MediaWiki  master
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 = $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]
112  );
113  }
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 )
117  : '_v';
118  $bcBools = $value[ApiResult::META_BC_BOOLS] ?? [];
119  $indexSubelements = isset( $value[ApiResult::META_TYPE] )
120  ? $value[ApiResult::META_TYPE] !== 'array'
121  : false;
122 
123  $content = null;
124  $subelements = [];
125  $indexedSubelements = [];
126  foreach ( $value as $k => $v ) {
127  if ( ApiResult::isMetadataKey( $k ) && !in_array( $k, $preserveKeys, true ) ) {
128  continue;
129  }
130 
131  $oldv = $v;
132  if ( is_bool( $v ) && !in_array( $k, $bcBools, true ) ) {
133  $v = $v ? 'true' : 'false';
134  }
135 
136  if ( $name !== null && $k === $contentKey ) {
137  $content = $v;
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 )] = [
144  'content' => $v,
145  ApiResult::META_CONTENT => 'content',
146  ApiResult::META_TYPE => 'assoc',
147  ];
148  } elseif ( is_bool( $oldv ) ) {
149  if ( $oldv ) {
150  $attributes[self::mangleName( $k, $preserveKeys )] = '';
151  }
152  } elseif ( $v !== null ) {
153  $attributes[self::mangleName( $k, $preserveKeys )] = $v;
154  }
155  }
156 
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',
163  ];
164  $content = null;
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' ];
169  }
170  }
171 
172  if ( $content !== null ) {
173  if ( is_scalar( $content ) ) {
174  $retval .= $indstr . Xml::element( $name, $attributes, $content );
175  } else {
176  if ( $name !== null ) {
177  $retval .= $indstr . Xml::element( $name, $attributes, null );
178  }
179  $retval .= static::recXmlPrint( null, $content, $indent );
180  if ( $name !== null ) {
181  $retval .= $indstr . Xml::closeElement( $name );
182  }
183  }
184  } elseif ( !$indexedSubelements && !$subelements ) {
185  if ( $name !== null ) {
186  $retval .= $indstr . Xml::element( $name, $attributes );
187  }
188  } else {
189  if ( $name !== null ) {
190  $retval .= $indstr . Xml::element( $name, $attributes, null );
191  }
192  foreach ( $subelements as $k => $v ) {
193  $retval .= static::recXmlPrint( $k, $v, $indent );
194  }
195  foreach ( $indexedSubelements as $k => $v ) {
196  $retval .= static::recXmlPrint( $indexedTagName, $v, $indent,
197  $indexSubelements ? [ '_idx' => $k ] : []
198  );
199  }
200  if ( $name !== null ) {
201  $retval .= $indstr . Xml::closeElement( $name );
202  }
203  }
204  } else {
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 );
209  } else {
210  $retval .= $indstr . Xml::element( $name, $attributes, $value );
211  }
212  }
213 
214  return $retval;
215  }
216 
223  private static function mangleName( $name, $preserveKeys = [] ) {
224  static $nsc = null, $nc = null;
225 
226  if ( in_array( $name, $preserveKeys, true ) ) {
227  return $name;
228  }
229 
230  if ( $name === '' ) {
231  return '_';
232  }
233 
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
237  // reserve it.
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}';
242  }
243 
244  if ( preg_match( "/^[$nsc][$nc]*$/uS", $name ) ) {
245  return $name;
246  }
247 
248  return '_' . preg_replace_callback(
249  "/[^$nc]/uS",
250  function ( $m ) {
251  return sprintf( '.%X.', UtfNormal\Utils::utf8ToCodepoint( $m[0] ) );
252  },
253  str_replace( '.', '.2E.', $name )
254  );
255  }
256 
257  protected function addXslt() {
258  $nt = Title::newFromText( $this->mXslt );
259  if ( is_null( $nt ) || !$nt->exists() ) {
260  $this->addWarning( 'apiwarn-invalidxmlstylesheet' );
261 
262  return;
263  }
264  if ( $nt->getNamespace() != NS_MEDIAWIKI ) {
265  $this->addWarning( 'apiwarn-invalidxmlstylesheetns' );
266 
267  return;
268  }
269  if ( substr( $nt->getText(), -4 ) !== '.xsl' ) {
270  $this->addWarning( 'apiwarn-invalidxmlstylesheetext' );
271 
272  return;
273  }
274  $this->printText( '<?xml-stylesheet href="' .
275  htmlspecialchars( $nt->getLocalURL( 'action=raw' ) ) . '" type="text/xsl" ?>' );
276  }
277 
278  public function getAllowedParams() {
279  return parent::getAllowedParams() + [
280  'xslt' => [
281  ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-xslt',
282  ],
283  'includexmlnamespace' => [
284  ApiBase::PARAM_DFLT => false,
285  ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-includexmlnamespace',
286  ],
287  ];
288  }
289 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
API XML output formatter.
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
getResult()
Get the result object.
Definition: ApiBase.php:633
static $namespace
setRootElement( $rootElemName)
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:49
$value
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:744
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
static isMetadataKey( $key)
Test whether a key should be considered metadata.
Definition: ApiResult.php:793
printText( $text)
Append text to the output buffer.
This is the abstract base class for API formatters.
const META_PRESERVE_KEYS
Key for the &#39;preserve keys&#39; metadata item.
Definition: ApiResult.php:84
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 '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. '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 '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 since 1.28! 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:1980
getIsHtml()
Returns true when the HTML pretty-printer should be used.
$params
static mangleName( $name, $preserveKeys=[])
Mangle XML-invalid names to be valid in XML.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don&#39;t use this unless yo...
Definition: ApiResult.php:58
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:72
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
static recXmlPrint( $name, $value, $indent, $attributes=[])
This method takes an array and converts it to XML.
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
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
const META_INDEXED_TAG_NAME
Key for the &#39;indexed tag name&#39; metadata item.
Definition: ApiResult.php:72
const META_SUBELEMENTS
Key for the &#39;subelements&#39; metadata item.
Definition: ApiResult.php:78
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1910
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
const META_BC_BOOLS
Key for the &#39;BC bools&#39; metadata item.
Definition: ApiResult.php:136
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
const META_CONTENT
Key for the &#39;content&#39; metadata item.
Definition: ApiResult.php:90
const META_BC_SUBELEMENTS
Key for the &#39;BC subelements&#39; metadata item.
Definition: ApiResult.php:143
$content
Definition: pageupdater.txt:72
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319