Changeset 3974

Timestamp:

05/24/09 12:15:55 (3 years ago)

Author:

CrawfordCurrie

Message:

Item1603: use quotes to protect topic names with odd characters in them

Location:

trunk/MailerContrib

Files:

• data/System/MailerContrib.txt (modified) (1 diff)
• lib/Foswiki/Contrib/MailerContrib.pm (modified) (4 diffs)
• lib/Foswiki/Contrib/MailerContrib/Subscription.pm (modified) (1 diff)
• lib/Foswiki/Contrib/MailerContrib/WebNotify.pm (modified) (1 diff)
• test/unit/MailerContrib/MailerContribSuite.pm (modified) (6 diffs)

trunk/MailerContrib/data/System/MailerContrib.txt

@@ -163 +163 @@
 |  Version: | %$VERSION% |
 |  Change History: | |
+|  24 May 2009 | Foswikitask:Item1603: use quotes to protect topic names with odd characters in them |
 |  23 Apr 2009 | Foswikitask:Item1501: Minor bug in logfile output fixed |
 |  03 Dec 2008 | Re-released for the Foswiki project |

trunk/MailerContrib/lib/Foswiki/Contrib/MailerContrib.pm

@@ -133 +133 @@
     };
 
-    my $ret = Foswiki::Contrib::MailerContrib::parsePageList( $subscribed, $who,
-        $topicList );
+    my $ret = parsePageList( $subscribed, $who, $topicList );
 
     return ( !defined( $subscribed->{not_subscribed} )
@@ -165 +164 @@
         push( @{ $subscribed->{not_subscribed} }, $stopic );
     }
-    return '';
 }
 
 =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
@@ -184 +183 @@
     #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..
+    # $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+)\))?/&{$object->{topicSub}}($object, $who, $unsubscribe||$1, $2, $3, $4)/e
-      )
-    {
-
+              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
     }
@@ -205 +210 @@
     if ( !Foswiki::Func::webExists($web) ) {
 
-        #        print STDERR "**** ERROR mailnotifier cannot find web $web\n";
+        # print STDERR "**** ERROR mailnotifier cannot find web $web\n";
         return '';
     }

trunk/MailerContrib/lib/Foswiki/Contrib/MailerContrib/Subscription.pm

@@ -68 +68 @@
     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} );

trunk/MailerContrib/lib/Foswiki/Contrib/MailerContrib/WebNotify.pm

@@ -417 +417 @@
     $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");
+        Foswiki::Func::writeWarning(
+            "Badly formatted page list at $who: $spec");
         return -1;
     }

trunk/MailerContrib/test/unit/MailerContrib/MailerContribSuite.pm

@@ -20 +20 @@
     TestTopic122  => "r1->r2",
     TestTopic1221 => "r1->r2",
-    TestTopic2    => "r2->r3",
-    TestTopic21   => "r1->r2",
+    'TestTopic2'    => "r2->r3",
+    'TestTopic21'   => "r1->r2",
 );
 
@@ -34 +34 @@
     TestTopic122  => "That danged robot",
     TestTopic1221 => "What's up, Buck?",
-    TestTopic2    => "roast my nipple-nuts",
-    TestTopic21   => "smoke me a kipper, I'll be back for breakfast",
+    'TestTopic2'    => "roast my nipple-nuts",
+    'TestTopic21'   => "smoke me a kipper, I'll be back for breakfast",
 
     # High-bit chars - assumes {Site}{CharSet} is set for a high-bit
@@ -145 +145 @@
         {
             email     => "email4\@example.com",
-            entry     => "email4\@example.com: TestTopic1 (0), TestTopic2 (3)",
+            entry     => "email4\@example.com: TestTopic1 (0), 'TestTopic2' (3)",
             topicsout => "TestTopic1 TestTopic2 TestTopic21"
         },
@@ -153 +153 @@
             email => "email5\@example.com",
             entry =>
-              "email5\@example.com: TestTopic1 + TestTopic2(3), -TestTopic21",
+              "email5\@example.com: TestTopic1 + 'TestTopic2'(3), -'TestTopic21'",
             topicsout => "TestTopic1 TestTopic2"
         },
@@ -167 +167 @@
         {
             email => "email7\@example.com",
-            entry => "email7\@example.com: TestTopic*1 - \\\n   TestTopic2*",
+            entry => "email7\@example.com: TestTopic*1 - \\\n   'TestTopic2*'",
             topicsout => "TestTopic1 TestTopic11 TestTopic121",
         },
@@ -338 +338 @@
         ( $meta, $text ) = Foswiki::Func::readTopic( $web, "TestTopic2" );
         Foswiki::Func::saveTopic( $web, "TestTopic2", $meta,
-            $finalText{TestTopic2}, { forcenewrevision => 1 } );
+            $finalText{'TestTopic2'}, { forcenewrevision => 1 } );
 
         ( $meta, $text ) = Foswiki::Func::readTopic( $web, "TestTopic21" );
         Foswiki::Func::saveTopic( $web, "TestTopic21", $meta,
-            $finalText{TestTopic21}, { forcenewrevision => 1 } );
+            $finalText{'TestTopic21'}, { forcenewrevision => 1 } );
 
         # wait a wee bit more for the clock to tick over again