6 #from openerp.tools.safe_eval import safe_eval as eval
8 import xml # FIXME use lxml
11 _logger = logging.getLogger(__name__)
13 class QWebContext(dict):
14 def __init__(self, data, undefined_handler=None):
15 self.undefined_handler = undefined_handler
38 dict.__init__(self, d)
39 self['defined'] = lambda key: key in self
41 def __getitem__(self, key):
44 elif not self.undefined_handler:
45 raise NameError("QWeb: name %r is not defined while rendering template %r" % (key, self.get('__template__')))
47 return self.get(key, self.undefined_handler(key, self))
49 class QWebXml(object):
50 """QWeb Xml templating engine
52 The templating engine use a very simple syntax, "magic" xml attributes, to
53 produce any kind of texutal output (even non-xml).
56 the template engine core implements the basic magic attributes:
58 t-att t-raw t-esc t-if t-foreach t-set t-call t-trim
61 - loader: function that return a template
65 def __init__(self, loader=None, undefined_handler=None):
67 self.undefined_handler = undefined_handler
68 self.node = xml.dom.Node
71 self._format_regex = re.compile('#\{(.*?)\}')
72 self._void_elements = set(['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen',
73 'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr'])
74 prefix = 'render_tag_'
75 for i in [j for j in dir(self) if j.startswith(prefix)]:
76 name = i[len(prefix):].replace('_', '-')
77 self._render_tag[name] = getattr(self.__class__, i)
80 prefix = 'render_att_'
81 for i in [j for j in dir(self) if j.startswith(prefix)]:
82 name = i[len(prefix):].replace('_', '-')
83 self._render_att[name] = getattr(self.__class__, i)
85 def register_tag(self, tag, func):
86 self._render_tag[tag] = func
88 def add_template(self, x):
89 if hasattr(x, 'documentElement'):
91 elif x.startswith("<?xml"):
92 dom = xml.dom.minidom.parseString(x)
94 dom = xml.dom.minidom.parse(x)
95 for n in dom.documentElement.childNodes:
96 if n.getAttribute('t-name'):
97 self._t[str(n.getAttribute("t-name"))] = n
99 def get_template(self, name):
103 xml = self.loader(name)
104 self.add_template(xml)
107 raise KeyError('qweb: template "%s" not found' % name)
109 def eval(self, expr, v):
111 return eval(expr, None, v)
113 raise SyntaxError("QWeb: invalid expression %r while rendering template '%s'" % (expr, v.get('__template__')))
115 def eval_object(self, expr, v):
116 return self.eval(expr, v)
118 def eval_str(self, expr, v):
121 val = self.eval(expr, v)
122 if isinstance(val, unicode):
123 return val.encode("utf8")
126 def eval_format(self, expr, v):
128 for m in self._format_regex.finditer(expr):
130 expr = expr.replace(m.group(), self.eval_str(m.groups()[0], v))
137 raise Exception("QWeb: format error '%s' " % expr)
139 def eval_bool(self, expr, v):
140 val = self.eval(expr, v)
146 def render(self, tname, v=None, out=None):
149 v['__template__'] = tname
150 v = QWebContext(v, self.undefined_handler)
151 return self.render_node(self.get_template(tname), v)
153 def render_node(self, e, v):
155 if e.nodeType == self.node.TEXT_NODE or e.nodeType == self.node.CDATA_SECTION_NODE:
156 r = e.data.encode("utf8")
157 elif e.nodeType == self.node.ELEMENT_NODE:
161 for (an, av) in e.attributes.items():
163 if isinstance(av, types.UnicodeType):
164 av = av.encode("utf8")
166 av = av.nodeValue.encode("utf8")
167 if an.startswith("t-"):
168 for i in self._render_att:
169 if an[2:].startswith(i):
170 g_att += self._render_att[i](self, e, an, av, v)
173 if an[2:] in self._render_tag:
177 g_att += ' %s="%s"' % (an, cgi.escape(av, 1))
179 if t_render in self._render_tag:
180 r = self._render_tag[t_render](self, e, t_att, g_att, v)
182 r = self.render_element(e, t_att, g_att, v)
185 def render_element(self, e, t_att, g_att, v, inner=None):
187 # t_att: t-* attributes
188 # g_att: generated attributes
190 # inner: optional innerXml
195 for n in e.childNodes:
196 g_inner.append(self.render_node(n, v))
197 name = str(e.nodeName)
198 inner = "".join(g_inner)
199 trim = t_att.get("trim", 0)
203 inner = inner.lstrip()
204 elif trim == 'right':
205 inner = inner.rstrip()
207 inner = inner.strip()
210 elif len(inner) or name not in self._void_elements:
211 return "<%s%s>%s</%s>" % (name, g_att, inner, name)
213 return "<%s%s/>" % (name, g_att)
216 def render_att_att(self, e, an, av, v):
217 if an.startswith("t-attf-"):
218 att, val = an[7:], self.eval_format(av, v)
219 elif an.startswith("t-att-"):
220 att, val = an[6:], self.eval_str(av, v)
222 att, val = self.eval_object(av, v)
223 return ' %s="%s"' % (att, cgi.escape(val, 1))
226 def render_tag_raw(self, e, t_att, g_att, v):
227 inner = self.eval_str(t_att["raw"], v)
228 return self.render_element(e, t_att, g_att, v, inner)
230 def render_tag_rawf(self, e, t_att, g_att, v):
231 inner = self.eval_format(t_att["rawf"], v)
232 return self.render_element(e, t_att, g_att, v, inner)
234 def render_tag_esc(self, e, t_att, g_att, v):
235 inner = cgi.escape(self.eval_str(t_att["esc"], v))
236 return self.render_element(e, t_att, g_att, v, inner)
238 def render_tag_escf(self, e, t_att, g_att, v):
239 inner = cgi.escape(self.eval_format(t_att["escf"], v))
240 return self.render_element(e, t_att, g_att, v, inner)
242 def render_tag_foreach(self, e, t_att, g_att, v):
243 expr = t_att["foreach"]
244 enum = self.eval_object(expr, v)
246 var = t_att.get('as', expr).replace('.', '_')
247 d = QWebContext(v.copy(), self.undefined_handler)
249 if isinstance(enum, types.ListType):
251 elif isinstance(enum, types.TupleType):
253 elif hasattr(enum, 'count'):
255 d["%s_size" % var] = size
256 d["%s_all" % var] = enum
260 d["%s_value" % var] = i
261 d["%s_index" % var] = index
262 d["%s_first" % var] = index == 0
263 d["%s_even" % var] = index % 2
264 d["%s_odd" % var] = (index + 1) % 2
265 d["%s_last" % var] = index + 1 == size
267 d["%s_parity" % var] = 'odd'
269 d["%s_parity" % var] = 'even'
270 if isinstance(i, types.DictType):
274 ru.append(self.render_element(e, t_att, g_att, d))
278 return "qweb: t-foreach %s not found." % expr
280 def render_tag_if(self, e, t_att, g_att, v):
281 if self.eval_bool(t_att["if"], v):
282 return self.render_element(e, t_att, g_att, v)
286 def render_tag_call(self, e, t_att, g_att, v):
287 if "import" in t_att:
290 d = QWebContext(v.copy(), self.undefined_handler)
291 d[0] = self.render_element(e, t_att, g_att, d)
292 return self.render(t_att["call"], d)
294 def render_tag_set(self, e, t_att, g_att, v):
296 v[t_att["set"]] = self.eval_object(t_att["value"], v)
297 elif "valuef" in t_att:
298 v[t_att["set"]] = self.eval_format(t_att["valuef"], v)
300 v[t_att["set"]] = self.render_element(e, t_att, g_att, v)
303 def render_tag_field(self, e, t_att, g_att, v):
304 """ eg: <span t-record="browse_record(res.partner, 1)" t-field="phone">+1 555 555 8069</span>"""
306 record, field = t_att["field"].rsplit('.', 1)
307 record = self.eval_object(record, v)
310 field_type = record._model._all_columns[field].column._type
312 if field_type == 'many2one':
313 field_data = record.read([field])[0].get(field)
314 inner = field_data and field_data[1] or ""
316 inner = getattr(record, field) or ""
317 if isinstance(inner, types.UnicodeType):
318 inner = inner.encode("utf8")
319 if field_type != 'html':
320 cgi.escape(str(inner))
323 ' %s="%s"' % (name, cgi.escape(str(value), True))
325 ('data-oe-model', record._model._name),
326 ('data-oe-id', str(record.id)),
327 ('data-oe-field', field),
328 ('data-oe-type', field_type),
331 except AttributeError:
332 _logger.warning("t-field no field %s for model %s", field, record._model._name)
334 return self.render_element(e, t_att, g_att, v, str(inner))