TrapsController::checkReadPermission() - Code Metrics - patrickpr/trapdirector - Measure and Improve Code Quality continuously with Scrutinizer

TrapsController::checkReadPermission() A
last analyzed 2020-10-31 13:30 UTC

↳ Parent: TrapsController

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	2
c	2
b	0
f	0
nc	2
nop	0
dl	0
loc	4
rs	10

<?php

namespace Icinga\Module\Trapdirector;

use Icinga\Web\Controller;

use Icinga\Data\Paginatable;

//use Exception;

use Icinga\Module\Trapdirector\Config\TrapModuleConfig;
use Icinga\Module\Trapdirector\Tables\TrapTableList;
use Icinga\Module\Trapdirector\Tables\TrapTableHostList;
use Icinga\Module\Trapdirector\Tables\HandlerTableList;
use Icinga\Module\Trapdirector\Config\MIBLoader;
use Icinga\Module\Trapdirector\TrapsActions\UIDatabase;

use Trapdirector\Trap;

use Icinga\Data\ConfigObject;
use Icinga\Exception\ProgrammingError;

class TrapsController extends Controller
{
	/** @var TrapModuleConfig $moduleConfig TrapModuleConfig instance */
	protected $moduleConfig;
	/** @var TrapTableList $trapTableList (by date)*/
	protected $trapTableList;
	/** @var TrapTableHostList $trapTableHostList TrapTableList (by hosts)*/
	protected $trapTableHostList;
	/** @var HandlerTableList $handlerTableList HandlerTableList instance*/
	protected $handlerTableList;
	/** @var ConfigObject $trapDB Trap database */
	protected $trapDB;
	/** @var ConfigObject $icingaDB Icinga IDO database */
	protected $icingaDB;
	/** @var MIBLoader $MIBData MIBLoader class */
	protected $MIBData;
	/** @var Trap $trapClass Trap class for bin/trap_class.php */
	protected $trapClass;
	/** @var UIDatabase $UIDatabase */
	protected $UIDatabase = NULL;
	/** @var Icinga2API $IcingaAPI */
	protected $icingaAPI = NULL;
	/** @var bool $apiMode connection to icinngaDB is by api (true) od ido DB (false) */
	protected $apiMode = FALSE;
	
	
	
	
	/** Get instance of TrapModuleConfig class
	*	@return TrapModuleConfig
	*/
	public function getModuleConfig() 
	{
		if ($this->moduleConfig == Null) 
		{
			$db_prefix=$this->Config()->get('config', 'database_prefix');
			if ($db_prefix === null) 
			{
				$this->redirectNow('trapdirector/settings?message=No database prefix');
			}
			$this->moduleConfig = new TrapModuleConfig($db_prefix);
		}
		return $this->moduleConfig;
	}
	
	/**
	 * Get instance of TrapTableList
	 * @return \Icinga\Module\Trapdirector\Tables\TrapTableList
	 */
	public function getTrapListTable() {
		if ($this->trapTableList == Null) {
			$this->trapTableList = new TrapTableList();
			$this->trapTableList->setConfig($this->getModuleConfig());
		}
		return $this->trapTableList;
	}
	
	/**
	 * @return \Icinga\Module\Trapdirector\Tables\TrapTableHostList
	 */
	public function getTrapHostListTable()
	{
	    if ($this->trapTableHostList == Null) 
		{
	        $this->trapTableHostList = new TrapTableHostList();
	        $this->trapTableHostList->setConfig($this->getModuleConfig());
	    }
	    return $this->trapTableHostList;
	}
	
	/**
	 * @return \Icinga\Module\Trapdirector\Tables\HandlerTableList
	 */
	public function getHandlerListTable() 
	{
		if ($this->handlerTableList == Null) 
		{
			$this->handlerTableList = new HandlerTableList();
			$this->handlerTableList->setConfig($this->getModuleConfig());
		}
		return $this->handlerTableList;
	}	

	/**
	 * @return UIDatabase
	 */
	public function getUIDatabase()
	{
	    if ($this->UIDatabase == Null)
	    {
	        $this->UIDatabase = new UIDatabase($this);
	       
	    }
	    return $this->UIDatabase;
	}

