2 // PukiWiki - Yet another WikiWikiWeb clone.
5 // 2002-2016 PukiWiki Development Team
6 // 2001-2002 Originally written by yu-ji
7 // License: GPL v2 or (at your option) any later version
9 // Plugin related functions
11 define('PKWK_PLUGIN_CALL_TIME_LIMIT', 768);
13 // Set global variables for plugins
14 function set_plugin_messages($messages)
16 foreach ($messages as $name=>$val)
17 if (! isset($GLOBALS[$name]))
18 $GLOBALS[$name] = $val;
21 // Check plugin '$name' is here
22 function exist_plugin($name)
25 static $exist = array(), $count = array();
27 $name = strtolower($name);
28 if(isset($exist[$name])) {
29 if (++$count[$name] > PKWK_PLUGIN_CALL_TIME_LIMIT)
30 die('Alert: plugin "' . htmlsc($name) .
31 '" was called over ' . PKWK_PLUGIN_CALL_TIME_LIMIT .
32 ' times. SPAM or someting?<br />' . "\n" .
33 '<a href="' . get_base_uri() . '?cmd=edit&page='.
34 rawurlencode($vars['page']) . '">Try to edit this page</a><br />' . "\n" .
35 '<a href="' . get_base_uri() . '">Return to frontpage</a>');
39 if (preg_match('/^\w{1,64}$/', $name) &&
40 file_exists(PLUGIN_DIR . $name . '.inc.php')) {
43 require_once(PLUGIN_DIR . $name . '.inc.php');
46 $exist[$name] = FALSE;
52 // Check if plugin API 'action' exists
53 function exist_plugin_action($name) {
54 return function_exists('plugin_' . $name . '_action') ? TRUE : exist_plugin($name) ?
55 function_exists('plugin_' . $name . '_action') : FALSE;
58 // Check if plugin API 'convert' exists
59 function exist_plugin_convert($name) {
60 return function_exists('plugin_' . $name . '_convert') ? TRUE : exist_plugin($name) ?
61 function_exists('plugin_' . $name . '_convert') : FALSE;
64 // Check if plugin API 'inline' exists
65 function exist_plugin_inline($name) {
66 return function_exists('plugin_' . $name . '_inline') ? TRUE : exist_plugin($name) ?
67 function_exists('plugin_' . $name . '_inline') : FALSE;
70 // Call 'init' function for the plugin
71 // NOTE: Returning FALSE means "An erorr occurerd"
72 function do_plugin_init($name)
74 static $done = array();
76 if (! isset($done[$name])) {
77 $func = 'plugin_' . $name . '_init';
78 $done[$name] = (! function_exists($func) || call_user_func($func) !== FALSE);
84 // Call API 'action' of the plugin
85 function do_plugin_action($name)
87 if (! exist_plugin_action($name)) return array();
89 if (do_plugin_init($name) === FALSE) {
90 die_message('Plugin init failed: ' . htmlsc($name));
93 $retvar = call_user_func('plugin_' . $name . '_action');
95 // Insert a hidden field, supports idenrtifying text enconding
96 if (PKWK_ENCODING_HINT != '')
97 $retvar = preg_replace('/(<form[^>]*>)/', '$1' . "\n" .
98 '<div><input type="hidden" name="encode_hint" value="' .
99 PKWK_ENCODING_HINT . '" /></div>', $retvar);
104 // Call API 'convert' of the plugin
105 function do_plugin_convert($name, $args = '')
109 if (do_plugin_init($name) === FALSE) {
110 return '[Plugin init failed: ' . htmlsc($name) . ']';
113 if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK) {
115 $pos = strpos($args, "\r"); // "\r" is just a delimiter
116 if ($pos !== FALSE) {
117 $body = substr($args, $pos + 1);
118 $args = substr($args, 0, $pos);
123 $aryargs = array(); // #plugin()
125 $aryargs = csv_explode(',', $args); // #plugin(A,B,C,D)
127 if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK) {
128 if (isset($body)) $aryargs[] = & $body; // #plugin(){{body}}
132 $retvar = call_user_func_array('plugin_' . $name . '_convert', $aryargs);
133 $digest = $_digest; // Revert
135 if ($retvar === FALSE) {
136 return htmlsc('#' . $name .
137 ($args != '' ? '(' . $args . ')' : ''));
138 } else if (PKWK_ENCODING_HINT != '') {
139 // Insert a hidden field, supports idenrtifying text enconding
140 return preg_replace('/(<form[^>]*>)/', '$1 ' . "\n" .
141 '<div><input type="hidden" name="encode_hint" value="' .
142 PKWK_ENCODING_HINT . '" /></div>', $retvar);
148 // Call API 'inline' of the plugin
149 function do_plugin_inline($name, $args, & $body)
153 if (do_plugin_init($name) === FALSE) {
154 return '[Plugin init failed: ' . htmlsc($name) . ']';
160 $aryargs = csv_explode(',', $args);
163 // NOTE: A reference of $body is always the last argument
164 $aryargs[] = & $body; // func_num_args() != 0
167 $retvar = call_user_func_array('plugin_' . $name . '_inline', $aryargs);
168 $digest = $_digest; // Revert
170 if($retvar === FALSE) {
172 return htmlsc('&' . $name . ($args ? '(' . $args . ')' : '') . ';');