Refactor redundant attrib dropping into new method

[lhc/web/wiklou.git] / includes / api / ApiFormatXml.php

diff --git a/includes/api/ApiFormatXml.php b/includes/api/ApiFormatXml.php
index 928e4b9..b34ed3a 100644 (file)
--- a/includes/api/ApiFormatXml.php
+++ b/includes/api/ApiFormatXml.php
@@ -35,6 +35,7 @@ class ApiFormatXml extends ApiFormatBase {
 
        private $mRootElemName = 'api';
        private $mDoubleQuote = false;
+       private $mXslt = null;
 
        public function __construct($main, $format) {
                parent :: __construct($main, $format);
@@ -55,13 +56,19 @@ class ApiFormatXml extends ApiFormatBase {
        public function execute() {
                $params = $this->extractRequestParams();
                $this->mDoubleQuote = $params['xmldoublequote'];
-
-               $this->printText('<?xml version="1.0" encoding="utf-8"?>');
-               $this->recXmlPrint($this->mRootElemName, $this->getResultData(), $this->getIsHtml() ? -2 : null);
+               $this->mXslt = $params['xslt'];
+
+               $this->printText('<?xml version="1.0"?>');
+               if (!is_null($this->mXslt))
+                       $this->addXslt();
+               $this->printText($this->recXmlPrint($this->mRootElemName,
+                               $this->getResultData(),
+                               $this->getIsHtml() ? -2 : null,
+                               $this->mDoubleQuote));
        }
 
        /**
-       * This method takes an array and converts it into an xml.
+       * This method takes an array and converts it to XML.
        * There are several noteworthy cases:
        *
        *  If array contains a key '_element', then the code assumes that ALL other keys are not important and replaces them with the value['_element'].
@@ -73,28 +80,28 @@ class ApiFormatXml extends ApiFormatBase {
        * If neither key is found, all keys become element names, and values become element content.
        * The method is recursive, so the same rules apply to any sub-arrays.
        */
-       function recXmlPrint($elemName, $elemValue, $indent) {
+       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['_attribs'])) {
-                                       $attribValues = $elemValue['_attribs'];
-                                       unset( $elemValue['_attribs'] );
-                               } else {
-                                       $attribValues = null;
-                               }
-                               
                                if (isset ($elemValue['*'])) {
                                        $subElemContent = $elemValue['*'];
-                                       if ($this->mDoubleQuote)
-                                               $subElemContent = $this->doubleQuote($subElemContent);
+                                       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;
                                }
@@ -109,9 +116,9 @@ class ApiFormatXml extends ApiFormatBase {
                                $indElements = array ();
                                $subElements = array ();
                                foreach ($elemValue as $subElemId => & $subElemValue) {
-                                       if (is_string($subElemValue) && $this->mDoubleQuote)
-                                               $subElemValue = $this->doubleQuote($subElemValue);
-
+                                       if (is_string($subElemValue) && $doublequote)
+                                               $subElemValue = Sanitizer::encodeAttribute($subElemValue);
+                                       
                                        if (gettype($subElemId) === 'integer') {
                                                $indElements[] = $subElemValue;
                                                unset ($elemValue[$subElemId]);
@@ -120,52 +127,66 @@ class ApiFormatXml extends ApiFormatBase {
                                                unset ($elemValue[$subElemId]);
                                        }
                                }
-                               
-                               $elemValue = wfArrayMerge( $attribValues, $elemValue ); // wtf
 
-                               if (is_null($subElemIndName) && !empty ($indElements))
+                               if (is_null($subElemIndName) && count($indElements))
                                        ApiBase :: dieDebug(__METHOD__, "($elemName, ...) has integer keys without _element value. Use ApiResult::setIndexedTagName().");
 
-                               if (!empty ($subElements) && !empty ($indElements) && !is_null($subElemContent))
+                               if (count($subElements) && count($indElements) && !is_null($subElemContent))
                                        ApiBase :: dieDebug(__METHOD__, "($elemName, ...) has content and subelements");
 
                                if (!is_null($subElemContent)) {
-                                       $this->printText($indstr . wfElement($elemName, $elemValue, $subElemContent));
-                               } elseif (empty ($indElements) && empty ($subElements)) {
-                                       $this->printText($indstr . wfElement($elemName, $elemValue));
+                                       $retval .= $indstr . Xml::element($elemName, $elemValue, $subElemContent);
+                               } elseif (!count($indElements) && !count($subElements)) {
+                                               $retval .= $indstr . Xml::element($elemName, $elemValue);
                                } else {
-                                       $this->printText($indstr . wfElement($elemName, $elemValue, null));
+                                       $retval .= $indstr . Xml::element($elemName, $elemValue, null);
 
                                        foreach ($subElements as $subElemId => & $subElemValue)
-                                               $this->recXmlPrint($subElemId, $subElemValue, $indent);
+                                               $retval .= self::recXmlPrint($subElemId, $subElemValue, $indent);
 
                                        foreach ($indElements as $subElemId => & $subElemValue)
-                                               $this->recXmlPrint($subElemIndName, $subElemValue, $indent);
+                                               $retval .= self::recXmlPrint($subElemIndName, $subElemValue, $indent);
 
-                                       $this->printText($indstr . wfCloseElement($elemName));
+                                       $retval .= $indstr . Xml::closeElement($elemName);
                                }
                                break;
                        case 'object' :
                                // ignore
                                break;
                        default :
-                               $this->printText($indstr . wfElement($elemName, null, $elemValue));
+                               $retval .= $indstr . Xml::element($elemName, null, $elemValue);
                                break;
                }
+               return $retval;
        }
-       private function doubleQuote( $text ) {
-               return Sanitizer::encodeAttribute( $text );
+       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="' . $nt->escapeLocalURL( 'action=raw' ) . '" type="text/xml" ?>' );
        }
-
+       
        public function getAllowedParams() {
                return array (
-                       'xmldoublequote' => false
+                       'xmldoublequote' => false,
+                       'xslt' => null,
                );
        }
 
        public function getParamDescription() {
                return array (
                        'xmldoublequote' => 'If specified, double quotes all attributes and content.',
+                       'xslt' => 'If specified, adds <xslt> as stylesheet',
                );
        }