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(int $uid, string $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(int $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): bool
 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|null Image object or null on error
 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(): array
 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(string $filename, string $mimetype = ''): array
 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(string $url, int $uid = 0, string $mimetype = ''): array
 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 string  $rid       Resource ID
 321          * @param string  $filename  Filename
 322          * @param string  $album     Album name
 323          * @param integer $scale     Scale
 324          * @param integer $type      Photo type, optional, default: Photo::DEFAULT
 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, int $uid, int $cid, string $rid, string $filename, string $album, int $scale, int $type = self::DEFAULT, string $allow_cid = '', string $allow_gid = '', string $deny_cid = '', string $deny_gid = '', string $desc = ''): bool
 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 = []): bool
 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 $image      Image to update. Optional, default null.
 445          * @param array $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(array $fields, array $conditions, Image $image = null, array $old_fields = []): bool
 453         {
 454                 if (!is_null($image)) {
 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($image->asString(), $photo['backend-ref']);
 462                                 } catch (InvalidClassStorageException $storageException) {
 463                                         $fields['data'] = $image->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|bool Array on success, false on error
 480          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 481          * @throws \ImagickException
 482          */
 483         public static function importProfilePhoto(string $image_url, int $uid, int $cid, bool $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(array $exifCoord, string $hemi): float
 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          * Change GPS to float number
 606          *
 607          * @param string $coordPart coordPart
 608          * @return float
 609          */
 610         private static function gps2Num(string $coordPart): float
 611         {
 612                 $parts = explode('/', $coordPart);
 613
 614                 if (count($parts) <= 0) {
 615                         return 0;
 616                 }
 617
 618                 if (count($parts) == 1) {
 619                         return (float)$parts[0];
 620                 }
 621
 622                 return floatval($parts[0]) / floatval($parts[1]);
 623         }
 624
 625         /**
 626          * Fetch the photo albums that are available for a viewer
 627          *
 628          * The query in this function is cost intensive, so it is cached.
 629          *
 630          * @param int  $uid    User id of the photos
 631          * @param bool $update Update the cache
 632          *
 633          * @return array Returns array of the photo albums
 634          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 635          */
 636         public static function getAlbums(int $uid, bool $update = false): array
 637         {
 638                 $sql_extra = Security::getPermissionsSQLByUserId($uid);
 639
 640                 $avatar_type = (local_user() && (local_user() == $uid)) ? self::USER_AVATAR : self::DEFAULT;
 641                 $banner_type = (local_user() && (local_user() == $uid)) ? self::USER_BANNER : self::DEFAULT;
 642
 643                 $key = 'photo_albums:' . $uid . ':' . local_user() . ':' . remote_user();
 644                 $albums = DI::cache()->get($key);
 645
 646                 if (is_null($albums) || $update) {
 647                         if (!DI::config()->get('system', 'no_count', false)) {
 648                                 /// @todo This query needs to be renewed. It is really slow
 649                                 // At this time we just store the data in the cache
 650                                 $albums = DBA::toArray(DBA::p("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
 651                                         FROM `photo`
 652                                         WHERE `uid` = ? AND `photo-type` IN (?, ?, ?) $sql_extra
 653                                         GROUP BY `album` ORDER BY `created` DESC",
 654                                         $uid,
 655                                         self::DEFAULT,
 656                                         $banner_type,
 657                                         $avatar_type
 658                                 ));
 659                         } else {
 660                                 // This query doesn't do the count and is much faster
 661                                 $albums = DBA::toArray(DBA::p("SELECT DISTINCT(`album`), '' AS `total`
 662                                         FROM `photo` USE INDEX (`uid_album_scale_created`)
 663                                         WHERE `uid` = ? AND `photo-type` IN (?, ?, ?) $sql_extra",
 664                                         $uid,
 665                                         self::DEFAULT,
 666                                         $banner_type,
 667                                         $avatar_type
 668                                 ));
 669                         }
 670                         DI::cache()->set($key, $albums, Duration::DAY);
 671                 }
 672                 return $albums;
 673         }
 674
 675         /**
 676          * @param int $uid User id of the photos
 677          * @return void
 678          * @throws \Exception
 679          */
 680         public static function clearAlbumCache(int $uid)
 681         {
 682                 $key = 'photo_albums:' . $uid . ':' . local_user() . ':' . remote_user();
 683                 DI::cache()->set($key, null, Duration::DAY);
 684         }
 685
 686         /**
 687          * Generate a unique photo ID.
 688          *
 689          * @return string Resource GUID
 690          * @throws \Exception
 691          */
 692         public static function newResource(): string
 693         {
 694                 return System::createGUID(32, false);
 695         }
 696
 697         /**
 698          * Extracts the rid from a local photo URI
 699          *
 700          * @param string $image_uri The URI of the photo
 701          * @return string The rid of the photo, or an empty string if the URI is not local
 702          */
 703         public static function ridFromURI(string $image_uri): string
 704         {
 705                 if (!stristr($image_uri, DI::baseUrl() . '/photo/')) {
 706                         return '';
 707                 }
 708                 $image_uri = substr($image_uri, strrpos($image_uri, '/') + 1);
 709                 $image_uri = substr($image_uri, 0, strpos($image_uri, '-'));
 710                 return trim($image_uri);
 711         }
 712
 713         /**
 714          * Checks if the given URL is a local photo.
 715          * Since it is meant for time critical occasions, the check is done without any database requests.
 716          *
 717          * @param string $url
 718          * @return boolean
 719          */
 720         public static function isPhotoURI(string $url): bool
 721         {
 722                 return !empty(self::ridFromURI($url));
 723         }
 724
 725         /**
 726          * Changes photo permissions that had been embedded in a post
 727          *
 728          * @todo This function currently does have some flaws:
 729          * - Sharing a post with a forum will create a photo that only the forum can see.
 730          * - Sharing a photo again that been shared non public before doesn't alter the permissions.
 731          *
 732          * @return string
 733          * @throws \Exception
 734          */
 735         public static function setPermissionFromBody($body, $uid, $original_contact_id, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny)
 736         {
 737                 // Simplify image codes
 738                 $img_body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
 739                 $img_body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $img_body);
 740
 741                 // Search for images
 742                 if (!preg_match_all("/\[img\](.*?)\[\/img\]/", $img_body, $match)) {
 743                         return false;
 744                 }
 745                 $images = $match[1];
 746                 if (empty($images)) {
 747                         return false;
 748                 }
 749
 750                 foreach ($images as $image) {
 751                         $image_rid = self::ridFromURI($image);
 752                         if (empty($image_rid)) {
 753                                 continue;
 754                         }
 755
 756                         // Ensure to only modify photos that you own
 757                         $srch = '<' . intval($original_contact_id) . '>';
 758
 759                         $condition = [
 760                                 'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
 761                                 'resource-id' => $image_rid, 'uid' => $uid
 762                         ];
 763                         if (!self::exists($condition)) {
 764                                 $photo = self::selectFirst(['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'uid'], ['resource-id' => $image_rid]);
 765                                 if (!DBA::isResult($photo)) {
 766                                         Logger::info('Image not found', ['resource-id' => $image_rid]);
 767                                 } else {
 768                                         Logger::info('Mismatching permissions', ['condition' => $condition, 'photo' => $photo]);
 769                                 }
 770                                 continue;
 771                         }
 772
 773                         /**
 774                          * @todo Existing permissions need to be mixed with the new ones.
 775                          * Otherwise this creates problems with sharing the same picture multiple times
 776                          * Also check if $str_contact_allow does contain a public forum.
 777                          * Then set the permissions to public.
 778                          */
 779
 780                         self::setPermissionForRessource($image_rid, $uid, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny);
 781                 }
 782
 783                 return true;
 784         }
 785
 786         /**
 787          * Add permissions to photo ressource
 788          * @todo mix with previous photo permissions
 789          *
 790          * @param string $image_rid
 791          * @param integer $uid
 792          * @param string $str_contact_allow
 793          * @param string $str_group_allow
 794          * @param string $str_contact_deny
 795          * @param string $str_group_deny
 796          * @return void
 797          */
 798         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)
 799         {
 800                 $fields = ['allow_cid' => $str_contact_allow, 'allow_gid' => $str_group_allow,
 801                 'deny_cid' => $str_contact_deny, 'deny_gid' => $str_group_deny,
 802                 'accessible' => DI::pConfig()->get($uid, 'system', 'accessible-photos', false)];
 803
 804                 $condition = ['resource-id' => $image_rid, 'uid' => $uid];
 805                 Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
 806                 self::update($fields, $condition);
 807         }
 808
 809         /**
 810          * Fetch the guid and scale from picture links
 811          *
 812          * @param string $name Picture link
 813          * @return array
 814          */
 815         public static function getResourceData(string $name): array
 816         {
 817                 $base = DI::baseUrl()->get();
 818
 819                 $guid = str_replace([Strings::normaliseLink($base), '/photo/'], '', Strings::normaliseLink($name));
 820
 821                 if (parse_url($guid, PHP_URL_SCHEME)) {
 822                         return [];
 823                 }
 824
 825                 $guid = pathinfo($guid, PATHINFO_FILENAME);
 826                 if (substr($guid, -2, 1) != "-") {
 827                         return [];
 828                 }
 829
 830                 $scale = intval(substr($guid, -1, 1));
 831                 if (!is_numeric($scale)) {
 832                         return [];
 833                 }
 834
 835                 $guid = substr($guid, 0, -2);
 836                 return ['guid' => $guid, 'scale' => $scale];
 837         }
 838
 839         /**
 840          * Tests if the picture link points to a locally stored picture
 841          *
 842          * @param string $name Picture link
 843          * @return boolean
 844          * @throws \Exception
 845          */
 846         public static function isLocal(string $name): bool
 847         {
 848                 // @TODO Maybe a proper check here on true condition?
 849                 return (bool)self::getIdForName($name);
 850         }
 851
 852         /**
 853          * Return the id of a local photo
 854          *
 855          * @param string $name Picture link
 856          * @return int
 857          */
 858         public static function getIdForName(string $name): int
 859         {
 860                 $data = self::getResourceData($name);
 861                 if (empty($data)) {
 862                         return 0;
 863                 }
 864
 865                 $photo = DBA::selectFirst('photo', ['id'], ['resource-id' => $data['guid'], 'scale' => $data['scale']]);
 866                 if (!empty($photo['id'])) {
 867                         return $photo['id'];
 868                 }
 869                 return 0;
 870         }
 871
 872         /**
 873          * Tests if the link points to a locally stored picture page
 874          *
 875          * @param string $name Page link
 876          * @return boolean
 877          * @throws \Exception
 878          */
 879         public static function isLocalPage(string $name): bool
 880         {
 881                 $base = DI::baseUrl()->get();
 882
 883                 $guid = str_replace(Strings::normaliseLink($base), '', Strings::normaliseLink($name));
 884                 $guid = preg_replace("=/photos/.*/image/(.*)=ism", '$1', $guid);
 885                 if (empty($guid)) {
 886                         return false;
 887                 }
 888
 889                 return DBA::exists('photo', ['resource-id' => $guid]);
 890         }
 891
 892         /**
 893          * Tries to resize image to wanted maximum size
 894          *
 895          * @param Image $image Image instance
 896          * @return Image|null Image instance on success, null on error
 897          */
 898         private static function fitImageSize(Image $image)
 899         {
 900                 $max_length = DI::config()->get('system', 'max_image_length');
 901                 if ($max_length > 0) {
 902                         $image->scaleDown($max_length);
 903                         Logger::info('File upload: Scaling picture to new size', ['max-length' => $max_length]);
 904                 }
 905
 906                 $filesize = strlen($image->asString());
 907                 $width    = $image->getWidth();
 908                 $height   = $image->getHeight();
 909
 910                 $maximagesize = DI::config()->get('system', 'maximagesize');
 911
 912                 if (!empty($maximagesize) && ($filesize > $maximagesize)) {
 913                         // Scale down to multiples of 640 until the maximum size isn't exceeded anymore
 914                         foreach ([5120, 2560, 1280, 640] as $pixels) {
 915                                 if (($filesize > $maximagesize) && (max($width, $height) > $pixels)) {
 916                                         Logger::info('Resize', ['size' => $filesize, 'width' => $width, 'height' => $height, 'max' => $maximagesize, 'pixels' => $pixels]);
 917                                         $image->scaleDown($pixels);
 918                                         $filesize = strlen($image->asString());
 919                                         $width = $image->getWidth();
 920                                         $height = $image->getHeight();
 921                                 }
 922                         }
 923                         if ($filesize > $maximagesize) {
 924                                 Logger::notice('Image size is too big', ['size' => $filesize, 'max' => $maximagesize]);
 925                                 return null;
 926                         }
 927                 }
 928
 929                 return $image;
 930         }
 931
 932         /**
 933          * Fetches image from URL and returns an array with instance and local file name
 934          *
 935          * @param string $image_url URL to image
 936          * @return array With: 'image' and 'filename' fields or empty array on error
 937          */
 938         private static function loadImageFromURL(string $image_url): array
 939         {
 940                 $filename = basename($image_url);
 941                 if (!empty($image_url)) {
 942                         $ret = DI::httpClient()->get($image_url, HttpClientAccept::IMAGE);
 943                         Logger::debug('Got picture', ['Content-Type' => $ret->getHeader('Content-Type'), 'url' => $image_url]);
 944                         $img_str = $ret->getBody();
 945                         $type = $ret->getContentType();
 946                 } else {
 947                         $img_str = '';
 948                         $type = '';
 949                 }
 950
 951                 if (empty($img_str)) {
 952                         Logger::notice('Empty content');
 953                         return [];
 954                 }
 955
 956                 $type = Images::getMimeTypeByData($img_str, $image_url, $type);
 957
 958                 $image = new Image($img_str, $type);
 959
 960                 $image = self::fitImageSize($image);
 961                 if (empty($image)) {
 962                         return [];
 963                 }
 964
 965                 return ['image' => $image, 'filename' => $filename];
 966         }
 967
 968         /**
 969          * Inserts uploaded image into database and removes local temporary file
 970          *
 971          * @param array $files File array
 972          * @return array With 'image' for Image instance and 'filename' for local file name or empty array on error
 973          */
 974         private static function uploadImage(array $files): array
 975         {
 976                 Logger::info('starting new upload');
 977
 978                 if (empty($files)) {
 979                         Logger::notice('Empty upload file');
 980                         return [];
 981                 }
 982
 983                 if (!empty($files['tmp_name'])) {
 984                         if (is_array($files['tmp_name'])) {
 985                                 $src = $files['tmp_name'][0];
 986                         } else {
 987                                 $src = $files['tmp_name'];
 988                         }
 989                 } else {
 990                         $src = '';
 991                 }
 992
 993                 if (!empty($files['name'])) {
 994                         if (is_array($files['name'])) {
 995                                 $filename = basename($files['name'][0]);
 996                         } else {
 997                                 $filename = basename($files['name']);
 998                         }
 999                 } else {
1000                         $filename = '';
1001                 }
1002
1003                 if (!empty($files['size'])) {
1004                         if (is_array($files['size'])) {
1005                                 $filesize = intval($files['size'][0]);
1006                         } else {
1007                                 $filesize = intval($files['size']);
1008                         }
1009                 } else {
1010                         $filesize = 0;
1011                 }
1012
1013                 if (!empty($files['type'])) {
1014                         if (is_array($files['type'])) {
1015                                 $filetype = $files['type'][0];
1016                         } else {
1017                                 $filetype = $files['type'];
1018                         }
1019                 } else {
1020                         $filetype = '';
1021                 }
1022
1023                 if (empty($src)) {
1024                         Logger::notice('No source file name', ['files' => $files]);
1025                         return [];
1026                 }
1027
1028                 $filetype = Images::getMimeTypeBySource($src, $filename, $filetype);
1029
1030                 Logger::info('File upload', ['src' => $src, 'filename' => $filename, 'size' => $filesize, 'type' => $filetype]);
1031
1032                 $imagedata = @file_get_contents($src);
1033                 $image = new Image($imagedata, $filetype);
1034                 if (!$image->isValid()) {
1035                         Logger::notice('Image is unvalid', ['files' => $files]);
1036                         return [];
1037                 }
1038
1039                 $image->orient($src);
1040                 @unlink($src);
1041
1042                 $image = self::fitImageSize($image);
1043                 if (empty($image)) {
1044                         return [];
1045                 }
1046
1047                 return ['image' => $image, 'filename' => $filename];
1048         }
1049
1050         /**
1051          * Handles uploaded image and assigns it to given user id
1052          *
1053          * @param int         $uid   User ID
1054          * @param array       $files uploaded file array
1055          * @param string      $album Album name (optional)
1056          * @param string|null $allow_cid
1057          * @param string|null $allow_gid
1058          * @param string      $deny_cid
1059          * @param string      $deny_gid
1060          * @param string      $desc Description (optional)
1061          * @param string      $resource_id GUID (optional)
1062          * @return array photo record or empty array on error
1063          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1064          */
1065         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
1066         {
1067                 $user = User::getOwnerDataById($uid);
1068                 if (empty($user)) {
1069                         Logger::notice('User not found', ['uid' => $uid]);
1070                         return [];
1071                 }
1072
1073                 $data = self::uploadImage($files);
1074                 if (empty($data)) {
1075                         Logger::info('upload failed');
1076                         return [];
1077                 }
1078
1079                 $image    = $data['image'];
1080                 $filename = $data['filename'];
1081                 $width    = $image->getWidth();
1082                 $height   = $image->getHeight();
1083
1084                 $resource_id = $resource_id ?: self::newResource();
1085                 $album       = $album ?: DI::l10n()->t('Wall Photos');
1086
1087                 if (is_null($allow_cid) && is_null($allow_gid)) {
1088                         $allow_cid = '<' . $user['id'] . '>';
1089                         $allow_gid = '';
1090                 }
1091
1092                 $smallest = 0;
1093
1094                 $r = self::store($image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
1095                 if (!$r) {
1096                         Logger::notice('Photo could not be stored');
1097                         return [];
1098                 }
1099
1100                 if ($width > 640 || $height > 640) {
1101                         $image->scaleDown(640);
1102                         $r = self::store($image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
1103                         if ($r) {
1104                                 $smallest = 1;
1105                         }
1106                 }
1107
1108                 if ($width > 320 || $height > 320) {
1109                         $image->scaleDown(320);
1110                         $r = self::store($image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
1111                         if ($r && ($smallest == 0)) {
1112                                 $smallest = 2;
1113                         }
1114                 }
1115
1116                 $condition = ['resource-id' => $resource_id];
1117                 $photo = self::selectFirst(['id', 'datasize', 'width', 'height', 'type'], $condition, ['order' => ['width' => true]]);
1118                 if (empty($photo)) {
1119                         Logger::notice('Photo not found', ['condition' => $condition]);
1120                         return [];
1121                 }
1122
1123                 $picture = [];
1124
1125                 $picture['id']          = $photo['id'];
1126                 $picture['resource_id'] = $resource_id;
1127                 $picture['size']        = $photo['datasize'];
1128                 $picture['width']       = $photo['width'];
1129                 $picture['height']      = $photo['height'];
1130                 $picture['type']        = $photo['type'];
1131                 $picture['albumpage']   = DI::baseUrl() . '/photos/' . $user['nickname'] . '/image/' . $resource_id;
1132                 $picture['picture']     = DI::baseUrl() . '/photo/{$resource_id}-0.' . $image->getExt();
1133                 $picture['preview']     = DI::baseUrl() . '/photo/{$resource_id}-{$smallest}.' . $image->getExt();
1134
1135                 Logger::info('upload done', ['picture' => $picture]);
1136                 return $picture;
1137         }
1138
1139         /**
1140          * Upload a user avatar
1141          *
1142          * @param int    $uid   User ID
1143          * @param array  $files uploaded file array
1144          * @param string $url   External image url
1145          * @return string avatar resource
1146          */
1147         public static function uploadAvatar(int $uid, array $files, string $url = ''): string
1148         {
1149                 if (!empty($files)) {
1150                         $data = self::uploadImage($files);
1151                         if (empty($data)) {
1152                                 Logger::info('upload failed');
1153                                 return '';
1154                         }
1155                 } elseif (!empty($url)) {
1156                         $data = self::loadImageFromURL($url);
1157                         if (empty($data)) {
1158                                 Logger::info('loading from external url failed');
1159                                 return '';
1160                         }
1161                 } else {
1162                         Logger::info('Neither files nor url provided');
1163                         return '';
1164                 }
1165
1166                 $image    = $data['image'];
1167                 $filename = $data['filename'];
1168                 $width    = $image->getWidth();
1169                 $height   = $image->getHeight();
1170
1171                 $resource_id = self::newResource();
1172                 $album       = DI::l10n()->t(self::PROFILE_PHOTOS);
1173
1174                 // upload profile image (scales 4, 5, 6)
1175                 logger::info('starting new profile image upload');
1176
1177                 if ($width > 300 || $height > 300) {
1178                         $image->scaleDown(300);
1179                 }
1180
1181                 $r = self::store($image, $uid, 0, $resource_id, $filename, $album, 4, self::USER_AVATAR);
1182                 if (!$r) {
1183                         logger::notice('profile image upload with scale 4 (300) failed');
1184                 }
1185
1186                 if ($width > 80 || $height > 80) {
1187                         $image->scaleDown(80);
1188                 }
1189
1190                 $r = self::store($image, $uid, 0, $resource_id, $filename, $album, 5, self::USER_AVATAR);
1191                 if (!$r) {
1192                         logger::notice('profile image upload with scale 5 (80) failed');
1193                 }
1194
1195                 if ($width > 48 || $height > 48) {
1196                         $image->scaleDown(48);
1197                 }
1198
1199                 $r = self::store($image, $uid, 0, $resource_id, $filename, $album, 6, self::USER_AVATAR);
1200                 if (!$r) {
1201                         logger::notice('profile image upload with scale 6 (48) failed');
1202                 }
1203
1204                 logger::info('new profile image upload ended');
1205
1206                 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $resource_id, $uid];
1207                 self::update(['profile' => false, 'photo-type' => self::DEFAULT], $condition);
1208
1209                 Contact::updateSelfFromUserID($uid, true);
1210
1211                 // Update global directory in background
1212                 Profile::publishUpdate($uid);
1213
1214                 return $resource_id;
1215         }
1216
1217         /**
1218          * Upload a user banner
1219          *
1220          * @param int    $uid   User ID
1221          * @param array  $files uploaded file array
1222          * @param string $url   External image url
1223          * @return string avatar resource
1224          */
1225         public static function uploadBanner(int $uid, array $files = [], string $url = ''): string
1226         {
1227                 if (!empty($files)) {
1228                         $data = self::uploadImage($files);
1229                         if (empty($data)) {
1230                                 Logger::info('upload failed');
1231                                 return '';
1232                         }
1233                 } elseif (!empty($url)) {
1234                         $data = self::loadImageFromURL($url);
1235                         if (empty($data)) {
1236                                 Logger::info('loading from external url failed');
1237                                 return '';
1238                         }
1239                 } else {
1240                         Logger::info('Neither files nor url provided');
1241                         return '';
1242                 }
1243
1244                 $image    = $data['image'];
1245                 $filename = $data['filename'];
1246                 $width    = $image->getWidth();
1247                 $height   = $image->getHeight();
1248
1249                 $resource_id = self::newResource();
1250                 $album       = DI::l10n()->t(self::BANNER_PHOTOS);
1251
1252                 if ($width > 960) {
1253                         $image->scaleDown(960);
1254                 }
1255
1256                 $r = self::store($image, $uid, 0, $resource_id, $filename, $album, 3, self::USER_BANNER);
1257                 if (!$r) {
1258                         logger::notice('profile banner upload with scale 3 (960) failed');
1259                 }
1260
1261                 logger::info('new profile banner upload ended');
1262
1263                 $condition = ["`photo-type` = ? AND `resource-id` != ? AND `uid` = ?", self::USER_BANNER, $resource_id, $uid];
1264                 self::update(['photo-type' => self::DEFAULT], $condition);
1265
1266                 Contact::updateSelfFromUserID($uid, true);
1267
1268                 // Update global directory in background
1269                 Profile::publishUpdate($uid);
1270
1271                 return $resource_id;
1272         }
1273 }
1274