summaryrefslogtreecommitdiff
path: root/classes/pluginhost.php
diff options
context:
space:
mode:
Diffstat (limited to 'classes/pluginhost.php')
-rwxr-xr-xclasses/pluginhost.php524
1 files changed, 381 insertions, 143 deletions
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index ee4107ae7..952d4df77 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -1,90 +1,219 @@
<?php
class PluginHost {
- private $pdo;
- /* 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 $last_registered;
- private $data_loaded;
- private static $instance;
+ // 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
+ *
+ * @var PDO|null
+ */
+ private $pdo_data = null;
+
+ /** @var array<string, array<int, array<int, Plugin>>> hook types -> priority levels -> Plugins */
+ private $hooks = [];
+
+ /** @var array<string, Plugin> */
+ private $plugins = [];
+
+ /** @var array<string, array<string, Plugin>> handler type -> method type -> Plugin */
+ private $handlers = [];
+
+ /** @var array<string, array{'description': string, 'suffix': string, 'arghelp': string, 'class': Plugin}> command type -> details array */
+ private $commands = [];
+
+ /** @var array<string, array<string, mixed>> plugin name -> (potential profile array) -> key -> value */
+ private $storage = [];
+
+ /** @var array<int, array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>> */
+ private $feeds = [];
+
+ /** @var array<string, Plugin> API method name, Plugin sender */
+ private $api_methods = [];
+
+ /** @var array<string, array<int, array{'action': string, 'description': string, 'sender': Plugin}>> */
+ private $plugin_actions = [];
+
+ /** @var int|null */
+ private $owner_uid = null;
+
+ /** @var bool */
+ private $data_loaded = false;
+
+ /** @var PluginHost|null */
+ private static $instance = null;
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
-
- const HOOK_ARTICLE_BUTTON = "hook_article_button"; // hook_article_button($line)
- const HOOK_ARTICLE_FILTER = "hook_article_filter"; // hook_article_filter($article)
- const HOOK_PREFS_TAB = "hook_prefs_tab"; // hook_prefs_tab($tab)
- const HOOK_PREFS_TAB_SECTION = "hook_prefs_tab_section"; // hook_prefs_tab_section($section)
- const HOOK_PREFS_TABS = "hook_prefs_tabs"; // hook_prefs_tabs()
- const HOOK_FEED_PARSED = "hook_feed_parsed"; // hook_feed_parsed($parser, $feed_id)
- const HOOK_UPDATE_TASK = "hook_update_task"; //*1 // GLOBAL: hook_update_task($cli_options)
- const HOOK_AUTH_USER = "hook_auth_user"; // hook_auth_user($login, $password, $service) (byref)
- const HOOK_HOTKEY_MAP = "hook_hotkey_map"; // hook_hotkey_map($hotkeys) (byref)
- const HOOK_RENDER_ARTICLE = "hook_render_article"; // hook_render_article($article)
- const HOOK_RENDER_ARTICLE_CDM = "hook_render_article_cdm"; // hook_render_article_cdm($article)
- const HOOK_FEED_FETCHED = "hook_feed_fetched"; // hook_feed_fetched($feed_data, $fetch_url, $owner_uid, $feed) (byref)
- const HOOK_SANITIZE = "hook_sanitize"; // hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) (byref)
- const HOOK_RENDER_ARTICLE_API = "hook_render_article_api"; // hook_render_article_api($params)
- const HOOK_TOOLBAR_BUTTON = "hook_toolbar_button"; // hook_toolbar_button()
- const HOOK_ACTION_ITEM = "hook_action_item"; // hook_action_item()
- const HOOK_HEADLINE_TOOLBAR_BUTTON = "hook_headline_toolbar_button"; // hook_headline_toolbar_button($feed_id, $is_cat)
- const HOOK_HOTKEY_INFO = "hook_hotkey_info"; // hook_hotkey_info($hotkeys) (byref)
- const HOOK_ARTICLE_LEFT_BUTTON = "hook_article_left_button"; // hook_article_left_button($row)
- const HOOK_PREFS_EDIT_FEED = "hook_prefs_edit_feed"; // hook_prefs_edit_feed($feed_id)
- const HOOK_PREFS_SAVE_FEED = "hook_prefs_save_feed"; // hook_prefs_save_feed($feed_id)
- const HOOK_FETCH_FEED = "hook_fetch_feed"; // hook_fetch_feed($feed_data, $fetch_url, $owner_uid, $feed, $last_article_timestamp, $auth_login, $auth_pass) (byref)
- const HOOK_QUERY_HEADLINES = "hook_query_headlines"; // hook_query_headlines($row) (byref)
- const HOOK_HOUSE_KEEPING = "hook_house_keeping"; //*1 // GLOBAL: hook_house_keeping()
- const HOOK_SEARCH = "hook_search"; // hook_search($query)
- const HOOK_FORMAT_ENCLOSURES = "hook_format_enclosures"; // hook__format_enclosures($rv, $result, $id, $always_display_enclosures, $article_content, $hide_images) (byref)
- const HOOK_SUBSCRIBE_FEED = "hook_subscribe_feed"; // hook_subscribe_feed($contents, $url, $auth_login, $auth_pass) (byref)
- const HOOK_HEADLINES_BEFORE = "hook_headlines_before"; // hook_headlines_before($feed, $is_cat, $qfh_ret)
- const HOOK_RENDER_ENCLOSURE = "hook_render_enclosure"; // hook_render_enclosure($entry, $id, $rv)
- const HOOK_ARTICLE_FILTER_ACTION = "hook_article_filter_action"; // hook_article_filter_action($article, $action)
- const HOOK_ARTICLE_EXPORT_FEED = "hook_article_export_feed"; // hook_article_export_feed($line, $feed, $is_cat, $owner_uid) (byref)
- const HOOK_MAIN_TOOLBAR_BUTTON = "hook_main_toolbar_button"; // hook_main_toolbar_button()
- const HOOK_ENCLOSURE_ENTRY = "hook_enclosure_entry"; // hook_enclosure_entry($entry, $id, $rv) (byref)
- const HOOK_FORMAT_ARTICLE = "hook_format_article"; // hook_format_article($html, $row)
- const HOOK_FORMAT_ARTICLE_CDM = "hook_format_article_cdm"; /* RIP */
- const HOOK_FEED_BASIC_INFO = "hook_feed_basic_info"; // hook_feed_basic_info($basic_info, $fetch_url, $owner_uid, $feed_id, $auth_login, $auth_pass) (byref)
- const HOOK_SEND_LOCAL_FILE = "hook_send_local_file"; // hook_send_local_file($filename)
- const HOOK_UNSUBSCRIBE_FEED = "hook_unsubscribe_feed"; // hook_unsubscribe_feed($feed_id, $owner_uid)
- const HOOK_SEND_MAIL = "hook_send_mail"; // hook_send_mail(Mailer $mailer, $params)
- const HOOK_FILTER_TRIGGERED = "hook_filter_triggered"; // hook_filter_triggered($feed_id, $owner_uid, $article, $matched_filters, $matched_rules, $article_filters)
- const HOOK_GET_FULL_TEXT = "hook_get_full_text"; // hook_get_full_text($url)
- const HOOK_ARTICLE_IMAGE = "hook_article_image"; // hook_article_image($enclosures, $content, $site_url)
- const HOOK_FEED_TREE = "hook_feed_tree"; // hook_feed_tree()
- const HOOK_IFRAME_WHITELISTED = "hook_iframe_whitelisted"; // hook_iframe_whitelisted($url)
- const HOOK_ENCLOSURE_IMPORTED = "hook_enclosure_imported"; // hook_enclosure_imported($enclosure, $feed)
- const HOOK_HEADLINES_CUSTOM_SORT_MAP = "hook_headlines_custom_sort_map"; // hook_headlines_custom_sort_map()
+ /** @see Plugin::hook_article_button() */
+ const HOOK_ARTICLE_BUTTON = "hook_article_button";
+
+ /** @see Plugin::hook_article_filter() */
+ const HOOK_ARTICLE_FILTER = "hook_article_filter";
+
+ /** @see Plugin::hook_prefs_tab() */
+ const HOOK_PREFS_TAB = "hook_prefs_tab";
+
+ /** @see Plugin::hook_prefs_tab_section() */
+ const HOOK_PREFS_TAB_SECTION = "hook_prefs_tab_section";
+
+ /** @see Plugin::hook_prefs_tabs() */
+ const HOOK_PREFS_TABS = "hook_prefs_tabs";
+
+ /** @see Plugin::hook_feed_parsed() */
+ const HOOK_FEED_PARSED = "hook_feed_parsed";
+
+ /** @see Plugin::hook_update_task() */
+ const HOOK_UPDATE_TASK = "hook_update_task"; //*1
+
+ /** @see Plugin::hook_auth_user() */
+ const HOOK_AUTH_USER = "hook_auth_user";
+
+ /** @see Plugin::hook_hotkey_map() */
+ const HOOK_HOTKEY_MAP = "hook_hotkey_map";
+
+ /** @see Plugin::hook_render_article() */
+ const HOOK_RENDER_ARTICLE = "hook_render_article";
+
+ /** @see Plugin::hook_render_article_cdm() */
+ const HOOK_RENDER_ARTICLE_CDM = "hook_render_article_cdm";
+
+ /** @see Plugin::hook_feed_fetched() */
+ const HOOK_FEED_FETCHED = "hook_feed_fetched";
+
+ /** @see Plugin::hook_sanitize() */
+ const HOOK_SANITIZE = "hook_sanitize";
+
+ /** @see Plugin::hook_render_article_api() */
+ const HOOK_RENDER_ARTICLE_API = "hook_render_article_api";
+
+ /** @see Plugin::hook_toolbar_button() */
+ const HOOK_TOOLBAR_BUTTON = "hook_toolbar_button";
+
+ /** @see Plugin::hook_action_item() */
+ const HOOK_ACTION_ITEM = "hook_action_item";
+
+ /** @see Plugin::hook_headline_toolbar_button() */
+ const HOOK_HEADLINE_TOOLBAR_BUTTON = "hook_headline_toolbar_button";
+
+ /** @see Plugin::hook_hotkey_info() */
+ const HOOK_HOTKEY_INFO = "hook_hotkey_info";
+
+ /** @see Plugin::hook_article_left_button() */
+ const HOOK_ARTICLE_LEFT_BUTTON = "hook_article_left_button";
+
+ /** @see Plugin::hook_prefs_edit_feed() */
+ const HOOK_PREFS_EDIT_FEED = "hook_prefs_edit_feed";
+
+ /** @see Plugin::hook_prefs_save_feed() */
+ const HOOK_PREFS_SAVE_FEED = "hook_prefs_save_feed";
+
+ /** @see Plugin::hook_fetch_feed() */
+ const HOOK_FETCH_FEED = "hook_fetch_feed";
+
+ /** @see Plugin::hook_query_headlines() */
+ const HOOK_QUERY_HEADLINES = "hook_query_headlines";
+
+ /** @see Plugin::hook_house_keeping() */
+ const HOOK_HOUSE_KEEPING = "hook_house_keeping"; //*1
+
+ /** @see Plugin::hook_search() */
+ const HOOK_SEARCH = "hook_search";
+
+ /** @see Plugin::hook_format_enclosures() */
+ const HOOK_FORMAT_ENCLOSURES = "hook_format_enclosures";
+
+ /** @see Plugin::hook_subscribe_feed() */
+ const HOOK_SUBSCRIBE_FEED = "hook_subscribe_feed";
+
+ /** @see Plugin::hook_headlines_before() */
+ const HOOK_HEADLINES_BEFORE = "hook_headlines_before";
+
+ /** @see Plugin::hook_render_enclosure() */
+ const HOOK_RENDER_ENCLOSURE = "hook_render_enclosure";
+
+ /** @see Plugin::hook_article_filter_action() */
+ const HOOK_ARTICLE_FILTER_ACTION = "hook_article_filter_action";
+
+ /** @see Plugin::hook_article_export_feed() */
+ const HOOK_ARTICLE_EXPORT_FEED = "hook_article_export_feed";
+
+ /** @see Plugin::hook_main_toolbar_button() */
+ const HOOK_MAIN_TOOLBAR_BUTTON = "hook_main_toolbar_button";
+
+ /** @see Plugin::hook_enclosure_entry() */
+ const HOOK_ENCLOSURE_ENTRY = "hook_enclosure_entry";
+
+ /** @see Plugin::hook_format_article() */
+ const HOOK_FORMAT_ARTICLE = "hook_format_article";
+
+ /** @see Plugin::hook_format_article_cdm() */
+ const HOOK_FORMAT_ARTICLE_CDM = "hook_format_article_cdm";
+
+ /** @see Plugin::hook_feed_basic_info() */
+ const HOOK_FEED_BASIC_INFO = "hook_feed_basic_info";
+
+ /** @see Plugin::hook_send_local_file() */
+ const HOOK_SEND_LOCAL_FILE = "hook_send_local_file";
+
+ /** @see Plugin::hook_unsubscribe_feed() */
+ const HOOK_UNSUBSCRIBE_FEED = "hook_unsubscribe_feed";
+
+ /** @see Plugin::hook_send_mail() */
+ const HOOK_SEND_MAIL = "hook_send_mail";
+
+ /** @see Plugin::hook_filter_triggered() */
+ const HOOK_FILTER_TRIGGERED = "hook_filter_triggered";
+
+ /** @see Plugin::hook_get_full_text() */
+ const HOOK_GET_FULL_TEXT = "hook_get_full_text";
+
+ /** @see Plugin::hook_article_image() */
+ const HOOK_ARTICLE_IMAGE = "hook_article_image";
+
+ /** @see Plugin::hook_feed_tree() */
+ const HOOK_FEED_TREE = "hook_feed_tree";
+
+ /** @see Plugin::hook_iframe_whitelisted() */
+ const HOOK_IFRAME_WHITELISTED = "hook_iframe_whitelisted";
+
+ /** @see Plugin::hook_enclosure_imported() */
+ const HOOK_ENCLOSURE_IMPORTED = "hook_enclosure_imported";
+
+ /** @see Plugin::hook_headlines_custom_sort_map() */
+ const HOOK_HEADLINES_CUSTOM_SORT_MAP = "hook_headlines_custom_sort_map";
+
+ /** @see Plugin::hook_headlines_custom_sort_override() */
const HOOK_HEADLINES_CUSTOM_SORT_OVERRIDE = "hook_headlines_custom_sort_override";
- // hook_headlines_custom_sort_override($order)
+
+ /** @see Plugin::hook_headline_toolbar_select_menu_item()
+ * @deprecated removed, see PluginHost::HOOK_HEADLINE_TOOLBAR_SELECT_MENU_ITEM2
+ */
const HOOK_HEADLINE_TOOLBAR_SELECT_MENU_ITEM = "hook_headline_toolbar_select_menu_item";
- // hook_headline_toolbar_select_menu_item($feed_id, $is_cat)
+
+ /** @see Plugin::hook_headline_toolbar_select_menu_item() */
+ const HOOK_HEADLINE_TOOLBAR_SELECT_MENU_ITEM2 = "hook_headline_toolbar_select_menu_item2";
+
+ /** @see Plugin::hook_pre_subscribe() */
+ const HOOK_PRE_SUBSCRIBE = "hook_pre_subscribe";
+
+ /** @see Plugin::hook_post_logout() */
+ const HOOK_POST_LOGOUT = "hook_post_logout";
const KIND_ALL = 1;
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() {
@@ -98,18 +227,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() {
+ /** needed for compatibility with API 1 */
+ function get_link(): bool {
return false;
}
- // needed for compatibility with API 2 (?)
- function get_dbh() {
+ /** needed for compatibility with API 2 (?) */
+ function get_dbh(): bool {
return false;
}
@@ -117,8 +246,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));
@@ -127,18 +259,26 @@ 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) {
- $method = strtolower($hook);
+ /**
+ * @param PluginHost::HOOK_* $hook
+ * @param mixed $args
+ */
+ function run_hooks(string $hook, ...$args): void {
- foreach ($this->get_hooks($hook) as $plugin) {
+ $method = strtolower((string)$hook);
+
+ foreach ($this->get_hooks((string)$hook) as $plugin) {
//Debug::log("invoking: " . get_class($plugin) . "->$hook()", Debug::$LOG_VERBOSE);
try {
@@ -151,10 +291,15 @@ class PluginHost {
}
}
- function run_hooks_until(string $hook, $check, ...$args) {
- $method = strtolower($hook);
+ /**
+ * @param PluginHost::HOOK_* $hook
+ * @param mixed $args
+ * @param mixed $check
+ */
+ function run_hooks_until(string $hook, $check, ...$args): bool {
+ $method = strtolower((string)$hook);
- foreach ($this->get_hooks($hook) as $plugin) {
+ foreach ($this->get_hooks((string)$hook) as $plugin) {
try {
$result = $plugin->$method(...$args);
@@ -171,10 +316,14 @@ class PluginHost {
return false;
}
- function run_hooks_callback(string $hook, Closure $callback, ...$args) {
- $method = strtolower($hook);
+ /**
+ * @param PluginHost::HOOK_* $hook
+ * @param mixed $args
+ */
+ function run_hooks_callback(string $hook, Closure $callback, ...$args): void {
+ $method = strtolower((string)$hook);
- foreach ($this->get_hooks($hook) as $plugin) {
+ foreach ($this->get_hooks((string)$hook) as $plugin) {
//Debug::log("invoking: " . get_class($plugin) . "->$hook()", Debug::$LOG_VERBOSE);
try {
@@ -188,10 +337,14 @@ class PluginHost {
}
}
- function chain_hooks_callback(string $hook, Closure $callback, &...$args) {
- $method = strtolower($hook);
+ /**
+ * @param PluginHost::HOOK_* $hook
+ * @param mixed $args
+ */
+ function chain_hooks_callback(string $hook, Closure $callback, &...$args): void {
+ $method = strtolower((string)$hook);
- foreach ($this->get_hooks($hook) as $plugin) {
+ foreach ($this->get_hooks((string)$hook) as $plugin) {
//Debug::log("invoking: " . get_class($plugin) . "->$hook()", Debug::$LOG_VERBOSE);
try {
@@ -205,10 +358,13 @@ class PluginHost {
}
}
- function add_hook(string $type, Plugin $sender, int $priority = 50) {
+ /**
+ * @param PluginHost::HOOK_* $type
+ */
+ function add_hook(string $type, Plugin $sender, int $priority = 50): void {
$priority = (int) $priority;
- if (!method_exists($sender, strtolower($type))) {
+ if (!method_exists($sender, strtolower((string)$type))) {
user_error(
sprintf("Plugin %s tried to register a hook without implementation: %s",
get_class($sender), $type),
@@ -229,7 +385,10 @@ class PluginHost {
ksort($this->hooks[$type]);
}
- function del_hook(string $type, Plugin $sender) {
+ /**
+ * @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) {
$key = array_search($sender, $this->hooks[$type][$prio]);
@@ -241,6 +400,10 @@ class PluginHost {
}
}
+ /**
+ * @param PluginHost::HOOK_* $type
+ * @return array<int, Plugin>
+ */
function get_hooks(string $type) {
if (isset($this->hooks[$type])) {
$tmp = [];
@@ -250,11 +413,14 @@ class PluginHost {
}
return $tmp;
- } else {
- return [];
}
+ return [];
}
- function load_all(int $kind, int $owner_uid = null, bool $skip_init = false) {
+
+ /**
+ * @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/*"));
$plugins = array_filter($plugins, "is_dir");
@@ -262,10 +428,13 @@ class PluginHost {
asort($plugins);
- $this->load(join(",", $plugins), $kind, $owner_uid, $skip_init);
+ $this->load(join(",", $plugins), (int)$kind, $owner_uid, $skip_init);
}
- function load(string $classlist, int $kind, int $owner_uid = null, bool $skip_init = false) {
+ /**
+ * @param PluginHost::KIND_* $kind
+ */
+ function load(string $classlist, int $kind, int $owner_uid = null, bool $skip_init = false): void {
$plugins = explode(",", $classlist);
$this->owner_uid = (int) $owner_uid;
@@ -285,8 +454,28 @@ class PluginHost {
}
if (!isset($this->plugins[$class])) {
+
+ // WIP hack
+ // we can't catch incompatible method signatures via Throwable
+ // 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 {
- if (file_exists($file)) require_once $file;
+ $_SESSION["plugin_blacklist"][$class] = 1;
+ require_once $file;
+ unset($_SESSION["plugin_blacklist"][$class]);
+
} catch (Error $err) {
user_error($err, E_USER_WARNING);
continue;
@@ -307,8 +496,6 @@ class PluginHost {
_bind_textdomain_codeset($class, "UTF-8");
}
- $this->last_registered = $class;
-
try {
switch ($kind) {
case $this::KIND_SYSTEM:
@@ -340,27 +527,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);
@@ -369,7 +556,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);
@@ -384,7 +574,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,
@@ -393,27 +583,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);
@@ -422,7 +619,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 = ?");
@@ -436,7 +633,7 @@ class PluginHost {
}
}
- private function save_data(string $plugin) {
+ private function save_data(string $plugin): void {
if ($this->owner_uid) {
if (!$this->pdo_data)
@@ -449,7 +646,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]);
@@ -469,8 +666,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) {
@@ -488,26 +689,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;
@@ -515,7 +722,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;
@@ -535,6 +747,10 @@ class PluginHost {
}
}
+ /**
+ * @param mixed $default_value
+ * @return mixed
+ */
function get(Plugin $sender, string $name, $default_value = false) {
$idx = get_class($sender);
@@ -547,6 +763,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);
@@ -555,13 +775,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);
@@ -576,7 +799,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] = [];
@@ -589,12 +812,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) {
@@ -602,46 +828,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(
@@ -664,8 +898,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(
@@ -674,18 +912,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";
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-08 08:36:40 +0000