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