ApiFormatBase.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use HttpStatus;
use MediaWiki\Context\DerivativeContext;
use MediaWiki\Html\Html;
use MediaWiki\Json\FormatJson;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Output\OutputPage;
use MediaWiki\SpecialPage\SpecialPage;
use Wikimedia\ParamValidator\ParamValidator;
 
abstract class ApiFormatBase extends ApiBase {
    private bool $mIsHtml;
    private string $mFormat;
    private string $mBuffer = '';
    private bool $mDisabled = false;
    private $mIsWrappedHtml = false;
    private $mHttpStatus = false;
    protected $mForceDefaultParams = false;
 
    public function __construct( ApiMain $main, string $format ) {
        parent::__construct( $main, $format );
 
        $this->mIsHtml = str_ends_with( $format, 'fm' );
        if ( $this->mIsHtml ) {
            $this->mFormat = substr( $format, 0, -2 ); // remove ending 'fm'
            $this->mIsWrappedHtml = $this->getMain()->getCheck( 'wrappedhtml' );
        } else {
            $this->mFormat = $format;
        }
        $this->mFormat = strtoupper( $this->mFormat );
    }
 
    abstract public function getMimeType();
 
    public function getFilename() {
        if ( $this->getIsWrappedHtml() ) {
            return 'api-result-wrapped.json';
        }
 
        if ( $this->getIsHtml() ) {
            return 'api-result.html';
        }
 
        $mimeAnalyzer = MediaWikiServices::getInstance()->getMimeAnalyzer();
        $ext = $mimeAnalyzer->getExtensionFromMimeTypeOrNull( $this->getMimeType() )
            ?? strtolower( $this->mFormat );
        return "api-result.$ext";
    }
 
    public function getFormat() {
        return $this->mFormat;
    }
 
    public function getIsHtml() {
        return $this->mIsHtml;
    }
 
    protected function getIsWrappedHtml() {
        return $this->mIsWrappedHtml;
    }
 
    public function disable() {
        $this->mDisabled = true;
    }
 
    public function isDisabled() {
        return $this->mDisabled;
    }
 
    public function canPrintErrors() {
        return true;
    }
 
    public function forceDefaultParams() {
        $this->mForceDefaultParams = true;
    }
 
    protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
        if ( !$this->mForceDefaultParams ) {
            return parent::getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
        }
 
        if ( !is_array( $paramSettings ) ) {
            return $paramSettings;
        }
 
