3 * @copyright Copyright (C) 2020, Friendica
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\Model\Storage;
24 use Friendica\Core\Config\IConfig;
25 use Friendica\Core\L10n;
26 use Friendica\Util\Strings;
27 use Psr\Log\LoggerInterface;
30 * Filesystem based storage backend
32 * This class manage data on filesystem.
33 * Base folder for storage is set in storage.filesystem_path.
34 * Best would be for storage folder to be outside webserver folder, we are using a
35 * folder relative to code tree root as default to ease things for users in shared hostings.
36 * Each new resource gets a value as reference and is saved in a
37 * folder tree stucture created from that value.
39 class Filesystem extends AbstractStorage
41 const NAME = 'Filesystem';
43 // Default base folder
44 const DEFAULT_BASE_FOLDER = 'storage';
53 * Filesystem constructor.
55 * @param IConfig $config
56 * @param LoggerInterface $logger
59 public function __construct(IConfig $config, LoggerInterface $logger, L10n $l10n)
61 parent::__construct($l10n, $logger);
63 $this->config = $config;
65 $path = $this->config->get('storage', 'filesystem_path', self::DEFAULT_BASE_FOLDER);
66 $this->basePath = rtrim($path, '/');
70 * Split data ref and return file path
72 * @param string $reference Data reference
76 private function pathForRef(string $reference)
78 $fold1 = substr($reference, 0, 2);
79 $fold2 = substr($reference, 2, 2);
80 $file = substr($reference, 4);
82 return implode('/', [$this->basePath, $fold1, $fold2, $file]);
87 * Create dirctory tree to store file, with .htaccess and index.html files
89 * @param string $file Path and filename
91 * @throws StorageException
93 private function createFoldersForFile(string $file)
95 $path = dirname($file);
98 if (!mkdir($path, 0770, true)) {
99 $this->logger->warning('Failed to create dir.', ['path' => $path]);
100 throw new StorageException($this->l10n->t('Filesystem storage failed to create "%s". Check you write permissions.', $path));
104 while ($path !== $this->basePath) {
105 if (!is_file($path . '/index.html')) {
106 file_put_contents($path . '/index.html', '');
108 chmod($path . '/index.html', 0660);
110 $path = dirname($path);
112 if (!is_file($path . '/index.html')) {
113 file_put_contents($path . '/index.html', '');
114 chmod($path . '/index.html', 0660);
121 public function get(string $reference)
123 $file = $this->pathForRef($reference);
124 if (!is_file($file)) {
128 return file_get_contents($file);
134 public function put(string $data, string $reference = '')
136 if ($reference === '') {
137 $reference = Strings::getRandomHex();
139 $file = $this->pathForRef($reference);
141 $this->createFoldersForFile($file);
143 $result = file_put_contents($file, $data);
145 // just in case the result is REALLY false, not zero or empty or anything else, throw the exception
146 if ($result === false) {
147 $this->logger->warning('Failed to write data.', ['file' => $file]);
148 throw new StorageException($this->l10n->t('Filesystem storage failed to save data to "%s". Check your write permissions', $file));
158 public function delete(string $reference)
160 $file = $this->pathForRef($reference);
161 // return true if file doesn't exists. we want to delete it: success with zero work!
162 if (!is_file($file)) {
165 return unlink($file);
171 public function getOptions()
176 $this->l10n->t('Storage base path'),
178 $this->l10n->t('Folder where uploaded files are saved. For maximum security, This should be a path outside web server folder tree')
186 public function saveOptions(array $data)
188 $storagePath = $data['storagepath'] ?? '';
189 if ($storagePath === '' || !is_dir($storagePath)) {
191 'storagepath' => $this->l10n->t('Enter a valid existing folder')
194 $this->config->set('storage', 'filesystem_path', $storagePath);
195 $this->basePath = $storagePath;
202 public static function getName()