<?php
/**
- * @file src/Module/Proxy.php
- * @brief Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Module;
use Friendica\BaseModule;
-use Friendica\Core\L10n;
+use Friendica\Core\Logger;
use Friendica\Core\System;
-use Friendica\Model\Photo;
+use Friendica\DI;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
+use Friendica\Network\HTTPClient\Client\HttpClientOptions;
+use Friendica\Network\HTTPException\NotModifiedException;
use Friendica\Object\Image;
use Friendica\Util\HTTPSignature;
+use Friendica\Util\Images;
use Friendica\Util\Proxy as ProxyUtils;
-use Friendica\Core\Logger;
/**
- * @brief Module Proxy
+ * Module Proxy
*
* urls:
* /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
{
/**
- * @brief Initializer method for this class.
- *
- * Sets application instance and checks if /proxy/ path is writable.
- *
+ * Fetch remote image content
*/
- public static function init()
+ protected function rawContent(array $request = [])
{
- // Set application instance here
- $a = self::getApp();
+ $request = $this->getRequestInfo();
+
+ if (!DI::config()->get('system', 'proxify_content')) {
+ Logger::notice('Proxy access is forbidden', ['request' => $request, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'accept' => $_SERVER['HTTP_ACCEPT'] ?? '']);
+ throw new \Friendica\Network\HTTPException\NotFoundException();
+ }
- /*
- * Pictures are stored in one of the following ways:
- *
- * 1. If a folder "proxy" exists and is writeable, then use this for caching
- * 2. If a cache path is defined, use this
- * 3. If everything else failed, cache into the database
- *
- * Question: Do we really need these three methods?
- */
- if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && isset($_SERVER['HTTP_IF_NONE_MATCH'])) {
- header('HTTP/1.1 304 Not Modified');
+ if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
- header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']);
+ 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');
}
-
- /// @TODO Stop here?
- exit();
- }
-
- if (function_exists('header_remove')) {
- header_remove('Pragma');
- header_remove('pragma');
+ throw new NotModifiedException();
}
- $direct_cache = self::setupDirectCache();
-
- $request = self::getRequestInfo();
-
if (empty($request['url'])) {
- System::httpExit(400, ['title' => L10n::t('Bad Request.')]);
+ throw new \Friendica\Network\HTTPException\BadRequestException();
}
- // Webserver already tried direct cache...
-
- // Try to use filecache;
- $cachefile = self::responseFromCache($request);
-
- // Try to use photo from db
- self::responseFromDB($request);
-
- //
- // If script is here, the requested url has never cached before.
- // Let's fetch it, scale it if required, then save it in cache.
- //
+ if (!DI::userSession()->getLocalUserId()) {
+ Logger::debug('Redirecting not logged in user to original address', ['url' => $request['url']]);
+ System::externalRedirect($request['url']);
+ }
// It shouldn't happen but it does - spaces in URL
$request['url'] = str_replace(' ', '+', $request['url']);
- $fetchResult = HTTPSignature::fetchRaw($request['url'], local_user(), true, ['timeout' => 10]);
+
+ // Fetch the content with the local user
+ $fetchResult = HTTPSignature::fetchRaw($request['url'], DI::userSession()->getLocalUserId(), [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE], 'timeout' => 10]);
$img_str = $fetchResult->getBody();
- // If there is an error then return a blank image
- if ((substr($fetchResult->getReturnCode(), 0, 1) == '4') || (!$img_str)) {
+ if (!$fetchResult->isSuccess() || empty($img_str)) {
+ Logger::notice('Error fetching image', ['image' => $request['url'], 'return' => $fetchResult->getReturnCode(), 'empty' => empty($img_str)]);
self::responseError();
// stop.
}
- $tempfile = tempnam(get_temppath(), 'cache');
- file_put_contents($tempfile, $img_str);
- $mime = mime_content_type($tempfile);
- unlink($tempfile);
+ Logger::debug('Got picture', ['Content-Type' => $fetchResult->getHeader('Content-Type'), 'uid' => DI::userSession()->getLocalUserId(), 'image' => $request['url']]);
+
+ $mime = Images::getMimeTypeByData($img_str);
$image = new Image($img_str, $mime);
if (!$image->isValid()) {
+ Logger::notice('The image is invalid', ['image' => $request['url'], 'mime' => $mime]);
self::responseError();
// stop.
}
- $basepath = $a->getBasePath();
-
- // Store original image
- if ($direct_cache) {
- // direct cache , store under ./proxy/
- file_put_contents($basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true), $image->asString());
- } elseif($cachefile !== '') {
- // cache file
- file_put_contents($cachefile, $image->asString());
- } else {
- // database
- Photo::store($image, 0, 0, $request['urlhash'], $request['url'], '', 100);
- }
-
-
// reduce quality - if it isn't a GIF
if ($image->getType() != 'image/gif') {
$image->scaleDown($request['size']);
}
-
- // Store scaled image
- if ($direct_cache && $request['sizetype'] != '') {
- file_put_contents($basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true) . $request['sizetype'], $image->asString());
- }
-
self::responseImageHttpCache($image);
// stop.
}
-
/**
- * @brief Build info about requested image to be proxied
+ * Build info about requested image to be proxied
*
* @return array
* [
* 'url' => requested url,
- * 'urlhash' => sha1 has of the url prefixed with 'pic:',
* 'size' => requested image size (int)
* 'sizetype' => requested image size (string): ':micro', ':thumb', ':small', ':medium', ':large'
* ]
* @throws \Exception
*/
- private static function getRequestInfo()
+ private function getRequestInfo(): array
{
- $a = self::getApp();
- $size = 1024;
+ $size = ProxyUtils::PIXEL_LARGE;
$sizetype = '';
- // Look for filename in the arguments
- if (($a->argc > 1) && !isset($_REQUEST['url'])) {
- if (isset($a->argv[3])) {
- $url = $a->argv[3];
- } elseif (isset($a->argv[2])) {
- $url = $a->argv[2];
- } else {
- $url = $a->argv[1];
- }
-
- /// @TODO: Why? And what about $url in this case?
- if (isset($a->argv[3]) && ($a->argv[3] == 'thumb')) {
- $size = 200;
- }
+ if (!empty($this->parameters['url']) && empty($_REQUEST['url'])) {
+ $url = $this->parameters['url'];
// thumb, small, medium and large.
if (substr($url, -6) == ':micro') {
- $size = 48;
+ $size = ProxyUtils::PIXEL_MICRO;
$sizetype = ':micro';
$url = substr($url, 0, -6);
} elseif (substr($url, -6) == ':thumb') {
- $size = 80;
+ $size = ProxyUtils::PIXEL_THUMB;
$sizetype = ':thumb';
$url = substr($url, 0, -6);
} elseif (substr($url, -6) == ':small') {
- $size = 300;
+ $size = ProxyUtils::PIXEL_SMALL;
$url = substr($url, 0, -6);
$sizetype = ':small';
} elseif (substr($url, -7) == ':medium') {
- $size = 600;
+ $size = ProxyUtils::PIXEL_MEDIUM;
$url = substr($url, 0, -7);
$sizetype = ':medium';
} elseif (substr($url, -6) == ':large') {
- $size = 1024;
+ $size = ProxyUtils::PIXEL_LARGE;
$url = substr($url, 0, -6);
$sizetype = ':large';
}
$url = str_replace(['.jpg', '.jpeg', '.gif', '.png'], ['','','',''], $url);
$url = base64_decode(strtr($url, '-_', '+/'), true);
-
} else {
- $url = defaults($_REQUEST, 'url', '');
+ $url = $_REQUEST['url'] ?? '';
}
return [
'url' => $url,
- 'urlhash' => 'pic:' . sha1($url),
'size' => $size,
'sizetype' => $sizetype,
];
}
-
- /**
- * @brief setup ./proxy folder for direct cache
- *
- * @return bool False if direct cache can't be used.
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- private static function setupDirectCache()
- {
- $a = self::getApp();
- $basepath = $a->getBasePath();
-
- // If the cache path isn't there, try to create it
- if (!is_dir($basepath . '/proxy') && is_writable($basepath)) {
- mkdir($basepath . '/proxy');
- }
-
- // Checking if caching into a folder in the webroot is activated and working
- $direct_cache = (is_dir($basepath . '/proxy') && is_writable($basepath . '/proxy'));
- // we don't use direct cache if image url is passed in args and not in querystring
- $direct_cache = $direct_cache && ($a->argc > 1) && !isset($_REQUEST['url']);
-
- return $direct_cache;
- }
-
-
- /**
- * @brief Try to reply with image in cachefile
- *
- * @param array $request Array from getRequestInfo
- *
- * @return string Cache file name, empty string if cache is not enabled.
- *
- * If cachefile exists, script ends here and this function will never returns
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- * @throws \ImagickException
- */
- private static function responseFromCache(&$request)
- {
- $cachefile = get_cachefile(hash('md5', $request['url']));
- if ($cachefile != '' && file_exists($cachefile)) {
- $img = new Image(file_get_contents($cachefile), mime_content_type($cachefile));
- self::responseImageHttpCache($img);
- // stop.
- }
- return $cachefile;
- }
-
/**
- * @brief Try to reply with image in database
- *
- * @param array $request Array from getRequestInfo
+ * In case of an error just stop. We don't return content to avoid caching problems
*
- * If the image exists in database, then script ends here and this function will never returns
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
- * @throws \ImagickException
- */
- private static function responseFromDB(&$request)
- {
- $photo = Photo::getPhoto($request['urlhash']);
-
- if ($photo !== false) {
- $img = Photo::getImageForPhoto($photo);
- self::responseImageHttpCache($img);
- // stop.
- }
- }
-
- /**
- * @brief Output a blank image, without cache headers, in case of errors
- *
*/
private static function responseError()
{
- header('Content-type: image/png');
- echo file_get_contents('images/blank.png');
- exit();
+ throw new \Friendica\Network\HTTPException\InternalServerErrorException();
}
/**
- * @brief Output the image with cache headers
+ * Output the image with cache headers
*
* @param Image $img
+ * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function responseImageHttpCache(Image $img)
{
if (is_null($img) || !$img->isValid()) {
+ Logger::notice('The cached image is invalid');
self::responseError();
// stop.
}
header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
header('Cache-Control: max-age=31536000');
echo $img->asString();
- exit();
+ System::exit();
}
}