1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<?php // -*-php-*-
rcs_id('$Id: Template.php,v 1.4 2005/09/11 13:30:22 rurban Exp $');
/*
Copyright 2005 $ThePhpWikiProgrammingTeam
This file is part of PhpWiki.
PhpWiki is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
PhpWiki is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with PhpWiki; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* Template: Parametrized blocks.
* Include text from a wiki page and replace certain placeholders by parameters.
* Similiar to CreatePage with the template argument, but at run-time.
* Similiar to the mediawiki templates but not with the "|" parameter seperator.
* Usage: <?plugin Template page=TemplateFilm vars="title=rurban&year=1999" ?>
* Author: Reini Urban
* See also: http://meta.wikimedia.org/wiki/Help:Template
*
* Parameter expansion:
* vars="var1=value1&var2=value2"
* We only support named parameters, not numbered ones as in mediawiki, and
* the placeholder is %%var%% and not {{{var}}} as in mediawiki.
*
* The following predefined variables are automatically expanded if existing:
* pagename
* mtime - last modified date + time
* ctime - creation date + time
* author - last author
* owner
* creator - first author
* SERVER_URL, DATA_PATH, SCRIPT_NAME, PHPWIKI_BASE_URL and BASE_URL
*
* <noinclude> .. </noinclude> is stripped
*
* In work:
* - ENABLE_MARKUP_TEMPLATE = true: (lib/InlineParser.php)
* Support a mediawiki-style syntax extension which maps
* {{TemplateFilm|title=Some Good Film|year=1999}}
* to
* <?plugin Template page=TemplateFilm vars="title=Some Good Film&year=1999" ?>
*/
class WikiPlugin_Template
extends WikiPlugin
{
function getName() {
return _("Template");
}
function getDescription() {
return _("Parametrized page inclusion.");
}
function getVersion() {
return preg_replace("/[Revision: $]/", '',
"\$Revision: 1.4 $");
}
function getDefaultArguments() {
return array(
'page' => false, // the page to include
'vars' => false,
'rev' => false, // the revision (defaults to most recent)
'section' => false, // just include a named section
'sectionhead' => false // when including a named section show the heading
);
}
function getWikiPageLinks($argstr, $basepage) {
extract($this->getArgs($argstr));
if ($page) {
// Expand relative page names.
$page = new WikiPageName($page, $basepage);
}
if (!$page or !$page->name)
return false;
return array($page->name);
}
function run($dbi, $argstr, &$request, $basepage) {
extract($this->getArgs($argstr, $request));
if ($page) {
// Expand relative page names.
$page = new WikiPageName($page, $basepage);
$page = $page->name;
}
if (!$page) {
return $this->error(_("no page specified"));
}
// Protect from recursive inclusion. A page can include itself once
static $included_pages = array();
if (in_array($page, $included_pages)) {
return $this->error(sprintf(_("recursive inclusion of page %s"),
$page));
}
$p = $dbi->getPage($page);
if ($rev) {
$r = $p->getRevision($rev);
if (!$r) {
return $this->error(sprintf(_("%s(%d): no such revision"),
$page, $rev));
}
} else {
$r = $p->getCurrentRevision();
}
$initial_content = $r->getPackedContent();
$c = explode("\n", $initial_content);
if ($section) {
$c = extractSection($section, $c, $page, $quiet, $sectionhead);
$initial_content = implode("\n", $c);
}
if (preg_match('/<noinclude>.+<\/noinclude>/s', $initial_content)) {
$initial_content = preg_replace("/<noinclude>.+?<\/noinclude>/s", "",
$initial_content);
}
if (preg_match('/%%\w+%%/', $initial_content)) // need variable expansion
{
$var = array();
if (!empty($vars)) {
foreach (split("&",$vars) as $pair) {
list($key,$val) = split("=",$pair);
$var[$key] = $val;
}
}
$thispage = $dbi->getPage($basepage);
// pagename is not overridable
if (empty($var['pagename']))
$var['pagename'] = $page;
// those are overridable
if (empty($var['mtime']) and preg_match('/%%mtime%%/', $initial_content)) {
$thisrev = $thispage->getCurrentRevision(false);
$var['mtime'] = $GLOBALS['WikiTheme']->formatDateTime($thisrev->get('mtime'));
}
if (empty($var['ctime']) and preg_match('/%%ctime%%/', $initial_content)) {
if ($first = $thispage->getRevision(1,false))
$var['ctime'] = $GLOBALS['WikiTheme']->formatDateTime($first->get('mtime'));
}
if (empty($var['author']) and preg_match('/%%author%%/', $initial_content))
$var['author'] = $thispage->getAuthor();
if (empty($var['owner']) and preg_match('/%%owner%%/', $initial_content))
$var['owner'] = $thispage->getOwner();
if (empty($var['creator']) and preg_match('/%%creator%%/', $initial_content))
$var['creator'] = $thispage->getCreator();
foreach (array("SERVER_URL", "DATA_PATH", "SCRIPT_NAME", "PHPWIKI_BASE_URL") as $c) {
// constants are not overridable
if (preg_match('/%%'.$c.'%%/', $initial_content))
$var[$c] = constant($c);
}
if (preg_match('/%%BASE_URL%%/', $initial_content))
$var['BASE_URL'] = PHPWIKI_BASE_URL;
foreach ($var as $key => $val) {
$initial_content = preg_replace("/%%$key%%/", $val, $initial_content);
}
}
array_push($included_pages, $page);
include_once('lib/BlockParser.php');
$content = TransformText($initial_content, $r->get('markup'), $page);
array_pop($included_pages);
return HTML::div(array('class' => 'template'), $content);
}
};
// $Log: Template.php,v $
// Revision 1.4 2005/09/11 13:30:22 rurban
// improve comments
//
// Revision 1.3 2005/09/10 20:43:19 rurban
// support <noinclude>
//
// Revision 1.2 2005/09/10 20:07:16 rurban
// fix BASE_URL
//
// Revision 1.1 2005/09/10 19:59:38 rurban
// Parametrized page inclusion ala mediawiki
//
// For emacs users
// Local Variables:
// mode: php
// tab-width: 8
// c-basic-offset: 4
// c-hanging-comment-ender-p: nil
// indent-tabs-mode: nil
// End:
?>
|
