Merge lp:~therp-nl/openobject-server/[e-mail]_fix_sequence_lp960201 into lp:openobject-server

[Ronald Portier (Therp)]

Fixes lp960201

[Olivier Dony (Odoo) (odo-openerp)]

Hi Ronald,

Thanks a lot for the patch and for your patience, sorry it took so long to process it.

Globally I approve your fix, but some parts of it were not suitable for merging in a stable version, and we need a fix in stable versions too. In order to save you the trouble of updating your merge prop and rebasing it on 7.0, Cedric has done it for you in this merge proposal, based on yours:
   https://code.launchpad.net/~openerp-dev/openobject-server/7.0-sequence-next-fix-csn/+merge/164363

It's now been merged in 7.0 at revision 4978 rev-id: <email address hidden> (credited to you), with an extra patch at revision 4979.
As a result I'll mark this merge proposal as merged, even if it's not technically true. The essence of the patch is indeed merged in 7.0 and will be automatically forward-ported to trunk soon.

Here is a summary of the changes we did:
- we changed the view so that only the 'number_next_actual' is visible in all views. This required fixing the code to avoid crashing during creation but makes the UI simpler for end-users. This implied a small change to the field label and tooltip too.
- we removed the new boolean flags you added (prohibit_*), both because they could not be added to a stable version and because they were technically not necessary to fix the issue. These flags were also not very useful now that only the "number_next_actual" field was visible. The user would only alter or decrease the sequence number if they really meant it. Also the "prohibit_number_next_lower" is a nice-to-have that cannot be made reliable with "standard" sequences: PostgreSQL-backed sequences are cross-transactions so you would be subject to a dirty read phenomenon.
- we changed the default value for `number_next` passed to _alter_sequence() to None, to distinguish "no value" from 0. Otherwise trying to set the value to 0 would be silently ignored. Technically the default PostgreSQL settings forbid starting sequences at 0-, but this is something than can be changed for each sequence, so someone might really want to use it.

Thanks again for this excellent contribution!

[Olivier Dony (Odoo) (odo-openerp)]

Note: revision 4978 does not contain the fix for the creation of sequence, that part was applied in revision 4979

=== modified file 'openerp/addons/base/ir/ir_sequence.py'
--- openerp/addons/base/ir/ir_sequence.py	2012-11-26 09:43:37 +0000
+++ openerp/addons/base/ir/ir_sequence.py	2012-11-29 11:40:33 +0000
@@ -22,9 +22,13 @@
 import logging
 import time
 
+<<<<<<< TREE
 from osv import osv, fields
 from tools.translate import _
 
+=======
+from openerp.tools.translate import _
+>>>>>>> MERGE-SOURCE
 import openerp
 
 _logger = logging.getLogger(__name__)
@@ -40,7 +44,7 @@
     _sql_constraints = [
         ('code_unique', 'unique(code)', '`code` must be unique.'),
     ]
-
+    
 def _code_get(self, cr, uid, context=None):
     cr.execute('select code, name from ir_sequence_type')
     return cr.fetchall()
@@ -55,6 +59,32 @@
     """
     _name = 'ir.sequence'
     _order = 'name'
+    
+    def _get_number_next_actual(
+            self, cr, user, ids, field_name, arg, context=None):
+        '''Return number from ir_sequence row when no_gap implementation,
+        and number from postgres sequence when standard implementation.'''
+        res = dict.fromkeys(ids)
+        for seq_id in ids:
+            this_obj = self.browse(cr, user, seq_id, context=context)
+            if  this_obj.implementation != 'standard':
+                res[seq_id] = this_obj.number_next
+            else:
+                # get number from postgres sequence. Cannot use
+                # currval, because that might give an error when
+                # not having used nextval before.
+                statement = (
+                    "SELECT last_value, increment_by, is_called"
+                    " FROM ir_sequence_%03d"
+                    % seq_id)
+                cr.execute(statement)
+                (last_value, increment_by, is_called) = cr.fetchone()
+                if  is_called:
+                    res[seq_id] = last_value + increment_by
+                else:
+                    res[seq_id] = last_value
+        return res
+    
     _columns = {
         'name': openerp.osv.fields.char('Name', size=64, required=True),
         'code': openerp.osv.fields.selection(_code_get, 'Code', size=64),
@@ -67,11 +97,31 @@
         'active': openerp.osv.fields.boolean('Active'),
         'prefix': openerp.osv.fields.char('Prefix', size=64, help="Prefix value of the record for the sequence"),
         'suffix': openerp.osv.fields.char('Suffix', size=64, help="Suffix value of the record for the sequence"),
-        'number_next': openerp.osv.fields.integer('Next Number', required=True, help="Next number of this sequence"),
+        'number_next': openerp.osv.fields.integer(
+            'Next Number', required=True,
+            help='Next number originally set or reset for this sequence'),
+        'number_next_actual': openerp.osv.fields.function(
+            _get_number_next_actual, type='integer', required=True,
+            string='Actual Next Number',
+            help='Next number that will actually be used.'
+            ' Will be zero for new sequence.'),
+        'prohibit_number_next_change': openerp.osv.fields.boolean(
+            'Prohibit change of Next Number',
+            help='Changing next number can wreak havoc on sequences.'
+            ' Checking this option will prevent accidental changes.'),
+        'prohibit_number_next_lower': openerp.osv.fields.boolean(
+            'Prohibit lower value for Next Number',
+            help='When manually setting Next Number to a value lower than the'
+            ' the current value, there is a big risk for duplicate key errors'
+            ' when trying to add new sequences generated to the database.'
+            ' This is especially the case when your prefix or suffix is not'
+            ' changed at the same time, or has no dynamic part (formula) that'
+            ' will also change.'),
         'number_increment': openerp.osv.fields.integer('Increment Number', required=True, help="The next number of the sequence will be incremented by this number"),
         'padding' : openerp.osv.fields.integer('Number Padding', required=True, help="OpenERP will automatically adds some '0' on the left of the 'Next Number' to get the required padding size."),
         'company_id': openerp.osv.fields.many2one('res.company', 'Company'),
     }
+    
     _defaults = {
         'implementation': 'standard',
         'active': True,
@@ -79,6 +129,8 @@
         'number_increment': 1,
         'number_next': 1,
         'padding' : 0,
+        'prohibit_number_next_change': False,
+        'prohibit_number_next_lower': False,
     }
 
     def init(self, cr):
@@ -122,7 +174,7 @@
         # object depends on it.
         cr.execute("DROP SEQUENCE IF EXISTS %s RESTRICT " % names)
 
-    def _alter_sequence(self, cr, id, number_increment, number_next):
+    def _alter_sequence(self, cr, id, number_increment, number_next=0):
         """ Alter a PostreSQL sequence.
 
         There is no access rights check.
