]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Photo.php
Use rawContent for Special Options to avoid a protected options() method
[friendica.git] / src / Model / Photo.php
index f79409e3f5c332f1115002d9b265f0388fbd2813..1d347f3d5f6c09db64009bac79f5b3148f6edcae 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
 
 namespace Friendica\Model;
 
-use Friendica\Core\Cache\Duration;
+use Friendica\Core\Cache\Enum\Duration;
 use Friendica\Core\Logger;
 use Friendica\Core\System;
 use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
 use Friendica\DI;
-use Friendica\Model\Storage\SystemResource;
+use Friendica\Core\Storage\Type\ExternalResource;
+use Friendica\Core\Storage\Exception\InvalidClassStorageException;
+use Friendica\Core\Storage\Exception\ReferenceStorageException;
+use Friendica\Core\Storage\Exception\StorageException;
+use Friendica\Core\Storage\Type\SystemResource;
 use Friendica\Object\Image;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Images;
@@ -35,14 +39,19 @@ use Friendica\Security\Security;
 use Friendica\Util\Proxy;
 use Friendica\Util\Strings;
 
-require_once "include/dba.php";
-
 /**
  * Class to handle photo dabatase table
  */
 class Photo
 {
        const CONTACT_PHOTOS = 'Contact Photos';
+       const PROFILE_PHOTOS = 'Profile Photos';
+
+       const DEFAULT        = 0;
+       const USER_AVATAR    = 10;
+       const USER_BANNER    = 11;
+       const CONTACT_AVATAR = 20;
+       const CONTACT_BANNER = 21;
 
        /**
         * Select rows from the photo table and returns them as array
@@ -183,8 +192,6 @@ class Photo
         * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
         *
         * @return \Friendica\Object\Image
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
-        * @throws \ImagickException
         */
        public static function getImageDataForPhoto(array $photo)
        {
@@ -192,19 +199,31 @@ class Photo
                        return $photo['data'];
                }
 
-               $backendClass = DI::storageManager()->getByName($photo['backend-class'] ?? '');
-               if (empty($backendClass)) {
-                       // legacy data storage in "data" column
-                       $i = self::selectFirst(['data'], ['id' => $photo['id']]);
-                       if ($i === false) {
-                               return null;
+               try {
+                       $backendClass = DI::storageManager()->getByName($photo['backend-class'] ?? '');
+                       /// @todo refactoring this returning, because the storage returns a "string" which is casted in different ways - a check "instanceof Image" will fail!
+                       return $backendClass->get($photo['backend-ref'] ?? '');
+               } catch (InvalidClassStorageException $storageException) {
+                       try {
+                               // legacy data storage in "data" column
+                               $i = self::selectFirst(['data'], ['id' => $photo['id']]);
+                               if ($i !== false) {
+                                       return $i['data'];
+                               } else {
+                                       DI::logger()->info('Stored legacy data is empty', ['photo' => $photo]);
+                               }
+                       } catch (\Exception $exception) {
+                               DI::logger()->info('Unexpected database exception', ['photo' => $photo, 'exception' => $exception]);
                        }
-                       $data = $i['data'];
-               } else {
-                       $backendRef = $photo['backend-ref'] ?? '';
-                       $data = $backendClass->get($backendRef);
+               } catch (ReferenceStorageException $referenceStorageException) {
+                       DI::logger()->debug('Invalid reference for photo', ['photo' => $photo, 'exception' => $referenceStorageException]);
+               } catch (StorageException $storageException) {
+                       DI::logger()->info('Unexpected storage exception', ['photo' => $photo, 'exception' => $storageException]);
+               } catch (\ImagickException $imagickException) {
+                       DI::logger()->info('Unexpected imagick exception', ['photo' => $photo, 'exception' => $imagickException]);
                }
-               return $data;
+
+               return null;
        }
 
        /**
@@ -216,14 +235,9 @@ class Photo
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function getImageForPhoto(array $photo)
+       public static function getImageForPhoto(array $photo): Image
        {
-               $data = self::getImageDataForPhoto($photo);
-               if (empty($data)) {
-                       return null;
-               }
-
-               return new Image($data, $photo['type']);
+               return new Image(self::getImageDataForPhoto($photo), $photo['type']);
        }
 
        /**
@@ -244,13 +258,17 @@ class Photo
         * Construct a photo array for a system resource image
         *
         * @param string $filename Image file name relative to code root
-        * @param string $mimetype Image mime type. Defaults to "image/jpeg"
+        * @param string $mimetype Image mime type. Is guessed by file name when empty.
         *
         * @return array
         * @throws \Exception
         */
-       public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
+       public static function createPhotoForSystemResource($filename, $mimetype = '')
        {
+               if (empty($mimetype)) {
+                       $mimetype = Images::guessTypeByExtension($filename);
+               }
+
                $fields = self::getFields();
                $values = array_fill(0, count($fields), "");
 
@@ -263,6 +281,33 @@ class Photo
                return $photo;
        }
 
+       /**
+        * Construct a photo array for an external resource image
+        *
+        * @param string $url      Image URL
+        * @param int    $uid      User ID of the requesting person
+        * @param string $mimetype Image mime type. Is guessed by file name when empty.
+        *
+        * @return array
+        * @throws \Exception
+        */
+       public static function createPhotoForExternalResource($url, $uid = 0, $mimetype = '')
+       {
+               if (empty($mimetype)) {
+                       $mimetype = Images::guessTypeByExtension($url);
+               }
+
+               $fields = self::getFields();
+               $values = array_fill(0, count($fields), "");
+
+               $photo                  = array_combine($fields, $values);
+               $photo['backend-class'] = ExternalResource::NAME;
+               $photo['backend-ref']   = json_encode(['url' => $url, 'uid' => $uid]);
+               $photo['type']          = $mimetype;
+               $photo['cacheable']     = true;
+
+               return $photo;
+       }
 
        /**
         * store photo metadata in db and binary in default backend
@@ -284,7 +329,7 @@ class Photo
         * @return boolean True on success
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
+       public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $type = self::DEFAULT, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
        {
                $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
                if (DBA::isResult($photo)) {
@@ -302,20 +347,20 @@ class Photo
                // Get defined storage backend.
                // if no storage backend, we use old "data" column in photo table.
                // if is an existing photo, reuse same backend
-               $data = "";
+               $data        = "";
                $backend_ref = "";
+               $storage     = "";
 
-               if (DBA::isResult($existing_photo)) {
-                       $backend_ref = (string)$existing_photo["backend-ref"];
-                       $storage = DI::storageManager()->getByName($existing_photo["backend-class"] ?? '');
-               } else {
-                       $storage = DI::storage();
-               }
-
-               if (empty($storage)) {
-                       $data = $Image->asString();
-               } else {
+               try {
+                       if (DBA::isResult($existing_photo)) {
+                               $backend_ref = (string)$existing_photo["backend-ref"];
+                               $storage     = DI::storageManager()->getWritableStorageByName($existing_photo["backend-class"] ?? '');
+                       } else {
+                               $storage = DI::storage();
+                       }
                        $backend_ref = $storage->put($Image->asString(), $backend_ref);
+               } catch (InvalidClassStorageException $storageException) {
+                       $data = $Image->asString();
                }
 
                $fields = [
@@ -334,7 +379,8 @@ class Photo
                        "datasize" => strlen($Image->asString()),
                        "data" => $data,
                        "scale" => $scale,
-                       "profile" => $profile,
+                       "photo-type" => $type,
+                       "profile" => false,
                        "allow_cid" => $allow_cid,
                        "allow_gid" => $allow_gid,
                        "deny_cid" => $deny_cid,
@@ -371,12 +417,15 @@ class Photo
                $photos = DBA::select('photo', ['id', 'backend-class', 'backend-ref'], $conditions);
 
                while ($photo = DBA::fetch($photos)) {
-                       $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
-                       if (!empty($backend_class)) {
-                               if ($backend_class->delete($photo["backend-ref"] ?? '')) {
-                                       // Delete the photos after they had been deleted successfully
-                                       DBA::delete("photo", ['id' => $photo['id']]);
-                               }
+                       try {
+                               $backend_class = DI::storageManager()->getWritableStorageByName($photo['backend-class'] ?? '');
+                               $backend_class->delete($photo['backend-ref'] ?? '');
+                               // Delete the photos after they had been deleted successfully
+                               DBA::delete("photo", ['id' => $photo['id']]);
+                       } catch (InvalidClassStorageException $storageException) {
+                               DI::logger()->debug('Storage class not found.', ['conditions' => $conditions, 'exception' => $storageException]);
+                       } catch (ReferenceStorageException $referenceStorageException) {
+                               DI::logger()->debug('Photo doesn\'t exist.', ['conditions' => $conditions, 'exception' => $referenceStorageException]);
                        }
                }
 
@@ -405,10 +454,10 @@ class Photo
                        $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
 
                        foreach($photos as $photo) {
-                               $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
-                               if (!empty($backend_class)) {
+                               try {
+                                       $backend_class         = DI::storageManager()->getWritableStorageByName($photo['backend-class'] ?? '');
                                        $fields["backend-ref"] = $backend_class->put($img->asString(), $photo['backend-ref']);
-                               } else {
+                               } catch (InvalidClassStorageException $storageException) {
                                        $fields["data"] = $img->asString();
                                }
                        }
@@ -435,7 +484,7 @@ class Photo
                $micro = "";
 
                $photo = DBA::selectFirst(
-                       "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "album" => self::CONTACT_PHOTOS]
+                       "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "photo-type" => self::CONTACT_AVATAR]
                );
                if (!empty($photo['resource-id'])) {
                        $resource_id = $photo["resource-id"];
@@ -447,11 +496,12 @@ class Photo
 
                $filename = basename($image_url);
                if (!empty($image_url)) {
-                       $ret = DI::httpRequest()->get($image_url);
+                       $ret = DI::httpClient()->get($image_url);
                        $img_str = $ret->getBody();
                        $type = $ret->getContentType();
                } else {
                        $img_str = '';
+                       $type = '';
                }
 
                if ($quit_on_error && ($img_str == "")) {
@@ -487,7 +537,7 @@ class Photo
                                Logger::info('Avatar is resized', ['uid' => $uid, 'cid' => $cid, 'size' => $filesize, 'type' => $Image->getType()]);
                        }
 
-                       $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 4);
+                       $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 4, self::CONTACT_AVATAR);
 
                        if ($r === false) {
                                $photo_failure = true;
@@ -495,7 +545,7 @@ class Photo
 
                        $Image->scaleDown(80);
 
-                       $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 5);
+                       $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 5, self::CONTACT_AVATAR);
 
                        if ($r === false) {
                                $photo_failure = true;
@@ -503,7 +553,7 @@ class Photo
 
                        $Image->scaleDown(48);
 
-                       $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 6);
+                       $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 6, self::CONTACT_AVATAR);
 
                        if ($r === false) {
                                $photo_failure = true;
@@ -514,25 +564,6 @@ class Photo
                        $image_url = DI::baseUrl() . "/photo/" . $resource_id . "-4." . $Image->getExt() . $suffix;
                        $thumb = DI::baseUrl() . "/photo/" . $resource_id . "-5." . $Image->getExt() . $suffix;
                        $micro = DI::baseUrl() . "/photo/" . $resource_id . "-6." . $Image->getExt() . $suffix;
-
-                       // Remove the cached photo
-                       $a = DI::app();
-                       $basepath = $a->getBasePath();
-
-                       if (is_dir($basepath . "/photo")) {
-                               $filename = $basepath . "/photo/" . $resource_id . "-4." . $Image->getExt();
-                               if (file_exists($filename)) {
-                                       unlink($filename);
-                               }
-                               $filename = $basepath . "/photo/" . $resource_id . "-5." . $Image->getExt();
-                               if (file_exists($filename)) {
-                                       unlink($filename);
-                               }
-                               $filename = $basepath . "/photo/" . $resource_id . "-6." . $Image->getExt();
-                               if (file_exists($filename)) {
-                                       unlink($filename);
-                               }
-                       }
                } else {
                        $photo_failure = true;
                }
@@ -601,29 +632,31 @@ class Photo
        {
                $sql_extra = Security::getPermissionsSQLByUserId($uid);
 
+               $avatar_type = (local_user() && (local_user() == $uid)) ? Photo::USER_AVATAR : Photo::DEFAULT;
+
                $key = "photo_albums:".$uid.":".local_user().":".remote_user();
                $albums = DI::cache()->get($key);
                if (is_null($albums) || $update) {
                        if (!DI::config()->get("system", "no_count", false)) {
                                /// @todo This query needs to be renewed. It is really slow
                                // At this time we just store the data in the cache
-                               $albums = q("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
+                               $albums = DBA::toArray(DBA::p("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
                                        FROM `photo`
-                                       WHERE `uid` = %d  AND `album` != '%s' AND `album` != '%s' $sql_extra
+                                       WHERE `uid` = ? AND `photo-type` IN (?, ?) $sql_extra
                                        GROUP BY `album` ORDER BY `created` DESC",
-                                       intval($uid),
-                                       DBA::escape(self::CONTACT_PHOTOS),
-                                       DBA::escape(DI::l10n()->t(self::CONTACT_PHOTOS))
-                               );
+                                       $uid,
+                                       self::DEFAULT,
+                                       $avatar_type
+                               ));
                        } else {
                                // This query doesn't do the count and is much faster
-                               $albums = q("SELECT DISTINCT(`album`), '' AS `total`
+                               $albums = DBA::toArray(DBA::p("SELECT DISTINCT(`album`), '' AS `total`
                                        FROM `photo` USE INDEX (`uid_album_scale_created`)
-                                       WHERE `uid` = %d  AND `album` != '%s' AND `album` != '%s' $sql_extra",
-                                       intval($uid),
-                                       DBA::escape(self::CONTACT_PHOTOS),
-                                       DBA::escape(DI::l10n()->t(self::CONTACT_PHOTOS))
-                               );
+                                       WHERE `uid` = ? AND `photo-type` IN (?, ?) $sql_extra",
+                                       $uid,
+                                       self::DEFAULT,
+                                       $avatar_type
+                               ));
                        }
                        DI::cache()->set($key, $albums, Duration::DAY);
                }
@@ -756,46 +789,33 @@ class Photo
        }
 
        /**
-        * Strips known picture extensions from picture links
-        *
-        * @param string $name Picture link
-        * @return string stripped picture link
-        * @throws \Exception
-        */
-       public static function stripExtension($name)
-       {
-               $name = str_replace([".jpg", ".png", ".gif"], ["", "", ""], $name);
-               foreach (Images::supportedTypes() as $m => $e) {
-                       $name = str_replace("." . $e, "", $name);
-               }
-               return $name;
-       }
-
-       /**
-        * Returns the GUID from picture links
+        * Fetch the guid and scale from picture links
         *
         * @param string $name Picture link
-        * @return string GUID
-        * @throws \Exception
+        * @return array
         */
-       public static function getGUID($name)
+       public static function getResourceData(string $name):array
        {
                $base = DI::baseUrl()->get();
 
                $guid = str_replace([Strings::normaliseLink($base), '/photo/'], '', Strings::normaliseLink($name));
 
-               $guid = self::stripExtension($guid);
+               if (parse_url($guid, PHP_URL_SCHEME)) {
+                       return [];
+               }
+
+               $guid = pathinfo($guid, PATHINFO_FILENAME);
                if (substr($guid, -2, 1) != "-") {
-                       return '';
+                       return [];
                }
 
                $scale = intval(substr($guid, -1, 1));
                if (!is_numeric($scale)) {
-                       return '';
+                       return [];
                }
 
                $guid = substr($guid, 0, -2);
-               return $guid;
+               return ['guid' => $guid, 'scale' => $scale];
        }
 
        /**
@@ -807,13 +827,27 @@ class Photo
         */
        public static function isLocal($name)
        {
-               $guid = self::getGUID($name);
+               return (bool)self::getIdForName($name);
+       }
 
-               if (empty($guid)) {
-                       return false;
+       /**
+        * Return the id of a local photo
+        *
+        * @param string $name Picture link
+        * @return int
+        */
+       public static function getIdForName($name)
+       {
+               $data = self::getResourceData($name);
+               if (empty($data)) {
+                       return 0;
                }
 
-               return DBA::exists('photo', ['resource-id' => $guid]);
+               $photo = DBA::selectFirst('photo', ['id'], ['resource-id' => $data['guid'], 'scale' => $data['scale']]);
+               if (!empty($photo['id'])) {
+                       return $photo['id'];
+               }
+               return 0;
        }
 
        /**
@@ -917,9 +951,6 @@ class Photo
                @unlink($src);
 
                $max_length = DI::config()->get('system', 'max_image_length');
-               if (!$max_length) {
-                       $max_length = MAX_IMAGE_LENGTH;
-               }
                if ($max_length > 0) {
                        $Image->scaleDown($max_length);
                        $filesize = strlen($Image->asString());
@@ -955,7 +986,7 @@ class Photo
 
                $smallest = 0;
 
-               $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, 0, $defperm);
+               $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $defperm);
                if (!$r) {
                        Logger::notice('Photo could not be stored');
                        return [];
@@ -963,7 +994,7 @@ class Photo
 
                if ($width > 640 || $height > 640) {
                        $Image->scaleDown(640);
-                       $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, 0, $defperm);
+                       $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $defperm);
                        if ($r) {
                                $smallest = 1;
                        }
@@ -971,7 +1002,7 @@ class Photo
 
                if ($width > 320 || $height > 320) {
                        $Image->scaleDown(320);
-                       $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, 0, $defperm);
+                       $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $defperm);
                        if ($r && ($smallest == 0)) {
                                $smallest = 2;
                        }