Add getMetaData method to PluginInfo and use it

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

src/com/dmdirc/Main.java

@@ -270,13 +270,13 @@ public final class Main {
      */
     private static void checkBundledPlugins(final PluginManager pm, final ConfigManager config) {
         for (PluginInfo plugin : pm.getPluginInfos()) {
-            if (config.hasOptionString("bundledplugins_versions", plugin.getName())) {
+            if (config.hasOptionString("bundledplugins_versions", plugin.getMetaData().getName())) {
                 final Version bundled = new Version(config.getOption("bundledplugins_versions",
-                        plugin.getName()));
-                final Version installed = plugin.getVersion();
+                        plugin.getMetaData().getName()));
+                final Version installed = plugin.getMetaData().getVersion();
 
                 if (installed.compareTo(bundled) < 0) {
-                    extractCorePlugins(plugin.getName());
+                    extractCorePlugins(plugin.getMetaData().getName());
                     PluginManager.getPluginManager().reloadPlugin(plugin.getFilename());
                 }
             }

src/com/dmdirc/commandparser/BaseCommandInfo.java

@@ -57,8 +57,13 @@ public class BaseCommandInfo implements CommandInfo {
         return name;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * @deprecated All commands should be shown in help messages
+     */
     @Override
+    @Deprecated
     public boolean showInHelp() {
         return true;
     }

src/com/dmdirc/commandparser/commands/global/Ifplugin.java

@@ -92,8 +92,8 @@ public class Ifplugin extends Command implements IntelligentCommand {
 
             for (PluginInfo possPlugin
                     : PluginManager.getPluginManager().getPluginInfos()) {
-                res.add(possPlugin.getName());
-                res.add("!" + possPlugin.getName());
+                res.add(possPlugin.getMetaData().getName());
+                res.add("!" + possPlugin.getMetaData().getName());
             }
         } else {
             res = TabCompleter.getIntelligentResults(arg, context, 1);

src/com/dmdirc/commandparser/commands/global/ReloadPlugin.java

@@ -58,7 +58,7 @@ public class ReloadPlugin extends Command implements IntelligentCommand {
         if (plugin == null) {
             sendLine(origin, args.isSilent(), FORMAT_ERROR,
                     "Plugin Reloading failed - Plugin not loaded");
-        } else if (PluginManager.getPluginManager().reloadPlugin(plugin.getRelativeFilename())) {
+        } else if (PluginManager.getPluginManager().reloadPlugin(plugin.getMetaData().getRelativeFilename())) {
             sendLine(origin, args.isSilent(), FORMAT_OUTPUT, "Plugin Reloaded.");
         } else {
             sendLine(origin, args.isSilent(), FORMAT_ERROR, "Plugin Reloading failed");
@@ -73,7 +73,7 @@ public class ReloadPlugin extends Command implements IntelligentCommand {
 
         if (arg == 0) {
             for (PluginInfo possPlugin : PluginManager.getPluginManager().getPluginInfos()) {
-                res.add(possPlugin.getName());
+                res.add(possPlugin.getMetaData().getName());
             }
         }
 

src/com/dmdirc/commandparser/commands/global/UnloadPlugin.java

@@ -57,7 +57,7 @@ public class UnloadPlugin extends Command implements IntelligentCommand {
                 .getPluginInfoByName(args.getArguments()[0]);
         if (plugin == null) {
             sendLine(origin, args.isSilent(), FORMAT_ERROR, "Plugin unloading failed - Plugin not loaded");
-        } else if (PluginManager.getPluginManager().delPlugin(plugin.getRelativeFilename())) {
+        } else if (PluginManager.getPluginManager().delPlugin(plugin.getMetaData().getRelativeFilename())) {
             sendLine(origin, args.isSilent(), FORMAT_OUTPUT, "Plugin Unloaded.");
             PluginManager.getPluginManager().updateAutoLoad(plugin);
         } else {
@@ -74,7 +74,7 @@ public class UnloadPlugin extends Command implements IntelligentCommand {
         if (arg == 0) {
             for (PluginInfo possPlugin : PluginManager.getPluginManager().getPluginInfos()) {
                 if (possPlugin.isLoaded()) {
-                    res.add(possPlugin.getName());
+                    res.add(possPlugin.getMetaData().getName());
                 }
             }
         }

src/com/dmdirc/commandparser/commands/server/RawServerCommand.java

@@ -67,8 +67,13 @@ public class RawServerCommand extends Command implements CommandInfo {
         return myName;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * @deprecated All commands should be shown in help messages
+     */
     @Override
+    @Deprecated
     public boolean showInHelp() {
         return true;
     }

src/com/dmdirc/config/prefs/PluginPreferencesCategory.java

@@ -97,9 +97,10 @@ public class PluginPreferencesCategory extends PreferencesCategory {
      */
     private void setPlugin(final PluginInfo plugin) {
         if (!plugin.isLoaded()) {
-            setWarning("These are settings for the '" + plugin.getNiceName() + "' plugin, "
-                    + "which is not currently loaded. You must enable the plugin in the "
-                    + "main 'Plugins' category for these settings to have any effect.");
+            setWarning("These are settings for the '" + plugin.getMetaData()
+                    .getFriendlyName() + "' plugin, " + "which is not currently"
+                    + " loaded. You must enable the plugin in the main 'Plugins'"
+                    + " category for these settings to have any effect.");
         }
     }
 

src/com/dmdirc/plugins/BasePlugin.java

@@ -108,8 +108,14 @@ public abstract class BasePlugin implements Plugin {
         }
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * @deprecated PluginInfo should be obtained using a constructor parameter,
+     * if required
+     */
     @Override
+    @Deprecated
     public void setPluginInfo(final PluginInfo pluginInfo) {
         this.pluginInfo = pluginInfo;
     }
@@ -147,7 +153,7 @@ public abstract class BasePlugin implements Plugin {
             final String fs = System.getProperty("file.separator");
             final String dir = PluginManager.getPluginManager()
                     .getFilesDirectory();
-            filesDir = new File(dir + pluginInfo.getName() + fs);
+            filesDir = new File(dir + pluginInfo.getMetaData().getName() + fs);
             if (!filesDir.exists()) {
                 filesDir.mkdirs();
             }

src/com/dmdirc/plugins/ExportInfo.java

@@ -52,7 +52,7 @@ public class ExportInfo {
     public ExportedService getExportedService() {
         try {
             final Class<?> c = pluginInfo.getPluginClassLoader().loadClass(className, false);
-            final Plugin p = className.equals(pluginInfo.getMainClass()) ? pluginInfo.getPluginObject() : null;
+            final Plugin p = className.equals(pluginInfo.getMetaData().getMainClass()) ? pluginInfo.getPluginObject() : null;
             return new ExportedService(c, methodName, p);
         } catch (ClassNotFoundException cnfe) {
             return null;

src/com/dmdirc/plugins/GlobalClassLoader.java

@@ -81,7 +81,7 @@ public final class GlobalClassLoader extends ClassLoader {
     public Class<?> loadClass(final String name, final PluginInfo pi) throws ClassNotFoundException {
         for (String classname : pi.getPersistentClasses()) {
             if (!resourcesList.containsKey(classname)) {
-                resourcesList.put(classname, pi.getFullFilename());
+                resourcesList.put(classname, pi.getMetaData().getPluginUrl().getPath());
             }
         }
         return loadClass(name);

src/com/dmdirc/plugins/PluginClassLoader.java

@@ -137,7 +137,7 @@ public class PluginClassLoader extends ClassLoader {
                 }
             }
         } catch (NoClassDefFoundError e) {
-            throw new ClassNotFoundException("Error loading '" + name + "' (wanted by " + pluginInfo.getName() + ") -> " + e.getMessage(), e);
+            throw new ClassNotFoundException("Error loading '" + name + "' (wanted by " + pluginInfo.getMetaData().getName() + ") -> " + e.getMessage(), e);
         }
 
 
@@ -152,7 +152,7 @@ public class PluginClassLoader extends ClassLoader {
         if (res.resourceExists(fileName)) {
             data = res.getResourceBytes(fileName);
         } else {
-            throw new ClassNotFoundException("Resource '" + name + "' (wanted by " + pluginInfo.getName() + ") does not exist.");
+            throw new ClassNotFoundException("Resource '" + name + "' (wanted by " + pluginInfo.getMetaData().getName() + ") does not exist.");
         }
 
         try {

src/com/dmdirc/plugins/PluginInfo.java

@@ -115,6 +115,15 @@ public class PluginInfo implements Comparable<PluginInfo>, ServiceProvider {
         getDefaults();
     }
 
+    /**
+     * Gets this plugin's meta data object.
+     *
+     * @return Plugin meta data object
+     */
+    public PluginMetaData getMetaData() {
+        return metadata;
+    }
+
     /**
      * Updates the list of known classes within this plugin from the specified
      * resource manager.

src/com/dmdirc/plugins/PluginManager.java

@@ -375,7 +375,7 @@ public class PluginManager implements ActionListener {
      */
     public PluginInfo getPluginInfoByName(final String name) {
         for (PluginInfo pluginInfo : getPluginInfos()) {
-            if (pluginInfo.getName().equalsIgnoreCase(name)) {
+            if (pluginInfo.getMetaData().getName().equalsIgnoreCase(name)) {
                 return pluginInfo;
             }
         }
@@ -550,7 +550,7 @@ public class PluginManager implements ActionListener {
      */
     public void updateAutoLoad(final PluginInfo plugin) {
         final List<String> list = IdentityManager.getGlobalConfig().getOptionList("plugins", "autoload");
-        final String path = plugin.getRelativeFilename();
+        final String path = plugin.getMetaData().getRelativeFilename();
 
         if (plugin.isLoaded() && !list.contains(path)) {
             list.add(path);
@@ -582,9 +582,9 @@ public class PluginManager implements ActionListener {
                     try {
                         pi.getPlugin().showConfig((PreferencesDialogModel) arguments[0]);
                     } catch (LinkageError le) {
-                        Logger.userError(ErrorLevel.MEDIUM, "Error with plugin (" + pi.getNiceName() + "), unable to show config (" + le + ")", le);
+                        Logger.userError(ErrorLevel.MEDIUM, "Error with plugin (" + pi.getMetaData().getFriendlyName() + "), unable to show config (" + le + ")", le);
                     } catch (Exception ex) {
-                        Logger.userError(ErrorLevel.MEDIUM, "Error with plugin (" + pi.getNiceName() + "), unable to show config (" + ex + ")", ex);
+                        Logger.userError(ErrorLevel.MEDIUM, "Error with plugin (" + pi.getMetaData().getFriendlyName() + "), unable to show config (" + ex + ")", ex);
                     }
                 }
             }

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

@@ -52,8 +52,8 @@ public class PluginComponent implements UpdateComponent, FileComponent {
     public PluginComponent(final PluginInfo plugin) {
         this.plugin = plugin;
 
-        if ((plugin.getAddonID() > 0 && plugin.getVersion().isValid())
-                || (CONFIG.hasOptionInt("plugin-addonid", plugin.getName()))) {
+        if ((plugin.getMetaData().getUpdaterId() > 0 && plugin.getMetaData().getVersion().isValid())
+                || (CONFIG.hasOptionInt("plugin-addonid", plugin.getMetaData().getName()))) {
             UpdateChecker.removeComponent(getName());
             UpdateChecker.registerComponent(this);
         }
@@ -62,29 +62,29 @@ public class PluginComponent implements UpdateComponent, FileComponent {
     /** {@inheritDoc} */
     @Override
     public String getName() {
-        if (plugin.getAddonID() > 0) {
-            return "addon-" + plugin.getAddonID();
+        if (plugin.getMetaData().getUpdaterId() > 0) {
+            return "addon-" + plugin.getMetaData().getUpdaterId();
         } else {
-            return "addon-" + CONFIG.getOption("plugin-addonid", plugin.getName());
+            return "addon-" + CONFIG.getOption("plugin-addonid", plugin.getMetaData().getName());
         }
     }
 
     /** {@inheritDoc} */
     @Override
     public String getFriendlyName() {
-        return plugin.getNiceName();
+        return plugin.getMetaData().getFriendlyName();
     }
 
     /** {@inheritDoc} */
     @Override
     public String getFriendlyVersion() {
-        return plugin.getFriendlyVersion();
+        return plugin.getMetaData().getFriendlyVersion();
     }
 
     /** {@inheritDoc} */
     @Override
     public Version getVersion() {
-        return plugin.getVersion();
+        return plugin.getMetaData().getVersion();
     }
 
     /** {@inheritDoc} */
@@ -108,7 +108,7 @@ public class PluginComponent implements UpdateComponent, FileComponent {
     /** {@inheritDoc} */
     @Override
     public boolean doInstall(final String path) {
-        final File target = new File(plugin.getFullFilename());
+        final File target = new File(plugin.getMetaData().getPluginUrl().getPath());
 
         boolean returnCode = false;
         final boolean wasLoaded = plugin.isLoaded();
@@ -128,7 +128,7 @@ public class PluginComponent implements UpdateComponent, FileComponent {
         // If it does, update the metadata.
         if (requiresRestart() || !new File(path).renameTo(target)) {
             // Windows rocks!
-            final File newTarget = new File(plugin.getFullFilename() + ".update");
+            final File newTarget = new File(plugin.getMetaData().getPluginUrl().getPath() + ".update");
 
             if (newTarget.exists()) {
                 newTarget.delete();

src/com/dmdirc/util/URLBuilder.java

@@ -110,8 +110,8 @@ public final class URLBuilder {
      */
     public static URL buildPluginURL(final String plugin, final String path) {
         return buildJarURL(
-                PluginManager.getPluginManager().getPluginInfoByName(plugin).getFullFilename(),
-                path);
+                PluginManager.getPluginManager().getPluginInfoByName(plugin)
+                .getMetaData().getPluginUrl().getPath(), path);
     }
 
     /**

test/com/dmdirc/config/prefs/PluginPreferencesCategoryTest.java

@@ -21,6 +21,7 @@
  */
 package com.dmdirc.config.prefs;
 
+import com.dmdirc.plugins.PluginMetaData;
 import com.dmdirc.plugins.PluginInfo;
 
 import org.junit.BeforeClass;
@@ -31,16 +32,21 @@ import static org.mockito.Mockito.*;
 public class PluginPreferencesCategoryTest {
 
     private static PluginInfo loaded, unloaded;
+    private static PluginMetaData metaData;
     private static PreferencesInterface obj;
 
     @BeforeClass
     public static void setupClass() {
+        metaData = mock(PluginMetaData.class);
+        when(metaData.getFriendlyName()).thenReturn("nice name");
+
         loaded = mock(PluginInfo.class);
         when(loaded.isLoaded()).thenReturn(true);
+        when(loaded.getMetaData()).thenReturn(metaData);
 
         unloaded = mock(PluginInfo.class);
         when(unloaded.isLoaded()).thenReturn(false);
-        when(unloaded.getNiceName()).thenReturn("nice name");
+        when(unloaded.getMetaData()).thenReturn(metaData);
 
         obj = mock(PreferencesInterface.class);
     }