Changeset 5269

Timestamp:

10/15/09 19:28:59 (2 years ago)

Author:

KennethLavrsen

Message:

Item2260: MailerContrib cannot find email templates based on skin or web
The checkin does the following

• It makes a tiny little fix in MailerContrib.pm where I pushTopicContext before loading mail template and pop it again afterwards
• Updates the the documentation to show by example how to tailor the mail message
• Merge over the code from trunk. This introduces a bug fix from Item1603 which for some reason was only applied to trunk
• And with this merge also merge over a lot of perl tinying.

It was too difficult to separate the two once I was this far. Look at next checkin in trunk to see only the actual code changes

Location:

branches/Release01x00/MailerContrib

Files:

• data/System/MailerContrib.txt (modified) (3 diffs)
• lib/Foswiki/Contrib/MailerContrib.pm (modified) (25 diffs)
• lib/Foswiki/Contrib/MailerContrib/Change.pm (modified) (8 diffs)
• lib/Foswiki/Contrib/MailerContrib/CompatibilityHacks.pm (modified) (3 diffs)
• lib/Foswiki/Contrib/MailerContrib/Config.spec (modified) (2 diffs)
• lib/Foswiki/Contrib/MailerContrib/Constants.pm (modified) (2 diffs)
• lib/Foswiki/Contrib/MailerContrib/Subscriber.pm (modified) (9 diffs)
• lib/Foswiki/Contrib/MailerContrib/Subscription.pm (modified) (7 diffs)
• lib/Foswiki/Contrib/MailerContrib/TopicContext.pm (modified) (1 diff)
• lib/Foswiki/Contrib/MailerContrib/UpData.pm (modified) (2 diffs)
• lib/Foswiki/Contrib/MailerContrib/WebNotify.pm (modified) (17 diffs)
• lib/Foswiki/Contrib/MailerContrib/build.pl (modified) (3 diffs)
• tools/mailnotify (modified) (1 diff)

branches/Release01x00/MailerContrib/data/System/MailerContrib.txt

@@ -136 +136 @@
 
 <!--
-   * Set SHORTDESCRIPTION = Supports e-mail notification of changes.
+   * Set SHORTDESCRIPTION = %$SHORTDESCRIPTION%
 -->
----++ Developer Notes
+---+++ Tailoring the email format
 The changes mails sent to subscribers are based on a Foswiki template called =mailnotify=. This template must contain the following definitions. 
 | =HTML:before= | Section of a HTML mail before the changes |
@@ -147 +147 @@
 | =PLAIN:after= | Section of a plain text mail after the changes |
 | =MailNotifyBody= | All the above are embedded in this. %<nop>HTML_TEXT% expands to the HTML obtained by expanding the =HTML:*= templates, and %<nop>PLAIN_TEXT% from the =PLAIN:*= templates. |
-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.
+The default template sends multipart mails containing both HTML and plaintext versions.
+
+To tailor the email format please avoid editing the distributed mailnotify.tmpl file as you will regret when it later gets overwritten when you upgrade Foswiki. Instead you should either use a skin setting to choose the template file or use web part of the [[%SYSTEMWEB%.SkinTemplates#FindingTemplates][template search path rules]]. 
+   
+It is recommended to use the skin method as it is easier to control, and requires less hacking around. Especially if you need to use the same tailoring for many or all webs.
+
+   * Simple global tailoring used in all webs using your normal default skin
+      * Make a copy of =templates/mailnotify.tmpl= called =templates/mailnotify.skiname.tmpl=. For example =templates/mailnotify.pattern.tmpl= and modify this copy to your need. If you use the !NatSkin simply use =templates/mailnotify.nat.tmpl= instead
+
+   * Using a dummy skin name globally
+      * In !%USERSWEB%.SitePreferences define a setting =* Set SKIN = notifyskin,pattern= where the notifyskin is the dummy skin name and the pattern in this example is the real skin.
+      * Create a =templates/mailnotify.notifyskin.tmpl= with your tailorings
+   
+   * Using a dummy skin name per web
+      * In each web where you want a special mailnotify template add the setting =* Set SKIN = notifywebname,pattern= where the notifywebname is the dummy skin name for this web and the pattern in this example is the real skin.
+      * For each web where you need a special mailnotify template create a =templates/mailnotify.notifywebname.tmpl= with your tailorings
+   
+   * Using the web path in the templates directory
+      * For each web where you want a special mailnotify create subdirectories in =templates= with the same names as the webs and place a =templates/mailnotify.tmpl= in these subdirectories with your tailorings
 
 Newsletters are sent after formatting using the standard =view= template, using whatever skin is selected in the topic being mailed.
+
+---+++ Using a topic defined email template
+
+If you want to use a topic to define the notify email format this is possible with a small workaround. Before you go ahead and do this you need to consider the security implication. Making the email format available to any user from a browser means that spammers can abuse this to create messages where they can spoof the from address. Only use this method if your Foswiki installation is safely behind a firewall and your users can be trusted.
+
+The method can best be shown with an example. In the following we...
+
+   * Define a custom mailnotify template based on a skin setting in !WebNotify
+   * Allow the users to define the mail format in a topic called !WebNotifyCustomTemplate
+
+Here are the steps
+
+First we create a file =templates/mailnotify.customnotify.tmpl= which only contains these two lines
+
+<verbatim>
+%TMPL:INCLUDE{"mailnotify"}%
+%TMPL:INCLUDE{"WebNotifyCustom"}%
+</verbatim>
+
+In the webs where you want the topic defined mail format we add the setting =* Set SKIN = customnotify,pattern= (assuming pattern is the normal skin)
+
+And we create a topic in the web called !WebNotifyCustomTemplate which contains the entire mailnotify template you want to use. Simply copy the content from =templates/mailnotify.tmpl= to this template and do the tailoring.
 
 ---+++ Contrib Info
@@ -160 +200 @@
 
 |  Author: | [[http://c-dot.co.uk][Crawford Currie]] |
-|  Copyright &copy;: | 2004, Wind River Systems; 2008, http://WikiRing.com |
+|  Copyright &copy;: | 2004, Wind River Systems; 2008, http://WikiRing.com; 2009 Foswiki Contributors |
 |  License: | GPL |
 |  Version: | %$VERSION% |
 |  Release: | %$RELEASE% |
 |  Change History: | |
+|  15 Oct 2009 | Foswikitask:Item2260. Make the feature that allows defining the email template based in either skin or web path. And improve the documentation so people can learn how to tailor the emails that the WebNotify feature sends. <br /> Foswikitask:Item1603: use quotes to protect topic names with odd characters in them |
 |  20 Sep 2009 | Small documentation update for Foswiki 1.0.7 release (RELEASE and adding parent) |
 |  23 Apr 2009 | Foswikitask:Item1501: Minor bug in logfile output fixed |

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib.pm

@@ -15 +15 @@
 use strict;
 
-use URI;
+use URI ();
 use CGI qw(-any);
 
-require Foswiki;
-require Foswiki::Plugins;
-require Foswiki::Time;
-require Foswiki::Func;
-require Foswiki::Contrib::MailerContrib::WebNotify;
-require Foswiki::Contrib::MailerContrib::Change;
-require Foswiki::Contrib::MailerContrib::UpData;
-
-use vars qw ( $VERSION $RELEASE $verbose );
-
-$VERSION = '$Rev$';
-$RELEASE = '20 Sep 2009';
+use Foswiki                                    ();
+use Foswiki::Plugins                           ();
+use Foswiki::Time                              ();
+use Foswiki::Func                              ();
+use Foswiki::Contrib::MailerContrib::WebNotify ();
+use Foswiki::Contrib::MailerContrib::Change    ();
+use Foswiki::Contrib::MailerContrib::UpData    ();
+
+our $VERSION = '$Rev$';
+our $RELEASE = '15 Oct 2009';
+our $SHORTDESCRIPTION = 'Supports e-mail notification of changes';
+
+our $verbose = 0;
 
 # PROTECTED STATIC ensure the contrib is initernally initialised
@@ -54 +55 @@
 
 sub mailNotify {
-    my( $webs, $twiki, $noisy, $exwebs ) = @_;
+    my ( $webs, $twiki, $noisy, $exwebs ) = @_;
 
     $verbose = $noisy;
 
     my $webstr;
-    if ( defined( $webs )) {
+    if ( defined($webs) ) {
         $webstr = join( '|', @$webs );
     }
-    $webstr = '*' unless ( $webstr );
+    $webstr = '*' unless ($webstr);
     $webstr =~ s/\*/\.\*/g;
 
     my $exwebstr = '';
-    if ( defined( $exwebs )) {
+    if ( defined($exwebs) ) {
         $exwebstr = join( '|', @$exwebs );
     }
     $exwebstr =~ s/\*/\.\*/g;
 
-    if (!defined $twiki) {
+    if ( !defined $twiki ) {
         $twiki = new Foswiki();
     }
@@ -87 +88 @@
 
     my $report = '';
-    foreach my $web ( Foswiki::Func::getListOfWebs( 'user ') ) {
-       if ( $web =~ /^($webstr)$/ && $web !~ /^($exwebstr)$/ ) {
-          $report .= _processWeb( $twiki, $web );
-       }
+    foreach my $web ( Foswiki::Func::getListOfWebs('user ') ) {
+        if ( $web =~ /^($webstr)$/ && $web !~ /^($exwebstr)$/ ) {
+            $report .= _processWeb( $twiki, $web );
+        }
     }
 
@@ -103 +104 @@
 
 sub changeSubscription {
-    my ($defaultWeb, $who, $topicList, $unsubscribe) = @_;
-
-    #we can get away with a normalise on a list of topics, so long as the list starts with a topic
-    my ($web, $t) = Foswiki::Func::normalizeWebTopicName($defaultWeb, $topicList);
+    my ( $defaultWeb, $who, $topicList, $unsubscribe ) = @_;
+
+#we can get away with a normalise on a list of topics, so long as the list starts with a topic
+    my ( $web, $t ) =
+      Foswiki::Func::normalizeWebTopicName( $defaultWeb, $topicList );
+
     #TODO: this limits us to subscribing to one web.
     my $wn = new Foswiki::Contrib::MailerContrib::WebNotify(
@@ -115 +118 @@
 }
 
-
 =pod
 ---+++ isSubscribedTo ($web, $who, $topicList) -> boolean
@@ -126 +128 @@
 
 sub isSubscribedTo {
-    my ($defaultWeb, $who, $topicList) = @_;
-    
+    my ( $defaultWeb, $who, $topicList ) = @_;
+
     my $subscribed = {
-                        currentWeb=>$defaultWeb,
-                        topicSub=>\&_isSubscribedToTopic
-                    };
-
-    my $ret = Foswiki::Contrib::MailerContrib::parsePageList($subscribed, $who, $topicList);
-    
-    return (!defined($subscribed->{not_subscribed}) ||
-                (0 == scalar($subscribed->{not_subscribed})) );
-}
+        currentWeb => $defaultWeb,
+        topicSub   => \&_isSubscribedToTopic
+    };
+
+    my $ret = parsePageList( $subscribed, $who, $topicList );
+
+    return ( !defined( $subscribed->{not_subscribed} )
+          || ( 0 == scalar( $subscribed->{not_subscribed} ) ) );
+}
+
 sub _isSubscribedToTopic {
     my ( $subscribed, $who, $unsubscribe, $topic, $options, $childDepth ) = @_;
-    
+
     require Foswiki::Contrib::MailerContrib::WebNotify;
-    my ($sweb, $stopic) = Foswiki::Func::normalizeWebTopicName($subscribed->{currentWeb}, $topic);
-
-    #TODO: extract this code so we only create $wn objects for each web once..    
-    my $wn = new Foswiki::Contrib::MailerContrib::WebNotify( $Foswiki::Plugins::SESSION, $sweb, $Foswiki::cfg{NotifyTopicName} );
+    my ( $sweb, $stopic ) =
+      Foswiki::Func::normalizeWebTopicName( $subscribed->{currentWeb}, $topic );
+
+    #TODO: extract this code so we only create $wn objects for each web once..
+    my $wn = new Foswiki::Contrib::MailerContrib::WebNotify(
+        $Foswiki::Plugins::SESSION, $sweb, $Foswiki::cfg{NotifyTopicName} );
     my $subscriber = $wn->getSubscriber($who);
-    
-    my $db = new Foswiki::Contrib::MailerContrib::UpData( $Foswiki::Plugins::SESSION, $sweb );
+
+    my $db =
+      new Foswiki::Contrib::MailerContrib::UpData( $Foswiki::Plugins::SESSION,
+        $sweb );
+
     #TODO: need to check $childDepth topics too (somehow)
-    if ( $subscriber->isSubscribedTo($stopic, $db) &&
-         (!$subscriber->isUnsubscribedFrom($stopic, $db))) {
-        push(@{$subscribed->{subscribed}}, $stopic);
-    } else {
-        push(@{$subscribed->{not_subscribed}}, $stopic);
-    }
-    return '';
+    if ( $subscriber->isSubscribedTo( $stopic, $db )
+        && ( !$subscriber->isUnsubscribedFrom( $stopic, $db ) ) )
+    {
+        push( @{ $subscribed->{subscribed} }, $stopic );
+    }
+    else {
+        push( @{ $subscribed->{not_subscribed} }, $stopic );
+    }
 }
 
 =pod
+
 ---+++ sub parsePageList ( $object, $who, $spec, $unsubscribe ) => unprocessable remainder of $spec line
-calls the $topicSub (ref to sub) once per identified topic entry.
-   * $object (is a hashref) can be used to set status' and its definition is dependent on $topicSub
-   * $object->{topicSub} _must_ be a sub ref and _must_ return an empty string
-   * $unsubscribe can be set to '-' to force an unsubscription (used by SubscribePlugin)
-   
-   $object is a functor.
+Calls the $object->{topicSub} once per identified topic entry.
+   * $object (a hashref) may be a hashref that has the field, =topicSub=,
+     which _may_ be a sub ref as follows:
+     =&topicSub($object, $who, $unsubscribe, $webTopic, $options, $childDepth)=
+   * =$unsubscribe= can be set to '-' to force an unsubscription
+     (used by SubscribePlugin)
 
 =cut
@@ -172 +182 @@
 sub parsePageList {
     my ( $object, $who, $spec, $unsubscribe ) = @_;
+
     #ASSERT(defined($object->{topicSub}));
-    
-    return $spec if (!defined($object->{topicSub}));
-    
+
+    return $spec if ( !$object || !defined( $object->{topicSub} ) );
+
     $spec =~ s/,/ /g;
-    #TODO: refine the $2 regex to be proper web.topic/topic/* style..
-    while ($spec =~ s/^\s*([+-])?\s*([\w.\*]+)([!?]?)\s*(?:\((\d+)\))?/&{$object->{topicSub}}($object, $who, $unsubscribe||$1, $2, $3, $4)/e) {
-        #go
+
+    # $1: + or -, optional
+    # $2: the wildcarded topic specifier (may be quoted)
+    # TODO: refine the $2 regex to be proper web.topic/topic/* style..
+    # $3: options
+    # $4: child depth
+    while ( $spec =~
+              s/^\s*([+-])?\s*([*\w.]+|'.*?'|".*?")([!?]?)\s*(?:\((\d+)\))?//) {
+        my ( $us, $webTopic, $options, $childDepth ) = (
+            $unsubscribe||$1||'+', $2, $3, $4||0 );
+        $webTopic =~ s/^(['"])(.*)\1$/$2/; # remove quotes
+        &{$object->{topicSub}}(
+            $object, $who, $us, $webTopic, $options, $childDepth);
+        #go
     }
     return $spec;
 }
-
 
 # PRIVATE: Read the webnotify, and notify changes
 sub _processWeb {
-    my( $twiki, $web) = @_;
-
-    if( ! Foswiki::Func::webExists( $web ) ) {
-#        print STDERR "**** ERROR mailnotifier cannot find web $web\n";
+    my ( $twiki, $web ) = @_;
+
+    if ( !Foswiki::Func::webExists($web) ) {
+
+        # print STDERR "**** ERROR mailnotifier cannot find web $web\n";
         return '';
     }
@@ -199 +221 @@
 
     # Read the webnotify and load subscriptions
-    my $wn = new Foswiki::Contrib::MailerContrib::WebNotify(
-        $twiki, $web, $Foswiki::cfg{NotifyTopicName} );
+    my $wn =
+      new Foswiki::Contrib::MailerContrib::WebNotify( $twiki, $web,
+        $Foswiki::cfg{NotifyTopicName} );
     if ( $wn->isEmpty() ) {
         print "\t$web has no subscribers\n" if $verbose;
-    } else {
+    }
+    else {
+
         # create a DB object for parent pointers
         print $wn->stringify(1) if $verbose;
@@ -223 +248 @@
 
     my $timeOfLastNotify = 0;
-    if( open(F, "<$notmeta")) {
+    if ( open( F, '<', $notmeta ) ) {
         local $/ = undef;
         $timeOfLastNotify = <F>;
@@ -229 +254 @@
     }
 
-    if ( $verbose ) {
-        print "\tLast notification was at " .
-          Foswiki::Time::formatTime( $timeOfLastNotify, 'iso' ). "\n";
+    if ($verbose) {
+        print "\tLast notification was at "
+          . Foswiki::Time::formatTime( $timeOfLastNotify, 'iso' ) . "\n";
     }
 
@@ -252 +277 @@
     my %allSet;
 
-    if( !defined( &Foswiki::Func::eachChangeSince )) {
+    if ( !defined(&Foswiki::Func::eachChangeSince) ) {
         require Foswiki::Contrib::MailerContrib::CompatibilityHacks;
     }
@@ -258 +283 @@
     # + 1 because the 'since' check is >=
     my $it = Foswiki::Func::eachChangeSince( $web, $timeOfLastNotify + 1 );
-    while( $it->hasNext() ) {
+    while ( $it->hasNext() ) {
         my $change = $it->next();
         next if $change->{more} && $change->{more} =~ /minor$/;
@@ -264 +289 @@
         next unless Foswiki::Func::topicExists( $web, $change->{topic} );
 
-        $timeOfLastChange = $change->{time} unless( $timeOfLastChange );
-
-        print "\tChange to $change->{topic} at ".
-          Foswiki::Time::formatTime( $change->{time}, 'iso' ).
-              ". New revision is $change->{revision}\n" if ( $verbose );
+        $timeOfLastChange = $change->{time} unless ($timeOfLastChange);
+
+        print "\tChange to $change->{topic} at "
+          . Foswiki::Time::formatTime( $change->{time}, 'iso' )
+          . ". New revision is $change->{revision}\n"
+          if ($verbose);
 
         # Formulate a change record, irrespective of
         # whether any subscriber is interested
-        $change = new Foswiki::Contrib::MailerContrib::Change(
-            $twiki, $web, $change->{topic}, $change->{user},
-            $change->{time}, $change->{revision} );
+        $change =
+          new Foswiki::Contrib::MailerContrib::Change( $twiki, $web,
+            $change->{topic}, $change->{user}, $change->{time},
+            $change->{revision} );
 
         # Now, find subscribers to this change and extend the change set
-        $notify->processChange(
-            $change, $db, \%changeset, \%seenset, \%allSet );
-    }
+        $notify->processChange( $change, $db, \%changeset, \%seenset,
+            \%allSet );
+    }
+
     # For each topic, see if there's a compulsory subscription independent
     # of the time since last notify
-    foreach my $topic (Foswiki::Func::getTopicList($web)) {
+    foreach my $topic ( Foswiki::Func::getTopicList($web) ) {
         $notify->processCompulsory( $topic, $db, \%allSet );
     }
 
     # Now generate emails for each recipient
-    my $report = _sendChangesMails(
-        $twiki, $web, \%changeset,
+    my $report =
+      _sendChangesMails( $twiki, $web, \%changeset,
         Foswiki::Time::formatTime($timeOfLastNotify) );
 
-    $report .= _sendNewsletterMails( $twiki, $web, \%allSet);
-
-    if ($timeOfLastChange != 0) {
-        if( open(F, ">$notmeta" )) {
+    $report .= _sendNewsletterMails( $twiki, $web, \%allSet );
+
+    if ( $timeOfLastChange != 0 ) {
+        if ( open( F, '>', $notmeta ) ) {
             print F $timeOfLastChange;
             close(F);
@@ -308 +336 @@
     my $report = '';
 
+    # We read the mailnotify template in the context (skin and web) or the
+    # WebNotify topic we are currently processing
+    Foswiki::Func::pushTopicContext( $web, $Foswiki::cfg{NotifyTopicName} );
     my $skin = Foswiki::Func::getSkin();
     my $template = Foswiki::Func::readTemplate( 'mailnotify', $skin );
+    Foswiki::Func::popTopicContext();
 
     my $homeTopic = $Foswiki::cfg{HomeTopicName};
 
-    my $before_html = Foswiki::Func::expandTemplate( 'HTML:before' );
-    my $middle_html = Foswiki::Func::expandTemplate( 'HTML:middle' );
-    my $after_html = Foswiki::Func::expandTemplate( 'HTML:after' );
-
-    my $before_plain = Foswiki::Func::expandTemplate( 'PLAIN:before' );
-    my $middle_plain = Foswiki::Func::expandTemplate( 'PLAIN:middle' );
-    my $after_plain = Foswiki::Func::expandTemplate( 'PLAIN:after' );
-
-    my $mailtmpl = Foswiki::Func::expandTemplate( 'MailNotifyBody' );
-    $mailtmpl = Foswiki::Func::expandCommonVariables(
-        $mailtmpl, $homeTopic, $web );
-    if( $Foswiki::cfg{RemoveImgInMailnotify} ) {
+    my $before_html = Foswiki::Func::expandTemplate('HTML:before');
+    my $middle_html = Foswiki::Func::expandTemplate('HTML:middle');
+    my $after_html  = Foswiki::Func::expandTemplate('HTML:after');
+
+    my $before_plain = Foswiki::Func::expandTemplate('PLAIN:before');
+    my $middle_plain = Foswiki::Func::expandTemplate('PLAIN:middle');
+    my $after_plain  = Foswiki::Func::expandTemplate('PLAIN:after');
+
+    my $mailtmpl = Foswiki::Func::expandTemplate('MailNotifyBody');
+    $mailtmpl =
+      Foswiki::Func::expandCommonVariables( $mailtmpl, $homeTopic, $web );
+    if ( $Foswiki::cfg{RemoveImgInMailnotify} ) {
+
         # change images to [alt] text if there, else remove image
         $mailtmpl =~ s/<img\s[^>]*\balt=\"([^\"]+)[^>]*>/[$1]/goi;
@@ -333 +366 @@
 
     foreach my $email ( keys %{$changeset} ) {
-        my $html = '';
+        my $html  = '';
         my $plain = '';
-        foreach my $change (sort { $a->{TIME} cmp $b->{TIME} }
-                            @{$changeset->{$email}} ) {
-
-            $html .= $change->expandHTML( $middle_html );
-            $plain .= $change->expandPlain( $middle_plain );
+        foreach my $change ( sort { $a->{TIME} cmp $b->{TIME} }
+            @{ $changeset->{$email} } )
+        {
+
+            $html  .= $change->expandHTML($middle_html);
+            $plain .= $change->expandPlain($middle_plain);
         }
 
@@ -363 +397 @@
         if ($error) {
             print STDERR "Error sending mail forf $web: $error\n";
-            $report .= $error."\n";
-        } else {
+            $report .= $error . "\n";
+        }
+        else {
             print "Notified $email of changes in $web\n" if $verbose;
             $sentMails++;
@@ -375 +410 @@
 
 sub relativeURL {
-    my( $base, $link ) = @_;
+    my ( $base, $link ) = @_;
     return URI->new_abs( $link, URI->new($base) )->as_string;
 }
 
 sub _sendNewsletterMails {
-    my ($twiki, $web, $allSet) = @_;
+    my ( $twiki, $web, $allSet ) = @_;
 
     my $report = '';
-    foreach my $topic (keys %$allSet) {
-        $report .= _sendNewsletterMail(
-            $twiki, $web, $topic, $allSet->{$topic});
+    foreach my $topic ( keys %$allSet ) {
+        $report .=
+          _sendNewsletterMail( $twiki, $web, $topic, $allSet->{$topic} );
     }
     return $report;
@@ -391 +426 @@
 
 sub _sendNewsletterMail {
-    my ($twiki, $web, $topic, $emails) = @_;
+    my ( $twiki, $web, $topic, $emails ) = @_;
     my $wikiName = Foswiki::Func::getWikiName();
 
@@ -397 +432 @@
 
     # Read topic data.
-    my ($meta, $text) = Foswiki::Func::readTopic( $web, $topic );
-
-    if (!defined( &Foswiki::Func::pushTopicContext )) {
+    my ( $meta, $text ) = Foswiki::Func::readTopic( $web, $topic );
+
+    if ( !defined(&Foswiki::Func::pushTopicContext) ) {
         require Foswiki::Contrib::MailerContrib::TopicContext;
     }
+
+    # SMELL: Have to hack into the core to set internal preferences :-(
+    my %old = map { $_ => undef } qw(BASEWEB BASETOPIC INCLUDINGWEB INCLUDINGTOPIC);
+    if (defined $Foswiki::Plugins::SESSION->{SESSION_TAGS}) {
+
+        # In 1.0.6 and earlier, have to handle some session tags ourselves
+        # because pushTopicContext doesn't do it. **
+        foreach my $macro (keys %old) {
+            $old{$macro} = Foswiki::Func::getPreferencesValue($macro);
+        }
+    }
     Foswiki::Func::pushTopicContext( $web, $topic );
+
+    # See ** above
+    if (defined $Foswiki::Plugins::SESSION->{SESSION_TAGS}) {
+        my $stags = $Foswiki::Plugins::SESSION->{SESSION_TAGS};
+        $stags->{BASEWEB} = $web;
+        $stags->{BASETOPIC} = $topic;
+        $stags->{INCLUDINGWEB} = $web;
+        $stags->{INCLUDINGTOPIC} = $topic;
+    }
 
     $twiki->enterContext( 'can_render_meta', $meta );
@@ -409 +464 @@
     my $skin = Foswiki::Func::getSkin();
     Foswiki::Func::readTemplate( 'newsletter', $skin );
-    my $header = Foswiki::Func::expandTemplate( 'NEWS:header' );
-    my $body = Foswiki::Func::expandTemplate( 'NEWS:body' );
-    my $footer = Foswiki::Func::expandTemplate( 'NEWS:footer' );
-
-    my ($revdate, $revuser, $maxrev);
-    ($revdate, $revuser, $maxrev) = $meta->getRevisionInfo();
+    my $header = Foswiki::Func::expandTemplate('NEWS:header');
+    my $body   = Foswiki::Func::expandTemplate('NEWS:body');
+    my $footer = Foswiki::Func::expandTemplate('NEWS:footer');
+
+    my ( $revdate, $revuser, $maxrev );
+    ( $revdate, $revuser, $maxrev ) = $meta->getRevisionInfo();
 
     # Handle standard formatting.
     $body =~ s/%TEXT%/$text/g;
+
     # Don't render the header, it is preformatted
-    $header = Foswiki::Func::expandCommonVariables($header, $topic, $web);
+    $header = Foswiki::Func::expandCommonVariables( $header, $topic, $web );
     my $tmpl = "$body\n$footer";
-    $tmpl = Foswiki::Func::expandCommonVariables($tmpl, $topic, $web);
-    $tmpl = Foswiki::Func::renderText($tmpl, "", $meta);
+    $tmpl = Foswiki::Func::expandCommonVariables( $tmpl, $topic, $web );
+    $tmpl = Foswiki::Func::renderText( $tmpl, "", $meta );
     $tmpl = "$header$tmpl";
 
@@ -432 +488 @@
     my $tagSeen = 0;
     my $publish = 1;
-    foreach my $s ( split( /(%STARTPUBLISH%|%STOPPUBLISH%)/, $tmpl )) {
-        if( $s eq '%STARTPUBLISH%' ) {
+    foreach my $s ( split( /(%STARTPUBLISH%|%STOPPUBLISH%)/, $tmpl ) ) {
+        if ( $s eq '%STARTPUBLISH%' ) {
             $publish = 1;
-            $newTmpl = '' unless( $tagSeen );
+            $newTmpl = '' unless ($tagSeen);
             $tagSeen = 1;
-        } elsif( $s eq '%STOPPUBLISH%' ) {
+        }
+        elsif ( $s eq '%STOPPUBLISH%' ) {
             $publish = 0;
             $tagSeen = 1;
-        } elsif( $publish ) {
+        }
+        elsif ($publish) {
             $newTmpl .= $s;
         }
@@ -453 +511 @@
     # Remove <base.../> tag
     $tmpl =~ s/<base[^>]+\/>//;
+
     # Remove <base...>...</base> tag
     $tmpl =~ s/<base[^>]+>.*?<\/base>//;
@@ -461 +520 @@
     $tmpl =~ s/(action=\")([^"]+)/$1.relativeURL($base,$2)/goei;
 
-    my $report = '';
+    my $report    = '';
     my $sentMails = 0;
 
@@ -482 +541 @@
         if ($error) {
             print STDERR "Error sending mail for $web: $error\n";
-            $report .= $error."\n";
-        } else {
+            $report .= $error . "\n";
+        }
+        else {
             print "Sent newletter for $web to $email\n" if $verbose;
             $sentMails++;
@@ -491 +551 @@
 
     Foswiki::Func::popTopicContext();
+
+    # SMELL: See ** above
+    if (defined $Foswiki::Plugins::SESSION->{SESSION_TAGS}) {
+
+            # In 1.0.6 and earlier, have to handle some session tags ourselves
+            # because pushTopicContext doesn't do it. **
+        foreach my $macro (keys %old) {
+            $Foswiki::Plugins::SESSION->{SESSION_TAGS}{$macro} =
+            $old{$macro};
+        }
+    }
 
     return $report;

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Change.pm

@@ -53 +53 @@
 
     $this->{SESSION} = $session;
-    $this->{WEB} = $web;
-    $this->{TOPIC} = $topic;
+    $this->{WEB}     = $web;
+    $this->{TOPIC}   = $topic;
     my $user;
+
     # SMELL: call to unpublished core function
-    if (defined(&Foswiki::Users::findUser)) {
+    if ( defined(&Foswiki::Users::findUser) ) {
         $user = $session->{users}->findUser( $author, undef, 1 );
         $this->{AUTHOR} = $user ? $user->wikiName() : $author;
-    } else {
+    }
+    else {
         $this->{AUTHOR} = Foswiki::Func::getWikiName($author);
     }
     $this->{TIME} = $time;
     ASSERT($rev) if DEBUG;
+
     # rev at this change
     $this->{CURR_REV} = $rev;
+
     # previous rev
     $this->{BASE_REV} = $rev - 1 || 1;
@@ -76 +80 @@
     my $this = shift;
 
-    return "$this->{WEB}.$this->{TOPIC} by $this->{AUTHOR} at $this->{TIME} from r$this->{BASE_REV} to r$this->{CURR_REV}";
+    return
+"$this->{WEB}.$this->{TOPIC} by $this->{AUTHOR} at $this->{TIME} from r$this->{BASE_REV} to r$this->{CURR_REV}";
 }
 
@@ -89 +94 @@
 
 sub merge {
-    my( $this, $other ) = @_;
-    ASSERT($this->isa( 'Foswiki::Contrib::MailerContrib::Change' )) if DEBUG;
-    ASSERT($other->isa( 'Foswiki::Contrib::MailerContrib::Change' )) if DEBUG;
-
-    if( $other->{CURR_REV} > $this->{CURR_REV} ) {
+    my ( $this, $other ) = @_;
+    ASSERT( $this->isa('Foswiki::Contrib::MailerContrib::Change') )  if DEBUG;
+    ASSERT( $other->isa('Foswiki::Contrib::MailerContrib::Change') ) if DEBUG;
+
+    if ( $other->{CURR_REV} > $this->{CURR_REV} ) {
         $this->{CURR_REV} = $other->{CURR_REV};
-        $this->{AUTHOR} = $other->{AUTHOR};
-        $this->{TIME} = $other->{TIME};
+        $this->{AUTHOR}   = $other->{AUTHOR};
+        $this->{TIME}     = $other->{TIME};
     }
 
     $this->{BASE_REV} = $other->{BASE_REV}
-      if($other->{BASE_REV} < $this->{BASE_REV});
+      if ( $other->{BASE_REV} < $this->{BASE_REV} );
 }
 
@@ -118 +123 @@
     my ( $this, $html ) = @_;
 
-    unless( defined $this->{HTML_SUMMARY} ) {
-        if( defined &Foswiki::Func::summariseChanges ) {
+    unless ( defined $this->{HTML_SUMMARY} ) {
+        if ( defined &Foswiki::Func::summariseChanges ) {
             $this->{HTML_SUMMARY} =
-              Foswiki::Func::summariseChanges(
-                  $this->{WEB}, $this->{TOPIC}, $this->{BASE_REV},
-                  $this->{CURR_REV}, 1 );
-        } else {
+              Foswiki::Func::summariseChanges( $this->{WEB}, $this->{TOPIC},
+                $this->{BASE_REV}, $this->{CURR_REV}, 1 );
+        }
+        else {
             $this->{HTML_SUMMARY} =
-              $this->{SESSION}->{renderer}->summariseChanges
-                ( undef, $this->{WEB}, $this->{TOPIC}, $this->{BASE_REV},
-                  $this->{CURR_REV}, 1 );
+              $this->{SESSION}->{renderer}
+              ->summariseChanges( undef, $this->{WEB}, $this->{TOPIC},
+                $this->{BASE_REV}, $this->{CURR_REV}, 1 );
         }
     }
@@ -134 +139 @@
     $html =~ s/%TOPICNAME%/$this->{TOPIC}/g;
     $html =~ s/%AUTHOR%/$this->{AUTHOR}/g;
-    my $tim =  Foswiki::Time::formatTime( $this->{TIME} );
+    my $tim = Foswiki::Time::formatTime( $this->{TIME} );
     $html =~ s/%TIME%/$tim/go;
     $html =~ s/%CUR_REV%/$this->{CURR_REV}/g;
     $html =~ s/%BASE_REV%/$this->{BASE_REV}/g;
     my $frev = '';
-    if( $this->{CURR_REV} ) {
-        if( $this->{CURR_REV} > 1 ) {
-            $frev = 'r'.$this->{BASE_REV}.
-              '-&gt;r'.$this->{CURR_REV};
-        } else {
+    if ( $this->{CURR_REV} ) {
+        if ( $this->{CURR_REV} > 1 ) {
+            $frev = 'r' . $this->{BASE_REV} . '-&gt;r' . $this->{CURR_REV};
+        }
+        else {
+
             # new _since the last notification_
-            $frev = CGI::span( { class=>'foswikiNew' }, 'NEW' );
+            $frev = CGI::span( { class => 'foswikiNew' }, 'NEW' );
         }
     }
     $html =~ s/%REVISION%/$frev/g;
-    $html = Foswiki::Func::expandCommonVariables(
-        $html, $this->{TOPIC}, $this->{WEB} );
-    $html = Foswiki::Func::renderText( $html );
+    $html =
+      Foswiki::Func::expandCommonVariables( $html, $this->{TOPIC},
+        $this->{WEB} );
+    $html = Foswiki::Func::renderText($html);
     $html =~ s/%TEXTHEAD%/$this->{HTML_SUMMARY}/g;
 
@@ -167 +174 @@
     my ( $this, $template ) = @_;
 
-    unless( defined $this->{TEXT_SUMMARY} ) {
+    unless ( defined $this->{TEXT_SUMMARY} ) {
         my $s;
-        if( defined &Foswiki::Func::summariseChanges ) {
-            $s = Foswiki::Func::summariseChanges(
-                $this->{WEB}, $this->{TOPIC}, $this->{BASE_REV},
-                $this->{CURR_REV}, 0 );
-        } else {
-            $s = $this->{SESSION}->{renderer}->summariseChanges(
-                undef, $this->{WEB}, $this->{TOPIC}, $this->{BASE_REV},
-                $this->{CURR_REV}, 0 );
+        if ( defined &Foswiki::Func::summariseChanges ) {
+            $s =
+              Foswiki::Func::summariseChanges( $this->{WEB}, $this->{TOPIC},
+                $this->{BASE_REV}, $this->{CURR_REV}, 0 );
+        }
+        else {
+            $s =
+              $this->{SESSION}->{renderer}
+              ->summariseChanges( undef, $this->{WEB}, $this->{TOPIC},
+                $this->{BASE_REV}, $this->{CURR_REV}, 0 );
         }
         $s =~ s/\n/\n   /gs;
@@ -183 +192 @@
     }
 
-    my $tim =  Foswiki::Time::formatTime( $this->{TIME} );
+    my $tim = Foswiki::Time::formatTime( $this->{TIME} );
 
     # URL-encode topic names for use of I18N topic names in plain text
@@ -193 +202 @@
     $template =~ s/%CUR_REV%/$this->{CURR_REV}/g;
     $template =~ s/%BASE_REV%/$this->{BASE_REV}/g;
-    $template =~ s/%TOPICNAME%/$this->{TOPIC}/g; # deprecated DO NOT USE!
+    $template =~ s/%TOPICNAME%/$this->{TOPIC}/g;     # deprecated DO NOT USE!
     $template =~ s/%TOPIC%/$this->{TOPIC}/g;
     my $frev = '';
-    if( $this->{CURR_REV} ) {
-        if( $this->{CURR_REV} > 1 ) {
-            $frev = 'r'.$this->{BASE_REV}.
-              '->r'.$this->{CURR_REV};
-        } else {
+    if ( $this->{CURR_REV} ) {
+        if ( $this->{CURR_REV} > 1 ) {
+            $frev = 'r' . $this->{BASE_REV} . '->r' . $this->{CURR_REV};
+        }
+        else {
+
             # new _since the last notification_
             $frev = 'NEW';

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/CompatibilityHacks.pm

@@ -4 +4 @@
 package IteratorHack;
 
+use strict;
+
 sub new {
-    my ($class, $list) = @_;
-    my $this = bless({list => $list, index => 0, next => undef }, $class);
+    my ( $class, $list ) = @_;
+    my $this = bless( { list => $list, index => 0, next => undef }, $class );
     return $this;
 }
 
 sub hasNext {
-    my( $this ) = @_;
+    my ($this) = @_;
     return 1 if $this->{next};
-    if( $this->{index} < scalar(@{$this->{list}}) ) {
-        $this->{next} = $this->{list}->[$this->{index}++];
+    if ( $this->{index} < scalar( @{ $this->{list} } ) ) {
+        $this->{next} = $this->{list}->[ $this->{index}++ ];
         return 1;
     }
@@ -31 +33 @@
 
 sub eachChangeSince {
-    my ($web, $since) = @_;
+    my ( $web, $since ) = @_;
 
     my $changes;
-    if( open(F, "<$Foswiki::cfg{DataDir}/$web/.changes")) {
+    if ( open( F, '<', "$Foswiki::cfg{DataDir}/$web/.changes" ) ) {
         local $/ = undef;
         $changes = <F>;
@@ -44 +46 @@
     my @changes =
       map {
-          # Create a hash for this line
-          { topic => $_->[0], user => $_->[1], time => $_->[2],
-              revision => $_->[3], more => $_->[4] };
+
+        # Create a hash for this line
+        {
+            topic    => $_->[0],
+            user     => $_->[1],
+            time     => $_->[2],
+            revision => $_->[3],
+            more     => $_->[4]
+        };
       }
-        grep {
-            # Filter on time
-            $_->[2] && $_->[2] >= $since
-        }
-          map {
-              # Split line into an array
-              my @row = split(/\t/, $_, 5);
-              \@row;
-          }
-            reverse split( /[\r\n]+/, $changes);
+      grep {
+
+        # Filter on time
+        $_->[2] && $_->[2] >= $since
+      }
+      map {
+
+        # Split line into an array
+        my @row = split( /\t/, $_, 5 );
+        \@row;
+      }
+      reverse split( /[\r\n]+/, $changes );
 
     return new IteratorHack( \@changes );

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Config.spec

@@ -1 @@
-# ---+ Mail and Proxies
+# ---+ Extensions
+# ---++ MailerContrib
 # **REGEX**
 # Define the regular expression that an email address entered in WebNotify
@@ -5 +6 @@
 # this expression to - for example - filter email addresses on your company
 # domain, or even block use of raw emails in WebNotify altogether (just make
-# it something that will never match, e.g. ='^notAnEmail$'=).
+# it something that will never match, e.g. <code>^notAnEmail$</code>).
 # If this is not defined, then the default setting of
-# =[A-Za-z0-9.+-_]+\@[A-Za-z0-9.-]+= is used.
+# <code>[A-Za-z0-9.+-_]+\@[A-Za-z0-9.-]+</code> is used.
 $Foswiki::cfg{MailerContrib}{EmailFilterIn} = '';
 

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Constants.pm

@@ +1 @@
+
 =pod
 
@@ -14 +15 @@
 package MailerConst;
 
-our $ALWAYS       = 1; # Always send, even if there are no changes
-our $FULL_TOPIC   = 2; # Send the full topic rather than just changes
+use strict;
+
+our $ALWAYS     = 1;    # Always send, even if there are no changes
+our $FULL_TOPIC = 2;    # Send the full topic rather than just changes
 
 # ? = FULL_TOPIC

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Subscriber.pm

@@ -67 +67 @@
     my $this = shift;
 
-    unless ( defined( $this->{emails} )) {
-        $this->{emails} = getEmailAddressesForUser( $this->{name});
+    unless ( defined( $this->{emails} ) ) {
+        $this->{emails} = getEmailAddressesForUser( $this->{name} );
     }
     return $this->{emails};
@@ -82 +82 @@
 
 sub getEmailAddressesForUser {
-    my $name = shift;
+    my $name   = shift;
     my $emails = [];
 
@@ -89 +89 @@
     if ( $name =~ /^$Foswiki::cfg{MailerContrib}{EmailFilterIn}$/ ) {
         push( @{$emails}, $name );
-    } else {
+    }
+    else {
         my $users = $Foswiki::Plugins::SESSION->{users};
-        if ($users->can('findUserByWikiName')) {
+        if ( $users->can('findUserByWikiName') ) {
+
             # User is represented by a wikiname. Map to a canonical
             # userid.
             my $list = $users->findUserByWikiName($name);
             foreach my $user (@$list) {
+
                 # Automatically expands groups
                 push( @{$emails}, $users->getEmails($user) );
             }
-        } else {
+        }
+        else {
+
             # Old code; use the user object
             my $user = $users->findUser( $name, undef, 1 );
-            if( $user ) {
+            if ($user) {
                 push( @{$emails}, $user->emails() );
-            } else {
-                $user = $users->findUser(
-                    $name, $name, 1 );
-                if( $user ) {
+            }
+            else {
+                $user = $users->findUser( $name, $name, 1 );
+                if ($user) {
                     push( @{$emails}, $user->emails() );
-                } else {
+                }
+                else {
+
                     # unknown - can't find an email
                     $emails = [];
@@ -123 +130 @@
 # topics.
 sub _addAndOptimise {
-    my( $this, $set, $new ) = @_;
+    my ( $this, $set, $new ) = @_;
 
     # Don't add already covered duplicates
     my $i = 0;
     my @remove;
-    foreach my $known (@{$this->{$set}}) {
+    foreach my $known ( @{ $this->{$set} } ) {
         return if $known->covers($new);
-        if( $new->covers( $known )) {
+        if ( $new->covers($known) ) {
+
             # remove anything covered by the new subscription
-            unshift(@remove, $i);
+            unshift( @remove, $i );
         }
         $i++;
     }
     foreach $i (@remove) {
-        splice(@{$this->{$set}}, $i, 1);
-    }
-    push( @{$this->{$set}}, $new );
+        splice( @{ $this->{$set} }, $i, 1 );
+    }
+    push( @{ $this->{$set} }, $new );
 }
 
@@ -145 +153 @@
 # you can in the face of wildcards.
 sub _subtract {
-    my( $this, $set, $new ) = @_;
+    my ( $this, $set, $new ) = @_;
 
     my $i = 0;
     my @remove;
-    foreach my $known (@{$this->{$set}}) {
-        if( $new->covers( $known )) {
+    foreach my $known ( @{ $this->{$set} } ) {
+        if ( $new->covers($known) ) {
+
             # remove anything covered by the new subscription
-            unshift(@remove, $i);
+            unshift( @remove, $i );
         }
         $i++;
     }
     foreach $i (@remove) {
-        splice(@{$this->{$set}}, $i, 1);
+        splice( @{ $this->{$set} }, $i, 1 );
     }
 }
@@ -193 +202 @@
 
     $this->_addAndOptimise( 'unsubscriptions', $subs );
-    if ($subs->matches('*')) {
+    if ( $subs->matches('*') ) {
+
         # -* makes no sense and causes evaluation problems.
         $this->_subtract( 'unsubscriptions', $subs );
     }
     $this->_subtract( 'subscriptions', $subs );
-    #TODO: should look at removing redundant exclusions ie a - SubScribe (2) when there is no positive subscription
-    
+
+#TODO: should look at removing redundant exclusions ie a - SubScribe (2) when there is no positive subscription
+
     #if there are no subscriptions, there is no point luging around the unsubs
-    if (scalar(@{$this->{'subscriptions'}}) == 0) {
-        undef @{$this->{'unsubscriptions'}};
+    if ( scalar( @{ $this->{'subscriptions'} } ) == 0 ) {
+        undef @{ $this->{'unsubscriptions'} };
     }
 }
@@ -217 +228 @@
 
 sub isSubscribedTo {
-   my ( $this, $topic, $db ) = @_;
-
-   foreach my $subscription ( @{$this->{subscriptions}} ) {
-       if ( $subscription->matches( $topic, $db )) {
-           return $subscription;
-       }
-   }
-
-   return undef;
+    my ( $this, $topic, $db ) = @_;
+
+    foreach my $subscription ( @{ $this->{subscriptions} } ) {
+        if ( $subscription->matches( $topic, $db ) ) {
+            return $subscription;
+        }
+    }
+
+    return;
 }
 
@@ -238 +249 @@
 
 sub isUnsubscribedFrom {
-   my ( $this, $topic, $db ) = @_;
-
-   foreach my $subscription ( @{$this->{unsubscriptions}} ) {
-       if ( $subscription->matches( $topic, $db )) {
-           return $subscription;
-       }
-   }
-
-   return undef;
+    my ( $this, $topic, $db ) = @_;
+
+    foreach my $subscription ( @{ $this->{unsubscriptions} } ) {
+        if ( $subscription->matches( $topic, $db ) ) {
+            return $subscription;
+        }
+    }
+
+    return;
 }
 
@@ -258 +269 @@
 sub stringify {
     my $this = shift;
-    my $subs = join( ' ',
-                     map { $_->stringify(); }
-                     @{$this->{subscriptions}} );
-    my $unsubs = join( " - ",
-                       map { $_->stringify(); }
-                       @{$this->{unsubscriptions}} );
+    my $subs =
+      join( ' ', map { $_->stringify(); } @{ $this->{subscriptions} } );
+    my $unsubs =
+      join( " - ", map { $_->stringify(); } @{ $this->{unsubscriptions} } );
     $unsubs = " - $unsubs" if $unsubs;
 
     my $name = $this->{name};
-    if ($name =~ /^$Foswiki::regex{wikiWordRegex}$/) {
-        $name = '%USERSWEB%.'.$name;
-    } elsif ($name !~ /^$Foswiki::cfg{MailerContrib}{EmailFilterIn}$/) {
-        $name = $name =~ /'/ ? '"'.$name.'"' : "'$name'";
-    }
-    return "   * " . $name . ": " .
-      $subs . $unsubs;
+    if ( $name =~ /^$Foswiki::regex{wikiWordRegex}$/ ) {
+        $name = '%USERSWEB%.' . $name;
+    }
+    elsif ( $name !~ /^$Foswiki::cfg{MailerContrib}{EmailFilterIn}$/ ) {
+        $name = $name =~ /'/ ? '"' . $name . '"' : "'$name'";
+    }
+    return "   * " . $name . ": " . $subs . $unsubs;
 }
 

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Subscription.pm

@@ -42 +42 @@
     my ( $class, $topics, $depth, $opts ) = @_;
 
-    ASSERT(defined($opts) && $opts =~ /^\d*$/) if DEBUG;
+    ASSERT( defined($opts) && $opts =~ /^\d*$/ ) if DEBUG;
 
     my $this = bless( {}, $class );
 
-    $this->{topics} = $topics || '';
-    $this->{depth} = $depth || 0;
-    $this->{options} = $opts || 0;
+    $this->{topics}  = $topics || '';
+    $this->{depth}   = $depth  || 0;
+    $this->{options} = $opts   || 0;
 
     $topics =~ s/[^\w\*]//g;
@@ -65 +65 @@
 
 sub stringify {
-    my $this = shift;
+    my $this   = shift;
     my $record = $this->{topics};
-    # convert RE back to wildcard
-    $record =~ s/\.\*\?/\*/;
+
+    # Protect non-alphanumerics in topic name
+    if ($record =~ /[^*\w.]/) {
+        if ($record =~ /'/) {
+            $record = "\"$record\"";
+        } else {
+            $record = "'$record'";
+        }
+    }
     $record .= $this->getMode();
     $record .= " ($this->{depth})" if ( $this->{depth} );
@@ -93 +100 @@
     return 1 if ( $topic =~ $this->{topicsRE} );
 
-    $depth = $this->{depth} unless defined( $depth );
+    $depth = $this->{depth} unless defined($depth);
     $depth ||= 0;
 
-    if ( $depth && $db) {
-        my $parent = $db->getParent( $topic );
+    if ( $depth && $db ) {
+        my $parent = $db->getParent($topic);
         $parent =~ s/^.*\.//;
-        return $this->matches( $parent, $db, $depth - 1 ) if ( $parent );
+        return $this->matches( $parent, $db, $depth - 1 ) if ($parent);
     }
 
@@ -119 +126 @@
 
 sub covers {
-    my( $this, $tother, $db ) = @_;
-    
+    my ( $this, $tother, $db ) = @_;
+
     #* should win always.
-    return 1 if ($this->{topics} eq '*');
+    return 1 if ( $this->{topics} eq '*' );
 
     # Does the mode cover the other subscription?
-    return 0 unless
-      (($this->{options} & $tother->{options}) == $tother->{options});
+    return 0
+      unless (
+        ( $this->{options} & $tother->{options} ) == $tother->{options} );
 
     # do they match without taking into account the depth?
-    return 0 unless( $this->matches($tother->{topics}, undef, 0) );
+    return 0 unless ( $this->matches( $tother->{topics}, undef, 0 ) );
 
     # if we have a depth and they don't, that's already catered for
@@ -139 +147 @@
     # if we have a depth and they have a depth, then there is coverage
     # if our depth is >= their depth
-    return 0 unless( $this->{depth} >= $tother->{depth} );
+    return 0 unless ( $this->{depth} >= $tother->{depth} );
 
     return 1;
@@ -155 +163 @@
     my $this = shift;
 
-    if ($this->{options} & $MailerConst::FULL_TOPIC) {
-        return '!' if ($this->{options} & $MailerConst::ALWAYS);
+    if ( $this->{options} & $MailerConst::FULL_TOPIC ) {
+        return '!' if ( $this->{options} & $MailerConst::ALWAYS );
         return '?';
     }
@@ -170 +178 @@
 
 sub equals {
-    my( $this, $tother ) = @_;
-    return 0 unless ($this->{options} eq $tother->{options});
-    return 0 unless ($this->{depth} == $tother->{depth});
-    return 0 unless ($this->{topics} eq $tother->{topics});
+    my ( $this, $tother ) = @_;
+    return 0 unless ( $this->{options} eq $tother->{options} );
+    return 0 unless ( $this->{depth} == $tother->{depth} );
+    return 0 unless ( $this->{topics} eq $tother->{topics} );
 }
 

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/TopicContext.pm

@@ -2 +2 @@
 # by MailerContrib.
 
+use strict;
+
 sub Foswiki::Func::pushTopicContext {
-    my( $web, $topic ) = @_;
+    my ( $web, $topic ) = @_;
     my $session = $Foswiki::Plugins::SESSION;
-    my( $web, $topic ) = $session->normalizeWebTopicName( @_ );
+    my ( $web, $topic ) = $session->normalizeWebTopicName(@_);
     my $old = {
-        web => $session->{webName},
+        web   => $session->{webName},
         topic => $session->{topicName},
-        mark => $session->{prefs}->mark() };
+        mark  => $session->{prefs}->mark()
+    };
 
-    push( @{$session->{_FUNC_PREFS_STACK}}, $old );
-    $session->{webName} = $web;
+    push( @{ $session->{_FUNC_PREFS_STACK} }, $old );
+    $session->{webName}   = $web;
     $session->{topicName} = $topic;
-    $session->{prefs}->pushWebPreferences( $web );
+    $session->{prefs}->pushWebPreferences($web);
     $session->{prefs}->pushPreferences( $web, $topic, 'TOPIC' );
-    $session->{prefs}->pushPreferenceValues(
-        'SESSION', $session->{loginManager}->getSessionValues() );
+    $session->{prefs}->pushPreferenceValues( 'SESSION',
+        $session->{loginManager}->getSessionValues() );
 }
 
 sub Foswiki::Func::popTopicContext {
     my $session = $Foswiki::Plugins::SESSION;
-    my $old = pop( @{$session->{_FUNC_PREFS_STACK}} );
-    $session->{prefs}->restore( $old->{mark});
-    $session->{webName} = $old->{web};
+    my $old     = pop( @{ $session->{_FUNC_PREFS_STACK} } );
+    $session->{prefs}->restore( $old->{mark} );
+    $session->{webName}   = $old->{web};
     $session->{topicName} = $old->{topic};
 }

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/UpData.pm

@@ -43 +43 @@
     my ( $class, $session, $web ) = @_;
     my $this = bless( {}, $class );
-    $this->{web} = $web;
+    $this->{web}     = $web;
     $this->{session} = $session;
     return $this;
@@ -58 +58 @@
     my ( $this, $topic ) = @_;
 
-    if ( ! defined( $this->{parent}{$topic} )) {
-        my( $meta, $text ) =
-          Foswiki::Func::readTopic( $this->{web}, $topic );
+    if ( !defined( $this->{parent}{$topic} ) ) {
+        my ( $meta, $text ) = Foswiki::Func::readTopic( $this->{web}, $topic );
         my $parent = $meta->get('TOPICPARENT');
         $this->{parent}{$topic} = $parent->{name} if $parent;

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/WebNotify.pm

@@ -32 +32 @@
 
 use strict;
-use locale; # required for matching \w with international characters
+use locale;    # required for matching \w with international characters
 
 use Assert;
@@ -64 +64 @@
     Foswiki::Contrib::MailerContrib::initContrib();
 
-    $this->{web} = $web;
-    $this->{topic} = $topic || $Foswiki::cfg{NotifyTopicName} || 'WebNotify';
-    $this->{pretext} = '';
+    $this->{web}      = $web;
+    $this->{topic}    = $topic || $Foswiki::cfg{NotifyTopicName} || 'WebNotify';
+    $this->{pretext}  = '';
     $this->{posttext} = '';
-    $this->{session} = $session;
+    $this->{session}  = $session;
     $this->{noexpandgroups} = $noexpandgroups;
 
-    if( Foswiki::Func::topicExists( $web, $topic )) {
+    if ( Foswiki::Func::topicExists( $web, $topic ) ) {
         $this->_load();
     }
@@ -89 +89 @@
 sub writeWebNotify {
     my $this = shift;
-    Foswiki::Func::saveTopicText(
-        $this->{web},
-        $this->{topic},
-        $this->stringify(),
-        1, 1);
+    Foswiki::Func::saveTopicText( $this->{web}, $this->{topic},
+        $this->stringify(), 1, 1 );
 }
 
@@ -112 +109 @@
 
     my $subscriber = $this->{subscribers}{$name};
-    unless ( $noAdd || defined( $subscriber )) {
-        $subscriber =
-          new Foswiki::Contrib::MailerContrib::Subscriber( $name );
+    unless ( $noAdd || defined($subscriber) ) {
+        $subscriber = new Foswiki::Contrib::MailerContrib::Subscriber($name);
         $this->{subscribers}{$name} = $subscriber;
     }
@@ -128 +124 @@
 
 sub getSubscribers {
-    my ( $this ) = @_;
-
-    return keys %{$this->{subscribers}};
+    my ($this) = @_;
+
+    return keys %{ $this->{subscribers} };
 }
 
@@ -147 +143 @@
     my ( $this, $name, $topics, $depth, $opts ) = @_;
 
-    ASSERT(defined($opts) && $opts =~ /^\d*$/) if DEBUG;
+    ASSERT( defined($opts) && $opts =~ /^\d*$/ ) if DEBUG;
 
     my @names = ($name);
-    unless ($this->{noexpandgroups}) {
-        if (defined &Foswiki::Func::eachGroupMember) {
-            my $it = Foswiki::Func::eachGroupMember( $name );
-            if( $it ) {
+    unless ( $this->{noexpandgroups} ) {
+        if ( defined &Foswiki::Func::eachGroupMember ) {
+            my $it = Foswiki::Func::eachGroupMember($name);
+            if ($it) {
                 @names = ();
-                while( $it->hasNext() ) {
+                while ( $it->hasNext() ) {
                     my $member = $it->next();
                     push( @names, $member );
                 }
             }
-        } else {
-            my $user = Foswiki::User->new($this->{session}, '', $name);
-            if ($user->isGroup) {
-                @names = map {$_->wikiName} @{$user->groupMembers};
+        }
+        else {
+            my $user = Foswiki::User->new( $this->{session}, '', $name );
+            if ( $user->isGroup ) {
+                @names = map { $_->wikiName } @{ $user->groupMembers };
             }
         }
@@ -169 +166 @@
 
     foreach my $n (@names) {
-        my $subscriber = $this->getSubscriber( $n );
-        my $sub = new Foswiki::Contrib::MailerContrib::Subscription(
-            $topics, $depth, $opts );
-        $subscriber->subscribe( $sub );
+        my $subscriber = $this->getSubscriber($n);
+        my $sub =
+          new Foswiki::Contrib::MailerContrib::Subscription( $topics, $depth,
+            $opts );
+        $subscriber->subscribe($sub);
     }
 }
@@ -191 +189 @@
     my ( $this, $name, $topics, $depth ) = @_;
 
-    my @names = ( $name );
-    unless ($this->{noexpandgroups}) {
-        if (defined &Foswiki::Func::eachGroupMember) {
-            my $it = Foswiki::Func::eachGroupMember( $name );
-            if( $it ) {
+    my @names = ($name);
+    unless ( $this->{noexpandgroups} ) {
+        if ( defined &Foswiki::Func::eachGroupMember ) {
+            my $it = Foswiki::Func::eachGroupMember($name);
+            if ($it) {
                 @names = ();
-                while( $it->hasNext() ) {
+                while ( $it->hasNext() ) {
                     my $member = $it->next();
                     push( @names, $member );
                 }
             }
-        } else {
-            my $user = Foswiki::User->new($this->{session}, '', $name);
-            if ($user->isGroup) {
-                @names = map {$_->wikiName} @{$user->groupMembers};
+        }
+        else {
+            my $user = Foswiki::User->new( $this->{session}, '', $name );
+            if ( $user->isGroup ) {
+                @names = map { $_->wikiName } @{ $user->groupMembers };
             }
         }
@@ -211 +210 @@
 
     foreach my $n (@names) {
-        my $subscriber = $this->getSubscriber( $n );
-        my $sub = new Foswiki::Contrib::MailerContrib::Subscription(
-            $topics, $depth, 0 );
-        $subscriber->unsubscribe( $sub );
+        my $subscriber = $this->getSubscriber($n);
+        my $sub =
+          new Foswiki::Contrib::MailerContrib::Subscription( $topics, $depth,
+            0 );
+        $subscriber->unsubscribe($sub);
     }
 }
@@ -235 +235 @@
     my $page = '';
 
-    $page .= $this->{pretext} if (!$subscribersOnly);
-    foreach my $name ( sort keys %{$this->{subscribers}} ) {
+    $page .= $this->{pretext} if ( !$subscribersOnly );
+    foreach my $name ( sort keys %{ $this->{subscribers} } ) {
         my $subscriber = $this->{subscribers}{$name};
         $page .= $subscriber->stringify() . "\n";
     }
-    $page .= $this->{posttext} if (!$subscribersOnly);
+    $page .= $this->{posttext} if ( !$subscribersOnly );
 
     return $page;
@@ -262 +262 @@
     my ( $this, $change, $db, $changeSet, $seenSet, $allSet ) = @_;
 
-    my $topic = $change->{TOPIC};
-    my $web = $change->{WEB};
-    my %authors = map { $_ => 1 }
-      @{Foswiki::Contrib::MailerContrib::Subscriber::getEmailAddressesForUser(
-          $change->{author})};
-
-    foreach my $name ( keys %{$this->{subscribers}} ) {
+    my $topic   = $change->{TOPIC};
+    my $web     = $change->{WEB};
+    my %authors = map { $_ => 1 } @{
+        Foswiki::Contrib::MailerContrib::Subscriber::getEmailAddressesForUser(
+            $change->{author}
+        )
+      };
+
+    foreach my $name ( keys %{ $this->{subscribers} } ) {
         my $subscriber = $this->{subscribers}{$name};
         my $subs = $subscriber->isSubscribedTo( $topic, $db );
-        if ($subs && !$subscriber->isUnsubscribedFrom( $topic, $db )) {
-
-            next unless Foswiki::Func::checkAccessPermission(
-                'VIEW', $name, undef, $topic, $this->{web}, undef );
+        if ( $subs && !$subscriber->isUnsubscribedFrom( $topic, $db ) ) {
+
+            next
+              unless Foswiki::Func::checkAccessPermission( 'VIEW', $name, undef,
+                $topic, $this->{web}, undef );
 
             my $emails = $subscriber->getEmailAddresses();
-            if( $emails && scalar( @$emails )) {
-                foreach my $email ( @$emails ) {
+            if ( $emails && scalar(@$emails) ) {
+                foreach my $email (@$emails) {
+
                     # Skip this change if the subscriber is the author
                     # of the change, and we are not always sending
-                    next if (!($subs->{options} & $MailerConst::ALWAYS)
-                               && $authors{$email});
-
-                    if ($subs->{options} & $MailerConst::FULL_TOPIC) {
-                        push( @{$allSet->{$topic}}, $email );
-                    } else {
+                    next
+                      if ( !( $subs->{options} & $MailerConst::ALWAYS )
+                        && $authors{$email} );
+
+                    if ( $subs->{options} & $MailerConst::FULL_TOPIC ) {
+                        push( @{ $allSet->{$topic} }, $email );
+                    }
+                    else {
                         my $at = $seenSet->{$email}{$topic};
-                        if ( $at ) {
-                            $changeSet->{$email}[$at - 1]->merge( $change );
-                        } else {
+                        if ($at) {
+                            $changeSet->{$email}[ $at - 1 ]->merge($change);
+                        }
+                        else {
                             $seenSet->{$email}{$topic} =
-                              push( @{$changeSet->{$email}}, $change );
+                              push( @{ $changeSet->{$email} }, $change );
                         }
                     }
                 }
-            } else {
-                $this->_emailWarn($subscriber,$name,$web);
+            }
+            else {
+                $this->_emailWarn( $subscriber, $name, $web );
             }
         }
@@ -313 +321 @@
 
 sub processCompulsory {
-    my ($this, $topic, $db, $allSet) = @_;
-
-    foreach my $name ( keys %{$this->{subscribers}} ) {
+    my ( $this, $topic, $db, $allSet ) = @_;
+
+    foreach my $name ( keys %{ $this->{subscribers} } ) {
         my $subscriber = $this->{subscribers}{$name};
         my $subs = $subscriber->isSubscribedTo( $topic, $db );
         next unless $subs;
-        next unless ($subs->{options} & $MailerConst::ALWAYS);
-        unless( $subscriber->isUnsubscribedFrom( $topic, $db )) {
+        next unless ( $subs->{options} & $MailerConst::ALWAYS );
+        unless ( $subscriber->isUnsubscribedFrom( $topic, $db ) ) {
             my $emails = $subscriber->getEmailAddresses();
-            if( $emails ) {
+            if ($emails) {
                 foreach my $address (@$emails) {
-                    push( @{$allSet->{$topic}}, $address );
+                    push( @{ $allSet->{$topic} }, $address );
                 }
             }
@@ -340 +348 @@
 sub isEmpty {
     my $this = shift;
-    return ( scalar( keys %{$this->{subscribers}} ) == 0 );
+    return ( scalar( keys %{ $this->{subscribers} } ) == 0 );
 }
 
@@ -347 +355 @@
     my $this = shift;
 
-    my ( $meta, $text ) = Foswiki::Func::readTopic(
-        $this->{web}, $this->{topic} );
+    my ( $meta, $text ) =
+      Foswiki::Func::readTopic( $this->{web}, $this->{topic} );
     my $in_pre = 1;
-    $this->{pretext} = '';
+    $this->{pretext}  = '';
     $this->{posttext} = '';
-    $this->{meta} = $meta;
+    $this->{meta}     = $meta;
+
     # join \ terminated lines
     $text =~ s/\\\r?\n//gs;
     my $webRE = qr/(?:$Foswiki::cfg{UsersWebName}\.)?/o;
-    foreach my $baseline ( split ( /\r?\n/, $text )) {
-        my $line = Foswiki::Func::expandCommonVariables(
-            $baseline, $this->{topic}, $this->{web}, $meta);
-        if( $line =~ /^\s+\*\s$webRE($Foswiki::regex{wikiWordRegex})\s+\-\s+($Foswiki::cfg{MailerContrib}{EmailFilterIn}+)\s*$/o
-              && $1 ne $Foswiki::cfg{DefaultUserWikiName}) {
+    foreach my $baseline ( split( /\r?\n/, $text ) ) {
+        my $line =
+          Foswiki::Func::expandCommonVariables( $baseline, $this->{topic},
+            $this->{web}, $meta );
+        if ( $line =~
+/^\s+\*\s$webRE($Foswiki::regex{wikiWordRegex})\s+\-\s+($Foswiki::cfg{MailerContrib}{EmailFilterIn}+)\s*$/o
+            && $1 ne $Foswiki::cfg{DefaultUserWikiName} )
+        {
+
             # Main.WikiName - email@domain (legacy format)
             $this->subscribe( $2, '*', 0, 0 );
             $in_pre = 0;
         }
-        elsif ( $line =~ /^\s+\*\s$webRE($Foswiki::regex{wikiWordRegex}|'.*?'|".*?"|$Foswiki::cfg{MailerContrib}{EmailFilterIn})\s*(:.*)?$/o
-                  && $1 ne $Foswiki::cfg{DefaultUserWikiName}) {
+        elsif ( $line =~
+/^\s+\*\s$webRE($Foswiki::regex{wikiWordRegex}|'.*?'|".*?"|$Foswiki::cfg{MailerContrib}{EmailFilterIn})\s*(:.*)?$/o
+            && $1 ne $Foswiki::cfg{DefaultUserWikiName} )
+        {
             my $subscriber = $1;
+
             # Get the topic list from the last bracket matched. Have to do it
             # this awkward way because the email filter may contain braces
             my $topics = $+;
+
             # email addresses can't start with :
-            $topics = undef unless ($topics =~ s/^://);
-            $subscriber =~ s/^(['"])(.*)\1$/$2/; # remove quotes
+            $topics = undef unless ( $topics =~ s/^:// );
+            $subscriber =~ s/^(['"])(.*)\1$/$2/;    # remove quotes
             if ($topics) {
                 $this->parsePageSubscriptions( $subscriber, $topics );
-            } else {
-                $this->subscribe($subscriber, '*', 0, 0 );
+            }
+            else {
+                $this->subscribe( $subscriber, '*', 0, 0 );
             }
             $in_pre = 0;
         }
         else {
-            if( $in_pre ) {
+            if ($in_pre) {
                 $this->{pretext} .= "$baseline\n";
-            } else {
-                $this->{posttext} .=  "$baseline\n";
+            }
+            else {
+                $this->{posttext} .= "$baseline\n";
             }
         }
@@ -395 +414 @@
 sub parsePageSubscriptions {
     my ( $this, $who, $spec, $unsubscribe ) = @_;
-    
+
     $this->{topicSub} = \&_subscribeTopic;
-    
-    my $ret = Foswiki::Contrib::MailerContrib::parsePageList($this, $who, $spec, $unsubscribe);
+
+    my $ret = Foswiki::Contrib::MailerContrib::parsePageList(
+        $this, $who, $spec, $unsubscribe );
     if ( $ret =~ m/\S/ ) {
         Foswiki::Func::writeWarning(
             "Badly formatted page list at $who: $spec");
-        return -1;
+        return -1;
     }
     return;
@@ -409 +429 @@
 sub _subscribeTopic {
     my ( $this, $who, $unsubscribe, $webTopic, $options, $childDepth ) = @_;
-    
-    my ($web, $topic) = Foswiki::Func::normalizeWebTopicName($this->{web}, $webTopic);
-    
-#print STDERR "_subscribeTopic($topic)\n";
+
+    my ( $web, $topic ) =
+      Foswiki::Func::normalizeWebTopicName( $this->{web}, $webTopic );
+
+    #print STDERR "_subscribeTopic($topic)\n";
     my $opts = 0;
     if ($options) {
-        $opts |= $MailerConst::FULL_TOPIC;
-        if ($options =~ /!/) {
-            $opts |= $MailerConst::ALWAYS;
-        }
+        $opts |= $MailerConst::FULL_TOPIC;
+        if ( $options =~ /!/ ) {
+            $opts |= $MailerConst::ALWAYS;
+        }
     }
     my $kids = $childDepth or 0;
-    if ( $unsubscribe && $unsubscribe eq '-') {
-        $this->unsubscribe( $who, $topic, $kids );
-    } else {
-        $this->subscribe( $who, $topic, $kids, $opts );
-    }
+    if ( $unsubscribe && $unsubscribe eq '-' ) {
+        $this->unsubscribe( $who, $topic, $kids );
+    }
+    else {
+        $this->subscribe( $who, $topic, $kids, $opts );
+    }
+
     #TODO: howto find & report errors?
     return '';
@@ -433 +456 @@
 # for a subscriber.
 sub _emailWarn {
-    my ($this, $subscriber, $name, $web) = @_;
+    my ( $this, $subscriber, $name, $web ) = @_;
 
     # Make sure we only warn once. Don't want to see this for every
     # Topic we are notifying on.
-    unless (defined $this->{nomail}{$name}) {
+    unless ( defined $this->{nomail}{$name} ) {
         $this->{nomail}{$name} = 1;
-        Foswiki::Func::writeWarning(
-            "Failed to find permitted email for '".
-              $subscriber->stringify()."' when processing web '$web'");
+        Foswiki::Func::writeWarning( "Failed to find permitted email for '"
+              . $subscriber->stringify()
+              . "' when processing web '$web'" );
     }
 }

branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/build.pl

@@ -15 +15 @@
 
 # Standard preamble
+use strict;
+
 BEGIN {
   foreach my $pc (split(/:/, $ENV{FOSWIKI_LIBS})) {
@@ -30 +32 @@
   sub new {
     my $class = shift;
-    return bless( $class->SUPER::new( "MailerContrib", "Mailer" ), $class );
+    return bless( $class->SUPER::new( "MailerContrib" ), $class );
   }
 
@@ -44 +46 @@
 
 # Create the build object
-$build = new MailerBuild();
+my $build = new MailerBuild();
 
 # Mailer the target on the command line, or the default target

branches/Release01x00/MailerContrib/tools/mailnotify

@@ -24 +24 @@
 # search path for this script, so it can find the rest of Foswiki e.g.
 # perl -I /usr/local/foswiki/bin /usr/local/foswiki/tools/mailnotify
+
+use strict;
 
 BEGIN {