openerp/models.py

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