cubicweb: web/views/primary.py@0b915d6f4264 (annotated)

1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	1	"""The default primary view
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	2
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	3	:organization: Logilab
1977 606923dff11b big bunch of copyright / docstring update Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 1885 diff changeset	4	:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	5	:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
1977 606923dff11b big bunch of copyright / docstring update Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 1885 diff changeset	6	:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	7	"""
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	8	__docformat__ = "restructuredtext en"
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	9	_ = unicode
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	10
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	11	from warnings import warn
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	12
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	13	from logilab.mtconverter import html_escape
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	14
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	15	from cubicweb import Unauthorized
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	16	from cubicweb.view import EntityView
2217 3a8cee8f8778 explicit display_name import Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2190 diff changeset	17	from cubicweb.schema import display_name
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	18	from cubicweb.web import uicfg
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	19
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	20
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	21	class PrimaryView(EntityView):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	22	"""the full view of an non final entity"""
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	23	id = 'primary'
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	24	title = _('primary')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	25	show_attr_label = True
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	26	show_rel_label = True
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	27	skip_none = True
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	28	rsection = uicfg.primaryview_section
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	29	display_ctrl = uicfg.primaryview_display_ctrl
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	30	main_related_section = True
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	31
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	32	def html_headers(self):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	33	"""return a list of html headers (eg something to be inserted between
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	34	<head> and </head> of the returned page
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	35
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	36	by default primary views are indexed
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	37	"""
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	38	return []
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	39
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	40	def cell_call(self, row, col):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	41	self.row = row
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	42	# XXX move render_entity implementation here
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	43	self.render_entity(self.complete_entity(row, col))
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	44	self.maxrelated = self.req.property_value('navigation.related-limit')
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	45
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	46	def render_entity(self, entity):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	47	"""return html to display the given entity"""
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	48	self.render_entity_title(entity)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	49	self.render_entity_metadata(entity)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	50	# entity's attributes and relations, excluding meta data
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	51	# if the entity isn't meta itself
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	52	boxes = self._prepare_side_boxes(entity)
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	53	if boxes or hasattr(self, 'render_side_related'):
1558 f63d090eb34a some primary view fixes, need more (eg reledit doesn't work for non final relation sylvain.thenault@logilab.fr parents: 1554 diff changeset	54	self.w(u'<table width="100%"><tr><td style="width: 75%">')
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	55	self.w(u'<div class="mainInfo">')
2132 d7ae060cd746 move navcontenttop on the top Katia Saurfelt <katia.saurfelt@logilab.fr> parents: 1977 diff changeset	56	self.content_navigation_components('navcontenttop')
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	57	try:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	58	self.render_entity_attributes(entity)
2171 b0c564c86a4b work around the risk of catching an unrelated TypeError Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2132 diff changeset	59	except TypeError, e: # XXX bw compat
b0c564c86a4b work around the risk of catching an unrelated TypeError Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2132 diff changeset	60	if 'render_entity' not in e.args[0]:
b0c564c86a4b work around the risk of catching an unrelated TypeError Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2132 diff changeset	61	raise
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	62	warn('siderelations argument of render_entity_attributes is '
1558 f63d090eb34a some primary view fixes, need more (eg reledit doesn't work for non final relation sylvain.thenault@logilab.fr parents: 1554 diff changeset	63	'deprecated (%s)' % self.__class__)
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	64	self.render_entity_attributes(entity, [])
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	65	if self.main_related_section:
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	66	try:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	67	self.render_entity_relations(entity)
2177 3454adb6164a ooops Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2171 diff changeset	68	except TypeError, e: # XXX bw compat
2171 b0c564c86a4b work around the risk of catching an unrelated TypeError Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2132 diff changeset	69	if 'render_entity' not in e.args[0]:
b0c564c86a4b work around the risk of catching an unrelated TypeError Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2132 diff changeset	70	raise
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	71	warn('siderelations argument of render_entity_relations is '
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	72	'deprecated')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	73	self.render_entity_relations(entity, [])
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	74	self.w(u'</div>')
2237 7e546c3d6ea5 [primary] fix #344249 Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2217 diff changeset	75	# side boxes
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	76	if boxes or hasattr(self, 'render_side_related'):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	77	self.w(u'</td><td>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	78	self.w(u'<div class="primaryRight">')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	79	if hasattr(self, 'render_side_related'):
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	80	warn('render_side_related is deprecated')
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	81	self.render_side_related(entity, [])
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	82	self.render_side_boxes(boxes)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	83	self.w(u'</div>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	84	self.w(u'</td></tr></table>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	85	self.content_navigation_components('navcontentbottom')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	86
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	87
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	88	def content_navigation_components(self, context):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	89	self.w(u'<div class="%s">' % context)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	90	for comp in self.vreg.possible_vobjects('contentnavigation',
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	91	self.req, self.rset, row=self.row,
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	92	view=self, context=context):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	93	try:
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	94	comp.render(w=self.w, row=self.row, view=self)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	95	except NotImplementedError:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	96	warn('component %s doesnt implement cell_call, please update'
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	97	% comp.__class__, DeprecationWarning)
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	98	comp.render(w=self.w, view=self)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	99	self.w(u'</div>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	100
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	101	def render_entity_title(self, entity):
1720 14c9a0a1aca1 drop content_title sylvain.thenault@logilab.fr parents: 1632 diff changeset	102	"""default implementation return dc_title"""
14c9a0a1aca1 drop content_title sylvain.thenault@logilab.fr parents: 1632 diff changeset	103	title = html_escape(entity.dc_title())
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	104	if title:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	105	self.w(u'<h1><span class="etype">%s</span> %s</h1>'
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	106	% (entity.dc_type().capitalize(), title))
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	107
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	108	def render_entity_metadata(self, entity):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	109	entity.view('metadata', w=self.w)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	110	summary = self.summary(entity) # deprecate summary?
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	111	if summary:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	112	self.w(u'<div class="summary">%s</div>' % summary)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	113
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	114	def summary(self, entity):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	115	"""default implementation return an empty string"""
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	116	return u''
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	117
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	118	def render_entity_attributes(self, entity, siderelations=None):
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	119	for rschema, tschemas, role, dispctrl in self._section_def(entity, 'attributes'):
2189 08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	120	# don't use reledit as default vid for composite relation
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	121	if rschema.is_final():
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	122	defaultvid = 'reledit'
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	123	# XXX use entity.e_schema.role_rproperty(role, rschema, 'composite', tschemas[0]) once yams > 0.23.0 is out
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	124	elif role == 'subject' and \
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	125	rschema.rproperty(entity.e_schema, tschemas[0], 'composite'):
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	126	defaultvid = 'csv'
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	127	elif role == 'object' and \
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	128	rschema.rproperty(tschemas[0], entity.e_schema, 'composite'):
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	129	defaultvid = 'csv'
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	130	else:
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	131	defaultvid = 'reledit'
08c66a83c3ca don't use reledit for composite relations Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2132 diff changeset	132	vid = dispctrl.get('vid', defaultvid)
1558 f63d090eb34a some primary view fixes, need more (eg reledit doesn't work for non final relation sylvain.thenault@logilab.fr parents: 1554 diff changeset	133	if rschema.is_final() or vid == 'reledit':
f63d090eb34a some primary view fixes, need more (eg reledit doesn't work for non final relation sylvain.thenault@logilab.fr parents: 1554 diff changeset	134	value = entity.view(vid, rtype=rschema.type, role=role)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	135	else:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	136	rset = self._relation_rset(entity, rschema, role, dispctrl)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	137	if rset:
1558 f63d090eb34a some primary view fixes, need more (eg reledit doesn't work for non final relation sylvain.thenault@logilab.fr parents: 1554 diff changeset	138	value = self.view(vid, rset)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	139	else:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	140	value = None
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	141	if self.skip_none and (value is None or value == ''):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	142	continue
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	143	self._render_attribute(rschema, value)
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	144
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	145	def render_entity_relations(self, entity, siderelations=None):
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	146	for rschema, tschemas, role, dispctrl in self._section_def(entity, 'relations'):
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	147	rset = self._relation_rset(entity, rschema, role, dispctrl)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	148	if rset:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	149	self._render_relation(rset, dispctrl, 'autolimited',
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	150	self.show_rel_label)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	151
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	152	def render_side_boxes(self, boxes):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	153	"""display side related relations:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	154	non-meta in a first step, meta in a second step
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	155	"""
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	156	for box in boxes:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	157	if isinstance(box, tuple):
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	158	label, rset, vid = box
1885 c2011d238e98 replace sideRelated with sideBox Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 1752 diff changeset	159	self.w(u'<div class="sideBox">')
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	160	self.wview(vid, rset, title=label)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	161	self.w(u'</div>')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	162	else:
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	163	try:
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	164	box.render(w=self.w, row=self.row)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	165	except NotImplementedError:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	166	# much probably a context insensitive box, which only implements
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	167	# .call() and not cell_call()
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	168	box.render(w=self.w)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	169
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	170	def _prepare_side_boxes(self, entity):
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	171	sideboxes = []
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	172	for rschema, tschemas, role, dispctrl in self._section_def(entity, 'sideboxes'):
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	173	rset = self._relation_rset(entity, rschema, role, dispctrl)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	174	if not rset:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	175	continue
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	176	label = display_name(self.req, rschema.type, role)
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	177	vid = dispctrl.get('vid', 'sidebox')
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	178	sideboxes.append( (label, rset, vid) )
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	179	sideboxes += self.vreg.possible_vobjects('boxes', self.req, self.rset,
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	180	row=self.row, view=self,
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	181	context='incontext')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	182	return sideboxes
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	183
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	184	def _section_def(self, entity, where):
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	185	rdefs = []
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	186	eschema = entity.e_schema
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	187	for rschema, tschemas, role in eschema.relation_definitions(True):
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	188	matchtschemas = []
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	189	for tschema in tschemas:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	190	section = self.rsection.etype_get(eschema, rschema, role,
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	191	tschema)
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	192	if section == where:
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	193	matchtschemas.append(tschema)
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	194	if matchtschemas:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	195	# XXX pick the latest dispctrl
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	196	dispctrl = self.display_ctrl.etype_get(eschema, rschema, role,
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	197	matchtschemas[-1])
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	198
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	199	rdefs.append( (rschema, matchtschemas, role, dispctrl) )
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	200	return sorted(rdefs, key=lambda x: x[-1]['order'])
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	201
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	202	def _relation_rset(self, entity, rschema, role, dispctrl):
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	203	try:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	204	if dispctrl.get('limit'):
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	205	rset = entity.related(rschema.type, role,
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	206	limit=self.maxrelated+1)
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	207	else:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	208	rset = entity.related(rschema.type, role)
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	209	except Unauthorized:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	210	return
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	211	if 'filter' in dispctrl:
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	212	rset = dispctrl['filter'](rset)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	213	return rset
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	214
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	215	def _render_relation(self, rset, dispctrl, defaultvid, showlabel):
1583 1d6d0ea1cda1 needs unicode string sylvain.thenault@logilab.fr parents: 1558 diff changeset	216	self.w(u'<div class="section">')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	217	if showlabel:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	218	self.w(u'<h4>%s</h4>' % self.req._(dispctrl['label']))
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	219	self.wview(dispctrl.get('vid', defaultvid), rset)
1583 1d6d0ea1cda1 needs unicode string sylvain.thenault@logilab.fr parents: 1558 diff changeset	220	self.w(u'</div>')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	221
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	222	def _render_attribute(self, rschema, value, role='subject'):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	223	if rschema.is_final():
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	224	show_label = self.show_attr_label
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	225	else:
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	226	show_label = self.show_rel_label
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	227	label = display_name(self.req, rschema.type, role)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	228	self.field(label, value, show_label=show_label, tr=False)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	229
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	230
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	231	class RelatedView(EntityView):
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	232	id = 'autolimited'
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	233	def call(self, title=None, **kwargs):
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	234	# if not too many entities, show them all in a list
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	235	maxrelated = self.req.property_value('navigation.related-limit')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	236	if title:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	237	self.w(u'<div class="title"><span>%s</span></div>' % title)
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	238	if self.rset.rowcount <= maxrelated:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	239	if self.rset.rowcount == 1:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	240	self.wview('incontext', self.rset, row=0)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	241	elif 1 < self.rset.rowcount <= 5:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	242	self.wview('csv', self.rset)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	243	else:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	244	self.w(u'<div>')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	245	self.wview('simplelist', self.rset)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	246	self.w(u'</div>')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	247	# else show links to display related entities
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	248	else:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	249	rql = self.rset.printable_rql()
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	250	self.rset.limit(maxrelated)
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	251	self.w(u'<div>')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	252	self.wview('simplelist', self.rset)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	253	self.w(u'[<a href="%s">%s</a>]' % (self.build_url(rql=rql),
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	254	self.req._('see them all')))
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	255	self.w(u'</div>')

author	Sylvain Thénault <sylvain.thenault@logilab.fr>
	Fri, 03 Jul 2009 17:57:33 +0200
branch	stable
changeset 2256	0b915d6f4264
parent 2237	7e546c3d6ea5
child 2293	7ded2a1416e4
child 2312	af4d8f75c5db
permissions	-rw-r--r--