3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * API XML output formatter
27 class ApiFormatXml
extends ApiFormatBase
{
29 private $mRootElemName = 'api';
30 public static $namespace = 'http://www.mediawiki.org/xml/api/';
31 private $mIncludeNamespace = false;
32 private $mXslt = null;
34 public function getMimeType() {
38 public function setRootElement( $rootElemName ) {
39 $this->mRootElemName
= $rootElemName;
42 public function execute() {
43 $params = $this->extractRequestParams();
44 $this->mIncludeNamespace
= $params['includexmlnamespace'];
45 $this->mXslt
= $params['xslt'];
47 $this->printText( '<?xml version="1.0"?>' );
48 if ( !is_null( $this->mXslt
) ) {
52 $result = $this->getResult();
53 if ( $this->mIncludeNamespace
&& $result->getResultData( 'xmlns' ) === null ) {
54 // If the result data already contains an 'xmlns' namespace added
55 // for custom XML output types, it will override the one for the
56 // generic API results.
57 // This allows API output of other XML types like Atom, RSS, RSD.
58 $result->addValue( null, 'xmlns', self
::$namespace, ApiResult
::NO_SIZE_CHECK
);
60 $data = $result->getResultData( null, [
61 'Custom' => function ( &$data, &$metadata ) {
62 if ( isset( $metadata[ApiResult
::META_TYPE
] ) ) {
63 // We want to use non-BC for BCassoc to force outputting of _idx.
64 switch ( $metadata[ApiResult
::META_TYPE
] ) {
66 $metadata[ApiResult
::META_TYPE
] = 'assoc';
71 'BC' => [ 'nobool', 'no*', 'nosub' ],
72 'Types' => [ 'ArmorKVP' => '_name' ],
76 static::recXmlPrint( $this->mRootElemName
,
78 $this->getIsHtml() ?
-2 : null
84 * This method takes an array and converts it to XML.
86 * @param string|null $name Tag name
87 * @param mixed $value Tag value (attributes/content/subelements)
88 * @param int|null $indent Indentation
89 * @param array $attributes Additional attributes
92 public static function recXmlPrint( $name, $value, $indent, $attributes = [] ) {
94 if ( $indent !== null ) {
95 if ( $name !== null ) {
98 $indstr = "\n" . str_repeat( ' ', $indent );
103 if ( is_object( $value ) ) {
104 $value = (array)$value;
106 if ( is_array( $value ) ) {
107 $contentKey = $value[ApiResult
::META_CONTENT
] ??
'*';
108 $subelementKeys = $value[ApiResult
::META_SUBELEMENTS
] ??
[];
109 if ( isset( $value[ApiResult
::META_BC_SUBELEMENTS
] ) ) {
110 $subelementKeys = array_merge(
111 $subelementKeys, $value[ApiResult
::META_BC_SUBELEMENTS
]
114 $preserveKeys = $value[ApiResult
::META_PRESERVE_KEYS
] ??
[];
115 $indexedTagName = isset( $value[ApiResult
::META_INDEXED_TAG_NAME
] )
116 ? self
::mangleName( $value[ApiResult
::META_INDEXED_TAG_NAME
], $preserveKeys )
118 $bcBools = $value[ApiResult
::META_BC_BOOLS
] ??
[];
119 $indexSubelements = isset( $value[ApiResult
::META_TYPE
] )
120 ?
$value[ApiResult
::META_TYPE
] !== 'array'
125 $indexedSubelements = [];
126 foreach ( $value as $k => $v ) {
127 if ( ApiResult
::isMetadataKey( $k ) && !in_array( $k, $preserveKeys, true ) ) {
132 if ( is_bool( $v ) && !in_array( $k, $bcBools, true ) ) {
133 $v = $v ?
'true' : 'false';
136 if ( $name !== null && $k === $contentKey ) {
138 } elseif ( is_int( $k ) ) {
139 $indexedSubelements[$k] = $v;
140 } elseif ( is_array( $v ) ||
is_object( $v ) ) {
141 $subelements[self
::mangleName( $k, $preserveKeys )] = $v;
142 } elseif ( in_array( $k, $subelementKeys, true ) ||
$name === null ) {
143 $subelements[self
::mangleName( $k, $preserveKeys )] = [
145 ApiResult
::META_CONTENT
=> 'content',
146 ApiResult
::META_TYPE
=> 'assoc',
148 } elseif ( is_bool( $oldv ) ) {
150 $attributes[self
::mangleName( $k, $preserveKeys )] = '';
152 } elseif ( $v !== null ) {
153 $attributes[self
::mangleName( $k, $preserveKeys )] = $v;
157 if ( $content !== null ) {
158 if ( $subelements ||
$indexedSubelements ) {
159 $subelements[self
::mangleName( $contentKey, $preserveKeys )] = [
160 'content' => $content,
161 ApiResult
::META_CONTENT
=> 'content',
162 ApiResult
::META_TYPE
=> 'assoc',
165 } elseif ( is_scalar( $content ) ) {
166 // Add xml:space="preserve" to the element so XML parsers
167 // will leave whitespace in the content alone
168 $attributes +
= [ 'xml:space' => 'preserve' ];
172 if ( $content !== null ) {
173 if ( is_scalar( $content ) ) {
174 $retval .= $indstr . Xml
::element( $name, $attributes, $content );
176 if ( $name !== null ) {
177 $retval .= $indstr . Xml
::element( $name, $attributes, null );
179 $retval .= static::recXmlPrint( null, $content, $indent );
180 if ( $name !== null ) {
181 $retval .= $indstr . Xml
::closeElement( $name );
184 } elseif ( !$indexedSubelements && !$subelements ) {
185 if ( $name !== null ) {
186 $retval .= $indstr . Xml
::element( $name, $attributes );
189 if ( $name !== null ) {
190 $retval .= $indstr . Xml
::element( $name, $attributes, null );
192 foreach ( $subelements as $k => $v ) {
193 $retval .= static::recXmlPrint( $k, $v, $indent );
195 foreach ( $indexedSubelements as $k => $v ) {
196 $retval .= static::recXmlPrint( $indexedTagName, $v, $indent,
197 $indexSubelements ?
[ '_idx' => $k ] : []
200 if ( $name !== null ) {
201 $retval .= $indstr . Xml
::closeElement( $name );
205 // to make sure null value doesn't produce unclosed element,
206 // which is what Xml::element( $name, null, null ) returns
207 if ( $value === null ) {
208 $retval .= $indstr . Xml
::element( $name, $attributes );
210 $retval .= $indstr . Xml
::element( $name, $attributes, $value );
218 * Mangle XML-invalid names to be valid in XML
219 * @param string $name
220 * @param array $preserveKeys Names to not mangle
221 * @return string Mangled name
223 private static function mangleName( $name, $preserveKeys = [] ) {
224 static $nsc = null, $nc = null;
226 if ( in_array( $name, $preserveKeys, true ) ) {
230 if ( $name === '' ) {
234 if ( $nsc === null ) {
235 // Note we omit ':' from $nsc and $nc because it's reserved for XML
236 // namespacing, and we omit '_' from $nsc (but not $nc) because we
238 $nsc = 'A-Za-z\x{C0}-\x{D6}\x{D8}-\x{F6}\x{F8}-\x{2FF}\x{370}-\x{37D}\x{37F}-\x{1FFF}' .
239 '\x{200C}-\x{200D}\x{2070}-\x{218F}\x{2C00}-\x{2FEF}\x{3001}-\x{D7FF}' .
240 '\x{F900}-\x{FDCF}\x{FDF0}-\x{FFFD}\x{10000}-\x{EFFFF}';
241 $nc = $nsc . '_\-.0-9\x{B7}\x{300}-\x{36F}\x{203F}-\x{2040}';
244 if ( preg_match( "/^[$nsc][$nc]*$/uS", $name ) ) {
248 return '_' . preg_replace_callback(
251 return sprintf( '.%X.', UtfNormal\Utils
::utf8ToCodepoint( $m[0] ) );
253 str_replace( '.', '.2E.', $name )
257 protected function addXslt() {
258 $nt = Title
::newFromText( $this->mXslt
);
259 if ( is_null( $nt ) ||
!$nt->exists() ) {
260 $this->addWarning( 'apiwarn-invalidxmlstylesheet' );
264 if ( $nt->getNamespace() != NS_MEDIAWIKI
) {
265 $this->addWarning( 'apiwarn-invalidxmlstylesheetns' );
269 if ( substr( $nt->getText(), -4 ) !== '.xsl' ) {
270 $this->addWarning( 'apiwarn-invalidxmlstylesheetext' );
274 $this->printText( '<?xml-stylesheet href="' .
275 htmlspecialchars( $nt->getLocalURL( 'action=raw' ) ) . '" type="text/xsl" ?>' );
278 public function getAllowedParams() {
279 return parent
::getAllowedParams() +
[
281 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-xml-param-xslt',
283 'includexmlnamespace' => [
284 ApiBase
::PARAM_DFLT
=> false,
285 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-xml-param-includexmlnamespace',