From 19c7350770788edf3ae0bb1fd6d95876667adbf6 Mon Sep 17 00:00:00 2001 From: Andrew Dolgov Date: Sun, 23 Dec 2012 14:52:18 +0400 Subject: [PATCH] experimental new plugin system --- backend.php | 4 + classes/button.php | 11 --- classes/button/tweet.php | 31 -------- classes/feeds.php | 10 ++- classes/filter.php | 14 ---- classes/pluginhandler.php | 18 +++++ classes/pluginhost.php | 71 ++++++++++++++++++ classes/rpc.php | 4 +- config.php-dist | 9 +-- images/art-tweet.png | Bin 159 -> 0 bytes include/functions.php | 24 +++--- include/rssfuncs.php | 23 +----- include/sanity_config.php | 4 +- index.php | 9 ++- js/tweet_button.js | 31 -------- plugins/mail/README.txt | 1 + js/mail_button.js => plugins/mail/mail.js | 4 +- {classes/button => plugins/mail}/mail.php | 28 +++++-- images/art-email.png => plugins/mail/mail.png | Bin plugins/note/README.txt | 1 + js/note_button.js => plugins/note/note.js | 2 +- {classes/button => plugins/note}/note.php | 33 +++++--- .../art-pub-note.png => plugins/note/note.png | Bin plugins/redditimgur/README.txt | 1 + .../redditimgur}/redditimgur.php | 14 +++- plugins/share/README.txt | 1 + js/share_button.js => plugins/share/share.js | 2 +- {classes/button => plugins/share}/share.php | 18 ++++- .../art-share.png => plugins/share/share.png | Bin 29 files changed, 204 insertions(+), 164 deletions(-) delete mode 100644 classes/button.php delete mode 100644 classes/button/tweet.php delete mode 100644 classes/filter.php create mode 100644 classes/pluginhandler.php create mode 100644 classes/pluginhost.php delete mode 100644 images/art-tweet.png delete mode 100644 js/tweet_button.js create mode 100644 plugins/mail/README.txt rename js/mail_button.js => plugins/mail/mail.js (85%) rename {classes/button => plugins/mail}/mail.php (90%) rename images/art-email.png => plugins/mail/mail.png (100%) create mode 100644 plugins/note/README.txt rename js/note_button.js => plugins/note/note.js (89%) rename {classes/button => plugins/note}/note.php (71%) rename images/art-pub-note.png => plugins/note/note.png (100%) create mode 100644 plugins/redditimgur/README.txt rename {classes/filter => plugins/redditimgur}/redditimgur.php (81%) create mode 100644 plugins/share/README.txt rename js/share_button.js => plugins/share/share.js (73%) rename {classes/button => plugins/share}/share.php (83%) rename images/art-share.png => plugins/share/share.png (100%) diff --git a/backend.php b/backend.php index 511bb3552..8aaf10016 100644 --- a/backend.php +++ b/backend.php @@ -126,6 +126,10 @@ if ($handler->before($method)) { if ($method && method_exists($handler, $method)) { $handler->$method(); + } else { + if (method_exists($handler, "catchall")) { + $handler->catchall($method); + } } $handler->after(); return; diff --git a/classes/button.php b/classes/button.php deleted file mode 100644 index 24d576dae..000000000 --- a/classes/button.php +++ /dev/null @@ -1,11 +0,0 @@ -link = $link; - } - -} -?> diff --git a/classes/button/tweet.php b/classes/button/tweet.php deleted file mode 100644 index 3157fb779..000000000 --- a/classes/button/tweet.php +++ /dev/null @@ -1,31 +0,0 @@ -link, 'images/art-tweet.png')."\" - class='tagsPic' style=\"cursor : pointer\" - onclick=\"tweetArticle($article_id)\" - title='".__('Share on Twitter')."'>"; - - return $rv; - } - - function getTweetInfo() { - $id = db_escape_string($_REQUEST['id']); - - $result = db_query($this->link, "SELECT title, link - FROM ttrss_entries, ttrss_user_entries - WHERE id = '$id' AND ref_id = id AND owner_uid = " .$_SESSION['uid']); - - if (db_num_rows($result) != 0) { - $title = truncate_string(strip_tags(db_fetch_result($result, 0, 'title')), - 100, '...'); - $article_link = db_fetch_result($result, 0, 'link'); - } - - print json_encode(array("title" => $title, "link" => $article_link, - "id" => $id)); - } - - -} -?> diff --git a/classes/feeds.php b/classes/feeds.php index 49adf3879..a90b1c8ed 100644 --- a/classes/feeds.php +++ b/classes/feeds.php @@ -249,7 +249,7 @@ class Feeds extends Handler_Protected { $headlines_count = db_num_rows($result); - if (get_pref($this->link, 'COMBINED_DISPLAY_MODE')) { + /* if (get_pref($this->link, 'COMBINED_DISPLAY_MODE')) { $button_plugins = array(); foreach (explode(",", ARTICLE_BUTTON_PLUGINS) as $p) { $pclass = "button_" . trim($p); @@ -259,7 +259,9 @@ class Feeds extends Handler_Protected { array_push($button_plugins, $plugin); } } - } + } */ + + global $pluginhost; if (db_num_rows($result) > 0) { @@ -706,8 +708,8 @@ class Feeds extends Handler_Protected { //$note_escaped = htmlspecialchars($line['note'], ENT_QUOTES); - foreach ($button_plugins as $p) { - $reply['content'] .= $p->render($id, $line); + foreach ($pluginhost->get_hooks($pluginhost::HOOK_ARTICLE_BUTTON) as $p) { + $reply['content'] .= $p->hook_article_button($line); } $reply['content'] .= "link = $link; - } - - function filter_article($article) { - return $article; - } - -} -?> diff --git a/classes/pluginhandler.php b/classes/pluginhandler.php new file mode 100644 index 000000000..df7058dcd --- /dev/null +++ b/classes/pluginhandler.php @@ -0,0 +1,18 @@ +get_plugin($_REQUEST["plugin"]); + + if (method_exists($plugin, $method)) { + $plugin->$method(); + } + } +} + +?> diff --git a/classes/pluginhost.php b/classes/pluginhost.php new file mode 100644 index 000000000..4274ec37b --- /dev/null +++ b/classes/pluginhost.php @@ -0,0 +1,71 @@ +link = $link; + } + + private function register_plugin($name, $plugin) { + //array_push($this->plugins, $plugin); + $this->plugins[$name] = $plugin; + } + + function get_link() { + return $this->link; + } + + function get_plugins() { + return $this->plugins; + } + + function get_plugin($name) { + return $this->plugins[$name]; + } + + 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) { + return $this->hooks[$type]; + } + + function load($classlist) { + $plugins = explode(",", $classlist); + + foreach ($plugins as $class) { + $class = trim($class); + $class_file = str_replace("_", "/", strtolower(basename($class))); + $file = dirname(__FILE__)."/../plugins/$class_file/$class_file.php"; + + if (file_exists($file)) require_once $file; + + if (class_exists($class)) { + $plugin = new $class($this); + + $this->register_plugin($class, $plugin); + } + } + } + +} +?> diff --git a/classes/rpc.php b/classes/rpc.php index 984187915..2bec8c54a 100644 --- a/classes/rpc.php +++ b/classes/rpc.php @@ -706,7 +706,7 @@ class RPC extends Handler_Protected { print json_encode(array("status" => $status)); } - function buttonPlugin() { + /* function buttonPlugin() { $pclass = "button_" . basename($_REQUEST['plugin']); $method = $_REQUEST['plugin_method']; @@ -716,7 +716,7 @@ class RPC extends Handler_Protected { return $plugin->$method(); } } - } + } */ function genHash() { $hash = sha1(uniqid(rand(), true)); diff --git a/config.php-dist b/config.php-dist index 53f5dc87b..2975d680a 100644 --- a/config.php-dist +++ b/config.php-dist @@ -176,16 +176,13 @@ // if you experience weird errors and tt-rss failing to start, blank pages // after login, or content encoding errors, disable it. + define('PLUGINS', ''); + // Plugins to load. Check plugins/ directory for additional information. + define('FEEDBACK_URL', ''); // Displays an URL for users to provide feedback or comments regarding // this instance of tt-rss. Can lead to a forum, contact email, etc. - define('ARTICLE_BUTTON_PLUGINS', 'note,tweet,share,mail'); - // Comma-separated list of additional article action button plugins - // to enable, like tweet button, etc. - // The following plugins are available: note, tweet, share, mail - // More plugins: http://tt-rss.org/wiki/Plugins - define('CONFIG_VERSION', 26); // Expected config version. Please update this option in config.php // if necessary (after migrating all new options from this file). diff --git a/images/art-tweet.png b/images/art-tweet.png deleted file mode 100644 index ad3c177a2d9e0e17f9a456aeb4bb86fff9e7be97..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 159 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!93?!50ihlx9Ea{HEjtmSN`?>!lvI6-$0X`wF zKw5qNG2=7;f#BDY7A+v3u_VYZn8D%MjWi&~(9^{+gyVX0LId-)HB%XR-u(X`pO8?` ztFj~hfBk_2f3r+`7>XYzz1bfY-=M*k-OS7|ce3nuM-}EMpk@Y7S3j3^P6Z"; - $button_plugins = explode(",", ARTICLE_BUTTON_PLUGINS); + global $pluginhost; - foreach ($button_plugins as $p) { - $pclass = "button_" . trim($p); - - if (class_exists($pclass)) { - $plugin = new $pclass($link); - $rv['content'] .= $plugin->render($id, $line); - } + foreach ($pluginhost->get_hooks($pluginhost::HOOK_ARTICLE_BUTTON) as $p) { + $rv['content'] .= $p->hook_article_button($line); } $rv['content'] .= "load(PLUGINS); + return true; } else { print "Unable to connect to database:" . db_last_error(); diff --git a/include/rssfuncs.php b/include/rssfuncs.php index f844aaeb9..4a5bd7680 100644 --- a/include/rssfuncs.php +++ b/include/rssfuncs.php @@ -399,23 +399,6 @@ _debug("update_rss_feed: " . count($filters) . " filters loaded."); } - $filter_plugins = array(); - - if (defined('_ARTICLE_FILTER_PLUGINS')) { - foreach (explode(",", _ARTICLE_FILTER_PLUGINS) as $p) { - $pclass = "filter_" . trim($p); - - if (class_exists($pclass)) { - $plugin = new $pclass($link); - array_push($filter_plugins, $plugin); - } - } - } - - if ($debug_enabled) { - _debug("update_rss_feed: " . count($filter_plugins) . " filter plugins loaded."); - } - if ($use_simplepie) { $iterator = $rss->get_items(); } else { @@ -782,7 +765,9 @@ } // TODO: less memory-hungry implementation - if (count($filter_plugins) > 0) { + global $pluginhost; + + foreach ($pluginhost->get_hooks($pluginhost::HOOK_ARTICLE_FILTER) as $p) { if ($debug_enabled) { _debug("update_rss_feed: applying plugin filters..."); } @@ -795,7 +780,7 @@ "author" => $entry_author); foreach ($filter_plugins as $plugin) { - $article = $plugin->filter_article($article); + $article = $plugin->hook_article_filter($article); } $entry_title = $article["title"]; diff --git a/include/sanity_config.php b/include/sanity_config.php index c0626243d..475f81f1b 100644 --- a/include/sanity_config.php +++ b/include/sanity_config.php @@ -1,3 +1,3 @@ - +$requred_defines = array( 'DB_TYPE', 'DB_HOST', 'DB_USER', 'DB_NAME', 'DB_PASS', 'MYSQL_CHARSET', 'SELF_URL_PATH', 'SINGLE_USER_MODE', 'PHP_EXECUTABLE', 'LOCK_DIRECTORY', 'CACHE_DIR', 'ICONS_DIR', 'ICONS_URL', 'AUTH_MODULES', 'AUTH_AUTO_CREATE', 'AUTH_AUTO_LOGIN', 'DEFAULT_UPDATE_METHOD', 'FORCE_ARTICLE_PURGE', 'PUBSUBHUBBUB_HUB', 'PUBSUBHUBBUB_ENABLED', 'SPHINX_ENABLED', 'SPHINX_INDEX', 'ENABLE_REGISTRATION', 'REG_NOTIFY_ADDRESS', 'REG_MAX_USERS', 'SESSION_COOKIE_LIFETIME', 'SESSION_EXPIRE_TIME', 'SESSION_CHECK_ADDRESS', 'SMTP_FROM_NAME', 'SMTP_FROM_ADDRESS', 'DIGEST_SUBJECT', 'SMTP_HOST', 'SMTP_LOGIN', 'SMTP_PASSWORD', 'CHECK_FOR_NEW_VERSION', 'ENABLE_GZIP_OUTPUT', 'FEEDBACK_URL', 'CONFIG_VERSION'); ?> diff --git a/index.php b/index.php index 445a8fa75..d958e2b89 100644 --- a/index.php +++ b/index.php @@ -71,10 +71,11 @@ get_plugins() as $n => $p) { + if (method_exists($p, "get_js")) { + echo JSMin::minify($p->get_js()); } } diff --git a/js/tweet_button.js b/js/tweet_button.js deleted file mode 100644 index d127010ac..000000000 --- a/js/tweet_button.js +++ /dev/null @@ -1,31 +0,0 @@ - function tweetArticle(id) { - try { - var query = "?op=rpc&method=buttonPlugin&plugin=tweet&plugin_method=getTweetInfo&id=" + param_escape(id); - - console.log(query); - - var d = new Date(); - var ts = d.getTime(); - - var w = window.open('backend.php?op=backend&method=loading', 'ttrss_tweet', - "status=0,toolbar=0,location=0,width=500,height=400,scrollbars=1,menubar=0"); - - new Ajax.Request("backend.php", { - parameters: query, - onComplete: function(transport) { - var ti = JSON.parse(transport.responseText); - - var share_url = "http://twitter.com/share?_=" + ts + - "&text=" + param_escape(ti.title) + - "&url=" + param_escape(ti.link); - - w.location.href = share_url; - - } }); - - - } catch (e) { - exception_error("tweetArticle", e); - } - } - diff --git a/plugins/mail/README.txt b/plugins/mail/README.txt new file mode 100644 index 000000000..d499a5de8 --- /dev/null +++ b/plugins/mail/README.txt @@ -0,0 +1 @@ +Shares article by email diff --git a/js/mail_button.js b/plugins/mail/mail.js similarity index 85% rename from js/mail_button.js rename to plugins/mail/mail.js index 0fcb0d80f..39f753cc0 100644 --- a/js/mail_button.js +++ b/plugins/mail/mail.js @@ -14,7 +14,7 @@ function emailArticle(id) { if (dijit.byId("emailArticleDlg")) dijit.byId("emailArticleDlg").destroyRecursive(); - var query = "backend.php?op=rpc&method=buttonPlugin&plugin=mail&plugin_method=emailArticle¶m=" + param_escape(id); + var query = "backend.php?op=pluginhandler&plugin=mail&method=emailArticle¶m=" + param_escape(id); dialog = new dijit.Dialog({ id: "emailArticleDlg", @@ -47,7 +47,7 @@ function emailArticle(id) { dojo.disconnect(tmph); new Ajax.Autocompleter('emailArticleDlg_destination', 'emailArticleDlg_dst_choices', - "backend.php?op=rpc&method=buttonPlugin&plugin=mail&plugin_method=completeEmails", + "backend.php?op=pluginhandler&plugin=mail&method=completeEmails", { tokens: '', paramName: "search" }); }); diff --git a/classes/button/mail.php b/plugins/mail/mail.php similarity index 90% rename from classes/button/mail.php rename to plugins/mail/mail.php index 309493bbe..a633d815f 100644 --- a/classes/button/mail.php +++ b/plugins/mail/mail.php @@ -1,9 +1,24 @@ link = $host->get_link(); + $this->host = $host; + + $host->add_hook($host::HOOK_ARTICLE_BUTTON, $this); + } + + function get_js() { + return file_get_contents(dirname(__FILE__) . "/mail.js"); + } + + function hook_article_button($line) { + return "Zoom"; } @@ -16,10 +31,9 @@ class Button_Mail extends Button { $_SESSION['email_secretkey'] = $secretkey; print ""; - print ""; - print ""; + print ""; print ""; - print ""; + print ""; $result = db_query($this->link, "SELECT email, full_name FROM ttrss_users WHERE id = " . $_SESSION["uid"]); diff --git a/images/art-email.png b/plugins/mail/mail.png similarity index 100% rename from images/art-email.png rename to plugins/mail/mail.png diff --git a/plugins/note/README.txt b/plugins/note/README.txt new file mode 100644 index 000000000..1efec8f02 --- /dev/null +++ b/plugins/note/README.txt @@ -0,0 +1 @@ +Support for article notes diff --git a/js/note_button.js b/plugins/note/note.js similarity index 89% rename from js/note_button.js rename to plugins/note/note.js index c9347ab19..022fc88e7 100644 --- a/js/note_button.js +++ b/plugins/note/note.js @@ -1,7 +1,7 @@ function editArticleNote(id) { try { - var query = "backend.php?op=rpc&method=buttonPlugin&plugin=note&plugin_method=edit¶m=" + param_escape(id); + var query = "backend.php?op=pluginhandler&plugin=note&method=edit¶m=" + param_escape(id); if (dijit.byId("editNoteDlg")) dijit.byId("editNoteDlg").destroyRecursive(); diff --git a/classes/button/note.php b/plugins/note/note.php similarity index 71% rename from classes/button/note.php rename to plugins/note/note.php index d5b6e380c..a856b5ac8 100644 --- a/classes/button/note.php +++ b/plugins/note/note.php @@ -1,10 +1,25 @@ link, "images/art-pub-note.png")."\" - style=\"cursor : pointer\" style=\"cursor : pointer\" - onclick=\"editArticleNote($article_id)\" - class='tagsPic' title='".__('Edit article note')."'>"; +class Note { + private $link; + private $host; + + function __construct($host) { + $this->link = $host->get_link(); + $this->host = $host; + + $host->add_hook($host::HOOK_ARTICLE_BUTTON, $this); + } + + function get_js() { + return file_get_contents(dirname(__FILE__) . "/note.js"); + } + + + function hook_article_button($line) { + return "link, "plugins/note/note.png")."\" + style=\"cursor : pointer\" style=\"cursor : pointer\" + onclick=\"editArticleNote(".$line["id"].")\" + class='tagsPic' title='".__('Edit article note')."'>"; } function edit() { @@ -16,10 +31,9 @@ class Button_Note extends Button { $note = db_fetch_result($result, 0, "note"); print ""; - print ""; - print ""; + print ""; + print ""; print ""; - print ""; print "
"; print "