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