3 namespace Friendica\Util;
5 use Friendica\BaseObject;
6 use Friendica\Core\Config;
7 use Friendica\Core\System;
11 * @brief Proxy utilities class
17 * Default time to keep images in proxy storage
19 const DEFAULT_TIME = 86400; // 1 Day
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';
34 * @todo Make this configurable?
36 private static $extensions = [
44 * @brief Private constructor
46 private function __construct () {
47 // No instances from utilities classes
51 * @brief Transform a remote URL into a local one.
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.
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
61 * @return string The proxyfied URL or relative path
62 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
64 public static function proxifyUrl($url, $writemode = false, $size = '')
66 // Get application instance
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') {
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);
84 // Is the proxy disabled?
85 if (Config::get('system', 'proxy_disabled')) {
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');
92 // Creating a sub directory to reduce the amount of files in the cache directory
93 $basepath = $a->getBasePath() . '/proxy';
95 $shortpath = hash('md5', $url);
96 $longpath = substr($shortpath, 0, 2);
98 if (is_dir($basepath) && $writemode && !is_dir($basepath . '/' . $longpath)) {
99 mkdir($basepath . '/' . $longpath);
100 chmod($basepath . '/' . $longpath, 0777);
103 $longpath .= '/' . strtr(base64_encode($url), '+/', '-_');
105 // Extract the URL extension
106 $extension = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION);
108 if (in_array($extension, self::$extensions)) {
109 $shortpath .= '.' . $extension;
110 $longpath .= '.' . $extension;
113 $proxypath = System::baseUrl() . '/proxy/' . $longpath;
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) {
123 } elseif (strlen($proxypath) > 250) {
124 return System::baseUrl() . '/proxy/' . $shortpath . '?url=' . urlencode($url);
125 } elseif ($writemode) {
128 return $proxypath . $size;
133 * @brief "Proxifies" HTML code's image tags
135 * "Proxifies", means replaces image URLs in given HTML code with those from
136 * proxy storage directory.
138 * @param string $html Un-proxified HTML code
140 * @return string Proxified HTML code
141 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
143 public static function proxifyHtml($html)
145 $html = str_replace(Strings::normaliseLink(System::baseUrl()) . '/', System::baseUrl() . '/', $html);
147 return preg_replace_callback('/(<img [^>]*src *= *["\'])([^"\']+)(["\'][^>]*>)/siU', 'self::replaceUrl', $html);
151 * @brief Checks if the URL is a local URL.
155 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
157 private static function isLocalImage($url)
159 if (substr($url, 0, 1) == '/') {
163 if (strtolower(substr($url, 0, 5)) == 'data:') {
167 // links normalised - bug #431
168 $baseurl = Strings::normaliseLink(System::baseUrl());
169 $url = Strings::normaliseLink($url);
171 return (substr($url, 0, strlen($baseurl)) == $baseurl);
175 * @brief Return the array of query string parameters from a URL
177 * @param string $url URL to parse
178 * @return array Associative array of query string parameters
180 private static function parseQuery($url)
182 $query = parse_url($url, PHP_URL_QUERY);
183 $query = html_entity_decode($query);
185 parse_str($query, $arr);
191 * @brief Call-back method to replace the UR
193 * @param array $matches Matches from preg_replace_callback()
194 * @return string Proxified HTML image tag
195 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
197 private static function replaceUrl(array $matches)
199 // if the picture seems to be from another picture cache then take the original source
200 $queryvar = self::parseQuery($matches[2]);
202 if (!empty($queryvar['url']) && substr($queryvar['url'], 0, 4) == 'http') {
203 $matches[2] = urldecode($queryvar['url']);
206 // Following line changed per bug #431
207 if (self::isLocalImage($matches[2])) {
208 return $matches[1] . $matches[2] . $matches[3];
211 // Return proxified HTML
212 return $matches[1] . self::proxifyUrl(htmlspecialchars_decode($matches[2])) . $matches[3];