MediaWiki  1.28.0
ApiFormatXml.php
Go to the documentation of this file.
1 <?php
31 class ApiFormatXml extends ApiFormatBase {
32 
33  private $mRootElemName = 'api';
34  public static $namespace = 'http://www.mediawiki.org/xml/api/';
35  private $mIncludeNamespace = false;
36  private $mXslt = null;
37 
38  public function getMimeType() {
39  return 'text/xml';
40  }
41 
42  public function setRootElement( $rootElemName ) {
43  $this->mRootElemName = $rootElemName;
44  }
45 
46  public function execute() {
47  $params = $this->extractRequestParams();
48  $this->mIncludeNamespace = $params['includexmlnamespace'];
49  $this->mXslt = $params['xslt'];
50 
51  $this->printText( '<?xml version="1.0"?>' );
52  if ( !is_null( $this->mXslt ) ) {
53  $this->addXslt();
54  }
55 
56  $result = $this->getResult();
57  if ( $this->mIncludeNamespace && $result->getResultData( 'xmlns' ) === null ) {
58  // If the result data already contains an 'xmlns' namespace added
59  // for custom XML output types, it will override the one for the
60  // generic API results.
61  // This allows API output of other XML types like Atom, RSS, RSD.
62  $result->addValue( null, 'xmlns', self::$namespace, ApiResult::NO_SIZE_CHECK );
63  }
64  $data = $result->getResultData( null, [
65  'Custom' => function ( &$data, &$metadata ) {
66  if ( isset( $metadata[ApiResult::META_TYPE] ) ) {
67  // We want to use non-BC for BCassoc to force outputting of _idx.
68  switch ( $metadata[ApiResult::META_TYPE] ) {
69  case 'BCassoc':
70  $metadata[ApiResult::META_TYPE] = 'assoc';
71  break;
72  }
73  }
74  },
75  'BC' => [ 'nobool', 'no*', 'nosub' ],
76  'Types' => [ 'ArmorKVP' => '_name' ],
77  ] );
78 
79  $this->printText(
80  static::recXmlPrint( $this->mRootElemName,
81  $data,
82  $this->getIsHtml() ? -2 : null
83  )
84  );
85  }
86 
96  public static function recXmlPrint( $name, $value, $indent, $attributes = [] ) {
97  $retval = '';
98  if ( $indent !== null ) {
99  if ( $name !== null ) {
100  $indent += 2;
101  }
102  $indstr = "\n" . str_repeat( ' ', $indent );
103  } else {
104  $indstr = '';
105  }
106 
107  if ( is_object( $value ) ) {
108  $value = (array)$value;
109  }
110  if ( is_array( $value ) ) {
111  $contentKey = isset( $value[ApiResult::META_CONTENT] )
113  : '*';
114  $subelementKeys = isset( $value[ApiResult::META_SUBELEMENTS] )
116  : [];
117  if ( isset( $value[ApiResult::META_BC_SUBELEMENTS] ) ) {
118  $subelementKeys = array_merge(
119  $subelementKeys, $value[ApiResult::META_BC_SUBELEMENTS]
120  );
121  }
122  $preserveKeys = isset( $value[ApiResult::META_PRESERVE_KEYS] )
124  : [];
125  $indexedTagName = isset( $value[ApiResult::META_INDEXED_TAG_NAME] )
126  ? self::mangleName( $value[ApiResult::META_INDEXED_TAG_NAME], $preserveKeys )
127  : '_v';
128  $bcBools = isset( $value[ApiResult::META_BC_BOOLS] )
130  : [];
131  $indexSubelements = isset( $value[ApiResult::META_TYPE] )
132  ? $value[ApiResult::META_TYPE] !== 'array'
133  : false;
134 
135  $content = null;
136  $subelements = [];
137  $indexedSubelements = [];
138  foreach ( $value as $k => $v ) {
139  if ( ApiResult::isMetadataKey( $k ) && !in_array( $k, $preserveKeys, true ) ) {
140  continue;
141  }
142 
143  $oldv = $v;
144  if ( is_bool( $v ) && !in_array( $k, $bcBools, true ) ) {
145  $v = $v ? 'true' : 'false';
146  }
147 
148  if ( $name !== null && $k === $contentKey ) {
149  $content = $v;
150  } elseif ( is_int( $k ) ) {
151  $indexedSubelements[$k] = $v;
152  } elseif ( is_array( $v ) || is_object( $v ) ) {
153  $subelements[self::mangleName( $k, $preserveKeys )] = $v;
154  } elseif ( in_array( $k, $subelementKeys, true ) || $name === null ) {
155  $subelements[self::mangleName( $k, $preserveKeys )] = [
156  'content' => $v,
157  ApiResult::META_CONTENT => 'content',
158  ApiResult::META_TYPE => 'assoc',
159  ];
160  } elseif ( is_bool( $oldv ) ) {
161  if ( $oldv ) {
162  $attributes[self::mangleName( $k, $preserveKeys )] = '';
163  }
164  } elseif ( $v !== null ) {
165  $attributes[self::mangleName( $k, $preserveKeys )] = $v;
166  }
167  }
168 
169  if ( $content !== null ) {
170  if ( $subelements || $indexedSubelements ) {
171  $subelements[self::mangleName( $contentKey, $preserveKeys )] = [
172  'content' => $content,
173  ApiResult::META_CONTENT => 'content',
174  ApiResult::META_TYPE => 'assoc',
175  ];
176  $content = null;
177  } elseif ( is_scalar( $content ) ) {
178  // Add xml:space="preserve" to the element so XML parsers
179  // will leave whitespace in the content alone
180  $attributes += [ 'xml:space' => 'preserve' ];
181  }
182  }
183 
184  if ( $content !== null ) {
185  if ( is_scalar( $content ) ) {
186  $retval .= $indstr . Xml::element( $name, $attributes, $content );
187  } else {
188  if ( $name !== null ) {
189  $retval .= $indstr . Xml::element( $name, $attributes, null );
190  }
191  $retval .= static::recXmlPrint( null, $content, $indent );
192  if ( $name !== null ) {
193  $retval .= $indstr . Xml::closeElement( $name );
194  }
195  }
196  } elseif ( !$indexedSubelements && !$subelements ) {
197  if ( $name !== null ) {
198  $retval .= $indstr . Xml::element( $name, $attributes );
199  }
200  } else {
201  if ( $name !== null ) {
202  $retval .= $indstr . Xml::element( $name, $attributes, null );
203  }
204  foreach ( $subelements as $k => $v ) {
205  $retval .= static::recXmlPrint( $k, $v, $indent );
206  }
207  foreach ( $indexedSubelements as $k => $v ) {
208  $retval .= static::recXmlPrint( $indexedTagName, $v, $indent,
209  $indexSubelements ? [ '_idx' => $k ] : []
210  );
211  }
212  if ( $name !== null ) {
213  $retval .= $indstr . Xml::closeElement( $name );
214  }
215  }
216  } else {
217  // to make sure null value doesn't produce unclosed element,
218  // which is what Xml::element( $name, null, null ) returns
219  if ( $value === null ) {
220  $retval .= $indstr . Xml::element( $name, $attributes );
221  } else {
222  $retval .= $indstr . Xml::element( $name, $attributes, $value );
223  }
224  }
225 
226  return $retval;
227  }
228 
235  private static function mangleName( $name, $preserveKeys = [] ) {
236  static $nsc = null, $nc = null;
237 
238  if ( in_array( $name, $preserveKeys, true ) ) {
239  return $name;
240  }
241 
242  if ( $name === '' ) {
243  return '_';
244  }
245 
246  if ( $nsc === null ) {
247  // Note we omit ':' from $nsc and $nc because it's reserved for XML
248  // namespacing, and we omit '_' from $nsc (but not $nc) because we
249  // reserve it.
250  $nsc = 'A-Za-z\x{C0}-\x{D6}\x{D8}-\x{F6}\x{F8}-\x{2FF}\x{370}-\x{37D}\x{37F}-\x{1FFF}' .
251  '\x{200C}-\x{200D}\x{2070}-\x{218F}\x{2C00}-\x{2FEF}\x{3001}-\x{D7FF}' .
252  '\x{F900}-\x{FDCF}\x{FDF0}-\x{FFFD}\x{10000}-\x{EFFFF}';
253  $nc = $nsc . '_\-.0-9\x{B7}\x{300}-\x{36F}\x{203F}-\x{2040}';
254  }
255 
256  if ( preg_match( "/^[$nsc][$nc]*$/uS", $name ) ) {
257  return $name;
258  }
259 
260  return '_' . preg_replace_callback(
261  "/[^$nc]/uS",
262  function ( $m ) {
263  return sprintf( '.%X.', UtfNormal\Utils::utf8ToCodepoint( $m[0] ) );
264  },
265  str_replace( '.', '.2E.', $name )
266  );
267  }
268 
269  protected function addXslt() {
270  $nt = Title::newFromText( $this->mXslt );
271  if ( is_null( $nt ) || !$nt->exists() ) {
272  $this->setWarning( 'Invalid or non-existent stylesheet specified' );
273 
274  return;
275  }
276  if ( $nt->getNamespace() != NS_MEDIAWIKI ) {
277  $this->setWarning( 'Stylesheet should be in the MediaWiki namespace.' );
278 
279  return;
280  }
281  if ( substr( $nt->getText(), -4 ) !== '.xsl' ) {
282  $this->setWarning( 'Stylesheet should have .xsl extension.' );
283 
284  return;
285  }
286  $this->printText( '<?xml-stylesheet href="' .
287  htmlspecialchars( $nt->getLocalURL( 'action=raw' ) ) . '" type="text/xsl" ?>' );
288  }
289 
290  public function getAllowedParams() {
291  return parent::getAllowedParams() + [
292  'xslt' => [
293  ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-xslt',
294  ],
295  'includexmlnamespace' => [
296  ApiBase::PARAM_DFLT => false,
297  ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-includexmlnamespace',
298  ],
299  ];
300  }
301 }
utf8ToCodepoint($char)
Determine the Unicode codepoint of a single-character UTF-8 sequence.
API XML output formatter.
the array() calling protocol came about after MediaWiki 1.4rc1.
getResult()
Get the result object.
Definition: ApiBase.php:577
static element($element, $attribs=null, $contents= '', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
static $namespace
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
$value
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
This is the abstract base class for API formatters.
const META_PRESERVE_KEYS
Key for the 'preserve keys' metadata item.
Definition: ApiResult.php:82
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
printText($text)
Append text to the output buffer.
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. '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 '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
static closeElement($element)
Shortcut to close an XML element.
Definition: Xml.php:118
Unicode normalization routines for working with UTF-8 strings.
Definition: UtfNormal.php:48
getIsHtml()
Returns true when the HTML pretty-printer should be used.
static recXmlPrint($name, $value, $indent, $attributes=[])
This method takes an array and converts it to XML.
$params
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
setWarning($warning)
Set warning section for this module.
Definition: ApiBase.php:1543
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:9
const NS_MEDIAWIKI
Definition: Defines.php:64
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
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:35
const META_INDEXED_TAG_NAME
Key for the 'indexed tag name' metadata item.
Definition: ApiResult.php:70
const META_SUBELEMENTS
Key for the 'subelements' metadata item.
Definition: ApiResult.php:76
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1046
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
Definition: ApiResult.php:134
const META_CONTENT
Key for the 'content' metadata item.
Definition: ApiResult.php:88
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
Definition: ApiResult.php:141
static mangleName($name, $preserveKeys=[])
Mangle XML-invalid names to be valid in XML.
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 local account incomplete not yet checked for validity & $retval
Definition: hooks.txt:242
setRootElement($rootElemName)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300
static isMetadataKey($key)
Test whether a key should be considered metadata.
Definition: ApiResult.php:795