document effect of contentless dependencies on sidebar efficiency

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

diff --git a/IkiWiki.pm b/IkiWiki.pm
index f6a985556bec162c46eb6fdea84abd9ea6c7e67f..5e5dc739d2696cce58374c2717b453d104521f11 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -13,26 +13,31 @@ 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 %hooks %forcerebuild
-           %loaded_plugins %depends_exact};
+           %pagesources %destsources %depends %depends_simple %hooks
+           %forcerebuild %loaded_plugins};

 
 use Exporter q{import};
 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
                  pagespec_match_list bestlink htmllink readfile writefile
                 pagetype srcfile pagename displaytime will_render gettext urlto
                 targetpage add_underlay pagetitle titlepage linkpage
 
 use Exporter q{import};
 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
                  pagespec_match_list bestlink htmllink readfile writefile
                 pagetype srcfile pagename displaytime will_render gettext urlto
                 targetpage add_underlay pagetitle titlepage linkpage

-                newpagefile inject add_link add_depends_exact
+                newpagefile inject add_link

                  %config %links %pagestate %wikistate %renderedfiles
                  %pagesources %destsources);
 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 
                  %config %links %pagestate %wikistate %renderedfiles
                  %pagesources %destsources);
 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 

+# Page dependency types.
+our $DEPEND_EXISTS=1;
+our $DEPEND_CONTENT=2;
+

 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");
 memoize("file_pruned");
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");
 memoize("file_pruned");

