Changeset 11602

Timestamp:

06/21/2017 09:30:26 PM (7 years ago)

Author:

r-a-y

Message:

Attachments: Fix issues with uploading a file containing accented characters.

Previously, when uploading a new avatar or cover image with accented
characters, the upload would fail. This is due to an upstream WordPress
bug since WP does not handle sanitizing these types of file names properly.
(See ​#WP22363, ​#WP24661, ​#WP15955 for just a few of the related problems.)

To fix this in BuddyPress, we are putting in a workaround to convert file
names with UTF-8 characters to their ASCII equivalent. First, we try to
use PHP's intl extension if available. If not, we use WP's
remove_accents() function, and lastly if the filename still contains
UTF-8 characters, we also try to use iconv() if available.

This is considered a workaround until WordPress fixes this in core.

Fixes #7484.

File:

• trunk/src/bp-core/classes/class-bp-attachment.php (modified) (2 diffs)

trunk/src/bp-core/classes/class-bp-attachment.php

@@ -262 +262 @@
         }
 
+        // Helper for utf-8 filenames.
+        add_filter( 'sanitize_file_name', array( $this, 'sanitize_utf8_filename' ) );
+
         // Upload the attachment.
         $this->attachment = wp_handle_upload( $file[ $this->file_input ], $overrides, $time );
+
+        remove_filter( 'sanitize_file_name', array( $this, 'sanitize_utf8_filename' ) );
 
         // Restore WordPress Uploads data.
@@ -272 +277 @@
         // Finally return the uploaded file or the error.
         return $this->attachment;
+    }
+
+    /**
+     * Helper to convert utf-8 characters in filenames to their ASCII equivalent.
+     *
+     * @since 2.9.0
+     *
+     * @param  string $retval Filename.
+     * @return string
+     */
+    public function sanitize_utf8_filename( $retval ) {
+        // PHP 5.4+ or with PECL intl 2.0+
+        if ( function_exists( 'transliterator_transliterate' ) && seems_utf8( $retval ) ) {
+            $retval = transliterator_transliterate( 'Any-Latin; Latin-ASCII; [\u0080-\u7fff] remove', $retval );
+
+        // Older.
+        } else {
+            // Use WP's built-in function to convert accents to their ASCII equivalent.
+            $retval = remove_accents( $retval );
+
+            // Still here? use iconv().
+            if ( function_exists( 'iconv' ) && seems_utf8( $retval ) ) {
+                $retval = iconv( 'UTF-8', 'ASCII//TRANSLIT//IGNORE', $retval );
+            }
+        }
+
+        return $retval;
     }