shinken/contactgroup.py

   1 #!/usr/bin/env python
   2 #Copyright (C) 2009-2010 :
   3 #    Gabes Jean, naparuba@gmail.com
   4 #    Gerhard Lausser, Gerhard.Lausser@consol.de
   5 #
   6 #This file is part of Shinken.
   7 #
   8 #Shinken is free software: you can redistribute it and/or modify
   9 #it under the terms of the GNU Affero General Public License as published by
  10 #the Free Software Foundation, either version 3 of the License, or
  11 #(at your option) any later version.
  12 #
  13 #Shinken is distributed in the hope that it will be useful,
  14 #but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #GNU Affero General Public License for more details.
  17 #
  18 #You should have received a copy of the GNU Affero General Public License
  19 #along with Shinken.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22 #Contactgroups are groups for contacts
  23 #They are just used for the config read and explode by elements
  24
  25 from itemgroup import Itemgroup, Itemgroups
  26 from shinken.property import UnusedProp, BoolProp, IntegerProp, FloatProp, CharProp, StringProp, ListProp
  27
  28 class Contactgroup(Itemgroup):
  29     id = 1
  30     my_type = 'contactgroup'
  31
  32     properties={
  33         'id': IntegerProp(
  34             default=0,
  35             fill_brok=['full_status']),
  36         'contactgroup_name': StringProp(
  37             fill_brok=['full_status']),
  38         'alias': StringProp(
  39             fill_brok=['full_status']),
  40         'members': StringProp(
  41             fill_brok=['full_status']),
  42         #Shinken specific
  43         'unknown_members': StringProp(
  44             default=[]),
  45         'configuration_errors' : StringProp(default = []),
  46         }
  47     macros = {
  48         'CONTACTGROUPALIAS' : 'alias',
  49         'CONTACTGROUPMEMBERS' : 'get_members'
  50         }
  51
  52
  53     def get_contacts(self):
  54         return self.members
  55
  56
  57     def get_name(self):
  58         return self.contactgroup_name
  59
  60
  61     def get_contactgroup_members(self):
  62         if self.has('contactgroup_members'):
  63             return self.contactgroup_members.split(',')
  64         else:
  65             return []
  66
  67
  68     #We fillfull properties with template ones if need
  69     #Because hostgroup we call may not have it's members
  70     #we call get_hosts_by_explosion on it
  71     def get_contacts_by_explosion(self, contactgroups):
  72         #First we tag the hg so it will not be explode
  73         #if a son of it already call it
  74         self.already_explode = True
  75
  76         #Now the recursiv part
  77         #rec_tag is set to False avery CG we explode
  78         #so if True here, it must be a loop in HG
  79         #calls... not GOOD!
  80         if self.rec_tag:
  81             print "Error : we've got a loop in contactgroup definition", self.get_name()
  82             if self.has('members'):
  83                 return self.members
  84             else:
  85                 return ''
  86         #Ok, not a loop, we tag it and continue
  87         self.rec_tag = True
  88
  89         cg_mbrs = self.get_contactgroup_members()
  90         for cg_mbr in cg_mbrs:
  91             cg = contactgroups.find_by_name(cg_mbr.strip())
  92             if cg is not None:
  93                 value = cg.get_contacts_by_explosion(contactgroups)
  94                 if value is not None:
  95                     self.add_string_member(value)
  96         if self.has('members'):
  97             return self.members
  98         else:
  99             return ''
 100
 101
 102 class Contactgroups(Itemgroups):
 103     name_property = "contactgroup_name" # is used for finding contactgroup
 104     inner_class = Contactgroup
 105
 106     def get_members_by_name(self, cgname):
 107         id = self.find_id_by_name(cgname)
 108         if id == None:
 109             return []
 110         return self.itemgroups[id].get_contacts()
 111
 112
 113     def add_contactgroup(self, cg):
 114         self.itemgroups[cg.id] = cg
 115
 116
 117     def linkify(self, contacts):
 118         self.linkify_cg_by_cont(contacts)
 119
 120
 121     #We just search for each host the id of the host
 122     #and replace the name by the id
 123     def linkify_cg_by_cont(self, contacts):
 124         for id in self.itemgroups:
 125             mbrs = self.itemgroups[id].get_contacts()
 126
 127             #The new member list, in id
 128             new_mbrs = []
 129             for mbr in mbrs:
 130                 m = contacts.find_by_name(mbr)
 131                 #Maybe the contact is missing, if so, must be put in unknown_members
 132                 if m != None:
 133                     new_mbrs.append(m)
 134                 else:
 135                     self.itemgroups[id].unknown_members.append(mbr)
 136
 137             #Make members uniq
 138             new_mbrs = list(set(new_mbrs))
 139
 140             #We find the id, we remplace the names
 141             self.itemgroups[id].replace_members(new_mbrs)
 142
 143
 144     #Add a contact string to a contact member
 145     #if the contact group do not exist, create it
 146     def add_member(self, cname, cgname):
 147         id = self.find_id_by_name(cgname)
 148         #if the id do not exist, create the cg
 149         if id == None:
 150             cg = Contactgroup({'contactgroup_name' : cgname, 'alias' : cgname, 'members' :  cname})
 151             self.add_contactgroup(cg)
 152         else:
 153             self.itemgroups[id].add_string_member(cname)
 154
 155
 156     #Use to fill members with contactgroup_members
 157     def explode(self):
 158         #We do not want a same hg to be explode again and again
 159         #so we tag it
 160         for tmp_cg in self.itemgroups.values():
 161             tmp_cg.already_explode = False
 162
 163         for cg in self.itemgroups.values():
 164             if cg.has('contactgroup_members') and not cg.already_explode:
 165                 #get_contacts_by_explosion is a recursive
 166                 #function, so we must tag hg so we do not loop
 167                 for tmp_cg in self.itemgroups.values():
 168                     tmp_cg.rec_tag = False
 169                 cg.get_contacts_by_explosion(self)
 170
 171         #We clean the tags
 172         for tmp_cg in self.itemgroups.values():
 173             if hasattr(tmp_cg, 'rec_tag'):
 174                 del tmp_cg.rec_tag
 175             del tmp_cg.already_explode