patrickpr / trapdirector

library/Trapdirector/TrapsProcess/TrapConfig.php

Indentation +159 added lines, -159 removed lines

@@ -15,183 +15,183 @@
 trait TrapConfig
 {
 
-    /** @return \Trapdirector\Logging   */
-    abstract public function getLogging();
-    /** @return \Trapdirector\TrapApi   */
-    abstract public function getTrapApi();
+	/** @return \Trapdirector\Logging   */
+	abstract public function getLogging();
+	/** @return \Trapdirector\TrapApi   */
+	abstract public function getTrapApi();
     
-    /**
-     * Get option from array of ini file, send message if empty
-     * @param string $option_array Array of ini file
-     * @param string $option_category category in ini file
-     * @param string $option_name name of option in category
-     * @param mixed $option_var variable to fill if found, left untouched if not found
-     * @param integer $log_level default 2 (warning)
-     * @param string $message warning message if not found
-     * @return boolean true if found, or false
-     */
-    protected function getOptionIfSet($option_array,$option_category,$option_name, &$option_var, $log_level = WARN, $message = null)
-    {
-        if (!isset($option_array[$option_category][$option_name]))
-        {
-            if ($message === null)
-            {
-                $message='No ' . $option_name . ' in config file: '. $this->trapModuleConfig;
-            }
-            $this->getLogging()->log($message,$log_level);
-            return false;
-        }
-        else
-        {
-            $option_var=$option_array[$option_category][$option_name];
-            return true;
-        }
-    }
+	/**
+	 * Get option from array of ini file, send message if empty
+	 * @param string $option_array Array of ini file
+	 * @param string $option_category category in ini file
+	 * @param string $option_name name of option in category
+	 * @param mixed $option_var variable to fill if found, left untouched if not found
+	 * @param integer $log_level default 2 (warning)
+	 * @param string $message warning message if not found
+	 * @return boolean true if found, or false
+	 */
+	protected function getOptionIfSet($option_array,$option_category,$option_name, &$option_var, $log_level = WARN, $message = null)
+	{
+		if (!isset($option_array[$option_category][$option_name]))
+		{
+			if ($message === null)
+			{
+				$message='No ' . $option_name . ' in config file: '. $this->trapModuleConfig;
+			}
+			$this->getLogging()->log($message,$log_level);
+			return false;
+		}
+		else
+		{
+			$option_var=$option_array[$option_category][$option_name];
+			return true;
+		}
+	}
 
-    /**
-     * Get options in database
-     */
-    protected function getDatabaseOptions()
-    {
-        // Database options
-        if ($this->logSetup === false) // Only if logging was no setup in constructor
-        {
-            $this->getDBConfigIfSet('log_level',$this->getLogging()->debugLevel);
-            $this->getDBConfigIfSet('log_destination',$this->getLogging()->outputMode);
-            $this->getDBConfigIfSet('log_file',$this->getLogging()->outputFile);
-        }
-    }
+	/**
+	 * Get options in database
+	 */
+	protected function getDatabaseOptions()
+	{
+		// Database options
+		if ($this->logSetup === false) // Only if logging was no setup in constructor
+		{
+			$this->getDBConfigIfSet('log_level',$this->getLogging()->debugLevel);
+			$this->getDBConfigIfSet('log_destination',$this->getLogging()->outputMode);
+			$this->getDBConfigIfSet('log_file',$this->getLogging()->outputFile);
+		}
+	}
         
-    /** Set $variable to value if $element found in database config table
-     * @param string $element
-     * @param string $variable
-     */
-    protected function getDBConfigIfSet($element,&$variable)
-    {
-        $value=$this->getDBConfig($element);
-        if ($value != null) $variable=$value;
-    }
+	/** Set $variable to value if $element found in database config table
+	 * @param string $element
+	 * @param string $variable
+	 */
+	protected function getDBConfigIfSet($element,&$variable)
+	{
+		$value=$this->getDBConfig($element);
+		if ($value != null) $variable=$value;
+	}
     
-    /**
-     *   Get data from db_config
-     *	@param $element string name of param
-     *	@return mixed : value (or null)
-     */
-    protected function getDBConfig($element)  // TODO : put this in DB class
-    {
-        $db_conn=$this->trapsDB->db_connect_trap();
-        $sql='SELECT value from '.$this->dbPrefix.'db_config WHERE ( name=\''.$element.'\' )';
-        if (($ret_code=$db_conn->query($sql)) === false) {
-            $this->logging->log('No result in query : ' . $sql,WARN,'');
-            return null;
-        }
-        $value=$ret_code->fetch();
-        if ($value != null && isset($value['value']))
-        {
-            return $value['value'];
-        }
-        return null;
-    }
+	/**
+	 *   Get data from db_config
+	 *	@param $element string name of param
+	 *	@return mixed : value (or null)
+	 */
+	protected function getDBConfig($element)  // TODO : put this in DB class
+	{
+		$db_conn=$this->trapsDB->db_connect_trap();
+		$sql='SELECT value from '.$this->dbPrefix.'db_config WHERE ( name=\''.$element.'\' )';
+		if (($ret_code=$db_conn->query($sql)) === false) {
+			$this->logging->log('No result in query : ' . $sql,WARN,'');
+			return null;
+		}
+		$value=$ret_code->fetch();
+		if ($value != null && isset($value['value']))
+		{
+			return $value['value'];
+		}
+		return null;
+	}
     
-    /**
-     * Get options from ini file
-     * @param array $trap_config : ini file array
-     */
-    protected function getMainOptions($trapConfig)
-    {
+	/**
+	 * Get options from ini file
+	 * @param array $trap_config : ini file array
+	 */
+	protected function getMainOptions($trapConfig)
+	{
         
-        $nodeStatus='';
-        $this->getOptionIfSet($trapConfig,'config','node', $nodeStatus);
-        if ($this->getTrapApi()->setStatus($nodeStatus) === FALSE)
-        {
-            $this->getLogging()->log('Unknown node status '.$nodeStatus.' : setting to MASTER',WARN);
-            $this->getTrapApi()->setStatusMaster();
-        }
-        else 
-        {
-            if ($this->getTrapApi()->getStatus() != TrapApi::MASTER)
-            {
-                // Get options to connect to API
-                $IP = $port = $user =  $pass = null;
-                $this->getOptionIfSet($trapConfig,'config','masterIP', $IP, ERROR);
-                $this->getOptionIfSet($trapConfig,'config','masterPort', $port, ERROR);
-                $this->getOptionIfSet($trapConfig,'config','masterUser', $user, ERROR);
-                $this->getOptionIfSet($trapConfig,'config','masterPass', $pass, ERROR);
-                $this->getTrapApi()->setParams($IP, $port, $user, $pass);
-                return;
-            }
-        }
+		$nodeStatus='';
+		$this->getOptionIfSet($trapConfig,'config','node', $nodeStatus);
+		if ($this->getTrapApi()->setStatus($nodeStatus) === FALSE)
+		{
+			$this->getLogging()->log('Unknown node status '.$nodeStatus.' : setting to MASTER',WARN);
+			$this->getTrapApi()->setStatusMaster();
+		}
+		else 
+		{
+			if ($this->getTrapApi()->getStatus() != TrapApi::MASTER)
+			{
+				// Get options to connect to API
+				$IP = $port = $user =  $pass = null;
+				$this->getOptionIfSet($trapConfig,'config','masterIP', $IP, ERROR);
+				$this->getOptionIfSet($trapConfig,'config','masterPort', $port, ERROR);
+				$this->getOptionIfSet($trapConfig,'config','masterUser', $user, ERROR);
+				$this->getOptionIfSet($trapConfig,'config','masterPass', $pass, ERROR);
+				$this->getTrapApi()->setParams($IP, $port, $user, $pass);
+				return;
+			}
+		}
         
-        // Snmptranslate binary path
-        $this->getOptionIfSet($trapConfig,'config','snmptranslate', $this->snmptranslate);
+		// Snmptranslate binary path
+		$this->getOptionIfSet($trapConfig,'config','snmptranslate', $this->snmptranslate);
         
-        // mibs path
-        $this->getOptionIfSet($trapConfig,'config','snmptranslate_dirs', $this->snmptranslate_dirs);
+		// mibs path
+		$this->getOptionIfSet($trapConfig,'config','snmptranslate_dirs', $this->snmptranslate_dirs);
         
-        // icinga2cmd path
-        $this->getOptionIfSet($trapConfig,'config','icingacmd', $this->icinga2cmd);
+		// icinga2cmd path
+		$this->getOptionIfSet($trapConfig,'config','icingacmd', $this->icinga2cmd);
         
-        // table prefix
-        $this->getOptionIfSet($trapConfig,'config','database_prefix', $this->dbPrefix);
+		// table prefix
+		$this->getOptionIfSet($trapConfig,'config','database_prefix', $this->dbPrefix);
         
-        // API options
-        if ($this->getOptionIfSet($trapConfig,'config','icingaAPI_host', $this->apiHostname))
-        {
-            $this->apiUse=true;
-            // Get API options or throw exception as not configured correctly
-            $this->getOptionIfSet($trapConfig,'config','icingaAPI_port', $this->apiPort,ERROR);
-            $this->getOptionIfSet($trapConfig,'config','icingaAPI_user', $this->apiUsername,ERROR);
-            $this->getOptionIfSet($trapConfig,'config','icingaAPI_password', $this->apiPassword,ERROR);
-        }
-    }
+		// API options
+		if ($this->getOptionIfSet($trapConfig,'config','icingaAPI_host', $this->apiHostname))
+		{
+			$this->apiUse=true;
+			// Get API options or throw exception as not configured correctly
+			$this->getOptionIfSet($trapConfig,'config','icingaAPI_port', $this->apiPort,ERROR);
+			$this->getOptionIfSet($trapConfig,'config','icingaAPI_user', $this->apiUsername,ERROR);
+			$this->getOptionIfSet($trapConfig,'config','icingaAPI_password', $this->apiPassword,ERROR);
+		}
+	}
     
-    /**
-     * Create and setup database class for trap & ido (if no api) db
-     * @param array $trap_config : ini file array
-     */
-    protected function setupDatabase($trapConfig)
-    {
-        // Trap database
-        if (!array_key_exists('database',$trapConfig['config']))
-        {
-            $this->logging->log("No database in config file: ".$this->trapModuleConfig,ERROR,'');
-            return;
-        }
-        $dbTrapName=$trapConfig['config']['database'];
-        $this->logging->log("Found database in config file: ".$dbTrapName,INFO );
+	/**
+	 * Create and setup database class for trap & ido (if no api) db
+	 * @param array $trap_config : ini file array
+	 */
+	protected function setupDatabase($trapConfig)
+	{
+		// Trap database
+		if (!array_key_exists('database',$trapConfig['config']))
+		{
+			$this->logging->log("No database in config file: ".$this->trapModuleConfig,ERROR,'');
+			return;
+		}
+		$dbTrapName=$trapConfig['config']['database'];
+		$this->logging->log("Found database in config file: ".$dbTrapName,INFO );
         
-        if ( ($dbConfig=parse_ini_file($this->icingaweb2Ressources,true)) === false)
-        {
-            $this->logging->log("Error reading ini file : ".$this->icingaweb2Ressources,ERROR,'');
-            return;
-        }
-        if (!array_key_exists($dbTrapName,$dbConfig))
-        {
-            $this->logging->log("No database '.$dbTrapName.' in config file: ".$this->icingaweb2Ressources,ERROR,'');
-            return;
-        }
+		if ( ($dbConfig=parse_ini_file($this->icingaweb2Ressources,true)) === false)
+		{
+			$this->logging->log("Error reading ini file : ".$this->icingaweb2Ressources,ERROR,'');
+			return;
+		}
+		if (!array_key_exists($dbTrapName,$dbConfig))
+		{
+			$this->logging->log("No database '.$dbTrapName.' in config file: ".$this->icingaweb2Ressources,ERROR,'');
+			return;
+		}
         
-        $this->trapsDB = new Database($this->logging,$dbConfig[$dbTrapName],$this->dbPrefix);
+		$this->trapsDB = new Database($this->logging,$dbConfig[$dbTrapName],$this->dbPrefix);
         
-        //TODO enable this again when API queries are all done :  $this->logging->log("API Use : ".print_r($this->apiUse,true),INFO );
+		//TODO enable this again when API queries are all done :  $this->logging->log("API Use : ".print_r($this->apiUse,true),INFO );
         
-        if ($this->apiUse === true) return; // In case of API use, no IDO is necessary
+		if ($this->apiUse === true) return; // In case of API use, no IDO is necessary
         
-        // IDO Database
-        if (!array_key_exists('IDOdatabase',$trapConfig['config']))
-        {
-            $this->logging->log("No IDOdatabase in config file: ".$this->trapModuleConfig,ERROR,'');
-        }
-        $dbIdoName=$trapConfig['config']['IDOdatabase'];
+		// IDO Database
+		if (!array_key_exists('IDOdatabase',$trapConfig['config']))
+		{
+			$this->logging->log("No IDOdatabase in config file: ".$this->trapModuleConfig,ERROR,'');
+		}
+		$dbIdoName=$trapConfig['config']['IDOdatabase'];
         
-        $this->logging->log("Found IDO database in config file: ".$dbIdoName,INFO );
-        if (!array_key_exists($dbIdoName,$dbConfig))
-        {
-            $this->logging->log("No database '.$dbIdoName.' in config file: ".$this->icingaweb2Ressources,ERROR,'');
-            return;
-        }
+		$this->logging->log("Found IDO database in config file: ".$dbIdoName,INFO );
+		if (!array_key_exists($dbIdoName,$dbConfig))
+		{
+			$this->logging->log("No database '.$dbIdoName.' in config file: ".$this->icingaweb2Ressources,ERROR,'');
+			return;
+		}
         
-        $this->trapsDB->setupIDO($dbConfig[$dbIdoName]);
-    }
+		$this->trapsDB->setupIDO($dbConfig[$dbIdoName]);
+	}
     
 }
