3 * @file src/Model/Storage/Filesystem.php
4 * @brief Storage backend system
7 namespace Friendica\Model\Storage;
9 use Friendica\Core\Config;
10 use Friendica\Core\L10n;
11 use Friendica\Core\Logger;
12 use Friendica\Util\Strings;
15 * @brief Filesystem based storage backend
17 * This class manage data on filesystem.
18 * Base folder for storage is set in storage.filesystem_path.
19 * Best would be for storage folder to be outside webserver folder, we are using a
20 * folder relative to code tree root as default to ease things for users in shared hostings.
21 * Each new resource gets a value as reference and is saved in a
22 * folder tree stucture created from that value.
24 class Filesystem implements IStorage
26 // Default base folder
27 const DEFAULT_BASE_FOLDER = "storage";
29 private static function getBasePath()
31 return Config::get("storage", "filesystem_path", self::DEFAULT_BASE_FOLDER);
35 * @brief Split data ref and return file path
36 * @param string $ref Data reference
39 private static function pathForRef($ref)
41 $base = self::getBasePath();
42 $fold1 = substr($ref, 0, 2);
43 $fold2 = substr($ref, 2, 2);
44 $file = substr($ref, 4);
46 return "{$base}/{$fold1}/{$fold2}/{$file}";
49 public static function get($ref)
51 $file = self::pathForRef($ref);
52 if (!is_file($file)) {
56 return file_get_contents($file);
59 public static function put($data, $ref = "")
62 $ref = Strings::getRandomHex();
65 $file = self::pathForRef($ref);
66 $path = dirname($file);
69 if (!mkdir($path, 0770, true)) {
70 Logger::log("Failed to create dirs {$path}");
71 echo L10n::t("Filesystem storage failed to create '%s'. Check you write permissions.", $path);
76 $r = file_put_contents($file, $data);
78 Logger::log("Failed to write data to {$file}");
79 echo L10n::t("Filesystem storage failed to save data to '%s'. Check your write permissions", $file);
85 public static function delete($ref)
87 $file = self::pathForRef($ref);
88 // return true if file doesn't exists. we want to delete it: success with zero work!
89 if (!is_file($file)) {