5 * Created on Sep 19, 2006
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * API JSON output formatter
31 class ApiFormatJson
extends ApiFormatBase
{
35 public function __construct( ApiMain
$main, $format ) {
36 parent
::__construct( $main, $format );
37 $this->isRaw
= ( $format === 'rawfm' );
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()->getCheck( '_' );
49 public function getMimeType() {
50 $params = $this->extractRequestParams();
52 if ( isset( $params['callback'] ) ) {
53 return 'text/javascript';
56 return 'application/json';
60 * @deprecated since 1.25
62 public function getNeedsRawData() {
67 * @deprecated since 1.25
69 public function getWantsHelp() {
70 wfDeprecated( __METHOD__
, '1.25' );
71 // Help is always ugly in JSON
75 public function execute() {
76 $params = $this->extractRequestParams();
80 $opt |
= FormatJson
::ALL_OK
;
83 switch ( $params['formatversion'] ) {
85 $opt |
= $params['utf8'] ? FormatJson
::ALL_OK
: FormatJson
::XMLMETA_OK
;
88 'Types' => array( 'AssocAsObject' => true ),
95 $opt |
= $params['ascii'] ? FormatJson
::XMLMETA_OK
: FormatJson
::ALL_OK
;
97 'Types' => array( 'AssocAsObject' => true ),
103 $this->dieUsage( __METHOD__
. ': Unknown value for \'formatversion\'', 'unknownformatversion' );
106 $data = $this->getResult()->getResultData( null, $transform );
107 $json = FormatJson
::encode( $data, $this->getIsHtml(), $opt );
109 // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
110 // Flash, but what it does isn't friendly for the API, so we need to
112 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
113 $json = preg_replace(
114 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
118 if ( isset( $params['callback'] ) ) {
119 $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
120 # Prepend a comment to try to avoid attacks against content
121 # sniffers, such as bug 68187.
122 $this->printText( "/**/$callback($json)" );
124 $this->printText( $json );
128 public function getAllowedParams() {
129 if ( $this->isRaw
) {
135 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-callback',
138 ApiBase
::PARAM_DFLT
=> false,
139 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-utf8',
142 ApiBase
::PARAM_DFLT
=> false,
143 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-ascii',
145 'formatversion' => array(
146 ApiBase
::PARAM_TYPE
=> array( 1, 2, 'latest' ),
147 ApiBase
::PARAM_DFLT
=> 1,
148 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-formatversion',