1: <?php
  2: 
  3: /**
  4:  * Library for image handling using the Imagick library of functions
  5:  *
  6:  * Requires Imagick 3.0.0+ and ImageMagick 6.3.8+
  7:  *
  8:  * @package core
  9:  */
 10: // force UTF-8 Ø
 11: 
 12: define('IMAGICK_REQUIRED_VERSION', '3.0.0');
 13: define('IMAGEMAGICK_REQUIRED_VERSION', '6.3.8');
 14: 
 15: $_imagick_version = phpversion('imagick');
 16: $_imagick_version_pass = version_compare($_imagick_version, IMAGICK_REQUIRED_VERSION, '>=');
 17: 
 18: $_imagemagick_version = '';
 19: $_imagemagick_version_pass = false;
 20: 
 21: $_zp_imagick_present = extension_loaded('imagick') && $_imagick_version_pass;
 22: 
 23: if ($_zp_imagick_present) {
 24:     @$_imagemagick_version = Imagick::getVersion();
 25:     preg_match('/\d+(\.\d+)*/', $_imagemagick_version['versionString'], $matches);
 26: 
 27:     $_imagemagick_version['versionNumber'] = $matches[0];
 28:     $_imagemagick_version_pass = version_compare($_imagemagick_version['versionNumber'], IMAGEMAGICK_REQUIRED_VERSION, '>=');
 29: 
 30:     $_zp_imagick_present &= $_imagick_version_pass;
 31:     unset($matches);
 32: }
 33: 
 34: $_zp_graphics_optionhandlers += array('lib_Imagick_Options' => new lib_Imagick_Options());
 35: 
 36: /**
 37:  * Option class for lib-Imagick
 38:  */
 39: class lib_Imagick_Options {
 40: 
 41:     public static $ignore_size = 0;
 42: 
 43:     function __construct() {
 44:         setOptionDefault('magick_max_height', self::$ignore_size);
 45:         setOptionDefault('magick_max_width', self::$ignore_size);
 46: 
 47:         if (!sanitize_numeric(getOption('magick_max_height'))) {
 48:             setOption('magick_max_height', self::$ignore_size);
 49:         }
 50: 
 51:         if (!sanitize_numeric(getOption('magick_max_width'))) {
 52:             setOption('magick_max_width', self::$ignore_size);
 53:         }
 54:     }
 55: 
 56:     /**
 57:      * Standard option interface
 58:      *
 59:      * @return array
 60:      */
 61:     function getOptionsSupported() {
 62:         global $_zp_imagick_present, $_zp_graphics_optionhandlers;
 63:         if ($disabled = $this->canLoadMsg()) {
 64:             setOption('use_imagick', 0, true);
 65:         }
 66:         $imagickOptions = array(
 67:                         gettext('Enable Imagick') => array(
 68:                                         'key'            => 'use_imagick',
 69:                                         'type'       => OPTION_TYPE_CHECKBOX,
 70:                                         'order'      => 0,
 71:                                         'disabled' => $disabled,
 72:                                         'desc'       => ($disabled) ? '<p class="notebox">' . $disabled . '</p>' : gettext('Your PHP has support for Imagick. Check this option if you wish to use the Imagick graphics library.')
 73:                         )
 74:         );
 75: 
 76:         if (!$disabled) {
 77:             $imagickOptions += array(
 78:                             gettext('Max height')    => array(
 79:                                             'key'        => 'magick_max_height',
 80:                                             'type'   => OPTION_TYPE_TEXTBOX,
 81:                                             'order'  => 1,
 82:                                             'desc'   => sprintf(gettext('The maximum height used by the site for processed images. Set to %d for unconstrained. Default is <strong>%d</strong>'), self::$ignore_size, self::$ignore_size)
 83:                             ),
 84:                             gettext('Max width')     => array(
 85:                                             'key'        => 'magick_max_width',
 86:                                             'type'   => OPTION_TYPE_TEXTBOX,
 87:                                             'order'  => 2,
 88:                                             'desc'   => sprintf(gettext('The maximum width used by the site for processed images. Set to %d for unconstrained. Default is <strong>%d</strong>.'), self::$ignore_size, self::$ignore_size)
 89:                             )
 90:             );
 91:         }
 92: 
 93:         return $imagickOptions;
 94:     }
 95: 
 96:     function canLoadMsg() {
 97:         global $_imagick_version_pass, $_imagemagick_version_pass;
 98: 
 99:         if (extension_loaded('imagick')) {
100:             if (!$_imagick_version_pass) {
101:                 return sprintf(gettext('The <strong><em>Imagick</em></strong> library version must be <strong>%s</strong> or later.'), IMAGICK_REQUIRED_VERSION);
102:             }
103: 
104:             if (!$_imagemagick_version_pass) {
105:                 return sprintf(gettext('The <strong><em>ImageMagick</em></strong> binary version must be <strong>%s</strong> or later.'), IMAGEMAGICK_REQUIRED_VERSION);
106:             }
107:         } else {
108:             return gettext('The <strong><em>Imagick</em></strong> extension is not available.');
109:         }
110: 
111:         return '';
112:     }
113: 
114: }
115: 
116: /**
117:  * Zenphoto image manipulation functions using the Imagick library
118:  */
119: if ($_zp_imagick_present && (getOption('use_imagick') || !extension_loaded('gd'))) {
120:     $_lib_Imagick_info = array();
121:     $_lib_Imagick_info['Library'] = 'Imagick';
122:     $_lib_Imagick_info['Library_desc'] = sprintf(gettext('PHP Imagick library <em>%s</em>') . '<br /><em>%s</em>', $_imagick_version, $_imagemagick_version['versionString']);
123: 
124:     $_imagick_format_whitelist = array(
125:                     'BMP'        => 'jpg', 'BMP2'    => 'jpg', 'BMP3'    => 'jpg',
126:                     'GIF'        => 'gif', 'GIF87'   => 'gif',
127:                     'JPG'        => 'jpg', 'JPEG'    => 'jpg',
128:                     'PNG'        => 'png', 'PNG8'    => 'png', 'PNG24'   => 'png', 'PNG32'   => 'png',
129:                     'TIFF'   => 'jpg', 'TIFF64' => 'jpg'
130:     );
131: 
132:     $_imagick = new Imagick();
133:     $_imagick_formats = $_imagick->queryFormats();
134:     foreach ($_imagick_formats as $format) {
135:         if (array_key_exists($format, $_imagick_format_whitelist)) {
136:             $_lib_Imagick_info[$format] = $_imagick_format_whitelist[$format];
137:         }
138:     }
139:     unset($_imagick_format_whitelist);
140:     unset($_imagick_formats);
141:     unset($_imagick);
142:     unset($format);
143: 
144:     if (DEBUG_IMAGE) {
145:         debugLog('Loading ' . $_lib_Imagick_info['Library']);
146:     }
147: 
148:     /**
149:      * Takes an image filename and returns an Imagick image object
150:      *
151:      * @param string $imgfile the full path and filename of the image to load
152:      * @return Imagick
153:      */
154:     function zp_imageGet($imgfile) {
155:         global $_lib_Imagick_info;
156: 
157:         if (array_key_exists(strtoupper(getSuffix($imgfile)), $_lib_Imagick_info)) {
158:             $image = new Imagick();
159: 
160:             $maxHeight = getOption('magick_max_height');
161:             $maxWidth = getOption('magick_max_width');
162: 
163:             if ($maxHeight > lib_Imagick_Options::$ignore_size && $maxWidth > lib_Imagick_Options::$ignore_size) {
164:                 $image->setOption('jpeg:size', $maxWidth . 'x' . $maxHeight);
165:             }
166: 
167:             $image->readImage(filesystemToInternal($imgfile));
168: 
169:             //Generic CMYK to RGB conversion
170:             if ($image->getImageColorspace() == Imagick::COLORSPACE_CMYK) {
171:                 $image->transformimagecolorspace(Imagick::COLORSPACE_SRGB);
172:             }
173: 
174:             return $image;
175:         }
176: 
177:         return false;
178:     }
179: 
180:     /**
181:      * Outputs an image resource as a given type
182:      *
183:      * @param Imagick $im
184:      * @param string $type
185:      * @param string $filename
186:      * @param int $qual
187:      * @return bool
188:      */
189:     function zp_imageOutput($im, $type, $filename = NULL, $qual = 75) {
190:         $interlace = getOption('image_interlace');
191:         $qual = max(min($qual, 100), 0);
192: 
193:         $im->setImageFormat($type);
194: 
195:         switch ($type) {
196:             case 'gif':
197:                 $im->setImageCompression(Imagick::COMPRESSION_LZW);
198:                 $im->setImageCompressionQuality($qual);
199: 
200:                 if ($interlace) {
201:                     $im->setInterlaceScheme(Imagick::INTERLACE_GIF);
202:                 }
203: 
204:                 break;
205: 
206:             case 'jpeg':
207:             case 'jpg':
208:                 $im->setImageCompression(Imagick::COMPRESSION_JPEG);
209:                 $im->setImageCompressionQuality($qual);
210: 
211:                 if ($interlace) {
212:                     $im->setInterlaceScheme(Imagick::INTERLACE_JPEG);
213:                 }
214: 
215:                 break;
216: 
217:             case 'png':
218:                 $im->setImageCompression(Imagick::COMPRESSION_ZIP);
219:                 $im->setImageCompressionQuality($qual);
220: 
221:                 if ($interlace) {
222:                     $im->setInterlaceScheme(Imagick::INTERLACE_PNG);
223:                 }
224: 
225:                 break;
226:         }
227: 
228:         $im->optimizeImageLayers();
229: 
230:         if ($filename == NULL) {
231:             header('Content-Type: image/' . $type);
232: 
233:             return print $im->getImagesBlob();
234:         }
235: 
236:         return $im->writeImages(filesystemToInternal($filename), true);
237:     }
238: 
239:     /**
240:      * Creates a true color image
241:      *
242:      * @param int $w the width of the image
243:      * @param int $h the height of the image
244:      * @return Imagick
245:      */
246:     function zp_createImage($w, $h) {
247:         $im = new Imagick();
248:         $im->newImage($w, $h, 'none');
249:         $im->setImageType(Imagick::IMGTYPE_TRUECOLORMATTE);
250: 
251:         return $im;
252:     }
253: 
254:     /**
255:      * Fills an image area
256:      *
257:      * @param Imagick $image
258:      * @param int $x
259:      * @param int $y
260:      * @param color $color
261:      * @return bool
262:      */
263:     function zp_imageFill($image, $x, $y, $color) {
264:         $target = $image->getImagePixelColor($x, $y);
265: 
266:         return $image->floodFillPaintImage($color, 1, $target, $x, $y, false);
267:     }
268: 
269:     /**
270:      * Sets the transparency color
271:      *
272:      * @param Imagick $image
273:      * @param color $color
274:      * @return bool
275:      */
276:     function zp_imageColorTransparent($image, $color) {
277:         return $image->transparentPaintImage($color, 0.0, 1, false);
278:     }
279: 
280:     /**
281:      * Copies an image canvas
282:      *
283:      * @param Imagick $imgCanvas destination canvas
284:      * @param Imagick $img source canvas
285:      * @param int $dest_x destination x
286:      * @param int $dest_y destination y
287:      * @param int $src_x source x
288:      * @param int $src_y source y
289:      * @param int $w width
290:      * @param int $h height
291:      * @return bool
292:      */
293:     function zp_copyCanvas($imgCanvas, $img, $dest_x, $dest_y, $src_x, $src_y, $w, $h) {
294:         $img->cropImage($w, $h, $src_x, $src_y);
295:         $result = true;
296:         foreach ($imgCanvas as $frame) {
297:             $result &= $frame->compositeImage($img, Imagick::COMPOSITE_OVER, $dest_x, $dest_y);
298:         }
299:         return $result;
300:     }
301: 
302:     /**
303:      * Resamples an image to a new copy
304:      *
305:      * @param Imagick $dst_image
306:      * @param Imagick $src_image
307:      * @param int $dst_x
308:      * @param int $dst_y
309:      * @param int $src_x
310:      * @param int $src_y
311:      * @param int $dst_w
312:      * @param int $dst_h
313:      * @param int $src_w
314:      * @param int $src_h
315:      * @return bool
316:      */
317:     function zp_resampleImage($dst_image, $src_image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) {
318:         foreach ($src_image->getImageProfiles() as $name => $profile) {
319:             $dst_image->profileImage($name, $profile);
320:         }
321:         $result = true;
322:         $src_image = $src_image->coalesceImages();
323:         foreach ($src_image as $frame) {
324:             $frame->cropImage($src_w, $src_h, $src_x, $src_y);
325:             $frame->setImagePage(0, 0, 0, 0);
326:             $frame->resizeImage($dst_w, $dst_h, Imagick::FILTER_LANCZOS, 1);
327: 
328:             $dst_image->setImageDelay($frame->getImageDelay());
329:             $result &= $dst_image->compositeImage($frame, Imagick::COMPOSITE_OVER, $dst_x, $dst_y);
330: 
331:             if ($dst_image->getNumberImages() < $src_image->getNumberImages()) {
332:                 $result &= $dst_image->addImage(zp_createImage($dst_image->getImageWidth(), $dst_image->getImageHeight()));
333:             }
334:             if (!$result) {
335:                 break;
336:             }
337:         }
338:         return $result;
339:     }
340: 
341:     /**
342:      * Sharpens an image using an Unsharp Mask filter.
343:      *
344:      * @param Imagick $img the image to sharpen
345:      * @param int $amount the strength of the sharpening effect
346:      * @param int $radius the pixel radius of the sharpening mask
347:      * @param int $threshold the color difference threshold required for sharpening
348:      * @return Imagick
349:      */
350:     function zp_imageUnsharpMask($img, $amount, $radius, $threshold) {
351:         $img->unsharpMaskImage($radius, 0.1, $amount, $threshold);
352: 
353:         return $img;
354:     }
355: 
356:     /**
357:      * Resize a file with transparency to given dimensions and still retain the alpha channel information
358:      *
359:      * @param Imagick $src
360:      * @param int $w
361:      * @param int $h
362:      * @return Imagick
363:      */
364:     function zp_imageResizeAlpha($src, $w, $h) {
365:         $src->scaleImage($w, $h);
366: 
367:         return $src;
368:     }
369: 
370:     /**
371:      * Returns true if Imagick library is configured with image rotation support
372:      *
373:      * @return bool
374:      */
375:     function zp_imageCanRotate() {
376:         return true;
377:     }
378: 
379:     /**
380:      * Rotates an image resource according to its Orientation setting
381:      *
382:      * @param Imagick $im
383:      * @param int $rotate
384:      * @return Imagick
385:      */
386:     function zp_rotateImage($im, $rotate) {
387:         $im->rotateImage('none', 360 - $rotate);
388:         return $im;
389:     }
390: 
391:     /**
392:      * Returns the image height and width
393:      *
394:      * @param string $filename
395:      * @param array $imageinfo
396:      * @return array
397:      */
398:     function zp_imageDims($filename) {
399:         $ping = new Imagick();
400: 
401:         if ($ping->pingImage(filesystemToInternal($filename))) {
402:             return array('width' => $ping->getImageWidth(), 'height' => $ping->getImageHeight());
403:         }
404: 
405:         return false;
406:     }
407: 
408:     /**
409:      * Returns the IPTC data of an image
410:      *
411:      * @param string $filename
412:      * @return string
413:      */
414:     function zp_imageIPTC($filename) {
415:         $ping = new Imagick();
416: 
417:         if ($ping->pingImage(filesystemToInternal($filename))) {
418:             try {
419:                 return $ping->getImageProfile('iptc');
420:             } catch (ImagickException $e) {
421:                 // IPTC profile does not exist
422:             }
423:         }
424: 
425:         return false;
426:     }
427: 
428:     /**
429:      * Returns the width of an image resource
430:      *
431:      * @param Imagick $im
432:      * @return int
433:      */
434:     function zp_imageWidth($im) {
435:         return $im->getImageWidth();
436:     }
437: 
438:     /**
439:      * Returns the height of an image resource
440:      *
441:      * @param Imagick $im
442:      * @return int
443:      */
444:     function zp_imageHeight($im) {
445:         return $im->getImageHeight();
446:     }
447: 
448:     /**
449:      * Does a copy merge of two image resources
450:      *
451:      * @param Imagick $dst_im
452:      * @param Imagick $src_im
453:      * @param int $dst_x
454:      * @param int $dst_y
455:      * @param int $src_x
456:      * @param int $src_y
457:      * @param int $src_w
458:      * @param int $src_h
459:      * @param int $pct
460:      * @return bool
461:      */
462:     function zp_imageMerge($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $pct) {
463:         $src_im->cropImage($src_w, $src_h, $src_x, $src_y);
464:         $src_im->setImageOpacity($pct / 100);
465: 
466:         return $dst_im->compositeImage($src_im, Imagick::COMPOSITE_OVER, $dst_x, $dst_y);
467:     }
468: 
469:     /**
470:      * Creates a grayscale image
471:      *
472:      * @param Imagick $image The image to grayscale
473:      * @return Imagick
474:      */
475:     function zp_imageGray($image) {
476:         $image->setType(Imagick::IMGTYPE_GRAYSCALE);
477:         $image->setImageColorspace(Imagick::COLORSPACE_GRAY);
478:         $image->setImageProperty('exif:ColorSpace', Imagick::IMGTYPE_GRAYSCALE);
479: 
480:         return $image;
481:     }
482: 
483:     /**
484:      * Destroys an image resource
485:      *
486:      * @param Imagick $im
487:      * @return bool
488:      */
489:     function zp_imageKill($im) {
490:         return $im->destroy();
491:     }
492: 
493:     /**
494:      * Returns an RGB color identifier
495:      *
496:      * @param Imagick $image
497:      * @param int $red
498:      * @param int $green
499:      * @param int $blue
500:      * @return ImagickPixel
501:      */
502:     function zp_colorAllocate($image, $red, $green, $blue) {
503:         return new ImagickPixel("rgb($red, $green, $blue)");
504:     }
505: 
506:     /**
507:      * Renders a string into the image
508:      *
509:      * @param Imagick $image
510:      * @param ImagickDraw $font
511:      * @param int $x
512:      * @param int $y
513:      * @param string $string
514:      * @param ImagickPixel $color
515:      * @return bool
516:      */
517:     function zp_writeString($image, $font, $x, $y, $string, $color) {
518:         $font->setStrokeColor($color);
519: 
520:         return $image->annotateImage($font, $x, $y + $image->getImageHeight() / 2, 0, $string);
521:     }
522: 
523:     /**
524:      * Creates a rectangle
525:      *
526:      * @param Imagick $image
527:      * @param int $x1
528:      * @param int $y1
529:      * @param int $x2
530:      * @param int $y2
531:      * @param ImagickPixel $color
532:      * @return bool
533:      */
534:     function zp_drawRectangle($image, $x1, $y1, $x2, $y2, $color) {
535:         return $image->borderImage($color, 1, 1);
536:     }
537: 
538:     /**
539:      * Returns array of graphics library info
540:      *
541:      * @return array
542:      */
543:     function zp_graphicsLibInfo() {
544:         global $_lib_Imagick_info;
545: 
546:         return $_lib_Imagick_info;
547:     }
548: 
549:     /**
550:      * Returns a list of available fonts
551:      *
552:      * @return array
553:      */
554:     function zp_getFonts() {
555:         global $_imagick_fontlist;
556: 
557:         if (!is_array($_imagick_fontlist)) {
558:             @$_imagick_fontlist = Imagick::queryFonts();
559:             $_imagick_fontlist = array('system' => '') + array_combine($_imagick_fontlist, $_imagick_fontlist);
560: 
561:             $basefile = SERVERPATH . '/' . USER_PLUGIN_FOLDER . '/imagick_fonts/';
562: 
563:             if (is_dir($basefile)) {
564:                 chdir($basefile);
565:                 $filelist = safe_glob('*.ttf');
566: 
567:                 foreach ($filelist as $file) {
568:                     $key = filesystemToInternal(str_replace('.ttf', '', $file));
569:                     $_imagick_fontlist[$key] = getcwd() . '/' . $file;
570:                 }
571:             }
572: 
573:             chdir(dirname(__FILE__));
574:         }
575: 
576:         return $_imagick_fontlist;
577:     }
578: 
579:     /**
580:      * Loads a font and returns an object with the font loaded
581:      *
582:      * @param string $font
583:      * @return ImagickDraw
584:      */
585:     function zp_imageLoadFont($font = NULL, $size = 18) {
586:         $draw = new ImagickDraw();
587: 
588:         if (!empty($font)) {
589:             $draw->setFont($font);
590:         }
591: 
592:         $draw->setFontSize($size);
593: 
594:         return $draw;
595:     }
596: 
597:     /**
598:      * Returns the font width in pixels
599:      *
600:      * @param ImagickDraw $font
601:      * @return int
602:      */
603:     function zp_imageFontWidth($font) {
604:         $temp = new Imagick();
605:         $metrics = $temp->queryFontMetrics($font, "The quick brown fox jumps over the lazy dog");
606:         $temp->destroy();
607: 
608:         return $metrics['characterWidth'];
609:     }
610: 
611:     /**
612:      * Returns the font height in pixels
613:      *
614:      * @param ImagickDraw $font
615:      * @return int
616:      */
617:     function zp_imageFontHeight($font) {
618:         $temp = new Imagick();
619:         $metrics = $temp->queryFontMetrics($font, "The quick brown fox jumps over the lazy dog");
620:         $temp->destroy();
621: 
622:         return $metrics['characterHeight'];
623:     }
624: 
625:     /**
626:      * Creates an image from an image stream
627:      *
628:      * @param $string
629:      * @return Imagick
630:      */
631:     function zp_imageFromString($string) {
632:         $im = new Imagick();
633: 
634:         $maxHeight = getOption('magick_max_height');
635:         $maxWidth = getOption('magick_max_width');
636: 
637:         if ($maxHeight > lib_Imagick_Options::$ignore_size && $maxWidth > lib_Imagick_Options::$ignore_size) {
638:             $im->setOption('jpeg:size', $maxWidth . 'x' . $maxHeight);
639:         }
640: 
641:         $im->readImageBlob($string);
642: 
643:         return $im;
644:     }
645: 
646: }
647: ?>
648: