New hook function: boolean_hook_function(), which is used for hooks that want a true...

[squirrelmail.git] / functions / plugin.php

diff --git a/functions/plugin.php b/functions/plugin.php
index b5f4e4f5a02ac7628bf933c3338ac9a9fc1b2caa..9c70edd198771e86e23c05ca1fad37267f14b665 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -3,7 +3,7 @@
 /**
  * plugin.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * 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.
@@ -13,13 +13,15 @@
  * $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("../plugins/$name/setup.php")) {
-        include_once("../plugins/$name/setup.php");
+    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();
@@ -31,6 +33,7 @@ function use_plugin ($name) {
 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])) {
@@ -47,6 +50,108 @@ function do_hook ($name) {
     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)) {
+                $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. */
+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 ***/
 /*************************************/