web/action.py
changeset 11057 0b59724cb3f2
parent 11052 058bb3dc685f
child 11058 23eb30449fe5
--- a/web/action.py	Mon Jan 04 18:40:30 2016 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,113 +0,0 @@
-# copyright 2003-2012 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
-# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
-#
-# This file is part of CubicWeb.
-#
-# CubicWeb is free software: you can redistribute it and/or modify it under the
-# terms of the GNU Lesser General Public License as published by the Free
-# Software Foundation, either version 2.1 of the License, or (at your option)
-# any later version.
-#
-# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
-# details.
-#
-# You should have received a copy of the GNU Lesser General Public License along
-# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
-"""abstract action classes for CubicWeb web client
-
-Actions are typically displayed in an action box, but can also be used
-in other parts of the interface (the user menu, the footer, etc.). The
-'order', 'category' and 'title' class attributes control how the action will
-be displayed. The 'submenu' attribute is only used for actions in the
-action box.
-
-The most important method from a developper point of view in the
-:meth:'Action.url' method, which returns a URL on which the navigation
-should be directed to perform the action.  The common way of
-writing that method is to simply return a URL to the current rset with a
-special view (with `self._cw.build_url(...)` for instance) 
-
-Many examples are available in :mod:`cubicweb.web.views.actions`.
-"""
-
-__docformat__ = "restructuredtext en"
-from cubicweb import _
-
-from cubicweb import target
-from cubicweb.predicates import (partial_relation_possible, match_search_state,
-                                 one_line_rset)
-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')
-    order = 99
-    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.action_link(action))
-
-    def html_class(self):
-        if self._cw.selected(self.url()):
-            return 'selected'
-
-    def build_action(self, title, url, **kwargs):
-        return UnregisteredAction(self._cw, title, url, **kwargs)
-
-    def url(self):
-        """return the url associated with this action"""
-        raise NotImplementedError
-
-
-class UnregisteredAction(Action):
-    """non registered action, used to build boxes"""
-    category = None
-    id = None
-
-    def __init__(self, req, title, url, **kwargs):
-        Action.__init__(self, req)
-        self.title = req._(title)
-        self._url = url
-        self.__dict__.update(kwargs)
-
-    def url(self):
-        return self._url
-
-
-class LinkToEntityAction(Action):
-    """base class for actions consisting to create a new object with an initial
-    relation set to an entity.
-
-    Additionally to EntityAction behaviour, this class is parametrized using
-    .rtype, .role and .target_etype attributes to check if the action apply and
-    if the logged user has access to it (see
-    :class:`~cubicweb.selectors.partial_relation_possible` selector
-    documentation for more information).
-    """
-    __select__ = (match_search_state('normal') & one_line_rset()
-                  & partial_relation_possible(action='add', strict=True))
-
-    submenu = 'addrelated'
-    # to be defined in concrete classes
-    target_etype = rtype = None
-
-    def url(self):
-        ttype = self.target_etype
-        entity = self.cw_rset.get_entity(self.cw_row or 0, self.cw_col or 0)
-        linkto = '%s:%s:%s' % (self.rtype, entity.eid, target(self))
-        return self._cw.vreg["etypes"].etype_class(ttype).cw_create_url(self._cw,
-                                  __redirectpath=entity.rest_path(), __linkto=linkto,
-                                  __redirectvid=self._cw.form.get('__redirectvid', ''))