src/Module/Proxy.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module;
  23
  24 use Friendica\BaseModule;
  25 use Friendica\Core\Logger;
  26 use Friendica\DI;
  27 use Friendica\Model\Photo;
  28 use Friendica\Object\Image;
  29 use Friendica\Util\HTTPSignature;
  30 use Friendica\Util\Proxy as ProxyUtils;
  31
  32 /**
  33  * Module Proxy
  34  *
  35  * urls:
  36  * /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
  37  * /proxy?url=<image url>
  38  */
  39 class Proxy extends BaseModule
  40 {
  41
  42         /**
  43          * Initializer method for this class.
  44          *
  45          * Sets application instance and checks if /proxy/ path is writable.
  46          *
  47          */
  48         public static function init(array $parameters = [])
  49         {
  50                 // Set application instance here
  51                 $a = DI::app();
  52
  53                 /*
  54                  * Pictures are stored in one of the following ways:
  55                  *
  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
  59                  *
  60                  * Question: Do we really need these three methods?
  61                  */
  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');
  68
  69                         if (function_exists('header_remove')) {
  70                                 header_remove('Last-Modified');
  71                                 header_remove('Expires');
  72                                 header_remove('Cache-Control');
  73                         }
  74
  75                         /// @TODO Stop here?
  76                         exit();
  77                 }
  78
  79                 if (function_exists('header_remove')) {
  80                         header_remove('Pragma');
  81                         header_remove('pragma');
  82                 }
  83
  84                 $direct_cache = self::setupDirectCache();
  85
  86                 $request = self::getRequestInfo();
  87
  88                 if (empty($request['url'])) {
  89                         throw new \Friendica\Network\HTTPException\BadRequestException();
  90                 }
  91
  92                 // Webserver already tried direct cache...
  93
  94                 // Try to use filecache;
  95                 $cachefile = self::responseFromCache($request);
  96
  97                 // Try to use photo from db
  98                 self::responseFromDB($request);
  99
 100                 //
 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.
 103                 //
 104
 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();
 109
 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();
 114                         // stop.
 115                 }
 116
 117                 $tempfile = tempnam(get_temppath(), 'cache');
 118                 file_put_contents($tempfile, $img_str);
 119                 $mime = mime_content_type($tempfile);
 120                 unlink($tempfile);
 121
 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();
 126                         // stop.
 127                 }
 128
 129                 $basepath = $a->getBasePath();
 130
 131                 // Store original image
 132                 if ($direct_cache) {
 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'));
 137                 } elseif($cachefile !== '') {
 138                         // cache file
 139                         file_put_contents($cachefile, $image->asString());
 140                 } else {
 141                         // database
 142                         Photo::store($image, 0, 0, $request['urlhash'], $request['url'], '', 100);
 143                 }
 144
 145
 146                 // reduce quality - if it isn't a GIF
 147                 if ($image->getType() != 'image/gif') {
 148                         $image->scaleDown($request['size']);
 149                 }
 150
 151
 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'));
 157                 }
 158
 159                 self::responseImageHttpCache($image);
 160                 // stop.
 161         }
 162
 163
 164         /**
 165          * Build info about requested image to be proxied
 166          *
 167          * @return array
 168          *    [
 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'
 173          *    ]
 174          * @throws \Exception
 175          */
 176         private static function getRequestInfo()
 177         {
 178                 $a = DI::app();
 179                 $size = 1024;
 180                 $sizetype = '';
 181
 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])) {
 186                                 $url = $a->argv[3];
 187                         } elseif (isset($a->argv[2])) {
 188                                 $url = $a->argv[2];
 189                         } else {
 190                                 $url = $a->argv[1];
 191                         }
 192
 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')) {
 196                                 $size = 200;
 197                         }
 198
 199                         // thumb, small, medium and large.
 200                         if (substr($url, -6) == ':micro') {
 201                                 $size = 48;
 202                                 $sizetype = ':micro';
 203                                 $url = substr($url, 0, -6);
 204                         } elseif (substr($url, -6) == ':thumb') {
 205                                 $size = 80;
 206                                 $sizetype = ':thumb';
 207                                 $url = substr($url, 0, -6);
 208                         } elseif (substr($url, -6) == ':small') {
 209                                 $size = 300;
 210                                 $url = substr($url, 0, -6);
 211                                 $sizetype = ':small';
 212                         } elseif (substr($url, -7) == ':medium') {
 213                                 $size = 600;
 214                                 $url = substr($url, 0, -7);
 215                                 $sizetype = ':medium';
 216                         } elseif (substr($url, -6) == ':large') {
 217                                 $size = 1024;
 218                                 $url = substr($url, 0, -6);
 219                                 $sizetype = ':large';
 220                         }
 221
 222                         $pos = strrpos($url, '=.');
 223                         if ($pos) {
 224                                 $url = substr($url, 0, $pos + 1);
 225                         }
 226
 227                         $url = str_replace(['.jpg', '.jpeg', '.gif', '.png'], ['','','',''], $url);
 228
 229                         $url = base64_decode(strtr($url, '-_', '+/'), true);
 230
 231                 } else {
 232                         $url = $_REQUEST['url'] ?? '';
 233                 }
 234
 235                 return [
 236                         'url' => $url,
 237                         'urlhash' => 'pic:' . sha1($url),
 238                         'size' => $size,
 239                         'sizetype' => $sizetype,
 240                 ];
 241         }
 242
 243
 244         /**
 245          * setup ./proxy folder for direct cache
 246          *
 247          * @return bool  False if direct cache can't be used.
 248          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 249          */
 250         private static function setupDirectCache()
 251         {
 252                 $a = DI::app();
 253                 $basepath = $a->getBasePath();
 254
 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');
 258                 }
 259
 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']);
 264
 265                 return $direct_cache;
 266         }
 267
 268
 269         /**
 270          * Try to reply with image in cachefile
 271          *
 272          * @param array $request Array from getRequestInfo
 273          *
 274          * @return string  Cache file name, empty string if cache is not enabled.
 275          *
 276          * If cachefile exists, script ends here and this function will never returns
 277          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 278          * @throws \ImagickException
 279          */
 280         private static function responseFromCache(&$request)
 281         {
 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);
 286                         // stop.
 287                 }
 288                 return $cachefile;
 289         }
 290
 291         /**
 292          * Try to reply with image in database
 293          *
 294          * @param array $request Array from getRequestInfo
 295          *
 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
 299          */
 300         private static function responseFromDB(&$request)
 301         {
 302                 $photo = Photo::getPhoto($request['urlhash']);
 303
 304                 if ($photo !== false) {
 305                         $img = Photo::getImageForPhoto($photo);
 306                         self::responseImageHttpCache($img);
 307                         // stop.
 308                 }
 309         }
 310
 311         /**
 312          * In case of an error just stop. We don't return content to avoid caching problems
 313          *
 314          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 315          */
 316         private static function responseError()
 317         {
 318                 throw new \Friendica\Network\HTTPException\InternalServerErrorException();
 319         }
 320
 321         /**
 322          * Output the image with cache headers
 323          *
 324          * @param Image $img
 325          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 326          */
 327         private static function responseImageHttpCache(Image $img)
 328         {
 329                 if (is_null($img) || !$img->isValid()) {
 330                         Logger::info('The cached image is invalid');
 331                         self::responseError();
 332                         // stop.
 333                 }
 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();
 340                 exit();
 341         }
 342 }