Add-on to the TWiki kernel that supports e-mail notification of changes. allows users to "subscribe" to regularly scheduled e-mails containing either:

• A report on changes to all topics that have changed within a particular TWiki web.
• A report on changes to a specific topic or set of topics the user can define flexibly.
• The entire content of a specific topic or set of topics. This is referred to as "news mode."

Summary of Contents

tools/mailnotify

tools/mailnotify

The central component of MailerContrib is a script, tools/mailnotify, that generates and sends out the emails based on analysis of

The main part of the mailer module is a script, tools/mailnotify. This script is designed to be run from 'cron' (or an equivalent offline job scheduler), and processes the contents of the standard WebNotify topic. As well as providing the usual notification service, it also provides per-topic notification services. The script may be run from the command line or a cron job.

1. users' subcriptions listed in the WebNotify topic in each web, and
2. changes within the respective webs.

Subscribers are listed in WebNotify following one of This script is designed to be run from these bullet list formats: cron (or an equivalent off-line job scheduler), or from the command-line.

The script collates the changes emails so that each subscriber only receives one changes notification for all changes in all webs in the TWiki. Furthermore, users can elect to receive just summaries of changes, or the entire content of topics that have changed.

Each web can optionally contain a topic called WebNotify.

Users subscribe to email notifications using their WikiName or an alternative email address, and can specify the webs/topics they wish to track using one of these bullet list formats:

where In the above examples, topicsis a space-separated list of topic names. The user may further customize the specific content they will receive using the following formats:

• Specify topics without a Web. prefix
• Topics must exist in this web.
• Topics may be specified using * wildcards
• Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic" (the same as not putting anything). The '-' sign means "unsubscribe" or "don't send notifications regarding this topic". This allows users to elect to filter out certain topics (and their children, to an arbitrary depth). Topic filters ('-') take precedence over topic includes ('+').
• Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. Note This uses the TWiki "Topic parent" feature.
• Each topic may optionally be preceded immediately followed by a '+' an exclamation mark ! or '-' sign. The '+' sign means "subscribe to this topic" (the same a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as not putting anything). The well) should be mailed '-' sign means "don't send notifications regarding this topic". This allows users to elect to filter out changes as to certain topics (and their children, to an arbitrary depth). Topic filters ('-') take precedence over topic includes ('+'). complete topics instead of change summaries. ! causes the topic to be mailed every time even if there have been no changes, ? will mail the topic only if there have been changes to it. This only makes sense for subscriptions.

For example: Subscribe Daisy to all changes to topics in this web.

* daisy@flowers.com daisy.cutter@flowers.com * daisy@flowers.com: Web* * DaisyCutter: Petal* (1) WeedKillers (3) Red*Phlox * StarTrekFan: * - *Wars - *sInTheirEyes - *shipTroopers 

A user may Subscribe Daisy to be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified of changes to in all webs that topic start with onceWeb.

   * daisy.cutter@flowers.com: Web*

Subscribe Daisy to changes to topics starting with Petal, and their immediate children, WeedKillers and children to a depth of 3, and all topics that match start with Pretty and end with Flowers e.g. PrettyPinkFlowers

   * DaisyCutter: Petal* (1) WeedKillers (3) Pretty*Flowers

Subscribe StarTrekFan to changes to all topics that start with Star except those that end in Wars, sInTheirEyes or shipTroopers.

   * StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopers

Subscribe Daisy to the full content of NewsLetter whenever it has changed

   * daisy@flowers.com: NewsLetter?

Subscribe buttercup to NewsLetter and its immediate children, even if it hasn't changed.

   * buttercup@flowers.com: NewsLetter! (1)

Subscribe GardenGroup (which includes Petunia) to all changed topics under AllnewsLetters to a depth of 3. Then unsubscribe Petunia from the ManureNewsLetter, which she would normally get as a member of GardenGroup?:

   * GardenGroup: AllNewsLetters? (3)
   * petunia@flowers.com: - ManureNewsLetter

A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified about changes that topic once (though they will still receive individual mails for news topics).

