Files
tryton/trytond/model/fields/many2many.py
T
2012-09-24 22:16:53 +02:00

239 lines
8.9 KiB
Python

#This file is part of Tryton. The COPYRIGHT file at the top level of
#this repository contains the full copyright notices and license terms.
from itertools import chain
from trytond.model.fields.field import Field, size_validate
from trytond.transaction import Transaction
from trytond.pool import Pool
class Many2Many(Field):
'''
Define many2many field (``list``).
'''
_type = 'many2many'
def __init__(self, relation_name, origin, target, string='', order=None,
datetime_field=None, size=None, help='', required=False,
readonly=False, domain=None, states=None, on_change=None,
on_change_with=None, depends=None, order_field=None, context=None,
loading='lazy'):
'''
:param relation_name: The name of the relation model
or the name of the target model for ModelView only.
:param origin: The name of the field to store origin ids.
:param target: The name of the field to store target ids.
:param order: a list of tuples that are constructed like this:
``('field name', 'DESC|ASC')``
allowing to specify the order of result
:param datetime_field: The name of the field that contains the datetime
value to read the target records.
'''
if datetime_field:
if depends:
depends.append(datetime_field)
else:
depends = [datetime_field]
super(Many2Many, self).__init__(string=string, help=help,
required=required, readonly=readonly, domain=domain, states=states,
on_change=on_change, on_change_with=on_change_with,
depends=depends, order_field=order_field, context=context,
loading=loading)
self.relation_name = relation_name
self.origin = origin
self.target = target
self.order = order
self.datetime_field = datetime_field
self.__size = None
self.size = size
__init__.__doc__ += Field.__init__.__doc__
def _get_size(self):
return self.__size
def _set_size(self, value):
size_validate(value)
self.__size = value
size = property(_get_size, _set_size)
def get(self, ids, model, name, values=None):
'''
Return target records ordered.
'''
if values is None:
values = {}
res = {}
if not ids:
return res
for i in ids:
res[i] = []
if self.order is None:
order = [(self.target, 'ASC')]
else:
order = self.order
Relation = Pool().get(self.relation_name)
if self.origin in Relation._fields:
origin_field = Relation._fields[self.origin]
else:
origin_field = Relation._inherit_fields[self.origin][2]
relations = []
for i in range(0, len(ids), Transaction().cursor.IN_MAX):
sub_ids = ids[i:i + Transaction().cursor.IN_MAX]
if origin_field._type == 'reference':
references = ['%s,%s' % (model.__name__, x) for x in sub_ids]
clause = [(self.origin, 'in', references)]
else:
clause = [(self.origin, 'in', sub_ids)]
clause += [(self.target + '.id', '!=', None)]
relations.append(Relation.search(clause, order=order))
relations = list(chain(*relations))
for relation in relations:
origin_id = getattr(relation, self.origin).id
res[origin_id].append(getattr(relation, self.target).id)
return dict((key, tuple(value)) for key, value in res.iteritems())
def set(self, ids, model, name, values):
'''
Set the values.
values: A list of tuples:
(``create``, ``{<field name>: value}``),
(``write``, ``<ids>``, ``{<field name>: value}``),
(``delete``, ``<ids>``),
(``delete_all``),
(``unlink``, ``<ids>``),
(``add``, ``<ids>``),
(``unlink_all``),
(``set``, ``<ids>``)
'''
pool = Pool()
if not values:
return
Relation = pool.get(self.relation_name)
Target = self.get_target()
if self.origin in Relation._fields:
origin_field = Relation._fields[self.origin]
else:
origin_field = Relation._inherit_fields[self.origin][2]
def search_clause(ids):
if origin_field._type == 'reference':
references = ['%s,%s' % (model.__name__, x) for x in ids]
return (self.origin, 'in', references)
else:
return (self.origin, 'in', ids)
def field_value(record_id):
if origin_field._type == 'reference':
return '%s,%s' % (model.__name__, record_id)
else:
return record_id
for act in values:
if act[0] == 'create':
for record_id in ids:
Relation.create({
self.origin: field_value(record_id),
self.target: Target.create(act[1]).id,
})
elif act[0] == 'write':
Target.write(Target.browse(act[1]), act[2])
elif act[0] == 'delete':
Target.delete(Target.browse(act[1]))
elif act[0] == 'delete_all':
relations = Relation.search([
search_clause(ids),
])
Target.delete([getattr(r, self.target) for r in relations
if getattr(r, self.target)])
elif act[0] == 'unlink':
if isinstance(act[1], (int, long)):
target_ids = [act[1]]
else:
target_ids = list(act[1])
if not target_ids:
continue
relations = []
for i in range(0, len(target_ids),
Transaction().cursor.IN_MAX):
sub_ids = target_ids[i:i + Transaction().cursor.IN_MAX]
relations += Relation.search([
search_clause(ids),
(self.target, 'in', sub_ids),
])
Relation.delete(relations)
elif act[0] == 'add':
target_ids = list(act[1])
if not target_ids:
continue
existing_ids = []
for i in range(0, len(target_ids),
Transaction().cursor.IN_MAX):
sub_ids = target_ids[i:i + Transaction().cursor.IN_MAX]
relations = Relation.search([
search_clause(ids),
(self.target, 'in', sub_ids),
])
for relation in relations:
existing_ids.append(getattr(relation, self.target).id)
for new_id in (x for x in target_ids if x not in existing_ids):
for record_id in ids:
Relation.create({
self.origin: field_value(record_id),
self.target: new_id,
})
elif act[0] == 'unlink_all':
targets = Relation.search([
search_clause(ids),
(self.target + '.id', '!=', None),
])
Relation.delete(targets)
elif act[0] == 'set':
if not act[1]:
target_ids = []
else:
target_ids = list(act[1])
targets2 = Relation.search([
search_clause(ids),
(self.target + '.id', '!=', None),
])
Relation.delete(targets2)
for new_id in target_ids:
for record_id in ids:
Relation.create({
self.origin: field_value(record_id),
self.target: new_id,
})
else:
raise Exception('Bad arguments')
def get_target(self):
'Return the target model'
Relation = Pool().get(self.relation_name)
if not self.target:
return Relation
if self.target in Relation._fields:
return Relation._fields[self.target].get_target()
else:
return Relation._inherit_fields[self.target][2].get_target()
def __set__(self, inst, value):
Target = self.get_target()
def instance(data):
if isinstance(data, Target):
return data
elif isinstance(data, dict):
return Target(**data)
else:
return Target(data)
value = [instance(x) for x in (value or [])]
super(Many2Many, self).__set__(inst, value)