(no commit message)

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

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 5ff1a5ae65fbfcd796550a1cf478272986ce9550..df8abe2c2711281c220a604aa0ddca09ec915a02 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -12,9 +12,9 @@ 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 @mass_depends 
-       %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};
 our @EXPORT = qw(hook debug error htmlpage template template_depends
 
 use Exporter q{import};
 our @EXPORT = qw(hook debug error htmlpage template template_depends


@@ -234,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,


@@ -433,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",


@@ -584,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") {


@@ -807,6 +823,17 @@ sub prep_writefile ($$) {
                if (-l "$destdir/$test") {
                        error("cannot write to a symlink ($test)");
                }
                if (-l "$destdir/$test") {
                        error("cannot write to a symlink ($test)");
                }

+               if (-f _ && $test ne $file) {
+                       # Remove conflicting file.
+                       foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
+                               foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
+                                       if ($f eq $test) {
+                                               unlink("$destdir/$test");
+                                               last;
+                                       }
+                               }
+                       }
+               }

                $test=dirname($test);
        }
 
                $test=dirname($test);
        }
 


@@ -860,10 +887,36 @@ sub will_render ($$;$) {
        my $dest=shift;
        my $clear=shift;
 
        my $dest=shift;
        my $clear=shift;
 

-       # Important security check.
+       # Important security check for independently created files.

        if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
            ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
        if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
            ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {

-               error("$config{destdir}/$dest independently created, not overwriting with version from $page");
+               my $from_other_page=0;
+               # Expensive, but rarely runs.
+               foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
+                       if (grep {
+                               $_ eq $dest ||
+                               dirname($_) eq $dest
+                           } @{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
+                               $from_other_page=1;
+                               last;
+                       }
+               }
+
+               error("$config{destdir}/$dest independently created, not overwriting with version from $page")
+                       unless $from_other_page;
+       }
+
+       # If $dest exists as a directory, remove conflicting files in it
+       # rendered from other pages.
+       if (-d _) {
+               foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
+                       foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
+                               if (dirname($f) eq $dest) {
+                                       unlink("$config{destdir}/$f");
+                                       rmdir(dirname("$config{destdir}/$f"));
+                               }
+                       }
+               }

        }
 
        if (! $clear || $cleared{$page}) {
        }
 
        if (! $clear || $cleared{$page}) {


@@ -990,10 +1043,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 ($;$) {


@@ -1009,6 +1070,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;
 


@@ -1047,6 +1118,15 @@ sub urlto ($$;$) {
        return beautify_urlpath($link);
 }
 
        return beautify_urlpath($link);
 }
 

+sub isselflink ($$) {
+       # Plugins can override this function to support special types
+       # of selflinks.
+       my $page=shift;
+       my $link=shift;
+
+        return $page eq $link;
+}
+

 sub htmllink ($$$;@) {
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)
 sub htmllink ($$$;@) {
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)


@@ -1072,7 +1152,7 @@ sub htmllink ($$$;@) {
        }
        
        return "<span class=\"selflink\">$linktext</span>"
        }
        
        return "<span class=\"selflink\">$linktext</span>"

