suppression of the notion of normal and expert mode
[tiramisu.git] / tiramisu / option.py
1 # -*- coding: utf-8 -*-
2 "option types and option description for the configuration management"
3 # Copyright (C) 2012 Team tiramisu (see AUTHORS 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 tiramisu.autolib import special_owners
24 from tiramisu.basetype import HiddenBaseType, DisabledBaseType
25 from tiramisu.error import (ConfigError, ConflictConfigError, NotFoundError, 
26                    SpecialOwnersError, RequiresError, RequirementRecursionError)
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 # multi types 
34
35 class Multi(list):
36     "container that support items for the values of list (multi) options" 
37     def __init__(self, lst, config, child):
38         self.config = config
39         self.child = child
40         super(Multi, self).__init__(lst)
41         
42     def __setitem__(self, key, value):
43         return self.setoption(value, key)
44
45     def append(self, value):
46         self.setoption(value)
47    
48     def setoption(self, value, key=None):
49         owners = self.child.getowner(self.config)
50         # None is replaced by default_multi
51         if value == None:
52             defval = self.child.getdefault()
53             if key is not None and len(defval) > key:
54                 value = defval[key]
55             else:
56                 value = self.child.default_multi
57             who = 'default'
58         else:
59             who = self.config._cfgimpl_owner
60             if not self.child._validate(value):
61                 raise ConfigError("invalid value {0} "
62                     "for option {1}".format(str(value), self.child._name))
63         oldvalue = list(self)
64         oldowner = self.child.getowner(self.config)
65         if key is None:
66             ret = super(Multi, self).append(value)
67             oldvalue.append(None)
68             oldowner.append(who)
69         else:
70             ret = super(Multi, self).__setitem__(key, value)
71             oldowner[key] = who
72         self.config._cfgimpl_previous_values[self.child._name] = oldvalue
73         self.child.setowner(self.config, oldowner)
74         return ret
75         
76     def pop(self, key):
77         oldowner = self.child.getowner(self.config)
78         oldowner.pop(key)
79         self.child.setowner(self.config, oldowner)
80         super(Multi, self).pop(key)
81 # ____________________________________________________________
82 #
83 class Option(HiddenBaseType, DisabledBaseType):
84     #reminder: an Option object is **not** a container for the value
85     _frozen = False
86     def __init__(self, name, doc, default=None, default_multi=None, 
87                  requires=None, mandatory=False, multi=False, callback=None, 
88                  callback_params=None):
89         self._name = name
90         self.doc = doc
91         self._requires = requires
92         self._mandatory = mandatory
93         self.multi = multi
94         if not self.multi and default_multi is not None:
95             raise ConfigError("a default_multi is set whereas multi is False"
96                   " in option: {0}".format(name)) 
97         if default_multi is not None and not self._validate(default_multi):
98             raise ConfigError("invalid default_multi value {0} "
99                 "for option {1}".format(str(default_multi), name))
100         self.default_multi = default_multi
101         #if self.multi and default_multi is None:
102             # _cfgimpl_warnings[name] = DefaultMultiWarning   
103         if callback is not None and (default is not None or default_multi is not None):
104             raise ConfigError("defaut values not allowed if option: {0}" 
105                 "is calculated".format(name))
106         self.callback = callback
107         if self.callback is None and callback_params is not None:
108             raise ConfigError("params defined for a callback function but"
109             " no callback defined yet for option {0}".format(name)) 
110         self.callback_params = callback_params
111         if self.multi == True:
112             if default == None:
113                 default = []
114             if not isinstance(default, list) or not self.validate(default):
115                 raise ConfigError("invalid default value {0} "
116                 "for option {1} : not list type".format(str(default), name))
117         else:
118             if default != None and not self.validate(default):
119                 raise ConfigError("invalid default value {0} " 
120                                          "for option {1}".format(str(default), name))
121         self.default = default
122         
123     def validate(self, value):
124         if self.multi == False:
125             # None allows the reset of the value
126             if value != None:
127                 return self._validate(value)
128         else:
129             if not isinstance(value, list): 
130                 raise ConfigError("invalid value {0} " 
131                         "for option {1} which must be a list".format(value,
132                         self._name))
133             for val in value:
134                 if val != None:
135                     # None allows the reset of the value
136                     if not self._validate(val):
137                         return False
138         return True
139
140     def getdefault(self):
141         return self.default
142
143     def getdoc(self):
144         return self.doc
145
146     def getcallback(self):
147         return self.callback
148     
149     def has_callback(self):
150         if self.callback == None:
151             return False
152         else:
153             return True
154
155     def getcallback_params(self):
156         return self.callback_params
157
158     def setowner(self, config, owner):
159         # config *must* be only the **parent** config (not the toplevel config) 
160         # owner is a **real* owner, a list is actually allowable here
161         name = self._name
162         if self._frozen:
163             raise TypeError("trying to change a frozen option's owner: %s" % name)
164         if owner in special_owners:
165             if self.callback == None:
166                 raise SpecialOwnersError("no callback specified for" 
167                                                       "option {0}".format(name))
168         if self.is_multi():
169             if not type(owner) == list:
170                 raise ConfigError("invalid owner for multi "
171                     "option: {0}".format(self._name))
172         config._cfgimpl_value_owners[name] = owner
173
174     def getowner(self, config):
175         # config *must* be only the **parent** config (not the toplevel config) 
176         return config._cfgimpl_value_owners[self._name]
177
178     def setoption(self, config, value, who):
179         "who is **not necessarily** a owner because it cannot be a list"
180         name = self._name
181         if self._frozen:
182             raise TypeError('trying to change a frozen option object: %s' % name)
183         # we want the possibility to reset everything
184         if who == "default" and value is None:
185             self.default = None
186             return
187         if not self.validate(value):
188             raise ConfigError('invalid value %s for option %s' % (value, name))
189         if who == "default":
190             # changes the default value (and therefore resets the previous value)
191             if self._validate(value):
192                 self.default = value
193             else:
194                 raise ConfigError("invalid value %s for option %s" % (value, name))
195         apply_requires(self, config)
196         # FIXME put the validation for the multi somewhere else
197 #            # it is a multi **and** it has requires
198 #            if self.multi == True:
199 #                if type(value) != list:
200 #                    raise TypeError("value {0} must be a list".format(value))
201 #                if self._requires is not None:
202 #                    for reqname in self._requires:
203 #                        # FIXME : verify that the slaves are all multi
204 #                        #option = getattr(config._cfgimpl_descr, reqname)
205 #    #                    if not option.multi == True:
206 #    #                        raise ConflictConfigError("an option with requires "
207 #    #                         "has to be a list type : {0}".format(name)) 
208 #                        if len(config._cfgimpl_values[reqname]) != len(value):
209 #                            raise ConflictConfigError("an option with requires "
210 #                             "has not the same length of the others " 
211 #                             "in the group : {0}".format(reqname)) 
212         if type(config._cfgimpl_values[name]) == Multi:
213             config._cfgimpl_previous_values[name] = list(config._cfgimpl_values[name])
214         else:
215             config._cfgimpl_previous_values[name] = config._cfgimpl_values[name] 
216         config._cfgimpl_values[name] = value
217
218     def getkey(self, value):
219         return value
220
221     def freeze(self):
222         self._frozen = True
223         return True
224
225     def unfreeze(self):
226         self._frozen = False
227     # ____________________________________________________________
228     def is_multi(self):
229         return self.multi
230
231     def is_mandatory(self):
232         return self._mandatory
233         
234 class ChoiceOption(Option):
235     opt_type = 'string'
236     
237     def __init__(self, name, doc, values, default=None,
238                  requires=None, callback=None, callback_params=None,
239                  multi=False, mandatory=False, open_values=False):
240         self.values = values
241         if open_values not in [True, False]:
242             raise ConfigError('Open_values must be a boolean for '
243                               '{0}'.format(name))
244         self.open_values = open_values
245         super(ChoiceOption, self).__init__(name, doc, default=default,
246                            callback=callback, callback_params=callback_params, 
247                            requires=requires, multi=multi, mandatory=mandatory)
248
249     def setoption(self, config, value, who):
250         name = self._name
251         super(ChoiceOption, self).setoption(config, value, who)
252
253     def _validate(self, value):
254         if not self.open_values:
255             return value is None or value in self.values
256         else:
257             return True
258
259 class BoolOption(Option):
260     opt_type = 'bool'
261     
262     def _validate(self, value):
263         return isinstance(value, bool)
264
265 # config level validator             
266 #    def setoption(self, config, value, who):
267 #        name = self._name
268 #        if value and self._validator is not None:
269 #            toplevel = config._cfgimpl_get_toplevel()
270 #            self._validator(toplevel)
271 #        super(BoolOption, self).setoption(config, value, who)
272
273 class IntOption(Option):
274     opt_type = 'int'
275     
276     def _validate(self, value):
277         try:
278             int(value)
279         except TypeError:
280             return False
281         return True
282                             
283     def setoption(self, config, value, who):
284         try:
285             super(IntOption, self).setoption(config, value, who)
286         except TypeError, e:
287             raise ConfigError(*e.args)
288
289 class FloatOption(Option):
290     opt_type = 'float'
291
292     def _validate(self, value):
293         try:
294             float(value)
295         except TypeError:
296             return False
297         return True
298
299     def setoption(self, config, value, who):
300         try:
301             super(FloatOption, self).setoption(config, float(value), who)
302         except TypeError, e:
303             raise ConfigError(*e.args)
304
305 class StrOption(Option):
306     opt_type = 'string'
307     
308     def _validate(self, value):
309         return isinstance(value, str)
310                                      
311     def setoption(self, config, value, who):
312         try:
313             super(StrOption, self).setoption(config, value, who)
314         except TypeError, e:
315             raise ConfigError(*e.args)
316
317 class SymLinkOption(object):
318     opt_type = 'symlink'
319     
320     def __init__(self, name, path):
321         self._name = name
322         self.path = path 
323     
324     def setoption(self, config, value, who):
325         try:
326             setattr(config, self.path, value) # .setoption(self.path, value, who)
327         except TypeError, e:
328             raise ConfigError(*e.args)
329
330 class IPOption(Option):
331     opt_type = 'ip'
332     
333     def _validate(self, value):
334         # by now the validation is nothing but a string, use IPy instead
335         return isinstance(value, str)
336                                      
337     def setoption(self, config, value, who):
338         try:
339             super(IPOption, self).setoption(config, value, who)
340         except TypeError, e:
341             raise ConfigError(*e.args)
342
343 class NetmaskOption(Option):
344     opt_type = 'netmask'
345     
346     def _validate(self, value):
347         # by now the validation is nothing but a string, use IPy instead
348         return isinstance(value, str)
349                                      
350     def setoption(self, config, value, who):
351         try:
352             super(NetmaskOption, self).setoption(config, value, who)
353         except TypeError, e:
354             raise ConfigError(*e.args)
355
356 class ArbitraryOption(Option):
357     def __init__(self, name, doc, default=None, defaultfactory=None, 
358                                    requires=None, multi=False, mandatory=False):
359         super(ArbitraryOption, self).__init__(name, doc, requires=requires,
360                                                multi=multi, mandatory=mandatory)
361         self.defaultfactory = defaultfactory
362         if defaultfactory is not None:
363             assert default is None
364
365     def _validate(self, value):
366         return True
367
368     def getdefault(self):
369         if self.defaultfactory is not None:
370             return self.defaultfactory()
371         return self.default
372
373 class OptionDescription(HiddenBaseType, DisabledBaseType):
374     group_type = 'default'
375     
376     def __init__(self, name, doc, children, requires=None):
377         self._name = name
378         self.doc = doc
379         self._children = children
380         self._requires = requires
381         self._build()
382     
383     def getdoc(self):
384         return self.doc
385
386     def _build(self):
387         for child in self._children:
388             setattr(self, child._name, child)
389
390     def add_child(self, child):
391         "dynamically adds a configuration option"
392         #Nothing is static. Even the Mona Lisa is falling apart.
393         for ch in self._children:
394             if isinstance(ch, Option):
395                 if child._name == ch._name:
396                     raise ConflictConfigError("existing option : {0}".format(
397                                                                    child._name))
398         self._children.append(child)
399         setattr(self, child._name, child)
400     
401     def update_child(self, child):
402         "modification of an existing option"
403         # XXX : corresponds to the `redefine`, is it usefull 
404         pass
405         
406     def getkey(self, config):
407         return tuple([child.getkey(getattr(config, child._name))
408                       for child in self._children])
409
410     def getpaths(self, include_groups=False, currpath=None):
411         """returns a list of all paths in self, recursively
412            currpath should not be provided (helps with recursion)
413         """
414         if currpath is None:
415             currpath = []
416         paths = []
417         for option in self._children:
418             attr = option._name
419             if attr.startswith('_cfgimpl'):
420                 continue
421             value = getattr(self, attr)
422             if isinstance(value, OptionDescription):
423                 if include_groups:
424                     paths.append('.'.join(currpath + [attr]))
425                 currpath.append(attr)
426                 paths += value.getpaths(include_groups=include_groups,
427                                         currpath=currpath)
428                 currpath.pop()
429             else:
430                 paths.append('.'.join(currpath + [attr]))
431         return paths
432     # ____________________________________________________________
433
434     def set_group_type(self, group_type):
435         if group_type in group_types:
436             self.group_type = group_type
437         else:
438             raise ConfigError('not allowed value for group_type : {0}'.format(
439                               group_type))
440     
441     def get_group_type(self):
442         return self.group_type
443     # ____________________________________________________________
444     def hide(self):
445         super(OptionDescription, self).hide()
446         # FIXME : AND THE SUBCHILDREN ? 
447         for child in self._children:
448             if isinstance(child, OptionDescription):
449                 child.hide()
450     
451     def show(self):
452         # FIXME : AND THE SUBCHILDREN ?? 
453         super(OptionDescription, self).show()
454         for child in self._children:
455             if isinstance(child, OptionDescription):
456                 child.show()
457     # ____________________________________________________________
458     def disable(self):
459         super(OptionDescription, self).disable()
460         # FIXME : AND THE SUBCHILDREN ? 
461         for child in self._children:
462             if isinstance(child, OptionDescription):
463                 child.disable()
464     
465     def enable(self):
466         # FIXME : AND THE SUBCHILDREN ? 
467         super(OptionDescription, self).enable()
468         for child in self._children:
469             if isinstance(child, OptionDescription):
470                 child.enable()
471 # ____________________________________________________________
472 def apply_requires(opt, config):
473     if hasattr(opt, '_requires'):
474         if opt._requires is not None:
475             # malformed requirements
476             rootconfig = config._cfgimpl_get_toplevel()
477             for req in opt._requires:
478                 if not type(req) == tuple and len(req) in (3, 4):
479                     raise RequiresError("malformed requirements for option:"
480                                                    " {0}".format(opt._name))
481             # all actions **must** be identical
482             actions = [req[2] for req in opt._requires]
483             action = actions[0]
484             for act in actions:
485                 if act != action:
486                     raise RequiresError("malformed requirements for option:"
487                                                    " {0}".format(opt._name))
488             # filters the callbacks
489             matches = False
490             for req in opt._requires:
491                 if len(req) == 3:
492                     name, expected, action = req
493                     inverted = False
494                 if len(req) == 4:
495                     name, expected, action, inverted = req
496                     if inverted == 'inverted':
497                         inverted = True
498                 path = config._cfgimpl_get_path() + '.' + opt._name
499                 if name.startswith(path):
500                     raise RequirementRecursionError("malformed requirements imbrication "
501                           "detected for option: '{0}' with requirement on: '{1}'".format(path, name))
502                 homeconfig, shortname = \
503                                       rootconfig._cfgimpl_get_home_by_path(name)
504                 # FIXME: doesn't work with 'auto' or 'fill' yet 
505                 # (copy the code from the __getattr__
506                 if shortname in homeconfig._cfgimpl_values:
507                     value = homeconfig._cfgimpl_values[shortname]
508                     if (not inverted and value == expected) or \
509                             (inverted and value != expected):
510                         if action not in available_actions:
511                             raise RequiresError("malformed requirements"
512                                            " for option: {0}".format(opt._name))
513                         getattr(opt, action)() #.hide() or show() or...
514                         matches = True
515                 else: # option doesn't exist ! should not happen...
516                     raise NotFoundError("required option not found: "
517                                                              "{0}".format(name))
518             # no callback has been triggered, then just reverse the action
519             if not matches:
520                 getattr(opt, reverse_actions[action])()
521