html5 bug closure, and documentation

[ikiwiki.git] / IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 1327e4db50495f0b2b02ba0ab08eb1b55445bec6..c428de77f7e055390e66fcdf53301f61ac2d9382 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -5,7 +5,6 @@ package IkiWiki;
 use warnings;
 use strict;
 use Encode;
-use HTML::Entities;
 use URI::Escape q{uri_escape_utf8};
 use POSIX ();
 use Storable;
@@ -13,8 +12,8 @@ use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
        %pagestate %wikistate %renderedfiles %oldrenderedfiles
-       %pagesources %destsources %depends %depends_simple %hooks
-       %forcerebuild %loaded_plugins %typedlinks %oldtypedlinks
+       %pagesources %destsources %depends %depends_simple @mass_depends 
+       %hooks %forcerebuild %loaded_plugins %typedlinks %oldtypedlinks
        %autofiles};
 
 use Exporter q{import};
@@ -152,7 +151,7 @@ sub getsetup () {
        templatedir => {
                type => "string",
                default => "$installdir/share/ikiwiki/templates",
-               description => "location of template files",
+               description => "additional directory to search for template files",
                advanced => 1,
                safe => 0, # path
                rebuild => 1,
@@ -235,6 +234,14 @@ sub getsetup () {
                safe => 1,
                rebuild => 1,
        },
+       html5 => {
+               type => "boolean",
+               default => 0,
+               description => "generate HTML5? (experimental)",
+               advanced => 1,
+               safe => 1,
+               rebuild => 1,
+       },
        sslcookie => {
                type => "boolean",
                default => 0,
@@ -991,10 +998,18 @@ sub abs2rel ($$) {
        return $ret;
 }
 
-sub displaytime ($;$) {
+sub displaytime ($;$$) {
        # Plugins can override this function to mark up the time to
        # display.
-       return '<span class="date">'.formattime(@_).'</span>';
+       my $time=formattime($_[0], $_[1]);
+       if ($config{html5}) {
+               return '<time datetime="'.date_3339($_[0]).'"'.
+                       ($_[2] ? ' pubdate' : '').
+                       '>'.$time.'</time>';
+       }
+       else {
+               return '<span class="date">'.$time.'</span>';
+       }
 }
 
 sub formattime ($;$) {
@@ -1010,6 +1025,16 @@ sub formattime ($;$) {
        return decode_utf8(POSIX::strftime($format, localtime($time)));
 }
 
+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", gmtime($time));
+       POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
+       return $ret;
+}
+
 sub beautify_urlpath ($) {
        my $url=shift;
 
@@ -1531,8 +1556,8 @@ sub loadindex () {
                my $d=$pages->{$src};
                my $page=pagename($src);
                $pagectime{$page}=$d->{ctime};
+               $pagesources{$page}=$src;
                if (! $config{rebuild}) {
-                       $pagesources{$page}=$src;
                        $pagemtime{$page}=$d->{mtime};
                        $renderedfiles{$page}=$d->{dest};
                        if (exists $d->{links} && ref $d->{links}) {
@@ -1653,62 +1678,80 @@ sub saveindex () {
 
 sub template_file ($) {
        my $name=shift;
-
-       my $template=srcfile("templates/$name", 1);
-       return $template if defined $template;
        
-       foreach my $dir ($config{templatedir},
-                        "$installdir/share/ikiwiki/templates") {
-               return "$dir/$name" if -e "$dir/$name";
+       my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
+       if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
+               $tpage=$pagesources{$tpage};
+               $name.=".tmpl";
        }
-       return;
-}
 
-sub template_params (@) {
-       filter => sub {
-               my $text_ref = shift;
-               ${$text_ref} = decode_utf8(${$text_ref});
-       },
-       loop_context_vars => 1,
-       die_on_bad_params => 0,
-       @_,
-       no_includes => 1,
-}
+       my $template=srcfile($tpage, 1);
+       if (defined $template) {
+               return $template, $tpage, 1 if wantarray;
+               return $template;
+       }
+       else {
+               $name=~s:/::; # avoid path traversal
+               foreach my $dir ($config{templatedir},
+                                "$installdir/share/ikiwiki/templates") {
+                       if (-e "$dir/$name") {
+                               $template="$dir/$name";
+                               last;
+                       }
+               }
+               if (defined $template) {        
+                       return $template, $tpage if wantarray;
+                       return $template;
+               }
+       }
 
-sub template ($;@) {
-       require HTML::Template;
-       return HTML::Template->new(template_params(
-               filename => template_file(shift),
-               @_
-       ));
+       return;
 }
 
 sub template_depends ($$;@) {
        my $name=shift;
        my $page=shift;
-
-       if (defined $page) {
-               add_depends($page, "templates/$name");
+       
+       my ($filename, $tpage, $untrusted)=template_file($name);
+       if (defined $page && defined $tpage) {
+               add_depends($page, $tpage);
        }
-       my $filename=template_file($name);
 
-       require HTML::Template;
-       return HTML::Template->new(template_params(
+       return unless defined $filename;
+
+       my @opts=(
+               filter => sub {
+                       my $text_ref = shift;
+                       ${$text_ref} = decode_utf8(${$text_ref});
+               },
+               loop_context_vars => 1,
+               die_on_bad_params => 0,
                filename => $filename,
-               @_
-       ));
+               @_,
+               ($untrusted ? (no_includes => 1) : ()),
+       );
+       return @opts if wantarray;
+
+       require HTML::Template;
+       return HTML::Template->new(@opts);
+}
+
+sub template ($;@) {
+       template_depends(shift, undef, @_);
 }
 
 sub misctemplate ($$;@) {
        my $title=shift;
        my $pagebody=shift;
        
-       my $template=template("misc.tmpl",
+       my $template=template("misc.tmpl");
+       $template->param(
                title => $title,
                indexlink => indexlink(),
                wikiname => $config{wikiname},
                pagebody => $pagebody,
                baseurl => baseurl(),
+               html5 => $config{html5},
                @_,
        );
        run_hooks(pagetemplate => sub {
@@ -2286,7 +2329,11 @@ sub match_glob ($$;@) {
 
        my $regexp=IkiWiki::glob2re($glob);
        if ($page=~/^$regexp$/i) {
-               if (! IkiWiki::isinternal($page) || $params{internal}) {
+               if ($params{onlypage} &&
+                   ! defined IkiWiki::pagetype($IkiWiki::pagesources{$page})) {
+                       return IkiWiki::FailReason->new("$page is not a page");
+               }
+               elsif (! IkiWiki::isinternal($page) || $params{internal}) {
                        return IkiWiki::SuccessReason->new("$glob matches $page");
                }
                else {
@@ -2302,6 +2349,10 @@ sub match_internal ($$;@) {
        return match_glob($_[0], $_[1], @_, internal => 1)
 }
 
+sub match_page ($$;@) {
+       return match_glob($_[0], $_[1], @_, onlypage => 1)
+}
+
 sub match_link ($$;@) {
        my $page=shift;
        my $link=lc(shift);