lib/plugin/Template.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright 2005,2007 $ThePhpWikiProgrammingTeam
   5  * Copyright 2008-2011 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 along
  20  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 /**
  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" >>
  30  * Author:  Reini Urban
  31  * See also: http://meta.wikimedia.org/wiki/Help:Template
  32  *
  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.
  37  *
  38  * The following predefined uppercase variables are automatically expanded if existing:
  39  *   PAGENAME
  40  *   MTIME     - last modified date + time
  41  *   CTIME     - creation date + time
  42  *   AUTHOR    - last author
  43  *   OWNER
  44  *   CREATOR   - first author
  45  *   SERVER_URL, DATA_PATH, SCRIPT_NAME, PHPWIKI_BASE_URL and BASE_URL
  46  *
  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.
  50  *
  51  *   We support a mediawiki-style syntax extension which maps
  52  *     {{TemplateFilm|title=Some Good Film|year=1999}}
  53  *   to
  54  *     <<Template page=TemplateFilm vars="title=Some Good Film&year=1999" >>
  55  */
  56
  57 class WikiPlugin_Template
  58 extends WikiPlugin
  59 {
  60     function getName() {
  61         return _("Template");
  62     }
  63
  64     function getDescription() {
  65         return _("Parametrized page inclusion.");
  66     }
  67
  68     function getDefaultArguments() {
  69         return array(
  70                      'page'    => false, // the page to include
  71                      'vars'    => false, // TODO: get rid of this, all remaining args should be vars
  72                      'rev'     => false, // the revision (defaults to most recent)
  73                      'section' => false, // just include a named section
  74                      'sectionhead' => false // when including a named section show the heading
  75                      );
  76     }
  77     function allow_undeclared_arg($name, $value) {
  78             // either just allow it or you can store it here away also.
  79             $this->vars[$name] = $value;
  80             return $name != 'action';
  81     }
  82
  83     // TODO: check if page can really be pulled from the args, or if it is just the basepage.
  84     function getWikiPageLinks($argstr, $basepage) {
  85         $args = $this->getArgs($argstr);
  86         $page = isset($args['page'])? $args['page']: '';
  87         if ($page) {
  88             // Expand relative page names.
  89             $page = new WikiPageName($page, $basepage);
  90         }
  91         if (!$page or !$page->name)
  92             return false;
  93         return array(array('linkto' => $page->name, 'relation' => 0));
  94     }
  95
  96     function run($dbi, $argstr, &$request, $basepage) {
  97         $this->vars = array();
  98         $args = $this->getArgs($argstr, $request);
  99         $vars = $args['vars'] ? $args['vars'] : $this->vars;
 100         $page = $args['page'];
 101
 102         if ($page) {
 103             // Expand relative page names.
 104             $page = new WikiPageName($page, $basepage);
 105             $page = $page->name;
 106         }
 107         if (!$page) {
 108             return $this->error(_("No page specified."));
 109         }
 110
 111         // If "Template:$page" exists, use it
 112         // else if "Template/$page" exists, use it
 113         // else use "$page"
 114         if ($dbi->isWikiPage("Template:" . $page)) {
 115             $page = "Template:" . $page;
 116         } elseif ($dbi->isWikiPage("Template/" . $page)) {
 117             $page = "Template/" . $page;
 118         }
 119
 120         // Protect from recursive inclusion. A page can include itself once
 121         static $included_pages = array();
 122         if (in_array($page, $included_pages)) {
 123             return $this->error(sprintf(_("Recursive inclusion of page %s"),
 124                                         $page));
 125         }
 126
 127         // Check if page exists
 128         if (!($dbi->isWikiPage($page))) {
 129             return $this->error(sprintf(_("Page '%s' does not exist."), $page));
 130         }
 131
 132         // Check if user is allowed to get the Page.
 133         if (!mayAccessPage ('view', $page)) {
 134                 return $this->error(sprintf(_("Illegal inclusion of page %s: no read access."),
 135                                         $page));
 136         }
 137
 138         $p = $dbi->getPage($page);
 139         if ($args['rev']) {
 140             if (!is_whole_number($args['rev']) or !($args['rev']>0)) {
 141                 return $this->error(_("Error: rev must be a positive integer."));
 142             }
 143             $r = $p->getRevision($args['rev']);
 144             if ((!$r) || ($r->hasDefaultContents())) {
 145                 return $this->error(sprintf(_("%s: no such revision %d."),
 146                                             $page, $args['rev']));
 147             }
 148         } else {
 149             $r = $p->getCurrentRevision();
 150         }
 151         $initial_content = $r->getPackedContent();
 152
 153         $content = $r->getContent();
 154         // follow redirects
 155         if ((preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(\S+)\s*\?'.'>/', implode("\n", $content), $m))
 156           or (preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(.*?)\s*\?'.'>/', implode("\n", $content), $m))
 157           or (preg_match('/<<\s*RedirectTo\s+page=(\S+)\s*>>/', implode("\n", $content), $m))
 158           or (preg_match('/<<\s*RedirectTo\s+page="(.*?)"\s*>>/', implode("\n", $content), $m)))
 159         {
 160             // Strip quotes (simple or double) from page name if any
 161             if ((string_starts_with($m[1], "'"))
 162               or (string_starts_with($m[1], "\""))) {
 163                 $m[1] = substr($m[1], 1, -1);
 164             }
 165             // trap recursive redirects
 166             if (in_array($m[1], $included_pages)) {
 167                 return $this->error(sprintf(_("Recursive inclusion of page %s ignored"),
 168                                                 $page.' => '.$m[1]));
 169             }
 170             $page = $m[1];
 171             $p = $dbi->getPage($page);
 172             $r = $p->getCurrentRevision();
 173             $initial_content = $r->getPackedContent();
 174         }
 175
 176         if ($args['section']) {
 177             $c = explode("\n", $initial_content);
 178             $c = extractSection($args['section'], $c, $page, $quiet, $args['sectionhead']);
 179             $initial_content = implode("\n", $c);
 180         }
 181         // exclude from expansion
 182         if (preg_match('/<noinclude>.+<\/noinclude>/s', $initial_content)) {
 183             $initial_content = preg_replace("/<noinclude>.+?<\/noinclude>/s", "",
 184                                             $initial_content);
 185         }
 186         // only in expansion
 187         $initial_content = preg_replace("/<includeonly>(.+)<\/includeonly>/s", "\\1",
 188                                         $initial_content);
 189         $this->doVariableExpansion($initial_content, $vars, $basepage, $request);
 190
 191         array_push($included_pages, $page);
 192
 193         // If content is single-line, call TransformInline, else call TransformText
 194         $initial_content = trim($initial_content, "\n");
 195         if (preg_match("/\n/", $initial_content)) {
 196             include_once('lib/BlockParser.php');
 197             $content = TransformText($initial_content, $r->get('markup'), $page);
 198         } else {
 199             include_once('lib/InlineParser.php');
 200             $content = TransformInline($initial_content, $r->get('markup'), $page);
 201         }
 202
 203         array_pop($included_pages);
 204
 205         return $content;
 206     }
 207
 208     /**
 209      * Expand template variables. Used by the TemplatePlugin and the CreatePagePlugin
 210      */
 211     function doVariableExpansion(&$content, $vars, $basepage, &$request) {
 212         if (preg_match('/%%\w+%%/', $content)) // need variable expansion
 213         {
 214             $dbi =& $request->_dbi;
 215             $var = array();
 216             if (is_string($vars) and !empty($vars)) {
 217                 foreach (explode("&", $vars) as $pair) {
 218                     list($key,$val) = explode("=", $pair);
 219                     $var[$key] = $val;
 220                 }
 221             } elseif (is_array($vars)) {
 222                 $var =& $vars;
 223             }
 224             $thispage = $dbi->getPage($basepage);
 225             // pagename and userid are not overridable
 226             $var['PAGENAME'] = $thispage->getName();
 227             if (preg_match('/%%USERID%%/', $content))
 228                 $var['USERID'] = $request->_user->getId();
 229             if (empty($var['MTIME']) and preg_match('/%%MTIME%%/', $content)) {
 230                 $thisrev  = $thispage->getCurrentRevision(false);
 231                 $var['MTIME'] = $GLOBALS['WikiTheme']->formatDateTime($thisrev->get('mtime'));
 232             }
 233             if (empty($var['CTIME']) and preg_match('/%%CTIME%%/', $content)) {
 234                 if ($first = $thispage->getRevision(1,false))
 235                     $var['CTIME'] = $GLOBALS['WikiTheme']->formatDateTime($first->get('mtime'));
 236             }
 237             if (empty($var['AUTHOR']) and preg_match('/%%AUTHOR%%/', $content))
 238                 $var['AUTHOR'] = $thispage->getAuthor();
 239             if (empty($var['OWNER']) and preg_match('/%%OWNER%%/', $content))
 240                 $var['OWNER'] = $thispage->getOwner();
 241             if (empty($var['CREATOR']) and preg_match('/%%CREATOR%%/', $content))
 242                 $var['CREATOR'] = $thispage->getCreator();
 243             foreach (array("SERVER_URL", "DATA_PATH", "SCRIPT_NAME", "PHPWIKI_BASE_URL") as $c) {
 244                 // constants are not overridable
 245                 if (preg_match('/%%'.$c.'%%/', $content))
 246                     $var[$c] = constant($c);
 247             }
 248             if (preg_match('/%%BASE_URL%%/', $content))
 249                 $var['BASE_URL'] = PHPWIKI_BASE_URL;
 250
 251             foreach ($var as $key => $val) {
 252                 // We have to decode the double quotes that have been encoded
 253                 // in inline or block parser.
 254                 $content = str_replace("%%".$key."%%", htmlspecialchars_decode($val), $content);
 255             }
 256         }
 257         return $content;
 258     }
 259 };
 260
 261 // Local Variables:
 262 // mode: php
 263 // tab-width: 8
 264 // c-basic-offset: 4
 265 // c-hanging-comment-ender-p: nil
 266 // indent-tabs-mode: nil
 267 // End:
 268 ?>