OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

230 lines
8.9 KiB

  1. # -*- encoding: utf-8 -*-
  2. ##############################################################################
  3. #
  4. # OpenERP, Open Source Management Solution
  5. #
  6. # Copyright (c) 2013 Noviat nv/sa (www.noviat.com). All rights reserved.
  7. #
  8. # This program is free software: you can redistribute it and/or modify
  9. # it under the terms of the GNU Affero General Public License as
  10. # published by the Free Software Foundation, either version 3 of the
  11. # License, or (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU Affero General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU Affero General Public License
  19. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. #
  21. ##############################################################################
  22. import xlwt
  23. from xlwt.Style import default_style
  24. import cStringIO
  25. from datetime import datetime
  26. from openerp.osv.fields import datetime as datetime_field
  27. from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT
  28. import inspect
  29. from types import CodeType
  30. from openerp.report.report_sxw import *
  31. from openerp import pooler
  32. from openerp.tools.translate import translate, _
  33. import logging
  34. _logger = logging.getLogger(__name__)
  35. class AttrDict(dict):
  36. def __init__(self, *args, **kwargs):
  37. super(AttrDict, self).__init__(*args, **kwargs)
  38. self.__dict__ = self
  39. class report_xls(report_sxw):
  40. xls_types = {
  41. 'bool': xlwt.Row.set_cell_boolean,
  42. 'date': xlwt.Row.set_cell_date,
  43. 'text': xlwt.Row.set_cell_text,
  44. 'number': xlwt.Row.set_cell_number,
  45. }
  46. xls_types_default = {
  47. 'bool': False,
  48. 'date': None,
  49. 'text': '',
  50. 'number': 0,
  51. }
  52. # TO DO: move parameters infra to configurable data
  53. # header/footer
  54. hf_params = {
  55. 'font_size': 8,
  56. 'font_style': 'I', # B: Bold, I: Italic, U: Underline
  57. }
  58. # styles
  59. _pfc = '26' # default pattern fore_color
  60. _bc = '22' # borders color
  61. decimal_format = '#,##0.00'
  62. date_format = 'YYYY-MM-DD'
  63. xls_styles = {
  64. 'xls_title': 'font: bold true, height 240;',
  65. 'bold': 'font: bold true;',
  66. 'underline': 'font: underline true;',
  67. 'italic': 'font: italic true;',
  68. 'fill': 'pattern: pattern solid, fore_color %s;' % _pfc,
  69. 'fill_blue': 'pattern: pattern solid, fore_color 27;',
  70. 'fill_grey': 'pattern: pattern solid, fore_color 22;',
  71. 'borders_all': 'borders: left thin, right thin, top thin, bottom thin, '
  72. 'left_colour %s, right_colour %s, top_colour %s, bottom_colour %s;' % (_bc, _bc, _bc, _bc),
  73. 'left': 'align: horz left;',
  74. 'center': 'align: horz center;',
  75. 'right': 'align: horz right;',
  76. 'wrap': 'align: wrap true;',
  77. 'top': 'align: vert top;',
  78. 'bottom': 'align: vert bottom;',
  79. }
  80. # TO DO: move parameters supra to configurable data
  81. def create(self, cr, uid, ids, data, context=None):
  82. self.pool = pooler.get_pool(cr.dbname)
  83. self.cr = cr
  84. self.uid = uid
  85. report_obj = self.pool.get('ir.actions.report.xml')
  86. report_ids = report_obj.search(cr, uid,
  87. [('report_name', '=', self.name[7:])], context=context)
  88. if report_ids:
  89. report_xml = report_obj.browse(cr, uid, report_ids[0], context=context)
  90. self.title = report_xml.name
  91. if report_xml.report_type == 'xls':
  92. return self.create_source_xls(cr, uid, ids, data, context)
  93. elif context.get('xls_export'):
  94. self.table = data.get('model') or self.table # use model from 'data' when no ir.actions.report.xml entry
  95. return self.create_source_xls(cr, uid, ids, data, context)
  96. return super(report_xls, self).create(cr, uid, ids, data, context)
  97. def create_source_xls(self, cr, uid, ids, data, context=None):
  98. if not context:
  99. context = {}
  100. parser_instance = self.parser(cr, uid, self.name2, context)
  101. self.parser_instance = parser_instance
  102. objs = self.getObjects(cr, uid, ids, context)
  103. parser_instance.set_context(objs, data, ids, 'xls')
  104. objs = parser_instance.localcontext['objects']
  105. n = cStringIO.StringIO()
  106. wb = xlwt.Workbook(encoding='utf-8')
  107. _p = AttrDict(parser_instance.localcontext)
  108. _xs = self.xls_styles
  109. self.xls_headers = {
  110. 'standard': '',
  111. }
  112. report_date = datetime_field.context_timestamp(cr, uid, datetime.now(), context).strftime(DEFAULT_SERVER_DATETIME_FORMAT)
  113. self.xls_footers = {
  114. 'standard': ('&L&%(font_size)s&%(font_style)s' + report_date +
  115. '&R&%(font_size)s&%(font_style)s&P / &N') % self.hf_params,
  116. }
  117. self.generate_xls_report(_p, _xs, data, objs, wb)
  118. wb.save(n)
  119. n.seek(0)
  120. return (n.read(), 'xls')
  121. def render(self, wanted, col_specs, rowtype, render_space='empty'):
  122. """
  123. returns 'evaluated' col_specs
  124. Input:
  125. - wanted: element from the wanted_list
  126. - col_specs : cf. specs[1:] documented in xls_row_template method
  127. - rowtype : 'header' or 'data'
  128. - render_space : type dict, (caller_space + localcontext) if not specified
  129. """
  130. if render_space == 'empty':
  131. render_space = {}
  132. caller_space = inspect.currentframe().f_back.f_back.f_locals
  133. localcontext = self.parser_instance.localcontext
  134. render_space.update(caller_space)
  135. render_space.update(localcontext)
  136. row = col_specs[wanted][rowtype][:]
  137. for i in range(len(row)):
  138. if isinstance(row[i], CodeType):
  139. row[i] = eval(row[i], render_space)
  140. row.insert(0, wanted)
  141. #_logger.warn('row O = %s', row)
  142. return row
  143. def generate_xls_report(self, parser, xls_styles, data, objects, wb):
  144. """ override this method to create your excel file """
  145. raise NotImplementedError()
  146. def xls_row_template(self, specs, wanted_list):
  147. """
  148. Returns a row template.
  149. Input :
  150. - 'wanted_list': list of Columns that will be returned in the row_template
  151. - 'specs': list with Column Characteristics
  152. 0: Column Name (from wanted_list)
  153. 1: Column Colspan
  154. 2: Column Size (unit = the width of the character 0 as it appears in the sheets default font)
  155. 3: Column Type
  156. 4: Column Data
  157. 5: Column Formula (or 'None' for Data)
  158. 6: Column Style
  159. """
  160. r = []
  161. col = 0
  162. for w in wanted_list:
  163. found = False
  164. for s in specs:
  165. if s[0] == w:
  166. found = True
  167. s_len = len(s)
  168. c = list(s[:5])
  169. # set write_cell_func or formula
  170. if s_len > 5 and s[5] is not None:
  171. c.append({'formula': s[5]})
  172. else:
  173. c.append({'write_cell_func': report_xls.xls_types[c[3]]})
  174. # Set custom cell style
  175. if s_len > 6 and s[6] is not None:
  176. c.append(s[6])
  177. else:
  178. c.append(None)
  179. # Set cell formula
  180. if s_len > 7 and s[7] is not None:
  181. c.append(s[7])
  182. else:
  183. c.append(None)
  184. r.append((col, c[1], c))
  185. col += c[1]
  186. break
  187. if not found:
  188. _logger.warn("report_xls.xls_row_template, column '%s' not found in specs", w)
  189. return r
  190. def xls_write_row(self, ws, row_pos, row_data, row_style=default_style, set_column_size=False):
  191. r = ws.row(row_pos)
  192. for col, size, spec in row_data:
  193. data = spec[4]
  194. formula = spec[5].get('formula') and xlwt.Formula(spec[5]['formula']) or None
  195. style = spec[6] and spec[6] or row_style
  196. if not data:
  197. # if no data, use default values
  198. data = report_xls.xls_types_default[spec[3]]
  199. if size != 1:
  200. if formula:
  201. ws.write_merge(row_pos, row_pos, col, col + size - 1, data, style)
  202. else:
  203. ws.write_merge(row_pos, row_pos, col, col + size - 1, data, style)
  204. else:
  205. if formula:
  206. ws.write(row_pos, col, formula, style)
  207. else:
  208. spec[5]['write_cell_func'](r, col, data, style)
  209. if set_column_size:
  210. ws.col(col).width = spec[2] * 256
  211. return row_pos + 1
  212. # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: