refactor(psalm): Bump psalm to level 1

Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>

Author: CarlSchwan

lib/AppInfo/Application.php

@@ -35,6 +35,9 @@
 
 include_once __DIR__ . '/../../vendor/autoload.php';
 
+/**
+ * @psalm-api
+ */
 class Application extends App implements IBootstrap {
 
 	public const appID = 'sharelisting';

lib/Command/AbstractCommand.php

@@ -45,12 +45,19 @@ public function configure(): void {
 		);
 	}
 
+	/**
+	 * @return array{0: string, 1: string, 2: string, 3: int}
+	 */
 	protected function getOptions(InputInterface $input): array {
+		/** @var string $user */
 		$user = $input->getOption('user');
+		/** @var string $path */
 		$path = $input->getOption('path');
+		/** @var string $token */
 		$token = $input->getOption('token');
-		$filter = $this->sharesList->filterStringToInt($input->getOption('filter'));
+		/** @var string $filter */
+		$filter = $input->getOption('filter');
 
-		return [$user, $path, $token, $filter];
+		return [$user, $path, $token, $this->sharesList->filterStringToInt($filter)];
 	}
 }

lib/Controller/ApiController.php

@@ -36,6 +36,9 @@
 use function iter\map;
 use function iter\toArray;
 
+/**
+ * @psalm-api
+ */
 class ApiController extends OCSController {
 	public function __construct(
 		string $appName,
@@ -67,15 +70,17 @@ public function getSharedSubfolders(string $path): DataResponse {
 		$formattedShares = map(fn (IShare $share) => $this->sharesList->formatShare($share), $shares);
 
 		// remove current folder
-		$filteredShares = filter(fn ($share) => $share['path'] !== $path, $formattedShares);
+		$filteredShares = filter(fn (array $share): bool => $share['path'] !== $path, $formattedShares);
 
 		// sort directories first
 		$sortedShares = toArray($filteredShares);
-		usort($sortedShares, function ($a, $b) {
+		usort($sortedShares, function (array $a, array $b): int {
+			/** @var array{is_directory: bool, path: string} $a */
+			/** @var array{is_directory: bool, path: string} $b */
 			if ($a['is_directory'] && $b['is_directory']) {
 				return strcmp($a['path'], $b['path']);
 			}
-			return $b['is_directory'] - $a['is_directory'];
+			return (int)$b['is_directory'] - (int)$a['is_directory'];
 		});
 
 		return new DataResponse($sortedShares);

lib/Listener/LoadSidebarScript.php

@@ -34,7 +34,7 @@
 /**
  * @template-implements IEventListener<LoadSidebar>
  */
-class LoadSidebarScript implements IEventListener {
+final class LoadSidebarScript implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadSidebar)) {
 			return;

lib/Service/ReportSender.php

@@ -32,10 +32,12 @@
 use Psr\Log\LoggerInterface;
 use Swaggest\JsonDiff\JsonDiff;
 
-class ReportSender {
+final class ReportSender {
 	protected const REPORT_NAME = ' - Shares report.';
 
+	/** @var array{url: string, fileName: string}|null */
 	protected ?array $diffReport = null;
+	/** @var array<string, array{url: string, data: string}> */
 	protected array $reports = [];
 
 	public function __construct(
@@ -75,12 +77,10 @@ public function createReport(
 
 		$formats = ['json', 'csv'];
 		$formatedDateTime = $dateTime->format('YmdHi');
-		foreach ($formats as $key => $format) {
+		$shares = iterator_to_array($this->sharesList->getFormattedShares($userId, $filter, $path, $token));
+		foreach ($formats as $format) {
 			$fileName = $formatedDateTime . self::REPORT_NAME . $format;
 			if (!array_key_exists($fileName, $this->reports)) {
-				if ($key === array_key_first($formats)) {
-					$shares = iterator_to_array($this->sharesList->getFormattedShares($userId, $filter, $path, $token));
-				}
 				$reportFile = $folder->newFile($fileName);
 				$data = $this->sharesList->getSerializedShares($shares, $format);
 				$reportFile->putContent($data);
@@ -96,7 +96,7 @@ public function createReport(
 	}
 
 	public function sendReport(string $recipient, \DateTimeImmutable $dateTime): void {
-		$defaultLanguage = $this->config->getSystemValue('default_language', 'en');
+		$defaultLanguage = $this->config->getSystemValueString('default_language', 'en');
 		$userLanguages = $this->config->getUserValue($recipient, 'core', 'lang');
 		$language = (!empty($userLanguages)) ? $userLanguages : $defaultLanguage;
 
@@ -215,14 +215,16 @@ public function diff(
 		$previousFile = $search[0];
 		$previousFilename = $previousFile->getName();
 		$previousDateTime = substr($previousFilename, 0, 12);
-		$previousContent = json_decode($previousFile->getContent());
+		/** @var list<object{id: string}> $previousContent */
+		$previousContent = json_decode($previousFile->getContent(), flags: JSON_THROW_ON_ERROR);
 		$previousContentWithId = [];
 		foreach ($previousContent as $value) {
 			$previousContentWithId[$value->id] = $value;
 		}
 
 		$newFilename = array_keys($this->reports)[0];
 		$newDateTime = substr($newFilename, 0, 12);
+		/** @var list<object{id: string}> $newContent */
 		$newContent = json_decode(array_values($this->reports)[0]['data']);
 		$newContentWithId = [];
 		foreach ($newContent as $value) {
@@ -243,7 +245,7 @@ public function diff(
 			'modified' => $jsonDiff->getModifiedDiff()
 		];
 
-		$reportFile->putContent(json_encode($res, JSON_PRETTY_PRINT));
+		$reportFile->putContent(json_encode($res, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR));
 
 		$this->diffReport = [
 			'url' => $this->url->linkToRouteAbsolute(

lib/Service/SharesList.php

@@ -1,29 +1,12 @@
 <?php
 
 declare(strict_types=1);
-/**
- * @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @author Florent Poinsaut <florent@solution-libre.fr>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author John Molakvoæ <skjnldsv@protonmail.com>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * 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
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
+
+// SPDX-FileCopyrightText: 2018 Nextcloud GmbH
+// SPDX-FileCopyrightText: 2022 Solution Libre SAS
+// SPDX-FileContributor: Roeland Jago Douma <roeland@famdouma.nl>
+// SPDX-FileContributor: Florent Poinsaut <florent@solution-libre.fr>
+// SPDX-FileContributor: John Molakvoæ <skjnldsv@protonmail.com>
 
 namespace OCA\ShareListing\Service;
 
@@ -33,7 +16,6 @@
 use OCP\Files\Folder;
 use OCP\Files\IRootFolder;
 use OCP\Files\NotFoundException;
-use OCP\IUserManager;
 use OCP\Share;
 use OCP\Share\IManager as ShareManager;
 use OCP\Share\IShare;
@@ -44,7 +26,7 @@
 use function iter\filter;
 use function iter\map;
 
-class SharesList {
+final class SharesList {
 
 	public const FILTER_NONE = 0;
 	public const FILTER_OWNER = 1;
@@ -56,11 +38,13 @@ class SharesList {
 
 	public function __construct(
 		private ShareManager $shareManager,
-		private IUserManager $userManager,
 		private IRootFolder $rootFolder,
 	) {
 	}
 
+	/**
+	 * @return non-empty-array<IShare::TYPE_*>
+	 */
 	private function getShareTypes(): array {
 		return [
 			IShare::TYPE_USER,
@@ -71,11 +55,18 @@ private function getShareTypes(): array {
 		];
 	}
 
+	/**
+	 * @return Iterator<IShare>
+	 */
 	public function get(?string $userId, int $filter, ?string $path = null, ?string $token = null): Iterator {
+		/** @var iterable<IShare> $shares */
 		$shares = $this->getShares($userId);
 
 		// If path is set. Filter for the current user
 		if ($path !== null) {
+			if ($userId === null) {
+				throw new \RuntimeException('Unable to query a path if no user is set.');
+			}
 			$userFolder = $this->rootFolder->getUserFolder($userId);
 			try {
 				$node = $userFolder->get($path);
@@ -137,8 +128,10 @@ public function get(?string $userId, int $filter, ?string $path = null, ?string
 	 * Get all shares. And filter them by being a subpath of the current path.
 	 * This allows us to build a list of subfiles/folder that are shared
 	 * as well
+	 * @return Iterator<IShare>
 	 */
 	public function getSub(string $userId, int $filter, string $path): Iterator {
+		/** @var iterable<IShare> $shares */
 		$shares = $this->shareManager->getAllShares();
 
 		// If path is set. Filter for the current user
@@ -150,7 +143,7 @@ public function getSub(string $userId, int $filter, string $path): Iterator {
 			return new EmptyIterator();
 		}
 
-		$shares = filter(function (IShare $share) use ($node) {
+		$shares = filter(function (IShare $share) use ($node): bool {
 			if ($node->getId() === $share->getNodeId()) {
 				return false;
 			}
@@ -161,30 +154,26 @@ public function getSub(string $userId, int $filter, string $path): Iterator {
 		}, $shares);
 
 		if ($filter === self::FILTER_OWNER) {
-			$shares = filter(fn (IShare $share) => $share->getShareOwner() === $userId, $shares);
+			$shares = filter(fn (IShare $share): bool => $share->getShareOwner() === $userId, $shares);
 		}
 		if ($filter === self::FILTER_INITIATOR) {
-			$shares = filter(fn (IShare $share) => $share->getSharedBy() === $userId, $shares);
+			$shares = filter(fn (IShare $share): bool => $share->getSharedBy() === $userId, $shares);
 		}
 		if ($filter === self::FILTER_RECIPIENT) {
 			// We can't check the recipient since this might be a group share etc. However you can't share to yourself
-			$shares = filter(fn (IShare $share) => $share->getShareOwner() !== $userId && $share->getSharedBy() !== $userId, $shares);
+			$shares = filter(fn (IShare $share): bool => $share->getShareOwner() !== $userId && $share->getSharedBy() !== $userId, $shares);
 		}
 
-		$shares = filter(function (IShare $share) {
+		return filter(function (IShare $share): bool {
 			try {
 				$userFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-			} catch (NoUserException) {
-				return false;
 			} catch (Throwable) {
 				return false;
 			}
 			$nodes = $userFolder->getById($share->getNodeId());
 
 			return $nodes !== [];
 		}, $shares);
-
-		return $shares;
 	}
 
 	public function getFormattedShares(?string $userId = null, int $filter = self::FILTER_NONE, ?string $path = null, ?string $token = null): Iterator {
@@ -196,7 +185,8 @@ public function getFormattedShares(?string $userId = null, int $filter = self::F
 	}
 
 	private function getShares(?string $userId): Iterator {
-		if (empty($userId)) {
+		if ($userId === null) {
+			/** @var iterable<IShare> $shares */
 			$shares = $this->shareManager->getAllShares();
 		} else {
 			$shareTypes = $this->getShareTypes();
@@ -232,12 +222,12 @@ public function formatShare(IShare $share): array {
 		];
 
 		$nodes = $userFolder->getById($share->getNodeId());
-		$node = array_shift($nodes);
-		$data['path'] = $userFolder->getRelativePath($node->getPath());
-		$data['name'] = $node->getName();
-		$data['is_directory'] = $node->getType() === 'dir';
-
-
+		if (!empty($nodes)) {
+			$node = array_shift($nodes);
+			$data['path'] = $userFolder->getRelativePath($node->getPath());
+			$data['name'] = $node->getName();
+			$data['is_directory'] = $node->getType() === 'dir';
+		}
 
 		if ($share->getShareType() === IShare::TYPE_USER) {
 			$data['type'] = 'user';
@@ -261,24 +251,23 @@ public function formatShare(IShare $share): array {
 			$data['recipient'] = $share->getSharedWith();
 		}
 
-		if ($share->getExpirationDate() !== null) {
-			$data['expiration'] = $share->getExpirationDate()->format('Y-m-d H:i:s');
+		$expirationDate = $share->getExpirationDate();
+		if ($expirationDate !== null) {
+			$data['expiration'] = $expirationDate->format('Y-m-d H:i:s');
 		}
 
 		return $data;
 	}
 
 	public function filterStringToInt(?string $filterString): int {
-		$filter = match ($filterString) {
+		return match ($filterString) {
 			'owner' => SharesList::FILTER_OWNER,
 			'initiator' => SharesList::FILTER_INITIATOR,
 			'recipient' => SharesList::FILTER_RECIPIENT,
 			'has-expiration' => SharesList::FILTER_HAS_EXPIRATION,
 			'no-expiration' => SharesList::FILTER_NO_EXPIRATION,
 			default => SharesList::FILTER_NONE,
 		};
-
-		return $filter;
 	}
 
 	public function getSerializedShares(array $shares, ?string $format = 'json'): string {

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-		errorLevel="4"
+		errorLevel="1"
 		resolveFromConfigFile="true"
 		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 		xmlns="https://getpsalm.org/schema/config"