1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
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.
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.
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/>.
20 ##############################################################################
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
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)
52 from collections import defaultdict, MutableMapping
53 from inspect import getmembers
56 import dateutil.relativedelta
58 from lxml import etree
61 from . import SUPERUSER_ID
64 from .api import Environment
65 from .exceptions import except_orm, AccessError, MissingError
66 from .osv import fields
67 from .osv.query import Query
68 from .tools import lazy_property
69 from .tools.config import config
70 from .tools.misc import CountingStream, DEFAULT_SERVER_DATETIME_FORMAT, DEFAULT_SERVER_DATE_FORMAT
71 from .tools.safe_eval import safe_eval as eval
72 from .tools.translate import _
74 _logger = logging.getLogger(__name__)
75 _schema = logging.getLogger(__name__ + '.schema')
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+)\((.*)\)$")
81 AUTOINIT_RECALCULATE_STORED_FIELDS = 1000
84 def check_object_name(name):
85 """ Check if the given name is a valid openerp object name.
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.
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
96 psycopg2.ProgrammingError: relation "xxx" does not exist).
98 The same restriction should apply to both osv and osv_memory
99 objects for consistency.
102 if regex_object_name.match(name) is None:
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
110 raise except_orm('ValueError', msg)
112 POSTGRES_CONFDELTYPES = {
120 def intersect(la, lb):
121 return filter(lambda x: x in lb, la)
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)
127 def fix_import_export_id_paths(fieldname):
129 Fixes the id fields in import and exports, and splits field paths
132 :param str fieldname: name of the field to import/export
133 :return: split field name
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('/')
140 def pg_varchar(size=0):
141 """ Returns the VARCHAR declaration for the provided size:
143 * If no size (or an empty or negative size is provided) return an
145 * Otherwise return a VARCHAR(n)
147 :type int size: varchar size, optional
151 if not isinstance(size, int):
152 raise TypeError("VARCHAR parameter should be an int, got %s"
155 return 'VARCHAR(%d)' % size
158 FIELDS_TO_PGTYPES = {
159 fields.boolean: 'bool',
160 fields.integer: 'int4',
164 fields.datetime: 'timestamp',
165 fields.binary: 'bytea',
166 fields.many2one: 'int4',
167 fields.serialized: 'text',
170 def get_pg_type(f, type_override=None):
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)
177 field_type = type_override or type(f)
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):
183 pg_type = ('numeric', 'NUMERIC')
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')
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())
198 pg_type = get_pg_type(f, getattr(fields, f._type))
200 _logger.warning('%s type not supported!', field_type)
206 class MetaModel(api.Meta):
207 """ Metaclass for the models.
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.
216 module_to_models = {}
218 def __init__(self, name, bases, attrs):
219 if not self._register:
220 self._register = True
221 super(MetaModel, self).__init__(name, bases, attrs)
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
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]
233 module_name = self.__module__.split('.')[0]
234 self._module = module_name
236 # Remember which models to instanciate for this module.
238 self.module_to_models.setdefault(self._module, []).append(self)
242 """ Pseudo-ids for new records. """
243 def __nonzero__(self):
246 IdType = (int, long, basestring, NewId)
249 # special columns automatically created by the ORM
250 LOG_ACCESS_COLUMNS = ['create_uid', 'create_date', 'write_uid', 'write_date']
251 MAGIC_COLUMNS = ['id'] + LOG_ACCESS_COLUMNS
253 class BaseModel(object):
254 """ Base class for OpenERP models.
256 OpenERP models are created by inheriting from this class' subclasses:
258 * :class:`Model` for regular database-persisted models
260 * :class:`TransientModel` for temporary data, stored in the database but
261 automatically vaccuumed every so often
263 * :class:`AbstractModel` for abstract super classes meant to be shared by
264 multiple inheriting model
266 The system automatically instantiates every model once per database. Those
267 instances represent the available models on each database, and depend on
268 which modules are installed on that database. The actual class of each
269 instance is built from the Python classes that create and inherit from the
272 Every model instance is a "recordset", i.e., an ordered collection of
273 records of the model. Recordsets are returned by methods like
274 :meth:`~.browse`, :meth:`~.search`, or field accesses. Records have no
275 explicit representation: a record is represented as a recordset of one
278 To create a class that should not be instantiated, the _register class
279 attribute may be set to False.
281 __metaclass__ = MetaModel
282 _auto = True # create database backend
283 _register = False # Set to false if the model shouldn't be automatically discovered.
290 _parent_name = 'parent_id'
291 _parent_store = False
292 _parent_order = False
298 _translate = True # set to False to disable translations export for this model
300 # dict of {field:method}, with method returning the (name_get of records, {id: fold})
301 # to include in the _read_group, if grouped on this field
305 _transient = False # True in a TransientModel
308 # { 'parent_model': 'm2o_field', ... }
311 # Mapping from inherits'd field name to triple (m, r, f, n) where m is the
312 # model from which it is inherits'd, r is the (local) field towards m, f
313 # is the _column object itself, and n is the original (i.e. top-most)
316 # { 'field_name': ('parent_model', 'm2o_field_to_reach_parent',
317 # field_column_obj, origina_parent_model), ... }
320 # Mapping field name/column_info object
321 # This is similar to _inherit_fields but:
322 # 1. includes self fields,
323 # 2. uses column_info instead of a triple.
328 _sql_constraints = []
330 # model dependencies, for models backed up by sql views:
331 # {model_name: field_names, ...}
334 CONCURRENCY_CHECK_FIELD = '__last_update'
336 def log(self, cr, uid, id, message, secondary=False, context=None):
337 return _logger.warning("log() is deprecated. Please use OpenChatter notification system instead of the res.log mechanism.")
339 def view_init(self, cr, uid, fields_list, context=None):
340 """Override this method to do specific things when a view on the object is opened."""
343 def _field_create(self, cr, context=None):
344 """ Create entries in ir_model_fields for all the model's fields.
346 If necessary, also create an entry in ir_model, and if called from the
347 modules loading scheme (by receiving 'module' in the context), also
348 create entries in ir_model_data (for the model and the fields).
350 - create an entry in ir_model (if there is not already one),
351 - create an entry in ir_model_data (if there is not already one, and if
352 'module' is in the context),
353 - update ir_model_fields with the fields found in _columns
354 (TODO there is some redundancy as _columns is updated from
355 ir_model_fields in __init__).
360 cr.execute("SELECT id FROM ir_model WHERE model=%s", (self._name,))
362 cr.execute('SELECT nextval(%s)', ('ir_model_id_seq',))
363 model_id = cr.fetchone()[0]
364 cr.execute("INSERT INTO ir_model (id,model, name, info,state) VALUES (%s, %s, %s, %s, %s)", (model_id, self._name, self._description, self.__doc__, 'base'))
366 model_id = cr.fetchone()[0]
367 if 'module' in context:
368 name_id = 'model_'+self._name.replace('.', '_')
369 cr.execute('select * from ir_model_data where name=%s and module=%s', (name_id, context['module']))
371 cr.execute("INSERT INTO ir_model_data (name,date_init,date_update,module,model,res_id) VALUES (%s, (now() at time zone 'UTC'), (now() at time zone 'UTC'), %s, %s, %s)", \
372 (name_id, context['module'], 'ir.model', model_id)
375 cr.execute("SELECT * FROM ir_model_fields WHERE model=%s", (self._name,))
377 for rec in cr.dictfetchall():
378 cols[rec['name']] = rec
380 ir_model_fields_obj = self.pool.get('ir.model.fields')
382 # sparse field should be created at the end, as it depends on its serialized field already existing
383 model_fields = sorted(self._columns.items(), key=lambda x: 1 if x[1]._type == 'sparse' else 0)
384 for (k, f) in model_fields:
386 'model_id': model_id,
389 'field_description': f.string,
391 'relation': f._obj or '',
392 'select_level': tools.ustr(int(f.select)),
393 'readonly': (f.readonly and 1) or 0,
394 'required': (f.required and 1) or 0,
395 'selectable': (f.selectable and 1) or 0,
396 'translate': (f.translate and 1) or 0,
397 'relation_field': f._fields_id if isinstance(f, fields.one2many) else '',
398 'serialization_field_id': None,
400 if getattr(f, 'serialization_field', None):
401 # resolve link to serialization_field if specified by name
402 serialization_field_id = ir_model_fields_obj.search(cr, SUPERUSER_ID, [('model','=',vals['model']), ('name', '=', f.serialization_field)])
403 if not serialization_field_id:
404 raise except_orm(_('Error'), _("Serialization field `%s` not found for sparse field `%s`!") % (f.serialization_field, k))
405 vals['serialization_field_id'] = serialization_field_id[0]
407 # When its a custom field,it does not contain f.select
408 if context.get('field_state', 'base') == 'manual':
409 if context.get('field_name', '') == k:
410 vals['select_level'] = context.get('select', '0')
411 #setting value to let the problem NOT occur next time
413 vals['select_level'] = cols[k]['select_level']
416 cr.execute('select nextval(%s)', ('ir_model_fields_id_seq',))
417 id = cr.fetchone()[0]
419 cr.execute("""INSERT INTO ir_model_fields (
420 id, model_id, model, name, field_description, ttype,
421 relation,state,select_level,relation_field, translate, serialization_field_id
423 %s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s
425 id, vals['model_id'], vals['model'], vals['name'], vals['field_description'], vals['ttype'],
426 vals['relation'], 'base',
427 vals['select_level'], vals['relation_field'], bool(vals['translate']), vals['serialization_field_id']
429 if 'module' in context:
430 name1 = 'field_' + self._table + '_' + k
431 cr.execute("select name from ir_model_data where name=%s", (name1,))
433 name1 = name1 + "_" + str(id)
434 cr.execute("INSERT INTO ir_model_data (name,date_init,date_update,module,model,res_id) VALUES (%s, (now() at time zone 'UTC'), (now() at time zone 'UTC'), %s, %s, %s)", \
435 (name1, context['module'], 'ir.model.fields', id)
438 for key, val in vals.items():
439 if cols[k][key] != vals[key]:
440 cr.execute('update ir_model_fields set field_description=%s where model=%s and name=%s', (vals['field_description'], vals['model'], vals['name']))
441 cr.execute("""UPDATE ir_model_fields SET
442 model_id=%s, field_description=%s, ttype=%s, relation=%s,
443 select_level=%s, readonly=%s ,required=%s, selectable=%s, relation_field=%s, translate=%s, serialization_field_id=%s
445 model=%s AND name=%s""", (
446 vals['model_id'], vals['field_description'], vals['ttype'],
448 vals['select_level'], bool(vals['readonly']), bool(vals['required']), bool(vals['selectable']), vals['relation_field'], bool(vals['translate']), vals['serialization_field_id'], vals['model'], vals['name']
451 self.invalidate_cache(cr, SUPERUSER_ID)
454 def _add_field(cls, name, field):
455 """ Add the given `field` under the given `name` in the class """
456 field.set_class_name(cls, name)
458 # add field in _fields (for reflection)
459 cls._fields[name] = field
461 # add field as an attribute, unless another kind of value already exists
462 if isinstance(getattr(cls, name, field), Field):
463 setattr(cls, name, field)
465 _logger.warning("In model %r, member %r is not a field", cls._name, name)
468 cls._columns[name] = field.to_column()
470 # remove potential column that may be overridden by field
471 cls._columns.pop(name, None)
474 def _add_magic_fields(cls):
475 """ Introduce magic fields on the current class
477 * id is a "normal" field (with a specific getter)
478 * create_uid, create_date, write_uid and write_date have become
480 * $CONCURRENCY_CHECK_FIELD is a computed field with its computing
481 method defined dynamically. Uses ``str(datetime.datetime.utcnow())``
482 to get the same structure as the previous
483 ``(now() at time zone 'UTC')::timestamp``::
485 # select (now() at time zone 'UTC')::timestamp;
487 ----------------------------
488 2013-06-18 08:30:37.292809
490 >>> str(datetime.datetime.utcnow())
491 '2013-06-18 08:31:32.821177'
493 def add(name, field):
494 """ add `field` with the given `name` if it does not exist yet """
495 if name not in cls._columns and name not in cls._fields:
496 cls._add_field(name, field)
501 # this field 'id' must override any other column or field
502 cls._add_field('id', fields.Id(automatic=True))
504 add('display_name', fields.Char(string='Display Name', automatic=True,
505 compute='_compute_display_name'))
508 add('create_uid', fields.Many2one('res.users', string='Created by', automatic=True))
509 add('create_date', fields.Datetime(string='Created on', automatic=True))
510 add('write_uid', fields.Many2one('res.users', string='Last Updated by', automatic=True))
511 add('write_date', fields.Datetime(string='Last Updated on', automatic=True))
512 last_modified_name = 'compute_concurrency_field_with_access'
514 last_modified_name = 'compute_concurrency_field'
516 # this field must override any other column or field
517 cls._add_field(cls.CONCURRENCY_CHECK_FIELD, fields.Datetime(
518 string='Last Modified on', compute=last_modified_name, automatic=True))
521 def compute_concurrency_field(self):
522 self[self.CONCURRENCY_CHECK_FIELD] = \
523 datetime.datetime.utcnow().strftime(DEFAULT_SERVER_DATETIME_FORMAT)
526 @api.depends('create_date', 'write_date')
527 def compute_concurrency_field_with_access(self):
528 self[self.CONCURRENCY_CHECK_FIELD] = \
529 self.write_date or self.create_date or \
530 datetime.datetime.utcnow().strftime(DEFAULT_SERVER_DATETIME_FORMAT)
533 # Goal: try to apply inheritance at the instanciation level and
534 # put objects in the pool var
537 def _build_model(cls, pool, cr):
538 """ Instanciate a given model.
540 This class method instanciates the class of some model (i.e. a class
541 deriving from osv or osv_memory). The class might be the class passed
542 in argument or, if it inherits from another class, a class constructed
543 by combining the two classes.
547 # IMPORTANT: the registry contains an instance for each model. The class
548 # of each model carries inferred metadata that is shared among the
549 # model's instances for this registry, but not among registries. Hence
550 # we cannot use that "registry class" for combining model classes by
551 # inheritance, since it confuses the metadata inference process.
553 # Keep links to non-inherited constraints in cls; this is useful for
554 # instance when exporting translations
555 cls._local_constraints = cls.__dict__.get('_constraints', [])
556 cls._local_sql_constraints = cls.__dict__.get('_sql_constraints', [])
558 # determine inherited models
559 parents = getattr(cls, '_inherit', [])
560 parents = [parents] if isinstance(parents, basestring) else (parents or [])
562 # determine the model's name
563 name = cls._name or (len(parents) == 1 and parents[0]) or cls.__name__
565 # determine the module that introduced the model
566 original_module = pool[name]._original_module if name in parents else cls._module
568 # build the class hierarchy for the model
569 for parent in parents:
570 if parent not in pool:
571 raise TypeError('The model "%s" specifies an unexisting parent class "%s"\n'
572 'You may need to add a dependency on the parent class\' module.' % (name, parent))
573 parent_model = pool[parent]
575 # do no use the class of parent_model, since that class contains
576 # inferred metadata; use its ancestor instead
577 parent_class = type(parent_model).__base__
579 # don't inherit custom fields
580 columns = dict((key, val)
581 for key, val in parent_class._columns.iteritems()
584 columns.update(cls._columns)
586 defaults = dict(parent_class._defaults)
587 defaults.update(cls._defaults)
589 inherits = dict(parent_class._inherits)
590 inherits.update(cls._inherits)
592 depends = dict(parent_class._depends)
593 for m, fs in cls._depends.iteritems():
594 depends[m] = depends.get(m, []) + fs
596 old_constraints = parent_class._constraints
597 new_constraints = cls._constraints
598 # filter out from old_constraints the ones overridden by a
599 # constraint with the same function name in new_constraints
600 constraints = new_constraints + [oldc
601 for oldc in old_constraints
602 if not any(newc[2] == oldc[2] and same_name(newc[0], oldc[0])
603 for newc in new_constraints)
606 sql_constraints = cls._sql_constraints + \
607 parent_class._sql_constraints
613 '_defaults': defaults,
614 '_inherits': inherits,
616 '_constraints': constraints,
617 '_sql_constraints': sql_constraints,
619 cls = type(name, (cls, parent_class), attrs)
621 # introduce the "registry class" of the model;
622 # duplicate some attributes so that the ORM can modify them
626 '_columns': dict(cls._columns),
627 '_defaults': dict(cls._defaults),
628 '_inherits': dict(cls._inherits),
629 '_depends': dict(cls._depends),
630 '_constraints': list(cls._constraints),
631 '_sql_constraints': list(cls._sql_constraints),
632 '_original_module': original_module,
634 cls = type(cls._name, (cls,), attrs)
636 # float fields are registry-dependent (digit attribute); duplicate them
638 for key, col in cls._columns.items():
639 if col._type == 'float':
640 cls._columns[key] = copy.copy(col)
642 # instantiate the model, and initialize it
643 model = object.__new__(cls)
644 model.__init__(pool, cr)
648 def _init_function_fields(cls, pool, cr):
649 # initialize the list of non-stored function fields for this model
650 pool._pure_function_fields[cls._name] = []
652 # process store of low-level function fields
653 for fname, column in cls._columns.iteritems():
654 if hasattr(column, 'digits_change'):
655 column.digits_change(cr)
656 # filter out existing store about this field
657 pool._store_function[cls._name] = [
659 for stored in pool._store_function.get(cls._name, [])
660 if (stored[0], stored[1]) != (cls._name, fname)
662 if not isinstance(column, fields.function):
665 # register it on the pool for invalidation
666 pool._pure_function_fields[cls._name].append(fname)
668 # process store parameter
671 get_ids = lambda self, cr, uid, ids, c={}: ids
672 store = {cls._name: (get_ids, None, column.priority, None)}
673 for model, spec in store.iteritems():
675 (fnct, fields2, order, length) = spec
677 (fnct, fields2, order) = spec
680 raise except_orm('Error',
681 ('Invalid function definition %s in object %s !\nYou must use the definition: store={object:(fnct, fields, priority, time length)}.' % (fname, cls._name)))
682 pool._store_function.setdefault(model, [])
683 t = (cls._name, fname, fnct, tuple(fields2) if fields2 else None, order, length)
684 if t not in pool._store_function[model]:
685 pool._store_function[model].append(t)
686 pool._store_function[model].sort(key=lambda x: x[4])
689 def _init_manual_fields(cls, pool, cr):
690 # Check whether the query is already done
691 if pool.fields_by_model is not None:
692 manual_fields = pool.fields_by_model.get(cls._name, [])
694 cr.execute('SELECT * FROM ir_model_fields WHERE model=%s AND state=%s', (cls._name, 'manual'))
695 manual_fields = cr.dictfetchall()
697 for field in manual_fields:
698 if field['name'] in cls._columns:
701 'string': field['field_description'],
702 'required': bool(field['required']),
703 'readonly': bool(field['readonly']),
704 'domain': eval(field['domain']) if field['domain'] else None,
705 'size': field['size'] or None,
706 'ondelete': field['on_delete'],
707 'translate': (field['translate']),
710 #'select': int(field['select_level'])
712 if field['serialization_field_id']:
713 cr.execute('SELECT name FROM ir_model_fields WHERE id=%s', (field['serialization_field_id'],))
714 attrs.update({'serialization_field': cr.fetchone()[0], 'type': field['ttype']})
715 if field['ttype'] in ['many2one', 'one2many', 'many2many']:
716 attrs.update({'relation': field['relation']})
717 cls._columns[field['name']] = fields.sparse(**attrs)
718 elif field['ttype'] == 'selection':
719 cls._columns[field['name']] = fields.selection(eval(field['selection']), **attrs)
720 elif field['ttype'] == 'reference':
721 cls._columns[field['name']] = fields.reference(selection=eval(field['selection']), **attrs)
722 elif field['ttype'] == 'many2one':
723 cls._columns[field['name']] = fields.many2one(field['relation'], **attrs)
724 elif field['ttype'] == 'one2many':
725 cls._columns[field['name']] = fields.one2many(field['relation'], field['relation_field'], **attrs)
726 elif field['ttype'] == 'many2many':
727 _rel1 = field['relation'].replace('.', '_')
728 _rel2 = field['model'].replace('.', '_')
729 _rel_name = 'x_%s_%s_%s_rel' % (_rel1, _rel2, field['name'])
730 cls._columns[field['name']] = fields.many2many(field['relation'], _rel_name, 'id1', 'id2', **attrs)
732 cls._columns[field['name']] = getattr(fields, field['ttype'])(**attrs)
735 def _init_constraints_onchanges(cls):
736 # store sql constraint error messages
737 for (key, _, msg) in cls._sql_constraints:
738 cls.pool._sql_error[cls._table + '_' + key] = msg
740 # collect constraint and onchange methods
741 cls._constraint_methods = []
742 cls._onchange_methods = defaultdict(list)
743 for attr, func in getmembers(cls, callable):
744 if hasattr(func, '_constrains'):
745 if not all(name in cls._fields for name in func._constrains):
746 _logger.warning("@constrains%r parameters must be field names", func._constrains)
747 cls._constraint_methods.append(func)
748 if hasattr(func, '_onchange'):
749 if not all(name in cls._fields for name in func._onchange):
750 _logger.warning("@onchange%r parameters must be field names", func._onchange)
751 for name in func._onchange:
752 cls._onchange_methods[name].append(func)
755 # In the past, this method was registering the model class in the server.
756 # This job is now done entirely by the metaclass MetaModel.
758 # Do not create an instance here. Model instances are created by method
762 def __init__(self, pool, cr):
763 """ Initialize a model and make it part of the given registry.
765 - copy the stored fields' functions in the registry,
766 - retrieve custom fields and add them in the model,
767 - ensure there is a many2one for each _inherits'd parent,
768 - update the children's _columns,
769 - give a chance to each field to initialize itself.
774 # link the class to the registry, and update the registry
776 cls._model = self # backward compatibility
777 pool.add(cls._name, self)
779 # determine description, table, sequence and log_access
780 if not cls._description:
781 cls._description = cls._name
783 cls._table = cls._name.replace('.', '_')
784 if not cls._sequence:
785 cls._sequence = cls._table + '_id_seq'
786 if not hasattr(cls, '_log_access'):
787 # If _log_access is not specified, it is the same value as _auto.
788 cls._log_access = cls._auto
791 if cls.is_transient():
792 cls._transient_check_count = 0
793 cls._transient_max_count = config.get('osv_memory_count_limit')
794 cls._transient_max_hours = config.get('osv_memory_age_limit')
795 assert cls._log_access, \
796 "TransientModels must have log_access turned on, " \
797 "in order to implement their access rights policy"
799 # retrieve new-style fields and duplicate them (to avoid clashes with
800 # inheritance between different models)
802 for attr, field in getmembers(cls, Field.__instancecheck__):
803 if not field._origin:
804 cls._add_field(attr, field.copy())
806 # introduce magic fields
807 cls._add_magic_fields()
809 # register stuff about low-level function fields and custom fields
810 cls._init_function_fields(pool, cr)
811 cls._init_manual_fields(pool, cr)
814 cls._inherits_check()
815 cls._inherits_reload()
817 # register constraints and onchange methods
818 cls._init_constraints_onchanges()
821 for k in cls._defaults:
822 assert k in cls._fields, \
823 "Model %s has a default for nonexiting field %s" % (cls._name, k)
826 for column in cls._columns.itervalues():
831 assert cls._rec_name in cls._fields, \
832 "Invalid rec_name %s for model %s" % (cls._rec_name, cls._name)
833 elif 'name' in cls._fields:
834 cls._rec_name = 'name'
836 # prepare ormcache, which must be shared by all instances of the model
839 def __export_xml_id(self):
840 """ Return a valid xml_id for the record `self`. """
841 ir_model_data = self.sudo().env['ir.model.data']
842 data = ir_model_data.search([('model', '=', self._name), ('res_id', '=', self.id)])
845 return '%s.%s' % (data[0].module, data[0].name)
850 name = '%s_%s' % (self._table, self.id)
851 while ir_model_data.search([('module', '=', '__export__'), ('name', '=', name)]):
853 name = '%s_%s_%s' % (self._table, self.id, postfix)
854 ir_model_data.create({
857 'module': '__export__',
860 return '__export__.' + name
863 def __export_rows(self, fields):
864 """ Export fields of the records in `self`.
866 :param fields: list of lists of fields to traverse
867 :return: list of lists of corresponding values
871 # main line of record, initially empty
872 current = [''] * len(fields)
873 lines.append(current)
875 # list of primary fields followed by secondary field(s)
878 # process column by column
879 for i, path in enumerate(fields):
884 if name in primary_done:
888 current[i] = str(record.id)
890 current[i] = record.__export_xml_id()
892 field = record._fields[name]
895 # this part could be simpler, but it has to be done this way
896 # in order to reproduce the former behavior
897 if not isinstance(value, BaseModel):
898 current[i] = field.convert_to_export(value, self.env)
900 primary_done.append(name)
902 # This is a special case, its strange behavior is intended!
903 if field.type == 'many2many' and len(path) > 1 and path[1] == 'id':
904 xml_ids = [r.__export_xml_id() for r in value]
905 current[i] = ','.join(xml_ids) or False
908 # recursively export the fields that follow name
909 fields2 = [(p[1:] if p and p[0] == name else []) for p in fields]
910 lines2 = value.__export_rows(fields2)
912 # merge first line with record's main line
913 for j, val in enumerate(lines2[0]):
916 # check value of current field
918 # assign xml_ids, and forget about remaining lines
919 xml_ids = [item[1] for item in value.name_get()]
920 current[i] = ','.join(xml_ids)
922 # append the other lines at the end
930 def export_data(self, fields_to_export, raw_data=False):
931 """ Export fields for selected objects
933 :param fields_to_export: list of fields
934 :param raw_data: True to return value in native Python type
935 :rtype: dictionary with a *datas* matrix
937 This method is used when exporting data via client menu
939 fields_to_export = map(fix_import_export_id_paths, fields_to_export)
941 self = self.with_context(export_raw_data=True)
942 return {'datas': self.__export_rows(fields_to_export)}
944 def import_data(self, cr, uid, fields, datas, mode='init', current_module='', noupdate=False, context=None, filename=None):
947 Use :meth:`~load` instead
949 Import given data in given module
951 This method is used when importing data via client menu.
953 Example of fields to import for a sale.order::
956 partner_id, (=name_search)
957 order_line/.id, (=database_id)
959 order_line/product_id/id, (=xml id)
960 order_line/price_unit,
961 order_line/product_uom_qty,
962 order_line/product_uom/id (=xml_id)
964 This method returns a 4-tuple with the following structure::
966 (return_code, errored_resource, error_message, unused)
968 * The first item is a return code, it is ``-1`` in case of
969 import error, or the last imported row number in case of success
970 * The second item contains the record data dict that failed to import
971 in case of error, otherwise it's 0
972 * The third item contains an error message string in case of error,
974 * The last item is currently unused, with no specific semantics
976 :param fields: list of fields to import
977 :param datas: data to import
978 :param mode: 'init' or 'update' for record creation
979 :param current_module: module name
980 :param noupdate: flag for record creation
981 :param filename: optional file to store partial import state for recovery
982 :returns: 4-tuple in the form (return_code, errored_resource, error_message, unused)
983 :rtype: (int, dict or 0, str or 0, str or 0)
985 context = dict(context) if context is not None else {}
986 context['_import_current_module'] = current_module
988 fields = map(fix_import_export_id_paths, fields)
989 ir_model_data_obj = self.pool.get('ir.model.data')
992 if m['type'] == 'error':
993 raise Exception(m['message'])
995 if config.get('import_partial') and filename:
996 with open(config.get('import_partial'), 'rb') as partial_import_file:
997 data = pickle.load(partial_import_file)
998 position = data.get(filename, 0)
1002 for res_id, xml_id, res, info in self._convert_records(cr, uid,
1003 self._extract_records(cr, uid, fields, datas,
1004 context=context, log=log),
1005 context=context, log=log):
1006 ir_model_data_obj._update(cr, uid, self._name,
1007 current_module, res, mode=mode, xml_id=xml_id,
1008 noupdate=noupdate, res_id=res_id, context=context)
1009 position = info.get('rows', {}).get('to', 0) + 1
1010 if config.get('import_partial') and filename and (not (position%100)):
1011 with open(config.get('import_partial'), 'rb') as partial_import:
1012 data = pickle.load(partial_import)
1013 data[filename] = position
1014 with open(config.get('import_partial'), 'wb') as partial_import:
1015 pickle.dump(data, partial_import)
1016 if context.get('defer_parent_store_computation'):
1017 self._parent_store_compute(cr)
1019 except Exception, e:
1021 return -1, {}, 'Line %d : %s' % (position + 1, tools.ustr(e)), ''
1023 if context.get('defer_parent_store_computation'):
1024 self._parent_store_compute(cr)
1025 return position, 0, 0, 0
1027 def load(self, cr, uid, fields, data, context=None):
1029 Attempts to load the data matrix, and returns a list of ids (or
1030 ``False`` if there was an error and no id could be generated) and a
1033 The ids are those of the records created and saved (in database), in
1034 the same order they were extracted from the file. They can be passed
1035 directly to :meth:`~read`
1037 :param fields: list of fields to import, at the same index as the corresponding data
1038 :type fields: list(str)
1039 :param data: row-major matrix of data to import
1040 :type data: list(list(str))
1041 :param dict context:
1042 :returns: {ids: list(int)|False, messages: [Message]}
1044 cr.execute('SAVEPOINT model_load')
1047 fields = map(fix_import_export_id_paths, fields)
1048 ModelData = self.pool['ir.model.data'].clear_caches()
1050 fg = self.fields_get(cr, uid, context=context)
1057 for id, xid, record, info in self._convert_records(cr, uid,
1058 self._extract_records(cr, uid, fields, data,
1059 context=context, log=messages.append),
1060 context=context, log=messages.append):
1062 cr.execute('SAVEPOINT model_load_save')
1063 except psycopg2.InternalError, e:
1064 # broken transaction, exit and hope the source error was
1066 if not any(message['type'] == 'error' for message in messages):
1067 messages.append(dict(info, type='error',message=
1068 u"Unknown database error: '%s'" % e))
1071 ids.append(ModelData._update(cr, uid, self._name,
1072 current_module, record, mode=mode, xml_id=xid,
1073 noupdate=noupdate, res_id=id, context=context))
1074 cr.execute('RELEASE SAVEPOINT model_load_save')
1075 except psycopg2.Warning, e:
1076 messages.append(dict(info, type='warning', message=str(e)))
1077 cr.execute('ROLLBACK TO SAVEPOINT model_load_save')
1078 except psycopg2.Error, e:
1079 messages.append(dict(
1081 **PGERROR_TO_OE[e.pgcode](self, fg, info, e)))
1082 # Failed to write, log to messages, rollback savepoint (to
1083 # avoid broken transaction) and keep going
1084 cr.execute('ROLLBACK TO SAVEPOINT model_load_save')
1085 except Exception, e:
1086 message = (_('Unknown error during import:') +
1087 ' %s: %s' % (type(e), unicode(e)))
1088 moreinfo = _('Resolve other errors first')
1089 messages.append(dict(info, type='error',
1092 # Failed for some reason, perhaps due to invalid data supplied,
1093 # rollback savepoint and keep going
1094 cr.execute('ROLLBACK TO SAVEPOINT model_load_save')
1095 if any(message['type'] == 'error' for message in messages):
1096 cr.execute('ROLLBACK TO SAVEPOINT model_load')
1098 return {'ids': ids, 'messages': messages}
1100 def _extract_records(self, cr, uid, fields_, data,
1101 context=None, log=lambda a: None):
1102 """ Generates record dicts from the data sequence.
1104 The result is a generator of dicts mapping field names to raw
1105 (unconverted, unvalidated) values.
1107 For relational fields, if sub-fields were provided the value will be
1108 a list of sub-records
1110 The following sub-fields may be set on the record (by key):
1111 * None is the name_get for the record (to use with name_create/name_search)
1112 * "id" is the External ID for the record
1113 * ".id" is the Database ID for the record
1115 columns = dict((k, v.column) for k, v in self._all_columns.iteritems())
1116 # Fake columns to avoid special cases in extractor
1117 columns[None] = fields.char('rec_name')
1118 columns['id'] = fields.char('External ID')
1119 columns['.id'] = fields.integer('Database ID')
1121 # m2o fields can't be on multiple lines so exclude them from the
1122 # is_relational field rows filter, but special-case it later on to
1123 # be handled with relational fields (as it can have subfields)
1124 is_relational = lambda field: columns[field]._type in ('one2many', 'many2many', 'many2one')
1125 get_o2m_values = itemgetter_tuple(
1126 [index for index, field in enumerate(fields_)
1127 if columns[field[0]]._type == 'one2many'])
1128 get_nono2m_values = itemgetter_tuple(
1129 [index for index, field in enumerate(fields_)
1130 if columns[field[0]]._type != 'one2many'])
1131 # Checks if the provided row has any non-empty non-relational field
1132 def only_o2m_values(row, f=get_nono2m_values, g=get_o2m_values):
1133 return any(g(row)) and not any(f(row))
1137 if index >= len(data): return
1140 # copy non-relational fields to record dict
1141 record = dict((field[0], value)
1142 for field, value in itertools.izip(fields_, row)
1143 if not is_relational(field[0]))
1145 # Get all following rows which have relational values attached to
1146 # the current record (no non-relational values)
1147 record_span = itertools.takewhile(
1148 only_o2m_values, itertools.islice(data, index + 1, None))
1149 # stitch record row back on for relational fields
1150 record_span = list(itertools.chain([row], record_span))
1151 for relfield in set(
1152 field[0] for field in fields_
1153 if is_relational(field[0])):
1154 column = columns[relfield]
1155 # FIXME: how to not use _obj without relying on fields_get?
1156 Model = self.pool[column._obj]
1158 # get only cells for this sub-field, should be strictly
1159 # non-empty, field path [None] is for name_get column
1160 indices, subfields = zip(*((index, field[1:] or [None])
1161 for index, field in enumerate(fields_)
1162 if field[0] == relfield))
1164 # return all rows which have at least one value for the
1165 # subfields of relfield
1166 relfield_data = filter(any, map(itemgetter_tuple(indices), record_span))
1167 record[relfield] = [subrecord
1168 for subrecord, _subinfo in Model._extract_records(
1169 cr, uid, subfields, relfield_data,
1170 context=context, log=log)]
1172 yield record, {'rows': {
1174 'to': index + len(record_span) - 1
1176 index += len(record_span)
1178 def _convert_records(self, cr, uid, records,
1179 context=None, log=lambda a: None):
1180 """ Converts records from the source iterable (recursive dicts of
1181 strings) into forms which can be written to the database (via
1182 self.create or (ir.model.data)._update)
1184 :returns: a list of triplets of (id, xid, record)
1185 :rtype: list((int|None, str|None, dict))
1187 if context is None: context = {}
1188 Converter = self.pool['ir.fields.converter']
1189 columns = dict((k, v.column) for k, v in self._all_columns.iteritems())
1190 Translation = self.pool['ir.translation']
1192 (f, (Translation._get_source(cr, uid, self._name + ',' + f, 'field',
1193 context.get('lang'))
1195 for f, column in columns.iteritems())
1197 convert = Converter.for_model(cr, uid, self, context=context)
1199 def _log(base, field, exception):
1200 type = 'warning' if isinstance(exception, Warning) else 'error'
1201 # logs the logical (not human-readable) field name for automated
1202 # processing of response, but injects human readable in message
1203 record = dict(base, type=type, field=field,
1204 message=unicode(exception.args[0]) % base)
1205 if len(exception.args) > 1 and exception.args[1]:
1206 record.update(exception.args[1])
1209 stream = CountingStream(records)
1210 for record, extras in stream:
1213 # name_get/name_create
1214 if None in record: pass
1221 dbid = int(record['.id'])
1223 # in case of overridden id column
1224 dbid = record['.id']
1225 if not self.search(cr, uid, [('id', '=', dbid)], context=context):
1228 record=stream.index,
1230 message=_(u"Unknown database identifier '%s'") % dbid))
1233 converted = convert(record, lambda field, err:\
1234 _log(dict(extras, record=stream.index, field=field_names[field]), field, err))
1236 yield dbid, xid, converted, dict(extras, record=stream.index)
1239 def _validate_fields(self, field_names):
1240 field_names = set(field_names)
1242 # old-style constraint methods
1243 trans = self.env['ir.translation']
1244 cr, uid, context = self.env.args
1247 for fun, msg, names in self._constraints:
1249 # validation must be context-independent; call `fun` without context
1250 valid = not (set(names) & field_names) or fun(self._model, cr, uid, ids)
1252 except Exception, e:
1253 _logger.debug('Exception while validating constraint', exc_info=True)
1255 extra_error = tools.ustr(e)
1258 res_msg = msg(self._model, cr, uid, ids, context=context)
1259 if isinstance(res_msg, tuple):
1260 template, params = res_msg
1261 res_msg = template % params
1263 res_msg = trans._get_source(self._name, 'constraint', self.env.lang, msg)
1265 res_msg += "\n\n%s\n%s" % (_('Error details:'), extra_error)
1267 _("Field(s) `%s` failed against a constraint: %s") %
1268 (', '.join(names), res_msg)
1271 raise except_orm('ValidateError', '\n'.join(errors))
1273 # new-style constraint methods
1274 for check in self._constraint_methods:
1275 if set(check._constrains) & field_names:
1278 def default_get(self, cr, uid, fields_list, context=None):
1279 """ Return default values for the fields in `fields_list`. Default
1280 values are determined by the context, user defaults, and the model
1283 :param fields_list: a list of field names
1284 :return: a dictionary mapping each field name to its corresponding
1285 default value; the keys of the dictionary are the fields in
1286 `fields_list` that have a default value different from ``False``.
1288 This method should not be overridden. In order to change the
1289 mechanism for determining default values, you should override method
1290 :meth:`add_default_value` instead.
1292 # trigger view init hook
1293 self.view_init(cr, uid, fields_list, context)
1295 # use a new record to determine default values
1296 record = self.new(cr, uid, {}, context=context)
1297 for name in fields_list:
1298 if name in self._fields:
1299 record[name] # force evaluation of defaults
1301 # retrieve defaults from record's cache
1302 result = self._convert_to_write(record._cache)
1303 for key, val in result.items():
1304 if isinstance(val, NewId):
1305 del result[key] # ignore new records in defaults
1309 def add_default_value(self, field):
1310 """ Set the default value of `field` to the new record `self`.
1311 The value must be assigned to `self`.
1313 assert not self.id, "Expected new record: %s" % self
1314 cr, uid, context = self.env.args
1317 # 1. look up context
1318 key = 'default_' + name
1320 self[name] = context[key]
1323 # 2. look up ir_values
1324 # Note: performance is good, because get_defaults_dict is cached!
1325 ir_values_dict = self.env['ir.values'].get_defaults_dict(self._name)
1326 if name in ir_values_dict:
1327 self[name] = ir_values_dict[name]
1330 # 3. look up property fields
1331 # TODO: get rid of this one
1332 column = self._columns.get(name)
1333 if isinstance(column, fields.property):
1334 self[name] = self.env['ir.property'].get(name, self._name)
1337 # 4. look up _defaults
1338 if name in self._defaults:
1339 value = self._defaults[name]
1341 value = value(self._model, cr, uid, context)
1345 # 5. delegate to field
1346 field.determine_default(self)
1348 def fields_get_keys(self, cr, user, context=None):
1349 res = self._columns.keys()
1350 # TODO I believe this loop can be replace by
1351 # res.extend(self._inherit_fields.key())
1352 for parent in self._inherits:
1353 res.extend(self.pool[parent].fields_get_keys(cr, user, context))
1356 def _rec_name_fallback(self, cr, uid, context=None):
1357 rec_name = self._rec_name
1358 if rec_name not in self._columns:
1359 rec_name = self._columns.keys()[0] if len(self._columns.keys()) > 0 else "id"
1363 # Overload this method if you need a window title which depends on the context
1365 def view_header_get(self, cr, user, view_id=None, view_type='form', context=None):
1368 def user_has_groups(self, cr, uid, groups, context=None):
1369 """Return true if the user is at least member of one of the groups
1370 in groups_str. Typically used to resolve `groups` attribute
1371 in view and model definitions.
1373 :param str groups: comma-separated list of fully-qualified group
1374 external IDs, e.g.: ``base.group_user,base.group_system``
1375 :return: True if the current user is a member of one of the
1378 return any(self.pool['res.users'].has_group(cr, uid, group_ext_id)
1379 for group_ext_id in groups.split(','))
1381 def _get_default_form_view(self, cr, user, context=None):
1382 """ Generates a default single-line form view using all fields
1383 of the current model except the m2m and o2m ones.
1385 :param cr: database cursor
1386 :param int user: user id
1387 :param dict context: connection context
1388 :returns: a form view as an lxml document
1389 :rtype: etree._Element
1391 view = etree.Element('form', string=self._description)
1392 group = etree.SubElement(view, 'group', col="4")
1393 for fname, field in self._fields.iteritems():
1394 if field.automatic or field.type in ('one2many', 'many2many'):
1397 etree.SubElement(group, 'field', name=fname)
1398 if field.type == 'text':
1399 etree.SubElement(group, 'newline')
1402 def _get_default_search_view(self, cr, user, context=None):
1403 """ Generates a single-field search view, based on _rec_name.
1405 :param cr: database cursor
1406 :param int user: user id
1407 :param dict context: connection context
1408 :returns: a tree view as an lxml document
1409 :rtype: etree._Element
1411 view = etree.Element('search', string=self._description)
1412 etree.SubElement(view, 'field', name=self._rec_name_fallback(cr, user, context))
1415 def _get_default_tree_view(self, cr, user, context=None):
1416 """ Generates a single-field tree view, based on _rec_name.
1418 :param cr: database cursor
1419 :param int user: user id
1420 :param dict context: connection context
1421 :returns: a tree view as an lxml document
1422 :rtype: etree._Element
1424 view = etree.Element('tree', string=self._description)
1425 etree.SubElement(view, 'field', name=self._rec_name_fallback(cr, user, context))
1428 def _get_default_calendar_view(self, cr, user, context=None):
1429 """ Generates a default calendar view by trying to infer
1430 calendar fields from a number of pre-set attribute names
1432 :param cr: database cursor
1433 :param int user: user id
1434 :param dict context: connection context
1435 :returns: a calendar view
1436 :rtype: etree._Element
1438 def set_first_of(seq, in_, to):
1439 """Sets the first value of `seq` also found in `in_` to
1440 the `to` attribute of the view being closed over.
1442 Returns whether it's found a suitable value (and set it on
1443 the attribute) or not
1451 view = etree.Element('calendar', string=self._description)
1452 etree.SubElement(view, 'field', name=self._rec_name_fallback(cr, user, context))
1454 if self._date_name not in self._columns:
1456 for dt in ['date', 'date_start', 'x_date', 'x_date_start']:
1457 if dt in self._columns:
1458 self._date_name = dt
1463 raise except_orm(_('Invalid Object Architecture!'), _("Insufficient fields for Calendar View!"))
1464 view.set('date_start', self._date_name)
1466 set_first_of(["user_id", "partner_id", "x_user_id", "x_partner_id"],
1467 self._columns, 'color')
1469 if not set_first_of(["date_stop", "date_end", "x_date_stop", "x_date_end"],
1470 self._columns, 'date_stop'):
1471 if not set_first_of(["date_delay", "planned_hours", "x_date_delay", "x_planned_hours"],
1472 self._columns, 'date_delay'):
1474 _('Invalid Object Architecture!'),
1475 _("Insufficient fields to generate a Calendar View for %s, missing a date_stop or a date_delay" % self._name))
1479 def fields_view_get(self, cr, uid, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
1481 Get the detailed composition of the requested view like fields, model, view architecture
1483 :param view_id: id of the view or None
1484 :param view_type: type of the view to return if view_id is None ('form', tree', ...)
1485 :param toolbar: true to include contextual actions
1486 :param submenu: deprecated
1487 :return: dictionary describing the composition of the requested view (including inherited views and extensions)
1488 :raise AttributeError:
1489 * if the inherited view has unknown position to work with other than 'before', 'after', 'inside', 'replace'
1490 * if some tag other than 'position' is found in parent view
1491 :raise Invalid ArchitectureError: if there is view type other than form, tree, calendar, search etc defined on the structure
1495 View = self.pool['ir.ui.view']
1498 'model': self._name,
1499 'field_parent': False,
1502 # try to find a view_id if none provided
1504 # <view_type>_view_ref in context can be used to overrride the default view
1505 view_ref_key = view_type + '_view_ref'
1506 view_ref = context.get(view_ref_key)
1509 module, view_ref = view_ref.split('.', 1)
1510 cr.execute("SELECT res_id FROM ir_model_data WHERE model='ir.ui.view' AND module=%s AND name=%s", (module, view_ref))
1511 view_ref_res = cr.fetchone()
1513 view_id = view_ref_res[0]
1515 _logger.warning('%r requires a fully-qualified external id (got: %r for model %s). '
1516 'Please use the complete `module.view_id` form instead.', view_ref_key, view_ref,
1520 # otherwise try to find the lowest priority matching ir.ui.view
1521 view_id = View.default_view(cr, uid, self._name, view_type, context=context)
1523 # context for post-processing might be overriden
1526 # read the view with inherited views applied
1527 root_view = View.read_combined(cr, uid, view_id, fields=['id', 'name', 'field_parent', 'type', 'model', 'arch'], context=context)
1528 result['arch'] = root_view['arch']
1529 result['name'] = root_view['name']
1530 result['type'] = root_view['type']
1531 result['view_id'] = root_view['id']
1532 result['field_parent'] = root_view['field_parent']
1533 # override context fro postprocessing
1534 if root_view.get('model') != self._name:
1535 ctx = dict(context, base_model_name=root_view.get('model'))
1537 # fallback on default views methods if no ir.ui.view could be found
1539 get_func = getattr(self, '_get_default_%s_view' % view_type)
1540 arch_etree = get_func(cr, uid, context)
1541 result['arch'] = etree.tostring(arch_etree, encoding='utf-8')
1542 result['type'] = view_type
1543 result['name'] = 'default'
1544 except AttributeError:
1545 raise except_orm(_('Invalid Architecture!'), _("No default view of type '%s' could be found !") % view_type)
1547 # Apply post processing, groups and modifiers etc...
1548 xarch, xfields = View.postprocess_and_fields(cr, uid, self._name, etree.fromstring(result['arch']), view_id, context=ctx)
1549 result['arch'] = xarch
1550 result['fields'] = xfields
1552 # Add related action information if aksed
1554 toclean = ('report_sxw_content', 'report_rml_content', 'report_sxw', 'report_rml', 'report_sxw_content_data', 'report_rml_content_data')
1560 ir_values_obj = self.pool.get('ir.values')
1561 resprint = ir_values_obj.get(cr, uid, 'action', 'client_print_multi', [(self._name, False)], False, context)
1562 resaction = ir_values_obj.get(cr, uid, 'action', 'client_action_multi', [(self._name, False)], False, context)
1563 resrelate = ir_values_obj.get(cr, uid, 'action', 'client_action_relate', [(self._name, False)], False, context)
1564 resaction = [clean(action) for action in resaction if view_type == 'tree' or not action[2].get('multi')]
1565 resprint = [clean(print_) for print_ in resprint if view_type == 'tree' or not print_[2].get('multi')]
1566 #When multi="True" set it will display only in More of the list view
1567 resrelate = [clean(action) for action in resrelate
1568 if (action[2].get('multi') and view_type == 'tree') or (not action[2].get('multi') and view_type == 'form')]
1570 for x in itertools.chain(resprint, resaction, resrelate):
1571 x['string'] = x['name']
1573 result['toolbar'] = {
1575 'action': resaction,
1580 def get_formview_id(self, cr, uid, id, context=None):
1581 """ Return an view id to open the document with. This method is meant to be
1582 overridden in addons that want to give specific view ids for example.
1584 :param int id: id of the document to open
1588 def get_formview_action(self, cr, uid, id, context=None):
1589 """ Return an action to open the document. This method is meant to be
1590 overridden in addons that want to give specific view ids for example.
1592 :param int id: id of the document to open
1594 view_id = self.get_formview_id(cr, uid, id, context=context)
1596 'type': 'ir.actions.act_window',
1597 'res_model': self._name,
1598 'view_type': 'form',
1599 'view_mode': 'form',
1600 'views': [(view_id, 'form')],
1601 'target': 'current',
1605 def get_access_action(self, cr, uid, id, context=None):
1606 """ Return an action to open the document. This method is meant to be
1607 overridden in addons that want to give specific access to the document.
1608 By default it opens the formview of the document.
1610 :paramt int id: id of the document to open
1612 return self.get_formview_action(cr, uid, id, context=context)
1614 def _view_look_dom_arch(self, cr, uid, node, view_id, context=None):
1615 return self.pool['ir.ui.view'].postprocess_and_fields(
1616 cr, uid, self._name, node, view_id, context=context)
1618 def search_count(self, cr, user, args, context=None):
1619 res = self.search(cr, user, args, context=context, count=True)
1620 if isinstance(res, list):
1624 @api.returns('self')
1625 def search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False):
1627 Search for records based on a search domain.
1629 :param cr: database cursor
1630 :param user: current user id
1631 :param args: list of tuples specifying the search domain [('field_name', 'operator', value), ...]. Pass an empty list to match all records.
1632 :param offset: optional number of results to skip in the returned values (default: 0)
1633 :param limit: optional max number of records to return (default: **None**)
1634 :param order: optional columns to sort by (default: self._order=id )
1635 :param context: optional context arguments, like lang, time zone
1636 :type context: dictionary
1637 :param count: optional (default: **False**), if **True**, returns only the number of records matching the criteria, not their ids
1638 :return: id or list of ids of records matching the criteria
1639 :rtype: integer or list of integers
1640 :raise AccessError: * if user tries to bypass access rules for read on the requested object.
1642 **Expressing a search domain (args)**
1644 Each tuple in the search domain needs to have 3 elements, in the form: **('field_name', 'operator', value)**, where:
1646 * **field_name** must be a valid name of field of the object model, possibly following many-to-one relationships using dot-notation, e.g 'street' or 'partner_id.country' are valid values.
1647 * **operator** must be a string with a valid comparison operator from this list: ``=, !=, >, >=, <, <=, like, ilike, in, not in, child_of, parent_left, parent_right``
1648 The semantics of most of these operators are obvious.
1649 The ``child_of`` operator will look for records who are children or grand-children of a given record,
1650 according to the semantics of this model (i.e following the relationship field named by
1651 ``self._parent_name``, by default ``parent_id``.
1652 * **value** must be a valid value to compare with the values of **field_name**, depending on its type.
1654 Domain criteria can be combined using 3 logical operators than can be added between tuples: '**&**' (logical AND, default), '**|**' (logical OR), '**!**' (logical NOT).
1655 These are **prefix** operators and the arity of the '**&**' and '**|**' operator is 2, while the arity of the '**!**' is just 1.
1656 Be very careful about this when you combine them the first time.
1658 Here is an example of searching for Partners named *ABC* from Belgium and Germany whose language is not english ::
1660 [('name','=','ABC'),'!',('language.code','=','en_US'),'|',('country_id.code','=','be'),('country_id.code','=','de'))
1662 The '&' is omitted as it is the default, and of course we could have used '!=' for the language, but what this domain really represents is::
1664 (name is 'ABC' AND (language is NOT english) AND (country is Belgium OR Germany))
1667 return self._search(cr, user, args, offset=offset, limit=limit, order=order, context=context, count=count)
1670 # display_name, name_get, name_create, name_search
1673 @api.depends(lambda self: (self._rec_name,) if self._rec_name else ())
1674 def _compute_display_name(self):
1675 for i, got_name in enumerate(self.name_get()):
1676 self[i].display_name = got_name[1]
1680 """ Return a textual representation for the records in `self`.
1681 By default this is the value of field ``display_name``.
1684 :return: list of pairs ``(id, text_repr)`` for all records
1687 name = self._rec_name
1688 if name in self._fields:
1689 convert = self._fields[name].convert_to_display_name
1691 result.append((record.id, convert(record[name])))
1694 result.append((record.id, "%s,%s" % (record._name, record.id)))
1699 def name_create(self, name):
1700 """ Create a new record by calling :meth:`~.create` with only one value
1701 provided: the display name of the new record.
1703 The new record will be initialized with any default values
1704 applicable to this model, or provided through the context. The usual
1705 behavior of :meth:`~.create` applies.
1707 :param name: display name of the record to create
1709 :return: the :meth:`~.name_get` pair value of the created record
1712 record = self.create({self._rec_name: name})
1713 return record.name_get()[0]
1715 _logger.warning("Cannot execute name_create, no _rec_name defined on %s", self._name)
1719 def name_search(self, name='', args=None, operator='ilike', limit=100):
1720 """ Search for records that have a display name matching the given
1721 `name` pattern when compared with the given `operator`, while also
1722 matching the optional search domain (`args`).
1724 This is used for example to provide suggestions based on a partial
1725 value for a relational field. Sometimes be seen as the inverse
1726 function of :meth:`~.name_get`, but it is not guaranteed to be.
1728 This method is equivalent to calling :meth:`~.search` with a search
1729 domain based on `display_name` and then :meth:`~.name_get` on the
1730 result of the search.
1732 :param name: the name pattern to match
1733 :param list args: optional search domain (see :meth:`~.search` for
1734 syntax), specifying further restrictions
1735 :param str operator: domain operator for matching `name`, such as
1736 ``'like'`` or ``'='``.
1737 :param int limit: optional max number of records to return
1739 :return: list of pairs ``(id, text_repr)`` for all matching records.
1741 return self._name_search(name, args, operator, limit=limit)
1743 def _name_search(self, cr, user, name='', args=None, operator='ilike', context=None, limit=100, name_get_uid=None):
1744 # private implementation of name_search, allows passing a dedicated user
1745 # for the name_get part to solve some access rights issues
1746 args = list(args or [])
1747 # optimize out the default criterion of ``ilike ''`` that matches everything
1748 if not self._rec_name:
1749 _logger.warning("Cannot execute name_search, no _rec_name defined on %s", self._name)
1750 elif not (name == '' and operator == 'ilike'):
1751 args += [(self._rec_name, operator, name)]
1752 access_rights_uid = name_get_uid or user
1753 ids = self._search(cr, user, args, limit=limit, context=context, access_rights_uid=access_rights_uid)
1754 res = self.name_get(cr, access_rights_uid, ids, context)
1757 def read_string(self, cr, uid, id, langs, fields=None, context=None):
1760 self.pool.get('ir.translation').check_access_rights(cr, uid, 'read')
1762 fields = self._columns.keys() + self._inherit_fields.keys()
1763 #FIXME: collect all calls to _get_source into one SQL call.
1765 res[lang] = {'code': lang}
1767 if f in self._columns:
1768 res_trans = self.pool.get('ir.translation')._get_source(cr, uid, self._name+','+f, 'field', lang)
1770 res[lang][f] = res_trans
1772 res[lang][f] = self._columns[f].string
1773 for table in self._inherits:
1774 cols = intersect(self._inherit_fields.keys(), fields)
1775 res2 = self.pool[table].read_string(cr, uid, id, langs, cols, context)
1778 res[lang]['code'] = lang
1779 for f in res2[lang]:
1780 res[lang][f] = res2[lang][f]
1783 def write_string(self, cr, uid, id, langs, vals, context=None):
1784 self.pool.get('ir.translation').check_access_rights(cr, uid, 'write')
1785 #FIXME: try to only call the translation in one SQL
1788 if field in self._columns:
1789 src = self._columns[field].string
1790 self.pool.get('ir.translation')._set_ids(cr, uid, self._name+','+field, 'field', lang, [0], vals[field], src)
1791 for table in self._inherits:
1792 cols = intersect(self._inherit_fields.keys(), vals)
1794 self.pool[table].write_string(cr, uid, id, langs, vals, context)
1797 def _add_missing_default_values(self, cr, uid, values, context=None):
1798 # avoid overriding inherited values when parent is set
1800 for tables, parent_field in self._inherits.items():
1801 if parent_field in values:
1802 avoid_tables.append(tables)
1804 # compute missing fields
1805 missing_defaults = set()
1806 for field in self._columns.keys():
1807 if not field in values:
1808 missing_defaults.add(field)
1809 for field in self._inherit_fields.keys():
1810 if (field not in values) and (self._inherit_fields[field][0] not in avoid_tables):
1811 missing_defaults.add(field)
1812 # discard magic fields
1813 missing_defaults -= set(MAGIC_COLUMNS)
1815 if missing_defaults:
1816 # override defaults with the provided values, never allow the other way around
1817 defaults = self.default_get(cr, uid, list(missing_defaults), context)
1819 if ((dv in self._columns and self._columns[dv]._type == 'many2many') \
1820 or (dv in self._inherit_fields and self._inherit_fields[dv][2]._type == 'many2many')) \
1821 and defaults[dv] and isinstance(defaults[dv][0], (int, long)):
1822 defaults[dv] = [(6, 0, defaults[dv])]
1823 if (dv in self._columns and self._columns[dv]._type == 'one2many' \
1824 or (dv in self._inherit_fields and self._inherit_fields[dv][2]._type == 'one2many')) \
1825 and isinstance(defaults[dv], (list, tuple)) and defaults[dv] and isinstance(defaults[dv][0], dict):
1826 defaults[dv] = [(0, 0, x) for x in defaults[dv]]
1827 defaults.update(values)
1831 def clear_caches(self):
1832 """ Clear the caches
1834 This clears the caches associated to methods decorated with
1835 ``tools.ormcache`` or ``tools.ormcache_multi``.
1838 self._ormcache.clear()
1839 self.pool._any_cache_cleared = True
1840 except AttributeError:
1844 def _read_group_fill_results(self, cr, uid, domain, groupby, remaining_groupbys, aggregated_fields,
1845 read_group_result, read_group_order=None, context=None):
1846 """Helper method for filling in empty groups for all possible values of
1847 the field being grouped by"""
1849 # self._group_by_full should map groupable fields to a method that returns
1850 # a list of all aggregated values that we want to display for this field,
1851 # in the form of a m2o-like pair (key,label).
1852 # This is useful to implement kanban views for instance, where all columns
1853 # should be displayed even if they don't contain any record.
1855 # Grab the list of all groups that should be displayed, including all present groups
1856 present_group_ids = [x[groupby][0] for x in read_group_result if x[groupby]]
1857 all_groups,folded = self._group_by_full[groupby](self, cr, uid, present_group_ids, domain,
1858 read_group_order=read_group_order,
1859 access_rights_uid=openerp.SUPERUSER_ID,
1862 result_template = dict.fromkeys(aggregated_fields, False)
1863 result_template[groupby + '_count'] = 0
1864 if remaining_groupbys:
1865 result_template['__context'] = {'group_by': remaining_groupbys}
1867 # Merge the left_side (current results as dicts) with the right_side (all
1868 # possible values as m2o pairs). Both lists are supposed to be using the
1869 # same ordering, and can be merged in one pass.
1872 def append_left(left_side):
1873 grouped_value = left_side[groupby] and left_side[groupby][0]
1874 if not grouped_value in known_values:
1875 result.append(left_side)
1876 known_values[grouped_value] = left_side
1878 count_attr = groupby + '_count'
1879 known_values[grouped_value].update({count_attr: left_side[count_attr]})
1880 def append_right(right_side):
1881 grouped_value = right_side[0]
1882 if not grouped_value in known_values:
1883 line = dict(result_template)
1884 line[groupby] = right_side
1885 line['__domain'] = [(groupby,'=',grouped_value)] + domain
1887 known_values[grouped_value] = line
1888 while read_group_result or all_groups:
1889 left_side = read_group_result[0] if read_group_result else None
1890 right_side = all_groups[0] if all_groups else None
1891 assert left_side is None or left_side[groupby] is False \
1892 or isinstance(left_side[groupby], (tuple,list)), \
1893 'M2O-like pair expected, got %r' % left_side[groupby]
1894 assert right_side is None or isinstance(right_side, (tuple,list)), \
1895 'M2O-like pair expected, got %r' % right_side
1896 if left_side is None:
1897 append_right(all_groups.pop(0))
1898 elif right_side is None:
1899 append_left(read_group_result.pop(0))
1900 elif left_side[groupby] == right_side:
1901 append_left(read_group_result.pop(0))
1902 all_groups.pop(0) # discard right_side
1903 elif not left_side[groupby] or not left_side[groupby][0]:
1904 # left side == "Undefined" entry, not present on right_side
1905 append_left(read_group_result.pop(0))
1907 append_right(all_groups.pop(0))
1911 r['__fold'] = folded.get(r[groupby] and r[groupby][0], False)
1914 def _read_group_prepare(self, orderby, aggregated_fields, annotated_groupbys, query):
1916 Prepares the GROUP BY and ORDER BY terms for the read_group method. Adds the missing JOIN clause
1917 to the query if order should be computed against m2o field.
1918 :param orderby: the orderby definition in the form "%(field)s %(order)s"
1919 :param aggregated_fields: list of aggregated fields in the query
1920 :param annotated_groupbys: list of dictionaries returned by _read_group_process_groupby
1921 These dictionaries contains the qualified name of each groupby
1922 (fully qualified SQL name for the corresponding field),
1923 and the (non raw) field name.
1924 :param osv.Query query: the query under construction
1925 :return: (groupby_terms, orderby_terms)
1928 groupby_terms = [gb['qualified_field'] for gb in annotated_groupbys]
1929 groupby_fields = [gb['groupby'] for gb in annotated_groupbys]
1931 return groupby_terms, orderby_terms
1933 self._check_qorder(orderby)
1934 for order_part in orderby.split(','):
1935 order_split = order_part.split()
1936 order_field = order_split[0]
1937 if order_field in groupby_fields:
1939 if self._all_columns[order_field.split(':')[0]].column._type == 'many2one':
1940 order_clause = self._generate_order_by(order_part, query).replace('ORDER BY ', '')
1942 orderby_terms.append(order_clause)
1943 groupby_terms += [order_term.split()[0] for order_term in order_clause.split(',')]
1945 order = '"%s" %s' % (order_field, '' if len(order_split) == 1 else order_split[1])
1946 orderby_terms.append(order)
1947 elif order_field in aggregated_fields:
1948 orderby_terms.append(order_part)
1950 # Cannot order by a field that will not appear in the results (needs to be grouped or aggregated)
1951 _logger.warn('%s: read_group order by `%s` ignored, cannot sort on empty columns (not grouped/aggregated)',
1952 self._name, order_part)
1953 return groupby_terms, orderby_terms
1955 def _read_group_process_groupby(self, gb, query, context):
1957 Helper method to collect important information about groupbys: raw
1958 field name, type, time informations, qualified name, ...
1960 split = gb.split(':')
1961 field_type = self._all_columns[split[0]].column._type
1962 gb_function = split[1] if len(split) == 2 else None
1963 temporal = field_type in ('date', 'datetime')
1964 tz_convert = field_type == 'datetime' and context.get('tz') in pytz.all_timezones
1965 qualified_field = self._inherits_join_calc(split[0], query)
1968 'day': 'dd MMM YYYY',
1969 'week': "'W'w YYYY",
1970 'month': 'MMMM YYYY',
1971 'quarter': 'QQQ YYYY',
1975 'day': dateutil.relativedelta.relativedelta(days=1),
1976 'week': datetime.timedelta(days=7),
1977 'month': dateutil.relativedelta.relativedelta(months=1),
1978 'quarter': dateutil.relativedelta.relativedelta(months=3),
1979 'year': dateutil.relativedelta.relativedelta(years=1)
1982 qualified_field = "timezone('%s', timezone('UTC',%s))" % (context.get('tz', 'UTC'), qualified_field)
1983 qualified_field = "date_trunc('%s', %s)" % (gb_function or 'month', qualified_field)
1984 if field_type == 'boolean':
1985 qualified_field = "coalesce(%s,false)" % qualified_field
1990 'display_format': display_formats[gb_function or 'month'] if temporal else None,
1991 'interval': time_intervals[gb_function or 'month'] if temporal else None,
1992 'tz_convert': tz_convert,
1993 'qualified_field': qualified_field
1996 def _read_group_prepare_data(self, key, value, groupby_dict, context):
1998 Helper method to sanitize the data received by read_group. The None
1999 values are converted to False, and the date/datetime are formatted,
2000 and corrected according to the timezones.
2002 value = False if value is None else value
2003 gb = groupby_dict.get(key)
2004 if gb and gb['type'] in ('date', 'datetime') and value:
2005 if isinstance(value, basestring):
2006 dt_format = DEFAULT_SERVER_DATETIME_FORMAT if gb['type'] == 'datetime' else DEFAULT_SERVER_DATE_FORMAT
2007 value = datetime.datetime.strptime(value, dt_format)
2008 if gb['tz_convert']:
2009 value = pytz.timezone(context['tz']).localize(value)
2012 def _read_group_get_domain(self, groupby, value):
2014 Helper method to construct the domain corresponding to a groupby and
2015 a given value. This is mostly relevant for date/datetime.
2017 if groupby['type'] in ('date', 'datetime') and value:
2018 dt_format = DEFAULT_SERVER_DATETIME_FORMAT if groupby['type'] == 'datetime' else DEFAULT_SERVER_DATE_FORMAT
2019 domain_dt_begin = value
2020 domain_dt_end = value + groupby['interval']
2021 if groupby['tz_convert']:
2022 domain_dt_begin = domain_dt_begin.astimezone(pytz.utc)
2023 domain_dt_end = domain_dt_end.astimezone(pytz.utc)
2024 return [(groupby['field'], '>=', domain_dt_begin.strftime(dt_format)),
2025 (groupby['field'], '<', domain_dt_end.strftime(dt_format))]
2026 if groupby['type'] == 'many2one' and value:
2028 return [(groupby['field'], '=', value)]
2030 def _read_group_format_result(self, data, annotated_groupbys, groupby, groupby_dict, domain, context):
2032 Helper method to format the data contained in the dictianary data by
2033 adding the domain corresponding to its values, the groupbys in the
2034 context and by properly formatting the date/datetime values.
2036 domain_group = [dom for gb in annotated_groupbys for dom in self._read_group_get_domain(gb, data[gb['groupby']])]
2037 for k,v in data.iteritems():
2038 gb = groupby_dict.get(k)
2039 if gb and gb['type'] in ('date', 'datetime') and v:
2040 data[k] = babel.dates.format_date(v, format=gb['display_format'], locale=context.get('lang', 'en_US'))
2042 data['__domain'] = domain_group + domain
2043 if len(groupby) - len(annotated_groupbys) >= 1:
2044 data['__context'] = { 'group_by': groupby[len(annotated_groupbys):]}
2048 def read_group(self, cr, uid, domain, fields, groupby, offset=0, limit=None, context=None, orderby=False, lazy=True):
2050 Get the list of records in list view grouped by the given ``groupby`` fields
2052 :param cr: database cursor
2053 :param uid: current user id
2054 :param domain: list specifying search criteria [['field_name', 'operator', 'value'], ...]
2055 :param list fields: list of fields present in the list view specified on the object
2056 :param list groupby: list of groupby descriptions by which the records will be grouped.
2057 A groupby description is either a field (then it will be grouped by that field)
2058 or a string 'field:groupby_function'. Right now, the only functions supported
2059 are 'day', 'week', 'month', 'quarter' or 'year', and they only make sense for
2060 date/datetime fields.
2061 :param int offset: optional number of records to skip
2062 :param int limit: optional max number of records to return
2063 :param dict context: context arguments, like lang, time zone.
2064 :param list orderby: optional ``order by`` specification, for
2065 overriding the natural sort ordering of the
2066 groups, see also :py:meth:`~osv.osv.osv.search`
2067 (supported only for many2one fields currently)
2068 :param bool lazy: if true, the results are only grouped by the first groupby and the
2069 remaining groupbys are put in the __context key. If false, all the groupbys are
2071 :return: list of dictionaries(one dictionary for each record) containing:
2073 * the values of fields grouped by the fields in ``groupby`` argument
2074 * __domain: list of tuples specifying the search criteria
2075 * __context: dictionary with argument like ``groupby``
2076 :rtype: [{'field_name_1': value, ...]
2077 :raise AccessError: * if user has no read rights on the requested object
2078 * if user tries to bypass access rules for read on the requested object
2082 self.check_access_rights(cr, uid, 'read')
2083 query = self._where_calc(cr, uid, domain, context=context)
2084 fields = fields or self._columns.keys()
2086 groupby = [groupby] if isinstance(groupby, basestring) else groupby
2087 groupby_list = groupby[:1] if lazy else groupby
2088 annotated_groupbys = [self._read_group_process_groupby(gb, query, context)
2089 for gb in groupby_list]
2090 groupby_fields = [g['field'] for g in annotated_groupbys]
2091 order = orderby or ','.join([g for g in groupby_list])
2092 groupby_dict = {gb['groupby']: gb for gb in annotated_groupbys}
2094 self._apply_ir_rules(cr, uid, query, 'read', context=context)
2095 for gb in groupby_fields:
2096 assert gb in fields, "Fields in 'groupby' must appear in the list of fields to read (perhaps it's missing in the list view?)"
2097 groupby_def = self._columns.get(gb) or (self._inherit_fields.get(gb) and self._inherit_fields.get(gb)[2])
2098 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"
2099 if not (gb in self._all_columns):
2100 # Don't allow arbitrary values, as this would be a SQL injection vector!
2101 raise except_orm(_('Invalid group_by'),
2102 _('Invalid group_by specification: "%s".\nA group_by specification must be a list of valid fields.')%(gb,))
2104 aggregated_fields = [
2106 if f not in ('id', 'sequence')
2107 if f not in groupby_fields
2108 if self._all_columns[f].column._type in ('integer', 'float')
2109 if getattr(self._all_columns[f].column, '_classic_write')]
2111 field_formatter = lambda f: (self._all_columns[f].column.group_operator or 'sum', self._inherits_join_calc(f, query), f)
2112 select_terms = ["%s(%s) AS %s" % field_formatter(f) for f in aggregated_fields]
2114 for gb in annotated_groupbys:
2115 select_terms.append('%s as "%s" ' % (gb['qualified_field'], gb['groupby']))
2117 groupby_terms, orderby_terms = self._read_group_prepare(order, aggregated_fields, annotated_groupbys, query)
2118 from_clause, where_clause, where_clause_params = query.get_sql()
2119 if lazy and (len(groupby_fields) >= 2 or not context.get('group_by_no_leaf')):
2120 count_field = groupby_fields[0] if len(groupby_fields) >= 1 else '_'
2124 prefix_terms = lambda prefix, terms: (prefix + " " + ",".join(terms)) if terms else ''
2125 prefix_term = lambda prefix, term: ('%s %s' % (prefix, term)) if term else ''
2128 SELECT min(%(table)s.id) AS id, count(%(table)s.id) AS %(count_field)s_count %(extra_fields)s
2136 'table': self._table,
2137 'count_field': count_field,
2138 'extra_fields': prefix_terms(',', select_terms),
2139 'from': from_clause,
2140 'where': prefix_term('WHERE', where_clause),
2141 'groupby': prefix_terms('GROUP BY', groupby_terms),
2142 'orderby': prefix_terms('ORDER BY', orderby_terms),
2143 'limit': prefix_term('LIMIT', int(limit) if limit else None),
2144 'offset': prefix_term('OFFSET', int(offset) if limit else None),
2146 cr.execute(query, where_clause_params)
2147 fetched_data = cr.dictfetchall()
2149 if not groupby_fields:
2152 many2onefields = [gb['field'] for gb in annotated_groupbys if gb['type'] == 'many2one']
2154 data_ids = [r['id'] for r in fetched_data]
2155 many2onefields = list(set(many2onefields))
2156 data_dict = {d['id']: d for d in self.read(cr, uid, data_ids, many2onefields, context=context)}
2157 for d in fetched_data:
2158 d.update(data_dict[d['id']])
2160 data = map(lambda r: {k: self._read_group_prepare_data(k,v, groupby_dict, context) for k,v in r.iteritems()}, fetched_data)
2161 result = [self._read_group_format_result(d, annotated_groupbys, groupby, groupby_dict, domain, context) for d in data]
2162 if lazy and groupby_fields[0] in self._group_by_full:
2163 # Right now, read_group only fill results in lazy mode (by default).
2164 # If you need to have the empty groups in 'eager' mode, then the
2165 # method _read_group_fill_results need to be completely reimplemented
2167 result = self._read_group_fill_results(cr, uid, domain, groupby_fields[0], groupby[len(annotated_groupbys):],
2168 aggregated_fields, result, read_group_order=order,
2172 def _inherits_join_add(self, current_model, parent_model_name, query):
2174 Add missing table SELECT and JOIN clause to ``query`` for reaching the parent table (no duplicates)
2175 :param current_model: current model object
2176 :param parent_model_name: name of the parent model for which the clauses should be added
2177 :param query: query object on which the JOIN should be added
2179 inherits_field = current_model._inherits[parent_model_name]
2180 parent_model = self.pool[parent_model_name]
2181 parent_alias, parent_alias_statement = query.add_join((current_model._table, parent_model._table, inherits_field, 'id', inherits_field), implicit=True)
2184 def _inherits_join_calc(self, field, query):
2186 Adds missing table select and join clause(s) to ``query`` for reaching
2187 the field coming from an '_inherits' parent table (no duplicates).
2189 :param field: name of inherited field to reach
2190 :param query: query object on which the JOIN should be added
2191 :return: qualified name of field, to be used in SELECT clause
2193 current_table = self
2194 parent_alias = '"%s"' % current_table._table
2195 while field in current_table._inherit_fields and not field in current_table._columns:
2196 parent_model_name = current_table._inherit_fields[field][0]
2197 parent_table = self.pool[parent_model_name]
2198 parent_alias = self._inherits_join_add(current_table, parent_model_name, query)
2199 current_table = parent_table
2200 return '%s."%s"' % (parent_alias, field)
2202 def _parent_store_compute(self, cr):
2203 if not self._parent_store:
2205 _logger.info('Computing parent left and right for table %s...', self._table)
2206 def browse_rec(root, pos=0):
2208 where = self._parent_name+'='+str(root)
2210 where = self._parent_name+' IS NULL'
2211 if self._parent_order:
2212 where += ' order by '+self._parent_order
2213 cr.execute('SELECT id FROM '+self._table+' WHERE '+where)
2215 for id in cr.fetchall():
2216 pos2 = browse_rec(id[0], pos2)
2217 cr.execute('update '+self._table+' set parent_left=%s, parent_right=%s where id=%s', (pos, pos2, root))
2219 query = 'SELECT id FROM '+self._table+' WHERE '+self._parent_name+' IS NULL'
2220 if self._parent_order:
2221 query += ' order by ' + self._parent_order
2224 for (root,) in cr.fetchall():
2225 pos = browse_rec(root, pos)
2226 self.invalidate_cache(cr, SUPERUSER_ID, ['parent_left', 'parent_right'])
2229 def _update_store(self, cr, f, k):
2230 _logger.info("storing computed values of fields.function '%s'", k)
2231 ss = self._columns[k]._symbol_set
2232 update_query = 'UPDATE "%s" SET "%s"=%s WHERE id=%%s' % (self._table, k, ss[0])
2233 cr.execute('select id from '+self._table)
2234 ids_lst = map(lambda x: x[0], cr.fetchall())
2236 iids = ids_lst[:AUTOINIT_RECALCULATE_STORED_FIELDS]
2237 ids_lst = ids_lst[AUTOINIT_RECALCULATE_STORED_FIELDS:]
2238 res = f.get(cr, self, iids, k, SUPERUSER_ID, {})
2239 for key, val in res.items():
2242 # if val is a many2one, just write the ID
2243 if type(val) == tuple:
2245 if val is not False:
2246 cr.execute(update_query, (ss[1](val), key))
2248 def _check_selection_field_value(self, cr, uid, field, value, context=None):
2249 """Raise except_orm if value is not among the valid values for the selection field"""
2250 if self._columns[field]._type == 'reference':
2251 val_model, val_id_str = value.split(',', 1)
2254 val_id = long(val_id_str)
2258 raise except_orm(_('ValidateError'),
2259 _('Invalid value for reference field "%s.%s" (last part must be a non-zero integer): "%s"') % (self._table, field, value))
2263 if isinstance(self._columns[field].selection, (tuple, list)):
2264 if val in dict(self._columns[field].selection):
2266 elif val in dict(self._columns[field].selection(self, cr, uid, context=context)):
2268 raise except_orm(_('ValidateError'),
2269 _('The value "%s" for the field "%s.%s" is not in the selection') % (value, self._name, field))
2271 def _check_removed_columns(self, cr, log=False):
2272 # iterate on the database columns to drop the NOT NULL constraints
2273 # of fields which were required but have been removed (or will be added by another module)
2274 columns = [c for c in self._columns if not (isinstance(self._columns[c], fields.function) and not self._columns[c].store)]
2275 columns += MAGIC_COLUMNS
2276 cr.execute("SELECT a.attname, a.attnotnull"
2277 " FROM pg_class c, pg_attribute a"
2278 " WHERE c.relname=%s"
2279 " AND c.oid=a.attrelid"
2280 " AND a.attisdropped=%s"
2281 " AND pg_catalog.format_type(a.atttypid, a.atttypmod) NOT IN ('cid', 'tid', 'oid', 'xid')"
2282 " AND a.attname NOT IN %s", (self._table, False, tuple(columns))),
2284 for column in cr.dictfetchall():
2286 _logger.debug("column %s is in the table %s but not in the corresponding object %s",
2287 column['attname'], self._table, self._name)
2288 if column['attnotnull']:
2289 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, column['attname']))
2290 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2291 self._table, column['attname'])
2293 def _save_constraint(self, cr, constraint_name, type):
2295 Record the creation of a constraint for this model, to make it possible
2296 to delete it later when the module is uninstalled. Type can be either
2297 'f' or 'u' depending on the constraint being a foreign key or not.
2299 if not self._module:
2300 # no need to save constraints for custom models as they're not part
2303 assert type in ('f', 'u')
2305 SELECT 1 FROM ir_model_constraint, ir_module_module
2306 WHERE ir_model_constraint.module=ir_module_module.id
2307 AND ir_model_constraint.name=%s
2308 AND ir_module_module.name=%s
2309 """, (constraint_name, self._module))
2312 INSERT INTO ir_model_constraint
2313 (name, date_init, date_update, module, model, type)
2314 VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2315 (SELECT id FROM ir_module_module WHERE name=%s),
2316 (SELECT id FROM ir_model WHERE model=%s), %s)""",
2317 (constraint_name, self._module, self._name, type))
2319 def _save_relation_table(self, cr, relation_table):
2321 Record the creation of a many2many for this model, to make it possible
2322 to delete it later when the module is uninstalled.
2325 SELECT 1 FROM ir_model_relation, ir_module_module
2326 WHERE ir_model_relation.module=ir_module_module.id
2327 AND ir_model_relation.name=%s
2328 AND ir_module_module.name=%s
2329 """, (relation_table, self._module))
2331 cr.execute("""INSERT INTO ir_model_relation (name, date_init, date_update, module, model)
2332 VALUES (%s, now() AT TIME ZONE 'UTC', now() AT TIME ZONE 'UTC',
2333 (SELECT id FROM ir_module_module WHERE name=%s),
2334 (SELECT id FROM ir_model WHERE model=%s))""",
2335 (relation_table, self._module, self._name))
2336 self.invalidate_cache(cr, SUPERUSER_ID)
2338 # checked version: for direct m2o starting from `self`
2339 def _m2o_add_foreign_key_checked(self, source_field, dest_model, ondelete):
2340 assert self.is_transient() or not dest_model.is_transient(), \
2341 'Many2One relationships from non-transient Model to TransientModel are forbidden'
2342 if self.is_transient() and not dest_model.is_transient():
2343 # TransientModel relationships to regular Models are annoying
2344 # usually because they could block deletion due to the FKs.
2345 # So unless stated otherwise we default them to ondelete=cascade.
2346 ondelete = ondelete or 'cascade'
2347 fk_def = (self._table, source_field, dest_model._table, ondelete or 'set null')
2348 self._foreign_keys.add(fk_def)
2349 _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2351 # unchecked version: for custom cases, such as m2m relationships
2352 def _m2o_add_foreign_key_unchecked(self, source_table, source_field, dest_model, ondelete):
2353 fk_def = (source_table, source_field, dest_model._table, ondelete or 'set null')
2354 self._foreign_keys.add(fk_def)
2355 _schema.debug("Table '%s': added foreign key '%s' with definition=REFERENCES \"%s\" ON DELETE %s", *fk_def)
2357 def _drop_constraint(self, cr, source_table, constraint_name):
2358 cr.execute("ALTER TABLE %s DROP CONSTRAINT %s" % (source_table,constraint_name))
2360 def _m2o_fix_foreign_key(self, cr, source_table, source_field, dest_model, ondelete):
2361 # Find FK constraint(s) currently established for the m2o field,
2362 # and see whether they are stale or not
2363 cr.execute("""SELECT confdeltype as ondelete_rule, conname as constraint_name,
2364 cl2.relname as foreign_table
2365 FROM pg_constraint as con, pg_class as cl1, pg_class as cl2,
2366 pg_attribute as att1, pg_attribute as att2
2367 WHERE con.conrelid = cl1.oid
2368 AND cl1.relname = %s
2369 AND con.confrelid = cl2.oid
2370 AND array_lower(con.conkey, 1) = 1
2371 AND con.conkey[1] = att1.attnum
2372 AND att1.attrelid = cl1.oid
2373 AND att1.attname = %s
2374 AND array_lower(con.confkey, 1) = 1
2375 AND con.confkey[1] = att2.attnum
2376 AND att2.attrelid = cl2.oid
2377 AND att2.attname = %s
2378 AND con.contype = 'f'""", (source_table, source_field, 'id'))
2379 constraints = cr.dictfetchall()
2381 if len(constraints) == 1:
2382 # Is it the right constraint?
2384 if cons['ondelete_rule'] != POSTGRES_CONFDELTYPES.get((ondelete or 'set null').upper(), 'a')\
2385 or cons['foreign_table'] != dest_model._table:
2386 # Wrong FK: drop it and recreate
2387 _schema.debug("Table '%s': dropping obsolete FK constraint: '%s'",
2388 source_table, cons['constraint_name'])
2389 self._drop_constraint(cr, source_table, cons['constraint_name'])
2391 # it's all good, nothing to do!
2394 # Multiple FKs found for the same field, drop them all, and re-create
2395 for cons in constraints:
2396 _schema.debug("Table '%s': dropping duplicate FK constraints: '%s'",
2397 source_table, cons['constraint_name'])
2398 self._drop_constraint(cr, source_table, cons['constraint_name'])
2400 # (re-)create the FK
2401 self._m2o_add_foreign_key_checked(source_field, dest_model, ondelete)
2404 def _set_default_value_on_column(self, cr, column_name, context=None):
2405 # ideally should use add_default_value but fails
2406 # due to ir.values not being ready
2408 # get old-style default
2409 default = self._defaults.get(column_name)
2410 if callable(default):
2411 default = default(self, cr, SUPERUSER_ID, context)
2413 # get new_style default if no old-style
2415 record = self.new(cr, SUPERUSER_ID, context=context)
2416 field = self._fields[column_name]
2417 field.determine_default(record)
2418 defaults = dict(record._cache)
2419 if column_name in defaults:
2420 default = field.convert_to_write(defaults[column_name])
2422 ss = self._columns[column_name]._symbol_set
2423 store_default = ss[1](default)
2424 if store_default is not None:
2425 _logger.debug("Table '%s': setting default value of new column %s to %r",
2426 self._table, column_name, default)
2427 query = 'UPDATE "%s" SET "%s"=%s WHERE "%s" is NULL' % (
2428 self._table, column_name, ss[0], column_name)
2429 cr.execute(query, (store_default,))
2430 # this is a disgrace
2433 def _auto_init(self, cr, context=None):
2436 Call _field_create and, unless _auto is False:
2438 - create the corresponding table in database for the model,
2439 - possibly add the parent columns in database,
2440 - possibly add the columns 'create_uid', 'create_date', 'write_uid',
2441 'write_date' in database if _log_access is True (the default),
2442 - report on database columns no more existing in _columns,
2443 - remove no more existing not null constraints,
2444 - alter existing database columns to match _columns,
2445 - create database tables to match _columns,
2446 - add database indices to match _columns,
2447 - save in self._foreign_keys a list a foreign keys to create (see
2451 self._foreign_keys = set()
2452 raise_on_invalid_object_name(self._name)
2455 store_compute = False
2456 stored_fields = [] # new-style stored fields with compute
2458 update_custom_fields = context.get('update_custom_fields', False)
2459 self._field_create(cr, context=context)
2460 create = not self._table_exist(cr)
2464 self._create_table(cr)
2467 cr.execute('SELECT COUNT(1) FROM "%s"' % (self._table,))
2468 has_rows = cr.fetchone()[0]
2471 if self._parent_store:
2472 if not self._parent_columns_exist(cr):
2473 self._create_parent_columns(cr)
2474 store_compute = True
2476 self._check_removed_columns(cr, log=False)
2478 # iterate on the "object columns"
2479 column_data = self._select_column_data(cr)
2481 for k, f in self._columns.iteritems():
2482 if k == 'id': # FIXME: maybe id should be a regular column?
2484 # Don't update custom (also called manual) fields
2485 if f.manual and not update_custom_fields:
2488 if isinstance(f, fields.one2many):
2489 self._o2m_raise_on_missing_reference(cr, f)
2491 elif isinstance(f, fields.many2many):
2492 self._m2m_raise_or_create_relation(cr, f)
2495 res = column_data.get(k)
2497 # The field is not found as-is in database, try if it
2498 # exists with an old name.
2499 if not res and hasattr(f, 'oldname'):
2500 res = column_data.get(f.oldname)
2502 cr.execute('ALTER TABLE "%s" RENAME "%s" TO "%s"' % (self._table, f.oldname, k))
2504 column_data[k] = res
2505 _schema.debug("Table '%s': renamed column '%s' to '%s'",
2506 self._table, f.oldname, k)
2508 # The field already exists in database. Possibly
2509 # change its type, rename it, drop it or change its
2512 f_pg_type = res['typname']
2513 f_pg_size = res['size']
2514 f_pg_notnull = res['attnotnull']
2515 if isinstance(f, fields.function) and not f.store and\
2516 not getattr(f, 'nodrop', False):
2517 _logger.info('column %s (%s) converted to a function, removed from table %s',
2518 k, f.string, self._table)
2519 cr.execute('ALTER TABLE "%s" DROP COLUMN "%s" CASCADE' % (self._table, k))
2521 _schema.debug("Table '%s': dropped column '%s' with cascade",
2525 f_obj_type = get_pg_type(f) and get_pg_type(f)[0]
2530 ('text', 'char', pg_varchar(f.size), '::%s' % pg_varchar(f.size)),
2531 ('varchar', 'text', 'TEXT', ''),
2532 ('int4', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2533 ('date', 'datetime', 'TIMESTAMP', '::TIMESTAMP'),
2534 ('timestamp', 'date', 'date', '::date'),
2535 ('numeric', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2536 ('float8', 'float', get_pg_type(f)[1], '::'+get_pg_type(f)[1]),
2538 if f_pg_type == 'varchar' and f._type == 'char' and f_pg_size and (f.size is None or f_pg_size < f.size):
2540 with cr.savepoint():
2541 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" TYPE %s' % (self._table, k, pg_varchar(f.size)))
2542 except psycopg2.NotSupportedError:
2543 # In place alter table cannot be done because a view is depending of this field.
2544 # Do a manual copy. This will drop the view (that will be recreated later)
2545 cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO temp_change_size' % (self._table, k))
2546 cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, pg_varchar(f.size)))
2547 cr.execute('UPDATE "%s" SET "%s"=temp_change_size::%s' % (self._table, k, pg_varchar(f.size)))
2548 cr.execute('ALTER TABLE "%s" DROP COLUMN temp_change_size CASCADE' % (self._table,))
2550 _schema.debug("Table '%s': column '%s' (type varchar) changed size from %s to %s",
2551 self._table, k, f_pg_size or 'unlimited', f.size or 'unlimited')
2553 if (f_pg_type==c[0]) and (f._type==c[1]):
2554 if f_pg_type != f_obj_type:
2556 cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO __temp_type_cast' % (self._table, k))
2557 cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, c[2]))
2558 cr.execute(('UPDATE "%s" SET "%s"= __temp_type_cast'+c[3]) % (self._table, k))
2559 cr.execute('ALTER TABLE "%s" DROP COLUMN __temp_type_cast CASCADE' % (self._table,))
2561 _schema.debug("Table '%s': column '%s' changed type from %s to %s",
2562 self._table, k, c[0], c[1])
2565 if f_pg_type != f_obj_type:
2569 newname = k + '_moved' + str(i)
2570 cr.execute("SELECT count(1) FROM pg_class c,pg_attribute a " \
2571 "WHERE c.relname=%s " \
2572 "AND a.attname=%s " \
2573 "AND c.oid=a.attrelid ", (self._table, newname))
2574 if not cr.fetchone()[0]:
2578 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2579 cr.execute('ALTER TABLE "%s" RENAME COLUMN "%s" TO "%s"' % (self._table, k, newname))
2580 cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2581 cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2582 _schema.debug("Table '%s': column '%s' has changed type (DB=%s, def=%s), data moved to column %s !",
2583 self._table, k, f_pg_type, f._type, newname)
2585 # if the field is required and hasn't got a NOT NULL constraint
2586 if f.required and f_pg_notnull == 0:
2588 self._set_default_value_on_column(cr, k, context=context)
2589 # add the NOT NULL constraint
2591 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k), log_exceptions=False)
2593 _schema.debug("Table '%s': column '%s': added NOT NULL constraint",
2596 msg = "Table '%s': unable to set a NOT NULL constraint on column '%s' !\n"\
2597 "If you want to have it, you should update the records and execute manually:\n"\
2598 "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2599 _schema.warning(msg, self._table, k, self._table, k)
2601 elif not f.required and f_pg_notnull == 1:
2602 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" DROP NOT NULL' % (self._table, k))
2604 _schema.debug("Table '%s': column '%s': dropped NOT NULL constraint",
2607 indexname = '%s_%s_index' % (self._table, k)
2608 cr.execute("SELECT indexname FROM pg_indexes WHERE indexname = %s and tablename = %s", (indexname, self._table))
2609 res2 = cr.dictfetchall()
2610 if not res2 and f.select:
2611 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2613 if f._type == 'text':
2614 # FIXME: for fields.text columns we should try creating GIN indexes instead (seems most suitable for an ERP context)
2615 msg = "Table '%s': Adding (b-tree) index for %s column '%s'."\
2616 "This is probably useless (does not work for fulltext search) and prevents INSERTs of long texts"\
2617 " because there is a length limit for indexable btree values!\n"\
2618 "Use a search view instead if you simply want to make the field searchable."
2619 _schema.warning(msg, self._table, f._type, k)
2620 if res2 and not f.select:
2621 cr.execute('DROP INDEX "%s_%s_index"' % (self._table, k))
2623 msg = "Table '%s': dropping index for column '%s' of type '%s' as it is not required anymore"
2624 _schema.debug(msg, self._table, k, f._type)
2626 if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2627 dest_model = self.pool[f._obj]
2628 if dest_model._auto and dest_model._table != 'ir_actions':
2629 self._m2o_fix_foreign_key(cr, self._table, k, dest_model, f.ondelete)
2631 # The field doesn't exist in database. Create it if necessary.
2633 if not isinstance(f, fields.function) or f.store:
2634 # add the missing field
2635 cr.execute('ALTER TABLE "%s" ADD COLUMN "%s" %s' % (self._table, k, get_pg_type(f)[1]))
2636 cr.execute("COMMENT ON COLUMN %s.\"%s\" IS %%s" % (self._table, k), (f.string,))
2637 _schema.debug("Table '%s': added column '%s' with definition=%s",
2638 self._table, k, get_pg_type(f)[1])
2642 self._set_default_value_on_column(cr, k, context=context)
2644 # remember the functions to call for the stored fields
2645 if isinstance(f, fields.function):
2647 if f.store is not True: # i.e. if f.store is a dict
2648 order = f.store[f.store.keys()[0]][2]
2649 todo_end.append((order, self._update_store, (f, k)))
2651 # remember new-style stored fields with compute method
2652 if k in self._fields and self._fields[k].depends:
2653 stored_fields.append(self._fields[k])
2655 # and add constraints if needed
2656 if isinstance(f, fields.many2one) or (isinstance(f, fields.function) and f._type == 'many2one' and f.store):
2657 if f._obj not in self.pool:
2658 raise except_orm('Programming Error', 'There is no reference available for %s' % (f._obj,))
2659 dest_model = self.pool[f._obj]
2660 ref = dest_model._table
2661 # ir_actions is inherited so foreign key doesn't work on it
2662 if ref != 'ir_actions':
2663 self._m2o_add_foreign_key_checked(k, dest_model, f.ondelete)
2665 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (self._table, k, self._table, k))
2669 cr.execute('ALTER TABLE "%s" ALTER COLUMN "%s" SET NOT NULL' % (self._table, k))
2670 _schema.debug("Table '%s': column '%s': added a NOT NULL constraint",
2673 msg = "WARNING: unable to set column %s of table %s not null !\n"\
2674 "Try to re-run: openerp-server --update=module\n"\
2675 "If it doesn't work, update records and execute manually:\n"\
2676 "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL"
2677 _logger.warning(msg, k, self._table, self._table, k, exc_info=True)
2681 cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2682 create = not bool(cr.fetchone())
2684 cr.commit() # start a new transaction
2687 self._add_sql_constraints(cr)
2690 self._execute_sql(cr)
2693 self._parent_store_compute(cr)
2697 # trigger computation of new-style stored fields with a compute
2699 _logger.info("Storing computed values of %s fields %s",
2700 self._name, ', '.join(sorted(f.name for f in stored_fields)))
2701 recs = self.browse(cr, SUPERUSER_ID, [], {'active_test': False})
2702 recs = recs.search([])
2704 map(recs._recompute_todo, stored_fields)
2707 todo_end.append((1000, func, ()))
2711 def _auto_end(self, cr, context=None):
2712 """ Create the foreign keys recorded by _auto_init. """
2713 for t, k, r, d in self._foreign_keys:
2714 cr.execute('ALTER TABLE "%s" ADD FOREIGN KEY ("%s") REFERENCES "%s" ON DELETE %s' % (t, k, r, d))
2715 self._save_constraint(cr, "%s_%s_fkey" % (t, k), 'f')
2717 del self._foreign_keys
2720 def _table_exist(self, cr):
2721 cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (self._table,))
2725 def _create_table(self, cr):
2726 cr.execute('CREATE TABLE "%s" (id SERIAL NOT NULL, PRIMARY KEY(id))' % (self._table,))
2727 cr.execute(("COMMENT ON TABLE \"%s\" IS %%s" % self._table), (self._description,))
2728 _schema.debug("Table '%s': created", self._table)
2731 def _parent_columns_exist(self, cr):
2732 cr.execute("""SELECT c.relname
2733 FROM pg_class c, pg_attribute a
2734 WHERE c.relname=%s AND a.attname=%s AND c.oid=a.attrelid
2735 """, (self._table, 'parent_left'))
2739 def _create_parent_columns(self, cr):
2740 cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_left" INTEGER' % (self._table,))
2741 cr.execute('ALTER TABLE "%s" ADD COLUMN "parent_right" INTEGER' % (self._table,))
2742 if 'parent_left' not in self._columns:
2743 _logger.error('create a column parent_left on object %s: fields.integer(\'Left Parent\', select=1)',
2745 _schema.debug("Table '%s': added column '%s' with definition=%s",
2746 self._table, 'parent_left', 'INTEGER')
2747 elif not self._columns['parent_left'].select:
2748 _logger.error('parent_left column on object %s must be indexed! Add select=1 to the field definition)',
2750 if 'parent_right' not in self._columns:
2751 _logger.error('create a column parent_right on object %s: fields.integer(\'Right Parent\', select=1)',
2753 _schema.debug("Table '%s': added column '%s' with definition=%s",
2754 self._table, 'parent_right', 'INTEGER')
2755 elif not self._columns['parent_right'].select:
2756 _logger.error('parent_right column on object %s must be indexed! Add select=1 to the field definition)',
2758 if self._columns[self._parent_name].ondelete not in ('cascade', 'restrict'):
2759 _logger.error("The column %s on object %s must be set as ondelete='cascade' or 'restrict'",
2760 self._parent_name, self._name)
2765 def _select_column_data(self, cr):
2766 # attlen is the number of bytes necessary to represent the type when
2767 # the type has a fixed size. If the type has a varying size attlen is
2768 # -1 and atttypmod is the size limit + 4, or -1 if there is no limit.
2769 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 " \
2770 "FROM pg_class c,pg_attribute a,pg_type t " \
2771 "WHERE c.relname=%s " \
2772 "AND c.oid=a.attrelid " \
2773 "AND a.atttypid=t.oid", (self._table,))
2774 return dict(map(lambda x: (x['attname'], x),cr.dictfetchall()))
2777 def _o2m_raise_on_missing_reference(self, cr, f):
2778 # TODO this check should be a method on fields.one2many.
2779 if f._obj in self.pool:
2780 other = self.pool[f._obj]
2781 # TODO the condition could use fields_get_keys().
2782 if f._fields_id not in other._columns.keys():
2783 if f._fields_id not in other._inherit_fields.keys():
2784 raise except_orm('Programming Error', "There is no reference field '%s' found for '%s'" % (f._fields_id, f._obj,))
2786 def _m2m_raise_or_create_relation(self, cr, f):
2787 m2m_tbl, col1, col2 = f._sql_names(self)
2788 # do not create relations for custom fields as they do not belong to a module
2789 # they will be automatically removed when dropping the corresponding ir.model.field
2790 # table name for custom relation all starts with x_, see __init__
2791 if not m2m_tbl.startswith('x_'):
2792 self._save_relation_table(cr, m2m_tbl)
2793 cr.execute("SELECT relname FROM pg_class WHERE relkind IN ('r','v') AND relname=%s", (m2m_tbl,))
2794 if not cr.dictfetchall():
2795 if f._obj not in self.pool:
2796 raise except_orm('Programming Error', 'Many2Many destination model does not exist: `%s`' % (f._obj,))
2797 dest_model = self.pool[f._obj]
2798 ref = dest_model._table
2799 cr.execute('CREATE TABLE "%s" ("%s" INTEGER NOT NULL, "%s" INTEGER NOT NULL, UNIQUE("%s","%s"))' % (m2m_tbl, col1, col2, col1, col2))
2800 # create foreign key references with ondelete=cascade, unless the targets are SQL views
2801 cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (ref,))
2802 if not cr.fetchall():
2803 self._m2o_add_foreign_key_unchecked(m2m_tbl, col2, dest_model, 'cascade')
2804 cr.execute("SELECT relkind FROM pg_class WHERE relkind IN ('v') AND relname=%s", (self._table,))
2805 if not cr.fetchall():
2806 self._m2o_add_foreign_key_unchecked(m2m_tbl, col1, self, 'cascade')
2808 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col1, m2m_tbl, col1))
2809 cr.execute('CREATE INDEX "%s_%s_index" ON "%s" ("%s")' % (m2m_tbl, col2, m2m_tbl, col2))
2810 cr.execute("COMMENT ON TABLE \"%s\" IS 'RELATION BETWEEN %s AND %s'" % (m2m_tbl, self._table, ref))
2812 _schema.debug("Create table '%s': m2m relation between '%s' and '%s'", m2m_tbl, self._table, ref)
2815 def _add_sql_constraints(self, cr):
2818 Modify this model's database table constraints so they match the one in
2822 def unify_cons_text(txt):
2823 return txt.lower().replace(', ',',').replace(' (','(')
2825 for (key, con, _) in self._sql_constraints:
2826 conname = '%s_%s' % (self._table, key)
2828 self._save_constraint(cr, conname, 'u')
2829 cr.execute("SELECT conname, pg_catalog.pg_get_constraintdef(oid, true) as condef FROM pg_constraint where conname=%s", (conname,))
2830 existing_constraints = cr.dictfetchall()
2834 'query': 'ALTER TABLE "%s" DROP CONSTRAINT "%s"' % (self._table, conname, ),
2835 'msg_ok': "Table '%s': dropped constraint '%s'. Reason: its definition changed from '%%s' to '%s'" % (
2836 self._table, conname, con),
2837 'msg_err': "Table '%s': unable to drop \'%s\' constraint !" % (self._table, con),
2842 'query': 'ALTER TABLE "%s" ADD CONSTRAINT "%s" %s' % (self._table, conname, con,),
2843 'msg_ok': "Table '%s': added constraint '%s' with definition=%s" % (self._table, conname, con),
2844 '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" % (
2850 if not existing_constraints:
2851 # constraint does not exists:
2852 sql_actions['add']['execute'] = True
2853 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2854 elif unify_cons_text(con) not in [unify_cons_text(item['condef']) for item in existing_constraints]:
2855 # constraint exists but its definition has changed:
2856 sql_actions['drop']['execute'] = True
2857 sql_actions['drop']['msg_ok'] = sql_actions['drop']['msg_ok'] % (existing_constraints[0]['condef'].lower(), )
2858 sql_actions['add']['execute'] = True
2859 sql_actions['add']['msg_err'] = sql_actions['add']['msg_err'] % (sql_actions['add']['query'], )
2861 # we need to add the constraint:
2862 sql_actions = [item for item in sql_actions.values()]
2863 sql_actions.sort(key=lambda x: x['order'])
2864 for sql_action in [action for action in sql_actions if action['execute']]:
2866 cr.execute(sql_action['query'])
2868 _schema.debug(sql_action['msg_ok'])
2870 _schema.warning(sql_action['msg_err'])
2874 def _execute_sql(self, cr):
2875 """ Execute the SQL code from the _sql attribute (if any)."""
2876 if hasattr(self, "_sql"):
2877 for line in self._sql.split(';'):
2878 line2 = line.replace('\n', '').strip()
2884 # Update objects that uses this one to update their _inherits fields
2888 def _inherits_reload_src(cls):
2889 """ Recompute the _inherit_fields mapping on each _inherits'd child model."""
2890 for model in cls.pool.values():
2891 if cls._name in model._inherits:
2892 model._inherits_reload()
2895 def _inherits_reload(cls):
2896 """ Recompute the _inherit_fields mapping.
2898 This will also call itself on each inherits'd child model.
2902 for table in cls._inherits:
2903 other = cls.pool[table]
2904 for col in other._columns.keys():
2905 res[col] = (table, cls._inherits[table], other._columns[col], table)
2906 for col in other._inherit_fields.keys():
2907 res[col] = (table, cls._inherits[table], other._inherit_fields[col][2], other._inherit_fields[col][3])
2908 cls._inherit_fields = res
2909 cls._all_columns = cls._get_column_infos()
2911 # interface columns with new-style fields
2912 for attr, column in cls._columns.items():
2913 if attr not in cls._fields:
2914 cls._add_field(attr, column.to_field())
2916 # interface inherited fields with new-style fields (note that the
2917 # reverse order is for being consistent with _all_columns above)
2918 for parent_model, parent_field in reversed(cls._inherits.items()):
2919 for attr, field in cls.pool[parent_model]._fields.iteritems():
2920 if attr not in cls._fields:
2921 new_field = field.copy(related=(parent_field, attr), _origin=field)
2922 cls._add_field(attr, new_field)
2924 cls._inherits_reload_src()
2927 def _get_column_infos(cls):
2928 """Returns a dict mapping all fields names (direct fields and
2929 inherited field via _inherits) to a ``column_info`` struct
2930 giving detailed columns """
2932 # do not inverse for loops, since local fields may hide inherited ones!
2933 for k, (parent, m2o, col, original_parent) in cls._inherit_fields.iteritems():
2934 result[k] = fields.column_info(k, col, parent, m2o, original_parent)
2935 for k, col in cls._columns.iteritems():
2936 result[k] = fields.column_info(k, col)
2940 def _inherits_check(cls):
2941 for table, field_name in cls._inherits.items():
2942 if field_name not in cls._columns:
2943 _logger.info('Missing many2one field definition for _inherits reference "%s" in "%s", using default one.', field_name, cls._name)
2944 cls._columns[field_name] = fields.many2one(table, string="Automatically created field to link to parent %s" % table,
2945 required=True, ondelete="cascade")
2946 elif not cls._columns[field_name].required or cls._columns[field_name].ondelete.lower() not in ("cascade", "restrict"):
2947 _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)
2948 cls._columns[field_name].required = True
2949 cls._columns[field_name].ondelete = "cascade"
2951 # reflect fields with delegate=True in dictionary cls._inherits
2952 for field in cls._fields.itervalues():
2953 if field.type == 'many2one' and not field.related and field.delegate:
2954 if not field.required:
2955 _logger.warning("Field %s with delegate=True must be required.", field)
2956 field.required = True
2957 if field.ondelete.lower() not in ('cascade', 'restrict'):
2958 field.ondelete = 'cascade'
2959 cls._inherits[field.comodel_name] = field.name
2962 def _prepare_setup_fields(self):
2963 """ Prepare the setup of fields once the models have been loaded. """
2964 for field in self._fields.itervalues():
2968 def _setup_fields(self, partial=False):
2969 """ Setup the fields (dependency triggers, etc). """
2970 for field in self._fields.itervalues():
2971 if partial and field.manual and \
2972 field.relational and field.comodel_name not in self.pool:
2973 # do not set up manual fields that refer to unknown models
2975 field.setup(self.env)
2977 # group fields by compute to determine field.computed_fields
2978 fields_by_compute = defaultdict(list)
2979 for field in self._fields.itervalues():
2981 field.computed_fields = fields_by_compute[field.compute]
2982 field.computed_fields.append(field)
2984 field.computed_fields = []
2986 def fields_get(self, cr, user, allfields=None, context=None, write_access=True):
2987 """ Return the definition of each field.
2989 The returned value is a dictionary (indiced by field name) of
2990 dictionaries. The _inherits'd fields are included. The string, help,
2991 and selection (if present) attributes are translated.
2993 :param cr: database cursor
2994 :param user: current user id
2995 :param allfields: list of fields
2996 :param context: context arguments, like lang, time zone
2997 :return: dictionary of field dictionaries, each one describing a field of the business object
2998 :raise AccessError: * if user has no create/write rights on the requested object
3001 recs = self.browse(cr, user, [], context)
3004 for fname, field in self._fields.iteritems():
3005 if allfields and fname not in allfields:
3007 if field.groups and not recs.user_has_groups(field.groups):
3009 res[fname] = field.get_description(recs.env)
3011 # if user cannot create or modify records, make all fields readonly
3012 has_access = functools.partial(recs.check_access_rights, raise_exception=False)
3013 if not (has_access('write') or has_access('create')):
3014 for description in res.itervalues():
3015 description['readonly'] = True
3016 description['states'] = {}
3020 def get_empty_list_help(self, cr, user, help, context=None):
3021 """ Generic method giving the help message displayed when having
3022 no result to display in a list or kanban view. By default it returns
3023 the help given in parameter that is generally the help message
3024 defined in the action.
3028 def check_field_access_rights(self, cr, user, operation, fields, context=None):
3030 Check the user access rights on the given fields. This raises Access
3031 Denied if the user does not have the rights. Otherwise it returns the
3032 fields (as is if the fields is not falsy, or the readable/writable
3033 fields if fields is falsy).
3035 if user == SUPERUSER_ID:
3036 return fields or list(self._fields)
3039 """ determine whether user has access to field `fname` """
3040 field = self._fields.get(fname)
3041 if field and field.groups:
3042 return self.user_has_groups(cr, user, groups=field.groups, context=context)
3047 fields = filter(valid, self._fields)
3049 invalid_fields = set(filter(lambda name: not valid(name), fields))
3051 _logger.warning('Access Denied by ACLs for operation: %s, uid: %s, model: %s, fields: %s',
3052 operation, user, self._name, ', '.join(invalid_fields))
3054 _('The requested operation cannot be completed due to security restrictions. '
3055 'Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3056 (self._description, operation))
3060 # new-style implementation of read(); old-style is defined below
3062 def read(self, fields=None, load='_classic_read'):
3063 """ Read the given fields for the records in `self`.
3065 :param fields: optional list of field names to return (default is
3067 :param load: deprecated, this argument is ignored
3068 :return: a list of dictionaries mapping field names to their values,
3069 with one dictionary per record
3070 :raise AccessError: if user has no read rights on some of the given
3073 # check access rights
3074 self.check_access_rights('read')
3075 fields = self.check_field_access_rights('read', fields)
3077 # split fields into stored and computed fields
3078 stored, computed = [], []
3080 if name in self._columns:
3082 elif name in self._fields:
3083 computed.append(name)
3085 _logger.warning("%s.read() with unknown field '%s'", self._name, name)
3087 # fetch stored fields from the database to the cache
3088 self._read_from_database(stored)
3090 # retrieve results from records; this takes values from the cache and
3091 # computes remaining fields
3093 name_fields = [(name, self._fields[name]) for name in (stored + computed)]
3094 use_name_get = (load == '_classic_read')
3097 values = {'id': record.id}
3098 for name, field in name_fields:
3099 values[name] = field.convert_to_read(record[name], use_name_get)
3100 result.append(values)
3101 except MissingError:
3106 # add explicit old-style implementation to read()
3108 def read(self, cr, user, ids, fields=None, context=None, load='_classic_read'):
3109 records = self.browse(cr, user, ids, context)
3110 result = BaseModel.read(records, fields, load=load)
3111 return result if isinstance(ids, list) else (bool(result) and result[0])
3114 def _prefetch_field(self, field):
3115 """ Read from the database in order to fetch `field` (:class:`Field`
3116 instance) for `self` in cache.
3118 # fetch the records of this model without field_name in their cache
3121 # by default, simply fetch field
3122 fnames = {field.name}
3124 if self.env.in_draft:
3125 # we may be doing an onchange, do not prefetch other fields
3127 elif field in self.env.todo:
3128 # field must be recomputed, do not prefetch records to recompute
3129 records -= self.env.todo[field]
3130 elif self._columns[field.name]._prefetch:
3131 # here we can optimize: prefetch all classic and many2one fields
3133 for fname, fcolumn in self._columns.iteritems()
3134 if fcolumn._prefetch)
3136 # fetch records with read()
3137 assert self in records and field.name in fnames
3140 result = records.read(list(fnames), load='_classic_write')
3144 # check the cache, and update it if necessary
3145 if field not in self._cache:
3146 for values in result:
3147 record = self.browse(values.pop('id'))
3148 record._cache.update(record._convert_to_cache(values, validate=False))
3149 if field not in self._cache:
3150 e = AccessError("No value found for %s.%s" % (self, field.name))
3151 self._cache[field] = FailedValue(e)
3154 def _read_from_database(self, field_names):
3155 """ Read the given fields of the records in `self` from the database,
3156 and store them in cache. Access errors are also stored in cache.
3159 cr, user, context = env.args
3161 # Construct a clause for the security rules.
3162 # 'tables' holds the list of tables necessary for the SELECT, including
3163 # the ir.rule clauses, and contains at least self._table.
3164 rule_clause, rule_params, tables = env['ir.rule'].domain_get(self._name, 'read')
3166 # determine the fields that are stored as columns in self._table
3167 fields_pre = [f for f in field_names if self._columns[f]._classic_write]
3169 # we need fully-qualified column names in case len(tables) > 1
3171 if isinstance(self._columns.get(f), fields.binary) and \
3172 context.get('bin_size_%s' % f, context.get('bin_size')):
3173 # PG 9.2 introduces conflicting pg_size_pretty(numeric) -> need ::cast
3174 return 'pg_size_pretty(length(%s."%s")::bigint) as "%s"' % (self._table, f, f)
3176 return '%s."%s"' % (self._table, f)
3177 qual_names = map(qualify, set(fields_pre + ['id']))
3179 query = """ SELECT %(qual_names)s FROM %(tables)s
3180 WHERE %(table)s.id IN %%s AND (%(extra)s)
3183 'qual_names': ",".join(qual_names),
3184 'tables': ",".join(tables),
3185 'table': self._table,
3186 'extra': " OR ".join(rule_clause) if rule_clause else "TRUE",
3187 'order': self._parent_order or self._order,
3190 empty = self.browse()
3193 for field in (self._fields[name] for name in field_names):
3194 prefetch.update(self._in_cache_without(field).ids)
3195 todo.update(self.env.todo.get(field, empty).ids)
3196 records = self.browse(prefetch - todo | set(self.ids))
3199 for sub_ids in cr.split_for_in_conditions(records.ids):
3200 cr.execute(query, [tuple(sub_ids)] + rule_params)
3201 result.extend(cr.dictfetchall())
3203 ids = [vals['id'] for vals in result]
3206 # translate the fields if necessary
3207 if context.get('lang'):
3208 ir_translation = env['ir.translation']
3209 for f in fields_pre:
3210 if self._columns[f].translate:
3211 #TODO: optimize out of this loop
3212 res_trans = ir_translation._get_ids(
3213 '%s,%s' % (self._name, f), 'model', context['lang'], ids)
3215 vals[f] = res_trans.get(vals['id'], False) or vals[f]
3217 # apply the symbol_get functions of the fields we just read
3218 for f in fields_pre:
3219 symbol_get = self._columns[f]._symbol_get
3222 vals[f] = symbol_get(vals[f])
3224 # store result in cache for POST fields
3226 record = self.browse(vals['id'])
3227 record._cache.update(record._convert_to_cache(vals, validate=False))
3229 # determine the fields that must be processed now
3230 fields_post = [f for f in field_names if not self._columns[f]._classic_write]
3232 # Compute POST fields, grouped by multi
3233 by_multi = defaultdict(list)
3234 for f in fields_post:
3235 by_multi[self._columns[f]._multi].append(f)
3237 for multi, fs in by_multi.iteritems():
3239 res2 = self._columns[fs[0]].get(cr, self._model, ids, fs, user, context=context, values=result)
3240 assert res2 is not None, \
3241 'The function field "%s" on the "%s" model returned None\n' \
3242 '(a dictionary was expected).' % (fs[0], self._name)
3244 # TOCHECK : why got string instend of dict in python2.6
3245 # if isinstance(res2[vals['id']], str): res2[vals['id']] = eval(res2[vals['id']])
3246 multi_fields = res2.get(vals['id'], {})
3249 vals[f] = multi_fields.get(f, [])
3252 res2 = self._columns[f].get(cr, self._model, ids, f, user, context=context, values=result)
3255 vals[f] = res2[vals['id']]
3259 # Warn about deprecated fields now that fields_pre and fields_post are computed
3260 for f in field_names:
3261 column = self._columns[f]
3262 if column.deprecated:
3263 _logger.warning('Field %s.%s is deprecated: %s', self._name, f, column.deprecated)
3265 # store result in cache
3267 record = self.browse(vals.pop('id'))
3268 record._cache.update(record._convert_to_cache(vals, validate=False))
3270 # store failed values in cache for the records that could not be read
3271 fetched = self.browse(ids)
3272 missing = records - fetched
3274 extras = fetched - records
3277 _("Database fetch misses ids ({}) and has extra ids ({}), may be caused by a type incoherence in a previous request").format(
3278 ', '.join(map(repr, missing._ids)),
3279 ', '.join(map(repr, extras._ids)),
3281 # store an access error exception in existing records
3283 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3284 (self._name, 'read')
3286 forbidden = missing.exists()
3287 forbidden._cache.update(FailedValue(exc))
3288 # store a missing error exception in non-existing records
3290 _('One of the documents you are trying to access has been deleted, please try again after refreshing.')
3292 (missing - forbidden)._cache.update(FailedValue(exc))
3295 def get_metadata(self):
3297 Returns some metadata about the given records.
3299 :return: list of ownership dictionaries for each requested record
3300 :rtype: list of dictionaries with the following keys:
3303 * create_uid: user who created the record
3304 * create_date: date when the record was created
3305 * write_uid: last user who changed the record
3306 * write_date: date of the last change to the record
3307 * xmlid: XML ID to use to refer to this record (if there is one), in format ``module.name``
3310 if self._log_access:
3311 fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
3312 quoted_table = '"%s"' % self._table
3313 fields_str = ",".join('%s.%s' % (quoted_table, field) for field in fields)
3314 query = '''SELECT %s, __imd.module, __imd.name
3315 FROM %s LEFT JOIN ir_model_data __imd
3316 ON (__imd.model = %%s and __imd.res_id = %s.id)
3317 WHERE %s.id IN %%s''' % (fields_str, quoted_table, quoted_table, quoted_table)
3318 self._cr.execute(query, (self._name, tuple(self.ids)))
3319 res = self._cr.dictfetchall()
3321 uids = set(r[k] for r in res for k in ['write_uid', 'create_uid'] if r.get(k))
3322 names = dict(self.env['res.users'].browse(uids).name_get())
3326 value = r[key] = r[key] or False
3327 if key in ('write_uid', 'create_uid') and value in names:
3328 r[key] = (value, names[value])
3329 r['xmlid'] = ("%(module)s.%(name)s" % r) if r['name'] else False
3330 del r['name'], r['module']
3333 def _check_concurrency(self, cr, ids, context):
3336 if not (context.get(self.CONCURRENCY_CHECK_FIELD) and self._log_access):
3338 check_clause = "(id = %s AND %s < COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp)"
3339 for sub_ids in cr.split_for_in_conditions(ids):
3342 id_ref = "%s,%s" % (self._name, id)
3343 update_date = context[self.CONCURRENCY_CHECK_FIELD].pop(id_ref, None)
3345 ids_to_check.extend([id, update_date])
3346 if not ids_to_check:
3348 cr.execute("SELECT id FROM %s WHERE %s" % (self._table, " OR ".join([check_clause]*(len(ids_to_check)/2))), tuple(ids_to_check))
3351 # mention the first one only to keep the error message readable
3352 raise except_orm('ConcurrencyException', _('A document was modified since you last viewed it (%s:%d)') % (self._description, res[0]))
3354 def _check_record_rules_result_count(self, cr, uid, ids, result_ids, operation, context=None):
3355 """Verify the returned rows after applying record rules matches
3356 the length of `ids`, and raise an appropriate exception if it does not.
3360 ids, result_ids = set(ids), set(result_ids)
3361 missing_ids = ids - result_ids
3363 # Attempt to distinguish record rule restriction vs deleted records,
3364 # to provide a more specific error message - check if the missinf
3365 cr.execute('SELECT id FROM ' + self._table + ' WHERE id IN %s', (tuple(missing_ids),))
3366 forbidden_ids = [x[0] for x in cr.fetchall()]
3368 # the missing ids are (at least partially) hidden by access rules
3369 if uid == SUPERUSER_ID:
3371 _logger.warning('Access Denied by record rules for operation: %s on record ids: %r, uid: %s, model: %s', operation, forbidden_ids, uid, self._name)
3372 raise except_orm(_('Access Denied'),
3373 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
3374 (self._description, operation))
3376 # If we get here, the missing_ids are not in the database
3377 if operation in ('read','unlink'):
3378 # No need to warn about deleting an already deleted record.
3379 # And no error when reading a record that was deleted, to prevent spurious
3380 # errors for non-transactional search/read sequences coming from clients
3382 _logger.warning('Failed operation on deleted record(s): %s, uid: %s, model: %s', operation, uid, self._name)
3383 raise except_orm(_('Missing document(s)'),
3384 _('One of the documents you are trying to access has been deleted, please try again after refreshing.'))
3387 def check_access_rights(self, cr, uid, operation, raise_exception=True): # no context on purpose.
3388 """Verifies that the operation given by ``operation`` is allowed for the user
3389 according to the access rights."""
3390 return self.pool.get('ir.model.access').check(cr, uid, self._name, operation, raise_exception)
3392 def check_access_rule(self, cr, uid, ids, operation, context=None):
3393 """Verifies that the operation given by ``operation`` is allowed for the user
3394 according to ir.rules.
3396 :param operation: one of ``write``, ``unlink``
3397 :raise except_orm: * if current ir.rules do not permit this operation.
3398 :return: None if the operation is allowed
3400 if uid == SUPERUSER_ID:
3403 if self.is_transient():
3404 # Only one single implicit access rule for transient models: owner only!
3405 # This is ok to hardcode because we assert that TransientModels always
3406 # have log_access enabled so that the create_uid column is always there.
3407 # And even with _inherits, these fields are always present in the local
3408 # table too, so no need for JOINs.
3409 cr.execute("""SELECT distinct create_uid
3411 WHERE id IN %%s""" % self._table, (tuple(ids),))
3412 uids = [x[0] for x in cr.fetchall()]
3413 if len(uids) != 1 or uids[0] != uid:
3414 raise except_orm(_('Access Denied'),
3415 _('For this kind of document, you may only access records you created yourself.\n\n(Document type: %s)') % (self._description,))
3417 where_clause, where_params, tables = self.pool.get('ir.rule').domain_get(cr, uid, self._name, operation, context=context)
3419 where_clause = ' and ' + ' and '.join(where_clause)
3420 for sub_ids in cr.split_for_in_conditions(ids):
3421 cr.execute('SELECT ' + self._table + '.id FROM ' + ','.join(tables) +
3422 ' WHERE ' + self._table + '.id IN %s' + where_clause,
3423 [sub_ids] + where_params)
3424 returned_ids = [x['id'] for x in cr.dictfetchall()]
3425 self._check_record_rules_result_count(cr, uid, sub_ids, returned_ids, operation, context=context)
3427 def create_workflow(self, cr, uid, ids, context=None):
3428 """Create a workflow instance for each given record IDs."""
3429 from openerp import workflow
3431 workflow.trg_create(uid, self._name, res_id, cr)
3432 # self.invalidate_cache(cr, uid, context=context) ?
3435 def delete_workflow(self, cr, uid, ids, context=None):
3436 """Delete the workflow instances bound to the given record IDs."""
3437 from openerp import workflow
3439 workflow.trg_delete(uid, self._name, res_id, cr)
3440 self.invalidate_cache(cr, uid, context=context)
3443 def step_workflow(self, cr, uid, ids, context=None):
3444 """Reevaluate the workflow instances of the given record IDs."""
3445 from openerp import workflow
3447 workflow.trg_write(uid, self._name, res_id, cr)
3448 # self.invalidate_cache(cr, uid, context=context) ?
3451 def signal_workflow(self, cr, uid, ids, signal, context=None):
3452 """Send given workflow signal and return a dict mapping ids to workflow results"""
3453 from openerp import workflow
3456 result[res_id] = workflow.trg_validate(uid, self._name, res_id, signal, cr)
3457 # self.invalidate_cache(cr, uid, context=context) ?
3460 def redirect_workflow(self, cr, uid, old_new_ids, context=None):
3461 """ Rebind the workflow instance bound to the given 'old' record IDs to
3462 the given 'new' IDs. (``old_new_ids`` is a list of pairs ``(old, new)``.
3464 from openerp import workflow
3465 for old_id, new_id in old_new_ids:
3466 workflow.trg_redirect(uid, self._name, old_id, new_id, cr)
3467 self.invalidate_cache(cr, uid, context=context)
3470 def unlink(self, cr, uid, ids, context=None):
3472 Delete records with given ids
3474 :param cr: database cursor
3475 :param uid: current user id
3476 :param ids: id or list of ids
3477 :param context: (optional) context arguments, like lang, time zone
3479 :raise AccessError: * if user has no unlink rights on the requested object
3480 * if user tries to bypass access rules for unlink on the requested object
3481 :raise UserError: if the record is default property for other records
3486 if isinstance(ids, (int, long)):
3489 result_store = self._store_get_values(cr, uid, ids, self._all_columns.keys(), context)
3491 # for recomputing new-style fields
3492 recs = self.browse(cr, uid, ids, context)
3493 recs.modified(self._fields)
3495 self._check_concurrency(cr, ids, context)
3497 self.check_access_rights(cr, uid, 'unlink')
3499 ir_property = self.pool.get('ir.property')
3501 # Check if the records are used as default properties.
3502 domain = [('res_id', '=', False),
3503 ('value_reference', 'in', ['%s,%s' % (self._name, i) for i in ids]),
3505 if ir_property.search(cr, uid, domain, context=context):
3506 raise except_orm(_('Error'), _('Unable to delete this document because it is used as a default property'))
3508 # Delete the records' properties.
3509 property_ids = ir_property.search(cr, uid, [('res_id', 'in', ['%s,%s' % (self._name, i) for i in ids])], context=context)
3510 ir_property.unlink(cr, uid, property_ids, context=context)
3512 self.delete_workflow(cr, uid, ids, context=context)
3514 self.check_access_rule(cr, uid, ids, 'unlink', context=context)
3515 pool_model_data = self.pool.get('ir.model.data')
3516 ir_values_obj = self.pool.get('ir.values')
3517 for sub_ids in cr.split_for_in_conditions(ids):
3518 cr.execute('delete from ' + self._table + ' ' \
3519 'where id IN %s', (sub_ids,))
3521 # Removing the ir_model_data reference if the record being deleted is a record created by xml/csv file,
3522 # as these are not connected with real database foreign keys, and would be dangling references.
3523 # Note: following steps performed as admin to avoid access rights restrictions, and with no context
3524 # to avoid possible side-effects during admin calls.
3525 # Step 1. Calling unlink of ir_model_data only for the affected IDS
3526 reference_ids = pool_model_data.search(cr, SUPERUSER_ID, [('res_id','in',list(sub_ids)),('model','=',self._name)])
3527 # Step 2. Marching towards the real deletion of referenced records
3529 pool_model_data.unlink(cr, SUPERUSER_ID, reference_ids)
3531 # For the same reason, removing the record relevant to ir_values
3532 ir_value_ids = ir_values_obj.search(cr, uid,
3533 ['|',('value','in',['%s,%s' % (self._name, sid) for sid in sub_ids]),'&',('res_id','in',list(sub_ids)),('model','=',self._name)],
3536 ir_values_obj.unlink(cr, uid, ir_value_ids, context=context)
3538 # invalidate the *whole* cache, since the orm does not handle all
3539 # changes made in the database, like cascading delete!
3540 recs.invalidate_cache()
3542 for order, obj_name, store_ids, fields in result_store:
3543 if obj_name == self._name:
3544 effective_store_ids = set(store_ids) - set(ids)
3546 effective_store_ids = store_ids
3547 if effective_store_ids:
3548 obj = self.pool[obj_name]
3549 cr.execute('select id from '+obj._table+' where id IN %s', (tuple(effective_store_ids),))
3550 rids = map(lambda x: x[0], cr.fetchall())
3552 obj._store_set_values(cr, uid, rids, fields, context)
3554 # recompute new-style fields
3563 def write(self, vals):
3565 Update records in `self` with the given field values.
3567 :param vals: field values to update, e.g {'field_name': new_field_value, ...}
3568 :type vals: dictionary
3570 :raise AccessError: * if user has no write rights on the requested object
3571 * if user tries to bypass access rules for write on the requested object
3572 :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3573 :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)
3575 **Note**: The type of field values to pass in ``vals`` for relationship fields is specific:
3577 + For a many2many field, a list of tuples is expected.
3578 Here is the list of tuple that are accepted, with the corresponding semantics ::
3580 (0, 0, { values }) link to a new record that needs to be created with the given values dictionary
3581 (1, ID, { values }) update the linked record with id = ID (write *values* on it)
3582 (2, ID) remove and delete the linked record with id = ID (calls unlink on ID, that will delete the object completely, and the link to it as well)
3583 (3, ID) cut the link to the linked record with id = ID (delete the relationship between the two objects but does not delete the target object itself)
3584 (4, ID) link to existing record with id = ID (adds a relationship)
3585 (5) unlink all (like using (3,ID) for all linked records)
3586 (6, 0, [IDs]) replace the list of linked IDs (like using (5) then (4,ID) for each ID in the list of IDs)
3589 [(6, 0, [8, 5, 6, 4])] sets the many2many to ids [8, 5, 6, 4]
3591 + For a one2many field, a lits of tuples is expected.
3592 Here is the list of tuple that are accepted, with the corresponding semantics ::
3594 (0, 0, { values }) link to a new record that needs to be created with the given values dictionary
3595 (1, ID, { values }) update the linked record with id = ID (write *values* on it)
3596 (2, ID) remove and delete the linked record with id = ID (calls unlink on ID, that will delete the object completely, and the link to it as well)
3599 [(0, 0, {'field_name':field_value_record1, ...}), (0, 0, {'field_name':field_value_record2, ...})]
3601 + For a many2one field, simply use the ID of target record, which must already exist, or ``False`` to remove the link.
3602 + For a reference field, use a string with the model name, a comma, and the target object id (example: ``'product.product, 5'``)
3608 self._check_concurrency(self._ids)
3609 self.check_access_rights('write')
3611 # No user-driven update of these columns
3612 for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3613 vals.pop(field, None)
3615 # split up fields into old-style and pure new-style ones
3616 old_vals, new_vals, unknown = {}, {}, []
3617 for key, val in vals.iteritems():
3618 if key in self._columns:
3620 elif key in self._fields:
3626 _logger.warning("%s.write() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3628 # write old-style fields with (low-level) method _write
3630 self._write(old_vals)
3632 # put the values of pure new-style fields into cache, and inverse them
3635 record._cache.update(record._convert_to_cache(new_vals, update=True))
3636 for key in new_vals:
3637 self._fields[key].determine_inverse(self)
3641 def _write(self, cr, user, ids, vals, context=None):
3642 # low-level implementation of write()
3647 self.check_field_access_rights(cr, user, 'write', vals.keys())
3648 for field in vals.keys():
3650 if field in self._columns:
3651 fobj = self._columns[field]
3652 elif field in self._inherit_fields:
3653 fobj = self._inherit_fields[field][2]
3660 for group in groups:
3661 module = group.split(".")[0]
3662 grp = group.split(".")[1]
3663 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", \
3664 (grp, module, 'res.groups', user))
3665 readonly = cr.fetchall()
3666 if readonly[0][0] >= 1:
3673 result = self._store_get_values(cr, user, ids, vals.keys(), context) or []
3675 # for recomputing new-style fields
3676 recs = self.browse(cr, user, ids, context)
3677 modified_fields = list(vals)
3678 if self._log_access:
3679 modified_fields += ['write_date', 'write_uid']
3680 recs.modified(modified_fields)
3682 parents_changed = []
3683 parent_order = self._parent_order or self._order
3684 if self._parent_store and (self._parent_name in vals) and not context.get('defer_parent_store_computation'):
3685 # The parent_left/right computation may take up to
3686 # 5 seconds. No need to recompute the values if the
3687 # parent is the same.
3688 # Note: to respect parent_order, nodes must be processed in
3689 # order, so ``parents_changed`` must be ordered properly.
3690 parent_val = vals[self._parent_name]
3692 query = "SELECT id FROM %s WHERE id IN %%s AND (%s != %%s OR %s IS NULL) ORDER BY %s" % \
3693 (self._table, self._parent_name, self._parent_name, parent_order)
3694 cr.execute(query, (tuple(ids), parent_val))
3696 query = "SELECT id FROM %s WHERE id IN %%s AND (%s IS NOT NULL) ORDER BY %s" % \
3697 (self._table, self._parent_name, parent_order)
3698 cr.execute(query, (tuple(ids),))
3699 parents_changed = map(operator.itemgetter(0), cr.fetchall())
3706 totranslate = context.get('lang', False) and (context['lang'] != 'en_US')
3708 field_column = self._all_columns.get(field) and self._all_columns.get(field).column
3709 if field_column and field_column.deprecated:
3710 _logger.warning('Field %s.%s is deprecated: %s', self._name, field, field_column.deprecated)
3711 if field in self._columns:
3712 if self._columns[field]._classic_write and not (hasattr(self._columns[field], '_fnct_inv')):
3713 if (not totranslate) or not self._columns[field].translate:
3714 upd0.append('"'+field+'"='+self._columns[field]._symbol_set[0])
3715 upd1.append(self._columns[field]._symbol_set[1](vals[field]))
3716 direct.append(field)
3718 upd_todo.append(field)
3720 updend.append(field)
3721 if field in self._columns \
3722 and hasattr(self._columns[field], 'selection') \
3724 self._check_selection_field_value(cr, user, field, vals[field], context=context)
3726 if self._log_access:
3727 upd0.append('write_uid=%s')
3728 upd0.append("write_date=(now() at time zone 'UTC')")
3732 self.check_access_rule(cr, user, ids, 'write', context=context)
3733 for sub_ids in cr.split_for_in_conditions(ids):
3734 cr.execute('update ' + self._table + ' set ' + ','.join(upd0) + ' ' \
3735 'where id IN %s', upd1 + [sub_ids])
3736 if cr.rowcount != len(sub_ids):
3737 raise MissingError(_('One of the records you are trying to modify has already been deleted (Document type: %s).') % self._description)
3742 if self._columns[f].translate:
3743 src_trans = self.pool[self._name].read(cr, user, ids, [f])[0][f]
3746 # Inserting value to DB
3747 context_wo_lang = dict(context, lang=None)
3748 self.write(cr, user, ids, {f: vals[f]}, context=context_wo_lang)
3749 self.pool.get('ir.translation')._set_ids(cr, user, self._name+','+f, 'model', context['lang'], ids, vals[f], src_trans)
3751 # call the 'set' method of fields which are not classic_write
3752 upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
3754 # default element in context must be removed when call a one2many or many2many
3755 rel_context = context.copy()
3756 for c in context.items():
3757 if c[0].startswith('default_'):
3758 del rel_context[c[0]]
3760 for field in upd_todo:
3762 result += self._columns[field].set(cr, self, id, field, vals[field], user, context=rel_context) or []
3764 unknown_fields = updend[:]
3765 for table in self._inherits:
3766 col = self._inherits[table]
3768 for sub_ids in cr.split_for_in_conditions(ids):
3769 cr.execute('select distinct "'+col+'" from "'+self._table+'" ' \
3770 'where id IN %s', (sub_ids,))
3771 nids.extend([x[0] for x in cr.fetchall()])
3775 if self._inherit_fields[val][0] == table:
3777 unknown_fields.remove(val)
3779 self.pool[table].write(cr, user, nids, v, context)
3783 'No such field(s) in model %s: %s.',
3784 self._name, ', '.join(unknown_fields))
3786 # check Python constraints
3787 recs._validate_fields(vals)
3789 # TODO: use _order to set dest at the right position and not first node of parent
3790 # We can't defer parent_store computation because the stored function
3791 # fields that are computer may refer (directly or indirectly) to
3792 # parent_left/right (via a child_of domain)
3795 self.pool._init_parent[self._name] = True
3797 order = self._parent_order or self._order
3798 parent_val = vals[self._parent_name]
3800 clause, params = '%s=%%s' % (self._parent_name,), (parent_val,)
3802 clause, params = '%s IS NULL' % (self._parent_name,), ()
3804 for id in parents_changed:
3805 cr.execute('SELECT parent_left, parent_right FROM %s WHERE id=%%s' % (self._table,), (id,))
3806 pleft, pright = cr.fetchone()
3807 distance = pright - pleft + 1
3809 # Positions of current siblings, to locate proper insertion point;
3810 # this can _not_ be fetched outside the loop, as it needs to be refreshed
3811 # after each update, in case several nodes are sequentially inserted one
3812 # next to the other (i.e computed incrementally)
3813 cr.execute('SELECT parent_right, id FROM %s WHERE %s ORDER BY %s' % (self._table, clause, parent_order), params)
3814 parents = cr.fetchall()
3816 # Find Position of the element
3818 for (parent_pright, parent_id) in parents:
3821 position = parent_pright and parent_pright + 1 or 1
3823 # It's the first node of the parent
3828 cr.execute('select parent_left from '+self._table+' where id=%s', (parent_val,))
3829 position = cr.fetchone()[0] + 1
3831 if pleft < position <= pright:
3832 raise except_orm(_('UserError'), _('Recursivity Detected.'))
3834 if pleft < position:
3835 cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3836 cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3837 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))
3839 cr.execute('update '+self._table+' set parent_left=parent_left+%s where parent_left>=%s', (distance, position))
3840 cr.execute('update '+self._table+' set parent_right=parent_right+%s where parent_right>=%s', (distance, position))
3841 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))
3842 recs.invalidate_cache(['parent_left', 'parent_right'])
3844 result += self._store_get_values(cr, user, ids, vals.keys(), context)
3847 # for recomputing new-style fields
3848 recs.modified(modified_fields)
3851 for order, model_name, ids_to_update, fields_to_recompute in result:
3852 key = (model_name, tuple(fields_to_recompute))
3853 done.setdefault(key, {})
3854 # avoid to do several times the same computation
3856 for id in ids_to_update:
3857 if id not in done[key]:
3858 done[key][id] = True
3860 self.pool[model_name]._store_set_values(cr, user, todo, fields_to_recompute, context)
3862 # recompute new-style fields
3863 if context.get('recompute', True):
3866 self.step_workflow(cr, user, ids, context=context)
3870 # TODO: Should set perm to user.xxx
3873 @api.returns('self', lambda value: value.id)
3874 def create(self, vals):
3875 """ Create a new record for the model.
3877 The values for the new record are initialized using the dictionary
3878 `vals`, and if necessary the result of :meth:`default_get`.
3880 :param vals: field values like ``{'field_name': field_value, ...}``,
3881 see :meth:`write` for details about the values format
3882 :return: new record created
3883 :raise AccessError: * if user has no create rights on the requested object
3884 * if user tries to bypass access rules for create on the requested object
3885 :raise ValidateError: if user tries to enter invalid value for a field that is not in selection
3886 :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)
3888 self.check_access_rights('create')
3890 # add missing defaults, and drop fields that may not be set by user
3891 vals = self._add_missing_default_values(vals)
3892 for field in itertools.chain(MAGIC_COLUMNS, ('parent_left', 'parent_right')):
3893 vals.pop(field, None)
3895 # split up fields into old-style and pure new-style ones
3896 old_vals, new_vals, unknown = {}, {}, []
3897 for key, val in vals.iteritems():
3898 if key in self._all_columns:
3900 elif key in self._fields:
3906 _logger.warning("%s.create() with unknown fields: %s", self._name, ', '.join(sorted(unknown)))
3908 # create record with old-style fields
3909 record = self.browse(self._create(old_vals))
3911 # put the values of pure new-style fields into cache, and inverse them
3912 record._cache.update(record._convert_to_cache(new_vals))
3913 for key in new_vals:
3914 self._fields[key].determine_inverse(record)
3918 def _create(self, cr, user, vals, context=None):
3919 # low-level implementation of create()
3923 if self.is_transient():
3924 self._transient_vacuum(cr, user)
3927 for v in self._inherits:
3928 if self._inherits[v] not in vals:
3931 tocreate[v] = {'id': vals[self._inherits[v]]}
3934 # list of column assignments defined as tuples like:
3935 # (column_name, format_string, column_value)
3936 # (column_name, sql_formula)
3937 # Those tuples will be used by the string formatting for the INSERT
3939 ('id', "nextval('%s')" % self._sequence),
3944 for v in vals.keys():
3945 if v in self._inherit_fields and v not in self._columns:
3946 (table, col, col_detail, original_parent) = self._inherit_fields[v]
3947 tocreate[table][v] = vals[v]
3950 if (v not in self._inherit_fields) and (v not in self._columns):
3952 unknown_fields.append(v)
3955 'No such field(s) in model %s: %s.',
3956 self._name, ', '.join(unknown_fields))
3958 for table in tocreate:
3959 if self._inherits[table] in vals:
3960 del vals[self._inherits[table]]
3962 record_id = tocreate[table].pop('id', None)
3964 # When linking/creating parent records, force context without 'no_store_function' key that
3965 # defers stored functions computing, as these won't be computed in batch at the end of create().
3966 parent_context = dict(context)
3967 parent_context.pop('no_store_function', None)
3969 if record_id is None or not record_id:
3970 record_id = self.pool[table].create(cr, user, tocreate[table], context=parent_context)
3972 self.pool[table].write(cr, user, [record_id], tocreate[table], context=parent_context)
3974 updates.append((self._inherits[table], '%s', record_id))
3976 #Start : Set bool fields to be False if they are not touched(to make search more powerful)
3977 bool_fields = [x for x in self._columns.keys() if self._columns[x]._type=='boolean']
3979 for bool_field in bool_fields:
3980 if bool_field not in vals:
3981 vals[bool_field] = False
3983 for field in vals.keys():
3985 if field in self._columns:
3986 fobj = self._columns[field]
3988 fobj = self._inherit_fields[field][2]
3994 for group in groups:
3995 module = group.split(".")[0]
3996 grp = group.split(".")[1]
3997 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" % \
3998 (grp, module, 'res.groups', user))
3999 readonly = cr.fetchall()
4000 if readonly[0][0] >= 1:
4003 elif readonly[0][0] == 0:
4011 current_field = self._columns[field]
4012 if current_field._classic_write:
4013 updates.append((field, '%s', current_field._symbol_set[1](vals[field])))
4015 #for the function fields that receive a value, we set them directly in the database
4016 #(they may be required), but we also need to trigger the _fct_inv()
4017 if (hasattr(current_field, '_fnct_inv')) and not isinstance(current_field, fields.related):
4018 #TODO: this way to special case the related fields is really creepy but it shouldn't be changed at
4019 #one week of the release candidate. It seems the only good way to handle correctly this is to add an
4020 #attribute to make a field `really readonly´ and thus totally ignored by the create()... otherwise
4021 #if, for example, the related has a default value (for usability) then the fct_inv is called and it
4022 #may raise some access rights error. Changing this is a too big change for now, and is thus postponed
4023 #after the release but, definitively, the behavior shouldn't be different for related and function
4025 upd_todo.append(field)
4027 #TODO: this `if´ statement should be removed because there is no good reason to special case the fields
4028 #related. See the above TODO comment for further explanations.
4029 if not isinstance(current_field, fields.related):
4030 upd_todo.append(field)
4031 if field in self._columns \
4032 and hasattr(current_field, 'selection') \
4034 self._check_selection_field_value(cr, user, field, vals[field], context=context)
4035 if self._log_access:
4036 updates.append(('create_uid', '%s', user))
4037 updates.append(('write_uid', '%s', user))
4038 updates.append(('create_date', "(now() at time zone 'UTC')"))
4039 updates.append(('write_date', "(now() at time zone 'UTC')"))
4041 # the list of tuples used in this formatting corresponds to
4042 # tuple(field_name, format, value)
4043 # In some case, for example (id, create_date, write_date) we does not
4044 # need to read the third value of the tuple, because the real value is
4045 # encoded in the second value (the format).
4047 """INSERT INTO "%s" (%s) VALUES(%s) RETURNING id""" % (
4049 ', '.join('"%s"' % u[0] for u in updates),
4050 ', '.join(u[1] for u in updates)
4052 tuple([u[2] for u in updates if len(u) > 2])
4055 id_new, = cr.fetchone()
4056 recs = self.browse(cr, user, id_new, context)
4057 upd_todo.sort(lambda x, y: self._columns[x].priority-self._columns[y].priority)
4059 if self._parent_store and not context.get('defer_parent_store_computation'):
4061 self.pool._init_parent[self._name] = True
4063 parent = vals.get(self._parent_name, False)
4065 cr.execute('select parent_right from '+self._table+' where '+self._parent_name+'=%s order by '+(self._parent_order or self._order), (parent,))
4067 result_p = cr.fetchall()
4068 for (pleft,) in result_p:
4073 cr.execute('select parent_left from '+self._table+' where id=%s', (parent,))
4074 pleft_old = cr.fetchone()[0]
4077 cr.execute('select max(parent_right) from '+self._table)
4078 pleft = cr.fetchone()[0] or 0
4079 cr.execute('update '+self._table+' set parent_left=parent_left+2 where parent_left>%s', (pleft,))
4080 cr.execute('update '+self._table+' set parent_right=parent_right+2 where parent_right>%s', (pleft,))
4081 cr.execute('update '+self._table+' set parent_left=%s,parent_right=%s where id=%s', (pleft+1, pleft+2, id_new))
4082 recs.invalidate_cache(['parent_left', 'parent_right'])
4084 # default element in context must be remove when call a one2many or many2many
4085 rel_context = context.copy()
4086 for c in context.items():
4087 if c[0].startswith('default_'):
4088 del rel_context[c[0]]
4091 for field in upd_todo:
4092 result += self._columns[field].set(cr, self, id_new, field, vals[field], user, rel_context) or []
4094 # check Python constraints
4095 recs._validate_fields(vals)
4097 if not context.get('no_store_function', False):
4098 result += self._store_get_values(cr, user, [id_new],
4099 list(set(vals.keys() + self._inherits.values())),
4103 for order, model_name, ids, fields2 in result:
4104 if not (model_name, ids, fields2) in done:
4105 self.pool[model_name]._store_set_values(cr, user, ids, fields2, context)
4106 done.append((model_name, ids, fields2))
4108 # recompute new-style fields
4109 modified_fields = list(vals)
4110 if self._log_access:
4111 modified_fields += ['create_uid', 'create_date', 'write_uid', 'write_date']
4112 recs.modified(modified_fields)
4115 if self._log_create and not (context and context.get('no_store_function', False)):
4116 message = self._description + \
4118 self.name_get(cr, user, [id_new], context=context)[0][1] + \
4119 "' " + _("created.")
4120 self.log(cr, user, id_new, message, True, context=context)
4122 self.check_access_rule(cr, user, [id_new], 'create', context=context)
4123 self.create_workflow(cr, user, [id_new], context=context)
4126 def _store_get_values(self, cr, uid, ids, fields, context):
4127 """Returns an ordered list of fields.function to call due to
4128 an update operation on ``fields`` of records with ``ids``,
4129 obtained by calling the 'store' triggers of these fields,
4130 as setup by their 'store' attribute.
4132 :return: [(priority, model_name, [record_ids,], [function_fields,])]
4134 if fields is None: fields = []
4135 stored_functions = self.pool._store_function.get(self._name, [])
4137 # use indexed names for the details of the stored_functions:
4138 model_name_, func_field_to_compute_, target_ids_func_, trigger_fields_, priority_ = range(5)
4140 # only keep store triggers that should be triggered for the ``fields``
4142 triggers_to_compute = (
4143 f for f in stored_functions
4144 if not f[trigger_fields_] or set(fields).intersection(f[trigger_fields_])
4148 target_id_results = {}
4149 for store_trigger in triggers_to_compute:
4150 target_func_id_ = id(store_trigger[target_ids_func_])
4151 if target_func_id_ not in target_id_results:
4152 # use admin user for accessing objects having rules defined on store fields
4153 target_id_results[target_func_id_] = [i for i in store_trigger[target_ids_func_](self, cr, SUPERUSER_ID, ids, context) if i]
4154 target_ids = target_id_results[target_func_id_]
4156 # the compound key must consider the priority and model name
4157 key = (store_trigger[priority_], store_trigger[model_name_])
4158 for target_id in target_ids:
4159 to_compute_map.setdefault(key, {}).setdefault(target_id,set()).add(tuple(store_trigger))
4161 # Here to_compute_map looks like:
4162 # { (10, 'model_a') : { target_id1: [ (trigger_1_tuple, trigger_2_tuple) ], ... }
4163 # (20, 'model_a') : { target_id2: [ (trigger_3_tuple, trigger_4_tuple) ], ... }
4164 # (99, 'model_a') : { target_id1: [ (trigger_5_tuple, trigger_6_tuple) ], ... }
4167 # Now we need to generate the batch function calls list
4169 # { (10, 'model_a') : [(10, 'model_a', [record_ids,], [function_fields,])] }
4171 for ((priority,model), id_map) in to_compute_map.iteritems():
4172 trigger_ids_maps = {}
4173 # function_ids_maps =
4174 # { (function_1_tuple, function_2_tuple) : [target_id1, target_id2, ..] }
4175 for target_id, triggers in id_map.iteritems():
4176 trigger_ids_maps.setdefault(tuple(triggers), []).append(target_id)
4177 for triggers, target_ids in trigger_ids_maps.iteritems():
4178 call_map.setdefault((priority,model),[]).append((priority, model, target_ids,
4179 [t[func_field_to_compute_] for t in triggers]))
4182 result = reduce(operator.add, (call_map[k] for k in sorted(call_map)))
4185 def _store_set_values(self, cr, uid, ids, fields, context):
4186 """Calls the fields.function's "implementation function" for all ``fields``, on records with ``ids`` (taking care of
4187 respecting ``multi`` attributes), and stores the resulting values in the database directly."""
4192 if self._log_access:
4193 cr.execute('select id,write_date from '+self._table+' where id IN %s', (tuple(ids),))
4197 field_dict.setdefault(r[0], [])
4198 res_date = time.strptime((r[1])[:19], '%Y-%m-%d %H:%M:%S')
4199 write_date = datetime.datetime.fromtimestamp(time.mktime(res_date))
4200 for i in self.pool._store_function.get(self._name, []):
4202 up_write_date = write_date + datetime.timedelta(hours=i[5])
4203 if datetime.datetime.now() < up_write_date:
4205 field_dict[r[0]].append(i[1])
4211 if self._columns[f]._multi not in keys:
4212 keys.append(self._columns[f]._multi)
4213 todo.setdefault(self._columns[f]._multi, [])
4214 todo[self._columns[f]._multi].append(f)
4218 # use admin user for accessing objects having rules defined on store fields
4219 result = self._columns[val[0]].get(cr, self, ids, val, SUPERUSER_ID, context=context)
4220 for id, value in result.items():
4222 for f in value.keys():
4223 if f in field_dict[id]:
4230 if self._columns[v]._type == 'many2one':
4232 value[v] = value[v][0]
4235 upd0.append('"'+v+'"='+self._columns[v]._symbol_set[0])
4236 upd1.append(self._columns[v]._symbol_set[1](value[v]))
4239 cr.execute('update "' + self._table + '" set ' + \
4240 ','.join(upd0) + ' where id = %s', upd1)
4244 # use admin user for accessing objects having rules defined on store fields
4245 result = self._columns[f].get(cr, self, ids, f, SUPERUSER_ID, context=context)
4246 for r in result.keys():
4248 if r in field_dict.keys():
4249 if f in field_dict[r]:
4251 for id, value in result.items():
4252 if self._columns[f]._type == 'many2one':
4257 cr.execute('update "' + self._table + '" set ' + \
4258 '"'+f+'"='+self._columns[f]._symbol_set[0] + ' where id = %s', (self._columns[f]._symbol_set[1](value), id))
4260 # invalidate the cache for the modified fields
4261 self.browse(cr, uid, ids, context).modified(fields)
4265 # TODO: ameliorer avec NULL
4266 def _where_calc(self, cr, user, domain, active_test=True, context=None):
4267 """Computes the WHERE clause needed to implement an OpenERP domain.
4268 :param domain: the domain to compute
4270 :param active_test: whether the default filtering of records with ``active``
4271 field set to ``False`` should be applied.
4272 :return: the query expressing the given domain as provided in domain
4273 :rtype: osv.query.Query
4278 # if the object has a field named 'active', filter out all inactive
4279 # records unless they were explicitely asked for
4280 if 'active' in self._all_columns and (active_test and context.get('active_test', True)):
4282 # the item[0] trick below works for domain items and '&'/'|'/'!'
4284 if not any(item[0] == 'active' for item in domain):
4285 domain.insert(0, ('active', '=', 1))
4287 domain = [('active', '=', 1)]
4290 e = expression.expression(cr, user, domain, self, context)
4291 tables = e.get_tables()
4292 where_clause, where_params = e.to_sql()
4293 where_clause = where_clause and [where_clause] or []
4295 where_clause, where_params, tables = [], [], ['"%s"' % self._table]
4297 return Query(tables, where_clause, where_params)
4299 def _check_qorder(self, word):
4300 if not regex_order.match(word):
4301 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)'))
4304 def _apply_ir_rules(self, cr, uid, query, mode='read', context=None):
4305 """Add what's missing in ``query`` to implement all appropriate ir.rules
4306 (using the ``model_name``'s rules or the current model's rules if ``model_name`` is None)
4308 :param query: the current query object
4310 if uid == SUPERUSER_ID:
4313 def apply_rule(added_clause, added_params, added_tables, parent_model=None):
4314 """ :param parent_model: name of the parent model, if the added
4315 clause comes from a parent model
4319 # as inherited rules are being applied, we need to add the missing JOIN
4320 # to reach the parent table (if it was not JOINed yet in the query)
4321 parent_alias = self._inherits_join_add(self, parent_model, query)
4322 # inherited rules are applied on the external table -> need to get the alias and replace
4323 parent_table = self.pool[parent_model]._table
4324 added_clause = [clause.replace('"%s"' % parent_table, '"%s"' % parent_alias) for clause in added_clause]
4325 # change references to parent_table to parent_alias, because we now use the alias to refer to the table
4327 for table in added_tables:
4328 # table is just a table name -> switch to the full alias
4329 if table == '"%s"' % parent_table:
4330 new_tables.append('"%s" as "%s"' % (parent_table, parent_alias))
4331 # table is already a full statement -> replace reference to the table to its alias, is correct with the way aliases are generated
4333 new_tables.append(table.replace('"%s"' % parent_table, '"%s"' % parent_alias))
4334 added_tables = new_tables
4335 query.where_clause += added_clause
4336 query.where_clause_params += added_params
4337 for table in added_tables:
4338 if table not in query.tables:
4339 query.tables.append(table)
4343 # apply main rules on the object
4344 rule_obj = self.pool.get('ir.rule')
4345 rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, self._name, mode, context=context)
4346 apply_rule(rule_where_clause, rule_where_clause_params, rule_tables)
4348 # apply ir.rules from the parents (through _inherits)
4349 for inherited_model in self._inherits:
4350 rule_where_clause, rule_where_clause_params, rule_tables = rule_obj.domain_get(cr, uid, inherited_model, mode, context=context)
4351 apply_rule(rule_where_clause, rule_where_clause_params, rule_tables,
4352 parent_model=inherited_model)
4354 def _generate_m2o_order_by(self, order_field, query):
4356 Add possibly missing JOIN to ``query`` and generate the ORDER BY clause for m2o fields,
4357 either native m2o fields or function/related fields that are stored, including
4358 intermediate JOINs for inheritance if required.
4360 :return: the qualified field name to use in an ORDER BY clause to sort by ``order_field``
4362 if order_field not in self._columns and order_field in self._inherit_fields:
4363 # also add missing joins for reaching the table containing the m2o field
4364 qualified_field = self._inherits_join_calc(order_field, query)
4365 order_field_column = self._inherit_fields[order_field][2]
4367 qualified_field = '"%s"."%s"' % (self._table, order_field)
4368 order_field_column = self._columns[order_field]
4370 assert order_field_column._type == 'many2one', 'Invalid field passed to _generate_m2o_order_by()'
4371 if not order_field_column._classic_write and not getattr(order_field_column, 'store', False):
4372 _logger.debug("Many2one function/related fields must be stored " \
4373 "to be used as ordering fields! Ignoring sorting for %s.%s",
4374 self._name, order_field)
4377 # figure out the applicable order_by for the m2o
4378 dest_model = self.pool[order_field_column._obj]
4379 m2o_order = dest_model._order
4380 if not regex_order.match(m2o_order):
4381 # _order is complex, can't use it here, so we default to _rec_name
4382 m2o_order = dest_model._rec_name
4384 # extract the field names, to be able to qualify them and add desc/asc
4386 for order_part in m2o_order.split(","):
4387 m2o_order_list.append(order_part.strip().split(" ", 1)[0].strip())
4388 m2o_order = m2o_order_list
4390 # Join the dest m2o table if it's not joined yet. We use [LEFT] OUTER join here
4391 # as we don't want to exclude results that have NULL values for the m2o
4392 src_table, src_field = qualified_field.replace('"', '').split('.', 1)
4393 dst_alias, dst_alias_statement = query.add_join((src_table, dest_model._table, src_field, 'id', src_field), implicit=False, outer=True)
4394 qualify = lambda field: '"%s"."%s"' % (dst_alias, field)
4395 return map(qualify, m2o_order) if isinstance(m2o_order, list) else qualify(m2o_order)
4397 def _generate_order_by(self, order_spec, query):
4399 Attempt to consruct an appropriate ORDER BY clause based on order_spec, which must be
4400 a comma-separated list of valid field names, optionally followed by an ASC or DESC direction.
4402 :raise" except_orm in case order_spec is malformed
4404 order_by_clause = ''
4405 order_spec = order_spec or self._order
4407 order_by_elements = []
4408 self._check_qorder(order_spec)
4409 for order_part in order_spec.split(','):
4410 order_split = order_part.strip().split(' ')
4411 order_field = order_split[0].strip()
4412 order_direction = order_split[1].strip() if len(order_split) == 2 else ''
4414 if order_field == 'id':
4415 order_by_elements.append('"%s"."%s" %s' % (self._table, order_field, order_direction))
4416 elif order_field in self._columns:
4417 order_column = self._columns[order_field]
4418 if order_column._classic_read:
4419 inner_clause = '"%s"."%s"' % (self._table, order_field)
4420 elif order_column._type == 'many2one':
4421 inner_clause = self._generate_m2o_order_by(order_field, query)
4423 continue # ignore non-readable or "non-joinable" fields
4424 elif order_field in self._inherit_fields:
4425 parent_obj = self.pool[self._inherit_fields[order_field][3]]
4426 order_column = parent_obj._columns[order_field]
4427 if order_column._classic_read:
4428 inner_clause = self._inherits_join_calc(order_field, query)
4429 elif order_column._type == 'many2one':
4430 inner_clause = self._generate_m2o_order_by(order_field, query)
4432 continue # ignore non-readable or "non-joinable" fields
4434 raise ValueError( _("Sorting field %s not found on model %s") %( order_field, self._name))
4436 if isinstance(inner_clause, list):
4437 for clause in inner_clause:
4438 order_by_elements.append("%s %s" % (clause, order_direction))
4440 order_by_elements.append("%s %s" % (inner_clause, order_direction))
4441 if order_by_elements:
4442 order_by_clause = ",".join(order_by_elements)
4444 return order_by_clause and (' ORDER BY %s ' % order_by_clause) or ''
4446 def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
4448 Private implementation of search() method, allowing specifying the uid to use for the access right check.
4449 This is useful for example when filling in the selection list for a drop-down and avoiding access rights errors,
4450 by specifying ``access_rights_uid=1`` to bypass access rights check, but not ir.rules!
4451 This is ok at the security level because this method is private and not callable through XML-RPC.
4453 :param access_rights_uid: optional user ID to use when checking access rights
4454 (not for ir.rules, this is only for ir.model.access)
4458 self.check_access_rights(cr, access_rights_uid or user, 'read')
4460 # For transient models, restrict acces to the current user, except for the super-user
4461 if self.is_transient() and self._log_access and user != SUPERUSER_ID:
4462 args = expression.AND(([('create_uid', '=', user)], args or []))
4464 query = self._where_calc(cr, user, args, context=context)
4465 self._apply_ir_rules(cr, user, query, 'read', context=context)
4466 order_by = self._generate_order_by(order, query)
4467 from_clause, where_clause, where_clause_params = query.get_sql()
4469 where_str = where_clause and (" WHERE %s" % where_clause) or ''
4472 # Ignore order, limit and offset when just counting, they don't make sense and could
4474 query_str = 'SELECT count(1) FROM ' + from_clause + where_str
4475 cr.execute(query_str, where_clause_params)
4479 limit_str = limit and ' limit %d' % limit or ''
4480 offset_str = offset and ' offset %d' % offset or ''
4481 query_str = 'SELECT "%s".id FROM ' % self._table + from_clause + where_str + order_by + limit_str + offset_str
4482 cr.execute(query_str, where_clause_params)
4485 # TDE note: with auto_join, we could have several lines about the same result
4486 # i.e. a lead with several unread messages; we uniquify the result using
4487 # a fast way to do it while preserving order (http://www.peterbe.com/plog/uniqifiers-benchmark)
4488 def _uniquify_list(seq):
4490 return [x for x in seq if x not in seen and not seen.add(x)]
4492 return _uniquify_list([x[0] for x in res])
4494 # returns the different values ever entered for one field
4495 # this is used, for example, in the client when the user hits enter on
4497 def distinct_field_get(self, cr, uid, field, value, args=None, offset=0, limit=None):
4500 if field in self._inherit_fields:
4501 return self.pool[self._inherit_fields[field][0]].distinct_field_get(cr, uid, field, value, args, offset, limit)
4503 return self._columns[field].search(cr, self, args, field, value, offset, limit, uid)
4505 def copy_data(self, cr, uid, id, default=None, context=None):
4507 Copy given record's data with all its fields values
4509 :param cr: database cursor
4510 :param uid: current user id
4511 :param id: id of the record to copy
4512 :param default: field values to override in the original values of the copied record
4513 :type default: dictionary
4514 :param context: context arguments, like lang, time zone
4515 :type context: dictionary
4516 :return: dictionary containing all the field values
4522 # avoid recursion through already copied records in case of circular relationship
4523 seen_map = context.setdefault('__copy_data_seen', {})
4524 if id in seen_map.setdefault(self._name, []):
4526 seen_map[self._name].append(id)
4530 if 'state' not in default:
4531 if 'state' in self._defaults:
4532 if callable(self._defaults['state']):
4533 default['state'] = self._defaults['state'](self, cr, uid, context)
4535 default['state'] = self._defaults['state']
4537 # build a black list of fields that should not be copied
4538 blacklist = set(MAGIC_COLUMNS + ['parent_left', 'parent_right'])
4539 def blacklist_given_fields(obj):
4540 # blacklist the fields that are given by inheritance
4541 for other, field_to_other in obj._inherits.items():
4542 blacklist.add(field_to_other)
4543 if field_to_other in default:
4544 # all the fields of 'other' are given by the record: default[field_to_other],
4545 # except the ones redefined in self
4546 blacklist.update(set(self.pool[other]._all_columns) - set(self._columns))
4548 blacklist_given_fields(self.pool[other])
4549 # blacklist deprecated fields
4550 for name, field in obj._columns.items():
4551 if field.deprecated:
4554 blacklist_given_fields(self)
4557 fields_to_copy = dict((f,fi) for f, fi in self._all_columns.iteritems()
4560 if f not in blacklist)
4562 data = self.read(cr, uid, [id], fields_to_copy.keys(), context=context)
4566 raise IndexError( _("Record #%d of %s not found, cannot copy!") %( id, self._name))
4569 for f, colinfo in fields_to_copy.iteritems():
4570 field = colinfo.column
4571 if field._type == 'many2one':
4572 res[f] = data[f] and data[f][0]
4573 elif field._type == 'one2many':
4574 other = self.pool[field._obj]
4575 # duplicate following the order of the ids because we'll rely on
4576 # it later for copying translations in copy_translation()!
4577 lines = [other.copy_data(cr, uid, line_id, context=context) for line_id in sorted(data[f])]
4578 # the lines are duplicated using the wrong (old) parent, but then
4579 # are reassigned to the correct one thanks to the (0, 0, ...)
4580 res[f] = [(0, 0, line) for line in lines if line]
4581 elif field._type == 'many2many':
4582 res[f] = [(6, 0, data[f])]
4588 def copy_translations(self, cr, uid, old_id, new_id, context=None):
4592 # avoid recursion through already copied records in case of circular relationship
4593 seen_map = context.setdefault('__copy_translations_seen',{})
4594 if old_id in seen_map.setdefault(self._name,[]):
4596 seen_map[self._name].append(old_id)
4598 trans_obj = self.pool.get('ir.translation')
4599 # TODO it seems fields_get can be replaced by _all_columns (no need for translation)
4600 fields = self.fields_get(cr, uid, context=context)
4602 for field_name, field_def in fields.items():
4603 # removing the lang to compare untranslated values
4604 context_wo_lang = dict(context, lang=None)
4605 old_record, new_record = self.browse(cr, uid, [old_id, new_id], context=context_wo_lang)
4606 # we must recursively copy the translations for o2o and o2m
4607 if field_def['type'] == 'one2many':
4608 target_obj = self.pool[field_def['relation']]
4609 # here we rely on the order of the ids to match the translations
4610 # as foreseen in copy_data()
4611 old_children = sorted(r.id for r in old_record[field_name])
4612 new_children = sorted(r.id for r in new_record[field_name])
4613 for (old_child, new_child) in zip(old_children, new_children):
4614 target_obj.copy_translations(cr, uid, old_child, new_child, context=context)
4615 # and for translatable fields we keep them for copy
4616 elif field_def.get('translate'):
4617 if field_name in self._columns:
4618 trans_name = self._name + "," + field_name
4621 elif field_name in self._inherit_fields:
4622 trans_name = self._inherit_fields[field_name][0] + "," + field_name
4623 # get the id of the parent record to set the translation
4624 inherit_field_name = self._inherit_fields[field_name][1]
4625 target_id = new_record[inherit_field_name].id
4626 source_id = old_record[inherit_field_name].id
4630 trans_ids = trans_obj.search(cr, uid, [
4631 ('name', '=', trans_name),
4632 ('res_id', '=', source_id)
4634 user_lang = context.get('lang')
4635 for record in trans_obj.read(cr, uid, trans_ids, context=context):
4637 # remove source to avoid triggering _set_src
4638 del record['source']
4639 record.update({'res_id': target_id})
4640 if user_lang and user_lang == record['lang']:
4641 # 'source' to force the call to _set_src
4642 # 'value' needed if value is changed in copy(), want to see the new_value
4643 record['source'] = old_record[field_name]
4644 record['value'] = new_record[field_name]
4645 trans_obj.create(cr, uid, record, context=context)
4647 @api.returns('self', lambda value: value.id)
4648 def copy(self, cr, uid, id, default=None, context=None):
4650 Duplicate record with given id updating it with default values
4652 :param cr: database cursor
4653 :param uid: current user id
4654 :param id: id of the record to copy
4655 :param default: dictionary of field values to override in the original values of the copied record, e.g: ``{'field_name': overriden_value, ...}``
4656 :type default: dictionary
4657 :param context: context arguments, like lang, time zone
4658 :type context: dictionary
4659 :return: id of the newly created record
4664 context = context.copy()
4665 data = self.copy_data(cr, uid, id, default, context)
4666 new_id = self.create(cr, uid, data, context)
4667 self.copy_translations(cr, uid, id, new_id, context)
4671 @api.returns('self')
4673 """ Return the subset of records in `self` that exist, and mark deleted
4674 records as such in cache. It can be used as a test on records::
4679 By convention, new records are returned as existing.
4681 ids = filter(None, self._ids) # ids to check in database
4684 query = """SELECT id FROM "%s" WHERE id IN %%s""" % self._table
4685 self._cr.execute(query, (ids,))
4686 ids = ([r[0] for r in self._cr.fetchall()] + # ids in database
4687 [id for id in self._ids if not id]) # new ids
4688 existing = self.browse(ids)
4689 if len(existing) < len(self):
4690 # mark missing records in cache with a failed value
4691 exc = MissingError(_("Record does not exist or has been deleted."))
4692 (self - existing)._cache.update(FailedValue(exc))
4695 def check_recursion(self, cr, uid, ids, context=None, parent=None):
4696 _logger.warning("You are using deprecated %s.check_recursion(). Please use the '_check_recursion()' instead!" % \
4698 assert parent is None or parent in self._columns or parent in self._inherit_fields,\
4699 "The 'parent' parameter passed to check_recursion() must be None or a valid field name"
4700 return self._check_recursion(cr, uid, ids, context, parent)
4702 def _check_recursion(self, cr, uid, ids, context=None, parent=None):
4704 Verifies that there is no loop in a hierarchical structure of records,
4705 by following the parent relationship using the **parent** field until a loop
4706 is detected or until a top-level record is found.
4708 :param cr: database cursor
4709 :param uid: current user id
4710 :param ids: list of ids of records to check
4711 :param parent: optional parent field name (default: ``self._parent_name = parent_id``)
4712 :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4715 parent = self._parent_name
4717 # must ignore 'active' flag, ir.rules, etc. => direct SQL query
4718 query = 'SELECT "%s" FROM "%s" WHERE id = %%s' % (parent, self._table)
4721 while current_id is not None:
4722 cr.execute(query, (current_id,))
4723 result = cr.fetchone()
4724 current_id = result[0] if result else None
4725 if current_id == id:
4729 def _check_m2m_recursion(self, cr, uid, ids, field_name):
4731 Verifies that there is no loop in a hierarchical structure of records,
4732 by following the parent relationship using the **parent** field until a loop
4733 is detected or until a top-level record is found.
4735 :param cr: database cursor
4736 :param uid: current user id
4737 :param ids: list of ids of records to check
4738 :param field_name: field to check
4739 :return: **True** if the operation can proceed safely, or **False** if an infinite loop is detected.
4742 field = self._all_columns.get(field_name)
4743 field = field.column if field else None
4744 if not field or field._type != 'many2many' or field._obj != self._name:
4745 # field must be a many2many on itself
4746 raise ValueError('invalid field_name: %r' % (field_name,))
4748 query = 'SELECT distinct "%s" FROM "%s" WHERE "%s" IN %%s' % (field._id2, field._rel, field._id1)
4752 for i in range(0, len(ids_parent), cr.IN_MAX):
4754 sub_ids_parent = ids_parent[i:j]
4755 cr.execute(query, (tuple(sub_ids_parent),))
4756 ids_parent2.extend(filter(None, map(lambda x: x[0], cr.fetchall())))
4757 ids_parent = ids_parent2
4758 for i in ids_parent:
4763 def _get_external_ids(self, cr, uid, ids, *args, **kwargs):
4764 """Retrieve the External ID(s) of any database record.
4766 **Synopsis**: ``_get_xml_ids(cr, uid, ids) -> { 'id': ['module.xml_id'] }``
4768 :return: map of ids to the list of their fully qualified External IDs
4769 in the form ``module.key``, or an empty list when there's no External
4770 ID for a record, e.g.::
4772 { 'id': ['module.ext_id', 'module.ext_id_bis'],
4775 ir_model_data = self.pool.get('ir.model.data')
4776 data_ids = ir_model_data.search(cr, uid, [('model', '=', self._name), ('res_id', 'in', ids)])
4777 data_results = ir_model_data.read(cr, uid, data_ids, ['module', 'name', 'res_id'])
4780 # can't use dict.fromkeys() as the list would be shared!
4782 for record in data_results:
4783 result[record['res_id']].append('%(module)s.%(name)s' % record)
4786 def get_external_id(self, cr, uid, ids, *args, **kwargs):
4787 """Retrieve the External ID of any database record, if there
4788 is one. This method works as a possible implementation
4789 for a function field, to be able to add it to any
4790 model object easily, referencing it as ``Model.get_external_id``.
4792 When multiple External IDs exist for a record, only one
4793 of them is returned (randomly).
4795 :return: map of ids to their fully qualified XML ID,
4796 defaulting to an empty string when there's none
4797 (to be usable as a function field),
4800 { 'id': 'module.ext_id',
4803 results = self._get_xml_ids(cr, uid, ids)
4804 for k, v in results.iteritems():
4811 # backwards compatibility
4812 get_xml_id = get_external_id
4813 _get_xml_ids = _get_external_ids
4815 def print_report(self, cr, uid, ids, name, data, context=None):
4817 Render the report `name` for the given IDs. The report must be defined
4818 for this model, not another.
4820 report = self.pool['ir.actions.report.xml']._lookup_report(cr, name)
4821 assert self._name == report.table
4822 return report.create(cr, uid, ids, data, context)
4826 def is_transient(cls):
4827 """ Return whether the model is transient.
4829 See :class:`TransientModel`.
4832 return cls._transient
4834 def _transient_clean_rows_older_than(self, cr, seconds):
4835 assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4836 # Never delete rows used in last 5 minutes
4837 seconds = max(seconds, 300)
4838 query = ("SELECT id FROM " + self._table + " WHERE"
4839 " COALESCE(write_date, create_date, (now() at time zone 'UTC'))::timestamp"
4840 " < ((now() at time zone 'UTC') - interval %s)")
4841 cr.execute(query, ("%s seconds" % seconds,))
4842 ids = [x[0] for x in cr.fetchall()]
4843 self.unlink(cr, SUPERUSER_ID, ids)
4845 def _transient_clean_old_rows(self, cr, max_count):
4846 # Check how many rows we have in the table
4847 cr.execute("SELECT count(*) AS row_count FROM " + self._table)
4849 if res[0][0] <= max_count:
4850 return # max not reached, nothing to do
4851 self._transient_clean_rows_older_than(cr, 300)
4853 def _transient_vacuum(self, cr, uid, force=False):
4854 """Clean the transient records.
4856 This unlinks old records from the transient model tables whenever the
4857 "_transient_max_count" or "_max_age" conditions (if any) are reached.
4858 Actual cleaning will happen only once every "_transient_check_time" calls.
4859 This means this method can be called frequently called (e.g. whenever
4860 a new record is created).
4861 Example with both max_hours and max_count active:
4862 Suppose max_hours = 0.2 (e.g. 12 minutes), max_count = 20, there are 55 rows in the
4863 table, 10 created/changed in the last 5 minutes, an additional 12 created/changed between
4864 5 and 10 minutes ago, the rest created/changed more then 12 minutes ago.
4865 - age based vacuum will leave the 22 rows created/changed in the last 12 minutes
4866 - count based vacuum will wipe out another 12 rows. Not just 2, otherwise each addition
4867 would immediately cause the maximum to be reached again.
4868 - the 10 rows that have been created/changed the last 5 minutes will NOT be deleted
4870 assert self._transient, "Model %s is not transient, it cannot be vacuumed!" % self._name
4871 _transient_check_time = 20 # arbitrary limit on vacuum executions
4872 self._transient_check_count += 1
4873 if not force and (self._transient_check_count < _transient_check_time):
4874 return True # no vacuum cleaning this time
4875 self._transient_check_count = 0
4877 # Age-based expiration
4878 if self._transient_max_hours:
4879 self._transient_clean_rows_older_than(cr, self._transient_max_hours * 60 * 60)
4881 # Count-based expiration
4882 if self._transient_max_count:
4883 self._transient_clean_old_rows(cr, self._transient_max_count)
4887 def resolve_2many_commands(self, cr, uid, field_name, commands, fields=None, context=None):
4888 """ Serializes one2many and many2many commands into record dictionaries
4889 (as if all the records came from the database via a read()). This
4890 method is aimed at onchange methods on one2many and many2many fields.
4892 Because commands might be creation commands, not all record dicts
4893 will contain an ``id`` field. Commands matching an existing record
4894 will have an ``id``.
4896 :param field_name: name of the one2many or many2many field matching the commands
4897 :type field_name: str
4898 :param commands: one2many or many2many commands to execute on ``field_name``
4899 :type commands: list((int|False, int|False, dict|False))
4900 :param fields: list of fields to read from the database, when applicable
4901 :type fields: list(str)
4902 :returns: records in a shape similar to that returned by ``read()``
4903 (except records may be missing the ``id`` field if they don't exist in db)
4906 result = [] # result (list of dict)
4907 record_ids = [] # ids of records to read
4908 updates = {} # {id: dict} of updates on particular records
4910 for command in commands or []:
4911 if not isinstance(command, (list, tuple)):
4912 record_ids.append(command)
4913 elif command[0] == 0:
4914 result.append(command[2])
4915 elif command[0] == 1:
4916 record_ids.append(command[1])
4917 updates.setdefault(command[1], {}).update(command[2])
4918 elif command[0] in (2, 3):
4919 record_ids = [id for id in record_ids if id != command[1]]
4920 elif command[0] == 4:
4921 record_ids.append(command[1])
4922 elif command[0] == 5:
4923 result, record_ids = [], []
4924 elif command[0] == 6:
4925 result, record_ids = [], list(command[2])
4927 # read the records and apply the updates
4928 other_model = self.pool[self._all_columns[field_name].column._obj]
4929 for record in other_model.read(cr, uid, record_ids, fields=fields, context=context):
4930 record.update(updates.get(record['id'], {}))
4931 result.append(record)
4935 # for backward compatibility
4936 resolve_o2m_commands_to_record_dicts = resolve_2many_commands
4938 def search_read(self, cr, uid, domain=None, fields=None, offset=0, limit=None, order=None, context=None):
4940 Performs a ``search()`` followed by a ``read()``.
4942 :param cr: database cursor
4943 :param user: current user id
4944 :param domain: Search domain, see ``args`` parameter in ``search()``. Defaults to an empty domain that will match all records.
4945 :param fields: List of fields to read, see ``fields`` parameter in ``read()``. Defaults to all fields.
4946 :param offset: Number of records to skip, see ``offset`` parameter in ``search()``. Defaults to 0.
4947 :param limit: Maximum number of records to return, see ``limit`` parameter in ``search()``. Defaults to no limit.
4948 :param order: Columns to sort result, see ``order`` parameter in ``search()``. Defaults to no sort.
4949 :param context: context arguments.
4950 :return: List of dictionaries containing the asked fields.
4951 :rtype: List of dictionaries.
4954 record_ids = self.search(cr, uid, domain or [], offset=offset, limit=limit, order=order, context=context)
4958 if fields and fields == ['id']:
4959 # shortcut read if we only want the ids
4960 return [{'id': id} for id in record_ids]
4962 # read() ignores active_test, but it would forward it to any downstream search call
4963 # (e.g. for x2m or function fields), and this is not the desired behavior, the flag
4964 # was presumably only meant for the main search().
4965 # TODO: Move this to read() directly?
4966 read_ctx = dict(context or {})
4967 read_ctx.pop('active_test', None)
4969 result = self.read(cr, uid, record_ids, fields, context=read_ctx)
4970 if len(result) <= 1:
4974 index = dict((r['id'], r) for r in result)
4975 return [index[x] for x in record_ids if x in index]
4977 def _register_hook(self, cr):
4978 """ stuff to do right after the registry is built """
4982 def _patch_method(cls, name, method):
4983 """ Monkey-patch a method for all instances of this model. This replaces
4984 the method called `name` by `method` in the given class.
4985 The original method is then accessible via ``method.origin``, and it
4986 can be restored with :meth:`~._revert_method`.
4991 def do_write(self, values):
4992 # do stuff, and call the original method
4993 return do_write.origin(self, values)
4995 # patch method write of model
4996 model._patch_method('write', do_write)
4998 # this will call do_write
4999 records = model.search([...])
5002 # restore the original method
5003 model._revert_method('write')
5005 origin = getattr(cls, name)
5006 method.origin = origin
5007 # propagate decorators from origin to method, and apply api decorator
5008 wrapped = api.guess(api.propagate(origin, method))
5009 wrapped.origin = origin
5010 setattr(cls, name, wrapped)
5013 def _revert_method(cls, name):
5014 """ Revert the original method called `name` in the given class.
5015 See :meth:`~._patch_method`.
5017 method = getattr(cls, name)
5018 setattr(cls, name, method.origin)
5023 # An instance represents an ordered collection of records in a given
5024 # execution environment. The instance object refers to the environment, and
5025 # the records themselves are represented by their cache dictionary. The 'id'
5026 # of each record is found in its corresponding cache dictionary.
5028 # This design has the following advantages:
5029 # - cache access is direct and thus fast;
5030 # - one can consider records without an 'id' (see new records);
5031 # - the global cache is only an index to "resolve" a record 'id'.
5035 def _browse(cls, env, ids):
5036 """ Create an instance attached to `env`; `ids` is a tuple of record
5039 records = object.__new__(cls)
5042 env.prefetch[cls._name].update(ids)
5046 def browse(self, arg=None):
5047 """ Return an instance corresponding to `arg` and attached to
5048 `self.env`; `arg` is either a record id, or a collection of record ids.
5050 ids = _normalize_ids(arg)
5051 #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5052 return self._browse(self.env, ids)
5055 def browse(self, cr, uid, arg=None, context=None):
5056 ids = _normalize_ids(arg)
5057 #assert all(isinstance(id, IdType) for id in ids), "Browsing invalid ids: %s" % ids
5058 return self._browse(Environment(cr, uid, context or {}), ids)
5061 # Internal properties, for manipulating the instance's implementation
5066 """ Return the list of non-false record ids of this instance. """
5067 return filter(None, list(self._ids))
5069 # backward-compatibility with former browse records
5070 _cr = property(lambda self: self.env.cr)
5071 _uid = property(lambda self: self.env.uid)
5072 _context = property(lambda self: self.env.context)
5075 # Conversion methods
5078 def ensure_one(self):
5079 """ Return `self` if it is a singleton instance, otherwise raise an
5084 raise except_orm("ValueError", "Expected singleton: %s" % self)
5086 def with_env(self, env):
5087 """ Return an instance equivalent to `self` attached to `env`.
5089 return self._browse(env, self._ids)
5091 def sudo(self, user=SUPERUSER_ID):
5092 """ Return an instance equivalent to `self` attached to an environment
5093 based on `self.env` with the given `user`.
5095 return self.with_env(self.env(user=user))
5097 def with_context(self, *args, **kwargs):
5098 """ Return an instance equivalent to `self` attached to an environment
5099 based on `self.env` with another context. The context is given by
5100 `self._context` or the positional argument if given, and modified by
5103 context = dict(args[0] if args else self._context, **kwargs)
5104 return self.with_env(self.env(context=context))
5106 def _convert_to_cache(self, values, update=False, validate=True):
5107 """ Convert the `values` dictionary into cached values.
5109 :param update: whether the conversion is made for updating `self`;
5110 this is necessary for interpreting the commands of *2many fields
5111 :param validate: whether values must be checked
5113 fields = self._fields
5114 target = self if update else self.browse()
5116 name: fields[name].convert_to_cache(value, target, validate=validate)
5117 for name, value in values.iteritems()
5121 def _convert_to_write(self, values):
5122 """ Convert the `values` dictionary into the format of :meth:`write`. """
5123 fields = self._fields
5125 (name, fields[name].convert_to_write(value))
5126 for name, value in values.iteritems()
5127 if name in self._fields
5131 # Record traversal and update
5134 def _mapped_func(self, func):
5135 """ Apply function `func` on all records in `self`, and return the
5136 result as a list or a recordset (if `func` return recordsets).
5138 vals = [func(rec) for rec in self]
5139 val0 = vals[0] if vals else func(self)
5140 if isinstance(val0, BaseModel):
5141 return reduce(operator.or_, vals, val0)
5144 def mapped(self, func):
5145 """ Apply `func` on all records in `self`, and return the result as a
5146 list or a recordset (if `func` return recordsets). In the latter
5147 case, the order of the returned recordset is arbritrary.
5149 :param func: a function or a dot-separated sequence of field names
5151 if isinstance(func, basestring):
5153 for name in func.split('.'):
5154 recs = recs._mapped_func(operator.itemgetter(name))
5157 return self._mapped_func(func)
5159 def _mapped_cache(self, name_seq):
5160 """ Same as `~.mapped`, but `name_seq` is a dot-separated sequence of
5161 field names, and only cached values are used.
5164 for name in name_seq.split('.'):
5165 field = recs._fields[name]
5166 null = field.null(self.env)
5167 recs = recs.mapped(lambda rec: rec._cache.get(field, null))
5170 def filtered(self, func):
5171 """ Select the records in `self` such that `func(rec)` is true, and
5172 return them as a recordset.
5174 :param func: a function or a dot-separated sequence of field names
5176 if isinstance(func, basestring):
5178 func = lambda rec: filter(None, rec.mapped(name))
5179 return self.browse([rec.id for rec in self if func(rec)])
5181 def sorted(self, key=None):
5182 """ Return the recordset `self` ordered by `key` """
5184 return self.search([('id', 'in', self.ids)])
5186 return self.browse(map(int, sorted(self, key=key)))
5188 def update(self, values):
5189 """ Update record `self[0]` with `values`. """
5190 for name, value in values.iteritems():
5194 # New records - represent records that do not exist in the database yet;
5195 # they are used to compute default values and perform onchanges.
5199 def new(self, values={}):
5200 """ Return a new record instance attached to `self.env`, and
5201 initialized with the `values` dictionary. Such a record does not
5202 exist in the database.
5204 record = self.browse([NewId()])
5205 record._cache.update(record._convert_to_cache(values, update=True))
5207 if record.env.in_onchange:
5208 # The cache update does not set inverse fields, so do it manually.
5209 # This is useful for computing a function field on secondary
5210 # records, if that field depends on the main record.
5212 field = self._fields.get(name)
5213 if field and field.inverse_field:
5214 field.inverse_field._update(record[name], record)
5219 # Dirty flag, to mark records modified (in draft mode)
5224 """ Return whether any record in `self` is dirty. """
5225 dirty = self.env.dirty
5226 return any(record in dirty for record in self)
5229 def _dirty(self, value):
5230 """ Mark the records in `self` as dirty. """
5232 map(self.env.dirty.add, self)
5234 map(self.env.dirty.discard, self)
5240 def __nonzero__(self):
5241 """ Test whether `self` is nonempty. """
5242 return bool(getattr(self, '_ids', True))
5245 """ Return the size of `self`. """
5246 return len(self._ids)
5249 """ Return an iterator over `self`. """
5250 for id in self._ids:
5251 yield self._browse(self.env, (id,))
5253 def __contains__(self, item):
5254 """ Test whether `item` is a subset of `self` or a field name. """
5255 if isinstance(item, BaseModel):
5256 if self._name == item._name:
5257 return set(item._ids) <= set(self._ids)
5258 raise except_orm("ValueError", "Mixing apples and oranges: %s in %s" % (item, self))
5259 if isinstance(item, basestring):
5260 return item in self._fields
5261 return item in self.ids
5263 def __add__(self, other):
5264 """ Return the concatenation of two recordsets. """
5265 if not isinstance(other, BaseModel) or self._name != other._name:
5266 raise except_orm("ValueError", "Mixing apples and oranges: %s + %s" % (self, other))
5267 return self.browse(self._ids + other._ids)
5269 def __sub__(self, other):
5270 """ Return the recordset of all the records in `self` that are not in `other`. """
5271 if not isinstance(other, BaseModel) or self._name != other._name:
5272 raise except_orm("ValueError", "Mixing apples and oranges: %s - %s" % (self, other))
5273 other_ids = set(other._ids)
5274 return self.browse([id for id in self._ids if id not in other_ids])
5276 def __and__(self, other):
5277 """ Return the intersection of two recordsets.
5278 Note that recordset order is not preserved.
5280 if not isinstance(other, BaseModel) or self._name != other._name:
5281 raise except_orm("ValueError", "Mixing apples and oranges: %s & %s" % (self, other))
5282 return self.browse(set(self._ids) & set(other._ids))
5284 def __or__(self, other):
5285 """ Return the union of two recordsets.
5286 Note that recordset order is not preserved.
5288 if not isinstance(other, BaseModel) or self._name != other._name:
5289 raise except_orm("ValueError", "Mixing apples and oranges: %s | %s" % (self, other))
5290 return self.browse(set(self._ids) | set(other._ids))
5292 def __eq__(self, other):
5293 """ Test whether two recordsets are equivalent (up to reordering). """
5294 if not isinstance(other, BaseModel):
5296 _logger.warning("Comparing apples and oranges: %s == %s", self, other)
5298 return self._name == other._name and set(self._ids) == set(other._ids)
5300 def __ne__(self, other):
5301 return not self == other
5303 def __lt__(self, other):
5304 if not isinstance(other, BaseModel) or self._name != other._name:
5305 raise except_orm("ValueError", "Mixing apples and oranges: %s < %s" % (self, other))
5306 return set(self._ids) < set(other._ids)
5308 def __le__(self, other):
5309 if not isinstance(other, BaseModel) or self._name != other._name:
5310 raise except_orm("ValueError", "Mixing apples and oranges: %s <= %s" % (self, other))
5311 return set(self._ids) <= set(other._ids)
5313 def __gt__(self, other):
5314 if not isinstance(other, BaseModel) or self._name != other._name:
5315 raise except_orm("ValueError", "Mixing apples and oranges: %s > %s" % (self, other))
5316 return set(self._ids) > set(other._ids)
5318 def __ge__(self, other):
5319 if not isinstance(other, BaseModel) or self._name != other._name:
5320 raise except_orm("ValueError", "Mixing apples and oranges: %s >= %s" % (self, other))
5321 return set(self._ids) >= set(other._ids)
5327 return "%s%s" % (self._name, getattr(self, '_ids', ""))
5329 def __unicode__(self):
5330 return unicode(str(self))
5335 if hasattr(self, '_ids'):
5336 return hash((self._name, frozenset(self._ids)))
5338 return hash(self._name)
5340 def __getitem__(self, key):
5341 """ If `key` is an integer or a slice, return the corresponding record
5342 selection as an instance (attached to `self.env`).
5343 Otherwise read the field `key` of the first record in `self`.
5347 inst = model.search(dom) # inst is a recordset
5348 r4 = inst[3] # fourth record in inst
5349 rs = inst[10:20] # subset of inst
5350 nm = rs['name'] # name of first record in inst
5352 if isinstance(key, basestring):
5353 # important: one must call the field's getter
5354 return self._fields[key].__get__(self, type(self))
5355 elif isinstance(key, slice):
5356 return self._browse(self.env, self._ids[key])
5358 return self._browse(self.env, (self._ids[key],))
5360 def __setitem__(self, key, value):
5361 """ Assign the field `key` to `value` in record `self`. """
5362 # important: one must call the field's setter
5363 return self._fields[key].__set__(self, value)
5366 # Cache and recomputation management
5371 """ Return the cache of `self`, mapping field names to values. """
5372 return RecordCache(self)
5375 def _in_cache_without(self, field):
5376 """ Make sure `self` is present in cache (for prefetching), and return
5377 the records of model `self` in cache that have no value for `field`
5378 (:class:`Field` instance).
5381 prefetch_ids = env.prefetch[self._name]
5382 prefetch_ids.update(self._ids)
5383 ids = filter(None, prefetch_ids - set(env.cache[field]))
5384 return self.browse(ids)
5388 """ Clear the records cache.
5391 The record cache is automatically invalidated.
5393 self.invalidate_cache()
5396 def invalidate_cache(self, fnames=None, ids=None):
5397 """ Invalidate the record caches after some records have been modified.
5398 If both `fnames` and `ids` are ``None``, the whole cache is cleared.
5400 :param fnames: the list of modified fields, or ``None`` for all fields
5401 :param ids: the list of modified record ids, or ``None`` for all
5405 return self.env.invalidate_all()
5406 fields = self._fields.values()
5408 fields = map(self._fields.__getitem__, fnames)
5410 # invalidate fields and inverse fields, too
5411 spec = [(f, ids) for f in fields] + \
5412 [(f.inverse_field, None) for f in fields if f.inverse_field]
5413 self.env.invalidate(spec)
5416 def modified(self, fnames):
5417 """ Notify that fields have been modified on `self`. This invalidates
5418 the cache, and prepares the recomputation of stored function fields
5419 (new-style fields only).
5421 :param fnames: iterable of field names that have been modified on
5424 # each field knows what to invalidate and recompute
5426 for fname in fnames:
5427 spec += self._fields[fname].modified(self)
5431 for env in self.env.all
5432 for field in env.cache
5434 # invalidate non-stored fields.function which are currently cached
5435 spec += [(f, None) for f in self.pool.pure_function_fields
5436 if f in cached_fields]
5438 self.env.invalidate(spec)
5440 def _recompute_check(self, field):
5441 """ If `field` must be recomputed on some record in `self`, return the
5442 corresponding records that must be recomputed.
5444 for env in [self.env] + list(iter(self.env.all)):
5445 if env.todo.get(field) and env.todo[field] & self:
5446 return env.todo[field]
5448 def _recompute_todo(self, field):
5449 """ Mark `field` to be recomputed. """
5450 todo = self.env.todo
5451 todo[field] = (todo.get(field) or self.browse()) | self
5453 def _recompute_done(self, field):
5454 """ Mark `field` as being recomputed. """
5455 todo = self.env.todo
5457 recs = todo.pop(field) - self
5462 def recompute(self):
5463 """ Recompute stored function fields. The fields and records to
5464 recompute have been determined by method :meth:`modified`.
5466 for env in list(iter(self.env.all)):
5468 field, recs = next(env.todo.iteritems())
5469 # evaluate the fields to recompute, and save them to database
5470 for rec, rec1 in zip(recs, recs.with_context(recompute=False)):
5472 values = rec._convert_to_write({
5473 f.name: rec[f.name] for f in field.computed_fields
5476 except MissingError:
5478 # mark the computed fields as done
5479 map(recs._recompute_done, field.computed_fields)
5482 # Generic onchange method
5485 def _has_onchange(self, field, other_fields):
5486 """ Return whether `field` should trigger an onchange event in the
5487 presence of `other_fields`.
5489 # test whether self has an onchange method for field, or field is a
5490 # dependency of any field in other_fields
5491 return field.name in self._onchange_methods or \
5492 any(dep in other_fields for dep in field.dependents)
5495 def _onchange_spec(self, view_info=None):
5496 """ Return the onchange spec from a view description; if not given, the
5497 result of ``self.fields_view_get()`` is used.
5501 # for traversing the XML arch and populating result
5502 def process(node, info, prefix):
5503 if node.tag == 'field':
5504 name = node.attrib['name']
5505 names = "%s.%s" % (prefix, name) if prefix else name
5506 if not result.get(names):
5507 result[names] = node.attrib.get('on_change')
5508 # traverse the subviews included in relational fields
5509 for subinfo in info['fields'][name].get('views', {}).itervalues():
5510 process(etree.fromstring(subinfo['arch']), subinfo, names)
5513 process(child, info, prefix)
5515 if view_info is None:
5516 view_info = self.fields_view_get()
5517 process(etree.fromstring(view_info['arch']), view_info, '')
5520 def _onchange_eval(self, field_name, onchange, result):
5521 """ Apply onchange method(s) for field `field_name` with spec `onchange`
5522 on record `self`. Value assignments are applied on `self`, while
5523 domain and warning messages are put in dictionary `result`.
5525 onchange = onchange.strip()
5528 if onchange in ("1", "true"):
5529 for method in self._onchange_methods.get(field_name, ()):
5530 method_res = method(self)
5533 if 'domain' in method_res:
5534 result.setdefault('domain', {}).update(method_res['domain'])
5535 if 'warning' in method_res:
5536 result['warning'] = method_res['warning']
5540 match = onchange_v7.match(onchange)
5542 method, params = match.groups()
5544 # evaluate params -> tuple
5545 global_vars = {'context': self._context, 'uid': self._uid}
5546 if self._context.get('field_parent'):
5547 class RawRecord(object):
5548 def __init__(self, record):
5549 self._record = record
5550 def __getattr__(self, name):
5551 field = self._record._fields[name]
5552 value = self._record[name]
5553 return field.convert_to_onchange(value)
5554 record = self[self._context['field_parent']]
5555 global_vars['parent'] = RawRecord(record)
5557 key: self._fields[key].convert_to_onchange(val)
5558 for key, val in self._cache.iteritems()
5560 params = eval("[%s]" % params, global_vars, field_vars)
5562 # call onchange method
5563 args = (self._cr, self._uid, self._origin.ids) + tuple(params)
5564 method_res = getattr(self._model, method)(*args)
5565 if not isinstance(method_res, dict):
5567 if 'value' in method_res:
5568 method_res['value'].pop('id', None)
5569 self.update(self._convert_to_cache(method_res['value'], validate=False))
5570 if 'domain' in method_res:
5571 result.setdefault('domain', {}).update(method_res['domain'])
5572 if 'warning' in method_res:
5573 result['warning'] = method_res['warning']
5576 def onchange(self, values, field_name, field_onchange):
5577 """ Perform an onchange on the given field.
5579 :param values: dictionary mapping field names to values, giving the
5580 current state of modification
5581 :param field_name: name of the modified field_name
5582 :param field_onchange: dictionary mapping field names to their
5587 if field_name and field_name not in self._fields:
5590 # determine subfields for field.convert_to_write() below
5592 subfields = defaultdict(set)
5593 for dotname in field_onchange:
5595 secondary.append(dotname)
5596 name, subname = dotname.split('.')
5597 subfields[name].add(subname)
5599 # create a new record with values, and attach `self` to it
5600 with env.do_in_onchange():
5601 record = self.new(values)
5602 values = dict(record._cache)
5603 # attach `self` with a different context (for cache consistency)
5604 record._origin = self.with_context(__onchange=True)
5606 # determine which field should be triggered an onchange
5607 todo = set([field_name]) if field_name else set(values)
5610 # dummy assignment: trigger invalidations on the record
5612 record[name] = record[name]
5614 result = {'value': {}}
5622 with env.do_in_onchange():
5623 # apply field-specific onchange methods
5624 if field_onchange.get(name):
5625 record._onchange_eval(name, field_onchange[name], result)
5627 # force re-evaluation of function fields on secondary records
5628 for field_seq in secondary:
5629 record.mapped(field_seq)
5631 # determine which fields have been modified
5632 for name, oldval in values.iteritems():
5633 newval = record[name]
5634 if newval != oldval or getattr(newval, '_dirty', False):
5635 field = self._fields[name]
5636 result['value'][name] = field.convert_to_write(
5637 newval, record._origin, subfields[name],
5641 # At the moment, the client does not support updates on a *2many field
5642 # while this one is modified by the user.
5643 if field_name and self._fields[field_name].type in ('one2many', 'many2many'):
5644 result['value'].pop(field_name, None)
5649 class RecordCache(MutableMapping):
5650 """ Implements a proxy dictionary to read/update the cache of a record.
5651 Upon iteration, it looks like a dictionary mapping field names to
5652 values. However, fields may be used as keys as well.
5654 def __init__(self, records):
5655 self._recs = records
5657 def __contains__(self, field):
5658 """ Return whether `records[0]` has a value for `field` in cache. """
5659 if isinstance(field, basestring):
5660 field = self._recs._fields[field]
5661 return self._recs.id in self._recs.env.cache[field]
5663 def __getitem__(self, field):
5664 """ Return the cached value of `field` for `records[0]`. """
5665 if isinstance(field, basestring):
5666 field = self._recs._fields[field]
5667 value = self._recs.env.cache[field][self._recs.id]
5668 return value.get() if isinstance(value, SpecialValue) else value
5670 def __setitem__(self, field, value):
5671 """ Assign the cached value of `field` for all records in `records`. """
5672 if isinstance(field, basestring):
5673 field = self._recs._fields[field]
5674 values = dict.fromkeys(self._recs._ids, value)
5675 self._recs.env.cache[field].update(values)
5677 def update(self, *args, **kwargs):
5678 """ Update the cache of all records in `records`. If the argument is a
5679 `SpecialValue`, update all fields (except "magic" columns).
5681 if args and isinstance(args[0], SpecialValue):
5682 values = dict.fromkeys(self._recs._ids, args[0])
5683 for name, field in self._recs._fields.iteritems():
5685 self._recs.env.cache[field].update(values)
5687 return super(RecordCache, self).update(*args, **kwargs)
5689 def __delitem__(self, field):
5690 """ Remove the cached value of `field` for all `records`. """
5691 if isinstance(field, basestring):
5692 field = self._recs._fields[field]
5693 field_cache = self._recs.env.cache[field]
5694 for id in self._recs._ids:
5695 field_cache.pop(id, None)
5698 """ Iterate over the field names with a regular value in cache. """
5699 cache, id = self._recs.env.cache, self._recs.id
5700 dummy = SpecialValue(None)
5701 for name, field in self._recs._fields.iteritems():
5702 if name != 'id' and not isinstance(cache[field].get(id, dummy), SpecialValue):
5706 """ Return the number of fields with a regular value in cache. """
5707 return sum(1 for name in self)
5709 class Model(BaseModel):
5710 """Main super-class for regular database-persisted OpenERP models.
5712 OpenERP models are created by inheriting from this class::
5717 The system will later instantiate the class once per database (on
5718 which the class' module is installed).
5721 _register = False # not visible in ORM registry, meant to be python-inherited only
5722 _transient = False # True in a TransientModel
5724 class TransientModel(BaseModel):
5725 """Model super-class for transient records, meant to be temporarily
5726 persisted, and regularly vaccuum-cleaned.
5728 A TransientModel has a simplified access rights management,
5729 all users can create new records, and may only access the
5730 records they created. The super-user has unrestricted access
5731 to all TransientModel records.
5734 _register = False # not visible in ORM registry, meant to be python-inherited only
5737 class AbstractModel(BaseModel):
5738 """Abstract Model super-class for creating an abstract class meant to be
5739 inherited by regular models (Models or TransientModels) but not meant to
5740 be usable on its own, or persisted.
5742 Technical note: we don't want to make AbstractModel the super-class of
5743 Model or BaseModel because it would not make sense to put the main
5744 definition of persistence methods such as create() in it, and still we
5745 should be able to override them within an AbstractModel.
5747 _auto = False # don't create any database backend for AbstractModels
5748 _register = False # not visible in ORM registry, meant to be python-inherited only
5751 def itemgetter_tuple(items):
5752 """ Fixes itemgetter inconsistency (useful in some cases) of not returning
5753 a tuple if len(items) == 1: always returns an n-tuple where n = len(items)
5758 return lambda gettable: (gettable[items[0]],)
5759 return operator.itemgetter(*items)
5761 def convert_pgerror_23502(model, fields, info, e):
5762 m = re.match(r'^null value in column "(?P<field>\w+)" violates '
5763 r'not-null constraint\n',
5765 field_name = m and m.group('field')
5766 if not m or field_name not in fields:
5767 return {'message': unicode(e)}
5768 message = _(u"Missing required value for the field '%s'.") % field_name
5769 field = fields.get(field_name)
5771 message = _(u"Missing required value for the field '%s' (%s)") % (field['string'], field_name)
5774 'field': field_name,
5777 def convert_pgerror_23505(model, fields, info, e):
5778 m = re.match(r'^duplicate key (?P<field>\w+) violates unique constraint',
5780 field_name = m and m.group('field')
5781 if not m or field_name not in fields:
5782 return {'message': unicode(e)}
5783 message = _(u"The value for the field '%s' already exists.") % field_name
5784 field = fields.get(field_name)
5786 message = _(u"%s This might be '%s' in the current model, or a field "
5787 u"of the same name in an o2m.") % (message, field['string'])
5790 'field': field_name,
5793 PGERROR_TO_OE = defaultdict(
5794 # shape of mapped converters
5795 lambda: (lambda model, fvg, info, pgerror: {'message': unicode(pgerror)}), {
5796 # not_null_violation
5797 '23502': convert_pgerror_23502,
5798 # unique constraint error
5799 '23505': convert_pgerror_23505,
5802 def _normalize_ids(arg, atoms={int, long, str, unicode, NewId}):
5803 """ Normalizes the ids argument for ``browse`` (v7 and v8) to a tuple.
5805 Various implementations were tested on the corpus of all browse() calls
5806 performed during a full crawler run (after having installed all website_*
5807 modules) and this one was the most efficient overall.
5809 A possible bit of correctness was sacrificed by not doing any test on
5810 Iterable and just assuming that any non-atomic type was an iterable of
5815 # much of the corpus is falsy objects (empty list, tuple or set, None)
5819 # `type in set` is significantly faster (because more restrictive) than
5820 # isinstance(arg, set) or issubclass(type, set); and for new-style classes
5821 # obj.__class__ is equivalent to but faster than type(obj). Not relevant
5822 # (and looks much worse) in most cases, but over millions of calls it
5823 # does have a very minor effect.
5824 if arg.__class__ in atoms:
5829 # keep those imports here to avoid dependency cycle errors
5830 from .osv import expression
5831 from .fields import Field, SpecialValue, FailedValue
5833 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: