1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
22 from operator import attrgetter
25 from openerp.osv import fields, osv
26 from openerp.tools.translate import _
27 from openerp import netsvc
28 import openerp.addons.decimal_precision as dp
31 # ------------------------------------------------------------------
33 # Produce, Buy or Find products and place a move
34 # then wizard for picking lists & move
37 class mrp_property_group(osv.osv):
39 Group of mrp properties.
41 _name = 'mrp.property.group'
42 _description = 'Property Group'
44 'name': fields.char('Property Group', size=64, required=True),
45 'description': fields.text('Description'),
48 class mrp_property(osv.osv):
52 _name = 'mrp.property'
53 _description = 'Property'
55 'name': fields.char('Name', size=64, required=True),
56 'composition': fields.selection([('min','min'),('max','max'),('plus','plus')], 'Properties composition', required=True, help="Not used in computations, for information purpose only."),
57 'group_id': fields.many2one('mrp.property.group', 'Property Group', required=True),
58 'description': fields.text('Description'),
61 'composition': lambda *a: 'min',
64 class StockMove(osv.osv):
65 _inherit = 'stock.move'
67 'procurements': fields.one2many('procurement.order', 'move_id', 'Procurements'),
70 def copy_data(self, cr, uid, id, default=None, context=None):
73 default['procurements'] = []
74 return super(StockMove, self).copy_data(cr, uid, id, default, context=context)
77 class procurement_order(osv.osv):
81 _name = "procurement.order"
82 _description = "Procurement"
83 _order = 'priority desc,date_planned'
84 _inherit = ['mail.thread']
87 'name': fields.text('Description', required=True),
88 'origin': fields.char('Source Document', size=64,
89 help="Reference of the document that created this Procurement.\n"
90 "This is automatically completed by OpenERP."),
91 'priority': fields.selection([('0','Not urgent'),('1','Normal'),('2','Urgent'),('3','Very Urgent')], 'Priority', required=True, select=True),
92 'date_planned': fields.datetime('Scheduled date', required=True, select=True),
93 'date_close': fields.datetime('Date Closed'),
94 'product_id': fields.many2one('product.product', 'Product', required=True, states={'draft':[('readonly',False)]}, readonly=True),
95 'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure'), required=True, states={'draft':[('readonly',False)]}, readonly=True),
96 'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True, states={'draft':[('readonly',False)]}, readonly=True),
97 'product_uos_qty': fields.float('UoS Quantity', states={'draft':[('readonly',False)]}, readonly=True),
98 'product_uos': fields.many2one('product.uom', 'Product UoS', states={'draft':[('readonly',False)]}, readonly=True),
99 'move_id': fields.many2one('stock.move', 'Reservation', ondelete='set null'),
100 'close_move': fields.boolean('Close Move at end'),
101 'location_id': fields.many2one('stock.location', 'Location', required=True, states={'draft':[('readonly',False)]}, readonly=True),
102 'procure_method': fields.selection([('make_to_stock','Make to Stock'),('make_to_order','Make to Order')], 'Procurement Method', states={'draft':[('readonly',False)], 'confirmed':[('readonly',False)]},
103 readonly=True, required=True, help="If you encode manually a Procurement, you probably want to use" \
104 " a make to order method."),
105 'note': fields.text('Note'),
106 'message': fields.text('Latest error', help="Exception occurred while computing procurement orders."),
107 'state': fields.selection([
109 ('cancel','Cancelled'),
110 ('confirmed','Confirmed'),
111 ('exception','Exception'),
112 ('running','Running'),
115 ('waiting','Waiting')], 'Status', required=True, track_visibility='onchange',
116 help='When a procurement is created the status is set to \'Draft\'.\n If the procurement is confirmed, the status is set to \'Confirmed\'.\
117 \nAfter confirming the status is set to \'Running\'.\n If any exception arises in the order then the status is set to \'Exception\'.\n Once the exception is removed the status becomes \'Ready\'.\n It is in \'Waiting\'. status when the procurement is waiting for another one to finish.'),
118 'note': fields.text('Note'),
119 'company_id': fields.many2one('res.company','Company',required=True),
124 'date_planned': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
126 'procure_method': 'make_to_order',
127 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'procurement.order', context=c)
130 def message_track(self, cr, uid, ids, tracked_fields, initial_values, context=None):
131 """ Overwrite message_track to avoid tracking more than once the confirm-exception loop
132 Add '_first_pass_done_' to the note field only the first time stuck in exception state
133 Will avoid getting furthur confirmed and exception change of state messages
135 TODO: this hack is necessary for a stable version but should be avoided for the next release.
136 Instead find a more elegant way to prevent redundant messages or entirely stop tracking states on procurement orders
138 for proc in self.browse(cr, uid, ids, context=context):
139 if not proc.note or '_first_pass_done_' not in proc.note or proc.state not in ('confirmed', 'exception'):
140 super(procurement_order, self).message_track(cr, uid, [proc.id], tracked_fields, initial_values, context=context)
141 if proc.state == 'exception':
142 cr.execute("""UPDATE procurement_order set note = TRIM(both E'\n' FROM COALESCE(note, '') || %s) WHERE id = %s""", ('\n\n_first_pass_done_',proc.id))
146 def unlink(self, cr, uid, ids, context=None):
147 procurements = self.read(cr, uid, ids, ['state'], context=context)
149 for s in procurements:
150 if s['state'] in ['draft','cancel']:
151 unlink_ids.append(s['id'])
153 raise osv.except_osv(_('Invalid Action!'),
154 _('Cannot delete Procurement Order(s) which are in %s state.') % \
156 return osv.osv.unlink(self, cr, uid, unlink_ids, context=context)
158 def onchange_product_id(self, cr, uid, ids, product_id, context=None):
159 """ Finds UoM and UoS of changed product.
160 @param product_id: Changed id of product.
161 @return: Dictionary of values.
164 w = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
166 'product_uom': w.uom_id.id,
167 'product_uos': w.uos_id and w.uos_id.id or w.uom_id.id
172 def is_product(self, cr, uid, ids, context=None):
173 """ Checks product type to decide which transition of the workflow to follow.
174 @return: True if all product ids received in argument are of type 'product' or 'consummable'. False if any is of type 'service'
176 return all(proc.product_id.type in ('product', 'consu') for proc in self.browse(cr, uid, ids, context=context))
178 def check_move_cancel(self, cr, uid, ids, context=None):
179 """ Checks if move is cancelled or not.
180 @return: True or False.
182 return all(procurement.move_id.state == 'cancel' for procurement in self.browse(cr, uid, ids, context=context))
184 def check_move_done(self, cr, uid, ids, context=None):
185 """ Checks if move is done or not.
186 @return: True or False.
188 return all(proc.product_id.type == 'service' or (proc.move_id and proc.move_id.state == 'done') \
189 for proc in self.browse(cr, uid, ids, context=context))
192 # This method may be overrided by objects that override procurement.order
193 # for computing their own purpose
195 def _quantity_compute_get(self, cr, uid, proc, context=None):
196 """ Finds sold quantity of product.
197 @param proc: Current procurement.
198 @return: Quantity or False.
200 if proc.product_id.type == 'product' and proc.move_id:
201 if proc.move_id.product_uos:
202 return proc.move_id.product_uos_qty
205 def _uom_compute_get(self, cr, uid, proc, context=None):
206 """ Finds UoS if product is Stockable Product.
207 @param proc: Current procurement.
208 @return: UoS or False.
210 if proc.product_id.type == 'product' and proc.move_id:
211 if proc.move_id.product_uos:
212 return proc.move_id.product_uos.id
216 # Return the quantity of product shipped/produced/served, which may be
217 # different from the planned quantity
219 def quantity_get(self, cr, uid, id, context=None):
220 """ Finds quantity of product used in procurement.
221 @return: Quantity of product.
223 proc = self.browse(cr, uid, id, context=context)
224 result = self._quantity_compute_get(cr, uid, proc, context=context)
226 result = proc.product_qty
229 def uom_get(self, cr, uid, id, context=None):
230 """ Finds UoM of product used in procurement.
231 @return: UoM of product.
233 proc = self.browse(cr, uid, id, context=context)
234 result = self._uom_compute_get(cr, uid, proc, context=context)
236 result = proc.product_uom.id
239 def check_waiting(self, cr, uid, ids, context=None):
240 """ Checks state of move.
241 @return: True or False
243 for procurement in self.browse(cr, uid, ids, context=context):
244 if procurement.move_id and procurement.move_id.state == 'auto':
248 def check_produce_service(self, cr, uid, procurement, context=None):
249 """ Depicts the capacity of the procurement workflow to deal with production of services.
250 By default, it's False. Overwritten by project_mrp module.
254 def check_produce_product(self, cr, uid, procurement, context=None):
255 """ Depicts the capacity of the procurement workflow to deal with production of products.
256 By default, it's False. Overwritten by mrp module.
260 def check_make_to_stock(self, cr, uid, ids, context=None):
261 """ Checks product type.
262 @return: True or False
265 for procurement in self.browse(cr, uid, ids, context=context):
266 if procurement.product_id.type == 'service':
267 ok = ok and self._check_make_to_stock_service(cr, uid, procurement, context)
269 ok = ok and self._check_make_to_stock_product(cr, uid, procurement, context)
272 def check_produce(self, cr, uid, ids, context=None):
273 """ Checks product type.
274 @return: True or False
276 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
277 for procurement in self.browse(cr, uid, ids, context=context):
278 product = procurement.product_id
279 #TOFIX: if product type is 'service' but supply_method is 'buy'.
280 if product.supply_method <> 'produce':
282 if product.type=='service':
283 res = self.check_produce_service(cr, uid, procurement, context)
285 res = self.check_produce_product(cr, uid, procurement, context)
290 def check_buy(self, cr, uid, ids):
291 """ Depicts the capacity of the procurement workflow to manage the supply_method == 'buy'.
292 By default, it's False. Overwritten by purchase module.
296 def check_move(self, cr, uid, ids, context=None):
297 """ Check whether the given procurement can be satisfied by an internal move,
298 typically a pulled flow. By default, it's False. Overwritten by the `stock_location` module.
302 def check_conditions_confirm2wait(self, cr, uid, ids):
303 """ condition on the transition to go from 'confirm' activity to 'confirm_wait' activity """
304 return not self.test_cancel(cr, uid, ids)
306 def test_cancel(self, cr, uid, ids):
307 """ Tests whether state of move is cancelled or not.
308 @return: True or False
310 for record in self.browse(cr, uid, ids):
311 if record.move_id and record.move_id.state == 'cancel':
315 #Initialize get_phantom_bom_id method as it is raising an error from yml of mrp_jit
316 #when one install first mrp and after that, mrp_jit. get_phantom_bom_id defined in mrp module
317 #which is not dependent for mrp_jit.
318 def get_phantom_bom_id(self, cr, uid, ids, context=None):
321 def action_confirm(self, cr, uid, ids, context=None):
322 """ Confirms procurement and writes exception message if any.
325 move_obj = self.pool.get('stock.move')
326 for procurement in self.browse(cr, uid, ids, context=context):
327 if procurement.product_qty <= 0.00:
328 raise osv.except_osv(_('Data Insufficient!'),
329 _('Please check the quantity in procurement order(s) for the product "%s", it should not be 0 or less!' % procurement.product_id.name))
330 if procurement.product_id.type in ('product', 'consu'):
331 if not procurement.move_id:
332 source = procurement.location_id.id
333 if procurement.procure_method == 'make_to_order':
334 source = procurement.product_id.property_stock_procurement.id
335 id = move_obj.create(cr, uid, {
336 'name': procurement.name,
337 'location_id': source,
338 'location_dest_id': procurement.location_id.id,
339 'product_id': procurement.product_id.id,
340 'product_qty': procurement.product_qty,
341 'product_uom': procurement.product_uom.id,
342 'date_expected': procurement.date_planned,
344 'company_id': procurement.company_id.id,
345 'auto_validate': True,
347 move_obj.action_confirm(cr, uid, [id], context=context)
348 self.write(cr, uid, [procurement.id], {'move_id': id, 'close_move': 1})
349 self.write(cr, uid, ids, {'state': 'confirmed', 'message': ''})
352 def action_move_assigned(self, cr, uid, ids, context=None):
353 """ Changes procurement state to Running and writes message.
356 message = _('Products reserved from stock.')
357 self.write(cr, uid, ids, {'state': 'running',
358 'message': message}, context=context)
359 self.message_post(cr, uid, ids, body=message, context=context)
362 def _check_make_to_stock_service(self, cr, uid, procurement, context=None):
364 This method may be overrided by objects that override procurement.order
365 for computing their own purpose
369 def _check_make_to_stock_product(self, cr, uid, procurement, context=None):
370 """ Checks procurement move state.
371 @param procurement: Current procurement.
372 @return: True or move id.
375 if procurement.move_id:
377 id = procurement.move_id.id
378 if not (procurement.move_id.state in ('done','assigned','cancel')):
379 ok = ok and self.pool.get('stock.move').action_assign(cr, uid, [id])
380 order_point_id = self.pool.get('stock.warehouse.orderpoint').search(cr, uid, [('product_id', '=', procurement.product_id.id)], context=context)
381 if not order_point_id and not ok:
382 message = _("Not enough stock and no minimum orderpoint rule defined.")
384 message = _("Not enough stock.")
387 message = _("Procurement '%s' is in exception: ") % (procurement.name) + message
388 #temporary context passed in write to prevent an infinite loop
389 ctx_wkf = dict(context or {})
390 ctx_wkf['workflow.trg_write.%s' % self._name] = False
391 self.write(cr, uid, [procurement.id], {'message': message},context=ctx_wkf)
394 def step_workflow(self, cr, uid, ids, context=None):
395 """ Don't trigger workflow for the element specified in trigger """
396 wkf_op_key = 'workflow.trg_write.%s' % self._name
397 if context and not context.get(wkf_op_key, True):
398 # make sure we don't have a trigger loop while processing triggers
400 return super(procurement_order, self).step_workflow(cr, uid, ids, context=context)
402 def action_produce_assign_service(self, cr, uid, ids, context=None):
403 """ Changes procurement state to Running.
406 for procurement in self.browse(cr, uid, ids, context=context):
407 self.write(cr, uid, [procurement.id], {'state': 'running'})
410 def action_produce_assign_product(self, cr, uid, ids, context=None):
411 """ This is action which call from workflow to assign production order to procurements
417 def action_po_assign(self, cr, uid, ids, context=None):
418 """ This is action which call from workflow to assign purchase order to procurements
423 # XXX action_cancel() should accept a context argument
424 def action_cancel(self, cr, uid, ids):
425 """Cancel Procurements and either cancel or assign the related Stock Moves, depending on the procurement configuration.
431 move_obj = self.pool.get('stock.move')
432 for proc in self.browse(cr, uid, ids):
433 if proc.close_move and proc.move_id:
434 if proc.move_id.state not in ('done', 'cancel'):
435 to_cancel.append(proc.move_id.id)
437 if proc.move_id and proc.move_id.state == 'waiting':
438 to_assign.append(proc.move_id.id)
440 move_obj.action_cancel(cr, uid, to_cancel)
442 move_obj.write(cr, uid, to_assign, {'state': 'assigned'})
443 self.write(cr, uid, ids, {'state': 'cancel'})
444 wf_service = netsvc.LocalService("workflow")
446 wf_service.trg_trigger(uid, 'procurement.order', id, cr)
449 def action_check_finished(self, cr, uid, ids):
450 return self.check_move_done(cr, uid, ids)
452 def action_check(self, cr, uid, ids):
453 """ Checks procurement move state whether assigned or done.
457 for procurement in self.browse(cr, uid, ids):
458 if procurement.move_id and procurement.move_id.state == 'assigned' or procurement.move_id.state == 'done':
459 self.action_done(cr, uid, [procurement.id])
463 def action_ready(self, cr, uid, ids):
464 """ Changes procurement state to Ready.
467 res = self.write(cr, uid, ids, {'state': 'ready'})
470 def action_done(self, cr, uid, ids):
471 """ Changes procurement state to Done and writes Closed date.
474 move_obj = self.pool.get('stock.move')
475 for procurement in self.browse(cr, uid, ids):
476 if procurement.move_id:
477 if procurement.close_move and (procurement.move_id.state <> 'done'):
478 move_obj.action_done(cr, uid, [procurement.move_id.id])
479 res = self.write(cr, uid, ids, {'state': 'done', 'date_close': time.strftime('%Y-%m-%d')})
480 wf_service = netsvc.LocalService("workflow")
482 wf_service.trg_trigger(uid, 'procurement.order', id, cr)
485 class StockPicking(osv.osv):
486 _inherit = 'stock.picking'
487 def test_finished(self, cr, uid, ids):
488 res = super(StockPicking, self).test_finished(cr, uid, ids)
489 for picking in self.browse(cr, uid, ids):
490 for move in picking.move_lines:
491 if move.state == 'done' and move.procurements:
492 self.pool.get('procurement.order').signal_button_check(cr, uid, map(attrgetter('id'), move.procurements))
495 class stock_warehouse_orderpoint(osv.osv):
497 Defines Minimum stock rules.
499 _name = "stock.warehouse.orderpoint"
500 _description = "Minimum Inventory Rule"
502 def _get_draft_procurements(self, cr, uid, ids, field_name, arg, context=None):
506 procurement_obj = self.pool.get('procurement.order')
507 for orderpoint in self.browse(cr, uid, ids, context=context):
508 procurement_ids = procurement_obj.search(cr, uid , [('state', '=', 'draft'), ('product_id', '=', orderpoint.product_id.id), ('location_id', '=', orderpoint.location_id.id)])
509 result[orderpoint.id] = procurement_ids
512 def _check_product_uom(self, cr, uid, ids, context=None):
514 Check if the UoM has the same category as the product standard UoM
519 for rule in self.browse(cr, uid, ids, context=context):
520 if rule.product_id.uom_id.category_id.id != rule.product_uom.category_id.id:
526 'name': fields.char('Name', size=32, required=True),
527 'active': fields.boolean('Active', help="If the active field is set to False, it will allow you to hide the orderpoint without removing it."),
528 'logic': fields.selection([('max','Order to Max'),('price','Best price (not yet active!)')], 'Reordering Mode', required=True),
529 'warehouse_id': fields.many2one('stock.warehouse', 'Warehouse', required=True, ondelete="cascade"),
530 'location_id': fields.many2one('stock.location', 'Location', required=True, ondelete="cascade"),
531 'product_id': fields.many2one('product.product', 'Product', required=True, ondelete='cascade', domain=[('type','!=','service')]),
532 'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True),
533 'product_min_qty': fields.float('Minimum Quantity', required=True,
534 help="When the virtual stock goes below the Min Quantity specified for this field, OpenERP generates "\
535 "a procurement to bring the forecasted quantity to the Max Quantity."),
536 'product_max_qty': fields.float('Maximum Quantity', required=True,
537 help="When the virtual stock goes below the Min Quantity, OpenERP generates "\
538 "a procurement to bring the forecasted quantity to the Quantity specified as Max Quantity."),
539 'qty_multiple': fields.integer('Qty Multiple', required=True,
540 help="The procurement quantity will be rounded up to this multiple."),
541 'procurement_id': fields.many2one('procurement.order', 'Latest procurement', ondelete="set null"),
542 'company_id': fields.many2one('res.company','Company',required=True),
543 'procurement_draft_ids': fields.function(_get_draft_procurements, type='many2many', relation="procurement.order", \
544 string="Related Procurement Orders",help="Draft procurement of the product and location of that orderpoint"),
547 'active': lambda *a: 1,
548 'logic': lambda *a: 'max',
549 'qty_multiple': lambda *a: 1,
550 'name': lambda x,y,z,c: x.pool.get('ir.sequence').get(y,z,'stock.orderpoint') or '',
551 'product_uom': lambda sel, cr, uid, context: context.get('product_uom', False),
552 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.warehouse.orderpoint', context=c)
555 ('qty_multiple_check', 'CHECK( qty_multiple > 0 )', 'Qty Multiple must be greater than zero.'),
558 (_check_product_uom, 'You have to select a product unit of measure in the same category than the default unit of measure of the product', ['product_id', 'product_uom']),
561 def default_get(self, cr, uid, fields, context=None):
562 res = super(stock_warehouse_orderpoint, self).default_get(cr, uid, fields, context)
563 # default 'warehouse_id' and 'location_id'
564 if 'warehouse_id' not in res:
565 warehouse = self.pool.get('ir.model.data').get_object(cr, uid, 'stock', 'warehouse0', context)
566 res['warehouse_id'] = warehouse.id
567 if 'location_id' not in res:
568 warehouse = self.pool.get('stock.warehouse').browse(cr, uid, res['warehouse_id'], context)
569 res['location_id'] = warehouse.lot_stock_id.id
572 def onchange_warehouse_id(self, cr, uid, ids, warehouse_id, context=None):
573 """ Finds location id for changed warehouse.
574 @param warehouse_id: Changed id of warehouse.
575 @return: Dictionary of values.
578 w = self.pool.get('stock.warehouse').browse(cr, uid, warehouse_id, context=context)
579 v = {'location_id': w.lot_stock_id.id}
583 def onchange_product_id(self, cr, uid, ids, product_id, context=None):
584 """ Finds UoM for changed product.
585 @param product_id: Changed id of product.
586 @return: Dictionary of values.
589 prod = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
590 d = {'product_uom': [('category_id', '=', prod.uom_id.category_id.id)]}
591 v = {'product_uom': prod.uom_id.id}
592 return {'value': v, 'domain': d}
593 return {'domain': {'product_uom': []}}
595 def copy(self, cr, uid, id, default=None, context=None):
599 'name': self.pool.get('ir.sequence').get(cr, uid, 'stock.orderpoint') or '',
601 return super(stock_warehouse_orderpoint, self).copy(cr, uid, id, default, context=context)
603 class product_template(osv.osv):
604 _inherit="product.template"
607 'type': fields.selection([('product','Stockable Product'),('consu', 'Consumable'),('service','Service')], 'Product Type', required=True, help="Consumable: Will not imply stock management for this product. \nStockable product: Will imply stock management for this product."),
608 'procure_method': fields.selection([('make_to_stock','Make to Stock'),('make_to_order','Make to Order')], 'Procurement Method', required=True, help="Make to Stock: When needed, the product is taken from the stock or we wait for replenishment. \nMake to Order: When needed, the product is purchased or produced."),
609 'supply_method': fields.selection([('produce','Manufacture'),('buy','Buy')], 'Supply Method', required=True, help="Manufacture: When procuring the product, a manufacturing order or a task will be generated, depending on the product type. \nBuy: When procuring the product, a purchase order will be generated."),
612 'procure_method': 'make_to_stock',
613 'supply_method': 'buy',
616 class product_product(osv.osv):
617 _inherit="product.product"
619 'orderpoint_ids': fields.one2many('stock.warehouse.orderpoint', 'product_id', 'Minimum Stock Rules'),
624 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: