typo

[git.ikiwiki.info.git] / IkiWiki / Plugin / recentchanges.pm

diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm
index 8ceb2dfbf9da8036ed08bc56efafda4c284199ae..758b98348d126aa572a537f9f0b359e5baffbb5e 100644 (file)
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -3,21 +3,48 @@ package IkiWiki::Plugin::recentchanges;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
+use Encode;
+use HTML::Entities;
 
-sub import { #{{{
+sub import {
+       hook(type => "getsetup", id => "recentchanges", call => \&getsetup);
        hook(type => "checkconfig", id => "recentchanges", call => \&checkconfig);
        hook(type => "refresh", id => "recentchanges", call => \&refresh);
-       hook(type => "htmlize", id => "_change", call => \&htmlize);
        hook(type => "pagetemplate", id => "recentchanges", call => \&pagetemplate);
-} #}}}
-
-sub checkconfig () { #{{{
+       hook(type => "htmlize", id => "_change", call => \&htmlize);
+       # Load goto to fix up links from recentchanges
+       IkiWiki::loadplugin("goto");
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+               },
+               recentchangespage => {
+                       type => "string",
+                       example => "recentchanges",
+                       description => "name of the recentchanges page",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               recentchangesnum => {
+                       type => "integer",
+                       example => 100,
+                       description => "number of changes to track",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
+
+sub checkconfig () {
        $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
        $config{recentchangesnum}=100 unless defined $config{recentchangesnum};
-} #}}}
+}
 
-sub refresh ($) { #{{{
+sub refresh ($) {
        my %seen;
 
        # add new changes
@@ -27,34 +54,36 @@ sub refresh ($) { #{{{
        
        # delete old and excess changes
        foreach my $page (keys %pagesources) {
-               if ($page=~/^\Q$config{recentchangespage}\E\/change_/ && ! $seen{$page}) {
+               if ($pagesources{$page} =~ /\._change$/ && ! $seen{$page}) {
                        unlink($config{srcdir}.'/'.$pagesources{$page});
                }
        }
-} #}}}
+}
 
-# Enable the recentchanges link on wiki pages.
-sub pagetemplate (@) { #{{{
+# Enable the recentchanges link.
+sub pagetemplate (@) {
        my %params=@_;
        my $template=$params{template};
        my $page=$params{page};
-       if ($config{rcs} && $page ne $config{recentchangespage} &&
-           $template->query(name => "recentchangesurl")) {
+
+       if (defined $config{recentchangespage} && $config{rcs} &&
+           $template->query(name => "recentchangesurl") &&
+           $page ne $config{recentchangespage}) {
                $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
                $template->param(have_actions => 1);
        }
-} #}}}
+}
 
 # Pages with extension _change have plain html markup, pass through.
-sub htmlize (@) { #{{{
+sub htmlize (@) {
        my %params=@_;
        return $params{content};
-} #}}}
+}
 
-sub store ($$$) { #{{{
+sub store ($$$) {
        my $change=shift;
 
-       my $page="$config{recentchangespage}/change_".IkiWiki::titlepage($change->{rev});
+       my $page="$config{recentchangespage}/change_".titlepage($change->{rev});
 
        # Optimisation to avoid re-writing pages. Assumes commits never
        # change (or that any changes are not important).
@@ -65,13 +94,18 @@ sub store ($$$) { #{{{
        delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
        $change->{pages} = [
                map {
-                       if (length $config{url}) {
-                               $_->{link} = "<a href=\"$config{url}/".
-                                       urlto($_->{page},"")."\">".
-                                       IkiWiki::pagetitle($_->{page})."</a>";
+                       if (length $config{cgiurl}) {
+                               $_->{link} = "<a href=\"".
+                                       IkiWiki::cgiurl(
+                                               do => "goto",
+                                               page => $_->{page}
+                                       ).
+                                       "\" rel=\"nofollow\">".
+                                       pagetitle($_->{page}).
+                                       "</a>"
                        }
                        else {
-                               $_->{link} = IkiWiki::pagetitle($_->{page});
+                               $_->{link} = pagetitle($_->{page});
                        }
                        $_->{baseurl}="$config{url}/" if length $config{url};
 
@@ -80,24 +114,26 @@ sub store ($$$) { #{{{
        ];
        push @{$change->{pages}}, { link => '...' } if $is_excess;
 
-       # See if the committer is an openid.
        $change->{author}=$change->{user};
-       my $oiduser=IkiWiki::openiduser($change->{user});
+       my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
        if (defined $oiduser) {
                $change->{authorurl}=$change->{user};
-               $change->{user}=$oiduser;
+               $change->{user}=defined $change->{nickname} ? $change->{nickname} : $oiduser;
        }
-       elsif (length $config{url}) {
-               $change->{authorurl}="$config{url}/".
-                       (length $config{userdir} ? "$config{userdir}/" : "").
-                       $change->{user};
+       elsif (length $config{cgiurl}) {
+               $change->{authorurl} = IkiWiki::cgiurl(
+                       do => "goto",
+                       page => IkiWiki::userpage($change->{author}),
+               );
        }
 
-       # escape  wikilinks and preprocessor stuff in commit messages
        if (ref $change->{message}) {
                foreach my $field (@{$change->{message}}) {
                        if (exists $field->{line}) {
-                               $field->{line} =~ s/(?<!\\)\[\[/\\\[\[/g;
+                               # escape html
+                               $field->{line} = encode_entities($field->{line});
+                               # escape links and preprocessor stuff
+                               $field->{line} = encode_entities($field->{line}, '\[\]');
                        }
                }
        }
@@ -109,8 +145,13 @@ sub store ($$$) { #{{{
                commitdate => displaytime($change->{when}, "%X %x"),
                wikiname => $config{wikiname},
        );
+       
+       $template->param(permalink => "$config{url}/$config{recentchangespage}/#change-".titlepage($change->{rev}))
+               if exists $config{url};
+       
        IkiWiki::run_hooks(pagetemplate => sub {
-               shift->(page => $page, destpage => $page, template => $template);
+               shift->(page => $page, destpage => $page,
+                       template => $template, rev => $change->{rev});
        });
 
        my $file=$page."._change";
@@ -118,12 +159,6 @@ sub store ($$$) { #{{{
        utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
 
        return $page;
-} #}}}
-
-sub updatechanges ($$) { #{{{
-       my $subdir=shift;
-       my @changes=@{shift()};
-       
-} #}}}
+}
 
 1