cubicweb: web/views/primary.py@c2bd7922cdaf (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
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2237 diff changeset	13	from logilab.mtconverter import xml_escape
1554 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
2402 321a87654988 strange, how does it work by computing maxrelated once everything is done ? Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2400 diff changeset	42	self.maxrelated = self.req.property_value('navigation.related-limit')
2384 6220783caa4b [primary] cleanup, render_entity -> cell_call Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2381 diff changeset	43	entity = self.complete_entity(row, col)
2400 17b1f0b80fe8 [primary] restore render_entity, as it is a bit too much work to update everything accordingly Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2384 diff changeset	44	self.render_entity(entity)
17b1f0b80fe8 [primary] restore render_entity, as it is a bit too much work to update everything accordingly Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2384 diff changeset	45
17b1f0b80fe8 [primary] restore render_entity, as it is a bit too much work to update everything accordingly Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2384 diff changeset	46	def render_entity(self, entity):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	47	self.render_entity_title(entity)
3849 afba6d304e71 deactivate toolbox until 3.6 Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3845 diff changeset	48	# XXX uncomment this in 3.6
afba6d304e71 deactivate toolbox until 3.6 Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3845 diff changeset	49	#self.render_entity_toolbox(entity)
1491 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%">')
3064 3fbcdf220ce9 fix so that entity's summary appears in main content cell to avoid layout pb Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2655 diff changeset	55	self.render_entity_summary(entity)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	56	self.w(u'<div class="mainInfo">')
2132 d7ae060cd746 move navcontenttop on the top Katia Saurfelt <katia.saurfelt@logilab.fr> parents: 1977 diff changeset	57	self.content_navigation_components('navcontenttop')
2384 6220783caa4b [primary] cleanup, render_entity -> cell_call Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2381 diff changeset	58	self.render_entity_attributes(entity)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	59	if self.main_related_section:
2384 6220783caa4b [primary] cleanup, render_entity -> cell_call Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2381 diff changeset	60	self.render_entity_relations(entity)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	61	self.w(u'</div>')
2237 7e546c3d6ea5 [primary] fix #344249 Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2217 diff changeset	62	# side boxes
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	63	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	64	self.w(u'</td><td>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	65	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	66	if hasattr(self, 'render_side_related'):
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	67	warn('render_side_related is deprecated')
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	68	self.render_side_related(entity, [])
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	69	self.render_side_boxes(boxes)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	70	self.w(u'</div>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	71	self.w(u'</td></tr></table>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	72	self.content_navigation_components('navcontentbottom')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	73
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	74	def content_navigation_components(self, context):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	75	self.w(u'<div class="%s">' % context)
2650 18aec79ec3a3 R [vreg] important refactoring of the vregistry, moving behaviour to end dictionnary (and so leaving room for more flexibility ; keep bw compat ; update api usage in cw Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2402 diff changeset	76	for comp in self.vreg['contentnavigation'].possible_vobjects(
18aec79ec3a3 R [vreg] important refactoring of the vregistry, moving behaviour to end dictionnary (and so leaving room for more flexibility ; keep bw compat ; update api usage in cw Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2402 diff changeset	77	self.req, rset=self.rset, row=self.row, view=self, context=context):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	78	try:
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	79	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	80	except NotImplementedError:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	81	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	82	% comp.__class__, DeprecationWarning)
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	83	comp.render(w=self.w, view=self)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	84	self.w(u'</div>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	85
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	86	def render_entity_title(self, entity):
1720 14c9a0a1aca1 drop content_title sylvain.thenault@logilab.fr parents: 1632 diff changeset	87	"""default implementation return dc_title"""
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2237 diff changeset	88	title = xml_escape(entity.dc_title())
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	89	if title:
3843 200719b9221f display entity type in metadata section instead of default title of primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3809 diff changeset	90	self.w(u'<h1>%s</h1>' % title)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	91
3845 596044fb7bc5 introduce render_entity_toolbox on default primary view to display components in the ctxtoolbar context, such as pdf icon, notification registration (nosylist)... Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3844 diff changeset	92	def render_entity_toolbox(self, entity):
596044fb7bc5 introduce render_entity_toolbox on default primary view to display components in the ctxtoolbar context, such as pdf icon, notification registration (nosylist)... Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3844 diff changeset	93	self.content_navigation_components('ctxtoolbar')
596044fb7bc5 introduce render_entity_toolbox on default primary view to display components in the ctxtoolbar context, such as pdf icon, notification registration (nosylist)... Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3844 diff changeset	94
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	95	def render_entity_metadata(self, entity):
3844 c2625c512085 stop calling render_entity_metadata in primary view, provides a Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3843 diff changeset	96	# XXX deprecated
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	97	entity.view('metadata', w=self.w)
3064 3fbcdf220ce9 fix so that entity's summary appears in main content cell to avoid layout pb Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2655 diff changeset	98
3fbcdf220ce9 fix so that entity's summary appears in main content cell to avoid layout pb Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2655 diff changeset	99	def render_entity_summary(self, entity):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	100	summary = self.summary(entity) # deprecate summary?
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	101	if summary:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	102	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	103
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	104	def summary(self, entity):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	105	"""default implementation return an empty string"""
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	106	return u''
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	107
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	108	def render_entity_attributes(self, entity, siderelations=None):
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	109	entity_attributes = self._section_def(entity, 'attributes')
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	110	if not entity_attributes:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	111	return
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	112	self.w(u'<table>')
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	113	for rschema, tschemas, role, dispctrl in entity_attributes:
2361 8f00836580f1 [reledit] do NOT propose to edit composite-related entities (unlinking would destroy the other side) Aurelien Campeas <aurelien.campeas@logilab.fr> parents: 2312 diff changeset	114	vid = dispctrl.get('vid', 'reledit')
3689 deb13e88e037 follow yams 0.25 api changes to improve performance Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3681 diff changeset	115	if rschema.final or vid == 'reledit':
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	116	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	117	else:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	118	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	119	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	120	value = self.view(vid, rset)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	121	else:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	122	value = None
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	123	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	124	continue
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	125	self._render_attribute(rschema, value, role=role, table=True)
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	126	self.w(u'</table>')
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	127
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	128	def render_entity_relations(self, entity, siderelations=None):
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	129	for rschema, tschemas, role, dispctrl in self._section_def(entity, 'relations'):
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	130	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	131	if rset:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	132	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	133	self.show_rel_label)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	134
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	135	def render_side_boxes(self, boxes):
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	136	"""display side related relations:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	137	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	138	"""
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	139	for box in boxes:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	140	if isinstance(box, tuple):
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	141	label, rset, vid = box
1885 c2011d238e98 replace sideRelated with sideBox Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 1752 diff changeset	142	self.w(u'<div class="sideBox">')
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	143	self.wview(vid, rset, title=label)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	144	self.w(u'</div>')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	145	else:
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	146	try:
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	147	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	148	except NotImplementedError:
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	149	# 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	150	# .call() and not cell_call()
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1721 diff changeset	151	box.render(w=self.w)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	152
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	153	def _prepare_side_boxes(self, entity):
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	154	sideboxes = []
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	155	for rschema, tschemas, role, dispctrl in self._section_def(entity, 'sideboxes'):
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	156	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	157	if not rset:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	158	continue
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	159	label = display_name(self.req, rschema.type, role)
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	160	vid = dispctrl.get('vid', 'sidebox')
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	161	sideboxes.append( (label, rset, vid) )
2650 18aec79ec3a3 R [vreg] important refactoring of the vregistry, moving behaviour to end dictionnary (and so leaving room for more flexibility ; keep bw compat ; update api usage in cw Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2402 diff changeset	162	sideboxes += self.vreg['boxes'].possible_vobjects(
18aec79ec3a3 R [vreg] important refactoring of the vregistry, moving behaviour to end dictionnary (and so leaving room for more flexibility ; keep bw compat ; update api usage in cw Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2402 diff changeset	163	self.req, rset=self.rset, row=self.row, view=self,
18aec79ec3a3 R [vreg] important refactoring of the vregistry, moving behaviour to end dictionnary (and so leaving room for more flexibility ; keep bw compat ; update api usage in cw Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2402 diff changeset	164	context='incontext')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	165	return sideboxes
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	166
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	167	def _section_def(self, entity, where):
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	168	rdefs = []
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	169	eschema = entity.e_schema
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	170	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	171	matchtschemas = []
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	172	for tschema in tschemas:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	173	section = self.rsection.etype_get(eschema, rschema, role,
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	174	tschema)
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	175	if section == where:
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	176	matchtschemas.append(tschema)
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	177	if matchtschemas:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	178	# XXX pick the latest dispctrl
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	179	dispctrl = self.display_ctrl.etype_get(eschema, rschema, role,
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	180	matchtschemas[-1])
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	181
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	182	rdefs.append( (rschema, matchtschemas, role, dispctrl) )
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	183	return sorted(rdefs, key=lambda x: x[-1]['order'])
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	184
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	185	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	186	try:
3681 cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	187	dispctrl.setdefault('limit', self.maxrelated)
cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	188	rset = entity.related(rschema.type, role, limit=dispctrl['limit']+1)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	189	except Unauthorized:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	190	return
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	191	if 'filter' in dispctrl:
78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	192	rset = dispctrl['filter'](rset)
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	193	return rset
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	194
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	195	def _render_relation(self, rset, dispctrl, defaultvid, showlabel):
1583 1d6d0ea1cda1 needs unicode string sylvain.thenault@logilab.fr parents: 1558 diff changeset	196	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	197	if showlabel:
1739 78b0819162a8 final rtag api sylvain.thenault@logilab.fr parents: 1726 diff changeset	198	self.w(u'<h4>%s</h4>' % self.req._(dispctrl['label']))
3705 5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	199	self.wview(dispctrl.get('vid', defaultvid), rset,
5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	200	initargs={'dispctrl': dispctrl})
1583 1d6d0ea1cda1 needs unicode string sylvain.thenault@logilab.fr parents: 1558 diff changeset	201	self.w(u'</div>')
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	202
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	203	def _render_attribute(self, rschema, value, role='subject', table=False):
3689 deb13e88e037 follow yams 0.25 api changes to improve performance Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3681 diff changeset	204	if rschema.final:
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	205	show_label = self.show_attr_label
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	206	else:
1554 3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup) sylvain.thenault@logilab.fr parents: 1516 diff changeset	207	show_label = self.show_rel_label
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	208	label = display_name(self.req, rschema.type, role)
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3778 diff changeset	209	self.field(label, value, show_label=show_label, tr=False, table=table)
1491 742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module sylvain.thenault@logilab.fr parents: diff changeset	210
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	211
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	212	class RelatedView(EntityView):
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	213	id = 'autolimited'
3681 cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	214
3705 5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	215	def call(self, **kwargs):
3681 cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	216	# nb: rset retreived using entity.related with limit + 1 if any
cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	217	# because of that, we known that rset.printable_rql() will return
cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	218	# rql with no limit set anyway (since it's handled manually)
3705 5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	219	if 'dispctrl' in self.extra_kwargs:
5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	220	limit = self.extra_kwargs['dispctrl'].get('limit')
5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	221	else:
5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3689 diff changeset	222	limit = None
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	223	# if not too many entities, show them all in a list
3681 cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	224	if limit is None or self.rset.rowcount <= limit:
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	225	if self.rset.rowcount == 1:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	226	self.wview('incontext', self.rset, row=0)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	227	elif 1 < self.rset.rowcount <= 5:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	228	self.wview('csv', self.rset)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	229	else:
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	230	self.w(u'<div>')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	231	self.wview('simplelist', self.rset)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	232	self.w(u'</div>')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	233	# else show links to display related entities
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	234	else:
3778 fd5449479584 so bad tests hasn't find that one... Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3705 diff changeset	235	rql = self.rset.printable_rql()
3681 cdbe4aac1198 fix max-related of related entities handling in primary view Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3071 diff changeset	236	self.rset.limit(limit) # remove extra entity
1516 288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	237	self.w(u'<div>')
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	238	self.wview('simplelist', self.rset)
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	239	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	240	self.req._('see them all')))
288d55a7c5e2 refactor side boxes handling of primary view sylvain.thenault@logilab.fr parents: 1491 diff changeset	241	self.w(u'</div>')
2652 3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	242
3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	243	## default primary ui configuration ###########################################
3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	244
3875 c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	245	_pvs = uicfg.primaryview_section
2652 3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	246	for rtype in ('eid', 'creation_date', 'modification_date', 'cwuri',
3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	247	'is', 'is_instance_of', 'identity',
2920 64322aa83a1d start a new workflow engine Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2655 diff changeset	248	'owned_by', 'created_by', 'in_state',
64322aa83a1d start a new workflow engine Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2655 diff changeset	249	'wf_info_for', 'by_transition', 'from_state', 'to_state',
64322aa83a1d start a new workflow engine Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2655 diff changeset	250	'require_permission', 'from_entity', 'to_entity',
2652 3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	251	'see_also'):
3875 c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	252	_pvs.tag_subject_of(('', rtype, ''), 'hidden')
c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	253	_pvs.tag_object_of(('', rtype, ''), 'hidden')
c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	254
c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	255	_pvs.tag_subject_of(('', 'use_email', ''), 'attributes')
c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	256	_pvs.tag_subject_of(('', 'primary_email', ''), 'hidden')
2652 3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	257
3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	258	for attr in ('name', 'final'):
3875 c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	259	_pvs.tag_attribute(('CWEType', attr), 'hidden')
2652 3753f3a07ca1 [refactoring] moved rtags specification in web/views Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 2402 diff changeset	260	for attr in ('name', 'final', 'symetric', 'inlined'):
3875 c2bd7922cdaf use shorter notation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3849 diff changeset	261	_pvs.tag_attribute(('CWRType', attr), 'hidden')

author	Sylvain Thénault <sylvain.thenault@logilab.fr>
	Wed, 18 Nov 2009 09:16:00 +0100
branch	stable
changeset 3875	c2bd7922cdaf
parent 3849	afba6d304e71
child 3890	d7a270f50f54
child 3970	e4ad7663610b
permissions	-rw-r--r--