]> git.mxchange.org Git - friendica.git/blobdiff - src/Network/HTTPRequest.php
Revert "Use last entry for Content-Type"
[friendica.git] / src / Network / HTTPRequest.php
index c751406c1bf911de72f62c84a3e3ce66e0222f01..c37db4c9a06a7aa5abe6a14e98076853c63f4001 100644 (file)
@@ -28,12 +28,18 @@ use Friendica\Core\Config\IConfig;
 use Friendica\Core\System;
 use Friendica\Util\Network;
 use Friendica\Util\Profiler;
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\RequestException;
+use GuzzleHttp\Exception\TransferException;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\UriInterface;
 use Psr\Log\LoggerInterface;
 
 /**
  * Performs HTTP requests to a given URL
  */
-class HTTPRequest
+class HTTPRequest implements IHTTPRequest
 {
        /** @var LoggerInterface */
        private $logger;
@@ -53,25 +59,9 @@ class HTTPRequest
        }
 
        /**
-        * fetches an URL.
-        *
-        * @param string $url        URL to fetch
-        * @param bool   $binary     default false
-        *                           TRUE if asked to return binary results (file download)
-        * @param array  $opts       (optional parameters) assoziative array with:
-        *                           'accept_content' => supply Accept: header with 'accept_content' as the value
-        *                           'timeout' => int Timeout in seconds, default system config value or 60 seconds
-        *                           'http_auth' => username:password
-        *                           'novalidate' => do not validate SSL certs, default is to validate using our CA list
-        *                           'nobody' => only return the header
-        *                           'cookiejar' => path to cookie jar file
-        *                           'header' => header array
-        * @param int    $redirects  The recursion counter for internal use - default 0
-        *
-        * @return CurlResult
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * {@inheritDoc}
         */
-       public function get(string $url, bool $binary = false, array $opts = [], int &$redirects = 0)
+       public function get(string $url, bool $binary = false, array $opts = [])
        {
                $stamp1 = microtime(true);
 
@@ -98,134 +88,147 @@ class HTTPRequest
                        return CurlResult::createErrorCurl($url);
                }
 
-               $ch = @curl_init($url);
-
-               if (($redirects > 8) || (!$ch)) {
-                       return CurlResult::createErrorCurl($url);
-               }
+               $curlOptions = [];
 
-               @curl_setopt($ch, CURLOPT_HEADER, true);
+               $curlOptions[CURLOPT_HEADER] = true;
 
                if (!empty($opts['cookiejar'])) {
-                       curl_setopt($ch, CURLOPT_COOKIEJAR, $opts["cookiejar"]);
-                       curl_setopt($ch, CURLOPT_COOKIEFILE, $opts["cookiejar"]);
+                       $curlOptions[CURLOPT_COOKIEJAR] = $opts["cookiejar"];
+                       $curlOptions[CURLOPT_COOKIEFILE] = $opts["cookiejar"];
                }
 
                // These settings aren't needed. We're following the location already.
-               //      @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
-               //      @curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
+               //      $curlOptions[CURLOPT_FOLLOWLOCATION] =true;
+               //      $curlOptions[CURLOPT_MAXREDIRS] = 5;
 
                if (!empty($opts['accept_content'])) {
-                       curl_setopt(
-                               $ch,
-                               CURLOPT_HTTPHEADER,
-                               ['Accept: ' . $opts['accept_content']]
-                       );
+                       if (empty($curlOptions[CURLOPT_HTTPHEADER])) {
+                               $curlOptions[CURLOPT_HTTPHEADER] = [];
+                       }
+                       array_push($curlOptions[CURLOPT_HTTPHEADER], 'Accept: ' . $opts['accept_content']);
                }
 
                if (!empty($opts['header'])) {
-                       curl_setopt($ch, CURLOPT_HTTPHEADER, $opts['header']);
+                       if (empty($curlOptions[CURLOPT_HTTPHEADER])) {
+                               $curlOptions[CURLOPT_HTTPHEADER] = [];
+                       }
+                       $curlOptions[CURLOPT_HTTPHEADER] = array_merge($opts['header'], $curlOptions[CURLOPT_HTTPHEADER]);
                }
 
-               @curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-               @curl_setopt($ch, CURLOPT_USERAGENT, $this->getUserAgent());
+               $curlOptions[CURLOPT_RETURNTRANSFER] = true;
+               $curlOptions[CURLOPT_USERAGENT] = $this->getUserAgent();
 
                $range = intval($this->config->get('system', 'curl_range_bytes', 0));
 
                if ($range > 0) {
-                       @curl_setopt($ch, CURLOPT_RANGE, '0-' . $range);
+                       $curlOptions[CURLOPT_RANGE] = '0-' . $range;
                }
 
                // Without this setting it seems as if some webservers send compressed content
                // This seems to confuse curl so that it shows this uncompressed.
                /// @todo  We could possibly set this value to "gzip" or something similar
-               curl_setopt($ch, CURLOPT_ENCODING, '');
+               $curlOptions[CURLOPT_ENCODING] = '';
 
                if (!empty($opts['headers'])) {
-                       @curl_setopt($ch, CURLOPT_HTTPHEADER, $opts['headers']);
+                       if (empty($curlOptions[CURLOPT_HTTPHEADER])) {
+                               $curlOptions[CURLOPT_HTTPHEADER] = [];
+                       }
+                       $curlOptions[CURLOPT_HTTPHEADER] = array_merge($opts['headers'], $curlOptions[CURLOPT_HTTPHEADER]);
                }
 
                if (!empty($opts['nobody'])) {
-                       @curl_setopt($ch, CURLOPT_NOBODY, $opts['nobody']);
+                       $curlOptions[CURLOPT_NOBODY] = $opts['nobody'];
                }
 
+               $curlOptions[CURLOPT_CONNECTTIMEOUT] = 10;
+
                if (!empty($opts['timeout'])) {
-                       @curl_setopt($ch, CURLOPT_TIMEOUT, $opts['timeout']);
+                       $curlOptions[CURLOPT_TIMEOUT] = $opts['timeout'];
                } else {
                        $curl_time = $this->config->get('system', 'curl_timeout', 60);
-                       @curl_setopt($ch, CURLOPT_TIMEOUT, intval($curl_time));
+                       $curlOptions[CURLOPT_TIMEOUT] = intval($curl_time);
                }
 
                // by default we will allow self-signed certs
                // but you can override this
 
                $check_cert = $this->config->get('system', 'verifyssl');
-               @curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
+               $curlOptions[CURLOPT_SSL_VERIFYPEER] = ($check_cert) ? true : false;
 
                if ($check_cert) {
-                       @curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
+                       $curlOptions[CURLOPT_SSL_VERIFYHOST] = 2;
                }
 
                $proxy = $this->config->get('system', 'proxy');
 
                if (!empty($proxy)) {
-                       @curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
-                       @curl_setopt($ch, CURLOPT_PROXY, $proxy);
+                       $curlOptions[CURLOPT_HTTPPROXYTUNNEL] = 1;
+                       $curlOptions[CURLOPT_PROXY] = $proxy;
                        $proxyuser = $this->config->get('system', 'proxyuser');
 
                        if (!empty($proxyuser)) {
-                               @curl_setopt($ch, CURLOPT_PROXYUSERPWD, $proxyuser);
+                               $curlOptions[CURLOPT_PROXYUSERPWD] = $proxyuser;
                        }
                }
 
                if ($this->config->get('system', 'ipv4_resolve', false)) {
-                       curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
+                       $curlOptions[CURLOPT_IPRESOLVE] = CURL_IPRESOLVE_V4;
                }
 
                if ($binary) {
-                       @curl_setopt($ch, CURLOPT_BINARYTRANSFER, 1);
+                       $curlOptions[CURLOPT_BINARYTRANSFER] = 1;
                }
 
-               // don't let curl abort the entire application
-               // if it throws any errors.
-
-               $s         = @curl_exec($ch);
-               $curl_info = @curl_getinfo($ch);
-
-               // Special treatment for HTTP Code 416
-               // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416
-               if (($curl_info['http_code'] == 416) && ($range > 0)) {
-                       @curl_setopt($ch, CURLOPT_RANGE, '');
-                       $s         = @curl_exec($ch);
-                       $curl_info = @curl_getinfo($ch);
-               }
+               $logger = $this->logger;
 
-               $curlResponse = new CurlResult($url, $s, $curl_info, curl_errno($ch), curl_error($ch));
+               $onRedirect = function(
+                       RequestInterface $request,
+                       ResponseInterface $response,
+                       UriInterface $uri
+               ) use ($logger) {
+                       $logger->notice('Curl redirect.', ['url' => $request->getUri(), 'to' => $uri]);
+               };
 
-               if ($curlResponse->isRedirectUrl()) {
-                       $redirects++;
-                       $this->logger->notice('Curl redirect.', ['url' => $url, 'to' => $curlResponse->getRedirectUrl()]);
-                       @curl_close($ch);
-                       return $this->get($curlResponse->getRedirectUrl(), $binary, $opts, $redirects);
+               $onHeaders = function (ResponseInterface $response) use ($opts) {
+                       if (!empty($opts['content_length']) &&
+                               $response->getHeaderLine('Content-Length') > $opts['content_length']) {
+                               throw new TransferException('The file is too big!');
+                       }
+               };
+
+               $client = new Client([
+                       'allow_redirect' => [
+                               'max' => 8,
+                               'on_redirect' => $onRedirect,
+                               'track_redirect' => true,
+                               'strict' => true,
+                               'referer' => true,
+                       ],
+                       'on_headers' => $onHeaders,
+                       'sink' => tempnam(get_temppath(), 'guzzle'),
+                       'curl' => $curlOptions
+               ]);
+
+               try {
+                       $response = $client->get($url);
+                       return new GuzzleResponse($response, $url);
+               } catch (TransferException $exception) {
+                       if ($exception instanceof RequestException &&
+                               $exception->hasResponse()) {
+                               return new GuzzleResponse($exception->getResponse(), $url, $exception->getCode(), '');
+                       } else {
+                               return new CurlResult($url, '', ['http_code' => $exception->getCode()], $exception->getCode(), '');
+                       }
+               } finally {
+                       $this->profiler->saveTimestamp($stamp1, 'network');
                }
-
-               @curl_close($ch);
-
-               $this->profiler->saveTimestamp($stamp1, 'network', System::callstack());
-
-               return $curlResponse;
        }
 
        /**
-        * Send POST request to $url
+        * {@inheritDoc}
         *
-        * @param string $url       URL to post
-        * @param mixed  $params    array of POST variables
-        * @param array  $headers   HTTP headers
-        * @param int    $redirects Recursion counter for internal use - default = 0
-        * @param int    $timeout   The timeout in seconds, default system config value or 60 seconds
+        * @param int $redirects The recursion counter for internal use - default 0
         *
-        * @return CurlResult The content
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function post(string $url, $params, array $headers = [], int $timeout = 0, int &$redirects = 0)
@@ -255,6 +258,8 @@ class HTTPRequest
                        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
                }
 
+               @curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
+
                if (intval($timeout)) {
                        curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
                } else {
@@ -293,7 +298,7 @@ class HTTPRequest
 
                $curlResponse = new CurlResult($url, $s, $curl_info, curl_errno($ch), curl_error($ch));
 
-               if ($curlResponse->isRedirectUrl()) {
+               if (!Network::isRedirectBlocked($url) && $curlResponse->isRedirectUrl()) {
                        $redirects++;
                        $this->logger->info('Post redirect.', ['url' => $url, 'to' => $curlResponse->getRedirectUrl()]);
                        curl_close($ch);
@@ -302,7 +307,7 @@ class HTTPRequest
 
                curl_close($ch);
 
-               $this->profiler->saveTimestamp($stamp1, 'network', System::callstack());
+               $this->profiler->saveTimestamp($stamp1, 'network');
 
                // Very old versions of Lighttpd don't like the "Expect" header, so we remove it when needed
                if ($curlResponse->getReturnCode() == 417) {
@@ -325,23 +330,20 @@ class HTTPRequest
        }
 
        /**
-        * Returns the original URL of the provided URL
-        *
-        * This function strips tracking query params and follows redirections, either
-        * through HTTP code or meta refresh tags. Stops after 10 redirections.
-        *
-        * @todo  Remove the $fetchbody parameter that generates an extraneous HEAD request
-        *
-        * @see   ParseUrl::getSiteinfo
-        *
-        * @param string $url       A user-submitted URL
-        * @param int    $depth     The current redirection recursion level (internal)
-        * @param bool   $fetchbody Wether to fetch the body or not after the HEAD requests
-        * @return string A canonical URL
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * {@inheritDoc}
         */
        public function finalUrl(string $url, int $depth = 1, bool $fetchbody = false)
        {
+               if (Network::isUrlBlocked($url)) {
+                       $this->logger->info('Domain is blocked.', ['url' => $url]);
+                       return $url;
+               }
+
+               if (Network::isRedirectBlocked($url)) {
+                       $this->logger->info('Domain should not be redirected.', ['url' => $url]);
+                       return $url;
+               }
+
                $url = Network::stripTrackingQueryParams($url);
 
                if ($depth > 10) {
@@ -356,6 +358,7 @@ class HTTPRequest
                curl_setopt($ch, CURLOPT_URL, $url);
                curl_setopt($ch, CURLOPT_HEADER, 1);
                curl_setopt($ch, CURLOPT_NOBODY, 1);
+               curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
                curl_setopt($ch, CURLOPT_TIMEOUT, 10);
                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                curl_setopt($ch, CURLOPT_USERAGENT, $this->getUserAgent());
@@ -365,7 +368,7 @@ class HTTPRequest
                $http_code = $curl_info['http_code'];
                curl_close($ch);
 
-               $this->profiler->saveTimestamp($stamp1, "network", System::callstack());
+               $this->profiler->saveTimestamp($stamp1, "network");
 
                if ($http_code == 0) {
                        return $url;
@@ -400,6 +403,7 @@ class HTTPRequest
                curl_setopt($ch, CURLOPT_URL, $url);
                curl_setopt($ch, CURLOPT_HEADER, 0);
                curl_setopt($ch, CURLOPT_NOBODY, 0);
+               curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
                curl_setopt($ch, CURLOPT_TIMEOUT, 10);
                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                curl_setopt($ch, CURLOPT_USERAGENT, $this->getUserAgent());
@@ -407,7 +411,7 @@ class HTTPRequest
                $body = curl_exec($ch);
                curl_close($ch);
 
-               $this->profiler->saveTimestamp($stamp1, "network", System::callstack());
+               $this->profiler->saveTimestamp($stamp1, "network");
 
                if (trim($body) == "") {
                        return $url;
@@ -443,21 +447,10 @@ class HTTPRequest
        }
 
        /**
-        * Curl wrapper
-        *
-        * If binary flag is true, return binary results.
-        * Set the cookiejar argument to a string (e.g. "/tmp/friendica-cookies.txt")
-        * to preserve cookies from one request to the next.
+        * {@inheritDoc}
         *
-        * @param string $url             URL to fetch
-        * @param bool   $binary          default false
-        *                                TRUE if asked to return binary results (file download)
-        * @param int    $timeout         Timeout in seconds, default system config value or 60 seconds
-        * @param string $accept_content  supply Accept: header with 'accept_content' as the value
-        * @param string $cookiejar       Path to cookie jar file
-        * @param int    $redirects       The recursion counter for internal use - default 0
+        * @param int $redirects The recursion counter for internal use - default 0
         *
-        * @return string The fetched content
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function fetch(string $url, bool $binary = false, int $timeout = 0, string $accept_content = '', string $cookiejar = '', int &$redirects = 0)
@@ -468,20 +461,10 @@ class HTTPRequest
        }
 
        /**
-        * Curl wrapper with array of return values.
-        *
-        * Inner workings and parameters are the same as @ref fetchUrl but returns an array with
-        * all the information collected during the fetch.
+        * {@inheritDoc}
         *
-        * @param string $url             URL to fetch
-        * @param bool   $binary          default false
-        *                                TRUE if asked to return binary results (file download)
-        * @param int    $timeout         Timeout in seconds, default system config value or 60 seconds
-        * @param string $accept_content  supply Accept: header with 'accept_content' as the value
-        * @param string $cookiejar       Path to cookie jar file
-        * @param int    $redirects       The recursion counter for internal use - default 0
+        * @param int $redirects The recursion counter for internal use - default 0
         *
-        * @return CurlResult With all relevant information, 'body' contains the actual fetched content.
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function fetchFull(string $url, bool $binary = false, int $timeout = 0, string $accept_content = '', string $cookiejar = '', int &$redirects = 0)
@@ -493,15 +476,12 @@ class HTTPRequest
                                'timeout'        => $timeout,
                                'accept_content' => $accept_content,
                                'cookiejar'      => $cookiejar
-                       ],
-                       $redirects
+                       ]
                );
        }
 
        /**
-        * Returns the current UserAgent as a String
-        *
-        * @return string the UserAgent as a String
+        * {@inheritDoc}
         */
        public function getUserAgent()
        {