Merge pull request #618 from csmith/tidying

Improve formatting of whois events.

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

@@ -211,8 +211,8 @@ UnknownCommandEvent:
 UserInfoResponseEvent:
   before: "---------- User info for {{user.nickname}} ----------"
   after: "--------- End of info for {{user.nickname}} ---------"
-  iterate: "entries"
-  format: "{{key}}: {{value}}"
+  iterate: "properties"
+  format: "{{friendlyName}}: {{rawValue}}"
   colour: 10
 
 ################## TODO ############################################################################
@@ -237,12 +237,6 @@ UserInfoResponseEvent:
 #  numeric_290=%4$s
 #  numeric_292=%4$s
 #  numeric_294=%4$s
-#  numeric_301=%4$s is away: %5$s
-#  numeric_311=-\n%4$s is %5$s@%6$s (%8$s).
-#  numeric_312=%4$s is connected to %5$s (%6$s).
-#  numeric_317=%4$s has been idle for %5$u; signed on at %6$TT on %6$TF.
-#  numeric_318=End of WHOIS info for %4$s.\n-
-#  numeric_319=%4$s is on: %5$s
 #  numeric_401=6A7000%4$s: %5$s
 #  numeric_404=6A7000%5$s
 #  numeric_405=6A7000%4$s: %5$s

src/com/dmdirc/ClientModule.java

@@ -36,14 +36,12 @@ import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.ConnectionFactory;
 import com.dmdirc.interfaces.ConnectionManager;
 import com.dmdirc.interfaces.LifecycleController;
-import com.dmdirc.interfaces.SystemLifecycleComponent;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.config.IdentityController;
 import com.dmdirc.plugins.PluginModule;
 import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.messages.ColourManagerFactory;
 import com.dmdirc.ui.messages.UiMessagesModule;
-import com.dmdirc.ui.messages.WhoisNumericFormatter;
 import com.dmdirc.ui.messages.sink.MessagesModule;
 import com.dmdirc.ui.themes.ThemeManager;
 import com.dmdirc.updater.UpdaterModule;
@@ -182,10 +180,4 @@ public class ClientModule {
         return objectGraph;
     }
 
-    @Provides(type = Provides.Type.SET)
-    public SystemLifecycleComponent getWhoisNumericFormatter(
-            final WhoisNumericFormatter formatter) {
-        return formatter;
-    }
-
 }

src/com/dmdirc/events/UserInfoResponseEvent.java

