X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/50c7f7ab04bbc1e28eecb4cc6253c117718d5e07..3d8d47d7858ae0e043a28f348fe8aec444d0d35a:/IkiWiki/Plugin/inline.pm?ds=inline
diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
index fd7a59ab3..7fe5a4dcf 100644
--- a/IkiWiki/Plugin/inline.pm
+++ b/IkiWiki/Plugin/inline.pm
@@ -4,15 +4,25 @@ package IkiWiki::Plugin::inline;
use warnings;
use strict;
-use IkiWiki 1.00;
-use IkiWiki::Render; # for displaytime
+use Encode;
+use IkiWiki 2.00;
use URI;
+my %knownfeeds;
+my %page_numfeeds;
+my @inline;
+my $nested=0;
+
sub import { #{{{
+ hook(type => "getopt", id => "inline", call => \&getopt);
+ hook(type => "getsetup", id => "inline", call => \&getsetup);
+ hook(type => "checkconfig", id => "inline", call => \&checkconfig);
+ hook(type => "sessioncgi", id => "inline", call => \&sessioncgi);
hook(type => "preprocess", id => "inline",
call => \&IkiWiki::preprocess_inline);
hook(type => "pagetemplate", id => "inline",
call => \&IkiWiki::pagetemplate_inline);
+ hook(type => "format", id => "inline", call => \&format);
# 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.
@@ -20,6 +30,118 @@ sub import { #{{{
call => \&IkiWiki::pingurl);
} # }}}
+sub getopt () { #{{{
+ eval q{use Getopt::Long};
+ error($@) if $@;
+ Getopt::Long::Configure('pass_through');
+ GetOptions(
+ "rss!" => \$config{rss},
+ "atom!" => \$config{atom},
+ "allowrss!" => \$config{allowrss},
+ "allowatom!" => \$config{allowatom},
+ "pingurl=s" => sub {
+ push @{$config{pingurl}}, $_[1];
+ },
+ );
+} #}}}
+
+sub getsetup () { #{{{
+ return
+ plugin => {
+ safe => 1,
+ rebuild => undef,
+ },
+ rss => {
+ type => "boolean",
+ example => 0,
+ description => "enable rss feeds by default?",
+ safe => 1,
+ rebuild => 1,
+ },
+ atom => {
+ type => "boolean",
+ example => 0,
+ description => "enable atom feeds by default?",
+ safe => 1,
+ rebuild => 1,
+ },
+ allowrss => {
+ type => "boolean",
+ example => 0,
+ description => "allow rss feeds to be used?",
+ safe => 1,
+ rebuild => 1,
+ },
+ allowatom => {
+ type => "boolean",
+ example => 0,
+ description => "allow atom feeds to be used?",
+ safe => 1,
+ rebuild => 1,
+ },
+ pingurl => {
+ type => "string",
+ example => "http://rpc.technorati.com/rpc/ping",
+ description => "urls to ping (using XML-RPC) on feed update",
+ safe => 1,
+ rebuild => 0,
+ },
+} #}}}
+
+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$/;
+ }
+ if (! exists $config{pingurl}) {
+ $config{pingurl}=[];
+ }
+} #}}}
+
+sub format (@) { #{{{
+ my %params=@_;
+
+ # Fill in the inline content generated earlier. This is actually an
+ # optimisation.
+ $params{content}=~s{}{
+ delete @inline[$1,]
+ }eg;
+ return $params{content};
+} #}}}
+
+sub sessioncgi ($$) { #{{{
+ my $q=shift;
+ my $session=shift;
+
+ if ($q->param('do') eq 'blog') {
+ my $page=titlepage(decode_utf8($q->param('title')));
+ $page=~s/(\/)/"__".ord($1)."__"/eg; # don't create subdirs
+ # if the page already exists, munge it to be unique
+ my $from=$q->param('from');
+ my $add="";
+ while (exists $IkiWiki::pagecase{lc($from."/".$page.$add)}) {
+ $add=1 unless length $add;
+ $add++;
+ }
+ $q->param('page', $page.$add);
+ # now go create the page
+ $q->param('do', 'create');
+ # make sure the editpage plugin in loaded
+ if (IkiWiki->can("cgi_editpage")) {
+ IkiWiki::cgi_editpage($q, $session);
+ }
+ else {
+ error(gettext("page editing not allowed"));
+ }
+ exit;
+ }
+}
+
# 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;
@@ -27,76 +149,144 @@ package IkiWiki;
my %toping;
my %feedlinks;
-sub yesno ($) { #{{{
- my $val=shift;
- return (defined $val && lc($val) eq "yes");
-} #}}}
-
sub preprocess_inline (@) { #{{{
my %params=@_;
if (! exists $params{pages}) {
- return "";
+ error gettext("missing pages parameter");
}
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 $rss=(($config{rss} || $config{allowrss}) && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
+ my $atom=(($config{atom} || $config{allowatom}) && 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;
+ my $feedonly=yesno($params{feedonly});
if (! exists $params{show} && ! $archive) {
$params{show}=10;
}
+ if (! exists $params{feedshow} && exists $params{show}) {
+ $params{feedshow}=$params{show};
+ }
my $desc;
if (exists $params{description}) {
$desc = $params{description}
- } else {
+ }
+ else {
$desc = $config{wikiname};
}
my $actions=yesno($params{actions});
+ if (exists $params{template}) {
+ $params{template}=~s/[^-_a-zA-Z0-9]+//g;
+ }
+ else {
+ $params{template} = $archive ? "archivepage" : "inlinepage";
+ }
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;
}
}
if (exists $params{sort} && $params{sort} eq 'title') {
- @list=sort @list;
+ @list=sort { pagetitle(basename($a)) cmp pagetitle(basename($b)) } @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 "unknown sort type $params{sort}";
+ error 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];
}
+ my @feedlist;
+ if ($feeds) {
+ if (exists $params{feedshow} &&
+ $params{feedshow} && @list > $params{feedshow}) {
+ @feedlist=@list[0..$params{feedshow} - 1];
+ }
+ else {
+ @feedlist=@list;
+ }
+ }
+
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 >= $#feedlist ? @list : @feedlist));
- my $rssurl=rsspage(basename($params{page}));
- my $atomurl=atompage(basename($params{page}));
+ my $feednum="";
+
+ my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
+ if (exists $knownfeeds{$feedid}) {
+ $feednum=$knownfeeds{$feedid};
+ }
+ else {
+ if (exists $page_numfeeds{$params{destpage}}) {
+ if ($feeds) {
+ $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}};
+ }
+ }
+ else {
+ $feednum=$knownfeeds{$feedid}="";
+ if ($feeds) {
+ $page_numfeeds{$params{destpage}}=1;
+ }
+ }
+ }
+
+ my $rssurl=basename(rsspage($params{destpage}).$feednum) if $feeds && $rss;
+ my $atomurl=basename(atompage($params{destpage}).$feednum) if $feeds && $atom;
my $ret="";
- if (exists $params{rootpage} && $config{cgiurl}) {
+ if (length $config{cgiurl} && ! $params{preview} && (exists $params{rootpage} ||
+ (exists $params{postform} && yesno($params{postform}))) &&
+ IkiWiki->can("cgi_editpage")) {
# 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});
+ my $rootpage;
+ if (exists $params{rootpage}) {
+ $rootpage=bestlink($params{page}, $params{rootpage});
+ if (!length $rootpage) {
+ $rootpage=$params{rootpage};
+ }
+ }
+ else {
+ $rootpage=$params{page};
+ }
+ $formtemplate->param(rootpage => $rootpage);
$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 ($feeds) {
+ elsif ($feeds && !$params{preview}) {
# Add feed buttons.
my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
$linktemplate->param(rssurl => $rssurl) if $rss;
@@ -104,80 +294,106 @@ sub preprocess_inline (@) { #{{{
$ret.=$linktemplate->output;
}
- my $template=template(
- ($archive ? "inlinepagetitle.tmpl" : "inlinepage.tmpl"),
- blind_cache => 1,
- ) unless $raw;
+ if (! $feedonly) {
+ require HTML::Template;
+ my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
+ if (! @params) {
+ error sprintf(gettext("nonexistant template %s"), $params{template});
+ }
+ my $template=HTML::Template->new(@params) unless $raw;
- foreach my $page (@list) {
- 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);
- }
- # Don't use htmllink because this way the
- # title is separate and can be overridden by
- # other plugins.
- my $link=bestlink($params{page}, $page);
- $link=htmlpage($link) if defined $type;
- $link=abs2rel($link, dirname($params{destpage}));
- $template->param(pageurl => $link);
- $template->param(title => pagetitle(basename($page)));
- $template->param(ctime => displaytime($pagectime{$page}));
-
- if ($actions) {
- my $file = $pagesources{$page};
- my $type = pagetype($file);
- if ($config{discussion}) {
- $template->param(have_actions => 1);
- $template->param(discussionlink => htmllink($page, $params{page}, "Discussion", 1, 1));
+ foreach my $page (@list) {
+ 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);
}
- if (length $config{cgiurl} && defined $type) {
- $template->param(have_actions => 1);
- $template->param(editurl => cgiurl(do => "edit", page => $page));
+ $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
+ $template->param(title => pagetitle(basename($page)));
+ $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
+ $template->param(mtime => displaytime($pagemtime{$page}, $params{timeformat}));
+ $template->param(first => 1) if $page eq $list[0];
+ $template->param(last => 1) if $page eq $list[$#list];
+
+ 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{destpage},
+ gettext("Discussion"),
+ noimageinline => 1,
+ forcesubpage => 1));
+ }
+ }
+ if (length $config{cgiurl} && defined $type) {
+ $template->param(have_actions => 1);
+ $template->param(editurl => cgiurl(do => "edit", page => $page));
+ }
}
+
+ run_hooks(pagetemplate => sub {
+ shift->(page => $page, destpage => $params{destpage},
+ template => $template,);
+ });
+
+ $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,
- readfile(srcfile($file)))));
+ else {
+ if (defined $type) {
+ $ret.="\n".
+ linkify($page, $params{destpage},
+ preprocess($page, $params{destpage},
+ filter($page, $params{destpage},
+ readfile(srcfile($file)))));
+ }
}
}
}
- if ($feeds && $rss) {
- will_render($params{page}, rsspage($params{page}));
- writefile(rsspage($params{page}), $config{destdir},
- genfeed("rss", $rssurl, $desc, $params{page}, @list));
- $toping{$params{page}}=1 unless $config{rebuild};
- $feedlinks{$params{destpage}}=qq{};
- }
- if ($feeds && $atom) {
- will_render($params{page}, atompage($params{page}));
- writefile(atompage($params{page}), $config{destdir},
- genfeed("atom", $atomurl, $desc, $params{page}, @list));
- $toping{$params{page}}=1 unless $config{rebuild};
- $feedlinks{$params{destpage}}=qq{};
+ if ($feeds) {
+ if (exists $params{feedpages}) {
+ @feedlist=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @feedlist;
+ }
+
+ if ($rss) {
+ my $rssp=rsspage($params{destpage}).$feednum;
+ will_render($params{destpage}, $rssp);
+ if (! $params{preview}) {
+ writefile($rssp, $config{destdir},
+ genfeed("rss",
+ $config{url}."/".$rssp, $desc, $params{guid}, $params{destpage}, @feedlist));
+ $toping{$params{destpage}}=1 unless $config{rebuild};
+ $feedlinks{$params{destpage}}.=qq{};
+ }
+ }
+ if ($atom) {
+ my $atomp=atompage($params{destpage}).$feednum;
+ will_render($params{destpage}, $atomp);
+ if (! $params{preview}) {
+ writefile($atomp, $config{destdir},
+ genfeed("atom", $config{url}."/".$atomp, $desc, $params{guid}, $params{destpage}, @feedlist));
+ $toping{$params{destpage}}=1 unless $config{rebuild};
+ $feedlinks{$params{destpage}}.=qq{};
+ }
+ }
}
- return $ret;
+ return $ret if $raw || $nested;
+ push @inline, $ret;
+ return "\n\n";
} #}}}
sub pagetemplate_inline (@) { #{{{
@@ -196,11 +412,14 @@ sub get_inline_content ($$) { #{{{
my $file=$pagesources{$page};
my $type=pagetype($file);
if (defined $type) {
- return htmlize($page, $type,
+ $nested++;
+ my $ret=htmlize($page, $destpage, $type,
linkify($page, $destpage,
preprocess($page, $destpage,
- filter($page,
+ filter($page, $destpage,
readfile(srcfile($file))))));
+ $nested--;
+ return $ret;
}
else {
return "";
@@ -210,9 +429,7 @@ sub get_inline_content ($$) { #{{{
sub date_822 ($) { #{{{
my $time=shift;
- eval q{use POSIX};
- error($@) if $@;
- my $lc_time= POSIX::setlocale(&POSIX::LC_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);
@@ -222,11 +439,9 @@ sub date_822 ($) { #{{{
sub date_3339 ($) { #{{{
my $time=shift;
- eval q{use POSIX};
- error($@) if $@;
- my $lc_time= POSIX::setlocale(&POSIX::LC_TIME);
+ 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));
+ my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
return $ret;
} #}}}
@@ -238,49 +453,62 @@ sub absolute_urls ($$) { #{{{
my $url=$baseurl;
$url=~s/[^\/]+$//;
-
- $content=~s/(new($url);
+ $top_uri->path_query(""); # reset the path
+ my $urltop = $top_uri->as_string;
+
+ $content=~s/(new(encode_utf8($config{url}."/".htmlpage($page)));
+ my $url=URI->new(encode_utf8(urlto($page,"",1)));
my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
my $content="";
my $lasttime = 0;
foreach my $p (@pages) {
- my $u=URI->new(encode_utf8($config{url}."/".htmlpage($p)));
+ my $u=URI->new(encode_utf8(urlto($p, "", 1)));
+ my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
$itemtemplate->param(
title => pagetitle(basename($p)),
url => $u,
permalink => $u,
- date_822 => date_822($pagectime{$p}),
- date_3339 => date_3339($pagectime{$p}),
+ cdate_822 => date_822($pagectime{$p}),
+ mdate_822 => date_822($pagemtime{$p}),
+ cdate_3339 => date_3339($pagectime{$p}),
+ mdate_3339 => date_3339($pagemtime{$p}),
);
- my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
+ if (exists $pagestate{$p} &&
+ exists $pagestate{$p}{meta}{guid}) {
+ $itemtemplate->param(guid => $pagestate{$p}{meta}{guid});
+ }
+
if ($itemtemplate->query(name => "enclosure")) {
my $file=$pagesources{$p};
my $type=pagetype($file);
@@ -288,7 +516,7 @@ sub genfeed ($$$$@) { #{{{
$itemtemplate->param(content => $pcontent);
}
else {
- my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
+ my $size=(srcfile_stat($file))[8];
my $mime="unknown";
eval q{use File::MimeInfo};
if (! $@) {
@@ -313,7 +541,7 @@ sub genfeed ($$$$@) { #{{{
$content.=$itemtemplate->output;
$itemtemplate->clear_params;
- $lasttime = $pagectime{$p} if $pagectime{$p} > $lasttime;
+ $lasttime = $pagemtime{$p} if $pagemtime{$p} > $lasttime;
}
my $template=template($feedtype."page.tmpl", blind_cache => 1);
@@ -323,6 +551,7 @@ sub genfeed ($$$$@) { #{{{
pageurl => $url,
content => $content,
feeddesc => $feeddesc,
+ guid => $guid,
feeddate => date_3339($lasttime),
feedurl => $feedurl,
version => $IkiWiki::version,
@@ -340,7 +569,7 @@ sub pingurl (@) { #{{{
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;
}
@@ -348,35 +577,34 @@ sub pingurl (@) { #{{{
defined(my $pid = fork) or error("Can't fork: $!");
return if $pid;
chdir '/';
- eval q{use POSIX âsetsidâ};
- setsid() or error("Can't start a new session: $!");
+ POSIX::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: $!");
+ 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=urlto($page, "", 1);
foreach my $pingurl (@{$config{pingurl}}) {
debug("Pinging $pingurl for $page");
eval {
my $client = RPC::XML::Client->new($pingurl);
my $req = RPC::XML::request->new('weblogUpdates.ping',
- $title, $url);
+ $title, $url);
my $res = $client->send_request($req);
if (! ref $res) {
- debug("Did not receive response to ping");
+ error("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]"));
+ error("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
}
};
if ($@) {
- debug "Ping failed: $@";
+ error "Ping failed: $@";
}
}
}