merge from master
[tiramisu.git] / tiramisu / value.py
1 # -*- coding: utf-8 -*-
2 "takes care of the option's values and multi values"
3 # Copyright (C) 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 # ____________________________________________________________
20 from time import time
21 from copy import copy
22 from tiramisu.error import ConfigError, SlaveError
23 from tiramisu.setting import owners, multitypes, expires_time
24 from tiramisu.autolib import carry_out_calculation
25 from tiramisu.i18n import _
26 from tiramisu.option import SymLinkOption
27
28
29 class Values(object):
30     """The `Config`'s root is indeed  in charge of the `Option()`'s values,
31     but the values are physicaly located here, in `Values`, wich is also
32     responsible of a caching utility.
33     """
34     __slots__ = ('context', '_p_')
35
36     def __init__(self, context, config_id, plugin_name):
37         """
38         Initializes the values's dict.
39
40         :param context: the context is the home config's values
41
42         """
43
44         self.context = context
45         import_lib = 'tiramisu.plugins.{0}.value'.format(plugin_name)
46         self._p_ = __import__(import_lib, globals(), locals(), ['Values'],
47                               -1).Values(config_id)
48
49     def _getkey(self, opt):
50         if self._p_.key_is_path:
51             return self._get_opt_path(opt)
52         else:
53             return opt
54
55     def _getdefault(self, opt):
56         meta = self.context.cfgimpl_get_meta()
57         if meta is not None:
58             value = meta.cfgimpl_get_values()[opt]
59         else:
60             value = opt.impl_getdefault()
61         if opt.impl_is_multi():
62             return copy(value)
63         else:
64             return value
65
66     def _getvalue(self, opt, validate=True):
67         "return value or default value if not set"
68         key = self._getkey(opt)
69         if not self._p_.hasvalue(key):
70             #if no value
71             value = self._getdefault(opt)
72             if opt.impl_is_multi():
73                 value = Multi(value, self.context, opt, validate)
74         else:
75             #if value
76             value = self._p_.getvalue(key)
77             if opt.impl_is_multi() and not isinstance(value, Multi):
78                 #load value so don't need to validate if is not a Multi
79                 value = Multi(value, self.context, opt, validate=False)
80         return value
81
82     def get_modified_values(self):
83         return self._p_.get_modified_values()
84
85     def __contains__(self, opt):
86         return self._p_.hasvalue('value', self._getkey(opt))
87
88     def __delitem__(self, opt):
89         self.reset(opt)
90
91     def reset(self, opt):
92         key = self._getkey(opt)
93         if self._p_.hasvalue(key):
94             setting = self.context.cfgimpl_get_settings()
95             opt.impl_validate(opt.impl_getdefault(), self.context,
96                               'validator' in setting)
97             self.context.cfgimpl_reset_cache()
98             if (opt.impl_is_multi() and
99                     opt.impl_get_multitype() == multitypes.master):
100                 for slave in opt.impl_get_master_slaves():
101                     self.reset(slave)
102             self._p_.resetvalue(key)
103
104     def _isempty(self, opt, value):
105         "convenience method to know if an option is empty"
106         empty = opt._empty
107         if (not opt.impl_is_multi() and (value is None or value == empty)) or \
108            (opt.impl_is_multi() and (value == [] or
109                                      None in value or empty in value)):
110             return True
111         return False
112
113     def _getcallback_value(self, opt, index=None):
114         callback, callback_params = opt._callback
115         if callback_params is None:
116             callback_params = {}
117         return carry_out_calculation(opt._name, config=self.context,
118                                      callback=callback,
119                                      callback_params=callback_params,
120                                      index=index)
121
122     def __getitem__(self, opt):
123         return self.getitem(opt)
124
125     def getitem(self, opt, validate=True, force_permissive=False,
126                 force_properties=None, validate_properties=True):
127         ntime = None
128         key = self._getkey(opt)
129         if self._p_.hascache('value', self._getkey(opt)):
130             ntime = time()
131             is_cached, value = self._p_.getcache('value', key, ntime)
132             if is_cached:
133                 if opt.impl_is_multi() and not isinstance(value, Multi):
134                     #load value so don't need to validate if is not a Multi
135                     value = Multi(value, self.context, opt, validate=False)
136                 return value
137         val = self._getitem(opt, validate, force_permissive, force_properties,
138                             validate_properties)
139         if 'expire' in self.context.cfgimpl_get_settings() and validate and \
140                 validate_properties and force_permissive is False and \
141                 force_properties is None:
142             if ntime is None:
143                 ntime = time()
144             self._p_.setcache('value', key, val, ntime + expires_time)
145
146         return val
147
148     def _getitem(self, opt, validate, force_permissive, force_properties,
149                  validate_properties):
150         # options with callbacks
151         setting = self.context.cfgimpl_get_settings()
152         is_frozen = 'frozen' in setting[opt]
153         # if value is callback and is not set
154         # or frozen with force_default_on_freeze
155         if opt.impl_has_callback() and (
156                 self.is_default_owner(opt) or
157                 (is_frozen and 'force_default_on_freeze' in setting[opt])):
158             no_value_slave = False
159             if (opt.impl_is_multi() and
160                     opt.impl_get_multitype() == multitypes.slave):
161                 masterp = self._get_opt_path(opt.impl_get_master_slaves())
162                 mastervalue = getattr(self.context, masterp)
163                 lenmaster = len(mastervalue)
164                 if lenmaster == 0:
165                     value = []
166                     no_value_slave = True
167
168             if not no_value_slave:
169                 value = self._getcallback_value(opt)
170                 if (opt.impl_is_multi() and
171                         opt.impl_get_multitype() == multitypes.slave):
172                     if not isinstance(value, list):
173                         value = [value for i in range(lenmaster)]
174             if opt.impl_is_multi():
175                 value = Multi(value, self.context, opt, validate)
176             #suppress value if already set
177             self.reset(opt)
178         # frozen and force default
179         elif is_frozen and 'force_default_on_freeze' in setting[opt]:
180             value = self._getdefault(opt)
181             if opt.impl_is_multi():
182                 value = Multi(value, self.context, opt, validate)
183         else:
184             value = self._getvalue(opt, validate)
185         if validate:
186             opt.impl_validate(value, self.context, 'validator' in setting)
187         if self.is_default_owner(opt) and \
188                 'force_store_value' in setting[opt]:
189             self.setitem(opt, value, is_write=False)
190         if validate_properties:
191             setting.validate_properties(opt, False, False, value=value,
192                                         force_permissive=force_permissive,
193                                         force_properties=force_properties)
194         return value
195
196     def __setitem__(self, opt, value):
197         self.setitem(opt, value)
198
199     def setitem(self, opt, value, force_permissive=False, is_write=True):
200         #is_write is, for example, used with "force_store_value"
201         #user didn't change value, so not write
202         #valid opt
203         opt.impl_validate(value, self.context,
204                           'validator' in self.context.cfgimpl_get_settings())
205         if opt.impl_is_multi() and not isinstance(value, Multi):
206             value = Multi(value, self.context, opt)
207         self._setvalue(opt, value, force_permissive=force_permissive,
208                        is_write=is_write)
209
210     def _setvalue(self, opt, value, force_permissive=False,
211                   force_properties=None,
212                   is_write=True, validate_properties=True):
213         self.context.cfgimpl_reset_cache()
214         if validate_properties:
215             setting = self.context.cfgimpl_get_settings()
216             setting.validate_properties(opt, False, is_write,
217                                         value=value,
218                                         force_permissive=force_permissive,
219                                         force_properties=force_properties)
220         owner = self.context.cfgimpl_get_settings().getowner()
221         self._p_.setvalue(self._getkey(opt), value, owner)
222
223     def getowner(self, opt):
224         if isinstance(opt, SymLinkOption):
225             opt = opt._opt
226         owner = self._p_.getowner(self._getkey(opt), owners.default)
227         meta = self.context.cfgimpl_get_meta()
228         if owner is owners.default and meta is not None:
229             owner = meta.cfgimpl_get_values().getowner(opt)
230         return owner
231
232     def setowner(self, opt, owner):
233         if not isinstance(owner, owners.Owner):
234             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
235         if self.getowner(opt) == owners.default:
236             raise ConfigError(_('no value for {0} cannot change owner to {1}'
237                                 '').format(opt._name, owner))
238         self._p_.setowner(self._getkey(opt), owner)
239
240     def is_default_owner(self, opt):
241         """
242         :param config: *must* be only the **parent** config
243                        (not the toplevel config)
244         :return: boolean
245         """
246         return self.getowner(opt) == owners.default
247
248     def reset_cache(self, only_expired):
249         if only_expired:
250             self._p_.reset_expired_cache('value', time())
251         else:
252             self._p_.reset_all_cache('value')
253
254     def _get_opt_path(self, opt):
255         return self.context.cfgimpl_get_description().impl_get_path_by_opt(opt)
256
257 # ____________________________________________________________
258 # multi types
259
260
261 class Multi(list):
262     """multi options values container
263     that support item notation for the values of multi options"""
264     __slots__ = ('opt', 'context')
265
266     def __init__(self, value, context, opt, validate=True):
267         """
268         :param value: the Multi wraps a list value
269         :param context: the home config that has the values
270         :param opt: the option object that have this Multi value
271         """
272         self.opt = opt
273         self.context = context
274         if not isinstance(value, list):
275             value = [value]
276         if validate and self.opt.impl_get_multitype() == multitypes.slave:
277             value = self._valid_slave(value)
278         elif self.opt.impl_get_multitype() == multitypes.master:
279             self._valid_master(value)
280         super(Multi, self).__init__(value)
281
282     def _valid_slave(self, value):
283         #if slave, had values until master's one
284         masterp = self.context.cfgimpl_get_description().impl_get_path_by_opt(
285             self.opt.impl_get_master_slaves())
286         mastervalue = getattr(self.context, masterp)
287         masterlen = len(mastervalue)
288         valuelen = len(value)
289         if valuelen > masterlen or (valuelen < masterlen and
290                                     not self.context.cfgimpl_get_values(
291                                     ).is_default_owner(self.opt)):
292             raise SlaveError(_("invalid len for the slave: {0}"
293                                " which has {1} as master").format(
294                                    self.opt._name, masterp))
295         elif valuelen < masterlen:
296             for num in range(0, masterlen - valuelen):
297                 value.append(self.opt.impl_getdefault_multi())
298         #else: same len so do nothing
299         return value
300
301     def _valid_master(self, value):
302         masterlen = len(value)
303         values = self.context.cfgimpl_get_values()
304         for slave in self.opt._master_slaves:
305             if not values.is_default_owner(slave):
306                 value_slave = values._getvalue(slave)
307                 if len(value_slave) > masterlen:
308                     raise SlaveError(_("invalid len for the master: {0}"
309                                        " which has {1} as slave with"
310                                        " greater len").format(
311                                            self.opt._name, slave._name))
312                 elif len(value_slave) < masterlen:
313                     for num in range(0, masterlen - len(value_slave)):
314                         value_slave.append(slave.impl_getdefault_multi(),
315                                            force=True)
316
317     def __setitem__(self, key, value):
318         self._validate(value)
319         #assume not checking mandatory property
320         super(Multi, self).__setitem__(key, value)
321         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
322
323     def append(self, value, force=False):
324         """the list value can be updated (appened)
325         only if the option is a master
326         """
327         if not force:
328             if self.opt.impl_get_multitype() == multitypes.slave:
329                 raise SlaveError(_("cannot append a value on a multi option {0}"
330                                    " which is a slave").format(self.opt._name))
331             elif self.opt.impl_get_multitype() == multitypes.master:
332                 values = self.context.cfgimpl_get_values()
333                 if value is None and self.opt.impl_has_callback():
334                     value = values._getcallback_value(self.opt)
335                     #Force None il return a list
336                     if isinstance(value, list):
337                         value = None
338         self._validate(value)
339         super(Multi, self).append(value)
340         self.context.cfgimpl_get_values()._setvalue(self.opt, self, validate_properties=not force)
341         if not force and self.opt.impl_get_multitype() == multitypes.master:
342             for slave in self.opt.impl_get_master_slaves():
343                 if not values.is_default_owner(slave):
344                     if slave.impl_has_callback():
345                         index = self.__len__() - 1
346                         dvalue = values._getcallback_value(slave, index=index)
347                     else:
348                         dvalue = slave.impl_getdefault_multi()
349                     old_value = values.getitem(slave, validate_properties=False)
350                     if len(old_value) < self.__len__():
351                         values.getitem(slave, validate_properties=False).append(
352                             dvalue, force=True)
353                     else:
354                         values.getitem(slave, validate_properties=False)[index] = dvalue
355
356     def sort(self, cmp=None, key=None, reverse=False):
357         if self.opt.impl_get_multitype() in [multitypes.slave,
358                                              multitypes.master]:
359             raise SlaveError(_("cannot sort multi option {0} if master or slave"
360                                "").format(self.opt._name))
361         super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
362         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
363
364     def reverse(self):
365         if self.opt.impl_get_multitype() in [multitypes.slave,
366                                              multitypes.master]:
367             raise SlaveError(_("cannot reverse multi option {0} if master or "
368                                "slave").format(self.opt._name))
369         super(Multi, self).reverse()
370         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
371
372     def insert(self, index, obj):
373         if self.opt.impl_get_multitype() in [multitypes.slave,
374                                              multitypes.master]:
375             raise SlaveError(_("cannot insert multi option {0} if master or "
376                                "slave").format(self.opt._name))
377         super(Multi, self).insert(index, obj)
378         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
379
380     def extend(self, iterable):
381         if self.opt.impl_get_multitype() in [multitypes.slave,
382                                              multitypes.master]:
383             raise SlaveError(_("cannot extend multi option {0} if master or "
384                                "slave").format(self.opt._name))
385         super(Multi, self).extend(iterable)
386         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
387
388     def _validate(self, value):
389         if value is not None:
390             try:
391                 self.opt._validate(value)
392             except ValueError, err:
393                 raise ValueError(_("invalid value {0} "
394                                    "for option {1}: {2}"
395                                    "").format(str(value),
396                                               self.opt._name, err))
397
398     def pop(self, key, force=False):
399         """the list value can be updated (poped)
400         only if the option is a master
401
402         :param key: index of the element to pop
403         :return: the requested element
404         """
405         if not force:
406             if self.opt.impl_get_multitype() == multitypes.slave:
407                 raise SlaveError(_("cannot pop a value on a multi option {0}"
408                                    " which is a slave").format(self.opt._name))
409             elif self.opt.impl_get_multitype() == multitypes.master:
410                 for slave in self.opt.impl_get_master_slaves():
411                     values = self.context.cfgimpl_get_values()
412                     if not values.is_default_owner(slave):
413                         #get multi without valid properties
414                         values.getitem(slave,
415                                        validate_properties=False
416                                        ).pop(key, force=True)
417         #set value without valid properties
418         ret = super(Multi, self).pop(key)
419         self.context.cfgimpl_get_values()._setvalue(self.opt, self, validate_properties=not force)
420         return ret