3 * @copyright Copyright (C) 2010-2021, the Friendica project
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\Module;
24 use Friendica\BaseModule;
25 use Friendica\Core\Logger;
26 use Friendica\Database\DBA;
28 use Friendica\Model\Contact;
29 use Friendica\Model\Photo as MPhoto;
30 use Friendica\Model\Post;
31 use Friendica\Model\Profile;
32 use Friendica\Model\Storage\ExternalResource;
33 use Friendica\Model\Storage\ReferenceStorageException;
34 use Friendica\Model\Storage\StorageException;
35 use Friendica\Model\Storage\SystemResource;
36 use Friendica\Network\HTTPException\InternalServerErrorException;
37 use Friendica\Network\HTTPException\NotFoundException;
38 use Friendica\Util\Proxy;
39 use Friendica\Object\Image;
40 use Friendica\Util\Images;
41 use Friendica\Util\Network;
46 class Photo extends BaseModule
51 * Fetch a photo or an avatar, in optional size, check for permissions and
54 public static function rawContent(array $parameters = [])
56 $totalstamp = microtime(true);
58 if (isset($_SERVER["HTTP_IF_MODIFIED_SINCE"])) {
59 header("HTTP/1.1 304 Not Modified");
60 header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
61 if (!empty($_SERVER["HTTP_IF_NONE_MATCH"])) {
62 header("Etag: " . $_SERVER["HTTP_IF_NONE_MATCH"]);
64 header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
65 header("Cache-Control: max-age=31536000");
66 if (function_exists("header_remove")) {
67 header_remove("Last-Modified");
68 header_remove("Expires");
69 header_remove("Cache-Control");
74 Profile::addVisitorCookieForHTTPSigner();
77 $square_resize = true;
80 $stamp = microtime(true);
81 if (!empty($parameters['customsize'])) {
82 $customsize = intval($parameters['customsize']);
83 $uid = MPhoto::stripExtension($parameters['name']);
84 $photo = self::getAvatar($uid, $parameters['type'], $customsize);
85 $square_resize = !in_array($parameters['type'], ['media', 'preview']);
86 } elseif (!empty($parameters['type'])) {
87 $uid = MPhoto::stripExtension($parameters['name']);
88 $photo = self::getAvatar($uid, $parameters['type'], Proxy::PIXEL_SMALL);
89 } elseif (!empty($parameters['name'])) {
90 $photoid = MPhoto::stripExtension($parameters['name']);
92 if (substr($photoid, -2, 1) == "-") {
93 $scale = intval(substr($photoid, -1, 1));
94 $photoid = substr($photoid, 0, -2);
96 $photo = MPhoto::getPhoto($photoid, $scale);
97 if ($photo === false) {
98 throw new \Friendica\Network\HTTPException\NotFoundException(DI::l10n()->t('The Photo with id %s is not available.', $photoid));
101 throw new \Friendica\Network\HTTPException\BadRequestException();
103 $fetch = microtime(true) - $stamp;
105 if ($photo === false) {
106 throw new \Friendica\Network\HTTPException\NotFoundException();
109 $cacheable = ($photo["allow_cid"] . $photo["allow_gid"] . $photo["deny_cid"] . $photo["deny_gid"] === "") && (isset($photo["cacheable"]) ? $photo["cacheable"] : true);
111 $stamp = microtime(true);
113 $imgdata = MPhoto::getImageDataForPhoto($photo);
114 if (empty($imgdata)) {
115 throw new NotFoundException();
118 // The mimetype for an external or system resource can only be known reliably after it had been fetched
119 if (in_array($photo['backend-class'], [ExternalResource::NAME, SystemResource::NAME])) {
120 $mimetype = Images::getMimeTypeByData($imgdata);
121 if (!empty($mimetype)) {
122 $photo['type'] = $mimetype;
126 $data = microtime(true) - $stamp;
128 if (empty($imgdata)) {
129 Logger::warning('Invalid photo', ['id' => $photo['id']]);
130 if (in_array($photo['backend-class'], [ExternalResource::NAME])) {
131 $reference = json_decode($photo['backend-ref'], true);
132 $error = DI::l10n()->t('Invalid external resource with url %s.', $reference['url']);
134 $error = DI::l10n()->t('Invalid photo with id %s.', $photo['id']);
136 throw new \Friendica\Network\HTTPException\InternalServerErrorException($error);
139 // if customsize is set and image is not a gif, resize it
140 if ($photo['type'] !== "image/gif" && $customsize > 0 && $customsize <= Proxy::PIXEL_THUMB && $square_resize) {
141 $img = new Image($imgdata, $photo['type']);
142 $img->scaleToSquare($customsize);
143 $imgdata = $img->asString();
144 } elseif ($photo['type'] !== "image/gif" && $customsize > 0) {
145 $img = new Image($imgdata, $photo['type']);
146 $img->scaleDown($customsize);
147 $imgdata = $img->asString();
150 if (function_exists("header_remove")) {
151 header_remove("Pragma");
152 header_remove("pragma");
155 header("Content-type: " . $photo['type']);
157 $stamp = microtime(true);
159 // it is a private photo that they have no permission to view.
160 // tell the browser not to cache it, in case they authenticate
161 // and subsequently have permission to see it
162 header("Cache-Control: no-store, no-cache, must-revalidate");
164 $md5 = $photo['hash'] ?: md5($imgdata);
165 header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
166 header("Etag: \"{$md5}\"");
167 header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
168 header("Cache-Control: max-age=31536000");
170 $checksum = microtime(true) - $stamp;
172 $stamp = microtime(true);
174 $output = microtime(true) - $stamp;
176 $total = microtime(true) - $totalstamp;
177 $rest = $total - ($fetch + $data + $checksum + $output);
179 if (!is_null($scale) && ($scale < 4)) {
180 Logger::info('Performance:', ['scale' => $scale, 'resource' => $photo['resource-id'],
181 'total' => number_format($total, 3), 'fetch' => number_format($fetch, 3),
182 'data' => number_format($data, 3), 'checksum' => number_format($checksum, 3),
183 'output' => number_format($output, 3), 'rest' => number_format($rest, 3)]);
189 private static function getAvatar($uid, $type="avatar", $customsize)
193 $media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $uid]);
197 $url = $media['preview'];
199 if (empty($url) && ($media['type'] == Post\Media::IMAGE)) {
200 $url = $media['url'];
207 if (Network::isLocalLink($url) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $url, $matches)) {
208 return MPhoto::getPhoto($matches[1], $matches[2]);
211 return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']);
213 $media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $uid, 'type' => Post\Media::IMAGE]);
218 if (Network::isLocalLink($media['url']) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $media['url'], $matches)) {
219 return MPhoto::getPhoto($matches[1], $matches[2]);
222 return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']);
224 $link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $uid]);
229 return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']);
231 $contact = Contact::getById($uid, ['uid', 'url', 'avatar', 'photo', 'xmpp', 'addr']);
232 if (empty($contact)) {
235 If (($contact['uid'] != 0) && empty($contact['photo']) && empty($contact['avatar'])) {
236 $contact = Contact::getByURL($contact['url'], false, ['avatar', 'photo', 'xmpp', 'addr']);
238 if (!empty($contact['photo']) && !empty($contact['avatar'])) {
239 // Fetch photo directly
240 $resourceid = MPhoto::ridFromURI($contact['photo']);
241 if (!empty($resourceid)) {
242 $photo = MPhoto::selectFirst([], ['resource-id' => $resourceid], ['order' => ['scale']]);
243 if (!empty($photo)) {
247 // We continue with the avatar link when the photo link is invalid
248 $url = $contact['avatar'];
249 } elseif (!empty($contact['avatar'])) {
250 $url = $contact['avatar'];
251 } elseif ($customsize <= Proxy::PIXEL_MICRO) {
252 $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
253 } elseif ($customsize <= Proxy::PIXEL_THUMB) {
254 $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
256 $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
258 return MPhoto::createPhotoForExternalResource($url);
260 $contact = Contact::getById($uid, ['uid', 'url', 'header']);
261 if (empty($contact)) {
264 If (($contact['uid'] != 0) && empty($contact['header'])) {
265 $contact = Contact::getByURL($contact['url'], false, ['header']);
267 if (!empty($contact['header'])) {
268 $url = $contact['header'];
270 $url = DI::baseUrl() . '/images/blank.png';
272 return MPhoto::createPhotoForExternalResource($url);
285 $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $uid, "profile" => 1]);
287 $contact = DBA::selectFirst('contact', [], ['uid' => $uid, 'self' => true]) ?: [];
292 $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
295 $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
299 $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
302 $parts = parse_url($default);
303 if (!empty($parts['scheme']) || !empty($parts['host'])) {
304 $photo = MPhoto::createPhotoForExternalResource($default);
306 $photo = MPhoto::createPhotoForSystemResource($default);