src/Network/HTTPClient/Response/GuzzleResponse.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL 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\HTTPClient\Response;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
  26 use Friendica\Network\HTTPException\NotImplementedException;
  27 use GuzzleHttp\Psr7\Response;
  28 use Psr\Http\Message\ResponseInterface;
  29
  30 /**
  31  * A content wrapper class for Guzzle call results
  32  */
  33 class GuzzleResponse extends Response implements ICanHandleHttpResponses, ResponseInterface
  34 {
  35         /** @var string The URL */
  36         private $url;
  37         /** @var boolean */
  38         private $isTimeout;
  39         /** @var boolean */
  40         private $isSuccess;
  41         /**
  42          * @var int the error number or 0 (zero) if no error
  43          */
  44         private $errorNumber;
  45
  46         /**
  47          * @var string the error message or '' (the empty string) if no
  48          */
  49         private $error;
  50
  51         public function __construct(ResponseInterface $response, string $url, $errorNumber = 0, $error = '')
  52         {
  53                 parent::__construct($response->getStatusCode(), $response->getHeaders(), $response->getBody(), $response->getProtocolVersion(), $response->getReasonPhrase());
  54                 $this->url         = $url;
  55                 $this->error       = $error;
  56                 $this->errorNumber = $errorNumber;
  57
  58                 $this->checkSuccess();
  59         }
  60
  61         private function checkSuccess()
  62         {
  63                 $this->isSuccess = ($this->getStatusCode() >= 200 && $this->getStatusCode() <= 299) || $this->errorNumber == 0;
  64
  65                 // Everything higher or equal 400 is not a success
  66                 if ($this->getReturnCode() >= 400) {
  67                         $this->isSuccess = false;
  68                 }
  69
  70                 if (!$this->isSuccess) {
  71                         Logger::debug('debug', ['info' => $this->getHeaders()]);
  72                 }
  73
  74                 if (!$this->isSuccess && $this->errorNumber == CURLE_OPERATION_TIMEDOUT) {
  75                         $this->isTimeout = true;
  76                 } else {
  77                         $this->isTimeout = false;
  78                 }
  79         }
  80
  81         /** {@inheritDoc} */
  82         public function getReturnCode(): string
  83         {
  84                 return $this->getStatusCode();
  85         }
  86
  87         /** {@inheritDoc} */
  88         public function getContentType(): string
  89         {
  90                 $contentTypes = $this->getHeader('Content-Type') ?? [];
  91
  92                 return array_pop($contentTypes) ?? '';
  93         }
  94
  95         /** {@inheritDoc} */
  96         public function inHeader(string $field): bool
  97         {
  98                 return $this->hasHeader($field);
  99         }
 100
 101         /** {@inheritDoc} */
 102         public function getHeaderArray(): array
 103         {
 104                 return $this->getHeaders();
 105         }
 106
 107         /** {@inheritDoc} */
 108         public function isSuccess(): bool
 109         {
 110                 return $this->isSuccess;
 111         }
 112
 113         /** {@inheritDoc} */
 114         public function getUrl(): string
 115         {
 116                 return $this->url;
 117         }
 118
 119         /** {@inheritDoc} */
 120         public function getRedirectUrl(): string
 121         {
 122                 return $this->url;
 123         }
 124
 125         /** {@inheritDoc}
 126          *
 127          * @throws NotImplementedException
 128          */
 129         public function isRedirectUrl(): bool
 130         {
 131                 throw new NotImplementedException();
 132         }
 133
 134         /** {@inheritDoc} */
 135         public function getErrorNumber(): int
 136         {
 137                 return $this->errorNumber;
 138         }
 139
 140         /** {@inheritDoc} */
 141         public function getError(): string
 142         {
 143                 return $this->error;
 144         }
 145
 146         /** {@inheritDoc} */
 147         public function isTimeout(): bool
 148         {
 149                 return $this->isTimeout;
 150         }
 151
 152         /// @todo - fix mismatching use of "getBody()" as string here and parent "getBody()" as streaminterface
 153         public function getBody(): string
 154         {
 155                 return (string) parent::getBody();
 156         }
 157 }