]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/Proxy.php
Simplified proxy handling
[friendica.git] / src / Util / Proxy.php
index 3473e8d167ddf9b578d8390f02d5b4d3fe7af83a..839442797ef8ed3b7a29bb3df63874266952fe7e 100644 (file)
@@ -1,16 +1,30 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Util;
 
-use Friendica\BaseModule;
-use Friendica\BaseObject;
-use Friendica\Core\Config;
-use Friendica\Core\System;
-
-require_once 'include/security.php';
+use Friendica\DI;
 
 /**
- * @brief Proxy utilities class
+ * Proxy utilities class
  */
 class Proxy
 {
@@ -23,11 +37,20 @@ class Proxy
        /**
         * Sizes constants
         */
-       const SIZE_MICRO  = 'micro';
-       const SIZE_THUMB  = 'thumb';
-       const SIZE_SMALL  = 'small';
-       const SIZE_MEDIUM = 'medium';
-       const SIZE_LARGE  = 'large';
+       const SIZE_MICRO  = 'micro'; // 48
+       const SIZE_THUMB  = 'thumb'; // 80
+       const SIZE_SMALL  = 'small'; // 300
+       const SIZE_MEDIUM = 'medium'; // 600
+       const SIZE_LARGE  = 'large'; // 1024
+
+       /**
+        * Pixel Sizes
+        */
+       const PIXEL_MICRO  = 48;
+       const PIXEL_THUMB  = 80;
+       const PIXEL_SMALL  = 300;
+       const PIXEL_MEDIUM = 600;
+       const PIXEL_LARGE  = 1024;
 
        /**
         * Accepted extensions
@@ -43,29 +66,29 @@ class Proxy
        ];
 
        /**
-        * @brief Private constructor
+        * Private constructor
         */
        private function __construct () {
                // No instances from utilities classes
        }
 
        /**
-        * @brief Transform a remote URL into a local one.
+        * Transform a remote URL into a local one.
         *
         * This function only performs the URL replacement on http URL and if the
         * provided URL isn't local, "the isn't deactivated" (sic) and if the config
         * system.proxy_disabled is set to false.
         *
         * @param string $url       The URL to proxyfy
-        * @param bool   $writemode Returns a local path the remote URL should be saved to
         * @param string $size      One of the ProxyUtils::SIZE_* constants
         *
         * @return string The proxyfied URL or relative path
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function proxifyUrl($url, $writemode = false, $size = '')
+       public static function proxifyUrl($url, $size = '')
        {
                // Get application instance
-               $a = BaseObject::getApp();
+               $a = DI::app();
 
                // Trim URL first
                $url = trim($url);
@@ -78,29 +101,21 @@ class Proxy
 
                // Only continue if it isn't a local image and the isn't deactivated
                if (self::isLocalImage($url)) {
-                       $url = str_replace(normalise_link(System::baseUrl()) . '/', System::baseUrl() . '/', $url);
+                       $url = str_replace(Strings::normaliseLink(DI::baseUrl()) . '/', DI::baseUrl() . '/', $url);
                        return $url;
                }
 
                // Is the proxy disabled?
-               if (Config::get('system', 'proxy_disabled')) {
+               if (DI::config()->get('system', 'proxy_disabled')) {
                        return $url;
                }
 
                // Image URL may have encoded ampersands for display which aren't desirable for proxy
                $url = html_entity_decode($url, ENT_NOQUOTES, 'utf-8');
 
-               // Creating a sub directory to reduce the amount of files in the cache directory
-               $basepath = $a->get_basepath() . '/proxy';
-
                $shortpath = hash('md5', $url);
                $longpath = substr($shortpath, 0, 2);
 
-               if (is_dir($basepath) && $writemode && !is_dir($basepath . '/' . $longpath)) {
-                       mkdir($basepath . '/' . $longpath);
-                       chmod($basepath . '/' . $longpath, 0777);
-               }
-
                $longpath .= '/' . strtr(base64_encode($url), '+/', '-_');
 
                // Extract the URL extension
@@ -111,27 +126,22 @@ class Proxy
                        $longpath .= '.' . $extension;
                }
 
-               $proxypath = System::baseUrl() . '/proxy/' . $longpath;
+               $proxypath = DI::baseUrl() . '/proxy/' . $longpath;
 
                if ($size != '') {
                        $size = ':' . $size;
                }
 
                // Too long files aren't supported by Apache
-               // Writemode in combination with long files shouldn't be possible
-               if ((strlen($proxypath) > 250) && $writemode) {
-                       return $shortpath;
-               } elseif (strlen($proxypath) > 250) {
-                       return System::baseUrl() . '/proxy/' . $shortpath . '?url=' . urlencode($url);
-               } elseif ($writemode) {
-                       return $longpath;
+               if (strlen($proxypath) > 250) {
+                       return DI::baseUrl() . '/proxy/' . $shortpath . '?url=' . urlencode($url);
                } else {
                        return $proxypath . $size;
                }
        }
 
        /**
-        * @brief "Proxifies" HTML code's image tags
+        * "Proxifies" HTML code's image tags
         *
         * "Proxifies", means replaces image URLs in given HTML code with those from
         * proxy storage directory.
@@ -139,21 +149,23 @@ class Proxy
         * @param string $html Un-proxified HTML code
         *
         * @return string Proxified HTML code
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function proxifyHtml($html)
        {
-               $html = str_replace(normalise_link(System::baseUrl()) . '/', System::baseUrl() . '/', $html);
+               $html = str_replace(Strings::normaliseLink(DI::baseUrl()) . '/', DI::baseUrl() . '/', $html);
 
                return preg_replace_callback('/(<img [^>]*src *= *["\'])([^"\']+)(["\'][^>]*>)/siU', 'self::replaceUrl', $html);
        }
 
        /**
-        * @brief Checks if the URL is a local URL.
+        * Checks if the URL is a local URL.
         *
         * @param string $url
         * @return boolean
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       private static function isLocalImage($url)
+       public static function isLocalImage($url)
        {
                if (substr($url, 0, 1) == '/') {
                        return true;
@@ -164,14 +176,14 @@ class Proxy
                }
 
                // links normalised - bug #431
-               $baseurl = normalise_link(System::baseUrl());
-               $url = normalise_link($url);
+               $baseurl = Strings::normaliseLink(DI::baseUrl());
+               $url = Strings::normaliseLink($url);
 
                return (substr($url, 0, strlen($baseurl)) == $baseurl);
        }
 
        /**
-        * @brief Return the array of query string parameters from a URL
+        * Return the array of query string parameters from a URL
         *
         * @param string $url URL to parse
         * @return array Associative array of query string parameters
@@ -187,10 +199,11 @@ class Proxy
        }
 
        /**
-        * @brief Call-back method to replace the UR
+        * Call-back method to replace the UR
         *
         * @param array $matches Matches from preg_replace_callback()
         * @return string Proxified HTML image tag
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function replaceUrl(array $matches)
        {