Changeset 49230

Timestamp:

10/20/2020 02:35:10 PM (6 years ago)

Author:

mikeschroder

Message:

Media: Support Stream Wrappers In WP_Image_Editor_Imagick

Since WP_Image_Editor's introduction, stream wrappers have functioned in WP_Image_Editor_GD, but haven't been properly supported in WP_Image_Editor_Imagick.

• Detects stream wrappers and uses file_put_contents() along with Imagick::read/getImageBlob() for handling when necessary.
• Introduces private method, WP_Image_Editor_Imagick::write_image to handle detection and proper saving.
• Introduces WP_Test_Stream class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.

Adds requirement for Imagick::readImageBlob(), available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.

Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.

Location:

trunk

Files:

• src/wp-includes/class-wp-image-editor-imagick.php (modified) (5 diffs)
• src/wp-includes/class-wp-image-editor.php (modified) (1 diff)
• tests/phpunit/includes/class-wp-test-stream.php (added)
• tests/phpunit/tests/image/editor.php (modified) (1 diff)
• tests/phpunit/tests/image/editorImagick.php (modified) (2 diffs)

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

@@ -72 +72 @@
                         'flopimage',
                         'readimage',
+                        'readimageblob',
                 );
 
@@ -128 +129 @@
                 }
 
-                if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) ) {
+                if ( ! is_file( $this->file ) && ! wp_is_stream( $this->file ) ) {
                         return new WP_Error( 'error_loading_image', __( 'File doesn’t exist?' ), $this->file );
                 }
@@ -149 +150 @@
                                 }
                         } else {
-                                $this->image->readImage( $this->file );
+                                if ( wp_is_stream( $this->file ) ) {
+                                        // Due to reports of issues with streams with `Imagick::readImageFile()`, uses `Imagick::readImageBlob()` instead.
+                                        $this->image->readImageBlob( file_get_contents( $this->file ), $this->file );
+                                } else {
+                                        $this->image->readImage( $this->file );
+                                }
                         }
 
@@ -683 +689 @@
 
                         $this->image->setImageFormat( strtoupper( $this->get_extension( $mime_type ) ) );
-                        $this->make_image( $filename, array( $image, 'writeImage' ), array( $filename ) );
-
+                } catch ( Exception $e ) {
+                        return new WP_Error( 'image_save_error', $e->getMessage(), $filename );
+                }
+
+                $write_image_result = $this->write_image( $this->image, $filename );
+                if ( is_wp_error( $write_image_result ) ) {
+                        return $write_image_result;
+                }
+
+                try {
                         // Reset original format.
                         $this->image->setImageFormat( $orig_format );
@@ -704 +718 @@
                         'mime-type' => $mime_type,
                 );
+        }
+
+        /**
+         * Writes an image to a file or stream.
+         *
+         * @since 5.6
+         *
+         * @param Imagick $image
+         * @param string  $filename The destination filename or stream URL.
+         *
+         * @return true|WP_Error
+         */
+        private function write_image( $image, $filename ) {
+                if ( wp_is_stream( $filename ) ) {
+                        /*
+                         * Due to reports of issues with streams with `Imagick::writeImageFile()` and `Imagick::writeImage()`, copies the blob instead.
+                         * Checks for exact type due to: https://www.php.net/manual/en/function.file-put-contents.php
+                         */
+                        if ( file_put_contents( $filename, $image->getImageBlob() ) === false ) {
+                                /* translators: %s: PHP function name. */
+                                return new WP_Error( 'image_save_error', sprintf( __( '%s failed while writing image to stream.' ), '<code>file_put_contents()</code>' ), $filename );
+                        } else {
+                                return true;
+                        }
+                } else {
+                        try {
+                                return $image->writeImage( $filename );
+                        } catch ( Exception $e ) {
+                                return new WP_Error( 'image_save_error', $e->getMessage(), $filename );
+                        }
+                }
         }
 

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

@@ -366 +366 @@
 
                 if ( ! is_null( $dest_path ) ) {
-                        $_dest_path = realpath( $dest_path );
-                        if ( $_dest_path ) {
-                                $dir = $_dest_path;
+                        if ( ! wp_is_stream( $dest_path ) ) {
+                                $_dest_path = realpath( $dest_path );
+                                if ( $_dest_path ) {
+                                        $dir = $_dest_path;
+                                }
+                        } else {
+                                $dir = $dest_path;
                         }
                 }

trunk/tests/phpunit/tests/image/editor.php

@@ -144 +144 @@
                 // Combo!
                 $this->assertSame( trailingslashit( realpath( get_temp_dir() ) ) . 'canola-new.png', $editor->generate_filename( 'new', realpath( get_temp_dir() ), 'png' ) );
+
+                // Test with a stream destination.
+                $this->assertSame( 'file://testing/path/canola-100x50.jpg', $editor->generate_filename( null, 'file://testing/path' ) );
         }
 

trunk/tests/phpunit/tests/image/editorImagick.php

@@ -17 +17 @@
                 require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
                 require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
+                require_once DIR_TESTROOT . '/includes/class-wp-test-stream.php';
 
                 parent::setUp();
@@ -575 +576 @@
         }
 
+        /**
+         * Test that images can be loaded and written over streams
+         */
+        public function test_streams() {
+                stream_wrapper_register( 'wptest', 'WP_Test_Stream' );
+                WP_Test_Stream::$data = array(
+                        'Tests_Image_Editor_Imagick' => array(
+                                '/read.jpg' => file_get_contents( DIR_TESTDATA . '/images/waffles.jpg' ),
+                        ),
+                );
+
+                $file                 = 'wptest://Tests_Image_Editor_Imagick/read.jpg';
+                $imagick_image_editor = new WP_Image_Editor_Imagick( $file );
+
+                $ret = $imagick_image_editor->load();
+                $this->assertNotWPError( $ret );
+
+                $temp_file = 'wptest://Tests_Image_Editor_Imagick/write.jpg';
+
+                $ret = $imagick_image_editor->save( $temp_file );
+                $this->assertNotWPError( $ret );
+
+                $this->assertSame( $temp_file, $ret['path'] );
+
+                if ( $temp_file !== $ret['path'] ) {
+                        unlink( $ret['path'] );
+                }
+                unlink( $temp_file );
+        }
 }