Changeset 13178 for trunk/src/bp-core/bp-core-avatars.php

Timestamp:

12/11/2021 02:13:14 PM (3 years ago)

Author:

imath

Message:

Add Ajax handlers for the recycle and delete previous avatar actions

These handlers will be used by the avatar UI:

• to reset a previously uploaded user avatar as the current user avatar (bp_avatar_ajax_recycle_previous_avatar()),
• to permanently remove a previously uploaded user avatar (bp_avatar_ajax_delete_previous_avatar()).

Props vapvarun, oztaser

See #8581

File:

• trunk/src/bp-core/bp-core-avatars.php (modified) (1 diff)

trunk/src/bp-core/bp-core-avatars.php

@@ -2241 +2241 @@
     return wp_filter_object_list( $avatars, array( 'type' => $type ) );
 }
+
+/**
+ * Recycle a previously uploaded avatar as the current avatar.
+ *
+ * @since 10.0.0
+ */
+function bp_avatar_ajax_recycle_previous_avatar() {
+    if ( ! bp_is_post_request() ) {
+        wp_send_json_error();
+    }
+
+    $avatar_data = bp_parse_args(
+        $_POST,
+        array(
+            'object'    => '',
+            'item_id'   => 0,
+            'avatar_id' => '',
+        )
+    );
+
+    if ( ! $avatar_data['object'] || ! $avatar_data['item_id'] || ! $avatar_data['avatar_id'] ) {
+        wp_send_json_error();
+    }
+
+    // Check the nonce.
+    check_admin_referer( 'bp_avatar_recycle_previous', 'nonce' );
+
+    // Capability check.
+    if ( ! bp_attachments_current_user_can( 'edit_avatar', $avatar_data ) ) {
+        wp_send_json_error();
+    }
+
+    // Set the Avatar Attachment Instance.
+    $avatar_attachment = new BP_Attachment_Avatar();
+    $object            = sanitize_key( $avatar_data['object'] );
+
+    if ( 'user' === $object ) {
+        $avatar_dir = 'avatars';
+    } else {
+        $avatar_dir = $object . '-avatars';
+    }
+
+    $item_id         = (int) $avatar_data['item_id'];
+    $avatar_dir_path = $avatar_attachment->upload_path . '/' . $avatar_dir . '/' . $item_id;
+    $current_avatars = bp_attachments_list_directory_files( $avatar_dir_path );
+    $revision_errors = array();
+
+    // This path will be needed to get the avatar revision object.
+    $avatar_full_revision_path = '';
+
+    // Add a revision of the current avatar if it's not a mystery man!
+    if ( $current_avatars ) {
+        foreach( $current_avatars as $current_avatar ) {
+            if ( ! isset( $current_avatar->name, $current_avatar->id, $current_avatar->path ) ) {
+                continue;
+            }
+
+            $is_full  = preg_match( "/-bpfull/", $current_avatar->name );
+            $is_thumb = preg_match( "/-bpthumb/", $current_avatar->name );
+
+            if ( $is_full || $is_thumb ) {
+                // Add a revision of the current avatar.
+                $revision = $avatar_attachment->add_revision(
+                    'avatar',
+                    array(
+                        'file_abspath' => $current_avatar->path,
+                        'file_id'      => $current_avatar->id,
+                    )
+                );
+
+                if ( is_wp_error( $revision ) ) {
+                    $revision_errors[] = $revision->get_error_message();
+                } elseif ( $is_full ) {
+                    $avatar_full_revision_path = $revision->path;
+                }
+            }
+        }
+    }
+
+    // No errors, let's recycle the previous avatar.
+    if ( ! $revision_errors ) {
+        $avatar_id   = sanitize_file_name( $avatar_data['avatar_id'] );
+        $suffix      = '-bpfull';
+        $history_dir = trailingslashit( bp_core_avatar_upload_path() ) . $avatar_dir . '/' . $item_id . '/history';
+        $avatars     = bp_attachments_list_directory_files( $history_dir );
+
+        if ( ! isset( $avatars[ $avatar_id ] ) ) {
+            wp_send_json_error(
+                array(
+                    'message' => __( 'The profile photo you want to recycle cannot be found.', 'buddypress' ),
+                )
+            );
+        }
+
+        // Init recycle vars.
+        $recycle_timestamp = bp_core_current_time( true, 'timestamp' );
+        $recycle_errors    = array();
+        $avatar_types      = array(
+            'full'  => '',
+            'thumb' => '',
+        );
+
+        // Use the found previous avatar.
+        $avatar                = $avatars[ $avatar_id ];
+        $avatar_types['full']  = $avatar->path;
+        $avatar_types['thumb'] = str_replace( $suffix, '-bpthumb', $avatar->path );
+        $historical_types      = $avatar_types;
+
+        // It's a legacy avatar, we need to crop it again and remove the thumb file that is not using a timestamp in its name.
+        if ( ! file_exists( $avatar_types['thumb'] ) ) {
+            $full_avatar_path = $avatar_dir_path . '/' . str_replace( 'bpfull', 'original-file', wp_basename( $avatar->path ) );
+
+            // Move the full version back to avatar dir.
+            rename( $avatar->path, $full_avatar_path );
+
+            $avatar_types = $avatar_attachment->crop(
+                array(
+                    'original_file' => $full_avatar_path,
+                    'avatar_dir'    => $avatar_dir,
+                    'object'        => $object,
+                    'item_id'       => $item_id,
+                )
+            );
+
+            // loop into the history directory to delete the legacy thumb version file.
+            foreach ( $avatars as $avatar_object ) {
+                $timestamp = str_replace( array( '-bpthumb', '-bpfull' ), '', $avatar_object->id );
+
+                if ( ! is_numeric( $timestamp ) && false !== strpos( $avatar_object->id, '-bpthumb' ) ) {
+                    @unlink( $avatar_object->path );
+                }
+            }
+        } else {
+            foreach( $avatar_types as $type_key => $avatar_path ) {
+                $filename  = wp_basename( $avatar_path );
+                $avatar_id = pathinfo( $filename, PATHINFO_FILENAME );
+                $recycle_path = $avatar_dir_path . '/' . str_replace( $avatar_id, $recycle_timestamp . '-bp' . $type_key, $filename );
+
+                if ( ! rename( $avatar_path, $recycle_path ) ) {
+                    $recycle_errors[] = __( 'An unexpected error occured while recycling the previous profile photo.', 'buddypress' );
+                } else {
+                    $avatar_types[ $type_key ] = $recycle_path;
+                }
+            }
+
+            $avatar_types = array_merge(
+                $avatar_types,
+                array(
+                    'timestamp' => $recycle_timestamp,
+                )
+            );
+        }
+
+        // No errors, fire the hook used when an avatar is set.
+        if ( ! $recycle_errors && $historical_types['full'] !== $avatar_types['full'] ) {
+            $r = array(
+                'item_id'    => $item_id,
+                'object'     => $object,
+                'avatar_dir' => $avatar_dir,
+            );
+
+            $action_hook = 'bp_members_avatar_uploaded';
+            if ( 'group' === $object ) {
+                $action_hook = 'groups_avatar_uploaded';
+            }
+
+            /** This action is documented in bp-core/bp-core-avatars.php */
+            do_action( $action_hook, $item_id, 'recycle', $r, $avatar_types );
+        } else {
+            $recycle_error = reset( $recycle_errors );
+
+            wp_send_json_error(
+                array(
+                    'message' => join( "\n", $recycle_error ),
+                )
+            );
+        }
+    } else {
+        wp_send_json_error(
+            array(
+                'message' => join( "\n", $revision_errors ),
+            )
+        );
+    }
+
+    $return = array(
+        'avatar'        => esc_url(
+            bp_core_fetch_avatar(
+                array(
+                    'object'  => $object,
+                    'item_id' => $item_id,
+                    'html'    => false,
+                    'type'    => 'full',
+                )
+            )
+        ),
+        'feedback_code' => 5,
+        'item_id'       => $item_id,
+    );
+
+    // Get the created revision object if it exists.
+    if ( $avatar_full_revision_path ) {
+        $history_dir     = dirname( $avatar_full_revision_path );
+        $avatars_history = bp_attachments_list_directory_files( $history_dir );
+        $latest_id       = pathinfo( wp_basename( $avatar_full_revision_path ), PATHINFO_FILENAME );
+
+        if ( isset( $avatars_history[ $latest_id ] ) ) {
+            $gmdate      = gmdate( 'Y-m-d H:i:s', $avatars_history[ $latest_id ]->last_modified );
+            $date        = strtotime( get_date_from_gmt( $gmdate ) );
+            $history_url = trailingslashit( bp_core_avatar_url() ) .  $avatar_dir . '/' . $item_id . '/history';
+
+            // Prepare the avatar object for JavaScript.
+            $avatars_history[ $latest_id ]->date = sprintf(
+                '%1$s (%2$s)',
+                date_i18n( get_option( 'date_format' ), $date ),
+                date_i18n( get_option( 'time_format' ), $date )
+            );
+            $avatars_history[ $latest_id ]->type = 'full';
+            $avatars_history[ $latest_id ]->url  = $history_url . '/' . $avatars_history[ $latest_id ]->name;
+
+            // Remove the path.
+            unset( $avatars_history[ $latest_id ]->path );
+
+            // Set the new object to add to the revision list.
+            $return['historicalAvatar'] = $avatars_history[ $latest_id ];
+        }
+    }
+
+    wp_send_json_success( $return );
+}
+add_action( 'wp_ajax_bp_avatar_recycle_previous', 'bp_avatar_ajax_recycle_previous_avatar' );
+
+/**
+ * Delete a previously uploaded avatar from avatars history.
+ *
+ * @since 10.0.0
+ */
+function bp_avatar_ajax_delete_previous_avatar() {
+    if ( ! bp_is_post_request() ) {
+        wp_send_json_error();
+    }
+
+    $avatar_data = bp_parse_args(
+        $_POST,
+        array(
+            'object'    => '',
+            'item_id'   => 0,
+            'avatar_id' => '',
+        )
+    );
+
+    if ( ! $avatar_data['object'] || ! $avatar_data['item_id'] || ! $avatar_data['avatar_id'] ) {
+        wp_send_json_error();
+    }
+
+    // Check the nonce.
+    check_admin_referer( 'bp_avatar_delete_previous', 'nonce' );
+
+    // Capability check.
+    if ( ! bp_attachments_current_user_can( 'edit_avatar', $avatar_data ) ) {
+        wp_send_json_error();
+    }
+
+    $object = sanitize_key( $avatar_data['object'] );
+    if ( 'user' === $object ) {
+        $avatar_dir = 'avatars';
+    } else {
+        $avatar_dir = $object . '-avatars';
+    }
+
+    $item_id     = (int) $avatar_data['item_id'];
+    $avatar_id   = sanitize_file_name( $avatar_data['avatar_id'] );
+    $suffix      = '-bpfull';
+    $history_dir = trailingslashit( bp_core_avatar_upload_path() ) . $avatar_dir . '/' . $item_id . '/history';
+    $avatars     = bp_attachments_list_directory_files( $history_dir );
+
+    if ( ! isset( $avatars[ $avatar_id ] ) ) {
+        wp_send_json_error(
+            array(
+                'message' => __( 'The profile photo you want to delete cannot be found.', 'buddypress' ),
+            )
+        );
+    }
+
+    $avatar_types = array(
+        'full'  => '',
+        'thumb' => '',
+    );
+
+    // Use the found previous avatar.
+    $avatar                = $avatars[ $avatar_id ];
+    $avatar_types['full']  = $avatar->path;
+    $avatar_types['thumb'] = str_replace( $suffix, '-bpthumb', $avatar->path );
+
+    // It's a legacy avatar, we need to find the thumb version using file last modified date.
+    if ( ! file_exists( $avatar_types['thumb'] ) ) {
+        $avatar_types['thumb']  = '';
+        $possible_thumb_avatars = wp_list_pluck( $avatars, 'last_modified', 'id' );
+
+        foreach ( $possible_thumb_avatars as $type_id => $modified_date ) {
+            $timediff = $avatar->last_modified - $modified_date;
+            if ( 1000 >= absint( $timediff ) && $avatar_id !== $type_id ) {
+                $avatar_types['thumb'] = $avatars[ $type_id ]->path;
+                break;
+            }
+        }
+    }
+
+    // Remove the files.
+    foreach ( $avatar_types as $avatar_path ) {
+        if ( ! $avatar_path ) {
+            continue;
+        }
+
+        @unlink( $avatar_path );
+    }
+
+    $timestamp = str_replace( '-bpfull', '', $avatar_id );
+    if ( ! is_numeric( $timestamp ) ) {
+        $timestamp = $avatar->last_modified;
+    }
+
+    /**
+     * Hook here to run custom code once the previous avatar has been deleted.
+     *
+     * @since 10.0.0
+     *
+     * @param int $item_id   The object ID.
+     * @param int $timestamp The avatar timestamp.
+     */
+    do_action( "bp_previous_{$object}_avatar_deleted", $item_id, $timestamp );
+
+    // Finally inform about the deletion success.
+    wp_send_json_success(
+        array(
+            'feedback_code' => 6,
+        )
+    );
+}
+add_action( 'wp_ajax_bp_avatar_delete_previous', 'bp_avatar_ajax_delete_previous_avatar' );