        return $paramSettings[ParamValidator::PARAM_DEFAULT] ?? null;
    }
 
    public function setHttpStatus( $code ) {
        if ( $this->mDisabled ) {
            return;
        }
 
        if ( $this->getIsHtml() ) {
            $this->mHttpStatus = $code;
        } else {
            $this->getMain()->getRequest()->response()->statusHeader( $code );
        }
    }
 
    public function initPrinter( $unused = false ) {
        if ( $this->mDisabled ) {
            return;
        }
 
        if ( $this->getIsHtml() && $this->getMain()->getCacheMode() === 'public' ) {
            // The HTML may contain user secrets! T354045
            $this->getMain()->setCacheMode( 'anon-public-user-private' );
        }
 
        $mime = $this->getIsWrappedHtml()
            ? 'text/mediawiki-api-prettyprint-wrapped'
            : ( $this->getIsHtml() ? 'text/html' : $this->getMimeType() );
 
        // Some printers (ex. Feed) do their own header settings,
        // in which case $mime will be set to null
        if ( $mime === null ) {
            return; // skip any initialization
        }
 
        $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
 
        // Set X-Frame-Options API results (T41180)
        $apiFrameOptions = $this->getConfig()->get( MainConfigNames::ApiFrameOptions );
        if ( $apiFrameOptions ) {
            $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
        }
 
        // Set a Content-Disposition header so something downloading an API
        // response uses a halfway-sensible filename (T128209).
        $header = 'Content-Disposition: inline';
        $filename = $this->getFilename();
        $compatFilename = mb_convert_encoding( $filename, 'ISO-8859-1' );
        if ( preg_match( '/^[0-9a-zA-Z!#$%&\'*+\-.^_`|~]+$/', $compatFilename ) ) {
            $header .= '; filename=' . $compatFilename;
        } else {
            $header .= '; filename="'
                . preg_replace( '/([\0-\x1f"\x5c\x7f])/', '\\\\$1', $compatFilename ) . '"';
        }
        if ( $compatFilename !== $filename ) {
            $value = "UTF-8''" . rawurlencode( $filename );
            // rawurlencode() encodes more characters than RFC 5987 specifies. Unescape the ones it allows.
            $value = strtr( $value, [
                '%21' => '!', '%23' => '#', '%24' => '$', '%26' => '&', '%2B' => '+', '%5E' => '^',
                '%60' => '`', '%7C' => '|',
            ] );
            $header .= '; filename*=' . $value;
        }
        $this->getMain()->getRequest()->response()->header( $header );
    }
 
    public function closePrinter() {
        if ( $this->mDisabled ) {
            return;
        }
 
        $mime = $this->getMimeType();
        if ( $this->getIsHtml() && $mime !== null ) {
            $format = $this->getFormat();
            $lcformat = strtolower( $format );
            $result = $this->getBuffer();
 
            $context = new DerivativeContext( $this->getMain() );
            $skinFactory = MediaWikiServices::getInstance()->getSkinFactory();
            $context->setSkin( $skinFactory->makeSkin( 'apioutput' ) );
            $context->setTitle( SpecialPage::getTitleFor( 'ApiHelp' ) );
            $out = new OutputPage( $context );
            $context->setOutput( $out );
 
            $out->setRobotPolicy( 'noindex,nofollow' );
            $out->addModuleStyles( 'mediawiki.apipretty' );
            $out->setPageTitleMsg( $context->msg( 'api-format-title' ) );
 
            if ( !$this->getIsWrappedHtml() ) {
                // When the format without suffix 'fm' is defined, there is a non-html version
                if ( $this->getMain()->getModuleManager()->isDefined( $lcformat, 'format' ) ) {
                    if ( !$this->getRequest()->wasPosted() ) {
                        $nonHtmlUrl = strtok( $this->getRequest()->getFullRequestURL(), '?' )
                            . '?' . $this->getRequest()->appendQueryValue( 'format', $lcformat );
                        $msg = $context->msg( 'api-format-prettyprint-header-hyperlinked' )
                            ->params( $format, $lcformat, $nonHtmlUrl );
                    } else {
                        $msg = $context->msg( 'api-format-prettyprint-header' )->params( $format, $lcformat );
                    }
                } else {
                    $msg = $context->msg( 'api-format-prettyprint-header-only-html' )->params( $format );
                }
 
                $header = $msg->parseAsBlock();
                $out->addHTML(
                    Html::rawElement( 'div', [ 'class' => 'api-pretty-header' ],
                        ApiHelp::fixHelpLinks( $header )
                    )
                );
 
                if ( $this->mHttpStatus && $this->mHttpStatus !== 200 ) {
                    $out->addHTML(
                        Html::rawElement( 'div', [ 'class' => [ 'api-pretty-header', 'api-pretty-status' ] ],
                            $this->msg(
                                'api-format-prettyprint-status',
                                $this->mHttpStatus,
                                HttpStatus::getMessage( $this->mHttpStatus )
                            )->parse()
                        )
                    );
                }
            }
 
            if ( $this->getHookRunner()->onApiFormatHighlight( $context, $result, $mime, $format ) ) {
                $out->addHTML(
                    Html::element( 'pre', [ 'class' => 'api-pretty-content' ], $result )
                );
            }
 
            if ( $this->getIsWrappedHtml() ) {
                // This is a special output mode mainly intended for ApiSandbox use
                $time = $this->getMain()->getRequest()->getElapsedTime();
                echo FormatJson::encode(
                    [
                        'status' => (int)( $this->mHttpStatus ?: 200 ),
                        'statustext' => HttpStatus::getMessage( $this->mHttpStatus ?: 200 ),
                        'html' => $out->getHTML(),
                        'modules' => array_values( array_unique( array_merge(
                            $out->getModules(),
                            $out->getModuleStyles()
                        ) ) ),
                        'continue' => $this->getResult()->getResultData( 'continue' ),
                        'time' => round( $time * 1000 ),
                    ],
                    false, FormatJson::ALL_OK
                );
            } else {
                // API handles its own clickjacking protection.
                // Note: $wgBreakFrames will still override $wgApiFrameOptions for format mode.
                $out->getMetadata()->setPreventClickjacking( false );
                $out->output();
            }
        } else {
            // For non-HTML output, clear all errors that might have been
            // displayed if display_errors=On
            ob_clean();
 
            echo $this->getBuffer();
        }
    }
 
    public function printText( $text ) {
        $this->mBuffer .= $text;
    }
 
    public function getBuffer() {
        return $this->mBuffer;
    }
 
    public function getAllowedParams() {
        $ret = [];
        if ( $this->getIsHtml() ) {
            $ret['wrappedhtml'] = [
                ParamValidator::PARAM_DEFAULT => false,
                ApiBase::PARAM_HELP_MSG => 'apihelp-format-param-wrappedhtml',
            ];
        }
        return $ret;
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
                => [ 'apihelp-format-example-generic', $this->getFormat() ]
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Data_formats';
    }
 
}
 
class_alias( ApiFormatBase::class, 'ApiFormatBase' );