*/
namespace Friendica\Model;
+use Friendica\BaseObject;
use Friendica\Core\Cache;
use Friendica\Core\Config;
use Friendica\Core\L10n;
use Friendica\Core\System;
-use Friendica\Database\DBM;
+use Friendica\Core\StorageManager;
+use Friendica\Database\DBA;
+use Friendica\Database\DBStructure;
+use Friendica\Model\Storage\IStorage;
use Friendica\Object\Image;
+use Friendica\Util\DateTimeFormat;
use Friendica\Util\Network;
-use Friendica\Util\Temporal;
-use dba;
+use Friendica\Util\Security;
-require_once 'include/dba.php';
+require_once "include/dba.php";
/**
* Class to handle photo dabatase table
*/
-class Photo
+class Photo extends BaseObject
{
/**
- * @param Image $Image image
- * @param integer $uid uid
- * @param integer $cid cid
- * @param integer $rid rid
- * @param string $filename filename
- * @param string $album album name
- * @param integer $scale scale
- * @param integer $profile optional, default = 0
- * @param string $allow_cid optional, default = ''
- * @param string $allow_gid optional, default = ''
- * @param string $deny_cid optional, default = ''
- * @param string $deny_gid optional, default = ''
- * @param string $desc optional, default = ''
- * @return object
+ * @brief Select rows from the photo table
+ *
+ * @param array $fields Array of selected fields, empty for all
+ * @param array $conditions Array of fields for conditions
+ * @param array $params Array of several parameters
+ *
+ * @return boolean|array
+ *
+ * @throws \Exception
+ * @see \Friendica\Database\DBA::select
+ */
+ public static function select(array $fields = [], array $conditions = [], array $params = [])
+ {
+ if (empty($fields)) {
+ $fields = self::getFields();
+ }
+
+ $r = DBA::select("photo", $fields, $conditions, $params);
+ return DBA::toArray($r);
+ }
+
+ /**
+ * @brief Retrieve a single record from the photo table
+ *
+ * @param array $fields Array of selected fields, empty for all
+ * @param array $conditions Array of fields for conditions
+ * @param array $params Array of several parameters
+ *
+ * @return bool|array
+ *
+ * @throws \Exception
+ * @see \Friendica\Database\DBA::select
+ */
+ public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
+ {
+ if (empty($fields)) {
+ $fields = self::getFields();
+ }
+
+ return DBA::selectFirst("photo", $fields, $conditions, $params);
+ }
+
+ /**
+ * @brief Get photos for user id
+ *
+ * @param integer $uid User id
+ * @param string $resourceid Rescource ID of the photo
+ * @param array $conditions Array of fields for conditions
+ * @param array $params Array of several parameters
+ *
+ * @return bool|array
+ *
+ * @throws \Exception
+ * @see \Friendica\Database\DBA::select
+ */
+ public static function getPhotosForUser($uid, $resourceid, array $conditions = [], array $params = [])
+ {
+ $conditions["resource-id"] = $resourceid;
+ $conditions["uid"] = $uid;
+
+ return self::select([], $conditions, $params);
+ }
+
+ /**
+ * @brief Get a photo for user id
+ *
+ * @param integer $uid User id
+ * @param string $resourceid Rescource ID of the photo
+ * @param integer $scale Scale of the photo. Defaults to 0
+ * @param array $conditions Array of fields for conditions
+ * @param array $params Array of several parameters
+ *
+ * @return bool|array
+ *
+ * @throws \Exception
+ * @see \Friendica\Database\DBA::select
+ */
+ public static function getPhotoForUser($uid, $resourceid, $scale = 0, array $conditions = [], array $params = [])
+ {
+ $conditions["resource-id"] = $resourceid;
+ $conditions["uid"] = $uid;
+ $conditions["scale"] = $scale;
+
+ return self::selectFirst([], $conditions, $params);
+ }
+
+ /**
+ * @brief Get a single photo given resource id and scale
+ *
+ * This method checks for permissions. Returns associative array
+ * on success, "no sign" image info, if user has no permission,
+ * false if photo does not exists
+ *
+ * @param string $resourceid Rescource ID of the photo
+ * @param integer $scale Scale of the photo. Defaults to 0
+ *
+ * @return boolean|array
+ * @throws \Exception
+ */
+ public static function getPhoto($resourceid, $scale = 0)
+ {
+ $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]);
+ if ($r === false) {
+ return false;
+ }
+
+ $sql_acl = Security::getPermissionsSQLByUserId($r["uid"]);
+
+ $conditions = [
+ "`resource-id` = ? AND `scale` <= ? " . $sql_acl,
+ $resourceid, $scale
+ ];
+
+ $params = ["order" => ["scale" => true]];
+
+ $photo = self::selectFirst([], $conditions, $params);
+
+ return $photo;
+ }
+
+ /**
+ * @brief Check if photo with given conditions exists
+ *
+ * @param array $conditions Array of extra conditions
+ *
+ * @return boolean
+ * @throws \Exception
+ */
+ public static function exists(array $conditions)
+ {
+ return DBA::exists("photo", $conditions);
+ }
+
+
+ /**
+ * @brief Get Image object for given row id. null if row id does not exist
+ *
+ * @param array $photo Photo data. Needs at least 'id', 'type', 'backend-class', 'backend-ref'
+ *
+ * @return \Friendica\Object\Image
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
+ */
+ public static function getImageForPhoto(array $photo)
+ {
+ if ($photo["backend-class"] == "") {
+ // legacy data storage in "data" column
+ $i = self::selectFirst(["data"], ["id" => $photo["id"]]);
+ if ($i === false) {
+ return null;
+ }
+ $data = $i["data"];
+ } else {
+ $backendClass = $photo["backend-class"];
+ $backendRef = $photo["backend-ref"];
+ $data = $backendClass::get($backendRef);
+ }
+
+ if ($data === "") {
+ return null;
+ }
+ return new Image($data, $photo["type"]);
+ }
+
+ /**
+ * @brief Return a list of fields that are associated with the photo table
+ *
+ * @return array field list
+ * @throws \Exception
+ */
+ private static function getFields()
+ {
+ $allfields = DBStructure::definition(false);
+ $fields = array_keys($allfields["photo"]["fields"]);
+ array_splice($fields, array_search("data", $fields), 1);
+ return $fields;
+ }
+
+ /**
+ * @brief Construct a photo array for a system resource image
+ *
+ * @param string $filename Image file name relative to code root
+ * @param string $mimetype Image mime type. Defaults to "image/jpeg"
+ *
+ * @return array
+ * @throws \Exception
*/
- public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '', $desc = '')
+ public static function createPhotoForSystemResource($filename, $mimetype = "image/jpeg")
{
- $photo = dba::selectFirst('photo', ['guid'], ["`resource-id` = ? AND `guid` != ?", $rid, '']);
- if (DBM::is_result($photo)) {
- $guid = $photo['guid'];
+ $fields = self::getFields();
+ $values = array_fill(0, count($fields), "");
+ $photo = array_combine($fields, $values);
+ $photo["backend-class"] = Storage\SystemResource::class;
+ $photo["backend-ref"] = $filename;
+ $photo["type"] = $mimetype;
+ $photo["cacheable"] = false;
+ return $photo;
+ }
+
+
+ /**
+ * @brief store photo metadata in db and binary in default backend
+ *
+ * @param Image $Image Image object with data
+ * @param integer $uid User ID
+ * @param integer $cid Contact ID
+ * @param integer $rid Resource ID
+ * @param string $filename Filename
+ * @param string $album Album name
+ * @param integer $scale Scale
+ * @param integer $profile Is a profile image? optional, default = 0
+ * @param string $allow_cid Permissions, allowed contacts. optional, default = ""
+ * @param string $allow_gid Permissions, allowed groups. optional, default = ""
+ * @param string $deny_cid Permissions, denied contacts.optional, default = ""
+ * @param string $deny_gid Permissions, denied greoup.optional, default = ""
+ * @param string $desc Photo caption. optional, default = ""
+ *
+ * @return boolean True on success
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ */
+ public static function store(Image $Image, $uid, $cid, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = "", $allow_gid = "", $deny_cid = "", $deny_gid = "", $desc = "")
+ {
+ $photo = self::selectFirst(["guid"], ["`resource-id` = ? AND `guid` != ?", $rid, ""]);
+ if (DBA::isResult($photo)) {
+ $guid = $photo["guid"];
+ } else {
+ $guid = System::createGUID();
+ }
+
+ $existing_photo = self::selectFirst(["id", "created", "backend-class", "backend-ref"], ["resource-id" => $rid, "uid" => $uid, "contact-id" => $cid, "scale" => $scale]);
+ $created = DateTimeFormat::utcNow();
+ if (DBA::isResult($existing_photo)) {
+ $created = $existing_photo["created"];
+ }
+
+ // Get defined storage backend.
+ // if no storage backend, we use old "data" column in photo table.
+ // if is an existing photo, reuse same backend
+ $data = "";
+ $backend_ref = "";
+
+ /** @var IStorage $backend_class */
+ if (DBA::isResult($existing_photo)) {
+ $backend_ref = (string)$existing_photo["backend-ref"];
+ $backend_class = (string)$existing_photo["backend-class"];
+ } else {
+ $backend_class = StorageManager::getBackend();
+ }
+
+ if ($backend_class === "") {
+ $data = $Image->asString();
} else {
- $guid = get_guid();
+ $backend_ref = $backend_class::put($Image->asString(), $backend_ref);
}
- $existing_photo = dba::selectFirst('photo', ['id'], ['resource-id' => $rid, 'uid' => $uid, 'contact-id' => $cid, 'scale' => $scale]);
$fields = [
- 'uid' => $uid,
- 'contact-id' => $cid,
- 'guid' => $guid,
- 'resource-id' => $rid,
- 'created' => Temporal::convert(),
- 'edited' => Temporal::convert(),
- 'filename' => basename($filename),
- 'type' => $Image->getType(),
- 'album' => $album,
- 'height' => $Image->getHeight(),
- 'width' => $Image->getWidth(),
- 'datasize' => strlen($Image->asString()),
- 'data' => $Image->asString(),
- 'scale' => $scale,
- 'profile' => $profile,
- 'allow_cid' => $allow_cid,
- 'allow_gid' => $allow_gid,
- 'deny_cid' => $deny_cid,
- 'deny_gid' => $deny_gid,
- 'desc' => $desc
+ "uid" => $uid,
+ "contact-id" => $cid,
+ "guid" => $guid,
+ "resource-id" => $rid,
+ "created" => $created,
+ "edited" => DateTimeFormat::utcNow(),
+ "filename" => basename($filename),
+ "type" => $Image->getType(),
+ "album" => $album,
+ "height" => $Image->getHeight(),
+ "width" => $Image->getWidth(),
+ "datasize" => strlen($Image->asString()),
+ "data" => $data,
+ "scale" => $scale,
+ "profile" => $profile,
+ "allow_cid" => $allow_cid,
+ "allow_gid" => $allow_gid,
+ "deny_cid" => $deny_cid,
+ "deny_gid" => $deny_gid,
+ "desc" => $desc,
+ "backend-class" => $backend_class,
+ "backend-ref" => $backend_ref
];
- if (DBM::is_result($existing_photo)) {
- $r = dba::update('photo', $fields, ['id' => $existing_photo['id']]);
+ if (DBA::isResult($existing_photo)) {
+ $r = DBA::update("photo", $fields, ["id" => $existing_photo["id"]]);
} else {
- $r = dba::insert('photo', $fields);
+ $r = DBA::insert("photo", $fields);
}
return $r;
}
+
+ /**
+ * @brief Delete info from table and data from storage
+ *
+ * @param array $conditions Field condition(s)
+ * @param array $options Options array, Optional
+ *
+ * @return boolean
+ *
+ * @throws \Exception
+ * @see \Friendica\Database\DBA::delete
+ */
+ public static function delete(array $conditions, array $options = [])
+ {
+ // get photo to delete data info
+ $photos = self::select(["backend-class","backend-ref"], $conditions);
+
+ foreach($photos as $photo) {
+ /** @var IStorage $backend_class */
+ $backend_class = (string)$photo["backend-class"];
+ if ($backend_class !== "") {
+ $backend_class::delete($photo["backend-ref"]);
+ }
+ }
+
+ return DBA::delete("photo", $conditions, $options);
+ }
+
+ /**
+ * @brief Update a photo
+ *
+ * @param array $fields Contains the fields that are updated
+ * @param array $conditions Condition array with the key values
+ * @param Image $img Image to update. Optional, default null.
+ * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
+ *
+ * @return boolean Was the update successfull?
+ *
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @see \Friendica\Database\DBA::update
+ */
+ public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
+ {
+ if (!is_null($img)) {
+ // get photo to update
+ $photos = self::select(["backend-class","backend-ref"], $conditions);
+
+ foreach($photos as $photo) {
+ /** @var IStorage $backend_class */
+ $backend_class = (string)$photo["backend-class"];
+ if ($backend_class !== "") {
+ $fields["backend-ref"] = $backend_class::put($img->asString(), $photo["backend-ref"]);
+ } else {
+ $fields["data"] = $img->asString();
+ }
+ }
+ $fields['updated'] = DateTimeFormat::utcNow();
+ }
+
+ $fields['edited'] = DateTimeFormat::utcNow();
+
+ return DBA::update("photo", $fields, $conditions, $old_fields);
+ }
+
/**
* @param string $image_url Remote URL
* @param integer $uid user id
* @param integer $cid contact id
* @param boolean $quit_on_error optional, default false
* @return array
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function importProfilePhoto($image_url, $uid, $cid, $quit_on_error = false)
{
- $photo = dba::selectFirst(
- 'photo', ['resource-id'], ['uid' => $uid, 'contact-id' => $cid, 'scale' => 4, 'album' => 'Contact Photos']
+ $thumb = "";
+ $micro = "";
+
+ $photo = DBA::selectFirst(
+ "photo", ["resource-id"], ["uid" => $uid, "contact-id" => $cid, "scale" => 4, "album" => "Contact Photos"]
);
- if (x($photo['resource-id'])) {
- $hash = $photo['resource-id'];
+ if (!empty($photo['resource-id'])) {
+ $hash = $photo["resource-id"];
} else {
- $hash = photo_new_resource();
+ $hash = self::newResource();
}
$photo_failure = false;
$type = Image::guessType($image_url, true);
$Image = new Image($img_str, $type);
if ($Image->isValid()) {
- $Image->scaleToSquare(175);
+ $Image->scaleToSquare(300);
- $r = self::store($Image, $uid, $cid, $hash, $filename, 'Contact Photos', 4);
+ $r = self::store($Image, $uid, $cid, $hash, $filename, "Contact Photos", 4);
if ($r === false) {
$photo_failure = true;
$Image->scaleDown(80);
- $r = self::store($Image, $uid, $cid, $hash, $filename, 'Contact Photos', 5);
+ $r = self::store($Image, $uid, $cid, $hash, $filename, "Contact Photos", 5);
if ($r === false) {
$photo_failure = true;
$Image->scaleDown(48);
- $r = self::store($Image, $uid, $cid, $hash, $filename, 'Contact Photos', 6);
+ $r = self::store($Image, $uid, $cid, $hash, $filename, "Contact Photos", 6);
if ($r === false) {
$photo_failure = true;
}
- $suffix = '?ts=' . time();
+ $suffix = "?ts=" . time();
- $image_url = System::baseUrl() . '/photo/' . $hash . '-4.' . $Image->getExt() . $suffix;
- $thumb = System::baseUrl() . '/photo/' . $hash . '-5.' . $Image->getExt() . $suffix;
- $micro = System::baseUrl() . '/photo/' . $hash . '-6.' . $Image->getExt() . $suffix;
+ $image_url = System::baseUrl() . "/photo/" . $hash . "-4." . $Image->getExt() . $suffix;
+ $thumb = System::baseUrl() . "/photo/" . $hash . "-5." . $Image->getExt() . $suffix;
+ $micro = System::baseUrl() . "/photo/" . $hash . "-6." . $Image->getExt() . $suffix;
// Remove the cached photo
- $a = get_app();
- $basepath = $a->get_basepath();
+ $a = \get_app();
+ $basepath = $a->getBasePath();
if (is_dir($basepath . "/photo")) {
- $filename = $basepath . '/photo/' . $hash . '-4.' . $Image->getExt();
+ $filename = $basepath . "/photo/" . $hash . "-4." . $Image->getExt();
if (file_exists($filename)) {
unlink($filename);
}
- $filename = $basepath . '/photo/' . $hash . '-5.' . $Image->getExt();
+ $filename = $basepath . "/photo/" . $hash . "-5." . $Image->getExt();
if (file_exists($filename)) {
unlink($filename);
}
- $filename = $basepath . '/photo/' . $hash . '-6.' . $Image->getExt();
+ $filename = $basepath . "/photo/" . $hash . "-6." . $Image->getExt();
if (file_exists($filename)) {
unlink($filename);
}
}
if ($photo_failure) {
- $image_url = System::baseUrl() . '/images/person-175.jpg';
- $thumb = System::baseUrl() . '/images/person-80.jpg';
- $micro = System::baseUrl() . '/images/person-48.jpg';
+ $image_url = System::baseUrl() . "/images/person-300.jpg";
+ $thumb = System::baseUrl() . "/images/person-80.jpg";
+ $micro = System::baseUrl() . "/images/person-48.jpg";
}
return [$image_url, $thumb, $micro];
}
/**
- * @param string $exifCoord coordinate
+ * @param array $exifCoord coordinate
* @param string $hemi hemi
* @return float
*/
$minutes = count($exifCoord) > 1 ? self::gps2Num($exifCoord[1]) : 0;
$seconds = count($exifCoord) > 2 ? self::gps2Num($exifCoord[2]) : 0;
- $flip = ($hemi == 'W' || $hemi == 'S') ? -1 : 1;
+ $flip = ($hemi == "W" || $hemi == "S") ? -1 : 1;
return floatval($flip * ($degrees + ($minutes / 60) + ($seconds / 3600)));
}
*/
private static function gps2Num($coordPart)
{
- $parts = explode('/', $coordPart);
+ $parts = explode("/", $coordPart);
if (count($parts) <= 0) {
return 0;
* @param bool $update Update the cache
*
* @return array Returns array of the photo albums
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function getAlbums($uid, $update = false)
{
- $sql_extra = permissions_sql($uid);
+ $sql_extra = Security::getPermissionsSQLByUserId($uid);
$key = "photo_albums:".$uid.":".local_user().":".remote_user();
$albums = Cache::get($key);
if (is_null($albums) || $update) {
- if (!Config::get('system', 'no_count', false)) {
+ if (!Config::get("system", "no_count", false)) {
/// @todo This query needs to be renewed. It is really slow
// At this time we just store the data in the cache
$albums = q("SELECT COUNT(DISTINCT `resource-id`) AS `total`, `album`, ANY_VALUE(`created`) AS `created`
WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra
GROUP BY `album` ORDER BY `created` DESC",
intval($uid),
- dbesc('Contact Photos'),
- dbesc(L10n::t('Contact Photos'))
+ DBA::escape("Contact Photos"),
+ DBA::escape(L10n::t("Contact Photos"))
);
} else {
// This query doesn't do the count and is much faster
FROM `photo` USE INDEX (`uid_album_scale_created`)
WHERE `uid` = %d AND `album` != '%s' AND `album` != '%s' $sql_extra",
intval($uid),
- dbesc('Contact Photos'),
- dbesc(L10n::t('Contact Photos'))
+ DBA::escape("Contact Photos"),
+ DBA::escape(L10n::t("Contact Photos"))
);
}
- Cache::set($key, $albums, CACHE_DAY);
+ Cache::set($key, $albums, Cache::DAY);
}
return $albums;
}
/**
* @param int $uid User id of the photos
* @return void
+ * @throws \Exception
*/
public static function clearAlbumCache($uid)
{
$key = "photo_albums:".$uid.":".local_user().":".remote_user();
- Cache::set($key, null, CACHE_DAY);
+ Cache::set($key, null, Cache::DAY);
+ }
+
+ /**
+ * Generate a unique photo ID.
+ *
+ * @return string
+ * @throws \Exception
+ */
+ public static function newResource()
+ {
+ return System::createGUID(32, false);
}
}