ApiFormatXml.php

Go to the documentation of this file.

<?php
class ApiFormatXml extends ApiFormatBase {

        private $mRootElemName = 'api';
        public static $namespace = 'http://www.mediawiki.org/xml/api/';
        private $mDoubleQuote = false;
        private $mIncludeNamespace = false;
        private $mXslt = null;

        public function getMimeType() {
                return 'text/xml';
        }

        public function getNeedsRawData() {
                return true;
        }

        public function setRootElement( $rootElemName ) {
                $this->mRootElemName = $rootElemName;
        }

        public function execute() {
                $params = $this->extractRequestParams();
                $this->mDoubleQuote = $params['xmldoublequote'];
                $this->mIncludeNamespace = $params['includexmlnamespace'];
                $this->mXslt = $params['xslt'];

                $this->printText( '<?xml version="1.0"?>' );
                if ( !is_null( $this->mXslt ) ) {
                        $this->addXslt();
                }
                if ( $this->mIncludeNamespace ) {
                        // If the result data already contains an 'xmlns' namespace added
                        // for custom XML output types, it will override the one for the
                        // generic API results.
                        // This allows API output of other XML types like Atom, RSS, RSD.
                        $data = $this->getResultData() + array( 'xmlns' => self::$namespace );
                } else {
                        $data = $this->getResultData();
                }

                $this->printText(
                        self::recXmlPrint( $this->mRootElemName,
                                $data,
                                $this->getIsHtml() ? - 2 : null,
                                $this->mDoubleQuote
                        )
                );
        }

        public static function recXmlPrint( $elemName, $elemValue, $indent, $doublequote = false ) {
                $retval = '';
                if ( !is_null( $indent ) ) {
                        $indent += 2;
                        $indstr = "\n" . str_repeat( ' ', $indent );
                } else {
                        $indstr = '';
                }
                $elemName = str_replace( ' ', '_', $elemName );

                switch ( gettype( $elemValue ) ) {
                        case 'array':
                                if ( isset( $elemValue['*'] ) ) {
                                        $subElemContent = $elemValue['*'];
                                        if ( $doublequote ) {
                                                $subElemContent = Sanitizer::encodeAttribute( $subElemContent );
                                        }
                                        unset( $elemValue['*'] );

                                        // Add xml:space="preserve" to the
                                        // element so XML parsers will leave
                                        // whitespace in the content alone
                                        $elemValue['xml:space'] = 'preserve';
                                } else {
                                        $subElemContent = null;
                                }

                                if ( isset( $elemValue['_element'] ) ) {
                                        $subElemIndName = $elemValue['_element'];
                                        unset( $elemValue['_element'] );
                                } else {
                                        $subElemIndName = null;
                                }

                                $indElements = array();
                                $subElements = array();
                                foreach ( $elemValue as $subElemId => & $subElemValue ) {
                                        if ( is_string( $subElemValue ) && $doublequote ) {
                                                $subElemValue = Sanitizer::encodeAttribute( $subElemValue );
                                        }

                                        if ( gettype( $subElemId ) === 'integer' ) {
                                                $indElements[] = $subElemValue;
                                                unset( $elemValue[$subElemId] );
                                        } elseif ( is_array( $subElemValue ) ) {
                                                $subElements[$subElemId] = $subElemValue;
                                                unset ( $elemValue[$subElemId] );
                                        }
                                }

                                if ( is_null( $subElemIndName ) && count( $indElements ) ) {
                                        ApiBase::dieDebug( __METHOD__, "($elemName, ...) has integer keys without _element value. Use ApiResult::setIndexedTagName()." );
                                }

                                if ( count( $subElements ) && count( $indElements ) && !is_null( $subElemContent ) ) {
                                        ApiBase::dieDebug( __METHOD__, "($elemName, ...) has content and subelements" );
                                }

                                if ( !is_null( $subElemContent ) ) {
                                        $retval .= $indstr . Xml::element( $elemName, $elemValue, $subElemContent );
                                } elseif ( !count( $indElements ) && !count( $subElements ) ) {
                                        $retval .= $indstr . Xml::element( $elemName, $elemValue );
                                } else {
                                        $retval .= $indstr . Xml::element( $elemName, $elemValue, null );

                                        foreach ( $subElements as $subElemId => & $subElemValue ) {
                                                $retval .= self::recXmlPrint( $subElemId, $subElemValue, $indent );
                                        }

                                        foreach ( $indElements as &$subElemValue ) {
                                                $retval .= self::recXmlPrint( $subElemIndName, $subElemValue, $indent );
                                        }

                                        $retval .= $indstr . Xml::closeElement( $elemName );
                                }
                                break;
                        case 'object':
                                // ignore
                                break;
                        default:
                                // to make sure null value doesn't produce unclosed element,
                                // which is what Xml::element( $elemName, null, null ) returns
                                if ( $elemValue === null ) {
                                        $retval .= $indstr . Xml::element( $elemName );
                                } else {
                                        $retval .= $indstr . Xml::element( $elemName, null, $elemValue );
                                }
                                break;
                }
                return $retval;
        }

        function addXslt() {
                $nt = Title::newFromText( $this->mXslt );
                if ( is_null( $nt ) || !$nt->exists() ) {
                        $this->setWarning( 'Invalid or non-existent stylesheet specified' );
                        return;
                }
                if ( $nt->getNamespace() != NS_MEDIAWIKI ) {
                        $this->setWarning( 'Stylesheet should be in the MediaWiki namespace.' );
                        return;
                }
                if ( substr( $nt->getText(), - 4 ) !== '.xsl' ) {
                        $this->setWarning( 'Stylesheet should have .xsl extension.' );
                        return;
                }
                $this->printText( '<?xml-stylesheet href="' . htmlspecialchars( $nt->getLocalURL( 'action=raw' ) ) . '" type="text/xsl" ?>' );
        }

        public function getAllowedParams() {
                return array(
                        'xmldoublequote' => false,
                        'xslt' => null,
                        'includexmlnamespace' => false,
                );
        }

        public function getParamDescription() {
                return array(
                        'xmldoublequote' => 'If specified, double quotes all attributes and content',
                        'xslt' => 'If specified, adds <xslt> as stylesheet. This should be a wiki page '
                                . 'in the MediaWiki namespace whose page name ends with ".xsl"',
                        'includexmlnamespace' => 'If specified, adds an XML namespace'
                );
        }

        public function getDescription() {
                return 'Output data in XML format' . parent::getDescription();
        }
}