X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/598d338b11cbcbf5d87517f3b8fcd99e357a31a2..9abda92324e2ae17a7437d7c0dded39cf4462649:/IkiWiki/Plugin/recentchanges.pm diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm index 6c9848ba3..ef108b3f0 100644 --- a/IkiWiki/Plugin/recentchanges.pm +++ b/IkiWiki/Plugin/recentchanges.pm @@ -3,79 +3,181 @@ package IkiWiki::Plugin::recentchanges; use warnings; use strict; -use IkiWiki 2.00; - -sub import { #{{{ - hook(type => "needsbuild", id => "recentchanges", - call => \&needsbuild); - hook(type => "preprocess", id => "recentchanges", - call => \&preprocess); - hook(type => "htmlize", id => "_change", - call => \&htmlize); -} #}}} - -sub needsbuild () { #{{{ - my @changes=IkiWiki::rcs_recentchanges(100); - updatechanges("*", "recentchanges", \@changes); -} #}}} - -sub preprocess (@) { #{{{ - my %params=@_; - - # TODO +use IkiWiki 3.00; +use Encode; +use HTML::Entities; + +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 => "pagetemplate", id => "recentchanges", call => \&pagetemplate); + hook(type => "htmlize", id => "_change", call => \&htmlize); + hook(type => "cgi", id => "recentchanges", call => \&cgi); +} + +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 ($) { + my %seen; + + # add new changes + foreach my $change (IkiWiki::rcs_recentchanges($config{recentchangesnum})) { + $seen{store($change, $config{recentchangespage})}=1; + } + + # delete old and excess changes + foreach my $page (keys %pagesources) { + if ($pagesources{$page} =~ /\._change$/ && ! $seen{$page}) { + unlink($config{srcdir}.'/'.$pagesources{$page}); + } + } +} - return ""; -} #}}} +# Enable the recentchanges link on wiki pages. +sub pagetemplate (@) { + my %params=@_; + my $template=$params{template}; + my $page=$params{page}; + + if (defined $config{recentchangespage} && $config{rcs} && + $page ne $config{recentchangespage} && + $template->query(name => "recentchangesurl")) { + $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 cgi ($) { + my $cgi=shift; + if (defined $cgi->param('do') && $cgi->param('do') eq "recentchanges_link") { + # This is a link from a change page to some + # other page. Since the change pages are only generated + # once, statically, links on them won't be updated if the + # page they link to is deleted, or newly created, or + # changes for whatever reason. So this CGI handles that + # dynamic linking stuff. + my $page=decode_utf8($cgi->param("page")); + if (!defined $page) { + error("missing page parameter"); + } + + IkiWiki::loadindex(); + + # If the page is internal (like a comment), see if it has a + # permalink. Comments do. + if (IkiWiki::isinternal($page) && + defined $pagestate{$page}{meta}{permalink}) { + IkiWiki::redirect($cgi, + $pagestate{$page}{meta}{permalink}); + exit; + } + + my $link=bestlink("", $page); + if (! length $link) { + print "Content-type: text/html\n\n"; + print IkiWiki::misctemplate(gettext(gettext("missing page")), + "

". + sprintf(gettext("The page %s does not exist."), + htmllink("", "", $page)). + "

"); + } + else { + IkiWiki::redirect($cgi, urlto($link, undef, 1)); + } + + exit; + } +} -sub store ($$) { #{{{ +sub store ($$$) { my $change=shift; - my $subdir=shift; - - my $page="$subdir/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). - return if exists $pagesources{$page} && ! $config{rebuild}; + return $page if exists $pagesources{$page} && ! $config{rebuild}; # Limit pages to first 10, and add links to the changed pages. my $is_excess = exists $change->{pages}[10]; delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess; $change->{pages} = [ map { - if (length $config{url}) { - $_->{link} = "{page},"")."\">". - IkiWiki::pagetitle($_->{page}).""; + if (length $config{cgiurl}) { + $_->{link} = " "recentchanges_link", + page => $_->{page} + ). + "\" rel=\"nofollow\">". + pagetitle($_->{page}). + "" } else { - $_->{link} = IkiWiki::pagetitle($_->{page}); + $_->{link} = pagetitle($_->{page}); } + $_->{baseurl}="$config{url}/" if length $config{url}; + $_; } @{$change->{pages}} ]; push @{$change->{pages}}, { link => '...' } if $is_excess; - # Take the first line of the commit message as a summary. - #my $m=shift @{$change->{message}}; - #$change->{summary}=$m->{line}; - #delete $change->{message} unless @{$change->{message}}; - # See if the committer is an openid. - my $oiduser=IkiWiki::openiduser($change->{user}); + $change->{author}=$change->{user}; + my $oiduser=eval { IkiWiki::openiduser($change->{user}) }; if (defined $oiduser) { $change->{authorurl}=$change->{user}; $change->{user}=$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 => "recentchanges_link", + page => (length $config{userdir} ? "$config{userdir}/" : "").$change->{author}, + ); + } + + if (ref $change->{message}) { + foreach my $field (@{$change->{message}}) { + if (exists $field->{line}) { + # escape html + $field->{line} = encode_entities($field->{line}); + # escape links and preprocessor stuff + $field->{line} = encode_entities($field->{line}, '\[\]'); + } + } } # Fill out a template with the change info. @@ -85,26 +187,20 @@ sub store ($$) { #{{{ commitdate => displaytime($change->{when}, "%X %x"), wikiname => $config{wikiname}, ); - $template->param(baseurl => "$config{url}/") if length $config{url}; + + $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 $html=$template->output; - # escape wikilinks and preprocessor stuff - $html=~s/(?{when}, $change->{when}, "$config{srcdir}/$page._change"; -} #}}} - -sub updatechanges ($$) { #{{{ - my $pagespec=shift; - my $subdir=shift; - my @changes=@{shift()}; - foreach my $change (@changes) { - store($change, $subdir); - } - # TODO: delete old -} #}}} + my $file=$page."._change"; + writefile($file, $config{srcdir}, $template->output); + utime $change->{when}, $change->{when}, "$config{srcdir}/$file"; + + return $page; +} 1