3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Object;
26 use Friendica\Util\Images;
31 * Class to handle images
35 /** @var Imagick|resource */
39 * Put back gd stuff, not everybody have Imagick
51 * @param string $data Image data
52 * @param string $type optional, default null
53 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
54 * @throws \ImagickException
56 public function __construct(string $data, string $type = null)
58 $this->imagick = class_exists('Imagick');
59 $this->types = Images::supportedTypes();
60 if (!array_key_exists($type, $this->types)) {
65 if ($this->isImagick() && $this->loadData($data)) {
68 // Failed to load with Imagick, fallback
69 $this->imagick = false;
71 $this->loadData($data);
79 public function __destruct()
82 if ($this->isImagick()) {
83 $this->image->clear();
84 $this->image->destroy();
87 if (is_resource($this->image)) {
88 imagedestroy($this->image);
96 public function isImagick()
98 return $this->imagick;
102 * Loads image data into handler class
104 * @param string $data Image data
105 * @return boolean Success
106 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
107 * @throws \ImagickException
109 private function loadData(string $data): bool
111 if ($this->isImagick()) {
112 $this->image = new Imagick();
114 $this->image->readImageBlob($data);
115 } catch (Exception $e) {
116 // Imagick couldn't use the data
121 * Setup the image to the format it will be saved to
123 $map = Images::getFormatsMap();
124 $format = $map[$this->type];
125 $this->image->setFormat($format);
127 // Always coalesce, if it is not a multi-frame image it won't hurt anyway
129 $this->image = $this->image->coalesceImages();
130 } catch (Exception $e) {
135 * setup the compression here, so we'll do it only once
137 switch ($this->getType()) {
139 $quality = DI::config()->get('system', 'png_quality');
141 * From http://www.imagemagick.org/script/command-line-options.php#quality:
143 * 'For the MNG and PNG image formats, the quality value sets
144 * the zlib compression level (quality / 10) and filter-type (quality % 10).
145 * The default PNG "quality" is 75, which means compression level 7 with adaptive PNG filtering,
146 * unless the image has a color map, in which case it means compression level 7 with no PNG filtering'
148 $quality = $quality * 10;
149 $this->image->setCompressionQuality($quality);
154 $quality = DI::config()->get('system', 'jpeg_quality');
155 $this->image->setCompressionQuality($quality);
158 // The 'width' and 'height' properties are only used by non-Imagick routines.
159 $this->width = $this->image->getImageWidth();
160 $this->height = $this->image->getImageHeight();
166 $this->valid = false;
168 $this->image = @imagecreatefromstring($data);
169 if ($this->image !== false) {
170 $this->width = imagesx($this->image);
171 $this->height = imagesy($this->image);
173 imagealphablending($this->image, false);
174 imagesavealpha($this->image, true);
178 } catch (\Throwable $error) {
179 /** @see https://github.com/php/doc-en/commit/d09a881a8e9059d11e756ee59d75bf404d6941ed */
180 if (strstr($error->getMessage(), "gd-webp cannot allocate temporary buffer")) {
181 DI::logger()->notice('Image is probably animated and therefore unsupported', ['error' => $error]);
183 DI::logger()->warning('Unexpected throwable.', ['error' => $error]);
193 public function isValid(): bool
195 if ($this->isImagick()) {
196 return ($this->image !== false);
204 public function getWidth()
206 if (!$this->isValid()) {
210 if ($this->isImagick()) {
211 return $this->image->getImageWidth();
219 public function getHeight()
221 if (!$this->isValid()) {
225 if ($this->isImagick()) {
226 return $this->image->getImageHeight();
228 return $this->height;
234 public function getImage()
236 if (!$this->isValid()) {
240 if ($this->isImagick()) {
243 $this->image = $this->image->deconstructImages();
245 } catch (Exception $e) {
255 public function getType()
257 if (!$this->isValid()) {
267 public function getExt()
269 if (!$this->isValid()) {
273 return $this->types[$this->getType()];
279 * @param integer $max max dimension
282 public function scaleDown(int $max)
284 if (!$this->isValid()) {
288 $width = $this->getWidth();
289 $height = $this->getHeight();
291 if ((! $width)|| (! $height)) {
295 if ($width > $max && $height > $max) {
296 // very tall image (greater than 16:9)
297 // constrain the width - let the height float.
299 if ((($height * 9) / 16) > $width) {
301 $dest_height = intval(($height * $max) / $width);
302 } elseif ($width > $height) {
303 // else constrain both dimensions
305 $dest_height = intval(($height * $max) / $width);
307 $dest_width = intval(($width * $max) / $height);
313 $dest_height = intval(($height * $max) / $width);
315 if ($height > $max) {
316 // very tall image (greater than 16:9)
317 // but width is OK - don't do anything
319 if ((($height * 9) / 16) > $width) {
320 $dest_width = $width;
321 $dest_height = $height;
323 $dest_width = intval(($width * $max) / $height);
327 $dest_width = $width;
328 $dest_height = $height;
333 return $this->scale($dest_width, $dest_height);
339 * @param integer $degrees degrees to rotate image
342 public function rotate(int $degrees)
344 if (!$this->isValid()) {
348 if ($this->isImagick()) {
349 $this->image->setFirstIterator();
351 $this->image->rotateImage(new ImagickPixel(), -$degrees); // ImageMagick rotates in the opposite direction of imagerotate()
352 } while ($this->image->nextImage());
356 // if script dies at this point check memory_limit setting in php.ini
357 $this->image = imagerotate($this->image, $degrees, 0);
358 $this->width = imagesx($this->image);
359 $this->height = imagesy($this->image);
365 * @param boolean $horiz optional, default true
366 * @param boolean $vert optional, default false
369 public function flip(bool $horiz = true, bool $vert = false)
371 if (!$this->isValid()) {
375 if ($this->isImagick()) {
376 $this->image->setFirstIterator();
379 $this->image->flipImage();
382 $this->image->flopImage();
384 } while ($this->image->nextImage());
388 $w = imagesx($this->image);
389 $h = imagesy($this->image);
390 $flipped = imagecreate($w, $h);
392 for ($x = 0; $x < $w; $x++) {
393 imagecopy($flipped, $this->image, $x, 0, $w - $x - 1, 0, 1, $h);
397 for ($y = 0; $y < $h; $y++) {
398 imagecopy($flipped, $this->image, 0, $y, 0, $h - $y - 1, $w, 1);
401 $this->image = $flipped;
405 * Fixes orientation and maybe returns EXIF data (?)
407 * @param string $filename Filename
410 public function orient(string $filename)
412 if ($this->isImagick()) {
413 // based off comment on http://php.net/manual/en/imagick.getimageorientation.php
414 $orientation = $this->image->getImageOrientation();
415 switch ($orientation) {
416 case Imagick::ORIENTATION_BOTTOMRIGHT:
417 $this->image->rotateimage("#000", 180);
419 case Imagick::ORIENTATION_RIGHTTOP:
420 $this->image->rotateimage("#000", 90);
422 case Imagick::ORIENTATION_LEFTBOTTOM:
423 $this->image->rotateimage("#000", -90);
427 $this->image->setImageOrientation(Imagick::ORIENTATION_TOPLEFT);
430 // based off comment on http://php.net/manual/en/function.imagerotate.php
432 if (!$this->isValid()) {
436 if ((!function_exists('exif_read_data')) || ($this->getType() !== 'image/jpeg')) {
440 $exif = @exif_read_data($filename, null, true);
445 $ort = isset($exif['IFD0']['Orientation']) ? $exif['IFD0']['Orientation'] : 1;
451 case 2: // horizontal flip
455 case 3: // 180 rotate left
459 case 4: // vertical flip
460 $this->flip(false, true);
463 case 5: // vertical flip + 90 rotate right
464 $this->flip(false, true);
468 case 6: // 90 rotate right
472 case 7: // horizontal flip + 90 rotate right
477 case 8: // 90 rotate left
486 * Rescales image to minimum size
488 * @param integer $min Minimum dimension
491 public function scaleUp(int $min)
493 if (!$this->isValid()) {
497 $width = $this->getWidth();
498 $height = $this->getHeight();
500 if ((!$width)|| (!$height)) {
504 if ($width < $min && $height < $min) {
505 if ($width > $height) {
507 $dest_height = intval(($height * $min) / $width);
509 $dest_width = intval(($width * $min) / $height);
515 $dest_height = intval(($height * $min) / $width);
517 if ($height < $min) {
518 $dest_width = intval(($width * $min) / $height);
521 $dest_width = $width;
522 $dest_height = $height;
527 return $this->scale($dest_width, $dest_height);
531 * Scales image to square
533 * @param integer $dim Dimension
536 public function scaleToSquare(int $dim)
538 if (!$this->isValid()) {
542 return $this->scale($dim, $dim);
546 * Scale image to target dimensions
548 * @param int $dest_width Destination width
549 * @param int $dest_height Destination height
550 * @return boolean Success
552 private function scale(int $dest_width, int $dest_height): bool
554 if (!$this->isValid()) {
558 if ($this->isImagick()) {
560 * If it is not animated, there will be only one iteration here,
561 * so don't bother checking
563 // Don't forget to go back to the first frame
564 $this->image->setFirstIterator();
566 // FIXME - implement horizontal bias for scaling as in following GD functions
567 // to allow very tall images to be constrained only horizontally.
569 $this->image->scaleImage($dest_width, $dest_height);
570 } catch (Exception $e) {
571 // Imagick couldn't use the data
574 } while ($this->image->nextImage());
576 // These may not be necessary anymore
577 $this->width = $this->image->getImageWidth();
578 $this->height = $this->image->getImageHeight();
580 $dest = imagecreatetruecolor($dest_width, $dest_height);
581 imagealphablending($dest, false);
582 imagesavealpha($dest, true);
584 if ($this->type=='image/png') {
585 imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
588 imagecopyresampled($dest, $this->image, 0, 0, 0, 0, $dest_width, $dest_height, $this->width, $this->height);
591 imagedestroy($this->image);
594 $this->image = $dest;
595 $this->width = imagesx($this->image);
596 $this->height = imagesy($this->image);
603 * Convert a GIF to a PNG to make it static
607 public function toStatic()
609 if ($this->type != 'image/gif') {
613 if ($this->isImagick()) {
614 $this->type == 'image/png';
615 $this->image->setFormat('png');
622 * @param integer $max maximum
623 * @param integer $x x coordinate
624 * @param integer $y y coordinate
625 * @param integer $w width
626 * @param integer $h height
629 public function crop(int $max, int $x, int $y, int $w, int $h)
631 if (!$this->isValid()) {
635 if ($this->isImagick()) {
636 $this->image->setFirstIterator();
638 $this->image->cropImage($w, $h, $x, $y);
640 * We need to remove the canva,
641 * or the image is not resized to the crop:
642 * http://php.net/manual/en/imagick.cropimage.php#97232
644 $this->image->setImagePage(0, 0, 0, 0);
645 } while ($this->image->nextImage());
646 return $this->scaleDown($max);
649 $dest = imagecreatetruecolor($max, $max);
650 imagealphablending($dest, false);
651 imagesavealpha($dest, true);
652 if ($this->type=='image/png') {
653 imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
655 imagecopyresampled($dest, $this->image, 0, 0, $x, $y, $max, $max, $w, $h);
657 imagedestroy($this->image);
659 $this->image = $dest;
660 $this->width = imagesx($this->image);
661 $this->height = imagesy($this->image);
668 * Magic method allowing string casting of an Image object
670 * Ex: $data = $Image->asString();
672 * $data = (string) $Image;
675 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
677 public function __toString(): string
679 return (string) $this->asString();
683 * Returns image as string or false on failure
686 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
688 public function asString()
690 if (!$this->isValid()) {
694 if ($this->isImagick()) {
697 $this->image = $this->image->deconstructImages();
698 $string = $this->image->getImagesBlob();
700 } catch (Exception $e) {
707 // Enable interlacing
708 imageinterlace($this->image, true);
710 switch ($this->getType()) {
712 $quality = DI::config()->get('system', 'png_quality');
713 imagepng($this->image, null, $quality);
718 $quality = DI::config()->get('system', 'jpeg_quality');
719 imagejpeg($this->image, null, $quality);
722 $string = ob_get_contents();