Skip to content

Commit

Permalink
More type cleanup in View and FileInfo
Browse files Browse the repository at this point in the history 
Signed-off-by: Côme Chilliet <[email protected]>
  • Loading branch information
@come-nc
come-nc committed Apr 3, 2023
1 parent ea05544 commit 0b3dad8
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 97 deletions.
32 changes: 14 additions & 18 deletions lib/private/Files/FileInfo.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,9 @@
use OCP\IUser;

class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
private array|ICacheEntry $data;
/**
* @var array $data
*/
private $data;

/**
* @var string $path
* @var string
*/
private $path;

Expand All @@ -53,7 +49,7 @@ class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
private $storage;

/**
* @var string $internalPath
* @var string
*/
private $internalPath;

Expand All @@ -62,22 +58,19 @@ class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
*/
private $mount;

/**
* @var IUser
*/
private $owner;
private ?IUser $owner;

/**
* @var string[]
*/
private $childEtags = [];
private array $childEtags = [];

/**
* @var IMountPoint[]
*/
private $subMounts = [];
private array $subMounts = [];

private $subMountsUsed = false;
private bool $subMountsUsed = false;

/**
* The size of the file/folder without any sub mount
Expand All @@ -89,8 +82,8 @@ class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
* @param Storage\Storage $storage
* @param string $internalPath
* @param array|ICacheEntry $data
* @param \OCP\Files\Mount\IMountPoint $mount
* @param \OCP\IUser|null $owner
* @param IMountPoint $mount
* @param ?IUser $owner
*/
public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
$this->path = $path;
Expand All @@ -107,6 +100,9 @@ public function __construct($path, $storage, $internalPath, $data, $mount, $owne
}

public function offsetSet($offset, $value): void {
if (is_null($offset)) {
throw new \TypeError('Null offset not supported');
}
$this->data[$offset] = $value;
}

