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