Initial global commands support (may be broken, can't test until svn removes the moved files...)

git-svn-id: http://svn.dmdirc.com/trunk@1239 00569f92-eb28-0410-84fd-f71c24880f

src/uk/org/ownage/dmdirc/commandparser/ChannelCommandParser.java

@@ -55,8 +55,9 @@ public final class ChannelCommandParser extends CommandParser {
     
     /** Loads the relevant commands into the parser. */
     protected void loadCommands() {
-        CommandManager.loadChannelCommands(this);
+        CommandManager.loadGlobalCommands(this);
         CommandManager.loadServerCommands(this);
+        CommandManager.loadChannelCommands(this);
     }
     
     /**

src/uk/org/ownage/dmdirc/commandparser/CommandManager.java

@@ -29,6 +29,7 @@ import uk.org.ownage.dmdirc.Config;
 import uk.org.ownage.dmdirc.Server;
 import uk.org.ownage.dmdirc.ServerManager;
 import uk.org.ownage.dmdirc.commandparser.commands.channel.*;
+import uk.org.ownage.dmdirc.commandparser.commands.global.*;
 import uk.org.ownage.dmdirc.commandparser.commands.query.*;
 import uk.org.ownage.dmdirc.commandparser.commands.server.*;
 import uk.org.ownage.dmdirc.logger.ErrorLevel;
@@ -41,6 +42,10 @@ import uk.org.ownage.dmdirc.logger.Logger;
  */
 public final class CommandManager {
     
+    /**
+     * The global commands that have been instansiated.
+     */
+    private static List<Command> globalCommands;
     /**
      * The server commands that have been instansiated.
      */
@@ -53,6 +58,10 @@ public final class CommandManager {
      * The query commands that have been instansiated.
      */
     private static List<Command> queryCommands;
+    /**
+     * The parsers that have requested global commands.
+     */
+    private static List<CommandParser> globalParsers;
     /**
      * The parsers that have requested server commands.
      */
@@ -99,6 +108,9 @@ public final class CommandManager {
         } else if (command instanceof QueryCommand) {
             target = queryParsers;
             queryCommands.add(command);
+        } else if (command instanceof GlobalCommand) {
+            target = globalParsers;
+            globalCommands.add(command);
         } else {
             Logger.error(ErrorLevel.ERROR, "Attempted to register an invalid command: "
                     + command.getClass().getName());
@@ -116,7 +128,7 @@ public final class CommandManager {
             final String commandName = Config.getCommandChar() + command.getName();
             
             for (Server server : ServerManager.getServerManager().getServers()) {
-                if (command instanceof ServerCommand) {
+                if (command instanceof ServerCommand || command instanceof GlobalCommand) {
                     server.getTabCompleter().addEntry(commandName);
                 } else if (command instanceof ChannelCommand) {
                     for (String channelName : server.getChannels()) {
@@ -151,6 +163,9 @@ public final class CommandManager {
         } else if (command instanceof QueryCommand) {
             target = queryParsers;
             queryCommands.remove(command);
+        } else if (command instanceof GlobalCommand) {
+            target = globalParsers;
+            globalCommands.remove(command);
         } else {
             Logger.error(ErrorLevel.ERROR, "Attempted to unregister an invalid command: "
                     + command.getClass().getName());
@@ -168,7 +183,7 @@ public final class CommandManager {
             final String commandName = Config.getCommandChar() + command.getName();
             
             for (Server server : ServerManager.getServerManager().getServers()) {
-                if (command instanceof ServerCommand) {
+                if (command instanceof ServerCommand || command instanceof GlobalCommand) {
                     server.getTabCompleter().removeEntry(commandName);
                 } else if (command instanceof ChannelCommand) {
                     for (String channelName : server.getChannels()) {
@@ -214,10 +229,12 @@ public final class CommandManager {
         channelCommands = new ArrayList<Command>();
         serverCommands = new ArrayList<Command>();
         queryCommands = new ArrayList<Command>();
+        globalCommands = new ArrayList<Command>();
         
         channelParsers = new ArrayList<CommandParser>();
         serverParsers = new ArrayList<CommandParser>();
         queryParsers = new ArrayList<CommandParser>();
+        globalParsers = new ArrayList<CommandParser>();
         
         channelPopupCommands = new ArrayList<Command>();
         
@@ -266,8 +283,6 @@ public final class CommandManager {
         new Nick();
         new Notice();
         new Query();
-        new Exit();
-        new ExitDefault();
         new Raw();
         new Reconnect();
         new ReloadActions();
@@ -279,6 +294,10 @@ public final class CommandManager {
         // Query commands
         new QueryMe();
         new QueryMeEmpty();
+        
+        // Global commands
+        new Exit();
+        new ExitDefault();
     }
     
     /**
@@ -313,6 +332,22 @@ public final class CommandManager {
         serverParsers.add(parser);
     }
     
+    /**
+     * Loads all global commands into the specified parser.
+     * @param parser The parser to load commands into
+     */
+    public static void loadGlobalCommands(final CommandParser parser) {
+        if (globalCommands == null) {
+            initLists();
+        }
+        
+        for (Command com : globalCommands) {
+            parser.registerCommand(com);
+        }
+        
+        globalParsers.add(parser);
+    }
+    
     /**
      * Loads all query commands into the specified parser.
      * @param parser The parser to load commands into
@@ -349,6 +384,26 @@ public final class CommandManager {
         return null;
     }
     
+    /**
+     * Retrieves the global command identified by the specified signature.
+     * @param signature The signature to look for
+     * @return A global command with a matching signature, or null if none
+     * were found.
+     */
+    public static GlobalCommand getGlobalCommand(final String signature) {
+        if (globalCommands == null) {
+            initLists();
+        }
+        
+        for (Command com : globalCommands) {
+            if (com.getSignature().equalsIgnoreCase(signature)) {
+                return (GlobalCommand) com;
+            }
+        }
+        
+        return null;
+    }
+    
     /**
      * Retrieves the channel command identified by the specified signature.
      * @param signature The signature to look for

src/uk/org/ownage/dmdirc/commandparser/GlobalCommand.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2006-2007 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 uk.org.ownage.dmdirc.commandparser;
+
+/**
+ * Represents a generic global command. Global commands are associated with
+ * no servers.
+ * @author chris
+ */
+public abstract class GlobalCommand extends Command {
+        
+    /**
+     * Executes this command. Note that for global commands, origin may be
+     * null.
+     * @param origin The window in which the command was typed
+     * @param args Arguments passed to this command
+     */
+    public abstract void execute(CommandWindow origin, String ... args);
+}

src/uk/org/ownage/dmdirc/commandparser/GlobalCommandParser.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2006-2007 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 uk.org.ownage.dmdirc.commandparser;
+
+import uk.org.ownage.dmdirc.Server;
+import uk.org.ownage.dmdirc.logger.ErrorLevel;
+import uk.org.ownage.dmdirc.logger.Logger;
+
+/**
+ * The command parser used for global commands.
+ * @author chris
+ */
+public final class GlobalCommandParser extends CommandParser {
+    
+    /**
+     * The singleton instance of this command parser.
+     */
+    private static GlobalCommandParser me;
+    
+    /**
+     * Creates a new instance of the GlobalCommandParser.
+     */
+    private GlobalCommandParser() {
+        super();
+    }
+    
+    /** Loads the relevant commands into the parser. */
+    protected void loadCommands() {
+        CommandManager.loadGlobalCommands(this);
+    }
+    
+    /**
+     * Executes the specified command with the given arguments.
+     * @param origin The window in which the command was typed
+     * @param command The command to be executed
+     * @param args The arguments to the command
+     */
+    protected void executeCommand(final CommandWindow origin, 
+            final Command command, final String... args) {
+        ((GlobalCommand) command).execute(origin, args);
+    }
+        
+    /**
+     * Called when the input was a line of text that was not a command. This normally
+     * means it is sent to the server/channel/user as-is, with no further processing.
+     * @param origin The window in which the command was typed
+     * @param line The line input by the user
+     */
+    protected void handleNonCommand(final CommandWindow origin, final String line) {
+        if (origin == null) {
+            Logger.error(ErrorLevel.WARNING, "Invalid global command: " + line);
+        } else {
+            origin.addLine("commandError", "Invalid global command: " + line);
+        }
+    }
+    
+}

src/uk/org/ownage/dmdirc/commandparser/QueryCommandParser.java

@@ -55,8 +55,9 @@ public final class QueryCommandParser extends CommandParser {
     
     /** Loads the relevant commands into the parser. */
     protected void loadCommands() {
-        CommandManager.loadQueryCommands(this);
+        CommandManager.loadGlobalCommands(this);
         CommandManager.loadServerCommands(this);
+        CommandManager.loadQueryCommands(this);
     }
     
     /**
@@ -65,7 +66,7 @@ public final class QueryCommandParser extends CommandParser {
      * @param command The command to be executed
      * @param args The arguments to the command
      */
-    protected void executeCommand(final CommandWindow origin, 
+    protected void executeCommand(final CommandWindow origin,
             final Command command, final String... args) {
         if (command instanceof QueryCommand) {
             ((QueryCommand) command).execute(origin, server, query, args);
@@ -73,7 +74,7 @@ public final class QueryCommandParser extends CommandParser {
             ((ServerCommand) command).execute(origin, server, args);
         }
     }
-        
+    
     /**
      * Called when the input was a line of text that was not a command. This normally
      * means it is sent to the server/channel/user as-is, with no further processing.

src/uk/org/ownage/dmdirc/commandparser/ServerCommandParser.java

@@ -47,6 +47,7 @@ public final class ServerCommandParser extends CommandParser {
     
     /** Loads the relevant commands into the parser. */
     protected void loadCommands() {
+        CommandManager.loadGlobalCommands(this);
         CommandManager.loadServerCommands(this);
     }
     

src/uk/org/ownage/dmdirc/commandparser/commands/server/Exit.java → src/uk/org/ownage/dmdirc/commandparser/commands/global/Exit.java

@@ -20,13 +20,12 @@
  * SOFTWARE.
  */
 
-package uk.org.ownage.dmdirc.commandparser.commands.server;
+package uk.org.ownage.dmdirc.commandparser.commands.global;
 
 import uk.org.ownage.dmdirc.Main;
-import uk.org.ownage.dmdirc.Server;
 import uk.org.ownage.dmdirc.commandparser.CommandManager;
 import uk.org.ownage.dmdirc.commandparser.CommandWindow;
-import uk.org.ownage.dmdirc.commandparser.ServerCommand;
+import uk.org.ownage.dmdirc.commandparser.GlobalCommand;
 
 /**
  * The exit command allows the user to quit DMDirc with a custom quit message.
@@ -34,7 +33,7 @@ import uk.org.ownage.dmdirc.commandparser.ServerCommand;
  * supplied) and saves the config file.
  * @author chris
  */
-public final class Exit extends ServerCommand {
+public final class Exit extends GlobalCommand {
     
     /**
      * Creates a new instance of Exit.
@@ -45,14 +44,8 @@ public final class Exit extends ServerCommand {
         CommandManager.registerCommand(this);
     }
     
-    /**
-     * Executes this command.
-     * @param origin The frame in which this command was issued
-     * @param server The server object that this command is associated with
-     * @param args The user supplied arguments
-     */
-    public void execute(final CommandWindow origin, final Server server,
-            final String... args) {
+    /** {@inheritDoc}  */
+    public void execute(final CommandWindow origin, final String... args) {
         Main.quit(implodeArgs(args));
     }
     

src/uk/org/ownage/dmdirc/commandparser/commands/server/ExitDefault.java → src/uk/org/ownage/dmdirc/commandparser/commands/global/ExitDefault.java

@@ -20,12 +20,12 @@
  * SOFTWARE.
  */
 
-package uk.org.ownage.dmdirc.commandparser.commands.server;
+package uk.org.ownage.dmdirc.commandparser.commands.global;
 
-import uk.org.ownage.dmdirc.Server;
+import uk.org.ownage.dmdirc.Config;
 import uk.org.ownage.dmdirc.commandparser.CommandManager;
 import uk.org.ownage.dmdirc.commandparser.CommandWindow;
-import uk.org.ownage.dmdirc.commandparser.ServerCommand;
+import uk.org.ownage.dmdirc.commandparser.GlobalCommand;
 
 /**
  * Represents the exit/0 command (i.e., an exit with no arguments). Reads the
@@ -33,7 +33,7 @@ import uk.org.ownage.dmdirc.commandparser.ServerCommand;
  * with it as an argument.
  * @author chris
  */
-public final class ExitDefault extends ServerCommand {
+public final class ExitDefault extends GlobalCommand {
     
     /**
      * Creates a new instance of ExitDefault.
@@ -44,16 +44,17 @@ public final class ExitDefault extends ServerCommand {
         CommandManager.registerCommand(this);
     }
     
-    /**
-     * Executes this command.
-     * @param origin The frame in which this command was issued
-     * @param server The server object that this command is associated with
-     * @param args The user supplied arguments
-     */
-    public void execute(final CommandWindow origin, final Server server,
-            final String... args) {
-        final String def = origin.getConfigManager().getOption("general", "closemessage");
-        CommandManager.getServerCommand("exit").execute(origin, server, def);
+    /** {@inheritDoc}  */
+    public void execute(final CommandWindow origin, final String... args) {
+        String def;
+        
+        if (origin == null) {
+            def = Config.getOption("general", "closemessage");
+        } else {
+            def = origin.getConfigManager().getOption("general", "closemessage");
+        }
+        
+        CommandManager.getGlobalCommand("exit").execute(origin, def);
     }