]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Photo.php
Merge pull request #6515 from annando/connector-posts
[friendica.git] / src / Model / Photo.php
index 3e0d5e40acca916f1c216807a49db9483d341aba..0778bf41969d4ce346c41553e75f1fda79ff2c4a 100644 (file)
@@ -11,8 +11,10 @@ use Friendica\Core\Cache;
 use Friendica\Core\Config;
 use Friendica\Core\L10n;
 use Friendica\Core\System;
+use Friendica\Core\StorageManager;
 use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
+use Friendica\Model\Storage\IStorage;
 use Friendica\Object\Image;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Network;
@@ -28,18 +30,19 @@ class Photo extends BaseObject
        /**
         * @brief Select rows from the photo table
         *
-        * @param array  $fields     Array of selected fields, empty for all
-        * @param array  $conditions Array of fields for conditions
-        * @param array  $params     Array of several parameters
+        * @param array $fields     Array of selected fields, empty for all
+        * @param array $conditions Array of fields for conditions
+        * @param array $params     Array of several parameters
         *
         * @return boolean|array
         *
-        * @see \Friendica\Database\DBA::select
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::select
         */
        public static function select(array $fields = [], array $conditions = [], array $params = [])
        {
                if (empty($fields)) {
-                       $selected = self::getFields();
+                       $fields = self::getFields();
                }
 
                $r = DBA::select("photo", $fields, $conditions, $params);
@@ -49,13 +52,14 @@ class Photo extends BaseObject
        /**
         * @brief 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
-        * @param array  $params     Array of several parameters
+        * @param array $fields     Array of selected fields, empty for all
+        * @param array $conditions Array of fields for conditions
+        * @param array $params     Array of several parameters
         *
         * @return bool|array
         *
-        * @see \Friendica\Database\DBA::select
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::select
         */
        public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
        {
@@ -66,6 +70,50 @@ class Photo extends BaseObject
                return DBA::selectFirst("photo", $fields, $conditions, $params);
        }
 
+       /**
+        * @brief Get photos for user id
+        *
+        * @param integer $uid        User id
+        * @param string  $resourceid Rescource ID of the photo
+        * @param array   $conditions Array of fields for conditions
+        * @param array   $params     Array of several parameters
+        *
+        * @return bool|array
+        *
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::select
+        */
+       public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
+       {
+               $conditions["resource-id"] = $resourceid;
+               $conditions["uid"] = $uid;
+
+               return self::select([], $conditions, $params);
+       }
+
+       /**
+        * @brief Get a photo for user id
+        *
+        * @param integer $uid        User id
+        * @param string  $resourceid Rescource ID of the photo
+        * @param integer $scale      Scale of the photo. Defaults to 0
+        * @param array   $conditions Array of fields for conditions
+        * @param array   $params     Array of several parameters
+        *
+        * @return bool|array
+        *
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::select
+        */
+       public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
+       {
+               $conditions["resource-id"] = $resourceid;
+               $conditions["uid"] = $uid;
+               $conditions["scale"] = $scale;
+
+               return self::selectFirst([], $conditions, $params);
+       }
+
        /**
         * @brief Get a single photo given resource id and scale
         *
@@ -73,10 +121,11 @@ class Photo extends BaseObject
         * on success, "no sign" image info, if user has no permission,
         * false if photo does not exists
         *
-        * @param string  $resourceid  Rescource ID for the photo
-        * @param integer $scale       Scale of the photo. Defaults to 0
+        * @param string  $resourceid Rescource ID of the photo
+        * @param integer $scale      Scale of the photo. Defaults to 0
         *
         * @return boolean|array
+        * @throws \Exception
         */
        public static function getPhoto($resourceid, $scale = 0)
        {
@@ -95,34 +144,35 @@ class Photo extends BaseObject
                $params = ["order" => ["scale" => true]];
 
                $photo = self::selectFirst([], $conditions, $params);
-               if ($photo === false) {
-                       return self::createPhotoForSystemResource("images/nosign.jpg");
-               }
+
                return $photo;
        }
 
        /**
-        * @brief Check if photo with given resource id exists
+        * @brief Check if photo with given conditions exists
         *
-        * @param string  $resourceid  Resource ID of the photo
+        * @param array $conditions Array of extra conditions
         *
         * @return boolean
+        * @throws \Exception
         */
-       public static function exists($resourceid)
+       public static function exists(array $conditions)
        {
-               return DBA::count("photo", ["resource-id" => $resourceid]) > 0;
+               return DBA::exists("photo", $conditions);
        }
 
+
        /**
         * @brief Get Image object for given row id. null if row id does not exist
         *
-        * @param integer  $id  Row id
+        * @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 getImageForPhoto($photo)
+       public static function getImageForPhoto(array $photo)
        {
-               $data = "";
                if ($photo["backend-class"] == "") {
                        // legacy data storage in "data" column
                        $i = self::selectFirst(["data"], ["id" => $photo["id"]]);
@@ -146,6 +196,7 @@ class Photo extends BaseObject
         * @brief Return a list of fields that are associated with the photo table
         *
         * @return array field list
+        * @throws \Exception
         */
        private static function getFields()
        {
@@ -158,17 +209,18 @@ class Photo extends BaseObject
        /**
         * @brief 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 $filename Image file name relative to code root
+        * @param string $mimetype Image mime type. Defaults to "image/jpeg"
         *
         * @return array
+        * @throws \Exception
         */
        public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
        {
                $fields = self::getFields();
                $values = array_fill(0, count($fields), "");
                $photo = array_combine($fields, $values);
-               $photo["backend-class"] = \Friendica\Model\Storage\SystemResource::class;
+               $photo["backend-class"] = Storage\SystemResource::class;
                $photo["backend-ref"] = $filename;
                $photo["type"] = $mimetype;
                $photo["cacheable"] = false;
@@ -179,21 +231,22 @@ class Photo extends BaseObject
        /**
         * @brief store photo metadata in db and binary in default backend
         *
-        * @param Image   $Image     image
-        * @param integer $uid       uid
-        * @param integer $cid       cid
-        * @param integer $rid       rid
-        * @param string  $filename  filename
-        * @param string  $album     album name
-        * @param integer $scale     scale
-        * @param integer $profile   optional, default = 0
-        * @param string  $allow_cid optional, default = ""
-        * @param string  $allow_gid optional, default = ""
-        * @param string  $deny_cid  optional, default = ""
-        * @param string  $deny_gid  optional, default = ""
-        * @param string  $desc      optional, default = ""
+        * @param Image   $Image     Image object with data
+        * @param integer $uid       User ID
+        * @param integer $cid       Contact ID
+        * @param integer $rid       Resource ID
+        * @param string  $filename  Filename
+        * @param string  $album     Album name
+        * @param integer $scale     Scale
+        * @param integer $profile   Is a profile image? optional, default = 0
+        * @param string  $allow_cid Permissions, allowed contacts. optional, default = ""
+        * @param string  $allow_gid Permissions, allowed groups. optional, default = ""
+        * @param string  $deny_cid  Permissions, denied contacts.optional, default = ""
+        * @param string  $deny_gid  Permissions, denied greoup.optional, default = ""
+        * @param string  $desc      Photo caption. optional, default = ""
         *
         * @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 = "")
        {
@@ -204,21 +257,26 @@ class Photo extends BaseObject
                        $guid = System::createGUID();
                }
 
-               $existing_photo = self::selectFirst(["id", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
+               $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
+               $created = DateTimeFormat::utcNow();
+               if (DBA::isResult($existing_photo)) {
+                       $created = $existing_photo["created"];
+               }
 
                // 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 = "";
                $backend_ref = "";
-               $backend_class = "";
 
+               /** @var IStorage $backend_class */
                if (DBA::isResult($existing_photo)) {
                        $backend_ref = (string)$existing_photo["backend-ref"];
                        $backend_class = (string)$existing_photo["backend-class"];
                } else {
-                       $backend_class = Config::get("storage", "class", "");
+                       $backend_class = StorageManager::getBackend();
                }
+
                if ($backend_class === "") {
                        $data = $Image->asString();
                } else {
@@ -231,7 +289,7 @@ class Photo extends BaseObject
                        "contact-id" => $cid,
                        "guid" => $guid,
                        "resource-id" => $rid,
-                       "created" => DateTimeFormat::utcNow(),
+                       "created" => $created,
                        "edited" => DateTimeFormat::utcNow(),
                        "filename" => basename($filename),
                        "type" => $Image->getType(),
@@ -260,12 +318,25 @@ class Photo extends BaseObject
                return $r;
        }
 
-       public static function delete(array $conditions, $options = [])
+
+       /**
+        * @brief Delete info from table and data from storage
+        *
+        * @param array $conditions Field condition(s)
+        * @param array $options    Options array, Optional
+        *
+        * @return boolean
+        *
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::delete
+        */
+       public static function delete(array $conditions, array $options = [])
        {
                // get photo to delete data info
                $photos = self::select(["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"]);
@@ -275,12 +346,50 @@ class Photo extends BaseObject
                return DBA::delete("photo", $conditions, $options);
        }
 
+       /**
+        * @brief Update a photo
+        *
+        * @param array         $fields     Contains the fields that are updated
+        * @param array         $conditions Condition array with the key values
+        * @param Image         $img        Image to update. Optional, default null.
+        * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
+        *
+        * @return boolean  Was the update successfull?
+        *
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @see   \Friendica\Database\DBA::update
+        */
+       public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
+       {
+               if (!is_null($img)) {
+                       // get photo to update
+                       $photos = self::select(["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"]);
+                               } else {
+                                       $fields["data"] = $img->asString();
+                               }
+                       }
+                       $fields['updated'] = DateTimeFormat::utcNow();
+               }
+
+               $fields['edited'] = DateTimeFormat::utcNow();
+
+               return DBA::update("photo", $fields, $conditions, $old_fields);
+       }
+
        /**
         * @param string  $image_url     Remote URL
         * @param integer $uid           user id
         * @param integer $cid           contact id
         * @param boolean $quit_on_error optional, default false
         * @return array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
        {
@@ -374,7 +483,7 @@ class Photo extends BaseObject
        }
 
        /**
-        * @param string $exifCoord coordinate
+        * @param array $exifCoord coordinate
         * @param string $hemi      hemi
         * @return float
         */
@@ -417,6 +526,7 @@ class Photo extends BaseObject
         * @param bool $update Update the cache
         *
         * @return array Returns array of the photo albums
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function getAlbums($uid, $update = false)
        {
@@ -454,6 +564,7 @@ class Photo extends BaseObject
        /**
         * @param int $uid User id of the photos
         * @return void
+        * @throws \Exception
         */
        public static function clearAlbumCache($uid)
        {
@@ -465,9 +576,10 @@ class Photo extends BaseObject
         * Generate a unique photo ID.
         *
         * @return string
+        * @throws \Exception
         */
        public static function newResource()
        {
-               return system::createGUID(32, false);
+               return System::createGUID(32, false);
        }
 }