Icinga2API::getNOKService() - Code Metrics - Inspection of "fixed API usage (includes PR#54, PR#71, PR#74)" - patrickpr/trapdirector - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#78)

unknown

created 2024-11-25 13:56 UTC

Icinga2API::getNOKService() A

↳ Parent: Icinga2API

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php


namespace Icinga\Module\Trapdirector;

use Icinga\Module\Trapdirector\IcingaApi\IcingaApiBase;
use RuntimeException;
use Exception;

class Icinga2API extends IcingaApiBase
{
    
    /**
     * Creates Icinga2API object
     * 
     * @param string $host host name or IP
     * @param number $port API port
     */
    public function __construct($host, $port = 5665)
    {
        parent::__construct($host,$port);
    }
    /**

/************ Host query ************/  

    /**
     * return array of host by filter
     * @param string $hostfilter
     * @throws Exception
     * @return array objects : array('__name','name','display_name','id' (=__name), 'address', 'ip4' (=address), 'address6', 'ip6' (=address6)
     */
    public function getHostByFilter(string $hostfilter)
    {
        $hosts = $this->standardQuery(
            'host',
            $hostfilter,
            //'match("*' . $ip . '*",host.address) || match("*' . $ip . '*",host.address6) || match("*' . $ip . '*",host.name) || match("*' . $ip . '*",host.display_name)',
            array('__name','name','display_name','address','address6')
            );
        foreach ( array_keys($hosts) as $key )
        {
            $hosts[$key]->id = $hosts[$key]->__name;
            $hosts[$key]->ip4 = $hosts[$key]->address;
            $hosts[$key]->ip6 = $hosts[$key]->address6;
        }
        return $hosts;
    }
    
    /**
     * return array of host by IP (4 or 6)
     * @param string $ip
     * @throws Exception
     * @return array objects : array('__name','name','display_name')
     */
    public function getHostByIP(string $ip) 
    {
        return $this->getHostByFilter('match("*' . $ip . '*",host.address) || match("*' . $ip . '*",host.address6)');
    }

    
    /**
     * Get host(s) by name in API
     * @param string $name
     * @return array|NULL[] : see getHostByIP
     */
    public function getHostByName(string $name)
    {
        return $this->getHostByFilter('match("*' . $name . '*",host.name) || match("*' . $name . '*",host.display_name)');
    }

    /**
     * Get host(s) by name in API
     * @param string $name
     * @return array|NULL[] : see getHostByIP
     */
    public function getHostByNameOrIP(string $name)
    {
        return $this->getHostByFilter( 
            'match("*' . $name . '*",host.name) || match("*' . $name . '*",host.display_name) || match("*' . $name . '*",host.address) || match("*' . $name . '*",host.address6)');
    }
    
    public function getHostInfoByID(string $name)
    {
        $host = $this->getHostByFilter(
            'host.__name=="'. $name .'"');
        if (isset($host[0]))
            return $host[0];
        else
            return NULL;
    }
 
    /**
     * Get all host and IP from hostgroup
     * @param string $hostGroup
     * @throws Exception
     * @return array : attributes : address, address6, name
     */
    public function getHostsIPByHostGroup($hostGroup)
    {        
        return $this->standardQuery(
            'host', 
            '"' . $hostGroup . '" in host.groups',
            array('address','address6','name')
                
        );
    }


    /** Get services from host in API
     *	
     *  @throws Exception
     *	@param $id string host name
     *  @param bool $active
     *  @param bool $passive_svc
     *	@return array display_name (of service), service_object_id
     */
    public function getServicesByHostid(string $id, bool $active = TRUE, bool $passive_svc = TRUE)
    {
        $filter = 'match("' . $id . '!*", service.__name)';
        if ($active === TRUE)
        {
            $filter .= ' && service.active==true';
        }
        if ($passive_svc === TRUE)
        {
            $filter .= ' && service.enable_passive_checks==true';
        }
        $services =  $this->standardQuery(
            'service',
            $filter,
            array('__name','name','display_name','active')
            );
        
        foreach ( array_keys($services) as $key )
        {
            $services[$key]->id = $services[$key]->__name;
        }
        
        return $services;
        
    }

/************  Host group query ************/    
    /**
     * return array of host by IP (4 or 6) or name
     * @param string $group Host group name
     * @throws Exception
     * @return array objects : array('name','display_name')
     */
    public function getHostsByGroup(string $group)
    {
         return $this->standardQuery(
            'host',
            '"' . $group . '" in host.groups',
            array('name','display_name')
            );
    }
    
    public function getServicesByHostGroupid(string $group)
    {
        $hostList = $this->getHostsByGroup($group);
        //return $hostList;
        $hostNum = count($hostList);
        $serviceList=array();
        foreach ($hostList as $curHost)
        {
            $services = $this->getServicesByHostid($curHost->name);
            foreach ($services as $service)
            {
                //return $service;
                if (! isset($serviceList[$service->name]))
                {
                    $serviceList[$service->name]=
                        array('num'=> 1 ,'__name' => $service->__name,'display_name' => $service->display_name);
                }
                else
                {
                    $serviceList[$service->name]['num']++;
                }
            }
        }
        $commonServices=array();
        foreach ($serviceList as $key => $values)
        {
            if ($values['num'] >= $hostNum)
            {
                array_push($commonServices,array($key,$values['display_name']));
            }
        }
        return $commonServices;
    }
 
    /**
     * Get all host and IP from hostgroup
     * @param string $hostGroup
     * @throws Exception
     * @return array : attributes : address, address6, name
     */
    public function getHostGroupByName($name)
    {
        $hosts = $this->standardQuery(
            'hostgroup',
            'match("*' . $name . '*",hostgroup.name)',
            array('__name','name','display_name')
            
            );
        foreach ( array_keys($hosts) as $key )
        {
            $hosts[$key]->id = $hosts[$key]->__name;
        }
        return $hosts;
    }
    
    /**
     * Get hostgroup by id (__name)
     * @param string $hostGroup
     * @throws Exception
     * @return array : __name, name, display_name
     */
    public function getHostGroupById($name)
    {
        $hosts = $this->standardQuery(
            'hostgroup',
            'hostgroup.__name=="'. $name .'"',
            array('__name','name','display_name')
            
            );
        $hosts[0]->id = $hosts[0]->__name;
        return $hosts[0];
    }
    
/****************   Service queries ************/
    /** Get services object id by host name / service name
     *	does not catch exceptions
     *	@param $hostname string host name
     *	@param $name string service name
     *  @param bool $active : if true, return only active service
     *  @param bool $passive_svc : if true, return only service accepting passive checks
     *	@return array  service id
     */
    public function getServiceIDByName($hostname,$name,bool $active = TRUE, bool $passive_svc = TRUE)
    {
        $filter = 'service.__name=="' . $hostname . '!'. $name .'"';
        if ($active === TRUE)
        {
            $filter .= ' && service.active==true';
        }
        if ($passive_svc === TRUE)
        {
            $filter .= ' && service.enable_passive_checks==true';
        }
        $services =  $this->standardQuery(
            'service',
            $filter,
            array('__name','name','display_name','active','enable_passive_checks')
            );
        
        foreach ( array_keys($services) as $key )
        {
            $services[$key]->id = $services[$key]->__name;
        }
        
        return $services;
    }
 
    /** Get services object by id (host!name)
     *	does not catch exceptions
     *	@param $name string service __name (host!name)
     *	@return array  service id
     */
    public function getServiceById($name)
    {
        $filter = 'service.__name=="' .  $name .'"';
        $services =  $this->standardQuery(
            'service',
            $filter,
            array('__name','name','display_name','active','enable_passive_checks')
            );
        
        foreach ( array_keys($services) as $key )
        {
            $services[$key]->id = $services[$key]->__name;
        }
        
        return $services;
    }

    /** Get services object by id (host!name)
     *	does not catch exceptions
     *	@param $name string service __name (host!name)
     *	@return array  service id
     */
    public function getNOKService()
    {
        $filter = 'service.state != ServiceOK && !(service.acknowledgement || service.downtime_depth || service.host.downtime_depth)';
        $services =  $this->standardQuery(
            'service',
            $filter,
            array('__name','name','last_check','host_name','state')
            );
        
        foreach ( array_keys($services) as $key )
        {
            $services[$key]->id = $services[$key]->__name;
        }
        
        return $services;
    }
    
    
}



1			<?php
2
3
4			namespace Icinga\Module\Trapdirector;
5
6			use Icinga\Module\Trapdirector\IcingaApi\IcingaApiBase;
7			use RuntimeException;
8			use Exception;
9
10			class Icinga2API extends IcingaApiBase
11			{
12
13			/**
14			* Creates Icinga2API object
15			*
16			* @param string $host host name or IP
17			* @param number $port API port
18			*/
19			public function __construct($host, $port = 5665)
20			{
21			parent::__construct($host,$port);
22			}
23			/**
24
25			/********** Host query **********/
26
27			/**
28			* return array of host by filter
29			* @param string $hostfilter
30			* @throws Exception
31			* @return array objects : array('__name','name','display_name','id' (=__name), 'address', 'ip4' (=address), 'address6', 'ip6' (=address6)
32			*/
33			public function getHostByFilter(string $hostfilter)
34			{
35			$hosts = $this->standardQuery(
36			'host',
37			$hostfilter,
38			//'match("' . $ip . '",host.address) \|\| match("' . $ip . '",host.address6) \|\| match("' . $ip . '",host.name) \|\| match("' . $ip . '",host.display_name)',
39			array('__name','name','display_name','address','address6')
40			);
41			foreach ( array_keys($hosts) as $key )
42			{
43			$hosts[$key]->id = $hosts[$key]->__name;
44			$hosts[$key]->ip4 = $hosts[$key]->address;
45			$hosts[$key]->ip6 = $hosts[$key]->address6;
46			}
47			return $hosts;
48			}
49
50			/**
51			* return array of host by IP (4 or 6)
52			* @param string $ip
53			* @throws Exception
54			* @return array objects : array('__name','name','display_name')
55			*/
56			public function getHostByIP(string $ip)
57			{
58			return $this->getHostByFilter('match("' . $ip . '",host.address) \|\| match("' . $ip . '",host.address6)');
59			}
60
61
62			/**
63			* Get host(s) by name in API
64			* @param string $name
65			* @return array\|NULL[] : see getHostByIP
66			*/
67			public function getHostByName(string $name)
68			{
69			return $this->getHostByFilter('match("' . $name . '",host.name) \|\| match("' . $name . '",host.display_name)');
70			}
71
72			/**
73			* Get host(s) by name in API
74			* @param string $name
75			* @return array\|NULL[] : see getHostByIP
76			*/
77			public function getHostByNameOrIP(string $name)
78			{
79			return $this->getHostByFilter(
80			'match("' . $name . '",host.name) \|\| match("' . $name . '",host.display_name) \|\| match("' . $name . '",host.address) \|\| match("' . $name . '",host.address6)');
81			}
82
83			public function getHostInfoByID(string $name)
84			{
85			$host = $this->getHostByFilter(
86			'host.__name=="'. $name .'"');
87			if (isset($host[0]))
88			return $host[0];
89			else
90			return NULL;
91			}
92
93			/**
94			* Get all host and IP from hostgroup
95			* @param string $hostGroup
96			* @throws Exception
97			* @return array : attributes : address, address6, name
98			*/
99			public function getHostsIPByHostGroup($hostGroup)
100			{
101			return $this->standardQuery(
102			'host',
103			'"' . $hostGroup . '" in host.groups',
104			array('address','address6','name')
105
106			);
107			}
108
109
110			/** Get services from host in API
111			*
112			* @throws Exception
113			* @param $id string host name
114			* @param bool $active
115			* @param bool $passive_svc
116			* @return array display_name (of service), service_object_id
117			*/
118			public function getServicesByHostid(string $id, bool $active = TRUE, bool $passive_svc = TRUE)
119			{
120			$filter = 'match("' . $id . '!*", service.__name)';
121			if ($active === TRUE)
122			{
123			$filter .= ' && service.active==true';
124			}
125			if ($passive_svc === TRUE)
126			{
127			$filter .= ' && service.enable_passive_checks==true';
128			}
129			$services = $this->standardQuery(
130			'service',
131			$filter,
132			array('__name','name','display_name','active')
133			);
134
135			foreach ( array_keys($services) as $key )
136			{
137			$services[$key]->id = $services[$key]->__name;
138			}
139
140			return $services;
141
142			}
143
144			/********** Host group query **********/
145			/**
146			* return array of host by IP (4 or 6) or name
147			* @param string $group Host group name
148			* @throws Exception
149			* @return array objects : array('name','display_name')
150			*/
151			public function getHostsByGroup(string $group)
152			{
153			return $this->standardQuery(
154			'host',
155			'"' . $group . '" in host.groups',
156			array('name','display_name')
157			);
158			}
159
160			public function getServicesByHostGroupid(string $group)
161			{
162			$hostList = $this->getHostsByGroup($group);
163			//return $hostList;
164			$hostNum = count($hostList);
165			$serviceList=array();
166			foreach ($hostList as $curHost)
167			{
168			$services = $this->getServicesByHostid($curHost->name);
169			foreach ($services as $service)
170			{
171			//return $service;
172			if (! isset($serviceList[$service->name]))
173			{
174			$serviceList[$service->name]=
175			array('num'=> 1 ,'__name' => $service->__name,'display_name' => $service->display_name);
176			}
177			else
178			{
179			$serviceList[$service->name]['num']++;
180			}
181			}
182			}
183			$commonServices=array();
184			foreach ($serviceList as $key => $values)
185			{
186			if ($values['num'] >= $hostNum)
187			{
188			array_push($commonServices,array($key,$values['display_name']));
189			}
190			}
191			return $commonServices;
192			}
193
194			/**
195			* Get all host and IP from hostgroup
196			* @param string $hostGroup
197			* @throws Exception
198			* @return array : attributes : address, address6, name
199			*/
200			public function getHostGroupByName($name)
201			{
202			$hosts = $this->standardQuery(
203			'hostgroup',
204			'match("' . $name . '",hostgroup.name)',
205			array('__name','name','display_name')
206
207			);
208			foreach ( array_keys($hosts) as $key )
209			{
210			$hosts[$key]->id = $hosts[$key]->__name;
211			}
212			return $hosts;
213			}
214
215			/**
216			* Get hostgroup by id (__name)
217			* @param string $hostGroup
218			* @throws Exception
219			* @return array : __name, name, display_name
220			*/
221			public function getHostGroupById($name)
222			{
223			$hosts = $this->standardQuery(
224			'hostgroup',
225			'hostgroup.__name=="'. $name .'"',
226			array('__name','name','display_name')
227
228			);
229			$hosts[0]->id = $hosts[0]->__name;
230			return $hosts[0];
231			}
232
233			/************** Service queries **********/
234			/** Get services object id by host name / service name
235			* does not catch exceptions
236			* @param $hostname string host name
237			* @param $name string service name
238			* @param bool $active : if true, return only active service
239			* @param bool $passive_svc : if true, return only service accepting passive checks
240			* @return array service id
241			*/
242			public function getServiceIDByName($hostname,$name,bool $active = TRUE, bool $passive_svc = TRUE)
243			{
244			$filter = 'service.__name=="' . $hostname . '!'. $name .'"';
245			if ($active === TRUE)
246			{
247			$filter .= ' && service.active==true';
248			}
249			if ($passive_svc === TRUE)
250			{
251			$filter .= ' && service.enable_passive_checks==true';
252			}
253			$services = $this->standardQuery(
254			'service',
255			$filter,
256			array('__name','name','display_name','active','enable_passive_checks')
257			);
258
259			foreach ( array_keys($services) as $key )
260			{
261			$services[$key]->id = $services[$key]->__name;
262			}
263
264			return $services;
265			}
266
267			/** Get services object by id (host!name)
268			* does not catch exceptions
269			* @param $name string service __name (host!name)
270			* @return array service id
271			*/
272			public function getServiceById($name)
273			{
274			$filter = 'service.__name=="' . $name .'"';
275			$services = $this->standardQuery(
276			'service',
277			$filter,
278			array('__name','name','display_name','active','enable_passive_checks')
279			);
280
281			foreach ( array_keys($services) as $key )
282			{
283			$services[$key]->id = $services[$key]->__name;
284			}
285
286			return $services;
287			}
288
289			/** Get services object by id (host!name)
290			* does not catch exceptions
291			* @param $name string service __name (host!name)
292			* @return array service id
293			*/
294			public function getNOKService()
295			{
296			$filter = 'service.state != ServiceOK && !(service.acknowledgement \|\| service.downtime_depth \|\| service.host.downtime_depth)';
297			$services = $this->standardQuery(
298			'service',
299			$filter,
300			array('__name','name','last_check','host_name','state')
301			);
302
303			foreach ( array_keys($services) as $key )
304			{
305			$services[$key]->id = $services[$key]->__name;
306			}
307
308			return $services;
309			}
310
311
312			}
313
314

patrickpr / trapdirector

Pull Request — master (#78)

Icinga2API::getNOKService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like