friendica/src/Module/Photo.php

343 lines
11 KiB
PHP
Raw Normal View History

2018-11-20 21:33:35 +00:00
<?php
/**
2021-03-29 06:40:20 +00:00
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
2018-11-20 21:33:35 +00:00
*/
namespace Friendica\Module;
use Friendica\BaseModule;
use Friendica\Core\Logger;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Contact;
2018-11-20 21:33:35 +00:00
use Friendica\Model\Photo as MPhoto;
use Friendica\Model\Post;
2021-07-01 18:05:54 +00:00
use Friendica\Model\Profile;
use Friendica\Model\Storage\ExternalResource;
2021-06-30 04:28:03 +00:00
use Friendica\Model\Storage\SystemResource;
use Friendica\Model\User;
use Friendica\Network\HTTPException;
2020-12-26 21:24:36 +00:00
use Friendica\Object\Image;
use Friendica\Util\Images;
2021-07-03 15:29:27 +00:00
use Friendica\Util\Network;
use Friendica\Util\Proxy;
2018-11-20 21:33:35 +00:00
/**
2020-01-19 06:05:23 +00:00
* Photo Module
2018-11-20 21:33:35 +00:00
*/
class Photo extends BaseModule
{
/**
2020-01-19 06:05:23 +00:00
* Module initializer
2018-11-20 21:33:35 +00:00
*
* Fetch a photo or an avatar, in optional size, check for permissions and
* return the image
*/
2020-12-26 18:51:36 +00:00
public static function rawContent(array $parameters = [])
2018-11-20 21:33:35 +00:00
{
2020-12-26 18:51:36 +00:00
$totalstamp = microtime(true);
2018-11-20 21:33:35 +00:00
2018-11-21 14:10:47 +00:00
if (isset($_SERVER["HTTP_IF_MODIFIED_SINCE"])) {
header("HTTP/1.1 304 Not Modified");
2018-11-20 21:33:35 +00:00
header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
2018-11-21 14:10:47 +00:00
if (!empty($_SERVER["HTTP_IF_NONE_MATCH"])) {
header("Etag: " . $_SERVER["HTTP_IF_NONE_MATCH"]);
2018-11-20 21:33:35 +00:00
}
header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
header("Cache-Control: max-age=31536000");
2018-11-21 14:10:47 +00:00
if (function_exists("header_remove")) {
header_remove("Last-Modified");
header_remove("Expires");
header_remove("Cache-Control");
2018-11-20 21:33:35 +00:00
}
exit;
}
2021-07-03 15:29:27 +00:00
Profile::addVisitorCookieForHTTPSigner();
2021-07-01 18:05:54 +00:00
2018-11-20 21:33:35 +00:00
$customsize = 0;
2021-06-28 19:38:03 +00:00
$square_resize = true;
2020-12-26 18:51:36 +00:00
$scale = null;
$stamp = microtime(true);
// User avatar
if (!empty($parameters['type'])) {
if (!empty($parameters['customsize'])) {
$customsize = intval($parameters['customsize']);
$square_resize = !in_array($parameters['type'], ['media', 'preview']);
}
if (!empty($parameters['nickname_ext'])) {
2021-10-04 06:13:52 +00:00
if (in_array($parameters['type'], ['contact', 'header'])) {
$guid = pathinfo($parameters['nickname_ext'], PATHINFO_FILENAME);
$account = DBA::selectFirst('account-user-view', ['id'], ['guid' => $guid], ['order' => ['uid' => true]]);
if (empty($account)) {
throw new HTTPException\NotFoundException();
}
$id = $account['id'];
} else {
$nickname = pathinfo($parameters['nickname_ext'], PATHINFO_FILENAME);
$user = User::getByNickname($nickname, ['uid']);
if (empty($user)) {
throw new HTTPException\NotFoundException();
}
2021-10-04 06:13:52 +00:00
$id = $user['uid'];
}
}
// User Id Fallback, to remove after version 2021.12
if (!empty($parameters['uid_ext'])) {
2021-10-04 06:13:52 +00:00
$id = intval(pathinfo($parameters['uid_ext'], PATHINFO_FILENAME));
}
// Please refactor this for the love of everything that's good
if (isset($parameters['id'])) {
2021-10-04 06:13:52 +00:00
$id = $parameters['id'];
}
if (empty($id)) {
Logger::notice('No picture id was detected', ['parameters' => $parameters]);
throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo is not available.'));
}
2021-10-04 06:13:52 +00:00
$photo = self::getPhotoByid($id, $parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
} else {
$photoid = pathinfo($parameters['name'], PATHINFO_FILENAME);
2021-06-24 07:08:38 +00:00
$scale = 0;
if (substr($photoid, -2, 1) == "-") {
$scale = intval(substr($photoid, -1, 1));
$photoid = substr($photoid, 0, -2);
}
$photo = MPhoto::getPhoto($photoid, $scale);
if ($photo === false) {
throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo with id %s is not available.', $photoid));
2021-06-24 07:08:38 +00:00
}
2018-11-20 21:33:35 +00:00
}
2020-12-26 18:51:36 +00:00
$fetch = microtime(true) - $stamp;
2018-11-20 21:33:35 +00:00
2018-11-21 15:37:32 +00:00
if ($photo === false) {
throw new HTTPException\NotFoundException();
2018-11-20 21:33:35 +00:00
}
2018-11-21 14:12:11 +00:00
$cacheable = ($photo["allow_cid"] . $photo["allow_gid"] . $photo["deny_cid"] . $photo["deny_gid"] === "") && (isset($photo["cacheable"]) ? $photo["cacheable"] : true);
2018-11-20 21:33:35 +00:00
2020-12-26 18:51:36 +00:00
$stamp = microtime(true);
2020-12-26 19:31:39 +00:00
$imgdata = MPhoto::getImageDataForPhoto($photo);
if (empty($imgdata)) {
throw new HTTPException\NotFoundException();
}
2021-06-30 04:28:03 +00:00
// The mimetype for an external or system resource can only be known reliably after it had been fetched
if (in_array($photo['backend-class'], [ExternalResource::NAME, SystemResource::NAME])) {
$mimetype = Images::getMimeTypeByData($imgdata);
if (!empty($mimetype)) {
$photo['type'] = $mimetype;
}
}
2020-12-26 18:51:36 +00:00
$data = microtime(true) - $stamp;
2018-11-20 21:33:35 +00:00
2020-12-26 19:31:39 +00:00
if (empty($imgdata)) {
Logger::warning('Invalid photo', ['id' => $photo['id']]);
if (in_array($photo['backend-class'], [ExternalResource::NAME])) {
$reference = json_decode($photo['backend-ref'], true);
$error = DI::l10n()->t('Invalid external resource with url %s.', $reference['url']);
} else {
$error = DI::l10n()->t('Invalid photo with id %s.', $photo['id']);
}
throw new HTTPException\InternalServerErrorException($error);
2018-11-20 21:33:35 +00:00
}
// if customsize is set and image is not a gif, resize it
2021-06-28 19:38:03 +00:00
if ($photo['type'] !== "image/gif" && $customsize > 0 && $customsize <= Proxy::PIXEL_THUMB && $square_resize) {
2020-12-26 21:24:36 +00:00
$img = new Image($imgdata, $photo['type']);
2018-11-20 21:33:35 +00:00
$img->scaleToSquare($customsize);
2020-12-26 19:31:39 +00:00
$imgdata = $img->asString();
2021-06-28 19:38:03 +00:00
} elseif ($photo['type'] !== "image/gif" && $customsize > 0) {
$img = new Image($imgdata, $photo['type']);
$img->scaleDown($customsize);
$imgdata = $img->asString();
2018-11-20 21:33:35 +00:00
}
2018-11-21 14:10:47 +00:00
if (function_exists("header_remove")) {
header_remove("Pragma");
header_remove("pragma");
2018-11-20 21:33:35 +00:00
}
2020-12-26 19:31:39 +00:00
header("Content-type: " . $photo['type']);
2018-11-20 21:33:35 +00:00
2020-12-26 18:51:36 +00:00
$stamp = microtime(true);
2018-11-20 21:33:35 +00:00
if (!$cacheable) {
// it is a private photo that they have no permission to view.
// tell the browser not to cache it, in case they authenticate
// and subsequently have permission to see it
header("Cache-Control: no-store, no-cache, must-revalidate");
} else {
2020-12-26 19:31:39 +00:00
$md5 = $photo['hash'] ?: md5($imgdata);
2018-11-20 21:33:35 +00:00
header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
2018-11-21 14:10:47 +00:00
header("Etag: \"{$md5}\"");
2018-11-20 21:33:35 +00:00
header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
header("Cache-Control: max-age=31536000");
}
2020-12-26 18:51:36 +00:00
$checksum = microtime(true) - $stamp;
2018-11-20 21:33:35 +00:00
2020-12-26 18:51:36 +00:00
$stamp = microtime(true);
2020-12-26 19:31:39 +00:00
echo $imgdata;
2020-12-26 18:51:36 +00:00
$output = microtime(true) - $stamp;
$total = microtime(true) - $totalstamp;
$rest = $total - ($fetch + $data + $checksum + $output);
if (!is_null($scale) && ($scale < 4)) {
Logger::info('Performance:', ['scale' => $scale, 'resource' => $photo['resource-id'],
'total' => number_format($total, 3), 'fetch' => number_format($fetch, 3),
'data' => number_format($data, 3), 'checksum' => number_format($checksum, 3),
'output' => number_format($output, 3), 'rest' => number_format($rest, 3)]);
}
2018-11-20 21:33:35 +00:00
2018-12-26 05:40:12 +00:00
exit();
2018-11-20 21:33:35 +00:00
}
2021-10-04 06:13:52 +00:00
private static function getPhotoByid(int $id, $type, $customsize)
2018-11-20 21:33:35 +00:00
{
switch($type) {
case "preview":
2021-10-04 06:13:52 +00:00
$media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $id]);
if (empty($media)) {
return false;
}
$url = $media['preview'];
if (empty($url) && ($media['type'] == Post\Media::IMAGE)) {
$url = $media['url'];
}
if (empty($url)) {
return false;
}
2021-07-03 15:29:27 +00:00
if (Network::isLocalLink($url) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $url, $matches)) {
return MPhoto::getPhoto($matches[1], $matches[2]);
}
2021-10-04 06:13:52 +00:00
2021-07-05 18:45:49 +00:00
return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']);
case "media":
2021-10-04 06:13:52 +00:00
$media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $id, 'type' => Post\Media::IMAGE]);
2021-06-28 04:53:20 +00:00
if (empty($media)) {
return false;
}
2021-07-03 15:29:27 +00:00
if (Network::isLocalLink($media['url']) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $media['url'], $matches)) {
return MPhoto::getPhoto($matches[1], $matches[2]);
}
2021-07-05 18:45:49 +00:00
return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']);
case "link":
2021-10-04 06:13:52 +00:00
$link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $id]);
2021-07-05 18:45:49 +00:00
if (empty($link)) {
return false;
}
return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']);
2021-06-28 01:34:29 +00:00
case "contact":
2021-10-04 06:13:52 +00:00
$contact = Contact::getById($id, ['uid', 'url', 'avatar', 'photo', 'xmpp', 'addr']);
2021-06-24 07:08:38 +00:00
if (empty($contact)) {
return false;
}
If (($contact['uid'] != 0) && empty($contact['photo']) && empty($contact['avatar'])) {
$contact = Contact::getByURL($contact['url'], false, ['avatar', 'photo', 'xmpp', 'addr']);
2021-06-24 07:08:38 +00:00
}
if (!empty($contact['photo']) && !empty($contact['avatar'])) {
2021-06-29 20:26:58 +00:00
// Fetch photo directly
$resourceid = MPhoto::ridFromURI($contact['photo']);
if (!empty($resourceid)) {
$photo = MPhoto::selectFirst([], ['resource-id' => $resourceid], ['order' => ['scale']]);
if (!empty($photo)) {
return $photo;
}
}
// We continue with the avatar link when the photo link is invalid
$url = $contact['avatar'];
2021-06-24 07:08:38 +00:00
} elseif (!empty($contact['avatar'])) {
$url = $contact['avatar'];
} elseif ($customsize <= Proxy::PIXEL_MICRO) {
$url = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
} elseif ($customsize <= Proxy::PIXEL_THUMB) {
$url = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
2021-06-24 07:08:38 +00:00
} else {
$url = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
2021-06-24 07:08:38 +00:00
}
2021-06-28 13:58:06 +00:00
return MPhoto::createPhotoForExternalResource($url);
2021-06-24 07:08:38 +00:00
case "header":
2021-10-04 06:13:52 +00:00
$contact = Contact::getById($id, ['uid', 'url', 'header']);
2021-06-24 07:08:38 +00:00
if (empty($contact)) {
return false;
}
If (($contact['uid'] != 0) && empty($contact['header'])) {
$contact = Contact::getByURL($contact['url'], false, ['header']);
}
if (!empty($contact['header'])) {
$url = $contact['header'];
} else {
$url = DI::baseUrl() . '/images/blank.png';
}
2021-06-28 13:58:06 +00:00
return MPhoto::createPhotoForExternalResource($url);
case "profile":
case "custom":
$scale = 4;
break;
case "micro":
$scale = 6;
break;
case "avatar":
default:
$scale = 5;
2018-11-20 21:33:35 +00:00
}
2021-10-04 06:13:52 +00:00
$photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $id, "profile" => 1]);
if (empty($photo)) {
2021-10-04 06:13:52 +00:00
$contact = DBA::selectFirst('contact', [], ['uid' => $id, 'self' => true]) ?: [];
switch($type) {
case "profile":
case "custom":
$default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
break;
case "micro":
$default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
break;
case "avatar":
default:
$default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
}
2021-06-24 17:30:22 +00:00
$parts = parse_url($default);
if (!empty($parts['scheme']) || !empty($parts['host'])) {
2021-06-28 13:58:06 +00:00
$photo = MPhoto::createPhotoForExternalResource($default);
2021-06-24 17:30:22 +00:00
} else {
$photo = MPhoto::createPhotoForSystemResource($default);
}
2018-11-20 21:33:35 +00:00
}
return $photo;
}
2018-11-21 14:10:47 +00:00
}