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
|
<?php
/**
*
*
* Created on Jul 29, 2011
*
* 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
*/
/**
* @ingroup API
*/
class ApiTokens extends ApiBase {
public function execute() {
$params = $this->extractRequestParams();
$res = array();
$types = $this->getTokenTypes();
foreach ( $params['type'] as $type ) {
$val = call_user_func( $types[$type], null, null );
if ( $val === false ) {
$this->setWarning( "Action '$type' is not allowed for the current user" );
} else {
$res[$type . 'token'] = $val;
}
}
$this->getResult()->addValue( null, $this->getModuleName(), $res );
}
private function getTokenTypes() {
// If we're in JSON callback mode, no tokens can be obtained
if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
return array();
}
static $types = null;
if ( $types ) {
return $types;
}
wfProfileIn( __METHOD__ );
$types = array( 'patrol' => array( 'ApiQueryRecentChanges', 'getPatrolToken' ) );
$names = array( 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
'email', 'import', 'watch', 'options' );
foreach ( $names as $name ) {
$types[$name] = array( 'ApiQueryInfo', 'get' . ucfirst( $name ) . 'Token' );
}
wfRunHooks( 'ApiTokensGetTokenTypes', array( &$types ) );
ksort( $types );
wfProfileOut( __METHOD__ );
return $types;
}
public function getAllowedParams() {
return array(
'type' => array(
ApiBase::PARAM_DFLT => 'edit',
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
),
);
}
public function getResultProperties() {
$props = array(
'' => array(),
);
self::addTokenProperties( $props, $this->getTokenTypes() );
return $props;
}
public function getParamDescription() {
return array(
'type' => 'Type of token(s) to request'
);
}
public function getDescription() {
return 'Gets tokens for data-modifying actions';
}
protected function getExamples() {
return array(
'api.php?action=tokens' => 'Retrieve an edit token (the default)',
'api.php?action=tokens&type=email|move' => 'Retrieve an email token and a move token'
);
}
}
|
