src/Model/Photo.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Model;
  23
  24 use Friendica\Core\Cache\Enum\Duration;
  25 use Friendica\Core\Logger;
  26 use Friendica\Core\System;
  27 use Friendica\Database\DBA;
  28 use Friendica\Database\DBStructure;
  29 use Friendica\DI;
  30 use Friendica\Core\Storage\Type\ExternalResource;
  31 use Friendica\Core\Storage\Exception\InvalidClassStorageException;
  32 use Friendica\Core\Storage\Exception\ReferenceStorageException;
  33 use Friendica\Core\Storage\Exception\StorageException;
  34 use Friendica\Core\Storage\Type\SystemResource;
  35 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
  36 use Friendica\Object\Image;
  37 use Friendica\Util\DateTimeFormat;
  38 use Friendica\Util\Images;
  39 use Friendica\Security\Security;
  40 use Friendica\Util\Proxy;
  41 use Friendica\Util\Strings;
  42
  43 /**
  44  * Class to handle photo dabatase table
  45  */
  46 class Photo
  47 {
  48         const CONTACT_PHOTOS = 'Contact Photos';
  49         const PROFILE_PHOTOS = 'Profile Photos';
  50         const BANNER_PHOTOS  = 'Banner Photos';
  51
  52         const DEFAULT        = 0;
  53         const USER_AVATAR    = 10;
  54         const USER_BANNER    = 11;
  55         const CONTACT_AVATAR = 20;
  56         const CONTACT_BANNER = 21;
  57
  58         /**
  59          * Select rows from the photo table and returns them as array
  60          *
  61          * @param array $fields     Array of selected fields, empty for all
  62          * @param array $conditions Array of fields for conditions
  63          * @param array $params     Array of several parameters
  64          *
  65          * @return boolean|array
  66          *
  67          * @throws \Exception
  68          * @see   \Friendica\Database\DBA::selectToArray
  69          */
  70         public static function selectToArray(array $fields = [], array $conditions = [], array $params = [])
  71         {
  72                 if (empty($fields)) {
  73                         $fields = self::getFields();
  74                 }
  75
  76                 return DBA::selectToArray('photo', $fields, $conditions, $params);
  77         }
  78
  79         /**
  80          * Retrieve a single record from the photo table
  81          *
  82          * @param array $fields     Array of selected fields, empty for all
  83          * @param array $conditions Array of fields for conditions
  84          * @param array $params     Array of several parameters
  85          *
  86          * @return bool|array
  87          *
  88          * @throws \Exception
  89          * @see   \Friendica\Database\DBA::select
  90          */
  91         public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
  92         {
  93                 if (empty($fields)) {
  94                         $fields = self::getFields();
  95                 }
  96
  97                 return DBA::selectFirst("photo", $fields, $conditions, $params);
  98         }
  99
 100         /**
 101          * Get photos for user id
 102          *
 103          * @param integer $uid        User id
 104          * @param string  $resourceid Rescource ID of the photo
 105          * @param array   $conditions Array of fields for conditions
 106          * @param array   $params     Array of several parameters
 107          *
 108          * @return bool|array
 109          *
 110          * @throws \Exception
 111          * @see   \Friendica\Database\DBA::select
 112          */
 113         public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
 114         {
 115                 $conditions["resource-id"] = $resourceid;
 116                 $conditions["uid"] = $uid;
 117
 118                 return self::selectToArray([], $conditions, $params);
 119         }
 120
 121         /**
 122          * Get a photo for user id
 123          *
 124          * @param integer $uid        User id
 125          * @param string  $resourceid Rescource ID of the photo
 126          * @param integer $scale      Scale of the photo. Defaults to 0
 127          * @param array   $conditions Array of fields for conditions
 128          * @param array   $params     Array of several parameters
 129          *
 130          * @return bool|array
 131          *
 132          * @throws \Exception
 133          * @see   \Friendica\Database\DBA::select
 134          */
 135         public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
 136         {
 137                 $conditions["resource-id"] = $resourceid;
 138                 $conditions["uid"] = $uid;
 139                 $conditions["scale"] = $scale;
 140
 141                 return self::selectFirst([], $conditions, $params);
 142         }
 143
 144         /**
 145          * Get a single photo given resource id and scale
 146          *
 147          * This method checks for permissions. Returns associative array
 148          * on success, "no sign" image info, if user has no permission,
 149          * false if photo does not exists
 150          *
 151          * @param string  $resourceid Rescource ID of the photo
 152          * @param integer $scale      Scale of the photo. Defaults to 0
 153          *
 154          * @return boolean|array
 155          * @throws \Exception
 156          */
 157         public static function getPhoto(string $resourceid, int $scale = 0)
 158         {
 159                 $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
 160                 if (!DBA::isResult($r)) {
 161                         return false;
 162                 }
 163
 164                 $uid = $r["uid"];
 165
 166                 $accessible = $uid ? (bool)DI::pConfig()->get($uid, 'system', 'accessible-photos', false) : false;
 167
 168                 $sql_acl = Security::getPermissionsSQLByUserId($uid, $accessible);
 169
 170                 $conditions = ["`resource-id` = ? AND `scale` <= ? " . $sql_acl, $resourceid, $scale];
 171                 $params = ["order" => ["scale" => true]];
 172                 $photo = self::selectFirst([], $conditions, $params);
 173
 174                 return $photo;
 175         }
 176
 177         /**
 178          * Check if photo with given conditions exists
 179          *
 180          * @param array $conditions Array of extra conditions
 181          *
 182          * @return boolean
 183          * @throws \Exception
 184          */
 185         public static function exists(array $conditions)
 186         {
 187                 return DBA::exists("photo", $conditions);
 188         }
 189
 190
 191         /**
 192          * Get Image data for given row id. null if row id does not exist
 193          *
 194          * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
 195          *
 196          * @return \Friendica\Object\Image
 197          */
 198         public static function getImageDataForPhoto(array $photo)
 199         {
 200                 if (!empty($photo['data'])) {
 201                         return $photo['data'];
 202                 }
 203
 204                 try {
 205                         $backendClass = DI::storageManager()->getByName($photo['backend-class'] ?? '');
 206                         /// @todo refactoring this returning, because the storage returns a "string" which is casted in different ways - a check "instanceof Image" will fail!
 207                         return $backendClass->get($photo['backend-ref'] ?? '');
 208                 } catch (InvalidClassStorageException $storageException) {
 209                         try {
 210                                 // legacy data storage in "data" column
 211                                 $i = self::selectFirst(['data'], ['id' => $photo['id']]);
 212                                 if ($i !== false) {
 213                                         return $i['data'];
 214                                 } else {
 215                                         DI::logger()->info('Stored legacy data is empty', ['photo' => $photo]);
 216                                 }
 217                         } catch (\Exception $exception) {
 218                                 DI::logger()->info('Unexpected database exception', ['photo' => $photo, 'exception' => $exception]);
 219                         }
 220                 } catch (ReferenceStorageException $referenceStorageException) {
 221                         DI::logger()->debug('Invalid reference for photo', ['photo' => $photo, 'exception' => $referenceStorageException]);
 222                 } catch (StorageException $storageException) {
 223                         DI::logger()->info('Unexpected storage exception', ['photo' => $photo, 'exception' => $storageException]);
 224                 } catch (\ImagickException $imagickException) {
 225                         DI::logger()->info('Unexpected imagick exception', ['photo' => $photo, 'exception' => $imagickException]);
 226                 }
 227
 228                 return null;
 229         }
 230
 231         /**
 232          * Get Image object for given row id. null if row id does not exist
 233          *
 234          * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
 235          *
 236          * @return \Friendica\Object\Image
 237          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 238          * @throws \ImagickException
 239          */
 240         public static function getImageForPhoto(array $photo): Image
 241         {
 242                 return new Image(self::getImageDataForPhoto($photo), $photo['type']);
 243         }
 244
 245         /**
 246          * Return a list of fields that are associated with the photo table
 247          *
 248          * @return array field list
 249          * @throws \Exception
 250          */
 251         private static function getFields()
 252         {
 253                 $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
 254                 $fields = array_keys($allfields["photo"]["fields"]);
 255                 array_splice($fields, array_search("data", $fields), 1);
 256                 return $fields;
 257         }
 258
 259         /**
 260          * Construct a photo array for a system resource image
 261          *
 262          * @param string $filename Image file name relative to code root
 263          * @param string $mimetype Image mime type. Is guessed by file name when empty.
 264          *
 265          * @return array
 266          * @throws \Exception
 267          */
 268         public static function createPhotoForSystemResource($filename, $mimetype = '')
 269         {
 270                 if (empty($mimetype)) {
 271                         $mimetype = Images::guessTypeByExtension($filename);
 272                 }
 273
 274                 $fields = self::getFields();
 275                 $values = array_fill(0, count($fields), "");
 276
 277                 $photo                  = array_combine($fields, $values);
 278                 $photo['backend-class'] = SystemResource::NAME;
 279                 $photo['backend-ref']   = $filename;
 280                 $photo['type']          = $mimetype;
 281                 $photo['cacheable']     = false;
 282
 283                 return $photo;
 284         }
 285
 286         /**
 287          * Construct a photo array for an external resource image
 288          *
 289          * @param string $url      Image URL
 290          * @param int    $uid      User ID of the requesting person
 291          * @param string $mimetype Image mime type. Is guessed by file name when empty.
 292          *
 293          * @return array
 294          * @throws \Exception
 295          */
 296         public static function createPhotoForExternalResource($url, $uid = 0, $mimetype = '')
 297         {
 298                 if (empty($mimetype)) {
 299                         $mimetype = Images::guessTypeByExtension($url);
 300                 }
 301
 302                 $fields = self::getFields();
 303                 $values = array_fill(0, count($fields), "");
 304
 305                 $photo                  = array_combine($fields, $values);
 306                 $photo['backend-class'] = ExternalResource::NAME;
 307                 $photo['backend-ref']   = json_encode(['url' => $url, 'uid' => $uid]);
 308                 $photo['type']          = $mimetype;
 309                 $photo['cacheable']     = true;
 310
 311                 return $photo;
 312         }
 313
 314         /**
 315          * store photo metadata in db and binary in default backend
 316          *
 317          * @param Image   $Image     Image object with data
 318          * @param integer $uid       User ID
 319          * @param integer $cid       Contact ID
 320          * @param integer $rid       Resource ID
 321          * @param string  $filename  Filename
 322          * @param string  $album     Album name
 323          * @param integer $scale     Scale
 324          * @param integer $profile   Is a profile image? optional, default = 0
 325          * @param string  $allow_cid Permissions, allowed contacts. optional, default = ""
 326          * @param string  $allow_gid Permissions, allowed groups. optional, default = ""
 327          * @param string  $deny_cid  Permissions, denied contacts.optional, default = ""
 328          * @param string  $deny_gid  Permissions, denied greoup.optional, default = ""
 329          * @param string  $desc      Photo caption. optional, default = ""
 330          *
 331          * @return boolean True on success
 332          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 333          */
 334         public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $type = self::DEFAULT, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
 335         {
 336                 $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
 337                 if (DBA::isResult($photo)) {
 338                         $guid = $photo["guid"];
 339                 } else {
 340                         $guid = System::createGUID();
 341                 }
 342
 343                 $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
 344                 $created = DateTimeFormat::utcNow();
 345                 if (DBA::isResult($existing_photo)) {
 346                         $created = $existing_photo["created"];
 347                 }
 348
 349                 // Get defined storage backend.
 350                 // if no storage backend, we use old "data" column in photo table.
 351                 // if is an existing photo, reuse same backend
 352                 $data        = "";
 353                 $backend_ref = "";
 354                 $storage     = "";
 355
 356                 try {
 357                         if (DBA::isResult($existing_photo)) {
 358                                 $backend_ref = (string)$existing_photo["backend-ref"];
 359                                 $storage     = DI::storageManager()->getWritableStorageByName($existing_photo["backend-class"] ?? '');
 360                         } else {
 361                                 $storage = DI::storage();
 362                         }
 363                         $backend_ref = $storage->put($Image->asString(), $backend_ref);
 364                 } catch (InvalidClassStorageException $storageException) {
 365                         $data = $Image->asString();
 366                 }
 367
 368                 $fields = [
 369                         "uid" => $uid,
 370                         "contact-id" => $cid,
 371                         "guid" => $guid,
 372                         "resource-id" => $rid,
 373                         "hash" => md5($Image->asString()),
 374                         "created" => $created,
 375                         "edited" => DateTimeFormat::utcNow(),
 376                         "filename" => basename($filename),
 377                         "type" => $Image->getType(),
 378                         "album" => $album,
 379                         "height" => $Image->getHeight(),
 380                         "width" => $Image->getWidth(),
 381                         "datasize" => strlen($Image->asString()),
 382                         "data" => $data,
 383                         "scale" => $scale,
 384                         "photo-type" => $type,
 385                         "profile" => false,
 386                         "allow_cid" => $allow_cid,
 387                         "allow_gid" => $allow_gid,
 388                         "deny_cid" => $deny_cid,
 389                         "deny_gid" => $deny_gid,
 390                         "desc" => $desc,
 391                         "backend-class" => (string)$storage,
 392                         "backend-ref" => $backend_ref
 393                 ];
 394
 395                 if (DBA::isResult($existing_photo)) {
 396                         $r = DBA::update("photo", $fields, ["id" => $existing_photo["id"]]);
 397                 } else {
 398                         $r = DBA::insert("photo", $fields);
 399                 }
 400
 401                 return $r;
 402         }
 403
 404
 405         /**
 406          * Delete info from table and data from storage
 407          *
 408          * @param array $conditions Field condition(s)
 409          * @param array $options    Options array, Optional
 410          *
 411          * @return boolean
 412          *
 413          * @throws \Exception
 414          * @see   \Friendica\Database\DBA::delete
 415          */
 416         public static function delete(array $conditions, array $options = [])
 417         {
 418                 // get photo to delete data info
 419                 $photos = DBA::select('photo', ['id', 'backend-class', 'backend-ref'], $conditions);
 420
 421                 while ($photo = DBA::fetch($photos)) {
 422                         try {
 423                                 $backend_class = DI::storageManager()->getWritableStorageByName($photo['backend-class'] ?? '');
 424                                 $backend_class->delete($photo['backend-ref'] ?? '');
 425                                 // Delete the photos after they had been deleted successfully
 426                                 DBA::delete("photo", ['id' => $photo['id']]);
 427                         } catch (InvalidClassStorageException $storageException) {
 428                                 DI::logger()->debug('Storage class not found.', ['conditions' => $conditions, 'exception' => $storageException]);
 429                         } catch (ReferenceStorageException $referenceStorageException) {
 430                                 DI::logger()->debug('Photo doesn\'t exist.', ['conditions' => $conditions, 'exception' => $referenceStorageException]);
 431                         }
 432                 }
 433
 434                 DBA::close($photos);
 435
 436                 return DBA::delete("photo", $conditions, $options);
 437         }
 438
 439         /**
 440          * Update a photo
 441          *
 442          * @param array         $fields     Contains the fields that are updated
 443          * @param array         $conditions Condition array with the key values
 444          * @param Image         $img        Image to update. Optional, default null.
 445          * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
 446          *
 447          * @return boolean  Was the update successfull?
 448          *
 449          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 450          * @see   \Friendica\Database\DBA::update
 451          */
 452         public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
 453         {
 454                 if (!is_null($img)) {
 455                         // get photo to update
 456                         $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
 457
 458                         foreach($photos as $photo) {
 459                                 try {
 460                                         $backend_class         = DI::storageManager()->getWritableStorageByName($photo['backend-class'] ?? '');
 461                                         $fields["backend-ref"] = $backend_class->put($img->asString(), $photo['backend-ref']);
 462                                 } catch (InvalidClassStorageException $storageException) {
 463                                         $fields["data"] = $img->asString();
 464                                 }
 465                         }
 466                         $fields['updated'] = DateTimeFormat::utcNow();
 467                 }
 468
 469                 $fields['edited'] = DateTimeFormat::utcNow();
 470
 471                 return DBA::update("photo", $fields, $conditions, $old_fields);
 472         }
 473
 474         /**
 475          * @param string  $image_url     Remote URL
 476          * @param integer $uid           user id
 477          * @param integer $cid           contact id
 478          * @param boolean $quit_on_error optional, default false
 479          * @return array
 480          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 481          * @throws \ImagickException
 482          */
 483         public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
 484         {
 485                 $thumb = "";
 486                 $micro = "";
 487
 488                 $photo = DBA::selectFirst(
 489                         "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "photo-type" => self::CONTACT_AVATAR]
 490                 );
 491                 if (!empty($photo['resource-id'])) {
 492                         $resource_id = $photo["resource-id"];
 493                 } else {
 494                         $resource_id = self::newResource();
 495                 }
 496
 497                 $photo_failure = false;
 498
 499                 $filename = basename($image_url);
 500                 if (!empty($image_url)) {
 501                         $ret = DI::httpClient()->get($image_url, HttpClientAccept::IMAGE);
 502                         Logger::debug('Got picture', ['Content-Type' => $ret->getHeader('Content-Type'), 'url' => $image_url]);
 503                         $img_str = $ret->getBody();
 504                         $type = $ret->getContentType();
 505                 } else {
 506                         $img_str = '';
 507                         $type = '';
 508                 }
 509
 510                 if ($quit_on_error && ($img_str == "")) {
 511                         return false;
 512                 }
 513
 514                 $type = Images::getMimeTypeByData($img_str, $image_url, $type);
 515
 516                 $Image = new Image($img_str, $type);
 517                 if ($Image->isValid()) {
 518                         $Image->scaleToSquare(300);
 519
 520                         $filesize = strlen($Image->asString());
 521                         $maximagesize = DI::config()->get('system', 'maximagesize');
 522                         if (!empty($maximagesize) && ($filesize > $maximagesize)) {
 523                                 Logger::info('Avatar exceeds image limit', ['uid' => $uid, 'cid' => $cid, 'maximagesize' => $maximagesize, 'size' => $filesize, 'type' => $Image->getType()]);
 524                                 if ($Image->getType() == 'image/gif') {
 525                                         $Image->toStatic();
 526                                         $Image = new Image($Image->asString(), 'image/png');
 527
 528                                         $filesize = strlen($Image->asString());
 529                                         Logger::info('Converted gif to a static png', ['uid' => $uid, 'cid' => $cid, 'size' => $filesize, 'type' => $Image->getType()]);
 530                                 }
 531                                 if ($filesize > $maximagesize) {
 532                                         foreach ([160, 80] as $pixels) {
 533                                                 if ($filesize > $maximagesize) {
 534                                                         Logger::info('Resize', ['uid' => $uid, 'cid' => $cid, 'size' => $filesize, 'max' => $maximagesize, 'pixels' => $pixels, 'type' => $Image->getType()]);
 535                                                         $Image->scaleDown($pixels);
 536                                                         $filesize = strlen($Image->asString());
 537                                                 }
 538                                         }
 539                                 }
 540                                 Logger::info('Avatar is resized', ['uid' => $uid, 'cid' => $cid, 'size' => $filesize, 'type' => $Image->getType()]);
 541                         }
 542
 543                         $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 4, self::CONTACT_AVATAR);
 544
 545                         if ($r === false) {
 546                                 $photo_failure = true;
 547                         }
 548
 549                         $Image->scaleDown(80);
 550
 551                         $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 5, self::CONTACT_AVATAR);
 552
 553                         if ($r === false) {
 554                                 $photo_failure = true;
 555                         }
 556
 557                         $Image->scaleDown(48);
 558
 559                         $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 6, self::CONTACT_AVATAR);
 560
 561                         if ($r === false) {
 562                                 $photo_failure = true;
 563                         }
 564
 565                         $suffix = "?ts=" . time();
 566
 567                         $image_url = DI::baseUrl() . "/photo/" . $resource_id . "-4." . $Image->getExt() . $suffix;
 568                         $thumb = DI::baseUrl() . "/photo/" . $resource_id . "-5." . $Image->getExt() . $suffix;
 569                         $micro = DI::baseUrl() . "/photo/" . $resource_id . "-6." . $Image->getExt() . $suffix;
 570                 } else {
 571                         $photo_failure = true;
 572                 }
 573
 574                 if ($photo_failure && $quit_on_error) {
 575                         return false;
 576                 }
 577
 578                 if ($photo_failure) {
 579                         $contact = Contact::getById($cid) ?: [];
 580                         $image_url = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
 581                         $thumb = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
 582                         $micro = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
 583                 }
 584
 585                 return [$image_url, $thumb, $micro];
 586         }
 587
 588         /**
 589          * @param array $exifCoord coordinate
 590          * @param string $hemi      hemi
 591          * @return float
 592          */
 593         public static function getGps($exifCoord, $hemi)
 594         {
 595                 $degrees = count($exifCoord) > 0 ? self::gps2Num($exifCoord[0]) : 0;
 596                 $minutes = count($exifCoord) > 1 ? self::gps2Num($exifCoord[1]) : 0;
 597                 $seconds = count($exifCoord) > 2 ? self::gps2Num($exifCoord[2]) : 0;
 598
 599                 $flip = ($hemi == "W" || $hemi == "S") ? -1 : 1;
 600
 601                 return floatval($flip * ($degrees + ($minutes / 60) + ($seconds / 3600)));
 602         }
 603
 604         /**
 605          * @param string $coordPart coordPart
 606          * @return float
 607          */
 608         private static function gps2Num($coordPart)
 609         {
 610                 $parts = explode("/", $coordPart);
 611
 612                 if (count($parts) <= 0) {
 613                         return 0;
 614                 }
 615
 616                 if (count($parts) == 1) {
 617                         return $parts[0];
 618                 }
 619
 620                 return floatval($parts[0]) / floatval($parts[1]);
 621         }
 622
 623         /**
 624          * Fetch the photo albums that are available for a viewer
 625          *
 626          * The query in this function is cost intensive, so it is cached.
 627          *
 628          * @param int  $uid    User id of the photos
 629          * @param bool $update Update the cache
 630          *
 631          * @return array Returns array of the photo albums
 632          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 633          */
 634         public static function getAlbums($uid, $update = false)
 635         {
 636                 $sql_extra = Security::getPermissionsSQLByUserId($uid);
 637
 638                 $avatar_type = (local_user() && (local_user() == $uid)) ? self::USER_AVATAR : self::DEFAULT;
 639                 $banner_type = (local_user() && (local_user() == $uid)) ? self::USER_BANNER : self::DEFAULT;
 640
 641                 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
 642                 $albums = DI::cache()->get($key);
 643                 if (is_null($albums) || $update) {
 644                         if (!DI::config()->get("system", "no_count", false)) {
 645                                 /// @todo This query needs to be renewed. It is really slow
 646                                 // At this time we just store the data in the cache
 647                                 $albums = DBA::toArray(DBA::p("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
 648                                         FROM `photo`
 649                                         WHERE `uid` = ? AND `photo-type` IN (?, ?, ?) $sql_extra
 650                                         GROUP BY `album` ORDER BY `created` DESC",
 651                                         $uid,
 652                                         self::DEFAULT,
 653                                         $banner_type,
 654                                         $avatar_type
 655                                 ));
 656                         } else {
 657                                 // This query doesn't do the count and is much faster
 658                                 $albums = DBA::toArray(DBA::p("SELECT DISTINCT(`album`), '' AS `total`
 659                                         FROM `photo` USE INDEX (`uid_album_scale_created`)
 660                                         WHERE `uid` = ? AND `photo-type` IN (?, ?, ?) $sql_extra",
 661                                         $uid,
 662                                         self::DEFAULT,
 663                                         $banner_type,
 664                                         $avatar_type
 665                                 ));
 666                         }
 667                         DI::cache()->set($key, $albums, Duration::DAY);
 668                 }
 669                 return $albums;
 670         }
 671
 672         /**
 673          * @param int $uid User id of the photos
 674          * @return void
 675          * @throws \Exception
 676          */
 677         public static function clearAlbumCache($uid)
 678         {
 679                 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
 680                 DI::cache()->set($key, null, Duration::DAY);
 681         }
 682
 683         /**
 684          * Generate a unique photo ID.
 685          *
 686          * @return string
 687          * @throws \Exception
 688          */
 689         public static function newResource()
 690         {
 691                 return System::createGUID(32, false);
 692         }
 693
 694         /**
 695          * Extracts the rid from a local photo URI
 696          *
 697          * @param string $image_uri The URI of the photo
 698          * @return string The rid of the photo, or an empty string if the URI is not local
 699          */
 700         public static function ridFromURI(string $image_uri)
 701         {
 702                 if (!stristr($image_uri, DI::baseUrl() . '/photo/')) {
 703                         return '';
 704                 }
 705                 $image_uri = substr($image_uri, strrpos($image_uri, '/') + 1);
 706                 $image_uri = substr($image_uri, 0, strpos($image_uri, '-'));
 707                 return trim($image_uri);
 708         }
 709
 710         /**
 711          * Checks if the given URL is a local photo.
 712          * Since it is meant for time critical occasions, the check is done without any database requests.
 713          *
 714          * @param string $url
 715          * @return boolean
 716          */
 717         public static function isPhotoURI(string $url): bool
 718         {
 719                 return !empty(self::ridFromURI($url));
 720         }
 721
 722         /**
 723          * Changes photo permissions that had been embedded in a post
 724          *
 725          * @todo This function currently does have some flaws:
 726          * - Sharing a post with a forum will create a photo that only the forum can see.
 727          * - Sharing a photo again that been shared non public before doesn't alter the permissions.
 728          *
 729          * @return string
 730          * @throws \Exception
 731          */
 732         public static function setPermissionFromBody($body, $uid, $original_contact_id, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny)
 733         {
 734                 // Simplify image codes
 735                 $img_body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
 736                 $img_body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $img_body);
 737
 738                 // Search for images
 739                 if (!preg_match_all("/\[img\](.*?)\[\/img\]/", $img_body, $match)) {
 740                         return false;
 741                 }
 742                 $images = $match[1];
 743                 if (empty($images)) {
 744                         return false;
 745                 }
 746
 747                 foreach ($images as $image) {
 748                         $image_rid = self::ridFromURI($image);
 749                         if (empty($image_rid)) {
 750                                 continue;
 751                         }
 752
 753                         // Ensure to only modify photos that you own
 754                         $srch = '<' . intval($original_contact_id) . '>';
 755
 756                         $condition = [
 757                                 'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
 758                                 'resource-id' => $image_rid, 'uid' => $uid
 759                         ];
 760                         if (!self::exists($condition)) {
 761                                 $photo = self::selectFirst(['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'uid'], ['resource-id' => $image_rid]);
 762                                 if (!DBA::isResult($photo)) {
 763                                         Logger::info('Image not found', ['resource-id' => $image_rid]);
 764                                 } else {
 765                                         Logger::info('Mismatching permissions', ['condition' => $condition, 'photo' => $photo]);
 766                                 }
 767                                 continue;
 768                         }
 769
 770                         /**
 771                          * @todo Existing permissions need to be mixed with the new ones.
 772                          * Otherwise this creates problems with sharing the same picture multiple times
 773                          * Also check if $str_contact_allow does contain a public forum.
 774                          * Then set the permissions to public.
 775                          */
 776
 777                         self::setPermissionForRessource($image_rid, $uid, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny);
 778                 }
 779
 780                 return true;
 781         }
 782
 783         /**
 784          * Add permissions to photo ressource
 785          * @todo mix with previous photo permissions
 786          *
 787          * @param string $image_rid
 788          * @param integer $uid
 789          * @param string $str_contact_allow
 790          * @param string $str_group_allow
 791          * @param string $str_contact_deny
 792          * @param string $str_group_deny
 793          * @return void
 794          */
 795         public static function setPermissionForRessource(string $image_rid, int $uid, string $str_contact_allow, string $str_group_allow, string $str_contact_deny, string $str_group_deny)
 796         {
 797                 $fields = ['allow_cid' => $str_contact_allow, 'allow_gid' => $str_group_allow,
 798                 'deny_cid' => $str_contact_deny, 'deny_gid' => $str_group_deny,
 799                 'accessible' => DI::pConfig()->get($uid, 'system', 'accessible-photos', false)];
 800
 801                 $condition = ['resource-id' => $image_rid, 'uid' => $uid];
 802                 Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
 803                 self::update($fields, $condition);
 804         }
 805
 806         /**
 807          * Fetch the guid and scale from picture links
 808          *
 809          * @param string $name Picture link
 810          * @return array
 811          */
 812         public static function getResourceData(string $name):array
 813         {
 814                 $base = DI::baseUrl()->get();
 815
 816                 $guid = str_replace([Strings::normaliseLink($base), '/photo/'], '', Strings::normaliseLink($name));
 817
 818                 if (parse_url($guid, PHP_URL_SCHEME)) {
 819                         return [];
 820                 }
 821
 822                 $guid = pathinfo($guid, PATHINFO_FILENAME);
 823                 if (substr($guid, -2, 1) != "-") {
 824                         return [];
 825                 }
 826
 827                 $scale = intval(substr($guid, -1, 1));
 828                 if (!is_numeric($scale)) {
 829                         return [];
 830                 }
 831
 832                 $guid = substr($guid, 0, -2);
 833                 return ['guid' => $guid, 'scale' => $scale];
 834         }
 835
 836         /**
 837          * Tests if the picture link points to a locally stored picture
 838          *
 839          * @param string $name Picture link
 840          * @return boolean
 841          * @throws \Exception
 842          */
 843         public static function isLocal($name)
 844         {
 845                 return (bool)self::getIdForName($name);
 846         }
 847
 848         /**
 849          * Return the id of a local photo
 850          *
 851          * @param string $name Picture link
 852          * @return int
 853          */
 854         public static function getIdForName($name)
 855         {
 856                 $data = self::getResourceData($name);
 857                 if (empty($data)) {
 858                         return 0;
 859                 }
 860
 861                 $photo = DBA::selectFirst('photo', ['id'], ['resource-id' => $data['guid'], 'scale' => $data['scale']]);
 862                 if (!empty($photo['id'])) {
 863                         return $photo['id'];
 864                 }
 865                 return 0;
 866         }
 867
 868         /**
 869          * Tests if the link points to a locally stored picture page
 870          *
 871          * @param string $name Page link
 872          * @return boolean
 873          * @throws \Exception
 874          */
 875         public static function isLocalPage($name)
 876         {
 877                 $base = DI::baseUrl()->get();
 878
 879                 $guid = str_replace(Strings::normaliseLink($base), '', Strings::normaliseLink($name));
 880                 $guid = preg_replace("=/photos/.*/image/(.*)=ism", '$1', $guid);
 881                 if (empty($guid)) {
 882                         return false;
 883                 }
 884
 885                 return DBA::exists('photo', ['resource-id' => $guid]);
 886         }
 887
 888         private static function fitImageSize($Image)
 889         {
 890                 $max_length = DI::config()->get('system', 'max_image_length');
 891                 if ($max_length > 0) {
 892                         $Image->scaleDown($max_length);
 893                         Logger::info('File upload: Scaling picture to new size', ['max-length' => $max_length]);
 894                 }
 895
 896                 $filesize = strlen($Image->asString());
 897                 $width    = $Image->getWidth();
 898                 $height   = $Image->getHeight();
 899
 900                 $maximagesize = DI::config()->get('system', 'maximagesize');
 901
 902                 if (!empty($maximagesize) && ($filesize > $maximagesize)) {
 903                         // Scale down to multiples of 640 until the maximum size isn't exceeded anymore
 904                         foreach ([5120, 2560, 1280, 640] as $pixels) {
 905                                 if (($filesize > $maximagesize) && (max($width, $height) > $pixels)) {
 906                                         Logger::info('Resize', ['size' => $filesize, 'width' => $width, 'height' => $height, 'max' => $maximagesize, 'pixels' => $pixels]);
 907                                         $Image->scaleDown($pixels);
 908                                         $filesize = strlen($Image->asString());
 909                                         $width = $Image->getWidth();
 910                                         $height = $Image->getHeight();
 911                                 }
 912                         }
 913                         if ($filesize > $maximagesize) {
 914                                 Logger::notice('Image size is too big', ['size' => $filesize, 'max' => $maximagesize]);
 915                                 return null;
 916                         }
 917                 }
 918
 919                 return $Image;
 920         }
 921
 922         private static function loadImageFromURL(string $image_url)
 923         {
 924                 $filename = basename($image_url);
 925                 if (!empty($image_url)) {
 926                         $ret = DI::httpClient()->get($image_url, HttpClientAccept::IMAGE);
 927                         Logger::debug('Got picture', ['Content-Type' => $ret->getHeader('Content-Type'), 'url' => $image_url]);
 928                         $img_str = $ret->getBody();
 929                         $type = $ret->getContentType();
 930                 } else {
 931                         $img_str = '';
 932                         $type = '';
 933                 }
 934
 935                 if (empty($img_str)) {
 936                         Logger::notice('Empty content');
 937                         return [];
 938                 }
 939
 940                 $type = Images::getMimeTypeByData($img_str, $image_url, $type);
 941
 942                 $Image = new Image($img_str, $type);
 943
 944                 $Image = self::fitImageSize($Image);
 945                 if (empty($Image)) {
 946                         return [];
 947                 }
 948
 949                 return ['image' => $Image, 'filename' => $filename];
 950         }
 951
 952         private static function uploadImage(array $files)
 953         {
 954                 Logger::info('starting new upload');
 955
 956                 if (empty($files)) {
 957                         Logger::notice('Empty upload file');
 958                         return [];
 959                 }
 960
 961                 if (!empty($files['tmp_name'])) {
 962                         if (is_array($files['tmp_name'])) {
 963                                 $src = $files['tmp_name'][0];
 964                         } else {
 965                                 $src = $files['tmp_name'];
 966                         }
 967                 } else {
 968                         $src = '';
 969                 }
 970
 971                 if (!empty($files['name'])) {
 972                         if (is_array($files['name'])) {
 973                                 $filename = basename($files['name'][0]);
 974                         } else {
 975                                 $filename = basename($files['name']);
 976                         }
 977                 } else {
 978                         $filename = '';
 979                 }
 980
 981                 if (!empty($files['size'])) {
 982                         if (is_array($files['size'])) {
 983                                 $filesize = intval($files['size'][0]);
 984                         } else {
 985                                 $filesize = intval($files['size']);
 986                         }
 987                 } else {
 988                         $filesize = 0;
 989                 }
 990
 991                 if (!empty($files['type'])) {
 992                         if (is_array($files['type'])) {
 993                                 $filetype = $files['type'][0];
 994                         } else {
 995                                 $filetype = $files['type'];
 996                         }
 997                 } else {
 998                         $filetype = '';
 999                 }
1000
1001                 if (empty($src)) {
1002                         Logger::notice('No source file name', ['files' => $files]);
1003                         return [];
1004                 }
1005
1006                 $filetype = Images::getMimeTypeBySource($src, $filename, $filetype);
1007
1008                 Logger::info('File upload', ['src' => $src, 'filename' => $filename, 'size' => $filesize, 'type' => $filetype]);
1009
1010                 $imagedata = @file_get_contents($src);
1011                 $Image = new Image($imagedata, $filetype);
1012                 if (!$Image->isValid()) {
1013                         Logger::notice('Image is unvalid', ['files' => $files]);
1014                         return [];
1015                 }
1016
1017                 $Image->orient($src);
1018                 @unlink($src);
1019
1020                 $Image = self::fitImageSize($Image);
1021                 if (empty($Image)) {
1022                         return [];
1023                 }
1024
1025                 return ['image' => $Image, 'filename' => $filename];
1026         }
1027
1028         /**
1029          * @param int         $uid   User ID
1030          * @param array       $files uploaded file array
1031          * @param string      $album
1032          * @param string|null $allow_cid
1033          * @param string|null $allow_gid
1034          * @param string      $deny_cid
1035          * @param string      $deny_gid
1036          * @param string      $desc
1037          * @param string      $resource_id
1038          * @return array photo record
1039          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1040          */
1041         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
1042         {
1043                 $user = User::getOwnerDataById($uid);
1044                 if (empty($user)) {
1045                         Logger::notice('User not found', ['uid' => $uid]);
1046                         return [];
1047                 }
1048
1049                 $data = self::uploadImage($files);
1050                 if (empty($data)) {
1051                         Logger::info('upload failed');
1052                         return [];
1053                 }
1054
1055                 $Image    = $data['image'];
1056                 $filename = $data['filename'];
1057                 $width    = $Image->getWidth();
1058                 $height   = $Image->getHeight();
1059
1060                 $resource_id = $resource_id ?: self::newResource();
1061                 $album       = $album ?: DI::l10n()->t('Wall Photos');
1062
1063                 if (is_null($allow_cid) && is_null($allow_gid)) {
1064                         $allow_cid = '<' . $user['id'] . '>';
1065                         $allow_gid = '';
1066                 }
1067
1068                 $smallest = 0;
1069
1070                 $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
1071                 if (!$r) {
1072                         Logger::notice('Photo could not be stored');
1073                         return [];
1074                 }
1075
1076                 if ($width > 640 || $height > 640) {
1077                         $Image->scaleDown(640);
1078                         $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
1079                         if ($r) {
1080                                 $smallest = 1;
1081                         }
1082                 }
1083
1084                 if ($width > 320 || $height > 320) {
1085                         $Image->scaleDown(320);
1086                         $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
1087                         if ($r && ($smallest == 0)) {
1088                                 $smallest = 2;
1089                         }
1090                 }
1091
1092                 $condition = ['resource-id' => $resource_id];
1093                 $photo = self::selectFirst(['id', 'datasize', 'width', 'height', 'type'], $condition, ['order' => ['width' => true]]);
1094                 if (empty($photo)) {
1095                         Logger::notice('Photo not found', ['condition' => $condition]);
1096                         return [];
1097                 }
1098
1099                 $picture = [];
1100
1101                 $picture['id']          = $photo['id'];
1102                 $picture['resource_id'] = $resource_id;
1103                 $picture['size']        = $photo['datasize'];
1104                 $picture['width']       = $photo['width'];
1105                 $picture['height']      = $photo['height'];
1106                 $picture['type']        = $photo['type'];
1107                 $picture['albumpage']   = DI::baseUrl() . '/photos/' . $user['nickname'] . '/image/' . $resource_id;
1108                 $picture['picture']     = DI::baseUrl() . '/photo/{$resource_id}-0.' . $Image->getExt();
1109                 $picture['preview']     = DI::baseUrl() . '/photo/{$resource_id}-{$smallest}.' . $Image->getExt();
1110
1111                 Logger::info('upload done', ['picture' => $picture]);
1112                 return $picture;
1113         }
1114
1115         /**
1116          * Upload a user avatar
1117          *
1118          * @param int    $uid   User ID
1119          * @param array  $files uploaded file array
1120          * @param string $url   External image url
1121          * @return string avatar resource
1122          */
1123         public static function uploadAvatar(int $uid, array $files, string $url = ''): string
1124         {
1125                 if (!empty($files)) {
1126                         $data = self::uploadImage($files);
1127                         if (empty($data)) {
1128                                 Logger::info('upload failed');
1129                                 return '';
1130                         }
1131                 } elseif (!empty($url)) {
1132                         $data = self::loadImageFromURL($url);
1133                         if (empty($data)) {
1134                                 Logger::info('loading from external url failed');
1135                                 return '';
1136                         }
1137                 } else {
1138                         Logger::info('Neither files nor url provided');
1139                         return '';
1140                 }
1141
1142                 $Image    = $data['image'];
1143                 $filename = $data['filename'];
1144                 $width    = $Image->getWidth();
1145                 $height   = $Image->getHeight();
1146
1147                 $resource_id = self::newResource();
1148                 $album       = DI::l10n()->t(self::PROFILE_PHOTOS);
1149
1150                 // upload profile image (scales 4, 5, 6)
1151                 logger::info('starting new profile image upload');
1152
1153                 if ($width > 300 || $height > 300) {
1154                         $Image->scaleDown(300);
1155                 }
1156
1157                 $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 4, self::USER_AVATAR);
1158                 if (!$r) {
1159                         logger::notice('profile image upload with scale 4 (300) failed');
1160                 }
1161
1162                 if ($width > 80 || $height > 80) {
1163                         $Image->scaleDown(80);
1164                 }
1165
1166                 $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 5, self::USER_AVATAR);
1167                 if (!$r) {
1168                         logger::notice('profile image upload with scale 5 (80) failed');
1169                 }
1170
1171                 if ($width > 48 || $height > 48) {
1172                         $Image->scaleDown(48);
1173                 }
1174
1175                 $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 6, self::USER_AVATAR);
1176                 if (!$r) {
1177                         logger::notice('profile image upload with scale 6 (48) failed');
1178                 }
1179
1180                 logger::info('new profile image upload ended');
1181
1182                 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $resource_id, $uid];
1183                 self::update(['profile' => false, 'photo-type' => self::DEFAULT], $condition);
1184
1185                 Contact::updateSelfFromUserID($uid, true);
1186
1187                 // Update global directory in background
1188                 Profile::publishUpdate($uid);
1189
1190                 return $resource_id;
1191         }
1192
1193         /**
1194          * Upload a user banner
1195          *
1196          * @param int    $uid   User ID
1197          * @param array  $files uploaded file array
1198          * @param string $url   External image url
1199          * @return string avatar resource
1200          */
1201         public static function uploadBanner(int $uid, array $files = [], string $url = ''): string
1202         {
1203                 if (!empty($files)) {
1204                         $data = self::uploadImage($files);
1205                         if (empty($data)) {
1206                                 Logger::info('upload failed');
1207                                 return '';
1208                         }
1209                 } elseif (!empty($url)) {
1210                         $data = self::loadImageFromURL($url);
1211                         if (empty($data)) {
1212                                 Logger::info('loading from external url failed');
1213                                 return '';
1214                         }
1215                 } else {
1216                         Logger::info('Neither files nor url provided');
1217                         return '';
1218                 }
1219
1220                 $Image    = $data['image'];
1221                 $filename = $data['filename'];
1222                 $width    = $Image->getWidth();
1223                 $height   = $Image->getHeight();
1224
1225                 $resource_id = self::newResource();
1226                 $album       = DI::l10n()->t(self::BANNER_PHOTOS);
1227
1228                 if ($width > 960) {
1229                         $Image->scaleDown(960);
1230                 }
1231
1232                 $r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 3, self::USER_BANNER);
1233                 if (!$r) {
1234                         logger::notice('profile banner upload with scale 3 (960) failed');
1235                 }
1236
1237                 logger::info('new profile banner upload ended');
1238
1239                 $condition = ["`photo-type` = ? AND `resource-id` != ? AND `uid` = ?", self::USER_BANNER, $resource_id, $uid];
1240                 self::update(['photo-type' => self::DEFAULT], $condition);
1241
1242                 Contact::updateSelfFromUserID($uid, true);
1243
1244                 // Update global directory in background
1245                 Profile::publishUpdate($uid);
1246
1247                 return $resource_id;
1248         }
1249 }