]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/inline.pm
testing
[ikiwiki.git] / IkiWiki / Plugin / inline.pm
index b06470bfef299dd0accf075ef6103e05893b4b21..c6c6c6a1e286bdacb46378d0767f5fa566c4c522 100644 (file)
@@ -4,15 +4,19 @@ package IkiWiki::Plugin::inline;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 1.00;
+use IkiWiki::Render; # for displaytime
+use URI;
 
 sub import { #{{{
-       IkiWiki::hook(type => "preprocess", id => "inline", 
+       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);
 } # }}}
 
@@ -21,101 +25,170 @@ sub import { #{{{
 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 $feeds=exists $params{feeds} ? yesno($params{feeds}) : 1;
+       if (! exists $params{show} && ! $archive) {
                $params{show}=10;
        }
-
-       # 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) {
                next if $page eq $params{page};
-               if (globlist_match($page, $params{pages})) {
+               if (pagespec_match($page, $params{pages})) {
                        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 "unknown sort type $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});
 
+       my $rssurl=rsspage(basename($params{page}));
+       my $atomurl=atompage(basename($params{page}));
        my $ret="";
-       
+
        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});
-               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;
        }
-       elsif ($config{rss}) {
-               # 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"),
+               ($archive ? "inlinepagetitle.tmpl" : "inlinepage.tmpl"),
                blind_cache => 1,
-       );
+       ) 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 => $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)) {
+                       # 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}));
 
-               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}) {
+                                       $template->param(have_actions => 1);
+                                       $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
+                               }
+                               if (length $config{cgiurl} && defined $type) {
+                                       $template->param(have_actions => 1);
+                                       $template->param(editurl => cgiurl(do => "edit", page => $page));
+                               }
+                       }
 
-               $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)))));
+                       }
+               }
        }
        
-       # TODO: should really add this to renderedfiles and call
-       # check_overwrite, but currently renderedfiles
-       # only supports listing one file per page.
-       if ($config{rss}) {
+       if ($feeds && $rss) {
+               will_render($params{page}, rsspage($params{page}));
                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};
+               $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;
@@ -123,7 +196,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,
+                      readfile(srcfile($file))))));
        }
        else {
                return "";
@@ -134,7 +211,24 @@ sub date_822 ($) { #{{{
        my $time=shift;
 
        eval q{use POSIX};
-       return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
+       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));
+       POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
+       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 ($$) { #{{{
@@ -155,33 +249,82 @@ sub rsspage ($) { #{{{
        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 $url="$config{url}/".htmlpage($page);
-       
-       my $template=template("rsspage.tmpl", blind_cache => 1,
-               die_on_bad_params => 0);
+       my $url=URI->new(encode_utf8($config{url}."/".htmlpage($page)));
        
-       my @items;
+       my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
+       my $content="";
+       my $lasttime = 0;
        foreach my $p (@pages) {
-               push @items, {
-                       itemtitle => pagetitle(basename($p)),
-                       itemurl => "$config{url}/$renderedfiles{$p}",
-                       itempubdate => date_822($pagectime{$p}),
-                       itemcontent => absolute_urls(get_inline_content($p, $page), $url),
-                       page => $p, # used by category adding code in tag plugin
-               } if exists $renderedfiles{$p};
+               my $u=URI->new(encode_utf8($config{url}."/".htmlpage($p)));
+
+               $itemtemplate->param(
+                       title => pagetitle(basename($p)),
+                       url => $u,
+                       permalink => $u,
+                       date_822 => date_822($pagectime{$p}),
+                       date_3339 => date_3339($pagectime{$p}),
+               );
+
+               my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
+               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($feedtype."page.tmpl", blind_cache => 1);
        $template->param(
-               title => $config{wikiname},
+               title => $page ne "index" ? pagetitle($page) : $config{wikiname},
                wikiname => $config{wikiname},
                pageurl => $url,
-               items => \@items,
+               content => $content,
+               feeddesc => $feeddesc,
+               feeddate => date_3339($lasttime),
+               feedurl => $feedurl,
+               version => $IkiWiki::version,
        );
-       
        run_hooks(pagetemplate => sub {
                shift->(page => $page, destpage => $page,
                        template => $template);
@@ -199,21 +342,28 @@ sub pingurl (@) { #{{{
                return;
        }
 
+       # TODO: daemonize here so slow pings don't slow down wiki updates
+
        foreach my $page (keys %toping) {
                my $title=pagetitle(basename($page));
                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");
-                       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: $@";
                        }
                }
        }