3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Core\Storage\Type;
24 use Friendica\Core\Storage\Exception\ReferenceStorageException;
25 use Friendica\Core\Storage\Exception\StorageException;
26 use Friendica\Core\Storage\Capability\ICanReadFromStorage;
29 * System resource storage class
31 * This class is used to load system resources, like images.
32 * Is not intended to be selectable by admins as default storage class.
34 class SystemResource implements ICanReadFromStorage
36 const NAME = 'SystemResource';
38 // Valid folders to look for resources
39 const VALID_FOLDERS = ["images"];
44 public function get(string $reference): string
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));
50 if (!file_exists($reference)) {
51 throw new StorageException(sprintf('System Resource is invalid for reference %s, the file doesn\'t exist', $reference));
53 $content = file_get_contents($reference);
55 if ($content === false) {
56 throw new StorageException(sprintf('Cannot get content for reference %s', $reference));
65 public function __toString(): string
73 public static function getName(): string