openerp/models.py

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