Implement your script in some module shipping in your package as a named function accepting context and request as its arguments:
def whoami(context, request):
from AccessControl.SecurityManagement import getSecurityManager
user = getSecurityManager().getUser()
return {
'absolute_url': context.absolute_url(),
'context': context.__repr__(),
'user': user.__repr__(),
'getId': user.getId(),
'getUserName': user.getUserName(),
'getRoles': user.getRoles(),
'getRolesInContext': user.getRolesInContext(context)
}
Remember to include transaction commit when your scripts modifies the database (the example above does not):
import transaction
transaction.commit()
Register your function as a named set’uptools entry point for collective.runhook* in your package’s setup.py:
from setuptools import setup
setup(
# ...
entry_points="""
# -*- Entry points: -*-
# ...
[collective.runhook]
whoami = my.package:whoami
"""
)
Add collective.runhook as a dependency of your package, or include it in your buildout’s instance part:
[buildout]
parts = instance
# ...
[instance]
recipe = plone.recipe.zope2instance
# ...
eggs =
Plone
# ...
collective.runhook
Run the buildout and execute your script:
$ bin/instance runhook whoami
...
{'absolute_url': 'http://nohost/Plone',
'context': '<Application at >',
'getId': None,
'getRoles': ('manage', 'Authenticated'),
'getRolesInContext': ['manage', 'Authenticated'],
'getUserName': 'System Processes',
'user': "<UnrestrictedUser 'System Processes'>"}
collective.runhook obeys the same instance script arguments as the run command:
$ bin/instance -OPlone runhook whoami
...
{'absolute_url': 'http://nohost/Plone',
'context': '<PloneSite at /Plone>',
'getId': None,
'getRoles': ('manage', 'Authenticated'),
'getRolesInContext': ['manage', 'Authenticated'],
'getUserName': 'System Processes',
'user': "<UnrestrictedUser 'System Processes'>"}
As a bonus, collective.runhook can authenticate the script as any existing user given with ZOPE_USER environment variable (but be aware that the authentication is only done after -O-traverse):
$ ZOPE_USER=datakurre bin/instance -OPlone runhook whoami
...
{'absolute_url': 'http://nohost/Plone',
'context': '<PloneSite at /Plone>',
'getId': 'datakurre',
'getRoles': ['Member', 'Reviewer', 'Site Administrator', 'Authenticated'],
'getRolesInContext': ['Member',
'Reviewer',
'Site Administrator',
'Authenticated'],
'getUserName': 'datakurre',
'user': "<PloneUser 'datakurre'>"}
And we do support URLs with VirtualHostBase:
$ ZOPE_USER=datakurre bin/instance -O/VirtualHostBase/http://example.com:80/Plone/VirtualHostRoot/Plone runhook whoami
...
{'absolute_url': 'http://example.com',
'context': '<PloneSite at /Plone>',
'getId': 'datakurre',
'getRoles': ['Member', 'Reviewer', 'Site Administrator', 'Authenticated'],
'getRolesInContext': ['Member',
'Reviewer',
'Site Administrator',
'Authenticated'],
'getUserName': 'datakurre',
'user': "<PloneUser 'datakurre'>"}
Changelog
0.9.5 (2014-09-28)
Fix to iterate through all entrypoints with the same name to support multiple scripts with the same hook name [datakurre]
Fix to pprint script return value to not require script to print by itself [datakurre]
0.9.4 (2014-09-26)
Fix to print hooks’ results (when non-False) [datakurre]
0.9.3 (2014-09-25)
Add support for VirtualHostMonster URLs [datakurre]
0.9.2 (2014-09-25)
Fix issue where wrong attribute from entrypoint was read [datakurre]
0.9.1 (2014-09-24)
Update README [datakurre]
0.9.0 (2014-09-24)
First release.
Metadata
Release files for collective.runhook 0.9.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| collective.runhook-0.9.5.zip | 15.3 kB | Without provenance | Details for collective.runhook-0.9.5.zip |
Release files / collective.runhook-0.9.5.zip
| Download URL | collective.runhook-0.9.5.zip |
|---|---|
| Size | 15.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3cd3f1620f9739ff312dd0884795a0a0b2e83970e32d144639a0a1b4c280365b
|
|
BLAKE2b-256 checksum How to use checksums |
db9675e8921ff7438249883577664cd15299157913942a98893eabe6492ffce6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for collective.runhook 0.9.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.