3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
26 * This is the abstract base class for API formatters.
30 abstract class ApiFormatBase
extends ApiBase
{
31 private $mIsHtml, $mFormat;
32 private $mBuffer, $mDisabled = false;
33 private $mIsWrappedHtml = false;
34 private $mHttpStatus = 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'
48 $this->mIsWrappedHtml
= $this->getMain()->getCheck( 'wrappedhtml' );
50 $this->mFormat
= $format;
52 $this->mFormat
= strtoupper( $this->mFormat
);
56 * Overriding class returns the MIME type that should be sent to the client.
58 * When getIsHtml() returns true, the return value here is used for syntax
59 * highlighting but the client sees text/html.
63 abstract public function getMimeType();
66 * Return a filename for this module's output.
67 * @note If $this->getIsWrappedHtml() || $this->getIsHtml(), you'll very
68 * likely want to fall back to this class's version.
70 * @return string Generally this should be "api-result.$ext"
72 public function getFilename() {
73 if ( $this->getIsWrappedHtml() ) {
74 return 'api-result-wrapped.json';
75 } elseif ( $this->getIsHtml() ) {
76 return 'api-result.html';
78 $exts = MediaWikiServices
::getInstance()->getMimeAnalyzer()
79 ->getExtensionsForType( $this->getMimeType() );
80 $ext = $exts ?
strtok( $exts, ' ' ) : strtolower( $this->mFormat
);
81 return "api-result.$ext";
86 * Get the internal format name
89 public function getFormat() {
90 return $this->mFormat
;
94 * Returns true when the HTML pretty-printer should be used.
95 * The default implementation assumes that formats ending with 'fm'
96 * should be formatted in HTML.
99 public function getIsHtml() {
100 return $this->mIsHtml
;
104 * Returns true when the special wrapped mode is enabled.
108 protected function getIsWrappedHtml() {
109 return $this->mIsWrappedHtml
;
113 * Disable the formatter.
115 * This causes calls to initPrinter() and closePrinter() to be ignored.
117 public function disable() {
118 $this->mDisabled
= true;
122 * Whether the printer is disabled
125 public function isDisabled() {
126 return $this->mDisabled
;
130 * Whether this formatter can handle printing API errors.
132 * If this returns false, then on API errors the default printer will be
137 public function canPrintErrors() {
142 * Ignore request parameters, force a default.
144 * Used as a fallback if errors are being thrown.
147 public function forceDefaultParams() {
148 $this->mForceDefaultParams
= true;
152 * Overridden to honor $this->forceDefaultParams(), if applicable
156 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
157 if ( !$this->mForceDefaultParams
) {
158 return parent
::getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
161 if ( !is_array( $paramSettings ) ) {
162 return $paramSettings;
165 return $paramSettings[self
::PARAM_DFLT
] ??
null;
169 * Set the HTTP status code to be used for the response
173 public function setHttpStatus( $code ) {
174 if ( $this->mDisabled
) {
178 if ( $this->getIsHtml() ) {
179 $this->mHttpStatus
= $code;
181 $this->getMain()->getRequest()->response()->statusHeader( $code );
186 * Initialize the printer function and prepare the output headers.
187 * @param bool $unused Always false since 1.25
189 public function initPrinter( $unused = false ) {
190 if ( $this->mDisabled
) {
194 $mime = $this->getIsWrappedHtml()
195 ?
'text/mediawiki-api-prettyprint-wrapped'
196 : ( $this->getIsHtml() ?
'text/html' : $this->getMimeType() );
198 // Some printers (ex. Feed) do their own header settings,
199 // in which case $mime will be set to null
200 if ( $mime === null ) {
201 return; // skip any initialization
204 $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
206 // Set X-Frame-Options API results (T41180)
207 $apiFrameOptions = $this->getConfig()->get( 'ApiFrameOptions' );
208 if ( $apiFrameOptions ) {
209 $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
212 // Set a Content-Disposition header so something downloading an API
213 // response uses a halfway-sensible filename (T128209).
214 $header = 'Content-Disposition: inline';
215 $filename = $this->getFilename();
216 $compatFilename = mb_convert_encoding( $filename, 'ISO-8859-1' );
217 if ( preg_match( '/^[0-9a-zA-Z!#$%&\'*+\-.^_`|~]+$/', $compatFilename ) ) {
218 $header .= '; filename=' . $compatFilename;
220 $header .= '; filename="'
221 . preg_replace( '/([\0-\x1f"\x5c\x7f])/', '\\\\$1', $compatFilename ) . '"';
223 if ( $compatFilename !== $filename ) {
224 $value = "UTF-8''" . rawurlencode( $filename );
225 // rawurlencode() encodes more characters than RFC 5987 specifies. Unescape the ones it allows.
226 $value = strtr( $value, [
227 '%21' => '!', '%23' => '#', '%24' => '$', '%26' => '&', '%2B' => '+', '%5E' => '^',
228 '%60' => '`', '%7C' => '|',
230 $header .= '; filename*=' . $value;
232 $this->getMain()->getRequest()->response()->header( $header );
236 * Finish printing and output buffered data.
238 public function closePrinter() {
239 if ( $this->mDisabled
) {
243 $mime = $this->getMimeType();
244 if ( $this->getIsHtml() && $mime !== null ) {
245 $format = $this->getFormat();
246 $lcformat = strtolower( $format );
247 $result = $this->getBuffer();
249 $context = new DerivativeContext( $this->getMain() );
250 $skinFactory = MediaWikiServices
::getInstance()->getSkinFactory();
251 $context->setSkin( $skinFactory->makeSkin( 'apioutput' ) );
252 $context->setTitle( SpecialPage
::getTitleFor( 'ApiHelp' ) );
253 $out = new OutputPage( $context );
254 $context->setOutput( $out );
256 $out->setRobotPolicy( 'noindex,nofollow' );
257 $out->addModuleStyles( 'mediawiki.apipretty' );
258 $out->setPageTitle( $context->msg( 'api-format-title' ) );
260 if ( !$this->getIsWrappedHtml() ) {
261 // When the format without suffix 'fm' is defined, there is a non-html version
262 if ( $this->getMain()->getModuleManager()->isDefined( $lcformat, 'format' ) ) {
263 if ( !$this->getRequest()->wasPosted() ) {
264 $nonHtmlUrl = strtok( $this->getRequest()->getFullRequestURL(), '?' )
265 . '?' . $this->getRequest()->appendQueryValue( 'format', $lcformat );
266 $msg = $context->msg( 'api-format-prettyprint-header-hyperlinked' )
267 ->params( $format, $lcformat, $nonHtmlUrl );
269 $msg = $context->msg( 'api-format-prettyprint-header' )->params( $format, $lcformat );
272 $msg = $context->msg( 'api-format-prettyprint-header-only-html' )->params( $format );
275 $header = $msg->parseAsBlock();
277 Html
::rawElement( 'div', [ 'class' => 'api-pretty-header' ],
278 ApiHelp
::fixHelpLinks( $header )
282 if ( $this->mHttpStatus
&& $this->mHttpStatus
!== 200 ) {
284 Html
::rawElement( 'div', [ 'class' => 'api-pretty-header api-pretty-status' ],
286 'api-format-prettyprint-status',
288 HttpStatus
::getMessage( $this->mHttpStatus
)
295 if ( Hooks
::run( 'ApiFormatHighlight', [ $context, $result, $mime, $format ] ) ) {
297 Html
::element( 'pre', [ 'class' => 'api-pretty-content' ], $result )
301 if ( $this->getIsWrappedHtml() ) {
302 // This is a special output mode mainly intended for ApiSandbox use
303 $time = $this->getMain()->getRequest()->getElapsedTime();
304 $json = FormatJson
::encode(
306 'status' => (int)( $this->mHttpStatus ?
: 200 ),
307 'statustext' => HttpStatus
::getMessage( $this->mHttpStatus ?
: 200 ),
308 'html' => $out->getHTML(),
309 'modules' => array_values( array_unique( array_merge(
311 $out->getModuleStyles()
313 'continue' => $this->getResult()->getResultData( 'continue' ),
314 'time' => round( $time * 1000 ),
316 false, FormatJson
::ALL_OK
319 // T68776: OutputHandler::mangleFlashPolicy() avoids a nasty bug in
320 // Flash, but what it does isn't friendly for the API, so we need to
322 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
323 $json = preg_replace(
324 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
330 // API handles its own clickjacking protection.
331 // Note, that $wgBreakFrames will still override $wgApiFrameOptions for format mode.
332 $out->allowClickjacking();
336 // For non-HTML output, clear all errors that might have been
337 // displayed if display_errors=On
340 echo $this->getBuffer();
345 * Append text to the output buffer.
346 * @param string $text
348 public function printText( $text ) {
349 $this->mBuffer
.= $text;
353 * Get the contents of the buffer.
356 public function getBuffer() {
357 return $this->mBuffer
;
360 public function getAllowedParams() {
362 if ( $this->getIsHtml() ) {
363 $ret['wrappedhtml'] = [
364 ApiBase
::PARAM_DFLT
=> false,
365 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-format-param-wrappedhtml',
372 protected function getExamplesMessages() {
374 'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
375 => [ 'apihelp-format-example-generic', $this->getFormat() ]
379 public function getHelpUrls() {
380 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Data_formats';
386 * For really cool vim folding this needs to be at the end:
387 * vim: foldmarker=@{,@} foldmethod=marker