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\System;
14 use Friendica\Core\StorageManager;
15 use Friendica\Database\DBA;
16 use Friendica\Database\DBStructure;
17 use Friendica\Object\Image;
18 use Friendica\Util\DateTimeFormat;
19 use Friendica\Util\Network;
20 use Friendica\Util\Security;
22 require_once "include/dba.php";
25 * Class to handle photo dabatase table
27 class Photo extends BaseObject
30 * @brief Select rows from the photo table
32 * @param array $fields Array of selected fields, empty for all
33 * @param array $conditions Array of fields for conditions
34 * @param array $params Array of several parameters
36 * @return boolean|array
38 * @see \Friendica\Database\DBA::select
40 public static function select(array $fields = [], array $conditions = [], array $params = [])
43 $selected = self::getFields();
46 $r = DBA::select("photo", $fields, $conditions, $params);
47 return DBA::toArray($r);
51 * @brief Retrieve a single record from the photo table
53 * @param array $fields Array of selected fields, empty for all
54 * @param array $conditions Array of fields for conditions
55 * @param array $params Array of several parameters
59 * @see \Friendica\Database\DBA::select
61 public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
64 $fields = self::getFields();
67 return DBA::selectFirst("photo", $fields, $conditions, $params);
71 * @brief Get photos for user id
73 * @param integer $uid User id
74 * @param string $resourceid Rescource ID of the photo
75 * @param array $conditions Array of fields for conditions
76 * @param array $params Array of several parameters
80 * @see \Friendica\Database\DBA::select
82 public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
84 $conditions["resource-id"] = $resourceid;
85 $conditions["uid"] = $uid;
87 return self::select([], $conditions, $params);
91 * @brief Get a photo for user id
93 * @param integer $uid User id
94 * @param string $resourceid Rescource ID of the photo
95 * @param integer $scale Scale of the photo. Defaults to 0
96 * @param array $conditions Array of fields for conditions
97 * @param array $params Array of several parameters
101 * @see \Friendica\Database\DBA::select
103 public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
105 $conditions["resource-id"] = $resourceid;
106 $conditions["uid"] = $uid;
107 $conditions["scale"] = $scale;
109 return self::selectFirst([], $conditions, $params);
113 * @brief Get a single photo given resource id and scale
115 * This method checks for permissions. Returns associative array
116 * on success, "no sign" image info, if user has no permission,
117 * false if photo does not exists
119 * @param string $resourceid Rescource ID of the photo
120 * @param integer $scale Scale of the photo. Defaults to 0
122 * @return boolean|array
124 public static function getPhoto($resourceid, $scale = 0)
126 $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
131 $sql_acl = Security::getPermissionsSQLByUserId($r["uid"]);
134 "`resource-id` = ? AND `scale` <= ? " . $sql_acl,
138 $params = ["order" => ["scale" => true]];
140 $photo = self::selectFirst([], $conditions, $params);
141 if ($photo === false) {
142 return self::createPhotoForSystemResource("images/nosign.jpg");
148 * @brief Check if photo with given resource id exists
150 * @param string $resourceid Resource ID of the photo
154 public static function exists($resourceid)
156 return DBA::count("photo", ["resource-id" => $resourceid]) > 0;
160 * @brief Get Image object for given row id. null if row id does not exist
162 * @param integer $id Row id
164 * @return \Friendica\Object\Image
166 public static function getImageForPhoto($photo)
169 if ($photo["backend-class"] == "") {
170 // legacy data storage in "data" column
171 $i = self::selectFirst(["data"], ["id" => $photo["id"]]);
177 $backendClass = $photo["backend-class"];
178 $backendRef = $photo["backend-ref"];
179 $data = $backendClass::get($backendRef);
185 return new Image($data, $photo["type"]);
189 * @brief Return a list of fields that are associated with the photo table
191 * @return array field list
193 private static function getFields()
195 $allfields = DBStructure::definition(false);
196 $fields = array_keys($allfields["photo"]["fields"]);
197 array_splice($fields, array_search("data", $fields), 1);
202 * @brief Construct a photo array for a system resource image
204 * @param string $filename Image file name relative to code root
205 * @param string $mimetype Image mime type. Defaults to "image/jpeg"
209 public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
211 $fields = self::getFields();
212 $values = array_fill(0, count($fields), "");
213 $photo = array_combine($fields, $values);
214 $photo["backend-class"] = \Friendica\Model\Storage\SystemResource::class;
215 $photo["backend-ref"] = $filename;
216 $photo["type"] = $mimetype;
217 $photo["cacheable"] = false;
223 * @brief store photo metadata in db and binary in default backend
225 * @param Image $Image Image object with data
226 * @param integer $uid User ID
227 * @param integer $cid Contact ID
228 * @param integer $rid Resource ID
229 * @param string $filename Filename
230 * @param string $album Album name
231 * @param integer $scale Scale
232 * @param integer $profile Is a profile image? optional, default = 0
233 * @param string $allow_cid Permissions, allowed contacts. optional, default = ""
234 * @param string $allow_gid Permissions, allowed groups. optional, default = ""
235 * @param string $deny_cid Permissions, denied contacts.optional, default = ""
236 * @param string $deny_gid Permissions, denied greoup.optional, default = ""
237 * @param string $desc Photo caption. optional, default = ""
239 * @return boolean True on success
241 public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
243 $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
244 if (DBA::isResult($photo)) {
245 $guid = $photo["guid"];
247 $guid = System::createGUID();
250 $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
251 $created = DateTimeFormat::utcNow();
252 if (DBA::isResult($existing_photo)) {
253 $created = $existing_photo["created"];
256 // Get defined storage backend.
257 // if no storage backend, we use old "data" column in photo table.
258 // if is an existing photo, reuse same backend
263 if (DBA::isResult($existing_photo)) {
264 $backend_ref = (string)$existing_photo["backend-ref"];
265 $backend_class = (string)$existing_photo["backend-class"];
267 $backend_class = StorageManager::getBackend();
269 if ($backend_class === "") {
270 $data = $Image->asString();
272 $backend_ref = $backend_class::put($Image->asString(), $backend_ref);
278 "contact-id" => $cid,
280 "resource-id" => $rid,
281 "created" => $created,
282 "edited" => DateTimeFormat::utcNow(),
283 "filename" => basename($filename),
284 "type" => $Image->getType(),
286 "height" => $Image->getHeight(),
287 "width" => $Image->getWidth(),
288 "datasize" => strlen($Image->asString()),
291 "profile" => $profile,
292 "allow_cid" => $allow_cid,
293 "allow_gid" => $allow_gid,
294 "deny_cid" => $deny_cid,
295 "deny_gid" => $deny_gid,
297 "backend-class" => $backend_class,
298 "backend-ref" => $backend_ref
301 if (DBA::isResult($existing_photo)) {
302 $r = DBA::update("photo", $fields, ["id" => $existing_photo["id"]]);
304 $r = DBA::insert("photo", $fields);
310 public static function delete(array $conditions, $options = [])
312 // get photo to delete data info
313 $photos = self::select(["backend-class","backend-ref"], $conditions);
315 foreach($photos as $photo) {
316 $backend_class = (string)$photo["backend-class"];
317 if ($backend_class !== "") {
318 $backend_class::delete($photo["backend-ref"]);
322 return DBA::delete("photo", $conditions, $options);
326 * @brief Update a photo
328 * @param array $fields Contains the fields that are updated
329 * @param array $conditions Condition array with the key values
330 * @param Image $img Image to update. Optional, default null.
331 * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
333 * @return boolean Was the update successfull?
335 * @see \Friendica\Database\DBA::update
337 public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
339 if (!is_null($img)) {
340 // get photo to update
341 $photos = self::select(["backend-class","backend-ref"], $conditions);
343 foreach($photos as $photo) {
344 $backend_class = (string)$photo["backend-class"];
345 if ($backend_class !== "") {
346 $fields["backend-ref"] = $backend_class::put($img->asString(), $photo["backend-ref"]);
348 $fields["data"] = $img->asString();
353 $fields['updated'] = DateTimeFormat::utcNow();
355 return DBA::update("photo", $fields, $conditions);
359 * @param string $image_url Remote URL
360 * @param integer $uid user id
361 * @param integer $cid contact id
362 * @param boolean $quit_on_error optional, default false
365 public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
370 $photo = DBA::selectFirst(
371 "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "album" => "Contact Photos"]
373 if (!empty($photo['resource-id'])) {
374 $hash = $photo["resource-id"];
376 $hash = self::newResource();
379 $photo_failure = false;
381 $filename = basename($image_url);
382 $img_str = Network::fetchUrl($image_url, true);
384 if ($quit_on_error && ($img_str == "")) {
388 $type = Image::guessType($image_url, true);
389 $Image = new Image($img_str, $type);
390 if ($Image->isValid()) {
391 $Image->scaleToSquare(300);
393 $r = self::store($Image, $uid, $cid, $hash, $filename, "Contact Photos", 4);
396 $photo_failure = true;
399 $Image->scaleDown(80);
401 $r = self::store($Image, $uid, $cid, $hash, $filename, "Contact Photos", 5);
404 $photo_failure = true;
407 $Image->scaleDown(48);
409 $r = self::store($Image, $uid, $cid, $hash, $filename, "Contact Photos", 6);
412 $photo_failure = true;
415 $suffix = "?ts=" . time();
417 $image_url = System::baseUrl() . "/photo/" . $hash . "-4." . $Image->getExt() . $suffix;
418 $thumb = System::baseUrl() . "/photo/" . $hash . "-5." . $Image->getExt() . $suffix;
419 $micro = System::baseUrl() . "/photo/" . $hash . "-6." . $Image->getExt() . $suffix;
421 // Remove the cached photo
423 $basepath = $a->getBasePath();
425 if (is_dir($basepath . "/photo")) {
426 $filename = $basepath . "/photo/" . $hash . "-4." . $Image->getExt();
427 if (file_exists($filename)) {
430 $filename = $basepath . "/photo/" . $hash . "-5." . $Image->getExt();
431 if (file_exists($filename)) {
434 $filename = $basepath . "/photo/" . $hash . "-6." . $Image->getExt();
435 if (file_exists($filename)) {
440 $photo_failure = true;
443 if ($photo_failure && $quit_on_error) {
447 if ($photo_failure) {
448 $image_url = System::baseUrl() . "/images/person-300.jpg";
449 $thumb = System::baseUrl() . "/images/person-80.jpg";
450 $micro = System::baseUrl() . "/images/person-48.jpg";
453 return [$image_url, $thumb, $micro];
457 * @param string $exifCoord coordinate
458 * @param string $hemi hemi
461 public static function getGps($exifCoord, $hemi)
463 $degrees = count($exifCoord) > 0 ? self::gps2Num($exifCoord[0]) : 0;
464 $minutes = count($exifCoord) > 1 ? self::gps2Num($exifCoord[1]) : 0;
465 $seconds = count($exifCoord) > 2 ? self::gps2Num($exifCoord[2]) : 0;
467 $flip = ($hemi == "W" || $hemi == "S") ? -1 : 1;
469 return floatval($flip * ($degrees + ($minutes / 60) + ($seconds / 3600)));
473 * @param string $coordPart coordPart
476 private static function gps2Num($coordPart)
478 $parts = explode("/", $coordPart);
480 if (count($parts) <= 0) {
484 if (count($parts) == 1) {
488 return floatval($parts[0]) / floatval($parts[1]);
492 * @brief Fetch the photo albums that are available for a viewer
494 * The query in this function is cost intensive, so it is cached.
496 * @param int $uid User id of the photos
497 * @param bool $update Update the cache
499 * @return array Returns array of the photo albums
501 public static function getAlbums($uid, $update = false)
503 $sql_extra = Security::getPermissionsSQLByUserId($uid);
505 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
506 $albums = Cache::get($key);
507 if (is_null($albums) || $update) {
508 if (!Config::get("system", "no_count", false)) {
509 /// @todo This query needs to be renewed. It is really slow
510 // At this time we just store the data in the cache
511 $albums = q("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
513 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra
514 GROUP BY `album` ORDER BY `created` DESC",
516 DBA::escape("Contact Photos"),
517 DBA::escape(L10n::t("Contact Photos"))
520 // This query doesn't do the count and is much faster
521 $albums = q("SELECT DISTINCT(`album`), '' AS `total`
522 FROM `photo` USE INDEX (`uid_album_scale_created`)
523 WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra",
525 DBA::escape("Contact Photos"),
526 DBA::escape(L10n::t("Contact Photos"))
529 Cache::set($key, $albums, Cache::DAY);
535 * @param int $uid User id of the photos
538 public static function clearAlbumCache($uid)
540 $key = "photo_albums:".$uid.":".local_user().":".remote_user();
541 Cache::set($key, null, Cache::DAY);
545 * Generate a unique photo ID.
549 public static function newResource()
551 return System::createGUID(32, false);