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