bin/report/interface.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20 ##############################################################################
  21
  22 import os
  23 import re
  24
  25 from lxml import etree
  26 import netsvc
  27 import pooler
  28
  29 import tools
  30 import addons
  31 import print_xml
  32 import render
  33 import urllib
  34
  35 #
  36 # encode a value to a string in utf8 and converts XML entities
  37 #
  38 def toxml(val):
  39     if isinstance(val, str):
  40         str_utf8 = val
  41     elif isinstance(val, unicode):
  42         str_utf8 = val.encode('utf-8')
  43     else:
  44         str_utf8 = str(val)
  45     return str_utf8.replace('&', '&amp;').replace('<','&lt;').replace('>','&gt;')
  46
  47 class report_int(netsvc.Service):
  48     def __init__(self, name, audience='*'):
  49         assert not self.exists(name), 'The report "%s" already exists!' % name
  50         super(report_int, self).__init__(name, audience)
  51         if name[0:7]<>'report.':
  52             raise Exception, 'ConceptionError, bad report name, should start with "report."'
  53         self.name = name
  54         self.id = 0
  55         self.name2 = '.'.join(name.split('.')[1:])
  56         self.title = None
  57         #self.joinGroup('report')
  58         self.exportMethod(self.create)
  59
  60     def create(self, cr, uid, ids, datas, context=None):
  61         return False
  62
  63 """
  64     Class to automatically build a document using the transformation process:
  65         XML -> DATAS -> RML -> PDF
  66                             -> HTML
  67     using a XSL:RML transformation
  68 """
  69 class report_rml(report_int):
  70     def __init__(self, name, table, tmpl, xsl):
  71         super(report_rml, self).__init__(name)
  72         self.table = table
  73         self.pageCount=True
  74         self.tmpl = tmpl
  75         self.xsl = xsl
  76         self.bin_datas = {}
  77         self.generators = {
  78             'pdf': self.create_pdf,
  79             'html': self.create_html,
  80             'raw': self.create_raw,
  81             'sxw': self.create_sxw,
  82             'txt': self.create_txt,
  83             'odt': self.create_odt,
  84             'html2html' : self.create_html2html,
  85             'makohtml2html' :self.create_makohtml2html,
  86         }
  87
  88     def create(self, cr, uid, ids, datas, context):
  89         xml = self.create_xml(cr, uid, ids, datas, context)
  90         xml = tools.ustr(xml).encode('utf8')
  91         report_type = datas.get('report_type', 'pdf')
  92         if report_type == 'raw':
  93             return (xml,report_type)
  94         rml = self.create_rml(cr, xml, uid, context)
  95         pool = pooler.get_pool(cr.dbname)
  96         ir_actions_report_xml_obj = pool.get('ir.actions.report.xml')
  97         report_xml_ids = ir_actions_report_xml_obj.search(cr, uid, [('report_name', '=', self.name[7:])], context=context)
  98         self.title = report_xml_ids and ir_actions_report_xml_obj.browse(cr,uid,report_xml_ids)[0].name or 'OpenERP Report'
  99         create_doc = self.generators[report_type]
 100         pdf = create_doc(rml, title=self.title)
 101         return (pdf, report_type)
 102
 103     def create_xml(self, cr, uid, ids, datas, context=None):
 104         if not context:
 105             context={}
 106         doc = print_xml.document(cr, uid, datas, {})
 107         self.bin_datas.update( doc.bin_datas  or {})
 108         doc.parse(self.tmpl, ids, self.table, context)
 109         xml = doc.xml_get()
 110         doc.close()
 111         return self.post_process_xml_data(cr, uid, xml, context)
 112
 113     def post_process_xml_data(self, cr, uid, xml, context=None):
 114         if not context:
 115             context={}
 116         # find the position of the 3rd tag
 117         # (skip the <?xml ...?> and the "root" tag)
 118         iter = re.finditer('<[^>]*>', xml)
 119         i = iter.next()
 120         i = iter.next()
 121         pos_xml = i.end()
 122
 123         doc = print_xml.document(cr, uid, {}, {})
 124         tmpl_path = addons.get_module_resource('base', 'report', 'corporate_defaults.xml')
 125         doc.parse(tmpl_path, [uid], 'res.users', context)
 126         corporate_header = doc.xml_get()
 127         doc.close()
 128
 129         # find the position of the tag after the <?xml ...?> tag
 130         iter = re.finditer('<[^>]*>', corporate_header)
 131         i = iter.next()
 132         pos_header = i.end()
 133
 134         return xml[:pos_xml] + corporate_header[pos_header:] + xml[pos_xml:]
 135
 136     #
 137     # TODO: The translation doesn't work for "<tag t="1">textext<tag> tex</tag>text</tag>"
 138     #
 139     def create_rml(self, cr, xml, uid, context=None):
 140         if not context:
 141             context={}
 142         pool = pooler.get_pool(cr.dbname)
 143         ir_translation_obj = pool.get('ir.translation')
 144
 145         # In some case we might not use xsl ...
 146         if not self.xsl:
 147             return xml
 148
 149         stylesheet = etree.parse(tools.file_open(self.xsl))
 150         xsl_path, _ = os.path.split(self.xsl)
 151         for import_child in stylesheet.findall('./import'):
 152             if 'href' in import_child.attrib:
 153                 imp_file = import_child.get('href')
 154                 _, imp_file = tools.file_open(imp_file, subdir=xsl_path, pathinfo=True)
 155                 import_child.set('href', urllib.quote(str(imp_file)))
 156
 157         #TODO: get all the translation in one query. That means we have to:
 158         # * build a list of items to translate,
 159         # * issue the query to translate them,
 160         # * (re)build/update the stylesheet with the translated items
 161
 162         def translate(doc, lang):
 163             for node in doc.xpath('//*[@t]'):
 164                 translation = ir_translation_obj._get_source(cr, uid, self.name2, 'xsl', lang, node.text)
 165                 if translation:
 166                     node.text = translation
 167
 168         if context.get('lang', False):
 169             translate(stylesheet, context['lang'])
 170
 171         transform = etree.XSLT(stylesheet)
 172         xml = etree.tostring(
 173             transform(etree.fromstring(xml)))
 174
 175         return xml
 176
 177     def create_pdf(self, rml, localcontext = None, logo=None, title=None):
 178         if not localcontext:
 179             localcontext={}
 180             if self.tmpl=='' and not self.pageCount:
 181                 self.pageCount=True
 182             else:
 183                 self.pageCount=False
 184             localcontext.update({'header':self.pageCount})
 185
 186         if logo:
 187             self.bin_datas['logo'] = logo
 188         else:
 189             if 'logo' in self.bin_datas:
 190                 del self.bin_datas['logo']
 191         obj = render.rml(rml, localcontext, self.bin_datas, tools.config['root_path'],title)
 192         obj.render()
 193         self.pageCount=True
 194         return obj.get()
 195
 196     def create_html(self, rml, localcontext = None, logo=None, title=None):
 197         obj = render.rml2html(rml, localcontext, self.bin_datas)
 198         obj.render()
 199         return obj.get()
 200
 201     def create_txt(self, rml,localcontext, logo=None, title=None):
 202         obj = render.rml2txt(rml, localcontext, self.bin_datas)
 203         obj.render()
 204         return obj.get().encode('utf-8')
 205
 206     def create_html2html(self, rml, localcontext = None, logo=None, title=None):
 207         obj = render.html2html(rml, localcontext, self.bin_datas)
 208         obj.render()
 209         return obj.get()
 210
 211
 212     def create_raw(self,rml, localcontext = None, logo=None, title=None):
 213         obj = render.odt2odt(etree.XML(rml),localcontext)
 214         obj.render()
 215         return etree.tostring(obj.get())
 216
 217     def create_sxw(self,rml,localcontext = None):
 218         obj = render.odt2odt(rml,localcontext)
 219         obj.render()
 220         return obj.get()
 221
 222     def create_odt(self,rml,localcontext = None):
 223         obj = render.odt2odt(rml,localcontext)
 224         obj.render()
 225         return obj.get()
 226
 227     def create_makohtml2html(self,html,localcontext = None):
 228         obj = render.makohtml2html(html,localcontext)
 229         obj.render()
 230         return obj.get()
 231
 232
 233 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: