MediaWiki  REL1_31
ApiFormatXml.php
Go to the documentation of this file.
1 <?php
27 class ApiFormatXml extends ApiFormatBase {
28 
29  private $mRootElemName = 'api';
30  public static $namespace = 'http://www.mediawiki.org/xml/api/';
31  private $mIncludeNamespace = false;
32  private $mXslt = null;
33 
34  public function getMimeType() {
35  return 'text/xml';
36  }
37 
38  public function setRootElement( $rootElemName ) {
39  $this->mRootElemName = $rootElemName;
40  }
41 
42  public function execute() {
43  $params = $this->extractRequestParams();
44  $this->mIncludeNamespace = $params['includexmlnamespace'];
45  $this->mXslt = $params['xslt'];
46 
47  $this->printText( '<?xml version="1.0"?>' );
48  if ( !is_null( $this->mXslt ) ) {
49  $this->addXslt();
50  }
51 
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 );
59  }
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] ) {
65  case 'BCassoc':
66  $metadata[ApiResult::META_TYPE] = 'assoc';
67  break;
68  }
69  }
70  },
71  'BC' => [ 'nobool', 'no*', 'nosub' ],
72  'Types' => [ 'ArmorKVP' => '_name' ],
73  ] );
74 
75  $this->printText(
76  static::recXmlPrint( $this->mRootElemName,
77  $data,
78  $this->getIsHtml() ? -2 : null
79  )
80  );
81  }
82 
92  public static function recXmlPrint( $name, $value, $indent, $attributes = [] ) {
93  $retval = '';
94  if ( $indent !== null ) {
95  if ( $name !== null ) {
96  $indent += 2;
97  }
98  $indstr = "\n" . str_repeat( ' ', $indent );
99  } else {
100  $indstr = '';
101  }
102 
103  if ( is_object( $value ) ) {
104  $value = (array)$value;
105  }
106  if ( is_array( $value ) ) {
107  $contentKey = isset( $value[ApiResult::META_CONTENT] )
109  : '*';
110  $subelementKeys = isset( $value[ApiResult::META_SUBELEMENTS] )
112  : [];
113  if ( isset( $value[ApiResult::META_BC_SUBELEMENTS] ) ) {
114  $subelementKeys = array_merge(
115  $subelementKeys, $value[ApiResult::META_BC_SUBELEMENTS]
116  );
117  }
118  $preserveKeys = isset( $value[ApiResult::META_PRESERVE_KEYS] )
120  : [];
121  $indexedTagName = isset( $value[ApiResult::META_INDEXED_TAG_NAME] )
123  : '_v';
124  $bcBools = isset( $value[ApiResult::META_BC_BOOLS] )
126  : [];
127  $indexSubelements = isset( $value[ApiResult::META_TYPE] )
128  ? $value[ApiResult::META_TYPE] !== 'array'
129  : false;
130 
131  $content = null;
132  $subelements = [];
133  $indexedSubelements = [];
134  foreach ( $value as $k => $v ) {
135  if ( ApiResult::isMetadataKey( $k ) && !in_array( $k, $preserveKeys, true ) ) {
136  continue;
137  }
138 
139  $oldv = $v;
140  if ( is_bool( $v ) && !in_array( $k, $bcBools, true ) ) {
141  $v = $v ? 'true' : 'false';
142  }
143 
144  if ( $name !== null && $k === $contentKey ) {
145  $content = $v;
146  } elseif ( is_int( $k ) ) {
147  $indexedSubelements[$k] = $v;
148  } elseif ( is_array( $v ) || is_object( $v ) ) {
149  $subelements[self::mangleName( $k, $preserveKeys )] = $v;
150  } elseif ( in_array( $k, $subelementKeys, true ) || $name === null ) {
151  $subelements[self::mangleName( $k, $preserveKeys )] = [
152  'content' => $v,
153  ApiResult::META_CONTENT => 'content',
154  ApiResult::META_TYPE => 'assoc',
155  ];
156  } elseif ( is_bool( $oldv ) ) {
157  if ( $oldv ) {
158  $attributes[self::mangleName( $k, $preserveKeys )] = '';
159  }
160  } elseif ( $v !== null ) {
161  $attributes[self::mangleName( $k, $preserveKeys )] = $v;
162  }
163  }
164 
165  if ( $content !== null ) {
166  if ( $subelements || $indexedSubelements ) {
167  $subelements[self::mangleName( $contentKey, $preserveKeys )] = [
168  'content' => $content,
169  ApiResult::META_CONTENT => 'content',
170  ApiResult::META_TYPE => 'assoc',
171  ];
172  $content = null;
173  } elseif ( is_scalar( $content ) ) {
174  // Add xml:space="preserve" to the element so XML parsers
175  // will leave whitespace in the content alone
176  $attributes += [ 'xml:space' => 'preserve' ];
177  }
178  }
179 
180  if ( $content !== null ) {
181  if ( is_scalar( $content ) ) {
182  $retval .= $indstr . Xml::element( $name, $attributes, $content );
183  } else {
184  if ( $name !== null ) {
185  $retval .= $indstr . Xml::element( $name, $attributes, null );
186  }
187  $retval .= static::recXmlPrint( null, $content, $indent );
188  if ( $name !== null ) {
189  $retval .= $indstr . Xml::closeElement( $name );
190  }
191  }
192  } elseif ( !$indexedSubelements && !$subelements ) {
193  if ( $name !== null ) {
194  $retval .= $indstr . Xml::element( $name, $attributes );
195  }
196  } else {
197  if ( $name !== null ) {
198  $retval .= $indstr . Xml::element( $name, $attributes, null );
199  }
200  foreach ( $subelements as $k => $v ) {
201  $retval .= static::recXmlPrint( $k, $v, $indent );
202  }
203  foreach ( $indexedSubelements as $k => $v ) {
204  $retval .= static::recXmlPrint( $indexedTagName, $v, $indent,
205  $indexSubelements ? [ '_idx' => $k ] : []
206  );
207  }
208  if ( $name !== null ) {
209  $retval .= $indstr . Xml::closeElement( $name );
210  }
211  }
212  } else {
213  // to make sure null value doesn't produce unclosed element,
214  // which is what Xml::element( $name, null, null ) returns
215  if ( $value === null ) {
216  $retval .= $indstr . Xml::element( $name, $attributes );
217  } else {
218  $retval .= $indstr . Xml::element( $name, $attributes, $value );
219  }
220  }
221 
222  return $retval;
223  }
224 
231  private static function mangleName( $name, $preserveKeys = [] ) {
232  static $nsc = null, $nc = null;
233 
234  if ( in_array( $name, $preserveKeys, true ) ) {
235  return $name;
236  }
237 
238  if ( $name === '' ) {
239  return '_';
240  }
241 
242  if ( $nsc === null ) {
243  // Note we omit ':' from $nsc and $nc because it's reserved for XML
244  // namespacing, and we omit '_' from $nsc (but not $nc) because we
245  // reserve it.
246  $nsc = 'A-Za-z\x{C0}-\x{D6}\x{D8}-\x{F6}\x{F8}-\x{2FF}\x{370}-\x{37D}\x{37F}-\x{1FFF}' .
247  '\x{200C}-\x{200D}\x{2070}-\x{218F}\x{2C00}-\x{2FEF}\x{3001}-\x{D7FF}' .
248  '\x{F900}-\x{FDCF}\x{FDF0}-\x{FFFD}\x{10000}-\x{EFFFF}';
249  $nc = $nsc . '_\-.0-9\x{B7}\x{300}-\x{36F}\x{203F}-\x{2040}';
250  }
251 
252  if ( preg_match( "/^[$nsc][$nc]*$/uS", $name ) ) {
253  return $name;
254  }
255 
256  return '_' . preg_replace_callback(
257  "/[^$nc]/uS",
258  function ( $m ) {
259  return sprintf( '.%X.', UtfNormal\Utils::utf8ToCodepoint( $m[0] ) );
260  },
261  str_replace( '.', '.2E.', $name )
262  );
263  }
264 
265  protected function addXslt() {
266  $nt = Title::newFromText( $this->mXslt );
267  if ( is_null( $nt ) || !$nt->exists() ) {
268  $this->addWarning( 'apiwarn-invalidxmlstylesheet' );
269 
270  return;
271  }
272  if ( $nt->getNamespace() != NS_MEDIAWIKI ) {
273  $this->addWarning( 'apiwarn-invalidxmlstylesheetns' );
274 
275  return;
276  }
277  if ( substr( $nt->getText(), -4 ) !== '.xsl' ) {
278  $this->addWarning( 'apiwarn-invalidxmlstylesheetext' );
279 
280  return;
281  }
282  $this->printText( '<?xml-stylesheet href="' .
283  htmlspecialchars( $nt->getLocalURL( 'action=raw' ) ) . '" type="text/xsl" ?>' );
284  }
285 
286  public function getAllowedParams() {
287  return parent::getAllowedParams() + [
288  'xslt' => [
289  ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-xslt',
290  ],
291  'includexmlnamespace' => [
292  ApiBase::PARAM_DFLT => false,
293  ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-includexmlnamespace',
294  ],
295  ];
296  }
297 }
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
ApiBase\addWarning
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1819
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiFormatXml\setRootElement
setRootElement( $rootElemName)
Definition: ApiFormatXml.php:38
ApiResult\META_TYPE
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ApiResult\META_BC_SUBELEMENTS
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
Definition: ApiResult.php:141
ApiFormatBase
This is the abstract base class for API formatters.
Definition: ApiFormatBase.php:28
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiResult\META_PRESERVE_KEYS
const META_PRESERVE_KEYS
Key for the 'preserve keys' metadata item.
Definition: ApiResult.php:82
ApiFormatXml
API XML output formatter.
Definition: ApiFormatXml.php:27
$params
$params
Definition: styleTest.css.php:40
ApiResult\NO_SIZE_CHECK
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition: ApiResult.php:56
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
ApiFormatXml\addXslt
addXslt()
Definition: ApiFormatXml.php:265
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
ApiFormatXml\$mXslt
$mXslt
Definition: ApiFormatXml.php:32
ApiFormatXml\getMimeType
getMimeType()
Overriding class returns the MIME type that should be sent to the client.
Definition: ApiFormatXml.php:34
ApiFormatXml\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiFormatXml.php:42
ApiFormatXml\$mRootElemName
$mRootElemName
Definition: ApiFormatXml.php:29
ApiResult\META_INDEXED_TAG_NAME
const META_INDEXED_TAG_NAME
Key for the 'indexed tag name' metadata item.
Definition: ApiResult.php:70
ApiFormatXml\$namespace
static $namespace
Definition: ApiFormatXml.php:30
UtfNormal
Unicode normalization routines for working with UTF-8 strings.
Definition: UtfNormal.php:48
ApiResult\META_SUBELEMENTS
const META_SUBELEMENTS
Key for the 'subelements' metadata item.
Definition: ApiResult.php:76
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
ApiResult\META_BC_BOOLS
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
Definition: ApiResult.php:134
ApiFormatXml\mangleName
static mangleName( $name, $preserveKeys=[])
Mangle XML-invalid names to be valid in XML.
Definition: ApiFormatXml.php:231
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
$value
$value
Definition: styleTest.css.php:45
ApiResult\isMetadataKey
static isMetadataKey( $key)
Test whether a key should be considered metadata.
Definition: ApiResult.php:793
ApiFormatBase\printText
printText( $text)
Append text to the output buffer.
Definition: ApiFormatBase.php:347
ApiFormatXml\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiFormatXml.php:286
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Xml\closeElement
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:118
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
ApiFormatXml\$mIncludeNamespace
$mIncludeNamespace
Definition: ApiFormatXml.php:31
utf8ToCodepoint
utf8ToCodepoint( $char)
Determine the Unicode codepoint of a single-character UTF-8 sequence.
Definition: UtfNormalUtil.php:88
ApiFormatBase\getIsHtml
getIsHtml()
Returns true when the HTML pretty-printer should be used.
Definition: ApiFormatBase.php:97
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:82
ApiFormatXml\recXmlPrint
static recXmlPrint( $name, $value, $indent, $attributes=[])
This method takes an array and converts it to XML.
Definition: ApiFormatXml.php:92
ApiResult\META_CONTENT
const META_CONTENT
Key for the 'content' metadata item.
Definition: ApiResult.php:88
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266