3
|
1 |
from __future__ import with_statement
|
0
|
2 |
#
|
|
3 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
4 |
# All rights reserved.
|
|
5 |
# This component and the accompanying materials are made available
|
|
6 |
# under the terms of "Eclipse Public License v1.0"
|
|
7 |
# which accompanies this distribution, and is available
|
|
8 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
9 |
#
|
|
10 |
# Initial Contributors:
|
|
11 |
# Nokia Corporation - initial contribution.
|
|
12 |
#
|
|
13 |
# Contributors:
|
|
14 |
#
|
|
15 |
# Description:
|
|
16 |
#
|
|
17 |
"""
|
|
18 |
Cone public API.
|
|
19 |
The core interface to the ConE functionality.
|
|
20 |
"""
|
|
21 |
|
|
22 |
import re
|
|
23 |
import sys
|
|
24 |
import logging
|
3
|
25 |
import mimetypes
|
|
26 |
|
|
27 |
from cone.public import exceptions, utils, container, mapping
|
|
28 |
|
|
29 |
def get_file_logger():
|
|
30 |
return logger
|
0
|
31 |
|
|
32 |
class Base(container.ObjectContainer):
|
|
33 |
"""
|
|
34 |
The Base class is intended for capturing same kind of naming scheme.
|
|
35 |
"""
|
|
36 |
|
|
37 |
|
|
38 |
def __init__(self, ref="", **kwargs):
|
|
39 |
if len(utils.dottedref.split_ref(ref)) > 1:
|
|
40 |
raise exceptions.InvalidRef("Invalid reference for Base object %s!" % ref)
|
|
41 |
self.ref = ref
|
|
42 |
container.ObjectContainer.__init__(self, ref)
|
3
|
43 |
try:
|
|
44 |
for arg in kwargs.keys():
|
|
45 |
if kwargs.get(arg) != None:
|
|
46 |
setattr(self, arg, kwargs.get(arg))
|
|
47 |
except AttributeError,e:
|
|
48 |
raise e
|
|
49 |
|
0
|
50 |
def __repr__(self):
|
|
51 |
dict = self._dict()
|
|
52 |
return "%s(%s)" % (self.__class__.__name__, dict)
|
|
53 |
|
3
|
54 |
# def __reduce_ex__(self, protocol_version):
|
|
55 |
# tpl = super(Base, self).__reduce_ex__(protocol_version)
|
|
56 |
# return tpl
|
|
57 |
|
|
58 |
# def __getstate__(self):
|
|
59 |
# state = self._dict(internals=True, ignore_empty=True)
|
|
60 |
# # pop out the _name so that it wont appear as redundant data (ref is the same)
|
|
61 |
# state.pop('_name', None)
|
|
62 |
# state.pop('_parent', None)
|
|
63 |
# return state
|
|
64 |
#
|
|
65 |
# def __setstate__(self, state):
|
|
66 |
# super(Base, self).__setstate__(state)
|
|
67 |
# self.ref = state.get('ref','')
|
|
68 |
# for arg in state.keys():
|
|
69 |
# self.__dict__.setdefault(arg, state.get(arg))
|
|
70 |
|
0
|
71 |
def _get_mapper(self,modelname):
|
|
72 |
"""
|
|
73 |
Return a instance of appropriate mapper for given model.
|
|
74 |
"""
|
|
75 |
return mapping.BaseMapper()
|
|
76 |
|
|
77 |
def _compare(self, other, dict_keys=None):
|
|
78 |
"""
|
|
79 |
Compare the attributes of elements
|
|
80 |
"""
|
|
81 |
if isinstance(other, Base):
|
|
82 |
keys = dict_keys or self._dict().keys()
|
|
83 |
for key in keys:
|
|
84 |
self_attr = None
|
|
85 |
other_attr = None
|
|
86 |
try:
|
|
87 |
self_attr = getattr(self, key)
|
|
88 |
other_attr = getattr(other, key)
|
|
89 |
except AttributeError:
|
|
90 |
# If the attribute is not found from either elements
|
|
91 |
# ignore it entirely
|
|
92 |
if self_attr == None and other_attr == None:
|
|
93 |
continue
|
|
94 |
if self_attr != other_attr:
|
|
95 |
return False
|
|
96 |
# If all given keys match report this as as similar element
|
|
97 |
return True
|
|
98 |
else:
|
|
99 |
return False
|
|
100 |
|
|
101 |
def _clone(self, **kwargs):
|
|
102 |
"""
|
|
103 |
A generic implementation for cloning the object.
|
|
104 |
Copies all (public) members in dictionary.
|
|
105 |
To clone objects recursively set the recursion level with recursion param.
|
|
106 |
@param recursion: Boolean to define recursion on or off
|
|
107 |
@param recursion_depth: positive integer to define recursion depth. default is -1 which will
|
|
108 |
perform recursion to all objects.
|
|
109 |
"""
|
|
110 |
dict = self._dict()
|
|
111 |
if kwargs.get('class_instance'):
|
|
112 |
class_instance = kwargs.get('class_instance')
|
|
113 |
del kwargs['class_instance']
|
|
114 |
else:
|
|
115 |
class_instance = self.__class__
|
|
116 |
obj = class_instance(**dict)
|
|
117 |
# Remove all children created at the construction phase
|
|
118 |
# This is needed when the recursion adds children to the object so that there are not duplicates
|
|
119 |
obj._order = []
|
|
120 |
obj._children = {}
|
|
121 |
|
|
122 |
# handle the recursion argument
|
|
123 |
recursion = kwargs.get('recursion', False)
|
|
124 |
if recursion:
|
|
125 |
recursion_depth = kwargs.get('recursion_depth', -1)
|
|
126 |
if recursion_depth < 0 or recursion_depth > 0:
|
|
127 |
# decrease the recursion
|
|
128 |
kwargs['recursion_depth'] = recursion_depth - 1
|
|
129 |
for child in self._objects():
|
|
130 |
obj._add(child._clone(**kwargs), container.APPEND)
|
|
131 |
return obj
|
|
132 |
|
3
|
133 |
def _dict(self, **kwargs):
|
0
|
134 |
"""
|
|
135 |
Return the public variables in a dictionary
|
|
136 |
"""
|
|
137 |
dict = {}
|
3
|
138 |
# loop through the items in this object internal __dict__
|
|
139 |
# and add all except internal variables and function overrides
|
|
140 |
for (key,value) in self.__dict__.items():
|
|
141 |
if not kwargs.get('internals', False) and key.startswith('_'):
|
0
|
142 |
continue
|
3
|
143 |
elif not kwargs.get('callables', False) and callable(value):
|
|
144 |
continue
|
|
145 |
elif kwargs.get('ignore_empty') and not value:
|
|
146 |
# ignore empty values
|
|
147 |
pass
|
0
|
148 |
else:
|
3
|
149 |
dict[key] = value
|
0
|
150 |
return dict
|
|
151 |
|
|
152 |
def _default_object(self, name):
|
|
153 |
return Base(name)
|
|
154 |
|
|
155 |
@property
|
|
156 |
def fqr(self):
|
|
157 |
"""
|
|
158 |
Return a Fully Qualified Ref, which is the full name of the reference.
|
|
159 |
Joins the namespace and ref to one string.
|
|
160 |
@return: A string
|
|
161 |
"""
|
|
162 |
return utils.dottedref.join_refs([self.namespace, self.get_ref()])
|
|
163 |
|
|
164 |
@property
|
|
165 |
def namespace(self):
|
|
166 |
"""
|
|
167 |
@return: The namespace of the object.
|
|
168 |
"""
|
|
169 |
containerpath = ""
|
|
170 |
path = ""
|
|
171 |
parentcontainer = self.find_parent(container=True)
|
|
172 |
parent = self.find_parent(type=Base)
|
|
173 |
paths = []
|
|
174 |
while parent and parent != parentcontainer:
|
|
175 |
""" Skip the element if it is supposed to be hidden. Begins with _. """
|
|
176 |
if not parent.get_ref().startswith('_'):
|
|
177 |
paths.append(parent.get_ref())
|
|
178 |
parent = parent._get_parent()
|
|
179 |
if parentcontainer:
|
|
180 |
paths.append(parentcontainer.namespace)
|
|
181 |
paths.reverse()
|
|
182 |
return utils.dottedref.join_refs(paths)
|
|
183 |
|
3
|
184 |
def path(self, toparent=None):
|
|
185 |
"""
|
|
186 |
Get the path to this Base object..
|
|
187 |
@param toparent: the _parent object up to which the path is relative. Default value is None.,
|
|
188 |
which gives the fully qualified path in the topology.
|
|
189 |
@return: The path to this Base object from toparent
|
|
190 |
"""
|
|
191 |
return self._path(toparent)
|
|
192 |
|
|
193 |
def parent_path(self, toparent=None):
|
|
194 |
"""
|
|
195 |
Get the path to the parent of this Base object..
|
|
196 |
@param toparent: the _parent object up to which the path is relative. Default value is None.,
|
|
197 |
which gives the fully qualified path in the topology.
|
|
198 |
@return: The path to this Base object from toparent
|
|
199 |
"""
|
|
200 |
if self._parent != None:
|
|
201 |
return self._parent.path(toparent)
|
|
202 |
else:
|
|
203 |
return ''
|
|
204 |
|
0
|
205 |
def get_fullref(self):
|
|
206 |
"""
|
|
207 |
Return a full reference, reference including a
|
|
208 |
possible index of the object in list.
|
|
209 |
e.g. ref can be bar[1] or just the normal bar.
|
|
210 |
|
|
211 |
@return: The full reference of the object.
|
|
212 |
"""
|
|
213 |
if self.parent and utils.is_list(self.parent._get(self.ref)):
|
|
214 |
return "%s[%s]" % (self.ref, self.get_index())
|
|
215 |
else:
|
|
216 |
return self.ref
|
|
217 |
|
|
218 |
def get_fullfqr(self):
|
|
219 |
"""
|
|
220 |
Return a full reference, reference including a
|
|
221 |
possible index of the object in list.
|
|
222 |
ref and adds index.
|
|
223 |
@return: A string
|
|
224 |
"""
|
|
225 |
return utils.dottedref.join_refs([self.get_fullnamespace(), self.get_fullref()])
|
|
226 |
|
|
227 |
def get_fullnamespace(self):
|
|
228 |
"""
|
|
229 |
@return: The full namespace of the object with possible indexes of the parent objects
|
|
230 |
"""
|
|
231 |
containerpath = ""
|
|
232 |
path = ""
|
|
233 |
parentcontainer = self.find_parent(container=True)
|
|
234 |
parent = self.find_parent(type=Base)
|
|
235 |
paths = []
|
|
236 |
while parent and parent != parentcontainer:
|
|
237 |
paths.append(parent.get_fullref())
|
|
238 |
parent = parent.parent
|
|
239 |
if parentcontainer:
|
|
240 |
paths.append(parentcontainer.namespace)
|
|
241 |
paths.reverse()
|
|
242 |
return utils.dottedref.join_refs(paths)
|
|
243 |
|
|
244 |
def get_storage(self):
|
|
245 |
"""
|
|
246 |
Get the root storage from the root object.
|
|
247 |
"""
|
|
248 |
if self._find_parent():
|
|
249 |
return self._find_parent().get_storage()
|
|
250 |
else:
|
|
251 |
raise exceptions.StorageException("Storage is not found from root!")
|
|
252 |
|
|
253 |
def get_project(self):
|
|
254 |
"""
|
|
255 |
Get the root project from the root object.
|
|
256 |
"""
|
|
257 |
if isinstance(self, Project):
|
|
258 |
return self
|
|
259 |
elif self._find_parent():
|
|
260 |
return self._find_parent().get_project()
|
|
261 |
else:
|
|
262 |
raise exceptions.NotFound("Project not found!!")
|
|
263 |
|
|
264 |
def get_default_view(self):
|
|
265 |
"""
|
|
266 |
Get the default view from the root object.
|
|
267 |
"""
|
|
268 |
try:
|
|
269 |
return self._find_parent().get_default_view()
|
|
270 |
except exceptions.NotFound:
|
|
271 |
raise exceptions.NotFound("Default View is not found! No root configuration?")
|
|
272 |
|
|
273 |
def get_root(self):
|
|
274 |
"""
|
|
275 |
Get the root object
|
|
276 |
"""
|
|
277 |
try:
|
|
278 |
return self._find_parent().get_root()
|
|
279 |
except exceptions.NotFound:
|
|
280 |
return self
|
|
281 |
|
|
282 |
def get_root_configuration(self):
|
|
283 |
"""
|
|
284 |
Get the root object
|
|
285 |
"""
|
|
286 |
if self.find_parent(type=Configuration):
|
|
287 |
return self.find_parent(type=Configuration).get_root_configuration()
|
|
288 |
elif isinstance(self, Configuration):
|
|
289 |
return self
|
|
290 |
else:
|
|
291 |
return None
|
|
292 |
|
3
|
293 |
def get_configuration(self):
|
|
294 |
"""
|
|
295 |
Return the containing configuration of this object.
|
|
296 |
"""
|
|
297 |
parent = self._find_parent_or_default(type=Configuration)
|
|
298 |
return parent
|
|
299 |
|
|
300 |
def get_configuration_path(self):
|
|
301 |
"""
|
|
302 |
Return the path of containing configuration of this object.
|
|
303 |
"""
|
|
304 |
parent = self._find_parent_or_default(type=Configuration)
|
|
305 |
try:
|
|
306 |
return parent.get_full_path()
|
|
307 |
except AttributeError:
|
|
308 |
return None
|
|
309 |
|
0
|
310 |
def get_index(self):
|
|
311 |
"""
|
|
312 |
@return : the index of the data element for sequential data defined inside the same configuration.
|
|
313 |
0 for normal data.
|
|
314 |
"""
|
|
315 |
# Get the list of items from parent which contains this element and ask my own index
|
|
316 |
# Make sure that the returned element is a list with get_list
|
|
317 |
selflist = utils.get_list(self._get_parent()._get(self.get_ref()))
|
|
318 |
return selflist.index(self)
|
|
319 |
|
|
320 |
def find_parent(self, **kwargs):
|
|
321 |
"""
|
|
322 |
find the closest parent object of given type.
|
|
323 |
e.g. find_parent(type=Configuration) returns the closest parent
|
|
324 |
Configuration parent instance
|
|
325 |
@param type: class definitiob
|
|
326 |
"""
|
|
327 |
type = kwargs.get('type', None)
|
|
328 |
container = kwargs.get('container', False)
|
|
329 |
try:
|
|
330 |
parent = self._find_parent()
|
|
331 |
if type and isinstance(parent, type):
|
|
332 |
return parent
|
|
333 |
elif container and hasattr(parent, 'container'):
|
|
334 |
return parent
|
|
335 |
else:
|
|
336 |
return parent.find_parent(**kwargs)
|
|
337 |
except exceptions.NotFound:
|
|
338 |
return None
|
|
339 |
|
|
340 |
def add(self, child, policy=container.REPLACE):
|
|
341 |
"""
|
|
342 |
A generic add function to add child objects. The function is intended to act as
|
|
343 |
proxy function that call the correct add function based on the child objects class.
|
|
344 |
|
|
345 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
346 |
@param child: the child object to add
|
|
347 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
348 |
"""
|
|
349 |
raise exceptions.NotSupportedException("Cannot add %s object to %s" % (child, self))
|
|
350 |
|
|
351 |
def get_elem(self, fqr):
|
|
352 |
"""
|
|
353 |
A generic get function to get child objects and members. The function uses getattr
|
|
354 |
to traverse downwards the the object tree. The returned object is the final object or attribute
|
|
355 |
if it is found. Raises AttributeError if the child is not found.
|
|
356 |
|
|
357 |
Example: obj.get('test.bar'), returns child obj.test.bar
|
|
358 |
@param fqr: the fully qualified ref to the object
|
|
359 |
@raise AttributeError: if the given ref is not found.
|
|
360 |
"""
|
|
361 |
return None
|
|
362 |
|
3
|
363 |
def get_store_interface(self):
|
|
364 |
# if the project cannot be retrieved return None
|
|
365 |
try:
|
|
366 |
return self.get_project()
|
|
367 |
except exceptions.NotFound:
|
|
368 |
return None
|
|
369 |
|
|
370 |
def get_id(self):
|
|
371 |
try:
|
|
372 |
return self._id
|
|
373 |
except AttributeError:
|
|
374 |
return None
|
|
375 |
|
|
376 |
def set_id(self,value):
|
|
377 |
self._id = value
|
|
378 |
|
|
379 |
def del_id(self):
|
|
380 |
delattr(self,'_id')
|
|
381 |
|
|
382 |
""" The id as a property """
|
|
383 |
id = property(get_id,set_id, del_id)
|
0
|
384 |
|
|
385 |
class Project(Base):
|
|
386 |
"""
|
|
387 |
A project is a container that can hold several Configuration objects.
|
|
388 |
"""
|
|
389 |
|
|
390 |
def __init__(self, storage, **kwargs):
|
|
391 |
"""
|
|
392 |
Project constructor
|
|
393 |
"""
|
|
394 |
Base.__init__(self, "")
|
|
395 |
""" Try to set the model and tet the actual configuration class """
|
|
396 |
try:
|
|
397 |
self._model = storage.persistentmodule.MODEL
|
|
398 |
except AttributeError:
|
|
399 |
self._model = None
|
3
|
400 |
self.loaded = {}
|
0
|
401 |
self.set_storage(storage)
|
|
402 |
self.update()
|
3
|
403 |
|
|
404 |
def __getstate__(self):
|
|
405 |
state = {}
|
|
406 |
state['storage'] = self.storage
|
|
407 |
return state
|
|
408 |
|
|
409 |
def __setstate__(self, state):
|
|
410 |
self.__init__(state['storage'])
|
0
|
411 |
|
|
412 |
def __add_loaded__(self, ref, obj):
|
|
413 |
"""
|
|
414 |
Add the object to loaded
|
|
415 |
"""
|
|
416 |
self.loaded[ref] = {'counter': 0, 'obj': obj}
|
|
417 |
|
|
418 |
def __get_loaded__(self, ref):
|
|
419 |
"""
|
|
420 |
Get a loaded object if it is existing and increase the reference counter
|
|
421 |
@param ref:
|
|
422 |
@return: The loaded object if it exists. None if it does not.
|
|
423 |
"""
|
|
424 |
if self.loaded.has_key(ref):
|
|
425 |
return self.loaded[ref]['obj']
|
|
426 |
else:
|
|
427 |
return None
|
|
428 |
|
|
429 |
def __loaded__(self, ref):
|
|
430 |
"""
|
|
431 |
Get a loaded object if it is existing and increase the reference counter
|
|
432 |
@param ref:
|
|
433 |
@return: The loaded object if it exists. None if it does not.
|
|
434 |
"""
|
|
435 |
if self.loaded.has_key(ref):
|
|
436 |
self.loaded[ref]['counter'] += 1
|
|
437 |
else:
|
|
438 |
raise exceptions.NotFound("ref %s is not found from loaded!" % ref)
|
|
439 |
|
|
440 |
def __unloaded__(self, ref):
|
|
441 |
"""
|
|
442 |
returns True when the reference count is zero and object can be released.
|
|
443 |
"""
|
|
444 |
if self.loaded.has_key(ref):
|
|
445 |
self.loaded[ref]['counter'] -= 1
|
|
446 |
if self.loaded[ref]['counter'] == 0:
|
|
447 |
del self.loaded[ref]
|
|
448 |
return True
|
|
449 |
else:
|
|
450 |
return False
|
3
|
451 |
else:
|
|
452 |
# Return False in case the object is loaded at all in this project
|
|
453 |
# increases performance as unloading is not done on unchanged objects
|
|
454 |
return False
|
0
|
455 |
|
|
456 |
def _supported_type(self, obj):
|
|
457 |
if isinstance(obj, Configuration) \
|
|
458 |
or isinstance(obj, ConfigurationProxy):
|
|
459 |
return True
|
|
460 |
else:
|
|
461 |
return False
|
|
462 |
|
|
463 |
|
|
464 |
def update(self):
|
|
465 |
"""
|
|
466 |
update the root confml files as configurations
|
|
467 |
"""
|
|
468 |
root_confmls = self.get_storage().list_resources(".")
|
|
469 |
root_confmls = utils.resourceref.filter_resources(root_confmls, "\.confml")
|
|
470 |
for rootml in root_confmls:
|
|
471 |
self._add(ConfigurationProxy(rootml))
|
|
472 |
|
|
473 |
def get_storage(self):
|
|
474 |
"""
|
|
475 |
Get the Storage instance of this Project.
|
|
476 |
"""
|
|
477 |
return self.storage
|
|
478 |
|
|
479 |
def set_storage(self, storage):
|
|
480 |
"""
|
|
481 |
Set the Storage instance of this Project.
|
|
482 |
"""
|
3
|
483 |
if storage != None and not isinstance(storage, Storage):
|
0
|
484 |
raise exceptions.StorageException("The given storage is not a instance of Storage!")
|
3
|
485 |
self.storage = storage
|
0
|
486 |
|
|
487 |
def list_configurations(self, filter_or_filters=None):
|
|
488 |
"""
|
|
489 |
List the direct child objects of the project (Root configurations)
|
|
490 |
@param filter_or_filters: A regular expression or list of regular expressions
|
|
491 |
used for filtering the configuration paths. If None, all configurations are
|
|
492 |
returned.
|
|
493 |
@return: a list for configuration file paths
|
|
494 |
"""
|
|
495 |
filters = None
|
|
496 |
if isinstance(filter_or_filters, basestring): filters = [filter_or_filters]
|
|
497 |
elif filter_or_filters is not None: filters = filter_or_filters
|
|
498 |
|
|
499 |
configs = [obj.get_path() for obj in self._objects()]
|
|
500 |
|
|
501 |
if filters is not None:
|
|
502 |
result = []
|
|
503 |
for config in configs:
|
|
504 |
for filter in filters:
|
|
505 |
if re.match(filter, config) is not None:
|
|
506 |
result.append(config)
|
|
507 |
break
|
|
508 |
return result
|
|
509 |
else:
|
|
510 |
return configs
|
|
511 |
|
|
512 |
def list_all_configurations(self):
|
|
513 |
"""
|
|
514 |
List all configuration objects of the project (all configurations)
|
|
515 |
@return: a list for configuration file paths
|
|
516 |
"""
|
3
|
517 |
# TODO
|
|
518 |
# huge performance problem
|
|
519 |
return [obj.get_full_path() for obj in self._traverse(type=(Configuration, ConfigurationProxy))]
|
0
|
520 |
|
|
521 |
def get_configuration(self, path):
|
|
522 |
"""
|
|
523 |
Get a configuration object from the given path
|
|
524 |
@param path: path to configuration
|
|
525 |
@return: a instance of Configuration.
|
|
526 |
"""
|
|
527 |
# Load the configuration object if it is not already loaded
|
|
528 |
try:
|
|
529 |
return self._get(utils.resourceref.to_objref(utils.resourceref.norm(path)))
|
|
530 |
except exceptions.NotFound, e:
|
|
531 |
if self.storage.is_resource(utils.resourceref.norm(path)):
|
|
532 |
proxy = ConfigurationProxy(utils.resourceref.norm(path))
|
|
533 |
proxy._set_parent(self)
|
|
534 |
return proxy
|
|
535 |
else:
|
|
536 |
raise e
|
|
537 |
|
|
538 |
def is_configuration(self, path):
|
|
539 |
"""
|
|
540 |
Return true if the given path is a configuration object in this Project.
|
|
541 |
@param path: path to configuration
|
|
542 |
@return: Boolean return value.
|
|
543 |
"""
|
|
544 |
# Changed from list_all_configurations to list_configurations
|
|
545 |
# (list_all_configurations causes a insane performance problem with _traverse)
|
3
|
546 |
#
|
|
547 |
try:
|
|
548 |
return self.storage.is_resource(path)
|
|
549 |
except exceptions.NotSupportedException:
|
|
550 |
return path in self.list_configurations()
|
|
551 |
|
|
552 |
def add_configuration(self, config, overwrite_existing=False):
|
0
|
553 |
"""
|
|
554 |
Add a Configuration object to this project
|
3
|
555 |
@param config: The configuration object to add
|
|
556 |
@param overwrite_existing: When this is set true any existing configuration is
|
|
557 |
overwritten.
|
|
558 |
"""
|
0
|
559 |
if isinstance(config, Configuration):
|
3
|
560 |
if not overwrite_existing and self.is_configuration(config.get_path()):
|
0
|
561 |
raise exceptions.AlreadyExists("%s" % config.get_path())
|
3
|
562 |
|
|
563 |
proxy = ConfigurationProxy(config.path)
|
|
564 |
proxy._set_obj(config)
|
|
565 |
self._add(proxy)
|
|
566 |
#self._add(config)
|
0
|
567 |
self.__add_loaded__(config.get_path(), config)
|
|
568 |
self.__loaded__(config.get_path())
|
|
569 |
else:
|
|
570 |
raise exceptions.IncorrectClassError("Only Configuration instance can be added to Project!")
|
|
571 |
|
3
|
572 |
def create_configuration(self, path, overwrite_existing=False, **kwargs):
|
0
|
573 |
"""
|
|
574 |
Create a Configuration object to this project
|
3
|
575 |
@param path: The path of the new configuration file
|
|
576 |
@param overwrite_existing: When this is set true any existing configuration is
|
|
577 |
overwritten.
|
|
578 |
@param **kwargs: normal keyword arguments that are passed on to the newly
|
|
579 |
created Configuration object. See Configuration object constructor description on what
|
|
580 |
you can pass on here.
|
|
581 |
"""
|
|
582 |
config = self.get_configuration_class()(utils.resourceref.norm(path), **kwargs)
|
|
583 |
self.add_configuration(config, overwrite_existing)
|
0
|
584 |
return config
|
|
585 |
|
|
586 |
def remove_configuration(self, path):
|
|
587 |
"""
|
|
588 |
Remove a Configuration by its reference
|
|
589 |
"""
|
|
590 |
# remove configuration as an object and try to remove it from the storage
|
|
591 |
self._remove(utils.resourceref.to_objref(path))
|
|
592 |
try:
|
|
593 |
self.storage.delete_resource(path)
|
|
594 |
except exceptions.NotSupportedException:
|
|
595 |
pass
|
|
596 |
return
|
|
597 |
|
|
598 |
def import_configuration(self, configuration):
|
|
599 |
"""
|
|
600 |
Import a configuration object from another storage
|
|
601 |
"""
|
|
602 |
self.storage.import_resources(configuration.list_resources(), configuration.get_storage())
|
|
603 |
return
|
|
604 |
|
3
|
605 |
def export_configuration(self, configuration, export_storage, **kwargs):
|
0
|
606 |
"""
|
|
607 |
Export a configuration object to another storage
|
|
608 |
"""
|
|
609 |
# First clone the configuration and then import the rest of the configuration resources
|
|
610 |
if isinstance(configuration, ConfigurationProxy):
|
|
611 |
configuration = configuration._get_obj()
|
|
612 |
|
|
613 |
export_storage.unload(configuration.get_full_path(),configuration)
|
|
614 |
for child in configuration._traverse(type=Configuration):
|
|
615 |
export_storage.unload(child.get_full_path(),child)
|
|
616 |
|
|
617 |
#If the configuration is not in the root of the project adding the path
|
|
618 |
#to final exporting source path.
|
|
619 |
#l = []
|
|
620 |
cpath = utils.resourceref.get_path(configuration.get_path())
|
|
621 |
resr = [utils.resourceref.join_refs([cpath,related]) \
|
3
|
622 |
for related in configuration.get_layer().list_all_related(**kwargs)]
|
|
623 |
|
|
624 |
self.storage.export_resources(resr ,export_storage, kwargs.get("empty_folders", False))
|
0
|
625 |
return
|
|
626 |
|
|
627 |
def get_configuration_class(self):
|
|
628 |
"""
|
|
629 |
return the default configuration class that is used with the model.
|
|
630 |
"""
|
|
631 |
return utils.get_class(self._model, Configuration)
|
|
632 |
|
|
633 |
def save(self):
|
|
634 |
"""
|
|
635 |
Save the object to the permanent Storage object. Calls the save operation for
|
|
636 |
all the children and also for the Storage.
|
|
637 |
"""
|
|
638 |
for child in self._objects():
|
|
639 |
if isinstance(child, (Configuration, ConfigurationProxy)):
|
|
640 |
child.save()
|
|
641 |
self.storage.save()
|
|
642 |
|
|
643 |
def close(self):
|
|
644 |
"""
|
|
645 |
Close the Project.
|
|
646 |
"""
|
|
647 |
for child in self._objects():
|
|
648 |
if isinstance(child, (Configuration, ConfigurationProxy)):
|
|
649 |
child.close()
|
|
650 |
self.storage.close()
|
|
651 |
|
|
652 |
def load(self, path):
|
|
653 |
"""
|
|
654 |
Load an object from a reference. The given reference is loaded once from storage
|
|
655 |
and stored as a loaded object to the Project. Sequential loads to the same ref will
|
|
656 |
return the same object.
|
|
657 |
@param path: The reference where to load the object
|
|
658 |
@raise StorageException: if the given object cannot be loaded as an
|
|
659 |
object from this storage
|
|
660 |
"""
|
|
661 |
if not self.__get_loaded__(path):
|
|
662 |
configuration = self.get_storage().load(path)
|
|
663 |
if configuration.get_ref() == 'unknown':
|
3
|
664 |
configuration.set_ref(utils.resourceref.to_dref(path))
|
0
|
665 |
self.__add_loaded__(path, configuration)
|
|
666 |
""" increase the ref counter """
|
|
667 |
self.__loaded__(path)
|
|
668 |
return self.__get_loaded__(path)
|
|
669 |
|
|
670 |
def unload(self, path, object):
|
|
671 |
"""
|
|
672 |
Release the given ref, which decreases the reference counter of the given ref.
|
|
673 |
@param path: The reference where to store the object
|
|
674 |
@param object: The object instance to dump
|
|
675 |
@raise StorageException: if the given object cannot be dumped to this storage
|
|
676 |
"""
|
|
677 |
if self.__unloaded__(path):
|
|
678 |
self.get_storage().unload(path, object)
|
3
|
679 |
# remove the configuration from this this project,
|
|
680 |
# with proxy set the _obj reference to None
|
|
681 |
try:
|
|
682 |
conf = self.get_configuration(path)
|
|
683 |
if isinstance(conf, ConfigurationProxy):
|
|
684 |
conf._set_obj(None)
|
|
685 |
except exceptions.NotFound:
|
|
686 |
# if the configuration is not found at all then ignore the resetting
|
|
687 |
pass
|
0
|
688 |
|
|
689 |
def get_path(self):
|
|
690 |
"""
|
|
691 |
Return the path of the project, which is always root
|
|
692 |
"""
|
|
693 |
return ""
|
|
694 |
|
|
695 |
|
|
696 |
class CompositeConfiguration(Base):
|
|
697 |
"""
|
|
698 |
A base class for composite Configuration objects.
|
|
699 |
"""
|
|
700 |
def __init__(self, ref="", **kwargs):
|
|
701 |
# self.meta = {}
|
|
702 |
# self.desc = ""
|
|
703 |
super(CompositeConfiguration, self).__init__(ref, **kwargs)
|
|
704 |
self.container = True
|
|
705 |
|
3
|
706 |
def _configuration_class(self):
|
|
707 |
return Configuration
|
|
708 |
|
0
|
709 |
def add_configuration(self, config):
|
|
710 |
"""
|
|
711 |
Add an existing Configuration to this configuration
|
|
712 |
@param config: A Configuration instance:
|
|
713 |
@return: None
|
|
714 |
"""
|
|
715 |
"""
|
|
716 |
Merge the default view features from added config to this configs _default_view.
|
|
717 |
"""
|
3
|
718 |
# if the Configuration has a separate resource path, add it automatically behind proxy
|
|
719 |
if utils.resourceref.is_path(config.path) and isinstance(config, Configuration):
|
|
720 |
proxy = ConfigurationProxy(config.path)
|
|
721 |
proxy._set_obj(config)
|
|
722 |
self._add(proxy)
|
|
723 |
# Add the new configuration to the list of "modified/loaded" configurations
|
|
724 |
try:
|
|
725 |
prj = self.get_project()
|
|
726 |
prj.__add_loaded__(config.get_full_path(), config)
|
|
727 |
prj.__loaded__(config.get_full_path())
|
|
728 |
except exceptions.NotFound:
|
|
729 |
# if the parent is not found this configuration is not (yet) a part of project and cant be stored
|
|
730 |
pass
|
|
731 |
else:
|
|
732 |
self._add(config)
|
|
733 |
|
|
734 |
def include_configuration(self, configref, policy=0):
|
0
|
735 |
"""
|
|
736 |
Add an existing Configuration to this configuration by its resource reference
|
|
737 |
@param config: A Configuration instance:
|
|
738 |
@return: None
|
|
739 |
"""
|
|
740 |
# add the configuration load proxy to this configuration instead
|
|
741 |
# adding the configuration directly
|
3
|
742 |
self._add(ConfigurationProxy(configref), policy)
|
0
|
743 |
|
|
744 |
def create_configuration(self, path):
|
|
745 |
"""
|
|
746 |
Create a new configuration by its name to the Configuration.
|
|
747 |
1. Create new Configuration object
|
|
748 |
2. Create new ConfigurationProxy
|
|
749 |
3. Add proxy to this object
|
|
750 |
4. Set proxy to point to the created Configuration object
|
|
751 |
@param path: The reference of the configuration to create
|
|
752 |
@return: The new configuration object.
|
|
753 |
"""
|
|
754 |
# normalise the path
|
|
755 |
normpath = utils.resourceref.norm(path)
|
3
|
756 |
cklass = self._configuration_class()
|
0
|
757 |
conf = cklass(normpath, namespace=self.namespace)
|
3
|
758 |
self.add_configuration(conf)
|
0
|
759 |
return conf
|
|
760 |
|
|
761 |
def remove_configuration(self, path):
|
|
762 |
"""
|
|
763 |
Remove a Layer object from the Configuration by its reference.
|
|
764 |
"""
|
|
765 |
self._remove(utils.resourceref.to_objref(path))
|
|
766 |
|
|
767 |
def list_configurations(self):
|
|
768 |
"""
|
|
769 |
List all Layer objects in the Configuration
|
|
770 |
@return: a copy array of layer references.
|
|
771 |
"""
|
|
772 |
return [config.get_path() for config in self._objects(type=(Configuration, ConfigurationProxy))]
|
|
773 |
|
|
774 |
def list_all_configurations(self):
|
|
775 |
"""
|
|
776 |
List all Layer objects in the Configuration
|
|
777 |
@return: a copy array of layer references.
|
|
778 |
"""
|
3
|
779 |
return [config.get_path_for_parent(self) for config in self._traverse(type=(Configuration, ConfigurationProxy))]
|
0
|
780 |
|
|
781 |
def get_configuration(self, path):
|
|
782 |
"""
|
|
783 |
Get a Layer object by if path
|
|
784 |
@return: a Layer object
|
|
785 |
"""
|
|
786 |
return self._get(utils.resourceref.to_objref(path))
|
|
787 |
|
|
788 |
def get_configuration_by_index(self, index):
|
|
789 |
"""
|
|
790 |
Get a Layer object by if indexing number
|
|
791 |
@return: a Layer object
|
|
792 |
"""
|
|
793 |
configs = self._objects(type=(Configuration, ConfigurationProxy))
|
|
794 |
return configs[index]
|
|
795 |
|
|
796 |
def get_last_configuration(self):
|
|
797 |
"""
|
|
798 |
Get the last Layer object from this configuration hierarchy.
|
|
799 |
@return: a Layer object
|
|
800 |
"""
|
|
801 |
last_config = self
|
|
802 |
try:
|
|
803 |
last_config = last_config.get_configuration_by_index(-1)
|
|
804 |
return last_config.get_last_configuration()
|
|
805 |
except IndexError:
|
|
806 |
return self
|
|
807 |
|
|
808 |
def add(self, child, policy=container.REPLACE):
|
|
809 |
"""
|
|
810 |
A generic add function to add child objects. The function is intended to act as
|
|
811 |
proxy function that call the correct add function based on the child objects class.
|
|
812 |
|
|
813 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
814 |
@param child: the child object to add
|
|
815 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
816 |
"""
|
|
817 |
if isinstance(child, Configuration):
|
|
818 |
self.add_configuration(child)
|
|
819 |
elif isinstance(child, ConfigurationProxy):
|
3
|
820 |
self._add(child)
|
0
|
821 |
elif isinstance(child, Base):
|
|
822 |
self._add(child)
|
|
823 |
else:
|
|
824 |
raise exceptions.IncorrectClassError("Cannot add %s to %s" % (child, self))
|
|
825 |
|
3
|
826 |
def layered_resources(self, layers=None, empty_folders=False, folder=None, resource_type=None):
|
|
827 |
"""
|
|
828 |
Fetch resource paths by layers so that if a resource with the same name
|
|
829 |
exists on multiple layers, the one on the latest layer is the active one.
|
|
830 |
@param layers: List of layer indices to specify the layer to use, None
|
|
831 |
for all layers.
|
|
832 |
@param empty_folders: If True, empty folders are returned also.
|
|
833 |
@param folder: Name of a specific folder from which to get resources, or None.
|
|
834 |
If None, resource_type must be specified.
|
|
835 |
@param resource_type: Type of the resources to find. Must be one of
|
|
836 |
('confml', 'implml', 'content', 'doc') or None.
|
|
837 |
If None, folder must be specified.
|
|
838 |
@return: A container.DataContainer instance containing the resource paths.
|
|
839 |
For example: {'foo.txt': ['layer1/content/foo.txt',
|
|
840 |
'layer2/content/foo.txt'],
|
|
841 |
'bar.txt': ['layer1/content/bar.txt']}
|
|
842 |
"""
|
|
843 |
MAPPING = {'confml': lambda layer: layer.confml_folder(),
|
|
844 |
'implml': lambda layer: layer.implml_folder(),
|
|
845 |
'content': lambda layer: layer.content_folder(),
|
|
846 |
'doc': lambda layer: layer.doc_folder()}
|
|
847 |
if resource_type is not None and resource_type not in MAPPING:
|
|
848 |
raise ValueError("Invalid resource type %r, should be one of %r" % (resource_type, MAPPING.keys()))
|
|
849 |
|
|
850 |
if folder and resource_type:
|
|
851 |
raise ValueError('Only one of folder and resource_type must be specified!')
|
|
852 |
if not folder and not resource_type:
|
|
853 |
raise ValueError('Either folder or resource_type must be specified!')
|
|
854 |
|
0
|
855 |
configuration_array = []
|
|
856 |
if layers == None:
|
|
857 |
configuration_array = self.list_configurations()
|
|
858 |
else:
|
|
859 |
all = self.list_configurations()
|
|
860 |
for i in layers:
|
|
861 |
configuration_array.append(all[i])
|
3
|
862 |
|
|
863 |
# Add the current configuration as the last one in the list, in case
|
|
864 |
# the current configuration happens to be a layer root itself
|
|
865 |
configuration_array.append('')
|
|
866 |
|
|
867 |
# Set up the get_folder function based on the parameters
|
|
868 |
if resource_type:
|
|
869 |
get_folder = MAPPING[resource_type]
|
|
870 |
else:
|
|
871 |
def get_folder(layer):
|
|
872 |
cpath = layer.get_current_path()
|
|
873 |
return Folder(layer.storage, utils.resourceref.join_refs([cpath, folder]))
|
|
874 |
|
|
875 |
result = container.DataContainer()
|
0
|
876 |
for configuration_path in configuration_array:
|
3
|
877 |
folder_obj = get_folder(self.get_configuration(configuration_path).get_layer())
|
|
878 |
folder_path = folder_obj.get_current_path()
|
|
879 |
for res_path in folder_obj.list_resources("", recurse=True, empty_folders=empty_folders):
|
|
880 |
if res_path == '': continue # ZipStorage sometimes returns empty paths
|
|
881 |
res_fullpath = utils.resourceref.join_refs([folder_path, res_path])
|
|
882 |
result.add_value(res_path, res_fullpath)
|
|
883 |
return result
|
|
884 |
|
|
885 |
def layered_confml(self, layers=None, empty_folders=False):
|
|
886 |
return self.layered_resources(layers, empty_folders, resource_type='confml')
|
|
887 |
|
|
888 |
def layered_implml(self, layers=None, empty_folders=False):
|
|
889 |
return self.layered_resources(layers, empty_folders, resource_type='implml')
|
|
890 |
|
|
891 |
def layered_content(self, layers=None, empty_folders=False):
|
|
892 |
return self.layered_resources(layers, empty_folders, resource_type='content')
|
|
893 |
|
|
894 |
def layered_doc(self, layers=None, empty_folders=False):
|
|
895 |
return self.layered_resources(layers, empty_folders, resource_type='doc')
|
|
896 |
|
|
897 |
|
|
898 |
|
0
|
899 |
class Configuration(CompositeConfiguration):
|
|
900 |
"""
|
|
901 |
A Configuration is a container that can hold several Layer objects.
|
|
902 |
"""
|
|
903 |
|
|
904 |
def __init__(self, ref="", **kwargs):
|
|
905 |
self.path = kwargs.get('path') or ref
|
|
906 |
self.namespace = kwargs.get('namespace', '')
|
3
|
907 |
self.name = kwargs.get('name',utils.resourceref.to_objref(self.path))
|
|
908 |
self.version = kwargs.get('version')
|
|
909 |
super(Configuration, self).__init__(utils.resourceref.to_objref(self.path), **kwargs)
|
0
|
910 |
self.container = True
|
|
911 |
|
|
912 |
def _default_object(self, name):
|
3
|
913 |
return self._default_class()(name)
|
|
914 |
|
|
915 |
def _default_class(self):
|
|
916 |
return self._feature_class()
|
|
917 |
|
|
918 |
def _feature_class(self):
|
|
919 |
return Feature
|
|
920 |
|
|
921 |
def _view_class(self):
|
|
922 |
return View
|
0
|
923 |
|
|
924 |
def _supported_type(self, obj):
|
|
925 |
if isinstance(obj, Configuration) \
|
|
926 |
or isinstance(obj, Feature) \
|
|
927 |
or isinstance(obj, Data) \
|
|
928 |
or isinstance(obj, ConfigurationProxy) \
|
|
929 |
or isinstance(obj, View) \
|
|
930 |
or isinstance(obj, Base):
|
|
931 |
return True
|
|
932 |
else:
|
|
933 |
return False
|
|
934 |
|
3
|
935 |
def _dict(self, **kwargs):
|
0
|
936 |
"""
|
|
937 |
Return the public variables in a dictionary
|
|
938 |
"""
|
3
|
939 |
dict = super(Configuration, self)._dict(**kwargs)
|
0
|
940 |
dict['namespace'] = self.namespace
|
|
941 |
return dict
|
|
942 |
|
|
943 |
def get_name(self):
|
|
944 |
"""
|
|
945 |
Return the name of the configuration
|
|
946 |
"""
|
|
947 |
return self.name
|
|
948 |
|
|
949 |
def set_name(self, name):
|
|
950 |
"""
|
|
951 |
Set the name
|
|
952 |
"""
|
|
953 |
self.name = name
|
|
954 |
|
|
955 |
def get_path(self):
|
|
956 |
"""
|
|
957 |
Return the path of the configuration resource
|
|
958 |
"""
|
|
959 |
return self.path
|
|
960 |
|
|
961 |
def set_path(self, path):
|
|
962 |
"""
|
|
963 |
Set the path of the configuration resource, and update the name and ref to correspond
|
|
964 |
"""
|
|
965 |
self.path = path
|
|
966 |
self.set_ref(utils.resourceref.to_objref(self.path))
|
|
967 |
|
|
968 |
def get_full_path(self):
|
|
969 |
"""
|
|
970 |
Return the path of the configuration resource
|
|
971 |
"""
|
|
972 |
try:
|
|
973 |
parentconfig = self._find_parent(type=Configuration)
|
|
974 |
parent_path = utils.resourceref.get_path(parentconfig.get_path())
|
|
975 |
except exceptions.NotFound:
|
|
976 |
parent_path = ""
|
3
|
977 |
return utils.resourceref.join_refs([parent_path, self.path])
|
|
978 |
|
|
979 |
def get_path_for_parent(self, parent):
|
|
980 |
"""
|
|
981 |
Return the path to this configuration for a defined parent Configuration object.
|
|
982 |
"""
|
|
983 |
parent_path = ""
|
|
984 |
try:
|
|
985 |
parentconfig = self._find_parent(type=Configuration)
|
|
986 |
if parent != parentconfig:
|
|
987 |
parent_path = utils.resourceref.get_path(parentconfig.get_path_for_parent(parent))
|
|
988 |
except exceptions.NotFound:
|
|
989 |
pass
|
0
|
990 |
return utils.resourceref.join_refs([parent_path, self.path])
|
|
991 |
|
|
992 |
def get_layer(self):
|
|
993 |
"""
|
|
994 |
Get the layer object where this Configuration is located.
|
|
995 |
"""
|
|
996 |
if not hasattr(self, "layer"):
|
|
997 |
layerpath = utils.resourceref.get_path(self.get_path())
|
|
998 |
# hardcoded removal of confml folder from the layer path it is there
|
|
999 |
layerpath = utils.resourceref.remove_end(layerpath, '/confml')
|
|
1000 |
self.layer = Layer(self.get_storage(), layerpath)
|
|
1001 |
""" Add the sublayers to this layer if they are different from this configuration """
|
|
1002 |
for configpath in self.list_configurations():
|
|
1003 |
sublayer_path = utils.resourceref.get_path(self.get_configuration(configpath).get_full_path())
|
|
1004 |
sublayer_path = utils.resourceref.remove_end(sublayer_path, '/confml')
|
|
1005 |
if sublayer_path != utils.resourceref.get_path(self.get_path()):
|
|
1006 |
self.layer.add_layer(self.get_configuration(configpath).get_layer())
|
|
1007 |
return self.layer
|
|
1008 |
|
|
1009 |
def set_namespace(self, namespace):
|
|
1010 |
"""
|
|
1011 |
@param namespace: The new namespace of the object
|
|
1012 |
"""
|
|
1013 |
self._namespace = namespace
|
|
1014 |
|
|
1015 |
def get_namespace(self):
|
|
1016 |
"""
|
|
1017 |
@return: The reference of the object.
|
|
1018 |
"""
|
|
1019 |
return self._namespace
|
|
1020 |
|
|
1021 |
def del_namespace(self):
|
|
1022 |
"""
|
|
1023 |
@return: The reference of the object.
|
|
1024 |
"""
|
|
1025 |
self._namespace = None
|
|
1026 |
namespace = property(get_namespace, set_namespace, del_namespace)
|
|
1027 |
|
3
|
1028 |
def list_resources(self, **kwargs):
|
0
|
1029 |
"""
|
|
1030 |
List all resources used in this configuration
|
|
1031 |
"""
|
|
1032 |
"""
|
|
1033 |
1. First ensure that all configuration resource files are added
|
|
1034 |
2. Then add all layer resources
|
|
1035 |
3. Make the list distinct
|
|
1036 |
"""
|
|
1037 |
|
|
1038 |
|
|
1039 |
resources = [self.get_full_path()]
|
3
|
1040 |
for config in self._traverse(type=(Configuration,ConfigurationProxy)):
|
0
|
1041 |
resources.append(config.get_full_path())
|
|
1042 |
layer = self.get_layer()
|
3
|
1043 |
for resref in layer.list_all_resources():
|
0
|
1044 |
resources.append(utils.resourceref.join_refs([layer.get_current_path(), resref]))
|
|
1045 |
|
|
1046 |
return utils.distinct_array(resources)
|
|
1047 |
|
|
1048 |
def get_resource(self, ref, mode="r"):
|
|
1049 |
"""
|
|
1050 |
Get the given resource as a Resource object. The resource is searched relative to the
|
|
1051 |
Configuration path, e.g. Configuration('test/foo/root.confml') => searches from 'test/foo'.
|
|
1052 |
@param ref: the reference path to the requested resource
|
|
1053 |
@return: a instance of Resource.
|
|
1054 |
"""
|
|
1055 |
mypath = utils.resourceref.get_path(self.path)
|
|
1056 |
myref = utils.resourceref.join_refs([mypath, ref])
|
|
1057 |
return self.get_storage().open_resource(myref, mode)
|
|
1058 |
|
|
1059 |
def get_all_resources(self):
|
|
1060 |
"""
|
|
1061 |
Get all resources in resource list of Resource objects
|
|
1062 |
"""
|
|
1063 |
resources = []
|
|
1064 |
res_list = self.list_resources()
|
|
1065 |
for res in res_list:
|
|
1066 |
resources.append(self.get_storage().open_resource(res))
|
|
1067 |
return resources
|
|
1068 |
|
|
1069 |
def get_root_resource(self):
|
|
1070 |
"""
|
|
1071 |
Get the configuration reference resource.
|
|
1072 |
"""
|
|
1073 |
return self.get_storage().open_resource(self.get_path())
|
|
1074 |
|
|
1075 |
def get_feature(self, ref):
|
|
1076 |
"""
|
|
1077 |
Get a feature object by its reference.
|
|
1078 |
@param ref: The reference to the feature object.
|
|
1079 |
@return: A Feature object
|
|
1080 |
"""
|
|
1081 |
return self._get(ref)
|
|
1082 |
|
3
|
1083 |
def create_feature(self, ref, **kwargs):
|
|
1084 |
"""
|
|
1085 |
Create a feature object to the configuration.
|
|
1086 |
@param ref: The ref for the Feature object.
|
|
1087 |
@param **kwargs: keyword arguments
|
|
1088 |
e.g. to add fea2 under fea1 add_feature(fea2, 'fea1')
|
|
1089 |
@return: the new feature object.
|
|
1090 |
"""
|
|
1091 |
fea = self._feature_class()(ref, **kwargs)
|
|
1092 |
self._add(fea)
|
|
1093 |
return fea
|
|
1094 |
|
0
|
1095 |
def add_feature(self, feature, namespace=""):
|
|
1096 |
"""
|
|
1097 |
Add a feature object to the configuration.
|
|
1098 |
@param feature: The Feature object to add.
|
|
1099 |
@param namespace: The sub namespace for the feature.
|
|
1100 |
e.g. to add fea2 under fea1 add_feature(fea2, 'fea1')
|
|
1101 |
@return: None
|
|
1102 |
"""
|
3
|
1103 |
if namespace and self._has(namespace):
|
|
1104 |
# Add the feature directly with an existing feature's add_feature functionality
|
|
1105 |
self.get_feature(namespace).add_feature(feature)
|
|
1106 |
else:
|
|
1107 |
self._add_to_path(namespace, feature)
|
0
|
1108 |
|
|
1109 |
def remove_feature(self, ref):
|
|
1110 |
"""
|
|
1111 |
remove feature by its reference
|
|
1112 |
@param ref:
|
|
1113 |
"""
|
|
1114 |
self._remove(ref)
|
|
1115 |
|
|
1116 |
def list_features(self):
|
|
1117 |
"""
|
|
1118 |
List immediate features found under the this configuration (the top nodes).
|
|
1119 |
The features are also available via the _default_view of the configuration.
|
|
1120 |
@return: a list of feature references.
|
|
1121 |
"""
|
|
1122 |
return [fea.get_ref() for fea in self._objects(type=Feature)]
|
|
1123 |
|
|
1124 |
def list_all_features(self):
|
|
1125 |
"""
|
|
1126 |
List all features found under the this configuration. The features are also
|
|
1127 |
available via the _default_view of the configuration.
|
|
1128 |
@return: a list of feature references.
|
|
1129 |
"""
|
|
1130 |
return [fea.fqr for fea in self._traverse(type=Feature)]
|
|
1131 |
|
|
1132 |
def add_data(self, data, policy=container.REPLACE):
|
|
1133 |
"""
|
|
1134 |
Add a data object to this configuration object.
|
3
|
1135 |
@param data: The Data object or list of Data objects to add.
|
0
|
1136 |
@return: None
|
3
|
1137 |
"""
|
|
1138 |
data_objs = utils.get_list(data)
|
|
1139 |
|
|
1140 |
if policy == container.PREPEND:
|
|
1141 |
data_objs = reversed(data_objs)
|
|
1142 |
policy_first = container.PREPEND
|
|
1143 |
policy_rest = container.PREPEND
|
|
1144 |
else:
|
|
1145 |
policy_first = policy
|
|
1146 |
policy_rest = container.APPEND
|
|
1147 |
|
|
1148 |
for i, data_obj in enumerate(data_objs):
|
|
1149 |
if not self._has(data_obj.attr):
|
|
1150 |
self._add(DataContainer(data_obj.attr, container=True))
|
|
1151 |
(namespace, name) = utils.dottedref.psplit_ref(data_obj.get_fearef())
|
|
1152 |
|
|
1153 |
if i == 0: p = policy_first
|
|
1154 |
else: p = policy_rest
|
|
1155 |
self._get(data_obj.attr)._add_to_path(namespace, data_obj, p)
|
0
|
1156 |
|
|
1157 |
def get_data(self, ref):
|
|
1158 |
"""
|
|
1159 |
Get a data object by its reference.
|
|
1160 |
@param ref: The reference to the data object.
|
|
1161 |
@return: A Data object
|
|
1162 |
"""
|
|
1163 |
return self.data._get(ref)
|
|
1164 |
|
|
1165 |
def remove_data(self, ref):
|
|
1166 |
"""
|
|
1167 |
remove feature by its reference
|
|
1168 |
@param ref:
|
|
1169 |
"""
|
|
1170 |
self.data._remove(ref)
|
|
1171 |
|
|
1172 |
def list_datas(self):
|
|
1173 |
"""
|
|
1174 |
List all datas found under the this configuration.
|
|
1175 |
@return: a list of Data references.
|
|
1176 |
"""
|
|
1177 |
if self._has('data'):
|
|
1178 |
return [dataelem.fqr for dataelem in self.data._objects(type=Data)]
|
|
1179 |
else:
|
|
1180 |
return []
|
|
1181 |
|
|
1182 |
def get_datas(self):
|
|
1183 |
"""
|
|
1184 |
List immediate datas found under the this configuration (the top nodes).
|
|
1185 |
@return: a list of Data references.
|
|
1186 |
"""
|
|
1187 |
if self._has('data'):
|
|
1188 |
return [dataelem for dataelem in self.data._objects(type=Data)]
|
|
1189 |
else:
|
|
1190 |
return []
|
|
1191 |
|
|
1192 |
def list_all_datas(self):
|
|
1193 |
"""
|
|
1194 |
List all Data elements found under the this configuration (or subconfigurations).
|
|
1195 |
@return: a list of Data references.
|
|
1196 |
"""
|
|
1197 |
return [dataelem.fqr for dataelem in self._traverse(type=Data)]
|
|
1198 |
|
|
1199 |
def get_all_datas(self):
|
|
1200 |
"""
|
|
1201 |
List all Data elements found under the this configuration (or subconfigurations).
|
|
1202 |
@return: a list of Data references.
|
|
1203 |
"""
|
|
1204 |
return [dataelem for dataelem in self._traverse(type=Data)]
|
|
1205 |
|
|
1206 |
def list_leaf_datas(self):
|
|
1207 |
"""
|
|
1208 |
List all leaf Data elements (i.e. actually modified settings) found under this configuration (or subconfigurations).
|
|
1209 |
@return: A list of Data references.
|
|
1210 |
"""
|
|
1211 |
return [dataelem.fqr for dataelem in self._find_leaves(type=Data)]
|
|
1212 |
|
|
1213 |
def get_leaf_datas(self):
|
|
1214 |
"""
|
|
1215 |
Get all leaf Data elements (i.e. actually modified settings) found under this configuration (or subconfigurations).
|
|
1216 |
@return: A list of Data objects.
|
|
1217 |
"""
|
|
1218 |
return [dataelem for dataelem in self._find_leaves(type=Data)]
|
|
1219 |
|
|
1220 |
def get_view(self, ref):
|
|
1221 |
"""
|
|
1222 |
Get a view object by its reference.
|
|
1223 |
@param ref: The reference to the view object.
|
|
1224 |
@return: A View object
|
|
1225 |
"""
|
|
1226 |
# Populate the view object before returning it
|
|
1227 |
view = self._get(ref)
|
|
1228 |
view.populate()
|
|
1229 |
return view
|
|
1230 |
|
3
|
1231 |
def create_view(self, viewname):
|
|
1232 |
"""
|
|
1233 |
Create a view object to the configuration.
|
|
1234 |
@param viewname: The name of the view to add.
|
|
1235 |
@return: view object
|
|
1236 |
"""
|
|
1237 |
viewobj = self._view_class()(viewname)
|
|
1238 |
self.add_view(viewobj)
|
|
1239 |
return viewobj
|
|
1240 |
|
|
1241 |
def add_view(self, viewobj):
|
0
|
1242 |
"""
|
|
1243 |
Add a view object to the configuration.
|
3
|
1244 |
@param viewobj: The existing view object to add.
|
0
|
1245 |
@return: None
|
|
1246 |
"""
|
3
|
1247 |
assert(isinstance(viewobj, View))
|
|
1248 |
return self._add(viewobj)
|
0
|
1249 |
|
|
1250 |
def remove_view(self, ref):
|
|
1251 |
"""
|
|
1252 |
Remove a view object from the configuration.
|
|
1253 |
@param ref: The reference to the View.
|
|
1254 |
@return: None
|
|
1255 |
@raise NotFound: when view is not found.
|
|
1256 |
"""
|
|
1257 |
return self._remove(ref)
|
|
1258 |
|
|
1259 |
def list_views(self):
|
|
1260 |
"""
|
|
1261 |
List all views found under the this configuration.
|
|
1262 |
@return: a list of view references.
|
|
1263 |
"""
|
|
1264 |
return [view._path(self) for view in self._traverse(type=View)]
|
|
1265 |
|
|
1266 |
def save(self):
|
|
1267 |
"""
|
|
1268 |
Save the object to the permanent Storage object. Calls the save operation of
|
|
1269 |
all the children.
|
|
1270 |
"""
|
3
|
1271 |
# Change the recursion order so that the current object
|
|
1272 |
# is saved first and then its childen.
|
|
1273 |
# This increases performance in cases where this object requires information about its childen (no unload -> load cases)
|
|
1274 |
self.get_project().unload(self.get_full_path(), self)
|
0
|
1275 |
for child in self._objects():
|
|
1276 |
if isinstance(child, (Configuration,ConfigurationProxy)):
|
|
1277 |
child.save()
|
|
1278 |
|
|
1279 |
def close(self):
|
|
1280 |
"""
|
|
1281 |
Close the configuration
|
|
1282 |
"""
|
|
1283 |
for child in self._objects():
|
|
1284 |
if isinstance(child, (Configuration, ConfigurationProxy)):
|
|
1285 |
child.close()
|
|
1286 |
# if self.get_full_path() != "":
|
|
1287 |
# self.get_project().unload(self.get_full_path(), self)
|
|
1288 |
|
|
1289 |
def add(self, child, policy=container.REPLACE):
|
|
1290 |
"""
|
|
1291 |
A generic add function to add child objects. The function is intended to act as
|
|
1292 |
proxy function that call the correct add function based on the child objects class.
|
|
1293 |
|
|
1294 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
1295 |
@param child: the child object to add
|
|
1296 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
1297 |
"""
|
|
1298 |
if isinstance(child, Feature):
|
|
1299 |
self.add_feature(child)
|
|
1300 |
elif isinstance(child, View):
|
|
1301 |
self._add(child)
|
|
1302 |
elif isinstance(child, (Data)):
|
|
1303 |
self.add_data(child)
|
|
1304 |
else:
|
|
1305 |
super(Configuration, self).add(child)
|
|
1306 |
|
|
1307 |
def get_default_view(self):
|
|
1308 |
"""
|
|
1309 |
Get the default view from this configuration hierarchy.
|
|
1310 |
This returns always the view from the Root configuration point of view.
|
|
1311 |
"""
|
|
1312 |
try:
|
3
|
1313 |
parent = self._find_parent_or_default()
|
0
|
1314 |
if parent and isinstance(parent, Configuration):
|
|
1315 |
return parent.get_default_view()
|
|
1316 |
else:
|
3
|
1317 |
if not self._has('?default_view'):
|
0
|
1318 |
self._create_default_view()
|
3
|
1319 |
return self._get('?default_view')
|
0
|
1320 |
except exceptions.NotFound, e:
|
|
1321 |
raise e
|
|
1322 |
# raise exceptions.NotFound("Default View is not found! No root configuration?")
|
|
1323 |
|
|
1324 |
def recreate_default_view(self):
|
|
1325 |
try:
|
|
1326 |
parent = self._find_parent_or_default()
|
|
1327 |
if parent and isinstance(parent, Configuration):
|
|
1328 |
parent.recreate_default_view()
|
|
1329 |
else:
|
|
1330 |
self._create_default_view()
|
|
1331 |
except exceptions.NotFound, e:
|
|
1332 |
raise e
|
|
1333 |
# raise exceptions.NotFound("Default View is not found! No root configuration?")
|
|
1334 |
|
|
1335 |
def _create_default_view(self):
|
|
1336 |
# Rebuild the default view for this Configuration
|
3
|
1337 |
default_view = View("?default_view", data=True)
|
|
1338 |
#self._default_view._parent= self
|
|
1339 |
self._add(default_view)
|
0
|
1340 |
# First add all features of the configuration to the view.
|
|
1341 |
# Then add all data elements under the features
|
|
1342 |
for child in self._traverse(type=Feature):
|
3
|
1343 |
# TODO print "Adding : %s -> %s" % (child.namespace, child)
|
|
1344 |
default_view.add_feature(child, child.namespace)
|
0
|
1345 |
for child in self._traverse(type=Data):
|
|
1346 |
#parent_config = child._find_parent_or_default(type=Configuration)
|
|
1347 |
#print "Adding data %s: fqr: %s from file %s." % (child.get_value(), child.fqr, parent_config.get_path())
|
|
1348 |
try:
|
3
|
1349 |
fea = default_view.get_feature(child.fqr)
|
0
|
1350 |
fea.add_data(child)
|
|
1351 |
except exceptions.NotFound, e:
|
|
1352 |
data_parent_config = child._find_parent_or_default(type=Configuration)
|
|
1353 |
logging.getLogger('cone').info("Warning: Feature '%s' for data in %s not found." % (child.fqr, data_parent_config.get_path()))
|
|
1354 |
|
|
1355 |
class ConfigurationProxy(container.LoadProxy):
|
|
1356 |
"""
|
|
1357 |
Configuration loading proxy. Loads the configuration from the given reference, when needed.
|
|
1358 |
"""
|
|
1359 |
def __init__(self, path, **kwargs):
|
|
1360 |
"""
|
|
1361 |
The ConfigurationProxy that represents a configuration that is included in another configuration.
|
|
1362 |
@param ref: the reference to the storage resource
|
|
1363 |
The ConfigurationProxy trust to get the store_interface from the parent object with get_storage() function.
|
|
1364 |
|
|
1365 |
"""
|
3
|
1366 |
super(ConfigurationProxy,self).__init__(path, **kwargs)
|
0
|
1367 |
self.set('_name', utils.resourceref.to_objref(path))
|
3
|
1368 |
|
0
|
1369 |
def _clone(self, **kwargs):
|
|
1370 |
"""
|
|
1371 |
A ConfigurationProxy specific implementation for cloning.
|
|
1372 |
Copies all (public) members in dictionary.
|
|
1373 |
To clone call the actual object that is proxied as well if the reqursion is on.
|
|
1374 |
@param recursion: Boolean to define recursion on or off
|
|
1375 |
@param recursion_depth: positive integer to define recursion depth. default is -1 which will
|
|
1376 |
perform recursion to all objects.
|
|
1377 |
"""
|
|
1378 |
dict = self._dict()
|
|
1379 |
obj = self.__class__(**dict)
|
|
1380 |
# handle the recursion argument
|
|
1381 |
recursion = kwargs.get('recursion', False)
|
|
1382 |
if recursion:
|
|
1383 |
recursion_depth = kwargs.get('recursion_depth', -1)
|
|
1384 |
if recursion_depth < 0 or recursion_depth > 0:
|
|
1385 |
# decrease the recursion
|
|
1386 |
kwargs['recursion_depth'] = recursion_depth - 1
|
|
1387 |
newobj = self._get_obj()._clone(**kwargs)
|
|
1388 |
obj._set_obj(newobj)
|
|
1389 |
return obj
|
3
|
1390 |
|
0
|
1391 |
def _dict(self):
|
|
1392 |
"""
|
|
1393 |
Return the public variables in a dictionary
|
|
1394 |
"""
|
|
1395 |
dict = {}
|
|
1396 |
for key in self.__dict__.keys():
|
|
1397 |
if key.startswith('_'):
|
|
1398 |
continue
|
|
1399 |
else:
|
|
1400 |
dict[key] = self.__dict__[key]
|
|
1401 |
return dict
|
3
|
1402 |
|
0
|
1403 |
def _get_mapper(self,modelname):
|
|
1404 |
"""
|
|
1405 |
Return a instance of appropriate mapper for given model.
|
|
1406 |
"""
|
|
1407 |
return mapping.BaseMapper()
|
|
1408 |
|
|
1409 |
class Group(Base):
|
|
1410 |
"""
|
|
1411 |
A Group class. Group is used in View to group up other Group/Feature objects.
|
|
1412 |
"""
|
|
1413 |
def __init__(self, ref="", **kwargs):
|
|
1414 |
super(Group, self).__init__(ref, **kwargs)
|
3
|
1415 |
self.name = kwargs.get('name', ref)
|
0
|
1416 |
self.support_data = kwargs.get("data", False)
|
|
1417 |
|
|
1418 |
def _supported_type(self, obj):
|
|
1419 |
if isinstance(obj, (Group, \
|
|
1420 |
Base, \
|
|
1421 |
_FeatureProxy, \
|
3
|
1422 |
FeatureLink, \
|
|
1423 |
ConfigurationProxy)):
|
0
|
1424 |
return True
|
|
1425 |
else:
|
|
1426 |
return False
|
|
1427 |
|
|
1428 |
def _default_object(self, name):
|
3
|
1429 |
return self._group_class()(name)
|
|
1430 |
|
|
1431 |
def _group_class(self):
|
|
1432 |
return Group
|
|
1433 |
|
|
1434 |
def _featurelink_class(self):
|
|
1435 |
return FeatureLink
|
0
|
1436 |
|
|
1437 |
def add(self, child, policy=container.REPLACE):
|
|
1438 |
"""
|
|
1439 |
A generic add function to add child objects. The function is intended to act as
|
|
1440 |
proxy function that call the correct add function based on the child objects class.
|
|
1441 |
|
|
1442 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
1443 |
@param child: the child object to add
|
|
1444 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
1445 |
"""
|
3
|
1446 |
if self._supported_type(child):
|
0
|
1447 |
self._add(child)
|
|
1448 |
else:
|
|
1449 |
raise exceptions.IncorrectClassError("Cannot add %s to %s" % (child, self))
|
|
1450 |
|
|
1451 |
def get_name(self):
|
|
1452 |
"""
|
|
1453 |
Return the name of the configuration
|
|
1454 |
"""
|
|
1455 |
return self.name
|
|
1456 |
|
|
1457 |
def set_name(self, name):
|
|
1458 |
"""
|
|
1459 |
Set the name
|
|
1460 |
"""
|
|
1461 |
self.name = name
|
|
1462 |
|
3
|
1463 |
def create_featurelink(self, feature_ref, **kwargs):
|
|
1464 |
"""
|
|
1465 |
create a feature link object to this element, with the given ref
|
|
1466 |
@param feature_ref: the reference for the featurelink which should
|
|
1467 |
point to a exising feature in the configuration.
|
|
1468 |
@param **kwargs: keyword arguments are passed to the featurelink object
|
|
1469 |
directly.
|
|
1470 |
"""
|
|
1471 |
fealink = self._featurelink_class()(feature_ref, **kwargs)
|
|
1472 |
self.add(fealink)
|
|
1473 |
return fealink
|
|
1474 |
|
|
1475 |
def get_featurelink(self, ref):
|
|
1476 |
return self._get(FeatureLink.get_featurelink_ref(ref))
|
|
1477 |
|
0
|
1478 |
def add_feature(self, feature, path=""):
|
|
1479 |
"""
|
|
1480 |
Add feature to this Group.
|
|
1481 |
"""
|
|
1482 |
if not isinstance(feature, Feature):
|
|
1483 |
raise exceptions.IncorrectClassError("add_feature requires instance of Feature!! Given %s" % feature)
|
|
1484 |
if not self.support_data:
|
|
1485 |
self._add_to_path(path, _FeatureProxy(feature._name, feature))
|
|
1486 |
else:
|
|
1487 |
self._add_to_path(path, _FeatureDataProxy(feature._name, feature))
|
|
1488 |
|
|
1489 |
def remove_feature(self, ref):
|
|
1490 |
"""
|
|
1491 |
remove a given feature from this view by reference.
|
|
1492 |
@param ref:
|
|
1493 |
"""
|
|
1494 |
self._remove(ref)
|
|
1495 |
|
|
1496 |
def get_feature(self, ref):
|
|
1497 |
"""
|
|
1498 |
@param path: The path (ref) to the given feature
|
|
1499 |
"""
|
|
1500 |
try:
|
|
1501 |
return self._get(ref)
|
|
1502 |
except exceptions.NotFound:
|
|
1503 |
raise exceptions.NotFound("Feature '%s' not found." % ref)
|
|
1504 |
|
3
|
1505 |
def get_features(self, refs, **kwargs):
|
0
|
1506 |
"""
|
|
1507 |
Get a list of features that match the ref.
|
3
|
1508 |
|
|
1509 |
@param refs: The paths (refs) to the given feature or xpath like expression. The refs
|
|
1510 |
argument can be a single reference or a list of references to features.
|
|
1511 |
@return: A list of features.
|
|
1512 |
|
|
1513 |
NOTE! the invalid references will not raise an exception.
|
|
1514 |
|
0
|
1515 |
Example1: get_features('foo.bar') would be the same as get_feature('foo.bar'), but this returns
|
|
1516 |
always a list [<Feature>].
|
|
1517 |
Example2: get_features('foo.*') would try to retrieve a list of all foo children.
|
|
1518 |
Example3: get_features('foo.*', type='') would try to retrieve a list of all foo children,
|
|
1519 |
that have a defined type.
|
3
|
1520 |
Example4: get_features(['foo','bar.set1']) would try to retrieve a foo and then bar.set1.
|
|
1521 |
|
|
1522 |
"""
|
|
1523 |
|
|
1524 |
if utils.is_list(refs):
|
|
1525 |
features = []
|
|
1526 |
for ref in refs:
|
|
1527 |
features += self.get_matching_features(ref, **kwargs)
|
|
1528 |
return features
|
|
1529 |
else:
|
|
1530 |
return self.get_matching_features(refs, **kwargs)
|
|
1531 |
|
|
1532 |
def get_matching_features(self, ref, **kwargs):
|
|
1533 |
"""
|
|
1534 |
Get a list of features that match the ref.
|
|
1535 |
|
|
1536 |
@param refs: The paths (refs) to the given feature or xpath like expression. The refs
|
|
1537 |
argument can be a single reference or a list of references to features.
|
0
|
1538 |
@return: A list of features.
|
3
|
1539 |
|
|
1540 |
NOTE! the invalid references will not raise an exception but return an empty list.
|
|
1541 |
|
|
1542 |
Example1: get_features('foo.bar') would be the same as get_feature('foo.bar'), but this returns
|
|
1543 |
always a list [<Feature>].
|
|
1544 |
Example2: get_features('foo.*') would try to retrieve a list of all foo children.
|
|
1545 |
Example3: get_features('foo.*', type='') would try to retrieve a list of all foo children,
|
|
1546 |
that have a defined type.
|
|
1547 |
|
|
1548 |
"""
|
|
1549 |
try:
|
|
1550 |
(startref, last) = utils.dottedref.psplit_ref(ref)
|
|
1551 |
startelem = self._get(startref)
|
|
1552 |
kwargs['type'] = _FeatureProxy
|
|
1553 |
if last == '**':
|
|
1554 |
return [fea for fea in startelem._traverse(**kwargs)]
|
|
1555 |
elif last == '*':
|
|
1556 |
return [fea for fea in startelem._objects(**kwargs)]
|
|
1557 |
elif ref != "":
|
|
1558 |
return [self._get(ref)]
|
|
1559 |
else:
|
|
1560 |
return []
|
|
1561 |
except exceptions.NotFound:
|
|
1562 |
return []
|
|
1563 |
|
0
|
1564 |
def list_features(self):
|
|
1565 |
"""
|
|
1566 |
Return a array of all Feature children references under this object.
|
|
1567 |
"""
|
|
1568 |
return [fea.get_ref() for fea in self._objects(type=(_FeatureProxy))]
|
|
1569 |
|
|
1570 |
def list_all_features(self):
|
|
1571 |
"""
|
|
1572 |
Return a array of all Feature children references under this object.
|
|
1573 |
"""
|
|
1574 |
return [fea.fqr for fea in self._traverse(type=(_FeatureProxy))]
|
|
1575 |
|
3
|
1576 |
def create_group(self, groupname, **kwargs):
|
|
1577 |
"""
|
|
1578 |
create a group object to this element with given group name.
|
|
1579 |
@param groupname: the name for the new group
|
|
1580 |
@param **kwargs: keyword arguments are passed on to the new group object.
|
|
1581 |
"""
|
|
1582 |
grp = self._group_class()(groupname, **kwargs)
|
|
1583 |
self.add_group(grp)
|
|
1584 |
return grp
|
|
1585 |
|
|
1586 |
def add_group(self, grp):
|
|
1587 |
"""
|
|
1588 |
"""
|
|
1589 |
self._add(grp)
|
0
|
1590 |
|
|
1591 |
def remove_group(self, ref):
|
|
1592 |
"""
|
|
1593 |
remove a given feature from this view by reference.
|
|
1594 |
@param ref:
|
|
1595 |
"""
|
|
1596 |
self._remove(ref)
|
|
1597 |
|
|
1598 |
def get_group(self, ref):
|
|
1599 |
"""
|
|
1600 |
@param path: The path (ref) to the given feature
|
|
1601 |
"""
|
|
1602 |
return self._get(ref)
|
|
1603 |
|
|
1604 |
def list_groups(self):
|
|
1605 |
"""
|
|
1606 |
"""
|
3
|
1607 |
return [group.ref for group in self._objects(type=Group)]
|
0
|
1608 |
|
|
1609 |
def populate(self):
|
|
1610 |
"""
|
|
1611 |
Populate or fetch the link to the actual feature for this featureproxy.
|
|
1612 |
This method fetches the feature to the _obj member variable and populates also
|
|
1613 |
subfeatures.
|
|
1614 |
"""
|
|
1615 |
for child in self._traverse(type=FeatureLink):
|
|
1616 |
child.populate()
|
|
1617 |
|
|
1618 |
|
|
1619 |
|
|
1620 |
class View(Group):
|
|
1621 |
"""
|
|
1622 |
A View class. View is intended to create new or different hierarchies of existing features. A View can contain Group and/or Feature objects.
|
|
1623 |
"""
|
|
1624 |
def __init__(self, ref="", **kwargs):
|
|
1625 |
super(View, self).__init__(self.to_ref(ref), **kwargs)
|
|
1626 |
self.container = True
|
|
1627 |
|
|
1628 |
@classmethod
|
|
1629 |
def to_ref(cls, ref):
|
|
1630 |
"""
|
|
1631 |
return a view reference converted from name
|
|
1632 |
"""
|
|
1633 |
return ref.replace('.', '').replace('/', '')
|
|
1634 |
|
|
1635 |
|
|
1636 |
class Feature(Base):
|
|
1637 |
"""
|
|
1638 |
A Feature class. Feature is the base for all Configurable items in a Configuration.
|
|
1639 |
"""
|
|
1640 |
PROPERTIES = ['value']
|
|
1641 |
def __init__(self, ref="", **kwargs):
|
|
1642 |
super(Feature, self).__init__(ref, **kwargs)
|
3
|
1643 |
self.name = kwargs.get('name', None)
|
0
|
1644 |
self.type = kwargs.get('type', None)
|
3
|
1645 |
self.relevant = kwargs.get('relevant', None)
|
|
1646 |
self.constraint = kwargs.get('constraint', None)
|
0
|
1647 |
self._dataproxy = None
|
|
1648 |
|
|
1649 |
def __copy__(self):
|
|
1650 |
dict = {}
|
|
1651 |
for key in self.__dict__.keys():
|
|
1652 |
if key.startswith('_') or key == 'ref':
|
|
1653 |
continue
|
|
1654 |
else:
|
|
1655 |
dict[key] = self.__dict__[key]
|
|
1656 |
fea = self.__class__(self.ref, **dict)
|
|
1657 |
return fea
|
|
1658 |
|
3
|
1659 |
def __getstate__(self):
|
|
1660 |
state = super(Feature, self).__getstate__()
|
|
1661 |
# remove the dataproxy value so that it is not stored in serializings
|
|
1662 |
state.pop('_dataproxy', None)
|
4
|
1663 |
# remove instancemethods so that those are not stored in serializings
|
|
1664 |
state.pop('get_original_value', None)
|
|
1665 |
state.pop('get_value', None)
|
|
1666 |
state.pop('set_value', None)
|
|
1667 |
state.pop('add_feature', None)
|
3
|
1668 |
return state
|
|
1669 |
|
|
1670 |
def __setstate__(self, state):
|
|
1671 |
super(Feature, self).__setstate__(state)
|
|
1672 |
self._dataproxy = None
|
|
1673 |
|
|
1674 |
|
0
|
1675 |
def _supported_type(self, obj):
|
|
1676 |
# For now support added for desc element via support for Base
|
|
1677 |
if isinstance(obj, (Feature, Option, Base)):
|
|
1678 |
return True
|
|
1679 |
else:
|
|
1680 |
return False
|
|
1681 |
|
3
|
1682 |
def _feature_class(self):
|
|
1683 |
return Feature
|
|
1684 |
|
0
|
1685 |
def add(self, child, policy=container.REPLACE):
|
|
1686 |
"""
|
|
1687 |
A generic add function to add child objects. The function is intended to act as
|
|
1688 |
proxy function that call the correct add function based on the child objects class.
|
|
1689 |
|
|
1690 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
1691 |
@param child: the child object to add
|
|
1692 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
1693 |
"""
|
|
1694 |
if isinstance(child, Feature):
|
|
1695 |
self.add_feature(child)
|
|
1696 |
elif isinstance(child, Option):
|
|
1697 |
self._add(child, policy)
|
|
1698 |
elif isinstance(child, Base):
|
|
1699 |
self._add(child, policy)
|
3
|
1700 |
elif isinstance(child, Property):
|
|
1701 |
self._add(child, policy)
|
0
|
1702 |
else:
|
|
1703 |
raise exceptions.IncorrectClassError("Cannot add %s to %s" % (child, self))
|
|
1704 |
|
|
1705 |
def get_name(self):
|
|
1706 |
"""
|
|
1707 |
Return the name of the configuration
|
|
1708 |
"""
|
|
1709 |
return self.name
|
|
1710 |
|
|
1711 |
def set_name(self, name):
|
|
1712 |
"""
|
|
1713 |
Set the name
|
|
1714 |
"""
|
|
1715 |
self.name = name
|
|
1716 |
|
3
|
1717 |
def get_relevant(self):
|
|
1718 |
"""
|
|
1719 |
Return the relevant attribute of the feature
|
|
1720 |
"""
|
|
1721 |
return self.relevant
|
|
1722 |
|
|
1723 |
def set_relevant(self, relevant):
|
|
1724 |
"""
|
|
1725 |
Set the relevant attribute
|
|
1726 |
"""
|
|
1727 |
self.relevant = relevant
|
|
1728 |
|
|
1729 |
def get_constraint(self):
|
|
1730 |
"""
|
|
1731 |
Return the constraint attribute of the feature
|
|
1732 |
"""
|
|
1733 |
return self.constraint
|
|
1734 |
|
|
1735 |
def set_constraint(self, constraint):
|
|
1736 |
"""
|
|
1737 |
Set the constraint attribute
|
|
1738 |
"""
|
|
1739 |
self.constraint = constraint
|
|
1740 |
|
0
|
1741 |
def get_type(self):
|
|
1742 |
return self.type
|
|
1743 |
|
|
1744 |
def set_type(self, type):
|
|
1745 |
self.type = type
|
|
1746 |
|
3
|
1747 |
def create_feature(self, ref, **kwargs):
|
|
1748 |
"""
|
|
1749 |
Create a feature object to the configuration.
|
|
1750 |
@param ref: The ref for the Feature object.
|
|
1751 |
@param **kwargs: keyword arguments
|
|
1752 |
e.g. to add fea2 under fea1 add_feature(fea2, 'fea1')
|
|
1753 |
@return: the new feature object.
|
|
1754 |
"""
|
|
1755 |
fea = self._feature_class()(ref, **kwargs)
|
|
1756 |
self.add_feature(fea)
|
|
1757 |
return fea
|
|
1758 |
|
0
|
1759 |
def add_feature(self, feature, path=""):
|
|
1760 |
"""
|
|
1761 |
@param feature: The Feature object to add
|
|
1762 |
"""
|
3
|
1763 |
self._add_to_path(path, feature)
|
0
|
1764 |
|
|
1765 |
def get_feature(self, path):
|
|
1766 |
"""
|
|
1767 |
@param path: The path (ref) to the given feature
|
|
1768 |
"""
|
|
1769 |
return self._get(path)
|
|
1770 |
|
|
1771 |
def remove_feature(self, ref):
|
|
1772 |
"""
|
|
1773 |
remove a given feature from this view by reference.
|
|
1774 |
@param ref:
|
|
1775 |
"""
|
3
|
1776 |
self._remove(ref)
|
0
|
1777 |
|
|
1778 |
def list_features(self):
|
|
1779 |
"""
|
|
1780 |
Return a array of all Feature children references under this object.
|
|
1781 |
"""
|
|
1782 |
return [fea.get_ref() for fea in self._objects(type=Feature)]
|
|
1783 |
|
|
1784 |
def list_all_features(self):
|
|
1785 |
"""
|
|
1786 |
Return a array of all Feature children references under this object.
|
|
1787 |
"""
|
|
1788 |
return [fea._path(self) for fea in self._traverse(type=Feature)]
|
|
1789 |
|
|
1790 |
def add_option(self, option):
|
|
1791 |
"""
|
|
1792 |
@param option: option object
|
|
1793 |
"""
|
|
1794 |
if not isinstance(option, Option):
|
|
1795 |
raise TypeError("%r is not an instance of Option!" % option)
|
|
1796 |
self._add(option)
|
|
1797 |
|
|
1798 |
def create_option(self, name, value):
|
|
1799 |
"""
|
|
1800 |
@param name: option name
|
|
1801 |
@param value: option value
|
|
1802 |
"""
|
|
1803 |
self._add(Option(name, value))
|
|
1804 |
|
|
1805 |
def get_option(self, ref):
|
|
1806 |
"""
|
|
1807 |
@param name: The option reference of the option (as returned by list_options())
|
|
1808 |
"""
|
|
1809 |
real_ref = 'opt_' + ref
|
|
1810 |
obj = self._get(real_ref)
|
|
1811 |
if not isinstance(obj, Option):
|
|
1812 |
raise TypeError('Object %r is not an instance of Option (%r instead)' % (real_ref, type(obj)))
|
|
1813 |
return obj
|
|
1814 |
|
|
1815 |
def remove_option(self, ref):
|
|
1816 |
"""
|
|
1817 |
remove a given option from this feature by option reference.
|
|
1818 |
"""
|
|
1819 |
real_ref = 'opt_' + ref
|
|
1820 |
obj = self._get(real_ref)
|
|
1821 |
if not isinstance(obj, Option):
|
|
1822 |
raise TypeError('Trying to remove option with ref %r, but object with ref %r is not an instance of Option (%s instead)' % (ref, real_ref, type(obj)))
|
|
1823 |
self._remove(real_ref)
|
|
1824 |
|
|
1825 |
def list_options(self):
|
|
1826 |
"""
|
|
1827 |
Return a array of all Option children references under this object.
|
|
1828 |
"""
|
|
1829 |
# Return option refs without the leading 'opt_'
|
|
1830 |
return [opt.ref[4:] for opt in self._objects(type=Option)]
|
|
1831 |
|
3
|
1832 |
def add_property(self, property):
|
|
1833 |
"""
|
|
1834 |
@param property: property object to add
|
|
1835 |
"""
|
|
1836 |
if not isinstance(property, Property):
|
|
1837 |
raise TypeError("%r is not an instance of Property!" % property)
|
|
1838 |
self._add(property)
|
|
1839 |
|
|
1840 |
def create_property(self, **kwargs):
|
|
1841 |
"""
|
|
1842 |
@param name=str: property name
|
|
1843 |
@param value=str: property value
|
|
1844 |
@param unit=str: property unit, e.g. kB
|
|
1845 |
"""
|
|
1846 |
self._add(Property(**kwargs))
|
|
1847 |
|
|
1848 |
|
|
1849 |
def get_property(self, ref):
|
|
1850 |
"""
|
|
1851 |
@param ref: The ref of the property
|
|
1852 |
"""
|
|
1853 |
obj = self._get(Property.to_propertyref(ref))
|
|
1854 |
|
|
1855 |
if not isinstance(obj, Property):
|
|
1856 |
raise TypeError('Object %r is not an instance of Property (%r instead)' % (Property.to_propertyref(ref), type(obj)))
|
|
1857 |
return obj
|
|
1858 |
|
|
1859 |
def remove_property(self, ref):
|
|
1860 |
"""
|
|
1861 |
remove a given property from this feature by ref.
|
|
1862 |
@param ref:
|
|
1863 |
"""
|
|
1864 |
obj = self._get(Property.to_propertyref(ref))
|
|
1865 |
if not isinstance(obj, Property):
|
|
1866 |
raise TypeError('Trying to remove property with ref %r, but object with ref %r is not an instance of Property (%s instead)' % (ref, Property.to_propertyref(ref), type(obj)))
|
|
1867 |
self._remove(Property.to_propertyref(ref))
|
|
1868 |
|
|
1869 |
def list_properties(self):
|
|
1870 |
"""
|
|
1871 |
Return a array of all Feature properties under this object.
|
|
1872 |
"""
|
|
1873 |
|
|
1874 |
return [Property.to_normref(property.ref) for property in self._objects(type=Property)]
|
|
1875 |
|
0
|
1876 |
def get_value(self, attr=None):
|
|
1877 |
"""
|
3
|
1878 |
Get the current value of the feature.
|
0
|
1879 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
1880 |
"""
|
3
|
1881 |
return self.convert_data_to_value(self.dataproxy._get_datas(attr=attr), cast=True, attr=attr)
|
0
|
1882 |
|
|
1883 |
def set_value(self, value, attr=None):
|
|
1884 |
"""
|
|
1885 |
Set the current value for this feature. Set the value on the topmost layer.
|
|
1886 |
@param value: the value to set
|
|
1887 |
"""
|
3
|
1888 |
data_objs = self.convert_value_to_data(value, attr)
|
|
1889 |
|
|
1890 |
# Set the created data objects to the dataproxy and the
|
|
1891 |
# last configuration, overriding any existing elements
|
|
1892 |
self.dataproxy._set_datas(data_objs, attr)
|
|
1893 |
last_config = self.get_root_configuration().get_last_configuration()
|
|
1894 |
last_config.add_data(data_objs, container.REPLACE)
|
|
1895 |
|
|
1896 |
def convert_data_to_value(self, data_objects, cast=True, attr=None):
|
|
1897 |
"""
|
|
1898 |
Convert the given list of Data objects into a suitable value
|
|
1899 |
for this setting.
|
|
1900 |
@param data_objects: The Data object list.
|
|
1901 |
@param cast: If True, the value should be cast to its correct Python type
|
|
1902 |
(e.g. int), if False, the value should remain in the string form
|
|
1903 |
it was in the data objects.
|
|
1904 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
1905 |
@return: The converted value.
|
|
1906 |
"""
|
|
1907 |
if not data_objects: return None
|
|
1908 |
|
|
1909 |
data_obj = data_objects[-1]
|
|
1910 |
if data_obj.map:
|
|
1911 |
value = self._resolve_name_id_mapped_value(data_obj.map, cast_value=cast)
|
|
1912 |
else:
|
|
1913 |
value = data_obj.value
|
|
1914 |
if cast: value = self.get_value_cast(value, attr)
|
|
1915 |
return value
|
|
1916 |
|
|
1917 |
def convert_value_to_data(self, value, attr=None):
|
|
1918 |
"""
|
|
1919 |
Convert the given value to a list of Data objects that can be placed
|
|
1920 |
in the configuration's last layer's data section (DataContainer object).
|
|
1921 |
@param value: The value to convert.
|
|
1922 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
1923 |
@return: The converted Data objects.
|
|
1924 |
"""
|
|
1925 |
value = self.set_value_cast(value, attr)
|
|
1926 |
return [Data(fqr=self.fqr, value=value, attr=attr)]
|
|
1927 |
|
0
|
1928 |
def del_value(self, attr=None):
|
|
1929 |
"""
|
|
1930 |
Delete the topmost value for this feature.
|
|
1931 |
"""
|
3
|
1932 |
self.dataproxy._del_value(attr)
|
0
|
1933 |
|
|
1934 |
def get_value_cast(self, value, attr=None):
|
|
1935 |
"""
|
|
1936 |
A function to perform the value type casting in get operation
|
|
1937 |
@param value: the value to cast
|
|
1938 |
@param attr: the attribute which is fetched from model (normally in confml either None='data' or 'rfs')
|
|
1939 |
"""
|
|
1940 |
return value
|
|
1941 |
|
|
1942 |
def set_value_cast(self, value, attr=None):
|
|
1943 |
"""
|
|
1944 |
A function to perform the value type casting in the set operation
|
|
1945 |
@param value: the value to cast
|
|
1946 |
@param attr: the attribute which is fetched from model (normally in confml either None='data' or 'rfs')
|
|
1947 |
"""
|
|
1948 |
return value
|
|
1949 |
|
|
1950 |
def get_original_value(self, attr=None):
|
|
1951 |
"""
|
|
1952 |
Get the current value of the feature
|
|
1953 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
1954 |
"""
|
3
|
1955 |
return self.convert_data_to_value(self.dataproxy._get_datas(attr=attr), cast=False, attr=attr)
|
0
|
1956 |
|
|
1957 |
def add_data(self, data):
|
|
1958 |
"""
|
|
1959 |
Add a data value.
|
|
1960 |
@param data: A Data object
|
|
1961 |
"""
|
|
1962 |
try:
|
|
1963 |
return self.dataproxy._add_data(data)
|
|
1964 |
except AttributeError:
|
|
1965 |
self.dataproxy = self.get_default_view().get_feature(self.get_fullfqr())
|
|
1966 |
return self.dataproxy._add_data(data)
|
|
1967 |
|
|
1968 |
def get_data(self, attr=None):
|
|
1969 |
"""
|
|
1970 |
Helper function to get the topmost data value from the default view.
|
|
1971 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
1972 |
"""
|
|
1973 |
try:
|
|
1974 |
return self.dataproxy._get_data(attr)
|
|
1975 |
except AttributeError:
|
|
1976 |
self.dataproxy = self.get_default_view().get_feature(self.get_fullfqr())
|
|
1977 |
return self.dataproxy._get_data(attr)
|
|
1978 |
|
|
1979 |
def get_datas(self):
|
|
1980 |
"""
|
|
1981 |
Helper function to get the data values from the default view.
|
|
1982 |
"""
|
|
1983 |
try:
|
|
1984 |
return self.dataproxy._get_datas()
|
|
1985 |
except AttributeError:
|
|
1986 |
self.dataproxy = self.get_default_view().get_feature(self.get_fullfqr())
|
|
1987 |
return self.dataproxy._get_datas()
|
|
1988 |
|
|
1989 |
def get_valueset(self):
|
|
1990 |
"""
|
|
1991 |
Get the ValueSet object for this feature, that has the list of available values.
|
|
1992 |
"""
|
|
1993 |
if self.get_type() == 'boolean':
|
|
1994 |
return ValueSet([True, False])
|
|
1995 |
elif self.get_type() == 'int':
|
|
1996 |
return ValueRange(0, sys.maxint)
|
|
1997 |
elif self.get_type() == 'string':
|
|
1998 |
return ValueRe('.*')
|
|
1999 |
elif self.get_type() in ('selection', 'multiSelection'):
|
|
2000 |
values = []
|
|
2001 |
for opt in self._objects(type=Option):
|
|
2002 |
v = opt.get_value()
|
|
2003 |
if v is not None: values.append(v)
|
|
2004 |
return ValueSet(values)
|
|
2005 |
|
|
2006 |
def is_sequence(self):
|
|
2007 |
""" Return true if the feature is a sequence or part of a sequence """
|
|
2008 |
try:
|
|
2009 |
return self._parent.is_sequence()
|
|
2010 |
except AttributeError:
|
|
2011 |
return False
|
|
2012 |
|
3
|
2013 |
def is_sequence_root(self):
|
|
2014 |
""" Return true if this feature is a sequence object it self """
|
|
2015 |
return False
|
|
2016 |
|
0
|
2017 |
def get_sequence_parent(self):
|
|
2018 |
""" Try to get a FeatureSequence object for this Feature if it is found """
|
|
2019 |
try:
|
|
2020 |
return self._parent.get_sequence_parent()
|
|
2021 |
except AttributeError:
|
|
2022 |
return None
|
|
2023 |
|
|
2024 |
def getdataproxy(self):
|
|
2025 |
if self._dataproxy == None:
|
|
2026 |
self.dataproxy = self.get_default_view().get_feature(self.get_fullfqr())
|
|
2027 |
return self._dataproxy
|
|
2028 |
def setdataproxy(self, value): self._dataproxy = value
|
|
2029 |
def deldataproxy(self): self._dataproxy = None
|
|
2030 |
dataproxy = property(getdataproxy, setdataproxy, deldataproxy)
|
3
|
2031 |
""" Use custom OProperty to enable overriding value methods in subclasses """
|
|
2032 |
value = utils.OProperty(get_value, set_value, del_value)
|
|
2033 |
|
|
2034 |
def get_column_value(self, attr=None):
|
|
2035 |
"""
|
|
2036 |
Get the value of the featuresequence column
|
|
2037 |
@param ref: the reference to the column
|
|
2038 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2039 |
"""
|
|
2040 |
""" get the feature specific data from sequence => a column of data table """
|
|
2041 |
seq_parent = self.get_sequence_parent()
|
|
2042 |
if seq_parent._has_empty_sequence_marker():
|
|
2043 |
return []
|
|
2044 |
|
|
2045 |
coldata = []
|
|
2046 |
colref = self.path(seq_parent)
|
|
2047 |
for row in seq_parent.data:
|
|
2048 |
feadata = row.get_feature(colref)
|
|
2049 |
coldata.append(feadata.get_value(attr))
|
|
2050 |
return coldata
|
|
2051 |
|
|
2052 |
def get_column_original_value(self, attr=None):
|
|
2053 |
"""
|
|
2054 |
Get the value of the featuresequence column
|
|
2055 |
@param feasequence: the feature sequence object
|
|
2056 |
@param ref: the reference to the column
|
|
2057 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2058 |
"""
|
|
2059 |
""" get the feature specific data from sequence => a column of data table """
|
|
2060 |
seq_parent = self.get_sequence_parent()
|
|
2061 |
if seq_parent._has_empty_sequence_marker():
|
|
2062 |
return []
|
|
2063 |
|
|
2064 |
coldata = []
|
|
2065 |
colref = self.path(seq_parent)
|
|
2066 |
for row in seq_parent.data:
|
|
2067 |
feadata = row.get_feature(colref)
|
|
2068 |
coldata.append(feadata.get_original_value(attr))
|
|
2069 |
return coldata
|
|
2070 |
|
|
2071 |
def set_column_value(self, value, attr=None):
|
|
2072 |
"""
|
|
2073 |
Get the value of the featuresequence column
|
|
2074 |
@param feasequence: the feature sequence object
|
|
2075 |
@param ref: the reference to the column
|
|
2076 |
@param value: the value to set. This must be a list instance.
|
|
2077 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2078 |
"""
|
|
2079 |
seq_parent = self.get_sequence_parent()
|
|
2080 |
colref = self.path(seq_parent)
|
|
2081 |
|
|
2082 |
if not isinstance(value,list):
|
|
2083 |
raise exceptions.ConeException("The value for feature sequence '%s' column '%s' must be a list instance. Got %r" % (self.get_sequence_parent().fqr, colref, value))
|
|
2084 |
|
|
2085 |
# Handle the special case where the sequence is marked as empty
|
|
2086 |
# with the empty sequence marker (single empty data element)
|
|
2087 |
if seq_parent._has_empty_sequence_marker():
|
|
2088 |
seqrows = []
|
|
2089 |
else:
|
|
2090 |
seqrows = seq_parent.data
|
|
2091 |
|
|
2092 |
if len(seqrows) < len(value):
|
|
2093 |
raise exceptions.ConeException("Too many values for feature sequence '%s' column '%s'. Sequence holds only %d rows. Got %d data values in %r" % (self.get_sequence_parent().fqr, colref, len(seqrows), len(value), value))
|
|
2094 |
for i in range(0, len(value)):
|
|
2095 |
feadata = seqrows[i].get_feature(colref)
|
|
2096 |
feadata.set_value(value[i])
|
|
2097 |
|
|
2098 |
def add_sequence_feature(self, feature, path=""):
|
|
2099 |
"""
|
|
2100 |
Override of the add_feature function in sequence to set the sequence childs to act
|
|
2101 |
as columns of the feature sequence
|
|
2102 |
@param feature: The Feature object to add
|
|
2103 |
@param path: path to feature if it not added directly under parent_fea
|
|
2104 |
"""
|
|
2105 |
# modify all possible children of feature
|
|
2106 |
for fea in feature._traverse(type=Feature):
|
|
2107 |
to_sequence_feature(fea)
|
|
2108 |
|
|
2109 |
# Finally modify and add this feature to parent_feat
|
|
2110 |
to_sequence_feature(feature)
|
|
2111 |
self._add_to_path(path, feature)
|
|
2112 |
|
|
2113 |
def _resolve_name_id_mapped_value(self, mapping_string, cast_value=True):
|
|
2114 |
"""
|
|
2115 |
Resolve the name-ID mapped value based on the given mapping string.
|
|
2116 |
@param mapping_string: The name-ID mapping string in the data element, e.g.
|
|
2117 |
"FooFeature/FooSequence[@key='123']"
|
|
2118 |
@param cast_value: If True, the resolved value will be cast to the corresponding
|
|
2119 |
Python type, otherwise the raw string representation of the value in the
|
|
2120 |
data element will be returned.
|
|
2121 |
@return: The resolved value.
|
|
2122 |
"""
|
|
2123 |
def fail(msg): raise exceptions.NameIdMappingError(msg)
|
|
2124 |
|
|
2125 |
pattern = r"^([\w/]+)\[@key='(.*)'\]$"
|
|
2126 |
m = re.match(pattern, mapping_string)
|
|
2127 |
if m is None: fail("Malformed mapping expression: %s" % mapping_string)
|
|
2128 |
|
|
2129 |
source_seq_ref = m.group(1).replace('/', '.')
|
|
2130 |
mapping_key = m.group(2)
|
|
2131 |
|
|
2132 |
dview = self.get_root_configuration().get_default_view()
|
|
2133 |
|
|
2134 |
try:
|
|
2135 |
source_seq = dview.get_feature(source_seq_ref)
|
|
2136 |
except exceptions.NotFound:
|
|
2137 |
fail("Mapping source sequence '%s' does not exist" % source_seq_ref)
|
|
2138 |
|
|
2139 |
if source_seq.type != 'sequence':
|
|
2140 |
fail("Mapping source setting '%s' is not a sequence setting" % source_seq_ref)
|
|
2141 |
if not source_seq.mapKey or not source_seq.mapValue:
|
|
2142 |
fail("Source sequence '%s' must have both mapKey and mapValue specified" % source_seq_ref)
|
|
2143 |
|
|
2144 |
def get_subsetting(ref):
|
|
2145 |
"""
|
|
2146 |
Return the sub-setting by the given mapKey or mapValue ref from the
|
|
2147 |
source sequence.
|
|
2148 |
@param ref: The reference in the format it is in the ConfML file.
|
|
2149 |
E.g. 'SubSetting', 'FileSubSetting/localPath', 'FileSubSetting/targetPath'
|
|
2150 |
"""
|
|
2151 |
subsetting = source_seq.get_feature(ref.replace('/', '.'))
|
|
2152 |
# Use localPath for file and folder settings by default
|
|
2153 |
if subsetting.type in ('file', 'folder'):
|
|
2154 |
subsetting = subsetting.get_feature('localPath')
|
|
2155 |
return subsetting
|
|
2156 |
|
|
2157 |
try:
|
|
2158 |
key_subsetting = get_subsetting(source_seq.mapKey)
|
|
2159 |
except exceptions.NotFound:
|
|
2160 |
fail("Invalid mapKey in source sequence '%s': no sub-setting with ref '%s'" % (source_seq_ref, source_seq.mapKey))
|
|
2161 |
|
|
2162 |
|
|
2163 |
# Get possible override for mapValue from options
|
|
2164 |
value_subsetting_ref = source_seq.mapValue
|
|
2165 |
value_subsetting_ref_overridden = False
|
|
2166 |
for opt in self._objects(type=Option):
|
|
2167 |
if not opt.map or not opt.map_value: continue
|
|
2168 |
if opt.map.replace('/', '.') == source_seq_ref:
|
|
2169 |
value_subsetting_ref = opt.map_value
|
|
2170 |
value_subsetting_ref_overridden = True
|
|
2171 |
|
|
2172 |
try:
|
|
2173 |
value_subsetting = get_subsetting(value_subsetting_ref)
|
|
2174 |
except exceptions.NotFound:
|
|
2175 |
if value_subsetting_ref_overridden:
|
|
2176 |
fail("Invalid mapValue override in option: sub-setting '%s' does not exist under source sequence '%s'" % (value_subsetting_ref, source_seq_ref))
|
|
2177 |
else:
|
|
2178 |
fail("Invalid mapValue in source sequence '%s': no sub-setting with ref '%s'" % (source_seq_ref, value_subsetting_ref))
|
|
2179 |
|
|
2180 |
key_list = key_subsetting.get_original_value()
|
|
2181 |
if mapping_key not in key_list:
|
|
2182 |
fail("No item-setting in source sequence '%s' matches key '%s'" % (source_seq_ref, mapping_key))
|
|
2183 |
|
|
2184 |
if cast_value: value_list = value_subsetting.get_value()
|
|
2185 |
else: value_list = value_subsetting.get_original_value()
|
|
2186 |
return value_list[key_list.index(mapping_key)]
|
|
2187 |
|
0
|
2188 |
|
|
2189 |
class FeatureSequence(Feature):
|
|
2190 |
POLICY_REPLACE = 0
|
|
2191 |
POLICY_APPEND = 1
|
|
2192 |
POLICY_PREPEND = 2
|
|
2193 |
"""
|
|
2194 |
A Feature class. Feature is the base for all Configurable items in a Configuration.
|
|
2195 |
"""
|
|
2196 |
dataelem_name = '?datarows'
|
|
2197 |
template_name = '?template'
|
|
2198 |
def __init__(self, ref="", **kwargs):
|
3
|
2199 |
super(FeatureSequence, self).__init__(ref, **kwargs)
|
0
|
2200 |
self.name = kwargs.get('name', ref)
|
|
2201 |
self.type = 'sequence'
|
|
2202 |
self._templatedata = None
|
|
2203 |
|
|
2204 |
def _get_policy(self, data):
|
|
2205 |
"""
|
|
2206 |
parse the policy from a policy string and return a constant
|
|
2207 |
@return: POLICY_* constant
|
|
2208 |
"""
|
|
2209 |
try:
|
|
2210 |
containerdata = utils.get_list(data._get_parent()._get(data.get_ref()))
|
|
2211 |
firstdata = containerdata[0]
|
|
2212 |
except AttributeError:
|
|
2213 |
firstdata = data
|
|
2214 |
|
|
2215 |
if firstdata.policy == 'append':
|
|
2216 |
return self.POLICY_APPEND
|
|
2217 |
elif firstdata.policy == 'prefix':
|
|
2218 |
return self.POLICY_PREPEND
|
|
2219 |
elif firstdata == data:
|
3
|
2220 |
# otherwise the policy is either replace or undefined
|
|
2221 |
# (firstdata.policy == 'replace' or firstdata.policy == ''):
|
0
|
2222 |
return self.POLICY_REPLACE
|
|
2223 |
else:
|
|
2224 |
return self.POLICY_APPEND
|
|
2225 |
|
|
2226 |
def _set_template_data(self, data=None):
|
|
2227 |
"""
|
|
2228 |
Set the template of the feature sequence
|
|
2229 |
"""
|
|
2230 |
if data != None:
|
|
2231 |
self._templatedata = data
|
|
2232 |
for feaname in self.list_features():
|
|
2233 |
if self._templatedata._has(feaname):
|
|
2234 |
self.get_feature(feaname)._templatedata = self._templatedata._get(feaname)
|
|
2235 |
else:
|
|
2236 |
subdata = Data(ref=feaname)
|
|
2237 |
self.get_feature(feaname)._templatedata = subdata
|
|
2238 |
self._templatedata._add(subdata)
|
|
2239 |
|
|
2240 |
def _add_datarow(self, dataobj=None, policy=POLICY_APPEND):
|
|
2241 |
"""
|
|
2242 |
Add a feature data row for a new data in this sequence
|
|
2243 |
"""
|
3
|
2244 |
create_sub_data_objs = True
|
0
|
2245 |
if dataobj == None:
|
|
2246 |
dataobj = Data(fqr=self.fqr)
|
|
2247 |
elif dataobj.attr != 'data':
|
|
2248 |
# Add data rows only for data objects (not e.g. RFS)
|
|
2249 |
return
|
3
|
2250 |
else:
|
|
2251 |
# If the data object is given, but it doesn't contain any child
|
|
2252 |
# elements, don't add them automatically. This is to account for the
|
|
2253 |
# case where there is only one empty data element that specifies
|
|
2254 |
# that the sequence is set to be empty
|
|
2255 |
if len(dataobj._order) == 0:
|
|
2256 |
create_sub_data_objs = False
|
0
|
2257 |
fea = FeatureSequenceSub(self.dataelem_name)
|
|
2258 |
rowproxy = _FeatureDataProxy(fea._name, fea)
|
|
2259 |
""" the imaginary features share the parent relation of the proxy objects """
|
|
2260 |
self.dataproxy._add(rowproxy, policy)
|
|
2261 |
fea._parent = rowproxy._parent
|
|
2262 |
rowproxy._add_data(dataobj)
|
|
2263 |
""" update the FeatureSequenceSub index from the index number of dataproxy """
|
|
2264 |
fea._index = utils.get_list(self.dataproxy._get(self.dataelem_name)).index(rowproxy)
|
|
2265 |
# Create a the subfeatures / columns for the parent feature and
|
|
2266 |
# add a data element under each feature.
|
|
2267 |
for feaname in self.list_all_features():
|
|
2268 |
(pathto_fea, fearef) = utils.dottedref.psplit_ref(feaname)
|
3
|
2269 |
subfea = self.get_feature(feaname)
|
|
2270 |
cellfea = FeatureSequenceSub(fearef)
|
|
2271 |
cellfea.set_value_cast = subfea.set_value_cast
|
|
2272 |
cellfea.get_value_cast = subfea.get_value_cast
|
|
2273 |
cellfea.convert_data_to_value = subfea.convert_data_to_value
|
|
2274 |
cellfea.convert_value_to_data = subfea.convert_value_to_data
|
|
2275 |
rowproxy.add_feature(cellfea, pathto_fea)
|
0
|
2276 |
subproxy = rowproxy.get_feature(feaname)
|
3
|
2277 |
subproxy._obj._parent = subproxy._parent
|
|
2278 |
if create_sub_data_objs and not dataobj._has(feaname):
|
0
|
2279 |
dataobj._add_to_path(pathto_fea, Data(ref=fearef))
|
|
2280 |
subproxy._add_data(dataobj._get(feaname))
|
3
|
2281 |
return dataobj
|
|
2282 |
|
|
2283 |
def _has_empty_sequence_marker(self):
|
|
2284 |
"""
|
|
2285 |
Return True if the sequence setting has the empty sequence marker (a single
|
|
2286 |
empty data element), which denotes that the sequence is set to empty.
|
|
2287 |
"""
|
|
2288 |
datatable = self.get_data()
|
|
2289 |
if len(datatable) == 1:
|
|
2290 |
data_elem = datatable[0].get_datas()[0]
|
|
2291 |
if len(data_elem._order) == 0:
|
|
2292 |
return True
|
|
2293 |
return False
|
|
2294 |
|
0
|
2295 |
def add(self, child, policy=container.REPLACE):
|
|
2296 |
"""
|
|
2297 |
A generic add function to add child objects. The function is intended to act as
|
|
2298 |
proxy function that call the correct add function based on the child objects class.
|
|
2299 |
|
|
2300 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
2301 |
@param child: the child object to add
|
|
2302 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
2303 |
"""
|
|
2304 |
if isinstance(child, Feature):
|
|
2305 |
self.add_feature(child)
|
|
2306 |
elif isinstance(child, Option):
|
|
2307 |
self._add(child)
|
|
2308 |
elif isinstance(child, Base):
|
|
2309 |
self._add(child)
|
|
2310 |
else:
|
|
2311 |
raise exceptions.IncorrectClassError("Cannot add %s to %s" % (child, self))
|
3
|
2312 |
|
|
2313 |
def add_feature(self, feature, path=""):
|
|
2314 |
"""
|
|
2315 |
Override of the add_feature function in sequence to set the sequence childs to act
|
|
2316 |
as columns of the feature sequence
|
|
2317 |
@param feature: The Feature object to add
|
|
2318 |
"""
|
|
2319 |
add_sequence_feature(self, feature, path)
|
0
|
2320 |
|
|
2321 |
def add_sequence(self, data=None, policy=POLICY_APPEND):
|
|
2322 |
"""
|
|
2323 |
Add a feature data row for a new data in this sequence
|
|
2324 |
"""
|
3
|
2325 |
if self._has_empty_sequence_marker():
|
|
2326 |
# We currently have the empty sequence marker (single empty data
|
|
2327 |
# element), so this one that we are adding should replace it
|
|
2328 |
policy = self.POLICY_REPLACE
|
|
2329 |
|
|
2330 |
datarow = self._add_datarow(None, policy)
|
|
2331 |
# add the new data sequence/row to the last configuration layer
|
|
2332 |
last_config = self.get_root_configuration().get_last_configuration()
|
|
2333 |
|
|
2334 |
container_policy = {self.POLICY_REPLACE: container.REPLACE,
|
|
2335 |
self.POLICY_APPEND: container.APPEND,
|
|
2336 |
self.POLICY_PREPEND: container.PREPEND}[policy]
|
|
2337 |
last_config.add_data(datarow, container_policy)
|
|
2338 |
|
0
|
2339 |
# set the initial data if it is given
|
|
2340 |
rowproxy = utils.get_list(self.dataproxy._get(self.dataelem_name))[-1]
|
|
2341 |
if data != None:
|
|
2342 |
for index in range(len(data)):
|
3
|
2343 |
if data[index] != None:
|
|
2344 |
rowproxy[index].set_value(data[index])
|
0
|
2345 |
|
|
2346 |
def set_template(self, data=None):
|
|
2347 |
"""
|
|
2348 |
Set the template of the feature sequence
|
|
2349 |
"""
|
3
|
2350 |
if data is None:
|
|
2351 |
self._templatedata = None
|
|
2352 |
return
|
|
2353 |
|
|
2354 |
if not isinstance(data, list):
|
|
2355 |
raise TypeError('data must be a list (got %r)' % data)
|
|
2356 |
|
|
2357 |
# Create the new template data object
|
|
2358 |
templatedata = Data(fqr=self.fqr, template=True)
|
|
2359 |
|
|
2360 |
# Add all sub-objects to the data object
|
|
2361 |
def add_data_objects(feature, data_obj, value_list):
|
|
2362 |
refs = feature.list_features()
|
|
2363 |
if len(refs) != len(value_list):
|
|
2364 |
raise ValueError("Data value list is invalid")
|
|
2365 |
for i, ref in enumerate(refs):
|
|
2366 |
value = value_list[i]
|
|
2367 |
subfea = feature.get_feature(ref)
|
|
2368 |
if isinstance(value, list):
|
|
2369 |
subdata = Data(ref=ref)
|
|
2370 |
data_obj.add(subdata)
|
|
2371 |
add_data_objects(feature.get_feature(ref), subdata, value)
|
|
2372 |
else:
|
|
2373 |
if value is not None:
|
|
2374 |
subdata = Data(ref=ref, value=subfea.set_value_cast(value))
|
|
2375 |
data_obj.add(subdata)
|
|
2376 |
add_data_objects(self, templatedata, data)
|
|
2377 |
|
|
2378 |
self._set_template_data(templatedata)
|
|
2379 |
|
|
2380 |
# Remove any existing template data
|
|
2381 |
pconfig = self.find_parent(type=Configuration)
|
|
2382 |
dataobjs = pconfig._traverse(type=Data, filters=[lambda x: x.template and x.fqr == self.fqr])
|
|
2383 |
if dataobjs:
|
|
2384 |
for dataobj in dataobjs:
|
|
2385 |
dataobj._parent._remove(dataobj.get_fullref())
|
|
2386 |
|
|
2387 |
# Add the template data to the parent config (beginning of the data section)
|
|
2388 |
pconfig.add_data(self._templatedata, policy=container.PREPEND)
|
0
|
2389 |
|
|
2390 |
def get_template(self):
|
|
2391 |
"""
|
|
2392 |
Add a feature data row for a new data in this sequence
|
|
2393 |
"""
|
|
2394 |
#self._set_template(None)
|
|
2395 |
# set the initial data if it is given
|
|
2396 |
if self._templatedata:
|
3
|
2397 |
def get_data_items(feature, data_obj):
|
|
2398 |
refs = feature.list_features()
|
|
2399 |
if refs:
|
|
2400 |
result = []
|
|
2401 |
for ref in refs:
|
|
2402 |
if data_obj._has(ref):
|
|
2403 |
result.append(get_data_items(feature.get_feature(ref), data_obj._get(ref)))
|
|
2404 |
else:
|
|
2405 |
result.append(None)
|
|
2406 |
return result
|
|
2407 |
else:
|
|
2408 |
return data_obj.value
|
|
2409 |
return get_data_items(self, self._templatedata)
|
0
|
2410 |
else:
|
|
2411 |
return None
|
|
2412 |
|
|
2413 |
def get_data(self):
|
|
2414 |
"""
|
|
2415 |
Helper function to get the topmost data value from the default view.
|
|
2416 |
"""
|
|
2417 |
if self.dataproxy._has(self.dataelem_name):
|
|
2418 |
return utils.get_list(self.dataproxy._get(self.dataelem_name))
|
|
2419 |
else:
|
|
2420 |
return []
|
|
2421 |
|
|
2422 |
def add_data(self, data):
|
|
2423 |
"""
|
|
2424 |
Add a data value.
|
|
2425 |
@param data: A Data object
|
|
2426 |
"""
|
|
2427 |
# Skip template data adding
|
|
2428 |
if data.template:
|
|
2429 |
self._set_template_data(data)
|
|
2430 |
else:
|
|
2431 |
# Get the data index
|
|
2432 |
self._add_datarow(data, self._get_policy(data))
|
|
2433 |
return
|
|
2434 |
|
|
2435 |
def get_value(self, attr=None):
|
|
2436 |
"""
|
|
2437 |
Helper function to get the topmost data value from the default view.
|
|
2438 |
"""
|
3
|
2439 |
if self._has_empty_sequence_marker():
|
|
2440 |
return []
|
|
2441 |
|
0
|
2442 |
datatable = self.get_data()
|
3
|
2443 |
rettable = []
|
0
|
2444 |
for row in datatable:
|
|
2445 |
rowvalues = row.value
|
|
2446 |
rettable.append(rowvalues)
|
|
2447 |
return rettable
|
|
2448 |
|
3
|
2449 |
def get_original_value(self, attr=None):
|
|
2450 |
"""
|
|
2451 |
Get the current value of the feature
|
|
2452 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2453 |
"""
|
|
2454 |
if self._has_empty_sequence_marker():
|
|
2455 |
return []
|
|
2456 |
|
|
2457 |
datatable = self.get_data()
|
|
2458 |
rettable = []
|
|
2459 |
for row in datatable:
|
|
2460 |
rowvalues = row.get_original_value()
|
|
2461 |
rettable.append(rowvalues)
|
|
2462 |
return rettable
|
|
2463 |
|
0
|
2464 |
def set_value(self, value, attr=None):
|
|
2465 |
"""
|
|
2466 |
Set the current value for this feature. Set the value on the topmost layer.
|
|
2467 |
@param value: the value to set. The value must be a two dimensional array (e.g. matrix)
|
|
2468 |
"""
|
3
|
2469 |
if value:
|
|
2470 |
# Add the first item with replace policy
|
|
2471 |
self.add_sequence(value[0], self.POLICY_REPLACE)
|
|
2472 |
for row in value[1:]:
|
|
2473 |
self.add_sequence(row)
|
|
2474 |
else:
|
|
2475 |
# Setting the sequence to empty, so add one empty item-setting
|
|
2476 |
# to signify that
|
|
2477 |
self.add_sequence(None, self.POLICY_REPLACE)
|
|
2478 |
|
|
2479 |
# Strip all sub-elements from the data element just created,
|
|
2480 |
# since the ConfML spec says that an empty sequence is denoted
|
|
2481 |
# by a single empty data element
|
|
2482 |
data_elem = self.get_data()[0].get_datas()[0]
|
|
2483 |
for r in list(data_elem._order):
|
|
2484 |
data_elem._remove(r)
|
0
|
2485 |
|
|
2486 |
def is_sequence(self):
|
|
2487 |
""" Return always true from a sequence object """
|
|
2488 |
return True
|
|
2489 |
|
3
|
2490 |
def is_sequence_root(self):
|
|
2491 |
""" Return true if this feature is a sequence object it self """
|
|
2492 |
return True
|
|
2493 |
|
|
2494 |
def get_column_features(self):
|
|
2495 |
""" Return a list of sequence subfeature, which are the columns of the sequence """
|
|
2496 |
columns = []
|
|
2497 |
for subref in self.list_features():
|
|
2498 |
columns.append(self.get_feature(subref))
|
|
2499 |
return columns
|
|
2500 |
|
0
|
2501 |
def get_sequence_parent(self):
|
|
2502 |
""" Return this object as a sequence parent """
|
|
2503 |
return self
|
|
2504 |
|
|
2505 |
value = property(get_value, set_value)
|
|
2506 |
data = property(get_data)
|
|
2507 |
|
3
|
2508 |
|
|
2509 |
def add_sequence_feature(parent_feature, feature, path=""):
|
|
2510 |
"""
|
|
2511 |
Override of the add_feature function in sequence to set the sequence childs to act
|
|
2512 |
as columns of the feature sequence
|
|
2513 |
@param parent_feature: The parent feature where the feature object is added
|
|
2514 |
@param feature: The Feature object to add
|
|
2515 |
@param path: path to feature if it not added directly under parent_fea
|
|
2516 |
"""
|
|
2517 |
# modify all possible children of feature
|
|
2518 |
for fea in feature._traverse(type=Feature):
|
|
2519 |
to_sequence_feature(fea)
|
|
2520 |
|
|
2521 |
# Finally modify and add this feature to parent_feat
|
|
2522 |
to_sequence_feature(feature)
|
|
2523 |
parent_feature._add_to_path(path, feature)
|
|
2524 |
|
|
2525 |
def to_sequence_feature(feature):
|
|
2526 |
"""
|
|
2527 |
modify a Feature object to sequence feature that will return column like data from a sequence.
|
|
2528 |
@param feature: The Feature object for which is modified.
|
|
2529 |
"""
|
|
2530 |
feature.get_value = feature.get_column_value
|
|
2531 |
feature.get_original_value = feature.get_column_original_value
|
|
2532 |
feature.set_value = feature.set_column_value
|
|
2533 |
feature.add_feature = feature.add_sequence_feature
|
|
2534 |
|
|
2535 |
def get_column_value(feasequence, ref, attr=None):
|
|
2536 |
"""
|
|
2537 |
Get the value of the featuresequence column
|
|
2538 |
@param feasequence: the feature sequence object
|
|
2539 |
@param ref: the reference to the column
|
|
2540 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2541 |
"""
|
|
2542 |
""" get the feature specific data from sequence => a column of data table """
|
|
2543 |
coldata = []
|
|
2544 |
for row in feasequence.data:
|
|
2545 |
feadata = row.get_feature(ref)
|
|
2546 |
coldata.append(feadata.get_value(attr))
|
|
2547 |
return coldata
|
|
2548 |
|
|
2549 |
def get_column_original_value(feasequence, ref, attr=None):
|
|
2550 |
"""
|
|
2551 |
Get the value of the featuresequence column
|
|
2552 |
@param feasequence: the feature sequence object
|
|
2553 |
@param ref: the reference to the column
|
|
2554 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2555 |
"""
|
|
2556 |
""" get the feature specific data from sequence => a column of data table """
|
|
2557 |
coldata = []
|
|
2558 |
for row in feasequence.data:
|
|
2559 |
feadata = row.get_feature(ref)
|
|
2560 |
coldata.append(feadata.get_original_value(attr))
|
|
2561 |
return coldata
|
|
2562 |
|
|
2563 |
def set_column_value(feasequence, ref, value, attr=None):
|
|
2564 |
"""
|
|
2565 |
Get the value of the featuresequence column
|
|
2566 |
@param feasequence: the feature sequence object
|
|
2567 |
@param ref: the reference to the column
|
|
2568 |
@param value: the value to set. This must be a list instance.
|
|
2569 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2570 |
"""
|
|
2571 |
if not isinstance(value,list):
|
|
2572 |
raise exceptions.ConeException("The value for feature sequence '%s' column '%s' must be a list instance. Got %r" % (feasequence.fqr, ref, value))
|
|
2573 |
seqrows = feasequence.data
|
|
2574 |
if len(seqrows) < len(value):
|
|
2575 |
raise exceptions.ConeException("Too many values for feature sequence '%s' column '%s'. Sequence holds only %d rows. Got %d data values in %r" % (feasequence.fqr, ref, len(seqrows), len(value), value))
|
|
2576 |
for i in range(0, len(value)):
|
|
2577 |
feadata = seqrows[i].get_feature(ref)
|
|
2578 |
feadata.set_value(value[i])
|
|
2579 |
|
0
|
2580 |
class FeatureSequenceCell(Feature):
|
|
2581 |
"""
|
|
2582 |
A Feature class. Feature is the base for all Configurable items in a Configuration.
|
|
2583 |
"""
|
|
2584 |
def __init__(self, ref="", **kwargs):
|
3
|
2585 |
super(FeatureSequenceCell, self).__init__(ref)
|
0
|
2586 |
self.name = kwargs.get('name', ref)
|
|
2587 |
self.type = 'seqcell'
|
|
2588 |
|
|
2589 |
def get_value(self, attr=None):
|
|
2590 |
"""
|
|
2591 |
Get the current value of the feature
|
|
2592 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2593 |
"""
|
|
2594 |
return self.dataproxy._get_value(attr)
|
|
2595 |
|
|
2596 |
def set_value(self, value):
|
|
2597 |
"""
|
|
2598 |
Set the current value for this feature. Set the value on the topmost layer.
|
|
2599 |
@param value: the value to set
|
|
2600 |
"""
|
|
2601 |
# The sequence cell only updates the latest value in the proxy
|
|
2602 |
self.dataproxy.get_data().set_value(value)
|
|
2603 |
|
|
2604 |
value = property(get_value, set_value)
|
|
2605 |
|
|
2606 |
class FeatureSequenceSub(Feature):
|
|
2607 |
"""
|
|
2608 |
A Feature class. Feature is the base for all Configurable items in a Configuration.
|
|
2609 |
"""
|
|
2610 |
def __init__(self, ref="", **kwargs):
|
3
|
2611 |
super(FeatureSequenceSub, self).__init__(ref)
|
0
|
2612 |
self.name = kwargs.get('name', ref)
|
|
2613 |
self.type = 'subseq'
|
|
2614 |
self._index = 0
|
|
2615 |
|
|
2616 |
def get_index(self):
|
|
2617 |
"""
|
|
2618 |
@return : the index of the data element for sequential data defined inside the same configuration.
|
|
2619 |
0 for normal data.
|
|
2620 |
"""
|
|
2621 |
return self._index
|
|
2622 |
|
|
2623 |
def set_value(self, value, attr=None):
|
|
2624 |
"""
|
|
2625 |
Set the current value for this sequence row.
|
|
2626 |
@param value: the value row to set
|
|
2627 |
"""
|
|
2628 |
if utils.is_list(value):
|
3
|
2629 |
for subindex in range(0, len(value)):
|
0
|
2630 |
self.dataproxy[subindex].get_data().set_value(value[subindex])
|
3
|
2631 |
else:
|
|
2632 |
data_objs = self.convert_value_to_data(value)
|
|
2633 |
data_object_where_to_add = self._parent._get_data()
|
|
2634 |
|
|
2635 |
self.dataproxy._set_datas(data_objs, attr)
|
|
2636 |
data_object_where_to_add._add(data_objs, container.REPLACE)
|
0
|
2637 |
|
|
2638 |
def get_value(self, attr=None):
|
|
2639 |
"""
|
|
2640 |
Set the current value for this feature. Set the value on the topmost layer.
|
|
2641 |
@param value: the value to set
|
|
2642 |
"""
|
3
|
2643 |
# Handle empty sequences
|
|
2644 |
if self.get_sequence_parent()._has_empty_sequence_marker():
|
|
2645 |
return []
|
|
2646 |
|
0
|
2647 |
# The sequence cell only updates the latest value in the proxy
|
|
2648 |
childdatas = self.dataproxy._objects()
|
|
2649 |
if len(childdatas) > 0:
|
|
2650 |
return [subdata.value for subdata in childdatas]
|
|
2651 |
else:
|
3
|
2652 |
return super(FeatureSequenceSub,self).get_value(attr)
|
|
2653 |
|
|
2654 |
def get_original_value(self, attr=None):
|
|
2655 |
"""
|
|
2656 |
Get the current value of the feature
|
|
2657 |
@param attr: The attribute name of the data. E.g. attr='data', attr='rfs'
|
|
2658 |
"""
|
|
2659 |
# Handle empty sequences
|
|
2660 |
if self.get_sequence_parent()._has_empty_sequence_marker():
|
|
2661 |
return []
|
|
2662 |
|
|
2663 |
childdatas = self.dataproxy._objects()
|
|
2664 |
if len(childdatas) > 0:
|
|
2665 |
return [subdata.get_original_value() for subdata in childdatas]
|
|
2666 |
else:
|
|
2667 |
return self.dataproxy._get_value(attr)
|
|
2668 |
|
0
|
2669 |
value = property(get_value, set_value)
|
|
2670 |
|
|
2671 |
|
|
2672 |
class FeatureLink(Base):
|
|
2673 |
"""
|
|
2674 |
A _FeatureProxy class. _FeatureProxy is the object that is added to View as a
|
|
2675 |
link to the actual Feature object.
|
|
2676 |
"""
|
3
|
2677 |
""" class variable for defining the override attributes"""
|
|
2678 |
override_attributes = ['name']
|
|
2679 |
ref_prefix = 'link_'
|
|
2680 |
PROXYREF_PREFIX = 'proxy_'
|
|
2681 |
|
|
2682 |
def __init__(self, ref="", **kwargs):
|
0
|
2683 |
# Store the fully qualified reference to this object
|
3
|
2684 |
self.link = kwargs.get('link', ref)
|
|
2685 |
self.name = kwargs.get('name', None)
|
|
2686 |
ref = self.get_featurelink_ref(self.link)
|
|
2687 |
# the reference of this particular object
|
|
2688 |
super(FeatureLink, self).__init__(ref, **kwargs)
|
0
|
2689 |
self._obj = None
|
|
2690 |
self._populated = False
|
|
2691 |
|
3
|
2692 |
def add(self, child, policy=container.REPLACE):
|
|
2693 |
"""
|
|
2694 |
Add an override to enable adding any override attribute to a featurelink object.
|
|
2695 |
|
|
2696 |
A generic add function to add child objects. The function is intended to act as
|
|
2697 |
proxy function that call the correct add function based on the child objects class.
|
|
2698 |
|
|
2699 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
2700 |
@param child: the child object to add
|
|
2701 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
2702 |
"""
|
|
2703 |
if isinstance(child, Base):
|
|
2704 |
self._add(child, policy)
|
|
2705 |
else:
|
|
2706 |
raise exceptions.IncorrectClassError("Cannot add %s to %s" % (child, self))
|
|
2707 |
|
|
2708 |
def get_name(self):
|
|
2709 |
"""
|
|
2710 |
Return the name of the featurelink
|
|
2711 |
"""
|
|
2712 |
return self.name
|
|
2713 |
|
|
2714 |
def set_name(self, name):
|
|
2715 |
"""
|
|
2716 |
Set the name
|
|
2717 |
"""
|
|
2718 |
self.name = name
|
|
2719 |
|
0
|
2720 |
@property
|
|
2721 |
def fqr(self):
|
|
2722 |
return self.link
|
|
2723 |
|
|
2724 |
def populate(self):
|
|
2725 |
"""
|
|
2726 |
Populate or fetch the link to the actual feature for this featureproxy.
|
|
2727 |
This method fetches the feature to the _obj member variable and populates also
|
|
2728 |
subfeatures.
|
|
2729 |
"""
|
|
2730 |
try:
|
|
2731 |
if not self._populated:
|
|
2732 |
feas = self.get_default_view().get_features(self.link)
|
3
|
2733 |
# get the non wildcard part of ref
|
|
2734 |
static_ref = utils.dottedref.get_static_ref(self.link)
|
0
|
2735 |
# add the found features to the parent
|
|
2736 |
for fea in feas:
|
3
|
2737 |
override_attrs = {}
|
|
2738 |
# override the FeatureProxy object with exactly same reference
|
|
2739 |
# (in feat/* case dont override the children features)
|
|
2740 |
if fea.fqr == static_ref:
|
|
2741 |
override_attrs = self.get_attributes()
|
|
2742 |
feature = fea._obj
|
|
2743 |
proxy_ref = self.get_featureproxy_ref(feature.fqr)
|
|
2744 |
proxy = _FeatureProxy(proxy_ref, feature, **override_attrs)
|
|
2745 |
self._get_parent()._add(proxy)
|
|
2746 |
|
0
|
2747 |
except exceptions.NotFound, e:
|
|
2748 |
parent_view = self._find_parent_or_default(type=View)
|
|
2749 |
view_name = parent_view.get_name()
|
|
2750 |
logging.getLogger('cone').info("Warning: Feature '%s' in view '%s' not found." % (self.link, view_name))
|
|
2751 |
|
3
|
2752 |
def get_attributes(self):
|
|
2753 |
"""
|
|
2754 |
Returns a list of FeatureLink attributes that override settings of the original feature.
|
|
2755 |
@return: a dictionary of attribute key : value pairs.
|
|
2756 |
"""
|
|
2757 |
attrs = {}
|
|
2758 |
for attr in self.override_attributes:
|
|
2759 |
# try to get the attribute from this object
|
|
2760 |
# and set it to the attribute list if it not None
|
|
2761 |
try:
|
|
2762 |
value = getattr(self, attr)
|
|
2763 |
if value != None: attrs[attr] = value
|
|
2764 |
except AttributeError:
|
|
2765 |
pass
|
|
2766 |
return attrs
|
|
2767 |
|
|
2768 |
@classmethod
|
|
2769 |
def get_featurelink_ref(cls, ref):
|
|
2770 |
"""
|
|
2771 |
return a featurelink ref from a feature ref.
|
|
2772 |
This is needed to make the featurelink object refs unique in a container
|
|
2773 |
that has Features.
|
|
2774 |
"""
|
|
2775 |
return cls.ref_prefix + ref.replace('.', '_').replace('/','_')
|
|
2776 |
|
|
2777 |
@classmethod
|
|
2778 |
def get_featureproxy_ref(cls, ref):
|
|
2779 |
"""
|
|
2780 |
Return a ref for a given setting fqr to be used under a group.
|
|
2781 |
This is needed to make the featureproxy object refs unique in a container
|
|
2782 |
that has Features.
|
|
2783 |
"""
|
|
2784 |
return cls.PROXYREF_PREFIX + ref.replace('.', '_').replace('/','_')
|
0
|
2785 |
|
|
2786 |
class _FeatureProxy(container.ObjectProxyContainer, Base):
|
|
2787 |
"""
|
|
2788 |
A _FeatureProxy class. _FeatureProxy is the object that is added to View as a
|
|
2789 |
link to the actual Feature object.
|
|
2790 |
"""
|
|
2791 |
def __init__(self, ref="", obj=None, **kwargs):
|
3
|
2792 |
container.ObjectProxyContainer.__init__(self, obj, ref)
|
|
2793 |
Base.__init__(self, ref, **kwargs)
|
0
|
2794 |
self.support_data = False
|
3
|
2795 |
|
0
|
2796 |
def __getattr__(self, name):
|
|
2797 |
"""
|
|
2798 |
First check if the requested attr is a children then
|
|
2799 |
direct all not found attribute calls to the sub object getattr
|
|
2800 |
"""
|
|
2801 |
try:
|
|
2802 |
return self.__dict__['_children'][name]
|
|
2803 |
except KeyError:
|
|
2804 |
return getattr(self._obj, name)
|
|
2805 |
|
|
2806 |
def __getitem__(self, index):
|
|
2807 |
return self._objects()[index]
|
|
2808 |
|
|
2809 |
def __setitem__(self, index, value):
|
3
|
2810 |
raise exceptions.NotSupportedException()
|
0
|
2811 |
|
|
2812 |
def __delitem__(self, index):
|
|
2813 |
item = self.__getitem__(index)
|
|
2814 |
return self._remove(item.get_ref())
|
|
2815 |
|
|
2816 |
def __len__(self):
|
|
2817 |
return len(self._order)
|
|
2818 |
|
|
2819 |
def _supported_type(self, obj):
|
|
2820 |
if isinstance(obj, _FeatureProxy):
|
|
2821 |
return True
|
|
2822 |
else:
|
|
2823 |
return False
|
|
2824 |
|
|
2825 |
def _default_object(self, name):
|
|
2826 |
return Group(name)
|
|
2827 |
|
|
2828 |
def _set_parent(self, newparent):
|
|
2829 |
"""
|
|
2830 |
@param newparent: The new parent object
|
|
2831 |
@return: None
|
|
2832 |
"""
|
|
2833 |
self._parent = newparent
|
|
2834 |
|
3
|
2835 |
def get_proxied_obj(self):
|
|
2836 |
"""
|
|
2837 |
@return: Returns proxied object.
|
|
2838 |
"""
|
|
2839 |
return self._obj
|
|
2840 |
|
0
|
2841 |
def add_feature(self, feature, path=""):
|
|
2842 |
"""
|
|
2843 |
"""
|
|
2844 |
if not isinstance(feature, Feature):
|
|
2845 |
raise exceptions.IncorrectClassError("add_feature requires instance of Feature!! Given %s" % feature)
|
|
2846 |
if not self.support_data:
|
|
2847 |
self._add_to_path(path, _FeatureProxy(feature._name, feature))
|
|
2848 |
else:
|
|
2849 |
self._add_to_path(path, _FeatureDataProxy(feature._name, feature))
|
|
2850 |
|
|
2851 |
def remove_feature(self, ref):
|
|
2852 |
"""
|
|
2853 |
remove a given feature from this view by reference.
|
|
2854 |
@param ref:
|
|
2855 |
"""
|
|
2856 |
self._remove(ref)
|
|
2857 |
|
|
2858 |
def get_feature(self, path):
|
|
2859 |
"""
|
|
2860 |
@param path: The path (ref) to the given feature
|
|
2861 |
"""
|
|
2862 |
return self._get(path)
|
|
2863 |
|
|
2864 |
def list_features(self):
|
|
2865 |
"""
|
|
2866 |
Return a array of all Feature children references under this object.
|
|
2867 |
"""
|
|
2868 |
return self._list()
|
|
2869 |
|
|
2870 |
def list_all_features(self):
|
|
2871 |
"""
|
|
2872 |
Return a array of all Feature children references under this object.
|
|
2873 |
"""
|
|
2874 |
return [fea._path(self) for fea in self._traverse(type=_FeatureProxy)]
|
|
2875 |
|
|
2876 |
def populate(self):
|
|
2877 |
"""
|
|
2878 |
Dummy implementation of populate
|
|
2879 |
"""
|
|
2880 |
pass
|
|
2881 |
|
3
|
2882 |
def has_attribute(self, name):
|
|
2883 |
"""
|
|
2884 |
Perform a check whether an attribute with given name is stored inside the
|
|
2885 |
_FeatureProxy. The check does not extend to the proxied (_obj) insanses or
|
|
2886 |
children of this proxy.
|
|
2887 |
|
|
2888 |
@return: True when an attribute is a real attribute in this _FeatureProxy object.
|
|
2889 |
"""
|
|
2890 |
return self.__dict__.has_key(name)
|
|
2891 |
|
|
2892 |
def get_option(self, ref):
|
|
2893 |
"""
|
|
2894 |
@param name: The option reference of the option (as returned by list_options())
|
|
2895 |
"""
|
|
2896 |
real_ref = 'opt_' + ref
|
|
2897 |
for op in self.options.values():
|
|
2898 |
if op.ref == real_ref:
|
|
2899 |
return op
|
|
2900 |
else:
|
|
2901 |
|
|
2902 |
obj = self.get_proxied_obj()._get(real_ref)
|
|
2903 |
if not isinstance(obj, Option):
|
|
2904 |
raise TypeError('Object %r is not an instance of Option (%r instead)' % (real_ref, type(obj)))
|
|
2905 |
return obj
|
|
2906 |
|
|
2907 |
def list_options(self):
|
|
2908 |
"""
|
|
2909 |
Return a array of all Option children references under this object.
|
|
2910 |
"""
|
|
2911 |
opts = self.get_proxied_obj().list_options()
|
|
2912 |
|
|
2913 |
for opt in self.options:
|
|
2914 |
opts.append(self.options[opt].ref[4:])
|
|
2915 |
|
|
2916 |
return opts
|
|
2917 |
|
|
2918 |
def get_property(self, ref):
|
|
2919 |
"""
|
|
2920 |
@param name: The property reference of the property (as returned by list_properties())
|
|
2921 |
"""
|
|
2922 |
for prop in self.properties.values():
|
|
2923 |
if prop.ref == Property.to_propertyref(ref):
|
|
2924 |
return prop
|
|
2925 |
else:
|
|
2926 |
obj = self.get_proxied_obj()._get(Property.to_propertyref(ref))
|
|
2927 |
return obj
|
|
2928 |
|
|
2929 |
def list_properties(self):
|
|
2930 |
"""
|
|
2931 |
Return a array of all Property children references under this object.
|
|
2932 |
"""
|
|
2933 |
props = self.get_proxied_obj().list_properties()
|
|
2934 |
|
|
2935 |
for pr in self.properties:
|
|
2936 |
props.append(Property.to_normref(self.properties[pr].ref))
|
|
2937 |
|
|
2938 |
return props
|
|
2939 |
|
|
2940 |
|
0
|
2941 |
class _FeatureDataProxy(_FeatureProxy):
|
|
2942 |
"""
|
|
2943 |
A Feature class. Feature is the base for all Configurable items in a Configuration.
|
|
2944 |
"""
|
|
2945 |
DEFAULT_KEY = 'data'
|
|
2946 |
def __init__(self, ref="", obj=None, **kwargs):
|
|
2947 |
# Initialize _obj to None, because __getattr__(), __setattr__()
|
|
2948 |
# and __delattr__() access it.
|
|
2949 |
# Note that we cannot use self._obj = None here, since that would
|
|
2950 |
# invoke __setattr__(), causing a kind of a chicken-and-egg problem
|
|
2951 |
object.__setattr__(self, '_obj', None)
|
|
2952 |
|
|
2953 |
super(_FeatureDataProxy, self).__init__(ref, obj)
|
|
2954 |
self.support_data = True
|
|
2955 |
""" Create the data container of all types of data. Add the key for the default key. """
|
|
2956 |
|
|
2957 |
self.defaultkey = _FeatureDataProxy.DEFAULT_KEY
|
|
2958 |
self.datas = {self.defaultkey : []}
|
|
2959 |
|
|
2960 |
def __getattr__(self, name):
|
|
2961 |
"""
|
|
2962 |
"""
|
|
2963 |
if object.__getattribute__(self, '_obj') is not None:
|
3
|
2964 |
self.get_proxied_obj().dataproxy = self
|
0
|
2965 |
|
|
2966 |
if name in Feature.PROPERTIES:
|
3
|
2967 |
return getattr(self.get_proxied_obj(), name)
|
0
|
2968 |
else:
|
|
2969 |
return super(_FeatureDataProxy, self).__getattr__(name)
|
|
2970 |
|
|
2971 |
def __setattr__(self, name, value):
|
|
2972 |
"""
|
|
2973 |
"""
|
|
2974 |
if object.__getattribute__(self, '_obj') is not None:
|
3
|
2975 |
self.get_proxied_obj().dataproxy = self
|
0
|
2976 |
|
|
2977 |
if name in Feature.PROPERTIES:
|
3
|
2978 |
return setattr(self.get_proxied_obj(), name, value)
|
0
|
2979 |
else:
|
|
2980 |
super(_FeatureDataProxy, self).__setattr__(name, value)
|
|
2981 |
|
|
2982 |
def __delattr__(self, name):
|
|
2983 |
"""
|
|
2984 |
"""
|
|
2985 |
if name in Feature.PROPERTIES:
|
3
|
2986 |
return delattr(self.get_proxied_obj(), name)
|
0
|
2987 |
else:
|
|
2988 |
return super(_FeatureDataProxy, self).__delattr__(name)
|
|
2989 |
|
|
2990 |
def _add_data(self, data):
|
|
2991 |
"""
|
3
|
2992 |
Add a data value or a list of data values.
|
0
|
2993 |
@param data: A Data object
|
|
2994 |
"""
|
3
|
2995 |
if isinstance(data, list):
|
|
2996 |
for d in data: self._add_data(d)
|
|
2997 |
return
|
|
2998 |
|
0
|
2999 |
try:
|
|
3000 |
self.datas[data.attr].append(data)
|
|
3001 |
except KeyError:
|
|
3002 |
""" Create a list object for missing attribute """
|
|
3003 |
self.datas[data.attr] = []
|
|
3004 |
self.datas[data.attr].append(data)
|
|
3005 |
|
|
3006 |
def _get_data(self, attr=None):
|
|
3007 |
"""
|
|
3008 |
Get the data value. in sequence setting cases returns an array of data.
|
|
3009 |
"""
|
|
3010 |
dataattr = attr or self.defaultkey
|
|
3011 |
try:
|
|
3012 |
if len(self.datas[dataattr]) > 0:
|
|
3013 |
return self.datas[dataattr][-1]
|
|
3014 |
else:
|
|
3015 |
return None
|
|
3016 |
except KeyError:
|
|
3017 |
""" return None for missing attribute """
|
|
3018 |
return None
|
|
3019 |
|
|
3020 |
def _get_datas(self, attr=None):
|
|
3021 |
"""
|
|
3022 |
Get the entire data array.
|
|
3023 |
"""
|
|
3024 |
dataattr = attr or self.defaultkey
|
3
|
3025 |
return self.datas.get(dataattr, [])
|
|
3026 |
|
|
3027 |
def _set_datas(self, datas, attr=None):
|
|
3028 |
"""
|
|
3029 |
Set the entire data array.
|
|
3030 |
"""
|
|
3031 |
dataattr = attr or self.defaultkey
|
|
3032 |
self.datas[dataattr] = list(datas)
|
0
|
3033 |
|
|
3034 |
def _get_value(self, attr=None):
|
|
3035 |
"""
|
|
3036 |
Get the topmost data value.
|
|
3037 |
"""
|
|
3038 |
if self._get_data(attr):
|
|
3039 |
return self._get_data(attr).get_value()
|
|
3040 |
else:
|
|
3041 |
return None
|
3
|
3042 |
|
0
|
3043 |
def _set_value(self, datavalue, attr=None):
|
|
3044 |
"""
|
|
3045 |
Set the value for the feature the last configuration in the current hierarchy
|
|
3046 |
@param value: The value for the feature.
|
|
3047 |
@return: The created Data object.
|
|
3048 |
"""
|
|
3049 |
# Make sure that data value exists only once the the last configuration layer
|
|
3050 |
# So if last_data exists on last layer, update the value of that data element.
|
|
3051 |
# otherwise create a new data elem to the topmost layer
|
|
3052 |
dataobj = self._get_data(attr)
|
|
3053 |
last_config = self.get_root_configuration().get_last_configuration()
|
|
3054 |
if dataobj and dataobj.find_parent(type=Configuration) == last_config:
|
|
3055 |
dataobj.set_value(datavalue)
|
|
3056 |
else:
|
|
3057 |
dataobj = Data(fqr=self.fqr, value=datavalue, attr=attr)
|
|
3058 |
last_config.add_data(dataobj)
|
|
3059 |
self._add_data(dataobj)
|
|
3060 |
return dataobj
|
|
3061 |
|
|
3062 |
def _del_value(self, attr=None):
|
|
3063 |
"""
|
|
3064 |
Remove the
|
|
3065 |
"""
|
|
3066 |
data = self._get_data(attr)
|
|
3067 |
if data:
|
|
3068 |
dataattr = attr or self.defaultkey
|
|
3069 |
parentconfig = data.find_parent(type=Configuration)
|
|
3070 |
if parentconfig:
|
|
3071 |
parentconfig.remove_data(data.get_fullfqr())
|
|
3072 |
del self.datas[dataattr][-1]
|
|
3073 |
|
|
3074 |
def _get_values(self, attr=None):
|
|
3075 |
"""
|
|
3076 |
Get the topmost data value.
|
|
3077 |
"""
|
|
3078 |
dataattr = attr or self.defaultkey
|
|
3079 |
return [dataelem.get_value() for dataelem in self.datas[dataattr]]
|
|
3080 |
|
|
3081 |
|
|
3082 |
class DataBase(Base):
|
|
3083 |
def __init__(self, ref="", **kwargs):
|
|
3084 |
super(DataBase, self).__init__(ref, **kwargs)
|
|
3085 |
|
|
3086 |
def _supported_type(self, obj):
|
|
3087 |
if isinstance(obj, (DataContainer, DataBase)):
|
|
3088 |
return True
|
|
3089 |
else:
|
|
3090 |
return False
|
|
3091 |
|
|
3092 |
def _default_object(self, name):
|
|
3093 |
return Data(ref=name)
|
|
3094 |
|
|
3095 |
def count(self):
|
|
3096 |
return len(self._objects())
|
|
3097 |
|
|
3098 |
def add(self, child, policy=container.REPLACE):
|
|
3099 |
"""
|
|
3100 |
A generic add function to add child objects. The function is intended to act as
|
|
3101 |
proxy function that call the correct add function based on the child objects class.
|
|
3102 |
|
|
3103 |
Example: obj.add(Feature("test")), actually obj.add_feature(Feature("test"))
|
|
3104 |
@param child: the child object to add
|
|
3105 |
@raise IncorrectClassError: if the given class cannot be added to this object.
|
|
3106 |
"""
|
|
3107 |
if isinstance(child, (Data)):
|
|
3108 |
self._add(child, container.APPEND)
|
|
3109 |
else:
|
|
3110 |
raise exceptions.IncorrectClassError("Cannot add %s object to %s" % (child, self))
|
|
3111 |
|
|
3112 |
|
|
3113 |
class DataContainer(DataBase):
|
|
3114 |
def __init__(self, ref="", **kwargs):
|
|
3115 |
super(DataContainer, self).__init__(ref, **kwargs)
|
|
3116 |
|
|
3117 |
|
|
3118 |
class Data(DataBase):
|
|
3119 |
"""
|
|
3120 |
The data element can contain any data setting for a feature. The data element can be
|
|
3121 |
a value definition for any type of data. It basically just links some data to a feature.
|
|
3122 |
The default Data attribute is 'data', but it can be any string. For example current use case
|
|
3123 |
is 'rfs'.
|
|
3124 |
"""
|
|
3125 |
def __init__(self, **kwargs):
|
|
3126 |
"""
|
|
3127 |
@param ref: the reference to the feature. E.g. foo
|
|
3128 |
@param fqr: the full reference to the feature. E.g. 'foo.bar'
|
|
3129 |
@param value: the value of the data
|
|
3130 |
@param attr: the attribute which the Data object defines. e.g. default is 'data'. But could be
|
|
3131 |
for example 'rfs'
|
|
3132 |
"""
|
|
3133 |
name = kwargs.get('ref', '')
|
|
3134 |
self.fearef = kwargs.get('fqr', None)
|
|
3135 |
if self.fearef:
|
|
3136 |
(namespace, name) = utils.dottedref.psplit_ref(self.fearef)
|
|
3137 |
super(Data, self).__init__(name)
|
|
3138 |
self.value = kwargs.get('value', None)
|
|
3139 |
self.attr = kwargs.get('attr') or 'data'
|
|
3140 |
self.policy = kwargs.get('policy', '')
|
|
3141 |
self.template = kwargs.get('template', False)
|
|
3142 |
self.map = kwargs.get('map')
|
3
|
3143 |
self.empty = kwargs.get('empty', False)
|
|
3144 |
self.lineno = None
|
|
3145 |
|
|
3146 |
def __setstate__(self, state):
|
|
3147 |
super(Data, self).__setstate__(state)
|
|
3148 |
self.value = state.get('value', None)
|
|
3149 |
self.attr = state.get('attr', None)
|
|
3150 |
self.policy = state.get('policy', '')
|
|
3151 |
self.map = state.get('map', None)
|
|
3152 |
self.template = state.get('template', False)
|
|
3153 |
self.lineno = state.get('lineno', None)
|
|
3154 |
self.fearef = state.get('fearef', None)
|
0
|
3155 |
|
|
3156 |
def get_fearef(self):
|
|
3157 |
if self.fearef:
|
|
3158 |
return self.fearef
|
|
3159 |
else:
|
|
3160 |
return self.fqr
|
|
3161 |
|
|
3162 |
def get_value(self):
|
3
|
3163 |
return self.value
|
0
|
3164 |
|
|
3165 |
def get_map(self):
|
|
3166 |
return self.map
|
|
3167 |
|
|
3168 |
def set_map(self, map):
|
|
3169 |
self.map = map
|
|
3170 |
if self.value:
|
|
3171 |
#Either value or mapping can be defined. Not both.
|
|
3172 |
self.value = None
|
|
3173 |
|
|
3174 |
def set_value(self, value):
|
|
3175 |
self.value = value
|
|
3176 |
if self.map:
|
|
3177 |
#Either value or mapping can be defined. Not both.
|
|
3178 |
self.map = None
|
|
3179 |
|
|
3180 |
def get_policy(self): return self._policy
|
|
3181 |
def set_policy(self, value): self._policy = value
|
|
3182 |
def del_policy(self): self._policy = None
|
|
3183 |
policy = property(get_policy, set_policy, del_policy)
|
|
3184 |
|
|
3185 |
|
3
|
3186 |
class ValueSet(set):
|
0
|
3187 |
"""
|
|
3188 |
A value set object to indicate a set of possible values for a feature.
|
|
3189 |
e.g. A boolean feature ValueSet([True, False])
|
|
3190 |
"""
|
|
3191 |
def __init__(self, initial_set=None):
|
|
3192 |
super(ValueSet, self).__init__(initial_set or [])
|
|
3193 |
|
|
3194 |
|
|
3195 |
class ValueRange(object):
|
|
3196 |
"""
|
|
3197 |
"""
|
|
3198 |
def __init__(self, fromvalue, tovalue, step=1):
|
|
3199 |
self.fromvalue = fromvalue
|
|
3200 |
self.tovalue = tovalue
|
|
3201 |
self.step = step
|
|
3202 |
|
|
3203 |
def __contains__(self, value):
|
|
3204 |
return self.fromvalue <= value and value <= self.tovalue and (value-self.fromvalue) % self.step == 0
|
|
3205 |
|
|
3206 |
|
|
3207 |
class ValueRe(object):
|
|
3208 |
"""
|
|
3209 |
"""
|
|
3210 |
def __init__(self, regexp):
|
|
3211 |
self.regexp = re.compile(regexp)
|
|
3212 |
|
|
3213 |
def __contains__(self, value):
|
|
3214 |
if isinstance(value, str):
|
|
3215 |
return self.regexp.match(value)
|
|
3216 |
else:
|
|
3217 |
return False
|
|
3218 |
|
|
3219 |
|
3
|
3220 |
class Property(Base):
|
|
3221 |
"""
|
|
3222 |
Confml property class
|
|
3223 |
"""
|
|
3224 |
def __init__(self, **kwargs):
|
|
3225 |
"""
|
|
3226 |
@param name=str: name string (mandatory)
|
|
3227 |
@param value=str: value for the property, string
|
|
3228 |
@param unit=str: unit of the property
|
|
3229 |
"""
|
|
3230 |
if kwargs.get('name',None) == None:
|
|
3231 |
raise ValueError("Property name cannot be None!")
|
|
3232 |
super(Property,self).__init__(Property.to_propertyref(kwargs.get('name',None)))
|
|
3233 |
self.name = kwargs.get('name',None)
|
|
3234 |
self.value = kwargs.get('value',None)
|
|
3235 |
self.unit = kwargs.get('unit',None)
|
|
3236 |
|
|
3237 |
@classmethod
|
|
3238 |
def to_propertyref(cls, name):
|
|
3239 |
"""
|
|
3240 |
@param name: name of the property
|
|
3241 |
@return: A property reference.
|
|
3242 |
"""
|
|
3243 |
if name is not None:
|
|
3244 |
return "property_%s" % name
|
|
3245 |
else:
|
|
3246 |
raise ValueError("Property name cannot be None!")
|
|
3247 |
|
|
3248 |
@classmethod
|
|
3249 |
def to_normref(cls, ref):
|
|
3250 |
"""
|
|
3251 |
@param ref: a property reference
|
|
3252 |
@return: normalized property reference
|
|
3253 |
"""
|
|
3254 |
return ref[9:]
|
|
3255 |
|
|
3256 |
def get_name(self):
|
|
3257 |
return self.name
|
|
3258 |
|
|
3259 |
def get_value(self):
|
|
3260 |
return self.value
|
|
3261 |
|
|
3262 |
def get_unit(self):
|
|
3263 |
return self.unit
|
|
3264 |
|
0
|
3265 |
class Option(Base):
|
|
3266 |
"""
|
|
3267 |
Confml option class.
|
|
3268 |
"""
|
|
3269 |
def __init__(self, name, value, **kwargs):
|
|
3270 |
super(Option, self).__init__(Option.to_optref(value, kwargs.get('map', None)))
|
|
3271 |
self.name = name
|
|
3272 |
self.value = value
|
|
3273 |
self.map = kwargs.get('map', None)
|
|
3274 |
self.relevant = kwargs.get('relevant', None)
|
3
|
3275 |
self.map_value = kwargs.get('map_value', None)
|
|
3276 |
self.display_name = kwargs.get('display_name', None)
|
0
|
3277 |
|
|
3278 |
@classmethod
|
|
3279 |
def to_optref(cls, value, map):
|
|
3280 |
"""
|
|
3281 |
@return: An option reference converted from value or map, depending
|
|
3282 |
on which one is not None.
|
|
3283 |
"""
|
|
3284 |
if value is not None:
|
|
3285 |
return "opt_value_%s" % value.replace('.', '').replace('/', '').replace(' ', '')
|
|
3286 |
elif map is not None:
|
|
3287 |
return "opt_map_%s" % map.replace('.', '').replace('/', '').replace(' ', '')
|
|
3288 |
else:
|
|
3289 |
raise ValueError("Both value and map are None!")
|
|
3290 |
|
|
3291 |
def get_name(self):
|
|
3292 |
return self.name
|
|
3293 |
|
|
3294 |
def get_value(self):
|
|
3295 |
return self.value
|
|
3296 |
|
|
3297 |
def __cmp__(self, other):
|
|
3298 |
try:
|
|
3299 |
ref = getattr(other, 'ref')
|
|
3300 |
except AttributeError:
|
|
3301 |
ref = other
|
|
3302 |
if self.ref < ref:
|
|
3303 |
return -1
|
|
3304 |
elif self.ref == ref:
|
|
3305 |
return 0
|
|
3306 |
else:
|
|
3307 |
return 1
|
|
3308 |
|
|
3309 |
|
|
3310 |
class Storage(object):
|
|
3311 |
"""
|
|
3312 |
A general base class for all storage type classes
|
|
3313 |
"""
|
|
3314 |
""" File open modes """
|
|
3315 |
MODE_UNKNOWN= -1
|
|
3316 |
MODE_READ = 1
|
|
3317 |
MODE_WRITE = 2
|
|
3318 |
MODE_APPEND = 3
|
|
3319 |
MODE_DELETE = 4
|
|
3320 |
|
3
|
3321 |
def __init__(self, path, mode=''):
|
0
|
3322 |
"""
|
|
3323 |
@param path: the reference to the root of the storage.
|
|
3324 |
"""
|
|
3325 |
self.rootpath = path
|
|
3326 |
self.curpath = ""
|
|
3327 |
self.container = True
|
|
3328 |
self.__opened_res__ = {}
|
3
|
3329 |
self.mode = mode
|
|
3330 |
self.cpath_stack = []
|
|
3331 |
|
0
|
3332 |
def __opened__(self, res):
|
|
3333 |
"""
|
|
3334 |
Internal function to add a newly opened Resource object to the list of open resources.
|
|
3335 |
@param res: The resource object
|
|
3336 |
"""
|
|
3337 |
if self.__opened_res__.has_key(res.path):
|
|
3338 |
self.__opened_res__[res.path].append(res)
|
|
3339 |
else:
|
|
3340 |
self.__opened_res__[res.path] = [res]
|
|
3341 |
|
|
3342 |
def __closed__(self, res):
|
|
3343 |
"""
|
|
3344 |
Internal function to remove a Resource object from the list of open resources.
|
|
3345 |
@param res: The resource object to remove
|
|
3346 |
@raise StorageException if the given resource object is not found:
|
|
3347 |
"""
|
|
3348 |
try:
|
|
3349 |
self.__opened_res__[res.path].remove(res)
|
|
3350 |
if len(self.__opened_res__[res.path]) == 0:
|
|
3351 |
del self.__opened_res__[res.path]
|
|
3352 |
except KeyError, e:
|
|
3353 |
raise exceptions.StorageException("No such %s open resource! %s" % (res, e))
|
|
3354 |
|
|
3355 |
def __has_open__(self, ref):
|
|
3356 |
"""
|
|
3357 |
Internal function to find out if any Resource objects are open from given ref.
|
|
3358 |
@param ref: The resource ref
|
|
3359 |
@return: True if resources found. Otherwise False.
|
|
3360 |
"""
|
|
3361 |
return self.__opened_res__.has_key(ref)
|
|
3362 |
|
|
3363 |
def __get_open__(self, path):
|
|
3364 |
"""
|
|
3365 |
Internal function to get all resource opened on a certain ref .
|
|
3366 |
@param ref: The resource ref
|
|
3367 |
@return: A list of open resources. Empty list if nothing is found
|
|
3368 |
"""
|
|
3369 |
if self.__has_open__(path):
|
|
3370 |
# return a copy of currently open resources
|
|
3371 |
return self.__opened_res__[path][:]
|
|
3372 |
else:
|
|
3373 |
return []
|
|
3374 |
|
|
3375 |
def __has_resource__(self, res):
|
|
3376 |
"""
|
|
3377 |
Internal function to find out if the given Resource objects is open in this storage.
|
|
3378 |
@param ref: The resource object
|
|
3379 |
@return: True if resources found. Otherwise False.
|
|
3380 |
"""
|
|
3381 |
try:
|
|
3382 |
res = self.__opened_res__[res.path].index(res)
|
|
3383 |
return True
|
|
3384 |
except KeyError, e:
|
|
3385 |
return False
|
|
3386 |
|
|
3387 |
@classmethod
|
|
3388 |
def open(cls,path, mode="r", **kwargs):
|
|
3389 |
"""
|
|
3390 |
Class method for opening an instance of Storage
|
|
3391 |
@param path: path to storage, which will determine what type of storage is initiated.
|
|
3392 |
"""
|
|
3393 |
# import all storage instances
|
|
3394 |
from cone.storage import storages
|
|
3395 |
for storagename in storages:
|
|
3396 |
storagemodule = 'cone.storage.'+storagename
|
|
3397 |
module = __import__(storagemodule)
|
|
3398 |
for storage_class in utils.all_subclasses(Storage):
|
|
3399 |
if storage_class.supported_storage(path):
|
|
3400 |
if hasattr(storage_class, '__open__'):
|
|
3401 |
return storage_class.__open__(path, mode, **kwargs)
|
|
3402 |
else:
|
|
3403 |
return storage_class(path, mode, **kwargs)
|
|
3404 |
|
|
3405 |
obj = Storage(path)
|
|
3406 |
return obj
|
|
3407 |
|
|
3408 |
@classmethod
|
|
3409 |
def supported_storage(cls, path):
|
|
3410 |
"""
|
|
3411 |
Class method for determing if the given clas supports a storage by given path.
|
|
3412 |
E.g. foo.zip, foo.cpd, foo/bar, http://foo.com/
|
|
3413 |
@param path:
|
|
3414 |
@return: Boolean value. True if the storage of the path is supported. False if not.
|
|
3415 |
"""
|
|
3416 |
return False
|
|
3417 |
|
|
3418 |
def set_path(self, path):
|
|
3419 |
"""
|
|
3420 |
"""
|
|
3421 |
self.rootpath = path
|
|
3422 |
|
|
3423 |
def get_path(self):
|
|
3424 |
"""
|
|
3425 |
"""
|
|
3426 |
return self.rootpath
|
|
3427 |
|
3
|
3428 |
def push(self, path):
|
|
3429 |
"""
|
|
3430 |
Set the current path under the Storage to the given path and push the possible existing path to a stack.
|
|
3431 |
The current path can be reverted with pop method.
|
|
3432 |
|
|
3433 |
@return: None
|
|
3434 |
@param path: The path which is set as current path.
|
|
3435 |
"""
|
|
3436 |
self.cpath_stack.append(self.curpath)
|
|
3437 |
self.curpath = path
|
|
3438 |
|
|
3439 |
def pop(self):
|
|
3440 |
"""
|
|
3441 |
Pop a path from path stack and set the current path to the popped element. The path can be pushed to the
|
|
3442 |
current path stack with push.
|
|
3443 |
|
|
3444 |
NOTE! if the pop is called when the current path stack is empty, the path will just remain is empty path
|
|
3445 |
keeping the active path in the storages root path.
|
|
3446 |
|
|
3447 |
@return: The new path.
|
|
3448 |
"""
|
|
3449 |
try:
|
|
3450 |
path = self.cpath_stack.pop()
|
|
3451 |
self.curpath = path
|
|
3452 |
except IndexError:
|
|
3453 |
pass
|
|
3454 |
return self.curpath
|
|
3455 |
|
0
|
3456 |
def set_current_path(self, path):
|
|
3457 |
"""
|
|
3458 |
@param path: the current path under the Storage.
|
|
3459 |
"""
|
|
3460 |
self.curpath = utils.resourceref.remove_end_slash(utils.resourceref.remove_begin_slash(path))
|
|
3461 |
|
|
3462 |
def get_current_path(self):
|
|
3463 |
"""
|
|
3464 |
get the current path under the Storage.
|
|
3465 |
"""
|
|
3466 |
return self.curpath
|
|
3467 |
|
|
3468 |
def close(self):
|
|
3469 |
"""
|
|
3470 |
Close the repository, which will save and close all open resources.
|
|
3471 |
"""
|
|
3472 |
for openref in self.__opened_res__.keys():
|
|
3473 |
for res in self.__get_open__(openref):
|
|
3474 |
self.close_resource(res)
|
|
3475 |
|
|
3476 |
def save(self):
|
|
3477 |
"""
|
|
3478 |
Flush changes from all resources to the repository.
|
|
3479 |
"""
|
|
3480 |
for openref in self.__opened_res__.keys():
|
|
3481 |
for res in self.__get_open__(openref):
|
|
3482 |
self.save_resource(res)
|
|
3483 |
|
|
3484 |
def open_resource(self, path, mode="r"):
|
|
3485 |
"""
|
|
3486 |
Open the given resource and return a File object.
|
|
3487 |
@param path : reference to the resource
|
|
3488 |
@param mode : the mode in which to open. Can be one of r = read, w = write, a = append.
|
|
3489 |
raises a NotResource exception if the ref item is not a resource.
|
|
3490 |
"""
|
|
3491 |
raise exceptions.NotSupportedException()
|
|
3492 |
|
|
3493 |
def delete_resource(self, path):
|
|
3494 |
"""
|
|
3495 |
Delete the given resource from storage
|
|
3496 |
@param path: reference to the resource
|
|
3497 |
raises a NotSupportedException exception if delete operation is not supported by the storage
|
|
3498 |
"""
|
|
3499 |
raise exceptions.NotSupportedException()
|
|
3500 |
|
|
3501 |
def close_resource(self, path):
|
|
3502 |
"""
|
|
3503 |
Close a given resource instance. Normally this is called by the Resource object
|
|
3504 |
in its own close.
|
|
3505 |
@param path the reference to the resource to close.
|
|
3506 |
"""
|
|
3507 |
raise exceptions.NotSupportedException()
|
|
3508 |
|
|
3509 |
def is_resource(self, path):
|
|
3510 |
"""
|
|
3511 |
Return true if the ref is a resource
|
|
3512 |
@param ref : reference to path where resources are searched
|
|
3513 |
"""
|
|
3514 |
raise exceptions.NotSupportedException()
|
|
3515 |
|
3
|
3516 |
def list_resources(self, path, **kwargs):
|
0
|
3517 |
"""
|
|
3518 |
find the resources under certain ref/path
|
|
3519 |
@param ref : reference to path where resources are searched
|
|
3520 |
@param recurse : defines whether to return resources directly under the path or does the listing recurse to subfolders.
|
|
3521 |
Default value is False. Set to True to enable recursion.
|
|
3522 |
"""
|
|
3523 |
return []
|
|
3524 |
|
|
3525 |
def import_resources(self, paths, storage):
|
|
3526 |
"""
|
|
3527 |
import resources from a list of resources to this storage
|
|
3528 |
@param paths : a list of Resourse objects.
|
|
3529 |
@param storage : the external storage from which files are imported.
|
|
3530 |
"""
|
|
3531 |
raise exceptions.NotSupportedException()
|
|
3532 |
|
|
3533 |
def export_resources(self, paths, storage):
|
|
3534 |
"""
|
|
3535 |
export resources from this storage based on a list of reference to this storage
|
|
3536 |
@param path : a list of resource paths in this storage (references).
|
|
3537 |
@param storage : the external storage where to export.
|
|
3538 |
"""
|
|
3539 |
raise exceptions.NotSupportedException()
|
|
3540 |
|
|
3541 |
def save_resource(self, path):
|
|
3542 |
"""
|
|
3543 |
Flush the changes of a given resource instance. Normally this is called by the Resource object
|
|
3544 |
in its own save.
|
|
3545 |
@param ref the reference to the resource to close.
|
|
3546 |
"""
|
|
3547 |
raise exceptions.NotSupportedException()
|
|
3548 |
|
|
3549 |
def create_folder(self, path):
|
|
3550 |
"""
|
|
3551 |
Create a folder entry to a path
|
|
3552 |
@param path : path to the folder
|
|
3553 |
"""
|
|
3554 |
raise exceptions.NotSupportedException()
|
|
3555 |
|
|
3556 |
def delete_folder(self, path):
|
|
3557 |
"""
|
|
3558 |
Delete a folder entry from a path. The path must be empty.
|
|
3559 |
@param path : path to the folder
|
|
3560 |
"""
|
|
3561 |
raise exceptions.NotSupportedException()
|
|
3562 |
|
|
3563 |
def is_folder(self, path):
|
|
3564 |
"""
|
|
3565 |
Check if the given path is an existing folder in the storage
|
|
3566 |
@param path : path to the folder
|
|
3567 |
"""
|
|
3568 |
raise exceptions.NotSupportedException()
|
|
3569 |
|
|
3570 |
def get_mode(self, mode_str):
|
|
3571 |
if mode_str.find("w") != -1:
|
|
3572 |
return self.MODE_WRITE
|
|
3573 |
elif mode_str.find("r") != -1:
|
|
3574 |
return self.MODE_READ
|
|
3575 |
elif mode_str.find("a") != -1:
|
|
3576 |
return self.MODE_APPEND
|
|
3577 |
elif mode_str.find("d") != -1:
|
|
3578 |
return self.MODE_DELETE
|
|
3579 |
else:
|
|
3580 |
return self.MODE_UNKNOWN
|
|
3581 |
|
|
3582 |
def unload(self, path, object):
|
|
3583 |
"""
|
|
3584 |
Dump a given object to the storage
|
|
3585 |
@param object: The object to dump to the storage, which is expected to be an instance
|
|
3586 |
of Base class.
|
|
3587 |
@param path: The reference where to store the object
|
|
3588 |
@param object: The object instance to dump
|
|
3589 |
@raise StorageException: if the given object cannot be dumped to this storage
|
|
3590 |
"""
|
|
3591 |
raise exceptions.NotSupportedException()
|
|
3592 |
|
|
3593 |
def load(self, path):
|
|
3594 |
"""
|
|
3595 |
Load an object from a reference.
|
|
3596 |
@param path: The reference where to load the object
|
|
3597 |
@raise StorageException: if the given object cannot be loaded as an object from this storage
|
|
3598 |
"""
|
|
3599 |
raise exceptions.NotSupportedException()
|
|
3600 |
|
|
3601 |
path = property(get_path, set_path)
|
|
3602 |
|
|
3603 |
class Resource(object):
|
|
3604 |
STATE_OPEN = 0
|
|
3605 |
STATE_CLOSE = 1
|
|
3606 |
def __init__(self, storage, path, mode=Storage.MODE_READ):
|
|
3607 |
self.storage = storage
|
|
3608 |
self.path = path
|
|
3609 |
self.mode = mode
|
|
3610 |
self.state = Resource.STATE_OPEN
|
|
3611 |
self.content_info = None
|
|
3612 |
|
|
3613 |
def get_path(self):
|
|
3614 |
return self.path
|
|
3615 |
|
|
3616 |
def close(self):
|
|
3617 |
"""
|
|
3618 |
Close the resource.
|
|
3619 |
Note1: the resource object cannot be accessed anymore after it has been closed.
|
|
3620 |
Note2: the changes are not automatically saved. The save operation must be explicitly called,
|
|
3621 |
to save data.
|
|
3622 |
"""
|
|
3623 |
self.storage.close_resource(self.path)
|
|
3624 |
self.state = Resource.STATE_OPEN
|
|
3625 |
|
|
3626 |
def read(self, bytes=0):
|
|
3627 |
"""
|
|
3628 |
Read data.
|
|
3629 |
"""
|
|
3630 |
raise exceptions.NotSupportedException()
|
|
3631 |
|
|
3632 |
def write(self, string):
|
|
3633 |
"""
|
|
3634 |
Write data.
|
|
3635 |
"""
|
|
3636 |
raise exceptions.NotSupportedException()
|
|
3637 |
|
|
3638 |
def truncate(self, size=0):
|
|
3639 |
"""
|
|
3640 |
Trunkate this resource data to the given size.
|
|
3641 |
@param size: The size to trunkate. Default value is zero, which make the resource empty.
|
|
3642 |
"""
|
3
|
3643 |
raise exceptions.NotSupportedException()
|
0
|
3644 |
|
|
3645 |
def save(self, size=0):
|
|
3646 |
"""
|
|
3647 |
Save all changes to data to storage.
|
|
3648 |
"""
|
3
|
3649 |
raise exceptions.NotSupportedException()
|
0
|
3650 |
|
|
3651 |
def get_mode(self):
|
|
3652 |
return self.storage.get_mode(self.mode)
|
|
3653 |
|
|
3654 |
def get_size(self):
|
|
3655 |
"""
|
|
3656 |
Return the size of this resource in bytes.
|
|
3657 |
|
|
3658 |
Note that this does not work in write mode.
|
|
3659 |
@return: The resource size in bytes:
|
|
3660 |
@raise exceptions.StorageException: The resource was opened in write mode.
|
|
3661 |
"""
|
|
3662 |
raise exceptions.NotSupportedException()
|
|
3663 |
|
|
3664 |
def get_content_info(self):
|
|
3665 |
"""
|
|
3666 |
Return the ContentInfo class that contains content information about
|
|
3667 |
resource.
|
|
3668 |
"""
|
|
3669 |
raise exceptions.NotSupportedException()
|
|
3670 |
|
|
3671 |
class ContentInfo(object):
|
|
3672 |
"""
|
|
3673 |
A ContentInfo object is used to describe content of Resource.
|
|
3674 |
"""
|
|
3675 |
logger = logging.getLogger('cone.contentinfo')
|
|
3676 |
|
|
3677 |
|
|
3678 |
def __init__(self, mimetype, mimesubtype):
|
|
3679 |
#: MIME Media type (http://www.iana.org/assignments/media-types/)
|
|
3680 |
#: as a string. E.g. 'image' or 'application'
|
|
3681 |
self.mimetype = mimetype
|
|
3682 |
#: MIME Media subtype as a string. E.g. 'svg+xml' or 'bmp'.
|
|
3683 |
self.mimesubtype = mimesubtype
|
|
3684 |
|
|
3685 |
@property
|
|
3686 |
def content_type(self):
|
|
3687 |
"""
|
|
3688 |
Returns MIME Media type (http://www.iana.org/assignments/media-types/)
|
|
3689 |
and subtype as a string. E.g. 'image/bmp'.
|
|
3690 |
"""
|
|
3691 |
return self.mimetype + '/' + self.mimesubtype
|
|
3692 |
|
|
3693 |
class ImageContentInfo(ContentInfo):
|
|
3694 |
|
|
3695 |
"""
|
|
3696 |
A ImageContentInfo object is used to describe content of image Resources.
|
|
3697 |
"""
|
|
3698 |
def __init__(self):
|
|
3699 |
ContentInfo.__init__(self, 'image', '')
|
|
3700 |
|
|
3701 |
class BmpImageContentInfo(ImageContentInfo):
|
|
3702 |
"""
|
|
3703 |
A BmpImageContentInfo object is used to describe content of bmp image
|
|
3704 |
Resources.
|
|
3705 |
"""
|
|
3706 |
|
|
3707 |
_BMP_BITS_PER_PIXEL_OFFSET_ = int('0x1C', 16)
|
|
3708 |
|
|
3709 |
def __init__(self, resource, data):
|
|
3710 |
ContentInfo.__init__(self, 'image', 'bmp')
|
|
3711 |
|
|
3712 |
#: Color depth as bits per pixel.
|
|
3713 |
self.color_depth = None
|
|
3714 |
if (resource != None):
|
|
3715 |
try:
|
|
3716 |
self.color_depth = ord(data[self._BMP_BITS_PER_PIXEL_OFFSET_])
|
|
3717 |
except Exception, e:
|
|
3718 |
self.logger.warning("Invalid BMP-file: %s" % resource.get_path())
|
|
3719 |
|
3
|
3720 |
|
|
3721 |
class currentdir(object):
|
|
3722 |
def __init__(self, storage, curdir):
|
|
3723 |
self.storage = storage
|
|
3724 |
# make sure that the curdir does not contain path prefix
|
|
3725 |
self.curdir = curdir.lstrip('/')
|
|
3726 |
|
|
3727 |
def __enter__(self):
|
|
3728 |
self.storage.push(self.curdir)
|
|
3729 |
|
|
3730 |
def __exit__(self, type, value, tb):
|
|
3731 |
self.storage.pop()
|
|
3732 |
|
|
3733 |
|
0
|
3734 |
class Folder(object):
|
|
3735 |
"""
|
|
3736 |
A Folder object is a subfolder of a Storage, offering access to part of the Storages resources.
|
|
3737 |
"""
|
3
|
3738 |
def __init__(self, storage, path, **kwargs):
|
0
|
3739 |
"""
|
|
3740 |
Create a layer folder to the storage if it does not exist.
|
|
3741 |
"""
|
3
|
3742 |
self.curpath = path
|
|
3743 |
self.storage = storage
|
|
3744 |
|
|
3745 |
def set_path(self, path):
|
|
3746 |
"""
|
|
3747 |
"""
|
|
3748 |
self.curpath = path
|
|
3749 |
|
|
3750 |
def get_path(self):
|
|
3751 |
"""
|
|
3752 |
"""
|
|
3753 |
return self.curpath
|
|
3754 |
|
|
3755 |
def set_current_path(self, path):
|
|
3756 |
"""
|
|
3757 |
@param path: the current path under the Storage.
|
|
3758 |
"""
|
|
3759 |
self.curpath = utils.resourceref.remove_end_slash(utils.resourceref.remove_begin_slash(path))
|
|
3760 |
|
|
3761 |
def get_current_path(self):
|
|
3762 |
"""
|
|
3763 |
get the current path under the Storage.
|
|
3764 |
"""
|
|
3765 |
return self.curpath
|
|
3766 |
|
|
3767 |
def close(self):
|
|
3768 |
"""
|
|
3769 |
Close the repository, which will save and close all open resources.
|
|
3770 |
"""
|
|
3771 |
self.storage.close()
|
|
3772 |
|
|
3773 |
def save(self):
|
|
3774 |
"""
|
|
3775 |
Flush changes from all resources to the repository.
|
|
3776 |
"""
|
|
3777 |
return self.storage.save()
|
|
3778 |
|
|
3779 |
def open_resource(self, path, mode="r"):
|
|
3780 |
"""
|
|
3781 |
Open the given resource and return a File object.
|
|
3782 |
@param path : reference to the resource
|
|
3783 |
@param mode : the mode in which to open. Can be one of r = read, w = write, a = append.
|
|
3784 |
raises a NotResource exception if the ref item is not a resource.
|
|
3785 |
"""
|
|
3786 |
with currentdir(self.storage, self.curpath):
|
|
3787 |
res = self.storage.open_resource(path, mode)
|
|
3788 |
return res
|
|
3789 |
|
|
3790 |
def delete_resource(self, path):
|
|
3791 |
"""
|
|
3792 |
Delete the given resource from storage
|
|
3793 |
@param path: reference to the resource
|
|
3794 |
raises a NotSupportedException exception if delete operation is not supported by the storage
|
|
3795 |
"""
|
|
3796 |
with currentdir(self.storage, self.curpath):
|
|
3797 |
res = self.storage.delete_resource(path)
|
|
3798 |
return res
|
|
3799 |
|
|
3800 |
def close_resource(self, path):
|
|
3801 |
"""
|
|
3802 |
Close a given resource instance. Normally this is called by the Resource object
|
|
3803 |
in its own close.
|
|
3804 |
@param path the reference to the resource to close.
|
|
3805 |
"""
|
|
3806 |
with currentdir(self.storage, self.curpath):
|
|
3807 |
res = self.storage.close_resource(path)
|
|
3808 |
return res
|
|
3809 |
|
|
3810 |
def is_resource(self, path):
|
|
3811 |
"""
|
|
3812 |
Return true if the ref is a resource
|
|
3813 |
@param ref : reference to path where resources are searched
|
|
3814 |
"""
|
|
3815 |
with currentdir(self.storage, self.curpath):
|
|
3816 |
res = self.storage.is_resource(path)
|
|
3817 |
return res
|
|
3818 |
|
|
3819 |
def list_resources(self, path, **kwargs):
|
|
3820 |
"""
|
|
3821 |
find the resources under certain ref/path
|
|
3822 |
@param ref : reference to path where resources are searched
|
|
3823 |
@param recurse : defines whether to return resources directly under the path or does the listing recurse to subfolders.
|
|
3824 |
Default value is False. Set to True to enable recursion.
|
|
3825 |
"""
|
|
3826 |
with currentdir(self.storage, self.curpath):
|
|
3827 |
res = self.storage.list_resources(path, **kwargs)
|
|
3828 |
return res
|
|
3829 |
|
|
3830 |
def import_resources(self, paths, storage):
|
|
3831 |
"""
|
|
3832 |
import resources from a list of resources to this storage
|
|
3833 |
@param paths : a list of Resourse objects.
|
|
3834 |
@param storage : the external storage from which files are imported.
|
|
3835 |
"""
|
|
3836 |
with currentdir(self.storage, self.curpath):
|
|
3837 |
res = self.storage.import_resources(paths, storage)
|
|
3838 |
return res
|
|
3839 |
|
|
3840 |
def export_resources(self, paths, storage):
|
|
3841 |
"""
|
|
3842 |
export resources from this storage based on a list of reference to this storage
|
|
3843 |
@param path : a list of resource paths in this storage (references).
|
|
3844 |
@param storage : the external storage where to export.
|
|
3845 |
"""
|
|
3846 |
with currentdir(self.storage, self.curpath):
|
|
3847 |
res = self.storage.export_resources(paths, storage)
|
|
3848 |
return res
|
|
3849 |
|
|
3850 |
def save_resource(self, path):
|
|
3851 |
"""
|
|
3852 |
Flush the changes of a given resource instance. Normally this is called by the Resource object
|
|
3853 |
in its own save.
|
|
3854 |
@param ref the reference to the resource to close.
|
|
3855 |
"""
|
|
3856 |
with currentdir(self.storage, self.curpath):
|
|
3857 |
res = self.storage.save_resource(path)
|
|
3858 |
return res
|
|
3859 |
|
|
3860 |
def create_folder(self, path):
|
|
3861 |
"""
|
|
3862 |
Create a folder entry to a path
|
|
3863 |
@param path : path to the folder
|
|
3864 |
"""
|
|
3865 |
with currentdir(self.storage, self.curpath):
|
|
3866 |
res = self.storage.create_folder(path)
|
|
3867 |
return res
|
|
3868 |
|
|
3869 |
def delete_folder(self, path):
|
|
3870 |
"""
|
|
3871 |
Delete a folder entry from a path. The path must be empty.
|
|
3872 |
@param path : path to the folder
|
|
3873 |
"""
|
|
3874 |
with currentdir(self.storage, self.curpath):
|
|
3875 |
res = self.storage.delete_folder(path)
|
|
3876 |
return res
|
|
3877 |
|
|
3878 |
def is_folder(self, path):
|
|
3879 |
"""
|
|
3880 |
Check if the given path is an existing folder in the storage
|
|
3881 |
@param path : path to the folder
|
|
3882 |
"""
|
|
3883 |
with currentdir(self.storage, self.curpath):
|
|
3884 |
res = self.storage.is_folder(path)
|
|
3885 |
return res
|
|
3886 |
|
|
3887 |
def get_mode(self, mode_str):
|
|
3888 |
return self.storage.get_mode()
|
|
3889 |
|
|
3890 |
def unload(self, path, object):
|
|
3891 |
"""
|
|
3892 |
Dump a given object to the storage
|
|
3893 |
@param object: The object to dump to the storage, which is expected to be an instance
|
|
3894 |
of Base class.
|
|
3895 |
@param path: The reference where to store the object
|
|
3896 |
@param object: The object instance to dump
|
|
3897 |
@raise StorageException: if the given object cannot be dumped to this storage
|
|
3898 |
"""
|
|
3899 |
with currentdir(self.storage, self.curpath):
|
|
3900 |
res = self.storage.unload(path, object)
|
|
3901 |
return res
|
|
3902 |
|
|
3903 |
def load(self, path):
|
|
3904 |
"""
|
|
3905 |
Load an object from a reference.
|
|
3906 |
@param path: The reference where to load the object
|
|
3907 |
@raise StorageException: if the given object cannot be loaded as an object from this storage
|
|
3908 |
"""
|
|
3909 |
with currentdir(self.storage, self.curpath):
|
|
3910 |
res = self.storage.load(path)
|
|
3911 |
return res
|
|
3912 |
|
|
3913 |
path = property(get_path, set_path)
|
|
3914 |
|
|
3915 |
|
|
3916 |
class CompositeLayer(Folder):
|
0
|
3917 |
"""
|
|
3918 |
A base class for composite Configuration objects.
|
|
3919 |
"""
|
3
|
3920 |
def __init__(self, storage, path="", **kwargs):
|
|
3921 |
super(CompositeLayer, self).__init__(storage, path, **kwargs)
|
0
|
3922 |
self.layers = kwargs.get('layers', [])
|
|
3923 |
self.path = path
|
|
3924 |
|
|
3925 |
def add_layer(self, layer):
|
|
3926 |
self.layers.append(layer)
|
|
3927 |
|
|
3928 |
def remove_layer(self, path):
|
|
3929 |
if self.get_layer(path):
|
|
3930 |
self.layers.remove(self.get_layer(path))
|
|
3931 |
else:
|
|
3932 |
raise exceptions.NotFound('Layer with given path %s not found!' % path)
|
|
3933 |
|
|
3934 |
def get_layer(self, path):
|
|
3935 |
for layer in self.layers:
|
|
3936 |
if layer.get_current_path() == path:
|
|
3937 |
return layer
|
|
3938 |
return None
|
|
3939 |
|
|
3940 |
def list_layers(self):
|
|
3941 |
return [layer.get_current_path() for layer in self.layers]
|
|
3942 |
|
|
3943 |
def list_confml(self):
|
|
3944 |
"""
|
|
3945 |
@return: array of confml file references.
|
|
3946 |
"""
|
|
3947 |
lres = []
|
|
3948 |
for layerpath in self.list_layers():
|
|
3949 |
for respath in self.get_layer(layerpath).list_confml():
|
|
3950 |
lres.append(utils.resourceref.join_refs([layerpath, respath]))
|
|
3951 |
return lres
|
|
3952 |
|
|
3953 |
def list_implml(self):
|
|
3954 |
"""
|
|
3955 |
@return: array of implml file references.
|
|
3956 |
"""
|
|
3957 |
lres = []
|
|
3958 |
for layerpath in self.list_layers():
|
|
3959 |
for respath in self.get_layer(layerpath).list_implml():
|
|
3960 |
lres.append(utils.resourceref.join_refs([layerpath, respath]))
|
|
3961 |
return lres
|
|
3962 |
|
|
3963 |
def list_content(self):
|
|
3964 |
"""
|
|
3965 |
@return: array of content file references.
|
|
3966 |
"""
|
|
3967 |
lres = []
|
|
3968 |
for layerpath in self.list_layers():
|
|
3969 |
for respath in self.get_layer(layerpath).list_content():
|
|
3970 |
lres.append(utils.resourceref.join_refs([layerpath, respath]))
|
|
3971 |
return lres
|
|
3972 |
|
|
3973 |
def list_doc(self):
|
|
3974 |
"""
|
|
3975 |
@return: array of document file references.
|
|
3976 |
"""
|
|
3977 |
lres = []
|
|
3978 |
for layerpath in self.list_layers():
|
|
3979 |
for respath in self.get_layer(layerpath).list_doc():
|
|
3980 |
lres.append(utils.resourceref.join_refs([layerpath, respath]))
|
|
3981 |
return lres
|
|
3982 |
|
3
|
3983 |
def list_all_resources(self, **kwargs):
|
0
|
3984 |
"""
|
|
3985 |
Returns a list of all layer related resource paths with full path in the storage.
|
|
3986 |
"""
|
|
3987 |
lres = []
|
|
3988 |
for layerpath in self.list_layers():
|
|
3989 |
sublayer = self.get_layer(layerpath)
|
3
|
3990 |
for respath in sublayer.list_all_resources(**kwargs):
|
0
|
3991 |
lres.append(utils.resourceref.join_refs([layerpath, respath]))
|
|
3992 |
return lres
|
3
|
3993 |
|
|
3994 |
def list_all_related(self, **kwargs):
|
|
3995 |
"""
|
|
3996 |
Returns a list of all (non confml) layer related resource paths with full path in the storage.
|
|
3997 |
"""
|
|
3998 |
lres = []
|
|
3999 |
for layerpath in self.list_layers():
|
|
4000 |
sublayer = self.get_layer(layerpath)
|
|
4001 |
for respath in sublayer.list_all_related(**kwargs):
|
|
4002 |
lres.append(utils.resourceref.join_refs([layerpath, respath]))
|
|
4003 |
|
|
4004 |
return lres
|
|
4005 |
|
0
|
4006 |
class Layer(CompositeLayer):
|
|
4007 |
"""
|
|
4008 |
A Layer object is a subfolder of a Storage, offering access to part of the Storages resources.
|
|
4009 |
"""
|
|
4010 |
def __init__(self, storage, path, **kwargs):
|
|
4011 |
"""
|
|
4012 |
Create a layer folder to the storage if it does not exist.
|
|
4013 |
@param storage: a reference to the Storage object
|
|
4014 |
@param path: path for the layer
|
|
4015 |
@param confml_path: optional parameter for confml files path (give in confml_path="something")
|
|
4016 |
@param imlpml_path: optional parameter for implml files path (give in implml_path="something")
|
|
4017 |
@param content_path: optional parameter for content files path (give in content_path="something")
|
|
4018 |
@param doc_path: optional parameter for doc files path (give in doc_path="something")
|
|
4019 |
"""
|
3
|
4020 |
super(Layer, self).__init__(storage, path, **kwargs)
|
0
|
4021 |
#if not storage.is_folder(path):
|
|
4022 |
# storage.create_folder(path)
|
|
4023 |
self.predefined = {'confml_path' : 'confml',
|
|
4024 |
'implml_path' : 'implml',
|
|
4025 |
'content_path' : 'content',
|
|
4026 |
'doc_path' : 'doc'}
|
|
4027 |
# list through all "hardcoded" paths and check whether the
|
|
4028 |
# hardcoded or given path exists under this Layer.
|
|
4029 |
# if it does then create a folder instance to that path
|
|
4030 |
for (pretag, prevalue) in self.predefined.items():
|
|
4031 |
self.predefined[pretag] = kwargs.get(pretag, prevalue)
|
|
4032 |
|
|
4033 |
def __getattr__(self, name):
|
|
4034 |
return getattr(self.storage, name)
|
|
4035 |
|
3
|
4036 |
def __getstate__(self):
|
|
4037 |
state = {}
|
|
4038 |
state['predefined'] = self.predefined
|
|
4039 |
state['path'] = self.path
|
|
4040 |
state['layers'] = self.layers
|
|
4041 |
return state
|
|
4042 |
|
|
4043 |
def __setstate__(self, state):
|
|
4044 |
state = {}
|
|
4045 |
self.predefined = state.get('predefined',{})
|
|
4046 |
self.path = state.get('path','')
|
|
4047 |
self.layers = state.get('layers',[])
|
|
4048 |
|
|
4049 |
return state
|
|
4050 |
|
0
|
4051 |
def list_confml(self):
|
|
4052 |
"""
|
|
4053 |
@return: array of confml file references.
|
|
4054 |
"""
|
3
|
4055 |
res = self.list_resources(self.predefined['confml_path'], recurse=True)
|
0
|
4056 |
res += super(Layer, self).list_confml()
|
|
4057 |
return res
|
|
4058 |
|
|
4059 |
def list_implml(self):
|
|
4060 |
"""
|
|
4061 |
@return: array of implml file references.
|
|
4062 |
"""
|
3
|
4063 |
res = self.list_resources(self.predefined['implml_path'], recurse=True)
|
0
|
4064 |
res += super(Layer, self).list_implml()
|
|
4065 |
return res
|
|
4066 |
|
|
4067 |
def list_content(self):
|
|
4068 |
"""
|
|
4069 |
@return: array of content file references.
|
|
4070 |
"""
|
3
|
4071 |
res = self.list_resources(self.predefined['content_path'], recurse=True)
|
0
|
4072 |
res += super(Layer, self).list_content()
|
|
4073 |
return res
|
|
4074 |
|
|
4075 |
def list_doc(self):
|
|
4076 |
"""
|
|
4077 |
@return: array of document file references.
|
|
4078 |
"""
|
3
|
4079 |
res = self.list_resources(self.predefined['doc_path'], recurse=True)
|
0
|
4080 |
res += super(Layer, self).list_doc()
|
|
4081 |
return res
|
|
4082 |
|
|
4083 |
def confml_folder(self):
|
3
|
4084 |
cpath = self.get_current_path()
|
0
|
4085 |
spath = self.predefined['confml_path']
|
|
4086 |
return Folder(self.storage, utils.resourceref.join_refs([cpath, spath]))
|
|
4087 |
|
|
4088 |
def implml_folder(self):
|
3
|
4089 |
cpath = self.get_current_path()
|
0
|
4090 |
spath = self.predefined['implml_path']
|
|
4091 |
return Folder(self.storage, utils.resourceref.join_refs([cpath, spath]))
|
|
4092 |
|
|
4093 |
def content_folder(self):
|
3
|
4094 |
cpath = self.get_current_path()
|
0
|
4095 |
spath = self.predefined['content_path']
|
|
4096 |
return Folder(self.storage, utils.resourceref.join_refs([cpath, spath]))
|
|
4097 |
|
|
4098 |
def doc_folder(self):
|
3
|
4099 |
cpath = self.get_current_path()
|
0
|
4100 |
spath = self.predefined['doc_path']
|
|
4101 |
return Folder(self.storage, utils.resourceref.join_refs([cpath, spath]))
|
|
4102 |
|
3
|
4103 |
def list_all_resources(self, **kwargs):
|
0
|
4104 |
"""
|
|
4105 |
Returns a list of all layer related resource paths with full path in the storage.
|
|
4106 |
"""
|
|
4107 |
lres = []
|
|
4108 |
for folderpath in sorted(self.predefined.values()):
|
3
|
4109 |
lres += self.list_resources(folderpath, recurse=True)
|
0
|
4110 |
|
3
|
4111 |
lres += super(Layer, self).list_all_resources()
|
0
|
4112 |
return lres
|
|
4113 |
|
3
|
4114 |
def list_all_related(self, **kwargs):
|
0
|
4115 |
"""
|
|
4116 |
Returns a list of all (non confml) layer related resource paths with full path in the storage.
|
|
4117 |
"""
|
3
|
4118 |
|
0
|
4119 |
lres = []
|
3
|
4120 |
exclude_filters = kwargs.get('exclude_filters', {})
|
|
4121 |
kwargs['recurse'] = True
|
0
|
4122 |
predef = self.predefined.copy()
|
|
4123 |
del predef['confml_path']
|
|
4124 |
for folderpath in sorted(predef.values()):
|
3
|
4125 |
filter = exclude_filters.get(folderpath, None)
|
|
4126 |
resources = self.list_resources(folderpath, **kwargs)
|
|
4127 |
if filter:
|
|
4128 |
lres += [res for res in resources if not re.search(filter, res, re.IGNORECASE)]
|
|
4129 |
else:
|
|
4130 |
lres += resources
|
|
4131 |
lres += super(Layer, self).list_all_related(**kwargs)
|
0
|
4132 |
|
|
4133 |
return lres
|
|
4134 |
|
|
4135 |
|
3
|
4136 |
class Include(Base, container.LoadLink):
|
|
4137 |
"""
|
|
4138 |
A common include element that automatically loads a resource
|
|
4139 |
and its object under this include element.
|
|
4140 |
"""
|
|
4141 |
def __init__(self, ref="", **kwargs):
|
|
4142 |
path = kwargs.get('path') or ref
|
|
4143 |
store_interface = kwargs.get('store_interface',None)
|
|
4144 |
ref = utils.resourceref.to_objref(path)
|
|
4145 |
container.LoadLink.__init__(self, path, store_interface)
|
|
4146 |
Base.__init__(self, ref)
|
|
4147 |
|
|
4148 |
def get_store_interface(self):
|
|
4149 |
if not self._storeint and self._parent:
|
|
4150 |
try:
|
|
4151 |
self._storeint = self._parent.get_store_interface()
|
|
4152 |
except exceptions.NotFound:
|
|
4153 |
# If project is not found, let the store interface be None
|
|
4154 |
pass
|
|
4155 |
return self._storeint
|
|
4156 |
|
|
4157 |
|
0
|
4158 |
class Rule(object):
|
|
4159 |
"""
|
|
4160 |
Base class for Rules in the system.
|
|
4161 |
"""
|
|
4162 |
def __init__(self):
|
|
4163 |
raise exceptions.NotSupportedException()
|
|
4164 |
|
|
4165 |
|
|
4166 |
class FactoryBase(object):
|
|
4167 |
pass
|
|
4168 |
|
|
4169 |
class Factory(object):
|
|
4170 |
def __getattr__(self, name):
|
|
4171 |
"""
|
|
4172 |
The Factory getattr find all subclasses for the Factory and searches for given attr
|
|
4173 |
in those.
|
|
4174 |
"""
|
|
4175 |
for sub_factory in utils.all_subclasses(FactoryBase):
|
|
4176 |
try:
|
|
4177 |
return getattr(sub_factory(), name)
|
|
4178 |
except AttributeError:
|
|
4179 |
continue
|
|
4180 |
raise AttributeError("type object %s has no attribute '%s'" % (self.__class__, name))
|
|
4181 |
|
|
4182 |
def get_mapper(modelname):
|
|
4183 |
"""
|
|
4184 |
Return a instance of appropriate mapper for given model.
|
|
4185 |
"""
|
|
4186 |
mapmodule = __import__('cone.public.mapping')
|
|
4187 |
return mapmodule.public.mapping.BaseMapper()
|
|
4188 |
|
|
4189 |
|
3
|
4190 |
class Problem(object):
|
|
4191 |
SEVERITY_ERROR = "error"
|
|
4192 |
SEVERITY_WARNING = "warning"
|
|
4193 |
SEVERITY_INFO = "info"
|
|
4194 |
|
|
4195 |
def __init__(self, msg, **kwargs):
|
|
4196 |
self.msg = msg
|
|
4197 |
self.type = kwargs.get('type', '')
|
|
4198 |
self.line = kwargs.get('line', None)
|
|
4199 |
self.file = kwargs.get('file', None)
|
|
4200 |
self.severity = kwargs.get('severity', self.SEVERITY_ERROR)
|
|
4201 |
self.traceback = kwargs.get('traceback', None)
|
|
4202 |
# A slot for any problem specific data
|
|
4203 |
self.problem_data = kwargs.get('problem_data', None)
|
|
4204 |
|
|
4205 |
def log(self, logger, current_file=None):
|
|
4206 |
"""
|
|
4207 |
Log this problem with the given logger.
|
|
4208 |
"""
|
|
4209 |
file = self.file or current_file
|
|
4210 |
if self.line is None:
|
|
4211 |
msg = "(%s) %s" % (file, self.msg)
|
|
4212 |
else:
|
|
4213 |
msg = "(%s:%d) %s" % (file, self.line, self.msg)
|
|
4214 |
|
|
4215 |
mapping = {self.SEVERITY_ERROR: logging.ERROR,
|
|
4216 |
self.SEVERITY_WARNING: logging.WARNING,
|
|
4217 |
self.SEVERITY_INFO: logging.INFO}
|
|
4218 |
level = mapping.get(self.severity, logging.ERROR)
|
|
4219 |
logger.log(level, msg)
|
|
4220 |
|
|
4221 |
if self.traceback:
|
|
4222 |
logger.debug(self.traceback)
|
|
4223 |
|
|
4224 |
@classmethod
|
|
4225 |
def from_exception(cls, ex):
|
|
4226 |
"""
|
|
4227 |
Create a Problem object from an exception instance.
|
|
4228 |
|
|
4229 |
If the exception is a sub-class of ConeException, then it may contain
|
|
4230 |
extra information (like a line number) for the problem.
|
|
4231 |
"""
|
|
4232 |
if isinstance(ex, exceptions.ConeException):
|
|
4233 |
return Problem(msg = ex.problem_msg or unicode(ex),
|
|
4234 |
type = ex.problem_type or '',
|
|
4235 |
line = ex.problem_lineno,
|
|
4236 |
severity = cls.SEVERITY_ERROR)
|
|
4237 |
else:
|
|
4238 |
return Problem(msg = unicode(ex),
|
|
4239 |
severity = cls.SEVERITY_ERROR)
|
|
4240 |
|
|
4241 |
def __repr__(self):
|
|
4242 |
var_data = []
|
|
4243 |
for varname in ('msg', 'type', 'line', 'file', 'severity'):
|
|
4244 |
var_data.append("%s=%r" % (varname, getattr(self, varname)))
|
|
4245 |
return "%s(%s)" % (self.__class__.__name__, ', '.join(var_data))
|
|
4246 |
|
|
4247 |
def __eq__(self, other):
|
|
4248 |
if not isinstance(other, Problem):
|
|
4249 |
return False
|
|
4250 |
for varname in ('msg', 'type', 'line', 'file', 'severity'):
|
|
4251 |
self_val = getattr(self, varname)
|
|
4252 |
other_val = getattr(other, varname)
|
|
4253 |
if self_val != other_val:
|
|
4254 |
return False
|
|
4255 |
return True
|
|
4256 |
|
|
4257 |
def __ne__(self, other):
|
|
4258 |
return self == other
|
|
4259 |
|
|
4260 |
def __lt__(self, other):
|
|
4261 |
if not isinstance(other, Problem):
|
|
4262 |
return False
|
|
4263 |
return (self.file, self.line) < (other.file, other.line)
|
|
4264 |
|
|
4265 |
def make_content_info(resource, data):
|
|
4266 |
"""
|
|
4267 |
Factory for ContentInfo
|
|
4268 |
"""
|
|
4269 |
cnt_inf = None
|
|
4270 |
|
|
4271 |
if resource != None:
|
|
4272 |
guessed_type = mimetypes.guess_type(resource.get_path())
|
|
4273 |
mimetype = None
|
|
4274 |
mimesubtype = None
|
|
4275 |
|
|
4276 |
if guessed_type != None:
|
|
4277 |
mimetype, mimesubtype = guessed_type[0].split('/')
|
|
4278 |
|
|
4279 |
if mimetype == 'image' and mimesubtype == 'x-ms-bmp':
|
|
4280 |
cnt_inf = BmpImageContentInfo(resource, data)
|
|
4281 |
else:
|
|
4282 |
cnt_inf = ContentInfo(mimetype, mimesubtype)
|
|
4283 |
return cnt_inf
|
|
4284 |
|
|
4285 |
def open_storage(path, mode="r", **kwargs):
|
|
4286 |
return Storage.open(path, mode="r", **kwargs)
|
|
4287 |
|
0
|
4288 |
class NullHandler(logging.Handler):
|
|
4289 |
"""
|
|
4290 |
Default handler that does not do anything.
|
|
4291 |
"""
|
|
4292 |
def emit(self, record):
|
|
4293 |
pass
|
|
4294 |
|
|
4295 |
#Initialization of default logger that contains NullHandler.
|
|
4296 |
logger = logging.getLogger('cone')
|
|
4297 |
logger.addHandler(NullHandler())
|