Ticket #42663: imagick.5.diff

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

@@ -21 +21 @@
          */
         protected $image;
 
+        /**
+         * Generated temporary files
+         *
+         * @var array
+         */
+        private $_tmp;
+
         public function __destruct() {
                 if ( $this->image instanceof Imagick ) {
                         // we don't need the original in memory anymore
                         $this->image->clear();
                         $this->image->destroy();
                 }
+                // if we have processed files from stream wrappers remove the local copies
+                if ( is_array( $this->_tmp ) ) {
+                        foreach ( $this->_tmp as $tmpfile ) {
+                                @unlink( $tmpfile );
+                        }
+                }
         }
 
         /**
@@ -133 +146 @@
                 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
                         return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
+                $local_file = $this->file;
+                if ( wp_is_stream( $this->file ) ) {
+                        $local_file = wp_tempnam();
+
+                        if ( empty( $this->_tmp ) ) {
+                                $this->_tmp = array();
+                        }
+                        $this->_tmp[] = $local_file;
+
+                        if ( false === @copy( $this->file, $local_file ) ) {
+                                return new WP_Error( 'error_loading_image', __( 'File doesn’t exist?' ), error_get_last() );
+                        }
+                }
+
                 /*
                  * Even though Imagick uses less PHP memory than GD, set higher limit
                  * for users that have low PHP.ini limits.
@@ -142 +169 @@
                 try {
                         $this->image = new Imagick();
                         $file_extension = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
-                        $filename = $this->file;
+                        $filename = $local_file;
 
                         if ( 'pdf' == $file_extension ) {
-                                $filename = $this->pdf_setup();
+                                $filename = $this->pdf_setup( $local_file );
                         }
 
                         // Reading image after Imagick instantiation because `setResolution`
@@ -735 +762 @@
          *
          * @return string|WP_Error File to load or WP_Error on failure.
          */
-        protected function pdf_setup() {
+        protected function pdf_setup( $local_file ) {
                 try {
                         // By default, PDFs are rendered in a very low resolution.
                         // We want the thumbnail to be readable, so increase the rendering DPI.
                         $this->image->setResolution( 128, 128 );
 
                         // Only load the first page.
-                        return $this->file . '[0]';
+                        return $local_file . '[0]';
                 }
                 catch ( Exception $e ) {
                         return new WP_Error( 'pdf_setup_failed', $e->getMessage(), $this->file );
                 }
         }
 
+        /**
+         * Either calls editor's save function or handles file as a stream.
+         *
+         * @param string|stream $filename
+         * @param callable $function
+         * @param array $arguments
+         * @return bool
+         */
+        protected function make_image( $filename, $function, $arguments ) {
+                if ( wp_is_stream( $filename ) ) {
+                        $tmp = wp_tempnam();
+                        if ( empty( $this->_tmp ) ) {
+                                $this->_tmp = array();
+                        }
+                        $this->_tmp[] = $tmp;
+
+                        $arguments[0] = $tmp;
+                }
+
+                if ( ! parent::make_image( $filename, $function, $arguments ) ) {
+                        return false;
+                }
+
+                if ( wp_is_stream( $filename ) ) {
+                        return copy( $tmp, $filename );
+                }
+        }
 }

new file tests/phpunit/includes/class-wp-test-stream.php

