- ** 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$
- **/
-
-
- if (defined('plugin_php'))
- return;
- define('plugin_php', true);
-
- global $plugin_general_debug, $squirrelmail_plugin_hooks;
- $plugin_general_debug = false;
-
- $squirrelmail_plugin_hooks = array();
-
- // 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-2004 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$
+ * @package squirrelmail
+ */
+
+/** Everything needs global.. */
+require_once(SM_PATH . 'functions/global.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;
+ $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 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;
+ $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)) {
+ $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 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;
+ $ret = '';
+
+ if (isset($squirrelmail_plugin_hooks[$name])
+ && is_array($squirrelmail_plugin_hooks[$name])) {
+ foreach ($squirrelmail_plugin_hooks[$name] as $function) {
+ /* Concatenate results from hook. */