/**
* 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$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
*/
-global $squirrelmail_plugin_hooks;
-$squirrelmail_plugin_hooks = array();
-
-/* This function adds a plugin. */
+/**
+ * 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();
- }
+
+ /**
+ * 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();
+ //}
}
}
-/* This function executes a hook. */
-function do_hook ($name) {
- global $squirrelmail_plugin_hooks;
- $data = func_get_args();
- $ret = '';
+/**
+ * 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.
+ *
+ */
+function do_hook($name, &$args) {
+
+ global $squirrelmail_plugin_hooks, $currentHookName;
+ $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)) {
- $function($data);
+ $ret = $function($args, $ret);
}
}
}
- /* Variable-length argument lists have a slight problem when */
- /* passing values by reference. Pity. This is a workaround. */
- return $data;
+ $currentHookName = '';
+ return $ret;
+
}
-/* This function executes a hook. */
-function do_hook_function($name,$parm=NULL) {
- global $squirrelmail_plugin_hooks;
+/**
+ * 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
+ * will be concatenated if they are both strings, or merged if they
+ * are arrays (in the same (non-overwrite) manner recursively).
+ *
+ * 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
+ * (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 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.
+ *
+ */
+function concat_hook_function($name, &$args, $force_array=FALSE) {
+
+ global $squirrelmail_plugin_hooks, $currentHookName;
+ $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);
+ $plugin_ret = $function($args);
+ if (!empty($plugin_ret)) {
+ $ret = sqm_array_merge($ret, $plugin_ret);
+ }
}
}
}
- /* Variable-length argument lists have a slight problem when */
- /* passing values by reference. Pity. This is a workaround. */
+ if ($force_array && is_string($ret)) {
+ $ret = array($ret);
+ }
+
+ $currentHookName = '';
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
+ *
+ * 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, &$args, $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 $plugin_name => $function) {
+ use_plugin($plugin_name);
+ if (function_exists($function)) {
+ $ret = $function($args);
+ 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;
+
+}
/**
+ * 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 ***
+ *
+ * @return bool whether this browser properly supports JavaScript
+ * @deprecated use checkForJavascript() since 1.5.1
*/
function soupNazi(){
+ return !checkForJavascript();
+}
- $soup_menu = array('Mozilla/3','Mozilla/2','Mozilla/1', 'Opera 4',
- 'Opera/4', 'OmniWeb', 'Lynx');
- foreach($soup_menu as $browser) {
- if(stristr($_SERVER['HTTP_USER_AGENT'], $browser)) {
- return 1;
- }
- }
- return 0;
+/**
+ * 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)) {
- foreach ($plugins as $name) {
- use_plugin($name);
- }
+
+/**
+ * Get a plugin's version.
+ *
+ * Determines and returns a plugin's version.
+ *
+ * By default, the desired plugin must be currently
+ * activated, and if it is not, this function will
+ * return FALSE. By overriding the default value
+ * of $force_inclusion, this function will attempt
+ * to grab versioning information from the given
+ * plugin even if it is not activated (plugin still
+ * has to be unpackaged and set in place in the
+ * plugins directory). Use with care - some plugins
+ * might break SquirrelMail when this is used.
+ *
+ * By turning on the $do_parse argument, the version
+ * string will be parsed by SquirrelMail into a
+ * SquirrelMail-compatible version string (such as
+ * "1.2.3") if it is not already.
+ *
+ * Note that this assumes plugin versioning is
+ * consistently applied in the same fashion that
+ * SquirrelMail versions are, with the exception that
+ * an applicable SquirrelMail version may be appended
+ * to the version number (which will be ignored herein).
+ * That is, plugin version number schemes are expected
+ * in the following format: 1.2.3, or 1.2.3-1.4.0.
+ *
+ * Any characters after the third version number
+ * indicating things such as beta or release candidate
+ * versions are discarded, so formats such as the
+ * following will also work, although extra information
+ * about beta versions can possibly confuse the desired
+ * results of the version check: 1.2.3-beta4, 1.2.3.RC2,
+ * and so forth.
+ *
+ * @since 1.5.2
+ *
+ * @param string plugin_name name of the plugin to
+ * check; must precisely
+ * match the plugin
+ * directory name
+ * @param bool force_inclusion try to get version info
+ * for plugins not activated?
+ * (default FALSE)
+ * @param bool do_parse return the plugin version
+ * in SquirrelMail-compatible
+ * format (default FALSE)
+ *
+ * @return mixed The plugin version string if found, otherwise,
+ * boolean FALSE is returned indicating that no
+ * version information could be found for the plugin.
+ *
+ */
+function get_plugin_version($plugin_name, $force_inclusion = FALSE, $do_parse = FALSE)
+{
+
+ $info_function = $plugin_name . '_info';
+ $version_function = $plugin_name . '_version';
+ $plugin_info = array();
+ $plugin_version = FALSE;
+
+
+ // first attempt to find the plugin info function, wherein
+ // the plugin version should be available
+ //
+ if (function_exists($info_function))
+ $plugin_info = $info_function();
+ else if ($force_inclusion
+ && file_exists(SM_PATH . 'plugins/' . $plugin_name . '/setup.php'))
+ {
+ include_once(SM_PATH . 'plugins/' . $plugin_name . '/setup.php');
+ if (function_exists($info_function))
+ $plugin_info = $info_function();
+ }
+ if (!empty($plugin_info['version']))
+ $plugin_version = $plugin_info['version'];
+
+
+ // otherwise, look for older version function
+ //
+ if (!$plugin_version && function_exists($version_function))
+ $plugin_version = $version_function();
+
+
+ if ($plugin_version && $do_parse)
+ {
+
+ // massage version number into something we understand
+ //
+ // the first regexp strips everything and anything that follows
+ // the first occurance of a non-digit (or non decimal point), so
+ // beware that putting letters in the middle of a version string
+ // will effectively truncate the version string right there (but
+ // this also just helps remove the SquirrelMail version part off
+ // of versions such as "1.2.3-1.4.4")
+ //
+ // the second regexp just strips out non-digits/non-decimal points
+ // (and might be redundant(?))
+ //
+ // the regexps are wrapped in a trim that makes sure the version
+ // does not start or end with a decimal point
+ //
+ $plugin_version = trim(preg_replace(array('/[^0-9.]+.*$/', '/[^0-9.]/'),
+ '', $plugin_version),
+ '.');
+
+ }
+
+ return $plugin_version;
+
+}
+
+/**
+ * Check a plugin's version.
+ *
+ * Returns TRUE if the given plugin is installed,
+ * activated and is at minimum version $a.$b.$c.
+ * If any one of those conditions fails, FALSE
+ * will be returned (careful of plugins that are
+ * sufficiently versioned but are not activated).
+ *
+ * By overriding the default value of $force_inclusion,
+ * this function will attempt to grab versioning
+ * information from the given plugin even if it
+ * is not activated (the plugin still has to be
+ * unpackaged and set in place in the plugins
+ * directory). Use with care - some plugins
+ * might break SquirrelMail when this is used.
+ *
+ * Note that this function assumes plugin
+ * versioning is consistently applied in the same
+ * fashion that SquirrelMail versions are, with the
+ * exception that an applicable SquirrelMail
+ * version may be appended to the version number
+ * (which will be ignored herein). That is, plugin
+ * version number schemes are expected in the following
+ * format: 1.2.3, or 1.2.3-1.4.0.
+ *
+ * Any characters after the third number indicating
+ * things such as beta or release candidate versions
+ * are discarded, so formats such as the following
+ * will also work, although extra information about
+ * beta versions can possibly confuse the desired results
+ * of the version check: 1.2.3-beta4, 1.2.3.RC2, and so forth.
+ *
+ * @since 1.5.2
+ *
+ * @param string plugin_name name of the plugin to
+ * check; must precisely
+ * match the plugin
+ * directory name
+ * @param int a major version number
+ * @param int b minor version number
+ * @param int c release number
+ * @param bool force_inclusion try to get version info
+ * for plugins not activated?
+ * (default FALSE)
+ *
+ * @return bool
+ *
+ */
+function check_plugin_version($plugin_name,
+ $a = 0, $b = 0, $c = 0,
+ $force_inclusion = FALSE)
+{
+
+ $plugin_version = get_plugin_version($plugin_name, $force_inclusion, TRUE);
+ if (!$plugin_version) return FALSE;
+
+
+ // split the version string into sections delimited by
+ // decimal points, and make sure we have three sections
+ //
+ $plugin_version = explode('.', $plugin_version);
+ if (!isset($plugin_version[0])) $plugin_version[0] = 0;
+ if (!isset($plugin_version[1])) $plugin_version[1] = 0;
+ if (!isset($plugin_version[2])) $plugin_version[2] = 0;
+// sm_print_r($plugin_version);
+
+
+ // now test the version number
+ //
+ if ($plugin_version[0] < $a ||
+ ($plugin_version[0] == $a && $plugin_version[1] < $b) ||
+ ($plugin_version[0] == $a && $plugin_version[1] == $b && $plugin_version[2] < $c))
+ return FALSE;
+
+
+ return TRUE;
+
}
-?>
projects / squirrelmail.git / blobdiff