]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Photo.php
Address code standards issues
[friendica.git] / src / Model / Photo.php
index 5400cafb40394be2d35708c8ad1cf7d4e411e68e..e8f77f8d23e696aa902ce4f1f4cee5b04541250b 100644 (file)
  */
 namespace Friendica\Model;
 
+use Friendica\BaseObject;
 use Friendica\Core\Cache;
 use Friendica\Core\Config;
 use Friendica\Core\L10n;
 use Friendica\Core\System;
 use Friendica\Database\DBA;
+use Friendica\Database\DBStructure;
 use Friendica\Object\Image;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Network;
-
-require_once 'include/dba.php';
+use Friendica\Util\Security;
 
 /**
  * Class to handle photo dabatase table
  */
-class Photo
+class Photo extends BaseObject
 {
        /**
+        * @brief Select rows from the photo table
+        *
+        * @param array  $fields    Array of selected fields, empty for all
+        * @param array  $condition Array of fields for condition
+        * @param array  $params    Array of several parameters
+        *
+        * @return boolean|array
+        *
+        * @see \Friendica\Database\DBA::select
+        */
+       public static function select(array $fields = [], array $condition = [], array $params = [])
+       {
+               if (empty($fields)) {
+                       $selected = self::getFields();
+               }
+
+               $r = DBA::select("photo", $fields, $condition, $params);
+               return DBA::toArray($r);
+       }
+
+       /**
+        * @brief Retrieve a single record from the photo table
+        *
+        * @param array  $fields    Array of selected fields, empty for all
+        * @param array  $condition Array of fields for condition
+        * @param array  $params    Array of several parameters
+        *
+        * @return bool|array
+        *
+        * @see \Friendica\Database\DBA::select
+        */
+       public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
+       {
+               if (empty($fields)) {
+                       $fields = self::getFields();
+               }
+
+               return DBA::selectFirst("photo", $fields, $condition, $params);
+       }
+
+       /**
+        * @brief 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,
+        * false if photo does not exists
+        *
+        * @param string  $resourceid  Rescource ID for the photo
+        * @param integer $scale       Scale of the photo. Defaults to 0
+        *
+        * @return boolean|array
+        */
+       public static function getPhoto($resourceid, $scale = 0)
+       {
+               $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
+               if ($r === false) {
+                       return false;
+               }
+
+               $sql_acl = Security::getPermissionsSQLByUserId($r["uid"]);
+
+               $condition = [
+                       "`resource-id` = ? AND `scale` <= ? " . $sql_acl,
+                       $resourceid, $scale
+               ];
+
+               $params = [ "order" => ["scale" => true]];
+
+               $photo = self::selectFirst([], $condition, $params);
+               if ($photo === false) {
+                       return self::createPhotoForSystemResource("images/nosign.jpg");
+               }
+               return $photo;
+       }
+
+       /**
+        * @brief Check if photo with given resource id exists
+        *
+        * @param string  $resourceid  Resource ID of the photo
+        *
+        * @return boolean
+        */
+       public static function exists($resourceid)
+       {
+               return DBA::count("photo", ["resource-id" => $resourceid]) > 0;
+       }
+
+       /**
+        * @brief Get Image object for given row id. null if row id does not exist
+        *
+        * @param integer  $id  Row id
+        *
+        * @return \Friendica\Object\Image
+        */
+       public static function getImageForPhoto($photo)
+       {
+               $data = "";
+               if ($photo["backend-class"] == "") {
+                       // legacy data storage in "data" column
+                       $i = self::selectFirst(["data"], ["id"=>$photo["id"]]);
+                       if ($i === false) {
+                               return null;
+                       }
+                       $data = $i["data"];
+               } else {
+                       $backendClass = $photo["backend-class"];
+                       $backendRef = $photo["backend-ref"];
+                       $data = $backendClass::get($backendRef);
+               }
+
+               if ($data === "") {
+                       return null;
+               }
+               return new Image($data, $photo["type"]);
+       }
+
+       /**
+        * @brief Return a list of fields that are associated with the photo table
+        *
+        * @return array field list
+        */
+       private static function getFields()
+       {
+               $allfields = DBStructure::definition(false);
+               $fields = array_keys($allfields["photo"]["fields"]);
+               array_splice($fields, array_search("data", $fields), 1);
+               return $fields;
+       }
+
+       /**
+        * @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"
+        *
+        * @return array
+        */
+       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";
+               $photo["backend-ref"] = $filename;
+               $photo["type"] = $mimetype;
+               $photo['cacheable'] = false;
+               return $photo;
+       }
+
+
+       /**
+        * @brief store photo metadata in db and binary in default backend
+        *
         * @param Image   $Image     image
         * @param integer $uid       uid
         * @param integer $cid       cid
@@ -36,7 +190,8 @@ class Photo
         * @param string  $deny_cid  optional, default = ''
         * @param string  $deny_gid  optional, default = ''
         * @param string  $desc      optional, default = ''
-        * @return object
+        *
+        * @return boolean True on success
         */
        public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '', $desc = '')
        {
@@ -49,6 +204,17 @@ class Photo
 
                $existing_photo = DBA::selectFirst('photo', ['id'], ['resource-id' => $rid, 'uid' => $uid, 'contact-id' => $cid, 'scale' => $scale]);
 
+               // Get defined storage backend.
+               // if no storage backend, we use old "data" column in photo table.
+               $data = "";
+               $backend_ref = "";
+               $backend_class = Config::get("storage", "class", "");
+               if ($backend_class === "") {
+                       $data = $Image->asString();
+               } else {
+                       $backend_ref = $backend_class::put($Image->asString());
+               }
+
                $fields = [
                        'uid' => $uid,
                        'contact-id' => $cid,
@@ -62,14 +228,16 @@ class Photo
                        'height' => $Image->getHeight(),
                        'width' => $Image->getWidth(),
                        'datasize' => strlen($Image->asString()),
-                       'data' => $Image->asString(),
+                       'data' => $data,
                        'scale' => $scale,
                        'profile' => $profile,
                        'allow_cid' => $allow_cid,
                        'allow_gid' => $allow_gid,
                        'deny_cid' => $deny_cid,
                        'deny_gid' => $deny_gid,
-                       'desc' => $desc
+                       'desc' => $desc,
+                       'backend-class' => $backend_class,
+                       'backend-ref' => $backend_ref
                ];
 
                if (DBA::isResult($existing_photo)) {
@@ -96,7 +264,7 @@ class Photo
                $photo = DBA::selectFirst(
                        'photo', ['resource-id'], ['uid' => $uid, 'contact-id' => $cid, 'scale' => 4, 'album' => 'Contact Photos']
                );
-               if (x($photo['resource-id'])) {
+               if (!empty($photo['resource-id'])) {
                        $hash = $photo['resource-id'];
                } else {
                        $hash = self::newResource();
@@ -114,7 +282,7 @@ class Photo
                $type = Image::guessType($image_url, true);
                $Image = new Image($img_str, $type);
                if ($Image->isValid()) {
-                       $Image->scaleToSquare(175);
+                       $Image->scaleToSquare(300);
 
                        $r = self::store($Image, $uid, $cid, $hash, $filename, 'Contact Photos', 4);
 
@@ -145,8 +313,8 @@ class Photo
                        $micro = System::baseUrl() . '/photo/' . $hash . '-6.' . $Image->getExt() . $suffix;
 
                        // Remove the cached photo
-                       $a = get_app();
-                       $basepath = $a->get_basepath();
+                       $a = \get_app();
+                       $basepath = $a->getBasePath();
 
                        if (is_dir($basepath . "/photo")) {
                                $filename = $basepath . '/photo/' . $hash . '-4.' . $Image->getExt();
@@ -171,7 +339,7 @@ class Photo
                }
 
                if ($photo_failure) {
-                       $image_url = System::baseUrl() . '/images/person-175.jpg';
+                       $image_url = System::baseUrl() . '/images/person-300.jpg';
                        $thumb = System::baseUrl() . '/images/person-80.jpg';
                        $micro = System::baseUrl() . '/images/person-48.jpg';
                }
@@ -226,7 +394,7 @@ class Photo
         */
        public static function getAlbums($uid, $update = false)
        {
-               $sql_extra = permissions_sql($uid);
+               $sql_extra = Security::getPermissionsSQLByUserId($uid);
 
                $key = "photo_albums:".$uid.":".local_user().":".remote_user();
                $albums = Cache::get($key);
@@ -239,8 +407,8 @@ class Photo
                                        WHERE `uid` = %d  AND `album` != '%s' AND `album` != '%s' $sql_extra
                                        GROUP BY `album` ORDER BY `created` DESC",
                                        intval($uid),
-                                       dbesc('Contact Photos'),
-                                       dbesc(L10n::t('Contact Photos'))
+                                       DBA::escape('Contact Photos'),
+                                       DBA::escape(L10n::t('Contact Photos'))
                                );
                        } else {
                                // This query doesn't do the count and is much faster
@@ -248,11 +416,11 @@ class Photo
                                        FROM `photo` USE INDEX (`uid_album_scale_created`)
                                        WHERE `uid` = %d  AND `album` != '%s' AND `album` != '%s' $sql_extra",
                                        intval($uid),
-                                       dbesc('Contact Photos'),
-                                       dbesc(L10n::t('Contact Photos'))
+                                       DBA::escape('Contact Photos'),
+                                       DBA::escape(L10n::t('Contact Photos'))
                                );
                        }
-                       Cache::set($key, $albums, CACHE_DAY);
+                       Cache::set($key, $albums, Cache::DAY);
                }
                return $albums;
        }
@@ -264,7 +432,7 @@ class Photo
        public static function clearAlbumCache($uid)
        {
                $key = "photo_albums:".$uid.":".local_user().":".remote_user();
-               Cache::set($key, null, CACHE_DAY);
+               Cache::set($key, null, Cache::DAY);
        }
 
        /**