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 => "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);
31 eval q{use Getopt::Long};
33 Getopt::Long::Configure('pass_through');
35 "rss!" => \$config{rss},
36 "atom!" => \$config{atom},
37 "allowrss!" => \$config{allowrss},
38 "allowatom!" => \$config{allowatom},
42 sub checkconfig () { #{{{
43 if (($config{rss} || $config{atom}) && ! length $config{url}) {
44 error(gettext("Must specify url to wiki with --url when using --rss or --atom"));
47 push @{$config{wiki_file_prune_regexps}}, qr/\.rss$/;
50 push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
54 sub sessioncgi () { #{{{
58 if ($q->param('do') eq 'blog') {
59 my $page=decode_utf8($q->param('title'));
60 $page=~s/\///g; # no slashes in blog posts
61 # if the page already exists, munge it to be unique
62 my $from=$q->param('from');
64 while (exists $IkiWiki::pagecase{lc($from."/".IkiWiki::titlepage($page).$add)}) {
65 $add=1 unless length $add;
68 $q->param('page', $page.$add);
69 # now go create the page
70 $q->param('do', 'create');
71 IkiWiki::cgi_editpage($q, $session);
76 # Back to ikiwiki namespace for the rest, this code is very much
77 # internal to ikiwiki even though it's separated into a plugin.
85 return (defined $val && lc($val) eq "yes");
88 sub preprocess_inline (@) { #{{{
91 if (! exists $params{pages}) {
94 my $raw=yesno($params{raw});
95 my $archive=yesno($params{archive});
96 my $rss=(($config{rss} || $config{allowrss}) && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
97 my $atom=(($config{atom} || $config{allowatom}) && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
98 my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
99 my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick;
100 my $feedonly=yesno($params{feedonly});
101 if (! exists $params{show} && ! $archive) {
105 if (exists $params{description}) {
106 $desc = $params{description}
108 $desc = $config{wikiname};
110 my $actions=yesno($params{actions});
111 if (exists $params{template}) {
112 $params{template}=~s/[^-_a-zA-Z0-9]+//g;
115 $params{template} = $archive ? "archivepage" : "inlinepage";
119 foreach my $page (keys %pagesources) {
120 next if $page eq $params{page};
121 if (pagespec_match($page, $params{pages}, location => $params{page})) {
126 if (exists $params{sort} && $params{sort} eq 'title') {
129 elsif (exists $params{sort} && $params{sort} eq 'mtime') {
130 @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
132 elsif (! exists $params{sort} || $params{sort} eq 'age') {
133 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
136 return sprintf(gettext("unknown sort type %s"), $params{sort});
139 if (yesno($params{reverse})) {
140 @list=reverse(@list);
143 if (exists $params{skip}) {
144 @list=@list[$params{skip} .. scalar @list - 1];
147 if ($params{show} && @list > $params{show}) {
148 @list=@list[0..$params{show} - 1];
151 add_depends($params{page}, $params{pages});
152 # Explicitly add all currently displayed pages as dependencies, so
153 # that if they are removed or otherwise changed, the inline will be
154 # sure to be updated.
155 add_depends($params{page}, join(" or ", @list));
156 # Force a scan of this page so any metadata that appears after this
157 # inline directive is available when inlining. The page normally
158 # wouldn't be scanned if it's only being rebuilt because of a
160 IkiWiki::scan($pagesources{$params{page}});
164 my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
165 if (exists $knownfeeds{$feedid}) {
166 $feednum=$knownfeeds{$feedid};
169 if (exists $page_numfeeds{$params{destpage}}) {
171 $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}};
175 $feednum=$knownfeeds{$feedid}="";
177 $page_numfeeds{$params{destpage}}=1;
182 my $rssurl=basename(rsspage($params{destpage}).$feednum) if $feeds && $rss;
183 my $atomurl=basename(atompage($params{destpage}).$feednum) if $feeds && $atom;
186 if ($config{cgiurl} && (exists $params{rootpage} ||
187 (exists $params{postform} && yesno($params{postform})))) {
188 # Add a blog post form, with feed buttons.
189 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
190 $formtemplate->param(cgiurl => $config{cgiurl});
191 $formtemplate->param(rootpage =>
192 exists $params{rootpage} ? $params{rootpage} : $params{page});
193 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
194 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
195 if (exists $params{postformtext}) {
196 $formtemplate->param(postformtext =>
197 $params{postformtext});
200 $formtemplate->param(postformtext =>
201 gettext("Add a new post titled:"));
203 $ret.=$formtemplate->output;
207 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
208 $linktemplate->param(rssurl => $rssurl) if $rss;
209 $linktemplate->param(atomurl => $atomurl) if $atom;
210 $ret.=$linktemplate->output;
214 require HTML::Template;
215 my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
217 return sprintf(gettext("nonexistant template %s"), $params{template});
219 my $template=HTML::Template->new(@params) unless $raw;
221 foreach my $page (@list) {
222 my $file = $pagesources{$page};
223 my $type = pagetype($file);
224 if (! $raw || ($raw && ! defined $type)) {
225 unless ($archive && $quick) {
226 # Get the content before populating the
227 # template, since getting the content uses
228 # the same template if inlines are nested.
229 my $content=get_inline_content($page, $params{destpage});
230 $template->param(content => $content);
232 $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
233 $template->param(title => pagetitle(basename($page)));
234 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
235 $template->param(first => 1) if $page eq $list[0];
236 $template->param(last => 1) if $page eq $list[$#list];
239 my $file = $pagesources{$page};
240 my $type = pagetype($file);
241 if ($config{discussion}) {
242 my $discussionlink=gettext("discussion");
243 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
244 (length $config{cgiurl} ||
245 exists $links{$page."/".$discussionlink})) {
246 $template->param(have_actions => 1);
247 $template->param(discussionlink =>
250 gettext("Discussion"),
255 if (length $config{cgiurl} && defined $type) {
256 $template->param(have_actions => 1);
257 $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
261 run_hooks(pagetemplate => sub {
262 shift->(page => $page, destpage => $params{destpage},
263 template => $template,);
266 $ret.=$template->output;
267 $template->clear_params;
272 linkify($page, $params{destpage},
273 preprocess($page, $params{destpage},
274 filter($page, $params{destpage},
275 readfile(srcfile($file)))));
282 if (exists $params{feedshow} && @list > $params{feedshow}) {
283 @list=@list[0..$params{feedshow} - 1];
285 if (exists $params{feedpages}) {
286 @list=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @list;
289 if ($rss && ! $params{preview}) {
290 my $rssp=rsspage($params{destpage}).$feednum;
291 will_render($params{destpage}, $rssp);
292 writefile($rssp, $config{destdir},
293 genfeed("rss", $rssurl, $desc, $params{destpage}, @list));
294 $toping{$params{destpage}}=1 unless $config{rebuild};
295 $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
297 if ($atom && ! $params{preview}) {
298 my $atomp=atompage($params{destpage}).$feednum;
299 will_render($params{destpage}, $atomp);
300 writefile($atomp, $config{destdir},
301 genfeed("atom", $atomurl, $desc, $params{destpage}, @list));
302 $toping{$params{destpage}}=1 unless $config{rebuild};
303 $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
310 sub pagetemplate_inline (@) { #{{{
312 my $page=$params{page};
313 my $template=$params{template};
315 $template->param(feedlinks => $feedlinks{$page})
316 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
319 sub get_inline_content ($$) { #{{{
323 my $file=$pagesources{$page};
324 my $type=pagetype($file);
326 return htmlize($page, $type,
327 linkify($page, $destpage,
328 preprocess($page, $destpage,
329 filter($page, $destpage,
330 readfile(srcfile($file))))));
337 sub date_822 ($) { #{{{
340 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
341 POSIX::setlocale(&POSIX::LC_TIME, "C");
342 my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
343 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
347 sub date_3339 ($) { #{{{
350 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
351 POSIX::setlocale(&POSIX::LC_TIME, "C");
352 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
353 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
357 sub absolute_urls ($$) { #{{{
358 # sucky sub because rss sucks
365 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
366 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/mig;
367 $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/mig;
371 sub rsspage ($) { #{{{
372 return targetpage(shift, "rss");
375 sub atompage ($) { #{{{
376 return targetpage(shift, "atom");
379 sub genfeed ($$$$@) { #{{{
386 my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
388 my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
391 foreach my $p (@pages) {
392 my $u=URI->new(encode_utf8($config{url}."/".urlto($p, "")));
393 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
395 $itemtemplate->param(
396 title => pagetitle(basename($p)),
399 cdate_822 => date_822($pagectime{$p}),
400 mdate_822 => date_822($pagemtime{$p}),
401 cdate_3339 => date_3339($pagectime{$p}),
402 mdate_3339 => date_3339($pagemtime{$p}),
405 if ($itemtemplate->query(name => "enclosure")) {
406 my $file=$pagesources{$p};
407 my $type=pagetype($file);
409 $itemtemplate->param(content => $pcontent);
412 my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
414 eval q{use File::MimeInfo};
416 $mime = mimetype($file);
418 $itemtemplate->param(
426 $itemtemplate->param(content => $pcontent);
429 run_hooks(pagetemplate => sub {
430 shift->(page => $p, destpage => $page,
431 template => $itemtemplate);
434 $content.=$itemtemplate->output;
435 $itemtemplate->clear_params;
437 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
440 my $template=template($feedtype."page.tmpl", blind_cache => 1);
442 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
443 wikiname => $config{wikiname},
446 feeddesc => $feeddesc,
447 feeddate => date_3339($lasttime),
449 version => $IkiWiki::version,
451 run_hooks(pagetemplate => sub {
452 shift->(page => $page, destpage => $page,
453 template => $template);
456 return $template->output;
459 sub pingurl (@) { #{{{
460 return unless @{$config{pingurl}} && %toping;
462 eval q{require RPC::XML::Client};
464 debug(gettext("RPC::XML::Client not found, not pinging"));
468 # daemonize here so slow pings don't slow down wiki updates
469 defined(my $pid = fork) or error("Can't fork: $!");
472 setsid() or error("Can't start a new session: $!");
473 open STDIN, '/dev/null';
474 open STDOUT, '>/dev/null';
475 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
477 # Don't need to keep a lock on the wiki as a daemon.
478 IkiWiki::unlockwiki();
480 foreach my $page (keys %toping) {
481 my $title=pagetitle(basename($page), 0);
482 my $url="$config{url}/".urlto($page, "");
483 foreach my $pingurl (@{$config{pingurl}}) {
484 debug("Pinging $pingurl for $page");
486 my $client = RPC::XML::Client->new($pingurl);
487 my $req = RPC::XML::request->new('weblogUpdates.ping',
489 my $res = $client->send_request($req);
491 debug("Did not receive response to ping");
494 if (! exists $r->{flerror} || $r->{flerror}) {
495 debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
499 debug "Ping failed: $@";
504 exit 0; # daemon done