Contactlist plugin

Fixes CLIENT-254

Change-Id: Idb5a3172b615b2b00fd2dfe1b089183303a8bd18
Reviewed-on: http://gerrit.dmdirc.com/1984
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/contactlist/ContactListCommand.java

@@ -0,0 +1,84 @@
+/*
+ * 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.contactlist;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandType;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.IntelligentCommand;
+import com.dmdirc.commandparser.commands.IntelligentCommand.IntelligentCommandContext;
+import com.dmdirc.commandparser.commands.context.ChannelCommandContext;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.ui.input.AdditionalTabTargets;
+
+/**
+ * Generates a contact list for the channel the command is used in.
+ */
+public class ContactListCommand extends Command implements CommandInfo,
+        IntelligentCommand {
+
+    /** {@inheritDoc} */
+    @Override
+    public void execute(final FrameContainer origin,
+            final CommandArguments args, final CommandContext context) {
+        final ChannelCommandContext chanContext = (ChannelCommandContext) context;
+
+        final ContactListListener listener = new ContactListListener(chanContext.getChannel());
+        listener.addListeners();
+        listener.clientListUpdated(chanContext.getChannel().getChannelInfo().getChannelClients());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getName() {
+        return "contactlist";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean showInHelp() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public CommandType getType() {
+        return CommandType.TYPE_CHANNEL;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getHelp() {
+        return "contactlist - Show a contact list for the current channel";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public AdditionalTabTargets getSuggestions(final int arg,
+            final IntelligentCommandContext context) {
+        return new AdditionalTabTargets().excludeAll();
+    }
+
+}

src/com/dmdirc/addons/contactlist/ContactListListener.java

@@ -0,0 +1,115 @@
+/*
+ * 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.contactlist;
+
+import com.dmdirc.Channel;
+import com.dmdirc.FrameContainer;
+import com.dmdirc.Query;
+import com.dmdirc.actions.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.actions.interfaces.ActionType;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.interfaces.FrameCloseListener;
+import com.dmdirc.interfaces.NicklistListener;
+import com.dmdirc.parser.interfaces.ChannelClientInfo;
+
+import java.util.Collection;
+
+/**
+ * Listens for contact list related events.
+ */
+public class ContactListListener implements NicklistListener,
+        ActionListener, FrameCloseListener {
+
+    /** The channel this listener is for. */
+    private final Channel channel;
+
+    /**
+     * Creates a new ContactListListener for the specified channel.
+     *
+     * @param channel The channel to show a contact list for
+     */
+    public ContactListListener(final Channel channel) {
+        this.channel = channel;
+    }
+
+    /**
+     * Adds all necessary listeners for this contact list listener to function.
+     */
+    public void addListeners() {
+        channel.addNicklistListener(this);
+        channel.addCloseListener(this);
+        ActionManager.getActionManager().registerListener(this, CoreActionType.CHANNEL_USERAWAY, CoreActionType.CHANNEL_USERBACK);
+    }
+
+    /**
+     * Removes the listeners added by {@link #addListeners()}.
+     */
+    public void removeListeners() {
+        channel.removeNicklistListener(this);
+        channel.removeCloseListener(this);
+        ActionManager.getActionManager().unregisterListener(this);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void clientListUpdated(final Collection<ChannelClientInfo> clients) {
+        for (ChannelClientInfo client : clients) {
+            clientAdded(client);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void clientListUpdated() {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void clientAdded(final ChannelClientInfo client) {
+        final Query query = channel.getServer().getQuery(client.getClient().getNickname(), false);
+
+        query.setIcon("query-" + client.getClient().getAwayState().name().toLowerCase());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void clientRemoved(final ChannelClientInfo client) {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format, final Object... arguments) {
+        if (arguments[0] == channel) {
+            clientAdded((ChannelClientInfo) arguments[1]);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void windowClosing(final FrameContainer window) {
+        removeListeners();
+    }
+}

src/com/dmdirc/addons/contactlist/ContactListPlugin.java

@@ -0,0 +1,48 @@
+/*
+ * 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.contactlist;
+
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.plugins.BasePlugin;
+
+/**
+ * Plugin to provide a POC contact list.
+ */
+public final class ContactListPlugin extends BasePlugin {
+
+    /** The command we've registered. */
+    private ContactListCommand command;
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        command = new ContactListCommand();
+        CommandManager.registerCommand(command);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        CommandManager.unregisterCommand(command);
+    }
+}

src/com/dmdirc/addons/contactlist/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+/**
+ * Provides a proof of concept contact list.
+ */
+package com.dmdirc.addons.contactlist;

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

@@ -0,0 +1,31 @@
+# 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
+  requires
+  icons
+
+metadata:
+  author=Chris <chris@dmdirc.com>
+  mainclass=com.dmdirc.addons.contactlist.ContactListPlugin
+  description=Proof of concept contact list support
+  name=contactlist
+  nicename=Contact List
+
+updates:
+  id=67
+
+version:
+  friendly=0.1
+
+provides:
+  contactlist command
+
+icons:
+  query-away=plugin://contactlist:com/dmdirc/addons/contactlist/res/offline.png
+  query-here=plugin://contactlist:com/dmdirc/addons/contactlist/res/online.png