src/Network/HTTPClient.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU APGL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Network;
  23
  24 use Friendica\Core\System;
  25 use Friendica\Util\Network;
  26 use Friendica\Util\Profiler;
  27 use GuzzleHttp\Client;
  28 use GuzzleHttp\Cookie\FileCookieJar;
  29 use GuzzleHttp\Exception\RequestException;
  30 use GuzzleHttp\Exception\TransferException;
  31 use GuzzleHttp\RequestOptions;
  32 use mattwright\URLResolver;
  33 use Psr\Http\Message\ResponseInterface;
  34 use Psr\Log\InvalidArgumentException;
  35 use Psr\Log\LoggerInterface;
  36
  37 /**
  38  * Performs HTTP requests to a given URL
  39  */
  40 class HTTPClient implements IHTTPClient
  41 {
  42         /** @var LoggerInterface */
  43         private $logger;
  44         /** @var Profiler */
  45         private $profiler;
  46         /** @var Client */
  47         private $client;
  48         /** @var URLResolver */
  49         private $resolver;
  50
  51         public function __construct(LoggerInterface $logger, Profiler $profiler, Client $client, URLResolver $resolver)
  52         {
  53                 $this->logger   = $logger;
  54                 $this->profiler = $profiler;
  55                 $this->client   = $client;
  56                 $this->resolver = $resolver;
  57         }
  58
  59         /**
  60          * {@inheritDoc}
  61          */
  62         public function request(string $method, string $url, array $opts = []): IHTTPResult
  63         {
  64                 $this->profiler->startRecording('network');
  65                 $this->logger->debug('Request start.', ['url' => $url, 'method' => $method]);
  66
  67                 if (Network::isLocalLink($url)) {
  68                         $this->logger->info('Local link', ['url' => $url, 'callstack' => System::callstack(20)]);
  69                 }
  70
  71                 if (strlen($url) > 1000) {
  72                         $this->logger->debug('URL is longer than 1000 characters.', ['url' => $url, 'callstack' => System::callstack(20)]);
  73                         $this->profiler->stopRecording();
  74                         return CurlResult::createErrorCurl(substr($url, 0, 200));
  75                 }
  76
  77                 $parts2     = [];
  78                 $parts      = parse_url($url);
  79                 $path_parts = explode('/', $parts['path'] ?? '');
  80                 foreach ($path_parts as $part) {
  81                         if (strlen($part) <> mb_strlen($part)) {
  82                                 $parts2[] = rawurlencode($part);
  83                         } else {
  84                                 $parts2[] = $part;
  85                         }
  86                 }
  87                 $parts['path'] = implode('/', $parts2);
  88                 $url           = Network::unparseURL($parts);
  89
  90                 if (Network::isUrlBlocked($url)) {
  91                         $this->logger->info('Domain is blocked.', ['url' => $url]);
  92                         $this->profiler->stopRecording();
  93                         return CurlResult::createErrorCurl($url);
  94                 }
  95
  96                 $conf = [];
  97
  98                 if (!empty($opts[HTTPClientOptions::COOKIEJAR])) {
  99                         $jar                           = new FileCookieJar($opts[HTTPClientOptions::COOKIEJAR]);
 100                         $conf[RequestOptions::COOKIES] = $jar;
 101                 }
 102
 103                 $headers = [];
 104
 105                 if (!empty($opts[HTTPClientOptions::ACCEPT_CONTENT])) {
 106                         $headers['Accept'] = $opts[HTTPClientOptions::ACCEPT_CONTENT];
 107                 }
 108
 109                 if (!empty($opts[HTTPClientOptions::LEGACY_HEADER])) {
 110                         $this->logger->notice('Wrong option \'headers\' used.');
 111                         $headers = array_merge($opts[HTTPClientOptions::LEGACY_HEADER], $headers);
 112                 }
 113
 114                 if (!empty($opts[HTTPClientOptions::HEADERS])) {
 115                         $headers = array_merge($opts[HTTPClientOptions::HEADERS], $headers);
 116                 }
 117
 118                 $conf[RequestOptions::HEADERS] = array_merge($this->client->getConfig(RequestOptions::HEADERS), $headers);
 119
 120                 if (!empty($opts[HTTPClientOptions::TIMEOUT])) {
 121                         $conf[RequestOptions::TIMEOUT] = $opts[HTTPClientOptions::TIMEOUT];
 122                 }
 123
 124                 if (!empty($opts[HTTPClientOptions::BODY])) {
 125                         $conf[RequestOptions::BODY] = $opts[HTTPClientOptions::BODY];
 126                 }
 127
 128                 if (!empty($opts[HTTPClientOptions::AUTH])) {
 129                         $conf[RequestOptions::AUTH] = $opts[HTTPClientOptions::AUTH];
 130                 }
 131
 132                 $conf[RequestOptions::ON_HEADERS] = function (ResponseInterface $response) use ($opts) {
 133                         if (!empty($opts[HTTPClientOptions::CONTENT_LENGTH]) &&
 134                                 (int)$response->getHeaderLine('Content-Length') > $opts[HTTPClientOptions::CONTENT_LENGTH]) {
 135                                 throw new TransferException('The file is too big!');
 136                         }
 137                 };
 138
 139                 try {
 140                         $this->logger->debug('http request config.', ['url' => $url, 'method' => $method, 'options' => $conf]);
 141
 142                         $response = $this->client->request($method, $url, $conf);
 143                         return new GuzzleResponse($response, $url);
 144                 } catch (TransferException $exception) {
 145                         if ($exception instanceof RequestException &&
 146                                 $exception->hasResponse()) {
 147                                 return new GuzzleResponse($exception->getResponse(), $url, $exception->getCode(), '');
 148                         } else {
 149                                 return new CurlResult($url, '', ['http_code' => $exception->getCode()], $exception->getCode(), '');
 150                         }
 151                 } catch (InvalidArgumentException $argumentException) {
 152                         $this->logger->info('Invalid Argument for HTTP call.', ['url' => $url, 'method' => $method, 'exception' => $argumentException]);
 153                         return new CurlResult($url, '', ['http_code' => $argumentException->getCode()], $argumentException->getCode(), $argumentException->getMessage());
 154                 } finally {
 155                         $this->logger->debug('Request stop.', ['url' => $url, 'method' => $method]);
 156                         $this->profiler->stopRecording();
 157                 }
 158         }
 159
 160         /** {@inheritDoc}
 161          */
 162         public function head(string $url, array $opts = []): IHTTPResult
 163         {
 164                 return $this->request('head', $url, $opts);
 165         }
 166
 167         /**
 168          * {@inheritDoc}
 169          */
 170         public function get(string $url, array $opts = []): IHTTPResult
 171         {
 172                 return $this->request('get', $url, $opts);
 173         }
 174
 175         /**
 176          * {@inheritDoc}
 177          */
 178         public function post(string $url, $params, array $headers = [], int $timeout = 0): IHTTPResult
 179         {
 180                 $opts = [];
 181
 182                 $opts[HTTPClientOptions::BODY] = $params;
 183
 184                 if (!empty($headers)) {
 185                         $opts[HTTPClientOptions::HEADERS] = $headers;
 186                 }
 187
 188                 if (!empty($timeout)) {
 189                         $opts[HTTPClientOptions::TIMEOUT] = $timeout;
 190                 }
 191
 192                 return $this->request('post', $url, $opts);
 193         }
 194
 195         /**
 196          * {@inheritDoc}
 197          */
 198         public function finalUrl(string $url)
 199         {
 200                 $this->profiler->startRecording('network');
 201
 202                 if (Network::isLocalLink($url)) {
 203                         $this->logger->debug('Local link', ['url' => $url, 'callstack' => System::callstack(20)]);
 204                 }
 205
 206                 if (Network::isUrlBlocked($url)) {
 207                         $this->logger->info('Domain is blocked.', ['url' => $url]);
 208                         return $url;
 209                 }
 210
 211                 if (Network::isRedirectBlocked($url)) {
 212                         $this->logger->info('Domain should not be redirected.', ['url' => $url]);
 213                         return $url;
 214                 }
 215
 216                 $url = Network::stripTrackingQueryParams($url);
 217
 218                 $url = trim($url, "'");
 219
 220                 $urlResult = $this->resolver->resolveURL($url);
 221
 222                 if ($urlResult->didErrorOccur()) {
 223                         throw new TransferException($urlResult->getErrorMessageString(), $urlResult->getHTTPStatusCode());
 224                 }
 225
 226                 return $urlResult->getURL();
 227         }
 228
 229         /**
 230          * {@inheritDoc}
 231          */
 232         public function fetch(string $url, int $timeout = 0, string $accept_content = '', string $cookiejar = '')
 233         {
 234                 $ret = $this->fetchFull($url, $timeout, $accept_content, $cookiejar);
 235
 236                 return $ret->getBody();
 237         }
 238
 239         /**
 240          * {@inheritDoc}
 241          */
 242         public function fetchFull(string $url, int $timeout = 0, string $accept_content = '', string $cookiejar = '')
 243         {
 244                 return $this->get(
 245                         $url,
 246                         [
 247                                 'timeout'        => $timeout,
 248                                 'accept_content' => $accept_content,
 249                                 'cookiejar'      => $cookiejar
 250                         ]
 251                 );
 252         }
 253 }