owners are *real* objects now
[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 types import FunctionType
24 from tiramisu.basetype import HiddenBaseType, DisabledBaseType
25 from tiramisu.error import (ConfigError, ConflictConfigError, NotFoundError,
26     RequiresError, RequirementRecursionError, MandatoryError,
27     PropertiesOptionError)
28 from tiramisu.autolib import carry_out_calculation
29 from tiramisu.setting import settings, groups, owners
30
31 requires_actions = [('hide', 'show'), ('enable', 'disable'), ('freeze', 'unfreeze')]
32
33 available_actions = []
34 reverse_actions = {}
35 for act1, act2 in requires_actions:
36     available_actions.extend([act1, act2])
37     reverse_actions[act1] = act2
38     reverse_actions[act2] = act1
39 # ____________________________________________________________
40 # multi types
41
42 class Multi(list):
43     """multi options values container
44     that support item notation for the values of multi options"""
45     def __init__(self, lst, config, opt):
46         """
47         :lst: the Multi wraps a list value
48         :param config: the parent config
49         :param opt: the option object that have this Multi value
50         """
51         self.config = config
52         self.opt = opt
53         if self.opt.is_master(config):
54             # we pass the list at the list type's init
55             # because a normal init cannot return anything
56             super(Multi, self).__init__(lst)
57             # we add the slaves without modifying the master
58             for l in lst:
59                 try:
60                     self.append(l, add_master=False)
61                 except Exception, err:
62                     print err
63         else:
64             self.config._valid_len(self.opt._name, lst)
65             super(Multi, self).__init__(lst)
66
67     def __setitem__(self, key, value):
68         return self._setvalue(value, key, who=owners.user)
69
70     def append(self, value, add_master=True):
71         """the list value can be updated (appened)
72         only if the option is a master
73         :param add_master: adds slaves without modifiying the master option
74                            if True, adds slaves **and** the master option
75         """
76         try:
77             master = self.config._cfgimpl_descr.get_master_name()
78             if master != self.opt._name:
79                 raise IndexError("in a group with a master, you mustn't add "
80                         "a value in a slave's Multi value")
81         except TypeError:
82             return self._setvalue(value, who=settings.owner)
83         multis = []
84         for name, multi in self.config:
85             multis.append(multi)
86         for multi in multis:
87             if master == multi.opt._name:
88                 if add_master:
89                     ret = multi._setvalue(value, who=settings.owner)
90                 else:
91                     ret = value
92             else:
93                 default_value = multi.opt.getdefault_multi()
94                 multi._setvalue(default_value)
95         return ret
96
97     def _setvalue(self, value, key=None, who=None):
98         if value != None:
99             if not self.opt._validate(value):
100                 raise ConfigError("invalid value {0} "
101                     "for option {1}".format(str(value), self.opt._name))
102         oldvalue = list(self)
103         if key is None:
104             ret = super(Multi, self).append(value)
105         else:
106             ret = super(Multi, self).__setitem__(key, value)
107         if who != None:
108             self.opt.setowner(self.config, who)
109         self.config._cfgimpl_previous_values[self.opt._name] = oldvalue
110         return ret
111
112     def pop(self, key):
113         """the list value can be updated (poped)
114         only if the option is a master
115         """
116         try:
117             master = self.config._cfgimpl_descr.get_master_name()
118             if master != self.opt._name:
119                 raise IndexError("in a group with a master, you mustn't remove "
120                         "a value in a slave's Multi value")
121         except TypeError:
122             return self._pop(key)
123
124         multis = []
125         for name, multi in self.config:
126             multis.append(multi)
127         for multi in multis:
128             if master == multi.opt._name:
129                 ret = multi._pop(key)
130             else:
131                 change_who = False
132                 # the value owner has to be updated because
133                 # the default value¬†doesn't have the same length
134                 # of the new value
135                 if len(multi.opt.getdefault()) >= len(multi):
136                     change_who = True
137                 multi._pop(key, change_who=change_who)
138         return ret
139
140     def _pop(self, key, change_who=True):
141         oldvalue = list(self)
142         if change_who:
143             self.opt.setowner(self.config, settings.owner)
144         self.config._cfgimpl_previous_values[self.opt._name] = oldvalue
145         return super(Multi, self).pop(key)
146 # ____________________________________________________________
147 #
148 class Option(HiddenBaseType, DisabledBaseType):
149     """
150     Abstract base class for configuration option's.
151
152     Reminder: an Option object is **not** a container for the value
153     """
154     #freeze means: cannot modify the value of an Option once set
155     _frozen = False
156     #if an Option has been frozen, shall return the default value
157     _force_default_on_freeze = False
158     def __init__(self, name, doc, default=None, default_multi=None,
159                  requires=None, mandatory=False, multi=False, callback=None,
160                  callback_params=None, validator=None, validator_args={}):
161         """
162         :param name: the option's name
163         :param doc: the option's description
164         :param default: specifies the default value of the option,
165                         for a multi : ['bla', 'bla', 'bla']
166         :param default_multi: 'bla' (used in case of a reset to default only at
167                         a given index)
168         :param requires: is a list of names of options located anywhere
169                          in the configuration.
170         :param multi: if true, the option's value is a list
171         :param callback: the name of a function. If set, the function's output
172                          is responsible of the option's value
173         :param callback_params: the callback's parameter
174         :param validator: the name of a function wich stands for a custom
175                           validation of the value
176         :param validator_args: the validator's parameters
177         """
178         self._name = name
179         self.doc = doc
180         self._requires = requires
181         self._mandatory = mandatory
182         self.multi = multi
183         self._validator = None
184         self._validator_args = None
185         if validator is not None:
186             if type(validator) != FunctionType:
187                 raise TypeError("validator must be a function")
188             self._validator = validator
189             if validator_args is not None:
190                 self._validator_args = validator_args
191         if not self.multi and default_multi is not None:
192             raise ConfigError("a default_multi is set whereas multi is False"
193                   " in option: {0}".format(name))
194         if default_multi is not None and not self._validate(default_multi):
195             raise ConfigError("invalid default_multi value {0} "
196                 "for option {1}".format(str(default_multi), name))
197         self.default_multi = default_multi
198         #if self.multi and default_multi is None:
199         #    _cfgimpl_warnings[name] = DefaultMultiWarning
200         if callback is not None and (default is not None or default_multi is not None):
201             raise ConfigError("defaut values not allowed if option: {0} "
202                 "is calculated".format(name))
203         self.callback = callback
204         if self.callback is None and callback_params is not None:
205             raise ConfigError("params defined for a callback function but"
206             " no callback defined yet for option {0}".format(name))
207         self.callback_params = callback_params
208         if self.multi == True:
209             if default == None:
210                 default = []
211             if not isinstance(default, list):
212                 raise ConfigError("invalid default value {0} "
213                 "for option {1} : not list type".format(str(default), name))
214             if not self.validate(default, False):
215                 raise ConfigError("invalid default value {0} "
216                 "for option {1}".format(str(default), name))
217         else:
218             if default != None and not self.validate(default, False):
219                 raise ConfigError("invalid default value {0} "
220                                          "for option {1}".format(str(default), name))
221         self.default = default
222         self.properties = [] # 'hidden', 'disabled'...
223
224     def validate(self, value, validate=True):
225         """
226         :param value: the option's value
227         :param validate: if true enables ``self._validator`` validation
228         """
229         # generic calculation
230         if self.multi == False:
231             # None allows the reset of the value
232             if value != None:
233                 # customizing the validator
234                 if validate and self._validator is not None and \
235                         not self._validator(value, **self._validator_args):
236                     return False
237                 return self._validate(value)
238         else:
239             if not isinstance(value, list):
240                 raise ConfigError("invalid value {0} "
241                         "for option {1} which must be a list".format(value,
242                         self._name))
243             for val in value:
244                 # None allows the reset of the value
245                 if val != None:
246                     # customizing the validator
247                     if validate and self._validator is not None and \
248                             not self._validator(val, **self._validator_args):
249                         return False
250                     if not self._validate(val):
251                         return False
252         return True
253
254     def getdefault(self, default_multi=False):
255         "accessing the default value"
256         if default_multi == False or not self.is_multi():
257             return self.default
258         else:
259             return self.getdefault_multi()
260
261     def getdefault_multi(self):
262         "accessing the default value for a multi"
263         return self.default_multi
264
265     def is_empty_by_default(self):
266         "no default value has been set yet"
267         if ((not self.is_multi() and self.default == None) or
268                 (self.is_multi() and (self.default == [] or None in self.default))):
269             return True
270         return False
271
272     def force_default(self):
273         "if an Option has been frozen, shall return the default value"
274         self._force_default_on_freeze = True
275
276     def hascallback_and_isfrozen():
277         return self._frozen and self.has_callback()
278
279     def is_forced_on_freeze(self):
280         "if an Option has been frozen, shall return the default value"
281         return self._frozen and self._force_default_on_freeze
282
283     def getdoc(self):
284         "accesses the Option's doc"
285         return self.doc
286
287     def getcallback(self):
288         "a callback is only a link, the name of an external hook"
289         return self.callback
290
291     def has_callback(self):
292         "to know if a callback has been defined or not"
293         if self.callback == None:
294             return False
295         else:
296             return True
297
298     def getcallback_value(self, config):
299         return carry_out_calculation(self._name,
300                 option=self, config=config)
301
302     def getcallback_params(self):
303         "if a callback has been defined, returns his arity"
304         return self.callback_params
305
306     def setowner(self, config, owner):
307         """
308         :param config: *must* be only the **parent** config
309                        (not the toplevel config)
310         :param owner: is a **real** owner, that is an object
311                       that lives in setting.owners
312         """
313         name = self._name
314         if not isinstance(owner, owners.Owner):
315             raise ConfigError("invalid type owner for option: {0}".format(
316                     str(name)))
317         config._cfgimpl_value_owners[name] = owner
318
319     def getowner(self, config):
320         "config *must* be only the **parent** config (not the toplevel config)"
321         return config._cfgimpl_value_owners[self._name]
322
323     def reset(self, config):
324         """resets the default value and owner
325         """
326         config.setoption(self._name, self.getdefault(), owners.default)
327
328     def is_default_owner(self, config):
329         """
330         :param config: *must* be only the **parent** config
331                        (not the toplevel config)
332         :return: boolean
333         """
334         return self.getowner(config) == 'default'
335
336     def setoption(self, config, value):
337         """changes the option's value with the value_owner's who
338         :param config: the parent config is necessary here to store the value
339         """
340         name = self._name
341         rootconfig = config._cfgimpl_get_toplevel()
342         if not self.validate(value, settings.validator):
343             raise ConfigError('invalid value %s for option %s' % (value, name))
344         if self.is_mandatory():
345             # value shall not be '' for a mandatory option
346             # so '' is considered as being None
347             if not self.is_multi() and value == '':
348                 value = None
349             if self.is_multi() and '' in value:
350                 value = Multi([{'': None}.get(i, i) for i in value], config, self)
351             if settings.is_mandatory() and ((self.is_multi() and value == []) or \
352                 (not self.is_multi() and value is None)):
353                 raise MandatoryError('cannot change the value to %s for '
354               'option %s' % (value, name))
355         if name not in config._cfgimpl_values:
356             raise AttributeError('unknown option %s' % (name))
357
358         if settings.is_frozen() and self.is_frozen():
359             raise TypeError('cannot change the value to %s for '
360                'option %s this option is frozen' % (str(value), name))
361         apply_requires(self, config)
362         if type(config._cfgimpl_values[name]) == Multi:
363             config._cfgimpl_previous_values[name] = list(config._cfgimpl_values[name])
364         else:
365             config._cfgimpl_previous_values[name] = config._cfgimpl_values[name]
366         config._cfgimpl_values[name] = value
367
368     def getkey(self, value):
369         return value
370
371     def is_master(self, config):
372         try:
373             self.master = config._cfgimpl_descr.get_master_name()
374         except TypeError:
375             return False
376         return self.master is not None and self.master == self._name
377     # ____________________________________________________________
378     "freeze utility"
379     def freeze(self):
380         self._frozen = True
381         return True
382     def unfreeze(self):
383         self._frozen = False
384     def is_frozen(self):
385         return self._frozen
386     # ____________________________________________________________
387     def is_multi(self):
388         return self.multi
389     def is_mandatory(self):
390         return self._mandatory
391
392 class ChoiceOption(Option):
393     opt_type = 'string'
394
395     def __init__(self, name, doc, values, default=None, default_multi=None,
396                  requires=None, mandatory=False, multi=False, callback=None,
397                  callback_params=None, open_values=False, validator=None,
398                  validator_args={}):
399         self.values = values
400         if open_values not in [True, False]:
401             raise ConfigError('Open_values must be a boolean for '
402                               '{0}'.format(name))
403         self.open_values = open_values
404         super(ChoiceOption, self).__init__(name, doc, default=default,
405                         default_multi=default_multi, callback=callback,
406                         callback_params=callback_params, requires=requires,
407                         multi=multi, mandatory=mandatory, validator=validator,
408                         validator_args=validator_args)
409
410     def _validate(self, value):
411         if not self.open_values:
412             return value is None or value in self.values
413         else:
414             return True
415
416 class BoolOption(Option):
417     opt_type = 'bool'
418
419     def _validate(self, value):
420         return isinstance(value, bool)
421
422 class IntOption(Option):
423     opt_type = 'int'
424
425     def _validate(self, value):
426         return isinstance(value, int)
427
428 class FloatOption(Option):
429     opt_type = 'float'
430
431     def _validate(self, value):
432         return isinstance(value, float)
433
434 class StrOption(Option):
435     opt_type = 'string'
436
437     def _validate(self, value):
438         return isinstance(value, str)
439
440 class SymLinkOption(object):
441     opt_type = 'symlink'
442
443     def __init__(self, name, path, opt):
444         self._name = name
445         self.path = path
446         self.opt = opt
447
448     def setoption(self, config, value):
449         setattr(config, self.path, value)
450
451     def __getattr__(self, name):
452         if name in ('_name', 'path', 'opt', 'setoption'):
453             return self.__dict__[name]
454         else:
455             return getattr(self.opt, name)
456
457 class IPOption(Option):
458     opt_type = 'ip'
459
460     def _validate(self, value):
461         # by now the validation is nothing but a string, use IPy instead
462         return isinstance(value, str)
463
464 class NetmaskOption(Option):
465     opt_type = 'netmask'
466
467     def _validate(self, value):
468         # by now the validation is nothing but a string, use IPy instead
469         return isinstance(value, str)
470
471 class OptionDescription(HiddenBaseType, DisabledBaseType):
472     """Config's schema (organisation, group) and container of Options"""
473     # the group_type is useful for filtering OptionDescriptions in a config
474     group_type = groups.default
475     def __init__(self, name, doc, children, requires=None):
476         """
477         :param children: is a list of option descriptions (including
478         ``OptionDescription`` instances for nested namespaces).
479         """
480         self._name = name
481         self.doc = doc
482         self._children = children
483         self._requires = requires
484         self._build()
485         self.properties = [] # 'hidden', 'disabled'...
486         # if this group is a master group, master is set
487         # to the master option name. it's just a ref to a name
488         self.master = None
489
490     def getdoc(self):
491         return self.doc
492
493     def _build(self):
494         for child in self._children:
495             setattr(self, child._name, child)
496
497     def add_child(self, child):
498         "dynamically adds a configuration option"
499         #Nothing is static. Even the Mona Lisa is falling apart.
500         for ch in self._children:
501             if isinstance(ch, Option):
502                 if child._name == ch._name:
503                     raise ConflictConfigError("existing option : {0}".format(
504                                                                    child._name))
505         self._children.append(child)
506         setattr(self, child._name, child)
507
508     def update_child(self, child):
509         "modification of an existing option"
510         # XXX : corresponds to the `redefine`, is it usefull
511         pass
512
513     def getkey(self, config):
514         return tuple([child.getkey(getattr(config, child._name))
515                       for child in self._children])
516
517     def getpaths(self, include_groups=False, currpath=None):
518         """returns a list of all paths in self, recursively
519            currpath should not be provided (helps with recursion)
520         """
521         if currpath is None:
522             currpath = []
523         paths = []
524         for option in self._children:
525             attr = option._name
526             if attr.startswith('_cfgimpl'):
527                 continue
528             if isinstance(option, OptionDescription):
529                 if include_groups:
530                     paths.append('.'.join(currpath + [attr]))
531                 currpath.append(attr)
532                 paths += option.getpaths(include_groups=include_groups,
533                                         currpath=currpath)
534                 currpath.pop()
535             else:
536                 paths.append('.'.join(currpath + [attr]))
537         return paths
538     # ____________________________________________________________
539     def set_group_type(self, group_type, master=None):
540         """sets a given group object to an OptionDescription
541
542         :param group_type: an instance of `GroupName` or `MasterGroupName`
543                               that lives in `setting.groups`
544         """
545         if isinstance(group_type, groups.GroupName):
546             self.group_type = group_type
547             if isinstance(group_type, groups.MasterGroupName):
548                 if master is None:
549                     raise ConfigError('this group type ({0}) needs a master '
550                             'for OptionDescription {1}'.format(group_type,
551                                 self._name))
552             else:
553                 if master is not None:
554                     raise ConfigError("this group type ({0}) doesn't need a "
555                             "master for OptionDescription {1}".format(
556                                 group_type, self._name))
557             self.master = master
558         else:
559             raise ConfigError('not allowed group_type : {0}'.format(group_type))
560
561     def get_group_type(self):
562         return self.group_type
563
564     def get_master_name(self):
565         if self.master is None:
566             raise TypeError('get_master_name() shall not be called in case of '
567                 'non-master OptionDescription')
568         return self.master
569
570     # ____________________________________________________________
571     "actions API"
572     def hide(self):
573         super(OptionDescription, self).hide()
574         for child in self._children:
575             if isinstance(child, OptionDescription):
576                 child.hide()
577     def show(self):
578         super(OptionDescription, self).show()
579         for child in self._children:
580             if isinstance(child, OptionDescription):
581                 child.show()
582
583     def disable(self):
584         super(OptionDescription, self).disable()
585         for child in self._children:
586             if isinstance(child, OptionDescription):
587                 child.disable()
588     def enable(self):
589         super(OptionDescription, self).enable()
590         for child in self._children:
591             if isinstance(child, OptionDescription):
592                 child.enable()
593 # ____________________________________________________________
594
595 def validate_requires_arg(requires, name):
596     "malformed requirements"
597     config_action = []
598     for req in requires:
599         if not type(req) == tuple and len(req) != 3:
600             raise RequiresError("malformed requirements for option:"
601                                            " {0}".format(name))
602         action = req[2]
603         if action not in available_actions:
604             raise RequiresError("malformed requirements for option: {0}"
605                                 "unknown action: {1}".format(name, action))
606         if reverse_actions[action] in config_action:
607             raise RequiresError("inconsistency in action types for option: {0}"
608                                 "action: {1} in contradiction with {2}\n"
609                                 " ({3})".format(name, action,
610                                     reverse_actions[action], requires))
611         config_action.append(action)
612
613 def build_actions(requires):
614     "action are hide, show, enable, disable..."
615     trigger_actions = {}
616     for require in requires:
617         action = require[2]
618         trigger_actions.setdefault(action, []).append(require)
619     return trigger_actions
620
621 def apply_requires(opt, config, permissive=False):
622     "carries out the jit (just in time requirements between options"
623     if hasattr(opt, '_requires') and opt._requires is not None:
624         rootconfig = config._cfgimpl_get_toplevel()
625         validate_requires_arg(opt._requires, opt._name)
626         # filters the callbacks
627         trigger_actions = build_actions(opt._requires)
628         for requires in trigger_actions.values():
629             matches = False
630             for require in requires:
631                 name, expected, action = require
632                 path = config._cfgimpl_get_path() + '.' + opt._name
633                 if name.startswith(path):
634                     raise RequirementRecursionError("malformed requirements "
635                           "imbrication detected for option: '{0}' "
636                           "with requirement on: '{1}'".format(path, name))
637                 homeconfig, shortname = rootconfig._cfgimpl_get_home_by_path(name)
638                 try:
639                     value = homeconfig._getattr(shortname, permissive=True)
640                 except PropertiesOptionError, err:
641                     permissives = err.proptype
642                     if permissive:
643                         for perm in settings.permissive:
644                             if perm in properties:
645                                 properties.remove(perm)
646                     if properties != []:
647                         raise NotFoundError("option '{0}' has requirement's property error: "
648                                      "{1} {2}".format(opt._name, name, properties))
649                 except Exception, err:
650                     raise NotFoundError("required option not found: "
651                                                              "{0}".format(name))
652                 if value == expected:
653                     getattr(opt, action)() #.hide() or show() or...
654                     # FIXME generic programming opt.property_launch(action, False)
655                     matches = True
656             # no callback has been triggered, then just reverse the action
657             if not matches:
658                 getattr(opt, reverse_actions[action])()