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          * @throws HTTPException\InternalServerErrorException
  61          */
  62         protected 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['cookiejar'])) {
  99                         $jar                           = new FileCookieJar($opts['cookiejar']);
 100                         $conf[RequestOptions::COOKIES] = $jar;
 101                 }
 102
 103                 $header = [];
 104
 105                 if (!empty($opts['accept_content'])) {
 106                         $header['Accept'] = $opts['accept_content'];
 107                 }
 108
 109                 if (!empty($opts['header'])) {
 110                         $header = array_merge($opts['header'], $header);
 111                 }
 112
 113                 if (!empty($opts['headers'])) {
 114                         $this->logger->notice('Wrong option \'headers\' used.');
 115                         $header = array_merge($opts['headers'], $header);
 116                 }
 117
 118                 $conf[RequestOptions::HEADERS] = array_merge($this->client->getConfig(RequestOptions::HEADERS), $header);
 119
 120                 if (!empty($opts['timeout'])) {
 121                         $conf[RequestOptions::TIMEOUT] = $opts['timeout'];
 122                 }
 123
 124                 $conf[RequestOptions::ON_HEADERS] = function (ResponseInterface $response) use ($opts) {
 125                         if (!empty($opts['content_length']) &&
 126                                 $response->getHeaderLine('Content-Length') > $opts['content_length']) {
 127                                 throw new TransferException('The file is too big!');
 128                         }
 129                 };
 130
 131                 try {
 132                         $this->logger->debug('http request config.', ['url' => $url, 'method' => $method, 'options' => $conf]);
 133
 134                         switch ($method) {
 135                                 case 'get':
 136                                 case 'head':
 137                                 case 'post':
 138                                         $response = $this->client->$method($url, $conf);
 139                                         break;
 140                                 default:
 141                                         throw new TransferException('Invalid method');
 142                         }
 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          * @throws HTTPException\InternalServerErrorException
 163          */
 164         public function head(string $url, array $opts = []): IHTTPResult
 165         {
 166                 return $this->request('head', $url, $opts);
 167         }
 168
 169         /**
 170          * {@inheritDoc}
 171          */
 172         public function get(string $url, array $opts = []): IHTTPResult
 173         {
 174                 return $this->request('get', $url, $opts);
 175         }
 176
 177         /**
 178          * {@inheritDoc}
 179          */
 180         public function post(string $url, $params, array $headers = [], int $timeout = 0): IHTTPResult
 181         {
 182                 $opts = [];
 183
 184                 $opts[RequestOptions::JSON] = $params;
 185
 186                 if (!empty($headers)) {
 187                         $opts['headers'] = $headers;
 188                 }
 189
 190                 if (!empty($timeout)) {
 191                         $opts[RequestOptions::TIMEOUT] = $timeout;
 192                 }
 193
 194                 return $this->request('post', $url, $opts);
 195         }
 196
 197         /**
 198          * {@inheritDoc}
 199          */
 200         public function finalUrl(string $url)
 201         {
 202                 $this->profiler->startRecording('network');
 203
 204                 if (Network::isLocalLink($url)) {
 205                         $this->logger->debug('Local link', ['url' => $url, 'callstack' => System::callstack(20)]);
 206                 }
 207
 208                 if (Network::isUrlBlocked($url)) {
 209                         $this->logger->info('Domain is blocked.', ['url' => $url]);
 210                         return $url;
 211                 }
 212
 213                 if (Network::isRedirectBlocked($url)) {
 214                         $this->logger->info('Domain should not be redirected.', ['url' => $url]);
 215                         return $url;
 216                 }
 217
 218                 $url = Network::stripTrackingQueryParams($url);
 219
 220                 $url = trim($url, "'");
 221
 222                 // Designate a temporary file that will store cookies during the session.
 223                 // Some websites test the browser for cookie support, so this enhances results.
 224                 $this->resolver->setCookieJar(tempnam(get_temppath() , 'url_resolver-'));
 225
 226                 $urlResult = $this->resolver->resolveURL($url);
 227
 228                 if ($urlResult->didErrorOccur()) {
 229                         throw new TransferException($urlResult->getErrorMessageString());
 230                 }
 231
 232                 return $urlResult->getURL();
 233         }
 234
 235         /**
 236          * {@inheritDoc}
 237          */
 238         public function fetch(string $url, int $timeout = 0, string $accept_content = '', string $cookiejar = '')
 239         {
 240                 $ret = $this->fetchFull($url, $timeout, $accept_content, $cookiejar);
 241
 242                 return $ret->getBody();
 243         }
 244
 245         /**
 246          * {@inheritDoc}
 247          */
 248         public function fetchFull(string $url, int $timeout = 0, string $accept_content = '', string $cookiejar = '')
 249         {
 250                 return $this->get(
 251                         $url,
 252                         [
 253                                 'timeout'        => $timeout,
 254                                 'accept_content' => $accept_content,
 255                                 'cookiejar'      => $cookiejar
 256                         ]
 257                 );
 258         }
 259 }