None and [] are both possible
[tiramisu.git] / option.py
1 # -*- coding: utf-8 -*-
2 "option types and option description for the configuration management"
3 # Copyright (C) 2012 Team tiramisu (see README for all contributors)
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18 #
19 # The original `Config` design model is unproudly borrowed from 
20 # the rough pypy's guys: http://codespeak.net/svn/pypy/dist/pypy/config/
21 # the whole pypy projet is under MIT licence
22 # ____________________________________________________________
23 from autolib import special_owners
24 from basetype import HiddenBaseType, DisabledBaseType, ModeBaseType, modes
25 from error import (ConfigError, ConflictConfigError, NotFoundError, 
26                    SpecialOwnersError, RequiresError)
27 available_actions = ['hide', 'show', 'enable', 'disable'] 
28 reverse_actions = {'hide': 'show', 'show': 'hide', 
29                    'disable':'enable', 'enable': 'disable'}
30 # ____________________________________________________________
31 # OptionDescription authorized group_type values
32 group_types = ['default', 'family', 'group', 'master']
33 # ____________________________________________________________
34 class Option(HiddenBaseType, DisabledBaseType, ModeBaseType):
35     #reminder: an Option object is **not** a container for the value
36     _frozen = False
37     def __init__(self, name, doc, default=None, default_multi=None, 
38                  requires=None, mandatory=False, multi=False, callback=None, 
39                  callback_params=None, mode='normal'):
40         self._name = name
41         self.doc = doc
42         self._requires = requires
43         self._mandatory = mandatory
44         self.multi = multi
45         if not self.multi and default_multi is not None:
46             raise ConfigError("a default_multi is set whereas multi is False"
47                   " in option: {0}".format(name)) 
48         self.default_multi = default_multi
49         #if self.multi and default_multi is None:
50             # _cfgimpl_warnings[name] = DefaultMultiWarning   
51         self.callback = callback
52         if self.callback is None and callback_params is not None:
53             raise ConfigError("params defined for a callback function but"
54             " no callback defined yet for option {0}".format(name)) 
55         self.callback_params = callback_params
56         if mode not in modes:
57             raise ConfigError("mode {0} not available".format(mode))
58         self.mode = mode
59         _default = default
60         if default != None:
61             if self.multi == True and type(default) != list:
62                 raise ConfigError("invalid default value {0} "
63                 "for option {1} : not list type".format(str(default), name))
64             if not self.validate(_default):
65                 raise ConfigError("invalid default value {0} " 
66                                          "for option {1}".format(str(default), name))
67         self.default = _default
68         
69     def validate(self, value):
70         if self.multi == False:
71             # None allows the reset of the value
72             if value != None:
73                 return self._validate(value)
74         else:
75             if type(value) != list:
76                 raise ConfigError("invalid value {0} " 
77                         "for option {1} which must be a list".format(value,
78                         self._name))
79             for val in value:
80                 if val != None:
81                     # None allows the reset of the value
82                     return self._validate(val)
83         return True
84
85     def getdefault(self):
86         return self.default
87
88     def getdoc(self):
89         return self.doc
90
91     def getcallback(self):
92         return self.callback
93
94     def getcallback_params(self):
95         return self.callback_params
96
97     def setowner(self, config, owner):
98         # owner is a **real* owner, a list is actually allowable here
99         name = self._name
100         if self._frozen:
101             raise TypeError("trying to change a frozen option's owner: %s" % name)
102         if owner in special_owners:
103             if self.callback == None:
104                 raise SpecialOwnersError("no callback specified for" 
105                                                       "option {0}".format(name))
106         if self.is_multi():
107             if not type(owner) == list:
108                 raise ConfigError("invalid owner for multi "
109                     "option: {0}".format(self._name))
110         config._cfgimpl_value_owners[name] = owner
111
112     def setoption(self, config, value, who):
113         "who is **not necessarily** a owner because it cannot be a list"
114         name = self._name
115         if self._frozen:
116             raise TypeError('trying to change a frozen option object: %s' % name)
117         # we want the possibility to reset everything
118         if who == "default" and value is None:
119             self.default = None
120             return
121         if not self.validate(value):
122             raise ConfigError('invalid value %s for option %s' % (value, name))
123         if who == "default":
124             # changes the default value (and therefore resets the previous value)
125             if self._validate(value):
126                 self.default = value
127             else:
128                 raise ConfigError("invalid value %s for option %s" % (value, name))
129         apply_requires(self, config)
130         # FIXME put the validation for the multi somewhere else
131 #            # it is a multi **and** it has requires
132 #            if self.multi == True:
133 #                if type(value) != list:
134 #                    raise TypeError("value {0} must be a list".format(value))
135 #                if self._requires is not None:
136 #                    for reqname in self._requires:
137 #                        # FIXME : verify that the slaves are all multi
138 #                        #option = getattr(config._cfgimpl_descr, reqname)
139 #    #                    if not option.multi == True:
140 #    #                        raise ConflictConfigError("an option with requires "
141 #    #                         "has to be a list type : {0}".format(name)) 
142 #                        if len(config._cfgimpl_values[reqname]) != len(value):
143 #                            raise ConflictConfigError("an option with requires "
144 #                             "has not the same length of the others " 
145 #                             "in the group : {0}".format(reqname)) 
146         config._cfgimpl_previous_values[name] = config._cfgimpl_values[name] 
147         config._cfgimpl_values[name] = value
148
149     def getkey(self, value):
150         return value
151
152     def freeze(self):
153         self._frozen = True
154         return True
155
156     def unfreeze(self):
157         self._frozen = False
158     # ____________________________________________________________
159     def is_multi(self):
160         return self.multi
161
162     def is_mandatory(self):
163         return self._mandatory
164         
165 class ChoiceOption(Option):
166     opt_type = 'string'
167     
168     def __init__(self, name, doc, values, default=None, requires=None,
169                  callback=None, callback_params=None, multi=False, 
170                                                            mandatory=False):
171         self.values = values
172         super(ChoiceOption, self).__init__(name, doc, default=default,
173                            callback=callback, callback_params=callback_params, 
174                            requires=requires, multi=multi, mandatory=mandatory)
175
176     def setoption(self, config, value, who):
177         name = self._name
178         super(ChoiceOption, self).setoption(config, value, who)
179
180     def _validate(self, value):
181         return value is None or value in self.values
182
183 class BoolOption(Option):
184     opt_type = 'bool'
185     
186 #    def __init__(self, name, doc, default=None, requires=None,
187 #                                  validator=None, multi=False, mandatory=False):
188 #        super(BoolOption, self).__init__(name, doc, default=default, 
189 #                            requires=requires, multi=multi, mandatory=mandatory)
190         #self._validator = validator
191
192     def _validate(self, value):
193         return isinstance(value, bool)
194
195 # FIXME config level validator             
196 #    def setoption(self, config, value, who):
197 #        name = self._name
198 #        if value and self._validator is not None:
199 #            toplevel = config._cfgimpl_get_toplevel()
200 #            self._validator(toplevel)
201 #        super(BoolOption, self).setoption(config, value, who)
202
203 class IntOption(Option):
204     opt_type = 'int'
205     
206     def _validate(self, value):
207         try:
208             int(value)
209         except TypeError:
210             return False
211         return True
212                             
213     def setoption(self, config, value, who):
214         try:
215             super(IntOption, self).setoption(config, value, who)
216         except TypeError, e:
217             raise ConfigError(*e.args)
218
219 class FloatOption(Option):
220     opt_type = 'float'
221
222     def _validate(self, value):
223         try:
224             float(value)
225         except TypeError:
226             return False
227         return True
228
229     def setoption(self, config, value, who):
230         try:
231             super(FloatOption, self).setoption(config, float(value), who)
232         except TypeError, e:
233             raise ConfigError(*e.args)
234
235 class StrOption(Option):
236     opt_type = 'string'
237     
238     def _validate(self, value):
239         return isinstance(value, str)
240                                      
241     def setoption(self, config, value, who):
242         try:
243             super(StrOption, self).setoption(config, value, who)
244         except TypeError, e:
245             raise ConfigError(*e.args)
246
247 class SymLinkOption(object): #(HiddenBaseType, DisabledBaseType):
248     opt_type = 'symlink'
249     
250     def __init__(self, name, path):
251         self._name = name
252         self.path = path 
253     
254     def setoption(self, config, value, who):
255         try:
256             setattr(config, self.path, value) # .setoption(self.path, value, who)
257         except TypeError, e:
258             raise ConfigError(*e.args)
259
260 class IPOption(Option):
261     opt_type = 'ip'
262     
263     def _validate(self, value):
264         # by now the validation is nothing but a string, use IPy instead
265         return isinstance(value, str)
266                                      
267     def setoption(self, config, value, who):
268         try:
269             super(IPOption, self).setoption(config, value, who)
270         except TypeError, e:
271             raise ConfigError(*e.args)
272
273 class NetmaskOption(Option):
274     opt_type = 'netmask'
275     
276     def _validate(self, value):
277         # by now the validation is nothing but a string, use IPy instead
278         return isinstance(value, str)
279                                      
280     def setoption(self, config, value, who):
281         try:
282             super(NetmaskOption, self).setoption(config, value, who)
283         except TypeError, e:
284             raise ConfigError(*e.args)
285
286 class ArbitraryOption(Option):
287     def __init__(self, name, doc, default=None, defaultfactory=None, 
288                                    requires=None, multi=False, mandatory=False):
289         super(ArbitraryOption, self).__init__(name, doc, requires=requires,
290                                                multi=multi, mandatory=mandatory)
291         self.defaultfactory = defaultfactory
292         if defaultfactory is not None:
293             assert default is None
294
295     def _validate(self, value):
296         return True
297
298     def getdefault(self):
299         if self.defaultfactory is not None:
300             return self.defaultfactory()
301         return self.default
302
303 class OptionDescription(HiddenBaseType, DisabledBaseType, ModeBaseType):
304     group_type = 'default'
305     
306     def __init__(self, name, doc, children, requires=None):
307         self._name = name
308         self.doc = doc
309         self._children = children
310         self._requires = requires
311         self._build()
312     
313     def getdoc(self):
314         return self.doc
315
316     def _build(self):
317         for child in self._children:
318             setattr(self, child._name, child)
319
320     def add_child(self, child):
321         "dynamically adds a configuration option"
322         #Nothing is static. Even the Mona Lisa is falling apart.
323         for ch in self._children:
324             if isinstance(ch, Option):
325                 if child._name == ch._name:
326                     raise ConflictConfigError("existing option : {0}".format(
327                                                                    child._name))
328         self._children.append(child)
329         setattr(self, child._name, child)
330     
331     def update_child(self, child):
332         "modification of an existing option"
333         # XXX : corresponds to the `redefine`, is it usefull 
334         pass
335         
336     def getkey(self, config):
337         return tuple([child.getkey(getattr(config, child._name))
338                       for child in self._children])
339
340     def getpaths(self, include_groups=False, currpath=None):
341         """returns a list of all paths in self, recursively
342            currpath should not be provided (helps with recursion)
343         """
344         if currpath is None:
345             currpath = []
346         paths = []
347         for option in self._children:
348             attr = option._name
349             if attr.startswith('_cfgimpl'):
350                 continue
351             value = getattr(self, attr)
352             if isinstance(value, OptionDescription):
353                 if include_groups:
354                     paths.append('.'.join(currpath + [attr]))
355                 currpath.append(attr)
356                 paths += value.getpaths(include_groups=include_groups,
357                                         currpath=currpath)
358                 currpath.pop()
359             else:
360                 paths.append('.'.join(currpath + [attr]))
361         return paths
362     # ____________________________________________________________
363
364     def set_group_type(self, group_type):
365         if group_type in group_types:
366             self.group_type = group_type
367         else:
368             raise ConfigError('not allowed value for group_type : {0}'.format(
369                               group_type))
370     
371     def get_group_type(self):
372         return self.group_type
373     # ____________________________________________________________
374     def hide(self):
375         super(OptionDescription, self).hide()
376         # FIXME : AND THE SUBCHILDREN ? 
377         for child in self._children:
378             if isinstance(child, OptionDescription):
379                 child.hide()
380     
381     def show(self):
382         # FIXME : AND THE SUBCHILDREN ?? 
383         super(OptionDescription, self).show()
384         for child in self._children:
385             if isinstance(child, OptionDescription):
386                 child.show()
387     # ____________________________________________________________
388     def disable(self):
389         super(OptionDescription, self).disable()
390         # FIXME : AND THE SUBCHILDREN ? 
391         for child in self._children:
392             if isinstance(child, OptionDescription):
393                 child.disable()
394     
395     def enable(self):
396         # FIXME : AND THE SUBCHILDREN ? 
397         super(OptionDescription, self).enable()
398         for child in self._children:
399             if isinstance(child, OptionDescription):
400                 child.enable()
401 # ____________________________________________________________
402 def apply_requires(opt, config):
403     if hasattr(opt, '_requires'):
404         if opt._requires is not None:
405             # malformed requirements
406             rootconfig = config._cfgimpl_get_toplevel()
407             for req in opt._requires:
408                 if not type(req) == tuple and len(req) in (3, 4):
409                     raise RequiresError("malformed requirements for option:"
410                                                    " {0}".format(opt._name))
411             # all actions **must** be identical
412             actions = [req[2] for req in opt._requires]
413             action = actions[0]
414             for act in actions:
415                 if act != action:
416                     raise RequiresError("malformed requirements for option:"
417                                                    " {0}".format(opt._name))
418             # filters the callbacks
419             matches = False
420             for req in opt._requires:
421                 if len(req) == 3:
422                     name, expected, action = req
423                     inverted = False
424                 if len(req) == 4:
425                     name, expected, action, inverted = req
426                     if inverted == 'inverted':
427                         inverted = True
428                 homeconfig, shortname = \
429                                       rootconfig._cfgimpl_get_home_by_path(name)
430                 # FIXME: doesn't work with 'auto' or 'fill' yet 
431                 # (copy the code from the __getattr__
432                 if shortname in homeconfig._cfgimpl_values:
433                     value = homeconfig._cfgimpl_values[shortname]
434                     if (not inverted and value == expected) or \
435                             (inverted and value != expected):
436                         if action not in available_actions:
437                             raise RequiresError("malformed requirements"
438                                            " for option: {0}".format(opt._name))
439                         getattr(opt, action)() #.hide() or show() or...
440                         matches = True
441                 else: # option doesn't exist ! should not happen...
442                     raise NotFoundError("required option not found: "
443                                                              "{0}".format(name))
444             # no callback has been triggered, then just reverse the action
445             if not matches:
446                 getattr(opt, reverse_actions[action])()
447