Changeset 5288

Timestamp:

10/17/09 11:44:14 (2 years ago)

Author:

KennethLavrsen

Message:

Item1302: mailnotify ignores -news operand
It is a bug that goes back to TWiki 4.0. The -news was documented but never implemented
Fixing it as speced would cause trouble for people.
And the spec is bad. It would not work well. So instead of implenting a bad spec I decided to implement -nonews and -nochanges which will give people the flexibility AND maintain status quo for those already using the mailnotify with or without a -news switch on the cronjob.

Location:

branches/Release01x00/MailerContrib

Files:

• data/System/MailerContrib.txt (modified) (4 diffs)
• lib/Foswiki/Contrib/MailerContrib.pm (modified) (5 diffs)
• test/unit/MailerContrib/MailerContribSuite.pm (modified) (4 diffs)
• tools/mailnotify (modified) (3 diffs)

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

@@ -50 +50 @@
    * *Unsubscribing to specific topics* - Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic". The '-' sign means "unsubscribe" or "don't send notifications regarding this particular topic". This allows users to elect to filter out certain topics. Topic filters ('-') take precedence over topic includes ('+') i.e. if you unsubscribe from a topic it will cancel out any subscriptions to that topic.
    * *Including child-topics in subscription* - 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 Foswiki "Topic parent" feature.
