]> git.mxchange.org Git - friendica.git/blobdiff - src/Module/Photo.php
Replace remaining references to default banner image by api.mastodon_banner configura...
[friendica.git] / src / Module / Photo.php
index 3d3110fd8b702fa2458c6c1a2ff61fc775b68637..c8e0656d2df62ac9014697cdabd14a636ad73526 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -22,7 +22,9 @@
 namespace Friendica\Module;
 
 use Friendica\BaseModule;
+use Friendica\Contact\Header;
 use Friendica\Core\Logger;
+use Friendica\Core\Protocol;
 use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Model\Contact;
@@ -31,7 +33,11 @@ use Friendica\Model\Post;
 use Friendica\Model\Profile;
 use Friendica\Core\Storage\Type\ExternalResource;
 use Friendica\Core\Storage\Type\SystemResource;
+use Friendica\Core\System;
+use Friendica\Core\Worker;
 use Friendica\Model\User;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
+use Friendica\Network\HTTPClient\Client\HttpClientOptions;
 use Friendica\Network\HTTPException;
 use Friendica\Network\HTTPException\NotModifiedException;
 use Friendica\Object\Image;
@@ -39,11 +45,12 @@ use Friendica\Util\Images;
 use Friendica\Util\Network;
 use Friendica\Util\ParseUrl;
 use Friendica\Util\Proxy;
+use Friendica\Worker\UpdateContact;
 
 /**
  * Photo Module
  */
-class Photo extends BaseModule
+class Photo extends BaseApi
 {
        /**
         * Module initializer
@@ -55,17 +62,17 @@ class Photo extends BaseModule
        {
                $totalstamp = microtime(true);
 
-               if (isset($_SERVER["HTTP_IF_MODIFIED_SINCE"])) {
-                       header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
-                       if (!empty($_SERVER["HTTP_IF_NONE_MATCH"])) {
-                               header("Etag: " . $_SERVER["HTTP_IF_NONE_MATCH"]);
+               if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
+                       header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
+                       if (!empty($_SERVER['HTTP_IF_NONE_MATCH'])) {
+                               header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']);
                        }
-                       header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
-                       header("Cache-Control: max-age=31536000");
-                       if (function_exists("header_remove")) {
-                               header_remove("Last-Modified");
-                               header_remove("Expires");
-                               header_remove("Cache-Control");
+                       header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
+                       header('Cache-Control: max-age=31536000');
+                       if (function_exists('header_remove')) {
+                               header_remove('Last-Modified');
+                               header_remove('Expires');
+                               header_remove('Cache-Control');
                        }
                        throw new NotModifiedException();
                }
@@ -123,15 +130,27 @@ class Photo extends BaseModule
                                throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo is not available.'));
                        }
 
-                       $photo = self::getPhotoByid($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
+                       $photo = self::getPhotoById($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
                } else {
                        $photoid = pathinfo($this->parameters['name'], PATHINFO_FILENAME);
                        $scale = 0;
-                       if (substr($photoid, -2, 1) == "-") {
+                       if (substr($photoid, -2, 1) == '-') {
                                $scale = intval(substr($photoid, -1, 1));
                                $photoid = substr($photoid, 0, -2);
                        }
-                       $photo = MPhoto::getPhoto($photoid, $scale);
+
+                       if (!empty($this->parameters['size'])) {
+                               switch ($this->parameters['size']) {
+                                       case 'thumb_small':
+                                               $scale = 2;
+                                               break;
+                                       case 'scaled_full':
+                                               $scale = 1;
+                                               break;
+                                       }
+                       }
+
+                       $photo = MPhoto::getPhoto($photoid, $scale, self::getCurrentUserID());
                        if ($photo === false) {
                                throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo with id %s is not available.', $photoid));
                        }
@@ -143,13 +162,17 @@ class Photo extends BaseModule
                        throw new HTTPException\NotFoundException();
                }
 
-               $cacheable = ($photo["allow_cid"] . $photo["allow_gid"] . $photo["deny_cid"] . $photo["deny_gid"] === "") && (isset($photo["cacheable"]) ? $photo["cacheable"] : true);
+               $cacheable = ($photo['allow_cid'] . $photo['allow_gid'] . $photo['deny_cid'] . $photo['deny_gid'] === '') && (isset($photo['cacheable']) ? $photo['cacheable'] : true);
 
                $stamp = microtime(true);
 
                $imgdata = MPhoto::getImageDataForPhoto($photo);
-               if (empty($imgdata)) {
+               if (empty($imgdata) && empty($photo['blurhash'])) {
                        throw new HTTPException\NotFoundException();
+               } elseif (empty($imgdata) && !empty($photo['blurhash'])) {
+                       $image = New Image('', 'image/png');
+                       $image->getFromBlurHash($photo['blurhash'], $photo['width'], $photo['height']);
+                       $imgdata = $image->asString();
                }
 
                // The mimetype for an external or system resource can only be known reliably after it had been fetched
@@ -173,36 +196,42 @@ class Photo extends BaseModule
                        throw new HTTPException\InternalServerErrorException($error);
                }
 
+               if (!empty($request['static'])) {
+                       $img = new Image($imgdata, $photo['type']);
+                       $img->toStatic();
+                       $imgdata = $img->asString();
+               }
+
                // if customsize is set and image is not a gif, resize it
-               if ($photo['type'] !== "image/gif" && $customsize > 0 && $customsize <= Proxy::PIXEL_THUMB && $square_resize) {
+               if ($photo['type'] !== 'image/gif' && $customsize > 0 && $customsize <= Proxy::PIXEL_THUMB && $square_resize) {
                        $img = new Image($imgdata, $photo['type']);
                        $img->scaleToSquare($customsize);
                        $imgdata = $img->asString();
-               } elseif ($photo['type'] !== "image/gif" && $customsize > 0) {
+               } elseif ($photo['type'] !== 'image/gif' && $customsize > 0) {
                        $img = new Image($imgdata, $photo['type']);
                        $img->scaleDown($customsize);
                        $imgdata = $img->asString();
                }
 
-               if (function_exists("header_remove")) {
-                       header_remove("Pragma");
-                       header_remove("pragma");
+               if (function_exists('header_remove')) {
+                       header_remove('Pragma');
+                       header_remove('pragma');
                }
 
-               header("Content-type: " . $photo['type']);
+               header('Content-type: ' . $photo['type']);
 
                $stamp = microtime(true);
                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");
+                       header('Cache-Control: no-store, no-cache, must-revalidate');
                } else {
                        $md5 = $photo['hash'] ?: md5($imgdata);
-                       header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
+                       header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
                        header("Etag: \"{$md5}\"");
-                       header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
-                       header("Cache-Control: max-age=31536000");
+                       header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
+                       header('Cache-Control: max-age=31536000');
                }
                $checksum = microtime(true) - $stamp;
 
@@ -214,27 +243,39 @@ class Photo extends BaseModule
                $rest = $total - ($fetch + $data + $checksum + $output);
 
                if (!is_null($scale) && ($scale < 4)) {
-                       Logger::info('Performance:', ['scale' => $scale, 'resource' => $photo['resource-id'],
+                       Logger::debug('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)]);
                }
 
-               exit();
+               System::exit();
        }
 
-       private static function getPhotoByid(int $id, $type, $customsize)
+       /**
+        * Fetches photo record by given id number, type and custom size
+        *
+        * @param int $id Photo id
+        * @param string $type Photo type
+        * @param int $customsize Custom size (?)
+        * @return array|bool Array on success, false on error
+        */
+       private static function getPhotoById(int $id, string $type, int $customsize)
        {
                switch($type) {
-                       case "preview":
-                               $media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $id]);
+                       case 'preview':
+                               $media = DBA::selectFirst('post-media', ['preview', 'url', 'preview-height', 'preview-width', 'height', 'width', 'mimetype', 'type', 'uri-id', 'blurhash'], ['id' => $id]);
                                if (empty($media)) {
                                        return false;
                                }
-                               $url = $media['preview'];
+                               $url    = $media['preview'];
+                               $width  = $media['preview-width'];
+                               $height = $media['preview-height'];
 
                                if (empty($url) && ($media['type'] == Post\Media::IMAGE)) {
-                                       $url = $media['url'];
+                                       $url    = $media['url'];
+                                       $width  = $media['width'];
+                                       $height = $media['height'];
                                }
 
                                if (empty($url)) {
@@ -242,37 +283,38 @@ class Photo extends BaseModule
                                }
 
                                if (Network::isLocalLink($url) && preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $url, $matches)) {
-                                       return MPhoto::getPhoto($matches[1], $matches[2]);
+                                       return MPhoto::getPhoto($matches[1], $matches[2], self::getCurrentUserID());
                                }
 
-                               return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']);
-                       case "media":
-                               $media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $id, 'type' => Post\Media::IMAGE]);
+                               return MPhoto::createPhotoForExternalResource($url, (int)DI::userSession()->getLocalUserId(), $media['mimetype'] ?? '', $media['blurhash'], $width, $height);
+                       case 'media':
+                               $media = DBA::selectFirst('post-media', ['url', 'height', 'width', 'mimetype', 'uri-id', 'blurhash'], ['id' => $id, 'type' => Post\Media::IMAGE]);
                                if (empty($media)) {
                                        return false;
                                }
 
                                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]);
+                                       return MPhoto::getPhoto($matches[1], $matches[2], self::getCurrentUserID());
                                }
 
-                               return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']);
-                       case "link":
-                               $link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $id]);
+                               return MPhoto::createPhotoForExternalResource($media['url'], (int)DI::userSession()->getLocalUserId(), $media['mimetype'], $media['blurhash'], $media['width'], $media['height']);
+                       case 'link':
+                               $link = DBA::selectFirst('post-link', ['url', 'mimetype', 'blurhash', 'width', 'height'], ['id' => $id]);
                                if (empty($link)) {
                                        return false;
                                }
 
-                               return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']);
-                       case "contact":
-                               $contact = Contact::getById($id, ['uid', 'url', 'nurl', 'avatar', 'photo', 'xmpp', 'addr']);
+                               return MPhoto::createPhotoForExternalResource($link['url'], (int)DI::userSession()->getLocalUserId(), $link['mimetype'] ?? '', $link['blurhash'] ?? '', $link['width'] ?? 0, $link['height'] ?? 0);
+                       case 'contact':
+                               $fields = ['uid', 'uri-id', 'url', 'nurl', 'avatar', 'photo', 'blurhash', 'xmpp', 'addr', 'network', 'failed', 'updated'];
+                               $contact = Contact::getById($id, $fields);
                                if (empty($contact)) {
                                        return false;
                                }
 
                                // For local users directly use the photo record that is marked as the profile
                                if (Network::isLocalLink($contact['url'])) {
-                                       $contact = Contact::selectFirst(['uid', 'url', 'avatar', 'photo', 'xmpp', 'addr'], ['nurl' => $contact['nurl'], 'self' => true]);
+                                       $contact = Contact::selectFirst($fields, ['nurl' => $contact['nurl'], 'self' => true]);
                                        if (!empty($contact)) {
                                                if ($customsize <= Proxy::PIXEL_MICRO) {
                                                        $scale = 6;
@@ -281,7 +323,7 @@ class Photo extends BaseModule
                                                } else {
                                                        $scale = 4;
                                                }
-                                               $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $contact['uid'], "profile" => 1]);
+                                               $photo = MPhoto::selectFirst([], ['scale' => $scale, 'uid' => $contact['uid'], 'profile' => 1]);
                                                if (!empty($photo)) {
                                                        return $photo;
                                                }
@@ -289,7 +331,7 @@ class Photo extends BaseModule
                                }
 
                                if (!empty($contact['uid']) && empty($contact['photo']) && empty($contact['avatar'])) {
-                                       $contact = Contact::getByURL($contact['url'], false, ['avatar', 'photo', 'xmpp', 'addr']);
+                                       $contact = Contact::getByURL($contact['url'], false, $fields);
                                }
 
                                if (!empty($contact['photo']) && !empty($contact['avatar'])) {
@@ -299,42 +341,85 @@ class Photo extends BaseModule
                                                $photo = MPhoto::selectFirst([], ['resource-id' => $resourceid], ['order' => ['scale']]);
                                                if (!empty($photo)) {
                                                        return $photo;
+                                               } else {
+                                                       $url = $contact['avatar'];
                                                }
+                                       } else {
+                                               $url = $contact['photo'];
                                        }
-                                       // We continue with the avatar link when the photo link is invalid
-                                       $url = $contact['avatar'];
                                } elseif (!empty($contact['avatar'])) {
                                        $url = $contact['avatar'];
                                }
+
+                               // If it is a local link, we save resources by just redirecting to it.
+                               if (!empty($url) && Network::isLocalLink($url)) {
+                                       System::externalRedirect($url);
+                               }
+
                                $mimetext = '';
                                if (!empty($url)) {
-                                       $mime = ParseUrl::getContentType($url);
+                                       $mime = ParseUrl::getContentType($url, HttpClientAccept::IMAGE);
                                        if (!empty($mime)) {
                                                $mimetext = $mime[0] . '/' . $mime[1];
                                        } else {
-                                               Logger::info('Invalid file', ['url' => $url]);
+                                               // Only update federated accounts that hadn't failed before and hadn't been updated recently
+                                               $update = in_array($contact['network'], Protocol::FEDERATED) && !$contact['failed']
+                                                       && ((time() - strtotime($contact['updated']) > 86400));
+                                               if ($update) {
+                                                       $curlResult = DI::httpClient()->head($url, [HttpClientOptions::ACCEPT_CONTENT => HttpClientAccept::IMAGE]);
+                                                       $update = !$curlResult->isSuccess() && ($curlResult->getReturnCode() == 404);
+                                                       Logger::debug('Got return code for avatar', ['return code' => $curlResult->getReturnCode(), 'cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
+                                               }
+                                               if ($update) {
+                                                       try {
+                                                               UpdateContact::add(Worker::PRIORITY_LOW, $id);
+                                                               Logger::info('Invalid file, contact update initiated', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
+                                                       } catch (\InvalidArgumentException $e) {
+                                                               Logger::notice($e->getMessage(), ['id' => $id, 'contact' => $contact]);
+                                                       }
+                                               } else {
+                                                       Logger::info('Invalid file', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
+                                               }
                                        }
                                        if (!empty($mimetext) && ($mime[0] != 'image') && ($mimetext != 'application/octet-stream')) {
                                                Logger::info('Unexpected Content-Type', ['mime' => $mimetext, 'url' => $url]);
                                                $mimetext = '';
+                                       } if (!empty($mimetext)) {
+                                               Logger::debug('Expected Content-Type', ['mime' => $mimetext, 'url' => $url]);
                                        }
                                }
-                               if (empty($mimetext)) {
+                               if (empty($mimetext) && !empty($contact['blurhash'])) {
+                                       $image = New Image('', 'image/png');
+                                       $image->getFromBlurHash($contact['blurhash'], $customsize, $customsize);
+                                       return MPhoto::createPhotoForImageData($image->asString());
+                               } elseif (empty($mimetext)) {
                                        if ($customsize <= Proxy::PIXEL_MICRO) {
-                                               $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
+                                               $url = Contact::getDefaultAvatar($contact ?: [], Proxy::SIZE_MICRO);
                                        } elseif ($customsize <= Proxy::PIXEL_THUMB) {
-                                               $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
+                                               $url = Contact::getDefaultAvatar($contact ?: [], Proxy::SIZE_THUMB);
                                        } else {
-                                               $url = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
+                                               $url = Contact::getDefaultAvatar($contact ?: [], Proxy::SIZE_SMALL);
+                                       }
+                                       if (Network::isLocalLink($url)) {
+                                               System::externalRedirect($url);
                                        }
                                }
-                               return MPhoto::createPhotoForExternalResource($url, 0, $mimetext);
-                       case "header":
+                               return MPhoto::createPhotoForExternalResource($url, 0, $mimetext, $contact['blurhash'] ?? null, $customsize, $customsize);
+                       case 'header':
                                $fields = ['uid', 'url', 'header', 'network', 'gsid'];
                                $contact = Contact::getById($id, $fields);
                                if (empty($contact)) {
                                        return false;
                                }
+
+                               if (Network::isLocalLink($contact['url'])) {
+                                       $header_uid = User::getIdForURL($contact['url']);
+                                       if (empty($header_uid)) {
+                                               throw new HTTPException\NotFoundException();
+                                       }
+                                       return self::getBannerForUser($header_uid);
+                               }
+
                                If (($contact['uid'] != 0) && empty($contact['header'])) {
                                        $contact = Contact::getByURL($contact['url'], false, $fields);
                                }
@@ -342,43 +427,46 @@ class Photo extends BaseModule
                                        $url = $contact['header'];
                                } else {
                                        $url = Contact::getDefaultHeader($contact);
+                                       if (Network::isLocalLink($url)) {
+                                               System::externalRedirect($url);
+                                       }
                                }
                                return MPhoto::createPhotoForExternalResource($url);
-                       case "banner":
-                               $photo = MPhoto::selectFirst([], ["scale" => 3, 'uid' => $id, 'photo-type' => MPhoto::USER_BANNER]);
-                               if (!empty($photo)) {
-                                       return $photo;
-                               }
-                               return MPhoto::createPhotoForExternalResource(DI::baseUrl() . '/images/friendica-banner.jpg');
-                       case "profile":
-                       case "custom":
+                       case 'banner':
+                               return self::getBannerForUser($id);
+                       case 'profile':
+                       case 'custom':
                                $scale = 4;
                                break;
-                       case "micro":
+                       case 'micro':
                                $scale = 6;
                                break;
-                       case "avatar":
+                       case 'avatar':
                        default:
                                $scale = 5;
                }
 
-               $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $id, "profile" => 1]);
+               $photo = MPhoto::selectFirst([], ['scale' => $scale, 'uid' => $id, 'profile' => 1]);
                if (empty($photo)) {
                        $contact = DBA::selectFirst('contact', [], ['uid' => $id, 'self' => true]) ?: [];
 
                        switch($type) {
-                               case "profile":
-                               case "custom":
+                               case 'profile':
+                               case 'custom':
                                        $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
                                        break;
-                               case "micro":
+                               case 'micro':
                                        $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
                                        break;
-                               case "avatar":
+                               case 'avatar':
                                default:
                                        $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
                        }
 
+                       if (Network::isLocalLink($default)) {
+                               System::externalRedirect($default);
+                       }
+
                        $parts = parse_url($default);
                        if (!empty($parts['scheme']) || !empty($parts['host'])) {
                                $photo = MPhoto::createPhotoForExternalResource($default);
@@ -388,4 +476,13 @@ class Photo extends BaseModule
                }
                return $photo;
        }
+
+       private static function getBannerForUser(int $uid): array
+       {
+               $photo = MPhoto::selectFirst([], ['scale' => 3, 'uid' => $uid, 'photo-type' => MPhoto::USER_BANNER]);
+               if (!empty($photo)) {
+                       return $photo;
+               }
+               return MPhoto::createPhotoForImageData(file_get_contents(DI::basePath() . (new Header(DI::config()))->getMastodonBannerPath()));
+       }
 }