summaryrefslogtreecommitdiff
path: root/IkiWiki/Plugin/map.pm
blob: 4a89fbc35ffc738ddf078c9bbc439a9251c31f3b (plain)
  1. #!/usr/bin/perl
  2. #
  3. # Produce a hierarchical map of links.
  4. #
  5. # by Alessandro Dotti Contra <alessandro@hyboria.org>
  6. #
  7. # Revision: 0.2
  8. package IkiWiki::Plugin::map;
  9. use warnings;
  10. use strict;
  11. use IkiWiki 2.00;
  12. sub import { #{{{
  13. hook(type => "getsetup", id => "map", call => \&getsetup);
  14. hook(type => "preprocess", id => "map", call => \&preprocess);
  15. } # }}}
  16. sub getsetup () { #{{{
  17. return
  18. plugin => {
  19. safe => 1,
  20. rebuild => undef,
  21. },
  22. } #}}}
  23. sub preprocess (@) { #{{{
  24. my %params=@_;
  25. $params{pages}="*" unless defined $params{pages};
  26. my $common_prefix;
  27. # Get all the items to map.
  28. my %mapitems;
  29. foreach my $page (keys %pagesources) {
  30. if (pagespec_match($page, $params{pages}, location => $params{page})) {
  31. if (exists $params{show} &&
  32. exists $pagestate{$page} &&
  33. exists $pagestate{$page}{meta}{$params{show}}) {
  34. $mapitems{$page}=$pagestate{$page}{meta}{$params{show}};
  35. }
  36. else {
  37. $mapitems{$page}='';
  38. }
  39. # Check for a common prefix.
  40. if (! defined $common_prefix) {
  41. $common_prefix=$page;
  42. }
  43. elsif (length $common_prefix &&
  44. $page !~ /^\Q$common_prefix\E(\/|$)/) {
  45. my @a=split(/\//, $page);
  46. my @b=split(/\//, $common_prefix);
  47. $common_prefix="";
  48. while (@a && @b && $a[0] eq $b[0]) {
  49. if (length $common_prefix) {
  50. $common_prefix.="/";
  51. }
  52. $common_prefix.=shift(@a);
  53. shift @b;
  54. }
  55. }
  56. }
  57. }
  58. # Common prefix should not be a page in the map.
  59. while (defined $common_prefix && length $common_prefix &&
  60. exists $mapitems{$common_prefix}) {
  61. $common_prefix=IkiWiki::dirname($common_prefix);
  62. }
  63. # Needs to update whenever a page is added or removed (or in some
  64. # cases, when its content changes, if show=title), so register a
  65. # dependency.
  66. add_depends($params{page}, $params{pages});
  67. # Explicitly add all currently shown pages, to detect when pages
  68. # are removed.
  69. add_depends($params{page}, join(" or ", keys %mapitems));
  70. # Create the map.
  71. my $parent="";
  72. my $indent=0;
  73. my $openli=0;
  74. my $dummy=0;
  75. my $map = "<div class='map'>\n<ul>\n";
  76. foreach my $item (sort keys %mapitems) {
  77. my @linktext = (length $mapitems{$item} ? (linktext => $mapitems{$item}) : ());
  78. $item=~s/^\Q$common_prefix\E\///
  79. if defined $common_prefix && length $common_prefix;
  80. my $depth = ($item =~ tr/\//\//) + 1;
  81. my $baseitem=IkiWiki::dirname($item);
  82. while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E(\/|$)/) {
  83. $parent=IkiWiki::dirname($parent);
  84. last if !$dummy && length $parent && $baseitem =~ /^\Q$parent\E(\/|$)/;
  85. $indent--;
  86. $map .= "</li>\n";
  87. if ($indent > 0) {
  88. $map .= "</ul>\n";
  89. }
  90. }
  91. $dummy=0;
  92. while ($depth < $indent) {
  93. $indent--;
  94. $map .= "</li>\n";
  95. if ($indent > 0) {
  96. $map .= "</ul>\n";
  97. }
  98. }
  99. my @bits=split("/", $item);
  100. my $p="";
  101. $p.="/".shift(@bits) for 1..$indent;
  102. while ($depth > $indent) {
  103. $indent++;
  104. if ($indent > 1) {
  105. $map .= "<ul>\n";
  106. }
  107. if ($depth > $indent) {
  108. $dummy=1;
  109. $p.="/".shift(@bits);
  110. $map .= "<li>"
  111. .htmllink($params{page}, $params{destpage},
  112. $p, class => "mapparent",
  113. noimageinline => 1)
  114. ."\n";
  115. $openli=1;
  116. }
  117. else {
  118. $openli=0;
  119. }
  120. }
  121. $map .= "</li>\n" if $openli;
  122. $map .= "<li>"
  123. .htmllink($params{page}, $params{destpage},
  124. "/".$common_prefix."/".$item,
  125. @linktext,
  126. class => "mapitem", noimageinline => 1)
  127. ."\n";
  128. $openli=1;
  129. $parent=$item;
  130. }
  131. while ($indent > 0) {
  132. $indent--;
  133. $map .= "</li>\n</ul>\n";
  134. }
  135. $map .= "</div>\n";
  136. return $map;
  137. } # }}}
  138. 1