]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/recentchanges.pm
added configuration for recentchanges
[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 2.00;
7
8 sub import { #{{{
9         hook(type => "checkconfig", id => "recentchanges", call => \&checkconfig);
10         hook(type => "refresh", id => "recentchanges", call => \&refresh);
11         hook(type => "htmlize", id => "_change", call => \&htmlize);
12 } #}}}
13
14 sub checkconfig () { #{{{
15         $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
16         $config{recentchangesnum}=100 unless defined $config{recentchangesnum};
17 } #}}}
18
19 sub refresh ($) { #{{{
20         my %seen;
21
22         # add new changes
23         foreach my $change (IkiWiki::rcs_recentchanges($config{recentchangesnum})) {
24                 $seen{store($change, $config{recentchangespage})}=1;
25         }
26         
27         # delete old and excess changes
28         foreach my $page (keys %pagesources) {
29                 if ($page=~/^\Q$config{recentchangespage}\E\/change_/ && ! $seen{$page}) {
30                         unlink($config{srcdir}.'/'.$pagesources{$page});
31                 }
32         }
33 } #}}}
34
35 # Pages with extension _change have plain html markup, pass through.
36 sub htmlize (@) { #{{{
37         my %params=@_;
38         return $params{content};
39 } #}}}
40
41 sub store ($$$) { #{{{
42         my $change=shift;
43
44         my $page="$config{recentchangespage}/change_".IkiWiki::titlepage($change->{rev});
45
46         # Optimisation to avoid re-writing pages. Assumes commits never
47         # change (or that any changes are not important).
48         return $page if exists $pagesources{$page} && ! $config{rebuild};
49
50         # Limit pages to first 10, and add links to the changed pages.
51         my $is_excess = exists $change->{pages}[10];
52         delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
53         $change->{pages} = [
54                 map {
55                         if (length $config{url}) {
56                                 $_->{link} = "<a href=\"$config{url}/".
57                                         urlto($_->{page},"")."\">".
58                                         IkiWiki::pagetitle($_->{page})."</a>";
59                         }
60                         else {
61                                 $_->{link} = IkiWiki::pagetitle($_->{page});
62                         }
63                         $_;
64                 } @{$change->{pages}}
65         ];
66         push @{$change->{pages}}, { link => '...' } if $is_excess;
67
68         # See if the committer is an openid.
69         my $oiduser=IkiWiki::openiduser($change->{user});
70         if (defined $oiduser) {
71                 $change->{authorurl}=$change->{user};
72                 $change->{user}=$oiduser;
73         }
74         elsif (length $config{url}) {
75                 $change->{authorurl}="$config{url}/".
76                         (length $config{userdir} ? "$config{userdir}/" : "").
77                         $change->{user};
78         }
79
80         # escape  wikilinks and preprocessor stuff in commit messages
81         if (ref $change->{message}) {
82                 foreach my $field (@{$change->{message}}) {
83                         if (exists $field->{line}) {
84                                 $field->{line} =~ s/(?<!\\)\[\[/\\\[\[/g;
85                         }
86                 }
87         }
88
89         # Fill out a template with the change info.
90         my $template=template("change.tmpl", blind_cache => 1);
91         $template->param(
92                 %$change,
93                 commitdate => displaytime($change->{when}, "%X %x"),
94                 wikiname => $config{wikiname},
95         );
96         $template->param(baseurl => "$config{url}/") if length $config{url};
97         IkiWiki::run_hooks(pagetemplate => sub {
98                 shift->(page => $page, destpage => $page, template => $template);
99         });
100
101         my $file=$page."._change";
102         writefile($file, $config{srcdir}, $template->output);
103         utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
104
105         return $page;
106 } #}}}
107
108 sub updatechanges ($$) { #{{{
109         my $subdir=shift;
110         my @changes=@{shift()};
111         
112 } #}}}
113
114 1