Changeset 45538 for trunk/src/wp-includes/class-wp-image-editor-imagick.php

Timestamp:

06/15/2019 01:01:48 AM (6 years ago)

Author:

azaozz

Message:

Save progress of intermediate image creation after upload. First run.

• Introduces wp_get_missing_image_subsizes() and wp_update_image_subsizes() to generate image sub-sizes that are missing or were not created after the upload.
• Adds a way to display errors that happened while creating sub-sizes.
• Introduces wp_create_image_subsizes() intended for use after an image was uploaded. It saves/updates the image metadata immediately after each sub-size is created. This fixes the (long standing) problem when some of the sub-size image files were created but there was a timeout or an error and the metadata was not saved. Until now such uploads were considered "failed" which usually resulted in the user trying to upload the same image again, creating even more "orphan" image files.

Note that the patch also includes some unrelated WPCS fixes.

Props mikeschroder, azaozz.
See #40439.

File:

• trunk/src/wp-includes/class-wp-image-editor-imagick.php (modified) (9 diffs)

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -109 +109 @@
         // setIteratorIndex is optional unless mime is an animated format.
         // Here, we just say no if you are missing it and aren't loading a jpeg.
-        if ( ! method_exists( 'Imagick', 'setIteratorIndex' ) && $mime_type != 'image/jpeg' ) {
+        if ( ! method_exists( 'Imagick', 'setIteratorIndex' ) && $mime_type !== 'image/jpeg' ) {
                 return false;
         }
@@ -147 +147 @@
             $filename       = $this->file;
 
-            if ( 'pdf' == $file_extension ) {
+            if ( 'pdf' === $file_extension ) {
                 $filename = $this->pdf_setup();
             }
@@ -194 +194 @@
 
         try {
-            if ( 'image/jpeg' == $this->mime_type ) {
+            if ( 'image/jpeg' === $this->mime_type ) {
                 $this->image->setImageCompressionQuality( $quality );
                 $this->image->setImageCompression( imagick::COMPRESSION_JPEG );
@@ -261 +261 @@
             return new WP_Error( 'error_getting_dimensions', __( 'Could not calculate resized image dimensions' ) );
         }
+
         list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
 
@@ -313 +314 @@
          * Imagick constant is defined or fall back to our default filter.
          */
-        if ( in_array( $filter_name, $allowed_filters ) && defined( 'Imagick::' . $filter_name ) ) {
+        if ( in_array( $filter_name, $allowed_filters, true ) && defined( 'Imagick::' . $filter_name ) ) {
             $filter = constant( 'Imagick::' . $filter_name );
         } else {
@@ -362 +363 @@
 
             // Set appropriate quality settings after resizing.
-            if ( 'image/jpeg' == $this->mime_type ) {
+            if ( 'image/jpeg' === $this->mime_type ) {
                 if ( is_callable( array( $this->image, 'unsharpMaskImage' ) ) ) {
                     $this->image->unsharpMaskImage( 0.25, 0.25, 8, 0.065 );
@@ -414 +415 @@
      *
      * @param array $sizes {
-     *     An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
+     *     An array of image size arrays. Default sizes are 'thumbnail', 'medium', 'medium_large', 'large'.
      *
      *     Either a height or width must be provided.
@@ -431 +432 @@
      */
     public function multi_resize( $sizes ) {
-        $metadata   = array();
+        $metadata = array();
+
+        foreach ( $sizes as $size => $size_data ) {
+            $meta = $this->make_subsize( $size_data );
+
+            if ( ! is_wp_error( $meta ) ) {
+                $metadata[ $size ] = $meta;
+            }
+        }
+
+        return $metadata;
+    }
+
+    /**
+     * Create an image sub-size and return the image meta data value for it.
+     *
+     * @since 5.3.0
+     *
+     * @param array $size_data Array of width, height, and whether to crop.
+     * @return WP_Error|array WP_Error on error, or the image data array for inclusion in the `sizes` array in the image meta.
+     */
+    public function make_subsize( $size_data ) {
+        if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
+            return new WP_Error( 'image_subsize_create_error', __( 'Cannot resize the image. Both width and height are not set.' ) );
+        }
+
         $orig_size  = $this->size;
         $orig_image = $this->image->getImage();
 
-        foreach ( $sizes as $size => $size_data ) {
-            if ( ! $this->image ) {
-                $this->image = $orig_image->getImage();
-            }
-
-            if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
-                continue;
-            }
-
-            if ( ! isset( $size_data['width'] ) ) {
-                $size_data['width'] = null;
-            }
-            if ( ! isset( $size_data['height'] ) ) {
-                $size_data['height'] = null;
-            }
-
-            if ( ! isset( $size_data['crop'] ) ) {
-                $size_data['crop'] = false;
-            }
-
-            $resize_result = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
-            $duplicate     = ( ( $orig_size['width'] == $size_data['width'] ) && ( $orig_size['height'] == $size_data['height'] ) );
-
-            if ( ! is_wp_error( $resize_result ) && ! $duplicate ) {
-                $resized = $this->_save( $this->image );
-
-                $this->image->clear();
-                $this->image->destroy();
-                $this->image = null;
-
-                if ( ! is_wp_error( $resized ) && $resized ) {
-                    unset( $resized['path'] );
-                    $metadata[ $size ] = $resized;
-                }
-            }
-
-            $this->size = $orig_size;
-        }
-
+        if ( ! isset( $size_data['width'] ) ) {
+            $size_data['width'] = null;
+        }
+
+        if ( ! isset( $size_data['height'] ) ) {
+            $size_data['height'] = null;
+        }
+
+        if ( ! isset( $size_data['crop'] ) ) {
+            $size_data['crop'] = false;
+        }
+
+        $resized = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
+
+        if ( is_wp_error( $resized ) ) {
+            $saved = $resized;
+        } else {
+            $saved = $this->_save( $this->image );
+
+            $this->image->clear();
+            $this->image->destroy();
+            $this->image = null;
+        }
+
+        $this->size  = $orig_size;
         $this->image = $orig_image;
 
-        return $metadata;
+        if ( ! is_wp_error( $saved ) ) {
+            unset( $saved['path'] );
+        }
+
+        return $saved;
     }
 
@@ -718 +734 @@
             // Strip profiles.
             foreach ( $this->image->getImageProfiles( '*', true ) as $key => $value ) {
-                if ( ! in_array( $key, $protected_profiles ) ) {
+                if ( ! in_array( $key, $protected_profiles, true ) ) {
                     $this->image->removeImageProfile( $key );
                 }