X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fplugin.php;h=ab8d518464a03a31ca42146c1bdc21c6d977cc9d;hb=2cc2227dc89e66e8c3de39d627e25afa28139072;hp=df8d37098aa6a996703c735c0e99fe5dc9386e95;hpb=355861846a51d35efe50848869d680fd3b4a5316;p=squirrelmail.git diff --git a/functions/plugin.php b/functions/plugin.php index df8d3709..ab8d5184 100644 --- a/functions/plugin.php +++ b/functions/plugin.php @@ -3,74 +3,236 @@ /** * plugin.php * - * Copyright (c) 1999-2001 The SquirrelMail Development Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * This file provides the framework for a plugin architecture. * * Documentation on how to write plugins might show up some time. * - * $Id$ + * @copyright © 1999-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail */ -/*****************************************************************/ -/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/ -/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/ -/*** + Base level indent should begin at left margin, as ***/ -/*** the $squirrelmail_plugin_hooks stuff below. ***/ -/*** + All identation should consist of four space blocks ***/ -/*** + Tab characters are evil. ***/ -/*** + all comments should use "slash-star ... star-slash" ***/ -/*** style -- no pound characters, no slash-slash style ***/ -/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/ -/*** ALWAYS USE { AND } CHARACTERS!!! ***/ -/*** + Please use ' instead of ", when possible. Note " ***/ -/*** should always be used in _( ) function calls. ***/ -/*** Thank you for your help making the SM code more readable. ***/ -/*****************************************************************/ +/** Everything needs global.. */ +require_once(SM_PATH . 'functions/global.php'); +require_once(SM_PATH . 'config/config.php'); +require_once(SM_PATH . 'functions/prefs.php'); global $squirrelmail_plugin_hooks; -squirrelmail_plugin_hooks = array(); +$squirrelmail_plugin_hooks = array(); - // This function adds a plugin - function use_plugin ($name) { +/** + * This function adds a plugin. + * @param string $name Internal plugin name (ie. delete_move_next) + * @return void + */ +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(); + } + } +} - if (file_exists('../plugins/'.$name.'/setup.php')) { - include_once('../plugins/'.$name.'/setup.php'); - $function = 'squirrelmail_plugin_init_'.$name; +/** + * 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(); + $function($data); } } + } + + $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. + * + * @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) { + global $squirrelmail_plugin_hooks, $currentHookName; + $ret = ''; + $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)) { + $ret = $function($parm); + } + } } - // This function executes a hook - function do_hook ($name) { - global $squirrelmail_plugin_hooks; - $Data = func_get_args(); - 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); + $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, concatenating the results of each + * plugin that has the hook defined. + * + * @param string name the name of the hook + * @param mixed parm optional hook function parameters + * @return string a concatenation of the results of each plugin function + */ +function concat_hook_function($name,$parm=NULL) { + global $squirrelmail_plugin_hooks, $currentHookName; + $ret = ''; + $currentHookName = $name; + + if (isset($squirrelmail_plugin_hooks[$name]) + && is_array($squirrelmail_plugin_hooks[$name])) { + foreach ($squirrelmail_plugin_hooks[$name] as $function) { + /* Concatenate results from hook. */ + if (function_exists($function)) { + $ret .= $function($parm); + } + } + } + + $currentHookName = ''; + + /* Variable-length argument lists have a slight problem when */ + /* passing values by reference. Pity. This is a workaround. */ + return $ret; +} + +/** + * This function is used for hooks which are to return true or + * false. If $priority is > 0, any one or more trues will override + * any falses. If $priority < 0, then one or more falses will + * 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 + */ +function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) { + global $squirrelmail_plugin_hooks, $currentHookName; + $yea = 0; + $nay = 0; + $ret = $tie; + + if (isset($squirrelmail_plugin_hooks[$name]) && + is_array($squirrelmail_plugin_hooks[$name])) { + + /* Loop over the plugins that registered the hook */ + $currentHookName = $name; + foreach ($squirrelmail_plugin_hooks[$name] as $function) { + if (function_exists($function)) { + $ret = $function($parm); + if ($ret) { + $yea++; + } else { + $nay++; } } } + $currentHookName = ''; - // Variable-length argument lists have a slight problem when - // passing values by reference. Pity. This is a workaround. - return $Data; + /* Examine the aftermath and assign the return value appropriately */ + if (($priority > 0) && ($yea)) { + $ret = true; + } elseif (($priority < 0) && ($nay)) { + $ret = false; + } elseif ($yea > $nay) { + $ret = true; + } elseif ($nay > $yea) { + $ret = false; + } else { + // There's a tie, no action needed. + } + return $ret; } + // If the code gets here, there was a problem - no hooks, etc. + return NULL; +} - /* -------------------- MAIN --------------------- */ +/** + * 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 + */ +function soupNazi(){ + return !checkForJavascript(); +} - // On startup, register all plugins configured for use - if (isset($plugins) && is_array($plugins)) { - foreach ($plugins as $name) { - use_plugin($name); - } +/** + * Check if plugin is enabled + * @param string $plugin_name plugin name + * @since 1.5.1 + * @return boolean + */ +function is_plugin_enabled($plugin_name) { + global $plugins; + + /** + * check if variable is empty. if var is not set, php empty + * returns true without error notice. + * + * then check if it is an array + */ + if (empty($plugins) || ! is_array($plugins)) + return false; + + if ( in_array($plugin_name,$plugins) ) { + return true; + } else { + return false; + } +} + +/*************************************/ +/*** MAIN PLUGIN LOADING CODE HERE ***/ +/*************************************/ + +/* On startup, register all plugins configured for use. */ +if (isset($plugins) && is_array($plugins)) { + // turn on output buffering in order to prevent output of new lines + ob_start(); + foreach ($plugins as $name) { + use_plugin($name); + } + // get output and remove whitespace + $output = trim(ob_get_contents()); + ob_end_clean(); + // if plugins output more than newlines and spacing, stop script execution. + if (!empty($output)) { + die($output); } +} ?>