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 non-existing 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, definition):
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 type, definition 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         constraints = cr.dictfetchone()
2318         if not constraints:
2319             cr.execute("""
2320                 INSERT INTO ir_model_constraint
2321                     (name, date_init, date_update, module, model, type, definition)
2322                 VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2323                     (SELECT id FROM ir_module_module WHERE name=%s),
2324                     (SELECT id FROM ir_model WHERE model=%s), %s, %s)""",
2325                     (constraint_name, self._module, self._name, type, definition))
2326         elif constraints['type'] != type or (definition and constraints['definition'] != definition):
2327             cr.execute("""
2328                 UPDATE ir_model_constraint
2329                 SET date_update=now() AT TIME ZONE 'UTC', type=%s, definition=%s
2330                 WHERE name=%s AND module = (SELECT id FROM ir_module_module WHERE name=%s)""",
2331                     (type, definition, constraint_name, self._module))
2332
2333     def _save_relation_table(self, cr, relation_table):
2334         """
2335         Record the creation of a many2many for this model, to make it possible
2336         to delete it later when the module is uninstalled.
2337         """
2338         cr.execute("""
2339             SELECT 1 FROM ir_model_relation, ir_module_module
2340             WHERE ir_model_relation.module=ir_module_module.id
2341                 AND ir_model_relation.name=%s
2342                 AND ir_module_module.name=%s
2343             """, (relation_table, self._module))
2344         if not cr.rowcount:
2345             cr.execute("""INSERT INTO ir_model_relation (name, date_init, date_update, module, model)
2346                                  VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2347                     (SELECT id FROM ir_module_module WHERE name=%s),
2348                     (SELECT id FROM ir_model WHERE model=%s))""",
2349                        (relation_table, self._module, self._name))
2350             self.invalidate_cache(cr, SUPERUSER_ID)
2351
2352     # checked version: for direct m2o starting from `self`
2353     def _m2o_add_foreign_key_checked(self, source_field, dest_model, ondelete):
2354         assert self.is_transient() or not dest_model.is_transient(), \
2355             'Many2One relationships from non-transient Model to TransientModel are forbidden'
2356         if self.is_transient() and not dest_model.is_transient():
2357             # TransientModel relationships to regular Models are annoying
2358             # usually because they could block deletion due to the FKs.
2359             # So unless stated otherwise we default them to ondelete=cascade.
2360             ondelete = ondelete or 'cascade'
2361         fk_def = (self._table, source_field, dest_model._table, ondelete or 'set null')
2362         self._foreign_keys.add(fk_def)
2363         _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2364
2365     # unchecked version: for custom cases, such as m2m relationships
2366     def _m2o_add_foreign_key_unchecked(self, source_table, source_field, dest_model, ondelete):
2367         fk_def = (source_table, source_field, dest_model._table, ondelete or 'set null')
2368         self._foreign_keys.add(fk_def)
2369         _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2370
2371     def _drop_constraint(self, cr, source_table, constraint_name):
2372         cr.execute("ALTER TABLE %s DROP CONSTRAINT %s" % (source_table,constraint_name))
2373
2374     def _m2o_fix_foreign_key(self, cr, source_table, source_field, dest_model, ondelete):
2375         # Find FK constraint(s) currently established for the m2o field,
2376         # and see whether they are stale or not
2377         cr.execute("""SELECT confdeltype as ondelete_rule, conname as constraint_name,
2378                              cl2.relname as foreign_table
2379                       FROM pg_constraint as con, pg_class as cl1, pg_class as cl2,
2380                            pg_attribute as att1, pg_attribute as att2
2381                       WHERE con.conrelid = cl1.oid
2382                         AND cl1.relname = %s
2383                         AND con.confrelid = cl2.oid
2384                         AND array_lower(con.conkey, 1) = 1
2385                         AND con.conkey[1] = att1.attnum
2386                         AND att1.attrelid = cl1.oid
2387                         AND att1.attname = %s
2388                         AND array_lower(con.confkey, 1) = 1
2389                         AND con.confkey[1] = att2.attnum
2390                         AND att2.attrelid = cl2.oid
2391                         AND att2.attname = %s
2392                         AND con.contype = 'f'""", (source_table, source_field, 'id'))
2393         constraints = cr.dictfetchall()
2394         if constraints:
2395             if len(constraints) == 1:
2396                 # Is it the right constraint?
2397                 cons, = constraints
2398                 if cons['ondelete_rule'] != POSTGRES_CONFDELTYPES.get((ondelete or 'set null').upper(), 'a')\
2399                     or cons['foreign_table'] != dest_model._table:
2400                     # Wrong FK: drop it and recreate
2401                     _schema.debug("Table '%s': dropping obsolete FK constraint: '%s'",
2402                                   source_table, cons['constraint_name'])
2403                     self._drop_constraint(cr, source_table, cons['constraint_name'])
2404                 else:
2405                     # it's all good, nothing to do!
2406                     return
2407             else:
2408                 # Multiple FKs found for the same field, drop them all, and re-create
2409                 for cons in constraints:
2410                     _schema.debug("Table '%s': dropping duplicate FK constraints: '%s'",
2411                                   source_table, cons['constraint_name'])
2412                     self._drop_constraint(cr, source_table, cons['constraint_name'])
2413
2414         # (re-)create the FK
2415         self._m2o_add_foreign_key_checked(source_field, dest_model, ondelete)
2416
2417
2418     def _set_default_value_on_column(self, cr, column_name, context=None):
2419         # ideally, we should use default_get(), but it fails due to ir.values
2420         # not being ready
2421
2422         # get default value
2423         default = self._defaults.get(column_name)
2424         if callable(default):
2425             default = default(self, cr, SUPERUSER_ID, context)
2426
2427         column = self._columns[column_name]
2428         ss = column._symbol_set
2429         db_default = ss[1](default)
2430         # Write default if non-NULL, except for booleans for which False means
2431         # the same as NULL - this saves us an expensive query on large tables.
2432         write_default = (db_default is not None if column._type != 'boolean'
2433                             else db_default)
2434         if write_default:
2435             _logger.debug("Table '%s': setting default value of new column %s to %r",
2436                           self._table, column_name, default)
2437             query = 'UPDATE "%s" SET "%s"=%s WHERE "%s" is NULL' % (
2438                 self._table, column_name, ss[0], column_name)
2439             cr.execute(query, (db_default,))
2440             # this is a disgrace
2441             cr.commit()
2442
2443     def _auto_init(self, cr, context=None):
2444         """
2445
2446         Call _field_create and, unless _auto is False:
2447
2448         - create the corresponding table in database for the model,
2449         - possibly add the parent columns in database,
2450         - possibly add the columns 'create_uid', 'create_date', 'write_uid',
2451           'write_date' in database if _log_access is True (the default),
2452         - report on database columns no more existing in _columns,
2453         - remove no more existing not null constraints,
2454         - alter existing database columns to match _columns,
2455         - create database tables to match _columns,
2456         - add database indices to match _columns,
2457         - save in self._foreign_keys a list a foreign keys to create (see
2458           _auto_end).
2459
2460         """
2461         self._foreign_keys = set()
2462         raise_on_invalid_object_name(self._name)
2463         if context is None:
2464             context = {}
2465         store_compute = False
2466         stored_fields = []              # new-style stored fields with compute
2467         todo_end = []
2468         update_custom_fields = context.get('update_custom_fields', False)
2469         self._field_create(cr, context=context)
2470         create = not self._table_exist(cr)
2471         if self._auto:
2472
2473             if create:
2474                 self._create_table(cr)
2475                 has_rows = False
2476             else:
2477                 cr.execute('SELECT 1 FROM "%s" LIMIT 1' % self._table)
2478                 has_rows = cr.rowcount
2479
2480             cr.commit()
2481             if self._parent_store:
2482                 if not self._parent_columns_exist(cr):
2483                     self._create_parent_columns(cr)
2484                     store_compute = True
2485
2486             self._check_removed_columns(cr, log=False)
2487
2488             # iterate on the "object columns"
2489             column_data = self._select_column_data(cr)
2490
2491             for k, f in self._columns.iteritems():
2492                 if k == 'id': # FIXME: maybe id should be a regular column?
2493                     continue
2494                 # Don't update custom (also called manual) fields
2495                 if f.manual and not update_custom_fields:
2496                     continue
2497
2498                 if isinstance(f, fields.one2many):
2499                     self._o2m_raise_on_missing_reference(cr, f)
2500
2501                 elif isinstance(f, fields.many2many):
2502                     self._m2m_raise_or_create_relation(cr, f)
2503
2504                 else:
2505                     res = column_data.get(k)
2506
2507                     # The field is not found as-is in database, try if it
2508                     # exists with an old name.
2509                     if not res and hasattr(f, 'oldname'):
2510                         res = column_data.get(f.oldname)
2511                         if res:
2512                             cr.execute('ALTER TABLE "%s" RENAME "%s" TO "%s"' % (self._table, f.oldname, k))
2513                             res['attname'] = k
2514                             column_data[k] = res
2515                             _schema.debug("Table '%s': renamed column '%s' to '%s'",
2516                                 self._table, f.oldname, k)
2517
2518                     # The field already exists in database. Possibly
2519                     # change its type, rename it, drop it or change its
2520                     # constraints.
2521                     if res:
2522                         f_pg_type = res['typname']
2523                         f_pg_size = res['size']
2524                         f_pg_notnull = res['attnotnull']
2525                         if isinstance(f, fields.function) and not f.store and\
2526                                 not getattr(f, 'nodrop', False):
2527                             _logger.info('column %s (%s) converted to a function, removed from table %s',
2528                                          k, f.string, self._table)
2529                             cr.execute('ALTER TABLE "%s" DROP COLUMN "%s" CASCADE' % (self._table, k))
2530                             cr.commit()
2531                             _schema.debug("Table '%s': dropped column '%s' with cascade",
2532                                 self._table, k)
2533                             f_obj_type = None
2534                         else:
2535                             f_obj_type = get_pg_type(f) and get_pg_type(f)[0]
2536
2537                         if f_obj_type:
2538                             ok = False
2539                             casts = [
2540                                 ('text', 'char', pg_varchar(f.size), '::%s' % pg_varchar(f.size)),
2541                                 ('varchar', 'text', 'TEXT', ''),
2542                                 ('int4', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2543                                 ('date', 'datetime', 'TIMESTAMP', '::TIMESTAMP'),
2544                                 ('timestamp', 'date', 'date', '::date'),
2545                                 ('numeric', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2546                                 ('float8', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2547                             ]
2548                             if f_pg_type == 'varchar' and f._type == 'char' and f_pg_size and (f.size is None or f_pg_size < f.size):
2549                                 try:
2550                                     with cr.savepoint():
2551                                         cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" TYPE %s' % (self._table, k, pg_varchar(f.size)))
2552                                 except psycopg2.NotSupportedError:
2553                                     # In place alter table cannot be done because a view is depending of this field.
2554                                     # Do a manual copy. This will drop the view (that will be recreated later)
2555                                     cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO temp_change_size' % (self._table, k))
2556                                     cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, pg_varchar(f.size)))
2557                                     cr.execute('UPDATE "%s" SET "%s"=temp_change_size::%s' % (self._table, k, pg_varchar(f.size)))
2558                                     cr.execute('ALTER TABLE "%s" DROP COLUMN temp_change_size CASCADE' % (self._table,))
2559                                 cr.commit()
2560                                 _schema.debug("Table '%s': column '%s' (type varchar) changed size from %s to %s",
2561                                     self._table, k, f_pg_size or 'unlimited', f.size or 'unlimited')
2562                             for c in casts:
2563                                 if (f_pg_type==c[0]) and (f._type==c[1]):
2564                                     if f_pg_type != f_obj_type:
2565                                         ok = True
2566                                         cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO __temp_type_cast' % (self._table, k))
2567                                         cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, c[2]))
2568                                         cr.execute(('UPDATE "%s" SET "%s"= __temp_type_cast'+c[3]) % (self._table, k))
2569                                         cr.execute('ALTER TABLE "%s" DROP COLUMN  __temp_type_cast CASCADE' % (self._table,))
2570                                         cr.commit()
2571                                         _schema.debug("Table '%s': column '%s' changed type from %s to %s",
2572                                             self._table, k, c[0], c[1])
2573                                     break
2574
2575                             if f_pg_type != f_obj_type:
2576                                 if not ok:
2577                                     i = 0
2578                                     while True:
2579                                         newname = k + '_moved' + str(i)
2580                                         cr.execute("SELECT count(1) FROM pg_class c,pg_attribute a " \
2581                                             "WHERE c.relname=%s " \
2582                                             "AND a.attname=%s " \
2583                                             "AND c.oid=a.attrelid ", (self._table, newname))
2584                                         if not cr.fetchone()[0]:
2585                                             break
2586                                         i += 1
2587                                     if f_pg_notnull:
2588                                         cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2589                                     cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO "%s"' % (self._table, k, newname))
2590                                     cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2591                                     cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2592                                     _schema.debug("Table '%s': column '%s' has changed type (DB=%s, def=%s), data moved to column %s !",
2593                                         self._table, k, f_pg_type, f._type, newname)
2594
2595                             # if the field is required and hasn't got a NOT NULL constraint
2596                             if f.required and f_pg_notnull == 0:
2597                                 if has_rows:
2598                                     self._set_default_value_on_column(cr, k, context=context)
2599                                 # add the NOT NULL constraint
2600                                 try:
2601                                     cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k), log_exceptions=False)
2602                                     cr.commit()
2603                                     _schema.debug("Table '%s': column '%s': added NOT NULL constraint",
2604                                         self._table, k)
2605                                 except Exception:
2606                                     msg = "Table '%s': unable to set a NOT NULL constraint on column '%s' !\n"\
2607                                         "If you want to have it, you should update the records and execute manually:\n"\
2608                                         "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2609                                     _schema.warning(msg, self._table, k, self._table, k)
2610                                 cr.commit()
2611                             elif not f.required and f_pg_notnull == 1:
2612                                 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2613                                 cr.commit()
2614                                 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2615                                     self._table, k)
2616                             # Verify index
2617                             indexname = '%s_%s_index' % (self._table, k)
2618                             cr.execute("SELECT indexname FROM pg_indexes WHERE indexname = %s and tablename = %s", (indexname, self._table))
2619                             res2 = cr.dictfetchall()
2620                             if not res2 and f.select:
2621                                 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2622                                 cr.commit()
2623                                 if f._type == 'text':
2624                                     # FIXME: for fields.text columns we should try creating GIN indexes instead (seems most suitable for an ERP context)
2625                                     msg = "Table '%s': Adding (b-tree) index for %s column '%s'."\
2626                                         "This is probably useless (does not work for fulltext search) and prevents INSERTs of long texts"\
2627                                         " because there is a length limit for indexable btree values!\n"\
2628                                         "Use a search view instead if you simply want to make the field searchable."
2629                                     _schema.warning(msg, self._table, f._type, k)
2630                             if res2 and not f.select:
2631                                 cr.execute('DROP INDEX "%s_%s_index"' % (self._table, k))
2632                                 cr.commit()
2633                                 msg = "Table '%s': dropping index for column '%s' of type '%s' as it is not required anymore"
2634                                 _schema.debug(msg, self._table, k, f._type)
2635
2636                             if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2637                                 dest_model = self.pool[f._obj]
2638                                 if dest_model._auto and dest_model._table != 'ir_actions':
2639                                     self._m2o_fix_foreign_key(cr, self._table, k, dest_model, f.ondelete)
2640
2641                     # The field doesn't exist in database. Create it if necessary.
2642                     else:
2643                         if not isinstance(f, fields.function) or f.store:
2644                             # add the missing field
2645                             cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2646                             cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2647                             _schema.debug("Table '%s': added column '%s' with definition=%s",
2648                                 self._table, k, get_pg_type(f)[1])
2649
2650                             # initialize it
2651                             if has_rows:
2652                                 self._set_default_value_on_column(cr, k, context=context)
2653
2654                             # remember the functions to call for the stored fields
2655                             if isinstance(f, fields.function):
2656                                 order = 10
2657                                 if f.store is not True: # i.e. if f.store is a dict
2658                                     order = f.store[f.store.keys()[0]][2]
2659                                 todo_end.append((order, self._update_store, (f, k)))
2660
2661                             # remember new-style stored fields with compute method
2662                             if k in self._fields and self._fields[k].depends:
2663                                 stored_fields.append(self._fields[k])
2664
2665                             # and add constraints if needed
2666                             if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2667                                 if f._obj not in self.pool:
2668                                     raise except_orm('Programming Error', 'There is no reference available for %s' % (f._obj,))
2669                                 dest_model = self.pool[f._obj]
2670                                 ref = dest_model._table
2671                                 # ir_actions is inherited so foreign key doesn't work on it
2672                                 if dest_model._auto and ref != 'ir_actions':
2673                                     self._m2o_add_foreign_key_checked(k, dest_model, f.ondelete)
2674                             if f.select:
2675                                 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2676                             if f.required:
2677                                 try:
2678                                     cr.commit()
2679                                     cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k))
2680                                     _schema.debug("Table '%s': column '%s': added a NOT NULL constraint",
2681                                         self._table, k)
2682                                 except Exception:
2683                                     msg = "WARNING: unable to set column %s of table %s not null !\n"\
2684                                         "Try to re-run: openerp-server --update=module\n"\
2685                                         "If it doesn't work, update records and execute manually:\n"\
2686                                         "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2687                                     _logger.warning(msg, k, self._table, self._table, k, exc_info=True)
2688                             cr.commit()
2689
2690         else:
2691             cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2692             create = not bool(cr.fetchone())
2693
2694         cr.commit()     # start a new transaction
2695
2696         if self._auto:
2697             self._add_sql_constraints(cr)
2698
2699         if create:
2700             self._execute_sql(cr)
2701
2702         if store_compute:
2703             self._parent_store_compute(cr)
2704             cr.commit()
2705
2706         if stored_fields:
2707             # trigger computation of new-style stored fields with a compute
2708             def func(cr):
2709                 _logger.info("Storing computed values of %s fields %s",
2710                     self._name, ', '.join(sorted(f.name for f in stored_fields)))
2711                 recs = self.browse(cr, SUPERUSER_ID, [], {'active_test': False})
2712                 recs = recs.search([])
2713                 if recs:
2714                     map(recs._recompute_todo, stored_fields)
2715                     recs.recompute()
2716
2717             todo_end.append((1000, func, ()))
2718
2719         return todo_end
2720
2721     def _auto_end(self, cr, context=None):
2722         """ Create the foreign keys recorded by _auto_init. """
2723         for t, k, r, d in self._foreign_keys:
2724             cr.execute('ALTER TABLE "%s" ADD FOREIGN KEY ("%s") REFERENCES "%s" ON DELETE %s' % (t, k, r, d))
2725             self._save_constraint(cr, "%s_%s_fkey" % (t, k), 'f', False)
2726         cr.commit()
2727         del self._foreign_keys
2728
2729
2730     def _table_exist(self, cr):
2731         cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2732         return cr.rowcount
2733
2734
2735     def _create_table(self, cr):
2736         cr.execute('CREATE TABLE "%s" (id SERIAL NOT NULL, PRIMARY KEY(id))' % (self._table,))
2737         cr.execute(("COMMENT ON TABLE \"%s\" IS %%s" % self._table), (self._description,))
2738         _schema.debug("Table '%s': created", self._table)
2739
2740
2741     def _parent_columns_exist(self, cr):
2742         cr.execute("""SELECT c.relname
2743             FROM pg_class c, pg_attribute a
2744             WHERE c.relname=%s AND a.attname=%s AND c.oid=a.attrelid
2745             """, (self._table, 'parent_left'))
2746         return cr.rowcount
2747
2748
2749     def _create_parent_columns(self, cr):
2750         cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_left" INTEGER' % (self._table,))
2751         cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_right" INTEGER' % (self._table,))
2752         if 'parent_left' not in self._columns:
2753             _logger.error('create a column parent_left on object %s: fields.integer(\'Left Parent\', select=1)',
2754                           self._table)
2755             _schema.debug("Table '%s': added column '%s' with definition=%s",
2756                 self._table, 'parent_left', 'INTEGER')
2757         elif not self._columns['parent_left'].select:
2758             _logger.error('parent_left column on object %s must be indexed! Add select=1 to the field definition)',
2759                           self._table)
2760         if 'parent_right' not in self._columns:
2761             _logger.error('create a column parent_right on object %s: fields.integer(\'Right Parent\', select=1)',
2762                           self._table)
2763             _schema.debug("Table '%s': added column '%s' with definition=%s",
2764                 self._table, 'parent_right', 'INTEGER')
2765         elif not self._columns['parent_right'].select:
2766             _logger.error('parent_right column on object %s must be indexed! Add select=1 to the field definition)',
2767                           self._table)
2768         if self._columns[self._parent_name].ondelete not in ('cascade', 'restrict'):
2769             _logger.error("The column %s on object %s must be set as ondelete='cascade' or 'restrict'",
2770                           self._parent_name, self._name)
2771
2772         cr.commit()
2773
2774
2775     def _select_column_data(self, cr):
2776         # attlen is the number of bytes necessary to represent the type when
2777         # the type has a fixed size. If the type has a varying size attlen is
2778         # -1 and atttypmod is the size limit + 4, or -1 if there is no limit.
2779         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 " \
2780            "FROM pg_class c,pg_attribute a,pg_type t " \
2781            "WHERE c.relname=%s " \
2782            "AND c.oid=a.attrelid " \
2783            "AND a.atttypid=t.oid", (self._table,))
2784         return dict(map(lambda x: (x['attname'], x),cr.dictfetchall()))
2785
2786
2787     def _o2m_raise_on_missing_reference(self, cr, f):
2788         # TODO this check should be a method on fields.one2many.
2789         if f._obj in self.pool:
2790             other = self.pool[f._obj]
2791             # TODO the condition could use fields_get_keys().
2792             if f._fields_id not in other._columns.keys():
2793                 if f._fields_id not in other._inherit_fields.keys():
2794                     raise except_orm('Programming Error', "There is no reference field '%s' found for '%s'" % (f._fields_id, f._obj,))
2795
2796     def _m2m_raise_or_create_relation(self, cr, f):
2797         m2m_tbl, col1, col2 = f._sql_names(self)
2798         # do not create relations for custom fields as they do not belong to a module
2799         # they will be automatically removed when dropping the corresponding ir.model.field
2800         # table name for custom relation all starts with x_, see __init__
2801         if not m2m_tbl.startswith('x_'):
2802             self._save_relation_table(cr, m2m_tbl)
2803         cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (m2m_tbl,))
2804         if not cr.dictfetchall():
2805             if f._obj not in self.pool:
2806                 raise except_orm('Programming Error', 'Many2Many destination model does not exist: `%s`' % (f._obj,))
2807             dest_model = self.pool[f._obj]
2808             ref = dest_model._table
2809             cr.execute('CREATE TABLE "%s" ("%s" INTEGER NOT NULL, "%s" INTEGER NOT NULL, UNIQUE("%s","%s"))' % (m2m_tbl, col1, col2, col1, col2))
2810             # create foreign key references with ondelete=cascade, unless the targets are SQL views
2811             cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (ref,))
2812             if not cr.fetchall():
2813                 self._m2o_add_foreign_key_unchecked(m2m_tbl, col2, dest_model, 'cascade')
2814             cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (self._table,))
2815             if not cr.fetchall():
2816                 self._m2o_add_foreign_key_unchecked(m2m_tbl, col1, self, 'cascade')
2817
2818             cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col1, m2m_tbl, col1))
2819             cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col2, m2m_tbl, col2))
2820             cr.execute("COMMENT ON TABLE \"%s\" IS 'RELATION BETWEEN %s AND %s'" % (m2m_tbl, self._table, ref))
2821             cr.commit()
2822             _schema.debug("Create table '%s': m2m relation between '%s' and '%s'", m2m_tbl, self._table, ref)
2823
2824
2825     def _add_sql_constraints(self, cr):
2826         """
2827
2828         Modify this model's database table constraints so they match the one in
2829         _sql_constraints.
2830
2831         """
2832         def unify_cons_text(txt):
2833             return txt.lower().replace(', ',',').replace(' (','(')
2834
2835         for (key, con, _) in self._sql_constraints:
2836             conname = '%s_%s' % (self._table, key)
2837
2838             # using 1 to get result if no imc but one pgc
2839             cr.execute("""SELECT definition, 1
2840                           FROM ir_model_constraint imc
2841                           RIGHT JOIN pg_constraint pgc
2842                           ON (pgc.conname = imc.name)
2843                           WHERE pgc.conname=%s
2844                           """, (conname, ))
2845             existing_constraints = cr.dictfetchone()
2846             sql_actions = {
2847                 'drop': {
2848                     'execute': False,
2849                     'query': 'ALTER TABLE "%s" DROP CONSTRAINT "%s"' % (self._table, conname, ),
2850                     'msg_ok': "Table '%s': dropped constraint '%s'. Reason: its definition changed from '%%s' to '%s'" % (
2851                         self._table, conname, con),
2852                     'msg_err': "Table '%s': unable to drop \'%s\' constraint !" % (self._table, con),
2853                     'order': 1,
2854                 },
2855                 'add': {
2856                     'execute': False,
2857                     'query': 'ALTER TABLE "%s" ADD CONSTRAINT "%s" %s' % (self._table, conname, con,),
2858                     'msg_ok': "Table '%s': added constraint '%s' with definition=%s" % (self._table, conname, con),
2859                     '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" % (
2860                         self._table, con),
2861                     'order': 2,
2862                 },
2863             }
2864
2865             if not existing_constraints:
2866                 # constraint does not exists:
2867                 sql_actions['add']['execute'] = True
2868                 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2869             elif unify_cons_text(con) != existing_constraints['definition']:
2870                 # constraint exists but its definition has changed:
2871                 sql_actions['drop']['execute'] = True
2872                 sql_actions['drop']['msg_ok'] = sql_actions['drop']['msg_ok'] % (existing_constraints['definition'] or '', )
2873                 sql_actions['add']['execute'] = True
2874                 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2875
2876             # we need to add the constraint:
2877             self._save_constraint(cr, conname, 'u', unify_cons_text(con))
2878             sql_actions = [item for item in sql_actions.values()]
2879             sql_actions.sort(key=lambda x: x['order'])
2880             for sql_action in [action for action in sql_actions if action['execute']]:
2881                 try:
2882                     cr.execute(sql_action['query'])
2883                     cr.commit()
2884                     _schema.debug(sql_action['msg_ok'])
2885                 except:
2886                     _schema.warning(sql_action['msg_err'])
2887                     cr.rollback()
2888
2889
2890     def _execute_sql(self, cr):
2891         """ Execute the SQL code from the _sql attribute (if any)."""
2892         if hasattr(self, "_sql"):
2893             for line in self._sql.split(';'):
2894                 line2 = line.replace('\n', '').strip()
2895                 if line2:
2896                     cr.execute(line2)
2897                     cr.commit()
2898
2899     #
2900     # Update objects that uses this one to update their _inherits fields
2901     #
2902
2903     @classmethod
2904     def _inherits_reload_src(cls):
2905         """ Recompute the _inherit_fields mapping on each _inherits'd child model."""
2906         for model in cls.pool.values():
2907             if cls._name in model._inherits:
2908                 model._inherits_reload()
2909
2910     @classmethod
2911     def _inherits_reload(cls):
2912         """ Recompute the _inherit_fields mapping.
2913
2914         This will also call itself on each inherits'd child model.
2915
2916         """
2917         res = {}
2918         for table in cls._inherits:
2919             other = cls.pool[table]
2920             for col in other._columns.keys():
2921                 res[col] = (table, cls._inherits[table], other._columns[col], table)
2922             for col in other._inherit_fields.keys():
2923                 res[col] = (table, cls._inherits[table], other._inherit_fields[col][2], other._inherit_fields[col][3])
2924         cls._inherit_fields = res
2925         cls._all_columns = cls._get_column_infos()
2926
2927         # interface columns with new-style fields
2928         for attr, column in cls._columns.items():
2929             if attr not in cls._fields:
2930                 cls._add_field(attr, column.to_field())
2931
2932         # interface inherited fields with new-style fields (note that the
2933         # reverse order is for being consistent with _all_columns above)
2934         for parent_model, parent_field in reversed(cls._inherits.items()):
2935             for attr, field in cls.pool[parent_model]._fields.iteritems():
2936                 if attr not in cls._fields:
2937                     cls._add_field(attr, field.new(
2938                         inherited=True,
2939                         related=(parent_field, attr),
2940                         related_sudo=False,
2941                     ))
2942
2943         cls._inherits_reload_src()
2944
2945     @classmethod
2946     def _get_column_infos(cls):
2947         """Returns a dict mapping all fields names (direct fields and
2948            inherited field via _inherits) to a ``column_info`` struct
2949            giving detailed columns """
2950         result = {}
2951         # do not inverse for loops, since local fields may hide inherited ones!
2952         for k, (parent, m2o, col, original_parent) in cls._inherit_fields.iteritems():
2953             result[k] = fields.column_info(k, col, parent, m2o, original_parent)
2954         for k, col in cls._columns.iteritems():
2955             result[k] = fields.column_info(k, col)
2956         return result
2957
2958     @classmethod
2959     def _inherits_check(cls):
2960         for table, field_name in cls._inherits.items():
2961             if field_name not in cls._columns:
2962                 _logger.info('Missing many2one field definition for _inherits reference "%s" in "%s", using default one.', field_name, cls._name)
2963                 cls._columns[field_name] = fields.many2one(table, string="Automatically created field to link to parent %s" % table,
2964                                                              required=True, ondelete="cascade")
2965             elif not cls._columns[field_name].required or cls._columns[field_name].ondelete.lower() not in ("cascade", "restrict"):
2966                 _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)
2967                 cls._columns[field_name].required = True
2968                 cls._columns[field_name].ondelete = "cascade"
2969
2970         # reflect fields with delegate=True in dictionary cls._inherits
2971         for field in cls._fields.itervalues():
2972             if field.type == 'many2one' and not field.related and field.delegate:
2973                 if not field.required:
2974                     _logger.warning("Field %s with delegate=True must be required.", field)
2975                     field.required = True
2976                 if field.ondelete.lower() not in ('cascade', 'restrict'):
2977                     field.ondelete = 'cascade'
2978                 cls._inherits[field.comodel_name] = field.name
2979
2980     @api.model
2981     def _prepare_setup_fields(self):
2982         """ Prepare the setup of fields once the models have been loaded. """
2983         for field in self._fields.itervalues():
2984             field.reset()
2985
2986     @api.model
2987     def _setup_fields(self, partial=False):
2988         """ Setup the fields (dependency triggers, etc). """
2989         for field in self._fields.itervalues():
2990             try:
2991                 field.setup(self.env)
2992             except Exception:
2993                 if not partial:
2994                     raise
2995
2996         # update columns (fields may have changed), and column_infos
2997         for name, field in self._fields.iteritems():
2998             if field.store:
2999                 self._columns[name] = field.to_column()
3000         self._inherits_reload()
3001
3002         # group fields by compute to determine field.computed_fields
3003         fields_by_compute = defaultdict(list)
3004         for field in self._fields.itervalues():
3005             if field.compute:
3006                 field.computed_fields = fields_by_compute[field.compute]
3007                 field.computed_fields.append(field)
3008             else:
3009                 field.computed_fields = []
3010
3011     def fields_get(self, cr, user, allfields=None, context=None, write_access=True):
3012         """ fields_get([fields])
3013
3014         Return the definition of each field.
3015
3016         The returned value is a dictionary (indiced by field name) of
3017         dictionaries. The _inherits'd fields are included. The string, help,
3018         and selection (if present) attributes are translated.
3019
3020         :param cr: database cursor
3021         :param user: current user id
3022         :param allfields: list of fields
3023         :param context: context arguments, like lang, time zone
3024         :return: dictionary of field dictionaries, each one describing a field of the business object
3025         :raise AccessError: * if user has no create/write rights on the requested object
3026
3027         """
3028         recs = self.browse(cr, user, [], context)
3029
3030         res = {}
3031         for fname, field in self._fields.iteritems():
3032             if allfields and fname not in allfields:
3033                 continue
3034             if not field.setup_done:
3035                 continue
3036             if field.groups and not recs.user_has_groups(field.groups):
3037                 continue
3038             res[fname] = field.get_description(recs.env)
3039
3040         # if user cannot create or modify records, make all fields readonly
3041         has_access = functools.partial(recs.check_access_rights, raise_exception=False)
3042         if not (has_access('write') or has_access('create')):
3043             for description in res.itervalues():
3044                 description['readonly'] = True
3045                 description['states'] = {}
3046
3047         return res
3048
3049     def get_empty_list_help(self, cr, user, help, context=None):
3050         """ Generic method giving the help message displayed when having
3051             no result to display in a list or kanban view. By default it returns
3052             the help given in parameter that is generally the help message
3053             defined in the action.
3054         """
3055         return help
3056
3057     def check_field_access_rights(self, cr, user, operation, fields, context=None):
3058         """
3059         Check the user access rights on the given fields. This raises Access
3060         Denied if the user does not have the rights. Otherwise it returns the
3061         fields (as is if the fields is not falsy, or the readable/writable
3062         fields if fields is falsy).
3063         """
3064         if user == SUPERUSER_ID:
3065             return fields or list(self._fields)
3066
3067         def valid(fname):
3068             """ determine whether user has access to field `fname` """
3069             field = self._fields.get(fname)
3070             if field and field.groups:
3071                 return self.user_has_groups(cr, user, groups=field.groups, context=context)
3072             else:
3073                 return True
3074
3075         if not fields:
3076             fields = filter(valid, self._fields)
3077         else:
3078             invalid_fields = set(filter(lambda name: not valid(name), fields))
3079             if invalid_fields:
3080                 _logger.warning('Access Denied by ACLs for operation: %s, uid: %s, model: %s, fields: %s',
3081                     operation, user, self._name, ', '.join(invalid_fields))
3082                 raise AccessError(
3083                     _('The requested operation cannot be completed due to security restrictions. '
3084                     'Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3085                     (self._description, operation))
3086
3087         return fields
3088
3089     # add explicit old-style implementation to read()
3090     @api.v7
3091     def read(self, cr, user, ids, fields=None, context=None, load='_classic_read'):
3092         records = self.browse(cr, user, ids, context)
3093         result = BaseModel.read(records, fields, load=load)
3094         return result if isinstance(ids, list) else (bool(result) and result[0])
3095
3096     # new-style implementation of read()
3097     @api.v8
3098     def read(self, fields=None, load='_classic_read'):
3099         """ read([fields])
3100
3101         Reads the requested fields for the records in `self`, low-level/RPC
3102         method. In Python code, prefer :meth:`~.browse`.
3103
3104         :param fields: list of field names to return (default is all fields)
3105         :return: a list of dictionaries mapping field names to their values,
3106                  with one dictionary per record
3107         :raise AccessError: if user has no read rights on some of the given
3108                 records
3109         """
3110         # check access rights
3111         self.check_access_rights('read')
3112         fields = self.check_field_access_rights('read', fields)
3113
3114         # split fields into stored and computed fields
3115         stored, computed = [], []
3116         for name in fields:
3117             if name in self._columns:
3118                 stored.append(name)
3119             elif name in self._fields:
3120                 computed.append(name)
3121             else:
3122                 _logger.warning("%s.read() with unknown field '%s'", self._name, name)
3123
3124         # fetch stored fields from the database to the cache
3125         self._read_from_database(stored)
3126
3127         # retrieve results from records; this takes values from the cache and
3128         # computes remaining fields
3129         result = []
3130         name_fields = [(name, self._fields[name]) for name in (stored + computed)]
3131         use_name_get = (load == '_classic_read')
3132         for record in self:
3133             try:
3134                 values = {'id': record.id}
3135                 for name, field in name_fields:
3136                     values[name] = field.convert_to_read(record[name], use_name_get)
3137                 result.append(values)
3138             except MissingError:
3139                 pass
3140
3141         return result
3142
3143     @api.multi
3144     def _prefetch_field(self, field):
3145         """ Read from the database in order to fetch `field` (:class:`Field`
3146             instance) for `self` in cache.
3147         """
3148         # fetch the records of this model without field_name in their cache
3149         records = self._in_cache_without(field)
3150
3151         if len(records) > PREFETCH_MAX:
3152             records = records[:PREFETCH_MAX] | self
3153
3154         # determine which fields can be prefetched
3155         if not self.env.in_draft and \
3156                 self._context.get('prefetch_fields', True) and \
3157                 self._columns[field.name]._prefetch:
3158             # prefetch all classic and many2one fields that the user can access
3159             fnames = {fname
3160                 for fname, fcolumn in self._columns.iteritems()
3161                 if fcolumn._prefetch
3162                 if not fcolumn.groups or self.user_has_groups(fcolumn.groups)
3163             }
3164         else:
3165             fnames = {field.name}
3166
3167         # important: never prefetch fields to recompute!
3168         get_recs_todo = self.env.field_todo
3169         for fname in list(fnames):
3170             if get_recs_todo(self._fields[fname]):
3171                 if fname == field.name:
3172                     records -= get_recs_todo(field)
3173                 else:
3174                     fnames.discard(fname)
3175
3176         # fetch records with read()
3177         assert self in records and field.name in fnames
3178         result = []
3179         try:
3180             result = records.read(list(fnames), load='_classic_write')
3181         except AccessError:
3182             pass
3183
3184         # check the cache, and update it if necessary
3185         if not self._cache.contains(field):
3186             for values in result:
3187                 record = self.browse(values.pop('id'))
3188                 record._cache.update(record._convert_to_cache(values, validate=False))
3189             if not self._cache.contains(field):
3190                 e = AccessError("No value found for %s.%s" % (self, field.name))
3191                 self._cache[field] = FailedValue(e)
3192
3193     @api.multi
3194     def _read_from_database(self, field_names):
3195         """ Read the given fields of the records in `self` from the database,
3196             and store them in cache. Access errors are also stored in cache.
3197         """
3198         env = self.env
3199         cr, user, context = env.args
3200
3201         # FIXME: The query construction needs to be rewritten using the internal Query
3202         # object, as in search(), to avoid ambiguous column references when
3203         # reading/sorting on a table that is auto_joined to another table with
3204         # common columns (e.g. the magical columns)
3205
3206         # Construct a clause for the security rules.
3207         # 'tables' holds the list of tables necessary for the SELECT, including
3208         # the ir.rule clauses, and contains at least self._table.
3209         rule_clause, rule_params, tables = env['ir.rule'].domain_get(self._name, 'read')
3210
3211         # determine the fields that are stored as columns in self._table
3212         fields_pre = [f for f in field_names if self._columns[f]._classic_write]
3213
3214         # we need fully-qualified column names in case len(tables) > 1
3215         def qualify(f):
3216             if isinstance(self._columns.get(f), fields.binary) and \
3217                     context.get('bin_size_%s' % f, context.get('bin_size')):
3218                 # PG 9.2 introduces conflicting pg_size_pretty(numeric) -> need ::cast
3219                 return 'pg_size_pretty(length(%s."%s")::bigint) as "%s"' % (self._table, f, f)
3220             else:
3221                 return '%s."%s"' % (self._table, f)
3222         qual_names = map(qualify, set(fields_pre + ['id']))
3223
3224         query = """ SELECT %(qual_names)s FROM %(tables)s
3225                     WHERE %(table)s.id IN %%s AND (%(extra)s)
3226                     ORDER BY %(order)s
3227                 """ % {
3228                     'qual_names': ",".join(qual_names),
3229                     'tables': ",".join(tables),
3230                     'table': self._table,
3231                     'extra': " OR ".join(rule_clause) if rule_clause else "TRUE",
3232                     'order': self._parent_order or self._order,
3233                 }
3234
3235         result = []
3236         for sub_ids in cr.split_for_in_conditions(self.ids):
3237             cr.execute(query, [tuple(sub_ids)] + rule_params)
3238             result.extend(cr.dictfetchall())
3239
3240         ids = [vals['id'] for vals in result]
3241
3242         if ids:
3243             # translate the fields if necessary
3244             if context.get('lang'):
3245                 ir_translation = env['ir.translation']
3246                 for f in fields_pre:
3247                     if self._columns[f].translate:
3248                         #TODO: optimize out of this loop
3249                         res_trans = ir_translation._get_ids(
3250                             '%s,%s' % (self._name, f), 'model', context['lang'], ids)
3251                         for vals in result:
3252                             vals[f] = res_trans.get(vals['id'], False) or vals[f]
3253
3254             # apply the symbol_get functions of the fields we just read
3255             for f in fields_pre:
3256                 symbol_get = self._columns[f]._symbol_get
3257                 if symbol_get:
3258                     for vals in result:
3259                         vals[f] = symbol_get(vals[f])
3260
3261             # store result in cache for POST fields
3262             for vals in result:
3263                 record = self.browse(vals['id'])
3264                 record._cache.update(record._convert_to_cache(vals, validate=False))
3265
3266             # determine the fields that must be processed now
3267             fields_post = [f for f in field_names if not self._columns[f]._classic_write]
3268
3269             # Compute POST fields, grouped by multi
3270             by_multi = defaultdict(list)
3271             for f in fields_post:
3272                 by_multi[self._columns[f]._multi].append(f)
3273
3274             for multi, fs in by_multi.iteritems():
3275                 if multi:
3276                     res2 = self._columns[fs[0]].get(cr, self._model, ids, fs, user, context=context, values=result)
3277                     assert res2 is not None, \
3278                         'The function field "%s" on the "%s" model returned None\n' \
3279                         '(a dictionary was expected).' % (fs[0], self._name)
3280                     for vals in result:
3281                         # TOCHECK : why got string instend of dict in python2.6
3282                         # if isinstance(res2[vals['id']], str): res2[vals['id']] = eval(res2[vals['id']])
3283                         multi_fields = res2.get(vals['id'], {})
3284                         if multi_fields:
3285                             for f in fs:
3286                                 vals[f] = multi_fields.get(f, [])
3287                 else:
3288                     for f in fs:
3289                         res2 = self._columns[f].get(cr, self._model, ids, f, user, context=context, values=result)
3290                         for vals in result:
3291                             if res2:
3292                                 vals[f] = res2[vals['id']]
3293                             else:
3294                                 vals[f] = []
3295
3296         # Warn about deprecated fields now that fields_pre and fields_post are computed
3297         for f in field_names:
3298             column = self._columns[f]
3299             if column.deprecated:
3300                 _logger.warning('Field %s.%s is deprecated: %s', self._name, f, column.deprecated)
3301
3302         # store result in cache
3303         for vals in result:
3304             record = self.browse(vals.pop('id'))
3305             record._cache.update(record._convert_to_cache(vals, validate=False))
3306
3307         # store failed values in cache for the records that could not be read
3308         fetched = self.browse(ids)
3309         missing = self - fetched
3310         if missing:
3311             extras = fetched - self
3312             if extras:
3313                 raise AccessError(
3314                     _("Database fetch misses ids ({}) and has extra ids ({}), may be caused by a type incoherence in a previous request").format(
3315                         ', '.join(map(repr, missing._ids)),
3316                         ', '.join(map(repr, extras._ids)),
3317                     ))
3318             # store an access error exception in existing records
3319             exc = AccessError(
3320                 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3321                 (self._name, 'read')
3322             )
3323             forbidden = missing.exists()
3324             forbidden._cache.update(FailedValue(exc))
3325             # store a missing error exception in non-existing records
3326             exc = MissingError(
3327                 _('One of the documents you are trying to access has been deleted, please try again after refreshing.')
3328             )
3329             (missing - forbidden)._cache.update(FailedValue(exc))
3330
3331     @api.multi
3332     def get_metadata(self):
3333         """
3334         Returns some metadata about the given records.
3335
3336         :return: list of ownership dictionaries for each requested record
3337         :rtype: list of dictionaries with the following keys:
3338
3339                     * id: object id
3340                     * create_uid: user who created the record
3341                     * create_date: date when the record was created
3342                     * write_uid: last user who changed the record
3343                     * write_date: date of the last change to the record
3344                     * xmlid: XML ID to use to refer to this record (if there is one), in format ``module.name``
3345         """
3346         fields = ['id']
3347         if self._log_access:
3348             fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
3349         quoted_table = '"%s"' % self._table
3350         fields_str = ",".join('%s.%s' % (quoted_table, field) for field in fields)
3351         query = '''SELECT %s, __imd.module, __imd.name
3352                    FROM %s LEFT JOIN ir_model_data __imd
3353                        ON (__imd.model = %%s and __imd.res_id = %s.id)
3354                    WHERE %s.id IN %%s''' % (fields_str, quoted_table, quoted_table, quoted_table)
3355         self._cr.execute(query, (self._name, tuple(self.ids)))
3356         res = self._cr.dictfetchall()
3357
3358         uids = set(r[k] for r in res for k in ['write_uid', 'create_uid'] if r.get(k))
3359         names = dict(self.env['res.users'].browse(uids).name_get())
3360
3361         for r in res:
3362             for key in r:
3363                 value = r[key] = r[key] or False
3364                 if key in ('write_uid', 'create_uid') and value in names:
3365                     r[key] = (value, names[value])
3366             r['xmlid'] = ("%(module)s.%(name)s" % r) if r['name'] else False
3367             del r['name'], r['module']
3368         return res
3369
3370     def _check_concurrency(self, cr, ids, context):
3371         if not context:
3372             return
3373         if not (context.get(self.CONCURRENCY_CHECK_FIELD) and self._log_access):
3374             return
3375         check_clause = "(id = %s AND %s < COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp)"
3376         for sub_ids in cr.split_for_in_conditions(ids):
3377             ids_to_check = []
3378             for id in sub_ids:
3379                 id_ref = "%s,%s" % (self._name, id)
3380                 update_date = context[self.CONCURRENCY_CHECK_FIELD].pop(id_ref, None)
3381                 if update_date:
3382                     ids_to_check.extend([id, update_date])
3383             if not ids_to_check:
3384                 continue
3385             cr.execute("SELECT id FROM %s WHERE %s" % (self._table, " OR ".join([check_clause]*(len(ids_to_check)/2))), tuple(ids_to_check))
3386             res = cr.fetchone()
3387             if res:
3388                 # mention the first one only to keep the error message readable
3389                 raise except_orm('ConcurrencyException', _('A document was modified since you last viewed it (%s:%d)') % (self._description, res[0]))
3390
3391     def _check_record_rules_result_count(self, cr, uid, ids, result_ids, operation, context=None):
3392         """Verify the returned rows after applying record rules matches
3393            the length of `ids`, and raise an appropriate exception if it does not.
3394         """
3395         if context is None:
3396             context = {}
3397         ids, result_ids = set(ids), set(result_ids)
3398         missing_ids = ids - result_ids
3399         if missing_ids:
3400             # Attempt to distinguish record rule restriction vs deleted records,
3401             # to provide a more specific error message - check if the missinf
3402             cr.execute('SELECT id FROM ' + self._table + ' WHERE id IN %s', (tuple(missing_ids),))
3403             forbidden_ids = [x[0] for x in cr.fetchall()]
3404             if forbidden_ids:
3405                 # the missing ids are (at least partially) hidden by access rules
3406                 if uid == SUPERUSER_ID:
3407                     return
3408                 _logger.warning('Access Denied by record rules for operation: %s on record ids: %r, uid: %s, model: %s', operation, forbidden_ids, uid, self._name)
3409                 raise except_orm(_('Access Denied'),
3410                                  _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3411                                     (self._description, operation))
3412             else:
3413                 # If we get here, the missing_ids are not in the database
3414                 if operation in ('read','unlink'):
3415                     # No need to warn about deleting an already deleted record.
3416                     # And no error when reading a record that was deleted, to prevent spurious
3417                     # errors for non-transactional search/read sequences coming from clients
3418                     return
3419                 _logger.warning('Failed operation on deleted record(s): %s, uid: %s, model: %s', operation, uid, self._name)
3420                 raise except_orm(_('Missing document(s)'),
3421                                  _('One of the documents you are trying to access has been deleted, please try again after refreshing.'))
3422
3423
3424     def check_access_rights(self, cr, uid, operation, raise_exception=True): # no context on purpose.
3425         """Verifies that the operation given by ``operation`` is allowed for the user
3426            according to the access rights."""
3427         return self.pool.get('ir.model.access').check(cr, uid, self._name, operation, raise_exception)
3428
3429     def check_access_rule(self, cr, uid, ids, operation, context=None):
3430         """Verifies that the operation given by ``operation`` is allowed for the user
3431            according to ir.rules.
3432
3433            :param operation: one of ``write``, ``unlink``
3434            :raise except_orm: * if current ir.rules do not permit this operation.
3435            :return: None if the operation is allowed
3436         """
3437         if uid == SUPERUSER_ID:
3438             return
3439
3440         if self.is_transient():
3441             # Only one single implicit access rule for transient models: owner only!
3442             # This is ok to hardcode because we assert that TransientModels always
3443             # have log_access enabled so that the create_uid column is always there.
3444             # And even with _inherits, these fields are always present in the local
3445             # table too, so no need for JOINs.
3446             cr.execute("""SELECT distinct create_uid
3447                           FROM %s
3448                           WHERE id IN %%s""" % self._table, (tuple(ids),))
3449             uids = [x[0] for x in cr.fetchall()]
3450             if len(uids) != 1 or uids[0] != uid:
3451                 raise except_orm(_('Access Denied'),
3452                                  _('For this kind of document, you may only access records you created yourself.\n\n(Document type: %s)') % (self._description,))
3453         else:
3454             where_clause, where_params, tables = self.pool.get('ir.rule').domain_get(cr, uid, self._name, operation, context=context)
3455             if where_clause:
3456                 where_clause = ' and ' + ' and '.join(where_clause)
3457                 for sub_ids in cr.split_for_in_conditions(ids):
3458                     cr.execute('SELECT ' + self._table + '.id FROM ' + ','.join(tables) +
3459                                ' WHERE ' + self._table + '.id IN %s' + where_clause,
3460                                [sub_ids] + where_params)
3461                     returned_ids = [x['id'] for x in cr.dictfetchall()]
3462                     self._check_record_rules_result_count(cr, uid, sub_ids, returned_ids, operation, context=context)
3463
3464     def create_workflow(self, cr, uid, ids, context=None):
3465         """Create a workflow instance for each given record IDs."""
3466         from openerp import workflow
3467         for res_id in ids:
3468             workflow.trg_create(uid, self._name, res_id, cr)
3469         # self.invalidate_cache(cr, uid, context=context) ?
3470         return True
3471
3472     def delete_workflow(self, cr, uid, ids, context=None):
3473         """Delete the workflow instances bound to the given record IDs."""
3474         from openerp import workflow
3475         for res_id in ids:
3476             workflow.trg_delete(uid, self._name, res_id, cr)
3477         self.invalidate_cache(cr, uid, context=context)
3478         return True
3479
3480     def step_workflow(self, cr, uid, ids, context=None):
3481         """Reevaluate the workflow instances of the given record IDs."""
3482         from openerp import workflow
3483         for res_id in ids:
3484             workflow.trg_write(uid, self._name, res_id, cr)
3485         # self.invalidate_cache(cr, uid, context=context) ?
3486         return True
3487
3488     def signal_workflow(self, cr, uid, ids, signal, context=None):
3489         """Send given workflow signal and return a dict mapping ids to workflow results"""
3490         from openerp import workflow
3491         result = {}
3492         for res_id in ids:
3493             result[res_id] = workflow.trg_validate(uid, self._name, res_id, signal, cr)
3494         # self.invalidate_cache(cr, uid, context=context) ?
3495         return result
3496
3497     def redirect_workflow(self, cr, uid, old_new_ids, context=None):
3498         """ Rebind the workflow instance bound to the given 'old' record IDs to
3499             the given 'new' IDs. (``old_new_ids`` is a list of pairs ``(old, new)``.
3500         """
3501         from openerp import workflow
3502         for old_id, new_id in old_new_ids:
3503             workflow.trg_redirect(uid, self._name, old_id, new_id, cr)
3504         self.invalidate_cache(cr, uid, context=context)
3505         return True
3506
3507     def unlink(self, cr, uid, ids, context=None):
3508         """ unlink()
3509
3510         Deletes the records of the current set
3511
3512         :raise AccessError: * if user has no unlink rights on the requested object
3513                             * if user tries to bypass access rules for unlink on the requested object
3514         :raise UserError: if the record is default property for other records
3515
3516         """
3517         if not ids:
3518             return True
3519         if isinstance(ids, (int, long)):
3520             ids = [ids]
3521
3522         result_store = self._store_get_values(cr, uid, ids, self._all_columns.keys(), context)
3523
3524         # for recomputing new-style fields
3525         recs = self.browse(cr, uid, ids, context)
3526         recs.modified(self._fields)
3527
3528         self._check_concurrency(cr, ids, context)
3529
3530         self.check_access_rights(cr, uid, 'unlink')
3531
3532         ir_property = self.pool.get('ir.property')
3533
3534         # Check if the records are used as default properties.
3535         domain = [('res_id', '=', False),
3536                   ('value_reference', 'in', ['%s,%s' % (self._name, i) for i in ids]),
3537                  ]
3538         if ir_property.search(cr, uid, domain, context=context):
3539             raise except_orm(_('Error'), _('Unable to delete this document because it is used as a default property'))
3540
3541         # Delete the records' properties.
3542         property_ids = ir_property.search(cr, uid, [('res_id', 'in', ['%s,%s' % (self._name, i) for i in ids])], context=context)
3543         ir_property.unlink(cr, uid, property_ids, context=context)
3544
3545         self.delete_workflow(cr, uid, ids, context=context)
3546
3547         self.check_access_rule(cr, uid, ids, 'unlink', context=context)
3548         pool_model_data = self.pool.get('ir.model.data')
3549         ir_values_obj = self.pool.get('ir.values')
3550         ir_attachment_obj = self.pool.get('ir.attachment')
3551         for sub_ids in cr.split_for_in_conditions(ids):
3552             cr.execute('delete from ' + self._table + ' ' \
3553                        'where id IN %s', (sub_ids,))
3554
3555             # Removing the ir_model_data reference if the record being deleted is a record created by xml/csv file,
3556             # as these are not connected with real database foreign keys, and would be dangling references.
3557             # Note: following steps performed as admin to avoid access rights restrictions, and with no context
3558             #       to avoid possible side-effects during admin calls.
3559             # Step 1. Calling unlink of ir_model_data only for the affected IDS
3560             reference_ids = pool_model_data.search(cr, SUPERUSER_ID, [('res_id','in',list(sub_ids)),('model','=',self._name)])
3561             # Step 2. Marching towards the real deletion of referenced records
3562             if reference_ids:
3563                 pool_model_data.unlink(cr, SUPERUSER_ID, reference_ids)
3564
3565             # For the same reason, removing the record relevant to ir_values
3566             ir_value_ids = ir_values_obj.search(cr, uid,
3567                     ['|',('value','in',['%s,%s' % (self._name, sid) for sid in sub_ids]),'&',('res_id','in',list(sub_ids)),('model','=',self._name)],
3568                     context=context)
3569             if ir_value_ids:
3570                 ir_values_obj.unlink(cr, uid, ir_value_ids, context=context)
3571
3572             # For the same reason, removing the record relevant to ir_attachment
3573             # The search is performed with sql as the search method of ir_attachment is overridden to hide attachments of deleted records
3574             cr.execute('select id from ir_attachment where res_model = %s and res_id in %s', (self._name, sub_ids))
3575             ir_attachment_ids = [ir_attachment[0] for ir_attachment in cr.fetchall()]
3576             if ir_attachment_ids:
3577                 ir_attachment_obj.unlink(cr, uid, ir_attachment_ids, context=context)
3578
3579         # invalidate the *whole* cache, since the orm does not handle all
3580         # changes made in the database, like cascading delete!
3581         recs.invalidate_cache()
3582
3583         for order, obj_name, store_ids, fields in result_store:
3584             if obj_name == self._name:
3585                 effective_store_ids = set(store_ids) - set(ids)
3586             else:
3587                 effective_store_ids = store_ids
3588             if effective_store_ids:
3589                 obj = self.pool[obj_name]
3590                 cr.execute('select id from '+obj._table+' where id IN %s', (tuple(effective_store_ids),))
3591                 rids = map(lambda x: x[0], cr.fetchall())
3592                 if rids:
3593                     obj._store_set_values(cr, uid, rids, fields, context)
3594
3595         # recompute new-style fields
3596         recs.recompute()
3597
3598         return True
3599
3600     #
3601     # TODO: Validate
3602     #
3603     @api.multi
3604     def write(self, vals):
3605         """ write(vals)
3606
3607         Updates all records in the current set with the provided values.
3608
3609         :param dict vals: fields to update and the value to set on them e.g::
3610
3611                 {'foo': 1, 'bar': "Qux"}
3612
3613             will set the field ``foo`` to ``1`` and the field ``bar`` to
3614             ``"Qux"`` if those are valid (otherwise it will trigger an error).
3615
3616         :raise AccessError: * if user has no write rights on the requested object
3617                             * if user tries to bypass access rules for write on the requested object
3618         :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3619         :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)
3620
3621         .. _openerp/models/relationals/format:
3622
3623         .. note:: Relational fields use a special "commands" format to manipulate their values
3624
3625             This format is a list of command triplets executed sequentially,
3626             possible command triplets are:
3627
3628             ``(0, _, values: dict)``
3629                 links to a new record created from the provided values
3630             ``(1, id, values: dict)``
3631                 updates the already-linked record of id ``id`` with the
3632                 provided ``values``
3633             ``(2, id, _)``
3634                 unlinks and deletes the linked record of id ``id``
3635             ``(3, id, _)``
3636                 unlinks the linked record of id ``id`` without deleting it
3637             ``(4, id, _)``
3638                 links to an existing record of id ``id``
3639             ``(5, _, _)``
3640                 unlinks all records in the relation, equivalent to using
3641                 the command ``3`` on every linked record
3642             ``(6, _, ids)``
3643                 replaces the existing list of linked records by the provoded
3644                 ones, equivalent to using ``5`` then ``4`` for each id in
3645                 ``ids``)
3646
3647             (in command triplets, ``_`` values are ignored and can be
3648             anything, generally ``0`` or ``False``)
3649
3650             Any command can be used on :class:`~openerp.fields.Many2many`,
3651             only ``0``, ``1`` and ``2`` can be used on
3652             :class:`~openerp.fields.One2many`.
3653         """
3654         if not self:
3655             return True
3656
3657         self._check_concurrency(self._ids)
3658         self.check_access_rights('write')
3659
3660         # No user-driven update of these columns
3661         for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3662             vals.pop(field, None)
3663
3664         # split up fields into old-style and pure new-style ones
3665         old_vals, new_vals, unknown = {}, {}, []
3666         for key, val in vals.iteritems():
3667             field = self._fields.get(key)
3668             if field:
3669                 if field.store or field.inherited:
3670                     old_vals[key] = val
3671                 if field.inverse and not field.inherited:
3672                     new_vals[key] = val
3673             else:
3674                 unknown.append(key)
3675
3676         if unknown:
3677             _logger.warning("%s.write() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3678
3679         # write old-style fields with (low-level) method _write
3680         if old_vals:
3681             self._write(old_vals)
3682
3683         # put the values of pure new-style fields into cache, and inverse them
3684         if new_vals:
3685             for record in self:
3686                 record._cache.update(record._convert_to_cache(new_vals, update=True))
3687             for key in new_vals:
3688                 self._fields[key].determine_inverse(self)
3689
3690         return True
3691
3692     def _write(self, cr, user, ids, vals, context=None):
3693         # low-level implementation of write()
3694         if not context:
3695             context = {}
3696
3697         readonly = None
3698         self.check_field_access_rights(cr, user, 'write', vals.keys())
3699         deleted_related = defaultdict(list)
3700         for field in vals.keys():
3701             fobj = None
3702             if field in self._columns:
3703                 fobj = self._columns[field]
3704             elif field in self._inherit_fields:
3705                 fobj = self._inherit_fields[field][2]
3706             if not fobj:
3707                 continue
3708             if fobj._type in ['one2many', 'many2many'] and vals[field]:
3709                 for wtuple in vals[field]:
3710                     if isinstance(wtuple, (tuple, list)) and wtuple[0] == 2:
3711                         deleted_related[fobj._obj].append(wtuple[1])
3712             groups = fobj.write
3713
3714             if groups:
3715                 edit = False
3716                 for group in groups:
3717                     module = group.split(".")[0]
3718                     grp = group.split(".")[1]
3719                     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", \
3720                                (grp, module, 'res.groups', user))
3721                     readonly = cr.fetchall()
3722                     if readonly[0][0] >= 1:
3723                         edit = True
3724                         break
3725
3726                 if not edit:
3727                     vals.pop(field)
3728
3729         result = self._store_get_values(cr, user, ids, vals.keys(), context) or []
3730
3731         # for recomputing new-style fields
3732         recs = self.browse(cr, user, ids, context)
3733         modified_fields = list(vals)
3734         if self._log_access:
3735             modified_fields += ['write_date', 'write_uid']
3736         recs.modified(modified_fields)
3737
3738         parents_changed = []
3739         parent_order = self._parent_order or self._order
3740         if self._parent_store and (self._parent_name in vals) and not context.get('defer_parent_store_computation'):
3741             # The parent_left/right computation may take up to
3742             # 5 seconds. No need to recompute the values if the
3743             # parent is the same.
3744             # Note: to respect parent_order, nodes must be processed in
3745             # order, so ``parents_changed`` must be ordered properly.
3746             parent_val = vals[self._parent_name]
3747             if parent_val:
3748                 query = "SELECT id FROM %s WHERE id IN %%s AND (%s != %%s OR %s IS NULL) ORDER BY %s" % \
3749                                 (self._table, self._parent_name, self._parent_name, parent_order)
3750                 cr.execute(query, (tuple(ids), parent_val))
3751             else:
3752                 query = "SELECT id FROM %s WHERE id IN %%s AND (%s IS NOT NULL) ORDER BY %s" % \
3753                                 (self._table, self._parent_name, parent_order)
3754                 cr.execute(query, (tuple(ids),))
3755             parents_changed = map(operator.itemgetter(0), cr.fetchall())
3756
3757         upd0 = []
3758         upd1 = []
3759         upd_todo = []
3760         updend = []
3761         direct = []
3762         totranslate = context.get('lang', False) and (context['lang'] != 'en_US')
3763         for field in vals:
3764             field_column = self._all_columns.get(field) and self._all_columns.get(field).column
3765             if field_column and field_column.deprecated:
3766                 _logger.warning('Field %s.%s is deprecated: %s', self._name, field, field_column.deprecated)
3767             if field in self._columns:
3768                 if self._columns[field]._classic_write and not (hasattr(self._columns[field], '_fnct_inv')):
3769                     if (not totranslate) or not self._columns[field].translate:
3770                         upd0.append('"'+field+'"='+self._columns[field]._symbol_set[0])
3771                         upd1.append(self._columns[field]._symbol_set[1](vals[field]))
3772                     direct.append(field)
3773                 else:
3774                     upd_todo.append(field)
3775             else:
3776                 updend.append(field)
3777             if field in self._columns \
3778                     and hasattr(self._columns[field], 'selection') \
3779                     and vals[field]:
3780                 self._check_selection_field_value(cr, user, field, vals[field], context=context)
3781
3782         if self._log_access:
3783             upd0.append('write_uid=%s')
3784             upd0.append("write_date=(now() at time zone 'UTC')")
3785             upd1.append(user)
3786             direct.append('write_uid')
3787             direct.append('write_date')
3788
3789         if len(upd0):
3790             self.check_access_rule(cr, user, ids, 'write', context=context)
3791             for sub_ids in cr.split_for_in_conditions(ids):
3792                 cr.execute('update ' + self._table + ' set ' + ','.join(upd0) + ' ' \
3793                            'where id IN %s', upd1 + [sub_ids])
3794                 if cr.rowcount != len(sub_ids):
3795                     raise MissingError(_('One of the records you are trying to modify has already been deleted (Document type: %s).') % self._description)
3796
3797             if totranslate:
3798                 # TODO: optimize
3799                 for f in direct:
3800                     if self._columns[f].translate:
3801                         src_trans = self.pool[self._name].read(cr, user, ids, [f])[0][f]
3802                         if not src_trans:
3803                             src_trans = vals[f]
3804                             # Inserting value to DB
3805                             context_wo_lang = dict(context, lang=None)
3806                             self.write(cr, user, ids, {f: vals[f]}, context=context_wo_lang)
3807                         self.pool.get('ir.translation')._set_ids(cr, user, self._name+','+f, 'model', context['lang'], ids, vals[f], src_trans)
3808
3809         # invalidate and mark new-style fields to recompute; do this before
3810         # setting other fields, because it can require the value of computed
3811         # fields, e.g., a one2many checking constraints on records
3812         recs.modified(direct)
3813
3814         # call the 'set' method of fields which are not classic_write
3815         upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
3816
3817         # default element in context must be removed when call a one2many or many2many
3818         rel_context = context.copy()
3819         for c in context.items():
3820             if c[0].startswith('default_'):
3821                 del rel_context[c[0]]
3822
3823         for field in upd_todo:
3824             for id in ids:
3825                 result += self._columns[field].set(cr, self, id, field, vals[field], user, context=rel_context) or []
3826
3827         # for recomputing new-style fields
3828         recs.modified(upd_todo)
3829
3830         unknown_fields = updend[:]
3831         for table in self._inherits:
3832             col = self._inherits[table]
3833             nids = []
3834             for sub_ids in cr.split_for_in_conditions(ids):
3835                 cr.execute('select distinct "'+col+'" from "'+self._table+'" ' \
3836                            'where id IN %s', (sub_ids,))
3837                 nids.extend([x[0] for x in cr.fetchall()])
3838
3839             v = {}
3840             for val in updend:
3841                 if self._inherit_fields[val][0] == table:
3842                     v[val] = vals[val]
3843                     unknown_fields.remove(val)
3844             if v:
3845                 self.pool[table].write(cr, user, nids, v, context)
3846
3847         if unknown_fields:
3848             _logger.warning(
3849                 'No such field(s) in model %s: %s.',
3850                 self._name, ', '.join(unknown_fields))
3851
3852         # check Python constraints
3853         recs._validate_fields(vals)
3854
3855         # TODO: use _order to set dest at the right position and not first node of parent
3856         # We can't defer parent_store computation because the stored function
3857         # fields that are computer may refer (directly or indirectly) to
3858         # parent_left/right (via a child_of domain)
3859         if parents_changed:
3860             if self.pool._init:
3861                 self.pool._init_parent[self._name] = True
3862             else:
3863                 order = self._parent_order or self._order
3864                 parent_val = vals[self._parent_name]
3865                 if parent_val:
3866                     clause, params = '%s=%%s' % (self._parent_name,), (parent_val,)
3867                 else:
3868                     clause, params = '%s IS NULL' % (self._parent_name,), ()
3869
3870                 for id in parents_changed:
3871                     cr.execute('SELECT parent_left, parent_right FROM %s WHERE id=%%s' % (self._table,), (id,))
3872                     pleft, pright = cr.fetchone()
3873                     distance = pright - pleft + 1
3874
3875                     # Positions of current siblings, to locate proper insertion point;
3876                     # this can _not_ be fetched outside the loop, as it needs to be refreshed
3877                     # after each update, in case several nodes are sequentially inserted one
3878                     # next to the other (i.e computed incrementally)
3879                     cr.execute('SELECT parent_right, id FROM %s WHERE %s ORDER BY %s' % (self._table, clause, parent_order), params)
3880                     parents = cr.fetchall()
3881
3882                     # Find Position of the element
3883                     position = None
3884                     for (parent_pright, parent_id) in parents:
3885                         if parent_id == id:
3886                             break
3887                         position = parent_pright and parent_pright + 1 or 1
3888
3889                     # It's the first node of the parent
3890                     if not position:
3891                         if not parent_val:
3892                             position = 1
3893                         else:
3894                             cr.execute('select parent_left from '+self._table+' where id=%s', (parent_val,))
3895                             position = cr.fetchone()[0] + 1
3896
3897                     if pleft < position <= pright:
3898                         raise except_orm(_('UserError'), _('Recursivity Detected.'))
3899
3900                     if pleft < position:
3901                         cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3902                         cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3903                         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))
3904                     else:
3905                         cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3906                         cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3907                         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))
3908                     recs.invalidate_cache(['parent_left', 'parent_right'])
3909
3910         result += self._store_get_values(cr, user, ids, vals.keys(), context)
3911         result.sort()
3912
3913         done = {}
3914         for order, model_name, ids_to_update, fields_to_recompute in result:
3915             key = (model_name, tuple(fields_to_recompute))
3916             done.setdefault(key, {})
3917             # avoid to do several times the same computation
3918             todo = []
3919             for id in ids_to_update:
3920                 if id not in done[key]:
3921                     done[key][id] = True
3922                     if id not in deleted_related[model_name]:
3923                         todo.append(id)
3924             self.pool[model_name]._store_set_values(cr, user, todo, fields_to_recompute, context)
3925
3926         # recompute new-style fields
3927         if context.get('recompute', True):
3928             recs.recompute()
3929
3930         self.step_workflow(cr, user, ids, context=context)
3931         return True
3932
3933     #
3934     # TODO: Should set perm to user.xxx
3935     #
3936     @api.model
3937     @api.returns('self', lambda value: value.id)
3938     def create(self, vals):
3939         """ create(vals) -> record
3940
3941         Creates a new record for the model.
3942
3943         The new record is initialized using the values from ``vals`` and
3944         if necessary those from :meth:`~.default_get`.
3945
3946         :param dict vals:
3947             values for the model's fields, as a dictionary::
3948
3949                 {'field_name': field_value, ...}
3950
3951             see :meth:`~.write` for details
3952         :return: new record created
3953         :raise AccessError: * if user has no create rights on the requested object
3954                             * if user tries to bypass access rules for create on the requested object
3955         :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3956         :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)
3957         """
3958         self.check_access_rights('create')
3959
3960         # add missing defaults, and drop fields that may not be set by user
3961         vals = self._add_missing_default_values(vals)
3962         for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3963             vals.pop(field, None)
3964
3965         # split up fields into old-style and pure new-style ones
3966         old_vals, new_vals, unknown = {}, {}, []
3967         for key, val in vals.iteritems():
3968             field = self._fields.get(key)
3969             if field:
3970                 if field.store or field.inherited:
3971                     old_vals[key] = val
3972                 if field.inverse and not field.inherited:
3973                     new_vals[key] = val
3974             else:
3975                 unknown.append(key)
3976
3977         if unknown:
3978             _logger.warning("%s.create() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3979
3980         # create record with old-style fields
3981         record = self.browse(self._create(old_vals))
3982
3983         # put the values of pure new-style fields into cache, and inverse them
3984         record._cache.update(record._convert_to_cache(new_vals))
3985         for key in new_vals:
3986             self._fields[key].determine_inverse(record)
3987
3988         return record
3989
3990     def _create(self, cr, user, vals, context=None):
3991         # low-level implementation of create()
3992         if not context:
3993             context = {}
3994
3995         if self.is_transient():
3996             self._transient_vacuum(cr, user)
3997
3998         tocreate = {}
3999         for v in self._inherits:
4000             if self._inherits[v] not in vals:
4001                 tocreate[v] = {}
4002             else:
4003                 tocreate[v] = {'id': vals[self._inherits[v]]}
4004
4005         updates = [
4006             # list of column assignments defined as tuples like:
4007             #   (column_name, format_string, column_value)
4008             #   (column_name, sql_formula)
4009             # Those tuples will be used by the string formatting for the INSERT
4010             # statement below.
4011             ('id', "nextval('%s')" % self._sequence),
4012         ]
4013
4014         upd_todo = []
4015         unknown_fields = []
4016         for v in vals.keys():
4017             if v in self._inherit_fields and v not in self._columns:
4018                 (table, col, col_detail, original_parent) = self._inherit_fields[v]
4019                 tocreate[table][v] = vals[v]
4020                 del vals[v]
4021             else:
4022                 if (v not in self._inherit_fields) and (v not in self._columns):
4023                     del vals[v]
4024                     unknown_fields.append(v)
4025         if unknown_fields:
4026             _logger.warning(
4027                 'No such field(s) in model %s: %s.',
4028                 self._name, ', '.join(unknown_fields))
4029
4030         for table in tocreate:
4031             if self._inherits[table] in vals:
4032                 del vals[self._inherits[table]]
4033
4034             record_id = tocreate[table].pop('id', None)
4035
4036             if record_id is None or not record_id:
4037                 record_id = self.pool[table].create(cr, user, tocreate[table], context=context)
4038             else:
4039                 self.pool[table].write(cr, user, [record_id], tocreate[table], context=context)
4040
4041             updates.append((self._inherits[table], '%s', record_id))
4042
4043         #Start : Set bool fields to be False if they are not touched(to make search more powerful)
4044         bool_fields = [x for x in self._columns.keys() if self._columns[x]._type=='boolean']
4045
4046         for bool_field in bool_fields:
4047             if bool_field not in vals:
4048                 vals[bool_field] = False
4049         #End
4050         for field in vals.keys():
4051             fobj = None
4052             if field in self._columns:
4053                 fobj = self._columns[field]
4054             else:
4055                 fobj = self._inherit_fields[field][2]
4056             if not fobj:
4057                 continue
4058             groups = fobj.write
4059             if groups:
4060                 edit = False
4061                 for group in groups:
4062                     module = group.split(".")[0]
4063                     grp = group.split(".")[1]
4064                     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" % \
4065                                (grp, module, 'res.groups', user))
4066                     readonly = cr.fetchall()
4067                     if readonly[0][0] >= 1:
4068                         edit = True
4069                         break
4070                     elif readonly[0][0] == 0:
4071                         edit = False
4072                     else:
4073                         edit = False
4074
4075                 if not edit:
4076                     vals.pop(field)
4077         for field in vals:
4078             current_field = self._columns[field]
4079             if current_field._classic_write:
4080                 updates.append((field, '%s', current_field._symbol_set[1](vals[field])))
4081
4082                 #for the function fields that receive a value, we set them directly in the database
4083                 #(they may be required), but we also need to trigger the _fct_inv()
4084                 if (hasattr(current_field, '_fnct_inv')) and not isinstance(current_field, fields.related):
4085                     #TODO: this way to special case the related fields is really creepy but it shouldn't be changed at
4086                     #one week of the release candidate. It seems the only good way to handle correctly this is to add an
4087                     #attribute to make a field `really readonly´ and thus totally ignored by the create()... otherwise
4088                     #if, for example, the related has a default value (for usability) then the fct_inv is called and it
4089                     #may raise some access rights error. Changing this is a too big change for now, and is thus postponed
4090                     #after the release but, definitively, the behavior shouldn't be different for related and function
4091                     #fields.
4092                     upd_todo.append(field)
4093             else:
4094                 #TODO: this `if´ statement should be removed because there is no good reason to special case the fields
4095                 #related. See the above TODO comment for further explanations.
4096                 if not isinstance(current_field, fields.related):
4097                     upd_todo.append(field)
4098             if field in self._columns \
4099                     and hasattr(current_field, 'selection') \
4100                     and vals[field]:
4101                 self._check_selection_field_value(cr, user, field, vals[field], context=context)
4102         if self._log_access:
4103             updates.append(('create_uid', '%s', user))
4104             updates.append(('write_uid', '%s', user))
4105             updates.append(('create_date', "(now() at time zone 'UTC')"))
4106             updates.append(('write_date', "(now() at time zone 'UTC')"))
4107
4108         # the list of tuples used in this formatting corresponds to
4109         # tuple(field_name, format, value)
4110         # In some case, for example (id, create_date, write_date) we does not
4111         # need to read the third value of the tuple, because the real value is
4112         # encoded in the second value (the format).
4113         cr.execute(
4114             """INSERT INTO "%s" (%s) VALUES(%s) RETURNING id""" % (
4115                 self._table,
4116                 ', '.join('"%s"' % u[0] for u in updates),
4117                 ', '.join(u[1] for u in updates)
4118             ),
4119             tuple([u[2] for u in updates if len(u) > 2])
4120         )
4121
4122         id_new, = cr.fetchone()
4123         recs = self.browse(cr, user, id_new, context)
4124
4125         if self._parent_store and not context.get('defer_parent_store_computation'):
4126             if self.pool._init:
4127                 self.pool._init_parent[self._name] = True
4128             else:
4129                 parent = vals.get(self._parent_name, False)
4130                 if parent:
4131                     cr.execute('select parent_right from '+self._table+' where '+self._parent_name+'=%s order by '+(self._parent_order or self._order), (parent,))
4132                     pleft_old = None
4133                     result_p = cr.fetchall()
4134                     for (pleft,) in result_p:
4135                         if not pleft:
4136                             break
4137                         pleft_old = pleft
4138                     if not pleft_old:
4139                         cr.execute('select parent_left from '+self._table+' where id=%s', (parent,))
4140                         pleft_old = cr.fetchone()[0]
4141                     pleft = pleft_old
4142                 else:
4143                     cr.execute('select max(parent_right) from '+self._table)
4144                     pleft = cr.fetchone()[0] or 0
4145                 cr.execute('update '+self._table+' set parent_left=parent_left+2 where parent_left>%s', (pleft,))
4146                 cr.execute('update '+self._table+' set parent_right=parent_right+2 where parent_right>%s', (pleft,))
4147                 cr.execute('update '+self._table+' set parent_left=%s,parent_right=%s where id=%s', (pleft+1, pleft+2, id_new))
4148                 recs.invalidate_cache(['parent_left', 'parent_right'])
4149
4150         # invalidate and mark new-style fields to recompute; do this before
4151         # setting other fields, because it can require the value of computed
4152         # fields, e.g., a one2many checking constraints on records
4153         recs.modified([u[0] for u in updates])
4154
4155         # call the 'set' method of fields which are not classic_write
4156         upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
4157
4158         # default element in context must be remove when call a one2many or many2many
4159         rel_context = context.copy()
4160         for c in context.items():
4161             if c[0].startswith('default_'):
4162                 del rel_context[c[0]]
4163
4164         result = []
4165         for field in upd_todo:
4166             result += self._columns[field].set(cr, self, id_new, field, vals[field], user, rel_context) or []
4167
4168         # for recomputing new-style fields
4169         recs.modified(upd_todo)
4170
4171         # check Python constraints
4172         recs._validate_fields(vals)
4173
4174         if context.get('recompute', True):
4175             result += self._store_get_values(cr, user, [id_new],
4176                 list(set(vals.keys() + self._inherits.values())),
4177                 context)
4178             result.sort()
4179             done = []
4180             for order, model_name, ids, fields2 in result:
4181                 if not (model_name, ids, fields2) in done:
4182                     self.pool[model_name]._store_set_values(cr, user, ids, fields2, context)
4183                     done.append((model_name, ids, fields2))
4184             # recompute new-style fields
4185             recs.recompute()
4186
4187         if self._log_create and context.get('recompute', True):
4188             message = self._description + \
4189                 " '" + \
4190                 self.name_get(cr, user, [id_new], context=context)[0][1] + \
4191                 "' " + _("created.")
4192             self.log(cr, user, id_new, message, True, context=context)
4193
4194         self.check_access_rule(cr, user, [id_new], 'create', context=context)
4195         self.create_workflow(cr, user, [id_new], context=context)
4196         return id_new
4197
4198     def _store_get_values(self, cr, uid, ids, fields, context):
4199         """Returns an ordered list of fields.function to call due to
4200            an update operation on ``fields`` of records with ``ids``,
4201            obtained by calling the 'store' triggers of these fields,
4202            as setup by their 'store' attribute.
4203
4204            :return: [(priority, model_name, [record_ids,], [function_fields,])]
4205         """
4206         if fields is None: fields = []
4207         stored_functions = self.pool._store_function.get(self._name, [])
4208
4209         # use indexed names for the details of the stored_functions:
4210         model_name_, func_field_to_compute_, target_ids_func_, trigger_fields_, priority_ = range(5)
4211
4212         # only keep store triggers that should be triggered for the ``fields``
4213         # being written to.
4214         triggers_to_compute = (
4215             f for f in stored_functions
4216             if not f[trigger_fields_] or set(fields).intersection(f[trigger_fields_])
4217         )
4218
4219         to_compute_map = {}
4220         target_id_results = {}
4221         for store_trigger in triggers_to_compute:
4222             target_func_id_ = id(store_trigger[target_ids_func_])
4223             if target_func_id_ not in target_id_results:
4224                 # use admin user for accessing objects having rules defined on store fields
4225                 target_id_results[target_func_id_] = [i for i in store_trigger[target_ids_func_](self, cr, SUPERUSER_ID, ids, context) if i]
4226             target_ids = target_id_results[target_func_id_]
4227
4228             # the compound key must consider the priority and model name
4229             key = (store_trigger[priority_], store_trigger[model_name_])
4230             for target_id in target_ids:
4231                 to_compute_map.setdefault(key, {}).setdefault(target_id,set()).add(tuple(store_trigger))
4232
4233         # Here to_compute_map looks like:
4234         # { (10, 'model_a') : { target_id1: [ (trigger_1_tuple, trigger_2_tuple) ], ... }
4235         #   (20, 'model_a') : { target_id2: [ (trigger_3_tuple, trigger_4_tuple) ], ... }
4236         #   (99, 'model_a') : { target_id1: [ (trigger_5_tuple, trigger_6_tuple) ], ... }
4237         # }
4238
4239         # Now we need to generate the batch function calls list
4240         # call_map =
4241         #   { (10, 'model_a') : [(10, 'model_a', [record_ids,], [function_fields,])] }
4242         call_map = {}
4243         for ((priority,model), id_map) in to_compute_map.iteritems():
4244             trigger_ids_maps = {}
4245             # function_ids_maps =
4246             #   { (function_1_tuple, function_2_tuple) : [target_id1, target_id2, ..] }
4247             for target_id, triggers in id_map.iteritems():
4248                 trigger_ids_maps.setdefault(tuple(triggers), []).append(target_id)
4249             for triggers, target_ids in trigger_ids_maps.iteritems():
4250                 call_map.setdefault((priority,model),[]).append((priority, model, target_ids,
4251                                                                  [t[func_field_to_compute_] for t in triggers]))
4252         result = []
4253         if call_map:
4254             result = reduce(operator.add, (call_map[k] for k in sorted(call_map)))
4255         return result
4256
4257     def _store_set_values(self, cr, uid, ids, fields, context):
4258         """Calls the fields.function's "implementation function" for all ``fields``, on records with ``ids`` (taking care of
4259            respecting ``multi`` attributes), and stores the resulting values in the database directly."""
4260         if not ids:
4261             return True
4262         field_flag = False
4263         field_dict = {}
4264         if self._log_access:
4265             cr.execute('select id,write_date from '+self._table+' where id IN %s', (tuple(ids),))
4266             res = cr.fetchall()
4267             for r in res:
4268                 if r[1]:
4269                     field_dict.setdefault(r[0], [])
4270                     res_date = time.strptime((r[1])[:19], '%Y-%m-%d %H:%M:%S')
4271                     write_date = datetime.datetime.fromtimestamp(time.mktime(res_date))
4272                     for i in self.pool._store_function.get(self._name, []):
4273                         if i[5]:
4274                             up_write_date = write_date + datetime.timedelta(hours=i[5])
4275                             if datetime.datetime.now() < up_write_date:
4276                                 if i[1] in fields:
4277                                     field_dict[r[0]].append(i[1])
4278                                     if not field_flag:
4279                                         field_flag = True
4280         todo = {}
4281         keys = []
4282         for f in fields:
4283             if self._columns[f]._multi not in keys:
4284                 keys.append(self._columns[f]._multi)
4285             todo.setdefault(self._columns[f]._multi, [])
4286             todo[self._columns[f]._multi].append(f)
4287         for key in keys:
4288             val = todo[key]
4289             if key:
4290                 # use admin user for accessing objects having rules defined on store fields
4291                 result = self._columns[val[0]].get(cr, self, ids, val, SUPERUSER_ID, context=context)
4292                 for id, value in result.items():
4293                     if field_flag:
4294                         for f in value.keys():
4295                             if f in field_dict[id]:
4296                                 value.pop(f)
4297                     upd0 = []
4298                     upd1 = []
4299                     for v in value:
4300                         if v not in val:
4301                             continue
4302                         if self._columns[v]._type == 'many2one':
4303                             try:
4304                                 value[v] = value[v][0]
4305                             except:
4306                                 pass
4307                         upd0.append('"'+v+'"='+self._columns[v]._symbol_set[0])
4308                         upd1.append(self._columns[v]._symbol_set[1](value[v]))
4309                     upd1.append(id)
4310                     if upd0 and upd1:
4311                         cr.execute('update "' + self._table + '" set ' + \
4312                             ','.join(upd0) + ' where id = %s', upd1)
4313
4314             else:
4315                 for f in val:
4316                     # use admin user for accessing objects having rules defined on store fields
4317                     result = self._columns[f].get(cr, self, ids, f, SUPERUSER_ID, context=context)
4318                     for r in result.keys():
4319                         if field_flag:
4320                             if r in field_dict.keys():
4321                                 if f in field_dict[r]:
4322                                     result.pop(r)
4323                     for id, value in result.items():
4324                         if self._columns[f]._type == 'many2one':
4325                             try:
4326                                 value = value[0]
4327                             except:
4328                                 pass
4329                         cr.execute('update "' + self._table + '" set ' + \
4330                             '"'+f+'"='+self._columns[f]._symbol_set[0] + ' where id = %s', (self._columns[f]._symbol_set[1](value), id))
4331
4332         # invalidate and mark new-style fields to recompute
4333         self.browse(cr, uid, ids, context).modified(fields)
4334
4335         return True
4336
4337     # TODO: ameliorer avec NULL
4338     def _where_calc(self, cr, user, domain, active_test=True, context=None):
4339         """Computes the WHERE clause needed to implement an OpenERP domain.
4340         :param domain: the domain to compute
4341         :type domain: list
4342         :param active_test: whether the default filtering of records with ``active``
4343                             field set to ``False`` should be applied.
4344         :return: the query expressing the given domain as provided in domain
4345         :rtype: osv.query.Query
4346         """
4347         if not context:
4348             context = {}
4349         domain = domain[:]
4350         # if the object has a field named 'active', filter out all inactive
4351         # records unless they were explicitely asked for
4352         if 'active' in self._all_columns and (active_test and context.get('active_test', True)):
4353             if domain:
4354                 # the item[0] trick below works for domain items and '&'/'|'/'!'
4355                 # operators too
4356                 if not any(item[0] == 'active' for item in domain):
4357                     domain.insert(0, ('active', '=', 1))
4358             else:
4359                 domain = [('active', '=', 1)]
4360
4361         if domain:
4362             e = expression.expression(cr, user, domain, self, context)
4363             tables = e.get_tables()
4364             where_clause, where_params = e.to_sql()
4365             where_clause = where_clause and [where_clause] or []
4366         else:
4367             where_clause, where_params, tables = [], [], ['"%s"' % self._table]
4368
4369         return Query(tables, where_clause, where_params)
4370
4371     def _check_qorder(self, word):
4372         if not regex_order.match(word):
4373             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)'))
4374         return True
4375
4376     def _apply_ir_rules(self, cr, uid, query, mode='read', context=None):
4377         """Add what's missing in ``query`` to implement all appropriate ir.rules
4378           (using the ``model_name``'s rules or the current model's rules if ``model_name`` is None)
4379
4380            :param query: the current query object
4381         """
4382         if uid == SUPERUSER_ID:
4383             return
4384
4385         def apply_rule(added_clause, added_params, added_tables, parent_model=None):
4386             """ :param parent_model: name of the parent model, if the added
4387                     clause comes from a parent model
4388             """
4389             if added_clause:
4390                 if parent_model:
4391                     # as inherited rules are being applied, we need to add the missing JOIN
4392                     # to reach the parent table (if it was not JOINed yet in the query)
4393                     parent_alias = self._inherits_join_add(self, parent_model, query)
4394                     # inherited rules are applied on the external table -> need to get the alias and replace
4395                     parent_table = self.pool[parent_model]._table
4396                     added_clause = [clause.replace('"%s"' % parent_table, '"%s"' % parent_alias) for clause in added_clause]
4397                     # change references to parent_table to parent_alias, because we now use the alias to refer to the table
4398                     new_tables = []
4399                     for table in added_tables:
4400                         # table is just a table name -> switch to the full alias
4401                         if table == '"%s"' % parent_table:
4402                             new_tables.append('"%s" as "%s"' % (parent_table, parent_alias))
4403                         # table is already a full statement -> replace reference to the table to its alias, is correct with the way aliases are generated
4404                         else:
4405                             new_tables.append(table.replace('"%s"' % parent_table, '"%s"' % parent_alias))
4406                     added_tables = new_tables
4407                 query.where_clause += added_clause
4408                 query.where_clause_params += added_params
4409                 for table in added_tables:
4410                     if table not in query.tables:
4411                         query.tables.append(table)
4412                 return True
4413             return False
4414
4415         # apply main rules on the object
4416         rule_obj = self.pool.get('ir.rule')
4417         rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, self._name, mode, context=context)
4418         apply_rule(rule_where_clause, rule_where_clause_params, rule_tables)
4419
4420         # apply ir.rules from the parents (through _inherits)
4421         for inherited_model in self._inherits:
4422             rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, inherited_model, mode, context=context)
4423             apply_rule(rule_where_clause, rule_where_clause_params, rule_tables,
4424                         parent_model=inherited_model)
4425
4426     def _generate_m2o_order_by(self, order_field, query):
4427         """
4428         Add possibly missing JOIN to ``query`` and generate the ORDER BY clause for m2o fields,
4429         either native m2o fields or function/related fields that are stored, including
4430         intermediate JOINs for inheritance if required.
4431
4432         :return: the qualified field name to use in an ORDER BY clause to sort by ``order_field``
4433         """
4434         if order_field not in self._columns and order_field in self._inherit_fields:
4435             # also add missing joins for reaching the table containing the m2o field
4436             qualified_field = self._inherits_join_calc(order_field, query)
4437             order_field_column = self._inherit_fields[order_field][2]
4438         else:
4439             qualified_field = '"%s"."%s"' % (self._table, order_field)
4440             order_field_column = self._columns[order_field]
4441
4442         assert order_field_column._type == 'many2one', 'Invalid field passed to _generate_m2o_order_by()'
4443         if not order_field_column._classic_write and not getattr(order_field_column, 'store', False):
4444             _logger.debug("Many2one function/related fields must be stored " \
4445                 "to be used as ordering fields! Ignoring sorting for %s.%s",
4446                 self._name, order_field)
4447             return
4448
4449         # figure out the applicable order_by for the m2o
4450         dest_model = self.pool[order_field_column._obj]
4451         m2o_order = dest_model._order
4452         if not regex_order.match(m2o_order):
4453             # _order is complex, can't use it here, so we default to _rec_name
4454             m2o_order = dest_model._rec_name
4455         else:
4456             # extract the field names, to be able to qualify them and add desc/asc
4457             m2o_order_list = []
4458             for order_part in m2o_order.split(","):
4459                 m2o_order_list.append(order_part.strip().split(" ", 1)[0].strip())
4460             m2o_order = m2o_order_list
4461
4462         # Join the dest m2o table if it's not joined yet. We use [LEFT] OUTER join here
4463         # as we don't want to exclude results that have NULL values for the m2o
4464         src_table, src_field = qualified_field.replace('"', '').split('.', 1)
4465         dst_alias, dst_alias_statement = query.add_join((src_table, dest_model._table, src_field, 'id', src_field), implicit=False, outer=True)
4466         qualify = lambda field: '"%s"."%s"' % (dst_alias, field)
4467         return map(qualify, m2o_order) if isinstance(m2o_order, list) else qualify(m2o_order)
4468
4469     def _generate_order_by(self, order_spec, query):
4470         """
4471         Attempt to consruct an appropriate ORDER BY clause based on order_spec, which must be
4472         a comma-separated list of valid field names, optionally followed by an ASC or DESC direction.
4473
4474         :raise" except_orm in case order_spec is malformed
4475         """
4476         order_by_clause = ''
4477         order_spec = order_spec or self._order
4478         if order_spec:
4479             order_by_elements = []
4480             self._check_qorder(order_spec)
4481             for order_part in order_spec.split(','):
4482                 order_split = order_part.strip().split(' ')
4483                 order_field = order_split[0].strip()
4484                 order_direction = order_split[1].strip() if len(order_split) == 2 else ''
4485                 order_column = None
4486                 inner_clause = None
4487                 if order_field == 'id':
4488                     order_by_elements.append('"%s"."%s" %s' % (self._table, order_field, order_direction))
4489                 elif order_field in self._columns:
4490                     order_column = self._columns[order_field]
4491                     if order_column._classic_read:
4492                         inner_clause = '"%s"."%s"' % (self._table, order_field)
4493                     elif order_column._type == 'many2one':
4494                         inner_clause = self._generate_m2o_order_by(order_field, query)
4495                     else:
4496                         continue  # ignore non-readable or "non-joinable" fields
4497                 elif order_field in self._inherit_fields:
4498                     parent_obj = self.pool[self._inherit_fields[order_field][3]]
4499                     order_column = parent_obj._columns[order_field]
4500                     if order_column._classic_read:
4501                         inner_clause = self._inherits_join_calc(order_field, query)
4502                     elif order_column._type == 'many2one':
4503                         inner_clause = self._generate_m2o_order_by(order_field, query)
4504                     else:
4505                         continue  # ignore non-readable or "non-joinable" fields
4506                 else:
4507                     raise ValueError( _("Sorting field %s not found on model %s") %( order_field, self._name))
4508                 if order_column and order_column._type == 'boolean':
4509                     inner_clause = "COALESCE(%s, false)" % inner_clause
4510                 if inner_clause:
4511                     if isinstance(inner_clause, list):
4512                         for clause in inner_clause:
4513                             order_by_elements.append("%s %s" % (clause, order_direction))
4514                     else:
4515                         order_by_elements.append("%s %s" % (inner_clause, order_direction))
4516             if order_by_elements:
4517                 order_by_clause = ",".join(order_by_elements)
4518
4519         return order_by_clause and (' ORDER BY %s ' % order_by_clause) or ''
4520
4521     def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
4522         """
4523         Private implementation of search() method, allowing specifying the uid to use for the access right check.
4524         This is useful for example when filling in the selection list for a drop-down and avoiding access rights errors,
4525         by specifying ``access_rights_uid=1`` to bypass access rights check, but not ir.rules!
4526         This is ok at the security level because this method is private and not callable through XML-RPC.
4527
4528         :param access_rights_uid: optional user ID to use when checking access rights
4529                                   (not for ir.rules, this is only for ir.model.access)
4530         """
4531         if context is None:
4532             context = {}
4533         self.check_access_rights(cr, access_rights_uid or user, 'read')
4534
4535         # For transient models, restrict acces to the current user, except for the super-user
4536         if self.is_transient() and self._log_access and user != SUPERUSER_ID:
4537             args = expression.AND(([('create_uid', '=', user)], args or []))
4538
4539         query = self._where_calc(cr, user, args, context=context)
4540         self._apply_ir_rules(cr, user, query, 'read', context=context)
4541         order_by = self._generate_order_by(order, query)
4542         from_clause, where_clause, where_clause_params = query.get_sql()
4543
4544         where_str = where_clause and (" WHERE %s" % where_clause) or ''
4545
4546         if count:
4547             # Ignore order, limit and offset when just counting, they don't make sense and could
4548             # hurt performance
4549             query_str = 'SELECT count(1) FROM ' + from_clause + where_str
4550             cr.execute(query_str, where_clause_params)
4551             res = cr.fetchone()
4552             return res[0]
4553
4554         limit_str = limit and ' limit %d' % limit or ''
4555         offset_str = offset and ' offset %d' % offset or ''
4556         query_str = 'SELECT "%s".id FROM ' % self._table + from_clause + where_str + order_by + limit_str + offset_str
4557         cr.execute(query_str, where_clause_params)
4558         res = cr.fetchall()
4559
4560         # TDE note: with auto_join, we could have several lines about the same result
4561         # i.e. a lead with several unread messages; we uniquify the result using
4562         # a fast way to do it while preserving order (http://www.peterbe.com/plog/uniqifiers-benchmark)
4563         def _uniquify_list(seq):
4564             seen = set()
4565             return [x for x in seq if x not in seen and not seen.add(x)]
4566
4567         return _uniquify_list([x[0] for x in res])
4568
4569     # returns the different values ever entered for one field
4570     # this is used, for example, in the client when the user hits enter on
4571     # a char field
4572     def distinct_field_get(self, cr, uid, field, value, args=None, offset=0, limit=None):
4573         if not args:
4574             args = []
4575         if field in self._inherit_fields:
4576             return self.pool[self._inherit_fields[field][0]].distinct_field_get(cr, uid, field, value, args, offset, limit)
4577         else:
4578             return self._columns[field].search(cr, self, args, field, value, offset, limit, uid)
4579
4580     def copy_data(self, cr, uid, id, default=None, context=None):
4581         """
4582         Copy given record's data with all its fields values
4583
4584         :param cr: database cursor
4585         :param uid: current user id
4586         :param id: id of the record to copy
4587         :param default: field values to override in the original values of the copied record
4588         :type default: dictionary
4589         :param context: context arguments, like lang, time zone
4590         :type context: dictionary
4591         :return: dictionary containing all the field values
4592         """
4593
4594         if context is None:
4595             context = {}
4596
4597         # avoid recursion through already copied records in case of circular relationship
4598         seen_map = context.setdefault('__copy_data_seen', {})
4599         if id in seen_map.setdefault(self._name, []):
4600             return
4601         seen_map[self._name].append(id)
4602
4603         if default is None:
4604             default = {}
4605         if 'state' not in default:
4606             if 'state' in self._defaults:
4607                 if callable(self._defaults['state']):
4608                     default['state'] = self._defaults['state'](self, cr, uid, context)
4609                 else:
4610                     default['state'] = self._defaults['state']
4611
4612         # build a black list of fields that should not be copied
4613         blacklist = set(MAGIC_COLUMNS + ['parent_left', 'parent_right'])
4614         def blacklist_given_fields(obj):
4615             # blacklist the fields that are given by inheritance
4616             for other, field_to_other in obj._inherits.items():
4617                 blacklist.add(field_to_other)
4618                 if field_to_other in default:
4619                     # all the fields of 'other' are given by the record: default[field_to_other],
4620                     # except the ones redefined in self
4621                     blacklist.update(set(self.pool[other]._all_columns) - set(self._columns))
4622                 else:
4623                     blacklist_given_fields(self.pool[other])
4624             # blacklist deprecated fields
4625             for name, field in obj._columns.items():
4626                 if field.deprecated:
4627                     blacklist.add(name)
4628
4629         blacklist_given_fields(self)
4630
4631
4632         fields_to_copy = dict((f,fi) for f, fi in self._all_columns.iteritems()
4633                                      if fi.column.copy
4634                                      if f not in default
4635                                      if f not in blacklist)
4636
4637         data = self.read(cr, uid, [id], fields_to_copy.keys(), context=context)
4638         if data:
4639             data = data[0]
4640         else:
4641             raise IndexError( _("Record #%d of %s not found, cannot copy!") %( id, self._name))
4642
4643         res = dict(default)
4644         for f, colinfo in fields_to_copy.iteritems():
4645             field = colinfo.column
4646             if field._type == 'many2one':
4647                 res[f] = data[f] and data[f][0]
4648             elif field._type == 'one2many':
4649                 other = self.pool[field._obj]
4650                 # duplicate following the order of the ids because we'll rely on
4651                 # it later for copying translations in copy_translation()!
4652                 lines = [other.copy_data(cr, uid, line_id, context=context) for line_id in sorted(data[f])]
4653                 # the lines are duplicated using the wrong (old) parent, but then
4654                 # are reassigned to the correct one thanks to the (0, 0, ...)
4655                 res[f] = [(0, 0, line) for line in lines if line]
4656             elif field._type == 'many2many':
4657                 res[f] = [(6, 0, data[f])]
4658             else:
4659                 res[f] = data[f]
4660
4661         return res
4662
4663     def copy_translations(self, cr, uid, old_id, new_id, context=None):
4664         if context is None:
4665             context = {}
4666
4667         # avoid recursion through already copied records in case of circular relationship
4668         seen_map = context.setdefault('__copy_translations_seen',{})
4669         if old_id in seen_map.setdefault(self._name,[]):
4670             return
4671         seen_map[self._name].append(old_id)
4672
4673         trans_obj = self.pool.get('ir.translation')
4674         # TODO it seems fields_get can be replaced by _all_columns (no need for translation)
4675         fields = self.fields_get(cr, uid, context=context)
4676
4677         for field_name, field_def in fields.items():
4678             # removing the lang to compare untranslated values
4679             context_wo_lang = dict(context, lang=None)
4680             old_record, new_record = self.browse(cr, uid, [old_id, new_id], context=context_wo_lang)
4681             # we must recursively copy the translations for o2o and o2m
4682             if field_def['type'] == 'one2many':
4683                 target_obj = self.pool[field_def['relation']]
4684                 # here we rely on the order of the ids to match the translations
4685                 # as foreseen in copy_data()
4686                 old_children = sorted(r.id for r in old_record[field_name])
4687                 new_children = sorted(r.id for r in new_record[field_name])
4688                 for (old_child, new_child) in zip(old_children, new_children):
4689                     target_obj.copy_translations(cr, uid, old_child, new_child, context=context)
4690             # and for translatable fields we keep them for copy
4691             elif field_def.get('translate'):
4692                 if field_name in self._columns:
4693                     trans_name = self._name + "," + field_name
4694                     target_id = new_id
4695                     source_id = old_id
4696                 elif field_name in self._inherit_fields:
4697                     trans_name = self._inherit_fields[field_name][0] + "," + field_name
4698                     # get the id of the parent record to set the translation
4699                     inherit_field_name = self._inherit_fields[field_name][1]
4700                     target_id = new_record[inherit_field_name].id
4701                     source_id = old_record[inherit_field_name].id
4702                 else:
4703                     continue
4704
4705                 trans_ids = trans_obj.search(cr, uid, [
4706                         ('name', '=', trans_name),
4707                         ('res_id', '=', source_id)
4708                 ])
4709                 user_lang = context.get('lang')
4710                 for record in trans_obj.read(cr, uid, trans_ids, context=context):
4711                     del record['id']
4712                     # remove source to avoid triggering _set_src
4713                     del record['source']
4714                     record.update({'res_id': target_id})
4715                     if user_lang and user_lang == record['lang']:
4716                         # 'source' to force the call to _set_src
4717                         # 'value' needed if value is changed in copy(), want to see the new_value
4718                         record['source'] = old_record[field_name]
4719                         record['value'] = new_record[field_name]
4720                     trans_obj.create(cr, uid, record, context=context)
4721
4722     @api.returns('self', lambda value: value.id)
4723     def copy(self, cr, uid, id, default=None, context=None):
4724         """ copy(default=None)
4725
4726         Duplicate record with given id updating it with default values
4727
4728         :param dict default: dictionary of field values to override in the
4729                original values of the copied record, e.g: ``{'field_name': overriden_value, ...}``
4730         :returns: new record
4731
4732         """
4733         if context is None:
4734             context = {}
4735         context = context.copy()
4736         data = self.copy_data(cr, uid, id, default, context)
4737         new_id = self.create(cr, uid, data, context)
4738         self.copy_translations(cr, uid, id, new_id, context)
4739         return new_id
4740
4741     @api.multi
4742     @api.returns('self')
4743     def exists(self):
4744         """  exists() -> records
4745
4746         Returns the subset of records in `self` that exist, and marks deleted
4747         records as such in cache. It can be used as a test on records::
4748
4749             if record.exists():
4750                 ...
4751
4752         By convention, new records are returned as existing.
4753         """
4754         ids = filter(None, self._ids)           # ids to check in database
4755         if not ids:
4756             return self
4757         query = """SELECT id FROM "%s" WHERE id IN %%s""" % self._table
4758         self._cr.execute(query, (ids,))
4759         ids = ([r[0] for r in self._cr.fetchall()] +    # ids in database
4760                [id for id in self._ids if not id])      # new ids
4761         existing = self.browse(ids)
4762         if len(existing) < len(self):
4763             # mark missing records in cache with a failed value
4764             exc = MissingError(_("Record does not exist or has been deleted."))
4765             (self - existing)._cache.update(FailedValue(exc))
4766         return existing
4767
4768     def check_recursion(self, cr, uid, ids, context=None, parent=None):
4769         _logger.warning("You are using deprecated %s.check_recursion(). Please use the '_check_recursion()' instead!" % \
4770                         self._name)
4771         assert parent is None or parent in self._columns or parent in self._inherit_fields,\
4772                     "The 'parent' parameter passed to check_recursion() must be None or a valid field name"
4773         return self._check_recursion(cr, uid, ids, context, parent)
4774
4775     def _check_recursion(self, cr, uid, ids, context=None, parent=None):
4776         """
4777         Verifies that there is no loop in a hierarchical structure of records,
4778         by following the parent relationship using the **parent** field until a loop
4779         is detected or until a top-level record is found.
4780
4781         :param cr: database cursor
4782         :param uid: current user id
4783         :param ids: list of ids of records to check
4784         :param parent: optional parent field name (default: ``self._parent_name = parent_id``)
4785         :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4786         """
4787         if not parent:
4788             parent = self._parent_name
4789
4790         # must ignore 'active' flag, ir.rules, etc. => direct SQL query
4791         query = 'SELECT "%s" FROM "%s" WHERE id = %%s' % (parent, self._table)
4792         for id in ids:
4793             current_id = id
4794             while current_id is not None:
4795                 cr.execute(query, (current_id,))
4796                 result = cr.fetchone()
4797                 current_id = result[0] if result else None
4798                 if current_id == id:
4799                     return False
4800         return True
4801
4802     def _check_m2m_recursion(self, cr, uid, ids, field_name):
4803         """
4804         Verifies that there is no loop in a hierarchical structure of records,
4805         by following the parent relationship using the **parent** field until a loop
4806         is detected or until a top-level record is found.
4807
4808         :param cr: database cursor
4809         :param uid: current user id
4810         :param ids: list of ids of records to check
4811         :param field_name: field to check
4812         :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4813         """
4814
4815         field = self._all_columns.get(field_name)
4816         field = field.column if field else None
4817         if not field or field._type != 'many2many' or field._obj != self._name:
4818             # field must be a many2many on itself
4819             raise ValueError('invalid field_name: %r' % (field_name,))
4820
4821         query = 'SELECT distinct "%s" FROM "%s" WHERE "%s" IN %%s' % (field._id2, field._rel, field._id1)
4822         ids_parent = ids[:]
4823         while ids_parent:
4824             ids_parent2 = []
4825             for i in range(0, len(ids_parent), cr.IN_MAX):
4826                 j = i + cr.IN_MAX
4827                 sub_ids_parent = ids_parent[i:j]
4828                 cr.execute(query, (tuple(sub_ids_parent),))
4829                 ids_parent2.extend(filter(None, map(lambda x: x[0], cr.fetchall())))
4830             ids_parent = ids_parent2
4831             for i in ids_parent:
4832                 if i in ids:
4833                     return False
4834         return True
4835
4836     def _get_external_ids(self, cr, uid, ids, *args, **kwargs):
4837         """Retrieve the External ID(s) of any database record.
4838
4839         **Synopsis**: ``_get_xml_ids(cr, uid, ids) -> { 'id': ['module.xml_id'] }``
4840
4841         :return: map of ids to the list of their fully qualified External IDs
4842                  in the form ``module.key``, or an empty list when there's no External
4843                  ID for a record, e.g.::
4844
4845                      { 'id': ['module.ext_id', 'module.ext_id_bis'],
4846                        'id2': [] }
4847         """
4848         ir_model_data = self.pool.get('ir.model.data')
4849         data_ids = ir_model_data.search(cr, uid, [('model', '=', self._name), ('res_id', 'in', ids)])
4850         data_results = ir_model_data.read(cr, uid, data_ids, ['module', 'name', 'res_id'])
4851         result = {}
4852         for id in ids:
4853             # can't use dict.fromkeys() as the list would be shared!
4854             result[id] = []
4855         for record in data_results:
4856             result[record['res_id']].append('%(module)s.%(name)s' % record)
4857         return result
4858
4859     def get_external_id(self, cr, uid, ids, *args, **kwargs):
4860         """Retrieve the External ID of any database record, if there
4861         is one. This method works as a possible implementation
4862         for a function field, to be able to add it to any
4863         model object easily, referencing it as ``Model.get_external_id``.
4864
4865         When multiple External IDs exist for a record, only one
4866         of them is returned (randomly).
4867
4868         :return: map of ids to their fully qualified XML ID,
4869                  defaulting to an empty string when there's none
4870                  (to be usable as a function field),
4871                  e.g.::
4872
4873                      { 'id': 'module.ext_id',
4874                        'id2': '' }
4875         """
4876         results = self._get_xml_ids(cr, uid, ids)
4877         for k, v in results.iteritems():
4878             if results[k]:
4879                 results[k] = v[0]
4880             else:
4881                 results[k] = ''
4882         return results
4883
4884     # backwards compatibility
4885     get_xml_id = get_external_id
4886     _get_xml_ids = _get_external_ids
4887
4888     def print_report(self, cr, uid, ids, name, data, context=None):
4889         """
4890         Render the report `name` for the given IDs. The report must be defined
4891         for this model, not another.
4892         """
4893         report = self.pool['ir.actions.report.xml']._lookup_report(cr, name)
4894         assert self._name == report.table
4895         return report.create(cr, uid, ids, data, context)
4896
4897     # Transience
4898     @classmethod
4899     def is_transient(cls):
4900         """ Return whether the model is transient.
4901
4902         See :class:`TransientModel`.
4903
4904         """
4905         return cls._transient
4906
4907     def _transient_clean_rows_older_than(self, cr, seconds):
4908         assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4909         # Never delete rows used in last 5 minutes
4910         seconds = max(seconds, 300)
4911         query = ("SELECT id FROM " + self._table + " WHERE"
4912             " COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp"
4913             " < ((now() at time zone 'UTC') - interval %s)")
4914         cr.execute(query, ("%s seconds" % seconds,))
4915         ids = [x[0] for x in cr.fetchall()]
4916         self.unlink(cr, SUPERUSER_ID, ids)
4917
4918     def _transient_clean_old_rows(self, cr, max_count):
4919         # Check how many rows we have in the table
4920         cr.execute("SELECT count(*) AS row_count FROM " + self._table)
4921         res = cr.fetchall()
4922         if res[0][0] <= max_count:
4923             return  # max not reached, nothing to do
4924         self._transient_clean_rows_older_than(cr, 300)
4925
4926     def _transient_vacuum(self, cr, uid, force=False):
4927         """Clean the transient records.
4928
4929         This unlinks old records from the transient model tables whenever the
4930         "_transient_max_count" or "_max_age" conditions (if any) are reached.
4931         Actual cleaning will happen only once every "_transient_check_time" calls.
4932         This means this method can be called frequently called (e.g. whenever
4933         a new record is created).
4934         Example with both max_hours and max_count active:
4935         Suppose max_hours = 0.2 (e.g. 12 minutes), max_count = 20, there are 55 rows in the
4936         table, 10 created/changed in the last 5 minutes, an additional 12 created/changed between
4937         5 and 10 minutes ago, the rest created/changed more then 12 minutes ago.
4938         - age based vacuum will leave the 22 rows created/changed in the last 12 minutes
4939         - count based vacuum will wipe out another 12 rows. Not just 2, otherwise each addition
4940           would immediately cause the maximum to be reached again.
4941         - the 10 rows that have been created/changed the last 5 minutes will NOT be deleted
4942         """
4943         assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4944         _transient_check_time = 20          # arbitrary limit on vacuum executions
4945         self._transient_check_count += 1
4946         if not force and (self._transient_check_count < _transient_check_time):
4947             return True  # no vacuum cleaning this time
4948         self._transient_check_count = 0
4949
4950         # Age-based expiration
4951         if self._transient_max_hours:
4952             self._transient_clean_rows_older_than(cr, self._transient_max_hours * 60 * 60)
4953
4954         # Count-based expiration
4955         if self._transient_max_count:
4956             self._transient_clean_old_rows(cr, self._transient_max_count)
4957
4958         return True
4959
4960     def resolve_2many_commands(self, cr, uid, field_name, commands, fields=None, context=None):
4961         """ Serializes one2many and many2many commands into record dictionaries
4962             (as if all the records came from the database via a read()).  This
4963             method is aimed at onchange methods on one2many and many2many fields.
4964
4965             Because commands might be creation commands, not all record dicts
4966             will contain an ``id`` field.  Commands matching an existing record
4967             will have an ``id``.
4968
4969             :param field_name: name of the one2many or many2many field matching the commands
4970             :type field_name: str
4971             :param commands: one2many or many2many commands to execute on ``field_name``
4972             :type commands: list((int|False, int|False, dict|False))
4973             :param fields: list of fields to read from the database, when applicable
4974             :type fields: list(str)
4975             :returns: records in a shape similar to that returned by ``read()``
4976                 (except records may be missing the ``id`` field if they don't exist in db)
4977             :rtype: list(dict)
4978         """
4979         result = []             # result (list of dict)
4980         record_ids = []         # ids of records to read
4981         updates = {}            # {id: dict} of updates on particular records
4982
4983         for command in commands or []:
4984             if not isinstance(command, (list, tuple)):
4985                 record_ids.append(command)
4986             elif command[0] == 0:
4987                 result.append(command[2])
4988             elif command[0] == 1:
4989                 record_ids.append(command[1])
4990                 updates.setdefault(command[1], {}).update(command[2])
4991             elif command[0] in (2, 3):
4992                 record_ids = [id for id in record_ids if id != command[1]]
4993             elif command[0] == 4:
4994                 record_ids.append(command[1])
4995             elif command[0] == 5:
4996                 result, record_ids = [], []
4997             elif command[0] == 6:
4998                 result, record_ids = [], list(command[2])
4999
5000         # read the records and apply the updates
5001         other_model = self.pool[self._all_columns[field_name].column._obj]
5002         for record in other_model.read(cr, uid, record_ids, fields=fields, context=context):
5003             record.update(updates.get(record['id'], {}))
5004             result.append(record)
5005
5006         return result
5007
5008     # for backward compatibility
5009     resolve_o2m_commands_to_record_dicts = resolve_2many_commands
5010
5011     def search_read(self, cr, uid, domain=None, fields=None, offset=0, limit=None, order=None, context=None):
5012         """
5013         Performs a ``search()`` followed by a ``read()``.
5014
5015         :param cr: database cursor
5016         :param user: current user id
5017         :param domain: Search domain, see ``args`` parameter in ``search()``. Defaults to an empty domain that will match all records.
5018         :param fields: List of fields to read, see ``fields`` parameter in ``read()``. Defaults to all fields.
5019         :param offset: Number of records to skip, see ``offset`` parameter in ``search()``. Defaults to 0.
5020         :param limit: Maximum number of records to return, see ``limit`` parameter in ``search()``. Defaults to no limit.
5021         :param order: Columns to sort result, see ``order`` parameter in ``search()``. Defaults to no sort.
5022         :param context: context arguments.
5023         :return: List of dictionaries containing the asked fields.
5024         :rtype: List of dictionaries.
5025
5026         """
5027         record_ids = self.search(cr, uid, domain or [], offset=offset, limit=limit, order=order, context=context)
5028         if not record_ids:
5029             return []
5030
5031         if fields and fields == ['id']:
5032             # shortcut read if we only want the ids
5033             return [{'id': id} for id in record_ids]
5034
5035         # read() ignores active_test, but it would forward it to any downstream search call
5036         # (e.g. for x2m or function fields), and this is not the desired behavior, the flag
5037         # was presumably only meant for the main search().
5038         # TODO: Move this to read() directly?
5039         read_ctx = dict(context or {})
5040         read_ctx.pop('active_test', None)
5041
5042         result = self.read(cr, uid, record_ids, fields, context=read_ctx)
5043         if len(result) <= 1:
5044             return result
5045
5046         # reorder read
5047         index = dict((r['id'], r) for r in result)
5048         return [index[x] for x in record_ids if x in index]
5049
5050     def _register_hook(self, cr):
5051         """ stuff to do right after the registry is built """
5052         pass
5053
5054     @classmethod
5055     def _patch_method(cls, name, method):
5056         """ Monkey-patch a method for all instances of this model. This replaces
5057             the method called `name` by `method` in the given class.
5058             The original method is then accessible via ``method.origin``, and it
5059             can be restored with :meth:`~._revert_method`.
5060
5061             Example::
5062
5063                 @api.multi
5064                 def do_write(self, values):
5065                     # do stuff, and call the original method
5066                     return do_write.origin(self, values)
5067
5068                 # patch method write of model
5069                 model._patch_method('write', do_write)
5070
5071                 # this will call do_write
5072                 records = model.search([...])
5073                 records.write(...)
5074
5075                 # restore the original method
5076                 model._revert_method('write')
5077         """
5078         origin = getattr(cls, name)
5079         method.origin = origin
5080         # propagate decorators from origin to method, and apply api decorator
5081         wrapped = api.guess(api.propagate(origin, method))
5082         wrapped.origin = origin
5083         setattr(cls, name, wrapped)
5084
5085     @classmethod
5086     def _revert_method(cls, name):
5087         """ Revert the original method called `name` in the given class.
5088             See :meth:`~._patch_method`.
5089         """
5090         method = getattr(cls, name)
5091         setattr(cls, name, method.origin)
5092
5093     #
5094     # Instance creation
5095     #
5096     # An instance represents an ordered collection of records in a given
5097     # execution environment. The instance object refers to the environment, and
5098     # the records themselves are represented by their cache dictionary. The 'id'
5099     # of each record is found in its corresponding cache dictionary.
5100     #
5101     # This design has the following advantages:
5102     #  - cache access is direct and thus fast;
5103     #  - one can consider records without an 'id' (see new records);
5104     #  - the global cache is only an index to "resolve" a record 'id'.
5105     #
5106
5107     @classmethod
5108     def _browse(cls, env, ids):
5109         """ Create an instance attached to `env`; `ids` is a tuple of record
5110             ids.
5111         """
5112         records = object.__new__(cls)
5113         records.env = env
5114         records._ids = ids
5115         env.prefetch[cls._name].update(ids)
5116         return records
5117
5118     @api.v7
5119     def browse(self, cr, uid, arg=None, context=None):
5120         ids = _normalize_ids(arg)
5121         #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5122         return self._browse(Environment(cr, uid, context or {}), ids)
5123
5124     @api.v8
5125     def browse(self, arg=None):
5126         """ browse([ids]) -> records
5127
5128         Returns a recordset for the ids provided as parameter in the current
5129         environment.
5130
5131         Can take no ids, a single id or a sequence of ids.
5132         """
5133         ids = _normalize_ids(arg)
5134         #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5135         return self._browse(self.env, ids)
5136
5137     #
5138     # Internal properties, for manipulating the instance's implementation
5139     #
5140
5141     @property
5142     def ids(self):
5143         """ List of actual record ids in this recordset (ignores placeholder
5144         ids for records to create)
5145         """
5146         return filter(None, list(self._ids))
5147
5148     # backward-compatibility with former browse records
5149     _cr = property(lambda self: self.env.cr)
5150     _uid = property(lambda self: self.env.uid)
5151     _context = property(lambda self: self.env.context)
5152
5153     #
5154     # Conversion methods
5155     #
5156
5157     def ensure_one(self):
5158         """ Verifies that the current recorset holds a single record. Raises
5159         an exception otherwise.
5160         """
5161         if len(self) == 1:
5162             return self
5163         raise except_orm("ValueError", "Expected singleton: %s" % self)
5164
5165     def with_env(self, env):
5166         """ Returns a new version of this recordset attached to the provided
5167         environment
5168
5169         :type env: :class:`~openerp.api.Environment`
5170         """
5171         return self._browse(env, self._ids)
5172
5173     def sudo(self, user=SUPERUSER_ID):
5174         """ sudo([user=SUPERUSER])
5175
5176         Returns a new version of this recordset attached to the provided
5177         user.
5178         """
5179         return self.with_env(self.env(user=user))
5180
5181     def with_context(self, *args, **kwargs):
5182         """ with_context([context][, **overrides]) -> records
5183
5184         Returns a new version of this recordset attached to an extended
5185         context.
5186
5187         The extended context is either the provided ``context`` in which
5188         ``overrides`` are merged or the *current* context in which
5189         ``overrides`` are merged e.g.::
5190
5191             # current context is {'key1': True}
5192             r2 = records.with_context({}, key2=True)
5193             # -> r2._context is {'key2': True}
5194             r2 = records.with_context(key2=True)
5195             # -> r2._context is {'key1': True, 'key2': True}
5196         """
5197         context = dict(args[0] if args else self._context, **kwargs)
5198         return self.with_env(self.env(context=context))
5199
5200     def _convert_to_cache(self, values, update=False, validate=True):
5201         """ Convert the `values` dictionary into cached values.
5202
5203             :param update: whether the conversion is made for updating `self`;
5204                 this is necessary for interpreting the commands of *2many fields
5205             :param validate: whether values must be checked
5206         """
5207         fields = self._fields
5208         target = self if update else self.browse()
5209         return {
5210             name: fields[name].convert_to_cache(value, target, validate=validate)
5211             for name, value in values.iteritems()
5212             if name in fields
5213         }
5214
5215     def _convert_to_write(self, values):
5216         """ Convert the `values` dictionary into the format of :meth:`write`. """
5217         fields = self._fields
5218         result = {}
5219         for name, value in values.iteritems():
5220             if name in fields:
5221                 value = fields[name].convert_to_write(value)
5222                 if not isinstance(value, NewId):
5223                     result[name] = value
5224         return result
5225
5226     #
5227     # Record traversal and update
5228     #
5229
5230     def _mapped_func(self, func):
5231         """ Apply function `func` on all records in `self`, and return the
5232             result as a list or a recordset (if `func` return recordsets).
5233         """
5234         vals = [func(rec) for rec in self]
5235         val0 = vals[0] if vals else func(self)
5236         if isinstance(val0, BaseModel):
5237             return reduce(operator.or_, vals, val0)
5238         return vals
5239
5240     def mapped(self, func):
5241         """ Apply `func` on all records in `self`, and return the result as a
5242             list or a recordset (if `func` return recordsets). In the latter
5243             case, the order of the returned recordset is arbritrary.
5244
5245             :param func: a function or a dot-separated sequence of field names
5246         """
5247         if isinstance(func, basestring):
5248             recs = self
5249             for name in func.split('.'):
5250                 recs = recs._mapped_func(operator.itemgetter(name))
5251             return recs
5252         else:
5253             return self._mapped_func(func)
5254
5255     def _mapped_cache(self, name_seq):
5256         """ Same as `~.mapped`, but `name_seq` is a dot-separated sequence of
5257             field names, and only cached values are used.
5258         """
5259         recs = self
5260         for name in name_seq.split('.'):
5261             field = recs._fields[name]
5262             null = field.null(self.env)
5263             recs = recs.mapped(lambda rec: rec._cache.get(field, null))
5264         return recs
5265
5266     def filtered(self, func):
5267         """ Select the records in `self` such that `func(rec)` is true, and
5268             return them as a recordset.
5269
5270             :param func: a function or a dot-separated sequence of field names
5271         """
5272         if isinstance(func, basestring):
5273             name = func
5274             func = lambda rec: filter(None, rec.mapped(name))
5275         return self.browse([rec.id for rec in self if func(rec)])
5276
5277     def sorted(self, key=None):
5278         """ Return the recordset `self` ordered by `key` """
5279         if key is None:
5280             return self.search([('id', 'in', self.ids)])
5281         else:
5282             return self.browse(map(int, sorted(self, key=key)))
5283
5284     def update(self, values):
5285         """ Update record `self[0]` with `values`. """
5286         for name, value in values.iteritems():
5287             self[name] = value
5288
5289     #
5290     # New records - represent records that do not exist in the database yet;
5291     # they are used to perform onchanges.
5292     #
5293
5294     @api.model
5295     def new(self, values={}):
5296         """ new([values]) -> record
5297
5298         Return a new record instance attached to the current environment and
5299         initialized with the provided ``value``. The record is *not* created
5300         in database, it only exists in memory.
5301         """
5302         record = self.browse([NewId()])
5303         record._cache.update(record._convert_to_cache(values, update=True))
5304
5305         if record.env.in_onchange:
5306             # The cache update does not set inverse fields, so do it manually.
5307             # This is useful for computing a function field on secondary
5308             # records, if that field depends on the main record.
5309             for name in values:
5310                 field = self._fields.get(name)
5311                 if field:
5312                     for invf in field.inverse_fields:
5313                         invf._update(record[name], record)
5314
5315         return record
5316
5317     #
5318     # Dirty flag, to mark records modified (in draft mode)
5319     #
5320
5321     @property
5322     def _dirty(self):
5323         """ Return whether any record in `self` is dirty. """
5324         dirty = self.env.dirty
5325         return any(record in dirty for record in self)
5326
5327     @_dirty.setter
5328     def _dirty(self, value):
5329         """ Mark the records in `self` as dirty. """
5330         if value:
5331             map(self.env.dirty.add, self)
5332         else:
5333             map(self.env.dirty.discard, self)
5334
5335     #
5336     # "Dunder" methods
5337     #
5338
5339     def __nonzero__(self):
5340         """ Test whether `self` is nonempty. """
5341         return bool(getattr(self, '_ids', True))
5342
5343     def __len__(self):
5344         """ Return the size of `self`. """
5345         return len(self._ids)
5346
5347     def __iter__(self):
5348         """ Return an iterator over `self`. """
5349         for id in self._ids:
5350             yield self._browse(self.env, (id,))
5351
5352     def __contains__(self, item):
5353         """ Test whether `item` (record or field name) is an element of `self`.
5354             In the first case, the test is fully equivalent to::
5355
5356                 any(item == record for record in self)
5357         """
5358         if isinstance(item, BaseModel) and self._name == item._name:
5359             return len(item) == 1 and item.id in self._ids
5360         elif isinstance(item, basestring):
5361             return item in self._fields
5362         else:
5363             raise except_orm("ValueError", "Mixing apples and oranges: %s in %s" % (item, self))
5364
5365     def __add__(self, other):
5366         """ Return the concatenation of two recordsets. """
5367         if not isinstance(other, BaseModel) or self._name != other._name:
5368             raise except_orm("ValueError", "Mixing apples and oranges: %s + %s" % (self, other))
5369         return self.browse(self._ids + other._ids)
5370
5371     def __sub__(self, other):
5372         """ Return the recordset of all the records in `self` that are not in `other`. """
5373         if not isinstance(other, BaseModel) or self._name != other._name:
5374             raise except_orm("ValueError", "Mixing apples and oranges: %s - %s" % (self, other))
5375         other_ids = set(other._ids)
5376         return self.browse([id for id in self._ids if id not in other_ids])
5377
5378     def __and__(self, other):
5379         """ Return the intersection of two recordsets.
5380             Note that recordset order is not preserved.
5381         """
5382         if not isinstance(other, BaseModel) or self._name != other._name:
5383             raise except_orm("ValueError", "Mixing apples and oranges: %s & %s" % (self, other))
5384         return self.browse(set(self._ids) & set(other._ids))
5385
5386     def __or__(self, other):
5387         """ Return the union of two recordsets.
5388             Note that recordset order is not preserved.
5389         """
5390         if not isinstance(other, BaseModel) or self._name != other._name:
5391             raise except_orm("ValueError", "Mixing apples and oranges: %s | %s" % (self, other))
5392         return self.browse(set(self._ids) | set(other._ids))
5393
5394     def __eq__(self, other):
5395         """ Test whether two recordsets are equivalent (up to reordering). """
5396         if not isinstance(other, BaseModel):
5397             if other:
5398                 _logger.warning("Comparing apples and oranges: %s == %s", self, other)
5399             return False
5400         return self._name == other._name and set(self._ids) == set(other._ids)
5401
5402     def __ne__(self, other):
5403         return not self == other
5404
5405     def __lt__(self, other):
5406         if not isinstance(other, BaseModel) or self._name != other._name:
5407             raise except_orm("ValueError", "Mixing apples and oranges: %s < %s" % (self, other))
5408         return set(self._ids) < set(other._ids)
5409
5410     def __le__(self, other):
5411         if not isinstance(other, BaseModel) or self._name != other._name:
5412             raise except_orm("ValueError", "Mixing apples and oranges: %s <= %s" % (self, other))
5413         return set(self._ids) <= set(other._ids)
5414
5415     def __gt__(self, other):
5416         if not isinstance(other, BaseModel) or self._name != other._name:
5417             raise except_orm("ValueError", "Mixing apples and oranges: %s > %s" % (self, other))
5418         return set(self._ids) > set(other._ids)
5419
5420     def __ge__(self, other):
5421         if not isinstance(other, BaseModel) or self._name != other._name:
5422             raise except_orm("ValueError", "Mixing apples and oranges: %s >= %s" % (self, other))
5423         return set(self._ids) >= set(other._ids)
5424
5425     def __int__(self):
5426         return self.id
5427
5428     def __str__(self):
5429         return "%s%s" % (self._name, getattr(self, '_ids', ""))
5430
5431     def __unicode__(self):
5432         return unicode(str(self))
5433
5434     __repr__ = __str__
5435
5436     def __hash__(self):
5437         if hasattr(self, '_ids'):
5438             return hash((self._name, frozenset(self._ids)))
5439         else:
5440             return hash(self._name)
5441
5442     def __getitem__(self, key):
5443         """ If `key` is an integer or a slice, return the corresponding record
5444             selection as an instance (attached to `self.env`).
5445             Otherwise read the field `key` of the first record in `self`.
5446
5447             Examples::
5448
5449                 inst = model.search(dom)    # inst is a recordset
5450                 r4 = inst[3]                # fourth record in inst
5451                 rs = inst[10:20]            # subset of inst
5452                 nm = rs['name']             # name of first record in inst
5453         """
5454         if isinstance(key, basestring):
5455             # important: one must call the field's getter
5456             return self._fields[key].__get__(self, type(self))
5457         elif isinstance(key, slice):
5458             return self._browse(self.env, self._ids[key])
5459         else:
5460             return self._browse(self.env, (self._ids[key],))
5461
5462     def __setitem__(self, key, value):
5463         """ Assign the field `key` to `value` in record `self`. """
5464         # important: one must call the field's setter
5465         return self._fields[key].__set__(self, value)
5466
5467     #
5468     # Cache and recomputation management
5469     #
5470
5471     @lazy_property
5472     def _cache(self):
5473         """ Return the cache of `self`, mapping field names to values. """
5474         return RecordCache(self)
5475
5476     @api.model
5477     def _in_cache_without(self, field):
5478         """ Make sure `self` is present in cache (for prefetching), and return
5479             the records of model `self` in cache that have no value for `field`
5480             (:class:`Field` instance).
5481         """
5482         env = self.env
5483         prefetch_ids = env.prefetch[self._name]
5484         prefetch_ids.update(self._ids)
5485         ids = filter(None, prefetch_ids - set(env.cache[field]))
5486         return self.browse(ids)
5487
5488     @api.model
5489     def refresh(self):
5490         """ Clear the records cache.
5491
5492             .. deprecated:: 8.0
5493                 The record cache is automatically invalidated.
5494         """
5495         self.invalidate_cache()
5496
5497     @api.model
5498     def invalidate_cache(self, fnames=None, ids=None):
5499         """ Invalidate the record caches after some records have been modified.
5500             If both `fnames` and `ids` are ``None``, the whole cache is cleared.
5501
5502             :param fnames: the list of modified fields, or ``None`` for all fields
5503             :param ids: the list of modified record ids, or ``None`` for all
5504         """
5505         if fnames is None:
5506             if ids is None:
5507                 return self.env.invalidate_all()
5508             fields = self._fields.values()
5509         else:
5510             fields = map(self._fields.__getitem__, fnames)
5511
5512         # invalidate fields and inverse fields, too
5513         spec = [(f, ids) for f in fields] + \
5514                [(invf, None) for f in fields for invf in f.inverse_fields]
5515         self.env.invalidate(spec)
5516
5517     @api.multi
5518     def modified(self, fnames):
5519         """ Notify that fields have been modified on `self`. This invalidates
5520             the cache, and prepares the recomputation of stored function fields
5521             (new-style fields only).
5522
5523             :param fnames: iterable of field names that have been modified on
5524                 records `self`
5525         """
5526         # each field knows what to invalidate and recompute
5527         spec = []
5528         for fname in fnames:
5529             spec += self._fields[fname].modified(self)
5530
5531         cached_fields = {
5532             field
5533             for env in self.env.all
5534             for field in env.cache
5535         }
5536         # invalidate non-stored fields.function which are currently cached
5537         spec += [(f, None) for f in self.pool.pure_function_fields
5538                  if f in cached_fields]
5539
5540         self.env.invalidate(spec)
5541
5542     def _recompute_check(self, field):
5543         """ If `field` must be recomputed on some record in `self`, return the
5544             corresponding records that must be recomputed.
5545         """
5546         return self.env.check_todo(field, self)
5547
5548     def _recompute_todo(self, field):
5549         """ Mark `field` to be recomputed. """
5550         self.env.add_todo(field, self)
5551
5552     def _recompute_done(self, field):
5553         """ Mark `field` as recomputed. """
5554         self.env.remove_todo(field, self)
5555
5556     @api.model
5557     def recompute(self):
5558         """ Recompute stored function fields. The fields and records to
5559             recompute have been determined by method :meth:`modified`.
5560         """
5561         while self.env.has_todo():
5562             field, recs = self.env.get_todo()
5563             # evaluate the fields to recompute, and save them to database
5564             for rec, rec1 in zip(recs, recs.with_context(recompute=False)):
5565                 try:
5566                     values = rec._convert_to_write({
5567                         f.name: rec[f.name] for f in field.computed_fields
5568                     })
5569                     rec1._write(values)
5570                 except MissingError:
5571                     pass
5572             # mark the computed fields as done
5573             map(recs._recompute_done, field.computed_fields)
5574
5575     #
5576     # Generic onchange method
5577     #
5578
5579     def _has_onchange(self, field, other_fields):
5580         """ Return whether `field` should trigger an onchange event in the
5581             presence of `other_fields`.
5582         """
5583         # test whether self has an onchange method for field, or field is a
5584         # dependency of any field in other_fields
5585         return field.name in self._onchange_methods or \
5586             any(dep in other_fields for dep in field.dependents)
5587
5588     @api.model
5589     def _onchange_spec(self, view_info=None):
5590         """ Return the onchange spec from a view description; if not given, the
5591             result of ``self.fields_view_get()`` is used.
5592         """
5593         result = {}
5594
5595         # for traversing the XML arch and populating result
5596         def process(node, info, prefix):
5597             if node.tag == 'field':
5598                 name = node.attrib['name']
5599                 names = "%s.%s" % (prefix, name) if prefix else name
5600                 if not result.get(names):
5601                     result[names] = node.attrib.get('on_change')
5602                 # traverse the subviews included in relational fields
5603                 for subinfo in info['fields'][name].get('views', {}).itervalues():
5604                     process(etree.fromstring(subinfo['arch']), subinfo, names)
5605             else:
5606                 for child in node:
5607                     process(child, info, prefix)
5608
5609         if view_info is None:
5610             view_info = self.fields_view_get()
5611         process(etree.fromstring(view_info['arch']), view_info, '')
5612         return result
5613
5614     def _onchange_eval(self, field_name, onchange, result):
5615         """ Apply onchange method(s) for field `field_name` with spec `onchange`
5616             on record `self`. Value assignments are applied on `self`, while
5617             domain and warning messages are put in dictionary `result`.
5618         """
5619         onchange = onchange.strip()
5620
5621         # onchange V8
5622         if onchange in ("1", "true"):
5623             for method in self._onchange_methods.get(field_name, ()):
5624                 method_res = method(self)
5625                 if not method_res:
5626                     continue
5627                 if 'domain' in method_res:
5628                     result.setdefault('domain', {}).update(method_res['domain'])
5629                 if 'warning' in method_res:
5630                     result['warning'] = method_res['warning']
5631             return
5632
5633         # onchange V7
5634         match = onchange_v7.match(onchange)
5635         if match:
5636             method, params = match.groups()
5637
5638             # evaluate params -> tuple
5639             global_vars = {'context': self._context, 'uid': self._uid}
5640             if self._context.get('field_parent'):
5641                 class RawRecord(object):
5642                     def __init__(self, record):
5643                         self._record = record
5644                     def __getattr__(self, name):
5645                         field = self._record._fields[name]
5646                         value = self._record[name]
5647                         return field.convert_to_onchange(value)
5648                 record = self[self._context['field_parent']]
5649                 global_vars['parent'] = RawRecord(record)
5650             field_vars = {
5651                 key: self._fields[key].convert_to_onchange(val)
5652                 for key, val in self._cache.iteritems()
5653             }
5654             params = eval("[%s]" % params, global_vars, field_vars)
5655
5656             # call onchange method
5657             args = (self._cr, self._uid, self._origin.ids) + tuple(params)
5658             method_res = getattr(self._model, method)(*args)
5659             if not isinstance(method_res, dict):
5660                 return
5661             if 'value' in method_res:
5662                 method_res['value'].pop('id', None)
5663                 self.update(self._convert_to_cache(method_res['value'], validate=False))
5664             if 'domain' in method_res:
5665                 result.setdefault('domain', {}).update(method_res['domain'])
5666             if 'warning' in method_res:
5667                 result['warning'] = method_res['warning']
5668
5669     @api.multi
5670     def onchange(self, values, field_name, field_onchange):
5671         """ Perform an onchange on the given field.
5672
5673             :param values: dictionary mapping field names to values, giving the
5674                 current state of modification
5675             :param field_name: name of the modified field_name
5676             :param field_onchange: dictionary mapping field names to their
5677                 on_change attribute
5678         """
5679         env = self.env
5680
5681         if field_name and field_name not in self._fields:
5682             return {}
5683
5684         # determine subfields for field.convert_to_write() below
5685         secondary = []
5686         subfields = defaultdict(set)
5687         for dotname in field_onchange:
5688             if '.' in dotname:
5689                 secondary.append(dotname)
5690                 name, subname = dotname.split('.')
5691                 subfields[name].add(subname)
5692
5693         # create a new record with values, and attach `self` to it
5694         with env.do_in_onchange():
5695             record = self.new(values)
5696             values = dict(record._cache)
5697             # attach `self` with a different context (for cache consistency)
5698             record._origin = self.with_context(__onchange=True)
5699
5700         # determine which field should be triggered an onchange
5701         todo = set([field_name]) if field_name else set(values)
5702         done = set()
5703
5704         # dummy assignment: trigger invalidations on the record
5705         for name in todo:
5706             value = record[name]
5707             field = self._fields[name]
5708             if not field_name and field.type == 'many2one' and field.delegate and not value:
5709                 # do not nullify all fields of parent record for new records
5710                 continue
5711             record[name] = value
5712
5713         result = {'value': {}}
5714
5715         while todo:
5716             name = todo.pop()
5717             if name in done:
5718                 continue
5719             done.add(name)
5720
5721             with env.do_in_onchange():
5722                 # apply field-specific onchange methods
5723                 if field_onchange.get(name):
5724                     record._onchange_eval(name, field_onchange[name], result)
5725
5726                 # force re-evaluation of function fields on secondary records
5727                 for field_seq in secondary:
5728                     record.mapped(field_seq)
5729
5730                 # determine which fields have been modified
5731                 for name, oldval in values.iteritems():
5732                     field = self._fields[name]
5733                     newval = record[name]
5734                     if field.type in ('one2many', 'many2many'):
5735                         if newval != oldval or newval._dirty:
5736                             # put new value in result
5737                             result['value'][name] = field.convert_to_write(
5738                                 newval, record._origin, subfields.get(name),
5739                             )
5740                             todo.add(name)
5741                         else:
5742                             # keep result: newval may have been dirty before
5743                             pass
5744                     else:
5745                         if newval != oldval:
5746                             # put new value in result
5747                             result['value'][name] = field.convert_to_write(
5748                                 newval, record._origin, subfields.get(name),
5749                             )
5750                             todo.add(name)
5751                         else:
5752                             # clean up result to not return another value
5753                             result['value'].pop(name, None)
5754
5755         # At the moment, the client does not support updates on a *2many field
5756         # while this one is modified by the user.
5757         if field_name and self._fields[field_name].type in ('one2many', 'many2many'):
5758             result['value'].pop(field_name, None)
5759
5760         return result
5761
5762
5763 class RecordCache(MutableMapping):
5764     """ Implements a proxy dictionary to read/update the cache of a record.
5765         Upon iteration, it looks like a dictionary mapping field names to
5766         values. However, fields may be used as keys as well.
5767     """
5768     def __init__(self, records):
5769         self._recs = records
5770
5771     def contains(self, field):
5772         """ Return whether `records[0]` has a value for `field` in cache. """
5773         if isinstance(field, basestring):
5774             field = self._recs._fields[field]
5775         return self._recs.id in self._recs.env.cache[field]
5776
5777     def __contains__(self, field):
5778         """ Return whether `records[0]` has a regular value for `field` in cache. """
5779         if isinstance(field, basestring):
5780             field = self._recs._fields[field]
5781         dummy = SpecialValue(None)
5782         value = self._recs.env.cache[field].get(self._recs.id, dummy)
5783         return not isinstance(value, SpecialValue)
5784
5785     def __getitem__(self, field):
5786         """ Return the cached value of `field` for `records[0]`. """
5787         if isinstance(field, basestring):
5788             field = self._recs._fields[field]
5789         value = self._recs.env.cache[field][self._recs.id]
5790         return value.get() if isinstance(value, SpecialValue) else value
5791
5792     def __setitem__(self, field, value):
5793         """ Assign the cached value of `field` for all records in `records`. """
5794         if isinstance(field, basestring):
5795             field = self._recs._fields[field]
5796         values = dict.fromkeys(self._recs._ids, value)
5797         self._recs.env.cache[field].update(values)
5798
5799     def update(self, *args, **kwargs):
5800         """ Update the cache of all records in `records`. If the argument is a
5801             `SpecialValue`, update all fields (except "magic" columns).
5802         """
5803         if args and isinstance(args[0], SpecialValue):
5804             values = dict.fromkeys(self._recs._ids, args[0])
5805             for name, field in self._recs._fields.iteritems():
5806                 if name != 'id':
5807                     self._recs.env.cache[field].update(values)
5808         else:
5809             return super(RecordCache, self).update(*args, **kwargs)
5810
5811     def __delitem__(self, field):
5812         """ Remove the cached value of `field` for all `records`. """
5813         if isinstance(field, basestring):
5814             field = self._recs._fields[field]
5815         field_cache = self._recs.env.cache[field]
5816         for id in self._recs._ids:
5817             field_cache.pop(id, None)
5818
5819     def __iter__(self):
5820         """ Iterate over the field names with a regular value in cache. """
5821         cache, id = self._recs.env.cache, self._recs.id
5822         dummy = SpecialValue(None)
5823         for name, field in self._recs._fields.iteritems():
5824             if name != 'id' and not isinstance(cache[field].get(id, dummy), SpecialValue):
5825                 yield name
5826
5827     def __len__(self):
5828         """ Return the number of fields with a regular value in cache. """
5829         return sum(1 for name in self)
5830
5831 class Model(BaseModel):
5832     """Main super-class for regular database-persisted OpenERP models.
5833
5834     OpenERP models are created by inheriting from this class::
5835
5836         class user(Model):
5837             ...
5838
5839     The system will later instantiate the class once per database (on
5840     which the class' module is installed).
5841     """
5842     _auto = True
5843     _register = False # not visible in ORM registry, meant to be python-inherited only
5844     _transient = False # True in a TransientModel
5845
5846 class TransientModel(BaseModel):
5847     """Model super-class for transient records, meant to be temporarily
5848        persisted, and regularly vaccuum-cleaned.
5849
5850        A TransientModel has a simplified access rights management,
5851        all users can create new records, and may only access the
5852        records they created. The super-user has unrestricted access
5853        to all TransientModel records.
5854     """
5855     _auto = True
5856     _register = False # not visible in ORM registry, meant to be python-inherited only
5857     _transient = True
5858
5859 class AbstractModel(BaseModel):
5860     """Abstract Model super-class for creating an abstract class meant to be
5861        inherited by regular models (Models or TransientModels) but not meant to
5862        be usable on its own, or persisted.
5863
5864        Technical note: we don't want to make AbstractModel the super-class of
5865        Model or BaseModel because it would not make sense to put the main
5866        definition of persistence methods such as create() in it, and still we
5867        should be able to override them within an AbstractModel.
5868        """
5869     _auto = False # don't create any database backend for AbstractModels
5870     _register = False # not visible in ORM registry, meant to be python-inherited only
5871     _transient = False
5872
5873 def itemgetter_tuple(items):
5874     """ Fixes itemgetter inconsistency (useful in some cases) of not returning
5875     a tuple if len(items) == 1: always returns an n-tuple where n = len(items)
5876     """
5877     if len(items) == 0:
5878         return lambda a: ()
5879     if len(items) == 1:
5880         return lambda gettable: (gettable[items[0]],)
5881     return operator.itemgetter(*items)
5882
5883 def convert_pgerror_23502(model, fields, info, e):
5884     m = re.match(r'^null value in column "(?P<field>\w+)" violates '
5885                  r'not-null constraint\n',
5886                  str(e))
5887     field_name = m and m.group('field')
5888     if not m or field_name not in fields:
5889         return {'message': unicode(e)}
5890     message = _(u"Missing required value for the field '%s'.") % field_name
5891     field = fields.get(field_name)
5892     if field:
5893         message = _(u"Missing required value for the field '%s' (%s)") % (field['string'], field_name)
5894     return {
5895         'message': message,
5896         'field': field_name,
5897     }
5898
5899 def convert_pgerror_23505(model, fields, info, e):
5900     m = re.match(r'^duplicate key (?P<field>\w+) violates unique constraint',
5901                  str(e))
5902     field_name = m and m.group('field')
5903     if not m or field_name not in fields:
5904         return {'message': unicode(e)}
5905     message = _(u"The value for the field '%s' already exists.") % field_name
5906     field = fields.get(field_name)
5907     if field:
5908         message = _(u"%s This might be '%s' in the current model, or a field "
5909                     u"of the same name in an o2m.") % (message, field['string'])
5910     return {
5911         'message': message,
5912         'field': field_name,
5913     }
5914
5915 PGERROR_TO_OE = defaultdict(
5916     # shape of mapped converters
5917     lambda: (lambda model, fvg, info, pgerror: {'message': unicode(pgerror)}), {
5918     # not_null_violation
5919     '23502': convert_pgerror_23502,
5920     # unique constraint error
5921     '23505': convert_pgerror_23505,
5922 })
5923
5924 def _normalize_ids(arg, atoms={int, long, str, unicode, NewId}):
5925     """ Normalizes the ids argument for ``browse`` (v7 and v8) to a tuple.
5926
5927     Various implementations were tested on the corpus of all browse() calls
5928     performed during a full crawler run (after having installed all website_*
5929     modules) and this one was the most efficient overall.
5930
5931     A possible bit of correctness was sacrificed by not doing any test on
5932     Iterable and just assuming that any non-atomic type was an iterable of
5933     some kind.
5934
5935     :rtype: tuple
5936     """
5937     # much of the corpus is falsy objects (empty list, tuple or set, None)
5938     if not arg:
5939         return ()
5940
5941     # `type in set` is significantly faster (because more restrictive) than
5942     # isinstance(arg, set) or issubclass(type, set); and for new-style classes
5943     # obj.__class__ is equivalent to but faster than type(obj). Not relevant
5944     # (and looks much worse) in most cases, but over millions of calls it
5945     # does have a very minor effect.
5946     if arg.__class__ in atoms:
5947         return arg,
5948
5949     return tuple(arg)
5950
5951 # keep those imports here to avoid dependency cycle errors
5952 from .osv import expression
5953 from .fields import Field, SpecialValue, FailedValue
5954
5955 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: