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
239
240
241
242
243
244
245
246
247
|
<?php
/**
* @file
* @ingroup SF
*/
/**
* Adds and handles the 'sfautocomplete' action to the MediaWiki API.
*
* @ingroup SF
*
* @author Sergey Chernyshev
* @author Yaron Koren
*/
class SFAutocompleteAPI extends ApiBase {
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName );
}
public function execute() {
$params = $this->extractRequestParams();
$substr = $params['substr'];
$namespace = $params['namespace'];
$property = $params['property'];
$category = $params['category'];
$concept = $params['concept'];
$external_url = $params['external_url'];
$baseprop = $params['baseprop'];
$basevalue = $params['basevalue'];
//$limit = $params['limit'];
if ( is_null( $baseprop ) && strlen( $substr ) == 0 ) {
$this->dieUsage( 'The substring must be specified', 'param_substr' );
}
if ( !is_null( $baseprop ) ) {
if ( !is_null( $property ) ) {
$data = self::getAllValuesForProperty( $property, null, $baseprop, $basevalue );
}
} elseif ( !is_null( $property ) ) {
$data = self::getAllValuesForProperty( $property, $substr );
} elseif ( !is_null( $category ) ) {
$data = SFUtils::getAllPagesForCategory( $category, 3, $substr );
} elseif ( !is_null( $concept ) ) {
$data = SFUtils::getAllPagesForConcept( $concept, $substr );
} elseif ( !is_null( $namespace ) ) {
$data = SFUtils::getAllPagesForNamespace( $namespace, $substr );
} elseif ( !is_null( $external_url ) ) {
$data = SFUtils::getValuesFromExternalURL( $external_url, $substr );
} else {
$data = array();
}
// If we got back an error message, exit with that message.
if ( !is_array( $data ) ) {
$this->dieUsage( $data );
}
// to prevent JS parsing problems, display should be the same
// even if there are no results
/*
if ( count( $data ) <= 0 ) {
return;
}
*/
// Format data as the API requires it - this is not needed
// for "values from url", where the data is already formatted
// correctly.
if ( is_null( $external_url ) ) {
$formattedData = array();
foreach ( $data as $value ) {
$formattedData[] = array( 'title' => $value );
}
} else {
$formattedData = $data;
}
// Set top-level elements.
$result = $this->getResult();
$result->setIndexedTagName( $formattedData, 'p' );
$result->addValue( null, $this->getModuleName(), $formattedData );
}
protected function getAllowedParams() {
return array (
'limit' => array (
ApiBase::PARAM_TYPE => 'limit',
ApiBase::PARAM_DFLT => 10,
ApiBase::PARAM_MIN => 1,
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
'substr' => null,
'property' => null,
'category' => null,
'concept' => null,
'namespace' => null,
'external_url' => null,
'baseprop' => null,
'basevalue' => null,
);
}
protected function getParamDescription() {
return array (
'substr' => 'Search substring',
'property' => 'Semantic property for which to search values',
'category' => 'Category for which to search values',
'concept' => 'Concept for which to search values',
'namespace' => 'Namespace for which to search values',
'external_url' => 'Alias for external URL from which to get values',
'baseprop' => 'A previous property in the form to check against',
'basevalue' => 'The value to check for the previous property',
//'limit' => 'Limit how many entries to return',
);
}
protected function getDescription() {
return 'Autocompletion call used by the Semantic Forms extension (http://www.mediawiki.org/Extension:Semantic_Forms)';
}
protected function getExamples() {
return array (
'api.php?action=sfautocomplete&substr=te',
'api.php?action=sfautocomplete&substr=te&property=Has_author',
'api.php?action=sfautocomplete&substr=te&category=Authors',
);
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
private static function getAllValuesForProperty( $property_name, $substring, $basePropertyName = null, $baseValue = null ) {
global $sfgMaxAutocompleteValues, $sfgCacheAutocompleteValues, $sfgAutocompleteCacheTimeout;
global $smwgDefaultStore;
$values = array();
$db = wfGetDB( DB_SLAVE );
$sqlOptions = array();
$sqlOptions['LIMIT'] = $sfgMaxAutocompleteValues;
$property = SMWPropertyValue::makeUserProperty( $property_name );
$propertyHasTypePage = ( $property->getPropertyTypeID() == '_wpg' );
$property_name = str_replace( ' ', '_', $property_name );
$conditions = array( 'p_ids.smw_title' => $property_name );
// Use cache if allowed
if ( $sfgCacheAutocompleteValues ) {
$cache = SFFormUtils::getFormCache();
// Remove trailing whitespace to avoid unnecessary database selects
$cacheKeyString = $property_name . '::' . rtrim( $substring );
if ( !is_null( $basePropertyName ) ) {
$cacheKeyString .= ',' . $basePropertyName . ',' . $baseValue;
}
$cacheKey = wfMemcKey( 'sf-autocomplete' , md5( $cacheKeyString ) );
$values = $cache->get( $cacheKey );
if ( !empty( $values ) ){
// Return with results immediately
return $values;
}
}
if ( $propertyHasTypePage ) {
$valueField = 'o_ids.smw_title';
if ( $smwgDefaultStore === 'SMWSQLStore3' ) {
$idsTable = $db->tableName( 'smw_object_ids' );
$propsTable = $db->tableName( 'smw_di_wikipage' );
} else {
$idsTable = $db->tableName( 'smw_ids' );
$propsTable = $db->tableName( 'smw_rels2' );
}
$fromClause = "$propsTable p JOIN $idsTable p_ids ON p.p_id = p_ids.smw_id JOIN $idsTable o_ids ON p.o_id = o_ids.smw_id";
} else {
if ( $smwgDefaultStore === 'SMWSQLStore3' ) {
$valueField = 'p.o_hash';
$idsTable = $db->tableName( 'smw_object_ids' );
$propsTable = $db->tableName( 'smw_di_blob' );
} else {
$valueField = 'p.value_xsd';
$idsTable = $db->tableName( 'smw_ids' );
$propsTable = $db->tableName( 'smw_atts2' );
}
$fromClause = "$propsTable p JOIN $idsTable p_ids ON p.p_id = p_ids.smw_id";
}
if ( !is_null( $basePropertyName ) ) {
$baseProperty = SMWPropertyValue::makeUserProperty( $basePropertyName );
$basePropertyHasTypePage = ( $baseProperty->getPropertyTypeID() == '_wpg' );
$basePropertyName = str_replace( ' ', '_', $basePropertyName );
$conditions['base_p_ids.smw_title'] = $basePropertyName;
if ( $basePropertyHasTypePage ) {
if ( $smwgDefaultStore === 'SMWSQLStore3' ) {
$idsTable = $db->tableName( 'smw_object_ids' );
$propsTable = $db->tableName( 'smw_di_wikipage' );
} else {
$idsTable = $db->tableName( 'smw_ids' );
$propsTable = $db->tableName( 'smw_rels2' );
}
$fromClause .= " JOIN $propsTable p_base ON p.s_id = p_base.s_id";
$fromClause .= " JOIN $idsTable base_p_ids ON p_base.p_id = base_p_ids.smw_id JOIN $idsTable base_o_ids ON p_base.o_id = base_o_ids.smw_id";
$baseValue = str_replace( ' ', '_', $baseValue );
$conditions['base_o_ids.smw_title'] = $baseValue;
} else {
if ( $smwgDefaultStore === 'SMWSQLStore3' ) {
$baseValueField = 'p_base.o_hash';
$idsTable = $db->tableName( 'smw_object_ids' );
$propsTable = $db->tableName( 'smw_di_blob' );
} else {
$baseValueField = 'p_base.value_xsd';
$idsTable = $db->tableName( 'smw_ids' );
$propsTable = $db->tableName( 'smw_atts2' );
}
$fromClause .= " JOIN $propsTable p_base ON p.s_id = p_base.s_id";
$fromClause .= " JOIN $idsTable base_p_ids ON p_base.p_id = base_p_ids.smw_id";
$conditions[$baseValueField] = $baseValue;
}
}
if ( !is_null( $substring ) ) {
// "Page" type property valeus are stored differently
// in the DB, i.e. underlines instead of spaces.
$conditions[] = SFUtils::getSQLConditionForAutocompleteInColumn( $valueField, $substring, $propertyHasTypePage );
}
$sqlOptions['ORDER BY'] = $valueField;
$res = $db->select( $fromClause, "DISTINCT $valueField",
$conditions, __METHOD__, $sqlOptions );
while ( $row = $db->fetchRow( $res ) ) {
$values[] = str_replace( '_', ' ', $row[0] );
}
$db->freeResult( $res );
if ( $sfgCacheAutocompleteValues ) {
// Save to cache.
$cache->set( $cacheKey, $values, $sfgAutocompleteCacheTimeout );
}
return $values;
}
}
|
GitWeb