Expand Down Expand Up @@ -357,7 +353,7 @@ public function getMountPoint() {
/**
* Get the owner of the file
*
* @return \OCP\IUser
* @return ?IUser
*/
public function getOwner() {
return $this->owner;
Expand All @@ -370,7 +366,7 @@ public function setSubMounts(array $mounts) {
$this->subMounts = $mounts;
}

private function updateEntryfromSubMounts() {
private function updateEntryfromSubMounts(): void {
if ($this->subMountsUsed) {
return;
}
Expand Down
145 changes: 68 additions & 77 deletions lib/private/Files/View.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ public function filesize(string $path) {
/**
* @param string $path
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
* @throws InvalidPathException
*/
public function readfile($path) {
$this->assertPathLength($path);
Expand All @@ -413,7 +413,7 @@ public function readfile($path) {
* @param int $from
* @param int $to
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
* @throws InvalidPathException
* @throws \OCP\Files\UnseekableException
*/
public function readfilePart($path, $from, $to) {
Expand Down Expand Up @@ -617,6 +617,9 @@ public function file_put_contents($path, $data) {
and !Filesystem::isFileBlacklisted($path)
) {
$path = $this->getRelativePath($absolutePath);
if ($path === null) {
throw new InvalidPathException("Path $absolutePath is not in the expected root");
}

$this->lockFile($path, ILockingProvider::LOCK_SHARED);

Expand Down Expand Up @@ -978,7 +981,7 @@ public function fopen($path, $mode) {

/**
* @param string $path
* @throws \OCP\Files\InvalidPathException
* @throws InvalidPathException
*/
public function toTmpFile($path): string|false {
$this->assertPathLength($path);
Expand All @@ -1001,7 +1004,7 @@ public function toTmpFile($path): string|false {
* @param string $tmpFile
* @param string $path
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
* @throws InvalidPathException
*/
public function fromTmpFile($tmpFile, $path) {
$this->assertPathLength($path);
Expand Down Expand Up @@ -1043,7 +1046,7 @@ public function fromTmpFile($tmpFile, $path) {
/**
* @param string $path
* @return mixed
* @throws \OCP\Files\InvalidPathException
* @throws InvalidPathException
*/
public function getMimeType($path) {
$this->assertPathLength($path);
Expand Down Expand Up @@ -1082,7 +1085,7 @@ public function hash($type, $path, $raw = false): string|bool {
/**
* @param string $path
* @return mixed
* @throws \OCP\Files\InvalidPathException
* @throws InvalidPathException
*/
public function free_space($path = '/') {
$this->assertPathLength($path);
Expand All @@ -1096,9 +1099,6 @@ public function 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 LockedException
Expand All @@ -1107,7 +1107,7 @@ public function free_space($path = '/') {
* 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) {
private function basicOperation(string $operation, string $path, array $hooks = [], $extraParam = null) {
$postFix = (substr($path, -1) === '/') ? '/' : '';
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
if (Filesystem::isValidPath($path)
Expand All @@ -1124,9 +1124,9 @@ private function basicOperation($operation, $path, $hooks = [], $extraParam = nu
}

$run = $this->runHooks($hooks, $path);
/** @var \OC\Files\Storage\Storage $storage */
[$storage, $internalPath] = Filesystem::resolvePath($absolutePath . $postFix);
if ($run and $storage) {
/** @var \OC\Files\Storage\Storage $storage */
if (in_array('write', $hooks) || in_array('delete', $hooks)) {
try {
$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
Expand Down Expand Up @@ -1204,14 +1204,15 @@ private function basicOperation($operation, $path, $hooks = [], $extraParam = nu
* @param string $path
* @return ?string
*/
private function getHookPath($path) {
if (!Filesystem::getView()) {
private function getHookPath($path): ?string {
$view = Filesystem::getView();
if (!$view) {
return $path;
}
return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
return $view->getRelativePath($this->getAbsolutePath($path));
}

private function shouldEmitHooks($path = '') {
private function shouldEmitHooks(string $path = ''): bool {
if ($path && Cache\Scanner::isPartialFile($path)) {
return false;
}
Expand Down Expand Up @@ -1335,7 +1336,7 @@ private function getCacheEntry($storage, $internalPath, $relativePath) {
* @param string $path
* @param bool|string $includeMountPoints true to add mountpoint sizes,
* 'ext' to add only ext storage mount point sizes. Defaults to true.
* @return \OC\Files\FileInfo|false False if file does not exist
* @return \OCP\Files\FileInfo|false False if file does not exist
*/
public function getFileInfo($path, $includeMountPoints = true) {
$this->assertPathLength($path);
Expand Down Expand Up @@ -1745,37 +1746,33 @@ public function getPath($id, int $storageId = null) {
* @param string $path
* @throws InvalidPathException
*/
private function assertPathLength($path) {
private function assertPathLength($path): void {
$maxLen = min(PHP_MAXPATHLEN, 4000);
// Check for the string length - performed using isset() instead of strlen()
// because isset() is about 5x-40x faster.
if (isset($path[$maxLen])) {
$pathLen = strlen($path);
throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
throw new InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
}
}

/**
* check if it is allowed to move a mount point to a given target.
* It is not allowed to move a mount point into a different mount point or
* into an already shared folder
*
* @param IStorage $targetStorage
* @param string $targetInternalPath
* @return boolean
*/
private function targetIsNotShared(IStorage $targetStorage, string $targetInternalPath) {
private function targetIsNotShared(IStorage $targetStorage, string $targetInternalPath): bool {
// note: cannot use the view because the target is already locked
$fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
$fileId = $targetStorage->getCache()->getId($targetInternalPath);
if ($fileId === -1) {
// target might not exist, need to check parent instead
$fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
$fileId = $targetStorage->getCache()->getId(dirname($targetInternalPath));
}

// check if any of the parents were shared by the current owner (include collections)
$shares = Share::getItemShared(
'folder',
$fileId,
(string)$fileId,
\OC\Share\Constants::FORMAT_NONE,
null,
true
Expand Down Expand Up @@ -1826,7 +1823,7 @@ private function getPartFileInfo($path) {
* @param string $fileName
* @throws InvalidPathException
*/
public function verifyPath($path, $fileName) {
public function verifyPath($path, $fileName): void {
try {
/** @type \OCP\Files\Storage $storage */
[$storage, $internalPath] = $this->resolvePath($path);
Expand Down Expand Up @@ -1884,7 +1881,7 @@ private function getParents($path) {
* is mounted directly on the given path, false otherwise
* @return IMountPoint mount point for which to apply locks
*/
private function getMountForLock($absolutePath, $useParentMount = false) {
private function getMountForLock(string $absolutePath, bool $useParentMount = false): IMountPoint {
$mount = Filesystem::getMountManager()->find($absolutePath);

if ($useParentMount) {
Expand Down Expand Up @@ -1917,24 +1914,22 @@ private function lockPath($path, $type, $lockMountPoint = false) {
}

$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
if ($mount) {
try {
$storage = $mount->getStorage();
if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->acquireLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}
} catch (LockedException $e) {
// rethrow with the a human-readable path
throw new LockedException(
$this->getPathRelativeToFiles($absolutePath),
$e,
$e->getExistingLock()
try {
$storage = $mount->getStorage();
if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->acquireLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}
} catch (LockedException $e) {
// rethrow with the a human-readable path
throw new LockedException(
$this->getPathRelativeToFiles($absolutePath),
$e,
$e->getExistingLock()
);
}

return true;
Expand All @@ -1959,31 +1954,29 @@ public function changeLock($path, $type, $lockMountPoint = false) {
}

$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
if ($mount) {
try {
$storage = $mount->getStorage();
if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->changeLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}
} catch (LockedException $e) {
try {
$storage = $mount->getStorage();
if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->changeLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}
} catch (LockedException $e) {
try {
// rethrow with the a human-readable path
throw new LockedException(
$this->getPathRelativeToFiles($absolutePath),
$e,
$e->getExistingLock()
);
} catch (\InvalidArgumentException $ex) {
throw new LockedException(
$absolutePath,
$ex,
$e->getExistingLock()
);
}
// rethrow with the a human-readable path
throw new LockedException(
$this->getPathRelativeToFiles($absolutePath),
$e,
$e->getExistingLock()
);
} catch (\InvalidArgumentException $ex) {
throw new LockedException(
$absolutePath,
$ex,
$e->getExistingLock()
);
}
}

Expand All @@ -2008,15 +2001,13 @@ private function unlockPath($path, $type, $lockMountPoint = 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
);
}
$storage = $mount->getStorage();
if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
$storage->releaseLock(
$mount->getInternalPath($absolutePath),
$type,
$this->lockingProvider
);
}

return true;
Expand Down
Loading

0 comments on commit 0b3dad8

Please sign in to comment.