nextcloud / server

apps/dav/lib/Connector/Sabre/Node.php

Indentation +355 added lines, -355 removed lines

@@ -25,364 +25,364 @@
 use OCP\Share\IManager;
 
 abstract class Node implements \Sabre\DAV\INode {
-	/**
-	 * The path to the current node
-	 *
-	 * @var string
-	 */
-	protected $path;
-
-	protected FileInfo $info;
-
-	/**
-	 * @var IManager
-	 */
-	protected $shareManager;
-
-	protected \OCP\Files\Node $node;
-
-	/**
-	 * Sets up the node, expects a full path name
-	 */
-	public function __construct(
-		protected View $fileView,
-		FileInfo $info,
-		?IManager $shareManager = null,
-	) {
-		$this->path = $this->fileView->getRelativePath($info->getPath());
-		$this->info = $info;
-		if ($shareManager) {
-			$this->shareManager = $shareManager;
-		} else {
-			$this->shareManager = Server::get(\OCP\Share\IManager::class);
-		}
-		if ($info instanceof Folder || $info instanceof File) {
-			$this->node = $info;
-		} else {
-			// The Node API assumes that the view passed doesn't have a fake root
-			$rootView = Server::get(View::class);
-			$root = Server::get(IRootFolder::class);
-			if ($info->getType() === FileInfo::TYPE_FOLDER) {
-				$this->node = new Folder($root, $rootView, $this->fileView->getAbsolutePath($this->path), $info);
-			} else {
-				$this->node = new File($root, $rootView, $this->fileView->getAbsolutePath($this->path), $info);
-			}
-		}
-	}
-
-	protected function refreshInfo(): void {
-		$info = $this->fileView->getFileInfo($this->path);
-		if ($info === false) {
-			throw new \Sabre\DAV\Exception('Failed to get fileinfo for ' . $this->path);
-		}
-		$this->info = $info;
-		$root = Server::get(IRootFolder::class);
-		$rootView = Server::get(View::class);
-		if ($this->info->getType() === FileInfo::TYPE_FOLDER) {
-			$this->node = new Folder($root, $rootView, $this->path, $this->info);
-		} else {
-			$this->node = new File($root, $rootView, $this->path, $this->info);
-		}
-	}
-
-	/**
-	 *  Returns the name of the node
-	 *
-	 * @return string
-	 */
-	public function getName() {
-		return $this->info->getName();
-	}
-
-	/**
-	 * Returns the full path
-	 *
-	 * @return string
-	 */
-	public function getPath() {
-		return $this->path;
-	}
-
-	/**
-	 * Renames the node
-	 *
-	 * @param string $name The new name
-	 * @throws \Sabre\DAV\Exception\BadRequest
-	 * @throws \Sabre\DAV\Exception\Forbidden
-	 */
-	public function setName($name) {
-		// rename is only allowed if the delete privilege is granted
-		// (basically rename is a copy with delete of the original node)
-		if (!($this->info->isDeletable() || ($this->info->getMountPoint() instanceof MoveableMount && $this->info->getInternalPath() === ''))) {
-			throw new \Sabre\DAV\Exception\Forbidden();
-		}
-
-		[$parentPath,] = \Sabre\Uri\split($this->path);
-		[, $newName] = \Sabre\Uri\split($name);
-		$newPath = $parentPath . '/' . $newName;
-
-		// verify path of the target
-		$this->verifyPath($newPath);
-
-		if (!$this->fileView->rename($this->path, $newPath)) {
-			throw new \Sabre\DAV\Exception('Failed to rename ' . $this->path . ' to ' . $newPath);
-		}
-
-		$this->path = $newPath;
-
-		$this->refreshInfo();
-	}
-
-	/**
-	 * Returns the last modification time, as a unix timestamp
-	 *
-	 * @return int timestamp as integer
-	 */
-	public function getLastModified() {
-		$timestamp = $this->info->getMtime();
-		if (!empty($timestamp)) {
-			return (int)$timestamp;
-		}
-		return $timestamp;
-	}
-
-	/**
-	 *  sets the last modification time of the file (mtime) to the value given
-	 *  in the second parameter or to now if the second param is empty.
-	 *  Even if the modification time is set to a custom value the access time is set to now.
-	 */
-	public function touch($mtime) {
-		$mtime = $this->sanitizeMtime($mtime);
-		$this->fileView->touch($this->path, $mtime);
-		$this->refreshInfo();
-	}
-
-	/**
-	 * Returns the ETag for a file
-	 *
-	 * An ETag is a unique identifier representing the current version of the
-	 * file. If the file changes, the ETag MUST change.  The ETag is an
-	 * arbitrary string, but MUST be surrounded by double-quotes.
-	 *
-	 * Return null if the ETag can not effectively be determined
-	 *
-	 * @return string
-	 */
-	public function getETag() {
-		return '"' . $this->info->getEtag() . '"';
-	}
-
-	/**
-	 * Sets the ETag
-	 *
-	 * @param string $etag
-	 *
-	 * @return int file id of updated file or -1 on failure
-	 */
-	public function setETag($etag) {
-		return $this->fileView->putFileInfo($this->path, ['etag' => $etag]);
-	}
-
-	public function setCreationTime(int $time) {
-		return $this->fileView->putFileInfo($this->path, ['creation_time' => $time]);
-	}
-
-	public function setUploadTime(int $time) {
-		return $this->fileView->putFileInfo($this->path, ['upload_time' => $time]);
-	}
-
-	/**
-	 * Returns the size of the node, in bytes
-	 *
-	 * @psalm-suppress ImplementedReturnTypeMismatch \Sabre\DAV\IFile::getSize signature does not support 32bit
-	 * @return int|float
-	 */
-	public function getSize(): int|float {
-		return $this->info->getSize();
-	}
-
-	/**
-	 * Returns the cache's file id
-	 *
-	 * @return int
-	 */
-	public function getId() {
-		return $this->info->getId();
-	}
-
-	/**
-	 * @return string|null
-	 */
-	public function getFileId() {
-		if ($id = $this->info->getId()) {
-			return DavUtil::getDavFileId($id);
-		}
-
-		return null;
-	}
-
-	/**
-	 * @return integer
-	 */
-	public function getInternalFileId() {
-		return $this->info->getId();
-	}
-
-	public function getInternalPath(): string {
-		return $this->info->getInternalPath();
-	}
-
-	/**
-	 * @param string $user
-	 * @return int
-	 */
-	public function getSharePermissions($user) {
-		// check of we access a federated share
-		if ($user !== null) {
-			try {
-				$share = $this->shareManager->getShareByToken($user);
-				return $share->getPermissions();
-			} catch (ShareNotFound $e) {
-				// ignore
-			}
-		}
-
-		try {
-			$storage = $this->info->getStorage();
-		} catch (StorageNotAvailableException $e) {
-			$storage = null;
-		}
-
-		if ($storage && $storage->instanceOfStorage(ISharedStorage::class)) {
-			/** @var ISharedStorage $storage */
-			$permissions = (int)$storage->getShare()->getPermissions();
-		} else {
-			$permissions = $this->info->getPermissions();
-		}
-
-		/*
+    /**
+     * The path to the current node
+     *
+     * @var string
+     */
+    protected $path;
+
+    protected FileInfo $info;
+
+    /**
+     * @var IManager
+     */
+    protected $shareManager;
+
+    protected \OCP\Files\Node $node;
+
+    /**
+     * Sets up the node, expects a full path name
+     */
+    public function __construct(
+        protected View $fileView,
+        FileInfo $info,
+        ?IManager $shareManager = null,
+    ) {
+        $this->path = $this->fileView->getRelativePath($info->getPath());
+        $this->info = $info;
+        if ($shareManager) {
+            $this->shareManager = $shareManager;
+        } else {
+            $this->shareManager = Server::get(\OCP\Share\IManager::class);
+        }
+        if ($info instanceof Folder || $info instanceof File) {
+            $this->node = $info;
+        } else {
+            // The Node API assumes that the view passed doesn't have a fake root
+            $rootView = Server::get(View::class);
+            $root = Server::get(IRootFolder::class);
+            if ($info->getType() === FileInfo::TYPE_FOLDER) {
+                $this->node = new Folder($root, $rootView, $this->fileView->getAbsolutePath($this->path), $info);
+            } else {
+                $this->node = new File($root, $rootView, $this->fileView->getAbsolutePath($this->path), $info);
+            }
+        }
+    }
+
+    protected function refreshInfo(): void {
+        $info = $this->fileView->getFileInfo($this->path);
+        if ($info === false) {
+            throw new \Sabre\DAV\Exception('Failed to get fileinfo for ' . $this->path);
+        }
+        $this->info = $info;
+        $root = Server::get(IRootFolder::class);
+        $rootView = Server::get(View::class);
+        if ($this->info->getType() === FileInfo::TYPE_FOLDER) {
+            $this->node = new Folder($root, $rootView, $this->path, $this->info);
+        } else {
+            $this->node = new File($root, $rootView, $this->path, $this->info);
+        }
+    }
+
+    /**
+     *  Returns the name of the node
+     *
+     * @return string
+     */
+    public function getName() {
+        return $this->info->getName();
+    }
+
+    /**
+     * Returns the full path
+     *
+     * @return string
+     */
+    public function getPath() {
+        return $this->path;
+    }
+
+    /**
+     * Renames the node
+     *
+     * @param string $name The new name
+     * @throws \Sabre\DAV\Exception\BadRequest
+     * @throws \Sabre\DAV\Exception\Forbidden
+     */
+    public function setName($name) {
+        // rename is only allowed if the delete privilege is granted
+        // (basically rename is a copy with delete of the original node)
+        if (!($this->info->isDeletable() || ($this->info->getMountPoint() instanceof MoveableMount && $this->info->getInternalPath() === ''))) {
+            throw new \Sabre\DAV\Exception\Forbidden();
+        }
+
+        [$parentPath,] = \Sabre\Uri\split($this->path);
+        [, $newName] = \Sabre\Uri\split($name);
+        $newPath = $parentPath . '/' . $newName;
+
+        // verify path of the target
+        $this->verifyPath($newPath);
+
+        if (!$this->fileView->rename($this->path, $newPath)) {
+            throw new \Sabre\DAV\Exception('Failed to rename ' . $this->path . ' to ' . $newPath);
+        }
+
+        $this->path = $newPath;
+
+        $this->refreshInfo();
+    }
+
+    /**
+     * Returns the last modification time, as a unix timestamp
+     *
+     * @return int timestamp as integer
+     */
+    public function getLastModified() {
+        $timestamp = $this->info->getMtime();
+        if (!empty($timestamp)) {
+            return (int)$timestamp;
+        }
+        return $timestamp;
+    }
+
+    /**
+     *  sets the last modification time of the file (mtime) to the value given
+     *  in the second parameter or to now if the second param is empty.
+     *  Even if the modification time is set to a custom value the access time is set to now.
+     */
+    public function touch($mtime) {
+        $mtime = $this->sanitizeMtime($mtime);
+        $this->fileView->touch($this->path, $mtime);
+        $this->refreshInfo();
+    }
+
+    /**
+     * Returns the ETag for a file
+     *
+     * An ETag is a unique identifier representing the current version of the
+     * file. If the file changes, the ETag MUST change.  The ETag is an
+     * arbitrary string, but MUST be surrounded by double-quotes.
+     *
+     * Return null if the ETag can not effectively be determined
+     *
+     * @return string
+     */
+    public function getETag() {
+        return '"' . $this->info->getEtag() . '"';
+    }
+
+    /**
+     * Sets the ETag
+     *
+     * @param string $etag
+     *
+     * @return int file id of updated file or -1 on failure
+     */
+    public function setETag($etag) {
+        return $this->fileView->putFileInfo($this->path, ['etag' => $etag]);
+    }
+
+    public function setCreationTime(int $time) {
+        return $this->fileView->putFileInfo($this->path, ['creation_time' => $time]);
+    }
+
+    public function setUploadTime(int $time) {
+        return $this->fileView->putFileInfo($this->path, ['upload_time' => $time]);
+    }
+
+    /**
+     * Returns the size of the node, in bytes
+     *
+     * @psalm-suppress ImplementedReturnTypeMismatch \Sabre\DAV\IFile::getSize signature does not support 32bit
+     * @return int|float
+     */
+    public function getSize(): int|float {
+        return $this->info->getSize();
+    }
+
+    /**
+     * Returns the cache's file id
+     *
+     * @return int
+     */
+    public function getId() {
+        return $this->info->getId();
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getFileId() {
+        if ($id = $this->info->getId()) {
+            return DavUtil::getDavFileId($id);
+        }
+
+        return null;
+    }
+
+    /**
+     * @return integer
+     */
+    public function getInternalFileId() {
+        return $this->info->getId();
+    }
+
+    public function getInternalPath(): string {
+        return $this->info->getInternalPath();
+    }
+
+    /**
+     * @param string $user
+     * @return int
+     */
+    public function getSharePermissions($user) {
+        // check of we access a federated share
+        if ($user !== null) {
+            try {
+                $share = $this->shareManager->getShareByToken($user);
+                return $share->getPermissions();
+            } catch (ShareNotFound $e) {
+                // ignore
+            }
+        }
+
+        try {
+            $storage = $this->info->getStorage();
+        } catch (StorageNotAvailableException $e) {
+            $storage = null;
+        }
+
+        if ($storage && $storage->instanceOfStorage(ISharedStorage::class)) {
+            /** @var ISharedStorage $storage */
+            $permissions = (int)$storage->getShare()->getPermissions();
+        } else {
+            $permissions = $this->info->getPermissions();
+        }
+
+        /*
 		 * We can always share non moveable mount points with DELETE and UPDATE
 		 * Eventually we need to do this properly
 		 */
-		$mountpoint = $this->info->getMountPoint();
-		if (!($mountpoint instanceof MoveableMount)) {
-			$mountpointpath = $mountpoint->getMountPoint();
-			if (str_ends_with($mountpointpath, '/')) {
-				$mountpointpath = substr($mountpointpath, 0, -1);
-			}
-
-			if (!$mountpoint->getOption('readonly', false) && $mountpointpath === $this->info->getPath()) {
-				$permissions |= Constants::PERMISSION_DELETE | Constants::PERMISSION_UPDATE;
-			}
-		}
-
-		/*
+        $mountpoint = $this->info->getMountPoint();
+        if (!($mountpoint instanceof MoveableMount)) {
+            $mountpointpath = $mountpoint->getMountPoint();
+            if (str_ends_with($mountpointpath, '/')) {
+                $mountpointpath = substr($mountpointpath, 0, -1);
+            }
+
+            if (!$mountpoint->getOption('readonly', false) && $mountpointpath === $this->info->getPath()) {
+                $permissions |= Constants::PERMISSION_DELETE | Constants::PERMISSION_UPDATE;
+            }
+        }
+
+        /*
 		 * Files can't have create or delete permissions
 		 */
-		if ($this->info->getType() === FileInfo::TYPE_FILE) {
-			$permissions &= ~(Constants::PERMISSION_CREATE | Constants::PERMISSION_DELETE);
-		}
-
-		return $permissions;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getShareAttributes(): array {
-		try {
-			$storage = $this->node->getStorage();
-		} catch (NotFoundException $e) {
-			return [];
-		}
-
-		$attributes = [];
-		if ($storage->instanceOfStorage(ISharedStorage::class)) {
-			/** @var ISharedStorage $storage */
-			$attributes = $storage->getShare()->getAttributes();
-			if ($attributes === null) {
-				return [];
-			} else {
-				return $attributes->toArray();
-			}
-		}
-
-		return $attributes;
-	}
-
-	public function getNoteFromShare(?string $user): ?string {
-		try {
-			$storage = $this->node->getStorage();
-		} catch (NotFoundException) {
-			return null;
-		}
-
-		if ($storage->instanceOfStorage(ISharedStorage::class)) {
-			/** @var ISharedStorage $storage */
-			$share = $storage->getShare();
-			if ($user === $share->getShareOwner()) {
-				// Note is only for recipient not the owner
-				return null;
-			}
-			return $share->getNote();
-		}
-
-		return null;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getDavPermissions() {
-		return DavUtil::getDavPermissions($this->info);
-	}
-
-	public function getOwner() {
-		return $this->info->getOwner();
-	}
-
-	protected function verifyPath(?string $path = null): void {
-		try {
-			$path = $path ?? $this->info->getPath();
-			$this->fileView->verifyPath(
-				dirname($path),
-				basename($path),
-			);
-		} catch (InvalidPathException $ex) {
-			throw new InvalidPath($ex->getMessage());
-		}
-	}
-
-	/**
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 */
-	public function acquireLock($type) {
-		$this->fileView->lockFile($this->path, $type);
-	}
-
-	/**
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 */
-	public function releaseLock($type) {
-		$this->fileView->unlockFile($this->path, $type);
-	}
-
-	/**
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 */
-	public function changeLock($type) {
-		$this->fileView->changeLock($this->path, $type);
-	}
-
-	public function getFileInfo() {
-		return $this->info;
-	}
-
-	public function getNode(): \OCP\Files\Node {
-		return $this->node;
-	}
-
-	protected function sanitizeMtime(string $mtimeFromRequest): int {
-		return MtimeSanitizer::sanitizeMtime($mtimeFromRequest);
-	}
+        if ($this->info->getType() === FileInfo::TYPE_FILE) {
+            $permissions &= ~(Constants::PERMISSION_CREATE | Constants::PERMISSION_DELETE);
+        }
+
+        return $permissions;
+    }
+
+    /**
+     * @return array
+     */
+    public function getShareAttributes(): array {
+        try {
+            $storage = $this->node->getStorage();
+        } catch (NotFoundException $e) {
+            return [];
+        }
+
+        $attributes = [];
+        if ($storage->instanceOfStorage(ISharedStorage::class)) {
+            /** @var ISharedStorage $storage */
+            $attributes = $storage->getShare()->getAttributes();
+            if ($attributes === null) {
+                return [];
+            } else {
+                return $attributes->toArray();
+            }
+        }
+
+        return $attributes;
+    }
+
+    public function getNoteFromShare(?string $user): ?string {
+        try {
+            $storage = $this->node->getStorage();
+        } catch (NotFoundException) {
+            return null;
+        }
+
+        if ($storage->instanceOfStorage(ISharedStorage::class)) {
+            /** @var ISharedStorage $storage */
+            $share = $storage->getShare();
+            if ($user === $share->getShareOwner()) {
+                // Note is only for recipient not the owner
+                return null;
+            }
+            return $share->getNote();
+        }
+
+        return null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDavPermissions() {
+        return DavUtil::getDavPermissions($this->info);
+    }
+
+    public function getOwner() {
+        return $this->info->getOwner();
+    }
+
+    protected function verifyPath(?string $path = null): void {
+        try {
+            $path = $path ?? $this->info->getPath();
+            $this->fileView->verifyPath(
+                dirname($path),
+                basename($path),
+            );
+        } catch (InvalidPathException $ex) {
+            throw new InvalidPath($ex->getMessage());
+        }
+    }
+
+    /**
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     */
+    public function acquireLock($type) {
+        $this->fileView->lockFile($this->path, $type);
+    }
+
+    /**
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     */
+    public function releaseLock($type) {
+        $this->fileView->unlockFile($this->path, $type);
+    }
+
+    /**
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     */
+    public function changeLock($type) {
+        $this->fileView->changeLock($this->path, $type);
+    }
+
+    public function getFileInfo() {
+        return $this->info;
+    }
+
+    public function getNode(): \OCP\Files\Node {
+        return $this->node;
+    }
+
+    protected function sanitizeMtime(string $mtimeFromRequest): int {
+        return MtimeSanitizer::sanitizeMtime($mtimeFromRequest);
+    }
 }