-               if length $bestlink && $page eq $bestlink &&
+               if length $bestlink && isselflink($page, $bestlink) &&

                   ! defined $opts{anchor};
        
        if (! $destsources{$bestlink}) {
                   ! defined $opts{anchor};
        
        if (! $destsources{$bestlink}) {


@@ -1375,10 +1455,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;


@@ -1520,6 +1596,12 @@ sub loadindex () {
        if (exists $index->{version} && ! ref $index->{version}) {
                $pages=$index->{page};
                %wikistate=%{$index->{state}};
        if (exists $index->{version} && ! ref $index->{version}) {
                $pages=$index->{page};
                %wikistate=%{$index->{state}};

+               # Handle plugins that got disabled by loading a new setup.
+               if (exists $config{setupfile}) {
+                       require IkiWiki::Setup;
+                       IkiWiki::Setup::disabled_plugins(
+                               grep { ! $loaded_plugins{$_} } keys %wikistate);
+               }

        }
        else {
                $pages=$index;
        }
        else {
                $pages=$index;


@@ -1587,11 +1669,7 @@ sub loadindex () {
 sub saveindex () {
        run_hooks(savestate => sub { shift->() });
 
 sub saveindex () {
        run_hooks(savestate => sub { shift->() });
 

-       my %hookids;
-       foreach my $type (keys %hooks) {
-               $hookids{$_}=1 foreach keys %{$hooks{$type}};
-       }
-       my @hookids=keys %hookids;
+       my @plugins=keys %loaded_plugins;

 
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
 
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});


@@ -1625,7 +1703,7 @@ sub saveindex () {
                }
 
                if (exists $pagestate{$page}) {
                }
 
                if (exists $pagestate{$page}) {

-                       foreach my $id (@hookids) {
+                       foreach my $id (@plugins) {

                                foreach my $key (keys %{$pagestate{$page}{$id}}) {
                                        $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
                                }
                                foreach my $key (keys %{$pagestate{$page}{$id}}) {
                                        $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
                                }


@@ -1634,7 +1712,8 @@ sub saveindex () {
        }
 
        $index{state}={};
        }
 
        $index{state}={};

-       foreach my $id (@hookids) {
+       foreach my $id (@plugins) {
+               $index{state}{$id}={}; # used to detect disabled plugins

                foreach my $key (keys %{$wikistate{$id}}) {
                        $index{state}{$id}{$key}=$wikistate{$id}{$key};
                }
                foreach my $key (keys %{$wikistate{$id}}) {
                        $index{state}{$id}{$key}=$wikistate{$id}{$key};
                }


@@ -1654,12 +1733,15 @@ sub template_file ($) {
        my $name=shift;
        
        my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
        my $name=shift;
        
        my $tpage=($name =~ s/^\///) ? $name : "templates/$name";

+       my $template;

        if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
        if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {

-               $tpage=$pagesources{$tpage};
+               $template=srcfile($pagesources{$tpage}, 1);

                $name.=".tmpl";
        }
                $name.=".tmpl";
        }

+       else {
+               $template=srcfile($tpage, 1);
+       }

 
 

-       my $template=srcfile($tpage, 1);

        if (defined $template) {
                return $template, $tpage, 1 if wantarray;
                return $template;
        if (defined $template) {
                return $template, $tpage, 1 if wantarray;
                return $template;


@@ -1716,23 +1798,59 @@ sub template ($;@) {
 
 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=@_;
        


@@ -1781,11 +1899,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}->(@_);
 }
 


@@ -2302,11 +2420,7 @@ sub match_glob ($$;@) {
 
        my $regexp=IkiWiki::glob2re($glob);
        if ($page=~/^$regexp$/i) {
 
        my $regexp=IkiWiki::glob2re($glob);
        if ($page=~/^$regexp$/i) {

-               if ($params{onlypage} &&
-                   ! defined IkiWiki::pagetype($IkiWiki::pagesources{$page})) {
-                       return IkiWiki::FailReason->new("$page is not a page");
-               }
-               elsif (! IkiWiki::isinternal($page) || $params{internal}) {
+               if (! IkiWiki::isinternal($page) || $params{internal}) {

                        return IkiWiki::SuccessReason->new("$glob matches $page");
                }
                else {
                        return IkiWiki::SuccessReason->new("$glob matches $page");
                }
                else {


@@ -2319,11 +2433,22 @@ 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 ($$;@) {
 }
 
 sub match_page ($$;@) {

-       return match_glob($_[0], $_[1], @_, onlypage => 1)
+       my $page=shift;
+       my $match=match_glob($page, shift, @_);
+       if ($match) {
+               my $source=exists $IkiWiki::pagesources{$page} ?
+                       $IkiWiki::pagesources{$page} :
+                       $IkiWiki::delpagesources{$page};
+               my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+               if (! defined $type) {  
+                       return IkiWiki::FailReason->new("$page is not a page");
+               }
+       }
+       return $match;

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


@@ -2344,18 +2469,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)
                        }
                }


@@ -2410,7 +2537,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 {


@@ -2419,7 +2546,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 {


@@ -2428,7 +2555,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 {