addons/product/product.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19 #
  20 ##############################################################################
  21
  22 import math
  23 import re
  24
  25 from _common import rounding
  26
  27 from openerp import tools
  28 from openerp.osv import osv, fields
  29 from openerp.tools.translate import _
  30
  31 import openerp.addons.decimal_precision as dp
  32
  33 def ean_checksum(eancode):
  34     """returns the checksum of an ean string of length 13, returns -1 if the string has the wrong length"""
  35     if len(eancode) <> 13:
  36         return -1
  37     oddsum=0
  38     evensum=0
  39     total=0
  40     eanvalue=eancode
  41     reversevalue = eanvalue[::-1]
  42     finalean=reversevalue[1:]
  43
  44     for i in range(len(finalean)):
  45         if i % 2 == 0:
  46             oddsum += int(finalean[i])
  47         else:
  48             evensum += int(finalean[i])
  49     total=(oddsum * 3) + evensum
  50
  51     check = int(10 - math.ceil(total % 10.0)) %10
  52     return check
  53
  54 def check_ean(eancode):
  55     """returns True if eancode is a valid ean13 string, or null"""
  56     if not eancode:
  57         return True
  58     if len(eancode) <> 13:
  59         return False
  60     try:
  61         int(eancode)
  62     except:
  63         return False
  64     return ean_checksum(eancode) == int(eancode[-1])
  65
  66 def sanitize_ean13(ean13):
  67     """Creates and returns a valid ean13 from an invalid one"""
  68     if not ean13:
  69         return "0000000000000"
  70     ean13 = re.sub("[A-Za-z]","0",ean13);
  71     ean13 = re.sub("[^0-9]","",ean13);
  72     ean13 = ean13[:13]
  73     if len(ean13) < 13:
  74         ean13 = ean13 + '0' * (13-len(ean13))
  75     return ean13[:-1] + str(ean_checksum(ean13))
  76
  77 #----------------------------------------------------------
  78 # UOM
  79 #----------------------------------------------------------
  80
  81 class product_uom_categ(osv.osv):
  82     _name = 'product.uom.categ'
  83     _description = 'Product uom categ'
  84     _columns = {
  85         'name': fields.char('Name', size=64, required=True, translate=True),
  86     }
  87
  88 class product_uom(osv.osv):
  89     _name = 'product.uom'
  90     _description = 'Product Unit of Measure'
  91
  92     def _compute_factor_inv(self, factor):
  93         return factor and (1.0 / factor) or 0.0
  94
  95     def _factor_inv(self, cursor, user, ids, name, arg, context=None):
  96         res = {}
  97         for uom in self.browse(cursor, user, ids, context=context):
  98             res[uom.id] = self._compute_factor_inv(uom.factor)
  99         return res
 100
 101     def _factor_inv_write(self, cursor, user, id, name, value, arg, context=None):
 102         return self.write(cursor, user, id, {'factor': self._compute_factor_inv(value)}, context=context)
 103
 104     def name_create(self, cr, uid, name, context=None):
 105         """ The UoM category and factor are required, so we'll have to add temporary values
 106             for imported UoMs """
 107         uom_categ = self.pool.get('product.uom.categ')
 108         # look for the category based on the english name, i.e. no context on purpose!
 109         # TODO: should find a way to have it translated but not created until actually used
 110         categ_misc = 'Unsorted/Imported Units'
 111         categ_id = uom_categ.search(cr, uid, [('name', '=', categ_misc)])
 112         if categ_id:
 113             categ_id = categ_id[0]
 114         else:
 115             categ_id, _ = uom_categ.name_create(cr, uid, categ_misc)
 116         uom_id = self.create(cr, uid, {self._rec_name: name,
 117                                        'category_id': categ_id,
 118                                        'factor': 1})
 119         return self.name_get(cr, uid, [uom_id], context=context)[0]
 120
 121     def create(self, cr, uid, data, context=None):
 122         if 'factor_inv' in data:
 123             if data['factor_inv'] <> 1:
 124                 data['factor'] = self._compute_factor_inv(data['factor_inv'])
 125             del(data['factor_inv'])
 126         return super(product_uom, self).create(cr, uid, data, context)
 127
 128     _order = "name"
 129     _columns = {
 130         'name': fields.char('Unit of Measure', size=64, required=True, translate=True),
 131         'category_id': fields.many2one('product.uom.categ', 'Category', required=True, ondelete='cascade',
 132             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."),
 133         'factor': fields.float('Ratio', required=True,digits=(12, 12),
 134             help='How much bigger or smaller this unit is compared to the reference Unit of Measure for this category:\n'\
 135                     '1 * (reference unit) = ratio * (this unit)'),
 136         'factor_inv': fields.function(_factor_inv, digits=(12,12),
 137             fnct_inv=_factor_inv_write,
 138             string='Ratio',
 139             help='How many times this Unit of Measure is bigger than the reference Unit of Measure in this category:\n'\
 140                     '1 * (this unit) = ratio * (reference unit)', required=True),
 141         'rounding': fields.float('Rounding Precision', digits_compute=dp.get_precision('Product Unit of Measure'), required=True,
 142             help="The computed quantity will be a multiple of this value. "\
 143                  "Use 1.0 for a Unit of Measure that cannot be further split, such as a piece."),
 144         'active': fields.boolean('Active', help="By unchecking the active field you can disable a unit of measure without deleting it."),
 145         'uom_type': fields.selection([('bigger','Bigger than the reference Unit of Measure'),
 146                                       ('reference','Reference Unit of Measure for this category'),
 147                                       ('smaller','Smaller than the reference Unit of Measure')],'Type', required=1),
 148     }
 149
 150     _defaults = {
 151         'active': 1,
 152         'rounding': 0.01,
 153         'uom_type': 'reference',
 154     }
 155
 156     _sql_constraints = [
 157         ('factor_gt_zero', 'CHECK (factor!=0)', 'The conversion ratio for a unit of measure cannot be 0!')
 158     ]
 159
 160     def _compute_qty(self, cr, uid, from_uom_id, qty, to_uom_id=False):
 161         if not from_uom_id or not qty or not to_uom_id:
 162             return qty
 163         uoms = self.browse(cr, uid, [from_uom_id, to_uom_id])
 164         if uoms[0].id == from_uom_id:
 165             from_unit, to_unit = uoms[0], uoms[-1]
 166         else:
 167             from_unit, to_unit = uoms[-1], uoms[0]
 168         return self._compute_qty_obj(cr, uid, from_unit, qty, to_unit)
 169
 170     def _compute_qty_obj(self, cr, uid, from_unit, qty, to_unit, context=None):
 171         if context is None:
 172             context = {}
 173         if from_unit.category_id.id <> to_unit.category_id.id:
 174             if context.get('raise-exception', True):
 175                 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,))
 176             else:
 177                 return qty
 178         amount = qty / from_unit.factor
 179         if to_unit:
 180             amount = rounding(amount * to_unit.factor, to_unit.rounding)
 181         return amount
 182
 183     def _compute_price(self, cr, uid, from_uom_id, price, to_uom_id=False):
 184         if not from_uom_id or not price or not to_uom_id:
 185             return price
 186         uoms = self.browse(cr, uid, [from_uom_id, to_uom_id])
 187         if uoms[0].id == from_uom_id:
 188             from_unit, to_unit = uoms[0], uoms[-1]
 189         else:
 190             from_unit, to_unit = uoms[-1], uoms[0]
 191         if from_unit.category_id.id <> to_unit.category_id.id:
 192             return price
 193         amount = price * from_unit.factor
 194         if to_uom_id:
 195             amount = amount / to_unit.factor
 196         return amount
 197
 198     def onchange_type(self, cursor, user, ids, value):
 199         if value == 'reference':
 200             return {'value': {'factor': 1, 'factor_inv': 1}}
 201         return {}
 202
 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)
 209
 210
 211
 212 class product_ul(osv.osv):
 213     _name = "product.ul"
 214     _description = "Shipping Unit"
 215     _columns = {
 216         'name' : fields.char('Name', size=64,select=True, required=True, translate=True),
 217         'type' : fields.selection([('unit','Unit'),('pack','Pack'),('box', 'Box'), ('pallet', 'Pallet')], 'Type', required=True),
 218     }
 219
 220
 221 #----------------------------------------------------------
 222 # Categories
 223 #----------------------------------------------------------
 224 class product_category(osv.osv):
 225
 226     def name_get(self, cr, uid, ids, context=None):
 227         if isinstance(ids, (list, tuple)) and not len(ids):
 228             return []
 229         if isinstance(ids, (long, int)):
 230             ids = [ids]
 231         reads = self.read(cr, uid, ids, ['name','parent_id'], context=context)
 232         res = []
 233         for record in reads:
 234             name = record['name']
 235             if record['parent_id']:
 236                 name = record['parent_id'][1]+' / '+name
 237             res.append((record['id'], name))
 238         return res
 239
 240     def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
 241         res = self.name_get(cr, uid, ids, context=context)
 242         return dict(res)
 243
 244     _name = "product.category"
 245     _description = "Product Category"
 246     _columns = {
 247         'name': fields.char('Name', size=64, required=True, translate=True, select=True),
 248         'complete_name': fields.function(_name_get_fnc, type="char", string='Name'),
 249         'parent_id': fields.many2one('product.category','Parent Category', select=True, ondelete='cascade'),
 250         'child_id': fields.one2many('product.category', 'parent_id', string='Child Categories'),
 251         'sequence': fields.integer('Sequence', select=True, help="Gives the sequence order when displaying a list of product categories."),
 252         '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."),
 253         'parent_left': fields.integer('Left Parent', select=1),
 254         'parent_right': fields.integer('Right Parent', select=1),
 255     }
 256
 257
 258     _defaults = {
 259         'type' : lambda *a : 'normal',
 260     }
 261
 262     _parent_name = "parent_id"
 263     _parent_store = True
 264     _parent_order = 'sequence, name'
 265     _order = 'parent_left'
 266
 267     def _check_recursion(self, cr, uid, ids, context=None):
 268         level = 100
 269         while len(ids):
 270             cr.execute('select distinct parent_id from product_category where id IN %s',(tuple(ids),))
 271             ids = filter(None, map(lambda x:x[0], cr.fetchall()))
 272             if not level:
 273                 return False
 274             level -= 1
 275         return True
 276
 277     _constraints = [
 278         (_check_recursion, 'Error ! You cannot create recursive categories.', ['parent_id'])
 279     ]
 280     def child_get(self, cr, uid, ids):
 281         return [ids]
 282
 283
 284
 285 #----------------------------------------------------------
 286 # Products
 287 #----------------------------------------------------------
 288 class product_template(osv.osv):
 289     _name = "product.template"
 290     _description = "Product Template"
 291
 292     _columns = {
 293         'name': fields.char('Name', size=128, required=True, translate=True, select=True),
 294         'product_manager': fields.many2one('res.users','Product Manager'),
 295         'description': fields.text('Description',translate=True,
 296             help="A precise description of the Product, used only for internal information purposes."),
 297         'description_purchase': fields.text('Purchase Description',translate=True,
 298             help="A description of the Product that you want to communicate to your suppliers. "
 299                  "This description will be copied to every Purchase Order, Reception and Supplier Invoice/Refund."),
 300         'description_sale': fields.text('Sale Description',translate=True,
 301             help="A description of the Product that you want to communicate to your customers. "
 302                  "This description will be copied to every Sale Order, Delivery Order and Customer Invoice/Refund"),
 303         '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."),
 304         'produce_delay': fields.float('Manufacturing Lead Time', help="Average delay in days to produce this product. In the case of multi-level BOM, the manufacturing lead times of the components will be added."),
 305         'rental': fields.boolean('Can be Rent'),
 306         'categ_id': fields.many2one('product.category','Category', required=True, change_default=True, domain="[('type','=','normal')]" ,help="Select category for the current product"),
 307         '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."),
 308         'standard_price': fields.float('Cost', digits_compute=dp.get_precision('Product Price'), help="Cost price of the product used for standard stock valuation in accounting and used as a base price on purchase orders.", groups="base.group_user"),
 309         'volume': fields.float('Volume', help="The volume in m3."),
 310         'weight': fields.float('Gross Weight', digits_compute=dp.get_precision('Stock Weight'), help="The gross weight in Kg."),
 311         'weight_net': fields.float('Net Weight', digits_compute=dp.get_precision('Stock Weight'), help="The net weight in Kg."),
 312         'cost_method': fields.selection([('standard','Standard Price'), ('average','Average Price')], 'Costing Method', required=True,
 313             help="Standard Price: The cost price is manually updated at the end of a specific period (usually every year). \nAverage Price: The cost price is recomputed at each incoming shipment."),
 314         'warranty': fields.float('Warranty'),
 315         'sale_ok': fields.boolean('Can be Sold', help="Specify if the product can be selected in a sales order line."),
 316         'state': fields.selection([('',''),
 317             ('draft', 'In Development'),
 318             ('sellable','Normal'),
 319             ('end','End of Lifecycle'),
 320             ('obsolete','Obsolete')], 'Status'),
 321         'uom_id': fields.many2one('product.uom', 'Unit of Measure', required=True, help="Default Unit of Measure used for all stock operation."),
 322         '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."),
 323         'uos_id' : fields.many2one('product.uom', 'Unit of Sale',
 324             help='Sepcify 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.'),
 325         'uos_coeff': fields.float('Unit of Measure -> UOS Coeff', digits_compute= dp.get_precision('Product UoS'),
 326             help='Coefficient to convert default Unit of Measure to Unit of Sale\n'
 327             ' uos = uom * coeff'),
 328         'mes_type': fields.selection((('fixed', 'Fixed'), ('variable', 'Variable')), 'Measure Type'),
 329         'seller_ids': fields.one2many('product.supplierinfo', 'product_id', 'Supplier'),
 330         'company_id': fields.many2one('res.company', 'Company', select=1),
 331     }
 332
 333     def _get_uom_id(self, cr, uid, *args):
 334         cr.execute('select id from product_uom order by id limit 1')
 335         res = cr.fetchone()
 336         return res and res[0] or False
 337
 338     def _default_category(self, cr, uid, context=None):
 339         if context is None:
 340             context = {}
 341         if 'categ_id' in context and context['categ_id']:
 342             return context['categ_id']
 343         md = self.pool.get('ir.model.data')
 344         res = False
 345         try:
 346             res = md.get_object_reference(cr, uid, 'product', 'product_category_all')[1]
 347         except ValueError:
 348             res = False
 349         return res
 350
 351     def onchange_uom(self, cursor, user, ids, uom_id, uom_po_id):
 352         if uom_id:
 353             return {'value': {'uom_po_id': uom_id}}
 354         return {}
 355
 356     def write(self, cr, uid, ids, vals, context=None):
 357         if 'uom_po_id' in vals:
 358             new_uom = self.pool.get('product.uom').browse(cr, uid, vals['uom_po_id'], context=context)
 359             for product in self.browse(cr, uid, ids, context=context):
 360                 old_uom = product.uom_po_id
 361                 if old_uom.category_id.id != new_uom.category_id.id:
 362                     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,))
 363         return super(product_template, self).write(cr, uid, ids, vals, context=context)
 364
 365     _defaults = {
 366         'company_id': lambda s,cr,uid,c: s.pool.get('res.company')._company_default_get(cr, uid, 'product.template', context=c),
 367         'list_price': 1,
 368         'cost_method': 'standard',
 369         'standard_price': 0.0,
 370         'sale_ok': 1,
 371         'produce_delay': 1,
 372         'uom_id': _get_uom_id,
 373         'uom_po_id': _get_uom_id,
 374         'uos_coeff' : 1.0,
 375         'mes_type' : 'fixed',
 376         'categ_id' : _default_category,
 377         'type' : 'consu',
 378     }
 379
 380     def _check_uom(self, cursor, user, ids, context=None):
 381         for product in self.browse(cursor, user, ids, context=context):
 382             if product.uom_id.category_id.id <> product.uom_po_id.category_id.id:
 383                 return False
 384         return True
 385
 386     def _check_uos(self, cursor, user, ids, context=None):
 387         for product in self.browse(cursor, user, ids, context=context):
 388             if product.uos_id \
 389                     and product.uos_id.category_id.id \
 390                     == product.uom_id.category_id.id:
 391                 return False
 392         return True
 393
 394     _constraints = [
 395         (_check_uom, 'Error: The default Unit of Measure and the purchase Unit of Measure must be in the same category.', ['uom_id']),
 396     ]
 397
 398     def name_get(self, cr, user, ids, context=None):
 399         if context is None:
 400             context = {}
 401         if 'partner_id' in context:
 402             pass
 403         return super(product_template, self).name_get(cr, user, ids, context)
 404
 405
 406 class product_product(osv.osv):
 407     def view_header_get(self, cr, uid, view_id, view_type, context=None):
 408         if context is None:
 409             context = {}
 410         res = super(product_product, self).view_header_get(cr, uid, view_id, view_type, context)
 411         if (context.get('categ_id', False)):
 412             return _('Products: ')+self.pool.get('product.category').browse(cr, uid, context['categ_id'], context=context).name
 413         return res
 414
 415     def _product_price(self, cr, uid, ids, name, arg, context=None):
 416         res = {}
 417         if context is None:
 418             context = {}
 419         quantity = context.get('quantity') or 1.0
 420         pricelist = context.get('pricelist', False)
 421         partner = context.get('partner', False)
 422         if pricelist:
 423             for id in ids:
 424                 try:
 425                     price = self.pool.get('product.pricelist').price_get(cr,uid,[pricelist], id, quantity, partner=partner, context=context)[pricelist]
 426                 except:
 427                     price = 0.0
 428                 res[id] = price
 429         for id in ids:
 430             res.setdefault(id, 0.0)
 431         return res
 432
 433     def _get_product_available_func(states, what):
 434         def _product_available(self, cr, uid, ids, name, arg, context=None):
 435             return {}.fromkeys(ids, 0.0)
 436         return _product_available
 437
 438     _product_qty_available = _get_product_available_func(('done',), ('in', 'out'))
 439     _product_virtual_available = _get_product_available_func(('confirmed','waiting','assigned','done'), ('in', 'out'))
 440     _product_outgoing_qty = _get_product_available_func(('confirmed','waiting','assigned'), ('out',))
 441     _product_incoming_qty = _get_product_available_func(('confirmed','waiting','assigned'), ('in',))
 442
 443     def _product_lst_price(self, cr, uid, ids, name, arg, context=None):
 444         res = {}
 445         product_uom_obj = self.pool.get('product.uom')
 446         for id in ids:
 447             res.setdefault(id, 0.0)
 448         for product in self.browse(cr, uid, ids, context=context):
 449             if 'uom' in context:
 450                 uom = product.uos_id or product.uom_id
 451                 res[product.id] = product_uom_obj._compute_price(cr, uid,
 452                         uom.id, product.list_price, context['uom'])
 453             else:
 454                 res[product.id] = product.list_price
 455             res[product.id] =  (res[product.id] or 0.0) * (product.price_margin or 1.0) + product.price_extra
 456         return res
 457
 458     def _get_partner_code_name(self, cr, uid, ids, product, partner_id, context=None):
 459         for supinfo in product.seller_ids:
 460             if supinfo.name.id == partner_id:
 461                 return {'code': supinfo.product_code or product.default_code, 'name': supinfo.product_name or product.name, 'variants': ''}
 462         res = {'code': product.default_code, 'name': product.name, 'variants': product.variants}
 463         return res
 464
 465     def _product_code(self, cr, uid, ids, name, arg, context=None):
 466         res = {}
 467         if context is None:
 468             context = {}
 469         for p in self.browse(cr, uid, ids, context=context):
 470             res[p.id] = self._get_partner_code_name(cr, uid, [], p, context.get('partner_id', None), context=context)['code']
 471         return res
 472
 473     def _product_partner_ref(self, cr, uid, ids, name, arg, context=None):
 474         res = {}
 475         if context is None:
 476             context = {}
 477         for p in self.browse(cr, uid, ids, context=context):
 478             data = self._get_partner_code_name(cr, uid, [], p, context.get('partner_id', None), context=context)
 479             if not data['variants']:
 480                 data['variants'] = p.variants
 481             if not data['code']:
 482                 data['code'] = p.code
 483             if not data['name']:
 484                 data['name'] = p.name
 485             res[p.id] = (data['code'] and ('['+data['code']+'] ') or '') + \
 486                     (data['name'] or '') + (data['variants'] and (' - '+data['variants']) or '')
 487         return res
 488
 489
 490     def _get_main_product_supplier(self, cr, uid, product, context=None):
 491         """Determines the main (best) product supplier for ``product``,
 492         returning the corresponding ``supplierinfo`` record, or False
 493         if none were found. The default strategy is to select the
 494         supplier with the highest priority (i.e. smallest sequence).
 495
 496         :param browse_record product: product to supply
 497         :rtype: product.supplierinfo browse_record or False
 498         """
 499         sellers = [(seller_info.sequence, seller_info)
 500                        for seller_info in product.seller_ids or []
 501                        if seller_info and isinstance(seller_info.sequence, (int, long))]
 502         return sellers and sellers[0][1] or False
 503
 504     def _calc_seller(self, cr, uid, ids, fields, arg, context=None):
 505         result = {}
 506         for product in self.browse(cr, uid, ids, context=context):
 507             main_supplier = self._get_main_product_supplier(cr, uid, product, context=context)
 508             result[product.id] = {
 509                 'seller_info_id': main_supplier and main_supplier.id or False,
 510                 'seller_delay': main_supplier.delay if main_supplier else 1,
 511                 'seller_qty': main_supplier and main_supplier.qty or 0.0,
 512                 'seller_id': main_supplier and main_supplier.name.id or False
 513             }
 514         return result
 515
 516
 517     def _get_image(self, cr, uid, ids, name, args, context=None):
 518         result = dict.fromkeys(ids, False)
 519         for obj in self.browse(cr, uid, ids, context=context):
 520             result[obj.id] = tools.image_get_resized_images(obj.image, avoid_resize_medium=True)
 521         return result
 522
 523     def _set_image(self, cr, uid, id, name, value, args, context=None):
 524         return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
 525
 526     def _get_name_template_ids(self, cr, uid, ids, context=None):
 527         result = set()
 528         template_ids = self.pool.get('product.product').search(cr, uid, [('product_tmpl_id', 'in', ids)])
 529         for el in template_ids:
 530             result.add(el)
 531         return list(result)
 532
 533     _defaults = {
 534         'active': lambda *a: 1,
 535         'price_extra': lambda *a: 0.0,
 536         'price_margin': lambda *a: 1.0,
 537         'color': 0,
 538     }
 539
 540     _name = "product.product"
 541     _description = "Product"
 542     _table = "product_product"
 543     _inherits = {'product.template': 'product_tmpl_id'}
 544     _inherit = ['mail.thread']
 545     _order = 'default_code,name_template'
 546     _columns = {
 547         'qty_available': fields.function(_product_qty_available, type='float', string='Quantity On Hand'),
 548         'virtual_available': fields.function(_product_virtual_available, type='float', string='Quantity Available'),
 549         'incoming_qty': fields.function(_product_incoming_qty, type='float', string='Incoming'),
 550         'outgoing_qty': fields.function(_product_outgoing_qty, type='float', string='Outgoing'),
 551         'price': fields.function(_product_price, type='float', string='Price', digits_compute=dp.get_precision('Product Price')),
 552         'lst_price' : fields.function(_product_lst_price, type='float', string='Public Price', digits_compute=dp.get_precision('Product Price')),
 553         'code': fields.function(_product_code, type='char', string='Internal Reference'),
 554         'partner_ref' : fields.function(_product_partner_ref, type='char', string='Customer ref'),
 555         'default_code' : fields.char('Internal Reference', size=64, select=True),
 556         'active': fields.boolean('Active', help="If unchecked, it will allow you to hide the product without removing it."),
 557         'variants': fields.char('Variants', size=64),
 558         'product_tmpl_id': fields.many2one('product.template', 'Product Template', required=True, ondelete="cascade", select=True),
 559         'ean13': fields.char('EAN13 Barcode', size=13, help="International Article Number used for product identification."),
 560         '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."),
 561         'price_extra': fields.float('Variant Price Extra', digits_compute=dp.get_precision('Product Price')),
 562         'price_margin': fields.float('Variant Price Margin', digits_compute=dp.get_precision('Product Price')),
 563         'pricelist_id': fields.dummy(string='Pricelist', relation='product.pricelist', type='many2one'),
 564         'name_template': fields.related('product_tmpl_id', 'name', string="Template Name", type='char', size=128, store={
 565             'product.template': (_get_name_template_ids, ['name'], 10),
 566             'product.product': (lambda self, cr, uid, ids, c=None: ids, [], 10),
 567
 568             }, select=True),
 569         'color': fields.integer('Color Index'),
 570         # image: all image fields are base64 encoded and PIL-supported
 571         'image': fields.binary("Image",
 572             help="This field holds the image used as image for the product, limited to 1024x1024px."),
 573         'image_medium': fields.function(_get_image, fnct_inv=_set_image,
 574             string="Medium-sized image", type="binary", multi="_get_image",
 575             store={
 576                 'product.product': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
 577             },
 578             help="Medium-sized image of the product. It is automatically "\
 579                  "resized as a 128x128px image, with aspect ratio preserved, "\
 580                  "only when the image exceeds one of those sizes. Use this field in form views or some kanban views."),
 581         'image_small': fields.function(_get_image, fnct_inv=_set_image,
 582             string="Small-sized image", type="binary", multi="_get_image",
 583             store={
 584                 'product.product': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
 585             },
 586             help="Small-sized image of the product. It is automatically "\
 587                  "resized as a 64x64px image, with aspect ratio preserved. "\
 588                  "Use this field anywhere a small image is required."),
 589         'seller_info_id': fields.function(_calc_seller, type='many2one', relation="product.supplierinfo", string="Supplier Info", multi="seller_info"),
 590         '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."),
 591         'seller_qty': fields.function(_calc_seller, type='float', string='Supplier Quantity', multi="seller_info", help="This is minimum quantity to purchase from Main Supplier."),
 592         '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"),
 593     }
 594     def unlink(self, cr, uid, ids, context=None):
 595         unlink_ids = []
 596         unlink_product_tmpl_ids = []
 597         for product in self.browse(cr, uid, ids, context=context):
 598             tmpl_id = product.product_tmpl_id.id
 599             # Check if the product is last product of this template
 600             other_product_ids = self.search(cr, uid, [('product_tmpl_id', '=', tmpl_id), ('id', '!=', product.id)], context=context)
 601             if not other_product_ids:
 602                 unlink_product_tmpl_ids.append(tmpl_id)
 603             unlink_ids.append(product.id)
 604         res = super(product_product, self).unlink(cr, uid, unlink_ids, context=context)
 605         # delete templates after calling super, as deleting template could lead to deleting
 606         # products due to ondelete='cascade'
 607         self.pool.get('product.template').unlink(cr, uid, unlink_product_tmpl_ids, context=context)
 608         return res
 609
 610     def onchange_uom(self, cursor, user, ids, uom_id, uom_po_id):
 611         if uom_id and uom_po_id:
 612             uom_obj=self.pool.get('product.uom')
 613             uom=uom_obj.browse(cursor,user,[uom_id])[0]
 614             uom_po=uom_obj.browse(cursor,user,[uom_po_id])[0]
 615             if uom.category_id.id != uom_po.category_id.id:
 616                 return {'value': {'uom_po_id': uom_id}}
 617         return False
 618
 619     def _check_ean_key(self, cr, uid, ids, context=None):
 620         for product in self.read(cr, uid, ids, ['ean13'], context=context):
 621             res = check_ean(product['ean13'])
 622         return res
 623
 624
 625     _constraints = [(_check_ean_key, 'You provided an invalid "EAN13 Barcode" reference. You may use the "Internal Reference" field instead.', ['ean13'])]
 626
 627     def on_order(self, cr, uid, ids, orderline, quantity):
 628         pass
 629
 630     def name_get(self, cr, user, ids, context=None):
 631         if context is None:
 632             context = {}
 633         if isinstance(ids, (int, long)):
 634             ids = [ids]
 635         if not len(ids):
 636             return []
 637         def _name_get(d):
 638             name = d.get('name','')
 639             code = d.get('default_code',False)
 640             if code:
 641                 name = '[%s] %s' % (code,name)
 642             if d.get('variants'):
 643                 name = name + ' - %s' % (d['variants'],)
 644             return (d['id'], name)
 645
 646         partner_id = context.get('partner_id', False)
 647
 648         result = []
 649         for product in self.browse(cr, user, ids, context=context):
 650             sellers = filter(lambda x: x.name.id == partner_id, product.seller_ids)
 651             if sellers:
 652                 for s in sellers:
 653                     mydict = {
 654                               'id': product.id,
 655                               'name': s.product_name or product.name,
 656                               'default_code': s.product_code or product.default_code,
 657                               'variants': product.variants
 658                               }
 659                     result.append(_name_get(mydict))
 660             else:
 661                 mydict = {
 662                           'id': product.id,
 663                           'name': product.name,
 664                           'default_code': product.default_code,
 665                           'variants': product.variants
 666                           }
 667                 result.append(_name_get(mydict))
 668         return result
 669
 670     def name_search(self, cr, user, name='', args=None, operator='ilike', context=None, limit=100):
 671         if not args:
 672             args = []
 673         if name:
 674             ids = self.search(cr, user, [('default_code','=',name)]+ args, limit=limit, context=context)
 675             if not ids:
 676                 ids = self.search(cr, user, [('ean13','=',name)]+ args, limit=limit, context=context)
 677             if not ids:
 678                 # Do not merge the 2 next lines into one single search, SQL search performance would be abysmal
 679                 # on a database with thousands of matching products, due to the huge merge+unique needed for the
 680                 # OR operator (and given the fact that the 'name' lookup results come from the ir.translation table
 681                 # Performing a quick memory merge of ids in Python will give much better performance
 682                 ids = set()
 683                 ids.update(self.search(cr, user, args + [('default_code',operator,name)], limit=limit, context=context))
 684                 if not limit or len(ids) < limit:
 685                     # we may underrun the limit because of dupes in the results, that's fine
 686                     ids.update(self.search(cr, user, args + [('name',operator,name)], limit=(limit and (limit-len(ids)) or False) , context=context))
 687                 ids = list(ids)
 688             if not ids:
 689                 ptrn = re.compile('(\[(.*?)\])')
 690                 res = ptrn.search(name)
 691                 if res:
 692                     ids = self.search(cr, user, [('default_code','=', res.group(2))] + args, limit=limit, context=context)
 693         else:
 694             ids = self.search(cr, user, args, limit=limit, context=context)
 695         result = self.name_get(cr, user, ids, context=context)
 696         return result
 697
 698     #
 699     # Could be overrided for variants matrices prices
 700     #
 701     def price_get(self, cr, uid, ids, ptype='list_price', context=None):
 702         if context is None:
 703             context = {}
 704
 705         if 'currency_id' in context:
 706             pricetype_obj = self.pool.get('product.price.type')
 707             price_type_id = pricetype_obj.search(cr, uid, [('field','=',ptype)])[0]
 708             price_type_currency_id = pricetype_obj.browse(cr,uid,price_type_id).currency_id.id
 709
 710         res = {}
 711         product_uom_obj = self.pool.get('product.uom')
 712         for product in self.browse(cr, uid, ids, context=context):
 713             res[product.id] = product[ptype] or 0.0
 714             if ptype == 'list_price':
 715                 res[product.id] = (res[product.id] * (product.price_margin or 1.0)) + \
 716                         product.price_extra
 717             if 'uom' in context:
 718                 uom = product.uom_id or product.uos_id
 719                 res[product.id] = product_uom_obj._compute_price(cr, uid,
 720                         uom.id, res[product.id], context['uom'])
 721             # Convert from price_type currency to asked one
 722             if 'currency_id' in context:
 723                 # Take the price_type currency from the product field
 724                 # This is right cause a field cannot be in more than one currency
 725                 res[product.id] = self.pool.get('res.currency').compute(cr, uid, price_type_currency_id,
 726                     context['currency_id'], res[product.id],context=context)
 727
 728         return res
 729
 730     def copy(self, cr, uid, id, default=None, context=None):
 731         if context is None:
 732             context={}
 733
 734         if not default:
 735             default = {}
 736
 737         # Craft our own `<name> (copy)` in en_US (self.copy_translation()
 738         # will do the other languages).
 739         context_wo_lang = context.copy()
 740         context_wo_lang.pop('lang', None)
 741         product = self.read(cr, uid, id, ['name'], context=context_wo_lang)
 742         default = default.copy()
 743         default.update(name=_("%s (copy)") % (product['name']))
 744
 745         if context.get('variant',False):
 746             fields = ['product_tmpl_id', 'active', 'variants', 'default_code',
 747                     'price_margin', 'price_extra']
 748             data = self.read(cr, uid, id, fields=fields, context=context)
 749             for f in fields:
 750                 if f in default:
 751                     data[f] = default[f]
 752             data['product_tmpl_id'] = data.get('product_tmpl_id', False) \
 753                     and data['product_tmpl_id'][0]
 754             del data['id']
 755             return self.create(cr, uid, data)
 756         else:
 757             return super(product_product, self).copy(cr, uid, id, default=default,
 758                     context=context)
 759
 760     def search(self, cr, uid, args, offset=0, limit=None, order=None, context=None, count=False):
 761         if context is None:
 762             context = {}
 763         if context and context.get('search_default_categ_id', False):
 764             args.append((('categ_id', 'child_of', context['search_default_categ_id'])))
 765         return super(product_product, self).search(cr, uid, args, offset=offset, limit=limit, order=order, context=context, count=False)
 766
 767
 768 class product_packaging(osv.osv):
 769     _name = "product.packaging"
 770     _description = "Packaging"
 771     _rec_name = 'ean'
 772     _order = 'sequence'
 773     _columns = {
 774         'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of packaging."),
 775         'name' : fields.text('Description', size=64),
 776         'qty' : fields.float('Quantity by Package',
 777             help="The total number of products you can put by pallet or box."),
 778         'ul' : fields.many2one('product.ul', 'Type of Package', required=True),
 779         'ul_qty' : fields.integer('Package by layer', help='The number of packages by layer'),
 780         'rows' : fields.integer('Number of Layers', required=True,
 781             help='The number of layers on a pallet or box'),
 782         'product_id' : fields.many2one('product.product', 'Product', select=1, ondelete='cascade', required=True),
 783         'ean' : fields.char('EAN', size=14,
 784             help="The EAN code of the package unit."),
 785         'code' : fields.char('Code', size=14,
 786             help="The code of the transport unit."),
 787         'weight': fields.float('Total Package Weight',
 788             help='The weight of a full package, pallet or box.'),
 789         'weight_ul': fields.float('Empty Package Weight'),
 790         'height': fields.float('Height', help='The height of the package'),
 791         'width': fields.float('Width', help='The width of the package'),
 792         'length': fields.float('Length', help='The length of the package'),
 793     }
 794
 795
 796     def _check_ean_key(self, cr, uid, ids, context=None):
 797         for pack in self.browse(cr, uid, ids, context=context):
 798             res = check_ean(pack.ean)
 799         return res
 800
 801     _constraints = [(_check_ean_key, 'Error: Invalid ean code', ['ean'])]
 802
 803     def name_get(self, cr, uid, ids, context=None):
 804         if not len(ids):
 805             return []
 806         res = []
 807         for pckg in self.browse(cr, uid, ids, context=context):
 808             p_name = pckg.ean and '[' + pckg.ean + '] ' or ''
 809             p_name += pckg.ul.name
 810             res.append((pckg.id,p_name))
 811         return res
 812
 813     def _get_1st_ul(self, cr, uid, context=None):
 814         cr.execute('select id from product_ul order by id asc limit 1')
 815         res = cr.fetchone()
 816         return (res and res[0]) or False
 817
 818     _defaults = {
 819         'rows' : lambda *a : 3,
 820         'sequence' : lambda *a : 1,
 821         'ul' : _get_1st_ul,
 822     }
 823
 824     def checksum(ean):
 825         salt = '31' * 6 + '3'
 826         sum = 0
 827         for ean_part, salt_part in zip(ean, salt):
 828             sum += int(ean_part) * int(salt_part)
 829         return (10 - (sum % 10)) % 10
 830     checksum = staticmethod(checksum)
 831
 832
 833
 834 class product_supplierinfo(osv.osv):
 835     _name = "product.supplierinfo"
 836     _description = "Information about a product supplier"
 837     def _calc_qty(self, cr, uid, ids, fields, arg, context=None):
 838         result = {}
 839         product_uom_pool = self.pool.get('product.uom')
 840         for supplier_info in self.browse(cr, uid, ids, context=context):
 841             for field in fields:
 842                 result[supplier_info.id] = {field:False}
 843             qty = supplier_info.min_qty
 844             result[supplier_info.id]['qty'] = qty
 845         return result
 846
 847     _columns = {
 848         'name' : fields.many2one('res.partner', 'Supplier', required=True,domain = [('supplier','=',True)], ondelete='cascade', help="Supplier of this product"),
 849         'product_name': fields.char('Supplier Product Name', size=128, help="This supplier's product name will be used when printing a request for quotation. Keep empty to use the internal one."),
 850         'product_code': fields.char('Supplier Product Code', size=64, help="This supplier's product code will be used when printing a request for quotation. Keep empty to use the internal one."),
 851         'sequence' : fields.integer('Sequence', help="Assigns the priority to the list of product supplier."),
 852         'product_uom': fields.related('product_id', 'uom_po_id', type='many2one', relation='product.uom', string="Supplier Unit of Measure", readonly="1", help="This comes from the product form."),
 853         '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."),
 854         '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."),
 855         'product_id' : fields.many2one('product.template', 'Product', required=True, ondelete='cascade', select=True),
 856         '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."),
 857         'pricelist_ids': fields.one2many('pricelist.partnerinfo', 'suppinfo_id', 'Supplier Pricelist'),
 858         'company_id':fields.many2one('res.company','Company',select=1),
 859     }
 860     _defaults = {
 861         'qty': lambda *a: 0.0,
 862         'sequence': lambda *a: 1,
 863         'delay': lambda *a: 1,
 864         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'product.supplierinfo', context=c),
 865     }
 866     def price_get(self, cr, uid, supplier_ids, product_id, product_qty=1, context=None):
 867         """
 868         Calculate price from supplier pricelist.
 869         @param supplier_ids: Ids of res.partner object.
 870         @param product_id: Id of product.
 871         @param product_qty: specify quantity to purchase.
 872         """
 873         if type(supplier_ids) in (int,long,):
 874             supplier_ids = [supplier_ids]
 875         res = {}
 876         product_pool = self.pool.get('product.product')
 877         partner_pool = self.pool.get('res.partner')
 878         pricelist_pool = self.pool.get('product.pricelist')
 879         currency_pool = self.pool.get('res.currency')
 880         currency_id = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id.id
 881         for supplier in partner_pool.browse(cr, uid, supplier_ids, context=context):
 882             # Compute price from standard price of product
 883             price = product_pool.price_get(cr, uid, [product_id], 'standard_price', context=context)[product_id]
 884
 885             # Compute price from Purchase pricelist of supplier
 886             pricelist_id = supplier.property_product_pricelist_purchase.id
 887             if pricelist_id:
 888                 price = pricelist_pool.price_get(cr, uid, [pricelist_id], product_id, product_qty, context=context).setdefault(pricelist_id, 0)
 889                 price = currency_pool.compute(cr, uid, pricelist_pool.browse(cr, uid, pricelist_id).currency_id.id, currency_id, price)
 890
 891             # Compute price from supplier pricelist which are in Supplier Information
 892             supplier_info_ids = self.search(cr, uid, [('name','=',supplier.id),('product_id','=',product_id)])
 893             if supplier_info_ids:
 894                 cr.execute('SELECT * ' \
 895                     'FROM pricelist_partnerinfo ' \
 896                     'WHERE suppinfo_id IN %s' \
 897                     'AND min_quantity <= %s ' \
 898                     'ORDER BY min_quantity DESC LIMIT 1', (tuple(supplier_info_ids),product_qty,))
 899                 res2 = cr.dictfetchone()
 900                 if res2:
 901                     price = res2['price']
 902             res[supplier.id] = price
 903         return res
 904     _order = 'sequence'
 905
 906
 907 class pricelist_partnerinfo(osv.osv):
 908     _name = 'pricelist.partnerinfo'
 909     _columns = {
 910         'name': fields.char('Description', size=64),
 911         'suppinfo_id': fields.many2one('product.supplierinfo', 'Partner Information', required=True, ondelete='cascade'),
 912         '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."),
 913         '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"),
 914     }
 915     _order = 'min_quantity asc'
 916
 917 class res_currency(osv.osv):
 918     _inherit = 'res.currency'
 919
 920     def _check_main_currency_rounding(self, cr, uid, ids, context=None):
 921         cr.execute('SELECT digits FROM decimal_precision WHERE name like %s',('Account',))
 922         digits = cr.fetchone()
 923         if digits and len(digits):
 924             digits = digits[0]
 925             main_currency = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id
 926             for currency_id in ids:
 927                 if currency_id == main_currency.id:
 928                     if main_currency.rounding < 10 ** -digits:
 929                         return False
 930         return True
 931
 932     _constraints = [
 933         (_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']),
 934     ]
 935
 936 class decimal_precision(osv.osv):
 937     _inherit = 'decimal.precision'
 938
 939     def _check_main_currency_rounding(self, cr, uid, ids, context=None):
 940         cr.execute('SELECT id, digits FROM decimal_precision WHERE name like %s',('Account',))
 941         res = cr.fetchone()
 942         if res and len(res):
 943             account_precision_id, digits = res
 944             main_currency = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id
 945             for decimal_precision in ids:
 946                 if decimal_precision == account_precision_id:
 947                     if main_currency.rounding < 10 ** -digits:
 948                         return False
 949         return True
 950
 951     _constraints = [
 952         (_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']),
 953     ]
 954
 955 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: