X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fplugin.php;h=3004f8699e0d75659ea8d5b783ba84757839e3bd;hb=eac264935e8da241a837ac60bd3d3a94a071c0c6;hp=34cb4bd6d1ecb958916fba9533adf0d8e2e35f46;hpb=f191a7da15d03e9cc5c6d5a80844ab7eca44825b;p=squirrelmail.git diff --git a/functions/plugin.php b/functions/plugin.php index 34cb4bd6..3004f869 100644 --- a/functions/plugin.php +++ b/functions/plugin.php @@ -1,72 +1,199 @@ \n"; - include ('../plugins/'.$name.'/setup.php'); - $function = 'squirrelmail_plugin_init_'.$name; - if (function_exists($function)) - { - if ($plugin_general_debug) - echo "plugin: ---- Executing $function to init plugin
\n"; - $function($plugin_general_debug); - } - elseif ($plugin_general_debug) - echo "plugin: -- Init function $function doesn't exist.
\n"; - } - elseif ($plugin_general_debug) - echo "plugin: Couldn't find $name/setup.php
\n"; - } - - // 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 $id => $function) { - // Add something to set correct gettext domain for plugin + * plugin.php + * + * Copyright (c) 1999-2003 The SquirrelMail Project 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$ + * @package squirrelmail + */ + +/** Everything needs global.. */ +require_once(SM_PATH . 'functions/global.php'); + +global $squirrelmail_plugin_hooks; +$squirrelmail_plugin_hooks = array(); + +/** + * 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(); + } + } +} + +/** + * This function executes a hook. + * @param string $name Name of hook to fire + * @return mixed $data + */ +function do_hook ($name) { + global $squirrelmail_plugin_hooks; + $data = func_get_args(); + $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. */ + if (function_exists($function)) { + $function($data); + } + } + } + + /* 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; + $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. */ if (function_exists($function)) { - $function($Data); + $ret = $function($parm); } - } - } - - // Variable-length argument lists have a slight problem when - // passing values by reference. Pity. This is a workaround. - return $Data; - } - - // On startup, register all plugins configured for use - if (isset($plugins) && is_array($plugins)) - foreach ($plugins as $id => $name) - { - if ($plugin_general_debug) - echo "plugin: Attempting load of plugin $name
\n"; - use_plugin($name); - } + } + } + + /* 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; + $ret = ''; + + 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); + } + } + } + + /* 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; + $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 */ + foreach ($squirrelmail_plugin_hooks[$name] as $function) { + if (function_exists($function)) { + $ret = $function($parm); + if ($ret) { + $yea++; + } else { + $nay++; + } + } + } + + /* 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; +} + +/** + * 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 function needs to have its name changed! + * + * @return bool whether this browser properly supports JavaScript + */ +function soupNazi(){ + + $soup_menu = array('Mozilla/3','Mozilla/2','Mozilla/1', 'Opera 4', + 'Opera/4', 'OmniWeb', 'Lynx'); + sqgetGlobalVar('HTTP_USER_AGENT', $user_agent, SQ_SERVER); + foreach($soup_menu as $browser) { + if(stristr($user_agent, $browser)) { + return 1; + } + } + return 0; +} +/*************************************/ +/*** MAIN PLUGIN LOADING CODE HERE ***/ +/*************************************/ + +/* On startup, register all plugins configured for use. */ +if (isset($plugins) && is_array($plugins)) { + foreach ($plugins as $name) { + use_plugin($name); + } +} ?>