Merge pull request #612 from csmith/tidying

Move some more formats over to events.

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

@@ -8,6 +8,8 @@ ServerCtcpEvent:
 ServerCtcpReplyEvent:
   format: "-!- CTCP {{type}} reply from {{user.nickname}}: {{content}}."
   colour: 4
+ServerConnectingEvent:
+  format: "Connecting to {{uri.host}}:{{uri.port}}..."
 ServerDisconnectedEvent:
   format: "-!- You have been disconnected from the server."
   colour: 2
@@ -41,9 +43,18 @@ 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
+ServerUnknownProtocolEvent:
+  format: "Unknown protocol '{{protocol}}'. Unable to connect."
+  colour: 4
 
 ################## Server messaging events #########################################################
 
@@ -53,6 +64,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,16 +207,9 @@ 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
-#  serverConnecting=Connecting to %1$s:%2$s...
 #  serverDisconnectInProgress=A disconnection attempt is in progress, please wait...
 #  serverConnectInProgress=A connection attempt is in progress, please wait...
 #  rawCommand=10>>> %1$s
@@ -195,11 +217,6 @@ CommandOutputEvent:
 #  commandOutput=%1$s
 #  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

@@ -319,24 +319,6 @@ public abstract class FrameContainer implements WindowModel {
         addLine(type, new Date(), args);
     }
 
-    @Override
-    public void addLine(final StringBuffer type, final Date timestamp, final Object... args) {
-        if (type != null) {
-            addLine(type.toString(), timestamp, args);
-        }
-    }
-
-    @Override
-    public void addLine(final StringBuffer type, final Object... args) {
-        addLine(type, new Date(), args);
-    }
-
-    @Override
-    @Deprecated
-    public void addLine(final String line, final boolean timestamp) {
-        addLine(line, new Date());
-    }
-
     @Override
     public void addLine(final String line, final Date timestamp) {
         for (final String myLine : line.split("\n")) {
@@ -421,58 +403,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

@@ -29,6 +29,7 @@ import com.dmdirc.events.ServerConnectedEvent;
 import com.dmdirc.events.ServerConnectingEvent;
 import com.dmdirc.events.ServerDisconnectedEvent;
 import com.dmdirc.events.ServerReconnectScheduledEvent;
+import com.dmdirc.events.ServerUnknownProtocolEvent;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.GroupChatManager;
 import com.dmdirc.interfaces.InviteManager;
@@ -69,7 +70,6 @@ import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Date;
-import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.ConcurrentSkipListMap;
@@ -322,7 +322,8 @@ public class Server extends FrameContainer implements Connection {
                 parser = Optional.ofNullable(buildParser());
 
                 if (!parser.isPresent()) {
-                    addLine("serverUnknownProtocol", address.getScheme());
+                    getEventBus().publishAsync(
+                            new ServerUnknownProtocolEvent(this, address.getScheme()));
                     return;
                 }
 
@@ -332,8 +333,6 @@ public class Server extends FrameContainer implements Connection {
                 parserLock.writeLock().unlock();
             }
 
-            addLine("serverConnecting", connectAddress.getHost(), connectAddress.getPort());
-
             myState.transition(ServerState.CONNECTING);
 
             doCallbacks();
@@ -348,7 +347,7 @@ public class Server extends FrameContainer implements Connection {
             }
         }
 
-        getEventBus().publish(new ServerConnectingEvent(this));
+        getEventBus().publish(new ServerConnectingEvent(this, address));
     }
 
     @Override
@@ -792,19 +791,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/ServerConnectingEvent.java

@@ -24,17 +24,27 @@ package com.dmdirc.events;
 
 import com.dmdirc.interfaces.Connection;
 
+import java.net.URI;
+
 /**
  * Fire when a server is connecting.
  */
-public class ServerConnectingEvent extends ServerEvent {
+public class ServerConnectingEvent extends ServerDisplayableEvent {
+
+    private final URI uri;
 
-    public ServerConnectingEvent(final Connection connection) {
+    public ServerConnectingEvent(final Connection connection, final URI uri) {
         super(connection);
+        this.uri = uri;
     }
 
-    public ServerConnectingEvent(final long timestamp, final Connection connection) {
+    public ServerConnectingEvent(final long timestamp, final Connection connection, final URI uri) {
         super(timestamp, connection);
+        this.uri = uri;
+    }
+
+    public URI getUri() {
+        return uri;
     }
 
 }

src/com/dmdirc/events/ServerUnknownProtocolEvent.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.interfaces.Connection;
+
+/**
+ * Raised when a server attempts to connect to an unknown protocol.
+ */
+public class ServerUnknownProtocolEvent extends ServerDisplayableEvent {
+
+    private final String protocol;
+
+    public ServerUnknownProtocolEvent(final long timestamp, final Connection connection, final String protocol) {
+        super(timestamp, connection);
+        this.protocol = protocol;
+    }
+
+    public ServerUnknownProtocolEvent(final Connection connection, final String protocol) {
+        super(connection);
+        this.protocol = protocol;
+    }
+
+    public String getProtocol() {
+        return protocol;
+    }
+
+}

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;
     }
 
 }

src/com/dmdirc/interfaces/WindowModel.java

@@ -161,37 +161,6 @@ public interface WindowModel {
      */
     void addLine(String type, Object... args);
 
-    /**
-     * Adds a line to this container's window. If the window is null for some reason, the line is
-     * silently discarded.
-     *
-     * @param type      The message type to use
-     * @param timestamp The timestamp to use for this line
-     * @param args      The message's arguments
-     *
-     * @since 0.6.4
-     */
-    void addLine(StringBuffer type, Date timestamp, Object... args);
-
-    /**
-     * Adds a line to this container's window. If the window is null for some reason, the line is
-     * silently discarded.
-     *
-     * @param type The message type to use
-     * @param args The message's arguments
-     */
-    void addLine(StringBuffer type, Object... args);
-
-    /**
-     * Adds the specified raw line to the window, without using a formatter.
-     *
-     * @param line      The line to be added
-     * @param timestamp Whether or not to display the timestamp for this line
-     * @deprecated Timestamps are always displayed.
-     */
-    @Deprecated
-    void addLine(String line, boolean timestamp);
-
     /**
      * Adds the specified raw line to the window, without using a formatter, and using the specified
      * timestamp. If the timestamp is <code>null</code>, no timestamp is added.