Changeset 10194

Timestamp:

10/06/2015 11:53:33 PM (10 years ago)

Author:

imath

Message:

Allow class extending the BP_Attachment class to get the original WordPress upload dir within their upload_dir_filter() method.

To do so, you simply need to add the argument $upload_dir_filter_args to the array you use inside your constructor and set it to 1.

Props rittesh.patel

Fixes #6591

Location:

trunk

Files:

• src/bp-core/classes/class-bp-attachment-cover-image.php (modified) (3 diffs)
• src/bp-core/classes/class-bp-attachment.php (modified) (8 diffs)
• tests/phpunit/assets/attachment-extensions.php (modified) (1 diff)
• tests/phpunit/testcases/core/class-bp-attachment.php (modified) (3 diffs)

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

@@ -94 +94 @@
      * @since 2.4.0
      *
+     * @param  array $upload_dir The original Uploads dir.
      * @return array upload data (path, url, basedir...)
      */
-    public function upload_dir_filter() {
+    public function upload_dir_filter( $upload_dir = array() ) {
         // Default values are for profiles
         $object_id = bp_displayed_user_id();
@@ -115 +116 @@
         $subdir  = '/' . $object_directory . '/' . $object_id . '/cover-image';
 
-        return apply_filters( 'bp_attachments_cover_image_upload_datas', array(
+        /**
+         * Filters the cover image upload directory.
+         *
+         * @since 2.4.0
+         *
+         * @param array $value       Array containing the path, URL, and other helpful settings.
+         * @param array $upload_dir The original Uploads dir.
+         */
+        return apply_filters( 'bp_attachments_cover_image_upload_dir', array(
             'path'    => $this->upload_path . $subdir,
             'url'     => $this->url . $subdir,
@@ -122 +131 @@
             'baseurl' => $this->url,
             'error'   => false
-        ) );
+        ), $upload_dir );
     }
 

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

@@ -35 +35 @@
      */
     protected $default_args = array(
-        'original_max_filesize' => 0,
-        'allowed_mime_types'    => array(),
-        'base_dir'              => '',
-        'action'                => '',
-        'file_input'            => '',
-        'upload_error_strings'  => array(),
-        'required_wp_files'     => array( 'file' ),
+        'original_max_filesize'  => 0,
+        'allowed_mime_types'     => array(),
+        'base_dir'               => '',
+        'action'                 => '',
+        'file_input'             => '',
+        'upload_error_strings'   => array(),
+        'required_wp_files'      => array( 'file' ),
+        'upload_dir_filter_args' => 0,
     );
 
@@ -48 +49 @@
      *
      * @since 2.3.0
+     * @since 2.4.0 Add the $upload_dir_filter_args argument to the $arguments array
      *
      * @param array|string $args {
-     *     @type int    $original_max_filesize Maximum file size in kilobytes. Defaults to php.ini settings.
-     *     @type array  $allowed_mime_types    List of allowed file extensions (eg: array( 'jpg', 'gif', 'png' ) ).
-     *                                         Defaults to WordPress allowed mime types.
-     *     @type string $base_dir              Component's upload base directory. Defaults to WordPress 'uploads'.
-     *     @type string $action                The upload action used when uploading a file, $_POST['action'] must be set
-     *                                         and its value must equal $action {@link wp_handle_upload()} (required).
-     *     @type string $file_input            The name attribute used in the file input. (required).
-     *     @type array  $upload_error_strings  A list of specific error messages (optional).
-     *     @type array  $required_wp_files     The list of required WordPress core files. Default: array( 'file' ).
+     *     @type int    $original_max_filesize  Maximum file size in kilobytes. Defaults to php.ini settings.
+     *     @type array  $allowed_mime_types     List of allowed file extensions (eg: array( 'jpg', 'gif', 'png' ) ).
+     *                                          Defaults to WordPress allowed mime types.
+     *     @type string $base_dir               Component's upload base directory. Defaults to WordPress 'uploads'.
+     *     @type string $action                 The upload action used when uploading a file, $_POST['action'] must be set
+     *                                          and its value must equal $action {@link wp_handle_upload()} (required).
+     *     @type string $file_input             The name attribute used in the file input. (required).
+     *     @type array  $upload_error_strings   A list of specific error messages (optional).
+     *     @type array  $required_wp_files      The list of required WordPress core files. Default: array( 'file' ).
+     *     @type int    $upload_dir_filter_args 1 to receive the original Upload dir array in the Upload dir filter, 0 otherwise.
+     *                                          Defaults to 0 (optional).
      * }
      * @uses  sanitize_key()
@@ -91 +95 @@
             } elseif ( 'base_dir' === $key ) {
                 $this->{$key} = sanitize_title( $param );
+
+            // Sanitize the upload dir filter arg to pass
+            } elseif ( 'upload_dir_filter_args' === $key ) {
+                $this->{$key} = (int) $param;
 
             // Action & File input are already set and sanitized
@@ -269 +277 @@
         // Make sure the file will be uploaded in the attachment directory
         if ( ! empty( $upload_dir_filter ) ) {
-            add_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+            add_filter( 'upload_dir', $upload_dir_filter, 10, $this->upload_dir_filter_args );
         }
 
@@ -277 +285 @@
         // Restore WordPress Uploads data
         if ( ! empty( $upload_dir_filter ) ) {
-            remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+            remove_filter( 'upload_dir', $upload_dir_filter, 10, $this->upload_dir_filter_args );
         }
 
@@ -346 +354 @@
      *
      * @since 2.3.0
+     * @since 2.4.0 Add the $upload_dir parameter to the method
      *
      * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
      *       regarding to context
      *
+     * @param  array $upload_dir The original Uploads dir.
      * @return array The upload directory data.
      */
-    public function upload_dir_filter() {
+    public function upload_dir_filter( $upload_dir = array() ) {
 
         /**
@@ -358 +368 @@
          *
          * @since 2.3.0
+         * @since 2.4.0 Include the original Upload directory as the second parameter of the filter.
          *
-         * @param array $value Array containing the path, URL, and other helpful settings.
+         * @param array $value          Array containing the path, URL, and other helpful settings.
+         * @param array $upload_dir     The original Uploads dir.
          */
         return apply_filters( 'bp_attachment_upload_dir', array(
@@ -368 +380 @@
             'baseurl' => $this->url,
             'error'   => false
-        ) );
+        ), $upload_dir );
     }
 

