Fix a couple of Generic.Files.OneObjectStructurePerFile.MultipleFound in api
[lhc/web/wiklou.git] / includes / api / ApiOpenSearch.php
1 <?php
2 /**
3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
4 * Copyright © 2008 Brion Vibber <brion@wikimedia.org>
5 * Copyright © 2014 Wikimedia Foundation and contributors
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
21 *
22 * @file
23 */
24
25 use MediaWiki\MediaWikiServices;
26
27 /**
28 * @ingroup API
29 */
30 class ApiOpenSearch extends ApiBase {
31 use SearchApi;
32
33 private $format = null;
34 private $fm = null;
35
36 /** @var array list of api allowed params */
37 private $allowedParams = null;
38
39 /**
40 * Get the output format
41 *
42 * @return string
43 */
44 protected function getFormat() {
45 if ( $this->format === null ) {
46 $params = $this->extractRequestParams();
47 $format = $params['format'];
48
49 $allowedParams = $this->getAllowedParams();
50 if ( !in_array( $format, $allowedParams['format'][ApiBase::PARAM_TYPE] ) ) {
51 $format = $allowedParams['format'][ApiBase::PARAM_DFLT];
52 }
53
54 if ( substr( $format, -2 ) === 'fm' ) {
55 $this->format = substr( $format, 0, -2 );
56 $this->fm = 'fm';
57 } else {
58 $this->format = $format;
59 $this->fm = '';
60 }
61 }
62 return $this->format;
63 }
64
65 public function getCustomPrinter() {
66 switch ( $this->getFormat() ) {
67 case 'json':
68 return new ApiOpenSearchFormatJson(
69 $this->getMain(), $this->fm, $this->getParameter( 'warningsaserror' )
70 );
71
72 case 'xml':
73 $printer = $this->getMain()->createPrinterByName( 'xml' . $this->fm );
74 $printer->setRootElement( 'SearchSuggestion' );
75 return $printer;
76
77 default:
78 ApiBase::dieDebug( __METHOD__, "Unsupported format '{$this->getFormat()}'" );
79 }
80 }
81
82 public function execute() {
83 $params = $this->extractRequestParams();
84 $search = $params['search'];
85 $suggest = $params['suggest'];
86 $results = [];
87 if ( !$suggest || $this->getConfig()->get( 'EnableOpenSearchSuggest' ) ) {
88 // Open search results may be stored for a very long time
89 $this->getMain()->setCacheMaxAge( $this->getConfig()->get( 'SearchSuggestCacheExpiry' ) );
90 $this->getMain()->setCacheMode( 'public' );
91 $results = $this->search( $search, $params );
92
93 // Allow hooks to populate extracts and images
94 Hooks::run( 'ApiOpenSearchSuggest', [ &$results ] );
95
96 // Trim extracts, if necessary
97 $length = $this->getConfig()->get( 'OpenSearchDescriptionLength' );
98 foreach ( $results as &$r ) {
99 if ( is_string( $r['extract'] ) && !$r['extract trimmed'] ) {
100 $r['extract'] = self::trimExtract( $r['extract'], $length );
101 }
102 }
103 }
104
105 // Populate result object
106 $this->populateResult( $search, $results );
107 }
108
109 /**
110 * Perform the search
111 * @param string $search the search query
112 * @param array $params api request params
113 * @return array search results. Keys are integers.
114 */
115 private function search( $search, array $params ) {
116 $searchEngine = $this->buildSearchEngine( $params );
117 $titles = $searchEngine->extractTitles( $searchEngine->completionSearchWithVariants( $search ) );
118 $results = [];
119
120 if ( !$titles ) {
121 return $results;
122 }
123
124 // Special pages need unique integer ids in the return list, so we just
125 // assign them negative numbers because those won't clash with the
126 // always positive articleIds that non-special pages get.
127 $nextSpecialPageId = -1;
128
129 if ( $params['redirects'] === null ) {
130 // Backwards compatibility, don't resolve for JSON.
131 $resolveRedir = $this->getFormat() !== 'json';
132 } else {
133 $resolveRedir = $params['redirects'] === 'resolve';
134 }
135
136 if ( $resolveRedir ) {
137 // Query for redirects
138 $redirects = [];
139 $lb = new LinkBatch( $titles );
140 if ( !$lb->isEmpty() ) {
141 $db = $this->getDB();
142 $res = $db->select(
143 [ 'page', 'redirect' ],
144 [ 'page_namespace', 'page_title', 'rd_namespace', 'rd_title' ],
145 [
146 'rd_from = page_id',
147 'rd_interwiki IS NULL OR rd_interwiki = ' . $db->addQuotes( '' ),
148 $lb->constructSet( 'page', $db ),
149 ],
150 __METHOD__
151 );
152 foreach ( $res as $row ) {
153 $redirects[$row->page_namespace][$row->page_title] =
154 [ $row->rd_namespace, $row->rd_title ];
155 }
156 }
157
158 // Bypass any redirects
159 $seen = [];
160 foreach ( $titles as $title ) {
161 $ns = $title->getNamespace();
162 $dbkey = $title->getDBkey();
163 $from = null;
164 if ( isset( $redirects[$ns][$dbkey] ) ) {
165 list( $ns, $dbkey ) = $redirects[$ns][$dbkey];
166 $from = $title;
167 $title = Title::makeTitle( $ns, $dbkey );
168 }
169 if ( !isset( $seen[$ns][$dbkey] ) ) {
170 $seen[$ns][$dbkey] = true;
171 $resultId = $title->getArticleID();
172 if ( $resultId === 0 ) {
173 $resultId = $nextSpecialPageId;
174 $nextSpecialPageId -= 1;
175 }
176 $results[$resultId] = [
177 'title' => $title,
178 'redirect from' => $from,
179 'extract' => false,
180 'extract trimmed' => false,
181 'image' => false,
182 'url' => wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ),
183 ];
184 }
185 }
186 } else {
187 foreach ( $titles as $title ) {
188 $resultId = $title->getArticleID();
189 if ( $resultId === 0 ) {
190 $resultId = $nextSpecialPageId;
191 $nextSpecialPageId -= 1;
192 }
193 $results[$resultId] = [
194 'title' => $title,
195 'redirect from' => null,
196 'extract' => false,
197 'extract trimmed' => false,
198 'image' => false,
199 'url' => wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ),
200 ];
201 }
202 }
203
204 return $results;
205 }
206
207 /**
208 * @param string $search
209 * @param array &$results
210 */
211 protected function populateResult( $search, &$results ) {
212 $result = $this->getResult();
213
214 switch ( $this->getFormat() ) {
215 case 'json':
216 // http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1
217 $result->addArrayType( null, 'array' );
218 $result->addValue( null, 0, strval( $search ) );
219 $terms = [];
220 $descriptions = [];
221 $urls = [];
222 foreach ( $results as $r ) {
223 $terms[] = $r['title']->getPrefixedText();
224 $descriptions[] = strval( $r['extract'] );
225 $urls[] = $r['url'];
226 }
227 $result->addValue( null, 1, $terms );
228 $result->addValue( null, 2, $descriptions );
229 $result->addValue( null, 3, $urls );
230 break;
231
232 case 'xml':
233 // https://msdn.microsoft.com/en-us/library/cc891508(v=vs.85).aspx
234 $imageKeys = [
235 'source' => true,
236 'alt' => true,
237 'width' => true,
238 'height' => true,
239 'align' => true,
240 ];
241 $items = [];
242 foreach ( $results as $r ) {
243 $item = [
244 'Text' => $r['title']->getPrefixedText(),
245 'Url' => $r['url'],
246 ];
247 if ( is_string( $r['extract'] ) && $r['extract'] !== '' ) {
248 $item['Description'] = $r['extract'];
249 }
250 if ( is_array( $r['image'] ) && isset( $r['image']['source'] ) ) {
251 $item['Image'] = array_intersect_key( $r['image'], $imageKeys );
252 }
253 ApiResult::setSubelementsList( $item, array_keys( $item ) );
254 $items[] = $item;
255 }
256 ApiResult::setIndexedTagName( $items, 'Item' );
257 $result->addValue( null, 'version', '2.0' );
258 $result->addValue( null, 'xmlns', 'http://opensearch.org/searchsuggest2' );
259 $result->addValue( null, 'Query', strval( $search ) );
260 $result->addSubelementsList( null, 'Query' );
261 $result->addValue( null, 'Section', $items );
262 break;
263
264 default:
265 ApiBase::dieDebug( __METHOD__, "Unsupported format '{$this->getFormat()}'" );
266 }
267 }
268
269 public function getAllowedParams() {
270 if ( $this->allowedParams !== null ) {
271 return $this->allowedParams;
272 }
273 $this->allowedParams = $this->buildCommonApiParams( false ) + [
274 'suggest' => false,
275 'redirects' => [
276 ApiBase::PARAM_TYPE => [ 'return', 'resolve' ],
277 ],
278 'format' => [
279 ApiBase::PARAM_DFLT => 'json',
280 ApiBase::PARAM_TYPE => [ 'json', 'jsonfm', 'xml', 'xmlfm' ],
281 ],
282 'warningsaserror' => false,
283 ];
284
285 // Use open search specific default limit
286 $this->allowedParams['limit'][ApiBase::PARAM_DFLT] = $this->getConfig()->get(
287 'OpenSearchDefaultLimit'
288 );
289
290 return $this->allowedParams;
291 }
292
293 public function getSearchProfileParams() {
294 return [
295 'profile' => [
296 'profile-type' => SearchEngine::COMPLETION_PROFILE_TYPE,
297 'help-message' => 'apihelp-query+prefixsearch-param-profile'
298 ],
299 ];
300 }
301
302 protected function getExamplesMessages() {
303 return [
304 'action=opensearch&search=Te'
305 => 'apihelp-opensearch-example-te',
306 ];
307 }
308
309 public function getHelpUrls() {
310 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Opensearch';
311 }
312
313 /**
314 * Trim an extract to a sensible length.
315 *
316 * Adapted from Extension:OpenSearchXml, which adapted it from
317 * Extension:ActiveAbstract.
318 *
319 * @param string $text
320 * @param int $length Target length; actual result will continue to the end of a sentence.
321 * @return string
322 */
323 public static function trimExtract( $text, $length ) {
324 static $regex = null;
325
326 if ( $regex === null ) {
327 $endchars = [
328 '([^\d])\.\s', '\!\s', '\?\s', // regular ASCII
329 '。', // full-width ideographic full-stop
330 '.', '!', '?', // double-width roman forms
331 '。', // half-width ideographic full stop
332 ];
333 $endgroup = implode( '|', $endchars );
334 $end = "(?:$endgroup)";
335 $sentence = ".{{$length},}?$end+";
336 $regex = "/^($sentence)/u";
337 }
338
339 $matches = [];
340 if ( preg_match( $regex, $text, $matches ) ) {
341 return trim( $matches[1] );
342 } else {
343 // Just return the first line
344 return trim( explode( "\n", $text )[0] );
345 }
346 }
347
348 /**
349 * Fetch the template for a type.
350 *
351 * @param string $type MIME type
352 * @return string
353 * @throws MWException
354 */
355 public static function getOpenSearchTemplate( $type ) {
356 $config = MediaWikiServices::getInstance()->getSearchEngineConfig();
357 $template = $config->getConfig()->get( 'OpenSearchTemplate' );
358
359 if ( $template && $type === 'application/x-suggestions+json' ) {
360 return $template;
361 }
362
363 $ns = implode( '|', $config->defaultNamespaces() );
364 if ( !$ns ) {
365 $ns = '0';
366 }
367
368 switch ( $type ) {
369 case 'application/x-suggestions+json':
370 return $config->getConfig()->get( 'CanonicalServer' ) . wfScript( 'api' )
371 . '?action=opensearch&search={searchTerms}&namespace=' . $ns;
372
373 case 'application/x-suggestions+xml':
374 return $config->getConfig()->get( 'CanonicalServer' ) . wfScript( 'api' )
375 . '?action=opensearch&format=xml&search={searchTerms}&namespace=' . $ns;
376
377 default:
378 throw new MWException( __METHOD__ . ": Unknown type '$type'" );
379 }
380 }
381 }