Add a whois on query plugin.

whoisonquery/plugin.config

@@ -7,6 +7,7 @@ keysections:
   metadata
   updates
   version
+  defaults
 
 metadata:
   author=Greg <greg@dmdirc.com>
@@ -19,4 +20,7 @@ updates:
   id=80
 
 version:
-  friendly=0.1
+  friendly=0.1
+
+defaults:
+  whoisonquery=false

whoisonquery/src/com/dmdirc/addons/whoisonquery/WhoisOnQueryManager.java

@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * 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.whoisonquery;
+
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.config.prefs.PluginPreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesSetting;
+import com.dmdirc.config.prefs.PreferencesType;
+import com.dmdirc.events.ClientPrefsOpenedEvent;
+import com.dmdirc.events.ConnectionPrefsRequestedEvent;
+import com.dmdirc.events.QueryOpenedEvent;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import javax.inject.Inject;
+
+import net.engio.mbassy.listener.Handler;
+
+/**
+ * Sends a whois when a new query is opened.
+ */
+public class WhoisOnQueryManager {
+
+    private final String domain;
+    private final PluginInfo pluginInfo;
+    private final DMDircMBassador eventBus;
+
+    @Inject
+    public WhoisOnQueryManager(@PluginDomain(WhoisOnQueryPlugin.class) final String domain,
+            @PluginDomain(WhoisOnQueryPlugin.class) final PluginInfo pluginInfo,
+            final DMDircMBassador eventBus) {
+        this.domain = domain;
+        this.pluginInfo = pluginInfo;
+        this.eventBus = eventBus;
+    }
+
+    public void load() {
+        eventBus.subscribe(this);
+    }
+
+    public void unload() {
+        eventBus.unsubscribe(this);
+    }
+
+    @VisibleForTesting
+    @Handler
+    void handleQueryEvent(final QueryOpenedEvent event) {
+        event.getQuery().getConnection().ifPresent(c -> {
+           final boolean enable = c.getWindowModel().getConfigManager()
+                   .getOptionBool(domain, "whoisonquery");
+            if (enable) {
+                c.requestUserInfo(event.getQuery().getUser());
+            }
+        });
+    }
+
+    @VisibleForTesting
+    @Handler
+    void handlePrefsEvent(final ClientPrefsOpenedEvent event) {
+        final PreferencesCategory category = new PluginPreferencesCategory(pluginInfo,
+                "Whois on Query", "Whois on query");
+        category.addSetting(getSetting(event.getModel().getConfigManager(),
+                event.getModel().getIdentity()));
+        event.getModel().getCategory("Plugins").addSubCategory(category);
+    }
+
+    @VisibleForTesting
+    @Handler
+    void handleConnectionPrefsEvent(final ConnectionPrefsRequestedEvent event) {
+        event.getCategory().addSetting(getSetting(event.getConfig(), event.getIdentity()));
+    }
+
+    private PreferencesSetting getSetting(final AggregateConfigProvider config,
+            final ConfigProvider configProvider) {
+        return new PreferencesSetting(PreferencesType.BOOLEAN, domain, "whoisonquery",
+                "Send whois on query", "Request user information when a query is opened?",
+                config, configProvider);
+    }
+}

whoisonquery/test/com/dmdirc/addons/jpq/WhoisOnQueryPluginTest.java → whoisonquery/src/com/dmdirc/addons/whoisonquery/WhoisOnQueryModule.java

@@ -20,15 +20,33 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.addons.jpq;
+package com.dmdirc.addons.whoisonquery;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.runners.MockitoJUnitRunner;
+import com.dmdirc.ClientModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
 
-@RunWith(MockitoJUnitRunner.class)
-public class WhoisOnQueryPluginTest {
+import dagger.Module;
+import dagger.Provides;
 
-    @Test
-    public void testSomething() {}
-}
+@Module(injects = WhoisOnQueryManager.class, addsTo = ClientModule.class)
+public class WhoisOnQueryModule {
+
+    private final PluginInfo pluginInfo;
+
+    public WhoisOnQueryModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+
+    @Provides
+    @PluginDomain(WhoisOnQueryPlugin.class)
+    public String getDomain() {
+        return pluginInfo.getDomain();
+    }
+
+    @Provides
+    @PluginDomain(WhoisOnQueryPlugin.class)
+    public PluginInfo getPluginInfo() {
+        return pluginInfo;
+    }
+}

whoisonquery/src/com/dmdirc/addons/jpq/WhoisOnQueryPlugin.java → whoisonquery/src/com/dmdirc/addons/whoisonquery/WhoisOnQueryPlugin.java

@@ -20,10 +20,34 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.addons.jpq;
+package com.dmdirc.addons.whoisonquery;
 
+import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BasePlugin;
 
+import dagger.ObjectGraph;
+
+/**
+ * Sends a whois when a new query is opened.
+ */
 public class WhoisOnQueryPlugin extends BasePlugin {
 
+    private WhoisOnQueryManager manager;
+
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new WhoisOnQueryModule(pluginInfo)));
+        manager = getObjectGraph().get(WhoisOnQueryManager.class);
+    }
+
+    @Override
+    public void onLoad() {
+        manager.load();
+    }
+
+    @Override
+    public void onUnload() {
+        manager.unload();
+    }
 }

whoisonquery/test/com/dmdirc/addons/whoisonquery/WhoisOnQueryManagerTest.java

