X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fplugin.php;h=74ddbea134633c8056581f57d9a3533fe0660707;hp=a891ac93f53295e83f248f7f46bddc2568fe9206;hb=0db60ced010cea3a14b2b3fc225692e5f2d6a272;hpb=8266f7af96f6983e3346ab701bf7b807561e73f3 diff --git a/functions/plugin.php b/functions/plugin.php index a891ac93..74ddbea1 100644 --- a/functions/plugin.php +++ b/functions/plugin.php @@ -21,73 +21,80 @@ function use_plugin ($name) { if (file_exists(SM_PATH . "plugins/$name/setup.php")) { include_once(SM_PATH . "plugins/$name/setup.php"); - $function = "squirrelmail_plugin_init_$name"; - if (function_exists($function)) { - $function(); - } - } -} - -/** - * This function executes a hook. - * @param string $name Name of hook to fire - * @return mixed $data - */ -function do_hook ($name) { - global $squirrelmail_plugin_hooks, $currentHookName; - $data = func_get_args(); - $currentHookName = $name; - if (isset($squirrelmail_plugin_hooks[$name]) - && is_array($squirrelmail_plugin_hooks[$name])) { - foreach ($squirrelmail_plugin_hooks[$name] as $function) { - /* Add something to set correct gettext domain for plugin. */ - if (function_exists($function)) { - $function($data); - } - } + /** + * As of SM 1.5.2, plugin hook registration is statically + * accomplished using the configuration utility (config/conf.pl). + * And this code is deprecated (but let's keep it until + * the new registration system is proven). + * + */ + //$function = "squirrelmail_plugin_init_$name"; + //if (function_exists($function)) { + // $function(); + //} } - - $currentHookName = ''; - - /* Variable-length argument lists have a slight problem when */ - /* passing values by reference. Pity. This is a workaround. */ - return $data; } /** - * This function executes a hook and allows for parameters to be passed. + * This function executes a plugin hook. + * + * It includes an arbitrary return value that is managed by + * all plugins on the same hook and returned to the core hook + * location. + * + * The desired format of the return value should be defined + * by the context in which the hook is called. + * + * Note that the master return value for this hook is passed + * to each plugin after the main argument(s) value/array as a + * convenience only - to show what the current return value is + * even though it is liable to be changed by other plugins. + * + * If any plugin on this hook wants to modify the $args + * plugin parameter, it simply has to use call-by-reference + * syntax in the hook function that it has registered for the + * current hook. Note that this is in addition to (entirely + * independent of) the return value for this hook. + * + * @param string $name Name of hook being executed + * @param mixed $args A single value or an array of arguments + * that are to be passed to all plugins + * operating off the hook being called. + * Note that this argument is passed by + * reference thus it is liable to be + * changed after the hook completes. + * + * @return mixed The return value that is managed by the plugins + * on the current hook. * - * @param string name the name of the hook - * @param mixed param the parameters to pass to the hook function - * @return mixed the return value of the hook function */ -function do_hook_function($name,$parm=NULL) { +function do_hook($name, &$args) { + global $squirrelmail_plugin_hooks, $currentHookName; - $ret = ''; $currentHookName = $name; + $ret = NULL; if (isset($squirrelmail_plugin_hooks[$name]) && is_array($squirrelmail_plugin_hooks[$name])) { - foreach ($squirrelmail_plugin_hooks[$name] as $function) { - /* Add something to set correct gettext domain for plugin. */ + foreach ($squirrelmail_plugin_hooks[$name] as $plugin_name => $function) { + use_plugin($plugin_name); if (function_exists($function)) { - $ret = $function($parm); + $ret = $function($args, $ret); } } } $currentHookName = ''; - - /* Variable-length argument lists have a slight problem when */ - /* passing values by reference. Pity. This is a workaround. */ return $ret; + } /** - * This function executes a hook, allows for parameters to be passed, - * and looks for an array returned from each plugin: each array is - * then merged into one and returned to the core hook location. + * This function executes a hook that allows for an arbitrary + * return value from each plugin that will be merged into one + * array (or one string if all return values are strings) and + * returned to the core hook location. * * Note that unlike PHP's array_merge function, matching array keys * will not overwrite each other, instead, values under such keys @@ -97,41 +104,61 @@ function do_hook_function($name,$parm=NULL) { * Plugins returning non-arrays (strings, objects, etc) will have * their output added to the end of the ultimate return array, * unless ALL values returned are strings, in which case one string - * with all returned strings concatenated together is returned. + * with all returned strings concatenated together is returned + * (unless $force_array is TRUE). + * + * If any plugin on this hook wants to modify the $args + * plugin parameter, it simply has to use call-by-reference + * syntax in the hook function that it has registered for the + * current hook. Note that this is in addition to (entirely + * independent of) the return value for this hook. * - * @param string name the name of the hook - * @param mixed param the parameters to pass to the hook function + * @param string $name Name of hook being executed + * @param mixed $args A single value or an array of arguments + * that are to be passed to all plugins + * operating off the hook being called. + * Note that this argument is passed by + * reference thus it is liable to be + * changed after the hook completes. + * @param boolean $force_array When TRUE, guarantees the return + * value will ALWAYS be an array, + * (simple strings will be forced + * into a one-element array). + * When FALSE, behavior is as + * described above (OPTIONAL; + * default behavior is to return + * mixed - array or string). * * @return mixed the merged return arrays or strings of each - * plugin on this hook + * plugin on this hook. * */ -function concat_hook_function($name,$parm=NULL) { +function concat_hook_function($name, &$args, $force_array=FALSE) { + global $squirrelmail_plugin_hooks, $currentHookName; -// $ret = ''; - $ret = array(); $currentHookName = $name; + $ret = ''; if (isset($squirrelmail_plugin_hooks[$name]) && is_array($squirrelmail_plugin_hooks[$name])) { - foreach ($squirrelmail_plugin_hooks[$name] as $function) { - /* Add something to set correct gettext domain for plugin. */ + foreach ($squirrelmail_plugin_hooks[$name] as $plugin_name => $function) { + use_plugin($plugin_name); if (function_exists($function)) { -// $ret .= $function($parm); - $ret = sqm_array_merge($ret, $function($parm)); + $plugin_ret = $function($args); + if (!empty($plugin_ret)) { + $ret = sqm_array_merge($ret, $plugin_ret); + } } } } - $currentHookName = ''; + if ($force_array && is_string($ret)) { + $ret = array($ret); + } - /* Variable-length argument lists have a slight problem when */ - /* passing values by reference. Pity. This is a workaround. */ - // FIXME: empty return array breaks legacy use of this hook, so - // as a workaround, return empty string (let's fix the - // hook calls so we can pull this out) - if (empty($ret)) return ''; + $currentHookName = ''; return $ret; + } /** @@ -141,13 +168,27 @@ function concat_hook_function($name,$parm=NULL) { * override any trues. * Priority 0 means majority rules. Ties will be broken with $tie * - * @param string name the hook name - * @param mixed parm the parameters for the hook function - * @param int priority - * @param bool tie - * @return bool the result of the function + * If any plugin on this hook wants to modify the $args + * plugin parameter, it simply has to use call-by-reference + * syntax in the hook function that it has registered for the + * current hook. Note that this is in addition to (entirely + * independent of) the return value for this hook. + * + * @param string $name The hook name + * @param mixed $args A single value or an array of arguments + * that are to be passed to all plugins + * operating off the hook being called. + * Note that this argument is passed by + * reference thus it is liable to be + * changed after the hook completes. + * @param int $priority See explanation above + * @param boolean $tie See explanation above + * + * @return boolean The result of the function + * */ -function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) { +function boolean_hook_function($name, &$args, $priority=0, $tie=false) { + global $squirrelmail_plugin_hooks, $currentHookName; $yea = 0; $nay = 0; @@ -158,9 +199,10 @@ function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) { /* Loop over the plugins that registered the hook */ $currentHookName = $name; - foreach ($squirrelmail_plugin_hooks[$name] as $function) { + foreach ($squirrelmail_plugin_hooks[$name] as $plugin_name => $function) { + use_plugin($plugin_name); if (function_exists($function)) { - $ret = $function($parm); + $ret = $function($args); if ($ret) { $yea++; } else { @@ -186,14 +228,16 @@ function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) { } // If the code gets here, there was a problem - no hooks, etc. return NULL; + } /** + * Do not use, use checkForJavascript() instead. + * * This function checks whether the user's USER_AGENT is known to * be broken. If so, returns true and the plugin is invisible to the * offending browser. * *** THIS IS A TEST FOR JAVASCRIPT SUPPORT *** - * FIXME: This function needs to have its name changed! * * @return bool whether this browser properly supports JavaScript * @deprecated use checkForJavascript() since 1.5.1