<?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
*
use Friendica\Util\Images;
use Friendica\Util\Network;
use Friendica\Util\Proxy;
-use Friendica\Util\Strings;
/**
* functions for handling contact avatar caching
*/
class Avatar
{
+ const BASE_PATH = '/avatar/';
+
/**
* Returns a field array with locally cached avatar pictures
*
- * @param array $contact
- * @param string $avatar
+ * @param array $contact Contact array
+ * @param string $avatar Link to avatar picture
+ * @param bool $force force picture update
* @return array
*/
- public static function fetchAvatarContact(array $contact, string $avatar): array
+ public static function fetchAvatarContact(array $contact, string $avatar, bool $force = false): array
{
$fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(), 'photo' => '', 'thumb' => '', 'micro' => ''];
return $fields;
}
- if (Network::isLocalLink($avatar)) {
+ if (Network::isLocalLink($avatar) || empty($avatar)) {
+ self::deleteCache($contact);
return $fields;
}
- if ($avatar != $contact['avatar']) {
+ if (($avatar != $contact['avatar']) || $force) {
self::deleteCache($contact);
Logger::debug('Avatar file name changed', ['new' => $avatar, 'old' => $contact['avatar']]);
} elseif (self::isCacheFile($contact['photo']) && self::isCacheFile($contact['thumb']) && self::isCacheFile($contact['micro'])) {
return $fields;
}
- $guid = Item::guidFromUri($contact['url'], parse_url($contact['url'], PHP_URL_HOST));
-
- $filename = substr($guid, 0, 2) . '/' . substr($guid, 3, 2) . '/' . substr($guid, 5, 3) . '/' .
- substr($guid, 9, 2) .'/' . substr($guid, 11, 2) . '/' . substr($guid, 13, 4). '/' . substr($guid, 18) . '-';
-
- $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
+ try {
+ $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
+ } catch (\Exception $exception) {
+ Logger::notice('Avatar is invalid', ['avatar' => $avatar, 'exception' => $exception]);
+ return $fields;
+ }
$img_str = $fetchResult->getBody();
if (empty($img_str)) {
return $fields;
}
- $fields['photo'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_SMALL);
- $fields['thumb'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_THUMB);
- $fields['micro'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_MICRO);
+ $filename = self::getFilename($contact['url'], $avatar);
+ $timestamp = time();
+
+ $fields['blurhash'] = $image->getBlurHash();
+
+ $fields['photo'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_SMALL, $timestamp);
+ $fields['thumb'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_THUMB, $timestamp);
+ $fields['micro'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_MICRO, $timestamp);
Logger::debug('Storing new avatar cache', ['uri-id' => $contact['uri-id'], 'fields' => $fields]);
return $fields;
}
- private static function storeAvatarCache(Image $image, string $filename, int $size): string
+ public static function storeAvatarByImage(array $contact, Image $image): array
+ {
+ $fields = ['photo' => '', 'thumb' => '', 'micro' => ''];
+
+ if (!DI::config()->get('system', 'avatar_cache')) {
+ self::deleteCache($contact);
+ return $fields;
+ }
+
+ if (Network::isLocalLink($contact['avatar']) || empty($contact['avatar'])) {
+ self::deleteCache($contact);
+ return $fields;
+ }
+
+ $filename = self::getFilename($contact['url'], $contact['avatar']);
+ $timestamp = time();
+
+ $fields['photo'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_SMALL, $timestamp);
+ $fields['thumb'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_THUMB, $timestamp);
+ $fields['micro'] = self::storeAvatarCache($image, $filename, Proxy::PIXEL_MICRO, $timestamp);
+
+ return $fields;
+ }
+
+ private static function getFilename(string $url, string $host): string
+ {
+ $guid = Item::guidFromUri($url, $host);
+
+ return substr($guid, 0, 2) . '/' . substr($guid, 3, 2) . '/' . substr($guid, 5, 3) . '/' .
+ substr($guid, 9, 2) .'/' . substr($guid, 11, 2) . '/' . substr($guid, 13, 4). '/' . substr($guid, 18) . '-';
+ }
+
+ private static function storeAvatarCache(Image $image, string $filename, int $size, int $timestamp): string
{
$image->scaleDown($size);
if (is_null($image) || !$image->isValid()) {
return '';
}
- $path = '/avatar/' . $filename . $size . '.' . $image->getExt();
+ $path = $filename . $size . '.' . $image->getExt();
- $filepath = DI::basePath() . $path;
+ $basepath = self::basePath();
+ if (empty($basepath)) {
+ return '';
+ }
- $dirpath = dirname($filepath);
+ $filepath = $basepath . $path;
+
+ $dirpath = $basepath;
DI::profiler()->startRecording('file');
- if (!file_exists($dirpath)) {
- mkdir($dirpath, 0775, true);
- } else {
- chmod($dirpath, 0775);
+ // Fetch the permission and group ownership of the "avatar" path and apply to all files
+ $dir_perm = fileperms($dirpath) & 0777;
+ $file_perm = fileperms($dirpath) & 0666;
+ $group = filegroup($dirpath);
+
+ // Check directory permissions of all parts of the path
+ foreach (explode('/', dirname($filename)) as $part) {
+ $dirpath .= $part . '/';
+
+ if (!file_exists($dirpath)) {
+ if (!@mkdir($dirpath, $dir_perm) && !file_exists($dirpath)) {
+ Logger::warning('Directory could not be created', ['directory' => $dirpath]);
+ }
+ } elseif ((($old_perm = fileperms($dirpath) & 0777) != $dir_perm) && !chmod($dirpath, $dir_perm)) {
+ Logger::warning('Directory permissions could not be changed', ['directory' => $dirpath, 'old' => $old_perm, 'new' => $dir_perm]);
+ }
+
+ if ((($old_group = filegroup($dirpath)) != $group) && !chgrp($dirpath, $group)) {
+ Logger::warning('Directory group could not be changed', ['directory' => $dirpath, 'old' => $old_group, 'new' => $group]);
+ }
+ }
+
+ if (!file_put_contents($filepath, $image->asString())) {
+ Logger::warning('File could not be created', ['file' => $filepath]);
+ }
+
+ $old_perm = fileperms($filepath) & 0666;
+ $old_group = filegroup($filepath);
+
+ if (($old_perm != $file_perm) && !chmod($filepath, $file_perm)) {
+ Logger::warning('File permissions could not be changed', ['file' => $filepath, 'old' => $old_perm, 'new' => $file_perm]);
}
- file_put_contents($filepath, $image->asString());
- chmod($filepath, 0664);
+ if (($old_group != $group) && !chgrp($filepath, $group)) {
+ Logger::warning('File group could not be changed', ['file' => $filepath, 'old' => $old_group, 'new' => $group]);
+ }
DI::profiler()->stopRecording();
return '';
}
- return DI::baseUrl() . $path;
+ return self::baseUrl() . $path . '?ts=' . $timestamp;
}
/**
*/
private static function getCacheFile(string $avatar): string
{
- if (empty($avatar) || !Network::isLocalLink($avatar)) {
+ $parts = parse_url($avatar);
+ if (empty($parts['host']) || ($parts['host'] != parse_url(self::baseUrl(), PHP_URL_HOST))) {
return '';
}
- $path = Strings::normaliseLink(DI::baseUrl() . '/avatar');
-
- if (Network::getUrlMatch($path, $avatar) != $path) {
+ $avatarpath = parse_url(self::baseUrl(), PHP_URL_PATH);
+ $pos = strpos($parts['path'], $avatarpath);
+ if ($pos !== 0) {
return '';
}
- $filename = str_replace($path, DI::basePath(). '/avatar/', Strings::normaliseLink($avatar));
+ $filename = self::basePath() . substr($parts['path'], strlen($avatarpath));
DI::profiler()->startRecording('file');
$exists = file_exists($filename);
* Delete locally cached avatar pictures of a contact
*
* @param string $avatar
- * @return void
+ * @return bool
*/
- public static function deleteCache(array $contact)
+ public static function deleteCache(array $contact): bool
{
+ $existed = (self::isCacheFile($contact['photo']) || self::isCacheFile($contact['thumb']) || self::isCacheFile($contact['micro']));
self::deleteCacheFile($contact['photo']);
self::deleteCacheFile($contact['thumb']);
self::deleteCacheFile($contact['micro']);
+
+ return $existed;
}
/**
{
$localFile = self::getCacheFile($avatar);
if (!empty($localFile)) {
- unlink($localFile);
+ @unlink($localFile);
Logger::debug('Unlink avatar', ['avatar' => $avatar]);
}
}
+
+ /**
+ * Fetch the avatar base path
+ *
+ * @return string
+ */
+ private static function basePath(): string
+ {
+ $basepath = DI::config()->get('system', 'avatar_cache_path');
+ if (empty($basepath)) {
+ $basepath = DI::basePath() . self::BASE_PATH;
+ }
+ $basepath = rtrim($basepath, '/') . '/';
+
+ if (!file_exists($basepath)) {
+ // We only automatically create the folder when it is in the web root
+ if (strpos($basepath, DI::basePath()) !== 0) {
+ Logger::warning('Base directory does not exist', ['directory' => $basepath]);
+ return '';
+ }
+ if (!mkdir($basepath, 0775)) {
+ Logger::warning('Base directory could not be created', ['directory' => $basepath]);
+ return '';
+ }
+ }
+
+ return $basepath;
+ }
+
+ /**
+ * Fetch the avatar base url
+ *
+ * @return string
+ */
+ private static function baseUrl(): string
+ {
+ $baseurl = DI::config()->get('system', 'avatar_cache_url');
+ if (!empty($baseurl)) {
+ return rtrim($baseurl, '/') . '/';
+ }
+
+ return DI::baseUrl() . self::BASE_PATH;
+ }
}
projects / friendica.git / blobdiff