\ No newline at end of file

Spacing +36 added lines, -36 removed lines

@@ -30,15 +30,15 @@ 
      * @param string $message warning message if not found
      * @return boolean true if found, or false
      */
-    protected function getOptionIfSet($option_array,$option_category,$option_name, &$option_var, $log_level = WARN, $message = null)
+    protected function getOptionIfSet($option_array, $option_category, $option_name, &$option_var, $log_level=WARN, $message=null)
     {
         if (!isset($option_array[$option_category][$option_name]))
         {
             if ($message === null)
             {
-                $message='No ' . $option_name . ' in config file: '. $this->trapModuleConfig;
+                $message='No '.$option_name.' in config file: '.$this->trapModuleConfig;
             }
-            $this->getLogging()->log($message,$log_level);
+            $this->getLogging()->log($message, $log_level);
             return false;
         }
         else
@@ -56,9 +56,9 @@ 
         // Database options
         if ($this->logSetup === false) // Only if logging was no setup in constructor
         {
-            $this->getDBConfigIfSet('log_level',$this->getLogging()->debugLevel);
-            $this->getDBConfigIfSet('log_destination',$this->getLogging()->outputMode);
-            $this->getDBConfigIfSet('log_file',$this->getLogging()->outputFile);
+            $this->getDBConfigIfSet('log_level', $this->getLogging()->debugLevel);
+            $this->getDBConfigIfSet('log_destination', $this->getLogging()->outputMode);
+            $this->getDBConfigIfSet('log_file', $this->getLogging()->outputFile);
         }
     }
         
