Move zope.app.component.interface to zope.component.interface (note t…

…he singular).

It contains some helpers regarding interfaces that are useful outside zope.app.

browser/icon.py

@@ -22,8 +22,8 @@
 from zope.publisher.interfaces.browser import IDefaultBrowserLayer
 from zope.configuration.exceptions import ConfigurationError
 from zope.traversing.namespace import getResource
+from zope.component.interface import provideInterface
 
-from zope.app.component.interface import provideInterface
 from zope.app.component.metaconfigure import handler
 from zope.app.publisher.browser import metaconfigure
 

browser/menumeta.py

@@ -0,0 +1,277 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Menu Directives Configuration Handlers
+
+$Id$
+"""
+import zope.component
+from zope.configuration.exceptions import ConfigurationError
+from zope.interface.interface import InterfaceClass
+from zope.interface import Interface
+from zope.publisher.interfaces.browser import IBrowserRequest
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+from zope.security.checker import InterfaceChecker, CheckerPublic
+from zope.component.interface import provideInterface
+
+from zope.app.component.metaconfigure import adapter, proxify
+from zope.app.component.metaconfigure import utility
+from zope.app.component.contentdirective import ClassDirective
+from zope.app.pagetemplate.engine import Engine
+from zope.app.container.interfaces import IAdding
+from zope.app.publisher.browser.menu import BrowserMenu
+from zope.app.publisher.browser.menu import BrowserMenuItem, BrowserSubMenuItem
+from zope.app.publisher.interfaces.browser import IBrowserMenu
+from zope.app.publisher.interfaces.browser import IBrowserMenuItem
+from zope.app.publisher.interfaces.browser import IMenuItemType
+from zope.app.publisher.interfaces.browser import AddMenu
+
+# Create special modules that contain all menu item types
+from types import ModuleType as module
+import sys
+menus = module('menus')
+sys.modules['zope.app.menus'] = menus
+
+
+_order_counter = {}
+
+
+def menuDirective(_context, id=None, class_=BrowserMenu, interface=None,
+                  title=u'', description=u''):
+    """Registers a new browser menu."""
+    if id is None and interface is None:
+        raise ConfigurationError(
+            "You must specify the 'id' or 'interface' attribute.")
+
+    if interface is None:
+        interface = InterfaceClass(id, (),
+                                   __doc__='Menu Item Type: %s' %id,
+                                   __module__='zope.app.menus')
+        # Add the menu item type to the `menus` module.
+        # Note: We have to do this immediately, so that directives using the
+        # MenuField can find the menu item type.
+        setattr(menus, id, interface)
+        path = 'zope.app.menus.' + id
+    else:
+        path = interface.__module__ + '.' + interface.getName()
+
+        # If an id was specified, make this menu available under this id.
+        # Note that the menu will be still available under its path, since it
+        # is an adapter, and the `MenuField` can resolve paths as well.
+        if id is None:
+            id = path
+        else:
+            # Make the interface available in the `zope.app.menus` module, so
+            # that other directives can find the interface under the name
+            # before the CA is setup.
+            _context.action(
+                discriminator = ('browser', 'MenuItemType', path),
+                callable = provideInterface,
+                args = (path, interface, IMenuItemType, _context.info)
+                )
+            setattr(menus, id, interface)
+
+    # Register the layer interface as an interface
+    _context.action(
+        discriminator = ('interface', path),
+        callable = provideInterface,
+        args = (path, interface),
+        kw = {'info': _context.info}
+        )
+
+    # Register the menu item type interface as an IMenuItemType
+    _context.action(
+        discriminator = ('browser', 'MenuItemType', id),
+        callable = provideInterface,
+        args = (id, interface, IMenuItemType, _context.info)
+        )
+
+    # Register the menu as a utility
+    utility(_context, IBrowserMenu, class_(id, title, description), name=id)
+
+
+def menuItemDirective(_context, menu, for_,
+                      action, title, description=u'', icon=None, filter=None,
+                      permission=None, layer=IDefaultBrowserLayer, extra=None,
+                      order=0):
+    """Register a single menu item."""
+    return menuItemsDirective(_context, menu, for_, layer).menuItem(
+        _context, action, title, description, icon, filter,
+        permission, extra, order)
+
+
+def subMenuItemDirective(_context, menu, for_, title, submenu,
+                         action=u'', description=u'', icon=None, filter=None,
+                         permission=None, layer=IDefaultBrowserLayer,
+                         extra=None, order=0):
+    """Register a single sub-menu menu item."""
+    return menuItemsDirective(_context, menu, for_, layer).subMenuItem(
+        _context, submenu, title, description, action, icon, filter,
+        permission, extra, order)
+
+
+class MenuItemFactory(object):
+    """generic factory for menu items."""
+
+    def __init__(self, factory, **kwargs):
+        self.factory = factory
+        if 'permission' in kwargs and kwargs['permission'] == 'zope.Public':
+            kwargs['permission'] = CheckerPublic
+        self.kwargs = kwargs
+
+    def __call__(self, context, request):
+        item = self.factory(context, request)
+
+        for key, value in self.kwargs.items():
+            setattr(item, key, value)
+
+        if item.permission is not None:
+            checker = InterfaceChecker(IBrowserMenuItem, item.permission)
+            item = proxify(item, checker)
+
+        return item
+
+
+class menuItemsDirective(object):
+    """Register several menu items for a particular menu."""
+
+    def __init__(self, _context, menu, for_, layer=IDefaultBrowserLayer):
+        self.for_ = for_
+        self.menuItemType = menu
+        self.layer = layer
+
+    def menuItem(self, _context, action, title, description=u'',
+                 icon=None, filter=None, permission=None, extra=None, order=0):
+
+        if filter is not None:
+            filter = Engine.compile(filter)
+
+        if order == 0:
+            order = _order_counter.get(self.for_, 1)
+            _order_counter[self.for_] = order + 1
+
+        factory = MenuItemFactory(
+            BrowserMenuItem,
+            title=title, description=description, icon=icon, action=action,
+            filter=filter, permission=permission, extra=extra, order=order,
+            _for=self.for_)
+        adapter(_context, (factory,), self.menuItemType,
+                (self.for_, self.layer), name=title)
+
+    def subMenuItem(self, _context, submenu, title, description=u'',
+                    action=u'', icon=None, filter=None, permission=None,
+                    extra=None, order=0):
+
+        if filter is not None:
+            filter = Engine.compile(filter)
+
+        if order == 0:
+            order = _order_counter.get(self.for_, 1)
+            _order_counter[self.for_] = order + 1
+
+        factory = MenuItemFactory(
+            BrowserSubMenuItem,
+            title=title, description=description, icon=icon, action=action,
+            filter=filter, permission=permission, extra=extra, order=order,
+            _for=self.for_, submenuId=submenu)
+        adapter(_context, (factory,), self.menuItemType,
+                (self.for_, self.layer), name=title)
+
+    def __call__(self, _context):
+        # Nothing to do.
+        pass
+
+def _checkViewFor(for_=None, layer=None, view_name=None):
+    """Check if there is a view of that name registered for IAdding
+    and IBrowserRequest. If not raise a ConfigurationError
+
+    It will raise a ConfigurationError if :
+        o view=""
+        o if view_name is not registred
+    """
+
+    if view_name is None:
+        raise ConfigurationError(
+            "Within a addMenuItem directive the view attribut"
+            " is optional but can\'t be empty"
+            )
+
+    gsm = zope.component.getGlobalSiteManager()
+    if gsm.adapters.lookup((for_, layer),
+                           Interface, view_name) is None:
+        raise ConfigurationError(
+            "view name %s not found " %view_name
+            )
+
+def addMenuItem(_context, title, description='', menu=None, for_=None,
+                class_=None, factory=None, view=None, icon=None, filter=None,
+                permission=None, layer=IDefaultBrowserLayer, extra=None,
+                order=0):
+    """Create an add menu item for a given class or factory
+
+    As a convenience, a class can be provided, in which case, a
+    factory is automatically defined based on the class.  In this
+    case, the factory id is based on the class name.
+
+    """
+
+    if for_ is not None:
+        _context.action(
+            discriminator = None,
+            callable = provideInterface,
+            args = ('', for_)
+            )
+        forname = 'For' + for_.getName()
+    else:
+        for_ = IAdding
+        forname = ''
+
+    if menu is not None:
+        if isinstance(menu, (str, unicode)):
+            menu = zope.component.getUtility(IMenuItemType, menu)
+            if menu is None:
+                raise ValueError("Missing menu id '%s'" % menu)
+
+    if class_ is None:
+        if factory is None:
+            raise ValueError("Must specify either class or factory")
+    else:
+        if factory is not None:
+            raise ValueError("Can't specify both class and factory")
+        if permission is None:
+            raise ValueError(
+                "A permission must be specified when a class is used")
+        factory = "BrowserAdd%s__%s.%s" % (
+            forname, class_.__module__, class_.__name__)
+        ClassDirective(_context, class_).factory(_context, id=factory)
+
+    extra = {'factory': factory}
+
+    if view:
+        action = view
+        # This action will check if the view exists
+        _context.action(
+            discriminator = None,
+            callable = _checkViewFor,
+            args = (for_, layer, view),
+            order=999999
+            )
+    else:
+        action = factory
+
+    if menu == None:
+        menu = AddMenu
+
+    return menuItemsDirective(_context, menu, for_, layer).menuItem(
+        _context, action, title, description, icon, filter,
+        permission, extra, order)

browser/metaconfigure.py

@@ -17,6 +17,7 @@
 """
 import warnings
 from zope.component.interfaces import IDefaultViewName
+from zope.component.interface import provideInterface
 from zope.configuration.exceptions import ConfigurationError
 from zope.interface import directlyProvides
 from zope.interface.interface import InterfaceClass
@@ -31,7 +32,6 @@
 from zope.app.publisher.browser.resourcemeta import resourceDirectory
 from zope.app.publisher.browser.i18nresourcemeta import I18nResource
 from zope.app.publisher.browser.viewmeta import view
-from zope.app.component.interface import provideInterface
 
 # BBB 2006/02/18, to be removed after 12 months
 import zope.deprecation

browser/viewmeta.py

@@ -17,7 +17,9 @@
 """
 import os
 
+from zope.component import queryMultiAdapter
 from zope.component.interfaces import ComponentLookupError, IDefaultViewName
+from zope.component.interface import provideInterface
 from zope.interface import implements, classImplements, Interface
 from zope.publisher.interfaces import NotFound
 from zope.security.checker import CheckerPublic, Checker, defineChecker
@@ -27,8 +29,6 @@
 from zope.publisher.interfaces.browser import IBrowserPublisher
 from zope.publisher.browser import BrowserView
 
-from zope.app import zapi
-from zope.app.component.interface import provideInterface
 from zope.app.component.metaconfigure import handler
 from zope.app.pagetemplate.simpleviewclass import SimpleViewClass
 from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
@@ -281,7 +281,7 @@ def publishTraverse(self, request, name,
 
                 if name in pages:
                     return getattr(self, pages[name])
-                view = zapi.queryMultiAdapter((self, request), name=name)
+                view = queryMultiAdapter((self, request), name=name)
                 if view is not None:
                     return view
 
@@ -294,7 +294,7 @@ def publishTraverse(self, request, name,
 
                 if name in pages:
                     return getattr(self, pages[name])
-                view = zapi.queryMultiAdapter((self, request), name=name)
+                view = queryMultiAdapter((self, request), name=name)
                 if view is not None:
                     return view