diff options
Diffstat (limited to 'includes/api/ApiFormatXml.php')
| -rw-r--r-- | includes/api/ApiFormatXml.php | 302 |
1 files changed, 177 insertions, 125 deletions
diff --git a/includes/api/ApiFormatXml.php b/includes/api/ApiFormatXml.php index b3d59379..fa0bac34 100644 --- a/includes/api/ApiFormatXml.php +++ b/includes/api/ApiFormatXml.php @@ -39,6 +39,9 @@ class ApiFormatXml extends ApiFormatBase { return 'text/xml'; } + /** + * @deprecated since 1.25 + */ public function getNeedsRawData() { return true; } @@ -56,18 +59,32 @@ class ApiFormatXml extends ApiFormatBase { if ( !is_null( $this->mXslt ) ) { $this->addXslt(); } - if ( $this->mIncludeNamespace ) { + + $result = $this->getResult(); + if ( $this->mIncludeNamespace && $result->getResultData( 'xmlns' ) === null ) { // 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(); + $result->addValue( null, 'xmlns', self::$namespace, ApiResult::NO_SIZE_CHECK ); } + $data = $result->getResultData( null, array( + 'Custom' => function ( &$data, &$metadata ) { + if ( isset( $metadata[ApiResult::META_TYPE] ) ) { + // We want to use non-BC for BCassoc to force outputting of _idx. + switch( $metadata[ApiResult::META_TYPE] ) { + case 'BCassoc': + $metadata[ApiResult::META_TYPE] = 'assoc'; + break; + } + } + }, + 'BC' => array( 'nobool', 'no*', 'nosub' ), + 'Types' => array( 'ArmorKVP' => '_name' ), + ) ); $this->printText( - self::recXmlPrint( $this->mRootElemName, + static::recXmlPrint( $this->mRootElemName, $data, $this->getIsHtml() ? -2 : null ) @@ -77,143 +94,185 @@ class ApiFormatXml extends ApiFormatBase { /** * 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']. - * - * @par Example: - * @verbatim - * name='root', value = array( '_element'=>'page', 'x', 'y', 'z') - * @endverbatim - * creates: - * @verbatim - * <root> <page>x</page> <page>y</page> <page>z</page> </root> - * @endverbatim - * - * If any of the array's element key is '*', then the code treats all - * other key->value pairs as attributes, and the value['*'] as the - * element's content. - * - * @par Example: - * @verbatim - * name='root', value = array( '*'=>'text', 'lang'=>'en', 'id'=>10) - * @endverbatim - * creates: - * @verbatim - * <root lang='en' id='10'>text</root> - * @endverbatim - * - * Finally neither key is found, all keys become element names, and values - * become element content. - * - * @note The method is recursive, so the same rules apply to any - * sub-arrays. - * - * @param string $elemName - * @param mixed $elemValue - * @param int $indent - * + * @param string|null $name Tag name + * @param mixed $value Tag value (attributes/content/subelements) + * @param int|null $indent Indentation + * @param array $attributes Additional attributes * @return string */ - public static function recXmlPrint( $elemName, $elemValue, $indent ) { + public static function recXmlPrint( $name, $value, $indent, $attributes = array() ) { $retval = ''; - if ( !is_null( $indent ) ) { - $indent += 2; + if ( $indent !== null ) { + if ( $name !== null ) { + $indent += 2; + } $indstr = "\n" . str_repeat( ' ', $indent ); } else { $indstr = ''; } - $elemName = str_replace( ' ', '_', $elemName ); - - if ( is_array( $elemValue ) ) { - if ( isset( $elemValue['*'] ) ) { - $subElemContent = $elemValue['*']; - 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 ( is_object( $value ) ) { + $value = (array)$value; + } + if ( is_array( $value ) ) { + $contentKey = isset( $value[ApiResult::META_CONTENT] ) + ? $value[ApiResult::META_CONTENT] + : '*'; + $subelementKeys = isset( $value[ApiResult::META_SUBELEMENTS] ) + ? $value[ApiResult::META_SUBELEMENTS] + : array(); + if ( isset( $value[ApiResult::META_BC_SUBELEMENTS] ) ) { + $subelementKeys = array_merge( + $subelementKeys, $value[ApiResult::META_BC_SUBELEMENTS] + ); } + $preserveKeys = isset( $value[ApiResult::META_PRESERVE_KEYS] ) + ? $value[ApiResult::META_PRESERVE_KEYS] + : array(); + $indexedTagName = isset( $value[ApiResult::META_INDEXED_TAG_NAME] ) + ? self::mangleName( $value[ApiResult::META_INDEXED_TAG_NAME], $preserveKeys ) + : '_v'; + $bcBools = isset( $value[ApiResult::META_BC_BOOLS] ) + ? $value[ApiResult::META_BC_BOOLS] + : array(); + $indexSubelements = isset( $value[ApiResult::META_TYPE] ) + ? $value[ApiResult::META_TYPE] !== 'array' + : false; - if ( isset( $elemValue['_element'] ) ) { - $subElemIndName = $elemValue['_element']; - unset( $elemValue['_element'] ); - } else { - $subElemIndName = null; - } + $content = null; + $subelements = array(); + $indexedSubelements = array(); + foreach ( $value as $k => $v ) { + if ( ApiResult::isMetadataKey( $k ) && !in_array( $k, $preserveKeys, true ) ) { + continue; + } - if ( isset( $elemValue['_subelements'] ) ) { - foreach ( $elemValue['_subelements'] as $subElemId ) { - if ( isset( $elemValue[$subElemId] ) && !is_array( $elemValue[$subElemId] ) ) { - $elemValue[$subElemId] = array( '*' => $elemValue[$subElemId] ); - } + $oldv = $v; + if ( is_bool( $v ) && !in_array( $k, $bcBools, true ) ) { + $v = $v ? 'true' : 'false'; } - unset( $elemValue['_subelements'] ); - } - $indElements = array(); - $subElements = array(); - foreach ( $elemValue as $subElemId => & $subElemValue ) { - if ( is_int( $subElemId ) ) { - $indElements[] = $subElemValue; - unset( $elemValue[$subElemId] ); - } elseif ( is_array( $subElemValue ) ) { - $subElements[$subElemId] = $subElemValue; - unset( $elemValue[$subElemId] ); - } elseif ( is_bool( $subElemValue ) ) { - // treat true as empty string, skip false in xml format - if ( $subElemValue === true ) { - $subElemValue = ''; - } else { - unset( $elemValue[$subElemId] ); + if ( $name !== null && $k === $contentKey ) { + $content = $v; + } elseif ( is_int( $k ) ) { + $indexedSubelements[$k] = $v; + } elseif ( is_array( $v ) || is_object( $v ) ) { + $subelements[self::mangleName( $k, $preserveKeys )] = $v; + } elseif ( in_array( $k, $subelementKeys, true ) || $name === null ) { + $subelements[self::mangleName( $k, $preserveKeys )] = array( + 'content' => $v, + ApiResult::META_CONTENT => 'content', + ApiResult::META_TYPE => 'assoc', + ); + } elseif ( is_bool( $oldv ) ) { + if ( $oldv ) { + $attributes[self::mangleName( $k, $preserveKeys )] = ''; } + } elseif ( $v !== null ) { + $attributes[self::mangleName( $k, $preserveKeys )] = $v; } } - 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 ( $content !== null ) { + if ( $subelements || $indexedSubelements ) { + $subelements[self::mangleName( $contentKey, $preserveKeys )] = array( + 'content' => $content, + ApiResult::META_CONTENT => 'content', + ApiResult::META_TYPE => 'assoc', + ); + $content = null; + } elseif ( is_scalar( $content ) ) { + // Add xml:space="preserve" to the element so XML parsers + // will leave whitespace in the content alone + $attributes += array( 'xml:space' => 'preserve' ); + } } - if ( !is_null( $subElemContent ) ) { - $retval .= $indstr . Xml::element( $elemName, $elemValue, $subElemContent ); - } elseif ( !count( $indElements ) && !count( $subElements ) ) { - $retval .= $indstr . Xml::element( $elemName, $elemValue ); + if ( $content !== null ) { + if ( is_scalar( $content ) ) { + $retval .= $indstr . Xml::element( $name, $attributes, $content ); + } else { + if ( $name !== null ) { + $retval .= $indstr . Xml::element( $name, $attributes, null ); + } + $retval .= static::recXmlPrint( null, $content, $indent ); + if ( $name !== null ) { + $retval .= $indstr . Xml::closeElement( $name ); + } + } + } elseif ( !$indexedSubelements && !$subelements ) { + if ( $name !== null ) { + $retval .= $indstr . Xml::element( $name, $attributes ); + } } else { - $retval .= $indstr . Xml::element( $elemName, $elemValue, null ); - - foreach ( $subElements as $subElemId => & $subElemValue ) { - $retval .= self::recXmlPrint( $subElemId, $subElemValue, $indent ); + if ( $name !== null ) { + $retval .= $indstr . Xml::element( $name, $attributes, null ); } - - foreach ( $indElements as &$subElemValue ) { - $retval .= self::recXmlPrint( $subElemIndName, $subElemValue, $indent ); + foreach ( $subelements as $k => $v ) { + $retval .= static::recXmlPrint( $k, $v, $indent ); + } + foreach ( $indexedSubelements as $k => $v ) { + $retval .= static::recXmlPrint( $indexedTagName, $v, $indent, + $indexSubelements ? array( '_idx' => $k ) : array() + ); + } + if ( $name !== null ) { + $retval .= $indstr . Xml::closeElement( $name ); } - - $retval .= $indstr . Xml::closeElement( $elemName ); } - } elseif ( !is_object( $elemValue ) ) { + } else { // 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 ); + // which is what Xml::element( $name, null, null ) returns + if ( $value === null ) { + $retval .= $indstr . Xml::element( $name, $attributes ); } else { - $retval .= $indstr . Xml::element( $elemName, null, $elemValue ); + $retval .= $indstr . Xml::element( $name, $attributes, $value ); } } return $retval; } + /** + * Mangle XML-invalid names to be valid in XML + * @param string $name + * @param array $preserveKeys Names to not mangle + * @return string Mangled name + */ + private static function mangleName( $name, $preserveKeys = array() ) { + static $nsc = null, $nc = null; + + if ( in_array( $name, $preserveKeys, true ) ) { + return $name; + } + + if ( $name === '' ) { + return '_'; + } + + if ( $nsc === null ) { + // Note we omit ':' from $nsc and $nc because it's reserved for XML + // namespacing, and we omit '_' from $nsc (but not $nc) because we + // reserve it. + $nsc = 'A-Za-z\x{C0}-\x{D6}\x{D8}-\x{F6}\x{F8}-\x{2FF}\x{370}-\x{37D}\x{37F}-\x{1FFF}' . + '\x{200C}-\x{200D}\x{2070}-\x{218F}\x{2C00}-\x{2FEF}\x{3001}-\x{D7FF}' . + '\x{F900}-\x{FDCF}\x{FDF0}-\x{FFFD}\x{10000}-\x{EFFFF}'; + $nc = $nsc . '_\-.0-9\x{B7}\x{300}-\x{36F}\x{203F}-\x{2040}'; + } + + if ( preg_match( "/^[$nsc][$nc]*$/uS", $name ) ) { + return $name; + } + + return '_' . preg_replace_callback( + "/[^$nc]/uS", + function ( $m ) { + return sprintf( '.%X.', utf8ToCodepoint( $m[0] ) ); + }, + str_replace( '.', '.2E.', $name ) + ); + } + function addXslt() { $nt = Title::newFromText( $this->mXslt ); if ( is_null( $nt ) || !$nt->exists() ) { @@ -237,20 +296,13 @@ class ApiFormatXml extends ApiFormatBase { public function getAllowedParams() { return array( - 'xslt' => null, - 'includexmlnamespace' => false, + 'xslt' => array( + ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-xslt', + ), + 'includexmlnamespace' => array( + ApiBase::PARAM_DFLT => false, + ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-includexmlnamespace', + ), ); } - - public function getParamDescription() { - return array( - '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(); - } } |