]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Photo.php
Merge remote-tracking branch 'upstream/2021.12-rc' into user-banner
[friendica.git] / src / Model / Photo.php
index d27bac47aceaaf385e82c5f7274da6f5476a2f56..8ba01e33655d280ede203d5f774e3c6b51465a42 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
  *
@@ -46,6 +46,7 @@ class Photo
 {
        const CONTACT_PHOTOS = 'Contact Photos';
        const PROFILE_PHOTOS = 'Profile Photos';
+       const BANNER_PHOTOS  = 'Banner Photos';
 
        const DEFAULT        = 0;
        const USER_AVATAR    = 10;
@@ -632,7 +633,8 @@ class Photo
        {
                $sql_extra = Security::getPermissionsSQLByUserId($uid);
 
-               $avatar_type = (local_user() && (local_user() == $uid)) ? Photo::USER_AVATAR : Photo::DEFAULT;
+               $avatar_type = (local_user() && (local_user() == $uid)) ? self::USER_AVATAR : self::DEFAULT;
+               $banner_type = (local_user() && (local_user() == $uid)) ? self::USER_BANNER : self::DEFAULT;
 
                $key = "photo_albums:".$uid.":".local_user().":".remote_user();
                $albums = DI::cache()->get($key);
@@ -642,19 +644,21 @@ class Photo
                                // At this time we just store the data in the cache
                                $albums = DBA::toArray(DBA::p("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
                                        FROM `photo`
-                                       WHERE `uid` = ? AND `photo-type` IN (?, ?) $sql_extra
+                                       WHERE `uid` = ? AND `photo-type` IN (?, ?, ?) $sql_extra
                                        GROUP BY `album` ORDER BY `created` DESC",
                                        $uid,
                                        self::DEFAULT,
+                                       $banner_type,
                                        $avatar_type
                                ));
                        } else {
                                // This query doesn't do the count and is much faster
                                $albums = DBA::toArray(DBA::p("SELECT DISTINCT(`album`), '' AS `total`
                                        FROM `photo` USE INDEX (`uid_album_scale_created`)
-                                       WHERE `uid` = ? AND `photo-type` IN (?, ?) $sql_extra",
+                                       WHERE `uid` = ? AND `photo-type` IN (?, ?, ?) $sql_extra",
                                        $uid,
                                        self::DEFAULT,
+                                       $banner_type,
                                        $avatar_type
                                ));
                        }
@@ -742,7 +746,7 @@ class Photo
                                'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
                                'resource-id' => $image_rid, 'uid' => $uid
                        ];
