Fix how CommandContexts work.

The highest level command parser now generates the context, regardless of
who executes it. So a global command executed in a channel window will get
a ChannelCommandContext, whereas before it got a plain CommandContext.

Commands that don't expect other contexts will work as before, because the
inheritence tree of contexts mirorrs the command parser (e.g., if a
ServerCommandParser executes a command, you can guarantee its context will
be a sublcass of ServerCommandContext).

This fixes the /set command never allowing --channel.

Change-Id: I86e3c9f0bfedecb5c6b538e2309528c9e71f5eb3
Fixes-issue: CLIENT-424
Reviewed-on: http://gerrit.dmdirc.com/3085
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/commandparser/parsers/ChannelCommandParser.java

@@ -30,6 +30,7 @@ import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.Command;
 import com.dmdirc.commandparser.commands.context.ChannelCommandContext;
+import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.interfaces.CommandController;
 
 /**
@@ -76,16 +77,26 @@ public class ChannelCommandParser extends ChatCommandParser {
                 CommandType.TYPE_SERVER, CommandType.TYPE_CHANNEL);
     }
 
-    /** {@inheritDoc} */
     @Override
-    protected void executeCommand(final FrameContainer origin,
-            final CommandInfo commandInfo, final Command command,
+    protected CommandContext getCommandContext(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
             final CommandArguments args) {
+        return new ChannelCommandContext(origin, commandInfo, channel);
+    }
+
+    @Override
+    protected void executeCommand(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
+            final CommandArguments args,
+            final CommandContext context) {
         if (commandInfo.getType() == CommandType.TYPE_CHANNEL) {
-            command.execute(origin, args, new ChannelCommandContext(origin,
-                    commandInfo, channel));
+            command.execute(origin, args, context);
         } else {
-            super.executeCommand(origin, commandInfo, command, args);
+            super.executeCommand(origin, commandInfo, command, args, context);
         }
     }
 

src/com/dmdirc/commandparser/parsers/ChatCommandParser.java

@@ -30,6 +30,7 @@ import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.Command;
 import com.dmdirc.commandparser.commands.context.ChatCommandContext;
+import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.interfaces.CommandController;
 
 /**
@@ -70,16 +71,26 @@ public class ChatCommandParser extends ServerCommandParser {
         }
     }
 
-    /** {@inheritDoc} */
     @Override
-    protected void executeCommand(final FrameContainer origin,
-            final CommandInfo commandInfo, final Command command,
+    protected CommandContext getCommandContext(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
             final CommandArguments args) {
+        return new ChatCommandContext(origin, commandInfo, owner);
+    }
+
+    @Override
+    protected void executeCommand(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
+            final CommandArguments args,
+            final CommandContext context) {
         if (commandInfo.getType() == CommandType.TYPE_CHAT) {
-            command.execute(origin, args, new ChatCommandContext(origin,
-                    commandInfo, owner));
+            command.execute(origin, args, context);
         } else {
-            super.executeCommand(origin, commandInfo, command, args);
+            super.executeCommand(origin, commandInfo, command, args, context);
         }
     }
 

src/com/dmdirc/commandparser/parsers/CommandParser.java

@@ -34,6 +34,7 @@ import com.dmdirc.commandparser.commands.Command;
 import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.ExternalCommand;
 import com.dmdirc.commandparser.commands.PreviousCommand;
+import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
@@ -151,7 +152,8 @@ public abstract class CommandParser implements Serializable {
             if (commands.containsKey(args.getCommandName().toLowerCase())) {
                 final CommandInfoPair pair = commands.get(args.getCommandName().toLowerCase());
                 addHistory(args.getStrippedLine());
-                executeCommand(origin, pair.getCommandInfo(), pair.getCommand(), args);
+                executeCommand(origin, pair.getCommandInfo(), pair.getCommand(), args,
+                        getCommandContext(origin, pair.getCommandInfo(), pair.getCommand(), args));
             } else {
                 handleInvalidCommand(origin, args);
             }
@@ -277,6 +279,21 @@ public abstract class CommandParser implements Serializable {
         handleNonCommand(origin, line);
     }
 
+    /**
+     * Gets the context that the command will execute with.
+     *
+     * @param origin The container which received the command
+     * @param commandInfo The command information object matched by the command
+     * @param command The command to be executed
+     * @param args The arguments to the command
+     * @return The context for the command.
+     */
+    protected abstract CommandContext getCommandContext(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
+            final CommandArguments args);
+
     /**
      * Executes the specified command with the given arguments.
      *
@@ -284,11 +301,11 @@ public abstract class CommandParser implements Serializable {
      * @param commandInfo The command information object matched by the command
      * @param command The command to be executed
      * @param args The arguments to the command
-     * @since 0.6.4
+     * @param context The context to use when executing the command
      */
     protected abstract void executeCommand(final FrameContainer origin,
             final CommandInfo commandInfo, final Command command,
-            final CommandArguments args);
+            final CommandArguments args, final CommandContext context);
 
     /**
      * Called when the user attempted to issue a command (i.e., used the command

src/com/dmdirc/commandparser/parsers/GlobalCommandParser.java

@@ -75,12 +75,23 @@ public class GlobalCommandParser extends CommandParser {
         commandManager.loadCommands(this, CommandType.TYPE_GLOBAL);
     }
 
-    /** {@inheritDoc} */
     @Override
-    protected void executeCommand(final FrameContainer origin,
-            final CommandInfo commandInfo, final Command command,
+    protected CommandContext getCommandContext(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
             final CommandArguments args) {
-        command.execute(origin, args, new CommandContext(origin, commandInfo));
+        return new CommandContext(origin, commandInfo);
+    }
+
+    @Override
+    protected void executeCommand(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
+            final CommandArguments args,
+            final CommandContext context) {
+        command.execute(origin, args, context);
     }
 
     /**

src/com/dmdirc/commandparser/parsers/QueryCommandParser.java

@@ -29,6 +29,7 @@ import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.commandparser.commands.context.QueryCommandContext;
 import com.dmdirc.interfaces.CommandController;
 
@@ -77,16 +78,26 @@ public class QueryCommandParser extends ChatCommandParser {
                 CommandType.TYPE_SERVER, CommandType.TYPE_QUERY);
     }
 
-    /** {@inheritDoc} */
     @Override
-    protected void executeCommand(final FrameContainer origin,
-            final CommandInfo commandInfo, final Command command,
+    protected CommandContext getCommandContext(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
             final CommandArguments args) {
+        return new QueryCommandContext(origin, commandInfo, query);
+    }
+
+    @Override
+    protected void executeCommand(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
+            final CommandArguments args,
+            final CommandContext context) {
         if (commandInfo.getType() == CommandType.TYPE_QUERY) {
-            command.execute(origin, args, new QueryCommandContext(origin,
-                    commandInfo, query));
+            command.execute(origin, args, context);
         } else {
-            super.executeCommand(origin, commandInfo, command, args);
+            super.executeCommand(origin, commandInfo, command, args, context);
         }
     }
 

src/com/dmdirc/commandparser/parsers/ServerCommandParser.java

@@ -29,6 +29,7 @@ import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.commandparser.commands.context.ServerCommandContext;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
@@ -78,11 +79,22 @@ public class ServerCommandParser extends GlobalCommandParser {
         commandManager.loadCommands(this, CommandType.TYPE_GLOBAL, CommandType.TYPE_SERVER);
     }
 
-    /** {@inheritDoc} */
     @Override
-    protected void executeCommand(final FrameContainer origin,
-            final CommandInfo commandInfo, final Command command,
+    protected CommandContext getCommandContext(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
             final CommandArguments args) {
+        return new ServerCommandContext(origin, commandInfo, server);
+    }
+
+    @Override
+    protected void executeCommand(
+            final FrameContainer origin,
+            final CommandInfo commandInfo,
+            final Command command,
+            final CommandArguments args,
+            final CommandContext context) {
         if (commandInfo.getType() == CommandType.TYPE_SERVER) {
             if (hasCommandOptions(command) && !getCommandOptions(command).allowOffline()
                     && (server == null || (server.getState() != ServerState.CONNECTED
@@ -92,10 +104,10 @@ public class ServerCommandParser extends GlobalCommandParser {
                     origin.addLine("commandError", "You must be connected to use this command");
                 }
             } else {
-                command.execute(origin, args, new ServerCommandContext(origin, commandInfo, server));
+                command.execute(origin, args, context);
             }
         } else {
-            super.executeCommand(origin, commandInfo, command, args);
+            super.executeCommand(origin, commandInfo, command, args, context);
         }
     }
 

test/com/dmdirc/harness/TestCommandParser.java

@@ -27,6 +27,7 @@ import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.commandparser.parsers.CommandParser;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
@@ -34,8 +35,6 @@ import com.dmdirc.interfaces.config.AggregateConfigProvider;
 public class TestCommandParser extends CommandParser {
     private static final long serialVersionUID = 7073002401375438532L;
 
-    private final AggregateConfigProvider configManager;
-
     public String nonCommandLine;
 
     public Command executedCommand;
@@ -49,7 +48,6 @@ public class TestCommandParser extends CommandParser {
     public TestCommandParser(final AggregateConfigProvider configManager,
             final CommandController commandManager) {
         super(configManager, commandManager);
-        this.configManager = configManager;
     }
 
     @Override
@@ -58,13 +56,19 @@ public class TestCommandParser extends CommandParser {
     }
 
     @Override
-    protected void executeCommand(FrameContainer origin,
-            CommandInfo commandInfo, Command command, CommandArguments args) {
+    protected void executeCommand(FrameContainer origin, CommandInfo commandInfo, Command command,
+            CommandArguments args, CommandContext context) {
         executedCommand = command;
         wasSilent = args.isSilent();
         commandArgs = args;
     }
 
+    @Override
+    protected CommandContext getCommandContext(FrameContainer origin, CommandInfo commandInfo,
+            Command command, CommandArguments args) {
+        return new CommandContext(origin, commandInfo);
+    }
+
     @Override
     protected void handleNonCommand(FrameContainer origin, String line) {
         nonCommandLine = line;