1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
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.
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.
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/>.
20 ##############################################################################
21 from lxml import etree
25 from datetime import datetime
29 from interface import report_rml
32 import openerp.pooler as pooler
33 import openerp.tools as tools
36 from openerp.osv.fields import float as float_class, function as function_class
37 from openerp.osv.orm import browse_record
38 from openerp.tools.translate import _
40 DT_FORMAT = '%Y-%m-%d'
41 DHM_FORMAT = '%Y-%m-%d %H:%M:%S'
42 HM_FORMAT = '%H:%M:%S'
71 def get_date_length(date_format=DT_FORMAT):
72 return len((datetime.now()).strftime(date_format))
74 class _format(object):
75 def set_value(self, cr, uid, name, object, field, lang_obj):
79 self.lang_obj = lang_obj
81 class _float_format(float, _format):
82 def __init__(self,value):
83 super(_float_format, self).__init__()
84 self.val = value or 0.0
88 if hasattr(self,'_field') and getattr(self._field, 'digits', None):
89 digits = self._field.digits[1]
90 if hasattr(self, 'lang_obj'):
91 return self.lang_obj.format('%.' + str(digits) + 'f', self.name, True)
94 class _int_format(int, _format):
95 def __init__(self,value):
96 super(_int_format, self).__init__()
100 if hasattr(self,'lang_obj'):
101 return self.lang_obj.format('%.d', self.name, True)
104 class _date_format(str, _format):
105 def __init__(self,value):
106 super(_date_format, self).__init__()
107 self.val = value and str(value) or ''
111 if getattr(self,'name', None):
112 date = datetime.strptime(self.name[:get_date_length()], DT_FORMAT)
113 return date.strftime(str(self.lang_obj.date_format))
116 class _dttime_format(str, _format):
117 def __init__(self,value):
118 super(_dttime_format, self).__init__()
119 self.val = value and str(value) or ''
122 if self.val and getattr(self,'name', None):
123 return datetime.strptime(self.name, DHM_FORMAT)\
124 .strftime("%s %s"%(str(self.lang_obj.date_format),
125 str(self.lang_obj.time_format)))
130 'float': _float_format,
131 'date': _date_format,
132 'integer': _int_format,
133 'datetime' : _dttime_format
137 # Context: {'node': node.dom}
139 class browse_record_list(list):
140 def __init__(self, lst, context):
141 super(browse_record_list, self).__init__(lst)
142 self.context = context
144 def __getattr__(self, name):
145 res = browse_record_list([getattr(x,name) for x in self], self.context)
149 return "browse_record_list("+str(len(self))+")"
151 class rml_parse(object):
152 def __init__(self, cr, uid, name, parents=rml_parents, tag=rml_tag, context=None):
157 self.pool = pooler.get_pool(cr.dbname)
158 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
159 self.localcontext = {
161 'setCompany': self.setCompany,
162 'repeatIn': self.repeatIn,
163 'setLang': self.setLang,
164 'setTag': self.setTag,
165 'removeParentNode': self.removeParentNode,
166 'format': self.format,
167 'formatLang': self.formatLang,
168 'lang' : user.company_id.partner_id.lang,
169 'translate' : self._translate,
170 'setHtmlImage' : self.set_html_image,
171 'strip_name' : self._strip_name,
173 'display_address': self.display_address,
174 # more context members are setup in setCompany() below:
178 self.setCompany(user.company_id)
179 self.localcontext.update(context)
182 self.parents = parents
184 self._lang_cache = {}
186 self.default_lang = {}
187 self.lang_dict_called = False
188 self._transl_regex = re.compile('(\[\[.+?\]\])')
190 def setTag(self, oldtag, newtag, attrs=None):
193 def _ellipsis(self, char, size=100, truncation_str='...'):
194 if len(char) <= size:
196 return char[:size-len(truncation_str)] + truncation_str
198 def setCompany(self, company_id):
200 self.localcontext['company'] = company_id
201 self.localcontext['logo'] = company_id.logo
202 self.rml_header = company_id.rml_header
203 self.rml_header2 = company_id.rml_header2
204 self.rml_header3 = company_id.rml_header3
205 self.logo = company_id.logo
207 def _strip_name(self, name, maxlen=50):
208 return self._ellipsis(name, maxlen)
210 def format(self, text, oldtag=None):
213 def removeParentNode(self, tag=None):
214 raise GeneratorExit('Skip')
216 def set_html_image(self,id,model=None,field=None,context=None):
220 model = 'ir.attachment'
223 res = self.pool.get(model).read(self.cr,self.uid,id)
226 elif model =='ir.attachment' :
233 def setLang(self, lang):
234 self.localcontext['lang'] = lang
235 self.lang_dict_called = False
236 for obj in self.objects:
237 obj._context['lang'] = lang
239 def _get_lang_dict(self):
240 pool_lang = self.pool.get('res.lang')
241 lang = self.localcontext.get('lang', 'en_US') or 'en_US'
242 lang_ids = pool_lang.search(self.cr,self.uid,[('code','=',lang)])[0]
243 lang_obj = pool_lang.browse(self.cr,self.uid,lang_ids)
244 self.lang_dict.update({'lang_obj':lang_obj,'date_format':lang_obj.date_format,'time_format':lang_obj.time_format})
245 self.default_lang[lang] = self.lang_dict.copy()
248 def digits_fmt(self, obj=None, f=None, dp=None):
249 digits = self.get_digits(obj, f, dp)
250 return "%%.%df" % (digits, )
252 def get_digits(self, obj=None, f=None, dp=None):
253 d = DEFAULT_DIGITS = 2
255 decimal_precision_obj = self.pool.get('decimal.precision')
256 ids = decimal_precision_obj.search(self.cr, self.uid, [('name', '=', dp)])
258 d = decimal_precision_obj.browse(self.cr, self.uid, ids)[0].digits
260 res_digits = getattr(obj._columns[f], 'digits', lambda x: ((16, DEFAULT_DIGITS)))
261 if isinstance(res_digits, tuple):
264 d = res_digits(self.cr)[1]
265 elif (hasattr(obj, '_field') and\
266 isinstance(obj._field, (float_class, function_class)) and\
268 d = obj._field.digits[1] or DEFAULT_DIGITS
271 def formatLang(self, value, digits=None, date=False, date_time=False, grouping=True, monetary=False, dp=False, currency_obj=False):
273 Assuming 'Account' decimal.precision=3:
274 formatLang(value) -> digits=2 (default)
275 formatLang(value, digits=4) -> digits=4
276 formatLang(value, dp='Account') -> digits=3
277 formatLang(value, digits=5, dp='Account') -> digits=5
281 digits = self.get_digits(dp=dp)
283 digits = self.get_digits(value)
285 if isinstance(value, (str, unicode)) and not value:
288 if not self.lang_dict_called:
289 self._get_lang_dict()
290 self.lang_dict_called = True
292 if date or date_time:
296 date_format = self.lang_dict['date_format']
297 parse_format = DT_FORMAT
299 value=value.split('.')[0]
300 date_format = date_format + " " + self.lang_dict['time_format']
301 parse_format = DHM_FORMAT
302 if not isinstance(value, time.struct_time):
303 return time.strftime(date_format, time.strptime(value[:get_date_length(parse_format)], parse_format))
306 date = datetime(*value.timetuple()[:6])
307 return date.strftime(date_format)
309 res = self.lang_dict['lang_obj'].format('%.' + str(digits) + 'f', value, grouping=grouping, monetary=monetary)
311 if currency_obj.position == 'after':
312 res='%s %s'%(res,currency_obj.symbol)
313 elif currency_obj and currency_obj.position == 'before':
314 res='%s %s'%(currency_obj.symbol, res)
317 def display_address(self, address_browse_record):
318 return self.pool.get('res.partner.address')._display_address(self.cr, self.uid, address_browse_record)
320 def repeatIn(self, lst, name,nodes_parent=False):
323 ret_lst.append({name:id})
326 def _translate(self,text):
327 lang = self.localcontext['lang']
328 if lang and text and not text.isspace():
329 transl_obj = self.pool.get('ir.translation')
330 piece_list = self._transl_regex.split(text)
331 for pn in range(len(piece_list)):
332 if not self._transl_regex.match(piece_list[pn]):
333 source_string = piece_list[pn].replace('\n', ' ').strip()
334 if len(source_string):
335 translated_string = transl_obj._get_source(self.cr, self.uid, self.name, ('report', 'rml'), lang, source_string)
336 if translated_string:
337 piece_list[pn] = piece_list[pn].replace(source_string, translated_string)
338 text = ''.join(piece_list)
341 def _add_header(self, rml_dom, header='external'):
342 if header=='internal':
343 rml_head = self.rml_header2
344 elif header=='internal landscape':
345 rml_head = self.rml_header3
347 rml_head = self.rml_header
349 head_dom = etree.XML(rml_head)
351 found = rml_dom.find('.//'+tag.tag)
352 if found is not None and len(found):
353 if tag.get('position'):
356 found.getparent().replace(found,tag)
359 def set_context(self, objects, data, ids, report_type = None):
360 self.localcontext['data'] = data
361 self.localcontext['objects'] = objects
362 self.localcontext['digits_fmt'] = self.digits_fmt
363 self.localcontext['get_digits'] = self.get_digits
366 self.objects = objects
368 if report_type=='odt' :
369 self.localcontext.update({'name_space' :common.odt_namespace})
371 self.localcontext.update({'name_space' :common.sxw_namespace})
373 # WARNING: the object[0].exists() call below is slow but necessary because
374 # some broken reporting wizards pass incorrect IDs (e.g. ir.ui.menu ids)
375 if objects and len(objects) == 1 and \
376 objects[0].exists() and 'company_id' in objects[0] and objects[0].company_id:
377 # When we print only one record, we can auto-set the correct
378 # company in the localcontext. For other cases the report
379 # will have to call setCompany() inside the main repeatIn loop.
380 self.setCompany(objects[0].company_id)
382 class report_sxw(report_rml, preprocess.report):
383 def __init__(self, name, table, rml=False, parser=rml_parse, header='external', store=False):
384 report_rml.__init__(self, name, table, rml, '')
389 self.internal_header=False
390 if header=='internal' or header=='internal landscape':
391 self.internal_header=True
393 def getObjects(self, cr, uid, ids, context):
394 table_obj = pooler.get_pool(cr.dbname).get(self.table)
395 return table_obj.browse(cr, uid, ids, list_class=browse_record_list, context=context, fields_process=_fields_process)
397 def create(self, cr, uid, ids, data, context=None):
400 if self.internal_header:
401 context.update(internal_header=self.internal_header)
402 # skip osv.fields.sanitize_binary_value() because we want the raw bytes in all cases
403 context.update(bin_raw=True)
404 pool = pooler.get_pool(cr.dbname)
405 ir_obj = pool.get('ir.actions.report.xml')
406 report_xml_ids = ir_obj.search(cr, uid,
407 [('report_name', '=', self.name[7:])], context=context)
409 report_xml = ir_obj.browse(cr, uid, report_xml_ids[0], context=context)
412 report_file = tools.file_open(self.tmpl, subdir=None)
414 rml = report_file.read()
415 report_type= data.get('report_type', 'pdf')
417 def __init__(self, *args, **argv):
418 for key,arg in argv.items():
419 setattr(self, key, arg)
420 report_xml = a(title=title, report_type=report_type, report_rml_content=rml, name=title, attachment=False, header=self.header)
423 if report_xml.header:
424 report_xml.header = self.header
425 report_type = report_xml.report_type
426 if report_type in ['sxw','odt']:
427 fnct = self.create_source_odt
428 elif report_type in ['pdf','raw','txt','html']:
429 fnct = self.create_source_pdf
430 elif report_type=='html2html':
431 fnct = self.create_source_html2html
432 elif report_type=='mako2html':
433 fnct = self.create_source_mako2html
435 raise NotImplementedError(_('Unknown report type: %s') % report_type)
436 fnct_ret = fnct(cr, uid, ids, data, report_xml, context)
441 def create_source_odt(self, cr, uid, ids, data, report_xml, context=None):
442 return self.create_single_odt(cr, uid, ids, data, report_xml, context or {})
444 def create_source_html2html(self, cr, uid, ids, data, report_xml, context=None):
445 return self.create_single_html2html(cr, uid, ids, data, report_xml, context or {})
447 def create_source_mako2html(self, cr, uid, ids, data, report_xml, context=None):
448 return self.create_single_mako2html(cr, uid, ids, data, report_xml, context or {})
450 def create_source_pdf(self, cr, uid, ids, data, report_xml, context=None):
453 pool = pooler.get_pool(cr.dbname)
454 attach = report_xml.attachment
456 objs = self.getObjects(cr, uid, ids, context)
459 aname = eval(attach, {'object':obj, 'time':time})
461 if report_xml.attachment_use and aname and context.get('attachment_use', True):
462 aids = pool.get('ir.attachment').search(cr, uid, [('datas_fname','=',aname+'.pdf'),('res_model','=',self.table),('res_id','=',obj.id)])
464 brow_rec = pool.get('ir.attachment').browse(cr, uid, aids[0])
465 if not brow_rec.datas:
467 d = base64.decodestring(brow_rec.datas)
468 results.append((d,'pdf'))
470 result = self.create_single_pdf(cr, uid, [obj.id], data, report_xml, context)
475 name = aname+'.'+result[1]
476 pool.get('ir.attachment').create(cr, uid, {
478 'datas': base64.encodestring(result[0]),
480 'res_model': self.table,
485 #TODO: should probably raise a proper osv_except instead, shouldn't we? see LP bug #325632
486 logging.getLogger('report').error('Could not create saved report attachment', exc_info=True)
487 results.append(result)
489 if results[0][1]=='pdf':
490 from pyPdf import PdfFileWriter, PdfFileReader
491 output = PdfFileWriter()
493 reader = PdfFileReader(cStringIO.StringIO(r[0]))
494 for page in range(reader.getNumPages()):
495 output.addPage(reader.getPage(page))
496 s = cStringIO.StringIO()
498 return s.getvalue(), results[0][1]
499 return self.create_single_pdf(cr, uid, ids, data, report_xml, context)
501 def create_single_pdf(self, cr, uid, ids, data, report_xml, context=None):
505 context = context.copy()
506 title = report_xml.name
507 rml = report_xml.report_rml_content
508 # if no rml file is found
511 rml_parser = self.parser(cr, uid, self.name2, context=context)
512 objs = self.getObjects(cr, uid, ids, context)
513 rml_parser.set_context(objs, data, ids, report_xml.report_type)
514 processed_rml = etree.XML(rml)
515 if report_xml.header:
516 rml_parser._add_header(processed_rml, self.header)
517 processed_rml = self.preprocess_rml(processed_rml,report_xml.report_type)
519 logo = base64.decodestring(rml_parser.logo)
520 create_doc = self.generators[report_xml.report_type]
521 pdf = create_doc(etree.tostring(processed_rml),rml_parser.localcontext,logo,title.encode('utf8'))
522 return (pdf, report_xml.report_type)
524 def create_single_odt(self, cr, uid, ids, data, report_xml, context=None):
527 context = context.copy()
528 report_type = report_xml.report_type
529 context['parents'] = sxw_parents
530 binary_report_content = report_xml.report_sxw_content
531 if isinstance(report_xml.report_sxw_content, unicode):
532 # if binary content was passed as unicode, we must
533 # re-encode it as a 8-bit string using the pass-through
534 # 'latin1' encoding, to restore the original byte values.
535 # See also osv.fields.sanitize_binary_value()
536 binary_report_content = report_xml.report_sxw_content.encode("latin1")
538 sxw_io = StringIO.StringIO(binary_report_content)
539 sxw_z = zipfile.ZipFile(sxw_io, mode='r')
540 rml = sxw_z.read('content.xml')
541 meta = sxw_z.read('meta.xml')
542 mime_type = sxw_z.read('mimetype')
543 if mime_type == 'application/vnd.sun.xml.writer':
549 rml_parser = self.parser(cr, uid, self.name2, context=context)
550 rml_parser.parents = sxw_parents
551 rml_parser.tag = sxw_tag
552 objs = self.getObjects(cr, uid, ids, context)
553 rml_parser.set_context(objs, data, ids, mime_type)
555 rml_dom_meta = node = etree.XML(meta)
556 elements = node.findall(rml_parser.localcontext['name_space']["meta"]+"user-defined")
558 if pe.get(rml_parser.localcontext['name_space']["meta"]+"name"):
559 if pe.get(rml_parser.localcontext['name_space']["meta"]+"name") == "Info 3":
560 pe[0].text=data['id']
561 if pe.get(rml_parser.localcontext['name_space']["meta"]+"name") == "Info 4":
562 pe[0].text=data['model']
563 meta = etree.tostring(rml_dom_meta, encoding='utf-8',
564 xml_declaration=True)
566 rml_dom = etree.XML(rml)
568 key1 = rml_parser.localcontext['name_space']["text"]+"p"
569 key2 = rml_parser.localcontext['name_space']["text"]+"drop-down"
570 for n in rml_dom.iterdescendants():
573 if mime_type == 'odt':
578 if de.text or de.tail:
579 pe.text = de.text or de.tail
581 if cnd.text or cnd.tail:
583 pe.text += cnd.text or cnd.tail
585 pe.text = cnd.text or cnd.tail
592 if de.text or de.tail:
593 pe.text = de.text or de.tail
595 text = cnd.get("{http://openoffice.org/2000/text}value",False)
597 if pe.text and text.startswith('[['):
599 elif text.startswith('[['):
604 rml_dom = self.preprocess_rml(rml_dom, mime_type)
605 create_doc = self.generators[mime_type]
606 odt = etree.tostring(create_doc(rml_dom, rml_parser.localcontext),
607 encoding='utf-8', xml_declaration=True)
608 sxw_z = zipfile.ZipFile(sxw_io, mode='a')
609 sxw_z.writestr('content.xml', odt)
610 sxw_z.writestr('meta.xml', meta)
612 if report_xml.header:
613 #Add corporate header/footer
614 rml_file = tools.file_open(os.path.join('base', 'report', 'corporate_%s_header.xml' % report_type))
616 rml = rml_file.read()
617 rml_parser = self.parser(cr, uid, self.name2, context=context)
618 rml_parser.parents = sxw_parents
619 rml_parser.tag = sxw_tag
620 objs = self.getObjects(cr, uid, ids, context)
621 rml_parser.set_context(objs, data, ids, report_xml.report_type)
622 rml_dom = self.preprocess_rml(etree.XML(rml),report_type)
623 create_doc = self.generators[report_type]
624 odt = create_doc(rml_dom,rml_parser.localcontext)
625 if report_xml.header:
626 rml_parser._add_header(odt)
627 odt = etree.tostring(odt, encoding='utf-8',
628 xml_declaration=True)
629 sxw_z.writestr('styles.xml', odt)
633 final_op = sxw_io.getvalue()
635 return (final_op, mime_type)
637 def create_single_html2html(self, cr, uid, ids, data, report_xml, context=None):
640 context = context.copy()
642 context['parents'] = html_parents
644 html = report_xml.report_rml_content
645 html_parser = self.parser(cr, uid, self.name2, context=context)
646 html_parser.parents = html_parents
647 html_parser.tag = sxw_tag
648 objs = self.getObjects(cr, uid, ids, context)
649 html_parser.set_context(objs, data, ids, report_type)
651 html_dom = etree.HTML(html)
652 html_dom = self.preprocess_rml(html_dom,'html2html')
654 create_doc = self.generators['html2html']
655 html = etree.tostring(create_doc(html_dom, html_parser.localcontext))
657 return (html.replace('&','&').replace('<', '<').replace('>', '>').replace('</br>',''), report_type)
659 def create_single_mako2html(self, cr, uid, ids, data, report_xml, context=None):
660 mako_html = report_xml.report_rml_content
661 html_parser = self.parser(cr, uid, self.name2, context)
662 objs = self.getObjects(cr, uid, ids, context)
663 html_parser.set_context(objs, data, ids, 'html')
664 create_doc = self.generators['makohtml2html']
665 html = create_doc(mako_html,html_parser.localcontext)
669 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: