src/Contact/Avatar.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Contact;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\DI;
  26 use Friendica\Model\Item;
  27 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
  28 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
  29 use Friendica\Object\Image;
  30 use Friendica\Util\DateTimeFormat;
  31 use Friendica\Util\HTTPSignature;
  32 use Friendica\Util\Images;
  33 use Friendica\Util\Network;
  34 use Friendica\Util\Proxy;
  35 use Friendica\Util\Strings;
  36
  37 /**
  38  * functions for handling contact avatar caching
  39  */
  40 class Avatar
  41 {
  42         /**
  43          * Returns a field array with locally cached avatar pictures
  44          *
  45          * @param array $contact
  46          * @param string $avatar
  47          * @return array
  48          */
  49         public static function fetchAvatarContact(array $contact, string $avatar): array
  50         {
  51                 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(), 'photo' => '', 'thumb' => '', 'micro' => ''];
  52
  53                 if (!DI::config()->get('system', 'avatar_cache')) {
  54                         self::deleteCache($contact);
  55                         return $fields;
  56                 }
  57
  58                 if (Network::isLocalLink($avatar)) {
  59                         return $fields;
  60                 }
  61
  62                 if ($avatar != $contact['avatar']) {
  63                         self::deleteCache($contact);
  64                         Logger::debug('Avatar file name changed', ['new' => $avatar, 'old' => $contact['avatar']]);
  65                 } elseif (self::isCacheFile($contact['photo']) && self::isCacheFile($contact['thumb']) && self::isCacheFile($contact['micro'])) {
  66                         $fields['photo'] = $contact['photo'];
  67                         $fields['thumb'] = $contact['thumb'];
  68                         $fields['micro'] = $contact['micro'];
  69                         Logger::debug('Using existing cache files', ['uri-id' => $contact['uri-id'], 'fields' => $fields]);
  70                         return $fields;
  71                 }
  72
  73                 $guid = Item::guidFromUri($contact['url'], parse_url($contact['url'], PHP_URL_HOST));
  74
  75                 $filename = substr($guid, 0, 2) . '/' . substr($guid, 3, 2) . '/' . substr($guid, 5, 3) . '/' .
  76                         substr($guid, 9, 2) .'/' . substr($guid, 11, 2) . '/' . substr($guid, 13, 4). '/' . substr($guid, 18) . '-';
  77
  78                 $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
  79
  80                 $img_str = $fetchResult->getBody();
  81                 if (empty($img_str)) {
  82                         Logger::debug('Avatar is invalid', ['avatar' => $avatar]);
  83                         return $fields;
  84                 }
  85
  86                 $image = new Image($img_str, Images::getMimeTypeByData($img_str));
  87                 if (!$image->isValid()) {
  88                         Logger::debug('Avatar picture is invalid', ['avatar' => $avatar]);
  89                         return $fields;
  90                 }
  91
  92                 $fields['photo'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_SMALL);
  93                 $fields['thumb'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_THUMB);
  94                 $fields['micro'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_MICRO);
  95
  96                 Logger::debug('Storing new avatar cache', ['uri-id' => $contact['uri-id'], 'fields' => $fields]);
  97
  98                 return $fields;
  99         }
 100
 101         private static function storeAvatarCache(Image $image, string $filename, int $size): string
 102         {
 103                 $image->scaleDown($size);
 104                 if (is_null($image) || !$image->isValid()) {
 105                         return '';
 106                 }
 107
 108                 $path = '/avatar/' . $filename . $size . '.' . $image->getExt();
 109
 110                 $filepath = DI::basePath() . $path;
 111
 112                 $dirpath = dirname($filepath);
 113
 114                 DI::profiler()->startRecording('file');
 115
 116                 if (!file_exists($dirpath)) {
 117                         mkdir($dirpath, 0777, true);
 118                 }
 119
 120                 file_put_contents($filepath, $image->asString());
 121                 DI::profiler()->stopRecording();
 122
 123                 return DI::baseUrl() . $path;
 124         }
 125
 126         /**
 127          * Check if the avatar cache file is locally stored
 128          *
 129          * @param string $avatar
 130          * @return boolean
 131          */
 132         private static function isCacheFile(string $avatar): bool
 133         {
 134                 return !empty(self::getCacheFile($avatar));
 135         }
 136
 137         /**
 138          * Fetch the name of locally cached avatar pictures
 139          *
 140          * @param string $avatar
 141          * @return string
 142          */
 143         private static function getCacheFile(string $avatar): string
 144         {
 145                 if (empty($avatar) || !Network::isLocalLink($avatar)) {
 146                         return '';
 147                 }
 148
 149                 $path = Strings::normaliseLink(DI::baseUrl() . '/avatar');
 150
 151                 if (Network::getUrlMatch($path, $avatar) != $path) {
 152                         return '';
 153                 }
 154
 155                 $filename = str_replace($path, DI::basePath(). '/avatar/', Strings::normaliseLink($avatar));
 156
 157                 DI::profiler()->startRecording('file');
 158                 $exists = file_exists($filename);
 159                 DI::profiler()->stopRecording();
 160
 161                 if (!$exists) {
 162                         return '';
 163                 }
 164                 return $filename;
 165         }
 166
 167         /**
 168          * Delete locally cached avatar pictures of a contact
 169          *
 170          * @param string $avatar
 171          * @return void
 172          */
 173         public static function deleteCache(array $contact)
 174         {
 175                 self::deleteCacheFile($contact['photo']);
 176                 self::deleteCacheFile($contact['thumb']);
 177                 self::deleteCacheFile($contact['micro']);
 178         }
 179
 180         /**
 181          * Delete a locally cached avatar picture
 182          *
 183          * @param string $avatar
 184          * @return void
 185          */
 186         private static function deleteCacheFile(string $avatar)
 187         {
 188                 $localFile = self::getCacheFile($avatar);
 189                 if (!empty($localFile)) {
 190                         unlink($localFile);
 191                         Logger::debug('Unlink avatar', ['avatar' => $avatar]);
 192                 }
 193         }
 194 }