Changeset 13175

Timestamp:

12/11/2021 12:00:16 PM (2 years ago)

Author:

imath

Message:

Introduce a new method to the BP Attachment API to add file revisions

The BP_Attachment::add_revision() method is primarily used by the BP_Attachment_Avatar class to keep the history of previously uploaded user avatars (and potentially other objects avatar).

When a user uploads a new avatar, the previously uploaded one is moved inside an history subdirectory of the user's avatar directory. This avatars history is then available for the new_avatar activities to display the avatar the user had at the time these were published.

Props vapvarun, oztaser

See #8581

Location:

trunk

Files:

• src/bp-core/classes/class-bp-attachment-avatar.php (modified) (7 diffs)
• src/bp-core/classes/class-bp-attachment.php (modified) (1 diff)
• tests/phpunit/testcases/core/class-bp-attachment.php (modified) (1 diff)

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

@@ -200 +200 @@
      *
      * @param array $args Array of arguments for the cropping.
-     * @return array The cropped avatars (full and thumb).
+     * @return array The cropped avatars (full, thumb and the timestamp).
      */
     public function crop( $args = array() ) {
@@ -256 +256 @@
         /**
          * Check that the new avatar doesn't have the same name as the
-         * old one before deleting
+         * old one before moving the previous one into history.
          */
         if ( ! empty( $existing_avatar ) && $existing_avatar !== $this->url . $relative_path ) {
-            bp_core_delete_existing_avatar( array( 'object' => $args['object'], 'item_id' => $args['item_id'], 'avatar_path' => $avatar_folder_dir ) );
+            // Add a new revision for the existing avatar.
+            $avatars = bp_attachments_list_directory_files( $avatar_folder_dir );
+
+            if ( $avatars ) {
+                foreach ( $avatars as $avatar_file ) {
+                    if ( ! isset( $avatar_file->name, $avatar_file->id, $avatar_file->path ) ) {
+                        continue;
+                    }
+
+                    $is_full  = preg_match( "/-bpfull/", $avatar_file->name );
+                    $is_thumb = preg_match( "/-bpthumb/", $avatar_file->name );
+
+                    if ( $is_full || $is_thumb ) {
+                        $revision = $this->add_revision(
+                            'avatar',
+                            array(
+                                'file_abspath' => $avatar_file->path,
+                                'file_id'      => $avatar_file->id,
+                            )
+                        );
+
+                        if ( is_wp_error( $revision ) ) {
+                            error_log( $revision->get_error_message() );
+                        }
+                    }
+                }
+            }
         }
 
@@ -273 +299 @@
         // Get the file extension.
         $data = @getimagesize( $absolute_path );
-        $ext  = $data['mime'] == 'image/png' ? 'png' : 'jpg';
+        $ext  = $data['mime'] === 'image/png' ? 'png' : 'jpg';
 
         $args['original_file'] = $absolute_path;
         $args['src_abs']       = false;
-        $avatar_types = array( 'full' => '', 'thumb' => '' );
+
+        $avatar_types = array(
+            'full'  => '',
+            'thumb' => '',
+        );
+        $timestamp   = bp_core_current_time( true, 'timestamp' );
 
         foreach ( $avatar_types as $key_type => $type ) {
@@ -288 +319 @@
             }
 
-            $filename         = wp_unique_filename( $avatar_folder_dir, uniqid() . "-bp{$key_type}.{$ext}" );
+            $filename         = wp_unique_filename( $avatar_folder_dir, $timestamp . "-bp{$key_type}.{$ext}" );
             $args['dst_file'] = $avatar_folder_dir . '/' . $filename;
 
@@ -297 +328 @@
         @unlink( $absolute_path );
 
-        // Return the full and thumb cropped avatars.
-        return $avatar_types;
+        // Return the full, thumb cropped avatars and the timestamp.
+        return array_merge(
+            $avatar_types,
+            array(
+                'timestamp' => $timestamp,
+            )
+        );
     }
 
@@ -383 +419 @@
                 3 => __( 'There was a problem deleting your profile photo. Please try again.', 'buddypress' ),
                 4 => __( 'Your profile photo was deleted successfully!', 'buddypress' ),
