Changeset 19637 in josm

Timestamp:

2026-10-06T08:57:52+02:00 (5 days ago)

Author:

stoecker

Message:

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

Location:

trunk

Files:

• native/linux/latest/usr/bin/josm-latest (modified) (1 diff)
• native/linux/tested/usr/bin/josm (modified) (1 diff)
• src/org/openstreetmap/josm/gui/bugreport/BugReportDialog.java (modified) (3 diffs)
• src/org/openstreetmap/josm/tools/bugreport/ReportedException.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/gui/bugreport/BugReportDialogTest.java (added)
• test/unit/org/openstreetmap/josm/tools/bugreport/ReportedExceptionTest.java (modified) (2 diffs)

trunk/native/linux/latest/usr/bin/josm-latest

@@ -58 +58 @@
     # shellcheck source=/etc/default/josm-latest
     . "/etc/default/${JOSM_VERSION}"
+fi
+
+# Java decodes file names with the character set of the locale, and -Dsun.jnu.encoding
+# cannot override it. If the locale is C/POSIX, or cannot be set at all - typically a
+# UTF-8 LANG whose locale is not installed, as in a Flatpak sandbox - file names are
+# decoded as ASCII and opening a folder that holds a non-ASCII name fails with
+# InvalidPathException. Fall back to C.UTF-8 then, which is built into glibc 2.35 and
+# later. This does not change the language of JOSM: when the locale cannot be set, Java
+# already falls back to English. LC_ALL is needed, as setlocale() fails as a whole if
+# any category names a locale that is not installed.
+if { [ -n "$(locale 2>&1 >/dev/null)" ] || [ "$(locale charmap 2>/dev/null)" = "ANSI_X3.4-1968" ]; } \
+        && [ -z "$(LC_ALL=C.UTF-8 locale 2>&1 >/dev/null)" ]; then
+    export LC_ALL=C.UTF-8
 fi
 

trunk/native/linux/tested/usr/bin/josm

@@ -58 +58 @@
     # shellcheck source=/etc/default/josm
     . "/etc/default/${JOSM_VERSION}"
+fi
+
+# Java decodes file names with the character set of the locale, and -Dsun.jnu.encoding
+# cannot override it. If the locale is C/POSIX, or cannot be set at all - typically a
+# UTF-8 LANG whose locale is not installed, as in a Flatpak sandbox - file names are
+# decoded as ASCII and opening a folder that holds a non-ASCII name fails with
+# InvalidPathException. Fall back to C.UTF-8 then, which is built into glibc 2.35 and
+# later. This does not change the language of JOSM: when the locale cannot be set, Java
+# already falls back to English. LC_ALL is needed, as setlocale() fails as a whole if
+# any category names a locale that is not installed.
+if { [ -n "$(locale 2>&1 >/dev/null)" ] || [ "$(locale charmap 2>/dev/null)" = "ANSI_X3.4-1968" ]; } \
+        && [ -z "$(LC_ALL=C.UTF-8 locale 2>&1 >/dev/null)" ]; then
+    export LC_ALL=C.UTF-8
 fi
 

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

trunk/test/unit/org/openstreetmap/josm/tools/bugreport/ReportedExceptionTest.java

@@ -3 +3 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import java.nio.file.InvalidPathException;
 import java.util.Arrays;
 
@@ -62 +65 @@
 
     /**
+     * Tests {@link ReportedException#isUnmappableFileName()}: a file name which the character set used for file names
+     * cannot represent is recognised, also as the cause of another exception, but only if that character set is not
+     * UTF-8 - otherwise the locale is not to blame. See #14596.
+     */
+    @Test
+    void testIsUnmappableFileName() {
+        // the exception sun.nio.fs.UnixPath throws for "Capture d'écran.png" when the locale is C or not installed
+        InvalidPathException unmappable = new InvalidPathException("/home/user/Capture d'\u00e9cran.png",
+                "Malformed input or input contains unmappable characters");
+        String jnuEncoding = System.getProperty("sun.jnu.encoding");
+        try {
+            System.setProperty("sun.jnu.encoding", "ANSI_X3.4-1968");
+            assertTrue(new ReportedException(unmappable).isUnmappableFileName());
+            assertTrue(new ReportedException(new IllegalStateException(unmappable)).isUnmappableFileName());
+            assertFalse(new ReportedException(new InvalidPathException("a\0b", "Nul character not allowed")).isUnmappableFileName());
+            assertFalse(new ReportedException(new IllegalStateException()).isUnmappableFileName());
+
+            System.setProperty("sun.jnu.encoding", "UTF-8");
+            assertFalse(new ReportedException(unmappable).isUnmappableFileName());
+        } finally {
+            System.setProperty("sun.jnu.encoding", jnuEncoding);
+        }
+    }
+
+    /**
      * Tests that {@link ReportedException#isSame(ReportedException)} works as expected.
      */