1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
# -*- coding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2012 TeMPO Consulting, MSF. All Rights Reserved
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
"""
This module is dedicated to help checking lines of Excel file at importation.
"""
from msf_supply_doc_import import MAX_LINES_NB
def check_nb_of_lines(**kwargs):
"""
Compute number of lines in the xml file to import.
"""
fileobj = kwargs['fileobj']
rows = fileobj.getRows()
i = 0
for x in rows.__iter__():
i = i + 1
if i > MAX_LINES_NB + 1:
return True
return False
def check_empty_line(**kwargs):
"""
Check if a line is not empty.
If all cells are empty, return False.
"""
row = kwargs['row']
col_count = kwargs['col_count']
for cell in range(col_count):
try:
if row.cells[cell].data:
return True
except TypeError:
pass
def get_log_message(**kwargs):
"""
Define log message
"""
obj = kwargs.get('obj', False)
to_write = kwargs['to_write']
# nb_lines_error and tender are just for tender
nb_lines_error = kwargs.get('nb_lines_error', False)
tender = kwargs.get('tender', False)
# not for tender
obj = kwargs.get('obj', False)
msg_to_return = False
# nb_lines_error => is just for tender
if tender and nb_lines_error:
msg_to_return = "The import of lines had errors, please correct the red lines below"
# is for all but tender
elif not tender and [x for x in obj.order_line if x.to_correct_ok]:
msg_to_return = "The import of lines had errors, please correct the red lines below"
# is for all but tender
elif not to_write:
msg_to_return = "The file doesn\'t contain valid line."
return msg_to_return
def product_value(cr, uid, **kwargs):
"""
Compute product value according to cell content.
Return product_code, comment, msg.
"""
msg = ''
row = kwargs['row']
product_obj = kwargs['product_obj']
# Tender does not have comment, it is an empty string
comment = kwargs['to_write'].get('comment', '')
# Tender does not have proc_type, it is False
proc_type = kwargs['to_write'].get('proc_type', False)
# Tender does not have price_unit, it is False
price_unit = kwargs['to_write'].get('price_unit', False)
error_list = kwargs['to_write']['error_list']
default_code = kwargs['to_write']['default_code']
# The tender line may have a default product if it is not found
obj_data = kwargs['obj_data']
try:
if row.cells[0] and row.cells[0].data:
product_code = row.cells[0].data
if product_code and row.cells[0].type == 'str':
product_code = product_code.strip()
p_ids = product_obj.search(cr, uid, [('default_code', '=', product_code)])
if not p_ids:
comment += ' Code: %s' % (product_code)
msg = 'The Product\'s Code is not found in the database.'
else:
default_code = p_ids[0]
proc_type = product_obj.browse(cr, uid, [default_code])[0].procure_method
price_unit = product_obj.browse(cr, uid, [default_code])[0].list_price
else:
msg = 'The Product Code has to be a string.'
if not default_code or default_code == obj_data.get_object_reference(cr, uid, 'msf_supply_doc_import', 'product_tbd')[1]:
comment += ' Product Code to be defined'
error_list.append(msg or 'The Product\'s Code has to be defined')
# if the cell is empty
except IndexError:
comment += ' Product Code to be defined'
error_list.append('The Product\'s Code has to be defined')
return {'default_code': default_code, 'proc_type': proc_type, 'comment': comment, 'error_list': error_list, 'price_unit': price_unit}
def quantity_value(**kwargs):
"""
Compute qty value of the cell.
"""
row = kwargs['row']
product_qty = kwargs['to_write']['product_qty']
error_list = kwargs['to_write']['error_list']
# with warning_list: the line does not appear in red, it is just informative
warning_list = kwargs['to_write']['warning_list']
try:
if not row.cells[2]:
warning_list.append('The Product Quantity was not set. It is set to 1 by default.')
else:
if row.cells[2].type in ['int', 'float']:
product_qty = row.cells[2].data
else:
error_list.append('The Product Quantity was not a number and it is required to be greater than 0, it is set to 1 by default.')
# if the cell is empty
except IndexError:
warning_list.append('The Product Quantity was not set. It is set to 1 by default.')
return {'product_qty': product_qty, 'error_list': error_list, 'warning_list': warning_list}
def compute_uom_value(cr, uid, **kwargs):
"""
Retrieves product UOM from Excel file
"""
row = kwargs['row']
uom_obj = kwargs['uom_obj']
product_obj = kwargs['product_obj']
default_code = kwargs['to_write']['default_code']
error_list = kwargs['to_write']['error_list']
uom_id = kwargs['to_write'].get('uom_id', False)
# The tender line may have a default UOM if it is not found
obj_data = kwargs['obj_data']
msg = ''
try:
# when row.cells[3] is "SpreadsheetCell: None" it is not really None (it is why it is transformed in string)
if row.cells[3] and str(row.cells[3]) != str(None):
if row.cells[3].type == 'str':
uom_name = row.cells[3].data.strip()
uom_ids = uom_obj.search(cr, uid, [('name', '=', uom_name)])
if uom_ids:
uom_id = uom_ids[0]
else:
msg = 'The UOM Name has to be a string.'
if not uom_id or uom_id == obj_data.get_object_reference(cr, uid, 'msf_supply_doc_import', 'uom_tbd')[1]:
error_list.append(msg or 'The UOM Name was not valid.')
uom_id = obj_data.get_object_reference(cr, uid, 'msf_supply_doc_import', 'uom_tbd')[1]
else:
error_list.append(msg or 'The UOM Name was empty.')
if default_code:
uom_id = product_obj.browse(cr, uid, [default_code])[0].uom_id.id
else:
uom_id = obj_data.get_object_reference(cr, uid, 'msf_supply_doc_import', 'uom_tbd')[1]
# if the cell is empty
except IndexError:
error_list.append('The UOM Name was empty.')
if default_code:
uom_id = product_obj.browse(cr, uid, [default_code])[0].uom_id.id
else:
uom_id = obj_data.get_object_reference(cr, uid, 'msf_supply_doc_import', 'uom_tbd')[1]
return {'uom_id': uom_id, 'error_list': error_list}
def compute_price_value(**kwargs):
"""
Retrieves Price Unit from Excel file and compute it if None.
"""
row = kwargs['row']
# the price_unit was updated in the product_value method if the product exists, else it was set to 1 by default.
price_unit = kwargs['to_write']['price_unit']
default_code = kwargs['to_write']['default_code']
error_list = kwargs['to_write']['error_list']
# with warning_list: the line does not appear in red, it is just informative
warning_list = kwargs['to_write']['warning_list']
price = kwargs['price'] or 'Price'
price_unit_defined = False
try:
if not row.cells[4] or not row.cells[4].data:
if default_code:
warning_list.append('The Price Unit was not set, we have taken the default "%s" of the product.' % price)
else:
error_list.append('The Price and Product not found.')
elif row.cells[4].type not in ['int', 'float'] and not default_code:
error_list.append('The Price Unit was not a number and no product was found.')
elif row.cells[4].type in ['int', 'float']:
price_unit_defined = True
price_unit = row.cells[4].data
else:
error_list.append('The Price Unit was not defined properly.')
# if nothing is found at the line index (empty cell)
except IndexError:
if default_code:
warning_list.append('The Price Unit was not set, we have taken the default "%s" of the product.' % price)
else:
error_list.append('Neither Price nor Product found.')
return {'price_unit': price_unit, 'error_list': error_list, 'warning_list': warning_list, 'price_unit_defined': price_unit_defined}
def compute_date_value(**kwargs):
"""
Retrieves Date from Excel file or take the one from the parent
"""
row = kwargs['row']
date_planned = kwargs['to_write']['date_planned']
error_list = kwargs['to_write']['error_list']
# with warning_list: the line does not appear in red, it is just informative
warning_list = kwargs['to_write']['warning_list']
try:
if row.cells[5] and row.cells[5].type == 'datetime':
date_planned = row.cells[5].data
else:
warning_list.append('The date format was not correct. The date from the header has been taken.')
# if nothing is found at the line index (empty cell)
except IndexError:
warning_list.append('The date format was not correct. The date from the header has been taken.')
return {'date_planned': date_planned, 'error_list': error_list, 'warning_list': warning_list}
def compute_currency_value(cr, uid, **kwargs):
"""
Retrieves Currency from Excel file or take the one from the parent
"""
row = kwargs['row']
functional_currency_id = kwargs['to_write']['functional_currency_id']
warning_list = kwargs['to_write']['warning_list']
currency_obj = kwargs['currency_obj']
browse_sale = kwargs.get('browse_sale', False)
browse_purchase = kwargs.get('browse_purchase', False)
# the cell number change between Internal Request and Sale Order
cell_nb = kwargs['cell']
fc_id = False
msg = ''
try:
if row.cells[cell_nb]:
curr = row.cells[cell_nb].data
if curr:
if row.cells[cell_nb].type == 'str':
curr_name = curr.strip().upper()
currency_ids = currency_obj.search(cr, uid, [('name', '=', curr_name)])
if currency_ids and browse_sale:
if currency_ids[0] == browse_sale.pricelist_id.currency_id.id:
fc_id = currency_ids[0]
else:
imported_curr_name = currency_obj.browse(cr, uid, currency_ids)[0].name
default_curr_name = browse_sale.pricelist_id.currency_id.name
msg = "The imported currency '%s' was not consistent and has been replaced by the \
currency '%s' of the order, please check the price." % (imported_curr_name, default_curr_name)
elif currency_ids and browse_purchase:
if currency_ids[0] == browse_purchase.pricelist_id.currency_id.id:
fc_id = currency_ids[0]
else:
imported_curr_name = currency_obj.browse(cr, uid, currency_ids)[0].name
default_curr_name = browse_purchase.pricelist_id.currency_id.name
msg = "The imported currency '%s' was not consistent and has been replaced by the \
currency '%s' of the order, please check the price." % (imported_curr_name, default_curr_name)
else:
msg = 'The Currency Name was not valid, it has to be a string.'
if fc_id:
functional_currency_id = fc_id
else:
warning_list.append(msg or 'The Currency Name was not found.')
# if the cell is empty
except IndexError:
warning_list.append('The Currency Name was not found.')
return {'functional_currency_id': functional_currency_id, 'warning_list': warning_list}
def comment_value(**kwargs):
"""
Retrieves comment from Excel file
"""
row = kwargs['row']
comment = kwargs['to_write']['comment']
warning_list = kwargs['to_write']['warning_list']
# the cell number change between Internal Request and Sale Order
cell_nb = kwargs['cell']
try:
if not row.cells[cell_nb]:
warning_list.append("No comment was defined")
else:
if comment and row.cells[cell_nb].data:
comment += ', %s' % row.cells[cell_nb].data
elif row.cells[cell_nb].data:
comment = row.cells[cell_nb].data
except IndexError:
warning_list.append("No comment was defined")
return {'comment': comment, 'warning_list': warning_list}
|