From a0f37c3206fce8a1fb5a2d82d3d3206990ca1e9c Mon Sep 17 00:00:00 2001
From: wn_ <invalid@email.com>
Date: Fri, 12 Nov 2021 00:06:00 +0000
Subject: Address PHPStan warnings in 'classes/pluginhost.php'.

---
 classes/pluginhost.php | 238 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 164 insertions(+), 74 deletions(-)

(limited to 'classes/pluginhost.php')

diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index b506a957a..36e050377 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -1,20 +1,38 @@
 <?php
 class PluginHost {
-	private $pdo;
+	private ?\Pdo $pdo = null;
+
 	/* separate handle for plugin data so transaction while saving wouldn't clash with possible main
 		tt-rss code transactions; only initialized when first needed */
-	private $pdo_data;
-	private $hooks = array();
-	private $plugins = array();
-	private $handlers = array();
-	private $commands = array();
-	private $storage = array();
-	private $feeds = array();
-	private $api_methods = array();
-	private $plugin_actions = array();
-	private $owner_uid;
-	private $data_loaded;
-	private static $instance;
+	private ?\Pdo $pdo_data = null;
+
+	/** @var array<string, array<int, array<int, Plugin>>> hook types -> priority levels -> Plugins */
+	private array $hooks = [];
+
+	/** @var array<string, Plugin> */
+	private array $plugins = [];
+
+	/** @var array<string, array<string, Plugin>> handler type -> method type -> Plugin */
+	private array $handlers = [];
+
+	/** @var array<string, array{'description': string, 'suffix': string, 'arghelp': string, 'class': Plugin}> command type -> details array */
+	private array $commands = [];
+
+	/** @var array<string, array<string, mixed>> plugin name -> (potential profile array) -> key -> value  */
+	private array $storage = [];
+
+	/** @var array<int, array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>> */
+	private array $feeds = [];
+
+	/** @var array<string, Plugin> API method name, Plugin sender */
+	private array $api_methods = [];
+
+	/** @var array<string, array<int, array{'action': string, 'description': string, 'sender': Plugin}>> */
+	private array $plugin_actions = [];
+
+	private ?int $owner_uid = null;
+	private bool $data_loaded = false;
+	private static ?PluginHost $instance = null;
 
 	const API_VERSION = 2;
 	const PUBLIC_METHOD_DELIMITER = "--";
@@ -174,13 +192,13 @@ class PluginHost {
 	const KIND_SYSTEM = 2;
 	const KIND_USER = 3;
 
-	static function object_to_domain(Plugin $plugin) {
+	static function object_to_domain(Plugin $plugin): string {
 		return strtolower(get_class($plugin));
 	}
 
 	function __construct() {
 		$this->pdo = Db::pdo();
-		$this->storage = array();
+		$this->storage = [];
 	}
 
 	private function __clone() {
@@ -194,18 +212,18 @@ class PluginHost {
 		return self::$instance;
 	}
 
-	private function register_plugin(string $name, Plugin $plugin) {
+	private function register_plugin(string $name, Plugin $plugin): void {
 		//array_push($this->plugins, $plugin);
 		$this->plugins[$name] = $plugin;
 	}
 
 	/** needed for compatibility with API 1 */
-	function get_link() {
+	function get_link(): bool {
 		return false;
 	}
 
 	/** needed for compatibility with API 2 (?) */
-	function get_dbh() {
+	function get_dbh(): bool {
 		return false;
 	}
 
@@ -213,8 +231,11 @@ class PluginHost {
 		return $this->pdo;
 	}
 
-	function get_plugin_names() {
-		$names = array();
+	/**
+	 * @return array<int, string>
+	 */
+	function get_plugin_names(): array {
+		$names = [];
 
 		foreach ($this->plugins as $p) {
 			array_push($names, get_class($p));
@@ -223,15 +244,21 @@ class PluginHost {
 		return $names;
 	}
 
-	function get_plugins() {
+	/**
+	 * @return array<Plugin>
+	 */
+	function get_plugins(): array {
 		return $this->plugins;
 	}
 
-	function get_plugin(string $name) {
+	function get_plugin(string $name): ?Plugin {
 		return $this->plugins[strtolower($name)] ?? null;
 	}
 
-	function run_hooks(string $hook, ...$args) {
+	/**
+	 * @param mixed $args
+	 */
+	function run_hooks(string $hook, ...$args): void {
 		$method = strtolower($hook);
 
 		foreach ($this->get_hooks($hook) as $plugin) {
@@ -247,7 +274,11 @@ class PluginHost {
 		}
 	}
 
-	function run_hooks_until(string $hook, $check, ...$args) {
+	/**
+	 * @param mixed $args
+	 * @param mixed $check
+	 */
+	function run_hooks_until(string $hook, $check, ...$args): bool {
 		$method = strtolower($hook);
 
 		foreach ($this->get_hooks($hook) as $plugin) {
@@ -267,7 +298,10 @@ class PluginHost {
 		return false;
 	}
 
-	function run_hooks_callback(string $hook, Closure $callback, ...$args) {
+	/**
+	 * @param mixed $args
+	 */
+	function run_hooks_callback(string $hook, Closure $callback, ...$args): void {
 		$method = strtolower($hook);
 
 		foreach ($this->get_hooks($hook) as $plugin) {
@@ -284,7 +318,10 @@ class PluginHost {
 		}
 	}
 
-	function chain_hooks_callback(string $hook, Closure $callback, &...$args) {
+	/**
+	 * @param mixed $args
+	 */
+	function chain_hooks_callback(string $hook, Closure $callback, &...$args): void {
 		$method = strtolower($hook);
 
 		foreach ($this->get_hooks($hook) as $plugin) {
@@ -301,7 +338,7 @@ class PluginHost {
 		}
 	}
 
-	function add_hook(string $type, Plugin $sender, int $priority = 50) {
+	function add_hook(string $type, Plugin $sender, int $priority = 50): void {
 		$priority = (int) $priority;
 
 		if (!method_exists($sender, strtolower($type))) {
@@ -325,7 +362,7 @@ class PluginHost {
 		ksort($this->hooks[$type]);
 	}
 
-	function del_hook(string $type, Plugin $sender) {
+	function del_hook(string $type, Plugin $sender): void {
 		if (is_array($this->hooks[$type])) {
 			foreach (array_keys($this->hooks[$type]) as $prio) {
 				$key = array_search($sender, $this->hooks[$type][$prio]);
@@ -337,6 +374,9 @@ class PluginHost {
 		}
 	}
 
+	/**
+	 * @return array<int, Plugin>
+	 */
 	function get_hooks(string $type) {
 		if (isset($this->hooks[$type])) {
 			$tmp = [];
@@ -346,11 +386,10 @@ class PluginHost {
 			}
 
 			return $tmp;
-		} else {
-			return [];
 		}
+		return [];
 	}
-	function load_all(int $kind, int $owner_uid = null, bool $skip_init = false) {
+	function load_all(int $kind, int $owner_uid = null, bool $skip_init = false): void {
 
 		$plugins = array_merge(glob("plugins/*"), glob("plugins.local/*"));
 		$plugins = array_filter($plugins, "is_dir");
@@ -361,7 +400,7 @@ class PluginHost {
 		$this->load(join(",", $plugins), $kind, $owner_uid, $skip_init);
 	}
 
-	function load(string $classlist, int $kind, int $owner_uid = null, bool $skip_init = false) {
+	function load(string $classlist, int $kind, int $owner_uid = null, bool $skip_init = false): void {
 		$plugins = explode(",", $classlist);
 
 		$this->owner_uid = (int) $owner_uid;
@@ -434,27 +473,27 @@ class PluginHost {
 		$this->load_data();
 	}
 
-	function is_system(Plugin $plugin) {
+	function is_system(Plugin $plugin): bool {
 		$about = $plugin->about();
 
-		return $about[3] ?? false;
+		return ($about[3] ?? false) === true;
 	}
 
 	// only system plugins are allowed to modify routing
-	function add_handler(string $handler, $method, Plugin $sender) {
+	function add_handler(string $handler, string $method, Plugin $sender): void {
 		$handler = str_replace("-", "_", strtolower($handler));
 		$method = strtolower($method);
 
 		if ($this->is_system($sender)) {
 			if (!isset($this->handlers[$handler])) {
-				$this->handlers[$handler] = array();
+				$this->handlers[$handler] = [];
 			}
 
 			$this->handlers[$handler][$method] = $sender;
 		}
 	}
 
-	function del_handler(string $handler, $method, Plugin $sender) {
+	function del_handler(string $handler, string $method, Plugin $sender): void {
 		$handler = str_replace("-", "_", strtolower($handler));
 		$method = strtolower($method);
 
@@ -463,7 +502,10 @@ class PluginHost {
 		}
 	}
 
-	function lookup_handler($handler, $method) {
+	/**
+	 * @return false|Plugin false if the handler couldn't be found, otherwise the Plugin/handler
+	 */
+	function lookup_handler(string $handler, string $method) {
 		$handler = str_replace("-", "_", strtolower($handler));
 		$method = strtolower($method);
 
@@ -478,7 +520,7 @@ class PluginHost {
 		return false;
 	}
 
-	function add_command(string $command, string $description, Plugin $sender, string $suffix = "", string $arghelp = "") {
+	function add_command(string $command, string $description, Plugin $sender, string $suffix = "", string $arghelp = ""): void {
 		$command = str_replace("-", "_", strtolower($command));
 
 		$this->commands[$command] = array("description" => $description,
@@ -487,27 +529,34 @@ class PluginHost {
 			"class" => $sender);
 	}
 
-	function del_command(string $command) {
+	function del_command(string $command): void {
 		$command = "-" . strtolower($command);
 
 		unset($this->commands[$command]);
 	}
 
-	function lookup_command($command) {
+	/**
+	 * @return false|Plugin false if the command couldn't be found, otherwise the registered Plugin
+	 */
+	function lookup_command(string $command) {
 		$command = "-" . strtolower($command);
 
-		if (is_array($this->commands[$command])) {
+		if (array_key_exists($command, $this->commands) && is_array($this->commands[$command])) {
 			return $this->commands[$command]["class"];
 		} else {
 			return false;
 		}
 	}
 
+	/** @return array<string, array{'description': string, 'suffix': string, 'arghelp': string, 'class': Plugin}>> command type -> details array */
 	function get_commands() {
 		return $this->commands;
 	}
 
-	function run_commands(array $args) {
+	/**
+	 * @param array<string, mixed> $args
+	 */
+	function run_commands(array $args): void {
 		foreach ($this->get_commands() as $command => $data) {
 			if (isset($args[$command])) {
 				$command = str_replace("-", "", $command);
@@ -516,7 +565,7 @@ class PluginHost {
 		}
 	}
 
-	private function load_data() {
+	private function load_data(): void {
 		if ($this->owner_uid && !$this->data_loaded && get_schema_version() > 100)  {
 			$sth = $this->pdo->prepare("SELECT name, content FROM ttrss_plugin_storage
 				WHERE owner_uid = ?");
@@ -530,7 +579,7 @@ class PluginHost {
 		}
 	}
 
-	private function save_data(string $plugin) {
+	private function save_data(string $plugin): void {
 		if ($this->owner_uid) {
 
 			if (!$this->pdo_data)
@@ -543,7 +592,7 @@ class PluginHost {
 			$sth->execute([$this->owner_uid, $plugin]);
 
 			if (!isset($this->storage[$plugin]))
-				$this->storage[$plugin] = array();
+				$this->storage[$plugin] = [];
 
 			$content = serialize($this->storage[$plugin]);
 
@@ -563,8 +612,12 @@ class PluginHost {
 		}
 	}
 
-	// same as set(), but sets data to current preference profile
-	function profile_set(Plugin $sender, string $name, $value) {
+	/**
+	 * same as set(), but sets data to current preference profile
+	 *
+	 * @param mixed $value
+	 */
+	function profile_set(Plugin $sender, string $name, $value): void {
 		$profile_id = $_SESSION["profile"] ?? null;
 
 		if ($profile_id) {
@@ -582,26 +635,32 @@ class PluginHost {
 
 			$this->save_data(get_class($sender));
 		} else {
-			return $this->set($sender, $name, $value);
+			$this->set($sender, $name, $value);
 		}
 	}
 
-	function set(Plugin $sender, string $name, $value) {
+	/**
+	 * @param mixed $value
+	 */
+	function set(Plugin $sender, string $name, $value): void {
 		$idx = get_class($sender);
 
 		if (!isset($this->storage[$idx]))
-			$this->storage[$idx] = array();
+			$this->storage[$idx] = [];
 
 		$this->storage[$idx][$name] = $value;
 
 		$this->save_data(get_class($sender));
 	}
 
-	function set_array(Plugin $sender, array $params) {
+	/**
+	 * @param array<int|string, mixed> $params
+	 */
+	function set_array(Plugin $sender, array $params): void {
 		$idx = get_class($sender);
 
 		if (!isset($this->storage[$idx]))
-			$this->storage[$idx] = array();
+			$this->storage[$idx] = [];
 
 		foreach ($params as $name => $value)
 			$this->storage[$idx][$name] = $value;
@@ -609,7 +668,12 @@ class PluginHost {
 		$this->save_data(get_class($sender));
 	}
 
-	// same as get(), but sets data to current preference profile
+	/**
+	 * same as get(), but sets data to current preference profile
+	 *
+	 * @param mixed $default_value
+	 * @return mixed
+	 */
 	function profile_get(Plugin $sender, string $name, $default_value = false) {
 		$profile_id = $_SESSION["profile"] ?? null;
 
@@ -629,6 +693,10 @@ class PluginHost {
 		}
 	}
 
+	/**
+	 * @param mixed $default_value
+	 * @return mixed
+	 */
 	function get(Plugin $sender, string $name, $default_value = false) {
 		$idx = get_class($sender);
 
@@ -641,6 +709,10 @@ class PluginHost {
 		}
 	}
 
+	/**
+	 * @param array<int|string, mixed> $default_value
+	 * @return array<int|string, mixed>
+	 */
 	function get_array(Plugin $sender, string $name, array $default_value = []) {
 		$tmp = $this->get($sender, $name);
 
@@ -649,13 +721,16 @@ class PluginHost {
 		return $tmp;
 	}
 
-	function get_all($sender) {
+	/**
+	 * @return array<string, mixed>
+	 */
+	function get_all(Plugin $sender) {
 		$idx = get_class($sender);
 
 		return $this->storage[$idx] ?? [];
 	}
 
-	function clear_data(Plugin $sender) {
+	function clear_data(Plugin $sender): void {
 		if ($this->owner_uid) {
 			$idx = get_class($sender);
 
@@ -670,7 +745,7 @@ class PluginHost {
 	// Plugin feed functions are *EXPERIMENTAL*!
 
 	// cat_id: only -1 is supported (Special)
-	function add_feed(int $cat_id, string $title, string $icon, Plugin $sender) {
+	function add_feed(int $cat_id, string $title, string $icon, Plugin $sender): int {
 
 		if (empty($this->feeds[$cat_id]))
 			$this->feeds[$cat_id] = [];
@@ -683,12 +758,15 @@ class PluginHost {
 		return $id;
 	}
 
+	/**
+	 * @return array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>
+	 */
 	function get_feeds(int $cat_id) {
 		return $this->feeds[$cat_id] ?? [];
 	}
 
 	// convert feed_id (e.g. -129) to pfeed_id first
-	function get_feed_handler(int $pfeed_id) {
+	function get_feed_handler(int $pfeed_id): ?Plugin {
 		foreach ($this->feeds as $cat) {
 			foreach ($cat as $feed) {
 				if ($feed['id'] == $pfeed_id) {
@@ -696,46 +774,54 @@ class PluginHost {
 				}
 			}
 		}
+		return null;
 	}
 
-	static function pfeed_to_feed_id(int $pfeed) {
+	static function pfeed_to_feed_id(int $pfeed): int {
 		return PLUGIN_FEED_BASE_INDEX - 1 - abs($pfeed);
 	}
 
-	static function feed_to_pfeed_id(int $feed) {
+	static function feed_to_pfeed_id(int $feed): int {
 		return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed);
 	}
 
-	function add_api_method(string $name, Plugin $sender) {
+	function add_api_method(string $name, Plugin $sender): void {
 		if ($this->is_system($sender)) {
 			$this->api_methods[strtolower($name)] = $sender;
 		}
 	}
 
-	function get_api_method(string $name) {
-		return $this->api_methods[$name];
+	function get_api_method(string $name): ?Plugin {
+		return $this->api_methods[$name] ?? null;
 	}
 
-	function add_filter_action(Plugin $sender, string $action_name, string $action_desc) {
+	function add_filter_action(Plugin $sender, string $action_name, string $action_desc): void {
 		$sender_class = get_class($sender);
 
 		if (!isset($this->plugin_actions[$sender_class]))
-			$this->plugin_actions[$sender_class] = array();
+			$this->plugin_actions[$sender_class] = [];
 
 		array_push($this->plugin_actions[$sender_class],
 			array("action" => $action_name, "description" => $action_desc, "sender" => $sender));
 	}
 
+	/**
+	 * @return array<string, array<int, array{'action': string, 'description': string, 'sender': Plugin}>>
+	 */
 	function get_filter_actions() {
 		return $this->plugin_actions;
 	}
 
-	function get_owner_uid() {
+	function get_owner_uid(): ?int {
 		return $this->owner_uid;
 	}
 
-	// handled by classes/pluginhandler.php, requires valid session
-	function get_method_url(Plugin $sender, string $method, $params = [])  {
+	/**
+	 * handled by classes/pluginhandler.php, requires valid session
+	 *
+	 * @param array<int|string, mixed> $params
+	 */
+	function get_method_url(Plugin $sender, string $method, array $params = []): string  {
 		return Config::get_self_url() . "/backend.php?" .
 			http_build_query(
 				array_merge(
@@ -758,8 +844,12 @@ class PluginHost {
 					$params));
 	} */
 
-	// WARNING: endpoint in public.php, exposed to unauthenticated users
-	function get_public_method_url(Plugin $sender, string $method, $params = [])  {
+	/**
+	 * WARNING: endpoint in public.php, exposed to unauthenticated users
+	 *
+	 * @param array<int|string, mixed> $params
+	 */
+	function get_public_method_url(Plugin $sender, string $method, array $params = []): ?string  {
 		if ($sender->is_public_method($method)) {
 			return Config::get_self_url() . "/public.php?" .
 				http_build_query(
@@ -768,18 +858,18 @@ class PluginHost {
 							"op" => strtolower(get_class($sender) . self::PUBLIC_METHOD_DELIMITER . $method),
 						],
 						$params));
-		} else {
-			user_error("get_public_method_url: requested method '$method' of '" . get_class($sender) . "' is private.");
 		}
+		user_error("get_public_method_url: requested method '$method' of '" . get_class($sender) . "' is private.");
+		return null;
 	}
 
-	function get_plugin_dir(Plugin $plugin) {
+	function get_plugin_dir(Plugin $plugin): string {
 		$ref = new ReflectionClass(get_class($plugin));
 		return dirname($ref->getFileName());
 	}
 
 	// TODO: use get_plugin_dir()
-	function is_local(Plugin $plugin) {
+	function is_local(Plugin $plugin): bool {
 		$ref = new ReflectionClass(get_class($plugin));
 		return basename(dirname(dirname($ref->getFileName()))) == "plugins.local";
 	}
-- 
cgit v1.2.3-54-g00ecf


From d3a81f598b24d6ae4f98415fac9509df6749eaf8 Mon Sep 17 00:00:00 2001
From: wn_ <invalid@email.com>
Date: Fri, 12 Nov 2021 21:17:31 +0000
Subject: Switch class properties from PHP typing to PHPDoc for compatibility
 with PHP < 7.4.0

---
 classes/db/migrations.php | 37 ++++++++++++++++++++++++++----------
 classes/debug.php         | 48 ++++++++++++++++++++++++++++++++---------------
 classes/diskcache.php     |  4 +++-
 classes/mailer.php        |  4 +++-
 classes/pluginhost.php    | 41 +++++++++++++++++++++++++---------------
 classes/urlhelper.php     | 32 +++++++++++++++++++++++--------
 6 files changed, 116 insertions(+), 50 deletions(-)

(limited to 'classes/pluginhost.php')

diff --git a/classes/db/migrations.php b/classes/db/migrations.php
index cb74c247a..6e20ddf7f 100644
--- a/classes/db/migrations.php
+++ b/classes/db/migrations.php
@@ -1,16 +1,33 @@
 <?php
 class Db_Migrations {
 
-	private string $base_filename = "schema.sql";
-	private string $base_path;
-	private string $migrations_path;
-	private string $migrations_table;
-	private bool $base_is_latest;
-	private \PDO $pdo;
-
-	private int $cached_version;
-	private int $cached_max_version;
-	private int $max_version_override;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	private $base_filename = "schema.sql";
+
+	/** @var string */
+	private $base_path;
+
+	/** @var string */
+	private $migrations_path;
+
+	/** @var string */
+	private $migrations_table;
+
+	/** @var bool */
+	private $base_is_latest;
+
+	/** @var PDO */
+	private $pdo;
+
+	/** @var int */
+	private $cached_version;
+
+	/** @var int */
+	private $cached_max_version;
+
+	/** @var int */
+	private $max_version_override;
 
 	function __construct() {
 		$this->pdo = Db::pdo();
diff --git a/classes/debug.php b/classes/debug.php
index 6e8c46ed2..e20126b86 100644
--- a/classes/debug.php
+++ b/classes/debug.php
@@ -1,9 +1,9 @@
 <?php
 class Debug {
 	const LOG_DISABLED = -1;
-    const LOG_NORMAL = 0;
-    const LOG_VERBOSE = 1;
-    const LOG_EXTENDED = 2;
+	const LOG_NORMAL = 0;
+	const LOG_VERBOSE = 1;
+	const LOG_EXTENDED = 2;
 
 	const ALL_LOG_LEVELS = [
 		Debug::LOG_DISABLED,
@@ -12,26 +12,44 @@ class Debug {
 		Debug::LOG_EXTENDED,
 	];
 
-	/** @deprecated */
-	public static int $LOG_DISABLED = self::LOG_DISABLED;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_DISABLED = self::LOG_DISABLED;
+
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_NORMAL = self::LOG_NORMAL;
 
-	/** @deprecated */
-    public static int $LOG_NORMAL = self::LOG_NORMAL;
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_VERBOSE = self::LOG_VERBOSE;
+
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_EXTENDED = self::LOG_EXTENDED;
 
-	/** @deprecated */
-    public static int $LOG_VERBOSE = self::LOG_VERBOSE;
+	/** @var bool */
+	private static $enabled = false;
 
-	/** @deprecated */
-    public static int $LOG_EXTENDED = self::LOG_EXTENDED;
+	/** @var bool */
+	private static $quiet = false;
 
-    private static bool $enabled = false;
-    private static bool $quiet = false;
-    private static ?string $logfile = null;
+	/** @var string|null */
+	private static $logfile = null;
 
 	/**
 	 * @var int Debug::LOG_*
 	 */
-    private static int $loglevel = self::LOG_NORMAL;
+    private static $loglevel = self::LOG_NORMAL;
 
 	public static function set_logfile(string $logfile): void {
         self::$logfile = $logfile;
diff --git a/classes/diskcache.php b/classes/diskcache.php
index 9fa043aee..ed334b2d2 100644
--- a/classes/diskcache.php
+++ b/classes/diskcache.php
@@ -1,6 +1,8 @@
 <?php
 class DiskCache {
-	private string $dir;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	private $dir;
 
 	/**
 	 * https://stackoverflow.com/a/53662733
diff --git a/classes/mailer.php b/classes/mailer.php
index 4eb13aec8..a0f232800 100644
--- a/classes/mailer.php
+++ b/classes/mailer.php
@@ -1,6 +1,8 @@
 <?php
 class Mailer {
-	private string $last_error = "";
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	private $last_error = "";
 
 	/**
 	 * @param array<string, mixed> $params
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 36e050377..173a75611 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -1,38 +1,49 @@
 <?php
 class PluginHost {
-	private ?\Pdo $pdo = null;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var PDO|null */
+	private $pdo = null;
 
-	/* separate handle for plugin data so transaction while saving wouldn't clash with possible main
-		tt-rss code transactions; only initialized when first needed */
-	private ?\Pdo $pdo_data = null;
+	/**
+	 * separate handle for plugin data so transaction while saving wouldn't clash with possible main
+	 * tt-rss code transactions; only initialized when first needed
+	 *
+	 * @var PDO|null
+	 */
+	private $pdo_data = null;
 
 	/** @var array<string, array<int, array<int, Plugin>>> hook types -> priority levels -> Plugins */
-	private array $hooks = [];
+	private $hooks = [];
 
 	/** @var array<string, Plugin> */
-	private array $plugins = [];
+	private $plugins = [];
 
 	/** @var array<string, array<string, Plugin>> handler type -> method type -> Plugin */
-	private array $handlers = [];
+	private $handlers = [];
 
 	/** @var array<string, array{'description': string, 'suffix': string, 'arghelp': string, 'class': Plugin}> command type -> details array */
-	private array $commands = [];
+	private $commands = [];
 
 	/** @var array<string, array<string, mixed>> plugin name -> (potential profile array) -> key -> value  */
-	private array $storage = [];
+	private $storage = [];
 
 	/** @var array<int, array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>> */
-	private array $feeds = [];
+	private $feeds = [];
 
 	/** @var array<string, Plugin> API method name, Plugin sender */
-	private array $api_methods = [];
+	private $api_methods = [];
 
 	/** @var array<string, array<int, array{'action': string, 'description': string, 'sender': Plugin}>> */
-	private array $plugin_actions = [];
+	private $plugin_actions = [];
+
+	/** @var int|null */
+	private $owner_uid = null;
+
+	/** @var bool */
+	private $data_loaded = false;
 
-	private ?int $owner_uid = null;
-	private bool $data_loaded = false;
-	private static ?PluginHost $instance = null;
+	/** @var PluginHost|null */
+	private static $instance = null;
 
 	const API_VERSION = 2;
 	const PUBLIC_METHOD_DELIMITER = "--";
diff --git a/classes/urlhelper.php b/classes/urlhelper.php
index 0592bf28c..351d66b8d 100644
--- a/classes/urlhelper.php
+++ b/classes/urlhelper.php
@@ -6,14 +6,30 @@ class UrlHelper {
 		"tel"
 	];
 
-	static string $fetch_last_error;
-	static int $fetch_last_error_code;
-	static string $fetch_last_error_content;
-	static string $fetch_last_content_type;
-	static string $fetch_last_modified;
-	static string $fetch_effective_url;
-	static string $fetch_effective_ip_addr;
-	static bool $fetch_curl_used;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	static $fetch_last_error;
+
+	/** @var int */
+	static $fetch_last_error_code;
+
+	/** @var string */
+	static $fetch_last_error_content;
+
+	/** @var string */
+	static $fetch_last_content_type;
+
+	/** @var string */
+	static $fetch_last_modified;
+
+	/** @var string */
+	static $fetch_effective_url;
+
+	/** @var string */
+	static $fetch_effective_ip_addr;
+
+	/** @var bool */
+	static $fetch_curl_used;
 
 	/**
 	 * @param array<string, string|int> $parts
-- 
cgit v1.2.3-54-g00ecf


From 15af164f6991db39fb49efa008d4854359746cbc Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Sun, 14 Nov 2021 11:50:55 +0300
Subject: pluginhost: add a hack to not crash on an incompatible plugin more
 than once (per login) - UGLY

---
 classes/pluginhost.php | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'classes/pluginhost.php')

diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 173a75611..7688a6d0d 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -431,8 +431,20 @@ class PluginHost {
 			}
 
 			if (!isset($this->plugins[$class])) {
+
+				// WIP hack
+				// we can't catch incompatible method signatures via Throwable
+				// maybe also auto-disable user plugin in this situation? idk -fox
+				if ($_SESSION["plugin_blacklist.$class"] ?? false) {
+					user_error("Plugin $class has caused a PHP Fatal Error so it won't be loaded again in this session.", E_USER_NOTICE);
+					continue;
+				}
+
 				try {
+					$_SESSION["plugin_blacklist.$class"] = true;
 					require_once $file;
+					$_SESSION["plugin_blacklist.$class"] = false;
+
 				} catch (Error $err) {
 					user_error($err, E_USER_WARNING);
 					continue;
-- 
cgit v1.2.3-54-g00ecf


From af2f4460ce94f48aa4c3bb3176c59325b6612b32 Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Sun, 14 Nov 2021 16:49:10 +0300
Subject:  * deal with some phpstan warnings in base plugin class  * arguably
 better hack for incompatible plugins causing E_COMPILE_ERROR

---
 classes/plugin.php     | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++
 classes/pluginhost.php | 18 +++++++---
 classes/pref/prefs.php |  2 +-
 3 files changed, 108 insertions(+), 6 deletions(-)

(limited to 'classes/pluginhost.php')

diff --git a/classes/plugin.php b/classes/plugin.php
index 8c14cd78d..b027a05c3 100644
--- a/classes/plugin.php
+++ b/classes/plugin.php
@@ -140,10 +140,19 @@ abstract class Plugin {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/**
+	 * @param FeedParser $parser
+	 * @param int $feed_id
+	 * @return void
+	 */
 	function hook_feed_parsed($parser, $feed_id) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/**
+	 * @param array<string,string> $cli_options
+	 * @return void
+	 */
 	function hook_update_task($cli_options) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
@@ -170,44 +179,94 @@ abstract class Plugin {
 		return false;
 	}
 
+	/**
+	 * @param array<string, string> $hotkeys
+	 * @return array<string, string>
+	 */
 	function hook_hotkey_map($hotkeys) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/**
+	 * @param array<string, mixed> $article
+	 * @return array<string, mixed>
+	 */
 	function hook_render_article($article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return [];
 	}
 
+	/**
+	 * @param array<string, mixed> $article
+	 * @return array<string, mixed>
+	 */
 	function hook_render_article_cdm($article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return [];
 	}
 
+	/**
+	 * @param string $feed_data
+	 * @param string $fetch_url
+	 * @param int $owner_uid
+	 * @param int $feed
+	 * @return string
+	 */
 	function hook_feed_fetched($feed_data, $fetch_url, $owner_uid, $feed) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
 	function hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/**
+	 * @param array{'article': array<string,mixed>} $params
+	 * @return array<string, string>
+	 */
 	function hook_render_article_api($params) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return [];
 	}
 
+	/** @return string  */
 	function hook_toolbar_button() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
+	/** @return string  */
 	function hook_action_item() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
+	/**
+	 * @param int $feed_id
+	 * @param bool $is_cat
+	 * @return string
+	 */
 	function hook_headline_toolbar_button($feed_id, $is_cat) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
+	/**
+	 * @param array<string,string> $hotkeys
+	 * @return array<string,string>
+	 */
 	function hook_hotkey_info($hotkeys) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return [];
 	}
 
 	function hook_article_left_button($row) {
@@ -230,6 +289,7 @@ abstract class Plugin {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/** @return void  */
 	function hook_house_keeping() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
@@ -262,6 +322,7 @@ abstract class Plugin {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/** @return void  */
 	function hook_main_toolbar_button() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
@@ -296,24 +357,57 @@ abstract class Plugin {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/** NOTE: $article_filters should be renamed $filter_actions because that's what this is
+	 * @param int $feed_id
+	 * @param int $owner_uid
+	 * @param array<string,mixed> $article
+	 * @param array<string,mixed> $matched_filters
+	 * @param array<string,string|bool|int> $matched_rules
+	 * @param array<string,string> $article_filters
+	 * @return void
+	 */
 	function hook_filter_triggered($feed_id, $owner_uid, $article, $matched_filters, $matched_rules, $article_filters) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
+	/**
+	 * @param string $url
+	 * @return string
+	 */
 	function hook_get_full_text($url) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
+	/**
+	 * @param array<string,string> $enclosures
+	 * @param string $content
+	 * @param string $site_url
+	 * @param array<string,mixed> $article
+	 * @return string
+	 */
 	function hook_article_image($enclosures, $content, $site_url, $article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
+	/** @return string */
 	function hook_feed_tree() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return "";
 	}
 
+	/**
+	 * @param string $url
+	 * @return bool
+	 */
 	function hook_iframe_whitelisted($url) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
+
+		return false;
 	}
 
 	function hook_enclosure_imported($enclosure, $feed) {
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 7688a6d0d..4b0c14a35 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -434,16 +434,24 @@ class PluginHost {
 
 				// WIP hack
 				// we can't catch incompatible method signatures via Throwable
-				// maybe also auto-disable user plugin in this situation? idk -fox
-				if ($_SESSION["plugin_blacklist.$class"] ?? false) {
-					user_error("Plugin $class has caused a PHP Fatal Error so it won't be loaded again in this session.", E_USER_NOTICE);
+				// this also enables global tt-rss safe mode in case there are more plugins like this
+				if (($_SESSION["plugin_blacklist"][$class] ?? 0)) {
+
+					// only report once per-plugin per-session
+					if ($_SESSION["plugin_blacklist"][$class] < 2) {
+						user_error("Plugin $class has caused a PHP fatal error so it won't be loaded again in this session.", E_USER_WARNING);
+						$_SESSION["plugin_blacklist"][$class] = 2;
+					}
+
+					$_SESSION["safe_mode"] = 1;
+
 					continue;
 				}
 
 				try {
-					$_SESSION["plugin_blacklist.$class"] = true;
+					$_SESSION["plugin_blacklist"][$class] = 1;
 					require_once $file;
-					$_SESSION["plugin_blacklist.$class"] = false;
+					unset($_SESSION["plugin_blacklist"][$class]);
 
 				} catch (Error $err) {
 					user_error($err, E_USER_WARNING);
diff --git a/classes/pref/prefs.php b/classes/pref/prefs.php
index 3a39bf981..025d8fda2 100644
--- a/classes/pref/prefs.php
+++ b/classes/pref/prefs.php
@@ -17,7 +17,7 @@ class Pref_Prefs extends Handler_Protected {
 	const PI_ERR_PLUGIN_NOT_FOUND = "PI_ERR_PLUGIN_NOT_FOUND";
 	const PI_ERR_NO_WORKDIR = "PI_ERR_NO_WORKDIR";
 
-	function csrf_ignore(string $method): bool {
+	function csrf_ignore($method) : bool {
 		$csrf_ignored = array("index", "updateself", "otpqrcode");
 
 		return array_search($method, $csrf_ignored) !== false;
-- 
cgit v1.2.3-54-g00ecf


From 10d1a8c05aba9f6c66021e3708ac6aa2ba714a2e Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Tue, 16 Nov 2021 16:31:40 +0300
Subject: adjust phpdoc tags for hook definitions/constants (make them
 reference each other)

---
 classes/plugin.php     |  85 +++++++++++++++++++++++++++++++++--------
 classes/pluginhost.php | 102 ++++++++++++++++++++++++-------------------------
 2 files changed, 119 insertions(+), 68 deletions(-)

(limited to 'classes/pluginhost.php')

diff --git a/classes/plugin.php b/classes/plugin.php
index 16e9791eb..afa9d7a78 100644
--- a/classes/plugin.php
+++ b/classes/plugin.php
@@ -1,11 +1,4 @@
 <?php
-/* TODO: I haven't yet decided if we're keeping hook prototypes which did grow (with additional params) over time and breaking all plugins
-	with legacy function definitions, or commenting base definitions out for the time being -fox
-
-	(It's a shame that PHP doesn't support argument overloading)
-
-	Stuff like hook_enclosure_entry() etc.
-*/
 abstract class Plugin {
 	const API_VERSION_COMPAT = 1;
 
@@ -103,9 +96,12 @@ abstract class Plugin {
 
 	/* plugin hook methods */
 
+	/* GLOBAL hooks are invoked in global context, only available to system plugins (loaded via .env for all users) */
+
 	/**
 	 * @param array<string,mixed> $line
 	 * @return string
+	 * @see PluginHost::HOOK_ARTICLE_BUTTON
 	 */
 	function hook_article_button($line) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -116,6 +112,7 @@ abstract class Plugin {
 	/**
 	 * @param array<string,mixed> $article
 	 * @return array<string,mixed>
+	 * @see PluginHost::HOOK_ARTICLE_FILTER
 	 */
 	function hook_article_filter($article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -126,6 +123,7 @@ abstract class Plugin {
 	/**
 	 * @param string $tab
 	 * @return void
+	 * @see PluginHost::HOOK_PREFS_TAB
 	 */
 	function hook_prefs_tab($tab) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -134,12 +132,15 @@ abstract class Plugin {
 	/**
 	 * @param string $section
 	 * @return void
+	 * @see PluginHost::HOOK_PREFS_TAB_SECTION
 	 */
 	function hook_prefs_tab_section($section) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
-	/** @return void  */
+	/** @return void
+	 * @see PluginHost::HOOK_PREFS_TABS
+	*/
 	function hook_prefs_tabs() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
@@ -148,14 +149,16 @@ abstract class Plugin {
 	 * @param FeedParser $parser
 	 * @param int $feed_id
 	 * @return void
+	 * @see PluginHost::HOOK_FEED_PARSED
 	 */
 	function hook_feed_parsed($parser, $feed_id) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
 
-	/**
+	/** GLOBAL
 	 * @param array<string,string> $cli_options
 	 * @return void
+	 * @see PluginHost::HOOK_UPDATE_TASK
 	 */
 	function hook_update_task($cli_options) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -166,6 +169,7 @@ abstract class Plugin {
 	 * @param string $password
 	 * @param string $service
 	 * @return int|false user_id
+	 * @see PluginHost::HOOK_AUTH_USER
 	 */
 	function hook_auth_user($login, $password, $service = '') {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -186,6 +190,7 @@ abstract class Plugin {
 	/**
 	 * @param array<string, string> $hotkeys
 	 * @return array<string, string>
+	 * @see PluginHost::HOOK_HOTKEY_MAP
 	 */
 	function hook_hotkey_map($hotkeys) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -196,6 +201,7 @@ abstract class Plugin {
 	/**
 	 * @param array<string, mixed> $article
 	 * @return array<string, mixed>
+	 * @see PluginHost::HOOK_RENDER_ARTICLE
 	 */
 	function hook_render_article($article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -206,6 +212,7 @@ abstract class Plugin {
 	/**
 	 * @param array<string, mixed> $article
 	 * @return array<string, mixed>
+	 * @see PluginHost::HOOK_RENDER_ARTICLE_CDM
 	 */
 	function hook_render_article_cdm($article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -219,6 +226,7 @@ abstract class Plugin {
 	 * @param int $owner_uid
 	 * @param int $feed
 	 * @return string
+	 * @see PluginHost::HOOK_FEED_FETCHED
 	 */
 	function hook_feed_fetched($feed_data, $fetch_url, $owner_uid, $feed) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -233,6 +241,7 @@ abstract class Plugin {
 	 * @param array<string> $disallowed_attributes
 	 * @param int $article_id
 	 * @return DOMDocument|array<int,DOMDocument|array<string>>
+	 * @see PluginHost::HOOK_SANITIZE
 	 */
 	function hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -243,6 +252,7 @@ abstract class Plugin {
 	/**
 	 * @param array{'article': array<string,mixed>|null, 'headline': array<string,mixed>|null} $params
 	 * @return array<string, string>
+	 * @see PluginHost::HOOK_RENDER_ARTICLE_API
 	 */
 	function hook_render_article_api($params) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -250,14 +260,20 @@ abstract class Plugin {
 		return [];
 	}
 
-	/** @return string  */
+	/**
+	 * @return string
+	 * @see PluginHost::HOOK_TOOLBAR_BUTTON
+	 */
 	function hook_toolbar_button() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 
 		return "";
 	}
 
-	/** @return string  */
+	/**
+	 * @return string
+	 * @see PluginHost::HOOK_ACTION_ITEM
+	 */
 	function hook_action_item() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 
@@ -268,6 +284,7 @@ abstract class Plugin {
 	 * @param int $feed_id
 	 * @param bool $is_cat
 	 * @return string
+	 * @see PluginHost::HOOK_HEADLINE_TOOLBAR_BUTTON
 	 */
 	function hook_headline_toolbar_button($feed_id, $is_cat) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -278,6 +295,7 @@ abstract class Plugin {
 	/**
 	 * @param array<string, array<string, string>> $hotkeys
 	 * @return array<string, array<string, string>>
+	 * @see PluginHost::HOOK_HOTKEY_INFO
 	 */
 	function hook_hotkey_info($hotkeys) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -288,6 +306,7 @@ abstract class Plugin {
 	/**
 	 * @param array<string,mixed> $row
 	 * @return string
+	 * @see PluginHost::HOOK_ARTICLE_LEFT_BUTTON
 	 */
 	function hook_article_left_button($row) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -298,6 +317,7 @@ abstract class Plugin {
 	/**
 	 * @param int $feed_id
 	 * @return void
+	 * @see PluginHost::HOOK_PREFS_EDIT_FEED
 	 */
 	function hook_prefs_edit_feed($feed_id) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -306,6 +326,7 @@ abstract class Plugin {
 	/**
 	 * @param int $feed_id
 	 * @return void
+	 * @see PluginHost::HOOK_PREFS_SAVE_FEED
 	 */
 	function hook_prefs_save_feed($feed_id) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -320,6 +341,7 @@ abstract class Plugin {
 	 * @param string $auth_login
 	 * @param string $auth_pass
 	 * @return string (possibly mangled feed data)
+	 * @see PluginHost::HOOK_FETCH_FEED
 	 */
 	function hook_fetch_feed($feed_data, $fetch_url, $owner_uid, $feed, $last_article_timestamp, $auth_login, $auth_pass) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -331,6 +353,7 @@ abstract class Plugin {
 	 * @param array<string,mixed> $row
 	 * @param int $excerpt_length
 	 * @return array<string,mixed>
+	 * @see PluginHost::HOOK_QUERY_HEADLINES
 	 */
 	function hook_query_headlines($row, $excerpt_length) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -338,7 +361,9 @@ abstract class Plugin {
 		return [];
 	}
 
-	/** @return void  */
+	/** GLOBAL
+	 * @return void
+	 * @see PluginHost::HOOK_HOUSE_KEEPING */
 	function hook_house_keeping() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
@@ -346,6 +371,7 @@ abstract class Plugin {
 	/**
 	 * @param string $query
 	 * @return array<int, string|array<string>>
+	 * @see PluginHost::HOOK_SEARCH
 	 */
 	function hook_search($query) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -361,6 +387,7 @@ abstract class Plugin {
 	 * @param string $article_content
 	 * @param bool $hide_images
 	 * @return string|array<string,array<int, array<string, mixed>>> ($enclosures_formatted, $enclosures)
+	 * @see PluginHost::HOOK_FORMAT_ENCLOSURES
 	 */
 	function hook_format_enclosures($enclosures_formatted, $enclosures, $article_id, $always_display_enclosures, $article_content, $hide_images) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -374,6 +401,7 @@ abstract class Plugin {
 	 * @param string $auth_login
 	 * @param string $auth_pass
 	 * @return string (possibly mangled feed data)
+	 * @see PluginHost::HOOK_SUBSCRIBE_FEED
 	 */
 	function hook_subscribe_feed($contents, $url, $auth_login, $auth_pass) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -386,6 +414,7 @@ abstract class Plugin {
 	 * @param bool $is_cat
 	 * @param array<string,mixed> $qfh_ret (headlines object)
 	 * @return string
+	 * @see PluginHost::HOOK_HEADLINES_BEFORE
 	 */
 	function hook_headlines_before($feed, $is_cat, $qfh_ret) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -398,6 +427,7 @@ abstract class Plugin {
 	 * @param int $article_id
 	 * @param array<string,mixed> $rv
 	 * @return string
+	 * @see PluginHost::HOOK_RENDER_ENCLOSURE
 	 */
 	function hook_render_enclosure($entry, $article_id, $rv) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -409,6 +439,7 @@ abstract class Plugin {
 	 * @param array<string,mixed> $article
 	 * @param string $action
 	 * @return array<string,mixed> ($article)
+	 * @see PluginHost::HOOK_ARTICLE_FILTER_ACTION
 	 */
 	function hook_article_filter_action($article, $action) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -422,6 +453,7 @@ abstract class Plugin {
 	 * @param bool $is_cat
 	 * @param int $owner_uid
 	 * @return array<string,mixed> ($line)
+	 * @see PluginHost::HOOK_ARTICLE_EXPORT_FEED
 	 */
 	function hook_article_export_feed($line, $feed, $is_cat, $owner_uid) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -429,7 +461,10 @@ abstract class Plugin {
 		return [];
 	}
 
-	/** @return void  */
+	/**
+	 * @return void
+	 * @see PluginHost::HOOK_MAIN_TOOLBAR_BUTTON
+	*/
 	function hook_main_toolbar_button() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 	}
@@ -439,6 +474,7 @@ abstract class Plugin {
 	 * @param int $id
 	 * @param array{'formatted': string, 'entries': array<int, array<string, mixed>>} $rv
 	 * @return array<string,string> ($entry)
+	 * @see PluginHost::HOOK_ENCLOSURE_ENTRY
 	 */
 	function hook_enclosure_entry($entry, $id, $rv) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -450,6 +486,7 @@ abstract class Plugin {
 	 * @param string $html
 	 * @param array<string,mixed> $row
 	 * @return string ($html)
+	 * @see PluginHost::HOOK_FORMAT_ARTICLE
 	 */
 	function hook_format_article($html, $row) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -465,6 +502,7 @@ abstract class Plugin {
 	 * @param string $auth_login
 	 * @param string $auth_pass
 	 * @return array{"title": string, "site_url": string}
+	 * @see PluginHost::HOOK_FEED_BASIC_INFO
 	 */
 	function hook_feed_basic_info($basic_info, $fetch_url, $owner_uid, $feed_id, $auth_login, $auth_pass) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -475,6 +513,7 @@ abstract class Plugin {
 	/**
 	 * @param string $filename
 	 * @return bool
+	 * @see PluginHost::HOOK_SEND_LOCAL_FILE
 	 */
 	function hook_send_local_file($filename) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -486,6 +525,7 @@ abstract class Plugin {
 	 * @param int $feed_id
 	 * @param int $owner_uid
 	 * @return bool
+	 * @see PluginHost::HOOK_UNSUBSCRIBE_FEED
 	 */
 	function hook_unsubscribe_feed($feed_id, $owner_uid) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -497,6 +537,7 @@ abstract class Plugin {
 	 * @param Mailer $mailer
 	 * @param array<string,mixed> $params
 	 * @return int
+	 * @see PluginHost::HOOK_SEND_MAIL
 	 */
 	function hook_send_mail($mailer, $params) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -512,6 +553,7 @@ abstract class Plugin {
 	 * @param array<string,string|bool|int> $matched_rules
 	 * @param array<string,string> $article_filters
 	 * @return void
+	 * @see PluginHost::HOOK_FILTER_TRIGGERED
 	 */
 	function hook_filter_triggered($feed_id, $owner_uid, $article, $matched_filters, $matched_rules, $article_filters) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -520,6 +562,7 @@ abstract class Plugin {
 	/**
 	 * @param string $url
 	 * @return string|false
+	 * @see PluginHost::HOOK_GET_FULL_TEXT
 	 */
 	function hook_get_full_text($url) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -533,6 +576,7 @@ abstract class Plugin {
 	 * @param string $site_url
 	 * @param array<string,mixed> $article
 	 * @return string|array<int,string>
+	 * @see PluginHost::HOOK_ARTICLE_IMAGE
 	 */
 	function hook_article_image($enclosures, $content, $site_url, $article) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -540,7 +584,10 @@ abstract class Plugin {
 		return "";
 	}
 
-	/** @return string */
+	/**
+	 * @return string
+	 * @see PluginHost::HOOK_FEED_TREE
+	 * */
 	function hook_feed_tree() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 
@@ -550,6 +597,7 @@ abstract class Plugin {
 	/**
 	 * @param string $url
 	 * @return bool
+	 * @see PluginHost::HOOK_IFRAME_WHITELISTED
 	 */
 	function hook_iframe_whitelisted($url) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -561,6 +609,7 @@ abstract class Plugin {
 	 * @param object $enclosure
 	 * @param int $feed
 	 * @return object ($enclosure)
+	 * @see PluginHost::HOOK_ENCLOSURE_IMPORTED
 	 */
 	function hook_enclosure_imported($enclosure, $feed) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -568,7 +617,10 @@ abstract class Plugin {
 		return $enclosure;
 	}
 
-	/** @return array<string,string> */
+	/**
+	 * @return array<string,string>
+	 * @see PluginHost::HOOK_HEADLINES_CUSTOM_SORT_MAP
+	 */
 	function hook_headlines_custom_sort_map() {
 		user_error("Dummy method invoked.", E_USER_ERROR);
 
@@ -578,6 +630,7 @@ abstract class Plugin {
 	/**
 	 * @param string $order
 	 * @return array<int, string|bool> -- query, skip_first_id
+	 * @see PluginHost::HOOK_HEADLINES_CUSTOM_SORT_OVERRIDE
 	 */
 	function hook_headlines_custom_sort_override($order) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -589,6 +642,7 @@ abstract class Plugin {
 	 * @param int $feed_id
 	 * @param int $is_cat
 	 * @return string
+	 * @see PluginHost::HOOK_HEADLINE_TOOLBAR_SELECT_MENU_ITEM
 	 */
 	function hook_headline_toolbar_select_menu_item($feed_id, $is_cat) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
@@ -601,6 +655,7 @@ abstract class Plugin {
 	 * @param string $auth_login
 	 * @param string $auth_pass
 	 * @return bool
+	 * @see PluginHost::HOOK_PRE_SUBSCRIBE
 	 */
 	function hook_pre_subscribe(&$url, $auth_login, $auth_pass) {
 		user_error("Dummy method invoked.", E_USER_ERROR);
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 4b0c14a35..83868514c 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -48,155 +48,151 @@ class PluginHost {
 	const API_VERSION = 2;
 	const PUBLIC_METHOD_DELIMITER = "--";
 
-	// Hooks marked with *1 are run in global context and available
-	// to plugins loaded in config.php only
-
-	/** hook_article_button($line) */
+	/** @see Plugin::hook_article_button() */
 	const HOOK_ARTICLE_BUTTON = "hook_article_button";
 
-	/** hook_article_filter($article) */
+	/** @see Plugin::hook_article_filter() */
 	const HOOK_ARTICLE_FILTER = "hook_article_filter";
 
-	/** hook_prefs_tab($tab) */
+	/** @see Plugin::hook_prefs_tab() */
 	const HOOK_PREFS_TAB = "hook_prefs_tab";
 
-	/** hook_prefs_tab_section($section) */
+	/** @see Plugin::hook_prefs_tab_section() */
 	const HOOK_PREFS_TAB_SECTION = "hook_prefs_tab_section";
 
-	/** hook_prefs_tabs() */
+	/** @see Plugin::hook_prefs_tabs() */
 	const HOOK_PREFS_TABS = "hook_prefs_tabs";
 
-	/** hook_feed_parsed($parser, $feed_id) */
+	/** @see Plugin::hook_feed_parsed() */
 	const HOOK_FEED_PARSED = "hook_feed_parsed";
 
-	/** GLOBAL: hook_update_task($cli_options) */
+	/** @see Plugin::hook_update_task() */
 	const HOOK_UPDATE_TASK = "hook_update_task"; //*1
 
-	/** hook_auth_user($login, $password, $service) (byref) */
+	/** @see Plugin::hook_auth_user() */
 	const HOOK_AUTH_USER = "hook_auth_user";
 
-	/** hook_hotkey_map($hotkeys) (byref) */
+	/** @see Plugin::hook_hotkey_map() */
 	const HOOK_HOTKEY_MAP = "hook_hotkey_map";
 
-	/** hook_render_article($article) */
+	/** @see Plugin::hook_render_article() */
 	const HOOK_RENDER_ARTICLE = "hook_render_article";
 
-	/** hook_render_article_cdm($article) */
+	/** @see Plugin::hook_render_article_cdm() */
 	const HOOK_RENDER_ARTICLE_CDM = "hook_render_article_cdm";
 
-	/** hook_feed_fetched($feed_data, $fetch_url, $owner_uid, $feed) (byref) */
+	/** @see Plugin::hook_feed_fetched() */
 	const HOOK_FEED_FETCHED = "hook_feed_fetched";
 
-	/** hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) (byref) */
+	/** @see Plugin::hook_sanitize() */
 	const HOOK_SANITIZE = "hook_sanitize";
 
-	/** hook_render_article_api($params) */
+	/** @see Plugin::hook_render_article_api() */
 	const HOOK_RENDER_ARTICLE_API = "hook_render_article_api";
 
-	/** hook_toolbar_button() */
+	/** @see Plugin::hook_toolbar_button() */
 	const HOOK_TOOLBAR_BUTTON = "hook_toolbar_button";
 
-	/** hook_action_item() */
+	/** @see Plugin::hook_action_item() */
 	const HOOK_ACTION_ITEM = "hook_action_item";
 
-	/** hook_headline_toolbar_button($feed_id, $is_cat) */
+	/** @see Plugin::hook_headline_toolbar_button() */
 	const HOOK_HEADLINE_TOOLBAR_BUTTON = "hook_headline_toolbar_button";
 
-	/** hook_hotkey_info($hotkeys) (byref) */
+	/** @see Plugin::hook_hotkey_info() */
 	const HOOK_HOTKEY_INFO = "hook_hotkey_info";
 
-	/** hook_article_left_button($row) */
+	/** @see Plugin::hook_article_left_button() */
 	const HOOK_ARTICLE_LEFT_BUTTON = "hook_article_left_button";
 
-	/** hook_prefs_edit_feed($feed_id) */
+	/** @see Plugin::hook_prefs_edit_feed() */
 	const HOOK_PREFS_EDIT_FEED = "hook_prefs_edit_feed";
 
-	/** hook_prefs_save_feed($feed_id) */
+	/** @see Plugin::hook_prefs_save_feed() */
 	const HOOK_PREFS_SAVE_FEED = "hook_prefs_save_feed";
 
-	/** hook_fetch_feed($feed_data, $fetch_url, $owner_uid, $feed, $last_article_timestamp, $auth_login, $auth_pass) (byref) */
+	/** @see Plugin::hook_fetch_feed() */
 	const HOOK_FETCH_FEED = "hook_fetch_feed";
 
-	/** hook_query_headlines($row) (byref) */
+	/** @see Plugin::hook_query_headlines() */
 	const HOOK_QUERY_HEADLINES = "hook_query_headlines";
 
-	/** GLOBAL: hook_house_keeping() */
+	/** @see Plugin::hook_house_keeping() */
 	const HOOK_HOUSE_KEEPING = "hook_house_keeping"; //*1
 
-	/** hook_search($query) */
+	/** @see Plugin::hook_search() */
 	const HOOK_SEARCH = "hook_search";
 
-	/** hook_format_enclosures($rv, $result, $id, $always_display_enclosures, $article_content, $hide_images) (byref) */
+	/** @see Plugin::hook_format_enclosures() */
 	const HOOK_FORMAT_ENCLOSURES = "hook_format_enclosures";
 
-	/** hook_subscribe_feed($contents, $url, $auth_login, $auth_pass) (byref) */
+	/** @see Plugin::hook_subscribe_feed() */
 	const HOOK_SUBSCRIBE_FEED = "hook_subscribe_feed";
 
-	/** hook_headlines_before($feed, $is_cat, $qfh_ret) */
+	/** @see Plugin::hook_headlines_before() */
 	const HOOK_HEADLINES_BEFORE = "hook_headlines_before";
 
-	/** hook_render_enclosure($entry, $id, $rv) */
+	/** @see Plugin::hook_render_enclosure() */
 	const HOOK_RENDER_ENCLOSURE = "hook_render_enclosure";
 
-	/** hook_article_filter_action($article, $action) */
+	/** @see Plugin::hook_article_filter_action() */
 	const HOOK_ARTICLE_FILTER_ACTION = "hook_article_filter_action";
 
-	/** hook_article_export_feed($line, $feed, $is_cat, $owner_uid) (byref) */
+	/** @see Plugin::hook_article_export_feed() */
 	const HOOK_ARTICLE_EXPORT_FEED = "hook_article_export_feed";
 
-	/** hook_main_toolbar_button() */
+	/** @see Plugin::hook_main_toolbar_button() */
 	const HOOK_MAIN_TOOLBAR_BUTTON = "hook_main_toolbar_button";
 
-	/** hook_enclosure_entry($entry, $id, $rv) (byref) */
+	/** @see Plugin::hook_enclosure_entry() */
 	const HOOK_ENCLOSURE_ENTRY = "hook_enclosure_entry";
 
-	/** hook_format_article($html, $row) */
+	/** @see Plugin::hook_format_article() */
 	const HOOK_FORMAT_ARTICLE = "hook_format_article";
 
-	/** @deprecated removed, do not use */
+	/** @see Plugin::hook_format_article_cdm() */
 	const HOOK_FORMAT_ARTICLE_CDM = "hook_format_article_cdm";
 
-	/** hook_feed_basic_info($basic_info, $fetch_url, $owner_uid, $feed_id, $auth_login, $auth_pass) (byref) */
+	/** @see Plugin::hook_feed_basic_info() */
 	const HOOK_FEED_BASIC_INFO = "hook_feed_basic_info";
 
-	/** hook_send_local_file($filename) */
+	/** @see Plugin::hook_send_local_file() */
 	const HOOK_SEND_LOCAL_FILE = "hook_send_local_file";
 
-	/** hook_unsubscribe_feed($feed_id, $owner_uid) */
+	/** @see Plugin::hook_unsubscribe_feed() */
 	const HOOK_UNSUBSCRIBE_FEED = "hook_unsubscribe_feed";
 
-	/** hook_send_mail(Mailer $mailer, $params) */
+	/** @see Plugin::hook_send_mail() */
 	const HOOK_SEND_MAIL = "hook_send_mail";
 
-	/** hook_filter_triggered($feed_id, $owner_uid, $article, $matched_filters, $matched_rules, $article_filters) */
+	/** @see Plugin::hook_filter_triggered() */
 	const HOOK_FILTER_TRIGGERED = "hook_filter_triggered";
 
-	/** hook_get_full_text($url) */
+	/** @see Plugin::hook_get_full_text() */
 	const HOOK_GET_FULL_TEXT = "hook_get_full_text";
 
-	/** hook_article_image($enclosures, $content, $site_url) */
+	/** @see Plugin::hook_article_image() */
 	const HOOK_ARTICLE_IMAGE = "hook_article_image";
 
-	/** hook_feed_tree() */
+	/** @see Plugin::hook_feed_tree() */
 	const HOOK_FEED_TREE = "hook_feed_tree";
 
-	/** hook_iframe_whitelisted($url) */
+	/** @see Plugin::hook_iframe_whitelisted() */
 	const HOOK_IFRAME_WHITELISTED = "hook_iframe_whitelisted";
 
-	/** hook_enclosure_imported($enclosure, $feed) */
+	/** @see Plugin::hook_enclosure_imported() */
 	const HOOK_ENCLOSURE_IMPORTED = "hook_enclosure_imported";
 
-	/** hook_headlines_custom_sort_map() */
+	/** @see Plugin::hook_headlines_custom_sort_map() */
 	const HOOK_HEADLINES_CUSTOM_SORT_MAP = "hook_headlines_custom_sort_map";
 
-	/** hook_headlines_custom_sort_override($order) */
+	/** @see Plugin::hook_headlines_custom_sort_override() */
 	const HOOK_HEADLINES_CUSTOM_SORT_OVERRIDE = "hook_headlines_custom_sort_override";
 
-	/** hook_headline_toolbar_select_menu_item($feed_id, $is_cat) */
+	/** @see Plugin::hook_headline_toolbar_select_menu_item() */
 	const HOOK_HEADLINE_TOOLBAR_SELECT_MENU_ITEM = "hook_headline_toolbar_select_menu_item";
 
-
-	/** hook_pre_subscribe($url, $auth_login, $auth_pass) (byref) */
+	/** @see Plugin::hook_pre_subscribe() */
 	const HOOK_PRE_SUBSCRIBE = "hook_pre_subscribe";
 
 	const KIND_ALL = 1;
-- 
cgit v1.2.3-54-g00ecf


From 5980b3d2cb5ad8b0689ae731f405fa0b2c9d6586 Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Tue, 16 Nov 2021 18:35:13 +0300
Subject: pluginhost: set stricter @params

---
 classes/pluginhost.php | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'classes/pluginhost.php')

diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 83868514c..f89cc5c32 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -263,6 +263,7 @@ class PluginHost {
 	}
 
 	/**
+	 * @param PluginHost::HOOK_* $hook
 	 * @param mixed $args
 	 */
 	function run_hooks(string $hook, ...$args): void {
@@ -282,6 +283,7 @@ class PluginHost {
 	}
 
 	/**
+	 * @param PluginHost::HOOK_* $hook
 	 * @param mixed $args
 	 * @param mixed $check
 	 */
@@ -306,6 +308,7 @@ class PluginHost {
 	}
 
 	/**
+	 * @param PluginHost::HOOK_* $hook
 	 * @param mixed $args
 	 */
 	function run_hooks_callback(string $hook, Closure $callback, ...$args): void {
@@ -326,6 +329,7 @@ class PluginHost {
 	}
 
 	/**
+	 * @param PluginHost::HOOK_* $hook
 	 * @param mixed $args
 	 */
 	function chain_hooks_callback(string $hook, Closure $callback, &...$args): void {
@@ -345,6 +349,9 @@ class PluginHost {
 		}
 	}
 
+	/**
+	 * @param PluginHost::HOOK_* $type
+	 */
 	function add_hook(string $type, Plugin $sender, int $priority = 50): void {
 		$priority = (int) $priority;
 
@@ -369,6 +376,9 @@ class PluginHost {
 		ksort($this->hooks[$type]);
 	}
 
+	/**
+	 * @param PluginHost::HOOK_* $type
+	 */
 	function del_hook(string $type, Plugin $sender): void {
 		if (is_array($this->hooks[$type])) {
 			foreach (array_keys($this->hooks[$type]) as $prio) {
@@ -382,6 +392,7 @@ class PluginHost {
 	}
 
 	/**
+	 * @param PluginHost::HOOK_* $type
 	 * @return array<int, Plugin>
 	 */
 	function get_hooks(string $type) {
@@ -396,6 +407,10 @@ class PluginHost {
 		}
 		return [];
 	}
+
+	/**
+	 * @param PluginHost::KIND_* $kind
+	 */
 	function load_all(int $kind, int $owner_uid = null, bool $skip_init = false): void {
 
 		$plugins = array_merge(glob("plugins/*"), glob("plugins.local/*"));
@@ -407,6 +422,9 @@ class PluginHost {
 		$this->load(join(",", $plugins), $kind, $owner_uid, $skip_init);
 	}
 
+	/**
+	 * @param PluginHost::KIND_* $kind
+	 */
 	function load(string $classlist, int $kind, int $owner_uid = null, bool $skip_init = false): void {
 		$plugins = explode(",", $classlist);
 
-- 
cgit v1.2.3-54-g00ecf