@@ -37,13 +37,14 @@ import java.util.Optional;
 public class UserInfoResponseEvent extends ServerDisplayableEvent {
 
     private final User user;
-    private final Map<UserInfoEvent.UserInfoType, String> info;
+    private final Map<UserInfoEvent.UserInfoType, UserInfoProperty> info;
 
     public UserInfoResponseEvent(final Connection connection, final long date,
             final User user, final Map<UserInfoEvent.UserInfoType, String> info) {
         super(date, connection);
         this.user = user;
-        this.info = new EnumMap<>(info);
+        this.info = new EnumMap<>(UserInfoEvent.UserInfoType.class);
+        info.forEach((key, value) -> this.info.put(key, new UserInfoProperty(key, value)));
     }
 
     /**
@@ -63,16 +64,40 @@ public class UserInfoResponseEvent extends ServerDisplayableEvent {
      * @return An optional containing the information, if it was provided.
      */
     public Optional<String> getInfo(final UserInfoEvent.UserInfoType type) {
-        return Optional.ofNullable(info.get(type));
+        return Optional.ofNullable(info.get(type)).map(UserInfoProperty::getRawValue);
     }
 
     /**
-     * Gets a collection of all info entries in the response.
+     * Gets a collection of all info properties in the response.
      *
-     * @return A collection of all user info entries.
+     * @return A collection of all user info properties.
      */
-    public Collection<Map.Entry<UserInfoEvent.UserInfoType, String>> getEntries() {
-        return info.entrySet();
+    public Collection<UserInfoProperty> getProperties() {
+        return info.values();
+    }
+
+    public static class UserInfoProperty {
+
+        private final UserInfoEvent.UserInfoType type;
+        private final String rawValue;
+
+        public UserInfoProperty(final UserInfoEvent.UserInfoType type, final String rawValue) {
+            this.type = type;
+            this.rawValue = rawValue;
+        }
+
+        public UserInfoEvent.UserInfoType getType() {
+            return type;
+        }
+
+        public String getRawValue() {
+            return rawValue;
+        }
+
+        public String getFriendlyName() {
+            return type.name().charAt(0) + type.name().substring(1).toLowerCase().replace('_', ' ');
+        }
+
     }
 
 }

src/com/dmdirc/ui/messages/WhoisNumericFormatter.java

@@ -1,157 +0,0 @@
-/*
- * 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.ui.messages;
-
-import com.dmdirc.ClientModule;
-import com.dmdirc.DMDircMBassador;
-import com.dmdirc.events.ServerDisconnectedEvent;
-import com.dmdirc.events.ServerNumericEvent;
-import com.dmdirc.interfaces.Connection;
-import com.dmdirc.interfaces.SystemLifecycleComponent;
-import com.dmdirc.interfaces.config.ConfigProvider;
-
-import java.util.HashMap;
-import java.util.Map;
-
-import javax.inject.Inject;
-import javax.inject.Singleton;
-
-import net.engio.mbassy.listener.Handler;
-
-/**
- * Listens for whois-like numeric events and automatically formats them.
- *
- * @since 0.6.3
- */
-@Singleton
-public class WhoisNumericFormatter implements SystemLifecycleComponent {
-
-    /** The name of the target of any current whois requests. */
-    private final Map<Connection, String> targets = new HashMap<>();
-    /** The identity to add formatters to. */
-    private final ConfigProvider identity;
-    /** Event bus to subscribe to events on. */
-    private final DMDircMBassador eventBus;
-
-    /**
-     * Creates a new whois numeric formatter that will add automatic formats to the specified
-     * identity. This will normally be a temporary global identity.
-     *
-     * @param identity The identity to write formatters to
-     * @param eventBus The event bus to subscribe to events on
-     */
-    @Inject
-    public WhoisNumericFormatter(
-            @ClientModule.AddonConfig final ConfigProvider identity,
-            final DMDircMBassador eventBus) {
-        this.identity = identity;
-        this.eventBus = eventBus;
-    }
-
-    /**
-     * Handles a server disconnected event. This clears any entry for that server in the
-     * {@link #targets} map.
-     *
-     * @param event The server disconnected event to process
-     */
-    @Handler
-    public void handleServerDisconnected(final ServerDisconnectedEvent event) {
-        targets.remove(event.getConnection());
-    }
-
-    /**
-     * Handles a received numeric event. This method has special handling for numerics 311 and 318,
-     * used to signal the start and end of a WHOIS request. It then monitors any other numerics
-     * without formatters for events which look like WHOIS information, and formats them
-     * automatically.
-     *
-     * @param event The server numeric event to process
-     */
-    @Handler
-    public void handleNumeric(final ServerNumericEvent event) {
-        final Connection server = event.getConnection();
-        final int numeric = event.getNumeric();
-        final String[] arguments = event.getArgs();
-        switch (numeric) {
-            case 311: // RPL_WHOISUSER
-                targets.put(server, arguments[3]);
-                break;
-            case 318: // RPL_ENDOFWHOIS
-                targets.remove(server);
-                break;
-            default:
-                if (arguments.length > 4
-                        && targets.containsKey(server)
-                        && arguments[3].equals(targets.get(server))) {
-                    // This numeric should be automatically formatted.
-
-                    if (event.getDisplayFormat().isEmpty()) {
-                        // No custom formatter, switch it to an auto whois
-                        // format and target.
-                        final String target = "numeric_autowhois_" + (arguments.length - 4);
-                        ensureExists(target, arguments.length);
-                        event.setDisplayFormat(target);
-                    } else {
-                        // There's a custom format. We'll see if we need to
-                        // add a formatter or notification settings for it
-                        // anyway.
-                        ensureExists(event.getDisplayFormat(), arguments.length);
-                    }
-                }
-                break;
-        }
-    }
-
-    /**
-     * Ensures that the specified formatter exists in our identity.
-     *
-     * @param target    The target to be checked and added if necessary
-     * @param arguments The number of arguments for the numeric
-     */
-    private void ensureExists(final String target, final int arguments) {
-        if (!identity.hasOptionString("formatter", target)) {
-            final StringBuilder builder = new StringBuilder("%4$s %" + arguments + "$s");
-            for (int i = 5; i < arguments; i++) {
-                builder.append(" %");
-                builder.append(i);
-                builder.append("$s");
-            }
-
-            identity.setOption("formatter", target, builder.toString());
-        }
-
-        if (!identity.hasOptionString("notifications", target)) {
-            identity.setOption("notifications", target, "group:whois");
-        }
-    }
-
-    @Override
-    public void startUp() {
-        eventBus.subscribe(this);
-    }
-
-    @Override
-    public void shutDown() {
-        eventBus.unsubscribe(this);
-    }
-}