lib/plugin.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone.
   3 // plugin.php
   4 // Copyright
   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
   8 //
   9 // Plugin related functions
  10
  11 define('PKWK_PLUGIN_CALL_TIME_LIMIT', 768);
  12
  13 // Set global variables for plugins
  14 function set_plugin_messages($messages)
  15 {
  16         foreach ($messages as $name=>$val)
  17                 if (! isset($GLOBALS[$name]))
  18                         $GLOBALS[$name] = $val;
  19 }
  20
  21 // Check plugin '$name' is here
  22 function exist_plugin($name)
  23 {
  24         global $vars;
  25         static $exist = array(), $count = array();
  26
  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&amp;page='.
  34                         rawurlencode($vars['page']) . '">Try to edit this page</a><br />' . "\n" .
  35                         '<a href="' . get_base_uri() . '">Return to frontpage</a>');
  36                 return $exist[$name];
  37         }
  38
  39         if (preg_match('/^\w{1,64}$/', $name) &&
  40             file_exists(PLUGIN_DIR . $name . '.inc.php')) {
  41                 $exist[$name] = TRUE;
  42                 $count[$name] = 1;
  43                 require_once(PLUGIN_DIR . $name . '.inc.php');
  44                 return TRUE;
  45         } else {
  46                 $exist[$name] = FALSE;
  47                 $count[$name] = 1;
  48                 return FALSE;
  49         }
  50 }
  51
  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;
  56 }
  57
  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;
  62 }
  63
  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;
  68 }
  69
  70 // Call 'init' function for the plugin
  71 // NOTE: Returning FALSE means "An erorr occurerd"
  72 function do_plugin_init($name)
  73 {
  74         static $done = array();
  75
  76         if (! isset($done[$name])) {
  77                 $func = 'plugin_' . $name . '_init';
  78                 $done[$name] = (! function_exists($func) || call_user_func($func) !== FALSE);
  79         }
  80
  81         return $done[$name];
  82 }
  83
  84 // Call API 'action' of the plugin
  85 function do_plugin_action($name)
  86 {
  87         if (! exist_plugin_action($name)) return array();
  88
  89         if (do_plugin_init($name) === FALSE) {
  90                 die_message('Plugin init failed: ' . htmlsc($name));
  91         }
  92
  93         $retvar = call_user_func('plugin_' . $name . '_action');
  94
  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);
 100
 101         return $retvar;
 102 }
 103
 104 // Call API 'convert' of the plugin
 105 function do_plugin_convert($name, $args = '')
 106 {
 107         global $digest;
 108
 109         if (do_plugin_init($name) === FALSE) {
 110                 return '[Plugin init failed: ' . htmlsc($name) . ']';
 111         }
 112
 113         if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK) {
 114                 // Multiline plugin?
 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);
 119                 }
 120         }
 121
 122         if ($args === '') {
 123                 $aryargs = array();                 // #plugin()
 124         } else {
 125                 $aryargs = csv_explode(',', $args); // #plugin(A,B,C,D)
 126         }
 127         if (! PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK) {
 128                 if (isset($body)) $aryargs[] = & $body;     // #plugin(){{body}}
 129         }
 130
 131         $_digest = $digest;
 132         $retvar  = call_user_func_array('plugin_' . $name . '_convert', $aryargs);
 133         $digest  = $_digest; // Revert
 134
 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);
 143         } else {
 144                 return $retvar;
 145         }
 146 }
 147
 148 // Call API 'inline' of the plugin
 149 function do_plugin_inline($name, $args, & $body)
 150 {
 151         global $digest;
 152
 153         if (do_plugin_init($name) === FALSE) {
 154                 return '[Plugin init failed: ' . htmlsc($name) . ']';
 155         }
 156
 157         if ($args === '') {
 158                 $aryargs = array();
 159         } else {
 160                 $aryargs = csv_explode(',', $args);
 161         }
 162
 163         // NOTE: A reference of $body is always the last argument
 164         $aryargs[] = & $body; // func_num_args() != 0
 165
 166         $_digest = $digest;
 167         $retvar  = call_user_func_array('plugin_' . $name . '_inline', $aryargs);
 168         $digest  = $_digest; // Revert
 169
 170         if($retvar === FALSE) {
 171                 // Do nothing
 172                 return htmlsc('&' . $name . ($args ? '(' . $args . ')' : '') . ';');
 173         } else {
 174                 return $retvar;
 175         }
 176 }