Move some more formats over to events.

This allows us to remove a fair chunk of the notification
handling functionality in FrameContainer.

Issue 426

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

@@ -41,6 +41,12 @@ ServerAuthNoticeEvent:
 ServerInviteReceivedEvent:
   format: "* You have been invited to {{channel}} by {{user.nickname}}."
   colour: 2
+ServerUserModesEvent:
+  format: "* User modes are: {{modes}}."
+  colour: 3
+ServerNickChangeEvent:
+  format: "* You are now known as {{newNick}}."
+  colour: 3
 ServerErrorEvent:
   format: "ERROR: {{reason}}"
   colour: 4
@@ -53,6 +59,24 @@ ServerNoticeEvent:
 ServerServerNoticeEvent:
   format: "-{{user.nickname}}- {{message}}"
   colour: 5
+ServerUnknownMessageEvent:
+  format: "<[{{sender}}:{{target}}]> {{message}}"
+  colour: 5
+ServerUnknownNoticeEvent:
+  format: "-[{{sender}}:{{target}}]- {{message}}"
+  colour: 5
+ServerUnknownActionEvent:
+  format: "* [{{sender}}:{{target}}] {{message}}"
+  colour: 5
+ServerWallopsEvent:
+  format: "${{user.nickname}}$ {{message}}"
+  colour: 5
+ServerWallusersEvent:
+  format: "!{{user.nickname}}! {{message}}"
+  colour: 5
+ServerWalldesyncEvent:
+  format: "/{{user.nickname}}/ {{message}}"
+  colour: 5
 
 ################## Channel join/part/quit events ###################################################
 
@@ -178,12 +202,6 @@ CommandOutputEvent:
   format: "{{message}}"
 
 ################## TODO ############################################################################
-#  userModeChanged=3* %1$s sets user mode: %4$s.
-#  userNoModes=3* No user modes.
-#  userModeDiscovered=3* User modes are: %4$s.
-#  walluser=5!%1$s! %4$s
-#  wallop=5$%1$s$ %4$s
-#  walldesync=5/%1$s/ %4$s
 #  selfCTCP=4->- [%1$s] %2$s
 #  selfNotice=5>%1$s> %2$s
 #  selfMessage=>[%1$s]> %2$s
@@ -196,10 +214,6 @@ CommandOutputEvent:
 #  actionTooLong=Warning: action too long to be sent
 #  tabCompletion=14Multiple possibilities: %1$s
 #  serverUnknownProtocol=4Unknown protocol '%1$s'. Unable to connect.
-#  selfNickChange=3* You are now known as %2$s.
-#  unknownNotice=5-[%1$s:%2$s]- %3$s
-#  unknownMessage=5<[%1$s:%2$s]> %3$s
-#  unknownNotice=5* [%1$s:%2$s] %3$s
 #  commandUsage=7Usage: %1$s%2$s %3$s
 #  numeric_006=%4$s
 #  numeric_007=%4$s

src/com/dmdirc/Channel.java

@@ -413,45 +413,6 @@ public class Channel extends FrameContainer implements GroupChat {
         return res;
     }
 
