]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/pagestats.pm
po: report bug + test case + proposed fix
[git.ikiwiki.info.git] / IkiWiki / Plugin / pagestats.pm
index 0958f5af6f173e673aa25f0109c0e80ee91aa08a..304ddd1c826e95f86d9dbfe139626852149e482c 100644 (file)
@@ -12,57 +12,128 @@ 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 { #{{{
+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 linktext ($%) {
+       # Return the text of the link to a tag, depending on option linktext.
+       my ($page, %params) = @_;
+       if (exists $params{show} &&
+               exists $pagestate{$page} &&
+               exists $pagestate{$page}{meta}{$params{show}}) {
+               return $pagestate{$page}{meta}{$params{show}};
+       }
+       else {
+               return 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});
-       
+
+       # Backwards compatibility
+       if (defined $params{show} && $params{show} =~ m/^\d+$/) {
+               $params{limit} = $params{show};
+               delete $params{show};
+       }
+
        my %counts;
        my $max = 0;
-       foreach my $page (keys %links) {
-               if (pagespec_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{limit}) {
+               my $i=0;
+               my %show;
+               foreach my $key (sort { $counts{$b} <=> $counts{$a} || $a cmp $b } keys %counts) {
+                       last if ++$i > $params{limit};
+                       $show{$key}=$counts{$key};
+               }
+               %counts=%show;
        }
 
        if ($style eq 'table') {
-               return "<table class='pageStats'>\n".
+               return "<table class='".(exists $params{class} ? $params{class} : "pageStats")."'>\n".
                        join("\n", map {
                                "<tr><td>".
-                               htmllink($params{page}, $params{destpage}, $_, 1).
+                               htmllink($params{page}, $params{destpage}, $_, noimageinline => 1, linktext => linktext($_, %params)).
                                "</td><td>".$counts{$_}."</td></tr>"
                        }
-                       sort { $counts{$b} <=> $counts{$a} } keys %counts).
+                       sort { $counts{$b} <=> $counts{$a} || $a cmp $b } keys %counts).
                        "\n</table>\n" ;
-       } else {
+       }
+       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)];
+                       
+                       $res.="<li>" if $style eq 'list';
                        $res .= "<span class=\"$class\">".
-                               htmllink($params{page}, $params{destpage}, $page).
+                                                       htmllink($params{page}, $params{destpage}, $page, linktext => linktext($page, %params)).
                                "</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