Fix a couple of grammar errors.

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

diff --git a/IkiWiki.pm b/IkiWiki.pm
index adae5d8c10519cad951c49c0347d866856a41a91..701f7137dd78483215637e205bbde0b720ea0387 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -5,7 +5,6 @@ package IkiWiki;
 use warnings;
 use strict;
 use Encode;
 use warnings;
 use strict;
 use Encode;

-use HTML::Entities;

 use URI::Escape q{uri_escape_utf8};
 use POSIX ();
 use Storable;
 use URI::Escape q{uri_escape_utf8};
 use POSIX ();
 use Storable;


@@ -13,13 +12,13 @@ use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
        %pagestate %wikistate %renderedfiles %oldrenderedfiles
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
        %pagestate %wikistate %renderedfiles %oldrenderedfiles

-       %pagesources %destsources %depends %depends_simple %hooks
-       %forcerebuild %loaded_plugins %typedlinks %oldtypedlinks
-       %autofiles};
+       %pagesources %delpagesources %destsources %depends %depends_simple
+       @mass_depends %hooks %forcerebuild %loaded_plugins %typedlinks
+       %oldtypedlinks %autofiles};

 
 use Exporter q{import};
 
 use Exporter q{import};

-our @EXPORT = qw(hook debug error template htmlpage deptype
-       add_depends pagespec_match pagespec_match_list bestlink
+our @EXPORT = qw(hook debug error htmlpage template template_depends
+       deptype add_depends pagespec_match pagespec_match_list bestlink

        htmllink readfile writefile pagetype srcfile pagename
        displaytime will_render gettext ngettext urlto targetpage
        add_underlay pagetitle titlepage linkpage newpagefile
        htmllink readfile writefile pagetype srcfile pagename
        displaytime will_render gettext ngettext urlto targetpage
        add_underlay pagetitle titlepage linkpage newpagefile


@@ -152,18 +151,11 @@ sub getsetup () {
        templatedir => {
                type => "string",
                default => "$installdir/share/ikiwiki/templates",
        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,
        },
                advanced => 1,
                safe => 0, # path
                rebuild => 1,
        },

-       templatedirs => {
-               type => "internal",
-               default => [],
-               description => "additional directories containing template files",
-               safe => 0,
-               rebuild => 0,
-       },

        underlaydir => {
                type => "string",
                default => "$installdir/share/ikiwiki/basewiki",
        underlaydir => {
                type => "string",
                default => "$installdir/share/ikiwiki/basewiki",


@@ -242,6 +234,14 @@ sub getsetup () {
                safe => 1,
                rebuild => 1,
        },
                safe => 1,
                rebuild => 1,
        },

+       html5 => {
+               type => "boolean",
+               default => 0,
+               description => "generate HTML5? (experimental)",
+               advanced => 1,
+               safe => 1,
+               rebuild => 1,
+       },

        sslcookie => {
                type => "boolean",
                default => 0,
        sslcookie => {
                type => "boolean",
                default => 0,


@@ -441,6 +441,13 @@ sub getsetup () {
                safe => 0,
                rebuild => 0,
        },
                safe => 0,
                rebuild => 0,
        },

+       wrapper_background_command => {
+               type => "internal",
+               default => '',
+               description => "background shell command to run",
+               safe => 0,
+               rebuild => 0,
+       },

        gettime => {
                type => "internal",
                description => "running in gettime mode",
        gettime => {
                type => "internal",
                description => "running in gettime mode",


@@ -592,10 +599,11 @@ sub loadplugins () {
        return 1;
 }
 
        return 1;
 }
 

-sub loadplugin ($) {
+sub loadplugin ($;$) {

        my $plugin=shift;
        my $plugin=shift;

+       my $force=shift;

 
 

-       return if grep { $_ eq $plugin} @{$config{disable_plugins}};
+       return if ! $force && grep { $_ eq $plugin} @{$config{disable_plugins}};

 
        foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
                         "$installdir/lib/ikiwiki") {
 
        foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
                         "$installdir/lib/ikiwiki") {


@@ -998,10 +1006,18 @@ sub abs2rel ($$) {
        return $ret;
 }
 
        return $ret;
 }
 

-sub displaytime ($;$) {
+sub displaytime ($;$$) {

        # Plugins can override this function to mark up the time to
        # display.
        # 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="pubdate"' : '').
+                       '>'.$time.'</time>';
+       }
+       else {
+               return '<span class="date">'.$time.'</span>';
+       }

 }
 
 sub formattime ($;$) {
 }
 
 sub formattime ($;$) {


@@ -1017,6 +1033,16 @@ sub formattime ($;$) {
        return decode_utf8(POSIX::strftime($format, localtime($time)));
 }
 
        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;
 
 sub beautify_urlpath ($) {
        my $url=shift;
 


@@ -1087,14 +1113,16 @@ sub htmllink ($$$;@) {
                $bestlink=htmlpage($bestlink);
 
                if (! $destsources{$bestlink}) {
                $bestlink=htmlpage($bestlink);
 
                if (! $destsources{$bestlink}) {

-                       return $linktext unless length $config{cgiurl};
-                       return "<span class=\"createlink\"><a href=\"".
-                               cgiurl(
-                                       do => "create",
-                                       page => lc($link),
-                                       from => $lpage
-                               ).
-                               "\" rel=\"nofollow\">?</a>$linktext</span>"
+                       my $cgilink = "";
+                       if (length $config{cgiurl}) {
+                               $cgilink = "<a href=\"".
+                                       cgiurl(
+                                               do => "create",
+                                               page => lc($link),
+                                               from => $lpage
+                                       )."\" rel=\"nofollow\">?</a>";
+                       }
+                       return "<span class=\"createlink\">$cgilink$linktext</span>"

                }
        }
        
                }
        }
        


@@ -1381,10 +1409,6 @@ sub filter ($$$) {
        return $content;
 }
 
        return $content;
 }
 

-sub indexlink () {
-       return "<a href=\"$config{url}\">$config{wikiname}</a>";
-}
-

 sub check_canedit ($$$;$) {
        my $page=shift;
        my $q=shift;
 sub check_canedit ($$$;$) {
        my $page=shift;
        my $q=shift;


@@ -1536,8 +1560,8 @@ sub loadindex () {
                my $d=$pages->{$src};
                my $page=pagename($src);
                $pagectime{$page}=$d->{ctime};
                my $d=$pages->{$src};
                my $page=pagename($src);
                $pagectime{$page}=$d->{ctime};

+               $pagesources{$page}=$src;

                if (! $config{rebuild}) {
                if (! $config{rebuild}) {

-                       $pagesources{$page}=$src;

                        $pagemtime{$page}=$d->{mtime};
                        $renderedfiles{$page}=$d->{dest};
                        if (exists $d->{links} && ref $d->{links}) {
                        $pagemtime{$page}=$d->{mtime};
                        $renderedfiles{$page}=$d->{dest};
                        if (exists $d->{links} && ref $d->{links}) {


@@ -1657,60 +1681,124 @@ sub saveindex () {
 }
 
 sub template_file ($) {
 }
 
 sub template_file ($) {

-       my $template=shift;
+       my $name=shift;
+       
+       my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
+       if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
+               $tpage=$pagesources{$tpage};
+               $name.=".tmpl";
+       }

 
 

-       foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
-                        "$installdir/share/ikiwiki/templates") {
-               return "$dir/$template" if -e "$dir/$template";
+       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;
+               }

        }
        }

+

        return;
 }
 
        return;
 }
 

-sub template_params (@) {
-       my $filename=template_file(shift);
-
-       if (! defined $filename) {
-               return if wantarray;
-               return "";
+sub template_depends ($$;@) {
+       my $name=shift;
+       my $page=shift;
+       
+       my ($filename, $tpage, $untrusted)=template_file($name);
+       if (defined $page && defined $tpage) {
+               add_depends($page, $tpage);

        }
 
        }
 

-       my @ret=(
+       return unless defined $filename;
+
+       my @opts=(

                filter => sub {
                        my $text_ref = shift;
                        ${$text_ref} = decode_utf8(${$text_ref});
                },
                filter => sub {
                        my $text_ref = shift;
                        ${$text_ref} = decode_utf8(${$text_ref});
                },

-               filename => $filename,

                loop_context_vars => 1,
                die_on_bad_params => 0,
                loop_context_vars => 1,
                die_on_bad_params => 0,

-               @_
+               filename => $filename,
+               @_,
+               ($untrusted ? (no_includes => 1) : ()),

        );
        );

-       return wantarray ? @ret : {@ret};
+       return @opts if wantarray;
+
+       require HTML::Template;
+       return HTML::Template->new(@opts);

 }
 
 sub template ($;@) {
 }
 
 sub template ($;@) {

-       require HTML::Template;
-       return HTML::Template->new(template_params(@_));
+       template_depends(shift, undef, @_);

 }
 
 sub misctemplate ($$;@) {
        my $title=shift;
 }
 
 sub misctemplate ($$;@) {
        my $title=shift;

-       my $pagebody=shift;
+       my $content=shift;
+       my %params=@_;

        
        

-       my $template=template("misc.tmpl");
+       my $template=template("page.tmpl");
+
+       my $page="";
+       if (exists $params{page}) {
+               $page=delete $params{page};
+       }
+       run_hooks(pagetemplate => sub {
+               shift->(
+                       page => $page,
+                       destpage => $page,
+                       template => $template,
+               );
+       });
+       templateactions($template, "");
+

        $template->param(
        $template->param(

+               dynamic => 1,

                title => $title,
                title => $title,

-               indexlink => indexlink(),

                wikiname => $config{wikiname},
                wikiname => $config{wikiname},

-               pagebody => $pagebody,
+               content => $content,

                baseurl => baseurl(),
                baseurl => baseurl(),

-               @_,
+               html5 => $config{html5},
+               %params,

        );
        );

-       run_hooks(pagetemplate => sub {
-               shift->(page => "", destpage => "", template => $template);
-       });
+       

        return $template->output;
 }
 
        return $template->output;
 }
 

+sub templateactions ($$) {
+       my $template=shift;
+       my $page=shift;
+
+       my $have_actions=0;
+       my @actions;
+       run_hooks(pageactions => sub {
+               push @actions, map { { action => $_ } } 
+                       grep { defined } shift->(page => $page);
+       });
+       $template->param(actions => \@actions);
+
+       if ($config{cgiurl} && exists $hooks{auth}) {
+               $template->param(prefsurl => cgiurl(do => "prefs"));
+               $have_actions=1;
+       }
+
+       if ($have_actions || @actions) {
+               $template->param(have_actions => 1);
+       }
+}
+

 sub hook (@) {
        my %param=@_;
        
 sub hook (@) {
        my %param=@_;
        


@@ -1759,11 +1847,11 @@ sub rcs_prepedit ($) {
        $hooks{rcs}{rcs_prepedit}{call}->(@_);
 }
 
        $hooks{rcs}{rcs_prepedit}{call}->(@_);
 }
 

-sub rcs_commit ($$$;$$) {
+sub rcs_commit (@) {

        $hooks{rcs}{rcs_commit}{call}->(@_);
 }
 
        $hooks{rcs}{rcs_commit}{call}->(@_);
 }
 

-sub rcs_commit_staged ($$$) {
+sub rcs_commit_staged (@) {

        $hooks{rcs}{rcs_commit_staged}{call}->(@_);
 }
 
        $hooks{rcs}{rcs_commit_staged}{call}->(@_);
 }
 


@@ -1817,10 +1905,12 @@ sub add_depends ($$;$) {
        foreach my $p (keys %pagesources) {
                my $r=$sub->($p, location => $page);
                my $i=$r->influences;
        foreach my $p (keys %pagesources) {
                my $r=$sub->($p, location => $page);
                my $i=$r->influences;

+               my $static=$r->influences_static;

                foreach my $k (keys %$i) {
                foreach my $k (keys %$i) {

+                       next unless $r || $static || $k eq $page;

                        $depends_simple{$page}{lc $k} |= $i->{$k};
                }
                        $depends_simple{$page}{lc $k} |= $i->{$k};
                }

-               last if $r->influences_static;
+               last if $static;

        }
 
        $depends{$page}{$pagespec} |= $deptype;
        }
 
        $depends{$page}{$pagespec} |= $deptype;


@@ -2144,6 +2234,9 @@ sub pagespec_match_list ($$;@) {
                my $r=$sub->($p, %params, location => $page);
                error(sprintf(gettext("cannot match pages: %s"), $r))
                        if $r->isa("IkiWiki::ErrorReason");
                my $r=$sub->($p, %params, location => $page);
                error(sprintf(gettext("cannot match pages: %s"), $r))
                        if $r->isa("IkiWiki::ErrorReason");

+               unless ($r || $r->influences_static) {
+                       $r->remove_influence($p);
+               }

                $accum |= $r;
                if ($r) {
                        push @matches, $p;
                $accum |= $r;
                if ($r) {
                        push @matches, $p;


@@ -2229,7 +2322,7 @@ sub merge_influences {
        my $anded=shift;
 
        if (! $anded || (($this || %{$this->[1]}) &&
        my $anded=shift;
 
        if (! $anded || (($this || %{$this->[1]}) &&

-                       ($other || %{$other->[1]}))) {
+                        ($other || %{$other->[1]}))) {

                foreach my $influence (keys %{$other->[1]}) {
                        $this->[1]{$influence} |= $other->[1]{$influence};
                }
                foreach my $influence (keys %{$other->[1]}) {
                        $this->[1]{$influence} |= $other->[1]{$influence};
                }


@@ -2240,6 +2333,13 @@ sub merge_influences {
        }
 }
 
        }
 }
 

+sub remove_influence {
+       my $this=shift;
+       my $torm=shift;
+
+       delete $this->[1]{$torm};
+}
+

 package IkiWiki::ErrorReason;
 
 our @ISA = 'IkiWiki::FailReason';
 package IkiWiki::ErrorReason;
 
 our @ISA = 'IkiWiki::FailReason';


@@ -2253,7 +2353,7 @@ sub derel ($$) {
        if ($path =~ m!^\./!) {
                $from=~s#/?[^/]+$## if defined $from;
                $path=~s#^\./##;
        if ($path =~ m!^\./!) {
                $from=~s#/?[^/]+$## if defined $from;
                $path=~s#^\./##;

-               $path="$from/$path" if length $from;
+               $path="$from/$path" if defined $from && length $from;

        }
 
        return $path;
        }
 
        return $path;


@@ -2281,7 +2381,19 @@ sub match_glob ($$;@) {
 }
 
 sub match_internal ($$;@) {
 }
 
 sub match_internal ($$;@) {

-       return match_glob($_[0], $_[1], @_, internal => 1)
+       return match_glob(shift, shift, @_, internal => 1)
+}
+
+sub match_page ($$;@) {
+       my $page=shift;
+       my $match=match_glob($page, shift, @_);
+       if ($match && ! (exists $IkiWiki::pagesources{$page}
+           && defined IkiWiki::pagetype($IkiWiki::pagesources{$page}))) {
+               return IkiWiki::FailReason->new("$page is not a page");
+       }
+       else {
+               return $match;
+       }

 }
 
 sub match_link ($$;@) {
 }
 
 sub match_link ($$;@) {


@@ -2302,18 +2414,20 @@ sub match_link ($$;@) {
                unless $links && @{$links};
        my $bestlink = IkiWiki::bestlink($from, $link);
        foreach my $p (@{$links}) {
                unless $links && @{$links};
        my $bestlink = IkiWiki::bestlink($from, $link);
        foreach my $p (@{$links}) {

+               next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
+

                if (length $bestlink) {
                if (length $bestlink) {

-                       if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p}) && $bestlink eq IkiWiki::bestlink($page, $p)) {
+                       if ($bestlink eq IkiWiki::bestlink($page, $p)) {

                                return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
                        }
                }
                else {
                                return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
                        }
                }
                else {

-                       if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p}) && match_glob($p, $link, %params)) {
+                       if (match_glob($p, $link, %params)) {

                                return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
                        }
                        my ($p_rel)=$p=~/^\/?(.*)/;
                        $link=~s/^\///;
                                return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
                        }
                        my ($p_rel)=$p=~/^\/?(.*)/;
                        $link=~s/^\///;

-                       if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p_rel}) && match_glob($p_rel, $link, %params)) {
+                       if (match_glob($p_rel, $link, %params)) {

                                return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
                        }
                }
                                return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
                        }
                }


@@ -2368,7 +2482,7 @@ sub match_created_after ($$;@) {
 }
 
 sub match_creation_day ($$;@) {
 }
 
 sub match_creation_day ($$;@) {

-       if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
+       if ((localtime($IkiWiki::pagectime{shift()}))[3] == shift) {

                return IkiWiki::SuccessReason->new('creation_day matched');
        }
        else {
                return IkiWiki::SuccessReason->new('creation_day matched');
        }
        else {


@@ -2377,7 +2491,7 @@ sub match_creation_day ($$;@) {
 }
 
 sub match_creation_month ($$;@) {
 }
 
 sub match_creation_month ($$;@) {

-       if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
+       if ((localtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {

                return IkiWiki::SuccessReason->new('creation_month matched');
        }
        else {
                return IkiWiki::SuccessReason->new('creation_month matched');
        }
        else {


@@ -2386,7 +2500,7 @@ sub match_creation_month ($$;@) {
 }
 
 sub match_creation_year ($$;@) {
 }
 
 sub match_creation_year ($$;@) {

-       if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
+       if ((localtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {

                return IkiWiki::SuccessReason->new('creation_year matched');
        }
        else {
                return IkiWiki::SuccessReason->new('creation_year matched');
        }
        else {