MediaWiki  REL1_31
ApiFormatJson.php
Go to the documentation of this file.
1 <?php
28 
29  private $isRaw;
30 
31  public function __construct( ApiMain $main, $format ) {
32  parent::__construct( $main, $format );
33  $this->isRaw = ( $format === 'rawfm' );
34 
35  if ( $this->getMain()->getCheck( 'callback' ) ) {
36  # T94015: jQuery appends a useless '_' parameter in jsonp mode.
37  # Mark the parameter as used in that case to avoid a warning that's
38  # outside the control of the end user.
39  # (and do it here because ApiMain::reportUnusedParams() gets called
40  # before our ::execute())
41  $this->getMain()->markParamsUsed( '_' );
42  }
43  }
44 
45  public function getMimeType() {
46  $params = $this->extractRequestParams();
47  // callback:
48  if ( isset( $params['callback'] ) ) {
49  return 'text/javascript';
50  }
51 
52  return 'application/json';
53  }
54 
55  public function execute() {
56  $params = $this->extractRequestParams();
57 
58  $opt = 0;
59  if ( $this->isRaw ) {
61  $transform = [];
62  } else {
63  switch ( $params['formatversion'] ) {
64  case 1:
66  $transform = [
67  'BC' => [],
68  'Types' => [ 'AssocAsObject' => true ],
69  'Strip' => 'all',
70  ];
71  break;
72 
73  case 2:
74  case 'latest':
76  $transform = [
77  'Types' => [ 'AssocAsObject' => true ],
78  'Strip' => 'all',
79  ];
80  break;
81 
82  default:
83  // Should have been caught during parameter validation
84  $this->dieDebug( __METHOD__, 'Unknown value for \'formatversion\'' );
85  }
86  }
87  $data = $this->getResult()->getResultData( null, $transform );
88  $json = FormatJson::encode( $data, $this->getIsHtml(), $opt );
89 
90  // T68776: OutputHandler::mangleFlashPolicy() avoids a nasty bug in
91  // Flash, but what it does isn't friendly for the API, so we need to
92  // work around it.
93  if ( preg_match( '/<\s*cross-domain-policy(?=\s|>)/i', $json ) ) {
94  $json = preg_replace(
95  '/<(\s*cross-domain-policy(?=\s|>))/i', '\\u003C$1', $json
96  );
97  }
98 
99  if ( isset( $params['callback'] ) ) {
100  $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
101  # Prepend a comment to try to avoid attacks against content
102  # sniffers, such as T70187.
103  $this->printText( "/**/$callback($json)" );
104  } else {
105  $this->printText( $json );
106  }
107  }
108 
109  public function getAllowedParams() {
110  if ( $this->isRaw ) {
111  return parent::getAllowedParams();
112  }
113 
114  $ret = parent::getAllowedParams() + [
115  'callback' => [
116  ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback',
117  ],
118  'utf8' => [
119  ApiBase::PARAM_DFLT => false,
120  ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8',
121  ],
122  'ascii' => [
123  ApiBase::PARAM_DFLT => false,
124  ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-ascii',
125  ],
126  'formatversion' => [
127  ApiBase::PARAM_TYPE => [ '1', '2', 'latest' ],
128  ApiBase::PARAM_DFLT => '1',
129  ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-formatversion',
130  ],
131  ];
132  return $ret;
133  }
134 }
ApiFormatJson\__construct
__construct(ApiMain $main, $format)
If $format ends with 'fm', pretty-print the output in HTML.
Definition: ApiFormatJson.php:31
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
ApiFormatJson\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiFormatJson.php:109
$opt
$opt
Definition: postprocess-phan.php:119
FormatJson\XMLMETA_OK
const XMLMETA_OK
Skip escaping the characters '<', '>', and '&', which have special meanings in HTML and XML.
Definition: FormatJson.php:46
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
$ret
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:2005
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
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
$params
$params
Definition: styleTest.css.php:40
FormatJson\ALL_OK
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
true
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:2006
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
ApiFormatJson
API JSON output formatter.
Definition: ApiFormatJson.php:27
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
ApiFormatJson\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiFormatJson.php:55
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiFormatJson\$isRaw
$isRaw
Definition: ApiFormatJson.php:29
ApiFormatJson\getMimeType
getMimeType()
Overriding class returns the MIME type that should be sent to the client.
Definition: ApiFormatJson.php:45
ApiFormatBase\printText
printText( $text)
Append text to the output buffer.
Definition: ApiFormatBase.php:347
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:537
ApiFormatBase\getIsHtml
getIsHtml()
Returns true when the HTML pretty-printer should be used.
Definition: ApiFormatBase.php:97
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2078