added some comments for translators

[git.ikiwiki.info.git] / IkiWiki / Plugin / inline.pm

diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
index 935df9a7764cb451d37705b7e10b0f8b105156d5..ecae47f1afb63f1ad3d41b2556bd7cf2adae355b 100644 (file)
--- a/IkiWiki/Plugin/inline.pm
+++ b/IkiWiki/Plugin/inline.pm
@@ -4,47 +4,80 @@ package IkiWiki::Plugin::inline;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki;
+use IkiWiki 1.00;
+use IkiWiki::Render; # for displaytime

 use URI;
 
 sub import { #{{{
 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);
                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.
        # 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);
 } # }}}
 
                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;
 # 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=@_;
 
 sub preprocess_inline (@) { #{{{
        my %params=@_;

-
+       

        if (! exists $params{pages}) {
                return "";
        }
        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;
+       if (! exists $params{show} && ! $archive) {

                $params{show}=10;
        }
                $params{show}=10;
        }

-       if (! exists $params{rss}) {
-               $params{rss}="yes";
-       }
-
-       # Avoid nested inlines, to avoid loops etc.
-       if ($processing_inline) {
-               return "";
+       my $desc;
+       if (exists $params{description}) {
+               $desc = $params{description} 
+       } else {
+               $desc = $config{wikiname};

        }
        }

-       $processing_inline=1;
+       my $actions=yesno($params{actions});

 
        my @list;
        foreach my $page (keys %pagesources) {
 
        my @list;
        foreach my $page (keys %pagesources) {


@@ -53,76 +86,135 @@ sub preprocess_inline (@) { #{{{
                        push @list, $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 'age') {
+               @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
+       }
+       else {
+               return sprintf(gettext("unknown sort type %s"), $params{sort});
+       }
+
+       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});
 
        if ($params{show} && @list > $params{show}) {
                @list=@list[0..$params{show} - 1];
        }
 
        add_depends($params{page}, $params{pages});
 

+       my $rssurl=rsspage(basename($params{page}));
+       my $atomurl=atompage(basename($params{page}));

        my $ret="";
        my $ret="";

-       
+

        if (exists $params{rootpage} && $config{cgiurl}) {
        if (exists $params{rootpage} && $config{cgiurl}) {

-               # Add a blog post form, with a rss link button.
+               # 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 $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(rssurl => $rssurl) if $feeds && $rss;
+               $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;

                $ret.=$formtemplate->output;
        }
                $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(
                $ret.=$linktemplate->output;
        }
        
        my $template=template(

-               (($params{archive} eq "no")
-                       ? "inlinepage.tmpl"
-                       : "inlinepagetitle.tmpl"),
+               ($archive ? "inlinepagetitle.tmpl" : "inlinepage.tmpl"),

                blind_cache => 1,
                blind_cache => 1,

-       );
+       ) unless $raw;

        
        foreach my $page (@list) {
        
        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)));
-               # TODO: if $params{archive} eq "no", 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).
-               $template->param(content => get_inline_content($page, $params{page}));
-               $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);
+                       }
+                       # 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}));

 
 

-               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} &&
+                                   $page !~ /.*\/discussion$/ &&
+                                   (length $config{cgiurl} || exists $links{$page."/".gettext("discussion")})) {
+                                       $template->param(have_actions => 1);
+                                       $template->param(discussionlink => htmllink($page, $params{page}, "Discussion", 1, 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{page},
+                                       template => $template,);
+                       });

 
 

-               $ret.=$template->output;
-               $template->clear_params;
+                       $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)))));
+                       }
+               }

        }
        
        }
        

-       # 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") {
+       if ($feeds && $rss) {
+               will_render($params{page}, rsspage($params{page}));

                writefile(rsspage($params{page}), $config{destdir},
                writefile(rsspage($params{page}), $config{destdir},

-                       genrss($params{page}, @list));
+                       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};
                $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;
 } #}}}
 
        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;
 sub get_inline_content ($$) { #{{{
        my $page=shift;
        my $destpage=shift;


@@ -130,7 +222,11 @@ sub get_inline_content ($$) { #{{{
        my $file=$pagesources{$page};
        my $type=pagetype($file);
        if (defined $type) {
        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,
+                      readfile(srcfile($file))))));

        }
        else {
                return "";
        }
        else {
                return "";


@@ -141,6 +237,7 @@ sub date_822 ($) { #{{{
        my $time=shift;
 
        eval q{use POSIX};
        my $time=shift;
 
        eval q{use POSIX};

+       error($@) if $@;

        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));
        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));


@@ -148,15 +245,29 @@ sub date_822 ($) { #{{{
        return $ret;
 } #}}}
 
        return $ret;
 } #}}}
 

+sub date_3339 ($) { #{{{
+       my $time=shift;
+
+       eval q{use POSIX};
+       error($@) if $@;
+       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;
 sub absolute_urls ($$) { #{{{
        # sucky sub because rss sucks
        my $content=shift;

-       my $url=shift;
+       my $baseurl=shift;

 
 

+       my $url=$baseurl;

        $url=~s/[^\/]+$//;
        
        $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;
 } #}}}
 
        return $content;
 } #}}}
 


@@ -166,26 +277,61 @@ sub rsspage ($) { #{{{
        return $page.".rss";
 } #}}}
 
        return $page.".rss";
 } #}}}
 

-sub genrss ($@) { #{{{
+sub atompage ($) { #{{{
+       my $page=shift;
+
+       return $page.".atom";
+} #}}}
+
+sub genfeed ($$$$@) { #{{{
+       my $feedtype=shift;
+       my $feedurl=shift;
+       my $feeddesc=shift;

        my $page=shift;
        my @pages=@_;
        
        my $page=shift;
        my @pages=@_;
        

-       my $url=URI->new(encode_utf8("$config{url}/".htmlpage($page)));
+       my $url=URI->new(encode_utf8($config{url}."/".htmlpage($page)));

        
        

-       my $itemtemplate=template("rssitem.tmpl", blind_cache => 1);
+       my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);

        my $content="";
        my $content="";

+       my $lasttime = 0;

        foreach my $p (@pages) {
        foreach my $p (@pages) {

-               next unless exists $renderedfiles{$p};
-
-               my $u=URI->new(encode_utf8("$config{url}/$renderedfiles{$p}"));
+               my $u=URI->new(encode_utf8($config{url}."/".htmlpage($p)));
+               
+               my $pcontent = absolute_urls(get_inline_content($p, $page), $url);

 
                $itemtemplate->param(
 
                $itemtemplate->param(

-                       title => pagetitle(basename($p)),
+                       title => pagetitle(basename($p), 1),

                        url => $u,
                        permalink => $u,
                        url => $u,
                        permalink => $u,

-                       pubdate => date_822($pagectime{$p}),
-                       content => absolute_urls(get_inline_content($p, $page), $url),
+                       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);
                run_hooks(pagetemplate => sub {
                        shift->(page => $p, destpage => $page,
                                template => $itemtemplate);


@@ -193,14 +339,20 @@ sub genrss ($@) { #{{{
 
                $content.=$itemtemplate->output;
                $itemtemplate->clear_params;
 
                $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(
        $template->param(

-               title => $config{wikiname},
+               title => $page ne "index" ? pagetitle($page, 1) : $config{wikiname},

                wikiname => $config{wikiname},
                pageurl => $url,
                content => $content,
                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,
        );
        run_hooks(pagetemplate => sub {
                shift->(page => $page, destpage => $page,


@@ -211,32 +363,52 @@ sub genrss ($@) { #{{{
 } #}}}
 
 sub pingurl (@) { #{{{
 } #}}}
 
 sub pingurl (@) { #{{{

-       return unless $config{pingurl} && %toping;
+       return unless @{$config{pingurl}} && %toping;

 
        eval q{require RPC::XML::Client};
        if ($@) {
 
        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;
        }
 
                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 '/';
+       eval q{use POSIX 'setsid'};
+       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) {
        foreach my $page (keys %toping) {

-               my $title=pagetitle(basename($page));
+               my $title=pagetitle(basename($page), 0);

                my $url="$config{url}/".htmlpage($page);
                foreach my $pingurl (@{$config{pingurl}}) {
                my $url="$config{url}/".htmlpage($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");
                        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: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
+                       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
 } #}}}
 
 1