3 * @file src/Module/Proxy.php
4 * @brief Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
6 namespace Friendica\Module;
8 use Friendica\BaseModule;
9 use Friendica\Core\L10n;
10 use Friendica\Core\System;
11 use Friendica\Model\Photo;
12 use Friendica\Object\Image;
13 use Friendica\Util\Network;
14 use Friendica\Util\Proxy as ProxyUtils;
20 * /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
21 * /proxy?url=<image url>
23 class Proxy extends BaseModule
27 * @brief Initializer method for this class.
29 * Sets application instance and checks if /proxy/ path is writable.
32 public static function init()
34 // Set application instance here
38 * Pictures are stored in one of the following ways:
40 * 1. If a folder "proxy" exists and is writeable, then use this for caching
41 * 2. If a cache path is defined, use this
42 * 3. If everything else failed, cache into the database
44 * Question: Do we really need these three methods?
46 if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && isset($_SERVER['HTTP_IF_NONE_MATCH'])) {
47 header('HTTP/1.1 304 Not Modified');
48 header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
49 header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']);
50 header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
51 header('Cache-Control: max-age=31536000');
53 if (function_exists('header_remove')) {
54 header_remove('Last-Modified');
55 header_remove('Expires');
56 header_remove('Cache-Control');
63 if (function_exists('header_remove')) {
64 header_remove('Pragma');
65 header_remove('pragma');
68 $direct_cache = self::setupDirectCache();
70 $request = self::getRequestInfo();
72 if (empty($request['url'])) {
73 System::httpExit(400, ['title' => L10n::t('Bad Request.')]);
76 // Webserver already tried direct cache...
78 // Try to use filecache;
79 $cachefile = self::responseFromCache($request);
81 // Try to use photo from db
82 self::responseFromDB($request);
86 // If script is here, the requested url has never cached before.
87 // Let's fetch it, scale it if required, then save it in cache.
91 // It shouldn't happen but it does - spaces in URL
92 $request['url'] = str_replace(' ', '+', $request['url']);
94 $fetchResult = Network::fetchUrlFull($request['url'], true, $redirects, 10);
95 $img_str = $fetchResult->getBody();
97 $tempfile = tempnam(get_temppath(), 'cache');
98 file_put_contents($tempfile, $img_str);
99 $mime = mime_content_type($tempfile);
102 // If there is an error then return a blank image
103 if ((substr($fetchResult->getReturnCode(), 0, 1) == '4') || (!$img_str)) {
104 self::responseError();
108 $image = new Image($img_str, $mime);
109 if (!$image->isValid()) {
110 self::responseError();
114 $basepath = $a->getBasePath();
116 // Store original image
118 // direct cache , store under ./proxy/
119 file_put_contents($basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true), $image->asString());
120 } elseif($cachefile !== '') {
122 file_put_contents($cachefile, $image->asString());
125 Photo::store($image, 0, 0, $request['urlhash'], $request['url'], '', 100);
129 // reduce quality - if it isn't a GIF
130 if ($image->getType() != 'image/gif') {
131 $image->scaleDown($request['size']);
135 // Store scaled image
136 if ($direct_cache && $request['sizetype'] != '') {
137 file_put_contents($basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true) . $request['sizetype'], $image->asString());
140 self::responseImageHttpCache($image);
146 * @brief Build info about requested image to be proxied
150 * 'url' => requested url,
151 * 'urlhash' => sha1 has of the url prefixed with 'pic:',
152 * 'size' => requested image size (int)
153 * 'sizetype' => requested image size (string): ':micro', ':thumb', ':small', ':medium', ':large'
157 private static function getRequestInfo()
164 // Look for filename in the arguments
165 if (($a->argc > 1) && !isset($_REQUEST['url'])) {
166 if (isset($a->argv[3])) {
168 } elseif (isset($a->argv[2])) {
174 /// @TODO: Why? And what about $url in this case?
175 if (isset($a->argv[3]) && ($a->argv[3] == 'thumb')) {
179 // thumb, small, medium and large.
180 if (substr($url, -6) == ':micro') {
182 $sizetype = ':micro';
183 $url = substr($url, 0, -6);
184 } elseif (substr($url, -6) == ':thumb') {
186 $sizetype = ':thumb';
187 $url = substr($url, 0, -6);
188 } elseif (substr($url, -6) == ':small') {
190 $url = substr($url, 0, -6);
191 $sizetype = ':small';
192 } elseif (substr($url, -7) == ':medium') {
194 $url = substr($url, 0, -7);
195 $sizetype = ':medium';
196 } elseif (substr($url, -6) == ':large') {
198 $url = substr($url, 0, -6);
199 $sizetype = ':large';
202 $pos = strrpos($url, '=.');
204 $url = substr($url, 0, $pos + 1);
207 $url = str_replace(['.jpg', '.jpeg', '.gif', '.png'], ['','','',''], $url);
209 $url = base64_decode(strtr($url, '-_', '+/'), true);
212 $url = defaults($_REQUEST, 'url', '');
217 'urlhash' => 'pic:' . sha1($url),
219 'sizetype' => $sizetype,
225 * @brief setup ./proxy folder for direct cache
227 * @return bool False if direct cache can't be used.
228 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
230 private static function setupDirectCache()
233 $basepath = $a->getBasePath();
235 // If the cache path isn't there, try to create it
236 if (!is_dir($basepath . '/proxy') && is_writable($basepath)) {
237 mkdir($basepath . '/proxy');
240 // Checking if caching into a folder in the webroot is activated and working
241 $direct_cache = (is_dir($basepath . '/proxy') && is_writable($basepath . '/proxy'));
242 // we don't use direct cache if image url is passed in args and not in querystring
243 $direct_cache = $direct_cache && ($a->argc > 1) && !isset($_REQUEST['url']);
245 return $direct_cache;
250 * @brief Try to reply with image in cachefile
252 * @param array $request Array from getRequestInfo
254 * @return string Cache file name, empty string if cache is not enabled.
256 * If cachefile exists, script ends here and this function will never returns
257 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
258 * @throws \ImagickException
260 private static function responseFromCache(&$request)
262 $cachefile = get_cachefile(hash('md5', $request['url']));
263 if ($cachefile != '' && file_exists($cachefile)) {
264 $img = new Image(file_get_contents($cachefile), mime_content_type($cachefile));
265 self::responseImageHttpCache($img);
272 * @brief Try to reply with image in database
274 * @param array $request Array from getRequestInfo
276 * If the image exists in database, then script ends here and this function will never returns
277 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
278 * @throws \ImagickException
280 private static function responseFromDB(&$request) {
282 $photo = Photo::getPhoto($request['urlhash']);
284 if ($photo !== false) {
285 $img = Photo::getImageForPhoto($photo);
286 self::responseImageHttpCache($img);
292 * @brief Output a blank image, without cache headers, in case of errors
295 private static function responseError() {
296 header('Content-type: image/png');
297 echo file_get_contents('images/blank.png');
302 * @brief Output the image with cache headers
305 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
307 private static function responseImageHttpCache(Image $img)
309 if (is_null($img) || !$img->isValid()) {
310 self::responseError();
313 header('Content-type: ' . $img->getType());
314 header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
315 header('Etag: "' . md5($img->asString()) . '"');
316 header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
317 header('Cache-Control: max-age=31536000');
318 echo $img->asString();