]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/inline.pm
* Add a test suite for the mercurial backend, contributed by Emanuele Aina.
[ikiwiki.git] / IkiWiki / Plugin / inline.pm
1 #!/usr/bin/perl
2 # Page inlining and blogging.
3 package IkiWiki::Plugin::inline;
4
5 use warnings;
6 use strict;
7 use IkiWiki 1.00;
8 use IkiWiki::Render; # for displaytime
9 use URI;
10
11 sub import { #{{{
12         hook(type => "preprocess", id => "inline", 
13                 call => \&IkiWiki::preprocess_inline);
14         hook(type => "pagetemplate", id => "inline",
15                 call => \&IkiWiki::pagetemplate_inline);
16         # Hook to change to do pinging since it's called late.
17         # This ensures each page only pings once and prevents slow
18         # pings interrupting page builds.
19         hook(type => "change", id => "inline", 
20                 call => \&IkiWiki::pingurl);
21 } # }}}
22
23 # Back to ikiwiki namespace for the rest, this code is very much
24 # internal to ikiwiki even though it's separated into a plugin.
25 package IkiWiki;
26
27 my %toping;
28 my %feedlinks;
29
30 sub yesno ($) { #{{{
31         my $val=shift;
32         return (defined $val && lc($val) eq "yes");
33 } #}}}
34
35 sub preprocess_inline (@) { #{{{
36         my %params=@_;
37         
38         if (! exists $params{pages}) {
39                 return "";
40         }
41         my $raw=yesno($params{raw});
42         my $archive=yesno($params{archive});
43         my $rss=($config{rss} && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
44         my $atom=($config{atom} && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
45         my $feeds=exists $params{feeds} ? yesno($params{feeds}) : 1;
46         if (! exists $params{show} && ! $archive) {
47                 $params{show}=10;
48         }
49         my $desc;
50         if (exists $params{description}) {
51                 $desc = $params{description} 
52         } else {
53                 $desc = $config{wikiname};
54         }
55         my $actions=yesno($params{actions});
56
57         my @list;
58         foreach my $page (keys %pagesources) {
59                 next if $page eq $params{page};
60                 if (pagespec_match($page, $params{pages})) {
61                         push @list, $page;
62                 }
63         }
64
65         if (exists $params{sort} && $params{sort} eq 'title') {
66                 @list=sort @list;
67         }
68         elsif (! exists $params{sort} || $params{sort} eq 'age') {
69                 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
70         }
71         else {
72                 return "unknown sort type $params{sort}";
73         }
74
75         if (exists $params{skip}) {
76                 @list=@list[$params{skip} .. scalar @list - 1];
77         }
78         
79         if ($params{show} && @list > $params{show}) {
80                 @list=@list[0..$params{show} - 1];
81         }
82
83         add_depends($params{page}, $params{pages});
84
85         my $rssurl=rsspage(basename($params{page}));
86         my $atomurl=atompage(basename($params{page}));
87         my $ret="";
88
89         if (exists $params{rootpage} && $config{cgiurl}) {
90                 # Add a blog post form, with feed buttons.
91                 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
92                 $formtemplate->param(cgiurl => $config{cgiurl});
93                 $formtemplate->param(rootpage => $params{rootpage});
94                 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
95                 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
96                 $ret.=$formtemplate->output;
97         }
98         elsif ($feeds) {
99                 # Add feed buttons.
100                 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
101                 $linktemplate->param(rssurl => $rssurl) if $rss;
102                 $linktemplate->param(atomurl => $atomurl) if $atom;
103                 $ret.=$linktemplate->output;
104         }
105         
106         my $template=template(
107                 ($archive ? "inlinepagetitle.tmpl" : "inlinepage.tmpl"),
108                 blind_cache => 1,
109         ) unless $raw;
110         
111         foreach my $page (@list) {
112                 my $file = $pagesources{$page};
113                 my $type = pagetype($file);
114                 if (! $raw || ($raw && ! defined $type)) {
115                         # Get the content before populating the template,
116                         # since getting the content uses the same template
117                         # if inlines are nested.
118                         # TODO: if $archive=1, the only reason to do this
119                         # is to let the meta plugin get page title info; so stop
120                         # calling this next line then once the meta plugin can
121                         # store that accross runs (also tags plugin).
122                         my $content=get_inline_content($page, $params{destpage});
123                         # Don't use htmllink because this way the title is separate
124                         # and can be overridden by other plugins.
125                         my $link=bestlink($params{page}, $page);
126                         $link=htmlpage($link) if defined $type;
127                         $link=abs2rel($link, dirname($params{destpage}));
128                         $template->param(pageurl => $link);
129                         $template->param(title => pagetitle(basename($page)));
130                         $template->param(content => $content);
131                         $template->param(ctime => displaytime($pagectime{$page}));
132
133                         if ($actions) {
134                                 my $file = $pagesources{$page};
135                                 my $type = pagetype($file);
136                                 if ($config{discussion}) {
137                                         $template->param(have_actions => 1);
138                                         $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
139                                 }
140                                 if (length $config{cgiurl} && defined $type) {
141                                         $template->param(have_actions => 1);
142                                         $template->param(editurl => cgiurl(do => "edit", page => $page));
143                                 }
144                         }
145
146                         run_hooks(pagetemplate => sub {
147                                 shift->(page => $page, destpage => $params{page},
148                                         template => $template,);
149                         });
150
151                         $ret.=$template->output;
152                         $template->clear_params;
153                 }
154                 else {
155                         if (defined $type) {
156                                 $ret.="\n".
157                                       linkify($page, $params{page},
158                                       preprocess($page, $params{page},
159                                       filter($page,
160                                       readfile(srcfile($file)))));
161                         }
162                 }
163         }
164         
165         if ($feeds && $rss) {
166                 will_render($params{page}, rsspage($params{page}));
167                 writefile(rsspage($params{page}), $config{destdir},
168                         genfeed("rss", $rssurl, $desc, $params{page}, @list));
169                 $toping{$params{page}}=1 unless $config{rebuild};
170                 $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
171         }
172         if ($feeds && $atom) {
173                 will_render($params{page}, atompage($params{page}));
174                 writefile(atompage($params{page}), $config{destdir},
175                         genfeed("atom", $atomurl, $desc, $params{page}, @list));
176                 $toping{$params{page}}=1 unless $config{rebuild};
177                 $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
178         }
179         
180         return $ret;
181 } #}}}
182
183 sub pagetemplate_inline (@) { #{{{
184         my %params=@_;
185         my $page=$params{page};
186         my $template=$params{template};
187
188         $template->param(feedlinks => $feedlinks{$page})
189                 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
190 } #}}}
191
192 sub get_inline_content ($$) { #{{{
193         my $page=shift;
194         my $destpage=shift;
195         
196         my $file=$pagesources{$page};
197         my $type=pagetype($file);
198         if (defined $type) {
199                 return htmlize($page, $type,
200                        linkify($page, $destpage,
201                        preprocess($page, $destpage,
202                        filter($page,
203                        readfile(srcfile($file))))));
204         }
205         else {
206                 return "";
207         }
208 } #}}}
209
210 sub date_822 ($) { #{{{
211         my $time=shift;
212
213         eval q{use POSIX};
214         error($@) if $@;
215         my $lc_time= POSIX::setlocale(&POSIX::LC_TIME);
216         POSIX::setlocale(&POSIX::LC_TIME, "C");
217         my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
218         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
219         return $ret;
220 } #}}}
221
222 sub date_3339 ($) { #{{{
223         my $time=shift;
224
225         eval q{use POSIX};
226         error($@) if $@;
227         my $lc_time= POSIX::setlocale(&POSIX::LC_TIME);
228         POSIX::setlocale(&POSIX::LC_TIME, "C");
229         my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", localtime($time));
230         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
231         return $ret;
232 } #}}}
233
234 sub absolute_urls ($$) { #{{{
235         # sucky sub because rss sucks
236         my $content=shift;
237         my $url=shift;
238
239         $url=~s/[^\/]+$//;
240         
241         $content=~s/<a\s+href="(?![^:]+:\/\/)([^"]+)"/<a href="$url$1"/ig;
242         $content=~s/<img\s+src="(?![^:]+:\/\/)([^"]+)"/<img src="$url$1"/ig;
243         return $content;
244 } #}}}
245
246 sub rsspage ($) { #{{{
247         my $page=shift;
248
249         return $page.".rss";
250 } #}}}
251
252 sub atompage ($) { #{{{
253         my $page=shift;
254
255         return $page.".atom";
256 } #}}}
257
258 sub genfeed ($$$$@) { #{{{
259         my $feedtype=shift;
260         my $feedurl=shift;
261         my $feeddesc=shift;
262         my $page=shift;
263         my @pages=@_;
264         
265         my $url=URI->new(encode_utf8($config{url}."/".htmlpage($page)));
266         
267         my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
268         my $content="";
269         my $lasttime = 0;
270         foreach my $p (@pages) {
271                 my $u=URI->new(encode_utf8($config{url}."/".htmlpage($p)));
272
273                 $itemtemplate->param(
274                         title => pagetitle(basename($p)),
275                         url => $u,
276                         permalink => $u,
277                         date_822 => date_822($pagectime{$p}),
278                         date_3339 => date_3339($pagectime{$p}),
279                 );
280
281                 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
282                 if ($itemtemplate->query(name => "enclosure")) {
283                         my $file=$pagesources{$p};
284                         my $type=pagetype($file);
285                         if (defined $type) {
286                                 $itemtemplate->param(content => $pcontent);
287                         }
288                         else {
289                                 my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
290                                 my $mime="unknown";
291                                 eval q{use File::MimeInfo};
292                                 if (! $@) {
293                                         $mime = mimetype($file);
294                                 }
295                                 $itemtemplate->param(
296                                         enclosure => $u,
297                                         type => $mime,
298                                         length => $size,
299                                 );
300                         }
301                 }
302                 else {
303                         $itemtemplate->param(content => $pcontent);
304                 }
305
306                 run_hooks(pagetemplate => sub {
307                         shift->(page => $p, destpage => $page,
308                                 template => $itemtemplate);
309                 });
310
311                 $content.=$itemtemplate->output;
312                 $itemtemplate->clear_params;
313
314                 $lasttime = $pagectime{$p} if $pagectime{$p} > $lasttime;
315         }
316
317         my $template=template($feedtype."page.tmpl", blind_cache => 1);
318         $template->param(
319                 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
320                 wikiname => $config{wikiname},
321                 pageurl => $url,
322                 content => $content,
323                 feeddesc => $feeddesc,
324                 feeddate => date_3339($lasttime),
325                 feedurl => $feedurl,
326                 version => $IkiWiki::version,
327         );
328         run_hooks(pagetemplate => sub {
329                 shift->(page => $page, destpage => $page,
330                         template => $template);
331         });
332         
333         return $template->output;
334 } #}}}
335
336 sub pingurl (@) { #{{{
337         return unless $config{pingurl} && %toping;
338
339         eval q{require RPC::XML::Client};
340         if ($@) {
341                 debug("RPC::XML::Client not found, not pinging");
342                 return;
343         }
344
345         # daemonize here so slow pings don't slow down wiki updates
346         eval q{use POSIX ’setsid’};
347         chdir '/';
348         open STDIN, '/dev/null';
349         open STDOUT, '>/dev/null';
350         defined(my $pid = fork) or error("Can't fork: $!");
351         return if $pid;
352         setsid() or error("Can't start a new session: $!");
353         open STDERR, '>&STDOUT' or error("Can’t dup stdout: $!");
354
355         foreach my $page (keys %toping) {
356                 my $title=pagetitle(basename($page));
357                 my $url="$config{url}/".htmlpage($page);
358                 foreach my $pingurl (@{$config{pingurl}}) {
359                         debug("Pinging $pingurl for $page");
360                         eval {
361                                 my $client = RPC::XML::Client->new($pingurl);
362                                 my $req = RPC::XML::request->new('weblogUpdates.ping',
363                                 $title, $url);
364                                 my $res = $client->send_request($req);
365                                 if (! ref $res) {
366                                         debug("Did not receive response to ping");
367                                 }
368                                 my $r=$res->value;
369                                 if (! exists $r->{flerror} || $r->{flerror}) {
370                                         debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
371                                 }
372                         };
373                         if ($@) {
374                                 debug "Ping failed: $@";
375                         }
376                 }
377         }
378 } #}}}
379
380 1