-                       if (!Photo::exists($condition)) {
+                       if (!self::exists($condition)) {
                                $photo = self::selectFirst(['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'uid'], ['resource-id' => $image_rid]);
                                if (!DBA::isResult($photo)) {
                                        Logger::info('Image not found', ['resource-id' => $image_rid]);
@@ -768,7 +772,7 @@ class Photo
        /**
         * Add permissions to photo ressource
         * @todo mix with previous photo permissions
-        * 
+        *
         * @param string $image_rid
         * @param integer $uid
         * @param string $str_contact_allow
@@ -785,7 +789,7 @@ class Photo
 
                $condition = ['resource-id' => $image_rid, 'uid' => $uid];
                Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
-               Photo::update($fields, $condition);
+               self::update($fields, $condition);
        }
 
        /**
@@ -870,22 +874,73 @@ class Photo
                return DBA::exists('photo', ['resource-id' => $guid]);
        }
 
-       /**
-        * 
-        * @param int   $uid   User ID
-        * @param array $files uploaded file array
-        * @return array photo record
-        */
-       public static function upload(int $uid, array $files)
+       private static function fitImageSize($Image)
        {
-               Logger::info('starting new upload');
+               $max_length = DI::config()->get('system', 'max_image_length');
+               if ($max_length > 0) {
+                       $Image->scaleDown($max_length);
+                       Logger::info('File upload: Scaling picture to new size', ['max-length' => $max_length]);
+               }
 
-               $user = User::getOwnerDataById($uid);
-               if (empty($user)) {
-                       Logger::notice('User not found', ['uid' => $uid]);
+               $filesize = strlen($Image->asString());
+               $width    = $Image->getWidth();
+               $height   = $Image->getHeight();
+
+               $maximagesize = DI::config()->get('system', 'maximagesize');
+
+               if (!empty($maximagesize) && ($filesize > $maximagesize)) {
+                       // Scale down to multiples of 640 until the maximum size isn't exceeded anymore
+                       foreach ([5120, 2560, 1280, 640] as $pixels) {
+                               if (($filesize > $maximagesize) && (max($width, $height) > $pixels)) {
+                                       Logger::info('Resize', ['size' => $filesize, 'width' => $width, 'height' => $height, 'max' => $maximagesize, 'pixels' => $pixels]);
+                                       $Image->scaleDown($pixels);
+                                       $filesize = strlen($Image->asString());
+                                       $width = $Image->getWidth();
+                                       $height = $Image->getHeight();
+                               }
+                       }
+                       if ($filesize > $maximagesize) {
+                               Logger::notice('Image size is too big', ['size' => $filesize, 'max' => $maximagesize]);
+                               return null;
+                       }
+               }
+
+               return $Image;
+       }
+
+       private static function loadImageFromURL(string $image_url)
+       {
+               $filename = basename($image_url);
+               if (!empty($image_url)) {
+                       $ret = DI::httpClient()->get($image_url);
+                       $img_str = $ret->getBody();
+                       $type = $ret->getContentType();
+               } else {
+                       $img_str = '';
+                       $type = '';
+               }
+
+               if (empty($img_str)) {
+                       Logger::notice('Empty content');
                        return [];
                }
 
+               $type = Images::getMimeTypeByData($img_str, $image_url, $type);
+
+               $Image = new Image($img_str, $type);
+
+               $Image = self::fitImageSize($Image);
+               if (empty($Image)) {
+                       return [];
+               }
+
+               return ['image' => $Image, 'filename' => $filename];
+       }
+
+       private static function uploadImage(array $files)
+       {
+               Logger::info('starting new upload');
+
                if (empty($files)) {
                        Logger::notice('Empty upload file');
                        return [];
@@ -932,7 +987,7 @@ class Photo
                }
 
                if (empty($src)) {
-                       Logger::notice('No source file name', ['uid' => $uid, 'files' => $files]);
+                       Logger::notice('No source file name', ['files' => $files]);
                        return [];
                }
 
@@ -943,50 +998,64 @@ class Photo
                $imagedata = @file_get_contents($src);
                $Image = new Image($imagedata, $filetype);
                if (!$Image->isValid()) {
-                       Logger::notice('Image is unvalid', ['uid' => $uid, 'files' => $files]);
+                       Logger::notice('Image is unvalid', ['files' => $files]);
                        return [];
                }
 
                $Image->orient($src);
                @unlink($src);
 
-               $max_length = DI::config()->get('system', 'max_image_length');
-               if ($max_length > 0) {
-                       $Image->scaleDown($max_length);
-                       $filesize = strlen($Image->asString());
-                       Logger::info('File upload: Scaling picture to new size', ['max-length' => $max_length]);
+               $Image = self::fitImageSize($Image);
+               if (empty($Image)) {
+                       return [];
                }
 
-               $width = $Image->getWidth();
-               $height = $Image->getHeight();
+               return ['image' => $Image, 'filename' => $filename];
+       }
 
-               $maximagesize = DI::config()->get('system', 'maximagesize');
+       /**
+        * @param int         $uid   User ID
+        * @param array       $files uploaded file array
+        * @param string      $album
+        * @param string|null $allow_cid
+        * @param string|null $allow_gid
+        * @param string      $deny_cid
+        * @param string      $deny_gid
+        * @param string      $desc
+        * @param string      $resource_id
+        * @return array photo record
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        */
+       public static function upload(int $uid, array $files, string $album = '', string $allow_cid = null, string $allow_gid = null, string $deny_cid = '', string $deny_gid = '', string $desc = '', string $resource_id = ''): array
+       {
+               $user = User::getOwnerDataById($uid);
+               if (empty($user)) {
+                       Logger::notice('User not found', ['uid' => $uid]);
+                       return [];
+               }
 
-               if (!empty($maximagesize) && ($filesize > $maximagesize)) {
-                       // Scale down to multiples of 640 until the maximum size isn't exceeded anymore
-                       foreach ([5120, 2560, 1280, 640] as $pixels) {
-                               if (($filesize > $maximagesize) && (max($width, $height) > $pixels)) {
-                                       Logger::info('Resize', ['size' => $filesize, 'width' => $width, 'height' => $height, 'max' => $maximagesize, 'pixels' => $pixels]);
-                                       $Image->scaleDown($pixels);
-                                       $filesize = strlen($Image->asString());
-                                       $width = $Image->getWidth();
-                                       $height = $Image->getHeight();
-                               }
-                       }
-                       if ($filesize > $maximagesize) {
-                               @unlink($src);
-                               Logger::notice('Image size is too big', ['size' => $filesize, 'max' => $maximagesize]);
-                               return [];
-                       }
+               $data = self::uploadImage($files);
+               if (empty($data)) {
+                       Logger::info('upload failed');
+                       return [];
                }
 
-               $resource_id = Photo::newResource();
-               $album       = DI::l10n()->t('Wall Photos');
-               $defperm     = '<' . $user['id'] . '>';
+               $Image    = $data['image'];
+               $filename = $data['filename'];
+               $width    = $Image->getWidth();
+               $height   = $Image->getHeight();
+
+               $resource_id = $resource_id ?: self::newResource();
+               $album       = $album ?: DI::l10n()->t('Wall Photos');
+
+               if (is_null($allow_cid) && is_null($allow_gid)) {
+                       $allow_cid = '<' . $user['id'] . '>';
+                       $allow_gid = '';
+               }
 
                $smallest = 0;
 
-               $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $defperm);
+               $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
                if (!$r) {
                        Logger::notice('Photo could not be stored');
                        return [];
@@ -994,7 +1063,7 @@ class Photo
 
                if ($width > 640 || $height > 640) {
                        $Image->scaleDown(640);
-                       $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $defperm);
+                       $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
                        if ($r) {
                                $smallest = 1;
                        }
@@ -1002,7 +1071,7 @@ class Photo
 
                if ($width > 320 || $height > 320) {
                        $Image->scaleDown(320);
-                       $r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $defperm);
+                       $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
                        if ($r && ($smallest == 0)) {
                                $smallest = 2;
                        }
@@ -1017,16 +1086,152 @@ class Photo
 
                $picture = [];
 
-               $picture['id']        = $photo['id'];
-               $picture['size']      = $photo['datasize'];
-               $picture['width']     = $photo['width'];
-               $picture['height']    = $photo['height'];
-               $picture['type']      = $photo['type'];
-               $picture['albumpage'] = DI::baseUrl() . '/photos/' . $user['nickname'] . '/image/' . $resource_id;
-               $picture['picture']   = DI::baseUrl() . '/photo/{$resource_id}-0.' . $Image->getExt();
-               $picture['preview']   = DI::baseUrl() . '/photo/{$resource_id}-{$smallest}.' . $Image->getExt();
+               $picture['id']          = $photo['id'];
+               $picture['resource_id'] = $resource_id;
+               $picture['size']        = $photo['datasize'];
+               $picture['width']       = $photo['width'];
+               $picture['height']      = $photo['height'];
+               $picture['type']        = $photo['type'];
+               $picture['albumpage']   = DI::baseUrl() . '/photos/' . $user['nickname'] . '/image/' . $resource_id;
+               $picture['picture']     = DI::baseUrl() . '/photo/{$resource_id}-0.' . $Image->getExt();
+               $picture['preview']     = DI::baseUrl() . '/photo/{$resource_id}-{$smallest}.' . $Image->getExt();
 
                Logger::info('upload done', ['picture' => $picture]);
                return $picture;
        }
+
+       /**
+        * Upload a user avatar
+        *
+        * @param int    $uid   User ID
+        * @param array  $files uploaded file array
+        * @param string $url   External image url
+        * @return string avatar resource
+        */
+       public static function uploadAvatar(int $uid, array $files, string $url = ''): string
+       {
+               if (!empty($files)) {
+                       $data = self::uploadImage($files);
+                       if (empty($data)) {
+                               Logger::info('upload failed');
+                               return '';
+                       }
+               } elseif (!empty($url)) {
+                       $data = self::loadImageFromURL($url);
+                       if (empty($data)) {
+                               Logger::info('loading from external url failed');
+                               return '';
+                       }
+               } else {
+                       Logger::info('Neither files nor url provided');
+                       return '';
+               }
+
+               $Image    = $data['image'];
+               $filename = $data['filename'];
+               $width    = $Image->getWidth();
+               $height   = $Image->getHeight();
+
+               $resource_id = self::newResource();
+               $album       = DI::l10n()->t(self::PROFILE_PHOTOS);
+
+               // upload profile image (scales 4, 5, 6)
+               logger::info('starting new profile image upload');
+
+               if ($width > 300 || $height > 300) {
+                       $Image->scaleDown(300);
+               }
+
+               $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 4, self::USER_AVATAR);
+               if (!$r) {
+                       logger::notice('profile image upload with scale 4 (300) failed');
+               }
+
+               if ($width > 80 || $height > 80) {
+                       $Image->scaleDown(80);
+               }
+
+               $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 5, self::USER_AVATAR);
+               if (!$r) {
+                       logger::notice('profile image upload with scale 5 (80) failed');
+               }
+
+               if ($width > 48 || $height > 48) {
+                       $Image->scaleDown(48);
+               }
+
+               $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 6, self::USER_AVATAR);
+               if (!$r) {
+                       logger::notice('profile image upload with scale 6 (48) failed');
+               }
+
+               logger::info('new profile image upload ended');
+
+               $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $resource_id, $uid];
+               self::update(['profile' => false, 'photo-type' => self::DEFAULT], $condition);
+
+               Contact::updateSelfFromUserID($uid, true);
+
+               // Update global directory in background
+               Profile::publishUpdate($uid);
+
+               return $resource_id;
+       }
+
+       /**
+        * Upload a user banner
+        *
+        * @param int    $uid   User ID
+        * @param array  $files uploaded file array
+        * @param string $url   External image url
+        * @return string avatar resource
+        */
+       public static function uploadBanner(int $uid, array $files = [], string $url = ''): string
+       {
+               if (!empty($files)) {
+                       $data = self::uploadImage($files);
+                       if (empty($data)) {
+                               Logger::info('upload failed');
+                               return '';
+                       }
+               } elseif (!empty($url)) {
+                       $data = self::loadImageFromURL($url);
+                       if (empty($data)) {
+                               Logger::info('loading from external url failed');
+                               return '';
+                       }
+               } else {
+                       Logger::info('Neither files nor url provided');
+                       return '';
+               }
+
+               $Image    = $data['image'];
+               $filename = $data['filename'];
+               $width    = $Image->getWidth();
+               $height   = $Image->getHeight();
+
+               $resource_id = self::newResource();
+               $album       = DI::l10n()->t(self::BANNER_PHOTOS);
+
+               if ($width > 960) {
+                       $Image->scaleDown(960);
+               }
+
+               $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 3, self::USER_BANNER);
+               if (!$r) {
+                       logger::notice('profile banner upload with scale 3 (960) failed');
+               }
+
+               logger::info('new profile banner upload ended');
+
+               $condition = ["`photo-type` = ? AND `resource-id` != ? AND `uid` = ?", self::USER_BANNER, $resource_id, $uid];
+               self::update(['photo-type' => self::DEFAULT], $condition);
+
+               Contact::updateSelfFromUserID($uid, true);
+
+               // Update global directory in background
+               Profile::publishUpdate($uid);
+
+               return $resource_id;
+       }
 }