addons/stock/stock.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 from lxml import etree
  23 from datetime import datetime
  24 from dateutil.relativedelta import relativedelta
  25 import time
  26 from operator import itemgetter
  27 from itertools import groupby
  28
  29 from osv import fields, osv
  30 from tools.translate import _
  31 import netsvc
  32 import tools
  33 from tools import float_compare
  34 import decimal_precision as dp
  35 import logging
  36 _logger = logging.getLogger(__name__)
  37
  38 #----------------------------------------------------------
  39 # Incoterms
  40 #----------------------------------------------------------
  41 class stock_incoterms(osv.osv):
  42     _name = "stock.incoterms"
  43     _description = "Incoterms"
  44     _columns = {
  45         'name': fields.char('Name', size=64, required=True, help="Incoterms are series of sales terms.They are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices."),
  46         'code': fields.char('Code', size=3, required=True, help="Code for Incoterms"),
  47         'active': fields.boolean('Active', help="By unchecking the active field, you may hide an INCOTERM without deleting it."),
  48     }
  49     _defaults = {
  50         'active': True,
  51     }
  52
  53 stock_incoterms()
  54
  55 class stock_journal(osv.osv):
  56     _name = "stock.journal"
  57     _description = "Stock Journal"
  58     _columns = {
  59         'name': fields.char('Stock Journal', size=32, required=True),
  60         'user_id': fields.many2one('res.users', 'Responsible'),
  61     }
  62     _defaults = {
  63         'user_id': lambda s, c, u, ctx: u
  64     }
  65
  66 stock_journal()
  67
  68 #----------------------------------------------------------
  69 # Stock Location
  70 #----------------------------------------------------------
  71 class stock_location(osv.osv):
  72     _name = "stock.location"
  73     _description = "Location"
  74     _parent_name = "location_id"
  75     _parent_store = True
  76     _parent_order = 'posz,name'
  77     _order = 'parent_left'
  78
  79     def name_get(self, cr, uid, ids, context=None):
  80         # always return the full hierarchical name
  81         res = self._complete_name(cr, uid, ids, 'complete_name', None, context=context)
  82         return res.items()
  83
  84     def _complete_name(self, cr, uid, ids, name, args, context=None):
  85         """ Forms complete name of location from parent location to child location.
  86         @return: Dictionary of values
  87         """
  88         res = {}
  89         for m in self.browse(cr, uid, ids, context=context):
  90             names = [m.name]
  91             parent = m.location_id
  92             while parent:
  93                 names.append(parent.name)
  94                 parent = parent.location_id
  95             res[m.id] = ' / '.join(reversed(names))
  96         return res
  97
  98     def _get_sublocations(self, cr, uid, ids, context=None):
  99         """ return all sublocations of the given stock locations (included) """
 100         return self.search(cr, uid, [('id', 'child_of', ids)], context=context)
 101
 102     def _product_value(self, cr, uid, ids, field_names, arg, context=None):
 103         """Computes stock value (real and virtual) for a product, as well as stock qty (real and virtual).
 104         @param field_names: Name of field
 105         @return: Dictionary of values
 106         """
 107         prod_id = context and context.get('product_id', False)
 108
 109         if not prod_id:
 110             return dict([(i, {}.fromkeys(field_names, 0.0)) for i in ids])
 111
 112         product_product_obj = self.pool.get('product.product')
 113
 114         cr.execute('select distinct product_id, location_id from stock_move where location_id in %s', (tuple(ids), ))
 115         dict1 = cr.dictfetchall()
 116         cr.execute('select distinct product_id, location_dest_id as location_id from stock_move where location_dest_id in %s', (tuple(ids), ))
 117         dict2 = cr.dictfetchall()
 118         res_products_by_location = sorted(dict1+dict2, key=itemgetter('location_id'))
 119         products_by_location = dict((k, [v['product_id'] for v in itr]) for k, itr in groupby(res_products_by_location, itemgetter('location_id')))
 120
 121         result = dict([(i, {}.fromkeys(field_names, 0.0)) for i in ids])
 122         result.update(dict([(i, {}.fromkeys(field_names, 0.0)) for i in list(set([aaa['location_id'] for aaa in res_products_by_location]))]))
 123
 124         currency_id = self.pool.get('res.users').browse(cr, uid, uid).company_id.currency_id.id
 125         currency_obj = self.pool.get('res.currency')
 126         currency = currency_obj.browse(cr, uid, currency_id, context=context)
 127         for loc_id, product_ids in products_by_location.items():
 128             if prod_id:
 129                 product_ids = [prod_id]
 130             c = (context or {}).copy()
 131             c['location'] = loc_id
 132             for prod in product_product_obj.browse(cr, uid, product_ids, context=c):
 133                 for f in field_names:
 134                     if f == 'stock_real':
 135                         if loc_id not in result:
 136                             result[loc_id] = {}
 137                         result[loc_id][f] += prod.qty_available
 138                     elif f == 'stock_virtual':
 139                         result[loc_id][f] += prod.virtual_available
 140                     elif f == 'stock_real_value':
 141                         amount = prod.qty_available * prod.standard_price
 142                         amount = currency_obj.round(cr, uid, currency, amount)
 143                         result[loc_id][f] += amount
 144                     elif f == 'stock_virtual_value':
 145                         amount = prod.virtual_available * prod.standard_price
 146                         amount = currency_obj.round(cr, uid, currency, amount)
 147                         result[loc_id][f] += amount
 148         return result
 149
 150     _columns = {
 151         'name': fields.char('Location Name', size=64, required=True, translate=True),
 152         'active': fields.boolean('Active', help="By unchecking the active field, you may hide a location without deleting it."),
 153         'usage': fields.selection([('supplier', 'Supplier Location'), ('view', 'View'), ('internal', 'Internal Location'), ('customer', 'Customer Location'), ('inventory', 'Inventory'), ('procurement', 'Procurement'), ('production', 'Production'), ('transit', 'Transit Location for Inter-Companies Transfers')], 'Location Type', required=True,
 154                  help="""* Supplier Location: Virtual location representing the source location for products coming from your suppliers
 155                        \n* View: Virtual location used to create a hierarchical structures for your warehouse, aggregating its child locations ; can't directly contain products
 156                        \n* Internal Location: Physical locations inside your own warehouses,
 157                        \n* Customer Location: Virtual location representing the destination location for products sent to your customers
 158                        \n* Inventory: Virtual location serving as counterpart for inventory operations used to correct stock levels (Physical inventories)
 159                        \n* Procurement: Virtual location serving as temporary counterpart for procurement operations when the source (supplier or production) is not known yet. This location should be empty when the procurement scheduler has finished running.
 160                        \n* Production: Virtual counterpart location for production operations: this location consumes the raw material and produces finished products
 161                       """, select = True),
 162          # temporarily removed, as it's unused: 'allocation_method': fields.selection([('fifo', 'FIFO'), ('lifo', 'LIFO'), ('nearest', 'Nearest')], 'Allocation Method', required=True),
 163         'complete_name': fields.function(_complete_name, type='char', size=256, string="Location Name",
 164                             store={'stock.location': (_get_sublocations, ['name', 'location_id'], 10)}),
 165
 166         'stock_real': fields.function(_product_value, type='float', string='Real Stock', multi="stock"),
 167         'stock_virtual': fields.function(_product_value, type='float', string='Virtual Stock', multi="stock"),
 168
 169         'location_id': fields.many2one('stock.location', 'Parent Location', select=True, ondelete='cascade'),
 170         'child_ids': fields.one2many('stock.location', 'location_id', 'Contains'),
 171
 172         'chained_journal_id': fields.many2one('stock.journal', 'Chaining Journal',help="Inventory Journal in which the chained move will be written, if the Chaining Type is not Transparent (no journal is used if left empty)"),
 173         'chained_location_id': fields.many2one('stock.location', 'Chained Location If Fixed'),
 174         'chained_location_type': fields.selection([('none', 'None'), ('customer', 'Customer'), ('fixed', 'Fixed Location')],
 175             'Chained Location Type', required=True,
 176             help="Determines whether this location is chained to another location, i.e. any incoming product in this location \n" \
 177                 "should next go to the chained location. The chained location is determined according to the type :"\
 178                 "\n* None: No chaining at all"\
 179                 "\n* Customer: The chained location will be taken from the Customer Location field on the Partner form of the Partner that is specified in the Picking list of the incoming products." \
 180                 "\n* Fixed Location: The chained location is taken from the next field: Chained Location if Fixed." \
 181                 ),
 182         'chained_auto_packing': fields.selection(
 183             [('auto', 'Automatic Move'), ('manual', 'Manual Operation'), ('transparent', 'Automatic No Step Added')],
 184             'Chaining Type',
 185             required=True,
 186             help="This is used only if you select a chained location type.\n" \
 187                 "The 'Automatic Move' value will create a stock move after the current one that will be "\
 188                 "validated automatically. With 'Manual Operation', the stock move has to be validated "\
 189                 "by a worker. With 'Automatic No Step Added', the location is replaced in the original move."
 190             ),
 191         'chained_picking_type': fields.selection([('out', 'Sending Goods'), ('in', 'Getting Goods'), ('internal', 'Internal')], 'Shipping Type', help="Shipping Type of the Picking List that will contain the chained move (leave empty to automatically detect the type based on the source and destination locations)."),
 192         'chained_company_id': fields.many2one('res.company', 'Chained Company', help='The company the Picking List containing the chained move will belong to (leave empty to use the default company determination rules'),
 193         'chained_delay': fields.integer('Chaining Lead Time',help="Delay between original move and chained move in days"),
 194         'partner_id': fields.many2one('res.partner', 'Location Address',help="Address of  customer or supplier."),
 195         'icon': fields.selection(tools.icons, 'Icon', size=64,help="Icon show in  hierarchical tree view"),
 196
 197         'comment': fields.text('Additional Information'),
 198         'posx': fields.integer('Corridor (X)',help="Optional localization details, for information purpose only"),
 199         'posy': fields.integer('Shelves (Y)', help="Optional localization details, for information purpose only"),
 200         'posz': fields.integer('Height (Z)', help="Optional localization details, for information purpose only"),
 201
 202         'parent_left': fields.integer('Left Parent', select=1),
 203         'parent_right': fields.integer('Right Parent', select=1),
 204         'stock_real_value': fields.function(_product_value, type='float', string='Real Stock Value', multi="stock", digits_compute=dp.get_precision('Account')),
 205         'stock_virtual_value': fields.function(_product_value, type='float', string='Virtual Stock Value', multi="stock", digits_compute=dp.get_precision('Account')),
 206         'company_id': fields.many2one('res.company', 'Company', select=1, help='Let this field empty if this location is shared between all companies'),
 207         'scrap_location': fields.boolean('Scrap Location', help='Check this box to allow using this location to put scrapped/damaged goods.'),
 208         'valuation_in_account_id': fields.many2one('account.account', 'Stock Valuation Account (Incoming)', domain = [('type','=','other')],
 209                                                    help="Used for real-time inventory valuation. When set on a virtual location (non internal type), "
 210                                                         "this account will be used to hold the value of products being moved from an internal location "
 211                                                         "into this location, instead of the generic Stock Output Account set on the product. "
 212                                                         "This has no effect for internal locations."),
 213         'valuation_out_account_id': fields.many2one('account.account', 'Stock Valuation Account (Outgoing)', domain = [('type','=','other')],
 214                                                    help="Used for real-time inventory valuation. When set on a virtual location (non internal type), "
 215                                                         "this account will be used to hold the value of products being moved out of this location "
 216                                                         "and into an internal location, instead of the generic Stock Output Account set on the product. "
 217                                                         "This has no effect for internal locations."),
 218     }
 219     _defaults = {
 220         'active': True,
 221         'usage': 'internal',
 222         'chained_location_type': 'none',
 223         'chained_auto_packing': 'manual',
 224         'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.location', context=c),
 225         'posx': 0,
 226         'posy': 0,
 227         'posz': 0,
 228         'icon': False,
 229         'scrap_location': False,
 230     }
 231
 232     def chained_location_get(self, cr, uid, location, partner=None, product=None, context=None):
 233         """ Finds chained location
 234         @param location: Location id
 235         @param partner: Partner id
 236         @param product: Product id
 237         @return: List of values
 238         """
 239         result = None
 240         if location.chained_location_type == 'customer':
 241             if partner:
 242                 result = partner.property_stock_customer
 243         elif location.chained_location_type == 'fixed':
 244             result = location.chained_location_id
 245         if result:
 246             return result, location.chained_auto_packing, location.chained_delay, location.chained_journal_id and location.chained_journal_id.id or False, location.chained_company_id and location.chained_company_id.id or False, location.chained_picking_type
 247         return result
 248
 249     def picking_type_get(self, cr, uid, from_location, to_location, context=None):
 250         """ Gets type of picking.
 251         @param from_location: Source location
 252         @param to_location: Destination location
 253         @return: Location type
 254         """
 255         result = 'internal'
 256         if (from_location.usage=='internal') and (to_location and to_location.usage in ('customer', 'supplier')):
 257             result = 'out'
 258         elif (from_location.usage in ('supplier', 'customer')) and (to_location.usage == 'internal'):
 259             result = 'in'
 260         return result
 261
 262     def _product_get_all_report(self, cr, uid, ids, product_ids=False, context=None):
 263         return self._product_get_report(cr, uid, ids, product_ids, context, recursive=True)
 264
 265     def _product_get_report(self, cr, uid, ids, product_ids=False,
 266             context=None, recursive=False):
 267         """ Finds the product quantity and price for particular location.
 268         @param product_ids: Ids of product
 269         @param recursive: True or False
 270         @return: Dictionary of values
 271         """
 272         if context is None:
 273             context = {}
 274         product_obj = self.pool.get('product.product')
 275         # Take the user company and pricetype
 276         context['currency_id'] = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id.currency_id.id
 277
 278         # To be able to offer recursive or non-recursive reports we need to prevent recursive quantities by default
 279         context['compute_child'] = False
 280
 281         if not product_ids:
 282             product_ids = product_obj.search(cr, uid, [], context={'active_test': False})
 283
 284         products = product_obj.browse(cr, uid, product_ids, context=context)
 285         products_by_uom = {}
 286         products_by_id = {}
 287         for product in products:
 288             products_by_uom.setdefault(product.uom_id.id, [])
 289             products_by_uom[product.uom_id.id].append(product)
 290             products_by_id.setdefault(product.id, [])
 291             products_by_id[product.id] = product
 292
 293         result = {}
 294         result['product'] = []
 295         for id in ids:
 296             quantity_total = 0.0
 297             total_price = 0.0
 298             for uom_id in products_by_uom.keys():
 299                 fnc = self._product_get
 300                 if recursive:
 301                     fnc = self._product_all_get
 302                 ctx = context.copy()
 303                 ctx['uom'] = uom_id
 304                 qty = fnc(cr, uid, id, [x.id for x in products_by_uom[uom_id]],
 305                         context=ctx)
 306                 for product_id in qty.keys():
 307                     if not qty[product_id]:
 308                         continue
 309                     product = products_by_id[product_id]
 310                     quantity_total += qty[product_id]
 311
 312                     # Compute based on pricetype
 313                     # Choose the right filed standard_price to read
 314                     amount_unit = product.price_get('standard_price', context=context)[product.id]
 315                     price = qty[product_id] * amount_unit
 316
 317                     total_price += price
 318                     result['product'].append({
 319                         'price': amount_unit,
 320                         'prod_name': product.name,
 321                         'code': product.default_code, # used by lot_overview_all report!
 322                         'variants': product.variants or '',
 323                         'uom': product.uom_id.name,
 324                         'prod_qty': qty[product_id],
 325                         'price_value': price,
 326                     })
 327         result['total'] = quantity_total
 328         result['total_price'] = total_price
 329         return result
 330
 331     def _product_get_multi_location(self, cr, uid, ids, product_ids=False, context=None,
 332                                     states=['done'], what=('in', 'out')):
 333         """
 334         @param product_ids: Ids of product
 335         @param states: List of states
 336         @param what: Tuple of
 337         @return:
 338         """
 339         product_obj = self.pool.get('product.product')
 340         if context is None:
 341             context = {}
 342         context.update({
 343             'states': states,
 344             'what': what,
 345             'location': ids
 346         })
 347         return product_obj.get_product_available(cr, uid, product_ids, context=context)
 348
 349     def _product_get(self, cr, uid, id, product_ids=False, context=None, states=['done']):
 350         """
 351         @param product_ids:
 352         @param states:
 353         @return:
 354         """
 355         ids = id and [id] or []
 356         return self._product_get_multi_location(cr, uid, ids, product_ids, context=context, states=states)
 357
 358     def _product_all_get(self, cr, uid, id, product_ids=False, context=None, states=['done']):
 359         # build the list of ids of children of the location given by id
 360         ids = id and [id] or []
 361         location_ids = self.search(cr, uid, [('location_id', 'child_of', ids)])
 362         return self._product_get_multi_location(cr, uid, location_ids, product_ids, context, states)
 363
 364     def _product_virtual_get(self, cr, uid, id, product_ids=False, context=None, states=['done']):
 365         return self._product_all_get(cr, uid, id, product_ids, context, ['confirmed', 'waiting', 'assigned', 'done'])
 366
 367     def _product_reserve(self, cr, uid, ids, product_id, product_qty, context=None, lock=False):
 368         """
 369         Attempt to find a quantity ``product_qty`` (in the product's default uom or the uom passed in ``context``) of product ``product_id``
 370         in locations with id ``ids`` and their child locations. If ``lock`` is True, the stock.move lines
 371         of product with id ``product_id`` in the searched location will be write-locked using Postgres's
 372         "FOR UPDATE NOWAIT" option until the transaction is committed or rolled back, to prevent reservin
 373         twice the same products.
 374         If ``lock`` is True and the lock cannot be obtained (because another transaction has locked some of
 375         the same stock.move lines), a log line will be output and False will be returned, as if there was
 376         not enough stock.
 377
 378         :param product_id: Id of product to reserve
 379         :param product_qty: Quantity of product to reserve (in the product's default uom or the uom passed in ``context``)
 380         :param lock: if True, the stock.move lines of product with id ``product_id`` in all locations (and children locations) with ``ids`` will
 381                      be write-locked using postgres's "FOR UPDATE NOWAIT" option until the transaction is committed or rolled back. This is
 382                      to prevent reserving twice the same products.
 383         :param context: optional context dictionary: if a 'uom' key is present it will be used instead of the default product uom to
 384                         compute the ``product_qty`` and in the return value.
 385         :return: List of tuples in the form (qty, location_id) with the (partial) quantities that can be taken in each location to
 386                  reach the requested product_qty (``qty`` is expressed in the default uom of the product), of False if enough
 387                  products could not be found, or the lock could not be obtained (and ``lock`` was True).
 388         """
 389         result = []
 390         amount = 0.0
 391         if context is None:
 392             context = {}
 393         uom_obj = self.pool.get('product.uom')
 394         uom_rounding = self.pool.get('product.product').browse(cr, uid, product_id, context=context).uom_id.rounding
 395         if context.get('uom'):
 396             uom_rounding = uom_obj.browse(cr, uid, context.get('uom'), context=context).rounding
 397         for id in self.search(cr, uid, [('location_id', 'child_of', ids)]):
 398             if lock:
 399                 try:
 400                     # Must lock with a separate select query because FOR UPDATE can't be used with
 401                     # aggregation/group by's (when individual rows aren't identifiable).
 402                     # We use a SAVEPOINT to be able to rollback this part of the transaction without
 403                     # failing the whole transaction in case the LOCK cannot be acquired.
 404                     cr.execute("SAVEPOINT stock_location_product_reserve")
 405                     cr.execute("""SELECT id FROM stock_move
 406                                   WHERE product_id=%s AND
 407                                           (
 408                                             (location_dest_id=%s AND
 409                                              location_id<>%s AND
 410                                              state='done')
 411                                             OR
 412                                             (location_id=%s AND
 413                                              location_dest_id<>%s AND
 414                                              state in ('done', 'assigned'))
 415                                           )
 416                                   FOR UPDATE of stock_move NOWAIT""", (product_id, id, id, id, id), log_exceptions=False)
 417                 except Exception:
 418                     # Here it's likely that the FOR UPDATE NOWAIT failed to get the LOCK,
 419                     # so we ROLLBACK to the SAVEPOINT to restore the transaction to its earlier
 420                     # state, we return False as if the products were not available, and log it:
 421                     cr.execute("ROLLBACK TO stock_location_product_reserve")
 422                     _logger.warn("Failed attempt to reserve %s x product %s, likely due to another transaction already in progress. Next attempt is likely to work. Detailed error available at DEBUG level.", product_qty, product_id)
 423                     _logger.debug("Trace of the failed product reservation attempt: ", exc_info=True)
 424                     return False
 425
 426             # XXX TODO: rewrite this with one single query, possibly even the quantity conversion
 427             cr.execute("""SELECT product_uom, sum(product_qty) AS product_qty
 428                           FROM stock_move
 429                           WHERE location_dest_id=%s AND
 430                                 location_id<>%s AND
 431                                 product_id=%s AND
 432                                 state='done'
 433                           GROUP BY product_uom
 434                        """,
 435                        (id, id, product_id))
 436             results = cr.dictfetchall()
 437             cr.execute("""SELECT product_uom,-sum(product_qty) AS product_qty
 438                           FROM stock_move
 439                           WHERE location_id=%s AND
 440                                 location_dest_id<>%s AND
 441                                 product_id=%s AND
 442                                 state in ('done', 'assigned')
 443                           GROUP BY product_uom
 444                        """,
 445                        (id, id, product_id))
 446             results += cr.dictfetchall()
 447             total = 0.0
 448             results2 = 0.0
 449             for r in results:
 450                 amount = uom_obj._compute_qty(cr, uid, r['product_uom'], r['product_qty'], context.get('uom', False))
 451                 results2 += amount
 452                 total += amount
 453             if total <= 0.0:
 454                 continue
 455
 456             amount = results2
 457             compare_qty = float_compare(amount, 0, precision_rounding=uom_rounding)
 458             if compare_qty == 1:
 459                 if amount > min(total, product_qty):
 460                     amount = min(product_qty, total)
 461                 result.append((amount, id))
 462                 product_qty -= amount
 463                 total -= amount
 464                 if product_qty <= 0.0:
 465                     return result
 466                 if total <= 0.0:
 467                     continue
 468         return False
 469
 470 stock_location()
 471
 472
 473 class stock_tracking(osv.osv):
 474     _name = "stock.tracking"
 475     _description = "Packs"
 476
 477     def checksum(sscc):
 478         salt = '31' * 8 + '3'
 479         sum = 0
 480         for sscc_part, salt_part in zip(sscc, salt):
 481             sum += int(sscc_part) * int(salt_part)
 482         return (10 - (sum % 10)) % 10
 483     checksum = staticmethod(checksum)
 484
 485     def make_sscc(self, cr, uid, context=None):
 486         sequence = self.pool.get('ir.sequence').get(cr, uid, 'stock.lot.tracking')
 487         try:
 488             return sequence + str(self.checksum(sequence))
 489         except Exception:
 490             return sequence
 491
 492     _columns = {
 493         'name': fields.char('Pack Reference', size=64, required=True, select=True, help="By default, the pack reference is generated following the sscc standard. (Serial number + 1 check digit)"),
 494         'active': fields.boolean('Active', help="By unchecking the active field, you may hide a pack without deleting it."),
 495         'serial': fields.char('Additional Reference', size=64, select=True, help="Other reference or serial number"),
 496         'move_ids': fields.one2many('stock.move', 'tracking_id', 'Moves for this pack', readonly=True),
 497         'date': fields.datetime('Creation Date', required=True),
 498     }
 499     _defaults = {
 500         'active': 1,
 501         'name': make_sscc,
 502         'date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
 503     }
 504
 505     def name_search(self, cr, user, name, args=None, operator='ilike', context=None, limit=100):
 506         if not args:
 507             args = []
 508         ids = self.search(cr, user, [('serial', '=', name)]+ args, limit=limit, context=context)
 509         ids += self.search(cr, user, [('name', operator, name)]+ args, limit=limit, context=context)
 510         return self.name_get(cr, user, ids, context)
 511
 512     def name_get(self, cr, uid, ids, context=None):
 513         """Append the serial to the name"""
 514         if not len(ids):
 515             return []
 516         res = [ (r['id'], r['serial'] and '%s [%s]' % (r['name'], r['serial'])
 517                                       or r['name'] )
 518                 for r in self.read(cr, uid, ids, ['name', 'serial'],
 519                                    context=context) ]
 520         return res
 521
 522     def unlink(self, cr, uid, ids, context=None):
 523         raise osv.except_osv(_('Error!'), _('You cannot remove a lot line.'))
 524
 525     def action_traceability(self, cr, uid, ids, context={}):
 526         """ It traces the information of a product
 527         @param self: The object pointer.
 528         @param cr: A database cursor
 529         @param uid: ID of the user currently logged in
 530         @param ids: List of IDs selected
 531         @param context: A standard dictionary
 532         @return: A dictionary of values
 533         """
 534         return self.pool.get('action.traceability').action_traceability(cr,uid,ids,context)
 535
 536 stock_tracking()
 537
 538 #----------------------------------------------------------
 539 # Stock Picking
 540 #----------------------------------------------------------
 541 class stock_picking(osv.osv):
 542     _name = "stock.picking"
 543     _inherit = ['mail.thread']
 544     _description = "Picking List"
 545
 546     def _set_maximum_date(self, cr, uid, ids, name, value, arg, context=None):
 547         """ Calculates planned date if it is greater than 'value'.
 548         @param name: Name of field
 549         @param value: Value of field
 550         @param arg: User defined argument
 551         @return: True or False
 552         """
 553         if not value:
 554             return False
 555         if isinstance(ids, (int, long)):
 556             ids = [ids]
 557         for pick in self.browse(cr, uid, ids, context=context):
 558             sql_str = """update stock_move set
 559                     date='%s'
 560                 where
 561                     picking_id=%d """ % (value, pick.id)
 562
 563             if pick.max_date:
 564                 sql_str += " and (date='" + pick.max_date + "' or date>'" + value + "')"
 565             cr.execute(sql_str)
 566         return True
 567
 568     def _set_minimum_date(self, cr, uid, ids, name, value, arg, context=None):
 569         """ Calculates planned date if it is less than 'value'.
 570         @param name: Name of field
 571         @param value: Value of field
 572         @param arg: User defined argument
 573         @return: True or False
 574         """
 575         if not value:
 576             return False
 577         if isinstance(ids, (int, long)):
 578             ids = [ids]
 579         for pick in self.browse(cr, uid, ids, context=context):
 580             sql_str = """update stock_move set
 581                     date='%s'
 582                 where
 583                     picking_id=%s """ % (value, pick.id)
 584             if pick.min_date:
 585                 sql_str += " and (date='" + pick.min_date + "' or date<'" + value + "')"
 586             cr.execute(sql_str)
 587         return True
 588
 589     def get_min_max_date(self, cr, uid, ids, field_name, arg, context=None):
 590         """ Finds minimum and maximum dates for picking.
 591         @return: Dictionary of values
 592         """
 593         res = {}
 594         for id in ids:
 595             res[id] = {'min_date': False, 'max_date': False}
 596         if not ids:
 597             return res
 598         cr.execute("""select
 599                 picking_id,
 600                 min(date_expected),
 601                 max(date_expected)
 602             from
 603                 stock_move
 604             where
 605                 picking_id IN %s
 606             group by
 607                 picking_id""",(tuple(ids),))
 608         for pick, dt1, dt2 in cr.fetchall():
 609             res[pick]['min_date'] = dt1
 610             res[pick]['max_date'] = dt2
 611         return res
 612
 613     def create(self, cr, user, vals, context=None):
 614         if ('name' not in vals) or (vals.get('name')=='/'):
 615             seq_obj_name =  'stock.picking.' + vals['type']
 616             vals['name'] = self.pool.get('ir.sequence').get(cr, user, seq_obj_name)
 617         new_id = super(stock_picking, self).create(cr, user, vals, context)
 618         if new_id:
 619             self.create_send_note(cr, user, [new_id], context=context)
 620         return new_id
 621
 622     _columns = {
 623         'name': fields.char('Reference', size=64, select=True, states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 624         'origin': fields.char('Source', size=64, states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="Reference of the document", select=True),
 625         'backorder_id': fields.many2one('stock.picking', 'Back Order of', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="If this shipment was split, then this field links to the shipment which contains the already processed part.", select=True),
 626         'type': fields.selection([('out', 'Sending Goods'), ('in', 'Getting Goods'), ('internal', 'Internal')], 'Shipping Type', required=True, select=True, readonly=True, help="Shipping type specify, goods coming in or going out."),
 627         'note': fields.text('Notes', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 628         'stock_journal_id': fields.many2one('stock.journal','Stock Journal', select=True, states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 629         'location_id': fields.many2one('stock.location', 'Location', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="Keep empty if you produce at the location where the finished products are needed." \
 630                 "Set a location if you produce at a fixed location. This can be a partner location " \
 631                 "if you subcontract the manufacturing operations.", select=True),
 632         'location_dest_id': fields.many2one('stock.location', 'Dest. Location', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="Location where the system will stock the finished products.", select=True),
 633         'move_type': fields.selection([('direct', 'Partial'), ('one', 'All at once')], 'Delivery Method', required=True, states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="It specifies goods to be deliver partially or all at once"),
 634         'state': fields.selection([
 635             ('draft', 'Draft'),
 636             ('cancel', 'Cancelled'),
 637             ('auto', 'Waiting Another Operation'),
 638             ('confirmed', 'Waiting Availability'),
 639             ('assigned', 'Ready to Transfer'),
 640             ('done', 'Transferred'),
 641             ], 'Status', readonly=True, select=True, help="""
 642             * Draft: not confirmed yet and will not be scheduled until confirmed\n
 643             * Waiting Another Operation: waiting for another move to proceed before it becomes automatically available (e.g. in Make-To-Order flows)\n
 644             * Waiting Availability: still waiting for the availability of products\n
 645             * Ready to Transfer: products reserved, simply waiting for confirmation.\n
 646             * Transferred: has been processed, can't be modified or cancelled anymore\n
 647             * Cancelled: has been cancelled, can't be confirmed anymore"""
 648         ),
 649         'min_date': fields.function(get_min_max_date, fnct_inv=_set_minimum_date, multi="min_max_date",
 650                  store=True, type='datetime', string='Scheduled Date', select=1, help="Scheduled date for the shipment to be processed"),
 651         'date': fields.datetime('Order Date', help="Date of order", select=True, states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 652         'date_done': fields.datetime('Date Done', help="Date of Completion", states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 653         'max_date': fields.function(get_min_max_date, fnct_inv=_set_maximum_date, multi="min_max_date",
 654                  store=True, type='datetime', string='Max. Expected Date', select=2),
 655         'move_lines': fields.one2many('stock.move', 'picking_id', 'Internal Moves', states={'done': [('readonly', True)], 'cancel': [('readonly', True)]}),
 656         'product_id': fields.related('move_lines', 'product_id', type='many2one', relation='product.product', string='Product'),
 657         'auto_picking': fields.boolean('Auto-Picking', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 658         'partner_id': fields.many2one('res.partner', 'Partner', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 659         'invoice_state': fields.selection([
 660             ("invoiced", "Invoiced"),
 661             ("2binvoiced", "To Be Invoiced"),
 662             ("none", "Not Applicable")], "Invoice Control",
 663             select=True, required=True, readonly=True, states={'draft': [('readonly', False)]}),
 664         'company_id': fields.many2one('res.company', 'Company', required=True, select=True, states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}),
 665     }
 666     _defaults = {
 667         'name': lambda self, cr, uid, context: '/',
 668         'state': 'draft',
 669         'move_type': 'direct',
 670         'type': 'internal',
 671         'invoice_state': 'none',
 672         'date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
 673         'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.picking', context=c)
 674     }
 675     _sql_constraints = [
 676         ('name_uniq', 'unique(name, company_id)', 'Reference must be unique per Company!'),
 677     ]
 678
 679     def action_process(self, cr, uid, ids, context=None):
 680         if context is None:
 681             context = {}
 682         """Open the partial picking wizard"""
 683         context.update({
 684             'active_model': self._name,
 685             'active_ids': ids,
 686             'active_id': len(ids) and ids[0] or False
 687         })
 688         return {
 689             'view_type': 'form',
 690             'view_mode': 'form',
 691             'res_model': 'stock.partial.picking',
 692             'type': 'ir.actions.act_window',
 693             'target': 'new',
 694             'context': context,
 695             'nodestroy': True,
 696         }
 697
 698     def copy(self, cr, uid, id, default=None, context=None):
 699         if default is None:
 700             default = {}
 701         default = default.copy()
 702         picking_obj = self.browse(cr, uid, id, context=context)
 703         move_obj=self.pool.get('stock.move')
 704         if ('name' not in default) or (picking_obj.name=='/'):
 705             seq_obj_name =  'stock.picking.' + picking_obj.type
 706             default['name'] = self.pool.get('ir.sequence').get(cr, uid, seq_obj_name)
 707             default['origin'] = ''
 708             default['backorder_id'] = False
 709         if picking_obj.invoice_state == 'invoiced':
 710             default['invoice_state'] = '2binvoiced'
 711         res=super(stock_picking, self).copy(cr, uid, id, default, context)
 712         if res:
 713             picking_obj = self.browse(cr, uid, res, context=context)
 714             for move in picking_obj.move_lines:
 715                 move_obj.write(cr, uid, [move.id], {'tracking_id': False,'prodlot_id':False, 'move_history_ids2': [(6, 0, [])], 'move_history_ids': [(6, 0, [])]})
 716         return res
 717
 718     def fields_view_get(self, cr, uid, view_id=None, view_type=False, context=None, toolbar=False, submenu=False):
 719         if view_type == 'form' and not view_id:
 720             mod_obj = self.pool.get('ir.model.data')
 721             if self._name == "stock.picking.in":
 722                 model,view_id = mod_obj.get_object_reference(cr, uid, 'stock', 'view_picking_in_form')
 723             if self._name == "stock.picking.out":
 724                 model,view_id = mod_obj.get_object_reference(cr, uid, 'stock', 'view_picking_out_form')
 725         return super(stock_picking,self).fields_view_get(cr, uid, view_id=view_id, view_type=view_type, context=context, toolbar=toolbar, submenu=submenu)
 726
 727     def onchange_partner_in(self, cr, uid, context=None, partner_id=None):
 728         return {}
 729
 730     def action_explode(self, cr, uid, moves, context=None):
 731         """Hook to allow other modules to split the moves of a picking."""
 732         return moves
 733
 734     def action_confirm(self, cr, uid, ids, context=None):
 735         """ Confirms picking.
 736         @return: True
 737         """
 738         pickings = self.browse(cr, uid, ids, context=context)
 739         for picking in pickings:
 740             if picking.state <> 'confirmed':
 741                 self.confirm_send_note(cr, uid, [picking.id], context=context)
 742         self.write(cr, uid, ids, {'state': 'confirmed'})
 743         todo = []
 744         for picking in pickings:
 745             for r in picking.move_lines:
 746                 if r.state == 'draft':
 747                     todo.append(r.id)
 748         todo = self.action_explode(cr, uid, todo, context)
 749         if len(todo):
 750             self.pool.get('stock.move').action_confirm(cr, uid, todo, context=context)
 751         return True
 752
 753     def test_auto_picking(self, cr, uid, ids):
 754         # TODO: Check locations to see if in the same location ?
 755         return True
 756
 757     def action_assign(self, cr, uid, ids, *args):
 758         """ Changes state of picking to available if all moves are confirmed.
 759         @return: True
 760         """
 761         wf_service = netsvc.LocalService("workflow")
 762         for pick in self.browse(cr, uid, ids):
 763             if pick.state == 'draft':
 764                 wf_service.trg_validate(uid, 'stock.picking', pick.id, 'button_confirm', cr)
 765             move_ids = [x.id for x in pick.move_lines if x.state == 'confirmed']
 766             if not move_ids:
 767                 raise osv.except_osv(_('Warning!'),_('Not enough stock, unable to reserve the products.'))
 768             self.pool.get('stock.move').action_assign(cr, uid, move_ids)
 769         return True
 770
 771     def force_assign(self, cr, uid, ids, *args):
 772         """ Changes state of picking to available if moves are confirmed or waiting.
 773         @return: True
 774         """
 775         wf_service = netsvc.LocalService("workflow")
 776         for pick in self.browse(cr, uid, ids):
 777             move_ids = [x.id for x in pick.move_lines if x.state in ['confirmed','waiting']]
 778             self.pool.get('stock.move').force_assign(cr, uid, move_ids)
 779             wf_service.trg_write(uid, 'stock.picking', pick.id, cr)
 780         return True
 781
 782     def draft_force_assign(self, cr, uid, ids, *args):
 783         """ Confirms picking directly from draft state.
 784         @return: True
 785         """
 786         wf_service = netsvc.LocalService("workflow")
 787         for pick in self.browse(cr, uid, ids):
 788             if not pick.move_lines:
 789                 raise osv.except_osv(_('Error!'),_('You cannot process picking without stock moves.'))
 790             wf_service.trg_validate(uid, 'stock.picking', pick.id,
 791                 'button_confirm', cr)
 792         return True
 793
 794     def draft_validate(self, cr, uid, ids, context=None):
 795         """ Validates picking directly from draft state.
 796         @return: True
 797         """
 798         wf_service = netsvc.LocalService("workflow")
 799         self.draft_force_assign(cr, uid, ids)
 800         for pick in self.browse(cr, uid, ids, context=context):
 801             move_ids = [x.id for x in pick.move_lines]
 802             self.pool.get('stock.move').force_assign(cr, uid, move_ids)
 803             wf_service.trg_write(uid, 'stock.picking', pick.id, cr)
 804         return self.action_process(
 805             cr, uid, ids, context=context)
 806     def cancel_assign(self, cr, uid, ids, *args):
 807         """ Cancels picking and moves.
 808         @return: True
 809         """
 810         wf_service = netsvc.LocalService("workflow")
 811         for pick in self.browse(cr, uid, ids):
 812             move_ids = [x.id for x in pick.move_lines]
 813             self.pool.get('stock.move').cancel_assign(cr, uid, move_ids)
 814             wf_service.trg_write(uid, 'stock.picking', pick.id, cr)
 815         return True
 816
 817     def action_assign_wkf(self, cr, uid, ids, context=None):
 818         """ Changes picking state to assigned.
 819         @return: True
 820         """
 821         self.write(cr, uid, ids, {'state': 'assigned'})
 822         return True
 823
 824     def test_finished(self, cr, uid, ids):
 825         """ Tests whether the move is in done or cancel state or not.
 826         @return: True or False
 827         """
 828         move_ids = self.pool.get('stock.move').search(cr, uid, [('picking_id', 'in', ids)])
 829         for move in self.pool.get('stock.move').browse(cr, uid, move_ids):
 830             if move.state not in ('done', 'cancel'):
 831
 832                 if move.product_qty != 0.0:
 833                     return False
 834                 else:
 835                     move.write({'state': 'done'})
 836         return True
 837
 838     def test_assigned(self, cr, uid, ids):
 839         """ Tests whether the move is in assigned state or not.
 840         @return: True or False
 841         """
 842         #TOFIX: assignment of move lines should be call before testing assigment otherwise picking never gone in assign state
 843         ok = True
 844         for pick in self.browse(cr, uid, ids):
 845             mt = pick.move_type
 846             # incomming shipments are always set as available if they aren't chained
 847             if pick.type == 'in':
 848                 if all([x.state != 'waiting' for x in pick.move_lines]):
 849                     return True
 850             for move in pick.move_lines:
 851                 if (move.state in ('confirmed', 'draft')) and (mt == 'one'):
 852                     return False
 853                 if (mt == 'direct') and (move.state == 'assigned') and (move.product_qty):
 854                     return True
 855                 ok = ok and (move.state in ('cancel', 'done', 'assigned'))
 856         return ok
 857
 858     def action_cancel(self, cr, uid, ids, context=None):
 859         """ Changes picking state to cancel.
 860         @return: True
 861         """
 862         for pick in self.browse(cr, uid, ids, context=context):
 863             ids2 = [move.id for move in pick.move_lines]
 864             self.pool.get('stock.move').action_cancel(cr, uid, ids2, context)
 865         self.write(cr, uid, ids, {'state': 'cancel', 'invoice_state': 'none'})
 866         self.ship_cancel_send_note(cr, uid, ids, context)
 867         return True
 868
 869     #
 870     # TODO: change and create a move if not parents
 871     #
 872     def action_done(self, cr, uid, ids, context=None):
 873         """Changes picking state to done.
 874
 875         This method is called at the end of the workflow by the activity "done".
 876         @return: True
 877         """
 878         self.write(cr, uid, ids, {'state': 'done', 'date_done': time.strftime('%Y-%m-%d %H:%M:%S')})
 879         return True
 880
 881     def action_move(self, cr, uid, ids, context=None):
 882         """Process the Stock Moves of the Picking
 883
 884         This method is called by the workflow by the activity "move".
 885         Normally that happens when the signal button_done is received (button
 886         "Done" pressed on a Picking view).
 887         @return: True
 888         """
 889         for pick in self.browse(cr, uid, ids, context=context):
 890             todo = []
 891             for move in pick.move_lines:
 892                 if move.state == 'draft':
 893                     self.pool.get('stock.move').action_confirm(cr, uid, [move.id],
 894                         context=context)
 895                     todo.append(move.id)
 896                 elif move.state in ('assigned','confirmed'):
 897                     todo.append(move.id)
 898             if len(todo):
 899                 self.pool.get('stock.move').action_done(cr, uid, todo,
 900                         context=context)
 901         return True
 902
 903     def get_currency_id(self, cr, uid, picking):
 904         return False
 905
 906     def _get_partner_to_invoice(self, cr, uid, picking, context=None):
 907         """ Gets the partner that will be invoiced
 908             Note that this function is inherited in the sale and purchase modules
 909             @param picking: object of the picking for which we are selecting the partner to invoice
 910             @return: object of the partner to invoice
 911         """
 912         return picking.partner_id and picking.partner_id.id
 913
 914     def _get_comment_invoice(self, cr, uid, picking):
 915         """
 916         @return: comment string for invoice
 917         """
 918         return picking.note or ''
 919
 920     def _get_price_unit_invoice(self, cr, uid, move_line, type, context=None):
 921         """ Gets price unit for invoice
 922         @param move_line: Stock move lines
 923         @param type: Type of invoice
 924         @return: The price unit for the move line
 925         """
 926         if context is None:
 927             context = {}
 928
 929         if type in ('in_invoice', 'in_refund'):
 930             # Take the user company and pricetype
 931             context['currency_id'] = move_line.company_id.currency_id.id
 932             amount_unit = move_line.product_id.price_get('standard_price', context=context)[move_line.product_id.id]
 933             return amount_unit
 934         else:
 935             return move_line.product_id.list_price
 936
 937     def _get_discount_invoice(self, cr, uid, move_line):
 938         '''Return the discount for the move line'''
 939         return 0.0
 940
 941     def _get_taxes_invoice(self, cr, uid, move_line, type):
 942         """ Gets taxes on invoice
 943         @param move_line: Stock move lines
 944         @param type: Type of invoice
 945         @return: Taxes Ids for the move line
 946         """
 947         if type in ('in_invoice', 'in_refund'):
 948             taxes = move_line.product_id.supplier_taxes_id
 949         else:
 950             taxes = move_line.product_id.taxes_id
 951
 952         if move_line.picking_id and move_line.picking_id.partner_id and move_line.picking_id.partner_id.id:
 953             return self.pool.get('account.fiscal.position').map_tax(
 954                 cr,
 955                 uid,
 956                 move_line.picking_id.partner_id.property_account_position,
 957                 taxes
 958             )
 959         else:
 960             return map(lambda x: x.id, taxes)
 961
 962     def _get_account_analytic_invoice(self, cr, uid, picking, move_line):
 963         return False
 964
 965     def _invoice_line_hook(self, cr, uid, move_line, invoice_line_id):
 966         '''Call after the creation of the invoice line'''
 967         return
 968
 969     def _invoice_hook(self, cr, uid, picking, invoice_id):
 970         '''Call after the creation of the invoice'''
 971         return
 972
 973     def _get_invoice_type(self, pick):
 974         src_usage = dest_usage = None
 975         inv_type = None
 976         if pick.invoice_state == '2binvoiced':
 977             if pick.move_lines:
 978                 src_usage = pick.move_lines[0].location_id.usage
 979                 dest_usage = pick.move_lines[0].location_dest_id.usage
 980             if pick.type == 'out' and dest_usage == 'supplier':
 981                 inv_type = 'in_refund'
 982             elif pick.type == 'out' and dest_usage == 'customer':
 983                 inv_type = 'out_invoice'
 984             elif pick.type == 'in' and src_usage == 'supplier':
 985                 inv_type = 'in_invoice'
 986             elif pick.type == 'in' and src_usage == 'customer':
 987                 inv_type = 'out_refund'
 988             else:
 989                 inv_type = 'out_invoice'
 990         return inv_type
 991
 992     def _prepare_invoice_group(self, cr, uid, picking, partner, invoice, context=None):
 993         """ Builds the dict for grouped invoices
 994             @param picking: picking object
 995             @param partner: object of the partner to invoice (not used here, but may be usefull if this function is inherited)
 996             @param invoice: object of the invoice that we are updating
 997             @return: dict that will be used to update the invoice
 998         """
 999         comment = self._get_comment_invoice(cr, uid, picking)
1000         return {
1001             'name': (invoice.name or '') + ', ' + (picking.name or ''),
1002             'origin': (invoice.origin or '') + ', ' + (picking.name or '') + (picking.origin and (':' + picking.origin) or ''),
1003             'comment': (comment and (invoice.comment and invoice.comment + "\n" + comment or comment)) or (invoice.comment and invoice.comment or ''),
1004             'date_invoice': context.get('date_inv', False),
1005             'user_id': uid,
1006         }
1007
1008     def _prepare_invoice(self, cr, uid, picking, partner, inv_type, journal_id, context=None):
1009         """ Builds the dict containing the values for the invoice
1010             @param picking: picking object
1011             @param partner: object of the partner to invoice
1012             @param inv_type: type of the invoice ('out_invoice', 'in_invoice', ...)
1013             @param journal_id: ID of the accounting journal
1014             @return: dict that will be used to create the invoice object
1015         """
1016         if isinstance(partner, int):
1017             partner = self.pool.get('res.partner').browse(cr, uid, partner, context=context)
1018         if inv_type in ('out_invoice', 'out_refund'):
1019             account_id = partner.property_account_receivable.id
1020         else:
1021             account_id = partner.property_account_payable.id
1022         comment = self._get_comment_invoice(cr, uid, picking)
1023         invoice_vals = {
1024             'name': picking.name,
1025             'origin': (picking.name or '') + (picking.origin and (':' + picking.origin) or ''),
1026             'type': inv_type,
1027             'account_id': account_id,
1028             'partner_id': partner.id,
1029             'comment': comment,
1030             'payment_term': partner.property_payment_term and partner.property_payment_term.id or False,
1031             'fiscal_position': partner.property_account_position.id,
1032             'date_invoice': context.get('date_inv', False),
1033             'company_id': picking.company_id.id,
1034             'user_id': uid,
1035         }
1036         cur_id = self.get_currency_id(cr, uid, picking)
1037         if cur_id:
1038             invoice_vals['currency_id'] = cur_id
1039         if journal_id:
1040             invoice_vals['journal_id'] = journal_id
1041         return invoice_vals
1042
1043     def _prepare_invoice_line(self, cr, uid, group, picking, move_line, invoice_id,
1044         invoice_vals, context=None):
1045         """ Builds the dict containing the values for the invoice line
1046             @param group: True or False
1047             @param picking: picking object
1048             @param: move_line: move_line object
1049             @param: invoice_id: ID of the related invoice
1050             @param: invoice_vals: dict used to created the invoice
1051             @return: dict that will be used to create the invoice line
1052         """
1053         if group:
1054             name = (picking.name or '') + '-' + move_line.name
1055         else:
1056             name = move_line.name
1057         origin = move_line.picking_id.name or ''
1058         if move_line.picking_id.origin:
1059             origin += ':' + move_line.picking_id.origin
1060
1061         if invoice_vals['type'] in ('out_invoice', 'out_refund'):
1062             account_id = move_line.product_id.product_tmpl_id.\
1063                     property_account_income.id
1064             if not account_id:
1065                 account_id = move_line.product_id.categ_id.\
1066                         property_account_income_categ.id
1067         else:
1068             account_id = move_line.product_id.product_tmpl_id.\
1069                     property_account_expense.id
1070             if not account_id:
1071                 account_id = move_line.product_id.categ_id.\
1072                         property_account_expense_categ.id
1073         if invoice_vals['fiscal_position']:
1074             fp_obj = self.pool.get('account.fiscal.position')
1075             fiscal_position = fp_obj.browse(cr, uid, invoice_vals['fiscal_position'], context=context)
1076             account_id = fp_obj.map_account(cr, uid, fiscal_position, account_id)
1077         # set UoS if it's a sale and the picking doesn't have one
1078         uos_id = move_line.product_uos and move_line.product_uos.id or False
1079         if not uos_id and invoice_vals['type'] in ('out_invoice', 'out_refund'):
1080             uos_id = move_line.product_uom.id
1081
1082         return {
1083             'name': name,
1084             'origin': origin,
1085             'invoice_id': invoice_id,
1086             'uos_id': uos_id,
1087             'product_id': move_line.product_id.id,
1088             'account_id': account_id,
1089             'price_unit': self._get_price_unit_invoice(cr, uid, move_line, invoice_vals['type']),
1090             'discount': self._get_discount_invoice(cr, uid, move_line),
1091             'quantity': move_line.product_uos_qty or move_line.product_qty,
1092             'invoice_line_tax_id': [(6, 0, self._get_taxes_invoice(cr, uid, move_line, invoice_vals['type']))],
1093             'account_analytic_id': self._get_account_analytic_invoice(cr, uid, picking, move_line),
1094         }
1095
1096     def action_invoice_create(self, cr, uid, ids, journal_id=False,
1097             group=False, type='out_invoice', context=None):
1098         """ Creates invoice based on the invoice state selected for picking.
1099         @param journal_id: Id of journal
1100         @param group: Whether to create a group invoice or not
1101         @param type: Type invoice to be created
1102         @return: Ids of created invoices for the pickings
1103         """
1104         if context is None:
1105             context = {}
1106
1107         invoice_obj = self.pool.get('account.invoice')
1108         invoice_line_obj = self.pool.get('account.invoice.line')
1109         partner_obj = self.pool.get('res.partner')
1110         invoices_group = {}
1111         res = {}
1112         inv_type = type
1113         for picking in self.browse(cr, uid, ids, context=context):
1114             if picking.invoice_state != '2binvoiced':
1115                 continue
1116             partner = self._get_partner_to_invoice(cr, uid, picking, context=context)
1117             if isinstance(partner, int):
1118                 partner = partner_obj.browse(cr, uid, [partner], context=context)[0]
1119             if not partner:
1120                 raise osv.except_osv(_('Error, no partner !'),
1121                     _('Please put a partner on the picking list if you want to generate invoice.'))
1122
1123             if not inv_type:
1124                 inv_type = self._get_invoice_type(picking)
1125
1126             if group and partner.id in invoices_group:
1127                 invoice_id = invoices_group[partner.id]
1128                 invoice = invoice_obj.browse(cr, uid, invoice_id)
1129                 invoice_vals_group = self._prepare_invoice_group(cr, uid, picking, partner, invoice, context=context)
1130                 invoice_obj.write(cr, uid, [invoice_id], invoice_vals_group, context=context)
1131             else:
1132                 invoice_vals = self._prepare_invoice(cr, uid, picking, partner, inv_type, journal_id, context=context)
1133                 invoice_id = invoice_obj.create(cr, uid, invoice_vals, context=context)
1134                 invoices_group[partner.id] = invoice_id
1135             res[picking.id] = invoice_id
1136             for move_line in picking.move_lines:
1137                 if move_line.state == 'cancel':
1138                     continue
1139                 vals = self._prepare_invoice_line(cr, uid, group, picking, move_line,
1140                                 invoice_id, invoice_vals, context=context)
1141                 if vals:
1142                     invoice_line_id = invoice_line_obj.create(cr, uid, vals, context=context)
1143                     self._invoice_line_hook(cr, uid, move_line, invoice_line_id)
1144
1145             invoice_obj.button_compute(cr, uid, [invoice_id], context=context,
1146                     set_total=(inv_type in ('in_invoice', 'in_refund')))
1147             self.write(cr, uid, [picking.id], {
1148                 'invoice_state': 'invoiced',
1149                 }, context=context)
1150             self._invoice_hook(cr, uid, picking, invoice_id)
1151         self.write(cr, uid, res.keys(), {
1152             'invoice_state': 'invoiced',
1153             }, context=context)
1154         return res
1155
1156     def test_done(self, cr, uid, ids, context=None):
1157         """ Test whether the move lines are done or not.
1158         @return: True or False
1159         """
1160         ok = False
1161         for pick in self.browse(cr, uid, ids, context=context):
1162             if not pick.move_lines:
1163                 return True
1164             for move in pick.move_lines:
1165                 if move.state not in ('cancel','done'):
1166                     return False
1167                 if move.state=='done':
1168                     ok = True
1169         return ok
1170
1171     def test_cancel(self, cr, uid, ids, context=None):
1172         """ Test whether the move lines are canceled or not.
1173         @return: True or False
1174         """
1175         for pick in self.browse(cr, uid, ids, context=context):
1176             for move in pick.move_lines:
1177                 if move.state not in ('cancel',):
1178                     return False
1179         return True
1180
1181     def allow_cancel(self, cr, uid, ids, context=None):
1182         for pick in self.browse(cr, uid, ids, context=context):
1183             if not pick.move_lines:
1184                 return True
1185             for move in pick.move_lines:
1186                 if move.state == 'done':
1187                     raise osv.except_osv(_('Error!'), _('You cannot cancel the picking as some moves have been done. You should cancel the picking lines.'))
1188         return True
1189
1190     def unlink(self, cr, uid, ids, context=None):
1191         move_obj = self.pool.get('stock.move')
1192         if context is None:
1193             context = {}
1194         for pick in self.browse(cr, uid, ids, context=context):
1195             if pick.state in ['done','cancel']:
1196                 raise osv.except_osv(_('Error!'), _('You cannot remove the picking which is in %s state!')%(pick.state,))
1197             else:
1198                 ids2 = [move.id for move in pick.move_lines]
1199                 ctx = context.copy()
1200                 ctx.update({'call_unlink':True})
1201                 if pick.state != 'draft':
1202                     #Cancelling the move in order to affect Virtual stock of product
1203                     move_obj.action_cancel(cr, uid, ids2, ctx)
1204                 #Removing the move
1205                 move_obj.unlink(cr, uid, ids2, ctx)
1206
1207         return super(stock_picking, self).unlink(cr, uid, ids, context=context)
1208
1209     # FIXME: needs refactoring, this code is partially duplicated in stock_move.do_partial()!
1210     def do_partial(self, cr, uid, ids, partial_datas, context=None):
1211         """ Makes partial picking and moves done.
1212         @param partial_datas : Dictionary containing details of partial picking
1213                           like partner_id, partner_id, delivery_date,
1214                           delivery moves with product_id, product_qty, uom
1215         @return: Dictionary of values
1216         """
1217         if context is None:
1218             context = {}
1219         else:
1220             context = dict(context)
1221         res = {}
1222         move_obj = self.pool.get('stock.move')
1223         product_obj = self.pool.get('product.product')
1224         currency_obj = self.pool.get('res.currency')
1225         uom_obj = self.pool.get('product.uom')
1226         sequence_obj = self.pool.get('ir.sequence')
1227         wf_service = netsvc.LocalService("workflow")
1228         for pick in self.browse(cr, uid, ids, context=context):
1229             new_picking = None
1230             complete, too_many, too_few = [], [], []
1231             move_product_qty, prodlot_ids, product_avail, partial_qty, product_uoms = {}, {}, {}, {}, {}
1232             for move in pick.move_lines:
1233                 if move.state in ('done', 'cancel'):
1234                     continue
1235                 partial_data = partial_datas.get('move%s'%(move.id), {})
1236                 product_qty = partial_data.get('product_qty',0.0)
1237                 move_product_qty[move.id] = product_qty
1238                 product_uom = partial_data.get('product_uom',False)
1239                 product_price = partial_data.get('product_price',0.0)
1240                 product_currency = partial_data.get('product_currency',False)
1241                 prodlot_id = partial_data.get('prodlot_id')
1242                 prodlot_ids[move.id] = prodlot_id
1243                 product_uoms[move.id] = product_uom
1244                 partial_qty[move.id] = uom_obj._compute_qty(cr, uid, product_uoms[move.id], product_qty, move.product_uom.id)
1245                 if move.product_qty == partial_qty[move.id]:
1246                     complete.append(move)
1247                 elif move.product_qty > partial_qty[move.id]:
1248                     too_few.append(move)
1249                 else:
1250                     too_many.append(move)
1251
1252                 # Average price computation
1253                 if (pick.type == 'in') and (move.product_id.cost_method == 'average'):
1254                     product = product_obj.browse(cr, uid, move.product_id.id)
1255                     move_currency_id = move.company_id.currency_id.id
1256                     context['currency_id'] = move_currency_id
1257                     qty = uom_obj._compute_qty(cr, uid, product_uom, product_qty, product.uom_id.id)
1258
1259                     if product.id in product_avail:
1260                         product_avail[product.id] += qty
1261                     else:
1262                         product_avail[product.id] = product.qty_available
1263
1264                     if qty > 0:
1265                         new_price = currency_obj.compute(cr, uid, product_currency,
1266                                 move_currency_id, product_price)
1267                         new_price = uom_obj._compute_price(cr, uid, product_uom, new_price,
1268                                 product.uom_id.id)
1269                         if product.qty_available <= 0:
1270                             new_std_price = new_price
1271                         else:
1272                             # Get the standard price
1273                             amount_unit = product.price_get('standard_price', context=context)[product.id]
1274                             new_std_price = ((amount_unit * product_avail[product.id])\
1275                                 + (new_price * qty))/(product_avail[product.id] + qty)
1276                         # Write the field according to price type field
1277                         product_obj.write(cr, uid, [product.id], {'standard_price': new_std_price})
1278
1279                         # Record the values that were chosen in the wizard, so they can be
1280                         # used for inventory valuation if real-time valuation is enabled.
1281                         move_obj.write(cr, uid, [move.id],
1282                                 {'price_unit': product_price,
1283                                  'price_currency_id': product_currency})
1284
1285
1286             for move in too_few:
1287                 product_qty = move_product_qty[move.id]
1288                 if not new_picking:
1289                     new_picking_name = pick.name
1290                     self.write(cr, uid, [pick.id],
1291                                {'name': sequence_obj.get(cr, uid,
1292                                             'stock.picking.%s'%(pick.type)),
1293                                })
1294                     new_picking = self.copy(cr, uid, pick.id,
1295                             {
1296                                 'name': new_picking_name,
1297                                 'move_lines' : [],
1298                                 'state':'draft',
1299                             })
1300                 if product_qty != 0:
1301                     defaults = {
1302                             'product_qty' : product_qty,
1303                             'product_uos_qty': product_qty, #TODO: put correct uos_qty
1304                             'picking_id' : new_picking,
1305                             'state': 'assigned',
1306                             'move_dest_id': False,
1307                             'price_unit': move.price_unit,
1308                             'product_uom': product_uoms[move.id]
1309                     }
1310                     prodlot_id = prodlot_ids[move.id]
1311                     if prodlot_id:
1312                         defaults.update(prodlot_id=prodlot_id)
1313                     move_obj.copy(cr, uid, move.id, defaults)
1314                 move_obj.write(cr, uid, [move.id],
1315                         {
1316                             'product_qty': move.product_qty - partial_qty[move.id],
1317                             'product_uos_qty': move.product_qty - partial_qty[move.id], #TODO: put correct uos_qty
1318                             'prodlot_id': False,
1319                             'tracking_id': False,
1320                         })
1321
1322             if new_picking:
1323                 move_obj.write(cr, uid, [c.id for c in complete], {'picking_id': new_picking})
1324             for move in complete:
1325                 defaults = {'product_uom': product_uoms[move.id], 'product_qty': move_product_qty[move.id]}
1326                 if prodlot_ids.get(move.id):
1327                     defaults.update({'prodlot_id': prodlot_ids[move.id]})
1328                 move_obj.write(cr, uid, [move.id], defaults)
1329             for move in too_many:
1330                 product_qty = move_product_qty[move.id]
1331                 defaults = {
1332                     'product_qty' : product_qty,
1333                     'product_uos_qty': product_qty, #TODO: put correct uos_qty
1334                     'product_uom': product_uoms[move.id]
1335                 }
1336                 prodlot_id = prodlot_ids.get(move.id)
1337                 if prodlot_ids.get(move.id):
1338                     defaults.update(prodlot_id=prodlot_id)
1339                 if new_picking:
1340                     defaults.update(picking_id=new_picking)
1341                 move_obj.write(cr, uid, [move.id], defaults)
1342
1343             # At first we confirm the new picking (if necessary)
1344             if new_picking:
1345                 wf_service.trg_validate(uid, 'stock.picking', new_picking, 'button_confirm', cr)
1346                 # Then we finish the good picking
1347                 self.write(cr, uid, [pick.id], {'backorder_id': new_picking})
1348                 self.action_move(cr, uid, [new_picking])
1349                 wf_service.trg_validate(uid, 'stock.picking', new_picking, 'button_done', cr)
1350                 wf_service.trg_write(uid, 'stock.picking', pick.id, cr)
1351                 delivered_pack_id = new_picking
1352                 back_order_name = self.browse(cr, uid, delivered_pack_id, context=context).name
1353                 self.back_order_send_note(cr, uid, ids, back_order_name, context)
1354             else:
1355                 self.action_move(cr, uid, [pick.id])
1356                 wf_service.trg_validate(uid, 'stock.picking', pick.id, 'button_done', cr)
1357                 delivered_pack_id = pick.id
1358                 self.ship_done_send_note(cr, uid, ids, context)
1359
1360             delivered_pack = self.browse(cr, uid, delivered_pack_id, context=context)
1361             res[pick.id] = {'delivered_picking': delivered_pack.id or False}
1362
1363         return res
1364
1365     # views associated to each picking type
1366     _VIEW_LIST = {
1367         'out': 'view_picking_out_form',
1368         'in': 'view_picking_in_form',
1369         'internal': 'view_picking_form',
1370     }
1371     def _get_view_id(self, cr, uid, type):
1372         """Get the view id suiting the given type
1373
1374         @param type: the picking type as a string
1375         @return: view i, or False if no view found
1376         """
1377         res = self.pool.get('ir.model.data').get_object_reference(cr, uid,
1378             'stock', self._VIEW_LIST.get(type, 'view_picking_form'))
1379         return res and res[1] or False
1380
1381     def log_picking(self, cr, uid, ids, context=None):
1382         """ This function will create log messages for picking.
1383         @param cr: the database cursor
1384         @param uid: the current user's ID for security checks,
1385         @param ids: List of Picking Ids
1386         @param context: A standard dictionary for contextual values
1387         """
1388         if context is None:
1389             context = {}
1390         for pick in self.browse(cr, uid, ids, context=context):
1391             msg=''
1392             if pick.auto_picking:
1393                 continue
1394             type_list = {
1395                 'out':_("Delivery Order"),
1396                 'in':_('Reception'),
1397                 'internal': _('Internal picking'),
1398             }
1399             message = type_list.get(pick.type, _('Document')) + " '" + (pick.name or '?') + "' "
1400             if pick.min_date:
1401                 msg= _(' for the ')+ datetime.strptime(pick.min_date, '%Y-%m-%d %H:%M:%S').strftime('%m/%d/%Y')
1402             state_list = {
1403                 'confirmed': _('is scheduled %s.') % msg,
1404                 'assigned': _('is ready to process.'),
1405                 'cancel': _('is cancelled.'),
1406                 'done': _('is done.'),
1407                 'auto': _('is waiting.'),
1408                 'draft': _('is in draft state.'),
1409             }
1410             context['view_id'] = self._get_view_id(cr, uid, pick.type)
1411             message += state_list[pick.state]
1412         return True
1413
1414     # -----------------------------------------
1415     # OpenChatter methods and notifications
1416     # -----------------------------------------
1417
1418     def _get_document_type(self, cr, uid, obj, context=None):
1419         type_dict = {
1420                 'out': _('Delivery order'),
1421                 'in': _('Shipment'),
1422                 'internal': _('Internal picking'),
1423         }
1424         return type_dict.get(obj.type, _('Picking'))
1425
1426     def create_send_note(self, cr, uid, ids, context=None):
1427         for obj in self.browse(cr, uid, ids, context=context):
1428             self.message_post(cr, uid, [obj.id], body=_("%s has been <b>created</b>.") % (self._get_document_type(cr, uid, obj, context=context)), subtype="mt_stock_new", context=context)
1429
1430     def confirm_send_note(self, cr, uid, ids, context=None):
1431         for obj in self.browse(cr, uid, ids, context=context):
1432             self.message_post(cr, uid, [obj.id], body=_("%s has been <b>confirmed</b>.") % (self._get_document_type(cr, uid, obj, context=context)), context=context)
1433
1434     def scrap_send_note(self, cr, uid, ids, quantity, uom, name, context=None):
1435         return self.message_post(cr, uid, ids, body=_("%s %s %s has been <b>moved to</b> scrap.") % (quantity, uom, name), context=context)
1436
1437     def back_order_send_note(self, cr, uid, ids, back_name, context=None):
1438         return self.message_post(cr, uid, ids, body=_("Back order <em>%s</em> has been <b>created</b>.") % (back_name), subtype="mt_stock_new", context=context)
1439
1440     def ship_done_send_note(self, cr, uid, ids, context=None):
1441         type_dict = {
1442                 'out': _("Products have been <b>delivered</b>."),
1443                 'in': _("Products have been <b>received</b>."),
1444                 'internal': _("Products have been <b>moved</b>."),
1445         }
1446         xml_id_dict = {
1447                        'out': 'mt_stock_delivered',
1448                        'in': 'mt_stock_received'
1449                        }
1450         for obj in self.browse(cr, uid, ids, context=context):
1451             self.message_post(cr, uid, [obj.id], body=_("Products have been <b>%s</b>.") % (type_dict.get(obj.type, 'move done')), subtype=xml_id_dict.get(obj.type), context=context)
1452
1453     def ship_cancel_send_note(self, cr, uid, ids, context=None):
1454         for obj in self.browse(cr, uid, ids, context=context):
1455             self.message_post(cr, uid, [obj.id], body=_("%s has been <b>cancelled</b>.") % (self._get_document_type(cr, uid, obj, context=context)), context=context)
1456
1457
1458 stock_picking()
1459
1460 class stock_production_lot(osv.osv):
1461
1462     def name_get(self, cr, uid, ids, context=None):
1463         if not ids:
1464             return []
1465         reads = self.read(cr, uid, ids, ['name', 'prefix', 'ref'], context)
1466         res = []
1467         for record in reads:
1468             name = record['name']
1469             prefix = record['prefix']
1470             if prefix:
1471                 name = prefix + '/' + name
1472             if record['ref']:
1473                 name = '%s [%s]' % (name, record['ref'])
1474             res.append((record['id'], name))
1475         return res
1476
1477     def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
1478         args = args or []
1479         ids = []
1480         if name:
1481             ids = self.search(cr, uid, [('prefix', '=', name)] + args, limit=limit, context=context)
1482             if not ids:
1483                 ids = self.search(cr, uid, [('name', operator, name)] + args, limit=limit, context=context)
1484         else:
1485             ids = self.search(cr, uid, args, limit=limit, context=context)
1486         return self.name_get(cr, uid, ids, context)
1487
1488     _name = 'stock.production.lot'
1489     _description = 'Serial Number'
1490
1491     def _get_stock(self, cr, uid, ids, field_name, arg, context=None):
1492         """ Gets stock of products for locations
1493         @return: Dictionary of values
1494         """
1495         if context is None:
1496             context = {}
1497         if 'location_id' not in context:
1498             locations = self.pool.get('stock.location').search(cr, uid, [('usage', '=', 'internal')], context=context)
1499         else:
1500             locations = context['location_id'] and [context['location_id']] or []
1501
1502         if isinstance(ids, (int, long)):
1503             ids = [ids]
1504
1505         res = {}.fromkeys(ids, 0.0)
1506         if locations:
1507             cr.execute('''select
1508                     prodlot_id,
1509                     sum(qty)
1510                 from
1511                     stock_report_prodlots
1512                 where
1513                     location_id IN %s and prodlot_id IN %s group by prodlot_id''',(tuple(locations),tuple(ids),))
1514             res.update(dict(cr.fetchall()))
1515
1516         return res
1517
1518     def _stock_search(self, cr, uid, obj, name, args, context=None):
1519         """ Searches Ids of products
1520         @return: Ids of locations
1521         """
1522         locations = self.pool.get('stock.location').search(cr, uid, [('usage', '=', 'internal')])
1523         cr.execute('''select
1524                 prodlot_id,
1525                 sum(qty)
1526             from
1527                 stock_report_prodlots
1528             where
1529                 location_id IN %s group by prodlot_id
1530             having  sum(qty) '''+ str(args[0][1]) + str(args[0][2]),(tuple(locations),))
1531         res = cr.fetchall()
1532         ids = [('id', 'in', map(lambda x: x[0], res))]
1533         return ids
1534
1535     _columns = {
1536         'name': fields.char('Serial Number', size=64, required=True, help="Unique Serial Number, will be displayed as: PREFIX/SERIAL [INT_REF]"),
1537         'ref': fields.char('Internal Reference', size=256, help="Internal reference number in case it differs from the manufacturer's serial number"),
1538         'prefix': fields.char('Prefix', size=64, help="Optional prefix to prepend when displaying this serial number: PREFIX/SERIAL [INT_REF]"),
1539         'product_id': fields.many2one('product.product', 'Product', required=True, domain=[('type', '<>', 'service')]),
1540         'date': fields.datetime('Creation Date', required=True),
1541         'stock_available': fields.function(_get_stock, fnct_search=_stock_search, type="float", string="Available", select=True,
1542             help="Current quantity of products with this Serial Number available in company warehouses",
1543             digits_compute=dp.get_precision('Product Unit of Measure')),
1544         'revisions': fields.one2many('stock.production.lot.revision', 'lot_id', 'Revisions'),
1545         'company_id': fields.many2one('res.company', 'Company', select=True),
1546         'move_ids': fields.one2many('stock.move', 'prodlot_id', 'Moves for this serial number', readonly=True),
1547     }
1548     _defaults = {
1549         'date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
1550         'name': lambda x, y, z, c: x.pool.get('ir.sequence').get(y, z, 'stock.lot.serial'),
1551         'product_id': lambda x, y, z, c: c.get('product_id', False),
1552     }
1553     _sql_constraints = [
1554         ('name_ref_uniq', 'unique (name, ref)', 'The combination of serial number and internal reference must be unique !'),
1555     ]
1556     def action_traceability(self, cr, uid, ids, context=None):
1557         """ It traces the information of a product
1558         @param self: The object pointer.
1559         @param cr: A database cursor
1560         @param uid: ID of the user currently logged in
1561         @param ids: List of IDs selected
1562         @param context: A standard dictionary
1563         @return: A dictionary of values
1564         """
1565         value=self.pool.get('action.traceability').action_traceability(cr,uid,ids,context)
1566         return value
1567 stock_production_lot()
1568
1569 class stock_production_lot_revision(osv.osv):
1570     _name = 'stock.production.lot.revision'
1571     _description = 'Serial Number Revision'
1572
1573     _columns = {
1574         'name': fields.char('Revision Name', size=64, required=True),
1575         'description': fields.text('Description'),
1576         'date': fields.date('Revision Date'),
1577         'indice': fields.char('Revision Number', size=16),
1578         'author_id': fields.many2one('res.users', 'Author'),
1579         'lot_id': fields.many2one('stock.production.lot', 'Serial Number', select=True, ondelete='cascade'),
1580         'company_id': fields.related('lot_id','company_id',type='many2one',relation='res.company',string='Company', store=True, readonly=True),
1581     }
1582
1583     _defaults = {
1584         'author_id': lambda x, y, z, c: z,
1585         'date': fields.date.context_today,
1586     }
1587
1588 stock_production_lot_revision()
1589
1590 # ----------------------------------------------------
1591 # Move
1592 # ----------------------------------------------------
1593
1594 #
1595 # Fields:
1596 #   location_dest_id is only used for predicting futur stocks
1597 #
1598 class stock_move(osv.osv):
1599
1600     def _getSSCC(self, cr, uid, context=None):
1601         cr.execute('select id from stock_tracking where create_uid=%s order by id desc limit 1', (uid,))
1602         res = cr.fetchone()
1603         return (res and res[0]) or False
1604
1605     _name = "stock.move"
1606     _description = "Stock Move"
1607     _order = 'date_expected desc, id'
1608     _log_create = False
1609
1610     def action_partial_move(self, cr, uid, ids, context=None):
1611         if context is None: context = {}
1612         if context.get('active_model') != self._name:
1613             context.update(active_ids=ids, active_model=self._name)
1614         partial_id = self.pool.get("stock.partial.move").create(
1615             cr, uid, {}, context=context)
1616         return {
1617             'name':_("Products to Process"),
1618             'view_mode': 'form',
1619             'view_id': False,
1620             'view_type': 'form',
1621             'res_model': 'stock.partial.move',
1622             'res_id': partial_id,
1623             'type': 'ir.actions.act_window',
1624             'nodestroy': True,
1625             'target': 'new',
1626             'domain': '[]',
1627             'context': context
1628         }
1629
1630
1631     def name_get(self, cr, uid, ids, context=None):
1632         res = []
1633         for line in self.browse(cr, uid, ids, context=context):
1634             name = line.location_id.name+' > '+line.location_dest_id.name
1635             # optional prefixes
1636             if line.product_id.code:
1637                 name = line.product_id.code + ': ' + name
1638             if line.picking_id.origin:
1639                 name = line.picking_id.origin + '/ ' + name
1640             res.append((line.id, name))
1641         return res
1642
1643     def _check_tracking(self, cr, uid, ids, context=None):
1644         """ Checks if serial number is assigned to stock move or not.
1645         @return: True or False
1646         """
1647         for move in self.browse(cr, uid, ids, context=context):
1648             if not move.prodlot_id and \
1649                (move.state == 'done' and \
1650                ( \
1651                    (move.product_id.track_production and move.location_id.usage == 'production') or \
1652                    (move.product_id.track_production and move.location_dest_id.usage == 'production') or \
1653                    (move.product_id.track_incoming and move.location_id.usage == 'supplier') or \
1654                    (move.product_id.track_outgoing and move.location_dest_id.usage == 'customer') or \
1655                    (move.product_id.track_incoming and move.location_id.usage == 'inventory') \
1656                )):
1657                 return False
1658         return True
1659
1660     def _check_product_lot(self, cr, uid, ids, context=None):
1661         """ Checks whether move is done or not and production lot is assigned to that move.
1662         @return: True or False
1663         """
1664         for move in self.browse(cr, uid, ids, context=context):
1665             if move.prodlot_id and move.state == 'done' and (move.prodlot_id.product_id.id != move.product_id.id):
1666                 return False
1667         return True
1668
1669     _columns = {
1670         'name': fields.char('Name', size=250, required=True, select=True),
1671         'priority': fields.selection([('0', 'Not urgent'), ('1', 'Urgent')], 'Priority'),
1672         'create_date': fields.datetime('Creation Date', readonly=True, select=True),
1673         'date': fields.datetime('Date', required=True, select=True, help="Move date: scheduled date until move is done, then date of actual move processing", states={'done': [('readonly', True)]}),
1674         'date_expected': fields.datetime('Scheduled Date', states={'done': [('readonly', True)]},required=True, select=True, help="Scheduled date for the processing of this move"),
1675         'product_id': fields.many2one('product.product', 'Product', required=True, select=True, domain=[('type','<>','service')],states={'done': [('readonly', True)]}),
1676
1677         'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure'),
1678             required=True,states={'done': [('readonly', True)]},
1679             help="This is the quantity of products from an inventory "
1680                 "point of view. For moves in the state 'done', this is the "
1681                 "quantity of products that were actually moved. For other "
1682                 "moves, this is the quantity of product that is planned to "
1683                 "be moved. Lowering this quantity does not generate a "
1684                 "backorder. Changing this quantity on assigned moves affects "
1685                 "the product reservation, and should be done with care."
1686         ),
1687         'product_uom': fields.many2one('product.uom', 'Unit of Measure', required=True,states={'done': [('readonly', True)]}),
1688         'product_uos_qty': fields.float('Quantity (UOS)', digits_compute=dp.get_precision('Product Unit of Measure'), states={'done': [('readonly', True)]}),
1689         'product_uos': fields.many2one('product.uom', 'Product UOS', states={'done': [('readonly', True)]}),
1690         'product_packaging': fields.many2one('product.packaging', 'Packaging', help="It specifies attributes of packaging like type, quantity of packaging,etc."),
1691
1692         'location_id': fields.many2one('stock.location', 'Source Location', required=True, select=True,states={'done': [('readonly', True)]}, help="Sets a location if you produce at a fixed location. This can be a partner location if you subcontract the manufacturing operations."),
1693         'location_dest_id': fields.many2one('stock.location', 'Destination Location', required=True,states={'done': [('readonly', True)]}, select=True, help="Location where the system will stock the finished products."),
1694         'partner_id': fields.many2one('res.partner', 'Destination Address ', states={'done': [('readonly', True)]}, help="Optional address where goods are to be delivered, specifically used for allotment"),
1695
1696         'prodlot_id': fields.many2one('stock.production.lot', 'Serial Number', states={'done': [('readonly', True)]}, help="Serial number is used to put a serial number on the production", select=True),
1697         'tracking_id': fields.many2one('stock.tracking', 'Pack', select=True, states={'done': [('readonly', True)]}, help="Logistical shipping unit: pallet, box, pack ..."),
1698
1699         'auto_validate': fields.boolean('Auto Validate'),
1700
1701         'move_dest_id': fields.many2one('stock.move', 'Destination Move', help="Optional: next stock move when chaining them", select=True),
1702         'move_history_ids': fields.many2many('stock.move', 'stock_move_history_ids', 'parent_id', 'child_id', 'Move History (child moves)'),
1703         'move_history_ids2': fields.many2many('stock.move', 'stock_move_history_ids', 'child_id', 'parent_id', 'Move History (parent moves)'),
1704         'picking_id': fields.many2one('stock.picking', 'Reference', select=True,states={'done': [('readonly', True)]}),
1705         'note': fields.text('Notes'),
1706         'state': fields.selection([('draft', 'New'),
1707                                    ('cancel', 'Cancelled'),
1708                                    ('waiting', 'Waiting Another Move'),
1709                                    ('confirmed', 'Waiting Availability'),
1710                                    ('assigned', 'Available'),
1711                                    ('done', 'Done'),
1712                                    ], 'Status', readonly=True, select=True,
1713                  help= "* New: When the stock move is created and not yet confirmed.\n"\
1714                        "* Waiting Another Move: This state can be seen when a move is waiting for another one, for example in a chained flow.\n"\
1715                        "* Waiting Availability: This state is reached when the procurement resolution is not straight forward. It may need the scheduler to run, a component to me manufactured...\n"\
1716                        "* Available: When products are reserved, it is set to \'Available\'.\n"\
1717                        "* Done: When the shipment is processed, the state is \'Done\'."),
1718         'price_unit': fields.float('Unit Price', digits_compute= dp.get_precision('Account'), help="Technical field used to record the product cost set by the user during a picking confirmation (when average price costing method is used)"),
1719         'price_currency_id': fields.many2one('res.currency', 'Currency for average price', help="Technical field used to record the currency chosen by the user during a picking confirmation (when average price costing method is used)"),
1720         'company_id': fields.many2one('res.company', 'Company', required=True, select=True),
1721         'backorder_id': fields.related('picking_id','backorder_id',type='many2one', relation="stock.picking", string="Back Order of", select=True),
1722         'origin': fields.related('picking_id','origin',type='char', size=64, relation="stock.picking", string="Source", store=True),
1723
1724         # used for colors in tree views:
1725         'scrapped': fields.related('location_dest_id','scrap_location',type='boolean',relation='stock.location',string='Scrapped', readonly=True),
1726         'type': fields.related('picking_id', 'type', type='selection', selection=[('out', 'Sending Goods'), ('in', 'Getting Goods'), ('internal', 'Internal')], string='Shipping Type'),
1727     }
1728
1729     def _check_location(self, cr, uid, ids, context=None):
1730         for record in self.browse(cr, uid, ids, context=context):
1731             if (record.state=='done') and (record.location_id.usage == 'view'):
1732                 raise osv.except_osv(_('Error'), _('You cannot move product %s from a location of type view %s.')% (record.product_id.name, record.location_id.name))
1733             if (record.state=='done') and (record.location_dest_id.usage == 'view' ):
1734                 raise osv.except_osv(_('Error'), _('You cannot move product %s to a location of type view %s.')% (record.product_id.name, record.location_dest_id.name))
1735         return True
1736
1737     _constraints = [
1738         (_check_tracking,
1739             'You must assign a serial number for this product.',
1740             ['prodlot_id']),
1741         (_check_location, 'You cannot move products from or to a location of the type view.',
1742             ['location_id','location_dest_id']),
1743         (_check_product_lot,
1744             'You try to assign a lot which is not from the same product.',
1745             ['prodlot_id'])]
1746
1747     def _default_location_destination(self, cr, uid, context=None):
1748         """ Gets default address of partner for destination location
1749         @return: Address id or False
1750         """
1751         mod_obj = self.pool.get('ir.model.data')
1752         picking_type = context.get('picking_type')
1753         location_id = False
1754         if context is None:
1755             context = {}
1756         if context.get('move_line', []):
1757             if context['move_line'][0]:
1758                 if isinstance(context['move_line'][0], (tuple, list)):
1759                     location_id = context['move_line'][0][2] and context['move_line'][0][2].get('location_dest_id',False)
1760                 else:
1761                     move_list = self.pool.get('stock.move').read(cr, uid, context['move_line'][0], ['location_dest_id'])
1762                     location_id = move_list and move_list['location_dest_id'][0] or False
1763         elif context.get('address_out_id', False):
1764             property_out = self.pool.get('res.partner').browse(cr, uid, context['address_out_id'], context).property_stock_customer
1765             location_id = property_out and property_out.id or False
1766         else:
1767             location_xml_id = False
1768             if picking_type == 'in':
1769                 location_xml_id = 'stock_location_stock'
1770             elif picking_type == 'out':
1771                 location_xml_id = 'stock_location_customers'
1772             if location_xml_id:
1773                 location_model, location_id = mod_obj.get_object_reference(cr, uid, 'stock', location_xml_id)
1774         return location_id
1775
1776     def _default_location_source(self, cr, uid, context=None):
1777         """ Gets default address of partner for source location
1778         @return: Address id or False
1779         """
1780         mod_obj = self.pool.get('ir.model.data')
1781         picking_type = context.get('picking_type')
1782         location_id = False
1783
1784         if context is None:
1785             context = {}
1786         if context.get('move_line', []):
1787             try:
1788                 location_id = context['move_line'][0][2]['location_id']
1789             except:
1790                 pass
1791         elif context.get('address_in_id', False):
1792             part_obj_add = self.pool.get('res.partner').browse(cr, uid, context['address_in_id'], context=context)
1793             if part_obj_add:
1794                 location_id = part_obj_add.property_stock_supplier.id
1795         else:
1796             location_xml_id = False
1797             if picking_type == 'in':
1798                 location_xml_id = 'stock_location_suppliers'
1799             elif picking_type == 'out':
1800                 location_xml_id = 'stock_location_stock'
1801             if location_xml_id:
1802                 location_model, location_id = mod_obj.get_object_reference(cr, uid, 'stock', location_xml_id)
1803         return location_id
1804
1805     def _default_destination_address(self, cr, uid, context=None):
1806         user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
1807         return user.company_id.partner_id.id
1808
1809     def _default_move_type(self, cr, uid, context=None):
1810         """ Gets default type of move
1811         @return: type
1812         """
1813         if context is None:
1814             context = {}
1815         picking_type = context.get('picking_type')
1816         type = 'internal'
1817         if picking_type == 'in':
1818             type = 'in'
1819         elif picking_type == 'out':
1820             type = 'out'
1821         return type
1822
1823     _defaults = {
1824         'location_id': _default_location_source,
1825         'location_dest_id': _default_location_destination,
1826         'partner_id': _default_destination_address,
1827         'type': _default_move_type,
1828         'state': 'draft',
1829         'priority': '1',
1830         'product_qty': 1.0,
1831         'scrapped' :  False,
1832         'date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
1833         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.move', context=c),
1834         'date_expected': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
1835     }
1836
1837     def write(self, cr, uid, ids, vals, context=None):
1838         if isinstance(ids, (int, long)):
1839             ids = [ids]
1840         if uid != 1:
1841             frozen_fields = set(['product_qty', 'product_uom', 'product_uos_qty', 'product_uos', 'location_id', 'location_dest_id', 'product_id'])
1842             for move in self.browse(cr, uid, ids, context=context):
1843                 if move.state == 'done':
1844                     if frozen_fields.intersection(vals):
1845                         raise osv.except_osv(_('Operation forbidden !'),
1846                                              _('Quantities, Unit of Measures, Products and Locations cannot be modified on stock moves that have already been processed (except by the Administrator).'))
1847         return  super(stock_move, self).write(cr, uid, ids, vals, context=context)
1848
1849     def copy(self, cr, uid, id, default=None, context=None):
1850         if default is None:
1851             default = {}
1852         default = default.copy()
1853         default.update({'move_history_ids2': [], 'move_history_ids': []})
1854         return super(stock_move, self).copy(cr, uid, id, default, context=context)
1855
1856     def _auto_init(self, cursor, context=None):
1857         res = super(stock_move, self)._auto_init(cursor, context=context)
1858         cursor.execute('SELECT indexname \
1859                 FROM pg_indexes \
1860                 WHERE indexname = \'stock_move_location_id_location_dest_id_product_id_state\'')
1861         if not cursor.fetchone():
1862             cursor.execute('CREATE INDEX stock_move_location_id_location_dest_id_product_id_state \
1863                     ON stock_move (product_id, state, location_id, location_dest_id)')
1864         return res
1865
1866     def onchange_lot_id(self, cr, uid, ids, prodlot_id=False, product_qty=False,
1867                         loc_id=False, product_id=False, uom_id=False, context=None):
1868         """ On change of production lot gives a warning message.
1869         @param prodlot_id: Changed production lot id
1870         @param product_qty: Quantity of product
1871         @param loc_id: Location id
1872         @param product_id: Product id
1873         @return: Warning message
1874         """
1875         if not prodlot_id or not loc_id:
1876             return {}
1877         ctx = context and context.copy() or {}
1878         ctx['location_id'] = loc_id
1879         ctx.update({'raise-exception': True})
1880         uom_obj = self.pool.get('product.uom')
1881         product_obj = self.pool.get('product.product')
1882         product_uom = product_obj.browse(cr, uid, product_id, context=ctx).uom_id
1883         prodlot = self.pool.get('stock.production.lot').browse(cr, uid, prodlot_id, context=ctx)
1884         location = self.pool.get('stock.location').browse(cr, uid, loc_id, context=ctx)
1885         uom = uom_obj.browse(cr, uid, uom_id, context=ctx)
1886         amount_actual = uom_obj._compute_qty_obj(cr, uid, product_uom, prodlot.stock_available, uom, context=ctx)
1887         warning = {}
1888         if (location.usage == 'internal') and (product_qty > (amount_actual or 0.0)):
1889             warning = {
1890                 'title': _('Insufficient Stock for Serial Number !'),
1891                 'message': _('You are moving %.2f %s but only %.2f %s available for this serial number.') % (product_qty, uom.name, amount_actual, uom.name)
1892             }
1893         return {'warning': warning}
1894
1895     def onchange_quantity(self, cr, uid, ids, product_id, product_qty,
1896                           product_uom, product_uos):
1897         """ On change of product quantity finds UoM and UoS quantities
1898         @param product_id: Product id
1899         @param product_qty: Changed Quantity of product
1900         @param product_uom: Unit of measure of product
1901         @param product_uos: Unit of sale of product
1902         @return: Dictionary of values
1903         """
1904         result = {
1905                   'product_uos_qty': 0.00
1906           }
1907         warning = {}
1908
1909         if (not product_id) or (product_qty <=0.0):
1910             result['product_qty'] = 0.0
1911             return {'value': result}
1912
1913         product_obj = self.pool.get('product.product')
1914         uos_coeff = product_obj.read(cr, uid, product_id, ['uos_coeff'])
1915
1916         # Warn if the quantity was decreased
1917         if ids:
1918             for move in self.read(cr, uid, ids, ['product_qty']):
1919                 if product_qty < move['product_qty']:
1920                     warning.update({
1921                        'title': _('Information'),
1922                        'message': _("By changing this quantity here, you accept the "
1923                                 "new quantity as complete: OpenERP will not "
1924                                 "automatically generate a back order.") })
1925                 break
1926
1927         if product_uos and product_uom and (product_uom != product_uos):
1928             result['product_uos_qty'] = product_qty * uos_coeff['uos_coeff']
1929         else:
1930             result['product_uos_qty'] = product_qty
1931
1932         return {'value': result, 'warning': warning}
1933
1934     def onchange_uos_quantity(self, cr, uid, ids, product_id, product_uos_qty,
1935                           product_uos, product_uom):
1936         """ On change of product quantity finds UoM and UoS quantities
1937         @param product_id: Product id
1938         @param product_uos_qty: Changed UoS Quantity of product
1939         @param product_uom: Unit of measure of product
1940         @param product_uos: Unit of sale of product
1941         @return: Dictionary of values
1942         """
1943         result = {
1944                   'product_qty': 0.00
1945           }
1946         warning = {}
1947
1948         if (not product_id) or (product_uos_qty <=0.0):
1949             result['product_uos_qty'] = 0.0
1950             return {'value': result}
1951
1952         product_obj = self.pool.get('product.product')
1953         uos_coeff = product_obj.read(cr, uid, product_id, ['uos_coeff'])
1954
1955         # Warn if the quantity was decreased
1956         for move in self.read(cr, uid, ids, ['product_uos_qty']):
1957             if product_uos_qty < move['product_uos_qty']:
1958                 warning.update({
1959                    'title': _('Warning: No Back Order'),
1960                    'message': _("By changing the quantity here, you accept the "
1961                                 "new quantity as complete: OpenERP will not "
1962                                 "automatically generate a Back Order.") })
1963                 break
1964
1965         if product_uos and product_uom and (product_uom != product_uos):
1966             result['product_qty'] = product_uos_qty / uos_coeff['uos_coeff']
1967         else:
1968             result['product_qty'] = product_uos_qty
1969         return {'value': result, 'warning': warning}
1970
1971     def onchange_product_id(self, cr, uid, ids, prod_id=False, loc_id=False,
1972                             loc_dest_id=False, partner_id=False):
1973         """ On change of product id, if finds UoM, UoS, quantity and UoS quantity.
1974         @param prod_id: Changed Product id
1975         @param loc_id: Source location id
1976         @param loc_dest_id: Destination location id
1977         @param partner_id: Address id of partner
1978         @return: Dictionary of values
1979         """
1980         if not prod_id:
1981             return {}
1982         lang = False
1983         if partner_id:
1984             addr_rec = self.pool.get('res.partner').browse(cr, uid, partner_id)
1985             if addr_rec:
1986                 lang = addr_rec and addr_rec.lang or False
1987         ctx = {'lang': lang}
1988
1989         product = self.pool.get('product.product').browse(cr, uid, [prod_id], context=ctx)[0]
1990         uos_id  = product.uos_id and product.uos_id.id or False
1991         result = {
1992             'product_uom': product.uom_id.id,
1993             'product_uos': uos_id,
1994             'product_qty': 1.00,
1995             'product_uos_qty' : self.pool.get('stock.move').onchange_quantity(cr, uid, ids, prod_id, 1.00, product.uom_id.id, uos_id)['value']['product_uos_qty'],
1996             'prodlot_id' : False,
1997         }
1998         if not ids:
1999             result['name'] = product.partner_ref
2000         if loc_id:
2001             result['location_id'] = loc_id
2002         if loc_dest_id:
2003             result['location_dest_id'] = loc_dest_id
2004         return {'value': result}
2005
2006     def onchange_move_type(self, cr, uid, ids, type, context=None):
2007         """ On change of move type gives sorce and destination location.
2008         @param type: Move Type
2009         @return: Dictionary of values
2010         """
2011         mod_obj = self.pool.get('ir.model.data')
2012         location_source_id = False
2013         location_dest_id = False
2014         if type == 'in':
2015             location_source_id = 'stock_location_suppliers'
2016             location_dest_id = 'stock_location_stock'
2017         elif type == 'out':
2018             location_source_id = 'stock_location_stock'
2019             location_dest_id = 'stock_location_customers'
2020         if location_source_id:
2021             try:
2022                 location_model, location_source_id = mod_obj.get_object_reference(cr, uid, 'stock', location_source_id)
2023             except ValueError, e:
2024                 location_source_id = False
2025         if location_dest_id:
2026             try:
2027                 location_model, location_dest_id = mod_obj.get_object_reference(cr, uid, 'stock', location_dest_id)
2028             except ValueError, e:
2029                 location_dest_id = False
2030         return {'value':{'location_id': location_source_id, 'location_dest_id': location_dest_id}}
2031
2032     def onchange_date(self, cr, uid, ids, date, date_expected, context=None):
2033         """ On change of Scheduled Date gives a Move date.
2034         @param date_expected: Scheduled Date
2035         @param date: Move Date
2036         @return: Move Date
2037         """
2038         if not date_expected:
2039             date_expected = time.strftime('%Y-%m-%d %H:%M:%S')
2040         return {'value':{'date': date_expected}}
2041
2042     def _chain_compute(self, cr, uid, moves, context=None):
2043         """ Finds whether the location has chained location type or not.
2044         @param moves: Stock moves
2045         @return: Dictionary containing destination location with chained location type.
2046         """
2047         result = {}
2048         for m in moves:
2049             dest = self.pool.get('stock.location').chained_location_get(
2050                 cr,
2051                 uid,
2052                 m.location_dest_id,
2053                 m.picking_id and m.picking_id.partner_id and m.picking_id.partner_id,
2054                 m.product_id,
2055                 context
2056             )
2057             if dest:
2058                 if dest[1] == 'transparent':
2059                     newdate = (datetime.strptime(m.date, '%Y-%m-%d %H:%M:%S') + relativedelta(days=dest[2] or 0)).strftime('%Y-%m-%d')
2060                     self.write(cr, uid, [m.id], {
2061                         'date': newdate,
2062                         'location_dest_id': dest[0].id})
2063                     if m.picking_id and (dest[3] or dest[5]):
2064                         self.pool.get('stock.picking').write(cr, uid, [m.picking_id.id], {
2065                             'stock_journal_id': dest[3] or m.picking_id.stock_journal_id.id,
2066                             'type': dest[5] or m.picking_id.type
2067                         }, context=context)
2068                     m.location_dest_id = dest[0]
2069                     res2 = self._chain_compute(cr, uid, [m], context=context)
2070                     for pick_id in res2.keys():
2071                         result.setdefault(pick_id, [])
2072                         result[pick_id] += res2[pick_id]
2073                 else:
2074                     result.setdefault(m.picking_id, [])
2075                     result[m.picking_id].append( (m, dest) )
2076         return result
2077
2078     def _prepare_chained_picking(self, cr, uid, picking_name, picking, picking_type, moves_todo, context=None):
2079         """Prepare the definition (values) to create a new chained picking.
2080
2081            :param str picking_name: desired new picking name
2082            :param browse_record picking: source picking (being chained to)
2083            :param str picking_type: desired new picking type
2084            :param list moves_todo: specification of the stock moves to be later included in this
2085                picking, in the form::
2086
2087                    [[move, (dest_location, auto_packing, chained_delay, chained_journal,
2088                                   chained_company_id, chained_picking_type)],
2089                     ...
2090                    ]
2091
2092                See also :meth:`stock_location.chained_location_get`.
2093         """
2094         res_company = self.pool.get('res.company')
2095         return {
2096                     'name': picking_name,
2097                     'origin': tools.ustr(picking.origin or ''),
2098                     'type': picking_type,
2099                     'note': picking.note,
2100                     'move_type': picking.move_type,
2101                     'auto_picking': moves_todo[0][1][1] == 'auto',
2102                     'stock_journal_id': moves_todo[0][1][3],
2103                     'company_id': moves_todo[0][1][4] or res_company._company_default_get(cr, uid, 'stock.company', context=context),
2104                     'partner_id': picking.partner_id.id,
2105                     'invoice_state': 'none',
2106                     'date': picking.date,
2107                 }
2108
2109     def _create_chained_picking(self, cr, uid, picking_name, picking, picking_type, moves_todo, context=None):
2110         picking_obj = self.pool.get('stock.picking')
2111         return picking_obj.create(cr, uid, self._prepare_chained_picking(cr, uid, picking_name, picking, picking_type, moves_todo, context=context))
2112
2113     def create_chained_picking(self, cr, uid, moves, context=None):
2114         res_obj = self.pool.get('res.company')
2115         location_obj = self.pool.get('stock.location')
2116         move_obj = self.pool.get('stock.move')
2117         wf_service = netsvc.LocalService("workflow")
2118         new_moves = []
2119         if context is None:
2120             context = {}
2121         seq_obj = self.pool.get('ir.sequence')
2122         for picking, todo in self._chain_compute(cr, uid, moves, context=context).items():
2123             ptype = todo[0][1][5] and todo[0][1][5] or location_obj.picking_type_get(cr, uid, todo[0][0].location_dest_id, todo[0][1][0])
2124             if picking:
2125                 # name of new picking according to its type
2126                 new_pick_name = seq_obj.get(cr, uid, 'stock.picking.' + ptype)
2127                 pickid = self._create_chained_picking(cr, uid, new_pick_name, picking, ptype, todo, context=context)
2128                 # Need to check name of old picking because it always considers picking as "OUT" when created from Sale Order
2129                 old_ptype = location_obj.picking_type_get(cr, uid, picking.move_lines[0].location_id, picking.move_lines[0].location_dest_id)
2130                 if old_ptype != picking.type:
2131                     old_pick_name = seq_obj.get(cr, uid, 'stock.picking.' + old_ptype)
2132                     self.pool.get('stock.picking').write(cr, uid, [picking.id], {'name': old_pick_name}, context=context)
2133             else:
2134                 pickid = False
2135             for move, (loc, dummy, delay, dummy, company_id, ptype) in todo:
2136                 new_id = move_obj.copy(cr, uid, move.id, {
2137                     'location_id': move.location_dest_id.id,
2138                     'location_dest_id': loc.id,
2139                     'date_moved': time.strftime('%Y-%m-%d'),
2140                     'picking_id': pickid,
2141                     'state': 'waiting',
2142                     'company_id': company_id or res_obj._company_default_get(cr, uid, 'stock.company', context=context)  ,
2143                     'move_history_ids': [],
2144                     'date': (datetime.strptime(move.date, '%Y-%m-%d %H:%M:%S') + relativedelta(days=delay or 0)).strftime('%Y-%m-%d'),
2145                     'move_history_ids2': []}
2146                 )
2147                 move_obj.write(cr, uid, [move.id], {
2148                     'move_dest_id': new_id,
2149                     'move_history_ids': [(4, new_id)]
2150                 })
2151                 new_moves.append(self.browse(cr, uid, [new_id])[0])
2152             if pickid:
2153                 wf_service.trg_validate(uid, 'stock.picking', pickid, 'button_confirm', cr)
2154         if new_moves:
2155             new_moves += self.create_chained_picking(cr, uid, new_moves, context)
2156         return new_moves
2157
2158     def action_confirm(self, cr, uid, ids, context=None):
2159         """ Confirms stock move.
2160         @return: List of ids.
2161         """
2162         moves = self.browse(cr, uid, ids, context=context)
2163         self.write(cr, uid, ids, {'state': 'confirmed'})
2164         self.create_chained_picking(cr, uid, moves, context)
2165         return []
2166
2167     def action_assign(self, cr, uid, ids, *args):
2168         """ Changes state to confirmed or waiting.
2169         @return: List of values
2170         """
2171         todo = []
2172         for move in self.browse(cr, uid, ids):
2173             if move.state in ('confirmed', 'waiting'):
2174                 todo.append(move.id)
2175         res = self.check_assign(cr, uid, todo)
2176         return res
2177
2178     def force_assign(self, cr, uid, ids, context=None):
2179         """ Changes the state to assigned.
2180         @return: True
2181         """
2182         self.write(cr, uid, ids, {'state': 'assigned'})
2183         wf_service = netsvc.LocalService('workflow')
2184         for move in self.browse(cr, uid, ids, context):
2185             if move.picking_id:
2186                 wf_service.trg_write(uid, 'stock.picking', move.picking_id.id, cr)
2187         return True
2188
2189     def cancel_assign(self, cr, uid, ids, context=None):
2190         """ Changes the state to confirmed.
2191         @return: True
2192         """
2193         self.write(cr, uid, ids, {'state': 'confirmed'})
2194
2195         # fix for bug lp:707031
2196         # called write of related picking because changing move availability does
2197         # not trigger workflow of picking in order to change the state of picking
2198         wf_service = netsvc.LocalService('workflow')
2199         for move in self.browse(cr, uid, ids, context):
2200             if move.picking_id:
2201                 wf_service.trg_write(uid, 'stock.picking', move.picking_id.id, cr)
2202         return True
2203
2204     #
2205     # Duplicate stock.move
2206     #
2207     def check_assign(self, cr, uid, ids, context=None):
2208         """ Checks the product type and accordingly writes the state.
2209         @return: No. of moves done
2210         """
2211         done = []
2212         count = 0
2213         pickings = {}
2214         if context is None:
2215             context = {}
2216         for move in self.browse(cr, uid, ids, context=context):
2217             if move.product_id.type == 'consu' or move.location_id.usage == 'supplier':
2218                 if move.state in ('confirmed', 'waiting'):
2219                     done.append(move.id)
2220                 pickings[move.picking_id.id] = 1
2221                 continue
2222             if move.state in ('confirmed', 'waiting'):
2223                 # Important: we must pass lock=True to _product_reserve() to avoid race conditions and double reservations
2224                 res = self.pool.get('stock.location')._product_reserve(cr, uid, [move.location_id.id], move.product_id.id, move.product_qty, {'uom': move.product_uom.id}, lock=True)
2225                 if res:
2226                     #_product_available_test depends on the next status for correct functioning
2227                     #the test does not work correctly if the same product occurs multiple times
2228                     #in the same order. This is e.g. the case when using the button 'split in two' of
2229                     #the stock outgoing form
2230                     self.write(cr, uid, [move.id], {'state':'assigned'})
2231                     done.append(move.id)
2232                     pickings[move.picking_id.id] = 1
2233                     r = res.pop(0)
2234                     product_uos_qty = self.pool.get('stock.move').onchange_quantity(cr, uid, ids, move.product_id.id, r[0], move.product_id.uom_id.id, move.product_id.uos_id.id)['value']['product_uos_qty']
2235                     cr.execute('update stock_move set location_id=%s, product_qty=%s, product_uos_qty=%s where id=%s', (r[1], r[0],product_uos_qty, move.id))
2236
2237                     while res:
2238                         r = res.pop(0)
2239                         move_id = self.copy(cr, uid, move.id, {'product_uos_qty': product_uos_qty, 'product_qty': r[0], 'location_id': r[1]})
2240                         done.append(move_id)
2241         if done:
2242             count += len(done)
2243             self.write(cr, uid, done, {'state': 'assigned'})
2244
2245         if count:
2246             for pick_id in pickings:
2247                 wf_service = netsvc.LocalService("workflow")
2248                 wf_service.trg_write(uid, 'stock.picking', pick_id, cr)
2249         return count
2250
2251     def setlast_tracking(self, cr, uid, ids, context=None):
2252         tracking_obj = self.pool.get('stock.tracking')
2253         picking = self.browse(cr, uid, ids, context=context)[0].picking_id
2254         if picking:
2255             last_track = [line.tracking_id.id for line in picking.move_lines if line.tracking_id]
2256             if not last_track:
2257                 last_track = tracking_obj.create(cr, uid, {}, context=context)
2258             else:
2259                 last_track.sort()
2260                 last_track = last_track[-1]
2261             self.write(cr, uid, ids, {'tracking_id': last_track})
2262         return True
2263
2264     #
2265     # Cancel move => cancel others move and pickings
2266     #
2267     def action_cancel(self, cr, uid, ids, context=None):
2268         """ Cancels the moves and if all moves are cancelled it cancels the picking.
2269         @return: True
2270         """
2271         if not len(ids):
2272             return True
2273         if context is None:
2274             context = {}
2275         pickings = set()
2276         for move in self.browse(cr, uid, ids, context=context):
2277             if move.state in ('confirmed', 'waiting', 'assigned', 'draft'):
2278                 if move.picking_id:
2279                     pickings.add(move.picking_id.id)
2280             if move.move_dest_id and move.move_dest_id.state == 'waiting':
2281                 self.write(cr, uid, [move.move_dest_id.id], {'state': 'assigned'})
2282                 if context.get('call_unlink',False) and move.move_dest_id.picking_id:
2283                     wf_service = netsvc.LocalService("workflow")
2284                     wf_service.trg_write(uid, 'stock.picking', move.move_dest_id.picking_id.id, cr)
2285         self.write(cr, uid, ids, {'state': 'cancel', 'move_dest_id': False})
2286         if not context.get('call_unlink',False):
2287             for pick in self.pool.get('stock.picking').browse(cr, uid, list(pickings), context=context):
2288                 if all(move.state == 'cancel' for move in pick.move_lines):
2289                     self.pool.get('stock.picking').write(cr, uid, [pick.id], {'state': 'cancel'})
2290
2291         wf_service = netsvc.LocalService("workflow")
2292         for id in ids:
2293             wf_service.trg_trigger(uid, 'stock.move', id, cr)
2294         return True
2295
2296     def _get_accounting_data_for_valuation(self, cr, uid, move, context=None):
2297         """
2298         Return the accounts and journal to use to post Journal Entries for the real-time
2299         valuation of the move.
2300
2301         :param context: context dictionary that can explicitly mention the company to consider via the 'force_company' key
2302         :raise: osv.except_osv() is any mandatory account or journal is not defined.
2303         """
2304         product_obj=self.pool.get('product.product')
2305         accounts = product_obj.get_product_accounts(cr, uid, move.product_id.id, context)
2306         if move.location_id.valuation_out_account_id:
2307             acc_src = move.location_id.valuation_out_account_id.id
2308         else:
2309             acc_src = accounts['stock_account_input']
2310
2311         if move.location_dest_id.valuation_in_account_id:
2312             acc_dest = move.location_dest_id.valuation_in_account_id.id
2313         else:
2314             acc_dest = accounts['stock_account_output']
2315
2316         acc_valuation = accounts.get('property_stock_valuation_account_id', False)
2317         journal_id = accounts['stock_journal']
2318
2319         if acc_dest == acc_valuation:
2320             raise osv.except_osv(_('Error!'),  _('Cannot create Journal Entry, Output Account of this product and Valuation account on category of this product are same.'))
2321
2322         if acc_src == acc_valuation:
2323             raise osv.except_osv(_('Error!'),  _('Cannot create Journal Entry, Input Account of this product and Valuation account on category of this product are same.'))
2324
2325         if not acc_src:
2326             raise osv.except_osv(_('Error!'),  _('Please define stock input account for this product or its category: "%s" (id: %d)') % \
2327                                     (move.product_id.name, move.product_id.id,))
2328         if not acc_dest:
2329             raise osv.except_osv(_('Error!'),  _('Please define stock output account for this product or its category: "%s" (id: %d)') % \
2330                                     (move.product_id.name, move.product_id.id,))
2331         if not journal_id:
2332             raise osv.except_osv(_('Error!'), _('Please define journal on the product category: "%s" (id: %d)') % \
2333                                     (move.product_id.categ_id.name, move.product_id.categ_id.id,))
2334         if not acc_valuation:
2335             raise osv.except_osv(_('Error!'), _('Please define inventory valuation account on the product category: "%s" (id: %d)') % \
2336                                     (move.product_id.categ_id.name, move.product_id.categ_id.id,))
2337         return journal_id, acc_src, acc_dest, acc_valuation
2338
2339     def _get_reference_accounting_values_for_valuation(self, cr, uid, move, context=None):
2340         """
2341         Return the reference amount and reference currency representing the inventory valuation for this move.
2342         These reference values should possibly be converted before being posted in Journals to adapt to the primary
2343         and secondary currencies of the relevant accounts.
2344         """
2345         product_uom_obj = self.pool.get('product.uom')
2346
2347         # by default the reference currency is that of the move's company
2348         reference_currency_id = move.company_id.currency_id.id
2349
2350         default_uom = move.product_id.uom_id.id
2351         qty = product_uom_obj._compute_qty(cr, uid, move.product_uom.id, move.product_qty, default_uom)
2352
2353         # if product is set to average price and a specific value was entered in the picking wizard,
2354         # we use it
2355         if move.product_id.cost_method == 'average' and move.price_unit:
2356             reference_amount = qty * move.price_unit
2357             reference_currency_id = move.price_currency_id.id or reference_currency_id
2358
2359         # Otherwise we default to the company's valuation price type, considering that the values of the
2360         # valuation field are expressed in the default currency of the move's company.
2361         else:
2362             if context is None:
2363                 context = {}
2364             currency_ctx = dict(context, currency_id = move.company_id.currency_id.id)
2365             amount_unit = move.product_id.price_get('standard_price', context=currency_ctx)[move.product_id.id]
2366             reference_amount = amount_unit * qty
2367
2368         return reference_amount, reference_currency_id
2369
2370
2371     def _create_product_valuation_moves(self, cr, uid, move, context=None):
2372         """
2373         Generate the appropriate accounting moves if the product being moves is subject
2374         to real_time valuation tracking, and the source or destination location is
2375         a transit location or is outside of the company.
2376         """
2377         if move.product_id.valuation == 'real_time': # FIXME: product valuation should perhaps be a property?
2378             if context is None:
2379                 context = {}
2380             src_company_ctx = dict(context,force_company=move.location_id.company_id.id)
2381             dest_company_ctx = dict(context,force_company=move.location_dest_id.company_id.id)
2382             account_moves = []
2383             # Outgoing moves (or cross-company output part)
2384             if move.location_id.company_id \
2385                 and (move.location_id.usage == 'internal' and move.location_dest_id.usage != 'internal'\
2386                      or move.location_id.company_id != move.location_dest_id.company_id):
2387                 journal_id, acc_src, acc_dest, acc_valuation = self._get_accounting_data_for_valuation(cr, uid, move, src_company_ctx)
2388                 reference_amount, reference_currency_id = self._get_reference_accounting_values_for_valuation(cr, uid, move, src_company_ctx)
2389                 #returning goods to supplier
2390                 if move.location_dest_id.usage == 'supplier':
2391                     account_moves += [(journal_id, self._create_account_move_line(cr, uid, move, acc_valuation, acc_src, reference_amount, reference_currency_id, context))]
2392                 else:
2393                     account_moves += [(journal_id, self._create_account_move_line(cr, uid, move, acc_valuation, acc_dest, reference_amount, reference_currency_id, context))]
2394
2395             # Incoming moves (or cross-company input part)
2396             if move.location_dest_id.company_id \
2397                 and (move.location_id.usage != 'internal' and move.location_dest_id.usage == 'internal'\
2398                      or move.location_id.company_id != move.location_dest_id.company_id):
2399                 journal_id, acc_src, acc_dest, acc_valuation = self._get_accounting_data_for_valuation(cr, uid, move, dest_company_ctx)
2400                 reference_amount, reference_currency_id = self._get_reference_accounting_values_for_valuation(cr, uid, move, src_company_ctx)
2401                 #goods return from customer
2402                 if move.location_id.usage == 'customer':
2403                     account_moves += [(journal_id, self._create_account_move_line(cr, uid, move, acc_dest, acc_valuation, reference_amount, reference_currency_id, context))]
2404                 else:
2405                     account_moves += [(journal_id, self._create_account_move_line(cr, uid, move, acc_src, acc_valuation, reference_amount, reference_currency_id, context))]
2406
2407             move_obj = self.pool.get('account.move')
2408             for j_id, move_lines in account_moves:
2409                 move_obj.create(cr, uid,
2410                         {
2411                          'journal_id': j_id,
2412                          'line_id': move_lines,
2413                          'ref': move.picking_id and move.picking_id.name})
2414
2415
2416     def action_done(self, cr, uid, ids, context=None):
2417         """ Makes the move done and if all moves are done, it will finish the picking.
2418         @return:
2419         """
2420         picking_ids = []
2421         move_ids = []
2422         wf_service = netsvc.LocalService("workflow")
2423         if context is None:
2424             context = {}
2425
2426         todo = []
2427         for move in self.browse(cr, uid, ids, context=context):
2428             if move.state=="draft":
2429                 todo.append(move.id)
2430         if todo:
2431             self.action_confirm(cr, uid, todo, context=context)
2432             todo = []
2433
2434         for move in self.browse(cr, uid, ids, context=context):
2435             if move.state in ['done','cancel']:
2436                 continue
2437             move_ids.append(move.id)
2438
2439             if move.picking_id:
2440                 picking_ids.append(move.picking_id.id)
2441             if move.move_dest_id.id and (move.state != 'done'):
2442                 self.write(cr, uid, [move.id], {'move_history_ids': [(4, move.move_dest_id.id)]})
2443                 #cr.execute('insert into stock_move_history_ids (parent_id,child_id) values (%s,%s)', (move.id, move.move_dest_id.id))
2444                 if move.move_dest_id.state in ('waiting', 'confirmed'):
2445                     self.force_assign(cr, uid, [move.move_dest_id.id], context=context)
2446                     if move.move_dest_id.picking_id:
2447                         wf_service.trg_write(uid, 'stock.picking', move.move_dest_id.picking_id.id, cr)
2448                     if move.move_dest_id.auto_validate:
2449                         self.action_done(cr, uid, [move.move_dest_id.id], context=context)
2450
2451             self._create_product_valuation_moves(cr, uid, move, context=context)
2452             if move.state not in ('confirmed','done','assigned'):
2453                 todo.append(move.id)
2454
2455         if todo:
2456             self.action_confirm(cr, uid, todo, context=context)
2457
2458         self.write(cr, uid, move_ids, {'state': 'done', 'date': time.strftime('%Y-%m-%d %H:%M:%S')}, context=context)
2459         for id in move_ids:
2460              wf_service.trg_trigger(uid, 'stock.move', id, cr)
2461
2462         for pick_id in picking_ids:
2463             wf_service.trg_write(uid, 'stock.picking', pick_id, cr)
2464
2465         return True
2466
2467     def _create_account_move_line(self, cr, uid, move, src_account_id, dest_account_id, reference_amount, reference_currency_id, context=None):
2468         """
2469         Generate the account.move.line values to post to track the stock valuation difference due to the
2470         processing of the given stock move.
2471         """
2472         # prepare default values considering that the destination accounts have the reference_currency_id as their main currency
2473         partner_id = (move.picking_id.partner_id and move.picking_id.partner_id.id and move.picking_id.partner_id.id) or False
2474         debit_line_vals = {
2475                     'name': move.name,
2476                     'product_id': move.product_id and move.product_id.id or False,
2477                     'quantity': move.product_qty,
2478                     'ref': move.picking_id and move.picking_id.name or False,
2479                     'date': time.strftime('%Y-%m-%d'),
2480                     'partner_id': partner_id,
2481                     'debit': reference_amount,
2482                     'account_id': dest_account_id,
2483         }
2484         credit_line_vals = {
2485                     'name': move.name,
2486                     'product_id': move.product_id and move.product_id.id or False,
2487                     'quantity': move.product_qty,
2488                     'ref': move.picking_id and move.picking_id.name or False,
2489                     'date': time.strftime('%Y-%m-%d'),
2490                     'partner_id': partner_id,
2491                     'credit': reference_amount,
2492                     'account_id': src_account_id,
2493         }
2494
2495         # if we are posting to accounts in a different currency, provide correct values in both currencies correctly
2496         # when compatible with the optional secondary currency on the account.
2497         # Financial Accounts only accept amounts in secondary currencies if there's no secondary currency on the account
2498         # or if it's the same as that of the secondary amount being posted.
2499         account_obj = self.pool.get('account.account')
2500         src_acct, dest_acct = account_obj.browse(cr, uid, [src_account_id, dest_account_id], context=context)
2501         src_main_currency_id = src_acct.company_id.currency_id.id
2502         dest_main_currency_id = dest_acct.company_id.currency_id.id
2503         cur_obj = self.pool.get('res.currency')
2504         if reference_currency_id != src_main_currency_id:
2505             # fix credit line:
2506             credit_line_vals['credit'] = cur_obj.compute(cr, uid, reference_currency_id, src_main_currency_id, reference_amount, context=context)
2507             if (not src_acct.currency_id) or src_acct.currency_id.id == reference_currency_id:
2508                 credit_line_vals.update(currency_id=reference_currency_id, amount_currency=reference_amount)
2509         if reference_currency_id != dest_main_currency_id:
2510             # fix debit line:
2511             debit_line_vals['debit'] = cur_obj.compute(cr, uid, reference_currency_id, dest_main_currency_id, reference_amount, context=context)
2512             if (not dest_acct.currency_id) or dest_acct.currency_id.id == reference_currency_id:
2513                 debit_line_vals.update(currency_id=reference_currency_id, amount_currency=reference_amount)
2514
2515         return [(0, 0, debit_line_vals), (0, 0, credit_line_vals)]
2516
2517     def unlink(self, cr, uid, ids, context=None):
2518         if context is None:
2519             context = {}
2520         ctx = context.copy()
2521         for move in self.browse(cr, uid, ids, context=context):
2522             if move.state != 'draft' and not ctx.get('call_unlink',False):
2523                 raise osv.except_osv(_('User Error!'),
2524                         _('You can only delete draft moves.'))
2525         return super(stock_move, self).unlink(
2526             cr, uid, ids, context=ctx)
2527
2528     # _create_lot function is not used anywhere
2529     def _create_lot(self, cr, uid, ids, product_id, prefix=False):
2530         """ Creates production lot
2531         @return: Production lot id
2532         """
2533         prodlot_obj = self.pool.get('stock.production.lot')
2534         prodlot_id = prodlot_obj.create(cr, uid, {'prefix': prefix, 'product_id': product_id})
2535         return prodlot_id
2536
2537     def action_scrap(self, cr, uid, ids, quantity, location_id, context=None):
2538         """ Move the scrap/damaged product into scrap location
2539         @param cr: the database cursor
2540         @param uid: the user id
2541         @param ids: ids of stock move object to be scrapped
2542         @param quantity : specify scrap qty
2543         @param location_id : specify scrap location
2544         @param context: context arguments
2545         @return: Scraped lines
2546         """
2547         #quantity should in MOVE UOM
2548         if quantity <= 0:
2549             raise osv.except_osv(_('Warning!'), _('Please provide a positive quantity to scrap.'))
2550         res = []
2551         for move in self.browse(cr, uid, ids, context=context):
2552             move_qty = move.product_qty
2553             uos_qty = quantity / move_qty * move.product_uos_qty
2554             default_val = {
2555                 'product_qty': quantity,
2556                 'product_uos_qty': uos_qty,
2557                 'state': move.state,
2558                 'scrapped' : True,
2559                 'location_dest_id': location_id,
2560                 'tracking_id': move.tracking_id.id,
2561                 'prodlot_id': move.prodlot_id.id,
2562             }
2563             new_move = self.copy(cr, uid, move.id, default_val)
2564
2565             res += [new_move]
2566             product_obj = self.pool.get('product.product')
2567             for product in product_obj.browse(cr, uid, [move.product_id.id], context=context):
2568                 if move.picking_id:
2569                     uom = product.uom_id.name if product.uom_id else ''
2570                     move.picking_id.scrap_send_note(quantity, uom, product.name, context=context)
2571
2572         self.action_done(cr, uid, res, context=context)
2573         return res
2574
2575     # action_split function is not used anywhere
2576     # FIXME: deprecate this method
2577     def action_split(self, cr, uid, ids, quantity, split_by_qty=1, prefix=False, with_lot=True, context=None):
2578         """ Split Stock Move lines into production lot which specified split by quantity.
2579         @param cr: the database cursor
2580         @param uid: the user id
2581         @param ids: ids of stock move object to be splited
2582         @param split_by_qty : specify split by qty
2583         @param prefix : specify prefix of production lot
2584         @param with_lot : if true, prodcution lot will assign for split line otherwise not.
2585         @param context: context arguments
2586         @return: Splited move lines
2587         """
2588
2589         if context is None:
2590             context = {}
2591         if quantity <= 0:
2592             raise osv.except_osv(_('Warning!'), _('Please provide proper quantity.'))
2593
2594         res = []
2595
2596         for move in self.browse(cr, uid, ids, context=context):
2597             if split_by_qty <= 0 or quantity == 0:
2598                 return res
2599
2600             uos_qty = split_by_qty / move.product_qty * move.product_uos_qty
2601
2602             quantity_rest = quantity % split_by_qty
2603             uos_qty_rest = split_by_qty / move.product_qty * move.product_uos_qty
2604
2605             update_val = {
2606                 'product_qty': split_by_qty,
2607                 'product_uos_qty': uos_qty,
2608             }
2609             for idx in range(int(quantity//split_by_qty)):
2610                 if not idx and move.product_qty<=quantity:
2611                     current_move = move.id
2612                 else:
2613                     current_move = self.copy(cr, uid, move.id, {'state': move.state})
2614                 res.append(current_move)
2615                 if with_lot:
2616                     update_val['prodlot_id'] = self._create_lot(cr, uid, [current_move], move.product_id.id)
2617
2618                 self.write(cr, uid, [current_move], update_val)
2619
2620
2621             if quantity_rest > 0:
2622                 idx = int(quantity//split_by_qty)
2623                 update_val['product_qty'] = quantity_rest
2624                 update_val['product_uos_qty'] = uos_qty_rest
2625                 if not idx and move.product_qty<=quantity:
2626                     current_move = move.id
2627                 else:
2628                     current_move = self.copy(cr, uid, move.id, {'state': move.state})
2629
2630                 res.append(current_move)
2631
2632
2633                 if with_lot:
2634                     update_val['prodlot_id'] = self._create_lot(cr, uid, [current_move], move.product_id.id)
2635
2636                 self.write(cr, uid, [current_move], update_val)
2637         return res
2638
2639     def action_consume(self, cr, uid, ids, quantity, location_id=False, context=None):
2640         """ Consumed product with specific quatity from specific source location
2641         @param cr: the database cursor
2642         @param uid: the user id
2643         @param ids: ids of stock move object to be consumed
2644         @param quantity : specify consume quantity
2645         @param location_id : specify source location
2646         @param context: context arguments
2647         @return: Consumed lines
2648         """
2649         #quantity should in MOVE UOM
2650         if context is None:
2651             context = {}
2652         if quantity <= 0:
2653             raise osv.except_osv(_('Warning!'), _('Please provide proper quantity.'))
2654         res = []
2655         for move in self.browse(cr, uid, ids, context=context):
2656             move_qty = move.product_qty
2657             if move_qty <= 0:
2658                 raise osv.except_osv(_('Error!'), _('Cannot consume a move with negative or zero quantity.'))
2659             quantity_rest = move.product_qty
2660             quantity_rest -= quantity
2661             uos_qty_rest = quantity_rest / move_qty * move.product_uos_qty
2662             if quantity_rest <= 0:
2663                 quantity_rest = 0
2664                 uos_qty_rest = 0
2665                 quantity = move.product_qty
2666
2667             uos_qty = quantity / move_qty * move.product_uos_qty
2668             if quantity_rest > 0:
2669                 default_val = {
2670                     'product_qty': quantity,
2671                     'product_uos_qty': uos_qty,
2672                     'state': move.state,
2673                     'location_id': location_id or move.location_id.id,
2674                 }
2675                 current_move = self.copy(cr, uid, move.id, default_val)
2676                 res += [current_move]
2677                 update_val = {}
2678                 update_val['product_qty'] = quantity_rest
2679                 update_val['product_uos_qty'] = uos_qty_rest
2680                 self.write(cr, uid, [move.id], update_val)
2681
2682             else:
2683                 quantity_rest = quantity
2684                 uos_qty_rest =  uos_qty
2685                 res += [move.id]
2686                 update_val = {
2687                         'product_qty' : quantity_rest,
2688                         'product_uos_qty' : uos_qty_rest,
2689                         'location_id': location_id or move.location_id.id,
2690                 }
2691                 self.write(cr, uid, [move.id], update_val)
2692
2693         self.action_done(cr, uid, res, context=context)
2694
2695         return res
2696
2697     # FIXME: needs refactoring, this code is partially duplicated in stock_picking.do_partial()!
2698     def do_partial(self, cr, uid, ids, partial_datas, context=None):
2699         """ Makes partial pickings and moves done.
2700         @param partial_datas: Dictionary containing details of partial picking
2701                           like partner_id, delivery_date, delivery
2702                           moves with product_id, product_qty, uom
2703         """
2704         res = {}
2705         picking_obj = self.pool.get('stock.picking')
2706         product_obj = self.pool.get('product.product')
2707         currency_obj = self.pool.get('res.currency')
2708         uom_obj = self.pool.get('product.uom')
2709         wf_service = netsvc.LocalService("workflow")
2710
2711         if context is None:
2712             context = {}
2713
2714         complete, too_many, too_few = [], [], []
2715         move_product_qty = {}
2716         prodlot_ids = {}
2717         for move in self.browse(cr, uid, ids, context=context):
2718             if move.state in ('done', 'cancel'):
2719                 continue
2720             partial_data = partial_datas.get('move%s'%(move.id), False)
2721             assert partial_data, _('Missing partial picking data for move #%s.') % (move.id)
2722             product_qty = partial_data.get('product_qty',0.0)
2723             move_product_qty[move.id] = product_qty
2724             product_uom = partial_data.get('product_uom',False)
2725             product_price = partial_data.get('product_price',0.0)
2726             product_currency = partial_data.get('product_currency',False)
2727             prodlot_ids[move.id] = partial_data.get('prodlot_id')
2728             if move.product_qty == product_qty:
2729                 complete.append(move)
2730             elif move.product_qty > product_qty:
2731                 too_few.append(move)
2732             else:
2733                 too_many.append(move)
2734
2735             # Average price computation
2736             if (move.picking_id.type == 'in') and (move.product_id.cost_method == 'average'):
2737                 product = product_obj.browse(cr, uid, move.product_id.id)
2738                 move_currency_id = move.company_id.currency_id.id
2739                 context['currency_id'] = move_currency_id
2740                 qty = uom_obj._compute_qty(cr, uid, product_uom, product_qty, product.uom_id.id)
2741                 if qty > 0:
2742                     new_price = currency_obj.compute(cr, uid, product_currency,
2743                             move_currency_id, product_price)
2744                     new_price = uom_obj._compute_price(cr, uid, product_uom, new_price,
2745                             product.uom_id.id)
2746                     if product.qty_available <= 0:
2747                         new_std_price = new_price
2748                     else:
2749                         # Get the standard price
2750                         amount_unit = product.price_get('standard_price', context=context)[product.id]
2751                         new_std_price = ((amount_unit * product.qty_available)\
2752                             + (new_price * qty))/(product.qty_available + qty)
2753
2754                     product_obj.write(cr, uid, [product.id],{'standard_price': new_std_price})
2755
2756                     # Record the values that were chosen in the wizard, so they can be
2757                     # used for inventory valuation if real-time valuation is enabled.
2758                     self.write(cr, uid, [move.id],
2759                                 {'price_unit': product_price,
2760                                  'price_currency_id': product_currency,
2761                                 })
2762
2763         for move in too_few:
2764             product_qty = move_product_qty[move.id]
2765             if product_qty != 0:
2766                 defaults = {
2767                             'product_qty' : product_qty,
2768                             'product_uos_qty': product_qty,
2769                             'picking_id' : move.picking_id.id,
2770                             'state': 'assigned',
2771                             'move_dest_id': False,
2772                             'price_unit': move.price_unit,
2773                             }
2774                 prodlot_id = prodlot_ids[move.id]
2775                 if prodlot_id:
2776                     defaults.update(prodlot_id=prodlot_id)
2777                 new_move = self.copy(cr, uid, move.id, defaults)
2778                 complete.append(self.browse(cr, uid, new_move))
2779             self.write(cr, uid, [move.id],
2780                     {
2781                         'product_qty': move.product_qty - product_qty,
2782                         'product_uos_qty': move.product_qty - product_qty,
2783                         'prodlot_id': False,
2784                         'tracking_id': False,
2785                     })
2786
2787
2788         for move in too_many:
2789             self.write(cr, uid, [move.id],
2790                     {
2791                         'product_qty': move.product_qty,
2792                         'product_uos_qty': move.product_qty,
2793                     })
2794             complete.append(move)
2795
2796         for move in complete:
2797             if prodlot_ids.get(move.id):
2798                 self.write(cr, uid, [move.id],{'prodlot_id': prodlot_ids.get(move.id)})
2799             self.action_done(cr, uid, [move.id], context=context)
2800             if  move.picking_id.id :
2801                 # TOCHECK : Done picking if all moves are done
2802                 cr.execute("""
2803                     SELECT move.id FROM stock_picking pick
2804                     RIGHT JOIN stock_move move ON move.picking_id = pick.id AND move.state = %s
2805                     WHERE pick.id = %s""",
2806                             ('done', move.picking_id.id))
2807                 res = cr.fetchall()
2808                 if len(res) == len(move.picking_id.move_lines):
2809                     picking_obj.action_move(cr, uid, [move.picking_id.id])
2810                     wf_service.trg_validate(uid, 'stock.picking', move.picking_id.id, 'button_done', cr)
2811
2812         return [move.id for move in complete]
2813
2814 stock_move()
2815
2816 class stock_inventory(osv.osv):
2817     _name = "stock.inventory"
2818     _description = "Inventory"
2819     _columns = {
2820         'name': fields.char('Inventory Reference', size=64, required=True, readonly=True, states={'draft': [('readonly', False)]}),
2821         'date': fields.datetime('Creation Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
2822         'date_done': fields.datetime('Date done'),
2823         'inventory_line_id': fields.one2many('stock.inventory.line', 'inventory_id', 'Inventories', readonly=True, states={'draft': [('readonly', False)]}),
2824         'move_ids': fields.many2many('stock.move', 'stock_inventory_move_rel', 'inventory_id', 'move_id', 'Created Moves'),
2825         'state': fields.selection( (('draft', 'Draft'), ('cancel','Cancelled'), ('confirm','Confirmed'), ('done', 'Done')), 'Status', readonly=True, select=True),
2826         'company_id': fields.many2one('res.company', 'Company', required=True, select=True, readonly=True, states={'draft':[('readonly',False)]}),
2827
2828     }
2829     _defaults = {
2830         'date': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
2831         'state': 'draft',
2832         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.inventory', context=c)
2833     }
2834
2835     def copy(self, cr, uid, id, default=None, context=None):
2836         if default is None:
2837             default = {}
2838         default = default.copy()
2839         default.update({'move_ids': [], 'date_done': False})
2840         return super(stock_inventory, self).copy(cr, uid, id, default, context=context)
2841
2842     def _inventory_line_hook(self, cr, uid, inventory_line, move_vals):
2843         """ Creates a stock move from an inventory line
2844         @param inventory_line:
2845         @param move_vals:
2846         @return:
2847         """
2848         return self.pool.get('stock.move').create(cr, uid, move_vals)
2849
2850     def action_done(self, cr, uid, ids, context=None):
2851         """ Finish the inventory
2852         @return: True
2853         """
2854         if context is None:
2855             context = {}
2856         move_obj = self.pool.get('stock.move')
2857         for inv in self.browse(cr, uid, ids, context=context):
2858             move_obj.action_done(cr, uid, [x.id for x in inv.move_ids], context=context)
2859             self.write(cr, uid, [inv.id], {'state':'done', 'date_done': time.strftime('%Y-%m-%d %H:%M:%S')}, context=context)
2860         return True
2861
2862     def action_confirm(self, cr, uid, ids, context=None):
2863         """ Confirm the inventory and writes its finished date
2864         @return: True
2865         """
2866         if context is None:
2867             context = {}
2868         # to perform the correct inventory corrections we need analyze stock location by
2869         # location, never recursively, so we use a special context
2870         product_context = dict(context, compute_child=False)
2871
2872         location_obj = self.pool.get('stock.location')
2873         for inv in self.browse(cr, uid, ids, context=context):
2874             move_ids = []
2875             for line in inv.inventory_line_id:
2876                 pid = line.product_id.id
2877                 product_context.update(uom=line.product_uom.id, date=inv.date, prodlot_id=line.prod_lot_id.id)
2878                 amount = location_obj._product_get(cr, uid, line.location_id.id, [pid], product_context)[pid]
2879                 change = line.product_qty - amount
2880                 lot_id = line.prod_lot_id.id
2881                 if change:
2882                     location_id = line.product_id.product_tmpl_id.property_stock_inventory.id
2883                     value = {
2884                         'name': 'INV:' + str(line.inventory_id.id) + ':' + line.inventory_id.name,
2885                         'product_id': line.product_id.id,
2886                         'product_uom': line.product_uom.id,
2887                         'prodlot_id': lot_id,
2888                         'date': inv.date,
2889                     }
2890
2891                     if change > 0:
2892                         value.update( {
2893                             'product_qty': change,
2894                             'location_id': location_id,
2895                             'location_dest_id': line.location_id.id,
2896                         })
2897                     else:
2898                         value.update( {
2899                             'product_qty': -change,
2900                             'location_id': line.location_id.id,
2901                             'location_dest_id': location_id,
2902                         })
2903                     move_ids.append(self._inventory_line_hook(cr, uid, line, value))
2904             self.write(cr, uid, [inv.id], {'state': 'confirm', 'move_ids': [(6, 0, move_ids)]})
2905             self.pool.get('stock.move').action_confirm(cr, uid, move_ids, context=context)
2906         return True
2907
2908     def action_cancel_draft(self, cr, uid, ids, context=None):
2909         """ Cancels the stock move and change inventory state to draft.
2910         @return: True
2911         """
2912         for inv in self.browse(cr, uid, ids, context=context):
2913             self.pool.get('stock.move').action_cancel(cr, uid, [x.id for x in inv.move_ids], context=context)
2914             self.write(cr, uid, [inv.id], {'state':'draft'}, context=context)
2915         return True
2916
2917     def action_cancel_inventory(self, cr, uid, ids, context=None):
2918         """ Cancels both stock move and inventory
2919         @return: True
2920         """
2921         move_obj = self.pool.get('stock.move')
2922         account_move_obj = self.pool.get('account.move')
2923         for inv in self.browse(cr, uid, ids, context=context):
2924             move_obj.action_cancel(cr, uid, [x.id for x in inv.move_ids], context=context)
2925             for move in inv.move_ids:
2926                  account_move_ids = account_move_obj.search(cr, uid, [('name', '=', move.name)])
2927                  if account_move_ids:
2928                      account_move_data_l = account_move_obj.read(cr, uid, account_move_ids, ['state'], context=context)
2929                      for account_move in account_move_data_l:
2930                          if account_move['state'] == 'posted':
2931                              raise osv.except_osv(_('User Error!'),
2932                                                   _('In order to cancel this inventory, you must first unpost related journal entries.'))
2933                          account_move_obj.unlink(cr, uid, [account_move['id']], context=context)
2934             self.write(cr, uid, [inv.id], {'state': 'cancel'}, context=context)
2935         return True
2936
2937 stock_inventory()
2938
2939 class stock_inventory_line(osv.osv):
2940     _name = "stock.inventory.line"
2941     _description = "Inventory Line"
2942     _rec_name = "inventory_id"
2943     _columns = {
2944         'inventory_id': fields.many2one('stock.inventory', 'Inventory', ondelete='cascade', select=True),
2945         'location_id': fields.many2one('stock.location', 'Location', required=True),
2946         'product_id': fields.many2one('product.product', 'Product', required=True, select=True),
2947         'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True),
2948         'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure')),
2949         'company_id': fields.related('inventory_id','company_id',type='many2one',relation='res.company',string='Company',store=True, select=True, readonly=True),
2950         'prod_lot_id': fields.many2one('stock.production.lot', 'Serial Number', domain="[('product_id','=',product_id)]"),
2951         'state': fields.related('inventory_id','state',type='char',string='Status',readonly=True),
2952     }
2953
2954     def _default_stock_location(self, cr, uid, context=None):
2955         stock_location = self.pool.get('ir.model.data').get_object(cr, uid, 'stock', 'stock_location_stock')
2956         return stock_location.id
2957
2958     _defaults = {
2959         'location_id': _default_stock_location
2960     }
2961
2962     def on_change_product_id(self, cr, uid, ids, location_id, product, uom=False, to_date=False):
2963         """ Changes UoM and name if product_id changes.
2964         @param location_id: Location id
2965         @param product: Changed product_id
2966         @param uom: UoM product
2967         @return:  Dictionary of changed values
2968         """
2969         if not product:
2970             return {'value': {'product_qty': 0.0, 'product_uom': False, 'prod_lot_id': False}}
2971         obj_product = self.pool.get('product.product').browse(cr, uid, product)
2972         uom = uom or obj_product.uom_id.id
2973         amount = self.pool.get('stock.location')._product_get(cr, uid, location_id, [product], {'uom': uom, 'to_date': to_date, 'compute_child': False})[product]
2974         result = {'product_qty': amount, 'product_uom': uom, 'prod_lot_id': False}
2975         return {'value': result}
2976
2977 stock_inventory_line()
2978
2979 #----------------------------------------------------------
2980 # Stock Warehouse
2981 #----------------------------------------------------------
2982 class stock_warehouse(osv.osv):
2983     _name = "stock.warehouse"
2984     _description = "Warehouse"
2985     _columns = {
2986         'name': fields.char('Name', size=128, required=True, select=True),
2987         'company_id': fields.many2one('res.company', 'Company', required=True, select=True),
2988         'partner_id': fields.many2one('res.partner', 'Owner Address'),
2989         'lot_input_id': fields.many2one('stock.location', 'Location Input', required=True, domain=[('usage','<>','view')]),
2990         'lot_stock_id': fields.many2one('stock.location', 'Location Stock', required=True, domain=[('usage','=','internal')]),
2991         'lot_output_id': fields.many2one('stock.location', 'Location Output', required=True, domain=[('usage','<>','view')]),
2992     }
2993
2994     def _default_lot_input_stock_id(self, cr, uid, context=None):
2995         lot_input_stock = self.pool.get('ir.model.data').get_object(cr, uid, 'stock', 'stock_location_stock')
2996         return lot_input_stock.id
2997
2998     def _default_lot_output_id(self, cr, uid, context=None):
2999         lot_output = self.pool.get('ir.model.data').get_object(cr, uid, 'stock', 'stock_location_output')
3000         return lot_output.id
3001
3002     _defaults = {
3003         'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.inventory', context=c),
3004         'lot_input_id': _default_lot_input_stock_id,
3005         'lot_stock_id': _default_lot_input_stock_id,
3006         'lot_output_id': _default_lot_output_id,
3007     }
3008
3009 stock_warehouse()
3010
3011 #----------------------------------------------------------
3012 # "Empty" Classes that are used to vary from the original stock.picking  (that are dedicated to the internal pickings)
3013 #   in order to offer a different usability with different views, labels, available reports/wizards...
3014 #----------------------------------------------------------
3015 class stock_picking_in(osv.osv):
3016     _name = "stock.picking.in"
3017     _inherit = "stock.picking"
3018     _table = "stock_picking"
3019     _description = "Incoming Shipments"
3020
3021     def check_access_rights(self, cr, uid, operation, raise_exception=True):
3022         #override in order to redirect the check of acces rights on the stock.picking object
3023         return self.pool.get('stock.picking').check_access_rights(cr, uid, operation, raise_exception=raise_exception)
3024
3025     def check_access_rule(self, cr, uid, ids, operation, context=None):
3026         #override in order to redirect the check of acces rules on the stock.picking object
3027         return self.pool.get('stock.picking').check_access_rule(cr, uid, ids, operation, context=context)
3028
3029     def _workflow_trigger(self, cr, uid, ids, trigger, context=None):
3030         #override in order to trigger the workflow of stock.picking at the end of create, write and unlink operation
3031         #instead of it's own workflow (which is not existing)
3032         return self.pool.get('stock.picking')._workflow_trigger(cr, uid, ids, trigger, context=context)
3033
3034     def _workflow_signal(self, cr, uid, ids, signal, context=None):
3035         #override in order to fire the workflow signal on given stock.picking workflow instance
3036         #instead of it's own workflow (which is not existing)
3037         return self.pool.get('stock.picking')._workflow_signal(cr, uid, ids, signal, context=context)
3038
3039     _columns = {
3040         'backorder_id': fields.many2one('stock.picking.in', 'Back Order of', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="If this shipment was split, then this field links to the shipment which contains the already processed part.", select=True),
3041         'state': fields.selection(
3042             [('draft', 'Draft'),
3043             ('auto', 'Waiting Another Operation'),
3044             ('confirmed', 'Waiting Availability'),
3045             ('assigned', 'Ready to Receive'),
3046             ('done', 'Received'),
3047             ('cancel', 'Cancelled'),],
3048             'State', readonly=True, select=True,
3049             help="""* Draft: not confirmed yet and will not be scheduled until confirmed\n
3050                  * Waiting Another Operation: waiting for another move to proceed before it becomes automatically available (e.g. in Make-To-Order flows)\n
3051                  * Waiting Availability: still waiting for the availability of products\n
3052                  * Ready to Receive: products reserved, simply waiting for confirmation.\n
3053                  * Received: has been processed, can't be modified or cancelled anymore\n
3054                  * Cancelled: has been cancelled, can't be confirmed anymore"""),
3055     }
3056     _defaults = {
3057         'type': 'in',
3058     }
3059
3060 class stock_picking_out(osv.osv):
3061     _name = "stock.picking.out"
3062     _inherit = "stock.picking"
3063     _table = "stock_picking"
3064     _description = "Delivery Orders"
3065
3066     def check_access_rights(self, cr, uid, operation, raise_exception=True):
3067         #override in order to redirect the check of acces rights on the stock.picking object
3068         return self.pool.get('stock.picking').check_access_rights(cr, uid, operation, raise_exception=raise_exception)
3069
3070     def check_access_rule(self, cr, uid, ids, operation, context=None):
3071         #override in order to redirect the check of acces rules on the stock.picking object
3072         return self.pool.get('stock.picking').check_access_rule(cr, uid, ids, operation, context=context)
3073
3074     def _workflow_trigger(self, cr, uid, ids, trigger, context=None):
3075         #override in order to trigger the workflow of stock.picking at the end of create, write and unlink operation
3076         #instead of it's own workflow (which is not existing)
3077         return self.pool.get('stock.picking')._workflow_trigger(cr, uid, ids, trigger, context=context)
3078
3079     def _workflow_signal(self, cr, uid, ids, signal, context=None):
3080         #override in order to fire the workflow signal on given stock.picking workflow instance
3081         #instead of it's own workflow (which is not existing)
3082         return self.pool.get('stock.picking')._workflow_signal(cr, uid, ids, signal, context=context)
3083
3084     _columns = {
3085         'backorder_id': fields.many2one('stock.picking.out', 'Back Order of', states={'done':[('readonly', True)], 'cancel':[('readonly',True)]}, help="If this shipment was split, then this field links to the shipment which contains the already processed part.", select=True),
3086         'state': fields.selection(
3087             [('draft', 'Draft'),
3088             ('auto', 'Waiting Another Operation'),
3089             ('confirmed', 'Waiting Availability'),
3090             ('assigned', 'Ready to Deliver'),
3091             ('done', 'Delivered'),
3092             ('cancel', 'Cancelled'),],
3093             'State', readonly=True, select=True,
3094             help="""* Draft: not confirmed yet and will not be scheduled until confirmed\n
3095                  * Waiting Another Operation: waiting for another move to proceed before it becomes automatically available (e.g. in Make-To-Order flows)\n
3096                  * Waiting Availability: still waiting for the availability of products\n
3097                  * Ready to Deliver: products reserved, simply waiting for confirmation.\n
3098                  * Delivered: has been processed, can't be modified or cancelled anymore\n
3099                  * Cancelled: has been cancelled, can't be confirmed anymore"""),
3100     }
3101     _defaults = {
3102         'type': 'out',
3103     }
3104
3105 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: