Core support for protocol description objects

Fixes issue 3560

Change-Id: I7e1bdc1c936608acf1d98e8629ff62cec4b3e810
Reviewed-on: http://gerrit.dmdirc.com/1182
Automatic-Compile: Gregory Holmes <greg@dmdirc.com>
Reviewed-by: Gregory Holmes <greg@dmdirc.com>

src/com/dmdirc/Channel.java

@@ -542,7 +542,7 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
             // Format topics
 
             args.add("");
-            args.addAll(Arrays.asList(server.getParser().parseHostmask(((Topic) arg).getClient())));
+            args.addAll(Arrays.asList(server.parseHostmask(((Topic) arg).getClient())));
             args.add(((Topic) arg).getTopic());
             args.add(((Topic) arg).getTime() * 1000);
 

src/com/dmdirc/Invite.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc;
 
+import com.dmdirc.parser.common.ChannelJoinRequest;
 import java.util.Date;
 
 /**
@@ -90,14 +91,14 @@ public class Invite {
      * @return This invite's source
      */
     public String[] getSource() {
-        return server.getParser().parseHostmask(source);
+        return server.parseHostmask(source);
     }
     
     /**
      * Join the channel that belongs to this invite.
      */
     public void accept() {
-        server.getParser().joinChannel(channel);
+        server.join(new ChannelJoinRequest(channel));
         
         server.removeInvite(this);
     }

src/com/dmdirc/ParserFactory.java

@@ -26,7 +26,7 @@ import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.parser.interfaces.Parser;
 import com.dmdirc.parser.common.MyInfo;
-import com.dmdirc.plugins.ExportedService;
+import com.dmdirc.parser.interfaces.ProtocolDescription;
 import com.dmdirc.plugins.NoSuchProviderException;
 import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.plugins.Service;
@@ -62,6 +62,51 @@ public class ParserFactory {
             }
         }
 
+        final Object obj = getExportResult(address, "getParser", myInfo, address);
+
+        if (obj instanceof Parser) {
+            return (Parser) obj;
+        } else {
+            Logger.userError(ErrorLevel.MEDIUM,
+                    "Unable to create parser for: " + address.getScheme());
+        }
+
+        return null;
+    }
+
+    /**
+     * Retrieves a protocol description.
+     *
+     * @param address The address to retrieve a description for
+     * @return A corresponding protocol description
+     * @since 0.6.4
+     */
+    public ProtocolDescription getDescription(final URI address) {
+        final Object obj = getExportResult(address, "getProtocolDescription");
+
+        if (obj instanceof ProtocolDescription) {
+            return (ProtocolDescription) obj;
+        } else {
+            Logger.userError(ErrorLevel.MEDIUM,
+                    "Unable to create protocol description for: " + address.getScheme());
+        }
+
+        return null;
+    }
+
+    /**
+     * Retrieves and executes an exported service with the specified name from a
+     * {@link ServiceProvider} which can provide a parser for the specified
+     * address. If no such provider or service is found, null is returned.
+     *
+     * @param address The address a provider is required for
+     * @param serviceName The name of the service to be retrieved
+     * @param args The arguments to be passed to the exported service
+     * @return The result from a relevant exported service, or null
+     * @since 0.6.4
+     */
+    protected Object getExportResult(final URI address,
+            final String serviceName, final Object ... args) {
         // TODO: Move default scheme to a setting
         final String scheme = address.getScheme() == null ? "irc" : address.getScheme();
 
@@ -74,14 +119,8 @@ public class ParserFactory {
                 if (provider != null) {
                     provider.activateServices();
 
-                    final ExportedService exportService = provider.getExportedService("getParser");
-                    final Object obj = exportService.execute(myInfo, address);
-                    if (obj != null && obj instanceof Parser) {
-                        return (Parser) obj;
-                    } else {
-                        Logger.userError(ErrorLevel.MEDIUM,
-                                "Unable to create parser for: " + address.getScheme());
-                    }
+                    return provider.getExportedService(serviceName)
+                            .execute(args);
                 }
             }
         } catch (NoSuchProviderException nspe) {

src/com/dmdirc/Query.java

@@ -70,14 +70,14 @@ public class Query extends MessageTarget<QueryWindow> implements PrivateActionLi
      * @param newServer The server object that this Query belongs to
      */
     public Query(final Server newServer, final String newHost) {
-        super("query", newServer.getParser().parseHostmask(newHost)[0],
-                newServer.getParser().parseHostmask(newHost)[0],
+        super("query", newServer.parseHostmask(newHost)[0],
+                newServer.parseHostmask(newHost)[0],
                 QueryWindow.class, newServer.getConfigManager(),
                 new QueryCommandParser());
 
         this.server = newServer;
         this.host = newHost;
-        this.nickname = server.getParser().parseHostmask(host)[0];
+        this.nickname = server.parseHostmask(host)[0];
 
         WindowManager.addWindow(server, this,
                 !getConfigManager().getOptionBool("general", "hidequeries"));
@@ -163,7 +163,7 @@ public class Query extends MessageTarget<QueryWindow> implements PrivateActionLi
                     getTranscoder().encode(action));
 
             doNotification("querySelfAction", CoreActionType.QUERY_SELF_ACTION,
-                    server.getParser().getLocalClient(), action);
+                    client, action);
         } else {
             addLine("actionTooLong", action.length());
         }
