src/Util/Proxy.php

   1 <?php
   2
   3 namespace Friendica\Util;
   4
   5 use Friendica\BaseModule;
   6 use Friendica\BaseObject;
   7 use Friendica\Core\Config;
   8 use Friendica\Core\System;
   9
  10 /**
  11  * @brief Proxy utilities class
  12  */
  13 class Proxy
  14 {
  15
  16         /**
  17          * Default time to keep images in proxy storage
  18          */
  19         const DEFAULT_TIME = 86400; // 1 Day
  20
  21         /**
  22          * Sizes constants
  23          */
  24         const SIZE_MICRO  = 'micro';
  25         const SIZE_THUMB  = 'thumb';
  26         const SIZE_SMALL  = 'small';
  27         const SIZE_MEDIUM = 'medium';
  28         const SIZE_LARGE  = 'large';
  29
  30         /**
  31          * Accepted extensions
  32          *
  33          * @var array
  34          * @todo Make this configurable?
  35          */
  36         private static $extensions = [
  37                 'jpg',
  38                 'jpeg',
  39                 'gif',
  40                 'png',
  41         ];
  42
  43         /**
  44          * @brief Private constructor
  45          */
  46         private function __construct () {
  47                 // No instances from utilities classes
  48         }
  49
  50         /**
  51          * @brief Transform a remote URL into a local one.
  52          *
  53          * This function only performs the URL replacement on http URL and if the
  54          * provided URL isn't local, "the isn't deactivated" (sic) and if the config
  55          * system.proxy_disabled is set to false.
  56          *
  57          * @param string $url       The URL to proxyfy
  58          * @param bool   $writemode Returns a local path the remote URL should be saved to
  59          * @param string $size      One of the ProxyUtils::SIZE_* constants
  60          *
  61          * @return string The proxyfied URL or relative path
  62          */
  63         public static function proxifyUrl($url, $writemode = false, $size = '')
  64         {
  65                 // Get application instance
  66                 $a = BaseObject::getApp();
  67
  68                 // Trim URL first
  69                 $url = trim($url);
  70
  71                 // Is no http in front of it?
  72                 /// @TODO To weak test for being a valid URL
  73                 if (substr($url, 0, 4) !== 'http') {
  74                         return $url;
  75                 }
  76
  77                 // Only continue if it isn't a local image and the isn't deactivated
  78                 if (self::isLocalImage($url)) {
  79                         $url = str_replace(normalise_link(System::baseUrl()) . '/', System::baseUrl() . '/', $url);
  80                         return $url;
  81                 }
  82
  83                 // Is the proxy disabled?
  84                 if (Config::get('system', 'proxy_disabled')) {
  85                         return $url;
  86                 }
  87
  88                 // Image URL may have encoded ampersands for display which aren't desirable for proxy
  89                 $url = html_entity_decode($url, ENT_NOQUOTES, 'utf-8');
  90
  91                 // Creating a sub directory to reduce the amount of files in the cache directory
  92                 $basepath = $a->getBasePath() . '/proxy';
  93
  94                 $shortpath = hash('md5', $url);
  95                 $longpath = substr($shortpath, 0, 2);
  96
  97                 if (is_dir($basepath) && $writemode && !is_dir($basepath . '/' . $longpath)) {
  98                         mkdir($basepath . '/' . $longpath);
  99                         chmod($basepath . '/' . $longpath, 0777);
 100                 }
 101
 102                 $longpath .= '/' . strtr(base64_encode($url), '+/', '-_');
 103
 104                 // Extract the URL extension
 105                 $extension = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION);
 106
 107                 if (in_array($extension, self::$extensions)) {
 108                         $shortpath .= '.' . $extension;
 109                         $longpath .= '.' . $extension;
 110                 }
 111
 112                 $proxypath = System::baseUrl() . '/proxy/' . $longpath;
 113
 114                 if ($size != '') {
 115                         $size = ':' . $size;
 116                 }
 117
 118                 // Too long files aren't supported by Apache
 119                 // Writemode in combination with long files shouldn't be possible
 120                 if ((strlen($proxypath) > 250) && $writemode) {
 121                         return $shortpath;
 122                 } elseif (strlen($proxypath) > 250) {
 123                         return System::baseUrl() . '/proxy/' . $shortpath . '?url=' . urlencode($url);
 124                 } elseif ($writemode) {
 125                         return $longpath;
 126                 } else {
 127                         return $proxypath . $size;
 128                 }
 129         }
 130
 131         /**
 132          * @brief "Proxifies" HTML code's image tags
 133          *
 134          * "Proxifies", means replaces image URLs in given HTML code with those from
 135          * proxy storage directory.
 136          *
 137          * @param string $html Un-proxified HTML code
 138          *
 139          * @return string Proxified HTML code
 140          */
 141         public static function proxifyHtml($html)
 142         {
 143                 $html = str_replace(normalise_link(System::baseUrl()) . '/', System::baseUrl() . '/', $html);
 144
 145                 return preg_replace_callback('/(<img [^>]*src *= *["\'])([^"\']+)(["\'][^>]*>)/siU', 'self::replaceUrl', $html);
 146         }
 147
 148         /**
 149          * @brief Checks if the URL is a local URL.
 150          *
 151          * @param string $url
 152          * @return boolean
 153          */
 154         private static function isLocalImage($url)
 155         {
 156                 if (substr($url, 0, 1) == '/') {
 157                         return true;
 158                 }
 159
 160                 if (strtolower(substr($url, 0, 5)) == 'data:') {
 161                         return true;
 162                 }
 163
 164                 // links normalised - bug #431
 165                 $baseurl = normalise_link(System::baseUrl());
 166                 $url = normalise_link($url);
 167
 168                 return (substr($url, 0, strlen($baseurl)) == $baseurl);
 169         }
 170
 171         /**
 172          * @brief Return the array of query string parameters from a URL
 173          *
 174          * @param string $url URL to parse
 175          * @return array Associative array of query string parameters
 176          */
 177         private static function parseQuery($url)
 178         {
 179                 $query = parse_url($url, PHP_URL_QUERY);
 180                 $query = html_entity_decode($query);
 181
 182                 parse_str($query, $arr);
 183
 184                 return $arr;
 185         }
 186
 187         /**
 188          * @brief Call-back method to replace the UR
 189          *
 190          * @param array $matches Matches from preg_replace_callback()
 191          * @return string Proxified HTML image tag
 192          */
 193         private static function replaceUrl(array $matches)
 194         {
 195                 // if the picture seems to be from another picture cache then take the original source
 196                 $queryvar = self::parseQuery($matches[2]);
 197
 198                 if (!empty($queryvar['url']) && substr($queryvar['url'], 0, 4) == 'http') {
 199                         $matches[2] = urldecode($queryvar['url']);
 200                 }
 201
 202                 // Following line changed per bug #431
 203                 if (self::isLocalImage($matches[2])) {
 204                         return $matches[1] . $matches[2] . $matches[3];
 205                 }
 206
 207                 // Return proxified HTML
 208                 return $matches[1] . self::proxifyUrl(htmlspecialchars_decode($matches[2])) . $matches[3];
 209         }
 210
 211 }