PHPStan prepare exceptions (#6037)

Take advantage of https://phpstan.org/blog/bring-your-exceptions-under-control Minimum changes to pass `tooWideThrowType` and `implicitThrows`. Revert some mistakes from: #5504 Preparation needed before new PRs of the same type: #5962 Fix several wrong PHPDocs and catches: > Method ... has ...Exception in PHPDoc @throws tag but it's not thrown. > Dead catch - ...Exception is never thrown in the try block.
FreshRSS · Jan 15, 2024 · 314077a · 314077a
1 parent 52f6c83
commit 314077a
Show file tree

Hide file tree

Showing 41 changed files with 204 additions and 164 deletions.
diff --git a/app/Controllers/authController.php b/app/Controllers/authController.php
@@ -65,7 +65,6 @@ public function indexAction(): void {
 	 *
 	 * It forwards to the correct login page (form) or main page if
 	 * the user is already connected.
-	 * @throws Minz_ConfigurationParamException
 	 */
 	public function loginAction(): void {
 		if (FreshRSS_Auth::hasAccess() && Minz_Request::paramString('u') === '') {

diff --git a/app/Controllers/feedController.php b/app/Controllers/feedController.php
@@ -30,8 +30,9 @@ public function firstAction(): void {
 	/**
 	 * @param array<string,mixed> $attributes
 	 * @throws FreshRSS_AlreadySubscribed_Exception
-	 * @throws FreshRSS_FeedNotAdded_Exception
+	 * @throws FreshRSS_BadUrl_Exception
 	 * @throws FreshRSS_Feed_Exception
+	 * @throws FreshRSS_FeedNotAdded_Exception
 	 * @throws Minz_FileNotExistException
 	 */
 	public static function addFeed(string $url, string $title = '', int $cat_id = 0, string $new_cat_name = '',
@@ -874,7 +875,6 @@ public function actualizeAction(): int {
 
 	/**
 	 * @throws Minz_ConfigurationNamespaceException
-	 * @throws JsonException
 	 * @throws Minz_PDOConnectionException
 	 */
 	public static function renameFeed(int $feed_id, string $feed_name): bool {

diff --git a/app/Controllers/indexController.php b/app/Controllers/indexController.php
@@ -241,6 +241,7 @@ public function opmlAction(): void {
 	/**
 	 * This method returns a list of entries based on the Context object.
 	 * @return Traversable<FreshRSS_Entry>
+	 * @throws FreshRSS_EntriesGetter_Exception
 	 */
 	public static function listEntriesByContext(): Traversable {
 		$entryDAO = FreshRSS_Factory::createEntryDao();

diff --git a/app/Controllers/tagController.php b/app/Controllers/tagController.php
@@ -160,7 +160,7 @@ public function addAction(): void {
 
 	/**
 	 * @throws Minz_ConfigurationNamespaceException
-	 * @throws Minz_PDOConnectionException|JsonException
+	 * @throws Minz_PDOConnectionException
 	 */
 	public function renameAction(): void {
 		if (!FreshRSS_Auth::hasAccess()) {

diff --git a/app/Controllers/updateController.php b/app/Controllers/updateController.php
@@ -11,18 +11,19 @@ public static function isGit(): bool {
 
 	/**
 	 * Automatic change to the new name of edge branch since FreshRSS 1.18.0.
+	 * @throws Minz_Exception
 	 */
 	public static function migrateToGitEdge(): bool {
 		$errorMessage = 'Error during git checkout to edge branch. Please change branch manually!';
 
 		if (!is_writable(FRESHRSS_PATH . '/.git/config')) {
-			throw new Exception($errorMessage);
+			throw new Minz_Exception($errorMessage);
 		}
 
 		//Note `git branch --show-current` requires git 2.22+
 		exec('git symbolic-ref --short HEAD', $output, $return);
 		if ($return != 0) {
-			throw new Exception($errorMessage);
+			throw new Minz_Exception($errorMessage);
 		}
 		$line = implode('', $output);
 		if ($line !== 'master' && $line !== 'dev') {
@@ -33,13 +34,13 @@ public static function migrateToGitEdge(): bool {
 		unset($output);
 		exec('git checkout edge --guess -f', $output, $return);
 		if ($return != 0) {
-			throw new Exception($errorMessage);
+			throw new Minz_Exception($errorMessage);
 		}
 
 		unset($output);
 		exec('git reset --hard FETCH_HEAD', $output, $return);
 		if ($return != 0) {
-			throw new Exception($errorMessage);
+			throw new Minz_Exception($errorMessage);
 		}
 
 		return true;
@@ -64,6 +65,7 @@ public static function hasGitUpdate(): bool {
 		chdir(FRESHRSS_PATH);
 		$output = [];
 		try {
+			/** @throws ValueError */
 			exec('git fetch --prune', $output, $return);
 			if ($return == 0) {
 				$output = [];
@@ -72,7 +74,7 @@ public static function hasGitUpdate(): bool {
 				$line = implode('; ', $output);
 				Minz_Log::warning('git fetch warning: ' . $line);
 			}
-		} catch (Exception $e) {
+		} catch (Throwable $e) {
 			Minz_Log::warning('git fetch error: ' . $e->getMessage());
 		}
 		chdir($cwd);
@@ -101,11 +103,9 @@ public static function gitPull() {
 
 			$output = [];
 			self::migrateToGitEdge();
-		} catch (Exception $e) {
+		} catch (Throwable $e) {
 			Minz_Log::warning('Git error: ' . $e->getMessage());
-			if (empty($output)) {
-				$output = $e->getMessage();
-			}
+			$output = $e->getMessage();
 			$return = 1;
 		}
 		chdir($cwd);

diff --git a/app/Controllers/userController.php b/app/Controllers/userController.php
@@ -208,7 +208,11 @@ public function manageAction(): void {
 		}
 	}
 
-	/** @param array<string,mixed> $userConfigOverride */
+	/**
+	 * @param array<string,mixed> $userConfigOverride
+	 * @throws Minz_ConfigurationNamespaceException
+	 * @throws Minz_PDOConnectionException
+	 */
 	public static function createUser(string $new_user_name, ?string $email, string $passwordPlain,
 		array $userConfigOverride = [], bool $insertDefaultFeeds = true): bool {
 		$userConfig = [];

diff --git a/app/Exceptions/AlreadySubscribedException.php b/app/Exceptions/AlreadySubscribedException.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-class FreshRSS_AlreadySubscribed_Exception extends Exception {
+class FreshRSS_AlreadySubscribed_Exception extends Minz_Exception {
 
 	private string $feedName = '';
 

diff --git a/app/Exceptions/ContextException.php b/app/Exceptions/ContextException.php
@@ -4,6 +4,6 @@
 /**
  * An exception raised when a context is invalid
  */
-class FreshRSS_Context_Exception extends Exception {
+class FreshRSS_Context_Exception extends Minz_Exception {
 
 }
diff --git a/app/Exceptions/DAOException.php b/app/Exceptions/DAOException.php
diff --git a/app/Exceptions/EntriesGetterException.php b/app/Exceptions/EntriesGetterException.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
 
-class FreshRSS_EntriesGetter_Exception extends Exception {
+class FreshRSS_EntriesGetter_Exception extends Minz_Exception {
 
 }
diff --git a/app/Exceptions/FeedException.php b/app/Exceptions/FeedException.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
 
-class FreshRSS_Feed_Exception extends Exception {
+class FreshRSS_Feed_Exception extends Minz_Exception {
 
 }
diff --git a/app/Exceptions/FeedNotAddedException.php b/app/Exceptions/FeedNotAddedException.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-class FreshRSS_FeedNotAdded_Exception extends Exception {
+class FreshRSS_FeedNotAdded_Exception extends Minz_Exception {
 
 	private string $url = '';
 

diff --git a/app/Exceptions/ZipException.php b/app/Exceptions/ZipException.php
@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-class FreshRSS_Zip_Exception extends Exception {
+class FreshRSS_Zip_Exception extends Minz_Exception {
 
 	private int $zipErrorCode = 0;
 

diff --git a/app/Exceptions/ZipMissingException.php b/app/Exceptions/ZipMissingException.php
@@ -1,5 +1,5 @@
 <?php
 declare(strict_types=1);
 
-class FreshRSS_ZipMissing_Exception extends Exception {
+class FreshRSS_ZipMissing_Exception extends Minz_Exception {
 }
diff --git a/app/Models/CategoryDAO.php b/app/Models/CategoryDAO.php
@@ -101,7 +101,6 @@ protected function autoUpdateDb(array $errorInfo): bool {
 	/**
 	 * @param array{'name':string,'id'?:int,'kind'?:int,'lastUpdate'?:int,'error'?:int|bool,'attributes'?:string|array<string,mixed>} $valuesTmp
 	 * @return int|false
-	 * @throws JsonException
 	 */
 	public function addCategory(array $valuesTmp) {
 		// TRIM() to provide a type hint as text
@@ -155,7 +154,6 @@ public function addCategoryObject(FreshRSS_Category $category) {
 	/**
 	 * @param array{'name':string,'kind':int,'attributes'?:array<string,mixed>|mixed|null} $valuesTmp
 	 * @return int|false
-	 * @throws JsonException
 	 */
 	public function updateCategory(int $id, array $valuesTmp) {
 		// No tag of the same name

diff --git a/app/Models/Context.php b/app/Models/Context.php
@@ -75,6 +75,9 @@ public static function initSystem(bool $reload = false): void {
 		}
 	}
 
+	/**
+	 * @throws FreshRSS_Context_Exception
+	 */
 	public static function &systemConf(): FreshRSS_SystemConfiguration {
 		if (FreshRSS_Context::$system_conf === null) {
 			throw new FreshRSS_Context_Exception('System configuration not initialised!');
@@ -88,7 +91,6 @@ public static function hasSystemConf(): bool {
 
 	/**
 	 * Initialize the context for the current user.
-	 * @throws Minz_ConfigurationParamException
 	 */
 	public static function initUser(string $username = '', bool $userMustExist = true): void {
 		FreshRSS_Context::$user_conf = null;
@@ -153,6 +155,9 @@ public static function initUser(string $username = '', bool $userMustExist = tru
 		}
 	}
 
+	/**
+	 * @throws FreshRSS_Context_Exception
+	 */
 	public static function &userConf(): FreshRSS_UserConfiguration {
 		if (FreshRSS_Context::$user_conf === null) {
 			throw new FreshRSS_Context_Exception('User configuration not initialised!');

diff --git a/app/Models/Entry.php b/app/Models/Entry.php
@@ -691,6 +691,7 @@ public function isDay(int $day, int $today): bool {
 
 	/**
 	 * @param array<string,mixed> $attributes
+	 * @throws Minz_Exception
 	 */
 	public static function getContentByParsing(string $url, string $path, array $attributes = [], int $maxRedirs = 3): string {
 		$cachePath = FreshRSS_Feed::cacheFilename($url, $attributes, FreshRSS_Feed::KIND_HTML_XPATH);
@@ -741,7 +742,7 @@ public static function getContentByParsing(string $url, string $path, array $att
 			$html = trim(sanitizeHTML($content, $base));
 			return $html;
 		} else {
-			throw new Exception();
+			throw new Minz_Exception();
 		}
 	}
 

diff --git a/app/Models/EntryDAO.php b/app/Models/EntryDAO.php
@@ -1007,6 +1007,7 @@ public static function sqlBooleanSearch(string $alias, FreshRSS_BooleanSearch $f
 	/**
 	 * @param 'ASC'|'DESC' $order
 	 * @return array{0:array<int|string>,1:string}
+	 * @throws FreshRSS_EntriesGetter_Exception
 	 */
 	protected function sqlListEntriesWhere(string $alias = '', ?FreshRSS_BooleanSearch $filters = null,
 			int $state = FreshRSS_Entry::STATE_ALL,
@@ -1059,6 +1060,7 @@ protected function sqlListEntriesWhere(string $alias = '', ?FreshRSS_BooleanSear
 	 * @param int $id category/feed/tag ID
 	 * @param 'ASC'|'DESC' $order
 	 * @return array{0:array<int|string>,1:string}
+	 * @throws FreshRSS_EntriesGetter_Exception
 	 */
 	private function sqlListWhere(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL,
 			string $order = 'DESC', int $limit = 1, string $firstId = '', ?FreshRSS_BooleanSearch $filters = null,
@@ -1126,6 +1128,7 @@ private function sqlListWhere(string $type = 'a', int $id = 0, int $state = Fres
 	 * @param 'ASC'|'DESC' $order
 	 * @param int $id category/feed/tag ID
 	 * @return PDOStatement|false
+	 * @throws FreshRSS_EntriesGetter_Exception
 	 */
 	private function listWhereRaw(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL,
 			string $order = 'DESC', int $limit = 1, string $firstId = '', ?FreshRSS_BooleanSearch $filters = null,
@@ -1161,6 +1164,7 @@ private function listWhereRaw(string $type = 'a', int $id = 0, int $state = Fres
 	 * @param int $id category/feed/tag ID
 	 * @param 'ASC'|'DESC' $order
 	 * @return Traversable<FreshRSS_Entry>
+	 * @throws FreshRSS_EntriesGetter_Exception
 	 */
 	public function listWhere(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL,
 			string $order = 'DESC', int $limit = 1, string $firstId = '',
@@ -1226,6 +1230,7 @@ public function listByIds(array $ids, string $order = 'DESC'): Traversable {
 	 * @param int $id category/feed/tag ID
 	 * @param 'ASC'|'DESC' $order
 	 * @return array<numeric-string>|null
+	 * @throws FreshRSS_EntriesGetter_Exception
 	 */
 	public function listIdsWhere(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL,
 		string $order = 'DESC', int $limit = 1, string $firstId = '', ?FreshRSS_BooleanSearch $filters = null): ?array {

diff --git a/app/Models/Feed.php b/app/Models/Feed.php
@@ -65,6 +65,9 @@ class FreshRSS_Feed extends Minz_Model {
 	private string $hubUrl = '';
 	private string $selfUrl = '';
 
+	/**
+	 * @throws FreshRSS_BadUrl_Exception
+	 */
 	public function __construct(string $url, bool $validate = true) {
 		if ($validate) {
 			$this->_url($url);
@@ -248,6 +251,9 @@ public function _id(int $value): void {
 		$this->id = $value;
 	}
 
+	/**
+	 * @throws FreshRSS_BadUrl_Exception
+	 */
 	public function _url(string $value, bool $validate = true): void {
 		$this->hash = '';
 		$url = $value;
@@ -323,9 +329,16 @@ public function _nbEntries(int $value): void {
 		$this->nbEntries = $value;
 	}
 
+	/**
+	 * @throws Minz_FileNotExistException
+	 * @throws FreshRSS_Feed_Exception
+	 */
 	public function load(bool $loadDetails = false, bool $noCache = false): ?SimplePie {
 		if ($this->url != '') {
-			// @phpstan-ignore-next-line
+			/**
+			 * @phpstan-ignore-next-line
+			 * @throws Minz_FileNotExistException
+			 */
 			if (CACHE_PATH == '') {
 				throw new Minz_FileNotExistException(
 					'CACHE_PATH',
@@ -615,9 +628,6 @@ private function dotPathsForStandardJsonFeed(): array {
 		];
 	}
 
-	/**
-	 * @throws FreshRSS_Context_Exception
-	 */
 	public function loadJson(): ?SimplePie {
 		if ($this->url == '') {
 			return null;
@@ -654,9 +664,6 @@ public function loadJson(): ?SimplePie {
 		return $this->simplePieFromContent($feedContent);
 	}
 
-	/**
-	 * @throws FreshRSS_Context_Exception
-	 */
 	public function loadHtmlXpath(): ?SimplePie {
 		if ($this->url == '') {
 			return null;
@@ -799,7 +806,6 @@ public function loadHtmlXpath(): ?SimplePie {
 
 	/**
 	 * @return int|null The max number of unread articles to keep, or null if disabled.
-	 * @throws JsonException
 	 */
 	public function keepMaxUnread() {
 		$keepMaxUnread = $this->attributeInt('keep_max_n_unread');
@@ -881,7 +887,10 @@ public function cleanOldEntries() {
 		return false;
 	}
 
-	/** @param array<string,mixed> $attributes */
+	/**
+	 * @param array<string,mixed> $attributes
+	 * @throws FreshRSS_Context_Exception
+	 */
 	public static function cacheFilename(string $url, array $attributes, int $kind = FreshRSS_Feed::KIND_RSS): string {
 		$simplePie = customSimplePie($attributes);
 		$filename = $simplePie->get_cache_filename($url);

diff --git a/app/Models/FeedDAO.php b/app/Models/FeedDAO.php
@@ -37,7 +37,6 @@ protected function autoUpdateDb(array $errorInfo): bool {
 	 * @param array{'url':string,'kind':int,'category':int,'name':string,'website':string,'description':string,'lastUpdate':int,'priority'?:int,
 	 * 	'pathEntries'?:string,'httpAuth':string,'error':int|bool,'ttl'?:int,'attributes'?:string|array<string|mixed>} $valuesTmp
 	 * @return int|false
-	 * @throws JsonException
 	 */
 	public function addFeed(array $valuesTmp) {
 		$sql = 'INSERT INTO `_feed` (url, kind, category, name, website, description, `lastUpdate`, priority, `pathEntries`, `httpAuth`, error, ttl, attributes)