[MERGE] merge from 6.0.0-RC1
[odoo/odoo.git] / bin / report / print_xml.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,types
23 from lxml import etree
24 import netsvc
25 import tools
26 from tools.safe_eval import safe_eval
27 import print_fnc
28 import copy
29 from osv.orm import browse_null, browse_record
30 import pooler
31
32 class InheritDict(dict):
33     # Might be usefull when we're doing name lookup for call or eval.
34
35     def __init__(self, parent=None):
36         self.parent = parent
37
38     def __getitem__(self, name):
39         if name in self:
40             return super(InheritDict, self).__getitem__(name)
41         else:
42             if not self.parent:
43                 raise KeyError
44             else:
45                 return self.parent[name]
46
47 def tounicode(val):
48     if isinstance(val, str):
49         unicode_val = unicode(val, 'utf-8')
50     elif isinstance(val, unicode):
51         unicode_val = val
52     else:
53         unicode_val = unicode(val)
54     return unicode_val
55
56 class document(object):
57     def __init__(self, cr, uid, datas, func=False):
58         # create a new document
59         self.cr = cr
60         self.pool = pooler.get_pool(cr.dbname)
61         self.func = func or {}
62         self.datas = datas
63         self.uid = uid
64         self.bin_datas = {}
65
66     def node_attrs_get(self, node):
67         if len(node.attrib):
68             return node.attrib
69         return {}
70
71     def get_value(self, browser, field_path):
72         fields = field_path.split('.')
73
74         if not len(fields):
75             return ''
76
77         value = browser
78
79         for f in fields:
80             if isinstance(value, list):
81                 if len(value)==0:
82                     return ''
83                 value = value[0]
84             if isinstance(value, browse_null):
85                 return ''
86             else:
87                 value = value[f]
88
89         if isinstance(value, browse_null) or (type(value)==bool and not value):
90             return ''
91         else:
92             return value
93
94     def get_value2(self, browser, field_path):
95         value = self.get_value(browser, field_path)
96         if isinstance(value, browse_record):
97             return value.id
98         elif isinstance(value, browse_null):
99             return False
100         else:
101             return value
102
103     def eval(self, record, expr):
104 #TODO: support remote variables (eg address.title) in expr
105 # how to do that: parse the string, find dots, replace those dotted variables by temporary
106 # "simple ones", fetch the value of those variables and add them (temporarily) to the _data
107 # dictionary passed to eval
108
109 #FIXME: it wont work if the data hasn't been fetched yet... this could
110 # happen if the eval node is the first one using this browse_record
111 # the next line is a workaround for the problem: it causes the resource to be loaded
112 #Pinky: Why not this ? eval(expr, browser) ?
113 #       name = browser.name
114 #       data_dict = browser._data[self.get_value(browser, 'id')]
115         return safe_eval(expr, {}, {'obj': record})
116
117     def parse_node(self, node, parent, browser, datas=None):
118             attrs = self.node_attrs_get(node)
119             if 'type' in attrs:
120                 if attrs['type']=='field':
121                     value = self.get_value(browser, attrs['name'])
122 #TODO: test this
123                     if value == '' and 'default' in attrs:
124                         value = attrs['default']
125                     el = etree.SubElement(parent, node.tag)
126                     el.text = tounicode(value)
127 #TODO: test this
128                     for key, value in attrs.iteritems():
129                         if key not in ('type', 'name', 'default'):
130                             el.set(key, value)
131
132                 elif attrs['type']=='attachment':
133                     if isinstance(browser, list):
134                         model = browser[0]._table_name
135                     else:
136                         model = browser._table_name
137
138                     value = self.get_value(browser, attrs['name'])
139
140                     service = netsvc.LocalService("object_proxy")
141                     ids = service.execute(self.cr.dbname, self.uid, 'ir.attachment', 'search', [('res_model','=',model),('res_id','=',int(value))])
142                     datas = service.execute(self.cr.dbname, self.uid, 'ir.attachment', 'read', ids)
143
144                     if len(datas):
145                         # if there are several, pick first
146                         datas = datas[0]
147                         fname = str(datas['datas_fname'])
148                         ext = fname.split('.')[-1].lower()
149                         if ext in ('jpg','jpeg', 'png'):
150                             import base64
151                             from StringIO import StringIO
152                             dt = base64.decodestring(datas['datas'])
153                             fp = StringIO()
154                             fp.write(dt)
155                             i = str(len(self.bin_datas))
156                             self.bin_datas[i] = fp
157                             el = etree.SubElement(parent, node.tag)
158                             el.text = i
159
160                 elif attrs['type']=='data':
161 #TODO: test this
162                     txt = self.datas.get('form', {}).get(attrs['name'], '')
163                     el = etree.SubElement(parent, node.tag)
164                     el.text = txt
165
166                 elif attrs['type']=='function':
167                     if attrs['name'] in self.func:
168                         txt = self.func[attrs['name']](node)
169                     else:
170                         txt = print_fnc.print_fnc(attrs['name'], node)
171                     el = etree.SubElement(parent, node.tag)
172                     el.text = txt
173
174                 elif attrs['type']=='eval':
175                     value = self.eval(browser, attrs['expr'])
176                     el = etree.SubElement(parent, node.tag)
177                     el.text = str(value)
178
179                 elif attrs['type']=='fields':
180                     fields = attrs['name'].split(',')
181                     vals = {}
182                     for b in browser:
183                         value = tuple([self.get_value2(b, f) for f in fields])
184                         if not value in vals:
185                             vals[value]=[]
186                         vals[value].append(b)
187                     keys = vals.keys()
188                     keys.sort()
189
190                     if 'order' in attrs and attrs['order']=='desc':
191                         keys.reverse()
192
193                     v_list = [vals[k] for k in keys]
194                     for v in v_list:
195                         el = etree.SubElement(parent, node.tag)
196                         for el_cld in node:
197                             self.parse_node(el_cld, el, v)
198
199                 elif attrs['type']=='call':
200                     if len(attrs['args']):
201 #TODO: test this
202                         # fetches the values of the variables which names where passed in the args attribute
203                         args = [self.eval(browser, arg) for arg in attrs['args'].split(',')]
204                     else:
205                         args = []
206                     # get the object
207                     if attrs.has_key('model'):
208                         obj = self.pool.get(attrs['model'])
209                     else:
210                         if isinstance(browser, list):
211                             obj = browser[0]._table
212                         else:
213                             obj = browser._table
214
215                     # get the ids
216                     if attrs.has_key('ids'):
217                         ids = self.eval(browser, attrs['ids'])
218                     else:
219                         if isinstance(browser, list):
220                             ids = [b.id for b in browser]
221                         else:
222                             ids = [browser.id]
223
224                     # call the method itself
225                     newdatas = getattr(obj, attrs['name'])(self.cr, self.uid, ids, *args)
226
227                     def parse_result_tree(node, parent, datas):
228                         if not node.tag == etree.Comment:
229                             el = etree.SubElement(parent, node.tag)
230                             atr = self.node_attrs_get(node)
231                             if 'value' in atr:
232                                 if not isinstance(datas[atr['value']], (str, unicode)):
233                                     txt = str(datas[atr['value']])
234                                 else:
235                                      txt = datas[atr['value']]
236                                 el.text = txt
237                             else:
238                                 for el_cld in node:
239                                     parse_result_tree(el_cld, el, datas)
240                     if not isinstance(newdatas, list):
241                         newdatas = [newdatas]
242                     for newdata in newdatas:
243                         parse_result_tree(node, parent, newdata)
244
245                 elif attrs['type']=='zoom':
246                     value = self.get_value(browser, attrs['name'])
247                     if value:
248                         if not isinstance(value, list):
249                             v_list = [value]
250                         else:
251                             v_list = value
252                         for v in v_list:
253                             el = etree.SubElement(parent, node.tag)
254                             for el_cld in node:
255                                 self.parse_node(el_cld, el, v)
256             else:
257                 # if there is no "type" attribute in the node, copy it to the xml data and parse its children
258                 if not node.tag == etree.Comment:
259                     if node.tag == parent.tag:
260                         el = parent
261                     else:
262                         el = etree.SubElement(parent, node.tag)
263                     for el_cld in node:
264                         self.parse_node(el_cld,el, browser)
265     def xml_get(self):
266         return etree.tostring(self.doc,encoding="utf-8",xml_declaration=True,pretty_print=True)
267
268     def parse_tree(self, ids, model, context=None):
269         if not context:
270             context={}
271         browser = self.pool.get(model).browse(self.cr, self.uid, ids, context)
272         self.parse_node(self.dom, self.doc, browser)
273
274     def parse_string(self, xml, ids, model, context=None):
275         if not context:
276             context={}
277         # parses the xml template to memory
278         self.dom = etree.XML(xml)
279         # create the xml data from the xml template
280         self.parse_tree(ids, model, context)
281
282     def parse(self, filename, ids, model, context=None):
283         if not context:
284             context={}
285         # parses the xml template to memory
286         self.dom = etree.XML(tools.file_open(filename).read())
287         self.doc = etree.Element(self.dom.tag)
288         self.parse_tree(ids, model, context)
289
290     def close(self):
291         self.doc = None
292         self.dom = None
293
294
295 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
296