Ticket #16434: 16434.13.diff

src/wp-admin/includes/class-wp-site-icon.php

@@ -62 +62 @@
 
                 add_action( 'admin_menu', array( $this, 'admin_menu_upload_site_icon' ) );
 
-                add_action( 'admin_action_set_site_icon',    array( $this, 'set_site_icon'    ) );
-                add_action( 'admin_action_remove_site_icon', array( $this, 'remove_site_icon' ) );
+                // Because of the media upload the 'admin_action_crop_site_icon' is not called
+                add_action( 'load-settings_page_site-icon',  array( $this, 'maybe_skip_cropping' ) );
+                add_action( 'admin_action_set_site_icon',    array( $this, 'set_site_icon'       ) );
+                add_action( 'admin_action_remove_site_icon', array( $this, 'remove_site_icon'    ) );
+                add_action( 'admin_action_site_icon_set',    array( $this, 'site_icon_set'       ) );
 
                 add_action( 'delete_attachment', array( $this, 'delete_attachment_data' ), 10, 1 );
                 add_filter( 'get_post_metadata', array( $this, 'get_post_metadata' ), 10, 4 );
@@ -181 +184 @@
                 </p>
                 <form class="hide-if-js" action="<?php echo esc_url( admin_url( 'options-general.php?page=site-icon' ) ); ?>" method="post" enctype="multipart/form-data">
                         <input name="action" value="crop_site_icon" type="hidden" />
-                        <input name="site-icon" type="file" />
+                        <input name="new-site-icon" type="file" />
                         <input name="submit" value="<?php esc_attr_e( 'Upload Image' ); ?>" type="submit" class="button button-primary" />
                         <p class="description">
                                 <?php printf( __( 'The image is recommended to be a square image of at least %spx in both width and height.' ), "<strong>$this->min_size</strong>" ); ?>
@@ -192 +195 @@
         }
 
         /**
-         * Crop a the image admin view.
+         * Check if the image needs cropping
+         * If it doesn't need cropping, proceed to set the icon
          *
          * @since 4.3.0
          */
