Wordpress 3.6
[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         protected $image = false; // GD Resource
20
21         function __destruct() {
22                 if ( $this->image ) {
23                         // we don't need the original in memory anymore
24                         imagedestroy( $this->image );
25                 }
26         }
27
28         /**
29          * Checks to see if current environment supports GD.
30          *
31          * @since 3.5.0
32          * @access public
33          *
34          * @return boolean
35          */
36         public static function test( $args = array() ) {
37                 if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
38                         return false;
39
40                 // On some setups GD library does not provide imagerotate() - Ticket #11536
41                 if ( isset( $args['methods'] ) &&
42                          in_array( 'rotate', $args['methods'] ) &&
43                          ! function_exists('imagerotate') ){
44
45                                 return false;
46                 }
47
48                 return true;
49         }
50
51         /**
52          * Checks to see if editor supports the mime-type specified.
53          *
54          * @since 3.5.0
55          * @access public
56          *
57          * @param string $mime_type
58          * @return boolean
59          */
60         public static function supports_mime_type( $mime_type ) {
61                 $image_types = imagetypes();
62                 switch( $mime_type ) {
63                         case 'image/jpeg':
64                                 return ($image_types & IMG_JPG) != 0;
65                         case 'image/png':
66                                 return ($image_types & IMG_PNG) != 0;
67                         case 'image/gif':
68                                 return ($image_types & IMG_GIF) != 0;
69                 }
70
71                 return false;
72         }
73
74         /**
75          * Loads image from $this->file into new GD Resource.
76          *
77          * @since 3.5.0
78          * @access protected
79          *
80          * @return boolean|\WP_Error
81          */
82         public function load() {
83                 if ( $this->image )
84                         return true;
85
86                 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
87                         return new WP_Error( 'error_loading_image', __('File doesn&#8217;t exist?'), $this->file );
88
89                 // Set artificially high because GD uses uncompressed images in memory
90                 @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
91                 $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
92
93                 if ( ! is_resource( $this->image ) )
94                         return new WP_Error( 'invalid_image', __('File is not an image.'), $this->file );
95
96                 $size = @getimagesize( $this->file );
97                 if ( ! $size )
98                         return new WP_Error( 'invalid_image', __('Could not read image size.'), $this->file );
99
100                 if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
101                         imagealphablending( $this->image, false );
102                         imagesavealpha( $this->image, true );
103                 }
104
105                 $this->update_size( $size[0], $size[1] );
106                 $this->mime_type = $size['mime'];
107
108                 return true;
109         }
110
111         /**
112          * Sets or updates current image size.
113          *
114          * @since 3.5.0
115          * @access protected
116          *
117          * @param int $width
118          * @param int $height
119          */
120         protected function update_size( $width = false, $height = false ) {
121                 if ( ! $width )
122                         $width = imagesx( $this->image );
123
124                 if ( ! $height )
125                         $height = imagesy( $this->image );
126
127                 return parent::update_size( $width, $height );
128         }
129
130         /**
131          * Resizes current image.
132          * Wraps _resize, since _resize returns a GD Resource.
133          *
134          * @since 3.5.0
135          * @access public
136          *
137          * @param int $max_w
138          * @param int $max_h
139          * @param boolean $crop
140          * @return boolean|WP_Error
141          */
142         public function resize( $max_w, $max_h, $crop = false ) {
143                 if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
144                         return true;
145
146                 $resized = $this->_resize( $max_w, $max_h, $crop );
147
148                 if ( is_resource( $resized ) ) {
149                         imagedestroy( $this->image );
150                         $this->image = $resized;
151                         return true;
152
153                 } elseif ( is_wp_error( $resized ) )
154                         return $resized;
155
156                 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
157         }
158
159         protected function _resize( $max_w, $max_h, $crop = false ) {
160                 $dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
161                 if ( ! $dims ) {
162                         return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions'), $this->file );
163                 }
164                 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
165
166                 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
167                 imagecopyresampled( $resized, $this->image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
168
169                 if ( is_resource( $resized ) ) {
170                         $this->update_size( $dst_w, $dst_h );
171                         return $resized;
172                 }
173
174                 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
175         }
176
177         /**
178          * Processes current image and saves to disk
179          * multiple sizes from single source.
180          *
181          * 'width' and 'height' are required.
182          * 'crop' defaults to false when not provided.
183          *
184          * @since 3.5.0
185          * @access public
186          *
187          * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... }
188          * @return array
189          */
190         public function multi_resize( $sizes ) {
191                 $metadata = array();
192                 $orig_size = $this->size;
193
194                 foreach ( $sizes as $size => $size_data ) {
195                         if ( ! ( isset( $size_data['width'] ) && isset( $size_data['height'] ) ) )
196                                 continue;
197
198                         if ( ! isset( $size_data['crop'] ) )
199                                 $size_data['crop'] = false;
200
201                         $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
202
203                         if( ! is_wp_error( $image ) ) {
204                                 $resized = $this->_save( $image );
205
206                                 imagedestroy( $image );
207
208                                 if ( ! is_wp_error( $resized ) && $resized ) {
209                                         unset( $resized['path'] );
210                                         $metadata[$size] = $resized;
211                                 }
212                         }
213
214                         $this->size = $orig_size;
215                 }
216
217                 return $metadata;
218         }
219
220         /**
221          * Crops Image.
222          *
223          * @since 3.5.0
224          * @access public
225          *
226          * @param string|int $src The source file or Attachment ID.
227          * @param int $src_x The start x position to crop from.
228          * @param int $src_y The start y position to crop from.
229          * @param int $src_w The width to crop.
230          * @param int $src_h The height to crop.
231          * @param int $dst_w Optional. The destination width.
232          * @param int $dst_h Optional. The destination height.
233          * @param boolean $src_abs Optional. If the source crop points are absolute.
234          * @return boolean|WP_Error
235          */
236         public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
237                 // If destination width/height isn't specified, use same as
238                 // width/height from source.
239                 if ( ! $dst_w )
240                         $dst_w = $src_w;
241                 if ( ! $dst_h )
242                         $dst_h = $src_h;
243
244                 $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
245
246                 if ( $src_abs ) {
247                         $src_w -= $src_x;
248                         $src_h -= $src_y;
249                 }
250
251                 if ( function_exists( 'imageantialias' ) )
252                         imageantialias( $dst, true );
253
254                 imagecopyresampled( $dst, $this->image, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
255
256                 if ( is_resource( $dst ) ) {
257                         imagedestroy( $this->image );
258                         $this->image = $dst;
259                         $this->update_size();
260                         return true;
261                 }
262
263                 return new WP_Error( 'image_crop_error', __('Image crop failed.'), $this->file );
264         }
265
266         /**
267          * Rotates current image counter-clockwise by $angle.
268          * Ported from image-edit.php
269          *
270          * @since 3.5.0
271          * @access public
272          *
273          * @param float $angle
274          * @return boolean|WP_Error
275          */
276         public function rotate( $angle ) {
277                 if ( function_exists('imagerotate') ) {
278                         $rotated = imagerotate( $this->image, $angle, 0 );
279
280                         if ( is_resource( $rotated ) ) {
281                                 imagedestroy( $this->image );
282                                 $this->image = $rotated;
283                                 $this->update_size();
284                                 return true;
285                         }
286                 }
287                 return new WP_Error( 'image_rotate_error', __('Image rotate failed.'), $this->file );
288         }
289
290         /**
291          * Flips current image.
292          *
293          * @since 3.5.0
294          * @access public
295          *
296          * @param boolean $horz Flip along Horizontal Axis
297          * @param boolean $vert Flip along Vertical Axis
298          * @returns boolean|WP_Error
299          */
300         public function flip( $horz, $vert ) {
301                 $w = $this->size['width'];
302                 $h = $this->size['height'];
303                 $dst = wp_imagecreatetruecolor( $w, $h );
304
305                 if ( is_resource( $dst ) ) {
306                         $sx = $vert ? ($w - 1) : 0;
307                         $sy = $horz ? ($h - 1) : 0;
308                         $sw = $vert ? -$w : $w;
309                         $sh = $horz ? -$h : $h;
310
311                         if ( imagecopyresampled( $dst, $this->image, 0, 0, $sx, $sy, $w, $h, $sw, $sh ) ) {
312                                 imagedestroy( $this->image );
313                                 $this->image = $dst;
314                                 return true;
315                         }
316                 }
317                 return new WP_Error( 'image_flip_error', __('Image flip failed.'), $this->file );
318         }
319
320         /**
321          * Saves current in-memory image to file.
322          *
323          * @since 3.5.0
324          * @access public
325          *
326          * @param string $destfilename
327          * @param string $mime_type
328          * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
329          */
330         public function save( $filename = null, $mime_type = null ) {
331                 $saved = $this->_save( $this->image, $filename, $mime_type );
332
333                 if ( ! is_wp_error( $saved ) ) {
334                         $this->file = $saved['path'];
335                         $this->mime_type = $saved['mime-type'];
336                 }
337
338                 return $saved;
339         }
340
341         protected function _save( $image, $filename = null, $mime_type = null ) {
342                 list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
343
344                 if ( ! $filename )
345                         $filename = $this->generate_filename( null, null, $extension );
346
347                 if ( 'image/gif' == $mime_type ) {
348                         if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) )
349                                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
350                 }
351                 elseif ( 'image/png' == $mime_type ) {
352                         // convert from full colors to index colors, like original PNG.
353                         if ( function_exists('imageistruecolor') && ! imageistruecolor( $image ) )
354                                 imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );
355
356                         if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) )
357                                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
358                 }
359                 elseif ( 'image/jpeg' == $mime_type ) {
360                         if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, apply_filters( 'jpeg_quality', $this->quality, 'image_resize' ) ) ) )
361                                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
362                 }
363                 else {
364                         return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
365                 }
366
367                 // Set correct file permissions
368                 $stat = stat( dirname( $filename ) );
369                 $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
370                 @ chmod( $filename, $perms );
371
372                 return array(
373                         'path' => $filename,
374                         'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
375                         'width' => $this->size['width'],
376                         'height' => $this->size['height'],
377                         'mime-type'=> $mime_type,
378                 );
379         }
380
381         /**
382          * Returns stream of current image.
383          *
384          * @since 3.5.0
385          * @access public
386          *
387          * @param string $mime_type
388          */
389         public function stream( $mime_type = null ) {
390                 list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
391
392                 switch ( $mime_type ) {
393                         case 'image/png':
394                                 header( 'Content-Type: image/png' );
395                                 return imagepng( $this->image );
396                         case 'image/gif':
397                                 header( 'Content-Type: image/gif' );
398                                 return imagegif( $this->image );
399                         default:
400                                 header( 'Content-Type: image/jpeg' );
401                                 return imagejpeg( $this->image, null, $this->quality );
402                 }
403         }
404
405         /**
406          * Either calls editor's save function or handles file as a stream.
407          *
408          * @since 3.5.0
409          * @access protected
410          *
411          * @param string|stream $filename
412          * @param callable $function
413          * @param array $arguments
414          * @return boolean
415          */
416         protected function make_image( $filename, $function, $arguments ) {
417                 if ( wp_is_stream( $filename ) )
418                         $arguments[1] = null;
419
420                 return parent::make_image( $filename, $function, $arguments );
421         }
422 }