Changeset 8471 in josm for trunk/src/org

Timestamp:

2015-06-07T02:38:12+02:00 (9 years ago)

Author:

Don-vip

Message:

offer to automatically download missing required plugins and restart. i18n impact, but this needs to be done before releasing the new tested because of the new dependence on commons-imaging, to avoid future bug reports.

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/RestartAction.java (modified) (1 diff)
• data/Preferences.java (modified) (2 diffs)
• gui/preferences/plugin/PluginPreference.java (modified) (7 diffs)
• plugins/PluginHandler.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/actions/RestartAction.java

@@ -21 +21 @@
  * Restarts JOSM as it was launched. Comes from "restart" plugin, originally written by Upliner.
  * <br><br>
- * Mechanisms have been improved based on #8561 discussions and <a href="http://lewisleo.blogspot.jp/2012/08/programmatically-restart-java.html">this article</a>.
+ * Mechanisms have been improved based on #8561 discussions and
+ * <a href="http://lewisleo.blogspot.jp/2012/08/programmatically-restart-java.html">this article</a>.
  * @since 5857
  */

trunk/src/org/openstreetmap/josm/data/Preferences.java

@@ -62 +62 @@
 import org.openstreetmap.josm.data.preferences.ColorProperty;
 import org.openstreetmap.josm.io.CachedFile;
+import org.openstreetmap.josm.io.OfflineAccessException;
+import org.openstreetmap.josm.io.OnlineResource;
 import org.openstreetmap.josm.io.XmlWriter;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
@@ -1449 +1451 @@
      * Replies the collection of plugin site URLs from where plugin lists can be downloaded.
      * @return the collection of plugin site URLs
+     * @see #getOnlinePluginSites
      */
     public Collection<String> getPluginSites() {
         return getCollection("pluginmanager.sites", Collections.singleton(Main.getJOSMWebsite()+"/pluginicons%<?plugins=>"));
+    }
+
+    /**
+     * Returns the list of plugin sites available according to offline mode settings.
+     * @return the list of available plugin sites
+     * @since 8471
+     */
+    public Collection<String> getOnlinePluginSites() {
+        Collection<String> pluginSites = new ArrayList<>(getPluginSites());
+        for (Iterator<String> it = pluginSites.iterator(); it.hasNext();) {
+            try {
+                OnlineResource.JOSM_WEBSITE.checkOfflineAccess(it.next(), Main.getJOSMWebsite());
+            } catch (OfflineAccessException ex) {
+                Main.warn(ex, false);
+                it.remove();
+            }
+        }
+        return pluginSites;
     }
 

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

@@ -50 +50 @@
 import org.openstreetmap.josm.gui.widgets.JosmTextField;
 import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
-import org.openstreetmap.josm.io.OfflineAccessException;
-import org.openstreetmap.josm.io.OnlineResource;
 import org.openstreetmap.josm.plugins.PluginDownloadTask;
 import org.openstreetmap.josm.plugins.PluginInformation;
@@ -121 +119 @@
      * @param parent The parent component
      * @param task The finished plugin download task
+     * @param restartRequired true if a restart is required
      * @since 6797
      */
@@ -321 +320 @@
     }
 
-    private static Collection<String> getOnlinePluginSites() {
-        Collection<String> pluginSites = new ArrayList<>(Main.pref.getPluginSites());
-        for (Iterator<String> it = pluginSites.iterator(); it.hasNext();) {
-            try {
-                OnlineResource.JOSM_WEBSITE.checkOfflineAccess(it.next(), Main.getJOSMWebsite());
-            } catch (OfflineAccessException ex) {
-                Main.warn(ex.getMessage());
-                it.remove();
-            }
-        }
-        return pluginSites;
-    }
-
     /**
      * The action for downloading the list of available plugins
@@ -339 +325 @@
     class DownloadAvailablePluginsAction extends AbstractAction {
 
+        /**
+         * Constructs a new {@code DownloadAvailablePluginsAction}.
+         */
         public DownloadAvailablePluginsAction() {
             putValue(NAME,tr("Download list"));
@@ -347 +336 @@
         @Override
         public void actionPerformed(ActionEvent e) {
-            Collection<String> pluginSites = getOnlinePluginSites();
+            Collection<String> pluginSites = Main.pref.getOnlinePluginSites();
             if (pluginSites.isEmpty()) {
                 return;
@@ -369 +358 @@
             Main.worker.submit(continuation);
         }
-
     }
 
@@ -411 +399 @@
                     );
             // the async task for downloading plugin information
-            final ReadRemotePluginInformationTask pluginInfoDownloadTask = new ReadRemotePluginInformationTask(getOnlinePluginSites());
+            final ReadRemotePluginInformationTask pluginInfoDownloadTask = new ReadRemotePluginInformationTask(
+                    Main.pref.getOnlinePluginSites());
 
             // to be run asynchronously after the plugin download

trunk/src/org/openstreetmap/josm/plugins/PluginHandler.java

@@ -53 +53 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.actions.RestartAction;
 import org.openstreetmap.josm.data.Version;
 import org.openstreetmap.josm.gui.HelpAwareOptionPane;