@@ -66,7 +66,7 @@ 
      * @param string $element
      * @param string $variable
      */
-    protected function getDBConfigIfSet($element,&$variable)
+    protected function getDBConfigIfSet($element, &$variable)
     {
         $value=$this->getDBConfig($element);
         if ($value != null) $variable=$value;
@@ -82,7 +82,7 @@ 
         $db_conn=$this->trapsDB->db_connect_trap();
         $sql='SELECT value from '.$this->dbPrefix.'db_config WHERE ( name=\''.$element.'\' )';
         if (($ret_code=$db_conn->query($sql)) === false) {
-            $this->logging->log('No result in query : ' . $sql,WARN,'');
+            $this->logging->log('No result in query : '.$sql, WARN, '');
             return null;
         }
         $value=$ret_code->fetch();
@@ -101,10 +101,10 @@ 
     {
         
         $nodeStatus='';
-        $this->getOptionIfSet($trapConfig,'config','node', $nodeStatus);
+        $this->getOptionIfSet($trapConfig, 'config', 'node', $nodeStatus);
         if ($this->getTrapApi()->setStatus($nodeStatus) === FALSE)
         {
-            $this->getLogging()->log('Unknown node status '.$nodeStatus.' : setting to MASTER',WARN);
+            $this->getLogging()->log('Unknown node status '.$nodeStatus.' : setting to MASTER', WARN);
             $this->getTrapApi()->setStatusMaster();
         }
         else 
@@ -112,36 +112,36 @@ 
             if ($this->getTrapApi()->getStatus() != TrapApi::MASTER)
             {
                 // Get options to connect to API
-                $IP = $port = $user =  $pass = null;
-                $this->getOptionIfSet($trapConfig,'config','masterIP', $IP, ERROR);
-                $this->getOptionIfSet($trapConfig,'config','masterPort', $port, ERROR);
-                $this->getOptionIfSet($trapConfig,'config','masterUser', $user, ERROR);
-                $this->getOptionIfSet($trapConfig,'config','masterPass', $pass, ERROR);
+                $IP=$port=$user=$pass=null;
+                $this->getOptionIfSet($trapConfig, 'config', 'masterIP', $IP, ERROR);
+                $this->getOptionIfSet($trapConfig, 'config', 'masterPort', $port, ERROR);
+                $this->getOptionIfSet($trapConfig, 'config', 'masterUser', $user, ERROR);
+                $this->getOptionIfSet($trapConfig, 'config', 'masterPass', $pass, ERROR);
                 $this->getTrapApi()->setParams($IP, $port, $user, $pass);
                 return;
             }
         }
         
         // Snmptranslate binary path
-        $this->getOptionIfSet($trapConfig,'config','snmptranslate', $this->snmptranslate);
+        $this->getOptionIfSet($trapConfig, 'config', 'snmptranslate', $this->snmptranslate);
         
         // mibs path
-        $this->getOptionIfSet($trapConfig,'config','snmptranslate_dirs', $this->snmptranslate_dirs);
+        $this->getOptionIfSet($trapConfig, 'config', 'snmptranslate_dirs', $this->snmptranslate_dirs);
         
         // icinga2cmd path
-        $this->getOptionIfSet($trapConfig,'config','icingacmd', $this->icinga2cmd);
+        $this->getOptionIfSet($trapConfig, 'config', 'icingacmd', $this->icinga2cmd);
         
         // table prefix
-        $this->getOptionIfSet($trapConfig,'config','database_prefix', $this->dbPrefix);
+        $this->getOptionIfSet($trapConfig, 'config', 'database_prefix', $this->dbPrefix);
         
         // API options
-        if ($this->getOptionIfSet($trapConfig,'config','icingaAPI_host', $this->apiHostname))
+        if ($this->getOptionIfSet($trapConfig, 'config', 'icingaAPI_host', $this->apiHostname))
         {
             $this->apiUse=true;
             // Get API options or throw exception as not configured correctly
-            $this->getOptionIfSet($trapConfig,'config','icingaAPI_port', $this->apiPort,ERROR);
-            $this->getOptionIfSet($trapConfig,'config','icingaAPI_user', $this->apiUsername,ERROR);
-            $this->getOptionIfSet($trapConfig,'config','icingaAPI_password', $this->apiPassword,ERROR);
+            $this->getOptionIfSet($trapConfig, 'config', 'icingaAPI_port', $this->apiPort, ERROR);
+            $this->getOptionIfSet($trapConfig, 'config', 'icingaAPI_user', $this->apiUsername, ERROR);
+            $this->getOptionIfSet($trapConfig, 'config', 'icingaAPI_password', $this->apiPassword, ERROR);
         }
     }
     
