- added new hooks/actions/events for addons to hook into the core

- TODO: the server services plugin is not capable of enabling and disabling addon plugins, yet

Author: Marius Burkard

install/install.php

@@ -211,9 +211,9 @@
 }
 
 //** Detect the installed applications
-$this->call_hook('find_installed_apps', false);
+$inst->raiseEvent('find_installed_apps::before');
 $inst->find_installed_apps();
-$this->call_hook('find_installed_apps', true);
+$inst->raiseEvent('find_installed_apps::after');
 
 //** Select the language and set default timezone
 $conf['language'] = $inst->simple_query('Select language', array('en', 'de'), 'en','language');
@@ -499,7 +499,7 @@
 	}
 }
 
-$inst->call_hook('configure_webserver_selection', true);
+$inst->raiseEvent('configure_webserver_selection::after');
 
 if($install_mode == 'standard' || strtolower($inst->simple_query('Configure Firewall Server', array('y', 'n'), 'y','configure_firewall')) == 'y') {
 	//* Check for Firewall
@@ -592,9 +592,9 @@
 	$inst->install_ispconfig_interface = false;
 }
 
-$inst->call_hook('install_ispconfig', false);
+$inst->raiseEvent('install_ispconfig::before');
 $inst->install_ispconfig();
-$inst->call_hook('install_ispconfig', true);
+$inst->raiseEvent('install_ispconfig::after');
 
 //* Configure DBServer
 swriteln('Configuring DBServer');

install/lib/installer_base.lib.php

@@ -2827,40 +2827,61 @@ protected function insert_db_credentials($tContents) {
 		return $tContents;
 	}
 
