chore: apply strict rector rules on appstore

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Author: susnux

apps/appstore/lib/AppInfo/Application.php

@@ -13,20 +13,19 @@
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
 
-class Application extends App implements IBootstrap {
+final class Application extends App implements IBootstrap {
 	public const APP_ID = 'appstore';
 
-	/**
-	 * @param array $urlParams
-	 */
 	public function __construct(array $urlParams = []) {
 		parent::__construct(self::APP_ID, $urlParams);
 	}
 
+	#[\Override()]
 	public function register(IRegistrationContext $context): void {
 		$context->registerSearchProvider(AppSearch::class);
 	}
 
+	#[\Override()]
 	public function boot(IBootContext $context): void {
 	}
 }

apps/appstore/lib/Controller/ApiController.php

@@ -43,17 +43,17 @@ class ApiController extends OCSController {
 
 	public function __construct(
 		IRequest $request,
-		private IConfig $config,
-		private IAppConfig $appConfig,
-		private AppManager $appManager,
-		private DependencyAnalyzer $dependencyAnalyzer,
-		private CategoryFetcher $categoryFetcher,
-		private AppFetcher $appFetcher,
-		private IFactory $l10nFactory,
-		private BundleFetcher $bundleFetcher,
-		private Installer $installer,
-		private IRegistry $subscriptionRegistry,
-		private LoggerInterface $logger,
+		private readonly IConfig $config,
+		private readonly IAppConfig $appConfig,
+		private readonly AppManager $appManager,
+		private readonly DependencyAnalyzer $dependencyAnalyzer,
+		private readonly CategoryFetcher $categoryFetcher,
+		private readonly AppFetcher $appFetcher,
+		private readonly IFactory $l10nFactory,
+		private readonly BundleFetcher $bundleFetcher,
+		private readonly Installer $installer,
+		private readonly IRegistry $subscriptionRegistry,
+		private readonly LoggerInterface $logger,
 	) {
 		parent::__construct(Application::APP_ID, $request);
 	}
@@ -70,33 +70,34 @@ public function listCategories(): DataResponse {
 		$currentLanguage = substr($this->l10nFactory->findLanguage(), 0, 2);
 
 		$categories = $this->categoryFetcher->get();
-		$categories = array_map(fn ($category) => [
+		$categories = array_map(fn (array $category): array => [
 			'id' => $category['id'],
 			'displayName' => $category['translations'][$currentLanguage]['name'] ?? $category['translations']['en']['name'],
 		], $categories);
 
-		return new DataResponse(array_values($categories));
+		return new DataResponse($categories);
 	}
 
 	/**
 	 * Get all available apps
 	 *
-	 * @return DataResponse<Http::STATUS_OK, list<array{id: string, name: string, description: string, ...}>, array{}>
+	 * @return DataResponse<Http::STATUS_OK, list<array{id: string, name: string, groups: list<string>, internal: bool, isCompatible: bool, missingDependencies?: list<string>, missingMaxNextcloudVersion: bool, missingMinNextcloudVersion: bool, ...<array-key, mixed>}>, array{}>
 	 *
 	 * 200: The apps were found successfully
 	 */
 	#[ApiRoute(verb: 'GET', url: '/api/v1/apps')]
 	public function listApps(): DataResponse {
 		$apps = $this->getAllApps();
 
+		/** @var array<string>|mixed $ignoreMaxApps */
 		$ignoreMaxApps = $this->config->getSystemValue('app_install_overwrite', []);
 		if (!is_array($ignoreMaxApps)) {
 			$this->logger->warning('The value given for app_install_overwrite is not an array. Ignoring...');
 			$ignoreMaxApps = [];
 		}
 
 		// Extend existing app details
-		$apps = array_map(function (array $appData) use ($ignoreMaxApps) {
+		$apps = array_map(function (array $appData) use ($ignoreMaxApps): array {
 			if (isset($appData['appstoreData'])) {
 				$appstoreData = $appData['appstoreData'];
 				$appData['screenshot'] = $this->createProxyPreviewUrl($appstoreData['screenshots'][0]['url'] ?? '');
@@ -105,7 +106,7 @@ public function listApps(): DataResponse {
 			}
 
 			$newVersion = $this->installer->isUpdateAvailable($appData['id']);
-			if ($newVersion) {
+			if ($newVersion !== false) {
 				$appData['update'] = $newVersion;
 			}
 
@@ -119,6 +120,7 @@ public function listApps(): DataResponse {
 					$groups = [$groups];
 				}
 			}
+
 			$appData['groups'] = $groups;
 			$appData['canUninstall'] = !$appData['active'] && $appData['removable'];
 
@@ -132,6 +134,7 @@ public function listApps(): DataResponse {
 			$appData['missingMaxNextcloudVersion'] = !isset($appData['dependencies']['nextcloud']['@attributes']['max-version']);
 			$appData['isCompatible'] = $this->dependencyAnalyzer->isMarkedCompatible($appData);
 
+			/** @var array{id: string, name: string, groups: list<string>, internal: bool, isCompatible: bool, missingDependencies?: list<string>, missingMaxNextcloudVersion: bool, missingMinNextcloudVersion: bool, ...<array-key, mixed>} $appData */
 			return $appData;
 		}, $apps);
 
@@ -166,16 +169,17 @@ public function enableApp(string $appId, array $groups = []): DataResponse {
 
 			$this->installer->installApp($appId);
 
-			if (count($groups) > 0) {
+			if ($groups !== []) {
 				$this->appManager->enableAppForGroups($appId, $this->getGroupList($groups));
 			} else {
 				$this->appManager->enableApp($appId);
 			}
+
 			$updateRequired = $this->appManager->isUpgradeRequired($appId);
 			return new DataResponse(['update_required' => $updateRequired]);
-		} catch (\Throwable $e) {
-			$this->logger->error('could not enable app', ['exception' => $e]);
-			throw new OCSException('could not enable app', Http::STATUS_INTERNAL_SERVER_ERROR, $e);
+		} catch (\Throwable $throwable) {
+			$this->logger->error('could not enable app', ['exception' => $throwable]);
+			throw new OCSException('could not enable app', Http::STATUS_INTERNAL_SERVER_ERROR, $throwable);
 		}
 	}
 
@@ -196,9 +200,9 @@ public function disableApp(string $appId): DataResponse {
 			$appId = $this->appManager->cleanAppId($appId);
 			$this->appManager->disableApp($appId);
 			return new DataResponse([]);
-		} catch (\Exception $e) {
-			$this->logger->error('could not disable app', ['exception' => $e]);
-			throw new OCSException('could not disable app', Http::STATUS_INTERNAL_SERVER_ERROR, $e);
+		} catch (\Exception $exception) {
+			$this->logger->error('could not disable app', ['exception' => $exception]);
+			throw new OCSException('could not disable app', Http::STATUS_INTERNAL_SERVER_ERROR, $exception);
 		}
 	}
 
@@ -223,6 +227,7 @@ public function uninstallApp(string $appId): DataResponse {
 			$this->appManager->clearAppsCache();
 			return new DataResponse([]);
 		}
+
 		throw new OCSException('could not remove app', Http::STATUS_INTERNAL_SERVER_ERROR);
 	}
 
@@ -247,13 +252,14 @@ public function updateApp(string $appId): DataResponse {
 			if ($result === false) {
 				throw new \Exception('Update failed');
 			}
-		} catch (\Exception $ex) {
+		} catch (\Exception $exception) {
 			$this->config->setSystemValue('maintenance', false);
-			throw new OCSException('could not update app', Http::STATUS_INTERNAL_SERVER_ERROR, $ex);
+			throw new OCSException('could not update app', Http::STATUS_INTERNAL_SERVER_ERROR, $exception);
 		}
 
 		return new DataResponse([]);
 	}
+
 	/**
 	 * Force enable an app.
 	 * This will override the nextcloud version requirement for an app
@@ -278,10 +284,11 @@ private function createProxyPreviewUrl(string $url): string {
 		if ($url === '') {
 			return '';
 		}
+
 		return 'https://usercontent.apps.nextcloud.com/' . base64_encode($url);
 	}
 
-	private function fetchApps() {
+	private function fetchApps(): void {
 		$appClass = new \OC_App();
 		$apps = $appClass->listAllApps();
 		foreach ($apps as $app) {
@@ -296,6 +303,7 @@ private function fetchApps() {
 
 				$app['screenshot'] = $this->createProxyPreviewUrl($appScreenshot);
 			}
+
 			$this->allApps[$app['id']] = $app;
 		}
 
@@ -332,17 +340,16 @@ private function getAllApps() {
 		if (empty($this->allApps)) {
 			$this->fetchApps();
 		}
+
 		return $this->allApps;
 	}
 
 	/**
 	 * Get all apps for a category from the app store
 	 *
-	 * @param string $requestedCategory
-	 * @return array
 	 * @throws \Exception
 	 */
-	private function getAppsForCategory($requestedCategory = ''): array {
+	private function getAppsForCategory(string $requestedCategory = ''): array {
 		$versionParser = new VersionParser();
 		$formattedApps = [];
 		$apps = $this->appFetcher->get();
@@ -355,6 +362,7 @@ private function getAppsForCategory($requestedCategory = ''): array {
 						$isInCategory = true;
 					}
 				}
+
 				if (!$isInCategory) {
 					continue;
 				}
@@ -363,14 +371,17 @@ private function getAppsForCategory($requestedCategory = ''): array {
 			if (!isset($app['releases'][0]['rawPlatformVersionSpec'])) {
 				continue;
 			}
+
 			$nextcloudVersion = $versionParser->getVersion($app['releases'][0]['rawPlatformVersionSpec']);
 			$nextcloudVersionDependencies = [];
 			if ($nextcloudVersion->getMinimumVersion() !== '') {
 				$nextcloudVersionDependencies['nextcloud']['@attributes']['min-version'] = $nextcloudVersion->getMinimumVersion();
 			}
+
 			if ($nextcloudVersion->getMaximumVersion() !== '') {
 				$nextcloudVersionDependencies['nextcloud']['@attributes']['max-version'] = $nextcloudVersion->getMaximumVersion();
 			}
+
 			$phpVersion = $versionParser->getVersion($app['releases'][0]['rawPhpVersionSpec']);
 
 			try {
@@ -384,12 +395,15 @@ private function getAppsForCategory($requestedCategory = ''): array {
 			if ($phpVersion->getMinimumVersion() !== '') {
 				$phpDependencies['php']['@attributes']['min-version'] = $phpVersion->getMinimumVersion();
 			}
+
 			if ($phpVersion->getMaximumVersion() !== '') {
 				$phpDependencies['php']['@attributes']['max-version'] = $phpVersion->getMaximumVersion();
 			}
+
 			if (isset($app['releases'][0]['minIntSize'])) {
 				$phpDependencies['php']['@attributes']['min-int-size'] = $app['releases'][0]['minIntSize'];
 			}
+
 			$authors = '';
 			foreach ($app['authors'] as $key => $author) {
 				$authors .= $author['name'];
@@ -454,24 +468,28 @@ private function getAppsForCategory($requestedCategory = ''): array {
 		return $formattedApps;
 	}
 
-	private function getGroupList(array $groups) {
+	/**
+	 * @param string[] $groups - The group ids to fetch
+	 * @return list<IGroup> - The list of groups matching the given group ids
+	 */
+	private function getGroupList(array $groups): array {
 		$groupManager = Server::get(IGroupManager::class);
 		$groupsList = [];
 		foreach ($groups as $group) {
 			$groupItem = $groupManager->get($group);
 			if ($groupItem instanceof IGroup) {
-				$groupsList[] = $groupManager->get($group);
+				$groupsList[] = $groupItem;
 			}
 		}
+
 		return $groupsList;
 	}
 
-	private function sortApps($a, $b) {
-		$a = (string)$a['name'];
-		$b = (string)$b['name'];
-		if ($a === $b) {
-			return 0;
-		}
-		return ($a < $b) ? -1 : 1;
+	/**
+	 * @param array{name: string, ...} $a
+	 * @param array{name: string, ...} $b
+	 */
+	private function sortApps(array $a, array $b): int {
+		return $a['name'] <=> $b['name'];
 	}
 }

apps/appstore/lib/Controller/DiscoverController.php

@@ -32,16 +32,16 @@
 use Psr\Log\LoggerInterface;
 
 #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)]
-class DiscoverController extends Controller {
+final class DiscoverController extends Controller {
 
-	private IAppData $appData;
+	private readonly IAppData $appData;
 
 	public function __construct(
 		IRequest $request,
 		IAppDataFactory $appDataFactory,
-		private IClientService $clientService,
-		private AppDiscoverFetcher $discoverFetcher,
-		private LoggerInterface $logger,
+		private readonly IClientService $clientService,
+		private readonly AppDiscoverFetcher $discoverFetcher,
+		private readonly LoggerInterface $logger,
 	) {
 		parent::__construct(Application::APP_ID, $request);
 		$this->appData = $appDataFactory->get(Application::APP_ID);
@@ -69,28 +69,25 @@ public function getAppDiscoverMedia(string $fileName, ILimiter $limiter, IUserSe
 		$getEtag = $this->discoverFetcher->getETag() ?? date('Y-m');
 		$etag = trim($getEtag, '"');
 
-		$folder = null;
 		try {
 			$folder = $this->appData->getFolder('app-discover-cache');
 			$this->cleanUpImageCache($folder, $etag);
-		} catch (\Throwable $e) {
+		} catch (\Throwable) {
 			$folder = $this->appData->newFolder('app-discover-cache');
 		}
 
 		// Get the current cache folder
 		try {
 			$folder = $folder->getFolder($etag);
-		} catch (NotFoundException $e) {
+		} catch (NotFoundException) {
 			$folder = $folder->newFolder($etag);
 		}
 
 		$info = pathinfo($fileName);
 		$hashName = md5($fileName);
 		$allFiles = $folder->getDirectoryListing();
 		// Try to find the file
-		$file = array_filter($allFiles, function (ISimpleFile $file) use ($hashName) {
-			return str_starts_with($file->getName(), $hashName);
-		});
+		$file = array_filter($allFiles, fn (ISimpleFile $file): bool => str_starts_with($file->getName(), $hashName));
 		// Get the first entry
 		$file = reset($file);
 		// If not found request from Web
@@ -150,15 +147,11 @@ private function checkCanDownloadMedia(string $filename): bool {
 		// Hosts that need further verification
 		// Github is only allowed if from our organization
 		$ALLOWED_HOSTS = ['github.com', 'raw.githubusercontent.com'];
-		if (!in_array($urlInfo['host'], $ALLOWED_HOSTS)) {
+		if (!in_array($urlInfo['host'], $ALLOWED_HOSTS, true)) {
 			return false;
 		}
 
-		if (str_starts_with($urlInfo['path'], '/nextcloud/') || str_starts_with($urlInfo['path'], '/nextcloud-gmbh/')) {
-			return true;
-		}
-
-		return false;
+		return str_starts_with($urlInfo['path'], '/nextcloud/') || str_starts_with($urlInfo['path'], '/nextcloud-gmbh/');
 	}
 
 	/**
@@ -174,7 +167,7 @@ private function cleanUpImageCache(ISimpleFolder $folder, string $etag): void {
 				if ($dir->getName() !== $etag) {
 					$dir->delete();
 				}
-			} catch (NotPermittedException $e) {
+			} catch (NotPermittedException) {
 				// ignore folder for now
 			}
 		}