@@ -0,0 +1,135 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * 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.whoisonquery;
+
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.Query;
+import com.dmdirc.config.prefs.PreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesDialogModel;
+import com.dmdirc.config.prefs.PreferencesSetting;
+import com.dmdirc.events.ClientPrefsOpenedEvent;
+import com.dmdirc.events.ConnectionPrefsRequestedEvent;
+import com.dmdirc.events.QueryOpenedEvent;
+import com.dmdirc.interfaces.Connection;
+import com.dmdirc.interfaces.User;
+import com.dmdirc.interfaces.WindowModel;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.PluginMetaData;
+
+import java.util.Optional;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class WhoisOnQueryManagerTest {
+
+    @Mock private DMDircMBassador eventBus;
+    @Mock private PluginInfo pluginInfo;
+    @Mock private PluginMetaData pluginMetaData;
+    @Mock private QueryOpenedEvent queryOpenedEvent;
+    @Mock private AggregateConfigProvider aggregateConfigProvider;
+    @Mock private Connection connection;
+    @Mock private WindowModel windowModel;
+    @Mock private Query query;
+    @Mock private User user;
+    @Mock private ClientPrefsOpenedEvent clientPrefsOpenedEvent;
+    @Mock private ConnectionPrefsRequestedEvent connectionPrefsRequestedEvent;
+    @Mock private PreferencesCategory preferencesCategory;
+    @Captor private ArgumentCaptor<PreferencesSetting> preferencesSetting;
+    @Mock private ConfigProvider configProvider;
+    @Mock private PreferencesDialogModel preferencesDialogModel;
+    @Captor private ArgumentCaptor<PreferencesCategory> preferencesCategoryArgumentCaptor;
+    private WhoisOnQueryManager instance;
+
+    @Before
+    public void setUp() throws Exception {
+        when(pluginInfo.getMetaData()).thenReturn(pluginMetaData);
+        when(pluginMetaData.getFriendlyName()).thenReturn("Plugin");
+        when(queryOpenedEvent.getQuery()).thenReturn(query);
+        when(query.getUser()).thenReturn(user);
+        when(query.getConnection()).thenReturn(Optional.of(connection));
+        when(connection.getWindowModel()).thenReturn(windowModel);
+        when(windowModel.getConfigManager()).thenReturn(aggregateConfigProvider);
+        when(connectionPrefsRequestedEvent.getConfig()).thenReturn(aggregateConfigProvider);
+        when(connectionPrefsRequestedEvent.getIdentity()).thenReturn(configProvider);
+        when(connectionPrefsRequestedEvent.getCategory()).thenReturn(preferencesCategory);
+        when(clientPrefsOpenedEvent.getModel()).thenReturn(preferencesDialogModel);
+        when(preferencesDialogModel.getIdentity()).thenReturn(configProvider);
+        when(preferencesDialogModel.getConfigManager()).thenReturn(aggregateConfigProvider);
+        when(preferencesDialogModel.getCategory("Plugins")).thenReturn(preferencesCategory);
+        instance = new WhoisOnQueryManager("domain", pluginInfo, eventBus);
+    }
+
+    @Test
+    public void testLoad() throws Exception {
+        instance.load();
+        verify(eventBus).subscribe(instance);
+    }
+
+    @Test
+    public void testUnload() throws Exception {
+        instance.unload();
+        verify(eventBus).unsubscribe(instance);
+    }
+
+    @Test
+    public void testHandleQueryEvent_Set() throws Exception {
+        when(aggregateConfigProvider.getOptionBool("domain", "whoisonquery")).thenReturn(true);
+        instance.handleQueryEvent(queryOpenedEvent);
+        verify(connection).requestUserInfo(user);
+    }
+
+    @Test
+    public void testHandleQueryEvent_Unset() throws Exception {
+        when(aggregateConfigProvider.getOptionBool("domain", "whoisonquery")).thenReturn(false);
+        instance.handleQueryEvent(queryOpenedEvent);
+        verify(connection, never()).requestUserInfo(user);
+    }
+
+    @Test
+    public void testHandlePrefsEvent() throws Exception {
+        when(aggregateConfigProvider.getOptionBool("domain", "whoisonquery")).thenReturn(true);
+        instance.handlePrefsEvent(clientPrefsOpenedEvent);
+        verify(preferencesCategory).addSubCategory(preferencesCategoryArgumentCaptor.capture());
+    }
+
+    @Test
+    public void testHandleConnectionPrefsEvent() throws Exception {
+        when(aggregateConfigProvider.getOptionBool("domain", "whoisonquery")).thenReturn(true);
+        instance.handleConnectionPrefsEvent(connectionPrefsRequestedEvent);
+        verify(preferencesCategory).addSetting(any());
+    }
+}

whoisonquery/test/com/dmdirc/addons/whoisonquery/WhoisOnQueryPluginTest.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * 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.whoisonquery;
+
+import com.dmdirc.plugins.PluginInfo;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import dagger.ObjectGraph;
+
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class WhoisOnQueryPluginTest {
+
+    @Mock private PluginInfo pluginInfo;
+    @Mock private ObjectGraph objectGraph;
+    @Mock private WhoisOnQueryManager whoisOnQueryManager;
+    private WhoisOnQueryPlugin instance;
+
+    @Before
+    public void setup() {
+        when(objectGraph.plus(any())).thenReturn(objectGraph);
+        when(objectGraph.get(any())).thenReturn(whoisOnQueryManager);
+        instance = new WhoisOnQueryPlugin();
+    }
+
+    @Test
+    public void testOnLoad() throws Exception {
+        instance.load(pluginInfo, objectGraph);
+        instance.onLoad();
+        verify(whoisOnQueryManager).load();
+    }
+
+    @Test
+    public void testOnUnload() throws Exception {
+        instance.load(pluginInfo, objectGraph);
+        instance.onUnload();
+        verify(whoisOnQueryManager).unload();
+    }
+}