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