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