add option name's validation and rename Option method with objimpl_
[tiramisu.git] / tiramisu / setting.py
1 # -*- coding: utf-8 -*-
2 "sets the options of the configuration objects Config object itself"
3 # Copyright (C) 2012-2013 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 time import time
24 from tiramisu.error import RequirementRecursionError, PropertiesOptionError
25 from tiramisu.i18n import _
26
27
28 expires_time = 5
29 ro_remove = ('permissive', 'hidden')
30 ro_append = ('frozen', 'disabled', 'validator', 'everything_frozen', 'mandatory')
31 rw_remove = ('permissive', 'everything_frozen', 'mandatory')
32 rw_append = ('frozen', 'disabled', 'validator', 'hidden')
33
34
35 class _const:
36     """convenient class that emulates a module
37     and builds constants (that is, unique names)"""
38     class ConstError(TypeError):
39         pass
40
41     def __setattr__(self, name, value):
42         if name in self.__dict__:
43             raise self.ConstError, _("Can't rebind group ({})").format(name)
44         self.__dict__[name] = value
45
46     def __delattr__(self, name):
47         if name in self.__dict__:
48             raise self.ConstError, _("Can't unbind group ({})").format(name)
49         raise ValueError(name)
50
51
52 # ____________________________________________________________
53 class GroupModule(_const):
54     "emulates a module to manage unique group (OptionDescription) names"
55     class GroupType(str):
56         """allowed normal group (OptionDescription) names
57         *normal* means : groups that are not master
58         """
59         pass
60
61     class DefaultGroupType(GroupType):
62         """groups that are default (typically 'default')"""
63         pass
64
65     class MasterGroupType(GroupType):
66         """allowed normal group (OptionDescription) names
67         *master* means : groups that have the 'master' attribute set
68         """
69         pass
70 # setting.groups (emulates a module)
71 groups = GroupModule()
72
73
74 def populate_groups():
75     "populates the available groups in the appropriate namespaces"
76     groups.master = groups.MasterGroupType('master')
77     groups.default = groups.DefaultGroupType('default')
78     groups.family = groups.GroupType('family')
79
80 # names are in the module now
81 populate_groups()
82
83
84 # ____________________________________________________________
85 class OwnerModule(_const):
86     """emulates a module to manage unique owner names.
87
88     owners are living in `Config._cfgimpl_value_owners`
89     """
90     class Owner(str):
91         """allowed owner names
92         """
93         pass
94
95     class DefaultOwner(Owner):
96         """groups that are default (typically 'default')"""
97         pass
98 # setting.owners (emulates a module)
99 owners = OwnerModule()
100
101
102 def populate_owners():
103     """populates the available owners in the appropriate namespaces
104
105     - 'user' is the generic is the generic owner.
106     - 'default' is the config owner after init time
107     """
108     setattr(owners, 'default', owners.DefaultOwner('default'))
109     setattr(owners, 'user', owners.Owner('user'))
110
111     def add_owner(name):
112         """
113         :param name: the name of the new owner
114         """
115         setattr(owners, name, owners.Owner(name))
116     setattr(owners, 'add_owner', add_owner)
117
118 # names are in the module now
119 populate_owners()
120
121
122 class MultiTypeModule(_const):
123     class MultiType(str):
124         pass
125
126     class DefaultMultiType(MultiType):
127         pass
128
129     class MasterMultiType(MultiType):
130         pass
131
132     class SlaveMultiType(MultiType):
133         pass
134
135 multitypes = MultiTypeModule()
136
137
138 def populate_multitypes():
139     setattr(multitypes, 'default', multitypes.DefaultMultiType('default'))
140     setattr(multitypes, 'master', multitypes.MasterMultiType('master'))
141     setattr(multitypes, 'slave', multitypes.SlaveMultiType('slave'))
142
143 populate_multitypes()
144
145
146 class Property(object):
147     __slots__ = ('_setting', '_properties', '_opt')
148
149     def __init__(self, setting, prop, opt=None):
150         self._opt = opt
151         self._setting = setting
152         self._properties = prop
153
154     def append(self, propname):
155         if not propname in self._properties:
156             self._properties.append(propname)
157             self._setting._set_properties(self._properties, self._opt)
158         self._setting.context.cfgimpl_reset_cache()
159
160     def remove(self, propname):
161         if propname in self._properties:
162             self._properties.remove(propname)
163             self._setting._set_properties(self._properties, self._opt)
164         self._setting.context.cfgimpl_reset_cache()
165
166     def __contains__(self, propname):
167         return propname in self._properties
168
169
170 #____________________________________________________________
171 class Setting(object):
172     "``Config()``'s configuration options"
173     __slots__ = ('context', '_properties', '_permissives', '_owner', '_cache')
174
175     def __init__(self, context):
176         # properties attribute: the name of a property enables this property
177         # key is None for global properties
178         self._properties = {None: ['expire']}
179         # permissive properties
180         self._permissives = {}
181         # generic owner
182         self._owner = owners.user
183         self.context = context
184         self._cache = {}
185
186     #____________________________________________________________
187     # properties methods
188     def __contains__(self, propname):
189         return propname in self._get_properties()
190
191     def __getitem__(self, opt):
192         return Property(self, self._get_properties(opt), opt)
193
194     def __setitem__(self, opt, value):
195         raise ValueError('you must only append/remove properties')
196
197     def _get_properties(self, opt=None, is_apply_req=True):
198         if opt is not None and opt in self._cache:
199             exp = time()
200             props, created = self._cache[opt]
201             if exp < created:
202                 return props
203         if opt is None:
204             default = []
205         else:
206             if is_apply_req:
207                 apply_requires(opt, self.context)
208             default = list(opt._properties)
209         props = self._properties.get(opt, default)
210         if opt is not None:
211             self._set_cache(opt, props)
212         return props
213
214     def append(self, propname):
215         "puts property propname in the Config's properties attribute"
216         Property(self, self._get_properties()).append(propname)
217
218     def remove(self, propname):
219         "deletes property propname in the Config's properties attribute"
220         Property(self, self._get_properties()).remove(propname)
221
222     def _set_properties(self, properties, opt=None):
223         """save properties for specified opt
224         (never save properties if same has option properties)
225         """
226         if opt is None:
227             self._properties[opt] = properties
228         else:
229             if opt._properties == properties:
230                 if opt in self._properties:
231                     del(self._properties[opt])
232             else:
233                 self._properties[opt] = properties
234
235     def _validate_frozen(self, opt, value, is_write):
236         if not is_write:
237             return False
238         if 'permissive' in self and 'frozen' in self._get_permissive():
239             return False
240         if 'everything_frozen' in self or (
241                 'frozen' in self and 'frozen' in self[opt]):
242             return True
243         return False
244
245     def _validate_mandatory(self, opt, value, force_properties):
246         if 'permissive' in self and 'mandatory' in self._get_permissive():
247             return False
248         check_mandatory = 'mandatory' in self
249         if force_properties is not None:
250             check_mandatory = ('mandatory' in force_properties or
251                                check_mandatory)
252         if check_mandatory and 'mandatory' in self[opt] and \
253                 self.context.cfgimpl_get_values()._is_empty(opt, value):
254             return True
255         return False
256
257     def _calc_properties(self, opt_or_descr, force_permissive, force_properties):
258         properties = set(self._get_properties(opt_or_descr))
259         #remove this properties, those properties are validate in after
260         properties = properties - set(['mandatory', 'frozen'])
261         set_properties = set(self._get_properties())
262         if force_properties is not None:
263             set_properties.update(set(force_properties))
264         properties = properties & set_properties
265         if force_permissive is True or 'permissive' in self:
266             properties = properties - set(self._get_permissive())
267         properties = properties - set(self._get_permissive(opt_or_descr))
268         return list(properties)
269
270     #____________________________________________________________
271     def validate_properties(self, opt_or_descr, is_descr, is_write,
272                             value=None, force_permissive=False,
273                             force_properties=None):
274         properties = self._calc_properties(opt_or_descr, force_permissive,
275                                            force_properties)
276         raise_text = _("trying to access"
277                        " to an option named: {0} with properties"
278                        " {1}")
279         if not is_descr:
280             if self._validate_mandatory(opt_or_descr, value, force_properties):
281                 properties.append('mandatory')
282             if self._validate_frozen(opt_or_descr, value, is_write):
283                 properties.append('frozen')
284                 raise_text = _('cannot change the value to {0} for '
285                                'option {1} this option is frozen')
286         if properties != []:
287             raise PropertiesOptionError(raise_text.format(opt_or_descr._name,
288                                                           str(properties)),
289                                         properties)
290
291     def _get_permissive(self, opt=None):
292         return self._permissives.get(opt, [])
293
294     def set_permissive(self, permissive, opt=None):
295         if not isinstance(permissive, tuple):
296             raise TypeError(_('permissive must be a tuple'))
297         self._permissives[opt] = permissive
298
299     #____________________________________________________________
300     def setowner(self, owner):
301         ":param owner: sets the default value for owner at the Config level"
302         if not isinstance(owner, owners.Owner):
303             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
304         self._owner = owner
305
306     def getowner(self):
307         return self._owner
308
309     #____________________________________________________________
310     def _read(self, remove, append):
311         for prop in remove:
312             self.remove(prop)
313         for prop in append:
314             self.append(prop)
315
316     def read_only(self):
317         "convenience method to freeze, hidde and disable"
318         self._read(ro_remove, ro_append)
319
320     def read_write(self):
321         "convenience method to freeze, hidde and disable"
322         self._read(rw_remove, rw_append)
323
324     def _set_cache(self, opt, props):
325         if 'expire' in self:
326             self._cache[opt] = (props, time() + expires_time)
327             pass
328
329     def reset_cache(self, only_expired):
330         if only_expired:
331             exp = time()
332             keys = self._cache.keys()
333             for key in keys:
334                 props, created = self._cache[key]
335                 if exp > created:
336                     del(self._cache[key])
337         else:
338             self._cache.clear()
339
340
341 def apply_requires(opt, config):
342     "carries out the jit (just in time requirements between options"
343     def build_actions(requires):
344         "action are hide, show, enable, disable..."
345         trigger_actions = {}
346         for require in requires:
347             action = require[2]
348             trigger_actions.setdefault(action, []).append(require)
349         return trigger_actions
350     #for symlink
351     if hasattr(opt, '_requires') and opt._requires is not None:
352         # filters the callbacks
353         settings = config.cfgimpl_get_settings()
354         setting = Property(settings, settings._get_properties(opt, False), opt)
355         trigger_actions = build_actions(opt._requires)
356         optpath = config.cfgimpl_get_context().cfgimpl_get_description().objimpl_get_path_by_opt(opt)
357         for requires in trigger_actions.values():
358             matches = False
359             for require in requires:
360                 if len(require) == 3:
361                     path, expected, action = require
362                     inverse = False
363                 elif len(require) == 4:
364                     path, expected, action, inverse = require
365                 if path == optpath or path.startswith(optpath + '.'):
366                     raise RequirementRecursionError(_("malformed requirements "
367                                                     "imbrication detected for option: '{0}' "
368                                                     "with requirement on: '{1}'").format(optpath, path))
369                 try:
370                     value = config.cfgimpl_get_context()._getattr(path, force_permissive=True)
371                 except PropertiesOptionError, err:
372                     properties = err.proptype
373                     raise PropertiesOptionError(_("option '{0}' has requirement's property error: "
374                                                   "{1} {2}").format(opt._name, path, properties))
375                 except AttributeError:
376                     raise AttributeError(_("required option not found: "
377                                          "{0}").format(path))
378                 if value == expected:
379                     if inverse:
380                         setting.remove(action)
381                     else:
382                         setting.append(action)
383                     matches = True
384             # no requirement has been triggered, then just reverse the action
385             if not matches:
386                 if inverse:
387                     setting.append(action)
388                 else:
389                     setting.remove(action)