HandlerController::indexAction() - Code Metrics - Inspection of "Handler add function split" - patrickpr/trapdirector - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( f4c14e...6af608 )

by Patrick
created 2019-11-15 17:22 UTC
HandlerController::indexAction() A

↳ Parent: HandlerController
Complexity

Conditions	1
Paths	1
Size

Total Lines	13
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	7
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	13
rs	10
<?php

namespace Icinga\Module\TrapDirector\Controllers;

use Icinga\Web\Url;

use Exception;

use Icinga\Module\Trapdirector\TrapsController;


//use Icinga\Web\Form as Form;
/** Rules management

*/
class HandlerController extends TrapsController
{

	/** index : list existing rules 
	*/
	public function indexAction()
	{	
		$this->checkReadPermission();
		$this->prepareTabs()->activate('status');

		$db = $this->getDb();
		$this->getHandlerListTable()->setConnection($db);
		$this->getHandlerListTable()->setMibloader($this->getMIB());
		// Apply pagination limits 
		$this->view->table=$this->applyPaginationLimits($this->getHandlerListTable(),$this->getModuleConfig()->itemListDisplay());		
		
		// Set Filter
		$this->view->filterEditor = $this->getHandlerListTable()->getFilterEditor($this->getRequest());		
	
		//$this->displayExitError('Handler/indexAction','Not implemented');
	}

	/** test_rule : test a rule
	 */
	public function testruleAction()
	{
	    $this->checkReadPermission();
	    $this->getTabs()->add('get',array(
	        'active'	=> true,
	        'label'		=> $this->translate('Test Rule'),
	        'url'		=> Url::fromRequest()
	    ));
	    
	    //$db = $this->getDb();

	    if ($this->params->get('rule') !== null) 
	    {
	        $this->view->rule= $this->params->get('rule');
	    }
	    else
	    {
	        $this->view->rule='';
	    }
	}
	
	/**
	 * Setup default veiw values for add action
	 */
	private function add_setup_vars()
	{
	    // variables to send to view
	    $this->view->hostlist=array(); // host list to input datalist
	    $this->view->hostname=''; // Host name in input text
	    $this->view->serviceGet=false; // Set to true to get list of service if only one host set
	    $this->view->serviceSet=null; // Select service in services select (must have serviceGet=true).
	    $this->view->mainoid=''; // Trap OID
	    $this->view->mib=''; // Trap mib
	    $this->view->name=''; // Trap name
	    $this->view->trapListForMIB=array(); // Trap list if mib exists for trap
	    $this->view->objectList=array(); // objects sent with trap
	    $this->view->display=''; // Initial display
	    $this->view->rule=''; // rule display
	    $this->view->revertOK=''; // revert OK in seconds
	    $this->view->hostid=-1; // normally set by javascript serviceGet()
	    $this->view->ruleid=-1; // Rule id in DB for update & delete
	    $this->view->setToUpdate=false; // set form as update form
	    $this->view->setRuleMatch=-1; // set action on rule match (default nothing)
	    $this->view->setRuleNoMatch=-1; // set action on rule no match (default nothing)
	    
	    $this->view->selectGroup=false; // Select by group if true
	    $this->view->hostgroupid=-1; // host group id
	    $this->view->serviceGroupGet=false; // Get list of service for group (set serviceSet to select one)
	    
	    $this->view->modifier=null;
	    $this->view->modified=null;
	}
	
	/**
	 * Setup new handler display from existing trap
	 * @param integer $trapid : trap id in DB
	 */
	private function add_from_existing($trapid)
	{
	    /********** Setup from existing trap ***************/
	    // Get the full trap info
	    $trapDetail=$this->getTrapDetail($trapid);
	    
	    $hostfilter=$trapDetail->source_ip;
	    
	    // Get host
	    try
	    {
	        $hosts=$this->getHostByIP($hostfilter);
	    }
	    catch (Exception $e)
	    {
	        $this->displayExitError('Add handler : get host by IP/Name ',$e->getMessage());
	    }
	    
	    
	    // if one unique host found -> put id text input
	    if (count($hosts)==1) {
	        $this->view->hostname=$hosts[0]->name;
	        //$hostid=$hosts[0]->id;
	        // Tell JS to get services when page is loaded
	        $this->view->serviceGet=true;
	        
	    }
	    else
	    {
	        foreach($hosts as $key=>$val)
	        {
	            array_push($this->view->hostlist,$hosts[$key]->name);
	        }
	    }
	    
	    // set up trap oid and objects received by the trap
	    
	    $this->view->mainoid=$trapDetail->trap_oid;
	    if ($trapDetail->trap_name_mib != null)
	    {
	        $this->view->mib=$trapDetail->trap_name_mib;
	        $this->view->name=$trapDetail->trap_name;
	        $this->view->trapListForMIB=$this->getMIB()
	        ->getTrapList($trapDetail->trap_name_mib);
	    }
	    
	    // Get all objects that can be in trap from MIB
	    $allObjects=$this->getMIB()->getObjectList($trapDetail->trap_oid);
	    // Get all objects in current Trap
	    $currentTrapObjects=$this->getTrapobjects($trapid);
	    $oid_index=1;
	    foreach ($currentTrapObjects as $key => $val)
	    {
	        $currentObjectType='Unknown';
	        $currentObjectTypeEnum='Unknown';
	        if (isset($allObjects[$val->oid]['type']))
	        {
	            $currentObjectType=$allObjects[$val->oid]['type'];
	            $currentObjectTypeEnum=$allObjects[$val->oid]['type_enum'];
	        }
	        $currentObject=array(
	            $oid_index,
	            $val->oid,
	            $val->oid_name_mib,
	            $val->oid_name,
	            $val->value,
	            $currentObjectType,
	            $currentObjectTypeEnum
	        );
	        $oid_index++;
	        array_push($this->view->objectList,$currentObject);
	        // set currrent object to null in allObjects
	        if (isset($allObjects[$val->oid]))
	        {
	            $allObjects[$val->oid]=null;
	        }
	    }
	    if ($allObjects!=null) // in case trap doesn't have objects or is not resolved
	    {
	        foreach ($allObjects as $key => $val)
	        {
	            if ($val==null) { continue; }
	            array_push($this->view->objectList, array(
	                $oid_index,
	                $key,
	                $allObjects[$key]['mib'],
	                $allObjects[$key]['name'],
	                '',
	                $allObjects[$key]['type'],
	                $allObjects[$key]['type_enum']
	            ));
	            $oid_index++;
	        }
	    }
	    
	    // Add a simple display
	    $this->view->display='Trap '.$trapDetail->trap_name.' received';
	    $this->view->create_basic_rule=true;
	}

	/**
	 * Check if host & service still exists or set warning message
	 * @param object $ruleDetail 
	 */
	private function add_check_host_exists($ruleDetail)
	{
	    // Check if hostname still exists
	    $host_get=$this->getHostByName($this->view->hostname);
	    
	    if (count($host_get)==0)
	    {
	        $this->view->warning_message='Host '.$this->view->hostname. ' doesn\'t exists anymore';
	        $this->view->serviceGet=false;
	    }
	    else
	    {
	        // Tell JS to get services when page is loaded
	        $this->view->serviceGet=true;
	        // get service id for form to set :
	        $serviceID=$this->getServiceIDByName($this->view->hostname,$ruleDetail->service_name);
	        if (count($serviceID) ==0)
	        {
	            $this->view->warning_message=' Service '.$ruleDetail->service_name. ' doesn\'t exists anymore';
	        }
	        else
	        {
	            $this->view->serviceSet=$serviceID[0]->id;
	        }
	    }
	}

	/**
	 * Check if hostgroup & service still exists or set warning message
	 * @param object $ruleDetail
	 */
	private function add_check_hostgroup_exists($ruleDetail)
	{
	    // Check if groupe exists
	    $group_get=$this->getHostGroupByName($this->view->hostgroupname);
	    if (count($group_get)==0)
	    {
	        $this->view->warning_message='HostGroup '.$this->view->hostgroupname. ' doesn\'t exists anymore';
	        $this->view->serviceGroupGet=false;
	    }
	    else
	    {
	        $grpServices=$this->getServicesByHostGroupid($group_get[0]->id);
	        $foundGrpService=0;
	        foreach ($grpServices as $grpService)
	        {
	            if ($grpService[0] == $ruleDetail->service_name)
	            {
	                $foundGrpService=1;
	                $this->view->serviceSet=$ruleDetail->service_name;
	            }
	        }
	        
	        // Tell JS to get services when page is loaded
	        $this->view->serviceGroupGet=true;
	        if ($foundGrpService==0)
	        {
	            $this->view->warning_message.=' Service '.$ruleDetail->service_name. ' doesn\'t exists anymore';
	        }
	    }
	}
	
