lib/plugin/PageGroup.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /**
   4  * Copyright 1999,2000,2001,2002,2004 $ThePhpWikiProgrammingTeam
   5  * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
   6  *
   7  * This file is part of PhpWiki.
   8  *
   9  * PhpWiki is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * PhpWiki is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with PhpWiki; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /**
  25  * Usage:
  26  *
  27  * <<PageGroup parent=MyTableOfContents >>
  28  *
  29  * <<PageGroup
  30  *          parent=MyTableOfContents
  31  *          label="Visit more pages in MyTableOfContents"
  32  * >>
  33  *
  34  * <<PageGroup parent=MyTableOfContents section=PartTwo loop=true >>
  35  *
  36  * <<PageGroup parent=MyTableOfContents loop=1 >>
  37  *
  38  *
  39  * Updated to use new HTML(). It mostly works, but it's still a giant hackish mess.
  40  */
  41 class WikiPlugin_PageGroup
  42 extends WikiPlugin
  43 {
  44     function getName() {
  45         return _("PageGroup");
  46     }
  47
  48     function getDescription() {
  49         return sprintf(_("PageGroup for %s"),'[pagename]');
  50     }
  51
  52     function getDefaultArguments() {
  53         return array(
  54                      'parent'  => '',
  55                      'rev'     => false,
  56                      'section' => _("Contents"),
  57                      'label'   => '',
  58                      'loop'    => false,
  59                      );
  60     }
  61
  62     // Stolen from IncludePage.php
  63     function extractGroupSection ($section, $content, $page) {
  64         $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
  65         if (preg_match("/ ^(!{1,})\\s*$qsection" // section header
  66                        . "  \\s*$\\n?"           // possible blank lines
  67                        . "  ( (?: ^.*\\n? )*? )" // some lines
  68                        . "  (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
  69                        implode("\n", $content),
  70                        $match)) {
  71             $result = array();
  72             //FIXME: return list of Wiki_Pagename objects
  73             foreach (explode("\n", $match[2]) as $line) {
  74                     $text = trim($line);
  75                 // Strip trailing blanks lines and ---- <hr>s
  76                 $text = preg_replace("/\\s*^-{4,}\\s*$/", "", $text);
  77                 // Strip leading list chars: * or #
  78                 $text = preg_replace("/^[\*#]+\s*(\S.+)$/", "\\1", $text);
  79                 // Strip surrounding []
  80                 // FIXME: parse [ name | link ]
  81                 $text = preg_replace("/^\[\s*(\S.+)\s*\]$/", "\\1", $text);
  82                 if (!empty($text))
  83                     $result[] = $text;
  84             }
  85             return $result;
  86         }
  87         return array(sprintf(_("<%s: no such section>"), $page ." ". $section));
  88     }
  89
  90     function run($dbi, $argstr, &$request, $basepage) {
  91
  92         $args = $this->getArgs($argstr, $request);
  93         extract($args);
  94         if (empty($parent)) {
  95             // FIXME: WikiPlugin has no way to report when
  96             // required args are missing?
  97             $error_text = sprintf("%s: ", "WikiPlugin_" .$this->getName());
  98             $error_text .= sprintf(_("A required argument '%s' is missing."), 'parent');
  99             return HTML::div(array('class' => "error"), $error_text);
 100         }
 101         $directions = array ('next'     => _("Next"),
 102                              'previous' => _("Previous"),
 103                              'contents' => _("Contents"),
 104                              'first'    => _("First"),
 105                              'last'     => _("Last")
 106                              );
 107
 108         global $WikiTheme;
 109         $sep = $WikiTheme->getButtonSeparator();
 110         if (!$sep)
 111             $sep = " | "; // force some kind of separator
 112
 113         // default label
 114         if (!$label)
 115             $label = $WikiTheme->makeLinkButton($parent);
 116
 117         // This is where the list extraction occurs from the named
 118         // $section on the $parent page.
 119
 120         $p = $dbi->getPage($parent);
 121         if ($rev) {
 122             $r = $p->getRevision($rev);
 123             if ((!$r) || ($r->hasDefaultContents())) {
 124                 return $this->error(sprintf(_("%s: no such revision %d."),
 125                                             $parent, $rev));
 126             }
 127         } else {
 128             $r = $p->getCurrentRevision();
 129         }
 130
 131         $c = $r->getContent();
 132         $c = $this->extractGroupSection($section, $c, $parent);
 133
 134         $pagename = $request->getArg('pagename');
 135
 136         // The ordered list of page names determines the page
 137         // ordering. Right now it doesn't work with a WikiList, only
 138         // normal lines of text containing the page names.
 139
 140         $thispage = array_search($pagename, $c);
 141
 142         $go = array ('previous','next');
 143         $links = HTML();
 144         $links->pushcontent($label);
 145         $links->pushcontent(" [ "); // an experiment
 146         $lastindex = count($c) - 1; // array is 0-based, count is 1-based!
 147
 148         foreach ( $go as $go_item ) {
 149             //yuck this smells, needs optimization.
 150             if ($go_item == 'previous') {
 151                 if ($loop) {
 152                     if ($thispage == 0) {
 153                         $linkpage  = $c[$lastindex];
 154                     } else {
 155                         $linkpage  = $c[$thispage - 1];
 156                     }
 157                     // mind the French : punctuation
 158                     $text = fmt("%s: %s", $directions[$go_item],
 159                                 $WikiTheme->makeLinkButton($linkpage));
 160                     $links->pushcontent($text);
 161                     $links->pushcontent($sep); // this works because
 162                                                // there are only 2 go
 163                                                // items, previous,next
 164                 } else {
 165                     if ($thispage == 0) {
 166                         // skip it
 167                     } else {
 168                         $linkpage  = $c[$thispage - 1];
 169                         $text = fmt("%s: %s", $directions[$go_item],
 170                                     $WikiTheme->makeLinkButton($linkpage));
 171                         $links->pushcontent($text);
 172                         $links->pushcontent($sep); //this works
 173                                                    //because there are
 174                                                    //only 2 go items,
 175                                                    //previous,next
 176                     }
 177                 }
 178             } else if ($go_item == 'next') {
 179                 if ($loop) {
 180                     if ($thispage == $lastindex) {
 181                         $linkpage  = $c[1];
 182                     } else {
 183                         $linkpage  = $c[$thispage + 1];
 184                     }
 185                     $text = fmt("%s: %s", $directions[$go_item],
 186                                 $WikiTheme->makeLinkButton($linkpage));
 187                 } else {
 188                     if ($thispage == $lastindex) {
 189                         // skip it
 190                     } else {
 191                         $linkpage = $c[$thispage + 1];
 192                         $text = fmt("%s: %s", $directions[$go_item],
 193                                     $WikiTheme->makeLinkButton($linkpage));
 194                     }
 195                 }
 196                 $links->pushcontent($text);
 197             }
 198         }
 199         $links->pushcontent(" ] "); // an experiment
 200         return $links;
 201     }
 202 };
 203
 204 // Local Variables:
 205 // mode: php
 206 // tab-width: 8
 207 // c-basic-offset: 4
 208 // c-hanging-comment-ender-p: nil
 209 // indent-tabs-mode: nil
 210 // End:
 211 ?>