	/**
	 * Get Ido connection on API (first) or Database as fallback
	 * @return \Icinga\Module\Trapdirector\TrapsActions\UIDatabase|\Icinga\Module\Trapdirector\Icinga2API
	 */
	public function getIdoConn()
	{
	    if ($this->icingaAPI === NULL)
	    {
    	    $host = $this->Config()->get('config', 'icingaAPI_host');
    	    if ($host == '')
    	    {
    	        $this->apiMode = FALSE;
    	        return $this->getUIDatabase();
    	    }
    	    $port = $this->Config()->get('config', 'icingaAPI_port');
    	    $user = $this->Config()->get('config', 'icingaAPI_user');
    	    $pass = $this->Config()->get('config', 'icingaAPI_password');
    	    $this->icingaAPI = new Icinga2API($host,$port);
    	    $this->icingaAPI->setCredentials($user, $pass);
    	    list($ret,$message) = $this->icingaAPI->test($this->getModuleConfig()->getapiUserPermissions());
    	    if ($ret === TRUE) // On error, switch to ido DB
    	    {
    	        $this->apiMode = FALSE;
    	        return $this->getUIDatabase();
    	    }
    	    $this->apiMode = TRUE;
    	    
	    }
	    return $this->icingaAPI;
	    
	}
	
    protected function applyPaginationLimits(Paginatable $paginatable, $limit = 25, $offset = null)
    {
        $limit = $this->params->get('limit', $limit);
        $page = $this->params->get('page', $offset);

        $paginatable->limit($limit, $page > 0 ? ($page - 1) * $limit : 0);

        return $paginatable;
    }	
	
	public function displayExitError($source,$message)
	{	// TODO : check better ways to transmit data (with POST ?)
		$this->redirectNow('trapdirector/error?source='.$source.'&message='.$message);
	}
	
	protected function checkReadPermission()
	{
        if (! $this->Auth()->hasPermission('trapdirector/view')) {
            $this->displayExitError('Permissions','No permission fo view content');
        }		
	}

	protected function checkConfigPermission()
	{
        if (! $this->Auth()->hasPermission('trapdirector/config')) {
            $this->displayExitError('Permissions','No permission fo configure');
        }		
	}
	
    /**
     * Check if user has write permission
     * @param number $check optional : if set to 1, return true (user has permission) or false instead of displaying error page
     * @return boolean : user has permission
     */
	protected function checkModuleConfigPermission($check=0)
	{
        if (! $this->Auth()->hasPermission('trapdirector/module_config')) {
            if ($check == 0)
            {
                $this->displayExitError('Permissions','No permission fo configure module');
            }
            return false;
        }
        return true;
	}

	/*************************  Trap class get **********************/
	public function getTrapClass()
	{ // TODO : try/catch here ? or within caller
		if ($this->trapClass == null)
		{
			require_once($this->Module()->getBaseDir() .'/bin/trap_class.php');
			$icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc');
			//$debug_level=4;
			$this->trapClass = new Trap($icingaweb2_etc);
			//$Trap->setLogging($debug_level,'syslog');
		}
		return $this->trapClass;
	}
	
	/************************** MIB related **************************/
	
	/** Get MIBLoader class
	*	@return MIBLoader class
	*/
	protected function getMIB()
	{
		if ($this->MIBData == null)
		{
		    $dbConn = $this->getUIDatabase()->getDbConn();
		    if ($dbConn === null) throw new \ErrorException('uncatched db error');
			$this->MIBData=new MIBLoader(
				$this->Config()->get('config', 'snmptranslate'),
				$this->Config()->get('config', 'snmptranslate_dirs'),
			    $dbConn,
				$this->getModuleConfig()
			);
		}
		return $this->MIBData;
	}	
	
	/**************************  Database queries *******************/		
	
	/** Check if director is installed
	*	@return bool true/false
	*/
	protected function isDirectorInstalled()
	{
	    $output=array();
	    exec('icingacli module list',$output);
	    foreach ($output as $line)
		{
			if (preg_match('/^director .*enabled/',$line))
			{
				return true;
			}
		}
		return false;
	}


	/************************ UI elements **************************/
	
    /**
     * get max rows to display before paging.
     * @return number
     */
	public function itemListDisplay()
	{
	    return $this->getUIDatabase()->getDBConfigValue('max_rows_in_list');
	}

	public function setitemListDisplay(int $maxRows)
	{
	    return $this->getUIDatabase()->setDBConfigValue('max_rows_in_list',$maxRows);
	}
	
    /**
     * get Handlers categories list (index => textvalue).
     * @return array
     */	
	public function getHandlersCategory()
	{
	    //<index>:<name>!<index>:<name>
	    $catList = $this->getUIDatabase()->getDBConfigValue('handler_categories');
	    $catListArray=explode('!',$catList);
	    $retArray=array();
	    foreach ($catListArray as $category)
	    {
	        $catArray=explode(':',$category);
	        $retArray[$catArray[0]] = $catArray[1];
	    }
	    return $retArray; 
	}

	public function setHandlerCategory(array $catArray)
	{
	    $catString='';
	    foreach ($catArray as $index => $value)
	    {
	        if ($catString != '' ) $catString .= '!';
	        $catString .= $index . ':' . $value;
	    }
	    $this->getUIDatabase()->setDBConfigValue('handler_categories', $catString);
	}
	
	public function addHandlersCategory(string $catName)
	{
	    $catArray = $this->getHandlersCategory();
	    $i=1;
	    while (isset($catArray[$i]) && $i < 100) $i++;
	    if ($i == 100) throw new ProgrammingError('Category array error');
	    $catArray[$i] = $catName;
	    $this->setHandlerCategory($catArray);
	}
	
	public function delHandlersCategory(int $catIndex)
	{
	    $catArray = $this->getHandlersCategory();
	    unset($catArray[$catIndex]);
	    $this->setHandlerCategory($catArray);
	    $this->getUIDatabase()->updateHandlersOnCategoryDelete($catIndex);
	}
	
	public function renameHandlersCategory(int $catIndex, string $catName)
	{
	    $catArray = $this->getHandlersCategory();
	    $catArray[$catIndex] = $catName;
	    $this->setHandlerCategory($catArray);
	}
	
}



