]> scripts.mit.edu Git - autoinstalls/wordpress.git/blob - wp-includes/class-wp-image-editor-gd.php
Wordpress 4.5.3
[autoinstalls/wordpress.git] / wp-includes / class-wp-image-editor-gd.php
1 <?php
2 /**
3  * WordPress GD Image Editor
4  *
5  * @package WordPress
6  * @subpackage Image_Editor
7  */
8
9 /**
10  * WordPress Image Editor Class for Image Manipulation through GD
11  *
12  * @since 3.5.0
13  * @package WordPress
14  * @subpackage Image_Editor
15  * @uses WP_Image_Editor Extends class
16  */
17 class WP_Image_Editor_GD extends WP_Image_Editor {
18         /**
19          * GD Resource.
20          *
21          * @access protected
22          * @var resource
23          */
24         protected $image;
25
26         public function __destruct() {
27                 if ( $this->image ) {
28                         // we don't need the original in memory anymore
29                         imagedestroy( $this->image );
30                 }
31         }
32
33         /**
34          * Checks to see if current environment supports GD.
35          *
36          * @since 3.5.0
37          *
38          * @static
39          * @access public
40          *
41          * @param array $args
42          * @return bool
43          */
44         public static function test( $args = array() ) {
45                 if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
46                         return false;
47
48                 // On some setups GD library does not provide imagerotate() - Ticket #11536
49                 if ( isset( $args['methods'] ) &&
50                          in_array( 'rotate', $args['methods'] ) &&
51                          ! function_exists('imagerotate') ){
52
53                                 return false;
54                 }
55
56                 return true;
57         }
58
59         /**
60          * Checks to see if editor supports the mime-type specified.
61          *
62          * @since 3.5.0
63          *
64          * @static
65          * @access public
66          *
67          * @param string $mime_type
68          * @return bool
69          */
70         public static function supports_mime_type( $mime_type ) {
71                 $image_types = imagetypes();
72                 switch( $mime_type ) {
73                         case 'image/jpeg':
74                                 return ($image_types & IMG_JPG) != 0;
75                         case 'image/png':
76                                 return ($image_types & IMG_PNG) != 0;
77                         case 'image/gif':
78                                 return ($image_types & IMG_GIF) != 0;
79                 }
80
81                 return false;
82         }
83
84         /**
85          * Loads image from $this->file into new GD Resource.
86          *
87          * @since 3.5.0
88          * @access protected
89          *
90          * @return bool|WP_Error True if loaded successfully; WP_Error on failure.
91          */
92         public function load() {
93                 if ( $this->image )
94                         return true;
95
96                 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
97                         return new WP_Error( 'error_loading_image', __('File doesn&#8217;t exist?'), $this->file );
98
99                 /**
100                  * Filter the memory limit allocated for image manipulation.
101                  *
102                  * @since 3.5.0
103                  *
104                  * @param int|string $limit Maximum memory limit to allocate for images. Default WP_MAX_MEMORY_LIMIT.
105                  *                          Accepts an integer (bytes), or a shorthand string notation, such as '256M'.
106                  */
107                 // Set artificially high because GD uses uncompressed images in memory
108                 @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
109
110                 $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
111
112                 if ( ! is_resource( $this->image ) )
113                         return new WP_Error( 'invalid_image', __('File is not an image.'), $this->file );
114
115                 $size = @getimagesize( $this->file );
116                 if ( ! $size )
117                         return new WP_Error( 'invalid_image', __('Could not read image size.'), $this->file );
118
119                 if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
120                         imagealphablending( $this->image, false );
121                         imagesavealpha( $this->image, true );
122                 }
123
124                 $this->update_size( $size[0], $size[1] );
125                 $this->mime_type = $size['mime'];
126
127                 return $this->set_quality();
128         }
129
130         /**
131          * Sets or updates current image size.
132          *
133          * @since 3.5.0
134          * @access protected
135          *
136          * @param int $width
137          * @param int $height
138          * @return true
139          */
140         protected function update_size( $width = false, $height = false ) {
141                 if ( ! $width )
142                         $width = imagesx( $this->image );
143
144                 if ( ! $height )
145                         $height = imagesy( $this->image );
146
147                 return parent::update_size( $width, $height );
148         }
149
150         /**
151          * Resizes current image.
152          * Wraps _resize, since _resize returns a GD Resource.
153          *
154          * At minimum, either a height or width must be provided.
155          * If one of the two is set to null, the resize will
156          * maintain aspect ratio according to the provided dimension.
157          *
158          * @since 3.5.0
159          * @access public
160          *
161          * @param  int|null $max_w Image width.
162          * @param  int|null $max_h Image height.
163          * @param  bool     $crop
164          * @return true|WP_Error
165          */
166         public function resize( $max_w, $max_h, $crop = false ) {
167                 if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
168                         return true;
169
170                 $resized = $this->_resize( $max_w, $max_h, $crop );
171
172                 if ( is_resource( $resized ) ) {
173                         imagedestroy( $this->image );
174                         $this->image = $resized;
175                         return true;
176
177                 } elseif ( is_wp_error( $resized ) )
178                         return $resized;
179
180                 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
181         }
182
183         /**
184          *
185          * @param int $max_w
186          * @param int $max_h
187          * @param bool|array $crop
188          * @return resource|WP_Error
189          */
190         protected function _resize( $max_w, $max_h, $crop = false ) {
191                 $dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
192                 if ( ! $dims ) {
193                         return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions'), $this->file );
194                 }
195                 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
196
197                 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
198                 imagecopyresampled( $resized, $this->image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
199
200                 if ( is_resource( $resized ) ) {
201                         $this->update_size( $dst_w, $dst_h );
202                         return $resized;
203                 }
204
205                 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
206         }
207
208         /**
209          * Resize multiple images from a single source.
210          *
211          * @since 3.5.0
212          * @access public
213          *
214          * @param array $sizes {
215          *     An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
216          *
217          *     Either a height or width must be provided.
218          *     If one of the two is set to null, the resize will
219          *     maintain aspect ratio according to the provided dimension.
220          *
221          *     @type array $size {
222          *         Array of height, width values, and whether to crop.
223          *
224          *         @type int  $width  Image width. Optional if `$height` is specified.
225          *         @type int  $height Image height. Optional if `$width` is specified.
226          *         @type bool $crop   Optional. Whether to crop the image. Default false.
227          *     }
228          * }
229          * @return array An array of resized images' metadata by size.
230          */
231         public function multi_resize( $sizes ) {
232                 $metadata = array();
233                 $orig_size = $this->size;
234
235                 foreach ( $sizes as $size => $size_data ) {
236                         if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
237                                 continue;
238                         }
239
240                         if ( ! isset( $size_data['width'] ) ) {
241                                 $size_data['width'] = null;
242                         }
243                         if ( ! isset( $size_data['height'] ) ) {
244                                 $size_data['height'] = null;
245                         }
246
247                         if ( ! isset( $size_data['crop'] ) ) {
248                                 $size_data['crop'] = false;
249                         }
250
251                         $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
252                         $duplicate = ( ( $orig_size['width'] == $size_data['width'] ) && ( $orig_size['height'] == $size_data['height'] ) );
253
254                         if ( ! is_wp_error( $image ) && ! $duplicate ) {
255                                 $resized = $this->_save( $image );
256
257                                 imagedestroy( $image );
258
259                                 if ( ! is_wp_error( $resized ) && $resized ) {
260                                         unset( $resized['path'] );
261                                         $metadata[$size] = $resized;
262                                 }
263                         }
264
265                         $this->size = $orig_size;
266                 }
267
268                 return $metadata;
269         }
270
271         /**
272          * Crops Image.
273          *
274          * @since 3.5.0
275          * @access public
276          *
277          * @param int  $src_x   The start x position to crop from.
278          * @param int  $src_y   The start y position to crop from.
279          * @param int  $src_w   The width to crop.
280          * @param int  $src_h   The height to crop.
281          * @param int  $dst_w   Optional. The destination width.
282          * @param int  $dst_h   Optional. The destination height.
283          * @param bool $src_abs Optional. If the source crop points are absolute.
284          * @return bool|WP_Error
285          */
286         public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
287                 // If destination width/height isn't specified, use same as
288                 // width/height from source.
289                 if ( ! $dst_w )
290                         $dst_w = $src_w;
291                 if ( ! $dst_h )
292                         $dst_h = $src_h;
293
294                 $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
295
296                 if ( $src_abs ) {
297                         $src_w -= $src_x;
298                         $src_h -= $src_y;
299                 }
300
301                 if ( function_exists( 'imageantialias' ) )
302                         imageantialias( $dst, true );
303
304                 imagecopyresampled( $dst, $this->image, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
305
306                 if ( is_resource( $dst ) ) {
307                         imagedestroy( $this->image );
308                         $this->image = $dst;
309                         $this->update_size();
310                         return true;
311                 }
312
313                 return new WP_Error( 'image_crop_error', __('Image crop failed.'), $this->file );
314         }
315
316         /**
317          * Rotates current image counter-clockwise by $angle.
318          * Ported from image-edit.php
319          *
320          * @since 3.5.0
321          * @access public
322          *
323          * @param float $angle
324          * @return true|WP_Error
325          */
326         public function rotate( $angle ) {
327                 if ( function_exists('imagerotate') ) {
328                         $transparency = imagecolorallocatealpha( $this->image, 255, 255, 255, 127 );
329                         $rotated = imagerotate( $this->image, $angle, $transparency );
330
331                         if ( is_resource( $rotated ) ) {
332                                 imagealphablending( $rotated, true );
333                                 imagesavealpha( $rotated, true );
334                                 imagedestroy( $this->image );
335                                 $this->image = $rotated;
336                                 $this->update_size();
337                                 return true;
338                         }
339                 }
340                 return new WP_Error( 'image_rotate_error', __('Image rotate failed.'), $this->file );
341         }
342
343         /**
344          * Flips current image.
345          *
346          * @since 3.5.0
347          * @access public
348          *
349          * @param bool $horz Flip along Horizontal Axis
350          * @param bool $vert Flip along Vertical Axis
351          * @return true|WP_Error
352          */
353         public function flip( $horz, $vert ) {
354                 $w = $this->size['width'];
355                 $h = $this->size['height'];
356                 $dst = wp_imagecreatetruecolor( $w, $h );
357
358                 if ( is_resource( $dst ) ) {
359                         $sx = $vert ? ($w - 1) : 0;
360                         $sy = $horz ? ($h - 1) : 0;
361                         $sw = $vert ? -$w : $w;
362                         $sh = $horz ? -$h : $h;
363
364                         if ( imagecopyresampled( $dst, $this->image, 0, 0, $sx, $sy, $w, $h, $sw, $sh ) ) {
365                                 imagedestroy( $this->image );
366                                 $this->image = $dst;
367                                 return true;
368                         }
369                 }
370                 return new WP_Error( 'image_flip_error', __('Image flip failed.'), $this->file );
371         }
372
373         /**
374          * Saves current in-memory image to file.
375          *
376          * @since 3.5.0
377          * @access public
378          *
379          * @param string|null $filename
380          * @param string|null $mime_type
381          * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
382          */
383         public function save( $filename = null, $mime_type = null ) {
384                 $saved = $this->_save( $this->image, $filename, $mime_type );
385
386                 if ( ! is_wp_error( $saved ) ) {
387                         $this->file = $saved['path'];
388                         $this->mime_type = $saved['mime-type'];
389                 }
390
391                 return $saved;
392         }
393
394         /**
395          * @param resource $image
396          * @param string|null $filename
397          * @param string|null $mime_type
398          * @return WP_Error|array
399          */
400         protected function _save( $image, $filename = null, $mime_type = null ) {
401                 list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
402
403                 if ( ! $filename )
404                         $filename = $this->generate_filename( null, null, $extension );
405
406                 if ( 'image/gif' == $mime_type ) {
407                         if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) )
408                                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
409                 }
410                 elseif ( 'image/png' == $mime_type ) {
411                         // convert from full colors to index colors, like original PNG.
412                         if ( function_exists('imageistruecolor') && ! imageistruecolor( $image ) )
413                                 imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );
414
415                         if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) )
416                                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
417                 }
418                 elseif ( 'image/jpeg' == $mime_type ) {
419                         if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) )
420                                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
421                 }
422                 else {
423                         return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
424                 }
425
426                 // Set correct file permissions
427                 $stat = stat( dirname( $filename ) );
428                 $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
429                 @ chmod( $filename, $perms );
430
431                 /**
432                  * Filter the name of the saved image file.
433                  *
434                  * @since 2.6.0
435                  *
436                  * @param string $filename Name of the file.
437                  */
438                 return array(
439                         'path'      => $filename,
440                         'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
441                         'width'     => $this->size['width'],
442                         'height'    => $this->size['height'],
443                         'mime-type' => $mime_type,
444                 );
445         }
446
447         /**
448          * Returns stream of current image.
449          *
450          * @since 3.5.0
451          * @access public
452          *
453          * @param string $mime_type
454          * @return bool
455          */
456         public function stream( $mime_type = null ) {
457                 list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
458
459                 switch ( $mime_type ) {
460                         case 'image/png':
461                                 header( 'Content-Type: image/png' );
462                                 return imagepng( $this->image );
463                         case 'image/gif':
464                                 header( 'Content-Type: image/gif' );
465                                 return imagegif( $this->image );
466                         default:
467                                 header( 'Content-Type: image/jpeg' );
468                                 return imagejpeg( $this->image, null, $this->get_quality() );
469                 }
470         }
471
472         /**
473          * Either calls editor's save function or handles file as a stream.
474          *
475          * @since 3.5.0
476          * @access protected
477          *
478          * @param string|stream $filename
479          * @param callable $function
480          * @param array $arguments
481          * @return bool
482          */
483         protected function make_image( $filename, $function, $arguments ) {
484                 if ( wp_is_stream( $filename ) )
485                         $arguments[1] = null;
486
487                 return parent::make_image( $filename, $function, $arguments );
488         }
489 }