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\Proxy;
36 use Friendica\Util\Strings;
38 require_once "include/dba.php";
41 * Class to handle photo dabatase table
45 const CONTACT_PHOTOS = 'Contact Photos';
48 * Select rows from the photo table and returns them as array
50 * @param array $fields Array of selected fields, empty for all
51 * @param array $conditions Array of fields for conditions
52 * @param array $params Array of several parameters
54 * @return boolean|array
57 * @see \Friendica\Database\DBA::selectToArray
59 public static function selectToArray(array $fields = [], array $conditions = [], array $params = [])
62 $fields = self::getFields();
65 return DBA::selectToArray('photo', $fields, $conditions, $params);
69 * Retrieve a single record from the photo table
71 * @param array $fields Array of selected fields, empty for all
72 * @param array $conditions Array of fields for conditions
73 * @param array $params Array of several parameters
78 * @see \Friendica\Database\DBA::select
80 public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
83 $fields = self::getFields();
86 return DBA::selectFirst("photo", $fields, $conditions, $params);
90 * Get photos for user id
92 * @param integer $uid User id
93 * @param string $resourceid Rescource ID of the photo
94 * @param array $conditions Array of fields for conditions
95 * @param array $params Array of several parameters
100 * @see \Friendica\Database\DBA::select
102 public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
104 $conditions["resource-id"] = $resourceid;
105 $conditions["uid"] = $uid;
107 return self::selectToArray([], $conditions, $params);
111 * Get a photo for user id
113 * @param integer $uid User id
114 * @param string $resourceid Rescource ID of the photo
115 * @param integer $scale Scale of the photo. Defaults to 0
116 * @param array $conditions Array of fields for conditions
117 * @param array $params Array of several parameters
122 * @see \Friendica\Database\DBA::select
124 public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
126 $conditions["resource-id"] = $resourceid;
127 $conditions["uid"] = $uid;
128 $conditions["scale"] = $scale;
130 return self::selectFirst([], $conditions, $params);
134 * Get a single photo given resource id and scale
136 * This method checks for permissions. Returns associative array
137 * on success, "no sign" image info, if user has no permission,
138 * false if photo does not exists
140 * @param string $resourceid Rescource ID of the photo
141 * @param integer $scale Scale of the photo. Defaults to 0
143 * @return boolean|array
146 public static function getPhoto(string $resourceid, int $scale = 0)
148 $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
149 if (!DBA::isResult($r)) {
155 $accessible = $uid ? (bool)DI::pConfig()->get($uid, 'system', 'accessible-photos', false) : false;
157 $sql_acl = Security::getPermissionsSQLByUserId($uid, $accessible);
159 $conditions = ["`resource-id` = ? AND `scale` <= ? " . $sql_acl, $resourceid, $scale];
160 $params = ["order" => ["scale" => true]];
161 $photo = self::selectFirst([], $conditions, $params);
167 * Check if photo with given conditions exists
169 * @param array $conditions Array of extra conditions
174 public static function exists(array $conditions)
176 return DBA::exists("photo", $conditions);
181 * Get Image object for given row id. null if row id does not exist
183 * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
185 * @return \Friendica\Object\Image
186 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
187 * @throws \ImagickException
189 public static function getImageForPhoto(array $photo)
191 $backendClass = DI::storageManager()->getByName($photo['backend-class'] ?? '');
192 if ($backendClass === null) {
193 // legacy data storage in "data" column
194 $i = self::selectFirst(['data'], ['id' => $photo['id']]);
200 $backendRef = $photo['backend-ref'] ?? '';
201 $data = $backendClass->get($backendRef);
208 return new Image($data, $photo['type']);
212 * Return a list of fields that are associated with the photo table
214 * @return array field list
217 private static function getFields()
219 $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
220 $fields = array_keys($allfields["photo"]["fields"]);
221 array_splice($fields, array_search("data", $fields), 1);
226 * Construct a photo array for a system resource image
228 * @param string $filename Image file name relative to code root
229 * @param string $mimetype Image mime type. Defaults to "image/jpeg"
234 public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
236 $fields = self::getFields();
237 $values = array_fill(0, count($fields), "");
239 $photo = array_combine($fields, $values);
240 $photo['backend-class'] = SystemResource::NAME;
241 $photo['backend-ref'] = $filename;
242 $photo['type'] = $mimetype;
243 $photo['cacheable'] = false;
250 * store photo metadata in db and binary in default backend
252 * @param Image $Image Image object with data
253 * @param integer $uid User ID
254 * @param integer $cid Contact ID
255 * @param integer $rid Resource ID
256 * @param string $filename Filename
257 * @param string $album Album name
258 * @param integer $scale Scale
259 * @param integer $profile Is a profile image? optional, default = 0
260 * @param string $allow_cid Permissions, allowed contacts. optional, default = ""
261 * @param string $allow_gid Permissions, allowed groups. optional, default = ""
262 * @param string $deny_cid Permissions, denied contacts.optional, default = ""
263 * @param string $deny_gid Permissions, denied greoup.optional, default = ""
264 * @param string $desc Photo caption. optional, default = ""
266 * @return boolean True on success
267 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
269 public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
271 $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
272 if (DBA::isResult($photo)) {
273 $guid = $photo["guid"];
275 $guid = System::createGUID();
278 $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
279 $created = DateTimeFormat::utcNow();
280 if (DBA::isResult($existing_photo)) {
281 $created = $existing_photo["created"];
284 // Get defined storage backend.
285 // if no storage backend, we use old "data" column in photo table.
286 // if is an existing photo, reuse same backend
290 if (DBA::isResult($existing_photo)) {
291 $backend_ref = (string)$existing_photo["backend-ref"];
292 $storage = DI::storageManager()->getByName($existing_photo["backend-class"] ?? '');
294 $storage = DI::storage();
297 if ($storage === null) {
298 $data = $Image->asString();
300 $backend_ref = $storage->put($Image->asString(), $backend_ref);
305 "contact-id" => $cid,
307 "resource-id" => $rid,
308 "hash" => md5($Image->asString()),
309 "created" => $created,
310 "edited" => DateTimeFormat::utcNow(),
311 "filename" => basename($filename),
312 "type" => $Image->getType(),
314 "height" => $Image->getHeight(),
315 "width" => $Image->getWidth(),
316 "datasize" => strlen($Image->asString()),
319 "profile" => $profile,
320 "allow_cid" => $allow_cid,
321 "allow_gid" => $allow_gid,
322 "deny_cid" => $deny_cid,
323 "deny_gid" => $deny_gid,
325 "backend-class" => (string)$storage,
326 "backend-ref" => $backend_ref
329 if (DBA::isResult($existing_photo)) {
330 $r = DBA::update("photo", $fields, ["id" => $existing_photo["id"]]);
332 $r = DBA::insert("photo", $fields);
340 * Delete info from table and data from storage
342 * @param array $conditions Field condition(s)
343 * @param array $options Options array, Optional
348 * @see \Friendica\Database\DBA::delete
350 public static function delete(array $conditions, array $options = [])
352 // get photo to delete data info
353 $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
355 foreach($photos as $photo) {
356 $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
357 if ($backend_class !== null) {
358 $backend_class->delete($photo["backend-ref"] ?? '');
362 return DBA::delete("photo", $conditions, $options);
368 * @param array $fields Contains the fields that are updated
369 * @param array $conditions Condition array with the key values
370 * @param Image $img Image to update. Optional, default null.
371 * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
373 * @return boolean Was the update successfull?
375 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
376 * @see \Friendica\Database\DBA::update
378 public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
380 if (!is_null($img)) {
381 // get photo to update
382 $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
384 foreach($photos as $photo) {
385 $backend_class = DI::storageManager()->getByName($photo['backend-class'] ?? '');
386 if ($backend_class !== null) {
387 $fields["backend-ref"] = $backend_class->put($img->asString(), $photo['backend-ref']);
389 $fields["data"] = $img->asString();
392 $fields['updated'] = DateTimeFormat::utcNow();
395 $fields['edited'] = DateTimeFormat::utcNow();
397 return DBA::update("photo", $fields, $conditions, $old_fields);
401 * @param string $image_url Remote URL
402 * @param integer $uid user id
403 * @param integer $cid contact id
404 * @param boolean $quit_on_error optional, default false
406 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
407 * @throws \ImagickException
409 public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
414 $photo = DBA::selectFirst(
415 "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "album" => self::CONTACT_PHOTOS]
417 if (!empty($photo['resource-id'])) {
418 $resource_id = $photo["resource-id"];
420 $resource_id = self::newResource();
423 $photo_failure = false;
425 $filename = basename($image_url);
426 if (!empty($image_url)) {
427 $ret = DI::httpRequest()->get($image_url);
428 $img_str = $ret->getBody();
429 $type = $ret->getContentType();
434 if ($quit_on_error && ($img_str == "")) {
438 $type = Images::getMimeTypeByData($img_str, $image_url, $type);
440 $Image = new Image($img_str, $type);
441 if ($Image->isValid()) {
442 $Image->scaleToSquare(300);
444 $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 4);
447 $photo_failure = true;
450 $Image->scaleDown(80);
452 $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 5);
455 $photo_failure = true;
458 $Image->scaleDown(48);
460 $r = self::store($Image, $uid, $cid, $resource_id, $filename, self::CONTACT_PHOTOS, 6);
463 $photo_failure = true;
466 $suffix = "?ts=" . time();
468 $image_url = DI::baseUrl() . "/photo/" . $resource_id . "-4." . $Image->getExt() . $suffix;
469 $thumb = DI::baseUrl() . "/photo/" . $resource_id . "-5." . $Image->getExt() . $suffix;
470 $micro = DI::baseUrl() . "/photo/" . $resource_id . "-6." . $Image->getExt() . $suffix;
472 // Remove the cached photo
474 $basepath = $a->getBasePath();
476 if (is_dir($basepath . "/photo")) {
477 $filename = $basepath . "/photo/" . $resource_id . "-4." . $Image->getExt();
478 if (file_exists($filename)) {
481 $filename = $basepath . "/photo/" . $resource_id . "-5." . $Image->getExt();
482 if (file_exists($filename)) {
485 $filename = $basepath . "/photo/" . $resource_id . "-6." . $Image->getExt();
486 if (file_exists($filename)) {
491 $photo_failure = true;
494 if ($photo_failure && $quit_on_error) {
498 if ($photo_failure) {
499 $contact = Contact::getById($cid) ?: [];
500 $image_url = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
501 $thumb = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
502 $micro = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
505 return [$image_url, $thumb, $micro];
509 * @param array $exifCoord coordinate
510 * @param string $hemi hemi
513 public static function getGps($exifCoord, $hemi)
515 $degrees = count($exifCoord) > 0 ? self::gps2Num($exifCoord[0]) : 0;
516 $minutes = count($exifCoord) > 1 ? self::gps2Num($exifCoord[1]) : 0;
517 $seconds = count($exifCoord) > 2 ? self::gps2Num($exifCoord[2]) : 0;
519 $flip = ($hemi == "W" || $hemi == "S") ? -1 : 1;
521 return floatval($flip * ($degrees + ($minutes / 60) + ($seconds / 3600)));
525 * @param string $coordPart coordPart
528 private static function gps2Num($coordPart)
530 $parts = explode("/", $coordPart);
532 if (count($parts) <= 0) {
536 if (count($parts) == 1) {
540 return floatval($parts[0]) / floatval($parts[1]);
544 * Fetch the photo albums that are available for a viewer
546 * The query in this function is cost intensive, so it is cached.
548 * @param int $uid User id of the photos
549 * @param bool $update Update the cache
551 * @return array Returns array of the photo albums
552 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
554 public static function getAlbums($uid, $update = false)
556 $sql_extra = Security::getPermissionsSQLByUserId($uid);
558 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
559 $albums = DI::cache()->get($key);
560 if (is_null($albums) || $update) {
561 if (!DI::config()->get("system", "no_count", false)) {
562 /// @todo This query needs to be renewed. It is really slow
563 // At this time we just store the data in the cache
564 $albums = q("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
566 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra
567 GROUP BY `album` ORDER BY `created` DESC",
569 DBA::escape(self::CONTACT_PHOTOS),
570 DBA::escape(DI::l10n()->t(self::CONTACT_PHOTOS))
573 // This query doesn't do the count and is much faster
574 $albums = q("SELECT DISTINCT(`album`), '' AS `total`
575 FROM `photo` USE INDEX (`uid_album_scale_created`)
576 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra",
578 DBA::escape(self::CONTACT_PHOTOS),
579 DBA::escape(DI::l10n()->t(self::CONTACT_PHOTOS))
582 DI::cache()->set($key, $albums, Duration::DAY);
588 * @param int $uid User id of the photos
592 public static function clearAlbumCache($uid)
594 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
595 DI::cache()->set($key, null, Duration::DAY);
599 * Generate a unique photo ID.
604 public static function newResource()
606 return System::createGUID(32, false);
610 * Extracts the rid from a local photo URI
612 * @param string $image_uri The URI of the photo
613 * @return string The rid of the photo, or an empty string if the URI is not local
615 public static function ridFromURI(string $image_uri)
617 if (!stristr($image_uri, DI::baseUrl() . '/photo/')) {
620 $image_uri = substr($image_uri, strrpos($image_uri, '/') + 1);
621 $image_uri = substr($image_uri, 0, strpos($image_uri, '-'));
622 if (!strlen($image_uri)) {
629 * Changes photo permissions that had been embedded in a post
631 * @todo This function currently does have some flaws:
632 * - Sharing a post with a forum will create a photo that only the forum can see.
633 * - Sharing a photo again that been shared non public before doesn't alter the permissions.
638 public static function setPermissionFromBody($body, $uid, $original_contact_id, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny)
640 // Simplify image codes
641 $img_body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
642 $img_body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $img_body);
645 if (!preg_match_all("/\[img\](.*?)\[\/img\]/", $img_body, $match)) {
649 if (empty($images)) {
653 foreach ($images as $image) {
654 $image_rid = self::ridFromURI($image);
655 if (empty($image_rid)) {
659 // Ensure to only modify photos that you own
660 $srch = '<' . intval($original_contact_id) . '>';
663 'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
664 'resource-id' => $image_rid, 'uid' => $uid
666 if (!Photo::exists($condition)) {
667 $photo = self::selectFirst(['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'uid'], ['resource-id' => $image_rid]);
668 if (!DBA::isResult($photo)) {
669 Logger::info('Image not found', ['resource-id' => $image_rid]);
671 Logger::info('Mismatching permissions', ['condition' => $condition, 'photo' => $photo]);
677 * @todo Existing permissions need to be mixed with the new ones.
678 * Otherwise this creates problems with sharing the same picture multiple times
679 * Also check if $str_contact_allow does contain a public forum.
680 * Then set the permissions to public.
683 $fields = ['allow_cid' => $str_contact_allow, 'allow_gid' => $str_group_allow,
684 'deny_cid' => $str_contact_deny, 'deny_gid' => $str_group_deny,
685 'accessible' => DI::pConfig()->get($uid, 'system', 'accessible-photos', false)];
687 $condition = ['resource-id' => $image_rid, 'uid' => $uid];
688 Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
689 Photo::update($fields, $condition);
696 * Strips known picture extensions from picture links
698 * @param string $name Picture link
699 * @return string stripped picture link
702 public static function stripExtension($name)
704 $name = str_replace([".jpg", ".png", ".gif"], ["", "", ""], $name);
705 foreach (Images::supportedTypes() as $m => $e) {
706 $name = str_replace("." . $e, "", $name);
712 * Returns the GUID from picture links
714 * @param string $name Picture link
715 * @return string GUID
718 public static function getGUID($name)
720 $base = DI::baseUrl()->get();
722 $guid = str_replace([Strings::normaliseLink($base), '/photo/'], '', Strings::normaliseLink($name));
724 $guid = self::stripExtension($guid);
725 if (substr($guid, -2, 1) != "-") {
729 $scale = intval(substr($guid, -1, 1));
730 if (!is_numeric($scale)) {
734 $guid = substr($guid, 0, -2);
739 * Tests if the picture link points to a locally stored picture
741 * @param string $name Picture link
745 public static function isLocal($name)
747 $guid = self::getGUID($name);
753 return DBA::exists('photo', ['resource-id' => $guid]);
757 * Tests if the link points to a locally stored picture page
759 * @param string $name Page link
763 public static function isLocalPage($name)
765 $base = DI::baseUrl()->get();
767 $guid = str_replace(Strings::normaliseLink($base), '', Strings::normaliseLink($name));
768 $guid = preg_replace("=/photos/.*/image/(.*)=ism", '$1', $guid);
773 return DBA::exists('photo', ['resource-id' => $guid]);