4 * Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
5 * Copyright 2008-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
20 * along with PhpWiki; if not, write to the Free Software
21 * 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: <<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 getDefaultArguments() {
42 return array( 'page' => false, // the page to include
43 'rev' => false, // the revision (defaults to most recent)
44 'quiet' => false, // if set, inclusion appears as normal content
45 'bytes' => false, // maximum number of bytes to include
46 'words' => false, // maximum number of words to include
47 'lines' => false, // maximum number of lines to include
48 'sections' => false, // maximum number of sections to include
49 'section' => false, // include a named section
50 'sectionhead' => false // when including a named section show the heading
54 function getWikiPageLinks($argstr, $basepage) {
55 extract($this->getArgs($argstr));
60 // Expand relative page names.
61 $page = new WikiPageName($page, $basepage);
63 if (!$page or !$page->name)
65 return array(array('linkto' => $page->name, 'relation' => 0));
68 function run($dbi, $argstr, &$request, $basepage) {
69 $args = $this->getArgs($argstr, $request);
72 // Expand relative page names.
73 $page = new WikiPageName($page, $basepage);
77 return $this->error(_("no page specified"));
80 // A page can include itself once (this is needed, e.g., when editing
81 // TextFormattingRules).
82 static $included_pages = array();
83 if (in_array($page, $included_pages)) {
84 return $this->error(sprintf(_("recursive inclusion of page %s ignored"),
88 // Check if page exists
89 if (!($dbi->isWikiPage($page))) {
90 return $this->error(sprintf(_("Page '%s' does not exist"), $page));
93 // Check if user is allowed to get the Page.
94 if (!mayAccessPage ('view', $page)) {
95 return $this->error(sprintf(_("Illegal inclusion of page %s: no read access"),
99 $p = $dbi->getPage($page);
101 $r = $p->getRevision($rev);
103 return $this->error(sprintf(_("%s(%d): no such revision"),
107 $r = $p->getCurrentRevision();
109 $c = $r->getContent();
112 if ((preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(\S+)\s*\?'.'>/', implode("\n", $c), $m))
113 or (preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(.*?)\s*\?'.'>/', implode("\n", $c), $m))
114 or (preg_match('/<<\s*RedirectTo\s+page=(\S+)\s*>>/', implode("\n", $c), $m))
115 or (preg_match('/<<\s*RedirectTo\s+page="(.*?)"\s*>>/', implode("\n", $c), $m)))
117 // Strip quotes (simple or double) from page name if any
118 if ((string_starts_with($m[1], "'"))
119 or (string_starts_with($m[1], "\""))) {
120 $m[1] = substr($m[1], 1, -1);
122 // trap recursive redirects
123 if (in_array($m[1], $included_pages)) {
124 return $this->error(sprintf(_("recursive inclusion of page %s ignored"),
125 $page.' => '.$m[1]));
128 $p = $dbi->getPage($page);
129 $r = $p->getCurrentRevision();
130 $c = $r->getContent(); // array of lines
133 $ct = $this->extractParts ($c, $page, $args);
135 // exclude from expansion
136 if (preg_match('/<noinclude>.+<\/noinclude>/s', $ct)) {
137 $ct = preg_replace("/<noinclude>.+?<\/noinclude>/s", "", $ct);
140 $ct = preg_replace("/<includeonly>(.+)<\/includeonly>/s", "\\1", $ct);
142 array_push($included_pages, $page);
144 include_once('lib/BlockParser.php');
145 $content = TransformText($ct, $r->get('markup'), $page);
147 array_pop($included_pages);
152 return HTML(HTML::p(array('class' => 'transclusion-title'),
153 fmt("Included from %s", WikiLink($page))),
155 HTML::div(array('class' => 'transclusion'),
160 * handles the arguments: section, sectionhead, lines, words, bytes,
161 * for UnfoldSubpages, IncludePage, ...
163 function extractParts ($c, $pagename, $args) {
168 $c = extractSection($section, $c, $pagename, $quiet, 1);
170 $c = extractSection($section, $c, $pagename, $quiet, $sectionhead);
174 $c = extractSections($sections, $c, $pagename, $quiet, 1);
177 $c = array_slice($c, 0, $lines);
178 $c[] = sprintf(_(" ... first %d lines"), $lines);
181 $c = firstNWordsOfContent($words, $c);
184 $ct = implode("\n", $c); // one string
185 if (strlen($ct) > $bytes) {
186 $ct = substr($c, 0, $bytes);
187 $c = array($ct, sprintf(_(" ... first %d bytes"), $bytes));
190 $ct = implode("\n", $c); // one string
195 // This is an excerpt from the css file I use:
197 // .transclusion-title {
198 // font-style: oblique;
199 // font-size: 0.75em;
200 // text-decoration: underline;
201 // text-align: right;
204 // DIV.transclusion {
205 // background: lightgreen;
207 // border-style: solid;
208 // padding-left: 0.8em;
209 // padding-right: 0.8em;
211 // padding-bottom: 0px;
212 // margin: 0.5ex 0px;
219 // c-hanging-comment-ender-p: nil
220 // indent-tabs-mode: nil