lib/plugin/IncludePage.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: IncludePage.php,v 1.8 2002-01-20 16:24:08 dairiki Exp $');
   3 /**
   4  * IncludePage:  include text from another wiki page in this one
   5  * usage:   <?plugin IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6?>
   6  * author:  Joe Edelman <joe@orbis-tertius.net>
   7  */
   8
   9 require_once('lib/transform.php');
  10
  11 class WikiPlugin_IncludePage
  12 extends WikiPlugin
  13 {
  14     function getName() {
  15         return _("IncludePage");
  16     }
  17
  18     function getDefaultArguments() {
  19         return array( 'page'    => false, // the page to include
  20                       'rev'     => false, // the revision (defaults to most recent)
  21                       'quiet'   => false, // if set, inclusion appears as normal content
  22                       'words'   => false, // maximum number of words to include
  23                       'lines'   => false, // maximum number of lines to include
  24                       'section' => false  // include a named section
  25                       );
  26     }
  27
  28     function firstNWordsOfContent( $n, $content ) {
  29         $wordcount = 0;
  30         $new = array( );
  31         foreach ($content as $line) {
  32             $words = explode(' ', $line);
  33             if ($wordcount + count($words) > $n) {
  34                 $new[] = implode(' ', array_slice($words, 0, $n - $wordcount))
  35                     . "... (first $n words)";
  36                 return $new;
  37             } else {
  38                 $wordcount += count($words);
  39                 $new[] = $line;
  40             }
  41         }
  42         return $new;
  43     }
  44
  45     function extractSection ($section, $content) {
  46         $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
  47
  48         if (preg_match("/ ^(!{1,})\\s*$qsection" // section header
  49                        . "  \\s*$\\n?"           // possible blank lines
  50                        . "  ( (?: ^.*\\n? )*? )" // some lines
  51                        . "  (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
  52                        implode("\n", $content),
  53                        $match)) {
  54             // Strip trailing blanks lines and ---- <hr>s
  55             $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
  56             return explode("\n", $text);
  57         }
  58         return array(sprintf(_("<%s: no such section>"), $section));
  59     }
  60
  61     function error($msg) {
  62         // FIXME: better error reporting?
  63         trigger_error($msg, E_USER_NOTICE);
  64     }
  65
  66     function run($dbi, $argstr, $request) {
  67
  68         extract($this->getArgs($argstr, $request));
  69
  70         if (!$page) {
  71             $this->error(_("no page specified"));
  72             return '';
  73         }
  74
  75         // A page can include itself once (this is needed, e.g.,  when editing
  76         // TextFormattingRules).
  77         static $included_pages = array();
  78         if (in_array($page, $included_pages)) {
  79             $this->error(sprintf(_("recursive inclusion of page %s"), $page));
  80             return '';
  81         }
  82
  83         $p = $dbi->getPage($page);
  84
  85         if ($rev) {
  86             $r = $p->getRevision($rev);
  87             if (!$r) {
  88                 $this->error(sprintf(_("%s(%d): no such revision"), $page,
  89                                      $rev));
  90                 return '';
  91             }
  92         } else {
  93             $r = $p->getCurrentRevision();
  94         }
  95
  96         $c = $r->getContent();
  97
  98         if ($section)
  99             $c = $this->extractSection($section, $c);
 100         if ($lines)
 101             $c = array_slice($c, 0, $lines);
 102         if ($words)
 103             $c = $this->firstNWordsOfContent($words, $c);
 104
 105         array_push($included_pages, $page);
 106         $content = do_transform($c);
 107         array_pop($included_pages);
 108
 109         if ($quiet) return $content;
 110
 111         return Element('p', array('class' => 'transclusion-title'),
 112                        sprintf(_("Included from %s"),
 113                                LinkExistingWikiWord($page)))
 114             . Element('div', array('class' => 'transclusion'),
 115                       $content);
 116     }
 117 };
 118
 119 // This is an excerpt from the css file I use:
 120 //
 121 // .transclusion-title {
 122 //   font-style: oblique;
 123 //   font-size: 0.75em;
 124 //   text-decoration: underline;
 125 //   text-align: right;
 126 // }
 127 //
 128 // DIV.transclusion {
 129 //   background: lightgreen;
 130 //   border: thin;
 131 //   border-style: solid;
 132 //   padding-left: 0.8em;
 133 //   padding-right: 0.8em;
 134 //   padding-top: 0px;
 135 //   padding-bottom: 0px;
 136 //   margin: 0.5ex 0px;
 137 // }
 138
 139 // KNOWN ISSUES:
 140 // - line & word limit doesn't work if the included page itself
 141 //   includes a plugin
 142 // - we need an error reporting scheme
 143
 144 // For emacs users
 145 // Local Variables:
 146 // mode: php
 147 // tab-width: 8
 148 // c-basic-offset: 4
 149 // c-hanging-comment-ender-p: nil
 150 // indent-tabs-mode: nil
 151 // End:
 152 ?>