Split config stuff into a separate dagger module

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

src/com/dmdirc/ClientModule.java

@@ -34,20 +34,14 @@ import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.aliases.AliasesModule;
 import com.dmdirc.commandparser.auto.AutoCommandModule;
 import com.dmdirc.commandparser.commands.CommandModule;
-import com.dmdirc.config.IdentityManager;
-import com.dmdirc.config.InvalidIdentityFileException;
+import com.dmdirc.config.ConfigModule;
 import com.dmdirc.interfaces.ActionController;
 import com.dmdirc.interfaces.CommandController;
+import com.dmdirc.interfaces.ConnectionFactory;
 import com.dmdirc.interfaces.ConnectionManager;
 import com.dmdirc.interfaces.LifecycleController;
-import com.dmdirc.interfaces.ConnectionFactory;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
-import com.dmdirc.interfaces.config.ConfigProvider;
 import com.dmdirc.interfaces.config.IdentityController;
-import com.dmdirc.interfaces.config.IdentityFactory;
-import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.logger.ErrorManager;
-import com.dmdirc.logger.Logger;
 import com.dmdirc.messages.MessagesModule;
 import com.dmdirc.plugins.CorePluginExtractor;
 import com.dmdirc.plugins.CorePluginHelper;
@@ -57,7 +51,6 @@ import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.plugins.ServiceLocator;
 import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.ui.IconManager;
-import com.dmdirc.ui.WarningDialog;
 import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.themes.ThemeManager;
 import com.dmdirc.updater.UpdaterModule;
@@ -65,10 +58,6 @@ import com.dmdirc.updater.manager.UpdateManager;
 import com.dmdirc.util.URLBuilder;
 import com.dmdirc.util.io.Downloader;
 
-import java.awt.GraphicsEnvironment;
-import java.io.File;
-import java.text.SimpleDateFormat;
-import java.util.Date;
 import java.util.Set;
 
 import javax.inject.Provider;
