]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/inline.pm
* Avoid a race in the git rcs_commit function, by not assuming HEAD will
[git.ikiwiki.info.git] / IkiWiki / Plugin / inline.pm
index ad8b718f3d6062355c9189ff66862facdafd6bd0..bb160ac4de949058cc62be656686058d717bb71b 100644 (file)
@@ -4,11 +4,17 @@ 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;
+
 sub import { #{{{
+       hook(type => "getopt", id => "inline", call => \&getopt);
+       hook(type => "checkconfig", id => "inline", call => \&checkconfig);
+       hook(type => "sessioncgi", id => "skeleton", call => \&sessioncgi);
        hook(type => "preprocess", id => "inline", 
                call => \&IkiWiki::preprocess_inline);
        hook(type => "pagetemplate", id => "inline",
@@ -18,8 +24,53 @@ sub import { #{{{
        # pings interrupting page builds.
        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$/;
+       }
+} #}}}
+
+sub sessioncgi () { #{{{
+       my $q=shift;
+       my $session=shift;
+
+       if ($q->param('do') eq 'blog') {
+               my $page=decode_utf8($q->param('title'));
+               $page=~s/\///g; # no slashes in blog posts
+               # if the page already exists, munge it to be unique
+               my $from=$q->param('from');
+               my $add="";
+               while (exists $IkiWiki::pagecase{lc($from."/".IkiWiki::titlepage($page).$add)}) {
+                       $add=1 unless length $add;
+                       $add++;
+               }
+               $q->param('page', $page.$add);
+               # now go create the page
+               $q->param('do', 'create');
+               IkiWiki::cgi_editpage($q, $session);
+               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;
@@ -42,7 +93,10 @@ sub preprocess_inline (@) { #{{{
        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 $feeds=exists $params{feeds} ? yesno($params{feeds}) : 1;
+       my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
+       my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick;
+       $feeds=0 if $params{preview};
+       my $feedonly=yesno($params{feedonly});
        if (! exists $params{show} && ! $archive) {
                $params{show}=10;
        }
@@ -53,11 +107,17 @@ sub preprocess_inline (@) { #{{{
                $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;
                }
        }
@@ -65,11 +125,18 @@ sub preprocess_inline (@) { #{{{
        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 "unknown sort type $params{sort}";
+               return sprintf(gettext("unknown sort type %s"), $params{sort});
+       }
+
+       if (yesno($params{reverse})) {
+               @list=reverse(@list);
        }
 
        if (exists $params{skip}) {
@@ -81,18 +148,48 @@ sub preprocess_inline (@) { #{{{
        }
 
        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 $feednum="";
 
-       my $rssurl=rsspage(basename($params{page}));
-       my $atomurl=atompage(basename($params{page}));
+       my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
+       if (exists $knownfeeds{$feedid}) {
+               $feednum=$knownfeeds{$feedid};
+       }
+       else {
+               if (exists $page_numfeeds{$params{destpage}}) {
+                       $feednum=$knownfeeds{$feedid}=++$page_numfeeds{$params{destpage}};
+               }
+               else {
+                       $feednum=$knownfeeds{$feedid}="";
+                       $page_numfeeds{$params{destpage}}=1;
+               }
+       }
+
+       my $rssurl=basename(rsspage($params{destpage}).$feednum);
+       my $atomurl=basename(atompage($params{destpage}).$feednum);
        my $ret="";
 
-       if (exists $params{rootpage} && $config{cgiurl}) {
+       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});
+               $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 ($feeds) {
@@ -103,78 +200,96 @@ 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) {
+                       return 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)) {
-                       # Get the content before populating the template,
-                       # since getting the content uses the same template
-                       # if inlines are nested.
-                       # TODO: if $archive=1, the only reason to do this
-                       # is to let the meta plugin get page title info; so stop
-                       # calling this next line then once the meta plugin can
-                       # store that accross runs (also tags plugin).
-                       my $content=get_inline_content($page, $params{destpage});
-                       # 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(content => $content);
-                       $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, $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}));
+       
+                               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 => pagetitle($page, 1)));
+                                       }
                                }
+       
+                               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{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
-       }
-       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{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
+       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{destpage}).$feednum;
+                       will_render($params{destpage}, $rssp);
+                       writefile($rssp, $config{destdir},
+                               genfeed("rss", $rssurl, $desc, $params{destpage}, @list));
+                       $toping{$params{destpage}}=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{destpage}).$feednum;
+                       will_render($params{destpage}, $atomp);
+                       writefile($atomp, $config{destdir},
+                               genfeed("atom", $atomurl, $desc, $params{destpage}, @list));
+                       $toping{$params{destpage}}=1 unless $config{rebuild};
+                       $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
+               }
        }
        
        return $ret;
@@ -199,7 +314,7 @@ sub get_inline_content ($$) { #{{{
                return htmlize($page, $type,
                       linkify($page, $destpage,
                       preprocess($page, $destpage,
-                      filter($page,
+                      filter($page, $destpage,
                       readfile(srcfile($file))))));
        }
        else {
@@ -210,8 +325,7 @@ sub get_inline_content ($$) { #{{{
 sub date_822 ($) { #{{{
        my $time=shift;
 
-       eval q{use POSIX};
-       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);
@@ -221,10 +335,9 @@ sub date_822 ($) { #{{{
 sub date_3339 ($) { #{{{
        my $time=shift;
 
-       eval q{use POSIX};
-       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;
 } #}}}
@@ -232,25 +345,23 @@ sub date_3339 ($) { #{{{
 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)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
+       $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/mig;
+       $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/mig;
        return $content;
 } #}}}
 
 sub rsspage ($) { #{{{
-       my $page=shift;
-
-       return $page.".rss";
+       return targetpage(shift, "rss");
 } #}}}
 
 sub atompage ($) { #{{{
-       my $page=shift;
-
-       return $page.".atom";
+       return targetpage(shift, "atom");
 } #}}}
 
 sub genfeed ($$$$@) { #{{{
@@ -260,23 +371,25 @@ sub genfeed ($$$$@) { #{{{
        my $page=shift;
        my @pages=@_;
        
-       my $url=URI->new(encode_utf8($config{url}."/".htmlpage($page)));
+       my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
        
        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($config{url}."/".urlto($p, "")));
+               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 ($itemtemplate->query(name => "enclosure")) {
                        my $file=$pagesources{$p};
                        my $type=pagetype($file);
@@ -309,7 +422,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);
@@ -332,25 +445,35 @@ sub genfeed ($$$$@) { #{{{
 } #}}}
 
 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;
        }
 
-       # TODO: daemonize here so slow pings don't slow down wiki updates
+       # 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}}) {
                        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");
@@ -365,6 +488,8 @@ sub pingurl (@) { #{{{
                        }
                }
        }
+
+       exit 0; # daemon done
 } #}}}
 
 1