lib/plugin/IncludePage.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright 1999, 2000, 2001, 2002 $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
  20  * along with PhpWiki; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /**
  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>
  28  */
  29
  30 class WikiPlugin_IncludePage
  31 extends WikiPlugin
  32 {
  33     function getName() {
  34         return _("IncludePage");
  35     }
  36
  37     function getDescription() {
  38         return _("Include text from another wiki page.");
  39     }
  40
  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
  51                       );
  52     }
  53
  54     function getWikiPageLinks($argstr, $basepage) {
  55         extract($this->getArgs($argstr));
  56
  57         if (!isset($page))
  58             return false;
  59         if ($page) {
  60             // Expand relative page names.
  61             $page = new WikiPageName($page, $basepage);
  62         }
  63         if (!$page or !$page->name)
  64             return false;
  65         return array(array('linkto' => $page->name, 'relation' => 0));
  66     }
  67
  68     function run($dbi, $argstr, &$request, $basepage) {
  69         $args = $this->getArgs($argstr, $request);
  70         extract($args);
  71
  72         if ($page) {
  73             // Expand relative page names.
  74             $page = new WikiPageName($page, $basepage);
  75             $page = $page->name;
  76         }
  77         if (!$page) {
  78             return $this->error(_("no page specified"));
  79         }
  80
  81         // A page can include itself once (this is needed, e.g.,  when editing
  82         // TextFormattingRules).
  83         static $included_pages = array();
  84         if (in_array($page, $included_pages)) {
  85             return $this->error(sprintf(_("Recursive inclusion of page %s ignored"),
  86                                         $page));
  87         }
  88
  89         // Check if page exists
  90         if (!($dbi->isWikiPage($page))) {
  91             return $this->error(sprintf(_("Page '%s' does not exist"), $page));
  92         }
  93
  94         // Check if user is allowed to get the Page.
  95         if (!mayAccessPage ('view', $page)) {
  96             return $this->error(sprintf(_("Illegal inclusion of page %s: no read access"),
  97                                         $page));
  98         }
  99
 100         $p = $dbi->getPage($page);
 101         if ($rev) {
 102             $r = $p->getRevision($rev);
 103             if ((!$r) || ($r->hasDefaultContents())) {
 104                 return $this->error(sprintf(_("%s: no such revision %d."),
 105                                             $page, $rev));
 106             }
 107         } else {
 108             $r = $p->getCurrentRevision();
 109         }
 110         $c = $r->getContent();
 111
 112         // follow redirects
 113         if ((preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(\S+)\s*\?'.'>/', implode("\n", $c), $m))
 114           or (preg_match('/<'.'\?plugin\s+RedirectTo\s+page=(.*?)\s*\?'.'>/', implode("\n", $c), $m))
 115           or (preg_match('/<<\s*RedirectTo\s+page=(\S+)\s*>>/', implode("\n", $c), $m))
 116           or (preg_match('/<<\s*RedirectTo\s+page="(.*?)"\s*>>/', implode("\n", $c), $m)))
 117         {
 118             // Strip quotes (simple or double) from page name if any
 119             if ((string_starts_with($m[1], "'"))
 120               or (string_starts_with($m[1], "\""))) {
 121                 $m[1] = substr($m[1], 1, -1);
 122             }
 123             // trap recursive redirects
 124             if (in_array($m[1], $included_pages)) {
 125                 return $this->error(sprintf(_("Recursive inclusion of page %s ignored"),
 126                                                 $page.' => '.$m[1]));
 127             }
 128             $page = $m[1];
 129             $p = $dbi->getPage($page);
 130             $r = $p->getCurrentRevision();
 131             $c = $r->getContent();   // array of lines
 132         }
 133
 134         $ct = $this->extractParts ($c, $page, $args);
 135
 136         // exclude from expansion
 137         if (preg_match('/<noinclude>.+<\/noinclude>/s', $ct)) {
 138             $ct = preg_replace("/<noinclude>.+?<\/noinclude>/s", "", $ct);
 139         }
 140         // only in expansion
 141         $ct = preg_replace("/<includeonly>(.+)<\/includeonly>/s", "\\1", $ct);
 142
 143         array_push($included_pages, $page);
 144
 145         include_once('lib/BlockParser.php');
 146         $content = TransformText($ct, $r->get('markup'), $page);
 147
 148         array_pop($included_pages);
 149
 150         if ($quiet)
 151             return $content;
 152
 153         return HTML(HTML::p(array('class' => 'transclusion-title'),
 154                             fmt("Included from %s", WikiLink($page))),
 155
 156                     HTML::div(array('class' => 'transclusion'),
 157                               false, $content));
 158     }
 159
 160     /**
 161      * handles the arguments: section, sectionhead, lines, words, bytes,
 162      * for UnfoldSubpages, IncludePage, ...
 163      */
 164     function extractParts ($c, $pagename, $args) {
 165         extract($args);
 166
 167         if ($section) {
 168             if ($sections) {
 169                 $c = extractSection($section, $c, $pagename, $quiet, 1);
 170             } else {
 171                 $c = extractSection($section, $c, $pagename, $quiet, $sectionhead);
 172             }
 173         }
 174         if ($sections) {
 175             $c = extractSections($sections, $c, $pagename, $quiet, 1);
 176         }
 177         if ($lines) {
 178             $c = array_slice($c, 0, $lines);
 179             $c[] = sprintf(_(" ... first %d lines"), $lines);
 180         }
 181         if ($words) {
 182             $c = firstNWordsOfContent($words, $c);
 183         }
 184         if ($bytes) {
 185             $ct = implode("\n", $c); // one string
 186             if (strlen($ct) > $bytes) {
 187                 $ct = substr($c, 0, $bytes);
 188                 $c = array($ct, sprintf(_(" ... first %d bytes"), $bytes));
 189             }
 190         }
 191         $ct = implode("\n", $c); // one string
 192         return $ct;
 193     }
 194 };
 195
 196 // Local Variables:
 197 // mode: php
 198 // tab-width: 8
 199 // c-basic-offset: 4
 200 // c-hanging-comment-ender-p: nil
 201 // indent-tabs-mode: nil
 202 // End:
 203 ?>