Fixes issue 3443: logging plugin should cache variables

Fixes issue 3444: window status plugin needs to cache values
issue 3441: twitter plugin needs to cache variables, especially debugEnabled

Change-Id: I116863f2a4e220f330aefeff9f49ed45f698c4d3
Reviewed-on: http://gerrit.dmdirc.com/363
Tested-by: Gregory Holmes <greboid@dmdirc.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/logging/LoggingPlugin.java

@@ -36,6 +36,7 @@ import com.dmdirc.config.prefs.PreferencesManager;
 import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.PreferencesType;
 import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
@@ -71,18 +72,33 @@ import java.util.TimerTask;
  *
  * @author Shane 'Dataforce' McCormack
  */
-public class LoggingPlugin extends Plugin implements ActionListener {
+public class LoggingPlugin extends Plugin implements ActionListener,
+        ConfigChangeListener {
 
     /** The command we registered. */
     private LoggingCommand command;
+    /** Cached boolean settings. */
+    private boolean networkfolders, filenamehash, addtime, stripcodes,
+            channelmodeprefix, autobackbuffer, backbufferTimestamp, usedate;
+    /** Cached string settings. */
+    private String timestamp, usedateformat, logDirectory, colour;
+    /** Cached int settings. */
+    private int historyLines, backbufferLines;
 
     /** Open File */
     protected class OpenFile {
 
+        /** Last used time. */
         public long lastUsedTime = System.currentTimeMillis();
 
+        /** Open file's writer. */
         public BufferedWriter writer = null;
 
+        /**
+         * Creates a new open file.
+         *
+         * @param writer Writer that has file open
+         */
         public OpenFile(final BufferedWriter writer) {
             this.writer = writer;
         }
@@ -117,7 +133,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
      */
     @Override
     public void onLoad() {
-        final File dir = new File(IdentityManager.getGlobalConfig().getOption(getDomain(), "general.directory"));
+        final File dir = new File(logDirectory);
         if (dir.exists()) {
             if (!dir.isDirectory()) {
                 Logger.userError(ErrorLevel.LOW, "Unable to create logging dir (file exists instead)");
@@ -128,6 +144,9 @@ public class LoggingPlugin extends Plugin implements ActionListener {
             }
         }
 
+        setCachedSettings();
+        IdentityManager.getGlobalConfig().addChangeListener(getDomain(), this);
+
         command = new LoggingCommand();
         ActionManager.addListener(this,
                 CoreActionType.CHANNEL_OPENED,
@@ -191,8 +210,10 @@ public class LoggingPlugin extends Plugin implements ActionListener {
      */
     @Override
     public void onUnload() {
-        idleFileTimer.cancel();
-        idleFileTimer.purge();
+        if (idleFileTimer != null) {
+            idleFileTimer.cancel();
+            idleFileTimer.purge();
+        }
 
         CommandManager.unregisterCommand(command);
         ActionManager.removeListener(this);
@@ -258,7 +279,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
 
         if (parser == null) {
             // Without a parser object, we might not be able to find the file to log this to.
-            if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.networkfolders")) {
+            if (networkfolders) {
                 // We *wont* be able to, so rather than logging to an incorrect file we just won't log.
                 return;
             }
@@ -271,7 +292,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
 
         switch (type) {
             case QUERY_OPENED:
-                if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "backbuffer.autobackbuffer")) {
+                if (autobackbuffer) {
                     showBackBuffer(query.getFrame(), filename);
                 }
 
@@ -326,7 +347,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
 
         switch (type) {
             case CHANNEL_OPENED:
-                if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "backbuffer.autobackbuffer")) {
+                if (autobackbuffer) {
                     showBackBuffer(chan.getFrame(), filename);
                 }
 
@@ -449,6 +470,12 @@ public class LoggingPlugin extends Plugin implements ActionListener {
         }
     }
 
+    /** {@inheritDoc} */
+    @Override
+    public void configChanged(String domain, String key) {
+        setCachedSettings();
+    }
+
     /**
      * Add a backbuffer to a frame.
      *
@@ -456,9 +483,6 @@ public class LoggingPlugin extends Plugin implements ActionListener {
      * @param filename File to get backbuffer from
      */
     protected void showBackBuffer(final Window frame, final String filename) {
-        final int numLines = IdentityManager.getGlobalConfig().getOptionInt(getDomain(), "backbuffer.lines");
-        final String colour = IdentityManager.getGlobalConfig().getOption(getDomain(), "backbuffer.colour");
-        final boolean showTimestamp = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "backbuffer.timestamp");
         if (frame == null) {
             Logger.userError(ErrorLevel.LOW, "Given a null frame");
             return;
@@ -472,12 +496,12 @@ public class LoggingPlugin extends Plugin implements ActionListener {
                 // is returned by getLines. To counter this, we call getLines(1) and do
                 // nothing with the output.
                 file.getLines(1);
-                final Stack<String> lines = file.getLines(numLines);
+                final Stack<String> lines = file.getLines(backbufferLines);
                 while (!lines.empty()) {
-                    frame.addLine(getColouredString(colour, lines.pop()), showTimestamp);
+                    frame.addLine(getColouredString(colour, lines.pop()), backbufferTimestamp);
                 }
                 file.close();
-                frame.addLine(getColouredString(colour, "--- End of backbuffer\n"), showTimestamp);
+                frame.addLine(getColouredString(colour, "--- End of backbuffer\n"), backbufferTimestamp);
             } catch (FileNotFoundException e) {
                 Logger.userError(ErrorLevel.LOW, "Unable to show backbuffer (Filename: " + filename + "): " + e.getMessage());
             } catch (IOException e) {
@@ -545,24 +569,23 @@ public class LoggingPlugin extends Plugin implements ActionListener {
     protected boolean appendLine(final String filename, final String line) {
         final StringBuffer finalLine = new StringBuffer();
 
-        if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.addtime")) {
+        if (addtime) {
             String dateString;
-            final String dateFormatString = IdentityManager.getGlobalConfig().getOption(getDomain(), "general.timestamp");
             try {
-                final DateFormat dateFormat = new SimpleDateFormat(dateFormatString);
+                final DateFormat dateFormat = new SimpleDateFormat(timestamp);
                 dateString = dateFormat.format(new Date()).trim();
             } catch (IllegalArgumentException iae) {
                 // Default to known good format
                 final DateFormat dateFormat = new SimpleDateFormat("[dd/MM/yyyy HH:mm:ss]");
                 dateString = dateFormat.format(new Date()).trim();
 
-                Logger.userError(ErrorLevel.LOW, "Dateformat String '" + dateFormatString + "' is invalid. For more information: http://java.sun.com/javase/6/docs/api/java/text/SimpleDateFormat.html");
+                Logger.userError(ErrorLevel.LOW, "Dateformat String '" + timestamp + "' is invalid. For more information: http://java.sun.com/javase/6/docs/api/java/text/SimpleDateFormat.html");
             }
             finalLine.append(dateString);
             finalLine.append(" ");
         }
 
-        if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.stripcodes")) {
+        if (stripcodes) {
             finalLine.append(Styliser.stipControlCodes(line));
         } else {
             finalLine.append(line);
@@ -605,7 +628,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
         final StringBuffer file = new StringBuffer();
         String md5String = "";
 
-        directory.append(IdentityManager.getGlobalConfig().getOption(getDomain(), "general.directory"));
+        directory.append(logDirectory);
         if (directory.charAt(directory.length() - 1) != File.separatorChar) {
             directory.append(File.separatorChar);
         }
@@ -631,8 +654,8 @@ public class LoggingPlugin extends Plugin implements ActionListener {
             md5String = obj.toString();
         }
 
-        if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "advanced.usedate")) {
-            final String dateFormat = IdentityManager.getGlobalConfig().getOption(getDomain(), "advanced.usedateformat");
+        if (usedate) {
+            final String dateFormat = usedateformat;
             final String dateDir = (new SimpleDateFormat(dateFormat)).format(new Date());
             directory.append(dateDir);
             if (directory.charAt(directory.length() - 1) != File.separatorChar) {
@@ -644,7 +667,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
             }
         }
 
-        if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "advanced.filenamehash")) {
+        if (filenamehash) {
             file.append('.');
             file.append(md5(md5String));
         }
@@ -663,7 +686,7 @@ public class LoggingPlugin extends Plugin implements ActionListener {
      * @param networkName Name of network
      */
     protected void addNetworkDir(final StringBuffer directory, final StringBuffer file, final String networkName) {
-        if (!IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.networkfolders")) {
+        if (!networkfolders) {
             return;
         }
 
@@ -761,14 +784,12 @@ public class LoggingPlugin extends Plugin implements ActionListener {
      * @return name to display
      */
     protected String getDisplayName(final ChannelClientInfo channelClient, final String overrideNick) {
-        final boolean addModePrefix = (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.channelmodeprefix"));
-
         if (channelClient == null) {
             return (overrideNick.isEmpty()) ? "Unknown Client" : overrideNick;
         } else if (overrideNick.isEmpty()) {
-            return (addModePrefix) ? channelClient.toString() : channelClient.getClient().getNickname();
+            return channelmodeprefix ? channelClient.toString() : channelClient.getClient().getNickname();
         } else {
-            return (addModePrefix) ? channelClient.getImportantModePrefix() + overrideNick : overrideNick;
+            return channelmodeprefix ? channelClient.getImportantModePrefix() + overrideNick : overrideNick;
         }
     }
 
@@ -812,10 +833,27 @@ public class LoggingPlugin extends Plugin implements ActionListener {
             return false;
         }
 
-        new HistoryWindow("History", reader, target,
-                IdentityManager.getGlobalConfig().getOptionInt(getDomain(), "history.lines"));
+        new HistoryWindow("History", reader, target, historyLines);
 
         return true;
     }
 
+    /** Updates cached settings. */
+    public void setCachedSettings() {
+        networkfolders = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.networkfolders");
+        filenamehash = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "advanced.filenamehash");
+        addtime = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.addtime");
+        stripcodes = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.stripcodes");
+        channelmodeprefix = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "general.channelmodeprefix");
+        autobackbuffer = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "backbuffer.autobackbuffer");
+        backbufferTimestamp = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "backbuffer.timestamp");
+        usedate = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "advanced.usedate");
+        timestamp = IdentityManager.getGlobalConfig().getOption(getDomain(), "general.timestamp");
+        usedateformat = IdentityManager.getGlobalConfig().getOption(getDomain(), "advanced.usedateformat");
+        historyLines = IdentityManager.getGlobalConfig().getOptionInt(getDomain(), "history.lines");
+        colour = IdentityManager.getGlobalConfig().getOption(getDomain(), "backbuffer.colour");
+        backbufferLines = IdentityManager.getGlobalConfig().getOptionInt(getDomain(), "backbuffer.lines");
+        logDirectory = IdentityManager.getGlobalConfig().getOption(getDomain(), "general.directory");
+    }
+
 }

src/com/dmdirc/addons/parser_twitter/Twitter.java

@@ -153,6 +153,9 @@ public class Twitter implements Parser, TwitterErrorHandler, TwitterRawHandler,
     /** Map to store misc stuff in. */
     private Map<Object, Object> myMap = new HashMap<Object, Object>();
 
+    /** Debug enabled. */
+    private boolean debugEnabled;
+
     /**
      * Create a new Twitter Parser!
      *
@@ -172,6 +175,7 @@ public class Twitter implements Parser, TwitterErrorHandler, TwitterRawHandler,
         
         resetState(true);
 
+        debugEnabled = getConfigManager().getOptionBool(myPlugin.getDomain(), "debugEnabled");
         if (getConfigManager().hasOptionString(myPlugin.getDomain(), "api.address."+myServerName)) {
             this.apiAddress = getConfigManager().getOption(myPlugin.getDomain(), "api.address."+myServerName);
         } else {
@@ -834,8 +838,7 @@ public class Twitter implements Parser, TwitterErrorHandler, TwitterRawHandler,
      * @param message Content of the message.
      */
     private void doDebug(final Debug code, final String message) {
-        final boolean debug = getConfigManager().getOptionBool(myPlugin.getDomain(), "debugEnabled");
-        if (debug) {
+        if (debugEnabled) {
             getCallbackManager().getCallbackType(DebugInfoListener.class).call(code.ordinal(), message);
         }
     }
@@ -873,7 +876,7 @@ public class Twitter implements Parser, TwitterErrorHandler, TwitterRawHandler,
         currentParsers.add(this);
         api.addErrorHandler(this);
         api.addRawHandler(this);
-        api.setDebug(getConfigManager().getOptionBool(myPlugin.getDomain(), "debugEnabled"));
+        api.setDebug(debugEnabled);
 
         getConfigManager().addChangeListener(myPlugin.getDomain(), this);
 
@@ -1281,13 +1284,12 @@ public class Twitter implements Parser, TwitterErrorHandler, TwitterRawHandler,
     /** {@inheritDoc} */
     @Override
     public void handleTwitterError(final TwitterAPI api, final Throwable t, final String source, final String twitterInput, final String twitterOutput, final String message) {
-        final boolean debug = getConfigManager().getOptionBool(myPlugin.getDomain(), "debugEnabled");
-        final boolean hide500Errors = !debug && getConfigManager().getOptionBool(myPlugin.getDomain(), "hide500Errors");
+        final boolean hide500Errors = !debugEnabled && getConfigManager().getOptionBool(myPlugin.getDomain(), "hide500Errors");
         if (hide500Errors && message.matches("^\\(50[0-9]\\).*")) { return; }
         try {
             if (!message.isEmpty()) {
-                twitterFail("Recieved an error from twitter: " + message + (debug ? " [" + source + "]" : ""));
-            } else if (debug) {
+                twitterFail("Recieved an error from twitter: " + message + (debugEnabled ? " [" + source + "]" : ""));
+            } else if (debugEnabled) {
                 twitterFail("Recieved an error: " + source);
             }
             if (t != null) {
@@ -1395,7 +1397,8 @@ public class Twitter implements Parser, TwitterErrorHandler, TwitterRawHandler,
     public void configChanged(final String domain, final String key) {
         if (domain.equalsIgnoreCase(myPlugin.getDomain())) {
             if (key.equalsIgnoreCase("debugEnabled")) {
-                api.setDebug(getConfigManager().getOptionBool(myPlugin.getDomain(), "debugEnabled"));
+                debugEnabled = getConfigManager().getOptionBool(myPlugin.getDomain(), "debugEnabled");
+                api.setDebug(debugEnabled);
             } else if (key.equalsIgnoreCase("autoAt")) {
                 sendPrivateNotice("'autoAt' setting was changed, reconnect needed.");
                 disconnect("'autoAt' setting was changed, reconnect needed.");

src/com/dmdirc/addons/parser_twitter/api/TwitterMessage.java

@@ -22,8 +22,6 @@
 
 package com.dmdirc.addons.parser_twitter.api;
 
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;

src/com/dmdirc/addons/parser_twitter/api/commons/StringEscapeUtils.java

@@ -19,7 +19,6 @@ package com.dmdirc.addons.parser_twitter.api.commons;
 import java.io.IOException;
 import java.io.StringWriter;
 import java.io.Writer;
-import java.util.Locale;
 
 /**
  * <p>Escapes and unescapes <code>String</code>s for

src/com/dmdirc/addons/windowstatus/WindowStatusPlugin.java

@@ -57,6 +57,8 @@ public final class WindowStatusPlugin extends Plugin implements ActionListener,
 
     /** The panel we use in the status bar. */
     private final WindowStatusPanel panel = new WindowStatusPanel();
+    private boolean showname, shownone;
+    private String nonePrefix;
 
     /** Creates a new instance of WindowStatusPlugin. */
     public WindowStatusPlugin() {
@@ -70,7 +72,7 @@ public final class WindowStatusPlugin extends Plugin implements ActionListener,
     public void onLoad() {
         Main.getUI().getStatusBar().addComponent(panel);
         IdentityManager.getGlobalConfig().addChangeListener(getDomain(), this);
-        updateStatus();
+        updateCache();
 
         ActionManager.addListener(this, CoreActionType.CLIENT_FRAME_CHANGED);
     }
@@ -98,6 +100,13 @@ public final class WindowStatusPlugin extends Plugin implements ActionListener,
         }
     }
 
+    private void updateCache() {
+        showname = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "client.showname");
+        shownone = IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "channel.shownone");
+        nonePrefix = IdentityManager.getGlobalConfig().getOption(getDomain(), "channel.noneprefix");
+        updateStatus();
+    }
+
     /**
      * Update the window status using the current active window.
      */
@@ -139,12 +148,8 @@ public final class WindowStatusPlugin extends Plugin implements ActionListener,
 
                 if (!names.containsKey(im)) {
                     if (mode.isEmpty()) {
-                        if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "channel.shownone")) {
-                            if (IdentityManager.getGlobalConfig().hasOptionString(getDomain(), "channel.noneprefix")) {
-                                mode = IdentityManager.getGlobalConfig().getOption(getDomain(), "channel.noneprefix");
-                            } else {
-                                mode = "None:";
-                            }
+                        if (shownone) {
+                            mode = nonePrefix;
                         } else {
                             continue;
                         }
@@ -179,7 +184,7 @@ public final class WindowStatusPlugin extends Plugin implements ActionListener,
             final Query frame = (Query) current;
 
             textString.append(frame.getHost());
-            if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "client.showname") && frame.getServer().getParser() != null) {
+            if (showname && frame.getServer().getParser() != null) {
                 final ClientInfo client = frame.getServer().getParser().getClient(frame.getHost());
                 final String realname = client.getRealname();
                 if (!realname.isEmpty()) {
@@ -214,7 +219,7 @@ public final class WindowStatusPlugin extends Plugin implements ActionListener,
     /** {@inheritDoc} */
     @Override
     public void configChanged(final String domain, final String key) {
-        updateStatus();
+        updateCache();
     }
 
 }