shinken/property.py

   1 # -*- mode: python ; coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2010:
   4 #    Hartmut Goebel, h.goebel@goebel-consult.de
   5 #    Gabes Jean, naparuba@gmail.com
   6 #    Gerhard Lausser, Gerhard.Lausser@consol.de
   7 #    Gregory Starck, g.starck@gmail.com
   8 #
   9 # This file is part of Shinken.
  10 #
  11 # Shinken is free software: you can redistribute it and/or modify
  12 # it under the terms of the GNU Affero General Public License as published by
  13 # the Free Software Foundation, either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # Shinken is distributed in the hope that it will be useful,
  17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 # GNU Affero General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU Affero General Public License
  22 # along with Shinken.  If not, see <http://www.gnu.org/licenses/>.
  23 """
  24 """
  25
  26 from shinken.util import to_bool, to_float, to_split, to_char, to_int
  27
  28 __author__ = "Hartmut Goebel <h.goebel@goebel-consult.de>"
  29 __copyright__ = "Copyright 2010 by Hartmut Goebel <h.goebel@goebel-consult.de>"
  30 __licence__ = "GNU Affero General Public License version 3 (AGPL v3)"
  31
  32
  33 FULL_STATUS = 'full_status'
  34 CHECK_RESULT = 'check_result'
  35
  36
  37 class Property(object):
  38     """
  39     Baseclass of all properties.
  40
  41     Same semantic for all subclasses (except UnusedProp): The property
  42     is required if, and only if, the default value is `None`.
  43
  44
  45     """
  46     def __init__(self, default='ididnotsetdefault', class_inherit=[],
  47                  unmanaged=False, help='', no_slots=False,
  48                  fill_brok=[], conf_send_preparation=None,
  49                  brok_transformation=None,retention=False,to_send=False,
  50                  override=False,managed=True):
  51         """
  52         `default`: default value to be used if this property is not set.
  53                    If default is None, this property is requied.
  54
  55         `class_inherit`: List of 2-tuples, (Service, 'blabla') : must
  56                    set this property to the Service class with name
  57                    blabla. if (Service, None): must set this property
  58                    to the Service class with same name
  59         `unmanaged`: ....
  60         `help`: usage text
  61         `no_slots`: do not take this property for __slots__
  62
  63         `fill_brok`: if set, send to broker. There are two categories:
  64                      FULL_STATUS for initial and update status,
  65                      CHECK_RESULT for check results
  66
  67         Only for the inital call:
  68
  69         conf_send_preparation: if set, will pass the property to this
  70                      function. It's used to 'flatten' some dangerous
  71                      properties like realms that are too 'linked' to
  72                      be send like that.
  73
  74         brok_transformation: if set, will call the function with the
  75                      value of the property the major times it will be
  76                      to flatten the data (like realm_name instead of
  77                      the realm object).
  78
  79         override : for scheduler, if the property must override the
  80                      value of the configuration we send
  81
  82         managed : property that is managed in Nagios but not in Shinken
  83
  84         """
  85         self.default = default
  86         self.has_default = (default != 'ididnotsetdefault')
  87         self.required = default is 'ididnotsetdefault'
  88         self.class_inherit = class_inherit
  89         self.help = help or ''
  90         self.unmanaged = unmanaged
  91         self.no_slots = no_slots
  92         self.fill_brok = fill_brok
  93         self.conf_send_preparation = conf_send_preparation
  94         self.brok_transformation = brok_transformation
  95         self.retention = retention
  96         self.to_send = to_send
  97         self.override = override
  98         self.managed = managed
  99         self.unused = False
 100
 101
 102 class UnusedProp(Property):
 103     """
 104     A unused Property. These are typically used by Nagios but
 105     no longer usefull/used by Shinken.
 106
 107     This is just to warn the user that the option he use is no more used
 108     in Shinken.
 109     """
 110     def __init__(self, text=None):
 111         """
 112         Since this property is not used, there is no use for other
 113         parameters than `text`.
 114
 115         `text` a some usage text if present, will print it to explain
 116         why it's no more useful
 117         """
 118         if text is None:
 119             text = ("This parameter is no longer useful in the "
 120                     "Shinken architecture.")
 121         self.text = text
 122         self.has_default = False
 123         self.class_inherit = []
 124         self.unused = True
 125         self.managed = True
 126
 127
 128 _boolean_states = {'1': True, 'yes': True, 'true': True, 'on': True,
 129                    '0': False, 'no': False, 'false': False, 'off': False}
 130
 131
 132 class BoolProp(Property):
 133     """
 134     A Boolean Property.
 135
 136     Boolean values are currently case insensitively defined as 0,
 137     false, no, off for False, and 1, true, yes, on for True).
 138     """
 139 #    @staticmethod
 140     def pythonize(self, val):
 141         return _boolean_states[val.lower()]
 142
 143
 144 class IntegerProp(Property):
 145 #    @staticmethod
 146     def pythonize(self, val):
 147         return to_int(val)
 148
 149
 150 class FloatProp(Property):
 151 #    @staticmethod
 152     def pythonize(self, val):
 153         return to_float(val)
 154
 155
 156 class CharProp(Property):
 157 #    @staticmethod
 158     def pythonize(self, val):
 159         return to_char(val)
 160
 161
 162 class StringProp(Property):
 163 #    @staticmethod
 164     def pythonize(self, val):
 165         return val
 166
 167
 168 class ListProp(Property):
 169 #    @staticmethod
 170     def pythonize(self, val):
 171         return to_split(val)