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\Contact;
24 use Friendica\Core\Logger;
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;
38 * functions for handling contact avatar caching
43 * Returns a field array with locally cached avatar pictures
45 * @param array $contact
46 * @param string $avatar
49 public static function fetchAvatarContact(array $contact, string $avatar): array
51 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(), 'photo' => '', 'thumb' => '', 'micro' => ''];
53 if (!DI::config()->get('system', 'avatar_cache')) {
54 self::deleteCache($contact);
58 if (Network::isLocalLink($avatar)) {
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]);
73 $guid = Item::guidFromUri($contact['url'], parse_url($contact['url'], PHP_URL_HOST));
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) . '-';
78 $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
80 $img_str = $fetchResult->getBody();
81 if (empty($img_str)) {
82 Logger::debug('Avatar is invalid', ['avatar' => $avatar]);
86 $image = new Image($img_str, Images::getMimeTypeByData($img_str));
87 if (!$image->isValid()) {
88 Logger::debug('Avatar picture is invalid', ['avatar' => $avatar]);
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);
96 Logger::debug('Storing new avatar cache', ['uri-id' => $contact['uri-id'], 'fields' => $fields]);
101 private static function storeAvatarCache(Image $image, string $filename, int $size): string
103 $image->scaleDown($size);
104 if (is_null($image) || !$image->isValid()) {
108 $path = '/avatar/' . $filename . $size . '.' . $image->getExt();
110 $filepath = DI::basePath() . $path;
112 $dirpath = DI::basePath() . '/avatar/';
114 DI::profiler()->startRecording('file');
116 // Fetch the permission and group ownership of the "avatar" path and apply to all files
117 $dir_perm = fileperms($dirpath) & 0777;
118 $file_perm = fileperms($dirpath) & 0666;
119 $group = filegroup($dirpath);
121 // Check directory permissions of all parts of the path
122 foreach (explode('/', dirname($filename)) as $part) {
123 $dirpath .= $part . '/';
124 if (!file_exists($dirpath)) {
125 mkdir($dirpath, $dir_perm);
126 } elseif (fileperms($dirpath) & 0777 != $dir_perm) {
127 chmod($dirpath, $dir_perm);
130 if (filegroup($dirpath) != $group) {
131 chgrp($dirpath, $group);
135 file_put_contents($filepath, $image->asString());
136 chmod($filepath, $file_perm);
137 chgrp($filepath, $group);
139 DI::profiler()->stopRecording();
141 if (!file_exists($filepath)) {
142 Logger::warning('Avatar cache file could not be stored', ['file' => $filepath]);
146 return DI::baseUrl() . $path;
150 * Check if the avatar cache file is locally stored
152 * @param string $avatar
155 private static function isCacheFile(string $avatar): bool
157 return !empty(self::getCacheFile($avatar));
161 * Fetch the name of locally cached avatar pictures
163 * @param string $avatar
166 private static function getCacheFile(string $avatar): string
168 if (empty($avatar) || !Network::isLocalLink($avatar)) {
172 $path = Strings::normaliseLink(DI::baseUrl() . '/avatar');
174 if (Network::getUrlMatch($path, $avatar) != $path) {
178 $filename = str_replace($path, DI::basePath(). '/avatar/', Strings::normaliseLink($avatar));
180 DI::profiler()->startRecording('file');
181 $exists = file_exists($filename);
182 DI::profiler()->stopRecording();
191 * Delete locally cached avatar pictures of a contact
193 * @param string $avatar
196 public static function deleteCache(array $contact)
198 self::deleteCacheFile($contact['photo']);
199 self::deleteCacheFile($contact['thumb']);
200 self::deleteCacheFile($contact['micro']);
204 * Delete a locally cached avatar picture
206 * @param string $avatar
209 private static function deleteCacheFile(string $avatar)
211 $localFile = self::getCacheFile($avatar);
212 if (!empty($localFile)) {
214 Logger::debug('Unlink avatar', ['avatar' => $avatar]);