@@ -464 +465 @@
 
     /**
-     * Alerts the user if a plugin required by another plugin is missing
+     * Alerts the user if a plugin required by another plugin is missing, and offer to download them & restart JOSM
      *
      * @param parent The parent Component used to display error popup
@@ -471 +472 @@
      */
     private static void alertMissingRequiredPlugin(Component parent, String plugin, Set<String> missingRequiredPlugin) {
-        StringBuilder sb = new StringBuilder();
+        StringBuilder sb = new StringBuilder(48);
         sb.append("<html>")
           .append(trn("Plugin {0} requires a plugin which was not found. The missing plugin is:",
@@ -480 +481 @@
           .append(Utils.joinAsHtmlUnorderedList(missingRequiredPlugin))
           .append("</html>");
-        JOptionPane.showMessageDialog(
+        ButtonSpec[] specs = new ButtonSpec[] {
+                new ButtonSpec(
+                        tr("Download and restart"),
+                        ImageProvider.get("restart"),
+                        trn("Click to download missing plugin and restart JOSM",
+                            "Click to download missing plugins and restart JOSM",
+                            missingRequiredPlugin.size()),
+                        null /* no specific help text */
+                ),
+                new ButtonSpec(
+                        tr("Continue"),
+                        ImageProvider.get("ok"),
+                        trn("Click to continue without this plugin",
+                            "Click to continue without these plugins",
+                            missingRequiredPlugin.size()),
+                        null /* no specific help text */
+                )
+        };
+        if (0 == HelpAwareOptionPane.showOptionDialog(
                 parent,
                 sb.toString(),
                 tr("Error"),
-                JOptionPane.ERROR_MESSAGE
-        );
+                JOptionPane.ERROR_MESSAGE,
+                null, /* no special icon */
+                specs,
+                specs[0],
+                HelpUtil.ht("/Plugin/Loading#MissingRequiredPlugin"))) {
+            downloadRequiredPluginsAndRestart(parent, missingRequiredPlugin);
+        }
+    }
+
+    private static void downloadRequiredPluginsAndRestart(final Component parent, final Set<String> missingRequiredPlugin) {
+        // Update plugin list
+        final ReadRemotePluginInformationTask pluginInfoDownloadTask = new ReadRemotePluginInformationTask(
+                Main.pref.getOnlinePluginSites());
+        Main.worker.submit(pluginInfoDownloadTask);
+
+        // Continuation
+        Main.worker.submit(new Runnable() {
+            @Override
+            public void run() {
+                // Build list of plugins to download
+                Set<PluginInformation> toDownload = new HashSet<>(pluginInfoDownloadTask.getAvailablePlugins());
+                for (Iterator<PluginInformation> it = toDownload.iterator(); it.hasNext();) {
+                    PluginInformation info = it.next();
+                    if (!missingRequiredPlugin.contains(info.getName())) {
+                        it.remove();
+                    }
+                }
+                // Check if something has still to be downloaded
+                if (!toDownload.isEmpty()) {
+                    // download plugins
+                    final PluginDownloadTask task = new PluginDownloadTask(parent, toDownload, tr("Download plugins"));
+                    Main.worker.submit(task);
+                    Main.worker.submit(new Runnable() {
+                        @Override
+                        public void run() {
+                            // restart if some plugins have been downloaded
+                            if (!task.getDownloadedPlugins().isEmpty()) {
+                                // update plugin list in preferences
+                                Set<String> plugins = new HashSet<>(Main.pref.getCollection("plugins"));
+                                for (PluginInformation plugin : task.getDownloadedPlugins()) {
+                                    plugins.add(plugin.name);
+                                }
+                                Main.pref.putCollection("plugins", plugins);
+                                // restart
+                                new RestartAction().actionPerformed(null);
+                            } else {
+                                Main.warn("No plugin downloaded, restart canceled");
+                            }
+                        }
+                    });
+                } else {
+                    Main.warn("No plugin to download, operation canceled");
+                }
+            }
+        });
     }
 
@@ -645 +717 @@
 
     /**
-     * Loads the plugin in <code>plugins</code> from locally available jar files into
-     * memory.
+     * Loads the plugin in <code>plugins</code> from locally available jar files into memory.
      *
      * @param parent The parent component to be used for the displayed dialog
@@ -905 +976 @@
             ReadRemotePluginInformationTask task1 = new ReadRemotePluginInformationTask(
                     monitor.createSubTaskMonitor(1, false),
-                    Main.pref.getPluginSites(), displayErrMsg
+                    Main.pref.getOnlinePluginSites(), displayErrMsg
             );
             Future<?> future = service.submit(task1);
@@ -1246 +1317 @@
         PluginProxy err = null;
         StackTraceElement[] stack = ex.getStackTrace();
-        /* remember the error position, as multiple plugins may be involved,
-           we search the topmost one */
+        // remember the error position, as multiple plugins may be involved, we search the topmost one
         int pos = stack.length;
         for (PluginProxy p : pluginList) {