3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Model;
24 use Friendica\Core\Cache\Duration;
25 use Friendica\Core\Logger;
26 use Friendica\Core\System;
27 use Friendica\Database\DBA;
28 use Friendica\Database\DBStructure;
30 use Friendica\Model\Storage\SystemResource;
31 use Friendica\Object\Image;
32 use Friendica\Util\DateTimeFormat;
33 use Friendica\Util\Images;
34 use Friendica\Security\Security;
35 use Friendica\Util\Strings;
37 require_once "include/dba.php";
40 * Class to handle photo dabatase table
44 const CONTACT_PHOTOS = 'Contact Photos';
47 * Select rows from the photo table and returns them as array
49 * @param array $fields Array of selected fields, empty for all
50 * @param array $conditions Array of fields for conditions
51 * @param array $params Array of several parameters
53 * @return boolean|array
56 * @see \Friendica\Database\DBA::selectToArray
58 public static function selectToArray(array $fields = [], array $conditions = [], array $params = [])
61 $fields = self::getFields();
64 return DBA::selectToArray('photo', $fields, $conditions, $params);
68 * Retrieve a single record from the photo table
70 * @param array $fields Array of selected fields, empty for all
71 * @param array $conditions Array of fields for conditions
72 * @param array $params Array of several parameters
77 * @see \Friendica\Database\DBA::select
79 public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
82 $fields = self::getFields();
85 return DBA::selectFirst("photo", $fields, $conditions, $params);
89 * Get photos for user id
91 * @param integer $uid User id
92 * @param string $resourceid Rescource ID of the photo
93 * @param array $conditions Array of fields for conditions
94 * @param array $params Array of several parameters
99 * @see \Friendica\Database\DBA::select
101 public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
103 $conditions["resource-id"] = $resourceid;
104 $conditions["uid"] = $uid;
106 return self::selectToArray([], $conditions, $params);
110 * Get a photo for user id
112 * @param integer $uid User id
113 * @param string $resourceid Rescource ID of the photo
114 * @param integer $scale Scale of the photo. Defaults to 0
115 * @param array $conditions Array of fields for conditions
116 * @param array $params Array of several parameters
121 * @see \Friendica\Database\DBA::select
123 public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
125 $conditions["resource-id"] = $resourceid;
126 $conditions["uid"] = $uid;
127 $conditions["scale"] = $scale;
129 return self::selectFirst([], $conditions, $params);
133 * Get a single photo given resource id and scale
135 * This method checks for permissions. Returns associative array
136 * on success, "no sign" image info, if user has no permission,
137 * false if photo does not exists
139 * @param string $resourceid Rescource ID of the photo
140 * @param integer $scale Scale of the photo. Defaults to 0
142 * @return boolean|array
145 public static function getPhoto(string $resourceid, int $scale = 0)
147 $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
148 if (!DBA::isResult($r)) {
154 $accessible = $uid ? (bool)DI::pConfig()->get($uid, 'system', 'accessible-photos', false) : false;
156 $sql_acl = Security::getPermissionsSQLByUserId($uid, $accessible);
158 $conditions = ["`resource-id` = ? AND `scale` <= ? " . $sql_acl, $resourceid, $scale];
159 $params = ["order" => ["scale" => true]];
160 $photo = self::selectFirst([], $conditions, $params);
166 * Check if photo with given conditions exists
168 * @param array $conditions Array of extra conditions
173 public static function exists(array $conditions)
175 return DBA::exists("photo", $conditions);
180 * Get Image object for given row id. null if row id does not exist
182 * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
184 * @return \Friendica\Object\Image
185 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
186 * @throws \ImagickException
188 public static function getImageForPhoto(array $photo)
190 $backendClass = DI::storageManager()->getByName($photo['backend-class'] ?? '');
191 if ($backendClass === null) {
192 // legacy data storage in "data" column
193 $i = self::selectFirst(['data'], ['id' => $photo['id']]);
199 $backendRef = $photo['backend-ref'] ?? '';
200 $data = $backendClass->get($backendRef);
207 return new Image($data, $photo['type']);
211 * Return a list of fields that are associated with the photo table
213 * @return array field list
216 private static function getFields()
218 $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
219 $fields = array_keys($allfields["photo"]["fields"]);
220 array_splice($fields, array_search("data", $fields), 1);
225 * Construct a photo array for a system resource image
227 * @param string $filename Image file name relative to code root
228 * @param string $mimetype Image mime type. Defaults to "image/jpeg"
233 public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
235 $fields = self::getFields();
236 $values = array_fill(0, count($fields), "");
238 $photo = array_combine($fields, $values);
239 $photo['backend-class'] = SystemResource::NAME;
240 $photo['backend-ref'] = $filename;
241 $photo['type'] = $mimetype;
242 $photo['cacheable'] = false;
249 * store photo metadata in db and binary in default backend
251 * @param Image $Image Image object with data
252 * @param integer $uid User ID
253 * @param integer $cid Contact ID
254 * @param integer $rid Resource ID
255 * @param string $filename Filename
256 * @param string $album Album name
257 * @param integer $scale Scale
258 * @param integer $profile Is a profile image? optional, default = 0
259 * @param string $allow_cid Permissions, allowed contacts. optional, default = ""
260 * @param string $allow_gid Permissions, allowed groups. optional, default = ""
261 * @param string $deny_cid Permissions, denied contacts.optional, default = ""
262 * @param string $deny_gid Permissions, denied greoup.optional, default = ""
263 * @param string $desc Photo caption. optional, default = ""
265 * @return boolean True on success
266 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
268 public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
270 $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
271 if (DBA::isResult($photo)) {
272 $guid = $photo["guid"];
274 $guid = System::createGUID();
277 $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
278 $created = DateTimeFormat::utcNow();
279 if (DBA::isResult($existing_photo)) {
280 $created = $existing_photo["created"];
283 // Get defined storage backend.
284 // if no storage backend, we use old "data" column in photo table.
285 // if is an existing photo, reuse same backend
289 if (DBA::isResult($existing_photo)) {
290 $backend_ref = (string)$existing_photo["backend-ref"];
291 $storage = DI::storageManager()->getByName($existing_photo["backend-class"] ?? '');
293 $storage = DI::storage();
296 if ($storage === null) {
297 $data = $Image->asString();
299 $backend_ref = $storage->put($Image->asString(), $backend_ref);
304 "contact-id" => $cid,
306 "resource-id" => $rid,
307 "created" => $created,
308 "edited" => DateTimeFormat::utcNow(),
309 "filename" => basename($filename),
310 "type" => $Image->getType(),
312 "height" => $Image->getHeight(),
313 "width" => $Image->getWidth(),
314 "datasize" => strlen($Image->asString()),
317 "profile" => $profile,
318 "allow_cid" => $allow_cid,
319 "allow_gid" => $allow_gid,
320 "deny_cid" => $deny_cid,
321 "deny_gid" => $deny_gid,
323 "backend-class" => (string)$storage,
324 "backend-ref" => $backend_ref
327 if (DBA::isResult($existing_photo)) {
328 $r = DBA::update("photo", $fields, ["id" => $existing_photo["id"]]);
330 $r = DBA::insert("photo", $fields);
338 * Delete info from table and data from storage
340 * @param array $conditions Field condition(s)
341 * @param array $options Options array, Optional
346 * @see \Friendica\Database\DBA::delete
348 public static function delete(array $conditions, array $options = [])
350 // get photo to delete data info
351 $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
353 foreach($photos as $photo) {
354 $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
355 if ($backend_class !== null) {
356 $backend_class->delete($photo["backend-ref"] ?? '');
360 return DBA::delete("photo", $conditions, $options);
366 * @param array $fields Contains the fields that are updated
367 * @param array $conditions Condition array with the key values
368 * @param Image $img Image to update. Optional, default null.
369 * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
371 * @return boolean Was the update successfull?
373 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
374 * @see \Friendica\Database\DBA::update
376 public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
378 if (!is_null($img)) {
379 // get photo to update
380 $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
382 foreach($photos as $photo) {
383 $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
384 if ($backend_class !== null) {
385 $fields["backend-ref"] = $backend_class->put($img->asString(), $photo['backend-ref']);
387 $fields["data"] = $img->asString();
390 $fields['updated'] = DateTimeFormat::utcNow();
393 $fields['edited'] = DateTimeFormat::utcNow();
395 return DBA::update("photo", $fields, $conditions, $old_fields);
399 * @param string $image_url Remote URL
400 * @param integer $uid user id
401 * @param integer $cid contact id
402 * @param boolean $quit_on_error optional, default false
404 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
405 * @throws \ImagickException
407 public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
412 $photo = DBA::selectFirst(
413 "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "album" => self::CONTACT_PHOTOS]
415 if (!empty($photo['resource-id'])) {
416 $resource_id = $photo["resource-id"];
418 $resource_id = self::newResource();
421 $photo_failure = false;
423 $filename = basename($image_url);
424 if (!empty($image_url)) {
425 $ret = DI::httpRequest()->get($image_url);
426 $img_str = $ret->getBody();
427 $type = $ret->getContentType();
432 if ($quit_on_error && ($img_str == "")) {
436 $type = Images::getMimeTypeByData($img_str, $image_url, $type);
438 $Image = new Image($img_str, $type);
439 if ($Image->isValid()) {
440 $Image->scaleToSquare(300);
442 $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 4);
445 $photo_failure = true;
448 $Image->scaleDown(80);
450 $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 5);
453 $photo_failure = true;
456 $Image->scaleDown(48);
458 $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 6);
461 $photo_failure = true;
464 $suffix = "?ts=" . time();
466 $image_url = DI::baseUrl() . "/photo/" . $resource_id . "-4." . $Image->getExt() . $suffix;
467 $thumb = DI::baseUrl() . "/photo/" . $resource_id . "-5." . $Image->getExt() . $suffix;
468 $micro = DI::baseUrl() . "/photo/" . $resource_id . "-6." . $Image->getExt() . $suffix;
470 // Remove the cached photo
472 $basepath = $a->getBasePath();
474 if (is_dir($basepath . "/photo")) {
475 $filename = $basepath . "/photo/" . $resource_id . "-4." . $Image->getExt();
476 if (file_exists($filename)) {
479 $filename = $basepath . "/photo/" . $resource_id . "-5." . $Image->getExt();
480 if (file_exists($filename)) {
483 $filename = $basepath . "/photo/" . $resource_id . "-6." . $Image->getExt();
484 if (file_exists($filename)) {
489 $photo_failure = true;
492 if ($photo_failure && $quit_on_error) {
496 if ($photo_failure) {
497 $image_url = DI::baseUrl() . Contact::DEFAULT_AVATAR_PHOTO;
498 $thumb = DI::baseUrl() . Contact::DEFAULT_AVATAR_THUMB;
499 $micro = DI::baseUrl() . Contact::DEFAULT_AVATAR_MICRO;
502 return [$image_url, $thumb, $micro];
506 * @param array $exifCoord coordinate
507 * @param string $hemi hemi
510 public static function getGps($exifCoord, $hemi)
512 $degrees = count($exifCoord) > 0 ? self::gps2Num($exifCoord[0]) : 0;
513 $minutes = count($exifCoord) > 1 ? self::gps2Num($exifCoord[1]) : 0;
514 $seconds = count($exifCoord) > 2 ? self::gps2Num($exifCoord[2]) : 0;
516 $flip = ($hemi == "W" || $hemi == "S") ? -1 : 1;
518 return floatval($flip * ($degrees + ($minutes / 60) + ($seconds / 3600)));
522 * @param string $coordPart coordPart
525 private static function gps2Num($coordPart)
527 $parts = explode("/", $coordPart);
529 if (count($parts) <= 0) {
533 if (count($parts) == 1) {
537 return floatval($parts[0]) / floatval($parts[1]);
541 * Fetch the photo albums that are available for a viewer
543 * The query in this function is cost intensive, so it is cached.
545 * @param int $uid User id of the photos
546 * @param bool $update Update the cache
548 * @return array Returns array of the photo albums
549 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
551 public static function getAlbums($uid, $update = false)
553 $sql_extra = Security::getPermissionsSQLByUserId($uid);
555 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
556 $albums = DI::cache()->get($key);
557 if (is_null($albums) || $update) {
558 if (!DI::config()->get("system", "no_count", false)) {
559 /// @todo This query needs to be renewed. It is really slow
560 // At this time we just store the data in the cache
561 $albums = q("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
563 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra
564 GROUP BY `album` ORDER BY `created` DESC",
566 DBA::escape(self::CONTACT_PHOTOS),
567 DBA::escape(DI::l10n()->t(self::CONTACT_PHOTOS))
570 // This query doesn't do the count and is much faster
571 $albums = q("SELECT DISTINCT(`album`), '' AS `total`
572 FROM `photo` USE INDEX (`uid_album_scale_created`)
573 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra",
575 DBA::escape(self::CONTACT_PHOTOS),
576 DBA::escape(DI::l10n()->t(self::CONTACT_PHOTOS))
579 DI::cache()->set($key, $albums, Duration::DAY);
585 * @param int $uid User id of the photos
589 public static function clearAlbumCache($uid)
591 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
592 DI::cache()->set($key, null, Duration::DAY);
596 * Generate a unique photo ID.
601 public static function newResource()
603 return System::createGUID(32, false);
607 * Extracts the rid from a local photo URI
609 * @param string $image_uri The URI of the photo
610 * @return string The rid of the photo, or an empty string if the URI is not local
612 public static function ridFromURI(string $image_uri)
614 if (!stristr($image_uri, DI::baseUrl() . '/photo/')) {
617 $image_uri = substr($image_uri, strrpos($image_uri, '/') + 1);
618 $image_uri = substr($image_uri, 0, strpos($image_uri, '-'));
619 if (!strlen($image_uri)) {
626 * Changes photo permissions that had been embedded in a post
628 * @todo This function currently does have some flaws:
629 * - Sharing a post with a forum will create a photo that only the forum can see.
630 * - Sharing a photo again that been shared non public before doesn't alter the permissions.
635 public static function setPermissionFromBody($body, $uid, $original_contact_id, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny)
637 // Simplify image codes
638 $img_body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
639 $img_body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $img_body);
642 if (!preg_match_all("/\[img\](.*?)\[\/img\]/", $img_body, $match)) {
646 if (empty($images)) {
650 foreach ($images as $image) {
651 $image_rid = self::ridFromURI($image);
652 if (empty($image_rid)) {
656 // Ensure to only modify photos that you own
657 $srch = '<' . intval($original_contact_id) . '>';
660 'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
661 'resource-id' => $image_rid, 'uid' => $uid
663 if (!Photo::exists($condition)) {
664 $photo = self::selectFirst(['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'uid'], ['resource-id' => $image_rid]);
665 if (!DBA::isResult($photo)) {
666 Logger::info('Image not found', ['resource-id' => $image_rid]);
668 Logger::info('Mismatching permissions', ['condition' => $condition, 'photo' => $photo]);
674 * @todo Existing permissions need to be mixed with the new ones.
675 * Otherwise this creates problems with sharing the same picture multiple times
676 * Also check if $str_contact_allow does contain a public forum.
677 * Then set the permissions to public.
680 $fields = ['allow_cid' => $str_contact_allow, 'allow_gid' => $str_group_allow,
681 'deny_cid' => $str_contact_deny, 'deny_gid' => $str_group_deny,
682 'accessible' => DI::pConfig()->get($uid, 'system', 'accessible-photos', false)];
684 $condition = ['resource-id' => $image_rid, 'uid' => $uid];
685 Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
686 Photo::update($fields, $condition);
693 * Strips known picture extensions from picture links
695 * @param string $name Picture link
696 * @return string stripped picture link
699 public static function stripExtension($name)
701 $name = str_replace([".jpg", ".png", ".gif"], ["", "", ""], $name);
702 foreach (Images::supportedTypes() as $m => $e) {
703 $name = str_replace("." . $e, "", $name);
709 * Returns the GUID from picture links
711 * @param string $name Picture link
712 * @return string GUID
715 public static function getGUID($name)
717 $base = DI::baseUrl()->get();
719 $guid = str_replace([Strings::normaliseLink($base), '/photo/'], '', Strings::normaliseLink($name));
721 $guid = self::stripExtension($guid);
722 if (substr($guid, -2, 1) != "-") {
726 $scale = intval(substr($guid, -1, 1));
727 if (!is_numeric($scale)) {
731 $guid = substr($guid, 0, -2);
736 * Tests if the picture link points to a locally stored picture
738 * @param string $name Picture link
742 public static function isLocal($name)
744 $guid = self::getGUID($name);
750 return DBA::exists('photo', ['resource-id' => $guid]);
754 * Tests if the link points to a locally stored picture page
756 * @param string $name Page link
760 public static function isLocalPage($name)
762 $base = DI::baseUrl()->get();
764 $guid = str_replace(Strings::normaliseLink($base), '', Strings::normaliseLink($name));
765 $guid = preg_replace("=/photos/.*/image/(.*)=ism", '$1', $guid);
770 return DBA::exists('photo', ['resource-id' => $guid]);