]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Photo.php
Merge pull request #8265 from nupplaphil/task/add_license
[friendica.git] / src / Model / Photo.php
index df4d50dd3dbc58d0380f6425ef75d7222e721a47..ccb0f2add4e972ecee1a89c1df2ae71b43c99c8d 100644 (file)
@@ -1,21 +1,33 @@
 <?php
-
 /**
- * @file src/Model/Photo.php
- * @brief This file contains the Photo class for database interface
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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\Model;
 
-use Friendica\Core\Cache;
-use Friendica\Core\Config;
-use Friendica\Core\L10n;
+use Friendica\Core\Cache\Duration;
 use Friendica\Core\Logger;
-use Friendica\Core\StorageManager;
 use Friendica\Core\System;
 use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
 use Friendica\DI;
-use Friendica\Model\Storage\IStorage;
+use Friendica\Model\Storage\SystemResource;
 use Friendica\Object\Image;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Images;
@@ -31,7 +43,7 @@ require_once "include/dba.php";
 class Photo
 {
        /**
-        * @brief Select rows from the photo table and returns them as array
+        * Select rows from the photo table and returns them as array
         *
         * @param array $fields     Array of selected fields, empty for all
         * @param array $conditions Array of fields for conditions
@@ -52,7 +64,7 @@ class Photo
        }
 
        /**
-        * @brief Retrieve a single record from the photo table
+        * Retrieve a single record from the photo table
         *
         * @param array $fields     Array of selected fields, empty for all
         * @param array $conditions Array of fields for conditions
@@ -73,7 +85,7 @@ class Photo
        }
 
        /**
-        * @brief Get photos for user id
+        * Get photos for user id
         *
         * @param integer $uid        User id
         * @param string  $resourceid Rescource ID of the photo
@@ -94,7 +106,7 @@ class Photo
        }
 
        /**
-        * @brief Get a photo for user id
+        * Get a photo for user id
         *
         * @param integer $uid        User id
         * @param string  $resourceid Rescource ID of the photo
@@ -117,7 +129,7 @@ class Photo
        }
 
        /**
-        * @brief Get a single photo given resource id and scale
+        * Get a single photo given resource id and scale
         *
         * This method checks for permissions. Returns associative array
         * on success, "no sign" image info, if user has no permission,
@@ -148,7 +160,7 @@ class Photo
        }
 
        /**
-        * @brief Check if photo with given conditions exists
+        * Check if photo with given conditions exists
         *
         * @param array $conditions Array of extra conditions
         *
@@ -162,7 +174,7 @@ class Photo
 
 
        /**
-        * @brief Get Image object for given row id. null if row id does not exist
+        * Get Image object for given row id. null if row id does not exist
         *
         * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
         *
@@ -172,30 +184,28 @@ class Photo
         */
        public static function getImageForPhoto(array $photo)
        {
-               $data = "";
-
-               if ($photo["backend-class"] == "") {
+               $backendClass = DI::storageManager()->getByName($photo['backend-class'] ?? '');
+               if ($backendClass === null) {
                        // legacy data storage in "data" column
-                       $i = self::selectFirst(["data"], ["id" => $photo["id"]]);
+                       $i = self::selectFirst(['data'], ['id' => $photo['id']]);
                        if ($i === false) {
                                return null;
                        }
-                       $data = $i["data"];
+                       $data = $i['data'];
                } else {
-                       $backendClass = $photo["backend-class"];
-                       $backendRef = $photo["backend-ref"];
-                       $data = $backendClass::get($backendRef);
+                       $backendRef = $photo['backend-ref'] ?? '';
+                       $data = $backendClass->get($backendRef);
                }
 
-               if ($data === "") {
+               if (empty($data)) {
                        return null;
                }
 
-               return new Image($data, $photo["type"]);
+               return new Image($data, $photo['type']);
        }
 
        /**
-        * @brief Return a list of fields that are associated with the photo table
+        * Return a list of fields that are associated with the photo table
         *
         * @return array field list
         * @throws \Exception
@@ -209,7 +219,7 @@ class Photo
        }
 
        /**
-        * @brief Construct a photo array for a system resource image
+        * 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"
@@ -222,18 +232,18 @@ class Photo
                $fields = self::getFields();
                $values = array_fill(0, count($fields), "");
 
-               $photo = array_combine($fields, $values);
-               $photo["backend-class"] = Storage\SystemResource::class;
-               $photo["backend-ref"] = $filename;
-               $photo["type"] = $mimetype;
-               $photo["cacheable"] = false;
+               $photo                  = array_combine($fields, $values);
+               $photo['backend-class'] = SystemResource::NAME;
+               $photo['backend-ref']   = $filename;
+               $photo['type']          = $mimetype;
+               $photo['cacheable']     = false;
 
                return $photo;
        }
 
 
        /**
-        * @brief store photo metadata in db and binary in default backend
+        * store photo metadata in db and binary in default backend
         *
         * @param Image   $Image     Image object with data
         * @param integer $uid       User ID
@@ -273,18 +283,17 @@ class Photo
                $data = "";
                $backend_ref = "";
 
-               /** @var IStorage $backend_class */
                if (DBA::isResult($existing_photo)) {
                        $backend_ref = (string)$existing_photo["backend-ref"];
-                       $backend_class = (string)$existing_photo["backend-class"];
+                       $storage = DI::storageManager()->getByName($existing_photo["backend-class"] ?? '');
                } else {
-                       $backend_class = StorageManager::getBackend();
+                       $storage = DI::storage();
                }
 
-               if ($backend_class === "") {
+               if ($storage === null) {
                        $data = $Image->asString();
                } else {
-                       $backend_ref = $backend_class::put($Image->asString(), $backend_ref);
+                       $backend_ref = $storage->put($Image->asString(), $backend_ref);
                }
 
 
@@ -309,7 +318,7 @@ class Photo
                        "deny_cid" => $deny_cid,
                        "deny_gid" => $deny_gid,
                        "desc" => $desc,
-                       "backend-class" => $backend_class,
+                       "backend-class" => (string)$storage,
                        "backend-ref" => $backend_ref
                ];
 
@@ -324,7 +333,7 @@ class Photo
 
 
        /**
-        * @brief Delete info from table and data from storage
+        * Delete info from table and data from storage
         *
         * @param array $conditions Field condition(s)
         * @param array $options    Options array, Optional
@@ -340,10 +349,9 @@ class Photo
                $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
 
                foreach($photos as $photo) {
-                       /** @var IStorage $backend_class */
-                       $backend_class = (string)$photo["backend-class"];
-                       if ($backend_class !== "") {
-                               $backend_class::delete($photo["backend-ref"]);
+                       $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
+                       if ($backend_class !== null) {
+                               $backend_class->delete($photo["backend-ref"] ?? '');
                        }
                }
 
@@ -351,7 +359,7 @@ class Photo
        }
 
        /**
-        * @brief Update a photo
+        * Update a photo
         *
         * @param array         $fields     Contains the fields that are updated
         * @param array         $conditions Condition array with the key values
@@ -370,10 +378,9 @@ class Photo
                        $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
 
                        foreach($photos as $photo) {
-                               /** @var IStorage $backend_class */
-                               $backend_class = (string)$photo["backend-class"];
-                               if ($backend_class !== "") {
-                                       $fields["backend-ref"] = $backend_class::put($img->asString(), $photo["backend-ref"]);
+                               $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
+                               if ($backend_class !== null) {
+                                       $fields["backend-ref"] = $backend_class->put($img->asString(), $photo['backend-ref']);
                                } else {
                                        $fields["data"] = $img->asString();
                                }
@@ -531,7 +538,7 @@ class Photo
        }
 
        /**
-        * @brief Fetch the photo albums that are available for a viewer
+        * Fetch the photo albums that are available for a viewer
         *
         * The query in this function is cost intensive, so it is cached.
         *
@@ -548,7 +555,7 @@ class Photo
                $key = "photo_albums:".$uid.":".local_user().":".remote_user();
                $albums = DI::cache()->get($key);
                if (is_null($albums) || $update) {
-                       if (!Config::get("system", "no_count", false)) {
+                       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`
@@ -557,7 +564,7 @@ class Photo
                                        GROUP BY `album` ORDER BY `created` DESC",
                                        intval($uid),
                                        DBA::escape("Contact Photos"),
-                                       DBA::escape(L10n::t("Contact Photos"))
+                                       DBA::escape(DI::l10n()->t("Contact Photos"))
                                );
                        } else {
                                // This query doesn't do the count and is much faster
@@ -566,10 +573,10 @@ class Photo
                                        WHERE `uid` = %d  AND `album` != '%s' AND `album` != '%s' $sql_extra",
                                        intval($uid),
                                        DBA::escape("Contact Photos"),
-                                       DBA::escape(L10n::t("Contact Photos"))
+                                       DBA::escape(DI::l10n()->t("Contact Photos"))
                                );
                        }
-                       DI::cache()->set($key, $albums, Cache::DAY);
+                       DI::cache()->set($key, $albums, Duration::DAY);
                }
                return $albums;
        }
@@ -582,7 +589,7 @@ class Photo
        public static function clearAlbumCache($uid)
        {
                $key = "photo_albums:".$uid.":".local_user().":".remote_user();
-               DI::cache()->set($key, null, Cache::DAY);
+               DI::cache()->set($key, null, Duration::DAY);
        }
 
        /**
@@ -596,6 +603,25 @@ class Photo
                return System::createGUID(32, false);
        }
 
+       /**
+        * Extracts the rid from a local photo URI
+        *
+        * @param string $image_uri The URI of the photo
+        * @return string The rid of the photo, or an empty string if the URI is not local
+        */
+       public static function ridFromURI(string $image_uri)
+       {
+               if (!stristr($image_uri, DI::baseUrl() . '/photo/')) {
+                       return '';
+               }
+               $image_uri = substr($image_uri, strrpos($image_uri, '/') + 1);
+               $image_uri = substr($image_uri, 0, strpos($image_uri, '-'));
+               if (!strlen($image_uri)) {
+                       return '';
+               }
+               return $image_uri;
+       }
+
        /**
         * Changes photo permissions that had been embedded in a post
         *
@@ -622,12 +648,8 @@ class Photo
                }
 
                foreach ($images as $image) {
-                       if (!stristr($image, DI::baseUrl() . '/photo/')) {
-                               continue;
-                       }
-                       $image_uri = substr($image,strrpos($image,'/') + 1);
-                       $image_uri = substr($image_uri,0, strpos($image_uri,'-'));
-                       if (!strlen($image_uri)) {
+                       $image_rid = self::ridFromURI($image);
+                       if (empty($image_rid)) {
                                continue;
                        }
 
@@ -636,7 +658,7 @@ class Photo
 
                        $condition = [
                                'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
-                               'resource-id' => $image_uri, 'uid' => $uid
+                               'resource-id' => $image_rid, 'uid' => $uid
                        ];
                        if (!Photo::exists($condition)) {
                                continue;
@@ -646,7 +668,7 @@ class Photo
 
                        $fields = ['allow_cid' => $str_contact_allow, 'allow_gid' => $str_group_allow,
                                        'deny_cid' => $str_contact_deny, 'deny_gid' => $str_group_deny];
-                       $condition = ['resource-id' => $image_uri, 'uid' => $uid];
+                       $condition = ['resource-id' => $image_rid, 'uid' => $uid];
                        Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
                        Photo::update($fields, $condition);
                }