3 * Contain a class for special pages
9 var $searchTerms = array();
10 var $namespaces = array( NS_MAIN
);
11 var $showRedirects = false;
14 * Perform a full text search query and return a result set.
15 * If title searches are not supported or disabled, return null.
17 * @param string $term - Raw search term
18 * @return SearchResultSet
22 function searchText( $term ) {
27 * Perform a title-only search query and return a result set.
28 * If title searches are not supported or disabled, return null.
30 * @param string $term - Raw search term
31 * @return SearchResultSet
35 function searchTitle( $term ) {
40 * If an exact title match can be find, or a very slightly close match,
41 * return the title. If no match, returns NULL.
46 public static function getNearMatch( $searchterm ) {
49 $allSearchTerms = array($searchterm);
51 if($wgContLang->hasVariants()){
52 $allSearchTerms = array_merge($allSearchTerms,$wgContLang->convertLinkToAllVariants($searchterm));
55 foreach($allSearchTerms as $term){
57 # Exact match? No need to look further.
58 $title = Title
::newFromText( $term );
62 if ( $title->getNamespace() == NS_SPECIAL ||
$title->exists() ) {
66 # Now try all lower case (i.e. first letter capitalized)
68 $title = Title
::newFromText( $wgContLang->lc( $term ) );
69 if ( $title->exists() ) {
73 # Now try capitalized string
75 $title = Title
::newFromText( $wgContLang->ucwords( $term ) );
76 if ( $title->exists() ) {
80 # Now try all upper case
82 $title = Title
::newFromText( $wgContLang->uc( $term ) );
83 if ( $title->exists() ) {
87 # Now try Word-Caps-Breaking-At-Word-Breaks, for hyphenated names etc
88 $title = Title
::newFromText( $wgContLang->ucwordbreaks($term) );
89 if ( $title->exists() ) {
93 global $wgCapitalLinks, $wgContLang;
94 if( !$wgCapitalLinks ) {
95 // Catch differs-by-first-letter-case-only
96 $title = Title
::newFromText( $wgContLang->ucfirst( $term ) );
97 if ( $title->exists() ) {
100 $title = Title
::newFromText( $wgContLang->lcfirst( $term ) );
101 if ( $title->exists() ) {
106 // Give hooks a chance at better match variants
108 if( !wfRunHooks( 'SearchGetNearMatch', array( $term, &$title ) ) ) {
113 $title = Title
::newFromText( $searchterm );
115 # Entering an IP address goes to the contributions page
116 if ( ( $title->getNamespace() == NS_USER
&& User
::isIP($title->getText() ) )
117 || User
::isIP( trim( $searchterm ) ) ) {
118 return SpecialPage
::getTitleFor( 'Contributions', $title->getDBkey() );
122 # Entering a user goes to the user page whether it's there or not
123 if ( $title->getNamespace() == NS_USER
) {
127 # Go to images that exist even if there's no local page.
128 # There may have been a funny upload, or it may be on a shared
129 # file repository such as Wikimedia Commons.
130 if( $title->getNamespace() == NS_IMAGE
) {
131 $image = wfFindFile( $title );
137 # MediaWiki namespace? Page may be "implied" if not customized.
138 # Just return it, with caps forced as the message system likes it.
139 if( $title->getNamespace() == NS_MEDIAWIKI
) {
140 return Title
::makeTitle( NS_MEDIAWIKI
, $wgContLang->ucfirst( $title->getText() ) );
143 # Quoted term? Try without the quotes...
145 if( preg_match( '/^"([^"]+)"$/', $searchterm, $matches ) ) {
146 return SearchEngine
::getNearMatch( $matches[1] );
152 public static function legalSearchChars() {
153 return "A-Za-z_'0-9\\x80-\\xFF\\-";
157 * Set the maximum number of results to return
158 * and how many to skip before returning the first.
164 function setLimitOffset( $limit, $offset = 0 ) {
165 $this->limit
= intval( $limit );
166 $this->offset
= intval( $offset );
170 * Set which namespaces the search should include.
171 * Give an array of namespace index numbers.
173 * @param array $namespaces
176 function setNamespaces( $namespaces ) {
177 $this->namespaces
= $namespaces;
181 * Parse some common prefixes: all (search everything)
184 * @param string $query
186 function replacePrefixes( $query ){
189 if( strpos($query,':') === false )
190 return $query; // nothing to do
193 $allkeyword = wfMsg('searchall').":";
194 if( strncmp($query, $allkeyword, strlen($allkeyword)) == 0 ){
195 $this->namespaces
= null;
196 $parsed = substr($query,strlen($allkeyword));
197 } else if( strpos($query,':') !== false ) {
198 $prefix = substr($query,0,strpos($query,':'));
199 $index = $wgContLang->getNsIndex($prefix);
200 if($index !== false){
201 $this->namespaces
= array($index);
202 $parsed = substr($query,strlen($prefix)+
1);
205 if(trim($parsed) == '')
206 return $query; // prefix was the whole query
212 * Make a list of searchable namespaces and their canonical names.
215 public static function searchableNamespaces() {
218 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
219 if( $ns >= NS_MAIN
) {
227 * Return a 'cleaned up' search string
232 function filter( $text ) {
233 $lc = $this->legalSearchChars();
234 return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
237 * Load up the appropriate search engine class for the currently
238 * active database backend, and return a configured instance.
240 * @return SearchEngine
242 public static function create() {
243 global $wgDBtype, $wgSearchType;
244 if( $wgSearchType ) {
245 $class = $wgSearchType;
246 } elseif( $wgDBtype == 'mysql' ) {
247 $class = 'SearchMySQL';
248 } else if ( $wgDBtype == 'postgres' ) {
249 $class = 'SearchPostgres';
250 } else if ( $wgDBtype == 'oracle' ) {
251 $class = 'SearchOracle';
253 $class = 'SearchEngineDummy';
255 $search = new $class( wfGetDB( DB_SLAVE
) );
256 $search->setLimitOffset(0,0);
261 * Create or update the search index record for the given page.
262 * Title and text should be pre-processed.
265 * @param string $title
266 * @param string $text
269 function update( $id, $title, $text ) {
274 * Update a search index record's title only.
275 * Title should be pre-processed.
278 * @param string $title
281 function updateTitle( $id, $title ) {
290 class SearchResultSet
{
292 * Fetch an array of regular expression fragments for matching
293 * the search terms as parsed by this engine in a text extract.
299 function termMatches() {
308 * Return true if results are included in this result set.
312 function hasResults() {
317 * Some search modes return a total hit count for the query
318 * in the entire article database. This may include pages
319 * in namespaces that would not be matched on the given
322 * Return null if no total hits number is supported.
327 function getTotalHits() {
332 * Some search modes return a suggested alternate term if there are
333 * no exact hits. Returns true if there is one on this set.
338 function hasSuggestion() {
343 * @return string suggested query, null if none
345 function getSuggestionQuery(){
350 * @return string highlighted suggested query, '' if none
352 function getSuggestionSnippet(){
357 * Fetches next search result, or false.
358 * @return SearchResult
367 * Frees the result set, if applicable.
379 class SearchResultTooMany
{
380 ## Some search engines may bail out if too many matches are found
389 function SearchResult( $row ) {
390 $this->mTitle
= Title
::makeTitle( $row->page_namespace
, $row->page_title
);
397 function getTitle() {
398 return $this->mTitle
;
402 * @return double or null if not supported
404 function getScore() {
409 * @return string highlighted text snippet, null if not supported
411 function getTextSnippet(){
416 * @return string highlighted title, '' if not supported
418 function getTitleSnippet(){
423 * @return string highlighted redirect name (redirect to this page), '' if none or not supported
425 function getRedirectSnippet(){
430 * @return Title object for the redirect to this page, null if none or not supported
432 function getRedirectTitle(){
437 * @return string highlighted relevant section name, null if none or not supported
439 function getSectionSnippet(){
444 * @return Title object (pagename+fragment) for the section, null if none or not supported
446 function getSectionTitle(){
451 * @return string timestamp, null if not supported
453 function getTimestamp(){
458 * @return int number of words, null if not supported
460 function getWordCount(){
465 * @return int size in bytes, null if not supported
467 function getByteSize(){
475 class SearchEngineDummy
{
476 function search( $term ) {
479 function setLimitOffset($l, $o) {}
480 function legalSearchChars() {}
482 function setnamespaces() {}
483 function searchtitle() {}
484 function searchtext() {}