Automagical fake client creation, using uber overly-complicated hacks

Fixes issue 2322

src/com/dmdirc/parser/irc/callbacks/CallbackObject.java

@@ -22,12 +22,19 @@
 
 package com.dmdirc.parser.irc.callbacks;
 
-import java.util.ArrayList;
-
 import com.dmdirc.parser.irc.IRCParser;
 import com.dmdirc.parser.irc.ParserError;
 import com.dmdirc.parser.irc.callbacks.interfaces.ICallbackInterface;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * CallbackObject.
@@ -140,6 +147,10 @@ public class CallbackObject {
         System.arraycopy(args, 0, newArgs, 1, args.length);
         newArgs[0] = myParser;
 
+        if (myParser.getCreateFake()) {
+            createFakeArgs(newArgs);
+        }
+
 		for (ICallbackInterface iface : new ArrayList<ICallbackInterface>(callbackInfo)) {
 			try {
                 type.getMethods()[0].invoke(iface, newArgs);
@@ -154,4 +165,111 @@ public class CallbackObject {
 		return bResult;
     }
 
+    /**
+     * Replaces all null entries in the specified array with fake values,
+     * if the corresponding parameter of this callback's type is marked with
+     * the {@link FakableArgument} annotation. The fake classes are constructed
+     * by using parameters designated {@link FakableSource}.
+     *
+     * @param args The arguments to be faked
+     */
+    protected void createFakeArgs(final Object[] args) {
+        int i = 0;
+
+        for (Annotation[] anns : type.getMethods()[0].getParameterAnnotations()) {
+            for (Annotation ann : anns) {
+                if (ann.annotationType().equals(FakableArgument.class)
+                        && args[i] == null) {
+                    args[i] = getFakeArg(args,
+                            type.getMethods()[0].getParameterTypes()[i],
+                            ((FakableArgument) ann).group());
+                }
+            }
+
+            i++;
+        }
+    }
+
+    /**
+     * Tries to create fake argument of the specified target class, by using
+     * {@link FakableSource} denoted parameters from the specified arg array.
+     * Parameters are only used if their groups value contains the specified
+     * group.
+     *
+     * If an argument is missing, the method attempts to create a fake instance
+     * by recursing into this method again. Note that this could cause an
+     * infinite recursion in cases of cyclic dependencies. If recursion fails,
+     * the constructor is skipped.
+     *
+     * If the created object has a <code>setFake(boolean)</code> method, it
+     * is automatically invoked with an argument of <code>true</code>.
+     *
+     * @param args The arguments array to use for sources
+     * @param target The class that should be constructed
+     * @param group The group of arguments to use
+     * @return An instance of the target class, or null on failure
+     */
+    protected Object getFakeArg(final Object[] args, final Class<?> target, final String group) {
+        final Map<Class, Object> sources = new HashMap<Class, Object>();
+        int i = 0;
+
+        for (Annotation[] anns : type.getMethods()[0].getParameterAnnotations()) {
+            for (Annotation ann : anns) {
+                if (ann.annotationType().equals(FakableSource.class)
+                        && Arrays.asList(((FakableSource) ann).group()).contains(group)) {
+                    sources.put(type.getMethods()[0].getParameterTypes()[i], args[i]);
+                }
+            }
+
+            i++;
+        }
+
+        for (Constructor<?> ctor : target.getConstructors()) {
+            Object[] params = new Object[ctor.getParameterTypes().length];
+
+            i = 0;
+            Object param;
+            boolean failed = false;
+
+            for (Class<?> needed : ctor.getParameterTypes()) {
+                if (sources.containsKey(needed)) {
+                    params[i] = sources.get(needed);
+                } else if ((param = getFakeArg(args, needed, group)) != null) {
+                    params[i] = param;
+                } else {
+                    failed = true;
+                }
+
+                i++;
+            }
+
+            if (!failed) {
+                try {
+                    final Object instance = ctor.newInstance(params);
+
+                    for (Method method : target.getMethods()) {
+                        if (method.getName().equals("setFake")
+                                && method.getParameterTypes().length == 1
+                                && method.getParameterTypes()[0].equals(Boolean.TYPE)) {
+
+                            method.invoke(instance, true);
+                        }
+                    }
+
+                    return instance;
+                } catch (InstantiationException ex) {
+                    // Do nothing
+                } catch (IllegalAccessException ex) {
+                    // Do nothing
+                } catch (IllegalArgumentException ex) {
+                    // Do nothing
+                } catch (InvocationTargetException ex) {
+                    // Do nothing
+                }
+            }
+        }
+
+        return null;
+    }
+
 }

src/com/dmdirc/parser/irc/callbacks/CallbackObjectSpecific.java

@@ -136,6 +136,10 @@ public class CallbackObjectSpecific extends CallbackObject {
         System.arraycopy(args, 0, newArgs, 1, args.length);
         newArgs[0] = myParser;
 
+        if (myParser.getCreateFake()) {
+            createFakeArgs(newArgs);
+        }
+
 		for (ICallbackInterface iface :new ArrayList<ICallbackInterface>(callbackInfo)) {
             if (type.isAnnotationPresent(SpecificCallback.class) &&
                     ((args[0] instanceof ClientInfo

src/com/dmdirc/parser/irc/callbacks/FakableArgument.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2006-2009 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.parser.irc.callbacks;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Indicates a specific argument may be faked.
+ *
+ * @since 0.6.3
+ * @author chris
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.PARAMETER)
+public @interface FakableArgument {
+
+    /**
+     * A group name used to differentiate between multiple fakable arguments
+     * in the same method.
+     *
+     * @return The name of the group for multiple fakable arguments
+     */
+    String group() default "default";
+
+}

src/com/dmdirc/parser/irc/callbacks/FakableSource.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2006-2009 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.parser.irc.callbacks;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Indicates that the specified argument is a source of data for fakable
+ * arguments.
+ *
+ * @since 0.6.3
+ * @author chris
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.PARAMETER)
+public @interface FakableSource {
+
+    /**
+     * A group name used to differentiate between multiple fakable arguments
+     * in the same method.
+     *
+     * @return The name of the groups for multiple fakable arguments
+     */
+    String[] group() default {"default"};
+
+}

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelAction.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /**
@@ -46,5 +48,10 @@ public interface IChannelAction extends ICallbackInterface {
 	 * @param sHost Hostname of sender (or servername)
 	 * @see com.dmdirc.parser.irc.ProcessMessage#callChannelAction
 	 */
-	void onChannelAction(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost);
+	void onChannelAction(
+            @FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            String sMessage,
+            @FakableSource String sHost);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelCTCP.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /**
@@ -47,5 +49,9 @@ public interface IChannelCTCP extends ICallbackInterface {
 	 * @param sHost Hostname of sender (or servername)
 	 * @see com.dmdirc.parser.irc.ProcessMessage#callChannelCTCP
 	 */
-	void onChannelCTCP(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sType, String sMessage, String sHost);
+	void onChannelCTCP(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            String sType, String sMessage,
+            @FakableSource String sHost);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelCTCPReply.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /**
@@ -47,5 +49,9 @@ public interface IChannelCTCPReply extends ICallbackInterface {
 	 * @param sHost Hostname of sender (or servername)
 	 * @see com.dmdirc.parser.irc.ProcessMessage#callChannelCTCPReply
 	 */
-	void onChannelCTCPReply(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sType, String sMessage, String sHost);
+	void onChannelCTCPReply(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            String sType, String sMessage,
+            @FakableSource String sHost);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelKick.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /**
@@ -45,5 +47,10 @@ public interface IChannelKick extends ICallbackInterface {
 	 * @param sKickedByHost Hostname of Kicker (or servername)
 	 * @see com.dmdirc.parser.irc.ProcessKick#callChannelKick
 	 */
-	void onChannelKick(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cKickedClient, ChannelClientInfo cKickedByClient, String sReason, String sKickedByHost);
+	void onChannelKick(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            ChannelClientInfo cKickedClient,
+            @FakableArgument ChannelClientInfo cKickedByClient,
+            String sReason,
+            @FakableSource String sKickedByHost);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelMessage.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /**
@@ -46,5 +48,9 @@ public interface IChannelMessage extends ICallbackInterface {
 	 * @param sHost Hostname of sender (or servername)
 	 * @see com.dmdirc.parser.irc.ProcessMessage#callChannelMessage
 	 */
-	void onChannelMessage(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost);
+	void onChannelMessage(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            String sMessage,
+            @FakableSource String sHost);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelModeChanged.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /** 
@@ -46,5 +48,9 @@ public interface IChannelModeChanged extends ICallbackInterface {
 	 * @param sModes String showing the exact mode change parsed.
 	 * @see com.dmdirc.parser.irc.ProcessMode#callChannelModeChanged
 	 */
-	void onChannelModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes);
+	void onChannelModeChanged(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            @FakableSource String sHost,
+            String sModes);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelNonUserModeChanged.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /** 
@@ -45,6 +47,10 @@ public interface IChannelNonUserModeChanged extends ICallbackInterface {
 	 * @param sHost Host doing the mode changing (User host or server name)
 	 * @param sModes String showing the exact mode change parsed. (Not including user modes)
 	 */
-	void onChannelNonUserModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes);
+	void onChannelNonUserModeChanged(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            @FakableSource String sHost,
+            String sModes);
 }
 

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelNotice.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /**
@@ -46,5 +48,9 @@ public interface IChannelNotice extends ICallbackInterface {
 	 * @param sHost Hostname of sender (or servername)
 	 * @see com.dmdirc.parser.irc.ProcessMessage#callChannelNotice
 	 */
-	void onChannelNotice(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost);
+	void onChannelNotice(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            String sMessage,
+            @FakableSource String sHost);
 }

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelSingleModeChanged.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /** 
@@ -45,6 +47,10 @@ public interface IChannelSingleModeChanged extends ICallbackInterface {
 	 * @param sHost Host doing the mode changing (User host or server name)
 	 * @param sModes String parsed (ie "+m" or "+k moo"
 	 */
-	void onChannelSingleModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes);
+	void onChannelSingleModeChanged(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            @FakableArgument ChannelClientInfo cChannelClient,
+            @FakableSource String sHost,
+            String sModes);
 }
 

src/com/dmdirc/parser/irc/callbacks/interfaces/IChannelUserModeChanged.java

@@ -25,6 +25,8 @@ package com.dmdirc.parser.irc.callbacks.interfaces;
 import com.dmdirc.parser.irc.ChannelClientInfo;
 import com.dmdirc.parser.irc.ChannelInfo;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.callbacks.FakableArgument;
+import com.dmdirc.parser.irc.callbacks.FakableSource;
 import com.dmdirc.parser.irc.callbacks.SpecificCallback;
 
 /** 
@@ -45,5 +47,10 @@ public interface IChannelUserModeChanged extends ICallbackInterface {
 	 * @param sMode String representing mode change (ie +o)
 	 * @see com.dmdirc.parser.irc.ProcessMode#callChannelUserModeChanged
 	 */
-	void onChannelUserModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChangedClient, ChannelClientInfo cSetByClient, String sHost, String sMode);
+	void onChannelUserModeChanged(@FakableSource IRCParser tParser,
+            @FakableSource ChannelInfo cChannel,
+            ChannelClientInfo cChangedClient,
+            @FakableArgument ChannelClientInfo cSetByClient,
+            @FakableSource String sHost,
+            String sMode);
 }