Add CommandOptions class and make all server commands that can't be used

offline use it. Fixes issue 2317.

src/com/dmdirc/commandparser/commands/CommandOptions.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2006-2009 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.commandparser.commands;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Allows commands to define options that affect their behaviour.
+ *
+ * @since 0.6.3
+ * @author chris
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface CommandOptions {
+
+    /**
+     * Whether or not to allow use of the command while not connected.
+     *
+     * @return True if the command may be used offline, false otherwise
+     */
+    boolean allowOffline() default true;
+
+}

src/com/dmdirc/commandparser/commands/server/Away.java

@@ -23,9 +23,9 @@
 package com.dmdirc.commandparser.commands.server;
 
 import com.dmdirc.Server;
-import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.interfaces.InputWindow;
 
@@ -33,6 +33,7 @@ import com.dmdirc.ui.interfaces.InputWindow;
  * The away command allows the user to set their away message.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Away extends ServerCommand {
     
     /**
@@ -48,13 +49,9 @@ public final class Away extends ServerCommand {
     @Override
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final CommandArguments args) {
-        if (server.getState() == ServerState.CONNECTED) {
-            final String line = args.getArgumentsAsString();
+        final String line = args.getArgumentsAsString();
 
-            server.getParser().sendLine("AWAY :" + line);
-        } else {
-            sendLine(origin, isSilent, FORMAT_ERROR, "Not connected");
-        }
+        server.getParser().sendLine("AWAY :" + line);
     }
     
     

src/com/dmdirc/commandparser/commands/server/Back.java

@@ -23,9 +23,9 @@
 package com.dmdirc.commandparser.commands.server;
 
 import com.dmdirc.Server;
-import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.input.AdditionalTabTargets;
@@ -37,6 +37,7 @@ import java.util.List;
  * The back command allows the user to unset their away status.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Back extends ServerCommand implements IntelligentCommand {
     
     /**
@@ -57,12 +58,7 @@ public final class Back extends ServerCommand implements IntelligentCommand {
      */
     @Override
     public void execute(final InputWindow origin, final Server server,
-            final boolean isSilent, final CommandArguments args) {
-        if (server.getState() != ServerState.CONNECTED) {
-            sendLine(origin, isSilent, FORMAT_ERROR, "Not connected");
-            return;
-        }
-        
+            final boolean isSilent, final CommandArguments args) {        
         server.getParser().sendLine("AWAY");
     }
     

src/com/dmdirc/commandparser/commands/server/Ctcp.java

@@ -23,9 +23,9 @@
 package com.dmdirc.commandparser.commands.server;
 
 import com.dmdirc.Server;
-import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.input.AdditionalTabTargets;
@@ -38,6 +38,7 @@ import java.util.List;
  * Allows the user to send CTCP messages.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Ctcp extends ServerCommand implements IntelligentCommand {
     
     /**
@@ -59,11 +60,6 @@ public final class Ctcp extends ServerCommand implements IntelligentCommand {
     @Override
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final CommandArguments args) {
-        if (server.getState() != ServerState.CONNECTED) {
-            sendLine(origin, isSilent, FORMAT_ERROR, "Not connected");
-            return;
-        }
-
         if (args.getArguments().length < 2) {
             showUsage(origin, isSilent, "ctcp", "<target> <type> [arguments]");
         } else {

src/com/dmdirc/commandparser/commands/server/Disconnect.java

@@ -50,6 +50,7 @@ public final class Disconnect extends ServerCommand {
      * @param isSilent Whether this command is silenced or not
      * @param args The user supplied arguments
      */
+    @Override
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final CommandArguments args) {
         String line;
@@ -64,17 +65,20 @@ public final class Disconnect extends ServerCommand {
     }
     
     
-    /** {@inheritDoc}. */
+    /** {@inheritDoc} */
+    @Override
     public String getName() {
         return "disconnect";
     }
     
-    /** {@inheritDoc}. */
+    /** {@inheritDoc} */
+    @Override
     public boolean showInHelp() {
         return true;
     }
     
-    /** {@inheritDoc}. */
+    /** {@inheritDoc} */
+    @Override
     public String getHelp() {
         return "disconnect [reason] - disconnect from this server";
     }

src/com/dmdirc/commandparser/commands/server/Message.java

@@ -23,9 +23,9 @@
 package com.dmdirc.commandparser.commands.server;
 
 import com.dmdirc.Server;
-import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.commandparser.commands.WrappableCommand;
@@ -39,6 +39,7 @@ import java.util.List;
  * Allows the user to send privmsgs.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Message extends ServerCommand implements IntelligentCommand,
         WrappableCommand {
     
@@ -55,11 +56,6 @@ public final class Message extends ServerCommand implements IntelligentCommand,
     @Override
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final CommandArguments args) {
-        if (server.getState() != ServerState.CONNECTED) {
-            sendLine(origin, isSilent, FORMAT_ERROR, "Not connected");
-            return;
-        }
-        
         if (args.getArguments().length < 2) {
             showUsage(origin, isSilent, "msg", "<target> <message>");
         } else {

src/com/dmdirc/commandparser/commands/server/Nick.java

@@ -25,6 +25,7 @@ package com.dmdirc.commandparser.commands.server;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.input.AdditionalTabTargets;
@@ -37,6 +38,7 @@ import java.util.List;
  * Allows the user to change nickname.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Nick extends ServerCommand implements IntelligentCommand {
     
     /**

src/com/dmdirc/commandparser/commands/server/Notice.java

@@ -26,6 +26,7 @@ import com.dmdirc.Server;
 import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.input.AdditionalTabTargets;
@@ -38,6 +39,7 @@ import java.util.List;
  * Allows the user to send notices.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Notice extends ServerCommand implements IntelligentCommand {
     
     /**
@@ -53,11 +55,6 @@ public final class Notice extends ServerCommand implements IntelligentCommand {
     @Override
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final CommandArguments args) {
-        if (server.getState() != ServerState.CONNECTED) {
-            sendLine(origin, isSilent, FORMAT_ERROR, "Not connected");
-            return;
-        }
-        
         if (args.getArguments().length < 2) {
             showUsage(origin, isSilent, "notice", "<target> <message>");
         } else {

src/com/dmdirc/commandparser/commands/server/Raw.java

@@ -25,6 +25,7 @@ package com.dmdirc.commandparser.commands.server;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.interfaces.InputWindow;
 
@@ -33,6 +34,7 @@ import com.dmdirc.ui.interfaces.InputWindow;
  * irc server.
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class Raw extends ServerCommand {
     
     /**

src/com/dmdirc/commandparser/commands/server/RawServerCommand.java

@@ -25,6 +25,7 @@ package com.dmdirc.commandparser.commands.server;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.interfaces.InputWindow;
 
@@ -34,6 +35,7 @@ import com.dmdirc.ui.interfaces.InputWindow;
  * 
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public final class RawServerCommand extends ServerCommand {
     
     /** The name of this raw command. */

src/com/dmdirc/commandparser/commands/server/Umode.java

@@ -26,6 +26,7 @@ import com.dmdirc.Server;
 import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.commands.CommandOptions;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.interfaces.InputWindow;
 
@@ -34,6 +35,7 @@ import com.dmdirc.ui.interfaces.InputWindow;
  * 
  * @author chris
  */
+@CommandOptions(allowOffline=false)
 public class Umode extends ServerCommand {
     
     /**

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

@@ -30,6 +30,7 @@ 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.ExternalCommand;
 import com.dmdirc.commandparser.commands.PreviousCommand;
 import com.dmdirc.config.IdentityManager;
@@ -262,4 +263,25 @@ public abstract class CommandParser implements Serializable {
      */
     protected abstract void handleNonCommand(final InputWindow origin,
             final String line);
+
+    /**
+     * Determines if the specified command has defined any command options.
+     *
+     * @param command The command to investigate
+     * @return True if the command defines options, false otherwise
+     */
+    protected boolean hasCommandOptions(final Command command) {
+        return command.getClass().isAnnotationPresent(CommandOptions.class);
+    }
+
+    /**
+     * Retrieves the command options for the specified command. If the command
+     * does not define options, this method will return null.
+     *
+     * @param command The command whose options should be retrieved
+     * @return The command's options, or null if not available
+     */
+    protected CommandOptions getCommandOptions(final Command command) {
+        return command.getClass().getAnnotation(CommandOptions.class);
+    }
 }

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

@@ -23,6 +23,7 @@
 package com.dmdirc.commandparser.parsers;
 
 import com.dmdirc.Server;
+import com.dmdirc.ServerState;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.CommandType;
@@ -70,7 +71,16 @@ public final class ServerCommandParser extends CommandParser {
     protected void executeCommand(final InputWindow origin,
             final boolean isSilent, final Command command, final CommandArguments args) {
         if (command instanceof ServerCommand) {
-            ((ServerCommand) command).execute(origin, server, isSilent, args);
+            if (hasCommandOptions(command) && !getCommandOptions(command).allowOffline()
+                    && ((server.getState() != ServerState.CONNECTED
+                    && server.getState() != ServerState.CONNECTING)
+                    || server.getParser() == null)) {
+                if (!isSilent) {
+                    origin.addLine("commandError", "You must be connected to use this command");
+                }
+            } else {
+                ((ServerCommand) command).execute(origin, server, isSilent, args);
+            }
         } else {
             ((GlobalCommand) command).execute(origin, isSilent, args);
         }