4 * Created on Sep 19, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiBase.php');
32 * This is the abstract base class for API formatters.
36 abstract class ApiFormatBase
extends ApiBase
{
38 private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp, $mCleared;
41 * Create a new instance of the formatter.
42 * If the format name ends with 'fm', wrap its output in the proper HTML.
44 public function __construct($main, $format) {
45 parent
:: __construct($main, $format);
47 $this->mIsHtml
= (substr($format, -2, 2) === 'fm'); // ends with 'fm'
49 $this->mFormat
= substr($format, 0, -2); // remove ending 'fm'
51 $this->mFormat
= $format;
52 $this->mFormat
= strtoupper($this->mFormat
);
53 $this->mCleared
= false;
57 * Overriding class returns the mime type that should be sent to the client.
58 * This method is not called if getIsHtml() returns true.
61 public abstract function getMimeType();
64 * If formatter outputs data results as is, the results must first be sanitized.
65 * An XML formatter on the other hand uses special tags, such as "_element" for special handling,
66 * and thus needs to override this function to return true.
68 public function getNeedsRawData() {
73 * Get the internal format name
75 public function getFormat() {
76 return $this->mFormat
;
80 * Specify whether or not ampersands should be escaped to '&' when rendering. This
81 * should only be set to true for the help message when rendered in the default (xmlfm)
82 * format. This is a temporary special-case fix that should be removed once the help
83 * has been reworked to use a fully html interface.
85 * @param boolean Whether or not ampersands should be escaped.
87 public function setUnescapeAmps ( $b ) {
88 $this->mUnescapeAmps
= $b;
92 * Returns true when an HTML filtering printer should be used.
93 * The default implementation assumes that formats ending with 'fm'
94 * should be formatted in HTML.
96 public function getIsHtml() {
97 return $this->mIsHtml
;
101 * Initialize the printer function and prepares the output headers, etc.
102 * This method must be the first outputing method during execution.
103 * A help screen's header is printed for the HTML-based output
105 function initPrinter($isError) {
106 $isHtml = $this->getIsHtml();
107 $mime = $isHtml ?
'text/html' : $this->getMimeType();
108 $script = wfScript( 'api' );
110 // Some printers (ex. Feed) do their own header settings,
111 // in which case $mime will be set to null
113 return; // skip any initialization
115 header("Content-Type: $mime; charset=utf-8");
119 <!DOCTYPE HTML
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
122 <?php
if ($this->mUnescapeAmps
) {
123 ?
> <title
>MediaWiki API
</title
>
125 ?
> <title
>MediaWiki API Result
</title
>
136 You are looking at the HTML representation of the
<?php
echo( $this->mFormat
); ?
> format
.<br
/>
137 HTML is good
for debugging
, but probably is not suitable
for your application
.<br
/>
138 See
<a href
='http://www.mediawiki.org/wiki/API'>complete documentation
</a
>, or
139 <a href
='<?php echo( $script ); ?>'>API help
</a
> for more information
.
154 * Finish printing. Closes HTML tags.
156 public function closePrinter() {
157 if ($this->getIsHtml()) {
170 * The main format printing function. Call it to output the result string to the user.
171 * This function will automatically output HTML when format name ends in 'fm'.
173 public function printText($text) {
174 if ($this->getIsHtml())
175 echo $this->formatHTML($text);
178 // For non-HTML output, clear all errors that might have been
179 // displayed if display_errors=On
180 // Do this only once, of course
184 $this->mCleared
= true;
191 * Says pretty-printer that it should use *bold* and $italics$ formatting
193 public function setHelp( $help = true ) {
198 * Prety-print various elements in HTML format, such as xml tags and URLs.
199 * This method also replaces any '<' with <
201 protected function formatHTML($text) {
202 global $wgUrlProtocols;
204 // Escape everything first for full coverage
205 $text = htmlspecialchars($text);
207 // encode all comments or tags as safe blue strings
208 $text = preg_replace('/\<(!--.*?--|.*?)\>/', '<span style="color:blue;"><\1></span>', $text);
210 $protos = implode("|", $wgUrlProtocols);
211 # This regex hacks around bug 13218 (" included in the URL)
212 $text = preg_replace("#(($protos).*?)(")?([ \\'\"()<\n])#", '<a href="\\1">\\1</a>\\3\\4', $text);
213 // identify requests to api.php
214 $text = preg_replace("#api\\.php\\?[^ \\()<\n\t]+#", '<a href="\\0">\\0</a>', $text);
216 // make strings inside * bold
217 $text = ereg_replace("\\*[^<>\n]+\\*", '<b>\\0</b>', $text);
218 // make strings inside $ italic
219 $text = ereg_replace("\\$[^<>\n]+\\$", '<b><i>\\0</i></b>', $text);
222 /* Temporary fix for bad links in help messages. As a special case,
223 * XML-escaped metachars are de-escaped one level in the help message
224 * for legibility. Should be removed once we have completed a fully-html
225 * version of the help message. */
226 if ( $this->mUnescapeAmps
)
227 $text = preg_replace( '/&(amp|quot|lt|gt);/', '&\1;', $text );
233 * Returns usage examples for this format.
235 protected function getExamples() {
236 return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName();
239 public function getDescription() {
240 return $this->getIsHtml() ?
' (pretty-print in HTML)' : '';
243 public static function getBaseVersion() {
244 return __CLASS__
. ': $Id$';
249 * This printer is used to wrap an instance of the Feed class
252 class ApiFormatFeedWrapper
extends ApiFormatBase
{
254 public function __construct($main) {
255 parent
:: __construct($main, 'feed');
259 * Call this method to initialize output data. See self::execute()
261 public static function setResult($result, $feed, $feedItems) {
262 // Store output in the Result data.
263 // This way we can check during execution if any error has occured
264 $data = & $result->getData();
265 $data['_feed'] = $feed;
266 $data['_feeditems'] = $feedItems;
270 * Feed does its own headers
272 public function getMimeType() {
277 * Optimization - no need to sanitize data that will not be needed
279 public function getNeedsRawData() {
284 * This class expects the result data to be in a custom format set by self::setResult()
285 * $result['_feed'] - an instance of one of the $wgFeedClasses classes
286 * $result['_feeditems'] - an array of FeedItem instances
288 public function execute() {
289 $data = $this->getResultData();
290 if (isset ($data['_feed']) && isset ($data['_feeditems'])) {
291 $feed = $data['_feed'];
292 $items = $data['_feeditems'];
295 foreach ($items as & $item)
296 $feed->outItem($item);
299 // Error has occured, print something useful
300 ApiBase
::dieDebug( __METHOD__
, 'Invalid feed class/item' );
304 public function getVersion() {
305 return __CLASS__
. ': $Id$';