Merge pull request #628 from csmith/tidying

Allow plugins to specify event formats.

src/com/dmdirc/plugins/PluginEventFormatManager.java

@@ -0,0 +1,98 @@
+/*
+ * 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.plugins;
+
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.events.PluginLoadedEvent;
+import com.dmdirc.events.PluginUnloadedEvent;
+import com.dmdirc.interfaces.SystemLifecycleComponent;
+import com.dmdirc.ui.messages.ColourManager;
+import com.dmdirc.ui.messages.EventFormatProvider;
+import com.dmdirc.ui.messages.MultiEventFormatProvider;
+import com.dmdirc.ui.messages.YamlEventFormatProvider;
+
+import com.google.common.eventbus.Subscribe;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+/**
+ * Loads default event formats from plugins.
+ *
+ * <p>Plugins can bundle a format file in {@code /META-INF/format.yml}, and it will be
+ * automatically added to the client when the plugin is loaded.
+ */
+@Singleton
+public class PluginEventFormatManager implements SystemLifecycleComponent {
+
+    private final DMDircMBassador eventbus;
+    private final MultiEventFormatProvider multiEventFormatProvider;
+    private final Map<PluginInfo, EventFormatProvider> providers = new HashMap<>();
+    private final ColourManager colourManager;
+
+    @Inject
+    public PluginEventFormatManager(
+            final DMDircMBassador eventbus,
+            final MultiEventFormatProvider multiEventFormatProvider,
+            @GlobalConfig final ColourManager colourManager) {
+        this.eventbus = eventbus;
+        this.multiEventFormatProvider = multiEventFormatProvider;
+        this.colourManager = colourManager;
+    }
+
+    @Override
+    public void startUp() {
+        eventbus.subscribe(this);
+    }
+
+    @Override
+    public void shutDown() {
+        eventbus.unsubscribe(this);
+    }
+
+    @Subscribe
+    public void handlePluginLoaded(final PluginLoadedEvent event) {
+        final Path path = event.getPlugin().getPath("/META-INF/format.yml");
+        if (Files.exists(path)) {
+            final YamlEventFormatProvider provider =
+                    new YamlEventFormatProvider(path, colourManager);
+            provider.load();
+            providers.put(event.getPlugin(), provider);
+            multiEventFormatProvider.addProvider(provider);
+        }
+    }
+
+    @Subscribe
+    public void handlePluginUnloaded(final PluginUnloadedEvent event) {
+        if (providers.containsKey(event.getPlugin())) {
+            multiEventFormatProvider.removeProvider(providers.remove(event.getPlugin()));
+        }
+    }
+
+}

src/com/dmdirc/plugins/PluginModule.java

@@ -23,6 +23,7 @@
 package com.dmdirc.plugins;
 
 import com.dmdirc.DMDircMBassador;
+import com.dmdirc.interfaces.SystemLifecycleComponent;
 import com.dmdirc.interfaces.config.IdentityController;
 import com.dmdirc.updater.manager.UpdateManager;
 
@@ -42,7 +43,6 @@ import static com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
 @Module(library = true, complete = false)
 public class PluginModule {
 
-
     @Provides
     @Singleton
     public PluginManager getPluginManager(
@@ -84,4 +84,10 @@ public class PluginModule {
         return locator;
     }
 
+    @Provides(type = Provides.Type.SET)
+    @Singleton
+    public SystemLifecycleComponent getEventFormatManager(final PluginEventFormatManager manager) {
+        return manager;
+    }
+
 }