1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
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.
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.
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/>.
20 ##############################################################################
25 from _common import ceiling
27 from openerp import SUPERUSER_ID
28 from openerp import tools
29 from openerp.osv import osv, fields
30 from openerp.tools.translate import _
31 from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT
33 import openerp.addons.decimal_precision as dp
35 def ean_checksum(eancode):
36 """returns the checksum of an ean string of length 13, returns -1 if the string has the wrong length"""
37 if len(eancode) != 13:
43 reversevalue = eanvalue[::-1]
44 finalean=reversevalue[1:]
46 for i in range(len(finalean)):
48 oddsum += int(finalean[i])
50 evensum += int(finalean[i])
51 total=(oddsum * 3) + evensum
53 check = int(10 - math.ceil(total % 10.0)) %10
56 def check_ean(eancode):
57 """returns True if eancode is a valid ean13 string, or null"""
60 if len(eancode) != 13:
66 return ean_checksum(eancode) == int(eancode[-1])
68 def sanitize_ean13(ean13):
69 """Creates and returns a valid ean13 from an invalid one"""
71 return "0000000000000"
72 ean13 = re.sub("[A-Za-z]","0",ean13);
73 ean13 = re.sub("[^0-9]","",ean13);
76 ean13 = ean13 + '0' * (13-len(ean13))
77 return ean13[:-1] + str(ean_checksum(ean13))
79 #----------------------------------------------------------
81 #----------------------------------------------------------
83 class product_uom_categ(osv.osv):
84 _name = 'product.uom.categ'
85 _description = 'Product uom categ'
87 'name': fields.char('Name', required=True, translate=True),
90 class product_uom(osv.osv):
92 _description = 'Product Unit of Measure'
94 def _compute_factor_inv(self, factor):
95 return factor and (1.0 / factor) or 0.0
97 def _factor_inv(self, cursor, user, ids, name, arg, context=None):
99 for uom in self.browse(cursor, user, ids, context=context):
100 res[uom.id] = self._compute_factor_inv(uom.factor)
103 def _factor_inv_write(self, cursor, user, id, name, value, arg, context=None):
104 return self.write(cursor, user, id, {'factor': self._compute_factor_inv(value)}, context=context)
106 def name_create(self, cr, uid, name, context=None):
107 """ The UoM category and factor are required, so we'll have to add temporary values
108 for imported UoMs """
109 uom_categ = self.pool.get('product.uom.categ')
110 # look for the category based on the english name, i.e. no context on purpose!
111 # TODO: should find a way to have it translated but not created until actually used
112 categ_misc = 'Unsorted/Imported Units'
113 categ_id = uom_categ.search(cr, uid, [('name', '=', categ_misc)])
115 categ_id = categ_id[0]
117 categ_id, _ = uom_categ.name_create(cr, uid, categ_misc)
118 uom_id = self.create(cr, uid, {self._rec_name: name,
119 'category_id': categ_id,
121 return self.name_get(cr, uid, [uom_id], context=context)[0]
123 def create(self, cr, uid, data, context=None):
124 if 'factor_inv' in data:
125 if data['factor_inv'] != 1:
126 data['factor'] = self._compute_factor_inv(data['factor_inv'])
127 del(data['factor_inv'])
128 return super(product_uom, self).create(cr, uid, data, context)
132 'name': fields.char('Unit of Measure', required=True, translate=True),
133 'category_id': fields.many2one('product.uom.categ', 'Product Category', required=True, ondelete='cascade',
134 help="Conversion between Units of Measure can only occur if they belong to the same category. The conversion will be made based on the ratios."),
135 'factor': fields.float('Ratio', required=True,digits=(12, 12),
136 help='How much bigger or smaller this unit is compared to the reference Unit of Measure for this category:\n'\
137 '1 * (reference unit) = ratio * (this unit)'),
138 'factor_inv': fields.function(_factor_inv, digits=(12,12),
139 fnct_inv=_factor_inv_write,
140 string='Bigger Ratio',
141 help='How many times this Unit of Measure is bigger than the reference Unit of Measure in this category:\n'\
142 '1 * (this unit) = ratio * (reference unit)', required=True),
143 'rounding': fields.float('Rounding Precision', digits_compute=dp.get_precision('Product Unit of Measure'), required=True,
144 help="The computed quantity will be a multiple of this value. "\
145 "Use 1.0 for a Unit of Measure that cannot be further split, such as a piece."),
146 'active': fields.boolean('Active', help="By unchecking the active field you can disable a unit of measure without deleting it."),
147 'uom_type': fields.selection([('bigger','Bigger than the reference Unit of Measure'),
148 ('reference','Reference Unit of Measure for this category'),
149 ('smaller','Smaller than the reference Unit of Measure')],'Type', required=1),
155 'uom_type': 'reference',
159 ('factor_gt_zero', 'CHECK (factor!=0)', 'The conversion ratio for a unit of measure cannot be 0!')
162 def _compute_qty(self, cr, uid, from_uom_id, qty, to_uom_id=False, round=True):
163 if not from_uom_id or not qty or not to_uom_id:
165 uoms = self.browse(cr, uid, [from_uom_id, to_uom_id])
166 if uoms[0].id == from_uom_id:
167 from_unit, to_unit = uoms[0], uoms[-1]
169 from_unit, to_unit = uoms[-1], uoms[0]
170 return self._compute_qty_obj(cr, uid, from_unit, qty, to_unit, round=round)
172 def _compute_qty_obj(self, cr, uid, from_unit, qty, to_unit, round=True, context=None):
175 if from_unit.category_id.id != to_unit.category_id.id:
176 if context.get('raise-exception', True):
177 raise osv.except_osv(_('Error!'), _('Conversion from Product UoM %s to Default UoM %s is not possible as they both belong to different Category!.') % (from_unit.name,to_unit.name,))
180 amount = qty / from_unit.factor
182 amount = amount * to_unit.factor
184 amount = ceiling(amount, to_unit.rounding)
187 def _compute_price(self, cr, uid, from_uom_id, price, to_uom_id=False):
188 if not from_uom_id or not price or not to_uom_id:
190 from_unit, to_unit = self.browse(cr, uid, [from_uom_id, to_uom_id])
191 if from_unit.category_id.id != to_unit.category_id.id:
193 amount = price * from_unit.factor
195 amount = amount / to_unit.factor
198 def onchange_type(self, cursor, user, ids, value):
199 if value == 'reference':
200 return {'value': {'factor': 1, 'factor_inv': 1}}
203 def write(self, cr, uid, ids, vals, context=None):
204 if 'category_id' in vals:
205 for uom in self.browse(cr, uid, ids, context=context):
206 if uom.category_id.id != vals['category_id']:
207 raise osv.except_osv(_('Warning!'),_("Cannot change the category of existing Unit of Measure '%s'.") % (uom.name,))
208 return super(product_uom, self).write(cr, uid, ids, vals, context=context)
212 class product_ul(osv.osv):
214 _description = "Logistic Unit"
216 'name' : fields.char('Name', select=True, required=True, translate=True),
217 'type' : fields.selection([('unit','Unit'),('pack','Pack'),('box', 'Box'), ('pallet', 'Pallet')], 'Type', required=True),
218 'height': fields.float('Height', help='The height of the package'),
219 'width': fields.float('Width', help='The width of the package'),
220 'length': fields.float('Length', help='The length of the package'),
221 'weight': fields.float('Empty Package Weight'),
225 #----------------------------------------------------------
227 #----------------------------------------------------------
228 class product_category(osv.osv):
230 def name_get(self, cr, uid, ids, context=None):
231 if isinstance(ids, (list, tuple)) and not len(ids):
233 if isinstance(ids, (long, int)):
235 reads = self.read(cr, uid, ids, ['name','parent_id'], context=context)
238 name = record['name']
239 if record['parent_id']:
240 name = record['parent_id'][1]+' / '+name
241 res.append((record['id'], name))
244 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
250 # Be sure name_search is symetric to name_get
251 name = name.split(' / ')[-1]
252 ids = self.search(cr, uid, [('name', operator, name)] + args, limit=limit, context=context)
254 ids = self.search(cr, uid, args, limit=limit, context=context)
255 return self.name_get(cr, uid, ids, context)
257 def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
258 res = self.name_get(cr, uid, ids, context=context)
261 _name = "product.category"
262 _description = "Product Category"
264 'name': fields.char('Name', required=True, translate=True, select=True),
265 'complete_name': fields.function(_name_get_fnc, type="char", string='Name'),
266 'parent_id': fields.many2one('product.category','Parent Category', select=True, ondelete='cascade'),
267 'child_id': fields.one2many('product.category', 'parent_id', string='Child Categories'),
268 'sequence': fields.integer('Sequence', select=True, help="Gives the sequence order when displaying a list of product categories."),
269 'type': fields.selection([('view','View'), ('normal','Normal')], 'Category Type', help="A category of the view type is a virtual category that can be used as the parent of another category to create a hierarchical structure."),
270 'parent_left': fields.integer('Left Parent', select=1),
271 'parent_right': fields.integer('Right Parent', select=1),
276 'type' : lambda *a : 'normal',
279 _parent_name = "parent_id"
281 _parent_order = 'sequence, name'
282 _order = 'parent_left'
285 (osv.osv._check_recursion, 'Error ! You cannot create recursive categories.', ['parent_id'])
289 class produce_price_history(osv.osv):
291 Keep track of the ``product.template`` standard prices as they are changed.
294 _name = 'product.price.history'
295 _rec_name = 'datetime'
296 _order = 'datetime desc'
299 'company_id': fields.many2one('res.company', required=True),
300 'product_template_id': fields.many2one('product.template', 'Product Template', required=True, ondelete='cascade'),
301 'datetime': fields.datetime('Historization Time'),
302 'cost': fields.float('Historized Cost'),
303 'reason': fields.char('Reason'),
306 def _get_default_company(self, cr, uid, context=None):
307 if 'force_company' in context:
308 return context['force_company']
310 company = self.pool['res.users'].browse(cr, uid, uid,
311 context=context).company_id
312 return company.id if company else False
315 'datetime': fields.datetime.now,
316 'company_id': _get_default_company,
320 class product_public_category(osv.osv):
321 _name = "product.public.category"
322 _description = "Public Category"
323 _order = "sequence, name"
326 (osv.osv._check_recursion, 'Error ! You cannot create recursive categories.', ['parent_id'])
329 def name_get(self, cr, uid, ids, context=None):
332 reads = self.read(cr, uid, ids, ['name','parent_id'], context=context)
335 name = record['name']
336 if record['parent_id']:
337 name = record['parent_id'][1]+' / '+name
338 res.append((record['id'], name))
341 def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
342 res = self.name_get(cr, uid, ids, context=context)
345 def _get_image(self, cr, uid, ids, name, args, context=None):
346 result = dict.fromkeys(ids, False)
347 for obj in self.browse(cr, uid, ids, context=context):
348 result[obj.id] = tools.image_get_resized_images(obj.image)
351 def _set_image(self, cr, uid, id, name, value, args, context=None):
352 return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
355 'name': fields.char('Name', required=True, translate=True),
356 'complete_name': fields.function(_name_get_fnc, type="char", string='Name'),
357 'parent_id': fields.many2one('product.public.category','Parent Category', select=True),
358 'child_id': fields.one2many('product.public.category', 'parent_id', string='Children Categories'),
359 'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of product categories."),
361 # NOTE: there is no 'default image', because by default we don't show thumbnails for categories. However if we have a thumbnail
362 # for at least one category, then we display a default image on the other, so that the buttons have consistent styling.
363 # In this case, the default image is set by the js code.
364 # NOTE2: image: all image fields are base64 encoded and PIL-supported
365 'image': fields.binary("Image",
366 help="This field holds the image used as image for the cateogry, limited to 1024x1024px."),
367 'image_medium': fields.function(_get_image, fnct_inv=_set_image,
368 string="Medium-sized image", type="binary", multi="_get_image",
370 'product.public.category': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
372 help="Medium-sized image of the category. It is automatically "\
373 "resized as a 128x128px image, with aspect ratio preserved. "\
374 "Use this field in form views or some kanban views."),
375 'image_small': fields.function(_get_image, fnct_inv=_set_image,
376 string="Smal-sized image", type="binary", multi="_get_image",
378 'product.public.category': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
380 help="Small-sized image of the category. It is automatically "\
381 "resized as a 64x64px image, with aspect ratio preserved. "\
382 "Use this field anywhere a small image is required."),
386 #----------------------------------------------------------
388 #----------------------------------------------------------
389 class product_template(osv.osv):
390 _name = "product.template"
391 _inherit = ['mail.thread']
392 _description = "Product Template"
394 def _get_image(self, cr, uid, ids, name, args, context=None):
395 result = dict.fromkeys(ids, False)
396 for obj in self.browse(cr, uid, ids, context=context):
397 result[obj.id] = tools.image_get_resized_images(obj.image, avoid_resize_medium=True)
400 def _set_image(self, cr, uid, id, name, value, args, context=None):
401 return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
404 'name': fields.char('Name', required=True, translate=True, select=True),
405 'product_manager': fields.many2one('res.users','Product Manager'),
406 'description': fields.text('Description',translate=True,
407 help="A precise description of the Product, used only for internal information purposes."),
408 'description_purchase': fields.text('Purchase Description',translate=True,
409 help="A description of the Product that you want to communicate to your suppliers. "
410 "This description will be copied to every Purchase Order, Reception and Supplier Invoice/Refund."),
411 'description_sale': fields.text('Sale Description',translate=True,
412 help="A description of the Product that you want to communicate to your customers. "
413 "This description will be copied to every Sale Order, Delivery Order and Customer Invoice/Refund"),
414 'type': fields.selection([('consu', 'Consumable'),('service','Service')], 'Product Type', required=True, help="Consumable are product where you don't manage stock, a service is a non-material product provided by a company or an individual."),
415 'rental': fields.boolean('Can be Rent'),
416 'categ_id': fields.many2one('product.category','Category', required=True, change_default=True, domain="[('type','=','normal')]" ,help="Select category for the current product"),
417 'public_categ_id': fields.many2one('product.public.category','Public Category', help="Those categories are used to group similar products for public sales (eg.: point of sale, e-commerce)."),
418 'list_price': fields.float('Sale Price', digits_compute=dp.get_precision('Product Price'), help="Base price to compute the customer price. Sometimes called the catalog price."),
419 'standard_price': fields.property(type = 'float', digits_compute=dp.get_precision('Product Price'),
420 help="Cost price of the product template used for standard stock valuation in accounting and used as a base price on purchase orders.",
421 groups="base.group_user", string="Cost Price"),
422 'volume': fields.float('Volume', help="The volume in m3."),
423 'weight': fields.float('Gross Weight', digits_compute=dp.get_precision('Stock Weight'), help="The gross weight in Kg."),
424 'weight_net': fields.float('Net Weight', digits_compute=dp.get_precision('Stock Weight'), help="The net weight in Kg."),
425 'warranty': fields.float('Warranty'),
426 'sale_ok': fields.boolean('Can be Sold', help="Specify if the product can be selected in a sales order line."),
427 'state': fields.selection([('',''),
428 ('draft', 'In Development'),
429 ('sellable','Normal'),
430 ('end','End of Lifecycle'),
431 ('obsolete','Obsolete')], 'Status'),
432 'uom_id': fields.many2one('product.uom', 'Unit of Measure', required=True, help="Default Unit of Measure used for all stock operation."),
433 'uom_po_id': fields.many2one('product.uom', 'Purchase Unit of Measure', required=True, help="Default Unit of Measure used for purchase orders. It must be in the same category than the default unit of measure."),
434 'uos_id' : fields.many2one('product.uom', 'Unit of Sale',
435 help='Specify a unit of measure here if invoicing is made in another unit of measure than inventory. Keep empty to use the default unit of measure.'),
436 'uos_coeff': fields.float('Unit of Measure -> UOS Coeff', digits_compute= dp.get_precision('Product UoS'),
437 help='Coefficient to convert default Unit of Measure to Unit of Sale\n'
438 ' uos = uom * coeff'),
439 'mes_type': fields.selection((('fixed', 'Fixed'), ('variable', 'Variable')), 'Measure Type'),
440 'seller_ids': fields.one2many('product.supplierinfo', 'product_tmpl_id', 'Supplier'),
441 'company_id': fields.many2one('res.company', 'Company', select=1),
442 # image: all image fields are base64 encoded and PIL-supported
443 'image': fields.binary("Image",
444 help="This field holds the image used as image for the product, limited to 1024x1024px."),
445 'image_medium': fields.function(_get_image, fnct_inv=_set_image,
446 string="Medium-sized image", type="binary", multi="_get_image",
448 'product.template': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
450 help="Medium-sized image of the product. It is automatically "\
451 "resized as a 128x128px image, with aspect ratio preserved, "\
452 "only when the image exceeds one of those sizes. Use this field in form views or some kanban views."),
453 'image_small': fields.function(_get_image, fnct_inv=_set_image,
454 string="Small-sized image", type="binary", multi="_get_image",
456 'product.template': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
458 help="Small-sized image of the product. It is automatically "\
459 "resized as a 64x64px image, with aspect ratio preserved. "\
460 "Use this field anywhere a small image is required."),
461 'product_variant_ids': fields.one2many('product.product', 'product_tmpl_id', 'Product Variants', required=True),
464 def _get_uom_id(self, cr, uid, *args):
465 cr.execute('select id from product_uom order by id limit 1')
467 return res and res[0] or False
469 def _default_category(self, cr, uid, context=None):
472 if 'categ_id' in context and context['categ_id']:
473 return context['categ_id']
474 md = self.pool.get('ir.model.data')
477 res = md.get_object_reference(cr, uid, 'product', 'product_category_all')[1]
482 def onchange_uom(self, cursor, user, ids, uom_id, uom_po_id):
484 return {'value': {'uom_po_id': uom_id}}
487 def create(self, cr, uid, vals, context=None):
488 ''' Store the initial standard price in order to be able to retrieve the cost of a product template for a given date'''
489 product_template_id = super(product_template, self).create(cr, uid, vals, context=context)
490 price_history_obj = self.pool['product.price.history']
491 price_history_obj.create(cr, uid, {
492 'product_template_id': product_template_id,
493 'cost': vals.get('standard_price', 0.0),
494 'reason': _('Product template created and standard price set'),
496 return product_template_id
498 def write(self, cr, uid, ids, vals, context=None):
499 ''' Store the standard price change in order to be able to retrieve the cost of a product template for a given date'''
500 if 'uom_po_id' in vals:
501 new_uom = self.pool.get('product.uom').browse(cr, uid, vals['uom_po_id'], context=context)
502 for product in self.browse(cr, uid, ids, context=context):
503 old_uom = product.uom_po_id
504 if old_uom.category_id.id != new_uom.category_id.id:
505 raise osv.except_osv(_('Unit of Measure categories Mismatch!'), _("New Unit of Measure '%s' must belong to same Unit of Measure category '%s' as of old Unit of Measure '%s'. If you need to change the unit of measure, you may deactivate this product from the 'Procurements' tab and create a new one.") % (new_uom.name, old_uom.category_id.name, old_uom.name,))
506 if 'standard_price' in vals:
507 price_history_obj = self.pool['product.price.history']
508 for prod_template_id in ids:
509 price_history_obj.create(cr, uid, {
510 'product_template_id': prod_template_id,
511 'cost': vals['standard_price'],
512 'reason': _('standard price is changed.'),
514 return super(product_template, self).write(cr, uid, ids, vals, context=context)
516 def copy(self, cr, uid, id, default=None, context=None):
519 template = self.browse(cr, uid, id, context=context)
520 default['name'] = _("%s (copy)") % (template['name'])
521 return super(product_template, self).copy(cr, uid, id, default=default, context=context)
524 'company_id': lambda s,cr,uid,c: s.pool.get('res.company')._company_default_get(cr, uid, 'product.template', context=c),
526 'standard_price': 0.0,
528 'uom_id': _get_uom_id,
529 'uom_po_id': _get_uom_id,
532 'categ_id' : _default_category,
536 def _check_uom(self, cursor, user, ids, context=None):
537 for product in self.browse(cursor, user, ids, context=context):
538 if product.uom_id.category_id.id != product.uom_po_id.category_id.id:
542 def _check_uos(self, cursor, user, ids, context=None):
543 for product in self.browse(cursor, user, ids, context=context):
545 and product.uos_id.category_id.id \
546 == product.uom_id.category_id.id:
551 (_check_uom, 'Error: The default Unit of Measure and the purchase Unit of Measure must be in the same category.', ['uom_id']),
554 def name_get(self, cr, user, ids, context=None):
557 if 'partner_id' in context:
559 return super(product_template, self).name_get(cr, user, ids, context)
562 class product_product(osv.osv):
563 _name = "product.product"
564 _description = "Product"
565 _inherits = {'product.template': 'product_tmpl_id'}
566 _inherit = ['mail.thread']
567 _order = 'default_code,name_template'
569 def view_header_get(self, cr, uid, view_id, view_type, context=None):
572 res = super(product_product, self).view_header_get(cr, uid, view_id, view_type, context)
573 if (context.get('categ_id', False)):
574 return _('Products: ') + self.pool.get('product.category').browse(cr, uid, context['categ_id'], context=context).name
577 def get_history_price(self, cr, uid, product_id, company_id, date=None, context=None):
581 date = time.strftime(DEFAULT_SERVER_DATETIME_FORMAT)
582 product = self.browse(cr, uid, product_id, context=context)
583 price_history_obj = self.pool.get('product.price.history')
584 history_ids = price_history_obj.search(cr, uid, [('company_id', '=', company_id), ('product_template_id', '=', product.product_tmpl_id.id), ('datetime', '<=', date)], limit=1)
586 return price_history_obj.read(cr, uid, history_ids[0], ['cost'], context=context)['cost']
587 raise osv.except_osv(_('Error!'), _("No standard price associated for product %s for the given date" % (product.name)))
589 def _product_price(self, cr, uid, ids, name, arg, context=None):
590 plobj = self.pool.get('product.pricelist')
594 quantity = context.get('quantity') or 1.0
595 pricelist = context.get('pricelist', False)
596 partner = context.get('partner', False)
598 # Support context pricelists specified as display_name or ID for compatibility
599 if isinstance(pricelist, basestring):
600 pricelist_ids = plobj.name_search(
601 cr, uid, pricelist, operator='=', context=context, limit=1)
602 pricelist = pricelist_ids[0][0] if pricelist_ids else pricelist
604 if isinstance(pricelist, (int, long)):
605 products = self.browse(cr, uid, ids, context=context)
606 qtys = map(lambda x: (x, quantity, partner), products)
607 pl = plobj.browse(cr, uid, pricelist, context=context)
608 price = plobj._price_get_multi(cr,uid, pl, qtys, context=context)
610 res[id] = price.get(id, 0.0)
612 res.setdefault(id, 0.0)
615 def _product_lst_price(self, cr, uid, ids, name, arg, context=None):
616 res = dict.fromkeys(ids, 0.0)
617 product_uom_obj = self.pool.get('product.uom')
621 if context.get('pricelist'):
622 pricelist = self.pool['product.pricelist'].browse(cr, uid, context.get('pricelist'), context=context)
623 base_currency = self.pool['res.users'].browse(cr, uid, uid, context=context).company_id.currency_id
625 for product in self.browse(cr, uid, ids, context=context):
627 uom = product.uos_id or product.uom_id
628 res[product.id] = product_uom_obj._compute_price(cr, uid,
629 uom.id, product.list_price, context['uom'])
631 res[product.id] = product.list_price
632 res[product.id] = (res[product.id] or 0.0) * (product.price_margin or 1.0) + product.price_extra
633 # update the result, according to the eventual pricelist currency
634 if pricelist and pricelist.currency_id:
635 res[product.id] = self.pool['res.currency'].compute(
636 cr, uid, base_currency.id, pricelist.currency_id.id, res[product.id], round=False, context=context)
639 def _save_product_lst_price(self, cr, uid, product_id, field_name, field_value, arg, context=None):
640 field_value = field_value or 0.0
641 product = self.browse(cr, uid, product_id, context=context)
642 list_price = (field_value - product.price_extra) / (product.price_margin or 1.0)
643 return self.write(cr, uid, [product_id], {'list_price': list_price}, context=context)
646 def _get_partner_code_name(self, cr, uid, ids, product, partner_id, context=None):
647 for supinfo in product.seller_ids:
648 if supinfo.name.id == partner_id:
649 return {'code': supinfo.product_code or product.default_code, 'name': supinfo.product_name or product.name, 'variants': ''}
650 res = {'code': product.default_code, 'name': product.name, 'variants': product.variants}
653 def _product_code(self, cr, uid, ids, name, arg, context=None):
657 for p in self.browse(cr, uid, ids, context=context):
658 res[p.id] = self._get_partner_code_name(cr, uid, [], p, context.get('partner_id', None), context=context)['code']
661 def _product_partner_ref(self, cr, uid, ids, name, arg, context=None):
665 for p in self.browse(cr, uid, ids, context=context):
666 data = self._get_partner_code_name(cr, uid, [], p, context.get('partner_id', None), context=context)
667 if not data['variants']:
668 data['variants'] = p.variants
670 data['code'] = p.code
672 data['name'] = p.name
673 res[p.id] = (data['code'] and ('['+data['code']+'] ') or '') + \
674 (data['name'] or '') + (data['variants'] and (' - '+data['variants']) or '')
677 def _is_only_child(self, cr, uid, ids, name, arg, context=None):
678 res = dict.fromkeys(ids, True)
679 for product in self.browse(cr, uid, ids, context=context):
680 if product.product_tmpl_id and len(product.product_tmpl_id.product_variant_ids) > 1:
681 res[product.id] = False
684 def _get_main_product_supplier(self, cr, uid, product, context=None):
685 """Determines the main (best) product supplier for ``product``,
686 returning the corresponding ``supplierinfo`` record, or False
687 if none were found. The default strategy is to select the
688 supplier with the highest priority (i.e. smallest sequence).
690 :param browse_record product: product to supply
691 :rtype: product.supplierinfo browse_record or False
693 sellers = [(seller_info.sequence, seller_info)
694 for seller_info in product.seller_ids or []
695 if seller_info and isinstance(seller_info.sequence, (int, long))]
696 return sellers and sellers[0][1] or False
698 def _calc_seller(self, cr, uid, ids, fields, arg, context=None):
700 for product in self.browse(cr, uid, ids, context=context):
701 main_supplier = self._get_main_product_supplier(cr, uid, product, context=context)
702 result[product.id] = {
703 'seller_info_id': main_supplier and main_supplier.id or False,
704 'seller_delay': main_supplier.delay if main_supplier else 1,
705 'seller_qty': main_supplier and main_supplier.qty or 0.0,
706 'seller_id': main_supplier and main_supplier.name.id or False
710 def _get_name_template_ids(self, cr, uid, ids, context=None):
712 template_ids = self.pool.get('product.product').search(cr, uid, [('product_tmpl_id', 'in', ids)])
713 for el in template_ids:
718 'price': fields.function(_product_price, fnct_inv=_save_product_lst_price, type='float', string='Price', digits_compute=dp.get_precision('Product Price')),
719 'lst_price' : fields.function(_product_lst_price, fnct_inv=_save_product_lst_price, type='float', string='Public Price', digits_compute=dp.get_precision('Product Price')),
720 'code': fields.function(_product_code, type='char', string='Internal Reference'),
721 'partner_ref' : fields.function(_product_partner_ref, type='char', string='Customer ref'),
722 'default_code' : fields.char('Internal Reference', select=True),
723 'active': fields.boolean('Active', help="If unchecked, it will allow you to hide the product without removing it."),
724 'variants': fields.char('Variants', translate=True),
725 'product_tmpl_id': fields.many2one('product.template', 'Product Template', required=True, ondelete="cascade", select=True),
726 'is_only_child': fields.function(
727 _is_only_child, type='boolean', string='Sole child of the parent template'),
728 'ean13': fields.char('EAN13 Barcode', size=13, help="International Article Number used for product identification."),
729 'packaging': fields.one2many('product.packaging', 'product_id', 'Packaging', help="Gives the different ways to package the same product. This has no impact on the picking order and is mainly used if you use the EDI module."),
730 'price_extra': fields.float('Variant Price Extra', digits_compute=dp.get_precision('Product Price'), help="Price Extra: Extra price for the variant on sale price. eg. 200 price extra, 1000 + 200 = 1200."),
731 'price_margin': fields.float('Variant Price Margin', digits_compute=dp.get_precision('Product Price'), help="Price Margin: Margin in percentage amount on sale price for the variant. eg. 10 price margin, 1000 * 1.1 = 1100."),
732 'pricelist_id': fields.dummy(string='Pricelist', relation='product.pricelist', type='many2one'),
733 'name_template': fields.related('product_tmpl_id', 'name', string="Template Name", type='char', store={
734 'product.template': (_get_name_template_ids, ['name'], 10),
735 'product.product': (lambda self, cr, uid, ids, c=None: ids, [], 10),
737 'color': fields.integer('Color Index'),
738 'seller_info_id': fields.function(_calc_seller, type='many2one', relation="product.supplierinfo", string="Supplier Info", multi="seller_info"),
739 'seller_delay': fields.function(_calc_seller, type='integer', string='Supplier Lead Time', multi="seller_info", help="This is the average delay in days between the purchase order confirmation and the reception of goods for this product and for the default supplier. It is used by the scheduler to order requests based on reordering delays."),
740 'seller_qty': fields.function(_calc_seller, type='float', string='Supplier Quantity', multi="seller_info", help="This is minimum quantity to purchase from Main Supplier."),
741 'seller_id': fields.function(_calc_seller, type='many2one', relation="res.partner", string='Main Supplier', help="Main Supplier who has highest priority in Supplier List.", multi="seller_info"),
745 'active': lambda *a: 1,
746 'price_extra': lambda *a: 0.0,
747 'price_margin': lambda *a: 1.0,
749 'is_only_child': True,
752 def unlink(self, cr, uid, ids, context=None):
754 unlink_product_tmpl_ids = []
755 for product in self.browse(cr, uid, ids, context=context):
756 tmpl_id = product.product_tmpl_id.id
757 # Check if the product is last product of this template
758 other_product_ids = self.search(cr, uid, [('product_tmpl_id', '=', tmpl_id), ('id', '!=', product.id)], context=context)
759 if not other_product_ids:
760 unlink_product_tmpl_ids.append(tmpl_id)
761 unlink_ids.append(product.id)
762 res = super(product_product, self).unlink(cr, uid, unlink_ids, context=context)
763 # delete templates after calling super, as deleting template could lead to deleting
764 # products due to ondelete='cascade'
765 self.pool.get('product.template').unlink(cr, uid, unlink_product_tmpl_ids, context=context)
768 def onchange_uom(self, cursor, user, ids, uom_id, uom_po_id):
769 if uom_id and uom_po_id:
770 uom_obj=self.pool.get('product.uom')
771 uom=uom_obj.browse(cursor,user,[uom_id])[0]
772 uom_po=uom_obj.browse(cursor,user,[uom_po_id])[0]
773 if uom.category_id.id != uom_po.category_id.id:
774 return {'value': {'uom_po_id': uom_id}}
777 def _check_ean_key(self, cr, uid, ids, context=None):
778 for product in self.read(cr, uid, ids, ['ean13'], context=context):
779 res = check_ean(product['ean13'])
782 _constraints = [(_check_ean_key, 'You provided an invalid "EAN13 Barcode" reference. You may use the "Internal Reference" field instead.', ['ean13'])]
784 def on_order(self, cr, uid, ids, orderline, quantity):
787 def name_get(self, cr, user, ids, context=None):
790 if isinstance(ids, (int, long)):
795 name = d.get('name','')
796 code = d.get('default_code',False)
798 name = '[%s] %s' % (code,name)
799 if d.get('variants'):
800 name = name + ' - %s' % (d['variants'],)
801 return (d['id'], name)
803 partner_id = context.get('partner_id', False)
805 # all user don't have access to seller and partner
806 # check access and use superuser
807 self.check_access_rights(cr, user, "read")
808 self.check_access_rule(cr, user, ids, "read", context=context)
811 for product in self.browse(cr, SUPERUSER_ID, ids, context=context):
814 sellers = filter(lambda x: x.name.id == partner_id, product.seller_ids)
819 'name': s.product_name or product.name,
820 'default_code': s.product_code or product.default_code,
821 'variants': product.variants
823 result.append(_name_get(mydict))
827 'name': product.name,
828 'default_code': product.default_code,
829 'variants': product.variants
831 result.append(_name_get(mydict))
834 def name_search(self, cr, user, name='', args=None, operator='ilike', context=None, limit=100):
838 ids = self.search(cr, user, [('default_code','=',name)]+ args, limit=limit, context=context)
840 ids = self.search(cr, user, [('ean13','=',name)]+ args, limit=limit, context=context)
842 # Do not merge the 2 next lines into one single search, SQL search performance would be abysmal
843 # on a database with thousands of matching products, due to the huge merge+unique needed for the
844 # OR operator (and given the fact that the 'name' lookup results come from the ir.translation table
845 # Performing a quick memory merge of ids in Python will give much better performance
846 ids = set(self.search(cr, user, args + [('default_code', operator, name)], limit=limit, context=context))
847 if not limit or len(ids) < limit:
848 # we may underrun the limit because of dupes in the results, that's fine
849 limit2 = (limit - len(ids)) if limit else False
850 ids.update(self.search(cr, user, args + [('name', operator, name)], limit=limit2, context=context))
853 ptrn = re.compile('(\[(.*?)\])')
854 res = ptrn.search(name)
856 ids = self.search(cr, user, [('default_code','=', res.group(2))] + args, limit=limit, context=context)
858 ids = self.search(cr, user, args, limit=limit, context=context)
859 result = self.name_get(cr, user, ids, context=context)
863 # Could be overrided for variants matrices prices
865 def price_get(self, cr, uid, ids, ptype='list_price', context=None):
866 products = self.browse(cr, uid, ids, context=context)
867 return self._price_get(cr, uid, products, ptype=ptype, context=context)
869 def _price_get(self, cr, uid, products, ptype='list_price', context=None):
873 if 'currency_id' in context:
874 pricetype_obj = self.pool.get('product.price.type')
875 price_type_id = pricetype_obj.search(cr, uid, [('field','=',ptype)])[0]
876 price_type_currency_id = pricetype_obj.browse(cr,uid,price_type_id).currency_id.id
879 # standard_price field can only be seen by users in base.group_user
880 # Thus, in order to compute the sale price from the cost price for users not in this group
881 # We fetch the standard price as the superuser
882 for product in products:
883 if ptype != 'standard_price':
884 res[product.id] = product[ptype] or 0.0
886 res[product.id] = self.read(cr, SUPERUSER_ID, product.id, [ptype], context=context)[ptype] or 0.0
888 product_uom_obj = self.pool.get('product.uom')
889 for product in products:
890 if ptype == 'list_price':
891 res[product.id] = (res[product.id] * (product.price_margin or 1.0)) + \
894 uom = product.uom_id or product.uos_id
895 res[product.id] = product_uom_obj._compute_price(cr, uid,
896 uom.id, res[product.id], context['uom'])
897 # Convert from price_type currency to asked one
898 if 'currency_id' in context:
899 # Take the price_type currency from the product field
900 # This is right cause a field cannot be in more than one currency
901 res[product.id] = self.pool.get('res.currency').compute(cr, uid, price_type_currency_id,
902 context['currency_id'], res[product.id],context=context)
906 def copy(self, cr, uid, id, default=None, context=None):
907 context = context or {}
908 default = dict(default or {})
910 # Craft our own `<name> (copy)` in en_US (self.copy_translation()
911 # will do the other languages).
912 context_wo_lang = dict(context or {})
913 context_wo_lang.pop('lang', None)
914 product = self.browse(cr, uid, id, context_wo_lang)
915 if context.get('variant'):
916 # if we copy a variant or create one, we keep the same template
917 default['product_tmpl_id'] = product.product_tmpl_id.id
918 elif 'name' not in default:
919 default['name'] = _("%s (copy)") % (product.name,)
921 return super(product_product, self).copy(cr, uid, id, default=default, context=context)
923 def search(self, cr, uid, args, offset=0, limit=None, order=None, context=None, count=False):
926 if context.get('search_default_categ_id'):
927 args.append((('categ_id', 'child_of', context['search_default_categ_id'])))
928 return super(product_product, self).search(cr, uid, args, offset=offset, limit=limit, order=order, context=context, count=count)
930 def open_product_template(self, cr, uid, ids, context=None):
931 """ Utility method used to add an "Open Template" button in product views """
932 product = self.browse(cr, uid, ids[0], context=context)
933 return {'type': 'ir.actions.act_window',
934 'res_model': 'product.template',
936 'res_id': product.product_tmpl_id.id,
940 class product_packaging(osv.osv):
941 _name = "product.packaging"
942 _description = "Packaging"
946 'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of packaging."),
947 'name' : fields.text('Description'),
948 'qty' : fields.float('Quantity by Package',
949 help="The total number of products you can put by pallet or box."),
950 'ul' : fields.many2one('product.ul', 'Package Logistic Unit', required=True),
951 'ul_qty' : fields.integer('Package by layer', help='The number of packages by layer'),
952 'ul_container': fields.many2one('product.ul', 'Pallet Logistic Unit'),
953 'rows' : fields.integer('Number of Layers', required=True,
954 help='The number of layers on a pallet or box'),
955 'product_id' : fields.many2one('product.product', 'Product', select=1, ondelete='cascade', required=True),
956 'ean' : fields.char('EAN', size=14, help="The EAN code of the package unit."),
957 'code' : fields.char('Code', help="The code of the transport unit."),
958 'weight': fields.float('Total Package Weight',
959 help='The weight of a full package, pallet or box.'),
962 def _check_ean_key(self, cr, uid, ids, context=None):
963 for pack in self.browse(cr, uid, ids, context=context):
964 res = check_ean(pack.ean)
967 _constraints = [(_check_ean_key, 'Error: Invalid ean code', ['ean'])]
969 def name_get(self, cr, uid, ids, context=None):
973 for pckg in self.browse(cr, uid, ids, context=context):
974 p_name = pckg.ean and '[' + pckg.ean + '] ' or ''
975 p_name += pckg.ul.name
976 res.append((pckg.id,p_name))
979 def _get_1st_ul(self, cr, uid, context=None):
980 cr.execute('select id from product_ul order by id asc limit 1')
982 return (res and res[0]) or False
985 'rows' : lambda *a : 3,
986 'sequence' : lambda *a : 1,
991 salt = '31' * 6 + '3'
993 for ean_part, salt_part in zip(ean, salt):
994 sum += int(ean_part) * int(salt_part)
995 return (10 - (sum % 10)) % 10
996 checksum = staticmethod(checksum)
1000 class product_supplierinfo(osv.osv):
1001 _name = "product.supplierinfo"
1002 _description = "Information about a product supplier"
1003 def _calc_qty(self, cr, uid, ids, fields, arg, context=None):
1005 for supplier_info in self.browse(cr, uid, ids, context=context):
1006 for field in fields:
1007 result[supplier_info.id] = {field:False}
1008 qty = supplier_info.min_qty
1009 result[supplier_info.id]['qty'] = qty
1013 'name' : fields.many2one('res.partner', 'Supplier', required=True,domain = [('supplier','=',True)], ondelete='cascade', help="Supplier of this product"),
1014 'product_name': fields.char('Supplier Product Name', help="This supplier's product name will be used when printing a request for quotation. Keep empty to use the internal one."),
1015 'product_code': fields.char('Supplier Product Code', help="This supplier's product code will be used when printing a request for quotation. Keep empty to use the internal one."),
1016 'sequence' : fields.integer('Sequence', help="Assigns the priority to the list of product supplier."),
1017 'product_uom': fields.related('product_tmpl_id', 'uom_po_id', type='many2one', relation='product.uom', string="Supplier Unit of Measure", readonly="1", help="This comes from the product form."),
1018 'min_qty': fields.float('Minimal Quantity', required=True, help="The minimal quantity to purchase to this supplier, expressed in the supplier Product Unit of Measure if not empty, in the default unit of measure of the product otherwise."),
1019 'qty': fields.function(_calc_qty, store=True, type='float', string='Quantity', multi="qty", help="This is a quantity which is converted into Default Unit of Measure."),
1020 'product_tmpl_id' : fields.many2one('product.template', 'Product Template', required=True, ondelete='cascade', select=True, oldname='product_id'),
1021 'delay' : fields.integer('Delivery Lead Time', required=True, help="Lead time in days between the confirmation of the purchase order and the reception of the products in your warehouse. Used by the scheduler for automatic computation of the purchase order planning."),
1022 'pricelist_ids': fields.one2many('pricelist.partnerinfo', 'suppinfo_id', 'Supplier Pricelist'),
1023 'company_id':fields.many2one('res.company','Company',select=1),
1026 'qty': lambda *a: 0.0,
1027 'sequence': lambda *a: 1,
1028 'delay': lambda *a: 1,
1029 'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'product.supplierinfo', context=c),
1031 def price_get(self, cr, uid, supplier_ids, product_id, product_qty=1, context=None):
1033 Calculate price from supplier pricelist.
1034 @param supplier_ids: Ids of res.partner object.
1035 @param product_id: Id of product.
1036 @param product_qty: specify quantity to purchase.
1038 if type(supplier_ids) in (int,long,):
1039 supplier_ids = [supplier_ids]
1041 product_pool = self.pool.get('product.product')
1042 partner_pool = self.pool.get('res.partner')
1043 pricelist_pool = self.pool.get('product.pricelist')
1044 currency_pool = self.pool.get('res.currency')
1045 currency_id = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id.id
1046 # Compute price from standard price of product
1047 product_price = product_pool.price_get(cr, uid, [product_id], 'standard_price', context=context)[product_id]
1048 product = product_pool.browse(cr, uid, product_id, context=context)
1049 for supplier in partner_pool.browse(cr, uid, supplier_ids, context=context):
1050 price = product_price
1051 # Compute price from Purchase pricelist of supplier
1052 pricelist_id = supplier.property_product_pricelist_purchase.id
1054 price = pricelist_pool.price_get(cr, uid, [pricelist_id], product_id, product_qty, context=context).setdefault(pricelist_id, 0)
1055 price = currency_pool.compute(cr, uid, pricelist_pool.browse(cr, uid, pricelist_id).currency_id.id, currency_id, price)
1057 # Compute price from supplier pricelist which are in Supplier Information
1058 supplier_info_ids = self.search(cr, uid, [('name','=',supplier.id),('product_tmpl_id','=',product.product_tmpl_id.id)])
1059 if supplier_info_ids:
1060 cr.execute('SELECT * ' \
1061 'FROM pricelist_partnerinfo ' \
1062 'WHERE suppinfo_id IN %s' \
1063 'AND min_quantity <= %s ' \
1064 'ORDER BY min_quantity DESC LIMIT 1', (tuple(supplier_info_ids),product_qty,))
1065 res2 = cr.dictfetchone()
1067 price = res2['price']
1068 res[supplier.id] = price
1073 class pricelist_partnerinfo(osv.osv):
1074 _name = 'pricelist.partnerinfo'
1076 'name': fields.char('Description'),
1077 'suppinfo_id': fields.many2one('product.supplierinfo', 'Partner Information', required=True, ondelete='cascade'),
1078 'min_quantity': fields.float('Quantity', required=True, help="The minimal quantity to trigger this rule, expressed in the supplier Unit of Measure if any or in the default Unit of Measure of the product otherrwise."),
1079 'price': fields.float('Unit Price', required=True, digits_compute=dp.get_precision('Product Price'), help="This price will be considered as a price for the supplier Unit of Measure if any or the default Unit of Measure of the product otherwise"),
1081 _order = 'min_quantity asc'
1083 class res_currency(osv.osv):
1084 _inherit = 'res.currency'
1086 def _check_main_currency_rounding(self, cr, uid, ids, context=None):
1087 cr.execute('SELECT digits FROM decimal_precision WHERE name like %s',('Account',))
1088 digits = cr.fetchone()
1089 if digits and len(digits):
1091 main_currency = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id
1092 for currency_id in ids:
1093 if currency_id == main_currency.id:
1094 if main_currency.rounding < 10 ** -digits:
1099 (_check_main_currency_rounding, 'Error! You cannot define a rounding factor for the company\'s main currency that is smaller than the decimal precision of \'Account\'.', ['rounding']),
1102 class decimal_precision(osv.osv):
1103 _inherit = 'decimal.precision'
1105 def _check_main_currency_rounding(self, cr, uid, ids, context=None):
1106 cr.execute('SELECT id, digits FROM decimal_precision WHERE name like %s',('Account',))
1108 if res and len(res):
1109 account_precision_id, digits = res
1110 main_currency = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id
1111 for decimal_precision in ids:
1112 if decimal_precision == account_precision_id:
1113 if main_currency.rounding < 10 ** -digits:
1118 (_check_main_currency_rounding, 'Error! You cannot define the decimal precision of \'Account\' as greater than the rounding factor of the company\'s main currency', ['digits']),
1121 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: