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