addons/procurement/procurement.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20 ##############################################################################
  21
  22 import time
  23
  24 from datetime import datetime
  25 from dateutil.relativedelta import relativedelta
  26
  27 from openerp.osv import fields, osv
  28 import openerp.addons.decimal_precision as dp
  29 from openerp.tools.translate import _
  30 import openerp
  31
  32 class procurement_group(osv.osv):
  33     '''
  34     The procurement requirement class is used to group products together
  35     when computing procurements. (tasks, physical products, ...)
  36
  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.
  40
  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).
  44
  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.
  51
  52     The name is usually the name of the original document (sale order) or a
  53     sequence computed if created manually.
  54     '''
  55     _name = 'procurement.group'
  56     _description = 'Procurement Requisition'
  57     _order = "id desc"
  58     _columns = {
  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'),
  65     }
  66     _defaults = {
  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'
  69     }
  70
  71 class procurement_rule(osv.osv):
  72     '''
  73     A rule describe what a procurement should do; produce, buy, move, ...
  74     '''
  75     _name = 'procurement.rule'
  76     _description = "Procurement Rule"
  77     _order = "name"
  78
  79     def _get_action(self, cr, uid, context=None):
  80         return []
  81
  82     _columns = {
  83         'name': fields.char('Name', required=True,
  84             help="This field will fill the packing origin and the name of its moves"),
  85         'group_id': fields.many2one('procurement.group', 'Procurement Group'),
  86         'action': fields.selection(selection=lambda s, cr, uid, context=None: s._get_action(cr, uid, context=context),
  87             string='Action', required=True),
  88     }
  89
  90
  91 class procurement_order(osv.osv):
  92     """
  93     Procurement Orders
  94     """
  95     _name = "procurement.order"
  96     _description = "Procurement"
  97     _order = 'priority desc,date_planned'
  98     _inherit = ['mail.thread']
  99     _log_create = False
 100     _columns = {
 101         'name': fields.text('Description', required=True),
 102
 103         'origin': fields.char('Source Document', size=64,
 104             help="Reference of the document that created this Procurement.\n"
 105             "This is automatically completed by OpenERP."),
 106         'company_id': fields.many2one('res.company', 'Company', required=True),
 107
 108         # These two fields are used for shceduling
 109         'priority': fields.selection([('0', 'Not urgent'), ('1', 'Normal'), ('2', 'Urgent'), ('3', 'Very Urgent')], 'Priority', required=True, select=True),
 110         'date_planned': fields.datetime('Scheduled date', required=True, select=True),
 111
 112         'group_id': fields.many2one('procurement.group', 'Procurement Group'),
 113         'rule_id': fields.many2one('procurement.rule', 'Rule'),
 114
 115         'product_id': fields.many2one('product.product', 'Product', required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
 116         'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure'), required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
 117         'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
 118
 119         'product_uos_qty': fields.float('UoS Quantity', states={'confirmed': [('readonly', False)]}, readonly=True),
 120         'product_uos': fields.many2one('product.uom', 'Product UoS', states={'confirmed': [('readonly', False)]}, readonly=True),
 121
 122         'state': fields.selection([
 123             ('cancel', 'Cancelled'),
 124             ('confirmed', 'Confirmed'),
 125             ('exception', 'Exception'),
 126             ('running', 'Running'),
 127             ('done', 'Done')
 128         ], 'Status', required=True, track_visibility='onchange'),
 129         'message': fields.text('Latest error', help="Exception occurred while computing procurement orders.", track_visibility='onchange'),
 130     }
 131
 132     _defaults = {
 133         'state': 'confirmed',
 134         'priority': '1',
 135         'date_planned': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
 136         'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'procurement.order', context=c)
 137     }
 138     def onchange_product_id(self, cr, uid, ids, product_id, context=None):
 139         """ Finds UoM and UoS of changed product.
 140         @param product_id: Changed id of product.
 141         @return: Dictionary of values.
 142         """
 143         if product_id:
 144             w = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
 145             v = {
 146                 'product_uom': w.uom_id.id,
 147                 'product_uos': w.uos_id and w.uos_id.id or w.uom_id.id
 148             }
 149             return {'value': v}
 150         return {}
 151
 152     def cancel(self, cr, uid, ids, context=None):
 153         self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
 154         return True
 155
 156     def run(self, cr, uid, ids, context=None):
 157         for procurement in self.browse(cr, uid, ids, context=context):
 158             if procurement.state not in ("running", "done"):
 159                 if self._assign(cr, uid, procurement, context=context):
 160                     procurement.refresh()
 161                     res = self._run(cr, uid, procurement, context=context or {})
 162                     if res:
 163                         self.write(cr, uid, [procurement.id], {'state': 'running'}, context=context)
 164                     else:
 165                         self.write(cr, uid, [procurement.id], {'state': 'exception'}, context=context)
 166                 else:
 167                     self.message_post(cr, uid, [procurement.id], body=_('No rule matching this procurement'), context=context)
 168                     self.write(cr, uid, [procurement.id], {'state': 'exception'}, context=context)
 169         return True
 170
 171     def check(self, cr, uid, ids, context=None):
 172         done_ids = []
 173         for procurement in self.browse(cr, uid, ids, context=context):
 174             result = self._check(cr, uid, procurement, context=context)
 175             if result:
 176                 done_ids.append(procurement.id)
 177         if done_ids:
 178             self.write(cr, uid, done_ids, {'state': 'done'}, context=context)
 179         return done_ids
 180
 181     #
 182     # Method to overwrite in different procurement modules
 183     #
 184     def _find_suitable_rule(self, cr, uid, procurement, context=None):
 185         '''This method returns a procurement.rule that depicts what to do with the given procurement
 186         in order to complete its needs. It returns False if no suiting rule is found.
 187             :param procurement: browse record
 188             :rtype: int or False
 189         '''
 190         return False
 191
 192     def _assign(self, cr, uid, procurement, context=None):
 193         '''This method check what to do with the given procurement in order to complete its needs.
 194         It returns False if no solution is found, otherwise it stores the matching rule (if any) and
 195         returns True.
 196             :param procurement: browse record
 197             :rtype: boolean
 198         '''
 199         if procurement.product_id.type != 'service':
 200             rule_id = self._find_suitable_rule(cr, uid, procurement, context=context)
 201             if rule_id:
 202                 rule = self.pool.get('procurement.rule').browse(cr, uid, rule_id, context=context)
 203                 self.message_post(cr, uid, [procurement.id], body=_('Following rule %s for the procurement resolution.') % (rule.name), context=context)
 204                 self.write(cr, uid, [procurement.id], {'rule_id': rule_id}, context=context)
 205                 return True
 206         return False
 207
 208     def _run(self, cr, uid, procurement, context=None):
 209         '''This method implements the resolution of the given procurement
 210             :param procurement: browse record
 211         '''
 212         return True
 213
 214     def _check(self, cr, uid, procurement, context=None):
 215         '''Returns True if the given procurement is fulfilled, False otherwise
 216             :param procurement: browse record
 217             :rtype: boolean
 218         '''
 219         return False
 220
 221     #
 222     # Scheduler
 223     #
 224     def run_scheduler(self, cr, uid, use_new_cursor=False, context=None):
 225         '''
 226         Call the scheduler to check the procurement order
 227
 228         @param self: The object pointer
 229         @param cr: The current row, from the database cursor,
 230         @param uid: The current user ID for security checks
 231         @param ids: List of selected IDs
 232         @param use_new_cursor: False or the dbname
 233         @param context: A standard dictionary for contextual values
 234         @return:  Dictionary of values
 235         '''
 236         if context is None:
 237             context = {}
 238         try:
 239             if use_new_cursor:
 240                 cr = openerp.registry(use_new_cursor).db.cursor()
 241
 242             company = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id
 243             maxdate = (datetime.today() + relativedelta(days=company.schedule_range)).strftime('%Y-%m-%d %H:%M:%S')
 244
 245             # Run confirmed procurements
 246             while True:
 247                 ids = self.search(cr, uid, [('state', '=', 'confirmed'), ('date_planned', '<=', maxdate)], context=context)
 248                 if not ids:
 249                     break
 250                 self.run(cr, uid, ids, context=context)
 251                 if use_new_cursor:
 252                     cr.commit()
 253
 254             # Check if running procurements are done
 255             offset = 0
 256             while True:
 257                 ids = self.search(cr, uid, [('state', '=', 'running'), ('date_planned', '<=', maxdate)], offset=offset, context=context)
 258                 if not ids:
 259                     break
 260                 done = self.check(cr, uid, ids, context=context)
 261                 offset += len(ids) - len(done)
 262                 if use_new_cursor and len(done):
 263                     cr.commit()
 264
 265         finally:
 266             if use_new_cursor:
 267                 try:
 268                     cr.close()
 269                 except Exception:
 270                     pass
 271         return {}
 272 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: