Auto numeric formatting

Fixes issue 3678

Squashed commit of the following:

commit 896c815005
Author: Chris Smith <chris@dmdirc.com>
Date:   Sat Jan 30 21:05:09 2010 +0000

    Add whois numeric formatter

    Change-Id: I474fe3778a9314212d69f6b0d4d95aec7ad3ecee

commit 11f13651ad
Author: Chris Smith <chris@dmdirc.com>
Date:   Fri Oct 24 19:02:05 2008 +0100

    No longer check for formatter.numeric_<ircd>_<xxx> settings

commit cc078694da
Author: Chris Smith <chris@dmdirc.com>
Date:   Fri Oct 24 18:59:29 2008 +0100

    Numerics with no applicable formatters can now be formatted by actions/plugins

Change-Id: I7c574c1f06f2d0bb77a4fe1ec855153f7e3d347e
Reviewed-on: http://gerrit.dmdirc.com/737
Reviewed-by: Gregory Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

src/com/dmdirc/Server.java

@@ -1279,13 +1279,10 @@ public class Server extends WritableFrameContainer implements
             snumeric = "0" + snumeric;
         }
 
-        final String withIrcd = "numeric_" + parser.getServerSoftwareType() + "_" + snumeric;
         final String sansIrcd = "numeric_" + snumeric;
-        StringBuffer target = null;
+        StringBuffer target = new StringBuffer("");
 
-        if (getConfigManager().hasOptionString("formatter", withIrcd)) {
-            target = new StringBuffer(withIrcd);
-        } else if (getConfigManager().hasOptionString("formatter", sansIrcd)) {
+        if (getConfigManager().hasOptionString("formatter", sansIrcd)) {
             target = new StringBuffer(sansIrcd);
         } else if (getConfigManager().hasOptionString("formatter", "numeric_unknown")) {
             target = new StringBuffer("numeric_unknown");
@@ -1294,9 +1291,7 @@ public class Server extends WritableFrameContainer implements
         ActionManager.processEvent(CoreActionType.SERVER_NUMERIC, target, this,
                 Integer.valueOf(numeric), tokens);
 
-        if (target != null) {
-            handleNotification(target.toString(), (Object[]) tokens);
-        }
+        handleNotification(target.toString(), (Object[]) tokens);
     }
 
     /**

src/com/dmdirc/actions/ActionManager.java

@@ -27,6 +27,7 @@ import com.dmdirc.Precondition;
 import com.dmdirc.actions.interfaces.ActionComparison;
 import com.dmdirc.actions.interfaces.ActionComponent;
 import com.dmdirc.actions.interfaces.ActionType;
+import com.dmdirc.actions.internal.WhoisNumericFormatter;
 import com.dmdirc.actions.wrappers.AliasWrapper;
 import com.dmdirc.actions.wrappers.PerformWrapper;
 import com.dmdirc.config.IdentityManager;
@@ -103,6 +104,8 @@ public final class ActionManager {
 
         registerGroup(AliasWrapper.getAliasWrapper());
         registerGroup(PerformWrapper.getPerformWrapper());
+
+        new WhoisNumericFormatter(IdentityManager.getAddonIdentity()).register();
        
         // Register a listener for the closing event, so we can save actions
         addListener(new ActionListener() {

src/com/dmdirc/actions/internal/WhoisNumericFormatter.java

@@ -0,0 +1,145 @@
+/*
+ * Copyright (c) 2006-2010 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.actions.internal;
+
+import com.dmdirc.Server;
+import com.dmdirc.actions.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.actions.interfaces.ActionType;
+import com.dmdirc.config.Identity;
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.interfaces.ActionListener;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Listens for whois-like numeric events and automatically formats them.
+ *
+ * @since 0.6.3
+ * @author chris
+ */
+public class WhoisNumericFormatter implements ActionListener {
+
+    /** The name of the target of any current whois requests. */
+    private final Map<Server, String> targets = new HashMap<Server, String>();
+
+    /** The identity to add formatters to. */
+    private final Identity identity;
+
+    /**
+     * Creates a new whois numeric formatter that will add automatic formats
+     * to the specified identity. This will normally be a temporary global
+     * identity, such as the one returned by
+     * {@link IdentityManager#getAddonIdentity()}.
+     *
+     * @param identity The identity to write formatters to
+     */
+    public WhoisNumericFormatter(final Identity identity) {
+        this.identity = identity;
+    }
+
+    /**
+     * Registers this this whois numeric formatter with the global actions
+     * manager.
+     */
+    public void register() {
+        ActionManager.addListener(this, CoreActionType.SERVER_NUMERIC,
+                CoreActionType.SERVER_DISCONNECTED);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format,
+            final Object... arguments) {
+        if (CoreActionType.SERVER_DISCONNECTED == type) {
+            handleServerDisconnected((Server) arguments[0]);
+        } else {
+            handleNumeric((Server) arguments[0], (Integer) arguments[1],
+                    (String[]) arguments[2], format);
+        }
+    }
+
+    /**
+     * Handles a server disconnected event. This clears any entry for that
+     * server in the <code>target</code> map.
+     *
+     * @param server The server that was disconnected
+     */
+    private void handleServerDisconnected(final Server server) {
+        targets.remove(server);
+    }
+
+    /**
+     * 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 server The server on which the event was received
+     * @param numeric The numeric code of the event
+     * @param arguments The arguments to the numeric event
+     * @param format The format that should be used to display the event
+     */
+    private void handleNumeric(final Server server, final int numeric,
+            final String[] arguments, final StringBuffer format) {
+        switch (numeric) {
+            case 311: // RPL_WHOISUSER
+                targets.put(server, arguments[3]);
+                break;
+            case 318: // RPL_ENDOFWHOIS
+                targets.remove(server);
+                break;
+            default:
+                if (format.length() == 0 && arguments.length > 4
+                        && targets.containsKey(server)
+                        && arguments[3].equals(targets.get(server))) {
+                    // This numeric should be automatically formatted.
+
+                    final String target = "numeric_auto_" + (arguments.length - 4);
+                    ensureExists(target, arguments.length);
+                    format.replace(0, format.length(), target);
+                }
+        }
+    }
+
+    /**
+     * 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());
+            identity.setOption("notification", target, "group:whois");
+        }
+    }
+
+}