Move to injecting various things in the addon browser.

Add a deprecated method to the SwingController/Manager to avoid having
to propagate the changes all the way up through the prefs dialog.

Add dependency on the annotation processor library for factories.

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

ivy.xml

@@ -16,6 +16,7 @@
 
         <dependency org="com.google.guava" name="guava" rev="15.+" conf="build->default" />
         <dependency org="com.google.code.findbugs" name="jsr305" rev="2.+" conf="main->default" />
+        <dependency org="com.dmdirc" name="annotations" rev="[0.3.4,)" conf="main->default" />
 
         <dependency org="org.slf4j" name="slf4j-api" rev="1.+" conf="main->default" />
         <dependency org="org.igniterealtime.smack" name="smack" rev="3.+" conf="main->default" />

src/com/dmdirc/addons/ui_swing/SwingController.java

@@ -35,6 +35,7 @@ import com.dmdirc.addons.ui_swing.commands.Input;
 import com.dmdirc.addons.ui_swing.commands.PopInCommand;
 import com.dmdirc.addons.ui_swing.commands.PopOutCommand;
 import com.dmdirc.addons.ui_swing.commands.ServerSettings;
+import com.dmdirc.addons.ui_swing.components.addonbrowser.DataLoaderWorkerFactory;
 import com.dmdirc.addons.ui_swing.components.frames.TextFrame;
 import com.dmdirc.addons.ui_swing.components.statusbar.FeedbackNag;
 import com.dmdirc.addons.ui_swing.components.statusbar.SwingStatusBar;
@@ -926,4 +927,9 @@ public class SwingController extends BaseCommandPlugin implements UIController {
         return swingManager.getDialogManager();
     }
 
+    @Deprecated
+    public DataLoaderWorkerFactory getDataLoaderWorkerFactory() {
+        return swingManager.getDataLoaderWorkerFactory();
+    }
+
 }

src/com/dmdirc/addons/ui_swing/SwingManager.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.addons.ui_swing;
 
+import com.dmdirc.addons.ui_swing.components.addonbrowser.DataLoaderWorkerFactory;
 import com.dmdirc.addons.ui_swing.components.menubar.MenuBar;
 import com.dmdirc.addons.ui_swing.components.statusbar.SwingStatusBar;
 import com.dmdirc.addons.ui_swing.dialogs.DialogKeyListener;
