4 * @file src/Model/Photo.php
5 * @brief This file contains the Photo class for database interface
7 namespace Friendica\Model;
9 use Friendica\BaseObject;
10 use Friendica\Core\Cache;
11 use Friendica\Core\Config;
12 use Friendica\Core\L10n;
13 use Friendica\Core\Logger;
14 use Friendica\Core\StorageManager;
15 use Friendica\Core\System;
16 use Friendica\Database\DBA;
17 use Friendica\Database\DBStructure;
19 use Friendica\Model\Storage\IStorage;
20 use Friendica\Object\Image;
21 use Friendica\Util\DateTimeFormat;
22 use Friendica\Util\Images;
23 use Friendica\Util\Network;
24 use Friendica\Util\Security;
25 use Friendica\Util\Strings;
27 require_once "include/dba.php";
30 * Class to handle photo dabatase table
32 class Photo extends BaseObject
35 * @brief Select rows from the photo table and returns them as array
37 * @param array $fields Array of selected fields, empty for all
38 * @param array $conditions Array of fields for conditions
39 * @param array $params Array of several parameters
41 * @return boolean|array
44 * @see \Friendica\Database\DBA::selectToArray
46 public static function selectToArray(array $fields = [], array $conditions = [], array $params = [])
49 $fields = self::getFields();
52 return DBA::selectToArray('photo', $fields, $conditions, $params);
56 * @brief Retrieve a single record from the photo table
58 * @param array $fields Array of selected fields, empty for all
59 * @param array $conditions Array of fields for conditions
60 * @param array $params Array of several parameters
65 * @see \Friendica\Database\DBA::select
67 public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
70 $fields = self::getFields();
73 return DBA::selectFirst("photo", $fields, $conditions, $params);
77 * @brief Get photos for user id
79 * @param integer $uid User id
80 * @param string $resourceid Rescource ID of the photo
81 * @param array $conditions Array of fields for conditions
82 * @param array $params Array of several parameters
87 * @see \Friendica\Database\DBA::select
89 public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
91 $conditions["resource-id"] = $resourceid;
92 $conditions["uid"] = $uid;
94 return self::selectToArray([], $conditions, $params);
98 * @brief Get a photo for user id
100 * @param integer $uid User id
101 * @param string $resourceid Rescource ID of the photo
102 * @param integer $scale Scale of the photo. Defaults to 0
103 * @param array $conditions Array of fields for conditions
104 * @param array $params Array of several parameters
109 * @see \Friendica\Database\DBA::select
111 public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
113 $conditions["resource-id"] = $resourceid;
114 $conditions["uid"] = $uid;
115 $conditions["scale"] = $scale;
117 return self::selectFirst([], $conditions, $params);
121 * @brief Get a single photo given resource id and scale
123 * This method checks for permissions. Returns associative array
124 * on success, "no sign" image info, if user has no permission,
125 * false if photo does not exists
127 * @param string $resourceid Rescource ID of the photo
128 * @param integer $scale Scale of the photo. Defaults to 0
130 * @return boolean|array
133 public static function getPhoto($resourceid, $scale = 0)
135 $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
136 if (!DBA::isResult($r)) {
142 $sql_acl = Security::getPermissionsSQLByUserId($uid);
144 $conditions = ["`resource-id` = ? AND `scale` <= ? " . $sql_acl, $resourceid, $scale];
145 $params = ["order" => ["scale" => true]];
146 $photo = self::selectFirst([], $conditions, $params);
152 * @brief Check if photo with given conditions exists
154 * @param array $conditions Array of extra conditions
159 public static function exists(array $conditions)
161 return DBA::exists("photo", $conditions);
166 * @brief Get Image object for given row id. null if row id does not exist
168 * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
170 * @return \Friendica\Object\Image
171 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
172 * @throws \ImagickException
174 public static function getImageForPhoto(array $photo)
178 if ($photo["backend-class"] == "") {
179 // legacy data storage in "data" column
180 $i = self::selectFirst(["data"], ["id" => $photo["id"]]);
186 $backendClass = $photo["backend-class"];
187 $backendRef = $photo["backend-ref"];
188 $data = $backendClass::get($backendRef);
195 return new Image($data, $photo["type"]);
199 * @brief Return a list of fields that are associated with the photo table
201 * @return array field list
204 private static function getFields()
206 $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
207 $fields = array_keys($allfields["photo"]["fields"]);
208 array_splice($fields, array_search("data", $fields), 1);
213 * @brief Construct a photo array for a system resource image
215 * @param string $filename Image file name relative to code root
216 * @param string $mimetype Image mime type. Defaults to "image/jpeg"
221 public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
223 $fields = self::getFields();
224 $values = array_fill(0, count($fields), "");
226 $photo = array_combine($fields, $values);
227 $photo["backend-class"] = Storage\SystemResource::class;
228 $photo["backend-ref"] = $filename;
229 $photo["type"] = $mimetype;
230 $photo["cacheable"] = false;
237 * @brief store photo metadata in db and binary in default backend
239 * @param Image $Image Image object with data
240 * @param integer $uid User ID
241 * @param integer $cid Contact ID
242 * @param integer $rid Resource ID
243 * @param string $filename Filename
244 * @param string $album Album name
245 * @param integer $scale Scale
246 * @param integer $profile Is a profile image? optional, default = 0
247 * @param string $allow_cid Permissions, allowed contacts. optional, default = ""
248 * @param string $allow_gid Permissions, allowed groups. optional, default = ""
249 * @param string $deny_cid Permissions, denied contacts.optional, default = ""
250 * @param string $deny_gid Permissions, denied greoup.optional, default = ""
251 * @param string $desc Photo caption. optional, default = ""
253 * @return boolean True on success
254 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
256 public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
258 $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
259 if (DBA::isResult($photo)) {
260 $guid = $photo["guid"];
262 $guid = System::createGUID();
265 $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
266 $created = DateTimeFormat::utcNow();
267 if (DBA::isResult($existing_photo)) {
268 $created = $existing_photo["created"];
271 // Get defined storage backend.
272 // if no storage backend, we use old "data" column in photo table.
273 // if is an existing photo, reuse same backend
277 /** @var IStorage $backend_class */
278 if (DBA::isResult($existing_photo)) {
279 $backend_ref = (string)$existing_photo["backend-ref"];
280 $backend_class = (string)$existing_photo["backend-class"];
282 $backend_class = StorageManager::getBackend();
285 if ($backend_class === "") {
286 $data = $Image->asString();
288 $backend_ref = $backend_class::put($Image->asString(), $backend_ref);
294 "contact-id" => $cid,
296 "resource-id" => $rid,
297 "created" => $created,
298 "edited" => DateTimeFormat::utcNow(),
299 "filename" => basename($filename),
300 "type" => $Image->getType(),
302 "height" => $Image->getHeight(),
303 "width" => $Image->getWidth(),
304 "datasize" => strlen($Image->asString()),
307 "profile" => $profile,
308 "allow_cid" => $allow_cid,
309 "allow_gid" => $allow_gid,
310 "deny_cid" => $deny_cid,
311 "deny_gid" => $deny_gid,
313 "backend-class" => $backend_class,
314 "backend-ref" => $backend_ref
317 if (DBA::isResult($existing_photo)) {
318 $r = DBA::update("photo", $fields, ["id" => $existing_photo["id"]]);
320 $r = DBA::insert("photo", $fields);
328 * @brief Delete info from table and data from storage
330 * @param array $conditions Field condition(s)
331 * @param array $options Options array, Optional
336 * @see \Friendica\Database\DBA::delete
338 public static function delete(array $conditions, array $options = [])
340 // get photo to delete data info
341 $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
343 foreach($photos as $photo) {
344 /** @var IStorage $backend_class */
345 $backend_class = (string)$photo["backend-class"];
346 if ($backend_class !== "") {
347 $backend_class::delete($photo["backend-ref"]);
351 return DBA::delete("photo", $conditions, $options);
355 * @brief Update a photo
357 * @param array $fields Contains the fields that are updated
358 * @param array $conditions Condition array with the key values
359 * @param Image $img Image to update. Optional, default null.
360 * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
362 * @return boolean Was the update successfull?
364 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
365 * @see \Friendica\Database\DBA::update
367 public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
369 if (!is_null($img)) {
370 // get photo to update
371 $photos = self::selectToArray(['backend-class', 'backend-ref'], $conditions);
373 foreach($photos as $photo) {
374 /** @var IStorage $backend_class */
375 $backend_class = (string)$photo["backend-class"];
376 if ($backend_class !== "") {
377 $fields["backend-ref"] = $backend_class::put($img->asString(), $photo["backend-ref"]);
379 $fields["data"] = $img->asString();
382 $fields['updated'] = DateTimeFormat::utcNow();
385 $fields['edited'] = DateTimeFormat::utcNow();
387 return DBA::update("photo", $fields, $conditions, $old_fields);
391 * @param string $image_url Remote URL
392 * @param integer $uid user id
393 * @param integer $cid contact id
394 * @param boolean $quit_on_error optional, default false
396 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
397 * @throws \ImagickException
399 public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
404 $photo = DBA::selectFirst(
405 "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "album" => "Contact Photos"]
407 if (!empty($photo['resource-id'])) {
408 $resource_id = $photo["resource-id"];
410 $resource_id = self::newResource();
413 $photo_failure = false;
415 $filename = basename($image_url);
416 if (!empty($image_url)) {
417 $ret = Network::curl($image_url, true);
418 $img_str = $ret->getBody();
419 $type = $ret->getContentType();
424 if ($quit_on_error && ($img_str == "")) {
429 $type = Images::guessType($image_url, true);
432 $Image = new Image($img_str, $type);
433 if ($Image->isValid()) {
434 $Image->scaleToSquare(300);
436 $r = self::store($Image, $uid, $cid, $resource_id, $filename, "Contact Photos", 4);
439 $photo_failure = true;
442 $Image->scaleDown(80);
444 $r = self::store($Image, $uid, $cid, $resource_id, $filename, "Contact Photos", 5);
447 $photo_failure = true;
450 $Image->scaleDown(48);
452 $r = self::store($Image, $uid, $cid, $resource_id, $filename, "Contact Photos", 6);
455 $photo_failure = true;
458 $suffix = "?ts=" . time();
460 $image_url = System::baseUrl() . "/photo/" . $resource_id . "-4." . $Image->getExt() . $suffix;
461 $thumb = System::baseUrl() . "/photo/" . $resource_id . "-5." . $Image->getExt() . $suffix;
462 $micro = System::baseUrl() . "/photo/" . $resource_id . "-6." . $Image->getExt() . $suffix;
464 // Remove the cached photo
466 $basepath = $a->getBasePath();
468 if (is_dir($basepath . "/photo")) {
469 $filename = $basepath . "/photo/" . $resource_id . "-4." . $Image->getExt();
470 if (file_exists($filename)) {
473 $filename = $basepath . "/photo/" . $resource_id . "-5." . $Image->getExt();
474 if (file_exists($filename)) {
477 $filename = $basepath . "/photo/" . $resource_id . "-6." . $Image->getExt();
478 if (file_exists($filename)) {
483 $photo_failure = true;
486 if ($photo_failure && $quit_on_error) {
490 if ($photo_failure) {
491 $image_url = System::baseUrl() . "/images/person-300.jpg";
492 $thumb = System::baseUrl() . "/images/person-80.jpg";
493 $micro = System::baseUrl() . "/images/person-48.jpg";
496 return [$image_url, $thumb, $micro];
500 * @param array $exifCoord coordinate
501 * @param string $hemi hemi
504 public static function getGps($exifCoord, $hemi)
506 $degrees = count($exifCoord) > 0 ? self::gps2Num($exifCoord[0]) : 0;
507 $minutes = count($exifCoord) > 1 ? self::gps2Num($exifCoord[1]) : 0;
508 $seconds = count($exifCoord) > 2 ? self::gps2Num($exifCoord[2]) : 0;
510 $flip = ($hemi == "W" || $hemi == "S") ? -1 : 1;
512 return floatval($flip * ($degrees + ($minutes / 60) + ($seconds / 3600)));
516 * @param string $coordPart coordPart
519 private static function gps2Num($coordPart)
521 $parts = explode("/", $coordPart);
523 if (count($parts) <= 0) {
527 if (count($parts) == 1) {
531 return floatval($parts[0]) / floatval($parts[1]);
535 * @brief Fetch the photo albums that are available for a viewer
537 * The query in this function is cost intensive, so it is cached.
539 * @param int $uid User id of the photos
540 * @param bool $update Update the cache
542 * @return array Returns array of the photo albums
543 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
545 public static function getAlbums($uid, $update = false)
547 $sql_extra = Security::getPermissionsSQLByUserId($uid);
549 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
550 $albums = Cache::get($key);
551 if (is_null($albums) || $update) {
552 if (!Config::get("system", "no_count", false)) {
553 /// @todo This query needs to be renewed. It is really slow
554 // At this time we just store the data in the cache
555 $albums = q("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
557 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra
558 GROUP BY `album` ORDER BY `created` DESC",
560 DBA::escape("Contact Photos"),
561 DBA::escape(L10n::t("Contact Photos"))
564 // This query doesn't do the count and is much faster
565 $albums = q("SELECT DISTINCT(`album`), '' AS `total`
566 FROM `photo` USE INDEX (`uid_album_scale_created`)
567 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra",
569 DBA::escape("Contact Photos"),
570 DBA::escape(L10n::t("Contact Photos"))
573 Cache::set($key, $albums, Cache::DAY);
579 * @param int $uid User id of the photos
583 public static function clearAlbumCache($uid)
585 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
586 Cache::set($key, null, Cache::DAY);
590 * Generate a unique photo ID.
595 public static function newResource()
597 return System::createGUID(32, false);
601 * Changes photo permissions that had been embedded in a post
603 * @todo This function currently does have some flaws:
604 * - Sharing a post with a forum will create a photo that only the forum can see.
605 * - Sharing a photo again that been shared non public before doesn't alter the permissions.
610 public static function setPermissionFromBody($body, $uid, $original_contact_id, $str_contact_allow, $str_group_allow, $str_contact_deny, $str_group_deny)
612 // Simplify image codes
613 $img_body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
614 $img_body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $img_body);
617 if (!preg_match_all("/\[img\](.*?)\[\/img\]/", $img_body, $match)) {
621 if (empty($images)) {
625 foreach ($images as $image) {
626 if (!stristr($image, System::baseUrl() . '/photo/')) {
629 $image_uri = substr($image,strrpos($image,'/') + 1);
630 $image_uri = substr($image_uri,0, strpos($image_uri,'-'));
631 if (!strlen($image_uri)) {
635 // Ensure to only modify photos that you own
636 $srch = '<' . intval($original_contact_id) . '>';
639 'allow_cid' => $srch, 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '',
640 'resource-id' => $image_uri, 'uid' => $uid
642 if (!Photo::exists($condition)) {
646 /// @todo Check if $str_contact_allow does contain a public forum. Then set the permissions to public.
648 $fields = ['allow_cid' => $str_contact_allow, 'allow_gid' => $str_group_allow,
649 'deny_cid' => $str_contact_deny, 'deny_gid' => $str_group_deny];
650 $condition = ['resource-id' => $image_uri, 'uid' => $uid];
651 Logger::info('Set permissions', ['condition' => $condition, 'permissions' => $fields]);
652 Photo::update($fields, $condition);
659 * Strips known picture extensions from picture links
661 * @param string $name Picture link
662 * @return string stripped picture link
665 public static function stripExtension($name)
667 $name = str_replace([".jpg", ".png", ".gif"], ["", "", ""], $name);
668 foreach (Images::supportedTypes() as $m => $e) {
669 $name = str_replace("." . $e, "", $name);
675 * Returns the GUID from picture links
677 * @param string $name Picture link
678 * @return string GUID
681 public static function getGUID($name)
684 $base = $a->getBaseURL();
686 $guid = str_replace([Strings::normaliseLink($base), '/photo/'], '', Strings::normaliseLink($name));
688 $guid = self::stripExtension($guid);
689 if (substr($guid, -2, 1) != "-") {
693 $scale = intval(substr($guid, -1, 1));
694 if (!is_numeric($scale)) {
698 $guid = substr($guid, 0, -2);
703 * Tests if the picture link points to a locally stored picture
705 * @param string $name Picture link
709 public static function isLocal($name)
711 $guid = self::getGUID($name);
717 return DBA::exists('photo', ['resource-id' => $guid]);
721 * Tests if the link points to a locally stored picture page
723 * @param string $name Page link
727 public static function isLocalPage($name)
730 $base = $a->getBaseURL();
732 $guid = str_replace(Strings::normaliseLink($base), '', Strings::normaliseLink($name));
733 $guid = preg_replace("=/photos/.*/image/(.*)=ism", '$1', $guid);
738 return DBA::exists('photo', ['resource-id' => $guid]);