@@ +1 @@
+<?php
+class WP_Test_Stream {
+        const FILE_MODE      = 33206; // 100666 in octal
+        const DIRECTORY_MODE = 16895; // 40777 in octal
+
+        static $data = array();
+
+        var $position;
+        var $file;
+        var $bucket;
+
+        private function open( $path ) {
+                $url = array_merge(
+                        array(
+                                'host' => '',
+                                'path' => '',
+                        ),
+                        parse_url( $path )
+                );
+
+                $this->bucket = $url['host'];
+                $this->file   = $url['path'] ? $url['path'] : '/';
+
+                if ( empty( $this->bucket ) ) {
+                        trigger_error( 'Cannot use an empty bucket name', E_USER_ERROR );
+                }
+
+                if ( ! isset( WP_Test_Stream::$data[ $this->bucket ] ) ) {
+                        WP_Test_Stream::$data[ $this->bucket ] = array();
+                }
+
+                $this->position = 0;
+        }
+
+        function stream_open( $path, $mode, $options, &$opened_path ) {
+                $this->open( $path );
+                return true;
+        }
+
+        function stream_read( $count ) {
+                if ( ! isset( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) ) {
+                        return '';
+                }
+
+                $ret             = substr( WP_Test_Stream::$data[ $this->bucket ][ $this->file ], $this->position, $count );
+                $this->position += strlen( $ret );
+                return $ret;
+        }
+
+        function stream_write( $data ) {
+                if ( ! isset( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) ) {
+                        WP_Test_Stream::$data[ $this->bucket ][ $this->file ] = '';
+                }
+
+                $left  = substr( WP_Test_Stream::$data[ $this->bucket ][ $this->file ], 0, $this->position );
+                $right = substr( WP_Test_Stream::$data[ $this->bucket ][ $this->file ], $this->position + strlen( $data ) );
+                WP_Test_Stream::$data[ $this->bucket ][ $this->file ] = $left . $data . $right;
+                $this->position                                      += strlen( $data );
+                return strlen( $data );
+        }
+
+        function stream_tell() {
+                return $this->position;
+        }
+
+        function stream_eof() {
+                if ( ! isset( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) ) {
+                        return true;
+                }
+
+                return $this->position >= strlen( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] );
+        }
+
+        function stream_seek( $offset, $whence ) {
+                switch ( $whence ) {
+                        case SEEK_SET:
+                                if ( $offset < strlen( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) && $offset >= 0 ) {
+                                        $this->position = $offset;
+                                        return true;
+                                } else {
+                                        return false;
+                                }
+                                break;
+
+                        case SEEK_CUR:
+                                if ( $offset >= 0 ) {
+                                        $this->position += $offset;
+                                        return true;
+                                } else {
+                                        return false;
+                                }
+                                break;
+
+                        case SEEK_END:
+                                if ( strlen( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) + $offset >= 0 ) {
+                                        $this->position = strlen( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) + $offset;
+                                        return true;
+                                } else {
+                                        return false;
+                                }
+                                break;
+
+                        default:
+                                return false;
+                }
+        }
+
+        function stream_metadata( $path, $option, $var ) {
+                $this->open( $path );
+                if ( STREAM_META_TOUCH == $option ) {
+                        if ( ! isset( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) ) {
+                                WP_Test_Stream::$data[ $this->bucket ][ $this->file ] = '';
+                        }
+                        return true;
+                }
+                return false;
+        }
+
+        function mkdir( $path, $mode, $options ) {
+                $this->open( $path );
+                if ( isset( WP_Test_Stream::$data[ $this->bucket ][ rtrim( $this->file, '/' ) ] ) ) {
+                        return false;
+                }
+                WP_Test_Stream::$data[ $this->bucket ][ rtrim( $this->file, '/' ) . '/' ] = 'DIRECTORY';
+                return true;
+        }
+
+        private function make_stat( $stats ) {
+                $defaults = array(
+                        'dev'     => 0,
+                        'ino'     => 0,
+                        'mode'    => 0,
+                        'nlink'   => 0,
+                        'uid'     => 0,
+                        'gid'     => 0,
+                        'rdev'    => 0,
+                        'size'    => 0,
+                        'atime'   => 0,
+                        'mtime'   => 0,
+                        'ctime'   => 0,
+                        'blksize' => 0,
+                        'blocks'  => 0,
+                );
+
+                return array_merge( $defaults, $stats );
+        }
+
+        public function stream_stat() {
+                if ( substr( $this->file, -1 ) == '/' || isset( WP_Test_Stream::$data[ $this->bucket ][ rtrim( $this->file, '/' ) . '/' ] ) ) {
+                        return $this->make_stat(
+                                array(
+                                        'mode' => WP_Test_Stream::DIRECTORY_MODE,
+                                )
+                        );
+                }
+
+                if ( ! isset( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ) ) {
+                        return false;
+                }
+
+                return $this->make_stat(
+                        array(
+                                'size' => strlen( WP_Test_Stream::$data[ $this->bucket ][ $this->file ] ),
+                                'mode' => WP_Test_Stream::FILE_MODE,
+                        )
+                );
+        }
+
+        public function url_stat( $path, $flags ) {
+                $this->open( $path );
+                return $this->stream_stat();
+        }
+}

new file tests/phpunit/tests/image/streams.php

