123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737 |
- <?php
- namespace OC\Files;
- use OC\Files\Mount\MountPoint;
- use OC\User\NoUserException;
- use OCP\Cache\CappedMemoryCache;
- use OCP\EventDispatcher\IEventDispatcher;
- use OCP\Files\Events\Node\FilesystemTornDownEvent;
- use OCP\Files\Mount\IMountManager;
- use OCP\Files\NotFoundException;
- use OCP\Files\Storage\IStorageFactory;
- use OCP\IUser;
- use OCP\IUserManager;
- use OCP\IUserSession;
- use Psr\Log\LoggerInterface;
- class Filesystem {
- private static ?Mount\Manager $mounts = null;
- public static bool $loaded = false;
- private static ?View $defaultInstance = null;
- private static ?CappedMemoryCache $normalizedPathCache = null;
-
- private static ?array $blacklist = null;
-
- public const CLASSNAME = 'OC_Filesystem';
-
- public const signal_rename = 'rename';
-
- public const signal_post_rename = 'post_rename';
-
- public const signal_create = 'create';
-
- public const signal_post_create = 'post_create';
-
- public const signal_copy = 'copy';
-
- public const signal_post_copy = 'post_copy';
-
- public const signal_write = 'write';
-
- public const signal_post_write = 'post_write';
-
- public const signal_update = 'update';
-
- public const signal_post_update = 'post_update';
-
- public const signal_read = 'read';
-
- public const signal_delete = 'delete';
-
- public const signal_param_path = 'path';
- public const signal_param_oldpath = 'oldpath';
- public const signal_param_newpath = 'newpath';
-
- public const signal_param_run = 'run';
- public const signal_create_mount = 'create_mount';
- public const signal_delete_mount = 'delete_mount';
- public const signal_param_mount_type = 'mounttype';
- public const signal_param_users = 'users';
- private static ?\OC\Files\Storage\StorageFactory $loader = null;
- private static bool $logWarningWhenAddingStorageWrapper = true;
-
- public static function logWarningWhenAddingStorageWrapper(bool $shouldLog): bool {
- $previousValue = self::$logWarningWhenAddingStorageWrapper;
- self::$logWarningWhenAddingStorageWrapper = $shouldLog;
- return $previousValue;
- }
-
- public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) {
- if (self::$logWarningWhenAddingStorageWrapper) {
- \OCP\Server::get(LoggerInterface::class)->warning("Storage wrapper '{wrapper}' was not registered via the 'OC_Filesystem - preSetup' hook which could cause potential problems.", [
- 'wrapper' => $wrapperName,
- 'app' => 'filesystem',
- ]);
- }
- $mounts = self::getMountManager()->getAll();
- if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) {
-
- return;
- }
- }
-
- public static function getLoader() {
- if (!self::$loader) {
- self::$loader = \OC::$server->get(IStorageFactory::class);
- }
- return self::$loader;
- }
-
- public static function getMountManager(): Mount\Manager {
- self::initMountManager();
- assert(self::$mounts !== null);
- return self::$mounts;
- }
-
- public static function getMountPoint($path) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- $mount = self::$mounts->find($path);
- return $mount->getMountPoint();
- }
-
- public static function getMountPoints($path) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- $result = [];
- $mounts = self::$mounts->findIn($path);
- foreach ($mounts as $mount) {
- $result[] = $mount->getMountPoint();
- }
- return $result;
- }
-
- public static function getStorage($mountPoint) {
- $mount = self::getMountManager()->find($mountPoint);
- return $mount->getStorage();
- }
-
- public static function getMountByStorageId($id) {
- return self::getMountManager()->findByStorageId($id);
- }
-
- public static function getMountByNumericId($id) {
- return self::getMountManager()->findByNumericId($id);
- }
-
- public static function resolvePath($path): array {
- $mount = self::getMountManager()->find($path);
- return [$mount->getStorage(), rtrim($mount->getInternalPath($path), '/')];
- }
- public static function init(string|IUser|null $user, string $root): bool {
- if (self::$defaultInstance) {
- return false;
- }
- self::initInternal($root);
-
- self::initMountPoints($user);
- return true;
- }
- public static function initInternal(string $root): bool {
- if (self::$defaultInstance) {
- return false;
- }
- self::getLoader();
- self::$defaultInstance = new View($root);
-
- $eventDispatcher = \OC::$server->get(IEventDispatcher::class);
- $eventDispatcher->addListener(FilesystemTornDownEvent::class, function () {
- self::$defaultInstance = null;
- self::$loaded = false;
- });
- self::initMountManager();
- self::$loaded = true;
- return true;
- }
- public static function initMountManager(): void {
- if (!self::$mounts) {
- self::$mounts = \OC::$server->get(IMountManager::class);
- }
- }
-
- public static function initMountPoints(string|IUser|null $user = ''): void {
-
- $userManager = \OC::$server->get(IUserManager::class);
- $userObject = ($user instanceof IUser) ? $user : $userManager->get($user);
- if ($userObject) {
-
- $setupManager = \OC::$server->get(SetupManager::class);
- $setupManager->setupForUser($userObject);
- } else {
- throw new NoUserException();
- }
- }
-
- public static function getView(): ?View {
- if (!self::$defaultInstance) {
-
- $session = \OC::$server->get(IUserSession::class);
- $user = $session->getUser();
- if ($user) {
- $userDir = '/' . $user->getUID() . '/files';
- self::initInternal($userDir);
- }
- }
- return self::$defaultInstance;
- }
-
- public static function tearDown() {
- \OC_Util::tearDownFS();
- }
-
- public static function getRoot() {
- if (!self::$defaultInstance) {
- return null;
- }
- return self::$defaultInstance->getRoot();
- }
-
- public static function mount($class, $arguments, $mountpoint) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- $mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader());
- self::$mounts->addMount($mount);
- }
-
- public static function getLocalFile(string $path): string|false {
- return self::$defaultInstance->getLocalFile($path);
- }
-
- public static function getLocalPath($path) {
- $datadir = \OC_User::getHome(\OC_User::getUser()) . '/files';
- $newpath = $path;
- if (strncmp($newpath, $datadir, strlen($datadir)) == 0) {
- $newpath = substr($path, strlen($datadir));
- }
- return $newpath;
- }
-
- public static function isValidPath($path) {
- $path = self::normalizePath($path);
- if (!$path || $path[0] !== '/') {
- $path = '/' . $path;
- }
- if (str_contains($path, '/../') || strrchr($path, '/') === '/..') {
- return false;
- }
- return true;
- }
-
- public static function isFileBlacklisted($filename) {
- $filename = self::normalizePath($filename);
- if (self::$blacklist === null) {
- self::$blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', ['.htaccess']);
- }
- $filename = strtolower(basename($filename));
- return in_array($filename, self::$blacklist);
- }
-
- public static function isIgnoredDir($dir) {
- if ($dir === '.' || $dir === '..') {
- return true;
- }
- return false;
- }
-
- public static function mkdir($path) {
- return self::$defaultInstance->mkdir($path);
- }
- public static function rmdir($path) {
- return self::$defaultInstance->rmdir($path);
- }
- public static function is_dir($path) {
- return self::$defaultInstance->is_dir($path);
- }
- public static function is_file($path) {
- return self::$defaultInstance->is_file($path);
- }
- public static function stat($path) {
- return self::$defaultInstance->stat($path);
- }
- public static function filetype($path) {
- return self::$defaultInstance->filetype($path);
- }
- public static function filesize($path) {
- return self::$defaultInstance->filesize($path);
- }
- public static function readfile($path) {
- return self::$defaultInstance->readfile($path);
- }
- public static function isCreatable($path) {
- return self::$defaultInstance->isCreatable($path);
- }
- public static function isReadable($path) {
- return self::$defaultInstance->isReadable($path);
- }
- public static function isUpdatable($path) {
- return self::$defaultInstance->isUpdatable($path);
- }
- public static function isDeletable($path) {
- return self::$defaultInstance->isDeletable($path);
- }
- public static function isSharable($path) {
- return self::$defaultInstance->isSharable($path);
- }
- public static function file_exists($path) {
- return self::$defaultInstance->file_exists($path);
- }
- public static function filemtime($path) {
- return self::$defaultInstance->filemtime($path);
- }
- public static function touch($path, $mtime = null) {
- return self::$defaultInstance->touch($path, $mtime);
- }
-
- public static function file_get_contents($path) {
- return self::$defaultInstance->file_get_contents($path);
- }
- public static function file_put_contents($path, $data) {
- return self::$defaultInstance->file_put_contents($path, $data);
- }
- public static function unlink($path) {
- return self::$defaultInstance->unlink($path);
- }
- public static function rename($source, $target) {
- return self::$defaultInstance->rename($source, $target);
- }
- public static function copy($source, $target) {
- return self::$defaultInstance->copy($source, $target);
- }
- public static function fopen($path, $mode) {
- return self::$defaultInstance->fopen($path, $mode);
- }
-
- public static function toTmpFile($path): string|false {
- return self::$defaultInstance->toTmpFile($path);
- }
- public static function fromTmpFile($tmpFile, $path) {
- return self::$defaultInstance->fromTmpFile($tmpFile, $path);
- }
- public static function getMimeType($path) {
- return self::$defaultInstance->getMimeType($path);
- }
- public static function hash($type, $path, $raw = false) {
- return self::$defaultInstance->hash($type, $path, $raw);
- }
- public static function free_space($path = '/') {
- return self::$defaultInstance->free_space($path);
- }
- public static function search($query) {
- return self::$defaultInstance->search($query);
- }
-
- public static function searchByMime($query) {
- return self::$defaultInstance->searchByMime($query);
- }
-
- public static function searchByTag($tag, $userId) {
- return self::$defaultInstance->searchByTag($tag, $userId);
- }
-
- public static function hasUpdated($path, $time) {
- return self::$defaultInstance->hasUpdated($path, $time);
- }
-
- public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false, $keepUnicode = false) {
-
- $path = (string)$path;
- if ($path === '') {
- return '/';
- }
- if (is_null(self::$normalizedPathCache)) {
- self::$normalizedPathCache = new CappedMemoryCache(2048);
- }
- $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]);
- if ($cacheKey && isset(self::$normalizedPathCache[$cacheKey])) {
- return self::$normalizedPathCache[$cacheKey];
- }
-
- if (!$keepUnicode) {
- $path = \OC_Util::normalizeUnicode($path);
- }
-
- $path = '/' . $path;
- $patterns = [
- '#\\\\#s',
- '#/\.(/\.)*/#s',
- '#\//+#s',
- '#/\.$#s',
- ];
- do {
- $count = 0;
- $path = preg_replace($patterns, '/', $path, -1, $count);
- } while ($count > 0);
-
- if ($stripTrailingSlash && strlen($path) > 1) {
- $path = rtrim($path, '/');
- }
- self::$normalizedPathCache[$cacheKey] = $path;
- return $path;
- }
-
- public static function getFileInfo($path, $includeMountPoints = true) {
- return self::getView()->getFileInfo($path, $includeMountPoints);
- }
-
- public static function putFileInfo($path, $data) {
- return self::$defaultInstance->putFileInfo($path, $data);
- }
-
- public static function getDirectoryContent($directory, $mimetype_filter = '') {
- return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter);
- }
-
- public static function getPath($id) {
- return self::$defaultInstance->getPath($id);
- }
-
- public static function getOwner($path) {
- return self::$defaultInstance->getOwner($path);
- }
-
- public static function getETag(string $path): string|false {
- return self::$defaultInstance->getETag($path);
- }
- }
|