2 rcs_id('$Id: IncludePage.php,v 1.30 2008-07-02 17:48:01 vargenau Exp $');
4 Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * IncludePage: include text from another wiki page in this one
26 * usage: <?plugin IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6?>
27 * author: Joe Edelman <joe@orbis-tertius.net>
30 class WikiPlugin_IncludePage
34 return _("IncludePage");
37 function getDescription() {
38 return _("Include text from another wiki page.");
41 function getVersion() {
42 return preg_replace("/[Revision: $]/", '',
43 "\$Revision: 1.30 $");
46 function getDefaultArguments() {
47 return array( 'page' => false, // the page to include
48 'rev' => false, // the revision (defaults to most recent)
49 'quiet' => false, // if set, inclusion appears as normal content
50 'bytes' => false, // maximum number of bytes to include
51 'words' => false, // maximum number of words to include
52 'lines' => false, // maximum number of lines to include
53 'sections' => false, // maximum number of sections to include
54 'section' => false, // include a named section
55 'sectionhead' => false // when including a named section show the heading
59 function getWikiPageLinks($argstr, $basepage) {
60 extract($this->getArgs($argstr));
63 // Expand relative page names.
64 $page = new WikiPageName($page, $basepage);
66 if (!$page or !$page->name)
68 return array(array('linkto' => $page->name, 'relation' => 0));
71 function run($dbi, $argstr, &$request, $basepage) {
72 $args = $this->getArgs($argstr, $request);
75 // Expand relative page names.
76 $page = new WikiPageName($page, $basepage);
80 return $this->error(_("no page specified"));
83 // A page can include itself once (this is needed, e.g., when editing
84 // TextFormattingRules).
85 static $included_pages = array();
86 if (in_array($page, $included_pages)) {
87 return $this->error(sprintf(_("recursive inclusion of page %s ignored"),
91 $p = $dbi->getPage($page);
93 $r = $p->getRevision($rev);
95 return $this->error(sprintf(_("%s(%d): no such revision"),
99 $r = $p->getCurrentRevision();
101 $c = $r->getContent();
104 if (preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(\w+)\s+\?'.'>/',
105 implode("\n", $c), $m))
107 // trap recursive redirects
108 if (in_array($m[1], $included_pages)) {
109 return $this->error(sprintf(_("recursive inclusion of page %s ignored"),
110 $page.' => '.$m[1]));
113 $p = $dbi->getPage($page);
114 $r = $p->getCurrentRevision();
115 $c = $r->getContent(); // array of lines
118 $ct = $this->extractParts ($c, $page, $args);
120 array_push($included_pages, $page);
122 include_once('lib/BlockParser.php');
123 $content = TransformText($ct, $r->get('markup'), $page);
125 array_pop($included_pages);
130 return HTML(HTML::p(array('class' => 'transclusion-title'),
131 fmt("Included from %s", WikiLink($page))),
133 HTML::div(array('class' => 'transclusion'),
138 * handles the arguments: section, sectionhead, lines, words, bytes,
139 * for UnfoldSubpages, IncludePage, ...
141 function extractParts ($c, $pagename, $args) {
145 $c = extractSection($section, $c, $pagename, $quiet,
148 $c = array_slice($c, 0, $lines);
149 $c[] = sprintf(_(" ... first %d lines"), $lines);
152 $c = firstNWordsOfContent($words, $c);
155 $ct = implode("\n", $c); // one string
156 if (strlen($ct) > $bytes) {
157 $ct = substr($c, 0, $bytes);
158 $c = array($ct, sprintf(_(" ... first %d bytes"), $bytes));
161 $ct = implode("\n", $c); // one string
166 // This is an excerpt from the css file I use:
168 // .transclusion-title {
169 // font-style: oblique;
170 // font-size: 0.75em;
171 // text-decoration: underline;
172 // text-align: right;
175 // DIV.transclusion {
176 // background: lightgreen;
178 // border-style: solid;
179 // padding-left: 0.8em;
180 // padding-right: 0.8em;
182 // padding-bottom: 0px;
183 // margin: 0.5ex 0px;
187 // - line & word limit doesn't work if the included page itself
191 // $Log: not supported by cvs2svn $
192 // Revision 1.29 2007/06/03 21:58:51 rurban
193 // Fix for Bug #1713784
194 // Includes this patch and a refactoring.
195 // RedirectTo is still not handled correctly.
197 // Revision 1.28 2006/04/17 17:28:21 rurban
198 // honor getWikiPageLinks change linkto=>relation
200 // Revision 1.27 2004/11/17 20:07:18 rurban
203 // Revision 1.26 2004/09/25 16:35:09 rurban
204 // use stdlib firstNWordsOfContent, extractSection
206 // Revision 1.25 2004/07/08 20:30:07 rurban
207 // plugin->run consistency: request as reference, added basepage.
208 // encountered strange bug in AllPages (and the test) which destroys ->_dbi
210 // Revision 1.24 2004/02/17 12:11:36 rurban
211 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
213 // Revision 1.23 2003/03/25 21:01:52 dairiki
214 // Remove debugging cruft.
216 // Revision 1.22 2003/03/13 18:57:56 dairiki
217 // Hack so that (when using the IncludePage plugin) the including page shows
218 // up in the BackLinks of the included page.
220 // Revision 1.21 2003/02/21 04:12:06 dairiki
221 // Minor fixes for new cached markup.
223 // Revision 1.20 2003/01/18 21:41:02 carstenklapp
225 // Reformatting & tabs to spaces;
226 // Added copyleft, getVersion, getDescription, rcs_id.
234 // c-hanging-comment-ender-p: nil
235 // indent-tabs-mode: nil