@@ +1 @@
+<?php
+
+/**
+ * @group image
+ * @group media
+ * @group upload
+ */
+class Tests_Image_Stream_Wrappers extends WP_UnitTestCase {
+
+        /**
+         * Setup test fixture
+         */
+        public function setUp() {
+                parent::setUp();
+
+                require_once( ABSPATH . WPINC . '/class-wp-image-editor.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-image-editor-gd.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-image-editor-imagick.php' );
+
+                require_once( DIR_TESTDATA . '/../includes/class-wp-test-stream.php' );
+                include_once( DIR_TESTDATA . '/../includes/mock-image-editor.php' );
+
+                if ( in_array( 'dummy', stream_get_wrappers() ) ) {
+                        stream_wrapper_unregister( 'dummy' );
+                }
+                stream_wrapper_register( 'dummy', 'WP_Test_Stream' );
+                WP_Test_Stream::$data = array();
+
+                // Ensure no legacy / failed tests detritus.
+                $folder = '/tmp/wordpress-gsoc-flyer*.{jpg,pdf}';
+
+                foreach ( glob( $folder, GLOB_BRACE ) as $file ) {
+                        unlink( $file );
+                }
+        }
+
+        public function image_editor_class() {
+                return array(
+                        array( 'WP_Image_Editor_GD' ),
+                        array( 'WP_Image_Editor_Imagick' ),
+                );
+        }
+
+        /**
+         * @dataProvider image_editor_class
+         */
+        public function test_save_to_stream_wrappers( $class ) {
+                // If the image editor isn't available, skip it
+                if ( ! call_user_func( array( $class, 'test' ) ) ) {
+                        $this->markTestSkipped( "$class is not available" );
+                }
+
+                $img = new $class( DIR_TESTDATA . '/images/canola.jpg' );
+                $this->assertNotInstanceOf( 'WP_Error', $img );
+                $loaded = $img->load();
+                $this->assertTrue( $loaded );
+
+                $new_filename = 'dummy://test/canola.jpg';
+                $this->assertTrue( wp_is_stream( $new_filename ) );
+
+                $ret = $img->save( $new_filename );
+                $this->assertNotInstanceOf( 'WP_Error', $ret );
+                $this->assertArrayHasKey( '/canola.jpg', WP_Test_Stream::$data['test'] );
+
+                // Clean up
+                unset( $img );
+        }
+
+        /**
+         * @dataProvider image_editor_class
+         */
+        public function test_load_from_stream_wrappers( $class ) {
+                // If the image editor isn't available, skip it
+                if ( ! call_user_func( array( $class, 'test' ) ) ) {
+                        $this->markTestSkipped( "$class is not available" );
+                }
+
+                $filename = 'dummy://test/canola.jpg';
+                $this->assertTrue( copy( DIR_TESTDATA . '/images/canola.jpg', $filename ) );
+                $this->assertArrayHasKey( '/canola.jpg', WP_Test_Stream::$data['test'] );
+
+                $img = new $class( $filename );
+                $this->assertNotInstanceOf( 'WP_Error', $img );
+                $loaded = $img->load();
+                $this->assertTrue( $loaded );
+
+                // Clean up
+                unset( $img );
+        }
+
+        /**
+         * @dataProvider image_editor_class
+         */
+        public function test_image_manipulation( $class ) {
+                // If the image editor isn't available, skip it
+                if ( ! call_user_func( array( $class, 'test' ) ) ) {
+                        $this->markTestSkipped( "$class is not available" );
+                }
+
+                $filename = 'dummy://test/canola.jpg';
+                $this->assertTrue( copy( DIR_TESTDATA . '/images/canola.jpg', $filename ) );
+                $this->assertArrayHasKey( '/canola.jpg', WP_Test_Stream::$data['test'] );
+
+                $img = new $class( $filename );
+                $this->assertNotInstanceOf( 'WP_Error', $img );
+                $loaded = $img->load();
+                $this->assertTrue( $loaded );
+
+                $cropped = $img->crop( 0, 0, 100, 100 );
+                $this->assertNotInstanceOf( 'WP_Error', $cropped );
+
+                $ret = $img->save( 'dummy://test/canola-100x100.jpg' );
+                $this->assertNotInstanceOf( 'WP_Error', $ret );
+                $this->assertArrayHasKey( '/canola-100x100.jpg', WP_Test_Stream::$data['test'] );
+
+                $orig_content    = WP_Test_Stream::$data['test']['/canola.jpg'];
+                $resized_content = WP_Test_Stream::$data['test']['/canola-100x100.jpg'];
+
+                $this->assertFalse( $orig_content == $resized_content );
+
+                // Clean up
+                unset( $img );
+        }
+
+        /**
+         * @dataProvider image_editor_class
+         */
+
+        public function test_image_upload( $class ) {
+                // If the image editor isn't available, skip it
+                if ( ! call_user_func( array( $class, 'test' ) ) ) {
+                        $this->markTestSkipped( "$class is not available" );
+                }
+
+                add_filter(
+                        'wp_image_editors',
+                        function ( $editors ) use ( $class ) {
+                                return array( $class );
+                        }
+                );
+
+                add_filter(
+                        'upload_dir',
+                        function ( $dir ) {
+                                $dir['base_dir'] = 'dummy://test/uploads';
+                                $dir['path']     = 'dummy://test/uploads' . $dir['subdir'];
+                                return $dir;
+                        }
+                );
+
+                $filename = DIR_TESTDATA . '/images/canola.jpg';
+                $contents = file_get_contents( $filename );
+                $upload   = wp_upload_bits( basename( $filename ), null, $contents );
+                $this->assertTrue( empty( $upload['error'] ), print_r( $upload, true ) );
+                $id = $this->_make_attachment( $upload );
+
+                $path = wp_upload_dir()['path'];
+                $this->assertEquals( substr( $path, 0, 13 ), 'dummy://test/' );
+
+                $this->assertFileExists( sprintf( '%s/%s', $path, 'canola.jpg' ) );
+                $this->assertFileExists( sprintf( '%s/%s', $path, 'canola-150x150.jpg' ) );
+                $this->assertFileExists( sprintf( '%s/%s', $path, 'canola-300x225.jpg' ) );
+        }
+
+}
+
+/* vim: set ft=php.wp: */