patrickpr / trapdirector

library/Trapdirector/TrapsController.php

Indentation +113 added lines, -113 removed lines

@@ -32,8 +32,8 @@ 
 	protected $trapClass;		//< Trap class for bin/trap_class.php
 		
 	/** Get instance of TrapModuleConfig class
-	*	@return TrapModuleConfig
-	*/
+	 *	@return TrapModuleConfig
+	 */
 	public function getModuleConfig() 
 	{
 		if ($this->moduleConfig == Null) 
@@ -58,12 +58,12 @@ 
 	
 	public function getTrapHostListTable()
 	{
-	    if ($this->trapTableHostList == Null) 
+		if ($this->trapTableHostList == Null) 
 		{
-	        $this->trapTableHostList = new TrapTableHostList();
-	        $this->trapTableHostList->setConfig($this->getModuleConfig());
-	    }
-	    return $this->trapTableHostList;
+			$this->trapTableHostList = new TrapTableHostList();
+			$this->trapTableHostList->setConfig($this->getModuleConfig());
+		}
+		return $this->trapTableHostList;
 	}
 	
 	public function getHandlerListTable() 
@@ -77,11 +77,11 @@ 
 	}	
 	
 	/**	Get Database connexion
-	*	@param $DBname string DB name in resource.ini_ge
-	*	@param $test bool if set to true, returns error code and not database
-	*	@param $test_version bool if set to flase, does not test database version of trapDB
-	*	@return array<integer,mixed>|mixed : if test=false, returns DB connexion, else array(error_num,message) or null on error.
-	*/
+	 *	@param $DBname string DB name in resource.ini_ge
+	 *	@param $test bool if set to true, returns error code and not database
+	 *	@param $test_version bool if set to flase, does not test database version of trapDB
+	 *	@return array<integer,mixed>|mixed : if test=false, returns DB connexion, else array(error_num,message) or null on error.
+	 */
 	public function getDbByName($DBname,$test=false,$test_version=true)
 	{
 		try 
@@ -161,20 +161,20 @@ 
 
 		if ( ! $dbresource )
 		{
-		    if ($test) return array(1,'No database in config.ini');
-		    $this->redirectNow('trapdirector/settings?idodberror=1');
-		    return null;
+			if ($test) return array(1,'No database in config.ini');
+			$this->redirectNow('trapdirector/settings?idodberror=1');
+			return null;
 		}
 		
 		try
 		{
-		    $dbconn = IcingaDbConnection::fromResourceName($dbresource);
+			$dbconn = IcingaDbConnection::fromResourceName($dbresource);
 		}
 		catch (Exception $e)
 		{
-		    if ($test) return array(2,"Database $dbresource does not exists in IcingaWeb2");
-		    $this->redirectNow('trapdirector/settings?idodberror=2');
-		    return null;
+			if ($test) return array(2,"Database $dbresource does not exists in IcingaWeb2");
+			$this->redirectNow('trapdirector/settings?idodberror=2');
+			return null;
 		}
 		
 		if ($test == false) 
@@ -185,13 +185,13 @@ 
 		
 		try
 		{
-		    $query = $dbconn->select()
-		    ->from('icinga_dbversion',array('version'));
-		    $version=$dbconn->fetchRow($query);
-		    if ( ($version == null) || ! property_exists($version,'version') )
-		    {
-		        return array(4,"$dbresource does not look like an IDO database");
-		    }
+			$query = $dbconn->select()
+			->from('icinga_dbversion',array('version'));
+			$version=$dbconn->fetchRow($query);
+			if ( ($version == null) || ! property_exists($version,'version') )
+			{
+				return array(4,"$dbresource does not look like an IDO database");
+			}
 		}
 		catch (Exception $e)
 		{
@@ -201,15 +201,15 @@ 
 		return array(0,'');
 	}
 	
-    protected function applyPaginationLimits(Paginatable $paginatable, $limit = 25, $offset = null)
-    {
-        $limit = $this->params->get('limit', $limit);
-        $page = $this->params->get('page', $offset);
+	protected function applyPaginationLimits(Paginatable $paginatable, $limit = 25, $offset = null)
+	{
+		$limit = $this->params->get('limit', $limit);
+		$page = $this->params->get('page', $offset);
 
-        $paginatable->limit($limit, $page > 0 ? ($page - 1) * $limit : 0);
+		$paginatable->limit($limit, $page > 0 ? ($page - 1) * $limit : 0);
 
-        return $paginatable;
-    }	
+		return $paginatable;
+	}	
 	
 	public function displayExitError($source,$message)
 	{	// TODO : check better ways to transmit data (with POST ?)
@@ -218,33 +218,33 @@ 
 	
 	protected function checkReadPermission()
 	{
-        if (! $this->Auth()->hasPermission('trapdirector/view')) {
-            $this->displayExitError('Permissions','No permission fo view content');
-        }		
+		if (! $this->Auth()->hasPermission('trapdirector/view')) {
+			$this->displayExitError('Permissions','No permission fo view content');
+		}		
 	}
 
 	protected function checkConfigPermission()
 	{
-        if (! $this->Auth()->hasPermission('trapdirector/config')) {
-            $this->displayExitError('Permissions','No permission fo configure');
-        }		
+		if (! $this->Auth()->hasPermission('trapdirector/config')) {
+			$this->displayExitError('Permissions','No permission fo configure');
+		}		
 	}
 	
-    /**
-     * Check if user has write permission
-     * @param number $check optional : if set to 1, return true (user has permission) or false instead of displaying error page
-     * @return boolean : user has permission
-     */
+	/**
+	 * Check if user has write permission
+	 * @param number $check optional : if set to 1, return true (user has permission) or false instead of displaying error page
+	 * @return boolean : user has permission
+	 */
 	protected function checkModuleConfigPermission($check=0)
 	{
-        if (! $this->Auth()->hasPermission('trapdirector/module_config')) {
-            if ($check == 0)
-            {
-                $this->displayExitError('Permissions','No permission fo configure module');
-            }
-            return false;
-        }
-        return true;
+		if (! $this->Auth()->hasPermission('trapdirector/module_config')) {
+			if ($check == 0)
+			{
+				$this->displayExitError('Permissions','No permission fo configure module');
+			}
+			return false;
+		}
+		return true;
 	}
 
 	/*************************  Trap class get **********************/
@@ -264,8 +264,8 @@ 
 	/************************** MIB related **************************/
 	
 	/** Get MIBLoader class
-	*	@return MIBLoader class
-	*/
+	 *	@return MIBLoader class
+	 */
 	protected function getMIB()
 	{
 		if ($this->MIBData == null)
@@ -283,9 +283,9 @@ 
 	/**************************  Database queries *******************/
 	
 	/** Get host(s) by IP (v4 or v6) or by name in IDO database
-	*	does not catch exceptions
-	*	@return array of objects ( name, id (object_id), display_name)
-	*/
+	 *	does not catch exceptions
+	 *	@return array of objects ( name, id (object_id), display_name)
+	 */
 	protected function getHostByIP($ip) 
 	{
 		// select a.name1, b.display_name from icinga.icinga_objects AS a , icinga.icinga_hosts AS b WHERE (b.address = '192.168.56.101' OR b.address6= '123456') and b.host_object_id=a.object_id
@@ -304,9 +304,9 @@ 
 	}
 
 	/** Get host(s) by name in IDO database
-	*	does not catch exceptions
-	*	@return array of objects ( name, id (object_id), display_name)
-	*/
+	 *	does not catch exceptions
+	 *	@return array of objects ( name, id (object_id), display_name)
+	 */
 	protected function getHostByName($name) 
 	{
 		// select a.name1, b.display_name from icinga.icinga_objects AS a , icinga.icinga_hosts AS b WHERE (b.address = '192.168.56.101' OR b.address6= '123456') and b.host_object_id=a.object_id
@@ -325,9 +325,9 @@ 
 	}	
 	
 	/** Get host groups by  name in IDO database
-	*	does not catch exceptions
-	*	@return array of objects ( name, id (object_id), display_name)
-	*/
+	 *	does not catch exceptions
+	 *	@return array of objects ( name, id (object_id), display_name)
+	 */
 	protected function getHostGroupByName($ip) 
 	{
 		// select a.name1, b.display_name from icinga.icinga_objects AS a , icinga.icinga_hosts AS b WHERE (b.address = '192.168.56.101' OR b.address6= '123456') and b.host_object_id=a.object_id
@@ -347,9 +347,9 @@ 
 
 	
 	/** Get host IP (v4 and v6) by name in IDO database
-	*	does not catch exceptions
-	*	@return array ( name, display_name, ip4, ip6)
-	*/
+	 *	does not catch exceptions
+	 *	@return array ( name, display_name, ip4, ip6)
+	 */
 	protected function getHostInfoByID($id) 
 	{
 		if (!preg_match('/^[0-9]+$/',$id)) { throw new Exception('Invalid id');  }
@@ -368,9 +368,9 @@ 
 
 	
 	/** Get host by objectid  in IDO database
-	*	does not catch exceptions
-	*	@return array of objects ( id, name, display_name, ip, ip6,  )
-	*/
+	 *	does not catch exceptions
+	 *	@return array of objects ( id, name, display_name, ip, ip6,  )
+	 */
 	protected function getHostByObjectID($id) // TODO : duplicate of getHostInfoByID above
 	{
 		if (!preg_match('/^[0-9]+$/',$id)) { throw new Exception('Invalid id');  }
@@ -388,10 +388,10 @@ 
 	}	
 	
 	/** Get services from object ( host_object_id) in IDO database
-	*	does not catch exceptions
-	*	@param $id	int object_id
-	*	@return array display_name (of service), service_object_id
-	*/
+	 *	does not catch exceptions
+	 *	@param $id	int object_id
+	 *	@return array display_name (of service), service_object_id
+	 */
 	protected function getServicesByHostid($id) 
 	{
 		// select a.name1, b.display_name from icinga.icinga_objects AS a , icinga.icinga_hosts AS b WHERE (b.address = '192.168.56.101' OR b.address6= '123456') and b.host_object_id=a.object_id
@@ -411,11 +411,11 @@ 
 	}	
 	
 	/** Get services from hostgroup object id ( hostgroup_object_id) in IDO database
-	* 	gets all hosts in hostgroup and return common services
-	*	does not catch exceptions
-	*	@param $id	int object_id
-	*	@return array display_name (of service), service_object_id
-	*/
+	 * 	gets all hosts in hostgroup and return common services
+	 *	does not catch exceptions
+	 *	@param $id	int object_id
+	 *	@return array display_name (of service), service_object_id
+	 */
 	protected function getServicesByHostGroupid($id) 
 	{		
 		if (!preg_match('/^[0-9]+$/',$id)) { throw new Exception('Invalid id');  }
@@ -454,7 +454,7 @@ 
 		//print_r($common_services);
 		foreach (array_keys($common_services) as $key)
 		{
-		    if ($common_services[$key]['num'] == $num_hosts)
+			if ($common_services[$key]['num'] == $num_hosts)
 			{
 				array_push($result,array($key,$common_services[$key]['name']));
 			}
@@ -464,11 +464,11 @@ 
 	}	
 
 	/** Get services object id by host name / service name in IDO database
-	*	does not catch exceptions
-	*	@param $hostname string host name
-	*	@param $name string service name
-	*	@return int  service id
-	*/
+	 *	does not catch exceptions
+	 *	@param $hostname string host name
+	 *	@param $name string service name
+	 *	@return int  service id
+	 */
 	protected function getServiceIDByName($hostname,$name) 
 	{
 		$db = $this->getIdoDb()->getConnection();
@@ -491,10 +491,10 @@ 
 	}
 	
 	/** Get object name from object_id  in IDO database
-	*	does not catch exceptions
-	*	@param int $id object_id (default to null, used first if not null)
-	*	@return array name1 (host) name2 (service)
-	*/
+	 *	does not catch exceptions
+	 *	@param int $id object_id (default to null, used first if not null)
+	 *	@return array name1 (host) name2 (service)
+	 */
 	protected function getObjectNameByid($id) 
 	{
 		// select a.name1, b.display_name from icinga.icinga_objects AS a , icinga.icinga_hosts AS b WHERE (b.address = '192.168.56.101' OR b.address6= '123456') and b.host_object_id=a.object_id
@@ -510,9 +510,9 @@ 
 	}		
 
 	/** Add handler rule in traps DB
-	*	@param array(<db item>=><value>)
-	*	@return int inserted id
-	*/
+	 *	@param array(<db item>=><value>)
+	 *	@return int inserted id
+	 */
 	protected function addHandlerRule($params)
 	{
 		// TODO Check for rule consistency
@@ -534,9 +534,9 @@ 
 	}	
 
 	/** Update handler rule in traps DB
-	*	@param array(<db item>=><value>)
-	*	@return array affected rows
-	*/
+	 *	@param array(<db item>=><value>)
+	 *	@return array affected rows
+	 */
 	protected function updateHandlerRule($params,$ruleID)
 	{
 		// TODO Check for rule consistency
@@ -554,8 +554,8 @@ 
 	}	
 	
 	/** Delete rule by id
-	*	@param int $ruleID rule id
-	*/
+	 *	@param int $ruleID rule id
+	 */
 	protected function deleteRule($ruleID)
 	{
 		if (!preg_match('/^[0-9]+$/',$ruleID)) { throw new Exception('Invalid id');  }
@@ -569,9 +569,9 @@ 
 	}
 
 	/** Delete trap by ip & oid
-	*	@param $ip string source IP (v4 or v6)
-	*	@param $oid string oid
-	*/
+	 *	@param $ip string source IP (v4 or v6)
+	 *	@param $oid string oid
+	 */
 	protected function deleteTrap($ip,$oid)
 	{
 		
@@ -597,9 +597,9 @@ 
    
 
 	/** count trap by ip & oid
-	*	@param $ip string source IP (v4 or v6)
-	*	@param $oid string oid
-	*/
+	 *	@param $ip string source IP (v4 or v6)
+	 *	@param $oid string oid
+	 */
 	protected function countTrap($ip,$oid)
 	{
 		
@@ -625,8 +625,8 @@ 
 	}		
 	
 	/** get configuration value
-	*	@param configuration name in db
-	*/
+	 *	@param configuration name in db
+	 */
 	protected function getDBConfigValue($element)
 	{
 	
@@ -657,8 +657,8 @@ 
 	}
 
 	/** add configuration value
-	*	@param name value
-	*/
+	 *	@param name value
+	 */
 	protected function addDBConfigValue($element,$value)
 	{
 	
@@ -675,8 +675,8 @@ 
 	}
 
 	/** set configuration value
-	*	@param name value
-	*/
+	 *	@param name value
+	 */
 	protected function setDBConfigValue($element,$value)
 	{
 	
@@ -690,13 +690,13 @@ 
 	}
 	
 	/** Check if director is installed
-	*	@return bool true/false
-	*/
+	 *	@return bool true/false
+	 */
 	protected function isDirectorInstalled()
 	{
-	    $output=array();
-	    exec('icingacli module list',$output);
-	    foreach ($output as $line)
+		$output=array();
+		exec('icingacli module list',$output);
+		foreach ($output as $line)
 		{
 			if (preg_match('/^director .*enabled/',$line))
 			{