includes/api/ApiFormatBase.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * This is the abstract base class for API formatters.
  25  *
  26  * @ingroup API
  27  */
  28 abstract class ApiFormatBase extends ApiBase {
  29         private $mIsHtml, $mFormat;
  30         private $mBuffer, $mDisabled = false;
  31         private $mIsWrappedHtml = false;
  32         private $mHttpStatus = false;
  33         protected $mForceDefaultParams = false;
  34
  35         /**
  36          * If $format ends with 'fm', pretty-print the output in HTML.
  37          * @param ApiMain $main
  38          * @param string $format Format name
  39          */
  40         public function __construct( ApiMain $main, $format ) {
  41                 parent::__construct( $main, $format );
  42
  43                 $this->mIsHtml = ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'
  44                 if ( $this->mIsHtml ) {
  45                         $this->mFormat = substr( $format, 0, -2 ); // remove ending 'fm'
  46                         $this->mIsWrappedHtml = $this->getMain()->getCheck( 'wrappedhtml' );
  47                 } else {
  48                         $this->mFormat = $format;
  49                 }
  50                 $this->mFormat = strtoupper( $this->mFormat );
  51         }
  52
  53         /**
  54          * Overriding class returns the MIME type that should be sent to the client.
  55          *
  56          * When getIsHtml() returns true, the return value here is used for syntax
  57          * highlighting but the client sees text/html.
  58          *
  59          * @return string
  60          */
  61         abstract public function getMimeType();
  62
  63         /**
  64          * Return a filename for this module's output.
  65          * @note If $this->getIsWrappedHtml() || $this->getIsHtml(), you'll very
  66          *  likely want to fall back to this class's version.
  67          * @since 1.27
  68          * @return string Generally this should be "api-result.$ext", and must be
  69          *  encoded for inclusion in a Content-Disposition header's filename parameter.
  70          */
  71         public function getFilename() {
  72                 if ( $this->getIsWrappedHtml() ) {
  73                         return 'api-result-wrapped.json';
  74                 } elseif ( $this->getIsHtml() ) {
  75                         return 'api-result.html';
  76                 } else {
  77                         $exts = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer()
  78                                 ->getExtensionsForType( $this->getMimeType() );
  79                         $ext = $exts ? strtok( $exts, ' ' ) : strtolower( $this->mFormat );
  80                         return "api-result.$ext";
  81                 }
  82         }
  83
  84         /**
  85          * Get the internal format name
  86          * @return string
  87          */
  88         public function getFormat() {
  89                 return $this->mFormat;
  90         }
  91
  92         /**
  93          * Returns true when the HTML pretty-printer should be used.
  94          * The default implementation assumes that formats ending with 'fm'
  95          * should be formatted in HTML.
  96          * @return bool
  97          */
  98         public function getIsHtml() {
  99                 return $this->mIsHtml;
 100         }
 101
 102         /**
 103          * Returns true when the special wrapped mode is enabled.
 104          * @since 1.27
 105          * @return bool
 106          */
 107         protected function getIsWrappedHtml() {
 108                 return $this->mIsWrappedHtml;
 109         }
 110
 111         /**
 112          * Disable the formatter.
 113          *
 114          * This causes calls to initPrinter() and closePrinter() to be ignored.
 115          */
 116         public function disable() {
 117                 $this->mDisabled = true;
 118         }
 119
 120         /**
 121          * Whether the printer is disabled
 122          * @return bool
 123          */
 124         public function isDisabled() {
 125                 return $this->mDisabled;
 126         }
 127
 128         /**
 129          * Whether this formatter can handle printing API errors.
 130          *
 131          * If this returns false, then on API errors the default printer will be
 132          * instantiated.
 133          * @since 1.23
 134          * @return bool
 135          */
 136         public function canPrintErrors() {
 137                 return true;
 138         }
 139
 140         /**
 141          * Ignore request parameters, force a default.
 142          *
 143          * Used as a fallback if errors are being thrown.
 144          * @since 1.26
 145          */
 146         public function forceDefaultParams() {
 147                 $this->mForceDefaultParams = true;
 148         }
 149
 150         /**
 151          * Overridden to honor $this->forceDefaultParams(), if applicable
 152          * @inheritDoc
 153          * @since 1.26
 154          */
 155         protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
 156                 if ( !$this->mForceDefaultParams ) {
 157                         return parent::getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
 158                 }
 159
 160                 if ( !is_array( $paramSettings ) ) {
 161                         return $paramSettings;
 162                 } elseif ( isset( $paramSettings[self::PARAM_DFLT] ) ) {
 163                         return $paramSettings[self::PARAM_DFLT];
 164                 } else {
 165                         return null;
 166                 }
 167         }
 168
 169         /**
 170          * Set the HTTP status code to be used for the response
 171          * @since 1.29
 172          * @param int $code
 173          */
 174         public function setHttpStatus( $code ) {
 175                 if ( $this->mDisabled ) {
 176                         return;
 177                 }
 178
 179                 if ( $this->getIsHtml() ) {
 180                         $this->mHttpStatus = $code;
 181                 } else {
 182                         $this->getMain()->getRequest()->response()->statusHeader( $code );
 183                 }
 184         }
 185
 186         /**
 187          * Initialize the printer function and prepare the output headers.
 188          * @param bool $unused Always false since 1.25
 189          */
 190         public function initPrinter( $unused = false ) {
 191                 if ( $this->mDisabled ) {
 192                         return;
 193                 }
 194
 195                 $mime = $this->getIsWrappedHtml()
 196                         ? 'text/mediawiki-api-prettyprint-wrapped'
 197                         : ( $this->getIsHtml() ? 'text/html' : $this->getMimeType() );
 198
 199                 // Some printers (ex. Feed) do their own header settings,
 200                 // in which case $mime will be set to null
 201                 if ( $mime === null ) {
 202                         return; // skip any initialization
 203                 }
 204
 205                 $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
 206
 207                 // Set X-Frame-Options API results (T41180)
 208                 $apiFrameOptions = $this->getConfig()->get( 'ApiFrameOptions' );
 209                 if ( $apiFrameOptions ) {
 210                         $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
 211                 }
 212
 213                 // Set a Content-Disposition header so something downloading an API
 214                 // response uses a halfway-sensible filename (T128209).
 215                 $filename = $this->getFilename();
 216                 $this->getMain()->getRequest()->response()->header(
 217                         "Content-Disposition: inline; filename=\"{$filename}\""
 218                 );
 219         }
 220
 221         /**
 222          * Finish printing and output buffered data.
 223          */
 224         public function closePrinter() {
 225                 if ( $this->mDisabled ) {
 226                         return;
 227                 }
 228
 229                 $mime = $this->getMimeType();
 230                 if ( $this->getIsHtml() && $mime !== null ) {
 231                         $format = $this->getFormat();
 232                         $lcformat = strtolower( $format );
 233                         $result = $this->getBuffer();
 234
 235                         $context = new DerivativeContext( $this->getMain() );
 236                         $context->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'apioutput' ) );
 237                         $context->setTitle( SpecialPage::getTitleFor( 'ApiHelp' ) );
 238                         $out = new OutputPage( $context );
 239                         $context->setOutput( $out );
 240
 241                         $out->addModuleStyles( 'mediawiki.apipretty' );
 242                         $out->setPageTitle( $context->msg( 'api-format-title' ) );
 243
 244                         if ( !$this->getIsWrappedHtml() ) {
 245                                 // When the format without suffix 'fm' is defined, there is a non-html version
 246                                 if ( $this->getMain()->getModuleManager()->isDefined( $lcformat, 'format' ) ) {
 247                                         if ( !$this->getRequest()->wasPosted() ) {
 248                                                 $nonHtmlUrl = strtok( $this->getRequest()->getFullRequestURL(), '?' )
 249                                                         . '?' . $this->getRequest()->appendQueryValue( 'format', $lcformat );
 250                                                 $msg = $context->msg( 'api-format-prettyprint-header-hyperlinked' )
 251                                                         ->params( $format, $lcformat, $nonHtmlUrl );
 252                                         } else {
 253                                                 $msg = $context->msg( 'api-format-prettyprint-header' )->params( $format, $lcformat );
 254                                         }
 255                                 } else {
 256                                         $msg = $context->msg( 'api-format-prettyprint-header-only-html' )->params( $format );
 257                                 }
 258
 259                                 $header = $msg->parseAsBlock();
 260                                 $out->addHTML(
 261                                         Html::rawElement( 'div', [ 'class' => 'api-pretty-header' ],
 262                                                 ApiHelp::fixHelpLinks( $header )
 263                                         )
 264                                 );
 265
 266                                 if ( $this->mHttpStatus && $this->mHttpStatus !== 200 ) {
 267                                         $out->addHTML(
 268                                                 Html::rawElement( 'div', [ 'class' => 'api-pretty-header api-pretty-status' ],
 269                                                         $this->msg(
 270                                                                 'api-format-prettyprint-status',
 271                                                                 $this->mHttpStatus,
 272                                                                 HttpStatus::getMessage( $this->mHttpStatus )
 273                                                         )->parse()
 274                                                 )
 275                                         );
 276                                 }
 277                         }
 278
 279                         if ( Hooks::run( 'ApiFormatHighlight', [ $context, $result, $mime, $format ] ) ) {
 280                                 $out->addHTML(
 281                                         Html::element( 'pre', [ 'class' => 'api-pretty-content' ], $result )
 282                                 );
 283                         }
 284
 285                         if ( $this->getIsWrappedHtml() ) {
 286                                 // This is a special output mode mainly intended for ApiSandbox use
 287                                 $time = microtime( true ) - $this->getConfig()->get( 'RequestTime' );
 288                                 $json = FormatJson::encode(
 289                                         [
 290                                                 'status' => (int)( $this->mHttpStatus ?: 200 ),
 291                                                 'statustext' => HttpStatus::getMessage( $this->mHttpStatus ?: 200 ),
 292                                                 'html' => $out->getHTML(),
 293                                                 'modules' => array_values( array_unique( array_merge(
 294                                                         $out->getModules(),
 295                                                         $out->getModuleScripts(),
 296                                                         $out->getModuleStyles()
 297                                                 ) ) ),
 298                                                 'continue' => $this->getResult()->getResultData( 'continue' ),
 299                                                 'time' => round( $time * 1000 ),
 300                                         ],
 301                                         false, FormatJson::ALL_OK
 302                                 );
 303
 304                                 // T68776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
 305                                 // Flash, but what it does isn't friendly for the API, so we need to
 306                                 // work around it.
 307                                 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
 308                                         $json = preg_replace(
 309                                                 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
 310                                         );
 311                                 }
 312
 313                                 echo $json;
 314                         } else {
 315                                 // API handles its own clickjacking protection.
 316                                 // Note, that $wgBreakFrames will still override $wgApiFrameOptions for format mode.
 317                                 $out->allowClickjacking();
 318                                 $out->output();
 319                         }
 320                 } else {
 321                         // For non-HTML output, clear all errors that might have been
 322                         // displayed if display_errors=On
 323                         ob_clean();
 324
 325                         echo $this->getBuffer();
 326                 }
 327         }
 328
 329         /**
 330          * Append text to the output buffer.
 331          * @param string $text
 332          */
 333         public function printText( $text ) {
 334                 $this->mBuffer .= $text;
 335         }
 336
 337         /**
 338          * Get the contents of the buffer.
 339          * @return string
 340          */
 341         public function getBuffer() {
 342                 return $this->mBuffer;
 343         }
 344
 345         public function getAllowedParams() {
 346                 $ret = [];
 347                 if ( $this->getIsHtml() ) {
 348                         $ret['wrappedhtml'] = [
 349                                 ApiBase::PARAM_DFLT => false,
 350                                 ApiBase::PARAM_HELP_MSG => 'apihelp-format-param-wrappedhtml',
 351
 352                         ];
 353                 }
 354                 return $ret;
 355         }
 356
 357         protected function getExamplesMessages() {
 358                 return [
 359                         'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
 360                                 => [ 'apihelp-format-example-generic', $this->getFormat() ]
 361                 ];
 362         }
 363
 364         public function getHelpUrls() {
 365                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Data_formats';
 366         }
 367
 368 }
 369
 370 /**
 371  * For really cool vim folding this needs to be at the end:
 372  * vim: foldmarker=@{,@} foldmethod=marker
 373  */