	/**
	 * Create object list array with all OIDs in rule & display
	 * Replace in rule & display by $<n>$
	 * @param string $display
	 * @param string $rule
	 * @return array
	 */
	private function add_create_trap_object_list(&$display, &$rule)
	{
	    $curObjectList=array();
	    $index=1;
	    // check in display & rule for : OID(<oid>)
	    $matches=array();
	    while ( preg_match('/_OID\(([\.0-9]+)\)/',$display,$matches) ||
	        preg_match('/_OID\(([\.0-9]+)\)/',$rule,$matches))
	    {
	        $curOid=$matches[1];
	        if (($object=$this->getMIB()->translateOID($curOid)) != null)
	        {
	            array_push($curObjectList, array(
	                $index,
	                $curOid,
	                $object['mib'],
	                $object['name'],
	                '',
	                $object['type'],
	                $object['type_enum']
	            ));
	        }
	        else
	        {
	            array_push($curObjectList, array(
	                $index,
	                $curOid,
	                'not found',
	                'not found',
	                '',
	                'not found'
	            ));
	        }
	        $display=preg_replace('/_OID\('.$curOid.'\)/','\$'.$index.'\$',$display);
	        $rule=preg_replace('/_OID\('.$curOid.'\)/','\$'.$index.'\$',$rule);
	        $index++;
	    }
	    return $curObjectList;
	}
	
	/** Add a handler  
	*	Get params fromid : setup from existing trap (id of trap table)
	*	Get param ruleid : edit from existing handler (id of rule table)
	*/
	public function addAction()
	{
		$this->checkConfigPermission();
		// set up tab
		$this->getTabs()->add('get',array(
			'active'	=> true,
			'label'		=> $this->translate('Add handler'),
			'url'		=> Url::fromRequest()
		));

		$this->add_setup_vars(); // setup default $this->view variables.
		
		// Get Mib List from DB
		$this->view->mibList=$this->getMIB()->getMIBList();
		
		//$this->view->trapvalues=false; // Set to true to display 'value' colum in objects
		
		if (($trapid = $this->params->get('fromid')) !== null) {
		    /********** Setup from existing trap ***************/
            $this->add_from_existing($trapid);
			return;
		}
		
		
		if ($this->params->get('ruleid') !== null) {
			/************* Rule editing ***************/
			$ruleid=$this->params->get('ruleid');
			$this->view->ruleid=$ruleid;
			$this->view->setToUpdate=true;

			// Get rule info from DB
			$ruleDetail=$this->getRuleDetail($ruleid);
			$this->view->hostname=$ruleDetail->host_name;
			$this->view->revertOK=$ruleDetail->revert_ok;
			$this->view->setRuleMatch=$ruleDetail->action_match;
			$this->view->setRuleNoMatch=$ruleDetail->action_nomatch;
			$this->view->hostgroupname=$ruleDetail->host_group_name;
			$this->view->modified=gmdate("Y-m-d\TH:i:s\Z",$ruleDetail->modified);
			$this->view->modifier=$ruleDetail->modifier;
			
			// Warning message if host/service don't exists anymore
			$this->view->warning_message='';
			if ($this->view->hostname != null)
			{
			    $this->view->selectGroup=false;
			    // Check if hostname still exists
			    $this->add_check_host_exists($ruleDetail);
			    $this->add_check_host_exists(/** @scrutinizer ignore-type */ $ruleDetail);
			}
			else
			{
			    $this->view->selectGroup=true;
			    $this->add_check_hostgroup_exists($ruleDetail); //  Check if groupe exists				
			    $this->add_check_hostgroup_exists(/** @scrutinizer ignore-type */ $ruleDetail); //  Check if groupe exists				
			}
			
			$this->view->mainoid=$ruleDetail->trap_oid;
			$oidName=$this->getMIB()->translateOID($ruleDetail->trap_oid);
			if ($oidName != null)  // oid is found in mibs
			{
				$this->view->mib=$oidName['mib']; 
				$this->view->name=$oidName['name'];
				$this->view->trapListForMIB=$this->getMIB()
					->getTrapList($oidName['mib']);				
			}
			// Create object list with : display & rules references (OID) and complete with all objects if found
			$display=$ruleDetail->display;
			$rule=$ruleDetail->rule;
			
			// Create object list array with all OIDs in rule & display
			$curObjectList=$this->add_create_trap_object_list($display, $rule);
			
			// set display
			$this->view->display=$display;
			$this->view->rule=$rule;
			
			$this->view->objectList=$curObjectList; 			
		}
	}
	
