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, orm, fields
30 from openerp.tools.translate import _
32 import openerp.addons.decimal_precision as dp
34 def ean_checksum(eancode):
35 """returns the checksum of an ean string of length 13, returns -1 if the string has the wrong length"""
36 if len(eancode) != 13:
42 reversevalue = eanvalue[::-1]
43 finalean=reversevalue[1:]
45 for i in range(len(finalean)):
47 oddsum += int(finalean[i])
49 evensum += int(finalean[i])
50 total=(oddsum * 3) + evensum
52 check = int(10 - math.ceil(total % 10.0)) %10
55 def check_ean(eancode):
56 """returns True if eancode is a valid ean13 string, or null"""
59 if len(eancode) != 13:
65 return ean_checksum(eancode) == int(eancode[-1])
67 def sanitize_ean13(ean13):
68 """Creates and returns a valid ean13 from an invalid one"""
70 return "0000000000000"
71 ean13 = re.sub("[A-Za-z]","0",ean13);
72 ean13 = re.sub("[^0-9]","",ean13);
75 ean13 = ean13 + '0' * (13-len(ean13))
76 return ean13[:-1] + str(ean_checksum(ean13))
78 #----------------------------------------------------------
80 #----------------------------------------------------------
82 class product_uom_categ(osv.osv):
83 _name = 'product.uom.categ'
84 _description = 'Product uom categ'
86 'name': fields.char('Name', required=True, translate=True),
89 class product_uom(osv.osv):
91 _description = 'Product Unit of Measure'
93 def _compute_factor_inv(self, factor):
94 return factor and (1.0 / factor) or 0.0
96 def _factor_inv(self, cursor, user, ids, name, arg, context=None):
98 for uom in self.browse(cursor, user, ids, context=context):
99 res[uom.id] = self._compute_factor_inv(uom.factor)
102 def _factor_inv_write(self, cursor, user, id, name, value, arg, context=None):
103 return self.write(cursor, user, id, {'factor': self._compute_factor_inv(value)}, context=context)
105 def name_create(self, cr, uid, name, context=None):
106 """ The UoM category and factor are required, so we'll have to add temporary values
107 for imported UoMs """
108 uom_categ = self.pool.get('product.uom.categ')
109 # look for the category based on the english name, i.e. no context on purpose!
110 # TODO: should find a way to have it translated but not created until actually used
111 categ_misc = 'Unsorted/Imported Units'
112 categ_id = uom_categ.search(cr, uid, [('name', '=', categ_misc)])
114 categ_id = categ_id[0]
116 categ_id, _ = uom_categ.name_create(cr, uid, categ_misc)
117 uom_id = self.create(cr, uid, {self._rec_name: name,
118 'category_id': categ_id,
120 return self.name_get(cr, uid, [uom_id], context=context)[0]
122 def create(self, cr, uid, data, context=None):
123 if 'factor_inv' in data:
124 if data['factor_inv'] != 1:
125 data['factor'] = self._compute_factor_inv(data['factor_inv'])
126 del(data['factor_inv'])
127 return super(product_uom, self).create(cr, uid, data, context)
131 'name': fields.char('Unit of Measure', required=True, translate=True),
132 'category_id': fields.many2one('product.uom.categ', 'Product Category', required=True, ondelete='cascade',
133 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."),
134 'factor': fields.float('Ratio', required=True,digits=(12, 12),
135 help='How much bigger or smaller this unit is compared to the reference Unit of Measure for this category:\n'\
136 '1 * (reference unit) = ratio * (this unit)'),
137 'factor_inv': fields.function(_factor_inv, digits=(12,12),
138 fnct_inv=_factor_inv_write,
139 string='Bigger Ratio',
140 help='How many times this Unit of Measure is bigger than the reference Unit of Measure in this category:\n'\
141 '1 * (this unit) = ratio * (reference unit)', required=True),
142 'rounding': fields.float('Rounding Precision', digits_compute=dp.get_precision('Product Unit of Measure'), required=True,
143 help="The computed quantity will be a multiple of this value. "\
144 "Use 1.0 for a Unit of Measure that cannot be further split, such as a piece."),
145 'active': fields.boolean('Active', help="By unchecking the active field you can disable a unit of measure without deleting it."),
146 'uom_type': fields.selection([('bigger','Bigger than the reference Unit of Measure'),
147 ('reference','Reference Unit of Measure for this category'),
148 ('smaller','Smaller than the reference Unit of Measure')],'Type', required=1),
154 'uom_type': 'reference',
158 ('factor_gt_zero', 'CHECK (factor!=0)', 'The conversion ratio for a unit of measure cannot be 0!')
161 def _compute_qty(self, cr, uid, from_uom_id, qty, to_uom_id=False, round=True):
162 if not from_uom_id or not qty or not to_uom_id:
164 uoms = self.browse(cr, uid, [from_uom_id, to_uom_id])
165 if uoms[0].id == from_uom_id:
166 from_unit, to_unit = uoms[0], uoms[-1]
168 from_unit, to_unit = uoms[-1], uoms[0]
169 return self._compute_qty_obj(cr, uid, from_unit, qty, to_unit, round=round)
171 def _compute_qty_obj(self, cr, uid, from_unit, qty, to_unit, round=True, context=None):
174 if from_unit.category_id.id != to_unit.category_id.id:
175 if context.get('raise-exception', True):
176 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,))
179 amount = qty / from_unit.factor
181 amount = amount * to_unit.factor
183 amount = ceiling(amount * to_unit.factor, to_unit.rounding)
186 def _compute_price(self, cr, uid, from_uom_id, price, to_uom_id=False):
187 if not from_uom_id or not price or not to_uom_id:
189 uoms = self.browse(cr, uid, [from_uom_id, to_uom_id])
190 if uoms[0].id == from_uom_id:
191 from_unit, to_unit = uoms[0], uoms[-1]
193 from_unit, to_unit = uoms[-1], uoms[0]
194 if from_unit.category_id.id != to_unit.category_id.id:
196 amount = price * from_unit.factor
198 amount = amount / to_unit.factor
201 def onchange_type(self, cursor, user, ids, value):
202 if value == 'reference':
203 return {'value': {'factor': 1, 'factor_inv': 1}}
206 def write(self, cr, uid, ids, vals, context=None):
207 if 'category_id' in vals:
208 for uom in self.browse(cr, uid, ids, context=context):
209 if uom.category_id.id != vals['category_id']:
210 raise osv.except_osv(_('Warning!'),_("Cannot change the category of existing Unit of Measure '%s'.") % (uom.name,))
211 return super(product_uom, self).write(cr, uid, ids, vals, context=context)
215 class product_ul(osv.osv):
217 _description = "Shipping Unit"
219 'name' : fields.char('Name', select=True, required=True, translate=True),
220 'type' : fields.selection([('unit','Unit'),('pack','Pack'),('box', 'Box'), ('pallet', 'Pallet')], 'Type', required=True),
224 #----------------------------------------------------------
226 #----------------------------------------------------------
227 class product_category(osv.osv):
229 def name_get(self, cr, uid, ids, context=None):
230 if isinstance(ids, (list, tuple)) and not len(ids):
232 if isinstance(ids, (long, int)):
234 reads = self.read(cr, uid, ids, ['name','parent_id'], context=context)
237 name = record['name']
238 if record['parent_id']:
239 name = record['parent_id'][1]+' / '+name
240 res.append((record['id'], name))
243 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
249 # Be sure name_search is symetric to name_get
250 name = name.split(' / ')[-1]
251 ids = self.search(cr, uid, [('name', operator, name)] + args, limit=limit, context=context)
253 ids = self.search(cr, uid, args, limit=limit, context=context)
254 return self.name_get(cr, uid, ids, context)
256 def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
257 res = self.name_get(cr, uid, ids, context=context)
260 _name = "product.category"
261 _description = "Product Category"
263 'name': fields.char('Name', required=True, translate=True, select=True),
264 'complete_name': fields.function(_name_get_fnc, type="char", string='Name'),
265 'parent_id': fields.many2one('product.category','Parent Category', select=True, ondelete='cascade'),
266 'child_id': fields.one2many('product.category', 'parent_id', string='Child Categories'),
267 'sequence': fields.integer('Sequence', select=True, help="Gives the sequence order when displaying a list of product categories."),
268 '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."),
269 'parent_left': fields.integer('Left Parent', select=1),
270 'parent_right': fields.integer('Right Parent', select=1),
275 'type' : lambda *a : 'normal',
278 _parent_name = "parent_id"
280 _parent_order = 'sequence, name'
281 _order = 'parent_left'
284 (osv.osv._check_recursion, 'Error ! You cannot create recursive categories.', ['parent_id'])
288 class prices_history(osv.osv):
290 Keep track of the ``product.template`` standard prices as they are changed.
293 _name = 'prices.history'
294 _rec_name = 'datetime'
295 _order = 'datetime desc'
298 'company_id': fields.many2one('res.company', required=True),
299 'product_template_id': fields.many2one('product.template', 'Product Template', required=True),
300 'datetime': fields.datetime('Historization Time'),
301 'cost': fields.float('Historized Cost'),
302 'reason': fields.char('Reason'),
305 def _get_default_company(self, cr, uid, context=None):
306 if 'force_company' in context:
307 return context['force_company']
309 company = self.pool['res.users'].browse(cr, uid, uid,
310 context=context).company_id
311 return company.id if company else False
314 'datetime': fields.datetime.now,
315 'company_id': _get_default_company,
319 class product_public_category(osv.osv):
320 _name = "product.public.category"
321 _description = "Public Category"
322 _order = "sequence, name"
325 (osv.osv._check_recursion, 'Error ! You cannot create recursive categories.', ['parent_id'])
328 def name_get(self, cr, uid, ids, context=None):
331 reads = self.read(cr, uid, ids, ['name','parent_id'], context=context)
334 name = record['name']
335 if record['parent_id']:
336 name = record['parent_id'][1]+' / '+name
337 res.append((record['id'], name))
340 def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
341 res = self.name_get(cr, uid, ids, context=context)
344 def _get_image(self, cr, uid, ids, name, args, context=None):
345 result = dict.fromkeys(ids, False)
346 for obj in self.browse(cr, uid, ids, context=context):
347 result[obj.id] = tools.image_get_resized_images(obj.image)
350 def _set_image(self, cr, uid, id, name, value, args, context=None):
351 return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
354 'name': fields.char('Name', required=True, translate=True),
355 'complete_name': fields.function(_name_get_fnc, type="char", string='Name'),
356 'parent_id': fields.many2one('product.public.category','Parent Category', select=True),
357 'child_id': fields.one2many('product.public.category', 'parent_id', string='Children Categories'),
358 'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of product categories."),
360 # NOTE: there is no 'default image', because by default we don't show thumbnails for categories. However if we have a thumbnail
361 # for at least one category, then we display a default image on the other, so that the buttons have consistent styling.
362 # In this case, the default image is set by the js code.
363 # NOTE2: image: all image fields are base64 encoded and PIL-supported
364 'image': fields.binary("Image",
365 help="This field holds the image used as image for the cateogry, limited to 1024x1024px."),
366 'image_medium': fields.function(_get_image, fnct_inv=_set_image,
367 string="Medium-sized image", type="binary", multi="_get_image",
369 'product.public.category': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
371 help="Medium-sized image of the category. It is automatically "\
372 "resized as a 128x128px image, with aspect ratio preserved. "\
373 "Use this field in form views or some kanban views."),
374 'image_small': fields.function(_get_image, fnct_inv=_set_image,
375 string="Smal-sized image", type="binary", multi="_get_image",
377 'product.public.category': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
379 help="Small-sized image of the category. It is automatically "\
380 "resized as a 64x64px image, with aspect ratio preserved. "\
381 "Use this field anywhere a small image is required."),
385 #----------------------------------------------------------
387 #----------------------------------------------------------
388 class product_template(osv.osv):
389 _name = "product.template"
390 _inherit = ['mail.thread']
391 _description = "Product Template"
393 def _get_image(self, cr, uid, ids, name, args, context=None):
394 result = dict.fromkeys(ids, False)
395 for obj in self.browse(cr, uid, ids, context=context):
396 result[obj.id] = tools.image_get_resized_images(obj.image, avoid_resize_medium=True)
399 def _set_image(self, cr, uid, id, name, value, args, context=None):
400 return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
403 'name': fields.char('Name', required=True, translate=True, select=True),
404 'product_manager': fields.many2one('res.users','Product Manager'),
405 'description': fields.text('Description',translate=True,
406 help="A precise description of the Product, used only for internal information purposes."),
407 'description_purchase': fields.text('Purchase Description',translate=True,
408 help="A description of the Product that you want to communicate to your suppliers. "
409 "This description will be copied to every Purchase Order, Reception and Supplier Invoice/Refund."),
410 'description_sale': fields.text('Sale Description',translate=True,
411 help="A description of the Product that you want to communicate to your customers. "
412 "This description will be copied to every Sale Order, Delivery Order and Customer Invoice/Refund"),
413 '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."),
414 'rental': fields.boolean('Can be Rent'),
415 'categ_id': fields.many2one('product.category','Category', required=True, change_default=True, domain="[('type','=','normal')]" ,help="Select category for the current product"),
416 '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)."),
417 '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."),
418 'standard_price': fields.property(type = 'float', digits_compute=dp.get_precision('Product Price'),
419 help="Cost price of the product template used for standard stock valuation in accounting and used as a base price on purchase orders.",
420 groups="base.group_user", string="Cost Price"),
421 'volume': fields.float('Volume', help="The volume in m3."),
422 'weight': fields.float('Gross Weight', digits_compute=dp.get_precision('Stock Weight'), help="The gross weight in Kg."),
423 'weight_net': fields.float('Net Weight', digits_compute=dp.get_precision('Stock Weight'), help="The net weight in Kg."),
424 'warranty': fields.float('Warranty'),
425 'sale_ok': fields.boolean('Can be Sold', help="Specify if the product can be selected in a sales order line."),
426 'state': fields.selection([('',''),
427 ('draft', 'In Development'),
428 ('sellable','Normal'),
429 ('end','End of Lifecycle'),
430 ('obsolete','Obsolete')], 'Status'),
431 'uom_id': fields.many2one('product.uom', 'Unit of Measure', required=True, help="Default Unit of Measure used for all stock operation."),
432 '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."),
433 'uos_id' : fields.many2one('product.uom', 'Unit of Sale',
434 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.'),
435 'uos_coeff': fields.float('Unit of Measure -> UOS Coeff', digits_compute= dp.get_precision('Product UoS'),
436 help='Coefficient to convert default Unit of Measure to Unit of Sale\n'
437 ' uos = uom * coeff'),
438 'mes_type': fields.selection((('fixed', 'Fixed'), ('variable', 'Variable')), 'Measure Type'),
439 'seller_ids': fields.one2many('product.supplierinfo', 'product_tmpl_id', 'Supplier'),
440 'company_id': fields.many2one('res.company', 'Company', select=1),
441 # image: all image fields are base64 encoded and PIL-supported
442 'image': fields.binary("Image",
443 help="This field holds the image used as image for the product, limited to 1024x1024px."),
444 'image_medium': fields.function(_get_image, fnct_inv=_set_image,
445 string="Medium-sized image", type="binary", multi="_get_image",
447 'product.template': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
449 help="Medium-sized image of the product. It is automatically "\
450 "resized as a 128x128px image, with aspect ratio preserved, "\
451 "only when the image exceeds one of those sizes. Use this field in form views or some kanban views."),
452 'image_small': fields.function(_get_image, fnct_inv=_set_image,
453 string="Small-sized image", type="binary", multi="_get_image",
455 'product.template': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
457 help="Small-sized image of the product. It is automatically "\
458 "resized as a 64x64px image, with aspect ratio preserved. "\
459 "Use this field anywhere a small image is required."),
460 'product_variant_ids': fields.one2many('product.product', 'product_tmpl_id', 'Product Variants', required=True),
463 def _get_uom_id(self, cr, uid, *args):
464 cr.execute('select id from product_uom order by id limit 1')
466 return res and res[0] or False
468 def _default_category(self, cr, uid, context=None):
471 if 'categ_id' in context and context['categ_id']:
472 return context['categ_id']
473 md = self.pool.get('ir.model.data')
476 res = md.get_object_reference(cr, uid, 'product', 'product_category_all')[1]
481 def onchange_uom(self, cursor, user, ids, uom_id, uom_po_id):
483 return {'value': {'uom_po_id': uom_id}}
486 def create(self, cr, uid, vals, context=None):
487 ''' Store the initial standard price in order to be able to retrieve the cost of a product template for a given date'''
488 product_template_id = super(product_template, self).create(cr, uid, vals, context=context)
489 price_history_obj = self.pool['prices.history']
490 price_history_obj.create(cr, uid, {
491 'product_template_id': product_template_id,
492 'cost': vals.get('standard_price', 0.0),
493 'reason': _('Product template created and standard price set'),
495 return product_template_id
497 def write(self, cr, uid, ids, vals, context=None):
498 ''' Store the standard price change in order to be able to retrieve the cost of a product template for a given date'''
499 if 'uom_po_id' in vals:
500 new_uom = self.pool.get('product.uom').browse(cr, uid, vals['uom_po_id'], context=context)
501 for product in self.browse(cr, uid, ids, context=context):
502 old_uom = product.uom_po_id
503 if old_uom.category_id.id != new_uom.category_id.id:
504 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,))
505 if 'standard_price' in vals:
506 price_history_obj = self.pool['prices.history']
507 for prod_template_id in ids:
508 price_history_obj.create(cr, uid, {
509 'product_template_id': prod_template_id,
510 'cost': vals['standard_price'],
511 'reason': _('standard price is changed.'),
513 return super(product_template, self).write(cr, uid, ids, vals, context=context)
515 def copy(self, cr, uid, id, default=None, context=None):
518 template = self.browse(cr, uid, id, context=context)
519 default['name'] = _("%s (copy)") % (template['name'])
520 return super(product_template, self).copy(cr, uid, id, default=default, context=context)
523 'company_id': lambda s,cr,uid,c: s.pool.get('res.company')._company_default_get(cr, uid, 'product.template', context=c),
525 'standard_price': 0.0,
527 'uom_id': _get_uom_id,
528 'uom_po_id': _get_uom_id,
531 'categ_id' : _default_category,
535 def _check_uom(self, cursor, user, ids, context=None):
536 for product in self.browse(cursor, user, ids, context=context):
537 if product.uom_id.category_id.id != product.uom_po_id.category_id.id:
541 def _check_uos(self, cursor, user, ids, context=None):
542 for product in self.browse(cursor, user, ids, context=context):
544 and product.uos_id.category_id.id \
545 == product.uom_id.category_id.id:
550 (_check_uom, 'Error: The default Unit of Measure and the purchase Unit of Measure must be in the same category.', ['uom_id']),
553 def name_get(self, cr, user, ids, context=None):
556 if 'partner_id' in context:
558 return super(product_template, self).name_get(cr, user, ids, context)
561 class product_product(osv.osv):
562 _name = "product.product"
563 _description = "Product"
564 _inherits = {'product.template': 'product_tmpl_id'}
565 _inherit = ['mail.thread']
566 _order = 'default_code,name_template'
568 def view_header_get(self, cr, uid, view_id, view_type, context=None):
571 res = super(product_product, self).view_header_get(cr, uid, view_id, view_type, context)
572 if (context.get('categ_id', False)):
573 return _('Products: ') + self.pool.get('product.category').browse(cr, uid, context['categ_id'], context=context).name
578 def get_history_price(self, cr, uid, product_id, company_id, context=None):
581 product = self.browse(cr, uid, product_id, context=context)
582 date = context.get('history_date', time.strftime('%Y-%m-%d %H:%M:%S'))
583 prices_history_obj = self.pool.get('prices.history')
584 history_ids = prices_history_obj.search(cr, uid, [('company_id', '=', company_id), ('product_template_id', '=', product.product_tmpl_id.id), ('datetime', '<=', date)], limit=1)
586 return prices_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', 'Logistical Units', 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 product_uom_obj = self.pool.get('product.uom')
880 for product in products:
881 res[product.id] = product[ptype] or 0.0
882 if ptype == 'list_price':
883 res[product.id] = (res[product.id] * (product.price_margin or 1.0)) + \
886 uom = product.uom_id or product.uos_id
887 res[product.id] = product_uom_obj._compute_price(cr, uid,
888 uom.id, res[product.id], context['uom'])
889 # Convert from price_type currency to asked one
890 if 'currency_id' in context:
891 # Take the price_type currency from the product field
892 # This is right cause a field cannot be in more than one currency
893 res[product.id] = self.pool.get('res.currency').compute(cr, uid, price_type_currency_id,
894 context['currency_id'], res[product.id],context=context)
898 def copy(self, cr, uid, id, default=None, context=None):
899 context = context or {}
900 default = dict(default or {})
902 # Craft our own `<name> (copy)` in en_US (self.copy_translation()
903 # will do the other languages).
904 context_wo_lang = dict(context or {})
905 context_wo_lang.pop('lang', None)
906 product = self.browse(cr, uid, id, context_wo_lang)
907 if context.get('variant'):
908 # if we copy a variant or create one, we keep the same template
909 default['product_tmpl_id'] = product.product_tmpl_id.id
910 elif 'name' not in default:
911 default['name'] = _("%s (copy)") % (product.name,)
913 return super(product_product, self).copy(cr, uid, id, default=default, context=context)
915 def search(self, cr, uid, args, offset=0, limit=None, order=None, context=None, count=False):
918 if context.get('search_default_categ_id'):
919 args.append((('categ_id', 'child_of', context['search_default_categ_id'])))
920 return super(product_product, self).search(cr, uid, args, offset=offset, limit=limit, order=order, context=context, count=count)
922 def open_product_template(self, cr, uid, ids, context=None):
923 """ Utility method used to add an "Open Template" button in product views """
924 product = self.browse(cr, uid, ids[0], context=context)
925 return {'type': 'ir.actions.act_window',
926 'res_model': 'product.template',
928 'res_id': product.product_tmpl_id.id,
932 class product_packaging(osv.osv):
933 _name = "product.packaging"
934 _description = "Packaging"
938 'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of packaging."),
939 'name' : fields.text('Description'),
940 'qty' : fields.float('Quantity by Package',
941 help="The total number of products you can put by pallet or box."),
942 'ul' : fields.many2one('product.ul', 'Type of Package', required=True),
943 'ul_qty' : fields.integer('Package by layer', help='The number of packages by layer'),
944 'rows' : fields.integer('Number of Layers', required=True,
945 help='The number of layers on a pallet or box'),
946 'product_id' : fields.many2one('product.product', 'Product', select=1, ondelete='cascade', required=True),
947 'ean' : fields.char('EAN', size=14, help="The EAN code of the package unit."),
948 'code' : fields.char('Code', help="The code of the transport unit."),
949 'weight': fields.float('Total Package Weight',
950 help='The weight of a full package, pallet or box.'),
951 'weight_ul': fields.float('Empty Package Weight'),
952 'height': fields.float('Height', help='The height of the package'),
953 'width': fields.float('Width', help='The width of the package'),
954 'length': fields.float('Length', help='The length of the package'),
958 def _check_ean_key(self, cr, uid, ids, context=None):
959 for pack in self.browse(cr, uid, ids, context=context):
960 res = check_ean(pack.ean)
963 _constraints = [(_check_ean_key, 'Error: Invalid ean code', ['ean'])]
965 def name_get(self, cr, uid, ids, context=None):
969 for pckg in self.browse(cr, uid, ids, context=context):
970 p_name = pckg.ean and '[' + pckg.ean + '] ' or ''
971 p_name += pckg.ul.name
972 res.append((pckg.id,p_name))
975 def _get_1st_ul(self, cr, uid, context=None):
976 cr.execute('select id from product_ul order by id asc limit 1')
978 return (res and res[0]) or False
981 'rows' : lambda *a : 3,
982 'sequence' : lambda *a : 1,
987 salt = '31' * 6 + '3'
989 for ean_part, salt_part in zip(ean, salt):
990 sum += int(ean_part) * int(salt_part)
991 return (10 - (sum % 10)) % 10
992 checksum = staticmethod(checksum)
996 class product_supplierinfo(osv.osv):
997 _name = "product.supplierinfo"
998 _description = "Information about a product supplier"
999 def _calc_qty(self, cr, uid, ids, fields, arg, context=None):
1001 for supplier_info in self.browse(cr, uid, ids, context=context):
1002 for field in fields:
1003 result[supplier_info.id] = {field:False}
1004 qty = supplier_info.min_qty
1005 result[supplier_info.id]['qty'] = qty
1009 'name' : fields.many2one('res.partner', 'Supplier', required=True,domain = [('supplier','=',True)], ondelete='cascade', help="Supplier of this product"),
1010 '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."),
1011 '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."),
1012 'sequence' : fields.integer('Sequence', help="Assigns the priority to the list of product supplier."),
1013 '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."),
1014 '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."),
1015 '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."),
1016 'product_tmpl_id' : fields.many2one('product.template', 'Product Template', required=True, ondelete='cascade', select=True, oldname='product_id'),
1017 '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."),
1018 'pricelist_ids': fields.one2many('pricelist.partnerinfo', 'suppinfo_id', 'Supplier Pricelist'),
1019 'company_id':fields.many2one('res.company','Company',select=1),
1022 'qty': lambda *a: 0.0,
1023 'sequence': lambda *a: 1,
1024 'delay': lambda *a: 1,
1025 'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'product.supplierinfo', context=c),
1027 def price_get(self, cr, uid, supplier_ids, product_id, product_qty=1, context=None):
1029 Calculate price from supplier pricelist.
1030 @param supplier_ids: Ids of res.partner object.
1031 @param product_id: Id of product.
1032 @param product_qty: specify quantity to purchase.
1034 if type(supplier_ids) in (int,long,):
1035 supplier_ids = [supplier_ids]
1037 product_pool = self.pool.get('product.product')
1038 partner_pool = self.pool.get('res.partner')
1039 pricelist_pool = self.pool.get('product.pricelist')
1040 currency_pool = self.pool.get('res.currency')
1041 currency_id = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id.id
1042 # Compute price from standard price of product
1043 product_price = product_pool.price_get(cr, uid, [product_id], 'standard_price', context=context)[product_id]
1044 product = product_pool.browse(cr, uid, product_id, context=context)
1045 for supplier in partner_pool.browse(cr, uid, supplier_ids, context=context):
1046 price = product_price
1047 # Compute price from Purchase pricelist of supplier
1048 pricelist_id = supplier.property_product_pricelist_purchase.id
1050 price = pricelist_pool.price_get(cr, uid, [pricelist_id], product_id, product_qty, context=context).setdefault(pricelist_id, 0)
1051 price = currency_pool.compute(cr, uid, pricelist_pool.browse(cr, uid, pricelist_id).currency_id.id, currency_id, price)
1053 # Compute price from supplier pricelist which are in Supplier Information
1054 supplier_info_ids = self.search(cr, uid, [('name','=',supplier.id),('product_tmpl_id','=',product.product_tmpl_id.id)])
1055 if supplier_info_ids:
1056 cr.execute('SELECT * ' \
1057 'FROM pricelist_partnerinfo ' \
1058 'WHERE suppinfo_id IN %s' \
1059 'AND min_quantity <= %s ' \
1060 'ORDER BY min_quantity DESC LIMIT 1', (tuple(supplier_info_ids),product_qty,))
1061 res2 = cr.dictfetchone()
1063 price = res2['price']
1064 res[supplier.id] = price
1069 class pricelist_partnerinfo(osv.osv):
1070 _name = 'pricelist.partnerinfo'
1072 'name': fields.char('Description'),
1073 'suppinfo_id': fields.many2one('product.supplierinfo', 'Partner Information', required=True, ondelete='cascade'),
1074 '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."),
1075 '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"),
1077 _order = 'min_quantity asc'
1079 class res_currency(osv.osv):
1080 _inherit = 'res.currency'
1082 def _check_main_currency_rounding(self, cr, uid, ids, context=None):
1083 cr.execute('SELECT digits FROM decimal_precision WHERE name like %s',('Account',))
1084 digits = cr.fetchone()
1085 if digits and len(digits):
1087 main_currency = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id
1088 for currency_id in ids:
1089 if currency_id == main_currency.id:
1090 if main_currency.rounding < 10 ** -digits:
1095 (_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']),
1098 class decimal_precision(osv.osv):
1099 _inherit = 'decimal.precision'
1101 def _check_main_currency_rounding(self, cr, uid, ids, context=None):
1102 cr.execute('SELECT id, digits FROM decimal_precision WHERE name like %s',('Account',))
1104 if res and len(res):
1105 account_precision_id, digits = res
1106 main_currency = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id
1107 for decimal_precision in ids:
1108 if decimal_precision == account_precision_id:
1109 if main_currency.rounding < 10 ** -digits:
1114 (_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']),
1117 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: