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
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
from datetime import datetime
from odoo.http import Controller, request, route
class SaleProductConfiguratorController(Controller):
@route(route='/sale/product_configurator/get_values', type='json', auth='user')
def sale_product_configurator_get_values(
self,
product_template_id,
quantity,
currency_id,
so_date,
product_uom_id=None,
company_id=None,
pricelist_id=None,
ptav_ids=None,
only_main_product=False,
**kwargs,
):
""" Return all product information needed for the product configurator.
:param int product_template_id: The product for which to seek information, as a
`product.template` id.
:param int quantity: The quantity of the product.
:param int currency_id: The currency of the transaction, as a `res.currency` id.
:param str so_date: The date of the `sale.order`, to compute the price at the right rate.
:param int|None product_uom_id: The unit of measure of the product, as a `uom.uom` id.
:param int|None company_id: The company to use, as a `res.company` id.
:param int|None pricelist_id: The pricelist to use, as a `product.pricelist` id.
:param list(int)|None ptav_ids: The combination of the product, as a list of
`product.template.attribute.value` ids.
:param bool only_main_product: Whether the optional products should be included or not.
:param dict kwargs: Locally unused data passed to `_get_product_information`.
:rtype: dict
:return: A dict containing a list of products and a list of optional products information,
generated by :meth:`_get_product_information`.
"""
if company_id:
request.update_context(allowed_company_ids=[company_id])
product_template = request.env['product.template'].browse(product_template_id)
combination = request.env['product.template.attribute.value']
if ptav_ids:
combination = request.env['product.template.attribute.value'].browse(ptav_ids).filtered(
lambda ptav: ptav.product_tmpl_id.id == product_template_id
)
# Set missing attributes (unsaved no_variant attributes, or new attribute on existing product)
unconfigured_ptals = (
product_template.attribute_line_ids - combination.attribute_line_id).filtered(
lambda ptal: ptal.attribute_id.display_type != 'multi')
combination += unconfigured_ptals.mapped(
lambda ptal: ptal.product_template_value_ids._only_active()[:1]
)
if not combination:
combination = product_template._get_first_possible_combination()
currency = request.env['res.currency'].browse(currency_id)
pricelist = request.env['product.pricelist'].browse(pricelist_id)
so_date = datetime.fromisoformat(so_date)
return dict(
products=[
dict(
**self._get_product_information(
product_template,
combination,
currency,
pricelist,
so_date,
quantity=quantity,
product_uom_id=product_uom_id,
**kwargs,
),
)
],
optional_products=[
dict(
**self._get_product_information(
optional_product_template,
optional_product_template._get_first_possible_combination(
parent_combination=combination
),
currency,
pricelist,
so_date,
# giving all the ptav of the parent product to get all the exclusions
parent_combination=product_template.attribute_line_ids.\
product_template_value_ids,
**kwargs,
),
parent_product_tmpl_id=product_template.id,
) for optional_product_template in product_template.optional_product_ids if
self._should_show_product(optional_product_template, combination)
] if not only_main_product else [],
currency_id=currency_id,
)
@route(
route='/sale/product_configurator/create_product',
type='json',
auth='user',
methods=['POST'],
)
def sale_product_configurator_create_product(self, product_template_id, ptav_ids):
""" Create the product when there is a dynamic attribute in the combination.
:param int product_template_id: The product for which to seek information, as a
`product.template` id.
:param list(int) ptav_ids: The combination of the product, as a list of
`product.template.attribute.value` ids.
:rtype: int
:return: The product created, as a `product.product` id.
"""
product_template = request.env['product.template'].browse(product_template_id)
combination = request.env['product.template.attribute.value'].browse(ptav_ids)
product = product_template._create_product_variant(combination)
return product.id
@route(
route='/sale/product_configurator/update_combination',
type='json',
auth='user',
methods=['POST'],
)
def sale_product_configurator_update_combination(
self,
product_template_id,
ptav_ids,
currency_id,
so_date,
quantity,
product_uom_id=None,
company_id=None,
pricelist_id=None,
**kwargs,
):
""" Return the updated combination information.
:param int product_template_id: The product for which to seek information, as a
`product.template` id.
:param list(int) ptav_ids: The combination of the product, as a list of
`product.template.attribute.value` ids.
:param int currency_id: The currency of the transaction, as a `res.currency` id.
:param str so_date: The date of the `sale.order`, to compute the price at the right rate.
:param int quantity: The quantity of the product.
:param int|None product_uom_id: The unit of measure of the product, as a `uom.uom` id.
:param int|None company_id: The company to use, as a `res.company` id.
:param int|None pricelist_id: The pricelist to use, as a `product.pricelist` id.
:param dict kwargs: Locally unused data passed to `_get_basic_product_information`.
:rtype: dict
:return: Basic informations about a product, generated by
:meth:`_get_basic_product_information`.
"""
if company_id:
request.update_context(allowed_company_ids=[company_id])
product_template = request.env['product.template'].browse(product_template_id)
pricelist = request.env['product.pricelist'].browse(pricelist_id)
product_uom = request.env['uom.uom'].browse(product_uom_id)
currency = request.env['res.currency'].browse(currency_id)
combination = request.env['product.template.attribute.value'].browse(ptav_ids)
product = product_template._get_variant_for_combination(combination)
return self._get_basic_product_information(
product or product_template,
pricelist,
combination,
quantity=quantity or 0.0,
uom=product_uom,
currency=currency,
date=datetime.fromisoformat(so_date),
**kwargs,
)
@route(route='/sale/product_configurator/get_optional_products', type='json', auth='user')
def sale_product_configurator_get_optional_products(
self,
product_template_id,
ptav_ids,
parent_ptav_ids,
currency_id,
so_date,
company_id=None,
pricelist_id=None,
**kwargs,
):
""" Return information about optional products for the given `product.template`.
:param int product_template_id: The product for which to seek information, as a
`product.template` id.
:param list(int) ptav_ids: The combination of the product, as a list of
`product.template.attribute.value` ids.
:param list(int) parent_ptav_ids: The combination of the parent product, as a list of
`product.template.attribute.value` ids.
:param int currency_id: The currency of the transaction, as a `res.currency` id.
:param str so_date: The date of the `sale.order`, to compute the price at the right rate.
:param int|None company_id: The company to use, as a `res.company` id.
:param int|None pricelist_id: The pricelist to use, as a `product.pricelist` id.
:param dict kwargs: Locally unused data passed to `_get_product_information`.
:rtype: [dict]
:return: A list of optional products information, generated by
:meth:`_get_product_information`.
"""
if company_id:
request.update_context(allowed_company_ids=[company_id])
product_template = request.env['product.template'].browse(product_template_id)
parent_combination = request.env['product.template.attribute.value'].browse(
parent_ptav_ids + ptav_ids
)
currency = request.env['res.currency'].browse(currency_id)
pricelist = request.env['product.pricelist'].browse(pricelist_id)
return [
dict(
**self._get_product_information(
optional_product_template,
optional_product_template._get_first_possible_combination(
parent_combination=parent_combination
),
currency,
pricelist,
datetime.fromisoformat(so_date),
parent_combination=parent_combination,
**kwargs,
),
parent_product_tmpl_id=product_template.id,
) for optional_product_template in product_template.optional_product_ids if
self._should_show_product(optional_product_template, parent_combination)
]
def _get_product_information(
self,
product_template,
combination,
currency,
pricelist,
so_date,
quantity=1,
product_uom_id=None,
parent_combination=None,
**kwargs,
):
""" Return complete information about a product.
:param product.template product_template: The product for which to seek information.
:param product.template.attribute.value combination: The combination of the product.
:param res.currency currency: The currency of the transaction.
:param product.pricelist pricelist: The pricelist to use.
:param datetime so_date: The date of the `sale.order`, to compute the price at the right
rate.
:param int quantity: The quantity of the product.
:param int|None product_uom_id: The unit of measure of the product, as a `uom.uom` id.
:param product.template.attribute.value|None parent_combination: The combination of the
parent product.
:param dict kwargs: Locally unused data passed to `_get_basic_product_information`.
:rtype: dict
:return: A dict with the following structure:
{
'product_tmpl_id': int,
'id': int,
'description_sale': str|False,
'display_name': str,
'price': float,
'quantity': int
'attribute_line': [{
'id': int
'attribute': {
'id': int
'name': str
'display_type': str
},
'attribute_value': [{
'id': int,
'name': str,
'price_extra': float,
'html_color': str|False,
'image': str|False,
'is_custom': bool
}],
'selected_attribute_id': int,
}],
'exclusions': dict,
'archived_combination': dict,
'parent_exclusions': dict,
}
"""
product_uom = request.env['uom.uom'].browse(product_uom_id)
product = product_template._get_variant_for_combination(combination)
attribute_exclusions = product_template._get_attribute_exclusions(
parent_combination=parent_combination,
combination_ids=combination.ids,
)
product_or_template = product or product_template
return dict(
product_tmpl_id=product_template.id,
**self._get_basic_product_information(
product_or_template,
pricelist,
combination,
quantity=quantity,
uom=product_uom,
currency=currency,
date=so_date,
**kwargs,
),
quantity=quantity,
attribute_lines=[dict(
id=ptal.id,
attribute=dict(**ptal.attribute_id.read(['id', 'name', 'display_type'])[0]),
attribute_values=[
dict(
**ptav.read(['name', 'html_color', 'image', 'is_custom'])[0],
price_extra=self._get_ptav_price_extra(
ptav, currency, so_date, product_or_template
),
) for ptav in ptal.product_template_value_ids
if ptav.ptav_active or combination and ptav.id in combination.ids
],
selected_attribute_value_ids=combination.filtered(
lambda c: ptal in c.attribute_line_id
).ids,
create_variant=ptal.attribute_id.create_variant,
) for ptal in product_template.attribute_line_ids],
exclusions=attribute_exclusions['exclusions'],
archived_combinations=attribute_exclusions['archived_combinations'],
parent_exclusions=attribute_exclusions['parent_exclusions'],
)
def _get_basic_product_information(self, product_or_template, pricelist, combination, **kwargs):
""" Return basic information about a product.
:param product.product|product.template product_or_template: The product for which to seek
information.
:param product.pricelist pricelist: The pricelist to use.
:param product.template.attribute.value combination: The combination of the product.
:param dict kwargs: Locally unused data passed to `_get_product_price`.
:rtype: dict
:return: A dict with the following structure:
{
'id': int, # if product_or_template is a record of `product.product`.
'description_sale': str|False,
'display_name': str,
'price': float,
}
"""
basic_information = dict(
**product_or_template.read(['description_sale', 'display_name'])[0]
)
# If the product is a template, check the combination to compute the name to take dynamic
# and no_variant attributes into account. Also, drop the id which was auto-included by the
# search but isn't relevant since it is supposed to be the id of a `product.product` record.
if not product_or_template.is_product_variant:
basic_information['id'] = False
combination_name = combination._get_combination_name()
if combination_name:
basic_information.update(
display_name=f"{basic_information['display_name']} ({combination_name})"
)
return dict(
**basic_information,
price=request.env['product.template']._get_configurator_display_price(
product_or_template.with_context(
**product_or_template._get_product_price_context(combination)
),
pricelist=pricelist,
**kwargs,
),
**request.env['product.template']._get_additional_configurator_data(
product_or_template, pricelist=pricelist, **kwargs
),
)
def _get_ptav_price_extra(self, ptav, currency, date, product_or_template):
""" Hook which returns the extra price for a product template attribute value.
:param product.template.attribute.value ptav: The product template attribute value for which
to compute the extra price.
:param res.currency currency: The currency to compute the extra price in.
:param datetime date: The date to compute the extra price at.
:param product.product|product.template product_or_template: The product on which the
product template attribute value applies.
:rtype: float
:return: The extra price for the product template attribute value.
"""
return ptav.currency_id._convert(
ptav.price_extra,
currency,
request.env.company,
date.date(),
)
def _should_show_product(self, product_template, parent_combination):
""" Hook which returns whether a product should be shown in the configurator.
:param product.template product_template: The product being checked.
:param product.template.attribute.value parent_combination: The combination of the parent
product.
:rtype: bool
:return: Whether the product should be shown in the configurator.
"""
return True
|
