lib/private/Files/View.php
<?php
/**
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Björn Schießle <bjoern@schiessle.org>
* @author cmeh <cmeh@users.noreply.github.com>
* @author Florin Peter <github@florin-peter.de>
* @author Jesús Macias <jmacias@solidgear.es>
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Semih Serhat Karakaya <karakayasemi@itu.edu.tr>
* @author Klaas Freitag <freitag@owncloud.com>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Luke Policinski <lpolicinski@gmail.com>
* @author Martin Mattel <martin.mattel@diemattels.at>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Petr Svoboda <weits666@gmail.com>
* @author Piotr Filiciak <piotr@filiciak.pl>
* @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 Stefan Weil <sw@weilnetz.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
* @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/>
*
*/
namespace OC\Files;
use Icewind\Streams\CallbackWrapper;
use OC\Files\Mount\MoveableMount;
use OC\Files\Storage\Storage;
use OC\Files\Storage\Local;
use OC\User\RemoteUser;
use OCP\Constants;
use OCP\Events\EventEmitterTrait;
use OCP\Files\Cache\ICacheEntry;
use OCP\Files\Cache\IScanner;
use OCP\Files\FileNameTooLongException;
use OCP\Files\InvalidCharacterInPathException;
use OCP\Files\InvalidPathException;
use OCP\Files\NotFoundException;
use OCP\Files\ReservedWordException;
use OCP\IUser;
use OCP\Lock\ILockingProvider;
use OCP\Lock\LockedException;
use OCA\Files_Sharing\SharedMount;
use OCP\Util;
use Symfony\Component\EventDispatcher\GenericEvent;
/**
* 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 {
use EventEmitterTrait;
/** @var string */
private $fakeRoot = '';
/**
* @var \OCP\Lock\ILockingProvider
*/
private $lockingProvider;
/** @var bool */
private $lockingEnabled;
/** @var bool */
private $updaterEnabled = true;
/** @var \OC\User\Manager */
private $userManager;
/** @var \Symfony\Component\EventDispatcher\EventDispatcherInterface */
private $eventDispatcher;
/** @var \OCP\IConfig */
private $config;
private static $ignorePartFile = false;
/**
* @param string $root
* @throws \Exception If $root contains an invalid path
*/
public function __construct($root = '') {
if ($root === null) {
throw new \InvalidArgumentException('Root can\'t be null');
}
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->eventDispatcher = \OC::$server->getEventDispatcher();
$this->config = \OC::$server->getConfig();
}
public function getAbsolutePath($path = '/') {
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
* @return boolean|null
*/
public function chroot($fakeRoot) {
if (!$fakeRoot == '') {
if ($fakeRoot[0] !== '/') {
$fakeRoot = '/' . $fakeRoot;
}
}
$this->fakeRoot = $fakeRoot;
}
/**
* get the fake root
*
* @return string
*/
public function getRoot() {
return $this->fakeRoot;
}
/**
* get path relative to the root of the view
*
* @param string $path
* @return string
*/
public function getRelativePath($path) {
$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
* @return string
*/
public function getMountPoint($path) {
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
* @return \OCP\Files\Mount\IMountPoint
*/
public function getMount($path) {
return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
}
/**
* 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 function resolvePath($path) {
$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
* @return string
*/
public function getLocalFile($path) {
$parent = \substr($path, 0, \strrpos($path, '/'));
$path = $this->getAbsolutePath($path);
list($storage, $internalPath) = Filesystem::resolvePath($path);
if (Filesystem::isValidPath($parent) and $storage) {
return $storage->getLocalFile($internalPath);
} else {
return null;
}
}
/**
* @param string $path
* @return string
*/
public function getLocalFolder($path) {
$parent = \substr($path, 0, \strrpos($path, '/'));
$path = $this->getAbsolutePath($path);
list($storage, $internalPath) = Filesystem::resolvePath($path);
if (Filesystem::isValidPath($parent) and $storage) {
return $storage->getLocalFolder($internalPath);
} else {
return null;
}
}
/**
* 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->emittingCall(function () use (&$path) {
$result = $this->basicOperation('mkdir', $path, ['create', 'write']);
return $result;
}, ['before' => ['path' => $this->getAbsolutePath($path)], 'after' => ['path' => $this->getAbsolutePath($path)]], 'file', 'create');
}
/**
* remove mount point
*
* @param \OC\Files\Mount\MoveableMount $mount
* @param string $path relative to data/
* @return boolean
*/
protected function removeMount($mount, $path) {
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() {
$this->updaterEnabled = false;
}
public function enableCacheUpdate() {
$this->updaterEnabled = true;
}
protected function writeUpdate(Storage $storage, $internalPath, $time = null) {
if ($this->updaterEnabled) {
if ($time === null) {
$time = \time();
}
$storage->getUpdater()->update($internalPath, $time);
}
}
protected function removeUpdate(Storage $storage, $internalPath) {
if ($this->updaterEnabled) {
$storage->getUpdater()->remove($internalPath);
}
}
protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, $sourceInternalPath, $targetInternalPath) {
if ($this->updaterEnabled) {
$targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
}
}
/**
* @param string $path
* @return bool|mixed
*/
public function rmdir($path) {
return $this->emittingCall(function () use (&$path) {
if ($path !== '') {
if ($this->isShareFolderOrShareFolderParent($path)) {
Util::writeLog("core", "The folder $path could not be deleted as it is configured as share_folder in config.", Util::WARN);
return false;
}
}
$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;
}, ['before' => ['path' => $this->getAbsolutePath($path)], 'after' => ['path' => $this->getAbsolutePath($path)]], 'file', 'delete');
}
/**
* Checks whether given path is a share folder or one of share folder parents
*
* @param $path - path relative to the files folder
*
* @return bool
*/
protected function isShareFolderOrShareFolderParent($path) {
$shareFolder = \trim($this->config->getSystemValue('share_folder', '/'), '/');
if ($shareFolder === '') {
return false;
}
$user = \OC_User::getUser();
$shareFolderAbsolutePath = "/$user/files/$shareFolder";
$trimmedAbsolutePath = $this->getAbsolutePath(\trim($path, '/'));
return $shareFolderAbsolutePath === $trimmedAbsolutePath || \strpos($shareFolderAbsolutePath, "$trimmedAbsolutePath/") === 0;
}
/**
* @param string $path
* @return resource
*/
public function opendir($path) {
return $this->basicOperation('opendir', $path, ['read']);
}
/**
* @param $handle
* @return mixed
*/
public function readdir($handle) {
$fsLocal = new Local(['datadir' => '/']);
// ToDo: Local does not have readdir - what is happening here?
/* @phan-suppress-next-line PhanUndeclaredMethod */
return $fsLocal->readdir($handle);
}
/**
* @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($path) {
return $this->basicOperation('filesize', $path);
}
/**
* @param string $path
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
*/
public function readfile($path) {
$this->assertPathLength($path);
@\ob_end_clean();
$handle = $this->fopen($path, 'rb');
if ($handle) {
$chunkSize = 8192; // 8 kB chunks
$size = $this->filesize($path);
while (!\feof($handle)) {
echo \fread($handle, $chunkSize);
\flush();
$this->checkConnectionStatus();
}
return $size;
}
return false;
}
/**
* @param string $path
* @param int $from
* @param int $to
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
* @throws \OCP\Files\UnseekableException
*/
public function readfilePart($path, $from, $to) {
$this->assertPathLength($path);
@\ob_end_clean();
$handle = $this->fopen($path, 'rb');
if ($handle) {
if (\fseek($handle, $from) === 0) {
$chunkSize = 8192; // 8 kB chunks
$end = $to + 1;
while (!\feof($handle) && \ftell($handle) < $end) {
$len = $end - \ftell($handle);
if ($len > $chunkSize) {
$len = $chunkSize;
}
echo \fread($handle, $len);
\flush();
$this->checkConnectionStatus();
}
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
* @return bool
*/
public function touch($path, $mtime = null) {
if ($mtime !== null and !\is_numeric($mtime)) {
$mtime = \strtotime($mtime);
}
$hooks = ['touch'];
if (!$this->file_exists($path)) {
$hooks[] = 'create';
$hooks[] = 'write';
}
$result = $this->basicOperation('touch', $path, $hooks, $mtime);
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 ($mtime === null) {
$mtime = \time();
}
//if native touch fails, we emulate it by changing the mtime in the cache
$this->putFileInfo($path, ['mtime' => $mtime]);
}
return true;
}
/**
* @param string $path
* @return mixed
*/
public function file_get_contents($path) {
return $this->emittingCall(function () use (&$path) {
return $this->basicOperation('file_get_contents', $path, ['read']);
}, ['before' => ['path' => $this->getAbsolutePath($path)], 'after' => ['path' => $this->getAbsolutePath($path)]], 'file', 'read');
}
/**
* @param bool $exists
* @param string $path
* @param bool $run
*/
protected function emit_file_hooks_pre($exists, $path, &$run) {
$event = new GenericEvent(null);
if (!$exists) {
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, [
Filesystem::signal_param_path => $this->getHookPath($path),
Filesystem::signal_param_run => &$run,
]);
if ($run) {
$event->setArgument('run', $run);
$this->eventDispatcher->dispatch($event, 'file.beforeCreate');
if ($event->getArgument('run') === false) {
$run = $event->getArgument('run');
}
}
} else {
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, [
Filesystem::signal_param_path => $this->getHookPath($path),
Filesystem::signal_param_run => &$run,
]);
if ($run) {
$event->setArgument('run', $run);
$this->eventDispatcher->dispatch($event, 'file.beforeUpdate');
if ($event->getArgument('run') === false) {
$run = $event->getArgument('run');
}
}
}
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, [
Filesystem::signal_param_path => $this->getHookPath($path),
Filesystem::signal_param_run => &$run,
]);
if ($run) {
$event->setArgument('run', $run);
$this->eventDispatcher->dispatch($event, 'file.beforeWrite');
if ($event->getArgument('run') === false) {
$run = $event->getArgument('run');
}
}
}
/**
* @param bool $exists
* @param string $path
*/
protected function emit_file_hooks_post($exists, $path) {
// A post event so no before event args required
return $this->emittingCall(function () use (&$exists, &$path) {
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),
]);
}, ['before' => ['path' => $path], 'after' => ['path' => $this->getAbsolutePath($path)]], 'file', 'create');
}
/**
* @param string $path
* @param mixed $data
* @return bool|mixed
* @throws \Exception
*/
public function file_put_contents($path, $data) {
return $this->emittingCall(function () use (&$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)
and !Filesystem::isForbiddenFileOrDir($path)
) {
$path = $this->getRelativePath($absolutePath);
$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;
}
$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
/** @var \OC\Files\Storage\Storage $storage */
list($storage, $internalPath) = $this->resolvePath($path);
$target = $storage->fopen($internalPath, 'w');
if ($target) {
list(, $result) = \OC_Helper::streamCopy($data, $target);
\fclose($target);
\fclose($data);
if ($result) {
$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);
}
}, ['before' => ['path' => $this->getAbsolutePath($path)], 'after' => ['path' => $this->getAbsolutePath($path)]], 'file', 'update');
}
/**
* @param string $path
* @return bool|mixed
*/
public function unlink($path) {
return $this->emittingCall(function () use (&$path) {
if ($path === '' || $path === '/') {
// do not allow deleting the root
return false;
}
$postFix = (\substr($path, -1, 1) === '/') ? '/' : '';
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
$mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
if ($mount and $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;
}
}, ['before' => ['path' => $this->getAbsolutePath($path)], 'after' => ['path' => $this->getAbsolutePath($path)]], 'file', 'delete');
}
/**
* @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 $path1 source path
* @param string $path2 target path
*
* @return bool|mixed
*/
public function rename($path1, $path2) {
return $this->emittingCall(function () use (&$path1, &$path2) {
$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
$result = false;
if (
Filesystem::isValidPath($path2)
and Filesystem::isValidPath($path1)
and !Filesystem::isForbiddenFileOrDir($path2)
) {
$path1 = $this->getRelativePath($absolutePath1);
$path2 = $this->getRelativePath($absolutePath2);
$exists = $this->file_exists($path2);
if ($path1 == null or $path2 == null) {
return false;
}
$this->lockFile($path1, ILockingProvider::LOCK_SHARED, true);
try {
$this->lockFile($path2, ILockingProvider::LOCK_SHARED, true);
} catch (LockedException $e) {
$this->unlockFile($path1, ILockingProvider::LOCK_SHARED);
throw $e;
}
$run = true;
if ($this->shouldEmitHooks($path1) && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
// 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, $path2, $run);
} elseif ($this->shouldEmitHooks($path1)) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_rename,
[
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2),
Filesystem::signal_param_run => &$run
]
);
}
if ($run) {
$this->verifyPath(\dirname($path2), \basename($path2));
$manager = Filesystem::getMountManager();
$mount1 = $this->getMount($path1);
$mount2 = $this->getMount($path2);
$storage1 = $mount1->getStorage();
$storage2 = $mount2->getStorage();
$internalPath1 = $mount1->getInternalPath($absolutePath1);
$internalPath2 = $mount2->getInternalPath($absolutePath2);
$this->changeLock($path1, ILockingProvider::LOCK_EXCLUSIVE, true);
$this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE, true);
if ($internalPath1 === '' and $mount1 instanceof MoveableMount) {
if ($this->canMove($mount1, $absolutePath2)) {
/**
* @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
*/
'@phan-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;
}
// 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($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false && (self::$ignorePartFile === 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);
}
}
$this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
$this->changeLock($path2, ILockingProvider::LOCK_SHARED, true);
if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
if ($this->shouldEmitHooks()) {
$this->emit_file_hooks_post($exists, $path2);
}
} elseif ($result) {
if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_rename,
[
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2)
]
);
}
}
}
$this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
$this->unlockFile($path2, ILockingProvider::LOCK_SHARED, true);
}
return $result;
}, [
'before' => ['oldpath' => $this->getAbsolutePath($path1),
'newpath' => $this->getAbsolutePath($path2)],
'after' => ['oldpath' => $this->getAbsolutePath($path1),
'newpath' => $this->getAbsolutePath($path2)]
], 'file', 'rename');
}
/**
* Copy a file/folder from the source path to target path
*
* @param string $path1 source path
* @param string $path2 target path
* @param bool $preserveMtime whether to preserve mtime on the copy
*
* @return bool|mixed
*/
public function copy($path1, $path2, $preserveMtime = false) {
$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
return $this->emittingCall(function () use ($absolutePath1, $absolutePath2) {
$result = false;
if (
Filesystem::isValidPath($absolutePath2)
&& Filesystem::isValidPath($absolutePath1)
&& !Filesystem::isForbiddenFileOrDir($absolutePath2)
) {
$path1 = $this->getRelativePath($absolutePath1);
$path2 = $this->getRelativePath($absolutePath2);
if ($path1 === null || $path2 === null) {
return false;
}
$run = true;
$this->lockFile($path2, ILockingProvider::LOCK_SHARED);
$this->lockFile($path1, ILockingProvider::LOCK_SHARED);
$lockTypePath1 = ILockingProvider::LOCK_SHARED;
$lockTypePath2 = ILockingProvider::LOCK_SHARED;
try {
$exists = $this->file_exists($path2);
if ($this->shouldEmitHooks()) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_copy,
[
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2),
Filesystem::signal_param_run => &$run
]
);
$this->emit_file_hooks_pre($exists, $path2, $run);
}
if ($run) {
$mount1 = $this->getMount($path1);
$mount2 = $this->getMount($path2);
$storage1 = $mount1->getStorage();
$internalPath1 = $mount1->getInternalPath($absolutePath1);
$storage2 = $mount2->getStorage();
$internalPath2 = $mount2->getInternalPath($absolutePath2);
$this->changeLock($path2, 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);
}
if ($result) {
$this->writeUpdate($storage2, $internalPath2);
}
$this->changeLock($path2, ILockingProvider::LOCK_SHARED);
$lockTypePath2 = ILockingProvider::LOCK_SHARED;
if ($result !== false && $this->shouldEmitHooks()) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_copy,
[
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2)
]
);
$this->emit_file_hooks_post($exists, $path2);
}
}
} catch (\Exception $e) {
$this->unlockFile($path2, $lockTypePath2);
$this->unlockFile($path1, $lockTypePath1);
throw $e;
}
$this->unlockFile($path2, $lockTypePath2);
$this->unlockFile($path1, $lockTypePath1);
}
return $result;
}, [
'before' => [
'oldpath' => $absolutePath1,
'newpath' => $absolutePath2
],
'after' => [
'oldpath' => $absolutePath1,
'newpath' => $absolutePath2
]
], 'file', 'copy');
}
/**
* @param string $path
* @param string $mode
* @return resource
*/
public function fopen($path, $mode) {
$hooks = [];
switch ($mode) {
case 'r':
case 'rb':
$hooks[] = 'read';
break;
case 'r+':
case 'rb+':
case 'w+':
case 'wb+':
case 'x+':
case 'xb+':
case 'a+':
case 'ab+':
$hooks[] = 'read';
$hooks[] = 'write';
break;
case 'w':
case 'wb':
case 'x':
case 'xb':
case 'a':
case 'ab':
$hooks[] = 'write';
break;
default:
Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, Util::ERROR);
}
return $this->basicOperation('fopen', $path, $hooks, $mode);
}
/**
* @param string $path
* @return bool|string
* @throws \OCP\Files\InvalidPathException
*/
public function toTmpFile($path) {
$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 \OCP\Files\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.
if (\is_resource($source)) {
\fclose($source);
}
\unlink($tmpFile);
return $result;
} else {
return false;
}
} else {
return false;
}
}
/**
* @param string $path
* @return mixed
* @throws \OCP\Files\InvalidPathException
*/
public function getMimeType($path) {
$this->assertPathLength($path);
return $this->basicOperation('getMimeType', $path);
}
/**
* @param string $type
* @param string $path
* @param bool $raw
* @return bool|null|string
*/
public function hash($type, $path, $raw = false) {
$postFix = (\substr($path, -1, 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)]
);
}
list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
if ($storage) {
$result = $storage->hash($type, $internalPath, $raw);
return $result;
}
}
return null;
}
/**
* @param string $path
* @return mixed
* @throws \OCP\Files\InvalidPathException
*/
public function free_space($path = '/') {
$this->assertPathLength($path);
return $this->basicOperation('free_space', $path);
}
/**
* abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
*
* @param string $operation
* @param string $path
* @param array $hooks (optional)
* @param mixed $extraParam (optional)
* @return mixed
* @throws \Exception
*
* 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($operation, $path, $hooks = [], $extraParam = null) {
$postFix = (\substr($path, -1, 1) === '/') ? '/' : '';
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
if (Filesystem::isValidPath($path)
and !Filesystem::isForbiddenFileOrDir($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);
/** @var \OC\Files\Storage\Storage $storage */
list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
if ($run and $storage) {
if (\in_array('write', $hooks) || \in_array('delete', $hooks)) {
$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
}
try {
if ($extraParam !== null) {
$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) {
if (\in_array('delete', $hooks)) {
$this->removeUpdate($storage, $internalPath);
}
if (\in_array('write', $hooks) and $operation !== 'fopen') {
$this->writeUpdate($storage, $internalPath);
}
if (\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) {
if (!Filesystem::getView()) {
return $path;
}
return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
}
private function shouldEmitHooks($path = '') {
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) {
if (empty($hooks)) {
return true;
}
$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($ownerId) {
$owner = $this->userManager->get($ownerId);
if (!$owner instanceof IUser) {
return new RemoteUser($ownerId);
}
return $owner;
}
/**
* 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 \OC\Files\Storage\Storage $storage
* @param string $internalPath
* @param string $relativePath
* @return array|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'] === IScanner::SIZE_NEEDS_SCAN))) {
$this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
if (!$storage->file_exists($internalPath)) {
$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
return false;
}
$scanner = $storage->getScanner($internalPath);
$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
$data = $cache->get($internalPath);
$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
} 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);
} elseif ($data['size'] === IScanner::SIZE_SHALLOW_SCANNED) {
$cache->correctFolderSize($internalPath, $data);
}
} 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 boolean|string $includeMountPoints true to add mountpoint sizes,
* 'ext' to add only ext storage mount point sizes. Defaults to true.
* 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);
if ($mount === null) {
return false;
}
$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;
}
try {
$itemPath = $this->getPath($data['fileid'], false);
$hasShareFolderInPath = $this->isShareFolderOrShareFolderParent($itemPath);
} catch (NotFoundException $e) {
$hasShareFolderInPath = false;
}
if ($hasShareFolderInPath) {
$data['permissions'] = $data['permissions'] & ~\OCP\Constants::PERMISSION_DELETE;
$data['permissions'] = $data['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
}
$owner = $this->getUserObjectForOwner($storage->getOwner($internalPath));
$info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
if ($data and isset($data['fileid'])) {
if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
//add the sizes of other mount points to the folder
$extOnly = ($includeMountPoints === 'ext');
$mounts = Filesystem::getMountManager()->findIn($path);
foreach ($mounts as $mount) {
$subStorage = $mount->getStorage();
if ($subStorage) {
// exclude shared storage ?
if ($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage) {
continue;
}
$subCache = $subStorage->getCache('');
$rootEntry = $subCache->get('');
$info->addSubEntry($rootEntry, $mount->getMountPoint());
}
}
}
}
return $info;
}
return false;
}
/**
* 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 = '') {
$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) {
$cache = $storage->getCache($internalPath);
$user = \OC_User::getUser();
$data = $this->getCacheEntry($storage, $internalPath, $directory);
if (!$data instanceof ICacheEntry || !isset($data['fileid']) || !($data->getPermissions() & Constants::PERMISSION_READ)) {
return [];
}
$folderId = $data['fileid'];
$contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
$sharingDisabled = Util::isSharingDisabledForUser();
/**
* @var \OC\Files\FileInfo[] $files
*/
$files = \array_filter($contents, function (ICacheEntry $content) {
return (!\OC\Files\Filesystem::isForbiddenFileOrDir($content['path']));
});
$files = \array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
try {
$itemPath = $this->getPath($content['fileid'], false);
$hasShareFolderInPath = $this->isShareFolderOrShareFolderParent($itemPath);
} catch (NotFoundException $e) {
$hasShareFolderInPath = false;
}
if ($sharingDisabled || $hasShareFolderInPath) {
$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
}
if ($hasShareFolderInPath) {
$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_DELETE;
}
$owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
}, $files);
//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
Util::writeLog(
'core',
'Exception while scanning storage "' . $subStorage->getId() . '": ' .
\get_class($e) . ': ' . $e->getMessage(),
Util::ERROR
);
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);
foreach ($files as &$entry) {
if ($entry->getName() === $entryName) {
$entry->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));
}
//remove any existing entry with the same name
foreach ($files as $i => $file) {
if ($file['name'] === $rootEntry['name']) {
unset($files[$i]);
break;
}
}
$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 (Util::isSharingDisabledForUser()) {
$rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
}
$owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
$files[] = 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 $files;
} else {
return [];
}
}
/**
* 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 \OC\Files\Storage\Storage $storage
* @var string $internalPath
*/
list($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();
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 = \OC::$server->getUserManager()->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 = \OC::$server->getUserManager()->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');
}
return $info->getOwner()->getUID();
}
/**
* get the ETag for a file or folder
*
* @param string $path
* @return string
*/
public function getETag($path) {
/**
* @var Storage\Storage $storage
* @var string $internalPath
*/
list($storage, $internalPath) = $this->resolvePath($path);
if ($storage) {
return $storage->getETag($internalPath);
} else {
return null;
}
}
/**
* Get the path of a file by id, relative to the view
*
* Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
*
* @param int $id
* @param bool $includeShares whether to recurse into shared mounts
* @throws NotFoundException
* @return string
*/
public function getPath($id, $includeShares = true) {
$id = (int)$id;
$manager = Filesystem::getMountManager();
$mounts = $manager->findIn($this->fakeRoot);
$findResult = $manager->find($this->fakeRoot);
if ($findResult) {
$mounts[] = $findResult;
}
// 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);
foreach ($mounts as $mount) {
/**
* @var \OC\Files\Mount\MountPoint $mount
*/
if (!$includeShares && $mount instanceof SharedMount) {
// prevent potential infinite loop when instantiating shared storages
// recursively
continue;
}
if ($mount->getStorage()) {
$cache = $mount->getStorage()->getCache();
$internalPath = $cache->getPathById($id);
if (\is_string($internalPath)) {
$fullPath = $mount->getMountPoint() . $internalPath;
if (($path = $this->getRelativePath($fullPath)) !== null) {
return $path;
}
}
}
}
throw new NotFoundException(\sprintf('File with id "%s" has not been found.', $id));
}
/**
* @param string $path
* @throws InvalidPathException
*/
private function assertPathLength($path) {
$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 \OCP\Files\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
*
* @param MoveableMount $mount1 moveable mount
* @param string $target absolute target path
* @return boolean
*/
private function canMove(MoveableMount $mount1, $target) {
list($targetStorage, $targetInternalPath) = \OC\Files\Filesystem::resolvePath($target);
if (!$targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
Util::writeLog(
'files',
'It is not allowed to move one mount point into another one',
Util::DEBUG
);
return false;
}
return $mount1->isTargetAllowed($target);
}
/**
* Get a fileinfo object for files that are ignored in the cache (part files)
*
* @param string $path
* @return \OCP\Files\FileInfo
*/
private function getPartFileInfo($path) {
$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) {
$l10n = \OC::$server->getL10N('lib');
// verify empty and dot files
$trimmed = \trim($fileName);
if ($trimmed === '') {
throw new InvalidPathException($l10n->t('Empty filename is not allowed'));
}
if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) {
throw new InvalidPathException($l10n->t('Dot files are not allowed'));
}
$matches = [];
if (\preg_match('/' . FileInfo::BLACKLIST_FILES_REGEX . '/', $fileName, $matches) !== 0) {
throw new InvalidPathException(
"Can`t upload files with extension {$matches[0]} because these extensions are reserved for internal use."
);
}
if (!\OC::$server->getDatabaseConnection()->allows4ByteCharacters()) {
// verify database - e.g. mysql only 3-byte chars
if (\preg_match('%(?:
\xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
| [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
| \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
)%xs', $fileName)) {
throw new InvalidPathException($l10n->t('4-byte characters are not supported in file names'));
}
}
try {
/** @type \OCP\Files\Storage $storage */
list($storage, $internalPath) = $this->resolvePath($path);
$storage->verifyPath($internalPath, $fileName);
} catch (ReservedWordException $ex) {
throw new InvalidPathException($l10n->t('File name is a reserved word'));
} catch (InvalidCharacterInPathException $ex) {
throw new InvalidPathException($l10n->t('File name contains at least one invalid character'));
} catch (FileNameTooLongException $ex) {
throw new InvalidPathException($l10n->t('File name is too long'));
}
}
/**
* 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 \OC\Files\Mount\MountPoint mount point for which to apply locks
*/
private function getMountForLock($absolutePath, $useParentMount = false) {
$results = [];
$mount = Filesystem::getMountManager()->find($absolutePath);
if (!$mount) {
return $results;
}
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 \OCP\Lock\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);
if ($mount) {
try {
$storage = $mount->getStorage();
if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->acquireLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}
} catch (\OCP\Lock\LockedException $e) {
// rethrow with the a human-readable path
throw new \OCP\Lock\LockedException(
$this->getPathRelativeToFiles($absolutePath),
$e
);
}
}
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 \OCP\Lock\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);
if ($mount) {
try {
$storage = $mount->getStorage();
if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->changeLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}
} catch (LockedException $e) {
// rethrow with the a human-readable path
throw new LockedException(
$this->getPathRelativeToFiles($absolutePath),
$e
);
}
}
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
*/
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);
if ($mount) {
$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
*/
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
*/
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 true;
}
/**
* 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') {
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 != \OCP\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 any nonexistent parent folders
*
* @param string $filePath
* @return bool
*/
private function createParentDirectories($filePath) {
$parentDirectory = \dirname($filePath);
while (!$this->file_exists($parentDirectory)) {
$result = $this->createParentDirectories($parentDirectory);
if ($result === false) {
return false;
}
}
$this->mkdir($filePath);
return true;
}
/**
* User can create part files example to a call for rename(), in effect
* it might not be a part file. So for better control in such cases this
* method would help to let the method in rename() to know if it is a
* part file.
*
* @param bool $isIgnored
*/
public static function setIgnorePartFile($isIgnored) {
self::$ignorePartFile = $isIgnored;
}
private function checkConnectionStatus(): void {
$connectionStatus = \connection_status();
if ($connectionStatus !== 0) {
throw new \RuntimeException("Connection lost. Status: $connectionStatus");
}
}
}