Changeset 1141

Timestamp:

01/22/08 16:38:24 (9 months ago)

Author:

earle

Message:

Allow wiki links in change summaries. Closes #115.

Location:

trunk

Files:

• Changes (modified) (1 diff)
• lib/OpenGuides.pm (modified) (7 diffs)
• lib/OpenGuides/Utils.pm (modified) (2 diffs)
• t/45_home_recent_changes.t (modified) (3 diffs)

trunk/Changes

@@ -5 +5 @@
 
 0.62    
+        Allow wiki page links (simple: [[Foo]], title: [[Foo|bar]]) in
+          change summaries.
         Ensure that all modules we ship are versioned.
         Added experimental support for local IP blacklisting modules; see the

trunk/lib/OpenGuides.pm

@@ -339 +339 @@
                 metadata_was   => { edit_type => "Normal edit" },
             );
+            my $base_url = $config->script_name . '?';
             @recent = map {
                             {
@@ -345 +346 @@
                                   CGI->escapeHTML($_->{last_modified}),
                               version       => CGI->escapeHTML($_->{version}),
-                              comment       =>
+                              comment       => OpenGuides::Utils::parse_change_comment(
                                   CGI->escapeHTML($_->{metadata}{comment}[0]),
+                                  $base_url,
+                              ),
                               username      =>
                                   CGI->escapeHTML($_->{metadata}{username}[0]),
-                              url           => $config->script_name . "?"
+                              url           => $base_url
                                              . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name}))
                             }
@@ -653 +656 @@
           unless $minor_edits;
         my @rc = $self->{wiki}->list_recent_changes( %criteria );
- 
+
+        my $base_url = $config->script_name . '?';
+        
         @rc = map {
             {
@@ -659 +664 @@
               last_modified => CGI->escapeHTML($_->{last_modified}),
               version     => CGI->escapeHTML($_->{version}),
-              comment     => CGI->escapeHTML($_->{metadata}{comment}[0]),
+              comment     => OpenGuides::Utils::parse_change_comment(
+                  CGI->escapeHTML($_->{metadata}{comment}[0]),
+                  $base_url,
+              ),
               username    => CGI->escapeHTML($_->{metadata}{username}[0]),
               host        => CGI->escapeHTML($_->{metadata}{host}[0]),
               username_param => CGI->escape($_->{metadata}{username}[0]),
               edit_type   => CGI->escapeHTML($_->{metadata}{edit_type}[0]),
-              url         => $config->script_name . "?"
+              url         => $base_url
       . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name})),
         }
@@ -678 +686 @@
             my @rc = $self->{wiki}->list_recent_changes( %criteria );
 
+            my $base_url = $config->script_name . '?';
+            
             @rc = map {
             {
@@ -683 +693 @@
               last_modified => CGI->escapeHTML($_->{last_modified}),
               version     => CGI->escapeHTML($_->{version}),
-              comment     => CGI->escapeHTML($_->{metadata}{comment}[0]),
+              comment     => OpenGuides::Utils::parse_change_comment(
+                  CGI->escapeHTML($_->{metadata}{comment}[0]),
+                  $base_url,
+              ),
               username    => CGI->escapeHTML($_->{metadata}{username}[0]),
               host        => CGI->escapeHTML($_->{metadata}{host}[0]),
               username_param => CGI->escape($_->{metadata}{username}[0]),
               edit_type   => CGI->escapeHTML($_->{metadata}{edit_type}[0]),
-              url         => $config->script_name . "?"
+              url         => $base_url
       . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name})),
         }
@@ -1022 +1035 @@
             modified => CGI->escapeHTML( $node_data{last_modified} ),
             username => CGI->escapeHTML( $node_data{metadata}{username}[0] ),
-            comment  => CGI->escapeHTML( $node_data{metadata}{comment}[0] ),
-                       } if $node_data{version};
+            comment  => OpenGuides::Utils::parse_change_comment(
+                CGI->escapeHTML( $node_data{metadata}{comment}[0] ),
+                $self->config->script_name . '?',
+            ),
+        } if $node_data{version};
     }
     @history = reverse @history;

trunk/lib/OpenGuides/Utils.pm

@@ -394 +394 @@
 };
 
+=item B<parse_change_comment>
+
+    my $change_comment = parse_change_comment($string, $base_url);
+    
+Given a base URL (for example, C<http://example.com/wiki.cgi?>), takes a string, 
+replaces C<[[page]]> and C<[[page|titled link]]> with
+
+    <a href="http://example.com/wiki.cgi?page">page</a>
+
+and
+
+    <a href="http://example.com/wiki.cgi?page">titled link</a>
+
+respectively, and returns it. This is a limited subset of wiki markup suitable for
+use in page change comments.
+
+=cut
+
+sub parse_change_comment {   
+    my ($comment, $base_url) = @_;
+
+    my @links = $comment =~ m{\[\[(.*?)\]\]}g;
+
+    # It's not all that great having to reinvent the wheel in this way, but
+    # Text::WikiFormat won't let you specify the subset of wiki notation that 
+    # you're interested in. C'est la vie.
+    foreach (@links) {
+        if (/(.*?)\|(.*)/) {
+            my ($page, $title) = ($1, $2);
+            $comment =~ s{\[\[$page\|$title\]\]}
+                         {<a href="$base_url$page">$title</a>};
+        } else {
+            my $page = $_;
+            $comment =~ s{\[\[$page\]\]}
+                         {<a href="$base_url$page">$page</a>};
+        }
+    }
+
+    return $comment;
+}
+
 =item B<send_email>
 
@@ -421 +462 @@
 
 =cut
+
 
 sub send_email {

trunk/t/45_home_recent_changes.t

@@ -11 +11 @@
 }
 
-plan tests => 13;
+plan tests => 15;
 
 my ( $config, $guide, $wiki );
@@ -60 +60 @@
 like( $output, qr/Edit this page/, "...edit this page link is there too" );
 
+OpenGuides::Test->write_data(
+                              guide    => $guide,
+                              node     => "Red Lion",
+                              content  => "A nice pub.",
+                              username => "Earle",
+                              comment  => "I also edited it. For fun, here are two links: [[A Page]], and the same link [[A Page|again]].",
+                            );
+
+# Reload page.
+$output = $guide->display_node(
+                                   id            => $config->home_name,
+                                   return_output => 1,
+                                 );
+
+like( $output, qr{<a href="\?A Page">A Page</a>}, "...simple wiki links appear in Recent Changes" );
+like( $output, qr{<a href="\?A Page">again</a>},  "...titled wiki links appear in Recent Changes" );
+
+
 # And that they don't show up if we don't want them.  Turn off the navbar
 # too, since we want to make sure the edit page link shows up regardless (it
@@ -78 +96 @@
 unlike( $output, qr/Ten most.*recent changes/, "...heading not shown either" );
 like( $output, qr/Edit this page/, "...edit this page link is there though" );
+