+                5 => __( 'Your profile photo was recycled successfully!', 'buddypress' ),
+                6 => __( 'The profile photo was permanently deleted successfully!', 'buddypress' ),
             );
         } elseif ( ! empty( $group_id ) ) {
@@ -401 +439 @@
                 3 => __( 'There was a problem deleting the group profile photo. Please try again.', 'buddypress' ),
                 4 => __( 'The group profile photo was deleted successfully!', 'buddypress' ),
+                5 => __( 'The group profile photo was recycled successfully!', 'buddypress' ),
+                6 => __( 'The group profile photo was permanently deleted successfully!', 'buddypress' ),
             );
         } else {

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

@@ -561 +561 @@
 
     /**
+     * Adds a new revision of a file.
+     *
+     * @since 10.0.0
+     *
+     * @param string $attachment_type The attachement type (eg: avatar).
+     * @param array $args {
+     *     @type string $file_abspath The source file (absolute path) for the attachment.
+     *     @type string $file_id      Optional. The file ID to use as a suffix for the revision directory.
+     * }
+     * @return object|WP_Error An object informing about the URL an Path to a revision file, a WP_Error object on failure.
+     */
+    public function add_revision( $attachment_type, $args = array() ) {
+        $r = bp_parse_args(
+            $args,
+            array(
+                'file_abspath' => '',
+                'file_id'      => '',
+            ),
+            'attachment_' . $attachment_type . '_add_revision'
+        );
+
+        if ( ! $r['file_abspath'] ) {
+            return new WP_Error( 'missing_parameter', __( 'The absolute path to your file is missing.', 'buddypress' ) );
+
+            // Make sure it's coming from an uploaded file.
+        } elseif ( false === strpos( $r['file_abspath'], $this->upload_path ) ) {
+            return new WP_Error( 'forbidden_path', __( 'The absolute path to your file is not allowed.', 'buddypress' ) );
+
+        } else {
+            $filepath = $r['file_abspath'];
+        }
+
+        $dirname  = trailingslashit( dirname( $filepath ) );
+        $filename = sanitize_file_name( wp_basename( $filepath ) );
+
+        if ( ! $r['file_id'] ) {
+            $r['file_id'] = $filename;
+        }
+
+        $file_id = wp_hash( $r['file_id'] );
+
+        // Set the revision name & dir.
+        $revision_name = '';
+        $revision_dir  = $dirname . '._revisions_' . $file_id;
+
+        // Avatars and Cover Images are specific attachments.
+        if ( 'avatar' === $attachment_type || 'cover_image' === $attachment_type ) {
+            $revision_dir  = $dirname . 'history';
+        }
+
+        // Create the revision directory if it doesn't exist yet.
+        if ( ! is_dir( $revision_dir ) ) {
+            mkdir( $revision_dir );
+        }
+
+        $revision_name = wp_unique_filename( $revision_dir, $filename );
+        $revision_path = trailingslashit( $revision_dir ) . $revision_name;
+
+        if ( ! rename( $filepath, $revision_path ) ) {
+            return new WP_Error( 'adding_revision_failed', __( 'An unexpected error occured while adding the revision.', 'buddypress' ) );
+        }
+
+        return (object) array(
+            'url'  => str_replace( trailingslashit( $this->upload_path ), trailingslashit( $this->url ), $revision_path ),
+            'path' => $revision_path,
+        );
+    }
+
+    /**
      * Get full data for an image
      *

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

@@ -407 +407 @@
     }
 
+    /**
+     * @group add_revision
+     */
+    public function test_bp_attachment_add_revision() {
+        if ( false === _wp_image_editor_choose() || version_compare( phpversion(), '7.0' , '<' ) ) {
+            $this->markTestSkipped( 'This test requires PHP >= 7.0 and to have a valid image editor that is compatible with WordPress.' );
+        }
+
+        $image = BP_TESTS_DIR . 'assets/upside-down.jpg';
+
+        $attachment = new BPTest_Attachment_Extension(
+            array(
+                'base_dir'   => 'add_revision',
+                'action'     => 'attachment_action',
+                'file_input' => 'attachment_file_input',
+            )
+        );
+
+        $abs_path_copy = $attachment->upload_path . '/upside-down.jpg';
+        copy( $image, $abs_path_copy );
+
+        $revision = $attachment->add_revision(
+            'media',
+            array(
+                'file_abspath' => $abs_path_copy,
+                'file_id'      => 'media',
+            )
+        );
+
+        $this->assertFalse( file_exists( $abs_path_copy ) );
+        $this->assertTrue( file_exists( $revision->path ) );
+
+        // Cleanup
+        @unlink( $revision->path );
+        @rmdir( dirname( $revision->path ) );
+        $this->clean_files( 'add_revision' );
+    }
+
+    /**
+     * @group add_revision
+     * @group avatars
+     */
+    public function test_bp_attachment_add_avatar_history() {
+        if ( false === _wp_image_editor_choose() || version_compare( phpversion(), '7.0' , '<' ) ) {
+            $this->markTestSkipped( 'This test requires PHP >= 7.0 and to have a valid image editor that is compatible with WordPress.' );
+        }
+
+        $image = BP_TESTS_DIR . 'assets/upside-down.jpg';
+
+        $attachment = new BPTest_Attachment_Extension(
+            array(
+                'base_dir'   => 'add_history',
+                'action'     => 'attachment_action',
+                'file_input' => 'attachment_file_input',
+            )
+        );
+
+        $abs_path_copy = $attachment->upload_path . '/upside-down.jpg';
+        copy( $image, $abs_path_copy );
+
+        $revision = $attachment->add_revision(
+            'avatar',
+            array(
+                'file_abspath' => $abs_path_copy,
+                'file_id'      => 'avatar',
+            )
+        );
+
+        $this->assertFalse( file_exists( $abs_path_copy ) );
+        $this->assertTrue( file_exists( $revision->path ) );
+        $this->assertSame( $attachment->url . '/history/upside-down.jpg', $revision->url );
+
+        // Cleanup
+        @unlink( $revision->path );
+        @rmdir( dirname( $revision->path ) );
+        $this->clean_files( 'add_history' );
+    }
+
     public function limit_to_50px( $max_width ) {
         return 50;