<?php
- /**
- ** plugin.php
- **
- ** This file provides the framework for a plugin architecture.
- **
- ** Plugins will eventually be a way to provide added functionality
- ** without having to patch the SquirrelMail source code. Have some
- ** patience, though, as the these funtions might change in the near
- ** future.
- **
- ** Documentation on how to write plugins might show up some time.
- **
- ** $Id$
- **/
-
- global $squirrelmail_plugin_hooks;
-
- $squirrelmail_plugin_hooks = array();
-
- // This function adds a plugin
- function use_plugin ($name) {
-
- if (file_exists('../plugins/'.$name.'/setup.php')) {
- include_once('../plugins/'.$name.'/setup.php');
- $function = 'squirrelmail_plugin_init_'.$name;
+/**
+ * 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
+ */
+
+/**
+ * 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();
+ $function($data);
}
}
-
}
- // 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 $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;
+}
- // 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, 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);
+ }
+ }
}
- /* -------------------- MAIN --------------------- */
+ $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])) {
- // On startup, register all plugins configured for use
- if (isset($plugins) && is_array($plugins)) {
- foreach ($plugins as $name) {
- use_plugin($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;
+ }
+}
+
+/**
+ * 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 (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 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.1
+ *
+ * @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)
+{
+
+ $version_function = $plugin_name . '_version';
+ $plugin_version = FALSE;
+
+
+ // attempt to find version function and get version from plugin
+ //
+ if (function_exists($version_function))
+ $plugin_version = $version_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($version_function))
+ $plugin_version = $version_function();
+ }
+
+ if (!$plugin_version) return FALSE;
+
+
+ // now massage version number into something we understand
+ //
+ $plugin_version = trim(preg_replace(array('/[^0-9.]+.*$/', '/[^0-9.]/'),
+ '', $plugin_version),
+ '.');
+ $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;
+
+}
-?>
\ No newline at end of file