2 # Page inlining and blogging.
3 package IkiWiki::Plugin::inline;
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);
31 eval q{use Getopt::Long};
33 Getopt::Long::Configure('pass_through');
35 "rss!" => \$config{rss},
36 "atom!" => \$config{atom},
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"));
45 push @{$config{wiki_file_prune_regexps}}, qr/\.rss$/;
48 push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
52 sub sessioncgi () { #{{{
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');
62 while (exists $IkiWiki::pagecase{lc($from."/".IkiWiki::titlepage($page).$add)}) {
63 $add=1 unless length $add;
66 $q->param('page', $page.$add);
67 # now go create the page
68 $q->param('do', 'create');
69 IkiWiki::cgi_editpage($q, $session);
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.
83 return (defined $val && lc($val) eq "yes");
86 sub preprocess_inline (@) { #{{{
89 if (! exists $params{pages}) {
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) {
104 if (exists $params{description}) {
105 $desc = $params{description}
107 $desc = $config{wikiname};
109 my $actions=yesno($params{actions});
110 if (exists $params{template}) {
111 $params{template}=~s/[^-_a-zA-Z0-9]+//g;
114 $params{template} = $archive ? "archivepage" : "inlinepage";
118 foreach my $page (keys %pagesources) {
119 next if $page eq $params{page};
120 if (pagespec_match($page, $params{pages}, location => $params{page})) {
125 if (exists $params{sort} && $params{sort} eq 'title') {
128 elsif (exists $params{sort} && $params{sort} eq 'mtime') {
129 @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
131 elsif (! exists $params{sort} || $params{sort} eq 'age') {
132 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
135 return sprintf(gettext("unknown sort type %s"), $params{sort});
138 if (yesno($params{reverse})) {
139 @list=reverse(@list);
142 if (exists $params{skip}) {
143 @list=@list[$params{skip} .. scalar @list - 1];
146 if ($params{show} && @list > $params{show}) {
147 @list=@list[0..$params{show} - 1];
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));
158 my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
159 if (exists $knownfeeds{$feedid}) {
160 $feednum=$knownfeeds{$feedid};
163 if (exists $page_numfeeds{$params{destpage}}) {
164 $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}};
167 $feednum=$knownfeeds{$feedid}="";
169 $page_numfeeds{$params{destpage}}=1;
174 my $rssurl=basename(rsspage($params{destpage}).$feednum);
175 my $atomurl=basename(atompage($params{destpage}).$feednum);
178 if ($config{cgiurl} && (exists $params{rootpage} ||
179 (exists $params{postform} && yesno($params{postform})))) {
180 # Add a blog post form, with feed buttons.
181 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
182 $formtemplate->param(cgiurl => $config{cgiurl});
183 $formtemplate->param(rootpage =>
184 exists $params{rootpage} ? $params{rootpage} : $params{page});
185 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
186 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
187 if (exists $params{postformtext}) {
188 $formtemplate->param(postformtext =>
189 $params{postformtext});
192 $formtemplate->param(postformtext =>
193 gettext("Add a new post titled:"));
195 $ret.=$formtemplate->output;
199 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
200 $linktemplate->param(rssurl => $rssurl) if $rss;
201 $linktemplate->param(atomurl => $atomurl) if $atom;
202 $ret.=$linktemplate->output;
206 require HTML::Template;
207 my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
209 return sprintf(gettext("nonexistant template %s"), $params{template});
211 my $template=HTML::Template->new(@params) unless $raw;
213 foreach my $page (@list) {
214 my $file = $pagesources{$page};
215 my $type = pagetype($file);
216 if (! $raw || ($raw && ! defined $type)) {
217 unless ($archive && $quick) {
218 # Get the content before populating the
219 # template, since getting the content uses
220 # the same template if inlines are nested.
221 my $content=get_inline_content($page, $params{destpage});
222 $template->param(content => $content);
224 $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
225 $template->param(title => pagetitle(basename($page)));
226 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
229 my $file = $pagesources{$page};
230 my $type = pagetype($file);
231 if ($config{discussion}) {
232 my $discussionlink=gettext("discussion");
233 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
234 (length $config{cgiurl} ||
235 exists $links{$page."/".$discussionlink})) {
236 $template->param(have_actions => 1);
237 $template->param(discussionlink =>
240 gettext("Discussion"),
245 if (length $config{cgiurl} && defined $type) {
246 $template->param(have_actions => 1);
247 $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
251 run_hooks(pagetemplate => sub {
252 shift->(page => $page, destpage => $params{destpage},
253 template => $template,);
256 $ret.=$template->output;
257 $template->clear_params;
262 linkify($page, $params{destpage},
263 preprocess($page, $params{destpage},
264 filter($page, $params{destpage},
265 readfile(srcfile($file)))));
272 if (exists $params{feedshow} && @list > $params{feedshow}) {
273 @list=@list[0..$params{feedshow} - 1];
275 if (exists $params{feedpages}) {
276 @list=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @list;
280 my $rssp=rsspage($params{destpage}).$feednum;
281 will_render($params{destpage}, $rssp);
282 writefile($rssp, $config{destdir},
283 genfeed("rss", $rssurl, $desc, $params{destpage}, @list));
284 $toping{$params{destpage}}=1 unless $config{rebuild};
285 $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
288 my $atomp=atompage($params{destpage}).$feednum;
289 will_render($params{destpage}, $atomp);
290 writefile($atomp, $config{destdir},
291 genfeed("atom", $atomurl, $desc, $params{destpage}, @list));
292 $toping{$params{destpage}}=1 unless $config{rebuild};
293 $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
300 sub pagetemplate_inline (@) { #{{{
302 my $page=$params{page};
303 my $template=$params{template};
305 $template->param(feedlinks => $feedlinks{$page})
306 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
309 sub get_inline_content ($$) { #{{{
313 my $file=$pagesources{$page};
314 my $type=pagetype($file);
316 return htmlize($page, $type,
317 linkify($page, $destpage,
318 preprocess($page, $destpage,
319 filter($page, $destpage,
320 readfile(srcfile($file))))));
327 sub date_822 ($) { #{{{
330 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
331 POSIX::setlocale(&POSIX::LC_TIME, "C");
332 my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
333 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
337 sub date_3339 ($) { #{{{
340 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
341 POSIX::setlocale(&POSIX::LC_TIME, "C");
342 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
343 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
347 sub absolute_urls ($$) { #{{{
348 # sucky sub because rss sucks
355 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
356 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/mig;
357 $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/mig;
361 sub rsspage ($) { #{{{
362 return targetpage(shift, "rss");
365 sub atompage ($) { #{{{
366 return targetpage(shift, "atom");
369 sub genfeed ($$$$@) { #{{{
376 my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
378 my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
381 foreach my $p (@pages) {
382 my $u=URI->new(encode_utf8($config{url}."/".urlto($p, "")));
383 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
385 $itemtemplate->param(
386 title => pagetitle(basename($p)),
389 cdate_822 => date_822($pagectime{$p}),
390 mdate_822 => date_822($pagemtime{$p}),
391 cdate_3339 => date_3339($pagectime{$p}),
392 mdate_3339 => date_3339($pagemtime{$p}),
395 if ($itemtemplate->query(name => "enclosure")) {
396 my $file=$pagesources{$p};
397 my $type=pagetype($file);
399 $itemtemplate->param(content => $pcontent);
402 my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
404 eval q{use File::MimeInfo};
406 $mime = mimetype($file);
408 $itemtemplate->param(
416 $itemtemplate->param(content => $pcontent);
419 run_hooks(pagetemplate => sub {
420 shift->(page => $p, destpage => $page,
421 template => $itemtemplate);
424 $content.=$itemtemplate->output;
425 $itemtemplate->clear_params;
427 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
430 my $template=template($feedtype."page.tmpl", blind_cache => 1);
432 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
433 wikiname => $config{wikiname},
436 feeddesc => $feeddesc,
437 feeddate => date_3339($lasttime),
439 version => $IkiWiki::version,
441 run_hooks(pagetemplate => sub {
442 shift->(page => $page, destpage => $page,
443 template => $template);
446 return $template->output;
449 sub pingurl (@) { #{{{
450 return unless @{$config{pingurl}} && %toping;
452 eval q{require RPC::XML::Client};
454 debug(gettext("RPC::XML::Client not found, not pinging"));
458 # daemonize here so slow pings don't slow down wiki updates
459 defined(my $pid = fork) or error("Can't fork: $!");
462 setsid() or error("Can't start a new session: $!");
463 open STDIN, '/dev/null';
464 open STDOUT, '>/dev/null';
465 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
467 # Don't need to keep a lock on the wiki as a daemon.
468 IkiWiki::unlockwiki();
470 foreach my $page (keys %toping) {
471 my $title=pagetitle(basename($page), 0);
472 my $url="$config{url}/".urlto($page, "");
473 foreach my $pingurl (@{$config{pingurl}}) {
474 debug("Pinging $pingurl for $page");
476 my $client = RPC::XML::Client->new($pingurl);
477 my $req = RPC::XML::request->new('weblogUpdates.ping',
479 my $res = $client->send_request($req);
481 debug("Did not receive response to ping");
484 if (! exists $r->{flerror} || $r->{flerror}) {
485 debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
489 debug "Ping failed: $@";
494 exit 0; # daemon done