modules/olocalmap.pl

   1 # Copyright (C) 2005  Flavio Poletti <flavio@polettix.it>
   2 #
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 2 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program; if not, write to the
  15 #    Free Software Foundation, Inc.
  16 #    59 Temple Place, Suite 330
  17 #    Boston, MA 02111-1307 USA
  18
  19 # This module adds an action and a link in the UserGotoBar to build
  20 # a Local Site Map starting from the current page. The map is a sort
  21 # of Table Of Contents in which the current page is considered the
  22 # root of the document.
  23 #
  24 # Basic idea got from MoinMoin.
  25
  26
  27 ##########################################################################
  28 #
  29 # End-user capabilities
  30 #
  31 ##########################################################################
  32 # Actions
  33 $Action{'localmap'} = \&DoLocalMap;
  34
  35 # Variables
  36 use vars qw($LocalMapDefaultDepth);
  37 $LocalMapDefaultDepth = 3 unless defined $LocalMapDefaultDepth;
  38
  39
  40 ##########################################################################
  41 #
  42 # Implementation
  43 #
  44 ##########################################################################
  45 $ModulesDescription .= '<p>$Id $: build a Local Site Map from a page, using references as sub-sections</p>';
  46
  47 push(@MyInitVariables, \&InitLocalMap);
  48
  49 sub InitLocalMap {
  50    my $id = GetCurrentPageName();
  51    my $action = lc(GetParam('action', ''));
  52    AllPagesList();              # Build %IndexHash
  53
  54    # Avoid putting stuff in non-pages (like RecentChanges) and in
  55    # the page result of the action
  56    return 0 unless (length($id)
  57                     && $IndexHash{$id}
  58                     && ($action cmp 'localmap'));
  59
  60    # Add a link to the list of parents
  61    $UserGotoBar .= ScriptLink("action=localmap;id=$id", T('LocalMap')) . ' ';
  62 }
  63
  64 sub DoLocalMap {
  65    my $id = GetParam('id', '');
  66    MyReportError(T('No page id for action localmap'), '400 BAD REQUEST',
  67                  undef, GetParam('raw', 0))
  68      unless length($id);
  69
  70    AllPagesList();              # Build %IndexHash
  71    MyReportError(Ts('Requested page %s does not exist', $id),
  72                  '503 SERVICE UNAVAILABLE', undef, GetParam('raw', 0))
  73      unless ($IndexHash{FreeToNormal($id)});
  74
  75    print GetHeader('', QuoteHtml(Ts('Local Map for %s', $id)), '');
  76
  77    my $depth = GetParam('depth', $LocalMapDefaultDepth);
  78    $id = FreeToNormal($id);
  79    my %got;                     # Tracks already hit pages
  80    print($q->ul(LocalMapWorkHorse($id, $depth, \%got)));
  81    PrintFooter();
  82 }
  83
  84 sub LocalMapWorkHorse {
  85    my ($id, $depth, $GotPagesRef) = @_;
  86
  87    $GotPagesRef->{$id} = $depth;
  88    return '' unless exists($IndexHash{$id});
  89    my $name = $id;
  90    $name =~ s/_/ /g;
  91
  92    my $retval_me .= ScriptLink("action=localmap;id=" . UrlEncode($id), $name);
  93    $retval_me .= ' (' . GetPageLink($id, T('view')) . ')';
  94    my $retval_me = $q->li($retval_me);
  95
  96    my $retval_children = '';
  97    if ($depth > 0) {
  98       my %data = ParseData(ReadFileOrDie(GetPageFile($id)));
  99       my @flags = split(/$FS/, $data{'flags'});
 100       my @blocks = split(/$FS/, $data{'blocks'});
 101       my @subpages;
 102
 103       # Iterate over blocks, operate only on "dirty" ones
 104       for (my $i = 0; $i < @flags; ++$i) {
 105          next unless $flags[$i];
 106          my $sub_id;
 107          local $_ = $blocks[$i];
 108
 109          if ($WikiLinks
 110              && ($BracketWiki && m/\G(\[$LinkPattern\s+([^\]]+?)\])/cog
 111                  or m/\G(\[$LinkPattern\])/cog or m/\G($LinkPattern)/cog)) {
 112             $sub_id = $1;
 113          } elsif ($FreeLinks
 114                   && (($BracketWiki
 115                        && m/\G(\[\[($FreeLinkPattern)\|([^\]]+)\]\])/cog)
 116                       or m/\G(\[\[\[($FreeLinkPattern)\]\]\])/cog
 117                       or m/\G(\[\[($FreeLinkPattern)\]\])/cog)) {
 118             $sub_id = $2;
 119          }
 120
 121          if ($sub_id) {
 122             $sub_id = FreeToNormal($sub_id);
 123             if (exists $IndexHash{$sub_id}
 124                 && ! exists $GotPagesRef->{$sub_id}) {
 125                push(@subpages, $sub_id);
 126                $GotPagesRef->{$sub_id} = $depth - 1;
 127             }
 128          }
 129       }
 130
 131       # Recollect. We cannot do it inside the for loop because otherwise
 132       # we would spoil the hash pointed by $GotPagesRef
 133       foreach my $sub_id (@subpages) {
 134          $retval_children .=
 135            LocalMapWorkHorse($sub_id, $depth - 1, $GotPagesRef);
 136       }
 137
 138       # Enclose all inside an unnumbered list
 139       $retval_children = $q->ul($retval_children) if length($retval_children);
 140    }
 141
 142    # Return the two sections
 143    return $retval_me . $retval_children;
 144 }