]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/pagestats.pm
pagestats: Use a combination of precense and link dependencies.
[ikiwiki.git] / IkiWiki / Plugin / pagestats.pm
index f6398c535f29ce2768e7389bf4d8b7581407d61a..00b919325ff3b194f7159a84133515721d83328c 100644 (file)
@@ -12,33 +12,52 @@ package IkiWiki::Plugin::pagestats;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 # Names of the HTML classes to use for the tag cloud
 our @classes = ('smallestPC', 'smallPC', 'normalPC', 'bigPC', 'biggestPC' );
 
-sub import { #{{{
+sub import {
+       hook(type => "getsetup", id => "pagestats", call => \&getsetup);
        hook(type => "preprocess", id => "pagestats", call => \&preprocess);
-} # }}}
+}
 
-sub preprocess (@) { #{{{
+sub getsetup () {
+       return 
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+}
+
+sub preprocess (@) {
        my %params=@_;
        $params{pages}="*" unless defined $params{pages};
        my $style = ($params{style} or 'cloud');
        
-       # Needs to update whenever a page is added or removed, so
-       # register a dependency.
-       add_depends($params{page}, $params{pages});
+       # Needs to update whenever a page is added or removed.
+       add_depends($params{page}, $params{pages}, exists => 1);
+       # Also needs to update when any page with links changes, 
+       # in case the links point to our displayed pages.
+       # (Amoung limits this further.)
+       add_depends($params{page}, exists $params{among} ? $params{among} : "*",
+               links => 1); 
        
        my %counts;
        my $max = 0;
-       foreach my $page (keys %links) {
-               if (pagespec_match($page, $params{pages}, location => $params{page})) {
-                       use IkiWiki::Render;
-                       my @bl = IkiWiki::backlinks($page);
-                       $counts{$page} = scalar(@bl);
-                       $max = $counts{$page} if $counts{$page} > $max;
+       foreach my $page (pagespec_match_list([keys %links],
+                       $params{pages}, location => $params{page})) {
+               use IkiWiki::Render;
+
+               my @backlinks = IkiWiki::backlink_pages($page);
+
+               if (exists $params{among}) {
+                       @backlinks = pagespec_match_list(\@backlinks,
+                               $params{among}, location => $params{page});
                }
+
+               $counts{$page} = scalar(@backlinks);
+               $max = $counts{$page} if $counts{$page} > $max;
        }
 
        if ($style eq 'table') {
@@ -50,11 +69,14 @@ sub preprocess (@) { #{{{
                        }
                        sort { $counts{$b} <=> $counts{$a} } keys %counts).
                        "\n</table>\n" ;
-       } else {
+       }
+       else {
                # In case of misspelling, default to a page cloud
 
                my $res = "<div class='pagecloud'>\n";
                foreach my $page (sort keys %counts) {
+                       next unless $counts{$page} > 0;
+
                        my $class = $classes[$counts{$page} * scalar(@classes) / ($max + 1)];
                        $res .= "<span class=\"$class\">".
                                htmllink($params{page}, $params{destpage}, $page).
@@ -64,6 +86,6 @@ sub preprocess (@) { #{{{
 
                return $res;
        }
-} # }}}
+}
 
 1