]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/inline.pm
* inline: Add timeformat parameter to control how the ctime of
[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 Encode;
8 use IkiWiki 2.00;
9 use URI;
10
11 my %knownfeeds;
12 my %page_numfeeds;
13
14 sub import { #{{{
15         hook(type => "getopt", id => "inline", call => \&getopt);
16         hook(type => "checkconfig", id => "inline", call => \&checkconfig);
17         hook(type => "sessioncgi", id => "skeleton", call => \&sessioncgi);
18         hook(type => "preprocess", id => "inline", 
19                 call => \&IkiWiki::preprocess_inline);
20         hook(type => "pagetemplate", id => "inline",
21                 call => \&IkiWiki::pagetemplate_inline);
22         # Hook to change to do pinging since it's called late.
23         # This ensures each page only pings once and prevents slow
24         # pings interrupting page builds.
25         hook(type => "change", id => "inline", 
26                 call => \&IkiWiki::pingurl);
27
28 } # }}}
29
30 sub getopt () { #{{{
31         eval q{use Getopt::Long};
32         error($@) if $@;
33         Getopt::Long::Configure('pass_through');
34         GetOptions(
35                 "rss!" => \$config{rss},
36                 "atom!" => \$config{atom},
37         );
38 }
39
40 sub checkconfig () { #{{{
41         if (($config{rss} || $config{atom}) && ! length $config{url}) {
42                 error(gettext("Must specify url to wiki with --url when using --rss or --atom"));
43         }
44         if ($config{rss}) {
45                 push @{$config{wiki_file_prune_regexps}}, qr/\.rss$/;
46         }
47         if ($config{atom}) {
48                 push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
49         }
50 } #}}}
51
52 sub sessioncgi () { #{{{
53         my $q=shift;
54         my $session=shift;
55
56         if ($q->param('do') eq 'blog') {
57                 my $page=decode_utf8($q->param('title'));
58                 $page=~s/\///g; # no slashes in blog posts
59                 # if the page already exists, munge it to be unique
60                 my $from=$q->param('from');
61                 my $add="";
62                 while (exists $IkiWiki::pagecase{lc($from."/".IkiWiki::titlepage($page).$add)}) {
63                         $add=1 unless length $add;
64                         $add++;
65                 }
66                 $q->param('page', $page.$add);
67                 # now go create the page
68                 $q->param('do', 'create');
69                 IkiWiki::cgi_editpage($q, $session);
70                 exit;
71         }
72 }
73
74 # Back to ikiwiki namespace for the rest, this code is very much
75 # internal to ikiwiki even though it's separated into a plugin.
76 package IkiWiki;
77
78 my %toping;
79 my %feedlinks;
80
81 sub yesno ($) { #{{{
82         my $val=shift;
83         return (defined $val && lc($val) eq "yes");
84 } #}}}
85
86 sub preprocess_inline (@) { #{{{
87         my %params=@_;
88         
89         if (! exists $params{pages}) {
90                 return "";
91         }
92         my $raw=yesno($params{raw});
93         my $archive=yesno($params{archive});
94         my $rss=($config{rss} && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
95         my $atom=($config{atom} && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
96         my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
97         my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick;
98         $feeds=0 if $params{preview};
99         my $feedonly=yesno($params{feedonly});
100         if (! exists $params{show} && ! $archive) {
101                 $params{show}=10;
102         }
103         my $desc;
104         if (exists $params{description}) {
105                 $desc = $params{description} 
106         } else {
107                 $desc = $config{wikiname};
108         }
109         my $actions=yesno($params{actions});
110         if (exists $params{template}) {
111                 $params{template}=~s/[^-_a-zA-Z0-9]+//g;
112         }
113         else {
114                 $params{template} = $archive ? "archivepage" : "inlinepage";
115         }
116
117         my @list;
118         foreach my $page (keys %pagesources) {
119                 next if $page eq $params{page};
120                 if (pagespec_match($page, $params{pages}, location => $params{page})) {
121                         push @list, $page;
122                 }
123         }
124
125         if (exists $params{sort} && $params{sort} eq 'title') {
126                 @list=sort @list;
127         }
128         elsif (exists $params{sort} && $params{sort} eq 'mtime') {
129                 @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
130         }
131         elsif (! exists $params{sort} || $params{sort} eq 'age') {
132                 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
133         }
134         else {
135                 return sprintf(gettext("unknown sort type %s"), $params{sort});
136         }
137
138         if (yesno($params{reverse})) {
139                 @list=reverse(@list);
140         }
141
142         if (exists $params{skip}) {
143                 @list=@list[$params{skip} .. scalar @list - 1];
144         }
145         
146         if ($params{show} && @list > $params{show}) {
147                 @list=@list[0..$params{show} - 1];
148         }
149
150         add_depends($params{page}, $params{pages});
151         # Explicitly add all currently displayed pages as dependencies, so
152         # that if they are removed or otherwise changed, the inline will be
153         # sure to be updated.
154         add_depends($params{page}, join(" or ", @list));
155         
156         my $feednum="";
157
158         my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
159         if (exists $knownfeeds{$feedid}) {
160                 $feednum=$knownfeeds{$feedid};
161         }
162         else {
163                 if (exists $page_numfeeds{$params{destpage}}) {
164                         $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}};
165                 }
166                 else {
167                         $feednum=$knownfeeds{$feedid}="";
168                         $page_numfeeds{$params{destpage}}=1;
169                 }
170         }
171
172         my $rssurl=basename(rsspage($params{destpage}).$feednum);
173         my $atomurl=basename(atompage($params{destpage}).$feednum);
174         my $ret="";
175
176         if ($config{cgiurl} && (exists $params{rootpage} ||
177                         (exists $params{postform} && yesno($params{postform})))) {
178                 # Add a blog post form, with feed buttons.
179                 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
180                 $formtemplate->param(cgiurl => $config{cgiurl});
181                 $formtemplate->param(rootpage => 
182                         exists $params{rootpage} ? $params{rootpage} : $params{page});
183                 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
184                 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
185                 if (exists $params{postformtext}) {
186                         $formtemplate->param(postformtext =>
187                                 $params{postformtext});
188                 }
189                 else {
190                         $formtemplate->param(postformtext =>
191                                 gettext("Add a new post titled:"));
192                 }
193                 $ret.=$formtemplate->output;
194         }
195         elsif ($feeds) {
196                 # Add feed buttons.
197                 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
198                 $linktemplate->param(rssurl => $rssurl) if $rss;
199                 $linktemplate->param(atomurl => $atomurl) if $atom;
200                 $ret.=$linktemplate->output;
201         }
202         
203         if (! $feedonly) {
204                 require HTML::Template;
205                 my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
206                 if (! @params) {
207                         return sprintf(gettext("nonexistant template %s"), $params{template});
208                 }
209                 my $template=HTML::Template->new(@params) unless $raw;
210         
211                 foreach my $page (@list) {
212                         my $file = $pagesources{$page};
213                         my $type = pagetype($file);
214                         if (! $raw || ($raw && ! defined $type)) {
215                                 unless ($archive && $quick) {
216                                         # Get the content before populating the
217                                         # template, since getting the content uses
218                                         # the same template if inlines are nested.
219                                         my $content=get_inline_content($page, $params{destpage});
220                                         $template->param(content => $content);
221                                 }
222                                 $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
223                                 $template->param(title => pagetitle(basename($page)));
224                                 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
225         
226                                 if ($actions) {
227                                         my $file = $pagesources{$page};
228                                         my $type = pagetype($file);
229                                         if ($config{discussion}) {
230                                                 my $discussionlink=gettext("discussion");
231                                                 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
232                                                     (length $config{cgiurl} ||
233                                                      exists $links{$page."/".$discussionlink})) {
234                                                         $template->param(have_actions => 1);
235                                                         $template->param(discussionlink =>
236                                                                 htmllink($page,
237                                                                         $params{destpage},
238                                                                         gettext("Discussion"),
239                                                                         noimageinline => 1,
240                                                                         forcesubpage => 1));
241                                                 }
242                                         }
243                                         if (length $config{cgiurl} && defined $type) {
244                                                 $template->param(have_actions => 1);
245                                                 $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
246                                         }
247                                 }
248         
249                                 run_hooks(pagetemplate => sub {
250                                         shift->(page => $page, destpage => $params{destpage},
251                                                 template => $template,);
252                                 });
253         
254                                 $ret.=$template->output;
255                                 $template->clear_params;
256                         }
257                         else {
258                                 if (defined $type) {
259                                         $ret.="\n".
260                                               linkify($page, $params{destpage},
261                                               preprocess($page, $params{destpage},
262                                               filter($page, $params{destpage},
263                                               readfile(srcfile($file)))));
264                                 }
265                         }
266                 }
267         }
268         
269         if ($feeds) {
270                 if (exists $params{feedshow} && @list > $params{feedshow}) {
271                         @list=@list[0..$params{feedshow} - 1];
272                 }
273                 if (exists $params{feedpages}) {
274                         @list=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @list;
275                 }
276         
277                 if ($rss) {
278                         my $rssp=rsspage($params{destpage}).$feednum;
279                         will_render($params{destpage}, $rssp);
280                         writefile($rssp, $config{destdir},
281                                 genfeed("rss", $rssurl, $desc, $params{destpage}, @list));
282                         $toping{$params{destpage}}=1 unless $config{rebuild};
283                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
284                 }
285                 if ($atom) {
286                         my $atomp=atompage($params{destpage}).$feednum;
287                         will_render($params{destpage}, $atomp);
288                         writefile($atomp, $config{destdir},
289                                 genfeed("atom", $atomurl, $desc, $params{destpage}, @list));
290                         $toping{$params{destpage}}=1 unless $config{rebuild};
291                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
292                 }
293         }
294         
295         return $ret;
296 } #}}}
297
298 sub pagetemplate_inline (@) { #{{{
299         my %params=@_;
300         my $page=$params{page};
301         my $template=$params{template};
302
303         $template->param(feedlinks => $feedlinks{$page})
304                 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
305 } #}}}
306
307 sub get_inline_content ($$) { #{{{
308         my $page=shift;
309         my $destpage=shift;
310         
311         my $file=$pagesources{$page};
312         my $type=pagetype($file);
313         if (defined $type) {
314                 return htmlize($page, $type,
315                        linkify($page, $destpage,
316                        preprocess($page, $destpage,
317                        filter($page, $destpage,
318                        readfile(srcfile($file))))));
319         }
320         else {
321                 return "";
322         }
323 } #}}}
324
325 sub date_822 ($) { #{{{
326         my $time=shift;
327
328         my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
329         POSIX::setlocale(&POSIX::LC_TIME, "C");
330         my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
331         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
332         return $ret;
333 } #}}}
334
335 sub date_3339 ($) { #{{{
336         my $time=shift;
337
338         my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
339         POSIX::setlocale(&POSIX::LC_TIME, "C");
340         my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
341         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
342         return $ret;
343 } #}}}
344
345 sub absolute_urls ($$) { #{{{
346         # sucky sub because rss sucks
347         my $content=shift;
348         my $baseurl=shift;
349
350         my $url=$baseurl;
351         $url=~s/[^\/]+$//;
352         
353         $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
354         $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/mig;
355         $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/mig;
356         return $content;
357 } #}}}
358
359 sub rsspage ($) { #{{{
360         return targetpage(shift, "rss");
361 } #}}}
362
363 sub atompage ($) { #{{{
364         return targetpage(shift, "atom");
365 } #}}}
366
367 sub genfeed ($$$$@) { #{{{
368         my $feedtype=shift;
369         my $feedurl=shift;
370         my $feeddesc=shift;
371         my $page=shift;
372         my @pages=@_;
373         
374         my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
375         
376         my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
377         my $content="";
378         my $lasttime = 0;
379         foreach my $p (@pages) {
380                 my $u=URI->new(encode_utf8($config{url}."/".urlto($p, "")));
381                 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
382
383                 $itemtemplate->param(
384                         title => pagetitle(basename($p)),
385                         url => $u,
386                         permalink => $u,
387                         cdate_822 => date_822($pagectime{$p}),
388                         mdate_822 => date_822($pagemtime{$p}),
389                         cdate_3339 => date_3339($pagectime{$p}),
390                         mdate_3339 => date_3339($pagemtime{$p}),
391                 );
392
393                 if ($itemtemplate->query(name => "enclosure")) {
394                         my $file=$pagesources{$p};
395                         my $type=pagetype($file);
396                         if (defined $type) {
397                                 $itemtemplate->param(content => $pcontent);
398                         }
399                         else {
400                                 my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
401                                 my $mime="unknown";
402                                 eval q{use File::MimeInfo};
403                                 if (! $@) {
404                                         $mime = mimetype($file);
405                                 }
406                                 $itemtemplate->param(
407                                         enclosure => $u,
408                                         type => $mime,
409                                         length => $size,
410                                 );
411                         }
412                 }
413                 else {
414                         $itemtemplate->param(content => $pcontent);
415                 }
416
417                 run_hooks(pagetemplate => sub {
418                         shift->(page => $p, destpage => $page,
419                                 template => $itemtemplate);
420                 });
421
422                 $content.=$itemtemplate->output;
423                 $itemtemplate->clear_params;
424
425                 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
426         }
427
428         my $template=template($feedtype."page.tmpl", blind_cache => 1);
429         $template->param(
430                 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
431                 wikiname => $config{wikiname},
432                 pageurl => $url,
433                 content => $content,
434                 feeddesc => $feeddesc,
435                 feeddate => date_3339($lasttime),
436                 feedurl => $feedurl,
437                 version => $IkiWiki::version,
438         );
439         run_hooks(pagetemplate => sub {
440                 shift->(page => $page, destpage => $page,
441                         template => $template);
442         });
443         
444         return $template->output;
445 } #}}}
446
447 sub pingurl (@) { #{{{
448         return unless @{$config{pingurl}} && %toping;
449
450         eval q{require RPC::XML::Client};
451         if ($@) {
452                 debug(gettext("RPC::XML::Client not found, not pinging"));
453                 return;
454         }
455
456         # daemonize here so slow pings don't slow down wiki updates
457         defined(my $pid = fork) or error("Can't fork: $!");
458         return if $pid;
459         chdir '/';
460         setsid() or error("Can't start a new session: $!");
461         open STDIN, '/dev/null';
462         open STDOUT, '>/dev/null';
463         open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
464
465         # Don't need to keep a lock on the wiki as a daemon.
466         IkiWiki::unlockwiki();
467
468         foreach my $page (keys %toping) {
469                 my $title=pagetitle(basename($page), 0);
470                 my $url="$config{url}/".urlto($page, "");
471                 foreach my $pingurl (@{$config{pingurl}}) {
472                         debug("Pinging $pingurl for $page");
473                         eval {
474                                 my $client = RPC::XML::Client->new($pingurl);
475                                 my $req = RPC::XML::request->new('weblogUpdates.ping',
476                                         $title, $url);
477                                 my $res = $client->send_request($req);
478                                 if (! ref $res) {
479                                         debug("Did not receive response to ping");
480                                 }
481                                 my $r=$res->value;
482                                 if (! exists $r->{flerror} || $r->{flerror}) {
483                                         debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
484                                 }
485                         };
486                         if ($@) {
487                                 debug "Ping failed: $@";
488                         }
489                 }
490         }
491
492         exit 0; # daemon done
493 } #}}}
494
495 1