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 ##############################################################################
24 from datetime import datetime
25 from dateutil.relativedelta import relativedelta
27 from openerp.osv import fields, osv
28 import openerp.addons.decimal_precision as dp
29 from openerp.tools.translate import _
32 class procurement_group(osv.osv):
34 The procurement requirement class is used to group products together
35 when computing procurements. (tasks, physical products, ...)
37 The goal is that when you have one sale order of several products
38 and the products are pulled from the same or several location(s), to keep
39 having the moves grouped into pickings that represent the sale order.
41 Used in: sales order (to group delivery order lines like the so), pull/push
42 rules (to pack like the delivery order), on orderpoints (e.g. for wave picking
43 all the similar products together).
45 Grouping is made only if the source and the destination is the same.
46 Suppose you have 4 lines on a picking from Output where 2 lines will need
47 to come from Input (crossdock) and 2 lines coming from Stock -> Output As
48 the four procurement orders will have the same group ids from the SO, the
49 move from input will have a stock.picking with 2 grouped lines and the move
50 from stock will have 2 grouped lines also.
52 The name is usually the name of the original document (sale order) or a
53 sequence computed if created manually.
55 _name = 'procurement.group'
56 _description = 'Procurement Requisition'
59 'name': fields.char('Reference', required=True),
60 'move_type': fields.selection([
61 ('direct', 'Partial'), ('one', 'All at once')],
62 'Delivery Method', required=True),
63 'partner_id': fields.many2one('res.partner', string = 'Partner'), #Sale should pass it here
64 'procurement_ids': fields.one2many('procurement.order', 'group_id', 'Procurements'),
67 'name': lambda self, cr, uid, c: self.pool.get('ir.sequence').get(cr, uid, 'procurement.group') or '',
68 'move_type': lambda self, cr, uid, c: 'one'
71 class procurement_rule(osv.osv):
73 A rule describe what a procurement should do; produce, buy, move, ...
75 _name = 'procurement.rule'
76 _description = "Procurement Rule"
79 def _get_action(self, cr, uid, context=None):
83 'name': fields.char('Name', required=True,
84 help="This field will fill the packing origin and the name of its moves"),
85 'group_propagation_option': fields.selection([('none', 'Leave Empty'), ('propagate', 'Propagate'), ('fixed', 'Fixed')], string="Propagation of Procurement Group"),
86 'group_id': fields.many2one('procurement.group', 'Fixed Procurement Group'),
87 'action': fields.selection(selection=lambda s, cr, uid, context=None: s._get_action(cr, uid, context=context),
88 string='Action', required=True),
89 'sequence': fields.integer('Sequence'),
90 'company_id': fields.many2one('res.company', 'Company'),
94 'group_propagation_option': 'propagate',
99 class procurement_order(osv.osv):
103 _name = "procurement.order"
104 _description = "Procurement"
105 _order = 'priority desc, date_planned, id asc'
106 _inherit = ['mail.thread']
109 'name': fields.text('Description', required=True),
111 'origin': fields.char('Source Document', size=64,
112 help="Reference of the document that created this Procurement.\n"
113 "This is automatically completed by OpenERP."),
114 'company_id': fields.many2one('res.company', 'Company', required=True),
116 # These two fields are used for shceduling
117 'priority': fields.selection([('0', 'Not urgent'), ('1', 'Normal'), ('2', 'Urgent'), ('3', 'Very Urgent')], 'Priority', required=True, select=True, track_visibility='onchange'),
118 'date_planned': fields.datetime('Scheduled Date', required=True, select=True, track_visibility='onchange'),
120 'group_id': fields.many2one('procurement.group', 'Procurement Group'),
121 'rule_id': fields.many2one('procurement.rule', 'Rule', track_visibility='onchange', help="Chosen rule for the procurement resolution. Usually chosen by the system but can be manually set by the procurement manager to force an unusual behavior."),
123 'product_id': fields.many2one('product.product', 'Product', required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
124 'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure'), required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
125 'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
127 'product_uos_qty': fields.float('UoS Quantity', states={'confirmed': [('readonly', False)]}, readonly=True),
128 'product_uos': fields.many2one('product.uom', 'Product UoS', states={'confirmed': [('readonly', False)]}, readonly=True),
130 'state': fields.selection([
131 ('cancel', 'Cancelled'),
132 ('confirmed', 'Confirmed'),
133 ('exception', 'Exception'),
134 ('running', 'Running'),
136 ], 'Status', required=True, track_visibility='onchange'),
140 'state': 'confirmed',
142 'date_planned': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
143 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'procurement.order', context=c)
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.') % s['state'])
155 return osv.osv.unlink(self, cr, uid, unlink_ids, context=context)
157 def do_view_procurements(self, cr, uid, ids, context=None):
159 This function returns an action that display existing procurement orders
160 of same procurement group of given ids.
162 mod_obj = self.pool.get('ir.model.data')
163 act_obj = self.pool.get('ir.actions.act_window')
164 result = mod_obj.get_object_reference(cr, uid, 'procurement', 'do_view_procurements')
165 id = result and result[1] or False
166 result = act_obj.read(cr, uid, [id], context=context)[0]
167 group_ids = set([proc.group_id.id for proc in self.browse(cr, uid, ids, context=context) if proc.group_id])
168 result['domain'] = "[('group_id','in',[" + ','.join(map(str, list(group_ids))) + "])]"
171 def onchange_product_id(self, cr, uid, ids, product_id, context=None):
172 """ Finds UoM and UoS of changed product.
173 @param product_id: Changed id of product.
174 @return: Dictionary of values.
177 w = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
179 'product_uom': w.uom_id.id,
180 'product_uos': w.uos_id and w.uos_id.id or w.uom_id.id
185 def get_cancel_ids(self, cr, uid, ids, context=None):
186 return [proc.id for proc in self.browse(cr, uid, ids, context=context) if proc.state != 'done']
188 def cancel(self, cr, uid, ids, context=None):
189 #cancel only the procurements that aren't done already
190 to_cancel_ids = self.get_cancel_ids(cr, uid, ids, context=context)
192 return self.write(cr, uid, to_cancel_ids, {'state': 'cancel'}, context=context)
194 def reset_to_confirmed(self, cr, uid, ids, context=None):
195 return self.write(cr, uid, ids, {'state': 'confirmed'}, context=context)
197 def run(self, cr, uid, ids, context=None):
198 for procurement in self.browse(cr, uid, ids, context=context):
199 if procurement.state not in ("running", "done"):
200 if self._assign(cr, uid, procurement, context=context):
201 procurement.refresh()
202 res = self._run(cr, uid, procurement, context=context or {})
204 self.write(cr, uid, [procurement.id], {'state': 'running'}, context=context)
206 self.write(cr, uid, [procurement.id], {'state': 'exception'}, context=context)
208 self.message_post(cr, uid, [procurement.id], body=_('No rule matching this procurement'), context=context)
209 self.write(cr, uid, [procurement.id], {'state': 'exception'}, context=context)
212 def check(self, cr, uid, ids, context=None):
214 for procurement in self.browse(cr, uid, ids, context=context):
215 result = self._check(cr, uid, procurement, context=context)
217 done_ids.append(procurement.id)
219 self.write(cr, uid, done_ids, {'state': 'done'}, context=context)
223 # Method to overwrite in different procurement modules
225 def _find_suitable_rule(self, cr, uid, procurement, context=None):
226 '''This method returns a procurement.rule that depicts what to do with the given procurement
227 in order to complete its needs. It returns False if no suiting rule is found.
228 :param procurement: browse record
233 def _assign(self, cr, uid, procurement, context=None):
234 '''This method check what to do with the given procurement in order to complete its needs.
235 It returns False if no solution is found, otherwise it stores the matching rule (if any) and
237 :param procurement: browse record
240 #if the procurement already has a rule assigned, we keep it (it has a higher priority as it may have been chosen manually)
241 if procurement.rule_id:
243 elif procurement.product_id.type != 'service':
244 rule_id = self._find_suitable_rule(cr, uid, procurement, context=context)
246 self.write(cr, uid, [procurement.id], {'rule_id': rule_id}, context=context)
250 def _run(self, cr, uid, procurement, context=None):
251 '''This method implements the resolution of the given procurement
252 :param procurement: browse record
253 :returns: True if the resolution of the procurement was a success, False otherwise to set it in exception
257 def _check(self, cr, uid, procurement, context=None):
258 '''Returns True if the given procurement is fulfilled, False otherwise
259 :param procurement: browse record
267 def run_scheduler(self, cr, uid, use_new_cursor=False, context=None):
269 Call the scheduler to check the procurement order
271 @param self: The object pointer
272 @param cr: The current row, from the database cursor,
273 @param uid: The current user ID for security checks
274 @param ids: List of selected IDs
275 @param use_new_cursor: False or the dbname
276 @param context: A standard dictionary for contextual values
277 @return: Dictionary of values
283 cr = openerp.registry(use_new_cursor).db.cursor()
285 company = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id
286 maxdate = (datetime.today() + relativedelta(days=company.schedule_range)).strftime('%Y-%m-%d %H:%M:%S')
288 # Run confirmed procurements
290 ids = self.search(cr, uid, [('state', '=', 'confirmed'), ('date_planned', '<=', maxdate)], context=context)
293 self.run(cr, uid, ids, context=context)
297 # Check if running procurements are done
300 ids = self.search(cr, uid, [('state', '=', 'running'), ('date_planned', '<=', maxdate)], offset=offset, context=context)
303 done = self.check(cr, uid, ids, context=context)
304 offset += len(ids) - len(done)
315 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: