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
|
<?php
/**
* Copyright © 2011 John Du Hart john@johnduhart.me
*
* 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
*/
/**
* @deprecated since 1.24
* @ingroup API
*/
class ApiTokens extends ApiBase {
public function execute() {
$this->addDeprecation(
[ 'apiwarn-deprecation-withreplacement', 'action=tokens', 'action=query&meta=tokens' ],
'action=tokens'
);
$params = $this->extractRequestParams();
$res = [
ApiResult::META_TYPE => 'assoc',
];
$types = $this->getTokenTypes();
foreach ( $params['type'] as $type ) {
$val = call_user_func( $types[$type], $this->getUser() );
if ( $val === false ) {
$this->addWarning( [ 'apiwarn-tokennotallowed', $type ] );
} else {
$res[$type . 'token'] = $val;
}
}
$this->getResult()->addValue( null, $this->getModuleName(), $res );
}
private function getTokenTypes() {
// If we're in a mode that breaks the same-origin policy, no tokens can
// be obtained
if ( $this->lacksSameOriginSecurity() ) {
return [];
}
static $types = null;
if ( $types ) {
return $types;
}
$types = [ 'patrol' => [ ApiQueryRecentChanges::class, 'getPatrolToken' ] ];
$names = [ 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
'email', 'import', 'watch', 'options' ];
foreach ( $names as $name ) {
$types[$name] = [ ApiQueryInfo::class, 'get' . ucfirst( $name ) . 'Token' ];
}
// For forwards-compat, copy any token types from ApiQueryTokens that
// we don't already have something for.
$request = $this->getRequest();
foreach ( ApiQueryTokens::getTokenTypeSalts() as $name => $salt ) {
if ( !isset( $types[$name] ) ) {
$types[$name] = static function ( User $user ) use ( $salt, $request ) {
return ApiQueryTokens::getToken( $user, $request->getSession(), $salt )->toString();
};
}
}
ksort( $types );
return $types;
}
public function isDeprecated() {
return true;
}
public function getAllowedParams() {
return [
'type' => [
ApiBase::PARAM_DFLT => 'edit',
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
],
];
}
protected function getExamplesMessages() {
return [
'action=tokens'
=> 'apihelp-tokens-example-edit',
'action=tokens&type=email|move'
=> 'apihelp-tokens-example-emailmove',
];
}
}
|
