src/Core/Storage/Type/SystemResource.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, 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 Friendica\Core\Storage\Exception\ReferenceStorageException;
  25 use Friendica\Core\Storage\Exception\StorageException;
  26 use Friendica\Core\Storage\Capability\ICanReadFromStorage;
  27
  28 /**
  29  * System resource storage class
  30  *
  31  * This class is used to load system resources, like images.
  32  * Is not intended to be selectable by admins as default storage class.
  33  */
  34 class SystemResource implements ICanReadFromStorage
  35 {
  36         const NAME = 'SystemResource';
  37
  38         // Valid folders to look for resources
  39         const VALID_FOLDERS = ["images"];
  40
  41         /**
  42          * @inheritDoc
  43          */
  44         public function get(string $reference): string
  45         {
  46                 $folder = dirname($reference);
  47                 if (!in_array($folder, self::VALID_FOLDERS)) {
  48                         throw new ReferenceStorageException(sprintf('System Resource is invalid for reference %s, no valid folder found', $reference));
  49                 }
  50                 if (!file_exists($reference)) {
  51                         throw new StorageException(sprintf('System Resource is invalid for reference %s, the file doesn\'t exist', $reference));
  52                 }
  53                 $content = file_get_contents($reference);
  54
  55                 if ($content === false) {
  56                         throw new StorageException(sprintf('Cannot get content for reference %s', $reference));
  57                 }
  58
  59                 return $content;
  60         }
  61
  62         /**
  63          * @inheritDoc
  64          */
  65         public function __toString(): string
  66         {
  67                 return self::NAME;
  68         }
  69
  70         /**
  71          * @inheritDoc
  72          */
  73         public static function getName(): string
  74         {
  75                 return self::NAME;
  76         }
  77 }