@@ -86,12 +75,13 @@ import net.engio.mbassy.bus.config.BusConfiguration;
 @Module(
         injects = {Main.class, CommandLineParser.class},
         includes = {
-            AliasesModule.class,
-            AutoCommandModule.class,
-            CommandLineOptionsModule.class,
-            CommandModule.class,
-            MessagesModule.class,
-            UpdaterModule.class
+                AliasesModule.class,
+                AutoCommandModule.class,
+                CommandLineOptionsModule.class,
+                CommandModule.class,
+                ConfigModule.class,
+                MessagesModule.class,
+                UpdaterModule.class
         },
         library = true)
 public class ClientModule {
@@ -115,6 +105,7 @@ public class ClientModule {
     private ObjectGraph objectGraph;
 
     @Provides
+    @SuppressWarnings("TypeMayBeWeakened")
     public ConnectionManager getConnectionManager(final ServerManager serverManager) {
         return serverManager;
     }
@@ -125,44 +116,6 @@ public class ClientModule {
         return new DMDircMBassador(BusConfiguration.Default());
     }
 
-    @Provides
-    @Singleton
-    public IdentityManager getIdentityManager(
-            @Directory(DirectoryType.BASE) final String baseDirectory,
-            @Directory(DirectoryType.IDENTITIES) final String identitiesDirectory,
-            @Directory(DirectoryType.ERRORS) final String errorsDirectory,
-            final CommandLineParser commandLineParser,
-            final DMDircMBassador eventBus) {
-        final IdentityManager identityManager = new IdentityManager(baseDirectory,
-                identitiesDirectory, eventBus);
-        ErrorManager.getErrorManager()
-                .initialise(identityManager.getGlobalConfiguration(), errorsDirectory, eventBus);
-        identityManager.loadVersionIdentity();
-
-        try {
-            identityManager.initialise();
-        } catch (InvalidIdentityFileException ex) {
-            handleInvalidConfigFile(identityManager, baseDirectory);
-        }
-
-        if (commandLineParser.getDisableReporting()) {
-            identityManager.getUserSettings().setOption("temp", "noerrorreporting", true);
-        }
-
-        return identityManager;
-    }
-
-    @Provides
-    public IdentityController getIdentityController(final IdentityManager manager) {
-        return manager;
-    }
-
-    @Provides
-    @GlobalConfig
-    public AggregateConfigProvider getGlobalConfig(final IdentityController controller) {
-        return controller.getGlobalConfiguration();
-    }
-
     @Provides
     @GlobalConfig
     @Singleton
@@ -172,18 +125,6 @@ public class ClientModule {
         return new IconManager(globalConfig, urlBuilder);
     }
 
-    @Provides
-    @UserConfig
-    public ConfigProvider getUserConfig(final IdentityController controller) {
-        return controller.getUserSettings();
-    }
-
-    @Provides
-    @AddonConfig
-    public ConfigProvider getAddonConfig(final IdentityController controller) {
-        return controller.getAddonSettings();
-    }
-
     @Provides
     @Singleton
     public ActionManager getActionManager(
@@ -285,11 +226,6 @@ public class ClientModule {
         return connectionManager;
     }
 
-    @Provides
-    public IdentityFactory getIdentityFactory(final IdentityManager identityManager) {
-        return identityManager;
-    }
-
     @Provides
     public ServiceLocator getServiceLocator(final LegacyServiceLocator locator) {
         return locator;
@@ -315,49 +251,4 @@ public class ClientModule {
         return objectGraph;
     }
 
-    /**
-     * Called when the global config cannot be loaded due to an error. This method informs the user
-     * of the problem and installs a new default config file, backing up the old one.
-     *
-     * @param identityManager The identity manager to re-initialise after installing defaults.
-     * @param configdir       The directory to extract default settings into.
-     */
-    private void handleInvalidConfigFile(final IdentityManager identityManager,
-            final String configdir) {
-        final String date = new SimpleDateFormat("yyyyMMddkkmmss").format(new Date());
-
-        final String message = "DMDirc has detected that your config file "
-                + "has become corrupted.<br><br>DMDirc will now backup "
-                + "your current config and try restarting with a default "
-                + "config.<br><br>Your old config will be saved as:<br>"
-                + "dmdirc.config." + date;
-
-        if (!GraphicsEnvironment.isHeadless()) {
-            new WarningDialog("Invalid Config File", message).displayBlocking();
-        }
-
-        // Let command-line users know what is happening.
-        System.out.println(message.replace("<br>", "\n"));
-
-        final File configFile = new File(configdir + "dmdirc.config");
-        final File newConfigFile = new File(configdir + "dmdirc.config." + date);
-
-        if (configFile.renameTo(newConfigFile)) {
-            try {
-                identityManager.initialise();
-            } catch (InvalidIdentityFileException iife) {
-                // This shouldn't happen!
-                Logger.appError(ErrorLevel.FATAL, "Unable to load global config", iife);
-            }
-        } else {
-            final String newMessage = "DMDirc was unable to rename the "
-                    + "global config file and is unable to fix this issue.";
-            if (!GraphicsEnvironment.isHeadless()) {
-                new WarningDialog("Invalid Config File", newMessage).displayBlocking();
-            }
-            System.out.println(newMessage.replace("<br>", "\n"));
-            System.exit(1);
-        }
-    }
-
 }

src/com/dmdirc/config/ConfigModule.java

@@ -0,0 +1,160 @@
+/*
+ * 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.config;
+
+import com.dmdirc.DMDircMBassador;
+import com.dmdirc.commandline.CommandLineParser;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.interfaces.config.IdentityController;
+import com.dmdirc.interfaces.config.IdentityFactory;
+import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.logger.ErrorManager;
+import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.WarningDialog;
+
+import java.awt.GraphicsEnvironment;
+import java.io.File;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
+import javax.inject.Singleton;
+
+import dagger.Module;
+import dagger.Provides;
+
+import static com.dmdirc.ClientModule.AddonConfig;
+import static com.dmdirc.ClientModule.GlobalConfig;
+import static com.dmdirc.ClientModule.UserConfig;
+import static com.dmdirc.commandline.CommandLineOptionsModule.Directory;
+import static com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
+
+/**
+ * Dagger module for the configuration system.
+ */
+@SuppressWarnings("TypeMayBeWeakened")
+@Module(library = true, complete = false)
+public class ConfigModule {
+
+
+    @Provides
+    @Singleton
+    public IdentityManager getIdentityManager(
+            @Directory(DirectoryType.BASE) final String baseDirectory,
+            @Directory(DirectoryType.IDENTITIES) final String identitiesDirectory,
+            @Directory(DirectoryType.ERRORS) final String errorsDirectory,
+            final CommandLineParser commandLineParser,
+            final DMDircMBassador eventBus) {
+        final IdentityManager identityManager = new IdentityManager(baseDirectory,
+                identitiesDirectory, eventBus);
+        ErrorManager.getErrorManager()
+                .initialise(identityManager.getGlobalConfiguration(), errorsDirectory, eventBus);
+        identityManager.loadVersionIdentity();
+
+        try {
+            identityManager.initialise();
+        } catch (InvalidIdentityFileException ex) {
+            handleInvalidConfigFile(identityManager, baseDirectory);
+        }
+
+        if (commandLineParser.getDisableReporting()) {
+            identityManager.getUserSettings().setOption("temp", "noerrorreporting", true);
+        }
+
+        return identityManager;
+    }
+
+    @Provides
+    public IdentityController getIdentityController(final IdentityManager manager) {
+        return manager;
+    }
+
+    @Provides
+    @GlobalConfig
+    public AggregateConfigProvider getGlobalConfig(final IdentityController controller) {
+        return controller.getGlobalConfiguration();
+    }
+
+    @Provides
+    @UserConfig
+    public ConfigProvider getUserConfig(final IdentityController controller) {
+        return controller.getUserSettings();
+    }
+
+    @Provides
+    @AddonConfig
+    public ConfigProvider getAddonConfig(final IdentityController controller) {
+        return controller.getAddonSettings();
+    }
+
+    @Provides
+    public IdentityFactory getIdentityFactory(final IdentityManager identityManager) {
+        return identityManager;
+    }
+
+    /**
+     * Called when the global config cannot be loaded due to an error. This method informs the user
+     * of the problem and installs a new default config file, backing up the old one.
+     *
+     * @param identityManager The identity manager to re-initialise after installing defaults.
+     * @param configdir       The directory to extract default settings into.
+     */
+    private void handleInvalidConfigFile(final IdentityManager identityManager,
+            final String configdir) {
+        final String date = new SimpleDateFormat("yyyyMMddkkmmss").format(new Date());
+
+        final String message = "DMDirc has detected that your config file "
+                + "has become corrupted.<br><br>DMDirc will now backup "
+                + "your current config and try restarting with a default "
+                + "config.<br><br>Your old config will be saved as:<br>"
+                + "dmdirc.config." + date;
+
+        if (!GraphicsEnvironment.isHeadless()) {
+            new WarningDialog("Invalid Config File", message).displayBlocking();
+        }
+
+        // Let command-line users know what is happening.
+        System.out.println(message.replace("<br>", "\n"));
+
+        final File configFile = new File(configdir + "dmdirc.config");
+        final File newConfigFile = new File(configdir + "dmdirc.config." + date);
+
+        if (configFile.renameTo(newConfigFile)) {
+            try {
+                identityManager.initialise();
+            } catch (InvalidIdentityFileException iife) {
+                // This shouldn't happen!
+                Logger.appError(ErrorLevel.FATAL, "Unable to load global config", iife);
+            }
+        } else {
+            final String newMessage = "DMDirc was unable to rename the "
+                    + "global config file and is unable to fix this issue.";
+            if (!GraphicsEnvironment.isHeadless()) {
+                new WarningDialog("Invalid Config File", newMessage).displayBlocking();
+            }
+            System.out.println(newMessage.replace("<br>", "\n"));
+            System.exit(1);
+        }
+    }
+
+}