Plone/Zope time based event mechanism
This is a developer level product. This product is indended to replace Products.TickingMachine with more robust Zope 3 codebase.
- Install collective.timedevents
Add the following to your buildout.cfg:eggs = ... collective.timedevents
Add clock server to tick timedevents subscribers - use your Plone instance name:[instance] ... zope-conf-additional = <clock-server> method /mysite/@@tick period 90 user admin password adminpassword host localhost </clock-server>
Add collective.timedevents.interfaces.ITickEvent subscribers to your product ZCML declarations.
<configure xmlns="http://namespaces.zope.org/zope" xmlns:browser="http://namespaces.zope.org/browser" i18n_domain="harvinaiset.app"> <subscriber handler="myproduct.tickers.on_tick" for="collective.timedevents.intefaces.ITickEvent" /> </configure>
Configure your event handler to react after certain period has expired:
from zope.app.component.hooks import getSite def on_tick(event): """ Do something after one hour has elapsed """ interval_in_days = 1.0 / 24.0 # One hour, floating point context = site.my_magic_context # Persistent object which stores our timing data if event.last_tick > context.last_action + interval_in_days: # Check whether enough time has elaped do_stuff() context.last_action = event.last_tick # Store when we last time did something
All ticking code is executed under admin privileges. Tick period is 300 seconds by default. This can be controlled in views.py. Ticks are logged by events.tick_logger defined in configure.zcml.
The product is loosely connected to Plone, but can be used standalone with little modifications.
This product fills the following quality criteria:
- Unit tests provided
- Good documentation provided
- Commented code
- PyPi eggs provided
Cron like "on day/hour/minute X" like subscribers could be added.
Released Apr 24, 2012 — tested with Plone 4.1, Plone 4, Plone 3
Added logging level option for tick_logger and fixed issues with data storage
More about this release…
- Get collective.timedevents for all platforms
- If you are using Plone 3.2 or higher, you probably want to install this product with buildout. See our tutorial on installing add-on products with buildout for more information.
|0.2.1||Apr 24, 2012||Added logging level option for tick_logger and fixed issues with data storage More about this release…||
|0.1.1||Nov 04, 2008||Fixed PyPi egg More about this release…||
|0.1||Nov 04, 2008||Initial release More about this release…||