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