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 openerp.osv import fields, osv
23 from openerp.tools.translate import _
24 from openerp import netsvc
26 import openerp.addons.decimal_precision as dp
29 # ------------------------------------------------------------------
31 # Produce, Buy or Find products and place a move
32 # then wizard for picking lists & move
35 class mrp_property_group(osv.osv):
37 Group of mrp properties.
39 _name = 'mrp.property.group'
40 _description = 'Property Group'
42 'name': fields.char('Property Group', size=64, required=True),
43 'description': fields.text('Description'),
47 class mrp_property(osv.osv):
51 _name = 'mrp.property'
52 _description = 'Property'
54 'name': fields.char('Name', size=64, required=True),
55 'composition': fields.selection([('min','min'),('max','max'),('plus','plus')], 'Properties composition', required=True, help="Not used in computations, for information purpose only."),
56 'group_id': fields.many2one('mrp.property.group', 'Property Group', required=True),
57 'description': fields.text('Description'),
60 '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)
78 class procurement_order(osv.osv):
82 _name = "procurement.order"
83 _description = "Procurement"
84 _order = 'priority desc,date_planned'
85 _inherit = ['mail.thread']
88 'name': fields.text('Description', required=True),
89 'origin': fields.char('Source Document', size=64,
90 help="Reference of the document that created this Procurement.\n"
91 "This is automatically completed by OpenERP."),
92 'priority': fields.selection([('0','Not urgent'),('1','Normal'),('2','Urgent'),('3','Very Urgent')], 'Priority', required=True, select=True),
93 'date_planned': fields.datetime('Scheduled date', required=True, select=True),
94 'date_close': fields.datetime('Date Closed'),
95 'product_id': fields.many2one('product.product', 'Product', required=True, states={'draft':[('readonly',False)]}, readonly=True),
96 'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure'), required=True, states={'draft':[('readonly',False)]}, readonly=True),
97 'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True, states={'draft':[('readonly',False)]}, readonly=True),
98 'product_uos_qty': fields.float('UoS Quantity', states={'draft':[('readonly',False)]}, readonly=True),
99 'product_uos': fields.many2one('product.uom', 'Product UoS', states={'draft':[('readonly',False)]}, readonly=True),
100 'move_id': fields.many2one('stock.move', 'Reservation', ondelete='set null'),
101 'close_move': fields.boolean('Close Move at end'),
102 'location_id': fields.many2one('stock.location', 'Location', required=True, states={'draft':[('readonly',False)]}, readonly=True),
103 '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)]},
104 readonly=True, required=True, help="If you encode manually a Procurement, you probably want to use" \
105 " a make to order method."),
106 'note': fields.text('Note'),
107 'message': fields.char('Latest error', size=124, help="Exception occurred while computing procurement orders."),
108 'state': fields.selection([
110 ('cancel','Cancelled'),
111 ('confirmed','Confirmed'),
112 ('exception','Exception'),
113 ('running','Running'),
116 ('waiting','Waiting')], 'Status', required=True, track_visibility='onchange',
117 help='When a procurement is created the status is set to \'Draft\'.\n If the procurement is confirmed, the status is set to \'Confirmed\'.\
118 \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.'),
119 'note': fields.text('Note'),
120 'company_id': fields.many2one('res.company','Company',required=True),
125 'date_planned': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
127 'procure_method': 'make_to_order',
128 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'procurement.order', context=c)
131 def message_track(self, cr, uid, ids, tracked_fields, initial_values, context=None):
132 """ Overwrite message_track to avoid tracking more than once the confirm-exception loop
133 Add '_first_pass_done_' to the note field only the first time stuck in exception state
134 Will avoid getting furthur confirmed and exception change of state messages
136 TODO: this hack is necessary for a stable version but should be avoided for the next release.
137 Instead find a more elegant way to prevent redundant messages or entirely stop tracking states on procurement orders
139 for proc in self.browse(cr, uid, ids, context=context):
140 if not proc.note or '_first_pass_done_' not in proc.note or proc.state not in ('confirmed', 'exception'):
141 super(procurement_order, self).message_track(cr, uid, [proc.id], tracked_fields, initial_values, context=context)
142 if proc.state == 'exception':
143 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))
147 def unlink(self, cr, uid, ids, context=None):
148 procurements = self.read(cr, uid, ids, ['state'], context=context)
150 for s in procurements:
151 if s['state'] in ['draft','cancel']:
152 unlink_ids.append(s['id'])
154 raise osv.except_osv(_('Invalid Action!'),
155 _('Cannot delete Procurement Order(s) which are in %s state.') % \
157 return osv.osv.unlink(self, cr, uid, unlink_ids, context=context)
159 def onchange_product_id(self, cr, uid, ids, product_id, context=None):
160 """ Finds UoM and UoS of changed product.
161 @param product_id: Changed id of product.
162 @return: Dictionary of values.
165 w = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
167 'product_uom': w.uom_id.id,
168 'product_uos': w.uos_id and w.uos_id.id or w.uom_id.id
173 def is_product(self, cr, uid, ids, context=None):
174 """ Checks product type to decide which transition of the workflow to follow.
175 @return: True if all product ids received in argument are of type 'product' or 'consummable'. False if any is of type 'service'
177 return all(proc.product_id.type in ('product', 'consu') for proc in self.browse(cr, uid, ids, context=context))
179 def check_move_cancel(self, cr, uid, ids, context=None):
180 """ Checks if move is cancelled or not.
181 @return: True or False.
183 return all(procurement.move_id.state == 'cancel' for procurement in self.browse(cr, uid, ids, context=context))
185 def check_move_done(self, cr, uid, ids, context=None):
186 """ Checks if move is done or not.
187 @return: True or False.
189 return all(proc.product_id.type == 'service' or (proc.move_id and proc.move_id.state == 'done') \
190 for proc in self.browse(cr, uid, ids, context=context))
193 # This method may be overrided by objects that override procurement.order
194 # for computing their own purpose
196 def _quantity_compute_get(self, cr, uid, proc, context=None):
197 """ Finds sold quantity of product.
198 @param proc: Current procurement.
199 @return: Quantity or False.
201 if proc.product_id.type == 'product' and proc.move_id:
202 if proc.move_id.product_uos:
203 return proc.move_id.product_uos_qty
206 def _uom_compute_get(self, cr, uid, proc, context=None):
207 """ Finds UoS if product is Stockable Product.
208 @param proc: Current procurement.
209 @return: UoS or False.
211 if proc.product_id.type == 'product' and proc.move_id:
212 if proc.move_id.product_uos:
213 return proc.move_id.product_uos.id
217 # Return the quantity of product shipped/produced/served, which may be
218 # different from the planned quantity
220 def quantity_get(self, cr, uid, id, context=None):
221 """ Finds quantity of product used in procurement.
222 @return: Quantity of product.
224 proc = self.browse(cr, uid, id, context=context)
225 result = self._quantity_compute_get(cr, uid, proc, context=context)
227 result = proc.product_qty
230 def uom_get(self, cr, uid, id, context=None):
231 """ Finds UoM of product used in procurement.
232 @return: UoM of product.
234 proc = self.browse(cr, uid, id, context=context)
235 result = self._uom_compute_get(cr, uid, proc, context=context)
237 result = proc.product_uom.id
240 def check_waiting(self, cr, uid, ids, context=None):
241 """ Checks state of move.
242 @return: True or False
244 for procurement in self.browse(cr, uid, ids, context=context):
245 if procurement.move_id and procurement.move_id.state == 'auto':
249 def check_produce_service(self, cr, uid, procurement, context=None):
250 """ Depicts the capacity of the procurement workflow to deal with production of services.
251 By default, it's False. Overwritten by project_mrp module.
255 def check_produce_product(self, cr, uid, procurement, context=None):
256 """ Depicts the capacity of the procurement workflow to deal with production of products.
257 By default, it's False. Overwritten by mrp module.
261 def check_make_to_stock(self, cr, uid, ids, context=None):
262 """ Checks product type.
263 @return: True or False
266 for procurement in self.browse(cr, uid, ids, context=context):
267 if procurement.product_id.type == 'service':
268 ok = ok and self._check_make_to_stock_service(cr, uid, procurement, context)
270 ok = ok and self._check_make_to_stock_product(cr, uid, procurement, context)
273 def check_produce(self, cr, uid, ids, context=None):
274 """ Checks product type.
275 @return: True or False
277 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
278 for procurement in self.browse(cr, uid, ids, context=context):
279 product = procurement.product_id
280 #TOFIX: if product type is 'service' but supply_method is 'buy'.
281 if product.supply_method <> 'produce':
283 if product.type=='service':
284 res = self.check_produce_service(cr, uid, procurement, context)
286 res = self.check_produce_product(cr, uid, procurement, context)
291 def check_buy(self, cr, uid, ids):
292 """ Depicts the capacity of the procurement workflow to manage the supply_method == 'buy'.
293 By default, it's False. Overwritten by purchase module.
297 def check_move(self, cr, uid, ids, context=None):
298 """ Check whether the given procurement can be satisfied by an internal move,
299 typically a pulled flow. By default, it's False. Overwritten by the `stock_location` module.
303 def check_conditions_confirm2wait(self, cr, uid, ids):
304 """ condition on the transition to go from 'confirm' activity to 'confirm_wait' activity """
305 return not self.test_cancel(cr, uid, ids)
307 def test_cancel(self, cr, uid, ids):
308 """ Tests whether state of move is cancelled or not.
309 @return: True or False
311 for record in self.browse(cr, uid, ids):
312 if record.move_id and record.move_id.state == 'cancel':
316 #Initialize get_phantom_bom_id method as it is raising an error from yml of mrp_jit
317 #when one install first mrp and after that, mrp_jit. get_phantom_bom_id defined in mrp module
318 #which is not dependent for mrp_jit.
319 def get_phantom_bom_id(self, cr, uid, ids, context=None):
322 def action_confirm(self, cr, uid, ids, context=None):
323 """ Confirms procurement and writes exception message if any.
326 move_obj = self.pool.get('stock.move')
327 for procurement in self.browse(cr, uid, ids, context=context):
328 if procurement.product_qty <= 0.00:
329 raise osv.except_osv(_('Data Insufficient!'),
330 _('Please check the quantity in procurement order(s) for the product "%s", it should not be 0 or less!' % procurement.product_id.name))
331 if procurement.product_id.type in ('product', 'consu'):
332 if not procurement.move_id:
333 source = procurement.location_id.id
334 if procurement.procure_method == 'make_to_order':
335 source = procurement.product_id.property_stock_procurement.id
336 id = move_obj.create(cr, uid, {
337 'name': procurement.name,
338 'location_id': source,
339 'location_dest_id': procurement.location_id.id,
340 'product_id': procurement.product_id.id,
341 'product_qty': procurement.product_qty,
342 'product_uom': procurement.product_uom.id,
343 'date_expected': procurement.date_planned,
345 'company_id': procurement.company_id.id,
346 'auto_validate': True,
348 move_obj.action_confirm(cr, uid, [id], context=context)
349 self.write(cr, uid, [procurement.id], {'move_id': id, 'close_move': 1})
350 self.write(cr, uid, ids, {'state': 'confirmed', 'message': ''})
353 def action_move_assigned(self, cr, uid, ids, context=None):
354 """ Changes procurement state to Running and writes message.
357 message = _('Products reserved from stock.')
358 self.write(cr, uid, ids, {'state': 'running',
359 'message': message}, context=context)
360 self.message_post(cr, uid, ids, body=message, context=context)
363 def _check_make_to_stock_service(self, cr, uid, procurement, context=None):
365 This method may be overrided by objects that override procurement.order
366 for computing their own purpose
370 def _check_make_to_stock_product(self, cr, uid, procurement, context=None):
371 """ Checks procurement move state.
372 @param procurement: Current procurement.
373 @return: True or move id.
376 if procurement.move_id:
378 id = procurement.move_id.id
379 if not (procurement.move_id.state in ('done','assigned','cancel')):
380 ok = ok and self.pool.get('stock.move').action_assign(cr, uid, [id])
381 order_point_id = self.pool.get('stock.warehouse.orderpoint').search(cr, uid, [('product_id', '=', procurement.product_id.id)], context=context)
382 if not order_point_id and not ok:
383 message = _("Not enough stock and no minimum orderpoint rule defined.")
385 message = _("Not enough stock.")
388 message = _("Procurement '%s' is in exception: ") % (procurement.name) + message
389 #temporary context passed in write to prevent an infinite loop
390 ctx_wkf = dict(context or {})
391 ctx_wkf['workflow.trg_write.%s' % self._name] = False
392 self.write(cr, uid, [procurement.id], {'message': message},context=ctx_wkf)
395 def _workflow_trigger(self, cr, uid, ids, trigger, context=None):
396 """ Don't trigger workflow for the element specified in trigger
398 wkf_op_key = 'workflow.%s.%s' % (trigger, self._name)
399 if context and not context.get(wkf_op_key, True):
400 # make sure we don't have a trigger loop while processing triggers
402 return super(procurement_order,self)._workflow_trigger(cr, uid, ids, trigger, context=context)
404 def action_produce_assign_service(self, cr, uid, ids, context=None):
405 """ Changes procurement state to Running.
408 for procurement in self.browse(cr, uid, ids, context=context):
409 self.write(cr, uid, [procurement.id], {'state': 'running'})
412 def action_produce_assign_product(self, cr, uid, ids, context=None):
413 """ This is action which call from workflow to assign production order to procurements
419 def action_po_assign(self, cr, uid, ids, context=None):
420 """ This is action which call from workflow to assign purchase order to procurements
425 # XXX action_cancel() should accept a context argument
426 def action_cancel(self, cr, uid, ids):
427 """Cancel Procurements and either cancel or assign the related Stock Moves, depending on the procurement configuration.
433 move_obj = self.pool.get('stock.move')
434 for proc in self.browse(cr, uid, ids):
435 if proc.close_move and proc.move_id:
436 if proc.move_id.state not in ('done', 'cancel'):
437 to_cancel.append(proc.move_id.id)
439 if proc.move_id and proc.move_id.state == 'waiting':
440 to_assign.append(proc.move_id.id)
442 move_obj.action_cancel(cr, uid, to_cancel)
444 move_obj.write(cr, uid, to_assign, {'state': 'assigned'})
445 self.write(cr, uid, ids, {'state': 'cancel'})
446 wf_service = netsvc.LocalService("workflow")
448 wf_service.trg_trigger(uid, 'procurement.order', id, cr)
451 def action_check_finished(self, cr, uid, ids):
452 return self.check_move_done(cr, uid, ids)
454 def action_check(self, cr, uid, ids):
455 """ Checks procurement move state whether assigned or done.
459 for procurement in self.browse(cr, uid, ids):
460 if procurement.move_id and procurement.move_id.state == 'assigned' or procurement.move_id.state == 'done':
461 self.action_done(cr, uid, [procurement.id])
465 def action_ready(self, cr, uid, ids):
466 """ Changes procurement state to Ready.
469 res = self.write(cr, uid, ids, {'state': 'ready'})
472 def action_done(self, cr, uid, ids):
473 """ Changes procurement state to Done and writes Closed date.
476 move_obj = self.pool.get('stock.move')
477 for procurement in self.browse(cr, uid, ids):
478 if procurement.move_id:
479 if procurement.close_move and (procurement.move_id.state <> 'done'):
480 move_obj.action_done(cr, uid, [procurement.move_id.id])
481 res = self.write(cr, uid, ids, {'state': 'done', 'date_close': time.strftime('%Y-%m-%d')})
482 wf_service = netsvc.LocalService("workflow")
484 wf_service.trg_trigger(uid, 'procurement.order', id, cr)
487 class StockPicking(osv.osv):
488 _inherit = 'stock.picking'
489 def test_finished(self, cursor, user, ids):
490 wf_service = netsvc.LocalService("workflow")
491 res = super(StockPicking, self).test_finished(cursor, user, ids)
492 for picking in self.browse(cursor, user, ids):
493 for move in picking.move_lines:
494 if move.state == 'done' and move.procurements:
495 for procurement in move.procurements:
496 wf_service.trg_validate(user, 'procurement.order',
497 procurement.id, 'button_check', cursor)
500 class stock_warehouse_orderpoint(osv.osv):
502 Defines Minimum stock rules.
504 _name = "stock.warehouse.orderpoint"
505 _description = "Minimum Inventory Rule"
507 def _get_draft_procurements(self, cr, uid, ids, field_name, arg, context=None):
511 procurement_obj = self.pool.get('procurement.order')
512 for orderpoint in self.browse(cr, uid, ids, context=context):
513 procurement_ids = procurement_obj.search(cr, uid , [('state', '=', 'draft'), ('product_id', '=', orderpoint.product_id.id), ('location_id', '=', orderpoint.location_id.id)])
514 result[orderpoint.id] = procurement_ids
517 def _check_product_uom(self, cr, uid, ids, context=None):
519 Check if the UoM has the same category as the product standard UoM
524 for rule in self.browse(cr, uid, ids, context=context):
525 if rule.product_id.uom_id.category_id.id != rule.product_uom.category_id.id:
531 'name': fields.char('Name', size=32, required=True),
532 'active': fields.boolean('Active', help="If the active field is set to False, it will allow you to hide the orderpoint without removing it."),
533 'logic': fields.selection([('max','Order to Max'),('price','Best price (not yet active!)')], 'Reordering Mode', required=True),
534 'warehouse_id': fields.many2one('stock.warehouse', 'Warehouse', required=True, ondelete="cascade"),
535 'location_id': fields.many2one('stock.location', 'Location', required=True, ondelete="cascade"),
536 'product_id': fields.many2one('product.product', 'Product', required=True, ondelete='cascade', domain=[('type','!=','service')]),
537 'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True),
538 'product_min_qty': fields.float('Minimum Quantity', required=True,
539 help="When the virtual stock goes below the Min Quantity specified for this field, OpenERP generates "\
540 "a procurement to bring the forecasted quantity to the Max Quantity."),
541 'product_max_qty': fields.float('Maximum Quantity', required=True,
542 help="When the virtual stock goes below the Min Quantity, OpenERP generates "\
543 "a procurement to bring the forecasted quantity to the Quantity specified as Max Quantity."),
544 'qty_multiple': fields.integer('Qty Multiple', required=True,
545 help="The procurement quantity will be rounded up to this multiple."),
546 'procurement_id': fields.many2one('procurement.order', 'Latest procurement', ondelete="set null"),
547 'company_id': fields.many2one('res.company','Company',required=True),
548 'procurement_draft_ids': fields.function(_get_draft_procurements, type='many2many', relation="procurement.order", \
549 string="Related Procurement Orders",help="Draft procurement of the product and location of that orderpoint"),
552 'active': lambda *a: 1,
553 'logic': lambda *a: 'max',
554 'qty_multiple': lambda *a: 1,
555 'name': lambda x,y,z,c: x.pool.get('ir.sequence').get(y,z,'stock.orderpoint') or '',
556 'product_uom': lambda sel, cr, uid, context: context.get('product_uom', False),
557 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.warehouse.orderpoint', context=c)
560 ('qty_multiple_check', 'CHECK( qty_multiple > 0 )', 'Qty Multiple must be greater than zero.'),
563 (_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']),
566 def default_get(self, cr, uid, fields, context=None):
567 res = super(stock_warehouse_orderpoint, self).default_get(cr, uid, fields, context)
568 # default 'warehouse_id' and 'location_id'
569 if 'warehouse_id' not in res:
570 warehouse = self.pool.get('ir.model.data').get_object(cr, uid, 'stock', 'warehouse0', context)
571 res['warehouse_id'] = warehouse.id
572 if 'location_id' not in res:
573 warehouse = self.pool.get('stock.warehouse').browse(cr, uid, res['warehouse_id'], context)
574 res['location_id'] = warehouse.lot_stock_id.id
577 def onchange_warehouse_id(self, cr, uid, ids, warehouse_id, context=None):
578 """ Finds location id for changed warehouse.
579 @param warehouse_id: Changed id of warehouse.
580 @return: Dictionary of values.
583 w = self.pool.get('stock.warehouse').browse(cr, uid, warehouse_id, context=context)
584 v = {'location_id': w.lot_stock_id.id}
588 def onchange_product_id(self, cr, uid, ids, product_id, context=None):
589 """ Finds UoM for changed product.
590 @param product_id: Changed id of product.
591 @return: Dictionary of values.
594 prod = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
595 d = {'product_uom': [('category_id', '=', prod.uom_id.category_id.id)]}
596 v = {'product_uom': prod.uom_id.id}
597 return {'value': v, 'domain': d}
598 return {'domain': {'product_uom': []}}
600 def copy(self, cr, uid, id, default=None, context=None):
604 'name': self.pool.get('ir.sequence').get(cr, uid, 'stock.orderpoint') or '',
606 return super(stock_warehouse_orderpoint, self).copy(cr, uid, id, default, context=context)
608 class product_template(osv.osv):
609 _inherit="product.template"
612 '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."),
613 '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."),
614 '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."),
617 'procure_method': 'make_to_stock',
618 'supply_method': 'buy',
621 class product_product(osv.osv):
622 _inherit="product.product"
624 'orderpoint_ids': fields.one2many('stock.warehouse.orderpoint', 'product_id', 'Minimum Stock Rules'),
629 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: