0
|
1 |
#
|
|
2 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
# All rights reserved.
|
|
4 |
# This component and the accompanying materials are made available
|
|
5 |
# under the terms of "Eclipse Public License v1.0"
|
|
6 |
# which accompanies this distribution, and is available
|
|
7 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
#
|
|
9 |
# Initial Contributors:
|
|
10 |
# Nokia Corporation - initial contribution.
|
|
11 |
#
|
|
12 |
# Contributors:
|
|
13 |
#
|
|
14 |
# Description:
|
|
15 |
#
|
|
16 |
##
|
|
17 |
# @author Teemu Rytkonen
|
|
18 |
'''
|
|
19 |
A plugin implementation for content selection from ConfigurationLayers.
|
|
20 |
'''
|
|
21 |
|
|
22 |
|
|
23 |
import re
|
|
24 |
import os
|
|
25 |
import sys
|
|
26 |
import logging
|
|
27 |
import shutil
|
|
28 |
import copy
|
|
29 |
import xml.parsers.expat
|
|
30 |
|
|
31 |
try:
|
|
32 |
from cElementTree import ElementTree
|
|
33 |
except ImportError:
|
|
34 |
try:
|
|
35 |
from elementtree import ElementTree
|
|
36 |
except ImportError:
|
|
37 |
try:
|
|
38 |
from xml.etree import cElementTree as ElementTree
|
|
39 |
except ImportError:
|
|
40 |
from xml.etree import ElementTree
|
|
41 |
|
|
42 |
import __init__
|
|
43 |
|
|
44 |
from cone.public import exceptions,plugin,utils,api
|
|
45 |
|
|
46 |
class ContentOutput(object):
|
|
47 |
def __init__(self, **kwargs):
|
|
48 |
self._dir = kwargs.get('dir',None)
|
|
49 |
self._file = kwargs.get('file',None)
|
|
50 |
self.flatten = kwargs.get('flatten',False)
|
|
51 |
self.inputs = kwargs.get('inputs', [])
|
|
52 |
self.configuration = None
|
|
53 |
|
|
54 |
def set_configuration(self, configuration):
|
|
55 |
self.configuration = configuration
|
|
56 |
for input in self.inputs:
|
|
57 |
input.configuration = self.configuration
|
|
58 |
|
|
59 |
def get_configuration(self, configuration):
|
|
60 |
self.configuration = configuration
|
|
61 |
|
|
62 |
def path_convert(self, path):
|
3
|
63 |
match = re.match('([a-zA-Z]:)(.*)', path)
|
|
64 |
if match:
|
|
65 |
path = match.group(2)
|
|
66 |
return path.lstrip('\\/')
|
0
|
67 |
|
|
68 |
def get_dir(self):
|
|
69 |
if self.configuration and ConfmlRefs.is_confml_ref(self._dir):
|
|
70 |
parts = self._dir.split(ConfmlRefs.ref_separator)
|
|
71 |
for (index, part) in enumerate(parts):
|
|
72 |
if ConfmlRefs.is_confml_ref(part):
|
|
73 |
ref = ConfmlRefs.get_confml_ref(part)
|
|
74 |
parts[index] = self.configuration.get_default_view().get_feature(ref).value
|
|
75 |
parts[index] = self.path_convert(parts[index])
|
|
76 |
else:
|
|
77 |
parts[index] = part
|
|
78 |
return (os.sep).join(parts)
|
|
79 |
else:
|
|
80 |
return self.path_convert(self._dir)
|
|
81 |
|
|
82 |
def set_dir(self, dir):
|
|
83 |
self._dir = dir
|
|
84 |
|
|
85 |
def get_file(self):
|
|
86 |
if self.configuration and self._file != None and ConfmlRefs.is_confml_ref(self._file):
|
|
87 |
parts = self._file.split(ConfmlRefs.ref_separator)
|
|
88 |
for (index, part) in enumerate(parts):
|
|
89 |
if ConfmlRefs.is_confml_ref(part):
|
|
90 |
ref = ConfmlRefs.get_confml_ref(part)
|
|
91 |
parts[index] = self.configuration.get_default_view().get_feature(ref).value
|
|
92 |
parts[index] = self.path_convert(parts[index])
|
|
93 |
else:
|
|
94 |
parts[index] = part
|
|
95 |
return (os.sep).join(parts)
|
|
96 |
else:
|
|
97 |
return self._file
|
|
98 |
|
|
99 |
def set_file(self, file):
|
|
100 |
self._file = file
|
|
101 |
|
|
102 |
dir = property(get_dir, set_dir)
|
|
103 |
file = property(get_file, set_file)
|
|
104 |
|
|
105 |
def get_refs(self):
|
|
106 |
refs = []
|
|
107 |
for input in self.inputs:
|
|
108 |
refs.extend(input.get_refs())
|
|
109 |
return refs
|
|
110 |
|
|
111 |
|
|
112 |
class ContentInput(object):
|
|
113 |
def __init__(self, **kwargs):
|
|
114 |
self._dir = kwargs.get('dir',None)
|
|
115 |
self._file = kwargs.get('file',None)
|
|
116 |
self._include = kwargs.get('include', {})
|
|
117 |
self._exclude = kwargs.get('exclude', {})
|
|
118 |
self.configuration = None
|
|
119 |
|
|
120 |
@property
|
|
121 |
def dir(self):
|
|
122 |
|
|
123 |
if self.configuration and ConfmlRefs.is_confml_ref(self._dir):
|
|
124 |
cref = ConfmlRefs.get_confml_ref(self._dir)
|
|
125 |
return self.configuration.get_default_view().get_feature(cref).value
|
|
126 |
else:
|
|
127 |
return self._dir
|
|
128 |
|
|
129 |
@property
|
|
130 |
def file(self):
|
|
131 |
|
|
132 |
if self._file and self.configuration and ConfmlRefs.is_confml_ref(self._file):
|
|
133 |
cref = ConfmlRefs.get_confml_ref(self._file)
|
|
134 |
return self.configuration.get_default_view().get_feature(cref).value
|
|
135 |
else:
|
|
136 |
return self._file
|
|
137 |
|
|
138 |
|
|
139 |
def _dereference_dict(self, data):
|
|
140 |
if self.configuration:
|
|
141 |
# Make a deep copy of the data, or otherwise get_refs() will
|
|
142 |
# return the correct refs only on the first call, as the
|
|
143 |
# references are replaced here
|
|
144 |
data = copy.deepcopy(data)
|
|
145 |
|
|
146 |
dview = self.configuration.get_default_view()
|
|
147 |
for key in data:
|
|
148 |
key_list = data.get(key)
|
|
149 |
for (index,elem) in enumerate(key_list):
|
|
150 |
if ConfmlRefs.is_confml_ref(elem):
|
|
151 |
cref = ConfmlRefs.get_confml_ref(elem)
|
|
152 |
try:
|
|
153 |
# change None value to empty string
|
|
154 |
cvalue = dview.get_feature(cref).value or ''
|
|
155 |
if utils.is_list(cvalue):
|
3
|
156 |
# Allow only strings (mainly filter out Nones)
|
|
157 |
cvalue = filter(lambda x: isinstance(x, basestring), cvalue)
|
|
158 |
cvalue = ", ".join([v or '' for v in cvalue])
|
0
|
159 |
key_list[index] = cvalue
|
|
160 |
except exceptions.NotFound:
|
|
161 |
logging.getLogger('cone.content').error("Feature ref '%s' in include key '%s' not found." % (cref,key))
|
|
162 |
return data
|
|
163 |
|
|
164 |
@property
|
|
165 |
def include(self):
|
|
166 |
return self._dereference_dict(self._include)
|
|
167 |
|
|
168 |
@property
|
|
169 |
def exclude(self):
|
|
170 |
return self._dereference_dict(self._exclude)
|
|
171 |
|
|
172 |
def get_filelist(self):
|
|
173 |
filelist = []
|
|
174 |
if self.file:
|
|
175 |
filelist.append(self.file)
|
|
176 |
for elem in self.include.get('files',[]):
|
|
177 |
elem = elem.lower().split(',')
|
|
178 |
filelist += [selem.strip() for selem in elem]
|
|
179 |
return filelist
|
|
180 |
|
|
181 |
def get_include_pattern(self):
|
|
182 |
return self.include.get('pattern',[''])[0]
|
|
183 |
|
|
184 |
def get_exclude_pattern(self):
|
|
185 |
return self.exclude.get('pattern',[''])[0]
|
|
186 |
|
|
187 |
def get_refs(self):
|
|
188 |
refs = []
|
|
189 |
if self._dir is not None:
|
|
190 |
refs.extend(utils.extract_delimited_tokens(self._dir))
|
|
191 |
if self._file is not None:
|
|
192 |
refs.extend(utils.extract_delimited_tokens(self._file))
|
|
193 |
for value_list in self._include.itervalues():
|
|
194 |
for value in value_list:
|
|
195 |
refs.extend(utils.extract_delimited_tokens(value))
|
|
196 |
for value_list in self._exclude.itervalues():
|
|
197 |
for value in value_list:
|
|
198 |
refs.extend(utils.extract_delimited_tokens(value))
|
|
199 |
return refs
|
|
200 |
|
|
201 |
|
|
202 |
class ExternalContentInput(ContentInput):
|
|
203 |
def __init__(self, **kwargs):
|
|
204 |
super(ExternalContentInput,self).__init__(**kwargs)
|
|
205 |
|
|
206 |
class ContentParserBase(object):
|
|
207 |
"""
|
|
208 |
Parses a single content implml file
|
|
209 |
"""
|
|
210 |
NAMESPACES = ['http://www.s60.com/xml/content/1']
|
|
211 |
INCLUDE_ATTR = ['pattern']
|
|
212 |
EXCLUDE_ATTR = ['pattern']
|
|
213 |
def __init__(self):
|
|
214 |
self.namespaces = self.NAMESPACES
|
|
215 |
|
|
216 |
def parse_phase(self,etree):
|
|
217 |
phase = ""
|
|
218 |
phase = etree.get('phase')
|
|
219 |
return phase
|
|
220 |
|
|
221 |
def parse_desc(self,etree):
|
|
222 |
desc = ""
|
|
223 |
desc_elem = etree.find("{%s}desc" % self.namespaces[0])
|
|
224 |
if desc_elem != None:
|
|
225 |
desc = desc_elem.text
|
|
226 |
return desc
|
|
227 |
|
|
228 |
def parse_tags(self,etree):
|
|
229 |
tags = {}
|
|
230 |
for tag in etree.getiterator("{%s}tag" % self.namespaces[0]):
|
|
231 |
tagname = tag.get('name','')
|
|
232 |
tagvalue = tag.get('value')
|
|
233 |
values = tags.get(tagname,[])
|
|
234 |
values.append(tagvalue)
|
|
235 |
tags[tagname] = values
|
|
236 |
return tags
|
|
237 |
|
|
238 |
def parse_input_include(self,etree):
|
|
239 |
include_elem = etree.getiterator("{%s}include" % self.namespaces[0])
|
|
240 |
include = {}
|
|
241 |
for f in include_elem:
|
|
242 |
for key in f.keys():
|
|
243 |
# Add the attribute if it is found to include dict
|
|
244 |
include[key] = []
|
|
245 |
include[key].append(f.get(key))
|
|
246 |
return include
|
|
247 |
|
|
248 |
def parse_input_exclude(self,etree):
|
|
249 |
elem = etree.getiterator("{%s}exclude" % self.namespaces[0])
|
|
250 |
exclude = {}
|
|
251 |
for f in elem:
|
|
252 |
for key in f.keys():
|
|
253 |
# Add the attribute if it is found
|
|
254 |
exclude[key] = []
|
|
255 |
exclude[key].append(f.get(key))
|
|
256 |
return exclude
|
|
257 |
|
|
258 |
class Content1Parser(ContentParserBase):
|
|
259 |
"""
|
|
260 |
Parses a single content implml file
|
|
261 |
"""
|
|
262 |
NAMESPACES = ['http://www.s60.com/xml/content/1']
|
|
263 |
def __init__(self):
|
|
264 |
super(ContentParserBase,self).__init__()
|
|
265 |
self.namespaces = self.NAMESPACES
|
|
266 |
|
|
267 |
def parse_input(self,etree):
|
|
268 |
input_elem = etree.find("{%s}input" % self.namespaces[0])
|
|
269 |
input_dir = ""
|
|
270 |
input_file = ""
|
|
271 |
if input_elem != None:
|
|
272 |
if input_elem.get('dir'):
|
|
273 |
input_dir = input_elem.get('dir')
|
|
274 |
if input_elem.get('file'):
|
|
275 |
input_dir = input_elem.get('file')
|
|
276 |
includes = self.parse_input_include(etree)
|
|
277 |
excludes = self.parse_input_exclude(etree)
|
|
278 |
return ContentInput(dir=input_dir, include=includes, exclude=excludes, file=input_file)
|
|
279 |
return None
|
|
280 |
|
|
281 |
def parse_outputs(self,etree):
|
|
282 |
output_elem = etree.find("{%s}output" % self.namespaces[0])
|
|
283 |
output_dir = ""
|
|
284 |
output_flatten = False
|
|
285 |
inputs = []
|
|
286 |
if output_elem != None:
|
|
287 |
output_dir = output_elem.get('dir','')
|
|
288 |
output_flatten = output_elem.get('flatten','') == "true"
|
|
289 |
input = self.parse_input(etree)
|
|
290 |
if input:
|
|
291 |
inputs.append(input)
|
|
292 |
return [ContentOutput(dir=output_dir, flatten=output_flatten, inputs=inputs)]
|
|
293 |
|
|
294 |
class Content2Parser(ContentParserBase):
|
|
295 |
"""
|
|
296 |
Parses a single content implml file
|
|
297 |
"""
|
|
298 |
NAMESPACES = ['http://www.s60.com/xml/content/2']
|
|
299 |
def __init__(self):
|
|
300 |
super(ContentParserBase,self).__init__()
|
|
301 |
self.namespaces = self.NAMESPACES
|
|
302 |
|
|
303 |
|
|
304 |
def parse_input(self,input_elem):
|
|
305 |
input = None
|
|
306 |
input_dir = ''
|
|
307 |
input_file = ''
|
|
308 |
if input_elem != None:
|
|
309 |
if input_elem.get('dir'):
|
|
310 |
input_dir = input_elem.get('dir')
|
|
311 |
if input_elem.get('file'):
|
|
312 |
input_file= input_elem.get('file')
|
|
313 |
includes = self.parse_input_include(input_elem)
|
|
314 |
excludes = self.parse_input_exclude(input_elem)
|
|
315 |
input = ContentInput(dir=input_dir, include=includes, exclude=excludes, file=input_file)
|
|
316 |
return input
|
|
317 |
|
|
318 |
def parse_external_input(self,input_elem):
|
|
319 |
input = None
|
|
320 |
input_dir = ''
|
|
321 |
if input_elem != None:
|
|
322 |
if input_elem.get('dir'):
|
|
323 |
input_dir = input_elem.get('dir')
|
|
324 |
includes = self.parse_input_include(input_elem)
|
|
325 |
excludes = self.parse_input_exclude(input_elem)
|
|
326 |
input = ExternalContentInput(dir=input_dir, include=includes, exclude=excludes)
|
|
327 |
return input
|
|
328 |
|
|
329 |
def parse_outputs(self,etree):
|
|
330 |
outputs = []
|
|
331 |
for output_elem in etree.getiterator("{%s}output" % self.namespaces[0]):
|
|
332 |
inputs = []
|
|
333 |
output_dir = output_elem.get('dir','')
|
|
334 |
output_file = output_elem.get('file','')
|
|
335 |
output_flatten = output_elem.get('flatten','') == "true"
|
|
336 |
for input_elem in output_elem.getiterator("{%s}input" % self.namespaces[0]):
|
|
337 |
inputs.append(self.parse_input(input_elem))
|
|
338 |
for input_elem in output_elem.getiterator("{%s}externalinput" % self.namespaces[0]):
|
|
339 |
inputs.append(self.parse_external_input(input_elem))
|
|
340 |
outputs.append(ContentOutput(dir=output_dir, flatten=output_flatten, inputs=inputs, file=output_file))
|
|
341 |
return outputs
|
|
342 |
|
|
343 |
|
|
344 |
class ContentImplReader(object):
|
|
345 |
"""
|
|
346 |
Parses a single content implml file
|
|
347 |
"""
|
|
348 |
PARSERS = {'http://www.s60.com/xml/content/1' : Content1Parser,
|
|
349 |
'http://www.s60.com/xml/content/2' : Content2Parser}
|
|
350 |
def __init__(self):
|
|
351 |
self.desc = None
|
|
352 |
self.outputs = None
|
|
353 |
self.phase = None
|
|
354 |
|
|
355 |
def fromstring(self, xml_as_string):
|
|
356 |
etree = ElementTree.fromstring(xml_as_string)
|
|
357 |
# Loop through parsers and try to find a match
|
|
358 |
(namespace,elemname) = get_elemname(etree.tag)
|
|
359 |
pclass = self.PARSERS.get(namespace, None)
|
|
360 |
self.parser = pclass()
|
|
361 |
self.desc = self.parser.parse_desc(etree)
|
|
362 |
self.outputs = self.parser.parse_outputs(etree)
|
|
363 |
self.phase = self.parser.parse_phase(etree)
|
|
364 |
self.tags = self.parser.parse_tags(etree)
|
|
365 |
return
|
|
366 |
|
|
367 |
namespace_pattern = re.compile("{(.*)}(.*)")
|
|
368 |
nonamespace_pattern = re.compile("(.*)")
|
|
369 |
|
|
370 |
def get_elemname(tag):
|
|
371 |
|
|
372 |
ns = namespace_pattern.match(tag)
|
|
373 |
nn = nonamespace_pattern.match(tag)
|
|
374 |
if ns:
|
|
375 |
namespace = ns.group(1)
|
|
376 |
elemname = ns.group(2)
|
|
377 |
return (namespace,elemname)
|
|
378 |
elif nn:
|
|
379 |
namespace = ""
|
|
380 |
elemname = nn.group(1)
|
|
381 |
return (namespace,elemname)
|
|
382 |
else:
|
|
383 |
raise exceptions.ParseError("Could not parse tag %s" % tag)
|
|
384 |
|
|
385 |
class ConfmlRefs(object):
|
|
386 |
|
|
387 |
ref_pattern = re.compile('^\$\{(.*)\}$')
|
|
388 |
cref_pattern = re.compile('.+\..+')
|
|
389 |
ref_separator = '/'
|
|
390 |
|
|
391 |
@classmethod
|
|
392 |
def is_ref_like(cls, variableref):
|
|
393 |
"""
|
|
394 |
|
|
395 |
Returns true if the given variable represents a ref
|
|
396 |
"""
|
|
397 |
return cls.cref_pattern.match(variableref) != None
|
|
398 |
|
|
399 |
@classmethod
|
|
400 |
def is_confml_ref(cls, variableref):
|
|
401 |
"""
|
|
402 |
|
|
403 |
Returns true if the given variable ref is a confml reference
|
|
404 |
"""
|
|
405 |
|
|
406 |
pos = variableref.find(cls.ref_separator)
|
|
407 |
if pos == -1:
|
|
408 |
return cls.ref_pattern.match(variableref) != None
|
|
409 |
else:
|
|
410 |
return cls.is_confml_refs(variableref)
|
|
411 |
|
|
412 |
@classmethod
|
|
413 |
def is_confml_refs(cls, variableref):
|
|
414 |
"""
|
|
415 |
|
|
416 |
Returns true if the given variable ref is a confml reference
|
|
417 |
"""
|
|
418 |
ret = False
|
|
419 |
parts = variableref.split(cls.ref_separator)
|
|
420 |
for p in parts:
|
|
421 |
if cls.is_confml_ref(p) == True:
|
|
422 |
ret = True
|
|
423 |
return ret
|
|
424 |
|
|
425 |
|
|
426 |
@classmethod
|
|
427 |
def get_confml_ref(cls, variableref):
|
|
428 |
"""
|
|
429 |
|
|
430 |
Returns true if the given variable ref is a confml reference
|
|
431 |
"""
|
|
432 |
pos = variableref.find(cls.ref_separator)
|
|
433 |
if pos == -1:
|
|
434 |
matchref = cls.ref_pattern.match(variableref)
|
|
435 |
if matchref:
|
|
436 |
return matchref.group(1)
|
|
437 |
else:
|
|
438 |
return cls.get_confml_refs(variableref)
|
|
439 |
|
|
440 |
@classmethod
|
|
441 |
def get_confml_refs(cls, variableref):
|
|
442 |
"""
|
|
443 |
|
|
444 |
Returns an array of confml refs based on variableref
|
|
445 |
"""
|
|
446 |
parts = variableref.split(cls.ref_separator)
|
|
447 |
ret = []
|
|
448 |
for p in parts:
|
|
449 |
matchref = cls.ref_pattern.match(p)
|
|
450 |
if matchref:
|
|
451 |
ref = matchref.group(1)
|
|
452 |
if not ref in ret:
|
|
453 |
ret.append(matchref.group(1))
|
|
454 |
else:
|
3
|
455 |
ret.append(p)
|
0
|
456 |
return ret |