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}) {
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";
187 foreach my $page (keys %pagesources) {
188 next if $page eq $params{page};
189 if (pagespec_match($page, $params{pages}, location => $params{page})) {
194 if (exists $params{sort} && $params{sort} eq 'title') {
195 @list=sort { pagetitle(basename($a)) cmp pagetitle(basename($b)) } @list;
197 elsif (exists $params{sort} && $params{sort} eq 'mtime') {
198 @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
200 elsif (! exists $params{sort} || $params{sort} eq 'age') {
201 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
204 error sprintf(gettext("unknown sort type %s"), $params{sort});
207 if (yesno($params{reverse})) {
208 @list=reverse(@list);
211 if (exists $params{skip}) {
212 @list=@list[$params{skip} .. scalar @list - 1];
217 if (exists $params{feedshow} &&
218 $params{feedshow} && @list > $params{feedshow}) {
219 @feedlist=@list[0..$params{feedshow} - 1];
226 if ($params{show} && @list > $params{show}) {
227 @list=@list[0..$params{show} - 1];
230 add_depends($params{page}, $params{pages});
231 # Explicitly add all currently displayed pages as dependencies, so
232 # that if they are removed or otherwise changed, the inline will be
233 # sure to be updated.
234 add_depends($params{page}, join(" or ", $#list >= $#feedlist ? @list : @feedlist));
236 if ($feeds && exists $params{feedpages}) {
237 @feedlist=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @feedlist;
240 my ($feedbase, $feednum);
242 # Ensure that multiple feeds on a page go to unique files.
244 # Feedfile can lead to conflicts if usedirs is not enabled,
245 # so avoid supporting it in that case.
246 delete $params{feedfile} if ! $config{usedirs};
247 # Tight limits on legal feedfiles, to avoid security issues
249 if (defined $params{feedfile}) {
250 if ($params{feedfile} =~ /\// ||
251 $params{feedfile} !~ /$config{wiki_file_regexp}/) {
252 error("illegal feedfile");
254 $params{feedfile}=possibly_foolish_untaint($params{feedfile});
256 $feedbase=targetpage($params{destpage}, "", $params{feedfile});
258 my $feedid=join("\0", $feedbase, map { $_."\0".$params{$_} } sort keys %params);
259 if (exists $knownfeeds{$feedid}) {
260 $feednum=$knownfeeds{$feedid};
263 if (exists $page_numfeeds{$params{destpage}}{$feedbase}) {
265 $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}}{$feedbase};
269 $feednum=$knownfeeds{$feedid}="";
271 $page_numfeeds{$params{destpage}}{$feedbase}=1;
277 my $rssurl=basename($feedbase."rss".$feednum) if $feeds && $rss;
278 my $atomurl=basename($feedbase."atom".$feednum) if $feeds && $atom;
282 if (length $config{cgiurl} && ! $params{preview} && (exists $params{rootpage} ||
283 (exists $params{postform} && yesno($params{postform}))) &&
284 IkiWiki->can("cgi_editpage")) {
285 # Add a blog post form, with feed buttons.
286 my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
287 $formtemplate->param(cgiurl => $config{cgiurl});
289 if (exists $params{rootpage}) {
290 $rootpage=bestlink($params{page}, $params{rootpage});
291 if (!length $rootpage) {
292 $rootpage=$params{rootpage};
296 $rootpage=$params{page};
298 $formtemplate->param(rootpage => $rootpage);
299 $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
300 $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
301 if (exists $params{postformtext}) {
302 $formtemplate->param(postformtext =>
303 $params{postformtext});
306 $formtemplate->param(postformtext =>
307 gettext("Add a new post titled:"));
309 $ret.=$formtemplate->output;
311 # The post form includes the feed buttons, so
312 # emptyfeeds cannot be hidden.
315 elsif ($feeds && !$params{preview} && ($emptyfeeds || @feedlist)) {
317 my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
318 $linktemplate->param(rssurl => $rssurl) if $rss;
319 $linktemplate->param(atomurl => $atomurl) if $atom;
320 $ret.=$linktemplate->output;
324 require HTML::Template;
325 my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
327 error sprintf(gettext("nonexistant template %s"), $params{template});
329 my $template=HTML::Template->new(@params) unless $raw;
331 foreach my $page (@list) {
332 my $file = $pagesources{$page};
333 my $type = pagetype($file);
334 if (! $raw || ($raw && ! defined $type)) {
335 unless ($archive && $quick) {
336 # Get the content before populating the
337 # template, since getting the content uses
338 # the same template if inlines are nested.
339 my $content=get_inline_content($page, $params{destpage});
340 $template->param(content => $content);
342 $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
343 $template->param(inlinepage => $page);
344 $template->param(title => pagetitle(basename($page)));
345 $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
346 $template->param(mtime => displaytime($pagemtime{$page}, $params{timeformat}));
347 $template->param(first => 1) if $page eq $list[0];
348 $template->param(last => 1) if $page eq $list[$#list];
351 my $file = $pagesources{$page};
352 my $type = pagetype($file);
353 if ($config{discussion}) {
354 my $discussionlink=gettext("discussion");
355 if ($page !~ /.*\/\Q$discussionlink\E$/ &&
356 (length $config{cgiurl} ||
357 exists $links{$page."/".$discussionlink})) {
358 $template->param(have_actions => 1);
359 $template->param(discussionlink =>
362 gettext("Discussion"),
367 if (length $config{cgiurl} && defined $type) {
368 $template->param(have_actions => 1);
369 $template->param(editurl => cgiurl(do => "edit", page => $page));
373 run_hooks(pagetemplate => sub {
374 shift->(page => $page, destpage => $params{destpage},
375 template => $template,);
378 $ret.=$template->output;
379 $template->clear_params;
384 linkify($page, $params{destpage},
385 preprocess($page, $params{destpage},
386 filter($page, $params{destpage},
387 readfile(srcfile($file)))));
393 if ($feeds && ($emptyfeeds || @feedlist)) {
395 my $rssp=$feedbase."rss".$feednum;
396 will_render($params{destpage}, $rssp);
397 if (! $params{preview}) {
398 writefile($rssp, $config{destdir},
400 $config{url}."/".$rssp, $desc, $params{guid}, $params{destpage}, @feedlist));
401 $toping{$params{destpage}}=1 unless $config{rebuild};
402 $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/rss+xml" title="$desc (RSS)" href="$rssurl" />};
406 my $atomp=$feedbase."atom".$feednum;
407 will_render($params{destpage}, $atomp);
408 if (! $params{preview}) {
409 writefile($atomp, $config{destdir},
410 genfeed("atom", $config{url}."/".$atomp, $desc, $params{guid}, $params{destpage}, @feedlist));
411 $toping{$params{destpage}}=1 unless $config{rebuild};
412 $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/atom+xml" title="$desc (Atom)" href="$atomurl" />};
417 return $ret if $raw || $nested;
419 return "<div class=\"inline\" id=\"$#inline\"></div>\n\n";
422 sub pagetemplate_inline (@) {
424 my $page=$params{page};
425 my $template=$params{template};
427 $template->param(feedlinks => $feedlinks{$page})
428 if exists $feedlinks{$page} && $template->query(name => "feedlinks");
431 sub get_inline_content ($$) {
435 my $file=$pagesources{$page};
436 my $type=pagetype($file);
439 my $ret=htmlize($page, $destpage, $type,
440 linkify($page, $destpage,
441 preprocess($page, $destpage,
442 filter($page, $destpage,
443 readfile(srcfile($file))))));
455 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
456 POSIX::setlocale(&POSIX::LC_TIME, "C");
457 my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
458 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
465 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
466 POSIX::setlocale(&POSIX::LC_TIME, "C");
467 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
468 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
472 sub absolute_urls ($$) {
473 # sucky sub because rss sucks
480 # what is the non path part of the url?
481 my $top_uri = URI->new($url);
482 $top_uri->path_query(""); # reset the path
483 my $urltop = $top_uri->as_string;
485 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
486 # relative to another wiki page
487 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:)([^\/][^"]*)"/$1 href="$url$2"/mig;
488 $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:)([^\/][^"]*)"/$1 src="$url$2"/mig;
489 # relative to the top of the site
490 $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:)(\/[^"]*)"/$1 href="$urltop$2"/mig;
491 $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:)(\/[^"]*)"/$1 src="$urltop$2"/mig;
495 sub genfeed ($$$$$@) {
503 my $url=URI->new(encode_utf8(urlto($page,"",1)));
505 my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
508 foreach my $p (@pages) {
509 my $u=URI->new(encode_utf8(urlto($p, "", 1)));
510 my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
512 $itemtemplate->param(
513 title => pagetitle(basename($p)),
516 cdate_822 => date_822($pagectime{$p}),
517 mdate_822 => date_822($pagemtime{$p}),
518 cdate_3339 => date_3339($pagectime{$p}),
519 mdate_3339 => date_3339($pagemtime{$p}),
522 if (exists $pagestate{$p}) {
523 if (exists $pagestate{$p}{meta}{guid}) {
524 $itemtemplate->param(guid => $pagestate{$p}{meta}{guid});
527 if (exists $pagestate{$p}{meta}{updated}) {
528 $itemtemplate->param(mdate_822 => date_822($pagestate{$p}{meta}{updated}));
529 $itemtemplate->param(mdate_3339 => date_3339($pagestate{$p}{meta}{updated}));
533 if ($itemtemplate->query(name => "enclosure")) {
534 my $file=$pagesources{$p};
535 my $type=pagetype($file);
537 $itemtemplate->param(content => $pcontent);
540 my $size=(srcfile_stat($file))[8];
542 eval q{use File::MimeInfo};
544 $mime = mimetype($file);
546 $itemtemplate->param(
554 $itemtemplate->param(content => $pcontent);
557 run_hooks(pagetemplate => sub {
558 shift->(page => $p, destpage => $page,
559 template => $itemtemplate);
562 $content.=$itemtemplate->output;
563 $itemtemplate->clear_params;
565 $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
568 my $template=template($feedtype."page.tmpl", blind_cache => 1);
570 title => $page ne "index" ? pagetitle($page) : $config{wikiname},
571 wikiname => $config{wikiname},
574 feeddesc => $feeddesc,
576 feeddate => date_3339($lasttime),
578 version => $IkiWiki::version,
580 run_hooks(pagetemplate => sub {
581 shift->(page => $page, destpage => $page,
582 template => $template);
585 return $template->output;
589 return unless @{$config{pingurl}} && %toping;
591 eval q{require RPC::XML::Client};
593 debug(gettext("RPC::XML::Client not found, not pinging"));
597 # daemonize here so slow pings don't slow down wiki updates
598 defined(my $pid = fork) or error("Can't fork: $!");
601 POSIX::setsid() or error("Can't start a new session: $!");
602 open STDIN, '/dev/null';
603 open STDOUT, '>/dev/null';
604 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
606 # Don't need to keep a lock on the wiki as a daemon.
607 IkiWiki::unlockwiki();
609 foreach my $page (keys %toping) {
610 my $title=pagetitle(basename($page), 0);
611 my $url=urlto($page, "", 1);
612 foreach my $pingurl (@{$config{pingurl}}) {
613 debug("Pinging $pingurl for $page");
615 my $client = RPC::XML::Client->new($pingurl);
616 my $req = RPC::XML::request->new('weblogUpdates.ping',
618 my $res = $client->send_request($req);
620 error("Did not receive response to ping");
623 if (! exists $r->{flerror} || $r->{flerror}) {
624 error("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
628 error "Ping failed: $@";
633 exit 0; # daemon done