-
Notifications
You must be signed in to change notification settings - Fork 5
/
channel.py
490 lines (411 loc) · 14.8 KB
/
channel.py
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
# -*- coding: utf-8 -*-
"""
sale_channel.py
:copyright: (c) 2015 by Openlabs Technologies & Consulting (P) Limited
:license: BSD, see LICENSE for more details.
"""
from trytond.pool import PoolMeta, Pool
from trytond.transaction import Transaction
from trytond.exceptions import UserError
from trytond.pyson import Eval, Bool
from trytond.model import ModelView, fields, ModelSQL
__metaclass__ = PoolMeta
__all__ = [
'SaleChannel', 'ReadUser', 'WriteUser', 'ChannelException',
'ChannelOrderState'
]
STATES = {
'readonly': ~Eval('active', True),
}
DEPENDS = ['active']
PRODUCT_STATES = {
'invisible': ~(Eval('source') != 'manual'),
'required': Eval('source') != 'manual',
}
INVISIBLE_IF_MANUAL = {
'invisible': Eval('source') == 'manual',
}
class SaleChannel(ModelSQL, ModelView):
"""
Sale Channel model
"""
__name__ = 'sale.channel'
name = fields.Char(
'Name', required=True, select=True, states=STATES, depends=DEPENDS
)
code = fields.Char(
'Code', select=True, states={'readonly': Eval('code', True)},
depends=['code']
)
active = fields.Boolean('Active', select=True)
company = fields.Many2One(
'company.company', 'Company', required=True, select=True,
states=STATES, depends=DEPENDS
)
address = fields.Many2One(
'party.address', 'Address', domain=[
('party', '=', Eval('company_party')),
], depends=['company_party']
)
source = fields.Selection(
'get_source', 'Source', required=True, states=STATES, depends=DEPENDS
)
read_users = fields.Many2Many(
'sale.channel-read-res.user', 'channel', 'user', 'Read Users'
)
create_users = fields.Many2Many(
'sale.channel-write-res.user', 'channel', 'user', 'Create Users'
)
warehouse = fields.Many2One(
'stock.location', "Warehouse", required=True,
domain=[('type', '=', 'warehouse')]
)
invoice_method = fields.Selection(
[
('manual', 'Manual'),
('order', 'On Order Processed'),
('shipment', 'On Shipment Sent')
], 'Invoice Method', required=True
)
shipment_method = fields.Selection(
[
('manual', 'Manual'),
('order', 'On Order Processed'),
('invoice', 'On Invoice Paid'),
], 'Shipment Method', required=True
)
currency = fields.Many2One(
'currency.currency', 'Currency', required=True
)
price_list = fields.Many2One(
'product.price_list', 'Price List', required=True
)
payment_term = fields.Many2One(
'account.invoice.payment_term', 'Payment Term', required=True
)
company_party = fields.Function(
fields.Many2One('party.party', 'Company Party'),
'on_change_with_company_party'
)
# These fields would be needed at the time of product imports from
# external channel
default_uom = fields.Many2One(
'product.uom', 'Default Product UOM',
states=PRODUCT_STATES, depends=['source']
)
exceptions = fields.One2Many(
'channel.exception', 'channel', 'Exceptions'
)
order_states = fields.One2Many(
"sale.channel.order_state", "channel", "Order States"
)
last_order_import_time = fields.DateTime(
'Last Order Import Time',
depends=['source', 'last_order_import_time_required'], states={
'invisible': Eval('source') == 'manual',
'required': Bool(Eval('last_order_import_time_required'))
}
)
last_order_export_time = fields.DateTime(
"Last Order Export Time", states=INVISIBLE_IF_MANUAL,
depends=['source']
)
last_shipment_export_time = fields.DateTime(
'Last shipment export time', states=INVISIBLE_IF_MANUAL,
depends=['source']
)
last_product_price_export_time = fields.DateTime(
'Last Product Price Export Time', states=INVISIBLE_IF_MANUAL,
depends=['source']
)
last_product_export_time = fields.DateTime(
'Last Product Export Time', states=INVISIBLE_IF_MANUAL,
depends=['source']
)
last_order_import_time_required = fields.Function(
fields.DateTime('Last Order Import Time Required'),
'get_last_order_import_time_required'
)
def get_last_order_import_time_required(self, name):
"""
Returns True or False if last_order_import_time field should be required
or not
"""
return False
@classmethod
def __setup__(cls):
"""
Setup the class before adding to pool
"""
super(SaleChannel, cls).__setup__()
cls._buttons.update({
'import_data_button': {},
'import_order_states_button': {},
})
@staticmethod
def default_default_uom():
Uom = Pool().get('product.uom')
unit = Uom.search([('name', '=', 'Unit')])
return unit and unit[0].id or None
@classmethod
def get_source(cls):
"""
Get the source
"""
return [('manual', 'Manual')]
@staticmethod
def default_active():
return True
@staticmethod
def default_currency():
pool = Pool()
Company = pool.get('company.company')
Channel = pool.get('sale.channel')
company_id = Channel.default_company()
company = Company(company_id)
return company.currency.id
@staticmethod
def default_company():
return Transaction().context.get('company')
@fields.depends('company')
def on_change_with_company_party(self, name=None):
Company = Pool().get('company.company')
company = self.company
if not company:
company = Company(SaleChannel.default_company()) # pragma: nocover
return company and company.party.id or None
def export_product_prices(self):
"""
Export product prices to channel
Since external channels are implemented by downstream modules, it is
the responsibility of those channels to reuse this method or call super.
:return: List of active records of products for which prices are
exported
"""
raise self.raise_user_error(
"This feature has not been implemented for %s channel yet."
% self.source
)
@classmethod
def import_orders_using_cron(cls, channels): # pragma: nocover
"""
Cron method to import orders from channels using cron
Downstream module need not to implement this method.
It will automatically call import_orders of the channel
Silently pass if import_orders is not implemented
"""
for channel in channels:
try:
channel.import_orders()
except UserError:
# Silently pass if method is not implemented
pass
@classmethod
def export_product_prices_using_cron(cls, channels): # pragma: nocover
"""
Cron method to export product prices to external channel using cron
Downstream module need not to implement this method.
It will automatically call export_product_prices method of the channel.
Silently pass if export_product_prices is not implemented
"""
for channel in channels:
try:
channel.export_product_prices()
except UserError:
# Silently pass if method is not implemented
pass
def import_orders(self):
"""
Import orders from external channel.
Since external channels are implemented by downstream modules, it is
the responsibility of those channels to implement importing or call
super to delegate.
:return: List of active records of sale orders that are imported
"""
raise self.raise_user_error(
"Import orders is not implemented for %s channels" % self.source
)
def import_order(self, order_info):
"""
Import specific order from external channel based on order_info.
Since external channels are implemented by downstream modules, it is
the responsibility of those channels to implement importing or call
super to delegate.
:param order_info: The type of order_info depends on the channel. It
could be an integer ID, a dictionary or anything.
:return: imported sale order active record
"""
raise self.raise_user_error(
"Import order is not implemented for %s channels" % self.source
)
def import_products(self):
"""
Import Products from external channel.
Since external channels are implemented by downstream modules, it is
the responsibility of those channels to implement importing or call
super to delegate.
:return: List of active records of products that are imported
"""
raise self.raise_user_error(
"Method import_products is not implemented for %s channel yet"
% self.source
) # pragma: nocover
def import_product(self, identifier):
"""
Import specific product from external channel based on product
identifier.
Since external channels are implemented by downstream modules, it is
the responsibility of those channels to implement importing or call
super to delegate.
:param identifier: product code or sku
:return: imported product active record
"""
raise self.raise_user_error(
"Method import_product is not implemented for %s channel yet"
% self.source
) # pragma: nocover
@classmethod
@ModelView.button_action('sale_channel.wizard_import_data')
def import_data_button(cls, channels):
pass # pragma: nocover
@classmethod
@ModelView.button_action('sale_channel.wizard_import_order_states')
def import_order_states_button(cls, channels):
"""
Import order states for current channel
:param channels: List of active records of channels
"""
pass
def import_order_states(self):
"""
Imports order states for current channel
Since external channels are implemented by downstream modules, it is
the responsibility of those channels to implement importing or call
super to delegate.
"""
raise self.raise_user_error(
"This feature has not been implemented for %s channel yet"
% self.source
)
def get_tryton_action(self, name):
"""
Get the tryton action corresponding to the channel state
as per the predefined logic.
Downstream modules need to inherit method and map states as per
convenience.
:param name: Name of channel state
:returns: A dictionary of tryton action and shipment and invoice methods
"""
return {
'action': 'do_not_import',
'invoice_method': 'manual',
'shipment_method': 'manual'
}
def create_order_state(self, code, name):
"""
This method creates order state for channel with given state code and
state name. If state already exist, return same.
:param code: State code used by external channel
:param name: State name used by external channel
:return: Active record of order state created or found
"""
OrderState = Pool().get('sale.channel.order_state')
order_states = OrderState.search([
('code', '=', code),
('channel', '=', self.id)
])
if order_states:
return order_states[0]
values = self.get_tryton_action(code)
values.update({
'name': name,
'code': code,
'channel': self.id,
})
return OrderState.create([values])[0]
class ReadUser(ModelSQL):
"""
Read Users for Sale Channel
"""
__name__ = 'sale.channel-read-res.user'
channel = fields.Many2One(
'sale.channel', 'Channel', ondelete='CASCADE', select=True,
required=True
)
user = fields.Many2One(
'res.user', 'User', ondelete='RESTRICT', required=True
)
class WriteUser(ModelSQL):
"""
Write Users for Sale Channel
"""
__name__ = 'sale.channel-write-res.user'
channel = fields.Many2One(
'sale.channel', 'Channel', ondelete='CASCADE', select=True,
required=True
)
user = fields.Many2One(
'res.user', 'User', ondelete='RESTRICT', required=True
)
class ChannelException(ModelSQL, ModelView):
"""
Channel Exception model
"""
__name__ = 'channel.exception'
origin = fields.Reference(
"Origin", selection='models_get', select=True, readonly=True
)
log = fields.Text('Exception Log', readonly=True)
channel = fields.Many2One(
"sale.channel", "Channel", required=True, readonly=True
)
is_resolved = fields.Boolean("Is Resolved ?", select=True)
@staticmethod
def default_is_resolved():
return False
@classmethod
def models_get(cls):
'''
Return valid models allowed for origin
'''
return [
('sale.sale', 'Sale'),
('sale.line', 'Sale Line'),
]
class ChannelOrderState(ModelSQL, ModelView):
"""
Sale Channel - Tryton Order State map
This model stores a map of order states between tryton and sale channel.
This allows the user to configure the states mapping according to his/her
convenience. This map is used to process orders in tryton when they are
imported. This is also used to map the order status back to channel when
sales are exported. This also allows the user to determine in which state
order need to be imported.
"""
__name__ = 'sale.channel.order_state'
name = fields.Char('Name', required=True, readonly=True)
code = fields.Char('Code', required=True, readonly=True)
action = fields.Selection([
('do_not_import', 'Do Not Import'),
('process_automatically', 'Process Automatically'),
('process_manually', 'Process Manually'),
('import_as_past', 'Import As Past Orders'),
], 'Action', required=True)
invoice_method = fields.Selection([
('manual', 'Manual'),
('order', 'On Order Processed'),
('shipment', 'On Shipment Sent'),
], 'Invoice Method', required=True)
shipment_method = fields.Selection([
('manual', 'Manual'),
('order', 'On Order Processed'),
('invoice', 'On Invoice Paid'),
], 'Shipment Method', required=True)
channel = fields.Many2One(
'sale.channel', 'Sale Channel', required=True,
ondelete="CASCADE", readonly=True
)
@staticmethod
def default_channel():
"Return default channel from context"
return Transaction().context.get('current_channel')