functions/plugin.php

   1 <?php
   2
   3    /**
   4     *   plugin.php
   5     *
   6     *   Copyright (c) 1999-2001 The Squirrelmail Development Team
   7     *   Licensed under the GNU GPL. For full terms see the file COPYING.
   8     *
   9     *   This file provides the framework for a plugin architecture.
  10     *
  11     *   Documentation on how to write plugins might show up some time.
  12     *
  13     *   $Id$
  14     */
  15
  16     global $squirrelmail_plugin_hooks;
  17
  18     $squirrelmail_plugin_hooks = array();
  19
  20     // This function adds a plugin
  21     function use_plugin ($name) {
  22
  23         if (file_exists('../plugins/'.$name.'/setup.php')) {
  24             include_once('../plugins/'.$name.'/setup.php');
  25             $function = 'squirrelmail_plugin_init_'.$name;
  26             if (function_exists($function)) {
  27                 $function();
  28             }
  29         }
  30
  31     }
  32
  33     // This function executes a hook
  34     function do_hook ($name) {
  35         global $squirrelmail_plugin_hooks;
  36         $Data = func_get_args();
  37         if (isset($squirrelmail_plugin_hooks[$name]) &&
  38             is_array($squirrelmail_plugin_hooks[$name])) {
  39             foreach ($squirrelmail_plugin_hooks[$name] as $function) {
  40                 // Add something to set correct gettext domain for plugin
  41                 if (function_exists($function)) {
  42                     $function($Data);
  43                 }
  44             }
  45         }
  46
  47         // Variable-length argument lists have a slight problem when
  48         // passing values by reference.  Pity.  This is a workaround.
  49         return $Data;
  50     }
  51
  52     /* -------------------- MAIN --------------------- */
  53
  54     // On startup, register all plugins configured for use
  55     if (isset($plugins) && is_array($plugins)) {
  56         foreach ($plugins as $name) {
  57             use_plugin($name);
  58         }
  59     }
  60
  61 ?>