refactor: Apply second batch of comments

Signed-off-by: Carl Schwan <[email protected]>

Author: CarlSchwan

apps/files_external/lib/Lib/Notify/SMBNotifyHandler.php

@@ -110,21 +110,16 @@ private function mapChange(\Icewind\SMB\Change $change) {
 		return $result;
 	}
 
-	private function mapNotifyType($smbType) {
-		switch ($smbType) {
-			case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED:
-				return IChange::ADDED;
-			case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED:
-				return IChange::REMOVED;
-			case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED:
-			case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED_STREAM:
-			case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED_STREAM:
-			case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED_STREAM:
-				return IChange::MODIFIED;
-			case \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_NEW:
-				return IChange::RENAMED;
-			default:
-				return null;
-		}
+	/**
+	 * @return IChange::ADDED|IChange::REMOVED|IChange::MODIFIED|IChange::RENAMED|null
+	 */
+	private function mapNotifyType($smbType): ?int {
+		return match ($smbType) {
+			\Icewind\SMB\INotifyHandler::NOTIFY_ADDED => IChange::ADDED,
+			\Icewind\SMB\INotifyHandler::NOTIFY_REMOVED => IChange::REMOVED,
+			\Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED, \Icewind\SMB\INotifyHandler::NOTIFY_ADDED_STREAM, \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED_STREAM, \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED_STREAM => IChange::MODIFIED,
+			\Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_NEW => IChange::RENAMED,
+			default => null,
+		};
 	}
 }

apps/files_sharing/lib/SharedMount.php