@@ -72,6 +73,9 @@ public class SwingManager {
     /** The key listener that supports dialogs. */
     private final DialogKeyListener dialogKeyListener;
 
+    /** Factory used to create data loader workers. */
+    private final DataLoaderWorkerFactory dataLoaderWorkerFactory;
+
     /** Provider of first run executors. */
     private final Provider<FirstRunWizardExecutor> firstRunExecutor;
 
@@ -89,6 +93,7 @@ public class SwingManager {
      * @param ctrlTabManager The window manager that handles ctrl+tab behaviour.
      * @param urlHandler The URL handler to use.
      * @param dialogKeyListener The key listener that supports dialogs.
+     * @param dataLoaderWorkerFactory Factory used to create data loader workers.
      * @param firstRunExecutor A provider of first run executors.
      */
     @Inject
@@ -104,6 +109,7 @@ public class SwingManager {
             final CtrlTabWindowManager ctrlTabManager,
             final URLHandler urlHandler,
             final DialogKeyListener dialogKeyListener,
+            final DataLoaderWorkerFactory dataLoaderWorkerFactory,
             final Provider<FirstRunWizardExecutor> firstRunExecutor) {
         this.dialogManager = dialogManager;
         this.eventQueue = eventQueue;
@@ -113,6 +119,7 @@ public class SwingManager {
         this.statusBarManager = statusBarManager;
         this.urlHandler = urlHandler;
         this.dialogKeyListener = dialogKeyListener;
+        this.dataLoaderWorkerFactory = dataLoaderWorkerFactory;
         this.firstRunExecutor = firstRunExecutor;
 
         this.mainFrame = mainFrame;
@@ -167,6 +174,11 @@ public class SwingManager {
         return dialogManager;
     }
 
+    @Deprecated
+    public DataLoaderWorkerFactory getDataLoaderWorkerFactory() {
+        return dataLoaderWorkerFactory;
+    }
+
     /**
      * Retrieves the window factory to use.
      *

src/com/dmdirc/addons/ui_swing/components/addonbrowser/AddonInfoLabel.java

@@ -22,8 +22,8 @@
 
 package com.dmdirc.addons.ui_swing.components.addonbrowser;
 
-import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
+import com.dmdirc.addons.ui_swing.dialogs.DialogManager;
 
 import java.awt.Color;
 import java.awt.Font;
@@ -51,23 +51,28 @@ public class AddonInfoLabel extends JPanel {
     private final AddonInfo addonInfo;
     /** Parent window. */
     private final BrowserWindow parentWindow;
-    /** Swing controller. */
-    private final SwingController controller;
+    /** The manager that will be used for installer dialogs. */
+    private final DialogManager dialogManager;
+    /** Factory to use to create install workers. */
+    private final InstallWorkerFactory workerFactory;
 
     /**
      * Creates a new addon info label to describe the specified addon info.
      *
-     * @param controller Swing controller
+     * @param dialogManager The manager that will be used for installer dialogs.
      * @param addonInfo Addon to describe
      * @param parentWindow Parent window
+     * @param workerFactory
      */
-    public AddonInfoLabel(final SwingController controller,
-            final AddonInfo addonInfo, final BrowserWindow parentWindow) {
-        super();
-
-        this.controller = controller;
+    public AddonInfoLabel(
+            final DialogManager dialogManager,
+            final AddonInfo addonInfo,
+            final BrowserWindow parentWindow,
+            final InstallWorkerFactory workerFactory) {
+        this.dialogManager = dialogManager;
         this.addonInfo = addonInfo;
         this.parentWindow = parentWindow;
+        this.workerFactory = workerFactory;
 
         init();
     }
@@ -95,7 +100,7 @@ public class AddonInfoLabel extends JPanel {
                 "wmax 100%-170, hmax 150, growy, wrap, pushy, gapleft 5");
 
         final JButton button = new JButton("Install");
-        button.addActionListener(new InstallListener(controller, addonInfo,
+        button.addActionListener(new InstallListener(dialogManager, workerFactory, addonInfo,
                 parentWindow));
         final boolean installed = addonInfo.isInstalled();
         add(button, "split, gapleft 5");

src/com/dmdirc/addons/ui_swing/components/addonbrowser/BrowserWindow.java

@@ -22,8 +22,6 @@
 
 package com.dmdirc.addons.ui_swing.components.addonbrowser;
 
-import com.dmdirc.addons.ui_swing.SwingController;
-
 import java.awt.Window;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
@@ -85,19 +83,20 @@ public class BrowserWindow extends JDialog implements ActionListener {
     private final JRadioButton statusButton = new JRadioButton("Status", false);
     /** Row sorter. */
     private final AddonSorter sorter;
-    /** Swing controller. */
-    private final SwingController controller;
+    /** Factory to use to produce workers to load addon data. */
+    private final DataLoaderWorkerFactory loaderFactory;
 
     /**
      * Creates and displays a new browser window.
      *
-     * @param controller Swing controller
+     * @param loaderFactory Factory to use to produce workers.
      * @param parentWindow Parent window
      */
-    public BrowserWindow(final SwingController controller,
+    public BrowserWindow(
+            final DataLoaderWorkerFactory loaderFactory,
             final Window parentWindow) {
         super(parentWindow, "DMDirc Addon Browser", ModalityType.MODELESS);
-        this.controller = controller;
+        this.loaderFactory = loaderFactory;
         setIconImages(parentWindow.getIconImages());
         setResizable(false);
         setLayout(new MigLayout("fill, wmin 650, hmin 600"));
@@ -195,10 +194,7 @@ public class BrowserWindow extends JDialog implements ActionListener {
      * @param download Download new addon feed?
      */
     public final void loadData(final boolean download) {
-        new DataLoaderWorker(controller, list, download,
-                controller.getIdentityManager().getConfigurationDirectory(),
-                this, scrollPane)
-                .executeInExecutor();
+        loaderFactory.getDataLoaderWorker(list, download, this, scrollPane).executeInExecutor();
     }
 
     /**

src/com/dmdirc/addons/ui_swing/components/addonbrowser/DataLoaderWorker.java

@@ -26,9 +26,13 @@ import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
+import com.dmdirc.commandline.CommandLineOptionsModule.Directory;
+import com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.updater.UpdateChecker;
+import com.dmdirc.util.annotations.factory.Factory;
+import com.dmdirc.util.annotations.factory.Unbound;
 import com.dmdirc.util.io.ConfigFile;
 import com.dmdirc.util.io.DownloadListener;
 import com.dmdirc.util.io.Downloader;
@@ -53,6 +57,7 @@ import net.miginfocom.swing.MigLayout;
 /**
  * Loads the addon data feed into the addon browser.
  */
+@Factory(inject = true)
 public class DataLoaderWorker
         extends LoggingSwingWorker<Collection<AddonInfo>, Object>
         implements DownloadListener {
@@ -71,24 +76,30 @@ public class DataLoaderWorker
     private final SwingController controller;
     /** Directory to store temporary files in. */
     private final String tempDirectory;
+    /** Factory to use to produce install workers. */
+    private final InstallWorkerFactory workerFactory;
 
     /**
      * Creates a new data loader worker.
      *
      * @param controller Swing controller
+     * @param workerFactory Factory to use to produce install workers.
+     * @param tempDirectory The directory to store temporary items in, such as the addons feed.
      * @param table Table to load data into
      * @param download Download new addons feed?
-     * @param tempDirectory The directory to store temporary items in, such as the addons feed.
      * @param browserWindow Browser window to pass to table objects
      * @param scrollPane Table's parent scrollpane
      */
-    public DataLoaderWorker(final SwingController controller,
-            final AddonTable table, final boolean download,
-            final String tempDirectory,
-            final BrowserWindow browserWindow, final JScrollPane scrollPane) {
-        super();
-
+    public DataLoaderWorker(
+            final SwingController controller,
+            final InstallWorkerFactory workerFactory,
+            @Directory(DirectoryType.TEMPORARY) final String tempDirectory,
+            @Unbound final AddonTable table,
+            @Unbound final boolean download,
+            @Unbound final BrowserWindow browserWindow,
+            @Unbound final JScrollPane scrollPane) {
         this.controller = controller;
+        this.workerFactory = workerFactory;
         this.download = download;
         this.table = table;
         this.tempDirectory = tempDirectory;
@@ -162,7 +173,7 @@ public class DataLoaderWorker
         table.getModel().setRowCount(0);
         for (final AddonInfo info : data) {
             table.getModel().addRow(new Object[]{
-                new AddonInfoLabel(controller, info, browserWindow),
+                new AddonInfoLabel(controller.getDialogManager(), info, browserWindow, workerFactory),
             });
         }
         table.getSelectionModel().setSelectionInterval(selectedRow, selectedRow);

src/com/dmdirc/addons/ui_swing/components/addonbrowser/InstallListener.java

@@ -22,7 +22,7 @@
 
 package com.dmdirc.addons.ui_swing.components.addonbrowser;
 
-import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.addons.ui_swing.dialogs.DialogManager;
 
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
@@ -34,23 +34,28 @@ public class InstallListener implements ActionListener {
 
     /** Addon info. */
     private final AddonInfo info;
+    /** Factory to use to create install workers. */
+    private final InstallWorkerFactory workerFactory;
     /** Parent window. */
     private final BrowserWindow parentWindow;
     /** Swing controller. */
-    private final SwingController controller;
+    private final DialogManager dialogManager;
 
     /**
      * Instantiates a new install listener.
      *
-     * @param controller Swing controller
+     * @param dialogManager Manager to use for installer dialogs.
+     * @param workerFactory Factory to use to construct install workers.
      * @param info Addoninfo to install
      * @param parentWindow Parent window
      */
-    public InstallListener(final SwingController controller,
-            final AddonInfo info, final BrowserWindow parentWindow) {
-        super();
-
-        this.controller = controller;
+    public InstallListener(
+            final DialogManager dialogManager,
+            final InstallWorkerFactory workerFactory,
+            final AddonInfo info,
+            final BrowserWindow parentWindow) {
+        this.dialogManager = dialogManager;
+        this.workerFactory = workerFactory;
         this.info = info;
         this.parentWindow = parentWindow;
     }
@@ -62,9 +67,9 @@ public class InstallListener implements ActionListener {
      */
     @Override
     public void actionPerformed(final ActionEvent e) {
-        final InstallerWindow installer = new InstallerWindow(controller,
+        final InstallerWindow installer = new InstallerWindow(dialogManager,
                 parentWindow, info);
         installer.display(parentWindow);
-        new InstallWorker(info, installer, controller).executeInExecutor();
+        workerFactory.getInstallWorker(info, installer).executeInExecutor();
     }
 }

src/com/dmdirc/addons/ui_swing/components/addonbrowser/InstallWorker.java

@@ -23,8 +23,12 @@
 package com.dmdirc.addons.ui_swing.components.addonbrowser;
 
 import com.dmdirc.actions.ActionManager;
-import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
+import com.dmdirc.commandline.CommandLineOptionsModule.Directory;
+import com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
+import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.util.annotations.factory.Factory;
+import com.dmdirc.util.annotations.factory.Unbound;
 import com.dmdirc.util.io.Downloader;
 
 import java.io.File;
@@ -34,30 +38,44 @@ import java.util.concurrent.ExecutionException;
 /**
  * Downloads a given addon from the addon site and loads it into the client.
  */
+@Factory(inject = true)
 public class InstallWorker extends LoggingSwingWorker<String, Void> {
 
     /** Addon info. */
     private final AddonInfo info;
     /** Window to show installer progress. */
     private final InstallerWindow installer;
-    /** */
-    private final SwingController controller;
+    /** Temporary directory to download files to. */
+    private final String tempDirectory;
+    /** Directory to install plugins in. */
+    private final String pluginDirectory;
+    /** Directory to install themes in. */
+    private final String themeDirectory;
+    /** Plugin manager to inform of new plugins. */
+    private final PluginManager pluginManager;
 
-    public InstallWorker(final AddonInfo info, final InstallerWindow window,
-            final SwingController controller) {
+    public InstallWorker(
+            @Directory(DirectoryType.TEMPORARY) final String tempDirectory,
+            @Directory(DirectoryType.PLUGINS) final String pluginDirectory,
+            @Directory(DirectoryType.THEMES) final String themeDirectory,
+            final PluginManager pluginManager,
+            @Unbound final AddonInfo info,
+            @Unbound final InstallerWindow window) {
         super();
 
         this.info = info;
         this.installer = window;
-        this.controller = controller;
+        this.tempDirectory = tempDirectory;
+        this.pluginDirectory = pluginDirectory;
+        this.themeDirectory = themeDirectory;
+        this.pluginManager = pluginManager;
     }
 
     /** {@inheritDoc} */
     @Override
     protected String doInBackground() {
         try {
-            final File file = new File(controller.getIdentityManager().getConfigurationDirectory(),
-                    "." + info.getId());
+            final File file = new File(tempDirectory, "." + info.getId());
             Downloader.downloadPage("http://addons.dmdirc.com/addondownload/"
                     + info.getDownload(), file.getAbsolutePath());
 
@@ -66,20 +84,16 @@ public class InstallWorker extends LoggingSwingWorker<String, Void> {
                     ActionManager.installActionPack(file.getAbsolutePath());
                     break;
                 case TYPE_PLUGIN:
-                    final File newFile = new File(
-                            controller.getPluginManager().getDirectory(),
-                            info.getTitle() + ".jar");
+                    final File newFile = new File(pluginDirectory, info.getTitle() + ".jar");
                     if (file.renameTo(newFile)) {
-                        controller.getPluginManager().addPlugin(
-                                newFile.getName());
+                        pluginManager.addPlugin(newFile.getName());
                     } else {
                         return "Unable to install addon, failed to move file: "
                                 + file.getAbsolutePath();
                     }
                     break;
                 case TYPE_THEME:
-                    if (!file.renameTo(new File(controller.getThemeManager().getDirectory()
-                            + info.getTitle() + ".zip"))) {
+                    if (!file.renameTo(new File(themeDirectory, info.getTitle() + ".zip"))) {
                         return "Unable to install addon, failed to move file: "
                                 + file.getAbsolutePath();
                     }

src/com/dmdirc/addons/ui_swing/components/addonbrowser/InstallerWindow.java

@@ -22,8 +22,8 @@
 
 package com.dmdirc.addons.ui_swing.components.addonbrowser;
 
-import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.components.text.TextLabel;
+import com.dmdirc.addons.ui_swing.dialogs.DialogManager;
 import com.dmdirc.addons.ui_swing.dialogs.StandardDialog;
 
 import java.awt.event.ActionEvent;
@@ -57,13 +57,13 @@ public class InstallerWindow extends StandardDialog implements ActionListener {
     /**
      * Instantiates a new installer window.
      *
-     * @param controller Swing controller
+     * @param dialogManager The dialog manager looking after this window.
      * @param parentWindow Parent window
      * @param info Associated addon info
      */
-    public InstallerWindow(final SwingController controller,
+    public InstallerWindow(final DialogManager dialogManager,
             final BrowserWindow parentWindow, final AddonInfo info) {
-        super(controller.getDialogManager(), parentWindow, ModalityType.MODELESS);
+        super(dialogManager, parentWindow, ModalityType.MODELESS);
         this.info = info;
         this.parentWindow = parentWindow;
         setTitle("Installing addon...");

src/com/dmdirc/addons/ui_swing/components/addonpanel/AddonPanel.java

@@ -207,7 +207,7 @@ public abstract class AddonPanel extends JPanel implements AddonToggleListener,
     @Override
     public void hyperlinkUpdate(final HyperlinkEvent e) {
         if (e.getEventType() == EventType.ACTIVATED) {
-            new BrowserWindow(controller, parentWindow);
+            new BrowserWindow(controller.getDataLoaderWorkerFactory(), parentWindow);
         }
     }