Changeset 9831

Timestamp:

05/02/2015 08:55:07 PM (9 years ago)

Author:

imath

Message:

Make sure the BP Attachments API behaves the right way when WordPress < 4.0

Before WordPress 4.0, there was no dynamic filter based on the name of the action posted in the upload form. So we also need to filter wp_handle_upload_prefilter to make sure the BP_Attachments->validate_upload() function will actually validate the uploads for versions of WordPress < 4.0.

Improve the i18n of the avatar type error, as the avatar types can now be filtered in the BP_Attachment_Avatar class.

Add unit tests for the BP Attachement class.

Fixes #6278

Location:

trunk

Files:

• src/bp-core/classes/class-bp-attachment-avatar.php (modified) (2 diffs)
• src/bp-core/classes/class-bp-attachment.php (modified) (2 diffs)
• tests/phpunit/assets/attachment-extensions.php (added)
• tests/phpunit/includes/testcase.php (modified) (1 diff)
• tests/phpunit/testcases/core/avatars.php (modified) (1 diff)
• tests/phpunit/testcases/core/class-bp-attachment.php (added)
• tests/phpunit/testcases/core/functions.php (modified) (1 diff)

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

@@ -29 +29 @@
      */
     public function __construct() {
+        // Allowed avatar types
+        $allowed_types = bp_core_get_allowed_avatar_types();
+
         parent::__construct( array(
             'action'                => 'bp_avatar_upload',
@@ -37 +40 @@
             'upload_error_strings'  => array(
                 9  => sprintf( __( 'That photo is too big. Please upload one smaller than %s', 'buddypress' ), size_format( bp_core_avatar_original_max_filesize() ) ),
-                10 => __( 'Please upload only JPG, GIF or PNG photos.', 'buddypress' ),
+                10 => sprintf( _n( 'Please upload only this file type: %s.', 'Please upload only these file types: %s.', count( $allowed_types ), 'buddypress' ), self::get_avatar_types( $allowed_types ) ),
             ),
         ) );
+    }
+
+    /**
+     * Gets the available avatar types
+     *
+     * @since BuddyPress (2.3.0)
+     * @return string comma separated list of allowed avatar types
+     */
+    public static function get_avatar_types( $allowed_types = array() ) {
+        $types = array_map( 'strtoupper', $allowed_types );
+        $comma = _x( ',', 'avatar types separator', 'buddypress' );
+        return join( $comma . ' ', $types );
     }
 

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

@@ -220 +220 @@
         add_filter( "{$this->action}_prefilter", array( $this, 'validate_upload' ), 10, 1 );
 
+        /**
+         * The above dynamic filter was introduced in WordPress 4.0, as we support WordPress
+         * back to 3.6, we need to also use the pre 4.0 static filter and remove it after
+         * the upload was processed.
+         */
+        add_filter( 'wp_handle_upload_prefilter', array( $this, 'validate_upload' ), 10, 1 );
+
         // Set Default overrides
         $overrides = array(
@@ -265 +272 @@
         // Restore WordPress Uploads data
         remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+
+        // Remove the pre WordPress 4.0 static filter
+        remove_filter( 'wp_handle_upload_prefilter', array( $this, 'validate_upload' ), 10, 1 );
 
         // Finally return the uploaded file or the error

trunk/tests/phpunit/includes/testcase.php

@@ -424 +424 @@
         $wpdb->query( 'COMMIT;' );
     }
+
+    /**
+     * Clean up created directories/files
+     */
+    public function rrmdir( $dir ) {
+        // Make sure we are only removing files/dir from uploads
+        if ( 0 !== strpos( $dir, bp_core_avatar_upload_path() ) ) {
+            return;
+        }
+
+        $d = glob( $dir . '/*' );
+
+        if ( ! empty( $d ) ) {
+            foreach ( $d as $file ) {
+                if ( is_dir( $file ) ) {
+                    $this->rrmdir( $file );
+                } else {
+                    @unlink( $file );
+                }
+            }
+        }
+
+        @rmdir( $dir );
+    }
 }

trunk/tests/phpunit/testcases/core/avatars.php

@@ -15 +15 @@
 
         $this->rrmdir( bp_core_avatar_upload_path() . '/' . $avatar_dir );
-    }
-
-    private function rrmdir( $dir ) {
-        $d = glob( $dir . '/*' );
-
-        if ( empty( $d ) ) {
-            return;
-        }
-
-        foreach ( $d as $file ) {
-            if ( is_dir( $file ) ) {
-                $this->rrmdir( $file );
-            } else {
-                @unlink( $file );
-            }
-        }
-
-        @rmdir( $dir );
     }
 

trunk/tests/phpunit/testcases/core/functions.php

@@ -599 +599 @@
         }
     }
+
+    /**
+     * @group bp_attachments
+     * @group bp_upload_dir
+     */
+    public function test_bp_upload_dir_ms() {
+        if ( ! is_multisite() ) {
+            $this->markTestSkipped( __METHOD__ . ' is a multisite-only test.' );
+        }
+
+        $expected_upload_dir = wp_upload_dir();
+
+        $b = $this->factory->blog->create();
+
+        switch_to_blog( $b );
+
+        $tested_upload_dir = bp_upload_dir();
+
+        restore_current_blog();
+
+        $this->assertSame( $expected_upload_dir, $tested_upload_dir );
+    }
 }