file permission fix
[squirrelmail.git] / functions / plugin.php
index fdc7020dee4ce3785994d67ddd6384b63a659142..b5f4e4f5a02ac7628bf933c3338ac9a9fc1b2caa 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * plugin.php
  *
- * Copyright (c) 1999-2001 The SquirrelMail Development Team
+ * 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.
  * $Id$
  */
 
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
-/***    + Base level indent should begin at left margin, as    ***/
-/***      the first line of the function definition below.     ***/
-/***    + All identation should consist of four space blocks   ***/
-/***    + Tab characters are evil.                             ***/
-/***    + all comments should use "slash-star ... star-slash"  ***/
-/***      style -- no pound characters, no slash-slash style   ***/
-/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
-/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
-/***    + Please use ' instead of ", when possible. Note "     ***/
-/***      should always be used in _( ) function calls.        ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
 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');
-            $function = 'squirrelmail_plugin_init_'.$name;
-            if (function_exists($function)) {
-                $function();
-            }
+/* 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 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);
-                }
+/* 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 --------------------- */
+    /* 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 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);
     }
+}
 
 ?>