DI the now playing plugin.

Change-Id: Ibe9c5f044aad1d51fc31a3bd5c9c7a98589d7018
Reviewed-on: http://gerrit.dmdirc.com/3214
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/nowplaying/ConfigPanel.java

@@ -27,7 +27,8 @@ import com.dmdirc.addons.ui_swing.components.reorderablelist.ListReorderButtonPa
 import com.dmdirc.addons.ui_swing.components.reorderablelist.ReorderableJList;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
 import com.dmdirc.config.prefs.PreferencesInterface;
-import com.dmdirc.interfaces.config.IdentityController;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigProvider;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 
@@ -51,22 +52,27 @@ import javax.swing.UIManager;
 
 import net.miginfocom.swing.MigLayout;
 
+import static com.google.common.base.Preconditions.checkNotNull;
+
 /**
  * Now playing plugin config panel.
  */
-public class ConfigPanel extends JPanel implements PreferencesInterface,
-        KeyListener {
+public class ConfigPanel extends JPanel implements PreferencesInterface, KeyListener {
 
     /** A version number for this class. */
     private static final long serialVersionUID = 1;
-    /** Media source order list. */
-    private ReorderableJList<String> list;
+    /** Now playing manager to get and handle sources. */
+    private final NowPlayingManager manager;
+    /** Global configuration to read settings from. */
+    private final AggregateConfigProvider globalConfig;
+    /** User settings to write settings to. */
+    private final ConfigProvider userSettings;
+    /** This plugin's settings domain. */
+    private final String domain;
     /** Media sources. */
     private final List<String> sources;
-    /** The plugin that owns this panel. */
-    private final NowPlayingPlugin plugin;
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
+    /** Media source order list. */
+    private ReorderableJList<String> list;
     /** Text field for our setting. */
     private JTextField textfield;
     /** Panel that the preview is in. */
@@ -79,24 +85,25 @@ public class ConfigPanel extends JPanel implements PreferencesInterface,
     /**
      * Creates a new instance of ConfigPanel.
      *
-     * @param identityController The controller to read/write settings with.
-     * @param plugin             The plugin that owns this panel
-     * @param sources            A list of sources to be used in the panel
+     * @param manager      Now playing manager to get and handle sources
+     * @param globalConfig Global config to read from
+     * @param userSettings Config to write settings to
+     * @param domain       This plugin's settings domain
+     * @param sources      A list of sources to be used in the panel
      */
     public ConfigPanel(
-            final IdentityController identityController,
-            final NowPlayingPlugin plugin,
+            final NowPlayingManager manager,
+            final AggregateConfigProvider globalConfig,
+            final ConfigProvider userSettings,
+            final String domain,
             final List<String> sources) {
         super();
-
-        if (sources == null) {
-            this.sources = new LinkedList<>();
-        } else {
-            this.sources = new LinkedList<>(sources);
-        }
-
-        this.identityController = identityController;
-        this.plugin = plugin;
+        this.manager = manager;
+        this.globalConfig = globalConfig;
+        this.userSettings = userSettings;
+        this.domain = domain;
+        this.sources = new LinkedList<>();
+        this.sources.addAll(checkNotNull(sources));
 
         initComponents();
     }
@@ -111,8 +118,7 @@ public class ConfigPanel extends JPanel implements PreferencesInterface,
             list.getModel().addElement(source);
         }
 
-        textfield = new JTextField(identityController.getGlobalConfiguration()
-                .getOption(plugin.getDomain(), "format"));
+        textfield = new JTextField(globalConfig.getOption(domain, "format"));
         textfield.addKeyListener(this);
         preview = new TextLabel("Preview:\n");
 
@@ -154,22 +160,20 @@ public class ConfigPanel extends JPanel implements PreferencesInterface,
     private void updatePreview() {
         updateTimer.cancel();
 
-        MediaSource source = plugin.getBestSource();
+        MediaSource source = manager.getBestSource();
 
         if (source == null) {
             source = new DummyMediaSource();
         }
 
-        final String text = plugin.doSubstitution(
+        final String text = manager.doSubstitution(
                 UIUtilities.invokeAndWait(new Callable<String>() {
-            /** {@inheritDoc} */
-            @Override
-            public String call() {
-                return textfield.getText();
-            }
-        }), source);
+                    @Override
+                    public String call() {
+                        return textfield.getText();
+                    }
+                }), source);
         SwingUtilities.invokeLater(new Runnable() {
-            /** {@inheritDoc} */
             @Override
             public void run() {
                 preview.setText("Preview:\n" + text);
@@ -197,39 +201,22 @@ public class ConfigPanel extends JPanel implements PreferencesInterface,
         return newSources;
     }
 
-    /** {@inheritDoc} */
     @Override
     public void save() {
-        plugin.saveSettings(getSources());
-        identityController.getUserSettings()
-                .setOption(plugin.getDomain(), "format", textfield.getText());
+        userSettings.setOption(domain, "sourceOrder", getSources());
+        userSettings.setOption(domain, "format", textfield.getText());
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Key event action
-     */
     @Override
     public void keyTyped(final KeyEvent e) {
         // Do nothing
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Key event action
-     */
     @Override
     public void keyPressed(final KeyEvent e) {
         // Do nothing
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Key event action
-     */
     @Override
     public void keyReleased(final KeyEvent e) {
         schedulePreviewUpdate();

src/com/dmdirc/addons/nowplaying/MediaSource.java

@@ -25,8 +25,6 @@ package com.dmdirc.addons.nowplaying;
 /**
  * The media source describes one source of "now playing" information (i.e., one method of getting
  * information from one media player).
- *
- * @author chris
  */
 public interface MediaSource {
 
@@ -34,8 +32,6 @@ public interface MediaSource {
      * Get the state of this media source
      *
      * @return State for this media source.
-     *
-     * @since 0.6.3m1
      */
     MediaSourceState getState();
 
@@ -82,7 +78,7 @@ public interface MediaSource {
     String getTime();
 
     /**
-     * Retrives the format of the currently loaded track.
+     * Retrieves the format of the currently loaded track.
      *
      * @return Current track format
      */

src/com/dmdirc/addons/nowplaying/MediaSourceComparator.java

@@ -28,16 +28,10 @@ import java.util.List;
 
 /**
  * Sorts media sources according to an ordered list of their names.
- *
- * @author chris
  */
 public class MediaSourceComparator implements Comparator<MediaSource>, Serializable {
 
-    /**
-     * A version number for this class. It should be changed whenever the class structure is changed
-     * (or anything else that would prevent serialized objects being unserialized with the new
-     * class).
-     */
+    /** A version number for this class. */
     private static final long serialVersionUID = 1;
     /** The order that the sources should be checked. */
     private final List<String> order;
@@ -52,7 +46,6 @@ public class MediaSourceComparator implements Comparator<MediaSource>, Serializa
         this.order = order;
     }
 
-    /** {@inheritDoc} */
     @Override
     public int compare(final MediaSource o1, final MediaSource o2) {
         return getPosition(o1) - getPosition(o2);

src/com/dmdirc/addons/nowplaying/MediaSourceManager.java

@@ -27,8 +27,6 @@ import java.util.List;
 /**
  * The media source manager is a standard interface for an object that controls one or more media
  * sources.
- *
- * @author chris
  */
 public interface MediaSourceManager {
 

src/com/dmdirc/addons/nowplaying/MediaSourceState.java

@@ -24,9 +24,6 @@ package com.dmdirc.addons.nowplaying;
 
 /**
  * The state of a media source.
- *
- * @author Shane McCormack
- * @since 0.6.3m1
  */
 public enum MediaSourceState {
 

src/com/dmdirc/addons/nowplaying/NowPlayingCommand.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.addons.nowplaying;
 
+import com.dmdirc.ClientModule.GlobalConfig;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.MessageTarget;
 import com.dmdirc.commandparser.BaseCommandInfo;
@@ -32,13 +33,16 @@ import com.dmdirc.commandparser.commands.IntelligentCommand;
 import com.dmdirc.commandparser.commands.context.ChatCommandContext;
 import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.config.IdentityController;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.plugins.PluginDomain;
 import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.input.TabCompleter;
 
 import java.util.Arrays;
 import java.util.List;
 
+import javax.inject.Inject;
+
 /**
  * The now playing command retrieves the currently playing song from a variety of media players.
  */
@@ -49,28 +53,33 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
             "nowplaying [--sources|--source <source>] [format] - "
             + "tells the channel the song you're currently playing",
             CommandType.TYPE_CHAT);
-    /** The plugin that's using this command. */
-    private final NowPlayingPlugin parent;
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
+    /** Now playing manager to get and handle sources. */
+    private final NowPlayingManager manager;
+    /** Global configuration to read settings from. */
+    private final AggregateConfigProvider globalConfig;
+    /** This plugin's settings domain. */
+    private final String domain;
 
     /**
      * Creates a new instance of this command.
      *
-     * @param controller         The controller to use for command information.
-     * @param parent             The plugin that owns this command.
-     * @param identityController The controller to use to read/write settings.
+     * @param controller   The controller to use for command information.
+     * @param manager      Now playing manager to get and handle sources.
+     * @param globalConfig Global config to read from
+     * @param domain       This plugin's settings domain
      */
+    @Inject
     public NowPlayingCommand(
             final CommandController controller,
-            final NowPlayingPlugin parent,
-            final IdentityController identityController) {
+            final NowPlayingManager manager,
+            @GlobalConfig final AggregateConfigProvider globalConfig,
+            @PluginDomain(NowPlayingPlugin.class) final String domain) {
         super(controller);
-        this.parent = parent;
-        this.identityController = identityController;
+        this.manager = manager;
+        this.globalConfig = globalConfig;
+        this.domain = domain;
     }
 
-    /** {@inheritDoc} */
     @Override
     public void execute(final FrameContainer origin,
             final CommandArguments args, final CommandContext context) {
@@ -82,7 +91,7 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
                 .equalsIgnoreCase("--source")) {
             if (args.getArguments().length > 1) {
                 final String sourceName = args.getArguments()[1];
-                final MediaSource source = parent.getSource(sourceName);
+                final MediaSource source = manager.getSource(sourceName);
 
                 if (source == null) {
                     sendLine(origin, args.isSilent(), FORMAT_ERROR, "Source not found.");
@@ -99,10 +108,10 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
                         "You must specify a source when using --source.");
             }
         } else {
-            if (parent.hasRunningSource()) {
+            if (manager.hasRunningSource()) {
                 target.getCommandParser().parseCommand(origin,
-                        getInformation(parent.getBestSource(), args.
-                        getArgumentsAsString(0)));
+                        getInformation(manager.getBestSource(), args.
+                                getArgumentsAsString(0)));
             } else {
                 sendLine(origin, args.isSilent(), FORMAT_ERROR,
                         "No running media sources available.");
@@ -119,7 +128,7 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
      */
     private void doSourceList(final FrameContainer origin, final boolean isSilent,
             final String format) {
-        final List<MediaSource> sources = parent.getSources();
+        final List<MediaSource> sources = manager.getSources();
 
         if (sources.isEmpty()) {
             sendLine(origin, isSilent, FORMAT_ERROR, "No media sources available.");
@@ -147,25 +156,21 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
     }
 
     /**
-     * Returns a formatted information string from the requested soruce.
+     * Returns a formatted information string from the requested source.
      *
      * @param source MediaSource to query
      * @param format Format to use
      *
      * @return Formatted information string
-     *
-     * @since 0.6.3
      */
     private String getInformation(final MediaSource source, final String format) {
         if (format.isEmpty()) {
-            return parent.doSubstitution(identityController.getGlobalConfiguration()
-                    .getOption(parent.getDomain(), "format"), source);
+            return manager.doSubstitution(globalConfig.getOption(domain, "format"), source);
         } else {
-            return parent.doSubstitution(format, source);
+            return manager.doSubstitution(format, source);
         }
     }
 
-    /** {@inheritDoc} */
     @Override
     public AdditionalTabTargets getSuggestions(final int arg,
             final IntelligentCommandContext context) {
@@ -185,7 +190,7 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
         } else if (arg == 1 && context.getPreviousArgs().get(0).equalsIgnoreCase("--source")) {
             final AdditionalTabTargets res = new AdditionalTabTargets();
             res.excludeAll();
-            for (MediaSource source : parent.getSources()) {
+            for (MediaSource source : manager.getSources()) {
                 if (source.getState() != MediaSourceState.CLOSED) {
                     res.add(source.getAppName());
                 }
@@ -199,7 +204,7 @@ public class NowPlayingCommand extends Command implements IntelligentCommand {
         } else {
             final AdditionalTabTargets res = TabCompleter
                     .getIntelligentResults(arg, context, context
-                    .getPreviousArgs().get(0).equalsIgnoreCase("--sources") ? 1 : 0);
+                            .getPreviousArgs().get(0).equalsIgnoreCase("--sources") ? 1 : 0);
             res.addAll(subsList);
             return res;
         }

src/com/dmdirc/addons/nowplaying/NowPlayingManager.java

@@ -0,0 +1,291 @@
+/*
+ * Copyright (c) 2006-2014 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.nowplaying;
+
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.ClientModule.UserConfig;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.interfaces.ActionController;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.interfaces.actions.ActionType;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.plugins.Plugin;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.PluginManager;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import javax.inject.Inject;
+
+public class NowPlayingManager implements ActionListener {
+
+    /** Plugin manager to get plugins from. */
+    private final PluginManager pluginManager;
+    /** Action controller to register listeners. */
+    private final ActionController actionController;
+    /** Global configuration to read settings from. */
+    private final AggregateConfigProvider globalConfig;
+    /** This plugin's settings domain. */
+    private final String domain;
+    /** The sources that we know of. */
+    private final List<MediaSource> sources = new ArrayList<>();
+    /** The managers that we know of. */
+    private final List<MediaSourceManager> managers = new ArrayList<>();
+    /** The user's preferred order for source usage. */
+    private List<String> order;
+
+    @Inject
+    public NowPlayingManager(
+            final PluginManager pluginManager,
+            final ActionController actionController,
+            @GlobalConfig final AggregateConfigProvider globalConfig,
+            @UserConfig final ConfigProvider userConfig,
+            @PluginDomain(NowPlayingPlugin.class) final String domain) {
+        this.pluginManager = pluginManager;
+        this.actionController = actionController;
+        this.globalConfig = globalConfig;
+        this.domain = domain;
+    }
+
+    /**
+     * Loads the plugin.
+     */
+    public void onLoad() {
+        sources.clear();
+        managers.clear();
+        order = getSettings();
+        actionController.registerListener(this, CoreActionType.PLUGIN_LOADED,
+                CoreActionType.PLUGIN_UNLOADED);
+        for (PluginInfo target : pluginManager.getPluginInfos()) {
+            if (target.isLoaded()) {
+                addPlugin(target);
+            }
+        }
+    }
+
+    /**
+     * Unloads the plugin.
+     */
+    public void onUnload() {
+        sources.clear();
+        managers.clear();
+        actionController.unregisterListener(this);
+    }
+
+    /** Loads the plugins settings. */
+    public List<String> getSettings() {
+        if (globalConfig.hasOptionString(domain, "sourceOrder")) {
+            return globalConfig.getOptionList(domain, "sourceOrder");
+        } else {
+            return new ArrayList<>();
+        }
+    }
+
+    /**
+     * Checks to see if a plugin implements one of the Media Source interfaces and if it does, adds
+     * the source(s) to our list.
+     *
+     * @param target The plugin to be tested
+     */
+    private void addPlugin(final PluginInfo target) {
+        final Plugin targetPlugin = target.getPlugin();
+        if (targetPlugin instanceof MediaSource) {
+            sources.add((MediaSource) targetPlugin);
+            addSourceToOrder((MediaSource) targetPlugin);
+        }
+
+        if (targetPlugin instanceof MediaSourceManager) {
+            managers.add((MediaSourceManager) targetPlugin);
+
+            if (((MediaSourceManager) targetPlugin).getSources() != null) {
+                for (MediaSource source : ((MediaSourceManager) targetPlugin).getSources()) {
+                    addSourceToOrder(source);
+                }
+            }
+        }
+    }
+
+    /**
+     * Checks to see if the specified media source needs to be added to our order list, and adds it
+     * if necessary.
+     *
+     * @param source The media source to be tested
+     */
+    private void addSourceToOrder(final MediaSource source) {
+        if (!order.contains(source.getAppName())) {
+            order.add(source.getAppName());
+        }
+    }
+
+    /**
+     * Checks to see if a plugin implements one of the Media Source interfaces and if it does,
+     * removes the source(s) from our list.
+     *
+     * @param target The plugin to be tested
+     */
+    private void removePlugin(final PluginInfo target) {
+        final Plugin targetPlugin = target.getPlugin();
+        if (targetPlugin instanceof MediaSource) {
+            sources.remove((MediaSource) targetPlugin);
+        }
+
+        if (targetPlugin instanceof MediaSourceManager) {
+            managers.remove((MediaSourceManager) targetPlugin);
+        }
+    }
+
+    /**
+     * Determines if there are any valid sources (paused or not).
+     *
+     * @return True if there are running sources, false otherwise
+     */
+    public boolean hasRunningSource() {
+        for (final MediaSource source : getSources()) {
+            if (source.getState() != MediaSourceState.CLOSED) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Retrieves the "best" source to use for displaying media information. The best source is
+     * defined as the earliest in the list that is running and not paused, or, if no such source
+     * exists, the earliest in the list that is running and paused. If neither condition is
+     * satisified returns null.
+     *
+     * @return The best source to use for media info
+     */
+    public MediaSource getBestSource() {
+        MediaSource paused = null;
+        final List<MediaSource> possibleSources = getSources();
+
+        Collections.sort(possibleSources, new MediaSourceComparator(order));
+
+        for (final MediaSource source : possibleSources) {
+            if (source.getState() != MediaSourceState.CLOSED) {
+                if (source.getState() == MediaSourceState.PLAYING) {
+                    return source;
+                } else if (paused == null) {
+                    paused = source;
+                }
+            }
+        }
+
+        return paused;
+    }
+
+    /**
+     * Substitutes the keywords in the specified format with the values with values from the
+     * specified source.
+     *
+     * @param format The format to be substituted
+     * @param source The source whose values should be used
+     *
+     * @return The substituted string
+     */
+    public String doSubstitution(final String format, final MediaSource source) {
+        final String artist = source.getArtist();
+        final String title = source.getTitle();
+        final String album = source.getAlbum();
+        final String app = source.getAppName();
+        final String bitrate = source.getBitrate();
+        final String filetype = source.getFormat();
+        final String length = source.getLength();
+        final String time = source.getTime();
+        final String state = source.getState().getNiceName();
+
+        return format.replace("$artist", sanitise(artist))
+                .replace("$title", sanitise(title))
+                .replace("$album", sanitise(album))
+                .replace("$app", sanitise(app))
+                .replace("$bitrate", sanitise(bitrate))
+                .replace("$format", sanitise(filetype))
+                .replace("$length", sanitise(length))
+                .replace("$state", sanitise(state))
+                .replace("$time", sanitise(time));
+    }
+
+    /**
+     * Sanitises the specified String so that it may be used as the replacement in a call to
+     * String.replaceAll. Namely, at present, this method returns an empty String if it is passed a
+     * null value; otherwise the input is returned as-is.
+     *
+     * @param input The string to be sanitised
+     *
+     * @return A sanitised version of the String
+     *
+     * @since 0.6.3
+     */
+    protected static String sanitise(final String input) {
+        return input == null ? "" : input;
+    }
+
+    /**
+     * Retrieves a source based on its name.
+     *
+     * @param name The name to search for
+     *
+     * @return The source with the specified name or null if none were found.
+     */
+    public MediaSource getSource(final String name) {
+        for (final MediaSource source : getSources()) {
+            if (source.getAppName().equalsIgnoreCase(name)) {
+                return source;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Retrieves all the sources registered with this plugin.
+     *
+     * @return All known media sources
+     */
+    public List<MediaSource> getSources() {
+        final List<MediaSource> res = new ArrayList<>(sources);
+
+        for (MediaSourceManager manager : managers) {
+            res.addAll(manager.getSources());
+        }
+
+        return res;
+    }
+
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format,
+            final Object... arguments) {
+        if (type == CoreActionType.PLUGIN_LOADED) {
+            addPlugin((PluginInfo) arguments[0]);
+        } else if (type == CoreActionType.PLUGIN_UNLOADED) {
+            removePlugin((PluginInfo) arguments[0]);
+        }
+    }
+
+}

src/com/dmdirc/addons/nowplaying/NowPlayingModule.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2006-2014 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.nowplaying;
+
+import com.dmdirc.addons.ui_swing.injection.SwingModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+
+import dagger.Module;
+import dagger.Provides;
+
+@Module(injects = {NowPlayingCommand.class, NowPlayingManager.class}, addsTo = SwingModule.class)
+public class NowPlayingModule {
+
+    private final PluginInfo pluginInfo;
+
+    public NowPlayingModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+    
+    @Provides
+    @PluginDomain(NowPlayingPlugin.class)
+    public String getSettingsDomain() {
+        return pluginInfo.getDomain();
+    }
+}

src/com/dmdirc/addons/nowplaying/NowPlayingPlugin.java

@@ -22,104 +22,70 @@
 
 package com.dmdirc.addons.nowplaying;
 
-import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.config.prefs.PluginPreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesDialogModel;
-import com.dmdirc.interfaces.ActionController;
-import com.dmdirc.interfaces.ActionListener;
-import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.actions.ActionType;
-import com.dmdirc.interfaces.config.IdentityController;
-import com.dmdirc.plugins.Plugin;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
 import java.util.concurrent.Callable;
 
+import dagger.ObjectGraph;
+
 /**
  * Plugin that allows users to advertise what they're currently playing or listening to.
  */
-public class NowPlayingPlugin extends BaseCommandPlugin implements ActionListener {
+public class NowPlayingPlugin extends BaseCommandPlugin {
 
-    /** The sources that we know of. */
-    private final List<MediaSource> sources = new ArrayList<>();
-    /** The managers that we know of. */
-    private final List<MediaSourceManager> managers = new ArrayList<>();
-    /** The user's preferred order for source usage. */
-    private List<String> order;
     /** This plugin's plugin info. */
     private final PluginInfo pluginInfo;
-    /** The action controller to use. */
-    private final ActionController actionController;
-    /** The identity controller to use. */
-    private final IdentityController identityController;
+    /** This plugin's settings domain. */
+    private final String domain;
+    /** Now playing manager. */
+    private NowPlayingManager nowplayingmanager;
 
     /**
      * Creates a new instance of this plugin.
      *
-     * @param pluginInfo         This plugin's plugin info
-     * @param actionController   The action controller to register listeners with
-     * @param commandController  Command controller to register commands
-     * @param identityController The identity controller to use.
+     * @param pluginInfo This plugin's plugin info
      */
-    public NowPlayingPlugin(final PluginInfo pluginInfo,
-            final ActionController actionController,
-            final CommandController commandController,
-            final IdentityController identityController) {
-        super(commandController);
-
+    public NowPlayingPlugin(final PluginInfo pluginInfo) {
         this.pluginInfo = pluginInfo;
-        this.actionController = actionController;
-        this.identityController = identityController;
+        this.domain = pluginInfo.getDomain();
+    }
 
-        registerCommand(new NowPlayingCommand(commandController, this, identityController),
-                NowPlayingCommand.INFO);
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new NowPlayingModule(pluginInfo)));
+        registerCommand(NowPlayingCommand.class, NowPlayingCommand.INFO);
+        nowplayingmanager = getObjectGraph().get(NowPlayingManager.class);
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        sources.clear();
-        managers.clear();
-
-        loadSettings();
-
-        actionController.registerListener(this, CoreActionType.PLUGIN_LOADED,
-                CoreActionType.PLUGIN_UNLOADED);
-
-        for (PluginInfo target : pluginInfo.getMetaData().getManager().getPluginInfos()) {
-            if (target.isLoaded()) {
-                addPlugin(target);
-            }
-        }
         super.onLoad();
+        nowplayingmanager.onLoad();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onUnload() {
-        sources.clear();
-        managers.clear();
-        actionController.unregisterListener(this);
-
         super.onUnload();
+        nowplayingmanager.onUnload();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void showConfig(final PreferencesDialogModel manager) {
         final ConfigPanel configPanel = UIUtilities.invokeAndWait(
                 new Callable<ConfigPanel>() {
-            @Override
-            public ConfigPanel call() {
-                return new ConfigPanel(identityController, NowPlayingPlugin.this, order);
-            }
-        });
+                    @Override
+                    public ConfigPanel call() {
+                        return new ConfigPanel(nowplayingmanager, manager.getConfigManager(),
+                                manager.getIdentity(), domain,
+                                nowplayingmanager.getSettings());
+                    }
+                });
 
         final PreferencesCategory category = new PluginPreferencesCategory(
                 pluginInfo, "Now Playing",
@@ -127,208 +93,4 @@ public class NowPlayingPlugin extends BaseCommandPlugin implements ActionListene
         manager.getCategory("Plugins").addSubCategory(category);
     }
 
-    /**
-     * Saves the plugins settings.
-     *
-     * @param newOrder The new order for sources
-     */
-    protected void saveSettings(final List<String> newOrder) {
-        order = newOrder;
-        identityController.getUserSettings().setOption(getDomain(), "sourceOrder", order);
-    }
-
-    /** Loads the plugins settings. */
-    private void loadSettings() {
-        if (identityController.getGlobalConfiguration().hasOptionString(getDomain(), "sourceOrder")) {
-            order = identityController.getGlobalConfiguration().getOptionList(getDomain(),
-                    "sourceOrder");
-        } else {
-            order = new ArrayList<>();
-        }
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void processEvent(final ActionType type, final StringBuffer format,
-            final Object... arguments) {
-        if (type == CoreActionType.PLUGIN_LOADED) {
-            addPlugin((PluginInfo) arguments[0]);
-        } else if (type == CoreActionType.PLUGIN_UNLOADED) {
-            removePlugin((PluginInfo) arguments[0]);
-        }
-    }
-
-    /**
-     * Checks to see if a plugin implements one of the Media Source interfaces and if it does, adds
-     * the source(s) to our list.
-     *
-     * @param target The plugin to be tested
-     */
-    private void addPlugin(final PluginInfo target) {
-        final Plugin targetPlugin = target.getPlugin();
-        if (targetPlugin instanceof MediaSource) {
-            sources.add((MediaSource) targetPlugin);
-            addSourceToOrder((MediaSource) targetPlugin);
-        }
-
-        if (targetPlugin instanceof MediaSourceManager) {
-            managers.add((MediaSourceManager) targetPlugin);
-
-            if (((MediaSourceManager) targetPlugin).getSources() != null) {
-                for (MediaSource source : ((MediaSourceManager) targetPlugin).getSources()) {
-                    addSourceToOrder(source);
-                }
-            }
-        }
-    }
-
-    /**
-     * Checks to see if the specified media source needs to be added to our order list, and adds it
-     * if neccessary.
-     *
-     * @param source The media source to be tested
-     */
-    private void addSourceToOrder(final MediaSource source) {
-        if (!order.contains(source.getAppName())) {
-            order.add(source.getAppName());
-        }
-    }
-
-    /**
-     * Checks to see if a plugin implements one of the Media Source interfaces and if it does,
-     * removes the source(s) from our list.
-     *
-     * @param target The plugin to be tested
-     */
-    private void removePlugin(final PluginInfo target) {
-        final Plugin targetPlugin = target.getPlugin();
-        if (targetPlugin instanceof MediaSource) {
-            sources.remove((MediaSource) targetPlugin);
-        }
-
-        if (targetPlugin instanceof MediaSourceManager) {
-            managers.remove((MediaSourceManager) targetPlugin);
-        }
-    }
-
-    /**
-     * Determines if there are any valid sources (paused or not).
-     *
-     * @return True if there are running sources, false otherwise
-     */
-    public boolean hasRunningSource() {
-        for (final MediaSource source : getSources()) {
-            if (source.getState() != MediaSourceState.CLOSED) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Retrieves the "best" source to use for displaying media information. The best source is
-     * defined as the earliest in the list that is running and not paused, or, if no such source
-     * exists, the earliest in the list that is running and paused. If neither condition is
-     * satisified returns null.
-     *
-     * @return The best source to use for media info
-     */
-    public MediaSource getBestSource() {
-        MediaSource paused = null;
-        final List<MediaSource> possibleSources = getSources();
-
-        Collections.sort(possibleSources, new MediaSourceComparator(order));
-
-        for (final MediaSource source : possibleSources) {
-            if (source.getState() != MediaSourceState.CLOSED) {
-                if (source.getState() == MediaSourceState.PLAYING) {
-                    return source;
-                } else if (paused == null) {
-                    paused = source;
-                }
-            }
-        }
-
-        return paused;
-    }
-
-    /**
-     * Substitutes the keywords in the specified format with the values with values from the
-     * specified source.
-     *
-     * @param format The format to be substituted
-     * @param source The source whose values should be used
-     *
-     * @return The substituted string
-     */
-    public String doSubstitution(final String format, final MediaSource source) {
-        final String artist = source.getArtist();
-        final String title = source.getTitle();
-        final String album = source.getAlbum();
-        final String app = source.getAppName();
-        final String bitrate = source.getBitrate();
-        final String filetype = source.getFormat();
-        final String length = source.getLength();
-        final String time = source.getTime();
-        final String state = source.getState().getNiceName();
-
-        return format.replace("$artist", sanitise(artist))
-                .replace("$title", sanitise(title))
-                .replace("$album", sanitise(album))
-                .replace("$app", sanitise(app))
-                .replace("$bitrate", sanitise(bitrate))
-                .replace("$format", sanitise(filetype))
-                .replace("$length", sanitise(length))
-                .replace("$state", sanitise(state))
-                .replace("$time", sanitise(time));
-    }
-
-    /**
-     * Sanitises the specified String so that it may be used as the replacement in a call to
-     * String.replaceAll. Namely, at present, this method returns an empty String if it is passed a
-     * null value; otherwise the input is returned as-is.
-     *
-     * @param input The string to be sanitised
-     *
-     * @return A sanitised version of the String
-     *
-     * @since 0.6.3
-     */
-    protected static String sanitise(final String input) {
-        return input == null ? "" : input;
-    }
-
-    /**
-     * Retrieves a source based on its name.
-     *
-     * @param name The name to search for
-     *
-     * @return The source with the specified name or null if none were found.
-     */
-    public MediaSource getSource(final String name) {
-        for (final MediaSource source : getSources()) {
-            if (source.getAppName().equalsIgnoreCase(name)) {
-                return source;
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * Retrieves all the sources registered with this plugin.
-     *
-     * @return All known media sources
-     */
-    public List<MediaSource> getSources() {
-        final List<MediaSource> res = new ArrayList<>(sources);
-
-        for (MediaSourceManager manager : managers) {
-            res.addAll(manager.getSources());
-        }
-
-        return res;
-    }
-
 }