wiki:AnnouncerPlugin

Version 4 (modified by ixokai, 6 years ago) (diff)

--

Flexible notifications for Trac

Description

The AnnouncerPlugin is meant to provide an extensible, user-customizable notification system that can be used to completely replace Trac's default notifications.

At the very least, it will allow users to receive notices about attachments, and to opt-out from receiving messages due to the always_notify_(owner|reporter|updater) options.

The full system (in the not-too-distant-future) will allow users to 'subscribe' to certain events by specifying simple yet powerful rules, such as asking to receive an announcement for any change that involves a ticket with a priority greater then 'high'. Later, a 'watch' feature is intended to replace CC usage, and allow watching of wiki-pages, and then to enable other plug-ins to provide new means for registering messages that users can subscribe to.

The AnnouncerPlugin is meant to be agnostic to what is being watched; where you should send something (email, IRC, jabber, ...), and what format it should look at. All in good time.

I've gone over the various tickets on t.e.o related to notification, and have summarized them at AnnouncerPlugin/Concerns for reference to keep in mind while developing the system.

Status

This code is ALPHA at present, and NOT suitable for general use.

Bugs/Feature Requests

Existing bugs and feature requests for AnnouncerPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out AnnouncerPlugin from here using Subversion, or browse the source with Trac.

Example

Initially(very soon now), it'll simply be a drop-in replacement for the default notifications, extending them to include attachment additions and deletions, and allowing users to opt-out from receiving notices normally sent because of the always_notify_* options.

Recent Changes

[12503] by hasienda on 2013-01-02 21:37:29
AnnouncerPlugin: Extend AccountManager notifications as required, refs #843, #7759 and #7977.

Note, that any previous version of TracAnnouncer won't work with latest
AccountManagerPlugin 'trunk' code, and this already made me thinking about
a more robust change listener definition. But this is another subject.

[12407] by rjollos on 2012-12-06 02:31:07
Added entries to .gitignore for some pydev project files.
[12402] by rjollos on 2012-12-04 07:39:17
Refs #10584: In [12359], the full path to attachment_notification.html was not being used.

Author/Contributors

Author: ixokai
Contributors:

Attachments (6)

Download all attachments as: .zip