3081ac1316efd501b95d1ba650d4ac321957b5cd
[ikiwiki.git] / 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 sessioncgi ($$) {
65         my ($q, $session) = @_;
66         my $do = $q->param('do');
67         my $rev = $q->param('rev');
68
69         return unless $do eq 'revert' && $rev;
70
71         my @changes=$IkiWiki::hooks{rcs}{rcs_preprevert}{call}->($rev);
72         IkiWiki::check_canchange(
73                 cgi => $q,
74                 session => $session,
75                 changes => \@changes,
76         );
77
78         eval q{use CGI::FormBuilder};
79         error($@) if $@;
80         my $form = CGI::FormBuilder->new(
81                 name => "revert",
82                 header => 0,
83                 charset => "utf-8",
84                 method => 'POST',
85                 javascript => 0,
86                 params => $q,
87                 action => IkiWiki::cgiurl(),
88                 stylesheet => 1,
89                 template => { template('revert.tmpl') },
90                 fields => [qw{revertmessage do sid rev}],
91         );
92         my $buttons=["Revert", "Cancel"];
93
94         $form->field(name => "revertmessage", type => "text", size => 80);
95         $form->field(name => "sid", type => "hidden", value => $session->id,
96                 force => 1);
97         $form->field(name => "do", type => "hidden", value => "revert",
98                 force => 1);
99
100         IkiWiki::decode_form_utf8($form);
101
102         if ($form->submitted eq 'Revert' && $form->validate) {
103                 IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
104                 my $message=sprintf(gettext("This reverts commit %s"), $rev);
105                 if (defined $form->field('revertmessage') &&
106                     length $form->field('revertmessage')) {
107                         $message=$form->field('revertmessage')."\n\n".$message;
108                 }
109                 my $r = $IkiWiki::hooks{rcs}{rcs_revert}{call}->($rev);
110                 error $r if defined $r;
111                 IkiWiki::disable_commit_hook();
112                 IkiWiki::rcs_commit_staged(
113                         message => $message,
114                         session => $session,
115                 );
116                 IkiWiki::enable_commit_hook();
117         
118                 require IkiWiki::Render;
119                 IkiWiki::refresh();
120                 IkiWiki::saveindex();
121         }
122         elsif ($form->submitted ne 'Cancel') {
123                 $form->title(sprintf(gettext("confirm reversion of %s"), $rev));
124                 $form->tmpl_param(diff => encode_entities(scalar IkiWiki::rcs_diff($rev, 200)));
125                 $form->field(name => "rev", type => "hidden", value => $rev, force => 1);
126                 IkiWiki::showform($form, $buttons, $session, $q);
127                 exit 0;
128         }
129
130         IkiWiki::redirect($q, urlto($config{recentchangespage}));
131         exit 0;
132 }
133
134 # Enable the recentchanges link.
135 sub pagetemplate (@) {
136         my %params=@_;
137         my $template=$params{template};
138         my $page=$params{page};
139
140         if (defined $config{recentchangespage} && $config{rcs} &&
141             $template->query(name => "recentchangesurl") &&
142             $page ne $config{recentchangespage}) {
143                 $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
144                 $template->param(have_actions => 1);
145         }
146 }
147
148 # Pages with extension _change have plain html markup, pass through.
149 sub htmlize (@) {
150         my %params=@_;
151         return $params{content};
152 }
153
154 sub store ($$$) {
155         my $change=shift;
156
157         my $page="$config{recentchangespage}/change_".titlepage($change->{rev});
158
159         # Optimisation to avoid re-writing pages. Assumes commits never
160         # change (or that any changes are not important).
161         return $page if exists $pagesources{$page} && ! $config{rebuild};
162
163         # Limit pages to first 10, and add links to the changed pages.
164         my $is_excess = exists $change->{pages}[10];
165         delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
166         $change->{pages} = [
167                 map {
168                         if (length $config{cgiurl}) {
169                                 $_->{link} = "<a href=\"".
170                                         IkiWiki::cgiurl(
171                                                 do => "goto",
172                                                 page => $_->{page}
173                                         ).
174                                         "\" rel=\"nofollow\">".
175                                         pagetitle($_->{page}).
176                                         "</a>"
177                         }
178                         else {
179                                 $_->{link} = pagetitle($_->{page});
180                         }
181                         $_->{baseurl}=IkiWiki::baseurl(undef) if length $config{url};
182
183                         $_;
184                 } @{$change->{pages}}
185         ];
186         push @{$change->{pages}}, { link => '...' } if $is_excess;
187         
188         if (length $config{cgiurl} &&
189             exists $IkiWiki::hooks{rcs}{rcs_preprevert} &&
190             exists $IkiWiki::hooks{rcs}{rcs_revert}) {
191                 $change->{reverturl} = IkiWiki::cgiurl(
192                         do => "revert",
193                         rev => $change->{rev}
194                 );
195         }
196
197         $change->{author}=$change->{user};
198         my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
199         if (defined $oiduser) {
200                 $change->{authorurl}=$change->{user};
201                 $change->{user}=defined $change->{nickname} ? $change->{nickname} : $oiduser;
202         }
203         elsif (length $config{cgiurl}) {
204                 $change->{authorurl} = IkiWiki::cgiurl(
205                         do => "goto",
206                         page => IkiWiki::userpage($change->{author}),
207                 );
208         }
209
210         if (ref $change->{message}) {
211                 foreach my $field (@{$change->{message}}) {
212                         if (exists $field->{line}) {
213                                 # escape html
214                                 $field->{line} = encode_entities($field->{line});
215                                 # escape links and preprocessor stuff
216                                 $field->{line} = encode_entities($field->{line}, '\[\]');
217                         }
218                 }
219         }
220
221         # Fill out a template with the change info.
222         my $template=template("change.tmpl", blind_cache => 1);
223         $template->param(
224                 %$change,
225                 commitdate => displaytime($change->{when}, "%X %x"),
226                 wikiname => $config{wikiname},
227         );
228         
229         $template->param(permalink => urlto($config{recentchangespage}, undef)."#change-".titlepage($change->{rev}))
230                 if exists $config{url};
231         
232         IkiWiki::run_hooks(pagetemplate => sub {
233                 shift->(page => $page, destpage => $page,
234                         template => $template, rev => $change->{rev});
235         });
236
237         my $file=$page."._change";
238         writefile($file, $config{srcdir}, $template->output);
239         utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
240
241         return $page;
242 }
243
244 1