4 * Created on July 30, 2007
6 * API for MediaWiki 1.8+
8 * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
32 * Query module to perform full text search within wiki titles and content
36 class ApiQuerySearch
extends ApiQueryGeneratorBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'sr' );
42 public function execute() {
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 private function run( $resultPageSet = null ) {
52 $params = $this->extractRequestParams();
55 $limit = $params['limit'];
56 $query = $params['search'];
57 $what = $params['what'];
58 $searchInfo = array_flip( $params['info'] );
59 $prop = array_flip( $params['prop'] );
61 if ( strval( $query ) === '' ) {
62 $this->dieUsage( 'empty search string is not allowed', 'param-search' );
65 // Create search engine instance and set options
66 $search = SearchEngine
::create();
67 $search->setLimitOffset( $limit +
1, $params['offset'] );
68 $search->setNamespaces( $params['namespace'] );
69 $search->showRedirects
= $params['redirects'];
71 // Perform the actual search
72 if ( $what == 'text' ) {
73 $matches = $search->searchText( $query );
74 } elseif ( $what == 'title' ) {
75 $matches = $search->searchTitle( $query );
77 // We default to title searches; this is a terrible legacy
78 // of the way we initially set up the MySQL fulltext-based
79 // search engine with separate title and text fields.
80 // In the future, the default should be for a combined index.
82 $matches = $search->searchTitle( $query );
84 // Not all search engines support a separate title search,
85 // for instance the Lucene-based engine we use on Wikipedia.
86 // In this case, fall back to full-text search (which will
87 // include titles in it!)
88 if ( is_null( $matches ) ) {
90 $matches = $search->searchText( $query );
93 if ( is_null( $matches ) ) {
94 $this->dieUsage( "{$what} search is disabled", "search-{$what}-disabled" );
97 // Add search meta data to result
98 if ( isset( $searchInfo['totalhits'] ) ) {
99 $totalhits = $matches->getTotalHits();
100 if ( $totalhits !== null ) {
101 $this->getResult()->addValue( array( 'query', 'searchinfo' ),
102 'totalhits', $totalhits );
105 if ( isset( $searchInfo['suggestion'] ) && $matches->hasSuggestion() ) {
106 $this->getResult()->addValue( array( 'query', 'searchinfo' ),
107 'suggestion', $matches->getSuggestionQuery() );
110 // Add the search results to the result
111 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
114 while ( $result = $matches->next() ) {
115 if ( ++
$count > $limit ) {
116 // We've reached the one extra which shows that there are additional items to be had. Stop here...
117 $this->setContinueEnumParameter( 'offset', $params['offset'] +
$params['limit'] );
121 // Silently skip broken and missing titles
122 if ( $result->isBrokenTitle() ||
$result->isMissingRevision() ) {
126 $title = $result->getTitle();
127 if ( is_null( $resultPageSet ) ) {
129 ApiQueryBase
::addTitleInfo( $vals, $title );
131 if ( isset( $prop['snippet'] ) ) {
132 $vals['snippet'] = $result->getTextSnippet( $terms );
134 if ( isset( $prop['size'] ) ) {
135 $vals['size'] = $result->getByteSize();
137 if ( isset( $prop['wordcount'] ) ) {
138 $vals['wordcount'] = $result->getWordCount();
140 if ( isset( $prop['timestamp'] ) ) {
141 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $result->getTimestamp() );
144 // Add item to results and see whether it fits
145 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ),
148 $this->setContinueEnumParameter( 'offset', $params['offset'] +
$count - 1 );
156 if ( is_null( $resultPageSet ) ) {
157 $this->getResult()->setIndexedTagName_internal( array(
158 'query', $this->getModuleName()
161 $resultPageSet->populateFromTitles( $titles );
165 public function getAllowedParams() {
168 'namespace' => array(
169 ApiBase
::PARAM_DFLT
=> 0,
170 ApiBase
::PARAM_TYPE
=> 'namespace',
171 ApiBase
::PARAM_ISMULTI
=> true,
174 ApiBase
::PARAM_DFLT
=> null,
175 ApiBase
::PARAM_TYPE
=> array(
181 ApiBase
::PARAM_DFLT
=> 'totalhits|suggestion',
182 ApiBase
::PARAM_TYPE
=> array(
186 ApiBase
::PARAM_ISMULTI
=> true,
189 ApiBase
::PARAM_DFLT
=> 'size|wordcount|timestamp|snippet',
190 ApiBase
::PARAM_TYPE
=> array(
196 ApiBase
::PARAM_ISMULTI
=> true,
198 'redirects' => false,
201 ApiBase
::PARAM_DFLT
=> 10,
202 ApiBase
::PARAM_TYPE
=> 'limit',
203 ApiBase
::PARAM_MIN
=> 1,
204 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_SML1
,
205 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_SML2
210 public function getParamDescription() {
212 'search' => 'Search for all page titles (or content) that has this value.',
213 'namespace' => 'The namespace(s) to enumerate.',
214 'what' => 'Search inside the text or titles.',
215 'info' => 'What metadata to return.',
216 'prop' => 'What properties to return.',
217 'redirects' => 'Include redirect pages in the search.',
218 'offset' => 'Use this value to continue paging (return by query)',
219 'limit' => 'How many total pages to return.'
223 public function getDescription() {
224 return 'Perform a full text search';
227 public function getPossibleErrors() {
228 return array_merge( parent
::getPossibleErrors(), array(
229 array( 'code' => 'param-search', 'info' => 'empty search string is not allowed' ),
230 array( 'code' => 'search-text-disabled', 'info' => 'text search is disabled' ),
231 array( 'code' => 'search-title-disabled', 'info' => 'title search is disabled' ),
235 protected function getExamples() {
237 'api.php?action=query&list=search&srsearch=meaning',
238 'api.php?action=query&list=search&srwhat=text&srsearch=meaning',
239 'api.php?action=query&generator=search&gsrsearch=meaning&prop=info',
243 public function getVersion() {
244 return __CLASS__
. ': $Id$';