patrickpr / trapdirector

library/Trapdirector/TrapsProcess/Trap.php

Spacing +177 added lines, -177 removed lines

@@ -52,13 +52,13 @@ 
     
     // Logs
     /** @var Logging Logging class. */
-    public $logging;    //< Logging class.
+    public $logging; //< Logging class.
     /** @var bool true if log was setup in constructor */
-    protected $logSetup;   //< bool true if log was setup in constructor
+    protected $logSetup; //< bool true if log was setup in constructor
     
     // Databases
     /** @var Database $trapsDB  Database class*/
-    public $trapsDB = null;
+    public $trapsDB=null;
     
     // Trap received data
     protected $receivingHost;
@@ -74,18 +74,18 @@ 
     protected $trapToDb=true;
     
     /** @var Mib mib class */
-    public $mibClass = null;
+    public $mibClass=null;
     
     /** @var Rule rule class */
-    public $ruleClass = null;
+    public $ruleClass=null;
     
     /** @var Plugins plugins manager **/
-    public $pluginClass = null;
+    public $pluginClass=null;
     
     /** @var TrapApi $trapApiClass */
-    public $trapApiClass = null;
+    public $trapApiClass=null;
     
-    function __construct($etcDir='/etc/icingaweb2',$baseLogLevel=null,$baseLogMode='syslog',$baseLogFile='')
+    function __construct($etcDir='/etc/icingaweb2', $baseLogLevel=null, $baseLogMode='syslog', $baseLogFile='')
     {
         // Paths of ini files
         $this->icingaweb2Etc=$etcDir;
@@ -93,10 +93,10 @@ 
         $this->icingaweb2Ressources=$this->icingaweb2Etc."/resources.ini";
 
         //************* Setup logging
-        $this->logging = new Logging();
+        $this->logging=new Logging();
         if ($baseLogLevel != null)
         {
-            $this->logging->setLogging($baseLogLevel, $baseLogMode,$baseLogFile);
+            $this->logging->setLogging($baseLogLevel, $baseLogMode, $baseLogFile);
             $this->logSetup=true;
         }
         else
@@ -108,17 +108,17 @@ 
         
         // Create distributed API object
         
-        $this->trapApiClass = new TrapApi($this->logging);
+        $this->trapApiClass=new TrapApi($this->logging);
         
         //*************** Get options from ini files
-        if (! is_file($this->trapModuleConfig))
+        if (!is_file($this->trapModuleConfig))
         {
             throw new Exception("Ini file ".$this->trapModuleConfig." does not exists");
         }
-        $trapConfig=parse_ini_file($this->trapModuleConfig,true);
+        $trapConfig=parse_ini_file($this->trapModuleConfig, true);
         if ($trapConfig == false)
         {
-            $this->logging->log("Error reading ini file : ".$this->trapModuleConfig,ERROR,'syslog');
+            $this->logging->log("Error reading ini file : ".$this->trapModuleConfig, ERROR, 'syslog');
             throw new Exception("Error reading ini file : ".$this->trapModuleConfig);
         }
         $this->getMainOptions($trapConfig); // Get main options from ini file
@@ -132,10 +132,10 @@ 
         if ($this->apiUse === true) $this->getAPI(); // Setup API
         
         //*************** Setup MIB
-        $this->mibClass = new Mib($this->logging,$this->trapsDB,$this->snmptranslate,$this->snmptranslate_dirs); // Create Mib class
+        $this->mibClass=new Mib($this->logging, $this->trapsDB, $this->snmptranslate, $this->snmptranslate_dirs); // Create Mib class
         
         //*************** Setup Rule
-        $this->ruleClass = new Rule($this); //< Create Rule class
+        $this->ruleClass=new Rule($this); //< Create Rule class
         
         $this->trapData=array(  // TODO : put this in a reset function (DAEMON_MODE)
             'source_ip'	=> 'unknown',
@@ -147,7 +147,7 @@ 
         
         //*************** Setup Plugins
         //Create plugin class. Plugins are not loaded here, but by calling registerAllPlugins
-        $this->pluginClass = new Plugins($this);
+        $this->pluginClass=new Plugins($this);
             
             
     }
@@ -176,15 +176,15 @@ 
      *	@param  string $destination file/syslog/display
      *	@return void
      **/
-    public function trapLog( $message, $level, $destination ='') // OBSOLETE
+    public function trapLog($message, $level, $destination='') // OBSOLETE
     {
         // TODO : replace ref with $this->logging->log
         $this->logging->log($message, $level, $destination);
     }
     
-    public function setLogging($debugLvl,$outputType,$outputOption=null)  // OBSOLETE
+    public function setLogging($debugLvl, $outputType, $outputOption=null)  // OBSOLETE
     {
-        $this->logging->setLogging($debugLvl, $outputType,$outputOption);
+        $this->logging->setLogging($debugLvl, $outputType, $outputOption);
     }
     
     /**
@@ -195,7 +195,7 @@ 
     {
         if ($this->icinga2api == null)
         {
-            $this->icinga2api = new Icinga2API($this->apiHostname,$this->apiPort);
+            $this->icinga2api=new Icinga2API($this->apiHostname, $this->apiPort);
         }
         return $this->icinga2api;
     }
@@ -214,7 +214,7 @@ 
         if ($input_stream === false)
         {
             $this->writeTrapErrorToDB("Error reading trap (code 1/Stdin)");
-            $this->logging->log("Error reading stdin !",ERROR,'');
+            $this->logging->log("Error reading stdin !", ERROR, '');
             return null; // note : exception thrown by logging
         }
         
@@ -223,21 +223,21 @@ 
         if ($this->receivingHost === false)
         {
             $this->writeTrapErrorToDB("Error reading trap (code 1/Line Host)");
-            $this->logging->log("Error reading Host !",ERROR,'');
+            $this->logging->log("Error reading Host !", ERROR, '');
         }
         // line 2 IP:port=>IP:port
         $IP=chop(fgets($input_stream));
         if ($IP === false)
         {
             $this->writeTrapErrorToDB("Error reading trap (code 1/Line IP)");
-            $this->logging->log("Error reading IP !",ERROR,'');
+            $this->logging->log("Error reading IP !", ERROR, '');
         }
         $matches=array();
-        $ret_code=preg_match('/.DP: \[(.*)\]:(.*)->\[(.*)\]:(.*)/',$IP,$matches);
-        if ($ret_code===0 || $ret_code===false)
+        $ret_code=preg_match('/.DP: \[(.*)\]:(.*)->\[(.*)\]:(.*)/', $IP, $matches);
+        if ($ret_code === 0 || $ret_code === false)
         {
             $this->writeTrapErrorToDB("Error parsing trap (code 2/IP)");
-            $this->logging->log('Error parsing IP : '.$IP,ERROR,'');
+            $this->logging->log('Error parsing IP : '.$IP, ERROR, '');
         }
         else
         {
@@ -247,41 +247,41 @@ 
             $this->trapData['destination_port']=$matches[4];
         }
         
-        while (($vars=fgets($input_stream)) !==false)
+        while (($vars=fgets($input_stream)) !== false)
         {
             $vars=chop($vars);
-            $ret_code=preg_match('/^([^ ]+) (.*)$/',$vars,$matches);
-            if ($ret_code===0 || $ret_code===false)
+            $ret_code=preg_match('/^([^ ]+) (.*)$/', $vars, $matches);
+            if ($ret_code === 0 || $ret_code === false)
             {
-                $this->logging->log('No match on trap data : '.$vars,WARN,'');
+                $this->logging->log('No match on trap data : '.$vars, WARN, '');
                 continue;
             }
-            if (($matches[1]=='.1.3.6.1.6.3.1.1.4.1.0') || ($matches[1]=='.1.3.6.1.6.3.1.1.4.1'))
+            if (($matches[1] == '.1.3.6.1.6.3.1.1.4.1.0') || ($matches[1] == '.1.3.6.1.6.3.1.1.4.1'))
             {
                 $this->trapData['trap_oid']=$matches[2];
                 continue;
             }
-            if ( $this->useSnmpTrapAddess === TRUE &&  preg_match('/'.$this->snmpTrapAddressOID.'/', $matches[1]) == 1)
+            if ($this->useSnmpTrapAddess === TRUE && preg_match('/'.$this->snmpTrapAddressOID.'/', $matches[1]) == 1)
             {
-                $this->logging->log('Found relayed trap from ' . $matches[2] . ' relayed by ' .$this->trapData['source_ip'],DEBUG);
-                if (preg_match('/^[0-9\.]+$/',$matches[2]) == 0 && preg_match('/^[0-9a-fA-F:]+$/',$matches[2]) == 0)
+                $this->logging->log('Found relayed trap from '.$matches[2].' relayed by '.$this->trapData['source_ip'], DEBUG);
+                if (preg_match('/^[0-9\.]+$/', $matches[2]) == 0 && preg_match('/^[0-9a-fA-F:]+$/', $matches[2]) == 0)
                 {
-                    $this->logging->log('Value of SnmpTrapAddess ('.$this->snmpTrapAddressOID.') is not IP : ' .$matches[2],WARN,'');
+                    $this->logging->log('Value of SnmpTrapAddess ('.$this->snmpTrapAddressOID.') is not IP : '.$matches[2], WARN, '');
                     continue;
                 }
-                $this->trapData['source_ip'] = $matches[2];
+                $this->trapData['source_ip']=$matches[2];
                 continue;
             }
-            $object= new stdClass;
-            $object->oid =$matches[1];
-            $object->value = $matches[2];
-            array_push($this->trapDataExt,$object);
+            $object=new stdClass;
+            $object->oid=$matches[1];
+            $object->value=$matches[2];
+            array_push($this->trapDataExt, $object);
         }
         
-        if ($this->trapData['trap_oid']=='unknown')
+        if ($this->trapData['trap_oid'] == 'unknown')
         {
-            $this->writeTrapErrorToDB("No trap oid found : check snmptrapd configuration (code 3/OID)",$this->trapData['source_ip']);
-            $this->logging->log('no trap oid found',ERROR,'');
+            $this->writeTrapErrorToDB("No trap oid found : check snmptrapd configuration (code 3/OID)", $this->trapData['source_ip']);
+            $this->logging->log('no trap oid found', ERROR, '');
         }
         
         // Translate oids.
@@ -303,7 +303,7 @@ 
         }
         
         
-        $this->trapData['status']= 'waiting';
+        $this->trapData['status']='waiting';
         
         return $this->trapData;
     }
@@ -319,40 +319,40 @@ 
         $db_conn=$this->trapsDB->db_connect_trap();
         
         $sql='SELECT mib,name from '.$this->dbPrefix.'mib_cache WHERE oid=\''.$oid.'\';';
-        $this->logging->log('SQL query : '.$sql,DEBUG );
+        $this->logging->log('SQL query : '.$sql, DEBUG);
         if (($ret_code=$db_conn->query($sql)) === false) {
-            $this->logging->log('No result in query : ' . $sql,ERROR,'');
+            $this->logging->log('No result in query : '.$sql, ERROR, '');
         }
         $name=$ret_code->fetch();
         if ($name['name'] != null)
         {
-            return array('trap_name_mib'=>$name['mib'],'trap_name'=>$name['name']);
+            return array('trap_name_mib'=>$name['mib'], 'trap_name'=>$name['name']);
         }
         
         // Also check if it is an instance of OID
-        $oid_instance=preg_replace('/\.[0-9]+$/','',$oid);
+        $oid_instance=preg_replace('/\.[0-9]+$/', '', $oid);
         
         $sql='SELECT mib,name from '.$this->dbPrefix.'mib_cache WHERE oid=\''.$oid_instance.'\';';
-        $this->logging->log('SQL query : '.$sql,DEBUG );
+        $this->logging->log('SQL query : '.$sql, DEBUG);
         if (($ret_code=$db_conn->query($sql)) === false) {
-            $this->logging->log('No result in query : ' . $sql,ERROR,'');
+            $this->logging->log('No result in query : '.$sql, ERROR, '');
         }
         $name=$ret_code->fetch();
         if ($name['name'] != null)
         {
-            return array('trap_name_mib'=>$name['mib'],'trap_name'=>$name['name']);
+            return array('trap_name_mib'=>$name['mib'], 'trap_name'=>$name['name']);
         }
         
         // Try to get oid name from snmptranslate
-        $translate=exec($this->snmptranslate . ' -m ALL -M +'.$this->snmptranslate_dirs.
+        $translate=exec($this->snmptranslate.' -m ALL -M +'.$this->snmptranslate_dirs.
             ' '.$oid);
         $matches=array();
-        $ret_code=preg_match('/(.*)::(.*)/',$translate,$matches);
-        if ($ret_code===0 || $ret_code === false) {
+        $ret_code=preg_match('/(.*)::(.*)/', $translate, $matches);
+        if ($ret_code === 0 || $ret_code === false) {
             return NULL;
         } else {
-            $this->logging->log('Found name with snmptrapd and not in DB for oid='.$oid,INFO);
-            return array('trap_name_mib'=>$matches[1],'trap_name'=>$matches[2]);
+            $this->logging->log('Found name with snmptrapd and not in DB for oid='.$oid, INFO);
+            return array('trap_name_mib'=>$matches[1], 'trap_name'=>$matches[2]);
         }
     }
     
@@ -363,90 +363,90 @@ 
      **/
     public function eraseOldTraps($days=0)
     {
-        if ($days==0)
+        if ($days == 0)
         {
             if (($days=$this->getDBConfig('db_remove_days')) == null)
             {
-                $this->logging->log('No days specified & no db value : no tap erase' ,WARN,'');
+                $this->logging->log('No days specified & no db value : no tap erase', WARN, '');
                 return;
             }
         }
         $db_conn=$this->trapsDB->db_connect_trap();
-        $daysago = strtotime("-".$days." day");
-        $sql= 'delete from '.$this->dbPrefix.'received where date_received < \''.date("Y-m-d H:i:s",$daysago).'\';';
+        $daysago=strtotime("-".$days." day");
+        $sql='delete from '.$this->dbPrefix.'received where date_received < \''.date("Y-m-d H:i:s", $daysago).'\';';
         if ($db_conn->query($sql) === false) {
-            $this->logging->log('Error erasing traps : '.$sql,ERROR,'');
+            $this->logging->log('Error erasing traps : '.$sql, ERROR, '');
         }
-        $this->logging->log('Erased traps older than '.$days.' day(s) : '.$sql,INFO);
+        $this->logging->log('Erased traps older than '.$days.' day(s) : '.$sql, INFO);
     }
     
     /** Write error to received trap database
      */
-    public function writeTrapErrorToDB($message,$sourceIP=null,$trapoid=null)
+    public function writeTrapErrorToDB($message, $sourceIP=null, $trapoid=null)
     {
         
         $db_conn=$this->trapsDB->db_connect_trap();
         
         // add date time
-        $insert_col ='date_received,status';
-        $insert_val = "'" . date("Y-m-d H:i:s")."','error'";
+        $insert_col='date_received,status';
+        $insert_val="'".date("Y-m-d H:i:s")."','error'";
         
-        if ($sourceIP !=null)
+        if ($sourceIP != null)
         {
-            $insert_col .=',source_ip';
-            $insert_val .=",'". $sourceIP ."'";
+            $insert_col.=',source_ip';
+            $insert_val.=",'".$sourceIP."'";
         }
-        if ($trapoid !=null)
+        if ($trapoid != null)
         {
-            $insert_col .=',trap_oid';
-            $insert_val .=",'". $trapoid ."'";
+            $insert_col.=',trap_oid';
+            $insert_val.=",'".$trapoid."'";
         }
-        $insert_col .=',status_detail';
-        $insert_val .=",'". $message ."'";
+        $insert_col.=',status_detail';
+        $insert_val.=",'".$message."'";
         
-        $sql= 'INSERT INTO '.$this->dbPrefix.'received (' . $insert_col . ') VALUES ('.$insert_val.')';
+        $sql='INSERT INTO '.$this->dbPrefix.'received ('.$insert_col.') VALUES ('.$insert_val.')';
         
         switch ($this->trapsDB->trapDBType)
         {
             case 'pgsql':
-                $sql .= ' RETURNING id;';
-                $this->logging->log('sql : '.$sql,INFO);
+                $sql.=' RETURNING id;';
+                $this->logging->log('sql : '.$sql, INFO);
                 if (($ret_code=$db_conn->query($sql)) === false) {
-                    $this->logging->log('Error SQL insert : '.$sql,1,'');
+                    $this->logging->log('Error SQL insert : '.$sql, 1, '');
                 }
-                $this->logging->log('SQL insertion OK',INFO );
+                $this->logging->log('SQL insertion OK', INFO);
                 // Get last id to insert oid/values in secondary table
                 if (($inserted_id_ret=$ret_code->fetch(PDO::FETCH_ASSOC)) === false) {
                     
-                    $this->logging->log('Erreur recuperation id',1,'');
+                    $this->logging->log('Erreur recuperation id', 1, '');
                 }
-                if (! isset($inserted_id_ret['id'])) {
-                    $this->logging->log('Error getting id',1,'');
+                if (!isset($inserted_id_ret['id'])) {
+                    $this->logging->log('Error getting id', 1, '');
                 }
                 $this->trapId=$inserted_id_ret['id'];
                 break;
             case 'mysql':
-                $sql .= ';';
-                $this->logging->log('sql : '.$sql,INFO );
+                $sql.=';';
+                $this->logging->log('sql : '.$sql, INFO);
                 if ($db_conn->query($sql) === false) {
-                    $this->logging->log('Error SQL insert : '.$sql,1,'');
+                    $this->logging->log('Error SQL insert : '.$sql, 1, '');
                 }
-                $this->logging->log('SQL insertion OK',INFO );
+                $this->logging->log('SQL insertion OK', INFO);
                 // Get last id to insert oid/values in secondary table
                 $sql='SELECT LAST_INSERT_ID();';
                 if (($ret_code=$db_conn->query($sql)) === false) {
-                    $this->logging->log('Erreur recuperation id',1,'');
+                    $this->logging->log('Erreur recuperation id', 1, '');
                 }
                 
                 $inserted_id=$ret_code->fetch(PDO::FETCH_ASSOC)['LAST_INSERT_ID()'];
-                if ($inserted_id==false) throw new Exception("Weird SQL error : last_insert_id returned false : open issue");
+                if ($inserted_id == false) throw new Exception("Weird SQL error : last_insert_id returned false : open issue");
                 $this->trapId=$inserted_id;
                 break;
             default:
-                $this->logging->log('Error SQL type unknown  : '.$this->trapsDB->trapDBType,1,'');
+                $this->logging->log('Error SQL type unknown  : '.$this->trapsDB->trapDBType, 1, '');
         }
         
-        $this->logging->log('id found: '. $this->trapId,INFO );
+        $this->logging->log('id found: '.$this->trapId, INFO);
     }
     
     /** Write trap data to trap database
@@ -463,86 +463,86 @@ 
         $insert_col='';
         $insert_val='';
         // add date time
-        $this->trapData['date_received'] = date("Y-m-d H:i:s");
+        $this->trapData['date_received']=date("Y-m-d H:i:s");
         
         $firstcol=1;
         foreach ($this->trapData as $col => $val)
         {
-            if ($firstcol==0)
+            if ($firstcol == 0)
             {
-                $insert_col .=',';
-                $insert_val .=',';
+                $insert_col.=',';
+                $insert_val.=',';
             }
-            $insert_col .= $col ;
-            $insert_val .= ($val==null)? 'NULL' : $db_conn->quote($val);
+            $insert_col.=$col;
+            $insert_val.=($val == null) ? 'NULL' : $db_conn->quote($val);
             $firstcol=0;
         }
         
-        $sql= 'INSERT INTO '.$this->dbPrefix.'received (' . $insert_col . ') VALUES ('.$insert_val.')';
+        $sql='INSERT INTO '.$this->dbPrefix.'received ('.$insert_col.') VALUES ('.$insert_val.')';
         switch ($this->trapsDB->trapDBType)
         {
             case 'pgsql':
-                $sql .= ' RETURNING id;';
-                $this->logging->log('sql : '.$sql,INFO );
+                $sql.=' RETURNING id;';
+                $this->logging->log('sql : '.$sql, INFO);
                 if (($ret_code=$db_conn->query($sql)) === false) {
-                    $this->logging->log('Error SQL insert : '.$sql,ERROR,'');
+                    $this->logging->log('Error SQL insert : '.$sql, ERROR, '');
                 }
-                $this->logging->log('SQL insertion OK',INFO );
+                $this->logging->log('SQL insertion OK', INFO);
                 // Get last id to insert oid/values in secondary table
                 if (($inserted_id_ret=$ret_code->fetch(PDO::FETCH_ASSOC)) === false) {
                     
-                    $this->logging->log('Erreur recuperation id',ERROR,'');
+                    $this->logging->log('Erreur recuperation id', ERROR, '');
                 }
-                if (! isset($inserted_id_ret['id'])) {
-                    $this->logging->log('Error getting id',ERROR,'');
+                if (!isset($inserted_id_ret['id'])) {
+                    $this->logging->log('Error getting id', ERROR, '');
                 }
                 $this->trapId=$inserted_id_ret['id'];
                 break;
             case 'mysql':
-                $sql .= ';';
-                $this->logging->log('sql : '.$sql,INFO );
+                $sql.=';';
+                $this->logging->log('sql : '.$sql, INFO);
                 if ($db_conn->query($sql) === false) {
-                    $this->logging->log('Error SQL insert : '.$sql,ERROR,'');
+                    $this->logging->log('Error SQL insert : '.$sql, ERROR, '');
                 }
-                $this->logging->log('SQL insertion OK',INFO );
+                $this->logging->log('SQL insertion OK', INFO);
                 // Get last id to insert oid/values in secondary table
                 $sql='SELECT LAST_INSERT_ID();';
                 if (($ret_code=$db_conn->query($sql)) === false) {
-                    $this->logging->log('Erreur recuperation id',ERROR,'');
+                    $this->logging->log('Erreur recuperation id', ERROR, '');
                 }
                 
                 $inserted_id=$ret_code->fetch(PDO::FETCH_ASSOC)['LAST_INSERT_ID()'];
-                if ($inserted_id==false) throw new Exception("Weird SQL error : last_insert_id returned false : open issue");
+                if ($inserted_id == false) throw new Exception("Weird SQL error : last_insert_id returned false : open issue");
                 $this->trapId=$inserted_id;
                 break;
             default:
-                $this->logging->log('Error SQL type unknown : '.$this->trapsDB->trapDBType,ERROR,'');
+                $this->logging->log('Error SQL type unknown : '.$this->trapsDB->trapDBType, ERROR, '');
         }
-        $this->logging->log('id found: '.$this->trapId,INFO );
+        $this->logging->log('id found: '.$this->trapId, INFO);
         
         // Fill trap extended data table
         foreach ($this->trapDataExt as $value) {
             // TODO : detect if trap value is encoded and decode it to UTF-8 for database
             $firstcol=1;
-            $value->trap_id = $this->trapId;
+            $value->trap_id=$this->trapId;
             $insert_col='';
             $insert_val='';
             foreach ($value as $col => $val)
             {
-                if ($firstcol==0)
+                if ($firstcol == 0)
                 {
-                    $insert_col .=',';
-                    $insert_val .=',';
+                    $insert_col.=',';
+                    $insert_val.=',';
                 }
-                $insert_col .= $col;
-                $insert_val .= ($val==null)? 'NULL' : $db_conn->quote($val);
+                $insert_col.=$col;
+                $insert_val.=($val == null) ? 'NULL' : $db_conn->quote($val);
                 $firstcol=0;
             }
             
-            $sql= 'INSERT INTO '.$this->dbPrefix.'received_data (' . $insert_col . ') VALUES ('.$insert_val.');';
+            $sql='INSERT INTO '.$this->dbPrefix.'received_data ('.$insert_col.') VALUES ('.$insert_val.');';
             
             if ($db_conn->query($sql) === false) {
-                $this->logging->log('Erreur insertion data : ' . $sql,WARN,'');
+                $this->logging->log('Erreur insertion data : '.$sql, WARN, '');
             }
         }
     }
@@ -552,14 +552,14 @@ 
      *	@param $oid string oid in numeric
      *	@return mixed|boolean : PDO object or false
      */
-    protected function getRules($ip,$oid)
+    protected function getRules($ip, $oid)
     {
         $db_conn=$this->trapsDB->db_connect_trap();
         // fetch rules based on IP in rule and OID
         $sql='SELECT * from '.$this->dbPrefix.'rules WHERE trap_oid=\''.$oid.'\' ';
-        $this->logging->log('SQL query : '.$sql,DEBUG );
+        $this->logging->log('SQL query : '.$sql, DEBUG);
         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 false;
         }
         $rules_all=$ret_code->fetchAll();
@@ -568,7 +568,7 @@ 
         $rule_ret_key=0;
         foreach ($rules_all as $key => $rule)
         {
-            if ($rule['ip4']==$ip || $rule['ip6']==$ip)
+            if ($rule['ip4'] == $ip || $rule['ip6'] == $ip)
             {
                 $rules_ret[$rule_ret_key]=$rules_all[$key];
                 //TODO : get host name by API (and check if correct in rule).
@@ -576,7 +576,7 @@ 
                 continue;
             }
             // TODO : get hosts IP by API
-            if (isset($rule['host_group_name']) && $rule['host_group_name']!=null)
+            if (isset($rule['host_group_name']) && $rule['host_group_name'] != null)
             { // get ips of group members by oid
                 $db_conn2=$this->trapsDB->db_connect_ido();
                 $sql="SELECT m.host_object_id, a.address as ip4, a.address6 as ip6, b.name1 as host_name
@@ -587,15 +587,15 @@ 
 						LEFT JOIN icinga_objects as b ON b.object_id = a.host_object_id
 						WHERE o.name1='".$rule['host_group_name']."';";
                 if (($ret_code2=$db_conn2->query($sql)) === false) {
-                    $this->logging->log('No result in query : ' . $sql,WARN,'');
+                    $this->logging->log('No result in query : '.$sql, WARN, '');
                     continue;
                 }
                 $grouphosts=$ret_code2->fetchAll();
                 //echo "rule grp :\n";print_r($grouphosts);echo "\n";
-                foreach ( $grouphosts as $host)
+                foreach ($grouphosts as $host)
                 {
                     //echo $host['ip4']."\n";
-                    if ($host['ip4']==$ip || $host['ip6']==$ip)
+                    if ($host['ip4'] == $ip || $host['ip6'] == $ip)
                     {
                         //echo "Rule added \n";
                         $rules_ret[$rule_ret_key]=$rules_all[$key];
@@ -618,7 +618,7 @@ 
         $db_conn=$this->trapsDB->db_connect_trap();
         $sql="UPDATE ".$this->dbPrefix."rules SET num_match = '".$set."' WHERE (id = '".$id."');";
         if ($db_conn->query($sql) === false) {
-            $this->logging->log('Error in update query : ' . $sql,WARN,'');
+            $this->logging->log('Error in update query : '.$sql, WARN, '');
         }
     }
     
@@ -630,23 +630,23 @@ 
      * @param string $display
      * @returnn bool true is service check was sent without error
      */
-    public function serviceCheckResult($host,$service,$state,$display)
+    public function serviceCheckResult($host, $service, $state, $display)
     {
         if ($this->apiUse === false)
         {
-            $send = '[' . date('U') .'] PROCESS_SERVICE_CHECK_RESULT;' .
-                $host.';' .$service .';' . $state . ';'.$display;
-                $this->logging->log( $send." : to : " .$this->icinga2cmd,INFO );
+            $send='['.date('U').'] PROCESS_SERVICE_CHECK_RESULT;'.
+                $host.';'.$service.';'.$state.';'.$display;
+                $this->logging->log($send." : to : ".$this->icinga2cmd, INFO);
                 
                 // TODO : file_put_contents & fopen (,'w' or 'a') does not work. See why. Or not as using API will be by default....
-                exec('echo "'.$send.'" > ' .$this->icinga2cmd);
+                exec('echo "'.$send.'" > '.$this->icinga2cmd);
                 return true;
         }
         else
         {
             // Get perfdata if found
             $matches=array();
-            if (preg_match('/(.*)\|(.*)/',$display,$matches) == 1)
+            if (preg_match('/(.*)\|(.*)/', $display, $matches) == 1)
             {
                 $display=$matches[1];
                 $perfdata=$matches[2];
@@ -656,17 +656,17 @@ 
                 $perfdata='';
             }
             
-            $api = $this->getAPI();
+            $api=$this->getAPI();
             $api->setCredentials($this->apiUsername, $this->apiPassword);
-            list($retcode,$retmessage)=$api->serviceCheckResult($host,$service,$state,$display,$perfdata);
+            list($retcode, $retmessage)=$api->serviceCheckResult($host, $service, $state, $display, $perfdata);
             if ($retcode == false)
             {
-                $this->logging->log( "Error sending result : " .$retmessage,WARN,'');
+                $this->logging->log("Error sending result : ".$retmessage, WARN, '');
                 return false;
             }
             else
             {
-                $this->logging->log( "Sent result : " .$retmessage,INFO );
+                $this->logging->log("Sent result : ".$retmessage, INFO);
                 return true;
             }
         }
@@ -674,7 +674,7 @@ 
     
     public function getHostByIP($ip)
     {
-        $api = $this->getAPI();
+        $api=$this->getAPI();
         $api->setCredentials($this->apiUsername, $this->apiPassword);
         return $api->getHostByIP($ip);
     }
@@ -687,35 +687,35 @@ 
     protected function applyDisplay($display)
     {
         $matches=array();
-        while (preg_match('/_OID\(([0-9\.\*]+)\)/',$display,$matches) == 1)
+        while (preg_match('/_OID\(([0-9\.\*]+)\)/', $display, $matches) == 1)
         {
             $oid=$matches[1];
             $found=0;
             // Test and transform regexp
-            $oidR = $this->ruleClass->regexp_eval($oid);
+            $oidR=$this->ruleClass->regexp_eval($oid);
             
-            foreach($this->trapDataExt as $val)
+            foreach ($this->trapDataExt as $val)
             {
-                if (preg_match("/^$oidR$/",$val->oid) == 1)
+                if (preg_match("/^$oidR$/", $val->oid) == 1)
                 {
-                    $val->value=preg_replace('/"/','',$val->value);
+                    $val->value=preg_replace('/"/', '', $val->value);
                     $rep=0;
-                    $display=preg_replace('/_OID\('.$oid.'\)/',$val->value,$display,-1,$rep);
-                    if ($rep==0)
+                    $display=preg_replace('/_OID\('.$oid.'\)/', $val->value, $display, -1, $rep);
+                    if ($rep == 0)
                     {
-                        $this->logging->log("Error in display",WARN,'');
+                        $this->logging->log("Error in display", WARN, '');
                         return $display;
                     }
                     $found=1;
                     break;
                 }
             }
-            if ($found==0)
+            if ($found == 0)
             {
-                $display=preg_replace('/_OID\('.$oid.'\)/','<not in trap>',$display,-1,$rep);
-                if ($rep==0)
+                $display=preg_replace('/_OID\('.$oid.'\)/', '<not in trap>', $display, -1, $rep);
+                if ($rep == 0)
                 {
-                    $this->logging->log("Error in display",WARN,'');
+                    $this->logging->log("Error in display", WARN, '');
                     return $display;
                 }
             }
@@ -727,11 +727,11 @@ 
      */
     public function applyRules()
     {
-        $rules = $this->getRules($this->trapData['source_ip'],$this->trapData['trap_oid']);
+        $rules=$this->getRules($this->trapData['source_ip'], $this->trapData['trap_oid']);
         
-        if ($rules===false || count($rules)==0)
+        if ($rules === false || count($rules) == 0)
         {
-            $this->logging->log('No rules found for this trap',INFO );
+            $this->logging->log('No rules found for this trap', INFO);
             $this->trapData['status']='unknown';
             $this->trapToDb=true;
             return;
@@ -746,59 +746,59 @@ 
             $service_name=$rule['service_name'];
             
             $display=$this->applyDisplay($rule['display']);
-            $this->trapAction = ($this->trapAction==null)? '' : $this->trapAction . ', ';
+            $this->trapAction=($this->trapAction == null) ? '' : $this->trapAction.', ';
             try
             {
-                $this->logging->log('Rule to eval : '.$rule['rule'],INFO );
-                $evalr=$this->ruleClass->eval_rule($rule['rule'], $this->trapDataExt) ;
+                $this->logging->log('Rule to eval : '.$rule['rule'], INFO);
+                $evalr=$this->ruleClass->eval_rule($rule['rule'], $this->trapDataExt);
                 //->eval_rule($rule['rule']);
                 
                 if ($evalr == true)
                 {
                     //$this->logging->log('rules OOK: '.print_r($rule),INFO );
                     $action=$rule['action_match'];
-                    $this->logging->log('action OK : '.$action,INFO );
+                    $this->logging->log('action OK : '.$action, INFO);
                     if ($action >= 0)
                     {
-                        if ($this->serviceCheckResult($host_name,$service_name,$action,$display) == false)
+                        if ($this->serviceCheckResult($host_name, $service_name, $action, $display) == false)
                         {
                             $this->trapAction.='Error sending status : check cmd/API';
                         }
                         else
                         {
-                            $this->add_rule_match($rule['id'],$rule['num_match']+1);
+                            $this->add_rule_match($rule['id'], $rule['num_match'] + 1);
                             $this->trapAction.='Status '.$action.' to '.$host_name.'/'.$service_name;
                         }
                     }
                     else
                     {
-                        $this->add_rule_match($rule['id'],$rule['num_match']+1);
+                        $this->add_rule_match($rule['id'], $rule['num_match'] + 1);
                     }
-                    $this->trapToDb=($action==-2)?false:true;
+                    $this->trapToDb=($action == -2) ?false:true;
                 }
                 else
                 {
                     //$this->logging->log('rules KOO : '.print_r($rule),INFO );
                     
                     $action=$rule['action_nomatch'];
-                    $this->logging->log('action NOK : '.$action,INFO );
+                    $this->logging->log('action NOK : '.$action, INFO);
                     if ($action >= 0)
                     {
-                        if ($this->serviceCheckResult($host_name,$service_name,$action,$display)==false)
+                        if ($this->serviceCheckResult($host_name, $service_name, $action, $display) == false)
                         {
                             $this->trapAction.='Error sending status : check cmd/API';
                         }
                         else
                         {
-                            $this->add_rule_match($rule['id'],$rule['num_match']+1);
+                            $this->add_rule_match($rule['id'], $rule['num_match'] + 1);
                             $this->trapAction.='Status '.$action.' to '.$host_name.'/'.$service_name;
                         }
                     }
                     else
                     {
-                        $this->add_rule_match($rule['id'],$rule['num_match']+1);
+                        $this->add_rule_match($rule['id'], $rule['num_match'] + 1);
                     }
-                    $this->trapToDb=($action==-2)?false:true;
+                    $this->trapToDb=($action == -2) ?false:true;
                 }
                 // Put name in source_name
                 if (!isset($this->trapData['source_name']))
@@ -807,7 +807,7 @@ 
                 }
                 else
                 {
-                    if (!preg_match('/'.$rule['host_name'].'/',$this->trapData['source_name']))
+                    if (!preg_match('/'.$rule['host_name'].'/', $this->trapData['source_name']))
                     { // only add if not present
                         $this->trapData['source_name'].=','.$rule['host_name'];
                     }
@@ -815,13 +815,13 @@ 
             }
             catch (Exception $e)
             {
-                $this->logging->log('Error in rule eval : '.$e->getMessage(),WARN,'');
+                $this->logging->log('Error in rule eval : '.$e->getMessage(), WARN, '');
                 $this->trapAction.=' ERR : '.$e->getMessage();
                 $this->trapData['status']='error';
             }
             
         }
-        if ($this->trapData['status']=='error')
+        if ($this->trapData['status'] == 'error')
         {
             $this->trapToDb=true; // Always put errors in DB for the use can see
         }
@@ -837,13 +837,13 @@ 
     public function add_rule_final($time)
     {
         $db_conn=$this->trapsDB->db_connect_trap();
-        if ($this->trapAction==null)
+        if ($this->trapAction == null)
         {
             $this->trapAction='No action';
         }
         $sql="UPDATE ".$this->dbPrefix."received SET process_time = '".$time."' , status_detail='".$this->trapAction."'  WHERE (id = '".$this->trapId."');";
         if ($db_conn->query($sql) === false) {
-            $this->logging->log('Error in update query : ' . $sql,WARN,'');
+            $this->logging->log('Error in update query : '.$sql, WARN, '');
         }
     }
     
@@ -866,7 +866,7 @@ 
     WHERE s.current_state != 0;";
         $db_conn=$this->trapsDB->db_connect_ido();
         if (($services_db=$db_conn->query($sql_query)) === false) { // set err to 1 to throw exception.
-            $this->logging->log('No result in query : ' . $sql_query,ERROR,'');
+            $this->logging->log('No result in query : '.$sql_query, ERROR, '');
             return 0;
         }
         $services=$services_db->fetchAll();
@@ -875,7 +875,7 @@ 
         $sql_query="SELECT host_name, service_name, revert_ok FROM ".$this->dbPrefix."rules where revert_ok != 0;";
         $db_conn2=$this->trapsDB->db_connect_trap();
         if (($rules_db=$db_conn2->query($sql_query)) === false) {
-            $this->logging->log('No result in query : ' . $sql_query,ERROR,'');
+            $this->logging->log('No result in query : '.$sql_query, ERROR, '');
             return 0;
         }
         $rules=$rules_db->fetchAll();
@@ -891,13 +891,13 @@ 
                     $service['host_name'] == $rule['host_name'] &&
                     ($service['last_check'] + $rule['revert_ok']) < $now)
                 {
-                    $this->serviceCheckResult($service['host_name'],$service['service_name'],0,'Reset service to OK after '.$rule['revert_ok'].' seconds');
+                    $this->serviceCheckResult($service['host_name'], $service['service_name'], 0, 'Reset service to OK after '.$rule['revert_ok'].' seconds');
                     $numreset++;
                 }
             }
         }
         echo "\n";
-        echo $numreset . " service(s) reset to OK\n";
+        echo $numreset." service(s) reset to OK\n";
         return 0;
         
     }

library/Trapdirector/TrapsProcess/TrapConfig.php

Spacing +40 added lines, -40 removed lines

@@ -36,15 +36,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
@@ -62,24 +62,24 @@ 
         // 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);
         }
         
-        $tmpVal = -1; // Get boolean coded in database as 1/0
+        $tmpVal=-1; // Get boolean coded in database as 1/0
         $this->getDBConfigIfSet('use_SnmpTrapAddess', $tmpVal);
-        if ($tmpVal != -1) $this->useSnmpTrapAddess = ($tmpVal == 1) ? TRUE : FALSE;
+        if ($tmpVal != -1) $this->useSnmpTrapAddess=($tmpVal == 1) ? TRUE : FALSE;
         
         $this->getDBConfigIfSet('SnmpTrapAddess_oid', $this->snmpTrapAddressOID); // Get oid then replace '.' with '\.' to use in regexp whrn reading traps
-        $this->snmpTrapAddressOID = preg_replace('/\./', '\\.', $this->snmpTrapAddressOID);
+        $this->snmpTrapAddressOID=preg_replace('/\./', '\\.', $this->snmpTrapAddressOID);
     }
         
     /** Set $variable to value if $element found in database config table
      * @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;
@@ -95,7 +95,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();
@@ -114,10 +114,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 
@@ -125,36 +125,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);
         }
     }
     
@@ -165,43 +165,43 @@ 
     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);
         
-        $this->logging->log("API Use : ".print_r($this->apiUse,true),DEBUG );
+        $this->logging->log("API Use : ".print_r($this->apiUse, true), DEBUG);
         
         //TODO enable this again when API queries are all done :
         //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;
         }