experimental: auto-generate and add all plugin hook methods to Plugin class
This commit is contained in:
Andrew Dolgov
parent
8a83f061bf
commit
b381e95792
|
|
@ -58,4 +58,198 @@ abstract class Plugin {
|
|||
return vsprintf($this->__($msgid), $args);
|
||||
}
|
||||
|
||||
/* plugin hook methods (auto-generated) */
|
||||
|
||||
function hook_article_button($line) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_article_filter($article) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_prefs_tab($tab) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_prefs_tab_section($section) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_prefs_tabs() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_feed_parsed($parser, $feed_id) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_update_task($cli_options) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_auth_user($login, $password, $service) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_hotkey_map($hotkeys) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_render_article($article) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_render_article_cdm($article) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_feed_fetched($feed_data, $fetch_url, $owner_uid, $feed) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_render_article_api($params) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_toolbar_button() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_action_item() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_headline_toolbar_button($feed_id, $is_cat) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_hotkey_info($hotkeys) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_article_left_button($row) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_prefs_edit_feed($feed_id) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_prefs_save_feed($feed_id) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
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);
|
||||
}
|
||||
|
||||
function hook_query_headlines($row) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_house_keeping() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_search($query) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_format_enclosures($rv, $result, $id, $always_display_enclosures, $article_content, $hide_images) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_subscribe_feed($contents, $url, $auth_login, $auth_pass) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_headlines_before($feed, $is_cat, $qfh_ret) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_render_enclosure($entry, $id, $rv) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_article_filter_action($article, $action) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_article_export_feed($line, $feed, $is_cat, $owner_uid) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_main_toolbar_button() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_enclosure_entry($entry, $id, $rv) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_format_article($html, $row) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
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);
|
||||
}
|
||||
|
||||
function hook_send_local_file($filename) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_unsubscribe_feed($feed_id, $owner_uid) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_send_mail(Mailer $mailer, $params) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_filter_triggered($feed_id, $owner_uid, $article, $matched_filters, $matched_rules, $article_filters) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_get_full_text($url) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_article_image($enclosures, $content, $site_url) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_feed_tree() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_iframe_whitelisted($url) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_enclosure_imported($enclosure, $feed) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_headlines_custom_sort_map() {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_headlines_custom_sort_override($order) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_headline_toolbar_select_menu_item($feed_id, $is_cat) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
function hook_pre_subscribe($url, $auth_login, $auth_pass) {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,62 @@
|
|||
<?php
|
||||
abstract class Plugin {
|
||||
const API_VERSION_COMPAT = 1;
|
||||
|
||||
/** @var PDO $pdo */
|
||||
protected $pdo;
|
||||
|
||||
abstract function init(PluginHost $host);
|
||||
|
||||
abstract function about();
|
||||
// return array(1.0, "plugin", "No description", "No author", false);
|
||||
|
||||
function __construct() {
|
||||
$this->pdo = Db::pdo();
|
||||
}
|
||||
|
||||
function flags() {
|
||||
/* associative array, possible keys:
|
||||
needs_curl = boolean
|
||||
*/
|
||||
return array();
|
||||
}
|
||||
|
||||
function is_public_method($method) {
|
||||
return false;
|
||||
}
|
||||
|
||||
function csrf_ignore($method) {
|
||||
return false;
|
||||
}
|
||||
|
||||
function get_js() {
|
||||
return "";
|
||||
}
|
||||
|
||||
function get_prefs_js() {
|
||||
return "";
|
||||
}
|
||||
|
||||
function api_version() {
|
||||
return Plugin::API_VERSION_COMPAT;
|
||||
}
|
||||
|
||||
/* gettext-related helpers */
|
||||
|
||||
function __($msgid) {
|
||||
return _dgettext(PluginHost::object_to_domain($this), $msgid);
|
||||
}
|
||||
|
||||
function _ngettext($singular, $plural, $number) {
|
||||
return _dngettext(PluginHost::object_to_domain($this), $singular, $plural, $number);
|
||||
}
|
||||
|
||||
function T_sprintf() {
|
||||
$args = func_get_args();
|
||||
$msgid = array_shift($args);
|
||||
|
||||
return vsprintf($this->__($msgid), $args);
|
||||
}
|
||||
|
||||
/** AUTO_GENERATED_HOOKS_GO_HERE **/
|
||||
}
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
#!/bin/sh
|
||||
|
||||
TMPFILE=$(mktemp)
|
||||
|
||||
grep 'hook_.*(' ../classes/pluginhost.php | sed -e 's#[\t ]*/[* ]*##' \
|
||||
-e 's# [*]/$##' \
|
||||
-e 's# *(byref) *##' \
|
||||
-e 's#GLOBAL: ##' | while read F; do
|
||||
|
||||
cat << EOF >> $TMPFILE
|
||||
function $F {
|
||||
user_error("Dummy method invoked.", E_USER_ERROR);
|
||||
}
|
||||
|
||||
EOF
|
||||
done
|
||||
|
||||
cat ../classes/plugin.tpl | while IFS=\n read L; do
|
||||
case $L in
|
||||
*AUTO_GENERATED_HOOKS_GO_HERE* )
|
||||
echo "\t/* plugin hook methods (auto-generated) */\n"
|
||||
cat $TMPFILE
|
||||
;;
|
||||
* )
|
||||
echo "$L"
|
||||
;;
|
||||
esac
|
||||
done > ../classes/plugin.php
|
||||
|
||||
rm -f -- $TMPFILE
|
||||
Loading…
Reference in New Issue