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