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

Timestamp:

02/22/2023 02:23:50 PM (19 months ago)

Author:

SergeyBiryukov

Message:

Media: Add WP_Image_Editor_Imagick::set_imagick_time_limit() method.

This aims to avoid timeout in Imagick operations.

Previously, Imagick operations could silently error by timeout and produce unexpected results. The new ::set_imagick_time_limit() method, now used in ::resize() and ::crop(), will better handle garbage collection in these cases as well as better align Imagick's timeout with PHP timeout, assuming it is set.

Props drzraf, audrasjb, costdev, antpb, SergeyBiryukov.
Fixes #52569.

File:

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

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

@@ -255 +255 @@
 
     /**
+     * Sets Imagick time limit.
+     *
+     * Depending on configuration, Imagick processing may take time.
+     *
+     * Multiple problems exist if PHP times out before ImageMagick completed:
+     * 1. Temporary files aren't cleaned by ImageMagick garbage collection.
+     * 2. No clear error is provided.
+     * 3. The cause of such timeout can be hard to pinpoint.
+     *
+     * This function, which is expected to be run before heavy image routines, resolves
+     * point 1 above by aligning Imagick's timeout with PHP's timeout, assuming it is set.
+     *
+     * Note:
+     *  - Imagick resource exhaustion does not issue catchable exceptions (yet).
+     *    See https://github.com/Imagick/imagick/issues/333.
+     *  - The resource limit is not saved/restored. It applies to subsequent
+     *    image operations within the time of the HTTP request.
+     *
+     * @since 6.2.0
+     *
+     * @return int|null The new limit on success, null on failure.
+     */
+    public static function set_imagick_time_limit() {
+        if ( ! defined( 'Imagick::RESOURCETYPE_TIME' ) ) {
+            return null;
+        }
+
+        // Returns PHP_FLOAT_MAX if unset.
+        $imagick_timeout = Imagick::getResourceLimit( Imagick::RESOURCETYPE_TIME );
+
+        // Convert to an integer, keeping in mind that: 0 === (int) PHP_FLOAT_MAX.
+        $imagick_timeout = $imagick_timeout > PHP_INT_MAX ? PHP_INT_MAX : (int) $imagick_timeout;
+
+        $php_timeout = (int) ini_get( 'max_execution_time' );
+
+        if ( $php_timeout > 1 && $php_timeout < $imagick_timeout ) {
+            $limit = (float) 0.8 * $php_timeout;
+            Imagick::setResourceLimit( Imagick::RESOURCETYPE_TIME, $limit );
+
+            return $limit;
+        }
+    }
+
+    /**
      * Resizes current image.
      *
@@ -283 +327 @@
             return $this->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h );
         }
+
+        self::set_imagick_time_limit();
 
         // Execute the resize.
@@ -550 +596 @@
         }
 
+        self::set_imagick_time_limit();
+
         try {
             $this->image->cropImage( $src_w, $src_h, $src_x, $src_y );