851 lines
31 KiB
Python
851 lines
31 KiB
Python
# -*- coding: utf-8 -*-
|
|
import collections
|
|
import cStringIO
|
|
import datetime
|
|
import json
|
|
import logging
|
|
import math
|
|
import re
|
|
import xml # FIXME use lxml and etree
|
|
|
|
import babel
|
|
import babel.dates
|
|
import werkzeug.utils
|
|
from PIL import Image
|
|
|
|
import openerp.tools
|
|
from openerp.tools.safe_eval import safe_eval as eval
|
|
from openerp.osv import osv, orm, fields
|
|
from openerp.tools.translate import _
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
class QWebException(Exception):
|
|
def __init__(self, message, template=None, node=None, attribute=None):
|
|
self.message = message
|
|
self.template = template
|
|
self.node = node
|
|
self.attribute = attribute
|
|
|
|
|
|
class QWebContext(dict):
|
|
def __init__(self, cr, uid, data, loader=None, templates=None, context=None):
|
|
self.cr = cr
|
|
self.uid = uid
|
|
self.loader = loader
|
|
self.templates = templates or {}
|
|
self.context = context
|
|
dic = dict(data)
|
|
super(QWebContext, self).__init__(dic)
|
|
self['defined'] = lambda key: key in self
|
|
|
|
def safe_eval(self, expr):
|
|
locals_dict = collections.defaultdict(lambda: None)
|
|
locals_dict.update(self)
|
|
locals_dict.pop('cr', None)
|
|
locals_dict.pop('loader', None)
|
|
return eval(expr, None, locals_dict, nocopy=True, locals_builtins=True)
|
|
|
|
def copy(self):
|
|
return QWebContext(self.cr, self.uid, dict.copy(self),
|
|
loader=self.loader,
|
|
templates=self.templates,
|
|
context=self.context)
|
|
|
|
def __copy__(self):
|
|
return self.copy()
|
|
|
|
class QWeb(orm.AbstractModel):
|
|
"""QWeb Xml templating engine
|
|
|
|
The templating engine use a very simple syntax, "magic" xml attributes, to
|
|
produce any kind of texutal output (even non-xml).
|
|
|
|
QWebXml:
|
|
the template engine core implements the basic magic attributes:
|
|
|
|
t-att t-raw t-esc t-if t-foreach t-set t-call t-trim
|
|
|
|
|
|
- loader: function that return a template
|
|
|
|
QWeb rendering can be used for many tasks. As a result, customizations
|
|
made by one task context (to either the main qweb rendering or to specific
|
|
fields rendering) could break other tasks.
|
|
|
|
To avoid that, ``ir.qweb`` was consciously made inheritable and the "root"
|
|
of an object hierarchy. If you need extensions or alterations which could
|
|
be incompatible with other subsystems, you should create a local object
|
|
inheriting from ``ir.qweb`` and customize that.
|
|
|
|
If you need to customize t-fields rendering, subclass the ir.qweb.field
|
|
model (and its sub-models) then override :meth:`~.get_converter_for` to
|
|
fetch the right field converters for your qweb model.
|
|
"""
|
|
|
|
_name = 'ir.qweb'
|
|
|
|
node = xml.dom.Node
|
|
_void_elements = frozenset([
|
|
'area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen',
|
|
'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr'])
|
|
_format_regex = re.compile(
|
|
'(?:'
|
|
# ruby-style pattern
|
|
'#\{(.+?)\}'
|
|
')|(?:'
|
|
# jinja-style pattern
|
|
'\{\{(.+?)\}\}'
|
|
')')
|
|
|
|
def __init__(self, pool, cr):
|
|
super(QWeb, self).__init__(pool, cr)
|
|
|
|
self._render_tag = self.prefixed_methods('render_tag_')
|
|
self._render_att = self.prefixed_methods('render_att_')
|
|
|
|
def prefixed_methods(self, prefix):
|
|
""" Extracts all methods prefixed by ``prefix``, and returns a mapping
|
|
of (t-name, method) where the t-name is the method name with prefix
|
|
removed and underscore converted to dashes
|
|
|
|
:param str prefix:
|
|
:return: dict
|
|
"""
|
|
return dict(
|
|
(name[len(prefix):].replace('_', '-'), getattr(type(self), name))
|
|
for name in dir(self)
|
|
if name.startswith(prefix))
|
|
|
|
def register_tag(self, tag, func):
|
|
self._render_tag[tag] = func
|
|
|
|
def load_document(self, x, into, context):
|
|
"""
|
|
Loads an XML document and installs any contained template in the engine
|
|
"""
|
|
if hasattr(x, 'documentElement'):
|
|
dom = x
|
|
elif x.startswith("<?xml"):
|
|
dom = xml.dom.minidom.parseString(x)
|
|
else:
|
|
dom = xml.dom.minidom.parse(x)
|
|
|
|
for n in dom.documentElement.childNodes:
|
|
if n.nodeType == self.node.ELEMENT_NODE and n.getAttribute('t-name'):
|
|
self.add_template(into, str(n.getAttribute("t-name")), n, context)
|
|
|
|
def add_template(self, into, name, node, context):
|
|
into[name] = node
|
|
|
|
def get_template(self, name, context):
|
|
if context.loader and name not in context.templates:
|
|
xml_doc = context.loader(name)
|
|
self.load_document(xml_doc, into=context.templates, context=context)
|
|
|
|
if name in context.templates:
|
|
return context.templates[name]
|
|
|
|
e = KeyError('qweb: template "%s" not found' % name)
|
|
setattr(e, 'qweb_template', name)
|
|
raise e
|
|
|
|
def eval(self, expr, v):
|
|
try:
|
|
return v.safe_eval(expr)
|
|
except Exception, e:
|
|
# add qweb metdata on exception
|
|
setattr(e, 'qweb_eval', expr)
|
|
setattr(e, 'qweb_template', v.get('__template__'))
|
|
raise
|
|
|
|
def eval_object(self, expr, v):
|
|
return self.eval(expr, v)
|
|
|
|
def eval_str(self, expr, v):
|
|
if expr == "0":
|
|
return v.get(0, '')
|
|
val = self.eval(expr, v)
|
|
if isinstance(val, unicode):
|
|
return val.encode("utf8")
|
|
return str(val)
|
|
|
|
def eval_format(self, expr, v):
|
|
expr, replacements = self._format_regex.subn(
|
|
lambda m: self.eval_str(m.group(1) or m.group(2), v),
|
|
expr)
|
|
|
|
if replacements:
|
|
return expr
|
|
|
|
try:
|
|
return str(expr % v)
|
|
except:
|
|
raise Exception("QWeb: format error '%s' " % expr)
|
|
|
|
def eval_bool(self, expr, v):
|
|
val = self.eval(expr, v)
|
|
if val:
|
|
return 1
|
|
else:
|
|
return 0
|
|
|
|
@openerp.tools.ormcache()
|
|
def get_template_xmlid(self, cr, uid, id):
|
|
imd = self.pool['ir.model.data']
|
|
domain = [('model', '=', 'ir.ui.view'), ('res_id', '=', id)]
|
|
xmlid = imd.search_read(cr, uid, domain, ['module', 'name'])[0]
|
|
return '%s.%s' % (xmlid['module'], xmlid['name'])
|
|
|
|
def render(self, cr, uid, id_or_xml_id, v=None, loader=None, context=None):
|
|
if isinstance(id_or_xml_id, list):
|
|
id_or_xml_id = id_or_xml_id[0]
|
|
tname = id_or_xml_id
|
|
if isinstance(id_or_xml_id, (int, long)):
|
|
tname = self.get_template_xmlid(cr, uid, tname)
|
|
|
|
if v is None:
|
|
v = {}
|
|
if not isinstance(v, QWebContext):
|
|
v = QWebContext(cr, uid, v, loader=loader, context=context)
|
|
v['__template__'] = tname
|
|
stack = v.get('__stack__', [])
|
|
if stack:
|
|
v['__caller__'] = stack[-1]
|
|
stack.append(tname)
|
|
v['__stack__'] = stack
|
|
v['xmlid'] = str(stack[0]) # Temporary fix
|
|
return self.render_node(self.get_template(tname, v), v)
|
|
|
|
def render_node(self, e, v):
|
|
r = ""
|
|
if e.nodeType == self.node.TEXT_NODE or e.nodeType == self.node.CDATA_SECTION_NODE:
|
|
r = e.data.encode("utf8")
|
|
elif e.nodeType == self.node.ELEMENT_NODE:
|
|
g_att = ""
|
|
t_render = None
|
|
t_att = {}
|
|
for (an, av) in e.attributes.items():
|
|
an = str(an)
|
|
if an == "groups":
|
|
can_see = self.user_has_groups(v['request'].cr, v['uid'], groups=av)
|
|
if not can_see:
|
|
return ''
|
|
continue
|
|
if isinstance(av, unicode):
|
|
av = av.encode("utf8")
|
|
else:
|
|
av = av.nodeValue.encode("utf8")
|
|
if an.startswith("t-"):
|
|
for i in self._render_att:
|
|
if an[2:].startswith(i):
|
|
g_att += self._render_att[i](self, e, an, av, v)
|
|
break
|
|
else:
|
|
if an[2:] in self._render_tag:
|
|
t_render = an[2:]
|
|
t_att[an[2:]] = av
|
|
else:
|
|
g_att += ' %s="%s"' % (an, werkzeug.utils.escape(av))
|
|
|
|
if 'debug' in t_att:
|
|
debugger = t_att.get('debug', 'pdb')
|
|
__import__(debugger).set_trace() # pdb, ipdb, pudb, ...
|
|
if t_render:
|
|
r = self._render_tag[t_render](self, e, t_att, g_att, v)
|
|
else:
|
|
r = self.render_element(e, t_att, g_att, v)
|
|
if isinstance(r, unicode):
|
|
return r.encode('utf-8')
|
|
return r
|
|
|
|
def render_element(self, e, t_att, g_att, v, inner=None):
|
|
# e: element
|
|
# t_att: t-* attributes
|
|
# g_att: generated attributes
|
|
# v: values
|
|
# inner: optional innerXml
|
|
if inner:
|
|
g_inner = inner
|
|
else:
|
|
g_inner = []
|
|
for n in e.childNodes:
|
|
try:
|
|
g_inner.append(self.render_node(n, v))
|
|
except Exception, ex:
|
|
# add qweb metdata on exception
|
|
if not getattr(ex, 'qweb_template', None):
|
|
setattr(e, 'qweb_template', v.get('__template__'))
|
|
if not getattr(ex, 'qweb_node', None):
|
|
setattr(ex, 'qweb_node', e)
|
|
raise
|
|
name = str(e.nodeName)
|
|
inner = "".join(g_inner)
|
|
trim = t_att.get("trim", 0)
|
|
if trim == 0:
|
|
pass
|
|
elif trim == 'left':
|
|
inner = inner.lstrip()
|
|
elif trim == 'right':
|
|
inner = inner.rstrip()
|
|
elif trim == 'both':
|
|
inner = inner.strip()
|
|
if name == "t":
|
|
return inner
|
|
elif len(inner) or name not in self._void_elements:
|
|
return "<%s%s>%s</%s>" % tuple(
|
|
v if isinstance(v, str) else v.encode('utf-8')
|
|
for v in (name, g_att, inner, name))
|
|
else:
|
|
return "<%s%s/>" % (name, g_att)
|
|
|
|
# Attributes
|
|
def render_att_att(self, e, an, av, v):
|
|
if an.startswith("t-attf-"):
|
|
att, val = an[7:], self.eval_format(av, v)
|
|
elif an.startswith("t-att-"):
|
|
att, val = an[6:], self.eval(av, v)
|
|
if isinstance(val, unicode):
|
|
val = val.encode("utf8")
|
|
else:
|
|
att, val = self.eval_object(av, v)
|
|
return val and ' %s="%s"' % (att, werkzeug.utils.escape(val)) or " "
|
|
|
|
def render_att_href(self, e, an, av, v):
|
|
return self.url_for(e, an, av, v)
|
|
def render_att_src(self, e, an, av, v):
|
|
return self.url_for(e, an, av, v)
|
|
def render_att_action(self, e, an, av, v):
|
|
return self.url_for(e, an, av, v)
|
|
def url_for(self, e, an, av, v):
|
|
if 'url_for' not in v:
|
|
raise KeyError("qweb: no 'url_for' found in context")
|
|
# Temporary implementation of t-keep-query until qweb py v2
|
|
keep_query = e.attributes.get('t-keep-query')
|
|
if keep_query:
|
|
params = self.eval_format(keep_query.value, v)
|
|
keep_query = [q.strip() for q in params.split(',')]
|
|
path = str(v['url_for'](self.eval_format(av, v), keep_query=keep_query))
|
|
return ' %s="%s"' % (an[2:], werkzeug.utils.escape(path))
|
|
|
|
# Tags
|
|
def render_tag_raw(self, e, t_att, g_att, v):
|
|
inner = self.eval_str(t_att["raw"], v)
|
|
return self.render_element(e, t_att, g_att, v, inner)
|
|
|
|
def render_tag_esc(self, e, t_att, g_att, v):
|
|
inner = werkzeug.utils.escape(self.eval_str(t_att["esc"], v))
|
|
return self.render_element(e, t_att, g_att, v, inner)
|
|
|
|
def render_tag_foreach(self, e, t_att, g_att, v):
|
|
expr = t_att["foreach"]
|
|
enum = self.eval_object(expr, v)
|
|
if enum is not None:
|
|
var = t_att.get('as', expr).replace('.', '_')
|
|
d = v.copy()
|
|
size = -1
|
|
if isinstance(enum, (list, tuple)):
|
|
size = len(enum)
|
|
elif hasattr(enum, 'count'):
|
|
size = enum.count()
|
|
d["%s_size" % var] = size
|
|
d["%s_all" % var] = enum
|
|
index = 0
|
|
ru = []
|
|
for i in enum:
|
|
d["%s_value" % var] = i
|
|
d["%s_index" % var] = index
|
|
d["%s_first" % var] = index == 0
|
|
d["%s_even" % var] = index % 2
|
|
d["%s_odd" % var] = (index + 1) % 2
|
|
d["%s_last" % var] = index + 1 == size
|
|
if index % 2:
|
|
d["%s_parity" % var] = 'odd'
|
|
else:
|
|
d["%s_parity" % var] = 'even'
|
|
if 'as' in t_att:
|
|
d[var] = i
|
|
elif isinstance(i, dict):
|
|
d.update(i)
|
|
ru.append(self.render_element(e, t_att, g_att, d))
|
|
index += 1
|
|
return "".join(ru)
|
|
else:
|
|
template = v.get('__template__')
|
|
e = NameError("QWeb: foreach enumerator %r is not defined while rendering template %r" % (expr, template))
|
|
e.qweb_template = template
|
|
raise e
|
|
|
|
def render_tag_if(self, e, t_att, g_att, v):
|
|
if self.eval_bool(t_att["if"], v):
|
|
return self.render_element(e, t_att, g_att, v)
|
|
else:
|
|
return ""
|
|
|
|
def render_tag_call(self, e, t_att, g_att, v):
|
|
d = v if 'import' in t_att else v.copy()
|
|
d[0] = self.render_element(e, t_att, g_att, d)
|
|
|
|
return self.render(None, None, self.eval_format(t_att["call"], d), d)
|
|
|
|
def render_tag_set(self, e, t_att, g_att, v):
|
|
if "value" in t_att:
|
|
v[t_att["set"]] = self.eval_object(t_att["value"], v)
|
|
elif "valuef" in t_att:
|
|
v[t_att["set"]] = self.eval_format(t_att["valuef"], v)
|
|
else:
|
|
v[t_att["set"]] = self.render_element(e, t_att, g_att, v)
|
|
return ""
|
|
|
|
def render_tag_field(self, e, t_att, g_att, v):
|
|
""" eg: <span t-record="browse_record(res.partner, 1)" t-field="phone">+1 555 555 8069</span>"""
|
|
node_name = e.nodeName
|
|
assert node_name not in ("table", "tbody", "thead", "tfoot", "tr", "td",
|
|
"li", "ul", "ol", "dl", "dt", "dd"),\
|
|
"RTE widgets do not work correctly on %r elements" % node_name
|
|
assert node_name != 't',\
|
|
"t-field can not be used on a t element, provide an actual HTML node"
|
|
|
|
record, field_name = t_att["field"].rsplit('.', 1)
|
|
record = self.eval_object(record, v)
|
|
|
|
column = record._model._all_columns[field_name].column
|
|
options = json.loads(t_att.get('field-options') or '{}')
|
|
field_type = get_field_type(column, options)
|
|
|
|
converter = self.get_converter_for(field_type)
|
|
|
|
return converter.to_html(v.cr, v.uid, field_name, record, options,
|
|
e, t_att, g_att, v, context=v.context)
|
|
|
|
def get_converter_for(self, field_type):
|
|
return self.pool.get('ir.qweb.field.' + field_type,
|
|
self.pool['ir.qweb.field'])
|
|
|
|
|
|
class FieldConverter(osv.AbstractModel):
|
|
""" Used to convert a t-field specification into an output HTML field.
|
|
|
|
:meth:`~.to_html` is the entry point of this conversion from QWeb, it:
|
|
|
|
* converts the record value to html using :meth:`~.record_to_html`
|
|
* generates the metadata attributes (``data-oe-``) to set on the root
|
|
result node
|
|
* generates the root result node itself through :meth:`~.render_element`
|
|
"""
|
|
_name = 'ir.qweb.field'
|
|
|
|
def attributes(self, cr, uid, field_name, record, options,
|
|
source_element, g_att, t_att, qweb_context,
|
|
context=None):
|
|
"""
|
|
Generates the metadata attributes (prefixed by ``data-oe-`` for the
|
|
root node of the field conversion. Attribute values are escaped by the
|
|
parent using ``werkzeug.utils.escape``.
|
|
|
|
The default attributes are:
|
|
|
|
* ``model``, the name of the record's model
|
|
* ``id`` the id of the record to which the field belongs
|
|
* ``field`` the name of the converted field
|
|
* ``type`` the logical field type (widget, may not match the column's
|
|
``type``, may not be any _column subclass name)
|
|
* ``translate``, a boolean flag (``0`` or ``1``) denoting whether the
|
|
column is translatable
|
|
* ``expression``, the original expression
|
|
|
|
:returns: iterable of (attribute name, attribute value) pairs.
|
|
"""
|
|
column = record._model._all_columns[field_name].column
|
|
field_type = get_field_type(column, options)
|
|
return [
|
|
('data-oe-model', record._model._name),
|
|
('data-oe-id', record.id),
|
|
('data-oe-field', field_name),
|
|
('data-oe-type', field_type),
|
|
('data-oe-expression', t_att['field']),
|
|
]
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
""" Converts a single value to its HTML version/output
|
|
"""
|
|
if not value: return ''
|
|
return value
|
|
|
|
def record_to_html(self, cr, uid, field_name, record, column, options=None, context=None):
|
|
""" Converts the specified field of the browse_record ``record`` to
|
|
HTML
|
|
"""
|
|
return self.value_to_html(
|
|
cr, uid, record[field_name], column, options=options, context=context)
|
|
|
|
def to_html(self, cr, uid, field_name, record, options,
|
|
source_element, t_att, g_att, qweb_context, context=None):
|
|
""" Converts a ``t-field`` to its HTML output. A ``t-field`` may be
|
|
extended by a ``t-field-options``, which is a JSON-serialized mapping
|
|
of configuration values.
|
|
|
|
A default configuration key is ``widget`` which can override the
|
|
field's own ``_type``.
|
|
"""
|
|
content = None
|
|
try:
|
|
content = self.record_to_html(
|
|
cr, uid, field_name, record,
|
|
record._model._all_columns[field_name].column,
|
|
options, context=context)
|
|
if options.get('html-escape', True):
|
|
content = werkzeug.utils.escape(content)
|
|
elif hasattr(content, '__html__'):
|
|
content = content.__html__()
|
|
except Exception:
|
|
_logger.warning("Could not get field %s for model %s",
|
|
field_name, record._model._name, exc_info=True)
|
|
|
|
g_att += ''.join(
|
|
' %s="%s"' % (name, werkzeug.utils.escape(value))
|
|
for name, value in self.attributes(
|
|
cr, uid, field_name, record, options,
|
|
source_element, g_att, t_att, qweb_context)
|
|
)
|
|
|
|
return self.render_element(cr, uid, source_element, t_att, g_att,
|
|
qweb_context, content)
|
|
|
|
def qweb_object(self):
|
|
return self.pool['ir.qweb']
|
|
|
|
def render_element(self, cr, uid, source_element, t_att, g_att,
|
|
qweb_context, content):
|
|
""" Final rendering hook, by default just calls ir.qweb's ``render_element``
|
|
"""
|
|
return self.qweb_object().render_element(
|
|
source_element, t_att, g_att, qweb_context, content or '')
|
|
|
|
def user_lang(self, cr, uid, context):
|
|
"""
|
|
Fetches the res.lang object corresponding to the language code stored
|
|
in the user's context. Fallbacks to en_US if no lang is present in the
|
|
context *or the language code is not valid*.
|
|
|
|
:returns: res.lang browse_record
|
|
"""
|
|
if context is None: context = {}
|
|
|
|
lang_code = context.get('lang') or 'en_US'
|
|
Lang = self.pool['res.lang']
|
|
|
|
lang_ids = Lang.search(cr, uid, [('code', '=', lang_code)], context=context) \
|
|
or Lang.search(cr, uid, [('code', '=', 'en_US')], context=context)
|
|
|
|
return Lang.browse(cr, uid, lang_ids[0], context=context)
|
|
|
|
class FloatConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.float'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def precision(self, cr, uid, column, options=None, context=None):
|
|
_, precision = column.digits or (None, None)
|
|
return precision
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
if context is None:
|
|
context = {}
|
|
precision = self.precision(cr, uid, column, options=options, context=context)
|
|
fmt = '%f' if precision is None else '%.{precision}f'
|
|
|
|
lang_code = context.get('lang') or 'en_US'
|
|
lang = self.pool['res.lang']
|
|
formatted = lang.format(cr, uid, [lang_code], fmt.format(precision=precision), value, grouping=True)
|
|
|
|
# %f does not strip trailing zeroes. %g does but its precision causes
|
|
# it to switch to scientific notation starting at a million *and* to
|
|
# strip decimals. So use %f and if no precision was specified manually
|
|
# strip trailing 0.
|
|
if not precision:
|
|
formatted = re.sub(r'(?:(0|\d+?)0+)$', r'\1', formatted)
|
|
return formatted
|
|
|
|
class DateConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.date'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
if not value: return ''
|
|
lang = self.user_lang(cr, uid, context=context)
|
|
locale = babel.Locale.parse(lang.code)
|
|
|
|
if isinstance(value, basestring):
|
|
value = datetime.datetime.strptime(
|
|
value, openerp.tools.DEFAULT_SERVER_DATE_FORMAT)
|
|
|
|
if options and 'format' in options:
|
|
pattern = options['format']
|
|
else:
|
|
strftime_pattern = lang.date_format
|
|
pattern = openerp.tools.posix_to_ldml(strftime_pattern, locale=locale)
|
|
|
|
return babel.dates.format_datetime(
|
|
value, format=pattern,
|
|
locale=locale)
|
|
|
|
class DateTimeConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.datetime'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
if not value: return ''
|
|
lang = self.user_lang(cr, uid, context=context)
|
|
locale = babel.Locale.parse(lang.code)
|
|
|
|
if isinstance(value, basestring):
|
|
value = datetime.datetime.strptime(
|
|
value, openerp.tools.DEFAULT_SERVER_DATETIME_FORMAT)
|
|
value = column.context_timestamp(
|
|
cr, uid, timestamp=value, context=context)
|
|
|
|
if options and 'format' in options:
|
|
pattern = options['format']
|
|
else:
|
|
strftime_pattern = (u"%s %s" % (lang.date_format, lang.time_format))
|
|
pattern = openerp.tools.posix_to_ldml(strftime_pattern, locale=locale)
|
|
|
|
return babel.dates.format_datetime(value, format=pattern, locale=locale)
|
|
|
|
class TextConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.text'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
"""
|
|
Escapes the value and converts newlines to br. This is bullshit.
|
|
"""
|
|
if not value: return ''
|
|
|
|
return nl2br(value, options=options)
|
|
|
|
class SelectionConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.selection'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def record_to_html(self, cr, uid, field_name, record, column, options=None, context=None):
|
|
value = record[field_name]
|
|
if not value: return ''
|
|
selection = dict(fields.selection.reify(
|
|
cr, uid, record._model, column))
|
|
return self.value_to_html(
|
|
cr, uid, selection[value], column, options=options)
|
|
|
|
class ManyToOneConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.many2one'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def record_to_html(self, cr, uid, field_name, record, column, options=None, context=None):
|
|
[read] = record.read([field_name])
|
|
_, value = read[field_name]
|
|
|
|
return nl2br(value, options=options)
|
|
|
|
class HTMLConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.html'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
return HTMLSafe(value or '')
|
|
|
|
class ImageConverter(osv.AbstractModel):
|
|
""" ``image`` widget rendering, inserts a data:uri-using image tag in the
|
|
document. May be overridden by e.g. the website module to generate links
|
|
instead.
|
|
|
|
.. todo:: what happens if different output need different converters? e.g.
|
|
reports may need embedded images or FS links whereas website
|
|
needs website-aware
|
|
"""
|
|
_name = 'ir.qweb.field.image'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
try:
|
|
image = Image.open(cStringIO.StringIO(value.decode('base64')))
|
|
image.verify()
|
|
except IOError:
|
|
raise ValueError("Non-image binary fields can not be converted to HTML")
|
|
except: # image.verify() throws "suitable exceptions", I have no idea what they are
|
|
raise ValueError("Invalid image content")
|
|
|
|
return HTMLSafe('<img src="data:%s;base64,%s">' % (Image.MIME[image.format], value))
|
|
|
|
class MonetaryConverter(osv.AbstractModel):
|
|
""" ``monetary`` converter, has a mandatory option
|
|
``display_currency``.
|
|
|
|
The currency is used for formatting *and rounding* of the float value. It
|
|
is assumed that the linked res_currency has a non-empty rounding value and
|
|
res.currency's ``round`` method is used to perform rounding.
|
|
|
|
.. note:: the monetary converter internally adds the qweb context to its
|
|
options mapping, so that the context is available to callees.
|
|
It's set under the ``_qweb_context`` key.
|
|
"""
|
|
_name = 'ir.qweb.field.monetary'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def to_html(self, cr, uid, field_name, record, options,
|
|
source_element, t_att, g_att, qweb_context, context=None):
|
|
options['_qweb_context'] = qweb_context
|
|
return super(MonetaryConverter, self).to_html(
|
|
cr, uid, field_name, record, options,
|
|
source_element, t_att, g_att, qweb_context, context=context)
|
|
|
|
def record_to_html(self, cr, uid, field_name, record, column, options, context=None):
|
|
if context is None:
|
|
context = {}
|
|
Currency = self.pool['res.currency']
|
|
display = self.display_currency(cr, uid, options)
|
|
|
|
# lang.format mandates a sprintf-style format. These formats are non-
|
|
# minimal (they have a default fixed precision instead), and
|
|
# lang.format will not set one by default. currency.round will not
|
|
# provide one either. So we need to generate a precision value
|
|
# (integer > 0) from the currency's rounding (a float generally < 1.0).
|
|
#
|
|
# The log10 of the rounding should be the number of digits involved if
|
|
# negative, if positive clamp to 0 digits and call it a day.
|
|
# nb: int() ~ floor(), we want nearest rounding instead
|
|
precision = int(round(math.log10(display.rounding)))
|
|
fmt = "%.{0}f".format(-precision if precision < 0 else 0)
|
|
|
|
lang_code = context.get('lang') or 'en_US'
|
|
lang = self.pool['res.lang']
|
|
formatted_amount = lang.format(cr, uid, [lang_code],
|
|
fmt, Currency.round(cr, uid, display, record[field_name]),
|
|
grouping=True, monetary=True)
|
|
|
|
pre = post = u''
|
|
if display.position == 'before':
|
|
pre = u'{symbol} '
|
|
else:
|
|
post = u' {symbol}'
|
|
|
|
return HTMLSafe(u'{pre}<span class="oe_currency_value">{0}</span>{post}'.format(
|
|
formatted_amount,
|
|
pre=pre, post=post,
|
|
).format(
|
|
symbol=display.symbol,
|
|
))
|
|
|
|
def display_currency(self, cr, uid, options):
|
|
return self.qweb_object().eval_object(
|
|
options['display_currency'], options['_qweb_context'])
|
|
|
|
TIMEDELTA_UNITS = (
|
|
('year', 3600 * 24 * 365),
|
|
('month', 3600 * 24 * 30),
|
|
('week', 3600 * 24 * 7),
|
|
('day', 3600 * 24),
|
|
('hour', 3600),
|
|
('minute', 60),
|
|
('second', 1)
|
|
)
|
|
class DurationConverter(osv.AbstractModel):
|
|
""" ``duration`` converter, to display integral or fractional values as
|
|
human-readable time spans (e.g. 1.5 as "1 hour 30 minutes").
|
|
|
|
Can be used on any numerical field.
|
|
|
|
Has a mandatory option ``unit`` which can be one of ``second``, ``minute``,
|
|
``hour``, ``day``, ``week`` or ``year``, used to interpret the numerical
|
|
field value before converting it.
|
|
|
|
Sub-second values will be ignored.
|
|
"""
|
|
_name = 'ir.qweb.field.duration'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
units = dict(TIMEDELTA_UNITS)
|
|
if value < 0:
|
|
raise ValueError(_("Durations can't be negative"))
|
|
if not options or options.get('unit') not in units:
|
|
raise ValueError(_("A unit must be provided to duration widgets"))
|
|
|
|
locale = babel.Locale.parse(
|
|
self.user_lang(cr, uid, context=context).code)
|
|
factor = units[options['unit']]
|
|
|
|
sections = []
|
|
r = value * factor
|
|
for unit, secs_per_unit in TIMEDELTA_UNITS:
|
|
v, r = divmod(r, secs_per_unit)
|
|
if not v: continue
|
|
section = babel.dates.format_timedelta(
|
|
v*secs_per_unit, threshold=1, locale=locale)
|
|
if section:
|
|
sections.append(section)
|
|
return u' '.join(sections)
|
|
|
|
class RelativeDatetimeConverter(osv.AbstractModel):
|
|
_name = 'ir.qweb.field.relative'
|
|
_inherit = 'ir.qweb.field'
|
|
|
|
def value_to_html(self, cr, uid, value, column, options=None, context=None):
|
|
parse_format = openerp.tools.DEFAULT_SERVER_DATETIME_FORMAT
|
|
locale = babel.Locale.parse(
|
|
self.user_lang(cr, uid, context=context).code)
|
|
|
|
if isinstance(value, basestring):
|
|
value = datetime.datetime.strptime(value, parse_format)
|
|
|
|
# value should be a naive datetime in UTC. So is fields.datetime.now()
|
|
reference = datetime.datetime.strptime(column.now(), parse_format)
|
|
|
|
return babel.dates.format_timedelta(
|
|
value - reference, add_direction=True, locale=locale)
|
|
|
|
class HTMLSafe(object):
|
|
""" HTMLSafe string wrapper, Werkzeug's escape() has special handling for
|
|
objects with a ``__html__`` methods but AFAIK does not provide any such
|
|
object.
|
|
|
|
Wrapping a string in HTML will prevent its escaping
|
|
"""
|
|
__slots__ = ['string']
|
|
def __init__(self, string):
|
|
self.string = string
|
|
def __html__(self):
|
|
return self.string
|
|
def __str__(self):
|
|
s = self.string
|
|
if isinstance(s, unicode):
|
|
return s.encode('utf-8')
|
|
return s
|
|
def __unicode__(self):
|
|
s = self.string
|
|
if isinstance(s, str):
|
|
return s.decode('utf-8')
|
|
return s
|
|
|
|
def nl2br(string, options=None):
|
|
""" Converts newlines to HTML linebreaks in ``string``. Automatically
|
|
escapes content unless options['html-escape'] is set to False, and returns
|
|
the result wrapped in an HTMLSafe object.
|
|
|
|
:param str string:
|
|
:param dict options:
|
|
:rtype: HTMLSafe
|
|
"""
|
|
if options is None: options = {}
|
|
|
|
if options.get('html-escape', True):
|
|
string = werkzeug.utils.escape(string)
|
|
return HTMLSafe(string.replace('\n', '<br>\n'))
|
|
|
|
def get_field_type(column, options):
|
|
""" Gets a t-field's effective type from the field's column and its options
|
|
"""
|
|
return options.get('widget', column._type)
|
|
|
|
# vim:et:
|