]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Photo.php
code standards
[friendica.git] / src / Model / Photo.php
index fe84d08a4768a474d0421e48f6c751d3d7a344fe..d736890c7c1398a16539e94b2abf6b2418d4ed78 100644 (file)
@@ -10,10 +10,11 @@ use Friendica\BaseObject;
 use Friendica\Core\Cache;
 use Friendica\Core\Config;
 use Friendica\Core\L10n;
-use Friendica\Core\System;
 use Friendica\Core\StorageManager;
+use Friendica\Core\System;
 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;
@@ -29,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);
@@ -50,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 = [])
        {
@@ -70,14 +73,15 @@ class Photo extends BaseObject
        /**
         * @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
+        * @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
         *
-        * @see \Friendica\Database\DBA::select
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::select
         */
        public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
        {
@@ -90,15 +94,16 @@ class Photo extends BaseObject
        /**
         * @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
+        * @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
         *
-        * @see \Friendica\Database\DBA::select
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::select
         */
        public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
        {
@@ -116,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 of 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)
        {
@@ -138,18 +144,17 @@ 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 conditions exists
         *
-        * @param array   $conditions  Array of extra conditions
+        * @param array $conditions Array of extra conditions
         *
         * @return boolean
+        * @throws \Exception
         */
        public static function exists(array $conditions)
        {
@@ -160,13 +165,16 @@ class Photo extends BaseObject
        /**
         * @brief 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'
+        * @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(array $photo)
        {
                $data = "";
+
                if ($photo["backend-class"] == "") {
                        // legacy data storage in "data" column
                        $i = self::selectFirst(["data"], ["id" => $photo["id"]]);
@@ -183,6 +191,7 @@ class Photo extends BaseObject
                if ($data === "") {
                        return null;
                }
+
                return new Image($data, $photo["type"]);
        }
 
@@ -190,10 +199,11 @@ 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()
        {
-               $allfields = DBStructure::definition(false);
+               $allfields = DBStructure::definition(self::getApp()->getBasePath(), false);
                $fields = array_keys($allfields["photo"]["fields"]);
                array_splice($fields, array_search("data", $fields), 1);
                return $fields;
@@ -202,20 +212,23 @@ 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;
+
                return $photo;
        }
 
@@ -238,6 +251,7 @@ class Photo extends BaseObject
         * @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 = "")
        {
@@ -259,14 +273,15 @@ class Photo extends BaseObject
                // 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 = StorageManager::getBackend();
                }
+
                if ($backend_class === "") {
                        $data = $Image->asString();
                } else {
@@ -308,15 +323,17 @@ class Photo extends BaseObject
                return $r;
        }
 
+
        /**
         * @brief Delete info from table and data from storage
         *
-        * @param array  $conditions  Field condition(s)
-        * @param array  $options     Options array, Optional
+        * @param array $conditions Field condition(s)
+        * @param array $options    Options array, Optional
         *
         * @return boolean
         *
-        * @see \Friendica\Database\DBA::delete
+        * @throws \Exception
+        * @see   \Friendica\Database\DBA::delete
         */
        public static function delete(array $conditions, array $options = [])
        {
@@ -324,6 +341,7 @@ class Photo extends BaseObject
                $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"]);
@@ -333,6 +351,178 @@ class Photo extends BaseObject
                return DBA::delete("photo", $conditions, $options);
        }
 
+       /**
+        * @brief This function is used by the fromgplus addon
+        *
+        * Stores a photo based on image data or an URL
+        *
+        * @param integer $uid       user id
+        * @param string  $imagedata optional, default empty
+        * @param string  $url       optional, default empty
+        * @return array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        */
+       public static function storeByData($uid, $imagedata = "", $url = "")
+       {
+               $a = self::getApp();
+               $logger = $a->getLogger();
+               $profiler = $a->getProfiler();
+
+               $isStored = DBA::p(
+                       "SELECT `user`.`nickname`, `user`.`page-flags`, `contact`.`id` FROM `user` INNER JOIN `contact` on `user`.`uid` = `contact`.`uid`
+                       WHERE `user`.`uid` = %d AND `user`.`blocked` = 0 AND `contact`.`self` = 1 LIMIT 1",
+                       intval($uid)
+               );
+
+               if (!DBA::isResult($isStored)) {
+                       $logger->info("Can't detect user data.", ['uid' => $uid]);
+                       return [];
+               } else {
+                       $isStored = DBA::toArray($isStored);
+               }
+
+               $page_owner_nick  = $isStored[0]['nickname'];
+
+               /// @TODO
+               /// $default_cid      = $isStored[0]['id'];
+               /// $community_page   = (($isStored[0]['page-flags'] == User::PAGE_FLAGS_COMMUNITY) ? true : false);
+
+               if ((strlen($imagedata) == 0) && ($url == "")) {
+                       $logger->info("No image data and no url provided");
+                       return [];
+               } elseif (strlen($imagedata) == 0) {
+                       $logger->info("Uploading picture,", ['url' => $url]);
+
+                       $stamp1 = microtime(true);
+                       $imagedata = @file_get_contents($url);
+                       $profiler->saveTimestamp($stamp1, "file", System::callstack());
+               }
+
+               $maxImageSize = Config::get('system', 'maximagesize');
+
+               if (($maxImageSize) && (strlen($imagedata) > $maxImageSize)) {
+                       $logger->info("image exceeds size limit.", ['max' => $maxImageSize, 'current' => strlen($imagedata)]);
+                       return [];
+               }
+
+               $tempFile = tempnam(get_temppath(), "cache");
+
+               $stamp1 = microtime(true);
+               file_put_contents($tempFile, $imagedata);
+               $profiler->saveTimestamp($stamp1, "file", System::callstack());
+
+               $data = getimagesize($tempFile);
+
+               if (!isset($data["mime"])) {
+                       unlink($tempFile);
+                       $logger->info("File is no picture");
+                       return [];
+               }
+
+               $image = new Image($imagedata, $data["mime"]);
+
+               if (!$image->isValid()) {
+                       unlink($tempFile);
+                       $logger->info("Picture is no valid picture");
+                       return [];
+               }
+
+               $image->orient($tempFile);
+               unlink($tempFile);
+
+               $max_length = Config::get('system', 'max_image_length');
+               if (! $max_length) {
+                       $max_length = MAX_IMAGE_LENGTH;
+               }
+
+               if ($max_length > 0) {
+                       $image->scaleDown($max_length);
+               }
+
+               $width = $image->getWidth();
+               $height = $image->getHeight();
+
+               $hash = self::newResource();
+
+               // Pictures are always public by now
+               //$defperm = '<'.$default_cid.'>';
+               $defperm = "";
+               $visitor = 0;
+
+               $isStored = Photo::store($image, $uid, $visitor, $hash, $tempFile, L10n::t('Wall Photos'), 0, 0, $defperm);
+
+               if (!$isStored) {
+                       $logger->info("Picture couldn't be stored");
+                       return [];
+               }
+
+               $image = ["page" => System::baseUrl().'/photos/'.$page_owner_nick.'/image/'.$hash,
+                       "full" => $a->getBaseURL()."/photo/{$hash}-0.".$image->getExt()];
+
+               if ($width > 800 || $height > 800) {
+                       $image["large"] = System::baseUrl()."/photo/{$hash}-0.".$image->getExt();
+               }
+
+               if ($width > 640 || $height > 640) {
+                       $image->scaleDown(640);
+                       $isStored = self::store($image, $uid, $visitor, $hash, $tempFile, L10n::t('Wall Photos'), 1, 0, $defperm);
+                       if ($isStored) {
+                               $image["medium"] = System::baseUrl()."/photo/{$hash}-1.".$image->getExt();
+                       }
+               }
+
+               if ($width > 320 || $height > 320) {
+                       $image->scaleDown(320);
+                       $isStored = self::store($image, $uid, $visitor, $hash, $tempFile, L10n::t('Wall Photos'), 2, 0, $defperm);
+                       if ($isStored) {
+                               $image["small"] = System::baseUrl()."/photo/{$hash}-2.".$image->getExt();
+                       }
+               }
+
+               if ($width > 160 && $height > 160) {
+                       $x = 0;
+                       $y = 0;
+
+                       $min = $image->getWidth();
+                       if ($min > 160) {
+                               $x = ($min - 160) / 2;
+                       }
+
+                       if ($image->getHeight() < $min) {
+                               $min = $image->getHeight();
+                               if ($min > 160) {
+                                       $y = ($min - 160) / 2;
+                               }
+                       }
+
+                       $min = 160;
+                       $image->crop(160, $x, $y, $min, $min);
+
+                       $isStored = self::store($image, $uid, $visitor, $hash, $tempFile, L10n::t('Wall Photos'), 3, 0, $defperm);
+                       if ($isStored) {
+                               $image["thumb"] = $a->getBaseURL() . "/photo/{$hash}-3." . $image->getExt();
+                       }
+               }
+
+               // Set the full image as preview image. This will be overwritten, if the picture is larger than 640.
+               $image["preview"] = $image["full"];
+
+               // Deactivated, since that would result in a cropped preview, if the picture wasn't larger than 320
+               //if (isset($image["thumb"]))
+               //  $image["preview"] = $image["thumb"];
+
+               // Unsure, if this should be activated or deactivated
+               //if (isset($image["small"]))
+               //  $image["preview"] = $image["small"];
+
+               if (isset($image["medium"])) {
+                       $image["preview"] = $image["medium"];
+               }
+
+               return $image;
+       }
+
        /**
         * @brief Update a photo
         *
@@ -343,7 +533,8 @@ class Photo extends BaseObject
         *
         * @return boolean  Was the update successfull?
         *
-        * @see \Friendica\Database\DBA::update
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @see   \Friendica\Database\DBA::update
         */
        public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
        {
@@ -352,6 +543,7 @@ class Photo extends BaseObject
                        $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"]);
@@ -364,7 +556,7 @@ class Photo extends BaseObject
 
                $fields['edited'] = DateTimeFormat::utcNow();
 
-               return DBA::update("photo", $fields, $conditions);
+               return DBA::update("photo", $fields, $conditions, $old_fields);
        }
 
        /**
@@ -373,6 +565,8 @@ class Photo extends BaseObject
         * @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)
        {
@@ -466,7 +660,7 @@ class Photo extends BaseObject
        }
 
        /**
-        * @param string $exifCoord coordinate
+        * @param array $exifCoord coordinate
         * @param string $hemi      hemi
         * @return float
         */
@@ -509,6 +703,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)
        {
@@ -546,6 +741,7 @@ class Photo extends BaseObject
        /**
         * @param int $uid User id of the photos
         * @return void
+        * @throws \Exception
         */
        public static function clearAlbumCache($uid)
        {
@@ -557,6 +753,7 @@ class Photo extends BaseObject
         * Generate a unique photo ID.
         *
         * @return string
+        * @throws \Exception
         */
        public static function newResource()
        {