Add initial work on MSN parser

Change-Id: Ie684811c98597cabdfa608786763675b491444fc
Depends-On: Icaa1cebfd34ddc1a278d00468d9d1da3048eb869
Reviewed-on: http://gerrit.dmdirc.com/1990
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/addons/parser_msn/MSNChannelClientInfo.java

@@ -0,0 +1,76 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.BaseChannelClientInfo;
+import com.dmdirc.parser.interfaces.ChannelClientInfo;
+import com.dmdirc.parser.interfaces.ChannelInfo;
+import com.dmdirc.parser.interfaces.ClientInfo;
+
+/**
+ * An MSN-specific channel client info object.
+ */
+public class MSNChannelClientInfo extends BaseChannelClientInfo {
+
+    /**
+     * Creates a new client info object for the specified channel and client.
+     *
+     * @param channel The channel the association is with
+     * @param client The user that holds the association
+     */
+    public MSNChannelClientInfo(final ChannelInfo channel,
+            final ClientInfo client) {
+        super(channel, client);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getImportantModePrefix() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getImportantMode() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getAllModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void kick(final String message) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int compareTo(final ChannelClientInfo o) {
+        return 0;
+    }
+
+}

src/com/dmdirc/addons/parser_msn/MSNClientInfo.java

@@ -0,0 +1,91 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.AwayState;
+import com.dmdirc.parser.common.BaseClientInfo;
+
+import net.sf.jml.MsnUser;
+import net.sf.jml.MsnUserStatus;
+
+/**
+ * An MSN-specific client info object.
+ */
+public class MSNClientInfo extends BaseClientInfo {
+
+    /** MSN contact. */
+    private final MsnUser contact;
+
+    /**
+     * Creates a new client info object with the specified details.
+     *
+     * @param contact The contact this object represents
+     * @param parser The parser that owns this client info object
+     * @param nick The nickname of the user this object represents
+     * @param user The username of the user this object represents
+     * @param host The hostname of the user this object represents
+     */
+    public MSNClientInfo(final MsnUser contact, final MSNParser parser,
+            final String nick, final String user, final String host) {
+        super(parser, nick, user, host);
+
+        this.contact = contact;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getChannelCount() {
+        return 0;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public AwayState getAwayState() {
+        if (contact.getStatus() == MsnUserStatus.ONLINE) {
+            return AwayState.HERE;
+        }
+        return AwayState.AWAY;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public MSNParser getParser() {
+        return (MSNParser) super.getParser();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getRealname() {
+        return contact.getDisplayName();
+    }
+
+    /**
+     * Returns the contact for this client info object
+     *
+     * @return MSN contact for this client
+     */
+    public MsnUser getContact() {
+        return contact;
+    }
+
+}

src/com/dmdirc/addons/parser_msn/MSNFakeChannel.java

@@ -0,0 +1,188 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.BaseChannelInfo;
+import com.dmdirc.parser.common.ChannelListModeItem;
+import com.dmdirc.parser.interfaces.ChannelClientInfo;
+import com.dmdirc.parser.interfaces.ClientInfo;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.callbacks.ChannelNamesListener;
+
+import java.util.Collection;
+import java.util.Collections;
+
+/**
+ * A 'fake' local channel used to display contact lists.
+ */
+public class MSNFakeChannel extends BaseChannelInfo {
+
+    /**
+     * Creates a new fake channel belonging to the specified parser and
+     * with the given name.
+     *
+     * @param parser The parser that owns this channel
+     * @param name The name of the channel
+     */
+    public MSNFakeChannel(final Parser parser, final String name) {
+        super(parser, name);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setTopic(final String topic) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getTopic() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public long getTopicTime() {
+        return 0;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getTopicSetter() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getMode(final char mode) {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public Collection<ChannelListModeItem> getListMode(final char mode) {
+        return Collections.<ChannelListModeItem>emptyList();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void part(final String reason) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendWho() {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void alterMode(final boolean add,
+            final Character mode, final String parameter) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void flushModes() {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void requestListModes() {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public ChannelClientInfo getChannelClient(final ClientInfo client) {
+        return getClient(client.getNickname());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public ChannelClientInfo getChannelClient(final String client,
+            final boolean create) {
+        final String[] parts = getParser().parseHostmask(client);
+        if (create && getClient(parts[0]) == null) {
+            return new MSNChannelClientInfo(this, getParser().getClient(client));
+        }
+        return getClient(parts[0]);
+    }
+
+    /**
+     * Replaces the clients in this channel with a the new list of clients.
+     *
+     * @param clients client list
+     */
+    public void replaceContacts(final Collection<ClientInfo> clients) {
+        for (ChannelClientInfo client : getChannelClients()) {
+            removeClient(client.getClient().getNickname());
+        }
+        for (ClientInfo client : clients) {
+            addClient(client.getNickname(), new MSNChannelClientInfo(this,
+                    client));
+        }
+
+        getParser().getCallbackManager().getCallbackType(
+                ChannelNamesListener.class).call(this);
+    }
+
+    /**
+     * Adds the specified clients to this channel
+     *
+     * @param clients client list
+     */
+    public void addContacts(final Collection<ClientInfo> clients) {
+        for (ClientInfo client : clients) {
+            addClient(client.getNickname(), new MSNChannelClientInfo(this,
+                    client));
+        }
+
+        getParser().getCallbackManager().getCallbackType(
+                ChannelNamesListener.class).call(this);
+    }
+
+    /**
+     * Removes the specified clients from this channel
+     *
+     * @param clients client list
+     */
+    public void removeContacts(final Collection<ClientInfo> clients) {
+        for (ClientInfo client : clients) {
+            removeClient(client.getNickname());
+        }
+
+        getParser().getCallbackManager().getCallbackType(
+                ChannelNamesListener.class).call(this);
+    }
+
+}

src/com/dmdirc/addons/parser_msn/MSNListener.java

@@ -0,0 +1,187 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.AwayState;
+import com.dmdirc.parser.common.ParserError;
+import com.dmdirc.parser.interfaces.ChannelInfo;
+import com.dmdirc.parser.interfaces.ClientInfo;
+import com.dmdirc.parser.interfaces.callbacks.ChannelSelfJoinListener;
+import com.dmdirc.parser.interfaces.callbacks.ConnectErrorListener;
+import com.dmdirc.parser.interfaces.callbacks.OtherAwayStateListener;
+import com.dmdirc.parser.interfaces.callbacks.PrivateMessageListener;
+import com.dmdirc.parser.interfaces.callbacks.ServerNoticeListener;
+import com.dmdirc.parser.interfaces.callbacks.ServerReadyListener;
+import com.dmdirc.parser.interfaces.callbacks.SocketCloseListener;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
+import net.sf.jml.MsnContact;
+import net.sf.jml.MsnList;
+import net.sf.jml.MsnMessenger;
+import net.sf.jml.MsnSwitchboard;
+import net.sf.jml.MsnUserStatus;
+import net.sf.jml.event.MsnAdapter;
+import net.sf.jml.message.MsnInstantMessage;
+import net.sf.jml.message.MsnSystemMessage;
+import net.sf.jml.message.MsnUnknownMessage;
+
+/**
+ * Listener object acting on events from the MSN connection.
+ */
+public class MSNListener extends MsnAdapter {
+
+    /** MSN Parser. */
+    private final MSNParser parser;
+    /** Switchboard ID. */
+    private final Object object = new Object();
+
+    /**
+     * Creates a new MSN listener.
+     *
+     * @param parser Parent parser
+     */
+    public MSNListener(final MSNParser parser) {
+        this.parser = parser;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void contactAddCompleted(final MsnMessenger mm, final MsnContact mc,
+            final MsnList ml) {
+        parser.addClient(mc);
+        parser.addClients(parser.getFakeChannel(), Arrays.asList(
+                new ClientInfo[]{ parser.getClient(mc), }));
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void contactListSyncCompleted(final MsnMessenger mm) {
+        final Collection<MsnContact> contacts = Arrays.asList(
+                mm.getContactList().getContacts());
+        final List<ClientInfo> clients = new ArrayList<ClientInfo>();
+        for (MsnContact contact : contacts) {
+            parser.addClient(contact);
+            clients.add(parser.getClient(contact));
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void contactStatusChanged(final MsnMessenger mm,
+            final MsnContact mc) {
+        if (mc.getStatus() != MsnUserStatus.OFFLINE) {
+            parser.addClients(parser.getFakeChannel(), Arrays.asList(
+                    new ClientInfo[]{ parser.getClient(mc), }));
+        } else if (mc.getStatus() == MsnUserStatus.OFFLINE) {
+            parser.removeClients(parser.getFakeChannel(), Arrays.asList(
+                    new ClientInfo[]{ parser.getClient(mc), }));
+        }
+        final boolean isBack = mc.getStatus().equals(MsnUserStatus.ONLINE);
+        parser.getCallbackManager().getCallbackType(
+                OtherAwayStateListener.class).call(parser.getClient(mc),
+                isBack ? AwayState.AWAY : AwayState.HERE,
+                isBack ? AwayState.HERE : AwayState.AWAY);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void exceptionCaught(final MsnMessenger mm, final Throwable thrwbl) {
+        final ParserError error = new ParserError(ParserError.ERROR_ERROR,
+                thrwbl.getMessage(), "");
+        error.setException(new Exception(thrwbl)); //NOPMD
+        parser.getCallbackManager().getCallbackType(ConnectErrorListener.class)
+                .call(error);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void instantMessageReceived(final MsnSwitchboard ms,
+            final MsnInstantMessage mim, final MsnContact mc) {
+        parser.getCallbackManager().getCallbackType(
+                PrivateMessageListener.class).call(mim.getContent(),
+                mc.getEmail().getEmailAddress());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void loginCompleted(final MsnMessenger mm) {
+        mm.newSwitchboard(object);
+        parser.getCallbackManager().getCallbackType(ServerReadyListener.class)
+                .call();
+        final ChannelInfo channel = parser.getFakeChannel();
+        if (channel != null) {
+            parser.getCallbackManager().getCallbackType(
+                    ChannelSelfJoinListener.class).call(channel);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void logout(final MsnMessenger mm) {
+        parser.getCallbackManager().getCallbackType(SocketCloseListener.class)
+                .call();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void offlineMessageReceived(final String body,
+            final String contentType, final String encoding,
+            final MsnContact mc) {
+        parser.getCallbackManager().getCallbackType(
+                PrivateMessageListener.class).call(body,
+                mc.getEmail().getEmailAddress());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void ownerStatusChanged(final MsnMessenger mm) {
+        if (mm.getOwner().getStatus() == MsnUserStatus.ONLINE) {
+            parser.getLocalClient().setBack();
+        }
+        parser.getLocalClient().setAway(mm.getOwner().getStatus()
+                .getDisplayStatus());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void systemMessageReceived(final MsnMessenger mm,
+            final MsnSystemMessage msm) {
+        if (msm.getContent() != null) {
+            parser.getCallbackManager().getCallbackType(
+                    ServerNoticeListener.class).call(msm.getContent(), "MSN");
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void unknownMessageReceived(final MsnSwitchboard ms,
+            final MsnUnknownMessage mum, final MsnContact mc) {
+        parser.getCallbackManager().getCallbackType(
+                ServerNoticeListener.class).call("Unknown message: "
+                + mum.getContent(), "MSN");
+    }
+}

src/com/dmdirc/addons/parser_msn/MSNLocalClientInfo.java

@@ -0,0 +1,100 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.AwayState;
+import com.dmdirc.parser.interfaces.LocalClientInfo;
+import com.dmdirc.parser.interfaces.callbacks.AwayStateListener;
+
+import net.sf.jml.MsnOwner;
+import net.sf.jml.MsnUserStatus;
+
+/**
+ * A representation of the local MSN client.
+ */
+public class MSNLocalClientInfo extends MSNClientInfo implements LocalClientInfo {
+
+    /** MSN user. */
+    private final MsnOwner owner;
+
+    /**
+     * Creates a new local client info object with the specified details.
+     *
+     * @param owner The client this object represents
+     * @param parser The parser that owns this client info object
+     * @param nick The nickname of the user this object represents
+     * @param user The username of the user this object represents
+     * @param host The hostname of the user this object represents
+     */
+    public MSNLocalClientInfo(final MsnOwner owner, final MSNParser parser,
+            final String nick, final String user, final String host) {
+        super(owner, parser, nick, user, host);
+
+        this.owner = owner;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setNickname(final String name) {
+        owner.setDisplayName(name);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setAway(final String reason) {
+        owner.setStatus(MsnUserStatus.AWAY);
+
+        getParser().getCallbackManager().getCallbackType(
+                AwayStateListener.class).call(AwayState.HERE, AwayState.AWAY,
+                reason);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setBack() {
+        owner.setStatus(MsnUserStatus.ONLINE);
+
+        getParser().getCallbackManager().getCallbackType(
+                AwayStateListener.class).call(AwayState.AWAY, AwayState.HERE,
+                null);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void alterMode(final boolean add, final Character mode) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void flushModes() {
+        //Ignore
+    }
+
+}

src/com/dmdirc/addons/parser_msn/MSNParser.java

@@ -0,0 +1,442 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.BaseParser;
+import com.dmdirc.parser.common.ChannelJoinRequest;
+import com.dmdirc.parser.common.DefaultStringConverter;
+import com.dmdirc.parser.common.QueuePriority;
+import com.dmdirc.parser.interfaces.ChannelClientInfo;
+import com.dmdirc.parser.interfaces.ChannelInfo;
+import com.dmdirc.parser.interfaces.ClientInfo;
+import com.dmdirc.parser.interfaces.LocalClientInfo;
+import com.dmdirc.parser.interfaces.StringConverter;
+
+import java.net.URI;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import net.sf.jml.MsnContact;
+import net.sf.jml.MsnMessenger;
+import net.sf.jml.impl.MsnMessengerFactory;
+
+/**
+ * A parser which can understand the MSN protocol.
+ */
+public class MSNParser extends BaseParser {
+
+    /** A map of this parser's implementations of common interfaces. */
+    private static final Map<Class<?>, Class<?>> IMPL_MAP
+            = new HashMap<Class<?>, Class<?>>();
+    /** MSN Connection. */
+    private MsnMessenger msn;
+    /** A cache of known clients. */
+    private final Map<String, MSNClientInfo> clients
+            = new HashMap<String, MSNClientInfo>();
+    /** Whether or not to use a channel for contact lists. */
+    private final boolean useFakeChannel;
+    /** The fake channel to use is useFakeChannel is enabled. */
+    private MSNFakeChannel fakeChannel;
+
+    /** Creates map of this parser's implementations of common interfaces. */
+    static {
+        IMPL_MAP.put(ClientInfo.class, MSNClientInfo.class);
+        IMPL_MAP.put(LocalClientInfo.class, MSNLocalClientInfo.class);
+        IMPL_MAP.put(ChannelInfo.class, MSNFakeChannel.class);
+        IMPL_MAP.put(ChannelClientInfo.class, MSNChannelClientInfo.class);
+    }
+
+    /**
+     * Creates a new parser for the specified address.
+     *
+     * @param address The address to connect to
+     */
+    public MSNParser(final URI address) {
+        super(address, IMPL_MAP);
+
+        useFakeChannel = address.getQuery().matches(
+                "(?i).*(^|&)showchannel($|&).*");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void disconnect(final String message) {
+        msn.logout();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void joinChannels(final ChannelJoinRequest... channels) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public ChannelInfo getChannel(final String channel) {
+        if ("&contacts".equalsIgnoreCase(channel)) {
+            return fakeChannel;
+        }
+        return null;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public Collection<? extends ChannelInfo> getChannels() {
+        return Collections.<ChannelInfo>emptyList();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getMaxLength(final String type, final String target) {
+        return -1;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getMaxLength() {
+        return -1;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public LocalClientInfo getLocalClient() {
+        final String[] parts = parseHostmask(msn.getOwner().getEmail()
+                .getEmailAddress());
+        return new MSNLocalClientInfo(msn.getOwner(), this, parts[0], parts[2],
+                parts[1]);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public MSNClientInfo getClient(final String details) {
+        final String[] parts = parseHostmask(details);
+        return clients.get(parts[0]);
+    }
+
+    /**
+     * Retrieves a {@link ClientInfo} object which corresponds to the specified
+     * contact. If the client wasn't previously known, it will be created.
+     *
+     * @param contact The contact to look up
+     *
+     * @return A corresponding client info object
+     */
+    public MSNClientInfo getClient(final MsnContact contact) {
+        return getClient(contact.getEmail().getEmailAddress());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendRawMessage(final String message) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendRawMessage(final String message,
+            final QueuePriority priority) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public StringConverter getStringConverter() {
+        return new DefaultStringConverter();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean isValidChannelName(final String name) {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean compareURI(final URI uri) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public Collection<? extends ChannelJoinRequest> extractChannels(
+            final URI uri) {
+        return Collections.<ChannelJoinRequest>emptyList();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getServerName() {
+        return "MSN";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getNetworkName() {
+        return "MSN";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getServerSoftware() {
+        return "MSN";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getServerSoftwareType() {
+        return "MSN";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public List<String> getServerInformationLines() {
+        return Collections.<String>emptyList();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getMaxTopicLength() {
+        return 0;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getBooleanChannelModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getListChannelModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getMaxListModes(final char mode) {
+        return 0;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean isUserSettable(final char mode) {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getParameterChannelModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getDoubleParameterChannelModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getUserModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getChannelUserModes() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getChannelPrefixes() {
+        return "#";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public long getServerLatency() {
+        return 0;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendCTCP(final String target, final String type,
+            final String message) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendCTCPReply(final String target, final String type,
+            final String message) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendMessage(final String target, final String message) {
+        msn.sendText(getClient(target).getContact().getEmail(), message);
+
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendNotice(final String target, final String message) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendAction(final String target, final String message) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void sendInvite(final String channel, final String user) {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getLastLine() {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String[] parseHostmask(final String hostmask) {
+        return new MSNProtocolDescription().parseHostmask(hostmask);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public long getPingTime() {
+        return 0;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void run() {
+        final String[] userInfoParts = getURI().getUserInfo().split(":", 2);
+        msn = MsnMessengerFactory.createMsnMessenger(
+                userInfoParts[0], userInfoParts[1]);
+        msn.addListener(new MSNListener(this));
+        msn.login();
+        if (useFakeChannel) {
+            fakeChannel = new MSNFakeChannel(this, "&contacts");
+        }
+    }
+
+    /**
+     * Updates the clients in the specified channel.
+     *
+     * @param channel Channel to update
+     * @param clients Clients to use in the channel
+     */
+    public void updateClients(final ChannelInfo channel,
+            final Collection<ClientInfo> clients) {
+        if (channel == fakeChannel) {
+            fakeChannel.replaceContacts(clients);
+        }
+    }
+
+    /**
+     * Adds the clients in the specified channel.
+     *
+     * @param channel Channel to update
+     * @param clients Clients to add in the channel
+     */
+    public void addClients(final ChannelInfo channel,
+            final Collection<ClientInfo> clients) {
+        if (channel == fakeChannel) {
+            fakeChannel.addContacts(clients);
+        }
+    }
+
+    /**
+     * Removes the clients in the specified channel.
+     *
+     * @param channel Channel to update
+     * @param clients Clients to add in the channel
+     */
+    public void removeClients(final ChannelInfo channel,
+            final Collection<ClientInfo> clients) {
+        if (channel == fakeChannel) {
+            fakeChannel.removeContacts(clients);
+        }
+    }
+
+    /**
+     * Returns the fake channel for this parser, this will be null if the
+     * user has opted not to use the fake channel.
+     *
+     * @return Fake channel or null
+     */
+    public ChannelInfo getFakeChannel() {
+        return fakeChannel;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getBindIP() {
+        return msn.getConnection().getInternalIP();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setBindIP(final String ip) {
+        //Ignore
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int getLocalPort() {
+        return msn.getConnection().getInternalPort();
+    }
+
+    /**
+     * Adds a contact to the list of known clients.
+     *
+     * @param contact Contact to add
+     */
+    public void addClient(final MsnContact contact) {
+        final String email = contact.getEmail().getEmailAddress();
+        final String[] parts = parseHostmask(email);
+        clients.put(email, new MSNClientInfo(contact, this, parts[0], parts[1],
+                parts[2]));
+    }
+
+    /**
+     * Removes a contact from the list of known clients.
+     *
+     * @param contact Contact to remove
+     */
+    public void removeClient(final MsnContact contact) {
+        clients.remove(contact.getEmail().getEmailAddress());
+    }
+}

src/com/dmdirc/addons/parser_msn/MSNPlugin.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2006-2011 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.addons.parser_msn;
+
+import com.dmdirc.parser.common.MyInfo;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.ProtocolDescription;
+import com.dmdirc.plugins.BasePlugin;
+
+import java.net.URI;
+
+/**
+ * Plugin that provides a parser to connect to MSN services.
+ */
+public class MSNPlugin extends BasePlugin {
+
+    /** Protocol descriptor. */
+    private final MSNProtocolDescription protocol
+            = new MSNProtocolDescription();
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        // Do nothing
+    }
+
+    /**
+     * Creates a new MSN parser for the specified client info and address.
+     *
+     * @param myInfo The settings for the local client
+     * @param address The address to connect to
+     *
+     * @return An appropriately configured parser
+     */
+    public Parser getParser(final MyInfo myInfo, final URI address) {
+        return new MSNParser(address);
+    }
+
+    /**
+     * Retrieves an object describing the properties of the MSN  protocol.
+     *
+     * @return A relevant protocol description object
+     */
+    public ProtocolDescription getDescription() {
+        return protocol;
+    }
+}

src/com/dmdirc/addons/parser_msn/MSNProtocolDescription.java

@@ -0,0 +1,44 @@
+/*
+ * 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.addons.parser_msn;
+
+import com.dmdirc.parser.interfaces.ProtocolDescription;
+
+/**
+ * A description of the MSN protocol.
+ */
+class MSNProtocolDescription implements ProtocolDescription {
+
+    /** {@inheritDoc} */
+    @Override
+    public int getDefaultPort() {
+        return 1863;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String[] parseHostmask(final String hostmask) {
+        return new String[] { hostmask, hostmask, hostmask, };
+    }
+
+}

src/com/dmdirc/addons/parser_msn/plugin.config

@@ -0,0 +1,34 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+  version
+  defaults
+  icons
+
+metadata:
+  author=Greg <greg@dmdirc.com>
+  mainclass=com.dmdirc.addons.parser_msn.MSNPlugin
+  description=Provides MSN access for DMDirc.
+  name=msn
+  nicename=MSN Plugin
+
+updates:
+  id=68
+
+version:
+  number=1
+  friendly=0.1
+
+provides:
+  msn parser
+  msns parser
+
+
+exports:
+  getParser in com.dmdirc.addons.parser_msn.MSNPlugin as getParser
+  getDescription in com.dmdirc.addons.parser_msn.MSNPlugin as getProtocolDescription