@@ -152,42 +152,42 @@ 
     protected function setupDatabase($trapConfig)
     {
         // Trap database
-        if (!array_key_exists('database',$trapConfig['config']))
+        if (!array_key_exists('database', $trapConfig['config']))
         {
-            $this->logging->log("No database in config file: ".$this->trapModuleConfig,ERROR,'');
+            $this->logging->log("No database in config file: ".$this->trapModuleConfig, ERROR, '');
             return;
         }
         $dbTrapName=$trapConfig['config']['database'];
-        $this->logging->log("Found database in config file: ".$dbTrapName,INFO );
+        $this->logging->log("Found database in config file: ".$dbTrapName, INFO);
         
-        if ( ($dbConfig=parse_ini_file($this->icingaweb2Ressources,true)) === false)
+        if (($dbConfig=parse_ini_file($this->icingaweb2Ressources, true)) === false)
         {
-            $this->logging->log("Error reading ini file : ".$this->icingaweb2Ressources,ERROR,'');
+            $this->logging->log("Error reading ini file : ".$this->icingaweb2Ressources, ERROR, '');
             return;
         }
-        if (!array_key_exists($dbTrapName,$dbConfig))
+        if (!array_key_exists($dbTrapName, $dbConfig))
         {
-            $this->logging->log("No database '.$dbTrapName.' in config file: ".$this->icingaweb2Ressources,ERROR,'');
+            $this->logging->log("No database '.$dbTrapName.' in config file: ".$this->icingaweb2Ressources, ERROR, '');
             return;
         }
         
-        $this->trapsDB = new Database($this->logging,$dbConfig[$dbTrapName],$this->dbPrefix);
+        $this->trapsDB=new Database($this->logging, $dbConfig[$dbTrapName], $this->dbPrefix);
         
         //TODO enable this again when API queries are all done :  $this->logging->log("API Use : ".print_r($this->apiUse,true),INFO );
         
         if ($this->apiUse === true) return; // In case of API use, no IDO is necessary
         
         // IDO Database
-        if (!array_key_exists('IDOdatabase',$trapConfig['config']))
+        if (!array_key_exists('IDOdatabase', $trapConfig['config']))
         {
-            $this->logging->log("No IDOdatabase in config file: ".$this->trapModuleConfig,ERROR,'');
+            $this->logging->log("No IDOdatabase in config file: ".$this->trapModuleConfig, ERROR, '');
         }
         $dbIdoName=$trapConfig['config']['IDOdatabase'];
         
-        $this->logging->log("Found IDO database in config file: ".$dbIdoName,INFO );
-        if (!array_key_exists($dbIdoName,$dbConfig))
+        $this->logging->log("Found IDO database in config file: ".$dbIdoName, INFO);
+        if (!array_key_exists($dbIdoName, $dbConfig))
         {
-            $this->logging->log("No database '.$dbIdoName.' in config file: ".$this->icingaweb2Ressources,ERROR,'');
+            $this->logging->log("No database '.$dbIdoName.' in config file: ".$this->icingaweb2Ressources, ERROR, '');
             return;
         }
         

Braces +12 added lines, -7 removed lines

@@ -40,8 +40,7 @@ 
             }
             $this->getLogging()->log($message,$log_level);
             return false;
-        }
-        else
+        } else
         {
             $option_var=$option_array[$option_category][$option_name];
             return true;
@@ -54,9 +53,11 @@ 
     protected function getDatabaseOptions()
     {
         // Database options
-        if ($this->logSetup === false) // Only if logging was no setup in constructor
+        if ($this->logSetup === false) {
+        	// Only if logging was no setup in constructor
         {
             $this->getDBConfigIfSet('log_level',$this->getLogging()->debugLevel);
+        }
             $this->getDBConfigIfSet('log_destination',$this->getLogging()->outputMode);
             $this->getDBConfigIfSet('log_file',$this->getLogging()->outputFile);
         }
@@ -69,7 +70,9 @@ 
     protected function getDBConfigIfSet($element,&$variable)
     {
         $value=$this->getDBConfig($element);
-        if ($value != null) $variable=$value;
+        if ($value != null) {
+        	$variable=$value;
+        }
     }
     
     /**
@@ -106,8 +109,7 @@ 
         {
             $this->getLogging()->log('Unknown node status '.$nodeStatus.' : setting to MASTER',WARN);
             $this->getTrapApi()->setStatusMaster();
-        }
-        else 
+        } else 
         {
             if ($this->getTrapApi()->getStatus() != TrapApi::MASTER)
             {
@@ -175,7 +177,10 @@ 
         
         //TODO enable this again when API queries are all done :  $this->logging->log("API Use : ".print_r($this->apiUse,true),INFO );
         
-        if ($this->apiUse === true) return; // In case of API use, no IDO is necessary
+        if ($this->apiUse === true) {
+        	return;
+        }
+        // In case of API use, no IDO is necessary
         
         // IDO Database
         if (!array_key_exists('IDOdatabase',$trapConfig['config']))