Convert some commands to use output events.

res/com/dmdirc/ui/messages/format.yml

@@ -217,7 +217,6 @@ CommandOutputEvent:
 #  commandOutput=%1$s
 #  actionTooLong=Warning: action too long to be sent
 #  tabCompletion=14Multiple possibilities: %1$s
-#  commandUsage=7Usage: %1$s%2$s %3$s
 #  numeric_006=%4$s
 #  numeric_007=%4$s
 #  numeric_015=%4$s

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

@@ -24,6 +24,8 @@ package com.dmdirc.commandparser.commands;
 
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.events.CommandErrorEvent;
+import com.dmdirc.events.CommandOutputEvent;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.WindowModel;
 import com.dmdirc.ui.messages.Styliser;
@@ -37,8 +39,10 @@ import javax.annotation.Nullable;
 public abstract class Command {
 
     /** The format name used for command output. */
+    @Deprecated
     protected static final String FORMAT_OUTPUT = "commandOutput";
     /** The format name used for command errors. */
+    @Deprecated
     protected static final String FORMAT_ERROR = "commandError";
     /** The controller this command is associated with. */
     private final CommandController controller;
@@ -59,6 +63,7 @@ public abstract class Command {
      * @param type     The type of message to send
      * @param args     The arguments of the message
      */
+    @Deprecated
     protected final void sendLine(@Nullable final WindowModel target,
             final boolean isSilent, final String type, final Object... args) {
         if (!isSilent && target != null) {
@@ -66,6 +71,34 @@ public abstract class Command {
         }
     }
 
+    /**
+     * Sends an output line, if appropriate, to the specified target.
+     *
+     * @param target   The command window to send the line to
+     * @param isSilent Whether this command is being silenced or not
+     * @param message  The output to send
+     */
+    protected final void showOutput(@Nullable final WindowModel target,
+            final boolean isSilent, final String message) {
+        if (!isSilent && target != null) {
+            target.getEventBus().publishAsync(new CommandOutputEvent(target, message));
+        }
+    }
+
+    /**
+     * Sends an error line, if appropriate, to the specified target.
+     *
+     * @param target   The command window to send the line to
+     * @param isSilent Whether this command is being silenced or not
+     * @param message  The error message to send
+     */
+    protected final void showError(@Nullable final WindowModel target,
+            final boolean isSilent, final String message) {
+        if (!isSilent && target != null) {
+            target.getEventBus().publishAsync(new CommandErrorEvent(target, message));
+        }
+    }
+
     /**
      * Sends a usage line, if appropriate, to the specified target.
      *
@@ -76,9 +109,10 @@ public abstract class Command {
      */
     protected final void showUsage(@Nullable final WindowModel target,
             final boolean isSilent, final String name, final String args) {
-        sendLine(target, isSilent, "commandUsage",
-                controller.getCommandChar(),
-                name, args);
+        if (!isSilent && target != null) {
+            target.getEventBus().publishAsync(new CommandErrorEvent(target,
+                    "Usage: " + controller.getCommandChar() + name + ' ' + args));
+        }
     }
 
     /**

src/com/dmdirc/commandparser/commands/channel/KickReason.java

@@ -82,8 +82,7 @@ public class KickReason extends Command implements IntelligentCommand {
                     ? Optional.of(args.getArgumentsAsString(1))
                     : Optional.empty());
         } else {
-            sendLine(origin, args.isSilent(), FORMAT_ERROR,
-                    "User not found: " + args.getArguments()[0]);
+            showError(origin, args.isSilent(), "User not found: " + args.getArguments()[0]);
         }
     }
 

src/com/dmdirc/commandparser/commands/channel/SetNickColour.java

@@ -84,8 +84,8 @@ public class SetNickColour extends Command implements IntelligentCommand {
                 .getUser(args.getArguments()[0]));
 
         if (!target.isPresent()) {
-            sendLine(origin, args.isSilent(), FORMAT_ERROR, "No such nickname ("
-                    + args.getArguments()[0] + ")!");
+            showError(origin, args.isSilent(),
+                    "No such nickname (" + args.getArguments()[0] + ")!");
         } else if (args.getArguments().length == 1) {
             // We're removing the colour
             target.get().removeDisplayProperty(DisplayProperty.FOREGROUND_COLOUR);
@@ -95,8 +95,8 @@ public class SetNickColour extends Command implements IntelligentCommand {
             final Colour newColour = colourManagerFactory.getColourManager(origin.getConfigManager())
                     .getColourFromString(args.getArguments()[1], null);
             if (newColour == null) {
-                sendLine(origin, args.isSilent(), FORMAT_ERROR, "Invalid colour specified ("
-                        + args.getArguments()[1] + ").");
+                showError(origin, args.isSilent(),
+                        "Invalid colour specified (" + args.getArguments()[1] + ").");
                 return;
             }
 

src/com/dmdirc/commandparser/commands/global/AliasCommand.java

@@ -88,11 +88,9 @@ public class AliasCommand extends Command implements IntelligentCommand {
         if ("--remove".equalsIgnoreCase(args.getArguments()[0])) {
             final String name = removeCommandChar(args.getArguments()[1]);
             if (doRemove(name)) {
-                sendLine(origin, args.isSilent(), FORMAT_OUTPUT, "Alias '"
-                        + name + "' removed.");
+                showOutput(origin, args.isSilent(), "Alias '" + name + "' removed.");
             } else {
-                sendLine(origin, args.isSilent(), FORMAT_ERROR, "Alias '"
-                        + name + "' not found.");
+                showError(origin, args.isSilent(), "Alias '" + name + "' not found.");
             }
 
             return;
@@ -101,8 +99,7 @@ public class AliasCommand extends Command implements IntelligentCommand {
         final String name = removeCommandChar(args.getArguments()[0]);
 
         if (aliasManager.getAlias(name).isPresent()) {
-            sendLine(origin, args.isSilent(), FORMAT_ERROR, "Alias '" + name
-                    + "' already exists.");
+            showError(origin, args.isSilent(), "Alias '" + name + "' already exists.");
             return;
         }
 
@@ -110,7 +107,7 @@ public class AliasCommand extends Command implements IntelligentCommand {
                 removeCommandChar(args.getArgumentsAsString(1)));
         aliasManager.addAlias(myAlias);
 
-        sendLine(origin, args.isSilent(), FORMAT_OUTPUT, "Alias '" + name + "' created.");
+        showOutput(origin, args.isSilent(), "Alias '" + name + "' created.");
     }
 
     /**

test/com/dmdirc/commandparser/commands/channel/BanTest.java

@@ -23,8 +23,10 @@
 package com.dmdirc.commandparser.commands.channel;
 
 import com.dmdirc.Channel;
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.commands.context.ChannelCommandContext;
+import com.dmdirc.events.CommandErrorEvent;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.GroupChatUser;
@@ -39,9 +41,7 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Mockito.anyChar;
-import static org.mockito.Mockito.anyString;
-import static org.mockito.Mockito.eq;
+import static org.mockito.Matchers.isA;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -55,6 +55,7 @@ public class BanTest {
     @Mock private Channel channel;
     @Mock private CommandController controller;
     @Mock private WindowModel container;
+    @Mock private DMDircMBassador eventbus;
     private Ban command;
 
     @Before
@@ -67,6 +68,7 @@ public class BanTest {
         when(channel.getUser(user2)).thenReturn(Optional.empty());
         when(controller.getCommandChar()).thenReturn('/');
         when(controller.getSilenceChar()).thenReturn('.');
+        when(container.getEventBus()).thenReturn(eventbus);
         command = new Ban(controller);
     }
 
@@ -75,7 +77,7 @@ public class BanTest {
         command.execute(container, new CommandArguments(controller, "/ban"),
                 new ChannelCommandContext(null, Ban.INFO, channel));
 
-        verify(container).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     /** Tests that the ban command uses the correct hostname if given a user. */

test/com/dmdirc/commandparser/commands/channel/KickReasonTest.java

@@ -23,8 +23,10 @@
 package com.dmdirc.commandparser.commands.channel;
 
 import com.dmdirc.Channel;
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.commands.context.ChannelCommandContext;
+import com.dmdirc.events.CommandErrorEvent;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.GroupChatUser;
@@ -38,13 +40,13 @@ import java.util.Optional;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Mockito.anyChar;
-import static org.mockito.Mockito.anyString;
-import static org.mockito.Mockito.eq;
-import static org.mockito.Mockito.matches;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.isA;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -58,8 +60,10 @@ public class KickReasonTest {
     @Mock private Channel channel;
     @Mock private CommandController controller;
     @Mock private WindowModel container;
+    @Mock private DMDircMBassador eventbus;
     @Mock private ChannelInfo channelInfo;
     @Mock private AggregateConfigProvider configProvider;
+    @Captor private ArgumentCaptor<CommandErrorEvent> errorEventCaptor;
     private KickReason command;
 
     @Before
@@ -75,6 +79,7 @@ public class KickReasonTest {
         when(channel.getUser(user2)).thenReturn(Optional.empty());
         when(controller.getCommandChar()).thenReturn('/');
         when(controller.getSilenceChar()).thenReturn('.');
+        when(container.getEventBus()).thenReturn(eventbus);
         command = new KickReason(controller);
     }
 
@@ -82,8 +87,7 @@ public class KickReasonTest {
     public void testUsage() {
         command.execute(container, new CommandArguments(controller, "/kick"),
                 new ChannelCommandContext(null, KickReason.INFO, channel));
-
-        verify(container).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test
@@ -91,7 +95,8 @@ public class KickReasonTest {
         command.execute(container, new CommandArguments(controller, "/kick user1"),
                 new ChannelCommandContext(null, KickReason.INFO, channel));
 
-        verify(container).addLine(eq("commandError"), matches(".*user1"));
+        verify(eventbus).publishAsync(errorEventCaptor.capture());
+        assertTrue(errorEventCaptor.getValue().getMessage().matches(".*user1"));
     }
 
     @Test

test/com/dmdirc/commandparser/commands/channel/SetNickColourTest.java

@@ -22,8 +22,10 @@
 package com.dmdirc.commandparser.commands.channel;
 
 import com.dmdirc.Channel;
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.commands.context.ChannelCommandContext;
+import com.dmdirc.events.CommandErrorEvent;
 import com.dmdirc.events.DisplayProperty;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.Connection;
@@ -39,12 +41,14 @@ import java.util.Optional;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
+import static org.junit.Assert.assertEquals;
 import static org.mockito.Matchers.any;
-import static org.mockito.Mockito.anyChar;
-import static org.mockito.Mockito.anyString;
+import static org.mockito.Matchers.isA;
 import static org.mockito.Mockito.eq;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
@@ -62,6 +66,8 @@ public class SetNickColourTest {
     @Mock private ColourManager colourManager;
     @Mock private CommandController controller;
     @Mock private WindowModel tiw;
+    @Mock private DMDircMBassador eventbus;
+    @Captor private ArgumentCaptor<CommandErrorEvent> errorEventCaptor;
     private SetNickColour command;
 
     @Before
@@ -76,14 +82,14 @@ public class SetNickColourTest {
         when(channel.getUser(user2)).thenReturn(Optional.empty());
         when(colourManagerFactory.getColourManager(any())).thenReturn(colourManager);
         when(colourManager.getColourFromString(eq("4"), any())).thenReturn(Colour.RED);
+        when(tiw.getEventBus()).thenReturn(eventbus);
     }
 
     @Test
     public void testUsageNoArgs() {
         command.execute(tiw, new CommandArguments(controller, "/foo"),
                 new ChannelCommandContext(null, SetNickColour.INFO, channel));
-
-        verify(tiw).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test
@@ -100,15 +106,16 @@ public class SetNickColourTest {
                 new ChannelCommandContext(null, SetNickColour.INFO, channel));
         verify(channel, never()).refreshClients();
         verify(groupChatUser, never()).removeDisplayProperty(DisplayProperty.FOREGROUND_COLOUR);
-        verify(tiw).addLine(eq("commandError"), eq("No such nickname (foo)!"));
+        verify(eventbus).publishAsync(errorEventCaptor.capture());
+        assertEquals("No such nickname (foo)!", errorEventCaptor.getValue().getMessage());
     }
 
     @Test
     public void testUsageInvalidColour() {
         command.execute(tiw, new CommandArguments(controller, "/foo moo omg"),
                 new ChannelCommandContext(null, SetNickColour.INFO, channel));
-
-        verify(tiw).addLine(eq("commandError"), eq("Invalid colour specified (omg)."));
+        verify(eventbus).publishAsync(errorEventCaptor.capture());
+        assertEquals("Invalid colour specified (omg).", errorEventCaptor.getValue().getMessage());
     }
 
     @Test

test/com/dmdirc/commandparser/commands/chat/MeTest.java

@@ -21,8 +21,10 @@
  */
 package com.dmdirc.commandparser.commands.chat;
 
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.commands.context.ChatCommandContext;
+import com.dmdirc.events.CommandErrorEvent;
 import com.dmdirc.interfaces.Chat;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.WindowModel;
@@ -33,9 +35,7 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Mockito.anyChar;
-import static org.mockito.Mockito.anyString;
-import static org.mockito.Mockito.eq;
+import static org.mockito.Matchers.isA;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -44,12 +44,14 @@ public class MeTest {
 
     @Mock private Chat chat;
     @Mock private WindowModel frameContainer;
+    @Mock private DMDircMBassador eventbus;
     @Mock private CommandController controller;
     private Me command;
 
     @Before
     public void setUp() {
         when(chat.getWindowModel()).thenReturn(frameContainer);
+        when(frameContainer.getEventBus()).thenReturn(eventbus);
         command = new Me(controller);
     }
 
@@ -57,8 +59,7 @@ public class MeTest {
     public void testUsage() {
         command.execute(frameContainer, new CommandArguments(controller, "/foo"),
                 new ChatCommandContext(null, Me.INFO, chat));
-
-        verify(frameContainer).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test

test/com/dmdirc/commandparser/commands/global/AliasCommandTest.java

@@ -21,10 +21,12 @@
  */
 package com.dmdirc.commandparser.commands.global;
 
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.aliases.AliasFactory;
 import com.dmdirc.commandparser.aliases.AliasManager;
 import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.events.CommandErrorEvent;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.WindowModel;
 import com.dmdirc.ui.input.TabCompleterUtils;
@@ -35,9 +37,7 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Matchers.anyChar;
-import static org.mockito.Matchers.anyString;
-import static org.mockito.Matchers.eq;
+import static org.mockito.Matchers.isA;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -49,6 +49,7 @@ public class AliasCommandTest {
     @Mock private CommandController controller;
     @Mock private TabCompleterUtils tabCompleterUtils;
     @Mock private WindowModel tiw;
+    @Mock private DMDircMBassador eventbus;
     private AliasCommand command;
 
     @Before
@@ -56,6 +57,7 @@ public class AliasCommandTest {
         command = new AliasCommand(controller, aliasFactory, aliasManager, tabCompleterUtils);
         when(controller.getCommandChar()).thenReturn('/');
         when(controller.getSilenceChar()).thenReturn('.');
+        when(tiw.getEventBus()).thenReturn(eventbus);
     }
 
     @Test
@@ -63,7 +65,7 @@ public class AliasCommandTest {
         command.execute(tiw, new CommandArguments(controller, "/foo"),
                 new CommandContext(null, AliasCommand.INFO));
 
-        verify(tiw).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test
@@ -71,7 +73,7 @@ public class AliasCommandTest {
         command.execute(tiw, new CommandArguments(controller, "/foo --remove"),
                 new CommandContext(null, AliasCommand.INFO));
 
-        verify(tiw).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
 }

test/com/dmdirc/commandparser/commands/global/IfpluginTest.java

@@ -21,10 +21,12 @@
  */
 package com.dmdirc.commandparser.commands.global;
 
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.GlobalWindow;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.commandparser.parsers.GlobalCommandParser;
+import com.dmdirc.events.CommandErrorEvent;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.WindowModel;
 import com.dmdirc.plugins.PluginManager;
@@ -38,10 +40,9 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Matchers.anyChar;
-import static org.mockito.Matchers.anyString;
-import static org.mockito.Matchers.eq;
+import static org.mockito.Matchers.isA;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 @RunWith(MockitoJUnitRunner.class)
 public class IfpluginTest {
@@ -52,10 +53,12 @@ public class IfpluginTest {
     @Mock private CommandController controller;
     @Mock private PluginManager pluginManager;
     @Mock private WindowModel tiw;
+    @Mock private DMDircMBassador eventbus;
     private Ifplugin command;
 
     @Before
     public void setUp() {
+        when(tiw.getEventBus()).thenReturn(eventbus);
         command = new Ifplugin(controller, pluginManager, gcpProvider, gwProvider,
                 tabCompleterUtils);
     }
@@ -64,16 +67,14 @@ public class IfpluginTest {
     public void testUsageNoArgs() {
         command.execute(tiw, new CommandArguments(controller, "/foo"),
                 new CommandContext(null, Ifplugin.INFO));
-
-        verify(tiw).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test
     public void testUsageOneArg() {
         command.execute(tiw, new CommandArguments(controller, "/foo bar"),
                 new CommandContext(null, Ifplugin.INFO));
-
-        verify(tiw).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventbus).publishAsync(isA(CommandErrorEvent.class));
     }
 
 }

test/com/dmdirc/commandparser/commands/global/NewServerTest.java

@@ -106,7 +106,7 @@ public class NewServerTest {
         command.execute(container, new CommandArguments(controller, "/foo"),
                 new CommandContext(null, NewServer.INFO));
 
-        verify(container).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventBus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test

test/com/dmdirc/commandparser/commands/server/ChangeServerTest.java

@@ -41,8 +41,6 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Matchers.anyChar;
-import static org.mockito.Matchers.anyString;
 import static org.mockito.Matchers.eq;
 import static org.mockito.Matchers.isA;
 import static org.mockito.Matchers.same;
@@ -73,7 +71,7 @@ public class ChangeServerTest {
         command.execute(tiw, new CommandArguments(controller, "/server"),
                 new ServerCommandContext(null, ChangeServer.INFO, connection));
 
-        verify(tiw).addLine(eq("commandUsage"), anyChar(), anyString(), anyString());
+        verify(eventBus).publishAsync(isA(CommandErrorEvent.class));
     }
 
     @Test