/usr/share/pyshared/zope/browsermenu/metaconfigure.py is in python-zope.browsermenu 3.9.1-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | ##############################################################################
#
# 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: metaconfigure.py 103270 2009-08-27 13:56:02Z nadako $
"""
from zope.browser.interfaces import IAdding
from zope.component import getGlobalSiteManager, getUtility
from zope.component.interface import provideInterface
from zope.component.zcml import adapter, proxify, utility
from zope.configuration.exceptions import ConfigurationError
from zope.interface import Interface
from zope.interface.interface import InterfaceClass
from zope.pagetemplate.engine import Engine
from zope.publisher.interfaces.browser import IDefaultBrowserLayer
from zope.security.checker import InterfaceChecker, CheckerPublic
from zope.security.metaconfigure import ClassDirective
from zope.browsermenu.menu import BrowserMenu, BrowserMenuItem, BrowserSubMenuItem
from zope.browsermenu.interfaces import IBrowserMenu, IMenuItemType
from zope.browsermenu.interfaces import IBrowserMenuItem, IBrowserSubMenuItem
from zope.browsermenu.interfaces import AddMenu
# Create special modules that contain all menu item types
from types import ModuleType as module
import sys
try:
import zope.app
except ImportError: # we doesn't always have zope.app now
sys.modules['zope.app'] = module('app')
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:
if id in dir(menus):
# reuse existing interfaces for the id, without this we are not
# able to override menus.
interface = getattr(menus, id)
else:
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, item_class=None):
"""Register a single menu item."""
return menuItemsDirective(_context, menu, for_, layer).menuItem(
_context, action, title, description, icon, filter,
permission, extra, order, item_class)
def subMenuItemDirective(_context, menu, for_, title, submenu,
action=u'', description=u'', icon=None, filter=None,
permission=None, layer=IDefaultBrowserLayer,
extra=None, order=0, item_class=None):
"""Register a single sub-menu menu item."""
return menuItemsDirective(_context, menu, for_, layer).subMenuItem(
_context, submenu, title, description, action, icon, filter,
permission, extra, order, item_class)
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."""
menuItemClass = BrowserMenuItem
subMenuItemClass = BrowserSubMenuItem
def __init__(self, _context, menu, for_, layer=IDefaultBrowserLayer,
permission=None):
self.for_ = for_
self.menuItemType = menu
self.layer = layer
self.permission = permission
def menuItem(self, _context, action, title, description=u'',
icon=None, filter=None, permission=None, extra=None,
order=0, item_class=None):
if filter is not None:
filter = Engine.compile(filter)
if permission is None:
permission = self.permission
if order == 0:
order = _order_counter.get(self.for_, 1)
_order_counter[self.for_] = order + 1
if item_class is None:
item_class = self.menuItemClass
if not IBrowserMenuItem.implementedBy(item_class):
raise ValueError("Item class (%s) must implement IBrowserMenuItem" % item_class)
factory = MenuItemFactory(
item_class,
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, item_class=None):
if filter is not None:
filter = Engine.compile(filter)
if permission is None:
permission = self.permission
if order == 0:
order = _order_counter.get(self.for_, 1)
_order_counter[self.for_] = order + 1
if item_class is None:
item_class = self.subMenuItemClass
if not IBrowserSubMenuItem.implementedBy(item_class):
raise ValueError("Item class (%s) must implement IBrowserSubMenuItem" % item_class)
factory = MenuItemFactory(
item_class,
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 = 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, item_class=None):
"""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 = 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=layer).menuItem(
_context, action, title, description, icon, filter,
permission, extra, order, item_class)
|