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

Timestamp:

12/11/2021 12:00:16 PM (3 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

File:

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

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 {