IkiWiki/Plugin/recentchanges.pm

   1 #!/usr/bin/perl
   2 package IkiWiki::Plugin::recentchanges;
   3
   4 use warnings;
   5 use strict;
   6 use IkiWiki 3.00;
   7 use Encode;
   8 use HTML::Entities;
   9
  10 sub import {
  11         hook(type => "getsetup", id => "recentchanges", call => \&getsetup);
  12         hook(type => "checkconfig", id => "recentchanges", call => \&checkconfig);
  13         hook(type => "refresh", id => "recentchanges", call => \&refresh);
  14         hook(type => "pagetemplate", id => "recentchanges", call => \&pagetemplate);
  15         hook(type => "htmlize", id => "_change", call => \&htmlize);
  16         hook(type => "sessioncgi", id => "recentchanges", call => \&sessioncgi);
  17         # Load goto to fix up links from recentchanges
  18         IkiWiki::loadplugin("goto");
  19 }
  20
  21 sub getsetup () {
  22         return
  23                 plugin => {
  24                         safe => 1,
  25                         rebuild => 1,
  26                 },
  27                 recentchangespage => {
  28                         type => "string",
  29                         example => "recentchanges",
  30                         description => "name of the recentchanges page",
  31                         safe => 1,
  32                         rebuild => 1,
  33                 },
  34                 recentchangesnum => {
  35                         type => "integer",
  36                         example => 100,
  37                         description => "number of changes to track",
  38                         safe => 1,
  39                         rebuild => 0,
  40                 },
  41 }
  42
  43 sub checkconfig () {
  44         $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
  45         $config{recentchangesnum}=100 unless defined $config{recentchangesnum};
  46 }
  47
  48 sub refresh ($) {
  49         my %seen;
  50
  51         # add new changes
  52         foreach my $change (IkiWiki::rcs_recentchanges($config{recentchangesnum})) {
  53                 $seen{store($change, $config{recentchangespage})}=1;
  54         }
  55
  56         # delete old and excess changes
  57         foreach my $page (keys %pagesources) {
  58                 if ($pagesources{$page} =~ /\._change$/ && ! $seen{$page}) {
  59                         unlink($config{srcdir}.'/'.$pagesources{$page});
  60                 }
  61         }
  62 }
  63
  64 sub confirmation_form {
  65         my ($q, $session, $rev) = @_;
  66
  67         eval q{use CGI::FormBuilder};
  68         error($@) if $@;
  69         my $f = CGI::FormBuilder->new(
  70                 name => "revert",
  71                 header => 0,
  72                 charset => "utf-8",
  73                 method => 'POST',
  74                 javascript => 0,
  75                 params => $q,
  76                 action => $config{cgiurl},
  77                 stylesheet => 1,
  78                 template => { template('revert.tmpl') },
  79         );
  80
  81         $f->field(name => "sid", type => "hidden", value => $session->id,
  82                 force => 1);
  83         $f->field(name => "do", type => "hidden", value => "revert",
  84                 force => 1);
  85
  86         return $f, ["Revert", "Cancel"];
  87 }
  88
  89 sub sessioncgi ($$) {
  90         my ($q, $session) = @_;
  91         my $do = $q->param('do');
  92         my $rev = $q->param('rev');
  93
  94         return unless $do eq 'revert' && $rev;
  95
  96         IkiWiki::rcs_preprevert(cgi => $q, session => $session, rev => $rev);
  97
  98         my ($form, $buttons) = confirmation_form($q, $session);
  99         IkiWiki::decode_form_utf8($form);
 100
 101         if ($form->submitted eq 'Revert' && $form->validate) {
 102                 IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
 103                 IkiWiki::disable_commit_hook();
 104                 my $r = IkiWiki::rcs_revert(
 105                         session => $session,
 106                         rev => $rev);
 107                 IkiWiki::enable_commit_hook();
 108
 109                 if ($r) {
 110                         die "Revert '$rev' failed.";
 111                 }
 112                 else {
 113                         require IkiWiki::Render;
 114                         IkiWiki::refresh();
 115                         IkiWiki::saveindex();
 116                 }
 117         }
 118         else {
 119                 $form->title(sprintf(gettext("confirm reversion of %s"), $rev));
 120                 $form->tmpl_param(diff => encode_entities(scalar IkiWiki::rcs_diff($rev)));
 121                 $form->field(name => "rev", type => "hidden", value => $rev, force => 1);
 122                 IkiWiki::showform($form, $buttons, $session, $q);
 123                 exit 0;
 124         }
 125
 126         IkiWiki::redirect($q, urlto($config{recentchangespage}, ''));
 127         exit 0;
 128 }
 129
 130 # Enable the recentchanges link.
 131 sub pagetemplate (@) {
 132         my %params=@_;
 133         my $template=$params{template};
 134         my $page=$params{page};
 135
 136         if (defined $config{recentchangespage} && $config{rcs} &&
 137             $template->query(name => "recentchangesurl") &&
 138             $page ne $config{recentchangespage}) {
 139                 $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
 140                 $template->param(have_actions => 1);
 141         }
 142 }
 143
 144 # Pages with extension _change have plain html markup, pass through.
 145 sub htmlize (@) {
 146         my %params=@_;
 147         return $params{content};
 148 }
 149
 150 sub store ($$$) {
 151         my $change=shift;
 152
 153         my $page="$config{recentchangespage}/change_".titlepage($change->{rev});
 154
 155         # Optimisation to avoid re-writing pages. Assumes commits never
 156         # change (or that any changes are not important).
 157         return $page if exists $pagesources{$page} && ! $config{rebuild};
 158
 159         # Limit pages to first 10, and add links to the changed pages.
 160         my $is_excess = exists $change->{pages}[10];
 161         delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
 162         $change->{pages} = [
 163                 map {
 164                         if (length $config{cgiurl}) {
 165                                 $_->{link} = "<a href=\"".
 166                                         IkiWiki::cgiurl(
 167                                                 do => "goto",
 168                                                 page => $_->{page}
 169                                         ).
 170                                         "\" rel=\"nofollow\">".
 171                                         pagetitle($_->{page}).
 172                                         "</a>"
 173                         }
 174                         else {
 175                                 $_->{link} = pagetitle($_->{page});
 176                         }
 177                         $_->{baseurl}="$config{url}/" if length $config{url};
 178
 179                         $_;
 180                 } @{$change->{pages}}
 181         ];
 182         push @{$change->{pages}}, { link => '...' } if $is_excess;
 183
 184         if (length $config{cgiurl}) {
 185                 $change->{reverturl} = IkiWiki::cgiurl(
 186                         do => "revert",
 187                         rev => $change->{rev}
 188                 );
 189         }
 190
 191         $change->{author}=$change->{user};
 192         my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
 193         if (defined $oiduser) {
 194                 $change->{authorurl}=$change->{user};
 195                 $change->{user}=defined $change->{nickname} ? $change->{nickname} : $oiduser;
 196         }
 197         elsif (length $config{cgiurl}) {
 198                 $change->{authorurl} = IkiWiki::cgiurl(
 199                         do => "goto",
 200                         page => IkiWiki::userpage($change->{author}),
 201                 );
 202         }
 203
 204         if (ref $change->{message}) {
 205                 foreach my $field (@{$change->{message}}) {
 206                         if (exists $field->{line}) {
 207                                 # escape html
 208                                 $field->{line} = encode_entities($field->{line});
 209                                 # escape links and preprocessor stuff
 210                                 $field->{line} = encode_entities($field->{line}, '\[\]');
 211                         }
 212                 }
 213         }
 214
 215         # Fill out a template with the change info.
 216         my $template=template("change.tmpl", blind_cache => 1);
 217         $template->param(
 218                 %$change,
 219                 commitdate => displaytime($change->{when}, "%X %x"),
 220                 wikiname => $config{wikiname},
 221         );
 222
 223         $template->param(permalink => "$config{url}/$config{recentchangespage}/#change-".titlepage($change->{rev}))
 224                 if exists $config{url};
 225
 226         IkiWiki::run_hooks(pagetemplate => sub {
 227                 shift->(page => $page, destpage => $page,
 228                         template => $template, rev => $change->{rev});
 229         });
 230
 231         my $file=$page."._change";
 232         writefile($file, $config{srcdir}, $template->output);
 233         utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
 234
 235         return $page;
 236 }
 237
 238 1