2 rcs_id('$Id: IncludePage.php,v 1.8 2002-01-20 16:24:08 dairiki Exp $');
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>
9 require_once('lib/transform.php');
11 class WikiPlugin_IncludePage
15 return _("IncludePage");
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
28 function firstNWordsOfContent( $n, $content ) {
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)";
38 $wordcount += count($words);
45 function extractSection ($section, $content) {
46 $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
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),
54 // Strip trailing blanks lines and ---- <hr>s
55 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
56 return explode("\n", $text);
58 return array(sprintf(_("<%s: no such section>"), $section));
61 function error($msg) {
62 // FIXME: better error reporting?
63 trigger_error($msg, E_USER_NOTICE);
66 function run($dbi, $argstr, $request) {
68 extract($this->getArgs($argstr, $request));
71 $this->error(_("no page specified"));
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));
83 $p = $dbi->getPage($page);
86 $r = $p->getRevision($rev);
88 $this->error(sprintf(_("%s(%d): no such revision"), $page,
93 $r = $p->getCurrentRevision();
96 $c = $r->getContent();
99 $c = $this->extractSection($section, $c);
101 $c = array_slice($c, 0, $lines);
103 $c = $this->firstNWordsOfContent($words, $c);
105 array_push($included_pages, $page);
106 $content = do_transform($c);
107 array_pop($included_pages);
109 if ($quiet) return $content;
111 return Element('p', array('class' => 'transclusion-title'),
112 sprintf(_("Included from %s"),
113 LinkExistingWikiWord($page)))
114 . Element('div', array('class' => 'transclusion'),
119 // This is an excerpt from the css file I use:
121 // .transclusion-title {
122 // font-style: oblique;
123 // font-size: 0.75em;
124 // text-decoration: underline;
125 // text-align: right;
128 // DIV.transclusion {
129 // background: lightgreen;
131 // border-style: solid;
132 // padding-left: 0.8em;
133 // padding-right: 0.8em;
135 // padding-bottom: 0px;
136 // margin: 0.5ex 0px;
140 // - line & word limit doesn't work if the included page itself
142 // - we need an error reporting scheme
149 // c-hanging-comment-ender-p: nil
150 // indent-tabs-mode: nil