DI the parser debug plugin.

Change-Id: I74bf46c25c17dd0297e65421ea726a301afbef46
Reviewed-on: http://gerrit.dmdirc.com/3218
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/parserdebug/DebugPlugin.java

@@ -22,113 +22,37 @@
 
 package com.dmdirc.addons.parserdebug;
 
-import com.dmdirc.actions.CoreActionType;
-import com.dmdirc.interfaces.ActionController;
-import com.dmdirc.interfaces.ActionListener;
-import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.Connection;
-import com.dmdirc.interfaces.actions.ActionType;
-import com.dmdirc.parser.interfaces.Parser;
-import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
+import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
-import com.dmdirc.ui.WindowManager;
-import com.dmdirc.util.URLBuilder;
 
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.Map;
+import dagger.ObjectGraph;
 
 /**
- * This causes parser debugging to be spammed to the console.
+ * This causes parser debugging to be output to the a debug window.
  */
-public final class DebugPlugin extends BaseCommandPlugin implements
-        DebugInfoListener, ActionListener {
+public final class DebugPlugin extends BaseCommandPlugin {
 
-    /** Map of parsers registered. */
-    protected final Map<Parser, DebugWindow> registeredParsers = new HashMap<>();
     /** The action controller to use. */
-    private final ActionController actionController;
+    private ParserDebugManager manager;
 
-    /**
-     * Creates a new instance of this plugin.
-     *
-     * @param actionController  The action controller to register listeners with
-     * @param commandController Command controller to register commands
-     * @param windowManager     Window Manager
-     * @param urlBuilder        The URL builder to use when finding icons.
-     */
-    public DebugPlugin(
-            final ActionController actionController,
-            final CommandController commandController,
-            final WindowManager windowManager,
-            final URLBuilder urlBuilder) {
-        super(commandController);
-
-        this.actionController = actionController;
-
-        registerCommand(new ParserDebugCommand(commandController, this, windowManager, urlBuilder),
-                ParserDebugCommand.INFO);
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new ParserDebugModule()));
+        registerCommand(ParserDebugCommand.class, ParserDebugCommand.INFO);
+        manager = getObjectGraph().get(ParserDebugManager.class);
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        actionController.registerListener(this, CoreActionType.SERVER_DISCONNECTED);
+        manager.addActionListener();
         super.onLoad();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onUnload() {
-        actionController.unregisterListener(this);
-
-        final ArrayList<DebugWindow> windowList = new ArrayList<>();
-        for (Parser parser : registeredParsers.keySet()) {
-            try {
-                parser.getCallbackManager().delCallback(DebugInfoListener.class, this);
-                final DebugWindow window = registeredParsers.get(parser);
-                windowList.add(window);
-            } catch (Exception e) {
-            }
-        }
-        for (DebugWindow window : windowList) {
-            window.close();
-        }
-        registeredParsers.clear();
+        manager.removeActionListener();
         super.onUnload();
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public void onDebugInfo(final Parser parser, final Date date, final int level, final String data) {
-        final DebugWindow window = registeredParsers.get(parser);
-        if (window != null) {
-            window.addLine(String.format("[%d] %s%n", level, data), true);
-        }
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void processEvent(final ActionType type, final StringBuffer format,
-            final Object... arguments) {
-        if (type == CoreActionType.SERVER_DISCONNECTED) {
-            final Connection connection = (Connection) arguments[0];
-            final Parser parser = connection.getParser();
-            if (registeredParsers.containsKey(parser)) {
-                try {
-                    final DebugWindow window = registeredParsers.get(parser);
-                    registeredParsers.remove(parser);
-                    window.unsetParser();
-                    parser.getCallbackManager().delCallback(DebugInfoListener.class, this);
-                    window.addLine("======================", true);
-                    window.addLine("No Longer Monitoring: " + parser + " (Server Disconnected)",
-                            true);
-                    window.addLine("======================", true);
-                } catch (Exception e) {
-                }
-            }
-        }
-    }
-
 }

src/com/dmdirc/addons/parserdebug/DebugWindow.java

@@ -37,33 +37,33 @@ import java.util.Arrays;
  */
 public class DebugWindow extends FrameContainer {
 
-    /** The plugin that owns this window */
-    protected final DebugPlugin plugin;
-    /** The parser this window is debugging */
+    /** The debug listener for this window. */
+    protected final DebugInfoListener listener;
+    /** The parser this window is debugging. */
     protected Parser parser;
-    /** The connection we're operating on */
-    protected final Connection connection;
+    /** The server we're operating on. */
+    protected final Server server;
 
     /**
      * Creates a new instance of DebugWindow.
      *
-     * @param plugin     The plugin that owns this window
+     * @param listener   The debug listener for this window
      * @param title      The title of this window
      * @param parser     The parser this plugin is debugging
      * @param server     The Server window this is a child of
      * @param urlBuilder The URL builder to use when finding icons.
      */
     public DebugWindow(
-            final DebugPlugin plugin,
+            final DebugInfoListener listener,
             final String title,
             final Parser parser,
             final Server server,
             final URLBuilder urlBuilder) {
         super("raw", "Parser Debug", title, server.getConfigManager(), urlBuilder,
                 Arrays.asList(WindowComponent.TEXTAREA.getIdentifier()));
-        this.plugin = plugin;
+        this.listener = listener;
         this.parser = parser;
-        this.connection = server;
+        this.server = server;
     }
 
     /**
@@ -73,7 +73,7 @@ public class DebugWindow extends FrameContainer {
      */
     @Override
     public Connection getConnection() {
-        return connection;
+        return server;
     }
 
     /**
@@ -94,7 +94,7 @@ public class DebugWindow extends FrameContainer {
 
         // Remove any callbacks or listeners
         if (parser != null) {
-            parser.getCallbackManager().delCallback(DebugInfoListener.class, plugin);
+            parser.getCallbackManager().delCallback(DebugInfoListener.class, listener);
         }
     }
 

src/com/dmdirc/addons/parserdebug/ParserDebugCommand.java

@@ -33,9 +33,8 @@ import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.commandparser.commands.context.ServerCommandContext;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.parser.interfaces.Parser;
-import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
-import com.dmdirc.ui.WindowManager;
-import com.dmdirc.util.URLBuilder;
+
+import javax.inject.Inject;
 
 /**
  * The ParserDebug Command allows controlling of which parsers spam debug info.
@@ -48,35 +47,27 @@ public final class ParserDebugCommand extends Command {
             "parserdebug", "parserdebug - Enables/Disables hooks for "
             + "onDebugInfo for the parser that owns this window",
             CommandType.TYPE_SERVER);
-    /** My Plugin */
-    final DebugPlugin myPlugin;
-    /** Window management. */
-    private final WindowManager windowManager;
-    private final URLBuilder urlBuilder;
+    /** Parser debug manager. */
+    final ParserDebugManager parserDebugManager;
 
     /**
      * Creates a new instance of ParserDebugCommand.
      *
-     * @param controller    The controller to use for command information.
-     * @param plugin        Plugin that owns this command
-     * @param windowManager Window management
-     * @param urlBuilder    The URL builder to use when finding icons.
+     * @param controller         The controller to use for command information.
+     * @param parserDebugManager Parser debug manager
      */
+    @Inject
     public ParserDebugCommand(
             final CommandController controller,
-            final DebugPlugin plugin,
-            final WindowManager windowManager,
-            final URLBuilder urlBuilder) {
+            final ParserDebugManager parserDebugManager) {
         super(controller);
-        myPlugin = plugin;
-        this.windowManager = windowManager;
-        this.urlBuilder = urlBuilder;
+        this.parserDebugManager = parserDebugManager;
     }
 
     /**
      * Executes this command.
      *
-     * @param origin      The framecontainer in which this command was issued
+     * @param origin      The frame container in which this command was issued
      * @param commandArgs The user supplied arguments
      * @param context     The Context of this command execution
      */
@@ -85,37 +76,22 @@ public final class ParserDebugCommand extends Command {
             final CommandContext context) {
         final boolean isSilent = commandArgs.isSilent();
 
-        final Parser parser = ((ServerCommandContext) context).getServer()
-                .getParser();
+        final Parser parser = ((ServerCommandContext) context).getServer().getParser();
 
         if (parser == null) {
             sendLine(origin, isSilent, FORMAT_ERROR, "Unable to get a parser for this window.");
             return;
         }
-        if (myPlugin.registeredParsers.containsKey(parser)) {
-            try {
-                parser.getCallbackManager().delCallback(DebugInfoListener.class, myPlugin);
-                final DebugWindow window = myPlugin.registeredParsers.get(parser);
-                window.addLine("======================", true);
-                window.addLine("No Longer Monitoring: " + parser + " (User Requested)", true);
-                window.addLine("======================", true);
-                myPlugin.registeredParsers.remove(parser);
+        if (parserDebugManager.containsParser(parser)) {
+            if (parserDebugManager.removeParser(parser, false)) {
                 sendLine(origin, isSilent, FORMAT_OUTPUT, "Removing callback ok");
-            } catch (Exception e) {
+            } else {
                 sendLine(origin, isSilent, FORMAT_ERROR, "Removing callback failed");
             }
         } else {
-            try {
-                parser.getCallbackManager().addCallback(DebugInfoListener.class, myPlugin);
-                final DebugWindow window = new DebugWindow(myPlugin,
-                        "Parser Debug", parser, (Server) origin.getConnection(), urlBuilder);
-                windowManager.addWindow((Server) origin.getConnection(), window);
-                myPlugin.registeredParsers.put(parser, window);
+            if (parserDebugManager.addParser(parser, (Server) origin.getConnection())) {
                 sendLine(origin, isSilent, FORMAT_OUTPUT, "Adding callback ok");
-                window.addLine("======================", true);
-                window.addLine("Started Monitoring: " + parser, true);
-                window.addLine("======================", true);
-            } catch (Exception e) {
+            } else {
                 sendLine(origin, isSilent, FORMAT_ERROR, "Adding callback failed");
             }
         }

src/com/dmdirc/addons/parserdebug/ParserDebugManager.java

@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.parserdebug;
+
+import com.dmdirc.Server;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.interfaces.ActionController;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.interfaces.Connection;
+import com.dmdirc.interfaces.actions.ActionType;
+import com.dmdirc.parser.common.CallbackNotFoundException;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
+import com.dmdirc.ui.WindowManager;
+import com.dmdirc.util.URLBuilder;
+
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.inject.Inject;
+
+public class ParserDebugManager implements ActionListener, DebugInfoListener {
+
+    /** Map of parsers registered. */
+    protected final Map<Parser, DebugWindow> registeredParsers;
+    /** Action controller. */
+    private final ActionController actionController;
+    /** URL Builder. */
+    private final URLBuilder urlBuilder;
+    /** Window manager. */
+    private final WindowManager windowManager;
+
+    @Inject
+    public ParserDebugManager(final ActionController actionController,
+            final URLBuilder urlBuilder,
+            final WindowManager windowManager) {
+        this.actionController = actionController;
+        this.urlBuilder = urlBuilder;
+        this.windowManager = windowManager;
+        registeredParsers = new HashMap<>();
+    }
+
+    /**
+     * Adds action listener.
+     */
+    public void addActionListener() {
+        actionController.registerListener(this, CoreActionType.SERVER_DISCONNECTED);
+    }
+
+    /**
+     * Remove action listener.
+     */
+    public void removeActionListener() {
+        actionController.unregisterListener(this);
+    }
+
+    /**
+     * Are we listener on the specified parser?
+     *
+     * @param parser Parser to check
+     *
+     * @return true if we're listening
+     */
+    public boolean containsParser(final Parser parser) {
+        return registeredParsers.containsKey(parser);
+    }
+
+    /**
+     * Adds a parser to this manager, adding any required call backs.
+     *
+     * @param parser Parser to add
+     * @param server The server associated with the parser
+     *
+     * @return Whether we added the parser without error
+     */
+    public boolean addParser(final Parser parser, final Server server) {
+        try {
+            parser.getCallbackManager().addCallback(DebugInfoListener.class, this);
+            final DebugWindow window = new DebugWindow(this, "Parser Debug", parser,
+                    server, urlBuilder);
+            windowManager.addWindow(server, window);
+            registeredParsers.put(parser, window);
+            window.addLine("======================", true);
+            window.addLine("Started Monitoring: " + parser, true);
+            window.addLine("======================", true);
+            return true;
+        } catch (CallbackNotFoundException ex) {
+            return false;
+        }
+    }
+
+    /**
+     * Removes the parser from this manager, removing any call backs as required.
+     *
+     * @param parser Parser to add
+     * @param close  Close debug window?
+     *
+     * @return Whether removed the parser without error
+     */
+    public boolean removeParser(final Parser parser, final boolean close) {
+        try {
+            parser.getCallbackManager().delCallback(DebugInfoListener.class, this);
+            final DebugWindow window = registeredParsers.get(parser);
+            window.addLine("======================", true);
+            window.addLine("No Longer Monitoring: " + parser + " (User Requested)", true);
+            window.addLine("======================", true);
+            if (close) {
+                window.close();
+            }
+            registeredParsers.remove(parser);
+            return true;
+        } catch (CallbackNotFoundException ex) {
+            return false;
+        }
+    }
+
+    /**
+     * Removes all parser listeners and closes.
+     *
+     * @param close Close debug windows?
+     */
+    public void removeAllParserListeners(final boolean close) {
+        for (Parser parser : registeredParsers.keySet()) {
+            removeParser(parser, close);
+        }
+    }
+
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format,
+            final Object... arguments) {
+        if (type == CoreActionType.SERVER_DISCONNECTED) {
+            final Parser parser = ((Connection) arguments[0]).getParser();
+            if (registeredParsers.containsKey(parser)) {
+                removeParser(parser, false);
+            }
+        }
+    }
+
+    @Override
+    public void onDebugInfo(final Parser parser, final Date date, final int level, final String data) {
+        final DebugWindow window = registeredParsers.get(parser);
+        if (window != null) {
+            window.addLine(String.format("[%d] %s%n", level, data), true);
+        }
+    }
+
+}

src/com/dmdirc/addons/parserdebug/ParserDebugModule.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.parserdebug;
+
+import com.dmdirc.ClientModule;
+
+import dagger.Module;
+
+@Module(injects = {ParserDebugCommand.class, ParserDebugManager.class}, addsTo = ClientModule.class)
+public class ParserDebugModule {
+
+}