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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<?php
/**
*
*
* Created on Sep 6, 2006
*
* 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
*/
/**
* This is a simple class to handle action=help
*
* @ingroup API
*/
class ApiHelp extends ApiBase {
/**
* Module for displaying help
*/
public function execute() {
// Get parameters
$params = $this->extractRequestParams();
if ( !isset( $params['modules'] ) && !isset( $params['querymodules'] ) ) {
$this->dieUsage( '', 'help' );
}
$this->getMain()->setHelp();
$result = $this->getResult();
if ( is_array( $params['modules'] ) ) {
$modules = $params['modules'];
} else {
$modules = array();
}
if ( is_array( $params['querymodules'] ) ) {
$this->logFeatureUsage( 'action=help&querymodules' );
$queryModules = $params['querymodules'];
foreach ( $queryModules as $m ) {
$modules[] = 'query+' . $m;
}
} else {
$queryModules = array();
}
$r = array();
foreach ( $modules as $m ) {
// sub-modules could be given in the form of "name[+name[+name...]]"
$subNames = explode( '+', $m );
if ( count( $subNames ) === 1 ) {
// In case the '+' was typed into URL, it resolves as a space
$subNames = explode( ' ', $m );
}
$module = $this->getMain();
$subNamesCount = count( $subNames );
for ( $i = 0; $i < $subNamesCount; $i++ ) {
$subs = $module->getModuleManager();
if ( $subs === null ) {
$module = null;
} else {
$module = $subs->getModule( $subNames[$i] );
}
if ( $module === null ) {
if ( count( $subNames ) === 2
&& $i === 1
&& $subNames[0] === 'query'
&& in_array( $subNames[1], $queryModules )
) {
// Legacy: This is one of the renamed 'querymodule=...' parameters,
// do not use '+' notation in the output, use submodule's name instead.
$name = $subNames[1];
} else {
$name = implode( '+', array_slice( $subNames, 0, $i + 1 ) );
}
$r[] = array( 'name' => $name, 'missing' => '' );
break;
} else {
$type = $subs->getModuleGroup( $subNames[$i] );
}
}
if ( $module !== null ) {
$r[] = $this->buildModuleHelp( $module, $type );
}
}
$result->setIndexedTagName( $r, 'module' );
$result->addValue( null, $this->getModuleName(), $r );
}
/**
* @param ApiBase $module
* @param string $type What type of request is this? e.g. action, query, list, prop, meta, format
* @return string
*/
private function buildModuleHelp( $module, $type ) {
$msg = ApiMain::makeHelpMsgHeader( $module, $type );
$msg2 = $module->makeHelpMsg();
if ( $msg2 !== false ) {
$msg .= $msg2;
}
return $msg;
}
public function shouldCheckMaxlag() {
return false;
}
public function isReadMode() {
return false;
}
public function getAllowedParams() {
return array(
'modules' => array(
ApiBase::PARAM_ISMULTI => true
),
'querymodules' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_DEPRECATED => true
),
);
}
public function getParamDescription() {
return array(
'modules' => 'List of module names (value of the action= parameter). ' .
'Can specify submodules with a \'+\'',
'querymodules' => 'Use modules=query+value instead. List of query ' .
'module names (value of prop=, meta= or list= parameter)',
);
}
public function getDescription() {
return 'Display this help screen. Or the help screen for the specified module.';
}
public function getExamples() {
return array(
'api.php?action=help' => 'Whole help page',
'api.php?action=help&modules=protect' => 'Module (action) help page',
'api.php?action=help&modules=query+categorymembers'
=> 'Help for the query/categorymembers module',
'api.php?action=help&modules=login|query+info'
=> 'Help for the login and query/info modules',
);
}
public function getHelpUrls() {
return array(
'https://www.mediawiki.org/wiki/API:Main_page',
'https://www.mediawiki.org/wiki/API:FAQ',
'https://www.mediawiki.org/wiki/API:Quick_start_guide',
);
}
}
|
