Changeset 60399

Timestamp:

07/01/2025 03:38:44 PM (7 months ago)

Author:

dmsnell

Message:

sanitize_file_name(): Normalize all space characters to a space.

The sanitize_file_name() function normalizes the no-break space to a normal space (U+0020) in order to prevent issues saving files with the no-break space in it.

This patch expands the replacement to all space characters, since it’s known that macOS stores a NARROW NO-BREAK SPACE (U+202F) in screenshot filenames between the time and the am/pm indicator.

There are deeper issues with the way this function works, but this patch resolves a known and common problem without raising any of the deeper refactoring questions.

Developed in ​https://github.com/wordpress/wordpress-develop/pull/9103
Discussed in https://core.trac.wordpress.org/ticket/62995

Props audrasjb, desrosj, dmsnell, jonsurrell, matt, room34, siliconforks, zieladam.
Fixes #62995.

Location:

trunk

Files:

• src/wp-includes/formatting.php (modified) (1 diff)
• tests/phpunit/tests/formatting/sanitizeFileName.php (modified) (1 diff)

trunk/src/wp-includes/formatting.php

@@ -2036 +2036 @@
 
     if ( $utf8_pcre ) {
-        $filename = preg_replace( "#\x{00a0}#siu", ' ', $filename );
+        /**
+         * Replace all whitespace characters with a basic space (U+0020).
+         *
+         * The “Zs” in the pattern selects characters in the `Space_Separator`
+         * category, which is what Unicode considers space characters.
+         *
+         * @see https://www.unicode.org/reports/tr44/#General_Category_Values
+         * @see https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-6/#G17548
+         * @see https://www.php.net/manual/en/regexp.reference.unicode.php
+         */
+        $filename = preg_replace( '#\p{Zs}#siu', ' ', $filename );
     }
 

trunk/tests/phpunit/tests/formatting/sanitizeFileName.php

@@ -36 +36 @@
      *
      * @ticket 16330
+     * @ticket 62995
      */
     public function test_replaces_spaces() {
         $urls = array(
-            'unencoded space.png'  => 'unencoded-space.png',
-            'encoded-space.jpg'    => 'encoded-space.jpg',
-            'plus+space.jpg'       => 'plusspace.jpg',
-            'multi %20 +space.png' => 'multi-20-space.png',
+            'unencoded space.png'                         => 'unencoded-space.png',
+            'encoded-space.jpg'                           => 'encoded-space.jpg',
+            'plus+space.jpg'                              => 'plusspace.jpg',
+            'multi %20 +space.png'                        => 'multi-20-space.png',
+            "Screenshot 2025-02-19 at 2.17.33\u{202F}PM.png" => 'Screenshot-2025-02-19-at-2.17.33-PM.png',
+            "Filename with non-breaking\u{00A0}space.txt" => 'Filename-with-non-breaking-space.txt',
+            "Filename with thin\u{2009}space.txt"         => 'Filename-with-thin-space.txt',
         );