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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?php
namespace SMW\MediaWiki\Api;
use ApiBase;
use SMW\ApplicationFactory;
use SMW\DIWikiPage;
use SMW\MediaWiki\Specials\Browse\HtmlBuilder;
/**
* Browse a subject api module
*
* @note To browse a particular subobject use the 'subobject' parameter because
* MW's WebRequest (responsible for handling request data sent by a browser) will
* eliminate any fragments (marked by "#") therefore using something like
* '"Lorem_ipsum#Foo' is not going to work but '&subject=Lorem_ipsum&subobject=Foo'
* will return results for the selected subobject
*
* @ingroup Api
*
* @license GNU GPL v2+
* @since 1.9
*
* @author mwjames
*/
class BrowseBySubject extends ApiBase {
/**
* @deprecated since 3.0, use the smwbrowse API module
*/
public function isDeprecated() {
return true;
}
/**
* @see ApiBase::execute
*/
public function execute() {
$params = $this->extractRequestParams();
if ( isset( $params['type'] ) && $params['type'] === 'html' ) {
$data = $this->buildHTML( $params );
} else {
$data = $this->doSerialize( $params );
}
$this->getResult()->addValue(
null,
'query',
$data
);
}
protected function buildHTML( $params ) {
$subject = new DIWikiPage(
$params['subject'],
$params['ns'],
$params['iw'],
$params['subobject']
);
$htmlBuilder = new HtmlBuilder(
ApplicationFactory::getInstance()->getStore(),
$subject
);
$htmlBuilder->setOptions(
(array)$params['options']
);
return $htmlBuilder->buildHTML();
}
protected function doSerialize( $params ) {
$applicationFactory = ApplicationFactory::getInstance();
$title = $applicationFactory->newTitleFactory()->newFromText(
$params['subject'],
$params['ns']
);
$deepRedirectTargetResolver = $applicationFactory->newMwCollaboratorFactory()->newDeepRedirectTargetResolver();
try {
$title = $deepRedirectTargetResolver->findRedirectTargetFor( $title );
} catch ( \Exception $e ) {
// 1.29+
if ( method_exists( $this, 'dieWithError' ) ) {
$this->dieWithError( [ 'smw-redirect-target-unresolvable', $e->getMessage() ] );
} else {
$this->dieUsage( $e->getMessage(), 'redirect-target-unresolvable' );
}
}
$dataItem = new DIWikiPage(
$title->getDBkey(),
$title->getNamespace(),
$title->getInterwiki(),
$params['subobject']
);
$semanticData = $applicationFactory->getStore()->getSemanticData(
$dataItem
);
$semanticDataSerializer = $applicationFactory->newSerializerFactory()->newSemanticDataSerializer();
return $this->doFormat( $semanticDataSerializer->serialize( $semanticData ) );
}
protected function doFormat( $serialized ) {
$this->addIndexTags( $serialized );
if ( isset( $serialized['sobj'] ) ) {
$this->getResult()->setIndexedTagName( $serialized['sobj'], 'subobject' );
foreach ( $serialized['sobj'] as $key => &$value ) {
$this->addIndexTags( $value );
}
}
return $serialized;
}
protected function addIndexTags( &$serialized ) {
if ( isset( $serialized['data'] ) && is_array( $serialized['data'] ) ) {
$this->getResult()->setIndexedTagName( $serialized['data'], 'property' );
foreach ( $serialized['data'] as $key => $value ) {
if ( isset( $serialized['data'][$key]['dataitem'] ) && is_array( $serialized['data'][$key]['dataitem'] ) ) {
$this->getResult()->setIndexedTagName( $serialized['data'][$key]['dataitem'], 'value' );
}
}
}
}
/**
* @codeCoverageIgnore
* @see ApiBase::getAllowedParams
*
* @return array
*/
public function getAllowedParams() {
return [
'subject' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_REQUIRED => true,
],
'ns' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_DFLT => 0,
ApiBase::PARAM_REQUIRED => false,
],
'iw' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_REQUIRED => false,
],
'subobject' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_REQUIRED => false,
],
'type' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_REQUIRED => false,
],
'options' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_REQUIRED => false,
]
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getParamDescription
*
* @return array
*/
public function getParamDescription() {
return [
'subject' => 'The subject to be queried',
'subobject' => 'A particular subobject id for the related subject'
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getDescription
*
* @return array
*/
public function getDescription() {
return [
'API module to query a subject.'
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getExamples
*
* @return array
*/
protected function getExamples() {
return [
'api.php?action=browsebysubject&subject=Main_Page',
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getVersion
*
* @return string
*/
public function getVersion() {
return __CLASS__ . '-' . SMW_VERSION;
}
}
|
