Merge pull request #1004 from nextcloud/psalm

ci(psalm): Add psalm CI

.github/workflows/psalm-matrix.yml

@@ -0,0 +1,73 @@
+# This workflow is provided via the organization template repository
+#
+# https://github.com/nextcloud/.github
+# https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization
+#
+# SPDX-FileCopyrightText: 2022-2024 Nextcloud GmbH and Nextcloud contributors
+# SPDX-License-Identifier: MIT
+
+name: Static analysis
+
+on: pull_request
+
+concurrency:
+  group: psalm-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  matrix:
+    runs-on: ubuntu-latest-low
+    outputs:
+      ocp-matrix: ${{ steps.versions.outputs.ocp-matrix }}
+    steps:
+      - name: Checkout app
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Get version matrix
+        id: versions
+        uses: icewind1991/nextcloud-version-matrix@58becf3b4bb6dc6cef677b15e2fd8e7d48c0908f # v1.3.1
+
+  static-analysis:
+    runs-on: ubuntu-latest
+    needs: matrix
+    strategy:
+      # do not stop on another job's failure
+      fail-fast: false
+      matrix: ${{ fromJson(needs.matrix.outputs.ocp-matrix) }}
+
+    name: static-psalm-analysis ${{ matrix.ocp-version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - name: Set up php${{ matrix.php-versions }}
+        uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231 # v2.31.1
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: bz2, ctype, curl, dom, fileinfo, gd, iconv, intl, json, libxml, mbstring, openssl, pcntl, posix, session, simplexml, xmlreader, xmlwriter, zip, zlib, sqlite, pdo_sqlite
+          coverage: none
+          ini-file: development
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: |
+          composer bin psalm remove nextcloud/ocp --dev
+          composer i
+
+      - name: Overwrite nextcloud/OCP version
+        run: composer bin psalm require --dev 'nextcloud/ocp:${{ matrix.ocp-version }}' --ignore-platform-reqs --with-dependencies
+
+      - name: Run coding standards check
+        run: composer run psalm -- --threads=1 --monochrome --no-progress --output-format=github
+
+  summary:
+    runs-on: ubuntu-latest-low
+    needs: static-analysis
+
+    if: always()
+
+    name: static-psalm-analysis-summary
+
+    steps:
+      - name: Summary status
+        run: if ${{ needs.static-analysis.result != 'success' }}; then exit 1; fi

.gitignore

@@ -23,3 +23,6 @@ translationfiles
 
 # Testing
 /tests/.phpunit.result.cache
+
+# Development
+/vendor-bin/*/vendor

appinfo/info.xml

@@ -11,7 +11,7 @@
 	<description><![CDATA[Requires users to accept the terms of service before accessing data.
 This product includes GeoLite2 data created by MaxMind, available from [maxmind.com](http://www.maxmind.com)]]></description>
 
-	<version>3.1.0</version>
+	<version>4.0.0</version>
 	<licence>agpl</licence>
 	<author>Joas Schilling</author>
 
@@ -33,7 +33,7 @@ This product includes GeoLite2 data created by MaxMind, available from [maxmind.
 	<screenshot>https://github.com/nextcloud/terms_of_service/raw/master/docs/notification-and-settings.png</screenshot>
 
 	<dependencies>
-		<nextcloud min-version="27" max-version="31" />
+		<nextcloud min-version="28" max-version="30" />
 	</dependencies>
 
 	<repair-steps>

composer.json

@@ -1,9 +1,17 @@
 {
+	"autoload": {
+		"psr-4": {
+			"OCA\\TermsOfService\\": "lib/"
+		}
+	},
 	"config": {
-		"classmap-authoritative": true,
+		"allow-plugins": {
+			"bamarni/composer-bin-plugin": true
+		},
+		"autoloader-suffix": "TermsOfService",
 		"optimize-autoloader": true,
 		"platform": {
-			"php": "8.0"
+			"php": "8.0.2"
 		},
 		"sort-packages": true
 	},
@@ -12,11 +20,22 @@
 		"geoip2/geoip2": "~2.0"
 	},
 	"require-dev": {
+		"bamarni/composer-bin-plugin": "^1.8",
 		"phpunit/phpunit": "^9.5",
 		"roave/security-advisories": "dev-latest"
 	},
 	"scripts": {
+		"bin": "echo 'bin not installed'",
 		"lint": "find . -name \\*.php -not -path './vendor/*' -print0 | xargs -0 -n1 php -l",
+		"post-install-cmd": [
+			"@composer bin all install --ansi",
+			"composer dump-autoload"
+		],
+		"post-update-cmd": [
+			"@composer bin all update --ansi",
+			"composer dump-autoload"
+		],
+		"psalm": "psalm --no-cache --threads=$(nproc)",
 		"test:unit": "vendor/bin/phpunit --color -c tests/phpunit.xml"
 	}
 }

lib/AppInfo/Application.php

@@ -76,6 +76,7 @@ public function boot(IBootContext $context): void {
 	}
 
 	public function registerFrontend(IRequest $request, IConfig $config, IUserSession $userSession): void {
+		/** @psalm-suppress UndefinedClass */
 		if (!\OC::$CLI) {
 			if ($userSession->getUser() instanceof IUser
 				&& strpos($request->getPathInfo(), '/s/') !== 0
@@ -96,12 +97,13 @@ public function addStorageWrapper(): void {
 
 	/**
 	 * @param string $mountPoint
-	 * @param IStorage|Wrapper $storage
+	 * @param IStorage $storage
 	 *
 	 * @return StorageWrapper|IStorage
 	 * @throws Exception
 	 */
 	public function addStorageWrapperCallback(string $mountPoint, IStorage $storage): IStorage {
+		/** @psalm-suppress UndefinedClass */
 		if (!\OC::$CLI) {
 			try {
 				return new StorageWrapper(

lib/Checker.php

@@ -192,7 +192,7 @@ private function matchCidr(string $ip, string $range): bool {
 			$subnet = inet_pton($subnet);
 			$ip = inet_pton($ip);
 
-			$binMask = str_repeat("f", $bits / 4);
+			$binMask = str_repeat("f", (int)($bits / 4));
 			switch ($bits % 4) {
 				case 0:
 					break;

lib/Db/Mapper/SignatoryMapper.php

@@ -14,6 +14,7 @@
 
 /**
  * @method Signatory mapRowToEntity(array $row)
+ * @template-extends QBMapper<Signatory>
  */
 class SignatoryMapper extends QBMapper {
 	const TABLENAME = 'termsofservice_sigs';

lib/Db/Mapper/TermsMapper.php

@@ -14,6 +14,7 @@
 
 /**
  * @method Terms mapRowToEntity(array $row)
+ * @template-extends QBMapper<Terms>
  */
 class TermsMapper extends QBMapper {
 	const TABLENAME = 'termsofservice_terms';

lib/Filesystem/CacheWrapper.php

@@ -8,13 +8,12 @@
 use OC\Files\Cache\Wrapper\CacheWrapper as Wrapper;
 use OCP\Constants;
 use OCP\Files\Cache\ICache;
-use OCP\Files\ForbiddenException;
 use OCP\Files\Storage\IStorage;
 
-class CacheWrapper extends Wrapper  {
+class CacheWrapper extends Wrapper {
 	/** @var Helper */
 	private $helper;
-	/** @var StorageWrapper*/
+	/** @var StorageWrapper */
 	protected $storage;
 	/** @var int */
 	protected $mask;

lib/Listener/RegistrationIntegration.php

@@ -22,6 +22,9 @@
 use OCP\IUser;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<ShowFormEvent|ValidateFormEvent|PassedFormEvent>
+ */
 class RegistrationIntegration implements IEventListener {
 
 	/** @var SignatoryMapper */

lib/Listener/UserDeletedListener.php

@@ -13,6 +13,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\User\Events\UserDeletedEvent;
 
+/**
+ * @template-implements IEventListener<UserDeletedEvent>
+ */
 class UserDeletedListener implements IEventListener {
 
 	/** @var SignatoryMapper */

lib/Migration/Version1000Date20220111180247.php

@@ -27,7 +27,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 
 		$table = $schema->getTable('termsofservice_sigs');
 		$column = $table->getColumn('user_id');
-		if (!$column->getLength() !== 64) {
+		if ($column->getLength() !== 64) {
 			$column->setLength(64);
 			return $schema;
 		}