|
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 |
A plugin implementation for rule generation.
|
|
|
18 |
'''
|
|
|
19 |
|
|
|
20 |
|
|
|
21 |
import os
|
|
|
22 |
import logging
|
|
3
|
23 |
import pkg_resources
|
|
0
|
24 |
|
|
|
25 |
from ruleplugin import relations
|
|
3
|
26 |
from cone.public import plugin,utils,rules
|
|
0
|
27 |
|
|
|
28 |
class RuleImpl(plugin.ImplBase):
|
|
|
29 |
IMPL_TYPE_ID = 'ruleml'
|
|
|
30 |
DEFAULT_INVOCATION_PHASE = 'pre'
|
|
|
31 |
|
|
|
32 |
def __init__(self, ref, configuration, relation_container):
|
|
|
33 |
"""
|
|
|
34 |
Overloading the default constructor
|
|
|
35 |
"""
|
|
|
36 |
plugin.ImplBase.__init__(self,ref,configuration)
|
|
|
37 |
self.relation_container = relation_container
|
|
|
38 |
|
|
|
39 |
def list_output_files(self):
|
|
|
40 |
"""
|
|
|
41 |
Return a list of output files as an array.
|
|
|
42 |
"""
|
|
|
43 |
return []
|
|
|
44 |
|
|
3
|
45 |
def get_refs(self):
|
|
|
46 |
"""
|
|
|
47 |
Return a list of all ConfML setting references that affect this
|
|
|
48 |
implementation. May also return None if references are not relevant
|
|
|
49 |
for the implementation.
|
|
|
50 |
"""
|
|
|
51 |
refs = []
|
|
|
52 |
relations = self.get_relations()
|
|
|
53 |
for relation in relations:
|
|
|
54 |
# get refs from relation return a tuple (left side refs, right side refs)
|
|
|
55 |
# only the left side refs are the "input" refs
|
|
|
56 |
refs += relation.get_refs()
|
|
|
57 |
# If the rules do not have any references return None to disable filter by refs
|
|
|
58 |
if refs == []:
|
|
|
59 |
refs = None
|
|
|
60 |
return refs
|
|
|
61 |
|
|
|
62 |
def get_target_refs(self):
|
|
|
63 |
"""
|
|
|
64 |
Return a list of all ConfML setting references that are affected by this
|
|
|
65 |
implementation. May also return None if references are not relevant
|
|
|
66 |
for the implementation.
|
|
|
67 |
"""
|
|
|
68 |
refs = []
|
|
|
69 |
relations = self.get_relations()
|
|
|
70 |
for relation in relations:
|
|
|
71 |
refs += relation.get_set_refs()
|
|
|
72 |
return refs
|
|
|
73 |
|
|
|
74 |
def get_outputs(self):
|
|
|
75 |
"""
|
|
|
76 |
Return a list of GenerationOutput objets as a list.
|
|
|
77 |
"""
|
|
|
78 |
outputs = []
|
|
|
79 |
phase = None
|
|
|
80 |
if self.generation_context: phase = self.generation_context.phase
|
|
|
81 |
for rel in self.get_relations():
|
|
|
82 |
outrefs = rel.get_set_refs()
|
|
|
83 |
for ref in outrefs:
|
|
|
84 |
outputs.append(plugin.GenerationOutput(ref,rel,type='ref', phase=phase))
|
|
|
85 |
return outputs
|
|
|
86 |
|
|
0
|
87 |
def generate(self, context=None):
|
|
3
|
88 |
logging.getLogger('cone.ruleml(%s)' % self.ref).info("Generating rules from %s" % self.ref)
|
|
0
|
89 |
relation_container = self.get_relation_container()
|
|
|
90 |
relation_container.context = context
|
|
3
|
91 |
return relation_container.execute(context)
|
|
0
|
92 |
|
|
|
93 |
def get_relation_container(self):
|
|
|
94 |
return self.relation_container
|
|
|
95 |
|
|
3
|
96 |
def get_relations(self):
|
|
|
97 |
return self.relation_container.get_relations()
|
|
|
98 |
|
|
|
99 |
class RuleBuiltinsModule(object):
|
|
|
100 |
pass
|
|
|
101 |
|
|
0
|
102 |
class RulemlRelationContainer(plugin.RelationContainer):
|
|
|
103 |
"""
|
|
|
104 |
Relation container for RuleML rules.
|
|
|
105 |
|
|
|
106 |
Basically this is a wrapper for rules.RelationContainer that adapts
|
|
|
107 |
it to the interface of plugin.RelationContainer.
|
|
|
108 |
"""
|
|
|
109 |
def __init__(self, configuration, source, rule_list, eval_globals):
|
|
|
110 |
plugin.RelationContainer.__init__(self, configuration, source=source)
|
|
|
111 |
self.configuration = configuration
|
|
|
112 |
self.relation_container = rules.RelationContainerImpl()
|
|
|
113 |
self.eval_globals = eval_globals
|
|
|
114 |
self.context = None
|
|
|
115 |
for rule in rule_list:
|
|
|
116 |
self.relation_container.add_relation(rule)
|
|
|
117 |
|
|
3
|
118 |
def execute(self, context=None):
|
|
0
|
119 |
results = []
|
|
3
|
120 |
if context: self.context = context
|
|
|
121 |
|
|
0
|
122 |
# Create the autoconfig if not done already
|
|
3
|
123 |
autoconfig = plugin.get_autoconfig(self.configuration)
|
|
0
|
124 |
|
|
3
|
125 |
# Using the configuration to pass the eval globals dict to the
|
|
|
126 |
# eval expression. The configuration only contains the globals
|
|
|
127 |
# dict for the duration of the rule execution, so hopefully this
|
|
|
128 |
# shouldn't mess anything up
|
|
|
129 |
self._set_builtin_eval_globals()
|
|
|
130 |
self.context._eval_expression_globals_dict = self.eval_globals
|
|
|
131 |
for i, rel in enumerate(self.relation_container):
|
|
|
132 |
index = i + 1
|
|
|
133 |
# Execute
|
|
|
134 |
self._execute_relation_and_log_error(rel, self.source, index, context)
|
|
0
|
135 |
|
|
3
|
136 |
del self.context._eval_expression_globals_dict
|
|
|
137 |
|
|
|
138 |
if self.relation_container.has_errors():
|
|
|
139 |
for error in self.relation_container.get_errors():
|
|
|
140 |
logging.getLogger('cone.ruleml_relation_container(%s)' % self.source).error(error)
|
|
|
141 |
|
|
|
142 |
if self.context:
|
|
|
143 |
self.context.results += results
|
|
|
144 |
return results
|
|
0
|
145 |
|
|
|
146 |
def get_relation_count(self):
|
|
|
147 |
return len(self.relation_container)
|
|
|
148 |
|
|
3
|
149 |
def get_relations(self):
|
|
|
150 |
return list(self.relation_container)
|
|
|
151 |
|
|
0
|
152 |
def _set_builtin_eval_globals(self):
|
|
|
153 |
"""
|
|
|
154 |
Add built-in attributes into the eval globals dictionary.
|
|
|
155 |
"""
|
|
3
|
156 |
builtins = RuleBuiltinsModule()
|
|
0
|
157 |
builtins.configuration = self.configuration
|
|
3
|
158 |
builtins.context = self.context
|
|
0
|
159 |
|
|
|
160 |
self.eval_globals['ruleml'] = builtins
|
|
|
161 |
|
|
3
|
162 |
class RuleImplReader(plugin.ReaderBase):
|
|
|
163 |
NAMESPACE = 'http://www.s60.com/xml/ruleml/3'
|
|
|
164 |
NAMESPACE_ID = 'ruleml3'
|
|
|
165 |
ROOT_ELEMENT_NAME = 'ruleml'
|
|
0
|
166 |
FILE_EXTENSIONS = ['ruleml']
|
|
|
167 |
|
|
|
168 |
def __init__(self, resource_ref, configuration):
|
|
|
169 |
self.resource_ref = resource_ref
|
|
|
170 |
self.configuration = configuration
|
|
|
171 |
|
|
|
172 |
@classmethod
|
|
|
173 |
def read_impl(cls, resource_ref, configuration, etree):
|
|
|
174 |
reader = cls(resource_ref, configuration)
|
|
3
|
175 |
rules = reader.parse_rules(resource_ref, etree)
|
|
|
176 |
eval_globals = reader.parse_eval_globals(etree)
|
|
|
177 |
lineno = utils.etree.get_lineno(etree)
|
|
0
|
178 |
|
|
3
|
179 |
# Create an ImplContainer to hold each rule as its own
|
|
|
180 |
# RuleML implementation
|
|
|
181 |
main_impl = plugin.ImplContainer(resource_ref, configuration)
|
|
|
182 |
main_impl.lineno = lineno
|
|
|
183 |
|
|
|
184 |
for rule in rules:
|
|
0
|
185 |
relation_container = RulemlRelationContainer(
|
|
|
186 |
configuration = configuration,
|
|
3
|
187 |
source = "%s:%d" % (resource_ref, rule.lineno),
|
|
|
188 |
rule_list = [rule],
|
|
0
|
189 |
eval_globals = eval_globals)
|
|
|
190 |
|
|
3
|
191 |
impl = RuleImpl(resource_ref, configuration, relation_container)
|
|
|
192 |
impl.lineno = rule.lineno
|
|
|
193 |
rule.implml = impl
|
|
|
194 |
|
|
|
195 |
main_impl.append(impl)
|
|
|
196 |
return main_impl
|
|
0
|
197 |
|
|
3
|
198 |
@classmethod
|
|
|
199 |
def get_schema_data(cls):
|
|
|
200 |
return pkg_resources.resource_string('ruleplugin', 'xsd/ruleml3.xsd')
|
|
0
|
201 |
|
|
3
|
202 |
def parse_rules(self, ref, etree):
|
|
0
|
203 |
rules = []
|
|
|
204 |
for elem in etree.getiterator("{%s}rule" % self.NAMESPACE):
|
|
3
|
205 |
lineno = utils.etree.get_lineno(elem)
|
|
|
206 |
rule_str = self._replace_eval_blocks(elem.text or '')
|
|
|
207 |
rels = relations.RelationFactory.get_relations(rule_str) or []
|
|
|
208 |
for rule in rels:
|
|
|
209 |
rule.ref = ref
|
|
|
210 |
rule.lineno = lineno
|
|
|
211 |
rules.append(rule)
|
|
0
|
212 |
return rules
|
|
|
213 |
|
|
|
214 |
def parse_eval_globals(self, etree):
|
|
|
215 |
eval_globals = {}
|
|
|
216 |
for elem in etree.getiterator("{%s}eval_globals" % self.NAMESPACE):
|
|
|
217 |
text = ""
|
|
|
218 |
if elem.get('file') != None:
|
|
|
219 |
self._read_eval_globals_from_file(elem.get('file'), eval_globals)
|
|
|
220 |
else:
|
|
|
221 |
try:
|
|
|
222 |
# Strip surrounding whitespace, otherwise there might be Python
|
|
|
223 |
# indentation errors
|
|
|
224 |
text = elem.text.strip()
|
|
|
225 |
exec(text, eval_globals)
|
|
|
226 |
except Exception, e:
|
|
3
|
227 |
logging.getLogger('cone.ruleml(%s)' % self.resource_ref).warning('Failed to evaluate eval_globals block, exception: %s' % (e))
|
|
0
|
228 |
return eval_globals
|
|
|
229 |
|
|
|
230 |
def _read_eval_globals_from_file(self, relative_path, eval_globals):
|
|
|
231 |
# Get the actual path (relative to the current implementation file)
|
|
|
232 |
base_path = os.path.dirname(self.resource_ref)
|
|
|
233 |
pyfile_path = os.path.normpath(os.path.join(base_path, relative_path)).replace('\\', '/')
|
|
|
234 |
# Read the data and execute
|
|
|
235 |
try:
|
|
|
236 |
resource = None
|
|
|
237 |
resource = self.configuration.get_resource(pyfile_path)
|
|
|
238 |
text = resource.read()
|
|
|
239 |
exec(text.replace('\r', ''), eval_globals)
|
|
|
240 |
except Exception, e:
|
|
3
|
241 |
logging.getLogger('cone.ruleml(%s)' % self.resource_ref).warning('Cannot import eval file: %s. Exception: %s' % (pyfile_path, e))
|
|
0
|
242 |
finally:
|
|
|
243 |
if resource is not None: resource.close()
|
|
|
244 |
|
|
|
245 |
|
|
|
246 |
@classmethod
|
|
|
247 |
def _replace_eval_blocks(cls, code):
|
|
|
248 |
return utils.expand_delimited_tokens(
|
|
|
249 |
string = code,
|
|
|
250 |
expander_func = lambda ref, index: '__eval__ %r' % ref,
|
|
|
251 |
delimiters =('{%', '%}'))
|