	/** Validate form and output message to user  
	*	@param in postdata 
	* 	@return string status : OK / <Message>
	**/
	protected function handlerformAction()
	{
		$postData=$this->getRequest()->getPost();
		//print_r($postData ).'<br>';
	
		$params=array(
			// id (also db) => 	array('post' => post id, 'val' => default val, 'db' => send to table)
			'hostgroup'		=>	array('post' => 'hostgroup','db'=>false),
			'db_rule'		=>	array('post' => 'db_rule','db'=>false),
			'hostid'		=>	array('post' => 'hostid','db'=>false),
			'host_name'		=>	array('post' => 'hostname','val' => null,'db'=>true),
			'host_group_name'=>	array('post' => null,'val' => null,'db'=>true),
			'serviceid'		=>	array('post' => 'serviceid','db'=>false),
			'service_name'	=>	array('post' => 'serviceName','db'=>true),
			'trap_oid'		=>	array('post' => 'oid','db'=>true),
			'revert_ok'		=>	array('post' => 'revertOK','val' => 0,'db'=>true),
			'display'		=>	array('post' => 'display','val' => '','db'=>true),
			'rule'			=>	array('post' => 'rule','val' => '','db'=>true),			
			'action_match'	=>	array('post' => 'ruleMatch','val' => -1,'db'=>true),
			'action_nomatch'=>	array('post' => 'ruleNoMatch','val' => -1,'db'=>true),					
			'ip4'			=>	array('post' => null,'val' => null,'db'=>true),
			'ip6'			=>	array('post' => null,'val' => null,'db'=>true),
			'action_form'	=>	array('post' => 'action_form','db'=>false)
		);
		
		if (isset($postData[$params['action_form']['post']]) 
			&& $postData[$params['action_form']['post']] == 'delete' )
		{
			try
			{
				$this->deleteRule($postData[$params['db_rule']['post']]);
			}
			catch (Exception $e)
			{
				$this->_helper->json(array('status'=>$e->getMessage()));
				return;
			}
			//$this->Module()->
			$this->_helper->json(array(
				'status'=>'OK',
			    'redirect'=>'trapdirector/handler'
			      
			));
		}		
		foreach (array_keys($params) as $key)
		{
			if ($params[$key]['post']==null) continue; // data not sent in post vars
			if (! isset($postData[$params[$key]['post']]))
			{
				// should not happen as the js checks data
				$this->_helper->json(array('status'=>'No ' . $key));
			}
			else
			{
				$data=$postData[$params[$key]['post']];
				if ($data!=null && $data !="")
				{
					$params[$key]['val']=$postData[$params[$key]['post']];
				}
			}
		}

		try 
		{
			$isHostGroup=($params['hostgroup']['val'] == 1)?true:false;
			if (! $isHostGroup ) 
			{  // checks if selection by host 
				$hostAddr=$this->getHostInfoByID($params['hostid']['val']);
				$params['ip4']['val']=$hostAddr->ip4;
				$params['ip6']['val']=$hostAddr->ip6;
				$checkHostName=$hostAddr->name;
				if ($params['host_name']['val'] != $checkHostName) 
				{
					$this->_helper->json(array('status'=>"Invalid host id : Please re enter host name"));
					return;
				}
				$serviceName=$this->getObjectNameByid($params['serviceid']['val']);
				$serviceName=$this->getObjectNameByid(/** @scrutinizer ignore-type */ $params['serviceid']['val']);
				if ($params['service_name']['val'] != $serviceName->name2)
				{
					$this->_helper->json(array('status'=>"Invalid service id : Please re enter service"));
					return;
				}
			}
			else
			{
				$object=$this->getObjectNameByid($params['hostid']['val']);
				if ($params['host_name']['val'] != $object->name1)
				{
					$this->_helper->json(array('status'=>"Invalid object group id : Please re enter service"));
					return;					
				}
				// Put param in correct column (group_name)
				$params['host_group_name']['val'] = $params['host_name']['val'];
				$params['host_name']['val']=null;
			}
			$dbparams=array();
			foreach ($params as $key=>$val)
			{
				if ($val['db']==true )
				{
					$dbparams[$key] = $val['val'];
				}
			}
			// echo '<br>';	print_r($dbparams);echo '<br>';
			if ($params['db_rule']['val'] == -1 ) 
			{
				$ruleID=$this->addHandlerRule($dbparams);
			}
			else
			{
				$this->updateHandlerRule($dbparams,$params['db_rule']['val']);
				$ruleID=$params['db_rule']['val'];
			}
		}
		catch (Exception $e)
		{
			$this->_helper->json(array('status'=>$e->getMessage()));
			return;
		}
		$this->_helper->json(array('status'=>'OK', 'id' => $ruleID));
		
	}

