]> git.mxchange.org Git - friendica.git/blobdiff - src/Object/Image.php
Merge pull request #11105 from annando/api-direct-messages
[friendica.git] / src / Object / Image.php
index 67413e3c0d1e7c5f13d7ae07287f4827ad9c4973..608f64e97c057741445b142d799f3f20ba98237e 100644 (file)
@@ -1,16 +1,29 @@
 <?php
 /**
- * @file src/Object/Image.php
- * @brief This file contains the Image class for image processing
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Object;
 
 use Exception;
-use Friendica\Core\Cache;
-use Friendica\Core\Config;
-use Friendica\Core\Logger;
-use Friendica\Core\System;
-use Friendica\Util\Network;
+use Friendica\DI;
+use Friendica\Util\Images;
 use Imagick;
 use ImagickPixel;
 
@@ -33,32 +46,7 @@ class Image
        private $types;
 
        /**
-        * @brief supported mimetypes and corresponding file extensions
-        * @return array
-        */
-       public static function supportedTypes()
-       {
-               if (class_exists('Imagick')) {
-                       // Imagick::queryFormats won't help us a lot there...
-                       // At least, not yet, other parts of friendica uses this array
-                       $t = [
-                               'image/jpeg' => 'jpg',
-                               'image/png' => 'png',
-                               'image/gif' => 'gif'
-                       ];
-               } else {
-                       $t = [];
-                       $t['image/jpeg'] ='jpg';
-                       if (imagetypes() & IMG_PNG) {
-                               $t['image/png'] = 'png';
-                       }
-               }
-
-               return $t;
-       }
-
-       /**
-        * @brief Constructor
+        * Constructor
         * @param string  $data
         * @param boolean $type optional, default null
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@@ -67,9 +55,9 @@ class Image
        public function __construct($data, $type = null)
        {
                $this->imagick = class_exists('Imagick');
-               $this->types = static::supportedTypes();
+               $this->types = Images::supportedTypes();
                if (!array_key_exists($type, $this->types)) {
-                       $type='image/jpeg';
+                       $type = 'image/jpeg';
                }
                $this->type = $type;
 
@@ -83,7 +71,8 @@ class Image
        }
 
        /**
-        * @brief Destructor
+        * Destructor
+        *
         * @return void
         */
        public function __destruct()
@@ -108,20 +97,6 @@ class Image
                return $this->imagick;
        }
 
-       /**
-        * @brief Maps Mime types to Imagick formats
-        * @return array With with image formats (mime type as key)
-        */
-       public static function getFormatsMap()
-       {
-               $m = [
-                       'image/jpeg' => 'JPG',
-                       'image/png' => 'PNG',
-                       'image/gif' => 'GIF'
-               ];
-               return $m;
-       }
-
        /**
         * @param string $data data
         * @return boolean
@@ -142,22 +117,23 @@ class Image
                        /*
                         * Setup the image to the format it will be saved to
                         */
-                       $map = self::getFormatsMap();
+                       $map = Images::getFormatsMap();
                        $format = $map[$this->type];
                        $this->image->setFormat($format);
 
                        // Always coalesce, if it is not a multi-frame image it won't hurt anyway
-                       $this->image = $this->image->coalesceImages();
+                       try {
+                               $this->image = $this->image->coalesceImages();
+                       } catch (Exception $e) {
+                               return false;
+                       }
 
                        /*
                         * setup the compression here, so we'll do it only once
                         */
                        switch ($this->getType()) {
                                case "image/png":
-                                       $quality = Config::get('system', 'png_quality');
-                                       if ((! $quality) || ($quality > 9)) {
-                                               $quality = PNG_QUALITY;
-                                       }
+                                       $quality = DI::config()->get('system', 'png_quality');
                                        /*
                                         * From http://www.imagemagick.org/script/command-line-options.php#quality:
                                         *
@@ -170,10 +146,7 @@ class Image
                                        $this->image->setCompressionQuality($quality);
                                        break;
                                case "image/jpeg":
-                                       $quality = Config::get('system', 'jpeg_quality');
-                                       if ((! $quality) || ($quality > 100)) {
-                                               $quality = JPEG_QUALITY;
-                                       }
+                                       $quality = DI::config()->get('system', 'jpeg_quality');
                                        $this->image->setCompressionQuality($quality);
                        }
 
@@ -251,9 +224,13 @@ class Image
                }
 
                if ($this->isImagick()) {
-                       /* Clean it */
-                       $this->image = $this->image->deconstructImages();
-                       return $this->image;
+                       try {
+                               /* Clean it */
+                               $this->image = $this->image->deconstructImages();
+                               return $this->image;
+                       } catch (Exception $e) {
+                               return false;
+                       }
                }
                return $this->image;
        }
