MediaWiki REL1_27
ApiFormatJson.php
Go to the documentation of this file.
1<?php
32
33 private $isRaw;
34
35 public function __construct( ApiMain $main, $format ) {
36 parent::__construct( $main, $format );
37 $this->isRaw = ( $format === 'rawfm' );
38
39 if ( $this->getMain()->getCheck( 'callback' ) ) {
40 # T94015: jQuery appends a useless '_' parameter in jsonp mode.
41 # Mark the parameter as used in that case to avoid a warning that's
42 # outside the control of the end user.
43 # (and do it here because ApiMain::reportUnusedParams() gets called
44 # before our ::execute())
45 $this->getMain()->markParamsUsed( '_' );
46 }
47 }
48
49 public function getMimeType() {
51 // callback:
52 if ( isset( $params['callback'] ) ) {
53 return 'text/javascript';
54 }
55
56 return 'application/json';
57 }
58
62 public function getWantsHelp() {
63 wfDeprecated( __METHOD__, '1.25' );
64 // Help is always ugly in JSON
65 return false;
66 }
67
68 public function execute() {
70
71 $opt = 0;
72 if ( $this->isRaw ) {
73 $opt |= FormatJson::ALL_OK;
74 $transform = [];
75 } else {
76 switch ( $params['formatversion'] ) {
77 case 1:
78 $opt |= $params['utf8'] ? FormatJson::ALL_OK : FormatJson::XMLMETA_OK;
79 $transform = [
80 'BC' => [],
81 'Types' => [ 'AssocAsObject' => true ],
82 'Strip' => 'all',
83 ];
84 break;
85
86 case 2:
87 case 'latest':
88 $opt |= $params['ascii'] ? FormatJson::XMLMETA_OK : FormatJson::ALL_OK;
89 $transform = [
90 'Types' => [ 'AssocAsObject' => true ],
91 'Strip' => 'all',
92 ];
93 break;
94
95 default:
96 $this->dieUsage( __METHOD__ .
97 ': Unknown value for \'formatversion\'', 'unknownformatversion' );
98 }
99 }
100 $data = $this->getResult()->getResultData( null, $transform );
101 $json = FormatJson::encode( $data, $this->getIsHtml(), $opt );
102
103 // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
104 // Flash, but what it does isn't friendly for the API, so we need to
105 // work around it.
106 if ( preg_match( '/<\s*cross-domain-policy(?=\s|>)/i', $json ) ) {
107 $json = preg_replace(
108 '/<(\s*cross-domain-policy(?=\s|>))/i', '\\u003C$1', $json
109 );
110 }
111
112 if ( isset( $params['callback'] ) ) {
113 $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
114 # Prepend a comment to try to avoid attacks against content
115 # sniffers, such as bug 68187.
116 $this->printText( "/**/$callback($json)" );
117 } else {
118 $this->printText( $json );
119 }
120 }
121
122 public function getAllowedParams() {
123 if ( $this->isRaw ) {
124 return parent::getAllowedParams();
125 }
126
127 $ret = parent::getAllowedParams() + [
128 'callback' => [
129 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback',
130 ],
131 'utf8' => [
132 ApiBase::PARAM_DFLT => false,
133 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8',
134 ],
135 'ascii' => [
136 ApiBase::PARAM_DFLT => false,
137 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-ascii',
138 ],
139 'formatversion' => [
140 ApiBase::PARAM_TYPE => [ 1, 2, 'latest' ],
142 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-formatversion',
143 ],
144 ];
145 return $ret;
146 }
147}
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getMain()
Get the main module.
Definition ApiBase.php:480
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:88
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:685
getResult()
Get the result object.
Definition ApiBase.php:584
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:125
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition ApiBase.php:1526
This is the abstract base class for API formatters.
printText( $text)
Append text to the output buffer.
getIsHtml()
Returns true when the HTML pretty-printer should be used.
API JSON output formatter.
getMimeType()
Overriding class returns the MIME type that should be sent to the client.
__construct(ApiMain $main, $format)
If $format ends with 'fm', pretty-print the output in HTML.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
This is the main API class, used for both external and internal processing.
Definition ApiMain.php:41
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:1810
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:1811
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
$params