3 * @copyright Copyright (C) 2020, Friendica
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\Module;
24 use Friendica\BaseModule;
25 use Friendica\Core\Logger;
27 use Friendica\Model\Photo;
28 use Friendica\Object\Image;
29 use Friendica\Util\HTTPSignature;
30 use Friendica\Util\Proxy as ProxyUtils;
36 * /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
37 * /proxy?url=<image url>
39 class Proxy extends BaseModule
43 * Initializer method for this class.
45 * Sets application instance and checks if /proxy/ path is writable.
48 public static function init(array $parameters = [])
50 // Set application instance here
54 * Pictures are stored in one of the following ways:
56 * 1. If a folder "proxy" exists and is writeable, then use this for caching
57 * 2. If a cache path is defined, use this
58 * 3. If everything else failed, cache into the database
60 * Question: Do we really need these three methods?
62 if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && isset($_SERVER['HTTP_IF_NONE_MATCH'])) {
63 header('HTTP/1.1 304 Not Modified');
64 header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
65 header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']);
66 header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
67 header('Cache-Control: max-age=31536000');
69 if (function_exists('header_remove')) {
70 header_remove('Last-Modified');
71 header_remove('Expires');
72 header_remove('Cache-Control');
79 if (function_exists('header_remove')) {
80 header_remove('Pragma');
81 header_remove('pragma');
84 $direct_cache = self::setupDirectCache();
86 $request = self::getRequestInfo();
88 if (empty($request['url'])) {
89 throw new \Friendica\Network\HTTPException\BadRequestException();
92 // Webserver already tried direct cache...
94 // Try to use filecache;
95 $cachefile = self::responseFromCache($request);
97 // Try to use photo from db
98 self::responseFromDB($request);
101 // If script is here, the requested url has never cached before.
102 // Let's fetch it, scale it if required, then save it in cache.
105 // It shouldn't happen but it does - spaces in URL
106 $request['url'] = str_replace(' ', '+', $request['url']);
107 $fetchResult = HTTPSignature::fetchRaw($request['url'], local_user(), ['timeout' => 10]);
108 $img_str = $fetchResult->getBody();
110 // If there is an error then return a blank image
111 if ((substr($fetchResult->getReturnCode(), 0, 1) == '4') || empty($img_str)) {
112 Logger::info('Error fetching image', ['image' => $request['url'], 'return' => $fetchResult->getReturnCode(), 'empty' => empty($img_str)]);
113 self::responseError();
117 $tempfile = tempnam(get_temppath(), 'cache');
118 file_put_contents($tempfile, $img_str);
119 $mime = mime_content_type($tempfile);
122 $image = new Image($img_str, $mime);
123 if (!$image->isValid()) {
124 Logger::info('The image is invalid', ['image' => $request['url'], 'mime' => $mime]);
125 self::responseError();
129 $basepath = $a->getBasePath();
131 // Store original image
133 // direct cache , store under ./proxy/
134 $filename = $basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true);
135 file_put_contents($filename, $image->asString());
136 chmod($filename, DI::config()->get('system', 'proxy_file_chmod', 0640));
137 } elseif($cachefile !== '') {
139 file_put_contents($cachefile, $image->asString());
142 Photo::store($image, 0, 0, $request['urlhash'], $request['url'], '', 100);
146 // reduce quality - if it isn't a GIF
147 if ($image->getType() != 'image/gif') {
148 $image->scaleDown($request['size']);
152 // Store scaled image
153 if ($direct_cache && $request['sizetype'] != '') {
154 $filename = $basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true) . $request['sizetype'];
155 file_put_contents($filename, $image->asString());
156 chmod($filename, DI::config()->get('system', 'proxy_file_chmod', 0640));
159 self::responseImageHttpCache($image);
165 * Build info about requested image to be proxied
169 * 'url' => requested url,
170 * 'urlhash' => sha1 has of the url prefixed with 'pic:',
171 * 'size' => requested image size (int)
172 * 'sizetype' => requested image size (string): ':micro', ':thumb', ':small', ':medium', ':large'
176 private static function getRequestInfo()
182 // Look for filename in the arguments
183 // @TODO: Replace with parameter from router
184 if (($a->argc > 1) && !isset($_REQUEST['url'])) {
185 if (isset($a->argv[3])) {
187 } elseif (isset($a->argv[2])) {
193 /// @TODO: Why? And what about $url in this case?
194 /// @TODO: Replace with parameter from router
195 if (isset($a->argv[3]) && ($a->argv[3] == 'thumb')) {
199 // thumb, small, medium and large.
200 if (substr($url, -6) == ':micro') {
202 $sizetype = ':micro';
203 $url = substr($url, 0, -6);
204 } elseif (substr($url, -6) == ':thumb') {
206 $sizetype = ':thumb';
207 $url = substr($url, 0, -6);
208 } elseif (substr($url, -6) == ':small') {
210 $url = substr($url, 0, -6);
211 $sizetype = ':small';
212 } elseif (substr($url, -7) == ':medium') {
214 $url = substr($url, 0, -7);
215 $sizetype = ':medium';
216 } elseif (substr($url, -6) == ':large') {
218 $url = substr($url, 0, -6);
219 $sizetype = ':large';
222 $pos = strrpos($url, '=.');
224 $url = substr($url, 0, $pos + 1);
227 $url = str_replace(['.jpg', '.jpeg', '.gif', '.png'], ['','','',''], $url);
229 $url = base64_decode(strtr($url, '-_', '+/'), true);
232 $url = $_REQUEST['url'] ?? '';
237 'urlhash' => 'pic:' . sha1($url),
239 'sizetype' => $sizetype,
245 * setup ./proxy folder for direct cache
247 * @return bool False if direct cache can't be used.
248 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
250 private static function setupDirectCache()
253 $basepath = $a->getBasePath();
255 // If the cache path isn't there, try to create it
256 if (!is_dir($basepath . '/proxy') && is_writable($basepath)) {
257 mkdir($basepath . '/proxy');
260 // Checking if caching into a folder in the webroot is activated and working
261 $direct_cache = (is_dir($basepath . '/proxy') && is_writable($basepath . '/proxy'));
262 // we don't use direct cache if image url is passed in args and not in querystring
263 $direct_cache = $direct_cache && ($a->argc > 1) && !isset($_REQUEST['url']);
265 return $direct_cache;
270 * Try to reply with image in cachefile
272 * @param array $request Array from getRequestInfo
274 * @return string Cache file name, empty string if cache is not enabled.
276 * If cachefile exists, script ends here and this function will never returns
277 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
278 * @throws \ImagickException
280 private static function responseFromCache(&$request)
282 $cachefile = get_cachefile(hash('md5', $request['url']));
283 if ($cachefile != '' && file_exists($cachefile)) {
284 $img = new Image(file_get_contents($cachefile), mime_content_type($cachefile));
285 self::responseImageHttpCache($img);
292 * Try to reply with image in database
294 * @param array $request Array from getRequestInfo
296 * If the image exists in database, then script ends here and this function will never returns
297 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
298 * @throws \ImagickException
300 private static function responseFromDB(&$request)
302 $photo = Photo::getPhoto($request['urlhash']);
304 if ($photo !== false) {
305 $img = Photo::getImageForPhoto($photo);
306 self::responseImageHttpCache($img);
312 * In case of an error just stop. We don't return content to avoid caching problems
314 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
316 private static function responseError()
318 throw new \Friendica\Network\HTTPException\InternalServerErrorException();
322 * Output the image with cache headers
325 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
327 private static function responseImageHttpCache(Image $img)
329 if (is_null($img) || !$img->isValid()) {
330 Logger::info('The cached image is invalid');
331 self::responseError();
334 header('Content-type: ' . $img->getType());
335 header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
336 header('Etag: "' . md5($img->asString()) . '"');
337 header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
338 header('Cache-Control: max-age=31536000');
339 echo $img->asString();