4 * Copyright 2005,2007 $ThePhpWikiProgrammingTeam
5 * Copyright 2008-2011 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.
25 * Template: Parametrized blocks.
26 * Include text from a wiki page and replace certain placeholders by parameters.
27 * Similiar to CreatePage with the template argument, but at run-time.
28 * Similiar to the mediawiki templates but not with the "|" parameter seperator.
29 * Usage: <<Template page=TemplateFilm vars="title=rurban&year=1999" >>
31 * See also: http://meta.wikimedia.org/wiki/Help:Template
33 * Parameter expansion:
34 * vars="var1=value1&var2=value2"
35 * We only support named parameters, not numbered ones as in mediawiki, and
36 * the placeholder is %%var%% and not {{{var}}} as in mediawiki.
38 * The following predefined uppercase variables are automatically expanded if existing:
40 * MTIME - last modified date + time
41 * CTIME - creation date + time
42 * AUTHOR - last author
44 * CREATOR - first author
45 * SERVER_URL, DATA_PATH, SCRIPT_NAME, PHPWIKI_BASE_URL and BASE_URL
47 * <noinclude> .. </noinclude> is stripped from the template expansion.
48 * <includeonly> .. </includeonly> is only expanded in pages using the template,
49 * not in the template itself.
51 * We support a mediawiki-style syntax extension which maps
52 * {{TemplateFilm|title=Some Good Film|year=1999}}
54 * <<Template page=TemplateFilm vars="title=Some Good Film&year=1999" >>
57 class WikiPlugin_Template
65 function getDescription()
67 return _("Parametrized page inclusion.");
70 function getDefaultArguments()
73 'page' => false, // the page to include
74 'vars' => false, // TODO: get rid of this, all remaining args should be vars
75 'rev' => false, // the revision (defaults to most recent)
76 'section' => false, // just include a named section
77 'sectionhead' => false // when including a named section show the heading
81 function allow_undeclared_arg($name, $value)
83 // either just allow it or you can store it here away also.
84 $this->vars[$name] = $value;
85 return $name != 'action';
88 // TODO: check if page can really be pulled from the args, or if it is just the basepage.
89 function getWikiPageLinks($argstr, $basepage)
91 $args = $this->getArgs($argstr);
92 $page = isset($args['page']) ? $args['page'] : '';
94 // Expand relative page names.
95 $page = new WikiPageName($page, $basepage);
97 if (!$page or !$page->name)
99 return array(array('linkto' => $page->name, 'relation' => 0));
102 function run($dbi, $argstr, &$request, $basepage)
104 $this->vars = array();
105 $args = $this->getArgs($argstr, $request);
106 $vars = $args['vars'] ? $args['vars'] : $this->vars;
107 $page = $args['page'];
110 // Expand relative page names.
111 $page = new WikiPageName($page, $basepage);
115 return $this->error(sprintf(_("A required argument ā%sā is missing."), 'page'));
118 // If "Template:$page" exists, use it
119 // else if "Template/$page" exists, use it
121 if ($dbi->isWikiPage("Template:" . $page)) {
122 $page = "Template:" . $page;
123 } elseif ($dbi->isWikiPage("Template/" . $page)) {
124 $page = "Template/" . $page;
127 // Protect from recursive inclusion. A page can include itself once
128 static $included_pages = array();
129 if (in_array($page, $included_pages)) {
130 return $this->error(sprintf(_("Recursive inclusion of page %s"),
134 // Check if page exists
135 if (!($dbi->isWikiPage($page))) {
136 return $this->error(sprintf(_("Page ā%sā does not exist."), $page));
139 // Check if user is allowed to get the Page.
140 if (!mayAccessPage('view', $page)) {
141 return $this->error(sprintf(_("Illegal inclusion of page %s: no read access."),
145 $p = $dbi->getPage($page);
147 if (!is_whole_number($args['rev']) or !($args['rev'] > 0)) {
148 return $this->error(_("Error: rev must be a positive integer."));
150 $r = $p->getRevision($args['rev']);
151 if ((!$r) || ($r->hasDefaultContents())) {
152 return $this->error(sprintf(_("%s: no such revision %d."),
153 $page, $args['rev']));
156 $r = $p->getCurrentRevision();
158 $initial_content = $r->getPackedContent();
160 $content = $r->getContent();
162 if ((preg_match('/<' . '\?plugin\s+RedirectTo\s+page=(\S+)\s*\?' . '>/', implode("\n", $content), $m))
163 or (preg_match('/<' . '\?plugin\s+RedirectTo\s+page=(.*?)\s*\?' . '>/', implode("\n", $content), $m))
164 or (preg_match('/<<\s*RedirectTo\s+page=(\S+)\s*>>/', implode("\n", $content), $m))
165 or (preg_match('/<<\s*RedirectTo\s+page="(.*?)"\s*>>/', implode("\n", $content), $m))
167 // Strip quotes (simple or double) from page name if any
168 if ((string_starts_with($m[1], "'"))
169 or (string_starts_with($m[1], "\""))
171 $m[1] = substr($m[1], 1, -1);
173 // trap recursive redirects
174 if (in_array($m[1], $included_pages)) {
175 return $this->error(sprintf(_("Recursive inclusion of page %s ignored"),
176 $page . ' => ' . $m[1]));
179 $p = $dbi->getPage($page);
180 $r = $p->getCurrentRevision();
181 $initial_content = $r->getPackedContent();
184 if ($args['section']) {
185 $c = explode("\n", $initial_content);
186 $c = extractSection($args['section'], $c, $page, $quiet, $args['sectionhead']);
187 $initial_content = implode("\n", $c);
189 // exclude from expansion
190 if (preg_match('/<noinclude>.+<\/noinclude>/s', $initial_content)) {
191 $initial_content = preg_replace("/<noinclude>.+?<\/noinclude>/s", "",
195 $initial_content = preg_replace("/<includeonly>(.+)<\/includeonly>/s", "\\1",
197 $this->doVariableExpansion($initial_content, $vars, $basepage, $request);
199 array_push($included_pages, $page);
201 // If content is single-line, call TransformInline, else call TransformText
202 $initial_content = trim($initial_content, "\n");
203 if (preg_match("/\n/", $initial_content)) {
204 include_once 'lib/BlockParser.php';
205 $content = TransformText($initial_content, $r->get('markup'), $page);
207 include_once 'lib/InlineParser.php';
208 $content = TransformInline($initial_content, $r->get('markup'), $page);
211 array_pop($included_pages);
217 * Expand template variables. Used by the TemplatePlugin and the CreatePagePlugin
219 function doVariableExpansion(&$content, $vars, $basepage, &$request)
221 if (preg_match('/%%\w+%%/', $content)) // need variable expansion
223 $dbi =& $request->_dbi;
225 if (is_string($vars) and !empty($vars)) {
226 foreach (explode("&", $vars) as $pair) {
227 list($key, $val) = explode("=", $pair);
230 } elseif (is_array($vars)) {
233 $thispage = $dbi->getPage($basepage);
234 // pagename and userid are not overridable
235 $var['PAGENAME'] = $thispage->getName();
236 if (preg_match('/%%USERID%%/', $content))
237 $var['USERID'] = $request->_user->getId();
238 if (empty($var['MTIME']) and preg_match('/%%MTIME%%/', $content)) {
239 $thisrev = $thispage->getCurrentRevision(false);
240 $var['MTIME'] = $GLOBALS['WikiTheme']->formatDateTime($thisrev->get('mtime'));
242 if (empty($var['CTIME']) and preg_match('/%%CTIME%%/', $content)) {
243 if ($first = $thispage->getRevision(1, false))
244 $var['CTIME'] = $GLOBALS['WikiTheme']->formatDateTime($first->get('mtime'));
246 if (empty($var['AUTHOR']) and preg_match('/%%AUTHOR%%/', $content))
247 $var['AUTHOR'] = $thispage->getAuthor();
248 if (empty($var['OWNER']) and preg_match('/%%OWNER%%/', $content))
249 $var['OWNER'] = $thispage->getOwner();
250 if (empty($var['CREATOR']) and preg_match('/%%CREATOR%%/', $content))
251 $var['CREATOR'] = $thispage->getCreator();
252 foreach (array("SERVER_URL", "DATA_PATH", "SCRIPT_NAME", "PHPWIKI_BASE_URL") as $c) {
253 // constants are not overridable
254 if (preg_match('/%%' . $c . '%%/', $content))
255 $var[$c] = constant($c);
257 if (preg_match('/%%BASE_URL%%/', $content))
258 $var['BASE_URL'] = PHPWIKI_BASE_URL;
260 foreach ($var as $key => $val) {
261 // We have to decode the double quotes that have been encoded
262 // in inline or block parser.
263 $content = str_replace("%%" . $key . "%%", htmlspecialchars_decode($val), $content);
274 // c-hanging-comment-ender-p: nil
275 // indent-tabs-mode: nil