-    @Override
-    protected boolean processNotificationArg(final Object arg, final List<Object> args) {
-        if (arg instanceof User) {
-            final User clientInfo = (User) arg;
-            args.add(clientInfo.getNickname());
-            args.add(clientInfo.getUsername());
-            args.add(clientInfo.getHostname());
-
-            return true;
-        } else if (arg instanceof GroupChatUser) {
-            final GroupChatUser clientInfo = (GroupChatUser) arg;
-
-            args.addAll(Arrays.asList(getDetails(clientInfo)));
-
-            return true;
-        } else if (arg instanceof Topic) {
-            // Format topics
-            final Topic topic = (Topic) arg;
-            args.add("");
-            args.add(topic.getClient().map(GroupChatUser::getNickname).orElse("Unknown"));
-            args.add(topic.getClient().flatMap(GroupChatUser::getUsername).orElse(""));
-            args.add(topic.getClient().flatMap(GroupChatUser::getHostname).orElse(""));
-            args.add(topic.getTopic());
-            args.add(topic.getDate().getTime());
-
-            return true;
-        } else {
-            // Everything else - default formatting
-
-            return super.processNotificationArg(arg, args);
-        }
-    }
-
-    @Override
-    protected void modifyNotificationArgs(final List<Object> actionArgs,
-            final List<Object> messageArgs) {
-        messageArgs.add(channelInfo.getName());
-    }
-
     // ---------------------------------------------------- TOPIC HANDLING -----
     /**
      * Adds the specified topic to this channel's topic list.

src/com/dmdirc/FrameContainer.java

@@ -421,58 +421,6 @@ public abstract class FrameContainer implements WindowModel {
         return lines;
     }
 
-    /**
-     * Processes and displays a notification.
-     *
-     * @param messageType The name of the formatter to be used for the message
-     * @param args        The arguments for the message
-     *
-     * @return True if any further behaviour should be executed, false otherwise
-     */
-    public boolean doNotification(final String messageType, final Object... args) {
-        final List<Object> messageArgs = new ArrayList<>();
-        final List<Object> actionArgs = new ArrayList<>();
-
-        actionArgs.add(this);
-
-        for (Object arg : args) {
-            actionArgs.add(arg);
-
-            if (!processNotificationArg(arg, messageArgs)) {
-                messageArgs.add(arg);
-            }
-        }
-
-        modifyNotificationArgs(actionArgs, messageArgs);
-
-        handleNotification(new Date(), messageType, messageArgs.toArray());
-
-        return true;
-    }
-
-    /**
-     * Allows subclasses to modify the lists of arguments for notifications.
-     *
-     * @param actionArgs  The list of arguments to be passed to the actions system
-     * @param messageArgs The list of arguments to be passed to the formatter
-     */
-    protected void modifyNotificationArgs(final List<Object> actionArgs,
-            final List<Object> messageArgs) {
-        // Do nothing
-    }
-
-    /**
-     * Allows subclasses to process specific types of notification arguments.
-     *
-     * @param arg  The argument to be processed
-     * @param args The list of arguments that any data should be appended to
-     *
-     * @return True if the arg has been processed, false otherwise
-     */
-    protected boolean processNotificationArg(final Object arg, final List<Object> args) {
-        return false;
-    }
-
     /**
      * Handles general server notifications (i.e., ones not tied to a specific window). The user can
      * select where the notifications should go in their config.

src/com/dmdirc/Query.java

@@ -51,7 +51,6 @@ import com.dmdirc.ui.messages.sink.MessageSinkManager;
 
 import java.awt.Toolkit;
 import java.util.Arrays;
-import java.util.List;
 import java.util.Optional;
 
 import net.engio.mbassy.listener.Handler;
@@ -113,19 +112,6 @@ public class Query extends FrameContainer implements PrivateChat {
         });
     }
 
-    @Override
-    protected boolean processNotificationArg(final Object arg, final List<Object> args) {
-        if (arg instanceof User) {
-            final User clientInfo = (User) arg;
-            args.add(clientInfo.getNickname());
-            args.add(clientInfo.getUsername());
-            args.add(clientInfo.getHostname());
-            return true;
-        } else {
-            return super.processNotificationArg(arg, args);
-        }
-    }
-
     @Override
     public int getMaxLineLength() {
         // TODO: The parser layer should abstract this

src/com/dmdirc/Server.java

@@ -792,19 +792,6 @@ public class Server extends FrameContainer implements Connection {
         return Optional.of(this);
     }
 
-    @Override
-    protected boolean processNotificationArg(final Object arg, final List<Object> args) {
-        if (arg instanceof User) {
-            final User clientInfo = (User) arg;
-            args.add(clientInfo.getNickname());
-            args.add(clientInfo.getUsername());
-            args.add(clientInfo.getHostname());
-            return true;
-        } else {
-            return super.processNotificationArg(arg, args);
-        }
-    }
-
     @Override
     public void updateTitle() {
         synchronized (myStateLock) {

src/com/dmdirc/ServerEventHandler.java

@@ -347,11 +347,8 @@ public class ServerEventHandler extends EventHandler {
 
     @Handler
     public void onUnknownNotice(final UnknownNoticeEvent event) {
-        final ServerUnknownNoticeEvent
-                coreEvent = new ServerUnknownNoticeEvent(owner, event.getHost(), event.getTarget(),
-                event.getMessage());
-        final String format = EventUtils.postDisplayable(eventBus, coreEvent, "unknownNotice");
-        owner.doNotification(format, event.getHost(), event.getTarget(), event.getMessage());
+        eventBus.publishAsync(new ServerUnknownNoticeEvent(
+                owner, event.getHost(), event.getTarget(),event.getMessage()));
     }
 
     @Handler
@@ -362,10 +359,8 @@ public class ServerEventHandler extends EventHandler {
                     new QuerySelfMessageEvent(owner.getQuery(event.getTarget()), owner.getLocalUser().get(),
                             event.getMessage()));
         } else {
-            final ServerUnknownMessageEvent coreEvent
-                    = new ServerUnknownMessageEvent(owner, event.getHost(), event.getTarget(), event.getMessage());
-            final String format = EventUtils.postDisplayable(eventBus, coreEvent, "unknownMessage");
-            owner.doNotification(format, event.getHost(), event.getTarget(), event.getMessage());
+            eventBus.publishAsync(new ServerUnknownMessageEvent(
+                    owner, event.getHost(), event.getTarget(), event.getMessage()));
         }
     }
 
@@ -377,28 +372,21 @@ public class ServerEventHandler extends EventHandler {
                     new QuerySelfActionEvent(owner.getQuery(event.getTarget()), owner.getLocalUser().get(),
                             event.getMessage()));
         } else {
-            final ServerUnknownActionEvent coreEvent
-                    = new ServerUnknownActionEvent(owner, event.getHost(), event.getTarget(), event.getMessage());
-            final String format = EventUtils.postDisplayable(eventBus, coreEvent, "unknownAction");
-            owner.doNotification(format, event.getHost(), event.getTarget(), event.getMessage());
+            eventBus.publishAsync(new ServerUnknownActionEvent(
+                    owner, event.getHost(), event.getTarget(), event.getMessage()));
         }
     }
 
     @Handler
     public void onUserModeChanged(final UserModeChangeEvent event) {
-        final ServerUserModesEvent coreEvent = new ServerUserModesEvent(owner,
-                owner.getUser(event.getClient().getHostname()), event.getModes());
-        final String format = EventUtils.postDisplayable(eventBus, coreEvent, "userModeChanged");
-        owner.doNotification(format, owner.getUser(event.getClient().getHostname()), event.getModes());
+        eventBus.publishAsync(new ServerUserModesEvent(
+                owner, owner.getUser(event.getClient().getHostname()), event.getModes()));
     }
 
     @Handler
     public void onUserModeDiscovered(final UserModeDiscoveryEvent event) {
-        final ServerUserModesEvent coreEvent = new ServerUserModesEvent(owner,
-                owner.getUser(event.getClient().getHostname()), event.getModes());
-        final String format = EventUtils.postDisplayable(eventBus, coreEvent,
-                event.getModes().isEmpty() || "+".equals(event.getModes()) ? "userNoModes" : "userModeDiscovered");
-        owner.doNotification(format, owner.getUser(event.getClient().getHostname()), event.getModes());
+        eventBus.publishAsync(new ServerUserModesEvent(
+                owner, owner.getUser(event.getClient().getHostname()), event.getModes()));
     }
 
     @Handler
@@ -412,36 +400,27 @@ public class ServerEventHandler extends EventHandler {
 
     @Handler
     public void onWallop(final WallopEvent event) {
-        final ServerWallopsEvent coreEvent = new ServerWallopsEvent(owner,
-                owner.getUser(event.getHost()), event.getMessage());
-        final String format = EventUtils.postDisplayable(eventBus, coreEvent, "wallop");
-        owner.doNotification(format, owner.getUser(event.getHost()), event.getMessage());
-
+        eventBus.publishAsync(new ServerWallopsEvent(owner,
+                owner.getUser(event.getHost()), event.getMessage()));
     }
 
     @Handler
     public void onWalluser(final WalluserEvent event) {
-        final ServerWallusersEvent coreEvent = new ServerWallusersEvent(owner,
-                owner.getLocalUser().get(), event.getMessage());
-        final String format = EventUtils.postDisplayable(eventBus, coreEvent, "walluser");
-        owner.doNotification(format, owner.getUser(event.getHost()), event.getMessage());
+        eventBus.publishAsync(new ServerWallusersEvent(owner,
+                owner.getLocalUser().get(), event.getMessage()));
     }
 
     @Handler
     public void onWallDesync(final WallDesyncEvent event) {
-        final ServerWalldesyncEvent coreEvent = new ServerWalldesyncEvent(owner,
-                owner.getLocalUser().get(), event.getMessage());
-        final String format = EventUtils.postDisplayable(eventBus, coreEvent, "walldesync");
-        owner.doNotification(format, owner.getUser(event.getHost()), event.getMessage());
+        eventBus.publishAsync(new ServerWalldesyncEvent(owner,
+                owner.getLocalUser().get(), event.getMessage()));
     }
 
     @Handler
     public void onNickChanged(final NickChangeEvent event) {
         if (event.getClient().equals(owner.getParser().get().getLocalClient())) {
-            final ServerNickChangeEvent coreEvent = new ServerNickChangeEvent(owner,
-                    event.getOldNick(), event.getClient().getNickname());
-            final String format = EventUtils.postDisplayable(eventBus, coreEvent, "selfNickChange");
-            owner.doNotification(format, event.getOldNick(), event.getClient().getNickname());
+            eventBus.publishAsync(new ServerNickChangeEvent(owner,
+                    event.getOldNick(), event.getClient().getNickname()));
             owner.updateTitle();
         }
     }

src/com/dmdirc/events/ServerUserModesEvent.java

@@ -31,28 +31,27 @@ import com.dmdirc.interfaces.User;
 public class ServerUserModesEvent extends ServerDisplayableEvent {
 
     private final User user;
-    private final String message;
+    private final String modes;
 
     public ServerUserModesEvent(final long timestamp, final Connection connection, final User user,
-            final String message) {
+            final String modes) {
         super(timestamp, connection);
         this.user = user;
-        this.message = message;
+        this.modes = modes;
     }
 
-    public ServerUserModesEvent(final Connection connection, final User user, final String
-            message) {
+    public ServerUserModesEvent(final Connection connection, final User user, final String modes) {
         super(connection);
         this.user = user;
-        this.message = message;
+        this.modes = modes;
     }
 
     public User getUser() {
         return user;
     }
 
-    public String getMessage() {
-        return message;
+    public String getModes() {
+        return modes;
     }
 
 }