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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
<?php
/*
* Created on Sep 19, 2006
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ('ApiBase.php');
}
/**
* This is the abstract base class for API formatters.
*
* @ingroup API
*/
abstract class ApiFormatBase extends ApiBase {
private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp, $mCleared;
/**
* Constructor
* If $format ends with 'fm', pretty-print the output in HTML.
* @param $main ApiMain
* @param $format string Format name
*/
public function __construct($main, $format) {
parent :: __construct($main, $format);
$this->mIsHtml = (substr($format, -2, 2) === 'fm'); // ends with 'fm'
if ($this->mIsHtml)
$this->mFormat = substr($format, 0, -2); // remove ending 'fm'
else
$this->mFormat = $format;
$this->mFormat = strtoupper($this->mFormat);
$this->mCleared = false;
}
/**
* Overriding class returns the mime type that should be sent to the client.
* This method is not called if getIsHtml() returns true.
* @return string
*/
public abstract function getMimeType();
/**
* Whether this formatter needs raw data such as _element tags
* @return bool
*/
public function getNeedsRawData() {
return false;
}
/**
* Get the internal format name
* @return string
*/
public function getFormat() {
return $this->mFormat;
}
/**
* Specify whether or not sequences like &quot; should be unescaped
* to " . This should only be set to true for the help message
* when rendered in the default (xmlfm) format. This is a temporary
* special-case fix that should be removed once the help has been
* reworked to use a fully HTML interface.
*
* @param $b bool Whether or not ampersands should be escaped.
*/
public function setUnescapeAmps ( $b ) {
$this->mUnescapeAmps = $b;
}
/**
* Returns true when the HTML pretty-printer should be used.
* The default implementation assumes that formats ending with 'fm'
* should be formatted in HTML.
* @return bool
*/
public function getIsHtml() {
return $this->mIsHtml;
}
/**
* Initialize the printer function and prepare the output headers, etc.
* This method must be the first outputing method during execution.
* A help screen's header is printed for the HTML-based output
* @param $isError bool Whether an error message is printed
*/
function initPrinter($isError) {
$isHtml = $this->getIsHtml();
$mime = $isHtml ? 'text/html' : $this->getMimeType();
$script = wfScript( 'api' );
// Some printers (ex. Feed) do their own header settings,
// in which case $mime will be set to null
if (is_null($mime))
return; // skip any initialization
header("Content-Type: $mime; charset=utf-8");
if ($isHtml) {
?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<?php if ($this->mUnescapeAmps) {
?> <title>MediaWiki API</title>
<?php } else {
?> <title>MediaWiki API Result</title>
<?php } ?>
</head>
<body>
<?php
if( !$isError ) {
?>
<br/>
<small>
You are looking at the HTML representation of the <?php echo( $this->mFormat ); ?> format.<br/>
HTML is good for debugging, but probably is not suitable for your application.<br/>
See <a href='http://www.mediawiki.org/wiki/API'>complete documentation</a>, or
<a href='<?php echo( $script ); ?>'>API help</a> for more information.
</small>
<?php
}
?>
<pre>
<?php
}
}
/**
* Finish printing. Closes HTML tags.
*/
public function closePrinter() {
if ($this->getIsHtml()) {
?>
</pre>
</body>
</html>
<?php
}
}
/**
* The main format printing function. Call it to output the result
* string to the user. This function will automatically output HTML
* when format name ends in 'fm'.
* @param $text string
*/
public function printText($text) {
if ($this->getIsHtml())
echo $this->formatHTML($text);
else
{
// For non-HTML output, clear all errors that might have been
// displayed if display_errors=On
// Do this only once, of course
if(!$this->mCleared)
{
ob_clean();
$this->mCleared = true;
}
echo $text;
}
}
/**
* Sets whether the pretty-printer should format *bold* and $italics$
* @param $help bool
*/
public function setHelp( $help = true ) {
$this->mHelp = true;
}
/**
* Prety-print various elements in HTML format, such as xml tags and
* URLs. This method also escapes characters like <
* @param $text string
* @return string
*/
protected function formatHTML($text) {
global $wgUrlProtocols;
// Escape everything first for full coverage
$text = htmlspecialchars($text);
// encode all comments or tags as safe blue strings
$text = preg_replace('/\<(!--.*?--|.*?)\>/', '<span style="color:blue;"><\1></span>', $text);
// identify URLs
$protos = implode("|", $wgUrlProtocols);
# This regex hacks around bug 13218 (" included in the URL)
$text = preg_replace("#(($protos).*?)(")?([ \\'\"<>\n]|<|>|")#", '<a href="\\1">\\1</a>\\3\\4', $text);
// identify requests to api.php
$text = preg_replace("#api\\.php\\?[^ \\()<\n\t]+#", '<a href="\\0">\\0</a>', $text);
if( $this->mHelp ) {
// make strings inside * bold
$text = preg_replace("#\\*[^<>\n]+\\*#", '<b>\\0</b>', $text);
// make strings inside $ italic
$text = preg_replace("#\\$[^<>\n]+\\$#", '<b><i>\\0</i></b>', $text);
}
/* Temporary fix for bad links in help messages. As a special case,
* XML-escaped metachars are de-escaped one level in the help message
* for legibility. Should be removed once we have completed a fully-html
* version of the help message. */
if ( $this->mUnescapeAmps )
$text = preg_replace( '/&(amp|quot|lt|gt);/', '&\1;', $text );
return $text;
}
protected function getExamples() {
return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName();
}
public function getDescription() {
return $this->getIsHtml() ? ' (pretty-print in HTML)' : '';
}
public static function getBaseVersion() {
return __CLASS__ . ': $Id: ApiFormatBase.php 48521 2009-03-18 19:25:29Z ialex $';
}
}
/**
* This printer is used to wrap an instance of the Feed class
* @ingroup API
*/
class ApiFormatFeedWrapper extends ApiFormatBase {
public function __construct($main) {
parent :: __construct($main, 'feed');
}
/**
* Call this method to initialize output data. See execute()
* @param $result ApiResult
* @param $feed object an instance of one of the $wgFeedClasses classes
* @param $feedItems array of FeedItem objects
*/
public static function setResult($result, $feed, $feedItems) {
// Store output in the Result data.
// This way we can check during execution if any error has occured
// Disable size checking for this because we can't continue
// cleanly; size checking would cause more problems than it'd
// solve
$result->disableSizeCheck();
$result->addValue(null, '_feed', $feed);
$result->addValue(null, '_feeditems', $feedItems);
$result->enableSizeCheck();
}
/**
* Feed does its own headers
*/
public function getMimeType() {
return null;
}
/**
* Optimization - no need to sanitize data that will not be needed
*/
public function getNeedsRawData() {
return true;
}
/**
* This class expects the result data to be in a custom format set by self::setResult()
* $result['_feed'] - an instance of one of the $wgFeedClasses classes
* $result['_feeditems'] - an array of FeedItem instances
*/
public function execute() {
$data = $this->getResultData();
if (isset ($data['_feed']) && isset ($data['_feeditems'])) {
$feed = $data['_feed'];
$items = $data['_feeditems'];
$feed->outHeader();
foreach ($items as & $item)
$feed->outItem($item);
$feed->outFooter();
} else {
// Error has occured, print something useful
ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );
}
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiFormatBase.php 48521 2009-03-18 19:25:29Z ialex $';
}
}
|
