/**
* 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-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');
-
-global $squirrelmail_plugin_hooks;
-$squirrelmail_plugin_hooks = array();
-
/**
* This function adds a plugin.
* @param string $name Internal plugin name (ie. delete_move_next)
* @return mixed $data
*/
function do_hook ($name) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$data = func_get_args();
- $ret = '';
+ $currentHookName = $name;
if (isset($squirrelmail_plugin_hooks[$name])
&& is_array($squirrelmail_plugin_hooks[$name])) {
}
}
+ $currentHookName = '';
+
/* Variable-length argument lists have a slight problem when */
/* passing values by reference. Pity. This is a workaround. */
return $data;
* @return mixed the return value of the hook function
*/
function do_hook_function($name,$parm=NULL) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$ret = '';
+ $currentHookName = $name;
if (isset($squirrelmail_plugin_hooks[$name])
&& is_array($squirrelmail_plugin_hooks[$name])) {
}
}
+ $currentHookName = '';
+
/* Variable-length argument lists have a slight problem when */
/* passing values by reference. Pity. This is a workaround. */
return $ret;
* @return string a concatenation of the results of each plugin function
*/
function concat_hook_function($name,$parm=NULL) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$ret = '';
+ $currentHookName = $name;
if (isset($squirrelmail_plugin_hooks[$name])
&& is_array($squirrelmail_plugin_hooks[$name])) {
}
}
+ $currentHookName = '';
+
/* Variable-length argument lists have a slight problem when */
/* passing values by reference. Pity. This is a workaround. */
return $ret;
* @return bool the result of the function
*/
function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$yea = 0;
$nay = 0;
$ret = $tie;
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);
}
}
}
+ $currentHookName = '';
/* Examine the aftermath and assign the return value appropriately */
if (($priority > 0) && ($yea)) {
* 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!
+ * *** 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();
+}
- $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;
+/**
+ * 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);
- }
+
+/**
+ * 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.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)
+{
+
+ $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;
+
}
-?>
projects / squirrelmail.git / blobdiff