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
  72 class procurement_rule(osv.osv):
  73     '''
  74     A rule describe what a procurement should do; produce, buy, move, ...
  75     '''
  76     _name = 'procurement.rule'
  77     _description = "Procurement Rule"
  78     _order = "name"
  79
  80     def _get_action(self, cr, uid, context=None):
  81         return []
  82
  83     _columns = {
  84         'name': fields.char('Name', required=True,
  85             help="This field will fill the packing origin and the name of its moves"),
  86         'group_id': fields.many2one('procurement.group', '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     }
  90
  91
  92 class procurement_order(osv.osv):
  93     """
  94     Procurement Orders
  95     """
  96     _name = "procurement.order"
  97     _description = "Procurement"
  98     _order = 'priority desc,date_planned'
  99     _inherit = ['mail.thread']
 100     _log_create = False
 101     _columns = {
 102         'name': fields.text('Description', required=True),
 103
 104         'origin': fields.char('Source Document', size=64,
 105             help="Reference of the document that created this Procurement.\n"
 106             "This is automatically completed by OpenERP."),
 107         'company_id': fields.many2one('res.company', 'Company', required=True),
 108
 109         # These two fields are used for shceduling
 110         'priority': fields.selection([('0', 'Not urgent'), ('1', 'Normal'), ('2', 'Urgent'), ('3', 'Very Urgent')], 'Priority', required=True, select=True),
 111         'date_planned': fields.datetime('Scheduled date', required=True, select=True),
 112
 113         'group_id': fields.many2one('procurement.group', 'Procurement Requisition'),
 114         'rule_id': fields.many2one('procurement.rule', 'Rule'),
 115
 116         'product_id': fields.many2one('product.product', 'Product', required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
 117         'product_qty': fields.float('Quantity', digits_compute=dp.get_precision('Product Unit of Measure'), required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
 118         'product_uom': fields.many2one('product.uom', 'Product Unit of Measure', required=True, states={'confirmed': [('readonly', False)]}, readonly=True),
 119
 120         'product_uos_qty': fields.float('UoS Quantity', states={'confirmed': [('readonly', False)]}, readonly=True),
 121         'product_uos': fields.many2one('product.uom', 'Product UoS', states={'confirmed': [('readonly', False)]}, readonly=True),
 122
 123         'state': fields.selection([
 124             ('cancel', 'Cancelled'),
 125             ('confirmed', 'Confirmed'),
 126             ('exception', 'Exception'),
 127             ('running', 'Running'),
 128             ('done', 'Done')
 129         ], 'Status', required=True, track_visibility='onchange'),
 130         'message': fields.text('Latest error', help="Exception occurred while computing procurement orders.", track_visibility='onchange'),
 131     }
 132
 133     _defaults = {
 134         'state': 'confirmed',
 135         'priority': '1',
 136         'date_planned': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
 137         'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'procurement.order', context=c)
 138     }
 139     def onchange_product_id(self, cr, uid, ids, product_id, context=None):
 140         """ Finds UoM and UoS of changed product.
 141         @param product_id: Changed id of product.
 142         @return: Dictionary of values.
 143         """
 144         if product_id:
 145             w = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
 146             v = {
 147                 'product_uom': w.uom_id.id,
 148                 'product_uos': w.uos_id and w.uos_id.id or w.uom_id.id
 149             }
 150             return {'value': v}
 151         return {}
 152
 153     def cancel(self, cr, uid, ids, context=None):
 154         self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
 155         return True
 156
 157     def run(self, cr, uid, ids, context=None):
 158         for procurement in self.browse(cr, uid, ids, context=context):
 159             if procurement.state not in ("running", "done"):
 160                 if self._assign(cr, uid, procurement, context=context):
 161                     procurement.refresh()
 162                     res = self._run(cr, uid, procurement, context=context or {})
 163                     if res:
 164                         self.write(cr, uid, [procurement.id], {'state': 'running'}, context=context)
 165                     else:
 166                         self.write(cr, uid, [procurement.id], {'state': 'exception'}, context=context)
 167                 else:
 168                     self.message_post(cr, uid, [procurement.id], body=_('No rule matching this procurement'), context=context)
 169                     self.write(cr, uid, [procurement.id], {'state': 'exception'}, context=context)
 170         return True
 171
 172     def check(self, cr, uid, ids, context=None):
 173         done = []
 174         for procurement in self.browse(cr, uid, ids, context=context):
 175             result = self._check(cr, uid, procurement, context=context)
 176             if result:
 177                 self.write(cr, uid, [procurement.id], {'state': 'done'}, context=context)
 178                 done.append(procurement.id)
 179         return done
 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                 self.write(cr, uid, [procurement.id], {'rule_id': rule_id}, context=context)
 203                 return True
 204         return False
 205
 206     def _run(self, cr, uid, procurement, context=None):
 207         '''This method implements the resolution of the given procurement
 208             :param procurement: browse record
 209         '''
 210         return True
 211
 212     def _check(self, cr, uid, procurement, context=None):
 213         '''Returns True if the given procurement is fulfilled, False otherwise
 214             :param procurement: browse record
 215             :rtype: boolean
 216         '''
 217         return False
 218
 219     #
 220     # Scheduler
 221     #
 222     def run_scheduler(self, cr, uid, use_new_cursor=False, context=None):
 223         '''
 224         Call the scheduler to check the procurement order
 225
 226         @param self: The object pointer
 227         @param cr: The current row, from the database cursor,
 228         @param uid: The current user ID for security checks
 229         @param ids: List of selected IDs
 230         @param use_new_cursor: False or the dbname
 231         @param context: A standard dictionary for contextual values
 232         @return:  Dictionary of values
 233         '''
 234         if context is None:
 235             context = {}
 236         try:
 237             if use_new_cursor:
 238                 cr = openerp.registry(use_new_cursor).db.cursor()
 239
 240             company = self.pool.get('res.users').browse(cr, uid, uid, context=context).company_id
 241             maxdate = (datetime.today() + relativedelta(days=company.schedule_range)).strftime('%Y-%m-%d %H:%M:%S')
 242
 243             # Run confirmed procurements
 244             while True:
 245                 ids = self.search(cr, uid, [('state', '=', 'confirmed'), ('date_planned', '<=', maxdate)], context=context)
 246                 if not ids:
 247                     break
 248                 self.run(cr, uid, ids, context=context)
 249                 if use_new_cursor:
 250                     cr.commit()
 251
 252             # Check if running procurements are done
 253             offset = 0
 254             while True:
 255                 ids = self.search(cr, uid, [('state', '=', 'running'), ('date_planned', '<=', maxdate)], offset=offset, context=context)
 256                 if not ids:
 257                     break
 258                 done = self.check(cr, uid, ids, context=context)
 259                 offset += len(ids) - len(done)
 260                 if use_new_cursor and len(done):
 261                     cr.commit()
 262
 263         finally:
 264             if use_new_cursor:
 265                 try:
 266                     cr.close()
 267                 except Exception:
 268                     pass
 269         return {}
 270 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: