?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Fixing syntax error in Image_GD->_do_save(), fixes #1953
[kohana-image.git] / classes / image / gd.php
blob2789cc0b43586d942a3df661638f842049f291f8
1 <?php defined('SYSPATH') or die('No direct script access.');
2 /**
3 * Image manipulation class using {@link http://php.net/gd GD}.
4 *
5 * @package Image
6 * @author Kohana Team
7 * @copyright (c) 2008-2009 Kohana Team
8 * @license http://kohanaphp.com/license.html
9 */
10 class Image_GD extends Image {
11
12 public static function check()
13 {
14 if ( ! function_exists('gd_info'))
15 {
16 throw new Kohana_Exception('GD is either not installed or not enabled, check your configuration');
17 }
18
19 if (defined('GD_VERSION'))
20 {
21 // Get the version via a constant, available in PHP 5.2.4+
22 $version = GD_VERSION;
23 }
24 else
25 {
26 // Get the version information
27 $version = current(gd_info());
28
29 // Extract the version number
30 preg_match('/\d+\.\d+(?:\.\d+)?/', $version, $matches);
31
32 // Get the major version
33 $version = $matches[0];
34 }
35
36 if ( ! version_compare($version, '2.0', '>='))
37 {
38 throw new Kohana_Exception('Image_GD requires GD version 2.0 or greater, you have :version',
39 array(':version' => $version));
40 }
41
42 return Image_GD::$_checked = TRUE;
43 }
44
45 // Temporary image resource
46 protected $_image;
47
48 public function __construct($file)
49 {
50 if ( ! Image_GD::$_checked)
51 {
52 // Run the install check
53 Image_GD::check();
54 }
55
56 parent::__construct($file);
57
58 // Set the image creation function name
59 switch ($this->type)
60 {
61 case IMAGETYPE_JPEG:
62 $create = 'imagecreatefromjpeg';
63 break;
64 case IMAGETYPE_GIF:
65 $create = 'imagecreatefromgif';
66 break;
67 case IMAGETYPE_PNG:
68 $create = 'imagecreatefrompng';
69 break;
70 }
71
72 if ( ! isset($create) OR ! function_exists($create))
73 {
74 throw new Kohana_Exception('Installed GD does not support :type images',
75 array(':type' => image_type_to_extension($this->type, FALSE)));
76 }
77
78 // Open the temporary image
79 $this->_image = $create($this->file);
80
81 // Preserve transparency when saving
82 imagesavealpha($this->_image, TRUE);
83 }
84
85 public function __destruct()
86 {
87 if (is_resource($this->_image))
88 {
89 // Free all resources
90 imagedestroy($this->_image);
91 }
92 }
93
94 protected function _do_resize($width, $height)
95 {
96 // Presize width and height
97 $pre_width = $this->width;
98 $pre_height = $this->height;
99
100 // Test if we can do a resize without resampling to speed up the final resize
101 if ($width > ($this->width / 2) AND $height > ($this->height / 2))
102 {
103 // The maximum reduction is 10% greater than the final size
104 $reduction_width = round($width * 1.1);
105 $reduction_height = round($height * 1.1);
106
107 while ($pre_width / 2 > $reduction_width AND $pre_height / 2 > $reduction_height)
108 {
109 // Reduce the size using an O(2n) algorithm, until it reaches the maximum reduction
110 $pre_width /= 2;
111 $pre_height /= 2;
112 }
113
114 // Create the temporary image to copy to
115 $image = $this->_create($pre_width, $pre_height);
116
117 if (imagecopyresized($image, $this->_image, 0, 0, 0, 0, $pre_width, $pre_height, $this->width, $this->height))
118 {
119 // Swap the new image for the old one
120 imagedestroy($this->_image);
121 $this->_image = $image;
122 }
123 }
124
125 // Create the temporary image to copy to
126 $image = $this->_create($width, $height);
127
128 // Execute the resize
129 if (imagecopyresampled($image, $this->_image, 0, 0, 0, 0, $width, $height, $pre_width, $pre_height))
130 {
131 // Swap the new image for the old one
132 imagedestroy($this->_image);
133 $this->_image = $image;
134
135 // Reset the width and height
136 $this->width = imagesx($image);
137 $this->height = imagesy($image);
138 }
139 }
140
141 protected function _do_crop($width, $height, $offset_x, $offset_y)
142 {
143 // Create the temporary image to copy to
144 $image = $this->_create($width, $height);
145
146 // Execute the crop
147 if (imagecopyresampled($image, $this->_image, 0, 0, $offset_x, $offset_y, $width, $height, $width, $height))
148 {
149 // Swap the new image for the old one
150 imagedestroy($this->_image);
151 $this->_image = $image;
152
153 // Reset the width and height
154 $this->width = imagesx($image);
155 $this->height = imagesy($image);
156 }
157 }
158
159 protected function _do_rotate($degrees)
160 {
161 // Transparent black will be used as the background for the uncovered region
162 $transparent = imagecolorallocatealpha($this->_image, 0, 0, 0, 127);
163
164 // Rotate, setting the transparent color
165 $image = imagerotate($this->_image, 360 - $degrees, $transparent, 1);
166
167 // Save the alpha of the rotated image
168 imagesavealpha($image, TRUE);
169
170 // Get the width and height of the rotated image
171 $width = imagesx($image);
172 $height = imagesy($image);
173
174 if (imagecopymerge($this->_image, $image, 0, 0, 0, 0, $width, $height, 100))
175 {
176 // Swap the new image for the old one
177 imagedestroy($this->_image);
178 $this->_image = $image;
179
180 // Reset the width and height
181 $this->width = $width;
182 $this->height = $height;
183 }
184 }
185
186 protected function _do_flip($direction)
187 {
188 // Create the flipped image
189 $flipped = $this->_create($this->width, $this->height);
190
191 if ($direction === Image::HORIZONTAL)
192 {
193 for ($x = 0; $x < $this->width; $x++)
194 {
195 // Flip each row from top to bottom
196 imagecopy($flipped, $this->_image, $x, 0, $this->width - $x - 1, 0, 1, $this->height);
197 }
198 }
199 else
200 {
201 for ($y = 0; $y < $this->height; $y++)
202 {
203 // Flip each column from left to right
204 imagecopy($flipped, $this->_image, 0, $y, 0, $this->height - $y - 1, $this->width, 1);
205 }
206 }
207
208 // Swap the new image for the old one
209 imagedestroy($this->_image);
210 $this->_image = $flipped;
211
212 // Reset the width and height
213 $this->width = imagesx($flipped);
214 $this->height = imagesy($flipped);
215 }
216
217 protected function _do_sharpen($amount)
218 {
219 // Amount should be in the range of 18-10
220 $amount = round(abs(-18 + ($amount * 0.08)), 2);
221
222 // Gaussian blur matrix
223 $matrix = array
224 (
225 array(-1, -1, -1),
226 array(-1, $amount, -1),
227 array(-1, -1, -1),
228 );
229
230 // Perform the sharpen
231 if ($image = imageconvolution($this->_image, $matrix, $amount - 8, 0))
232 {
233 // Swap the new image for the old one
234 imagedestroy($this->_image);
235 $this->_image = $image;
236
237 // Reset the width and height
238 $this->width = imagesx($image);
239 $this->height = imagesy($image);
240 }
241 }
242
243 protected function _do_reflection($height, $opacity, $fade_in)
244 {
245 // Convert an opacity range of 0-100 to 127-0
246 $opacity = round(abs(($opacity * 127 / 100) - 127));
247
248 if ($opacity < 127)
249 {
250 // Calculate the opacity stepping
251 $stepping = (127 - $opacity) / $height;
252 }
253 else
254 {
255 // Avoid a "divide by zero" error
256 $stepping = 127 / $height;
257 }
258
259 // Create the reflection image
260 $reflection = $this->_create($this->width, $this->height + $height);
261
262 // Copy the image to the reflection
263 imagecopy($reflection, $this->_image, 0, 0, 0, 0, $this->width, $this->height);
264
265 for ($offset = 0; $height >= $offset; $offset++)
266 {
267 // Read the next line down
268 $src_y = $this->height - $offset - 1;
269
270 // Place the line at the bottom of the reflection
271 $dst_y = $this->height + $offset;
272
273 if ($fade_in === TRUE)
274 {
275 // Start with the most transparent line first
276 $dst_opacity = round($opacity + ($stepping * ($height - $offset)));
277 }
278 else
279 {
280 // Start with the most opaque line first
281 $dst_opacity = round($opacity + ($stepping * $offset));
282 }
283
284 // Create a single line of the image
285 $line = $this->_create($this->width, 1);
286
287 // Copy a single line from the current image into the line
288 imagecopy($line, $this->_image, 0, 0, 0, $src_y, $this->width, 1);
289
290 // Colorize the line to add the correct alpha level
291 imagefilter($line, IMG_FILTER_COLORIZE, 0, 0, 0, $dst_opacity);
292
293 // Copy a the line into the reflection
294 imagecopy($reflection, $line, 0, $dst_y, 0, 0, $this->width, 1);
295 }
296
297 // Swap the new image for the old one
298 imagedestroy($this->_image);
299 $this->_image = $reflection;
300
301 // Reset the width and height
302 $this->width = imagesx($reflection);
303 $this->height = imagesy($reflection);
304 }
305
306 protected function _do_watermark(Image $watermark, $offset_x, $offset_y, $opacity)
307 {
308 // Create the watermark image resource
309 $overlay = imagecreatefromstring($watermark->render());
310
311 // Get the width and height of the watermark
312 $width = imagesx($overlay);
313 $height = imagesy($overlay);
314
315 if ($opacity < 100)
316 {
317 // Convert an opacity range of 0-100 to 127-0
318 $opacity = round(abs(($opacity * 127 / 100) - 127));
319
320 // Allocate transparent white
321 $color = imagecolorallocatealpha($overlay, 255, 255, 255, $opacity);
322
323 // The transparent image will overlay the watermark
324 imagelayereffect($overlay, IMG_EFFECT_OVERLAY);
325
326 // Fill the background with transparent white
327 imagefilledrectangle($overlay, 0, 0, $width, $height, $color);
328 }
329
330 // Alpha blending must be enabled on the background!
331 imagealphablending($this->_image, TRUE);
332
333 if (imagecopy($this->_image, $overlay, $offset_x, $offset_y, 0, 0, $width, $height))
334 {
335 // Destroy the overlay image
336 imagedestroy($overlay);
337 }
338 }
339
340 protected function _do_background($r, $g, $b, $opacity)
341 {
342 // Convert an opacity range of 0-100 to 127-0
343 $opacity = round(abs(($opacity * 127 / 100) - 127));
344
345 // Create a new background
346 $background = $this->_create($this->width, $this->height);
347
348 // Allocate the color
349 $color = imagecolorallocatealpha($background, $r, $g, $b, $opacity);
350
351 // Fill the image with white
352 imagefilledrectangle($background, 0, 0, $this->width, $this->height, $color);
353
354 // Alpha blending must be enabled on the background!
355 imagealphablending($background, TRUE);
356
357 // Copy the image onto a white background to remove all transparency
358 if (imagecopy($background, $this->_image, 0, 0, 0, 0, $this->width, $this->height))
359 {
360 // Swap the new image for the old one
361 imagedestroy($this->_image);
362 $this->_image = $background;
363 }
364 }
365
366 protected function _do_save($file, $quality)
367 {
368 // Get the extension of the file
369 $extension = pathinfo($file, PATHINFO_EXTENSION);
370
371 // Get the save function and IMAGETYPE
372 list($save, $type) = $this->_save_function($extension, $quality);
373
374 // Save the image to a file
375 $status = isset($quality) ? $save($this->_image, NULL, $quality) : $save($this->_image, NULL);
376
377 if ($status === TRUE AND $type !== $this->type)
378 {
379 // Reset the image type and mime type
380 $this->type = $type;
381 $this->mime = image_type_to_mime_type($type);
382 }
383
384 return TRUE;
385 }
386
387 protected function _do_render($type, $quality)
388 {
389 // Get the save function and IMAGETYPE
390 list($save, $type) = $this->_save_function($type, $quality);
391
392 // Capture the output
393 ob_start();
394
395 // Render the image
396 $status = isset($quality) ? $save($this->_image, NULL, $quality) : $save($this->_image, NULL);
397
398 if ($status === TRUE AND $type !== $this->type)
399 {
400 // Reset the image type and mime type
401 $this->type = $type;
402 $this->mime = image_type_to_mime_type($type);
403 }
404
405 return ob_get_clean();
406 }
407
408 /**
409 * Get the GD saving function and image type for this extension.
410 * Also normalizes the quality setting
411 *
412 * @throws Kohana_Exception
413 * @param string image type: png, jpg, etc
414 * @param integer image quality
415 * @return array save function, IMAGETYPE_* constant
416 */
417 protected function _save_function($extension, & $quality)
418 {
419 switch ($extension)
420 {
421 case 'jpg':
422 case 'jpeg':
423 // Save a JPG file
424 $save = 'imagejpeg';
425 $type = IMAGETYPE_JPEG;
426 break;
427 case 'gif':
428 // Save a GIF file
429 $save = 'imagegif';
430 $type = IMAGETYPE_GIF;
431
432 // GIFs do not a quality setting
433 $quality = NULL;
434 break;
435 case 'png':
436 // Save a PNG file
437 $save = 'imagepng';
438 $type = IMAGETYPE_PNG;
439
440 // Use a compression level of 9 (does not affect quality!)
441 $quality = 9;
442 break;
443 default:
444 throw new Kohana_Exception('Installed GD does not support :type images',
445 array(':type' => $type));
446 break;
447 }
448
449 return array($save, $type);
450 }
451
452 /**
453 * Create an empty image with the given width and height.
454 *
455 * @param integer image width
456 * @param integer image height
457 * @return resource
458 */
459 protected function _create($width, $height)
460 {
461 // Create an empty image
462 $image = imagecreatetruecolor($width, $height);
463
464 // Do not apply alpha blending
465 imagealphablending($image, FALSE);
466
467 // Save alpha levels
468 imagesavealpha($image, TRUE);
469
470 return $image;
471 }
472
473 } // End Image_GD