openerp/models.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 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
  23 """
  24     Object Relational Mapping module:
  25      * Hierarchical structure
  26      * Constraints consistency and validation
  27      * Object metadata depends on its status
  28      * Optimised processing by complex query (multiple actions at once)
  29      * Default field values
  30      * Permissions optimisation
  31      * Persistant object: DB postgresql
  32      * Data conversion
  33      * Multi-level caching system
  34      * Two different inheritance mechanisms
  35      * Rich set of field types:
  36           - classical (varchar, integer, boolean, ...)
  37           - relational (one2many, many2one, many2many)
  38           - functional
  39
  40 """
  41
  42 import copy
  43 import datetime
  44 import functools
  45 import itertools
  46 import logging
  47 import operator
  48 import pickle
  49 import pytz
  50 import re
  51 import time
  52 from collections import defaultdict, MutableMapping
  53 from inspect import getmembers
  54
  55 import babel.dates
  56 import dateutil.relativedelta
  57 import psycopg2
  58 from lxml import etree
  59
  60 import openerp
  61 from . import SUPERUSER_ID
  62 from . import api
  63 from . import tools
  64 from .api import Environment
  65 from .exceptions import except_orm, AccessError, MissingError
  66 from .osv import fields
  67 from .osv.query import Query
  68 from .tools import lazy_property
  69 from .tools.config import config
  70 from .tools.misc import CountingStream, DEFAULT_SERVER_DATETIME_FORMAT, DEFAULT_SERVER_DATE_FORMAT
  71 from .tools.safe_eval import safe_eval as eval
  72 from .tools.translate import _
  73
  74 _logger = logging.getLogger(__name__)
  75 _schema = logging.getLogger(__name__ + '.schema')
  76
  77 regex_order = re.compile('^( *([a-z0-9:_]+|"[a-z0-9:_]+")( *desc| *asc)?( *, *|))+$', re.I)
  78 regex_object_name = re.compile(r'^[a-z0-9_.]+$')
  79 onchange_v7 = re.compile(r"^(\w+)\((.*)\)$")
  80
  81 AUTOINIT_RECALCULATE_STORED_FIELDS = 1000
  82
  83
  84 def check_object_name(name):
  85     """ Check if the given name is a valid openerp object name.
  86
  87         The _name attribute in osv and osv_memory object is subject to
  88         some restrictions. This function returns True or False whether
  89         the given name is allowed or not.
  90
  91         TODO: this is an approximation. The goal in this approximation
  92         is to disallow uppercase characters (in some places, we quote
  93         table/column names and in other not, which leads to this kind
  94         of errors:
  95
  96             psycopg2.ProgrammingError: relation "xxx" does not exist).
  97
  98         The same restriction should apply to both osv and osv_memory
  99         objects for consistency.
 100
 101     """
 102     if regex_object_name.match(name) is None:
 103         return False
 104     return True
 105
 106 def raise_on_invalid_object_name(name):
 107     if not check_object_name(name):
 108         msg = "The _name attribute %s is not valid." % name
 109         _logger.error(msg)
 110         raise except_orm('ValueError', msg)
 111
 112 POSTGRES_CONFDELTYPES = {
 113     'RESTRICT': 'r',
 114     'NO ACTION': 'a',
 115     'CASCADE': 'c',
 116     'SET NULL': 'n',
 117     'SET DEFAULT': 'd',
 118 }
 119
 120 def intersect(la, lb):
 121     return filter(lambda x: x in lb, la)
 122
 123 def same_name(f, g):
 124     """ Test whether functions `f` and `g` are identical or have the same name """
 125     return f == g or getattr(f, '__name__', 0) == getattr(g, '__name__', 1)
 126
 127 def fix_import_export_id_paths(fieldname):
 128     """
 129     Fixes the id fields in import and exports, and splits field paths
 130     on '/'.
 131
 132     :param str fieldname: name of the field to import/export
 133     :return: split field name
 134     :rtype: list of str
 135     """
 136     fixed_db_id = re.sub(r'([^/])\.id', r'\1/.id', fieldname)
 137     fixed_external_id = re.sub(r'([^/]):id', r'\1/id', fixed_db_id)
 138     return fixed_external_id.split('/')
 139
 140 def pg_varchar(size=0):
 141     """ Returns the VARCHAR declaration for the provided size:
 142
 143     * If no size (or an empty or negative size is provided) return an
 144       'infinite' VARCHAR
 145     * Otherwise return a VARCHAR(n)
 146
 147     :type int size: varchar size, optional
 148     :rtype: str
 149     """
 150     if size:
 151         if not isinstance(size, int):
 152             raise TypeError("VARCHAR parameter should be an int, got %s"
 153                             % type(size))
 154         if size > 0:
 155             return 'VARCHAR(%d)' % size
 156     return 'VARCHAR'
 157
 158 FIELDS_TO_PGTYPES = {
 159     fields.boolean: 'bool',
 160     fields.integer: 'int4',
 161     fields.text: 'text',
 162     fields.html: 'text',
 163     fields.date: 'date',
 164     fields.datetime: 'timestamp',
 165     fields.binary: 'bytea',
 166     fields.many2one: 'int4',
 167     fields.serialized: 'text',
 168 }
 169
 170 def get_pg_type(f, type_override=None):
 171     """
 172     :param fields._column f: field to get a Postgres type for
 173     :param type type_override: use the provided type for dispatching instead of the field's own type
 174     :returns: (postgres_identification_type, postgres_type_specification)
 175     :rtype: (str, str)
 176     """
 177     field_type = type_override or type(f)
 178
 179     if field_type in FIELDS_TO_PGTYPES:
 180         pg_type =  (FIELDS_TO_PGTYPES[field_type], FIELDS_TO_PGTYPES[field_type])
 181     elif issubclass(field_type, fields.float):
 182         if f.digits:
 183             pg_type = ('numeric', 'NUMERIC')
 184         else:
 185             pg_type = ('float8', 'DOUBLE PRECISION')
 186     elif issubclass(field_type, (fields.char, fields.reference)):
 187         pg_type = ('varchar', pg_varchar(f.size))
 188     elif issubclass(field_type, fields.selection):
 189         if (isinstance(f.selection, list) and isinstance(f.selection[0][0], int))\
 190                 or getattr(f, 'size', None) == -1:
 191             pg_type = ('int4', 'INTEGER')
 192         else:
 193             pg_type = ('varchar', pg_varchar(getattr(f, 'size', None)))
 194     elif issubclass(field_type, fields.function):
 195         if f._type == 'selection':
 196             pg_type = ('varchar', pg_varchar())
 197         else:
 198             pg_type = get_pg_type(f, getattr(fields, f._type))
 199     else:
 200         _logger.warning('%s type not supported!', field_type)
 201         pg_type = None
 202
 203     return pg_type
 204
 205
 206 class MetaModel(api.Meta):
 207     """ Metaclass for the models.
 208
 209     This class is used as the metaclass for the class :class:`BaseModel` to
 210     discover the models defined in a module (without instanciating them).
 211     If the automatic discovery is not needed, it is possible to set the model's
 212     ``_register`` attribute to False.
 213
 214     """
 215
 216     module_to_models = {}
 217
 218     def __init__(self, name, bases, attrs):
 219         if not self._register:
 220             self._register = True
 221             super(MetaModel, self).__init__(name, bases, attrs)
 222             return
 223
 224         if not hasattr(self, '_module'):
 225             # The (OpenERP) module name can be in the `openerp.addons` namespace
 226             # or not.  For instance, module `sale` can be imported as
 227             # `openerp.addons.sale` (the right way) or `sale` (for backward
 228             # compatibility).
 229             module_parts = self.__module__.split('.')
 230             if len(module_parts) > 2 and module_parts[:2] == ['openerp', 'addons']:
 231                 module_name = self.__module__.split('.')[2]
 232             else:
 233                 module_name = self.__module__.split('.')[0]
 234             self._module = module_name
 235
 236         # Remember which models to instanciate for this module.
 237         if not self._custom:
 238             self.module_to_models.setdefault(self._module, []).append(self)
 239
 240
 241 class NewId(object):
 242     """ Pseudo-ids for new records. """
 243     def __nonzero__(self):
 244         return False
 245
 246 IdType = (int, long, basestring, NewId)
 247
 248
 249 # special columns automatically created by the ORM
 250 LOG_ACCESS_COLUMNS = ['create_uid', 'create_date', 'write_uid', 'write_date']
 251 MAGIC_COLUMNS = ['id'] + LOG_ACCESS_COLUMNS
 252
 253 class BaseModel(object):
 254     """ Base class for OpenERP models.
 255
 256     OpenERP models are created by inheriting from this class' subclasses:
 257
 258     *   :class:`Model` for regular database-persisted models
 259
 260     *   :class:`TransientModel` for temporary data, stored in the database but
 261         automatically vaccuumed every so often
 262
 263     *   :class:`AbstractModel` for abstract super classes meant to be shared by
 264         multiple inheriting model
 265
 266     The system automatically instantiates every model once per database. Those
 267     instances represent the available models on each database, and depend on
 268     which modules are installed on that database. The actual class of each
 269     instance is built from the Python classes that create and inherit from the
 270     corresponding model.
 271
 272     Every model instance is a "recordset", i.e., an ordered collection of
 273     records of the model. Recordsets are returned by methods like
 274     :meth:`~.browse`, :meth:`~.search`, or field accesses. Records have no
 275     explicit representation: a record is represented as a recordset of one
 276     record.
 277
 278     To create a class that should not be instantiated, the _register class
 279     attribute may be set to False.
 280     """
 281     __metaclass__ = MetaModel
 282     _auto = True # create database backend
 283     _register = False # Set to false if the model shouldn't be automatically discovered.
 284     _name = None
 285     _columns = {}
 286     _constraints = []
 287     _custom = False
 288     _defaults = {}
 289     _rec_name = None
 290     _parent_name = 'parent_id'
 291     _parent_store = False
 292     _parent_order = False
 293     _date_name = 'date'
 294     _order = 'id'
 295     _sequence = None
 296     _description = None
 297     _needaction = False
 298     _translate = True # set to False to disable translations export for this model
 299
 300     # dict of {field:method}, with method returning the (name_get of records, {id: fold})
 301     # to include in the _read_group, if grouped on this field
 302     _group_by_full = {}
 303
 304     # Transience
 305     _transient = False # True in a TransientModel
 306
 307     # structure:
 308     #  { 'parent_model': 'm2o_field', ... }
 309     _inherits = {}
 310
 311     # Mapping from inherits'd field name to triple (m, r, f, n) where m is the
 312     # model from which it is inherits'd, r is the (local) field towards m, f
 313     # is the _column object itself, and n is the original (i.e. top-most)
 314     # parent model.
 315     # Example:
 316     #  { 'field_name': ('parent_model', 'm2o_field_to_reach_parent',
 317     #                   field_column_obj, origina_parent_model), ... }
 318     _inherit_fields = {}
 319
 320     # Mapping field name/column_info object
 321     # This is similar to _inherit_fields but:
 322     # 1. includes self fields,
 323     # 2. uses column_info instead of a triple.
 324     _all_columns = {}
 325
 326     _table = None
 327     _log_create = False
 328     _sql_constraints = []
 329
 330     # model dependencies, for models backed up by sql views:
 331     # {model_name: field_names, ...}
 332     _depends = {}
 333
 334     CONCURRENCY_CHECK_FIELD = '__last_update'
 335
 336     def log(self, cr, uid, id, message, secondary=False, context=None):
 337         return _logger.warning("log() is deprecated. Please use OpenChatter notification system instead of the res.log mechanism.")
 338
 339     def view_init(self, cr, uid, fields_list, context=None):
 340         """Override this method to do specific things when a view on the object is opened."""
 341         pass
 342
 343     def _field_create(self, cr, context=None):
 344         """ Create entries in ir_model_fields for all the model's fields.
 345
 346         If necessary, also create an entry in ir_model, and if called from the
 347         modules loading scheme (by receiving 'module' in the context), also
 348         create entries in ir_model_data (for the model and the fields).
 349
 350         - create an entry in ir_model (if there is not already one),
 351         - create an entry in ir_model_data (if there is not already one, and if
 352           'module' is in the context),
 353         - update ir_model_fields with the fields found in _columns
 354           (TODO there is some redundancy as _columns is updated from
 355           ir_model_fields in __init__).
 356
 357         """
 358         if context is None:
 359             context = {}
 360         cr.execute("SELECT id FROM ir_model WHERE model=%s", (self._name,))
 361         if not cr.rowcount:
 362             cr.execute('SELECT nextval(%s)', ('ir_model_id_seq',))
 363             model_id = cr.fetchone()[0]
 364             cr.execute("INSERT INTO ir_model (id,model, name, info,state) VALUES (%s, %s, %s, %s, %s)", (model_id, self._name, self._description, self.__doc__, 'base'))
 365         else:
 366             model_id = cr.fetchone()[0]
 367         if 'module' in context:
 368             name_id = 'model_'+self._name.replace('.', '_')
 369             cr.execute('select * from ir_model_data where name=%s and module=%s', (name_id, context['module']))
 370             if not cr.rowcount:
 371                 cr.execute("INSERT INTO ir_model_data (name,date_init,date_update,module,model,res_id) VALUES (%s, (now() at time zone 'UTC'), (now() at time zone 'UTC'), %s, %s, %s)", \
 372                     (name_id, context['module'], 'ir.model', model_id)
 373                 )
 374
 375         cr.execute("SELECT * FROM ir_model_fields WHERE model=%s", (self._name,))
 376         cols = {}
 377         for rec in cr.dictfetchall():
 378             cols[rec['name']] = rec
 379
 380         ir_model_fields_obj = self.pool.get('ir.model.fields')
 381
 382         # sparse field should be created at the end, as it depends on its serialized field already existing
 383         model_fields = sorted(self._columns.items(), key=lambda x: 1 if x[1]._type == 'sparse' else 0)
 384         for (k, f) in model_fields:
 385             vals = {
 386                 'model_id': model_id,
 387                 'model': self._name,
 388                 'name': k,
 389                 'field_description': f.string,
 390                 'ttype': f._type,
 391                 'relation': f._obj or '',
 392                 'select_level': tools.ustr(int(f.select)),
 393                 'readonly': (f.readonly and 1) or 0,
 394                 'required': (f.required and 1) or 0,
 395                 'selectable': (f.selectable and 1) or 0,
 396                 'translate': (f.translate and 1) or 0,
 397                 'relation_field': f._fields_id if isinstance(f, fields.one2many) else '',
 398                 'serialization_field_id': None,
 399             }
 400             if getattr(f, 'serialization_field', None):
 401                 # resolve link to serialization_field if specified by name
 402                 serialization_field_id = ir_model_fields_obj.search(cr, SUPERUSER_ID, [('model','=',vals['model']), ('name', '=', f.serialization_field)])
 403                 if not serialization_field_id:
 404                     raise except_orm(_('Error'), _("Serialization field `%s` not found for sparse field `%s`!") % (f.serialization_field, k))
 405                 vals['serialization_field_id'] = serialization_field_id[0]
 406
 407             # When its a custom field,it does not contain f.select
 408             if context.get('field_state', 'base') == 'manual':
 409                 if context.get('field_name', '') == k:
 410                     vals['select_level'] = context.get('select', '0')
 411                 #setting value to let the problem NOT occur next time
 412                 elif k in cols:
 413                     vals['select_level'] = cols[k]['select_level']
 414
 415             if k not in cols:
 416                 cr.execute('select nextval(%s)', ('ir_model_fields_id_seq',))
 417                 id = cr.fetchone()[0]
 418                 vals['id'] = id
 419                 cr.execute("""INSERT INTO ir_model_fields (
 420                     id, model_id, model, name, field_description, ttype,
 421                     relation,state,select_level,relation_field, translate, serialization_field_id
 422                 ) VALUES (
 423                     %s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s
 424                 )""", (
 425                     id, vals['model_id'], vals['model'], vals['name'], vals['field_description'], vals['ttype'],
 426                      vals['relation'], 'base',
 427                     vals['select_level'], vals['relation_field'], bool(vals['translate']), vals['serialization_field_id']
 428                 ))
 429                 if 'module' in context:
 430                     name1 = 'field_' + self._table + '_' + k
 431                     cr.execute("select name from ir_model_data where name=%s", (name1,))
 432                     if cr.fetchone():
 433                         name1 = name1 + "_" + str(id)
 434                     cr.execute("INSERT INTO ir_model_data (name,date_init,date_update,module,model,res_id) VALUES (%s, (now() at time zone 'UTC'), (now() at time zone 'UTC'), %s, %s, %s)", \
 435                         (name1, context['module'], 'ir.model.fields', id)
 436                     )
 437             else:
 438                 for key, val in vals.items():
 439                     if cols[k][key] != vals[key]:
 440                         cr.execute('update ir_model_fields set field_description=%s where model=%s and name=%s', (vals['field_description'], vals['model'], vals['name']))
 441                         cr.execute("""UPDATE ir_model_fields SET
 442                             model_id=%s, field_description=%s, ttype=%s, relation=%s,
 443                             select_level=%s, readonly=%s ,required=%s, selectable=%s, relation_field=%s, translate=%s, serialization_field_id=%s
 444                         WHERE
 445                             model=%s AND name=%s""", (
 446                                 vals['model_id'], vals['field_description'], vals['ttype'],
 447                                 vals['relation'],
 448                                 vals['select_level'], bool(vals['readonly']), bool(vals['required']), bool(vals['selectable']), vals['relation_field'], bool(vals['translate']), vals['serialization_field_id'], vals['model'], vals['name']
 449                             ))
 450                         break
 451         self.invalidate_cache(cr, SUPERUSER_ID)
 452
 453     @classmethod
 454     def _add_field(cls, name, field):
 455         """ Add the given `field` under the given `name` in the class """
 456         field.set_class_name(cls, name)
 457
 458         # add field in _fields (for reflection)
 459         cls._fields[name] = field
 460
 461         # add field as an attribute, unless another kind of value already exists
 462         if isinstance(getattr(cls, name, field), Field):
 463             setattr(cls, name, field)
 464         else:
 465             _logger.warning("In model %r, member %r is not a field", cls._name, name)
 466
 467         if field.store:
 468             cls._columns[name] = field.to_column()
 469         else:
 470             # remove potential column that may be overridden by field
 471             cls._columns.pop(name, None)
 472
 473     @classmethod
 474     def _add_magic_fields(cls):
 475         """ Introduce magic fields on the current class
 476
 477         * id is a "normal" field (with a specific getter)
 478         * create_uid, create_date, write_uid and write_date have become
 479           "normal" fields
 480         * $CONCURRENCY_CHECK_FIELD is a computed field with its computing
 481           method defined dynamically. Uses ``str(datetime.datetime.utcnow())``
 482           to get the same structure as the previous
 483           ``(now() at time zone 'UTC')::timestamp``::
 484
 485               # select (now() at time zone 'UTC')::timestamp;
 486                         timezone
 487               ----------------------------
 488                2013-06-18 08:30:37.292809
 489
 490               >>> str(datetime.datetime.utcnow())
 491               '2013-06-18 08:31:32.821177'
 492         """
 493         def add(name, field):
 494             """ add `field` with the given `name` if it does not exist yet """
 495             if name not in cls._columns and name not in cls._fields:
 496                 cls._add_field(name, field)
 497
 498         # cyclic import
 499         from . import fields
 500
 501         # this field 'id' must override any other column or field
 502         cls._add_field('id', fields.Id(automatic=True))
 503
 504         add('display_name', fields.Char(string='Display Name', automatic=True,
 505             compute='_compute_display_name'))
 506
 507         if cls._log_access:
 508             add('create_uid', fields.Many2one('res.users', string='Created by', automatic=True))
 509             add('create_date', fields.Datetime(string='Created on', automatic=True))
 510             add('write_uid', fields.Many2one('res.users', string='Last Updated by', automatic=True))
 511             add('write_date', fields.Datetime(string='Last Updated on', automatic=True))
 512             last_modified_name = 'compute_concurrency_field_with_access'
 513         else:
 514             last_modified_name = 'compute_concurrency_field'
 515
 516         # this field must override any other column or field
 517         cls._add_field(cls.CONCURRENCY_CHECK_FIELD, fields.Datetime(
 518             string='Last Modified on', compute=last_modified_name, automatic=True))
 519
 520     @api.one
 521     def compute_concurrency_field(self):
 522         self[self.CONCURRENCY_CHECK_FIELD] = \
 523             datetime.datetime.utcnow().strftime(DEFAULT_SERVER_DATETIME_FORMAT)
 524
 525     @api.one
 526     @api.depends('create_date', 'write_date')
 527     def compute_concurrency_field_with_access(self):
 528         self[self.CONCURRENCY_CHECK_FIELD] = \
 529             self.write_date or self.create_date or \
 530             datetime.datetime.utcnow().strftime(DEFAULT_SERVER_DATETIME_FORMAT)
 531
 532     #
 533     # Goal: try to apply inheritance at the instanciation level and
 534     #       put objects in the pool var
 535     #
 536     @classmethod
 537     def _build_model(cls, pool, cr):
 538         """ Instanciate a given model.
 539
 540         This class method instanciates the class of some model (i.e. a class
 541         deriving from osv or osv_memory). The class might be the class passed
 542         in argument or, if it inherits from another class, a class constructed
 543         by combining the two classes.
 544
 545         """
 546
 547         # IMPORTANT: the registry contains an instance for each model. The class
 548         # of each model carries inferred metadata that is shared among the
 549         # model's instances for this registry, but not among registries. Hence
 550         # we cannot use that "registry class" for combining model classes by
 551         # inheritance, since it confuses the metadata inference process.
 552
 553         # Keep links to non-inherited constraints in cls; this is useful for
 554         # instance when exporting translations
 555         cls._local_constraints = cls.__dict__.get('_constraints', [])
 556         cls._local_sql_constraints = cls.__dict__.get('_sql_constraints', [])
 557
 558         # determine inherited models
 559         parents = getattr(cls, '_inherit', [])
 560         parents = [parents] if isinstance(parents, basestring) else (parents or [])
 561
 562         # determine the model's name
 563         name = cls._name or (len(parents) == 1 and parents[0]) or cls.__name__
 564
 565         # determine the module that introduced the model
 566         original_module = pool[name]._original_module if name in parents else cls._module
 567
 568         # build the class hierarchy for the model
 569         for parent in parents:
 570             if parent not in pool:
 571                 raise TypeError('The model "%s" specifies an unexisting parent class "%s"\n'
 572                     'You may need to add a dependency on the parent class\' module.' % (name, parent))
 573             parent_model = pool[parent]
 574
 575             # do no use the class of parent_model, since that class contains
 576             # inferred metadata; use its ancestor instead
 577             parent_class = type(parent_model).__base__
 578
 579             # don't inherit custom fields
 580             columns = dict((key, val)
 581                 for key, val in parent_class._columns.iteritems()
 582                 if not val.manual
 583             )
 584             columns.update(cls._columns)
 585
 586             defaults = dict(parent_class._defaults)
 587             defaults.update(cls._defaults)
 588
 589             inherits = dict(parent_class._inherits)
 590             inherits.update(cls._inherits)
 591
 592             depends = dict(parent_class._depends)
 593             for m, fs in cls._depends.iteritems():
 594                 depends[m] = depends.get(m, []) + fs
 595
 596             old_constraints = parent_class._constraints
 597             new_constraints = cls._constraints
 598             # filter out from old_constraints the ones overridden by a
 599             # constraint with the same function name in new_constraints
 600             constraints = new_constraints + [oldc
 601                 for oldc in old_constraints
 602                 if not any(newc[2] == oldc[2] and same_name(newc[0], oldc[0])
 603                            for newc in new_constraints)
 604             ]
 605
 606             sql_constraints = cls._sql_constraints + \
 607                               parent_class._sql_constraints
 608
 609             attrs = {
 610                 '_name': name,
 611                 '_register': False,
 612                 '_columns': columns,
 613                 '_defaults': defaults,
 614                 '_inherits': inherits,
 615                 '_depends': depends,
 616                 '_constraints': constraints,
 617                 '_sql_constraints': sql_constraints,
 618             }
 619             cls = type(name, (cls, parent_class), attrs)
 620
 621         # introduce the "registry class" of the model;
 622         # duplicate some attributes so that the ORM can modify them
 623         attrs = {
 624             '_name': name,
 625             '_register': False,
 626             '_columns': dict(cls._columns),
 627             '_defaults': dict(cls._defaults),
 628             '_inherits': dict(cls._inherits),
 629             '_depends': dict(cls._depends),
 630             '_constraints': list(cls._constraints),
 631             '_sql_constraints': list(cls._sql_constraints),
 632             '_original_module': original_module,
 633         }
 634         cls = type(cls._name, (cls,), attrs)
 635
 636         # float fields are registry-dependent (digit attribute); duplicate them
 637         # to avoid issues
 638         for key, col in cls._columns.items():
 639             if col._type == 'float':
 640                 cls._columns[key] = copy.copy(col)
 641
 642         # instantiate the model, and initialize it
 643         model = object.__new__(cls)
 644         model.__init__(pool, cr)
 645         return model
 646
 647     @classmethod
 648     def _init_function_fields(cls, pool, cr):
 649         # initialize the list of non-stored function fields for this model
 650         pool._pure_function_fields[cls._name] = []
 651
 652         # process store of low-level function fields
 653         for fname, column in cls._columns.iteritems():
 654             if hasattr(column, 'digits_change'):
 655                 column.digits_change(cr)
 656             # filter out existing store about this field
 657             pool._store_function[cls._name] = [
 658                 stored
 659                 for stored in pool._store_function.get(cls._name, [])
 660                 if (stored[0], stored[1]) != (cls._name, fname)
 661             ]
 662             if not isinstance(column, fields.function):
 663                 continue
 664             if not column.store:
 665                 # register it on the pool for invalidation
 666                 pool._pure_function_fields[cls._name].append(fname)
 667                 continue
 668             # process store parameter
 669             store = column.store
 670             if store is True:
 671                 get_ids = lambda self, cr, uid, ids, c={}: ids
 672                 store = {cls._name: (get_ids, None, column.priority, None)}
 673             for model, spec in store.iteritems():
 674                 if len(spec) == 4:
 675                     (fnct, fields2, order, length) = spec
 676                 elif len(spec) == 3:
 677                     (fnct, fields2, order) = spec
 678                     length = None
 679                 else:
 680                     raise except_orm('Error',
 681                         ('Invalid function definition %s in object %s !\nYou must use the definition: store={object:(fnct, fields, priority, time length)}.' % (fname, cls._name)))
 682                 pool._store_function.setdefault(model, [])
 683                 t = (cls._name, fname, fnct, tuple(fields2) if fields2 else None, order, length)
 684                 if t not in pool._store_function[model]:
 685                     pool._store_function[model].append(t)
 686                     pool._store_function[model].sort(key=lambda x: x[4])
 687
 688     @classmethod
 689     def _init_manual_fields(cls, pool, cr):
 690         # Check whether the query is already done
 691         if pool.fields_by_model is not None:
 692             manual_fields = pool.fields_by_model.get(cls._name, [])
 693         else:
 694             cr.execute('SELECT * FROM ir_model_fields WHERE model=%s AND state=%s', (cls._name, 'manual'))
 695             manual_fields = cr.dictfetchall()
 696
 697         for field in manual_fields:
 698             if field['name'] in cls._columns:
 699                 continue
 700             attrs = {
 701                 'string': field['field_description'],
 702                 'required': bool(field['required']),
 703                 'readonly': bool(field['readonly']),
 704                 'domain': eval(field['domain']) if field['domain'] else None,
 705                 'size': field['size'] or None,
 706                 'ondelete': field['on_delete'],
 707                 'translate': (field['translate']),
 708                 'manual': True,
 709                 '_prefetch': False,
 710                 #'select': int(field['select_level'])
 711             }
 712             if field['serialization_field_id']:
 713                 cr.execute('SELECT name FROM ir_model_fields WHERE id=%s', (field['serialization_field_id'],))
 714                 attrs.update({'serialization_field': cr.fetchone()[0], 'type': field['ttype']})
 715                 if field['ttype'] in ['many2one', 'one2many', 'many2many']:
 716                     attrs.update({'relation': field['relation']})
 717                 cls._columns[field['name']] = fields.sparse(**attrs)
 718             elif field['ttype'] == 'selection':
 719                 cls._columns[field['name']] = fields.selection(eval(field['selection']), **attrs)
 720             elif field['ttype'] == 'reference':
 721                 cls._columns[field['name']] = fields.reference(selection=eval(field['selection']), **attrs)
 722             elif field['ttype'] == 'many2one':
 723                 cls._columns[field['name']] = fields.many2one(field['relation'], **attrs)
 724             elif field['ttype'] == 'one2many':
 725                 cls._columns[field['name']] = fields.one2many(field['relation'], field['relation_field'], **attrs)
 726             elif field['ttype'] == 'many2many':
 727                 _rel1 = field['relation'].replace('.', '_')
 728                 _rel2 = field['model'].replace('.', '_')
 729                 _rel_name = 'x_%s_%s_%s_rel' % (_rel1, _rel2, field['name'])
 730                 cls._columns[field['name']] = fields.many2many(field['relation'], _rel_name, 'id1', 'id2', **attrs)
 731             else:
 732                 cls._columns[field['name']] = getattr(fields, field['ttype'])(**attrs)
 733
 734     @classmethod
 735     def _init_constraints_onchanges(cls):
 736         # store sql constraint error messages
 737         for (key, _, msg) in cls._sql_constraints:
 738             cls.pool._sql_error[cls._table + '_' + key] = msg
 739
 740         # collect constraint and onchange methods
 741         cls._constraint_methods = []
 742         cls._onchange_methods = defaultdict(list)
 743         for attr, func in getmembers(cls, callable):
 744             if hasattr(func, '_constrains'):
 745                 if not all(name in cls._fields for name in func._constrains):
 746                     _logger.warning("@constrains%r parameters must be field names", func._constrains)
 747                 cls._constraint_methods.append(func)
 748             if hasattr(func, '_onchange'):
 749                 if not all(name in cls._fields for name in func._onchange):
 750                     _logger.warning("@onchange%r parameters must be field names", func._onchange)
 751                 for name in func._onchange:
 752                     cls._onchange_methods[name].append(func)
 753
 754     def __new__(cls):
 755         # In the past, this method was registering the model class in the server.
 756         # This job is now done entirely by the metaclass MetaModel.
 757         #
 758         # Do not create an instance here.  Model instances are created by method
 759         # _build_model().
 760         return None
 761
 762     def __init__(self, pool, cr):
 763         """ Initialize a model and make it part of the given registry.
 764
 765         - copy the stored fields' functions in the registry,
 766         - retrieve custom fields and add them in the model,
 767         - ensure there is a many2one for each _inherits'd parent,
 768         - update the children's _columns,
 769         - give a chance to each field to initialize itself.
 770
 771         """
 772         cls = type(self)
 773
 774         # link the class to the registry, and update the registry
 775         cls.pool = pool
 776         cls._model = self              # backward compatibility
 777         pool.add(cls._name, self)
 778
 779         # determine description, table, sequence and log_access
 780         if not cls._description:
 781             cls._description = cls._name
 782         if not cls._table:
 783             cls._table = cls._name.replace('.', '_')
 784         if not cls._sequence:
 785             cls._sequence = cls._table + '_id_seq'
 786         if not hasattr(cls, '_log_access'):
 787             # If _log_access is not specified, it is the same value as _auto.
 788             cls._log_access = cls._auto
 789
 790         # Transience
 791         if cls.is_transient():
 792             cls._transient_check_count = 0
 793             cls._transient_max_count = config.get('osv_memory_count_limit')
 794             cls._transient_max_hours = config.get('osv_memory_age_limit')
 795             assert cls._log_access, \
 796                 "TransientModels must have log_access turned on, " \
 797                 "in order to implement their access rights policy"
 798
 799         # retrieve new-style fields and duplicate them (to avoid clashes with
 800         # inheritance between different models)
 801         cls._fields = {}
 802         for attr, field in getmembers(cls, Field.__instancecheck__):
 803             if not field._origin:
 804                 cls._add_field(attr, field.copy())
 805
 806         # introduce magic fields
 807         cls._add_magic_fields()
 808
 809         # register stuff about low-level function fields and custom fields
 810         cls._init_function_fields(pool, cr)
 811         cls._init_manual_fields(pool, cr)
 812
 813         # process _inherits
 814         cls._inherits_check()
 815         cls._inherits_reload()
 816
 817         # register constraints and onchange methods
 818         cls._init_constraints_onchanges()
 819
 820         # check defaults
 821         for k in cls._defaults:
 822             assert k in cls._fields, \
 823                 "Model %s has a default for nonexiting field %s" % (cls._name, k)
 824
 825         # restart columns
 826         for column in cls._columns.itervalues():
 827             column.restart()
 828
 829         # validate rec_name
 830         if cls._rec_name:
 831             assert cls._rec_name in cls._fields, \
 832                 "Invalid rec_name %s for model %s" % (cls._rec_name, cls._name)
 833         elif 'name' in cls._fields:
 834             cls._rec_name = 'name'
 835
 836         # prepare ormcache, which must be shared by all instances of the model
 837         cls._ormcache = {}
 838
 839     def __export_xml_id(self):
 840         """ Return a valid xml_id for the record `self`. """
 841         ir_model_data = self.sudo().env['ir.model.data']
 842         data = ir_model_data.search([('model', '=', self._name), ('res_id', '=', self.id)])
 843         if data:
 844             if data.module:
 845                 return '%s.%s' % (data.module, data.name)
 846             else:
 847                 return data.name
 848         else:
 849             postfix = 0
 850             name = '%s_%s' % (self._table, self.id)
 851             while ir_model_data.search([('module', '=', '__export__'), ('name', '=', name)]):
 852                 postfix += 1
 853                 name = '%s_%s_%s' % (self._table, self.id, postfix)
 854             ir_model_data.create({
 855                 'model': self._name,
 856                 'res_id': self.id,
 857                 'module': '__export__',
 858                 'name': name,
 859             })
 860             return '__export__.' + name
 861
 862     @api.multi
 863     def __export_rows(self, fields):
 864         """ Export fields of the records in `self`.
 865
 866             :param fields: list of lists of fields to traverse
 867             :return: list of lists of corresponding values
 868         """
 869         lines = []
 870         for record in self:
 871             # main line of record, initially empty
 872             current = [''] * len(fields)
 873             lines.append(current)
 874
 875             # list of primary fields followed by secondary field(s)
 876             primary_done = []
 877
 878             # process column by column
 879             for i, path in enumerate(fields):
 880                 if not path:
 881                     continue
 882
 883                 name = path[0]
 884                 if name in primary_done:
 885                     continue
 886
 887                 if name == '.id':
 888                     current[i] = str(record.id)
 889                 elif name == 'id':
 890                     current[i] = record.__export_xml_id()
 891                 else:
 892                     field = record._fields[name]
 893                     value = record[name]
 894
 895                     # this part could be simpler, but it has to be done this way
 896                     # in order to reproduce the former behavior
 897                     if not isinstance(value, BaseModel):
 898                         current[i] = field.convert_to_export(value, self.env)
 899                     else:
 900                         primary_done.append(name)
 901
 902                         # This is a special case, its strange behavior is intended!
 903                         if field.type == 'many2many' and len(path) > 1 and path[1] == 'id':
 904                             xml_ids = [r.__export_xml_id() for r in value]
 905                             current[i] = ','.join(xml_ids) or False
 906                             continue
 907
 908                         # recursively export the fields that follow name
 909                         fields2 = [(p[1:] if p and p[0] == name else []) for p in fields]
 910                         lines2 = value.__export_rows(fields2)
 911                         if lines2:
 912                             # merge first line with record's main line
 913                             for j, val in enumerate(lines2[0]):
 914                                 if val:
 915                                     current[j] = val
 916                             # check value of current field
 917                             if not current[i]:
 918                                 # assign xml_ids, and forget about remaining lines
 919                                 xml_ids = [item[1] for item in value.name_get()]
 920                                 current[i] = ','.join(xml_ids)
 921                             else:
 922                                 # append the other lines at the end
 923                                 lines += lines2[1:]
 924                         else:
 925                             current[i] = False
 926
 927         return lines
 928
 929     @api.multi
 930     def export_data(self, fields_to_export, raw_data=False):
 931         """ Export fields for selected objects
 932
 933             :param fields_to_export: list of fields
 934             :param raw_data: True to return value in native Python type
 935             :rtype: dictionary with a *datas* matrix
 936
 937             This method is used when exporting data via client menu
 938         """
 939         fields_to_export = map(fix_import_export_id_paths, fields_to_export)
 940         if raw_data:
 941             self = self.with_context(export_raw_data=True)
 942         return {'datas': self.__export_rows(fields_to_export)}
 943
 944     def import_data(self, cr, uid, fields, datas, mode='init', current_module='', noupdate=False, context=None, filename=None):
 945         """
 946         .. deprecated:: 7.0
 947             Use :meth:`~load` instead
 948
 949         Import given data in given module
 950
 951         This method is used when importing data via client menu.
 952
 953         Example of fields to import for a sale.order::
 954
 955             .id,                         (=database_id)
 956             partner_id,                  (=name_search)
 957             order_line/.id,              (=database_id)
 958             order_line/name,
 959             order_line/product_id/id,    (=xml id)
 960             order_line/price_unit,
 961             order_line/product_uom_qty,
 962             order_line/product_uom/id    (=xml_id)
 963
 964         This method returns a 4-tuple with the following structure::
 965
 966             (return_code, errored_resource, error_message, unused)
 967
 968         * The first item is a return code, it is ``-1`` in case of
 969           import error, or the last imported row number in case of success
 970         * The second item contains the record data dict that failed to import
 971           in case of error, otherwise it's 0
 972         * The third item contains an error message string in case of error,
 973           otherwise it's 0
 974         * The last item is currently unused, with no specific semantics
 975
 976         :param fields: list of fields to import
 977         :param datas: data to import
 978         :param mode: 'init' or 'update' for record creation
 979         :param current_module: module name
 980         :param noupdate: flag for record creation
 981         :param filename: optional file to store partial import state for recovery
 982         :returns: 4-tuple in the form (return_code, errored_resource, error_message, unused)
 983         :rtype: (int, dict or 0, str or 0, str or 0)
 984         """
 985         context = dict(context) if context is not None else {}
 986         context['_import_current_module'] = current_module
 987
 988         fields = map(fix_import_export_id_paths, fields)
 989         ir_model_data_obj = self.pool.get('ir.model.data')
 990
 991         def log(m):
 992             if m['type'] == 'error':
 993                 raise Exception(m['message'])
 994
 995         if config.get('import_partial') and filename:
 996             with open(config.get('import_partial'), 'rb') as partial_import_file:
 997                 data = pickle.load(partial_import_file)
 998                 position = data.get(filename, 0)
 999
