/**
* This is the abstract base class for API formatters.
- *
- * @addtogroup API
+ *
+ * @ingroup API
*/
abstract class ApiFormatBase extends ApiBase {
- private $mIsHtml, $mFormat;
+ private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp, $mCleared;
/**
* Create a new instance of the formatter.
else
$this->mFormat = $format;
$this->mFormat = strtoupper($this->mFormat);
+ $this->mCleared = false;
}
/**
/**
* If formatter outputs data results as is, the results must first be sanitized.
* An XML formatter on the other hand uses special tags, such as "_element" for special handling,
- * and thus needs to override this function to return true.
+ * and thus needs to override this function to return true.
*/
public function getNeedsRawData() {
return false;
}
+ /**
+ * Specify whether or not ampersands should be escaped to '&' when rendering. 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 boolean Whether or not ampersands should be escaped.
+ */
+ public function setUnescapeAmps ( $b ) {
+ $this->mUnescapeAmps = $b;
+ }
+
/**
* Returns true when an HTML filtering printer should be used.
- * The default implementation assumes that formats ending with 'fm'
- * should be formatted in HTML.
+ * The default implementation assumes that formats ending with 'fm'
+ * should be formatted in HTML.
*/
public function getIsHtml() {
return $this->mIsHtml;
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
- <title>MediaWiki API</title>
+<?php if ($this->mUnescapeAmps) {
+?> <title>MediaWiki API</title>
+<?php } else {
+?> <title>MediaWiki API Result</title>
+<?php } ?>
</head>
<body>
<?php
- if (!$isError) {
+ if( !$isError ) {
?>
<br/>
<small>
-You are looking at the HTML representation of the <?=$this->mFormat?> format.<br/>
+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='api.php'>API help</a> for more information.
+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
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;
+ }
+ }
+
+ /**
+ * Says pretty-printer that it should use *bold* and $italics$ formatting
+ */
+ public function setHelp( $help = true ) {
+ $this->mHelp = true;
}
/**
* This method also replaces any '<' with <
*/
protected function formatHTML($text) {
- // encode all tags as safe blue strings
- $text = ereg_replace('\<([^>]+)\>', '<span style="color:blue;"><\1></span>', $text);
+ // 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 = "http|https|ftp|gopher";
- $text = ereg_replace("($protos)://[^ \\'\"()<\n]+", '<a href="\\0">\\0</a>', $text);
+ # 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 = ereg_replace("api\\.php\\?[^ \\()<\n\t]+", '<a href="\\0">\\0</a>', $text);
- // make strings inside * bold
- $text = ereg_replace("\\*[^<>\n]+\\*", '<b>\\0</b>', $text);
- // make strings inside $ italic
- $text = ereg_replace("\\$[^<>\n]+\\$", '<b><i>\\0</i></b>', $text);
+ $text = preg_replace("#api\\.php\\?[^ \\()<\n\t]+#", '<a href="\\0">\\0</a>', $text);
+ if( $this->mHelp ) {
+ // make strings inside * bold
+ $text = ereg_replace("\\*[^<>\n]+\\*", '<b>\\0</b>', $text);
+ // make strings inside $ italic
+ $text = ereg_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;
}
return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName();
}
- protected function getDescription() {
+ public function getDescription() {
return $this->getIsHtml() ? ' (pretty-print in HTML)' : '';
}
}
/**
- * This printer is used to wrap an instance of the Feed class
- * @addtogroup API
+ * This printer is used to wrap an instance of the Feed class
+ * @ingroup API
*/
class ApiFormatFeedWrapper extends ApiFormatBase {
$feed->outItem($item);
$feed->outFooter();
} else {
- // Error has occured, print something usefull
- // TODO: make this error more informative using ApiBase :: dieDebug() or similar
- wfHttpError(500, 'Internal Server Error', '');
+ // Error has occured, print something useful
+ ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );
}
}
-
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
dépôts / lhc / web / wiklou.git / blobdiff