<?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$
- **/
-
-
- $plugin_php = true;
- $plugin_general_debug = false;
-
- // This function adds a plugin
- function use_plugin ($name) {
- global $plugin_general_debug;
-
- if (file_exists('../plugins/'.$name.'/setup.php')) {
- if ($plugin_general_debug)
- echo "plugin: -- Loading $name/setup.php<br>\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<br>\n";
- $function($plugin_general_debug);
- }
- elseif ($plugin_general_debug)
- echo "plugin: -- Init function $function doesn't exist.<br>\n";
- }
- elseif ($plugin_general_debug)
- echo "plugin: Couldn't find $name/setup.php<br>\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$
+ */
+
+require_once(SM_PATH . 'functions/global.php');
+
+global $squirrelmail_plugin_hooks;
+$squirrelmail_plugin_hooks = array();
+
+/* This function adds a plugin. */
+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. */
+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. */
+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<br>\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. */
+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 */
+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.
+ */
+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);
+ }
+}
?>
projects / squirrelmail.git / blobdiff