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