openerp/tools/qweb.py

   1 import cgi
   2 import logging
   3 import re
   4
   5 #from openerp.tools.safe_eval import safe_eval as eval
   6
   7 import xml   # FIXME use lxml
   8 import xml.dom.minidom
   9 import traceback
  10 from openerp.osv import osv, orm
  11
  12 _logger = logging.getLogger(__name__)
  13
  14 BUILTINS = {
  15     'False': False,
  16     'None': None,
  17     'True': True,
  18     'abs': abs,
  19     'bool': bool,
  20     'dict': dict,
  21     'filter': filter,
  22     'len': len,
  23     'list': list,
  24     'map': map,
  25     'max': max,
  26     'min': min,
  27     'reduce': reduce,
  28     'repr': repr,
  29     'round': round,
  30     'set': set,
  31     'str': str,
  32     'tuple': tuple,
  33 }
  34
  35 class QWebContext(dict):
  36     def __init__(self, data, undefined_handler=None):
  37         self.undefined_handler = undefined_handler
  38         dic = BUILTINS.copy()
  39         dic.update(data)
  40         dict.__init__(self, dic)
  41         self['defined'] = lambda key: key in self
  42
  43     def __getitem__(self, key):
  44         if key in self:
  45             return self.get(key)
  46         elif not self.undefined_handler:
  47             raise NameError("QWeb: name %r is not defined while rendering template %r" % (key, self.get('__template__')))
  48         else:
  49             return self.get(key, self.undefined_handler(key, self))
  50
  51 class QWebXml(object):
  52     """QWeb Xml templating engine
  53
  54     The templating engine use a very simple syntax, "magic" xml attributes, to
  55     produce any kind of texutal output (even non-xml).
  56
  57     QWebXml:
  58         the template engine core implements the basic magic attributes:
  59
  60         t-att t-raw t-esc t-if t-foreach t-set t-call t-trim
  61
  62
  63     - loader: function that return a template
  64
  65
  66     """
  67     def __init__(self, loader=None, undefined_handler=None):
  68         self.loader = loader
  69         self.undefined_handler = undefined_handler
  70         self.node = xml.dom.Node
  71         self._t = {}
  72         self._render_tag = {}
  73         self._format_regex = re.compile('#\{(.*?)\}')
  74         self._void_elements = set(['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen',
  75                                   'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr'])
  76         prefix = 'render_tag_'
  77         for i in [j for j in dir(self) if j.startswith(prefix)]:
  78             name = i[len(prefix):].replace('_', '-')
  79             self._render_tag[name] = getattr(self.__class__, i)
  80
  81         self._render_att = {}
  82         prefix = 'render_att_'
  83         for i in [j for j in dir(self) if j.startswith(prefix)]:
  84             name = i[len(prefix):].replace('_', '-')
  85             self._render_att[name] = getattr(self.__class__, i)
  86
  87     def register_tag(self, tag, func):
  88         self._render_tag[tag] = func
  89
  90     def add_template(self, x):
  91         if hasattr(x, 'documentElement'):
  92             dom = x
  93         elif x.startswith("<?xml"):
  94             dom = xml.dom.minidom.parseString(x)
  95         else:
  96             dom = xml.dom.minidom.parse(x)
  97         for n in dom.documentElement.childNodes:
  98             if n.nodeType == 1 and n.getAttribute('t-name'):
  99                 self._t[str(n.getAttribute("t-name"))] = n
 100
 101     def get_template(self, name):
 102         if name in self._t:
 103             return self._t[name]
 104         elif self.loader:
 105             xml = self.loader(name)
 106             self.add_template(xml)
 107             if name in self._t:
 108                 return self._t[name]
 109         raise KeyError('qweb: template "%s" not found' % name)
 110
 111     def eval(self, expr, v):
 112         try:
 113             return eval(expr, None, v)
 114         except (osv.except_osv, orm.except_orm), err:
 115             raise orm.except_orm("QWeb Error", "Invalid expression %r while rendering template '%s'.\n\n%s" % (expr, v.get('__template__'), err[1]))
 116         except Exception:
 117             raise SyntaxError("QWeb: invalid expression %r while rendering template '%s'.\n\n%s" % (expr, v.get('__template__'), traceback.format_exc()))
 118
 119     def eval_object(self, expr, v):
 120         return self.eval(expr, v)
 121
 122     def eval_str(self, expr, v):
 123         if expr == "0":
 124             return v.get(0, '')
 125         val = self.eval(expr, v)
 126         if isinstance(val, unicode):
 127             return val.encode("utf8")
 128         return str(val)
 129
 130     def eval_format(self, expr, v):
 131         use_native = True
 132         for m in self._format_regex.finditer(expr):
 133             use_native = False
 134             expr = expr.replace(m.group(), self.eval_str(m.groups()[0], v))
 135         if not use_native:
 136             return expr
 137         else:
 138             try:
 139                 return str(expr % v)
 140             except:
 141                 raise Exception("QWeb: format error '%s' " % expr)
 142
 143     def eval_bool(self, expr, v):
 144         val = self.eval(expr, v)
 145         if val:
 146             return 1
 147         else:
 148             return 0
 149
 150     def render(self, tname, v=None, out=None):
 151         if v is None:
 152             v = {}
 153         v['__template__'] = tname
 154         stack = v.get('__stack__', [])
 155         if stack:
 156             v['__caller__'] = stack[-1]
 157         stack.append(tname)
 158         v['__stack__'] = stack
 159         v = QWebContext(v, self.undefined_handler)
 160         return self.render_node(self.get_template(tname), v)
 161
 162     def render_node(self, e, v):
 163         r = ""
 164         if e.nodeType == self.node.TEXT_NODE or e.nodeType == self.node.CDATA_SECTION_NODE:
 165             r = e.data.encode("utf8")
 166         elif e.nodeType == self.node.ELEMENT_NODE:
 167             g_att = ""
 168             t_render = None
 169             t_att = {}
 170             for (an, av) in e.attributes.items():
 171                 an = str(an)
 172                 if isinstance(av, types.UnicodeType):
 173                     av = av.encode("utf8")
 174                 else:
 175                     av = av.nodeValue.encode("utf8")
 176                 if an.startswith("t-"):
 177                     for i in self._render_att:
 178                         if an[2:].startswith(i):
 179                             g_att += self._render_att[i](self, e, an, av, v)
 180                             break
 181                     else:
 182                         if an[2:] in self._render_tag:
 183                             t_render = an[2:]
 184                         t_att[an[2:]] = av
 185                 else:
 186                     g_att += ' %s="%s"' % (an, cgi.escape(av, 1))
 187
 188             if 'debug' in t_att:
 189                 debugger = t_att.get('debug', 'pdb')
 190                 __import__(debugger).set_trace() # pdb, ipdb, pudb, ...
 191             if t_render:
 192                 if t_render in self._render_tag:
 193                     r = self._render_tag[t_render](self, e, t_att, g_att, v)
 194             else:
 195                 r = self.render_element(e, t_att, g_att, v)
 196         return r
 197
 198     def render_element(self, e, t_att, g_att, v, inner=None):
 199         # e: element
 200         # t_att: t-* attributes
 201         # g_att: generated attributes
 202         # v: values
 203         # inner: optional innerXml
 204         if inner:
 205             g_inner = inner
 206         else:
 207             g_inner = []
 208             for n in e.childNodes:
 209                 g_inner.append(self.render_node(n, v))
 210         name = str(e.nodeName)
 211         inner = "".join(g_inner)
 212         trim = t_att.get("trim", 0)
 213         if trim == 0:
 214             pass
 215         elif trim == 'left':
 216             inner = inner.lstrip()
 217         elif trim == 'right':
 218             inner = inner.rstrip()
 219         elif trim == 'both':
 220             inner = inner.strip()
 221         if name == "t":
 222             return inner
 223         elif len(inner) or name not in self._void_elements:
 224             return "<%s%s>%s</%s>" % (name, g_att, inner, name)
 225         else:
 226             return "<%s%s/>" % (name, g_att)
 227
 228     # Attributes
 229     def render_att_att(self, e, an, av, v):
 230         if an.startswith("t-attf-"):
 231             att, val = an[7:], self.eval_format(av, v)
 232         elif an.startswith("t-att-"):
 233             att, val = an[6:], self.eval(av, v)
 234             if isinstance(val, unicode):
 235                 val = val.encode("utf8")
 236         else:
 237             att, val = self.eval_object(av, v)
 238         return val and ' %s="%s"' % (att, cgi.escape(str(val), 1)) or " "
 239
 240     # Tags
 241     def render_tag_raw(self, e, t_att, g_att, v):
 242         inner = self.eval_str(t_att["raw"], v)
 243         return self.render_element(e, t_att, g_att, v, inner)
 244
 245     def render_tag_rawf(self, e, t_att, g_att, v):
 246         inner = self.eval_format(t_att["rawf"], v)
 247         return self.render_element(e, t_att, g_att, v, inner)
 248
 249     def render_tag_esc(self, e, t_att, g_att, v):
 250         inner = cgi.escape(self.eval_str(t_att["esc"], v))
 251         return self.render_element(e, t_att, g_att, v, inner)
 252
 253     def render_tag_escf(self, e, t_att, g_att, v):
 254         inner = cgi.escape(self.eval_format(t_att["escf"], v))
 255         return self.render_element(e, t_att, g_att, v, inner)
 256
 257     def render_tag_foreach(self, e, t_att, g_att, v):
 258         expr = t_att["foreach"]
 259         enum = self.eval_object(expr, v)
 260         if enum is not None:
 261             var = t_att.get('as', expr).replace('.', '_')
 262             d = QWebContext(v.copy(), self.undefined_handler)
 263             size = -1
 264             if isinstance(enum, (types.ListType, types.TupleType)):
 265                 size = len(enum)
 266             elif hasattr(enum, 'count'):
 267                 size = enum.count()
 268             d["%s_size" % var] = size
 269             d["%s_all" % var] = enum
 270             index = 0
 271             ru = []
 272             for i in enum:
 273                 d["%s_value" % var] = i
 274                 d["%s_index" % var] = index
 275                 d["%s_first" % var] = index == 0
 276                 d["%s_even" % var] = index % 2
 277                 d["%s_odd" % var] = (index + 1) % 2
 278                 d["%s_last" % var] = index + 1 == size
 279                 if index % 2:
 280                     d["%s_parity" % var] = 'odd'
 281                 else:
 282                     d["%s_parity" % var] = 'even'
 283                 if 'as' in t_att:
 284                     d[var] = i
 285                 elif isinstance(i, types.DictType):
 286                     d.update(i)
 287                 ru.append(self.render_element(e, t_att, g_att, d))
 288                 index += 1
 289             return "".join(ru)
 290         else:
 291             raise NameError("QWeb: foreach enumerator %r is not defined while rendering template %r" % (expr, v.get('__template__')))
 292
 293     def render_tag_if(self, e, t_att, g_att, v):
 294         if self.eval_bool(t_att["if"], v):
 295             return self.render_element(e, t_att, g_att, v)
 296         else:
 297             return ""
 298
 299     def render_tag_call(self, e, t_att, g_att, v):
 300         if "import" in t_att:
 301             d = v
 302         else:
 303             d = QWebContext(v.copy(), self.undefined_handler)
 304         d[0] = self.render_element(e, t_att, g_att, d)
 305         return self.render(self.eval_format(t_att["call"], d), d)
 306
 307     def render_tag_set(self, e, t_att, g_att, v):
 308         if "value" in t_att:
 309             v[t_att["set"]] = self.eval_object(t_att["value"], v)
 310         elif "valuef" in t_att:
 311             v[t_att["set"]] = self.eval_format(t_att["valuef"], v)
 312         else:
 313             v[t_att["set"]] = self.render_element(e, t_att, g_att, v)
 314         return ""
 315
 316     def render_tag_field(self, e, t_att, g_att, v):
 317         """ eg: <span t-record="browse_record(res.partner, 1)" t-field="phone">+1 555 555 8069</span>"""
 318
 319         record, field = t_att["field"].rsplit('.', 1)
 320         record = self.eval_object(record, v)
 321
 322         inner = None
 323         field_type = record._model._all_columns[field].column._type
 324         try:
 325             if field_type == 'many2one':
 326                 field_data = record.read([field])[0].get(field)
 327                 inner = field_data and field_data[1]
 328             else:
 329                 inner = getattr(record, field)
 330
 331             if isinstance(inner, unicode):
 332                 inner = inner.encode("utf8")
 333
 334             if e.tagName != 't':
 335                 g_att += ''.join(
 336                     ' %s="%s"' % (name, cgi.escape(str(value), True))
 337                     for name, value in [
 338                         ('data-oe-model', record._model._name),
 339                         ('data-oe-id', str(record.id)),
 340                         ('data-oe-field', field),
 341                         ('data-oe-type', field_type),
 342                     ]
 343                 )
 344         except AttributeError:
 345             _logger.warning("t-field no field %s for model %s", field, record._model._name)
 346
 347         return self.render_element(e, t_att, g_att, v, str(inner or ""))
 348
 349 # leave this, al.