Note mailnotifyignores permissions in webs. It is entirely possible for a user to get added to a WebNotify topic one of the subscription topics in a web, when they are not authorised to view the topics in that web. This could result in them having limited access to sensitive information (the topic summaries). information, particularly with news mode.

TWiki/Contrib/MailerContrib code library

Note that when using the "news mode" ! or ? specifiers are used the entire topic text is mailed out as HTML. The newsletter template is used to generate the content in this mail, using whatever skin is selected in the topic being mailed.

The second In addition, part of the module is a code library that %STARTPUBLISH% and %STOPPUBLISH% markers used by provides the services for other applications to modify WebNotify through a clean, well documented interface. This allows (for example) plugin developers to add a "Register me for notification" button to their pages. The main interface is the WebNotifyTWiki:Plugins.PublishContribpackage described below. to delimit the text to be published are respected.

Installation Instructions

TWiki/Contrib/MailerContrib code library

This Contrib The second is pre-installed as part of the TWiki release package, and should only have module is a code library that provides the services for other applications to be re-installed if an upgrade modify the subscription topics through a clean, well documented API. This allows (for example) plugin developers to add (for example) a "Register me for this newsletter" button to their pages. The main interface is required. the WebNotify package described below.

• Download the ZIP file from the Plugin web (see below)
• Unzip MailerContrib.zip in your twiki installation directory.
• Run the installer script MailContrib_intaller.pl or alternatively resolve all dependencies manually.
• To make sure the installation was successful, run the mailnotify script from the command line, with no parameters. In this case it will print out what it would have done to STDOUT.

package TWiki::Contrib::MailerContrib::WebNotify

Setting up your cron job

Object that represents the contents of a WebNotify topic in a TWiki web

You need to set up a cron (or equivalent) job to run mailnotify.

ClassMethod new($web, $topic)

Usage: perl -I <bin> mailnotify [-q] [ web1 web2 ... webN ] Create a new object by parsing the content of the given topic in the given web. This is the normal way to load a is the path to the TWiki bin directory (usually WebNotify../bin topic. If the topic does not exist, it will create an empty object. ), so that the script can find the rest of TWiki.

ObjectMethod writeWebNotify()

For example, Write the object to the perl -I /usr/local/twiki/bin mailnotify -q Public PrivateWebNotifywill generate notifications for topic it was read from. If there is a problem writing the Public and Private webs. topic (e.g. it is locked), the method will return an error message. If everything is ok it will return undef.

Settings ObjectMethod getSubscriber($name, $noAdd)

• Set STUB = TWiki::Contrib::Mailer $name - Name of subscriber (wikiname with no web or email address)
• Set SHORTDESCRIPTION = Supports e-mail notification of changes. $noAdd - If false or undef, a new subscriber will be created for this name

Get a subscriber from the list of subscribers, and return a reference to the Subscriber object. If $noAdd is true, and the subscriber is not found, undef will be returned. Otherwise a new Subscriber object will be added if necessary.

ObjectMethod getSubscribers()

Get a list of all subscriber names (unsorted)

ObjectMethod subscribe($name, $topics, $depth)

• $name - Name of subscriber (wikiname with no web or email address)
• $topics - wildcard expression giving topics to subscribe to
• $depth - Child depth to scan (default 0)
• $mode - ! if this is a non-changes subscription and the topics should be mailed evebn if there are no changes. ? to mail the full topic only if there are changes. undef to mail changes only.

Add a subscription, adding the subscriber if necessary.

ObjectMethod unsubscribe($name, $topics, $depth)

• $name - Name of subscriber (wikiname with no web or email address)
• $topics - wildcard expression giving topics to subscribe to
• $depth - Child depth to scan (default 0)

Add an unsubscription, adding the subscriber if necessary. An unsubscription is a specific request to ignore notifications for a topic for this particular subscriber.

ObjectMethod stringify() -> string

Return a string representation of this object, in WebNotify format.

ObjectMethod processChange($change, $db, $changeSet, $seenSet, $allSet)

• $change - ref of a TWiki::Contrib::Mailer::Change
• $db - TWiki::Contrib::MailerContrib::UpData database of parent references
• $changeSet - ref of a hash mapping emails to sets of changes
• $seenSet - ref of a hash recording indices of topics already seen
• $allSet - ref of a hash that maps topics to email addresses for news subscriptions

Find all subscribers that are interested in the given change. Only the most recent change to each topic listed in the .changes file is retained. This method does not change this object.

ObjectMethod processCompulsory($topic, $db, \%allSet)

• $topic - topic name
• $db - TWiki::Contrib::MailerContrib::UpData database of parent references
• \%allSet - ref of a hash that maps topics to email addresses for news subscriptions

ObjectMethod isEmpty() -> boolean

Return true if there are no subscribers

package TWiki::Contrib::MailerContrib::Subscriber

Object that represents a subscriber to notification. A subscriber is a name (which may be a wikiName or an email address) and a list of subscriptions which describe the topis subscribed to, and unsubscriptions representing topics they are specifically not interested in. The subscriber name may also be a group, so it may expand to many email addresses.

ClassMethod new($name)

• $name - Wikiname, with no web, or email address, of user targeted for notification

Create a new user.

ObjectMethod getEmailAddresses() -> list

Get a list of email addresses for the user(s) represented by this subscription

ObjectMethod subscribe($subs)

• $subs - Subscription object

Add a new subscription to this subscriber object. The subscription will always be added, even if there is a wildcard overlap with an existing subscription.

ObjectMethod unsubscribe($subs)

• $subs - Subscription object

Add a new unsubscription to this subscriber object. The unsubscription will always be added, even if there is a wildcard overlap with an existing subscription or unsubscription.

An unsubscription is a statement of the subscribers desire not to be notified of changes to this topic.

ObjectMethod isSubscribedTo($topic) -> $subscription

• $topic - Topic object we are checking
• $db - TWiki::Contrib::MailerContrib::UpData database of parents

Check if we have a subscription to the given topic. Return the subscription that matches if we do, undef otherwise.

ObjectMethod isUnsubscribedFrom($topic) -> $subscription

• $topic - Topic object we are checking
• $db - TWiki::Contrib::MailerContrib::UpData database of parents

Check if we have an unsubscription from the given topic. Return the subscription that matches if we do, undef otherwise.

ObjectMethod stringify() -> string

Return a string representation of this object, in WebNotify format.

package TWiki::Contrib::MailerContrib::Subscription

Object that represents a single subscription of a user to notification on a page. A subscription is expressed as a page spec (which may contain wildcards) and a depth of children of matching pages that the user is subscribed to.

ClassMethod new($pages, $childDepth, $news)

• $pages - Wildcarded expression matching subscribed pages
• $childDepth - Depth of children of $topic to notify changes for. Defaults to 0
• $mode - ! if this is a non-changes subscription and the topics should be mailed evebn if there are no changes. ? to mail the full topic only if there are changes. undef to mail changes only.

Create a new subscription.

ObjectMethod stringify() -> string

Return a string representation of this object, in WebNotify format.

ObjectMethod matches($topic, $db, $depth) -> boolean

• $topic - Topic object we are checking
• $db - TWiki::Contrib::MailerContrib::UpData database of parent names
• $depth - If non-zero, check if the parent of the given topic matches as well. undef = 0.

Check if we match this topic. Recurses up the parenthood tree seeing if this is a child of a parent that matches within the depth range.

ObjectMethod getMode() -> $mode

Return ! if this is a non-changes subscription and the topics should be mailed even if there are no changes. ? to mail the full topic only if there are changes. undef to mail changes only.

package TWiki::Contrib::MailerContrib::Change

Object that represents a change to a topic.

ClassMethod new($web)

• $web - Web name
• $topic - Topic name
• $author - String author of change
• $time - String time of change
• $rev - Revision identifier

Construct a new change object.

ObjectMethod merge($change)

• $change - Change record to merge

Merge another change record with this one, so that the combined record is a reflection of both changes.

ObjectMethod expandHTML($html) -> string

• $html - Template to expand keys within

Expand an HTML template using the values in this change. The following keys are expanded: %TOPICNAME%, %AUTHOR%, %TIME%, %REVISION%, %TEXTHEAD%.

Returns the expanded template.

ObjectMethod expandPlain() -> string

Generate a plaintext version of this change.

package TWiki::Contrib::MailerContrib::UpData

Object that lazy-scans topics to extract parent relationships.

ClassMethod new($web)

• $web - Web we are building parent relationships for

Constructor for a web; initially empty, will lazy-load as topics are referenced.

ObjectMethod getParent($topic) -> string

Get the name of the parent topic of the given topic

package TWiki::Contrib::Mailer

Package of support for extended WebNotify notification, supporting per-topic notification and notification of changes to children.

Also supported is a simple API that can be used to change the WebNotify topic from other code.

StaticMethod mailNotify($webs, $session, $verbose)

• $webs - filter list of names webs to process. Wildcards (*) may be used.
• $session - optional session object. If not given, will use a local object.
• $verbose - true to get verbose (debug) output

Main entry point.

Process the WebNotify topics in each web and generate and issue notification mails. Designed to be invoked from the command line; should only be called by mailnotify scripts.

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

• If you have TWiki 4.1 or later, and Perl 5.8, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • The webserver user has to have permission to write to all areas of your installation for this to work.
• If you have a permanent connection to the internet (and Perl 5.8), you are recommended to use the automatic installer script
  • Just download the MailerContrib_installer perl script and run it.
• Notes:
  • The installer script will:
    • Automatically resolve dependencies,
    • Copy files into the right places in your local install (even if you have renamed data directories),
    • check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
    • If the $TWIKI_PACKAGES environment variable is set to point to a directory, the installer will try to get archives from there. Otherwise it will try to download from twiki.org or cpan.org, as appropriate.
    • (Developers only: the script will look for twikiplugins/MailerContrib/MailerContrib.tgz before downloading from TWiki.org)
  • If you don't have a permanent connection, you can still use the automatic installer, by downloading all required TWiki archives to a local directory.
    • Point the environment variable $TWIKI_PACKAGES to this directory, and the installer script will look there first for required TWiki packages.
      • $TWIKI_PACKAGES is actually a path; you can list several directories separated by :
    • If you are behind a firewall that blocks access to CPAN, you can build a local CPAN mini-mirror, as described at http://twiki.org/cgi-bin/view/Codev/BuildingDakar#CPAN_local_minimirror
• If you don't want to use the installer script, or have problems on your platform (e.g. you don't have Perl 5.8), then you can still install manually:
  1. Download and unpack one of the .zip or .tgz archives to a temporary directory.
  2. Manually copy the contents across to the relevant places in your TWiki installation.
  3. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
  4. Manually edit LocalSite.cfg to set any configuration variables.
  5. Run configure and enable the module, if it is a plugin.
  6. Repeat from step 1 for any missing dependencies.

• To make sure the installation was successful, run the mailnotify script from the command line, with no parameters. In this case it will print out what it would have done to STDOUT.

Setting up your cron job(s)

You need to set up a cron (or equivalent) job to run tools/mailnotify.

Usage: perl -I <bin> mailnotify [-q] [-news] [ web1 web2 ... webN ] <bin> is the path to the TWiki bin directory, so that the script can find the rest of TWiki.

For example, assuming TWiki was installed at /usr/local/twiki, this cron entry:

0 0 * * * cd /usr/local/twiki && perl -I bin tools/mailnotify -q Public Private

will generate change notifications for the Public and Private webs every night at midnight.

0 0 * * 0 cd /usr/local/twiki && perl -I bin tools/mailnotify -news

will generate newsletters from all webs every week on midnight Saturday.

Developer Notes

The changes mails sent to users are based on a TWiki template called mailnotify. This template must contain the following definitions.

The default template sends multipart mails containing both HTML and plaintext versions. You can easily provide a custom version of this template using a local skin.

Newsletters are sent after formatting using the standard view template, using whatever skin is selected in the topic being mailed.