"""The automatic entity form.
:organization: Logilab
:copyright: 2001-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
"""
__docformat__ = "restructuredtext en"
_ = unicode
from warnings import warn
from simplejson import dumps
from logilab.mtconverter import xml_escape
from logilab.common.decorators import iclassmethod, cached
from cubicweb import typed_eid, neg_role, uilib
from cubicweb.schema import display_name
from cubicweb.view import EntityView
from cubicweb.selectors import (
match_kwargs, match_form_params, non_final_entity,
specified_etype_implements)
from cubicweb.web import stdmsgs, uicfg, eid_param, \
form as f, formwidgets as fw, formfields as ff
from cubicweb.web.views import forms
_AFS = uicfg.autoform_section
_AFFK = uicfg.autoform_field_kwargs
# inlined form handling ########################################################
class InlinedFormField(ff.Field):
def __init__(self, view=None, **kwargs):
kwargs.setdefault('label', None)
super(InlinedFormField, self).__init__(name=view.rtype, role=view.role,
eidparam=True, **kwargs)
self.view = view
def render(self, form, renderer):
"""render this field, which is part of form, using the given form
renderer
"""
view = self.view
i18nctx = 'inlined:%s.%s.%s' % (form.edited_entity.e_schema,
view.rtype, view.role)
return u'<div class="inline-%s-%s-slot">%s</div>' % (
view.rtype, view.role,
view.render(i18nctx=i18nctx, row=view.cw_row, col=view.cw_col))
def form_init(self, form):
"""method called before by build_context to trigger potential field
initialization requiring the form instance
"""
if self.view.form:
self.view.form.build_context(form.formvalues)
@property
def needs_multipart(self):
if self.view.form:
# take a look at inlined forms to check (recursively) if they need
# multipart handling.
return self.view.form.needs_multipart
return False
def has_been_modified(self, form):
return False
def process_posted(self, form):
pass # handled by the subform
class InlineEntityEditionFormView(f.FormViewMixIn, EntityView):
"""
:attr peid: the parent entity's eid hosting the inline form
:attr rtype: the relation bridging `etype` and `peid`
:attr role: the role played by the `peid` in the relation
:attr pform: the parent form where this inlined form is being displayed
"""
__regid__ = 'inline-edition'
__select__ = non_final_entity() & match_kwargs('peid', 'rtype')
_select_attrs = ('peid', 'rtype', 'role', 'pform', 'etype')
removejs = "removeInlinedEntity('%s', '%s', '%s')"
def __init__(self, *args, **kwargs):
for attr in self._select_attrs:
# don't pop attributes from kwargs, so the end-up in
# self.cw_extra_kwargs which is then passed to the edition form (see
# the .form method)
setattr(self, attr, kwargs.get(attr))
super(InlineEntityEditionFormView, self).__init__(*args, **kwargs)
def _entity(self):
assert self.cw_row is not None, self
return self.cw_rset.get_entity(self.cw_row, self.cw_col)
@property
@cached
def form(self):
entity = self._entity()
form = self._cw.vreg['forms'].select('edition', self._cw,
entity=entity,
formtype='inlined',
form_renderer_id='inline',
copy_nav_params=False,
mainform=False,
parent_form=self.pform,
**self.cw_extra_kwargs)
if self.pform is None:
form.restore_previous_post(form.session_key())
#assert form.parent_form
self.add_hiddens(form, entity)
return form
def cell_call(self, row, col, i18nctx, **kwargs):
"""
:param peid: the parent entity's eid hosting the inline form
:param rtype: the relation bridging `etype` and `peid`
:param role: the role played by the `peid` in the relation
"""
entity = self._entity()
divonclick = "restoreInlinedEntity('%s', '%s', '%s')" % (
self.peid, self.rtype, entity.eid)
self.render_form(i18nctx, divonclick=divonclick, **kwargs)
def render_form(self, i18nctx, **kwargs):
"""fetch and render the form"""
entity = self._entity()
divid = '%s-%s-%s' % (self.peid, self.rtype, entity.eid)
title = self.form_title(entity, i18nctx)
removejs = self.removejs and self.removejs % (
self.peid, self.rtype, entity.eid)
countkey = '%s_count' % self.rtype
try:
self._cw.data[countkey] += 1
except KeyError:
self._cw.data[countkey] = 1
self.w(self.form.render(
divid=divid, title=title, removejs=removejs, i18nctx=i18nctx,
counter=self._cw.data[countkey] , **kwargs))
def form_title(self, entity, i18nctx):
return self._cw.pgettext(i18nctx, entity.__regid__)
def add_hiddens(self, form, entity):
"""to ease overriding (see cubes.vcsfile.views.forms for instance)"""
iid = 'rel-%s-%s-%s' % (self.peid, self.rtype, entity.eid)
# * str(self.rtype) in case it's a schema object
# * neged_role() since role is the for parent entity, we want the role
# of the inlined entity
form.add_hidden(name=str(self.rtype), value=self.peid,
role=neg_role(self.role), eidparam=True, id=iid)
def keep_entity(self, form, entity):
if not entity.has_eid():
return True
# are we regenerating form because of a validation error ?
if form.form_previous_values:
cdvalues = self._cw.list_form_param(eid_param(self.rtype, self.peid),
form.form_previous_values)
if unicode(entity.eid) not in cdvalues:
return False
return True
class InlineEntityCreationFormView(InlineEntityEditionFormView):
"""
:attr etype: the entity type being created in the inline form
"""
__regid__ = 'inline-creation'
__select__ = (match_kwargs('peid', 'petype', 'rtype')
& specified_etype_implements('Any'))
_select_attrs = InlineEntityEditionFormView._select_attrs + ('petype',)
@property
def removejs(self):
entity = self._entity()
rdef = entity.e_schema.rdef(self.rtype, neg_role(self.role), self.petype)
card= rdef.role_cardinality(self.role)
# when one is adding an inline entity for a relation of a single card,
# the 'add a new xxx' link disappears. If the user then cancel the addition,
# we have to make this link appears back. This is done by giving add new link
# id to removeInlineForm.
if card not in '?1':
return "removeInlineForm('%%s', '%%s', '%s', '%%s')" % self.role
divid = "addNew%s%s%s:%s" % (
self.etype, self.rtype, self.role, self.peid)
return "removeInlineForm('%%s', '%%s', '%s', '%%s', '%s')" % (
self.role, divid)
@cached
def _entity(self):
try:
cls = self._cw.vreg['etypes'].etype_class(self.etype)
except:
self.w(self._cw._('no such entity type %s') % etype)
return
entity = cls(self._cw)
entity.eid = self._cw.varmaker.next()
return entity
def call(self, i18nctx, **kwargs):
self.render_form(i18nctx, **kwargs)
class InlineAddNewLinkView(InlineEntityCreationFormView):
"""
:attr card: the cardinality of the relation according to role of `peid`
"""
__regid__ = 'inline-addnew-link'
__select__ = (match_kwargs('peid', 'petype', 'rtype')
& specified_etype_implements('Any'))
_select_attrs = InlineEntityCreationFormView._select_attrs + ('card',)
form = None # no actual form wrapped
def call(self, i18nctx, **kwargs):
self._cw.set_varmaker()
divid = "addNew%s%s%s:%s" % (self.etype, self.rtype, self.role, self.peid)
self.w(u'<div class="inlinedform" id="%s" cubicweb:limit="true">'
% divid)
js = "addInlineCreationForm('%s', '%s', '%s', '%s', '%s', '%s')" % (
self.peid, self.petype, self.etype, self.rtype, self.role, i18nctx)
if self.pform.should_hide_add_new_relation_link(self.rtype, self.card):
js = "toggleVisibility('%s'); %s" % (divid, js)
__ = self._cw.pgettext
self.w(u'<a class="addEntity" id="add%s:%slink" href="javascript: %s" >+ %s.</a>'
% (self.rtype, self.peid, js, __(i18nctx, 'add a %s' % self.etype)))
self.w(u'</div>')
# generic relations handling ##################################################
def relation_id(eid, rtype, role, reid):
"""return an identifier for a relation between two entities"""
if role == 'subject':
return u'%s:%s:%s' % (eid, rtype, reid)
return u'%s:%s:%s' % (reid, rtype, eid)
def toggleable_relation_link(eid, nodeid, label='x'):
"""return javascript snippet to delete/undelete a relation between two
entities
"""
js = u"javascript: togglePendingDelete('%s', %s);" % (
nodeid, xml_escape(dumps(eid)))
return u'[<a class="handle" href="%s" id="handle%s">%s</a>]' % (
js, nodeid, label)
def get_pending_inserts(req, eid=None):
"""shortcut to access req's pending_insert entry
This is where are stored relations being added while editing
an entity. This used to be stored in a temporary cookie.
"""
pending = req.get_session_data('pending_insert') or ()
return ['%s:%s:%s' % (subj, rel, obj) for subj, rel, obj in pending
if eid is None or eid in (subj, obj)]
def get_pending_deletes(req, eid=None):
"""shortcut to access req's pending_delete entry
This is where are stored relations being removed while editing
an entity. This used to be stored in a temporary cookie.
"""
pending = req.get_session_data('pending_delete') or ()
return ['%s:%s:%s' % (subj, rel, obj) for subj, rel, obj in pending
if eid is None or eid in (subj, obj)]
def parse_relations_descr(rdescr):
"""parse a string describing some relations, in the form
subjeids:rtype:objeids
where subjeids and objeids are eids separeted by a underscore
return an iterator on (subject eid, relation type, object eid) found
"""
for rstr in rdescr:
subjs, rtype, objs = rstr.split(':')
for subj in subjs.split('_'):
for obj in objs.split('_'):
yield typed_eid(subj), rtype, typed_eid(obj)
def delete_relations(req, rdefs):
"""delete relations from the repository"""
# FIXME convert to using the syntax subject:relation:eids
execute = req.execute
for subj, rtype, obj in parse_relations_descr(rdefs):
rql = 'DELETE X %s Y where X eid %%(x)s, Y eid %%(y)s' % rtype
execute(rql, {'x': subj, 'y': obj}, ('x', 'y'))
req.set_message(req._('relations deleted'))
def insert_relations(req, rdefs):
"""insert relations into the repository"""
execute = req.execute
for subj, rtype, obj in parse_relations_descr(rdefs):
rql = 'SET X %s Y where X eid %%(x)s, Y eid %%(y)s' % rtype
execute(rql, {'x': subj, 'y': obj}, ('x', 'y'))
class GenericRelationsWidget(fw.FieldWidget):
def render(self, form, field, renderer):
stream = []
w = stream.append
req = form._cw
_ = req._
__ = _
eid = form.edited_entity.eid
w(u'<table id="relatedEntities">')
for rschema, role, related in field.relations_table(form):
# already linked entities
if related:
w(u'<tr><th class="labelCol">%s</th>' % rschema.display_name(req, role))
w(u'<td>')
w(u'<ul>')
for viewparams in related:
w(u'<li class="invisible">%s<div id="span%s" class="%s">%s</div></li>'
% (viewparams[1], viewparams[0], viewparams[2], viewparams[3]))
if not form.force_display and form.maxrelitems < len(related):
link = (u'<span class="invisible">'
'[<a href="javascript: window.location.href+=\'&__force_display=1\'">%s</a>]'
'</span>' % _('view all'))
w(u'<li class="invisible">%s</li>' % link)
w(u'</ul>')
w(u'</td>')
w(u'</tr>')
pendings = list(field.restore_pending_inserts(form))
if not pendings:
w(u'<tr><th> </th><td> </td></tr>')
else:
for row in pendings:
# soon to be linked to entities
w(u'<tr id="tr%s">' % row[1])
w(u'<th>%s</th>' % row[3])
w(u'<td>')
w(u'<a class="handle" title="%s" href="%s">[x]</a>' %
(_('cancel this insert'), row[2]))
w(u'<a id="a%s" class="editionPending" href="%s">%s</a>'
% (row[1], row[4], xml_escape(row[5])))
w(u'</td>')
w(u'</tr>')
w(u'<tr id="relationSelectorRow_%s" class="separator">' % eid)
w(u'<th class="labelCol">')
w(u'<select id="relationSelector_%s" tabindex="%s" '
'onchange="javascript:showMatchingSelect(this.options[this.selectedIndex].value,%s);">'
% (eid, req.next_tabindex(), xml_escape(dumps(eid))))
w(u'<option value="">%s</option>' % _('select a relation'))
for i18nrtype, rschema, role in field.relations:
# more entities to link to
w(u'<option value="%s_%s">%s</option>' % (rschema, role, i18nrtype))
w(u'</select>')
w(u'</th>')
w(u'<td id="unrelatedDivs_%s"></td>' % eid)
w(u'</tr>')
w(u'</table>')
return '\n'.join(stream)
class GenericRelationsField(ff.Field):
widget = GenericRelationsWidget
def __init__(self, relations, name='_cw_generic_field', **kwargs):
assert relations
kwargs['eidparam'] = True
super(GenericRelationsField, self).__init__(name, **kwargs)
self.relations = relations
def process_posted(self, form):
todelete = get_pending_deletes(form._cw)
if todelete:
delete_relations(form._cw, todelete)
toinsert = get_pending_inserts(form._cw)
if toinsert:
insert_relations(form._cw, toinsert)
return ()
def relations_table(self, form):
"""yiels 3-tuples (rtype, role, related_list)
where <related_list> itself a list of :
- node_id (will be the entity element's DOM id)
- appropriate javascript's togglePendingDelete() function call
- status 'pendingdelete' or ''
- oneline view of related entity
"""
entity = form.edited_entity
pending_deletes = get_pending_deletes(form._cw, entity.eid)
for label, rschema, role in self.relations:
related = []
if entity.has_eid():
rset = entity.related(rschema, role, limit=form.related_limit)
if role == 'subject':
haspermkwargs = {'fromeid': entity.eid}
else:
haspermkwargs = {'toeid': entity.eid}
if rschema.has_perm(form._cw, 'delete', **haspermkwargs):
toggleable_rel_link_func = toggleable_relation_link
else:
toggleable_rel_link_func = lambda x, y, z: u''
for row in xrange(rset.rowcount):
nodeid = relation_id(entity.eid, rschema, role,
rset[row][0])
if nodeid in pending_deletes:
status, label = u'pendingDelete', '+'
else:
status, label = u'', 'x'
dellink = toggleable_rel_link_func(entity.eid, nodeid, label)
eview = form._cw.view('oneline', rset, row=row)
related.append((nodeid, dellink, status, eview))
yield (rschema, role, related)
def restore_pending_inserts(self, form):
"""used to restore edition page as it was before clicking on
'search for <some entity type>'
"""
entity = form.edited_entity
pending_inserts = set(get_pending_inserts(form._cw, form.edited_entity.eid))
for pendingid in pending_inserts:
eidfrom, rtype, eidto = pendingid.split(':')
if typed_eid(eidfrom) == entity.eid: # subject
label = display_name(form._cw, rtype, 'subject',
entity.__regid__)
reid = eidto
else:
label = display_name(form._cw, rtype, 'object',
entity.__regid__)
reid = eidfrom
jscall = "javascript: cancelPendingInsert('%s', 'tr', null, %s);" \
% (pendingid, entity.eid)
rset = form._cw.eid_rset(reid)
eview = form._cw.view('text', rset, row=0)
yield rtype, pendingid, jscall, label, reid, eview
class UnrelatedDivs(EntityView):
__regid__ = 'unrelateddivs'
__select__ = match_form_params('relation')
def cell_call(self, row, col):
entity = self.cw_rset.get_entity(row, col)
relname, role = self._cw.form.get('relation').rsplit('_', 1)
rschema = self._cw.vreg.schema.rschema(relname)
hidden = 'hidden' in self._cw.form
is_cell = 'is_cell' in self._cw.form
self.w(self.build_unrelated_select_div(entity, rschema, role,
is_cell=is_cell, hidden=hidden))
def build_unrelated_select_div(self, entity, rschema, role,
is_cell=False, hidden=True):
options = []
divid = 'div%s_%s_%s' % (rschema.type, role, entity.eid)
selectid = 'select%s_%s_%s' % (rschema.type, role, entity.eid)
if rschema.symmetric or role == 'subject':
targettypes = rschema.objects(entity.e_schema)
etypes = '/'.join(sorted(etype.display_name(self._cw) for etype in targettypes))
else:
targettypes = rschema.subjects(entity.e_schema)
etypes = '/'.join(sorted(etype.display_name(self._cw) for etype in targettypes))
etypes = uilib.cut(etypes, self._cw.property_value('navigation.short-line-size'))
options.append('<option>%s %s</option>' % (self._cw._('select a'), etypes))
options += self._get_select_options(entity, rschema, role)
options += self._get_search_options(entity, rschema, role, targettypes)
relname, role = self._cw.form.get('relation').rsplit('_', 1)
return u"""\
<div class="%s" id="%s">
<select id="%s" onchange="javascript: addPendingInsert(this.options[this.selectedIndex], %s, %s, '%s');">
%s
</select>
</div>
""" % (hidden and 'hidden' or '', divid, selectid,
xml_escape(dumps(entity.eid)), is_cell and 'true' or 'null', relname,
'\n'.join(options))
def _get_select_options(self, entity, rschema, role):
"""add options to search among all entities of each possible type"""
options = []
pending_inserts = get_pending_inserts(self._cw, entity.eid)
rtype = rschema.type
form = self._cw.vreg['forms'].select('edition', self._cw, entity=entity)
field = form.field_by_name(rschema, role, entity.e_schema)
limit = self._cw.property_value('navigation.combobox-limit')
# NOTE: expect 'limit' arg on choices method of relation field
for eview, reid in field.vocabulary(form, limit=limit):
if reid is None:
if eview: # skip blank value
options.append('<option class="separator">-- %s --</option>'
% xml_escape(eview))
elif reid != ff.INTERNAL_FIELD_VALUE:
optionid = relation_id(entity.eid, rtype, role, reid)
if optionid not in pending_inserts:
# prefix option's id with letters to make valid XHTML wise
options.append('<option id="id%s" value="%s">%s</option>' %
(optionid, reid, xml_escape(eview)))
return options
def _get_search_options(self, entity, rschema, role, targettypes):
"""add options to search among all entities of each possible type"""
options = []
_ = self._cw._
for eschema in targettypes:
mode = '%s:%s:%s:%s' % (role, entity.eid, rschema.type, eschema)
url = self._cw.build_url(entity.rest_path(), vid='search-associate',
__mode=mode)
options.append((eschema.display_name(self._cw),
'<option value="%s">%s %s</option>' % (
xml_escape(url), _('Search for'), eschema.display_name(self._cw))))
return [o for l, o in sorted(options)]
# The automatic entity form ####################################################
class AutomaticEntityForm(forms.EntityFieldsForm):
"""base automatic form to edit any entity.
Designed to be fully generated from schema but highly configurable through:
* uicfg (autoform_* relation tags)
* various standard form parameters
* overriding
You can also easily customise it by adding/removing fields in
AutomaticEntityForm instances or by inheriting from it.
"""
__regid__ = 'edition'
cwtarget = 'eformframe'
cssclass = 'entityForm'
copy_nav_params = True
form_buttons = [fw.SubmitButton(),
fw.Button(stdmsgs.BUTTON_APPLY, cwaction='apply'),
fw.Button(stdmsgs.BUTTON_CANCEL, cwaction='cancel')]
# for attributes selection when searching in uicfg.autoform_section
formtype = 'main'
# set this to a list of [(relation, role)] if you want to explictily tell
# which relations should be edited
display_fields = None
@iclassmethod
def field_by_name(cls_or_self, name, role=None, eschema=None):
"""return field with the given name and role. If field is not explicitly
defined for the form but `eclass` is specified, guess_field will be
called.
"""
try:
return super(AutomaticEntityForm, cls_or_self).field_by_name(name, role, eschema)
except f.FieldNotFound:
if name == '_cw_generic_field' and not isinstance(cls_or_self, type):
return cls_or_self._generic_relations_field()
raise
# base automatic entity form methods #######################################
def __init__(self, *args, **kwargs):
super(AutomaticEntityForm, self).__init__(*args, **kwargs)
entity = self.edited_entity
if entity.has_eid():
entity.complete()
for rtype, role in self.editable_attributes():
try:
self.field_by_name(str(rtype), role)
continue # explicitly specified
except f.FieldNotFound:
# has to be guessed
try:
field = self.field_by_name(str(rtype), role,
eschema=entity.e_schema)
self.fields.append(field)
except f.FieldNotFound:
# meta attribute such as <attr>_format
continue
if self.fieldsets_in_order:
fsio = list(self.fieldsets_in_order)
else:
fsio = [None]
self.fieldsets_in_order = fsio
# add fields for relation whose target should have an inline form
for formview in self.inlined_form_views():
field = self._inlined_form_view_field(formview)
self.fields.append(field)
if not field.fieldset in fsio:
fsio.append(field.fieldset)
if self.formtype == 'main':
# add the generic relation field if necessary
if entity.has_eid() and (
self.display_fields is None or
'_cw_generic_field' in self.display_fields):
try:
field = self.field_by_name('_cw_generic_field')
except f.FieldNotFound:
# no editable relation
pass
else:
self.fields.append(field)
if not field.fieldset in fsio:
fsio.append(field.fieldset)
self.maxrelitems = self._cw.property_value('navigation.related-limit')
self.force_display = bool(self._cw.form.get('__force_display'))
fnum = len(self.fields)
self.fields.sort(key=lambda f: f.order is None and fnum or f.order)
@property
def related_limit(self):
if self.force_display:
return None
return self.maxrelitems + 1
def action(self):
"""return the form's action attribute. Default to validateform if not
explicitly overriden.
"""
try:
return self._action
except AttributeError:
return self._cw.build_url('validateform')
def set_action(self, value):
"""override default action"""
self._action = value
action = property(action, set_action)
# autoform specific fields #################################################
def _generic_relations_field(self):
try:
srels_by_cat = self.srelations_by_category('generic', 'add', strict=True)
warn('[3.6] %s: srelations_by_category is deprecated, use uicfg or '
'override editable_relations instead' % classid(form),
DeprecationWarning)
except AttributeError:
srels_by_cat = self.editable_relations()
if not srels_by_cat:
raise f.FieldNotFound('_cw_generic_field')
fieldset = u'%s :' % self._cw.__('This %s' % self.edited_entity.e_schema)
fieldset = fieldset.capitalize()
return GenericRelationsField(self.editable_relations(),
fieldset=fieldset, label=None)
def _inlined_form_view_field(self, view):
# XXX allow more customization
kwargs = _AFFK.etype_get(self.edited_entity.e_schema, view.rtype,
view.role, view.etype)
if kwargs is None:
kwargs = {}
return InlinedFormField(view=view, **kwargs)
# methods mapping edited entity relations to fields in the form ############
def _relations_by_section(self, section, permission='add', strict=False):
"""return a list of (relation schema, target schemas, role) matching
given category(ies) and permission
"""
return _AFS.relations_by_section(
self.edited_entity, self.formtype, section, permission, strict)
def editable_attributes(self, strict=False):
"""return a list of (relation schema, role) to edit for the entity"""
if self.display_fields is not None:
return self.display_fields
if self.edited_entity.has_eid() and not self.edited_entity.has_perm('update'):
return []
# XXX we should simply put eid in the generated section, no?
return [(rtype, role) for rtype, _, role in self._relations_by_section(
'attributes', 'update', strict)]
def editable_relations(self):
"""return a sorted list of (relation's label, relation'schema, role) for
relations in the 'relations' section
"""
result = []
for rschema, _, role in self._relations_by_section('relations',
strict=True):
result.append( (rschema.display_name(self.edited_entity._cw, role,
self.edited_entity.__regid__),
rschema, role) )
return sorted(result)
def inlined_relations(self):
"""return a list of (relation schema, target schemas, role) matching
given category(ies) and permission
"""
return self._relations_by_section('inlined')
# inlined forms control ####################################################
def inlined_form_views(self):
"""compute and return list of inlined form views (hosting the inlined
form object)
"""
allformviews = []
entity = self.edited_entity
for rschema, ttypes, role in self.inlined_relations():
# show inline forms only if there's one possible target type
# for rschema
if len(ttypes) != 1:
self.warning('entity related by the %s relation should have '
'inlined form but there is multiple target types, '
'dunno what to do', rschema)
continue
ttype = ttypes[0].type
if self.should_inline_relation_form(rschema, ttype, role):
formviews = list(self.inline_edition_form_view(rschema, ttype, role))
card = rschema.role_rdef(entity.e_schema, ttype, role).role_cardinality(role)
# there is no related entity and we need at least one: we need to
# display one explicit inline-creation view
if self.should_display_inline_creation_form(rschema, formviews, card):
formviews += self.inline_creation_form_view(rschema, ttype, role)
# we can create more than one related entity, we thus display a link
# to add new related entities
if self.should_display_add_new_relation_link(rschema, formviews, card):
addnewlink = self._cw.vreg['views'].select(
'inline-addnew-link', self._cw,
etype=ttype, rtype=rschema, role=role, card=card,
peid=self.edited_entity.eid,
petype=self.edited_entity.e_schema, pform=self)
formviews.append(addnewlink)
allformviews += formviews
return allformviews
def should_inline_relation_form(self, rschema, targettype, role):
"""return true if the given relation with entity has role and a
targettype target should be inlined
At this point we now relation has inlined_attributes tag (eg is returned
by `inlined_relations()`. Overrides this for more finer control.
"""
return True
def should_display_inline_creation_form(self, rschema, existant, card):
"""return true if a creation form should be inlined
by default true if there is no related entity and we need at least one
"""
return not existant and card in '1+' or self._cw.form.has_key('force_%s_display' % rschema)
def should_display_add_new_relation_link(self, rschema, existant, card):
"""return true if we should add a link to add a new creation form
(through ajax call)
by default true if there is no related entity or if the relation has
multiple cardinality
"""
return not existant or card in '+*' # XXX add target type permisssions
def should_hide_add_new_relation_link(self, rschema, card):
"""return true if once an inlined creation form is added, the 'add new'
link should be hidden
by default true if the relation has single cardinality
"""
return card in '1?'
def inline_edition_form_view(self, rschema, ttype, role):
"""yield inline form views for already related entities through the
given relation
"""
entity = self.edited_entity
related = entity.has_eid() and entity.related(rschema, role)
if related:
vvreg = self._cw.vreg['views']
# display inline-edition view for all existing related entities
for i, relentity in enumerate(related.entities()):
if relentity.has_perm('update'):
yield vvreg.select('inline-edition', self._cw,
rset=related, row=i, col=0,
etype=ttype, rtype=rschema, role=role,
peid=entity.eid, pform=self)
def inline_creation_form_view(self, rschema, ttype, role):
"""yield inline form views to a newly related (hence created) entity
through the given relation
"""
yield self._cw.vreg['views'].select('inline-creation', self._cw,
etype=ttype, rtype=rschema, role=role,
peid=self.edited_entity.eid,
petype=self.edited_entity.e_schema,
pform=self)
## default form ui configuration ##############################################
# use primary and not generated for eid since it has to be an hidden
_AFS.tag_attribute(('*', 'eid'), 'main', 'attributes')
_AFS.tag_attribute(('*', 'eid'), 'muledit', 'attributes')
_AFS.tag_attribute(('*', 'description'), 'main', 'attributes')
_AFS.tag_attribute(('*', 'creation_date'), 'main', 'metadata')
_AFS.tag_attribute(('*', 'modification_date'), 'main', 'metadata')
_AFS.tag_attribute(('*', 'cwuri'), 'main', 'metadata')
_AFS.tag_attribute(('*', 'has_text'), 'main', 'hidden')
_AFS.tag_subject_of(('*', 'in_state', '*'), 'main', 'hidden')
_AFS.tag_subject_of(('*', 'owned_by', '*'), 'main', 'metadata')
_AFS.tag_subject_of(('*', 'created_by', '*'), 'main', 'metadata')
_AFS.tag_subject_of(('*', 'require_permission', '*'), 'main', 'hidden')
_AFS.tag_subject_of(('*', 'by_transition', '*'), 'main', 'attributes')
_AFS.tag_subject_of(('*', 'by_transition', '*'), 'muledit', 'attributes')
_AFS.tag_object_of(('*', 'by_transition', '*'), 'main', 'hidden')
_AFS.tag_object_of(('*', 'from_state', '*'), 'main', 'hidden')
_AFS.tag_object_of(('*', 'to_state', '*'), 'main', 'hidden')
_AFS.tag_subject_of(('*', 'wf_info_for', '*'), 'main', 'attributes')
_AFS.tag_subject_of(('*', 'wf_info_for', '*'), 'muledit', 'attributes')
_AFS.tag_object_of(('*', 'wf_info_for', '*'), 'main', 'hidden')
_AFS.tag_subject_of(('CWPermission', 'require_group', '*'), 'main', 'attributes')
_AFS.tag_subject_of(('CWPermission', 'require_group', '*'), 'muledit', 'attributes')
_AFS.tag_attribute(('CWEType', 'final'), 'main', 'hidden')
_AFS.tag_attribute(('CWRType', 'final'), 'main', 'hidden')
_AFS.tag_attribute(('CWUser', 'firstname'), 'main', 'attributes')
_AFS.tag_attribute(('CWUser', 'surname'), 'main', 'attributes')
_AFS.tag_attribute(('CWUser', 'last_login_time'), 'main', 'metadata')
_AFS.tag_subject_of(('CWUser', 'in_group', '*'), 'main', 'attributes')
_AFS.tag_subject_of(('CWUser', 'in_group', '*'), 'muledit', 'attributes')
_AFS.tag_subject_of(('*', 'primary_email', '*'), 'main', 'relations')
_AFS.tag_subject_of(('*', 'use_email', '*'), 'main', 'inlined')
_AFS.tag_subject_of(('CWRelation', 'relation_type', '*'), 'main', 'inlined')
_AFS.tag_subject_of(('CWRelation', 'from_entity', '*'), 'main', 'inlined')
_AFS.tag_subject_of(('CWRelation', 'to_entity', '*'), 'main', 'inlined')
_AFFK.tag_attribute(('RQLExpression', 'expression'),
{'widget': fw.TextInput})
_AFFK.tag_subject_of(('TrInfo', 'wf_info_for', '*'),
{'widget': fw.HiddenInput})
def registration_callback(vreg):
global etype_relation_field
def etype_relation_field(etype, rtype, role='subject'):
eschema = vreg.schema.eschema(etype)
return AutomaticEntityForm.field_by_name(rtype, role, eschema)
vreg.register_all(globals().values(), __name__)