* search box

Additional boxes (disabled by default):

* possible views box

from logilab.common.deprecation import class_deprecated

from cubicweb import Unauthorized

from cubicweb.selectors import (match_user_groups, match_context, match_kwargs,

                                non_final_entity, nonempty_rset)

from cubicweb.web import box, htmlwidgets

# XXX bw compat, some cubes import this class from here

BoxTemplate = box.BoxTemplate

BoxHtml = htmlwidgets.BoxHtml

class EditBox(box.Box): # XXX rename to ActionsBox

    __select__ = box.Box.__select__ & non_final_entity()

    contextual = True

    def init_rendering(self):

        super(EditBox, self).init_rendering()

                                                            **self.cw_extra_kwargs)

        for category, defaultmenu in (('mainactions', self),

        if not self.items and len(self._menus_by_id) == 1 and not other_menu.is_empty():

            self.items = other_menu.items

            for submenu in self._menus_in_order:

                self.add_submenu(self, submenu)

        if not self.items:

            raise box.EmptyComponent()

    def render_title(self, w):

        title = self._cw._(self.title)

        if self.cw_rset:

            etypes = self.cw_rset.column_types(0)

            if len(etypes) == 1:

                plural = self.cw_rset.rowcount > 1 and 'plural' or ''

                etypelabel = display_name(self._cw, iter(etypes).next(), plural)

                title = u'%s - %s' % (title, etypelabel.lower())

        w(title)

    def render_body(self, w):

        self.render_items(w)

            self._menus_by_id[id] = menu = htmlwidgets.BoxMenu(title)

                # XXX iirk

                if hasattr(boxlink, 'label'):

                    boxlink.label = u'%s %s' % (submenu.label_prefix, boxlink.label)

                else:

                    submenu.items[0] = u'%s %s' % (submenu.label_prefix, boxlink)

            box.append(xml_escape(submenu.label))

class SearchBox(box.Box):

 </td></tr></table>

 </form>"""

    def render_title(self, w):

        w(u"""<span onclick="javascript: toggleVisibility('rqlinput')">%s</span>"""

          % self._cw._(self.title))

    def render_body(self, w):

        if self._cw.form.pop('__fromsearchbox', None):

            rql = self._cw.form.get('rql', '')

        w(self.formdef % (self._cw.build_url('view'), self._cw.next_tabindex(),

                          xml_escape(rql), self._cw.next_tabindex()))

class PossibleViewsBox(box.Box):

    def init_rendering(self):

        self.views = [v for v in self._cw.vreg['views'].possible_views(self._cw,

                                                                       rset=self.cw_rset)

                      if v.category != 'startupview']

        if not self.views:

            raise box.EmptyComponent()

        self.items = []

    def render_body(self, w):

        for category, views in box.sort_by_category(self.views):

            menu = htmlwidgets.BoxMenu(category)

            self.append(menu)

        self.render_items(w)

class StartupViewsBox(PossibleViewsBox):

    def init_rendering(self):

        self.views = [v for v in self._cw.vreg['views'].possible_views(self._cw)

                      if v.category == 'startupview']

        if not self.views:

            raise box.EmptyComponent()

        self.items = []

class RsetBox(box.Box):

    """helper view class to display an rset in a sidebox"""

    __select__ = nonempty_rset() & match_kwargs('title', 'vid')

    __regid__ = 'rsetbox'

    cw_property_defs = {}

    context = 'incontext'

    @property

    def domid(self):

        return super(RsetBox, self).domid + unicode(abs(id(self)))

    def render_title(self, w):

        w(self.cw_extra_kwargs['title'])

    def render_body(self, w):

        self._cw.view(self.cw_extra_kwargs['vid'], self.cw_rset, w=w)

 # helper classes ##############################################################

    __metaclass__ = class_deprecated

    __deprecation_warning__ = 'SideBoxView is deprecated, use RsetBox instead'

    def call(self, **kwargs):

        box = self._cw.vreg['boxes'].select('rsetbox', self._cw, rset=self.cw_rset,

                                            vid='autolimited', title=title,

                                            **self.cw_extra_kwargs)

        box.render(self.w)

class ContextualBoxLayout(box.Layout):

    __select__ = match_context('incontext', 'left', 'right') & box.contextual()

    # predefined class in cubicweb.css: contextualBox | contextFreeBox

    # XXX: navigationBox | actionBox

    cssclass = 'contextualBox'

    def render(self, w):

        view = self.cw_extra_kwargs['view']

        try:

            view.init_rendering()

        except Unauthorized, ex:

            self.warning("can't render %s: %s", view, ex)

            return

        except box.EmptyComponent:

            return

        w(u'<div class="%s %s" id="%s">' % (self.cssclass, view.cssclass,

                                            view.domid))

        w(u'<div class="boxTitle"><span>')

        view.render_title(w)

        w(u'</span></div>\n<div class="boxBody">')

        view.render_body(w)

        # boxFooter div is a CSS place holder (for shadow for example)

        w(u'</div><div class="boxFooter"></div></div>\n')

class ContextFreeBoxLayout(ContextualBoxLayout):

    __select__ = match_context('incontext', 'left', 'right') & ~box.contextual()

    cssclass = 'contextFreeBox'