Merge lp:~camptocamp/openobject-addons/trunk-extra-sale-exceptions-2.0 into lp:openobject-addons/extra-trunk

[Guewen Baconnier @ Camptocamp]

Hi,

Here is my improvements on the module sale_exceptions.

I want to commit you my work before any merge, because I think it may have some impact on your clients.

In short :
 - Instead of a method, each exception has now a python code, evaluated (safe_eval) during the execution. Indeed, you need super rights (group_system) to modify the exceptions code. So it let add, modify or deactivate (active field) each sale exception rule. Each rule is applied on the order or the sale order.
 - The test_exceptions method (workflow condition) does not anymore raise an error, it returns only False when some exceptions have been found
 - The confirm button on the sale order now open a nice popup (osv_memory) with the list of exceptions to fix. The Sale Manager has the possibility to bypass the exceptions and confirm it anyway.

Now, one remark:
I guess that this module has been created for a specific need, and that it contains default rules which are not really generic ('unknown' in line.product_id.name.lower() as instance ?). I also commented out in my branch the rule excep_invalid_location which needs the (missing) dependency on the module delivery.

I propose to clean up all this base exceptions, do you agree? we should keep some good examples like No ZIP on Destination or Not Enough Virtual Stock.

Thanks
See you
Guewen

[lp:~camptocamp/openobject-addons/trunk-extra-sale-exceptions-2.0]

5627. By Guewen Baconnier @ Camptocamp on 2012-02-21

[FIX] removed necessary import

=== modified file 'sale_exceptions/__init__.py'
--- sale_exceptions/__init__.py	2011-03-07 12:19:42 +0000
+++ sale_exceptions/__init__.py	2012-02-21 21:55:24 +0000
@@ -20,5 +20,6 @@
 ##############################################################################
 
 import sale
+import wizard
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 

