3d1e3764d9f8fd110e0a9d06044e8c90c8864409
[ikiwiki.git] / IkiWiki / Plugin / pedigree.pm
1 #!/usr/bin/perl
2 # -*- cperl-indent-level: 8; -*-
3 # Ikiwiki pedigree plugin.
4 package IkiWiki::Plugin::pedigree;
5
6 use warnings;
7 use strict;
8 use IkiWiki 2.00;
9
10 sub import { #{{{
11         hook(type => "pagetemplate", id => "pedigree", call => \&pagetemplate);
12 } # }}}
13
14 sub pedigree ($) { #{{{
15         my $page=shift;
16
17         my @ret;
18         my $path="";
19         my $title=$config{wikiname};
20         my $i=0;
21
22         my @pagepath=(split("/", $page));
23         my $pagedepth=@pagepath;
24         foreach my $dir (@pagepath) {
25                 next if $dir eq 'index';
26                 push @ret, {
27                             url => urlto($path, $page),
28                             page => $title,
29                             absdepth => $i,
30                             is_root => ($i eq 0),
31                             is_second_ancestor => ($i eq 1),
32                             is_grand_mother => ($i eq ($pagedepth - 2)),
33                             is_mother => ($i eq ($pagedepth - 1)),
34                            };
35                 $path.="/".$dir;
36                 $title=IkiWiki::pagetitle($dir);
37                 $i++;
38         }
39         return @ret;
40 } #}}}
41
42 sub forget_oldest ($@) { #{{{
43         my $offset=shift;
44         my @pedigree=@_;
45         my @ret;
46         my $parent;
47         unless ($offset ge scalar(@pedigree)) {
48                 for (my $i=0; $i < $offset; $i++) {
49                         shift @pedigree;
50                 }
51                 while (@pedigree) {
52                         # Doing so does not modify the original @pedigree, we've
53                         # got our own copy of its "content" (i.e. a pile of
54                         # references to hashes)...
55                         $parent=shift @pedigree;
56                         # ... but we have no copy of the referenced hashes, so we
57                         # actually are modifying them in-place, but we don't care
58                         # here since reldepth has to be computed everytime anyway.
59                         $parent->{reldepth}=($parent->{absdepth} - $offset);
60                         push @ret, $parent;
61                 }
62         }
63         return @ret;
64 } #}}}
65
66 sub pagetemplate (@) { #{{{
67         my %params=@_;
68         my $page=$params{page};
69         my $template=$params{template};
70
71         if ($template->query(name => "pedigree")
72             or $template->query(name => "pedigree_but_root")
73             or $template->query(name => "pedigree_but_two_oldest")
74            )
75           {
76                   my @pedigree=pedigree($page);
77                   $template->param(pedigree => \@pedigree);
78                   $template->param(pedigree_but_root => [forget_oldest(1, @pedigree)]);
79                   $template->param(pedigree_but_two_oldest => [forget_oldest(2, @pedigree)]);
80           }
81
82 } # }}}
83
84 1