@@ -130,10 +182,12 @@
         if number_increment == 0:
              raise osv.except_osv(_('Warning!'),_("Increment number must not be zero."))
         assert isinstance(id, (int, long))
-        cr.execute("""
-            ALTER SEQUENCE ir_sequence_%03d INCREMENT BY %%s RESTART WITH %%s
-            """ % id, (number_increment, number_next))
-
+        statement = ("ALTER SEQUENCE ir_sequence_%03d INCREMENT BY %d" %
+            (id, number_increment))
+        if  number_next:
+            statement += " RESTART WITH %d" % (number_next, )
+        cr.execute(statement)
+        
     def create(self, cr, uid, values, context=None):
         """ Create a sequence, in implementation == standard a fast gaps-allowed PostgreSQL sequence is used.
         """
@@ -147,10 +201,37 @@
         super(ir_sequence, self).unlink(cr, uid, ids, context)
         self._drop_sequence(cr, ids)
         return True
+    
+    def _pre_validate(self, cr, uid, ids, values, context=None):
+        '''If number_next changed, check wether change allowed.
+If number is lower than actual next number, check wether this is allowed.
+Raise error when invalid change requested.'''
+        if  not 'number_next' in values:
+            return 
+        nn_new = values['number_next']
+        for this_obj in self.browse(cr, uid, ids, context=context):
+            # Only validate when changed.
+            if this_obj.number_next != nn_new:
+                prohibit_change = values.get(
+                    'prohibit_number_next_change',
+                    this_obj.prohibit_number_next_change)
+                if  prohibit_change:
+                    raise openerp.osv.orm.except_orm(
+                        _('ValidationError'),
+                        _('Chance of Next Number has been prohibited'))
+                prohibit_lower = values.get(
+                    'prohibit_number_next_lower',
+                    this_obj.prohibit_number_next_lower)
+                if  prohibit_lower and (this_obj.number_next_actual > nn_new):
+                    raise openerp.osv.orm.except_orm(
+                        _('ValidationError'),
+                        _('Setting Next Number to a value lower than the'
+                        ' actual value has been prohibited'))
 
     def write(self, cr, uid, ids, values, context=None):
         if not isinstance(ids, (list, tuple)):
             ids = [ids]
+        self._pre_validate(cr, uid, ids, values, context=context)
         new_implementation = values.get('implementation')
         rows = self.read(cr, uid, ids, ['implementation', 'number_increment', 'number_next'], context)
         super(ir_sequence, self).write(cr, uid, ids, values, context)
@@ -161,7 +242,15 @@
             n = values.get('number_next', row['number_next'])
             if row['implementation'] == 'standard':
                 if new_implementation in ('standard', None):
-                    self._alter_sequence(cr, row['id'], i, n)
+                    # Implementation has NOT changed.
+                    # Only change sequence if really requested.
+                    if (('number_next' in values)
+                    and (values['number_next'] != row['number_next'])):
+                        self._alter_sequence(cr, row['id'], i, n)
+                    else:
+                        # Just in case only increment changed
+                        if  'number_increment' in values:
+                            self._alter_sequence(cr, row['id'], i)
                 else:
                     self._drop_sequence(cr, row['id'])
             else:
@@ -169,7 +258,6 @@
                     pass
                 else:
                     self._create_sequence(cr, row['id'], i, n)
-
         return True
 
     def _interpolate(self, s, d):

=== modified file 'openerp/addons/base/ir/ir_sequence_view.xml'
--- openerp/addons/base/ir/ir_sequence_view.xml	2012-10-13 12:09:24 +0000
+++ openerp/addons/base/ir/ir_sequence_view.xml	2012-11-29 11:40:33 +0000
@@ -20,7 +20,17 @@
                             <field name="suffix"/>
                             <field name="padding"/>
                             <field name="number_increment"/>
-                            <field name="number_next"/>
+                            <!-- If number_next_actual is 0, we have a brand new record -->
+                            <field
+                                name="prohibit_number_next_change"
+                                attrs="{'invisible':[('number_next_actual','=',0)]}" />
+                            <field name="prohibit_number_next_lower"
+                                attrs="{'invisible':[('number_next_actual','=',0)]}" />
+                            <field name="number_next_actual"
+                                attrs="{'invisible':[('number_next_actual','=',0)]}" /> 
+                            <field 
+                                name="number_next"
+                                attrs="{'readonly':[('prohibit_number_next_change','=',True),('number_next_actual','&gt;',0)]}" />
                             <field name="implementation"/>
                         </group>
                         <group col="3" string="Legend (for prefix, suffix)">