X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/2794d7ef5abc4fa8fc2eb42d5c85ada197df0767..8a6a0673339c00480d49513eb0e3db83a9c7ce9c:/IkiWiki/Plugin/inline.pm?ds=inline

diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
index d8f2ca0d8..e23f7b903 100644
--- a/IkiWiki/Plugin/inline.pm
+++ b/IkiWiki/Plugin/inline.pm
@@ -4,121 +4,258 @@ package IkiWiki::Plugin::inline;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 2.00;
+use URI;
 
 sub import { #{{{
-	IkiWiki::hook(type => "preprocess", id => "inline", 
+	hook(type => "getopt", id => "inline", call => \&getopt);
+	hook(type => "checkconfig", id => "inline", call => \&checkconfig);
+	hook(type => "preprocess", id => "inline", 
 		call => \&IkiWiki::preprocess_inline);
+	hook(type => "pagetemplate", id => "inline",
+		call => \&IkiWiki::pagetemplate_inline);
 	# Hook to change to do pinging since it's called late.
 	# This ensures each page only pings once and prevents slow
 	# pings interrupting page builds.
-	IkiWiki::hook(type => "change", id => "inline", 
+	hook(type => "change", id => "inline", 
 		call => \&IkiWiki::pingurl);
 } # }}}
 
+sub getopt () { #{{{
+	eval q{use Getopt::Long};
+	error($@) if $@;
+	Getopt::Long::Configure('pass_through');
+	GetOptions(
+		"rss!" => \$config{rss},
+		"atom!" => \$config{atom},
+	);
+}
+
+sub checkconfig () { #{{{
+	if (($config{rss} || $config{atom}) && ! length $config{url}) {
+		error(gettext("Must specify url to wiki with --url when using --rss or --atom"));
+	}
+	if ($config{rss}) {
+		push @{$config{wiki_file_prune_regexps}}, qr/\.rss$/;
+	}
+	if ($config{atom}) {
+		push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
+	}
+} #}}}
+
 # Back to ikiwiki namespace for the rest, this code is very much
 # internal to ikiwiki even though it's separated into a plugin.
 package IkiWiki;
 
 my %toping;
-my $processing_inline=0;
+my %feedlinks;
+
+sub yesno ($) { #{{{
+	my $val=shift;
+	return (defined $val && lc($val) eq "yes");
+} #}}}
 
 sub preprocess_inline (@) { #{{{
 	my %params=@_;
-
+	
 	if (! exists $params{pages}) {
 		return "";
 	}
-	if (! exists $params{archive}) {
-		$params{archive}="no";
-	}
-	if (! exists $params{show} && $params{archive} eq "no") {
+	my $raw=yesno($params{raw});
+	my $archive=yesno($params{archive});
+	my $rss=($config{rss} && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
+	my $atom=($config{atom} && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
+	my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
+	my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick;
+	$feeds=0 if $params{preview};
+	if (! exists $params{show} && ! $archive) {
 		$params{show}=10;
 	}
-	if (! exists $params{rss}) {
-		$params{rss}="yes";
+	my $desc;
+	if (exists $params{description}) {
+		$desc = $params{description} 
+	} else {
+		$desc = $config{wikiname};
 	}
-
-	# Avoid nested inlines, to avoid loops etc.
-	if ($processing_inline) {
-		return "";
+	my $actions=yesno($params{actions});
+	if (exists $params{template}) {
+		$params{template}=~s/[^-_a-zA-Z0-9]+//g;
+	}
+	else {
+		$params{template} = $archive ? "archivepage" : "inlinepage";
 	}
-	$processing_inline=1;
 
 	my @list;
 	foreach my $page (keys %pagesources) {
 		next if $page eq $params{page};
-		if (pagespec_match($page, $params{pages})) {
+		if (pagespec_match($page, $params{pages}, location => $params{page})) {
 			push @list, $page;
 		}
 	}
-	@list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
+
+	if (exists $params{sort} && $params{sort} eq 'title') {
+		@list=sort @list;
+	}
+	elsif (exists $params{sort} && $params{sort} eq 'mtime') {
+		@list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
+	}
+	elsif (! exists $params{sort} || $params{sort} eq 'age') {
+		@list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
+	}
+	else {
+		return sprintf(gettext("unknown sort type %s"), $params{sort});
+	}
+
+	if (yesno($params{reverse})) {
+		@list=reverse(@list);
+	}
+
+	if (exists $params{skip}) {
+		@list=@list[$params{skip} .. scalar @list - 1];
+	}
+	
 	if ($params{show} && @list > $params{show}) {
 		@list=@list[0..$params{show} - 1];
 	}
 
 	add_depends($params{page}, $params{pages});
+	# Explicitly add all currently displayed pages as dependencies, so
+	# that if they are removed or otherwise changed, the inline will be
+	# sure to be updated.
+	add_depends($params{page}, join(" or ", @list));
 
+	my $rssurl=basename(rsspage($params{page}));
+	my $atomurl=basename(atompage($params{page}));
 	my $ret="";
-	
-	if (exists $params{rootpage} && $config{cgiurl}) {
-		# Add a blog post form, with a rss link button.
+
+	if ($config{cgiurl} && (exists $params{rootpage} ||
+			(exists $params{postform} && yesno($params{postform})))) {
+		# Add a blog post form, with feed buttons.
 		my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
 		$formtemplate->param(cgiurl => $config{cgiurl});
-		$formtemplate->param(rootpage => $params{rootpage});
-		if ($config{rss}) {
-			$formtemplate->param(rssurl => rsspage(basename($params{page})));
+		$formtemplate->param(rootpage => 
+			exists $params{rootpage} ? $params{rootpage} : $params{page});
+		$formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
+		$formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
+		if (exists $params{postformtext}) {
+			$formtemplate->param(postformtext =>
+				$params{postformtext});
+		}
+		else {
+			$formtemplate->param(postformtext =>
+				gettext("Add a new post titled:"));
 		}
 		$ret.=$formtemplate->output;
 	}
-	elsif ($config{rss} && $params{rss} eq "yes") {
-		# Add a rss link button.
-		my $linktemplate=template("rsslink.tmpl", blind_cache => 1);
-		$linktemplate->param(rssurl => rsspage(basename($params{page})));
+	elsif ($feeds) {
+		# Add feed buttons.
+		my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
+		$linktemplate->param(rssurl => $rssurl) if $rss;
+		$linktemplate->param(atomurl => $atomurl) if $atom;
 		$ret.=$linktemplate->output;
 	}
 	
-	my $template=template(
-		(($params{archive} eq "no")
-			? "inlinepage.tmpl"
-			: "inlinepagetitle.tmpl"),
-		blind_cache => 1,
-	);
+	my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
+	if (! @params) {
+		return sprintf(gettext("nonexistant template %s"), $params{template});
+	}
+	my $template=HTML::Template->new(@params) unless $raw;
 	
 	foreach my $page (@list) {
-		# Don't use htmllink because this way the title is separate
-		# and can be overridden by other plugins.
-		my $link=htmlpage(bestlink($params{page}, $page));
-		$link=abs2rel($link, dirname($params{page}));
-		$template->param(pageurl => $link);
-		$template->param(title => pagetitle(basename($page)));
-		$template->param(content => get_inline_content($page, $params{page}))
-			if $params{archive} eq "no";
-		$template->param(ctime => displaytime($pagectime{$page}));
+		my $file = $pagesources{$page};
+		my $type = pagetype($file);
+		if (! $raw || ($raw && ! defined $type)) {
+			unless ($archive && $quick) {
+				# Get the content before populating the
+				# template, since getting the content uses
+				# the same template if inlines are nested.
+				my $content=get_inline_content($page, $params{destpage});
+				$template->param(content => $content);
+			}
+			$template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
+			$template->param(title => pagetitle(basename($page)));
+			$template->param(ctime => displaytime($pagectime{$page}));
 
-		run_hooks(pagetemplate => sub {
-			shift->(page => $page, destpage => $params{page},
-				template => $template,);
-		});
+			if ($actions) {
+				my $file = $pagesources{$page};
+				my $type = pagetype($file);
+				if ($config{discussion}) {
+					my $discussionlink=gettext("discussion");
+					if ($page !~ /.*\/\Q$discussionlink\E$/ &&
+					    (length $config{cgiurl} ||
+					     exists $links{$page."/".$discussionlink})) {
+						$template->param(have_actions => 1);
+						$template->param(discussionlink =>
+							htmllink($page,
+								$params{page},
+								gettext("Discussion"),
+								noimageinline => 1,
+								forcesubpage => 1));
+					}
+				}
+				if (length $config{cgiurl} && defined $type) {
+					$template->param(have_actions => 1);
+					$template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
+				}
+			}
 
-		$ret.=$template->output;
-		$template->clear_params;
+			run_hooks(pagetemplate => sub {
+				shift->(page => $page, destpage => $params{page},
+					template => $template,);
+			});
+
+			$ret.=$template->output;
+			$template->clear_params;
+		}
+		else {
+			if (defined $type) {
+				$ret.="\n".
+				      linkify($page, $params{page},
+				      preprocess($page, $params{page},
+				      filter($page, $params{page},
+				      readfile(srcfile($file)))));
+			}
+		}
 	}
 	
-	# TODO: should really add this to renderedfiles and call
-	# check_overwrite, but currently renderedfiles
-	# only supports listing one file per page.
-	if ($config{rss} && $params{rss} eq "yes") {
-		writefile(rsspage($params{page}), $config{destdir},
-			genrss($params{page}, @list));
-		$toping{$params{page}}=1 unless $config{rebuild};
+	if ($feeds) {
+		if (exists $params{feedshow} && @list > $params{feedshow}) {
+			@list=@list[0..$params{feedshow} - 1];
+		}
+		if (exists $params{feedpages}) {
+			@list=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @list;
+		}
+	
+		if ($rss) {
+			my $rssp=rsspage($params{page});
+			will_render($params{page}, $rssp);
+			writefile($rssp, $config{destdir},
+				genfeed("rss", $rssurl, $desc, $params{page}, @list));
+			$toping{$params{page}}=1 unless $config{rebuild};
+			$feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
+		}
+		if ($atom) {
+			my $atomp=atompage($params{page});
+			will_render($params{page}, $atomp);
+			writefile($atomp, $config{destdir},
+				genfeed("atom", $atomurl, $desc, $params{page}, @list));
+			$toping{$params{page}}=1 unless $config{rebuild};
+			$feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
+		}
 	}
 	
-	$processing_inline=0;
-
 	return $ret;
 } #}}}
 
+sub pagetemplate_inline (@) { #{{{
+	my %params=@_;
+	my $page=$params{page};
+	my $template=$params{template};
+
+	$template->param(feedlinks => $feedlinks{$page})
+		if exists $feedlinks{$page} && $template->query(name => "feedlinks");
+} #}}}
+
 sub get_inline_content ($$) { #{{{
 	my $page=shift;
 	my $destpage=shift;
@@ -126,7 +263,11 @@ sub get_inline_content ($$) { #{{{
 	my $file=$pagesources{$page};
 	my $type=pagetype($file);
 	if (defined $type) {
-		return htmlize($type, preprocess($page, $destpage, linkify($page, $destpage, readfile(srcfile($file)))));
+		return htmlize($page, $type,
+		       linkify($page, $destpage,
+		       preprocess($page, $destpage,
+		       filter($page, $destpage,
+		       readfile(srcfile($file))))));
 	}
 	else {
 		return "";
@@ -136,62 +277,115 @@ sub get_inline_content ($$) { #{{{
 sub date_822 ($) { #{{{
 	my $time=shift;
 
-	eval q{use POSIX};
-	return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
+	my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
+	POSIX::setlocale(&POSIX::LC_TIME, "C");
+	my $ret=POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
+	POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
+	return $ret;
+} #}}}
+
+sub date_3339 ($) { #{{{
+	my $time=shift;
+
+	my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
+	POSIX::setlocale(&POSIX::LC_TIME, "C");
+	my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", localtime($time));
+	POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
+	return $ret;
 } #}}}
 
 sub absolute_urls ($$) { #{{{
 	# sucky sub because rss sucks
 	my $content=shift;
-	my $url=shift;
+	my $baseurl=shift;
 
+	my $url=$baseurl;
 	$url=~s/[^\/]+$//;
 	
-	$content=~s/<a\s+href="(?![^:]+:\/\/)([^"]+)"/<a href="$url$1"/ig;
-	$content=~s/<img\s+src="(?![^:]+:\/\/)([^"]+)"/<img src="$url$1"/ig;
+	$content=~s/(<a(?:\s+(?:class|id)="?\w+"?)?)\s+href="(#[^"]+)"/$1 href="$baseurl$2"/ig;
+	$content=~s/(<a(?:\s+(?:class|id)="?\w+"?)?)\s+href="(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/ig;
+	$content=~s/(<img(?:\s+(?:class|id)="?\w+"?)?)\s+src="(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/ig;
 	return $content;
 } #}}}
 
 sub rsspage ($) { #{{{
-	my $page=shift;
+	return targetpage(shift, "rss");
+} #}}}
 
-	return $page.".rss";
+sub atompage ($) { #{{{
+	return targetpage(shift, "atom");
 } #}}}
 
-sub genrss ($@) { #{{{
+sub genfeed ($$$$@) { #{{{
+	my $feedtype=shift;
+	my $feedurl=shift;
+	my $feeddesc=shift;
 	my $page=shift;
 	my @pages=@_;
 	
-	my $url="$config{url}/".htmlpage($page);
+	my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
 	
-	my $itemtemplate=template("rssitem.tmpl", blind_cache => 1, 
-		die_on_bad_params => 0);
+	my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
 	my $content="";
+	my $lasttime = 0;
 	foreach my $p (@pages) {
-		next unless exists $renderedfiles{$p};
+		my $u=URI->new(encode_utf8($config{url}."/".urlto($p, "")));
+		my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
 
 		$itemtemplate->param(
 			title => pagetitle(basename($p)),
-			url => "$config{url}/$renderedfiles{$p}",
-			pubdate => date_822($pagectime{$p}),
-			content => absolute_urls(get_inline_content($p, $page), $url),
+			url => $u,
+			permalink => $u,
+			date_822 => date_822($pagectime{$p}),
+			date_3339 => date_3339($pagectime{$p}),
 		);
+
+		if ($itemtemplate->query(name => "enclosure")) {
+			my $file=$pagesources{$p};
+			my $type=pagetype($file);
+			if (defined $type) {
+				$itemtemplate->param(content => $pcontent);
+			}
+			else {
+				my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
+				my $mime="unknown";
+				eval q{use File::MimeInfo};
+				if (! $@) {
+					$mime = mimetype($file);
+				}
+				$itemtemplate->param(
+					enclosure => $u,
+					type => $mime,
+					length => $size,
+				);
+			}
+		}
+		else {
+			$itemtemplate->param(content => $pcontent);
+		}
+
 		run_hooks(pagetemplate => sub {
 			shift->(page => $p, destpage => $page,
 				template => $itemtemplate);
 		});
+
 		$content.=$itemtemplate->output;
 		$itemtemplate->clear_params;
+
+		$lasttime = $pagectime{$p} if $pagectime{$p} > $lasttime;
 	}
 
-	my $template=template("rsspage.tmpl", blind_cache => 1);
+	my $template=template($feedtype."page.tmpl", blind_cache => 1);
 	$template->param(
-		title => $config{wikiname},
+		title => $page ne "index" ? pagetitle($page) : $config{wikiname},
 		wikiname => $config{wikiname},
 		pageurl => $url,
 		content => $content,
+		feeddesc => $feeddesc,
+		feeddate => date_3339($lasttime),
+		feedurl => $feedurl,
+		version => $IkiWiki::version,
 	);
-	
 	run_hooks(pagetemplate => sub {
 		shift->(page => $page, destpage => $page,
 			template => $template);
@@ -201,32 +395,51 @@ sub genrss ($@) { #{{{
 } #}}}
 
 sub pingurl (@) { #{{{
-	return unless $config{pingurl} && %toping;
+	return unless @{$config{pingurl}} && %toping;
 
 	eval q{require RPC::XML::Client};
 	if ($@) {
-		debug("RPC::XML::Client not found, not pinging");
+		debug(gettext("RPC::XML::Client not found, not pinging"));
 		return;
 	}
 
+	# daemonize here so slow pings don't slow down wiki updates
+	defined(my $pid = fork) or error("Can't fork: $!");
+	return if $pid;
+	chdir '/';
+	setsid() or error("Can't start a new session: $!");
+	open STDIN, '/dev/null';
+	open STDOUT, '>/dev/null';
+	open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
+
+	# Don't need to keep a lock on the wiki as a daemon.
+	IkiWiki::unlockwiki();
+
 	foreach my $page (keys %toping) {
-		my $title=pagetitle(basename($page));
-		my $url="$config{url}/".htmlpage($page);
+		my $title=pagetitle(basename($page), 0);
+		my $url="$config{url}/".urlto($page, "");
 		foreach my $pingurl (@{$config{pingurl}}) {
-			my $client = RPC::XML::Client->new($pingurl);
-			my $req = RPC::XML::request->new('weblogUpdates.ping',
-				$title, $url);
 			debug("Pinging $pingurl for $page");
-			my $res = $client->send_request($req);
-			if (! ref $res) {
-				debug("Did not receive response to ping");
-			}
-			my $r=$res->value;
-			if (! exists $r->{flerror} || $r->{flerror}) {
-				debug("Ping rejected: ".$r->{message});
+			eval {
+				my $client = RPC::XML::Client->new($pingurl);
+				my $req = RPC::XML::request->new('weblogUpdates.ping',
+					$title, $url);
+				my $res = $client->send_request($req);
+				if (! ref $res) {
+					debug("Did not receive response to ping");
+				}
+				my $r=$res->value;
+				if (! exists $r->{flerror} || $r->{flerror}) {
+					debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
+				}
+			};
+			if ($@) {
+				debug "Ping failed: $@";
 			}
 		}
 	}
+
+	exit 0; # daemon done
 } #}}}
 
 1