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 traceback
   9 from openerp.osv import osv, orm
  10
  11 _logger = logging.getLogger(__name__)
  12
  13 BUILTINS = {
  14     'False': False,
  15     'None': None,
  16     'True': True,
  17     'abs': abs,
  18     'bool': bool,
  19     'dict': dict,
  20     'filter': filter,
  21     'len': len,
  22     'list': list,
  23     'map': map,
  24     'max': max,
  25     'min': min,
  26     'reduce': reduce,
  27     'repr': repr,
  28     'round': round,
  29     'set': set,
  30     'str': str,
  31     'tuple': tuple,
  32 }
  33
  34 class QWebContext(dict):
  35     def __init__(self, data, undefined_handler=None):
  36         self.undefined_handler = undefined_handler
  37         dic = BUILTINS.copy()
  38         dic.update(data)
  39         dict.__init__(self, dic)
  40         self['defined'] = lambda key: key in self
  41
  42     def __getitem__(self, key):
  43         if key in self:
  44             return self.get(key)
  45         elif not self.undefined_handler:
  46             raise NameError("QWeb: name %r is not defined while rendering template %r" % (key, self.get('__template__')))
  47         else:
  48             return self.get(key, self.undefined_handler(key, self))
  49
  50 class QWebXml(object):
  51     """QWeb Xml templating engine
  52
  53     The templating engine use a very simple syntax, "magic" xml attributes, to
  54     produce any kind of texutal output (even non-xml).
  55
  56     QWebXml:
  57         the template engine core implements the basic magic attributes:
  58
  59         t-att t-raw t-esc t-if t-foreach t-set t-call t-trim
  60
  61
  62     - loader: function that return a template
  63
  64
  65     """
  66     def __init__(self, loader=None, undefined_handler=None):
  67         self.loader = loader
  68         self.undefined_handler = undefined_handler
  69         self.node = xml.dom.Node
  70         self._t = {}
  71         self._render_tag = {}
  72         self._format_regex = re.compile('#\{(.*?)\}')
  73         self._void_elements = set(['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen',
  74                                   'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr'])
  75         prefix = 'render_tag_'
  76         for i in [j for j in dir(self) if j.startswith(prefix)]:
  77             name = i[len(prefix):].replace('_', '-')
  78             self._render_tag[name] = getattr(self.__class__, i)
  79
  80         self._render_att = {}
  81         prefix = 'render_att_'
  82         for i in [j for j in dir(self) if j.startswith(prefix)]:
  83             name = i[len(prefix):].replace('_', '-')
  84             self._render_att[name] = getattr(self.__class__, i)
  85
  86     def register_tag(self, tag, func):
  87         self._render_tag[tag] = func
  88
  89     def add_template(self, x):
  90         if hasattr(x, 'documentElement'):
  91             dom = x
  92         elif x.startswith("<?xml"):
  93             dom = xml.dom.minidom.parseString(x)
  94         else:
  95             dom = xml.dom.minidom.parse(x)
  96         for n in dom.documentElement.childNodes:
  97             if n.nodeType == 1 and n.getAttribute('t-name'):
  98                 self._t[str(n.getAttribute("t-name"))] = n
  99
 100     def get_template(self, name):
 101         if name in self._t:
 102             return self._t[name]
 103         elif self.loader:
 104             xml = self.loader(name)
 105             self.add_template(xml)
 106             if name in self._t:
 107                 return self._t[name]
 108         raise KeyError('qweb: template "%s" not found' % name)
 109
 110     def eval(self, expr, v):
 111         try:
 112             return eval(expr, None, v)
 113         except (osv.except_osv, orm.except_orm), err:
 114             raise orm.except_orm("QWeb Error", "Invalid expression %r while rendering template '%s'.\n\n%s" % (expr, v.get('__template__'), err[1]))
 115         except Exception:
 116             raise SyntaxError("QWeb: invalid expression %r while rendering template '%s'.\n\n%s" % (expr, v.get('__template__'), traceback.format_exc()))
 117
 118     def eval_object(self, expr, v):
 119         return self.eval(expr, v)
 120
 121     def eval_str(self, expr, v):
 122         if expr == "0":
 123             return v.get(0, '')
 124         val = self.eval(expr, v)
 125         if isinstance(val, unicode):
 126             return val.encode("utf8")
 127         return str(val)
 128
 129     def eval_format(self, expr, v):
 130         use_native = True
 131         for m in self._format_regex.finditer(expr):
 132             use_native = False
 133             expr = expr.replace(m.group(), self.eval_str(m.groups()[0], v))
 134         if not use_native:
 135             return expr
 136         else:
 137             try:
 138                 return str(expr % v)
 139             except:
 140                 raise Exception("QWeb: format error '%s' " % expr)
 141
 142     def eval_bool(self, expr, v):
 143         val = self.eval(expr, v)
 144         if val:
 145             return 1
 146         else:
 147             return 0
 148
 149     def render(self, tname, v=None, out=None):
 150         if v is None:
 151             v = {}
 152         v['__template__'] = tname
 153         stack = v.get('__stack__', [])
 154         if stack:
 155             v['__caller__'] = stack[-1]
 156         stack.append(tname)
 157         v['__stack__'] = stack
 158         v = QWebContext(v, self.undefined_handler)
 159         return self.render_node(self.get_template(tname), v)
 160
 161     def render_node(self, e, v):
 162         r = ""
 163         if e.nodeType == self.node.TEXT_NODE or e.nodeType == self.node.CDATA_SECTION_NODE:
 164             r = e.data.encode("utf8")
 165         elif e.nodeType == self.node.ELEMENT_NODE:
 166             g_att = ""
 167             t_render = None
 168             t_att = {}
 169             for (an, av) in e.attributes.items():
 170                 an = str(an)
 171                 if isinstance(av, unicode):
 172                     av = av.encode("utf8")
 173                 else:
 174                     av = av.nodeValue.encode("utf8")
 175                 if an.startswith("t-"):
 176                     for i in self._render_att:
 177                         if an[2:].startswith(i):
 178                             g_att += self._render_att[i](self, e, an, av, v)
 179                             break
 180                     else:
 181                         if an[2:] in self._render_tag:
 182                             t_render = an[2:]
 183                         t_att[an[2:]] = av
 184                 else:
 185                     g_att += ' %s="%s"' % (an, cgi.escape(av, 1))
 186
 187             if 'debug' in t_att:
 188                 debugger = t_att.get('debug', 'pdb')
 189                 __import__(debugger).set_trace() # pdb, ipdb, pudb, ...
 190             if t_render:
 191                 if t_render in self._render_tag:
 192                     r = self._render_tag[t_render](self, e, t_att, g_att, v)
 193             else:
 194                 r = self.render_element(e, t_att, g_att, v)
 195         return r
 196
 197     def render_element(self, e, t_att, g_att, v, inner=None):
 198         # e: element
 199         # t_att: t-* attributes
 200         # g_att: generated attributes
 201         # v: values
 202         # inner: optional innerXml
 203         if inner:
 204             g_inner = inner
 205         else:
 206             g_inner = []
 207             for n in e.childNodes:
 208                 g_inner.append(self.render_node(n, v))
 209         name = str(e.nodeName)
 210         inner = "".join(g_inner)
 211         trim = t_att.get("trim", 0)
 212         if trim == 0:
 213             pass
 214         elif trim == 'left':
 215             inner = inner.lstrip()
 216         elif trim == 'right':
 217             inner = inner.rstrip()
 218         elif trim == 'both':
 219             inner = inner.strip()
 220         if name == "t":
 221             return inner
 222         elif len(inner) or name not in self._void_elements:
 223             return "<%s%s>%s</%s>" % (name, g_att, inner, name)
 224         else:
 225             return "<%s%s/>" % (name, g_att)
 226
 227     # Attributes
 228     def render_att_att(self, e, an, av, v):
 229         if an.startswith("t-attf-"):
 230             att, val = an[7:], self.eval_format(av, v)
 231         elif an.startswith("t-att-"):
 232             att, val = an[6:], self.eval(av, v)
 233             if isinstance(val, unicode):
 234                 val = val.encode("utf8")
 235         else:
 236             att, val = self.eval_object(av, v)
 237         return val and ' %s="%s"' % (att, cgi.escape(str(val), 1)) or " "
 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, (list, tuple)):
 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, dict):
 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 = None
 322         field_type = record._model._all_columns[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]
 327             else:
 328                 inner = getattr(record, field)
 329
 330             if isinstance(inner, unicode):
 331                 inner = inner.encode("utf8")
 332
 333             if e.tagName == 't':
 334                 e.tagName = DEFAULT_TAG_BY_TYPE[field_type]
 335
 336             g_att += ''.join(
 337                 ' %s="%s"' % (name, cgi.escape(str(value), True))
 338                 for name, value in [
 339                     ('data-oe-model', record._model._name),
 340                     ('data-oe-id', str(record.id)),
 341                     ('data-oe-field', field),
 342                     ('data-oe-type', field_type),
 343                     ('data-oe-expression', t_att['field']),
 344                 ]
 345             )
 346         except AttributeError:
 347             _logger.warning("t-field no field %s for model %s", field, record._model._name)
 348
 349         return self.render_element(e, t_att, g_att, v, str(inner or ""))
 350
 351 # If a t-field is set on a <t> element, by default only its text will be
 352 # rendered losing the information that it's a tag and completely breaking
 353 # edition => replace <t> by some default tag depending on field type
 354 DEFAULT_TAG_BY_TYPE = {
 355     'integer': 'span',
 356     'float': 'span',
 357     'char': 'span',
 358     'many2one': 'span',
 359 }
 360
 361 # leave this, al.