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