openerp/models.py

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