-   * *Subscribing to entire topic ("news mode")* - Each topic may optionally be immediately followed by an exclamation mark ! and/or a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as well) should be mailed out as *complete topics* instead of change summaries. ! causes the full topic to be mailed every time _even if there have been no changes_, and ? will mail the full topic only if there have been changes. One can limit the content of the subscribed topic to send out by inserting %<nop>STARTPUBLISH% and %<nop>STOPPUBLISH% markers within the topic. Note that "news mode" subscriptions require a corresponding cron job that includes the "-news" option (see [[%TOPIC%#Setting_up_your_cron_job_s][details]]).
+   * *Subscribing to entire topic ("news mode")* - Each topic may optionally be immediately followed by an exclamation mark ! and/or a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as well) should be mailed out as *complete topics* instead of change summaries. ! causes the full topic to be mailed every time _even if there have been no changes_, and ? will mail the full topic only if there have been changes. One can limit the content of the subscribed topic to send out by inserting %<nop>STARTPUBLISH% and %<nop>STOPPUBLISH% markers within the topic. Note that the script mailnotify can be run with the options -nochanges or -nonews so that you can run the two mode on different schedules (see [[%TOPIC%#Setting_up_your_cron_job_s][details]]).
 
 Examples:
@@ -114 +114 @@
 You need to set up a =cron= (or equivalent) job to run the =tools/mailnotify= perl script.
 
-The script is used as follows: <code>perl -I _bin_ mailnotify [-q] [-news] [ <i>web1 web2 ... webN</i> ]</code>
+The script is used as follows: <code>perl -I _bin_ mailnotify [-q] [-nonews] [-nochanges] [ <i>web1 web2 ... webN</i> ]</code>
 | _bin_ | path to the Foswiki bin directory, so that the script can find the rest of Foswiki. |
 | =-q= | Don't print progress information |
-| =-news= | Run in "news mode" (process subscriptions that include "!" or "?" following the topic) |
+| =-nonews= | Skip the "news mode" (do not process subscriptions that include "!" or "?" following the topic) |
+| =-nochanges= | Only run the news mode. (only process subscriptions that include "!" or "?" following the topic) |
 | <code><i>web1 web2 ... webN</i></code> | List of webs to process, separated by spaces or commas. The default is to process all webs. Wildcards (*) are supported. |
 For example, assuming Foswiki was installed at =/usr/local/foswiki=, this cron entry:
@@ -129 +130 @@
 will generate change notifications for all webs, except the =Sandbox= web.
 <verbatim>
-0 0 * * 0 cd /usr/local/foswiki && perl -I bin tools/mailnotify -news
-</verbatim>
-will generate newsletters from *all* webs every week on midnight Saturday.
+0 0 * * 0 cd /usr/local/foswiki && perl -I bin tools/mailnotify -nochanges
+</verbatim>
+will generate newsletters from *all* webs every week on midnight Saturday but will not process the non-newsletter subscriptions.
+<verbatim>
+0 0 * * * cd /usr/local/foswiki && perl -I bin tools/mailnotify -nonews
+</verbatim>
+will generate change notifications for all webs every night at midnight but will not process the newsletter subscriptions.
 
 %X% Note: Multiple instances of mailnotify script are not allowed to be executed simutaneously. If you need to run the script multiple times with different options, make sure the cron jobs are scheduled so a previous run has finished before the next starts. You can also write a small script that runs mailnotify in sequence as described in Foswiki:Support.DuplicateNotificationsFromMailerCon.
+
+%X% Note: Even if you run separate -nonews and -nochanges cron jobs, the subscriptions using the "?" feature will only show the topics that changed since last time the mailnotify script was run even if it was run with -nonews. Separate newsletter jobs work best with the unconditional "!" mode.
 
 <!--
@@ -205 +212 @@
 |  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 |
+|  17 Oct 2009 | Foswikitask:Item1302: Removed the documentation of the -news mode which was actually never really implemented. Instead added two new -nonews and -nochanges modes which enables running mailnotify in newsletter mode with another schedule than the changes mode. If you upgrade and used the -news option with mailnotify things will work like you are used to as the -news option made no difference (old bug). |
+|  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

@@ -27 +27 @@
 
 our $VERSION = '$Rev$';
-our $RELEASE = '15 Oct 2009';
+our $RELEASE = '17 Oct 2009';
 our $SHORTDESCRIPTION = 'Supports e-mail notification of changes';
 
 our $verbose = 0;
+our $nonews = 0;
+our $nochanges = 0;
 
 # PROTECTED STATIC ensure the contrib is initernally initialised
@@ -40 +42 @@
 =pod
 
----++ StaticMethod mailNotify($webs, $session, $verbose, $exwebs)
+---++ StaticMethod mailNotify($webs, $session, $verbose, $exwebs, $nonewsmode, $nochangesmode)
    * =$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.
    * =$exwebs = - filter list of webs to exclude.
+   * =$nonewsmode = the notify script was called with the -nonews option so we skip news mode
+   * =$nochangesmode = the notify script was called with the -nochanges option
 
 Main entry point.
@@ -55 +59 @@
 
 sub mailNotify {
-    my ( $webs, $twiki, $noisy, $exwebs ) = @_;
+    my ( $webs, $twiki, $noisy, $exwebs, $nonewsmode, $nochangesmode ) = @_;
 
     $verbose = $noisy;
+    $nonews = $nonewsmode || 0;
+    $nochanges = $nochangesmode || 0;
 
     my $webstr;
@@ -208 +214 @@
 # PRIVATE: Read the webnotify, and notify changes
 sub _processWeb {
-    my ( $twiki, $web ) = @_;
+    my ( $twiki, $web, $nonews, $nochanges ) = @_;
 
     if ( !Foswiki::Func::webExists($web) ) {
@@ -315 +321 @@
 
     # Now generate emails for each recipient
-    my $report =
-      _sendChangesMails( $twiki, $web, \%changeset,
-        Foswiki::Time::formatTime($timeOfLastNotify) );
-
-    $report .= _sendNewsletterMails( $twiki, $web, \%allSet );
-
+    my $report = '';
+    
+    if ( !$nochanges ) {
+        $report .= _sendChangesMails( $twiki, $web, \%changeset,
+          Foswiki::Time::formatTime($timeOfLastNotify) );
+    }
+
+    if ( !$nonews ) {
+        $report .= _sendNewsletterMails( $twiki, $web, \%allSet );
+    }
+    
     if ( $timeOfLastChange != 0 ) {
         if ( open( F, '>', $notmeta ) ) {

branches/Release01x00/MailerContrib/test/unit/MailerContrib/MailerContribSuite.pm

@@ -358 +358 @@
 
     my @webs = ( $this->{test_web}, $this->{users_web} );
-    Foswiki::Contrib::MailerContrib::mailNotify( \@webs, $this->{twiki}, 0 );
+    Foswiki::Contrib::MailerContrib::mailNotify( \@webs, $this->{twiki}, 0, 0, 0 );
 
     #print "REPORT\n",join("\n\n", @FoswikiFnTestCase::mails);
@@ -415 +415 @@
 
     my @webs = ( $testWeb2, $this->{users_web} );
-    Foswiki::Contrib::MailerContrib::mailNotify( \@webs, $this->{twiki}, 0 );
+    Foswiki::Contrib::MailerContrib::mailNotify( \@webs, $this->{twiki}, 0, 0, 0 );
 
     #print "REPORT\n",join("\n\n", @FoswikiFnTestCase::mails);
@@ -542 +542 @@
         $meta, "Before\n${s}After", $meta );
     Foswiki::Contrib::MailerContrib::mailNotify( [ $this->{test_web} ],
-        $this->{twiki}, 0 );
+        $this->{twiki}, 0, 0, 0 );
 
     my %matched;
@@ -571 +571 @@
         $meta, "Before\n${s}After", $meta );
     Foswiki::Contrib::MailerContrib::mailNotify( [ $this->{test_web} ],
-        $this->{twiki}, 0 );
+        $this->{twiki}, 0, 0, 0 );
 
     my %matched;

branches/Release01x00/MailerContrib/tools/mailnotify

@@ -35 +35 @@
 my @webs = ();
 my @exwebs = ();
+my $nonews = 0;
+my $nochanges = 0;
 
 # Called from the command line
@@ -40 +42 @@
     if( $arg eq "-q" ) {
         $verbose = 0;
+    } elsif ( $arg eq "-nonews" ) {
+        $nonews = 1;
+    } elsif ( $arg eq "-nochanges" ) {
+        $nochanges = 1;
     } elsif ( $arg =~ m/^-(.*)/ ) {
         push( @exwebs, $1 );
@@ -51 +57 @@
 
 my $report = Foswiki::Contrib::MailerContrib::mailNotify(
-    \@webs, undef, $verbose, \@exwebs );
+    \@webs, undef, $verbose, \@exwebs, $nonews, $nochanges );
 
 print $report."\n" if $verbose;