Changeset 17679 in josm

Timestamp:

2021-03-28T14:58:23+02:00 (4 years ago)

Author:

Don-vip

Message:

see #17858 - ask Oracle Java WebStart users to switch to OpenWebStart

Rocket icon from ​https://github.com/twitter/twemoji/blob/v13.0.2/assets/svg/1f680.svg

Location:

trunk

Files:

• resources/images/presets/transport/rocket.svg (added)
• src/org/openstreetmap/josm/actions/ShowStatusReportAction.java (modified) (1 diff)
• src/org/openstreetmap/josm/gui/MainApplication.java (modified) (2 diffs)
• src/org/openstreetmap/josm/gui/MainInitialization.java (modified) (1 diff)
• src/org/openstreetmap/josm/tools/PlatformHook.java (modified) (3 diffs)
• src/org/openstreetmap/josm/tools/PlatformHookOsx.java (modified) (2 diffs)
• src/org/openstreetmap/josm/tools/PlatformHookUnixoid.java (modified) (1 diff)
• src/org/openstreetmap/josm/tools/PlatformHookWindows.java (modified) (1 diff)
• src/org/openstreetmap/josm/tools/Utils.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/tools/PlatformHookOsxTest.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/tools/PlatformHookWindowsTest.java (modified) (1 diff)

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

@@ -139 +139 @@
             }
             // Add WebStart package details if run from JNLP
-            if (Utils.isRunningJavaWebStart()) {
+            if (Utils.isRunningWebStart()) {
                 String webStartDetails = platform.getWebStartPackageDetails();
                 if (webStartDetails != null) {

trunk/src/org/openstreetmap/josm/gui/MainApplication.java

@@ -342 +342 @@
     }
 
-    /**
-     * Asks user to update its version of Java.
-     * @param updVersion target update version
-     * @param url download URL
-     * @param major true for a migration towards a major version of Java (8:9), false otherwise
-     * @param eolDate the EOL/expiration date
-     * @since 12270
-     */
-    public static void askUpdateJava(String updVersion, String url, String eolDate, boolean major) {
-        ExtendedDialog ed = new ExtendedDialog(
-                mainFrame,
-                tr("Outdated Java version"),
-                tr("OK"), tr("Update Java"), tr("Cancel"));
+    private static void askUpdate(String title, String update, String property, String icon, StringBuilder content, String url) {
+        ExtendedDialog ed = new ExtendedDialog(mainFrame, title, tr("OK"), update, tr("Cancel"));
         // Check if the dialog has not already been permanently hidden by user
-        if (!ed.toggleEnable("askUpdateJava"+updVersion).toggleCheckState()) {
-            ed.setButtonIcons("ok", "java", "cancel").setCancelButton(3);
+        if (!ed.toggleEnable(property).toggleCheckState()) {
+            ed.setButtonIcons("ok", icon, "cancel").setCancelButton(3);
             ed.setMinimumSize(new Dimension(480, 300));
             ed.setIcon(JOptionPane.WARNING_MESSAGE);
-            StringBuilder content = new StringBuilder(tr("You are running version {0} of Java.",
-                    "<b>"+getSystemProperty("java.version")+"</b>")).append("<br><br>");
-            if ("Sun Microsystems Inc.".equals(getSystemProperty("java.vendor")) && !PlatformManager.getPlatform().isOpenJDK()) {
-                content.append("<b>").append(tr("This version is no longer supported by {0} since {1} and is not recommended for use.",
-                        "Oracle", eolDate)).append("</b><br><br>");
-            }
-            content.append("<b>")
-                   .append(major ?
-                        tr("JOSM will soon stop working with this version; we highly recommend you to update to Java {0}.", updVersion) :
-                        tr("You may face critical Java bugs; we highly recommend you to update to Java {0}.", updVersion))
-                   .append("</b><br><br>")
-                   .append(tr("Would you like to update now ?"));
             ed.setContent(content.toString());
 
@@ -382 +359 @@
             }
         }
+    }
+
+    /**
+     * Asks user to update its version of Java.
+     * @param updVersion target update version
+     * @param url download URL
+     * @param major true for a migration towards a major version of Java (8:11), false otherwise
+     * @param eolDate the EOL/expiration date
+     * @since 12270
+     */
+    public static void askUpdateJava(String updVersion, String url, String eolDate, boolean major) {
+        StringBuilder content = new StringBuilder(tr("You are running version {0} of Java.",
+                "<b>"+getSystemProperty("java.version")+"</b>")).append("<br><br>");
+        if ("Sun Microsystems Inc.".equals(getSystemProperty("java.vendor")) && !PlatformManager.getPlatform().isOpenJDK()) {
+            content.append("<b>").append(tr("This version is no longer supported by {0} since {1} and is not recommended for use.",
+                    "Oracle", eolDate)).append("</b><br><br>");
+        }
+        content.append("<b>")
+               .append(major ?
+                    tr("JOSM will soon stop working with this version; we highly recommend you to update to Java {0}.", updVersion) :
+                    tr("You may face critical Java bugs; we highly recommend you to update to Java {0}.", updVersion))
+               .append("</b><br><br>")
+               .append(tr("Would you like to update now ?"));
+        askUpdate(tr("Outdated Java version"), tr("Update Java"), "askUpdateJava"+updVersion, "java", content, url);
+    }
+
+    /**
+     * Asks user to migrate to OpenWebStart
+     * @param url download URL
+     * @since 17679
+     */
+    public static void askMigrateWebStart(String url) {
+        // CHECKSTYLE.OFF: LineLength
+        StringBuilder content = new StringBuilder(tr("You are running an <b>Oracle</b> implementation of Java WebStart."))
+                .append("<br><br>")
+                .append(tr("It was for years the recommended way to use JOSM. Oracle removed WebStart from Java 11,<br>but the open source community reimplemented the Java Web Start technology as a new product: <b>OpenWebStart</b>"))
+                .append("<br><br>")
+                .append(tr("OpenWebStart is now considered mature enough by JOSM developers to ask everyone to move away from an Oracle implementation,<br>allowing you to benefit from a recent version of Java, and allowing JOSM developers to move forward by planning the Java {0} migration.", "11"))
+                .append("<br><br>")
+                .append(tr("Would you like to <b>download OpenWebStart now</b>? (Please do!)"));
+        askUpdate(tr("Outdated Java WebStart version"), tr("Update to OpenWebStart"), "askUpdateWebStart", "presets/transport/rocket", content, url);
+        // CHECKSTYLE.ON: LineLength
     }
 

trunk/src/org/openstreetmap/josm/gui/MainInitialization.java

@@ -72 +72 @@
             new InitializationTask(tr("Starting file watcher"), FileWatcher.getDefaultInstance()::start),
             new InitializationTask(tr("Executing platform startup hook"),
-                    () -> PlatformManager.getPlatform().startupHook(MainApplication::askUpdateJava)),
+                    () -> PlatformManager.getPlatform().startupHook(MainApplication::askUpdateJava, MainApplication::askMigrateWebStart)),
             new InitializationTask(tr("Building main menu"), application::initializeMainWindow),
             new InitializationTask(tr("Updating user interface"), () -> {

trunk/src/org/openstreetmap/josm/tools/PlatformHook.java

@@ -85 +85 @@
       * Reason: On OSX we need to register some callbacks with the
       * OS, so we'll receive events from the system menu.
-     * @param callback Java expiration callback, providing GUI feedback
-     * @since 12270 (signature)
-      */
-    default void startupHook(JavaExpirationCallback callback) {
+      * @param javaCallback Java expiration callback, providing GUI feedback
+      * @param webStartCallback WebStart migration callback, providing GUI feedback
+      * @since 17679 (signature)
+      */
+    default void startupHook(JavaExpirationCallback javaCallback, WebStartMigrationCallback webStartCallback) {
         // Do nothing
     }
@@ -262 +263 @@
          */
         void askUpdateJava(String updVersion, String url, String eolDate, boolean major);
+    }
+
+    /**
+     * Called when Oracle Java WebStart is detected at startup.
+     * @since 17679
+     */
+    @FunctionalInterface
+    interface WebStartMigrationCallback {
+        /**
+         * Asks user to migrate to OpenWebStart.
+         * @param url download URL
+         */
+        void askMigrateWebStart(String url);
     }
 
@@ -285 +299 @@
 
     /**
+     * Checks if we run Oracle Web Start, proposes to user to migrate to OpenWebStart.
+     * @param callback WebStart migration callback
+     * @since 17679
+     */
+    default void checkWebStartMigration(WebStartMigrationCallback callback) {
+        if (Utils.isRunningJavaWebStart()) {
+            callback.askMigrateWebStart(Config.getPref().get("openwebstart.download.url", "https://openwebstart.com/download/"));
+        }
+    }
+
+    /**
      * Called when interfacing with native OS functions. Currently only used with macOS.
      * The callback must perform all GUI-related tasks associated to an OS request.

trunk/src/org/openstreetmap/josm/tools/PlatformHookOsx.java

@@ -60 +60 @@
 
     @Override
-    public void startupHook(JavaExpirationCallback callback) {
+    public void startupHook(JavaExpirationCallback javaCallback, WebStartMigrationCallback webStartCallback) {
         // Here we register callbacks for the menu entries in the system menu and file opening through double-click
         // https://openjdk.java.net/jeps/272
@@ -98 +98 @@
             Logging.warn("Failed to register with macOS: " + ex);
         }
-        checkExpiredJava(callback);
+        checkExpiredJava(javaCallback);
+        checkWebStartMigration(webStartCallback);
     }
 

trunk/src/org/openstreetmap/josm/tools/PlatformHookUnixoid.java

@@ -61 +61 @@
             }
         }
+    }
+
+    @Override
+    public void startupHook(JavaExpirationCallback javaCallback, WebStartMigrationCallback webStartCallback) {
+        checkWebStartMigration(webStartCallback);
     }
 

trunk/src/org/openstreetmap/josm/tools/PlatformHookWindows.java

@@ -154 +154 @@
 
     @Override
-    public void startupHook(JavaExpirationCallback callback) {
-        checkExpiredJava(callback);
+    public void startupHook(JavaExpirationCallback javaCallback, WebStartMigrationCallback webStartCallback) {
+        checkExpiredJava(javaCallback);
+        checkWebStartMigration(webStartCallback);
     }
 

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -67 +67 @@
 import java.util.zip.ZipFile;
 
+import org.openstreetmap.josm.spi.preferences.Config;
+
 import com.kitfox.svg.xml.XMLParseUtil;
-import org.openstreetmap.josm.spi.preferences.Config;
 
 /**
@@ -1720 +1721 @@
 
     /**
-     * Determines whether JOSM has been started via Java Web Start.
-     * @return true if JOSM has been started via Java Web Start
-     * @since 15740
-     */
-    public static boolean isRunningJavaWebStart() {
+     * Determines whether JOSM has been started via Web Start (JNLP).
+     * @return true if JOSM has been started via Web Start (JNLP)
+     * @since 17679
+     */
+    public static boolean isRunningWebStart() {
         try {
             // See http://stackoverflow.com/a/16200769/2257172
@@ -1731 +1732 @@
             return false;
         }
+    }
+
+    /**
+     * Determines whether JOSM has been started via Oracle Java Web Start.
+     * @return true if JOSM has been started via Oracle Java Web Start
+     * @since 15740
+     */
+    public static boolean isRunningJavaWebStart() {
+        return isRunningWebStart() && Package.getPackage("com.sun.javaws") != null;
+    }
+
+    /**
+     * Determines whether JOSM has been started via Open Web Start (IcedTea-Web).
+     * @return true if JOSM has been started via Open Web Start (IcedTea-Web)
+     * @since 17679
+     */
+    public static boolean isRunningOpenWebStart() {
+        return isRunningWebStart() && Package.getPackage("net.adoptopenjdk.icedteaweb") != null;
     }
 

trunk/test/unit/org/openstreetmap/josm/tools/PlatformHookOsxTest.java

@@ -37 +37 @@
     @Test
     void testStartupHook() {
-        hook.startupHook((a, b, c, d) -> System.out.println("callback"));
+        hook.startupHook((a, b, c, d) -> System.out.println("java callback"), u -> System.out.println("webstart callback"));
     }
 

trunk/test/unit/org/openstreetmap/josm/tools/PlatformHookWindowsTest.java

@@ -55 +55 @@
     @Test
     void testStartupHook() {
-        hook.startupHook((a, b, c, d) -> System.out.println("callback"));
+        hook.startupHook((a, b, c, d) -> System.out.println("java callback"), u -> System.out.println("webstart callback"));
     }