=== modified file 'sale_exceptions/__openerp__.py'
--- sale_exceptions/__openerp__.py	2012-02-13 09:31:57 +0000
+++ sale_exceptions/__openerp__.py	2012-02-21 21:55:24 +0000
@@ -23,11 +23,11 @@
 
 {
     'name': 'Sale Exceptions',
-    'version': '1.0',
+    'version': '2.0',
     'category': 'Generic Modules/Sale',
     'description': """
 This module allows you attach several customizable exceptions to your sale order in a way that you can filter orders by exceptions type and fix them.
-This is escpecially useful in an order importation scenario such as with the base_sale_multi_channels module, because it's likely a few orders have errors when you import them (like product not found in OpenERP, wrong line format etc...) 
+This is especially useful in an order importation scenario such as with the base_sale_multi_channels module, because it's likely a few orders have errors when you import them (like product not found in OpenERP, wrong line format etc...)
     """,
     'author': 'Akretion',
     'website': 'http://www.akretion.com',
@@ -36,6 +36,7 @@
     'update_xml': ['sale_workflow.xml',
                    'sale_view.xml',
                    'sale_exceptions_data.xml',
+                   'wizard/sale_exception_confirm_view.xml',
                    'security/ir.model.access.csv'],
     'demo_xml': [],
     'installable': True,

=== modified file 'sale_exceptions/sale.py'
--- sale_exceptions/sale.py	2012-02-13 09:33:17 +0000
+++ sale_exceptions/sale.py	2012-02-21 21:55:24 +0000
@@ -3,6 +3,7 @@
 #
 #    OpenERP, Open Source Management Solution
 #    Copyright (C) 2011 Akretion LTDA.
+#    Copyright (C) 2012 Camptocamp SA (Guewen Baconnier)
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
@@ -19,20 +20,40 @@
 #
 ##############################################################################
 
-from datetime import datetime, timedelta
-from dateutil.relativedelta import relativedelta
 import time
+import netsvc
 
 from osv import fields, osv
+from tools.safe_eval import safe_eval as eval
 from tools.translate import _
-import netsvc
 
 class sale_exception(osv.osv):
     _name = "sale.exception"
     _description = "Sale Exceptions"
     _columns = {
         'name': fields.char('Exception Name', size=64, required=True, translate=True),
-        'sale_order_ids': fields.many2many('sale.order', 'sale_order_exception_rel', 'exception_id', 'sale_order_id', 'Sale Orders'),
+        'note': fields.text('Note'),
+        'sale_order_ids': fields.many2many('sale.order', 'sale_order_exception_rel',
+                                           'exception_id', 'sale_order_id', 'Sale Orders'),
+        'model': fields.selection([('sale.order', 'Sale Order'), ('sale.order.line', 'Sale Order Line')],
+                                  string='Apply on', required=True),
+        'active': fields.boolean('Active'),
+        'code': fields.text('Python Code',
+                    help="Python code executed to check if the exception apply or not. The code must apply block = True to apply the exception."),
+    }
+
+    _defaults = {
+        'code': """# Python code. Use block = True to block the sale order.
+# You can use the following variables :
+#  - self: ORM model of the record which is checked
+#  - order or line: browse_record of the sale order or sale order line
+#  - object: same as order or line, browse_record of the sale order or sale order line
+#  - pool: ORM model pool (i.e. self.pool)
+#  - time: Python time module
+#  - cr: database cursor
+#  - uid: current user id
+#  - context: current context
+"""
     }
 
 sale_exception()
@@ -41,58 +62,110 @@
     _inherit = "sale.order"
     _columns = {
         'exceptions_ids': fields.many2many('sale.exception', 'sale_order_exception_rel', 'sale_order_id', 'exception_id', 'Exceptions'),
+        'ignore_exceptions': fields.boolean('Ignore Exceptions'),
     }
 
-    def __add_exception(self, cr, uid, exceptions_list, exception_name):
-        ir_model_data_id = self.pool.get('ir.model.data').search(cr, uid, [('name', '=', exception_name)])[0]
-        except_id = self.pool.get('ir.model.data').read(cr, uid, ir_model_data_id, ['res_id'])['res_id']
-        if except_id not in exceptions_list:
-            exceptions_list.append(except_id)
-
     def test_all_draft_orders(self, cr, uid, context=None):
         ids = self.search(cr, uid, [('state', '=', 'draft')])
-        for id in ids:
-            try:
-                self.test_exceptions(cr, uid, [id])
-            except Exception:
-                pass
-        return True
-
-    def test_exceptions(self, cr, uid, ids, *args):
+        self.test_exceptions(cr, uid, ids)
+        return True
+
+    def button_order_confirm(self, cr, uid, ids, context=None):
+        exception_ids = self.detect_exceptions(cr, uid, ids, context=context)
+        if exception_ids:
+            model_data_obj = self.pool.get('ir.model.data')
+            action = {
+                'type': 'ir.actions.act_window',
+                'view_type': 'form',
+                'view_mode': 'form',
+                'res_model': 'sale.exception.confirm',
+                'view_id': model_data_obj.get_object_reference(cr, uid, 'sale_exceptions', 'view_sale_exception_confirm')[1],
+                'target': 'new',
+            }
+            return action
+        else:
+            wf_service = netsvc.LocalService("workflow")
+            wf_service.trg_validate(uid, 'sale.order', ids[0], 'order_confirm', cr)
+        return True
+
+    def test_exceptions(self, cr, uid, ids, context=None):
+        """
+        Condition method for the workflow from draft to confirm
+        """
+        exception_ids = self.detect_exceptions(cr, uid, ids, context=context)
+        if exception_ids:
+            return False
+        return True
+
+    def detect_exceptions(self, cr, uid, ids, context=None):
+        exception_obj = self.pool.get('sale.exception')
+        order_exception_ids = exception_obj.search(cr, uid,
+            [('model', '=', 'sale.order')], context=context)
+        line_exception_ids = exception_obj.search(cr, uid,
+            [('model', '=', 'sale.order.line')], context=context)
+        order_exceptions = exception_obj.browse(cr, uid, order_exception_ids, context=context)
+        line_exceptions = exception_obj.browse(cr, uid, line_exception_ids, context=context)
+
+        exception_ids = False
         for order in self.browse(cr, uid, ids):
-            new_exceptions = []
-            self.add_custom_order_exception(cr, uid, ids, order, new_exceptions, *args)
-            self.write(cr, uid, [order.id], {'exceptions_ids': [(6, 0, new_exceptions)]})
-            cr.commit()
-        if len(new_exceptions) != 0:
-            raise osv.except_osv(_('Order has errors!'), "\n".join(ex.name for ex in self.pool.get('sale.exception').browse(cr, uid, new_exceptions)))
-        return True
-
-    def add_custom_order_exception(self, cr, uid, ids, order, exceptions, *args):
-        self.detect_invalid_destination(cr, uid, order, exceptions)
-        self.detect_no_zip(cr, uid, order, exceptions)
+            if order.ignore_exceptions:
+                continue
+            exception_ids = self._detect_exceptions(cr, uid, order,
+                order_exceptions, line_exceptions, context=context)
+
+            self.write(cr, uid, [order.id], {'exceptions_ids': [(6, 0, exception_ids)]})
+        return exception_ids
+
+    def _exception_rule_eval_context(self, cr, uid, obj_name, obj, context=None):
+        if context is None:
+            context = {}
+
+        return {obj_name: obj,
+                'self': self.pool.get(obj._name),
+                'object': obj,
+                'obj': obj,
+                'pool': self.pool,
+                'cr': cr,
+                'uid': uid,
+                'user': self.pool.get('res.users').browse(cr, uid, uid),
+                'time': time,
+                # copy context to prevent side-effects of eval
+                'context': dict(context),}
+
+    def _rule_eval(self, cr, uid, rule, obj_name, obj, context):
+        expr = rule.code
+        space = self._exception_rule_eval_context(cr, uid, obj_name, obj,
+                                                  context=context)
+        try:
+            eval(expr, space,
+                 mode='exec', nocopy=True) # nocopy allows to return 'result'
+        except Exception, e:
+            raise osv.except_osv(_('Error'), _('Error when evaluating the sale exception rule :\n %s \n(%s)') %
+                                 (rule.name, e))
+        return space.get('block', False)
+
+    def _detect_exceptions(self, cr, uid, order, order_exceptions, line_exceptions, context=None):
+        exception_ids = []
+        for rule in order_exceptions:
+            if self._rule_eval(cr, uid, rule, 'order', order, context):
+                exception_ids.append(rule.id)
+
         for order_line in order.order_line:
-            self.detect_wrong_product(cr, uid, order_line, exceptions)
-            self.detect_not_enough_virtual_stock(cr, uid, order_line, exceptions)
-        return exceptions
-
-    def detect_invalid_destination(self, cr, uid, order, exceptions):
-        no_delivery_carrier = self.pool.get('delivery.carrier').search(cr, uid, [('name', '=', 'No Delivery')])
-        if no_delivery_carrier:
-            no_delivery_carrier_grid = self.pool.get('delivery.carrier').grid_get(cr, uid, no_delivery_carrier, order.partner_shipping_id.id)
-            if no_delivery_carrier_grid:
-                self.__add_exception(cr, uid, exceptions, 'excep_invalid_location')
-
-    def detect_no_zip(self, cr, uid, order, exceptions):
-        if not order.partner_shipping_id.zip:
-            self.__add_exception(cr, uid, exceptions, 'excep_no_zip')
-
-    def detect_wrong_product(self, cr, uid, order_line, exceptions):
-        if order_line.product_id and 'unknown' in order_line.product_id.name.lower() or not order_line.product_id:
-            self.__add_exception(cr, uid, exceptions, 'excep_product')
-
-    def detect_not_enough_virtual_stock(self, cr, uid, order_line, exceptions):
-        if order_line.product_id and order_line.product_id.type == 'product' and order_line.product_id.virtual_available < order_line.product_uom_qty:
-            self.__add_exception(cr, uid, exceptions, 'excep_no_stock')
+            for rule in line_exceptions:
+                if rule.id in exception_ids:
+                    continue  # we do not matter if the exception as already been
+                    # found for an order line of this order
+                if self._rule_eval(cr, uid, rule, 'line', order_line, context):
+                    exception_ids.append(rule.id)
+
+        return exception_ids
+
+    def copy(self, cr, uid, id, default=None, context=None):
+        if default is None:
+            default = {}
+        default.update({
+            'ignore_exceptions': False,
+        })
+        return super(sale_order, self).copy(cr, uid, id, default=default, context=context)
 
 sale_order()

=== modified file 'sale_exceptions/sale_exceptions_data.xml'
--- sale_exceptions/sale_exceptions_data.xml	2011-08-22 21:10:53 +0000
+++ sale_exceptions/sale_exceptions_data.xml	2012-02-21 21:55:24 +0000
@@ -1,30 +1,49 @@
 <?xml version="1.0" encoding="utf-8"?>
 <openerp>
-    <data>
+    <data noupdate="1">
         <record id="excep_product" model="sale.exception">
-            <field name="name">Error: Product Not Found</field>
-        </record>
-
-        <record id="excep_invalid_location" model="sale.exception">
-            <field name="name">Error: Invalid Destination</field>
+            <field name="name">Product Not Found</field>
+            <field name="code">if line.product_id and 'unknown' in line.product_id.name.lower() or not line.product_id:
+    block = True</field>
+            <field name="model">sale.order.line</field>
+            <field name="note"></field>
+            <field name="active" eval="True"/>
         </record>
 
         <record id="excep_no_zip" model="sale.exception">
-            <field name="name">Error: No Destination zip</field>
+            <field name="name">No ZIP on Destination</field>
+            <field name="code">if not order.partner_shipping_id.zip:
+    block = True</field>
+            <field name="model">sale.order</field>
+            <field name="note"></field>
+            <field name="active" eval="True"/>
         </record>
 
         <record id="excep_wrong_line" model="sale.exception">
-            <field name="name">Error: Wrong Order Line Format</field>
+            <field name="name">Wrong Order Line Format</field>
+            <field name="code"></field>
+            <field name="model">sale.order.line</field>
+            <field name="note"></field>
+            <field name="active" eval="False"/>
         </record>
 
         <record id="excep_no_stock" model="sale.exception">
-            <field name="name">Error: Not enough virtual Stock</field>
+            <field name="name">Not Enough Virtual Stock</field>
+            <field name="code">if line.product_id and line.product_id.type == 'product' and line.product_id.virtual_available &lt; line.product_uom_qty:
+    block = True</field>
+            <field name="model">sale.order.line</field>
+            <field name="note"></field>
+            <field name="active" eval="True"/>
         </record>
 	
 		<record id="excep_no_component_stock" model="sale.exception">
-		    <field name="name">Error: Not enough virtual stock of components</field>
+		    <field name="name">Not enough virtual stock of components</field>
+            <field name="code"></field>
+            <field name="model">sale.order.line</field>
+            <field name="active" eval="False"/>could
+            <field name="note"></field>
 		</record>
-		
+
         <record id="no_delivery_partner" model="res.partner">
             <field name="name">No Delivery</field>
         </record>
@@ -35,11 +54,27 @@
             <field model="product.category" name="categ_id" search="[]"/>
         </record>
 		
-        <record id="no_delivery_carrier" model="delivery.carrier">
+  <!--
+        induce a dependency on delivery, is it really necessary ?
+
+        <record id="excep_invalid_location" model="sale.exception">
+            <field name="name">Invalid Destination</field>
+            <field name="code">carrier_obj = pool.get('delivery.carrier')
+no_delivery_carrier = carrier_obj.search(cr, uid, [('name', '=', 'No Delivery')])
+if no_delivery_carrier:
+    no_delivery_carrier_grid = carrier_obj.grid_get(cr, uid, no_delivery_carrier, order.partner_shipping_id.id)
+    if no_delivery_carrier_grid:
+        block=True</field>
+            <field name="model">sale.order</field>
+            <field name="note"></field>
+            <field name="active" eval="True"/>
+        </record>
+
+      <record id="no_delivery_carrier" model="delivery.carrier">
             <field name="name">No Delivery</field>
             <field name="partner_id" ref="no_delivery_partner"/>
             <field name="product_id" ref="no_delivery_product"/>
-        </record>
+        </record>-->
 
         <record forcecreate="True" id="ir_cron_test_orders" model="ir.cron">
             <field name="name">Test Draft Orders</field>

=== modified file 'sale_exceptions/sale_view.xml'
--- sale_exceptions/sale_view.xml	2011-03-07 12:19:42 +0000
+++ sale_exceptions/sale_view.xml	2012-02-21 21:55:24 +0000
@@ -1,6 +1,39 @@
 <?xml version="1.0" ?>
 <openerp>
 	<data>
+
+        <record id="view_sale_exception_tree" model="ir.ui.view">
+            <field name="name">sale.exception.tree</field>
+            <field name="model">sale.exception</field>
+            <field name="type">tree</field>
+            <field name="arch" type="xml">
+                <tree string="Sale Exception">
+                    <field name="name"/>
+                    <field name="note"/>
+                </tree>
+            </field>
+        </record>
+
+        <record id="view_sale_exception_form" model="ir.ui.view">
+            <field name="name">sale.exception.form</field>
+            <field name="model">sale.exception</field>
+            <field name="type">form</field>
+            <field name="arch" type="xml">
+                <form string="Sale Exception Setup">
+                    <field name="name" colspan="4"/>
+                    <field name="note" colspan="4"/>
+                    <newline/>
+                    <group colspan="4" col="2" groups="base.group_sale_manager">
+                        <field name="active"/>
+                        <group colspan="2" col="2" groups="base.group_system">
+                            <field name="model"/>
+                            <field name="code"/>
+                        </group>
+                    </group>
+                </form>
+            </field>
+        </record>
+
 		<record id="ir_actions_act_window_exceptions0" model="ir.actions.act_window">
 			<field eval="[(6,0,[])]" name="groups_id"/>
 			<field name="context">{}</field>
@@ -14,6 +47,7 @@
 			<field eval="0" name="multi"/>
 			<field name="type">ir.actions.act_window</field>
 			<field name="name">Exceptions</field>
+            <field name="view_id" ref="view_sale_exception_tree"/>
 		</record>
 		
         <menuitem action="ir_actions_act_window_exceptions0" id="ir_ui_menu_exceptions0"
@@ -24,12 +58,18 @@
 			<field name="inherit_id" ref="sale.view_order_form"/>
 			<field name="name">sale.order.68956.inherit</field>
 			<field name="arch" type="xml">
-				<field name="note" position="replace">
-                    <group  colspan="6" col="6">
-                        <field name="exceptions_ids" colspan="2"/>
-                        <field name="note" colspan="4"/>			
-                    </group>
-                </field>
+                <data>
+                    <field name="note" position="after">
+                        <group  colspan="6" col="6">
+                            <field name="exceptions_ids" colspan="2"/>
+                            <field name="note" colspan="4"/>
+                        </group>
+                    </field>
+                    <button name="order_confirm" position="attributes">
+                        <attribute name="name">button_order_confirm</attribute>
+                        <attribute name="type">object</attribute>
+                    </button>
+                </data>
 			</field>
 			<field name="model">sale.order</field>
 			<field name="type">form</field>

=== added directory 'sale_exceptions/wizard'
=== added file 'sale_exceptions/wizard/__init__.py'
--- sale_exceptions/wizard/__init__.py	1970-01-01 00:00:00 +0000
+++ sale_exceptions/wizard/__init__.py	2012-02-21 21:55:24 +0000
@@ -0,0 +1,1 @@
+import sale_exception_confirm

=== added file 'sale_exceptions/wizard/sale_exception_confirm.py'
--- sale_exceptions/wizard/sale_exception_confirm.py	1970-01-01 00:00:00 +0000
+++ sale_exceptions/wizard/sale_exception_confirm.py	2012-02-21 21:55:24 +0000
@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Copyright Camptocamp SA
+#    @author: Guewen Baconnier
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+import netsvc
+
+from osv import osv, fields
+
+
+class SaleExceptionConfirm(osv.osv_memory):
+
+    _name = 'sale.exception.confirm'
+
+    _columns = {
+        'sale_id': fields.many2one('sale.order', 'Sale'),
+        'exception_ids': fields.many2many('sale.exception', string='Exceptions to resolve', readonly=True),
+        'ignore': fields.boolean('Ignore Exceptions'),
+    }
+
+    def default_get(self, cr, uid, fields, context=None):
+        res = super(SaleExceptionConfirm, self).default_get(cr, uid, fields, context=context)
+        order_obj = self.pool.get('sale.order')
+        sale_id = context.get('active_id', False)
+        if sale_id:
+            sale = order_obj.browse(cr, uid, sale_id, context=context)
+            exception_ids = [e.id for e in sale.exceptions_ids]
+            res.update({'exception_ids': [(6, 0, exception_ids)]})
+
+        res.update({'sale_id': sale_id})
+        return res
+
+    def action_confirm(self, cr, uid, ids, context=None):
+        form = self.browse(cr, uid, ids[0], context=context)
+        if form.ignore:
+            self.pool.get('sale.order').write(cr, uid, form.sale_id.id,
+                    {'ignore_exceptions': True}, context=context)
+            wf_service = netsvc.LocalService("workflow")
+            wf_service.trg_validate(uid, 'sale.order', form.sale_id.id, 'order_confirm', cr)
+        return {'type': 'ir.actions.act_window_close'}
+
+SaleExceptionConfirm()

=== added file 'sale_exceptions/wizard/sale_exception_confirm_view.xml'
--- sale_exceptions/wizard/sale_exception_confirm_view.xml	1970-01-01 00:00:00 +0000
+++ sale_exceptions/wizard/sale_exception_confirm_view.xml	2012-02-21 21:55:24 +0000
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+
+        <record id="view_sale_exception_confirm" model="ir.ui.view">
+            <field name="name">Sale Exceptions</field>
+            <field name="model">sale.exception.confirm</field>
+            <field name="type">form</field>
+            <field name="arch" type="xml">
+                <form string="Sale Exceptions">
+                    <separator colspan="4" string="Exceptions on the sale order" />
+                    <field name="exception_ids" colspan="4">
+                        <form string="Sale Exception">
+                           <field name="name" colspan="4"/>
+                           <field name="note" colspan="4"/>
+                        </form>
+                        <tree string="Sale Exceptions">
+                            <field name="name"/>
+                            <field name="note"/>
+                        </tree>
+                    </field>
+                    <newline/>
+                    <field name="ignore" groups='base.group_sale_manager'/>
+                    <newline/>
+                    <separator colspan="4"/>
+                    <group col="2" colspan="4">
+                        <button name="action_confirm" string="_Ok"
+                            colspan="1" type="object" icon="gtk-ok" />
+                    </group>
+                </form>
+            </field>
+        </record>
+
+        <record id="action_sale_exception_confirm" model="ir.actions.act_window">
+            <field name="name">Sale Exceptions</field>
+            <field name="type">ir.actions.act_window</field>
+            <field name="res_model">sale.exception.confirm</field>
+            <field name="view_type">form</field>
+            <field name="view_mode">form</field>
+            <field name="view_id" ref="view_sale_exception_confirm"/>
+            <field name="target">new</field>
+        </record>
+
+    </data>
+</openerp>