Changeset 19637 in josm for trunk/src

Timestamp:

2026-10-06T08:57:52+02:00 (2 weeks ago)

Author:

stoecker

Message:

detect the UTF-8 filename issue in non-UTF contexts, patch by wangi, fix #24940

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/bugreport/BugReportDialog.java (modified) (3 diffs)
• tools/bugreport/ReportedException.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/bugreport/BugReportDialog.java

@@ -32 +32 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.InputMapUtils;
+import org.openstreetmap.josm.tools.Utils;
 import org.openstreetmap.josm.tools.bugreport.BugReport;
 import org.openstreetmap.josm.tools.bugreport.BugReportQueue.SuppressionMode;
@@ -46 +47 @@
 public class BugReportDialog extends JDialog {
     private static final int MAX_MESSAGE_SIZE = 500;
+    /** whether the user has been told about file names that cannot be represented, which is done once per session */
+    private static volatile boolean unmappableFileNameExplained;
     // This is explicitly not an ExtendedDialog - we still want to be able to display bug reports if there are problems with preferences/..
     private final JPanel content = new JPanel(new GridBagLayout());
@@ -229 +232 @@
                     );
             return SuppressionMode.NONE;
+        } else if (e.isUnmappableFileName()) {
+            // Not a bug in JOSM, but a locale which cannot represent the name of a file, see #14596. Explain how to
+            // fix it rather than asking for a bug report, and only once: browsing other folders throws it again.
+            if (!unmappableFileNameExplained) {
+                unmappableFileNameExplained = true;
+                GuiHelper.runInEDTAndWait(() -> JOptionPane.showMessageDialog(MainApplication.getMainFrame(),
+                        tr("<html>JOSM cannot handle the name of a file, because it is running with the character set {0} "
+                                + "for file names, which cannot represent it.<br>"
+                                + "This happens when JOSM is started without a UTF-8 locale, for example with {1}, "
+                                + "or with a locale which is not installed.<br><br>"
+                                + "Please start JOSM with the environment variable {2}.</html>",
+                                Utils.getSystemProperty("sun.jnu.encoding"), "<tt>LANG=C</tt>", "<tt>LC_ALL=C.UTF-8</tt>"),
+                        tr("Unsupported file name"),
+                        JOptionPane.WARNING_MESSAGE));
+            }
+            return SuppressionMode.NONE;
         } else {
             PluginDownloadTask downloadTask = PluginHandler.updateOrdisablePluginAfterException(e);

trunk/src/org/openstreetmap/josm/tools/bugreport/ReportedException.java

@@ -5 +5 @@
 import java.io.Serializable;
 import java.lang.reflect.InvocationTargetException;
+import java.nio.file.InvalidPathException;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -22 +23 @@
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.StreamUtils;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -279 +281 @@
 
     /**
+     * Check if this is caused by the name of a file which cannot be represented in the character set Java uses for
+     * file names. Java takes that character set from the locale, so this happens when JOSM runs in the C/POSIX locale,
+     * or with a locale which is not installed: file names are then ASCII only, and opening a folder which holds a
+     * non-ASCII name fails. See #14596.
+     * @return <code>true</code> if it is.
+     * @since 19637
+     */
+    public boolean isUnmappableFileName() {
+        return !"UTF-8".equalsIgnoreCase(Utils.getSystemProperty("sun.jnu.encoding"))
+                && StreamUtils.toStream(CauseTraceIterator::new).anyMatch(t -> t instanceof InvalidPathException
+                        && String.valueOf(((InvalidPathException) t).getReason()).contains("unmappable characters"));
+    }
+
+    /**
      * Iterates over the causes for this exception. Ignores cycles and aborts iteration then.
      * @author Michal Zangl