Code Cleaning

[squirrelmail.git] / functions / plugin.php

diff --git a/functions/plugin.php b/functions/plugin.php
index 7d209e844818d68e3feeca9676d0921db57f561b..3ce547ca38ce8e4b52144274a8bc05fe947f2dc6 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -1,63 +1,76 @@
 <?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
+ *
+ * Copyright (c) 1999-2002 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$
+ */
 
-    global $squirrelmail_plugin_hooks;
+global $squirrelmail_plugin_hooks;
+$squirrelmail_plugin_hooks = array();
 
-    $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";
+        if (function_exists($function)) {
+            $function();
+        }
+    }
+}
 
-    // This function adds a plugin
-    function use_plugin ($name) {
+/* This function executes a hook. */
+function do_hook ($name) {
+    global $squirrelmail_plugin_hooks;
+    $data = func_get_args();
 
-        if (file_exists('../plugins/'.$name.'/setup.php')) {
-            include_once('../plugins/'.$name.'/setup.php');
-            $function = 'squirrelmail_plugin_init_'.$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);
-                }
-            }
-        }
+    /* Variable-length argument lists have a slight problem when */
+    /* passing values by reference. Pity. This is a workaround.  */
+    return $data;
+}
+
+/*************************************/
+/*** MAIN PLUGIN LOADING CODE HERE ***/
+/*************************************/
 
-        // 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 $name) {
+        use_plugin($name);
     }
+}
 
-    /* -------------------- MAIN --------------------- */
+    /**
+     * 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(){
 
-    // On startup, register all plugins configured for use
-    if (isset($plugins) && is_array($plugins)) {
-        foreach ($plugins as $name) {
-            use_plugin($name);
-        }
+        global $HTTP_USER_AGENT, $SQSPELL_SOUP_NAZI;
+        
+        require_once('../plugins/squirrelspell/sqspell_config.php');
+
+        $soup_menu = explode( ',', $SQSPELL_SOUP_NAZI );
+        return( in_array( trim( $HTTP_USER_AGENT ), $soup_menu ) );
     }
 
 ?>
\ No newline at end of file