includes/api/ApiQuerySearch.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.8+
   4  *
   5  * Created on July 30, 2007
   6  *
   7  * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiQueryBase.php' );
  30 }
  31
  32 /**
  33  * Query module to perform full text search within wiki titles and content
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQuerySearch extends ApiQueryGeneratorBase {
  38
  39         public function __construct( $query, $moduleName ) {
  40                 parent::__construct( $query, $moduleName, 'sr' );
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator( $resultPageSet ) {
  48                 $this->run( $resultPageSet );
  49         }
  50
  51         private function run( $resultPageSet = null ) {
  52                 global $wgContLang;
  53                 $params = $this->extractRequestParams();
  54
  55                 // Extract parameters
  56                 $limit = $params['limit'];
  57                 $query = $params['search'];
  58                 $what = $params['what'];
  59                 $searchInfo = array_flip( $params['info'] );
  60                 $prop = array_flip( $params['prop'] );
  61
  62                 // Create search engine instance and set options
  63                 $search = SearchEngine::create();
  64                 $search->setLimitOffset( $limit + 1, $params['offset'] );
  65                 $search->setNamespaces( $params['namespace'] );
  66                 $search->showRedirects = $params['redirects'];
  67
  68                 // Perform the actual search
  69                 if ( $what == 'text' ) {
  70                         $matches = $search->searchText( $query );
  71                 } elseif ( $what == 'title' ) {
  72                         $matches = $search->searchTitle( $query );
  73                 } elseif ( $what == 'nearmatch' ) {
  74                         $matches = SearchEngine::getNearMatchResultSet( $query );
  75                 } else {
  76                         // We default to title searches; this is a terrible legacy
  77                         // of the way we initially set up the MySQL fulltext-based
  78                         // search engine with separate title and text fields.
  79                         // In the future, the default should be for a combined index.
  80                         $what = 'title';
  81                         $matches = $search->searchTitle( $query );
  82
  83                         // Not all search engines support a separate title search,
  84                         // for instance the Lucene-based engine we use on Wikipedia.
  85                         // In this case, fall back to full-text search (which will
  86                         // include titles in it!)
  87                         if ( is_null( $matches ) ) {
  88                                 $what = 'text';
  89                                 $matches = $search->searchText( $query );
  90                         }
  91                 }
  92                 if ( is_null( $matches ) ) {
  93                         $this->dieUsage( "{$what} search is disabled", "search-{$what}-disabled" );
  94                 }
  95
  96                 // Add search meta data to result
  97                 if ( isset( $searchInfo['totalhits'] ) ) {
  98                         $totalhits = $matches->getTotalHits();
  99                         if ( $totalhits !== null ) {
 100                                 $this->getResult()->addValue( array( 'query', 'searchinfo' ),
 101                                                 'totalhits', $totalhits );
 102                         }
 103                 }
 104                 if ( isset( $searchInfo['suggestion'] ) && $matches->hasSuggestion() ) {
 105                         $this->getResult()->addValue( array( 'query', 'searchinfo' ),
 106                                                 'suggestion', $matches->getSuggestionQuery() );
 107                 }
 108
 109                 // Add the search results to the result
 110                 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
 111                 $titles = array();
 112                 $count = 0;
 113                 while ( $result = $matches->next() ) {
 114                         if ( ++ $count > $limit ) {
 115                                 // We've reached the one extra which shows that there are additional items to be had. Stop here...
 116                                 $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
 117                                 break;
 118                         }
 119
 120                         // Silently skip broken and missing titles
 121                         if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
 122                                 continue;
 123                         }
 124
 125                         $title = $result->getTitle();
 126                         if ( is_null( $resultPageSet ) ) {
 127                                 $vals = array();
 128                                 ApiQueryBase::addTitleInfo( $vals, $title );
 129
 130                                 if ( isset( $prop['snippet'] ) ) {
 131                                         $vals['snippet'] = $result->getTextSnippet( $terms );
 132                                 }
 133                                 if ( isset( $prop['size'] ) ) {
 134                                         $vals['size'] = $result->getByteSize();
 135                                 }
 136                                 if ( isset( $prop['wordcount'] ) ) {
 137                                         $vals['wordcount'] = $result->getWordCount();
 138                                 }
 139                                 if ( isset( $prop['timestamp'] ) ) {
 140                                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $result->getTimestamp() );
 141                                 }
 142                                 if ( !is_null( $result->getScore() ) ) {
 143                                         if ( isset( $prop['score'] ) ) {
 144                                                 $vals['score'] = $result->getScore();
 145                                         }
 146                                 }
 147                                 if ( isset( $prop['titlesnippet'] ) ) {
 148                                         $vals['titlesnippet'] = $result->getTitleSnippet( $terms );
 149                                 }
 150                                 if ( !is_null( $result->getRedirectTitle() ) ) {
 151                                         if ( isset( $prop['redirecttitle'] ) ) {
 152                                                 $vals['redirecttitle'] = $result->getRedirectTitle();
 153                                         }
 154                                         if ( isset( $prop['redirectsnippet'] ) ) {
 155                                                 $vals['redirectsnippet'] = $result->getRedirectSnippet( $terms );
 156                                         }
 157                                 }
 158                                 if ( !is_null( $result->getSectionTitle() ) ) {
 159                                         if ( isset( $prop['sectiontitle'] ) ) {
 160                                                 $vals['sectiontitle'] = $result->getSectionTitle();
 161                                         }
 162                                         if ( isset( $prop['sectionsnippet'] ) ) {
 163                                                 $vals['sectionsnippet'] = $result->getSectionSnippet();
 164                                         }
 165                                 }
 166                                 if ( isset( $prop['hasrelated'] ) ) {
 167                                         if ( $result->hasRelated() ) {
 168                                                 $vals['hasrelated'] = "";
 169                                         }
 170                                 }
 171
 172                                 // Add item to results and see whether it fits
 173                                 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ),
 174                                                 null, $vals );
 175                                 if ( !$fit ) {
 176                                         $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
 177                                         break;
 178                                 }
 179                         } else {
 180                                 $titles[] = $title;
 181                         }
 182                 }
 183
 184                 if ( is_null( $resultPageSet ) ) {
 185                         $this->getResult()->setIndexedTagName_internal( array(
 186                                                 'query', $this->getModuleName()
 187                                         ), 'p' );
 188                 } else {
 189                         $resultPageSet->populateFromTitles( $titles );
 190                 }
 191         }
 192
 193         public function getCacheMode( $params ) {
 194                 return 'public';
 195         }
 196
 197         public function getAllowedParams() {
 198                 return array(
 199                         'search' => array(
 200                                 ApiBase::PARAM_TYPE => 'string',
 201                                 ApiBase::PARAM_REQUIRED => true
 202                         ),
 203                         'namespace' => array(
 204                                 ApiBase::PARAM_DFLT => 0,
 205                                 ApiBase::PARAM_TYPE => 'namespace',
 206                                 ApiBase::PARAM_ISMULTI => true,
 207                         ),
 208                         'what' => array(
 209                                 ApiBase::PARAM_DFLT => null,
 210                                 ApiBase::PARAM_TYPE => array(
 211                                         'title',
 212                                         'text',
 213                                         'nearmatch',
 214                                 )
 215                         ),
 216                         'info' => array(
 217                                 ApiBase::PARAM_DFLT => 'totalhits|suggestion',
 218                                 ApiBase::PARAM_TYPE => array(
 219                                         'totalhits',
 220                                         'suggestion',
 221                                 ),
 222                                 ApiBase::PARAM_ISMULTI => true,
 223                         ),
 224                         'prop' => array(
 225                                 ApiBase::PARAM_DFLT => 'size|wordcount|timestamp|snippet',
 226                                 ApiBase::PARAM_TYPE => array(
 227                                         'size',
 228                                         'wordcount',
 229                                         'timestamp',
 230                                         'score',
 231                                         'snippet',
 232                                         'titlesnippet',
 233                                         'redirecttitle',
 234                                         'redirectsnippet',
 235                                         'sectiontitle',
 236                                         'sectionsnippet',
 237                                         'hasrelated',
 238                                 ),
 239                                 ApiBase::PARAM_ISMULTI => true,
 240                         ),
 241                         'redirects' => false,
 242                         'offset' => 0,
 243                         'limit' => array(
 244                                 ApiBase::PARAM_DFLT => 10,
 245                                 ApiBase::PARAM_TYPE => 'limit',
 246                                 ApiBase::PARAM_MIN => 1,
 247                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_SML1,
 248                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_SML2
 249                         )
 250                 );
 251         }
 252
 253         public function getParamDescription() {
 254                 return array(
 255                         'search' => 'Search for all page titles (or content) that has this value',
 256                         'namespace' => 'The namespace(s) to enumerate',
 257                         'what' => 'Search inside the text or titles',
 258                         'info' => 'What metadata to return',
 259                         'prop' => array(
 260                                 'What properties to return',
 261                                 ' size             - Adds the size of the page in bytes',
 262                                 ' wordcount        - Adds the word count of the page',
 263                                 ' timestamp        - Adds the timestamp of when the page was last edited',
 264                                 ' score            - Adds the score (if any) from the search engine',
 265                                 ' snippet          - Adds a parsed snippet of the page',
 266                                 ' titlesnippet     - Adds a parsed snippet of the page title',
 267                                 ' redirectsnippet  - Adds a parsed snippet of the redirect',
 268                                 ' redirecttitle    - Adds a parsed snippet of the redirect title',
 269                                 ' sectionsnippet   - Adds a parsed snippet of the matching section',
 270                                 ' sectiontitle     - Adds a parsed snippet of the matching section title',
 271                                 ' hasrelated       - Indicates whether a related search is available',
 272                         ),
 273                         'redirects' => 'Include redirect pages in the search',
 274                         'offset' => 'Use this value to continue paging (return by query)',
 275                         'limit' => 'How many total pages to return'
 276                 );
 277         }
 278
 279         public function getDescription() {
 280                 return 'Perform a full text search';
 281         }
 282
 283         public function getPossibleErrors() {
 284                 return array_merge( parent::getPossibleErrors(), array(
 285                         array( 'code' => 'search-text-disabled', 'info' => 'text search is disabled' ),
 286                         array( 'code' => 'search-title-disabled', 'info' => 'title search is disabled' ),
 287                 ) );
 288         }
 289
 290         protected function getExamples() {
 291                 return array(
 292                         'api.php?action=query&list=search&srsearch=meaning',
 293                         'api.php?action=query&list=search&srwhat=text&srsearch=meaning',
 294                         'api.php?action=query&generator=search&gsrsearch=meaning&prop=info',
 295                 );
 296         }
 297
 298         public function getVersion() {
 299                 return __CLASS__ . ': $Id$';
 300         }
 301 }