2 # Page inlining and blogging.
3 package IkiWiki::Plugin::inline;
17 hook(type => "getopt", id => "inline", call => \&getopt);
18 hook(type => "getsetup", id => "inline", call => \&getsetup);
19 hook(type => "checkconfig", id => "inline", call => \&checkconfig);
20 hook(type => "sessioncgi", id => "inline", call => \&sessioncgi);
21 hook(type => "preprocess", id => "inline",
22 call => \&IkiWiki::preprocess_inline);
23 hook(type => "pagetemplate", id => "inline",
24 call => \&IkiWiki::pagetemplate_inline);
25 hook(type => "format", id => "inline", call => \&format, first => 1);
26 # Hook to change to do pinging since it's called late.
27 # This ensures each page only pings once and prevents slow
28 # pings interrupting page builds.
29 hook(type => "change", id => "inline", call => \&IkiWiki::pingurl);
33 eval q{use Getopt::Long};
35 Getopt::Long::Configure('pass_through');
37 "rss!" => \$config{rss},
38 "atom!" => \$config{atom},
39 "allowrss!" => \$config{allowrss},
40 "allowatom!" => \$config{allowatom},
42 push @{$config{pingurl}}, $_[1];
56 description => "enable rss feeds by default?",
63 description => "enable atom feeds by default?",
70 description => "allow rss feeds to be used?",
77 description => "allow atom feeds to be used?",
83 example => "http://rpc.technorati.com/rpc/ping",
84 description => "urls to ping (using XML-RPC) on feed update",
91 if (($config{rss} || $config{atom}) && ! length $config{url}) {
92 error(gettext("Must specify url to wiki with --url when using --rss or --atom"));
95 push @{$config{wiki_file_prune_regexps}}, qr/\.rss$/;
98 push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
100 if (! exists $config{pingurl}) {
108 # Fill in the inline content generated earlier. This is actually an
110 $params{content}=~s{<div class="inline" id="([^"]+)"></div>}{
113 return $params{content};
116 sub sessioncgi ($$) {
120 if ($q->param('do') eq 'blog') {
121 my $page=titlepage(decode_utf8($q->param('title')));
122 $page=~s/(\/)/"__".ord($1)."__"/eg; # don't create subdirs
123 # if the page already exists, munge it to be unique
124 my $from=$q->param('from');
126 while (exists $IkiWiki::pagecase{lc($from."/".$page.$add)}) {
127 $add=1 unless length $add;
130 $q->param('page', $page.$add);
131 # now go create the page
132 $q->param('do', 'create');
133 # make sure the editpage plugin in loaded
134 if (IkiWiki->can("cgi_editpage")) {
135 IkiWiki::cgi_editpage($q, $session);
138 error(gettext("page editing not allowed"));
144 # Back to ikiwiki namespace for the rest, this code is very much
145 # internal to ikiwiki even though it's separated into a plugin.
151 sub preprocess_inline (@) {
154 if (! exists $params{pages} && ! exists $params{pagenames}) {
155 error gettext("missing pages parameter");
157 my $raw=yesno($params{raw});
158 my $archive=yesno($params{archive});
159 my $rss=(($config{rss} || $config{allowrss}) && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
160 my $atom=(($config{atom} || $config{allowatom}) && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
161 my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
162 my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick;
163 my $emptyfeeds=exists $params{emptyfeeds} ? yesno($params{emptyfeeds}) : 1;
164 my $feedonly=yesno($params{feedonly});
165 if (! exists $params{show} && ! $archive) {
168 if (! exists $params{feedshow} && exists $params{show}) {
169 $params{feedshow}=$params{show};
172 if (exists $params{description}) {
173 $desc = $params{description}
176 $desc = $config{wikiname};
178 my $actions=yesno($params{actions});
179 if (exists $params{template}) {
180 $params{template}=~s/[^-_a-zA-Z0-9]+//g;
183 $params{template} = $archive ? "archivepage" : "inlinepage";
188 if (exists $params{pagenames}) {
189 foreach my $p (qw(sort pages)) {
190 if (exists $params{$p}) {
191 error sprintf(gettext("the %s and %s parameters cannot be used together"),
196 @list = map { bestlink($params{page}, $_) }
197 split ' ', $params{pagenames};
199 $params{pages} = join(" or ", @list);
202 @list = pagespec_match_list(
203 [ grep { $_ ne $params{page} } keys %pagesources ],
204 $params{pages}, location => $params{page});
206 if (exists $params{sort} && $params{sort} eq 'title') {
207 @list=sort { pagetitle(basename($a)) cmp pagetitle(basename($b)) } @list;
209 elsif (exists $params{sort} && $params{sort} eq 'title_natural') {
210 eval q{use Sort::Naturally};
212 error(gettext("Sort::Naturally needed for title_natural sort"));
214 @list=sort { Sort::Naturally::ncmp(pagetitle(basename($a)), pagetitle(basename($b))) } @list;
216 elsif (exists $params{sort} && $params{sort} eq 'mtime') {
217 @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
219 elsif (! exists $params{sort} || $params{sort} eq 'age') {
220 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
223 error sprintf(gettext("unknown sort type %s"), $params{sort});
227 if (yesno($params{reverse})) {
228 @list=reverse(@list);
231 if (exists $params{skip}) {
232 @list=@list[$params{skip} .. scalar @list - 1];
237 if (exists $params{feedshow} &&
238 $params{feedshow} && @list > $params{feedshow}) {
239 @feedlist=@list[0..$params{feedshow} - 1];
246 if ($params{show} && @list > $params{show}) {
247 @list=@list[0..$params{show} - 1];
250 add_depends($params{page}, $params{pages});
251 # Explicitly add all currently displayed pages as dependencies, so
252 # that if they are removed or otherwise changed, the inline will be
253 # sure to be updated.
254 add_depends($params{page}, join(" or ", $#list >= $#feedlist ? @list : @feedlist));
256 if ($feeds && exists $params{feedpages}) {
257 @feedlist=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @feedlist;
260 my ($feedbase, $feednum);
262 # Ensure that multiple feeds on a page go to unique files.
264 # Feedfile can lead to conflicts if usedirs is not enabled,
265 # so avoid supporting it in that case.
266 delete $params{feedfile} if ! $config{usedirs};
267 # Tight limits on legal feedfiles, to avoid security issues
269 if (defined $params{feedfile}) {
270 if ($params{feedfile} =~ /\// ||
271 $params{feedfile} !~ /$config{wiki_file_regexp}/) {
272 error("illegal feedfile");
274 $params{feedfile}=possibly_foolish_untaint($params{feedfile});
276 $feedbase=targetpage($params{destpage}, "", $params{feedfile});
278 my $feedid=join("\0", $feedbase, map { $_."\0".$params{$_} } sort keys %params);
279 if (exists $knownfeeds{$feedid}) {
280 $feednum=$knownfeeds{$feedid};
283 if (exists $page_numfeeds{$params{destpage}}{$feedbase}) {
285 $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}}{$feedbase};
289 $feednum=$knownfeeds{$feedid}="";
291 $page_numfeeds{$params{destpage}}{$feedbase}=1;
297 my $rssurl=abs2rel($feedbase."rss".$feednum, dirname(htmlpage($params{destpage}))) if $feeds && $rss;
298 my $atomurl=abs2rel($feedbase."atom".$feednum, dirname(htmlpage($params{destpage}))) if $feeds && $atom;
302 if (length $config{cgiurl} && ! $params{preview} && (exists $params{rootpage} ||
303 (exists $params{postform} && yesno($params{postform}))) &&
304 IkiWiki->can("cgi_editpage")) {
305 # Add a blog post form, with feed buttons.
306 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
307 $formtemplate->param(cgiurl => $config{cgiurl});
309 if (exists $params{rootpage}) {
310 $rootpage=bestlink($params{page}, $params{rootpage});
311 if (!length $rootpage) {
312 $rootpage=$params{rootpage};
316 $rootpage=$params{page};
318 $formtemplate->param(rootpage => $rootpage);
319 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
320 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
321 if (exists $params{postformtext}) {
322 $formtemplate->param(postformtext =>
323 $params{postformtext});
326 $formtemplate->param(postformtext =>
327 gettext("Add a new post titled:"));
329 $ret.=$formtemplate->output;
331 # The post form includes the feed buttons, so
332 # emptyfeeds cannot be hidden.
335 elsif ($feeds && !$params{preview} && ($emptyfeeds || @feedlist)) {
337 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
338 $linktemplate->param(rssurl => $rssurl) if $rss;
339 $linktemplate->param(atomurl => $atomurl) if $atom;
340 $ret.=$linktemplate->output;
344 require HTML::Template;
345 my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
347 error sprintf(gettext("nonexistant template %s"), $params{template});
349 my $template=HTML::Template->new(@params) unless $raw;
351 my $discussionlink=lc(gettext("Discussion"))
352 if $config{discussion};
354 foreach my $page (@list) {
355 my $file = $pagesources{$page};
356 my $type = pagetype($file);
357 if (! $raw || ($raw && ! defined $type)) {
358 unless ($archive && $quick) {
359 # Get the content before populating the
360 # template, since getting the content uses
361 # the same template if inlines are nested.
362 my $content=get_inline_content($page, $params{destpage});
363 $template->param(content => $content);
365 $template->param(pageurl => urlto($page, $params{destpage}));
366 $template->param(inlinepage => $page);
367 $template->param(title => pagetitle(basename($page)));
368 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
369 $template->param(mtime => displaytime($pagemtime{$page}, $params{timeformat}));
370 $template->param(first => 1) if $page eq $list[0];
371 $template->param(last => 1) if $page eq $list[$#list];
374 my $file = $pagesources{$page};
375 my $type = pagetype($file);
376 if ($config{discussion}) {
377 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
378 (length $config{cgiurl} ||
379 exists $links{$page."/".$discussionlink})) {
380 $template->param(have_actions => 1);
381 $template->param(discussionlink =>
384 gettext("Discussion"),
389 if (length $config{cgiurl} && defined $type) {
390 $template->param(have_actions => 1);
391 $template->param(editurl => cgiurl(do => "edit", page => $page));
395 run_hooks(pagetemplate => sub {
396 shift->(page => $page, destpage => $params{destpage},
397 template => $template,);
400 $ret.=$template->output;
401 $template->clear_params;
406 linkify($page, $params{destpage},
407 preprocess($page, $params{destpage},
408 filter($page, $params{destpage},
409 readfile(srcfile($file)))));
415 if ($feeds && ($emptyfeeds || @feedlist)) {
417 my $rssp=$feedbase."rss".$feednum;
418 will_render($params{destpage}, $rssp);
419 if (! $params{preview}) {
420 writefile($rssp, $config{destdir},
422 $config{url}."/".$rssp, $desc, $params{guid}, $params{destpage}, @feedlist));
423 $toping{$params{destpage}}=1 unless $config{rebuild};
424 $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/rss+xml" title="$desc (RSS)" href="$rssurl" />};
428 my $atomp=$feedbase."atom".$feednum;
429 will_render($params{destpage}, $atomp);
430 if (! $params{preview}) {
431 writefile($atomp, $config{destdir},
432 genfeed("atom", $config{url}."/".$atomp, $desc, $params{guid}, $params{destpage}, @feedlist));
433 $toping{$params{destpage}}=1 unless $config{rebuild};
434 $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/atom+xml" title="$desc (Atom)" href="$atomurl" />};
439 return $ret if $raw || $nested;
441 return "<div class=\"inline\" id=\"$#inline\"></div>\n\n";
444 sub pagetemplate_inline (@) {
446 my $page=$params{page};
447 my $template=$params{template};
449 $template->param(feedlinks => $feedlinks{$page})
450 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
453 sub get_inline_content ($$) {
457 my $file=$pagesources{$page};
458 my $type=pagetype($file);
461 my $ret=htmlize($page, $destpage, $type,
462 linkify($page, $destpage,
463 preprocess($page, $destpage,
464 filter($page, $destpage,
465 readfile(srcfile($file))))));
477 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
478 POSIX::setlocale(&POSIX::LC_TIME, "C");
479 my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
480 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
487 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
488 POSIX::setlocale(&POSIX::LC_TIME, "C");
489 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
490 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
494 sub absolute_urls ($$) {
495 # sucky sub because rss sucks
502 # what is the non path part of the url?
503 my $top_uri = URI->new($url);
504 $top_uri->path_query(""); # reset the path
505 my $urltop = $top_uri->as_string;
507 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
508 # relative to another wiki page
509 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:)([^\/][^"]*)"/$1 href="$url$2"/mig;
510 $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:)([^\/][^"]*)"/$1 src="$url$2"/mig;
511 # relative to the top of the site
512 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:)(\/[^"]*)"/$1 href="$urltop$2"/mig;
513 $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:)(\/[^"]*)"/$1 src="$urltop$2"/mig;
517 sub genfeed ($$$$$@) {
525 my $url=URI->new(encode_utf8(urlto($page,"",1)));
527 my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
530 foreach my $p (@pages) {
531 my $u=URI->new(encode_utf8(urlto($p, "", 1)));
532 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
534 $itemtemplate->param(
535 title => pagetitle(basename($p)),
538 cdate_822 => date_822($pagectime{$p}),
539 mdate_822 => date_822($pagemtime{$p}),
540 cdate_3339 => date_3339($pagectime{$p}),
541 mdate_3339 => date_3339($pagemtime{$p}),
544 if (exists $pagestate{$p}) {
545 if (exists $pagestate{$p}{meta}{guid}) {
546 $itemtemplate->param(guid => $pagestate{$p}{meta}{guid});
549 if (exists $pagestate{$p}{meta}{updated}) {
550 $itemtemplate->param(mdate_822 => date_822($pagestate{$p}{meta}{updated}));
551 $itemtemplate->param(mdate_3339 => date_3339($pagestate{$p}{meta}{updated}));
555 if ($itemtemplate->query(name => "enclosure")) {
556 my $file=$pagesources{$p};
557 my $type=pagetype($file);
559 $itemtemplate->param(content => $pcontent);
562 my $size=(srcfile_stat($file))[8];
564 eval q{use File::MimeInfo};
566 $mime = mimetype($file);
568 $itemtemplate->param(
576 $itemtemplate->param(content => $pcontent);
579 run_hooks(pagetemplate => sub {
580 shift->(page => $p, destpage => $page,
581 template => $itemtemplate);
584 $content.=$itemtemplate->output;
585 $itemtemplate->clear_params;
587 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
590 my $template=template($feedtype."page.tmpl", blind_cache => 1);
592 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
593 wikiname => $config{wikiname},
596 feeddesc => $feeddesc,
598 feeddate => date_3339($lasttime),
600 version => $IkiWiki::version,
602 run_hooks(pagetemplate => sub {
603 shift->(page => $page, destpage => $page,
604 template => $template);
607 return $template->output;
611 return unless @{$config{pingurl}} && %toping;
613 eval q{require RPC::XML::Client};
615 debug(gettext("RPC::XML::Client not found, not pinging"));
619 # daemonize here so slow pings don't slow down wiki updates
620 defined(my $pid = fork) or error("Can't fork: $!");
623 POSIX::setsid() or error("Can't start a new session: $!");
624 open STDIN, '/dev/null';
625 open STDOUT, '>/dev/null';
626 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
628 # Don't need to keep a lock on the wiki as a daemon.
629 IkiWiki::unlockwiki();
631 foreach my $page (keys %toping) {
632 my $title=pagetitle(basename($page), 0);
633 my $url=urlto($page, "", 1);
634 foreach my $pingurl (@{$config{pingurl}}) {
635 debug("Pinging $pingurl for $page");
637 my $client = RPC::XML::Client->new($pingurl);
638 my $req = RPC::XML::request->new('weblogUpdates.ping',
640 my $res = $client->send_request($req);
642 error("Did not receive response to ping");
645 if (! exists $r->{flerror} || $r->{flerror}) {
646 error("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
650 error "Ping failed: $@";
655 exit 0; # daemon done