src/Core/Storage/Type/ExternalResource.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   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\Core\Storage\Type;
  23
  24 use Exception;
  25 use Friendica\Core\Storage\Exception\ReferenceStorageException;
  26 use Friendica\Core\Storage\Capability\ICanReadFromStorage;
  27 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
  28 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
  29 use Friendica\Util\HTTPSignature;
  30 use Psr\Log\LoggerInterface;
  31
  32 /**
  33  * External resource storage class
  34  *
  35  * This class is used to load external resources, like images.
  36  * Is not intended to be selectable by admins as default storage class.
  37  */
  38 class ExternalResource implements ICanReadFromStorage
  39 {
  40         const NAME = 'ExternalResource';
  41
  42         /** @var LoggerInterface */
  43         protected $logger;
  44
  45         public function __construct(LoggerInterface $logger)
  46         {
  47                 $this->logger = $logger;
  48         }
  49
  50         /**
  51          * @inheritDoc
  52          */
  53         public function get(string $reference): string
  54         {
  55                 $data = json_decode($reference);
  56                 if (empty($data->url)) {
  57                         throw new ReferenceStorageException(sprintf('Invalid reference %s, cannot retrieve URL', $reference));
  58                 }
  59
  60                 $parts = parse_url($data->url);
  61                 if (empty($parts['scheme']) || empty($parts['host'])) {
  62                         throw new ReferenceStorageException(sprintf('Invalid reference %s, cannot extract scheme and host', $reference));
  63                 }
  64
  65                 try {
  66                         $fetchResult = HTTPSignature::fetchRaw($data->url, $data->uid, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
  67                 } catch (Exception $exception) {
  68                         $this->logger->notice('URL is invalid', ['url' => $data->url, 'error' => $exception]);
  69                         throw new ReferenceStorageException(sprintf('External resource failed to get %s', $reference), $exception->getCode(), $exception);
  70                 }
  71                 if (!empty($fetchResult) && $fetchResult->isSuccess()) {
  72                         $this->logger->debug('Got picture', ['Content-Type' => $fetchResult->getHeader('Content-Type'), 'uid' => $data->uid, 'url' => $data->url]);
  73                         return $fetchResult->getBody();
  74                 } else {
  75                         if (empty($fetchResult)) {
  76                                 throw new ReferenceStorageException(sprintf('External resource failed to get %s', $reference));
  77                         } else {
  78                                 throw new ReferenceStorageException(sprintf('External resource failed to get %s', $reference), $fetchResult->getReturnCode(), new Exception($fetchResult->getBody()));
  79                         }
  80                 }
  81         }
  82
  83         /**
  84          * @inheritDoc
  85          */
  86         public function __toString(): string
  87         {
  88                 return self::NAME;
  89         }
  90
  91         /**
  92          * @inheritDoc
  93          */
  94         public static function getName(): string
  95         {
  96                 return self::NAME;
  97         }
  98 }