Changeset 277 in josm

Timestamp:

2007-07-06T00:38:51+02:00 (17 years ago)

Author:

imi

Message:

• added Plugin Manager to download new plugins from within JOSM

Location:

src/org/openstreetmap/josm

Files:

• gui/preferences/PluginPreference.java (modified) (2 diffs)
• plugins/PluginDownloader.java (added)
• plugins/PluginInformation.java (modified) (3 diffs)
• tools/XmlObjectParser.java (modified) (1 diff)

src/org/openstreetmap/josm/gui/preferences/PluginPreference.java

@@ -2 +2 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
-
+import static org.openstreetmap.josm.tools.I18n.trn;
+
+import java.awt.Dimension;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.io.File;
+import java.io.FileReader;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.LinkedList;
-import java.util.List;
 import java.util.Map;
+import java.util.SortedMap;
+import java.util.TreeMap;
 import java.util.Map.Entry;
 
 import javax.swing.BorderFactory;
 import javax.swing.Box;
+import javax.swing.JButton;
 import javax.swing.JCheckBox;
 import javax.swing.JLabel;
+import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.plugins.PluginDownloader;
 import org.openstreetmap.josm.plugins.PluginException;
 import org.openstreetmap.josm.plugins.PluginInformation;
+import org.openstreetmap.josm.plugins.PluginProxy;
 import org.openstreetmap.josm.tools.GBC;