@@ -480,7 +457,6 @@ class Image
                                break;
                }
 
-               //      Logger::log('exif: ' . print_r($exif,true));
                return $exif;
        }
 
@@ -541,7 +517,7 @@ class Image
        }
 
        /**
-        * @brief Scale image to target dimensions
+        * Scale image to target dimensions
         *
         * @param int $dest_width
         * @param int $dest_height
@@ -563,7 +539,12 @@ class Image
                        do {
                                // FIXME - implement horizontal bias for scaling as in following GD functions
                                // to allow very tall images to be constrained only horizontally.
-                               $this->image->scaleImage($dest_width, $dest_height);
+                               try {
+                                       $this->image->scaleImage($dest_width, $dest_height);
+                               } catch (Exception $e) {
+                                       // Imagick couldn't use the data
+                                       return false;
+                               }
                        } while ($this->image->nextImage());
 
                        // These may not be necessary anymore
@@ -592,6 +573,21 @@ class Image
                return true;
        }
 
+       /**
+        * Convert a GIF to a PNG to make it static
+        */
+       public function toStatic()
+       {
+               if ($this->type != 'image/gif') {
+                       return;
+               }
+
+               if ($this->isImagick()) {
+                       $this->type == 'image/png';
+                       $this->image->setFormat('png');
+               }
+       }
+
        /**
         * @param integer $max maximum
         * @param integer $x   x coordinate
@@ -636,27 +632,7 @@ class Image
        }
 
        /**
-        * @param string $path file path
-        * @return mixed
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
-        */
-       public function saveToFilePath($path)
-       {
-               if (!$this->isValid()) {
-                       return false;
-               }
-
-               $string = $this->asString();
-
-               $a = \get_app();
-
-               $stamp1 = microtime(true);
-               file_put_contents($path, $string);
-               $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
-       }
-
-       /**
-        * @brief Magic method allowing string casting of an Image object
+        * Magic method allowing string casting of an Image object
         *
         * Ex: $data = $Image->asString();
         * can be replaced by
@@ -680,10 +656,14 @@ class Image
                }
 
                if ($this->isImagick()) {
-                       /* Clean it */
-                       $this->image = $this->image->deconstructImages();
-                       $string = $this->image->getImagesBlob();
-                       return $string;
+                       try {
+                               /* Clean it */
+                               $this->image = $this->image->deconstructImages();
+                               $string = $this->image->getImagesBlob();
+                               return $string;
+                       } catch (Exception $e) {
+                               return false;
+                       }
                }
 
                ob_start();
@@ -693,17 +673,11 @@ class Image
 
                switch ($this->getType()) {
                        case "image/png":
-                               $quality = Config::get('system', 'png_quality');
-                               if ((!$quality) || ($quality > 9)) {
-                                       $quality = PNG_QUALITY;
-                               }
+                               $quality = DI::config()->get('system', 'png_quality');
                                imagepng($this->image, null, $quality);
                                break;
                        case "image/jpeg":
-                               $quality = Config::get('system', 'jpeg_quality');
-                               if ((!$quality) || ($quality > 100)) {
-                                       $quality = JPEG_QUALITY;
-                               }
+                               $quality = DI::config()->get('system', 'jpeg_quality');
                                imagejpeg($this->image, null, $quality);
                }
                $string = ob_get_contents();
@@ -711,161 +685,4 @@ class Image
 
                return $string;
        }
