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];
57 description => "enable rss feeds by default?",
64 description => "enable atom feeds by default?",
71 description => "allow rss feeds to be used?",
78 description => "allow atom feeds to be used?",
84 example => "http://rpc.technorati.com/rpc/ping",
85 description => "urls to ping (using XML-RPC) on feed update",
91 example => '%1$s\'s %2$s',
92 description => "format string for the default feed description, using the wiki name and page title as parameters",
99 if (($config{rss} || $config{atom}) && ! length $config{url}) {
100 error(gettext("Must specify url to wiki with --url when using --rss or --atom"));
103 push @{$config{wiki_file_prune_regexps}}, qr/\.rss$/;
106 push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
108 if (! exists $config{pingurl}) {
116 # Fill in the inline content generated earlier. This is actually an
118 $params{content}=~s{<div class="inline" id="([^"]+)"></div>}{
121 return $params{content};
124 sub sessioncgi ($$) {
128 if ($q->param('do') eq 'blog') {
129 my $page=titlepage(decode_utf8($q->param('title')));
130 $page=~s/(\/)/"__".ord($1)."__"/eg; # don't create subdirs
131 # if the page already exists, munge it to be unique
132 my $from=$q->param('from');
134 while (exists $IkiWiki::pagecase{lc($from."/".$page.$add)}) {
135 $add=1 unless length $add;
138 $q->param('page', "/$from/$page$add");
139 # now go create the page
140 $q->param('do', 'create');
141 # make sure the editpage plugin is loaded
142 if (IkiWiki->can("cgi_editpage")) {
143 IkiWiki::cgi_editpage($q, $session);
146 error(gettext("page editing not allowed"));
152 # Back to ikiwiki namespace for the rest, this code is very much
153 # internal to ikiwiki even though it's separated into a plugin.
159 sub preprocess_inline (@) {
162 if (! exists $params{pages} && ! exists $params{pagenames}) {
163 error gettext("missing pages parameter");
165 my $raw=yesno($params{raw});
166 my $archive=yesno($params{archive});
167 my $rss=(($config{rss} || $config{allowrss}) && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
168 my $atom=(($config{atom} || $config{allowatom}) && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
169 my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
170 my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick && ! $raw;
171 my $emptyfeeds=exists $params{emptyfeeds} ? yesno($params{emptyfeeds}) : 1;
172 my $feedonly=yesno($params{feedonly});
173 if (! exists $params{show} && ! $archive) {
176 if (! exists $params{feedshow} && exists $params{show}) {
177 $params{feedshow}=$params{show};
180 my ($page, $desc, $feedtitle);
181 $page = $params{page};
182 if ($pagestate{$page}{meta} && $pagestate{$page}{meta}{title}) {
183 $feedtitle = $pagestate{$page}{meta}{title};
185 $feedtitle = pagetitle(basename($page));
187 if (exists $params{description}) {
188 $desc = $params{description}
189 } elsif ($pagestate{$page}{meta} && $pagestate{$page}{meta}{description}) {
190 $desc = $pagestate{$page}{meta}{description};
192 if ($page =~ m!^/?index(?:$|\.)!) {
193 $desc = $config{wikiname};
195 my $descfmt = defined $config{feed_desc_fmt} ? $config{feed_desc_fmt} : '%1$s\'s %2$s';
196 $desc = sprintf($descfmt, $config{wikiname}, $feedtitle);
199 my $actions=yesno($params{actions});
200 if (exists $params{template}) {
201 $params{template}=~s/[^-_a-zA-Z0-9]+//g;
204 $params{template} = $archive ? "archivepage" : "inlinepage";
209 if (exists $params{pagenames}) {
210 foreach my $p (qw(sort pages)) {
211 if (exists $params{$p}) {
212 error sprintf(gettext("the %s and %s parameters cannot be used together"),
217 @list = map { bestlink($params{page}, $_) }
218 split ' ', $params{pagenames};
220 if (yesno($params{reverse})) {
221 @list=reverse(@list);
224 foreach my $p (@list) {
225 add_depends($params{page}, $p, deptype($quick ? "presence" : "content"));
233 if ($params{feedshow} && $num < $params{feedshow} && $num > 0) {
234 $num=$params{feedshow};
236 if ($params{skip} && $num) {
240 @list = pagespec_match_list($params{page}, $params{pages},
241 deptype => deptype($quick ? "presence" : "content"),
242 filter => sub { $_[0] eq $params{page} },
243 sort => exists $params{sort} ? $params{sort} : "age",
244 reverse => yesno($params{reverse}),
245 ($num ? (num => $num) : ()),
249 if (exists $params{skip}) {
250 @list=@list[$params{skip} .. $#list];
255 if (exists $params{feedshow} &&
256 $params{feedshow} && @list > $params{feedshow}) {
257 @feedlist=@list[0..$params{feedshow} - 1];
264 if ($params{show} && @list > $params{show}) {
265 @list=@list[0..$params{show} - 1];
268 if ($feeds && exists $params{feedpages}) {
269 @feedlist = pagespec_match_list(
270 $params{page}, "($params{pages}) and ($params{feedpages})",
271 deptype => deptype($quick ? "presence" : "content"),
276 my ($feedbase, $feednum);
278 # Ensure that multiple feeds on a page go to unique files.
280 # Feedfile can lead to conflicts if usedirs is not enabled,
281 # so avoid supporting it in that case.
282 delete $params{feedfile} if ! $config{usedirs};
283 # Tight limits on legal feedfiles, to avoid security issues
285 if (defined $params{feedfile}) {
286 if ($params{feedfile} =~ /\// ||
287 $params{feedfile} !~ /$config{wiki_file_regexp}/) {
288 error("illegal feedfile");
290 $params{feedfile}=possibly_foolish_untaint($params{feedfile});
292 $feedbase=targetpage($params{page}, "", $params{feedfile});
294 my $feedid=join("\0", $feedbase, map { $_."\0".$params{$_} } sort keys %params);
295 if (exists $knownfeeds{$feedid}) {
296 $feednum=$knownfeeds{$feedid};
299 if (exists $page_numfeeds{$params{destpage}}{$feedbase}) {
301 $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}}{$feedbase};
305 $feednum=$knownfeeds{$feedid}="";
307 $page_numfeeds{$params{destpage}}{$feedbase}=1;
313 my ($rssurl, $atomurl, $rssdesc, $atomdesc);
316 $rssurl=abs2rel($feedbase."rss".$feednum, dirname(htmlpage($params{destpage})));
317 $rssdesc = gettext("%s (RSS feed)", $desc);
320 $atomurl=abs2rel($feedbase."atom".$feednum, dirname(htmlpage($params{destpage})));
321 $atomdesc = gettext("%s (Atom feed)", $desc);
327 if (length $config{cgiurl} && ! $params{preview} && (exists $params{rootpage} ||
328 (exists $params{postform} && yesno($params{postform}))) &&
329 IkiWiki->can("cgi_editpage")) {
330 # Add a blog post form, with feed buttons.
331 my $formtemplate=template_depends("blogpost.tmpl", $params{page}, blind_cache => 1);
332 $formtemplate->param(cgiurl => IkiWiki::cgiurl());
333 $formtemplate->param(rootpage => rootpage(%params));
336 $formtemplate->param(rssurl => $rssurl);
337 $formtemplate->param(rssdesc => $rssdesc);
340 $formtemplate->param(atomurl => $atomurl);
341 $formtemplate->param(atomdesc => $atomdesc);
344 if (exists $params{postformtext}) {
345 $formtemplate->param(postformtext =>
346 $params{postformtext});
349 $formtemplate->param(postformtext =>
350 gettext("Add a new post titled:"));
352 $ret.=$formtemplate->output;
354 # The post form includes the feed buttons, so
355 # emptyfeeds cannot be hidden.
358 elsif ($feeds && !$params{preview} && ($emptyfeeds || @feedlist)) {
360 my $linktemplate=template_depends("feedlink.tmpl", $params{page}, blind_cache => 1);
362 $linktemplate->param(rssurl => $rssurl);
363 $linktemplate->param(rssdesc => $rssdesc);
366 $linktemplate->param(atomurl => $atomurl);
367 $linktemplate->param(atomdesc => $atomdesc);
369 $ret.=$linktemplate->output;
375 # cannot use wiki pages as templates; template not sanitized due to
378 $template=template_depends($params{template}.".tmpl", $params{page},
382 error sprintf(gettext("failed to process template %s"), $params{template}.".tmpl").": $@";
385 my $needcontent=$raw || (!($archive && $quick) && $template->query(name => 'content'));
387 foreach my $page (@list) {
388 my $file = $pagesources{$page};
389 my $type = pagetype($file);
392 # Get the content before populating the
393 # template, since getting the content uses
394 # the same template if inlines are nested.
395 my $content=get_inline_content($page, $params{destpage});
396 $template->param(content => $content);
398 $template->param(pageurl => urlto($page, $params{destpage}));
399 $template->param(inlinepage => $page);
400 $template->param(title => pagetitle(basename($page)));
401 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}, 1));
402 $template->param(mtime => displaytime($pagemtime{$page}, $params{timeformat}));
403 $template->param(first => 1) if $page eq $list[0];
404 $template->param(last => 1) if $page eq $list[$#list];
405 $template->param(html5 => $config{html5});
408 my $file = $pagesources{$page};
409 my $type = pagetype($file);
410 if ($config{discussion}) {
411 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
412 (length $config{cgiurl} ||
413 exists $pagesources{$page."/".lc($config{discussionpage})})) {
414 $template->param(have_actions => 1);
415 $template->param(discussionlink =>
418 $config{discussionpage},
423 if (length $config{cgiurl} &&
425 IkiWiki->can("cgi_editpage")) {
426 $template->param(have_actions => 1);
427 $template->param(editurl => cgiurl(do => "edit", page => $page));
432 run_hooks(pagetemplate => sub {
433 shift->(page => $page, destpage => $params{destpage},
434 template => $template,);
437 $ret.=$template->output;
438 $template->clear_params;
443 linkify($page, $params{destpage},
444 preprocess($page, $params{destpage},
445 filter($page, $params{destpage},
446 readfile(srcfile($file)))));
450 readfile(srcfile($file));
456 if ($feeds && ($emptyfeeds || @feedlist)) {
458 my $rssp=$feedbase."rss".$feednum;
459 will_render($params{destpage}, $rssp);
460 if (! $params{preview}) {
461 writefile($rssp, $config{destdir},
463 $config{url}."/".$rssp, $feedtitle, $desc, $params{guid}, $params{destpage}, @feedlist));
464 $toping{$params{destpage}}=1 unless $config{rebuild};
465 $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/rss+xml" title="$rssdesc" href="$rssurl" />};
469 my $atomp=$feedbase."atom".$feednum;
470 will_render($params{destpage}, $atomp);
471 if (! $params{preview}) {
472 writefile($atomp, $config{destdir},
473 genfeed("atom", $config{url}."/".$atomp, $feedtitle, $desc, $params{guid}, $params{destpage}, @feedlist));
474 $toping{$params{destpage}}=1 unless $config{rebuild};
475 $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/atom+xml" title="$atomdesc" href="$atomurl" />};
480 clear_inline_content_cache();
482 return $ret if $raw || $nested;
484 return "<div class=\"inline\" id=\"$#inline\"></div>\n\n";
487 sub pagetemplate_inline (@) {
489 my $page=$params{page};
490 my $template=$params{template};
492 $template->param(feedlinks => $feedlinks{$page})
493 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
498 my $cached_destpage="";
500 sub get_inline_content ($$) {
504 if (exists $inline_content{$page} && $cached_destpage eq $destpage) {
505 return $inline_content{$page};
508 my $file=$pagesources{$page};
509 my $type=pagetype($file);
513 $ret=htmlize($page, $destpage, $type,
514 linkify($page, $destpage,
515 preprocess($page, $destpage,
516 filter($page, $destpage,
517 readfile(srcfile($file))))));
519 if (isinternal($page)) {
520 # make inlined text of internal pages searchable
521 run_hooks(indexhtml => sub {
522 shift->(page => $page, destpage => $page,
528 if ($cached_destpage ne $destpage) {
529 clear_inline_content_cache();
530 $cached_destpage=$destpage;
532 return $inline_content{$page}=$ret;
535 sub clear_inline_content_cache () {
544 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
545 POSIX::setlocale(&POSIX::LC_TIME, "C");
546 my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
547 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
551 sub absolute_urls ($$) {
552 # needed because rss sucks
558 my $urltop; # calculated if needed
562 eval q{use HTML::Parser; use HTML::Tagset};
564 my $p = HTML::Parser->new(api_version => 3);
565 $p->handler(default => sub { $ret.=join("", @_) }, "text");
566 $p->handler(start => sub {
567 my ($tagname, $pos, $text) = @_;
568 if (ref $HTML::Tagset::linkElements{$tagname}) {
570 # use attribute sets from right to left
571 # to avoid invalidating the offsets
572 # when replacing the values
573 my ($k_offset, $k_len, $v_offset, $v_len) =
575 my $attrname = lc(substr($text, $k_offset, $k_len));
576 next unless grep { $_ eq $attrname } @{$HTML::Tagset::linkElements{$tagname}};
577 next unless $v_offset; # 0 v_offset means no value
578 my $v = substr($text, $v_offset, $v_len);
579 $v =~ s/^([\'\"])(.*)\1$/$2/;
581 $v=$baseurl.$v; # anchor
583 elsif ($v=~/^(?!\w+:)[^\/]/) {
584 $v=$url.$v; # relative url
587 if (! defined $urltop) {
588 # what is the non path part of the url?
589 my $top_uri = URI->new($url);
590 $top_uri->path_query(""); # reset the path
591 $urltop = $top_uri->as_string;
593 $v=$urltop.$v; # url relative to top of site
595 $v =~ s/\"/"/g; # since we quote with ""
596 substr($text, $v_offset, $v_len) = qq("$v");
600 }, "tagname, tokenpos, text");
607 sub genfeed ($$$$$@) {
616 my $url=URI->new(encode_utf8(urlto($page,"",1)));
618 my $itemtemplate=template_depends($feedtype."item.tmpl", $page, blind_cache => 1);
621 foreach my $p (@pages) {
622 my $u=URI->new(encode_utf8(urlto($p, "", 1)));
623 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
625 $itemtemplate->param(
626 title => pagetitle(basename($p)),
629 cdate_822 => date_822($pagectime{$p}),
630 mdate_822 => date_822($pagemtime{$p}),
631 cdate_3339 => date_3339($pagectime{$p}),
632 mdate_3339 => date_3339($pagemtime{$p}),
635 if (exists $pagestate{$p}) {
636 if (exists $pagestate{$p}{meta}{guid}) {
637 eval q{use HTML::Entities};
638 $itemtemplate->param(guid => HTML::Entities::encode_numeric($pagestate{$p}{meta}{guid}));
641 if (exists $pagestate{$p}{meta}{updated}) {
642 $itemtemplate->param(mdate_822 => date_822($pagestate{$p}{meta}{updated}));
643 $itemtemplate->param(mdate_3339 => date_3339($pagestate{$p}{meta}{updated}));
647 if ($itemtemplate->query(name => "enclosure")) {
648 my $file=$pagesources{$p};
649 my $type=pagetype($file);
651 $itemtemplate->param(content => $pcontent);
654 my $size=(srcfile_stat($file))[8];
656 eval q{use File::MimeInfo};
658 $mime = mimetype($file);
660 $itemtemplate->param(
668 $itemtemplate->param(content => $pcontent);
671 run_hooks(pagetemplate => sub {
672 shift->(page => $p, destpage => $page,
673 template => $itemtemplate);
676 $content.=$itemtemplate->output;
677 $itemtemplate->clear_params;
679 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
682 my $template=template_depends($feedtype."page.tmpl", $page, blind_cache => 1);
685 wikiname => $config{wikiname},
688 feeddesc => $feeddesc,
690 feeddate => date_3339($lasttime),
692 version => $IkiWiki::version,
694 run_hooks(pagetemplate => sub {
695 shift->(page => $page, destpage => $page,
696 template => $template);
699 return $template->output;
703 return unless @{$config{pingurl}} && %toping;
705 eval q{require RPC::XML::Client};
707 debug(gettext("RPC::XML::Client not found, not pinging"));
711 # daemonize here so slow pings don't slow down wiki updates
712 defined(my $pid = fork) or error("Can't fork: $!");
715 POSIX::setsid() or error("Can't start a new session: $!");
716 open STDIN, '/dev/null';
717 open STDOUT, '>/dev/null';
718 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
720 # Don't need to keep a lock on the wiki as a daemon.
721 IkiWiki::unlockwiki();
723 foreach my $page (keys %toping) {
724 my $title=pagetitle(basename($page), 0);
725 my $url=urlto($page, "", 1);
726 foreach my $pingurl (@{$config{pingurl}}) {
727 debug("Pinging $pingurl for $page");
729 my $client = RPC::XML::Client->new($pingurl);
730 my $req = RPC::XML::request->new('weblogUpdates.ping',
732 my $res = $client->send_request($req);
734 error("Did not receive response to ping");
737 if (! exists $r->{flerror} || $r->{flerror}) {
738 error("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
742 error "Ping failed: $@";
747 exit 0; # daemon done
755 if (exists $params{rootpage}) {
756 $rootpage=bestlink($params{page}, $params{rootpage});
757 if (!length $rootpage) {
758 $rootpage=$params{rootpage};
762 $rootpage=$params{page};