HelperController::checkPostVar() - Code Metrics - Inspection of "added checkPostVars Function" - patrickpr/trapdirector - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 6b0d98...409614 )

by Patrick
created 2020-01-26 17:14 UTC
HelperController::checkPostVar() A

↳ Parent: HelperController
Complexity

Conditions	3
Paths	3
Size

Total Lines	13
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace Icinga\Module\Trapdirector\Controllers;

//use Icinga\Web\Controller;
//use Icinga\Web\Url;
use Exception;
use Icinga\Module\Trapdirector\TrapsController;
use Trapdirector\Trap;

class HelperController extends TrapsController
{
	
	/** Get host list with filter (IP or name) : host=<filter>
	*	returns in JSON : status=>OK/NOK  hosts=>array of hosts
	*/
	public function gethostsAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$hostFilter = $this->checkPostVar($postData, 'hostFilter', '.*');
		
		$retHosts=array('status'=>'OK','hosts' => array());

		$hosts=$this->getHostByIP($hostFilter);
		foreach ($hosts as $val)
		{
			array_push($retHosts['hosts'],$val->name);
		}
		
		$this->_helper->json($retHosts);
	}
	
	/** Get hostgroup list with filter (name) : hostgroup=<hostFilter>
	*	returns in JSON : status=>OK/NOK  hosts=>array of hosts
	*/
	public function gethostgroupsAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$hostFilter = $this->checkPostVar($postData, 'hostfilter', '.*');
		
		$retHosts=array('status'=>'OK','hosts' => array());

		$hosts=$this->getHostGroupByName($hostFilter);
		foreach ($hosts as $val)
		{
			array_push($retHosts['hosts'],$val->name);
		}
		
		$this->_helper->json($retHosts);
	}
	
	/** Get service list by host name ( host=<host> )
	*	returns in JSON : 
	*		status=>OK/No services found/More than one host matches
	*		services=>array of services (name)
	*		hostid = host object id or -1 if not found.
	*/
	public function getservicesAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$host=$this->checkPostVar($postData, 'host', '.*');

		if (isset($postData['host']))
		{
			$host=$postData['host'];
		}
		else
		{
			$this->_helper->json(array('status'=>'No Hosts','hostid' => -1));
			return;
		}
		
		$hostArray=$this->getHostByName($host);
		if (count($hostArray) > 1)
		{	
			$this->_helper->json(array('status'=>'More than one host matches','hostid' => -1));
			return;
		}
		else if (count($hostArray) == 0)
		{
			$this->_helper->json(array('status'=>'No host matches','hostid' => -1));
			return;
		}
		$services=$this->getServicesByHostid($hostArray[0]->id);
		if (count($services) < 1)
		{
			$this->_helper->json(array('status'=>'No services found for host','hostid' => $hostArray[0]->id));
			return;
		}
		$retServices=array('status'=>'OK','services' => array(),'hostid' => $hostArray[0]->id);
		foreach ($services as $val)
		{
			array_push($retServices['services'],array($val->id , $val->name));
		}
		$this->_helper->json($retServices);
	}
	
	/** Get service list by host group ( name=<host> )
	*	returns in JSON : 
	*		status=>OK/No services found/More than one host matches
	*		services=>array of services (name)
	*		groupid = group object id or -1 if not found.
	*/
	public function gethostgroupservicesAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$host = $this->checkPostVar($postData, 'host', '.*');
		
		$hostArray=$this->getHostGroupByName($host);
		if (count($hostArray) > 1)
		{	
			$this->_helper->json(array('status'=>'More than one hostgroup matches','hostid' => -1));
			return;
		}
		else if (count($hostArray) == 0)
		{
			$this->_helper->json(array('status'=>'No hostgroup matches','hostid' => -1));
			return;
		}
		$services=$this->getServicesByHostGroupid($hostArray[0]->id);
		if (count($services) < 1)
		{
			$this->_helper->json(array('status'=>'No services found for hostgroup','hostid' => $hostArray[0]->id));
			return;
		}
		$retServices=array('status'=>'OK','services' => $services,'hostid' => $hostArray[0]->id);
		
		$this->_helper->json($retServices);
	}

	/** Get traps from mib  : entry : mib=<mib>
	*	returns in JSON : 
	*		status=>OK/No mib/Error getting mibs
	*		traps=>array of array( oid -> name)
	*/
	public function gettrapsAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$mib = $this->checkPostVar($postData, 'mib', '.*');

		try
		{
			$traplist=$this->getMIB()->getTrapList($mib);
			$retTraps=array('status'=>'OK','traps' => $traplist);
		} 
		catch (Exception $e) 
		{ 
			$retTraps=array('status' => 'Error getting mibs');
		}
		$this->_helper->json($retTraps);
	}	

	/** Get trap objects from mib  : entry : trap=<oid>
	*	returns in JSON : 
	*		status=>OK/no trap/not found
	*		objects=>array of array( oid -> name, oid->mib)
	*/
	public function gettrapobjectsAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$trap = $this->checkPostVar($postData, 'trap', '.*');
		
		try
		{
			$objectlist=$this->getMIB()->getObjectList($trap);
			$objectlist=$this->getMIB()->getObjectList(/** @scrutinizer ignore-type */ $trap);
			$retObjects=array('status'=>'OK','objects' => $objectlist);
		} 
		catch (Exception $e) 
		{ 
			$retObjects=array('status' => 'not found');
		}
		$this->_helper->json($retObjects);
	}	
	
	/** Get list of all loaded mibs : entry : none
	*	return : array of strings.
	*/
	public function getmiblistAction()
	{
		try
		{
			$miblist=$this->getMIB()->getMIBList();
		} 
		catch (Exception $e) 
		{ 
			$miblist=array('Error getting mibs');
		}
		$this->_helper->json($miblist);
	}
	
	/** Get MIB::Name from OID : entry : oid
	*		status=>OK/No oid/not found
	*		mib=>string
	*		name=>string
	*/	
	public function translateoidAction()
	{
		$postData=$this->getRequest()->getPost();
		
		$oid = $this->checkPostVar($postData, 'oid', '.*');
		
		// Try to get oid name from snmptranslate
		if (($object=$this->getMIB()->translateOID($oid)) == null)
		{
			$this->_helper->json(array('status'=>'Not found'));
			return;
		}
		else
		{
			$this->_helper->json(
				array('status'=>'OK',
					'mib' => $object['mib'], 
					'name' => $object['name'],
					'type' => $object['type'],
					'type_enum' => $object['type_enum'],
				    'description' => $object['description']
				)
			);
		}

	}
	
	/** Save or execute database purge of <n> days
	*	days=>int 
	*	action=>save/execute
	*	return : status=>OK/Message error
	*/
	public function dbmaintenanceAction()
	{
		
		$postData=$this->getRequest()->getPost();
		
		$days = $this->checkPostVar($postData, 'days', '^[0-9]+$');

		$action = $this->checkPostVar($postData, 'action', 'save|execute');
		
		if ($action == 'save')
		{
			try
			{
				$this->setDBConfigValue('db_remove_days',$days);
			}
			catch (Exception $e)
			{
				$this->_helper->json(array('status'=>'Save error : '.$e->getMessage() ));
				return;
			}
			$this->_helper->json(array('status'=>'OK'));
			return;
		}
		if ($action == 'execute')
		{
			try
			{
				require_once($this->Module()->getBaseDir() .'/bin/trap_class.php');
				$icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc');
				$debug_level=4;
				$Trap = new Trap($icingaweb2_etc);
				$Trap->setLogging($debug_level,'syslog');
				$Trap->eraseOldTraps($days);
				$Trap->eraseOldTraps(/** @scrutinizer ignore-type */ $days);
			}
			catch (Exception $e)
			{
				$this->_helper->json(array('status'=>'execute error : '.$e->getMessage() ));
				return;
			}			
			$this->_helper->json(array('status'=>'OK'));
		}
			
	}	

	/** Save log output to db
	*	destination=>log destination 
	*	file=>file name
	*	level => int 
	*	return : status=>OK/Message error
	*/
	public function logdestinationAction()
	{
		$postData=$this->getRequest()->getPost();
		if (isset($postData['destination']))
		{
			$destination=$postData['destination'];
			$logDest=$this->getModuleConfig()->getLogDestinations();
			if (!isset($logDest[$destination]))
			{
				$this->_helper->json(array('status'=>'invalid destination : '.$destination));
				return;
			}
		}
		else
		{
			$this->_helper->json(array('status'=>'No destination'));
		}
		if (isset($postData['file']))
		{ 
			$file=$postData['file'];
			$fileHandler=@fopen($file,'w');
			if ($fileHandler == false)
			{   // File os note writabe / cannot create
			    $this->_helper->json(array('status'=>'File not writable :  '.$file));
			    return;
			}
		}
		else
		{
			if ($destination != 'file')

			{
				$file=null;
			}
			else
			{
				$this->_helper->json(array('status'=>'No file'));
				return;
			}
		}

		if (isset($postData['level']))
		{ 
			$level=$postData['level'];
		}
		else
		{
			$this->_helper->json(array('status'=>'No level'));
			return;
		}
		
		try
		{
			$this->setDBConfigValue('log_destination',$destination);
			$this->setDBConfigValue('log_file',$file);
			$this->setDBConfigValue('log_level',$level);
		}
		catch (Exception $e)
		{
			$this->_helper->json(array('status'=>'Save error : '.$e->getMessage() ));
			return;
		}
		$this->_helper->json(array('status'=>'OK'));
		return;
			
	}	
	
	/** Test a rule evaluation
	 *	rule=>rule to evaluate
	 *	action=>'evaluate'
	 *	return : status=>OK/Message error & message : return of evaluation
	 */
	public function testruleAction()
	{
	    
	    $postData=$this->getRequest()->getPost();
	    if (isset($postData['rule']))
	    {
	        $rule=$postData['rule'];
	    }
	    else
	    {
	        $this->_helper->json(array('status'=>'No Rule'));
	    }
	    if (isset($postData['action']))
	    {
	        $action=$postData['action'];
	        if ($action != 'evaluate')
	        {
	            $this->_helper->json(array('status'=>'unknown action '.$action));
	            return;
	        }
	    }
	    else
	    {
	        $this->_helper->json(array('status'=>'No action'));
	        return;
	    }
	    if ($action == 'evaluate')
	    {
	        try
	        {
	            require_once($this->Module()->getBaseDir() .'/bin/trap_class.php');
	            $icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc');
	            $Trap = new Trap($icingaweb2_etc);
	            // Cleanup spaces before eval
	            $rule=$Trap->ruleClass->eval_cleanup($rule);

	            // Eval
	            $item=0;
	            $rule=$Trap->ruleClass->evaluation($rule,$item);
	        }
	        catch (Exception $e)
	        {
	            $this->_helper->json(array('status'=>'Evaluation error : '.$e->getMessage() ));
	            return;
	        }
	        $return=($rule==true)?'true':'false';
	        $this->_helper->json(array('status'=>'OK', 'message' => $return));
	    }
	    
	}	

	/** Test a rule evaluation
	 *	name    => name of plugin
	 *	action  => enable | disable
	 *	return : status=>OK/Message error
	 */
	public function pluginAction()
	{
	    $postData=$this->getRequest()->getPost();
	    if (isset($postData['name']))
	    {
	        $pluginName=$postData['name'];
	    }
	    else
	    {
	        $this->_helper->json(array('status'=>'No plugin name'));
	    }
	    if (isset($postData['action']))
	    {
	        $action=$postData['action'];
	        if ($action != 'enable' && $action != 'disable')
	        {
	            $this->_helper->json(array('status'=>'unknown action '.$action));
	            return;
	        }
	    }
	    else
	    {
	        $this->_helper->json(array('status'=>'No action'));
	        return;
	    }

        try
        {
            require_once($this->Module()->getBaseDir() .'/bin/trap_class.php');
            $icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc');
            $Trap = new Trap($icingaweb2_etc);
            // Enable plugin.
            $action=($action == 'enable') ? true : false;
            $retVal=$Trap->pluginClass->enablePlugin($pluginName, $action);

            
        }
        catch (Exception $e)
        {
            $this->_helper->json(array('status'=>'Action error : '.$e->getMessage() ));
            return;
        }
        if ($retVal === true)
        {
            $this->_helper->json(array('status'=>'OK'));
        }
        else
        {
            $this->_helper->json(array('status'=>'Error, see logs'));
        }
	}
	
	/** Function evaluation
	 *	function    => name of function
	 *	action      => evaluate
	 *	return : status=>OK/Message error & message : return of evaluation ('true' or 'false' )
	 */
	public function functionAction()
	{
	    $postData=$this->getRequest()->getPost();
	    if (isset($postData['function']))
	    {
	        $functionString=$postData['function'];
	    }
	    else
	    {
	        $this->_helper->json(array('status'=>'No function name'));
	    }
	    if (isset($postData['action']))
	    {
	        $action=$postData['action'];
	        if ($action != 'evaluate')
	        {
	            $this->_helper->json(array('status'=>'unknown action '.$action));
	            return;
	        }
	    }
	    else
	    {
	        $this->_helper->json(array('status'=>'No action'));
	        return;
	    }
	    
	    try
	    {
	        require_once($this->Module()->getBaseDir() .'/bin/trap_class.php');
	        $icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc');
	        $Trap = new Trap($icingaweb2_etc);
	        // load all plugins in case tested function is not enabled.
	        $Trap->pluginClass->registerAllPlugins(false);
	        // Clean all spaces
	        $functionString = $Trap->ruleClass->eval_cleanup($functionString);

	        // Eval functions
	        $result = $Trap->pluginClass->evaluateFunctionString($functionString);	        
	    }
	    catch (Exception $e)
	    {
	        $this->_helper->json(array('status'=>'Action error : '.$e->getMessage() ));
	        return;
	    }
	    
        $result = ($result === true)?'True':'False';
        $this->_helper->json(array('status'=>'OK','message' => $result));
	}

    /**************   Utilities **********************/

	private function checkPostVar(array $postData,string $postVar, string $validRegexp) : string
	{
	    if (!isset ($postData[$postVar]))
	    {
	        $this->_helper->json(array('status'=>'No ' . $postVar));
	        return '';
	    }
	    if (preg_match('/'.$validRegexp.'/', $postData[$postVar]) != 1)
	    {
	        $this->_helper->json(array('status'=>'Unknown ' . $postVar . ' value '.$postData[$postVar]));
	        return '';
	    }
	    return $postData[$postVar];
	}
}

patrickpr / trapdirector

Push — master ( 6b0d98...409614 )

HelperController::checkPostVar() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