+memoize("template_file");

 
 sub getsetup () {
        wikiname => {
 
 sub getsetup () {
        wikiname => {


@@ -149,6 +154,13 @@ sub getsetup () {
                safe => 0, # path
                rebuild => 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",


@@ -336,7 +348,7 @@ sub getsetup () {
                        qr/\.x?html?$/, qr/\.ikiwiki-new$/,
                        qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
                        qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
                        qr/\.x?html?$/, qr/\.ikiwiki-new$/,
                        qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
                        qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,

-                       qr/\.dpkg-tmp$/],
+                       qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],

                description => "regexps of source files to ignore",
                safe => 0,
                rebuild => 1,
                description => "regexps of source files to ignore",
                safe => 0,
                rebuild => 1,


@@ -356,7 +368,7 @@ sub getsetup () {
        },
        web_commit_regexp => {
                type => "internal",
        },
        web_commit_regexp => {
                type => "internal",

-               default => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
+               default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,

                description => "regexp to parse web commits from logs",
                safe => 0,
                rebuild => 0,
                description => "regexp to parse web commits from logs",
                safe => 0,
                rebuild => 0,


@@ -536,12 +548,12 @@ sub loadplugins () {
        }
        
        if ($config{rcs}) {
        }
        
        if ($config{rcs}) {

-               if (exists $IkiWiki::hooks{rcs}) {
+               if (exists $hooks{rcs}) {

                        error(gettext("cannot use multiple rcs plugins"));
                }
                loadplugin($config{rcs});
        }
                        error(gettext("cannot use multiple rcs plugins"));
                }
                loadplugin($config{rcs});
        }

-       if (! exists $IkiWiki::hooks{rcs}) {
+       if (! exists $hooks{rcs}) {

                loadplugin("norcs");
        }
 
                loadplugin("norcs");
        }
 


@@ -1476,7 +1488,7 @@ sub loadindex () {
        if (! $config{rebuild}) {
                %pagesources=%pagemtime=%oldlinks=%links=%depends=
                %destsources=%renderedfiles=%pagecase=%pagestate=
        if (! $config{rebuild}) {
                %pagesources=%pagemtime=%oldlinks=%links=%depends=
                %destsources=%renderedfiles=%pagecase=%pagestate=

-               %depends_exact=();
+               %depends_simple=();

        }
        my $in;
        if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
        }
        my $in;
        if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {


@@ -1516,18 +1528,28 @@ sub loadindex () {
                                $links{$page}=$d->{links};
                                $oldlinks{$page}=[@{$d->{links}}];
                        }
                                $links{$page}=$d->{links};
                                $oldlinks{$page}=[@{$d->{links}}];
                        }

-                       if (exists $d->{depends_exact}) {
-                               $depends_exact{$page}={
-                                       map { $_ => 1 } @{$d->{depends_exact}}
+                       if (ref $d->{depends_simple} eq 'ARRAY') {
+                               # old format
+                               $depends_simple{$page}={
+                                       map { $_ => 1 } @{$d->{depends_simple}}

                                };
                        }
                                };
                        }

+                       elsif (exists $d->{depends_simple}) {
+                               $depends{$page}=$d->{depends_simple};
+                       }

                        if (exists $d->{dependslist}) {
                        if (exists $d->{dependslist}) {

+                               # old format

                                $depends{$page}={
                                $depends{$page}={

-                                       map { $_ => 1 } @{$d->{dependslist}}
+                                       map { $_ => $DEPEND_CONTENT | $DEPEND_EXISTS }
+                                               @{$d->{dependslist}}

                                };
                        }
                                };
                        }

+                       elsif (exists $d->{depends} && ! ref $d->{depends}) {
+                               # old format
+                               $depends{$page}={$d->{depends} => $DEPEND_CONTENT | $DEPEND_EXISTS};
+                       }

                        elsif (exists $d->{depends}) {
                        elsif (exists $d->{depends}) {

-                               $depends{$page}={$d->{depends} => 1};
+                               $depends{$page}=$d->{depends};

                        }
                        if (exists $d->{state}) {
                                $pagestate{$page}=$d->{state};
                        }
                        if (exists $d->{state}) {
                                $pagestate{$page}=$d->{state};


@@ -1573,11 +1595,11 @@ sub saveindex () {
                };
 
                if (exists $depends{$page}) {
                };
 
                if (exists $depends{$page}) {

-                       $index{page}{$src}{dependslist} = [ keys %{$depends{$page}} ];
+                       $index{page}{$src}{depends} = $depends{$page};

                }
 
                }
 

-               if (exists $depends_exact{$page}) {
-                       $index{page}{$src}{depends_exact} = [ keys %{$depends_exact{$page}} ];
+               if (exists $depends_simple{$page}) {
+                       $index{page}{$src}{depends_simple} = $depends_simple{$page};

                }
 
                if (exists $pagestate{$page}) {
                }
 
                if (exists $pagestate{$page}) {


@@ -1609,7 +1631,8 @@ sub saveindex () {
 sub template_file ($) {
        my $template=shift;
 
 sub template_file ($) {
        my $template=shift;
 

-       foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
+       foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
+                        "$installdir/share/ikiwiki/templates") {

                return "$dir/$template" if -e "$dir/$template";
        }
        return;
                return "$dir/$template" if -e "$dir/$template";
        }
        return;


@@ -1744,21 +1767,31 @@ sub rcs_receive () {
        $hooks{rcs}{rcs_receive}{call}->();
 }
 
        $hooks{rcs}{rcs_receive}{call}->();
 }
 

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

        my $page=shift;
        my $pagespec=shift;
 
        my $page=shift;
        my $pagespec=shift;
 

-       return unless pagespec_valid($pagespec);
+       my $simple=$pagespec =~ /$config{wiki_file_regexp}/ &&
+               $pagespec !~ /[\s*?()!]/;

 
 

-       $depends{$page}{$pagespec} = 1;
-       return 1;
-}
+       my $deptype=$DEPEND_CONTENT | $DEPEND_EXISTS;
+       if (@_) {
+               my %params=@_;
+               if (defined $params{content} && $params{content} == 0 &&
+                   ($simple || pagespec_contentless($pagespec))) {
+                       $deptype=$deptype & ~$DEPEND_CONTENT;
+               }
+       }
+
+       if ($simple) {
+               $depends_simple{$page}{lc $pagespec} |= $deptype;
+               return 1;
+       }

 
 

-sub add_depends_exact ($$) {
-       my $page = shift;
-       my $dep = shift;
+       return unless pagespec_valid($pagespec);

 
 

-       $depends_exact{$page}{$dep} = 1;
+       $depends{$page}{$pagespec} |= $deptype;
+       return 1;

 }
 
 sub file_pruned ($$) {
 }
 
 sub file_pruned ($$) {


@@ -1943,6 +1976,18 @@ sub pagespec_valid ($) {
        return ! $@;
 }
 
        return ! $@;
 }
 

+sub pagespec_contentless ($) {
+       my $spec=shift;
+
+       while ($spec=~m{
+               (\w+)\([^\)]*\) # only match pagespec functions
+       }igx) {
+               return 0 unless $1=~/^(glob|internal|creation_month|creation_day|creation_year|created_before|created_after)$/;
+       }
+
+       return 1;
+}
+

 sub glob2re ($) {
        my $re=quotemeta(shift);
        $re=~s/\\\*/.*/g;
 sub glob2re ($) {
        my $re=quotemeta(shift);
        $re=~s/\\\*/.*/g;


@@ -2043,10 +2088,10 @@ sub match_link ($$;@) {
                else {
                        return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
                                if match_glob($p, $link, %params);
                else {
                        return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
                                if match_glob($p, $link, %params);

-                       $p=~s/^\///;
+                       my ($p_rel)=$p=~/^\/?(.*)/;

                        $link=~s/^\///;
                        $link=~s/^\///;

-                       return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
-                               if match_glob($p, $link, %params);
+                       return IkiWiki::SuccessReason->new("$page links to page $p_rel matching $link")
+                               if match_glob($p_rel, $link, %params);

                }
        }
        return IkiWiki::FailReason->new("$page does not link to $link");
                }
        }
        return IkiWiki::FailReason->new("$page does not link to $link");