]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/pagestats.pm
prune: do not prune beyond an optional base directory, and add a test
[ikiwiki.git] / IkiWiki / Plugin / pagestats.pm
index 34fd11715d24e03fa7012023a97c1aef7d86d13d..17b26f7baa75ed3b3e68c95f310f6821227d0c89 100644 (file)
 #          (default)
 #   table: produces a table with the number of backlinks for each page
 #
-# By Enrico Zini.
+# by Enrico Zini
 package IkiWiki::Plugin::pagestats;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 3.00;
 
 # Names of the HTML classes to use for the tag cloud
 our @classes = ('smallestPC', 'smallPC', 'normalPC', 'bigPC', 'biggestPC' );
 
-sub import { #{{{
-       IkiWiki::hook(type => "preprocess", id => "pagestats",
-               call => \&preprocess);
-} # }}}
+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,
+                       section => "widget",
+               },
+}
+
+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.
-       IkiWiki::add_depends($params{page}, $params{pages});
-       
        my %counts;
        my $max = 0;
-       foreach my $page (%IkiWiki::links) {
-               if (IkiWiki::globlist_match($page, $params{pages})) {
-                       my @bl = IkiWiki::backlinks($page);
-                       $counts{$page} = scalar(@bl);
-                       $max = $counts{$page} if $counts{$page} > $max;
+       foreach my $page (pagespec_match_list($params{page}, $params{pages},
+                                 # update when a displayed page is added/removed
+                                 deptype => deptype("presence"))) {
+               use IkiWiki::Render;
+
+               my @backlinks = IkiWiki::backlink_pages($page);
+
+               if (exists $params{among}) {
+                       # only consider backlinks from the amoung pages
+                       @backlinks = pagespec_match_list(
+                               $params{page}, $params{among},
+                               # update whenever links on those pages change
+                               deptype => deptype("links"),
+                               list => \@backlinks
+                       );
+               }
+               else {
+                       # update when any page with links changes,
+                       # in case the links point to our displayed pages
+                       add_depends($params{page}, "*", deptype("links"));
+               }
+
+               $counts{$page} = scalar(@backlinks);
+               $max = $counts{$page} if $counts{$page} > $max;
+       }
+
+       if (exists $params{show}) {
+               my $i=0;
+               my %show;
+               foreach my $key (sort { $counts{$b} <=> $counts{$a} } keys %counts) {
+                       last if ++$i > $params{show};
+                       $show{$key}=$counts{$key};
                }
+               %counts=%show;
        }
 
        if ($style eq 'table') {
-               return "<table class='pageStats'>\n".join("\n", map { "<tr><td>$_</td><td>".$counts{$_}."</td></tr>" }
-                     sort { $counts{$b} <=> $counts{$a} } keys %counts)."\n</table>\n" ;
-       } else {
+               return "<table class='".(exists $params{class} ? $params{class} : "pageStats")."'>\n".
+                       join("\n", map {
+                               "<tr><td>".
+                               htmllink($params{page}, $params{destpage}, $_, noimageinline => 1).
+                               "</td><td>".$counts{$_}."</td></tr>"
+                       }
+                       sort { $counts{$b} <=> $counts{$a} } keys %counts).
+                       "\n</table>\n" ;
+       }
+       else {
                # In case of misspelling, default to a page cloud
 
-               my $res = "<div class='pagecloud'>\n";
+               my $res;
+               if ($style eq 'list') {
+                       $res = "<ul class='".(exists $params{class} ? $params{class} : "list")."'>\n";
+               }
+               else {
+                       $res = "<div class='".(exists $params{class} ? $params{class} : "pagecloud")."'>\n";
+               }
                foreach my $page (sort keys %counts) {
+                       next unless $counts{$page} > 0;
+
                        my $class = $classes[$counts{$page} * scalar(@classes) / ($max + 1)];
-                       my $link = IkiWiki::abs2rel(IkiWiki::htmlpage($page), IkiWiki::dirname($params{page}));
-                       $res .= sprintf("<span class='%s'><a href='%s'>%s</a></span>\n",
-                                       $class, $link, $page);
-                               
+                       
+                       $res.="<li>" if $style eq 'list';
+                       $res .= "<span class=\"$class\">".
+                               htmllink($params{page}, $params{destpage}, $page).
+                               "</span>\n";
+                       $res.="</li>" if $style eq 'list';
+
+               }
+               if ($style eq 'list') {
+                       $res .= "</ul>\n";
+               }
+               else {
+                       $res .= "</div>\n";
                }
-               $res .= "</div>\n";
 
                return $res;
        }
-} # }}}
+}
 
 1