addons/product/pricelist.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 time
  23
  24 from openerp import tools
  25 from openerp.osv import fields, osv
  26 from openerp.tools.translate import _
  27
  28 import openerp.addons.decimal_precision as dp
  29
  30
  31 class price_type(osv.osv):
  32     """
  33         The price type is used to points which field in the product form
  34         is a price and in which currency is this price expressed.
  35         When a field is a price, you can use it in pricelists to base
  36         sale and purchase prices based on some fields of the product.
  37     """
  38     def _price_field_get(self, cr, uid, context=None):
  39         mf = self.pool.get('ir.model.fields')
  40         ids = mf.search(cr, uid, [('model','in', (('product.product'),('product.template'))), ('ttype','=','float')], context=context)
  41         res = []
  42         for field in mf.browse(cr, uid, ids, context=context):
  43             res.append((field.name, field.field_description))
  44         return res
  45
  46     def _get_field_currency(self, cr, uid, fname, ctx):
  47         ids = self.search(cr, uid, [('field','=',fname)], context=ctx)
  48         return self.browse(cr, uid, ids, context=ctx)[0].currency_id
  49
  50     def _get_currency(self, cr, uid, ctx):
  51         comp = self.pool.get('res.users').browse(cr,uid,uid).company_id
  52         if not comp:
  53             comp_id = self.pool.get('res.company').search(cr, uid, [])[0]
  54             comp = self.pool.get('res.company').browse(cr, uid, comp_id)
  55         return comp.currency_id.id
  56
  57     _name = "product.price.type"
  58     _description = "Price Type"
  59     _columns = {
  60         "name" : fields.char("Price Name", required=True, translate=True, help="Name of this kind of price."),
  61         "active" : fields.boolean("Active"),
  62         "field" : fields.selection(_price_field_get, "Product Field", size=32, required=True, help="Associated field in the product form."),
  63         "currency_id" : fields.many2one('res.currency', "Currency", required=True, help="The currency the field is expressed in."),
  64     }
  65     _defaults = {
  66         "active": lambda *args: True,
  67         "currency_id": _get_currency
  68     }
  69
  70
  71 #----------------------------------------------------------
  72 # Price lists
  73 #----------------------------------------------------------
  74
  75 class product_pricelist_type(osv.osv):
  76     _name = "product.pricelist.type"
  77     _description = "Pricelist Type"
  78     _columns = {
  79         'name': fields.char('Name', required=True, translate=True),
  80         'key': fields.char('Key', required=True, help="Used in the code to select specific prices based on the context. Keep unchanged."),
  81     }
  82
  83
  84 class product_pricelist(osv.osv):
  85     def _pricelist_type_get(self, cr, uid, context=None):
  86         pricelist_type_obj = self.pool.get('product.pricelist.type')
  87         pricelist_type_ids = pricelist_type_obj.search(cr, uid, [], order='name')
  88         pricelist_types = pricelist_type_obj.read(cr, uid, pricelist_type_ids, ['key','name'], context=context)
  89
  90         res = []
  91
  92         for type in pricelist_types:
  93             res.append((type['key'],type['name']))
  94
  95         return res
  96
  97     _name = "product.pricelist"
  98     _description = "Pricelist"
  99     _order = 'name'
 100     _columns = {
 101         'name': fields.char('Pricelist Name', required=True, translate=True),
 102         'active': fields.boolean('Active', help="If unchecked, it will allow you to hide the pricelist without removing it."),
 103         'type': fields.selection(_pricelist_type_get, 'Pricelist Type', required=True),
 104         'version_id': fields.one2many('product.pricelist.version', 'pricelist_id', 'Pricelist Versions', copy=True),
 105         'currency_id': fields.many2one('res.currency', 'Currency', required=True),
 106         'company_id': fields.many2one('res.company', 'Company'),
 107     }
 108
 109     def name_get(self, cr, uid, ids, context=None):
 110         result= []
 111         if not all(ids):
 112             return result
 113         for pl in self.browse(cr, uid, ids, context=context):
 114             name = pl.name + ' ('+ pl.currency_id.name + ')'
 115             result.append((pl.id,name))
 116         return result
 117
 118     def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
 119         if name and operator == '=' and not args:
 120             # search on the name of the pricelist and its currency, opposite of name_get(),
 121             # Used by the magic context filter in the product search view.
 122             query_args = {'name': name, 'limit': limit, 'lang': (context or {}).get('lang') or 'en_US'}
 123             query = """SELECT p.id
 124                        FROM ((
 125                                 SELECT pr.id, pr.name
 126                                 FROM product_pricelist pr JOIN
 127                                      res_currency cur ON
 128                                          (pr.currency_id = cur.id)
 129                                 WHERE pr.name || ' (' || cur.name || ')' = %(name)s
 130                             )
 131                             UNION (
 132                                 SELECT tr.res_id as id, tr.value as name
 133                                 FROM ir_translation tr JOIN
 134                                      product_pricelist pr ON (
 135                                         pr.id = tr.res_id AND
 136                                         tr.type = 'model' AND
 137                                         tr.name = 'product.pricelist,name' AND
 138                                         tr.lang = %(lang)s
 139                                      ) JOIN
 140                                      res_currency cur ON
 141                                          (pr.currency_id = cur.id)
 142                                 WHERE tr.value || ' (' || cur.name || ')' = %(name)s
 143                             )
 144                         ) p
 145                        ORDER BY p.name"""
 146             if limit:
 147                 query += " LIMIT %(limit)s"
 148             cr.execute(query, query_args)
 149             ids = [r[0] for r in cr.fetchall()]
 150             # regular search() to apply ACLs - may limit results below limit in some cases
 151             ids = self.search(cr, uid, [('id', 'in', ids)], limit=limit, context=context)
 152             if ids:
 153                 return self.name_get(cr, uid, ids, context)
 154         return super(product_pricelist, self).name_search(
 155             cr, uid, name, args, operator=operator, context=context, limit=limit)
 156
 157
 158     def _get_currency(self, cr, uid, ctx):
 159         comp = self.pool.get('res.users').browse(cr, uid, uid).company_id
 160         if not comp:
 161             comp_id = self.pool.get('res.company').search(cr, uid, [])[0]
 162             comp = self.pool.get('res.company').browse(cr, uid, comp_id)
 163         return comp.currency_id.id
 164
 165     _defaults = {
 166         'active': lambda *a: 1,
 167         "currency_id": _get_currency
 168     }
 169
 170     def price_get_multi(self, cr, uid, ids, products_by_qty_by_partner, context=None):
 171         return dict((key, price[0]) for key, price in self.price_rule_get_multi(cr, uid, ids, products_by_qty_by_partner, context=context).items())
 172
 173     def price_rule_get_multi(self, cr, uid, ids, products_by_qty_by_partner, context=None):
 174         """multi products 'price_get'.
 175            @param ids:
 176            @param products_by_qty:
 177            @param partner:
 178            @param context: {
 179              'date': Date of the pricelist (%Y-%m-%d),}
 180            @return: a dict of dict with product_id as key and a dict 'price by pricelist' as value
 181         """
 182         if not ids:
 183             ids = self.pool.get('product.pricelist').search(cr, uid, [], context=context)
 184         results = {}
 185         for pricelist in self.browse(cr, uid, ids, context=context):
 186             subres = self._price_rule_get_multi(cr, uid, pricelist, products_by_qty_by_partner, context=context)
 187             for product_id,price in subres.items():
 188                 results.setdefault(product_id, {})
 189                 results[product_id][pricelist.id] = price
 190         return results
 191
 192     def _price_get_multi(self, cr, uid, pricelist, products_by_qty_by_partner, context=None):
 193         return dict((key, price[0]) for key, price in self._price_rule_get_multi(cr, uid, pricelist, products_by_qty_by_partner, context=context).items())
 194
 195     def _price_rule_get_multi(self, cr, uid, pricelist, products_by_qty_by_partner, context=None):
 196         context = context or {}
 197         date = context.get('date') or time.strftime('%Y-%m-%d')
 198
 199         products = map(lambda x: x[0], products_by_qty_by_partner)
 200         currency_obj = self.pool.get('res.currency')
 201         product_obj = self.pool.get('product.template')
 202         product_uom_obj = self.pool.get('product.uom')
 203         price_type_obj = self.pool.get('product.price.type')
 204
 205         if not products:
 206             return {}
 207
 208         version = False
 209         for v in pricelist.version_id:
 210             if ((v.date_start is False) or (v.date_start <= date)) and ((v.date_end is False) or (v.date_end >= date)):
 211                 version = v
 212                 break
 213         if not version:
 214             raise osv.except_osv(_('Warning!'), _("At least one pricelist has no active version !\nPlease create or activate one."))
 215         categ_ids = {}
 216         for p in products:
 217             categ = p.categ_id
 218             while categ:
 219                 categ_ids[categ.id] = True
 220                 categ = categ.parent_id
 221         categ_ids = categ_ids.keys()
 222
 223         is_product_template = products[0]._name == "product.template"
 224         if is_product_template:
 225             prod_tmpl_ids = [tmpl.id for tmpl in products]
 226             prod_ids = [product.id for product in tmpl.product_variant_ids for tmpl in products]
 227         else:
 228             prod_ids = [product.id for product in products]
 229             prod_tmpl_ids = [product.product_tmpl_id.id for product in products]
 230
 231         # Load all rules
 232         cr.execute(
 233             'SELECT i.id '
 234             'FROM product_pricelist_item AS i '
 235             'WHERE (product_tmpl_id IS NULL OR product_tmpl_id = any(%s)) '
 236                 'AND (product_id IS NULL OR (product_id = any(%s))) '
 237                 'AND ((categ_id IS NULL) OR (categ_id = any(%s))) '
 238                 'AND (price_version_id = %s) '
 239             'ORDER BY sequence, min_quantity desc',
 240             (prod_tmpl_ids, prod_ids, categ_ids, version.id))
 241
 242         item_ids = [x[0] for x in cr.fetchall()]
 243         items = self.pool.get('product.pricelist.item').browse(cr, uid, item_ids, context=context)
 244
 245         price_types = {}
 246
 247         results = {}
 248         for product, qty, partner in products_by_qty_by_partner:
 249             uom_price_already_computed = False
 250             results[product.id] = 0.0
 251             price = False
 252             rule_id = False
 253             for rule in items:
 254                 if rule.min_quantity and qty<rule.min_quantity:
 255                     continue
 256                 if is_product_template:
 257                     if rule.product_tmpl_id and product.id != rule.product_tmpl_id.id:
 258                         continue
 259                     if rule.product_id:
 260                         continue
 261                 else:
 262                     if rule.product_tmpl_id and product.product_tmpl_id.id != rule.product_tmpl_id.id:
 263                         continue
 264                     if rule.product_id and product.id != rule.product_id.id:
 265                         continue
 266
 267                 if rule.categ_id:
 268                     cat = product.categ_id
 269                     while cat:
 270                         if cat.id == rule.categ_id.id:
 271                             break
 272                         cat = cat.parent_id
 273                     if not cat:
 274                         continue
 275
 276                 if rule.base == -1:
 277                     if rule.base_pricelist_id:
 278                         price_tmp = self._price_get_multi(cr, uid,
 279                                 rule.base_pricelist_id, [(product,
 280                                 qty, False)], context=context)[product.id]
 281                         ptype_src = rule.base_pricelist_id.currency_id.id
 282                         uom_price_already_computed = True
 283                         price = currency_obj.compute(cr, uid,
 284                                 ptype_src, pricelist.currency_id.id,
 285                                 price_tmp, round=False,
 286                                 context=context)
 287                 elif rule.base == -2:
 288                     for seller in product.seller_ids:
 289                         if (not partner) or (seller.name.id != partner):
 290                             continue
 291                         qty_in_seller_uom = qty
 292                         from_uom = context.get('uom') or product.uom_id.id
 293                         seller_uom = seller.product_uom and seller.product_uom.id or False
 294                         if seller_uom and from_uom and from_uom != seller_uom:
 295                             qty_in_seller_uom = product_uom_obj._compute_qty(cr, uid, from_uom, qty, to_uom_id=seller_uom)
 296                         else:
 297                             uom_price_already_computed = True
 298                         for line in seller.pricelist_ids:
 299                             if line.min_quantity <= qty_in_seller_uom:
 300                                 price = line.price
 301
 302                 else:
 303                     if rule.base not in price_types:
 304                         price_types[rule.base] = price_type_obj.browse(cr, uid, int(rule.base))
 305                     price_type = price_types[rule.base]
 306
 307                     uom_price_already_computed = True
 308                     price = currency_obj.compute(cr, uid,
 309                             price_type.currency_id.id, pricelist.currency_id.id,
 310                             product_obj._price_get(cr, uid, [product],
 311                             price_type.field, context=context)[product.id], round=False, context=context)
 312
 313                 if price is not False:
 314                     price_limit = price
 315                     price = price * (1.0+(rule.price_discount or 0.0))
 316                     if rule.price_round:
 317                         price = tools.float_round(price, precision_rounding=rule.price_round)
 318                     price += (rule.price_surcharge or 0.0)
 319                     if rule.price_min_margin:
 320                         price = max(price, price_limit+rule.price_min_margin)
 321                     if rule.price_max_margin:
 322                         price = min(price, price_limit+rule.price_max_margin)
 323                     rule_id = rule.id
 324                 break
 325
 326             if price:
 327                 if 'uom' in context and not uom_price_already_computed:
 328                     uom = product.uos_id or product.uom_id
 329                     price = product_uom_obj._compute_price(cr, uid, uom.id, price, context['uom'])
 330
 331             results[product.id] = (price, rule_id)
 332         return results
 333
 334     def price_get(self, cr, uid, ids, prod_id, qty, partner=None, context=None):
 335         return dict((key, price[0]) for key, price in self.price_rule_get(cr, uid, ids, prod_id, qty, partner=partner, context=context).items())
 336
 337     def price_rule_get(self, cr, uid, ids, prod_id, qty, partner=None, context=None):
 338         product = self.pool.get('product.product').browse(cr, uid, prod_id, context=context)
 339         res_multi = self.price_rule_get_multi(cr, uid, ids, products_by_qty_by_partner=[(product, qty, partner)], context=context)
 340         res = res_multi[prod_id]
 341         return res
 342
 343
 344 class product_pricelist_version(osv.osv):
 345     _name = "product.pricelist.version"
 346     _description = "Pricelist Version"
 347     _columns = {
 348         'pricelist_id': fields.many2one('product.pricelist', 'Price List',
 349             required=True, select=True, ondelete='cascade'),
 350         'name': fields.char('Name', required=True, translate=True),
 351         'active': fields.boolean('Active',
 352             help="When a version is duplicated it is set to non active, so that the " \
 353             "dates do not overlaps with original version. You should change the dates " \
 354             "and reactivate the pricelist", copy=False),
 355         'items_id': fields.one2many('product.pricelist.item',
 356             'price_version_id', 'Price List Items', required=True, copy=True),
 357         'date_start': fields.date('Start Date', help="First valid date for the version."),
 358         'date_end': fields.date('End Date', help="Last valid date for the version."),
 359         'company_id': fields.related('pricelist_id','company_id',type='many2one',
 360             readonly=True, relation='res.company', string='Company', store=True)
 361     }
 362     _defaults = {
 363         'active': lambda *a: 1,
 364     }
 365
 366     def _check_date(self, cursor, user, ids, context=None):
 367         for pricelist_version in self.browse(cursor, user, ids, context=context):
 368             if not pricelist_version.active:
 369                 continue
 370             where = []
 371             if pricelist_version.date_start:
 372                 where.append("((date_end>='%s') or (date_end is null))" % (pricelist_version.date_start,))
 373             if pricelist_version.date_end:
 374                 where.append("((date_start<='%s') or (date_start is null))" % (pricelist_version.date_end,))
 375
 376             cursor.execute('SELECT id ' \
 377                     'FROM product_pricelist_version ' \
 378                     'WHERE '+' and '.join(where) + (where and ' and ' or '')+
 379                         'pricelist_id = %s ' \
 380                         'AND active ' \
 381                         'AND id <> %s', (
 382                             pricelist_version.pricelist_id.id,
 383                             pricelist_version.id))
 384             if cursor.fetchall():
 385                 return False
 386         return True
 387
 388     _constraints = [
 389         (_check_date, 'You cannot have 2 pricelist versions that overlap!',
 390             ['date_start', 'date_end'])
 391     ]
 392
 393
 394 class product_pricelist_item(osv.osv):
 395     def _price_field_get(self, cr, uid, context=None):
 396         pt = self.pool.get('product.price.type')
 397         ids = pt.search(cr, uid, [], context=context)
 398         result = []
 399         for line in pt.browse(cr, uid, ids, context=context):
 400             result.append((line.id, line.name))
 401
 402         result.append((-1, _('Other Pricelist')))
 403         result.append((-2, _('Supplier Prices on the product form')))
 404         return result
 405
 406 # Added default function to fetch the Price type Based on Pricelist type.
 407     def _get_default_base(self, cr, uid, fields, context=None):
 408         product_price_type_obj = self.pool.get('product.price.type')
 409         if fields.get('type') == 'purchase':
 410             product_price_type_ids = product_price_type_obj.search(cr, uid, [('field', '=', 'standard_price')], context=context)
 411         elif fields.get('type') == 'sale':
 412             product_price_type_ids = product_price_type_obj.search(cr, uid, [('field','=','list_price')], context=context)
 413         else:
 414             return -1
 415         if not product_price_type_ids:
 416             return False
 417         else:
 418             pricetype = product_price_type_obj.browse(cr, uid, product_price_type_ids, context=context)[0]
 419             return pricetype.id
 420
 421     _name = "product.pricelist.item"
 422     _description = "Pricelist item"
 423     _order = "sequence, min_quantity desc"
 424     _defaults = {
 425         'base': _get_default_base,
 426         'min_quantity': lambda *a: 0,
 427         'sequence': lambda *a: 5,
 428         'price_discount': lambda *a: 0,
 429     }
 430
 431     def _check_recursion(self, cr, uid, ids, context=None):
 432         for obj_list in self.browse(cr, uid, ids, context=context):
 433             if obj_list.base == -1:
 434                 main_pricelist = obj_list.price_version_id.pricelist_id.id
 435                 other_pricelist = obj_list.base_pricelist_id.id
 436                 if main_pricelist == other_pricelist:
 437                     return False
 438         return True
 439
 440     def _check_margin(self, cr, uid, ids, context=None):
 441         for item in self.browse(cr, uid, ids, context=context):
 442             if item.price_max_margin and item.price_min_margin and (item.price_min_margin > item.price_max_margin):
 443                 return False
 444         return True
 445
 446     _columns = {
 447         'name': fields.char('Rule Name', help="Explicit rule name for this pricelist line."),
 448         'price_version_id': fields.many2one('product.pricelist.version', 'Price List Version', required=True, select=True, ondelete='cascade'),
 449         'product_tmpl_id': fields.many2one('product.template', 'Product Template', ondelete='cascade', help="Specify a template if this rule only applies to one product template. Keep empty otherwise."),
 450         'product_id': fields.many2one('product.product', 'Product', ondelete='cascade', help="Specify a product if this rule only applies to one product. Keep empty otherwise."),
 451         'categ_id': fields.many2one('product.category', 'Product Category', ondelete='cascade', help="Specify a product category if this rule only applies to products belonging to this category or its children categories. Keep empty otherwise."),
 452
 453         'min_quantity': fields.integer('Min. Quantity', required=True, help="For the rule to apply, bought/sold quantity must be greater than or equal to minimum quantity specified in this field."),
 454         'sequence': fields.integer('Sequence', required=True, help="Gives the order in which the pricelist items will be checked. The evaluation gives highest priority to lowest sequence and stops as soon as a matching item is found."),
 455         'base': fields.selection(_price_field_get, 'Based on', required=True, size=-1, help="Base price for computation."),
 456         'base_pricelist_id': fields.many2one('product.pricelist', 'Other Pricelist'),
 457
 458         'price_surcharge': fields.float('Price Surcharge',
 459             digits_compute= dp.get_precision('Product Price'), help='Specify the fixed amount to add or substract(if negative) to the amount calculated with the discount.'),
 460         'price_discount': fields.float('Price Discount', digits=(16,4)),
 461         'price_round': fields.float('Price Rounding',
 462             digits_compute= dp.get_precision('Product Price'),
 463             help="Sets the price so that it is a multiple of this value.\n" \
 464               "Rounding is applied after the discount and before the surcharge.\n" \
 465               "To have prices that end in 9.99, set rounding 10, surcharge -0.01" \
 466             ),
 467         'price_min_margin': fields.float('Min. Price Margin',
 468             digits_compute= dp.get_precision('Product Price'), help='Specify the minimum amount of margin over the base price.'),
 469         'price_max_margin': fields.float('Max. Price Margin',
 470             digits_compute= dp.get_precision('Product Price'), help='Specify the maximum amount of margin over the base price.'),
 471         'company_id': fields.related('price_version_id','company_id',type='many2one',
 472             readonly=True, relation='res.company', string='Company', store=True)
 473     }
 474
 475     _constraints = [
 476         (_check_recursion, 'Error! You cannot assign the Main Pricelist as Other Pricelist in PriceList Item!', ['base_pricelist_id']),
 477         (_check_margin, 'Error! The minimum margin should be lower than the maximum margin.', ['price_min_margin', 'price_max_margin'])
 478     ]
 479
 480     def product_id_change(self, cr, uid, ids, product_id, context=None):
 481         if not product_id:
 482             return {}
 483         prod = self.pool.get('product.product').read(cr, uid, [product_id], ['code','name'])
 484         if prod[0]['code']:
 485             return {'value': {'name': prod[0]['code']}}
 486         return {}
 487
 488
 489
 490 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 491