+
−"""abstract action classes 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 cubicweb import target
+
−from cubicweb.selectors import (partial_relation_possible, match_search_state,
+
−                                one_line_rset, partial_may_add_relation, yes,
+
−                                accepts_compat, condition_compat, deprecate)
+
−from cubicweb.appobject import AppObject
+
−
+
−
+
−class Action(AppObject):
+
−    """abstract action. Handle the .search_states attribute to match
+
−    request search state.
+
−    """
+
−    __registry__ = 'actions'
+
−    __select__ = match_search_state('normal')
+
−
+
−    property_defs = {
+
−        'visible':  dict(type='Boolean', default=True,
+
−                         help=_('display the action or not')),
+
−        'order':    dict(type='Int', default=99,
+
−                         help=_('display order of the action')),
+
−        'category': dict(type='String', default='moreactions',
+
−                         vocabulary=('mainactions', 'moreactions', 'addrelated',
+
−                                     'useractions', 'siteactions', 'hidden'),
+
−                         help=_('context where this component should be displayed')),
+
−    }
+
−    site_wide = True # don't want user to configurate actions
+
−    category = 'moreactions'
+
−    # actions in category 'moreactions' can specify a sub-menu in which they should be filed
+
−    submenu = None
+
−
+
−    def actual_actions(self):
+
−        yield self
+
−
+
−    def fill_menu(self, box, menu):
+
−        """add action(s) to the given submenu of the given box"""
+
−        for action in self.actual_actions():
+
−            menu.append(box.box_action(action))
+
−
+
−    def url(self):
+
−        """return the url associated with this action"""
+
−        raise NotImplementedError
+
−
+
−    def html_class(self):
+
−        if self.req.selected(self.url()):
+
−            return 'selected'
+
−        if self.category:
+
−            return 'box' + self.category.capitalize()
+
−
+
−    def build_action(self, title, path, **kwargs):
+
−        return UnregisteredAction(self.req, self.rset, title, path, **kwargs)
+
−
+
−
+
−class UnregisteredAction(Action):
+
−    """non registered action used to build boxes. Unless you set them
+
−    explicitly, .vreg and .schema attributes at least are None.
+
−    """
+
−    category = None
+
−    id = None
+
−
+
−    def __init__(self, req, rset, title, path, **kwargs):
+
−        Action.__init__(self, req, rset)
+
−        self.title = req._(title)
+
−        self._path = path
+
−        self.__dict__.update(kwargs)
+
−
+
−    def url(self):
+
−        return self._path
+
−
+
−
+
−class LinkToEntityAction(Action):
+
−    """base class for actions consisting to create a new object
+
−    with an initial relation set to an entity.
+
−    Additionaly to EntityAction behaviour, this class is parametrized
+
−    using .etype, .rtype and .target attributes to check if the
+
−    action apply and if the logged user has access to it
+
−    """
+
−    __select__ = (match_search_state('normal') & one_line_rset()
+
−                  & partial_relation_possible(action='add')
+
−                  & partial_may_add_relation())
+
−    registered = accepts_compat(Action.registered)
+
−
+
−    submenu = 'addrelated'
+
−
+
−    def url(self):
+
−        current_entity = self.rset.get_entity(self.row or 0, self.col or 0)
+
−        linkto = '%s:%s:%s' % (self.rtype, current_entity.eid, target(self))
+
−        return self.build_url('add/%s' % self.etype, __linkto=linkto,
+
−                              __redirectpath=current_entity.rest_path(), # should not be url quoted!
+
−                              __redirectvid=self.req.form.get('__redirectvid', ''))
+
−
+
−class EntityAction(Action):
+
−    """DEPRECATED / BACKWARD COMPAT
+
−    """
+
−    registered = deprecate(condition_compat(accepts_compat(Action.registered)),
+
−                           msg='EntityAction is deprecated, use Action with '
+
−                           'appropriate selectors')
+
−