3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
4 * Copyright © 2008 Brion Vibber <brion@wikimedia.org>
5 * Copyright © 2014 Wikimedia Foundation and contributors
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.
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.
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
25 use MediaWiki\MediaWikiServices
;
30 class ApiOpenSearch
extends ApiBase
{
33 private $format = null;
36 /** @var array list of api allowed params */
37 private $allowedParams = null;
40 * Get the output format
44 protected function getFormat() {
45 if ( $this->format
=== null ) {
46 $params = $this->extractRequestParams();
47 $format = $params['format'];
49 $allowedParams = $this->getAllowedParams();
50 if ( !in_array( $format, $allowedParams['format'][ApiBase
::PARAM_TYPE
] ) ) {
51 $format = $allowedParams['format'][ApiBase
::PARAM_DFLT
];
54 if ( substr( $format, -2 ) === 'fm' ) {
55 $this->format
= substr( $format, 0, -2 );
58 $this->format
= $format;
65 public function getCustomPrinter() {
66 switch ( $this->getFormat() ) {
68 return new ApiOpenSearchFormatJson(
69 $this->getMain(), $this->fm
, $this->getParameter( 'warningsaserror' )
73 $printer = $this->getMain()->createPrinterByName( 'xml' . $this->fm
);
74 $printer->setRootElement( 'SearchSuggestion' );
78 ApiBase
::dieDebug( __METHOD__
, "Unsupported format '{$this->getFormat()}'" );
82 public function execute() {
83 $params = $this->extractRequestParams();
84 $search = $params['search'];
85 $suggest = $params['suggest'];
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 );
93 // Allow hooks to populate extracts and images
94 Hooks
::run( 'ApiOpenSearchSuggest', [ &$results ] );
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 );
105 // Populate result object
106 $this->populateResult( $search, $results );
111 * @param string $search the search query
112 * @param array $params api request params
113 * @return array search results. Keys are integers.
115 private function search( $search, array $params ) {
116 $searchEngine = $this->buildSearchEngine( $params );
117 $titles = $searchEngine->extractTitles( $searchEngine->completionSearchWithVariants( $search ) );
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;
129 if ( $params['redirects'] === null ) {
130 // Backwards compatibility, don't resolve for JSON.
131 $resolveRedir = $this->getFormat() !== 'json';
133 $resolveRedir = $params['redirects'] === 'resolve';
136 if ( $resolveRedir ) {
137 // Query for redirects
139 $lb = new LinkBatch( $titles );
140 if ( !$lb->isEmpty() ) {
141 $db = $this->getDB();
143 [ 'page', 'redirect' ],
144 [ 'page_namespace', 'page_title', 'rd_namespace', 'rd_title' ],
147 'rd_interwiki IS NULL OR rd_interwiki = ' . $db->addQuotes( '' ),
148 $lb->constructSet( 'page', $db ),
152 foreach ( $res as $row ) {
153 $redirects[$row->page_namespace
][$row->page_title
] =
154 [ $row->rd_namespace
, $row->rd_title
];
158 // Bypass any redirects
160 foreach ( $titles as $title ) {
161 $ns = $title->getNamespace();
162 $dbkey = $title->getDBkey();
164 if ( isset( $redirects[$ns][$dbkey] ) ) {
165 list( $ns, $dbkey ) = $redirects[$ns][$dbkey];
167 $title = Title
::makeTitle( $ns, $dbkey );
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;
176 $results[$resultId] = [
178 'redirect from' => $from,
180 'extract trimmed' => false,
182 'url' => wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
),
187 foreach ( $titles as $title ) {
188 $resultId = $title->getArticleID();
189 if ( $resultId === 0 ) {
190 $resultId = $nextSpecialPageId;
191 $nextSpecialPageId -= 1;
193 $results[$resultId] = [
195 'redirect from' => null,
197 'extract trimmed' => false,
199 'url' => wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
),
208 * @param string $search
209 * @param array &$results
211 protected function populateResult( $search, &$results ) {
212 $result = $this->getResult();
214 switch ( $this->getFormat() ) {
216 // http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1
217 $result->addArrayType( null, 'array' );
218 $result->addValue( null, 0, strval( $search ) );
222 foreach ( $results as $r ) {
223 $terms[] = $r['title']->getPrefixedText();
224 $descriptions[] = strval( $r['extract'] );
227 $result->addValue( null, 1, $terms );
228 $result->addValue( null, 2, $descriptions );
229 $result->addValue( null, 3, $urls );
233 // https://msdn.microsoft.com/en-us/library/cc891508(v=vs.85).aspx
242 foreach ( $results as $r ) {
244 'Text' => $r['title']->getPrefixedText(),
247 if ( is_string( $r['extract'] ) && $r['extract'] !== '' ) {
248 $item['Description'] = $r['extract'];
250 if ( is_array( $r['image'] ) && isset( $r['image']['source'] ) ) {
251 $item['Image'] = array_intersect_key( $r['image'], $imageKeys );
253 ApiResult
::setSubelementsList( $item, array_keys( $item ) );
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 );
265 ApiBase
::dieDebug( __METHOD__
, "Unsupported format '{$this->getFormat()}'" );
269 public function getAllowedParams() {
270 if ( $this->allowedParams
!== null ) {
271 return $this->allowedParams
;
273 $this->allowedParams
= $this->buildCommonApiParams( false ) +
[
276 ApiBase
::PARAM_TYPE
=> [ 'return', 'resolve' ],
279 ApiBase
::PARAM_DFLT
=> 'json',
280 ApiBase
::PARAM_TYPE
=> [ 'json', 'jsonfm', 'xml', 'xmlfm' ],
282 'warningsaserror' => false,
285 // Use open search specific default limit
286 $this->allowedParams
['limit'][ApiBase
::PARAM_DFLT
] = $this->getConfig()->get(
287 'OpenSearchDefaultLimit'
290 return $this->allowedParams
;
293 public function getSearchProfileParams() {
296 'profile-type' => SearchEngine
::COMPLETION_PROFILE_TYPE
,
297 'help-message' => 'apihelp-query+prefixsearch-param-profile'
302 protected function getExamplesMessages() {
304 'action=opensearch&search=Te'
305 => 'apihelp-opensearch-example-te',
309 public function getHelpUrls() {
310 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Opensearch';
314 * Trim an extract to a sensible length.
316 * Adapted from Extension:OpenSearchXml, which adapted it from
317 * Extension:ActiveAbstract.
319 * @param string $text
320 * @param int $length Target length; actual result will continue to the end of a sentence.
323 public static function trimExtract( $text, $length ) {
324 static $regex = null;
326 if ( $regex === null ) {
328 '([^\d])\.\s', '\!\s', '\?\s', // regular ASCII
329 '。', // full-width ideographic full-stop
330 '.', '!', '?', // double-width roman forms
331 '。', // half-width ideographic full stop
333 $endgroup = implode( '|', $endchars );
334 $end = "(?:$endgroup)";
335 $sentence = ".{{$length},}?$end+";
336 $regex = "/^($sentence)/u";
340 if ( preg_match( $regex, $text, $matches ) ) {
341 return trim( $matches[1] );
343 // Just return the first line
344 return trim( explode( "\n", $text )[0] );
349 * Fetch the template for a type.
351 * @param string $type MIME type
353 * @throws MWException
355 public static function getOpenSearchTemplate( $type ) {
356 $config = MediaWikiServices
::getInstance()->getSearchEngineConfig();
357 $template = $config->getConfig()->get( 'OpenSearchTemplate' );
359 if ( $template && $type === 'application/x-suggestions+json' ) {
363 $ns = implode( '|', $config->defaultNamespaces() );
369 case 'application/x-suggestions+json':
370 return $config->getConfig()->get( 'CanonicalServer' ) . wfScript( 'api' )
371 . '?action=opensearch&search={searchTerms}&namespace=' . $ns;
373 case 'application/x-suggestions+xml':
374 return $config->getConfig()->get( 'CanonicalServer' ) . wfScript( 'api' )
375 . '?action=opensearch&format=xml&search={searchTerms}&namespace=' . $ns;
378 throw new MWException( __METHOD__
. ": Unknown type '$type'" );
386 class ApiOpenSearchFormatJson
extends ApiFormatJson
{
387 private $warningsAsError = false;
389 public function __construct( ApiMain
$main, $fm, $warningsAsError ) {
390 parent
::__construct( $main, "json$fm" );
391 $this->warningsAsError
= $warningsAsError;
394 public function execute() {
395 $result = $this->getResult();
396 if ( !$result->getResultData( 'error' ) && !$result->getResultData( 'errors' ) ) {
397 // Ignore warnings or treat as errors, as requested
398 $warnings = $result->removeValue( 'warnings', null );
399 if ( $this->warningsAsError
&& $warnings ) {
401 'apierror-opensearch-json-warnings',
403 [ 'warnings' => $warnings ]
407 // Ignore any other unexpected keys (e.g. from $wgDebugToolbar)
408 $remove = array_keys( array_diff_key(
409 $result->getResultData(),
410 [ 0 => 'search', 1 => 'terms', 2 => 'descriptions', 3 => 'urls' ]
412 foreach ( $remove as $key ) {
413 $result->removeValue( $key, null );