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' );
40 public function getMimeType() {
41 $params = $this->extractRequestParams();
43 if ( isset( $params['callback'] ) ) {
44 return 'text/javascript';
47 return 'application/json';
51 * @deprecated since 1.25
53 public function getNeedsRawData() {
58 * @deprecated since 1.25
60 public function getWantsHelp() {
61 wfDeprecated( __METHOD__
, '1.25' );
62 // Help is always ugly in JSON
66 public function execute() {
67 $params = $this->extractRequestParams();
71 $opt |
= FormatJson
::ALL_OK
;
74 switch ( $params['formatversion'] ) {
76 $opt |
= $params['utf8'] ? FormatJson
::ALL_OK
: FormatJson
::XMLMETA_OK
;
79 'Types' => array( 'AssocAsObject' => true ),
86 $opt |
= $params['ascii'] ? FormatJson
::XMLMETA_OK
: FormatJson
::ALL_OK
;
88 'Types' => array( 'AssocAsObject' => true ),
94 $this->dieUsage( __METHOD__
. ': Unknown value for \'formatversion\'', 'unknownformatversion' );
97 $data = $this->getResult()->getResultData( null, $transform );
98 $json = FormatJson
::encode( $data, $this->getIsHtml(), $opt );
100 // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
101 // Flash, but what it does isn't friendly for the API, so we need to
103 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
104 $json = preg_replace(
105 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
109 if ( isset( $params['callback'] ) ) {
110 $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
111 # Prepend a comment to try to avoid attacks against content
112 # sniffers, such as bug 68187.
113 $this->printText( "/**/$callback($json)" );
115 $this->printText( $json );
119 public function getAllowedParams() {
120 if ( $this->isRaw
) {
126 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-callback',
129 ApiBase
::PARAM_DFLT
=> false,
130 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-utf8',
133 ApiBase
::PARAM_DFLT
=> false,
134 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-ascii',
136 'formatversion' => array(
137 ApiBase
::PARAM_TYPE
=> array( 1, 2, 'latest' ),
138 ApiBase
::PARAM_DFLT
=> 1,
139 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-json-param-formatversion',