2006-09-23 15:57:16 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Created on Sep 19, 2006
|
|
|
|
|
*
|
|
|
|
|
* API for MediaWiki 1.8+
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@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
|
2006-10-01 02:02:13 +00:00
|
|
|
require_once ('ApiBase.php');
|
2006-09-23 15:57:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
abstract class ApiFormatBase extends ApiBase {
|
|
|
|
|
|
|
|
|
|
private $mIsHtml, $mFormat, $mOriginalFormat;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Constructor
|
|
|
|
|
*/
|
|
|
|
|
public function __construct($main, $format) {
|
|
|
|
|
parent :: __construct($main);
|
|
|
|
|
|
|
|
|
|
$this->mOriginalFormat = $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);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Overriding class returns the mime type that should be sent to the client.
|
2006-09-27 05:13:48 +00:00
|
|
|
* This method is not called if getIsHtml() returns true.
|
2006-09-23 15:57:16 +00:00
|
|
|
* @return string
|
|
|
|
|
*/
|
2006-09-27 05:13:48 +00:00
|
|
|
public abstract function getMimeType();
|
2006-09-23 15:57:16 +00:00
|
|
|
|
2006-09-27 05:13:48 +00:00
|
|
|
public function getNeedsRawData() {
|
2006-09-25 04:12:07 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2006-09-23 15:57:16 +00:00
|
|
|
/**
|
|
|
|
|
* Returns true when an HTML filtering printer should be used.
|
|
|
|
|
* The default implementation assumes that formats ending with 'fm'
|
|
|
|
|
* should be formatted in HTML.
|
|
|
|
|
*/
|
2006-09-27 05:13:48 +00:00
|
|
|
public function getIsHtml() {
|
2006-09-23 15:57:16 +00:00
|
|
|
return $this->mIsHtml;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Initialize the printer function and prepares 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
|
|
|
|
|
*/
|
2006-09-27 05:13:48 +00:00
|
|
|
function initPrinter($isError) {
|
|
|
|
|
$isHtml = $this->getIsHtml();
|
|
|
|
|
$mime = $isHtml ? 'text/html' : $this->getMimeType();
|
2006-09-23 15:57:16 +00:00
|
|
|
header("Content-Type: $mime; charset=utf-8;");
|
|
|
|
|
|
|
|
|
|
if ($isHtml) {
|
|
|
|
|
?>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>MediaWiki API</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if (!$isError) {
|
|
|
|
|
?>
|
2006-09-23 23:30:25 +00:00
|
|
|
<br/>
|
2006-09-23 15:57:16 +00:00
|
|
|
<small>
|
|
|
|
|
This result is being shown in <?=$this->mFormat?> format,
|
|
|
|
|
which might not be suitable for your application.<br/>
|
2006-10-01 02:02:13 +00:00
|
|
|
See <a href='api.php'>API help</a> for more information.<br/>
|
2006-09-23 15:57:16 +00:00
|
|
|
</small>
|
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
?>
|
|
|
|
|
<pre>
|
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Finish printing. Closes HTML tags.
|
|
|
|
|
*/
|
2006-09-27 05:13:48 +00:00
|
|
|
public function closePrinter() {
|
|
|
|
|
if ($this->getIsHtml()) {
|
2006-09-23 15:57:16 +00:00
|
|
|
?>
|
|
|
|
|
</pre>
|
|
|
|
|
</body>
|
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2006-09-27 05:13:48 +00:00
|
|
|
public function printText($text) {
|
|
|
|
|
if ($this->getIsHtml())
|
|
|
|
|
echo $this->formatHTML($text);
|
2006-09-23 15:57:16 +00:00
|
|
|
else
|
|
|
|
|
echo $text;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Prety-print various elements in HTML format, such as xml tags and URLs.
|
2006-10-01 02:02:13 +00:00
|
|
|
* This method also replaces any '<' with <
|
2006-09-23 15:57:16 +00:00
|
|
|
*/
|
2006-09-27 05:13:48 +00:00
|
|
|
protected function formatHTML($text) {
|
2006-09-23 15:57:16 +00:00
|
|
|
// encode all tags as safe blue strings
|
|
|
|
|
$text = ereg_replace('\<([^>]+)\>', '<font color=blue><\1></font>', $text);
|
|
|
|
|
// identify URLs
|
|
|
|
|
$text = ereg_replace("[a-zA-Z]+://[^ '()<\n]+", '<a href="\\0">\\0</a>', $text);
|
|
|
|
|
// identify requests to api.php
|
2006-09-25 06:10:16 +00:00
|
|
|
$text = ereg_replace("api\\.php\\?[^ ()<\n\t]+", '<a href="\\0">\\0</a>', $text);
|
2006-09-23 15:57:16 +00:00
|
|
|
// make strings inside * bold
|
|
|
|
|
$text = ereg_replace("\\*[^<>\n]+\\*", '<b>\\0</b>', $text);
|
2006-10-02 18:27:06 +00:00
|
|
|
// make strings inside $ italic
|
|
|
|
|
$text = ereg_replace("\\$[^<>\n]+\\$", '<b><i>\\0</i></b>', $text);
|
2006-09-26 06:37:26 +00:00
|
|
|
|
2006-09-23 15:57:16 +00:00
|
|
|
return $text;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns usage examples for this format.
|
|
|
|
|
*/
|
2006-09-27 05:13:48 +00:00
|
|
|
protected function getExamples() {
|
2006-09-23 15:57:16 +00:00
|
|
|
return 'api.php?action=query&meta=siteinfo&si=namespaces&format=' . $this->mOriginalFormat;
|
|
|
|
|
}
|
2006-10-01 21:20:55 +00:00
|
|
|
|
|
|
|
|
public static function getBaseVersion() {
|
|
|
|
|
return __CLASS__ . ': $Id$';
|
|
|
|
|
}
|
2006-09-23 15:57:16 +00:00
|
|
|
}
|
|
|
|
|
?>
|