-import org.openstreetmap.josm.tools.UrlLabel;
+import org.openstreetmap.josm.tools.XmlObjectParser.Uniform;
 
 public class PluginPreference implements PreferenceSetting {
 
-        private Map<PluginInformation, Boolean> pluginMap;
+        /**
+         * Only the plugin name, it's jar location and the description.
+         * In other words, this is the minimal requirement the plugin preference page
+         * needs to show the plugin as available
+         * 
+         * @author imi
+         */
+        public static class PluginDescription {
+                public String name;
+                public String description;
+                public String resource;
+                public PluginDescription(String name, String description, String resource) {
+                        this.name = name;
+                        this.description = description;
+                        this.resource = resource;
+        }
+                public PluginDescription() {
+        }
+        }
+        
+        private Map<PluginDescription, Boolean> pluginMap;
+        private Box pluginPanel = Box.createVerticalBox();
+        private JPanel plugin;
 
         public void addGui(final PreferenceDialog gui) {
-                pluginMap = new HashMap<PluginInformation, Boolean>();
-                Box pluginPanel = Box.createVerticalBox();
-                List<PluginInformation> availablePlugins = new LinkedList<PluginInformation>();
-                for (String location : PluginInformation.getPluginLocations()) {
-                        File[] pluginFiles = new File(location).listFiles();
-                        if (pluginFiles != null) {
-                                Arrays.sort(pluginFiles);
-                                for (File f : pluginFiles) {
-                                        if (f.isFile() && f.getName().endsWith(".jar")) {
-                                                try {
-                                    availablePlugins.add(new PluginInformation(f));
-                            } catch (PluginException x) {
-                            }
-                                        }
-                                }
-                        }
-                }
-                Collections.sort(availablePlugins, new Comparator<PluginInformation>(){
-                        public int compare(PluginInformation o1, PluginInformation o2) {
-                    return o1.name.compareTo(o2.name);
-            }
-                });
-
+                plugin = gui.createPreferenceTab("plugin", tr("Plugins"), tr("Configure available Plugins."));
+                JScrollPane pluginPane = new JScrollPane(pluginPanel, JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED, JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
+                pluginPane.setBorder(null);
+                plugin.add(pluginPane, GBC.eol().fill(GBC.BOTH));
+                plugin.add(GBC.glue(0,10), GBC.eol());
+                JButton morePlugins = new JButton(tr("Get more plugins"));
+                morePlugins.addActionListener(new ActionListener(){
+                        public void actionPerformed(ActionEvent e) {
+                                int count = PluginDownloader.downloadDescription();
+                        if (count > 0)
+                                JOptionPane.showMessageDialog(Main.parent,
+                                                trn("Downloaded plugin information from {0} site",
+                                                                "Downloaded plugin information from {0} sites", count, count));
+                        else
+                                JOptionPane.showMessageDialog(Main.parent, tr("No plugin information found."));
+                        refreshPluginPanel(gui);
+            }
+                });
+                plugin.add(morePlugins, GBC.std().insets(0,0,10,0));
+                
+                JButton update = new JButton(tr("Update current"));
+                update.addActionListener(new ActionListener(){
+                        public void actionPerformed(ActionEvent e) {
+                                JOptionPane.showMessageDialog(Main.parent, tr("Not implemented yet."));
+            }
+                });
+                plugin.add(update, GBC.std().insets(0,0,10,0));
+
+                JButton configureSites = new JButton(tr("Configure Plugin Sites"));
+                configureSites.addActionListener(new ActionListener(){
+                        public void actionPerformed(ActionEvent e) {
+                                JOptionPane.showMessageDialog(Main.parent, tr("Not implemented yet."));
+            }
+                });
+                plugin.add(configureSites, GBC.std());
+
+                refreshPluginPanel(gui);
+        }
+
+        private void refreshPluginPanel(final PreferenceDialog gui) {
+            Collection<PluginDescription> availablePlugins = getAvailablePlugins();
+            pluginMap = new HashMap<PluginDescription, Boolean>();
+            pluginPanel.removeAll();
                 Collection<String> enabledPlugins = Arrays.asList(Main.pref.get("plugins").split(","));
-                for (final PluginInformation plugin : availablePlugins) {
+                for (final PluginDescription plugin : availablePlugins) {
                         boolean enabled = enabledPlugins.contains(plugin.name);
                         final JCheckBox pluginCheck = new JCheckBox(plugin.name, enabled);
                         pluginPanel.add(pluginCheck);
 
-                        pluginCheck.setToolTipText(plugin.file != null ? plugin.file.getAbsolutePath() : tr("Plugin bundled with JOSM"));
+                        pluginCheck.setToolTipText(plugin.resource != null ? plugin.resource : tr("Plugin bundled with JOSM"));
                         JLabel label = new JLabel("<html><i>"+(plugin.description==null?"no description available":plugin.description)+"</i></html>");
                         label.setBorder(BorderFactory.createEmptyBorder(0,20,0,0));
+                        label.setMaximumSize(new Dimension(450,1000));
                         pluginPanel.add(label);
                         pluginPanel.add(Box.createVerticalStrut(5));
@@ -77 +127 @@
                         });
                 }
-                JScrollPane pluginPane = new JScrollPane(pluginPanel, JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED, JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
-                pluginPane.setBorder(null);
-
-                JPanel plugin = gui.createPreferenceTab("plugin", tr("Plugins"), tr("Configure available Plugins."));
-                plugin.add(pluginPane, GBC.eol().fill(GBC.BOTH));
-                plugin.add(GBC.glue(0,10), GBC.eol());
-                plugin.add(new UrlLabel("http://josm.eigenheimstrasse.de/wiki/Plugins", tr("Get more plugins")), GBC.std().fill(GBC.HORIZONTAL));
-        }
+                plugin.updateUI();
+    }
+
+        private Collection<PluginDescription> getAvailablePlugins() {
+                SortedMap<String, PluginDescription> availablePlugins = new TreeMap<String, PluginDescription>(new Comparator<String>(){
+                        public int compare(String o1, String o2) {
+                    return o1.compareToIgnoreCase(o2);
+            }
+                });
+                for (String location : PluginInformation.getPluginLocations()) {
+                        File[] pluginFiles = new File(location).listFiles();
+                        if (pluginFiles != null) {
+                                for (File f : pluginFiles) {
+                                        if (!f.isFile())
+                                                continue;
+                                        if (f.getName().endsWith(".jar")) {
+                                                try {
+                                                        PluginInformation info = new PluginInformation(f);
+                                    availablePlugins.put(info.name, new PluginDescription(info.name, info.description, PluginInformation.getURLString(f.getPath())));
+                            } catch (PluginException x) {
+                            }
+                                        } else if (f.getName().endsWith(".xml")) {
+                                                try {
+                                Uniform<PluginDescription> parser = new Uniform<PluginDescription>(new FileReader(f), "plugin", PluginDescription.class);
+                                for (PluginDescription pd : parser)
+                                        availablePlugins.put(pd.name, pd);
+                        } catch (Exception e) {
+                                e.printStackTrace();
+                                JOptionPane.showMessageDialog(Main.parent, tr("Error reading plugin information file: {0}", f.getName()));
+                        }
+                                        }
+                                }
+                        }
+                }
+                for (PluginProxy proxy : Main.plugins)
+                        if (!availablePlugins.containsKey(proxy.info.name))
+                                availablePlugins.put(proxy.info.name, new PluginDescription(
+                                                proxy.info.name, 
+                                                proxy.info.description, 
+                                                PluginInformation.getURLString(proxy.info.file.getPath())));
+            return availablePlugins.values();
+    }
 
         public void ok() {
+                Collection<PluginDescription> toDownload = new LinkedList<PluginDescription>();
+                String msg = "";
+                for (Entry<PluginDescription, Boolean> entry : pluginMap.entrySet()) {
+                        if (entry.getValue() && PluginInformation.findPlugin(entry.getKey().name) == null) {
+                                toDownload.add(entry.getKey());
+                                msg += entry.getKey().name+"\n";
+                        }
+                }
+                if (!toDownload.isEmpty()) {
+                        int answer = JOptionPane.showConfirmDialog(Main.parent, 
+                                        tr("Download the following plugins?\n\n{0}", msg), 
+                                        tr("Download missing plugins"),
+                                        JOptionPane.YES_NO_OPTION);
+                        if (answer != JOptionPane.OK_OPTION)
+                                for (PluginDescription pd : toDownload)
+                                        pluginMap.put(pd, false);
+                        else
+                                for (PluginDescription pd : toDownload)
+                                        PluginDownloader.downloadPlugin(pd);
+                }
+
                 String plugins = "";
-                for (Entry<PluginInformation, Boolean> entry : pluginMap.entrySet())
-                        if (entry.getValue())
+                for (Entry<PluginDescription, Boolean> entry : pluginMap.entrySet()) {
+                        if (entry.getValue()) {
                                 plugins += entry.getKey().name + ",";
+                                if (PluginInformation.findPlugin(entry.getKey().name) == null)
+                                        toDownload.add(entry.getKey());
+                        }
+                }
                 if (plugins.endsWith(","))
                         plugins = plugins.substring(0, plugins.length()-1);

src/org/openstreetmap/josm/plugins/PluginInformation.java

@@ -32 +32 @@
         public final String author;
         public final int stage;
+        public final String version;
         public final List<URL> libraries = new ArrayList<URL>();
 
@@ -64 +65 @@
                         String stageStr = attr.getValue("Plugin-Stage");
                         stage = stageStr == null ? 50 : Integer.parseInt(stageStr);
+                        version = attr.getValue("Plugin-Version");
                         author = attr.getValue("Author");
                         if (file != null)
@@ -118 +120 @@
         }
 
-        private String getURLString(String fileName) {
+        public static String getURLString(String fileName) {
                 if (System.getProperty("os.name").startsWith("Windows"))
                         return "file:/"+fileName;

src/org/openstreetmap/josm/tools/XmlObjectParser.java

@@ -66 +66 @@
                         if (mapping.containsKey(qname) && !mapping.get(qname).onStart)
                                 report();
-                        else if (characters != null && !current.isEmpty())
+                        else if (characters != null && !current.isEmpty()) {
                                 setValue(qname, characters);
+                                characters = "";
+                        }
                 }
                 @Override public void characters(char[] ch, int start, int length) {