classes/plugins/PluginRegistry.inc.php

<?php

// $Id: PluginRegistry.inc.php,v 1.27 2008/07/01 01:16:10 asmecher Exp $


import('plugins.Plugin');

define('PLUGINS_PREFIX', 'plugins/');

class PluginRegistry {
   function &getPlugins($category = null) {
      $plugins = &Registry::get('plugins');
      if ($category !== null) return $plugins[$category];
      return $plugins;
   }

   function &getAllPlugins() {
      $plugins =& PluginRegistry::getPlugins();
      $allPlugins = array();
      if (is_array($plugins)) foreach ($plugins as $category => $list) {
         if (is_array($list)) $allPlugins += $list;
      }
      return $allPlugins;
   }

   function register($category, &$plugin, $path) {
      $pluginName = $plugin->getName();
      $plugins =& PluginRegistry::getPlugins();
      if (!$plugins) $plugins = array();

      // If the plugin was already loaded, do not load it again.
      if (isset($plugins[$category][$pluginName])) return false;

      // Allow the plugin to register.
      if (!$plugin->register($category, $path)) return false;

      if (isset($plugins[$category])) $plugins[$category][$plugin->getName()] = &$plugin;
      else $plugins[$category] = array($plugin->getName() => &$plugin);
      Registry::set('plugins', $plugins);
      return true;
   }

   function &getPlugin ($category, $name) {
      $plugins = &PluginRegistry::getPlugins();
      $plugin = @$plugins[$category][$name];
      return $plugin;
   }

   function &loadCategory ($category, $forceLoad = false) {
      $plugins = array();
      $categoryDir = PLUGINS_PREFIX . $category;
      if (!is_dir($categoryDir)) return $plugins;

      $handle = opendir($categoryDir);
      while (($file = readdir($handle)) !== false) {
         if ($file == '.' || $file == '..') continue;
         $pluginPath = "$categoryDir/$file";
         $pluginWrapper = "$pluginPath/index.php";

         if (!file_exists($pluginWrapper)) continue;
         $plugin = include($pluginWrapper);
         if ($plugin && is_object($plugin)) {
            $plugins[$plugin->getSeq()][$pluginPath] =& $plugin;
            unset($plugin);
         }
      }
      closedir($handle);

      // If anyone else wants to jump category, here is the chance.
      HookRegistry::call('PluginRegistry::loadCategory', array(&$category, &$plugins));

      // Register the plugins in sequence.
      ksort($plugins);
      foreach ($plugins as $seq => $junk1) {
         foreach ($plugins[$seq] as $pluginPath => $junk2) {
            PluginRegistry::register($category, $plugins[$seq][$pluginPath], $pluginPath);
         }
      }
      unset($plugins);

      // Return the list of successfully-registered plugins.
      $plugins = &PluginRegistry::getPlugins($category);
      return $plugins;
   }

   function &loadPlugin($category, $pathName) {
      $pluginPath = PLUGINS_PREFIX . $category . '/' . $pathName;
      $plugin = null;
      if (!file_exists($pluginPath . '/index.php')) return $plugin;

      $plugin = @include("$pluginPath/index.php");
      if ($plugin && is_object($plugin)) {
         PluginRegistry::register($category, $plugin, $pluginPath);
      }
      return $plugin;
   }

   function getCategories() {
      $categories = array(
         'auth',
         'blocks',
         'citationFormats',
         'gateways',
         'generic',
         'implicitAuth',
         'importexport',
         'paymethod',
         'reports',
         'themes'
      );
      HookRegistry::call('PluginRegistry::getCategories', array(&$categories));
      return $categories;
   }

   function &loadAllPlugins() {
      foreach (PluginRegistry::getCategories() as $category) {
         PluginRegistry::loadCategory($category);
      }
      $allPlugins =& PluginRegistry::getAllPlugins();
      return $allPlugins;
   }
}
?>

---