openerp/tools/qweb.py

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