Migrate ParserDebug plugin.

Change-Id: I661cc835878a13701363e9911b4f4cc23c83ae24
Reviewed-on: http://gerrit.dmdirc.com/1297
Reviewed-by: Gregory Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

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

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.actions.interfaces.ActionType;
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
+import com.dmdirc.plugins.Plugin;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.HashMap;
+
+/**
+ * This causes parser debugging to be spammed to the console.
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public final class DebugPlugin extends Plugin implements DebugInfoListener, ActionListener {
+
+    /** The ParserDebugCommand we created. */
+    private ParserDebugCommand command = null;
+
+    /** Map of parsers registered. */
+    protected final HashMap<Parser,DebugWindow> registeredParsers
+            = new HashMap<Parser,DebugWindow>();
+
+    /**
+     * Creates a new instance of the Debug Plugin.
+     */
+    public DebugPlugin() { super(); }
+    
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        ActionManager.addListener(this, CoreActionType.SERVER_DISCONNECTED);
+        command = new ParserDebugCommand(this);
+    }
+    
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        CommandManager.unregisterCommand(command);
+        final ArrayList<DebugWindow> windowList = new ArrayList<DebugWindow>();
+        for (Parser parser : registeredParsers.keySet()) {
+            try {
+                parser.getCallbackManager().delCallback(DebugInfoListener.class, this);
+                DebugWindow window = registeredParsers.get(parser);
+                windowList.add(window);
+            } catch (Exception e) { }
+        }
+        for (DebugWindow window : windowList) {
+            window.close();
+        }
+        registeredParsers.clear();
+    }
+    
+    /** {@inheritDoc} */
+    @Override
+    public void onDebugInfo(final Parser parser, final Date date, final int level, final String data) {
+        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 Server thisServer = (Server)arguments[0];
+            final Parser parser = thisServer.getParser();
+            if (registeredParsers.containsKey(parser)) {
+                try {
+                    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

@@ -0,0 +1,115 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.FrameContainer;
+import com.dmdirc.Server;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
+import com.dmdirc.ui.WindowManager;
+import com.dmdirc.ui.interfaces.Window;
+
+/**
+ * This class is used to show the parser debug in a window
+ *
+ * @author Shane 'Dataforce' McCormack
+ */
+public class DebugWindow extends FrameContainer<Window> {
+
+    /** The plugin that owns this window */
+    protected DebugPlugin plugin;
+    /** The parser this window is debugging */
+    protected Parser parser;
+    /** The Server window we are a child of */
+    protected Server server;
+    
+    /**
+     * Creates a new instance of DebugWindow.
+     *
+     * @param plugin The plugin that owns 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
+     */
+    public DebugWindow(final DebugPlugin plugin, final String title, final Parser parser, final Server server) {
+        super("raw", "Parser Debug", title, Window.class, server.getConfigManager());
+        this.plugin = plugin;
+        this.parser = parser;
+        this.server = server;
+
+        WindowManager.addWindow(server, this);
+    }
+       
+    /**
+     * Returns the server instance associated with this container.
+     *
+     * @return the associated server connection
+     */
+    @Override
+    public Server getServer() {
+        return server;
+    }
+    
+    /**
+     * Set the parser to null to stop us holding onto parsers when the server
+     * connection is closed.
+     */
+    public void unsetParser() {
+        addLine("======================", true);
+        addLine("Unset parser: "+parser, true);
+        parser = null;
+    }
+    
+
+    /**
+     * Closes this container (and it's associated frame).
+     */
+    @Override
+    public void windowClosing() {
+        // 1: Make the window non-visible
+        for (Window window : getWindows()) {
+            window.setVisible(false);
+        }
+        
+        // 2: Remove any callbacks or listeners
+        if (parser != null) {
+            parser.getCallbackManager().delCallback(DebugInfoListener.class, plugin);
+        }
+        
+        // 3: Trigger any actions neccessary
+        // 4: Trigger action for the window closing
+        // 5: Inform any parents that the window is closing
+        
+        // 6: Remove the window from the window manager
+        WindowManager.removeWindow(this);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void windowClosed() {
+        // 7: Remove any references to the window and parents
+        this.parser = null;
+        this.server = null;
+        this.plugin = null;
+    }
+}

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

@@ -0,0 +1,133 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.CommandOptions;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.commandparser.commands.context.ServerCommandContext;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
+
+/**
+ * The ParserDebug Command allows controlling of which parsers spam debug info.
+ *
+ * @author Shane "Dataforce" Mc Cormack
+ */
+@CommandOptions(allowOffline=false)
+public final class ParserDebugCommand extends Command implements CommandInfo {
+    /** My Plugin */
+    final DebugPlugin myPlugin;
+
+    /**
+     * Creates a new instance of ParserDebugCommand.
+     *
+     * @param plugin Plugin that owns this command
+     */
+    public ParserDebugCommand(final DebugPlugin plugin) {
+        super();
+        myPlugin = plugin;
+        CommandManager.registerCommand(this);
+    }
+    
+    /** {@inheritDoc} */
+    @Override
+    public CommandType getType() {
+        return CommandType.TYPE_SERVER;
+    }
+
+    /**
+     * Executes this command.
+     *
+     * @param origin The framecontainer in which this command was issued
+     * @param commandArgs The user supplied arguments
+     * @param context The Context of this command execution
+     */
+    @Override
+    public void execute(final FrameContainer<?> origin, final CommandArguments commandArgs, final CommandContext context) {
+        final String[] args = commandArgs.getArguments();
+        final boolean isSilent = commandArgs.isSilent();
+  
+        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);
+                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);
+                sendLine(origin, isSilent, FORMAT_OUTPUT, "Removing callback ok");
+            } catch (Exception e) {
+                sendLine(origin, isSilent, FORMAT_ERROR, "Removing callback failed");
+            }
+        } else {
+            try {
+                parser.getCallbackManager().addCallback(DebugInfoListener.class, myPlugin);
+                DebugWindow window = new DebugWindow(myPlugin, "Parser Debug", parser, origin.getServer());
+                myPlugin.registeredParsers.put(parser, window);
+                sendLine(origin, isSilent, FORMAT_OUTPUT, "Adding callback ok");
+                window.addLine("======================", true);
+                window.addLine("Started Monitoring: "+parser, true);
+                window.addLine("======================", true);
+            } catch (Exception e) {
+                sendLine(origin, isSilent, FORMAT_ERROR, "Adding callback failed");
+            }
+        }
+    }
+
+    /**
+     * Returns this command's name.
+     *
+     * @return The name of this command
+     */
+    @Override
+    public String getName() { return "parserdebug"; }
+    
+    /**
+     * Returns whether or not this command should be shown in help messages.
+     *
+     * @return True iff the command should be shown, false otherwise
+     */
+    @Override
+    public boolean showInHelp() { return true; }
+    
+    /**
+     * Returns a string representing the help message for this command.
+     *
+     * @return the help message for this command
+     */
+    @Override
+    public String getHelp() { return "parserdebug - Enables/Disables hooks for onDebugInfo for the parser that owns this window"; }
+}
+

src/com/dmdirc/addons/parserdebug/plugin.config

@@ -0,0 +1,17 @@
+keysections:
+  metadata
+  version
+
+metadata:
+  mainclass=com.dmdirc.addons.parserdebug.DebugPlugin
+  author=Shane <shane@dmdirc.com>
+  description=Allows viewing of parser debugging. (Hacky, likely to break stuff!)
+  name=parserdebug
+  nicename=Parser Debug Plugin
+
+version:
+  number=3
+  friendly=0.3
+
+provides:
+  parserdebug command