-
-       /**
-        * Guess image mimetype from filename or from Content-Type header
-        *
-        * @param string  $filename Image filename
-        * @param boolean $fromcurl Check Content-Type header from curl request
-        * @param string  $header   passed headers to take into account
-        *
-        * @return object
-        * @throws \ImagickException
-        */
-       public static function guessType($filename, $fromcurl = false, $header = '')
-       {
-               Logger::log('Image: guessType: '.$filename . ($fromcurl?' from curl headers':''), Logger::DEBUG);
-               $type = null;
-               if ($fromcurl) {
-                       $headers=[];
-                       $h = explode("\n", $header);
-                       foreach ($h as $l) {
-                               $data = array_map("trim", explode(":", trim($l), 2));
-                               if (count($data) > 1) {
-                                       list($k,$v) = $data;
-                                       $headers[$k] = $v;
-                               }
-                       }
-                       if (array_key_exists('Content-Type', $headers))
-                               $type = $headers['Content-Type'];
-               }
-               if (is_null($type)) {
-                       // Guessing from extension? Isn't that... dangerous?
-                       if (class_exists('Imagick') && file_exists($filename) && is_readable($filename)) {
-                               /**
-                                * Well, this not much better,
-                                * but at least it comes from the data inside the image,
-                                * we won't be tricked by a manipulated extension
-                                */
-                               $image = new Imagick($filename);
-                               $type = $image->getImageMimeType();
-                               $image->setInterlaceScheme(Imagick::INTERLACE_PLANE);
-                       } else {
-                               $ext = pathinfo($filename, PATHINFO_EXTENSION);
-                               $types = self::supportedTypes();
-                               $type = "image/jpeg";
-                               foreach ($types as $m => $e) {
-                                       if ($ext == $e) {
-                                               $type = $m;
-                                       }
-                               }
-                       }
-               }
-               Logger::log('Image: guessType: type='.$type, Logger::DEBUG);
-               return $type;
-       }
-
-       /**
-        * @param string $url url
-        * @return object
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
-        */
-       public static function getInfoFromURL($url)
-       {
-               $data = [];
-
-               if (empty($url)) {
-                       return $data;
-               }
-
-               $data = Cache::get($url);
-
-               if (is_null($data) || !$data || !is_array($data)) {
-                       $img_str = Network::fetchUrl($url, true, $redirects, 4);
-
-                       if (!$img_str) {
-                               return false;
-                       }
-
-                       $filesize = strlen($img_str);
-
-                       try {
-                               if (function_exists("getimagesizefromstring")) {
-                                       $data = @getimagesizefromstring($img_str);
-                               } else {
-                                       $tempfile = tempnam(get_temppath(), "cache");
-
-                                       $a = \get_app();
-                                       $stamp1 = microtime(true);
-                                       file_put_contents($tempfile, $img_str);
-                                       $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
-
-                                       $data = getimagesize($tempfile);
-                                       unlink($tempfile);
-                               }
-                       } catch (Exception $e) {
-                               return false;
-                       }
-
-                       if ($data) {
-                               $data["size"] = $filesize;
-                       }
-
-                       Cache::set($url, $data);
-               }
-
-               return $data;
-       }
-
-       /**
-        * @param integer $width  width
-        * @param integer $height height
-        * @param integer $max    max
-        * @return array
-        */
-       public static function getScalingDimensions($width, $height, $max)
-       {
-               if ((!$width) || (!$height)) {
-                       return false;
-               }
-
-               if ($width > $max && $height > $max) {
-                       // very tall image (greater than 16:9)
-                       // constrain the width - let the height float.
-
-                       if ((($height * 9) / 16) > $width) {
-                               $dest_width = $max;
-                               $dest_height = intval(($height * $max) / $width);
-                       } elseif ($width > $height) {
-                               // else constrain both dimensions
-                               $dest_width = $max;
-                               $dest_height = intval(($height * $max) / $width);
-                       } else {
-                               $dest_width = intval(($width * $max) / $height);
-                               $dest_height = $max;
-                       }
-               } else {
-                       if ($width > $max) {
-                               $dest_width = $max;
-                               $dest_height = intval(($height * $max) / $width);
-                       } else {
-                               if ($height > $max) {
-                                       // very tall image (greater than 16:9)
-                                       // but width is OK - don't do anything
-
-                                       if ((($height * 9) / 16) > $width) {
-                                               $dest_width = $width;
-                                               $dest_height = $height;
-                                       } else {
-                                               $dest_width = intval(($width * $max) / $height);
-                                               $dest_height = $max;
-                                       }
-                               } else {
-                                       $dest_width = $width;
-                                       $dest_height = $height;
-                               }
-                       }
-               }
-               return ["width" => $dest_width, "height" => $dest_height];
-       }
 }