trunk/tests/phpunit/assets/attachment-extensions.php

@@ -8 +8 @@
         return parent::__construct( $args );
     }
+
+    public function upload_dir_filter( $upload_dir = array() ) {
+        $this->original_upload_dir = $upload_dir;
+
+        return parent::upload_dir_filter( $upload_dir );
+    }
 }

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

@@ -13 +13 @@
     public function setUp() {
         parent::setUp();
-        add_filter( 'bp_attachment_upload_overrides', array( $this, 'filter_overrides' ),  10, 1 );
-        add_filter( 'upload_dir',                     array( $this, 'filter_upload_dir' ), 20, 1 );
+        add_filter( 'bp_attachment_upload_overrides',        array( $this, 'filter_overrides' ),       10, 1 );
+        add_filter( 'upload_dir',                            array( $this, 'filter_upload_dir' ),      20, 1 );
+        add_filter( 'bp_attachments_cover_image_upload_dir', array( $this, 'filter_cover_image_dir' ), 10, 2 );
         $this->upload_results = array();
         $this->image_file = trailingslashit( buddypress()->plugin_dir ) . 'bp-core/images/mystery-man.jpg';
+        $this->original_upload_dir = array();
     }
 
     public function tearDown() {
         parent::tearDown();
-        remove_filter( 'bp_attachment_upload_overrides', array( $this, 'filter_overrides' ),  10, 1 );
-        remove_filter( 'upload_dir',                     array( $this, 'filter_upload_dir' ), 20, 1 );
+        remove_filter( 'bp_attachment_upload_overrides',     array( $this, 'filter_overrides' ),       10, 1 );
+        remove_filter( 'upload_dir',                         array( $this, 'filter_upload_dir' ),      20, 1 );
+        add_filter( 'bp_attachments_cover_image_upload_dir', array( $this, 'filter_cover_image_dir' ), 10, 2 );
         $this->upload_results = array();
         $this->image_file = '';
+        $this->original_upload_dir = array();
     }
 
@@ -44 +48 @@
 
         return $upload_dir;
+    }
+
+    public function filter_cover_image_dir( $cover_dir, $upload_dir ) {
+        $this->original_upload_dir = $upload_dir;
+
+        return $cover_dir;
     }
 
@@ -454 +464 @@
         $this->assertTrue( 3 === $image_data['meta']['orientation'] );
     }
+
+    /**
+     * @group upload
+     * @group cover_images
+     */
+    public function test_bp_attachment_upload_dir_filter_arg() {
+        $reset_files = $_FILES;
+        $reset_post = $_POST;
+
+        $attachment_class = new BPTest_Attachment_Extension( array(
+            'action'                 => 'attachment_action',
+            'file_input'             => 'attachment_file_input',
+            'base_dir'               => 'attachment_base_dir',
+            'upload_dir_filter_args' => 1,
+        ) );
+
+        $_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 ),
+        );
+
+        // Simulate an upload
+        $attachment_class->upload( $_FILES );
+
+        // Remove the filter used to fake uploads
+        remove_filter( 'upload_dir', array( $this, 'filter_upload_dir' ), 20, 1 );
+
+        $this->assertSame( $attachment_class->original_upload_dir, wp_upload_dir() );
+
+        // Restore the filter used to fake uploads
+        add_filter( 'upload_dir', array( $this, 'filter_upload_dir' ), 20, 1 );
+
+        $this->assertTrue( 1 === $attachment_class->upload_dir_filter_args );
+
+        $cover_image_class = new BP_Attachment_Cover_Image();
+
+        // Simulate an upload
+        $cover_image_class->upload( $_FILES );
+
+        // Should be empty
+        $this->assertEmpty( $this->original_upload_dir );
+
+        $this->assertTrue( 0 === $cover_image_class->upload_dir_filter_args );
+
+        $_FILES = $reset_files;
+        $_POST = $reset_post;
+    }
 }