- Merged revisions 3922-3958 from svn stable branch - Added backup size to ...

tbrehm

2013-04-16 a0fd5ab7b5412985324e970573ca22a27b3a94d3

 server/lib/classes/plugins.inc.php

@@ -1,7 +1,7 @@
<?php

/*
Copyright (c) 2007, Till Brehm, projektfarm Gmbh
Copyright (c) 2007-2012, Till Brehm, projektfarm Gmbh
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
@@ -30,57 +30,95 @@

class plugins {
   
   var $notification_events = array();
   var $available_events = array();
   var $subscribed_events = array();
   var $subscribed_actions = array();
   var $debug = false;
   
   /*
    This function is called to load the plugins from the plugins-available folder
    This function is called to load the plugins from the plugins-enabled or the plugins-core folder
   */
   
   function loadPlugins() {
   function loadPlugins($type) {
      global $app,$conf;

      $subPath = 'plugins-enabled';
      //if ($type == 'core') $subPath = 'plugins-core';
      
      $plugins_dir = $conf["rootpath"].$conf["fs_div"]."lib".$conf["fs_div"]."plugins-enabled".$conf["fs_div"]
      $plugins_dir = $conf['rootpath'].$conf['fs_div'].$subPath.$conf['fs_div'];
      $tmp_plugins = array();
      
      if (is_dir($plugins_dir)) {
         if ($dh = opendir($dir)) {
         if ($dh = opendir($plugins_dir)) {
            //** Go trough all files in the plugin dir
            while (($file = readdir($dh)) !== false) {
               if($file != '.' && $file != '..') {
               if($file != '.' && $file != '..' && substr($file,-8,8) == '.inc.php') {
                  $plugin_name = substr($file,0,-8);
                  include_once($plugins_dir.$file);
                  $app->log("Loading Plugin: $plugin_name",LOGLEVEL_DEBUG);
                  $app->plugins[$plugin_name] = new $module_name;
                  $app->plugins[$plugin_name]->onLoad();
                  $tmp_plugins[$plugin_name] = $file;
               }
            }
            //** sort the plugins by name
            ksort($tmp_plugins);
				
            //** load the plugins
            foreach($tmp_plugins as $plugin_name => $file) {
               include_once($plugins_dir.$file);
               if($this->debug) $app->log('Loading plugin: '.$plugin_name,LOGLEVEL_DEBUG);
               $app->loaded_plugins[$plugin_name] = new $plugin_name;
               $app->loaded_plugins[$plugin_name]->onLoad();
            }
         } else {
            $app->log('Unable to open the plugins directory: '.$plugins_dir,LOGLEVEL_ERROR);
         }
      } else {
         $app->log("Plugin directory missing: $plugins_dir",LOGLEVEL_ERROR);
         $app->log('Plugins directory missing: '.$plugins_dir,LOGLEVEL_ERROR);
      }
      
   }
   
   /*
    This function is called by the modules to register for a specific
    table change notification
      This function is used by the modules to announce which events they provide
   */
	
   function announceEvents($module_name,$events) {
      global $app;
      foreach($events as $event_name) {
         $this->available_events[$event_name] = $module_name;
         if($this->debug) $app->log('Announced event: '.$event_name,LOGLEVEL_DEBUG);
      }
   }
	
	
   /*
    This function is called by the plugin to register for an event
   */
   
   function registerEvent($event_name,$plugin_name,$function_name) {
      $this->notification_events[$event_name][] = array('plugin' => $plugin_name, 'function' => $function_name);
      global $app;
      if(!isset($this->available_events[$event_name])) {
         $app->log("Unable to register function '$function_name' from plugin '$plugin_name' for event '$event_name'",LOGLEVEL_DEBUG);
      } else {
         $this->subscribed_events[$event_name][] = array('plugin' => $plugin_name, 'function' => $function_name);
         if($this->debug)  $app->log("Registered function '$function_name' from plugin '$plugin_name' for event '$event_name'.",LOGLEVEL_DEBUG);
      }
   }
   
   
   function raiseEvent($event_name,$data) {
      global $app;
      
      // Get the hooks for this table
      $events = $this->notification_hevents[$event_name];
      // Get the subscriptions for this event
      $events = (isset($this->subscribed_events[$event_name]))?$this->subscribed_events[$event_name]:'';
      if($this->debug) $app->log('Raised event: '.$event_name,LOGLEVEL_DEBUG);
      
      if(is_array($events)) {
         foreach($events as $event) {
            $plugin_name = $event["plugin"];
            $function_name = $event["function"];
            // Claa the processing function of the module
            call_user_method($function_name,$app->plugins[$plugin_name],$event_name,$data);
            $plugin_name = $event['plugin'];
            $function_name = $event['function'];
            // Call the processing function of the plugin
            $app->log("Calling function '$function_name' from plugin '$plugin_name' raised by event '$event_name'.",LOGLEVEL_DEBUG);
            // call_user_method($function_name,$app->loaded_plugins[$plugin_name],$event_name,$data);
            call_user_func(array($app->loaded_plugins[$plugin_name],$function_name),$event_name,$data);
            unset($plugin_name);
            unset($function_name);
         }
@@ -89,6 +127,45 @@
      unset($events);
   }
   
   /*
    This function is called by the plugin to register for an action
   */
	
   function registerAction($action_name,$plugin_name,$function_name) {
      global $app;
      $this->subscribed_actions[$action_name][] = array('plugin' => $plugin_name, 'function' => $function_name);
      if($this->debug)  $app->log("Registered function '$function_name' from plugin '$plugin_name' for action '$event_name'.",LOGLEVEL_DEBUG);
   }
	
	
   function raiseAction($action_name,$data) {
      global $app;
		
      //* Get the subscriptions for this action
      $actions = (isset($this->subscribed_actions[$action_name]))?$this->subscribed_actions[$action_name]:'';
      if($this->debug) $app->log('Raised action: '.$action_name,LOGLEVEL_DEBUG);
		
      if(is_array($actions)) {
         foreach($actions as $action) {
            $plugin_name = $action['plugin'];
            $function_name = $action['function'];
            $state_out = 'ok';
            //* Call the processing function of the plugin
            $app->log("Calling function '$function_name' from plugin '$plugin_name' raised by action '$action_name'.",LOGLEVEL_DEBUG);
            $state = call_user_func(array($app->loaded_plugins[$plugin_name],$function_name),$action_name,$data);
            //* ensure that we return the highest warning / error level if a error occured in one of the functions
            if($state == 'warning' && $state_out != 'error') $state_out = 'warning';
            if($state == 'error') $state_out = 'error';
            unset($plugin_name);
            unset($function_name);
         }
      }
      unset($action);
      unset($actions);
		
      return $state_out;
   }
	
}

?>
?>