addons/website/models/ir_ui_view.py

   1 # -*- coding: utf-8 -*-
   2 import copy
   3
   4 from lxml import etree, html
   5
   6 from openerp import SUPERUSER_ID
   7 from openerp.addons.website.models import website
   8 from openerp.http import request
   9 from openerp.osv import osv, fields
  10
  11 class view(osv.osv):
  12     _inherit = "ir.ui.view"
  13     _columns = {
  14         'page': fields.boolean("Whether this view is a web page template (complete)"),
  15         'website_meta_title': fields.char("Website meta title", size=70, translate=True),
  16         'website_meta_description': fields.text("Website meta description", size=160, translate=True),
  17         'website_meta_keywords': fields.char("Website meta keywords", translate=True),
  18         'customize_show': fields.boolean("Show As Optional Inherit"),
  19     }
  20     _defaults = {
  21         'page': False,
  22         'customize_show': False,
  23     }
  24
  25
  26     def _view_obj(self, cr, uid, view_id, context=None):
  27         if isinstance(view_id, basestring):
  28             return self.pool['ir.model.data'].xmlid_to_object(
  29                 cr, uid, view_id, raise_if_not_found=True, context=context
  30             )
  31         elif isinstance(view_id, (int, long)):
  32             return self.browse(cr, uid, view_id, context=context)
  33
  34         # assume it's already a view object (WTF?)
  35         return view_id
  36
  37     # Returns all views (called and inherited) related to a view
  38     # Used by translation mechanism, SEO and optional templates
  39     def _views_get(self, cr, uid, view_id, options=True, context=None, root=True):
  40         """ For a given view ``view_id``, should return:
  41
  42         * the view itself
  43         * all views inheriting from it, enabled or not
  44           - but not the optional children of a non-enabled child
  45         * all views called from it (via t-call)
  46         """
  47         try:
  48             view = self._view_obj(cr, uid, view_id, context=context)
  49         except ValueError:
  50             # Shall we log that ?
  51             return []
  52
  53         while root and view.inherit_id:
  54             view = view.inherit_id
  55
  56         result = [view]
  57
  58         node = etree.fromstring(view.arch)
  59         for child in node.xpath("//t[@t-call]"):
  60             try:
  61                 called_view = self._view_obj(cr, uid, child.get('t-call'), context=context)
  62             except ValueError:
  63                 continue
  64             if called_view not in result:
  65                 result += self._views_get(cr, uid, called_view, options=options, context=context)
  66
  67         extensions = view.inherit_children_ids
  68         if not options:
  69             # only active children
  70             extensions = (v for v in view.inherit_children_ids if v.active)
  71
  72         # Keep options in a deterministic order regardless of their applicability
  73         for extension in sorted(extensions, key=lambda v: v.id):
  74             for r in self._views_get(
  75                     cr, uid, extension,
  76                     # only return optional grandchildren if this child is enabled
  77                     options=extension.active,
  78                     context=context, root=False):
  79                 if r not in result:
  80                     result.append(r)
  81         return result
  82
  83     def extract_embedded_fields(self, cr, uid, arch, context=None):
  84         return arch.xpath('//*[@data-oe-model != "ir.ui.view"]')
  85
  86     def save_embedded_field(self, cr, uid, el, context=None):
  87         Model = self.pool[el.get('data-oe-model')]
  88         field = el.get('data-oe-field')
  89
  90         column = Model._all_columns[field].column
  91         converter = self.pool['website.qweb'].get_converter_for(
  92             el.get('data-oe-type'))
  93         value = converter.from_html(cr, uid, Model, column, el)
  94
  95         if value is not None:
  96             # TODO: batch writes?
  97             Model.write(cr, uid, [int(el.get('data-oe-id'))], {
  98                 field: value
  99             }, context=context)
 100
 101     def to_field_ref(self, cr, uid, el, context=None):
 102         # filter out meta-information inserted in the document
 103         attributes = dict((k, v) for k, v in el.items()
 104                           if not k.startswith('data-oe-'))
 105         attributes['t-field'] = el.get('data-oe-expression')
 106
 107         out = html.html_parser.makeelement(el.tag, attrib=attributes)
 108         out.tail = el.tail
 109         return out
 110
 111     def replace_arch_section(self, cr, uid, view_id, section_xpath, replacement, context=None):
 112         # the root of the arch section shouldn't actually be replaced as it's
 113         # not really editable itself, only the content truly is editable.
 114
 115         [view] = self.browse(cr, uid, [view_id], context=context)
 116         arch = etree.fromstring(view.arch.encode('utf-8'))
 117         # => get the replacement root
 118         if not section_xpath:
 119             root = arch
 120         else:
 121             # ensure there's only one match
 122             [root] = arch.xpath(section_xpath)
 123
 124         root.text = replacement.text
 125         root.tail = replacement.tail
 126         # replace all children
 127         del root[:]
 128         for child in replacement:
 129             root.append(copy.deepcopy(child))
 130
 131         return arch
 132
 133     def render(self, cr, uid, id_or_xml_id, values=None, engine='ir.qweb', context=None):
 134         if request and getattr(request, 'website_enabled', False):
 135             engine='website.qweb'
 136
 137             if isinstance(id_or_xml_id, list):
 138                 id_or_xml_id = id_or_xml_id[0]
 139
 140             if not context:
 141                 context = {}
 142
 143             company = self.pool['res.company'].browse(cr, SUPERUSER_ID, request.website.company_id.id, context=context)
 144
 145             qcontext = dict(
 146                 context.copy(),
 147                 website=request.website,
 148                 url_for=website.url_for,
 149                 slug=website.slug,
 150                 res_company=company,
 151                 user_id=self.pool.get("res.users").browse(cr, uid, uid),
 152                 translatable=context.get('lang') != request.website.default_lang_code,
 153                 editable=request.website.is_publisher(),
 154                 menu_data=self.pool['ir.ui.menu'].load_menus_root(cr, uid, context=context) if request.website.is_user() else None,
 155             )
 156
 157             # add some values
 158             if values:
 159                 qcontext.update(values)
 160
 161             # in edit mode ir.ui.view will tag nodes
 162             context = dict(context, inherit_branding=qcontext.get('editable', False))
 163
 164             view_obj = request.website.get_template(id_or_xml_id)
 165             if 'main_object' not in qcontext:
 166                 qcontext['main_object'] = view_obj
 167
 168             values = qcontext
 169
 170         return super(view, self).render(cr, uid, id_or_xml_id, values=values, engine=engine, context=context)
 171
 172     def _pretty_arch(self, arch):
 173         # remove_blank_string does not seem to work on HTMLParser, and
 174         # pretty-printing with lxml more or less requires stripping
 175         # whitespace: http://lxml.de/FAQ.html#why-doesn-t-the-pretty-print-option-reformat-my-xml-output
 176         # so serialize to XML, parse as XML (remove whitespace) then serialize
 177         # as XML (pretty print)
 178         arch_no_whitespace = etree.fromstring(
 179             etree.tostring(arch, encoding='utf-8'),
 180             parser=etree.XMLParser(encoding='utf-8', remove_blank_text=True))
 181         return etree.tostring(
 182             arch_no_whitespace, encoding='unicode', pretty_print=True)
 183
 184     def save(self, cr, uid, res_id, value, xpath=None, context=None):
 185         """ Update a view section. The view section may embed fields to write
 186
 187         :param str model:
 188         :param int res_id:
 189         :param str xpath: valid xpath to the tag to replace
 190         """
 191         res_id = int(res_id)
 192
 193         arch_section = html.fromstring(
 194             value, parser=html.HTMLParser(encoding='utf-8'))
 195
 196         if xpath is None:
 197             # value is an embedded field on its own, not a view section
 198             self.save_embedded_field(cr, uid, arch_section, context=context)
 199             return
 200
 201         for el in self.extract_embedded_fields(cr, uid, arch_section, context=context):
 202             self.save_embedded_field(cr, uid, el, context=context)
 203
 204             # transform embedded field back to t-field
 205             el.getparent().replace(el, self.to_field_ref(cr, uid, el, context=context))
 206
 207         arch = self.replace_arch_section(cr, uid, res_id, xpath, arch_section, context=context)
 208         self.write(cr, uid, res_id, {
 209             'arch': self._pretty_arch(arch)
 210         }, context=context)
 211
 212         view = self.browse(cr, SUPERUSER_ID, res_id, context=context)
 213         if view.model_data_id:
 214             view.model_data_id.write({'noupdate': True})
 215