"""navigation components definition for CubicWeb web client
: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 logilab.mtconverter import xml_escape
from cubicweb.interfaces import IBreadCrumbs
from cubicweb.selectors import (one_line_rset, implements, one_etype_rset,
two_lines_rset, any_rset)
from cubicweb.view import EntityView, Component
# don't use AnyEntity since this may cause bug with isinstance() due to reloading
from cubicweb.entity import Entity
from cubicweb.common import tags, uilib
class BreadCrumbEntityVComponent(Component):
id = 'breadcrumbs'
__select__ = one_line_rset() & implements(IBreadCrumbs)
property_defs = {
_('visible'): dict(type='Boolean', default=True,
help=_('display the component or not')),
}
title = _('contentnavigation_breadcrumbs')
help = _('contentnavigation_breadcrumbs_description')
separator = u' > '
def call(self, view=None, first_separator=True):
entity = self.rset.get_entity(0, 0)
path = entity.breadcrumbs(view)
if path:
self.w(u'<span id="breadcrumbs" class="pathbar">')
if first_separator:
self.w(self.separator)
self.render_breadcrumbs(entity, path)
self.w(u'</span>')
def render_breadcrumbs(self, contextentity, path):
root = path.pop(0)
if isinstance(root, Entity):
self.w(u'<a href="%s">%s</a>' % (self.req.build_url(root.id),
root.dc_type('plural')))
self.w(self.separator)
self.wpath_part(root, contextentity, not path)
for i, parent in enumerate(path):
self.w(self.separator)
self.w(u"\n")
self.wpath_part(parent, contextentity, i == len(path) - 1)
def wpath_part(self, part, contextentity, last=False):
if isinstance(part, Entity):
if last and part.eid == contextentity.eid:
self.w(xml_escape(part.view('breadcrumbtext')))
else:
self.w(part.view('breadcrumbs'))
elif isinstance(part, tuple):
url, title = part
textsize = self.req.property_value('navigation.short-line-size')
self.w(u'<a href="%s">%s</a>' % (
xml_escape(url), xml_escape(uilib.cut(title, textsize))))
else:
textsize = self.req.property_value('navigation.short-line-size')
self.w(uilib.cut(unicode(part), textsize))
class BreadCrumbETypeVComponent(BreadCrumbEntityVComponent):
__select__ = two_lines_rset() & one_etype_rset() & implements(IBreadCrumbs)
def render_breadcrumbs(self, contextentity, path):
# XXX hack: only display etype name or first non entity path part
root = path.pop(0)
if isinstance(root, Entity):
self.w(u'<a href="%s">%s</a>' % (self.req.build_url(root.id),
root.dc_type('plural')))
else:
self.wpath_part(root, contextentity, not path)
class BreadCrumbAnyRSetVComponent(BreadCrumbEntityVComponent):
__select__ = any_rset()
def call(self, view=None, first_separator=True):
self.w(u'<span id="breadcrumbs" class="pathbar">')
if first_separator:
self.w(self.separator)
self.w(self.req._('search'))
self.w(u'</span>')
class BreadCrumbView(EntityView):
id = 'breadcrumbs'
def cell_call(self, row, col):
entity = self.rset.get_entity(row, col)
desc = xml_escape(uilib.cut(entity.dc_description(), 50))
# XXX remember camember : tags.a autoescapes !
self.w(tags.a(entity.view('breadcrumbtext'),
href=entity.absolute_url(), title=desc))
class BreadCrumbTextView(EntityView):
id = 'breadcrumbtext'
def cell_call(self, row, col):
entity = self.rset.get_entity(row, col)
textsize = self.req.property_value('navigation.short-line-size')
self.w(uilib.cut(entity.dc_title(), textsize))