* @author Ashod Nakashian * @author Bart Visscher * @author Björn Schießle * @author Christoph Wurst * @author Florin Peter * @author Jesús Macias * @author Joas Schilling * @author Jörn Friedrich Dreyer * @author Julius Härtl * @author karakayasemi * @author Klaas Freitag * @author korelstar * @author Lukas Reschke * @author Luke Policinski * @author Michael Gapczynski * @author Morris Jobke * @author Piotr Filiciak * @author Robin Appelman * @author Robin McCorkell * @author Roeland Jago Douma * @author Sam Tuke * @author Scott Dutton * @author Thomas Müller * @author Thomas Tanghus * @author Vincent Petry * * @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 * */ namespace OC\Files; use Icewind\Streams\CallbackWrapper; use OC\Files\Mount\MoveableMount; use OC\Files\Storage\Storage; use OC\User\LazyUser; use OC\Share\Share; use OC\User\User; use OC\User\Manager as UserManager; use OCA\Files_Sharing\SharedMount; use OCP\Constants; use OCP\Files\Cache\ICacheEntry; use OCP\Files\EmptyFileNameException; use OCP\Files\FileNameTooLongException; use OCP\Files\InvalidCharacterInPathException; use OCP\Files\InvalidDirectoryException; use OCP\Files\InvalidPathException; use OCP\Files\Mount\IMountPoint; use OCP\Files\NotFoundException; use OCP\Files\ReservedWordException; use OCP\Files\Storage\IStorage; use OCP\IUser; use OCP\Lock\ILockingProvider; use OCP\Lock\LockedException; use Psr\Log\LoggerInterface; /** * Class to provide access to ownCloud filesystem via a "view", and methods for * working with files within that view (e.g. read, write, delete, etc.). Each * view is restricted to a set of directories via a virtual root. The default view * uses the currently logged in user's data directory as root (parts of * OC_Filesystem are merely a wrapper for OC\Files\View). * * Apps that need to access files outside of the user data folders (to modify files * belonging to a user other than the one currently logged in, for example) should * use this class directly rather than using OC_Filesystem, or making use of PHP's * built-in file manipulation functions. This will ensure all hooks and proxies * are triggered correctly. * * Filesystem functions are not called directly; they are passed to the correct * \OC\Files\Storage\Storage object */ class View { private string $fakeRoot = ''; private ILockingProvider $lockingProvider; private bool $lockingEnabled; private bool $updaterEnabled = true; private UserManager $userManager; private LoggerInterface $logger; /** * @throws \Exception If $root contains an invalid path */ public function __construct(string $root = '') { if (!Filesystem::isValidPath($root)) { throw new \Exception(); } $this->fakeRoot = $root; $this->lockingProvider = \OC::$server->getLockingProvider(); $this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider); $this->userManager = \OC::$server->getUserManager(); $this->logger = \OC::$server->get(LoggerInterface::class); } /** * @param ?string $path * @psalm-template S as string|null * @psalm-param S $path * @psalm-return (S is string ? string : null) */ public function getAbsolutePath($path = '/'): ?string { if ($path === null) { return null; } $this->assertPathLength($path); if ($path === '') { $path = '/'; } if ($path[0] !== '/') { $path = '/' . $path; } return $this->fakeRoot . $path; } /** * Change the root to a fake root * * @param string $fakeRoot */ public function chroot($fakeRoot): void { if (!$fakeRoot == '') { if ($fakeRoot[0] !== '/') { $fakeRoot = '/' . $fakeRoot; } } $this->fakeRoot = $fakeRoot; } /** * Get the fake root */ public function getRoot(): string { return $this->fakeRoot; } /** * get path relative to the root of the view * * @param string $path */ public function getRelativePath($path): ?string { $this->assertPathLength($path); if ($this->fakeRoot == '') { return $path; } if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) { return '/'; } // missing slashes can cause wrong matches! $root = rtrim($this->fakeRoot, '/') . '/'; if (strpos($path, $root) !== 0) { return null; } else { $path = substr($path, strlen($this->fakeRoot)); if (strlen($path) === 0) { return '/'; } else { return $path; } } } /** * 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 does not take the chroot into account ) * * @param string $path */ public function getMountPoint($path): string { return Filesystem::getMountPoint($this->getAbsolutePath($path)); } /** * 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 does not take the chroot into account ) * * @param string $path */ public function getMount($path): IMountPoint { return Filesystem::getMountManager()->find($this->getAbsolutePath($path)); } /** * Resolve a path to a storage and internal path * * @param string $path * @return array{?\OCP\Files\Storage\IStorage, string} an array consisting of the storage and the internal path */ public function resolvePath($path): array { $a = $this->getAbsolutePath($path); $p = Filesystem::normalizePath($a); return Filesystem::resolvePath($p); } /** * 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 */ public function getLocalFile($path): string|false { $parent = substr($path, 0, strrpos($path, '/') ?: 0); $path = $this->getAbsolutePath($path); [$storage, $internalPath] = Filesystem::resolvePath($path); if (Filesystem::isValidPath($parent) && $storage) { return $storage->getLocalFile($internalPath); } else { return false; } } /** * the following functions operate with arguments and return values identical * to those of their PHP built-in equivalents. Mostly they are merely wrappers * for \OC\Files\Storage\Storage via basicOperation(). */ public function mkdir($path) { return $this->basicOperation('mkdir', $path, ['create', 'write']); } /** * remove mount point * * @param IMountPoint $mount * @param string $path relative to data/ */ protected function removeMount($mount, $path): bool { if ($mount instanceof MoveableMount) { // cut of /user/files to get the relative path to data/user/files $pathParts = explode('/', $path, 4); $relPath = '/' . $pathParts[3]; $this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true); \OC_Hook::emit( Filesystem::CLASSNAME, "umount", [Filesystem::signal_param_path => $relPath] ); $this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true); $result = $mount->removeMount(); $this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true); if ($result) { \OC_Hook::emit( Filesystem::CLASSNAME, "post_umount", [Filesystem::signal_param_path => $relPath] ); } $this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true); return $result; } else { // do not allow deleting the storage's root / the mount point // because for some storages it might delete the whole contents // but isn't supposed to work that way return false; } } public function disableCacheUpdate(): void { $this->updaterEnabled = false; } public function enableCacheUpdate(): void { $this->updaterEnabled = true; } protected function writeUpdate(Storage $storage, string $internalPath, ?int $time = null): void { if ($this->updaterEnabled) { if (is_null($time)) { $time = time(); } $storage->getUpdater()->update($internalPath, $time); } } protected function removeUpdate(Storage $storage, string $internalPath): void { if ($this->updaterEnabled) { $storage->getUpdater()->remove($internalPath); } } protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, string $sourceInternalPath, string $targetInternalPath): void { if ($this->updaterEnabled) { $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); } } /** * @param string $path * @return bool|mixed */ public function rmdir($path) { $absolutePath = $this->getAbsolutePath($path); $mount = Filesystem::getMountManager()->find($absolutePath); if ($mount->getInternalPath($absolutePath) === '') { return $this->removeMount($mount, $absolutePath); } if ($this->is_dir($path)) { $result = $this->basicOperation('rmdir', $path, ['delete']); } else { $result = false; } if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete $storage = $mount->getStorage(); $internalPath = $mount->getInternalPath($absolutePath); $storage->getUpdater()->remove($internalPath); } return $result; } /** * @param string $path * @return resource|false */ public function opendir($path) { return $this->basicOperation('opendir', $path, ['read']); } /** * @param string $path * @return bool|mixed */ public function is_dir($path) { if ($path == '/') { return true; } return $this->basicOperation('is_dir', $path); } /** * @param string $path * @return bool|mixed */ public function is_file($path) { if ($path == '/') { return false; } return $this->basicOperation('is_file', $path); } /** * @param string $path * @return mixed */ public function stat($path) { return $this->basicOperation('stat', $path); } /** * @param string $path * @return mixed */ public function filetype($path) { return $this->basicOperation('filetype', $path); } /** * @param string $path * @return mixed */ public function filesize(string $path) { return $this->basicOperation('filesize', $path); } /** * @param string $path * @return bool|mixed * @throws InvalidPathException */ public function readfile($path) { $this->assertPathLength($path); if (ob_get_level()) { ob_end_clean(); } $handle = $this->fopen($path, 'rb'); if ($handle) { $chunkSize = 524288; // 512 kB chunks while (!feof($handle)) { echo fread($handle, $chunkSize); flush(); } fclose($handle); return $this->filesize($path); } return false; } /** * @param string $path * @param int $from * @param int $to * @return bool|mixed * @throws InvalidPathException * @throws \OCP\Files\UnseekableException */ public function readfilePart($path, $from, $to) { $this->assertPathLength($path); if (ob_get_level()) { ob_end_clean(); } $handle = $this->fopen($path, 'rb'); if ($handle) { $chunkSize = 524288; // 512 kB chunks $startReading = true; if ($from !== 0 && $from !== '0' && fseek($handle, $from) !== 0) { // forward file handle via chunked fread because fseek seem to have failed $end = $from + 1; while (!feof($handle) && ftell($handle) < $end && ftell($handle) !== $from) { $len = $from - ftell($handle); if ($len > $chunkSize) { $len = $chunkSize; } $result = fread($handle, $len); if ($result === false) { $startReading = false; break; } } } if ($startReading) { $end = $to + 1; while (!feof($handle) && ftell($handle) < $end) { $len = $end - ftell($handle); if ($len > $chunkSize) { $len = $chunkSize; } echo fread($handle, $len); flush(); } return ftell($handle) - $from; } throw new \OCP\Files\UnseekableException('fseek error'); } return false; } /** * @param string $path * @return mixed */ public function isCreatable($path) { return $this->basicOperation('isCreatable', $path); } /** * @param string $path * @return mixed */ public function isReadable($path) { return $this->basicOperation('isReadable', $path); } /** * @param string $path * @return mixed */ public function isUpdatable($path) { return $this->basicOperation('isUpdatable', $path); } /** * @param string $path * @return bool|mixed */ public function isDeletable($path) { $absolutePath = $this->getAbsolutePath($path); $mount = Filesystem::getMountManager()->find($absolutePath); if ($mount->getInternalPath($absolutePath) === '') { return $mount instanceof MoveableMount; } return $this->basicOperation('isDeletable', $path); } /** * @param string $path * @return mixed */ public function isSharable($path) { return $this->basicOperation('isSharable', $path); } /** * @param string $path * @return bool|mixed */ public function file_exists($path) { if ($path == '/') { return true; } return $this->basicOperation('file_exists', $path); } /** * @param string $path * @return mixed */ public function filemtime($path) { return $this->basicOperation('filemtime', $path); } /** * @param string $path * @param int|string $mtime */ public function touch($path, $mtime = null): bool { if (!is_null($mtime) && !is_numeric($mtime)) { $mtime = strtotime($mtime); } $hooks = ['touch']; if (!$this->file_exists($path)) { $hooks[] = 'create'; $hooks[] = 'write'; } try { $result = $this->basicOperation('touch', $path, $hooks, $mtime); } catch (\Exception $e) { $this->logger->info('Error while setting modified time', ['app' => 'core', 'exception' => $e]); $result = false; } if (!$result) { // If create file fails because of permissions on external storage like SMB folders, // check file exists and return false if not. if (!$this->file_exists($path)) { return false; } if (is_null($mtime)) { $mtime = time(); } //if native touch fails, we emulate it by changing the mtime in the cache $this->putFileInfo($path, ['mtime' => floor($mtime)]); } return true; } /** * @param string $path * @return string|false * @throws LockedException */ public function file_get_contents($path) { return $this->basicOperation('file_get_contents', $path, ['read']); } protected function emit_file_hooks_pre(bool $exists, string $path, bool &$run): void { if (!$exists) { \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, [ Filesystem::signal_param_path => $this->getHookPath($path), Filesystem::signal_param_run => &$run, ]); } else { \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, [ Filesystem::signal_param_path => $this->getHookPath($path), Filesystem::signal_param_run => &$run, ]); } \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, [ Filesystem::signal_param_path => $this->getHookPath($path), Filesystem::signal_param_run => &$run, ]); } protected function emit_file_hooks_post(bool $exists, string $path): void { if (!$exists) { \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, [ Filesystem::signal_param_path => $this->getHookPath($path), ]); } else { \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, [ Filesystem::signal_param_path => $this->getHookPath($path), ]); } \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, [ Filesystem::signal_param_path => $this->getHookPath($path), ]); } /** * @param string $path * @param string|resource $data * @return bool|mixed * @throws LockedException */ public function file_put_contents($path, $data) { if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path)); if (Filesystem::isValidPath($path) && !Filesystem::isFileBlacklisted($path) ) { $path = $this->getRelativePath($absolutePath); if ($path === null) { throw new InvalidPathException("Path $absolutePath is not in the expected root"); } $this->lockFile($path, ILockingProvider::LOCK_SHARED); $exists = $this->file_exists($path); $run = true; if ($this->shouldEmitHooks($path)) { $this->emit_file_hooks_pre($exists, $path, $run); } if (!$run) { $this->unlockFile($path, ILockingProvider::LOCK_SHARED); return false; } try { $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE); } catch (\Exception $e) { // Release the shared lock before throwing. $this->unlockFile($path, ILockingProvider::LOCK_SHARED); throw $e; } /** @var Storage $storage */ [$storage, $internalPath] = $this->resolvePath($path); $target = $storage->fopen($internalPath, 'w'); if ($target) { [, $result] = \OC_Helper::streamCopy($data, $target); fclose($target); fclose($data); $this->writeUpdate($storage, $internalPath); $this->changeLock($path, ILockingProvider::LOCK_SHARED); if ($this->shouldEmitHooks($path) && $result !== false) { $this->emit_file_hooks_post($exists, $path); } $this->unlockFile($path, ILockingProvider::LOCK_SHARED); return $result; } else { $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE); return false; } } else { return false; } } else { $hooks = $this->file_exists($path) ? ['update', 'write'] : ['create', 'write']; return $this->basicOperation('file_put_contents', $path, $hooks, $data); } } /** * @param string $path * @return bool|mixed */ public function unlink($path) { if ($path === '' || $path === '/') { // do not allow deleting the root return false; } $postFix = (substr($path, -1) === '/') ? '/' : ''; $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path)); $mount = Filesystem::getMountManager()->find($absolutePath . $postFix); if ($mount->getInternalPath($absolutePath) === '') { return $this->removeMount($mount, $absolutePath); } if ($this->is_dir($path)) { $result = $this->basicOperation('rmdir', $path, ['delete']); } else { $result = $this->basicOperation('unlink', $path, ['delete']); } if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete $storage = $mount->getStorage(); $internalPath = $mount->getInternalPath($absolutePath); $storage->getUpdater()->remove($internalPath); return true; } else { return $result; } } /** * @param string $directory * @return bool|mixed */ public function deleteAll($directory) { return $this->rmdir($directory); } /** * Rename/move a file or folder from the source path to target path. * * @param string $source source path * @param string $target target path * * @return bool|mixed * @throws LockedException */ public function rename($source, $target) { $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($source)); $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($target)); $result = false; if ( Filesystem::isValidPath($target) && Filesystem::isValidPath($source) && !Filesystem::isFileBlacklisted($target) ) { $source = $this->getRelativePath($absolutePath1); $target = $this->getRelativePath($absolutePath2); $exists = $this->file_exists($target); if ($source == null || $target == null) { return false; } $this->lockFile($source, ILockingProvider::LOCK_SHARED, true); try { $this->lockFile($target, ILockingProvider::LOCK_SHARED, true); $run = true; if ($this->shouldEmitHooks($source) && (Cache\Scanner::isPartialFile($source) && !Cache\Scanner::isPartialFile($target))) { // if it was a rename from a part file to a regular file it was a write and not a rename operation $this->emit_file_hooks_pre($exists, $target, $run); } elseif ($this->shouldEmitHooks($source)) { \OC_Hook::emit( Filesystem::CLASSNAME, Filesystem::signal_rename, [ Filesystem::signal_param_oldpath => $this->getHookPath($source), Filesystem::signal_param_newpath => $this->getHookPath($target), Filesystem::signal_param_run => &$run ] ); } if ($run) { $this->verifyPath(dirname($target), basename($target)); $manager = Filesystem::getMountManager(); $mount1 = $this->getMount($source); $mount2 = $this->getMount($target); $storage1 = $mount1->getStorage(); $storage2 = $mount2->getStorage(); $internalPath1 = $mount1->getInternalPath($absolutePath1); $internalPath2 = $mount2->getInternalPath($absolutePath2); $this->changeLock($source, ILockingProvider::LOCK_EXCLUSIVE, true); try { $this->changeLock($target, ILockingProvider::LOCK_EXCLUSIVE, true); if ($internalPath1 === '') { if ($mount1 instanceof MoveableMount) { $sourceParentMount = $this->getMount(dirname($source)); if ($sourceParentMount === $mount2 && $this->targetIsNotShared($storage2, $internalPath2)) { /** * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1 */ $sourceMountPoint = $mount1->getMountPoint(); $result = $mount1->moveMount($absolutePath2); $manager->moveMount($sourceMountPoint, $mount1->getMountPoint()); } else { $result = false; } } else { $result = false; } // moving a file/folder within the same mount point } elseif ($storage1 === $storage2) { if ($storage1) { $result = $storage1->rename($internalPath1, $internalPath2); } else { $result = false; } // moving a file/folder between storages (from $storage1 to $storage2) } else { $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2); } if ((Cache\Scanner::isPartialFile($source) && !Cache\Scanner::isPartialFile($target)) && $result !== false) { // if it was a rename from a part file to a regular file it was a write and not a rename operation $this->writeUpdate($storage2, $internalPath2); } elseif ($result) { if ($internalPath1 !== '') { // don't do a cache update for moved mounts $this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2); } } } catch (\Exception $e) { throw $e; } finally { $this->changeLock($source, ILockingProvider::LOCK_SHARED, true); $this->changeLock($target, ILockingProvider::LOCK_SHARED, true); } if ((Cache\Scanner::isPartialFile($source) && !Cache\Scanner::isPartialFile($target)) && $result !== false) { if ($this->shouldEmitHooks()) { $this->emit_file_hooks_post($exists, $target); } } elseif ($result) { if ($this->shouldEmitHooks($source) && $this->shouldEmitHooks($target)) { \OC_Hook::emit( Filesystem::CLASSNAME, Filesystem::signal_post_rename, [ Filesystem::signal_param_oldpath => $this->getHookPath($source), Filesystem::signal_param_newpath => $this->getHookPath($target) ] ); } } } } catch (\Exception $e) { throw $e; } finally { $this->unlockFile($source, ILockingProvider::LOCK_SHARED, true); $this->unlockFile($target, ILockingProvider::LOCK_SHARED, true); } } return $result; } /** * Copy a file/folder from the source path to target path * * @param string $source source path * @param string $target target path * @param bool $preserveMtime whether to preserve mtime on the copy * * @return bool|mixed */ public function copy($source, $target, $preserveMtime = false) { $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($source)); $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($target)); $result = false; if ( Filesystem::isValidPath($target) && Filesystem::isValidPath($source) && !Filesystem::isFileBlacklisted($target) ) { $source = $this->getRelativePath($absolutePath1); $target = $this->getRelativePath($absolutePath2); if ($source == null || $target == null) { return false; } $run = true; $this->lockFile($target, ILockingProvider::LOCK_SHARED); $this->lockFile($source, ILockingProvider::LOCK_SHARED); $lockTypePath1 = ILockingProvider::LOCK_SHARED; $lockTypePath2 = ILockingProvider::LOCK_SHARED; try { $exists = $this->file_exists($target); if ($this->shouldEmitHooks()) { \OC_Hook::emit( Filesystem::CLASSNAME, Filesystem::signal_copy, [ Filesystem::signal_param_oldpath => $this->getHookPath($source), Filesystem::signal_param_newpath => $this->getHookPath($target), Filesystem::signal_param_run => &$run ] ); $this->emit_file_hooks_pre($exists, $target, $run); } if ($run) { $mount1 = $this->getMount($source); $mount2 = $this->getMount($target); $storage1 = $mount1->getStorage(); $internalPath1 = $mount1->getInternalPath($absolutePath1); $storage2 = $mount2->getStorage(); $internalPath2 = $mount2->getInternalPath($absolutePath2); $this->changeLock($target, ILockingProvider::LOCK_EXCLUSIVE); $lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE; if ($mount1->getMountPoint() == $mount2->getMountPoint()) { if ($storage1) { $result = $storage1->copy($internalPath1, $internalPath2); } else { $result = false; } } else { $result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2); } $this->writeUpdate($storage2, $internalPath2); $this->changeLock($target, ILockingProvider::LOCK_SHARED); $lockTypePath2 = ILockingProvider::LOCK_SHARED; if ($this->shouldEmitHooks() && $result !== false) { \OC_Hook::emit( Filesystem::CLASSNAME, Filesystem::signal_post_copy, [ Filesystem::signal_param_oldpath => $this->getHookPath($source), Filesystem::signal_param_newpath => $this->getHookPath($target) ] ); $this->emit_file_hooks_post($exists, $target); } } } catch (\Exception $e) { $this->unlockFile($target, $lockTypePath2); $this->unlockFile($source, $lockTypePath1); throw $e; } $this->unlockFile($target, $lockTypePath2); $this->unlockFile($source, $lockTypePath1); } return $result; } /** * @param string $path * @param string $mode 'r' or 'w' * @return resource|false * @throws LockedException */ public function fopen($path, $mode) { $mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support $hooks = []; switch ($mode) { case 'r': $hooks[] = 'read'; break; case 'r+': case 'w+': case 'x+': case 'a+': $hooks[] = 'read'; $hooks[] = 'write'; break; case 'w': case 'x': case 'a': $hooks[] = 'write'; break; default: $this->logger->error('invalid mode (' . $mode . ') for ' . $path, ['app' => 'core']); } if ($mode !== 'r' && $mode !== 'w') { $this->logger->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends', ['app' => 'core']); } $handle = $this->basicOperation('fopen', $path, $hooks, $mode); if (!is_resource($handle) && $mode === 'r') { // trying to read a file that isn't on disk, check if the cache is out of sync and rescan if needed $mount = $this->getMount($path); $internalPath = $mount->getInternalPath($this->getAbsolutePath($path)); $storage = $mount->getStorage(); if ($storage->getCache()->inCache($internalPath) && !$storage->file_exists($path)) { $this->writeUpdate($storage, $internalPath); } } return $handle; } /** * @param string $path * @throws InvalidPathException */ public function toTmpFile($path): string|false { $this->assertPathLength($path); if (Filesystem::isValidPath($path)) { $source = $this->fopen($path, 'r'); if ($source) { $extension = pathinfo($path, PATHINFO_EXTENSION); $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension); file_put_contents($tmpFile, $source); return $tmpFile; } else { return false; } } else { return false; } } /** * @param string $tmpFile * @param string $path * @return bool|mixed * @throws InvalidPathException */ public function fromTmpFile($tmpFile, $path) { $this->assertPathLength($path); if (Filesystem::isValidPath($path)) { // Get directory that the file is going into $filePath = dirname($path); // Create the directories if any if (!$this->file_exists($filePath)) { $result = $this->createParentDirectories($filePath); if ($result === false) { return false; } } $source = fopen($tmpFile, 'r'); if ($source) { $result = $this->file_put_contents($path, $source); /** * $this->file_put_contents() might have already closed * the resource, so we check it, before trying to close it * to avoid messages in the error log. * @psalm-suppress RedundantCondition false-positive */ if (is_resource($source)) { fclose($source); } unlink($tmpFile); return $result; } else { return false; } } else { return false; } } /** * @param string $path * @return mixed * @throws InvalidPathException */ public function getMimeType($path) { $this->assertPathLength($path); return $this->basicOperation('getMimeType', $path); } /** * @param string $type * @param string $path * @param bool $raw */ public function hash($type, $path, $raw = false): string|bool { $postFix = (substr($path, -1) === '/') ? '/' : ''; $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path)); if (Filesystem::isValidPath($path)) { $path = $this->getRelativePath($absolutePath); if ($path == null) { return false; } if ($this->shouldEmitHooks($path)) { \OC_Hook::emit( Filesystem::CLASSNAME, Filesystem::signal_read, [Filesystem::signal_param_path => $this->getHookPath($path)] ); } /** @var Storage|null $storage */ [$storage, $internalPath] = Filesystem::resolvePath($absolutePath . $postFix); if ($storage) { return $storage->hash($type, $internalPath, $raw); } } return false; } /** * @param string $path * @return mixed * @throws InvalidPathException */ public function free_space($path = '/') { $this->assertPathLength($path); $result = $this->basicOperation('free_space', $path); if ($result === null) { throw new InvalidPathException(); } return $result; } /** * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage * * @param mixed $extraParam (optional) * @return mixed * @throws LockedException * * This method takes requests for basic filesystem functions (e.g. reading & writing * files), processes hooks and proxies, sanitises paths, and finally passes them on to * \OC\Files\Storage\Storage for delegation to a storage backend for execution */ private function basicOperation(string $operation, string $path, array $hooks = [], $extraParam = null) { $postFix = (substr($path, -1) === '/') ? '/' : ''; $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path)); if (Filesystem::isValidPath($path) && !Filesystem::isFileBlacklisted($path) ) { $path = $this->getRelativePath($absolutePath); if ($path == null) { return false; } if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) { // always a shared lock during pre-hooks so the hook can read the file $this->lockFile($path, ILockingProvider::LOCK_SHARED); } $run = $this->runHooks($hooks, $path); [$storage, $internalPath] = Filesystem::resolvePath($absolutePath . $postFix); if ($run && $storage) { /** @var Storage $storage */ if (in_array('write', $hooks) || in_array('delete', $hooks)) { try { $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE); } catch (LockedException $e) { // release the shared lock we acquired before quitting $this->unlockFile($path, ILockingProvider::LOCK_SHARED); throw $e; } } try { if (!is_null($extraParam)) { $result = $storage->$operation($internalPath, $extraParam); } else { $result = $storage->$operation($internalPath); } } catch (\Exception $e) { if (in_array('write', $hooks) || in_array('delete', $hooks)) { $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE); } elseif (in_array('read', $hooks)) { $this->unlockFile($path, ILockingProvider::LOCK_SHARED); } throw $e; } if ($result !== false && in_array('delete', $hooks)) { $this->removeUpdate($storage, $internalPath); } if ($result !== false && in_array('write', $hooks, true) && $operation !== 'fopen' && $operation !== 'touch') { $this->writeUpdate($storage, $internalPath); } if ($result !== false && in_array('touch', $hooks)) { $this->writeUpdate($storage, $internalPath, $extraParam); } if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) { $this->changeLock($path, ILockingProvider::LOCK_SHARED); } $unlockLater = false; if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) { $unlockLater = true; // make sure our unlocking callback will still be called if connection is aborted ignore_user_abort(true); $result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) { if (in_array('write', $hooks)) { $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE); } elseif (in_array('read', $hooks)) { $this->unlockFile($path, ILockingProvider::LOCK_SHARED); } }); } if ($this->shouldEmitHooks($path) && $result !== false) { if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open $this->runHooks($hooks, $path, true); } } if (!$unlockLater && (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) ) { $this->unlockFile($path, ILockingProvider::LOCK_SHARED); } return $result; } else { $this->unlockFile($path, ILockingProvider::LOCK_SHARED); } } return null; } /** * get the path relative to the default root for hook usage * * @param string $path * @return ?string */ private function getHookPath($path): ?string { $view = Filesystem::getView(); if (!$view) { return $path; } return $view->getRelativePath($this->getAbsolutePath($path)); } private function shouldEmitHooks(string $path = ''): bool { if ($path && Cache\Scanner::isPartialFile($path)) { return false; } if (!Filesystem::$loaded) { return false; } $defaultRoot = Filesystem::getRoot(); if ($defaultRoot === null) { return false; } if ($this->fakeRoot === $defaultRoot) { return true; } $fullPath = $this->getAbsolutePath($path); if ($fullPath === $defaultRoot) { return true; } return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/'); } /** * @param string[] $hooks * @param string $path * @param bool $post * @return bool */ private function runHooks($hooks, $path, $post = false) { $relativePath = $path; $path = $this->getHookPath($path); $prefix = $post ? 'post_' : ''; $run = true; if ($this->shouldEmitHooks($relativePath)) { foreach ($hooks as $hook) { if ($hook != 'read') { \OC_Hook::emit( Filesystem::CLASSNAME, $prefix . $hook, [ Filesystem::signal_param_run => &$run, Filesystem::signal_param_path => $path ] ); } elseif (!$post) { \OC_Hook::emit( Filesystem::CLASSNAME, $prefix . $hook, [ Filesystem::signal_param_path => $path ] ); } } } return $run; } /** * check if a file or folder has been updated since $time * * @param string $path * @param int $time * @return bool */ public function hasUpdated($path, $time) { return $this->basicOperation('hasUpdated', $path, [], $time); } /** * @param string $ownerId * @return IUser */ private function getUserObjectForOwner(string $ownerId) { return new LazyUser($ownerId, $this->userManager); } /** * Get file info from cache * * If the file is not in cached it will be scanned * If the file has changed on storage the cache will be updated * * @param Storage $storage * @param string $internalPath * @param string $relativePath * @return ICacheEntry|bool */ private function getCacheEntry($storage, $internalPath, $relativePath) { $cache = $storage->getCache($internalPath); $data = $cache->get($internalPath); $watcher = $storage->getWatcher($internalPath); try { // if the file is not in the cache or needs to be updated, trigger the scanner and reload the data if (!$data || (isset($data['size']) && $data['size'] === -1)) { if (!$storage->file_exists($internalPath)) { return false; } // don't need to get a lock here since the scanner does it's own locking $scanner = $storage->getScanner($internalPath); $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW); $data = $cache->get($internalPath); } elseif (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) { $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED); $watcher->update($internalPath, $data); $storage->getPropagator()->propagateChange($internalPath, time()); $data = $cache->get($internalPath); $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED); } } catch (LockedException $e) { // if the file is locked we just use the old cache info } return $data; } /** * get the filesystem info * * @param string $path * @param bool|string $includeMountPoints true to add mountpoint sizes, * 'ext' to add only ext storage mount point sizes. Defaults to true. * @return \OC\Files\FileInfo|false False if file does not exist */ public function getFileInfo($path, $includeMountPoints = true) { $this->assertPathLength($path); if (!Filesystem::isValidPath($path)) { return false; } if (Cache\Scanner::isPartialFile($path)) { return $this->getPartFileInfo($path); } $relativePath = $path; $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path); $mount = Filesystem::getMountManager()->find($path); $storage = $mount->getStorage(); $internalPath = $mount->getInternalPath($path); if ($storage) { $data = $this->getCacheEntry($storage, $internalPath, $relativePath); if (!$data instanceof ICacheEntry) { return false; } if ($mount instanceof MoveableMount && $internalPath === '') { $data['permissions'] |= \OCP\Constants::PERMISSION_DELETE; } $ownerId = $storage->getOwner($internalPath); $owner = null; if ($ownerId !== null && $ownerId !== false) { // ownerId might be null if files are accessed with an access token without file system access $owner = $this->getUserObjectForOwner($ownerId); } $info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner); if (isset($data['fileid'])) { if ($includeMountPoints && $data['mimetype'] === 'httpd/unix-directory') { //add the sizes of other mount points to the folder $extOnly = ($includeMountPoints === 'ext'); $this->addSubMounts($info, $extOnly); } } return $info; } else { $this->logger->warning('Storage not valid for mountpoint: ' . $mount->getMountPoint(), ['app' => 'core']); } return false; } /** * Extend a FileInfo that was previously requested with `$includeMountPoints = false` to include the sub mounts */ public function addSubMounts(FileInfo $info, $extOnly = false): void { $mounts = Filesystem::getMountManager()->findIn($info->getPath()); $info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) { $subStorage = $mount->getStorage(); return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage); })); } /** * 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 FileInfo[] */ public function getDirectoryContent($directory, $mimetype_filter = '', \OCP\Files\FileInfo $directoryInfo = null) { $this->assertPathLength($directory); if (!Filesystem::isValidPath($directory)) { return []; } $path = $this->getAbsolutePath($directory); $path = Filesystem::normalizePath($path); $mount = $this->getMount($directory); $storage = $mount->getStorage(); $internalPath = $mount->getInternalPath($path); if (!$storage) { return []; } $cache = $storage->getCache($internalPath); $user = \OC_User::getUser(); if (!$directoryInfo) { $data = $this->getCacheEntry($storage, $internalPath, $directory); if (!$data instanceof ICacheEntry || !isset($data['fileid'])) { return []; } } else { $data = $directoryInfo; } if (!($data->getPermissions() & Constants::PERMISSION_READ)) { return []; } $folderId = $data->getId(); $contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter $sharingDisabled = \OCP\Util::isSharingDisabledForUser(); $fileNames = array_map(function (ICacheEntry $content) { return $content->getName(); }, $contents); /** * @var \OC\Files\FileInfo[] $fileInfos */ $fileInfos = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) { if ($sharingDisabled) { $content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE; } $owner = $this->getUserObjectForOwner($storage->getOwner($content['path'])); return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner); }, $contents); $files = array_combine($fileNames, $fileInfos); //add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders $mounts = Filesystem::getMountManager()->findIn($path); $dirLength = strlen($path); foreach ($mounts as $mount) { $mountPoint = $mount->getMountPoint(); $subStorage = $mount->getStorage(); if ($subStorage) { $subCache = $subStorage->getCache(''); $rootEntry = $subCache->get(''); if (!$rootEntry) { $subScanner = $subStorage->getScanner(); try { $subScanner->scanFile(''); } catch (\OCP\Files\StorageNotAvailableException $e) { continue; } catch (\OCP\Files\StorageInvalidException $e) { continue; } catch (\Exception $e) { // sometimes when the storage is not available it can be any exception $this->logger->error('Exception while scanning storage "' . $subStorage->getId() . '"', [ 'exception' => $e, 'app' => 'core', ]); continue; } $rootEntry = $subCache->get(''); } if ($rootEntry && ($rootEntry->getPermissions() & Constants::PERMISSION_READ)) { $relativePath = trim(substr($mountPoint, $dirLength), '/'); if ($pos = strpos($relativePath, '/')) { //mountpoint inside subfolder add size to the correct folder $entryName = substr($relativePath, 0, $pos); if (isset($files[$entryName])) { $files[$entryName]->addSubEntry($rootEntry, $mountPoint); } } else { //mountpoint in this folder, add an entry for it $rootEntry['name'] = $relativePath; $rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file'; $permissions = $rootEntry['permissions']; // do not allow renaming/deleting the mount point if they are not shared files/folders // for shared files/folders we use the permissions given by the owner if ($mount instanceof MoveableMount) { $rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE; } else { $rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE)); } $rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/ // if sharing was disabled for the user we remove the share permissions if (\OCP\Util::isSharingDisabledForUser()) { $rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE; } $owner = $this->getUserObjectForOwner($subStorage->getOwner('')); $files[$rootEntry->getName()] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner); } } } } if ($mimetype_filter) { $files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) { if (strpos($mimetype_filter, '/')) { return $file->getMimetype() === $mimetype_filter; } else { return $file->getMimePart() === $mimetype_filter; } }); } return array_values($files); } /** * change file metadata * * @param string $path * @param array|\OCP\Files\FileInfo $data * @return int * * returns the fileid of the updated file */ public function putFileInfo($path, $data) { $this->assertPathLength($path); if ($data instanceof FileInfo) { $data = $data->getData(); } $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path); /** * @var Storage $storage * @var string $internalPath */ [$storage, $internalPath] = Filesystem::resolvePath($path); if ($storage) { $cache = $storage->getCache($path); if (!$cache->inCache($internalPath)) { $scanner = $storage->getScanner($internalPath); $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW); } return $cache->put($internalPath, $data); } else { return -1; } } /** * search for files with the name matching $query * * @param string $query * @return FileInfo[] */ public function search($query) { return $this->searchCommon('search', ['%' . $query . '%']); } /** * search for files with the name matching $query * * @param string $query * @return FileInfo[] */ public function searchRaw($query) { return $this->searchCommon('search', [$query]); } /** * search for files by mimetype * * @param string $mimetype * @return FileInfo[] */ public function searchByMime($mimetype) { return $this->searchCommon('searchByMime', [$mimetype]); } /** * search for files by tag * * @param string|int $tag name or tag id * @param string $userId owner of the tags * @return FileInfo[] */ public function searchByTag($tag, $userId) { return $this->searchCommon('searchByTag', [$tag, $userId]); } /** * @param string $method cache method * @param array $args * @return FileInfo[] */ private function searchCommon($method, $args) { $files = []; $rootLength = strlen($this->fakeRoot); $mount = $this->getMount(''); $mountPoint = $mount->getMountPoint(); $storage = $mount->getStorage(); $userManager = \OC::$server->getUserManager(); if ($storage) { $cache = $storage->getCache(''); $results = call_user_func_array([$cache, $method], $args); foreach ($results as $result) { if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') { $internalPath = $result['path']; $path = $mountPoint . $result['path']; $result['path'] = substr($mountPoint . $result['path'], $rootLength); $owner = $userManager->get($storage->getOwner($internalPath)); $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner); } } $mounts = Filesystem::getMountManager()->findIn($this->fakeRoot); foreach ($mounts as $mount) { $mountPoint = $mount->getMountPoint(); $storage = $mount->getStorage(); if ($storage) { $cache = $storage->getCache(''); $relativeMountPoint = substr($mountPoint, $rootLength); $results = call_user_func_array([$cache, $method], $args); if ($results) { foreach ($results as $result) { $internalPath = $result['path']; $result['path'] = rtrim($relativeMountPoint . $result['path'], '/'); $path = rtrim($mountPoint . $internalPath, '/'); $owner = $userManager->get($storage->getOwner($internalPath)); $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner); } } } } } return $files; } /** * Get the owner for a file or folder * * @param string $path * @return string the user id of the owner * @throws NotFoundException */ public function getOwner($path) { $info = $this->getFileInfo($path); if (!$info) { throw new NotFoundException($path . ' not found while trying to get owner'); } if ($info->getOwner() === null) { throw new NotFoundException($path . ' has no owner'); } return $info->getOwner()->getUID(); } /** * get the ETag for a file or folder * * @param string $path * @return string|false */ public function getETag($path) { [$storage, $internalPath] = $this->resolvePath($path); if ($storage) { return $storage->getETag($internalPath); } else { return false; } } /** * Get the path of a file by id, relative to the view * * 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 * @param int|null $storageId * @return string * @throws NotFoundException */ public function getPath($id, int $storageId = null) { $id = (int)$id; $manager = Filesystem::getMountManager(); $mounts = $manager->findIn($this->fakeRoot); $mounts[] = $manager->find($this->fakeRoot); $mounts = array_filter($mounts); // reverse the array, so we start with the storage this view is in // which is the most likely to contain the file we're looking for $mounts = array_reverse($mounts); // put non-shared mounts in front of the shared mount // this prevents unneeded recursion into shares usort($mounts, function (IMountPoint $a, IMountPoint $b) { return $a instanceof SharedMount && (!$b instanceof SharedMount) ? 1 : -1; }); if (!is_null($storageId)) { $mounts = array_filter($mounts, function (IMountPoint $mount) use ($storageId) { return $mount->getNumericStorageId() === $storageId; }); } foreach ($mounts as $mount) { /** * @var \OC\Files\Mount\MountPoint $mount */ if ($mount->getStorage()) { $cache = $mount->getStorage()->getCache(); $internalPath = $cache->getPathById($id); if (is_string($internalPath)) { $fullPath = $mount->getMountPoint() . $internalPath; if (!is_null($path = $this->getRelativePath($fullPath))) { return $path; } } } } throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id)); } /** * @param string $path * @throws InvalidPathException */ private function assertPathLength($path): void { $maxLen = min(PHP_MAXPATHLEN, 4000); // Check for the string length - performed using isset() instead of strlen() // because isset() is about 5x-40x faster. if (isset($path[$maxLen])) { $pathLen = strlen($path); throw new InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path"); } } /** * check if it is allowed to move a mount point to a given target. * It is not allowed to move a mount point into a different mount point or * into an already shared folder */ private function targetIsNotShared(IStorage $targetStorage, string $targetInternalPath): bool { // note: cannot use the view because the target is already locked $fileId = $targetStorage->getCache()->getId($targetInternalPath); if ($fileId === -1) { // target might not exist, need to check parent instead $fileId = $targetStorage->getCache()->getId(dirname($targetInternalPath)); } // check if any of the parents were shared by the current owner (include collections) $shares = Share::getItemShared( 'folder', (string)$fileId, \OC\Share\Constants::FORMAT_NONE, null, true ); if (count($shares) > 0) { $this->logger->debug( 'It is not allowed to move one mount point into a shared folder', ['app' => 'files']); return false; } return true; } /** * Get a fileinfo object for files that are ignored in the cache (part files) */ private function getPartFileInfo(string $path): \OC\Files\FileInfo { $mount = $this->getMount($path); $storage = $mount->getStorage(); $internalPath = $mount->getInternalPath($this->getAbsolutePath($path)); $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath)); return new FileInfo( $this->getAbsolutePath($path), $storage, $internalPath, [ 'fileid' => null, 'mimetype' => $storage->getMimeType($internalPath), 'name' => basename($path), 'etag' => null, 'size' => $storage->filesize($internalPath), 'mtime' => $storage->filemtime($internalPath), 'encrypted' => false, 'permissions' => \OCP\Constants::PERMISSION_ALL ], $mount, $owner ); } /** * @param string $path * @param string $fileName * @throws InvalidPathException */ public function verifyPath($path, $fileName): void { try { /** @type \OCP\Files\Storage $storage */ [$storage, $internalPath] = $this->resolvePath($path); $storage->verifyPath($internalPath, $fileName); } catch (ReservedWordException $ex) { $l = \OC::$server->getL10N('lib'); throw new InvalidPathException($l->t('File name is a reserved word')); } catch (InvalidCharacterInPathException $ex) { $l = \OC::$server->getL10N('lib'); throw new InvalidPathException($l->t('File name contains at least one invalid character')); } catch (FileNameTooLongException $ex) { $l = \OC::$server->getL10N('lib'); throw new InvalidPathException($l->t('File name is too long')); } catch (InvalidDirectoryException $ex) { $l = \OC::$server->getL10N('lib'); throw new InvalidPathException($l->t('Dot files are not allowed')); } catch (EmptyFileNameException $ex) { $l = \OC::$server->getL10N('lib'); throw new InvalidPathException($l->t('Empty filename is not allowed')); } } /** * get all parent folders of $path * * @param string $path * @return string[] */ private function getParents($path) { $path = trim($path, '/'); if (!$path) { return []; } $parts = explode('/', $path); // remove the single file array_pop($parts); $result = ['/']; $resultPath = ''; foreach ($parts as $part) { if ($part) { $resultPath .= '/' . $part; $result[] = $resultPath; } } return $result; } /** * Returns the mount point for which to lock * * @param string $absolutePath absolute path * @param bool $useParentMount true to return parent mount instead of whatever * is mounted directly on the given path, false otherwise * @return IMountPoint mount point for which to apply locks */ private function getMountForLock(string $absolutePath, bool $useParentMount = false): IMountPoint { $mount = Filesystem::getMountManager()->find($absolutePath); if ($useParentMount) { // find out if something is mounted directly on the path $internalPath = $mount->getInternalPath($absolutePath); if ($internalPath === '') { // resolve the parent mount instead $mount = Filesystem::getMountManager()->find(dirname($absolutePath)); } } return $mount; } /** * Lock the given path * * @param string $path the path of the file to lock, relative to the view * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage * * @return bool False if the path is excluded from locking, true otherwise * @throws LockedException if the path is already locked */ private function lockPath($path, $type, $lockMountPoint = false) { $absolutePath = $this->getAbsolutePath($path); $absolutePath = Filesystem::normalizePath($absolutePath); if (!$this->shouldLockFile($absolutePath)) { return false; } $mount = $this->getMountForLock($absolutePath, $lockMountPoint); try { $storage = $mount->getStorage(); if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) { $storage->acquireLock( $mount->getInternalPath($absolutePath), $type, $this->lockingProvider ); } } catch (LockedException $e) { // rethrow with the a human-readable path throw new LockedException( $this->getPathRelativeToFiles($absolutePath), $e, $e->getExistingLock() ); } return true; } /** * Change the lock type * * @param string $path the path of the file to lock, relative to the view * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage * * @return bool False if the path is excluded from locking, true otherwise * @throws LockedException if the path is already locked */ public function changeLock($path, $type, $lockMountPoint = false) { $path = Filesystem::normalizePath($path); $absolutePath = $this->getAbsolutePath($path); $absolutePath = Filesystem::normalizePath($absolutePath); if (!$this->shouldLockFile($absolutePath)) { return false; } $mount = $this->getMountForLock($absolutePath, $lockMountPoint); try { $storage = $mount->getStorage(); if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) { $storage->changeLock( $mount->getInternalPath($absolutePath), $type, $this->lockingProvider ); } } catch (LockedException $e) { try { // rethrow with the a human-readable path throw new LockedException( $this->getPathRelativeToFiles($absolutePath), $e, $e->getExistingLock() ); } catch (\InvalidArgumentException $ex) { throw new LockedException( $absolutePath, $ex, $e->getExistingLock() ); } } return true; } /** * Unlock the given path * * @param string $path the path of the file to unlock, relative to the view * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage * * @return bool False if the path is excluded from locking, true otherwise * @throws LockedException */ private function unlockPath($path, $type, $lockMountPoint = false) { $absolutePath = $this->getAbsolutePath($path); $absolutePath = Filesystem::normalizePath($absolutePath); if (!$this->shouldLockFile($absolutePath)) { return false; } $mount = $this->getMountForLock($absolutePath, $lockMountPoint); $storage = $mount->getStorage(); if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) { $storage->releaseLock( $mount->getInternalPath($absolutePath), $type, $this->lockingProvider ); } return true; } /** * Lock a path and all its parents up to the root of the view * * @param string $path the path of the file to lock relative to the view * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage * * @return bool False if the path is excluded from locking, true otherwise * @throws LockedException */ public function lockFile($path, $type, $lockMountPoint = false) { $absolutePath = $this->getAbsolutePath($path); $absolutePath = Filesystem::normalizePath($absolutePath); if (!$this->shouldLockFile($absolutePath)) { return false; } $this->lockPath($path, $type, $lockMountPoint); $parents = $this->getParents($path); foreach ($parents as $parent) { $this->lockPath($parent, ILockingProvider::LOCK_SHARED); } return true; } /** * Unlock a path and all its parents up to the root of the view * * @param string $path the path of the file to lock relative to the view * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage * * @return bool False if the path is excluded from locking, true otherwise * @throws LockedException */ public function unlockFile($path, $type, $lockMountPoint = false) { $absolutePath = $this->getAbsolutePath($path); $absolutePath = Filesystem::normalizePath($absolutePath); if (!$this->shouldLockFile($absolutePath)) { return false; } $this->unlockPath($path, $type, $lockMountPoint); $parents = $this->getParents($path); foreach ($parents as $parent) { $this->unlockPath($parent, ILockingProvider::LOCK_SHARED); } return true; } /** * Only lock files in data/user/files/ * * @param string $path Absolute path to the file/folder we try to (un)lock * @return bool */ protected function shouldLockFile($path) { $path = Filesystem::normalizePath($path); $pathSegments = explode('/', $path); if (isset($pathSegments[2])) { // E.g.: /username/files/path-to-file return ($pathSegments[2] === 'files') && (count($pathSegments) > 3); } return strpos($path, '/appdata_') !== 0; } /** * Shortens the given absolute path to be relative to * "$user/files". * * @param string $absolutePath absolute path which is under "files" * * @return string path relative to "files" with trimmed slashes or null * if the path was NOT relative to files * * @throws \InvalidArgumentException if the given path was not under "files" * @since 8.1.0 */ public function getPathRelativeToFiles($absolutePath) { $path = Filesystem::normalizePath($absolutePath); $parts = explode('/', trim($path, '/'), 3); // "$user", "files", "path/to/dir" if (!isset($parts[1]) || $parts[1] !== 'files') { $this->logger->error( '$absolutePath must be relative to "files", value is "{absolutePath}"', [ 'absolutePath' => $absolutePath, ] ); throw new \InvalidArgumentException('$absolutePath must be relative to "files"'); } if (isset($parts[2])) { return $parts[2]; } return ''; } /** * @param string $filename * @return array * @throws \OC\User\NoUserException * @throws NotFoundException */ public function getUidAndFilename($filename) { $info = $this->getFileInfo($filename); if (!$info instanceof \OCP\Files\FileInfo) { throw new NotFoundException($this->getAbsolutePath($filename) . ' not found'); } $uid = $info->getOwner()->getUID(); if ($uid != \OC_User::getUser()) { Filesystem::initMountPoints($uid); $ownerView = new View('/' . $uid . '/files'); try { $filename = $ownerView->getPath($info['fileid']); } catch (NotFoundException $e) { throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid); } } return [$uid, $filename]; } /** * Creates parent non-existing folders * * @param string $filePath * @return bool */ private function createParentDirectories($filePath) { $directoryParts = explode('/', $filePath); $directoryParts = array_filter($directoryParts); foreach ($directoryParts as $key => $part) { $currentPathElements = array_slice($directoryParts, 0, $key); $currentPath = '/' . implode('/', $currentPathElements); if ($this->is_file($currentPath)) { return false; } if (!$this->file_exists($currentPath)) { $this->mkdir($currentPath); } } return true; } }