|
|
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Christopher Schäpers <kondou@ts.unde.re>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Florin Peter <github@florin-peter.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author korelstar <korelstar@users.noreply.github.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Michael Gapczynski <GapczynskiM@gmail.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Sam Tuke <mail@samtuke.com>
- * @author Stephan Peijnik <speijnik@anexia-it.com>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
-
- /**
- * Class for abstraction of filesystem functions
- * This class won't call any filesystem functions for itself but will pass them to the correct OC_Filestorage object
- * this class should also handle all the file permission related stuff
- *
- * Hooks provided:
- * read(path)
- * write(path, &run)
- * post_write(path)
- * create(path, &run) (when a file is created, both create and write will be emitted in that order)
- * post_create(path)
- * delete(path, &run)
- * post_delete(path)
- * rename(oldpath,newpath, &run)
- * post_rename(oldpath,newpath)
- * copy(oldpath,newpath, &run) (if the newpath doesn't exists yes, copy, create and write will be emitted in that order)
- * post_rename(oldpath,newpath)
- * post_initMountPoints(user, user_dir)
- *
- * the &run parameter can be set to false to prevent the operation from occurring
- */
-
- namespace OC\Files;
-
- use OC\Cache\CappedMemoryCache;
- use OC\Files\Config\MountProviderCollection;
- use OC\Files\Mount\MountPoint;
- use OC\Lockdown\Filesystem\NullStorage;
- use OCP\Files\Config\IMountProvider;
- use OCP\Files\NotFoundException;
- use OCP\Files\Storage\IStorageFactory;
- use OCP\ILogger;
- use OCP\IUserManager;
-
- class Filesystem {
-
- /**
- * @var Mount\Manager $mounts
- */
- private static $mounts;
-
- public static $loaded = false;
- /**
- * @var \OC\Files\View $defaultInstance
- */
- private static $defaultInstance;
-
- private static $usersSetup = [];
-
- private static $normalizedPathCache = null;
-
- private static $listeningForProviders = false;
-
- /**
- * classname which used for hooks handling
- * used as signalclass in OC_Hooks::emit()
- */
- public const CLASSNAME = 'OC_Filesystem';
-
- /**
- * signalname emitted before file renaming
- *
- * @param string $oldpath
- * @param string $newpath
- */
- public const signal_rename = 'rename';
-
- /**
- * signal emitted after file renaming
- *
- * @param string $oldpath
- * @param string $newpath
- */
- public const signal_post_rename = 'post_rename';
-
- /**
- * signal emitted before file/dir creation
- *
- * @param string $path
- * @param bool $run changing this flag to false in hook handler will cancel event
- */
- public const signal_create = 'create';
-
- /**
- * signal emitted after file/dir creation
- *
- * @param string $path
- * @param bool $run changing this flag to false in hook handler will cancel event
- */
- public const signal_post_create = 'post_create';
-
- /**
- * signal emits before file/dir copy
- *
- * @param string $oldpath
- * @param string $newpath
- * @param bool $run changing this flag to false in hook handler will cancel event
- */
- public const signal_copy = 'copy';
-
- /**
- * signal emits after file/dir copy
- *
- * @param string $oldpath
- * @param string $newpath
- */
- public const signal_post_copy = 'post_copy';
-
- /**
- * signal emits before file/dir save
- *
- * @param string $path
- * @param bool $run changing this flag to false in hook handler will cancel event
- */
- public const signal_write = 'write';
-
- /**
- * signal emits after file/dir save
- *
- * @param string $path
- */
- public const signal_post_write = 'post_write';
-
- /**
- * signal emitted before file/dir update
- *
- * @param string $path
- * @param bool $run changing this flag to false in hook handler will cancel event
- */
- public const signal_update = 'update';
-
- /**
- * signal emitted after file/dir update
- *
- * @param string $path
- * @param bool $run changing this flag to false in hook handler will cancel event
- */
- public const signal_post_update = 'post_update';
-
- /**
- * signal emits when reading file/dir
- *
- * @param string $path
- */
- public const signal_read = 'read';
-
- /**
- * signal emits when removing file/dir
- *
- * @param string $path
- */
- public const signal_delete = 'delete';
-
- /**
- * parameters definitions for signals
- */
- public const signal_param_path = 'path';
- public const signal_param_oldpath = 'oldpath';
- public const signal_param_newpath = 'newpath';
-
- /**
- * run - changing this flag to false in hook handler will cancel event
- */
- 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';
-
- /**
- * @var \OC\Files\Storage\StorageFactory $loader
- */
- private static $loader;
-
- /** @var bool */
- private static $logWarningWhenAddingStorageWrapper = true;
-
- /**
- * @param bool $shouldLog
- * @return bool previous value
- * @internal
- */
- public static function logWarningWhenAddingStorageWrapper($shouldLog) {
- $previousValue = self::$logWarningWhenAddingStorageWrapper;
- self::$logWarningWhenAddingStorageWrapper = (bool) $shouldLog;
- return $previousValue;
- }
-
- /**
- * @param string $wrapperName
- * @param callable $wrapper
- * @param int $priority
- */
- public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) {
- if (self::$logWarningWhenAddingStorageWrapper) {
- \OC::$server->getLogger()->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)) {
- // do not re-wrap if storage with this name already existed
- return;
- }
- }
-
- /**
- * Returns the storage factory
- *
- * @return IStorageFactory
- */
- public static function getLoader() {
- if (!self::$loader) {
- self::$loader = \OC::$server->query(IStorageFactory::class);
- }
- return self::$loader;
- }
-
- /**
- * Returns the mount manager
- *
- * @return \OC\Files\Mount\Manager
- */
- public static function getMountManager($user = '') {
- if (!self::$mounts) {
- \OC_Util::setupFS($user);
- }
- return self::$mounts;
- }
-
- /**
- * get the mountpoint of the storage object for a path
- * ( note: because a storage is not always mounted inside the fakeroot, the
- * returned mountpoint is relative to the absolute root of the filesystem
- * and doesn't take the chroot into account )
- *
- * @param string $path
- * @return string
- */
- public static function getMountPoint($path) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- $mount = self::$mounts->find($path);
- if ($mount) {
- return $mount->getMountPoint();
- } else {
- return '';
- }
- }
-
- /**
- * get a list of all mount points in a directory
- *
- * @param string $path
- * @return string[]
- */
- 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;
- }
-
- /**
- * get the storage mounted at $mountPoint
- *
- * @param string $mountPoint
- * @return \OC\Files\Storage\Storage
- */
- public static function getStorage($mountPoint) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- $mount = self::$mounts->find($mountPoint);
- return $mount->getStorage();
- }
-
- /**
- * @param string $id
- * @return Mount\MountPoint[]
- */
- public static function getMountByStorageId($id) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- return self::$mounts->findByStorageId($id);
- }
-
- /**
- * @param int $id
- * @return Mount\MountPoint[]
- */
- public static function getMountByNumericId($id) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- return self::$mounts->findByNumericId($id);
- }
-
- /**
- * resolve a path to a storage and internal path
- *
- * @param string $path
- * @return array an array consisting of the storage and the internal path
- */
- public static function resolvePath($path) {
- if (!self::$mounts) {
- \OC_Util::setupFS();
- }
- $mount = self::$mounts->find($path);
- if ($mount) {
- return [$mount->getStorage(), rtrim($mount->getInternalPath($path), '/')];
- } else {
- return [null, null];
- }
- }
-
- public static function init($user, $root) {
- if (self::$defaultInstance) {
- return false;
- }
- self::getLoader();
- self::$defaultInstance = new View($root);
-
- if (!self::$mounts) {
- self::$mounts = \OC::$server->getMountManager();
- }
-
- //load custom mount config
- self::initMountPoints($user);
-
- self::$loaded = true;
-
- return true;
- }
-
- public static function initMountManager() {
- if (!self::$mounts) {
- self::$mounts = \OC::$server->getMountManager();
- }
- }
-
- /**
- * Initialize system and personal mount points for a user
- *
- * @param string $user
- * @throws \OC\User\NoUserException if the user is not available
- */
- public static function initMountPoints($user = '') {
- if ($user == '') {
- $user = \OC_User::getUser();
- }
- if ($user === null || $user === false || $user === '') {
- throw new \OC\User\NoUserException('Attempted to initialize mount points for null user and no user in session');
- }
-
- if (isset(self::$usersSetup[$user])) {
- return;
- }
-
- self::$usersSetup[$user] = true;
-
- $userManager = \OC::$server->getUserManager();
- $userObject = $userManager->get($user);
-
- if (is_null($userObject)) {
- \OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, ILogger::ERROR);
- // reset flag, this will make it possible to rethrow the exception if called again
- unset(self::$usersSetup[$user]);
- throw new \OC\User\NoUserException('Backends provided no user object for ' . $user);
- }
-
- $realUid = $userObject->getUID();
- // workaround in case of different casings
- if ($user !== $realUid) {
- $stack = json_encode(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 50));
- \OCP\Util::writeLog('files', 'initMountPoints() called with wrong user casing. This could be a bug. Expected: "' . $realUid . '" got "' . $user . '". Stack: ' . $stack, ILogger::WARN);
- $user = $realUid;
-
- // again with the correct casing
- if (isset(self::$usersSetup[$user])) {
- return;
- }
-
- self::$usersSetup[$user] = true;
- }
-
- if (\OC::$server->getLockdownManager()->canAccessFilesystem()) {
- /** @var \OC\Files\Config\MountProviderCollection $mountConfigManager */
- $mountConfigManager = \OC::$server->getMountProviderCollection();
-
- // home mounts are handled seperate since we need to ensure this is mounted before we call the other mount providers
- $homeMount = $mountConfigManager->getHomeMountForUser($userObject);
- self::getMountManager()->addMount($homeMount);
-
- if ($homeMount->getStorageRootId() === -1) {
- $homeMount->getStorage()->mkdir('');
- $homeMount->getStorage()->getScanner()->scan('');
- }
-
- \OC\Files\Filesystem::getStorage($user);
-
- // Chance to mount for other storages
- if ($userObject) {
- $mounts = $mountConfigManager->addMountForUser($userObject, self::getMountManager());
- $mounts[] = $homeMount;
- $mountConfigManager->registerMounts($userObject, $mounts);
- }
-
- self::listenForNewMountProviders($mountConfigManager, $userManager);
- } else {
- self::getMountManager()->addMount(new MountPoint(
- new NullStorage([]),
- '/' . $user
- ));
- self::getMountManager()->addMount(new MountPoint(
- new NullStorage([]),
- '/' . $user . '/files'
- ));
- }
- \OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', ['user' => $user]);
- }
-
- /**
- * Get mounts from mount providers that are registered after setup
- *
- * @param MountProviderCollection $mountConfigManager
- * @param IUserManager $userManager
- */
- private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) {
- if (!self::$listeningForProviders) {
- self::$listeningForProviders = true;
- $mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) {
- foreach (Filesystem::$usersSetup as $user => $setup) {
- $userObject = $userManager->get($user);
- if ($userObject) {
- $mounts = $provider->getMountsForUser($userObject, Filesystem::getLoader());
- array_walk($mounts, [self::$mounts, 'addMount']);
- }
- }
- });
- }
- }
-
- /**
- * get the default filesystem view
- *
- * @return View
- */
- public static function getView() {
- return self::$defaultInstance;
- }
-
- /**
- * tear down the filesystem, removing all storage providers
- */
- public static function tearDown() {
- self::clearMounts();
- self::$defaultInstance = null;
- }
-
- /**
- * get the relative path of the root data directory for the current user
- *
- * @return string
- *
- * Returns path like /admin/files
- */
- public static function getRoot() {
- if (!self::$defaultInstance) {
- return null;
- }
- return self::$defaultInstance->getRoot();
- }
-
- /**
- * clear all mounts and storage backends
- */
- public static function clearMounts() {
- if (self::$mounts) {
- self::$usersSetup = [];
- self::$mounts->clear();
- }
- }
-
- /**
- * mount an \OC\Files\Storage\Storage in our virtual filesystem
- *
- * @param \OC\Files\Storage\Storage|string $class
- * @param array $arguments
- * @param string $mountpoint
- */
- 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);
- }
-
- /**
- * return the path to a local version of the file
- * we need this because we can't know if a file is stored local or not from
- * outside the filestorage and for some purposes a local file is needed
- *
- * @param string $path
- * @return string
- */
- public static function getLocalFile($path) {
- return self::$defaultInstance->getLocalFile($path);
- }
-
- /**
- * @param string $path
- * @return string
- */
- public static function getLocalFolder($path) {
- return self::$defaultInstance->getLocalFolder($path);
- }
-
- /**
- * return path to file which reflects one visible in browser
- *
- * @param string $path
- * @return string
- */
- 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;
- }
-
- /**
- * check if the requested path is valid
- *
- * @param string $path
- * @return bool
- */
- public static function isValidPath($path) {
- $path = self::normalizePath($path);
- if (!$path || $path[0] !== '/') {
- $path = '/' . $path;
- }
- if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
- return false;
- }
- return true;
- }
-
- /**
- * checks if a file is blacklisted for storage in the filesystem
- * Listens to write and rename hooks
- *
- * @param array $data from hook
- */
- public static function isBlacklisted($data) {
- if (isset($data['path'])) {
- $path = $data['path'];
- } elseif (isset($data['newpath'])) {
- $path = $data['newpath'];
- }
- if (isset($path)) {
- if (self::isFileBlacklisted($path)) {
- $data['run'] = false;
- }
- }
- }
-
- /**
- * @param string $filename
- * @return bool
- */
- public static function isFileBlacklisted($filename) {
- $filename = self::normalizePath($filename);
-
- $blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', ['.htaccess']);
- $filename = strtolower(basename($filename));
- return in_array($filename, $blacklist);
- }
-
- /**
- * check if the directory should be ignored when scanning
- * NOTE: the special directories . and .. would cause never ending recursion
- *
- * @param string $dir
- * @return boolean
- */
- public static function isIgnoredDir($dir) {
- if ($dir === '.' || $dir === '..') {
- return true;
- }
- return false;
- }
-
- /**
- * following functions are equivalent to their php builtin equivalents for arguments/return values.
- */
- 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);
- }
-
- /**
- * @return string
- */
- 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($path1, $path2) {
- return self::$defaultInstance->rename($path1, $path2);
- }
-
- public static function copy($path1, $path2) {
- return self::$defaultInstance->copy($path1, $path2);
- }
-
- public static function fopen($path, $mode) {
- return self::$defaultInstance->fopen($path, $mode);
- }
-
- /**
- * @return string
- */
- public static function toTmpFile($path) {
- 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);
- }
-
- /**
- * @param string $query
- */
- public static function searchByMime($query) {
- return self::$defaultInstance->searchByMime($query);
- }
-
- /**
- * @param string|int $tag name or tag id
- * @param string $userId owner of the tags
- * @return FileInfo[] array or file info
- */
- public static function searchByTag($tag, $userId) {
- return self::$defaultInstance->searchByTag($tag, $userId);
- }
-
- /**
- * check if a file or folder has been updated since $time
- *
- * @param string $path
- * @param int $time
- * @return bool
- */
- public static function hasUpdated($path, $time) {
- return self::$defaultInstance->hasUpdated($path, $time);
- }
-
- /**
- * Fix common problems with a file path
- *
- * @param string $path
- * @param bool $stripTrailingSlash whether to strip the trailing slash
- * @param bool $isAbsolutePath whether the given path is absolute
- * @param bool $keepUnicode true to disable unicode normalization
- * @return string
- */
- public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false, $keepUnicode = false) {
- if (is_null(self::$normalizedPathCache)) {
- self::$normalizedPathCache = new CappedMemoryCache(2048);
- }
-
- /**
- * FIXME: This is a workaround for existing classes and files which call
- * this function with another type than a valid string. This
- * conversion should get removed as soon as all existing
- * function calls have been fixed.
- */
- $path = (string)$path;
-
- $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]);
-
- if ($cacheKey && isset(self::$normalizedPathCache[$cacheKey])) {
- return self::$normalizedPathCache[$cacheKey];
- }
-
- if ($path === '') {
- return '/';
- }
-
- //normalize unicode if possible
- if (!$keepUnicode) {
- $path = \OC_Util::normalizeUnicode($path);
- }
-
- //add leading slash, if it is already there we strip it anyway
- $path = '/' . $path;
-
- $patterns = [
- '/\\\\/s', // no windows style slashes
- '/\/\.(\/\.)?\//s', // remove '/./'
- '/\/{2,}/s', // remove sequence of slashes
- '/\/\.$/s', // remove trailing /.
- ];
-
- do {
- $count = 0;
- $path = preg_replace($patterns, '/', $path, -1, $count);
- } while ($count > 0);
-
- //remove trailing slash
- if ($stripTrailingSlash && strlen($path) > 1) {
- $path = rtrim($path, '/');
- }
-
- self::$normalizedPathCache[$cacheKey] = $path;
-
- return $path;
- }
-
- /**
- * get the filesystem info
- *
- * @param string $path
- * @param boolean $includeMountPoints whether to add mountpoint sizes,
- * defaults to true
- * @return \OC\Files\FileInfo|bool False if file does not exist
- */
- public static function getFileInfo($path, $includeMountPoints = true) {
- return self::$defaultInstance->getFileInfo($path, $includeMountPoints);
- }
-
- /**
- * change file metadata
- *
- * @param string $path
- * @param array $data
- * @return int
- *
- * returns the fileid of the updated file
- */
- public static function putFileInfo($path, $data) {
- return self::$defaultInstance->putFileInfo($path, $data);
- }
-
- /**
- * get the content of a directory
- *
- * @param string $directory path under datadirectory
- * @param string $mimetype_filter limit returned content to this mimetype or mimepart
- * @return \OC\Files\FileInfo[]
- */
- public static function getDirectoryContent($directory, $mimetype_filter = '') {
- return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter);
- }
-
- /**
- * Get the path of a file by id
- *
- * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file
- *
- * @param int $id
- * @throws NotFoundException
- * @return string
- */
- public static function getPath($id) {
- return self::$defaultInstance->getPath($id);
- }
-
- /**
- * Get the owner for a file or folder
- *
- * @param string $path
- * @return string
- */
- public static function getOwner($path) {
- return self::$defaultInstance->getOwner($path);
- }
-
- /**
- * get the ETag for a file or folder
- *
- * @param string $path
- * @return string
- */
- public static function getETag($path) {
- return self::$defaultInstance->getETag($path);
- }
- }
|