1			<?php
2
3			namespace Icinga\Module\Trapdirector;
4
5			use Icinga\Web\Controller;
6
7			use Icinga\Data\Paginatable;
8
9			//use Exception;
10
11			use Icinga\Module\Trapdirector\Config\TrapModuleConfig;
12			use Icinga\Module\Trapdirector\Tables\TrapTableList;
13			use Icinga\Module\Trapdirector\Tables\TrapTableHostList;
14			use Icinga\Module\Trapdirector\Tables\HandlerTableList;
15			use Icinga\Module\Trapdirector\Config\MIBLoader;
16			use Icinga\Module\Trapdirector\TrapsActions\UIDatabase;
17
18			use Trapdirector\Trap;
19
20			use Icinga\Data\ConfigObject;
21			use Icinga\Exception\ProgrammingError;
22
23			class TrapsController extends Controller
24			{
25			/** @var TrapModuleConfig $moduleConfig TrapModuleConfig instance */
26			protected $moduleConfig;
27			/** @var TrapTableList $trapTableList (by date)*/
28			protected $trapTableList;
29			/** @var TrapTableHostList $trapTableHostList TrapTableList (by hosts)*/
30			protected $trapTableHostList;
31			/** @var HandlerTableList $handlerTableList HandlerTableList instance*/
32			protected $handlerTableList;
33			/** @var ConfigObject $trapDB Trap database */
34			protected $trapDB;
35			/** @var ConfigObject $icingaDB Icinga IDO database */
36			protected $icingaDB;
37			/** @var MIBLoader $MIBData MIBLoader class */
38			protected $MIBData;
39			/** @var Trap $trapClass Trap class for bin/trap_class.php */
40			protected $trapClass;
41			/** @var UIDatabase $UIDatabase */
42			protected $UIDatabase = NULL;
43			/** @var Icinga2API $IcingaAPI */
44			protected $icingaAPI = NULL;
45			/** @var bool $apiMode connection to icinngaDB is by api (true) od ido DB (false) */
46			protected $apiMode = FALSE;
47
48
49
50
51			/** Get instance of TrapModuleConfig class
52			* @return TrapModuleConfig
53			*/
54			public function getModuleConfig()
55			{
56			if ($this->moduleConfig == Null)
57			{
58			$db_prefix=$this->Config()->get('config', 'database_prefix');
59			if ($db_prefix === null)
60			{
61			$this->redirectNow('trapdirector/settings?message=No database prefix');
62			}
63			$this->moduleConfig = new TrapModuleConfig($db_prefix);
64			}
65			return $this->moduleConfig;
66			}
67
68			/**
69			* Get instance of TrapTableList
70			* @return \Icinga\Module\Trapdirector\Tables\TrapTableList
71			*/
72			public function getTrapListTable() {
73			if ($this->trapTableList == Null) {
74			$this->trapTableList = new TrapTableList();
75			$this->trapTableList->setConfig($this->getModuleConfig());
76			}
77			return $this->trapTableList;
78			}
79
80			/**
81			* @return \Icinga\Module\Trapdirector\Tables\TrapTableHostList
82			*/
83			public function getTrapHostListTable()
84			{
85			if ($this->trapTableHostList == Null)
86			{
87			$this->trapTableHostList = new TrapTableHostList();
88			$this->trapTableHostList->setConfig($this->getModuleConfig());
89			}
90			return $this->trapTableHostList;
91			}
92
93			/**
94			* @return \Icinga\Module\Trapdirector\Tables\HandlerTableList
95			*/
96			public function getHandlerListTable()
97			{
98			if ($this->handlerTableList == Null)
99			{
100			$this->handlerTableList = new HandlerTableList();
101			$this->handlerTableList->setConfig($this->getModuleConfig());
102			}
103			return $this->handlerTableList;
104			}
105
106			/**
107			* @return UIDatabase
108			*/
109			public function getUIDatabase()
110			{
111			if ($this->UIDatabase == Null)
112			{
113			$this->UIDatabase = new UIDatabase($this);
114
115			}
116			return $this->UIDatabase;
117			}
118
119			/**
120			* Get Ido connection on API (first) or Database as fallback
121			* @return \Icinga\Module\Trapdirector\TrapsActions\UIDatabase\|\Icinga\Module\Trapdirector\Icinga2API
122			*/
123			public function getIdoConn()
124			{
125			if ($this->icingaAPI === NULL)
126			{
127			$host = $this->Config()->get('config', 'icingaAPI_host');
128			if ($host == '')
129			{
130			$this->apiMode = FALSE;
131			return $this->getUIDatabase();
132			}
133			$port = $this->Config()->get('config', 'icingaAPI_port');
134			$user = $this->Config()->get('config', 'icingaAPI_user');
135			$pass = $this->Config()->get('config', 'icingaAPI_password');
136			$this->icingaAPI = new Icinga2API($host,$port);
137			$this->icingaAPI->setCredentials($user, $pass);
138			list($ret,$message) = $this->icingaAPI->test($this->getModuleConfig()->getapiUserPermissions());
139			if ($ret === TRUE) // On error, switch to ido DB
140			{
141			$this->apiMode = FALSE;
142			return $this->getUIDatabase();
143			}
144			$this->apiMode = TRUE;
145
146			}
147			return $this->icingaAPI;
148
149			}
150
151			protected function applyPaginationLimits(Paginatable $paginatable, $limit = 25, $offset = null)
152			{
153			$limit = $this->params->get('limit', $limit);
154			$page = $this->params->get('page', $offset);
155
156			$paginatable->limit($limit, $page > 0 ? ($page - 1) * $limit : 0);
157
158			return $paginatable;
159			}
160
161			public function displayExitError($source,$message)
162			{ // TODO : check better ways to transmit data (with POST ?)
163			$this->redirectNow('trapdirector/error?source='.$source.'&message='.$message);
164			}
165
166			protected function checkReadPermission()
167			{
168			if (! $this->Auth()->hasPermission('trapdirector/view')) {
169			$this->displayExitError('Permissions','No permission fo view content');
170			}
171			}
172
173			protected function checkConfigPermission()
174			{
175			if (! $this->Auth()->hasPermission('trapdirector/config')) {
176			$this->displayExitError('Permissions','No permission fo configure');
177			}
178			}
179
180			/**
181			* Check if user has write permission
182			* @param number $check optional : if set to 1, return true (user has permission) or false instead of displaying error page
183			* @return boolean : user has permission
184			*/
185			protected function checkModuleConfigPermission($check=0)
186			{
187			if (! $this->Auth()->hasPermission('trapdirector/module_config')) {
188			if ($check == 0)
189			{
190			$this->displayExitError('Permissions','No permission fo configure module');
191			}
192			return false;
193			}
194			return true;
195			}
196
197			/*********************** Trap class get ********************/
198			public function getTrapClass()
199			{ // TODO : try/catch here ? or within caller
200			if ($this->trapClass == null)
201			{
202			require_once($this->Module()->getBaseDir() .'/bin/trap_class.php');
203			$icingaweb2_etc=$this->Config()->get('config', 'icingaweb2_etc');
204			//$debug_level=4;
205			$this->trapClass = new Trap($icingaweb2_etc);
206			//$Trap->setLogging($debug_level,'syslog');
207			}
208			return $this->trapClass;
209			}
210
211			/************************ MIB related ************************/
212
213			/** Get MIBLoader class
214			* @return MIBLoader class
215			*/
216			protected function getMIB()
217			{
218			if ($this->MIBData == null)
219			{
220			$dbConn = $this->getUIDatabase()->getDbConn();
221			if ($dbConn === null) throw new \ErrorException('uncatched db error');
222			$this->MIBData=new MIBLoader(
223			$this->Config()->get('config', 'snmptranslate'),
224			$this->Config()->get('config', 'snmptranslate_dirs'),
225			$dbConn,
226			$this->getModuleConfig()
227			);
228			}
229			return $this->MIBData;
230			}
231
232			/************************ Database queries *****************/
233
234			/** Check if director is installed
235			* @return bool true/false
236			*/
237			protected function isDirectorInstalled()
238			{
239			$output=array();
240			exec('icingacli module list',$output);
241			foreach ($output as $line)
242			{
243			if (preg_match('/^director .*enabled/',$line))
244			{
245			return true;
246			}
247			}
248			return false;
249			}
250
251
252			/********************** UI elements ************************/
253
254			/**
255			* get max rows to display before paging.
256			* @return number
257			*/
258			public function itemListDisplay()
259			{
260			return $this->getUIDatabase()->getDBConfigValue('max_rows_in_list');
261			}
262
263			public function setitemListDisplay(int $maxRows)
264			{
265			return $this->getUIDatabase()->setDBConfigValue('max_rows_in_list',$maxRows);
266			}
267
268			/**
269			* get Handlers categories list (index => textvalue).
270			* @return array
271			*/
272			public function getHandlersCategory()
273			{
274			//<index>:<name>!<index>:<name>
275			$catList = $this->getUIDatabase()->getDBConfigValue('handler_categories');
276			$catListArray=explode('!',$catList);
277			$retArray=array();
278			foreach ($catListArray as $category)
279			{
280			$catArray=explode(':',$category);
281			$retArray[$catArray[0]] = $catArray[1];
282			}
283			return $retArray;
284			}
285
286			public function setHandlerCategory(array $catArray)
287			{
288			$catString='';
289			foreach ($catArray as $index => $value)
290			{
291			if ($catString != '' ) $catString .= '!';
292			$catString .= $index . ':' . $value;
293			}
294			$this->getUIDatabase()->setDBConfigValue('handler_categories', $catString);
295			}
296
297			public function addHandlersCategory(string $catName)
298			{
299			$catArray = $this->getHandlersCategory();
300			$i=1;
301			while (isset($catArray[$i]) && $i < 100) $i++;
302			if ($i == 100) throw new ProgrammingError('Category array error');
303			$catArray[$i] = $catName;
304			$this->setHandlerCategory($catArray);
305			}
306
307			public function delHandlersCategory(int $catIndex)
308			{
309			$catArray = $this->getHandlersCategory();
310			unset($catArray[$catIndex]);
311			$this->setHandlerCategory($catArray);
312			$this->getUIDatabase()->updateHandlersOnCategoryDelete($catIndex);
313			}
314
315			public function renameHandlersCategory(int $catIndex, string $catName)
316			{
317			$catArray = $this->getHandlersCategory();
318			$catArray[$catIndex] = $catName;
319			$this->setHandlerCategory($catArray);
320			}
321
322			}
323
324

patrickpr / trapdirector

TrapsController::checkReadPermission() A last analyzed 2020-10-31 13:30 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TrapsController::checkReadPermission() A
last analyzed 2020-10-31 13:30 UTC