mirror of
https://github.com/nextcloud/server.git
synced 2025-02-06 01:20:16 +00:00
472 lines
15 KiB
PHP
472 lines
15 KiB
PHP
<?php
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
namespace OCA\DAV\Connector\Sabre;
|
|
|
|
use OC\Files\Mount\MoveableMount;
|
|
use OC\Files\View;
|
|
use OCA\DAV\AppInfo\Application;
|
|
use OCA\DAV\Connector\Sabre\Exception\FileLocked;
|
|
use OCA\DAV\Connector\Sabre\Exception\Forbidden;
|
|
use OCA\DAV\Connector\Sabre\Exception\InvalidPath;
|
|
use OCP\App\IAppManager;
|
|
use OCP\Files\FileInfo;
|
|
use OCP\Files\Folder;
|
|
use OCP\Files\ForbiddenException;
|
|
use OCP\Files\InvalidPathException;
|
|
use OCP\Files\NotFoundException;
|
|
use OCP\Files\NotPermittedException;
|
|
use OCP\Files\StorageNotAvailableException;
|
|
use OCP\IL10N;
|
|
use OCP\IRequest;
|
|
use OCP\L10N\IFactory;
|
|
use OCP\Lock\ILockingProvider;
|
|
use OCP\Lock\LockedException;
|
|
use OCP\Server;
|
|
use OCP\Share\IManager as IShareManager;
|
|
use Psr\Log\LoggerInterface;
|
|
use Sabre\DAV\Exception\BadRequest;
|
|
use Sabre\DAV\Exception\Locked;
|
|
use Sabre\DAV\Exception\NotFound;
|
|
use Sabre\DAV\Exception\ServiceUnavailable;
|
|
use Sabre\DAV\IFile;
|
|
use Sabre\DAV\INode;
|
|
|
|
class Directory extends Node implements \Sabre\DAV\ICollection, \Sabre\DAV\IQuota, \Sabre\DAV\IMoveTarget, \Sabre\DAV\ICopyTarget {
|
|
/**
|
|
* Cached directory content
|
|
* @var FileInfo[]
|
|
*/
|
|
private ?array $dirContent = null;
|
|
|
|
/** Cached quota info */
|
|
private ?array $quotaInfo = null;
|
|
|
|
/**
|
|
* Sets up the node, expects a full path name
|
|
*/
|
|
public function __construct(
|
|
View $view,
|
|
FileInfo $info,
|
|
private ?CachingTree $tree = null,
|
|
?IShareManager $shareManager = null,
|
|
) {
|
|
parent::__construct($view, $info, $shareManager);
|
|
}
|
|
|
|
/**
|
|
* Creates a new file in the directory
|
|
*
|
|
* Data will either be supplied as a stream resource, or in certain cases
|
|
* as a string. Keep in mind that you may have to support either.
|
|
*
|
|
* After successful creation of the file, you may choose to return the ETag
|
|
* of the new file here.
|
|
*
|
|
* The returned ETag must be surrounded by double-quotes (The quotes should
|
|
* be part of the actual string).
|
|
*
|
|
* If you cannot accurately determine the ETag, you should not return it.
|
|
* If you don't store the file exactly as-is (you're transforming it
|
|
* somehow) you should also not return an ETag.
|
|
*
|
|
* This means that if a subsequent GET to this new file does not exactly
|
|
* return the same contents of what was submitted here, you are strongly
|
|
* recommended to omit the ETag.
|
|
*
|
|
* @param string $name Name of the file
|
|
* @param resource|string $data Initial payload
|
|
* @return null|string
|
|
* @throws Exception\EntityTooLarge
|
|
* @throws Exception\UnsupportedMediaType
|
|
* @throws FileLocked
|
|
* @throws InvalidPath
|
|
* @throws \Sabre\DAV\Exception
|
|
* @throws \Sabre\DAV\Exception\BadRequest
|
|
* @throws \Sabre\DAV\Exception\Forbidden
|
|
* @throws \Sabre\DAV\Exception\ServiceUnavailable
|
|
*/
|
|
public function createFile($name, $data = null) {
|
|
try {
|
|
if (!$this->fileView->isCreatable($this->path)) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
|
|
$this->fileView->verifyPath($this->path, $name);
|
|
|
|
$path = $this->fileView->getAbsolutePath($this->path) . '/' . $name;
|
|
// in case the file already exists/overwriting
|
|
$info = $this->fileView->getFileInfo($this->path . '/' . $name);
|
|
if (!$info) {
|
|
// use a dummy FileInfo which is acceptable here since it will be refreshed after the put is complete
|
|
$info = new \OC\Files\FileInfo($path, null, null, [
|
|
'type' => FileInfo::TYPE_FILE
|
|
], null);
|
|
}
|
|
$node = new File($this->fileView, $info);
|
|
|
|
// only allow 1 process to upload a file at once but still allow reading the file while writing the part file
|
|
$node->acquireLock(ILockingProvider::LOCK_SHARED);
|
|
$this->fileView->lockFile($path . '.upload.part', ILockingProvider::LOCK_EXCLUSIVE);
|
|
|
|
$result = $node->put($data);
|
|
|
|
$this->fileView->unlockFile($path . '.upload.part', ILockingProvider::LOCK_EXCLUSIVE);
|
|
$node->releaseLock(ILockingProvider::LOCK_SHARED);
|
|
return $result;
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage(), $e->getCode(), $e);
|
|
} catch (InvalidPathException $ex) {
|
|
throw new InvalidPath($ex->getMessage(), false, $ex);
|
|
} catch (ForbiddenException $ex) {
|
|
throw new Forbidden($ex->getMessage(), $ex->getRetry(), $ex);
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a new subdirectory
|
|
*
|
|
* @param string $name
|
|
* @throws FileLocked
|
|
* @throws InvalidPath
|
|
* @throws \Sabre\DAV\Exception\Forbidden
|
|
* @throws \Sabre\DAV\Exception\ServiceUnavailable
|
|
*/
|
|
public function createDirectory($name) {
|
|
try {
|
|
if (!$this->info->isCreatable()) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
|
|
$this->fileView->verifyPath($this->path, $name);
|
|
$newPath = $this->path . '/' . $name;
|
|
if (!$this->fileView->mkdir($newPath)) {
|
|
throw new \Sabre\DAV\Exception\Forbidden('Could not create directory ' . $newPath);
|
|
}
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage(), 0, $e);
|
|
} catch (InvalidPathException $ex) {
|
|
throw new InvalidPath($ex->getMessage(), false, $ex);
|
|
} catch (ForbiddenException $ex) {
|
|
throw new Forbidden($ex->getMessage(), $ex->getRetry(), $ex);
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a specific child node, referenced by its name
|
|
*
|
|
* @param string $name
|
|
* @param FileInfo $info
|
|
* @return \Sabre\DAV\INode
|
|
* @throws InvalidPath
|
|
* @throws \Sabre\DAV\Exception\NotFound
|
|
* @throws \Sabre\DAV\Exception\ServiceUnavailable
|
|
*/
|
|
public function getChild($name, $info = null, ?IRequest $request = null, ?IL10N $l10n = null) {
|
|
if (!$this->info->isReadable()) {
|
|
// avoid detecting files through this way
|
|
throw new NotFound();
|
|
}
|
|
|
|
$path = $this->path . '/' . $name;
|
|
if (is_null($info)) {
|
|
try {
|
|
$this->fileView->verifyPath($this->path, $name, true);
|
|
$info = $this->fileView->getFileInfo($path);
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage(), 0, $e);
|
|
} catch (InvalidPathException $ex) {
|
|
throw new InvalidPath($ex->getMessage(), false, $ex);
|
|
} catch (ForbiddenException $e) {
|
|
throw new \Sabre\DAV\Exception\Forbidden($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
if (!$info) {
|
|
throw new \Sabre\DAV\Exception\NotFound('File with name ' . $path . ' could not be located');
|
|
}
|
|
|
|
if ($info->getMimeType() === FileInfo::MIMETYPE_FOLDER) {
|
|
$node = new \OCA\DAV\Connector\Sabre\Directory($this->fileView, $info, $this->tree, $this->shareManager);
|
|
} else {
|
|
$node = new File($this->fileView, $info, $this->shareManager, $request, $l10n);
|
|
}
|
|
if ($this->tree) {
|
|
$this->tree->cacheNode($node);
|
|
}
|
|
return $node;
|
|
}
|
|
|
|
/**
|
|
* Returns an array with all the child nodes
|
|
*
|
|
* @return \Sabre\DAV\INode[]
|
|
* @throws \Sabre\DAV\Exception\Locked
|
|
* @throws Forbidden
|
|
*/
|
|
public function getChildren() {
|
|
if (!is_null($this->dirContent)) {
|
|
return $this->dirContent;
|
|
}
|
|
try {
|
|
if (!$this->info->isReadable()) {
|
|
// return 403 instead of 404 because a 404 would make
|
|
// the caller believe that the collection itself does not exist
|
|
if (Server::get(IAppManager::class)->isInstalled('files_accesscontrol')) {
|
|
throw new Forbidden('No read permissions. This might be caused by files_accesscontrol, check your configured rules');
|
|
} else {
|
|
throw new Forbidden('No read permissions');
|
|
}
|
|
}
|
|
$folderContent = $this->getNode()->getDirectoryListing();
|
|
} catch (LockedException $e) {
|
|
throw new Locked();
|
|
}
|
|
|
|
$nodes = [];
|
|
$request = \OC::$server->get(IRequest::class);
|
|
$l10nFactory = \OC::$server->get(IFactory::class);
|
|
$l10n = $l10nFactory->get(Application::APP_ID);
|
|
foreach ($folderContent as $info) {
|
|
$node = $this->getChild($info->getName(), $info, $request, $l10n);
|
|
$nodes[] = $node;
|
|
}
|
|
$this->dirContent = $nodes;
|
|
return $this->dirContent;
|
|
}
|
|
|
|
/**
|
|
* Checks if a child exists.
|
|
*
|
|
* @param string $name
|
|
* @return bool
|
|
*/
|
|
public function childExists($name) {
|
|
// note: here we do NOT resolve the chunk file name to the real file name
|
|
// to make sure we return false when checking for file existence with a chunk
|
|
// file name.
|
|
// This is to make sure that "createFile" is still triggered
|
|
// (required old code) instead of "updateFile".
|
|
//
|
|
// TODO: resolve chunk file name here and implement "updateFile"
|
|
$path = $this->path . '/' . $name;
|
|
return $this->fileView->file_exists($path);
|
|
}
|
|
|
|
/**
|
|
* Deletes all files in this directory, and then itself
|
|
*
|
|
* @return void
|
|
* @throws FileLocked
|
|
* @throws \Sabre\DAV\Exception\Forbidden
|
|
*/
|
|
public function delete() {
|
|
if ($this->path === '' || $this->path === '/' || !$this->info->isDeletable()) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
|
|
try {
|
|
if (!$this->fileView->rmdir($this->path)) {
|
|
// assume it wasn't possible to remove due to permission issue
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
} catch (ForbiddenException $ex) {
|
|
throw new Forbidden($ex->getMessage(), $ex->getRetry());
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
private function getLogger(): LoggerInterface {
|
|
return \OC::$server->get(LoggerInterface::class);
|
|
}
|
|
|
|
/**
|
|
* Returns available diskspace information
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getQuotaInfo() {
|
|
if ($this->quotaInfo) {
|
|
return $this->quotaInfo;
|
|
}
|
|
$relativePath = $this->fileView->getRelativePath($this->info->getPath());
|
|
if ($relativePath === null) {
|
|
$this->getLogger()->warning('error while getting quota as the relative path cannot be found');
|
|
return [0, 0];
|
|
}
|
|
|
|
try {
|
|
$storageInfo = \OC_Helper::getStorageInfo($relativePath, $this->info, false);
|
|
if ($storageInfo['quota'] === FileInfo::SPACE_UNLIMITED) {
|
|
$free = FileInfo::SPACE_UNLIMITED;
|
|
} else {
|
|
$free = $storageInfo['free'];
|
|
}
|
|
$this->quotaInfo = [
|
|
$storageInfo['used'],
|
|
$free
|
|
];
|
|
return $this->quotaInfo;
|
|
} catch (NotFoundException $e) {
|
|
$this->getLogger()->warning('error while getting quota into', ['exception' => $e]);
|
|
return [0, 0];
|
|
} catch (StorageNotAvailableException $e) {
|
|
$this->getLogger()->warning('error while getting quota into', ['exception' => $e]);
|
|
return [0, 0];
|
|
} catch (NotPermittedException $e) {
|
|
$this->getLogger()->warning('error while getting quota into', ['exception' => $e]);
|
|
return [0, 0];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Moves a node into this collection.
|
|
*
|
|
* It is up to the implementors to:
|
|
* 1. Create the new resource.
|
|
* 2. Remove the old resource.
|
|
* 3. Transfer any properties or other data.
|
|
*
|
|
* Generally you should make very sure that your collection can easily move
|
|
* the move.
|
|
*
|
|
* If you don't, just return false, which will trigger sabre/dav to handle
|
|
* the move itself. If you return true from this function, the assumption
|
|
* is that the move was successful.
|
|
*
|
|
* @param string $targetName New local file/collection name.
|
|
* @param string $fullSourcePath Full path to source node
|
|
* @param INode $sourceNode Source node itself
|
|
* @return bool
|
|
* @throws BadRequest
|
|
* @throws ServiceUnavailable
|
|
* @throws Forbidden
|
|
* @throws FileLocked
|
|
* @throws \Sabre\DAV\Exception\Forbidden
|
|
*/
|
|
public function moveInto($targetName, $fullSourcePath, INode $sourceNode) {
|
|
if (!$sourceNode instanceof Node) {
|
|
// it's a file of another kind, like FutureFile
|
|
if ($sourceNode instanceof IFile) {
|
|
// fallback to default copy+delete handling
|
|
return false;
|
|
}
|
|
throw new BadRequest('Incompatible node types');
|
|
}
|
|
|
|
$destinationPath = $this->getPath() . '/' . $targetName;
|
|
|
|
|
|
$targetNodeExists = $this->childExists($targetName);
|
|
|
|
// at getNodeForPath we also check the path for isForbiddenFileOrDir
|
|
// with that we have covered both source and destination
|
|
if ($sourceNode instanceof Directory && $targetNodeExists) {
|
|
throw new \Sabre\DAV\Exception\Forbidden('Could not copy directory ' . $sourceNode->getName() . ', target exists');
|
|
}
|
|
|
|
[$sourceDir,] = \Sabre\Uri\split($sourceNode->getPath());
|
|
$destinationDir = $this->getPath();
|
|
|
|
$sourcePath = $sourceNode->getPath();
|
|
|
|
$isMovableMount = false;
|
|
$sourceMount = \OC::$server->getMountManager()->find($this->fileView->getAbsolutePath($sourcePath));
|
|
$internalPath = $sourceMount->getInternalPath($this->fileView->getAbsolutePath($sourcePath));
|
|
if ($sourceMount instanceof MoveableMount && $internalPath === '') {
|
|
$isMovableMount = true;
|
|
}
|
|
|
|
try {
|
|
$sameFolder = ($sourceDir === $destinationDir);
|
|
// if we're overwriting or same folder
|
|
if ($targetNodeExists || $sameFolder) {
|
|
// note that renaming a share mount point is always allowed
|
|
if (!$this->fileView->isUpdatable($destinationDir) && !$isMovableMount) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
} else {
|
|
if (!$this->fileView->isCreatable($destinationDir)) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
}
|
|
|
|
if (!$sameFolder) {
|
|
// moving to a different folder, source will be gone, like a deletion
|
|
// note that moving a share mount point is always allowed
|
|
if (!$this->fileView->isDeletable($sourcePath) && !$isMovableMount) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
}
|
|
|
|
$fileName = basename($destinationPath);
|
|
try {
|
|
$this->fileView->verifyPath($destinationDir, $fileName);
|
|
} catch (InvalidPathException $ex) {
|
|
throw new InvalidPath($ex->getMessage());
|
|
}
|
|
|
|
$renameOkay = $this->fileView->rename($sourcePath, $destinationPath);
|
|
if (!$renameOkay) {
|
|
throw new \Sabre\DAV\Exception\Forbidden('');
|
|
}
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new ServiceUnavailable($e->getMessage(), $e->getCode(), $e);
|
|
} catch (ForbiddenException $ex) {
|
|
throw new Forbidden($ex->getMessage(), $ex->getRetry(), $ex);
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
public function copyInto($targetName, $sourcePath, INode $sourceNode) {
|
|
if ($sourceNode instanceof File || $sourceNode instanceof Directory) {
|
|
try {
|
|
$destinationPath = $this->getPath() . '/' . $targetName;
|
|
$sourcePath = $sourceNode->getPath();
|
|
|
|
if (!$this->fileView->isCreatable($this->getPath())) {
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
|
}
|
|
|
|
try {
|
|
$this->fileView->verifyPath($this->getPath(), $targetName);
|
|
} catch (InvalidPathException $ex) {
|
|
throw new InvalidPath($ex->getMessage());
|
|
}
|
|
|
|
$copyOkay = $this->fileView->copy($sourcePath, $destinationPath);
|
|
|
|
if (!$copyOkay) {
|
|
throw new \Sabre\DAV\Exception\Forbidden('Copy did not proceed');
|
|
}
|
|
|
|
return true;
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new ServiceUnavailable($e->getMessage(), $e->getCode(), $e);
|
|
} catch (ForbiddenException $ex) {
|
|
throw new Forbidden($ex->getMessage(), $ex->getRetry(), $ex);
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public function getNode(): Folder {
|
|
return $this->node;
|
|
}
|
|
}
|