5 * Created on Sep 19, 2006
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * This is the abstract base class for API formatters.
32 abstract class ApiFormatBase
extends ApiBase
{
33 private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp;
34 private $mBuffer, $mDisabled = false;
35 protected $mForceDefaultParams = false;
38 * If $format ends with 'fm', pretty-print the output in HTML.
39 * @param ApiMain $main
40 * @param string $format Format name
42 public function __construct( ApiMain
$main, $format ) {
43 parent
::__construct( $main, $format );
45 $this->mIsHtml
= ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'
46 if ( $this->mIsHtml
) {
47 $this->mFormat
= substr( $format, 0, -2 ); // remove ending 'fm'
49 $this->mFormat
= $format;
51 $this->mFormat
= strtoupper( $this->mFormat
);
55 * Overriding class returns the MIME type that should be sent to the client.
57 * When getIsHtml() returns true, the return value here is used for syntax
58 * highlighting but the client sees text/html.
62 abstract public function getMimeType();
65 * Get the internal format name
68 public function getFormat() {
69 return $this->mFormat
;
73 * Returns true when the HTML pretty-printer should be used.
74 * The default implementation assumes that formats ending with 'fm'
75 * should be formatted in HTML.
78 public function getIsHtml() {
79 return $this->mIsHtml
;
83 * Disable the formatter.
85 * This causes calls to initPrinter() and closePrinter() to be ignored.
87 public function disable() {
88 $this->mDisabled
= true;
92 * Whether the printer is disabled
95 public function isDisabled() {
96 return $this->mDisabled
;
100 * Whether this formatter can handle printing API errors.
102 * If this returns false, then on API errors the default printer will be
107 public function canPrintErrors() {
112 * Ignore request parameters, force a default.
114 * Used as a fallback if errors are being thrown.
117 public function forceDefaultParams() {
118 $this->mForceDefaultParams
= true;
122 * Overridden to honor $this->forceDefaultParams(), if applicable
125 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
126 if ( !$this->mForceDefaultParams
) {
127 return parent
::getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
130 if ( !is_array( $paramSettings ) ) {
131 return $paramSettings;
132 } elseif ( isset( $paramSettings[self
::PARAM_DFLT
] ) ) {
133 return $paramSettings[self
::PARAM_DFLT
];
140 * Initialize the printer function and prepare the output headers.
141 * @param bool $unused Always false since 1.25
143 function initPrinter( $unused = false ) {
144 if ( $this->mDisabled
) {
148 $mime = $this->getIsHtml() ?
'text/html' : $this->getMimeType();
150 // Some printers (ex. Feed) do their own header settings,
151 // in which case $mime will be set to null
152 if ( $mime === null ) {
153 return; // skip any initialization
156 $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
158 //Set X-Frame-Options API results (bug 39180)
159 $apiFrameOptions = $this->getConfig()->get( 'ApiFrameOptions' );
160 if ( $apiFrameOptions ) {
161 $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
166 * Finish printing and output buffered data.
168 public function closePrinter() {
169 if ( $this->mDisabled
) {
173 $mime = $this->getMimeType();
174 if ( $this->getIsHtml() && $mime !== null ) {
175 $format = $this->getFormat();
176 $result = $this->getBuffer();
178 $context = new DerivativeContext( $this->getMain() );
179 $context->setSkin( SkinFactory
::getDefaultInstance()->makeSkin( 'apioutput' ) );
180 $context->setTitle( SpecialPage
::getTitleFor( 'ApiHelp' ) );
181 $out = new OutputPage( $context );
182 $context->setOutput( $out );
184 $out->addModules( 'mediawiki.apipretty' );
185 $out->setPageTitle( $context->msg( 'api-format-title' ) );
187 $header = $context->msg( 'api-format-prettyprint-header' )
188 ->params( $format, strtolower( $format ) )
191 Html
::rawElement( 'div', array( 'class' => 'api-pretty-header' ),
192 ApiHelp
::fixHelpLinks( $header )
196 if ( Hooks
::run( 'ApiFormatHighlight', array( $context, $result, $mime, $format ) ) ) {
198 Html
::element( 'pre', array( 'class' => 'api-pretty-content' ), $result )
202 // API handles its own clickjacking protection.
203 // Note, that $wgBreakFrames will still override $wgApiFrameOptions for format mode.
204 $out->allowClickJacking();
207 // For non-HTML output, clear all errors that might have been
208 // displayed if display_errors=On
211 echo $this->getBuffer();
216 * Append text to the output buffer.
217 * @param string $text
219 public function printText( $text ) {
220 $this->mBuffer
.= $text;
224 * Get the contents of the buffer.
227 public function getBuffer() {
228 return $this->mBuffer
;
231 protected function getExamplesMessages() {
233 'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
234 => array( 'apihelp-format-example-generic', $this->getFormat() )
238 public function getHelpUrls() {
239 return 'https://www.mediawiki.org/wiki/API:Data_formats';
243 * To avoid code duplication with the deprecation of dbg, dump, txt, wddx,
244 * and yaml, this method is added to do the necessary work. It should be
245 * removed when those deprecated formats are removed.
247 protected function markDeprecated() {
248 $fm = $this->getIsHtml() ?
'fm' : '';
249 $name = $this->getModuleName();
250 $this->logFeatureUsage( "format=$name" );
251 $this->setWarning( "format=$name has been deprecated. Please use format=json$fm instead." );
254 /************************************************************************//**
260 * Specify whether or not sequences like &quot; should be unescaped
261 * to " . This should only be set to true for the help message
262 * when rendered in the default (xmlfm) format. This is a temporary
263 * special-case fix that should be removed once the help has been
264 * reworked to use a fully HTML interface.
266 * @deprecated since 1.25
267 * @param bool $b Whether or not ampersands should be escaped.
269 public function setUnescapeAmps( $b ) {
270 wfDeprecated( __METHOD__
, '1.25' );
271 $this->mUnescapeAmps
= $b;
275 * Whether this formatter can format the help message in a nice way.
276 * By default, this returns the same as getIsHtml().
277 * When action=help is set explicitly, the help will always be shown
278 * @deprecated since 1.25
281 public function getWantsHelp() {
282 wfDeprecated( __METHOD__
, '1.25' );
283 return $this->getIsHtml();
287 * Sets whether the pretty-printer should format *bold*
288 * @deprecated since 1.25
291 public function setHelp( $help = true ) {
292 wfDeprecated( __METHOD__
, '1.25' );
293 $this->mHelp
= $help;
297 * Pretty-print various elements in HTML format, such as xml tags and
298 * URLs. This method also escapes characters like <
299 * @deprecated since 1.25
300 * @param string $text
303 protected function formatHTML( $text ) {
304 wfDeprecated( __METHOD__
, '1.25' );
306 // Escape everything first for full coverage
307 $text = htmlspecialchars( $text );
309 if ( $this->mFormat
=== 'XML' ||
$this->mFormat
=== 'WDDX' ) {
310 // encode all comments or tags as safe blue strings
311 $text = str_replace( '<', '<span style="color:blue;"><', $text );
312 $text = str_replace( '>', '></span>', $text );
315 // identify requests to api.php
316 $text = preg_replace( '#^(\s*)(api\.php\?[^ <\n\t]+)$#m', '\1<a href="\2">\2</a>', $text );
317 if ( $this->mHelp
) {
318 // make lines inside * bold
319 $text = preg_replace( '#^(\s*)(\*[^<>\n]+\*)(\s*)$#m', '$1<b>$2</b>$3', $text );
322 // Armor links (bug 61362)
324 $text = preg_replace_callback( '#<a .*?</a>#', function ( $matches ) use ( &$masked ) {
325 $sha = sha1( $matches[0] );
326 $masked[$sha] = $matches[0];
331 $protos = wfUrlProtocolsWithoutProtRel();
332 // This regex hacks around bug 13218 (" included in the URL)
333 $text = preg_replace(
334 "#(((?i)$protos).*?)(")?([ \\'\"<>\n]|<|>|")#",
335 '<a href="\\1">\\1</a>\\3\\4',
340 $text = preg_replace_callback( '#<([0-9a-f]{40})>#', function ( $matches ) use ( &$masked ) {
342 return isset( $masked[$sha] ) ?
$masked[$sha] : $matches[0];
346 * Temporary fix for bad links in help messages. As a special case,
347 * XML-escaped metachars are de-escaped one level in the help message
348 * for legibility. Should be removed once we have completed a fully-HTML
349 * version of the help message.
351 if ( $this->mUnescapeAmps
) {
352 $text = preg_replace( '/&(amp|quot|lt|gt);/', '&\1;', $text );
359 * @see ApiBase::getDescription
360 * @deprecated since 1.25
362 public function getDescription() {
363 return $this->getIsHtml() ?
' (pretty-print in HTML)' : '';
367 * Set the flag to buffer the result instead of printing it.
368 * @deprecated since 1.25, output is always buffered
371 public function setBufferResult( $value ) {
375 * Formerly indicated whether the formatter needed metadata from ApiResult.
377 * ApiResult previously (indirectly) used this to decide whether to add
378 * metadata or to ignore calls to metadata-setting methods, which
379 * unfortunately made several methods that should have been static have to
380 * be dynamic instead. Now ApiResult always stores metadata and formatters
381 * are required to ignore it or filter it out.
383 * @deprecated since 1.25
386 public function getNeedsRawData() {
394 * For really cool vim folding this needs to be at the end:
395 * vim: foldmarker=@{,@} foldmethod=marker