add a fourth item to 'view box' defintion, dispctrl, so that
we can later globally sort all boxes instead of having view
boxes before component boxes.
'view' boxes order is configured through uicfg.primaryview_display_ctrl,
'component' boxes order through the cwproperty system.
"""The default primary view
:organization: Logilab
:copyright: 2001-2009 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 logilab.mtconverter import xml_escape
from cubicweb import Unauthorized
from cubicweb.selectors import match_kwargs
from cubicweb.view import EntityView
from cubicweb.schema import display_name
from cubicweb.web import uicfg
class PrimaryView(EntityView):
"""the full view of an non final entity"""
id = 'primary'
title = _('primary')
show_attr_label = True
show_rel_label = True
skip_none = True
rsection = uicfg.primaryview_section
display_ctrl = uicfg.primaryview_display_ctrl
main_related_section = True
def html_headers(self):
"""return a list of html headers (eg something to be inserted between
<head> and </head> of the returned page
by default primary views are indexed
"""
return []
def cell_call(self, row, col):
self.row = row
self.maxrelated = self.req.property_value('navigation.related-limit')
entity = self.complete_entity(row, col)
self.render_entity(entity)
def render_entity(self, entity):
self.render_entity_title(entity)
# XXX uncomment this in 3.6
#self.render_entity_toolbox(entity)
# entity's attributes and relations, excluding meta data
# if the entity isn't meta itself
if self.is_primary():
boxes = self._prepare_side_boxes(entity)
else:
boxes = None
if boxes or hasattr(self, 'render_side_related'):
self.w(u'<table width="100%"><tr><td style="width: 75%">')
self.render_entity_summary(entity)
self.w(u'<div class="mainInfo">')
self.content_navigation_components('navcontenttop')
self.render_entity_attributes(entity)
if self.main_related_section:
self.render_entity_relations(entity)
self.w(u'</div>')
# side boxes
if boxes or hasattr(self, 'render_side_related'):
self.w(u'</td><td>')
self.w(u'<div class="primaryRight">')
if hasattr(self, 'render_side_related'):
warn('render_side_related is deprecated')
self.render_side_related(entity, [])
self.render_side_boxes(boxes)
self.w(u'</div>')
self.w(u'</td></tr></table>')
self.content_navigation_components('navcontentbottom')
def content_navigation_components(self, context):
self.w(u'<div class="%s">' % context)
for comp in self.vreg['contentnavigation'].possible_vobjects(
self.req, rset=self.rset, row=self.row, view=self, context=context):
try:
comp.render(w=self.w, row=self.row, view=self)
except NotImplementedError:
warn('component %s doesnt implement cell_call, please update'
% comp.__class__, DeprecationWarning)
comp.render(w=self.w, view=self)
self.w(u'</div>')
def render_entity_title(self, entity):
"""default implementation return dc_title"""
title = xml_escape(entity.dc_title())
if title:
if self.is_primary():
self.w(u'<h1>%s</h1>' % title)
else:
atitle = self.req._('follow this link for more information on this %s') % entity.dc_type()
self.w(u'<h4><a href="%s" title="%s">%s</a></h4>'
% (entity.absolute_url(), atitle, title))
def render_entity_toolbox(self, entity):
self.content_navigation_components('ctxtoolbar')
def render_entity_metadata(self, entity):
# XXX deprecated
entity.view('metadata', w=self.w)
def render_entity_summary(self, entity):
summary = self.summary(entity) # deprecate summary?
if summary:
self.w(u'<div class="summary">%s</div>' % summary)
def summary(self, entity):
"""default implementation return an empty string"""
return u''
def render_entity_attributes(self, entity, siderelations=None):
entity_attributes = self._section_def(entity, 'attributes')
if not entity_attributes:
return
self.w(u'<table>')
for rschema, tschemas, role, dispctrl in entity_attributes:
vid = dispctrl.get('vid', 'reledit')
if rschema.final or vid == 'reledit':
value = entity.view(vid, rtype=rschema.type, role=role)
else:
rset = self._relation_rset(entity, rschema, role, dispctrl)
if rset:
value = self.view(vid, rset)
else:
value = None
if self.skip_none and (value is None or value == ''):
continue
try:
self._render_attribute(dispctrl, rschema, value,
role=role, table=True)
except TypeError:
warn('[3.6] _render_attribute prototype has changed, '
'please update %s' % self.__class___, DeprecationWarning)
self._render_attribute(rschema, value, role=role, table=True)
self.w(u'</table>')
def render_entity_relations(self, entity, siderelations=None):
for rschema, tschemas, role, dispctrl in self._section_def(entity, 'relations'):
rset = self._relation_rset(entity, rschema, role, dispctrl)
if rset:
try:
self._render_relation(dispctrl, rset, 'autolimited')
except TypeError:
warn('[3.6] _render_relation prototype has changed, '
'please update %s' % self.__class__, DeprecationWarning)
self._render_relation(rset, dispctrl, 'autolimited',
self.show_rel_label)
def render_side_boxes(self, boxes):
"""display side related relations:
non-meta in a first step, meta in a second step
"""
for box in boxes:
if isinstance(box, tuple):
try:
label, rset, vid, dispctrl = box
except ValueError:
warn('box views should now be defined as a 4-uple (label, rset, vid, dispctrl), '
'please update %s' % self.__class__.__name__,
DeprecationWarning)
label, rset, vid = box
self.w(u'<div class="sideBox">')
self.wview(vid, rset, title=label)
self.w(u'</div>')
else:
try:
box.render(w=self.w, row=self.row)
except NotImplementedError:
# much probably a context insensitive box, which only implements
# .call() and not cell_call()
box.render(w=self.w)
def _prepare_side_boxes(self, entity):
sideboxes = []
for rschema, tschemas, role, dispctrl in self._section_def(entity, 'sideboxes'):
rset = self._relation_rset(entity, rschema, role, dispctrl)
if not rset:
continue
label = display_name(self.req, rschema.type, role)
vid = dispctrl.get('vid', 'sidebox')
sideboxes.append( (label, rset, vid, dispctrl) )
sideboxes += self.vreg['boxes'].possible_vobjects(
self.req, rset=self.rset, row=self.row, view=self,
context='incontext')
# XXX since we've two sorted list, it may be worth using bisect
def get_order(x):
if isinstance(x, tuple):
# x is a view box (label, rset, vid, dispctrl)
# default to 1000 so view boxes occurs after component boxes
return x[-1].get('order', 1000)
# x is a component box
return x.propval('order')
return sorted(sideboxes, key=get_order)
def _section_def(self, entity, where):
rdefs = []
eschema = entity.e_schema
for rschema, tschemas, role in eschema.relation_definitions(True):
matchtschemas = []
for tschema in tschemas:
section = self.rsection.etype_get(eschema, rschema, role,
tschema)
if section == where:
matchtschemas.append(tschema)
if matchtschemas:
# XXX pick the latest dispctrl
dispctrl = self.display_ctrl.etype_get(eschema, rschema, role,
matchtschemas[-1])
rdefs.append( (rschema, matchtschemas, role, dispctrl) )
return sorted(rdefs, key=lambda x: x[-1]['order'])
def _relation_rset(self, entity, rschema, role, dispctrl):
try:
dispctrl.setdefault('limit', self.maxrelated)
rset = entity.related(rschema.type, role, limit=dispctrl['limit']+1)
except Unauthorized:
return
if 'filter' in dispctrl:
rset = dispctrl['filter'](rset)
return rset
def _render_relation(self, dispctrl, rset, defaultvid, showlabel):
self.w(u'<div class="section">')
if dispctrl.get('showlabel', self.show_rel_label):
self.w(u'<h4>%s</h4>' % self.req._(dispctrl['label']))
self.wview(dispctrl.get('vid', defaultvid), rset,
initargs={'dispctrl': dispctrl})
self.w(u'</div>')
def _render_attribute(self, dispctrl, rschema, value,
role='subject', table=False):
if rschema.final:
showlabel = dispctrl.get('showlabel', self.show_attr_label)
else:
showlabel = dispctrl.get('showlabel', self.show_rel_label)
if dispctrl.get('label'):
label = self.req._(dispctrl.get('label'))
else:
label = display_name(self.req, rschema.type, role)
self.field(label, value, show_label=showlabel, tr=False, table=table)
class RelatedView(EntityView):
id = 'autolimited'
def call(self, **kwargs):
# nb: rset retreived using entity.related with limit + 1 if any
# because of that, we known that rset.printable_rql() will return
# rql with no limit set anyway (since it's handled manually)
if 'dispctrl' in self.extra_kwargs:
limit = self.extra_kwargs['dispctrl'].get('limit')
else:
limit = None
# if not too many entities, show them all in a list
if limit is None or self.rset.rowcount <= limit:
if self.rset.rowcount == 1:
self.wview('incontext', self.rset, row=0)
elif 1 < self.rset.rowcount <= 5:
self.wview('csv', self.rset)
else:
self.w(u'<div>')
self.wview('simplelist', self.rset)
self.w(u'</div>')
# else show links to display related entities
else:
rql = self.rset.printable_rql()
self.rset.limit(limit) # remove extra entity
self.w(u'<div>')
self.wview('simplelist', self.rset)
self.w(u'[<a href="%s">%s</a>]' % (self.build_url(rql=rql),
self.req._('see them all')))
self.w(u'</div>')
class URLAttributeView(EntityView):
"""use this view for attributes whose value is an url and that you want
to display as clickable link
"""
id = 'urlattr'
__select__ = EntityView.__select__ & match_kwargs('rtype')
def cell_call(self, row, col, rtype, **kwargs):
entity = self.rset.get_entity(row, col)
url = entity.printable_value(rtype)
if url:
self.w(u'<a href="%s">%s</a>' % (url, url))
## default primary ui configuration ###########################################
_pvs = uicfg.primaryview_section
for rtype in ('eid', 'creation_date', 'modification_date', 'cwuri',
'is', 'is_instance_of', 'identity',
'owned_by', 'created_by', 'in_state',
'wf_info_for', 'by_transition', 'from_state', 'to_state',
'require_permission', 'from_entity', 'to_entity',
'see_also'):
_pvs.tag_subject_of(('*', rtype, '*'), 'hidden')
_pvs.tag_object_of(('*', rtype, '*'), 'hidden')
_pvs.tag_subject_of(('*', 'use_email', '*'), 'attributes')
_pvs.tag_subject_of(('*', 'primary_email', '*'), 'hidden')
for attr in ('name', 'final'):
_pvs.tag_attribute(('CWEType', attr), 'hidden')
for attr in ('name', 'final', 'symetric', 'inlined'):
_pvs.tag_attribute(('CWRType', attr), 'hidden')