2012-12-23 11:52:18 +01:00
|
|
|
<?php
|
|
|
|
class PluginHost {
|
2013-04-17 14:23:15 +02:00
|
|
|
private $dbh;
|
2012-12-23 11:52:18 +01:00
|
|
|
private $hooks = array();
|
|
|
|
private $plugins = array();
|
2012-12-23 20:05:51 +01:00
|
|
|
private $handlers = array();
|
2012-12-24 06:52:15 +01:00
|
|
|
private $commands = array();
|
2012-12-27 13:55:25 +01:00
|
|
|
private $storage = array();
|
2013-03-27 13:14:27 +01:00
|
|
|
private $feeds = array();
|
2013-04-12 06:18:43 +02:00
|
|
|
private $api_methods = array();
|
2012-12-27 13:55:25 +01:00
|
|
|
private $owner_uid;
|
2013-02-26 16:30:19 +01:00
|
|
|
private $debug;
|
2013-04-19 15:20:03 +02:00
|
|
|
private $last_registered;
|
2013-04-18 10:27:34 +02:00
|
|
|
private static $instance;
|
2012-12-23 11:52:18 +01:00
|
|
|
|
2013-04-19 15:31:56 +02:00
|
|
|
const API_VERSION = 2;
|
2013-04-19 15:26:22 +02:00
|
|
|
|
2012-12-23 11:52:18 +01:00
|
|
|
const HOOK_ARTICLE_BUTTON = 1;
|
|
|
|
const HOOK_ARTICLE_FILTER = 2;
|
2012-12-23 13:15:34 +01:00
|
|
|
const HOOK_PREFS_TAB = 3;
|
2012-12-26 22:12:28 +01:00
|
|
|
const HOOK_PREFS_TAB_SECTION = 4;
|
2012-12-23 20:36:07 +01:00
|
|
|
const HOOK_PREFS_TABS = 5;
|
2012-12-24 11:13:03 +01:00
|
|
|
const HOOK_FEED_PARSED = 6;
|
2012-12-24 11:27:15 +01:00
|
|
|
const HOOK_UPDATE_TASK = 7;
|
2012-12-27 12:14:44 +01:00
|
|
|
const HOOK_AUTH_USER = 8;
|
2012-12-28 07:46:53 +01:00
|
|
|
const HOOK_HOTKEY_MAP = 9;
|
2013-02-23 13:01:51 +01:00
|
|
|
const HOOK_RENDER_ARTICLE = 10;
|
|
|
|
const HOOK_RENDER_ARTICLE_CDM = 11;
|
2013-02-23 15:38:50 +01:00
|
|
|
const HOOK_FEED_FETCHED = 12;
|
2013-03-19 15:58:42 +01:00
|
|
|
const HOOK_SANITIZE = 13;
|
2013-03-21 15:19:23 +01:00
|
|
|
const HOOK_RENDER_ARTICLE_API = 14;
|
2013-04-01 16:06:09 +02:00
|
|
|
const HOOK_TOOLBAR_BUTTON = 15;
|
|
|
|
const HOOK_ACTION_ITEM = 16;
|
|
|
|
const HOOK_HEADLINE_TOOLBAR_BUTTON = 17;
|
2013-04-02 09:05:17 +02:00
|
|
|
const HOOK_HOTKEY_INFO = 18;
|
2013-04-09 14:46:56 +02:00
|
|
|
const HOOK_ARTICLE_LEFT_BUTTON = 19;
|
2013-04-26 12:21:08 +02:00
|
|
|
const HOOK_PREFS_EDIT_FEED = 20;
|
2013-04-26 12:23:18 +02:00
|
|
|
const HOOK_PREFS_SAVE_FEED = 21;
|
2012-12-23 11:52:18 +01:00
|
|
|
|
2012-12-25 07:02:08 +01:00
|
|
|
const KIND_ALL = 1;
|
|
|
|
const KIND_SYSTEM = 2;
|
|
|
|
const KIND_USER = 3;
|
|
|
|
|
2013-04-19 06:40:19 +02:00
|
|
|
function __construct() {
|
2013-04-18 10:27:34 +02:00
|
|
|
$this->dbh = Db::get();
|
2012-12-27 13:55:25 +01:00
|
|
|
|
2013-04-28 16:17:58 +02:00
|
|
|
$this->storage = array();
|
2012-12-23 11:52:18 +01:00
|
|
|
}
|
|
|
|
|
2013-04-18 10:27:34 +02:00
|
|
|
private function __clone() {
|
|
|
|
//
|
|
|
|
}
|
|
|
|
|
|
|
|
public static function getInstance() {
|
|
|
|
if (self::$instance == null)
|
|
|
|
self::$instance = new self();
|
|
|
|
|
|
|
|
return self::$instance;
|
|
|
|
}
|
|
|
|
|
2012-12-23 11:52:18 +01:00
|
|
|
private function register_plugin($name, $plugin) {
|
|
|
|
//array_push($this->plugins, $plugin);
|
|
|
|
$this->plugins[$name] = $plugin;
|
|
|
|
}
|
|
|
|
|
2013-04-19 15:31:56 +02:00
|
|
|
// needed for compatibility with API 1
|
2013-04-19 15:20:03 +02:00
|
|
|
function get_link() {
|
2013-04-19 15:31:56 +02:00
|
|
|
return false;
|
2013-04-19 15:20:03 +02:00
|
|
|
}
|
|
|
|
|
2013-04-17 14:23:15 +02:00
|
|
|
function get_dbh() {
|
|
|
|
return $this->dbh;
|
2012-12-23 11:52:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function get_plugins() {
|
|
|
|
return $this->plugins;
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_plugin($name) {
|
|
|
|
return $this->plugins[$name];
|
|
|
|
}
|
|
|
|
|
2012-12-23 13:15:34 +01:00
|
|
|
function run_hooks($type, $method, $args) {
|
|
|
|
foreach ($this->get_hooks($type) as $hook) {
|
|
|
|
$hook->$method($args);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-12-23 11:52:18 +01:00
|
|
|
function add_hook($type, $sender) {
|
|
|
|
if (!is_array($this->hooks[$type])) {
|
|
|
|
$this->hooks[$type] = array();
|
|
|
|
}
|
|
|
|
|
|
|
|
array_push($this->hooks[$type], $sender);
|
|
|
|
}
|
|
|
|
|
|
|
|
function del_hook($type, $sender) {
|
|
|
|
if (is_array($this->hooks[$type])) {
|
|
|
|
$key = array_Search($this->hooks[$type], $sender);
|
|
|
|
if ($key !== FALSE) {
|
|
|
|
unset($this->hooks[$type][$key]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_hooks($type) {
|
2012-12-24 10:45:34 +01:00
|
|
|
if (isset($this->hooks[$type])) {
|
|
|
|
return $this->hooks[$type];
|
|
|
|
} else {
|
|
|
|
return array();
|
|
|
|
}
|
2012-12-23 11:52:18 +01:00
|
|
|
}
|
2012-12-27 16:20:12 +01:00
|
|
|
function load_all($kind, $owner_uid = false) {
|
2012-12-24 12:39:42 +01:00
|
|
|
$plugins = array_map("basename", glob("plugins/*"));
|
2012-12-27 16:20:12 +01:00
|
|
|
$this->load(join(",", $plugins), $kind, $owner_uid);
|
2012-12-24 12:39:42 +01:00
|
|
|
}
|
2012-12-23 11:52:18 +01:00
|
|
|
|
2012-12-27 13:55:25 +01:00
|
|
|
function load($classlist, $kind, $owner_uid = false) {
|
2012-12-23 11:52:18 +01:00
|
|
|
$plugins = explode(",", $classlist);
|
|
|
|
|
2012-12-27 13:55:25 +01:00
|
|
|
$this->owner_uid = (int) $owner_uid;
|
|
|
|
|
2012-12-23 11:52:18 +01:00
|
|
|
foreach ($plugins as $class) {
|
|
|
|
$class = trim($class);
|
2012-12-23 20:05:51 +01:00
|
|
|
$class_file = strtolower(basename($class));
|
2013-04-16 18:20:38 +02:00
|
|
|
|
|
|
|
if (!is_dir(dirname(__FILE__)."/../plugins/$class_file")) continue;
|
|
|
|
|
2012-12-30 10:36:40 +01:00
|
|
|
$file = dirname(__FILE__)."/../plugins/$class_file/init.php";
|
2012-12-23 11:52:18 +01:00
|
|
|
|
2012-12-24 21:45:10 +01:00
|
|
|
if (!isset($this->plugins[$class])) {
|
|
|
|
if (file_exists($file)) require_once $file;
|
2012-12-23 11:52:18 +01:00
|
|
|
|
2012-12-24 21:45:10 +01:00
|
|
|
if (class_exists($class) && is_subclass_of($class, "Plugin")) {
|
|
|
|
$plugin = new $class($this);
|
2012-12-23 11:52:18 +01:00
|
|
|
|
2013-04-19 15:26:22 +02:00
|
|
|
$plugin_api = $plugin->api_version();
|
|
|
|
|
|
|
|
if ($plugin_api < PluginHost::API_VERSION) {
|
|
|
|
user_error("Plugin $class is not compatible with current API version (need: " . PluginHost::API_VERSION . ", got: $plugin_api)", E_USER_WARNING);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2013-04-19 15:20:03 +02:00
|
|
|
$this->last_registered = $class;
|
|
|
|
|
2012-12-25 07:02:08 +01:00
|
|
|
switch ($kind) {
|
|
|
|
case $this::KIND_SYSTEM:
|
|
|
|
if ($this->is_system($plugin)) {
|
|
|
|
$plugin->init($this);
|
|
|
|
$this->register_plugin($class, $plugin);
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case $this::KIND_USER:
|
|
|
|
if (!$this->is_system($plugin)) {
|
|
|
|
$plugin->init($this);
|
|
|
|
$this->register_plugin($class, $plugin);
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case $this::KIND_ALL:
|
|
|
|
$plugin->init($this);
|
|
|
|
$this->register_plugin($class, $plugin);
|
|
|
|
break;
|
|
|
|
}
|
2012-12-24 21:45:10 +01:00
|
|
|
}
|
2012-12-23 11:52:18 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-12-24 21:45:10 +01:00
|
|
|
function is_system($plugin) {
|
2012-12-25 07:02:08 +01:00
|
|
|
$about = $plugin->about();
|
2012-12-24 21:45:10 +01:00
|
|
|
|
|
|
|
return @$about[3];
|
|
|
|
}
|
|
|
|
|
|
|
|
// only system plugins are allowed to modify routing
|
2012-12-23 20:05:51 +01:00
|
|
|
function add_handler($handler, $method, $sender) {
|
2012-12-23 20:36:07 +01:00
|
|
|
$handler = str_replace("-", "_", strtolower($handler));
|
2012-12-23 20:05:51 +01:00
|
|
|
$method = strtolower($method);
|
|
|
|
|
2012-12-24 21:45:10 +01:00
|
|
|
if ($this->is_system($sender)) {
|
|
|
|
if (!is_array($this->handlers[$handler])) {
|
|
|
|
$this->handlers[$handler] = array();
|
|
|
|
}
|
2012-12-23 20:05:51 +01:00
|
|
|
|
2012-12-24 21:45:10 +01:00
|
|
|
$this->handlers[$handler][$method] = $sender;
|
|
|
|
}
|
2012-12-23 20:05:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function del_handler($handler, $method) {
|
2012-12-23 20:36:07 +01:00
|
|
|
$handler = str_replace("-", "_", strtolower($handler));
|
2012-12-23 20:05:51 +01:00
|
|
|
$method = strtolower($method);
|
|
|
|
|
2012-12-24 21:45:10 +01:00
|
|
|
if ($this->is_system($sender)) {
|
|
|
|
unset($this->handlers[$handler][$method]);
|
|
|
|
}
|
2012-12-23 20:05:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function lookup_handler($handler, $method) {
|
2012-12-23 20:36:07 +01:00
|
|
|
$handler = str_replace("-", "_", strtolower($handler));
|
2012-12-23 20:05:51 +01:00
|
|
|
$method = strtolower($method);
|
|
|
|
|
|
|
|
if (is_array($this->handlers[$handler])) {
|
2012-12-23 20:36:07 +01:00
|
|
|
if (isset($this->handlers[$handler]["*"])) {
|
|
|
|
return $this->handlers[$handler]["*"];
|
|
|
|
} else {
|
|
|
|
return $this->handlers[$handler][$method];
|
|
|
|
}
|
2012-12-23 20:05:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-24 06:52:15 +01:00
|
|
|
|
2013-03-28 15:37:36 +01:00
|
|
|
function add_command($command, $description, $sender, $suffix = "", $arghelp = "") {
|
2013-03-21 11:48:47 +01:00
|
|
|
$command = str_replace("-", "_", strtolower($command));
|
2012-12-24 06:52:15 +01:00
|
|
|
|
2012-12-25 07:02:08 +01:00
|
|
|
$this->commands[$command] = array("description" => $description,
|
2013-03-28 15:37:36 +01:00
|
|
|
"suffix" => $suffix,
|
|
|
|
"arghelp" => $arghelp,
|
2012-12-25 07:02:08 +01:00
|
|
|
"class" => $sender);
|
2012-12-24 06:52:15 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function del_command($command) {
|
|
|
|
$command = "-" . strtolower($command);
|
|
|
|
|
2012-12-25 07:02:08 +01:00
|
|
|
unset($this->commands[$command]);
|
2012-12-24 06:52:15 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function lookup_command($command) {
|
|
|
|
$command = "-" . strtolower($command);
|
|
|
|
|
|
|
|
if (is_array($this->commands[$command])) {
|
|
|
|
return $this->commands[$command]["class"];
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_commands() {
|
|
|
|
return $this->commands;
|
|
|
|
}
|
|
|
|
|
|
|
|
function run_commands($args) {
|
|
|
|
foreach ($this->get_commands() as $command => $data) {
|
2013-03-21 11:48:47 +01:00
|
|
|
if (isset($args[$command])) {
|
2012-12-24 06:52:15 +01:00
|
|
|
$command = str_replace("-", "", $command);
|
|
|
|
$data["class"]->$command($args);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-12-27 13:55:25 +01:00
|
|
|
function load_data($force = false) {
|
2013-04-28 16:17:58 +02:00
|
|
|
if ($this->owner_uid) {
|
2013-04-17 18:12:14 +02:00
|
|
|
$plugin = $this->dbh->escape_string($plugin);
|
2012-12-27 13:55:25 +01:00
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
$result = $this->dbh->query("SELECT name, content FROM ttrss_plugin_storage
|
2012-12-27 13:55:25 +01:00
|
|
|
WHERE owner_uid = '".$this->owner_uid."'");
|
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
while ($line = $this->dbh->fetch_assoc($result)) {
|
2012-12-27 13:55:25 +01:00
|
|
|
$this->storage[$line["name"]] = unserialize($line["content"]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private function save_data($plugin) {
|
|
|
|
if ($this->owner_uid) {
|
2013-04-17 18:12:14 +02:00
|
|
|
$plugin = $this->dbh->escape_string($plugin);
|
2012-12-27 13:55:25 +01:00
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
$this->dbh->query("BEGIN");
|
2012-12-27 13:55:25 +01:00
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
$result = $this->dbh->query("SELECT id FROM ttrss_plugin_storage WHERE
|
2012-12-27 13:55:25 +01:00
|
|
|
owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
|
|
|
|
|
|
|
|
if (!isset($this->storage[$plugin]))
|
|
|
|
$this->storage[$plugin] = array();
|
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
$content = $this->dbh->escape_string(serialize($this->storage[$plugin]));
|
2012-12-27 13:55:25 +01:00
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
if ($this->dbh->num_rows($result) != 0) {
|
|
|
|
$this->dbh->query("UPDATE ttrss_plugin_storage SET content = '$content'
|
2012-12-27 13:55:25 +01:00
|
|
|
WHERE owner_uid= '".$this->owner_uid."' AND name = '$plugin'");
|
|
|
|
|
|
|
|
} else {
|
2013-04-17 18:12:14 +02:00
|
|
|
$this->dbh->query("INSERT INTO ttrss_plugin_storage
|
2012-12-27 13:55:25 +01:00
|
|
|
(name,owner_uid,content) VALUES
|
|
|
|
('$plugin','".$this->owner_uid."','$content')");
|
|
|
|
}
|
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
$this->dbh->query("COMMIT");
|
2012-12-27 13:55:25 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function set($sender, $name, $value, $sync = true) {
|
|
|
|
$idx = get_class($sender);
|
|
|
|
|
|
|
|
if (!isset($this->storage[$idx]))
|
|
|
|
$this->storage[$idx] = array();
|
|
|
|
|
|
|
|
$this->storage[$idx][$name] = $value;
|
|
|
|
|
|
|
|
if ($sync) $this->save_data(get_class($sender));
|
|
|
|
}
|
|
|
|
|
2012-12-27 16:20:12 +01:00
|
|
|
function get($sender, $name, $default_value = false) {
|
2012-12-27 13:55:25 +01:00
|
|
|
$idx = get_class($sender);
|
|
|
|
|
|
|
|
if (isset($this->storage[$idx][$name])) {
|
|
|
|
return $this->storage[$idx][$name];
|
|
|
|
} else {
|
|
|
|
return $default_value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_all($sender) {
|
|
|
|
$idx = get_class($sender);
|
|
|
|
|
|
|
|
return $this->storage[$idx];
|
|
|
|
}
|
2012-12-27 16:20:12 +01:00
|
|
|
|
|
|
|
function clear_data($sender) {
|
|
|
|
if ($this->owner_uid) {
|
|
|
|
$idx = get_class($sender);
|
|
|
|
|
|
|
|
unset($this->storage[$idx]);
|
|
|
|
|
2013-04-17 18:12:14 +02:00
|
|
|
$this->dbh->query("DELETE FROM ttrss_plugin_storage WHERE name = '$idx'
|
2012-12-27 16:20:12 +01:00
|
|
|
AND owner_uid = " . $this->owner_uid);
|
|
|
|
}
|
|
|
|
}
|
2013-02-26 16:30:19 +01:00
|
|
|
|
|
|
|
function set_debug($debug) {
|
|
|
|
$this->debug = $debug;
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_debug() {
|
|
|
|
return $this->debug;
|
|
|
|
}
|
2013-03-27 13:14:27 +01:00
|
|
|
|
|
|
|
// Plugin feed functions are *EXPERIMENTAL*!
|
|
|
|
|
|
|
|
// cat_id: only -1 is supported (Special)
|
|
|
|
function add_feed($cat_id, $title, $icon, $sender) {
|
|
|
|
if (!$this->feeds[$cat_id]) $this->feeds[$cat_id] = array();
|
|
|
|
|
|
|
|
$id = count($this->feeds[$cat_id]);
|
|
|
|
|
|
|
|
array_push($this->feeds[$cat_id],
|
|
|
|
array('id' => $id, 'title' => $title, 'sender' => $sender, 'icon' => $icon));
|
|
|
|
|
|
|
|
return $id;
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_feeds($cat_id) {
|
|
|
|
return $this->feeds[$cat_id];
|
|
|
|
}
|
|
|
|
|
|
|
|
// convert feed_id (e.g. -129) to pfeed_id first
|
|
|
|
function get_feed_handler($pfeed_id) {
|
|
|
|
foreach ($this->feeds as $cat) {
|
|
|
|
foreach ($cat as $feed) {
|
|
|
|
if ($feed['id'] == $pfeed_id) {
|
|
|
|
return $feed['sender'];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static function pfeed_to_feed_id($label) {
|
|
|
|
return PLUGIN_FEED_BASE_INDEX - 1 - abs($label);
|
|
|
|
}
|
|
|
|
|
|
|
|
static function feed_to_pfeed_id($feed) {
|
|
|
|
return PLUGIN_FEED_BASE_INDEX - 1 + abs($feed);
|
|
|
|
}
|
|
|
|
|
2013-04-12 06:18:43 +02:00
|
|
|
function add_api_method($name, $sender) {
|
|
|
|
if ($this->is_system($sender)) {
|
|
|
|
$this->api_methods[strtolower($name)] = $sender;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function get_api_method($name) {
|
|
|
|
return $this->api_methods[$name];
|
|
|
|
}
|
2012-12-23 11:52:18 +01:00
|
|
|
}
|
|
|
|
?>
|