#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (C) 2009-2014:
# Gabes Jean, naparuba@gmail.com
# Gerhard Lausser, Gerhard.Lausser@consol.de
# Gregory Starck, g.starck@gmail.com
# Hartmut Goebel, h.goebel@goebel-consult.de
#
# This file is part of Shinken.
#
# Shinken is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Shinken is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with Shinken. If not, see <http://www.gnu.org/licenses/>.
from itemgroup import Itemgroup, Itemgroups
from shinken.util import get_obj_name
from shinken.property import StringProp, IntegerProp
from shinken.log import logger
[docs]class Hostgroup(Itemgroup):
id = 1 # zero is always a little bit special... like in database
my_type = 'hostgroup'
properties = Itemgroup.properties.copy()
properties.update({
'id': IntegerProp(default=0, fill_brok=['full_status']),
'hostgroup_name': StringProp(fill_brok=['full_status']),
'alias': StringProp(fill_brok=['full_status']),
'notes': StringProp(default='', fill_brok=['full_status']),
'notes_url': StringProp(default='', fill_brok=['full_status']),
'action_url': StringProp(default='', fill_brok=['full_status']),
'realm': StringProp(default='', fill_brok=['full_status'], conf_send_preparation=get_obj_name),
})
macros = {
'HOSTGROUPALIAS': 'alias',
'HOSTGROUPMEMBERS': 'members',
'HOSTGROUPNOTES': 'notes',
'HOSTGROUPNOTESURL': 'notes_url',
'HOSTGROUPACTIONURL': 'action_url'
}
[docs] def get_name(self):
return self.hostgroup_name
[docs] def get_hosts(self):
if getattr(self, 'members', None) is not None:
return self.members
else:
return []
[docs] def get_hostgroup_members(self):
if self.has('hostgroup_members'):
return [m.strip() for m in self.hostgroup_members.split(',')]
else:
return []
# We fillfull properties with template ones if need
# Because hostgroup we call may not have it's members
# we call get_hosts_by_explosion on it
[docs] def get_hosts_by_explosion(self, hostgroups):
# First we tag the hg so it will not be explode
# if a son of it already call it
self.already_explode = True
# Now the recursive part
# rec_tag is set to False every HG we explode
# so if True here, it must be a loop in HG
# calls... not GOOD!
if self.rec_tag:
logger.error("[hostgroup::%s] got a loop in hostgroup definition", self.get_name())
return self.get_hosts()
# Ok, not a loop, we tag it and continue
self.rec_tag = True
hg_mbrs = self.get_hostgroup_members()
for hg_mbr in hg_mbrs:
hg = hostgroups.find_by_name(hg_mbr.strip())
if hg is not None:
value = hg.get_hosts_by_explosion(hostgroups)
if value is not None:
self.add_string_member(value)
return self.get_hosts()
[docs]class Hostgroups(Itemgroups):
name_property = "hostgroup_name" # is used for finding hostgroups
inner_class = Hostgroup
[docs] def get_members_by_name(self, hgname):
hg = self.find_by_name(hgname)
if hg is None:
return []
return hg.get_hosts()
[docs] def linkify(self, hosts=None, realms=None):
self.linkify_hg_by_hst(hosts)
self.linkify_hg_by_realms(realms)
# We just search for each hostgroup the id of the hosts
# and replace the name by the id
[docs] def linkify_hg_by_hst(self, hosts):
for hg in self:
mbrs = hg.get_hosts()
# The new member list, in id
new_mbrs = []
for mbr in mbrs:
if mbr == '*':
new_mbrs.extend(hosts)
else:
h = hosts.find_by_name(mbr.strip())
if h is not None:
new_mbrs.append(h)
else:
hg.add_string_unknown_member(mbr)
# Make members uniq
new_mbrs = list(set(new_mbrs))
# We find the id, we replace the names
hg.replace_members(new_mbrs)
# Now register us in our members
for h in hg.members:
h.hostgroups.append(hg)
# and be sure we are uniq in it
h.hostgroups = list(set(h.hostgroups))
# More than an explode function, but we need to already
# have members so... Will be really linkify just after
# And we explode realm in ours members, but do not override
# a host realm value if it's already set
[docs] def linkify_hg_by_realms(self, realms):
# Now we explode the realm value if we've got one
# The group realm must not override a host one (warning?)
for hg in self:
if not hasattr(hg, 'realm'):
continue
# Maybe the value is void?
if not hg.realm.strip():
continue
r = realms.find_by_name(hg.realm.strip())
if r is not None:
hg.realm = r
logger.debug("[hostgroups] %s is in %s realm", hg.get_name(), r.get_name())
else:
err = "the hostgroup %s got an unknown realm '%s'" % (hg.get_name(), hg.realm)
hg.configuration_errors.append(err)
hg.realm = None
continue
for h in hg:
if h is None:
continue
if h.realm is None or h.got_default_realm: # default value not hasattr(h, 'realm'):
logger.debug("[hostgroups] apply a realm %s to host %s from a hostgroup rule (%s)", \
hg.realm.get_name(), h.get_name(), hg.get_name())
h.realm = hg.realm
else:
if h.realm != hg.realm:
logger.warning("[hostgroups] host %s it not in the same realm than it's hostgroup %s", \
h.get_name(), hg.get_name())
# Add a host string to a hostgroup member
# if the host group do not exist, create it
[docs] def add_member(self, hname, hgname):
hg = self.find_by_name(hgname)
# if the id do not exist, create the hg
if hg is None:
hg = Hostgroup({'hostgroup_name': hgname, 'alias': hgname, 'members': hname})
self.add(hg)
else:
hg.add_string_member(hname)
# Use to fill members with hostgroup_members
[docs] def explode(self):
# We do not want a same hg to be explode again and again
# so we tag it
for tmp_hg in self.items.values():
tmp_hg.already_explode = False
for hg in self.items.values():
if hg.has('hostgroup_members') and not hg.already_explode:
# get_hosts_by_explosion is a recursive
# function, so we must tag hg so we do not loop
for tmp_hg in self.items.values():
tmp_hg.rec_tag = False
hg.get_hosts_by_explosion(self)
# We clean the tags
for tmp_hg in self.items.values():
if hasattr(tmp_hg, 'rec_tag'):
del tmp_hg.rec_tag
del tmp_hg.already_explode