Merge branch 'master' of http://git.ispconfig.org/ispconfig/ispconfig3

Author: Florian Schaal

interface/lib/classes/plugin.inc.php

@@ -43,35 +43,51 @@ private function loadPluginCache() {
 
 
 		if(isset($_SESSION['s']['plugin_cache'])) unset($_SESSION['s']['plugin_cache']);
-
-		$plugins_dir = ISPC_LIB_PATH.FS_DIV.'plugins'.FS_DIV;
+		
+		$plugin_dirs = array();
+		$plugin_dirs[] = ISPC_LIB_PATH.FS_DIV.'plugins';
+		
+		if(is_dir(ISPC_WEB_PATH)) {
+			if($dh = opendir(ISPC_WEB_PATH)) {
+				while(($file = readdir($dh)) !== false) {
+					if($file !== '.' && $file !== '..' && is_dir(ISPC_WEB_PATH . FS_DIV . $file) && is_dir(ISPC_WEB_PATH . FS_DIV . $file . FS_DIV . 'lib' . FS_DIV . 'plugin.d')) $plugin_dirs[] = ISPC_WEB_PATH . FS_DIV . $file . FS_DIV . 'lib' . FS_DIV . 'plugin.d';
+				}
+				closedir($dh);
+			}
+		}
+		
 		$_SESSION['s']['plugin_cache'] = array();
 		$tmp_plugins = array();
-
-		if (is_dir($plugins_dir)) {
-			if ($dh = opendir($plugins_dir)) {
-				//** Go trough all files in the plugin dir
-				while (($file = readdir($dh)) !== false) {
-					if($file != '.' && $file != '..' && substr($file, -8, 8) == '.inc.php') {
-						$plugin_name = substr($file, 0, -8);
-						$tmp_plugins[$plugin_name] = $file;
+		
+		for($d = 0; $d < count($plugin_dirs); $d++) {
+			$plugins_dir = $plugin_dirs[$d];
+			if (is_dir($plugins_dir)) {
+				if ($dh = opendir($plugins_dir)) {
+					$tmp_plugins = array();
+					//** Go trough all files in the plugin dir
+					while (($file = readdir($dh)) !== false) {
+						if($file !== '.' && $file !== '..' && substr($file, -8, 8) == '.inc.php') {
+							$plugin_name = substr($file, 0, -8);
+							$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();
+					closedir($dh);
+					//** sort the plugins by name
+					ksort($tmp_plugins);
+
+					//** load the plugins
+					foreach($tmp_plugins as $plugin_name => $file) {
+						require $plugins_dir . FS_DIV . $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('Unable to open the plugins directory: '.$plugins_dir, LOGLEVEL_ERROR);
+				$app->log('Plugins directory missing: '.$plugins_dir, LOGLEVEL_ERROR);
 			}
-		} else {
-			$app->log('Plugins directory missing: '.$plugins_dir, LOGLEVEL_ERROR);
 		}
 
 	}
@@ -81,39 +97,44 @@ private function loadPluginCache() {
 	 for faster lookups without the need to load all plugins for every page.
 	*/
 
-	public function registerEvent($event_name, $plugin_name, $function_name) {
+	public function registerEvent($event_name, $plugin_name, $function_name, $module_name = '') {
 		global $app;
 
-		$_SESSION['s']['plugin_cache'][$event_name][] = array('plugin' => $plugin_name, 'function' => $function_name);
+		$_SESSION['s']['plugin_cache'][$event_name][] = array('plugin' => $plugin_name, 'function' => $function_name, 'module' => $module_name);
 		if($this->debug) $app->log("Plugin '$plugin_name' has registered the function '$function_name' for the event '$event_name'", LOGLEVEL_DEBUG);
 	}
 
 	/*
 		This function is called when a certian action occurs, e.g. a form gets saved or a user is logged in.
 	*/
 
-	public function raiseEvent($event_name, $data) {
+	public function raiseEvent($event_name, $data, $return_data = false) {
 		global $app;
 
 		if(!isset($_SESSION['s']['plugin_cache'])) {
 			$this->loadPluginCache();
 			if($this->debug) $app->log('Loaded the plugin cache.', LOGLEVEL_DEBUG);
 		}
-
-
+		
+		$result = '';
 		$sub_events = explode(':', $event_name);
 
 		if(is_array($sub_events)) {
 			if(count($sub_events) == 3) {
 				$tmp_event = $sub_events[2];
 				if($this->debug) $app->log("Called Event '$tmp_event'", LOGLEVEL_DEBUG);
-				$this->callPluginEvent($tmp_event, $data);
+				$tmpresult = $this->callPluginEvent($tmp_event, $data, $return_data);
+				if($return_data == true && $tmpresult) $result .= $tmpresult;
+				
 				$tmp_event = $sub_events[0].':'.$sub_events[2];
 				if($this->debug) $app->log("Called Event '$tmp_event'", LOGLEVEL_DEBUG);
-				$this->callPluginEvent($tmp_event, $data);
+				$tmpresult = $this->callPluginEvent($tmp_event, $data, $return_data);
+				if($return_data == true && $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);
-				$this->callPluginEvent($tmp_event, $data);
+				$tmpresult = $this->callPluginEvent($tmp_event, $data, $return_data);
+				if($return_data == true && $tmpresult) $result .= $tmpresult;
 
 				/*$sub_events = array_reverse($sub_events);
 				$tmp_event = '';
@@ -125,23 +146,36 @@ public function raiseEvent($event_name, $data) {
 				*/
 			} else {
 				if($this->debug) $app->log("Called Event '$sub_events[0]'", LOGLEVEL_DEBUG);
-				$this->callPluginEvent($sub_events[0], $data);
+				$tmpresult = $this->callPluginEvent($sub_events[0], $data, $return_data);
+				if($return_data == true && $tmpresult) $result .= $tmpresult;
 			}
 		}
+		
+		if($return_data == true) return $result;
 
 	} // end function raiseEvent
 
 	//* Internal function to load the plugin and call the event function in the plugin.
-	private function callPluginEvent($event_name, $data) {
+	private function callPluginEvent($event_name, $data, $return_data = false) {
 		global $app;
 
+		$result = '';
+
 		//* execute the functions for the events
 		if(@is_array($_SESSION['s']['plugin_cache'][$event_name])) {
 			foreach($_SESSION['s']['plugin_cache'][$event_name] as $rec) {
 				$plugin_name = $rec['plugin'];
 				$function_name = $rec['function'];
-				$plugin_file = ISPC_LIB_PATH.FS_DIV.'plugins'.FS_DIV.$plugin_name.'.inc.php';
-
+				$module_name = $rec['module'];
+				if($module_name != '') {
+					if(strpos($module_name, '..') !== false || strpos($module_name, '/') !== false) {
+						if($this->debug) $app->log('Module name ' . $module_name . ' contains illegal characters.', LOGLEVEL_DEBUG);
+						continue;
+					}
+					$plugin_file = ISPC_WEB_PATH . FS_DIV . $module_name . FS_DIV . 'lib' . FS_DIV . 'plugin.d' . FS_DIV . $plugin_name . '.inc.php';
+				} else {
+					$plugin_file = ISPC_LIB_PATH . FS_DIV . 'plugins' . FS_DIV . $plugin_name . '.inc.php';
+				}
 
 				if(is_file($plugin_file)) {
 					if(!isset($app->loaded_plugins[$plugin_name])) {
@@ -152,12 +186,14 @@ private function callPluginEvent($event_name, $data) {
 					if($this->debug) $app->log("Called method: '$function_name' in plugin '$plugin_name' for 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);
-
+					$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) return $result;
 
 	} // end functiom callPluginEvent
 

interface/lib/classes/tform_actions.inc.php

@@ -46,7 +46,7 @@ function onLoad() {
 		$app->tpl->newTemplate("tabbed_form.tpl.htm");
 
 		// Load table definition from file
-		$app->tform->loadFormDef($tform_def_file);
+		$app->tform->loadFormDef($tform_def_file, (isset($_SESSION['s']['module']['name']) ? $_SESSION['s']['module']['name'] : ''));
 
 		// Importing ID
 		$this->id = (isset($_REQUEST["id"]))?$app->functions->intval($_REQUEST["id"]):0;
@@ -594,7 +594,7 @@ function loadPlugins($next_tab) {
 				$app->load($plugin_class);
 				$this->plugins[$plugin_name] = new $plugin_class;
 				$this->plugins[$plugin_name]->setOptions($plugin_name, $plugin_settings['options']);
-				// Make the data of the form easily accessible for the plugib
+				// Make the data of the form easily accessible for the plugin
 				$this->plugins[$plugin_name]->form = $this;
 				$this->plugins[$plugin_name]->onLoad();
 			}

interface/lib/classes/tform_base.inc.php

@@ -127,6 +127,7 @@ function loadFormDef($file, $module = '') {
 		global $app, $conf;
 
 		include $file;
+		$app->plugin->raiseEvent($_SESSION['s']['module']['name'].':'.$form['name'] . ':on_before_formdef', $this);
 		$this->formDef = $form;
 
 		$this->module = $module;
@@ -150,8 +151,10 @@ function loadFormDef($file, $module = '') {
 			$wb = $app->functions->array_merge($wb_global, $wb);
 		}
 		if(isset($wb_global)) unset($wb_global);
-
+		
 		$this->wordbook = $wb;
+		
+		$app->plugin->raiseEvent($_SESSION['s']['module']['name'].':'.$app->tform->formDef['name'] . ':on_after_formdef', $this);
 
 		$this->dateformat = $app->lng('conf_format_dateshort');
 		$this->datetimeformat = $app->lng('conf_format_datetime');

interface/lib/classes/tpl.inc.php

@@ -839,28 +839,34 @@ public function __construct($tmplfile = null, $options = null)
 		 * @access private
 		 * @return mixed data/string or boolean
 		 */
-		private function _getData ($tmplfile, $do_eval=false)
+		private function _getData ($tmplfile, $do_eval=false, $tmpl_from_string = false)
 		{
 			//* check the current file depth
 			if ($this->_includedepth > $this->OPTIONS['MAX_INCLUDES'] || $tmplfile == false) {
 				return;
 			} else {
 				if ($this->_debug){
-					array_push($this->_debugIncludedfiles, $tmplfile);
+					if($tmpl_from_string) array_push($this->_debugIncludedfiles, 'String: ' . substr($tmplfile, 0, 25) . '...');
+					else array_push($this->_debugIncludedfiles, $tmplfile);
 				}
 				if ($do_eval) {
-					array_push($this->_currentincludedir, dirname($tmplfile));
+					if($tmpl_from_string == true) array_push($this->_currentincludedir, end($this->_currentincludedir));
+					else array_push($this->_currentincludedir, dirname($tmplfile));
 					$this->_includedepth++;
 				}
 			}
 
 
-			if($this->_cache && $this->_checkCache($tmplfile)) { //* cache exists so lets use it
+			if($this->_cache && $this->_checkCache($tmplfile, $tmpl_from_string)) { //* cache exists so lets use it
 				$data = fread($fp = fopen($this->_cachefile, 'r'), filesize($this->_cachefile));
 				fclose($fp);
 			} else { //* no cache lets parse the file
-				$data = fread($fp = fopen($tmplfile, 'r'), filesize($tmplfile));
-				fclose($fp);
+				if($tmpl_from_string == true) {
+					$data = $tmplfile;
+				} else {
+					$data = fread($fp = fopen($tmplfile, 'r'), filesize($tmplfile));
+					fclose($fp);
+				}
 
 				$regex = '/(<|<\/|{|{\/|<!--|<!--\/){1}\s*';
 				$regex.= 'tmpl_([\w]+)\s*';
@@ -884,7 +890,7 @@ private function _getData ($tmplfile, $do_eval=false)
 			}
 
 			//* now we must parse the $data and check for any <tmpl_include>'s
-			if ($this->_debug) $this->doDebugWarnings(file($tmplfile), $tmplfile);
+			if ($this->_debug && $tmpl_from_string == false) $this->doDebugWarnings(file($tmplfile), $tmplfile);
 
 			if ($do_eval) {
 				$success = @eval('?>'.$data.'<?php return 1;');
@@ -1061,6 +1067,46 @@ private function _parseIf($varname, $value = null, $op = null, $namespace = null
 			}
 		}
 
+		/**
+		 * returns a string containing hook data
+		 * @param string $type
+		 * @param string $name
+		 * @return string hook data
+		 */
+		private function _parseHook ($name)
+		{
+			global $app;
+			
+			if(!$name) return false;
+			
+			$module = isset($_SESSION['s']['module']['name']) ? $_SESSION['s']['module']['name'] : '';
+			$form = isset($app->tform->formDef['name']) ? $app->tform->formDef['name'] : '';
+			
+			$events = array();
+			if($module) {
+				$events[] = $module . ':' . ($form ? $form : '') . ':' . $name;
+				$events[] = $module . ':' . ($form ? $form : '') . ':on_template_content';
+			} else {
+				$events[] = $name;
+				$events[] = 'on_template_content';
+			}
+			
+			$events = array_unique($events);
+			
+			for($e = 0; $e < count($events); $e++) {
+				$tmpresult = $app->plugin->raiseEvent($events[$e], array(
+					'name' => $name,
+					'module' => $module,
+					'form' => $form
+				), true);
+				if(!$tmpresult) $tmpresult = '';
+				else $tmpresult = $this->_getData($tmpresult, false, true);
+				
+				$result .= $tmpresult;
+			}
+			
+			return $result;
+		}
 
 		/**
 		 * returns a string used for parsing in tmpl_loop statements.
@@ -1254,7 +1300,10 @@ private function _parseTag ($args)
 				if ($this->OPTIONS['ENABLE_PHPINCLUDE']) {
 					return '<?php include(\''.$file.'\'); ?>';
 				}
-
+			
+			case 'hook':
+				return $this->_parseHook(@$var);
+			
 			case 'include':
 				return '<?php $this->_getData($this->_fileSearch(\''.$file.'\'), 1); ?>';
 

interface/lib/classes/tpl_cache.inc.php

@@ -101,8 +101,8 @@ function setCacheExtension($str = null) {
 	 * FUNCTION: _checkCache
 	 * checks if there's a cache, if there is then it will read the cache file as the template.
 	 */
-	function _checkCache ($tmplfile) {
-		$this->_cachefile = $this->_getFilename($tmplfile);
+	function _checkCache ($tmplfile, $tmpl_from_string = false) {
+		$this->_cachefile = $this->_getFilename($tmplfile, $tmpl_from_string);
 		if ($this->_clearcache) {
 			if (file_exists($this->_cachefile)) unlink($this->_cachefile);
 			return false;
@@ -133,8 +133,9 @@ function _checkCache ($tmplfile) {
 	 * gets the full pathname for the cached file
 	 *
 	 */
-	function _getFilename($tmplfile) {
-		return $this->OPTIONS['CACHE_DIRECTORY'].'/'.md5('vlibCachestaR'.realpath($tmplfile)).'.'.$this->OPTIONS['CACHE_EXTENSION'];
+	function _getFilename($tmplfile, $tmpl_from_string = false) {
+		if($tmpl_from_string == true) return $this->OPTIONS['CACHE_DIRECTORY'].'/'.md5('vlibCachestaRSTRING'.$tmplfile).'.'.$this->OPTIONS['CACHE_EXTENSION'];
+		else return $this->OPTIONS['CACHE_DIRECTORY'].'/'.md5('vlibCachestaR'.realpath($tmplfile)).'.'.$this->OPTIONS['CACHE_EXTENSION'];
 	}
 
 

interface/web/admin/templates/directive_snippets_edit.htm

@@ -16,7 +16,7 @@ <h1><tmpl_var name="list_head_txt"></h1>
             </div>
 			<div class="form-group">
                 <label for="snippet" class="col-sm-3 control-label">{tmpl_var name='snippet_txt'}</label>
-                <div class="col-sm-9"><textarea class="form-control" name="snippet" id="snippet" rows='10' cols='50'>{tmpl_var name='snippet'}</textarea></div><span class="nginx"> &nbsp; {tmpl_var name='variables_txt'}: </span><a href="javascript:void(0);" class="addPlaceholder nginx">{DOCROOT}</a><span class="nginx">, </span><a href="javascript:void(0);" class="addPlaceholder nginx">{FASTCGIPASS}</a>
+                <div class="col-sm-9"><textarea class="form-control" name="snippet" id="snippet" rows='10' cols='50'>{tmpl_var name='snippet'}</textarea></div><span> &nbsp; {tmpl_var name='variables_txt'}: </span><a href="javascript:void(0);" class="addPlaceholder">{DOCROOT}</a>, <a href="javascript:void(0);" class="addPlaceholder">{DOCROOT_CLIENT}</a><span class="nginx">, </span><a href="javascript:void(0);" class="addPlaceholder nginx">{FASTCGIPASS}</a>
             </div>
 			<div class="form-group php">
                 <label class="col-sm-3 control-label">{tmpl_var name='required_php_snippets_txt'}</label>