@@ -179,7 +179,7 @@ public class Query extends MessageTarget<QueryWindow> implements PrivateActionLi
     @Override
     public void onPrivateMessage(final Parser parser, final String message,
             final String remoteHost) {
-        final String[] parts = parser.parseHostmask(host);
+        final String[] parts = server.parseHostmask(host);
 
         final StringBuffer buff = new StringBuffer("queryMessage");
 
@@ -199,7 +199,7 @@ public class Query extends MessageTarget<QueryWindow> implements PrivateActionLi
     @Override
     public void onPrivateAction(final Parser parser, final String message,
             final String remoteHost) {
-        final String[] parts = parser.parseHostmask(host);
+        final String[] parts = server.parseHostmask(host);
 
         final StringBuffer buff = new StringBuffer("queryAction");
 

src/com/dmdirc/Server.java

@@ -46,6 +46,7 @@ import com.dmdirc.parser.interfaces.Parser;
 import com.dmdirc.parser.interfaces.SecureParser;
 import com.dmdirc.parser.interfaces.StringConverter;
 import com.dmdirc.parser.common.MyInfo;
+import com.dmdirc.parser.interfaces.ProtocolDescription;
 import com.dmdirc.ui.WindowManager;
 import com.dmdirc.ui.input.TabCompleter;
 import com.dmdirc.ui.input.TabCompletionType;
@@ -104,6 +105,8 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
     private transient Parser parser;
     /** The Parser instance that used to be handling this server. */
     private transient Parser oldParser;
+    /** The parser-supplied protocol description object. */
+    private ProtocolDescription protocolDescription;
 
     /**
      * Object used to synchronoise access to parser. This object should be
@@ -181,6 +184,7 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
                 new ServerCommandParser());
 
         this.address = uri;
+        this.protocolDescription = new ParserFactory().getDescription(address);
         this.profile = profile;
 
         ServerManager.getServerManager().registerServer(this);
@@ -277,6 +281,7 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
                 getConfigManager().migrate(address.getScheme(), "", "", address.getHost());
 
                 this.address = address;
+                this.protocolDescription = new ParserFactory().getDescription(address);
                 this.profile = profile;
 
                 updateTitle();
@@ -481,21 +486,7 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
      * @return True iff the query is known, false otherwise
      */
     public boolean hasQuery(final String host) {
-        final String nick;
-
-        try {
-            parserLock.readLock().lock();
-
-            if (parser == null) {
-                return false;
-            }
-
-            nick = converter.toLowerCase(parser.parseHostmask(host)[0]);
-        } finally {
-            parserLock.readLock().unlock();
-        }
-
-        return queries.containsKey(nick);
+        return queries.containsKey(converter.toLowerCase(parseHostmask(host)[0]));
     }
 
     /**
@@ -513,20 +504,8 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
             }
         }
 
-        final String nick, lnick;
-
-        try {
-            parserLock.readLock().lock();
-
-            if (parser == null) {
-                throw new IllegalStateException("Can't retrieve query while disconnected");
-            }
-
-            nick = parser.parseHostmask(host)[0];
-            lnick = converter.toLowerCase(nick);
-        } finally {
-            parserLock.readLock().unlock();
-        }
+        final String nick = parseHostmask(host)[0];
+        final String lnick = converter.toLowerCase(nick);
 
         if (!queries.containsKey(lnick)) {
             final Query newQuery = new Query(this, host);
@@ -791,6 +770,19 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
         return false;
     }
 
+    /**
+     * Parses the specified hostmask in a manner prescribed by the protocol
+     * currently used by this server.
+     *
+     * @see ProtocolDescription#parseHostmask(java.lang.String)
+     * @param hostmask The hostmask to be parsed
+     * @return An array containing the nickname, username and hostname
+     * @since 0.6.4
+     */
+    public String[] parseHostmask(final String hostmask) {
+        return protocolDescription.parseHostmask(hostmask);
+    }
+
     /**
      * Retrieves the MyInfo object used for the IRC Parser.
      *

src/com/dmdirc/ServerEventHandler.java

@@ -154,7 +154,7 @@ public final class ServerEventHandler extends EventHandler implements
 
         if (owner.doNotification("privateCTCP", CoreActionType.SERVER_CTCP,
                 owner.getParser().getClient(sHost), sType, sMessage)) {
-            owner.sendCTCPReply(tParser.parseHostmask(sHost)[0], sType, sMessage);
+            owner.sendCTCPReply(owner.parseHostmask(sHost)[0], sType, sMessage);
         }
     }
 

src/com/dmdirc/commandparser/commands/channel/ShowTopic.java

@@ -56,7 +56,7 @@ public final class ShowTopic extends ChannelCommand implements ExternalCommand {
             if (cChannel.getTopic().isEmpty()) {
                 sendLine(origin, isSilent, "channelNoTopic", cChannel);
             } else {
-                final String[] parts = server.getParser().parseHostmask(cChannel.getTopicSetter());
+                final String[] parts = server.parseHostmask(cChannel.getTopicSetter());
 
                 sendLine(origin, isSilent, "channelTopicDiscovered",
                         "", parts[0], parts[1], parts[2], cChannel.getTopic(),

test/com/dmdirc/InviteTest.java

@@ -25,8 +25,6 @@ package com.dmdirc;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.addons.ui_dummy.DummyController;
 
-import com.dmdirc.parser.interfaces.Parser;
-import java.net.URI;
 import java.util.Date;
 
 import org.junit.BeforeClass;
@@ -37,7 +35,6 @@ import static org.mockito.Mockito.*;
 
 public class InviteTest {
 
-    private static Parser parser;
     private static Server server;
     private static Invite test;
     private static long ts;
@@ -48,10 +45,8 @@ public class InviteTest {
         IdentityManager.load();
         
         server = mock(Server.class);
-        parser = mock(Parser.class);
 
-        when(server.getParser()).thenReturn(parser);
-        when(parser.parseHostmask("nick!ident@host"))
+        when(server.parseHostmask("nick!ident@host"))
                 .thenReturn(new String[] { "nick", "ident", "host"});
 
         test = new Invite(server, "#channel", "nick!ident@host");