1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<?php
/**
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Json\FormatJson;
use Wikimedia\ParamValidator\ParamValidator;
/**
* API JSON output formatter
* @ingroup API
*/
class ApiFormatJson extends ApiFormatBase {
/** @var bool */
private $isRaw;
public function __construct( ApiMain $main, string $format ) {
parent::__construct( $main, $format );
$this->isRaw = ( $format === 'rawfm' );
if ( $this->getMain()->getCheck( 'callback' ) ) {
# T94015: jQuery appends a useless '_' parameter in jsonp mode.
# Mark the parameter as used in that case to avoid a warning that's
# outside the control of the end user.
# (and do it here because ApiMain::reportUnusedParams() gets called
# before our ::execute())
$this->getMain()->markParamsUsed( '_' );
}
}
public function getMimeType() {
$params = $this->extractRequestParams();
// callback:
if ( isset( $params['callback'] ) ) {
return 'text/javascript';
}
return 'application/json';
}
public function execute() {
$params = $this->extractRequestParams();
$opt = 0;
if ( $this->isRaw ) {
$opt |= FormatJson::ALL_OK;
$transform = [];
} else {
switch ( $params['formatversion'] ) {
case 1:
$opt |= $params['utf8'] ? FormatJson::ALL_OK : FormatJson::XMLMETA_OK;
$transform = [
'BC' => [],
'Types' => [ 'AssocAsObject' => true ],
'Strip' => 'all',
];
break;
case 2:
case 'latest':
$opt |= $params['ascii'] ? FormatJson::XMLMETA_OK : FormatJson::ALL_OK;
$transform = [
'Types' => [ 'AssocAsObject' => true ],
'Strip' => 'all',
];
break;
default:
// Should have been caught during parameter validation
// @codeCoverageIgnoreStart
self::dieDebug( __METHOD__, 'Unknown value for \'formatversion\'' );
// @codeCoverageIgnoreEnd
}
}
$data = $this->getResult()->getResultData( null, $transform );
$json = FormatJson::encode( $data, $this->getIsHtml(), $opt );
if ( $json === false ) {
// This should never happen, but it's a bug which could crop up
// if you use ApiResult::NO_VALIDATE for instance.
// @codeCoverageIgnoreStart
self::dieDebug( __METHOD__, 'Unable to encode API result as JSON' );
// @codeCoverageIgnoreEnd
}
if ( isset( $params['callback'] ) ) {
$callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
# Prepend a comment to try to avoid attacks against content
# sniffers, such as T70187.
$this->printText( "/**/$callback($json)" );
} else {
$this->printText( $json );
}
}
public function getAllowedParams() {
if ( $this->isRaw ) {
return parent::getAllowedParams();
}
return parent::getAllowedParams() + [
'callback' => [
ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback',
],
'utf8' => [
ParamValidator::PARAM_DEFAULT => false,
ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8',
],
'ascii' => [
ParamValidator::PARAM_DEFAULT => false,
ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-ascii',
],
'formatversion' => [
ParamValidator::PARAM_TYPE => [ '1', '2', 'latest' ],
ParamValidator::PARAM_DEFAULT => '1',
ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-formatversion',
ApiBase::PARAM_HELP_MSG_PER_VALUE => [
'1' => 'apihelp-json-paramvalue-formatversion-1',
'2' => 'apihelp-json-paramvalue-formatversion-2',
'latest' => 'apihelp-json-paramvalue-formatversion-latest',
],
],
];
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiFormatJson::class, 'ApiFormatJson' );
|
