af096568146f2adf2ad4747c83118595cb60306c
3 * Created on Oct 13, 2006
5 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
6 * Copyright © 2008 Brion Vibber <brion@wikimedia.org>
7 * Copyright © 2014 Brad Jorsch <bjorsch@wikimedia.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
30 class ApiOpenSearch
extends ApiBase
{
32 private $format = null;
36 * Get the output format
40 protected function getFormat() {
41 if ( $this->format
=== null ) {
42 $params = $this->extractRequestParams();
43 $format = $params['format'];
45 $allowedParams = $this->getAllowedParams();
46 if ( !in_array( $format, $allowedParams['format'][ApiBase
::PARAM_TYPE
] ) ) {
47 $format = $allowedParams['format'][ApiBase
::PARAM_DFLT
];
50 if ( substr( $format, -2 ) === 'fm' ) {
51 $this->format
= substr( $format, 0, -2 );
54 $this->format
= $format;
61 public function getCustomPrinter() {
62 switch ( $this->getFormat() ) {
64 return $this->getMain()->createPrinterByName( 'json' . $this->fm
);
67 $printer = $this->getMain()->createPrinterByName( 'xml' . $this->fm
);
68 $printer->setRootElement( 'SearchSuggestion' );
72 ApiBase
::dieDebug( __METHOD__
, "Unsupported format '{$this->getFormat()}'" );
76 public function execute() {
77 $params = $this->extractRequestParams();
78 $search = $params['search'];
79 $limit = $params['limit'];
80 $namespaces = $params['namespace'];
81 $suggest = $params['suggest'];
83 if ( $params['redirects'] === null ) {
84 // Backwards compatibility, don't resolve for JSON.
85 $resolveRedir = $this->getFormat() !== 'json';
87 $resolveRedir = $params['redirects'] === 'resolve';
92 if ( !$suggest ||
$this->getConfig()->get( 'EnableOpenSearchSuggest' ) ) {
93 // Open search results may be stored for a very long time
94 $this->getMain()->setCacheMaxAge( $this->getConfig()->get( 'SearchSuggestCacheExpiry' ) );
95 $this->getMain()->setCacheMode( 'public' );
96 $this->search( $search, $limit, $namespaces, $resolveRedir, $results );
98 // Allow hooks to populate extracts and images
99 Hooks
::run( 'ApiOpenSearchSuggest', array( &$results ) );
101 // Trim extracts, if necessary
102 $length = $this->getConfig()->get( 'OpenSearchDescriptionLength' );
103 foreach ( $results as &$r ) {
104 if ( is_string( $r['extract'] ) && !$r['extract trimmed'] ) {
105 $r['extract'] = self
::trimExtract( $r['extract'], $length );
110 // Populate result object
111 $this->populateResult( $search, $results );
117 * @param string $search Text to search
118 * @param int $limit Maximum items to return
119 * @param array $namespaces Namespaces to search
120 * @param bool $resolveRedir Whether to resolve redirects
121 * @param array &$results Put results here. Keys have to be integers.
123 protected function search( $search, $limit, $namespaces, $resolveRedir, &$results ) {
124 // Find matching titles as Title objects
125 $searcher = new TitlePrefixSearch
;
126 $titles = $searcher->searchWithVariants( $search, $limit, $namespaces );
131 // Special pages need unique integer ids in the return list, so we just
132 // assign them negative numbers because those won't clash with the
133 // always positive articleIds that non-special pages get.
134 $nextSpecialPageId = -1;
136 if ( $resolveRedir ) {
137 // Query for redirects
138 $db = $this->getDb();
139 $lb = new LinkBatch( $titles );
141 array( 'page', 'redirect' ),
142 array( 'page_namespace', 'page_title', 'rd_namespace', 'rd_title' ),
145 'rd_interwiki IS NULL OR rd_interwiki = ' . $db->addQuotes( '' ),
146 $lb->constructSet( 'page', $db ),
150 $redirects = array();
151 foreach ( $res as $row ) {
152 $redirects[$row->page_namespace
][$row->page_title
] =
153 array( $row->rd_namespace
, $row->rd_title
);
156 // Bypass any redirects
158 foreach ( $titles as $title ) {
159 $ns = $title->getNamespace();
160 $dbkey = $title->getDBkey();
162 if ( isset( $redirects[$ns][$dbkey] ) ) {
163 list( $ns, $dbkey ) = $redirects[$ns][$dbkey];
165 $title = Title
::makeTitle( $ns, $dbkey );
167 if ( !isset( $seen[$ns][$dbkey] ) ) {
168 $seen[$ns][$dbkey] = true;
169 $resultId = $title->getArticleId();
170 if ( $resultId === 0 ) {
171 $resultId = $nextSpecialPageId;
172 $nextSpecialPageId -= 1;
174 $results[$resultId] = array(
176 'redirect from' => $from,
178 'extract trimmed' => false,
180 'url' => wfExpandUrl( $title->getFullUrl(), PROTO_CURRENT
),
185 foreach ( $titles as $title ) {
186 $resultId = $title->getArticleId();
187 if ( $resultId === 0 ) {
188 $resultId = $nextSpecialPageId;
189 $nextSpecialPageId -= 1;
191 $results[$resultId] = array(
193 'redirect from' => null,
195 'extract trimmed' => false,
197 'url' => wfExpandUrl( $title->getFullUrl(), PROTO_CURRENT
),
204 * @param string $search
205 * @param array &$results
207 protected function populateResult( $search, &$results ) {
208 $result = $this->getResult();
210 switch ( $this->getFormat() ) {
212 // http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1
213 $result->addValue( null, 0, strval( $search ) );
215 $descriptions = array();
217 foreach ( $results as $r ) {
218 $terms[] = $r['title']->getPrefixedText();
219 $descriptions[] = strval( $r['extract'] );
222 $result->addValue( null, 1, $terms );
223 $result->addValue( null, 2, $descriptions );
224 $result->addValue( null, 3, $urls );
228 // http://msdn.microsoft.com/en-us/library/cc891508%28v=vs.85%29.aspx
237 foreach ( $results as $r ) {
239 $result->setContent( $item, $r['title']->getPrefixedText(), 'Text' );
240 $result->setContent( $item, $r['url'], 'Url' );
241 if ( is_string( $r['extract'] ) && $r['extract'] !== '' ) {
242 $result->setContent( $item, $r['extract'], 'Description' );
244 if ( is_array( $r['image'] ) && isset( $r['image']['source'] ) ) {
245 $item['Image'] = array_intersect_key( $r['image'], $imageKeys );
249 $result->setIndexedTagName( $items, 'Item' );
250 $result->addValue( null, 'version', '2.0' );
251 $result->addValue( null, 'xmlns', 'http://opensearch.org/searchsuggest2' );
253 $result->setContent( $query, strval( $search ) );
254 $result->addValue( null, 'Query', $query );
255 $result->addValue( null, 'Section', $items );
259 ApiBase
::dieDebug( __METHOD__
, "Unsupported format '{$this->getFormat()}'" );
263 public function getAllowedParams() {
267 ApiBase
::PARAM_DFLT
=> $this->getConfig()->get( 'OpenSearchDefaultLimit' ),
268 ApiBase
::PARAM_TYPE
=> 'limit',
269 ApiBase
::PARAM_MIN
=> 1,
270 ApiBase
::PARAM_MAX
=> 100,
271 ApiBase
::PARAM_MAX2
=> 100
273 'namespace' => array(
274 ApiBase
::PARAM_DFLT
=> NS_MAIN
,
275 ApiBase
::PARAM_TYPE
=> 'namespace',
276 ApiBase
::PARAM_ISMULTI
=> true
279 'redirects' => array(
280 ApiBase
::PARAM_TYPE
=> array( 'return', 'resolve' ),
283 ApiBase
::PARAM_DFLT
=> 'json',
284 ApiBase
::PARAM_TYPE
=> array( 'json', 'jsonfm', 'xml', 'xmlfm' ),
289 protected function getExamplesMessages() {
291 'action=opensearch&search=Te'
292 => 'apihelp-opensearch-example-te',
296 public function getHelpUrls() {
297 return 'https://www.mediawiki.org/wiki/API:Opensearch';
301 * Trim an extract to a sensible length.
303 * Adapted from Extension:OpenSearchXml, which adapted it from
304 * Extension:ActiveAbstract.
306 * @param string $text
307 * @param int $len Target length; actual result will continue to the end of a sentence.
310 public static function trimExtract( $text, $length ) {
311 static $regex = null;
313 if ( $regex === null ) {
315 '([^\d])\.\s', '\!\s', '\?\s', // regular ASCII
316 '。', // full-width ideographic full-stop
317 '.', '!', '?', // double-width roman forms
318 '。', // half-width ideographic full stop
320 $endgroup = implode( '|', $endchars );
321 $end = "(?:$endgroup)";
322 $sentence = ".{{$length},}?$end+";
323 $regex = "/^($sentence)/u";
327 if ( preg_match( $regex, $text, $matches ) ) {
328 return trim( $matches[1] );
330 // Just return the first line
331 $lines = explode( "\n", $text );
332 return trim( $lines[0] );
337 * Fetch the template for a type.
339 * @param string $type MIME type
342 public static function getOpenSearchTemplate( $type ) {
343 global $wgOpenSearchTemplate, $wgCanonicalServer;
345 if ( $wgOpenSearchTemplate && $type === 'application/x-suggestions+json' ) {
346 return $wgOpenSearchTemplate;
349 $ns = implode( '|', SearchEngine
::defaultNamespaces() );
355 case 'application/x-suggestions+json':
356 return $wgCanonicalServer . wfScript( 'api' )
357 . '?action=opensearch&search={searchTerms}&namespace=' . $ns;
359 case 'application/x-suggestions+xml':
360 return $wgCanonicalServer . wfScript( 'api' )
361 . '?action=opensearch&format=xml&search={searchTerms}&namespace=' . $ns;
364 throw new MWException( __METHOD__
. ": Unknown type '$type'" );