Add some methods to update components to indicate if a restart of the client is needed before the user updates

fixes issue 642

Change-Id: I64f23ddcd75e97700a02e1c65d97ae91e48734f5
Reviewed-on: http://gerrit.dmdirc.com/1057
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>

src/com/dmdirc/updater/UpdateComponent.java

@@ -26,25 +26,25 @@ package com.dmdirc.updater;
  * The update component interface defines the methods needed to be implemented
  * by updatable components. The components handle determining the current
  * version and installing updated files.
- * 
+ *
  * @author chris
  */
 public interface UpdateComponent {
-    
+
     /**
      * Retrieves the name of this component.
-     * 
+     *
      * @return This component's name
      */
     String getName();
-    
+
     /**
      * A user-friendly name displayed for the component.
-     * 
+     *
      * @return This component's user-friendly name
      */
     String getFriendlyName();
-    
+
     /**
      * A user-friendly version displayed for the component.
      *
@@ -55,17 +55,45 @@ public interface UpdateComponent {
 
     /**
      * Retrieves the currently installed version of this component.
-     * 
+     *
      * @return This component's current version
      * @since 0.6.3m1
      */
     Version getVersion();
-    
+
+    /**
+     * Provisionally indicates if this component will require a client
+     * restart. The result of {@link #doInstall(java.lang.String)} ultimately
+     * decides if the client requires a restart.
+     *
+     * @return True if the client requires a restart
+     * @since 0.6.4
+     */
+    boolean requiresRestart();
+
+    /**
+     * Indicates if this component will require a manual install.
+     *
+     * @return True if the component requires a manual install
+     * @since 0.6.4
+     */
+    boolean requiresManualInstall();
+
+    /**
+     * Generates manual installation instructions given that the update has been
+     * downloaded to the specified temporary path.
+     *
+     * @param path The full path to the downloaded data
+     * @return Return manual instructions for this plugin
+     * @since 0.6.4
+     */
+    String getManualInstructions(final String path);
+
     /**
      * Installs the updated version of this component. After the update has
      * been installed, the component is responsible for deleting the specified
      * file.
-     * 
+     *
      * @param path The full path to the downloaded data
      * @return True if a client restart is needed, false otherwise
      * @throws java.lang.Exception If any error occured

src/com/dmdirc/updater/components/ActionGroupComponent.java

@@ -30,22 +30,22 @@ import com.dmdirc.updater.Version;
 
 /**
  * Update component for action groups.
- * 
+ *
  * @author chris
  */
 public class ActionGroupComponent implements UpdateComponent {
-    
+
     /** The group that this component represents. */
     private ActionGroup group;
-    
+
     /**
      * Creates a new ActionGroupComponent for the specified action group.
-     * 
+     *
      * @param group The action group this component is for
      */
     public ActionGroupComponent(final ActionGroup group) {
         this.group = group;
-        
+
         if (group.getComponent() != -1 && group.getVersion() != null) {
             UpdateChecker.removeComponent(getName());
             UpdateChecker.registerComponent(this);
@@ -76,6 +76,24 @@ public class ActionGroupComponent implements UpdateComponent {
         return String.valueOf(getVersion());
     }
 
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresRestart() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresManualInstall() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getManualInstructions(final String path) {
+        return "";
+    }
+
     /** {@inheritDoc} */
     @Override
     public boolean doInstall(final String path) throws Exception {

src/com/dmdirc/updater/components/ClientComponent.java

@@ -32,7 +32,7 @@ import java.io.File;
 
 /**
  * Represents the client component, which covers the core client resources.
- * 
+ *
  * @author chris
  */
 public class ClientComponent implements UpdateComponent {
@@ -42,7 +42,7 @@ public class ClientComponent implements UpdateComponent {
     public String getName() {
         return "client";
     }
-    
+
     /** {@inheritDoc} */
     @Override
     public String getFriendlyName() {
@@ -57,26 +57,24 @@ public class ClientComponent implements UpdateComponent {
 
     /** {@inheritDoc} */
     @Override
-    public String getFriendlyVersion() {
-        return IdentityManager.getGlobalConfig().getOption("version", "version");
+    public boolean requiresRestart() {
+        return true;
     }
 
     /** {@inheritDoc} */
     @Override
-    public boolean doInstall(final String path) {
-        final File tmpFile = new File(path);
-        final File targetFile = new File(tmpFile.getParent() + File.separator + ".DMDirc.jar");
-        
-        if (targetFile.exists()) {
-            targetFile.delete();
-        }
-        
-        tmpFile.renameTo(targetFile);
-        
-        if (!LauncherComponent.isUsingLauncher()) {
-            final String message;
+    public boolean requiresManualInstall() {
+        return !LauncherComponent.isUsingLauncher();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getManualInstructions(final String path) {
+        final File targetFile = new File(new File(path).getParent() + File.separator + ".DMDirc.jar");
+
+        if (requiresManualInstall()) {
             if (DMDircResourceManager.isRunningFromJar()) {
-                message = "A new version of DMDirc has been downloaded, but as you\n"
+                return "A new version of DMDirc has been downloaded, but as you\n"
                     + "do not seem to be using the DMDirc launcher, it will\n"
                     + "not be installed automatically.\n\n"
                     + "To install this update manually, please replace the\n"
@@ -85,7 +83,7 @@ public class ClientComponent implements UpdateComponent {
                     + "with the following file:\n"
                     + "  " + targetFile.getAbsolutePath();
             } else {
-                message = "A new version of DMDirc has been downloaded, but as you\n"
+                return "A new version of DMDirc has been downloaded, but as you\n"
                     + "do not seem to be using the DMDirc launcher, it will\n"
                     + "not be installed automatically.\n\n"
                     + "To install this update manually, please extract the\n"
@@ -94,10 +92,34 @@ public class ClientComponent implements UpdateComponent {
                     + "over your existing DMDirc install located in:\n"
                     + "  " + DMDircResourceManager.getCurrentWorkingDirectory();
             }
-            
+        }
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getFriendlyVersion() {
+        return IdentityManager.getGlobalConfig().getOption("version", "version");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean doInstall(final String path) {
+        final File tmpFile = new File(path);
+        final File targetFile = new File(tmpFile.getParent() + File.separator + ".DMDirc.jar");
+
+        if (targetFile.exists()) {
+            targetFile.delete();
+        }
+
+        tmpFile.renameTo(targetFile);
+
+         // @deprecated Should be removed when updater UI changes are implemented.
+        final String message = this.getManualInstructions(path);
+        if (requiresManualInstall()) {
             Main.getUI().showMessageDialog("Client update downloaded", message);
         }
-        
+
         return true;
     }
 

src/com/dmdirc/updater/components/DefaultsComponent.java

@@ -33,7 +33,7 @@ import java.io.IOException;
 
 /**
  * Represents the default identities.
- * 
+ *
  * @author chris
  */
 public class DefaultsComponent implements UpdateComponent {
@@ -43,12 +43,12 @@ public class DefaultsComponent implements UpdateComponent {
     public String getName() {
         return "defaultsettings";
     }
-    
+
     /** {@inheritDoc} */
     @Override
     public String getFriendlyName() {
         return "Default settings";
-    }    
+    }
 
     /** {@inheritDoc} */
     @Override
@@ -57,10 +57,10 @@ public class DefaultsComponent implements UpdateComponent {
     }
 
     /** {@inheritDoc} */
-    @Override    
+    @Override
     public Version getVersion() {
         final ConfigManager globalConfig = IdentityManager.getGlobalConfig();
-        
+
         if (globalConfig.hasOptionString("identity", "defaultsversion")) {
             return new Version(globalConfig.getOption("identity", "defaultsversion"));
         } else {
@@ -68,21 +68,39 @@ public class DefaultsComponent implements UpdateComponent {
         }
     }
 
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresRestart() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresManualInstall() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getManualInstructions(final String path) {
+        return "";
+    }
+
     /**
      * {@inheritDoc}
-     * 
+     *
      * @throws java.io.IOException On i/o exception when reading zip file
      */
     @Override
     public boolean doInstall(final String path) throws IOException {
         final ZipResourceManager ziprm = ZipResourceManager.getInstance(path);
-        
+
         ziprm.extractResources("", IdentityManager.getDirectory());
-        
+
         IdentityManager.loadUser();
-        
+
         new File(path).delete();
-        
+
         return false;
     }
 

src/com/dmdirc/updater/components/LauncherComponent.java

@@ -88,12 +88,12 @@ public class LauncherComponent implements UpdateComponent, OptionsComponent {
     public String getName() {
         return "launcher-" + platform;
     }
-    
+
     /** {@inheritDoc} */
     @Override
     public String getFriendlyName() {
         return "Launcher";
-    }    
+    }
 
     /** {@inheritDoc} */
     @Override
@@ -113,6 +113,25 @@ public class LauncherComponent implements UpdateComponent, OptionsComponent {
         return options;
     }
 
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresRestart() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresManualInstall() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getManualInstructions(final String path) {
+        return "";
+    }
+
     /** {@inheritDoc} */
     @Override
     public boolean doInstall(final String path) throws Exception {
@@ -126,13 +145,13 @@ public class LauncherComponent implements UpdateComponent, OptionsComponent {
 
             tmpFile.renameTo(targetFile);
             targetFile.setExecutable(true);
-            return true;
+
         } else {
             final ZipResourceManager ziprm = ZipResourceManager.getInstance(path);
             ziprm.extractResources("", tmpFile.getParent()+ File.separator);
             new File(path).delete();
-            return true;
         }
+        return true;
     }
 
 }

src/com/dmdirc/updater/components/ModeAliasesComponent.java

@@ -33,7 +33,7 @@ import java.io.IOException;
 
 /**
  * Represents the mode alias identities.
- * 
+ *
  * @author chris
  */
 public class ModeAliasesComponent implements UpdateComponent {
@@ -43,12 +43,12 @@ public class ModeAliasesComponent implements UpdateComponent {
     public String getName() {
         return "modealiases";
     }
-    
+
     /** {@inheritDoc} */
     @Override
     public String getFriendlyName() {
         return "Mode aliases";
-    }    
+    }
 
     /** {@inheritDoc} */
     @Override
@@ -57,10 +57,10 @@ public class ModeAliasesComponent implements UpdateComponent {
     }
 
     /** {@inheritDoc} */
-    @Override    
+    @Override
     public Version getVersion() {
         final ConfigManager globalConfig = IdentityManager.getGlobalConfig();
-        
+
         if (globalConfig.hasOptionString("identity", "modealiasversion")) {
             return new Version(globalConfig.getOption("identity", "modealiasversion"));
         } else {
@@ -68,21 +68,39 @@ public class ModeAliasesComponent implements UpdateComponent {
         }
     }
 
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresRestart() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresManualInstall() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getManualInstructions(final String path) {
+        return "";
+    }
+
     /**
      * {@inheritDoc}
-     * 
+     *
      * @throws java.io.IOException On i/o exception when reading zip file
      */
     @Override
     public boolean doInstall(final String path) throws IOException {
         final ZipResourceManager ziprm = ZipResourceManager.getInstance(path);
-        
+
         ziprm.extractResources("", IdentityManager.getDirectory());
-        
+
         IdentityManager.loadUser();
-        
+
         new File(path).delete();
-        
+
         return false;
     }
 

src/com/dmdirc/updater/components/PluginComponent.java

@@ -34,26 +34,26 @@ import java.io.File;
 
 /**
  * An update component for plugins.
- * 
+ *
  * @author chris
  */
 public class PluginComponent implements UpdateComponent, FileComponent {
-    
+
     /** The plugin this component is for. */
     private final PluginInfo plugin;
-    
+
     /** The config to use. */
     private static final ConfigManager config = IdentityManager.getGlobalConfig();
 
     /**
      * Creates a new PluginComponent for the specified plugin, to enable it to
      * be updated automatically.
-     * 
+     *
      * @param plugin The plugin to be added to the updater
      */
     public PluginComponent(final PluginInfo plugin) {
         this.plugin = plugin;
-        
+
         if ((plugin.getAddonID() > 0 && plugin.getVersion().isValid())
                 || (config.hasOptionInt("plugin-addonid", plugin.getName()))) {
             UpdateChecker.removeComponent(getName());
@@ -72,7 +72,7 @@ public class PluginComponent implements UpdateComponent, FileComponent {
     }
 
     /** {@inheritDoc} */
-    @Override    
+    @Override
     public String getFriendlyName() {
         return plugin.getNiceName();
     }
@@ -84,13 +84,31 @@ public class PluginComponent implements UpdateComponent, FileComponent {
     }
 
     /** {@inheritDoc} */
-    @Override    
+    @Override
     public Version getVersion() {
         return plugin.getVersion();
     }
 
     /** {@inheritDoc} */
-    @Override    
+    @Override
+    public boolean requiresRestart() {
+        return !plugin.isUnloadable() && plugin.isLoaded();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean requiresManualInstall() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getManualInstructions(final String path) {
+        return "";
+    }
+
+    /** {@inheritDoc} */
+    @Override
     public boolean doInstall(final String path) throws Exception {
         final File target = new File(plugin.getFullFilename());
 
@@ -110,14 +128,14 @@ public class PluginComponent implements UpdateComponent, FileComponent {
         // If it doesn't work then keep the plugin in a .update file untill
         // the next restart.
         // If it does, update the metadata.
-        if ((!plugin.isUnloadable() && plugin.isLoaded()) || !new File(path).renameTo(target)) {
+        if (requiresRestart() || !new File(path).renameTo(target)) {
             // Windows rocks!
             final File newTarget = new File(plugin.getFullFilename() + ".update");
-            
+
             if (newTarget.exists()) {
                 newTarget.delete();
             }
-            
+
             new File(path).renameTo(newTarget);
             returnCode = true;
         } else {
@@ -126,7 +144,7 @@ public class PluginComponent implements UpdateComponent, FileComponent {
 
         // If the plugin was loaded before, load it again.
         if (wasLoaded) { plugin.loadPlugin(); }
-        
+
         return returnCode;
     }