184c69663d
plugins work. The real solution is a centralized init and no active code under functions/
238 lines
6.8 KiB
PHP
238 lines
6.8 KiB
PHP
<?php
|
|
|
|
/**
|
|
* plugin.php
|
|
*
|
|
* This file provides the framework for a plugin architecture.
|
|
*
|
|
* Documentation on how to write plugins might show up some time.
|
|
*
|
|
* @copyright © 1999-2006 The SquirrelMail Project Team
|
|
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
|
|
* @version $Id$
|
|
* @package squirrelmail
|
|
*/
|
|
|
|
/** 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();
|
|
|
|
/**
|
|
* 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, $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);
|
|
}
|
|
}
|
|
}
|
|
|
|
$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);
|
|
}
|
|
}
|
|
}
|
|
|
|
$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 = '';
|
|
|
|
/* 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 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();
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
}
|
|
|
|
?>
|