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     def _check_selection_field_value(self, cr, uid, field, value, context=None):
2275         """Raise except_orm if value is not among the valid values for the selection field"""
2276         if self._columns[field]._type == 'reference':
2277             val_model, val_id_str = value.split(',', 1)
2278             val_id = False
2279             try:
2280                 val_id = long(val_id_str)
2281             except ValueError:
2282                 pass
2283             if not val_id:
2284                 raise except_orm(_('ValidateError'),
2285                                  _('Invalid value for reference field "%s.%s" (last part must be a non-zero integer): "%s"') % (self._table, field, value))
2286             val = val_model
2287         else:
2288             val = value
2289         if isinstance(self._columns[field].selection, (tuple, list)):
2290             if val in dict(self._columns[field].selection):
2291                 return
2292         elif val in dict(self._columns[field].selection(self, cr, uid, context=context)):
2293             return
2294         raise except_orm(_('ValidateError'),
2295                          _('The value "%s" for the field "%s.%s" is not in the selection') % (value, self._name, field))
2296
2297     def _check_removed_columns(self, cr, log=False):
2298         # iterate on the database columns to drop the NOT NULL constraints
2299         # of fields which were required but have been removed (or will be added by another module)
2300         columns = [c for c in self._columns if not (isinstance(self._columns[c], fields.function) and not self._columns[c].store)]
2301         columns += MAGIC_COLUMNS
2302         cr.execute("SELECT a.attname, a.attnotnull"
2303                    "  FROM pg_class c, pg_attribute a"
2304                    " WHERE c.relname=%s"
2305                    "   AND c.oid=a.attrelid"
2306                    "   AND a.attisdropped=%s"
2307                    "   AND pg_catalog.format_type(a.atttypid, a.atttypmod) NOT IN ('cid', 'tid', 'oid', 'xid')"
2308                    "   AND a.attname NOT IN %s", (self._table, False, tuple(columns))),
2309
2310         for column in cr.dictfetchall():
2311             if log:
2312                 _logger.debug("column %s is in the table %s but not in the corresponding object %s",
2313                               column['attname'], self._table, self._name)
2314             if column['attnotnull']:
2315                 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, column['attname']))
2316                 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2317                               self._table, column['attname'])
2318
2319     def _save_constraint(self, cr, constraint_name, type):
2320         """
2321         Record the creation of a constraint for this model, to make it possible
2322         to delete it later when the module is uninstalled. Type can be either
2323         'f' or 'u' depending on the constraint being a foreign key or not.
2324         """
2325         if not self._module:
2326             # no need to save constraints for custom models as they're not part
2327             # of any module
2328             return
2329         assert type in ('f', 'u')
2330         cr.execute("""
2331             SELECT 1 FROM ir_model_constraint, ir_module_module
2332             WHERE ir_model_constraint.module=ir_module_module.id
2333                 AND ir_model_constraint.name=%s
2334                 AND ir_module_module.name=%s
2335             """, (constraint_name, self._module))
2336         if not cr.rowcount:
2337             cr.execute("""
2338                 INSERT INTO ir_model_constraint
2339                     (name, date_init, date_update, module, model, type)
2340                 VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2341                     (SELECT id FROM ir_module_module WHERE name=%s),
2342                     (SELECT id FROM ir_model WHERE model=%s), %s)""",
2343                     (constraint_name, self._module, self._name, type))
2344
2345     def _save_relation_table(self, cr, relation_table):
2346         """
2347         Record the creation of a many2many for this model, to make it possible
2348         to delete it later when the module is uninstalled.
2349         """
2350         cr.execute("""
2351             SELECT 1 FROM ir_model_relation, ir_module_module
2352             WHERE ir_model_relation.module=ir_module_module.id
2353                 AND ir_model_relation.name=%s
2354                 AND ir_module_module.name=%s
2355             """, (relation_table, self._module))
2356         if not cr.rowcount:
2357             cr.execute("""INSERT INTO ir_model_relation (name, date_init, date_update, module, model)
2358                                  VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2359                     (SELECT id FROM ir_module_module WHERE name=%s),
2360                     (SELECT id FROM ir_model WHERE model=%s))""",
2361                        (relation_table, self._module, self._name))
2362             self.invalidate_cache(cr, SUPERUSER_ID)
2363
2364     # checked version: for direct m2o starting from `self`
2365     def _m2o_add_foreign_key_checked(self, source_field, dest_model, ondelete):
2366         assert self.is_transient() or not dest_model.is_transient(), \
2367             'Many2One relationships from non-transient Model to TransientModel are forbidden'
2368         if self.is_transient() and not dest_model.is_transient():
2369             # TransientModel relationships to regular Models are annoying
2370             # usually because they could block deletion due to the FKs.
2371             # So unless stated otherwise we default them to ondelete=cascade.
2372             ondelete = ondelete or 'cascade'
2373         fk_def = (self._table, source_field, dest_model._table, ondelete or 'set null')
2374         self._foreign_keys.add(fk_def)
2375         _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2376
2377     # unchecked version: for custom cases, such as m2m relationships
2378     def _m2o_add_foreign_key_unchecked(self, source_table, source_field, dest_model, ondelete):
2379         fk_def = (source_table, source_field, dest_model._table, ondelete or 'set null')
2380         self._foreign_keys.add(fk_def)
2381         _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2382
2383     def _drop_constraint(self, cr, source_table, constraint_name):
2384         cr.execute("ALTER TABLE %s DROP CONSTRAINT %s" % (source_table,constraint_name))
2385
2386     def _m2o_fix_foreign_key(self, cr, source_table, source_field, dest_model, ondelete):
2387         # Find FK constraint(s) currently established for the m2o field,
2388         # and see whether they are stale or not
2389         cr.execute("""SELECT confdeltype as ondelete_rule, conname as constraint_name,
2390                              cl2.relname as foreign_table
2391                       FROM pg_constraint as con, pg_class as cl1, pg_class as cl2,
2392                            pg_attribute as att1, pg_attribute as att2
2393                       WHERE con.conrelid = cl1.oid
2394                         AND cl1.relname = %s
2395                         AND con.confrelid = cl2.oid
2396                         AND array_lower(con.conkey, 1) = 1
2397                         AND con.conkey[1] = att1.attnum
2398                         AND att1.attrelid = cl1.oid
2399                         AND att1.attname = %s
2400                         AND array_lower(con.confkey, 1) = 1
2401                         AND con.confkey[1] = att2.attnum
2402                         AND att2.attrelid = cl2.oid
2403                         AND att2.attname = %s
2404                         AND con.contype = 'f'""", (source_table, source_field, 'id'))
2405         constraints = cr.dictfetchall()
2406         if constraints:
2407             if len(constraints) == 1:
2408                 # Is it the right constraint?
2409                 cons, = constraints
2410                 if cons['ondelete_rule'] != POSTGRES_CONFDELTYPES.get((ondelete or 'set null').upper(), 'a')\
2411                     or cons['foreign_table'] != dest_model._table:
2412                     # Wrong FK: drop it and recreate
2413                     _schema.debug("Table '%s': dropping obsolete FK constraint: '%s'",
2414                                   source_table, cons['constraint_name'])
2415                     self._drop_constraint(cr, source_table, cons['constraint_name'])
2416                 else:
2417                     # it's all good, nothing to do!
2418                     return
2419             else:
2420                 # Multiple FKs found for the same field, drop them all, and re-create
2421                 for cons in constraints:
2422                     _schema.debug("Table '%s': dropping duplicate FK constraints: '%s'",
2423                                   source_table, cons['constraint_name'])
2424                     self._drop_constraint(cr, source_table, cons['constraint_name'])
2425
2426         # (re-)create the FK
2427         self._m2o_add_foreign_key_checked(source_field, dest_model, ondelete)
2428
2429
2430     def _set_default_value_on_column(self, cr, column_name, context=None):
2431         # ideally should use add_default_value but fails
2432         # due to ir.values not being ready
2433
2434         # get old-style default
2435         default = self._defaults.get(column_name)
2436         if callable(default):
2437             default = default(self, cr, SUPERUSER_ID, context)
2438
2439         # get new_style default if no old-style
2440         if default is None:
2441             record = self.new(cr, SUPERUSER_ID, context=context)
2442             field = self._fields[column_name]
2443             field.determine_default(record)
2444             defaults = dict(record._cache)
2445             if column_name in defaults:
2446                 default = field.convert_to_write(defaults[column_name])
2447
2448         column = self._columns[column_name]
2449         ss = column._symbol_set
2450         db_default = ss[1](default)
2451         # Write default if non-NULL, except for booleans for which False means
2452         # the same as NULL - this saves us an expensive query on large tables.
2453         write_default = (db_default is not None if column._type != 'boolean'
2454                             else db_default)
2455         if write_default:
2456             _logger.debug("Table '%s': setting default value of new column %s to %r",
2457                           self._table, column_name, default)
2458             query = 'UPDATE "%s" SET "%s"=%s WHERE "%s" is NULL' % (
2459                 self._table, column_name, ss[0], column_name)
2460             cr.execute(query, (db_default,))
2461             # this is a disgrace
2462             cr.commit()
2463
2464     def _auto_init(self, cr, context=None):
2465         """
2466
2467         Call _field_create and, unless _auto is False:
2468
2469         - create the corresponding table in database for the model,
2470         - possibly add the parent columns in database,
2471         - possibly add the columns 'create_uid', 'create_date', 'write_uid',
2472           'write_date' in database if _log_access is True (the default),
2473         - report on database columns no more existing in _columns,
2474         - remove no more existing not null constraints,
2475         - alter existing database columns to match _columns,
2476         - create database tables to match _columns,
2477         - add database indices to match _columns,
2478         - save in self._foreign_keys a list a foreign keys to create (see
2479           _auto_end).
2480
2481         """
2482         self._foreign_keys = set()
2483         raise_on_invalid_object_name(self._name)
2484         if context is None:
2485             context = {}
2486         store_compute = False
2487         stored_fields = []              # new-style stored fields with compute
2488         todo_end = []
2489         update_custom_fields = context.get('update_custom_fields', False)
2490         self._field_create(cr, context=context)
2491         create = not self._table_exist(cr)
2492         if self._auto:
2493
2494             if create:
2495                 self._create_table(cr)
2496                 has_rows = False
2497             else:
2498                 cr.execute('SELECT 1 FROM "%s" LIMIT 1' % self._table)
2499                 has_rows = cr.rowcount
2500
2501             cr.commit()
2502             if self._parent_store:
2503                 if not self._parent_columns_exist(cr):
2504                     self._create_parent_columns(cr)
2505                     store_compute = True
2506
2507             self._check_removed_columns(cr, log=False)
2508
2509             # iterate on the "object columns"
2510             column_data = self._select_column_data(cr)
2511
2512             for k, f in self._columns.iteritems():
2513                 if k == 'id': # FIXME: maybe id should be a regular column?
2514                     continue
2515                 # Don't update custom (also called manual) fields
2516                 if f.manual and not update_custom_fields:
2517                     continue
2518
2519                 if isinstance(f, fields.one2many):
2520                     self._o2m_raise_on_missing_reference(cr, f)
2521
2522                 elif isinstance(f, fields.many2many):
2523                     self._m2m_raise_or_create_relation(cr, f)
2524
2525                 else:
2526                     res = column_data.get(k)
2527
2528                     # The field is not found as-is in database, try if it
2529                     # exists with an old name.
2530                     if not res and hasattr(f, 'oldname'):
2531                         res = column_data.get(f.oldname)
2532                         if res:
2533                             cr.execute('ALTER TABLE "%s" RENAME "%s" TO "%s"' % (self._table, f.oldname, k))
2534                             res['attname'] = k
2535                             column_data[k] = res
2536                             _schema.debug("Table '%s': renamed column '%s' to '%s'",
2537                                 self._table, f.oldname, k)
2538
2539                     # The field already exists in database. Possibly
2540                     # change its type, rename it, drop it or change its
2541                     # constraints.
2542                     if res:
2543                         f_pg_type = res['typname']
2544                         f_pg_size = res['size']
2545                         f_pg_notnull = res['attnotnull']
2546                         if isinstance(f, fields.function) and not f.store and\
2547                                 not getattr(f, 'nodrop', False):
2548                             _logger.info('column %s (%s) converted to a function, removed from table %s',
2549                                          k, f.string, self._table)
2550                             cr.execute('ALTER TABLE "%s" DROP COLUMN "%s" CASCADE' % (self._table, k))
2551                             cr.commit()
2552                             _schema.debug("Table '%s': dropped column '%s' with cascade",
2553                                 self._table, k)
2554                             f_obj_type = None
2555                         else:
2556                             f_obj_type = get_pg_type(f) and get_pg_type(f)[0]
2557
2558                         if f_obj_type:
2559                             ok = False
2560                             casts = [
2561                                 ('text', 'char', pg_varchar(f.size), '::%s' % pg_varchar(f.size)),
2562                                 ('varchar', 'text', 'TEXT', ''),
2563                                 ('int4', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2564                                 ('date', 'datetime', 'TIMESTAMP', '::TIMESTAMP'),
2565                                 ('timestamp', 'date', 'date', '::date'),
2566                                 ('numeric', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2567                                 ('float8', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2568                             ]
2569                             if f_pg_type == 'varchar' and f._type == 'char' and f_pg_size and (f.size is None or f_pg_size < f.size):
2570                                 try:
2571                                     with cr.savepoint():
2572                                         cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" TYPE %s' % (self._table, k, pg_varchar(f.size)))
2573                                 except psycopg2.NotSupportedError:
2574                                     # In place alter table cannot be done because a view is depending of this field.
2575                                     # Do a manual copy. This will drop the view (that will be recreated later)
2576                                     cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO temp_change_size' % (self._table, k))
2577                                     cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, pg_varchar(f.size)))
2578                                     cr.execute('UPDATE "%s" SET "%s"=temp_change_size::%s' % (self._table, k, pg_varchar(f.size)))
2579                                     cr.execute('ALTER TABLE "%s" DROP COLUMN temp_change_size CASCADE' % (self._table,))
2580                                 cr.commit()
2581                                 _schema.debug("Table '%s': column '%s' (type varchar) changed size from %s to %s",
2582                                     self._table, k, f_pg_size or 'unlimited', f.size or 'unlimited')
2583                             for c in casts:
2584                                 if (f_pg_type==c[0]) and (f._type==c[1]):
2585                                     if f_pg_type != f_obj_type:
2586                                         ok = True
2587                                         cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO __temp_type_cast' % (self._table, k))
2588                                         cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, c[2]))
2589                                         cr.execute(('UPDATE "%s" SET "%s"= __temp_type_cast'+c[3]) % (self._table, k))
2590                                         cr.execute('ALTER TABLE "%s" DROP COLUMN  __temp_type_cast CASCADE' % (self._table,))
2591                                         cr.commit()
2592                                         _schema.debug("Table '%s': column '%s' changed type from %s to %s",
2593                                             self._table, k, c[0], c[1])
2594                                     break
2595
2596                             if f_pg_type != f_obj_type:
2597                                 if not ok:
2598                                     i = 0
2599                                     while True:
2600                                         newname = k + '_moved' + str(i)
2601                                         cr.execute("SELECT count(1) FROM pg_class c,pg_attribute a " \
2602                                             "WHERE c.relname=%s " \
2603                                             "AND a.attname=%s " \
2604                                             "AND c.oid=a.attrelid ", (self._table, newname))
2605                                         if not cr.fetchone()[0]:
2606                                             break
2607                                         i += 1
2608                                     if f_pg_notnull:
2609                                         cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2610                                     cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO "%s"' % (self._table, k, newname))
2611                                     cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2612                                     cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2613                                     _schema.debug("Table '%s': column '%s' has changed type (DB=%s, def=%s), data moved to column %s !",
2614                                         self._table, k, f_pg_type, f._type, newname)
2615
2616                             # if the field is required and hasn't got a NOT NULL constraint
2617                             if f.required and f_pg_notnull == 0:
2618                                 if has_rows:
2619                                     self._set_default_value_on_column(cr, k, context=context)
2620                                 # add the NOT NULL constraint
2621                                 try:
2622                                     cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k), log_exceptions=False)
2623                                     cr.commit()
2624                                     _schema.debug("Table '%s': column '%s': added NOT NULL constraint",
2625                                         self._table, k)
2626                                 except Exception:
2627                                     msg = "Table '%s': unable to set a NOT NULL constraint on column '%s' !\n"\
2628                                         "If you want to have it, you should update the records and execute manually:\n"\
2629                                         "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2630                                     _schema.warning(msg, self._table, k, self._table, k)
2631                                 cr.commit()
2632                             elif not f.required and f_pg_notnull == 1:
2633                                 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2634                                 cr.commit()
2635                                 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2636                                     self._table, k)
2637                             # Verify index
2638                             indexname = '%s_%s_index' % (self._table, k)
2639                             cr.execute("SELECT indexname FROM pg_indexes WHERE indexname = %s and tablename = %s", (indexname, self._table))
2640                             res2 = cr.dictfetchall()
2641                             if not res2 and f.select:
2642                                 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2643                                 cr.commit()
2644                                 if f._type == 'text':
2645                                     # FIXME: for fields.text columns we should try creating GIN indexes instead (seems most suitable for an ERP context)
2646                                     msg = "Table '%s': Adding (b-tree) index for %s column '%s'."\
2647                                         "This is probably useless (does not work for fulltext search) and prevents INSERTs of long texts"\
2648                                         " because there is a length limit for indexable btree values!\n"\
2649                                         "Use a search view instead if you simply want to make the field searchable."
2650                                     _schema.warning(msg, self._table, f._type, k)
2651                             if res2 and not f.select:
2652                                 cr.execute('DROP INDEX "%s_%s_index"' % (self._table, k))
2653                                 cr.commit()
2654                                 msg = "Table '%s': dropping index for column '%s' of type '%s' as it is not required anymore"
2655                                 _schema.debug(msg, self._table, k, f._type)
2656
2657                             if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2658                                 dest_model = self.pool[f._obj]
2659                                 if dest_model._auto and dest_model._table != 'ir_actions':
2660                                     self._m2o_fix_foreign_key(cr, self._table, k, dest_model, f.ondelete)
2661
2662                     # The field doesn't exist in database. Create it if necessary.
2663                     else:
2664                         if not isinstance(f, fields.function) or f.store:
2665                             # add the missing field
2666                             cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2667                             cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2668                             _schema.debug("Table '%s': added column '%s' with definition=%s",
2669                                 self._table, k, get_pg_type(f)[1])
2670
2671                             # initialize it
2672                             if has_rows:
2673                                 self._set_default_value_on_column(cr, k, context=context)
2674
2675                             # remember the functions to call for the stored fields
2676                             if isinstance(f, fields.function):
2677                                 order = 10
2678                                 if f.store is not True: # i.e. if f.store is a dict
2679                                     order = f.store[f.store.keys()[0]][2]
2680                                 todo_end.append((order, self._update_store, (f, k)))
2681
2682                             # remember new-style stored fields with compute method
2683                             if k in self._fields and self._fields[k].depends:
2684                                 stored_fields.append(self._fields[k])
2685
2686                             # and add constraints if needed
2687                             if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2688                                 if f._obj not in self.pool:
2689                                     raise except_orm('Programming Error', 'There is no reference available for %s' % (f._obj,))
2690                                 dest_model = self.pool[f._obj]
2691                                 ref = dest_model._table
2692                                 # ir_actions is inherited so foreign key doesn't work on it
2693                                 if dest_model._auto and ref != 'ir_actions':
2694                                     self._m2o_add_foreign_key_checked(k, dest_model, f.ondelete)
2695                             if f.select:
2696                                 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2697                             if f.required:
2698                                 try:
2699                                     cr.commit()
2700                                     cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k))
2701                                     _schema.debug("Table '%s': column '%s': added a NOT NULL constraint",
2702                                         self._table, k)
2703                                 except Exception:
2704                                     msg = "WARNING: unable to set column %s of table %s not null !\n"\
2705                                         "Try to re-run: openerp-server --update=module\n"\
2706                                         "If it doesn't work, update records and execute manually:\n"\
2707                                         "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2708                                     _logger.warning(msg, k, self._table, self._table, k, exc_info=True)
2709                             cr.commit()
2710
2711         else:
2712             cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2713             create = not bool(cr.fetchone())
2714
2715         cr.commit()     # start a new transaction
2716
2717         if self._auto:
2718             self._add_sql_constraints(cr)
2719
2720         if create:
2721             self._execute_sql(cr)
2722
2723         if store_compute:
2724             self._parent_store_compute(cr)
2725             cr.commit()
2726
2727         if stored_fields:
2728             # trigger computation of new-style stored fields with a compute
2729             def func(cr):
2730                 _logger.info("Storing computed values of %s fields %s",
2731                     self._name, ', '.join(sorted(f.name for f in stored_fields)))
2732                 recs = self.browse(cr, SUPERUSER_ID, [], {'active_test': False})
2733                 recs = recs.search([])
2734                 if recs:
2735                     map(recs._recompute_todo, stored_fields)
2736                     recs.recompute()
2737
2738             todo_end.append((1000, func, ()))
2739
2740         return todo_end
2741
2742     def _auto_end(self, cr, context=None):
2743         """ Create the foreign keys recorded by _auto_init. """
2744         for t, k, r, d in self._foreign_keys:
2745             cr.execute('ALTER TABLE "%s" ADD FOREIGN KEY ("%s") REFERENCES "%s" ON DELETE %s' % (t, k, r, d))
2746             self._save_constraint(cr, "%s_%s_fkey" % (t, k), 'f')
2747         cr.commit()
2748         del self._foreign_keys
2749
2750
2751     def _table_exist(self, cr):
2752         cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2753         return cr.rowcount
2754
2755
2756     def _create_table(self, cr):
2757         cr.execute('CREATE TABLE "%s" (id SERIAL NOT NULL, PRIMARY KEY(id))' % (self._table,))
2758         cr.execute(("COMMENT ON TABLE \"%s\" IS %%s" % self._table), (self._description,))
2759         _schema.debug("Table '%s': created", self._table)
2760
2761
2762     def _parent_columns_exist(self, cr):
2763         cr.execute("""SELECT c.relname
2764             FROM pg_class c, pg_attribute a
2765             WHERE c.relname=%s AND a.attname=%s AND c.oid=a.attrelid
2766             """, (self._table, 'parent_left'))
2767         return cr.rowcount
2768
2769
2770     def _create_parent_columns(self, cr):
2771         cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_left" INTEGER' % (self._table,))
2772         cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_right" INTEGER' % (self._table,))
2773         if 'parent_left' not in self._columns:
2774             _logger.error('create a column parent_left on object %s: fields.integer(\'Left Parent\', select=1)',
2775                           self._table)
2776             _schema.debug("Table '%s': added column '%s' with definition=%s",
2777                 self._table, 'parent_left', 'INTEGER')
2778         elif not self._columns['parent_left'].select:
2779             _logger.error('parent_left column on object %s must be indexed! Add select=1 to the field definition)',
2780                           self._table)
2781         if 'parent_right' not in self._columns:
2782             _logger.error('create a column parent_right on object %s: fields.integer(\'Right Parent\', select=1)',
2783                           self._table)
2784             _schema.debug("Table '%s': added column '%s' with definition=%s",
2785                 self._table, 'parent_right', 'INTEGER')
2786         elif not self._columns['parent_right'].select:
2787             _logger.error('parent_right column on object %s must be indexed! Add select=1 to the field definition)',
2788                           self._table)
2789         if self._columns[self._parent_name].ondelete not in ('cascade', 'restrict'):
2790             _logger.error("The column %s on object %s must be set as ondelete='cascade' or 'restrict'",
2791                           self._parent_name, self._name)
2792
2793         cr.commit()
2794
2795
2796     def _select_column_data(self, cr):
2797         # attlen is the number of bytes necessary to represent the type when
2798         # the type has a fixed size. If the type has a varying size attlen is
2799         # -1 and atttypmod is the size limit + 4, or -1 if there is no limit.
2800         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 " \
2801            "FROM pg_class c,pg_attribute a,pg_type t " \
2802            "WHERE c.relname=%s " \
2803            "AND c.oid=a.attrelid " \
2804            "AND a.atttypid=t.oid", (self._table,))
2805         return dict(map(lambda x: (x['attname'], x),cr.dictfetchall()))
2806
2807
2808     def _o2m_raise_on_missing_reference(self, cr, f):
2809         # TODO this check should be a method on fields.one2many.
2810         if f._obj in self.pool:
2811             other = self.pool[f._obj]
2812             # TODO the condition could use fields_get_keys().
2813             if f._fields_id not in other._columns.keys():
2814                 if f._fields_id not in other._inherit_fields.keys():
2815                     raise except_orm('Programming Error', "There is no reference field '%s' found for '%s'" % (f._fields_id, f._obj,))
2816
2817     def _m2m_raise_or_create_relation(self, cr, f):
2818         m2m_tbl, col1, col2 = f._sql_names(self)
2819         # do not create relations for custom fields as they do not belong to a module
2820         # they will be automatically removed when dropping the corresponding ir.model.field
2821         # table name for custom relation all starts with x_, see __init__
2822         if not m2m_tbl.startswith('x_'):
2823             self._save_relation_table(cr, m2m_tbl)
2824         cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (m2m_tbl,))
2825         if not cr.dictfetchall():
2826             if f._obj not in self.pool:
2827                 raise except_orm('Programming Error', 'Many2Many destination model does not exist: `%s`' % (f._obj,))
2828             dest_model = self.pool[f._obj]
2829             ref = dest_model._table
2830             cr.execute('CREATE TABLE "%s" ("%s" INTEGER NOT NULL, "%s" INTEGER NOT NULL, UNIQUE("%s","%s"))' % (m2m_tbl, col1, col2, col1, col2))
2831             # create foreign key references with ondelete=cascade, unless the targets are SQL views
2832             cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (ref,))
2833             if not cr.fetchall():
2834                 self._m2o_add_foreign_key_unchecked(m2m_tbl, col2, dest_model, 'cascade')
2835             cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (self._table,))
2836             if not cr.fetchall():
2837                 self._m2o_add_foreign_key_unchecked(m2m_tbl, col1, self, 'cascade')
2838
2839             cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col1, m2m_tbl, col1))
2840             cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col2, m2m_tbl, col2))
2841             cr.execute("COMMENT ON TABLE \"%s\" IS 'RELATION BETWEEN %s AND %s'" % (m2m_tbl, self._table, ref))
2842             cr.commit()
2843             _schema.debug("Create table '%s': m2m relation between '%s' and '%s'", m2m_tbl, self._table, ref)
2844
2845
2846     def _add_sql_constraints(self, cr):
2847         """
2848
2849         Modify this model's database table constraints so they match the one in
2850         _sql_constraints.
2851
2852         """
2853         def unify_cons_text(txt):
2854             return txt.lower().replace(', ',',').replace(' (','(')
2855
2856         for (key, con, _) in self._sql_constraints:
2857             conname = '%s_%s' % (self._table, key)
2858
2859             self._save_constraint(cr, conname, 'u')
2860             cr.execute("SELECT conname, pg_catalog.pg_get_constraintdef(oid, true) as condef FROM pg_constraint where conname=%s", (conname,))
2861             existing_constraints = cr.dictfetchall()
2862             sql_actions = {
2863                 'drop': {
2864                     'execute': False,
2865                     'query': 'ALTER TABLE "%s" DROP CONSTRAINT "%s"' % (self._table, conname, ),
2866                     'msg_ok': "Table '%s': dropped constraint '%s'. Reason: its definition changed from '%%s' to '%s'" % (
2867                         self._table, conname, con),
2868                     'msg_err': "Table '%s': unable to drop \'%s\' constraint !" % (self._table, con),
2869                     'order': 1,
2870                 },
2871                 'add': {
2872                     'execute': False,
2873                     'query': 'ALTER TABLE "%s" ADD CONSTRAINT "%s" %s' % (self._table, conname, con,),
2874                     'msg_ok': "Table '%s': added constraint '%s' with definition=%s" % (self._table, conname, con),
2875                     '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" % (
2876                         self._table, con),
2877                     'order': 2,
2878                 },
2879             }
2880
2881             if not existing_constraints:
2882                 # constraint does not exists:
2883                 sql_actions['add']['execute'] = True
2884                 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2885             elif unify_cons_text(con) not in [unify_cons_text(item['condef']) for item in existing_constraints]:
2886                 # constraint exists but its definition has changed:
2887                 sql_actions['drop']['execute'] = True
2888                 sql_actions['drop']['msg_ok'] = sql_actions['drop']['msg_ok'] % (existing_constraints[0]['condef'].lower(), )
2889                 sql_actions['add']['execute'] = True
2890                 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2891
2892             # we need to add the constraint:
2893             sql_actions = [item for item in sql_actions.values()]
2894             sql_actions.sort(key=lambda x: x['order'])
2895             for sql_action in [action for action in sql_actions if action['execute']]:
2896                 try:
2897                     cr.execute(sql_action['query'])
2898                     cr.commit()
2899                     _schema.debug(sql_action['msg_ok'])
2900                 except:
2901                     _schema.warning(sql_action['msg_err'])
2902                     cr.rollback()
2903
2904
2905     def _execute_sql(self, cr):
2906         """ Execute the SQL code from the _sql attribute (if any)."""
2907         if hasattr(self, "_sql"):
2908             for line in self._sql.split(';'):
2909                 line2 = line.replace('\n', '').strip()
2910                 if line2:
2911                     cr.execute(line2)
2912                     cr.commit()
2913
2914     #
2915     # Update objects that uses this one to update their _inherits fields
2916     #
2917
2918     @classmethod
2919     def _inherits_reload_src(cls):
2920         """ Recompute the _inherit_fields mapping on each _inherits'd child model."""
2921         for model in cls.pool.values():
2922             if cls._name in model._inherits:
2923                 model._inherits_reload()
2924
2925     @classmethod
2926     def _inherits_reload(cls):
2927         """ Recompute the _inherit_fields mapping.
2928
2929         This will also call itself on each inherits'd child model.
2930
2931         """
2932         res = {}
2933         for table in cls._inherits:
2934             other = cls.pool[table]
2935             for col in other._columns.keys():
2936                 res[col] = (table, cls._inherits[table], other._columns[col], table)
2937             for col in other._inherit_fields.keys():
2938                 res[col] = (table, cls._inherits[table], other._inherit_fields[col][2], other._inherit_fields[col][3])
2939         cls._inherit_fields = res
2940         cls._all_columns = cls._get_column_infos()
2941
2942         # interface columns with new-style fields
2943         for attr, column in cls._columns.items():
2944             if attr not in cls._fields:
2945                 cls._add_field(attr, column.to_field())
2946
2947         # interface inherited fields with new-style fields (note that the
2948         # reverse order is for being consistent with _all_columns above)
2949         for parent_model, parent_field in reversed(cls._inherits.items()):
2950             for attr, field in cls.pool[parent_model]._fields.iteritems():
2951                 if attr not in cls._fields:
2952                     cls._add_field(attr, field.copy(
2953                         inherited=True,
2954                         related=(parent_field, attr),
2955                         related_sudo=False,
2956                     ))
2957
2958         cls._inherits_reload_src()
2959
2960     @classmethod
2961     def _get_column_infos(cls):
2962         """Returns a dict mapping all fields names (direct fields and
2963            inherited field via _inherits) to a ``column_info`` struct
2964            giving detailed columns """
2965         result = {}
2966         # do not inverse for loops, since local fields may hide inherited ones!
2967         for k, (parent, m2o, col, original_parent) in cls._inherit_fields.iteritems():
2968             result[k] = fields.column_info(k, col, parent, m2o, original_parent)
2969         for k, col in cls._columns.iteritems():
2970             result[k] = fields.column_info(k, col)
2971         return result
2972
2973     @classmethod
2974     def _inherits_check(cls):
2975         for table, field_name in cls._inherits.items():
2976             if field_name not in cls._columns:
2977                 _logger.info('Missing many2one field definition for _inherits reference "%s" in "%s", using default one.', field_name, cls._name)
2978                 cls._columns[field_name] = fields.many2one(table, string="Automatically created field to link to parent %s" % table,
2979                                                              required=True, ondelete="cascade")
2980             elif not cls._columns[field_name].required or cls._columns[field_name].ondelete.lower() not in ("cascade", "restrict"):
2981                 _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)
2982                 cls._columns[field_name].required = True
2983                 cls._columns[field_name].ondelete = "cascade"
2984
2985         # reflect fields with delegate=True in dictionary cls._inherits
2986         for field in cls._fields.itervalues():
2987             if field.type == 'many2one' and not field.related and field.delegate:
2988                 if not field.required:
2989                     _logger.warning("Field %s with delegate=True must be required.", field)
2990                     field.required = True
2991                 if field.ondelete.lower() not in ('cascade', 'restrict'):
2992                     field.ondelete = 'cascade'
2993                 cls._inherits[field.comodel_name] = field.name
2994
2995     @api.model
2996     def _prepare_setup_fields(self):
2997         """ Prepare the setup of fields once the models have been loaded. """
2998         for field in self._fields.itervalues():
2999             field.reset()
3000
3001     @api.model
3002     def _setup_fields(self, partial=False):
3003         """ Setup the fields (dependency triggers, etc). """
3004         for field in self._fields.itervalues():
3005             if partial and field.manual and \
3006                     field.relational and \
3007                     (field.comodel_name not in self.pool or \
3008                      (field.type == 'one2many' and field.inverse_name not in self.pool[field.comodel_name]._fields)):
3009                 # do not set up manual fields that refer to unknown models
3010                 continue
3011             field.setup(self.env)
3012
3013         # group fields by compute to determine field.computed_fields
3014         fields_by_compute = defaultdict(list)
3015         for field in self._fields.itervalues():
3016             if field.compute:
3017                 field.computed_fields = fields_by_compute[field.compute]
3018                 field.computed_fields.append(field)
3019             else:
3020                 field.computed_fields = []
3021
3022     def fields_get(self, cr, user, allfields=None, context=None, write_access=True):
3023         """ fields_get([fields])
3024
3025         Return the definition of each field.
3026
3027         The returned value is a dictionary (indiced by field name) of
3028         dictionaries. The _inherits'd fields are included. The string, help,
3029         and selection (if present) attributes are translated.
3030
3031         :param cr: database cursor
3032         :param user: current user id
3033         :param allfields: list of fields
3034         :param context: context arguments, like lang, time zone
3035         :return: dictionary of field dictionaries, each one describing a field of the business object
3036         :raise AccessError: * if user has no create/write rights on the requested object
3037
3038         """
3039         recs = self.browse(cr, user, [], context)
3040
3041         res = {}
3042         for fname, field in self._fields.iteritems():
3043             if allfields and fname not in allfields:
3044                 continue
3045             if not field.setup_done:
3046                 continue
3047             if field.groups and not recs.user_has_groups(field.groups):
3048                 continue
3049             res[fname] = field.get_description(recs.env)
3050
3051         # if user cannot create or modify records, make all fields readonly
3052         has_access = functools.partial(recs.check_access_rights, raise_exception=False)
3053         if not (has_access('write') or has_access('create')):
3054             for description in res.itervalues():
3055                 description['readonly'] = True
3056                 description['states'] = {}
3057
3058         return res
3059
3060     def get_empty_list_help(self, cr, user, help, context=None):
3061         """ Generic method giving the help message displayed when having
3062             no result to display in a list or kanban view. By default it returns
3063             the help given in parameter that is generally the help message
3064             defined in the action.
3065         """
3066         return help
3067
3068     def check_field_access_rights(self, cr, user, operation, fields, context=None):
3069         """
3070         Check the user access rights on the given fields. This raises Access
3071         Denied if the user does not have the rights. Otherwise it returns the
3072         fields (as is if the fields is not falsy, or the readable/writable
3073         fields if fields is falsy).
3074         """
3075         if user == SUPERUSER_ID:
3076             return fields or list(self._fields)
3077
3078         def valid(fname):
3079             """ determine whether user has access to field `fname` """
3080             field = self._fields.get(fname)
3081             if field and field.groups:
3082                 return self.user_has_groups(cr, user, groups=field.groups, context=context)
3083             else:
3084                 return True
3085
3086         if not fields:
3087             fields = filter(valid, self._fields)
3088         else:
3089             invalid_fields = set(filter(lambda name: not valid(name), fields))
3090             if invalid_fields:
3091                 _logger.warning('Access Denied by ACLs for operation: %s, uid: %s, model: %s, fields: %s',
3092                     operation, user, self._name, ', '.join(invalid_fields))
3093                 raise AccessError(
3094                     _('The requested operation cannot be completed due to security restrictions. '
3095                     'Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3096                     (self._description, operation))
3097
3098         return fields
3099
3100     # add explicit old-style implementation to read()
3101     @api.v7
3102     def read(self, cr, user, ids, fields=None, context=None, load='_classic_read'):
3103         records = self.browse(cr, user, ids, context)
3104         result = BaseModel.read(records, fields, load=load)
3105         return result if isinstance(ids, list) else (bool(result) and result[0])
3106
3107     # new-style implementation of read()
3108     @api.v8
3109     def read(self, fields=None, load='_classic_read'):
3110         """ read([fields])
3111
3112         Reads the requested fields for the records in `self`, low-level/RPC
3113         method. In Python code, prefer :meth:`~.browse`.
3114
3115         :param fields: list of field names to return (default is all fields)
3116         :return: a list of dictionaries mapping field names to their values,
3117                  with one dictionary per record
3118         :raise AccessError: if user has no read rights on some of the given
3119                 records
3120         """
3121         # check access rights
3122         self.check_access_rights('read')
3123         fields = self.check_field_access_rights('read', fields)
3124
3125         # split fields into stored and computed fields
3126         stored, computed = [], []
3127         for name in fields:
3128             if name in self._columns:
3129                 stored.append(name)
3130             elif name in self._fields:
3131                 computed.append(name)
3132             else:
3133                 _logger.warning("%s.read() with unknown field '%s'", self._name, name)
3134
3135         # fetch stored fields from the database to the cache
3136         self._read_from_database(stored)
3137
3138         # retrieve results from records; this takes values from the cache and
3139         # computes remaining fields
3140         result = []
3141         name_fields = [(name, self._fields[name]) for name in (stored + computed)]
3142         use_name_get = (load == '_classic_read')
3143         for record in self:
3144             try:
3145                 values = {'id': record.id}
3146                 for name, field in name_fields:
3147                     values[name] = field.convert_to_read(record[name], use_name_get)
3148                 result.append(values)
3149             except MissingError:
3150                 pass
3151
3152         return result
3153
3154     @api.multi
3155     def _prefetch_field(self, field):
3156         """ Read from the database in order to fetch `field` (:class:`Field`
3157             instance) for `self` in cache.
3158         """
3159         # fetch the records of this model without field_name in their cache
3160         records = self._in_cache_without(field)
3161
3162         if len(records) > PREFETCH_MAX:
3163             records = records[:PREFETCH_MAX] | self
3164
3165         # by default, simply fetch field
3166         fnames = {field.name}
3167
3168         if self.env.in_draft:
3169             # we may be doing an onchange, do not prefetch other fields
3170             pass
3171         elif self.env.field_todo(field):
3172             # field must be recomputed, do not prefetch records to recompute
3173             records -= self.env.field_todo(field)
3174         elif not self._context.get('prefetch_fields', True):
3175             # do not prefetch other fields
3176             pass
3177         elif self._columns[field.name]._prefetch:
3178             # here we can optimize: prefetch all classic and many2one fields
3179             fnames = set(fname
3180                 for fname, fcolumn in self._columns.iteritems()
3181                 if fcolumn._prefetch
3182                 if not fcolumn.groups or self.user_has_groups(fcolumn.groups)
3183             )
3184
3185         # fetch records with read()
3186         assert self in records and field.name in fnames
3187         result = []
3188         try:
3189             result = records.read(list(fnames), load='_classic_write')
3190         except AccessError:
3191             pass
3192
3193         # check the cache, and update it if necessary
3194         if not self._cache.contains(field):
3195             for values in result:
3196                 record = self.browse(values.pop('id'))
3197                 record._cache.update(record._convert_to_cache(values, validate=False))
3198             if not self._cache.contains(field):
3199                 e = AccessError("No value found for %s.%s" % (self, field.name))
3200                 self._cache[field] = FailedValue(e)
3201
3202     @api.multi
3203     def _read_from_database(self, field_names):
3204         """ Read the given fields of the records in `self` from the database,
3205             and store them in cache. Access errors are also stored in cache.
3206         """
3207         env = self.env
3208         cr, user, context = env.args
3209
3210         # FIXME: The query construction needs to be rewritten using the internal Query
3211         # object, as in search(), to avoid ambiguous column references when
3212         # reading/sorting on a table that is auto_joined to another table with
3213         # common columns (e.g. the magical columns)
3214
3215         # Construct a clause for the security rules.
3216         # 'tables' holds the list of tables necessary for the SELECT, including
3217         # the ir.rule clauses, and contains at least self._table.
3218         rule_clause, rule_params, tables = env['ir.rule'].domain_get(self._name, 'read')
3219
3220         # determine the fields that are stored as columns in self._table
3221         fields_pre = [f for f in field_names if self._columns[f]._classic_write]
3222
3223         # we need fully-qualified column names in case len(tables) > 1
3224         def qualify(f):
3225             if isinstance(self._columns.get(f), fields.binary) and \
3226                     context.get('bin_size_%s' % f, context.get('bin_size')):
3227                 # PG 9.2 introduces conflicting pg_size_pretty(numeric) -> need ::cast
3228                 return 'pg_size_pretty(length(%s."%s")::bigint) as "%s"' % (self._table, f, f)
3229             else:
3230                 return '%s."%s"' % (self._table, f)
3231         qual_names = map(qualify, set(fields_pre + ['id']))
3232
3233         query = """ SELECT %(qual_names)s FROM %(tables)s
3234                     WHERE %(table)s.id IN %%s AND (%(extra)s)
3235                     ORDER BY %(order)s
3236                 """ % {
3237                     'qual_names': ",".join(qual_names),
3238                     'tables': ",".join(tables),
3239                     'table': self._table,
3240                     'extra': " OR ".join(rule_clause) if rule_clause else "TRUE",
3241                     'order': self._parent_order or self._order,
3242                 }
3243
3244         result = []
3245         for sub_ids in cr.split_for_in_conditions(self.ids):
3246             cr.execute(query, [tuple(sub_ids)] + rule_params)
3247             result.extend(cr.dictfetchall())
3248
3249         ids = [vals['id'] for vals in result]
3250
3251         if ids:
3252             # translate the fields if necessary
3253             if context.get('lang'):
3254                 ir_translation = env['ir.translation']
3255                 for f in fields_pre:
3256                     if self._columns[f].translate:
3257                         #TODO: optimize out of this loop
3258                         res_trans = ir_translation._get_ids(
3259                             '%s,%s' % (self._name, f), 'model', context['lang'], ids)
3260                         for vals in result:
3261                             vals[f] = res_trans.get(vals['id'], False) or vals[f]
3262
3263             # apply the symbol_get functions of the fields we just read
3264             for f in fields_pre:
3265                 symbol_get = self._columns[f]._symbol_get
3266                 if symbol_get:
3267                     for vals in result:
3268                         vals[f] = symbol_get(vals[f])
3269
3270             # store result in cache for POST fields
3271             for vals in result:
3272                 record = self.browse(vals['id'])
3273                 record._cache.update(record._convert_to_cache(vals, validate=False))
3274
3275             # determine the fields that must be processed now
3276             fields_post = [f for f in field_names if not self._columns[f]._classic_write]
3277
3278             # Compute POST fields, grouped by multi
3279             by_multi = defaultdict(list)
3280             for f in fields_post:
3281                 by_multi[self._columns[f]._multi].append(f)
3282
3283             for multi, fs in by_multi.iteritems():
3284                 if multi:
3285                     res2 = self._columns[fs[0]].get(cr, self._model, ids, fs, user, context=context, values=result)
3286                     assert res2 is not None, \
3287                         'The function field "%s" on the "%s" model returned None\n' \
3288                         '(a dictionary was expected).' % (fs[0], self._name)
3289                     for vals in result:
3290                         # TOCHECK : why got string instend of dict in python2.6
3291                         # if isinstance(res2[vals['id']], str): res2[vals['id']] = eval(res2[vals['id']])
3292                         multi_fields = res2.get(vals['id'], {})
3293                         if multi_fields:
3294                             for f in fs:
3295                                 vals[f] = multi_fields.get(f, [])
3296                 else:
3297                     for f in fs:
3298                         res2 = self._columns[f].get(cr, self._model, ids, f, user, context=context, values=result)
3299                         for vals in result:
3300                             if res2:
3301                                 vals[f] = res2[vals['id']]
3302                             else:
3303                                 vals[f] = []
3304
3305         # Warn about deprecated fields now that fields_pre and fields_post are computed
3306         for f in field_names:
3307             column = self._columns[f]
3308             if column.deprecated:
3309                 _logger.warning('Field %s.%s is deprecated: %s', self._name, f, column.deprecated)
3310
3311         # store result in cache
3312         for vals in result:
3313             record = self.browse(vals.pop('id'))
3314             record._cache.update(record._convert_to_cache(vals, validate=False))
3315
3316         # store failed values in cache for the records that could not be read
3317         fetched = self.browse(ids)
3318         missing = self - fetched
3319         if missing:
3320             extras = fetched - self
3321             if extras:
3322                 raise AccessError(
3323                     _("Database fetch misses ids ({}) and has extra ids ({}), may be caused by a type incoherence in a previous request").format(
3324                         ', '.join(map(repr, missing._ids)),
3325                         ', '.join(map(repr, extras._ids)),
3326                     ))
3327             # store an access error exception in existing records
3328             exc = AccessError(
3329                 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3330                 (self._name, 'read')
3331             )
3332             forbidden = missing.exists()
3333             forbidden._cache.update(FailedValue(exc))
3334             # store a missing error exception in non-existing records
3335             exc = MissingError(
3336                 _('One of the documents you are trying to access has been deleted, please try again after refreshing.')
3337             )
3338             (missing - forbidden)._cache.update(FailedValue(exc))
3339
3340     @api.multi
3341     def get_metadata(self):
3342         """
3343         Returns some metadata about the given records.
3344
3345         :return: list of ownership dictionaries for each requested record
3346         :rtype: list of dictionaries with the following keys:
3347
3348                     * id: object id
3349                     * create_uid: user who created the record
3350                     * create_date: date when the record was created
3351                     * write_uid: last user who changed the record
3352                     * write_date: date of the last change to the record
3353                     * xmlid: XML ID to use to refer to this record (if there is one), in format ``module.name``
3354         """
3355         fields = ['id']
3356         if self._log_access:
3357             fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
3358         quoted_table = '"%s"' % self._table
3359         fields_str = ",".join('%s.%s' % (quoted_table, field) for field in fields)
3360         query = '''SELECT %s, __imd.module, __imd.name
3361                    FROM %s LEFT JOIN ir_model_data __imd
3362                        ON (__imd.model = %%s and __imd.res_id = %s.id)
3363                    WHERE %s.id IN %%s''' % (fields_str, quoted_table, quoted_table, quoted_table)
3364         self._cr.execute(query, (self._name, tuple(self.ids)))
3365         res = self._cr.dictfetchall()
3366
3367         uids = set(r[k] for r in res for k in ['write_uid', 'create_uid'] if r.get(k))
3368         names = dict(self.env['res.users'].browse(uids).name_get())
3369
3370         for r in res:
3371             for key in r:
3372                 value = r[key] = r[key] or False
3373                 if key in ('write_uid', 'create_uid') and value in names:
3374                     r[key] = (value, names[value])
3375             r['xmlid'] = ("%(module)s.%(name)s" % r) if r['name'] else False
3376             del r['name'], r['module']
3377         return res
3378
3379     def _check_concurrency(self, cr, ids, context):
3380         if not context:
3381             return
3382         if not (context.get(self.CONCURRENCY_CHECK_FIELD) and self._log_access):
3383             return
3384         check_clause = "(id = %s AND %s < COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp)"
3385         for sub_ids in cr.split_for_in_conditions(ids):
3386             ids_to_check = []
3387             for id in sub_ids:
3388                 id_ref = "%s,%s" % (self._name, id)
3389                 update_date = context[self.CONCURRENCY_CHECK_FIELD].pop(id_ref, None)
3390                 if update_date:
3391                     ids_to_check.extend([id, update_date])
3392             if not ids_to_check:
3393                 continue
3394             cr.execute("SELECT id FROM %s WHERE %s" % (self._table, " OR ".join([check_clause]*(len(ids_to_check)/2))), tuple(ids_to_check))
3395             res = cr.fetchone()
3396             if res:
3397                 # mention the first one only to keep the error message readable
3398                 raise except_orm('ConcurrencyException', _('A document was modified since you last viewed it (%s:%d)') % (self._description, res[0]))
3399
3400     def _check_record_rules_result_count(self, cr, uid, ids, result_ids, operation, context=None):
3401         """Verify the returned rows after applying record rules matches
3402            the length of `ids`, and raise an appropriate exception if it does not.
3403         """
3404         if context is None:
3405             context = {}
3406         ids, result_ids = set(ids), set(result_ids)
3407         missing_ids = ids - result_ids
3408         if missing_ids:
3409             # Attempt to distinguish record rule restriction vs deleted records,
3410             # to provide a more specific error message - check if the missinf
3411             cr.execute('SELECT id FROM ' + self._table + ' WHERE id IN %s', (tuple(missing_ids),))
3412             forbidden_ids = [x[0] for x in cr.fetchall()]
3413             if forbidden_ids:
3414                 # the missing ids are (at least partially) hidden by access rules
3415                 if uid == SUPERUSER_ID:
3416                     return
3417                 _logger.warning('Access Denied by record rules for operation: %s on record ids: %r, uid: %s, model: %s', operation, forbidden_ids, uid, self._name)
3418                 raise except_orm(_('Access Denied'),
3419                                  _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3420                                     (self._description, operation))
3421             else:
3422                 # If we get here, the missing_ids are not in the database
3423                 if operation in ('read','unlink'):
3424                     # No need to warn about deleting an already deleted record.
3425                     # And no error when reading a record that was deleted, to prevent spurious
3426                     # errors for non-transactional search/read sequences coming from clients
3427                     return
3428                 _logger.warning('Failed operation on deleted record(s): %s, uid: %s, model: %s', operation, uid, self._name)
3429                 raise except_orm(_('Missing document(s)'),
3430                                  _('One of the documents you are trying to access has been deleted, please try again after refreshing.'))
3431
3432
3433     def check_access_rights(self, cr, uid, operation, raise_exception=True): # no context on purpose.
3434         """Verifies that the operation given by ``operation`` is allowed for the user
3435            according to the access rights."""
3436         return self.pool.get('ir.model.access').check(cr, uid, self._name, operation, raise_exception)
3437
3438     def check_access_rule(self, cr, uid, ids, operation, context=None):
3439         """Verifies that the operation given by ``operation`` is allowed for the user
3440            according to ir.rules.
3441
3442            :param operation: one of ``write``, ``unlink``
3443            :raise except_orm: * if current ir.rules do not permit this operation.
3444            :return: None if the operation is allowed
3445         """
3446         if uid == SUPERUSER_ID:
3447             return
3448
3449         if self.is_transient():
3450             # Only one single implicit access rule for transient models: owner only!
3451             # This is ok to hardcode because we assert that TransientModels always
3452             # have log_access enabled so that the create_uid column is always there.
3453             # And even with _inherits, these fields are always present in the local
3454             # table too, so no need for JOINs.
3455             cr.execute("""SELECT distinct create_uid
3456                           FROM %s
3457                           WHERE id IN %%s""" % self._table, (tuple(ids),))
3458             uids = [x[0] for x in cr.fetchall()]
3459             if len(uids) != 1 or uids[0] != uid:
3460                 raise except_orm(_('Access Denied'),
3461                                  _('For this kind of document, you may only access records you created yourself.\n\n(Document type: %s)') % (self._description,))
3462         else:
3463             where_clause, where_params, tables = self.pool.get('ir.rule').domain_get(cr, uid, self._name, operation, context=context)
3464             if where_clause:
3465                 where_clause = ' and ' + ' and '.join(where_clause)
3466                 for sub_ids in cr.split_for_in_conditions(ids):
3467                     cr.execute('SELECT ' + self._table + '.id FROM ' + ','.join(tables) +
3468                                ' WHERE ' + self._table + '.id IN %s' + where_clause,
3469                                [sub_ids] + where_params)
3470                     returned_ids = [x['id'] for x in cr.dictfetchall()]
3471                     self._check_record_rules_result_count(cr, uid, sub_ids, returned_ids, operation, context=context)
3472
3473     def create_workflow(self, cr, uid, ids, context=None):
3474         """Create a workflow instance for each given record IDs."""
3475         from openerp import workflow
3476         for res_id in ids:
3477             workflow.trg_create(uid, self._name, res_id, cr)
3478         # self.invalidate_cache(cr, uid, context=context) ?
3479         return True
3480
3481     def delete_workflow(self, cr, uid, ids, context=None):
3482         """Delete the workflow instances bound to the given record IDs."""
3483         from openerp import workflow
3484         for res_id in ids:
3485             workflow.trg_delete(uid, self._name, res_id, cr)
3486         self.invalidate_cache(cr, uid, context=context)
3487         return True
3488
3489     def step_workflow(self, cr, uid, ids, context=None):
3490         """Reevaluate the workflow instances of the given record IDs."""
3491         from openerp import workflow
3492         for res_id in ids:
3493             workflow.trg_write(uid, self._name, res_id, cr)
3494         # self.invalidate_cache(cr, uid, context=context) ?
3495         return True
3496
3497     def signal_workflow(self, cr, uid, ids, signal, context=None):
3498         """Send given workflow signal and return a dict mapping ids to workflow results"""
3499         from openerp import workflow
3500         result = {}
3501         for res_id in ids:
3502             result[res_id] = workflow.trg_validate(uid, self._name, res_id, signal, cr)
3503         # self.invalidate_cache(cr, uid, context=context) ?
3504         return result
3505
3506     def redirect_workflow(self, cr, uid, old_new_ids, context=None):
3507         """ Rebind the workflow instance bound to the given 'old' record IDs to
3508             the given 'new' IDs. (``old_new_ids`` is a list of pairs ``(old, new)``.
3509         """
3510         from openerp import workflow
3511         for old_id, new_id in old_new_ids:
3512             workflow.trg_redirect(uid, self._name, old_id, new_id, cr)
3513         self.invalidate_cache(cr, uid, context=context)
3514         return True
3515
3516     def unlink(self, cr, uid, ids, context=None):
3517         """ unlink()
3518
3519         Deletes the records of the current set
3520
3521         :raise AccessError: * if user has no unlink rights on the requested object
3522                             * if user tries to bypass access rules for unlink on the requested object
3523         :raise UserError: if the record is default property for other records
3524
3525         """
3526         if not ids:
3527             return True
3528         if isinstance(ids, (int, long)):
3529             ids = [ids]
3530
3531         result_store = self._store_get_values(cr, uid, ids, self._all_columns.keys(), context)
3532
3533         # for recomputing new-style fields
3534         recs = self.browse(cr, uid, ids, context)
3535         recs.modified(self._fields)
3536
3537         self._check_concurrency(cr, ids, context)
3538
3539         self.check_access_rights(cr, uid, 'unlink')
3540
3541         ir_property = self.pool.get('ir.property')
3542
3543         # Check if the records are used as default properties.
3544         domain = [('res_id', '=', False),
3545                   ('value_reference', 'in', ['%s,%s' % (self._name, i) for i in ids]),
3546                  ]
3547         if ir_property.search(cr, uid, domain, context=context):
3548             raise except_orm(_('Error'), _('Unable to delete this document because it is used as a default property'))
3549
3550         # Delete the records' properties.
3551         property_ids = ir_property.search(cr, uid, [('res_id', 'in', ['%s,%s' % (self._name, i) for i in ids])], context=context)
3552         ir_property.unlink(cr, uid, property_ids, context=context)
3553
3554         self.delete_workflow(cr, uid, ids, context=context)
3555
3556         self.check_access_rule(cr, uid, ids, 'unlink', context=context)
3557         pool_model_data = self.pool.get('ir.model.data')
3558         ir_values_obj = self.pool.get('ir.values')
3559         ir_attachment_obj = self.pool.get('ir.attachment')
3560         for sub_ids in cr.split_for_in_conditions(ids):
3561             cr.execute('delete from ' + self._table + ' ' \
3562                        'where id IN %s', (sub_ids,))
3563
3564             # Removing the ir_model_data reference if the record being deleted is a record created by xml/csv file,
3565             # as these are not connected with real database foreign keys, and would be dangling references.
3566             # Note: following steps performed as admin to avoid access rights restrictions, and with no context
3567             #       to avoid possible side-effects during admin calls.
3568             # Step 1. Calling unlink of ir_model_data only for the affected IDS
3569             reference_ids = pool_model_data.search(cr, SUPERUSER_ID, [('res_id','in',list(sub_ids)),('model','=',self._name)])
3570             # Step 2. Marching towards the real deletion of referenced records
3571             if reference_ids:
3572                 pool_model_data.unlink(cr, SUPERUSER_ID, reference_ids)
3573
3574             # For the same reason, removing the record relevant to ir_values
3575             ir_value_ids = ir_values_obj.search(cr, uid,
3576                     ['|',('value','in',['%s,%s' % (self._name, sid) for sid in sub_ids]),'&',('res_id','in',list(sub_ids)),('model','=',self._name)],
3577                     context=context)
3578             if ir_value_ids:
3579                 ir_values_obj.unlink(cr, uid, ir_value_ids, context=context)
3580
3581             # For the same reason, removing the record relevant to ir_attachment
3582             # The search is performed with sql as the search method of ir_attachment is overridden to hide attachments of deleted records
3583             cr.execute('select id from ir_attachment where res_model = %s and res_id in %s', (self._name, sub_ids))
3584             ir_attachment_ids = [ir_attachment[0] for ir_attachment in cr.fetchall()]
3585             if ir_attachment_ids:
3586                 ir_attachment_obj.unlink(cr, uid, ir_attachment_ids, context=context)
3587
3588         # invalidate the *whole* cache, since the orm does not handle all
3589         # changes made in the database, like cascading delete!
3590         recs.invalidate_cache()
3591
3592         for order, obj_name, store_ids, fields in result_store:
3593             if obj_name == self._name:
3594                 effective_store_ids = set(store_ids) - set(ids)
3595             else:
3596                 effective_store_ids = store_ids
3597             if effective_store_ids:
3598                 obj = self.pool[obj_name]
3599                 cr.execute('select id from '+obj._table+' where id IN %s', (tuple(effective_store_ids),))
3600                 rids = map(lambda x: x[0], cr.fetchall())
3601                 if rids:
3602                     obj._store_set_values(cr, uid, rids, fields, context)
3603
3604         # recompute new-style fields
3605         recs.recompute()
3606
3607         return True
3608
3609     #
3610     # TODO: Validate
3611     #
3612     @api.multi
3613     def write(self, vals):
3614         """ write(vals)
3615
3616         Updates all records in the current set with the provided values.
3617
3618         :param dict vals: fields to update and the value to set on them e.g::
3619
3620                 {'foo': 1, 'bar': "Qux"}
3621
3622             will set the field ``foo`` to ``1`` and the field ``bar`` to
3623             ``"Qux"`` if those are valid (otherwise it will trigger an error).
3624
3625         :raise AccessError: * if user has no write rights on the requested object
3626                             * if user tries to bypass access rules for write on the requested object
3627         :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3628         :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)
3629
3630         .. _openerp/models/relationals/format:
3631
3632         .. note:: Relational fields use a special "commands" format to manipulate their values
3633
3634             This format is a list of command triplets executed sequentially,
3635             possible command triplets are:
3636
3637             ``(0, _, values: dict)``
3638                 links to a new record created from the provided values
3639             ``(1, id, values: dict)``
3640                 updates the already-linked record of id ``id`` with the
3641                 provided ``values``
3642             ``(2, id, _)``
3643                 unlinks and deletes the linked record of id ``id``
3644             ``(3, id, _)``
3645                 unlinks the linked record of id ``id`` without deleting it
3646             ``(4, id, _)``
3647                 links to an existing record of id ``id``
3648             ``(5, _, _)``
3649                 unlinks all records in the relation, equivalent to using
3650                 the command ``3`` on every linked record
3651             ``(6, _, ids)``
3652                 replaces the existing list of linked records by the provoded
3653                 ones, equivalent to using ``5`` then ``4`` for each id in
3654                 ``ids``)
3655
3656             (in command triplets, ``_`` values are ignored and can be
3657             anything, generally ``0`` or ``False``)
3658
3659             Any command can be used on :class:`~openerp.fields.Many2many`,
3660             only ``0``, ``1`` and ``2`` can be used on
3661             :class:`~openerp.fields.One2many`.
3662         """
3663         if not self:
3664             return True
3665
3666         self._check_concurrency(self._ids)
3667         self.check_access_rights('write')
3668
3669         # No user-driven update of these columns
3670         for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3671             vals.pop(field, None)
3672
3673         # split up fields into old-style and pure new-style ones
3674         old_vals, new_vals, unknown = {}, {}, []
3675         for key, val in vals.iteritems():
3676             if key in self._columns:
3677                 old_vals[key] = val
3678             elif key in self._fields:
3679                 new_vals[key] = val
3680             else:
3681                 unknown.append(key)
3682
3683         if unknown:
3684             _logger.warning("%s.write() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3685
3686         # write old-style fields with (low-level) method _write
3687         if old_vals:
3688             self._write(old_vals)
3689
3690         # put the values of pure new-style fields into cache, and inverse them
3691         if new_vals:
3692             for record in self:
3693                 record._cache.update(record._convert_to_cache(new_vals, update=True))
3694             for key in new_vals:
3695                 self._fields[key].determine_inverse(self)
3696
3697         return True
3698
3699     def _write(self, cr, user, ids, vals, context=None):
3700         # low-level implementation of write()
3701         if not context:
3702             context = {}
3703
3704         readonly = None
3705         self.check_field_access_rights(cr, user, 'write', vals.keys())
3706         deleted_related = defaultdict(list)
3707         for field in vals.keys():
3708             fobj = None
3709             if field in self._columns:
3710                 fobj = self._columns[field]
3711             elif field in self._inherit_fields:
3712                 fobj = self._inherit_fields[field][2]
3713             if not fobj:
3714                 continue
3715             if fobj._type in ['one2many', 'many2many'] and vals[field]:
3716                 for wtuple in vals[field]:
3717                     if isinstance(wtuple, (tuple, list)) and wtuple[0] == 2:
3718                         deleted_related[fobj._obj].append(wtuple[1])
3719             groups = fobj.write
3720
3721             if groups:
3722                 edit = False
3723                 for group in groups:
3724                     module = group.split(".")[0]
3725                     grp = group.split(".")[1]
3726                     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", \
3727                                (grp, module, 'res.groups', user))
3728                     readonly = cr.fetchall()
3729                     if readonly[0][0] >= 1:
3730                         edit = True
3731                         break
3732
3733                 if not edit:
3734                     vals.pop(field)
3735
3736         result = self._store_get_values(cr, user, ids, vals.keys(), context) or []
3737
3738         # for recomputing new-style fields
3739         recs = self.browse(cr, user, ids, context)
3740         modified_fields = list(vals)
3741         if self._log_access:
3742             modified_fields += ['write_date', 'write_uid']
3743         recs.modified(modified_fields)
3744
3745         parents_changed = []
3746         parent_order = self._parent_order or self._order
3747         if self._parent_store and (self._parent_name in vals) and not context.get('defer_parent_store_computation'):
3748             # The parent_left/right computation may take up to
3749             # 5 seconds. No need to recompute the values if the
3750             # parent is the same.
3751             # Note: to respect parent_order, nodes must be processed in
3752             # order, so ``parents_changed`` must be ordered properly.
3753             parent_val = vals[self._parent_name]
3754             if parent_val:
3755                 query = "SELECT id FROM %s WHERE id IN %%s AND (%s != %%s OR %s IS NULL) ORDER BY %s" % \
3756                                 (self._table, self._parent_name, self._parent_name, parent_order)
3757                 cr.execute(query, (tuple(ids), parent_val))
3758             else:
3759                 query = "SELECT id FROM %s WHERE id IN %%s AND (%s IS NOT NULL) ORDER BY %s" % \
3760                                 (self._table, self._parent_name, parent_order)
3761                 cr.execute(query, (tuple(ids),))
3762             parents_changed = map(operator.itemgetter(0), cr.fetchall())
3763
3764         upd0 = []
3765         upd1 = []
3766         upd_todo = []
3767         updend = []
3768         direct = []
3769         totranslate = context.get('lang', False) and (context['lang'] != 'en_US')
3770         for field in vals:
3771             field_column = self._all_columns.get(field) and self._all_columns.get(field).column
3772             if field_column and field_column.deprecated:
3773                 _logger.warning('Field %s.%s is deprecated: %s', self._name, field, field_column.deprecated)
3774             if field in self._columns:
3775                 if self._columns[field]._classic_write and not (hasattr(self._columns[field], '_fnct_inv')):
3776                     if (not totranslate) or not self._columns[field].translate:
3777                         upd0.append('"'+field+'"='+self._columns[field]._symbol_set[0])
3778                         upd1.append(self._columns[field]._symbol_set[1](vals[field]))
3779                     direct.append(field)
3780                 else:
3781                     upd_todo.append(field)
3782             else:
3783                 updend.append(field)
3784             if field in self._columns \
3785                     and hasattr(self._columns[field], 'selection') \
3786                     and vals[field]:
3787                 self._check_selection_field_value(cr, user, field, vals[field], context=context)
3788
3789         if self._log_access:
3790             upd0.append('write_uid=%s')
3791             upd0.append("write_date=(now() at time zone 'UTC')")
3792             upd1.append(user)
3793
3794         if len(upd0):
3795             self.check_access_rule(cr, user, ids, 'write', context=context)
3796             for sub_ids in cr.split_for_in_conditions(ids):
3797                 cr.execute('update ' + self._table + ' set ' + ','.join(upd0) + ' ' \
3798                            'where id IN %s', upd1 + [sub_ids])
3799                 if cr.rowcount != len(sub_ids):
3800                     raise MissingError(_('One of the records you are trying to modify has already been deleted (Document type: %s).') % self._description)
3801
3802             if totranslate:
3803                 # TODO: optimize
3804                 for f in direct:
3805                     if self._columns[f].translate:
3806                         src_trans = self.pool[self._name].read(cr, user, ids, [f])[0][f]
3807                         if not src_trans:
3808                             src_trans = vals[f]
3809                             # Inserting value to DB
3810                             context_wo_lang = dict(context, lang=None)
3811                             self.write(cr, user, ids, {f: vals[f]}, context=context_wo_lang)
3812                         self.pool.get('ir.translation')._set_ids(cr, user, self._name+','+f, 'model', context['lang'], ids, vals[f], src_trans)
3813
3814         # call the 'set' method of fields which are not classic_write
3815         upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
3816
3817         # default element in context must be removed when call a one2many or many2many
3818         rel_context = context.copy()
3819         for c in context.items():
3820             if c[0].startswith('default_'):
3821                 del rel_context[c[0]]
3822
3823         for field in upd_todo:
3824             for id in ids:
3825                 result += self._columns[field].set(cr, self, id, field, vals[field], user, context=rel_context) or []
3826
3827         unknown_fields = updend[:]
3828         for table in self._inherits:
3829             col = self._inherits[table]
3830             nids = []
3831             for sub_ids in cr.split_for_in_conditions(ids):
3832                 cr.execute('select distinct "'+col+'" from "'+self._table+'" ' \
3833                            'where id IN %s', (sub_ids,))
3834                 nids.extend([x[0] for x in cr.fetchall()])
3835
3836             v = {}
3837             for val in updend:
3838                 if self._inherit_fields[val][0] == table:
3839                     v[val] = vals[val]
3840                     unknown_fields.remove(val)
3841             if v:
3842                 self.pool[table].write(cr, user, nids, v, context)
3843
3844         if unknown_fields:
3845             _logger.warning(
3846                 'No such field(s) in model %s: %s.',
3847                 self._name, ', '.join(unknown_fields))
3848
3849         # check Python constraints
3850         recs._validate_fields(vals)
3851
3852         # TODO: use _order to set dest at the right position and not first node of parent
3853         # We can't defer parent_store computation because the stored function
3854         # fields that are computer may refer (directly or indirectly) to
3855         # parent_left/right (via a child_of domain)
3856         if parents_changed:
3857             if self.pool._init:
3858                 self.pool._init_parent[self._name] = True
3859             else:
3860                 order = self._parent_order or self._order
3861                 parent_val = vals[self._parent_name]
3862                 if parent_val:
3863                     clause, params = '%s=%%s' % (self._parent_name,), (parent_val,)
3864                 else:
3865                     clause, params = '%s IS NULL' % (self._parent_name,), ()
3866
3867                 for id in parents_changed:
3868                     cr.execute('SELECT parent_left, parent_right FROM %s WHERE id=%%s' % (self._table,), (id,))
3869                     pleft, pright = cr.fetchone()
3870                     distance = pright - pleft + 1
3871
3872                     # Positions of current siblings, to locate proper insertion point;
3873                     # this can _not_ be fetched outside the loop, as it needs to be refreshed
3874                     # after each update, in case several nodes are sequentially inserted one
3875                     # next to the other (i.e computed incrementally)
3876                     cr.execute('SELECT parent_right, id FROM %s WHERE %s ORDER BY %s' % (self._table, clause, parent_order), params)
3877                     parents = cr.fetchall()
3878
3879                     # Find Position of the element
3880                     position = None
3881                     for (parent_pright, parent_id) in parents:
3882                         if parent_id == id:
3883                             break
3884                         position = parent_pright and parent_pright + 1 or 1
3885
3886                     # It's the first node of the parent
3887                     if not position:
3888                         if not parent_val:
3889                             position = 1
3890                         else:
3891                             cr.execute('select parent_left from '+self._table+' where id=%s', (parent_val,))
3892                             position = cr.fetchone()[0] + 1
3893
3894                     if pleft < position <= pright:
3895                         raise except_orm(_('UserError'), _('Recursivity Detected.'))
3896
3897                     if pleft < position:
3898                         cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3899                         cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3900                         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))
3901                     else:
3902                         cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3903                         cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3904                         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))
3905                     recs.invalidate_cache(['parent_left', 'parent_right'])
3906
3907         result += self._store_get_values(cr, user, ids, vals.keys(), context)
3908         result.sort()
3909
3910         # for recomputing new-style fields
3911         recs.modified(modified_fields)
3912
3913         done = {}
3914         for order, model_name, ids_to_update, fields_to_recompute in result:
3915             key = (model_name, tuple(fields_to_recompute))
3916             done.setdefault(key, {})
3917             # avoid to do several times the same computation
3918             todo = []
3919             for id in ids_to_update:
3920                 if id not in done[key]:
3921                     done[key][id] = True
3922                     if id not in deleted_related[model_name]:
3923                         todo.append(id)
3924             self.pool[model_name]._store_set_values(cr, user, todo, fields_to_recompute, context)
3925
3926         # recompute new-style fields
3927         if context.get('recompute', True):
3928             recs.recompute()
3929
3930         self.step_workflow(cr, user, ids, context=context)
3931         return True
3932
3933     #
3934     # TODO: Should set perm to user.xxx
3935     #
3936     @api.model
3937     @api.returns('self', lambda value: value.id)
3938     def create(self, vals):
3939         """ create(vals) -> record
3940
3941         Creates a new record for the model.
3942
3943         The new record is initialized using the values from ``vals`` and
3944         if necessary those from :meth:`~.default_get`.
3945
3946         :param dict vals:
3947             values for the model's fields, as a dictionary::
3948
3949                 {'field_name': field_value, ...}
3950
3951             see :meth:`~.write` for details
3952         :return: new record created
3953         :raise AccessError: * if user has no create rights on the requested object
3954                             * if user tries to bypass access rules for create on the requested object
3955         :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3956         :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)
3957         """
3958         self.check_access_rights('create')
3959
3960         # add missing defaults, and drop fields that may not be set by user
3961         vals = self._add_missing_default_values(vals)
3962         for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3963             vals.pop(field, None)
3964
3965         # split up fields into old-style and pure new-style ones
3966         old_vals, new_vals, unknown = {}, {}, []
3967         for key, val in vals.iteritems():
3968             if key in self._all_columns:
3969                 old_vals[key] = val
3970             elif key in self._fields:
3971                 new_vals[key] = val
3972             else:
3973                 unknown.append(key)
3974
3975         if unknown:
3976             _logger.warning("%s.create() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3977
3978         # create record with old-style fields
3979         record = self.browse(self._create(old_vals))
3980
3981         # put the values of pure new-style fields into cache, and inverse them
3982         record._cache.update(record._convert_to_cache(new_vals))
3983         for key in new_vals:
3984             self._fields[key].determine_inverse(record)
3985
3986         return record
3987
3988     def _create(self, cr, user, vals, context=None):
3989         # low-level implementation of create()
3990         if not context:
3991             context = {}
3992
3993         if self.is_transient():
3994             self._transient_vacuum(cr, user)
3995
3996         tocreate = {}
3997         for v in self._inherits:
3998             if self._inherits[v] not in vals:
3999                 tocreate[v] = {}
4000             else:
4001                 tocreate[v] = {'id': vals[self._inherits[v]]}
4002
4003         updates = [
4004             # list of column assignments defined as tuples like:
4005             #   (column_name, format_string, column_value)
4006             #   (column_name, sql_formula)
4007             # Those tuples will be used by the string formatting for the INSERT
4008             # statement below.
4009             ('id', "nextval('%s')" % self._sequence),
4010         ]
4011
4012         upd_todo = []
4013         unknown_fields = []
4014         for v in vals.keys():
4015             if v in self._inherit_fields and v not in self._columns:
4016                 (table, col, col_detail, original_parent) = self._inherit_fields[v]
4017                 tocreate[table][v] = vals[v]
4018                 del vals[v]
4019             else:
4020                 if (v not in self._inherit_fields) and (v not in self._columns):
4021                     del vals[v]
4022                     unknown_fields.append(v)
4023         if unknown_fields:
4024             _logger.warning(
4025                 'No such field(s) in model %s: %s.',
4026                 self._name, ', '.join(unknown_fields))
4027
4028         for table in tocreate:
4029             if self._inherits[table] in vals:
4030                 del vals[self._inherits[table]]
4031
4032             record_id = tocreate[table].pop('id', None)
4033
4034             if record_id is None or not record_id:
4035                 record_id = self.pool[table].create(cr, user, tocreate[table], context=context)
4036             else:
4037                 self.pool[table].write(cr, user, [record_id], tocreate[table], context=context)
4038
4039             updates.append((self._inherits[table], '%s', record_id))
4040
4041         #Start : Set bool fields to be False if they are not touched(to make search more powerful)
4042         bool_fields = [x for x in self._columns.keys() if self._columns[x]._type=='boolean']
4043
4044         for bool_field in bool_fields:
4045             if bool_field not in vals:
4046                 vals[bool_field] = False
4047         #End
4048         for field in vals.keys():
4049             fobj = None
4050             if field in self._columns:
4051                 fobj = self._columns[field]
4052             else:
4053                 fobj = self._inherit_fields[field][2]
4054             if not fobj:
4055                 continue
4056             groups = fobj.write
4057             if groups:
4058                 edit = False
4059                 for group in groups:
4060                     module = group.split(".")[0]
4061                     grp = group.split(".")[1]
4062                     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" % \
4063                                (grp, module, 'res.groups', user))
4064                     readonly = cr.fetchall()
4065                     if readonly[0][0] >= 1:
4066                         edit = True
4067                         break
4068                     elif readonly[0][0] == 0:
4069                         edit = False
4070                     else:
4071                         edit = False
4072
4073                 if not edit:
4074                     vals.pop(field)
4075         for field in vals:
4076             current_field = self._columns[field]
4077             if current_field._classic_write:
4078                 updates.append((field, '%s', current_field._symbol_set[1](vals[field])))
4079
4080                 #for the function fields that receive a value, we set them directly in the database
4081                 #(they may be required), but we also need to trigger the _fct_inv()
4082                 if (hasattr(current_field, '_fnct_inv')) and not isinstance(current_field, fields.related):
4083                     #TODO: this way to special case the related fields is really creepy but it shouldn't be changed at
4084                     #one week of the release candidate. It seems the only good way to handle correctly this is to add an
4085                     #attribute to make a field `really readonly´ and thus totally ignored by the create()... otherwise
4086                     #if, for example, the related has a default value (for usability) then the fct_inv is called and it
4087                     #may raise some access rights error. Changing this is a too big change for now, and is thus postponed
4088                     #after the release but, definitively, the behavior shouldn't be different for related and function
4089                     #fields.
4090                     upd_todo.append(field)
4091             else:
4092                 #TODO: this `if´ statement should be removed because there is no good reason to special case the fields
4093                 #related. See the above TODO comment for further explanations.
4094                 if not isinstance(current_field, fields.related):
4095                     upd_todo.append(field)
4096             if field in self._columns \
4097                     and hasattr(current_field, 'selection') \
4098                     and vals[field]:
4099                 self._check_selection_field_value(cr, user, field, vals[field], context=context)
4100         if self._log_access:
4101             updates.append(('create_uid', '%s', user))
4102             updates.append(('write_uid', '%s', user))
4103             updates.append(('create_date', "(now() at time zone 'UTC')"))
4104             updates.append(('write_date', "(now() at time zone 'UTC')"))
4105
4106         # the list of tuples used in this formatting corresponds to
4107         # tuple(field_name, format, value)
4108         # In some case, for example (id, create_date, write_date) we does not
4109         # need to read the third value of the tuple, because the real value is
4110         # encoded in the second value (the format).
4111         cr.execute(
4112             """INSERT INTO "%s" (%s) VALUES(%s) RETURNING id""" % (
4113                 self._table,
4114                 ', '.join('"%s"' % u[0] for u in updates),
4115                 ', '.join(u[1] for u in updates)
4116             ),
4117             tuple([u[2] for u in updates if len(u) > 2])
4118         )
4119
4120         id_new, = cr.fetchone()
4121         recs = self.browse(cr, user, id_new, context)
4122         upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
4123
4124         if self._parent_store and not context.get('defer_parent_store_computation'):
4125             if self.pool._init:
4126                 self.pool._init_parent[self._name] = True
4127             else:
4128                 parent = vals.get(self._parent_name, False)
4129                 if parent:
4130                     cr.execute('select parent_right from '+self._table+' where '+self._parent_name+'=%s order by '+(self._parent_order or self._order), (parent,))
4131                     pleft_old = None
4132                     result_p = cr.fetchall()
4133                     for (pleft,) in result_p:
4134                         if not pleft:
4135                             break
4136                         pleft_old = pleft
4137                     if not pleft_old:
4138                         cr.execute('select parent_left from '+self._table+' where id=%s', (parent,))
4139                         pleft_old = cr.fetchone()[0]
4140                     pleft = pleft_old
4141                 else:
4142                     cr.execute('select max(parent_right) from '+self._table)
4143                     pleft = cr.fetchone()[0] or 0
4144                 cr.execute('update '+self._table+' set parent_left=parent_left+2 where parent_left>%s', (pleft,))
4145                 cr.execute('update '+self._table+' set parent_right=parent_right+2 where parent_right>%s', (pleft,))
4146                 cr.execute('update '+self._table+' set parent_left=%s,parent_right=%s where id=%s', (pleft+1, pleft+2, id_new))
4147                 recs.invalidate_cache(['parent_left', 'parent_right'])
4148
4149         # default element in context must be remove when call a one2many or many2many
4150         rel_context = context.copy()
4151         for c in context.items():
4152             if c[0].startswith('default_'):
4153                 del rel_context[c[0]]
4154
4155         result = []
4156         for field in upd_todo:
4157             result += self._columns[field].set(cr, self, id_new, field, vals[field], user, rel_context) or []
4158
4159         # check Python constraints
4160         recs._validate_fields(vals)
4161
4162         # invalidate and mark new-style fields to recompute
4163         modified_fields = list(vals)
4164         if self._log_access:
4165             modified_fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
4166         recs.modified(modified_fields)
4167
4168         if context.get('recompute', True):
4169             result += self._store_get_values(cr, user, [id_new],
4170                 list(set(vals.keys() + self._inherits.values())),
4171                 context)
4172             result.sort()
4173             done = []
4174             for order, model_name, ids, fields2 in result:
4175                 if not (model_name, ids, fields2) in done:
4176                     self.pool[model_name]._store_set_values(cr, user, ids, fields2, context)
4177                     done.append((model_name, ids, fields2))
4178             # recompute new-style fields
4179             recs.recompute()
4180
4181         if self._log_create and context.get('recompute', True):
4182             message = self._description + \
4183                 " '" + \
4184                 self.name_get(cr, user, [id_new], context=context)[0][1] + \
4185                 "' " + _("created.")
4186             self.log(cr, user, id_new, message, True, context=context)
4187
4188         self.check_access_rule(cr, user, [id_new], 'create', context=context)
4189         self.create_workflow(cr, user, [id_new], context=context)
4190         return id_new
4191
4192     def _store_get_values(self, cr, uid, ids, fields, context):
4193         """Returns an ordered list of fields.function to call due to
4194            an update operation on ``fields`` of records with ``ids``,
4195            obtained by calling the 'store' triggers of these fields,
4196            as setup by their 'store' attribute.
4197
4198            :return: [(priority, model_name, [record_ids,], [function_fields,])]
4199         """
4200         if fields is None: fields = []
4201         stored_functions = self.pool._store_function.get(self._name, [])
4202
4203         # use indexed names for the details of the stored_functions:
4204         model_name_, func_field_to_compute_, target_ids_func_, trigger_fields_, priority_ = range(5)
4205
4206         # only keep store triggers that should be triggered for the ``fields``
4207         # being written to.
4208         triggers_to_compute = (
4209             f for f in stored_functions
4210             if not f[trigger_fields_] or set(fields).intersection(f[trigger_fields_])
4211         )
4212
4213         to_compute_map = {}
4214         target_id_results = {}
4215         for store_trigger in triggers_to_compute:
4216             target_func_id_ = id(store_trigger[target_ids_func_])
4217             if target_func_id_ not in target_id_results:
4218                 # use admin user for accessing objects having rules defined on store fields
4219                 target_id_results[target_func_id_] = [i for i in store_trigger[target_ids_func_](self, cr, SUPERUSER_ID, ids, context) if i]
4220             target_ids = target_id_results[target_func_id_]
4221
4222             # the compound key must consider the priority and model name
4223             key = (store_trigger[priority_], store_trigger[model_name_])
4224             for target_id in target_ids:
4225                 to_compute_map.setdefault(key, {}).setdefault(target_id,set()).add(tuple(store_trigger))
4226
4227         # Here to_compute_map looks like:
4228         # { (10, 'model_a') : { target_id1: [ (trigger_1_tuple, trigger_2_tuple) ], ... }
4229         #   (20, 'model_a') : { target_id2: [ (trigger_3_tuple, trigger_4_tuple) ], ... }
4230         #   (99, 'model_a') : { target_id1: [ (trigger_5_tuple, trigger_6_tuple) ], ... }
4231         # }
4232
4233         # Now we need to generate the batch function calls list
4234         # call_map =
4235         #   { (10, 'model_a') : [(10, 'model_a', [record_ids,], [function_fields,])] }
4236         call_map = {}
4237         for ((priority,model), id_map) in to_compute_map.iteritems():
4238             trigger_ids_maps = {}
4239             # function_ids_maps =
4240             #   { (function_1_tuple, function_2_tuple) : [target_id1, target_id2, ..] }
4241             for target_id, triggers in id_map.iteritems():
4242                 trigger_ids_maps.setdefault(tuple(triggers), []).append(target_id)
4243             for triggers, target_ids in trigger_ids_maps.iteritems():
4244                 call_map.setdefault((priority,model),[]).append((priority, model, target_ids,
4245                                                                  [t[func_field_to_compute_] for t in triggers]))
4246         result = []
4247         if call_map:
4248             result = reduce(operator.add, (call_map[k] for k in sorted(call_map)))
4249         return result
4250
4251     def _store_set_values(self, cr, uid, ids, fields, context):
4252         """Calls the fields.function's "implementation function" for all ``fields``, on records with ``ids`` (taking care of
4253            respecting ``multi`` attributes), and stores the resulting values in the database directly."""
4254         if not ids:
4255             return True
4256         field_flag = False
4257         field_dict = {}
4258         if self._log_access:
4259             cr.execute('select id,write_date from '+self._table+' where id IN %s', (tuple(ids),))
4260             res = cr.fetchall()
4261             for r in res:
4262                 if r[1]:
4263                     field_dict.setdefault(r[0], [])
4264                     res_date = time.strptime((r[1])[:19], '%Y-%m-%d %H:%M:%S')
4265                     write_date = datetime.datetime.fromtimestamp(time.mktime(res_date))
4266                     for i in self.pool._store_function.get(self._name, []):
4267                         if i[5]:
4268                             up_write_date = write_date + datetime.timedelta(hours=i[5])
4269                             if datetime.datetime.now() < up_write_date:
4270                                 if i[1] in fields:
4271                                     field_dict[r[0]].append(i[1])
4272                                     if not field_flag:
4273                                         field_flag = True
4274         todo = {}
4275         keys = []
4276         for f in fields:
4277             if self._columns[f]._multi not in keys:
4278                 keys.append(self._columns[f]._multi)
4279             todo.setdefault(self._columns[f]._multi, [])
4280             todo[self._columns[f]._multi].append(f)
4281         for key in keys:
4282             val = todo[key]
4283             if key:
4284                 # use admin user for accessing objects having rules defined on store fields
4285                 result = self._columns[val[0]].get(cr, self, ids, val, SUPERUSER_ID, context=context)
4286                 for id, value in result.items():
4287                     if field_flag:
4288                         for f in value.keys():
4289                             if f in field_dict[id]:
4290                                 value.pop(f)
4291                     upd0 = []
4292                     upd1 = []
4293                     for v in value:
4294                         if v not in val:
4295                             continue
4296                         if self._columns[v]._type == 'many2one':
4297                             try:
4298                                 value[v] = value[v][0]
4299                             except:
4300                                 pass
4301                         upd0.append('"'+v+'"='+self._columns[v]._symbol_set[0])
4302                         upd1.append(self._columns[v]._symbol_set[1](value[v]))
4303                     upd1.append(id)
4304                     if upd0 and upd1:
4305                         cr.execute('update "' + self._table + '" set ' + \
4306                             ','.join(upd0) + ' where id = %s', upd1)
4307
4308             else:
4309                 for f in val:
4310                     # use admin user for accessing objects having rules defined on store fields
4311                     result = self._columns[f].get(cr, self, ids, f, SUPERUSER_ID, context=context)
4312                     for r in result.keys():
4313                         if field_flag:
4314                             if r in field_dict.keys():
4315                                 if f in field_dict[r]:
4316                                     result.pop(r)
4317                     for id, value in result.items():
4318                         if self._columns[f]._type == 'many2one':
4319                             try:
4320                                 value = value[0]
4321                             except:
4322                                 pass
4323                         cr.execute('update "' + self._table + '" set ' + \
4324                             '"'+f+'"='+self._columns[f]._symbol_set[0] + ' where id = %s', (self._columns[f]._symbol_set[1](value), id))
4325
4326         # invalidate and mark new-style fields to recompute
4327         self.browse(cr, uid, ids, context).modified(fields)
4328
4329         return True
4330
4331     # TODO: ameliorer avec NULL
4332     def _where_calc(self, cr, user, domain, active_test=True, context=None):
4333         """Computes the WHERE clause needed to implement an OpenERP domain.
4334         :param domain: the domain to compute
4335         :type domain: list
4336         :param active_test: whether the default filtering of records with ``active``
4337                             field set to ``False`` should be applied.
4338         :return: the query expressing the given domain as provided in domain
4339         :rtype: osv.query.Query
4340         """
4341         if not context:
4342             context = {}
4343         domain = domain[:]
4344         # if the object has a field named 'active', filter out all inactive
4345         # records unless they were explicitely asked for
4346         if 'active' in self._all_columns and (active_test and context.get('active_test', True)):
4347             if domain:
4348                 # the item[0] trick below works for domain items and '&'/'|'/'!'
4349                 # operators too
4350                 if not any(item[0] == 'active' for item in domain):
4351                     domain.insert(0, ('active', '=', 1))
4352             else:
4353                 domain = [('active', '=', 1)]
4354
4355         if domain:
4356             e = expression.expression(cr, user, domain, self, context)
4357             tables = e.get_tables()
4358             where_clause, where_params = e.to_sql()
4359             where_clause = where_clause and [where_clause] or []
4360         else:
4361             where_clause, where_params, tables = [], [], ['"%s"' % self._table]
4362
4363         return Query(tables, where_clause, where_params)
4364
4365     def _check_qorder(self, word):
4366         if not regex_order.match(word):
4367             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)'))
4368         return True
4369
4370     def _apply_ir_rules(self, cr, uid, query, mode='read', context=None):
4371         """Add what's missing in ``query`` to implement all appropriate ir.rules
4372           (using the ``model_name``'s rules or the current model's rules if ``model_name`` is None)
4373
4374            :param query: the current query object
4375         """
4376         if uid == SUPERUSER_ID:
4377             return
4378
4379         def apply_rule(added_clause, added_params, added_tables, parent_model=None):
4380             """ :param parent_model: name of the parent model, if the added
4381                     clause comes from a parent model
4382             """
4383             if added_clause:
4384                 if parent_model:
4385                     # as inherited rules are being applied, we need to add the missing JOIN
4386                     # to reach the parent table (if it was not JOINed yet in the query)
4387                     parent_alias = self._inherits_join_add(self, parent_model, query)
4388                     # inherited rules are applied on the external table -> need to get the alias and replace
4389                     parent_table = self.pool[parent_model]._table
4390                     added_clause = [clause.replace('"%s"' % parent_table, '"%s"' % parent_alias) for clause in added_clause]
4391                     # change references to parent_table to parent_alias, because we now use the alias to refer to the table
4392                     new_tables = []
4393                     for table in added_tables:
4394                         # table is just a table name -> switch to the full alias
4395                         if table == '"%s"' % parent_table:
4396                             new_tables.append('"%s" as "%s"' % (parent_table, parent_alias))
4397                         # table is already a full statement -> replace reference to the table to its alias, is correct with the way aliases are generated
4398                         else:
4399                             new_tables.append(table.replace('"%s"' % parent_table, '"%s"' % parent_alias))
4400                     added_tables = new_tables
4401                 query.where_clause += added_clause
4402                 query.where_clause_params += added_params
4403                 for table in added_tables:
4404                     if table not in query.tables:
4405                         query.tables.append(table)
4406                 return True
4407             return False
4408
4409         # apply main rules on the object
4410         rule_obj = self.pool.get('ir.rule')
4411         rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, self._name, mode, context=context)
4412         apply_rule(rule_where_clause, rule_where_clause_params, rule_tables)
4413
4414         # apply ir.rules from the parents (through _inherits)
4415         for inherited_model in self._inherits:
4416             rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, inherited_model, mode, context=context)
4417             apply_rule(rule_where_clause, rule_where_clause_params, rule_tables,
4418                         parent_model=inherited_model)
4419
4420     def _generate_m2o_order_by(self, order_field, query):
4421         """
4422         Add possibly missing JOIN to ``query`` and generate the ORDER BY clause for m2o fields,
4423         either native m2o fields or function/related fields that are stored, including
4424         intermediate JOINs for inheritance if required.
4425
4426         :return: the qualified field name to use in an ORDER BY clause to sort by ``order_field``
4427         """
4428         if order_field not in self._columns and order_field in self._inherit_fields:
4429             # also add missing joins for reaching the table containing the m2o field
4430             qualified_field = self._inherits_join_calc(order_field, query)
4431             order_field_column = self._inherit_fields[order_field][2]
4432         else:
4433             qualified_field = '"%s"."%s"' % (self._table, order_field)
4434             order_field_column = self._columns[order_field]
4435
4436         assert order_field_column._type == 'many2one', 'Invalid field passed to _generate_m2o_order_by()'
4437         if not order_field_column._classic_write and not getattr(order_field_column, 'store', False):
4438             _logger.debug("Many2one function/related fields must be stored " \
4439                 "to be used as ordering fields! Ignoring sorting for %s.%s",
4440                 self._name, order_field)
4441             return
4442
4443         # figure out the applicable order_by for the m2o
4444         dest_model = self.pool[order_field_column._obj]
4445         m2o_order = dest_model._order
4446         if not regex_order.match(m2o_order):
4447             # _order is complex, can't use it here, so we default to _rec_name
4448             m2o_order = dest_model._rec_name
4449         else:
4450             # extract the field names, to be able to qualify them and add desc/asc
4451             m2o_order_list = []
4452             for order_part in m2o_order.split(","):
4453                 m2o_order_list.append(order_part.strip().split(" ", 1)[0].strip())
4454             m2o_order = m2o_order_list
4455
4456         # Join the dest m2o table if it's not joined yet. We use [LEFT] OUTER join here
4457         # as we don't want to exclude results that have NULL values for the m2o
4458         src_table, src_field = qualified_field.replace('"', '').split('.', 1)
4459         dst_alias, dst_alias_statement = query.add_join((src_table, dest_model._table, src_field, 'id', src_field), implicit=False, outer=True)
4460         qualify = lambda field: '"%s"."%s"' % (dst_alias, field)
4461         return map(qualify, m2o_order) if isinstance(m2o_order, list) else qualify(m2o_order)
4462
4463     def _generate_order_by(self, order_spec, query):
4464         """
4465         Attempt to consruct an appropriate ORDER BY clause based on order_spec, which must be
4466         a comma-separated list of valid field names, optionally followed by an ASC or DESC direction.
4467
4468         :raise" except_orm in case order_spec is malformed
4469         """
4470         order_by_clause = ''
4471         order_spec = order_spec or self._order
4472         if order_spec:
4473             order_by_elements = []
4474             self._check_qorder(order_spec)
4475             for order_part in order_spec.split(','):
4476                 order_split = order_part.strip().split(' ')
4477                 order_field = order_split[0].strip()
4478                 order_direction = order_split[1].strip() if len(order_split) == 2 else ''
4479                 order_column = None
4480                 inner_clause = None
4481                 if order_field == 'id':
4482                     order_by_elements.append('"%s"."%s" %s' % (self._table, order_field, order_direction))
4483                 elif order_field in self._columns:
4484                     order_column = self._columns[order_field]
4485                     if order_column._classic_read:
4486                         inner_clause = '"%s"."%s"' % (self._table, order_field)
4487                     elif order_column._type == 'many2one':
4488                         inner_clause = self._generate_m2o_order_by(order_field, query)
4489                     else:
4490                         continue  # ignore non-readable or "non-joinable" fields
4491                 elif order_field in self._inherit_fields:
4492                     parent_obj = self.pool[self._inherit_fields[order_field][3]]
4493                     order_column = parent_obj._columns[order_field]
4494                     if order_column._classic_read:
4495                         inner_clause = self._inherits_join_calc(order_field, query)
4496                     elif order_column._type == 'many2one':
4497                         inner_clause = self._generate_m2o_order_by(order_field, query)
4498                     else:
4499                         continue  # ignore non-readable or "non-joinable" fields
4500                 else:
4501                     raise ValueError( _("Sorting field %s not found on model %s") %( order_field, self._name))
4502                 if order_column and order_column._type == 'boolean':
4503                     inner_clause = "COALESCE(%s, false)" % inner_clause
4504                 if inner_clause:
4505                     if isinstance(inner_clause, list):
4506                         for clause in inner_clause:
4507                             order_by_elements.append("%s %s" % (clause, order_direction))
4508                     else:
4509                         order_by_elements.append("%s %s" % (inner_clause, order_direction))
4510             if order_by_elements:
4511                 order_by_clause = ",".join(order_by_elements)
4512
4513         return order_by_clause and (' ORDER BY %s ' % order_by_clause) or ''
4514
4515     def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
4516         """
4517         Private implementation of search() method, allowing specifying the uid to use for the access right check.
4518         This is useful for example when filling in the selection list for a drop-down and avoiding access rights errors,
4519         by specifying ``access_rights_uid=1`` to bypass access rights check, but not ir.rules!
4520         This is ok at the security level because this method is private and not callable through XML-RPC.
4521
4522         :param access_rights_uid: optional user ID to use when checking access rights
4523                                   (not for ir.rules, this is only for ir.model.access)
4524         """
4525         if context is None:
4526             context = {}
4527         self.check_access_rights(cr, access_rights_uid or user, 'read')
4528
4529         # For transient models, restrict acces to the current user, except for the super-user
4530         if self.is_transient() and self._log_access and user != SUPERUSER_ID:
4531             args = expression.AND(([('create_uid', '=', user)], args or []))
4532
4533         query = self._where_calc(cr, user, args, context=context)
4534         self._apply_ir_rules(cr, user, query, 'read', context=context)
4535         order_by = self._generate_order_by(order, query)
4536         from_clause, where_clause, where_clause_params = query.get_sql()
4537
4538         where_str = where_clause and (" WHERE %s" % where_clause) or ''
4539
4540         if count:
4541             # Ignore order, limit and offset when just counting, they don't make sense and could
4542             # hurt performance
4543             query_str = 'SELECT count(1) FROM ' + from_clause + where_str
4544             cr.execute(query_str, where_clause_params)
4545             res = cr.fetchone()
4546             return res[0]
4547
4548         limit_str = limit and ' limit %d' % limit or ''
4549         offset_str = offset and ' offset %d' % offset or ''
4550         query_str = 'SELECT "%s".id FROM ' % self._table + from_clause + where_str + order_by + limit_str + offset_str
4551         cr.execute(query_str, where_clause_params)
4552         res = cr.fetchall()
4553
4554         # TDE note: with auto_join, we could have several lines about the same result
4555         # i.e. a lead with several unread messages; we uniquify the result using
4556         # a fast way to do it while preserving order (http://www.peterbe.com/plog/uniqifiers-benchmark)
4557         def _uniquify_list(seq):
4558             seen = set()
4559             return [x for x in seq if x not in seen and not seen.add(x)]
4560
4561         return _uniquify_list([x[0] for x in res])
4562
4563     # returns the different values ever entered for one field
4564     # this is used, for example, in the client when the user hits enter on
4565     # a char field
4566     def distinct_field_get(self, cr, uid, field, value, args=None, offset=0, limit=None):
4567         if not args:
4568             args = []
4569         if field in self._inherit_fields:
4570             return self.pool[self._inherit_fields[field][0]].distinct_field_get(cr, uid, field, value, args, offset, limit)
4571         else:
4572             return self._columns[field].search(cr, self, args, field, value, offset, limit, uid)
4573
4574     def copy_data(self, cr, uid, id, default=None, context=None):
4575         """
4576         Copy given record's data with all its fields values
4577
4578         :param cr: database cursor
4579         :param uid: current user id
4580         :param id: id of the record to copy
4581         :param default: field values to override in the original values of the copied record
4582         :type default: dictionary
4583         :param context: context arguments, like lang, time zone
4584         :type context: dictionary
4585         :return: dictionary containing all the field values
4586         """
4587
4588         if context is None:
4589             context = {}
4590
4591         # avoid recursion through already copied records in case of circular relationship
4592         seen_map = context.setdefault('__copy_data_seen', {})
4593         if id in seen_map.setdefault(self._name, []):
4594             return
4595         seen_map[self._name].append(id)
4596
4597         if default is None:
4598             default = {}
4599         if 'state' not in default:
4600             if 'state' in self._defaults:
4601                 if callable(self._defaults['state']):
4602                     default['state'] = self._defaults['state'](self, cr, uid, context)
4603                 else:
4604                     default['state'] = self._defaults['state']
4605
4606         # build a black list of fields that should not be copied
4607         blacklist = set(MAGIC_COLUMNS + ['parent_left', 'parent_right'])
4608         def blacklist_given_fields(obj):
4609             # blacklist the fields that are given by inheritance
4610             for other, field_to_other in obj._inherits.items():
4611                 blacklist.add(field_to_other)
4612                 if field_to_other in default:
4613                     # all the fields of 'other' are given by the record: default[field_to_other],
4614                     # except the ones redefined in self
4615                     blacklist.update(set(self.pool[other]._all_columns) - set(self._columns))
4616                 else:
4617                     blacklist_given_fields(self.pool[other])
4618             # blacklist deprecated fields
4619             for name, field in obj._columns.items():
4620                 if field.deprecated:
4621                     blacklist.add(name)
4622
4623         blacklist_given_fields(self)
4624
4625
4626         fields_to_copy = dict((f,fi) for f, fi in self._all_columns.iteritems()
4627                                      if fi.column.copy
4628                                      if f not in default
4629                                      if f not in blacklist)
4630
4631         data = self.read(cr, uid, [id], fields_to_copy.keys(), context=context)
4632         if data:
4633             data = data[0]
4634         else:
4635             raise IndexError( _("Record #%d of %s not found, cannot copy!") %( id, self._name))
4636
4637         res = dict(default)
4638         for f, colinfo in fields_to_copy.iteritems():
4639             field = colinfo.column
4640             if field._type == 'many2one':
4641                 res[f] = data[f] and data[f][0]
4642             elif field._type == 'one2many':
4643                 other = self.pool[field._obj]
4644                 # duplicate following the order of the ids because we'll rely on
4645                 # it later for copying translations in copy_translation()!
4646                 lines = [other.copy_data(cr, uid, line_id, context=context) for line_id in sorted(data[f])]
4647                 # the lines are duplicated using the wrong (old) parent, but then
4648                 # are reassigned to the correct one thanks to the (0, 0, ...)
4649                 res[f] = [(0, 0, line) for line in lines if line]
4650             elif field._type == 'many2many':
4651                 res[f] = [(6, 0, data[f])]
4652             else:
4653                 res[f] = data[f]
4654
4655         return res
4656
4657     def copy_translations(self, cr, uid, old_id, new_id, context=None):
4658         if context is None:
4659             context = {}
4660
4661         # avoid recursion through already copied records in case of circular relationship
4662         seen_map = context.setdefault('__copy_translations_seen',{})
4663         if old_id in seen_map.setdefault(self._name,[]):
4664             return
4665         seen_map[self._name].append(old_id)
4666
4667         trans_obj = self.pool.get('ir.translation')
4668         # TODO it seems fields_get can be replaced by _all_columns (no need for translation)
4669         fields = self.fields_get(cr, uid, context=context)
4670
4671         for field_name, field_def in fields.items():
4672             # removing the lang to compare untranslated values
4673             context_wo_lang = dict(context, lang=None)
4674             old_record, new_record = self.browse(cr, uid, [old_id, new_id], context=context_wo_lang)
4675             # we must recursively copy the translations for o2o and o2m
4676             if field_def['type'] == 'one2many':
4677                 target_obj = self.pool[field_def['relation']]
4678                 # here we rely on the order of the ids to match the translations
4679                 # as foreseen in copy_data()
4680                 old_children = sorted(r.id for r in old_record[field_name])
4681                 new_children = sorted(r.id for r in new_record[field_name])
4682                 for (old_child, new_child) in zip(old_children, new_children):
4683                     target_obj.copy_translations(cr, uid, old_child, new_child, context=context)
4684             # and for translatable fields we keep them for copy
4685             elif field_def.get('translate'):
4686                 if field_name in self._columns:
4687                     trans_name = self._name + "," + field_name
4688                     target_id = new_id
4689                     source_id = old_id
4690                 elif field_name in self._inherit_fields:
4691                     trans_name = self._inherit_fields[field_name][0] + "," + field_name
4692                     # get the id of the parent record to set the translation
4693                     inherit_field_name = self._inherit_fields[field_name][1]
4694                     target_id = new_record[inherit_field_name].id
4695                     source_id = old_record[inherit_field_name].id
4696                 else:
4697                     continue
4698
4699                 trans_ids = trans_obj.search(cr, uid, [
4700                         ('name', '=', trans_name),
4701                         ('res_id', '=', source_id)
4702                 ])
4703                 user_lang = context.get('lang')
4704                 for record in trans_obj.read(cr, uid, trans_ids, context=context):
4705                     del record['id']
4706                     # remove source to avoid triggering _set_src
4707                     del record['source']
4708                     record.update({'res_id': target_id})
4709                     if user_lang and user_lang == record['lang']:
4710                         # 'source' to force the call to _set_src
4711                         # 'value' needed if value is changed in copy(), want to see the new_value
4712                         record['source'] = old_record[field_name]
4713                         record['value'] = new_record[field_name]
4714                     trans_obj.create(cr, uid, record, context=context)
4715
4716     @api.returns('self', lambda value: value.id)
4717     def copy(self, cr, uid, id, default=None, context=None):
4718         """ copy(default=None)
4719
4720         Duplicate record with given id updating it with default values
4721
4722         :param dict default: dictionary of field values to override in the
4723                original values of the copied record, e.g: ``{'field_name': overriden_value, ...}``
4724         :returns: new record
4725
4726         """
4727         if context is None:
4728             context = {}
4729         context = context.copy()
4730         data = self.copy_data(cr, uid, id, default, context)
4731         new_id = self.create(cr, uid, data, context)
4732         self.copy_translations(cr, uid, id, new_id, context)
4733         return new_id
4734
4735     @api.multi
4736     @api.returns('self')
4737     def exists(self):
4738         """  exists() -> records
4739
4740         Returns the subset of records in `self` that exist, and marks deleted
4741         records as such in cache. It can be used as a test on records::
4742
4743             if record.exists():
4744                 ...
4745
4746         By convention, new records are returned as existing.
4747         """
4748         ids = filter(None, self._ids)           # ids to check in database
4749         if not ids:
4750             return self
4751         query = """SELECT id FROM "%s" WHERE id IN %%s""" % self._table
4752         self._cr.execute(query, (ids,))
4753         ids = ([r[0] for r in self._cr.fetchall()] +    # ids in database
4754                [id for id in self._ids if not id])      # new ids
4755         existing = self.browse(ids)
4756         if len(existing) < len(self):
4757             # mark missing records in cache with a failed value
4758             exc = MissingError(_("Record does not exist or has been deleted."))
4759             (self - existing)._cache.update(FailedValue(exc))
4760         return existing
4761
4762     def check_recursion(self, cr, uid, ids, context=None, parent=None):
4763         _logger.warning("You are using deprecated %s.check_recursion(). Please use the '_check_recursion()' instead!" % \
4764                         self._name)
4765         assert parent is None or parent in self._columns or parent in self._inherit_fields,\
4766                     "The 'parent' parameter passed to check_recursion() must be None or a valid field name"
4767         return self._check_recursion(cr, uid, ids, context, parent)
4768
4769     def _check_recursion(self, cr, uid, ids, context=None, parent=None):
4770         """
4771         Verifies that there is no loop in a hierarchical structure of records,
4772         by following the parent relationship using the **parent** field until a loop
4773         is detected or until a top-level record is found.
4774
4775         :param cr: database cursor
4776         :param uid: current user id
4777         :param ids: list of ids of records to check
4778         :param parent: optional parent field name (default: ``self._parent_name = parent_id``)
4779         :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4780         """
4781         if not parent:
4782             parent = self._parent_name
4783
4784         # must ignore 'active' flag, ir.rules, etc. => direct SQL query
4785         query = 'SELECT "%s" FROM "%s" WHERE id = %%s' % (parent, self._table)
4786         for id in ids:
4787             current_id = id
4788             while current_id is not None:
4789                 cr.execute(query, (current_id,))
4790                 result = cr.fetchone()
4791                 current_id = result[0] if result else None
4792                 if current_id == id:
4793                     return False
4794         return True
4795
4796     def _check_m2m_recursion(self, cr, uid, ids, field_name):
4797         """
4798         Verifies that there is no loop in a hierarchical structure of records,
4799         by following the parent relationship using the **parent** field until a loop
4800         is detected or until a top-level record is found.
4801
4802         :param cr: database cursor
4803         :param uid: current user id
4804         :param ids: list of ids of records to check
4805         :param field_name: field to check
4806         :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4807         """
4808
4809         field = self._all_columns.get(field_name)
4810         field = field.column if field else None
4811         if not field or field._type != 'many2many' or field._obj != self._name:
4812             # field must be a many2many on itself
4813             raise ValueError('invalid field_name: %r' % (field_name,))
4814
4815         query = 'SELECT distinct "%s" FROM "%s" WHERE "%s" IN %%s' % (field._id2, field._rel, field._id1)
4816         ids_parent = ids[:]
4817         while ids_parent:
4818             ids_parent2 = []
4819             for i in range(0, len(ids_parent), cr.IN_MAX):
4820                 j = i + cr.IN_MAX
4821                 sub_ids_parent = ids_parent[i:j]
4822                 cr.execute(query, (tuple(sub_ids_parent),))
4823                 ids_parent2.extend(filter(None, map(lambda x: x[0], cr.fetchall())))
4824             ids_parent = ids_parent2
4825             for i in ids_parent:
4826                 if i in ids:
4827                     return False
4828         return True
4829
4830     def _get_external_ids(self, cr, uid, ids, *args, **kwargs):
4831         """Retrieve the External ID(s) of any database record.
4832
4833         **Synopsis**: ``_get_xml_ids(cr, uid, ids) -> { 'id': ['module.xml_id'] }``
4834
4835         :return: map of ids to the list of their fully qualified External IDs
4836                  in the form ``module.key``, or an empty list when there's no External
4837                  ID for a record, e.g.::
4838
4839                      { 'id': ['module.ext_id', 'module.ext_id_bis'],
4840                        'id2': [] }
4841         """
4842         ir_model_data = self.pool.get('ir.model.data')
4843         data_ids = ir_model_data.search(cr, uid, [('model', '=', self._name), ('res_id', 'in', ids)])
4844         data_results = ir_model_data.read(cr, uid, data_ids, ['module', 'name', 'res_id'])
4845         result = {}
4846         for id in ids:
4847             # can't use dict.fromkeys() as the list would be shared!
4848             result[id] = []
4849         for record in data_results:
4850             result[record['res_id']].append('%(module)s.%(name)s' % record)
4851         return result
4852
4853     def get_external_id(self, cr, uid, ids, *args, **kwargs):
4854         """Retrieve the External ID of any database record, if there
4855         is one. This method works as a possible implementation
4856         for a function field, to be able to add it to any
4857         model object easily, referencing it as ``Model.get_external_id``.
4858
4859         When multiple External IDs exist for a record, only one
4860         of them is returned (randomly).
4861
4862         :return: map of ids to their fully qualified XML ID,
4863                  defaulting to an empty string when there's none
4864                  (to be usable as a function field),
4865                  e.g.::
4866
4867                      { 'id': 'module.ext_id',
4868                        'id2': '' }
4869         """
4870         results = self._get_xml_ids(cr, uid, ids)
4871         for k, v in results.iteritems():
4872             if results[k]:
4873                 results[k] = v[0]
4874             else:
4875                 results[k] = ''
4876         return results
4877
4878     # backwards compatibility
4879     get_xml_id = get_external_id
4880     _get_xml_ids = _get_external_ids
4881
4882     def print_report(self, cr, uid, ids, name, data, context=None):
4883         """
4884         Render the report `name` for the given IDs. The report must be defined
4885         for this model, not another.
4886         """
4887         report = self.pool['ir.actions.report.xml']._lookup_report(cr, name)
4888         assert self._name == report.table
4889         return report.create(cr, uid, ids, data, context)
4890
4891     # Transience
4892     @classmethod
4893     def is_transient(cls):
4894         """ Return whether the model is transient.
4895
4896         See :class:`TransientModel`.
4897
4898         """
4899         return cls._transient
4900
4901     def _transient_clean_rows_older_than(self, cr, seconds):
4902         assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4903         # Never delete rows used in last 5 minutes
4904         seconds = max(seconds, 300)
4905         query = ("SELECT id FROM " + self._table + " WHERE"
4906             " COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp"
4907             " < ((now() at time zone 'UTC') - interval %s)")
4908         cr.execute(query, ("%s seconds" % seconds,))
4909         ids = [x[0] for x in cr.fetchall()]
4910         self.unlink(cr, SUPERUSER_ID, ids)
4911
4912     def _transient_clean_old_rows(self, cr, max_count):
4913         # Check how many rows we have in the table
4914         cr.execute("SELECT count(*) AS row_count FROM " + self._table)
4915         res = cr.fetchall()
4916         if res[0][0] <= max_count:
4917             return  # max not reached, nothing to do
4918         self._transient_clean_rows_older_than(cr, 300)
4919
4920     def _transient_vacuum(self, cr, uid, force=False):
4921         """Clean the transient records.
4922
4923         This unlinks old records from the transient model tables whenever the
4924         "_transient_max_count" or "_max_age" conditions (if any) are reached.
4925         Actual cleaning will happen only once every "_transient_check_time" calls.
4926         This means this method can be called frequently called (e.g. whenever
4927         a new record is created).
4928         Example with both max_hours and max_count active:
4929         Suppose max_hours = 0.2 (e.g. 12 minutes), max_count = 20, there are 55 rows in the
4930         table, 10 created/changed in the last 5 minutes, an additional 12 created/changed between
4931         5 and 10 minutes ago, the rest created/changed more then 12 minutes ago.
4932         - age based vacuum will leave the 22 rows created/changed in the last 12 minutes
4933         - count based vacuum will wipe out another 12 rows. Not just 2, otherwise each addition
4934           would immediately cause the maximum to be reached again.
4935         - the 10 rows that have been created/changed the last 5 minutes will NOT be deleted
4936         """
4937         assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4938         _transient_check_time = 20          # arbitrary limit on vacuum executions
4939         self._transient_check_count += 1
4940         if not force and (self._transient_check_count < _transient_check_time):
4941             return True  # no vacuum cleaning this time
4942         self._transient_check_count = 0
4943
4944         # Age-based expiration
4945         if self._transient_max_hours:
4946             self._transient_clean_rows_older_than(cr, self._transient_max_hours * 60 * 60)
4947
4948         # Count-based expiration
4949         if self._transient_max_count:
4950             self._transient_clean_old_rows(cr, self._transient_max_count)
4951
4952         return True
4953
4954     def resolve_2many_commands(self, cr, uid, field_name, commands, fields=None, context=None):
4955         """ Serializes one2many and many2many commands into record dictionaries
4956             (as if all the records came from the database via a read()).  This
4957             method is aimed at onchange methods on one2many and many2many fields.
4958
4959             Because commands might be creation commands, not all record dicts
4960             will contain an ``id`` field.  Commands matching an existing record
4961             will have an ``id``.
4962
4963             :param field_name: name of the one2many or many2many field matching the commands
4964             :type field_name: str
4965             :param commands: one2many or many2many commands to execute on ``field_name``
4966             :type commands: list((int|False, int|False, dict|False))
4967             :param fields: list of fields to read from the database, when applicable
4968             :type fields: list(str)
4969             :returns: records in a shape similar to that returned by ``read()``
4970                 (except records may be missing the ``id`` field if they don't exist in db)
4971             :rtype: list(dict)
4972         """
4973         result = []             # result (list of dict)
4974         record_ids = []         # ids of records to read
4975         updates = {}            # {id: dict} of updates on particular records
4976
4977         for command in commands or []:
4978             if not isinstance(command, (list, tuple)):
4979                 record_ids.append(command)
4980             elif command[0] == 0:
4981                 result.append(command[2])
4982             elif command[0] == 1:
4983                 record_ids.append(command[1])
4984                 updates.setdefault(command[1], {}).update(command[2])
4985             elif command[0] in (2, 3):
4986                 record_ids = [id for id in record_ids if id != command[1]]
4987             elif command[0] == 4:
4988                 record_ids.append(command[1])
4989             elif command[0] == 5:
4990                 result, record_ids = [], []
4991             elif command[0] == 6:
4992                 result, record_ids = [], list(command[2])
4993
4994         # read the records and apply the updates
4995         other_model = self.pool[self._all_columns[field_name].column._obj]
4996         for record in other_model.read(cr, uid, record_ids, fields=fields, context=context):
4997             record.update(updates.get(record['id'], {}))
4998             result.append(record)
4999
5000         return result
5001
5002     # for backward compatibility
5003     resolve_o2m_commands_to_record_dicts = resolve_2many_commands
5004
5005     def search_read(self, cr, uid, domain=None, fields=None, offset=0, limit=None, order=None, context=None):
5006         """
5007         Performs a ``search()`` followed by a ``read()``.
5008
5009         :param cr: database cursor
5010         :param user: current user id
5011         :param domain: Search domain, see ``args`` parameter in ``search()``. Defaults to an empty domain that will match all records.
5012         :param fields: List of fields to read, see ``fields`` parameter in ``read()``. Defaults to all fields.
5013         :param offset: Number of records to skip, see ``offset`` parameter in ``search()``. Defaults to 0.
5014         :param limit: Maximum number of records to return, see ``limit`` parameter in ``search()``. Defaults to no limit.
5015         :param order: Columns to sort result, see ``order`` parameter in ``search()``. Defaults to no sort.
5016         :param context: context arguments.
5017         :return: List of dictionaries containing the asked fields.
5018         :rtype: List of dictionaries.
5019
5020         """
5021         record_ids = self.search(cr, uid, domain or [], offset=offset, limit=limit, order=order, context=context)
5022         if not record_ids:
5023             return []
5024
5025         if fields and fields == ['id']:
5026             # shortcut read if we only want the ids
5027             return [{'id': id} for id in record_ids]
5028
5029         # read() ignores active_test, but it would forward it to any downstream search call
5030         # (e.g. for x2m or function fields), and this is not the desired behavior, the flag
5031         # was presumably only meant for the main search().
5032         # TODO: Move this to read() directly?
5033         read_ctx = dict(context or {})
5034         read_ctx.pop('active_test', None)
5035
5036         result = self.read(cr, uid, record_ids, fields, context=read_ctx)
5037         if len(result) <= 1:
5038             return result
5039
5040         # reorder read
5041         index = dict((r['id'], r) for r in result)
5042         return [index[x] for x in record_ids if x in index]
5043
5044     def _register_hook(self, cr):
5045         """ stuff to do right after the registry is built """
5046         pass
5047
5048     @classmethod
5049     def _patch_method(cls, name, method):
5050         """ Monkey-patch a method for all instances of this model. This replaces
5051             the method called `name` by `method` in the given class.
5052             The original method is then accessible via ``method.origin``, and it
5053             can be restored with :meth:`~._revert_method`.
5054
5055             Example::
5056
5057                 @api.multi
5058                 def do_write(self, values):
5059                     # do stuff, and call the original method
5060                     return do_write.origin(self, values)
5061
5062                 # patch method write of model
5063                 model._patch_method('write', do_write)
5064
5065                 # this will call do_write
5066                 records = model.search([...])
5067                 records.write(...)
5068
5069                 # restore the original method
5070                 model._revert_method('write')
5071         """
5072         origin = getattr(cls, name)
5073         method.origin = origin
5074         # propagate decorators from origin to method, and apply api decorator
5075         wrapped = api.guess(api.propagate(origin, method))
5076         wrapped.origin = origin
5077         setattr(cls, name, wrapped)
5078
5079     @classmethod
5080     def _revert_method(cls, name):
5081         """ Revert the original method called `name` in the given class.
5082             See :meth:`~._patch_method`.
5083         """
5084         method = getattr(cls, name)
5085         setattr(cls, name, method.origin)
5086
5087     #
5088     # Instance creation
5089     #
5090     # An instance represents an ordered collection of records in a given
5091     # execution environment. The instance object refers to the environment, and
5092     # the records themselves are represented by their cache dictionary. The 'id'
5093     # of each record is found in its corresponding cache dictionary.
5094     #
5095     # This design has the following advantages:
5096     #  - cache access is direct and thus fast;
5097     #  - one can consider records without an 'id' (see new records);
5098     #  - the global cache is only an index to "resolve" a record 'id'.
5099     #
5100
5101     @classmethod
5102     def _browse(cls, env, ids):
5103         """ Create an instance attached to `env`; `ids` is a tuple of record
5104             ids.
5105         """
5106         records = object.__new__(cls)
5107         records.env = env
5108         records._ids = ids
5109         env.prefetch[cls._name].update(ids)
5110         return records
5111
5112     @api.v7
5113     def browse(self, cr, uid, arg=None, context=None):
5114         ids = _normalize_ids(arg)
5115         #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5116         return self._browse(Environment(cr, uid, context or {}), ids)
5117
5118     @api.v8
5119     def browse(self, arg=None):
5120         """ browse([ids]) -> records
5121
5122         Returns a recordset for the ids provided as parameter in the current
5123         environment.
5124
5125         Can take no ids, a single id or a sequence of ids.
5126         """
5127         ids = _normalize_ids(arg)
5128         #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5129         return self._browse(self.env, ids)
5130
5131     #
5132     # Internal properties, for manipulating the instance's implementation
5133     #
5134
5135     @property
5136     def ids(self):
5137         """ List of actual record ids in this recordset (ignores placeholder
5138         ids for records to create)
5139         """
5140         return filter(None, list(self._ids))
5141
5142     # backward-compatibility with former browse records
5143     _cr = property(lambda self: self.env.cr)
5144     _uid = property(lambda self: self.env.uid)
5145     _context = property(lambda self: self.env.context)
5146
5147     #
5148     # Conversion methods
5149     #
5150
5151     def ensure_one(self):
5152         """ Verifies that the current recorset holds a single record. Raises
5153         an exception otherwise.
5154         """
5155         if len(self) == 1:
5156             return self
5157         raise except_orm("ValueError", "Expected singleton: %s" % self)
5158
5159     def with_env(self, env):
5160         """ Returns a new version of this recordset attached to the provided
5161         environment
5162
5163         :type env: :class:`~openerp.api.Environment`
5164         """
5165         return self._browse(env, self._ids)
5166
5167     def sudo(self, user=SUPERUSER_ID):
5168         """ sudo([user=SUPERUSER])
5169
5170         Returns a new version of this recordset attached to the provided
5171         user.
5172         """
5173         return self.with_env(self.env(user=user))
5174
5175     def with_context(self, *args, **kwargs):
5176         """ with_context([context][, **overrides]) -> records
5177
5178         Returns a new version of this recordset attached to an extended
5179         context.
5180
5181         The extended context is either the provided ``context`` in which
5182         ``overrides`` are merged or the *current* context in which
5183         ``overrides`` are merged e.g.::
5184
5185             # current context is {'key1': True}
5186             r2 = records.with_context({}, key2=True)
5187             # -> r2._context is {'key2': True}
5188             r2 = records.with_context(key2=True)
5189             # -> r2._context is {'key1': True, 'key2': True}
5190         """
5191         context = dict(args[0] if args else self._context, **kwargs)
5192         return self.with_env(self.env(context=context))
5193
5194     def _convert_to_cache(self, values, update=False, validate=True):
5195         """ Convert the `values` dictionary into cached values.
5196
5197             :param update: whether the conversion is made for updating `self`;
5198                 this is necessary for interpreting the commands of *2many fields
5199             :param validate: whether values must be checked
5200         """
5201         fields = self._fields
5202         target = self if update else self.browse()
5203         return {
5204             name: fields[name].convert_to_cache(value, target, validate=validate)
5205             for name, value in values.iteritems()
5206             if name in fields
5207         }
5208
5209     def _convert_to_write(self, values):
5210         """ Convert the `values` dictionary into the format of :meth:`write`. """
5211         fields = self._fields
5212         result = {}
5213         for name, value in values.iteritems():
5214             if name in fields:
5215                 value = fields[name].convert_to_write(value)
5216                 if not isinstance(value, NewId):
5217                     result[name] = value
5218         return result
5219
5220     #
5221     # Record traversal and update
5222     #
5223
5224     def _mapped_func(self, func):
5225         """ Apply function `func` on all records in `self`, and return the
5226             result as a list or a recordset (if `func` return recordsets).
5227         """
5228         vals = [func(rec) for rec in self]
5229         val0 = vals[0] if vals else func(self)
5230         if isinstance(val0, BaseModel):
5231             return reduce(operator.or_, vals, val0)
5232         return vals
5233
5234     def mapped(self, func):
5235         """ Apply `func` on all records in `self`, and return the result as a
5236             list or a recordset (if `func` return recordsets). In the latter
5237             case, the order of the returned recordset is arbritrary.
5238
5239             :param func: a function or a dot-separated sequence of field names
5240         """
5241         if isinstance(func, basestring):
5242             recs = self
5243             for name in func.split('.'):
5244                 recs = recs._mapped_func(operator.itemgetter(name))
5245             return recs
5246         else:
5247             return self._mapped_func(func)
5248
5249     def _mapped_cache(self, name_seq):
5250         """ Same as `~.mapped`, but `name_seq` is a dot-separated sequence of
5251             field names, and only cached values are used.
5252         """
5253         recs = self
5254         for name in name_seq.split('.'):
5255             field = recs._fields[name]
5256             null = field.null(self.env)
5257             recs = recs.mapped(lambda rec: rec._cache.get(field, null))
5258         return recs
5259
5260     def filtered(self, func):
5261         """ Select the records in `self` such that `func(rec)` is true, and
5262             return them as a recordset.
5263
5264             :param func: a function or a dot-separated sequence of field names
5265         """
5266         if isinstance(func, basestring):
5267             name = func
5268             func = lambda rec: filter(None, rec.mapped(name))
5269         return self.browse([rec.id for rec in self if func(rec)])
5270
5271     def sorted(self, key=None):
5272         """ Return the recordset `self` ordered by `key` """
5273         if key is None:
5274             return self.search([('id', 'in', self.ids)])
5275         else:
5276             return self.browse(map(int, sorted(self, key=key)))
5277
5278     def update(self, values):
5279         """ Update record `self[0]` with `values`. """
5280         for name, value in values.iteritems():
5281             self[name] = value
5282
5283     #
5284     # New records - represent records that do not exist in the database yet;
5285     # they are used to compute default values and perform onchanges.
5286     #
5287
5288     @api.model
5289     def new(self, values={}):
5290         """ new([values]) -> record
5291
5292         Return a new record instance attached to the current environment and
5293         initialized with the provided ``value``. The record is *not* created
5294         in database, it only exists in memory.
5295         """
5296         record = self.browse([NewId()])
5297         record._cache.update(record._convert_to_cache(values, update=True))
5298
5299         if record.env.in_onchange:
5300             # The cache update does not set inverse fields, so do it manually.
5301             # This is useful for computing a function field on secondary
5302             # records, if that field depends on the main record.
5303             for name in values:
5304                 field = self._fields.get(name)
5305                 if field:
5306                     for invf in field.inverse_fields:
5307                         invf._update(record[name], record)
5308
5309         return record
5310
5311     #
5312     # Dirty flag, to mark records modified (in draft mode)
5313     #
5314
5315     @property
5316     def _dirty(self):
5317         """ Return whether any record in `self` is dirty. """
5318         dirty = self.env.dirty
5319         return any(record in dirty for record in self)
5320
5321     @_dirty.setter
5322     def _dirty(self, value):
5323         """ Mark the records in `self` as dirty. """
5324         if value:
5325             map(self.env.dirty.add, self)
5326         else:
5327             map(self.env.dirty.discard, self)
5328
5329     #
5330     # "Dunder" methods
5331     #
5332
5333     def __nonzero__(self):
5334         """ Test whether `self` is nonempty. """
5335         return bool(getattr(self, '_ids', True))
5336
5337     def __len__(self):
5338         """ Return the size of `self`. """
5339         return len(self._ids)
5340
5341     def __iter__(self):
5342         """ Return an iterator over `self`. """
5343         for id in self._ids:
5344             yield self._browse(self.env, (id,))
5345
5346     def __contains__(self, item):
5347         """ Test whether `item` (record or field name) is an element of `self`.
5348             In the first case, the test is fully equivalent to::
5349
5350                 any(item == record for record in self)
5351         """
5352         if isinstance(item, BaseModel) and self._name == item._name:
5353             return len(item) == 1 and item.id in self._ids
5354         elif isinstance(item, basestring):
5355             return item in self._fields
5356         else:
5357             raise except_orm("ValueError", "Mixing apples and oranges: %s in %s" % (item, self))
5358
5359     def __add__(self, other):
5360         """ Return the concatenation of two recordsets. """
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(self._ids + other._ids)
5364
5365     def __sub__(self, other):
5366         """ Return the recordset of all the records in `self` that are not in `other`. """
5367         if not isinstance(other, BaseModel) or self._name != other._name:
5368             raise except_orm("ValueError", "Mixing apples and oranges: %s - %s" % (self, other))
5369         other_ids = set(other._ids)
5370         return self.browse([id for id in self._ids if id not in other_ids])
5371
5372     def __and__(self, other):
5373         """ Return the intersection of two recordsets.
5374             Note that recordset order is not preserved.
5375         """
5376         if not isinstance(other, BaseModel) or self._name != other._name:
5377             raise except_orm("ValueError", "Mixing apples and oranges: %s & %s" % (self, other))
5378         return self.browse(set(self._ids) & set(other._ids))
5379
5380     def __or__(self, other):
5381         """ Return the union of two recordsets.
5382             Note that recordset order is not preserved.
5383         """
5384         if not isinstance(other, BaseModel) or self._name != other._name:
5385             raise except_orm("ValueError", "Mixing apples and oranges: %s | %s" % (self, other))
5386         return self.browse(set(self._ids) | set(other._ids))
5387
5388     def __eq__(self, other):
5389         """ Test whether two recordsets are equivalent (up to reordering). """
5390         if not isinstance(other, BaseModel):
5391             if other:
5392                 _logger.warning("Comparing apples and oranges: %s == %s", self, other)
5393             return False
5394         return self._name == other._name and set(self._ids) == set(other._ids)
5395
5396     def __ne__(self, other):
5397         return not self == other
5398
5399     def __lt__(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 __le__(self, other):
5405         if not isinstance(other, BaseModel) or self._name != other._name:
5406             raise except_orm("ValueError", "Mixing apples and oranges: %s <= %s" % (self, other))
5407         return set(self._ids) <= set(other._ids)
5408
5409     def __gt__(self, other):
5410         if not isinstance(other, BaseModel) or self._name != other._name:
5411             raise except_orm("ValueError", "Mixing apples and oranges: %s > %s" % (self, other))
5412         return set(self._ids) > set(other._ids)
5413
5414     def __ge__(self, other):
5415         if not isinstance(other, BaseModel) or self._name != other._name:
5416             raise except_orm("ValueError", "Mixing apples and oranges: %s >= %s" % (self, other))
5417         return set(self._ids) >= set(other._ids)
5418
5419     def __int__(self):
5420         return self.id
5421
5422     def __str__(self):
5423         return "%s%s" % (self._name, getattr(self, '_ids', ""))
5424
5425     def __unicode__(self):
5426         return unicode(str(self))
5427
5428     __repr__ = __str__
5429
5430     def __hash__(self):
5431         if hasattr(self, '_ids'):
5432             return hash((self._name, frozenset(self._ids)))
5433         else:
5434             return hash(self._name)
5435
5436     def __getitem__(self, key):
5437         """ If `key` is an integer or a slice, return the corresponding record
5438             selection as an instance (attached to `self.env`).
5439             Otherwise read the field `key` of the first record in `self`.
5440
5441             Examples::
5442
5443                 inst = model.search(dom)    # inst is a recordset
5444                 r4 = inst[3]                # fourth record in inst
5445                 rs = inst[10:20]            # subset of inst
5446                 nm = rs['name']             # name of first record in inst
5447         """
5448         if isinstance(key, basestring):
5449             # important: one must call the field's getter
5450             return self._fields[key].__get__(self, type(self))
5451         elif isinstance(key, slice):
5452             return self._browse(self.env, self._ids[key])
5453         else:
5454             return self._browse(self.env, (self._ids[key],))
5455
5456     def __setitem__(self, key, value):
5457         """ Assign the field `key` to `value` in record `self`. """
5458         # important: one must call the field's setter
5459         return self._fields[key].__set__(self, value)
5460
5461     #
5462     # Cache and recomputation management
5463     #
5464
5465     @lazy_property
5466     def _cache(self):
5467         """ Return the cache of `self`, mapping field names to values. """
5468         return RecordCache(self)
5469
5470     @api.model
5471     def _in_cache_without(self, field):
5472         """ Make sure `self` is present in cache (for prefetching), and return
5473             the records of model `self` in cache that have no value for `field`
5474             (:class:`Field` instance).
5475         """
5476         env = self.env
5477         prefetch_ids = env.prefetch[self._name]
5478         prefetch_ids.update(self._ids)
5479         ids = filter(None, prefetch_ids - set(env.cache[field]))
5480         return self.browse(ids)
5481
5482     @api.model
5483     def refresh(self):
5484         """ Clear the records cache.
5485
5486             .. deprecated:: 8.0
5487                 The record cache is automatically invalidated.
5488         """
5489         self.invalidate_cache()
5490
5491     @api.model
5492     def invalidate_cache(self, fnames=None, ids=None):
5493         """ Invalidate the record caches after some records have been modified.
5494             If both `fnames` and `ids` are ``None``, the whole cache is cleared.
5495
5496             :param fnames: the list of modified fields, or ``None`` for all fields
5497             :param ids: the list of modified record ids, or ``None`` for all
5498         """
5499         if fnames is None:
5500             if ids is None:
5501                 return self.env.invalidate_all()
5502             fields = self._fields.values()
5503         else:
5504             fields = map(self._fields.__getitem__, fnames)
5505
5506         # invalidate fields and inverse fields, too
5507         spec = [(f, ids) for f in fields] + \
5508                [(invf, None) for f in fields for invf in f.inverse_fields]
5509         self.env.invalidate(spec)
5510
5511     @api.multi
5512     def modified(self, fnames):
5513         """ Notify that fields have been modified on `self`. This invalidates
5514             the cache, and prepares the recomputation of stored function fields
5515             (new-style fields only).
5516
5517             :param fnames: iterable of field names that have been modified on
5518                 records `self`
5519         """
5520         # each field knows what to invalidate and recompute
5521         spec = []
5522         for fname in fnames:
5523             spec += self._fields[fname].modified(self)
5524
5525         cached_fields = {
5526             field
5527             for env in self.env.all
5528             for field in env.cache
5529         }
5530         # invalidate non-stored fields.function which are currently cached
5531         spec += [(f, None) for f in self.pool.pure_function_fields
5532                  if f in cached_fields]
5533
5534         self.env.invalidate(spec)
5535
5536     def _recompute_check(self, field):
5537         """ If `field` must be recomputed on some record in `self`, return the
5538             corresponding records that must be recomputed.
5539         """
5540         return self.env.check_todo(field, self)
5541
5542     def _recompute_todo(self, field):
5543         """ Mark `field` to be recomputed. """
5544         self.env.add_todo(field, self)
5545
5546     def _recompute_done(self, field):
5547         """ Mark `field` as recomputed. """
5548         self.env.remove_todo(field, self)
5549
5550     @api.model
5551     def recompute(self):
5552         """ Recompute stored function fields. The fields and records to
5553             recompute have been determined by method :meth:`modified`.
5554         """
5555         while self.env.has_todo():
5556             field, recs = self.env.get_todo()
5557             # evaluate the fields to recompute, and save them to database
5558             for rec, rec1 in zip(recs, recs.with_context(recompute=False)):
5559                 try:
5560                     values = rec._convert_to_write({
5561                         f.name: rec[f.name] for f in field.computed_fields
5562                     })
5563                     rec1._write(values)
5564                 except MissingError:
5565                     pass
5566             # mark the computed fields as done
5567             map(recs._recompute_done, field.computed_fields)
5568
5569     #
5570     # Generic onchange method
5571     #
5572
5573     def _has_onchange(self, field, other_fields):
5574         """ Return whether `field` should trigger an onchange event in the
5575             presence of `other_fields`.
5576         """
5577         # test whether self has an onchange method for field, or field is a
5578         # dependency of any field in other_fields
5579         return field.name in self._onchange_methods or \
5580             any(dep in other_fields for dep in field.dependents)
5581
5582     @api.model
5583     def _onchange_spec(self, view_info=None):
5584         """ Return the onchange spec from a view description; if not given, the
5585             result of ``self.fields_view_get()`` is used.
5586         """
5587         result = {}
5588
5589         # for traversing the XML arch and populating result
5590         def process(node, info, prefix):
5591             if node.tag == 'field':
5592                 name = node.attrib['name']
5593                 names = "%s.%s" % (prefix, name) if prefix else name
5594                 if not result.get(names):
5595                     result[names] = node.attrib.get('on_change')
5596                 # traverse the subviews included in relational fields
5597                 for subinfo in info['fields'][name].get('views', {}).itervalues():
5598                     process(etree.fromstring(subinfo['arch']), subinfo, names)
5599             else:
5600                 for child in node:
5601                     process(child, info, prefix)
5602
5603         if view_info is None:
5604             view_info = self.fields_view_get()
5605         process(etree.fromstring(view_info['arch']), view_info, '')
5606         return result
5607
5608     def _onchange_eval(self, field_name, onchange, result):
5609         """ Apply onchange method(s) for field `field_name` with spec `onchange`
5610             on record `self`. Value assignments are applied on `self`, while
5611             domain and warning messages are put in dictionary `result`.
5612         """
5613         onchange = onchange.strip()
5614
5615         # onchange V8
5616         if onchange in ("1", "true"):
5617             for method in self._onchange_methods.get(field_name, ()):
5618                 method_res = method(self)
5619                 if not method_res:
5620                     continue
5621                 if 'domain' in method_res:
5622                     result.setdefault('domain', {}).update(method_res['domain'])
5623                 if 'warning' in method_res:
5624                     result['warning'] = method_res['warning']
5625             return
5626
5627         # onchange V7
5628         match = onchange_v7.match(onchange)
5629         if match:
5630             method, params = match.groups()
5631
5632             # evaluate params -> tuple
5633             global_vars = {'context': self._context, 'uid': self._uid}
5634             if self._context.get('field_parent'):
5635                 class RawRecord(object):
5636                     def __init__(self, record):
5637                         self._record = record
5638                     def __getattr__(self, name):
5639                         field = self._record._fields[name]
5640                         value = self._record[name]
5641                         return field.convert_to_onchange(value)
5642                 record = self[self._context['field_parent']]
5643                 global_vars['parent'] = RawRecord(record)
5644             field_vars = {
5645                 key: self._fields[key].convert_to_onchange(val)
5646                 for key, val in self._cache.iteritems()
5647             }
5648             params = eval("[%s]" % params, global_vars, field_vars)
5649
5650             # call onchange method
5651             args = (self._cr, self._uid, self._origin.ids) + tuple(params)
5652             method_res = getattr(self._model, method)(*args)
5653             if not isinstance(method_res, dict):
5654                 return
5655             if 'value' in method_res:
5656                 method_res['value'].pop('id', None)
5657                 self.update(self._convert_to_cache(method_res['value'], validate=False))
5658             if 'domain' in method_res:
5659                 result.setdefault('domain', {}).update(method_res['domain'])
5660             if 'warning' in method_res:
5661                 result['warning'] = method_res['warning']
5662
5663     @api.multi
5664     def onchange(self, values, field_name, field_onchange):
5665         """ Perform an onchange on the given field.
5666
5667             :param values: dictionary mapping field names to values, giving the
5668                 current state of modification
5669             :param field_name: name of the modified field_name
5670             :param field_onchange: dictionary mapping field names to their
5671                 on_change attribute
5672         """
5673         env = self.env
5674
5675         if field_name and field_name not in self._fields:
5676             return {}
5677
5678         # determine subfields for field.convert_to_write() below
5679         secondary = []
5680         subfields = defaultdict(set)
5681         for dotname in field_onchange:
5682             if '.' in dotname:
5683                 secondary.append(dotname)
5684                 name, subname = dotname.split('.')
5685                 subfields[name].add(subname)
5686
5687         # create a new record with values, and attach `self` to it
5688         with env.do_in_onchange():
5689             record = self.new(values)
5690             values = dict(record._cache)
5691             # attach `self` with a different context (for cache consistency)
5692             record._origin = self.with_context(__onchange=True)
5693
5694         # determine which field should be triggered an onchange
5695         todo = set([field_name]) if field_name else set(values)
5696         done = set()
5697
5698         # dummy assignment: trigger invalidations on the record
5699         for name in todo:
5700             value = record[name]
5701             field = self._fields[name]
5702             if not field_name and field.type == 'many2one' and field.delegate and not value:
5703                 # do not nullify all fields of parent record for new records
5704                 continue
5705             record[name] = value
5706
5707         result = {'value': {}}
5708
5709         while todo:
5710             name = todo.pop()
5711             if name in done:
5712                 continue
5713             done.add(name)
5714
5715             with env.do_in_onchange():
5716                 # apply field-specific onchange methods
5717                 if field_onchange.get(name):
5718                     record._onchange_eval(name, field_onchange[name], result)
5719
5720                 # force re-evaluation of function fields on secondary records
5721                 for field_seq in secondary:
5722                     record.mapped(field_seq)
5723
5724                 # determine which fields have been modified
5725                 for name, oldval in values.iteritems():
5726                     field = self._fields[name]
5727                     newval = record[name]
5728                     if field.type in ('one2many', 'many2many'):
5729                         if newval != oldval or newval._dirty:
5730                             # put new value in result
5731                             result['value'][name] = field.convert_to_write(
5732                                 newval, record._origin, subfields.get(name),
5733                             )
5734                             todo.add(name)
5735                         else:
5736                             # keep result: newval may have been dirty before
5737                             pass
5738                     else:
5739                         if newval != oldval:
5740                             # put new value in result
5741                             result['value'][name] = field.convert_to_write(
5742                                 newval, record._origin, subfields.get(name),
5743                             )
5744                             todo.add(name)
5745                         else:
5746                             # clean up result to not return another value
5747                             result['value'].pop(name, None)
5748
5749         # At the moment, the client does not support updates on a *2many field
5750         # while this one is modified by the user.
5751         if field_name and self._fields[field_name].type in ('one2many', 'many2many'):
5752             result['value'].pop(field_name, None)
5753
5754         return result
5755
5756
5757 class RecordCache(MutableMapping):
5758     """ Implements a proxy dictionary to read/update the cache of a record.
5759         Upon iteration, it looks like a dictionary mapping field names to
5760         values. However, fields may be used as keys as well.
5761     """
5762     def __init__(self, records):
5763         self._recs = records
5764
5765     def contains(self, field):
5766         """ Return whether `records[0]` has a value for `field` in cache. """
5767         if isinstance(field, basestring):
5768             field = self._recs._fields[field]
5769         return self._recs.id in self._recs.env.cache[field]
5770
5771     def __contains__(self, field):
5772         """ Return whether `records[0]` has a regular value for `field` in cache. """
5773         if isinstance(field, basestring):
5774             field = self._recs._fields[field]
5775         dummy = SpecialValue(None)
5776         value = self._recs.env.cache[field].get(self._recs.id, dummy)
5777         return not isinstance(value, SpecialValue)
5778
5779     def __getitem__(self, field):
5780         """ Return the cached value of `field` for `records[0]`. """
5781         if isinstance(field, basestring):
5782             field = self._recs._fields[field]
5783         value = self._recs.env.cache[field][self._recs.id]
5784         return value.get() if isinstance(value, SpecialValue) else value
5785
5786     def __setitem__(self, field, value):
5787         """ Assign the cached value of `field` for all records in `records`. """
5788         if isinstance(field, basestring):
5789             field = self._recs._fields[field]
5790         values = dict.fromkeys(self._recs._ids, value)
5791         self._recs.env.cache[field].update(values)
5792
5793     def update(self, *args, **kwargs):
5794         """ Update the cache of all records in `records`. If the argument is a
5795             `SpecialValue`, update all fields (except "magic" columns).
5796         """
5797         if args and isinstance(args[0], SpecialValue):
5798             values = dict.fromkeys(self._recs._ids, args[0])
5799             for name, field in self._recs._fields.iteritems():
5800                 if name != 'id':
5801                     self._recs.env.cache[field].update(values)
5802         else:
5803             return super(RecordCache, self).update(*args, **kwargs)
5804
5805     def __delitem__(self, field):
5806         """ Remove the cached value of `field` for all `records`. """
5807         if isinstance(field, basestring):
5808             field = self._recs._fields[field]
5809         field_cache = self._recs.env.cache[field]
5810         for id in self._recs._ids:
5811             field_cache.pop(id, None)
5812
5813     def __iter__(self):
5814         """ Iterate over the field names with a regular value in cache. """
5815         cache, id = self._recs.env.cache, self._recs.id
5816         dummy = SpecialValue(None)
5817         for name, field in self._recs._fields.iteritems():
5818             if name != 'id' and not isinstance(cache[field].get(id, dummy), SpecialValue):
5819                 yield name
5820
5821     def __len__(self):
5822         """ Return the number of fields with a regular value in cache. """
5823         return sum(1 for name in self)
5824
5825 class Model(BaseModel):
5826     """Main super-class for regular database-persisted OpenERP models.
5827
5828     OpenERP models are created by inheriting from this class::
5829
5830         class user(Model):
5831             ...
5832
5833     The system will later instantiate the class once per database (on
5834     which the class' module is installed).
5835     """
5836     _auto = True
5837     _register = False # not visible in ORM registry, meant to be python-inherited only
5838     _transient = False # True in a TransientModel
5839
5840 class TransientModel(BaseModel):
5841     """Model super-class for transient records, meant to be temporarily
5842        persisted, and regularly vaccuum-cleaned.
5843
5844        A TransientModel has a simplified access rights management,
5845        all users can create new records, and may only access the
5846        records they created. The super-user has unrestricted access
5847        to all TransientModel records.
5848     """
5849     _auto = True
5850     _register = False # not visible in ORM registry, meant to be python-inherited only
5851     _transient = True
5852
5853 class AbstractModel(BaseModel):
5854     """Abstract Model super-class for creating an abstract class meant to be
5855        inherited by regular models (Models or TransientModels) but not meant to
5856        be usable on its own, or persisted.
5857
5858        Technical note: we don't want to make AbstractModel the super-class of
5859        Model or BaseModel because it would not make sense to put the main
5860        definition of persistence methods such as create() in it, and still we
5861        should be able to override them within an AbstractModel.
5862        """
5863     _auto = False # don't create any database backend for AbstractModels
5864     _register = False # not visible in ORM registry, meant to be python-inherited only
5865     _transient = False
5866
5867 def itemgetter_tuple(items):
5868     """ Fixes itemgetter inconsistency (useful in some cases) of not returning
5869     a tuple if len(items) == 1: always returns an n-tuple where n = len(items)
5870     """
5871     if len(items) == 0:
5872         return lambda a: ()
5873     if len(items) == 1:
5874         return lambda gettable: (gettable[items[0]],)
5875     return operator.itemgetter(*items)
5876
5877 def convert_pgerror_23502(model, fields, info, e):
5878     m = re.match(r'^null value in column "(?P<field>\w+)" violates '
5879                  r'not-null constraint\n',
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"Missing required value for the field '%s'.") % field_name
5885     field = fields.get(field_name)
5886     if field:
5887         message = _(u"Missing required value for the field '%s' (%s)") % (field['string'], field_name)
5888     return {
5889         'message': message,
5890         'field': field_name,
5891     }
5892
5893 def convert_pgerror_23505(model, fields, info, e):
5894     m = re.match(r'^duplicate key (?P<field>\w+) violates unique constraint',
5895                  str(e))
5896     field_name = m and m.group('field')
5897     if not m or field_name not in fields:
5898         return {'message': unicode(e)}
5899     message = _(u"The value for the field '%s' already exists.") % field_name
5900     field = fields.get(field_name)
5901     if field:
5902         message = _(u"%s This might be '%s' in the current model, or a field "
5903                     u"of the same name in an o2m.") % (message, field['string'])
5904     return {
5905         'message': message,
5906         'field': field_name,
5907     }
5908
5909 PGERROR_TO_OE = defaultdict(
5910     # shape of mapped converters
5911     lambda: (lambda model, fvg, info, pgerror: {'message': unicode(pgerror)}), {
5912     # not_null_violation
5913     '23502': convert_pgerror_23502,
5914     # unique constraint error
5915     '23505': convert_pgerror_23505,
5916 })
5917
5918 def _normalize_ids(arg, atoms={int, long, str, unicode, NewId}):
5919     """ Normalizes the ids argument for ``browse`` (v7 and v8) to a tuple.
5920
5921     Various implementations were tested on the corpus of all browse() calls
5922     performed during a full crawler run (after having installed all website_*
5923     modules) and this one was the most efficient overall.
5924
5925     A possible bit of correctness was sacrificed by not doing any test on
5926     Iterable and just assuming that any non-atomic type was an iterable of
5927     some kind.
5928
5929     :rtype: tuple
5930     """
5931     # much of the corpus is falsy objects (empty list, tuple or set, None)
5932     if not arg:
5933         return ()
5934
5935     # `type in set` is significantly faster (because more restrictive) than
5936     # isinstance(arg, set) or issubclass(type, set); and for new-style classes
5937     # obj.__class__ is equivalent to but faster than type(obj). Not relevant
5938     # (and looks much worse) in most cases, but over millions of calls it
5939     # does have a very minor effect.
5940     if arg.__class__ in atoms:
5941         return arg,
5942
5943     return tuple(arg)
5944
5945 # keep those imports here to avoid dependency cycle errors
5946 from .osv import expression
5947 from .fields import Field, SpecialValue, FailedValue
5948
5949 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: