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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
/**
* Created on 15 April 2011
* API for Gadgets extension
*
* 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
*/
class ApiQueryGadgets extends ApiQueryBase {
private $props,
$category,
$neededIds,
$listAllowed,
$listEnabled;
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ga' );
}
public function execute() {
$params = $this->extractRequestParams();
$this->props = array_flip( $params['prop'] );
$this->categories = isset( $params['categories'] )
? array_flip( $params['categories'] )
: false;
$this->neededIds = isset( $params['ids'] )
? array_flip( $params['ids'] )
: false;
$this->listAllowed = isset( $params['allowed'] ) && $params['allowed'];
$this->listEnabled = isset( $params['enabled'] ) && $params['enabled'];
$this->getMain()->setCacheMode( $this->listAllowed || $this->listEnabled
? 'anon-public-user-private' : 'public' );
$this->applyList( $this->getList() );
}
private function getList() {
$gadgets = Gadget::loadStructuredList();
$result = array();
foreach ( $gadgets as $category => $list ) {
if ( $this->categories && !isset( $this->categories[$category] ) ) {
continue;
}
foreach ( $list as $g ) {
if ( $this->isNeeded( $g ) ) {
$result[] = $g;
}
}
}
return $result;
}
private function applyList( $gadgets ) {
$data = array();
$result = $this->getResult();
foreach ( $gadgets as $g ) {
$row = array();
if ( isset( $this->props['id'] ) ) {
$row['id'] = $g->getName();
}
if ( isset( $this->props['metadata'] ) ) {
$row['metadata'] = $this->fakeMetadata( $g );
$this->setIndexedTagNameForMetadata( $row['metadata'] );
}
if ( isset( $this->props['desc'] ) ) {
$row['desc'] = $g->getDescription();
}
$data[] = $row;
}
$result->setIndexedTagName( $data, 'gadget' );
$result->addValue( 'query', $this->getModuleName(), $data );
}
/**
*
*/
private function isNeeded( Gadget $gadget ) {
global $wgUser;
return ( $this->neededIds === false || isset( $this->neededIds[$gadget->getName()] ) )
&& ( !$this->listAllowed || $gadget->isAllowed( $wgUser ) )
&& ( !$this->listEnabled || $gadget->isEnabled( $wgUser ) );
}
private function fakeMetadata( Gadget $g ) {
return array(
'settings' => array(
'rights' => $g->getRequiredRights(),
'default' => $g->isOnByDefault(),
'hidden' => false, // Only exists in RL2 branch
'shared' => false, // Only exists in RL2 branch
'category' => $g->getCategory(),
),
'module' => array(
'scripts' => $g->getScripts(),
'styles' => $g->getStyles(),
'dependencies' => $g->getDependencies(),
'messages' => array(), // Only exists in RL2 branch
)
);
}
private function setIndexedTagNameForMetadata( &$metadata ) {
static $tagNames = array(
'rights' => 'right',
'scripts' => 'script',
'styles' => 'style',
'dependencies' => 'dependency',
'messages' => 'message',
);
$result = $this->getResult();
foreach ( $metadata as $type => &$data ) {
foreach ( $data as $key => &$value ) {
if ( is_array( $value ) ) {
$tag = isset( $tagNames[$key] ) ? $tagNames[$key] : $key;
$result->setIndexedTagName( $value, $tag );
}
}
}
}
public function getAllowedParams() {
return array(
'prop' => array(
ApiBase::PARAM_DFLT => 'id|metadata',
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array(
'id',
'metadata',
'desc',
),
),
'language' => null,
'categories' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => 'string',
),
'ids' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => true,
),
'allowed' => false,
'enabled' => false,
);
}
public function getDescription() {
return 'Returns a list of gadgets used on this wiki';
}
public function getParamDescription() {
$p = $this->getModulePrefix();
return array(
'prop' => array(
'What gadget information to get:',
' id - Internal gadget ID',
' metadata - The gadget metadata',
' desc - Gadget description transformed into HTML (can be slow, use only if really needed)',
),
'categories' => 'Gadgets from what categories to retrieve',
'ids' => 'ID(s) of gadgets to retrieve',
'allowed' => 'List only gadgets allowed to current user',
'enabled' => 'List only gadgets enabled by current user',
);
}
protected function getExamples() {
$params = $this->getAllowedParams();
$allProps = implode( '|', $params['prop'][ApiBase::PARAM_TYPE] );
return array(
'Get a list of gadgets along with their descriptions:',
' api.php?action=query&list=gadgets&gaprop=id|desc',
'Get a list of gadgets with all possble properties:',
" api.php?action=query&list=gadgets&gaprop=$allProps",
'Get a list of gadgets belonging to caregory "foo":',
' api.php?action=query&list=gadgets&gacategories=foo',
'Get information about gadgets "foo" and "bar":',
' api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata',
'Get a list of gadgets enabled by current user:',
' api.php?action=query&list=gadgets&gaenabled',
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryGadgets.php 97274 2011-09-16 14:24:52Z reedy $';
}
}
|
