Use CoreAboutDialogModel for licences.

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/about/AboutDialog.java

@@ -22,11 +22,13 @@
 
 package com.dmdirc.addons.ui_swing.dialogs.about;
 
+import com.dmdirc.ClientModule.GlobalConfig;
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.addons.ui_swing.dialogs.StandardDialog;
 import com.dmdirc.addons.ui_swing.injection.MainWindow;
 import com.dmdirc.events.ClientInfoRequestEvent;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.ui.AboutDialogModel;
 import com.dmdirc.ui.core.about.InfoItem;
 import com.dmdirc.ui.core.util.URLHandler;
@@ -52,27 +54,31 @@ public class AboutDialog extends StandardDialog {
     private final URLHandler urlHandler;
     private final AboutDialogModel model;
     private final SwingController controller;
+    private final DMDircMBassador eventBus;
+    private final AggregateConfigProvider config;
 
     @Inject
     public AboutDialog(
+            @GlobalConfig final AggregateConfigProvider config,
             @MainWindow final Window parentWindow,
             final AboutDialogModel model,
             final URLHandler urlHandler,
             final DMDircMBassador eventBus,
-            final SwingController controller,
-            final LicencesPanel licensesPanel) {
+            final SwingController controller) {
         super(parentWindow, ModalityType.MODELESS);
         this.urlHandler = urlHandler;
         this.model = model;
         this.controller = controller;
+        this.eventBus = eventBus;
+        this.config = config;
 
         eventBus.subscribe(this);
         model.load();
-        initComponents(licensesPanel);
+        initComponents();
     }
 
     /** Initialises the main UI components. */
-    private void initComponents(final LicencesPanel licensesPanel) {
+    private void initComponents() {
         final JTabbedPane tabbedPane = new JTabbedPane();
 
         setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
@@ -86,7 +92,7 @@ public class AboutDialog extends StandardDialog {
 
         tabbedPane.add("About", new AboutPanel(urlHandler, model));
         tabbedPane.add("Credits", new CreditsPanel(urlHandler, model));
-        tabbedPane.add("Licences", licensesPanel);
+        tabbedPane.add("Licences", new LicencesPanel(model, config, eventBus));
         tabbedPane.add("Information", new InfoPanel(model));
 
         getContentPane().setLayout(new MigLayout("ins rel, wrap 1, fill, "

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/about/Licence.java

@@ -1,106 +0,0 @@
-/*
- * 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.ui_swing.dialogs.about;
-
-/**
- * Simple class to describe a licence.
- */
-public class Licence {
-
-    private String name;
-    private String component;
-    private String body;
-
-    /**
-     * Instantiates a new licence with the specified attributes.
-     *
-     * @param name      Name of the licence
-     * @param component Component the licence applies to
-     * @param body      Body of the licence
-     */
-    public Licence(final String name, final String component, final String body) {
-        this.name = name;
-        this.component = component;
-        this.body = body;
-    }
-
-    /**
-     * Get the value of body.
-     *
-     * @return the value of body
-     */
-    public String getBody() {
-        return body;
-    }
-
-    /**
-     * Set the value of body.
-     *
-     * @param body new value of body
-     */
-    public void setBody(final String body) {
-        this.body = body;
-    }
-
-    /**
-     * Get the value of component.
-     *
-     * @return the value of component
-     */
-    public String getComponent() {
-        return component;
-    }
-
-    /**
-     * Set the value of component.
-     *
-     * @param component new value of component
-     */
-    public void setComponent(final String component) {
-        this.component = component;
-    }
-
-    /**
-     * Get the value of name.
-     *
-     * @return the value of name
-     */
-    public String getName() {
-        return name;
-    }
-
-    /**
-     * Set the value of name.
-     *
-     * @param name new value of name
-     */
-    public void setName(final String name) {
-        this.name = name;
-    }
-
-    @Override
-    public String toString() {
-        return getComponent();
-    }
-
-}

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/about/LicenceLoader.java

@@ -23,19 +23,12 @@
 package com.dmdirc.addons.ui_swing.dialogs.about;
 
 import com.dmdirc.DMDircMBassador;
-import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.LoggingSwingWorker;
-import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.interfaces.ui.AboutDialogModel;
+import com.dmdirc.ui.core.about.LicensedComponent;
 import com.dmdirc.util.resourcemanager.ResourceManager;
 
-import java.io.BufferedReader;
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.util.Collection;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.TreeMap;
 
 import javax.swing.JTree;
 import javax.swing.tree.DefaultMutableTreeNode;
@@ -52,117 +45,49 @@ public class LicenceLoader extends LoggingSwingWorker<Void, Void> {
 
     /** Tree to add licenses to. */
     private final JTree tree;
+    private final AboutDialogModel model;
     /** Model to load licences into. */
-    private final DefaultTreeModel model;
-    /** List of plugins to get licenses for. */
-    private final Collection<PluginInfo> plugins;
+    private final DefaultTreeModel treeModel;
 
     /**
      * Instantiates a new licence loader.
      *
-     * @param plugins  List of plugins to get licenses from
      * @param tree     Tree to add licenses to
      * @param model    Model to load licences into
      * @param eventBus The event bus to post errors to
      */
-    public LicenceLoader(final Collection<PluginInfo> plugins, final JTree tree,
-            final DefaultTreeModel model, final DMDircMBassador eventBus) {
+    public LicenceLoader(final AboutDialogModel model, final JTree tree,
+            final DefaultTreeModel treeModel, final DMDircMBassador eventBus) {
         super(eventBus);
-        this.plugins = plugins;
         this.tree = tree;
         this.model = model;
+        this.treeModel = treeModel;
     }
 
     @Override
     protected Void doInBackground() throws IOException {
         final ResourceManager rm = ResourceManager.getResourceManager();
         checkNotNull(rm, "Unable to find resource manager");
-        addCoreLicences(rm);
-        for (PluginInfo pi : plugins) {
-            addPluginLicences(pi);
-        }
+        model.getLicensedComponents().forEach(this::addLicensedComponent);
         return null;
     }
 
-    private Licence createLicence(final Entry<String, InputStream> entry) {
-        final String licenceString = entry.getKey().substring(entry.getKey().
-                lastIndexOf('/') + 1);
-        if (licenceString.length() > 1) {
-            final String[] licenceStringParts = licenceString.split(" - ");
-            return new Licence(licenceStringParts[1], licenceStringParts[0],
-                    "<html><h1>" + licenceStringParts[1] + "</h1><p>" +
-                            readInputStream(entry.getValue()).replace("\n", "<br>") +
-                            "</p></html>");
-        } else {
-            return null;
-        }
-    }
-
-    private void addCoreLicences(final ResourceManager rm) {
-        final DefaultMutableTreeNode root = new DefaultMutableTreeNode("DMDirc");
-        final Map<String, InputStream> licences = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
-        licences.putAll(rm.getResourcesStartingWithAsInputStreams("com/dmdirc/licences/"));
-        addLicensesToNode(licences, root);
-    }
-
-    private void addPluginLicences(final PluginInfo pi) throws IOException {
-        final Map<String, InputStream> licences = pi.getLicenceStreams();
-
-        if (licences.isEmpty()) {
-            return;
-        }
-
-        final DefaultMutableTreeNode root = new DefaultMutableTreeNode(pi);
-        addLicensesToNode(licences, root);
-    }
-
-    private void addLicensesToNode(final Map<String, InputStream> licences,
-            final DefaultMutableTreeNode root) {
-        UIUtilities.invokeAndWait(() -> model.insertNodeInto(root,
-                (MutableTreeNode) model.getRoot(), model.getChildCount(model.getRoot())));
-        for (Entry<String, InputStream> entry : licences.entrySet()) {
-            final Licence licence = createLicence(entry);
-            if (licence == null) {
-                continue;
-            }
-            UIUtilities.invokeAndWait(
-                    () -> model.insertNodeInto(new DefaultMutableTreeNode(licence), root,
-                            model.getChildCount(root)));
-        }
+    private void addLicensedComponent(final LicensedComponent component) {
+        final MutableTreeNode componentNode = new DefaultMutableTreeNode(component);
+        treeModel.insertNodeInto(componentNode, (MutableTreeNode) treeModel.getRoot(),
+                treeModel.getChildCount(treeModel.getRoot()));
+        component.getLicences().forEach(l -> treeModel.insertNodeInto(
+                new DefaultMutableTreeNode(l), componentNode,
+                treeModel.getChildCount(componentNode)));
     }
 
     @Override
     protected void done() {
-        model.nodeStructureChanged((TreeNode) model.getRoot());
+        treeModel.nodeStructureChanged((TreeNode) treeModel.getRoot());
         for (int i = 0; i < tree.getRowCount(); i++) {
             tree.expandRow(i);
         }
         tree.setSelectionRow(0);
         super.done();
     }
-
-    /**
-     * Converts an input stream into a string.
-     *
-     * @param stream Stream to convert
-     *
-     * @return Contents of the input stream
-     */
-    private String readInputStream(final InputStream stream) {
-        String line;
-        final StringBuilder text = new StringBuilder();
-
-        try (BufferedReader input = new BufferedReader(new InputStreamReader(stream))) {
-            line = input.readLine();
-            while (line != null) {
-                text.append(line).append('\n');
-                line = input.readLine();
-            }
-        } catch (IOException ex) {
-            //Ignore
-        }
-
-        return text.toString();
-    }
-
 }

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/about/LicenceRenderer.java

@@ -22,7 +22,8 @@
 
 package com.dmdirc.addons.ui_swing.dialogs.about;
 
-import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.ui.core.about.Licence;
+import com.dmdirc.ui.core.about.LicensedComponent;
 
 import java.awt.Color;
 import java.awt.Component;
@@ -48,9 +49,14 @@ public class LicenceRenderer extends DefaultTreeCellRenderer {
                 value, sel, expanded, leaf, row, hasFocus);
         label.setIcon(null);
         label.setOpaque(false);
-        if (((DefaultMutableTreeNode) value).getUserObject() instanceof PluginInfo) {
-            setText(((PluginInfo) ((DefaultMutableTreeNode) value)
-                    .getUserObject()).getMetaData().getFriendlyName());
+        final DefaultMutableTreeNode node = (DefaultMutableTreeNode) value;
+        final Object nodeValue = node.getUserObject();
+        if (nodeValue instanceof Licence) {
+            setText(((Licence) nodeValue).getComponent());
+        } else if (nodeValue instanceof LicensedComponent) {
+            setText(((LicensedComponent) nodeValue).getName());
+        } else {
+            setText(value.toString());
         }
         return label;
     }

ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/about/LicencesPanel.java

@@ -22,18 +22,20 @@
 
 package com.dmdirc.addons.ui_swing.dialogs.about;
 
-import com.dmdirc.ClientModule.GlobalConfig;
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.components.TreeScroller;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
-import com.dmdirc.plugins.PluginInfo;
-import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.interfaces.ui.AboutDialogModel;
+import com.dmdirc.ui.core.about.Licence;
+import com.dmdirc.ui.core.about.LicensedComponent;
+
+import com.google.common.base.Joiner;
+import com.google.common.base.Splitter;
 
 import java.awt.Font;
 import java.awt.Rectangle;
 
-import javax.inject.Inject;
 import javax.swing.BorderFactory;
 import javax.swing.JEditorPane;
 import javax.swing.JPanel;
@@ -69,20 +71,12 @@ public class LicencesPanel extends JPanel implements TreeSelectionListener {
     /** Licence list. */
     private JTree list;
 
-    /**
-     * Creates a new instance of LicencesPanel.
-     *
-     * @param globalConfig  The config to read settings from.
-     * @param pluginManager The manager to use to find plugins (to display their licenses).
-     * @param eventBus      The event bus to post errors to.
-     */
-    @Inject
-    public LicencesPanel(
-            @GlobalConfig final AggregateConfigProvider globalConfig,
-            final PluginManager pluginManager, final DMDircMBassador eventBus) {
+    public LicencesPanel(final AboutDialogModel model,
+            final AggregateConfigProvider globalConfig,
+            final DMDircMBassador eventBus) {
         config = globalConfig;
         initComponents();
-        new LicenceLoader(pluginManager.getPluginInfos(), list, listModel, eventBus).execute();
+        new LicenceLoader(model, list, listModel, eventBus).execute();
         addListeners();
         layoutComponents();
     }
@@ -148,16 +142,15 @@ public class LicencesPanel extends JPanel implements TreeSelectionListener {
         final Object userObject = ((DefaultMutableTreeNode) e.getPath().
                 getLastPathComponent()).getUserObject();
         if (userObject instanceof Licence) {
-            licence.setText(((Licence) userObject).getBody());
-        } else if (userObject instanceof PluginInfo) {
-            final PluginInfo pi = (PluginInfo) userObject;
+            licence.setText(
+                    "<h3 style='margin: 3px; padding: 0px 0px 5px 0px;'>"
+                            + ((Licence) userObject).getName() + "</h3>"
+                            + Joiner.on("<br>").join(
+                            Splitter.on('\n').split(((Licence) userObject).getBody())));
+        } else if (userObject instanceof LicensedComponent) {
+            final LicensedComponent lc = (LicensedComponent) userObject;
             licence.setText("<b>Name:</b> "
-                    + pi.getMetaData().getFriendlyName() + "<br>"
-                    + "<b>Version:</b> "
-                    + pi.getMetaData().getFriendlyVersion() + "<br>"
-                    + "<b>Author:</b> " + pi.getMetaData().getAuthor() + "<br>"
-                    + "<b>Description:</b> "
-                    + pi.getMetaData().getDescription() + "<br>");
+                    + lc.getName() + "<br>");
         } else {
             licence.setText("<b>Name:</b> DMDirc<br>"
                     + "<b>Version:</b> " + config