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\Logger;
  26 use Friendica\Core\Storage\Exception\ReferenceStorageException;
  27 use Friendica\Core\Storage\Capability\ICanReadFromStorage;
  28 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
  29 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
  30 use Friendica\Util\HTTPSignature;
  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         /**
  43          * @inheritDoc
  44          */
  45         public function get(string $reference): string
  46         {
  47                 $data = json_decode($reference);
  48                 if (empty($data->url)) {
  49                         throw new ReferenceStorageException(sprintf('Invalid reference %s, cannot retrieve URL', $reference));
  50                 }
  51
  52                 $parts = parse_url($data->url);
  53                 if (empty($parts['scheme']) || empty($parts['host'])) {
  54                         throw new ReferenceStorageException(sprintf('Invalid reference %s, cannot extract scheme and host', $reference));
  55                 }
  56
  57                 try {
  58                         $fetchResult = HTTPSignature::fetchRaw($data->url, $data->uid, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
  59                 } catch (Exception $exception) {
  60                         Logger::notice('URL is invalid', ['url' => $data->url, 'error' => $exception]);
  61                         throw new ReferenceStorageException(sprintf('External resource failed to get %s', $reference), $exception->getCode(), $exception);
  62                 }
  63                 if (!empty($fetchResult) && $fetchResult->isSuccess()) {
  64                         Logger::debug('Got picture', ['Content-Type' => $fetchResult->getHeader('Content-Type'), 'uid' => $data->uid, 'url' => $data->url]);
  65                         return $fetchResult->getBody();
  66                 } else {
  67                         if (empty($fetchResult)) {
  68                                 throw new ReferenceStorageException(sprintf('External resource failed to get %s', $reference));
  69                         } else {
  70                                 throw new ReferenceStorageException(sprintf('External resource failed to get %s', $reference), $fetchResult->getReturnCode(), new Exception($fetchResult->getBody()));
  71                         }
  72                 }
  73         }
  74
  75         /**
  76          * @inheritDoc
  77          */
  78         public function __toString(): string
  79         {
  80                 return self::NAME;
  81         }
  82
  83         /**
  84          * @inheritDoc
  85          */
  86         public static function getName(): string
  87         {
  88                 return self::NAME;
  89         }
  90 }