1.23.0/php/ApiFormatBase_8php_source.html

<?php

abstract class ApiFormatBase extends ApiBase {

    private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp, $mCleared;

    private $mBufferResult = false, $mBuffer, $mDisabled = false;


    public function __construct( $main, $format ) {

        parent::__construct( $main, $format );


        $this->mIsHtml = ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'

        if ( $this->mIsHtml ) {

            $this->mFormat = substr( $format, 0, -2 ); // remove ending 'fm'

        } else {

            $this->mFormat = $format;

        }

        $this->mFormat = strtoupper( $this->mFormat );

        $this->mCleared = false;

    }


    abstract public function getMimeType();


    public function getNeedsRawData() {

        return false;

    }


    public function getFormat() {

        return $this->mFormat;

    }


    public function setUnescapeAmps( $b ) {

        $this->mUnescapeAmps = $b;

    }


    public function getIsHtml() {

        return $this->mIsHtml;

    }


    public function getWantsHelp() {

        return $this->getIsHtml();

    }


    public function disable() {

        $this->mDisabled = true;

    }


    public function isDisabled() {

        return $this->mDisabled;

    }


    public function canPrintErrors() {

        return true;

    }


    function initPrinter( $isHelpScreen ) {

        if ( $this->mDisabled ) {

            return;

        }

        $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

        if ( is_null( $mime ) ) {

            return; // skip any initialization

        }


        $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );


        //Set X-Frame-Options API results (bug 39180)

        global $wgApiFrameOptions;

        if ( $wgApiFrameOptions ) {

            $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $wgApiFrameOptions" );

        }


        if ( $isHtml ) {

?>

<!DOCTYPE HTML>

<html>

<head>

<?php

            if ( $this->mUnescapeAmps ) {

?>  <title>MediaWiki API</title>

<?php

            } else {

?>  <title>MediaWiki API Result</title>

<?php

            }

?>

</head>

<body>

<?php

            if ( !$isHelpScreen ) {

// @codingStandardsIgnoreStart Exclude long line from CodeSniffer checks

?>

<br />

<small>

You are looking at the HTML representation of the <?php echo $this->mFormat; ?> format.<br />

HTML is good for debugging, but is unsuitable for application use.<br />

Specify the format parameter to change the output format.<br />

To see the non HTML representation of the <?php echo $this->mFormat; ?> format, set format=<?php echo strtolower( $this->mFormat ); ?>.<br />

See the <a href='https://www.mediawiki.org/wiki/API'>complete documentation</a>, or

<a href='<?php echo $script; ?>'>API help</a> for more information.

</small>

<pre style='white-space: pre-wrap;'>

<?php

// @codingStandardsIgnoreEnd

            // don't wrap the contents of the <pre> for help screens

            // because these are actually formatted to rely on

            // the monospaced font for layout purposes

            } else {

?>

<pre>

<?php

            }

        }

    }


    public function closePrinter() {

        if ( $this->mDisabled ) {

            return;

        }

        if ( $this->getIsHtml() ) {

?>


</pre>

</body>

</html>

<?php

        }

    }


    public function printText( $text ) {

        if ( $this->mDisabled ) {

            return;

        }

        if ( $this->mBufferResult ) {

            $this->mBuffer = $text;

        } elseif ( $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;

        }

    }


    public function getBuffer() {

        return $this->mBuffer;

    }


    public function setBufferResult( $value ) {

        $this->mBufferResult = $value;

    }


    public function setHelp( $help = true ) {

        $this->mHelp = $help;

    }


    protected function formatHTML( $text ) {

        // Escape everything first for full coverage

        $text = htmlspecialchars( $text );

        // encode all comments or tags as safe blue strings

        $text = str_replace( '&lt;', '<span style="color:blue;">&lt;', $text );

        $text = str_replace( '&gt;', '&gt;</span>', $text );


        // identify requests to api.php

        $text = preg_replace( '#^(\s*)(api\.php\?[^ <\n\t]+)$#m', '\1<a href="\2">\2</a>', $text );

        if ( $this->mHelp ) {

            // make lines inside * bold

            $text = preg_replace( '#^(\s*)(\*[^<>\n]+\*)(\s*)$#m', '$1<b>$2</b>$3', $text );

        }


        // Armor links (bug 61362)

        $masked = array();

        $text = preg_replace_callback( '#<a .*?</a>#', function ( $matches ) use ( &$masked ) {

            $sha = sha1( $matches[0] );

            $masked[$sha] = $matches[0];

            return "<$sha>";

        }, $text );


        // identify URLs

        $protos = wfUrlProtocolsWithoutProtRel();

        // This regex hacks around bug 13218 (&quot; included in the URL)

        $text = preg_replace(

            "#(((?i)$protos).*?)(&quot;)?([ \\'\"<>\n]|&lt;|&gt;|&quot;)#",

            '<a href="\\1">\\1</a>\\3\\4',

            $text

        );


        // Unarmor links

        $text = preg_replace_callback( '#<([0-9a-f]{40})>#', function ( $matches ) use ( &$masked ) {

            $sha = $matches[1];

            return isset( $masked[$sha] ) ? $masked[$sha] : $matches[0];

        }, $text );


        if ( $this->mUnescapeAmps ) {

            $text = preg_replace( '/&amp;(amp|quot|lt|gt);/', '&\1;', $text );

        }


        return $text;

    }


    public function getExamples() {

        return array(

            'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()

                => "Format the query result in the {$this->getModuleName()} format",

        );

    }


    public function getHelpUrls() {

        return 'https://www.mediawiki.org/wiki/API:Data_formats';

    }


    public function getDescription() {

        return $this->getIsHtml() ? ' (pretty-print in HTML)' : '';

    }

}


class ApiFormatFeedWrapper extends ApiFormatBase {


    public function __construct( $main ) {

        parent::__construct( $main, 'feed' );

    }


    public static function setResult( $result, $feed, $feedItems ) {

        // Store output in the Result data.

        // This way we can check during execution if any error has occurred

        // Disable size checking for this because we can't continue

        // cleanly; size checking would cause more problems than it'd

        // solve

        $result->disableSizeCheck();

        $result->addValue( null, '_feed', $feed );

        $result->addValue( null, '_feeditems', $feedItems );

        $result->enableSizeCheck();

    }


    public function getMimeType() {

        return null;

    }


    public function getNeedsRawData() {

        return true;

    }


    public function canPrintErrors() {

        return false;

    }


    public function execute() {

        $data = $this->getResultData();

        if ( isset( $data['_feed'] ) && isset( $data['_feeditems'] ) ) {

            $feed = $data['_feed'];

            $items = $data['_feeditems'];


            $feed->outHeader();

            foreach ( $items as & $item ) {

                $feed->outItem( $item );

            }

            $feed->outFooter();

        } else {

            // Error has occurred, print something useful

            ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );

        }

    }

}