lib/private/Files/Filesystem.php
<?php
/**
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Christopher Schäpers <kondou@ts.unde.re>
* @author Florin Peter <github@florin-peter.de>
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Martin Mattel <martin.mattel@diemattels.at>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <rullzer@owncloud.com>
* @author Sam Tuke <mail@samtuke.com>
* @author Stephan Peijnik <speijnik@anexia-it.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2018, ownCloud GmbH
* @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\Storage\StorageFactory;
use OCP\Files\Config\IMountProvider;
use OCP\Files\NotFoundException;
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()->debug("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 \OCP\Files\Storage\IStorageFactory
*/
public static function getLoader() {
if (!self::$loader) {
self::$loader = new StorageFactory();
}
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, $fullInit = true) {
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, $fullInit);
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 = '', $fullInit = true) {
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 ($userObject === null) {
$msg = "Backends provided no user object for $user";
\OC::$server->getLogger()->error($msg, ['app' => __CLASS__]);
// reset flag, this will make it possible to rethrow the exception if called again
unset(self::$usersSetup[$user]);
throw new \OC\User\NoUserException($msg);
}
$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, \OCP\Util::DEBUG);
$user = $realUid;
// again with the correct casing
if (isset(self::$usersSetup[$user])) {
return;
}
self::$usersSetup[$user] = true;
}
/** @var \OC\Files\Config\MountProviderCollection $mountConfigManager */
$mountConfigManager = \OC::$server->getMountProviderCollection();
'@phan-var \OC\Files\Config\MountProviderCollection $mountConfigManager';
// home mounts are handled separate since we need to ensure this is mounted before we call the other mount providers
$homeMount = $mountConfigManager->getHomeMountForUser($userObject);
self::getMountManager()->addMount($homeMount);
\OC\Files\Filesystem::getStorage($user);
if ($fullInit) {
// Chance to mount for other storages
if ($userObject) {
$mounts = $mountConfigManager->getMountsForUser($userObject);
\array_walk($mounts, [self::$mounts, 'addMount']);
$mounts[] = $homeMount;
$mountConfigManager->registerMounts($userObject, $mounts);
}
self::listenForNewMountProviders($mountConfigManager, $userManager);
\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 isForbiddenFileOrDir_Hook($data) {
if (isset($data['path'])) {
$path = $data['path'];
} elseif (isset($data['newpath'])) {
$path = $data['newpath'];
}
if (isset($path)) {
if (self::isForbiddenFileOrDir($path)) {
$data['run'] = false;
}
}
}
/**
* deprecated, replaced by isForbiddenFileOrDir
* @param string $filename
* @return boolean
*/
public static function isFileBlacklisted($filename) {
return self::isForbiddenFileOrDir($filename);
}
/**
* 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;
}
/**
* Return a string describing the last regex error cause.
*
* @return string
* @see https://www.php.net/manual/function.preg-last-error.php
*/
private static function pregErrorText() {
$errors = [
PREG_NO_ERROR => 'Code 0 : No errors',
PREG_INTERNAL_ERROR => 'Code 1 : Internal PCRE error, most likely a syntax error',
PREG_BACKTRACK_LIMIT_ERROR => 'Code 2 : Backtrack limit was exhausted',
PREG_RECURSION_LIMIT_ERROR => 'Code 3 : Recursion limit was exhausted',
PREG_BAD_UTF8_ERROR => 'Code 4 : The offset did not correspond to the beginning of a valid UTF-8 code point',
PREG_BAD_UTF8_OFFSET_ERROR => 'Code 5 : Malformed UTF-8 data',
PREG_JIT_STACKLIMIT_ERROR => 'Code 6 : Just-in-time compiler stack limit reached',
];
return $errors[\preg_last_error()];
}
/**
* Regex validity check.
*
* @param string $regexToBeChecked regex to be checked
* @param string $callerMessage message from the calling function to identify where it is coming from
* @return boolean
*/
private static function regexValidityCheck($regexToBeChecked, $callerMessage = '') {
if (\preg_last_error() !== PREG_NO_ERROR) {
\OC::$server->getLogger()->error(
'Regex error: ' . $regexToBeChecked . ' - ' . $callerMessage . ': ' . self::pregErrorText(),
['app' => __CLASS__]
);
return false;
}
return true;
}
/**
* Manage regex against Folder or File.
*
* @param array $regexList Regex array as defined in Config file
* @param array $path Folder path or File contained in an array
* @param string $callerMessage Message from the calling function to identify where a possible error is coming from
* @return boolean folder or file regex status
*/
private static function checkRegexAgainstFolderOrFile($regexList, $path, $callerMessage = '') {
foreach ($regexList as $item) {
// check if the first and last character is a '/' and add one if not
// terminate with i == case insensitive
$newItem = $item;
if (\substr($item, 0, 1) !== '/') {
$newItem = '/' . $item;
}
if (\substr($item, -1) !== '/') {
$newItem = $newItem . '/i';
} else {
$newItem = $newItem . 'i';
}
@\preg_match($newItem, null);
if (self::regexValidityCheck($item, $callerMessage)) {
foreach ($path as $pathPart) {
if (@\preg_match($newItem, $pathPart)
&& self::regexValidityCheck(
$item,
'Checked string: ' . $pathPart
)) {
return true;
}
}
}
}
return false;
}
/**
*
* Check if the directory path / file name contains a Blacklisted or Excluded name as defined in config.
* config.php parameter arrays can contain file names to be blacklisted or directory names to be excluded
* Blacklist ... files that may harm the owncloud environment like a foreign `.htaccess` file or other unwanted files
* Excluded ... directories that are excluded from being further processed, like snapshot directories
* The parameter $excluded and the query with can be redesigned if filesystem.php will get
* a constructor where it is then possible to define the excluded directory names for unit tests.
*
* @param string $FileOrDir is an array describing full folder path or full filename
* @param array $excluded is only used in conjunction with unit tests as we handover here the blacklisted / excluded
* directory name to be tested against
* @return boolean
*/
public static function isForbiddenFileOrDir($FileOrDir, $excluded = []) {
$blacklistArray = [];
$pathParts = [];
// force blacklist/exclude arraylist/arrayRegex for unit tests
if ($excluded) {
$excludeFolders = $excluded;
$excludeFoldersRegex = $excluded;
$blacklistFiles = $excluded;
$blacklistFilesRegex = $excluded;
} else {
$config = \OC::$server->getSystemConfig();
$excludeFolders = $config->getValue('excluded_directories', []);
$excludeFoldersRegex = $config->getValue('excluded_directories_regex', []);
$blacklistFiles = $config->getValue('blacklisted_files', ['.htaccess']);
$blacklistFilesRegex = $config->getValue('blacklisted_files_regex', []);
}
// empty array elements ('') will cause an infinite loop
// remove double or empty array elements and add exactly one '.htaccess' if not present.
// important, because if you define an empty config value, '.htaccess' will not be added...
// prevents misuse with a fake config value
$blacklistFiles[] = '.htaccess';
$blacklistFiles = \array_unique($blacklistFiles);
$blacklistFiles = \array_values(\array_filter($blacklistFiles));
// removes double or empty array elements
$excludeFolders = \array_unique($excludeFolders);
$excludeFolders = \array_values(\array_filter($excludeFolders));
$excludeFoldersRegex = \array_unique($excludeFoldersRegex);
$excludeFoldersRegex = \array_values(\array_filter($excludeFoldersRegex));
$blacklistFilesRegex = \array_unique($blacklistFilesRegex);
$blacklistFilesRegex = \array_values(\array_filter($blacklistFilesRegex));
// explode '/'
$ppx = \array_filter(\explode('/', $FileOrDir), 'strlen');
$ppx = \array_map('strtolower', $ppx);
// further explode each array element with '\' and add to result array if found
foreach ($ppx as $pp) {
// only add an array element if strlen != 0
$pathParts = \array_merge($pathParts, \array_filter(\explode('\\', $pp), 'strlen'));
}
// force that the last element (possibly the filename) is an entry in an array
// this is necessary for the called functions which expect this to be an array
$blacklistArray[] = \end($pathParts);
// first, check if the folder is excluded
$excludeFolders= \array_map('trim', $excludeFolders);
$excludeFolders= \array_map('strtolower', $excludeFolders);
if (\array_intersect($excludeFolders, $pathParts)) {
return true;
}
if (self::checkRegexAgainstFolderOrFile(
$excludeFoldersRegex,
$pathParts,
"Check excluded_directories_regex variable in config file"
)) {
return true;
}
// second, check if the file is blacklisted
if (\array_intersect($blacklistFiles, $blacklistArray)) {
return true;
}
if (self::checkRegexAgainstFolderOrFile(
$blacklistFilesRegex,
$blacklistArray,
"Check blacklisted_files_regex variable in config file"
)) {
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 opendir($path) {
return self::$defaultInstance->opendir($path);
}
public static function readdir($path) {
return self::$defaultInstance->readdir($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
* @return FileInfo[] array of file info
*/
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 of 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 (self::$normalizedPathCache === null) {
self::$normalizedPathCache = new CappedMemoryCache();
}
/**
* 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 (isset(self::$normalizedPathCache[$cacheKey])) {
return self::$normalizedPathCache[$cacheKey];
}
if ($path == '') {
return '/';
}
//normalize unicode if possible
if (!$keepUnicode) {
$path = \OC_Util::normalizeUnicode($path);
}
//no windows style slashes
$path = \str_replace('\\', '/', $path);
//add leading slash
if ($path[0] !== '/') {
$path = '/' . $path;
}
// remove '/./'
// ugly, but str_replace() can't replace them all in one go
// as the replacement itself is part of the search string
// which will only be found during the next iteration
while (\strpos($path, '/./') !== false) {
$path = \str_replace('/./', '/', $path);
}
// remove sequences of slashes
$path = \preg_replace('#/{2,}#', '/', $path);
//remove trailing slash
if ($stripTrailingSlash and \strlen($path) > 1 and \substr($path, -1, 1) === '/') {
$path = \substr($path, 0, -1);
}
// remove trailing '/.'
if (\substr($path, -2) == '/.') {
$path = \substr($path, 0, -2);
}
$normalizedPath = $path;
self::$normalizedPathCache[$cacheKey] = $normalizedPath;
return $normalizedPath;
}
/**
* 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) {
if (self::$defaultInstance === null) {
throw new NotFoundException("defaultInstance is null");
}
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);
}
/**
* Determines whether primary object storage is enabled on the instance
*
* @return bool
*/
public static function isPrimaryObjectStorageEnabled(): bool {
$config = \OC::$server->getConfig();
$appManager = \OC::$server->getAppManager();
$objectStorageAppEnabled = $appManager->isEnabledForUser('files_primary_s3');
$objectStorage = $config->getSystemValue('objectstore', null);
return $objectStorageAppEnabled && $objectStorage !== null;
}
}