@@ -28,9 +28,7 @@
  * Shared mount points can be moved by the user
  */
 class SharedMount extends MountPoint implements MoveableMount, ISharedMountPoint {
-	/**
-	 * @var SharedStorage $storage
-	 */
+	/** @var ?SharedStorage $storage */
 	protected $storage = null;
 
 	/** @var IShare */

build/psalm-baseline.xml

@@ -3681,11 +3681,6 @@
       <code><![CDATA[self::getGlobalCache()->getStorageInfo($storageId)]]></code>
     </NullableReturnStatement>
   </file>
-  <file src="lib/private/Files/Cache/Updater.php">
-    <RedundantCondition>
-      <code><![CDATA[$this->cache instanceof Cache]]></code>
-    </RedundantCondition>
-  </file>
   <file src="lib/private/Files/Cache/Wrapper/CacheWrapper.php">
     <LessSpecificImplementedReturnType>
       <code><![CDATA[array]]></code>

lib/private/Authentication/LoginCredentials/Credentials.php

@@ -13,7 +13,7 @@ class Credentials implements ICredentials {
 	public function __construct(
 		private readonly string $uid,
 		private readonly string $loginName,
-		private readonly string $password,
+		private readonly ?string $password,
 	) {
 	}
 
@@ -28,7 +28,7 @@ public function getLoginName(): string {
 	}
 
 	#[Override]
-	public function getPassword(): string {
+	public function getPassword(): ?string {
 		return $this->password;
 	}
 }

lib/private/Config.php

@@ -30,7 +30,7 @@ public function __construct(
 		protected string $configDir,
 		protected string $configFileName = 'config.php',
 	) {
-		$this->configFilePath = $this->configDir . $configFileName;
+		$this->configFilePath = $this->configDir . $this->configFileName;
 		$this->readData();
 		$this->isReadOnly = $this->getValue('config_is_read_only', false);
 	}

lib/private/Encryption/Util.php

@@ -28,30 +28,20 @@ class Util {
 	public const HEADER_ENCRYPTION_MODULE_KEY = 'oc_encryption_module';
 
 	/**
-	 * block size will always be 8192 for a PHP stream
+	 * Block size will always be 8192 for a PHP stream
 	 * @see https://bugs.php.net/bug.php?id=21641
-	 * @var integer
 	 */
-	protected $headerSize = 8192;
+	protected int $headerSize = 8192;
 
 	/**
-	 * block size will always be 8192 for a PHP stream
+	 * Block size will always be 8192 for a PHP stream
 	 * @see https://bugs.php.net/bug.php?id=21641
-	 * @var integer
 	 */
-	protected $blockSize = 8192;
+	protected int $blockSize = 8192;
 
-	/** @var array */
-	protected $ocHeaderKeys;
-
-	/** @var array paths excluded from encryption */
+	protected array $ocHeaderKeys;
 	protected array $excludedPaths = [];
 
-	/**
-	 *
-	 * @param View $rootView
-	 * @param IConfig $config
-	 */
 	public function __construct(
 		protected View $rootView,
 		protected IUserManager $userManager,

lib/private/Files/Cache/FailedCache.php

@@ -19,13 +19,8 @@
  * Storage placeholder to represent a missing precondition, storage unavailable
  */
 class FailedCache implements ICache {
-	/**
-	 * FailedCache constructor.
-	 *
-	 * @param bool $visible
-	 */
 	public function __construct(
-		private $visible = true,
+		private readonly bool $visible = true,
 	) {
 	}
 

lib/private/Files/Cache/Scanner.php

@@ -13,6 +13,7 @@
 use OC\Files\Storage\Wrapper\Encryption;
 use OC\Files\Storage\Wrapper\Jail;
 use OC\Hooks\BasicEmitter;
+use OCP\Files\Cache\ICache;
 use OCP\Files\Cache\ICacheEntry;
 use OCP\Files\Cache\IScanner;
 use OCP\Files\ForbiddenException;
@@ -42,15 +43,11 @@
  */
 class Scanner extends BasicEmitter implements IScanner {
 	protected string $storageId;
-	/** @var Cache */
-	protected $cache;
-	/** @var boolean $cacheActive If true, perform cache operations, if false, do not affect cache */
+	protected ICache $cache;
+	/** @var bool $cacheActive Whether to perform cache operations */
 	protected bool $cacheActive;
-	/** @var bool $useTransactions whether to use transactions */
 	protected bool $useTransactions = true;
-	/** * @var ILockingProvider */
 	protected ILockingProvider $lockingProvider;
-
 	protected IDBConnection $connection;
 
 	public function __construct(
@@ -416,7 +413,9 @@ protected function scanChildren(string $path, $recursive, int $reuse, int $folde
 		// for encrypted storages, we trigger a regular folder size calculation instead of using the calculated size
 		// to make sure we also updated the unencrypted-size where applicable
 		if ($this->storage->instanceOfStorage(Encryption::class)) {
-			$this->cache->calculateFolderSize($path);
+			/** @var Cache $cache */
+			$cache = $this->cache;
+			$cache->calculateFolderSize($path);
 		} else {
 			if ($this->cacheActive) {
 				$updatedData = [];
@@ -588,14 +587,8 @@ protected function runBackgroundScanJob(callable $callback, $path) {
 			if ($this->cacheActive && $this->cache instanceof Cache) {
 				$this->cache->correctFolderSize($path, null, true);
 			}
-		} catch (StorageInvalidException $e) {
-			// skip unavailable storages
-		} catch (StorageNotAvailableException $e) {
-			// skip unavailable storages
-		} catch (ForbiddenException $e) {
-			// skip forbidden storages
-		} catch (LockedException $e) {
-			// skip unavailable storages
+		} catch (StorageInvalidException|StorageNotAvailableException|ForbiddenException|LockedException) {
+			// skip unavailable and forbidden storages
 		}
 	}
 

lib/private/Files/Cache/Updater.php

@@ -13,41 +13,21 @@
 use OC\Files\Storage\Storage;
 use OCP\Files\Cache\ICache;
 use OCP\Files\Cache\ICacheEntry;
+use OCP\Files\Cache\IPropagator;
+use OCP\Files\Cache\IScanner;
 use OCP\Files\Cache\IUpdater;
 use OCP\Files\Storage\IStorage;
 use OCP\Server;
+use Override;
 use Psr\Log\LoggerInterface;
 
-/**
- * Update the cache and propagate changes
- *
- */
 class Updater implements IUpdater {
-	/**
-	 * @var bool
-	 */
-	protected $enabled = true;
-
-	/**
-	 * @var Propagator
-	 */
-	protected $propagator;
-
-	/**
-	 * @var Scanner
-	 */
-	protected $scanner;
-
-	/**
-	 * @var Cache
-	 */
-	protected $cache;
-
+	protected bool $enabled = true;
+	protected IPropagator $propagator;
+	protected IScanner $scanner;
+	protected ICache $cache;
 	private LoggerInterface $logger;
 
-	/**
-	 * @param Storage $storage
-	 */
 	public function __construct(
 		protected Storage $storage,
 	) {
@@ -60,46 +40,32 @@ public function __construct(
 	/**
 	 * Disable updating the cache through this updater
 	 */
-	public function disable() {
+	public function disable(): void {
 		$this->enabled = false;
 	}
 
 	/**
 	 * Re-enable the updating of the cache through this updater
 	 */
-	public function enable() {
+	public function enable(): void {
 		$this->enabled = true;
 	}
 
-	/**
-	 * Get the propagator for etags and mtime for the view the updater works on
-	 *
-	 * @return Propagator
-	 */
-	public function getPropagator() {
+	#[Override]
+	public function getPropagator(): IPropagator {
 		return $this->propagator;
 	}
 
-	/**
-	 * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem
-	 *
-	 * @param string $path the path of the file to propagate the changes for
-	 * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used
-	 */
-	public function propagate($path, $time = null) {
+	#[Override]
+	public function propagate(string $path, ?int $time = null): void {
 		if (Scanner::isPartialFile($path)) {
 			return;
 		}
 		$this->propagator->propagateChange($path, $time);
 	}
 
-	/**
-	 * Update the cache for $path and update the size, etag and mtime of the parent folders
-	 *
-	 * @param string $path
-	 * @param int $time
-	 */
-	public function update($path, $time = null, ?int $sizeDifference = null) {
+	#[Override]
+	public function update(string $path, ?int $time = null, ?int $sizeDifference = null): void {
 		if (!$this->enabled || Scanner::isPartialFile($path)) {
 			return;
 		}
@@ -126,12 +92,8 @@ public function update($path, $time = null, ?int $sizeDifference = null) {
 		$this->propagator->propagateChange($path, $time, $sizeDifference ?? 0);
 	}
 
-	/**
-	 * Remove $path from the cache and update the size, etag and mtime of the parent folders
-	 *
-	 * @param string $path
-	 */
-	public function remove($path) {
+	#[Override]
+	public function remove(string $path): void {
 		if (!$this->enabled || Scanner::isPartialFile($path)) {
 			return;
 		}
@@ -156,14 +118,8 @@ public function remove($path) {
 		}
 	}
 
-	/**
-	 * Rename a file or folder in the cache.
-	 *
-	 * @param IStorage $sourceStorage
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function renameFromStorage(IStorage $sourceStorage, $source, $target) {
+	#[Override]
+	public function renameFromStorage(IStorage $sourceStorage, string $source, string $target): void {
 		$this->copyOrRenameFromStorage($sourceStorage, $source, $target, function (ICache $sourceCache) use ($sourceStorage, $source, $target): void {
 			// Remove existing cache entry to no reuse the fileId.
 			if ($this->cache->inCache($target)) {
@@ -178,9 +134,7 @@ public function renameFromStorage(IStorage $sourceStorage, $source, $target) {
 		});
 	}
 
-	/**
-	 * Copy a file or folder in the cache.
-	 */
+	#[Override]
 	public function copyFromStorage(IStorage $sourceStorage, string $source, string $target): void {
 		$this->copyOrRenameFromStorage($sourceStorage, $source, $target, function (ICache $sourceCache, ICacheEntry $sourceInfo) use ($target): void {
 			$parent = dirname($target);
@@ -250,7 +204,7 @@ private function copyOrRenameFromStorage(IStorage $sourceStorage, string $source
 		$this->propagator->propagateChange($target, $time);
 	}
 
-	private function updateStorageMTimeOnly($internalPath) {
+	private function updateStorageMTimeOnly(string $internalPath): void {
 		$fileId = $this->cache->getId($internalPath);
 		if ($fileId !== -1) {
 			$mtime = $this->storage->filemtime($internalPath);
@@ -266,11 +220,9 @@ private function updateStorageMTimeOnly($internalPath) {
 	}
 
 	/**
-	 * update the storage_mtime of the direct parent in the cache to the mtime from the storage
-	 *
-	 * @param string $internalPath
+	 * Update the storage_mtime of the direct parent in the cache to the mtime from the storage
 	 */
-	private function correctParentStorageMtime($internalPath) {
+	private function correctParentStorageMtime(string $internalPath): void {
 		$parentId = $this->cache->getParentId($internalPath);
 		$parent = dirname($internalPath);
 		if ($parentId != -1) {

lib/private/Files/Cache/Watcher.php

@@ -8,33 +8,22 @@
 namespace OC\Files\Cache;
 
 use OC\Files\Storage\Storage;
+use OCP\Files\Cache\ICache;
 use OCP\Files\Cache\ICacheEntry;
+use OCP\Files\Cache\IScanner;
 use OCP\Files\Cache\IWatcher;
 
 /**
  * check the storage backends for updates and change the cache accordingly
  */
 class Watcher implements IWatcher {
-	protected $watchPolicy = self::CHECK_ONCE;
-
-	protected $checkedPaths = [];
-
-	/**
-	 * @var Cache $cache
-	 */
-	protected $cache;
-
-	/**
-	 * @var Scanner $scanner ;
-	 */
-	protected $scanner;
-
+	protected int $watchPolicy = self::CHECK_ONCE;
+	protected array $checkedPaths = [];
+	protected ICache $cache;
+	protected IScanner $scanner;
 	/** @var callable[] */
-	protected $onUpdate = [];
+	protected array $onUpdate = [];
 
-	/**
-	 * @param Storage $storage
-	 */
 	public function __construct(
 		protected Storage $storage,
 	) {