-        public function crop_page() {
+        public function maybe_skip_cropping() {
+                if ( ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != 'crop_site_icon' ) {
+                        return;
+                }
+
                 check_admin_referer( 'crop-site-icon' );
 
+                $upload_data = $this->get_upload_data();
+                $image_size = $upload_data['image_size'];
+
+                if ( $image_size[0] == $image_size[1] && $image_size[0] == $this->min_size ) {
+                        // no cropping is required
+
+                        $url = add_query_arg(
+                                array(
+                                        'attachment_id' => $upload_data['attachment_id'],
+                                        'skip-cropping' => true,
+                                        'create-new-attachment' => true,
+                                        'action' => 'set_site_icon'
+                                ),
+                                wp_nonce_url( admin_url( 'options-general.php' ), 'set-site-icon' )
+                        );
+
+                        wp_redirect( $url );
+                        die();
+                }
+        }
+
+        /**
+         * Get the data required to work with the uploaded image
+         *
+         * @since 4.3.0
+         *
+         * @return array containing the collected data
+         */
+        public function get_upload_data() {
                 if ( isset( $_GET['file'] ) ) {
                         $attachment_id = absint( $_GET['file'] );
                         $file          = get_attached_file( $attachment_id, true );
@@ -213 +250 @@
 
                 $image_size = getimagesize( $file );
 
+                return compact('attachment_id', 'url', 'image_size');
+        }
+
+        /**
+         * Crop a the image admin view.
+         *
+         * @since 4.3.0
+         */
+        public function crop_page() {
+                check_admin_referer( 'crop-site-icon' );
+
+                $upload_data = $this->get_upload_data();
+
+                $image_size = $upload_data['image_size'];
+                $attachment_id = $upload_data['attachment_id'];
+                $url = $upload_data['url'];
+
                 if ( $image_size[0] < $this->min_size ) {
                         add_settings_error( 'site-icon', 'too-small', sprintf( __( 'The selected image is smaller than %upx in width.' ), $this->min_size ) );
 
@@ -320 +374 @@
         public function set_site_icon() {
                 check_admin_referer( 'set-site-icon' );
 
-                // Delete any existing site icon images.
-                $this->delete_site_icon();
+                $attachment_id = absint( $_REQUEST['attachment_id'] );
+                $current_site_icon_id = get_option( 'site_icon' );
 
-                $attachment_id = absint( $_POST['attachment_id'] );
+                $create_new_attachement = isset( $_REQUEST['create-new-attachment'] ) && $_REQUEST['create-new-attachment'];
+                $skip_cropping = isset( $_REQUEST['skip-cropping'] ) && $_REQUEST['skip-cropping'];
 
-                // TODO
-                if ( empty( $_POST['skip-cropping'] ) ) {
-                        $crop_ratio = (float) $_POST['crop_ratio'];
-                        $crop_data = $this->convert_coordinates_from_resized_to_full( $_POST['crop-x'], $_POST['crop-y'], $_POST['crop-w'], $_POST['crop-h'], $crop_ratio );
-                        $cropped = wp_crop_image( $attachment_id, $crop_data['crop_x'], $crop_data['crop_y'], $crop_data['crop_width'], $crop_data['crop_height'], $this->min_size, $this->min_size );
-                } elseif ( ! empty( $_POST['create-new-attachment'] ) ) {
-                        $cropped = _copy_image_file( $attachment_id );
+                /*
+                 * If the current attachment as been set as site icon don't delete it.
+                 */
+                if ( $current_site_icon_id != $attachment_id ) {
+                        // Delete any existing site icon images.
+                        $this->delete_site_icon();
+
+                        if ( false === $skip_cropping ) {
+                                $crop_ratio = (float) $_REQUEST['crop_ratio'];
+                                $crop_data  = $this->convert_coordinates_from_resized_to_full(
+                                        $_POST['crop-x'],
+                                        $_POST['crop-y'],
+                                        $_POST['crop-w'],
+                                        $_POST['crop-h'],
+                                        $crop_ratio
+                                );
+                                $cropped = wp_crop_image(
+                                        $attachment_id,
+                                        $crop_data['crop_x'],
+                                        $crop_data['crop_y'],
+                                        $crop_data['crop_width'],
+                                        $crop_data['crop_height'],
+                                        $this->min_size,
+                                        $this->min_size
+                                );
+                        } elseif ( $create_new_attachement ) {
+                                $cropped = _copy_image_file( $attachment_id );
+                        } else {
+                                $cropped = get_attached_file( $attachment_id );
+                        }
+
+                        if ( ! $cropped || is_wp_error( $cropped ) ) {
+                                wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) );
+                        }
+
+                        $object = $this->create_attachment_object( $cropped, $attachment_id );
+
+                        if ( $create_new_attachement ) {
+                                unset( $object['ID'] );
+                        }
+
+                        // Update the attachment
+                        add_filter( 'intermediate_image_sizes_advanced', array( $this, 'additional_sizes' ) );
+                        $attachment_id = $this->insert_attachment( $object, $cropped );
+                        remove_filter( 'intermediate_image_sizes_advanced', array( $this, 'additional_sizes' ) );
+
+                        // Save the site_icon data into option
+                        update_option( 'site_icon', $attachment_id );
+
                 } else {
-                        $cropped = get_attached_file( $attachment_id );
-                }
 
-                if ( ! $cropped || is_wp_error( $cropped ) ) {
-                        wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) );
-                }
+                        // Get the file path
+                        $image_url = get_attached_file( $attachment_id );
 
-                $object = $this->create_attachment_object( $cropped, $attachment_id );
-
-                if ( ! empty( $_POST['create-new-attachment'] ) ) {
-                        unset( $object['ID'] );
+                        // Update meta-data and possibly regenerate intermediate sizes
+                        add_filter( 'intermediate_image_sizes_advanced', array( $this, 'additional_sizes' ) );
+                        $this->update_attachment_metadata( $attachment_id, $image_url );
+                        remove_filter( 'intermediate_image_sizes_advanced', array( $this, 'additional_sizes' ) );
                 }
 
-                // Update the attachment
-                add_filter( 'intermediate_image_sizes_advanced', array( $this, 'additional_sizes' ) );
-                $attachment_id = $this->insert_attachment( $object, $cropped );
-                remove_filter( 'intermediate_image_sizes_advanced', array( $this, 'additional_sizes' ) );
+                // redirect to settings page
+                wp_redirect(
+                        add_query_arg(
+                                array('action' => 'site_icon_set'),
+                                admin_url( 'options-general.php' )
+                        )
+                );
+                die();
 
-                // Save the site_icon data into option
-                update_option( 'site_icon', $attachment_id );
+        }
 
+        public function site_icon_set() {
                 add_settings_error( 'site-icon', 'icon-updated', __( 'Site Icon updated.' ), 'updated' );
         }
 
@@ -489 +587 @@
         }
 
         /**
-         * Insert an attachment and its metadata.
+         * Insert an attachment
          *
          * @since 4.3.0
          *
          * @param array  $object  Attachment object.
-         * @param string $cropped Cropped image URL.
+         * @param string $image_url Cropped image URL.
          * @return int Attachment ID.
          */
-        public function insert_attachment( $object, $cropped ) {
-                $attachment_id = wp_insert_attachment( $object, $cropped );
-                $metadata      = wp_generate_attachment_metadata( $attachment_id, $cropped );
+        public function insert_attachment( $object, $image_url ) {
+                $attachment_id = wp_insert_attachment( $object, $image_url );
 
+                $updated = $this->update_attachment_metadata( $attachment_id, $image_url );
+                if ( false !== $updated ) {
+                        return $attachment_id;
+                }
+
+                return false;
+        }
+
+        /**
+         * Update the metadata of an attachment
+         *
+         * @since 4.3.0
+         *
+         * @param int $attachment_id Attachment ID
+         * @param string $image_url Cropped image URL.
+         *
+         * @return bool|int
+         */
+        public function update_attachment_metadata( $attachment_id, $image_url ) {
+                $metadata = wp_generate_attachment_metadata( $attachment_id, $image_url );
+
                 /**
                  * Filter the site icon attachment metadata.
                  *
@@ -511 +629 @@
                  * @param array $metadata Attachment metadata.
                  */
                 $metadata = apply_filters( 'site_icon_attachment_metadata', $metadata );
-                wp_update_attachment_metadata( $attachment_id, $metadata );
+                $updated = wp_update_attachment_metadata( $attachment_id, $metadata );
 
-                return $attachment_id;
+                return $updated;
         }
 
         /**

src/wp-admin/options-general.php

@@ -142 +142 @@
                         'action' => 'remove_site_icon',
                 ), wp_nonce_url( admin_url( 'options-general.php' ), 'remove-site-icon' ) );
         ?>
-
+        <input type="hidden" name="site_icon" value="<?php echo esc_attr(get_option('site_icon')) ?>" />
         <img class="avatar avatar-150" src="<?php site_icon_url( null, 150 ); ?>" height="150" width="150" />
         <p class="hide-if-no-js">
                 <label class="screen-reader-text" for="choose-from-library-link"><?php _e( 'Choose an image from your media library:' ); ?></label>