1000         position = 0
1001         try:
1002             for res_id, xml_id, res, info in self._convert_records(cr, uid,
1003                             self._extract_records(cr, uid, fields, datas,
1004                                                   context=context, log=log),
1005                             context=context, log=log):
1006                 ir_model_data_obj._update(cr, uid, self._name,
1007                      current_module, res, mode=mode, xml_id=xml_id,
1008                      noupdate=noupdate, res_id=res_id, context=context)
1009                 position = info.get('rows', {}).get('to', 0) + 1
1010                 if config.get('import_partial') and filename and (not (position%100)):
1011                     with open(config.get('import_partial'), 'rb') as partial_import:
1012                         data = pickle.load(partial_import)
1013                     data[filename] = position
1014                     with open(config.get('import_partial'), 'wb') as partial_import:
1015                         pickle.dump(data, partial_import)
1016                     if context.get('defer_parent_store_computation'):
1017                         self._parent_store_compute(cr)
1018                     cr.commit()
1019         except Exception, e:
1020             cr.rollback()
1021             return -1, {}, 'Line %d : %s' % (position + 1, tools.ustr(e)), ''
1022
1023         if context.get('defer_parent_store_computation'):
1024             self._parent_store_compute(cr)
1025         return position, 0, 0, 0
1026
1027     def load(self, cr, uid, fields, data, context=None):
1028         """
1029         Attempts to load the data matrix, and returns a list of ids (or
1030         ``False`` if there was an error and no id could be generated) and a
1031         list of messages.
1032
1033         The ids are those of the records created and saved (in database), in
1034         the same order they were extracted from the file. They can be passed
1035         directly to :meth:`~read`
1036
1037         :param fields: list of fields to import, at the same index as the corresponding data
1038         :type fields: list(str)
1039         :param data: row-major matrix of data to import
1040         :type data: list(list(str))
1041         :param dict context:
1042         :returns: {ids: list(int)|False, messages: [Message]}
1043         """
1044         cr.execute('SAVEPOINT model_load')
1045         messages = []
1046
1047         fields = map(fix_import_export_id_paths, fields)
1048         ModelData = self.pool['ir.model.data'].clear_caches()
1049
1050         fg = self.fields_get(cr, uid, context=context)
1051
1052         mode = 'init'
1053         current_module = ''
1054         noupdate = False
1055
1056         ids = []
1057         for id, xid, record, info in self._convert_records(cr, uid,
1058                 self._extract_records(cr, uid, fields, data,
1059                                       context=context, log=messages.append),
1060                 context=context, log=messages.append):
1061             try:
1062                 cr.execute('SAVEPOINT model_load_save')
1063             except psycopg2.InternalError, e:
1064                 # broken transaction, exit and hope the source error was
1065                 # already logged
1066                 if not any(message['type'] == 'error' for message in messages):
1067                     messages.append(dict(info, type='error',message=
1068                         u"Unknown database error: '%s'" % e))
1069                 break
1070             try:
1071                 ids.append(ModelData._update(cr, uid, self._name,
1072                      current_module, record, mode=mode, xml_id=xid,
1073                      noupdate=noupdate, res_id=id, context=context))
1074                 cr.execute('RELEASE SAVEPOINT model_load_save')
1075             except psycopg2.Warning, e:
1076                 messages.append(dict(info, type='warning', message=str(e)))
1077                 cr.execute('ROLLBACK TO SAVEPOINT model_load_save')
1078             except psycopg2.Error, e:
1079                 messages.append(dict(
1080                     info, type='error',
1081                     **PGERROR_TO_OE[e.pgcode](self, fg, info, e)))
1082                 # Failed to write, log to messages, rollback savepoint (to
1083                 # avoid broken transaction) and keep going
1084                 cr.execute('ROLLBACK TO SAVEPOINT model_load_save')
1085             except Exception, e:
1086                 message = (_('Unknown error during import:') +
1087                            ' %s: %s' % (type(e), unicode(e)))
1088                 moreinfo = _('Resolve other errors first')
1089                 messages.append(dict(info, type='error',
1090                                      message=message,
1091                                      moreinfo=moreinfo))
1092                 # Failed for some reason, perhaps due to invalid data supplied,
1093                 # rollback savepoint and keep going
1094                 cr.execute('ROLLBACK TO SAVEPOINT model_load_save')
1095         if any(message['type'] == 'error' for message in messages):
1096             cr.execute('ROLLBACK TO SAVEPOINT model_load')
1097             ids = False
1098         return {'ids': ids, 'messages': messages}
1099
1100     def _extract_records(self, cr, uid, fields_, data,
1101                          context=None, log=lambda a: None):
1102         """ Generates record dicts from the data sequence.
1103
1104         The result is a generator of dicts mapping field names to raw
1105         (unconverted, unvalidated) values.
1106
1107         For relational fields, if sub-fields were provided the value will be
1108         a list of sub-records
1109
1110         The following sub-fields may be set on the record (by key):
1111         * None is the name_get for the record (to use with name_create/name_search)
1112         * "id" is the External ID for the record
1113         * ".id" is the Database ID for the record
1114         """
1115         columns = dict((k, v.column) for k, v in self._all_columns.iteritems())
1116         # Fake columns to avoid special cases in extractor
1117         columns[None] = fields.char('rec_name')
1118         columns['id'] = fields.char('External ID')
1119         columns['.id'] = fields.integer('Database ID')
1120
1121         # m2o fields can't be on multiple lines so exclude them from the
1122         # is_relational field rows filter, but special-case it later on to
1123         # be handled with relational fields (as it can have subfields)
1124         is_relational = lambda field: columns[field]._type in ('one2many', 'many2many', 'many2one')
1125         get_o2m_values = itemgetter_tuple(
1126             [index for index, field in enumerate(fields_)
1127                   if columns[field[0]]._type == 'one2many'])
1128         get_nono2m_values = itemgetter_tuple(
1129             [index for index, field in enumerate(fields_)
1130                   if columns[field[0]]._type != 'one2many'])
1131         # Checks if the provided row has any non-empty non-relational field
1132         def only_o2m_values(row, f=get_nono2m_values, g=get_o2m_values):
1133             return any(g(row)) and not any(f(row))
1134
1135         index = 0
1136         while True:
1137             if index >= len(data): return
1138
1139             row = data[index]
1140             # copy non-relational fields to record dict
1141             record = dict((field[0], value)
1142                 for field, value in itertools.izip(fields_, row)
1143                 if not is_relational(field[0]))
1144
1145             # Get all following rows which have relational values attached to
1146             # the current record (no non-relational values)
1147             record_span = itertools.takewhile(
1148                 only_o2m_values, itertools.islice(data, index + 1, None))
1149             # stitch record row back on for relational fields
1150             record_span = list(itertools.chain([row], record_span))
1151             for relfield in set(
1152                     field[0] for field in fields_
1153                              if is_relational(field[0])):
1154                 column = columns[relfield]
1155                 # FIXME: how to not use _obj without relying on fields_get?
1156                 Model = self.pool[column._obj]
1157
1158                 # get only cells for this sub-field, should be strictly
1159                 # non-empty, field path [None] is for name_get column
1160                 indices, subfields = zip(*((index, field[1:] or [None])
1161                                            for index, field in enumerate(fields_)
1162                                            if field[0] == relfield))
1163
1164                 # return all rows which have at least one value for the
1165                 # subfields of relfield
1166                 relfield_data = filter(any, map(itemgetter_tuple(indices), record_span))
1167                 record[relfield] = [subrecord
1168                     for subrecord, _subinfo in Model._extract_records(
1169                         cr, uid, subfields, relfield_data,
1170                         context=context, log=log)]
1171
1172             yield record, {'rows': {
1173                 'from': index,
1174                 'to': index + len(record_span) - 1
1175             }}
1176             index += len(record_span)
1177
1178     def _convert_records(self, cr, uid, records,
1179                          context=None, log=lambda a: None):
1180         """ Converts records from the source iterable (recursive dicts of
1181         strings) into forms which can be written to the database (via
1182         self.create or (ir.model.data)._update)
1183
1184         :returns: a list of triplets of (id, xid, record)
1185         :rtype: list((int|None, str|None, dict))
1186         """
1187         if context is None: context = {}
1188         Converter = self.pool['ir.fields.converter']
1189         columns = dict((k, v.column) for k, v in self._all_columns.iteritems())
1190         Translation = self.pool['ir.translation']
1191         field_names = dict(
1192             (f, (Translation._get_source(cr, uid, self._name + ',' + f, 'field',
1193                                          context.get('lang'))
1194                  or column.string))
1195             for f, column in columns.iteritems())
1196
1197         convert = Converter.for_model(cr, uid, self, context=context)
1198
1199         def _log(base, field, exception):
1200             type = 'warning' if isinstance(exception, Warning) else 'error'
1201             # logs the logical (not human-readable) field name for automated
1202             # processing of response, but injects human readable in message
1203             record = dict(base, type=type, field=field,
1204                           message=unicode(exception.args[0]) % base)
1205             if len(exception.args) > 1 and exception.args[1]:
1206                 record.update(exception.args[1])
1207             log(record)
1208
1209         stream = CountingStream(records)
1210         for record, extras in stream:
1211             dbid = False
1212             xid = False
1213             # name_get/name_create
1214             if None in record: pass
1215             # xid
1216             if 'id' in record:
1217                 xid = record['id']
1218             # dbid
1219             if '.id' in record:
1220                 try:
1221                     dbid = int(record['.id'])
1222                 except ValueError:
1223                     # in case of overridden id column
1224                     dbid = record['.id']
1225                 if not self.search(cr, uid, [('id', '=', dbid)], context=context):
1226                     log(dict(extras,
1227                         type='error',
1228                         record=stream.index,
1229                         field='.id',
1230                         message=_(u"Unknown database identifier '%s'") % dbid))
1231                     dbid = False
1232
1233             converted = convert(record, lambda field, err:\
1234                 _log(dict(extras, record=stream.index, field=field_names[field]), field, err))
1235
1236             yield dbid, xid, converted, dict(extras, record=stream.index)
1237
1238     @api.multi
1239     def _validate_fields(self, field_names):
1240         field_names = set(field_names)
1241
1242         # old-style constraint methods
1243         trans = self.env['ir.translation']
1244         cr, uid, context = self.env.args
1245         ids = self.ids
1246         errors = []
1247         for fun, msg, names in self._constraints:
1248             try:
1249                 # validation must be context-independent; call `fun` without context
1250                 valid = not (set(names) & field_names) or fun(self._model, cr, uid, ids)
1251                 extra_error = None
1252             except Exception, e:
1253                 _logger.debug('Exception while validating constraint', exc_info=True)
1254                 valid = False
1255                 extra_error = tools.ustr(e)
1256             if not valid:
1257                 if callable(msg):
1258                     res_msg = msg(self._model, cr, uid, ids, context=context)
1259                     if isinstance(res_msg, tuple):
1260                         template, params = res_msg
1261                         res_msg = template % params
1262                 else:
1263                     res_msg = trans._get_source(self._name, 'constraint', self.env.lang, msg)
1264                 if extra_error:
1265                     res_msg += "\n\n%s\n%s" % (_('Error details:'), extra_error)
1266                 errors.append(
1267                     _("Field(s) `%s` failed against a constraint: %s") %
1268                         (', '.join(names), res_msg)
1269                 )
1270         if errors:
1271             raise except_orm('ValidateError', '\n'.join(errors))
1272
1273         # new-style constraint methods
1274         for check in self._constraint_methods:
1275             if set(check._constrains) & field_names:
1276                 check(self)
1277
1278     def default_get(self, cr, uid, fields_list, context=None):
1279         """ Return default values for the fields in `fields_list`. Default
1280             values are determined by the context, user defaults, and the model
1281             itself.
1282
1283             :param fields_list: a list of field names
1284             :return: a dictionary mapping each field name to its corresponding
1285                 default value; the keys of the dictionary are the fields in
1286                 `fields_list` that have a default value different from ``False``.
1287
1288             This method should not be overridden. In order to change the
1289             mechanism for determining default values, you should override method
1290             :meth:`add_default_value` instead.
1291         """
1292         # trigger view init hook
1293         self.view_init(cr, uid, fields_list, context)
1294
1295         # use a new record to determine default values
1296         record = self.new(cr, uid, {}, context=context)
1297         for name in fields_list:
1298             if name in self._fields:
1299                 record[name]            # force evaluation of defaults
1300
1301         # retrieve defaults from record's cache
1302         return self._convert_to_write(record._cache)
1303
1304     def add_default_value(self, field):
1305         """ Set the default value of `field` to the new record `self`.
1306             The value must be assigned to `self`.
1307         """
1308         assert not self.id, "Expected new record: %s" % self
1309         cr, uid, context = self.env.args
1310         name = field.name
1311
1312         # 1. look up context
1313         key = 'default_' + name
1314         if key in context:
1315             self[name] = context[key]
1316             return
1317
1318         # 2. look up ir_values
1319         #    Note: performance is good, because get_defaults_dict is cached!
1320         ir_values_dict = self.env['ir.values'].get_defaults_dict(self._name)
1321         if name in ir_values_dict:
1322             self[name] = ir_values_dict[name]
1323             return
1324
1325         # 3. look up property fields
1326         #    TODO: get rid of this one
1327         column = self._columns.get(name)
1328         if isinstance(column, fields.property):
1329             self[name] = self.env['ir.property'].get(name, self._name)
1330             return
1331
1332         # 4. look up _defaults
1333         if name in self._defaults:
1334             value = self._defaults[name]
1335             if callable(value):
1336                 value = value(self._model, cr, uid, context)
1337             self[name] = value
1338             return
1339
1340         # 5. delegate to field
1341         field.determine_default(self)
1342
1343     def fields_get_keys(self, cr, user, context=None):
1344         res = self._columns.keys()
1345         # TODO I believe this loop can be replace by
1346         # res.extend(self._inherit_fields.key())
1347         for parent in self._inherits:
1348             res.extend(self.pool[parent].fields_get_keys(cr, user, context))
1349         return res
1350
1351     def _rec_name_fallback(self, cr, uid, context=None):
1352         rec_name = self._rec_name
1353         if rec_name not in self._columns:
1354             rec_name = self._columns.keys()[0] if len(self._columns.keys()) > 0 else "id"
1355         return rec_name
1356
1357     #
1358     # Overload this method if you need a window title which depends on the context
1359     #
1360     def view_header_get(self, cr, user, view_id=None, view_type='form', context=None):
1361         return False
1362
1363     def user_has_groups(self, cr, uid, groups, context=None):
1364         """Return true if the user is at least member of one of the groups
1365            in groups_str. Typically used to resolve `groups` attribute
1366            in view and model definitions.
1367
1368            :param str groups: comma-separated list of fully-qualified group
1369                               external IDs, e.g.: ``base.group_user,base.group_system``
1370            :return: True if the current user is a member of one of the
1371                     given groups
1372         """
1373         return any(self.pool['res.users'].has_group(cr, uid, group_ext_id)
1374                    for group_ext_id in groups.split(','))
1375
1376     def _get_default_form_view(self, cr, user, context=None):
1377         """ Generates a default single-line form view using all fields
1378         of the current model except the m2m and o2m ones.
1379
1380         :param cr: database cursor
1381         :param int user: user id
1382         :param dict context: connection context
1383         :returns: a form view as an lxml document
1384         :rtype: etree._Element
1385         """
1386         view = etree.Element('form', string=self._description)
1387         group = etree.SubElement(view, 'group', col="4")
1388         for fname, field in self._fields.iteritems():
1389             if field.automatic or field.type in ('one2many', 'many2many'):
1390                 continue
1391
1392             etree.SubElement(group, 'field', name=fname)
1393             if field.type == 'text':
1394                 etree.SubElement(group, 'newline')
1395         return view
1396
1397     def _get_default_search_view(self, cr, user, context=None):
1398         """ Generates a single-field search view, based on _rec_name.
1399
1400         :param cr: database cursor
1401         :param int user: user id
1402         :param dict context: connection context
1403         :returns: a tree view as an lxml document
1404         :rtype: etree._Element
1405         """
1406         view = etree.Element('search', string=self._description)
1407         etree.SubElement(view, 'field', name=self._rec_name_fallback(cr, user, context))
1408         return view
1409
1410     def _get_default_tree_view(self, cr, user, context=None):
1411         """ Generates a single-field tree view, based on _rec_name.
1412
1413         :param cr: database cursor
1414         :param int user: user id
1415         :param dict context: connection context
1416         :returns: a tree view as an lxml document
1417         :rtype: etree._Element
1418         """
1419         view = etree.Element('tree', string=self._description)
1420         etree.SubElement(view, 'field', name=self._rec_name_fallback(cr, user, context))
1421         return view
1422
1423     def _get_default_calendar_view(self, cr, user, context=None):
1424         """ Generates a default calendar view by trying to infer
1425         calendar fields from a number of pre-set attribute names
1426
1427         :param cr: database cursor
1428         :param int user: user id
1429         :param dict context: connection context
1430         :returns: a calendar view
1431         :rtype: etree._Element
1432         """
1433         def set_first_of(seq, in_, to):
1434             """Sets the first value of `seq` also found in `in_` to
1435             the `to` attribute of the view being closed over.
1436
1437             Returns whether it's found a suitable value (and set it on
1438             the attribute) or not
1439             """
1440             for item in seq:
1441                 if item in in_:
1442                     view.set(to, item)
1443                     return True
1444             return False
1445
1446         view = etree.Element('calendar', string=self._description)
1447         etree.SubElement(view, 'field', name=self._rec_name_fallback(cr, user, context))
1448
1449         if self._date_name not in self._columns:
1450             date_found = False
1451             for dt in ['date', 'date_start', 'x_date', 'x_date_start']:
1452                 if dt in self._columns:
1453                     self._date_name = dt
1454                     date_found = True
1455                     break
1456
1457             if not date_found:
1458                 raise except_orm(_('Invalid Object Architecture!'), _("Insufficient fields for Calendar View!"))
1459         view.set('date_start', self._date_name)
1460
1461         set_first_of(["user_id", "partner_id", "x_user_id", "x_partner_id"],
1462                      self._columns, 'color')
1463
1464         if not set_first_of(["date_stop", "date_end", "x_date_stop", "x_date_end"],
1465                             self._columns, 'date_stop'):
1466             if not set_first_of(["date_delay", "planned_hours", "x_date_delay", "x_planned_hours"],
1467                                 self._columns, 'date_delay'):
1468                 raise except_orm(
1469                     _('Invalid Object Architecture!'),
1470                     _("Insufficient fields to generate a Calendar View for %s, missing a date_stop or a date_delay" % self._name))
1471
1472         return view
1473
1474     def fields_view_get(self, cr, uid, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
1475         """
1476         Get the detailed composition of the requested view like fields, model, view architecture
1477
1478         :param view_id: id of the view or None
1479         :param view_type: type of the view to return if view_id is None ('form', tree', ...)
1480         :param toolbar: true to include contextual actions
1481         :param submenu: deprecated
1482         :return: dictionary describing the composition of the requested view (including inherited views and extensions)
1483         :raise AttributeError:
1484                             * if the inherited view has unknown position to work with other than 'before', 'after', 'inside', 'replace'
1485                             * if some tag other than 'position' is found in parent view
1486         :raise Invalid ArchitectureError: if there is view type other than form, tree, calendar, search etc defined on the structure
1487         """
1488         if context is None:
1489             context = {}
1490         View = self.pool['ir.ui.view']
1491
1492         result = {
1493             'model': self._name,
1494             'field_parent': False,
1495         }
1496
1497         # try to find a view_id if none provided
1498         if not view_id:
1499             # <view_type>_view_ref in context can be used to overrride the default view
1500             view_ref_key = view_type + '_view_ref'
1501             view_ref = context.get(view_ref_key)
1502             if view_ref:
1503                 if '.' in view_ref:
1504                     module, view_ref = view_ref.split('.', 1)
1505                     cr.execute("SELECT res_id FROM ir_model_data WHERE model='ir.ui.view' AND module=%s AND name=%s", (module, view_ref))
1506                     view_ref_res = cr.fetchone()
1507                     if view_ref_res:
1508                         view_id = view_ref_res[0]
1509                 else:
1510                     _logger.warning('%r requires a fully-qualified external id (got: %r for model %s). '
1511                         'Please use the complete `module.view_id` form instead.', view_ref_key, view_ref,
1512                         self._name)
1513
1514             if not view_id:
1515                 # otherwise try to find the lowest priority matching ir.ui.view
1516                 view_id = View.default_view(cr, uid, self._name, view_type, context=context)
1517
1518         # context for post-processing might be overriden
1519         ctx = context
1520         if view_id:
1521             # read the view with inherited views applied
1522             root_view = View.read_combined(cr, uid, view_id, fields=['id', 'name', 'field_parent', 'type', 'model', 'arch'], context=context)
1523             result['arch'] = root_view['arch']
1524             result['name'] = root_view['name']
1525             result['type'] = root_view['type']
1526             result['view_id'] = root_view['id']
1527             result['field_parent'] = root_view['field_parent']
1528             # override context fro postprocessing
1529             if root_view.get('model') != self._name:
1530                 ctx = dict(context, base_model_name=root_view.get('model'))
1531         else:
1532             # fallback on default views methods if no ir.ui.view could be found
1533             try:
1534                 get_func = getattr(self, '_get_default_%s_view' % view_type)
1535                 arch_etree = get_func(cr, uid, context)
1536                 result['arch'] = etree.tostring(arch_etree, encoding='utf-8')
1537                 result['type'] = view_type
1538                 result['name'] = 'default'
1539             except AttributeError:
1540                 raise except_orm(_('Invalid Architecture!'), _("No default view of type '%s' could be found !") % view_type)
1541
1542         # Apply post processing, groups and modifiers etc...
1543         xarch, xfields = View.postprocess_and_fields(cr, uid, self._name, etree.fromstring(result['arch']), view_id, context=ctx)
1544         result['arch'] = xarch
1545         result['fields'] = xfields
1546
1547         # Add related action information if aksed
1548         if toolbar:
1549             toclean = ('report_sxw_content', 'report_rml_content', 'report_sxw', 'report_rml', 'report_sxw_content_data', 'report_rml_content_data')
1550             def clean(x):
1551                 x = x[2]
1552                 for key in toclean:
1553                     x.pop(key, None)
1554                 return x
1555             ir_values_obj = self.pool.get('ir.values')
1556             resprint = ir_values_obj.get(cr, uid, 'action', 'client_print_multi', [(self._name, False)], False, context)
1557             resaction = ir_values_obj.get(cr, uid, 'action', 'client_action_multi', [(self._name, False)], False, context)
1558             resrelate = ir_values_obj.get(cr, uid, 'action', 'client_action_relate', [(self._name, False)], False, context)
1559             resaction = [clean(action) for action in resaction if view_type == 'tree' or not action[2].get('multi')]
1560             resprint = [clean(print_) for print_ in resprint if view_type == 'tree' or not print_[2].get('multi')]
1561             #When multi="True" set it will display only in More of the list view
1562             resrelate = [clean(action) for action in resrelate
1563                          if (action[2].get('multi') and view_type == 'tree') or (not action[2].get('multi') and view_type == 'form')]
1564
1565             for x in itertools.chain(resprint, resaction, resrelate):
1566                 x['string'] = x['name']
1567
1568             result['toolbar'] = {
1569                 'print': resprint,
1570                 'action': resaction,
1571                 'relate': resrelate
1572             }
1573         return result
1574
1575     def get_formview_id(self, cr, uid, id, context=None):
1576         """ Return an view id to open the document with. This method is meant to be
1577             overridden in addons that want to give specific view ids for example.
1578
1579             :param int id: id of the document to open
1580         """
1581         return False
1582
1583     def get_formview_action(self, cr, uid, id, context=None):
1584         """ Return an action to open the document. This method is meant to be
1585             overridden in addons that want to give specific view ids for example.
1586
1587             :param int id: id of the document to open
1588         """
1589         view_id = self.get_formview_id(cr, uid, id, context=context)
1590         return {
1591                 'type': 'ir.actions.act_window',
1592                 'res_model': self._name,
1593                 'view_type': 'form',
1594                 'view_mode': 'form',
1595                 'views': [(view_id, 'form')],
1596                 'target': 'current',
1597                 'res_id': id,
1598             }
1599
1600     def _view_look_dom_arch(self, cr, uid, node, view_id, context=None):
1601         return self.pool['ir.ui.view'].postprocess_and_fields(
1602             cr, uid, self._name, node, view_id, context=context)
1603
1604     def search_count(self, cr, user, args, context=None):
1605         res = self.search(cr, user, args, context=context, count=True)
1606         if isinstance(res, list):
1607             return len(res)
1608         return res
1609
1610     @api.returns('self')
1611     def search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False):
1612         """
1613         Search for records based on a search domain.
1614
1615         :param cr: database cursor
1616         :param user: current user id
1617         :param args: list of tuples specifying the search domain [('field_name', 'operator', value), ...]. Pass an empty list to match all records.
1618         :param offset: optional number of results to skip in the returned values (default: 0)
1619         :param limit: optional max number of records to return (default: **None**)
1620         :param order: optional columns to sort by (default: self._order=id )
1621         :param context: optional context arguments, like lang, time zone
1622         :type context: dictionary
1623         :param count: optional (default: **False**), if **True**, returns only the number of records matching the criteria, not their ids
1624         :return: id or list of ids of records matching the criteria
1625         :rtype: integer or list of integers
1626         :raise AccessError: * if user tries to bypass access rules for read on the requested object.
1627
1628         **Expressing a search domain (args)**
1629
1630         Each tuple in the search domain needs to have 3 elements, in the form: **('field_name', 'operator', value)**, where:
1631
1632             * **field_name** must be a valid name of field of the object model, possibly following many-to-one relationships using dot-notation, e.g 'street' or 'partner_id.country' are valid values.
1633             * **operator** must be a string with a valid comparison operator from this list: ``=, !=, >, >=, <, <=, like, ilike, in, not in, child_of, parent_left, parent_right``
1634               The semantics of most of these operators are obvious.
1635               The ``child_of`` operator will look for records who are children or grand-children of a given record,
1636               according to the semantics of this model (i.e following the relationship field named by
1637               ``self._parent_name``, by default ``parent_id``.
1638             * **value** must be a valid value to compare with the values of **field_name**, depending on its type.
1639
1640         Domain criteria can be combined using 3 logical operators than can be added between tuples:  '**&**' (logical AND, default), '**|**' (logical OR), '**!**' (logical NOT).
1641         These are **prefix** operators and the arity of the '**&**' and '**|**' operator is 2, while the arity of the '**!**' is just 1.
1642         Be very careful about this when you combine them the first time.
1643
1644         Here is an example of searching for Partners named *ABC* from Belgium and Germany whose language is not english ::
1645
1646             [('name','=','ABC'),'!',('language.code','=','en_US'),'|',('country_id.code','=','be'),('country_id.code','=','de'))
1647
1648         The '&' is omitted as it is the default, and of course we could have used '!=' for the language, but what this domain really represents is::
1649
1650             (name is 'ABC' AND (language is NOT english) AND (country is Belgium OR Germany))
1651
1652         """
1653         return self._search(cr, user, args, offset=offset, limit=limit, order=order, context=context, count=count)
1654
1655     #
1656     # display_name, name_get, name_create, name_search
1657     #
1658
1659     @api.depends(lambda self: (self._rec_name,) if self._rec_name else ())
1660     def _compute_display_name(self):
1661         for i, got_name in enumerate(self.name_get()):
1662             self[i].display_name = got_name[1]
1663
1664     @api.multi
1665     def name_get(self):
1666         """ Return a textual representation for the records in `self`.
1667             By default this is the value of field ``display_name``.
1668
1669             :rtype: list(tuple)
1670             :return: list of pairs ``(id, text_repr)`` for all records
1671         """
1672         result = []
1673         name = self._rec_name
1674         if name in self._fields:
1675             convert = self._fields[name].convert_to_display_name
1676             for record in self:
1677                 result.append((record.id, convert(record[name])))
1678         else:
1679             for record in self:
1680                 result.append((record.id, "%s,%s" % (record._name, record.id)))
1681
1682         return result
1683
1684     @api.model
1685     def name_create(self, name):
1686         """ Create a new record by calling :meth:`~.create` with only one value
1687             provided: the display name of the new record.
1688
1689             The new record will be initialized with any default values
1690             applicable to this model, or provided through the context. The usual
1691             behavior of :meth:`~.create` applies.
1692
1693             :param name: display name of the record to create
1694             :rtype: tuple
1695             :return: the :meth:`~.name_get` pair value of the created record
1696         """
1697         if self._rec_name:
1698             record = self.create({self._rec_name: name})
1699             return record.name_get()[0]
1700         else:
1701             _logger.warning("Cannot execute name_create, no _rec_name defined on %s", self._name)
1702             return False
1703
1704     @api.model
1705     def name_search(self, name='', args=None, operator='ilike', limit=100):
1706         """ Search for records that have a display name matching the given
1707             `name` pattern when compared with the given `operator`, while also
1708             matching the optional search domain (`args`).
1709
1710             This is used for example to provide suggestions based on a partial
1711             value for a relational field. Sometimes be seen as the inverse
1712             function of :meth:`~.name_get`, but it is not guaranteed to be.
1713
1714             This method is equivalent to calling :meth:`~.search` with a search
1715             domain based on `display_name` and then :meth:`~.name_get` on the
1716             result of the search.
1717
1718             :param name: the name pattern to match
1719             :param list args: optional search domain (see :meth:`~.search` for
1720                 syntax), specifying further restrictions
1721             :param str operator: domain operator for matching `name`, such as
1722                 ``'like'`` or ``'='``.
1723             :param int limit: optional max number of records to return
1724             :rtype: list
1725             :return: list of pairs ``(id, text_repr)`` for all matching records.
1726         """
1727         args = list(args or [])
1728         if not self._rec_name:
1729             _logger.warning("Cannot execute name_search, no _rec_name defined on %s", self._name)
1730         elif not (name == '' and operator == 'ilike'):
1731             args += [(self._rec_name, operator, name)]
1732         return self.search(args, limit=limit).name_get()
1733
1734     def _name_search(self, cr, user, name='', args=None, operator='ilike', context=None, limit=100, name_get_uid=None):
1735         # private implementation of name_search, allows passing a dedicated user
1736         # for the name_get part to solve some access rights issues
1737         args = list(args or [])
1738         # optimize out the default criterion of ``ilike ''`` that matches everything
1739         if not self._rec_name:
1740             _logger.warning("Cannot execute name_search, no _rec_name defined on %s", self._name)
1741         elif not (name == '' and operator == 'ilike'):
1742             args += [(self._rec_name, operator, name)]
1743         access_rights_uid = name_get_uid or user
1744         ids = self._search(cr, user, args, limit=limit, context=context, access_rights_uid=access_rights_uid)
1745         res = self.name_get(cr, access_rights_uid, ids, context)
1746         return res
1747
1748     def read_string(self, cr, uid, id, langs, fields=None, context=None):
1749         res = {}
1750         res2 = {}
1751         self.pool.get('ir.translation').check_access_rights(cr, uid, 'read')
1752         if not fields:
1753             fields = self._columns.keys() + self._inherit_fields.keys()
1754         #FIXME: collect all calls to _get_source into one SQL call.
1755         for lang in langs:
1756             res[lang] = {'code': lang}
1757             for f in fields:
1758                 if f in self._columns:
1759                     res_trans = self.pool.get('ir.translation')._get_source(cr, uid, self._name+','+f, 'field', lang)
1760                     if res_trans:
1761                         res[lang][f] = res_trans
1762                     else:
1763                         res[lang][f] = self._columns[f].string
1764         for table in self._inherits:
1765             cols = intersect(self._inherit_fields.keys(), fields)
1766             res2 = self.pool[table].read_string(cr, uid, id, langs, cols, context)
1767         for lang in res2:
1768             if lang in res:
1769                 res[lang]['code'] = lang
1770             for f in res2[lang]:
1771                 res[lang][f] = res2[lang][f]
1772         return res
1773
1774     def write_string(self, cr, uid, id, langs, vals, context=None):
1775         self.pool.get('ir.translation').check_access_rights(cr, uid, 'write')
1776         #FIXME: try to only call the translation in one SQL
1777         for lang in langs:
1778             for field in vals:
1779                 if field in self._columns:
1780                     src = self._columns[field].string
1781                     self.pool.get('ir.translation')._set_ids(cr, uid, self._name+','+field, 'field', lang, [0], vals[field], src)
1782         for table in self._inherits:
1783             cols = intersect(self._inherit_fields.keys(), vals)
1784             if cols:
1785                 self.pool[table].write_string(cr, uid, id, langs, vals, context)
1786         return True
1787
1788     def _add_missing_default_values(self, cr, uid, values, context=None):
1789         # avoid overriding inherited values when parent is set
1790         avoid_tables = []
1791         for tables, parent_field in self._inherits.items():
1792             if parent_field in values:
1793                 avoid_tables.append(tables)
1794
1795         # compute missing fields
1796         missing_defaults = set()
1797         for field in self._columns.keys():
1798             if not field in values:
1799                 missing_defaults.add(field)
1800         for field in self._inherit_fields.keys():
1801             if (field not in values) and (self._inherit_fields[field][0] not in avoid_tables):
1802                 missing_defaults.add(field)
1803         # discard magic fields
1804         missing_defaults -= set(MAGIC_COLUMNS)
1805
1806         if missing_defaults:
1807             # override defaults with the provided values, never allow the other way around
1808             defaults = self.default_get(cr, uid, list(missing_defaults), context)
1809             for dv in defaults:
1810                 if ((dv in self._columns and self._columns[dv]._type == 'many2many') \
1811                      or (dv in self._inherit_fields and self._inherit_fields[dv][2]._type == 'many2many')) \
1812                         and defaults[dv] and isinstance(defaults[dv][0], (int, long)):
1813                     defaults[dv] = [(6, 0, defaults[dv])]
1814                 if (dv in self._columns and self._columns[dv]._type == 'one2many' \
1815                     or (dv in self._inherit_fields and self._inherit_fields[dv][2]._type == 'one2many')) \
1816                         and isinstance(defaults[dv], (list, tuple)) and defaults[dv] and isinstance(defaults[dv][0], dict):
1817                     defaults[dv] = [(0, 0, x) for x in defaults[dv]]
1818             defaults.update(values)
1819             values = defaults
1820         return values
1821
1822     def clear_caches(self):
1823         """ Clear the caches
1824
1825         This clears the caches associated to methods decorated with
1826         ``tools.ormcache`` or ``tools.ormcache_multi``.
1827         """
1828         try:
1829             self._ormcache.clear()
1830             self.pool._any_cache_cleared = True
1831         except AttributeError:
1832             pass
1833
1834
1835     def _read_group_fill_results(self, cr, uid, domain, groupby, remaining_groupbys, aggregated_fields,
1836                                  read_group_result, read_group_order=None, context=None):
1837         """Helper method for filling in empty groups for all possible values of
1838            the field being grouped by"""
1839
1840         # self._group_by_full should map groupable fields to a method that returns
1841         # a list of all aggregated values that we want to display for this field,
1842         # in the form of a m2o-like pair (key,label).
1843         # This is useful to implement kanban views for instance, where all columns
1844         # should be displayed even if they don't contain any record.
1845
1846         # Grab the list of all groups that should be displayed, including all present groups
1847         present_group_ids = [x[groupby][0] for x in read_group_result if x[groupby]]
1848         all_groups,folded = self._group_by_full[groupby](self, cr, uid, present_group_ids, domain,
1849                                                   read_group_order=read_group_order,
1850                                                   access_rights_uid=openerp.SUPERUSER_ID,
1851                                                   context=context)
1852
1853         result_template = dict.fromkeys(aggregated_fields, False)
1854         result_template[groupby + '_count'] = 0
1855         if remaining_groupbys:
1856             result_template['__context'] = {'group_by': remaining_groupbys}
1857
1858         # Merge the left_side (current results as dicts) with the right_side (all
1859         # possible values as m2o pairs). Both lists are supposed to be using the
1860         # same ordering, and can be merged in one pass.
1861         result = []
1862         known_values = {}
1863         def append_left(left_side):
1864             grouped_value = left_side[groupby] and left_side[groupby][0]
1865             if not grouped_value in known_values:
1866                 result.append(left_side)
1867                 known_values[grouped_value] = left_side
1868             else:
1869                 count_attr = groupby + '_count'
1870                 known_values[grouped_value].update({count_attr: left_side[count_attr]})
1871         def append_right(right_side):
1872             grouped_value = right_side[0]
1873             if not grouped_value in known_values:
1874                 line = dict(result_template)
1875                 line[groupby] = right_side
1876                 line['__domain'] = [(groupby,'=',grouped_value)] + domain
1877                 result.append(line)
1878                 known_values[grouped_value] = line
1879         while read_group_result or all_groups:
1880             left_side = read_group_result[0] if read_group_result else None
1881             right_side = all_groups[0] if all_groups else None
1882             assert left_side is None or left_side[groupby] is False \
1883                  or isinstance(left_side[groupby], (tuple,list)), \
1884                 'M2O-like pair expected, got %r' % left_side[groupby]
1885             assert right_side is None or isinstance(right_side, (tuple,list)), \
1886                 'M2O-like pair expected, got %r' % right_side
1887             if left_side is None:
1888                 append_right(all_groups.pop(0))
1889             elif right_side is None:
1890                 append_left(read_group_result.pop(0))
1891             elif left_side[groupby] == right_side:
1892                 append_left(read_group_result.pop(0))
1893                 all_groups.pop(0) # discard right_side
1894             elif not left_side[groupby] or not left_side[groupby][0]:
1895                 # left side == "Undefined" entry, not present on right_side
1896                 append_left(read_group_result.pop(0))
1897             else:
1898                 append_right(all_groups.pop(0))
1899
1900         if folded:
1901             for r in result:
1902                 r['__fold'] = folded.get(r[groupby] and r[groupby][0], False)
1903         return result
1904
1905     def _read_group_prepare(self, orderby, aggregated_fields, annotated_groupbys, query):
1906         """
1907         Prepares the GROUP BY and ORDER BY terms for the read_group method. Adds the missing JOIN clause
1908         to the query if order should be computed against m2o field.
1909         :param orderby: the orderby definition in the form "%(field)s %(order)s"
1910         :param aggregated_fields: list of aggregated fields in the query
1911         :param annotated_groupbys: list of dictionaries returned by _read_group_process_groupby
1912                 These dictionaries contains the qualified name of each groupby
1913                 (fully qualified SQL name for the corresponding field),
1914                 and the (non raw) field name.
1915         :param osv.Query query: the query under construction
1916         :return: (groupby_terms, orderby_terms)
1917         """
1918         orderby_terms = []
1919         groupby_terms = [gb['qualified_field'] for gb in annotated_groupbys]
1920         groupby_fields = [gb['groupby'] for gb in annotated_groupbys]
1921         if not orderby:
1922             return groupby_terms, orderby_terms
1923
1924         self._check_qorder(orderby)
1925         for order_part in orderby.split(','):
1926             order_split = order_part.split()
1927             order_field = order_split[0]
1928             if order_field in groupby_fields:
1929
1930                 if self._all_columns[order_field.split(':')[0]].column._type == 'many2one':
1931                     order_clause = self._generate_order_by(order_part, query).replace('ORDER BY ', '')
1932                     if order_clause:
1933                         orderby_terms.append(order_clause)
1934                         groupby_terms += [order_term.split()[0] for order_term in order_clause.split(',')]
1935                 else:
1936                     order = '"%s" %s' % (order_field, '' if len(order_split) == 1 else order_split[1])
1937                     orderby_terms.append(order)
1938             elif order_field in aggregated_fields:
1939                 orderby_terms.append(order_part)
1940             else:
1941                 # Cannot order by a field that will not appear in the results (needs to be grouped or aggregated)
1942                 _logger.warn('%s: read_group order by `%s` ignored, cannot sort on empty columns (not grouped/aggregated)',
1943                              self._name, order_part)
1944         return groupby_terms, orderby_terms
1945
1946     def _read_group_process_groupby(self, gb, query, context):
1947         """
1948             Helper method to collect important information about groupbys: raw
1949             field name, type, time informations, qualified name, ...
1950         """
1951         split = gb.split(':')
1952         field_type = self._all_columns[split[0]].column._type
1953         gb_function = split[1] if len(split) == 2 else None
1954         temporal = field_type in ('date', 'datetime')
1955         tz_convert = field_type == 'datetime' and context.get('tz') in pytz.all_timezones
1956         qualified_field = self._inherits_join_calc(split[0], query)
1957         if temporal:
1958             display_formats = {
1959                 'day': 'dd MMM YYYY',
1960                 'week': "'W'w YYYY",
1961                 'month': 'MMMM YYYY',
1962                 'quarter': 'QQQ YYYY',
1963                 'year': 'YYYY'
1964             }
1965             time_intervals = {
1966                 'day': dateutil.relativedelta.relativedelta(days=1),
1967                 'week': datetime.timedelta(days=7),
1968                 'month': dateutil.relativedelta.relativedelta(months=1),
1969                 'quarter': dateutil.relativedelta.relativedelta(months=3),
1970                 'year': dateutil.relativedelta.relativedelta(years=1)
1971             }
1972             if tz_convert:
1973                 qualified_field = "timezone('%s', timezone('UTC',%s))" % (context.get('tz', 'UTC'), qualified_field)
1974             qualified_field = "date_trunc('%s', %s)" % (gb_function or 'month', qualified_field)
1975         if field_type == 'boolean':
1976             qualified_field = "coalesce(%s,false)" % qualified_field
1977         return {
1978             'field': split[0],
1979             'groupby': gb,
1980             'type': field_type,
1981             'display_format': display_formats[gb_function or 'month'] if temporal else None,
1982             'interval': time_intervals[gb_function or 'month'] if temporal else None,
1983             'tz_convert': tz_convert,
1984             'qualified_field': qualified_field
1985         }
1986
1987     def _read_group_prepare_data(self, key, value, groupby_dict, context):
1988         """
1989             Helper method to sanitize the data received by read_group. The None
1990             values are converted to False, and the date/datetime are formatted,
1991             and corrected according to the timezones.
1992         """
1993         value = False if value is None else value
1994         gb = groupby_dict.get(key)
1995         if gb and gb['type'] in ('date', 'datetime') and value:
1996             if isinstance(value, basestring):
1997                 dt_format = DEFAULT_SERVER_DATETIME_FORMAT if gb['type'] == 'datetime' else DEFAULT_SERVER_DATE_FORMAT
1998                 value = datetime.datetime.strptime(value, dt_format)
1999             if gb['tz_convert']:
2000                 value =  pytz.timezone(context['tz']).localize(value)
2001         return value
2002
2003     def _read_group_get_domain(self, groupby, value):
2004         """
2005             Helper method to construct the domain corresponding to a groupby and
2006             a given value. This is mostly relevant for date/datetime.
2007         """
2008         if groupby['type'] in ('date', 'datetime') and value:
2009             dt_format = DEFAULT_SERVER_DATETIME_FORMAT if groupby['type'] == 'datetime' else DEFAULT_SERVER_DATE_FORMAT
2010             domain_dt_begin = value
2011             domain_dt_end = value + groupby['interval']
2012             if groupby['tz_convert']:
2013                 domain_dt_begin = domain_dt_begin.astimezone(pytz.utc)
2014                 domain_dt_end = domain_dt_end.astimezone(pytz.utc)
2015             return [(groupby['field'], '>=', domain_dt_begin.strftime(dt_format)),
2016                    (groupby['field'], '<', domain_dt_end.strftime(dt_format))]
2017         if groupby['type'] == 'many2one' and value:
2018                 value = value[0]
2019         return [(groupby['field'], '=', value)]
2020
2021     def _read_group_format_result(self, data, annotated_groupbys, groupby, groupby_dict, domain, context):
2022         """
2023             Helper method to format the data contained in the dictianary data by
2024             adding the domain corresponding to its values, the groupbys in the
2025             context and by properly formatting the date/datetime values.
2026         """
2027         domain_group = [dom for gb in annotated_groupbys for dom in self._read_group_get_domain(gb, data[gb['groupby']])]
2028         for k,v in data.iteritems():
2029             gb = groupby_dict.get(k)
2030             if gb and gb['type'] in ('date', 'datetime') and v:
2031                 data[k] = babel.dates.format_date(v, format=gb['display_format'], locale=context.get('lang', 'en_US'))
2032
2033         data['__domain'] = domain_group + domain
2034         if len(groupby) - len(annotated_groupbys) >= 1:
2035             data['__context'] = { 'group_by': groupby[len(annotated_groupbys):]}
2036         del data['id']
2037         return data
2038
2039     def read_group(self, cr, uid, domain, fields, groupby, offset=0, limit=None, context=None, orderby=False, lazy=True):
2040         """
2041         Get the list of records in list view grouped by the given ``groupby`` fields
2042
2043         :param cr: database cursor
2044         :param uid: current user id
2045         :param domain: list specifying search criteria [['field_name', 'operator', 'value'], ...]
2046         :param list fields: list of fields present in the list view specified on the object
2047         :param list groupby: list of groupby descriptions by which the records will be grouped.
2048                 A groupby description is either a field (then it will be grouped by that field)
2049                 or a string 'field:groupby_function'.  Right now, the only functions supported
2050                 are 'day', 'week', 'month', 'quarter' or 'year', and they only make sense for
2051                 date/datetime fields.
2052         :param int offset: optional number of records to skip
2053         :param int limit: optional max number of records to return
2054         :param dict context: context arguments, like lang, time zone.
2055         :param list orderby: optional ``order by`` specification, for
2056                              overriding the natural sort ordering of the
2057                              groups, see also :py:meth:`~osv.osv.osv.search`
2058                              (supported only for many2one fields currently)
2059         :param bool lazy: if true, the results are only grouped by the first groupby and the
2060                 remaining groupbys are put in the __context key.  If false, all the groupbys are
2061                 done in one call.
2062         :return: list of dictionaries(one dictionary for each record) containing:
2063
2064                     * the values of fields grouped by the fields in ``groupby`` argument
2065                     * __domain: list of tuples specifying the search criteria
2066                     * __context: dictionary with argument like ``groupby``
2067         :rtype: [{'field_name_1': value, ...]
2068         :raise AccessError: * if user has no read rights on the requested object
2069                             * if user tries to bypass access rules for read on the requested object
2070         """
2071         if context is None:
2072             context = {}
2073         self.check_access_rights(cr, uid, 'read')
2074         query = self._where_calc(cr, uid, domain, context=context)
2075         fields = fields or self._columns.keys()
2076
2077         groupby = [groupby] if isinstance(groupby, basestring) else groupby
2078         groupby_list = groupby[:1] if lazy else groupby
2079         annotated_groupbys = [self._read_group_process_groupby(gb, query, context)
2080                                     for gb in groupby_list]
2081         groupby_fields = [g['field'] for g in annotated_groupbys]
2082         order = orderby or ','.join([g for g in groupby_list])
2083         groupby_dict = {gb['groupby']: gb for gb in annotated_groupbys}
2084
2085         self._apply_ir_rules(cr, uid, query, 'read', context=context)
2086         for gb in groupby_fields:
2087             assert gb in fields, "Fields in 'groupby' must appear in the list of fields to read (perhaps it's missing in the list view?)"
2088             groupby_def = self._columns.get(gb) or (self._inherit_fields.get(gb) and self._inherit_fields.get(gb)[2])
2089             assert groupby_def and groupby_def._classic_write, "Fields in 'groupby' must be regular database-persisted fields (no function or related fields), or function fields with store=True"
2090             if not (gb in self._all_columns):
2091                 # Don't allow arbitrary values, as this would be a SQL injection vector!
2092                 raise except_orm(_('Invalid group_by'),
2093                                  _('Invalid group_by specification: "%s".\nA group_by specification must be a list of valid fields.')%(gb,))
2094
2095         aggregated_fields = [
2096             f for f in fields
2097             if f not in ('id', 'sequence')
2098             if f not in groupby_fields
2099             if self._all_columns[f].column._type in ('integer', 'float')
2100             if getattr(self._all_columns[f].column, '_classic_write')]
2101
2102         field_formatter = lambda f: (self._all_columns[f].column.group_operator or 'sum', self._inherits_join_calc(f, query), f)
2103         select_terms = ["%s(%s) AS %s" % field_formatter(f) for f in aggregated_fields]
2104
2105         for gb in annotated_groupbys:
2106             select_terms.append('%s as "%s" ' % (gb['qualified_field'], gb['groupby']))
2107
2108         groupby_terms, orderby_terms = self._read_group_prepare(order, aggregated_fields, annotated_groupbys, query)
2109         from_clause, where_clause, where_clause_params = query.get_sql()
2110         if lazy and (len(groupby_fields) >= 2 or not context.get('group_by_no_leaf')):
2111             count_field = groupby_fields[0] if len(groupby_fields) >= 1 else '_'
2112         else:
2113             count_field = '_'
2114
2115         prefix_terms = lambda prefix, terms: (prefix + " " + ",".join(terms)) if terms else ''
2116         prefix_term = lambda prefix, term: ('%s %s' % (prefix, term)) if term else ''
2117
2118         query = """
2119             SELECT min(%(table)s.id) AS id, count(%(table)s.id) AS %(count_field)s_count %(extra_fields)s
2120             FROM %(from)s
2121             %(where)s
2122             %(groupby)s
2123             %(orderby)s
2124             %(limit)s
2125             %(offset)s
2126         """ % {
2127             'table': self._table,
2128             'count_field': count_field,
2129             'extra_fields': prefix_terms(',', select_terms),
2130             'from': from_clause,
2131             'where': prefix_term('WHERE', where_clause),
2132             'groupby': prefix_terms('GROUP BY', groupby_terms),
2133             'orderby': prefix_terms('ORDER BY', orderby_terms),
2134             'limit': prefix_term('LIMIT', int(limit) if limit else None),
2135             'offset': prefix_term('OFFSET', int(offset) if limit else None),
2136         }
2137         cr.execute(query, where_clause_params)
2138         fetched_data = cr.dictfetchall()
2139
2140         if not groupby_fields:
2141             return fetched_data
2142
2143         many2onefields = [gb['field'] for gb in annotated_groupbys if gb['type'] == 'many2one']
2144         if many2onefields:
2145             data_ids = [r['id'] for r in fetched_data]
2146             many2onefields = list(set(many2onefields))
2147             data_dict = {d['id']: d for d in self.read(cr, uid, data_ids, many2onefields, context=context)}
2148             for d in fetched_data:
2149                 d.update(data_dict[d['id']])
2150
2151         data = map(lambda r: {k: self._read_group_prepare_data(k,v, groupby_dict, context) for k,v in r.iteritems()}, fetched_data)
2152         result = [self._read_group_format_result(d, annotated_groupbys, groupby, groupby_dict, domain, context) for d in data]
2153         if lazy and groupby_fields[0] in self._group_by_full:
2154             # Right now, read_group only fill results in lazy mode (by default).
2155             # If you need to have the empty groups in 'eager' mode, then the
2156             # method _read_group_fill_results need to be completely reimplemented
2157             # in a sane way
2158             result = self._read_group_fill_results(cr, uid, domain, groupby_fields[0], groupby[len(annotated_groupbys):],
2159                                                        aggregated_fields, result, read_group_order=order,
2160                                                        context=context)
2161         return result
2162
2163     def _inherits_join_add(self, current_model, parent_model_name, query):
2164         """
2165         Add missing table SELECT and JOIN clause to ``query`` for reaching the parent table (no duplicates)
2166         :param current_model: current model object
2167         :param parent_model_name: name of the parent model for which the clauses should be added
2168         :param query: query object on which the JOIN should be added
2169         """
2170         inherits_field = current_model._inherits[parent_model_name]
2171         parent_model = self.pool[parent_model_name]
2172         parent_alias, parent_alias_statement = query.add_join((current_model._table, parent_model._table, inherits_field, 'id', inherits_field), implicit=True)
2173         return parent_alias
2174
2175     def _inherits_join_calc(self, field, query):
2176         """
2177         Adds missing table select and join clause(s) to ``query`` for reaching
2178         the field coming from an '_inherits' parent table (no duplicates).
2179
2180         :param field: name of inherited field to reach
2181         :param query: query object on which the JOIN should be added
2182         :return: qualified name of field, to be used in SELECT clause
2183         """
2184         current_table = self
2185         parent_alias = '"%s"' % current_table._table
2186         while field in current_table._inherit_fields and not field in current_table._columns:
2187             parent_model_name = current_table._inherit_fields[field][0]
2188             parent_table = self.pool[parent_model_name]
2189             parent_alias = self._inherits_join_add(current_table, parent_model_name, query)
2190             current_table = parent_table
2191         return '%s."%s"' % (parent_alias, field)
2192
2193     def _parent_store_compute(self, cr):
2194         if not self._parent_store:
2195             return
2196         _logger.info('Computing parent left and right for table %s...', self._table)
2197         def browse_rec(root, pos=0):
2198             # TODO: set order
2199             where = self._parent_name+'='+str(root)
2200             if not root:
2201                 where = self._parent_name+' IS NULL'
2202             if self._parent_order:
2203                 where += ' order by '+self._parent_order
2204             cr.execute('SELECT id FROM '+self._table+' WHERE '+where)
2205             pos2 = pos + 1
2206             for id in cr.fetchall():
2207                 pos2 = browse_rec(id[0], pos2)
2208             cr.execute('update '+self._table+' set parent_left=%s, parent_right=%s where id=%s', (pos, pos2, root))
2209             return pos2 + 1
2210         query = 'SELECT id FROM '+self._table+' WHERE '+self._parent_name+' IS NULL'
2211         if self._parent_order:
2212             query += ' order by ' + self._parent_order
2213         pos = 0
2214         cr.execute(query)
2215         for (root,) in cr.fetchall():
2216             pos = browse_rec(root, pos)
2217         self.invalidate_cache(cr, SUPERUSER_ID, ['parent_left', 'parent_right'])
2218         return True
2219
2220     def _update_store(self, cr, f, k):
2221         _logger.info("storing computed values of fields.function '%s'", k)
2222         ss = self._columns[k]._symbol_set
2223         update_query = 'UPDATE "%s" SET "%s"=%s WHERE id=%%s' % (self._table, k, ss[0])
2224         cr.execute('select id from '+self._table)
2225         ids_lst = map(lambda x: x[0], cr.fetchall())
2226         while ids_lst:
2227             iids = ids_lst[:AUTOINIT_RECALCULATE_STORED_FIELDS]
2228             ids_lst = ids_lst[AUTOINIT_RECALCULATE_STORED_FIELDS:]
2229             res = f.get(cr, self, iids, k, SUPERUSER_ID, {})
2230             for key, val in res.items():
2231                 if f._multi:
2232                     val = val[k]
2233                 # if val is a many2one, just write the ID
2234                 if type(val) == tuple:
2235                     val = val[0]
2236                 if val is not False:
2237                     cr.execute(update_query, (ss[1](val), key))
2238
2239     def _check_selection_field_value(self, cr, uid, field, value, context=None):
2240         """Raise except_orm if value is not among the valid values for the selection field"""
2241         if self._columns[field]._type == 'reference':
2242             val_model, val_id_str = value.split(',', 1)
2243             val_id = False
2244             try:
2245                 val_id = long(val_id_str)
2246             except ValueError:
2247                 pass
2248             if not val_id:
2249                 raise except_orm(_('ValidateError'),
2250                                  _('Invalid value for reference field "%s.%s" (last part must be a non-zero integer): "%s"') % (self._table, field, value))
2251             val = val_model
2252         else:
2253             val = value
2254         if isinstance(self._columns[field].selection, (tuple, list)):
2255             if val in dict(self._columns[field].selection):
2256                 return
2257         elif val in dict(self._columns[field].selection(self, cr, uid, context=context)):
2258             return
2259         raise except_orm(_('ValidateError'),
2260                          _('The value "%s" for the field "%s.%s" is not in the selection') % (value, self._name, field))
2261
2262     def _check_removed_columns(self, cr, log=False):
2263         # iterate on the database columns to drop the NOT NULL constraints
2264         # of fields which were required but have been removed (or will be added by another module)
2265         columns = [c for c in self._columns if not (isinstance(self._columns[c], fields.function) and not self._columns[c].store)]
2266         columns += MAGIC_COLUMNS
2267         cr.execute("SELECT a.attname, a.attnotnull"
2268                    "  FROM pg_class c, pg_attribute a"
2269                    " WHERE c.relname=%s"
2270                    "   AND c.oid=a.attrelid"
2271                    "   AND a.attisdropped=%s"
2272                    "   AND pg_catalog.format_type(a.atttypid, a.atttypmod) NOT IN ('cid', 'tid', 'oid', 'xid')"
2273                    "   AND a.attname NOT IN %s", (self._table, False, tuple(columns))),
2274
2275         for column in cr.dictfetchall():
2276             if log:
2277                 _logger.debug("column %s is in the table %s but not in the corresponding object %s",
2278                               column['attname'], self._table, self._name)
2279             if column['attnotnull']:
2280                 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, column['attname']))
2281                 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2282                               self._table, column['attname'])
2283
2284     def _save_constraint(self, cr, constraint_name, type):
2285         """
2286         Record the creation of a constraint for this model, to make it possible
2287         to delete it later when the module is uninstalled. Type can be either
2288         'f' or 'u' depending on the constraint being a foreign key or not.
2289         """
2290         if not self._module:
2291             # no need to save constraints for custom models as they're not part
2292             # of any module
2293             return
2294         assert type in ('f', 'u')
2295         cr.execute("""
2296             SELECT 1 FROM ir_model_constraint, ir_module_module
2297             WHERE ir_model_constraint.module=ir_module_module.id
2298                 AND ir_model_constraint.name=%s
2299                 AND ir_module_module.name=%s
2300             """, (constraint_name, self._module))
2301         if not cr.rowcount:
2302             cr.execute("""
2303                 INSERT INTO ir_model_constraint
2304                     (name, date_init, date_update, module, model, type)
2305                 VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2306                     (SELECT id FROM ir_module_module WHERE name=%s),
2307                     (SELECT id FROM ir_model WHERE model=%s), %s)""",
2308                     (constraint_name, self._module, self._name, type))
2309
2310     def _save_relation_table(self, cr, relation_table):
2311         """
2312         Record the creation of a many2many for this model, to make it possible
2313         to delete it later when the module is uninstalled.
2314         """
2315         cr.execute("""
2316             SELECT 1 FROM ir_model_relation, ir_module_module
2317             WHERE ir_model_relation.module=ir_module_module.id
2318                 AND ir_model_relation.name=%s
2319                 AND ir_module_module.name=%s
2320             """, (relation_table, self._module))
2321         if not cr.rowcount:
2322             cr.execute("""INSERT INTO ir_model_relation (name, date_init, date_update, module, model)
2323                                  VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2324                     (SELECT id FROM ir_module_module WHERE name=%s),
2325                     (SELECT id FROM ir_model WHERE model=%s))""",
2326                        (relation_table, self._module, self._name))
2327             self.invalidate_cache(cr, SUPERUSER_ID)
2328
2329     # checked version: for direct m2o starting from `self`
2330     def _m2o_add_foreign_key_checked(self, source_field, dest_model, ondelete):
2331         assert self.is_transient() or not dest_model.is_transient(), \
2332             'Many2One relationships from non-transient Model to TransientModel are forbidden'
2333         if self.is_transient() and not dest_model.is_transient():
2334             # TransientModel relationships to regular Models are annoying
2335             # usually because they could block deletion due to the FKs.
2336             # So unless stated otherwise we default them to ondelete=cascade.
2337             ondelete = ondelete or 'cascade'
2338         fk_def = (self._table, source_field, dest_model._table, ondelete or 'set null')
2339         self._foreign_keys.add(fk_def)
2340         _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2341
2342     # unchecked version: for custom cases, such as m2m relationships
2343     def _m2o_add_foreign_key_unchecked(self, source_table, source_field, dest_model, ondelete):
2344         fk_def = (source_table, source_field, dest_model._table, ondelete or 'set null')
2345         self._foreign_keys.add(fk_def)
2346         _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2347
2348     def _drop_constraint(self, cr, source_table, constraint_name):
2349         cr.execute("ALTER TABLE %s DROP CONSTRAINT %s" % (source_table,constraint_name))
2350
2351     def _m2o_fix_foreign_key(self, cr, source_table, source_field, dest_model, ondelete):
2352         # Find FK constraint(s) currently established for the m2o field,
2353         # and see whether they are stale or not
2354         cr.execute("""SELECT confdeltype as ondelete_rule, conname as constraint_name,
2355                              cl2.relname as foreign_table
2356                       FROM pg_constraint as con, pg_class as cl1, pg_class as cl2,
2357                            pg_attribute as att1, pg_attribute as att2
2358                       WHERE con.conrelid = cl1.oid
2359                         AND cl1.relname = %s
2360                         AND con.confrelid = cl2.oid
2361                         AND array_lower(con.conkey, 1) = 1
2362                         AND con.conkey[1] = att1.attnum
2363                         AND att1.attrelid = cl1.oid
2364                         AND att1.attname = %s
2365                         AND array_lower(con.confkey, 1) = 1
2366                         AND con.confkey[1] = att2.attnum
2367                         AND att2.attrelid = cl2.oid
2368                         AND att2.attname = %s
2369                         AND con.contype = 'f'""", (source_table, source_field, 'id'))
2370         constraints = cr.dictfetchall()
2371         if constraints:
2372             if len(constraints) == 1:
2373                 # Is it the right constraint?
2374                 cons, = constraints
2375                 if cons['ondelete_rule'] != POSTGRES_CONFDELTYPES.get((ondelete or 'set null').upper(), 'a')\
2376                     or cons['foreign_table'] != dest_model._table:
2377                     # Wrong FK: drop it and recreate
2378                     _schema.debug("Table '%s': dropping obsolete FK constraint: '%s'",
2379                                   source_table, cons['constraint_name'])
2380                     self._drop_constraint(cr, source_table, cons['constraint_name'])
2381                 else:
2382                     # it's all good, nothing to do!
2383                     return
2384             else:
2385                 # Multiple FKs found for the same field, drop them all, and re-create
2386                 for cons in constraints:
2387                     _schema.debug("Table '%s': dropping duplicate FK constraints: '%s'",
2388                                   source_table, cons['constraint_name'])
2389                     self._drop_constraint(cr, source_table, cons['constraint_name'])
2390
2391         # (re-)create the FK
2392         self._m2o_add_foreign_key_checked(source_field, dest_model, ondelete)
2393
2394
2395     def _set_default_value_on_column(self, cr, column_name, context=None):
2396         # ideally should use add_default_value but fails
2397         # due to ir.values not being ready
2398
2399         # get old-style default
2400         default = self._defaults.get(column_name)
2401         if callable(default):
2402             default = default(self, cr, SUPERUSER_ID, context)
2403
2404         # get new_style default if no old-style
2405         if default is None:
2406             record = self.new(cr, SUPERUSER_ID, context=context)
2407             field = self._fields[column_name]
2408             field.determine_default(record)
2409             defaults = dict(record._cache)
2410             if column_name in defaults:
2411                 default = field.convert_to_write(defaults[column_name])
2412
2413         ss = self._columns[column_name]._symbol_set
2414         store_default = ss[1](default)
2415         if store_default is not None:
2416             _logger.debug("Table '%s': setting default value of new column %s to %r",
2417                           self._table, column_name, default)
2418             query = 'UPDATE "%s" SET "%s"=%s WHERE "%s" is NULL' % (
2419                 self._table, column_name, ss[0], column_name)
2420             cr.execute(query, (store_default,))
2421             # this is a disgrace
2422             cr.commit()
2423
2424     def _auto_init(self, cr, context=None):
2425         """
2426
2427         Call _field_create and, unless _auto is False:
2428
2429         - create the corresponding table in database for the model,
2430         - possibly add the parent columns in database,
2431         - possibly add the columns 'create_uid', 'create_date', 'write_uid',
2432           'write_date' in database if _log_access is True (the default),
2433         - report on database columns no more existing in _columns,
2434         - remove no more existing not null constraints,
2435         - alter existing database columns to match _columns,
2436         - create database tables to match _columns,
2437         - add database indices to match _columns,
2438         - save in self._foreign_keys a list a foreign keys to create (see
2439           _auto_end).
2440
2441         """
2442         self._foreign_keys = set()
2443         raise_on_invalid_object_name(self._name)
2444         if context is None:
2445             context = {}
2446         store_compute = False
2447         stored_fields = []              # new-style stored fields with compute
2448         todo_end = []
2449         update_custom_fields = context.get('update_custom_fields', False)
2450         self._field_create(cr, context=context)
2451         create = not self._table_exist(cr)
2452         if self._auto:
2453
2454             if create:
2455                 self._create_table(cr)
2456                 has_rows = False
2457             else:
2458                 cr.execute('SELECT COUNT(1) FROM "%s"' % (self._table,))
2459                 has_rows = cr.fetchone()[0]
2460
2461             cr.commit()
2462             if self._parent_store:
2463                 if not self._parent_columns_exist(cr):
2464                     self._create_parent_columns(cr)
2465                     store_compute = True
2466
2467             self._check_removed_columns(cr, log=False)
2468
2469             # iterate on the "object columns"
2470             column_data = self._select_column_data(cr)
2471
2472             for k, f in self._columns.iteritems():
2473                 if k == 'id': # FIXME: maybe id should be a regular column?
2474                     continue
2475                 # Don't update custom (also called manual) fields
2476                 if f.manual and not update_custom_fields:
2477                     continue
2478
2479                 if isinstance(f, fields.one2many):
2480                     self._o2m_raise_on_missing_reference(cr, f)
2481
2482                 elif isinstance(f, fields.many2many):
2483                     self._m2m_raise_or_create_relation(cr, f)
2484
2485                 else:
2486                     res = column_data.get(k)
2487
2488                     # The field is not found as-is in database, try if it
2489                     # exists with an old name.
2490                     if not res and hasattr(f, 'oldname'):
2491                         res = column_data.get(f.oldname)
2492                         if res:
2493                             cr.execute('ALTER TABLE "%s" RENAME "%s" TO "%s"' % (self._table, f.oldname, k))
2494                             res['attname'] = k
2495                             column_data[k] = res
2496                             _schema.debug("Table '%s': renamed column '%s' to '%s'",
2497                                 self._table, f.oldname, k)
2498
2499                     # The field already exists in database. Possibly
2500                     # change its type, rename it, drop it or change its
2501                     # constraints.
2502                     if res:
2503                         f_pg_type = res['typname']
2504                         f_pg_size = res['size']
2505                         f_pg_notnull = res['attnotnull']
2506                         if isinstance(f, fields.function) and not f.store and\
2507                                 not getattr(f, 'nodrop', False):
2508                             _logger.info('column %s (%s) converted to a function, removed from table %s',
2509                                          k, f.string, self._table)
2510                             cr.execute('ALTER TABLE "%s" DROP COLUMN "%s" CASCADE' % (self._table, k))
2511                             cr.commit()
2512                             _schema.debug("Table '%s': dropped column '%s' with cascade",
2513                                 self._table, k)
2514                             f_obj_type = None
2515                         else:
2516                             f_obj_type = get_pg_type(f) and get_pg_type(f)[0]
2517
2518                         if f_obj_type:
2519                             ok = False
2520                             casts = [
2521                                 ('text', 'char', pg_varchar(f.size), '::%s' % pg_varchar(f.size)),
2522                                 ('varchar', 'text', 'TEXT', ''),
2523                                 ('int4', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2524                                 ('date', 'datetime', 'TIMESTAMP', '::TIMESTAMP'),
2525                                 ('timestamp', 'date', 'date', '::date'),
2526                                 ('numeric', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2527                                 ('float8', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2528                             ]
2529                             if f_pg_type == 'varchar' and f._type == 'char' and f_pg_size and (f.size is None or f_pg_size < f.size):
2530                                 try:
2531                                     with cr.savepoint():
2532                                         cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" TYPE %s' % (self._table, k, pg_varchar(f.size)))
2533                                 except psycopg2.NotSupportedError:
2534                                     # In place alter table cannot be done because a view is depending of this field.
2535                                     # Do a manual copy. This will drop the view (that will be recreated later)
2536                                     cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO temp_change_size' % (self._table, k))
2537                                     cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, pg_varchar(f.size)))
2538                                     cr.execute('UPDATE "%s" SET "%s"=temp_change_size::%s' % (self._table, k, pg_varchar(f.size)))
2539                                     cr.execute('ALTER TABLE "%s" DROP COLUMN temp_change_size CASCADE' % (self._table,))
2540                                 cr.commit()
2541                                 _schema.debug("Table '%s': column '%s' (type varchar) changed size from %s to %s",
2542                                     self._table, k, f_pg_size or 'unlimited', f.size or 'unlimited')
2543                             for c in casts:
2544                                 if (f_pg_type==c[0]) and (f._type==c[1]):
2545                                     if f_pg_type != f_obj_type:
2546                                         ok = True
2547                                         cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO __temp_type_cast' % (self._table, k))
2548                                         cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, c[2]))
2549                                         cr.execute(('UPDATE "%s" SET "%s"= __temp_type_cast'+c[3]) % (self._table, k))
2550                                         cr.execute('ALTER TABLE "%s" DROP COLUMN  __temp_type_cast CASCADE' % (self._table,))
2551                                         cr.commit()
2552                                         _schema.debug("Table '%s': column '%s' changed type from %s to %s",
2553                                             self._table, k, c[0], c[1])
2554                                     break
2555
2556                             if f_pg_type != f_obj_type:
2557                                 if not ok:
2558                                     i = 0
2559                                     while True:
2560                                         newname = k + '_moved' + str(i)
2561                                         cr.execute("SELECT count(1) FROM pg_class c,pg_attribute a " \
2562                                             "WHERE c.relname=%s " \
2563                                             "AND a.attname=%s " \
2564                                             "AND c.oid=a.attrelid ", (self._table, newname))
2565                                         if not cr.fetchone()[0]:
2566                                             break
2567                                         i += 1
2568                                     if f_pg_notnull:
2569                                         cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2570                                     cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO "%s"' % (self._table, k, newname))
2571                                     cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2572                                     cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2573                                     _schema.debug("Table '%s': column '%s' has changed type (DB=%s, def=%s), data moved to column %s !",
2574                                         self._table, k, f_pg_type, f._type, newname)
2575
2576                             # if the field is required and hasn't got a NOT NULL constraint
2577                             if f.required and f_pg_notnull == 0:
2578                                 if has_rows:
2579                                     self._set_default_value_on_column(cr, k, context=context)
2580                                 # add the NOT NULL constraint
2581                                 try:
2582                                     cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k), log_exceptions=False)
2583                                     cr.commit()
2584                                     _schema.debug("Table '%s': column '%s': added NOT NULL constraint",
2585                                         self._table, k)
2586                                 except Exception:
2587                                     msg = "Table '%s': unable to set a NOT NULL constraint on column '%s' !\n"\
2588                                         "If you want to have it, you should update the records and execute manually:\n"\
2589                                         "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2590                                     _schema.warning(msg, self._table, k, self._table, k)
2591                                 cr.commit()
2592                             elif not f.required and f_pg_notnull == 1:
2593                                 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2594                                 cr.commit()
2595                                 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2596                                     self._table, k)
2597                             # Verify index
2598                             indexname = '%s_%s_index' % (self._table, k)
2599                             cr.execute("SELECT indexname FROM pg_indexes WHERE indexname = %s and tablename = %s", (indexname, self._table))
2600                             res2 = cr.dictfetchall()
2601                             if not res2 and f.select:
2602                                 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2603                                 cr.commit()
2604                                 if f._type == 'text':
2605                                     # FIXME: for fields.text columns we should try creating GIN indexes instead (seems most suitable for an ERP context)
2606                                     msg = "Table '%s': Adding (b-tree) index for %s column '%s'."\
2607                                         "This is probably useless (does not work for fulltext search) and prevents INSERTs of long texts"\
2608                                         " because there is a length limit for indexable btree values!\n"\
2609                                         "Use a search view instead if you simply want to make the field searchable."
2610                                     _schema.warning(msg, self._table, f._type, k)
2611                             if res2 and not f.select:
2612                                 cr.execute('DROP INDEX "%s_%s_index"' % (self._table, k))
2613                                 cr.commit()
2614                                 msg = "Table '%s': dropping index for column '%s' of type '%s' as it is not required anymore"
2615                                 _schema.debug(msg, self._table, k, f._type)
2616
2617                             if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2618                                 dest_model = self.pool[f._obj]
2619                                 if dest_model._table != 'ir_actions':
2620                                     self._m2o_fix_foreign_key(cr, self._table, k, dest_model, f.ondelete)
2621
2622                     # The field doesn't exist in database. Create it if necessary.
2623                     else:
2624                         if not isinstance(f, fields.function) or f.store:
2625                             # add the missing field
2626                             cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2627                             cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2628                             _schema.debug("Table '%s': added column '%s' with definition=%s",
2629                                 self._table, k, get_pg_type(f)[1])
2630
2631                             # initialize it
2632                             if has_rows:
2633                                 self._set_default_value_on_column(cr, k, context=context)
2634
2635                             # remember the functions to call for the stored fields
2636                             if isinstance(f, fields.function):
2637                                 order = 10
2638                                 if f.store is not True: # i.e. if f.store is a dict
2639                                     order = f.store[f.store.keys()[0]][2]
2640                                 todo_end.append((order, self._update_store, (f, k)))
2641
2642                             # remember new-style stored fields with compute method
2643                             if k in self._fields and self._fields[k].depends:
2644                                 stored_fields.append(self._fields[k])
2645
2646                             # and add constraints if needed
2647                             if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2648                                 if f._obj not in self.pool:
2649                                     raise except_orm('Programming Error', 'There is no reference available for %s' % (f._obj,))
2650                                 dest_model = self.pool[f._obj]
2651                                 ref = dest_model._table
2652                                 # ir_actions is inherited so foreign key doesn't work on it
2653                                 if ref != 'ir_actions':
2654                                     self._m2o_add_foreign_key_checked(k, dest_model, f.ondelete)
2655                             if f.select:
2656                                 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2657                             if f.required:
2658                                 try:
2659                                     cr.commit()
2660                                     cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k))
2661                                     _schema.debug("Table '%s': column '%s': added a NOT NULL constraint",
2662                                         self._table, k)
2663                                 except Exception:
2664                                     msg = "WARNING: unable to set column %s of table %s not null !\n"\
2665                                         "Try to re-run: openerp-server --update=module\n"\
2666                                         "If it doesn't work, update records and execute manually:\n"\
2667                                         "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2668                                     _logger.warning(msg, k, self._table, self._table, k, exc_info=True)
2669                             cr.commit()
2670
2671         else:
2672             cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2673             create = not bool(cr.fetchone())
2674
2675         cr.commit()     # start a new transaction
2676
2677         if self._auto:
2678             self._add_sql_constraints(cr)
2679
2680         if create:
2681             self._execute_sql(cr)
2682
2683         if store_compute:
2684             self._parent_store_compute(cr)
2685             cr.commit()
2686
2687         if stored_fields:
2688             # trigger computation of new-style stored fields with a compute
2689             def func(cr):
2690                 _logger.info("Storing computed values of %s fields %s",
2691                     self._name, ', '.join(sorted(f.name for f in stored_fields)))
2692                 recs = self.browse(cr, SUPERUSER_ID, [], {'active_test': False})
2693                 recs = recs.search([])
2694                 if recs:
2695                     map(recs._recompute_todo, stored_fields)
2696                     recs.recompute()
2697
2698             todo_end.append((1000, func, ()))
2699
2700         return todo_end
2701
2702     def _auto_end(self, cr, context=None):
2703         """ Create the foreign keys recorded by _auto_init. """
2704         for t, k, r, d in self._foreign_keys:
2705             cr.execute('ALTER TABLE "%s" ADD FOREIGN KEY ("%s") REFERENCES "%s" ON DELETE %s' % (t, k, r, d))
2706             self._save_constraint(cr, "%s_%s_fkey" % (t, k), 'f')
2707         cr.commit()
2708         del self._foreign_keys
2709
2710
2711     def _table_exist(self, cr):
2712         cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2713         return cr.rowcount
2714
2715
2716     def _create_table(self, cr):
2717         cr.execute('CREATE TABLE "%s" (id SERIAL NOT NULL, PRIMARY KEY(id))' % (self._table,))
2718         cr.execute(("COMMENT ON TABLE \"%s\" IS %%s" % self._table), (self._description,))
2719         _schema.debug("Table '%s': created", self._table)
2720
2721
2722     def _parent_columns_exist(self, cr):
2723         cr.execute("""SELECT c.relname
2724             FROM pg_class c, pg_attribute a
2725             WHERE c.relname=%s AND a.attname=%s AND c.oid=a.attrelid
2726             """, (self._table, 'parent_left'))
2727         return cr.rowcount
2728
2729
2730     def _create_parent_columns(self, cr):
2731         cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_left" INTEGER' % (self._table,))
2732         cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_right" INTEGER' % (self._table,))
2733         if 'parent_left' not in self._columns:
2734             _logger.error('create a column parent_left on object %s: fields.integer(\'Left Parent\', select=1)',
2735                           self._table)
2736             _schema.debug("Table '%s': added column '%s' with definition=%s",
2737                 self._table, 'parent_left', 'INTEGER')
2738         elif not self._columns['parent_left'].select:
2739             _logger.error('parent_left column on object %s must be indexed! Add select=1 to the field definition)',
2740                           self._table)
2741         if 'parent_right' not in self._columns:
2742             _logger.error('create a column parent_right on object %s: fields.integer(\'Right Parent\', select=1)',
2743                           self._table)
2744             _schema.debug("Table '%s': added column '%s' with definition=%s",
2745                 self._table, 'parent_right', 'INTEGER')
2746         elif not self._columns['parent_right'].select:
2747             _logger.error('parent_right column on object %s must be indexed! Add select=1 to the field definition)',
2748                           self._table)
2749         if self._columns[self._parent_name].ondelete not in ('cascade', 'restrict'):
2750             _logger.error("The column %s on object %s must be set as ondelete='cascade' or 'restrict'",
2751                           self._parent_name, self._name)
2752
2753         cr.commit()
2754
2755
2756     def _select_column_data(self, cr):
2757         # attlen is the number of bytes necessary to represent the type when
2758         # the type has a fixed size. If the type has a varying size attlen is
2759         # -1 and atttypmod is the size limit + 4, or -1 if there is no limit.
2760         cr.execute("SELECT c.relname,a.attname,a.attlen,a.atttypmod,a.attnotnull,a.atthasdef,t.typname,CASE WHEN a.attlen=-1 THEN (CASE WHEN a.atttypmod=-1 THEN 0 ELSE a.atttypmod-4 END) ELSE a.attlen END as size " \
2761            "FROM pg_class c,pg_attribute a,pg_type t " \
2762            "WHERE c.relname=%s " \
2763            "AND c.oid=a.attrelid " \
2764            "AND a.atttypid=t.oid", (self._table,))
2765         return dict(map(lambda x: (x['attname'], x),cr.dictfetchall()))
2766
2767
2768     def _o2m_raise_on_missing_reference(self, cr, f):
2769         # TODO this check should be a method on fields.one2many.
2770         if f._obj in self.pool:
2771             other = self.pool[f._obj]
2772             # TODO the condition could use fields_get_keys().
2773             if f._fields_id not in other._columns.keys():
2774                 if f._fields_id not in other._inherit_fields.keys():
2775                     raise except_orm('Programming Error', "There is no reference field '%s' found for '%s'" % (f._fields_id, f._obj,))
2776
2777     def _m2m_raise_or_create_relation(self, cr, f):
2778         m2m_tbl, col1, col2 = f._sql_names(self)
2779         # do not create relations for custom fields as they do not belong to a module
2780         # they will be automatically removed when dropping the corresponding ir.model.field
2781         # table name for custom relation all starts with x_, see __init__
2782         if not m2m_tbl.startswith('x_'):
2783             self._save_relation_table(cr, m2m_tbl)
2784         cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (m2m_tbl,))
2785         if not cr.dictfetchall():
2786             if f._obj not in self.pool:
2787                 raise except_orm('Programming Error', 'Many2Many destination model does not exist: `%s`' % (f._obj,))
2788             dest_model = self.pool[f._obj]
2789             ref = dest_model._table
2790             cr.execute('CREATE TABLE "%s" ("%s" INTEGER NOT NULL, "%s" INTEGER NOT NULL, UNIQUE("%s","%s"))' % (m2m_tbl, col1, col2, col1, col2))
2791             # create foreign key references with ondelete=cascade, unless the targets are SQL views
2792             cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (ref,))
2793             if not cr.fetchall():
2794                 self._m2o_add_foreign_key_unchecked(m2m_tbl, col2, dest_model, 'cascade')
2795             cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (self._table,))
2796             if not cr.fetchall():
2797                 self._m2o_add_foreign_key_unchecked(m2m_tbl, col1, self, 'cascade')
2798
2799             cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col1, m2m_tbl, col1))
2800             cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col2, m2m_tbl, col2))
2801             cr.execute("COMMENT ON TABLE \"%s\" IS 'RELATION BETWEEN %s AND %s'" % (m2m_tbl, self._table, ref))
2802             cr.commit()
2803             _schema.debug("Create table '%s': m2m relation between '%s' and '%s'", m2m_tbl, self._table, ref)
2804
2805
2806     def _add_sql_constraints(self, cr):
2807         """
2808
2809         Modify this model's database table constraints so they match the one in
2810         _sql_constraints.
2811
2812         """
2813         def unify_cons_text(txt):
2814             return txt.lower().replace(', ',',').replace(' (','(')
2815
2816         for (key, con, _) in self._sql_constraints:
2817             conname = '%s_%s' % (self._table, key)
2818
2819             self._save_constraint(cr, conname, 'u')
2820             cr.execute("SELECT conname, pg_catalog.pg_get_constraintdef(oid, true) as condef FROM pg_constraint where conname=%s", (conname,))
2821             existing_constraints = cr.dictfetchall()
2822             sql_actions = {
2823                 'drop': {
2824                     'execute': False,
2825                     'query': 'ALTER TABLE "%s" DROP CONSTRAINT "%s"' % (self._table, conname, ),
2826                     'msg_ok': "Table '%s': dropped constraint '%s'. Reason: its definition changed from '%%s' to '%s'" % (
2827                         self._table, conname, con),
2828                     'msg_err': "Table '%s': unable to drop \'%s\' constraint !" % (self._table, con),
2829                     'order': 1,
2830                 },
2831                 'add': {
2832                     'execute': False,
2833                     'query': 'ALTER TABLE "%s" ADD CONSTRAINT "%s" %s' % (self._table, conname, con,),
2834                     'msg_ok': "Table '%s': added constraint '%s' with definition=%s" % (self._table, conname, con),
2835                     'msg_err': "Table '%s': unable to add \'%s\' constraint !\n If you want to have it, you should update the records and execute manually:\n%%s" % (
2836                         self._table, con),
2837                     'order': 2,
2838                 },
2839             }
2840
2841             if not existing_constraints:
2842                 # constraint does not exists:
2843                 sql_actions['add']['execute'] = True
2844                 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2845             elif unify_cons_text(con) not in [unify_cons_text(item['condef']) for item in existing_constraints]:
2846                 # constraint exists but its definition has changed:
2847                 sql_actions['drop']['execute'] = True
2848                 sql_actions['drop']['msg_ok'] = sql_actions['drop']['msg_ok'] % (existing_constraints[0]['condef'].lower(), )
2849                 sql_actions['add']['execute'] = True
2850                 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2851
2852             # we need to add the constraint:
2853             sql_actions = [item for item in sql_actions.values()]
2854             sql_actions.sort(key=lambda x: x['order'])
2855             for sql_action in [action for action in sql_actions if action['execute']]:
2856                 try:
2857                     cr.execute(sql_action['query'])
2858                     cr.commit()
2859                     _schema.debug(sql_action['msg_ok'])
2860                 except:
2861                     _schema.warning(sql_action['msg_err'])
2862                     cr.rollback()
2863
2864
2865     def _execute_sql(self, cr):
2866         """ Execute the SQL code from the _sql attribute (if any)."""
2867         if hasattr(self, "_sql"):
2868             for line in self._sql.split(';'):
2869                 line2 = line.replace('\n', '').strip()
2870                 if line2:
2871                     cr.execute(line2)
2872                     cr.commit()
2873
2874     #
2875     # Update objects that uses this one to update their _inherits fields
2876     #
2877
2878     @classmethod
2879     def _inherits_reload_src(cls):
2880         """ Recompute the _inherit_fields mapping on each _inherits'd child model."""
2881         for model in cls.pool.values():
2882             if cls._name in model._inherits:
2883                 model._inherits_reload()
2884
2885     @classmethod
2886     def _inherits_reload(cls):
2887         """ Recompute the _inherit_fields mapping.
2888
2889         This will also call itself on each inherits'd child model.
2890
2891         """
2892         res = {}
2893         for table in cls._inherits:
2894             other = cls.pool[table]
2895             for col in other._columns.keys():
2896                 res[col] = (table, cls._inherits[table], other._columns[col], table)
2897             for col in other._inherit_fields.keys():
2898                 res[col] = (table, cls._inherits[table], other._inherit_fields[col][2], other._inherit_fields[col][3])
2899         cls._inherit_fields = res
2900         cls._all_columns = cls._get_column_infos()
2901
2902         # interface columns with new-style fields
2903         for attr, column in cls._columns.items():
2904             if attr not in cls._fields:
2905                 cls._add_field(attr, column.to_field())
2906
2907         # interface inherited fields with new-style fields (note that the
2908         # reverse order is for being consistent with _all_columns above)
2909         for parent_model, parent_field in reversed(cls._inherits.items()):
2910             for attr, field in cls.pool[parent_model]._fields.iteritems():
2911                 if attr not in cls._fields:
2912                     new_field = field.copy(related=(parent_field, attr), _origin=field)
2913                     cls._add_field(attr, new_field)
2914
2915         cls._inherits_reload_src()
2916
2917     @classmethod
2918     def _get_column_infos(cls):
2919         """Returns a dict mapping all fields names (direct fields and
2920            inherited field via _inherits) to a ``column_info`` struct
2921            giving detailed columns """
2922         result = {}
2923         # do not inverse for loops, since local fields may hide inherited ones!
2924         for k, (parent, m2o, col, original_parent) in cls._inherit_fields.iteritems():
2925             result[k] = fields.column_info(k, col, parent, m2o, original_parent)
2926         for k, col in cls._columns.iteritems():
2927             result[k] = fields.column_info(k, col)
2928         return result
2929
2930     @classmethod
2931     def _inherits_check(cls):
2932         for table, field_name in cls._inherits.items():
2933             if field_name not in cls._columns:
2934                 _logger.info('Missing many2one field definition for _inherits reference "%s" in "%s", using default one.', field_name, cls._name)
2935                 cls._columns[field_name] = fields.many2one(table, string="Automatically created field to link to parent %s" % table,
2936                                                              required=True, ondelete="cascade")
2937             elif not cls._columns[field_name].required or cls._columns[field_name].ondelete.lower() not in ("cascade", "restrict"):
2938                 _logger.warning('Field definition for _inherits reference "%s" in "%s" must be marked as "required" with ondelete="cascade" or "restrict", forcing it to required + cascade.', field_name, cls._name)
2939                 cls._columns[field_name].required = True
2940                 cls._columns[field_name].ondelete = "cascade"
2941
2942         # reflect fields with delegate=True in dictionary cls._inherits
2943         for field in cls._fields.itervalues():
2944             if field.type == 'many2one' and not field.related and field.delegate:
2945                 if not field.required:
2946                     _logger.warning("Field %s with delegate=True must be required.", field)
2947                     field.required = True
2948                 if field.ondelete.lower() not in ('cascade', 'restrict'):
2949                     field.ondelete = 'cascade'
2950                 cls._inherits[field.comodel_name] = field.name
2951
2952     @api.model
2953     def _prepare_setup_fields(self):
2954         """ Prepare the setup of fields once the models have been loaded. """
2955         for field in self._fields.itervalues():
2956             field.reset()
2957
2958     @api.model
2959     def _setup_fields(self):
2960         """ Setup the fields (dependency triggers, etc). """
2961         for field in self._fields.itervalues():
2962             field.setup(self.env)
2963
2964         # group fields by compute to determine field.computed_fields
2965         fields_by_compute = defaultdict(list)
2966         for field in self._fields.itervalues():
2967             if field.compute:
2968                 field.computed_fields = fields_by_compute[field.compute]
2969                 field.computed_fields.append(field)
2970             else:
2971                 field.computed_fields = []
2972
2973     def fields_get(self, cr, user, allfields=None, context=None, write_access=True):
2974         """ Return the definition of each field.
2975
2976         The returned value is a dictionary (indiced by field name) of
2977         dictionaries. The _inherits'd fields are included. The string, help,
2978         and selection (if present) attributes are translated.
2979
2980         :param cr: database cursor
2981         :param user: current user id
2982         :param allfields: list of fields
2983         :param context: context arguments, like lang, time zone
2984         :return: dictionary of field dictionaries, each one describing a field of the business object
2985         :raise AccessError: * if user has no create/write rights on the requested object
2986
2987         """
2988         recs = self.browse(cr, user, [], context)
2989
2990         res = {}
2991         for fname, field in self._fields.iteritems():
2992             if allfields and fname not in allfields:
2993                 continue
2994             if field.groups and not recs.user_has_groups(field.groups):
2995                 continue
2996             res[fname] = field.get_description(recs.env)
2997
2998         # if user cannot create or modify records, make all fields readonly
2999         has_access = functools.partial(recs.check_access_rights, raise_exception=False)
3000         if not (has_access('write') or has_access('create')):
3001             for description in res.itervalues():
3002                 description['readonly'] = True
3003                 description['states'] = {}
3004
3005         return res
3006
3007     def get_empty_list_help(self, cr, user, help, context=None):
3008         """ Generic method giving the help message displayed when having
3009             no result to display in a list or kanban view. By default it returns
3010             the help given in parameter that is generally the help message
3011             defined in the action.
3012         """
3013         return help
3014
3015     def check_field_access_rights(self, cr, user, operation, fields, context=None):
3016         """
3017         Check the user access rights on the given fields. This raises Access
3018         Denied if the user does not have the rights. Otherwise it returns the
3019         fields (as is if the fields is not falsy, or the readable/writable
3020         fields if fields is falsy).
3021         """
3022         if user == SUPERUSER_ID:
3023             return fields or list(self._fields)
3024
3025         def valid(fname):
3026             """ determine whether user has access to field `fname` """
3027             field = self._fields.get(fname)
3028             if field and field.groups:
3029                 return self.user_has_groups(cr, user, groups=field.groups, context=context)
3030             else:
3031                 return True
3032
3033         if not fields:
3034             fields = filter(valid, self._fields)
3035         else:
3036             invalid_fields = set(filter(lambda name: not valid(name), fields))
3037             if invalid_fields:
3038                 _logger.warning('Access Denied by ACLs for operation: %s, uid: %s, model: %s, fields: %s',
3039                     operation, user, self._name, ', '.join(invalid_fields))
3040                 raise AccessError(
3041                     _('The requested operation cannot be completed due to security restrictions. '
3042                     'Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3043                     (self._description, operation))
3044
3045         return fields
3046
3047     # new-style implementation of read(); old-style is defined below
3048     @api.v8
3049     def read(self, fields=None, load='_classic_read'):
3050         """ Read the given fields for the records in `self`.
3051
3052             :param fields: optional list of field names to return (default is
3053                     all fields)
3054             :param load: deprecated, this argument is ignored
3055             :return: a list of dictionaries mapping field names to their values,
3056                     with one dictionary per record
3057             :raise AccessError: if user has no read rights on some of the given
3058                     records
3059         """
3060         # check access rights
3061         self.check_access_rights('read')
3062         fields = self.check_field_access_rights('read', fields)
3063
3064         # split fields into stored and computed fields
3065         stored, computed = [], []
3066         for name in fields:
3067             if name in self._columns:
3068                 stored.append(name)
3069             elif name in self._fields:
3070                 computed.append(name)
3071             else:
3072                 _logger.warning("%s.read() with unknown field '%s'", self._name, name)
3073
3074         # fetch stored fields from the database to the cache
3075         self._read_from_database(stored)
3076
3077         # retrieve results from records; this takes values from the cache and
3078         # computes remaining fields
3079         result = []
3080         name_fields = [(name, self._fields[name]) for name in (stored + computed)]
3081         use_name_get = (load == '_classic_read')
3082         for record in self:
3083             try:
3084                 values = {'id': record.id}
3085                 for name, field in name_fields:
3086                     values[name] = field.convert_to_read(record[name], use_name_get)
3087                 result.append(values)
3088             except MissingError:
3089                 pass
3090
3091         return result
3092
3093     # add explicit old-style implementation to read()
3094     @api.v7
3095     def read(self, cr, user, ids, fields=None, context=None, load='_classic_read'):
3096         records = self.browse(cr, user, ids, context)
3097         result = BaseModel.read(records, fields, load=load)
3098         return result if isinstance(ids, list) else (bool(result) and result[0])
3099
3100     @api.multi
3101     def _prefetch_field(self, field):
3102         """ Read from the database in order to fetch `field` (:class:`Field`
3103             instance) for `self` in cache.
3104         """
3105         # fetch the records of this model without field_name in their cache
3106         records = self
3107
3108         # by default, simply fetch field
3109         fnames = {field.name}
3110
3111         if self.env.in_draft:
3112             # we may be doing an onchange, do not prefetch other fields
3113             pass
3114         elif field in self.env.todo:
3115             # field must be recomputed, do not prefetch records to recompute
3116             records -= self.env.todo[field]
3117         elif self._columns[field.name]._prefetch:
3118             # here we can optimize: prefetch all classic and many2one fields
3119             fnames = set(fname
3120                 for fname, fcolumn in self._columns.iteritems()
3121                 if fcolumn._prefetch)
3122
3123         # fetch records with read()
3124         assert self in records and field.name in fnames
3125         result = []
3126         try:
3127             result = records.read(list(fnames), load='_classic_write')
3128         except AccessError:
3129             pass
3130
3131         # check the cache, and update it if necessary
3132         if field not in self._cache:
3133             for values in result:
3134                 record = self.browse(values.pop('id'))
3135                 record._cache.update(record._convert_to_cache(values, validate=False))
3136             if field not in self._cache:
3137                 e = AccessError("No value found for %s.%s" % (self, field.name))
3138                 self._cache[field] = FailedValue(e)
3139
3140     @api.multi
3141     def _read_from_database(self, field_names):
3142         """ Read the given fields of the records in `self` from the database,
3143             and store them in cache. Access errors are also stored in cache.
3144         """
3145         env = self.env
3146         cr, user, context = env.args
3147
3148         # Construct a clause for the security rules.
3149         # 'tables' holds the list of tables necessary for the SELECT, including
3150         # the ir.rule clauses, and contains at least self._table.
3151         rule_clause, rule_params, tables = env['ir.rule'].domain_get(self._name, 'read')
3152
3153         # determine the fields that are stored as columns in self._table
3154         fields_pre = [f for f in field_names if self._columns[f]._classic_write]
3155
3156         # we need fully-qualified column names in case len(tables) > 1
3157         def qualify(f):
3158             if isinstance(self._columns.get(f), fields.binary) and \
3159                     context.get('bin_size_%s' % f, context.get('bin_size')):
3160                 # PG 9.2 introduces conflicting pg_size_pretty(numeric) -> need ::cast
3161                 return 'pg_size_pretty(length(%s."%s")::bigint) as "%s"' % (self._table, f, f)
3162             else:
3163                 return '%s."%s"' % (self._table, f)
3164         qual_names = map(qualify, set(fields_pre + ['id']))
3165
3166         query = """ SELECT %(qual_names)s FROM %(tables)s
3167                     WHERE %(table)s.id IN %%s AND (%(extra)s)
3168                     ORDER BY %(order)s
3169                 """ % {
3170                     'qual_names': ",".join(qual_names),
3171                     'tables': ",".join(tables),
3172                     'table': self._table,
3173                     'extra': " OR ".join(rule_clause) if rule_clause else "TRUE",
3174                     'order': self._parent_order or self._order,
3175                 }
3176
3177         empty = self.browse()
3178         prefetch = set()
3179         todo = set()
3180         for field in (self._fields[name] for name in field_names):
3181             prefetch.update(self._in_cache_without(field).ids)
3182             todo.update(self.env.todo.get(field, empty).ids)
3183         records = self.browse(prefetch - todo | set(self.ids))
3184
3185         result = []
3186         for sub_ids in cr.split_for_in_conditions(records.ids):
3187             cr.execute(query, [tuple(sub_ids)] + rule_params)
3188             result.extend(cr.dictfetchall())
3189
3190         ids = [vals['id'] for vals in result]
3191
3192         if ids:
3193             # translate the fields if necessary
3194             if context.get('lang'):
3195                 ir_translation = env['ir.translation']
3196                 for f in fields_pre:
3197                     if self._columns[f].translate:
3198                         #TODO: optimize out of this loop
3199                         res_trans = ir_translation._get_ids(
3200                             '%s,%s' % (self._name, f), 'model', context['lang'], ids)
3201                         for vals in result:
3202                             vals[f] = res_trans.get(vals['id'], False) or vals[f]
3203
3204             # apply the symbol_get functions of the fields we just read
3205             for f in fields_pre:
3206                 symbol_get = self._columns[f]._symbol_get
3207                 if symbol_get:
3208                     for vals in result:
3209                         vals[f] = symbol_get(vals[f])
3210
3211             # store result in cache for POST fields
3212             for vals in result:
3213                 record = self.browse(vals['id'])
3214                 record._cache.update(record._convert_to_cache(vals, validate=False))
3215
3216             # determine the fields that must be processed now
3217             fields_post = [f for f in field_names if not self._columns[f]._classic_write]
3218
3219             # Compute POST fields, grouped by multi
3220             by_multi = defaultdict(list)
3221             for f in fields_post:
3222                 by_multi[self._columns[f]._multi].append(f)
3223
3224             for multi, fs in by_multi.iteritems():
3225                 if multi:
3226                     res2 = self._columns[fs[0]].get(cr, self._model, ids, fs, user, context=context, values=result)
3227                     assert res2 is not None, \
3228                         'The function field "%s" on the "%s" model returned None\n' \
3229                         '(a dictionary was expected).' % (fs[0], self._name)
3230                     for vals in result:
3231                         # TOCHECK : why got string instend of dict in python2.6
3232                         # if isinstance(res2[vals['id']], str): res2[vals['id']] = eval(res2[vals['id']])
3233                         multi_fields = res2.get(vals['id'], {})
3234                         if multi_fields:
3235                             for f in fs:
3236                                 vals[f] = multi_fields.get(f, [])
3237                 else:
3238                     for f in fs:
3239                         res2 = self._columns[f].get(cr, self._model, ids, f, user, context=context, values=result)
3240                         for vals in result:
3241                             if res2:
3242                                 vals[f] = res2[vals['id']]
3243                             else:
3244                                 vals[f] = []
3245
3246         # Warn about deprecated fields now that fields_pre and fields_post are computed
3247         for f in field_names:
3248             column = self._columns[f]
3249             if column.deprecated:
3250                 _logger.warning('Field %s.%s is deprecated: %s', self._name, f, column.deprecated)
3251
3252         # store result in cache
3253         for vals in result:
3254             record = self.browse(vals.pop('id'))
3255             record._cache.update(record._convert_to_cache(vals, validate=False))
3256
3257         # store failed values in cache for the records that could not be read
3258         fetched = self.browse(ids)
3259         missing = records - fetched
3260         if missing:
3261             extras = fetched - records
3262             if extras:
3263                 raise AccessError(
3264                     _("Database fetch misses ids ({}) and has extra ids ({}), may be caused by a type incoherence in a previous request").format(
3265                         ', '.join(map(repr, missing._ids)),
3266                         ', '.join(map(repr, extras._ids)),
3267                     ))
3268             # store an access error exception in existing records
3269             exc = AccessError(
3270                 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3271                 (self._name, 'read')
3272             )
3273             forbidden = missing.exists()
3274             forbidden._cache.update(FailedValue(exc))
3275             # store a missing error exception in non-existing records
3276             exc = MissingError(
3277                 _('One of the documents you are trying to access has been deleted, please try again after refreshing.')
3278             )
3279             (missing - forbidden)._cache.update(FailedValue(exc))
3280
3281     @api.multi
3282     def get_metadata(self):
3283         """
3284         Returns some metadata about the given records.
3285
3286         :return: list of ownership dictionaries for each requested record
3287         :rtype: list of dictionaries with the following keys:
3288
3289                     * id: object id
3290                     * create_uid: user who created the record
3291                     * create_date: date when the record was created
3292                     * write_uid: last user who changed the record
3293                     * write_date: date of the last change to the record
3294                     * xmlid: XML ID to use to refer to this record (if there is one), in format ``module.name``
3295         """
3296         fields = ['id']
3297         if self._log_access:
3298             fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
3299         quoted_table = '"%s"' % self._table
3300         fields_str = ",".join('%s.%s' % (quoted_table, field) for field in fields)
3301         query = '''SELECT %s, __imd.module, __imd.name
3302                    FROM %s LEFT JOIN ir_model_data __imd
3303                        ON (__imd.model = %%s and __imd.res_id = %s.id)
3304                    WHERE %s.id IN %%s''' % (fields_str, quoted_table, quoted_table, quoted_table)
3305         self._cr.execute(query, (self._name, tuple(self.ids)))
3306         res = self._cr.dictfetchall()
3307
3308         uids = set(r[k] for r in res for k in ['write_uid', 'create_uid'] if r.get(k))
3309         names = dict(self.env['res.users'].browse(uids).name_get())
3310
3311         for r in res:
3312             for key in r:
3313                 value = r[key] = r[key] or False
3314                 if key in ('write_uid', 'create_uid') and value in names:
3315                     r[key] = (value, names[value])
3316             r['xmlid'] = ("%(module)s.%(name)s" % r) if r['name'] else False
3317             del r['name'], r['module']
3318         return res
3319
3320     def _check_concurrency(self, cr, ids, context):
3321         if not context:
3322             return
3323         if not (context.get(self.CONCURRENCY_CHECK_FIELD) and self._log_access):
3324             return
3325         check_clause = "(id = %s AND %s < COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp)"
3326         for sub_ids in cr.split_for_in_conditions(ids):
3327             ids_to_check = []
3328             for id in sub_ids:
3329                 id_ref = "%s,%s" % (self._name, id)
3330                 update_date = context[self.CONCURRENCY_CHECK_FIELD].pop(id_ref, None)
3331                 if update_date:
3332                     ids_to_check.extend([id, update_date])
3333             if not ids_to_check:
3334                 continue
3335             cr.execute("SELECT id FROM %s WHERE %s" % (self._table, " OR ".join([check_clause]*(len(ids_to_check)/2))), tuple(ids_to_check))
3336             res = cr.fetchone()
3337             if res:
3338                 # mention the first one only to keep the error message readable
3339                 raise except_orm('ConcurrencyException', _('A document was modified since you last viewed it (%s:%d)') % (self._description, res[0]))
3340
3341     def _check_record_rules_result_count(self, cr, uid, ids, result_ids, operation, context=None):
3342         """Verify the returned rows after applying record rules matches
3343            the length of `ids`, and raise an appropriate exception if it does not.
3344         """
3345         if context is None:
3346             context = {}
3347         ids, result_ids = set(ids), set(result_ids)
3348         missing_ids = ids - result_ids
3349         if missing_ids:
3350             # Attempt to distinguish record rule restriction vs deleted records,
3351             # to provide a more specific error message - check if the missinf
3352             cr.execute('SELECT id FROM ' + self._table + ' WHERE id IN %s', (tuple(missing_ids),))
3353             forbidden_ids = [x[0] for x in cr.fetchall()]
3354             if forbidden_ids:
3355                 # the missing ids are (at least partially) hidden by access rules
3356                 if uid == SUPERUSER_ID:
3357                     return
3358                 _logger.warning('Access Denied by record rules for operation: %s on record ids: %r, uid: %s, model: %s', operation, forbidden_ids, uid, self._name)
3359                 raise except_orm(_('Access Denied'),
3360                                  _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3361                                     (self._description, operation))
3362             else:
3363                 # If we get here, the missing_ids are not in the database
3364                 if operation in ('read','unlink'):
3365                     # No need to warn about deleting an already deleted record.
3366                     # And no error when reading a record that was deleted, to prevent spurious
3367                     # errors for non-transactional search/read sequences coming from clients
3368                     return
3369                 _logger.warning('Failed operation on deleted record(s): %s, uid: %s, model: %s', operation, uid, self._name)
3370                 raise except_orm(_('Missing document(s)'),
3371                                  _('One of the documents you are trying to access has been deleted, please try again after refreshing.'))
3372
3373
3374     def check_access_rights(self, cr, uid, operation, raise_exception=True): # no context on purpose.
3375         """Verifies that the operation given by ``operation`` is allowed for the user
3376            according to the access rights."""
3377         return self.pool.get('ir.model.access').check(cr, uid, self._name, operation, raise_exception)
3378
3379     def check_access_rule(self, cr, uid, ids, operation, context=None):
3380         """Verifies that the operation given by ``operation`` is allowed for the user
3381            according to ir.rules.
3382
3383            :param operation: one of ``write``, ``unlink``
3384            :raise except_orm: * if current ir.rules do not permit this operation.
3385            :return: None if the operation is allowed
3386         """
3387         if uid == SUPERUSER_ID:
3388             return
3389
3390         if self.is_transient():
3391             # Only one single implicit access rule for transient models: owner only!
3392             # This is ok to hardcode because we assert that TransientModels always
3393             # have log_access enabled so that the create_uid column is always there.
3394             # And even with _inherits, these fields are always present in the local
3395             # table too, so no need for JOINs.
3396             cr.execute("""SELECT distinct create_uid
3397                           FROM %s
3398                           WHERE id IN %%s""" % self._table, (tuple(ids),))
3399             uids = [x[0] for x in cr.fetchall()]
3400             if len(uids) != 1 or uids[0] != uid:
3401                 raise except_orm(_('Access Denied'),
3402                                  _('For this kind of document, you may only access records you created yourself.\n\n(Document type: %s)') % (self._description,))
3403         else:
3404             where_clause, where_params, tables = self.pool.get('ir.rule').domain_get(cr, uid, self._name, operation, context=context)
3405             if where_clause:
3406                 where_clause = ' and ' + ' and '.join(where_clause)
3407                 for sub_ids in cr.split_for_in_conditions(ids):
3408                     cr.execute('SELECT ' + self._table + '.id FROM ' + ','.join(tables) +
3409                                ' WHERE ' + self._table + '.id IN %s' + where_clause,
3410                                [sub_ids] + where_params)
3411                     returned_ids = [x['id'] for x in cr.dictfetchall()]
3412                     self._check_record_rules_result_count(cr, uid, sub_ids, returned_ids, operation, context=context)
3413
3414     def create_workflow(self, cr, uid, ids, context=None):
3415         """Create a workflow instance for each given record IDs."""
3416         from openerp import workflow
3417         for res_id in ids:
3418             workflow.trg_create(uid, self._name, res_id, cr)
3419         # self.invalidate_cache(cr, uid, context=context) ?
3420         return True
3421
3422     def delete_workflow(self, cr, uid, ids, context=None):
3423         """Delete the workflow instances bound to the given record IDs."""
3424         from openerp import workflow
3425         for res_id in ids:
3426             workflow.trg_delete(uid, self._name, res_id, cr)
3427         self.invalidate_cache(cr, uid, context=context)
3428         return True
3429
3430     def step_workflow(self, cr, uid, ids, context=None):
3431         """Reevaluate the workflow instances of the given record IDs."""
3432         from openerp import workflow
3433         for res_id in ids:
3434             workflow.trg_write(uid, self._name, res_id, cr)
3435         # self.invalidate_cache(cr, uid, context=context) ?
3436         return True
3437
3438     def signal_workflow(self, cr, uid, ids, signal, context=None):
3439         """Send given workflow signal and return a dict mapping ids to workflow results"""
3440         from openerp import workflow
3441         result = {}
3442         for res_id in ids:
3443             result[res_id] = workflow.trg_validate(uid, self._name, res_id, signal, cr)
3444         # self.invalidate_cache(cr, uid, context=context) ?
3445         return result
3446
3447     def redirect_workflow(self, cr, uid, old_new_ids, context=None):
3448         """ Rebind the workflow instance bound to the given 'old' record IDs to
3449             the given 'new' IDs. (``old_new_ids`` is a list of pairs ``(old, new)``.
3450         """
3451         from openerp import workflow
3452         for old_id, new_id in old_new_ids:
3453             workflow.trg_redirect(uid, self._name, old_id, new_id, cr)
3454         self.invalidate_cache(cr, uid, context=context)
3455         return True
3456
3457     def unlink(self, cr, uid, ids, context=None):
3458         """
3459         Delete records with given ids
3460
3461         :param cr: database cursor
3462         :param uid: current user id
3463         :param ids: id or list of ids
3464         :param context: (optional) context arguments, like lang, time zone
3465         :return: True
3466         :raise AccessError: * if user has no unlink rights on the requested object
3467                             * if user tries to bypass access rules for unlink on the requested object
3468         :raise UserError: if the record is default property for other records
3469
3470         """
3471         if not ids:
3472             return True
3473         if isinstance(ids, (int, long)):
3474             ids = [ids]
3475
3476         result_store = self._store_get_values(cr, uid, ids, self._all_columns.keys(), context)
3477
3478         # for recomputing new-style fields
3479         recs = self.browse(cr, uid, ids, context)
3480         recs.modified(self._fields)
3481
3482         self._check_concurrency(cr, ids, context)
3483
3484         self.check_access_rights(cr, uid, 'unlink')
3485
3486         ir_property = self.pool.get('ir.property')
3487
3488         # Check if the records are used as default properties.
3489         domain = [('res_id', '=', False),
3490                   ('value_reference', 'in', ['%s,%s' % (self._name, i) for i in ids]),
3491                  ]
3492         if ir_property.search(cr, uid, domain, context=context):
3493             raise except_orm(_('Error'), _('Unable to delete this document because it is used as a default property'))
3494
3495         # Delete the records' properties.
3496         property_ids = ir_property.search(cr, uid, [('res_id', 'in', ['%s,%s' % (self._name, i) for i in ids])], context=context)
3497         ir_property.unlink(cr, uid, property_ids, context=context)
3498
3499         self.delete_workflow(cr, uid, ids, context=context)
3500
3501         self.check_access_rule(cr, uid, ids, 'unlink', context=context)
3502         pool_model_data = self.pool.get('ir.model.data')
3503         ir_values_obj = self.pool.get('ir.values')
3504         for sub_ids in cr.split_for_in_conditions(ids):
3505             cr.execute('delete from ' + self._table + ' ' \
3506                        'where id IN %s', (sub_ids,))
3507
3508             # Removing the ir_model_data reference if the record being deleted is a record created by xml/csv file,
3509             # as these are not connected with real database foreign keys, and would be dangling references.
3510             # Note: following steps performed as admin to avoid access rights restrictions, and with no context
3511             #       to avoid possible side-effects during admin calls.
3512             # Step 1. Calling unlink of ir_model_data only for the affected IDS
3513             reference_ids = pool_model_data.search(cr, SUPERUSER_ID, [('res_id','in',list(sub_ids)),('model','=',self._name)])
3514             # Step 2. Marching towards the real deletion of referenced records
3515             if reference_ids:
3516                 pool_model_data.unlink(cr, SUPERUSER_ID, reference_ids)
3517
3518             # For the same reason, removing the record relevant to ir_values
3519             ir_value_ids = ir_values_obj.search(cr, uid,
3520                     ['|',('value','in',['%s,%s' % (self._name, sid) for sid in sub_ids]),'&',('res_id','in',list(sub_ids)),('model','=',self._name)],
3521                     context=context)
3522             if ir_value_ids:
3523                 ir_values_obj.unlink(cr, uid, ir_value_ids, context=context)
3524
3525         # invalidate the *whole* cache, since the orm does not handle all
3526         # changes made in the database, like cascading delete!
3527         recs.invalidate_cache()
3528
3529         for order, obj_name, store_ids, fields in result_store:
3530             if obj_name == self._name:
3531                 effective_store_ids = set(store_ids) - set(ids)
3532             else:
3533                 effective_store_ids = store_ids
3534             if effective_store_ids:
3535                 obj = self.pool[obj_name]
3536                 cr.execute('select id from '+obj._table+' where id IN %s', (tuple(effective_store_ids),))
3537                 rids = map(lambda x: x[0], cr.fetchall())
3538                 if rids:
3539                     obj._store_set_values(cr, uid, rids, fields, context)
3540
3541         # recompute new-style fields
3542         recs.recompute()
3543
3544         return True
3545
3546     #
3547     # TODO: Validate
3548     #
3549     @api.multi
3550     def write(self, vals):
3551         """
3552         Update records in `self` with the given field values.
3553
3554         :param vals: field values to update, e.g {'field_name': new_field_value, ...}
3555         :type vals: dictionary
3556         :return: True
3557         :raise AccessError: * if user has no write rights on the requested object
3558                             * if user tries to bypass access rules for write on the requested object
3559         :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3560         :raise UserError: if a loop would be created in a hierarchy of objects a result of the operation (such as setting an object as its own parent)
3561
3562         **Note**: The type of field values to pass in ``vals`` for relationship fields is specific:
3563
3564             + For a many2many field, a list of tuples is expected.
3565               Here is the list of tuple that are accepted, with the corresponding semantics ::
3566
3567                  (0, 0,  { values })    link to a new record that needs to be created with the given values dictionary
3568                  (1, ID, { values })    update the linked record with id = ID (write *values* on it)
3569                  (2, ID)                remove and delete the linked record with id = ID (calls unlink on ID, that will delete the object completely, and the link to it as well)
3570                  (3, ID)                cut the link to the linked record with id = ID (delete the relationship between the two objects but does not delete the target object itself)
3571                  (4, ID)                link to existing record with id = ID (adds a relationship)
3572                  (5)                    unlink all (like using (3,ID) for all linked records)
3573                  (6, 0, [IDs])          replace the list of linked IDs (like using (5) then (4,ID) for each ID in the list of IDs)
3574
3575                  Example:
3576                     [(6, 0, [8, 5, 6, 4])] sets the many2many to ids [8, 5, 6, 4]
3577
3578             + For a one2many field, a lits of tuples is expected.
3579               Here is the list of tuple that are accepted, with the corresponding semantics ::
3580
3581                  (0, 0,  { values })    link to a new record that needs to be created with the given values dictionary
3582                  (1, ID, { values })    update the linked record with id = ID (write *values* on it)
3583                  (2, ID)                remove and delete the linked record with id = ID (calls unlink on ID, that will delete the object completely, and the link to it as well)
3584
3585                  Example:
3586                     [(0, 0, {'field_name':field_value_record1, ...}), (0, 0, {'field_name':field_value_record2, ...})]
3587
3588             + For a many2one field, simply use the ID of target record, which must already exist, or ``False`` to remove the link.
3589             + For a reference field, use a string with the model name, a comma, and the target object id (example: ``'product.product, 5'``)
3590
3591         """
3592         if not self:
3593             return True
3594
3595         self._check_concurrency(self._ids)
3596         self.check_access_rights('write')
3597
3598         # No user-driven update of these columns
3599         for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3600             vals.pop(field, None)
3601
3602         # split up fields into old-style and pure new-style ones
3603         old_vals, new_vals, unknown = {}, {}, []
3604         for key, val in vals.iteritems():
3605             if key in self._columns:
3606                 old_vals[key] = val
3607             elif key in self._fields:
3608                 new_vals[key] = val
3609             else:
3610                 unknown.append(key)
3611
3612         if unknown:
3613             _logger.warning("%s.write() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3614
3615         # write old-style fields with (low-level) method _write
3616         if old_vals:
3617             self._write(old_vals)
3618
3619         # put the values of pure new-style fields into cache, and inverse them
3620         if new_vals:
3621             self._cache.update(self._convert_to_cache(new_vals))
3622             for key in new_vals:
3623                 self._fields[key].determine_inverse(self)
3624
3625         return True
3626
3627     def _write(self, cr, user, ids, vals, context=None):
3628         # low-level implementation of write()
3629         if not context:
3630             context = {}
3631
3632         readonly = None
3633         self.check_field_access_rights(cr, user, 'write', vals.keys())
3634         for field in vals.keys():
3635             fobj = None
3636             if field in self._columns:
3637                 fobj = self._columns[field]
3638             elif field in self._inherit_fields:
3639                 fobj = self._inherit_fields[field][2]
3640             if not fobj:
3641                 continue
3642             groups = fobj.write
3643
3644             if groups:
3645                 edit = False
3646                 for group in groups:
3647                     module = group.split(".")[0]
3648                     grp = group.split(".")[1]
3649                     cr.execute("select count(*) from res_groups_users_rel where gid IN (select res_id from ir_model_data where name=%s and module=%s and model=%s) and uid=%s", \
3650                                (grp, module, 'res.groups', user))
3651                     readonly = cr.fetchall()
3652                     if readonly[0][0] >= 1:
3653                         edit = True
3654                         break
3655
3656                 if not edit:
3657                     vals.pop(field)
3658
3659         result = self._store_get_values(cr, user, ids, vals.keys(), context) or []
3660
3661         # for recomputing new-style fields
3662         recs = self.browse(cr, user, ids, context)
3663         modified_fields = list(vals)
3664         if self._log_access:
3665             modified_fields += ['write_date', 'write_uid']
3666         recs.modified(modified_fields)
3667
3668         parents_changed = []
3669         parent_order = self._parent_order or self._order
3670         if self._parent_store and (self._parent_name in vals) and not context.get('defer_parent_store_computation'):
3671             # The parent_left/right computation may take up to
3672             # 5 seconds. No need to recompute the values if the
3673             # parent is the same.
3674             # Note: to respect parent_order, nodes must be processed in
3675             # order, so ``parents_changed`` must be ordered properly.
3676             parent_val = vals[self._parent_name]
3677             if parent_val:
3678                 query = "SELECT id FROM %s WHERE id IN %%s AND (%s != %%s OR %s IS NULL) ORDER BY %s" % \
3679                                 (self._table, self._parent_name, self._parent_name, parent_order)
3680                 cr.execute(query, (tuple(ids), parent_val))
3681             else:
3682                 query = "SELECT id FROM %s WHERE id IN %%s AND (%s IS NOT NULL) ORDER BY %s" % \
3683                                 (self._table, self._parent_name, parent_order)
3684                 cr.execute(query, (tuple(ids),))
3685             parents_changed = map(operator.itemgetter(0), cr.fetchall())
3686
3687         upd0 = []
3688         upd1 = []
3689         upd_todo = []
3690         updend = []
3691         direct = []
3692         totranslate = context.get('lang', False) and (context['lang'] != 'en_US')
3693         for field in vals:
3694             field_column = self._all_columns.get(field) and self._all_columns.get(field).column
3695             if field_column and field_column.deprecated:
3696                 _logger.warning('Field %s.%s is deprecated: %s', self._name, field, field_column.deprecated)
3697             if field in self._columns:
3698                 if self._columns[field]._classic_write and not (hasattr(self._columns[field], '_fnct_inv')):
3699                     if (not totranslate) or not self._columns[field].translate:
3700                         upd0.append('"'+field+'"='+self._columns[field]._symbol_set[0])
3701                         upd1.append(self._columns[field]._symbol_set[1](vals[field]))
3702                     direct.append(field)
3703                 else:
3704                     upd_todo.append(field)
3705             else:
3706                 updend.append(field)
3707             if field in self._columns \
3708                     and hasattr(self._columns[field], 'selection') \
3709                     and vals[field]:
3710                 self._check_selection_field_value(cr, user, field, vals[field], context=context)
3711
3712         if self._log_access:
3713             upd0.append('write_uid=%s')
3714             upd0.append("write_date=(now() at time zone 'UTC')")
3715             upd1.append(user)
3716
3717         if len(upd0):
3718             self.check_access_rule(cr, user, ids, 'write', context=context)
3719             for sub_ids in cr.split_for_in_conditions(ids):
3720                 cr.execute('update ' + self._table + ' set ' + ','.join(upd0) + ' ' \
3721                            'where id IN %s', upd1 + [sub_ids])
3722                 if cr.rowcount != len(sub_ids):
3723                     raise MissingError(_('One of the records you are trying to modify has already been deleted (Document type: %s).') % self._description)
3724
3725             if totranslate:
3726                 # TODO: optimize
3727                 for f in direct:
3728                     if self._columns[f].translate:
3729                         src_trans = self.pool[self._name].read(cr, user, ids, [f])[0][f]
3730                         if not src_trans:
3731                             src_trans = vals[f]
3732                             # Inserting value to DB
3733                             context_wo_lang = dict(context, lang=None)
3734                             self.write(cr, user, ids, {f: vals[f]}, context=context_wo_lang)
3735                         self.pool.get('ir.translation')._set_ids(cr, user, self._name+','+f, 'model', context['lang'], ids, vals[f], src_trans)
3736
3737         # call the 'set' method of fields which are not classic_write
3738         upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
3739
3740         # default element in context must be removed when call a one2many or many2many
3741         rel_context = context.copy()
3742         for c in context.items():
3743             if c[0].startswith('default_'):
3744                 del rel_context[c[0]]
3745
3746         for field in upd_todo:
3747             for id in ids:
3748                 result += self._columns[field].set(cr, self, id, field, vals[field], user, context=rel_context) or []
3749
3750         unknown_fields = updend[:]
3751         for table in self._inherits:
3752             col = self._inherits[table]
3753             nids = []
3754             for sub_ids in cr.split_for_in_conditions(ids):
3755                 cr.execute('select distinct "'+col+'" from "'+self._table+'" ' \
3756                            'where id IN %s', (sub_ids,))
3757                 nids.extend([x[0] for x in cr.fetchall()])
3758
3759             v = {}
3760             for val in updend:
3761                 if self._inherit_fields[val][0] == table:
3762                     v[val] = vals[val]
3763                     unknown_fields.remove(val)
3764             if v:
3765                 self.pool[table].write(cr, user, nids, v, context)
3766
3767         if unknown_fields:
3768             _logger.warning(
3769                 'No such field(s) in model %s: %s.',
3770                 self._name, ', '.join(unknown_fields))
3771
3772         # check Python constraints
3773         recs._validate_fields(vals)
3774
3775         # TODO: use _order to set dest at the right position and not first node of parent
3776         # We can't defer parent_store computation because the stored function
3777         # fields that are computer may refer (directly or indirectly) to
3778         # parent_left/right (via a child_of domain)
3779         if parents_changed:
3780             if self.pool._init:
3781                 self.pool._init_parent[self._name] = True
3782             else:
3783                 order = self._parent_order or self._order
3784                 parent_val = vals[self._parent_name]
3785                 if parent_val:
3786                     clause, params = '%s=%%s' % (self._parent_name,), (parent_val,)
3787                 else:
3788                     clause, params = '%s IS NULL' % (self._parent_name,), ()
3789
3790                 for id in parents_changed:
3791                     cr.execute('SELECT parent_left, parent_right FROM %s WHERE id=%%s' % (self._table,), (id,))
3792                     pleft, pright = cr.fetchone()
3793                     distance = pright - pleft + 1
3794
3795                     # Positions of current siblings, to locate proper insertion point;
3796                     # this can _not_ be fetched outside the loop, as it needs to be refreshed
3797                     # after each update, in case several nodes are sequentially inserted one
3798                     # next to the other (i.e computed incrementally)
3799                     cr.execute('SELECT parent_right, id FROM %s WHERE %s ORDER BY %s' % (self._table, clause, parent_order), params)
3800                     parents = cr.fetchall()
3801
3802                     # Find Position of the element
3803                     position = None
3804                     for (parent_pright, parent_id) in parents:
3805                         if parent_id == id:
3806                             break
3807                         position = parent_pright and parent_pright + 1 or 1
3808
3809                     # It's the first node of the parent
3810                     if not position:
3811                         if not parent_val:
3812                             position = 1
3813                         else:
3814                             cr.execute('select parent_left from '+self._table+' where id=%s', (parent_val,))
3815                             position = cr.fetchone()[0] + 1
3816
3817                     if pleft < position <= pright:
3818                         raise except_orm(_('UserError'), _('Recursivity Detected.'))
3819
3820                     if pleft < position:
3821                         cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3822                         cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3823                         cr.execute('update '+self._table+' set parent_left=parent_left+%s, parent_right=parent_right+%s where parent_left>=%s and parent_left<%s', (position-pleft, position-pleft, pleft, pright))
3824                     else:
3825                         cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3826                         cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3827                         cr.execute('update '+self._table+' set parent_left=parent_left-%s, parent_right=parent_right-%s where parent_left>=%s and parent_left<%s', (pleft-position+distance, pleft-position+distance, pleft+distance, pright+distance))
3828                     recs.invalidate_cache(['parent_left', 'parent_right'])
3829
3830         result += self._store_get_values(cr, user, ids, vals.keys(), context)
3831         result.sort()
3832
3833         # for recomputing new-style fields
3834         recs.modified(modified_fields)
3835
3836         done = {}
3837         for order, model_name, ids_to_update, fields_to_recompute in result:
3838             key = (model_name, tuple(fields_to_recompute))
3839             done.setdefault(key, {})
3840             # avoid to do several times the same computation
3841             todo = []
3842             for id in ids_to_update:
3843                 if id not in done[key]:
3844                     done[key][id] = True
3845                     todo.append(id)
3846             self.pool[model_name]._store_set_values(cr, user, todo, fields_to_recompute, context)
3847
3848         # recompute new-style fields
3849         if context.get('recompute', True):
3850             recs.recompute()
3851
3852         self.step_workflow(cr, user, ids, context=context)
3853         return True
3854
3855     #
3856     # TODO: Should set perm to user.xxx
3857     #
3858     @api.model
3859     @api.returns('self', lambda value: value.id)
3860     def create(self, vals):
3861         """ Create a new record for the model.
3862
3863             The values for the new record are initialized using the dictionary
3864             `vals`, and if necessary the result of :meth:`default_get`.
3865
3866             :param vals: field values like ``{'field_name': field_value, ...}``,
3867                 see :meth:`write` for details about the values format
3868             :return: new record created
3869             :raise AccessError: * if user has no create rights on the requested object
3870                                 * if user tries to bypass access rules for create on the requested object
3871             :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3872             :raise UserError: if a loop would be created in a hierarchy of objects a result of the operation (such as setting an object as its own parent)
3873         """
3874         self.check_access_rights('create')
3875
3876         # add missing defaults, and drop fields that may not be set by user
3877         vals = self._add_missing_default_values(vals)
3878         for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3879             vals.pop(field, None)
3880
3881         # split up fields into old-style and pure new-style ones
3882         old_vals, new_vals, unknown = {}, {}, []
3883         for key, val in vals.iteritems():
3884             if key in self._all_columns:
3885                 old_vals[key] = val
3886             elif key in self._fields:
3887                 new_vals[key] = val
3888             else:
3889                 unknown.append(key)
3890
3891         if unknown:
3892             _logger.warning("%s.create() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3893
3894         # create record with old-style fields
3895         record = self.browse(self._create(old_vals))
3896
3897         # put the values of pure new-style fields into cache, and inverse them
3898         record._cache.update(record._convert_to_cache(new_vals))
3899         for key in new_vals:
3900             self._fields[key].determine_inverse(record)
3901
3902         return record
3903
3904     def _create(self, cr, user, vals, context=None):
3905         # low-level implementation of create()
3906         if not context:
3907             context = {}
3908
3909         if self.is_transient():
3910             self._transient_vacuum(cr, user)
3911
3912         tocreate = {}
3913         for v in self._inherits:
3914             if self._inherits[v] not in vals:
3915                 tocreate[v] = {}
3916             else:
3917                 tocreate[v] = {'id': vals[self._inherits[v]]}
3918
3919         updates = [
3920             # list of column assignments defined as tuples like:
3921             #   (column_name, format_string, column_value)
3922             #   (column_name, sql_formula)
3923             # Those tuples will be used by the string formatting for the INSERT
3924             # statement below.
3925             ('id', "nextval('%s')" % self._sequence),
3926         ]
3927
3928         upd_todo = []
3929         unknown_fields = []
3930         for v in vals.keys():
3931             if v in self._inherit_fields and v not in self._columns:
3932                 (table, col, col_detail, original_parent) = self._inherit_fields[v]
3933                 tocreate[table][v] = vals[v]
3934                 del vals[v]
3935             else:
3936                 if (v not in self._inherit_fields) and (v not in self._columns):
3937                     del vals[v]
3938                     unknown_fields.append(v)
3939         if unknown_fields:
3940             _logger.warning(
3941                 'No such field(s) in model %s: %s.',
3942                 self._name, ', '.join(unknown_fields))
3943
3944         for table in tocreate:
3945             if self._inherits[table] in vals:
3946                 del vals[self._inherits[table]]
3947
3948             record_id = tocreate[table].pop('id', None)
3949
3950             if isinstance(record_id, dict):
3951                 # Shit happens: this possibly comes from a new record
3952                 tocreate[table] = dict(record_id, **tocreate[table])
3953                 record_id = None
3954
3955             # When linking/creating parent records, force context without 'no_store_function' key that
3956             # defers stored functions computing, as these won't be computed in batch at the end of create().
3957             parent_context = dict(context)
3958             parent_context.pop('no_store_function', None)
3959
3960             if record_id is None or not record_id:
3961                 record_id = self.pool[table].create(cr, user, tocreate[table], context=parent_context)
3962             else:
3963                 self.pool[table].write(cr, user, [record_id], tocreate[table], context=parent_context)
3964
3965             updates.append((self._inherits[table], '%s', record_id))
3966
3967         #Start : Set bool fields to be False if they are not touched(to make search more powerful)
3968         bool_fields = [x for x in self._columns.keys() if self._columns[x]._type=='boolean']
3969
3970         for bool_field in bool_fields:
3971             if bool_field not in vals:
3972                 vals[bool_field] = False
3973         #End
3974         for field in vals.keys():
3975             fobj = None
3976             if field in self._columns:
3977                 fobj = self._columns[field]
3978             else:
3979                 fobj = self._inherit_fields[field][2]
3980             if not fobj:
3981                 continue
3982             groups = fobj.write
3983             if groups:
3984                 edit = False
3985                 for group in groups:
3986                     module = group.split(".")[0]
3987                     grp = group.split(".")[1]
3988                     cr.execute("select count(*) from res_groups_users_rel where gid IN (select res_id from ir_model_data where name='%s' and module='%s' and model='%s') and uid=%s" % \
3989                                (grp, module, 'res.groups', user))
3990                     readonly = cr.fetchall()
3991                     if readonly[0][0] >= 1:
3992                         edit = True
3993                         break
3994                     elif readonly[0][0] == 0:
3995                         edit = False
3996                     else:
3997                         edit = False
3998
3999                 if not edit:
4000                     vals.pop(field)
4001         for field in vals:
4002             current_field = self._columns[field]
4003             if current_field._classic_write:
4004                 updates.append((field, '%s', current_field._symbol_set[1](vals[field])))
4005
4006                 #for the function fields that receive a value, we set them directly in the database
4007                 #(they may be required), but we also need to trigger the _fct_inv()
4008                 if (hasattr(current_field, '_fnct_inv')) and not isinstance(current_field, fields.related):
4009                     #TODO: this way to special case the related fields is really creepy but it shouldn't be changed at
4010                     #one week of the release candidate. It seems the only good way to handle correctly this is to add an
4011                     #attribute to make a field `really readonly´ and thus totally ignored by the create()... otherwise
4012                     #if, for example, the related has a default value (for usability) then the fct_inv is called and it
4013                     #may raise some access rights error. Changing this is a too big change for now, and is thus postponed
4014                     #after the release but, definitively, the behavior shouldn't be different for related and function
4015                     #fields.
4016                     upd_todo.append(field)
4017             else:
4018                 #TODO: this `if´ statement should be removed because there is no good reason to special case the fields
4019                 #related. See the above TODO comment for further explanations.
4020                 if not isinstance(current_field, fields.related):
4021                     upd_todo.append(field)
4022             if field in self._columns \
4023                     and hasattr(current_field, 'selection') \
4024                     and vals[field]:
4025                 self._check_selection_field_value(cr, user, field, vals[field], context=context)
4026         if self._log_access:
4027             updates.append(('create_uid', '%s', user))
4028             updates.append(('write_uid', '%s', user))
4029             updates.append(('create_date', "(now() at time zone 'UTC')"))
4030             updates.append(('write_date', "(now() at time zone 'UTC')"))
4031
4032         # the list of tuples used in this formatting corresponds to
4033         # tuple(field_name, format, value)
4034         # In some case, for example (id, create_date, write_date) we does not
4035         # need to read the third value of the tuple, because the real value is
4036         # encoded in the second value (the format).
4037         cr.execute(
4038             """INSERT INTO "%s" (%s) VALUES(%s) RETURNING id""" % (
4039                 self._table,
4040                 ', '.join('"%s"' % u[0] for u in updates),
4041                 ', '.join(u[1] for u in updates)
4042             ),
4043             tuple([u[2] for u in updates if len(u) > 2])
4044         )
4045
4046         id_new, = cr.fetchone()
4047         recs = self.browse(cr, user, id_new, context)
4048         upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
4049
4050         if self._parent_store and not context.get('defer_parent_store_computation'):
4051             if self.pool._init:
4052                 self.pool._init_parent[self._name] = True
4053             else:
4054                 parent = vals.get(self._parent_name, False)
4055                 if parent:
4056                     cr.execute('select parent_right from '+self._table+' where '+self._parent_name+'=%s order by '+(self._parent_order or self._order), (parent,))
4057                     pleft_old = None
4058                     result_p = cr.fetchall()
4059                     for (pleft,) in result_p:
4060                         if not pleft:
4061                             break
4062                         pleft_old = pleft
4063                     if not pleft_old:
4064                         cr.execute('select parent_left from '+self._table+' where id=%s', (parent,))
4065                         pleft_old = cr.fetchone()[0]
4066                     pleft = pleft_old
4067                 else:
4068                     cr.execute('select max(parent_right) from '+self._table)
4069                     pleft = cr.fetchone()[0] or 0
4070                 cr.execute('update '+self._table+' set parent_left=parent_left+2 where parent_left>%s', (pleft,))
4071                 cr.execute('update '+self._table+' set parent_right=parent_right+2 where parent_right>%s', (pleft,))
4072                 cr.execute('update '+self._table+' set parent_left=%s,parent_right=%s where id=%s', (pleft+1, pleft+2, id_new))
4073                 recs.invalidate_cache(['parent_left', 'parent_right'])
4074
4075         # default element in context must be remove when call a one2many or many2many
4076         rel_context = context.copy()
4077         for c in context.items():
4078             if c[0].startswith('default_'):
4079                 del rel_context[c[0]]
4080
4081         result = []
4082         for field in upd_todo:
4083             result += self._columns[field].set(cr, self, id_new, field, vals[field], user, rel_context) or []
4084
4085         # check Python constraints
4086         recs._validate_fields(vals)
4087
4088         if not context.get('no_store_function', False):
4089             result += self._store_get_values(cr, user, [id_new],
4090                 list(set(vals.keys() + self._inherits.values())),
4091                 context)
4092             result.sort()
4093             done = []
4094             for order, model_name, ids, fields2 in result:
4095                 if not (model_name, ids, fields2) in done:
4096                     self.pool[model_name]._store_set_values(cr, user, ids, fields2, context)
4097                     done.append((model_name, ids, fields2))
4098
4099             # recompute new-style fields
4100             modified_fields = list(vals)
4101             if self._log_access:
4102                 modified_fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
4103             recs.modified(modified_fields)
4104             recs.recompute()
4105
4106         if self._log_create and not (context and context.get('no_store_function', False)):
4107             message = self._description + \
4108                 " '" + \
4109                 self.name_get(cr, user, [id_new], context=context)[0][1] + \
4110                 "' " + _("created.")
4111             self.log(cr, user, id_new, message, True, context=context)
4112
4113         self.check_access_rule(cr, user, [id_new], 'create', context=context)
4114         self.create_workflow(cr, user, [id_new], context=context)
4115         return id_new
4116
4117     def _store_get_values(self, cr, uid, ids, fields, context):
4118         """Returns an ordered list of fields.function to call due to
4119            an update operation on ``fields`` of records with ``ids``,
4120            obtained by calling the 'store' triggers of these fields,
4121            as setup by their 'store' attribute.
4122
4123            :return: [(priority, model_name, [record_ids,], [function_fields,])]
4124         """
4125         if fields is None: fields = []
4126         stored_functions = self.pool._store_function.get(self._name, [])
4127
4128         # use indexed names for the details of the stored_functions:
4129         model_name_, func_field_to_compute_, target_ids_func_, trigger_fields_, priority_ = range(5)
4130
4131         # only keep store triggers that should be triggered for the ``fields``
4132         # being written to.
4133         triggers_to_compute = (
4134             f for f in stored_functions
4135             if not f[trigger_fields_] or set(fields).intersection(f[trigger_fields_])
4136         )
4137
4138         to_compute_map = {}
4139         target_id_results = {}
4140         for store_trigger in triggers_to_compute:
4141             target_func_id_ = id(store_trigger[target_ids_func_])
4142             if target_func_id_ not in target_id_results:
4143                 # use admin user for accessing objects having rules defined on store fields
4144                 target_id_results[target_func_id_] = [i for i in store_trigger[target_ids_func_](self, cr, SUPERUSER_ID, ids, context) if i]
4145             target_ids = target_id_results[target_func_id_]
4146
4147             # the compound key must consider the priority and model name
4148             key = (store_trigger[priority_], store_trigger[model_name_])
4149             for target_id in target_ids:
4150                 to_compute_map.setdefault(key, {}).setdefault(target_id,set()).add(tuple(store_trigger))
4151
4152         # Here to_compute_map looks like:
4153         # { (10, 'model_a') : { target_id1: [ (trigger_1_tuple, trigger_2_tuple) ], ... }
4154         #   (20, 'model_a') : { target_id2: [ (trigger_3_tuple, trigger_4_tuple) ], ... }
4155         #   (99, 'model_a') : { target_id1: [ (trigger_5_tuple, trigger_6_tuple) ], ... }
4156         # }
4157
4158         # Now we need to generate the batch function calls list
4159         # call_map =
4160         #   { (10, 'model_a') : [(10, 'model_a', [record_ids,], [function_fields,])] }
4161         call_map = {}
4162         for ((priority,model), id_map) in to_compute_map.iteritems():
4163             trigger_ids_maps = {}
4164             # function_ids_maps =
4165             #   { (function_1_tuple, function_2_tuple) : [target_id1, target_id2, ..] }
4166             for target_id, triggers in id_map.iteritems():
4167                 trigger_ids_maps.setdefault(tuple(triggers), []).append(target_id)
4168             for triggers, target_ids in trigger_ids_maps.iteritems():
4169                 call_map.setdefault((priority,model),[]).append((priority, model, target_ids,
4170                                                                  [t[func_field_to_compute_] for t in triggers]))
4171         result = []
4172         if call_map:
4173             result = reduce(operator.add, (call_map[k] for k in sorted(call_map)))
4174         return result
4175
4176     def _store_set_values(self, cr, uid, ids, fields, context):
4177         """Calls the fields.function's "implementation function" for all ``fields``, on records with ``ids`` (taking care of
4178            respecting ``multi`` attributes), and stores the resulting values in the database directly."""
4179         if not ids:
4180             return True
4181         field_flag = False
4182         field_dict = {}
4183         if self._log_access:
4184             cr.execute('select id,write_date from '+self._table+' where id IN %s', (tuple(ids),))
4185             res = cr.fetchall()
4186             for r in res:
4187                 if r[1]:
4188                     field_dict.setdefault(r[0], [])
4189                     res_date = time.strptime((r[1])[:19], '%Y-%m-%d %H:%M:%S')
4190                     write_date = datetime.datetime.fromtimestamp(time.mktime(res_date))
4191                     for i in self.pool._store_function.get(self._name, []):
4192                         if i[5]:
4193                             up_write_date = write_date + datetime.timedelta(hours=i[5])
4194                             if datetime.datetime.now() < up_write_date:
4195                                 if i[1] in fields:
4196                                     field_dict[r[0]].append(i[1])
4197                                     if not field_flag:
4198                                         field_flag = True
4199         todo = {}
4200         keys = []
4201         for f in fields:
4202             if self._columns[f]._multi not in keys:
4203                 keys.append(self._columns[f]._multi)
4204             todo.setdefault(self._columns[f]._multi, [])
4205             todo[self._columns[f]._multi].append(f)
4206         for key in keys:
4207             val = todo[key]
4208             if key:
4209                 # use admin user for accessing objects having rules defined on store fields
4210                 result = self._columns[val[0]].get(cr, self, ids, val, SUPERUSER_ID, context=context)
4211                 for id, value in result.items():
4212                     if field_flag:
4213                         for f in value.keys():
4214                             if f in field_dict[id]:
4215                                 value.pop(f)
4216                     upd0 = []
4217                     upd1 = []
4218                     for v in value:
4219                         if v not in val:
4220                             continue
4221                         if self._columns[v]._type == 'many2one':
4222                             try:
4223                                 value[v] = value[v][0]
4224                             except:
4225                                 pass
4226                         upd0.append('"'+v+'"='+self._columns[v]._symbol_set[0])
4227                         upd1.append(self._columns[v]._symbol_set[1](value[v]))
4228                     upd1.append(id)
4229                     if upd0 and upd1:
4230                         cr.execute('update "' + self._table + '" set ' + \
4231                             ','.join(upd0) + ' where id = %s', upd1)
4232
4233             else:
4234                 for f in val:
4235                     # use admin user for accessing objects having rules defined on store fields
4236                     result = self._columns[f].get(cr, self, ids, f, SUPERUSER_ID, context=context)
4237                     for r in result.keys():
4238                         if field_flag:
4239                             if r in field_dict.keys():
4240                                 if f in field_dict[r]:
4241                                     result.pop(r)
4242                     for id, value in result.items():
4243                         if self._columns[f]._type == 'many2one':
4244                             try:
4245                                 value = value[0]
4246                             except:
4247                                 pass
4248                         cr.execute('update "' + self._table + '" set ' + \
4249                             '"'+f+'"='+self._columns[f]._symbol_set[0] + ' where id = %s', (self._columns[f]._symbol_set[1](value), id))
4250
4251         # invalidate the cache for the modified fields
4252         self.browse(cr, uid, ids, context).modified(fields)
4253
4254         return True
4255
4256     # TODO: ameliorer avec NULL
4257     def _where_calc(self, cr, user, domain, active_test=True, context=None):
4258         """Computes the WHERE clause needed to implement an OpenERP domain.
4259         :param domain: the domain to compute
4260         :type domain: list
4261         :param active_test: whether the default filtering of records with ``active``
4262                             field set to ``False`` should be applied.
4263         :return: the query expressing the given domain as provided in domain
4264         :rtype: osv.query.Query
4265         """
4266         if not context:
4267             context = {}
4268         domain = domain[:]
4269         # if the object has a field named 'active', filter out all inactive
4270         # records unless they were explicitely asked for
4271         if 'active' in self._all_columns and (active_test and context.get('active_test', True)):
4272             if domain:
4273                 # the item[0] trick below works for domain items and '&'/'|'/'!'
4274                 # operators too
4275                 if not any(item[0] == 'active' for item in domain):
4276                     domain.insert(0, ('active', '=', 1))
4277             else:
4278                 domain = [('active', '=', 1)]
4279
4280         if domain:
4281             e = expression.expression(cr, user, domain, self, context)
4282             tables = e.get_tables()
4283             where_clause, where_params = e.to_sql()
4284             where_clause = where_clause and [where_clause] or []
4285         else:
4286             where_clause, where_params, tables = [], [], ['"%s"' % self._table]
4287
4288         return Query(tables, where_clause, where_params)
4289
4290     def _check_qorder(self, word):
4291         if not regex_order.match(word):
4292             raise except_orm(_('AccessError'), _('Invalid "order" specified. A valid "order" specification is a comma-separated list of valid field names (optionally followed by asc/desc for the direction)'))
4293         return True
4294
4295     def _apply_ir_rules(self, cr, uid, query, mode='read', context=None):
4296         """Add what's missing in ``query`` to implement all appropriate ir.rules
4297           (using the ``model_name``'s rules or the current model's rules if ``model_name`` is None)
4298
4299            :param query: the current query object
4300         """
4301         if uid == SUPERUSER_ID:
4302             return
4303
4304         def apply_rule(added_clause, added_params, added_tables, parent_model=None):
4305             """ :param parent_model: name of the parent model, if the added
4306                     clause comes from a parent model
4307             """
4308             if added_clause:
4309                 if parent_model:
4310                     # as inherited rules are being applied, we need to add the missing JOIN
4311                     # to reach the parent table (if it was not JOINed yet in the query)
4312                     parent_alias = self._inherits_join_add(self, parent_model, query)
4313                     # inherited rules are applied on the external table -> need to get the alias and replace
4314                     parent_table = self.pool[parent_model]._table
4315                     added_clause = [clause.replace('"%s"' % parent_table, '"%s"' % parent_alias) for clause in added_clause]
4316                     # change references to parent_table to parent_alias, because we now use the alias to refer to the table
4317                     new_tables = []
4318                     for table in added_tables:
4319                         # table is just a table name -> switch to the full alias
4320                         if table == '"%s"' % parent_table:
4321                             new_tables.append('"%s" as "%s"' % (parent_table, parent_alias))
4322                         # table is already a full statement -> replace reference to the table to its alias, is correct with the way aliases are generated
4323                         else:
4324                             new_tables.append(table.replace('"%s"' % parent_table, '"%s"' % parent_alias))
4325                     added_tables = new_tables
4326                 query.where_clause += added_clause
4327                 query.where_clause_params += added_params
4328                 for table in added_tables:
4329                     if table not in query.tables:
4330                         query.tables.append(table)
4331                 return True
4332             return False
4333
4334         # apply main rules on the object
4335         rule_obj = self.pool.get('ir.rule')
4336         rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, self._name, mode, context=context)
4337         apply_rule(rule_where_clause, rule_where_clause_params, rule_tables)
4338
4339         # apply ir.rules from the parents (through _inherits)
4340         for inherited_model in self._inherits:
4341             rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, inherited_model, mode, context=context)
4342             apply_rule(rule_where_clause, rule_where_clause_params, rule_tables,
4343                         parent_model=inherited_model)
4344
4345     def _generate_m2o_order_by(self, order_field, query):
4346         """
4347         Add possibly missing JOIN to ``query`` and generate the ORDER BY clause for m2o fields,
4348         either native m2o fields or function/related fields that are stored, including
4349         intermediate JOINs for inheritance if required.
4350
4351         :return: the qualified field name to use in an ORDER BY clause to sort by ``order_field``
4352         """
4353         if order_field not in self._columns and order_field in self._inherit_fields:
4354             # also add missing joins for reaching the table containing the m2o field
4355             qualified_field = self._inherits_join_calc(order_field, query)
4356             order_field_column = self._inherit_fields[order_field][2]
4357         else:
4358             qualified_field = '"%s"."%s"' % (self._table, order_field)
4359             order_field_column = self._columns[order_field]
4360
4361         assert order_field_column._type == 'many2one', 'Invalid field passed to _generate_m2o_order_by()'
4362         if not order_field_column._classic_write and not getattr(order_field_column, 'store', False):
4363             _logger.debug("Many2one function/related fields must be stored " \
4364                 "to be used as ordering fields! Ignoring sorting for %s.%s",
4365                 self._name, order_field)
4366             return
4367
4368         # figure out the applicable order_by for the m2o
4369         dest_model = self.pool[order_field_column._obj]
4370         m2o_order = dest_model._order
4371         if not regex_order.match(m2o_order):
4372             # _order is complex, can't use it here, so we default to _rec_name
4373             m2o_order = dest_model._rec_name
4374         else:
4375             # extract the field names, to be able to qualify them and add desc/asc
4376             m2o_order_list = []
4377             for order_part in m2o_order.split(","):
4378                 m2o_order_list.append(order_part.strip().split(" ", 1)[0].strip())
4379             m2o_order = m2o_order_list
4380
4381         # Join the dest m2o table if it's not joined yet. We use [LEFT] OUTER join here
4382         # as we don't want to exclude results that have NULL values for the m2o
4383         src_table, src_field = qualified_field.replace('"', '').split('.', 1)
4384         dst_alias, dst_alias_statement = query.add_join((src_table, dest_model._table, src_field, 'id', src_field), implicit=False, outer=True)
4385         qualify = lambda field: '"%s"."%s"' % (dst_alias, field)
4386         return map(qualify, m2o_order) if isinstance(m2o_order, list) else qualify(m2o_order)
4387
4388     def _generate_order_by(self, order_spec, query):
4389         """
4390         Attempt to consruct an appropriate ORDER BY clause based on order_spec, which must be
4391         a comma-separated list of valid field names, optionally followed by an ASC or DESC direction.
4392
4393         :raise" except_orm in case order_spec is malformed
4394         """
4395         order_by_clause = ''
4396         order_spec = order_spec or self._order
4397         if order_spec:
4398             order_by_elements = []
4399             self._check_qorder(order_spec)
4400             for order_part in order_spec.split(','):
4401                 order_split = order_part.strip().split(' ')
4402                 order_field = order_split[0].strip()
4403                 order_direction = order_split[1].strip() if len(order_split) == 2 else ''
4404                 inner_clause = None
4405                 if order_field == 'id':
4406                     order_by_elements.append('"%s"."%s" %s' % (self._table, order_field, order_direction))
4407                 elif order_field in self._columns:
4408                     order_column = self._columns[order_field]
4409                     if order_column._classic_read:
4410                         inner_clause = '"%s"."%s"' % (self._table, order_field)
4411                     elif order_column._type == 'many2one':
4412                         inner_clause = self._generate_m2o_order_by(order_field, query)
4413                     else:
4414                         continue  # ignore non-readable or "non-joinable" fields
4415                 elif order_field in self._inherit_fields:
4416                     parent_obj = self.pool[self._inherit_fields[order_field][3]]
4417                     order_column = parent_obj._columns[order_field]
4418                     if order_column._classic_read:
4419                         inner_clause = self._inherits_join_calc(order_field, query)
4420                     elif order_column._type == 'many2one':
4421                         inner_clause = self._generate_m2o_order_by(order_field, query)
4422                     else:
4423                         continue  # ignore non-readable or "non-joinable" fields
4424                 else:
4425                     raise ValueError( _("Sorting field %s not found on model %s") %( order_field, self._name))
4426                 if inner_clause:
4427                     if isinstance(inner_clause, list):
4428                         for clause in inner_clause:
4429                             order_by_elements.append("%s %s" % (clause, order_direction))
4430                     else:
4431                         order_by_elements.append("%s %s" % (inner_clause, order_direction))
4432             if order_by_elements:
4433                 order_by_clause = ",".join(order_by_elements)
4434
4435         return order_by_clause and (' ORDER BY %s ' % order_by_clause) or ''
4436
4437     def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
4438         """
4439         Private implementation of search() method, allowing specifying the uid to use for the access right check.
4440         This is useful for example when filling in the selection list for a drop-down and avoiding access rights errors,
4441         by specifying ``access_rights_uid=1`` to bypass access rights check, but not ir.rules!
4442         This is ok at the security level because this method is private and not callable through XML-RPC.
4443
4444         :param access_rights_uid: optional user ID to use when checking access rights
4445                                   (not for ir.rules, this is only for ir.model.access)
4446         """
4447         if context is None:
4448             context = {}
4449         self.check_access_rights(cr, access_rights_uid or user, 'read')
4450
4451         # For transient models, restrict acces to the current user, except for the super-user
4452         if self.is_transient() and self._log_access and user != SUPERUSER_ID:
4453             args = expression.AND(([('create_uid', '=', user)], args or []))
4454
4455         query = self._where_calc(cr, user, args, context=context)
4456         self._apply_ir_rules(cr, user, query, 'read', context=context)
4457         order_by = self._generate_order_by(order, query)
4458         from_clause, where_clause, where_clause_params = query.get_sql()
4459
4460         where_str = where_clause and (" WHERE %s" % where_clause) or ''
4461
4462         if count:
4463             # Ignore order, limit and offset when just counting, they don't make sense and could
4464             # hurt performance
4465             query_str = 'SELECT count(1) FROM ' + from_clause + where_str
4466             cr.execute(query_str, where_clause_params)
4467             res = cr.fetchone()
4468             return res[0]
4469
4470         limit_str = limit and ' limit %d' % limit or ''
4471         offset_str = offset and ' offset %d' % offset or ''
4472         query_str = 'SELECT "%s".id FROM ' % self._table + from_clause + where_str + order_by + limit_str + offset_str
4473         cr.execute(query_str, where_clause_params)
4474         res = cr.fetchall()
4475
4476         # TDE note: with auto_join, we could have several lines about the same result
4477         # i.e. a lead with several unread messages; we uniquify the result using
4478         # a fast way to do it while preserving order (http://www.peterbe.com/plog/uniqifiers-benchmark)
4479         def _uniquify_list(seq):
4480             seen = set()
4481             return [x for x in seq if x not in seen and not seen.add(x)]
4482
4483         return _uniquify_list([x[0] for x in res])
4484
4485     # returns the different values ever entered for one field
4486     # this is used, for example, in the client when the user hits enter on
4487     # a char field
4488     def distinct_field_get(self, cr, uid, field, value, args=None, offset=0, limit=None):
4489         if not args:
4490             args = []
4491         if field in self._inherit_fields:
4492             return self.pool[self._inherit_fields[field][0]].distinct_field_get(cr, uid, field, value, args, offset, limit)
4493         else:
4494             return self._columns[field].search(cr, self, args, field, value, offset, limit, uid)
4495
4496     def copy_data(self, cr, uid, id, default=None, context=None):
4497         """
4498         Copy given record's data with all its fields values
4499
4500         :param cr: database cursor
4501         :param uid: current user id
4502         :param id: id of the record to copy
4503         :param default: field values to override in the original values of the copied record
4504         :type default: dictionary
4505         :param context: context arguments, like lang, time zone
4506         :type context: dictionary
4507         :return: dictionary containing all the field values
4508         """
4509
4510         if context is None:
4511             context = {}
4512
4513         # avoid recursion through already copied records in case of circular relationship
4514         seen_map = context.setdefault('__copy_data_seen', {})
4515         if id in seen_map.setdefault(self._name, []):
4516             return
4517         seen_map[self._name].append(id)
4518
4519         if default is None:
4520             default = {}
4521         if 'state' not in default:
4522             if 'state' in self._defaults:
4523                 if callable(self._defaults['state']):
4524                     default['state'] = self._defaults['state'](self, cr, uid, context)
4525                 else:
4526                     default['state'] = self._defaults['state']
4527
4528         # build a black list of fields that should not be copied
4529         blacklist = set(MAGIC_COLUMNS + ['parent_left', 'parent_right'])
4530         def blacklist_given_fields(obj):
4531             # blacklist the fields that are given by inheritance
4532             for other, field_to_other in obj._inherits.items():
4533                 blacklist.add(field_to_other)
4534                 if field_to_other in default:
4535                     # all the fields of 'other' are given by the record: default[field_to_other],
4536                     # except the ones redefined in self
4537                     blacklist.update(set(self.pool[other]._all_columns) - set(self._columns))
4538                 else:
4539                     blacklist_given_fields(self.pool[other])
4540             # blacklist deprecated fields
4541             for name, field in obj._columns.items():
4542                 if field.deprecated:
4543                     blacklist.add(name)
4544
4545         blacklist_given_fields(self)
4546
4547
4548         fields_to_copy = dict((f,fi) for f, fi in self._all_columns.iteritems()
4549                                      if fi.column.copy
4550                                      if f not in default
4551                                      if f not in blacklist)
4552
4553         data = self.read(cr, uid, [id], fields_to_copy.keys(), context=context)
4554         if data:
4555             data = data[0]
4556         else:
4557             raise IndexError( _("Record #%d of %s not found, cannot copy!") %( id, self._name))
4558
4559         res = dict(default)
4560         for f, colinfo in fields_to_copy.iteritems():
4561             field = colinfo.column
4562             if field._type == 'many2one':
4563                 res[f] = data[f] and data[f][0]
4564             elif field._type == 'one2many':
4565                 other = self.pool[field._obj]
4566                 # duplicate following the order of the ids because we'll rely on
4567                 # it later for copying translations in copy_translation()!
4568                 lines = [other.copy_data(cr, uid, line_id, context=context) for line_id in sorted(data[f])]
4569                 # the lines are duplicated using the wrong (old) parent, but then
4570                 # are reassigned to the correct one thanks to the (0, 0, ...)
4571                 res[f] = [(0, 0, line) for line in lines if line]
4572             elif field._type == 'many2many':
4573                 res[f] = [(6, 0, data[f])]
4574             else:
4575                 res[f] = data[f]
4576
4577         return res
4578
4579     def copy_translations(self, cr, uid, old_id, new_id, context=None):
4580         if context is None:
4581             context = {}
4582
4583         # avoid recursion through already copied records in case of circular relationship
4584         seen_map = context.setdefault('__copy_translations_seen',{})
4585         if old_id in seen_map.setdefault(self._name,[]):
4586             return
4587         seen_map[self._name].append(old_id)
4588
4589         trans_obj = self.pool.get('ir.translation')
4590         # TODO it seems fields_get can be replaced by _all_columns (no need for translation)
4591         fields = self.fields_get(cr, uid, context=context)
4592
4593         for field_name, field_def in fields.items():
4594             # removing the lang to compare untranslated values
4595             context_wo_lang = dict(context, lang=None)
4596             old_record, new_record = self.browse(cr, uid, [old_id, new_id], context=context_wo_lang)
4597             # we must recursively copy the translations for o2o and o2m
4598             if field_def['type'] == 'one2many':
4599                 target_obj = self.pool[field_def['relation']]
4600                 # here we rely on the order of the ids to match the translations
4601                 # as foreseen in copy_data()
4602                 old_children = sorted(r.id for r in old_record[field_name])
4603                 new_children = sorted(r.id for r in new_record[field_name])
4604                 for (old_child, new_child) in zip(old_children, new_children):
4605                     target_obj.copy_translations(cr, uid, old_child, new_child, context=context)
4606             # and for translatable fields we keep them for copy
4607             elif field_def.get('translate'):
4608                 if field_name in self._columns:
4609                     trans_name = self._name + "," + field_name
4610                     target_id = new_id
4611                     source_id = old_id
4612                 elif field_name in self._inherit_fields:
4613                     trans_name = self._inherit_fields[field_name][0] + "," + field_name
4614                     # get the id of the parent record to set the translation
4615                     inherit_field_name = self._inherit_fields[field_name][1]
4616                     target_id = new_record[inherit_field_name].id
4617                     source_id = old_record[inherit_field_name].id
4618                 else:
4619                     continue
4620
4621                 trans_ids = trans_obj.search(cr, uid, [
4622                         ('name', '=', trans_name),
4623                         ('res_id', '=', source_id)
4624                 ])
4625                 user_lang = context.get('lang')
4626                 for record in trans_obj.read(cr, uid, trans_ids, context=context):
4627                     del record['id']
4628                     # remove source to avoid triggering _set_src
4629                     del record['source']
4630                     record.update({'res_id': target_id})
4631                     if user_lang and user_lang == record['lang']:
4632                         # 'source' to force the call to _set_src
4633                         # 'value' needed if value is changed in copy(), want to see the new_value
4634                         record['source'] = old_record[field_name]
4635                         record['value'] = new_record[field_name]
4636                     trans_obj.create(cr, uid, record, context=context)
4637
4638     @api.returns('self', lambda value: value.id)
4639     def copy(self, cr, uid, id, default=None, context=None):
4640         """
4641         Duplicate record with given id updating it with default values
4642
4643         :param cr: database cursor
4644         :param uid: current user id
4645         :param id: id of the record to copy
4646         :param default: dictionary of field values to override in the original values of the copied record, e.g: ``{'field_name': overriden_value, ...}``
4647         :type default: dictionary
4648         :param context: context arguments, like lang, time zone
4649         :type context: dictionary
4650         :return: id of the newly created record
4651
4652         """
4653         if context is None:
4654             context = {}
4655         context = context.copy()
4656         data = self.copy_data(cr, uid, id, default, context)
4657         new_id = self.create(cr, uid, data, context)
4658         self.copy_translations(cr, uid, id, new_id, context)
4659         return new_id
4660
4661     @api.multi
4662     @api.returns('self')
4663     def exists(self):
4664         """ Return the subset of records in `self` that exist, and mark deleted
4665             records as such in cache. It can be used as a test on records::
4666
4667                 if record.exists():
4668                     ...
4669
4670             By convention, new records are returned as existing.
4671         """
4672         ids = filter(None, self._ids)           # ids to check in database
4673         if not ids:
4674             return self
4675         query = """SELECT id FROM "%s" WHERE id IN %%s""" % self._table
4676         self._cr.execute(query, (ids,))
4677         ids = ([r[0] for r in self._cr.fetchall()] +    # ids in database
4678                [id for id in self._ids if not id])      # new ids
4679         existing = self.browse(ids)
4680         if len(existing) < len(self):
4681             # mark missing records in cache with a failed value
4682             exc = MissingError(_("Record does not exist or has been deleted."))
4683             (self - existing)._cache.update(FailedValue(exc))
4684         return existing
4685
4686     def check_recursion(self, cr, uid, ids, context=None, parent=None):
4687         _logger.warning("You are using deprecated %s.check_recursion(). Please use the '_check_recursion()' instead!" % \
4688                         self._name)
4689         assert parent is None or parent in self._columns or parent in self._inherit_fields,\
4690                     "The 'parent' parameter passed to check_recursion() must be None or a valid field name"
4691         return self._check_recursion(cr, uid, ids, context, parent)
4692
4693     def _check_recursion(self, cr, uid, ids, context=None, parent=None):
4694         """
4695         Verifies that there is no loop in a hierarchical structure of records,
4696         by following the parent relationship using the **parent** field until a loop
4697         is detected or until a top-level record is found.
4698
4699         :param cr: database cursor
4700         :param uid: current user id
4701         :param ids: list of ids of records to check
4702         :param parent: optional parent field name (default: ``self._parent_name = parent_id``)
4703         :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4704         """
4705         if not parent:
4706             parent = self._parent_name
4707
4708         # must ignore 'active' flag, ir.rules, etc. => direct SQL query
4709         query = 'SELECT "%s" FROM "%s" WHERE id = %%s' % (parent, self._table)
4710         for id in ids:
4711             current_id = id
4712             while current_id is not None:
4713                 cr.execute(query, (current_id,))
4714                 result = cr.fetchone()
4715                 current_id = result[0] if result else None
4716                 if current_id == id:
4717                     return False
4718         return True
4719
4720     def _check_m2m_recursion(self, cr, uid, ids, field_name):
4721         """
4722         Verifies that there is no loop in a hierarchical structure of records,
4723         by following the parent relationship using the **parent** field until a loop
4724         is detected or until a top-level record is found.
4725
4726         :param cr: database cursor
4727         :param uid: current user id
4728         :param ids: list of ids of records to check
4729         :param field_name: field to check
4730         :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4731         """
4732
4733         field = self._all_columns.get(field_name)
4734         field = field.column if field else None
4735         if not field or field._type != 'many2many' or field._obj != self._name:
4736             # field must be a many2many on itself
4737             raise ValueError('invalid field_name: %r' % (field_name,))
4738
4739         query = 'SELECT distinct "%s" FROM "%s" WHERE "%s" IN %%s' % (field._id2, field._rel, field._id1)
4740         ids_parent = ids[:]
4741         while ids_parent:
4742             ids_parent2 = []
4743             for i in range(0, len(ids_parent), cr.IN_MAX):
4744                 j = i + cr.IN_MAX
4745                 sub_ids_parent = ids_parent[i:j]
4746                 cr.execute(query, (tuple(sub_ids_parent),))
4747                 ids_parent2.extend(filter(None, map(lambda x: x[0], cr.fetchall())))
4748             ids_parent = ids_parent2
4749             for i in ids_parent:
4750                 if i in ids:
4751                     return False
4752         return True
4753
4754     def _get_external_ids(self, cr, uid, ids, *args, **kwargs):
4755         """Retrieve the External ID(s) of any database record.
4756
4757         **Synopsis**: ``_get_xml_ids(cr, uid, ids) -> { 'id': ['module.xml_id'] }``
4758
4759         :return: map of ids to the list of their fully qualified External IDs
4760                  in the form ``module.key``, or an empty list when there's no External
4761                  ID for a record, e.g.::
4762
4763                      { 'id': ['module.ext_id', 'module.ext_id_bis'],
4764                        'id2': [] }
4765         """
4766         ir_model_data = self.pool.get('ir.model.data')
4767         data_ids = ir_model_data.search(cr, uid, [('model', '=', self._name), ('res_id', 'in', ids)])
4768         data_results = ir_model_data.read(cr, uid, data_ids, ['module', 'name', 'res_id'])
4769         result = {}
4770         for id in ids:
4771             # can't use dict.fromkeys() as the list would be shared!
4772             result[id] = []
4773         for record in data_results:
4774             result[record['res_id']].append('%(module)s.%(name)s' % record)
4775         return result
4776
4777     def get_external_id(self, cr, uid, ids, *args, **kwargs):
4778         """Retrieve the External ID of any database record, if there
4779         is one. This method works as a possible implementation
4780         for a function field, to be able to add it to any
4781         model object easily, referencing it as ``Model.get_external_id``.
4782
4783         When multiple External IDs exist for a record, only one
4784         of them is returned (randomly).
4785
4786         :return: map of ids to their fully qualified XML ID,
4787                  defaulting to an empty string when there's none
4788                  (to be usable as a function field),
4789                  e.g.::
4790
4791                      { 'id': 'module.ext_id',
4792                        'id2': '' }
4793         """
4794         results = self._get_xml_ids(cr, uid, ids)
4795         for k, v in results.iteritems():
4796             if results[k]:
4797                 results[k] = v[0]
4798             else:
4799                 results[k] = ''
4800         return results
4801
4802     # backwards compatibility
4803     get_xml_id = get_external_id
4804     _get_xml_ids = _get_external_ids
4805
4806     def print_report(self, cr, uid, ids, name, data, context=None):
4807         """
4808         Render the report `name` for the given IDs. The report must be defined
4809         for this model, not another.
4810         """
4811         report = self.pool['ir.actions.report.xml']._lookup_report(cr, name)
4812         assert self._name == report.table
4813         return report.create(cr, uid, ids, data, context)
4814
4815     # Transience
4816     @classmethod
4817     def is_transient(cls):
4818         """ Return whether the model is transient.
4819
4820         See :class:`TransientModel`.
4821
4822         """
4823         return cls._transient
4824
4825     def _transient_clean_rows_older_than(self, cr, seconds):
4826         assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4827         # Never delete rows used in last 5 minutes
4828         seconds = max(seconds, 300)
4829         query = ("SELECT id FROM " + self._table + " WHERE"
4830             " COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp"
4831             " < ((now() at time zone 'UTC') - interval %s)")
4832         cr.execute(query, ("%s seconds" % seconds,))
4833         ids = [x[0] for x in cr.fetchall()]
4834         self.unlink(cr, SUPERUSER_ID, ids)
4835
4836     def _transient_clean_old_rows(self, cr, max_count):
4837         # Check how many rows we have in the table
4838         cr.execute("SELECT count(*) AS row_count FROM " + self._table)
4839         res = cr.fetchall()
4840         if res[0][0] <= max_count:
4841             return  # max not reached, nothing to do
4842         self._transient_clean_rows_older_than(cr, 300)
4843
4844     def _transient_vacuum(self, cr, uid, force=False):
4845         """Clean the transient records.
4846
4847         This unlinks old records from the transient model tables whenever the
4848         "_transient_max_count" or "_max_age" conditions (if any) are reached.
4849         Actual cleaning will happen only once every "_transient_check_time" calls.
4850         This means this method can be called frequently called (e.g. whenever
4851         a new record is created).
4852         Example with both max_hours and max_count active:
4853         Suppose max_hours = 0.2 (e.g. 12 minutes), max_count = 20, there are 55 rows in the
4854         table, 10 created/changed in the last 5 minutes, an additional 12 created/changed between
4855         5 and 10 minutes ago, the rest created/changed more then 12 minutes ago.
4856         - age based vacuum will leave the 22 rows created/changed in the last 12 minutes
4857         - count based vacuum will wipe out another 12 rows. Not just 2, otherwise each addition
4858           would immediately cause the maximum to be reached again.
4859         - the 10 rows that have been created/changed the last 5 minutes will NOT be deleted
4860         """
4861         assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4862         _transient_check_time = 20          # arbitrary limit on vacuum executions
4863         self._transient_check_count += 1
4864         if not force and (self._transient_check_count < _transient_check_time):
4865             return True  # no vacuum cleaning this time
4866         self._transient_check_count = 0
4867
4868         # Age-based expiration
4869         if self._transient_max_hours:
4870             self._transient_clean_rows_older_than(cr, self._transient_max_hours * 60 * 60)
4871
4872         # Count-based expiration
4873         if self._transient_max_count:
4874             self._transient_clean_old_rows(cr, self._transient_max_count)
4875
4876         return True
4877
4878     def resolve_2many_commands(self, cr, uid, field_name, commands, fields=None, context=None):
4879         """ Serializes one2many and many2many commands into record dictionaries
4880             (as if all the records came from the database via a read()).  This
4881             method is aimed at onchange methods on one2many and many2many fields.
4882
4883             Because commands might be creation commands, not all record dicts
4884             will contain an ``id`` field.  Commands matching an existing record
4885             will have an ``id``.
4886
4887             :param field_name: name of the one2many or many2many field matching the commands
4888             :type field_name: str
4889             :param commands: one2many or many2many commands to execute on ``field_name``
4890             :type commands: list((int|False, int|False, dict|False))
4891             :param fields: list of fields to read from the database, when applicable
4892             :type fields: list(str)
4893             :returns: records in a shape similar to that returned by ``read()``
4894                 (except records may be missing the ``id`` field if they don't exist in db)
4895             :rtype: list(dict)
4896         """
4897         result = []             # result (list of dict)
4898         record_ids = []         # ids of records to read
4899         updates = {}            # {id: dict} of updates on particular records
4900
4901         for command in commands or []:
4902             if not isinstance(command, (list, tuple)):
4903                 record_ids.append(command)
4904             elif command[0] == 0:
4905                 result.append(command[2])
4906             elif command[0] == 1:
4907                 record_ids.append(command[1])
4908                 updates.setdefault(command[1], {}).update(command[2])
4909             elif command[0] in (2, 3):
4910                 record_ids = [id for id in record_ids if id != command[1]]
4911             elif command[0] == 4:
4912                 record_ids.append(command[1])
4913             elif command[0] == 5:
4914                 result, record_ids = [], []
4915             elif command[0] == 6:
4916                 result, record_ids = [], list(command[2])
4917
4918         # read the records and apply the updates
4919         other_model = self.pool[self._all_columns[field_name].column._obj]
4920         for record in other_model.read(cr, uid, record_ids, fields=fields, context=context):
4921             record.update(updates.get(record['id'], {}))
4922             result.append(record)
4923
4924         return result
4925
4926     # for backward compatibility
4927     resolve_o2m_commands_to_record_dicts = resolve_2many_commands
4928
4929     def search_read(self, cr, uid, domain=None, fields=None, offset=0, limit=None, order=None, context=None):
4930         """
4931         Performs a ``search()`` followed by a ``read()``.
4932
4933         :param cr: database cursor
4934         :param user: current user id
4935         :param domain: Search domain, see ``args`` parameter in ``search()``. Defaults to an empty domain that will match all records.
4936         :param fields: List of fields to read, see ``fields`` parameter in ``read()``. Defaults to all fields.
4937         :param offset: Number of records to skip, see ``offset`` parameter in ``search()``. Defaults to 0.
4938         :param limit: Maximum number of records to return, see ``limit`` parameter in ``search()``. Defaults to no limit.
4939         :param order: Columns to sort result, see ``order`` parameter in ``search()``. Defaults to no sort.
4940         :param context: context arguments.
4941         :return: List of dictionaries containing the asked fields.
4942         :rtype: List of dictionaries.
4943
4944         """
4945         record_ids = self.search(cr, uid, domain or [], offset=offset, limit=limit, order=order, context=context)
4946         if not record_ids:
4947             return []
4948
4949         if fields and fields == ['id']:
4950             # shortcut read if we only want the ids
4951             return [{'id': id} for id in record_ids]
4952
4953         # read() ignores active_test, but it would forward it to any downstream search call
4954         # (e.g. for x2m or function fields), and this is not the desired behavior, the flag
4955         # was presumably only meant for the main search().
4956         # TODO: Move this to read() directly?
4957         read_ctx = dict(context or {})
4958         read_ctx.pop('active_test', None)
4959
4960         result = self.read(cr, uid, record_ids, fields, context=read_ctx)
4961         if len(result) <= 1:
4962             return result
4963
4964         # reorder read
4965         index = dict((r['id'], r) for r in result)
4966         return [index[x] for x in record_ids if x in index]
4967
4968     def _register_hook(self, cr):
4969         """ stuff to do right after the registry is built """
4970         pass
4971
4972     def _patch_method(self, name, method):
4973         """ Monkey-patch a method for all instances of this model. This replaces
4974             the method called `name` by `method` in `self`'s class.
4975             The original method is then accessible via ``method.origin``, and it
4976             can be restored with :meth:`~._revert_method`.
4977
4978             Example::
4979
4980                 @api.multi
4981                 def do_write(self, values):
4982                     # do stuff, and call the original method
4983                     return do_write.origin(self, values)
4984
4985                 # patch method write of model
4986                 model._patch_method('write', do_write)
4987
4988                 # this will call do_write
4989                 records = model.search([...])
4990                 records.write(...)
4991
4992                 # restore the original method
4993                 model._revert_method('write')
4994         """
4995         cls = type(self)
4996         origin = getattr(cls, name)
4997         method.origin = origin
4998         # propagate decorators from origin to method, and apply api decorator
4999         wrapped = api.guess(api.propagate(origin, method))
5000         wrapped.origin = origin
5001         setattr(cls, name, wrapped)
5002
5003     def _revert_method(self, name):
5004         """ Revert the original method of `self` called `name`.
5005             See :meth:`~._patch_method`.
5006         """
5007         cls = type(self)
5008         method = getattr(cls, name)
5009         setattr(cls, name, method.origin)
5010
5011     #
5012     # Instance creation
5013     #
5014     # An instance represents an ordered collection of records in a given
5015     # execution environment. The instance object refers to the environment, and
5016     # the records themselves are represented by their cache dictionary. The 'id'
5017     # of each record is found in its corresponding cache dictionary.
5018     #
5019     # This design has the following advantages:
5020     #  - cache access is direct and thus fast;
5021     #  - one can consider records without an 'id' (see new records);
5022     #  - the global cache is only an index to "resolve" a record 'id'.
5023     #
5024
5025     @classmethod
5026     def _browse(cls, env, ids):
5027         """ Create an instance attached to `env`; `ids` is a tuple of record
5028             ids.
5029         """
5030         records = object.__new__(cls)
5031         records.env = env
5032         records._ids = ids
5033         env.prefetch[cls._name].update(ids)
5034         return records
5035
5036     @api.v8
5037     def browse(self, arg=None):
5038         """ Return an instance corresponding to `arg` and attached to
5039             `self.env`; `arg` is either a record id, or a collection of record ids.
5040         """
5041         ids = _normalize_ids(arg)
5042         #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5043         return self._browse(self.env, ids)
5044
5045     @api.v7
5046     def browse(self, cr, uid, arg=None, context=None):
5047         ids = _normalize_ids(arg)
5048         #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5049         return self._browse(Environment(cr, uid, context or {}), ids)
5050
5051     #
5052     # Internal properties, for manipulating the instance's implementation
5053     #
5054
5055     @property
5056     def ids(self):
5057         """ Return the list of non-false record ids of this instance. """
5058         return filter(None, list(self._ids))
5059
5060     # backward-compatibility with former browse records
5061     _cr = property(lambda self: self.env.cr)
5062     _uid = property(lambda self: self.env.uid)
5063     _context = property(lambda self: self.env.context)
5064
5065     #
5066     # Conversion methods
5067     #
5068
5069     def ensure_one(self):
5070         """ Return `self` if it is a singleton instance, otherwise raise an
5071             exception.
5072         """
5073         if len(self) == 1:
5074             return self
5075         raise except_orm("ValueError", "Expected singleton: %s" % self)
5076
5077     def with_env(self, env):
5078         """ Return an instance equivalent to `self` attached to `env`.
5079         """
5080         return self._browse(env, self._ids)
5081
5082     def sudo(self, user=SUPERUSER_ID):
5083         """ Return an instance equivalent to `self` attached to an environment
5084             based on `self.env` with the given `user`.
5085         """
5086         return self.with_env(self.env(user=user))
5087
5088     def with_context(self, *args, **kwargs):
5089         """ Return an instance equivalent to `self` attached to an environment
5090             based on `self.env` with another context. The context is given by
5091             `self._context` or the positional argument if given, and modified by
5092             `kwargs`.
5093         """
5094         context = dict(args[0] if args else self._context, **kwargs)
5095         return self.with_env(self.env(context=context))
5096
5097     def _convert_to_cache(self, values, validate=True):
5098         """ Convert the `values` dictionary into cached values. """
5099         fields = self._fields
5100         return {
5101             name: fields[name].convert_to_cache(value, self.env, validate=validate)
5102             for name, value in values.iteritems()
5103             if name in fields
5104         }
5105
5106     def _convert_to_write(self, values):
5107         """ Convert the `values` dictionary into the format of :meth:`write`. """
5108         fields = self._fields
5109         return dict(
5110             (name, fields[name].convert_to_write(value))
5111             for name, value in values.iteritems()
5112             if name in self._fields
5113         )
5114
5115     #
5116     # Record traversal and update
5117     #
5118
5119     def _mapped_func(self, func):
5120         """ Apply function `func` on all records in `self`, and return the
5121             result as a list or a recordset (if `func` return recordsets).
5122         """
5123         vals = [func(rec) for rec in self]
5124         val0 = vals[0] if vals else func(self)
5125         if isinstance(val0, BaseModel):
5126             return reduce(operator.or_, vals, val0)
5127         return vals
5128
5129     def mapped(self, func):
5130         """ Apply `func` on all records in `self`, and return the result as a
5131             list or a recordset (if `func` return recordsets). In the latter
5132             case, the order of the returned recordset is arbritrary.
5133
5134             :param func: a function or a dot-separated sequence of field names
5135         """
5136         if isinstance(func, basestring):
5137             recs = self
5138             for name in func.split('.'):
5139                 recs = recs._mapped_func(operator.itemgetter(name))
5140             return recs
5141         else:
5142             return self._mapped_func(func)
5143
5144     def _mapped_cache(self, name_seq):
5145         """ Same as `~.mapped`, but `name_seq` is a dot-separated sequence of
5146             field names, and only cached values are used.
5147         """
5148         recs = self
5149         for name in name_seq.split('.'):
5150             field = recs._fields[name]
5151             null = field.null(self.env)
5152             recs = recs.mapped(lambda rec: rec._cache.get(field, null))
5153         return recs
5154
5155     def filtered(self, func):
5156         """ Select the records in `self` such that `func(rec)` is true, and
5157             return them as a recordset.
5158
5159             :param func: a function or a dot-separated sequence of field names
5160         """
5161         if isinstance(func, basestring):
5162             name = func
5163             func = lambda rec: filter(None, rec.mapped(name))
5164         return self.browse([rec.id for rec in self if func(rec)])
5165
5166     def sorted(self, key=None):
5167         """ Return the recordset `self` ordered by `key` """
5168         if key is None:
5169             return self.search([('id', 'in', self.ids)])
5170         else:
5171             return self.browse(map(int, sorted(self, key=key)))
5172
5173     def update(self, values):
5174         """ Update record `self[0]` with `values`. """
5175         for name, value in values.iteritems():
5176             self[name] = value
5177
5178     #
5179     # New records - represent records that do not exist in the database yet;
5180     # they are used to compute default values and perform onchanges.
5181     #
5182
5183     @api.model
5184     def new(self, values={}):
5185         """ Return a new record instance attached to `self.env`, and
5186             initialized with the `values` dictionary. Such a record does not
5187             exist in the database.
5188         """
5189         record = self.browse([NewId()])
5190         record._cache.update(self._convert_to_cache(values))
5191
5192         if record.env.in_onchange:
5193             # The cache update does not set inverse fields, so do it manually.
5194             # This is useful for computing a function field on secondary
5195             # records, if that field depends on the main record.
5196             for name in values:
5197                 field = self._fields.get(name)
5198                 if field and field.inverse_field:
5199                     field.inverse_field._update(record[name], record)
5200
5201         return record
5202
5203     #
5204     # Dirty flag, to mark records modified (in draft mode)
5205     #
5206
5207     @property
5208     def _dirty(self):
5209         """ Return whether any record in `self` is dirty. """
5210         dirty = self.env.dirty
5211         return any(record in dirty for record in self)
5212
5213     @_dirty.setter
5214     def _dirty(self, value):
5215         """ Mark the records in `self` as dirty. """
5216         if value:
5217             map(self.env.dirty.add, self)
5218         else:
5219             map(self.env.dirty.discard, self)
5220
5221     #
5222     # "Dunder" methods
5223     #
5224
5225     def __nonzero__(self):
5226         """ Test whether `self` is nonempty. """
5227         return bool(getattr(self, '_ids', True))
5228
5229     def __len__(self):
5230         """ Return the size of `self`. """
5231         return len(self._ids)
5232
5233     def __iter__(self):
5234         """ Return an iterator over `self`. """
5235         for id in self._ids:
5236             yield self._browse(self.env, (id,))
5237
5238     def __contains__(self, item):
5239         """ Test whether `item` is a subset of `self` or a field name. """
5240         if isinstance(item, BaseModel):
5241             if self._name == item._name:
5242                 return set(item._ids) <= set(self._ids)
5243             raise except_orm("ValueError", "Mixing apples and oranges: %s in %s" % (item, self))
5244         if isinstance(item, basestring):
5245             return item in self._fields
5246         return item in self.ids
5247
5248     def __add__(self, other):
5249         """ Return the concatenation of two recordsets. """
5250         if not isinstance(other, BaseModel) or self._name != other._name:
5251             raise except_orm("ValueError", "Mixing apples and oranges: %s + %s" % (self, other))
5252         return self.browse(self._ids + other._ids)
5253
5254     def __sub__(self, other):
5255         """ Return the recordset of all the records in `self` that are not in `other`. """
5256         if not isinstance(other, BaseModel) or self._name != other._name:
5257             raise except_orm("ValueError", "Mixing apples and oranges: %s - %s" % (self, other))
5258         other_ids = set(other._ids)
5259         return self.browse([id for id in self._ids if id not in other_ids])
5260
5261     def __and__(self, other):
5262         """ Return the intersection of two recordsets.
5263             Note that recordset order is not preserved.
5264         """
5265         if not isinstance(other, BaseModel) or self._name != other._name:
5266             raise except_orm("ValueError", "Mixing apples and oranges: %s & %s" % (self, other))
5267         return self.browse(set(self._ids) & set(other._ids))
5268
5269     def __or__(self, other):
5270         """ Return the union of two recordsets.
5271             Note that recordset order is not preserved.
5272         """
5273         if not isinstance(other, BaseModel) or self._name != other._name:
5274             raise except_orm("ValueError", "Mixing apples and oranges: %s | %s" % (self, other))
5275         return self.browse(set(self._ids) | set(other._ids))
5276
5277     def __eq__(self, other):
5278         """ Test whether two recordsets are equivalent (up to reordering). """
5279         if not isinstance(other, BaseModel):
5280             if other:
5281                 _logger.warning("Comparing apples and oranges: %s == %s", self, other)
5282             return False
5283         return self._name == other._name and set(self._ids) == set(other._ids)
5284
5285     def __ne__(self, other):
5286         return not self == other
5287
5288     def __lt__(self, other):
5289         if not isinstance(other, BaseModel) or self._name != other._name:
5290             raise except_orm("ValueError", "Mixing apples and oranges: %s < %s" % (self, other))
5291         return set(self._ids) < set(other._ids)
5292
5293     def __le__(self, other):
5294         if not isinstance(other, BaseModel) or self._name != other._name:
5295             raise except_orm("ValueError", "Mixing apples and oranges: %s <= %s" % (self, other))
5296         return set(self._ids) <= set(other._ids)
5297
5298     def __gt__(self, other):
5299         if not isinstance(other, BaseModel) or self._name != other._name:
5300             raise except_orm("ValueError", "Mixing apples and oranges: %s > %s" % (self, other))
5301         return set(self._ids) > set(other._ids)
5302
5303     def __ge__(self, other):
5304         if not isinstance(other, BaseModel) or self._name != other._name:
5305             raise except_orm("ValueError", "Mixing apples and oranges: %s >= %s" % (self, other))
5306         return set(self._ids) >= set(other._ids)
5307
5308     def __int__(self):
5309         return self.id
5310
5311     def __str__(self):
5312         return "%s%s" % (self._name, getattr(self, '_ids', ""))
5313
5314     def __unicode__(self):
5315         return unicode(str(self))
5316
5317     __repr__ = __str__
5318
5319     def __hash__(self):
5320         if hasattr(self, '_ids'):
5321             return hash((self._name, frozenset(self._ids)))
5322         else:
5323             return hash(self._name)
5324
5325     def __getitem__(self, key):
5326         """ If `key` is an integer or a slice, return the corresponding record
5327             selection as an instance (attached to `self.env`).
5328             Otherwise read the field `key` of the first record in `self`.
5329
5330             Examples::
5331
5332                 inst = model.search(dom)    # inst is a recordset
5333                 r4 = inst[3]                # fourth record in inst
5334                 rs = inst[10:20]            # subset of inst
5335                 nm = rs['name']             # name of first record in inst
5336         """
5337         if isinstance(key, basestring):
5338             # important: one must call the field's getter
5339             return self._fields[key].__get__(self, type(self))
5340         elif isinstance(key, slice):
5341             return self._browse(self.env, self._ids[key])
5342         else:
5343             return self._browse(self.env, (self._ids[key],))
5344
5345     def __setitem__(self, key, value):
5346         """ Assign the field `key` to `value` in record `self`. """
5347         # important: one must call the field's setter
5348         return self._fields[key].__set__(self, value)
5349
5350     #
5351     # Cache and recomputation management
5352     #
5353
5354     @lazy_property
5355     def _cache(self):
5356         """ Return the cache of `self`, mapping field names to values. """
5357         return RecordCache(self)
5358
5359     @api.model
5360     def _in_cache_without(self, field):
5361         """ Make sure `self` is present in cache (for prefetching), and return
5362             the records of model `self` in cache that have no value for `field`
5363             (:class:`Field` instance).
5364         """
5365         env = self.env
5366         prefetch_ids = env.prefetch[self._name]
5367         prefetch_ids.update(self._ids)
5368         ids = filter(None, prefetch_ids - set(env.cache[field]))
5369         return self.browse(ids)
5370
5371     @api.model
5372     def refresh(self):
5373         """ Clear the records cache.
5374
5375             .. deprecated:: 8.0
5376                 The record cache is automatically invalidated.
5377         """
5378         self.invalidate_cache()
5379
5380     @api.model
5381     def invalidate_cache(self, fnames=None, ids=None):
5382         """ Invalidate the record caches after some records have been modified.
5383             If both `fnames` and `ids` are ``None``, the whole cache is cleared.
5384
5385             :param fnames: the list of modified fields, or ``None`` for all fields
5386             :param ids: the list of modified record ids, or ``None`` for all
5387         """
5388         if fnames is None:
5389             if ids is None:
5390                 return self.env.invalidate_all()
5391             fields = self._fields.values()
5392         else:
5393             fields = map(self._fields.__getitem__, fnames)
5394
5395         # invalidate fields and inverse fields, too
5396         spec = [(f, ids) for f in fields] + \
5397                [(f.inverse_field, None) for f in fields if f.inverse_field]
5398         self.env.invalidate(spec)
5399
5400     @api.multi
5401     def modified(self, fnames):
5402         """ Notify that fields have been modified on `self`. This invalidates
5403             the cache, and prepares the recomputation of stored function fields
5404             (new-style fields only).
5405
5406             :param fnames: iterable of field names that have been modified on
5407                 records `self`
5408         """
5409         # each field knows what to invalidate and recompute
5410         spec = []
5411         for fname in fnames:
5412             spec += self._fields[fname].modified(self)
5413
5414         cached_fields = {
5415             field
5416             for env in self.env.all
5417             for field in env.cache
5418         }
5419         # invalidate non-stored fields.function which are currently cached
5420         spec += [(f, None) for f in self.pool.pure_function_fields
5421                  if f in cached_fields]
5422
5423         self.env.invalidate(spec)
5424
5425     def _recompute_check(self, field):
5426         """ If `field` must be recomputed on some record in `self`, return the
5427             corresponding records that must be recomputed.
5428         """
5429         for env in [self.env] + list(iter(self.env.all)):
5430             if env.todo.get(field) and env.todo[field] & self:
5431                 return env.todo[field]
5432
5433     def _recompute_todo(self, field):
5434         """ Mark `field` to be recomputed. """
5435         todo = self.env.todo
5436         todo[field] = (todo.get(field) or self.browse()) | self
5437
5438     def _recompute_done(self, field):
5439         """ Mark `field` as being recomputed. """
5440         todo = self.env.todo
5441         if field in todo:
5442             recs = todo.pop(field) - self
5443             if recs:
5444                 todo[field] = recs
5445
5446     @api.model
5447     def recompute(self):
5448         """ Recompute stored function fields. The fields and records to
5449             recompute have been determined by method :meth:`modified`.
5450         """
5451         for env in list(iter(self.env.all)):
5452             while env.todo:
5453                 field, recs = next(env.todo.iteritems())
5454                 # evaluate the fields to recompute, and save them to database
5455                 for rec, rec1 in zip(recs, recs.with_context(recompute=False)):
5456                     try:
5457                         values = rec._convert_to_write({
5458                             f.name: rec[f.name] for f in field.computed_fields
5459                         })
5460                         rec1._write(values)
5461                     except MissingError:
5462                         pass
5463                 # mark the computed fields as done
5464                 map(recs._recompute_done, field.computed_fields)
5465
5466     #
5467     # Generic onchange method
5468     #
5469
5470     def _has_onchange(self, field, other_fields):
5471         """ Return whether `field` should trigger an onchange event in the
5472             presence of `other_fields`.
5473         """
5474         # test whether self has an onchange method for field, or field is a
5475         # dependency of any field in other_fields
5476         return field.name in self._onchange_methods or \
5477             any(dep in other_fields for dep in field.dependents)
5478
5479     @api.model
5480     def _onchange_spec(self, view_info=None):
5481         """ Return the onchange spec from a view description; if not given, the
5482             result of ``self.fields_view_get()`` is used.
5483         """
5484         result = {}
5485
5486         # for traversing the XML arch and populating result
5487         def process(node, info, prefix):
5488             if node.tag == 'field':
5489                 name = node.attrib['name']
5490                 names = "%s.%s" % (prefix, name) if prefix else name
5491                 if not result.get(names):
5492                     result[names] = node.attrib.get('on_change')
5493                 # traverse the subviews included in relational fields
5494                 for subinfo in info['fields'][name].get('views', {}).itervalues():
5495                     process(etree.fromstring(subinfo['arch']), subinfo, names)
5496             else:
5497                 for child in node:
5498                     process(child, info, prefix)
5499
5500         if view_info is None:
5501             view_info = self.fields_view_get()
5502         process(etree.fromstring(view_info['arch']), view_info, '')
5503         return result
5504
5505     def _onchange_eval(self, field_name, onchange, result):
5506         """ Apply onchange method(s) for field `field_name` with spec `onchange`
5507             on record `self`. Value assignments are applied on `self`, while
5508             domain and warning messages are put in dictionary `result`.
5509         """
5510         onchange = onchange.strip()
5511
5512         # onchange V8
5513         if onchange in ("1", "true"):
5514             for method in self._onchange_methods.get(field_name, ()):
5515                 method_res = method(self)
5516                 if not method_res:
5517                     continue
5518                 if 'domain' in method_res:
5519                     result.setdefault('domain', {}).update(method_res['domain'])
5520                 if 'warning' in method_res:
5521                     result['warning'] = method_res['warning']
5522             return
5523
5524         # onchange V7
5525         match = onchange_v7.match(onchange)
5526         if match:
5527             method, params = match.groups()
5528
5529             # evaluate params -> tuple
5530             global_vars = {'context': self._context, 'uid': self._uid}
5531             if self._context.get('field_parent'):
5532                 class RawRecord(object):
5533                     def __init__(self, record):
5534                         self._record = record
5535                     def __getattr__(self, name):
5536                         field = self._record._fields[name]
5537                         value = self._record[name]
5538                         return field.convert_to_onchange(value)
5539                 record = self[self._context['field_parent']]
5540                 global_vars['parent'] = RawRecord(record)
5541             field_vars = {
5542                 key: self._fields[key].convert_to_onchange(val)
5543                 for key, val in self._cache.iteritems()
5544             }
5545             params = eval("[%s]" % params, global_vars, field_vars)
5546
5547             # call onchange method
5548             args = (self._cr, self._uid, self._origin.ids) + tuple(params)
5549             method_res = getattr(self._model, method)(*args)
5550             if not isinstance(method_res, dict):
5551                 return
5552             if 'value' in method_res:
5553                 method_res['value'].pop('id', None)
5554                 self.update(self._convert_to_cache(method_res['value'], validate=False))
5555             if 'domain' in method_res:
5556                 result.setdefault('domain', {}).update(method_res['domain'])
5557             if 'warning' in method_res:
5558                 result['warning'] = method_res['warning']
5559
5560     @api.multi
5561     def onchange(self, values, field_name, field_onchange):
5562         """ Perform an onchange on the given field.
5563
5564             :param values: dictionary mapping field names to values, giving the
5565                 current state of modification
5566             :param field_name: name of the modified field_name
5567             :param field_onchange: dictionary mapping field names to their
5568                 on_change attribute
5569         """
5570         env = self.env
5571
5572         if field_name and field_name not in self._fields:
5573             return {}
5574
5575         # determine subfields for field.convert_to_write() below
5576         secondary = []
5577         subfields = defaultdict(set)
5578         for dotname in field_onchange:
5579             if '.' in dotname:
5580                 secondary.append(dotname)
5581                 name, subname = dotname.split('.')
5582                 subfields[name].add(subname)
5583
5584         # create a new record with values, and attach `self` to it
5585         with env.do_in_onchange():
5586             record = self.new(values)
5587             values = dict(record._cache)
5588             # attach `self` with a different context (for cache consistency)
5589             record._origin = self.with_context(__onchange=True)
5590
5591         # determine which field should be triggered an onchange
5592         todo = set([field_name]) if field_name else set(values)
5593         done = set()
5594
5595         # dummy assignment: trigger invalidations on the record
5596         for name in todo:
5597             record[name] = record[name]
5598
5599         result = {'value': {}}
5600
5601         while todo:
5602             name = todo.pop()
5603             if name in done:
5604                 continue
5605             done.add(name)
5606
5607             with env.do_in_onchange():
5608                 # apply field-specific onchange methods
5609                 if field_onchange.get(name):
5610                     record._onchange_eval(name, field_onchange[name], result)
5611
5612                 # force re-evaluation of function fields on secondary records
5613                 for field_seq in secondary:
5614                     record.mapped(field_seq)
5615
5616                 # determine which fields have been modified
5617                 for name, oldval in values.iteritems():
5618                     newval = record[name]
5619                     if newval != oldval or getattr(newval, '_dirty', False):
5620                         field = self._fields[name]
5621                         result['value'][name] = field.convert_to_write(
5622                             newval, record._origin, subfields[name],
5623                         )
5624                         todo.add(name)
5625
5626         # At the moment, the client does not support updates on a *2many field
5627         # while this one is modified by the user.
5628         if field_name and self._fields[field_name].type in ('one2many', 'many2many'):
5629             result['value'].pop(field_name, None)
5630
5631         return result
5632
5633
5634 class RecordCache(MutableMapping):
5635     """ Implements a proxy dictionary to read/update the cache of a record.
5636         Upon iteration, it looks like a dictionary mapping field names to
5637         values. However, fields may be used as keys as well.
5638     """
5639     def __init__(self, records):
5640         self._recs = records
5641
5642     def __contains__(self, field):
5643         """ Return whether `records[0]` has a value for `field` in cache. """
5644         if isinstance(field, basestring):
5645             field = self._recs._fields[field]
5646         return self._recs.id in self._recs.env.cache[field]
5647
5648     def __getitem__(self, field):
5649         """ Return the cached value of `field` for `records[0]`. """
5650         if isinstance(field, basestring):
5651             field = self._recs._fields[field]
5652         value = self._recs.env.cache[field][self._recs.id]
5653         return value.get() if isinstance(value, SpecialValue) else value
5654
5655     def __setitem__(self, field, value):
5656         """ Assign the cached value of `field` for all records in `records`. """
5657         if isinstance(field, basestring):
5658             field = self._recs._fields[field]
5659         values = dict.fromkeys(self._recs._ids, value)
5660         self._recs.env.cache[field].update(values)
5661
5662     def update(self, *args, **kwargs):
5663         """ Update the cache of all records in `records`. If the argument is a
5664             `SpecialValue`, update all fields (except "magic" columns).
5665         """
5666         if args and isinstance(args[0], SpecialValue):
5667             values = dict.fromkeys(self._recs._ids, args[0])
5668             for name, field in self._recs._fields.iteritems():
5669                 if name != 'id':
5670                     self._recs.env.cache[field].update(values)
5671         else:
5672             return super(RecordCache, self).update(*args, **kwargs)
5673
5674     def __delitem__(self, field):
5675         """ Remove the cached value of `field` for all `records`. """
5676         if isinstance(field, basestring):
5677             field = self._recs._fields[field]
5678         field_cache = self._recs.env.cache[field]
5679         for id in self._recs._ids:
5680             field_cache.pop(id, None)
5681
5682     def __iter__(self):
5683         """ Iterate over the field names with a regular value in cache. """
5684         cache, id = self._recs.env.cache, self._recs.id
5685         dummy = SpecialValue(None)
5686         for name, field in self._recs._fields.iteritems():
5687             if name != 'id' and not isinstance(cache[field].get(id, dummy), SpecialValue):
5688                 yield name
5689
5690     def __len__(self):
5691         """ Return the number of fields with a regular value in cache. """
5692         return sum(1 for name in self)
5693
5694 class Model(BaseModel):
5695     """Main super-class for regular database-persisted OpenERP models.
5696
5697     OpenERP models are created by inheriting from this class::
5698
5699         class user(Model):
5700             ...
5701
5702     The system will later instantiate the class once per database (on
5703     which the class' module is installed).
5704     """
5705     _auto = True
5706     _register = False # not visible in ORM registry, meant to be python-inherited only
5707     _transient = False # True in a TransientModel
5708
5709 class TransientModel(BaseModel):
5710     """Model super-class for transient records, meant to be temporarily
5711        persisted, and regularly vaccuum-cleaned.
5712
5713        A TransientModel has a simplified access rights management,
5714        all users can create new records, and may only access the
5715        records they created. The super-user has unrestricted access
5716        to all TransientModel records.
5717     """
5718     _auto = True
5719     _register = False # not visible in ORM registry, meant to be python-inherited only
5720     _transient = True
5721
5722 class AbstractModel(BaseModel):
5723     """Abstract Model super-class for creating an abstract class meant to be
5724        inherited by regular models (Models or TransientModels) but not meant to
5725        be usable on its own, or persisted.
5726
5727        Technical note: we don't want to make AbstractModel the super-class of
5728        Model or BaseModel because it would not make sense to put the main
5729        definition of persistence methods such as create() in it, and still we
5730        should be able to override them within an AbstractModel.
5731        """
5732     _auto = False # don't create any database backend for AbstractModels
5733     _register = False # not visible in ORM registry, meant to be python-inherited only
5734     _transient = False
5735
5736 def itemgetter_tuple(items):
5737     """ Fixes itemgetter inconsistency (useful in some cases) of not returning
5738     a tuple if len(items) == 1: always returns an n-tuple where n = len(items)
5739     """
5740     if len(items) == 0:
5741         return lambda a: ()
5742     if len(items) == 1:
5743         return lambda gettable: (gettable[items[0]],)
5744     return operator.itemgetter(*items)
5745
5746 def convert_pgerror_23502(model, fields, info, e):
5747     m = re.match(r'^null value in column "(?P<field>\w+)" violates '
5748                  r'not-null constraint\n',
5749                  str(e))
5750     field_name = m and m.group('field')
5751     if not m or field_name not in fields:
5752         return {'message': unicode(e)}
5753     message = _(u"Missing required value for the field '%s'.") % field_name
5754     field = fields.get(field_name)
5755     if field:
5756         message = _(u"Missing required value for the field '%s' (%s)") % (field['string'], field_name)
5757     return {
5758         'message': message,
5759         'field': field_name,
5760     }
5761
5762 def convert_pgerror_23505(model, fields, info, e):
5763     m = re.match(r'^duplicate key (?P<field>\w+) violates unique constraint',
5764                  str(e))
5765     field_name = m and m.group('field')
5766     if not m or field_name not in fields:
5767         return {'message': unicode(e)}
5768     message = _(u"The value for the field '%s' already exists.") % field_name
5769     field = fields.get(field_name)
5770     if field:
5771         message = _(u"%s This might be '%s' in the current model, or a field "
5772                     u"of the same name in an o2m.") % (message, field['string'])
5773     return {
5774         'message': message,
5775         'field': field_name,
5776     }
5777
5778 PGERROR_TO_OE = defaultdict(
5779     # shape of mapped converters
5780     lambda: (lambda model, fvg, info, pgerror: {'message': unicode(pgerror)}), {
5781     # not_null_violation
5782     '23502': convert_pgerror_23502,
5783     # unique constraint error
5784     '23505': convert_pgerror_23505,
5785 })
5786
5787 def _normalize_ids(arg, atoms={int, long, str, unicode, NewId}):
5788     """ Normalizes the ids argument for ``browse`` (v7 and v8) to a tuple.
5789
5790     Various implementations were tested on the corpus of all browse() calls
5791     performed during a full crawler run (after having installed all website_*
5792     modules) and this one was the most efficient overall.
5793
5794     A possible bit of correctness was sacrificed by not doing any test on
5795     Iterable and just assuming that any non-atomic type was an iterable of
5796     some kind.
5797
5798     :rtype: tuple
5799     """
5800     # much of the corpus is falsy objects (empty list, tuple or set, None)
5801     if not arg:
5802         return ()
5803
5804     # `type in set` is significantly faster (because more restrictive) than
5805     # isinstance(arg, set) or issubclass(type, set); and for new-style classes
5806     # obj.__class__ is equivalent to but faster than type(obj). Not relevant
5807     # (and looks much worse) in most cases, but over millions of calls it
5808     # does have a very minor effect.
5809     if arg.__class__ in atoms:
5810         return arg,
5811
5812     return tuple(arg)
5813
5814 # keep those imports here to avoid dependency cycle errors
5815 from .osv import expression
5816 from .fields import Field, SpecialValue, FailedValue
5817
5818 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: