]> git.mxchange.org Git - friendica.git/blobdiff - src/Contact/Avatar.php
Merge remote-tracking branch 'upstream/develop' into restricted-access
[friendica.git] / src / Contact / Avatar.php
index ed2cf9a50aedbc1f225cd6c1dcba9c181d8461ef..fc4b7e38cba62279c37d05ca04877e5fa71f5163 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
  *
@@ -32,7 +32,6 @@ use Friendica\Util\HTTPSignature;
 use Friendica\Util\Images;
 use Friendica\Util\Network;
 use Friendica\Util\Proxy;
-use Friendica\Util\Strings;
 
 /**
  * functions for handling contact avatar caching
@@ -58,7 +57,8 @@ class Avatar
                        return $fields;
                }
 
-               if (Network::isLocalLink($avatar)) {
+               if (Network::isLocalLink($avatar) || empty($avatar)) {
+                       self::deleteCache($contact);
                        return $fields;
                }
 
@@ -73,7 +73,12 @@ class Avatar
                        return $fields;
                }
 
-               $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)) {
@@ -87,11 +92,14 @@ class Avatar
                        return $fields;
                }
 
-               $filename = self::getFilename($contact['url']);
-               
-               $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]);
 
@@ -107,39 +115,46 @@ class Avatar
                        return $fields;
                }
 
-               if (Network::isLocalLink($contact['avatar'])) {
+               if (Network::isLocalLink($contact['avatar']) || empty($contact['avatar'])) {
+                       self::deleteCache($contact);
                        return $fields;
                }
 
-               $filename = self::getFilename($contact['url']);
-               
-               $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'], $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)
+       private static function getFilename(string $url, string $host): string
        {
-               $guid = Item::guidFromUri($url, parse_url($url, PHP_URL_HOST));
+               $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): string
+       private static function storeAvatarCache(Image $image, string $filename, int $size, int $timestamp): string
        {
                $image->scaleDown($size);
                if (is_null($image) || !$image->isValid()) {
                        return '';
                }
 
-               $path = self::BASE_PATH . $filename . $size . '.' . $image->getExt();
+               $path = $filename . $size . '.' . $image->getExt();
+
+               $basepath = self::basePath();
+               if (empty($basepath)) {
+                       return '';
+               }
 
-               $filepath = DI::basePath() . $path;
+               $filepath = $basepath . $path;
 
-               $dirpath = DI::basePath() . self::BASE_PATH;
+               $dirpath = $basepath;
 
                DI::profiler()->startRecording('file');
 
@@ -153,15 +168,15 @@ class Avatar
                        $dirpath .= $part . '/';
 
                        if (!file_exists($dirpath)) {
-                               if (!mkdir($dirpath, $dir_perm)) {
+                               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::notice('Directory permissions could not be changed', ['directory' => $dirpath, 'old' => $old_perm, 'new' => $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::notice('Directory group could not be changed', ['directory' => $dirpath, 'old' => $old_group, 'new' => $group]);
+                               Logger::warning('Directory group could not be changed', ['directory' => $dirpath, 'old' => $old_group, 'new' => $group]);
                        }
                }
 
@@ -173,11 +188,11 @@ class Avatar
                $old_group = filegroup($filepath);
 
                if (($old_perm != $file_perm) && !chmod($filepath, $file_perm)) {
-                       Logger::notice('File permissions could not be changed', ['file' => $filepath, 'old' => $old_perm, 'new' => $file_perm]);
+                       Logger::warning('File permissions could not be changed', ['file' => $filepath, 'old' => $old_perm, 'new' => $file_perm]);
                }
 
                if (($old_group != $group) && !chgrp($filepath, $group)) {
-                       Logger::notice('File group could not be changed', ['file' => $filepath, 'old' => $old_group, 'new' => $group]);
+                       Logger::warning('File group could not be changed', ['file' => $filepath, 'old' => $old_group, 'new' => $group]);
                }
 
                DI::profiler()->stopRecording();
@@ -187,7 +202,7 @@ class Avatar
                        return '';
                }
 
-               return DI::baseUrl() . $path;
+               return self::baseUrl() . $path . '?ts=' . $timestamp;
        }
 
        /**
@@ -209,17 +224,18 @@ class Avatar
         */
        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() . self::BASE_PATH);
-
-               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(). self::BASE_PATH, Strings::normaliseLink($avatar));
+               $filename = self::basePath() . substr($parts['path'], strlen($avatarpath));
 
                DI::profiler()->startRecording('file');
                $exists = file_exists($filename);
@@ -235,13 +251,16 @@ class Avatar
         * 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;
        }
 
        /**
@@ -254,8 +273,51 @@ class Avatar
        {
                $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;
+       }
 }