]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/inline.pm
Merge branch 'master' of ssh://git.kitenet.net/srv/git/ikiwiki.info
[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 => "inline", 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         # Force a scan of this page so any metadata that appears after this
156         # inline directive is available when inlining. The page normally 
157         # wouldn't be scanned if it's only being rebuilt because of a
158         # depedency.
159         IkiWiki::scan($pagesources{$params{page}});
160
161         my $feednum="";
162
163         my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
164         if (exists $knownfeeds{$feedid}) {
165                 $feednum=$knownfeeds{$feedid};
166         }
167         else {
168                 if (exists $page_numfeeds{$params{destpage}}) {
169                         if ($feeds) {
170                                 $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}};
171                         }
172                 }
173                 else {
174                         $feednum=$knownfeeds{$feedid}="";
175                         if ($feeds) {
176                                 $page_numfeeds{$params{destpage}}=1;
177                         }
178                 }
179         }
180
181         my $rssurl=basename(rsspage($params{destpage}).$feednum) if $feeds && $rss;
182         my $atomurl=basename(atompage($params{destpage}).$feednum) if $feeds && $atom;
183         my $ret="";
184
185         if ($config{cgiurl} && (exists $params{rootpage} ||
186                         (exists $params{postform} && yesno($params{postform})))) {
187                 # Add a blog post form, with feed buttons.
188                 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
189                 $formtemplate->param(cgiurl => $config{cgiurl});
190                 $formtemplate->param(rootpage => 
191                         exists $params{rootpage} ? $params{rootpage} : $params{page});
192                 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
193                 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
194                 if (exists $params{postformtext}) {
195                         $formtemplate->param(postformtext =>
196                                 $params{postformtext});
197                 }
198                 else {
199                         $formtemplate->param(postformtext =>
200                                 gettext("Add a new post titled:"));
201                 }
202                 $ret.=$formtemplate->output;
203         }
204         elsif ($feeds) {
205                 # Add feed buttons.
206                 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
207                 $linktemplate->param(rssurl => $rssurl) if $rss;
208                 $linktemplate->param(atomurl => $atomurl) if $atom;
209                 $ret.=$linktemplate->output;
210         }
211         
212         if (! $feedonly) {
213                 require HTML::Template;
214                 my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
215                 if (! @params) {
216                         return sprintf(gettext("nonexistant template %s"), $params{template});
217                 }
218                 my $template=HTML::Template->new(@params) unless $raw;
219         
220                 foreach my $page (@list) {
221                         my $file = $pagesources{$page};
222                         my $type = pagetype($file);
223                         if (! $raw || ($raw && ! defined $type)) {
224                                 unless ($archive && $quick) {
225                                         # Get the content before populating the
226                                         # template, since getting the content uses
227                                         # the same template if inlines are nested.
228                                         my $content=get_inline_content($page, $params{destpage});
229                                         $template->param(content => $content);
230                                 }
231                                 $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
232                                 $template->param(title => pagetitle(basename($page)));
233                                 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
234         
235                                 if ($actions) {
236                                         my $file = $pagesources{$page};
237                                         my $type = pagetype($file);
238                                         if ($config{discussion}) {
239                                                 my $discussionlink=gettext("discussion");
240                                                 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
241                                                     (length $config{cgiurl} ||
242                                                      exists $links{$page."/".$discussionlink})) {
243                                                         $template->param(have_actions => 1);
244                                                         $template->param(discussionlink =>
245                                                                 htmllink($page,
246                                                                         $params{destpage},
247                                                                         gettext("Discussion"),
248                                                                         noimageinline => 1,
249                                                                         forcesubpage => 1));
250                                                 }
251                                         }
252                                         if (length $config{cgiurl} && defined $type) {
253                                                 $template->param(have_actions => 1);
254                                                 $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
255                                         }
256                                 }
257         
258                                 run_hooks(pagetemplate => sub {
259                                         shift->(page => $page, destpage => $params{destpage},
260                                                 template => $template,);
261                                 });
262         
263                                 $ret.=$template->output;
264                                 $template->clear_params;
265                         }
266                         else {
267                                 if (defined $type) {
268                                         $ret.="\n".
269                                               linkify($page, $params{destpage},
270                                               preprocess($page, $params{destpage},
271                                               filter($page, $params{destpage},
272                                               readfile(srcfile($file)))));
273                                 }
274                         }
275                 }
276         }
277         
278         if ($feeds) {
279                 if (exists $params{feedshow} && @list > $params{feedshow}) {
280                         @list=@list[0..$params{feedshow} - 1];
281                 }
282                 if (exists $params{feedpages}) {
283                         @list=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @list;
284                 }
285         
286                 if ($rss) {
287                         my $rssp=rsspage($params{destpage}).$feednum;
288                         will_render($params{destpage}, $rssp);
289                         writefile($rssp, $config{destdir},
290                                 genfeed("rss", $rssurl, $desc, $params{destpage}, @list));
291                         $toping{$params{destpage}}=1 unless $config{rebuild};
292                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
293                 }
294                 if ($atom) {
295                         my $atomp=atompage($params{destpage}).$feednum;
296                         will_render($params{destpage}, $atomp);
297                         writefile($atomp, $config{destdir},
298                                 genfeed("atom", $atomurl, $desc, $params{destpage}, @list));
299                         $toping{$params{destpage}}=1 unless $config{rebuild};
300                         $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
301                 }
302         }
303         
304         return $ret;
305 } #}}}
306
307 sub pagetemplate_inline (@) { #{{{
308         my %params=@_;
309         my $page=$params{page};
310         my $template=$params{template};
311
312         $template->param(feedlinks => $feedlinks{$page})
313                 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
314 } #}}}
315
316 sub get_inline_content ($$) { #{{{
317         my $page=shift;
318         my $destpage=shift;
319         
320         my $file=$pagesources{$page};
321         my $type=pagetype($file);
322         if (defined $type) {
323                 return htmlize($page, $type,
324                        linkify($page, $destpage,
325                        preprocess($page, $destpage,
326                        filter($page, $destpage,
327                        readfile(srcfile($file))))));
328         }
329         else {
330                 return "";
331         }
332 } #}}}
333
334 sub date_822 ($) { #{{{
335         my $time=shift;
336
337         my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
338         POSIX::setlocale(&POSIX::LC_TIME, "C");
339         my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
340         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
341         return $ret;
342 } #}}}
343
344 sub date_3339 ($) { #{{{
345         my $time=shift;
346
347         my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
348         POSIX::setlocale(&POSIX::LC_TIME, "C");
349         my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
350         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
351         return $ret;
352 } #}}}
353
354 sub absolute_urls ($$) { #{{{
355         # sucky sub because rss sucks
356         my $content=shift;
357         my $baseurl=shift;
358
359         my $url=$baseurl;
360         $url=~s/[^\/]+$//;
361         
362         $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
363         $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/mig;
364         $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/mig;
365         return $content;
366 } #}}}
367
368 sub rsspage ($) { #{{{
369         return targetpage(shift, "rss");
370 } #}}}
371
372 sub atompage ($) { #{{{
373         return targetpage(shift, "atom");
374 } #}}}
375
376 sub genfeed ($$$$@) { #{{{
377         my $feedtype=shift;
378         my $feedurl=shift;
379         my $feeddesc=shift;
380         my $page=shift;
381         my @pages=@_;
382         
383         my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
384         
385         my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
386         my $content="";
387         my $lasttime = 0;
388         foreach my $p (@pages) {
389                 my $u=URI->new(encode_utf8($config{url}."/".urlto($p, "")));
390                 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
391
392                 $itemtemplate->param(
393                         title => pagetitle(basename($p)),
394                         url => $u,
395                         permalink => $u,
396                         cdate_822 => date_822($pagectime{$p}),
397                         mdate_822 => date_822($pagemtime{$p}),
398                         cdate_3339 => date_3339($pagectime{$p}),
399                         mdate_3339 => date_3339($pagemtime{$p}),
400                 );
401
402                 if ($itemtemplate->query(name => "enclosure")) {
403                         my $file=$pagesources{$p};
404                         my $type=pagetype($file);
405                         if (defined $type) {
406                                 $itemtemplate->param(content => $pcontent);
407                         }
408                         else {
409                                 my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
410                                 my $mime="unknown";
411                                 eval q{use File::MimeInfo};
412                                 if (! $@) {
413                                         $mime = mimetype($file);
414                                 }
415                                 $itemtemplate->param(
416                                         enclosure => $u,
417                                         type => $mime,
418                                         length => $size,
419                                 );
420                         }
421                 }
422                 else {
423                         $itemtemplate->param(content => $pcontent);
424                 }
425
426                 run_hooks(pagetemplate => sub {
427                         shift->(page => $p, destpage => $page,
428                                 template => $itemtemplate);
429                 });
430
431                 $content.=$itemtemplate->output;
432                 $itemtemplate->clear_params;
433
434                 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
435         }
436
437         my $template=template($feedtype."page.tmpl", blind_cache => 1);
438         $template->param(
439                 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
440                 wikiname => $config{wikiname},
441                 pageurl => $url,
442                 content => $content,
443                 feeddesc => $feeddesc,
444                 feeddate => date_3339($lasttime),
445                 feedurl => $feedurl,
446                 version => $IkiWiki::version,
447         );
448         run_hooks(pagetemplate => sub {
449                 shift->(page => $page, destpage => $page,
450                         template => $template);
451         });
452         
453         return $template->output;
454 } #}}}
455
456 sub pingurl (@) { #{{{
457         return unless @{$config{pingurl}} && %toping;
458
459         eval q{require RPC::XML::Client};
460         if ($@) {
461                 debug(gettext("RPC::XML::Client not found, not pinging"));
462                 return;
463         }
464
465         # daemonize here so slow pings don't slow down wiki updates
466         defined(my $pid = fork) or error("Can't fork: $!");
467         return if $pid;
468         chdir '/';
469         setsid() or error("Can't start a new session: $!");
470         open STDIN, '/dev/null';
471         open STDOUT, '>/dev/null';
472         open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
473
474         # Don't need to keep a lock on the wiki as a daemon.
475         IkiWiki::unlockwiki();
476
477         foreach my $page (keys %toping) {
478                 my $title=pagetitle(basename($page), 0);
479                 my $url="$config{url}/".urlto($page, "");
480                 foreach my $pingurl (@{$config{pingurl}}) {
481                         debug("Pinging $pingurl for $page");
482                         eval {
483                                 my $client = RPC::XML::Client->new($pingurl);
484                                 my $req = RPC::XML::request->new('weblogUpdates.ping',
485                                         $title, $url);
486                                 my $res = $client->send_request($req);
487                                 if (! ref $res) {
488                                         debug("Did not receive response to ping");
489                                 }
490                                 my $r=$res->value;
491                                 if (! exists $r->{flerror} || $r->{flerror}) {
492                                         debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
493                                 }
494                         };
495                         if ($@) {
496                                 debug "Ping failed: $@";
497                         }
498                 }
499         }
500
501         exit 0; # daemon done
502 } #}}}
503
504 1