4 * Copyright 1999,2000,2001,2002,2004 $ThePhpWikiProgrammingTeam
5 * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
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.
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.
19 * You should have received a copy of the GNU General Public License along
20 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * <<PageGroup parent=MyTableOfContents >>
30 * parent=MyTableOfContents
31 * label="Visit more pages in MyTableOfContents"
34 * <<PageGroup parent=MyTableOfContents section=PartTwo loop=true >>
36 * <<PageGroup parent=MyTableOfContents loop=1 >>
39 * Updated to use new HTML(). It mostly works, but it's still a giant hackish mess.
41 class WikiPlugin_PageGroup
46 return _("PageGroup");
49 function getDescription()
51 return sprintf(_("PageGroup for %s."), '[pagename]');
54 function getDefaultArguments()
59 'section' => _("Contents"),
65 // Stolen from IncludePage.php
66 function extractGroupSection($section, $content, $page)
68 $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
69 if (preg_match("/ ^(!{1,})\\s*$qsection" // section header
70 . " \\s*$\\n?" // possible blank lines
71 . " ( (?: ^.*\\n? )*? )" // some lines
72 . " (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
73 implode("\n", $content),
77 //FIXME: return list of Wiki_Pagename objects
78 foreach (explode("\n", $match[2]) as $line) {
80 // Strip trailing blanks lines and ---- <hr>s
81 $text = preg_replace("/\\s*^-{4,}\\s*$/", "", $text);
82 // Strip leading list chars: * or #
83 $text = preg_replace("/^[\*#]+\s*(\S.+)$/", "\\1", $text);
84 // Strip surrounding []
85 // FIXME: parse [ name | link ]
86 $text = preg_replace("/^\[\s*(\S.+)\s*\]$/", "\\1", $text);
92 return array(sprintf(_("<%s: no such section>"), $page . " " . $section));
95 function run($dbi, $argstr, &$request, $basepage)
98 $args = $this->getArgs($argstr, $request);
100 if (empty($parent)) {
101 return $this->error(sprintf(_("A required argument ā%sā is missing."), 'parent'));
103 $directions = array('next' => _("Next"),
104 'previous' => _("Previous"),
105 'contents' => _("Contents"),
106 'first' => _("First"),
111 $sep = $WikiTheme->getButtonSeparator();
113 $sep = " | "; // force some kind of separator
117 $label = $WikiTheme->makeLinkButton($parent);
119 // This is where the list extraction occurs from the named
120 // $section on the $parent page.
122 $p = $dbi->getPage($parent);
124 $r = $p->getRevision($rev);
125 if ((!$r) || ($r->hasDefaultContents())) {
126 return $this->error(sprintf(_("%s: no such revision %d."),
130 $r = $p->getCurrentRevision();
133 $c = $r->getContent();
134 $c = $this->extractGroupSection($section, $c, $parent);
136 $pagename = $request->getArg('pagename');
138 // The ordered list of page names determines the page
139 // ordering. Right now it doesn't work with a WikiList, only
140 // normal lines of text containing the page names.
142 $thispage = array_search($pagename, $c);
144 $go = array('previous', 'next');
146 $links->pushcontent($label);
147 $links->pushcontent(" [ "); // an experiment
148 $lastindex = count($c) - 1; // array is 0-based, count is 1-based!
150 foreach ($go as $go_item) {
151 //yuck this smells, needs optimization.
152 if ($go_item == 'previous') {
154 if ($thispage == 0) {
155 $linkpage = $c[$lastindex];
157 $linkpage = $c[$thispage - 1];
159 // mind the French : punctuation
160 $text = fmt("%s: %s", $directions[$go_item],
161 $WikiTheme->makeLinkButton($linkpage));
162 $links->pushcontent($text);
163 $links->pushcontent($sep); // this works because
164 // there are only 2 go
165 // items, previous,next
167 if ($thispage == 0) {
170 $linkpage = $c[$thispage - 1];
171 $text = fmt("%s: %s", $directions[$go_item],
172 $WikiTheme->makeLinkButton($linkpage));
173 $links->pushcontent($text);
174 $links->pushcontent($sep); //this works
180 } elseif ($go_item == 'next') {
182 if ($thispage == $lastindex) {
185 $linkpage = $c[$thispage + 1];
187 $text = fmt("%s: %s", $directions[$go_item],
188 $WikiTheme->makeLinkButton($linkpage));
190 if ($thispage == $lastindex) {
193 $linkpage = $c[$thispage + 1];
194 $text = fmt("%s: %s", $directions[$go_item],
195 $WikiTheme->makeLinkButton($linkpage));
198 $links->pushcontent($text);
201 $links->pushcontent(" ] "); // an experiment
210 // c-hanging-comment-ender-p: nil
211 // indent-tabs-mode: nil