def pageletDirective(
_context, class_, name, permission, for_=zope.interface.Interface,
layer=IDefaultBrowserLayer, provides=interfaces.IPagelet,
allowed_interface=None, allowed_attributes=None, **kwargs):
# Security map dictionary
required = {}
# Get the permission; mainly to correctly handle CheckerPublic.
permission = viewmeta._handle_permission(_context, permission)
# The class must be specified.
if not class_:
raise ConfigurationError("Must specify a class.")
if not zope.interface.interfaces.IInterface.providedBy(provides):
raise ConfigurationError("Provides interface provide IInterface.")
ifaces = list(zope.interface.Declaration(provides).flattened())
if interfaces.IPagelet not in ifaces:
raise ConfigurationError("Provides interface must inherit IPagelet.")
# Build a new class that we can use different permission settings if we
# use the class more then once.
cdict = {}
cdict['__name__'] = name
cdict.update(kwargs)
new_class = type(class_.__name__, (class_, browser.BrowserPagelet), cdict)
# Set up permission mapping for various accessible attributes
viewmeta._handle_allowed_interface(
_context, allowed_interface, permission, required)
viewmeta._handle_allowed_attributes(
_context, allowed_attributes, permission, required)
viewmeta._handle_allowed_attributes(
_context, kwargs.keys(), permission, required)
viewmeta._handle_allowed_attributes(
_context, ('__call__', 'browserDefault', 'update', 'render',
'publishTraverse'), permission, required)
# Register the interfaces.
viewmeta._handle_for(_context, for_)
# provide the custom provides interface if not allready provided
if not provides.implementedBy(new_class):
zope.interface.classImplements(new_class, provides)
# Create the security checker for the new class
zope.security.checker.defineChecker(new_class,
zope.security.checker.Checker(required))
# register pagelet
_context.action(
discriminator = ('pagelet', for_, layer, name),
callable = zope.component.zcml.handler,
args = ('registerAdapter',
new_class, (for_, layer), provides, name, _context.info),)
def page(
_context,
name,
permission,
for_=Interface,
layer=IDefaultBrowserLayer,
template=None,
class_=None,
allowed_interface=None,
allowed_attributes=None,
attribute='__call__',
menu=None,
title=None,
):
_handle_menu(_context, menu, title, [for_], name, permission, layer)
required = {}
permission = _handle_permission(_context, permission)
if not (class_ or template):
raise ConfigurationError("Must specify a class or template")
if attribute != '__call__':
if template:
raise ConfigurationError(
"Attribute and template cannot be used together.")
if not class_:
raise ConfigurationError(
"A class must be provided if attribute is used")
if template:
template = os.path.abspath(str(_context.path(template)))
if not os.path.isfile(template):
raise ConfigurationError("No such file", template)
# TODO: new __name__ attribute must be tested
if class_:
if attribute != '__call__':
if not hasattr(class_, attribute):
raise ConfigurationError(
"The provided class doesn't have the specified attribute ")
if template:
# class and template
new_class = SimpleViewClass(template, bases=(class_, ), name=name)
else:
if not hasattr(class_, 'browserDefault'):
cdict = {
'browserDefault':
lambda self, request: (getattr(self, attribute), ())
}
else:
cdict = {}
cdict['__name__'] = name
cdict['__page_attribute__'] = attribute
cdict.update(getSecurityInfo(class_))
new_class = type(class_.__name__, (
class_,
simple,
), cdict)
if attribute != "__call__":
# in case the attribute does not provide a docstring,
# ZPublisher refuses to publish it. So, as a workaround,
# we provide a stub docstring
func = getattr(new_class, attribute)
if not func.__doc__:
# cannot test for MethodType/UnboundMethod here
# because of ExtensionClass
if hasattr(func, 'im_func'):
# you can only set a docstring on functions, not
# on method objects
func = func.im_func
func.__doc__ = "Stub docstring to make ZPublisher work"
if hasattr(class_, '__implements__'):
classImplements(new_class, IBrowserPublisher)
else:
# template
new_class = SimpleViewClass(template, name=name)
for n in ('', attribute):
required[n] = permission
_handle_allowed_interface(_context, allowed_interface, permission,
required)
_handle_allowed_attributes(_context, allowed_attributes, permission,
required)
_handle_for(_context, for_)
_configure_z2security(_context, new_class, required)
_context.action(
discriminator=('view', (for_, layer), name, IBrowserRequest),
callable=handler,
args=('registerAdapter', new_class, (for_, layer), Interface, name,
_context.info),
)
def page(_context, name, permission, for_=Interface,
layer=IDefaultBrowserLayer, template=None, class_=None,
allowed_interface=None, allowed_attributes=None,
attribute='__call__', menu=None, title=None,
):
name = str(name) # De-unicode
_handle_menu(_context, menu, title, [for_], name, permission, layer)
required = {}
permission = _handle_permission(_context, permission)
if not (class_ or template):
raise ConfigurationError("Must specify a class or template")
if attribute != '__call__':
if template:
raise ConfigurationError(
"Attribute and template cannot be used together.")
if not class_:
raise ConfigurationError(
"A class must be provided if attribute is used")
if template:
template = os.path.abspath(str(_context.path(template)))
if not os.path.isfile(template):
raise ConfigurationError("No such file", template)
# TODO: new __name__ attribute must be tested
if class_:
if attribute != '__call__':
if not hasattr(class_, attribute):
raise ConfigurationError(
"The provided class doesn't have the specified attribute "
)
if template:
# class and template
new_class = SimpleViewClass(template, bases=(class_, ), name=name)
else:
if not hasattr(class_, 'browserDefault'):
cdict = {
'browserDefault':
lambda self, request: (getattr(self, attribute), ())
}
else:
cdict = {}
cdict['__name__'] = name
cdict['__page_attribute__'] = attribute
cdict.update(getSecurityInfo(class_))
new_class = type(class_.__name__, (class_, simple,), cdict)
if attribute != "__call__":
# in case the attribute does not provide a docstring,
# ZPublisher refuses to publish it. So, as a workaround,
# we provide a stub docstring
func = getattr(new_class, attribute)
if not func.__doc__:
# cannot test for MethodType/UnboundMethod here
# because of ExtensionClass
if hasattr(func, 'im_func'):
# you can only set a docstring on functions, not
# on method objects
func = func.im_func
func.__doc__ = "Stub docstring to make ZPublisher work"
if hasattr(class_, '__implements__'):
classImplements(new_class, IBrowserPublisher)
else:
# template
new_class = SimpleViewClass(template, name=name)
for n in ('', attribute):
required[n] = permission
_handle_allowed_interface(_context, allowed_interface, permission,
required)
_handle_allowed_attributes(_context, allowed_attributes, permission,
required)
_handle_for(_context, for_)
_configure_z2security(_context, new_class, required)
_context.action(
discriminator = ('view', (for_, layer), name, IBrowserRequest),
callable = handler,
args = ('registerAdapter',
new_class, (for_, layer), Interface, name, _context.info),
)
def menuItemDirective(
_context, name, permission, for_=zope.interface.Interface,
layer=IDefaultBrowserLayer, view=IBrowserView,
manager=interfaces.IMenuManager, class_=None, template=None,
attribute='render', allowed_interface=None, allowed_attributes=None,
title=None, **kwargs):
# Security map dictionary
required = {}
if title is not None:
# set i18n aware title
kwargs['i18nTitle'] = title
# Get the permission; mainly to correctly handle CheckerPublic.
permission = _handle_permission(_context, permission)
# Either the class or template must be specified.
if not (class_ or template):
raise ConfigurationError("Must specify a class or template")
# Make sure that all the non-default attribute specifications are correct.
if attribute != 'render':
if template:
raise ConfigurationError(
"Attribute and template cannot be used together.")
# Note: The previous logic forbids this condition to evere occur.
if not class_:
raise ConfigurationError(
"A class must be provided if attribute is used")
# Make sure that the template exists and that all low-level API methods
# have the right permission.
if template:
template = os.path.abspath(str(_context.path(template)))
if not os.path.isfile(template):
raise ConfigurationError("No such file", template)
required['__getitem__'] = permission
# Make sure the has the right form, if specified.
if class_:
if attribute != 'render':
if not hasattr(class_, attribute):
raise ConfigurationError(
"The provided class doesn't have the specified attribute "
)
if template:
# Create a new class for the viewlet template and class.
new_class = viewlet.SimpleViewletClass(
template, bases=(class_, ), attributes=kwargs, name=name)
else:
if not hasattr(class_, 'browserDefault'):
cdict = {'browserDefault':
lambda self, request: (getattr(self, attribute), ())}
else:
cdict = {}
cdict['__name__'] = name
cdict['__page_attribute__'] = attribute
cdict.update(kwargs)
new_class = type(class_.__name__,
(class_, viewlet.SimpleAttributeViewlet), cdict)
if hasattr(class_, '__implements__'):
zope.interface.classImplements(new_class, IBrowserPublisher)
else:
# Create a new class for the viewlet template alone.
new_class = viewlet.SimpleViewletClass(template, name=name,
attributes=kwargs)
# Set up permission mapping for various accessible attributes
_handle_allowed_interface(
_context, allowed_interface, permission, required)
_handle_allowed_attributes(
_context, allowed_attributes, permission, required)
_handle_allowed_attributes(
_context, kwargs.keys(), permission, required)
_handle_allowed_attributes(
_context,
(attribute, 'browserDefault', 'update', 'render', 'publishTraverse'),
permission, required)
# Register the interfaces.
_handle_for(_context, for_)
zcml.interface(_context, view)
# Create the security checker for the new class
zope.security.checker.defineChecker(new_class,
zope.security.checker.Checker(required))
# register viewlet
_context.action(
discriminator = ('viewlet', for_, layer, view, manager, name),
callable = zcml.handler,
args = ('registerAdapter',
new_class, (for_, layer, view, manager),
zope.viewlet.interfaces.IViewlet, name, _context.info),)
def wizardStepDirective(_context,
class_,
name,
permission,
for_=zope.interface.Interface,
layer=IDefaultBrowserLayer,
wizard=interfaces.IWizard,
provides=interfaces.IStep,
allowed_interface=None,
allowed_attributes=None,
**kwargs):
# Security map dictionary
required = {}
# Get the permission; mainly to correctly handle CheckerPublic.
permission = _handle_permission(_context, permission)
# The class must be specified.
if not class_:
raise ConfigurationError("Must specify a class.")
if not zope.interface.interfaces.IInterface.providedBy(provides):
raise ConfigurationError("Provides interface provide IInterface.")
ifaces = list(zope.interface.Declaration(provides).flattened())
if interfaces.IPagelet not in ifaces:
raise ConfigurationError("Provides interface must inherit IPagelet.")
if not interfaces.IWizard.implementedBy(wizard):
raise ConfigurationError("Provides interface must inherit IWizard.")
# Build a new class that we can use different permission settings if we
# use the class more then once.
cdict = {}
cdict['__name__'] = name
cdict.update(kwargs)
new_class = type(class_.__name__, (class_, step.Step), cdict)
# Set up permission mapping for various accessible attributes
_handle_allowed_interface(_context, allowed_interface, permission,
required)
_handle_allowed_attributes(_context, allowed_attributes, permission,
required)
_handle_allowed_attributes(_context, kwargs.keys(), permission, required)
_handle_allowed_attributes(
_context,
('__call__', 'browserDefault', 'update', 'render', 'publishTraverse'),
permission, required)
# Register the interfaces.
_handle_for(_context, for_)
# provide the custom provides interface if not allready provided
if not provides.implementedBy(new_class):
zope.interface.classImplements(new_class, provides)
# Create the security checker for the new class
zope.security.checker.defineChecker(
new_class, zope.security.checker.Checker(required))
# register pagelet
_context.action(discriminator=('pagelet', for_, layer, name),
callable=zope.component.zcml.handler,
args=('registerAdapter', new_class, (for_, layer, wizard),
provides, name, _context.info))