From 9db190c7e736ec8d063187d4241b59feaf7dc2d1 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 22 Jun 2011 11:28:20 +0200 Subject: update to MediaWiki 1.17.0 --- includes/api/ApiQuerySearch.php | 166 ++++++++++++++++++++++++++-------------- 1 file changed, 110 insertions(+), 56 deletions(-) (limited to 'includes/api/ApiQuerySearch.php') diff --git a/includes/api/ApiQuerySearch.php b/includes/api/ApiQuerySearch.php index 4e032321..3cf693af 100644 --- a/includes/api/ApiQuerySearch.php +++ b/includes/api/ApiQuerySearch.php @@ -1,11 +1,10 @@ @gmail.com + * Created on July 30, 2007 + * + * Copyright © 2007 Yuri Astrakhan @gmail.com * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,13 +18,15 @@ * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html + * + * @file */ if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ( 'ApiQueryBase.php' ); + require_once( 'ApiQueryBase.php' ); } /** @@ -36,7 +37,7 @@ if ( !defined( 'MEDIAWIKI' ) ) { class ApiQuerySearch extends ApiQueryGeneratorBase { public function __construct( $query, $moduleName ) { - parent :: __construct( $query, $moduleName, 'sr' ); + parent::__construct( $query, $moduleName, 'sr' ); } public function execute() { @@ -57,9 +58,6 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { $what = $params['what']; $searchInfo = array_flip( $params['info'] ); $prop = array_flip( $params['prop'] ); - - if ( strval( $query ) === '' ) - $this->dieUsage( "empty search string is not allowed", 'param-search' ); // Create search engine instance and set options $search = SearchEngine::create(); @@ -72,6 +70,8 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { $matches = $search->searchText( $query ); } elseif ( $what == 'title' ) { $matches = $search->searchTitle( $query ); + } elseif ( $what == 'nearmatch' ) { + $matches = SearchEngine::getNearMatchResultSet( $query ); } else { // We default to title searches; this is a terrible legacy // of the way we initially set up the MySQL fulltext-based @@ -79,7 +79,7 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { // In the future, the default should be for a combined index. $what = 'title'; $matches = $search->searchTitle( $query ); - + // Not all search engines support a separate title search, // for instance the Lucene-based engine we use on Wikipedia. // In this case, fall back to full-text search (which will @@ -89,9 +89,10 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { $matches = $search->searchText( $query ); } } - if ( is_null( $matches ) ) + if ( is_null( $matches ) ) { $this->dieUsage( "{$what} search is disabled", "search-{$what}-disabled" ); - + } + // Add search meta data to result if ( isset( $searchInfo['totalhits'] ) ) { $totalhits = $matches->getTotalHits(); @@ -107,7 +108,7 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { // Add the search results to the result $terms = $wgContLang->convertForSearchResult( $matches->termMatches() ); - $titles = array (); + $titles = array(); $count = 0; while ( $result = $matches->next() ) { if ( ++ $count > $limit ) { @@ -117,23 +118,53 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { } // Silently skip broken and missing titles - if ( $result->isBrokenTitle() || $result->isMissingRevision() ) + if ( $result->isBrokenTitle() || $result->isMissingRevision() ) { continue; - + } + $title = $result->getTitle(); if ( is_null( $resultPageSet ) ) { $vals = array(); ApiQueryBase::addTitleInfo( $vals, $title ); - - if ( isset( $prop['snippet'] ) ) + + if ( isset( $prop['snippet'] ) ) { $vals['snippet'] = $result->getTextSnippet( $terms ); - if ( isset( $prop['size'] ) ) + } + if ( isset( $prop['size'] ) ) { $vals['size'] = $result->getByteSize(); - if ( isset( $prop['wordcount'] ) ) + } + if ( isset( $prop['wordcount'] ) ) { $vals['wordcount'] = $result->getWordCount(); - if ( isset( $prop['timestamp'] ) ) + } + if ( isset( $prop['timestamp'] ) ) { $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $result->getTimestamp() ); - + } + if ( !is_null( $result->getScore() ) && isset( $prop['score'] ) ) { + $vals['score'] = $result->getScore(); + } + if ( isset( $prop['titlesnippet'] ) ) { + $vals['titlesnippet'] = $result->getTitleSnippet( $terms ); + } + if ( !is_null( $result->getRedirectTitle() ) ) { + if ( isset( $prop['redirecttitle'] ) ) { + $vals['redirecttitle'] = $result->getRedirectTitle(); + } + if ( isset( $prop['redirectsnippet'] ) ) { + $vals['redirectsnippet'] = $result->getRedirectSnippet( $terms ); + } + } + if ( !is_null( $result->getSectionTitle() ) ) { + if ( isset( $prop['sectiontitle'] ) ) { + $vals['sectiontitle'] = $result->getSectionTitle(); + } + if ( isset( $prop['sectionsnippet'] ) ) { + $vals['sectionsnippet'] = $result->getSectionSnippet(); + } + } + if ( isset( $prop['hasrelated'] ) && $result->hasRelated() ) { + $vals['hasrelated'] = ""; + } + // Add item to results and see whether it fits $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals ); @@ -160,77 +191,100 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { } public function getAllowedParams() { - return array ( - 'search' => null, - 'namespace' => array ( - ApiBase :: PARAM_DFLT => 0, - ApiBase :: PARAM_TYPE => 'namespace', - ApiBase :: PARAM_ISMULTI => true, + return array( + 'search' => array( + ApiBase::PARAM_TYPE => 'string', + ApiBase::PARAM_REQUIRED => true + ), + 'namespace' => array( + ApiBase::PARAM_DFLT => 0, + ApiBase::PARAM_TYPE => 'namespace', + ApiBase::PARAM_ISMULTI => true, ), - 'what' => array ( - ApiBase :: PARAM_DFLT => null, - ApiBase :: PARAM_TYPE => array ( + 'what' => array( + ApiBase::PARAM_DFLT => null, + ApiBase::PARAM_TYPE => array( 'title', 'text', + 'nearmatch', ) ), 'info' => array( - ApiBase :: PARAM_DFLT => 'totalhits|suggestion', - ApiBase :: PARAM_TYPE => array ( + ApiBase::PARAM_DFLT => 'totalhits|suggestion', + ApiBase::PARAM_TYPE => array( 'totalhits', 'suggestion', ), - ApiBase :: PARAM_ISMULTI => true, + ApiBase::PARAM_ISMULTI => true, ), 'prop' => array( - ApiBase :: PARAM_DFLT => 'size|wordcount|timestamp|snippet', - ApiBase :: PARAM_TYPE => array ( + ApiBase::PARAM_DFLT => 'size|wordcount|timestamp|snippet', + ApiBase::PARAM_TYPE => array( 'size', 'wordcount', 'timestamp', + 'score', 'snippet', + 'titlesnippet', + 'redirecttitle', + 'redirectsnippet', + 'sectiontitle', + 'sectionsnippet', + 'hasrelated', ), - ApiBase :: PARAM_ISMULTI => true, + ApiBase::PARAM_ISMULTI => true, ), 'redirects' => false, 'offset' => 0, - 'limit' => array ( - ApiBase :: PARAM_DFLT => 10, - ApiBase :: PARAM_TYPE => 'limit', - ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX => ApiBase :: LIMIT_SML1, - ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_SML2 + 'limit' => array( + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_SML1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_SML2 ) ); } public function getParamDescription() { - return array ( - 'search' => 'Search for all page titles (or content) that has this value.', - 'namespace' => 'The namespace(s) to enumerate.', - 'what' => 'Search inside the text or titles.', - 'info' => 'What metadata to return.', - 'prop' => 'What properties to return.', - 'redirects' => 'Include redirect pages in the search.', + return array( + 'search' => 'Search for all page titles (or content) that has this value', + 'namespace' => 'The namespace(s) to enumerate', + 'what' => 'Search inside the text or titles', + 'info' => 'What metadata to return', + 'prop' => array( + 'What properties to return', + ' size - Adds the size of the page in bytes', + ' wordcount - Adds the word count of the page', + ' timestamp - Adds the timestamp of when the page was last edited', + ' score - Adds the score (if any) from the search engine', + ' snippet - Adds a parsed snippet of the page', + ' titlesnippet - Adds a parsed snippet of the page title', + ' redirectsnippet - Adds a parsed snippet of the redirect', + ' redirecttitle - Adds a parsed snippet of the redirect title', + ' sectionsnippet - Adds a parsed snippet of the matching section', + ' sectiontitle - Adds a parsed snippet of the matching section title', + ' hasrelated - Indicates whether a related search is available', + ), + 'redirects' => 'Include redirect pages in the search', 'offset' => 'Use this value to continue paging (return by query)', - 'limit' => 'How many total pages to return.' + 'limit' => 'How many total pages to return' ); } public function getDescription() { return 'Perform a full text search'; } - + public function getPossibleErrors() { return array_merge( parent::getPossibleErrors(), array( - array( 'code' => 'param-search', 'info' => 'empty search string is not allowed' ), array( 'code' => 'search-text-disabled', 'info' => 'text search is disabled' ), array( 'code' => 'search-title-disabled', 'info' => 'title search is disabled' ), ) ); } protected function getExamples() { - return array ( + return array( 'api.php?action=query&list=search&srsearch=meaning', 'api.php?action=query&list=search&srwhat=text&srsearch=meaning', 'api.php?action=query&generator=search&gsrsearch=meaning&prop=info', @@ -238,6 +292,6 @@ class ApiQuerySearch extends ApiQueryGeneratorBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQuerySearch.php 69932 2010-07-26 08:03:21Z tstarling $'; + return __CLASS__ . ': $Id: ApiQuerySearch.php 76300 2010-11-08 12:23:24Z reedy $'; } } -- cgit v1.2.3-54-g00ecf