3 * @file src/Object/Image.php
4 * @brief This file contains the Image class for image processing
6 namespace Friendica\Object;
9 use Friendica\Core\Cache;
10 use Friendica\Core\Config;
11 use Friendica\Core\L10n;
12 use Friendica\Core\System;
13 use Friendica\Database\DBM;
14 use Friendica\Model\Photo;
15 use Friendica\Util\Network;
21 * Class to handle images
28 * Put back gd stuff, not everybody have Imagick
38 * @brief supported mimetypes and corresponding file extensions
41 public static function supportedTypes()
43 if (class_exists('Imagick')) {
44 // Imagick::queryFormats won't help us a lot there...
45 // At least, not yet, other parts of friendica uses this array
47 'image/jpeg' => 'jpg',
53 $t['image/jpeg'] ='jpg';
54 if (imagetypes() & IMG_PNG) {
55 $t['image/png'] = 'png';
64 * @param object $data data
65 * @param boolean $type optional, default null
68 public function __construct($data, $type = null)
70 $this->imagick = class_exists('Imagick');
71 $this->types = static::supportedTypes();
72 if (!array_key_exists($type, $this->types)) {
77 if ($this->isImagick() && $this->loadData($data)) {
80 // Failed to load with Imagick, fallback
81 $this->imagick = false;
83 return $this->loadData($data);
90 public function __destruct()
93 if ($this->isImagick()) {
94 $this->image->clear();
95 $this->image->destroy();
98 if (is_resource($this->image)) {
99 imagedestroy($this->image);
107 public function isImagick()
109 return $this->imagick;
113 * @brief Maps Mime types to Imagick formats
114 * @return array With with image formats (mime type as key)
116 public static function getFormatsMap()
119 'image/jpeg' => 'JPG',
120 'image/png' => 'PNG',
127 * @param object $data data
130 private function loadData($data)
132 if ($this->isImagick()) {
133 $this->image = new Imagick();
135 $this->image->readImageBlob($data);
136 } catch (Exception $e) {
137 // Imagick couldn't use the data
142 * Setup the image to the format it will be saved to
144 $map = self::getFormatsMap();
145 $format = $map[$this->type];
146 $this->image->setFormat($format);
148 // Always coalesce, if it is not a multi-frame image it won't hurt anyway
149 $this->image = $this->image->coalesceImages();
152 * setup the compression here, so we'll do it only once
154 switch ($this->getType()) {
156 $quality = Config::get('system', 'png_quality');
157 if ((! $quality) || ($quality > 9)) {
158 $quality = PNG_QUALITY;
161 * From http://www.imagemagick.org/script/command-line-options.php#quality:
163 * 'For the MNG and PNG image formats, the quality value sets
164 * the zlib compression level (quality / 10) and filter-type (quality % 10).
165 * The default PNG "quality" is 75, which means compression level 7 with adaptive PNG filtering,
166 * unless the image has a color map, in which case it means compression level 7 with no PNG filtering'
168 $quality = $quality * 10;
169 $this->image->setCompressionQuality($quality);
172 $quality = Config::get('system', 'jpeg_quality');
173 if ((! $quality) || ($quality > 100)) {
174 $quality = JPEG_QUALITY;
176 $this->image->setCompressionQuality($quality);
179 // The 'width' and 'height' properties are only used by non-Imagick routines.
180 $this->width = $this->image->getImageWidth();
181 $this->height = $this->image->getImageHeight();
187 $this->valid = false;
188 $this->image = @imagecreatefromstring($data);
189 if ($this->image !== false) {
190 $this->width = imagesx($this->image);
191 $this->height = imagesy($this->image);
193 imagealphablending($this->image, false);
194 imagesavealpha($this->image, true);
205 public function isValid()
207 if ($this->isImagick()) {
208 return ($this->image !== false);
216 public function getWidth()
218 if (!$this->isValid()) {
222 if ($this->isImagick()) {
223 return $this->image->getImageWidth();
231 public function getHeight()
233 if (!$this->isValid()) {
237 if ($this->isImagick()) {
238 return $this->image->getImageHeight();
240 return $this->height;
246 public function getImage()
248 if (!$this->isValid()) {
252 if ($this->isImagick()) {
254 $this->image = $this->image->deconstructImages();
263 public function getType()
265 if (!$this->isValid()) {
275 public function getExt()
277 if (!$this->isValid()) {
281 return $this->types[$this->getType()];
285 * @param integer $max max dimension
288 public function scaleDown($max)
290 if (!$this->isValid()) {
294 $width = $this->getWidth();
295 $height = $this->getHeight();
297 $dest_width = $dest_height = 0;
299 if ((! $width)|| (! $height)) {
303 if ($width > $max && $height > $max) {
304 // very tall image (greater than 16:9)
305 // constrain the width - let the height float.
307 if ((($height * 9) / 16) > $width) {
309 $dest_height = intval(($height * $max) / $width);
310 } elseif ($width > $height) {
311 // else constrain both dimensions
313 $dest_height = intval(($height * $max) / $width);
315 $dest_width = intval(($width * $max) / $height);
321 $dest_height = intval(($height * $max) / $width);
323 if ($height > $max) {
324 // very tall image (greater than 16:9)
325 // but width is OK - don't do anything
327 if ((($height * 9) / 16) > $width) {
328 $dest_width = $width;
329 $dest_height = $height;
331 $dest_width = intval(($width * $max) / $height);
335 $dest_width = $width;
336 $dest_height = $height;
341 return $this->scale($dest_width, $dest_height);
345 * @param integer $degrees degrees to rotate image
348 public function rotate($degrees)
350 if (!$this->isValid()) {
354 if ($this->isImagick()) {
355 $this->image->setFirstIterator();
357 $this->image->rotateImage(new ImagickPixel(), -$degrees); // ImageMagick rotates in the opposite direction of imagerotate()
358 } while ($this->image->nextImage());
362 // if script dies at this point check memory_limit setting in php.ini
363 $this->image = imagerotate($this->image, $degrees, 0);
364 $this->width = imagesx($this->image);
365 $this->height = imagesy($this->image);
369 * @param boolean $horiz optional, default true
370 * @param boolean $vert optional, default false
373 public function flip($horiz = true, $vert = false)
375 if (!$this->isValid()) {
379 if ($this->isImagick()) {
380 $this->image->setFirstIterator();
383 $this->image->flipImage();
386 $this->image->flopImage();
388 } while ($this->image->nextImage());
392 $w = imagesx($this->image);
393 $h = imagesy($this->image);
394 $flipped = imagecreate($w, $h);
396 for ($x = 0; $x < $w; $x++) {
397 imagecopy($flipped, $this->image, $x, 0, $w - $x - 1, 0, 1, $h);
401 for ($y = 0; $y < $h; $y++) {
402 imagecopy($flipped, $this->image, 0, $y, 0, $h - $y - 1, $w, 1);
405 $this->image = $flipped;
409 * @param string $filename filename
412 public function orient($filename)
414 if ($this->isImagick()) {
415 // based off comment on http://php.net/manual/en/imagick.getimageorientation.php
416 $orientation = $this->image->getImageOrientation();
417 switch ($orientation) {
418 case Imagick::ORIENTATION_BOTTOMRIGHT:
419 $this->image->rotateimage("#000", 180);
421 case Imagick::ORIENTATION_RIGHTTOP:
422 $this->image->rotateimage("#000", 90);
424 case Imagick::ORIENTATION_LEFTBOTTOM:
425 $this->image->rotateimage("#000", -90);
429 $this->image->setImageOrientation(Imagick::ORIENTATION_TOPLEFT);
432 // based off comment on http://php.net/manual/en/function.imagerotate.php
434 if (!$this->isValid()) {
438 if ((!function_exists('exif_read_data')) || ($this->getType() !== 'image/jpeg')) {
442 $exif = @exif_read_data($filename, null, true);
447 $ort = $exif['IFD0']['Orientation'];
453 case 2: // horizontal flip
457 case 3: // 180 rotate left
461 case 4: // vertical flip
462 $this->flip(false, true);
465 case 5: // vertical flip + 90 rotate right
466 $this->flip(false, true);
470 case 6: // 90 rotate right
474 case 7: // horizontal flip + 90 rotate right
479 case 8: // 90 rotate left
484 // logger('exif: ' . print_r($exif,true));
489 * @param integer $min minimum dimension
492 public function scaleUp($min)
494 if (!$this->isValid()) {
498 $width = $this->getWidth();
499 $height = $this->getHeight();
501 $dest_width = $dest_height = 0;
503 if ((!$width)|| (!$height)) {
507 if ($width < $min && $height < $min) {
508 if ($width > $height) {
510 $dest_height = intval(($height * $min) / $width);
512 $dest_width = intval(($width * $min) / $height);
518 $dest_height = intval(($height * $min) / $width);
520 if ($height < $min) {
521 $dest_width = intval(($width * $min) / $height);
524 $dest_width = $width;
525 $dest_height = $height;
530 return $this->scale($dest_width, $dest_height);
534 * @param integer $dim dimension
537 public function scaleToSquare($dim)
539 if (!$this->isValid()) {
543 return $this->scale($dim, $dim);
547 * @brief Scale image to target dimensions
549 * @param int $dest_width
550 * @param int $dest_height
553 private function scale($dest_width, $dest_height)
555 if (!$this->isValid()) {
559 if ($this->isImagick()) {
561 * If it is not animated, there will be only one iteration here,
562 * so don't bother checking
564 // Don't forget to go back to the first frame
565 $this->image->setFirstIterator();
567 // FIXME - implement horizontal bias for scaling as in following GD functions
568 // to allow very tall images to be constrained only horizontally.
569 $this->image->scaleImage($dest_width, $dest_height);
570 } while ($this->image->nextImage());
572 // These may not be necessary anymore
573 $this->width = $this->image->getImageWidth();
574 $this->height = $this->image->getImageHeight();
576 $dest = imagecreatetruecolor($dest_width, $dest_height);
577 imagealphablending($dest, false);
578 imagesavealpha($dest, true);
580 if ($this->type=='image/png') {
581 imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
584 imagecopyresampled($dest, $this->image, 0, 0, 0, 0, $dest_width, $dest_height, $this->width, $this->height);
587 imagedestroy($this->image);
590 $this->image = $dest;
591 $this->width = imagesx($this->image);
592 $this->height = imagesy($this->image);
599 * @param integer $max maximum
600 * @param integer $x x coordinate
601 * @param integer $y y coordinate
602 * @param integer $w width
603 * @param integer $h height
606 public function crop($max, $x, $y, $w, $h)
608 if (!$this->isValid()) {
612 if ($this->isImagick()) {
613 $this->image->setFirstIterator();
615 $this->image->cropImage($w, $h, $x, $y);
617 * We need to remove the canva,
618 * or the image is not resized to the crop:
619 * http://php.net/manual/en/imagick.cropimage.php#97232
621 $this->image->setImagePage(0, 0, 0, 0);
622 } while ($this->image->nextImage());
623 return $this->scaleDown($max);
626 $dest = imagecreatetruecolor($max, $max);
627 imagealphablending($dest, false);
628 imagesavealpha($dest, true);
629 if ($this->type=='image/png') {
630 imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
632 imagecopyresampled($dest, $this->image, 0, 0, $x, $y, $max, $max, $w, $h);
634 imagedestroy($this->image);
636 $this->image = $dest;
637 $this->width = imagesx($this->image);
638 $this->height = imagesy($this->image);
642 * @param string $path file path
645 public function saveToFilePath($path)
647 if (!$this->isValid()) {
651 $string = $this->asString();
655 $stamp1 = microtime(true);
656 file_put_contents($path, $string);
657 $a->save_timestamp($stamp1, "file");
661 * @brief Magic method allowing string casting of an Image object
663 * Ex: $data = $Image->asString();
665 * $data = (string) $Image;
669 public function __toString() {
670 return $this->asString();
676 public function asString()
678 if (!$this->isValid()) {
682 if ($this->isImagick()) {
684 $this->image = $this->image->deconstructImages();
685 $string = $this->image->getImagesBlob();
693 // Enable interlacing
694 imageinterlace($this->image, true);
696 switch ($this->getType()) {
698 $quality = Config::get('system', 'png_quality');
699 if ((!$quality) || ($quality > 9)) {
700 $quality = PNG_QUALITY;
702 imagepng($this->image, null, $quality);
705 $quality = Config::get('system', 'jpeg_quality');
706 if ((!$quality) || ($quality > 100)) {
707 $quality = JPEG_QUALITY;
709 imagejpeg($this->image, null, $quality);
711 $string = ob_get_contents();
718 * Guess image mimetype from filename or from Content-Type header
720 * @param string $filename Image filename
721 * @param boolean $fromcurl Check Content-Type header from curl request
725 public static function guessType($filename, $fromcurl = false)
727 logger('Image: guessType: '.$filename . ($fromcurl?' from curl headers':''), LOGGER_DEBUG);
732 $h = explode("\n", $a->get_curl_headers());
734 list($k,$v) = array_map("trim", explode(":", trim($l), 2));
737 if (array_key_exists('Content-Type', $headers))
738 $type = $headers['Content-Type'];
740 if (is_null($type)) {
741 // Guessing from extension? Isn't that... dangerous?
742 if (class_exists('Imagick') && file_exists($filename) && is_readable($filename)) {
744 * Well, this not much better,
745 * but at least it comes from the data inside the image,
746 * we won't be tricked by a manipulated extension
748 $image = new Imagick($filename);
749 $type = $image->getImageMimeType();
750 $image->setInterlaceScheme(Imagick::INTERLACE_PLANE);
752 $ext = pathinfo($filename, PATHINFO_EXTENSION);
753 $types = self::supportedTypes();
754 $type = "image/jpeg";
755 foreach ($types as $m => $e) {
762 logger('Image: guessType: type='.$type, LOGGER_DEBUG);
767 * @param string $url url
770 public static function getInfoFromURL($url)
778 $data = Cache::get($url);
780 if (is_null($data) || !$data || !is_array($data)) {
781 $img_str = Network::fetchUrl($url, true, $redirects, 4);
782 $filesize = strlen($img_str);
784 if (function_exists("getimagesizefromstring")) {
785 $data = getimagesizefromstring($img_str);
787 $tempfile = tempnam(get_temppath(), "cache");
790 $stamp1 = microtime(true);
791 file_put_contents($tempfile, $img_str);
792 $a->save_timestamp($stamp1, "file");
794 $data = getimagesize($tempfile);
799 $data["size"] = $filesize;
802 Cache::set($url, $data);
809 * @param integer $width width
810 * @param integer $height height
811 * @param integer $max max
814 public static function getScalingDimensions($width, $height, $max)
816 $dest_width = $dest_height = 0;
818 if ((!$width) || (!$height)) {
822 if ($width > $max && $height > $max) {
823 // very tall image (greater than 16:9)
824 // constrain the width - let the height float.
826 if ((($height * 9) / 16) > $width) {
828 $dest_height = intval(($height * $max) / $width);
829 } elseif ($width > $height) {
830 // else constrain both dimensions
832 $dest_height = intval(($height * $max) / $width);
834 $dest_width = intval(($width * $max) / $height);
840 $dest_height = intval(($height * $max) / $width);
842 if ($height > $max) {
843 // very tall image (greater than 16:9)
844 // but width is OK - don't do anything
846 if ((($height * 9) / 16) > $width) {
847 $dest_width = $width;
848 $dest_height = $height;
850 $dest_width = intval(($width * $max) / $height);
854 $dest_width = $width;
855 $dest_height = $height;
859 return ["width" => $dest_width, "height" => $dest_height];
863 * @brief This function is used by the fromgplus addon
864 * @param object $a App
865 * @param integer $uid user id
866 * @param string $imagedata optional, default empty
867 * @param string $url optional, default empty
870 public static function storePhoto(App $a, $uid, $imagedata = "", $url = "")
873 "SELECT `user`.`nickname`, `user`.`page-flags`, `contact`.`id` FROM `user` INNER JOIN `contact` on `user`.`uid` = `contact`.`uid`
874 WHERE `user`.`uid` = %d AND `user`.`blocked` = 0 AND `contact`.`self` = 1 LIMIT 1",
878 if (!DBM::is_result($r)) {
879 logger("Can't detect user data for uid ".$uid, LOGGER_DEBUG);
883 $page_owner_nick = $r[0]['nickname'];
886 /// $default_cid = $r[0]['id'];
887 /// $community_page = (($r[0]['page-flags'] == PAGE_COMMUNITY) ? true : false);
889 if ((strlen($imagedata) == 0) && ($url == "")) {
890 logger("No image data and no url provided", LOGGER_DEBUG);
892 } elseif (strlen($imagedata) == 0) {
893 logger("Uploading picture from ".$url, LOGGER_DEBUG);
895 $stamp1 = microtime(true);
896 $imagedata = @file_get_contents($url);
897 $a->save_timestamp($stamp1, "file");
900 $maximagesize = Config::get('system', 'maximagesize');
902 if (($maximagesize) && (strlen($imagedata) > $maximagesize)) {
903 logger("Image exceeds size limit of ".$maximagesize, LOGGER_DEBUG);
907 $tempfile = tempnam(get_temppath(), "cache");
909 $stamp1 = microtime(true);
910 file_put_contents($tempfile, $imagedata);
911 $a->save_timestamp($stamp1, "file");
913 $data = getimagesize($tempfile);
915 if (!isset($data["mime"])) {
917 logger("File is no picture", LOGGER_DEBUG);
921 $Image = new Image($imagedata, $data["mime"]);
923 if (!$Image->isValid()) {
925 logger("Picture is no valid picture", LOGGER_DEBUG);
929 $Image->orient($tempfile);
932 $max_length = Config::get('system', 'max_image_length');
934 $max_length = MAX_IMAGE_LENGTH;
937 if ($max_length > 0) {
938 $Image->scaleDown($max_length);
941 $width = $Image->getWidth();
942 $height = $Image->getHeight();
944 $hash = Photo::newResource();
948 // Pictures are always public by now
949 //$defperm = '<'.$default_cid.'>';
953 $r = Photo::store($Image, $uid, $visitor, $hash, $tempfile, L10n::t('Wall Photos'), 0, 0, $defperm);
956 logger("Picture couldn't be stored", LOGGER_DEBUG);
960 $image = ["page" => System::baseUrl().'/photos/'.$page_owner_nick.'/image/'.$hash,
961 "full" => System::baseUrl()."/photo/{$hash}-0.".$Image->getExt()];
963 if ($width > 800 || $height > 800) {
964 $image["large"] = System::baseUrl()."/photo/{$hash}-0.".$Image->getExt();
967 if ($width > 640 || $height > 640) {
968 $Image->scaleDown(640);
969 $r = Photo::store($Image, $uid, $visitor, $hash, $tempfile, L10n::t('Wall Photos'), 1, 0, $defperm);
971 $image["medium"] = System::baseUrl()."/photo/{$hash}-1.".$Image->getExt();
975 if ($width > 320 || $height > 320) {
976 $Image->scaleDown(320);
977 $r = Photo::store($Image, $uid, $visitor, $hash, $tempfile, L10n::t('Wall Photos'), 2, 0, $defperm);
979 $image["small"] = System::baseUrl()."/photo/{$hash}-2.".$Image->getExt();
983 if ($width > 160 && $height > 160) {
987 $min = $Image->getWidth();
989 $x = ($min - 160) / 2;
992 if ($Image->getHeight() < $min) {
993 $min = $Image->getHeight();
995 $y = ($min - 160) / 2;
1000 $Image->crop(160, $x, $y, $min, $min);
1002 $r = Photo::store($Image, $uid, $visitor, $hash, $tempfile, L10n::t('Wall Photos'), 3, 0, $defperm);
1004 $image["thumb"] = System::baseUrl()."/photo/{$hash}-3.".$Image->getExt();
1008 // Set the full image as preview image. This will be overwritten, if the picture is larger than 640.
1009 $image["preview"] = $image["full"];
1011 // Deactivated, since that would result in a cropped preview, if the picture wasn't larger than 320
1012 //if (isset($image["thumb"]))
1013 // $image["preview"] = $image["thumb"];
1015 // Unsure, if this should be activated or deactivated
1016 //if (isset($image["small"]))
1017 // $image["preview"] = $image["small"];
1019 if (isset($image["medium"])) {
1020 $image["preview"] = $image["medium"];