Changeset 5269 for branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Subscriber.pm

Timestamp:

10/15/09 19:28:59 (3 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

File:

• branches/Release01x00/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Subscriber.pm (modified) (9 diffs)

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;
 }