-	public function call_hook($hook_name, $after = true) {
-		if(is_null($this->addon_classes)) {
-			// load addon libs
-			$this->addon_classes = array();
-			$libpath = realpath(dirname(__FILE__).'/..') . '/lib.d';
-			if(($dir = opendir($libpath))) {
-				while(false !== ($cur = readdir($dir))) {
-					if(strpos($cur, '..') !== false || !is_file($libpath . '/' . $cur) || substr($cur, -8) !== '.lib.php') {
-						continue;
-					}
-					$class_name = substr($cur, 0, -8) . '_addon_installer';
-					include_once $libpath . '/' . $cur;
-					if(!class_exists($class_name)) {
-						continue;
-					}
-					
-					$this->addon_classes[] = new $class_name;
+	private function loadAddonClasses($path) {
+		$libpath = $conf['ispconfig_install_dir'] . '/addons';
+		if(($dir = opendir($libpath))) {
+			while(false !== ($cur = readdir($dir))) {
+				if($cur === '.' || $cur === '..' || strpos($cur, '..') !== false || !is_dir($libpath . '/' . $cur)) {
+					continue;
+				}
+				$addon_file = $libpath . '/' . $cur . '/' . $cur . '.addon.php';
+				if(!is_file($addon_file)) {
+					continue;
+				}
+
+				$class_name = $cur . '_addon_installer';
+				
+				if(isset($this->addon_classes[$class_name]) && is_object($this->addon_classes[$class_name])) {
+					// don't override
+					continue;
+				}
+				
+				include_once $addon_file;
+				if(!class_exists($class_name)) {
+					continue;
+				}
+
+				if(!is_array($this->addon_classes)) {
+					$this->addon_classes = array();
 				}
-				closedir($dir);
+				
+				$this->addon_classes[$class_name] = new $class_name;
 			}
+			closedir($dir);
 		}
+	}
+	
+	public function raiseEvent($event_name) {
+		global $conf;
 
-		$call_method = 'onBefore';
-		if($after === true) {
-			$call_method = 'onAfter';
+		if(is_null($this->addon_classes)) {
+			// load addon libs
+			$this->addon_classes = array();
+			$addonpath = $conf['ispconfig_install_dir'] . '/addons';
+			$this->loadAddonClasses($addonpath);
+			
+			// check for addon libs in install dir
+			$addonpath = realpath(dirname(__FILE__) . '/..') . '/addons';
+			$this->loadAddonClasses($addonpath);
 		}
+		
+		$call_method = 'onRaisedEvent';
 		reset($this->addon_classes);
 		foreach($this->addon_classes as $cl) {
 			if(method_exists($cl, $call_method)) {
-				call_user_func(array($cl, $call_method), $hook_name);
+				call_user_func(array($cl, $call_method), $event_name);
 			}
 		}
 	}
 
 }
-
-?>

install/lib/update.lib.php

@@ -434,11 +434,16 @@ function setDefaultServers(){
  *	@param $servicename string the name of the Database-Field in "servers" for this service
  *	@param $detected_value boolean The result of service detection
  */
-function check_service_config_state($servicename, $detected_value) {
-	global $current_svc_config, $inst, $conf;
+function check_service_config_state($servicename, $detected_value, $use_current_config = null) {
+	global $current_svc_config, $inst;
 
-	if ($current_svc_config[$servicename] == 1) $current_state = 1;
-	else $current_state = 0;
+	if(is_array($use_current_config)) {
+		if ($use_current_config[$servicename] == 1) $current_state = 1;
+		else $current_state = 0;
+	} else {
+		if ($current_svc_config[$servicename] == 1) $current_state = 1;
+		else $current_state = 0;
+	}
 
 	if ($detected_value) $detected_value = 1;
 	else $detected_value = 0;

install/update.php

@@ -340,9 +340,9 @@
 /*
  *  dump the new Database and reconfigure the server.ini
  */
-$inst->call_hook('updateDbAndIni', false);
+$inst->raiseEvent('updateDbAndIni::before');
 updateDbAndIni();
-$inst->call_hook('updateDbAndIni', true);
+$inst->raiseEvent('updateDbAndIni::after');
 
 //** read server config from db into $conf['server_config']
 $tmp = $inst->db->queryOneRecord("SELECT config FROM ?? WHERE server_id = ?", $conf["mysql"]["database"] . '.server', $conf['server_id']);
@@ -364,11 +364,12 @@
 //}
 
 //** Detect the installed applications
-$this->call_hook('find_installed_apps', false);
+$inst->raiseEvent('find_installed_apps::before');
 $inst->find_installed_apps();
-$this->call_hook('find_installed_apps', true);
+$inst->raiseEvent('find_installed_apps::after');
 
 //** Check for current service config state and compare to our results
+$inst->raiseEvent('check_service_config_state::before');
 if ($conf['mysql']['master_slave_setup'] == 'y') $current_svc_config = $inst->dbmaster->queryOneRecord("SELECT mail_server,web_server,dns_server,firewall_server,db_server FROM ?? WHERE server_id=?", $conf['mysql']['master_database'] . '.server', $conf['server_id']);
 else $current_svc_config = $inst->db->queryOneRecord("SELECT mail_server,web_server,dns_server,firewall_server,db_server FROM ?? WHERE server_id=?", $conf["mysql"]["database"] . '.server', $conf['server_id']);
 $conf['services']['mail'] = check_service_config_state('mail_server', $conf['postfix']['installed']);
@@ -377,6 +378,7 @@
 $conf['services']['firewall'] = check_service_config_state('firewall_server', ($conf['ufw']['installed'] || $conf['firewall']['installed']));
 $conf['services']['db'] = check_service_config_state('db_server', true); /* Will always offer as MySQL is of course installed on this host as it's a requirement for ISPC to work... */
 unset($current_svc_config);
+$inst->raiseEvent('check_service_config_state::after');
 
 //** Write new decisions into DB
 $sql = "UPDATE ?? SET mail_server = '{$conf['services']['mail']}', web_server = '{$conf['services']['web']}', dns_server = '{$conf['services']['dns']}', file_server = '{$conf['services']['file']}', db_server = '{$conf['services']['db']}', proxy_server = '{$conf['services']['proxy']}', firewall_server = '$firewall_server_enabled' WHERE server_id = ?";
@@ -539,7 +541,9 @@
 	}
 }
 
+$inst->raiseEvent('install_ispconfig::before');
 $inst->install_ispconfig();
+$inst->raiseEvent('install_ispconfig::after');
 
 // Cleanup
 $inst->cleanup_ispconfig();

interface/lib/classes/functions.inc.php

@@ -253,6 +253,12 @@ public function suggest_ips($type = 'IPv4'){
 				}
 			}
 		}
+		
+		$tmp_ips = $app->plugin->raiseEvent('get_server_ips', 0, true);
+		if(is_array($tmp_ips) && !empty($tmp_ips)) {
+			$ips = array_merge($ips, $tmp_ips);
+		}
+		
 
 		$results = $groupid != 1 ? $app->db->queryAllRecords("SELECT database_name as name,remote_ips as ip FROM web_database WHERE remote_ips != '' AND sys_groupid = ?", $groupid) : $results = $app->db->queryAllRecords("SELECT database_name as name,remote_ips as ip FROM web_database WHERE remote_ips != ''");
 

interface/lib/classes/listform.inc.php

@@ -66,6 +66,70 @@ public function loadListDef($file, $module = '')
 
 		$this->wordbook = $wb;
 
+		$module = (isset($_SESSION['s']['module']['name']) ? $_SESSION['s']['module']['name'] : '');
+
+		// load wordbook/lang files from addons
+		if($module == '') {
+			$lng_path = 'lib/lang.d';
+		} else {
+			$lng_path = '../' . $module . '/lib/lang.d';
+		}
+		if(($dir = opendir($lng_path))) {
+			$fallback_files = array();
+			$use_files = array();
+			while(false !== ($cur = readdir($dir))) {
+				$lng_file = $lng_path . '/' . $cur;
+				if(is_file($lng_file) && substr($cur, -strlen('.'.$app->listform->listDef["name"].".lng")) === '.'.$app->listform->listDef["name"].".lng") {
+					if(substr($cur, 0, 3) === 'en_') {
+						$fallback_files[] = $cur;
+					} elseif(substr($cur, 0, 3) === $app->functions->check_language($_SESSION["s"]["language"]) . '_') {
+						$use_files[] = $cur;
+					}
+				}
+			}
+			closedir($dir);
+			
+			foreach($fallback_files as $cur) {
+				$cur_lng = $app->functions->check_language($_SESSION["s"]["language"]) . '_' . substr($cur, 3);
+				if(in_array($cur_lng, $use_files, true) == false) {
+					$use_files[] = $cur;
+				}
+			}
+			unset($fallback_files);
+			
+			reset($use_files);
+			foreach($use_files as $cur) {
+				$lng_file = $lng_path . '/' . $cur;
+				
+				include $lng_file;
+				if(isset($wb) && is_array($wb)) {
+					$this->wordbook = $app->functions->array_merge($this->wordbook, $wb);
+				}
+			}
+			unset($use_files);
+		}
+
+
+		if($module) {
+			// load list files from addons
+			$listform_path = '../' . $module . '/lib/form.d';
+			if(($dir = opendir($listform_path))) {
+				$items = null;
+				while(false !== ($cur = readdir($dir))) {
+					$listform_file = $listform_path . '/' . $cur;
+					if(is_file($listform_file) && substr($cur, -strlen('.'.$app->listform->listDef["name"].".list.php")) === '.'.$app->listform->listDef["name"].".list.php") {
+						unset($items); // just in case someone does not create a new array in the list file
+						include($listform_file);
+						if(isset($items) && is_array($items) && !empty($items)) {
+							$this->listDef['item'] = array_merge($this->listDef['item'], $items);
+						}
+					}
+				}
+				closedir($dir);
+			}
+		}
+		
+		
 		return true;
 	}
 

interface/lib/classes/plugin.inc.php

@@ -124,17 +124,35 @@ public function raiseEvent($event_name, $data, $return_data = false) {
 				$tmp_event = $sub_events[2];
 				if($this->debug) $app->log("Called Event '$tmp_event'", LOGLEVEL_DEBUG);
 				$tmpresult = $this->callPluginEvent($tmp_event, $data, $return_data);
-				if($return_data == true && $tmpresult) $result .= $tmpresult;
+				if($return_data == true && $tmpresult) {
+					if(is_array($tmpresult) && (!$result || is_array($result))) {
+						$result = array_merge($result, $tmpresult);
+					} elseif(!is_array($tmpresult)) {
+						$result .= $tmpresult;
+					}
+				}
 
 				$tmp_event = $sub_events[0].':'.$sub_events[2];
 				if($this->debug) $app->log("Called Event '$tmp_event'", LOGLEVEL_DEBUG);
 				$tmpresult = $this->callPluginEvent($tmp_event, $data, $return_data);
-				if($return_data == true && $tmpresult) $result .= $tmpresult;
+				if($return_data == true && $tmpresult) {
+					if(is_array($tmpresult) && (!$result || is_array($result))) {
+						$result = array_merge($result, $tmpresult);
+					} elseif(!is_array($tmpresult)) {
+						$result .= $tmpresult;
+					}
+				}
 
 				$tmp_event = $sub_events[0].':'.$sub_events[1].':'.$sub_events[2];
 				if($this->debug) $app->log("Called Event '$tmp_event'", LOGLEVEL_DEBUG);
 				$tmpresult = $this->callPluginEvent($tmp_event, $data, $return_data);
-				if($return_data == true && $tmpresult) $result .= $tmpresult;
+				if($return_data == true && $tmpresult) {
+					if(is_array($tmpresult) && (!$result || is_array($result))) {
+						$result = array_merge($result, $tmpresult);
+					} elseif(!is_array($tmpresult)) {
+						$result .= $tmpresult;
+					}
+				}
 
 				/*$sub_events = array_reverse($sub_events);
 				$tmp_event = '';
@@ -147,7 +165,13 @@ public function raiseEvent($event_name, $data, $return_data = false) {
 			} else {
 				if($this->debug) $app->log("Called Event '$sub_events[0]'", LOGLEVEL_DEBUG);
 				$tmpresult = $this->callPluginEvent($sub_events[0], $data, $return_data);
-				if($return_data == true && $tmpresult) $result .= $tmpresult;
+				if($return_data == true && $tmpresult) {
+					if(is_array($tmpresult) && (!$result || is_array($result))) {
+						$result = array_merge($result, $tmpresult);
+					} elseif(!is_array($tmpresult)) {
+						$result .= $tmpresult;
+					}
+				}
 			}
 		}
 
@@ -187,7 +211,13 @@ private function callPluginEvent($event_name, $data, $return_data = false) {
 					// call_user_method($function_name,$app->loaded_plugins[$plugin_name],$event_name,$data);
 
 					$tmpresult = call_user_func(array($app->loaded_plugins[$plugin_name], $function_name), $event_name, $data);
-					if($return_data == true && $tmpresult) $result .= $tmpresult;
+					if($return_data == true && $tmpresult) {
+						if(is_array($tmpresult) && (!$result || is_array($result))) {
+							$result = array_merge($result, $tmpresult);
+						} elseif(!is_array($tmpresult)) {
+							$result .= $tmpresult;
+						}
+					}
 				}
 			}
 

interface/lib/classes/remote.d/server.inc.php

@@ -203,7 +203,6 @@ public function server_get_serverid_by_name($session_id, $server_name)
         global $app;
 		if(!$this->checkPerm($session_id, 'server_get')) {
         	throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
-            return false;
 		}
 		if (!empty($session_id) && !empty($server_name)) {
 			$sql = "SELECT server_id FROM server WHERE server_name  = ?";
@@ -225,12 +224,22 @@ public function server_get_functions($session_id, $server_id)
         global $app;
 		if(!$this->checkPerm($session_id, 'server_get')) {
         	throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
-            return false;
 		}
 		if (!empty($session_id) && !empty($server_id)) { 
-			$sql = "SELECT mail_server, web_server, dns_server, file_server, db_server, proxy_server, firewall_server, mirror_server_id FROM server WHERE server_id  = ?";
+			$sql = "SELECT * FROM server WHERE server_id  = ?";
 			$all = $app->db->queryOneRecord($sql, $server_id);
-			return $all;
+			if(empty($all)) return false;
+			
+			$func = array();
+			foreach($all as $key => $value) {
+				if($key === 'mirror_server_id' || substr($key, -7) === '_server') {
+					if($value == 0 || $value == 1) {
+						$func[$key] = $value;
+					}
+				}
+			}
+			
+			return $func;
 		} else {
 			return false;
 		}
@@ -241,7 +250,6 @@ public function server_get_app_version($session_id, $server_id = 0)
 		global $app;
 		if(!$this->checkPerm($session_id, 'server_get')) {
 			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
-			return false;
 		}
 		if (!empty($session_id)) {
 			if($server_id == 0) $ispc_app_version = array('ispc_app_version' => ISPC_APP_VERSION);