Changeset 14384 in josm for trunk/src

Timestamp:

2018-10-29T22:24:29+01:00 (5 years ago)

Author:

Don-vip

Message:

see #16912 - introduce native and virtual plugins using new Plugin-Platform and Plugin-Provides manifest entries

Use case: javafx-windows, javafx-osx and javafx-unixoid are three native plugins providing the virtual javafx plugin on which other plugins can depend

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/preferences/plugin/PluginCheckBox.java (modified) (1 diff)
• gui/preferences/plugin/PluginPreferencesModel.java (modified) (1 diff)
• plugins/PluginHandler.java (modified) (3 diffs)
• plugins/PluginInformation.java (modified) (6 diffs)
• plugins/ReadLocalPluginInformationTask.java (modified) (2 diffs)
• plugins/ReadRemotePluginInformationTask.java (modified) (3 diffs)

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

@@ -63 +63 @@
                 if (!p.equals(pi) && p.requires != null && ppModel.isSelectedPlugin(p.getName())) {
                     for (String s : p.getRequiredPlugins()) {
-                        if (s.equals(pi.getName())) {
+                        if (s.equals(pi.getName()) || s.equals(pi.provides)) {
                             otherPlugins.add(p.getName());
                             break;

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

@@ -237 +237 @@
      */
     public PluginInformation getPluginInformation(String name) {
-        for (PluginInformation pi: availablePlugins) {
-            if (pi.getName() != null && pi.getName().equals(name))
-                return pi;
+        if (name != null) {
+            for (PluginInformation pi: availablePlugins) {
+                if (name.equals(pi.getName()) || name.equals(pi.provides))
+                    return pi;
+            }
         }
         return null;

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

@@ -607 +607 @@
     }
 
+    private static void logWrongPlatform(String plugin, String pluginPlatform) {
+        Logging.warn(
+                tr("Plugin {0} must be run on a {1} platform.",
+                        plugin, pluginPlatform
+                ));
+    }
+
     private static void logJavaUpdateRequired(String plugin, int requiredVersion) {
         Logging.warn(
@@ -640 +647 @@
     public static boolean checkLoadPreconditions(Component parent, Collection<PluginInformation> plugins, PluginInformation plugin) {
 
+        // make sure the plugin is not meant for another platform
+        if (!plugin.isForCurrentPlatform()) {
+            // Just log a warning, this is unlikely to happen as we display only relevant plugins in HMI
+            logWrongPlatform(plugin.name, plugin.platform);
+            return false;
+        }
+
         // make sure the plugin is compatible with the current Java version
         if (plugin.localminjavaversion > Utils.getJavaVersion()) {
-            // Just log a warning until we switch to Java 11 so that openjfx plugin does not trigger a popup
+            // Just log a warning until we switch to Java 11 so that javafx plugin does not trigger a popup
             logJavaUpdateRequired(plugin.name, plugin.localminjavaversion);
             return false;
@@ -686 +700 @@
             for (PluginInformation pi: plugins) {
                 pluginNames.add(pi.name);
+                if (pi.provides != null) {
+                    pluginNames.add(pi.provides);
+                }
             }
             Set<String> missingPlugins = new HashSet<>();

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

@@ -31 +31 @@
 import org.openstreetmap.josm.tools.LanguageInfo;
 import org.openstreetmap.josm.tools.Logging;
+import org.openstreetmap.josm.tools.Platform;
+import org.openstreetmap.josm.tools.PlatformManager;
 import org.openstreetmap.josm.tools.Utils;
 
@@ -62 +64 @@
     /** The list of required plugins, separated by ';' (from locally available jar). */
     public String localrequires;
+    /** The plugin platform on which it is meant to run (windows, osx, unixoid). */
+    public String platform;
+    /** The virtual plugin provided by this plugin, if native for a given platform. */
+    public String provides;
     /** The plugin link (for documentation). */
     public String link;
@@ -169 +175 @@
         this.className = other.className;
         this.requires = other.requires;
+        this.provides = other.provides;
+        this.platform = other.platform;
         this.link = other.link;
         this.description = other.description;
@@ -216 +224 @@
         }
         link = s;
+        platform = attr.getValue("Plugin-Platform");
+        provides = attr.getValue("Plugin-Provides");
         requires = attr.getValue("Plugin-Requires");
         s = attr.getValue(lang+"Plugin-Description");
@@ -422 +432 @@
         Collection<String> locations = getPluginLocations();
 
+        String[] nameCandidates = new String[] {
+                pluginName,
+                pluginName + "-" + PlatformManager.getPlatform().getPlatform().name().toLowerCase(Locale.ENGLISH)};
         for (String s : locations) {
-            File pluginFile = new File(s, pluginName + ".jar");
-            if (pluginFile.exists()) {
-                return new PluginInformation(pluginFile);
+            for (String nameCandidate: nameCandidates) {
+                File pluginFile = new File(s, nameCandidate + ".jar");
+                if (pluginFile.exists()) {
+                    return new PluginInformation(pluginFile);
+                }
             }
         }
@@ -579 +594 @@
         }
     }
+
+    /**
+     * Determines if this plugin can be run on the current platform.
+     * @return {@code true} if this plugin can be run on the current platform
+     * @since 14384
+     */
+    public boolean isForCurrentPlatform() {
+        try {
+            return platform == null || PlatformManager.getPlatform().getPlatform() == Platform.valueOf(platform.toUpperCase(Locale.ENGLISH));
+        } catch (IllegalArgumentException e) {
+            Logging.warn(e);
+            return true;
+        }
+    }
 }

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

@@ -190 +190 @@
     }
 
+    protected void filterIrrelevantPlugins() {
+        availablePlugins.entrySet().removeIf(e -> !e.getValue().isForCurrentPlatform());
+    }
+
     @Override
     protected void realRun() throws SAXException, IOException, OsmTransferException {
@@ -207 +211 @@
         if (canceled) return;
         filterOldPlugins();
+        filterIrrelevantPlugins();
         getProgressMonitor().worked(1);
     }

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

@@ -25 +25 @@
 import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import javax.swing.JLabel;
@@ -283 +284 @@
     }
 
+    protected List<PluginInformation> filterIrrelevantPlugins(List<PluginInformation> plugins) {
+        return plugins.stream().filter(PluginInformation::isForCurrentPlatform).collect(Collectors.toList());
+    }
+
     /**
      * Parses the plugin list
@@ -294 +299 @@
             InputStream in = new ByteArrayInputStream(doc.getBytes(StandardCharsets.UTF_8));
             List<PluginInformation> pis = new PluginListParser().parse(in);
-            availablePlugins.addAll(filterDeprecatedPlugins(pis));
+            availablePlugins.addAll(filterIrrelevantPlugins(filterDeprecatedPlugins(pis)));
         } catch (PluginListParseException e) {
             Logging.error(tr("Failed to parse plugin list document from site ''{0}''. Skipping site. Exception was: {1}", site, e.toString()));