Changeset 9874

Timestamp:

05/17/2015 11:14:39 AM (11 years ago)

Author:

imath

Message:

In BP_Attachment->upload(), only filter the WordPress upload_dir if the callback function is set.

This callback function can be passed as the second argument of BP_Attachment->upload(), or dynamically created if the specific $base_dir parameter was provided by the extending class.

About this second case, if the extending class forgets to set the $base_dir parameter or do it on purpose in order to use the WordPress default upload directory, we will not filter the WordPress upload_dir to avoid a warning.

This commit also adds a third argument to BP_Attachment->upload(), in case there is a need to pass a specific time (yyyy/mm) to set the WordPress default upload sub directory.

Fixes #6438

Location:

trunk

Files:

• src/bp-core/classes/class-bp-attachment.php (modified) (3 diffs)
• tests/phpunit/testcases/core/class-bp-attachment.php (modified) (3 diffs)

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

@@ -197 +197 @@
      * @param  array $file               The appropriate entry the from $_FILES superglobal.
      * @param  string $upload_dir_filter A specific filter to be applied to 'upload_dir' (optional).
+     * @param  string $time              Optional. Time formatted in 'yyyy/mm'. Default null.
      * @uses   wp_handle_upload()        To upload the file
      * @uses   add_filter()              To temporarly overrides WordPress uploads data
@@ -206 +207 @@
      *                                   (eg: array( 'error' => $message ) )
      */
-    public function upload( $file, $upload_dir_filter = '' ) {
+    public function upload( $file, $upload_dir_filter = '', $time = null ) {
         /**
          * Upload action and the file input name are required parameters
@@ -265 +266 @@
 
         // Make sure the file will be uploaded in the attachment directory
-        add_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+        if ( ! empty( $upload_dir_filter ) ) {
+            add_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+        }
 
         // Upload the attachment
-        $this->attachment = wp_handle_upload( $file[ $this->file_input ], $overrides );
+        $this->attachment = wp_handle_upload( $file[ $this->file_input ], $overrides, $time );
 
         // Restore WordPress Uploads data
-        remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+        if ( ! empty( $upload_dir_filter ) ) {
+            remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+        }
 
         // Remove the pre WordPress 4.0 static filter

trunk/tests/phpunit/testcases/core/class-bp-attachment.php

@@ -14 +14 @@
         parent::setUp();
         add_filter( 'bp_attachment_upload_overrides', array( $this, 'filter_overrides' ),  10, 1 );
-        add_filter( 'bp_attachment_upload_dir',       array( $this, 'filter_upload_dir' ), 10, 1 );
-        add_filter( 'xprofile_avatar_upload_dir',     array( $this, 'filter_upload_dir' ), 10, 1 );
-        add_filter( 'groups_avatar_upload_dir',       array( $this, 'filter_upload_dir' ), 10, 1 );
+        add_filter( 'upload_dir',                     array( $this, 'filter_upload_dir' ), 20, 1 );
         $this->upload_results = array();
         $this->image_file = trailingslashit( buddypress()->plugin_dir ) . 'bp-core/images/mystery-man.jpg';
@@ -24 +22 @@
         parent::tearDown();
         remove_filter( 'bp_attachment_upload_overrides', array( $this, 'filter_overrides' ),  10, 1 );
-        remove_filter( 'bp_attachment_upload_dir',       array( $this, 'filter_upload_dir' ), 10, 1 );
-        remove_filter( 'xprofile_avatar_upload_dir',     array( $this, 'filter_upload_dir' ), 10, 1 );
-        remove_filter( 'groups_avatar_upload_dir',       array( $this, 'filter_upload_dir' ), 10, 1 );
+        remove_filter( 'upload_dir',                     array( $this, 'filter_upload_dir' ), 20, 1 );
         $this->upload_results = array();
         $this->image_file = '';
@@ -176 +172 @@
     /**
      * @group upload
+     */
+    public function test_bp_attachment_upload_no_base_dir_specific_time() {
+        $reset_files = $_FILES;
+        $reset_post = $_POST;
+
+        $attachment_class = new BPTest_Attachment_Extension( array(
+            'action'                => 'attachment_action',
+            'file_input'            => 'attachment_file_input',
+        ) );
+
+        $_POST['action'] = $attachment_class->action;
+        $_FILES[ $attachment_class->file_input ] = array(
+            'tmp_name' => $this->image_file,
+            'name'     => 'mystery-man.jpg',
+            'type'     => 'image/jpeg',
+            'error'    => 0,
+            'size'     => filesize( $this->image_file ),
+        );
+
+        $time = '2015/01';
+
+        $upload = $attachment_class->upload( $_FILES, '', $time );
+
+        // If no base_dir was provided, default WordPress uploads dir should be used.
+        $this->assertEquals( $upload['file'], $attachment_class->upload_path . '/' . $time . '/mystery-man.jpg' );
+
+        // clean up!
+        $_FILES = $reset_files;
+        $_POST = $reset_post;
+    }
+
+    /**
+     * @group upload
      * @group avatar
      */