	/** Get trap detail by trapid. 
	*	@param integer $trapid : id of trap in received table
	*	@return array (objects)
	*/
	protected function getTrapDetail($trapid) 
	{
		if (!preg_match('/^[0-9]+$/',$trapid)) { throw new Exception('Invalid id');  }
		$queryArray=$this->getModuleConfig()->trapDetailQuery();
		
		$db = $this->getDb()->getConnection();
		// ***************  Get main data
		// extract columns and titles;
		$elmts=NULL;
		foreach ($queryArray as $key => $val) {
			$elmts[$key]=$val[1];
		}
		try
		{		
			$query = $db->select()
				->from($this->getModuleConfig()->getTrapTableName(),$elmts)
				->where('id=?',$trapid);
			$trapDetail=$db->fetchRow($query);
			if ( $trapDetail == null ) throw new Exception('No traps was found with id = '.$trapid);
		}
		catch (Exception $e)
		{
			$this->displayExitError('Add handler : get trap detail returning : '.print_r($trapDetail,true),$e->getMessage());

			return;
		}

		return $trapDetail;

	}

	/** Get trap objects
	*	@param integer $trapid : trap id
	* 	@return array : full column in db of trap id
	*/
	protected function getTrapobjects($trapid)
	{	
		if (!preg_match('/^[0-9]+$/',$trapid)) { throw new Exception('Invalid id');  }
		$queryArrayData=$this->getModuleConfig()->trapDataDetailQuery();
		
		$db = $this->getDb()->getConnection();
		// ***************  Get object data
		// extract columns and titles;
		$data_elmts=NULL;
		foreach ($queryArrayData as $key => $val) {
			$data_elmts[$key]=$val[1];
		}
		try
		{		
			$query = $db->select()
				->from($this->moduleConfig->getTrapDataTableName(),$data_elmts)
				->where('trap_id=?',$trapid);
			$trapDetail=$db->fetchAll($query);
			// if ( $trapDetail == null ) throw new Exception('No traps was found with id = '.$trapid);
		}
		catch (Exception $e)
		{
			$this->displayExitError('Add handler : get trap data detail : ',$e->getMessage());
			return array();
		}

		return $trapDetail;
	}

	/** Get rule detail by ruleid.
	*	@param integer $ruleid int id of rule in rule table
	*	@return array : column objects in db
	*/
	protected function getRuleDetail($ruleid) 
	{
		if (!preg_match('/^[0-9]+$/',$ruleid)) { throw new Exception('Invalid id');  }
		$queryArray=$this->getModuleConfig()->ruleDetailQuery();
		
		$db = $this->getDb()->getConnection();
		// ***************  Get main data
		try
		{		
			$query = $db->select()
				->from($this->getModuleConfig()->getTrapRuleName(),$queryArray)
				->where('id=?',$ruleid);
			$ruleDetail=$db->fetchRow($query);
			if ( $ruleDetail == null ) throw new Exception('No rule was found with id = '.$ruleid);
		}
		catch (Exception $e)
		{
			$this->displayExitError('Update handler : get rule detail',$e->getMessage());
			return array();
		}

		return $ruleDetail;

	}

	/** Setup tabs for rules 
	*/
	protected function prepareTabs()
	{
		return $this->getTabs()->add('status', array(
			'label' => $this->translate('Traps'),
			'url'   => $this->getModuleConfig()->urlPath() . '/handler')
		);
	} 
	
}
patrickpr / trapdirector

Push — master ( f4c14e...6af608 )

HandlerController::indexAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
