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