3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * API JSON output formatter
27 class ApiFormatJson
extends ApiFormatBase
{
31 public function __construct( ApiMain
$main, $format ) {
32 parent
::__construct( $main, $format );
33 $this->isRaw
= ( $format === 'rawfm' );
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( '_' );
45 public function getMimeType() {
46 $params = $this->extractRequestParams();
48 if ( isset( $params['callback'] ) ) {
49 return 'text/javascript';
52 return 'application/json';
55 public function execute() {
56 $params = $this->extractRequestParams();
60 $opt |
= FormatJson
::ALL_OK
;
63 switch ( $params['formatversion'] ) {
65 $opt |
= $params['utf8'] ? FormatJson
::ALL_OK
: FormatJson
::XMLMETA_OK
;
68 'Types' => [ 'AssocAsObject' => true ],
75 $opt |
= $params['ascii'] ? FormatJson
::XMLMETA_OK
: FormatJson
::ALL_OK
;
77 'Types' => [ 'AssocAsObject' => true ],
83 // Should have been caught during parameter validation
84 $this->dieDebug( __METHOD__
, 'Unknown value for \'formatversion\'' );
87 $data = $this->getResult()->getResultData( null, $transform );
88 $json = FormatJson
::encode( $data, $this->getIsHtml(), $opt );
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
93 if ( preg_match( '/\<\s*cross-domain-policy(?=\s|\>)/i', $json ) ) {
95 '/\<(\s*cross-domain-policy(?=\s|\>))/i', '\\u003C$1', $json
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)" );
105 $this->printText( $json );
109 public function getAllowedParams() {
110 if ( $this->isRaw
) {
111 return parent
::getAllowedParams();
114 $ret = parent
::getAllowedParams() +
[
116 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-callback',
119 ApiBase
::PARAM_DFLT
=> false,
120 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-utf8',
123 ApiBase
::PARAM_DFLT
=> false,
124 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-ascii',
127 ApiBase
::PARAM_TYPE
=> [ '1', '2', 'latest' ],
128 ApiBase
::PARAM_DFLT
=> '1',
129 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-formatversion',