3 * @copyright Copyright (C) 2010-2022, 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\Core\Storage\Type\ExternalResource;
33 use Friendica\Core\Storage\Type\SystemResource;
34 use Friendica\Model\User;
35 use Friendica\Network\HTTPClient\Client\HttpClient;
36 use Friendica\Network\HTTPException;
37 use Friendica\Network\HTTPException\NotModifiedException;
38 use Friendica\Object\Image;
39 use Friendica\Util\Images;
40 use Friendica\Util\Network;
41 use Friendica\Util\ParseUrl;
42 use Friendica\Util\Proxy;
47 class Photo extends BaseModule
52 * Fetch a photo or an avatar, in optional size, check for permissions and
55 protected function rawContent(array $request = [])
57 $totalstamp = microtime(true);
59 if (isset($_SERVER["HTTP_IF_MODIFIED_SINCE"])) {
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");
71 throw new NotModifiedException();
74 Profile::addVisitorCookieForHTTPSigner();
77 $square_resize = true;
79 $stamp = microtime(true);
81 if (!empty($this->parameters['type'])) {
82 if (!empty($this->parameters['customsize'])) {
83 $customsize = intval($this->parameters['customsize']);
84 $square_resize = !in_array($this->parameters['type'], ['media', 'preview']);
87 if (!empty($this->parameters['guid'])) {
88 $guid = $this->parameters['guid'];
89 $account = DBA::selectFirst('account-user-view', ['id'], ['guid' => $guid], ['order' => ['uid' => true]]);
90 if (empty($account)) {
91 throw new HTTPException\NotFoundException();
97 // Contact Id Fallback, to remove after version 2021.12
98 if (isset($this->parameters['contact_id'])) {
99 $id = intval($this->parameters['contact_id']);
102 if (!empty($this->parameters['nickname_ext'])) {
103 $nickname = pathinfo($this->parameters['nickname_ext'], PATHINFO_FILENAME);
104 $user = User::getByNickname($nickname, ['uid']);
106 throw new HTTPException\NotFoundException();
112 // User Id Fallback, to remove after version 2021.12
113 if (!empty($this->parameters['uid_ext'])) {
114 $id = intval(pathinfo($this->parameters['uid_ext'], PATHINFO_FILENAME));
117 // Please refactor this for the love of everything that's good
118 if (isset($this->parameters['id'])) {
119 $id = $this->parameters['id'];
123 Logger::notice('No picture id was detected', ['parameters' => $this->parameters, 'query' => DI::args()->getQueryString()]);
124 throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo is not available.'));
127 $photo = self::getPhotoByid($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
129 $photoid = pathinfo($this->parameters['name'], PATHINFO_FILENAME);
131 if (substr($photoid, -2, 1) == "-") {
132 $scale = intval(substr($photoid, -1, 1));
133 $photoid = substr($photoid, 0, -2);
135 $photo = MPhoto::getPhoto($photoid, $scale);
136 if ($photo === false) {
137 throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo with id %s is not available.', $photoid));
141 $fetch = microtime(true) - $stamp;
143 if ($photo === false) {
144 throw new HTTPException\NotFoundException();
147 $cacheable = ($photo["allow_cid"] . $photo["allow_gid"] . $photo["deny_cid"] . $photo["deny_gid"] === "") && (isset($photo["cacheable"]) ? $photo["cacheable"] : true);
149 $stamp = microtime(true);
151 $imgdata = MPhoto::getImageDataForPhoto($photo);
152 if (empty($imgdata)) {
153 throw new HTTPException\NotFoundException();
156 // The mimetype for an external or system resource can only be known reliably after it had been fetched
157 if (in_array($photo['backend-class'], [ExternalResource::NAME, SystemResource::NAME])) {
158 $mimetype = Images::getMimeTypeByData($imgdata);
159 if (!empty($mimetype)) {
160 $photo['type'] = $mimetype;
164 $data = microtime(true) - $stamp;
166 if (empty($imgdata)) {
167 Logger::warning('Invalid photo', ['id' => $photo['id']]);
168 if (in_array($photo['backend-class'], [ExternalResource::NAME])) {
169 $reference = json_decode($photo['backend-ref'], true);
170 $error = DI::l10n()->t('Invalid external resource with url %s.', $reference['url']);
172 $error = DI::l10n()->t('Invalid photo with id %s.', $photo['id']);
174 throw new HTTPException\InternalServerErrorException($error);
177 // if customsize is set and image is not a gif, resize it
178 if ($photo['type'] !== "image/gif" && $customsize > 0 && $customsize <= Proxy::PIXEL_THUMB && $square_resize) {
179 $img = new Image($imgdata, $photo['type']);
180 $img->scaleToSquare($customsize);
181 $imgdata = $img->asString();
182 } elseif ($photo['type'] !== "image/gif" && $customsize > 0) {
183 $img = new Image($imgdata, $photo['type']);
184 $img->scaleDown($customsize);
185 $imgdata = $img->asString();
188 if (function_exists("header_remove")) {
189 header_remove("Pragma");
190 header_remove("pragma");
193 header("Content-type: " . $photo['type']);
195 $stamp = microtime(true);
197 // it is a private photo that they have no permission to view.
198 // tell the browser not to cache it, in case they authenticate
199 // and subsequently have permission to see it
200 header("Cache-Control: no-store, no-cache, must-revalidate");
202 $md5 = $photo['hash'] ?: md5($imgdata);
203 header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
204 header("Etag: \"{$md5}\"");
205 header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
206 header("Cache-Control: max-age=31536000");
208 $checksum = microtime(true) - $stamp;
210 $stamp = microtime(true);
212 $output = microtime(true) - $stamp;
214 $total = microtime(true) - $totalstamp;
215 $rest = $total - ($fetch + $data + $checksum + $output);
217 if (!is_null($scale) && ($scale < 4)) {
218 Logger::info('Performance:', ['scale' => $scale, 'resource' => $photo['resource-id'],
219 'total' => number_format($total, 3), 'fetch' => number_format($fetch, 3),
220 'data' => number_format($data, 3), 'checksum' => number_format($checksum, 3),
221 'output' => number_format($output, 3), 'rest' => number_format($rest, 3)]);
227 private static function getPhotoByid(int $id, $type, $customsize)
231 $media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $id]);
235 $url = $media['preview'];
237 if (empty($url) && ($media['type'] == Post\Media::IMAGE)) {
238 $url = $media['url'];
245 if (Network::isLocalLink($url) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $url, $matches)) {
246 return MPhoto::getPhoto($matches[1], $matches[2]);
249 return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']);
251 $media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $id, 'type' => Post\Media::IMAGE]);
256 if (Network::isLocalLink($media['url']) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $media['url'], $matches)) {
257 return MPhoto::getPhoto($matches[1], $matches[2]);
260 return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']);
262 $link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $id]);
267 return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']);
269 $contact = Contact::getById($id, ['uid', 'url', 'nurl', 'avatar', 'photo', 'xmpp', 'addr']);
270 if (empty($contact)) {
274 // For local users directly use the photo record that is marked as the profile
275 if (Network::isLocalLink($contact['url'])) {
276 $contact = Contact::selectFirst(['uid', 'url', 'avatar', 'photo', 'xmpp', 'addr'], ['nurl' => $contact['nurl'], 'self' => true]);
277 if (!empty($contact)) {
278 if ($customsize <= Proxy::PIXEL_MICRO) {
280 } elseif ($customsize <= Proxy::PIXEL_THUMB) {
285 $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $contact['uid'], "profile" => 1]);
286 if (!empty($photo)) {
292 if (!empty($contact['uid']) && empty($contact['photo']) && empty($contact['avatar'])) {
293 $contact = Contact::getByURL($contact['url'], false, ['avatar', 'photo', 'xmpp', 'addr']);
296 if (!empty($contact['photo']) && !empty($contact['avatar'])) {
297 // Fetch photo directly
298 $resourceid = MPhoto::ridFromURI($contact['photo']);
299 if (!empty($resourceid)) {
300 $photo = MPhoto::selectFirst([], ['resource-id' => $resourceid], ['order' => ['scale']]);
301 if (!empty($photo)) {
305 // We continue with the avatar link when the photo link is invalid
306 $url = $contact['avatar'];
307 } elseif (!empty($contact['avatar'])) {
308 $url = $contact['avatar'];
312 $mime = ParseUrl::getContentType($url, HttpClient::ACCEPT_IMAGE);
314 $mimetext = $mime[0] . '/' . $mime[1];
316 Logger::info('Invalid file', ['url' => $url]);
318 if (!empty($mimetext) && ($mime[0] != 'image') && ($mimetext != 'application/octet-stream')) {
319 Logger::info('Unexpected Content-Type', ['mime' => $mimetext, 'url' => $url]);
321 } if (!empty($mimetext)) {
322 Logger::debug('Expected Content-Type', ['mime' => $mimetext, 'url' => $url]);
325 if (empty($mimetext)) {
326 if ($customsize <= Proxy::PIXEL_MICRO) {
327 $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
328 } elseif ($customsize <= Proxy::PIXEL_THUMB) {
329 $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
331 $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
334 return MPhoto::createPhotoForExternalResource($url, 0, $mimetext);
336 $fields = ['uid', 'url', 'header', 'network', 'gsid'];
337 $contact = Contact::getById($id, $fields);
338 if (empty($contact)) {
341 If (($contact['uid'] != 0) && empty($contact['header'])) {
342 $contact = Contact::getByURL($contact['url'], false, $fields);
344 if (!empty($contact['header'])) {
345 $url = $contact['header'];
347 $url = Contact::getDefaultHeader($contact);
349 return MPhoto::createPhotoForExternalResource($url);
351 $photo = MPhoto::selectFirst([], ["scale" => 3, 'uid' => $id, 'photo-type' => MPhoto::USER_BANNER]);
352 if (!empty($photo)) {
355 return MPhoto::createPhotoForExternalResource(DI::baseUrl() . '/images/friendica-banner.jpg');
368 $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $id, "profile" => 1]);
370 $contact = DBA::selectFirst('contact', [], ['uid' => $id, 'self' => true]) ?: [];
375 $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
378 $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
382 $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
385 $parts = parse_url($default);
386 if (!empty($parts['scheme']) || !empty($parts['host'])) {
387 $photo = MPhoto::createPhotoForExternalResource($default);
389 $photo = MPhoto::createPhotoForSystemResource($default);