src/Module/Proxy.php

   1 <?php
   2 /**
   3  * @file src/Module/Proxy.php
   4  * @brief Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
   5  */
   6 namespace Friendica\Module;
   7
   8 use Friendica\BaseModule;
   9 use Friendica\Core\L10n;
  10 use Friendica\Core\System;
  11 use Friendica\Core\Logger;
  12 use Friendica\Model\Photo;
  13 use Friendica\Object\Image;
  14 use Friendica\Util\HTTPSignature;
  15 use Friendica\Util\Proxy as ProxyUtils;
  16
  17 /**
  18  * @brief Module Proxy
  19  *
  20  * urls:
  21  * /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
  22  * /proxy?url=<image url>
  23  */
  24 class Proxy extends BaseModule
  25 {
  26
  27         /**
  28          * @brief Initializer method for this class.
  29          *
  30          * Sets application instance and checks if /proxy/ path is writable.
  31          *
  32          */
  33         public static function init($parameters)
  34         {
  35                 // Set application instance here
  36                 $a = self::getApp();
  37
  38                 /*
  39                  * Pictures are stored in one of the following ways:
  40                  *
  41                  * 1. If a folder "proxy" exists and is writeable, then use this for caching
  42                  * 2. If a cache path is defined, use this
  43                  * 3. If everything else failed, cache into the database
  44                  *
  45                  * Question: Do we really need these three methods?
  46                  */
  47                 if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && isset($_SERVER['HTTP_IF_NONE_MATCH'])) {
  48                         header('HTTP/1.1 304 Not Modified');
  49                         header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
  50                         header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']);
  51                         header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
  52                         header('Cache-Control: max-age=31536000');
  53
  54                         if (function_exists('header_remove')) {
  55                                 header_remove('Last-Modified');
  56                                 header_remove('Expires');
  57                                 header_remove('Cache-Control');
  58                         }
  59
  60                         /// @TODO Stop here?
  61                         exit();
  62                 }
  63
  64                 if (function_exists('header_remove')) {
  65                         header_remove('Pragma');
  66                         header_remove('pragma');
  67                 }
  68
  69                 $direct_cache = self::setupDirectCache();
  70
  71                 $request = self::getRequestInfo();
  72
  73                 if (empty($request['url'])) {
  74                         throw new \Friendica\Network\HTTPException\BadRequestException();
  75                 }
  76
  77                 // Webserver already tried direct cache...
  78
  79                 // Try to use filecache;
  80                 $cachefile = self::responseFromCache($request);
  81
  82                 // Try to use photo from db
  83                 self::responseFromDB($request);
  84
  85                 //
  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.
  88                 //
  89
  90                 // It shouldn't happen but it does - spaces in URL
  91                 $request['url'] = str_replace(' ', '+', $request['url']);
  92                 $fetchResult = HTTPSignature::fetchRaw($request['url'], local_user(), true, ['timeout' => 10]);
  93                 $img_str = $fetchResult->getBody();
  94
  95                 // If there is an error then return a blank image
  96                 if ((substr($fetchResult->getReturnCode(), 0, 1) == '4') || empty($img_str)) {
  97                         Logger::info('Error fetching image', ['image' => $request['url'], 'return' => $fetchResult->getReturnCode(), 'empty' => empty($img_str)]);
  98                         self::responseError();
  99                         // stop.
 100                 }
 101
 102                 $tempfile = tempnam(get_temppath(), 'cache');
 103                 file_put_contents($tempfile, $img_str);
 104                 $mime = mime_content_type($tempfile);
 105                 unlink($tempfile);
 106
 107                 $image = new Image($img_str, $mime);
 108                 if (!$image->isValid()) {
 109                         Logger::info('The image is invalid', ['image' => $request['url'], 'mime' => $mime]);
 110                         self::responseError();
 111                         // stop.
 112                 }
 113
 114                 $basepath = $a->getBasePath();
 115
 116                 // Store original image
 117                 if ($direct_cache) {
 118                         // direct cache , store under ./proxy/
 119                         file_put_contents($basepath . '/proxy/' . ProxyUtils::proxifyUrl($request['url'], true), $image->asString());
 120                 } elseif($cachefile !== '') {
 121                         // cache file
 122                         file_put_contents($cachefile, $image->asString());
 123                 } else {
 124                         // database
 125                         Photo::store($image, 0, 0, $request['urlhash'], $request['url'], '', 100);
 126                 }
 127
 128
 129                 // reduce quality - if it isn't a GIF
 130                 if ($image->getType() != 'image/gif') {
 131                         $image->scaleDown($request['size']);
 132                 }
 133
 134
 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());
 138                 }
 139
 140                 self::responseImageHttpCache($image);
 141                 // stop.
 142         }
 143
 144
 145         /**
 146          * @brief Build info about requested image to be proxied
 147          *
 148          * @return array
 149          *    [
 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'
 154          *    ]
 155          * @throws \Exception
 156          */
 157         private static function getRequestInfo()
 158         {
 159                 $a = self::getApp();
 160                 $size = 1024;
 161                 $sizetype = '';
 162
 163                 // Look for filename in the arguments
 164                 // @TODO: Replace with parameter from router
 165                 if (($a->argc > 1) && !isset($_REQUEST['url'])) {
 166                         if (isset($a->argv[3])) {
 167                                 $url = $a->argv[3];
 168                         } elseif (isset($a->argv[2])) {
 169                                 $url = $a->argv[2];
 170                         } else {
 171                                 $url = $a->argv[1];
 172                         }
 173
 174                         /// @TODO: Why? And what about $url in this case?
 175                         /// @TODO: Replace with parameter from router
 176                         if (isset($a->argv[3]) && ($a->argv[3] == 'thumb')) {
 177                                 $size = 200;
 178                         }
 179
 180                         // thumb, small, medium and large.
 181                         if (substr($url, -6) == ':micro') {
 182                                 $size = 48;
 183                                 $sizetype = ':micro';
 184                                 $url = substr($url, 0, -6);
 185                         } elseif (substr($url, -6) == ':thumb') {
 186                                 $size = 80;
 187                                 $sizetype = ':thumb';
 188                                 $url = substr($url, 0, -6);
 189                         } elseif (substr($url, -6) == ':small') {
 190                                 $size = 300;
 191                                 $url = substr($url, 0, -6);
 192                                 $sizetype = ':small';
 193                         } elseif (substr($url, -7) == ':medium') {
 194                                 $size = 600;
 195                                 $url = substr($url, 0, -7);
 196                                 $sizetype = ':medium';
 197                         } elseif (substr($url, -6) == ':large') {
 198                                 $size = 1024;
 199                                 $url = substr($url, 0, -6);
 200                                 $sizetype = ':large';
 201                         }
 202
 203                         $pos = strrpos($url, '=.');
 204                         if ($pos) {
 205                                 $url = substr($url, 0, $pos + 1);
 206                         }
 207
 208                         $url = str_replace(['.jpg', '.jpeg', '.gif', '.png'], ['','','',''], $url);
 209
 210                         $url = base64_decode(strtr($url, '-_', '+/'), true);
 211
 212                 } else {
 213                         $url = $_REQUEST['url'] ?? '';
 214                 }
 215
 216                 return [
 217                         'url' => $url,
 218                         'urlhash' => 'pic:' . sha1($url),
 219                         'size' => $size,
 220                         'sizetype' => $sizetype,
 221                 ];
 222         }
 223
 224
 225         /**
 226          * @brief setup ./proxy folder for direct cache
 227          *
 228          * @return bool  False if direct cache can't be used.
 229          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 230          */
 231         private static function setupDirectCache()
 232         {
 233                 $a = self::getApp();
 234                 $basepath = $a->getBasePath();
 235
 236                 // If the cache path isn't there, try to create it
 237                 if (!is_dir($basepath . '/proxy') && is_writable($basepath)) {
 238                         mkdir($basepath . '/proxy');
 239                 }
 240
 241                 // Checking if caching into a folder in the webroot is activated and working
 242                 $direct_cache = (is_dir($basepath . '/proxy') && is_writable($basepath . '/proxy'));
 243                 // we don't use direct cache if image url is passed in args and not in querystring
 244                 $direct_cache = $direct_cache && ($a->argc > 1) && !isset($_REQUEST['url']);
 245
 246                 return $direct_cache;
 247         }
 248
 249
 250         /**
 251          * @brief Try to reply with image in cachefile
 252          *
 253          * @param array $request Array from getRequestInfo
 254          *
 255          * @return string  Cache file name, empty string if cache is not enabled.
 256          *
 257          * If cachefile exists, script ends here and this function will never returns
 258          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 259          * @throws \ImagickException
 260          */
 261         private static function responseFromCache(&$request)
 262         {
 263                 $cachefile = get_cachefile(hash('md5', $request['url']));
 264                 if ($cachefile != '' && file_exists($cachefile)) {
 265                         $img = new Image(file_get_contents($cachefile), mime_content_type($cachefile));
 266                         self::responseImageHttpCache($img);
 267                         // stop.
 268                 }
 269                 return $cachefile;
 270         }
 271
 272         /**
 273          * @brief Try to reply with image in database
 274          *
 275          * @param array $request Array from getRequestInfo
 276          *
 277          * If the image exists in database, then script ends here and this function will never returns
 278          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 279          * @throws \ImagickException
 280          */
 281         private static function responseFromDB(&$request)
 282         {
 283                 $photo = Photo::getPhoto($request['urlhash']);
 284
 285                 if ($photo !== false) {
 286                         $img = Photo::getImageForPhoto($photo);
 287                         self::responseImageHttpCache($img);
 288                         // stop.
 289                 }
 290         }
 291
 292         /**
 293          * In case of an error just stop. We don't return content to avoid caching problems
 294          *
 295          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 296          */
 297         private static function responseError()
 298         {
 299                 throw new \Friendica\Network\HTTPException\InternalServerErrorException();
 300         }
 301
 302         /**
 303          * @brief Output the image with cache headers
 304          *
 305          * @param Image $img
 306          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 307          */
 308         private static function responseImageHttpCache(Image $img)
 309         {
 310                 if (is_null($img) || !$img->isValid()) {
 311                         Logger::info('The cached image is invalid');
 312                         self::responseError();
 313                         // stop.
 314                 }
 315                 header('Content-type: ' . $img->getType());
 316                 header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
 317                 header('Etag: "' . md5($img->asString()) . '"');
 318                 header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
 319                 header('Cache-Control: max-age=31536000');
 320                 echo $img->asString();
 321                 exit();
 322         }
 323 }