includes/specials/SpecialSearch.php

   1 <?php
   2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
   3 # http://www.mediawiki.org/
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with this program; if not, write to the Free Software Foundation, Inc.,
  17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18 # http://www.gnu.org/copyleft/gpl.html
  19
  20 /**
  21  * Run text & title search and display the output
  22  * @file
  23  * @ingroup SpecialPage
  24  */
  25
  26 /**
  27  * Entry point
  28  *
  29  * @param $par String: (default '')
  30  */
  31 function wfSpecialSearch( $par = '' ) {
  32         global $wgRequest, $wgUser, $wgUseOldSearchUI;
  33         // Strip underscores from title parameter; most of the time we'll want
  34         // text form here. But don't strip underscores from actual text params!
  35         $titleParam = str_replace( '_', ' ', $par );
  36         // Fetch the search term
  37         $search = str_replace( "\n", " ", $wgRequest->getText( 'search', $titleParam ) );
  38         $class = $wgUseOldSearchUI ? 'SpecialSearchOld' : 'SpecialSearch';
  39         $searchPage = new $class( $wgRequest, $wgUser );
  40         if( $wgRequest->getVal( 'fulltext' )
  41                 || !is_null( $wgRequest->getVal( 'offset' ))
  42                 || !is_null( $wgRequest->getVal( 'searchx' )) )
  43         {
  44                 $searchPage->showResults( $search );
  45         } else {
  46                 $searchPage->goResult( $search );
  47         }
  48 }
  49
  50 /**
  51  * implements Special:Search - Run text & title search and display the output
  52  * @ingroup SpecialPage
  53  */
  54 class SpecialSearch {
  55
  56         /**
  57          * Set up basic search parameters from the request and user settings.
  58          * Typically you'll pass $wgRequest and $wgUser.
  59          *
  60          * @param WebRequest $request
  61          * @param User $user
  62          * @public
  63          */
  64         function __construct( &$request, &$user ) {
  65                 list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
  66                 $this->mPrefix = $request->getVal('prefix', '');
  67                 # Extract requested namespaces
  68                 $this->namespaces = $this->powerSearch( $request );
  69                 if( empty( $this->namespaces ) ) {
  70                         $this->namespaces = SearchEngine::userNamespaces( $user );
  71                 }
  72                 $this->searchRedirects = $request->getcheck( 'redirs' ) ? true : false;
  73                 $this->searchAdvanced = $request->getVal( 'advanced' );
  74                 $this->active = 'advanced';
  75                 $this->sk = $user->getSkin();
  76                 $this->didYouMeanHtml = ''; # html of did you mean... link
  77         }
  78
  79         /**
  80          * If an exact title match can be found, jump straight ahead to it.
  81          * @param string $term
  82          */
  83         public function goResult( $term ) {
  84                 global $wgOut;
  85                 $this->setupPage( $term );
  86                 # Try to go to page as entered.
  87                 $t = Title::newFromText( $term );
  88                 # If the string cannot be used to create a title
  89                 if( is_null( $t ) ) {
  90                         return $this->showResults( $term );
  91                 }
  92                 # If there's an exact or very near match, jump right there.
  93                 $t = SearchEngine::getNearMatch( $term );
  94                 if( !is_null( $t ) ) {
  95                         $wgOut->redirect( $t->getFullURL() );
  96                         return;
  97                 }
  98                 # No match, generate an edit URL
  99                 $t = Title::newFromText( $term );
 100                 if( !is_null( $t ) ) {
 101                         global $wgGoToEdit;
 102                         wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) );
 103                         # If the feature is enabled, go straight to the edit page
 104                         if( $wgGoToEdit ) {
 105                                 $wgOut->redirect( $t->getFullURL( 'action=edit' ) );
 106                                 return;
 107                         }
 108                 }
 109                 return $this->showResults( $term );
 110         }
 111
 112         /**
 113          * @param string $term
 114          */
 115         public function showResults( $term ) {
 116                 global $wgOut, $wgUser, $wgDisableTextSearch, $wgContLang;
 117                 wfProfileIn( __METHOD__ );
 118
 119                 $sk = $wgUser->getSkin();
 120
 121                 $this->searchEngine = SearchEngine::create();
 122                 $search =& $this->searchEngine;
 123                 $search->setLimitOffset( $this->limit, $this->offset );
 124                 $search->setNamespaces( $this->namespaces );
 125                 $search->showRedirects = $this->searchRedirects;
 126                 $search->prefix = $this->mPrefix;
 127                 $term = $search->transformSearchTerm($term);
 128
 129                 $this->setupPage( $term );
 130
 131                 if( $wgDisableTextSearch ) {
 132                         global $wgSearchForwardUrl;
 133                         if( $wgSearchForwardUrl ) {
 134                                 $url = str_replace( '$1', urlencode( $term ), $wgSearchForwardUrl );
 135                                 $wgOut->redirect( $url );
 136                                 wfProfileOut( __METHOD__ );
 137                                 return;
 138                         }
 139                         global $wgInputEncoding;
 140                         $wgOut->addHTML(
 141                                 Xml::openElement( 'fieldset' ) .
 142                                 Xml::element( 'legend', null, wfMsg( 'search-external' ) ) .
 143                                 Xml::element( 'p', array( 'class' => 'mw-searchdisabled' ), wfMsg( 'searchdisabled' ) ) .
 144                                 wfMsg( 'googlesearch',
 145                                         htmlspecialchars( $term ),
 146                                         htmlspecialchars( $wgInputEncoding ),
 147                                         htmlspecialchars( wfMsg( 'searchbutton' ) )
 148                                 ) .
 149                                 Xml::closeElement( 'fieldset' )
 150                         );
 151                         wfProfileOut( __METHOD__ );
 152                         return;
 153                 }
 154
 155                 $t = Title::newFromText( $term );
 156
 157                 // fetch search results
 158                 $rewritten = $search->replacePrefixes($term);
 159
 160                 $titleMatches = $search->searchTitle( $rewritten );
 161                 if( !($titleMatches instanceof SearchResultTooMany))
 162                         $textMatches = $search->searchText( $rewritten );
 163
 164                 // did you mean... suggestions
 165                 if( $textMatches && $textMatches->hasSuggestion() ) {
 166                         $st = SpecialPage::getTitleFor( 'Search' );
 167                         $stParams = wfArrayToCGI(
 168                                 array( 'search' => $textMatches->getSuggestionQuery(), 'fulltext'       => wfMsg('search') ),
 169                                 $this->powerSearchOptions()
 170                         );
 171                         $suggestLink = $sk->makeKnownLinkObj( $st,
 172                                 $textMatches->getSuggestionSnippet(),
 173                                 $stParams );
 174
 175                         $this->didYouMeanHtml = '<div class="searchdidyoumean">'.wfMsg('search-suggest',$suggestLink).'</div>';
 176                 }
 177
 178                 // start rendering the page
 179                 $wgOut->addHtml(
 180                         Xml::openElement( 'table', array( 'border'=>0, 'cellpadding'=>0, 'cellspacing'=>0 ) ) .
 181                         Xml::openElement( 'tr' ) .
 182                         Xml::openElement( 'td' ) . "\n" .
 183                         ( $this->searchAdvanced ? $this->powerSearchBox( $term ) : $this->shortDialog( $term ) ) .
 184                         Xml::closeElement('td') .
 185                         Xml::closeElement('tr') .
 186                         Xml::closeElement('table')
 187                 );
 188
 189                 // Sometimes the search engine knows there are too many hits
 190                 if( $titleMatches instanceof SearchResultTooMany ) {
 191                         $wgOut->addWikiText( '==' . wfMsg( 'toomanymatches' ) . "==\n" );
 192                         wfProfileOut( __METHOD__ );
 193                         return;
 194                 }
 195
 196                 $filePrefix = $wgContLang->getFormattedNsText(NS_FILE).':';
 197                 if( '' === trim( $term ) || $filePrefix === trim( $term ) ) {
 198                         $wgOut->addHTML( $this->searchAdvanced ? $this->powerSearchFocus() : $this->searchFocus() );
 199                         // Empty query -- straight view of search form
 200                         wfProfileOut( __METHOD__ );
 201                         return;
 202                 }
 203
 204                 // show direct page/create link
 205                 if( !is_null($t) ) {
 206                         if( !$t->exists() ) {
 207                                 $wgOut->addWikiMsg( 'searchmenu-new', wfEscapeWikiText( $t->getPrefixedText() ) );
 208                         } else {
 209                                 $wgOut->addWikiMsg( 'searchmenu-exists', wfEscapeWikiText( $t->getPrefixedText() ) );
 210                         }
 211                 }
 212
 213                 // Get number of results
 214                 $titleMatchesSQL = $titleMatches ? $titleMatches->numRows() : 0;
 215                 $textMatchesSQL = $textMatches ? $textMatches->numRows() : 0;
 216                 // Total initial query matches (possible false positives)
 217                 $numSQL = $titleMatchesSQL + $textMatchesSQL;
 218                 // Get total actual results (after second filtering, if any)
 219                 $numTitleMatches = $titleMatches && !is_null( $titleMatches->getTotalHits() ) ?
 220                         $titleMatches->getTotalHits() : $titleMatchesSQL;
 221                 $numTextMatches = $textMatches && !is_null( $textMatches->getTotalHits() ) ?
 222                         $textMatches->getTotalHits() : $textMatchesSQL;
 223                 $totalRes = $numTitleMatches + $numTextMatches;
 224
 225                 // show number of results and current offset
 226                 if( $numSQL > 0 ) {
 227                         if( $numSQL > 0 ) {
 228                                 $top = wfMsgExt('showingresultstotal', array( 'parseinline' ),
 229                                         $this->offset+1, $this->offset+$numSQL, $totalRes, $numSQL );
 230                         } elseif( $numSQL >= $this->limit ) {
 231                                 $top = wfShowingResults( $this->offset, $this->limit );
 232                         } else {
 233                                 $top = wfShowingResultsNum( $this->offset, $this->limit, $numSQL );
 234                         }
 235                         $wgOut->addHTML( "<p class='mw-search-numberresults'>{$top}</p>\n" );
 236                 }
 237
 238                 // prev/next links
 239                 if( $numSQL || $this->offset ) {
 240                         $prevnext = wfViewPrevNext( $this->offset, $this->limit,
 241                                 SpecialPage::getTitleFor( 'Search' ),
 242                                 wfArrayToCGI( $this->powerSearchOptions(), array( 'search' => $term ) ),
 243                                 max( $titleMatchesSQL, $textMatchesSQL ) < $this->limit
 244                         );
 245                         $wgOut->addHTML( "<p class='mw-search-pager-top'>{$prevnext}</p>\n" );
 246                         wfRunHooks( 'SpecialSearchResults', array( $term, &$titleMatches, &$textMatches ) );
 247                 } else {
 248                         wfRunHooks( 'SpecialSearchNoResults', array( $term ) );
 249                 }
 250
 251                 $wgOut->addHtml( "<div class='searchresults'>" );
 252                 if( $titleMatches ) {
 253                         if( $numTitleMatches > 0 ) {
 254                                 $wgOut->wrapWikiMsg( "==$1==\n", 'titlematches' );
 255                                 $wgOut->addHTML( $this->showMatches( $titleMatches ) );
 256                         }
 257                         $titleMatches->free();
 258                 }
 259                 if( $textMatches ) {
 260                         // output appropriate heading
 261                         if( $numTextMatches > 0 && $numTitleMatches > 0 ) {
 262                                 // if no title matches the heading is redundant
 263                                 $wgOut->wrapWikiMsg( "==$1==\n", 'textmatches' );
 264                         } elseif( $totalRes == 0 ) {
 265                                 # Don't show the 'no text matches' if we received title matches
 266                                 $wgOut->wrapWikiMsg( "==$1==\n", 'notextmatches' );
 267                         }
 268                         // show interwiki results if any
 269                         if( $textMatches->hasInterwikiResults() ) {
 270                                 $wgOut->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(), $term ) );
 271                         }
 272                         // show results
 273                         if( $numTextMatches > 0 ) {
 274                                 $wgOut->addHTML( $this->showMatches( $textMatches ) );
 275                         }
 276
 277                         $textMatches->free();
 278                 }
 279                 if( $totalRes === 0 ) {
 280                         $wgOut->addWikiMsg( 'search-nonefound' );
 281                 }
 282                 $wgOut->addHtml( "</div>" );
 283                 if( $totalRes === 0 ) {
 284                         $wgOut->addHTML( $this->searchAdvanced ? $this->powerSearchFocus() : $this->searchFocus() );
 285                 }
 286
 287                 if( $numSQL || $this->offset ) {
 288                         $wgOut->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
 289                 }
 290                 wfProfileOut( __METHOD__ );
 291         }
 292
 293         /**
 294          *
 295          */
 296         protected function setupPage( $term ) {
 297                 global $wgOut;
 298                 // Figure out the active search profile header
 299                 $nsAllSet = array_keys( SearchEngine::searchableNamespaces() );
 300                 if( $this->searchAdvanced )
 301                         $this->active = 'advanced';
 302                 else if( $this->namespaces === NS_FILE || $this->startsWithImage( $term ) )
 303                         $this->active = 'images';
 304                 elseif( $this->namespaces === $nsAllSet )
 305                         $this->active = 'all';
 306                 elseif( $this->namespaces === SearchEngine::defaultNamespaces() )
 307                         $this->active = 'default';
 308                 elseif( $this->namespaces === SearchEngine::projectNamespaces() )
 309                         $this->active = 'project';
 310                 else
 311                         $this->active = 'advanced';
 312                 # Should advanced UI be used?
 313                 $this->searchAdvanced = ($this->active === 'advanced');
 314                 if( !empty( $term ) ) {
 315                         $wgOut->setPageTitle( wfMsg( 'searchresults') );
 316                         $wgOut->setHTMLTitle( wfMsg( 'pagetitle', wfMsg( 'searchresults-title', $term ) ) );
 317                 }
 318                 $wgOut->setArticleRelated( false );
 319                 $wgOut->setRobotPolicy( 'noindex,nofollow' );
 320         }
 321
 322         /**
 323          * Extract "power search" namespace settings from the request object,
 324          * returning a list of index numbers to search.
 325          *
 326          * @param WebRequest $request
 327          * @return array
 328          */
 329         protected function powerSearch( &$request ) {
 330                 $arr = array();
 331                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 332                         if( $request->getCheck( 'ns' . $ns ) ) {
 333                                 $arr[] = $ns;
 334                         }
 335                 }
 336                 return $arr;
 337         }
 338
 339         /**
 340          * Reconstruct the 'power search' options for links
 341          * @return array
 342          */
 343         protected function powerSearchOptions() {
 344                 $opt = array();
 345                 foreach( $this->namespaces as $n ) {
 346                         $opt['ns' . $n] = 1;
 347                 }
 348                 $opt['redirs'] = $this->searchRedirects ? 1 : 0;
 349                 if( $this->searchAdvanced ) {
 350                         $opt['advanced'] = $this->searchAdvanced;
 351                 }
 352                 return $opt;
 353         }
 354
 355         /**
 356          * Show whole set of results
 357          *
 358          * @param SearchResultSet $matches
 359          */
 360         protected function showMatches( &$matches ) {
 361                 global $wgContLang;
 362                 wfProfileIn( __METHOD__ );
 363
 364                 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
 365
 366                 $out = "";
 367                 $infoLine = $matches->getInfo();
 368                 if( !is_null($infoLine) ) {
 369                         $out .= "\n<!-- {$infoLine} -->\n";
 370                 }
 371                 $off = $this->offset + 1;
 372                 $out .= "<ul class='mw-search-results'>\n";
 373                 while( $result = $matches->next() ) {
 374                         $out .= $this->showHit( $result, $terms );
 375                 }
 376                 $out .= "</ul>\n";
 377
 378                 // convert the whole thing to desired language variant
 379                 $out = $wgContLang->convert( $out );
 380                 wfProfileOut( __METHOD__ );
 381                 return $out;
 382         }
 383
 384         /**
 385          * Format a single hit result
 386          * @param SearchResult $result
 387          * @param array $terms terms to highlight
 388          */
 389         protected function showHit( $result, $terms ) {
 390                 global $wgContLang, $wgLang, $wgUser;
 391                 wfProfileIn( __METHOD__ );
 392
 393                 if( $result->isBrokenTitle() ) {
 394                         wfProfileOut( __METHOD__ );
 395                         return "<!-- Broken link in search result -->\n";
 396                 }
 397
 398                 $sk = $wgUser->getSkin();
 399                 $t = $result->getTitle();
 400
 401                 $link = $this->sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
 402
 403                 //If page content is not readable, just return the title.
 404                 //This is not quite safe, but better than showing excerpts from non-readable pages
 405                 //Note that hiding the entry entirely would screw up paging.
 406                 if( !$t->userCanRead() ) {
 407                         wfProfileOut( __METHOD__ );
 408                         return "<li>{$link}</li>\n";
 409                 }
 410
 411                 // If the page doesn't *exist*... our search index is out of date.
 412                 // The least confusing at this point is to drop the result.
 413                 // You may get less results, but... oh well. :P
 414                 if( $result->isMissingRevision() ) {
 415                         wfProfileOut( __METHOD__ );
 416                         return "<!-- missing page " . htmlspecialchars( $t->getPrefixedText() ) . "-->\n";
 417                 }
 418
 419                 // format redirects / relevant sections
 420                 $redirectTitle = $result->getRedirectTitle();
 421                 $redirectText = $result->getRedirectSnippet($terms);
 422                 $sectionTitle = $result->getSectionTitle();
 423                 $sectionText = $result->getSectionSnippet($terms);
 424                 $redirect = '';
 425                 if( !is_null($redirectTitle) )
 426                         $redirect = "<span class='searchalttitle'>"
 427                                 .wfMsg('search-redirect',$this->sk->makeKnownLinkObj( $redirectTitle, $redirectText))
 428                                 ."</span>";
 429                 $section = '';
 430                 if( !is_null($sectionTitle) )
 431                         $section = "<span class='searchalttitle'>"
 432                                 .wfMsg('search-section', $this->sk->makeKnownLinkObj( $sectionTitle, $sectionText))
 433                                 ."</span>";
 434
 435                 // format text extract
 436                 $extract = "<div class='searchresult'>".$result->getTextSnippet($terms)."</div>";
 437
 438                 // format score
 439                 if( is_null( $result->getScore() ) ) {
 440                         // Search engine doesn't report scoring info
 441                         $score = '';
 442                 } else {
 443                         $percent = sprintf( '%2.1f', $result->getScore() * 100 );
 444                         $score = wfMsg( 'search-result-score', $wgLang->formatNum( $percent ) )
 445                                 . ' - ';
 446                 }
 447
 448                 // format description
 449                 $byteSize = $result->getByteSize();
 450                 $wordCount = $result->getWordCount();
 451                 $timestamp = $result->getTimestamp();
 452                 $size = wfMsgExt( 'search-result-size', array( 'parsemag', 'escape' ),
 453                         $this->sk->formatSize( $byteSize ), $wordCount );
 454                 $date = $wgLang->timeanddate( $timestamp );
 455
 456                 // link to related articles if supported
 457                 $related = '';
 458                 if( $result->hasRelated() ) {
 459                         $st = SpecialPage::getTitleFor( 'Search' );
 460                         $stParams = wfArrayToCGI( $this->powerSearchOptions(),
 461                                 array('search'    => wfMsgForContent('searchrelated').':'.$t->getPrefixedText(),
 462                                       'fulltext'  => wfMsg('search') ));
 463
 464                         $related = ' -- ' . $sk->makeKnownLinkObj( $st,
 465                                 wfMsg('search-relatedarticle'), $stParams );
 466                 }
 467
 468                 // Include a thumbnail for media files...
 469                 if( $t->getNamespace() == NS_FILE ) {
 470                         $img = wfFindFile( $t );
 471                         if( $img ) {
 472                                 $thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
 473                                 if( $thumb ) {
 474                                         $desc = $img->getShortDesc();
 475                                         wfProfileOut( __METHOD__ );
 476                                         // Float doesn't seem to interact well with the bullets.
 477                                         // Table messes up vertical alignment of the bullets.
 478                                         // Bullets are therefore disabled (didn't look great anyway).
 479                                         return "<li>" .
 480                                                 '<table class="searchResultImage">' .
 481                                                 '<tr>' .
 482                                                 '<td width="120" align="center" valign="top">' .
 483                                                 $thumb->toHtml( array( 'desc-link' => true ) ) .
 484                                                 '</td>' .
 485                                                 '<td valign="top">' .
 486                                                 $link .
 487                                                 $extract .
 488                                                 "<div class='mw-search-result-data'>{$score}{$desc} - {$date}{$related}</div>" .
 489                                                 '</td>' .
 490                                                 '</tr>' .
 491                                                 '</table>' .
 492                                                 "</li>\n";
 493                                 }
 494                         }
 495                 }
 496
 497                 wfProfileOut( __METHOD__ );
 498                 return "<li>{$link} {$redirect} {$section} {$extract}\n" .
 499                         "<div class='mw-search-result-data'>{$score}{$size} - {$date}{$related}</div>" .
 500                         "</li>\n";
 501
 502         }
 503
 504         /**
 505          * Show results from other wikis
 506          *
 507          * @param SearchResultSet $matches
 508          */
 509         protected function showInterwiki( &$matches, $query ) {
 510                 global $wgContLang;
 511                 wfProfileIn( __METHOD__ );
 512                 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
 513
 514                 $out = "<div id='mw-search-interwiki'><div id='mw-search-interwiki-caption'>".
 515                         wfMsg('search-interwiki-caption')."</div>\n";
 516                 $off = $this->offset + 1;
 517                 $out .= "<ul class='mw-search-iwresults'>\n";
 518
 519                 // work out custom project captions
 520                 $customCaptions = array();
 521                 $customLines = explode("\n",wfMsg('search-interwiki-custom')); // format per line <iwprefix>:<caption>
 522                 foreach($customLines as $line) {
 523                         $parts = explode(":",$line,2);
 524                         if(count($parts) == 2) // validate line
 525                                 $customCaptions[$parts[0]] = $parts[1];
 526                 }
 527
 528                 $prev = null;
 529                 while( $result = $matches->next() ) {
 530                         $out .= $this->showInterwikiHit( $result, $prev, $terms, $query, $customCaptions );
 531                         $prev = $result->getInterwikiPrefix();
 532                 }
 533                 // FIXME: should support paging in a non-confusing way (not sure how though, maybe via ajax)..
 534                 $out .= "</ul></div>\n";
 535
 536                 // convert the whole thing to desired language variant
 537                 $out = $wgContLang->convert( $out );
 538                 wfProfileOut( __METHOD__ );
 539                 return $out;
 540         }
 541
 542         /**
 543          * Show single interwiki link
 544          *
 545          * @param SearchResult $result
 546          * @param string $lastInterwiki
 547          * @param array $terms
 548          * @param string $query
 549          * @param array $customCaptions iw prefix -> caption
 550          */
 551         protected function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) {
 552                 wfProfileIn( __METHOD__ );
 553                 global $wgContLang, $wgLang;
 554
 555                 if( $result->isBrokenTitle() ) {
 556                         wfProfileOut( __METHOD__ );
 557                         return "<!-- Broken link in search result -->\n";
 558                 }
 559
 560                 $t = $result->getTitle();
 561
 562                 $link = $this->sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
 563
 564                 // format redirect if any
 565                 $redirectTitle = $result->getRedirectTitle();
 566                 $redirectText = $result->getRedirectSnippet($terms);
 567                 $redirect = '';
 568                 if( !is_null($redirectTitle) )
 569                         $redirect = "<span class='searchalttitle'>"
 570                                 .wfMsg('search-redirect',$this->sk->makeKnownLinkObj( $redirectTitle, $redirectText))
 571                                 ."</span>";
 572
 573                 $out = "";
 574                 // display project name
 575                 if(is_null($lastInterwiki) || $lastInterwiki != $t->getInterwiki()) {
 576                         if( key_exists($t->getInterwiki(),$customCaptions) )
 577                                 // captions from 'search-interwiki-custom'
 578                                 $caption = $customCaptions[$t->getInterwiki()];
 579                         else{
 580                                 // default is to show the hostname of the other wiki which might suck
 581                                 // if there are many wikis on one hostname
 582                                 $parsed = parse_url($t->getFullURL());
 583                                 $caption = wfMsg('search-interwiki-default', $parsed['host']);
 584                         }
 585                         // "more results" link (special page stuff could be localized, but we might not know target lang)
 586                         $searchTitle = Title::newFromText($t->getInterwiki().":Special:Search");
 587                         $searchLink = $this->sk->makeKnownLinkObj( $searchTitle, wfMsg('search-interwiki-more'),
 588                                 wfArrayToCGI(array('search' => $query, 'fulltext' => 'Search')));
 589                         $out .= "</ul><div class='mw-search-interwiki-project'><span class='mw-search-interwiki-more'>
 590                                 {$searchLink}</span>{$caption}</div>\n<ul>";
 591                 }
 592
 593                 $out .= "<li>{$link} {$redirect}</li>\n";
 594                 wfProfileOut( __METHOD__ );
 595                 return $out;
 596         }
 597
 598
 599         /**
 600          * Generates the power search box at bottom of [[Special:Search]]
 601          * @param $term string: search term
 602          * @return $out string: HTML form
 603          */
 604         protected function powerSearchBox( $term ) {
 605                 global $wgScript;
 606
 607                 $namespaces = SearchEngine::searchableNamespaces();
 608
 609                 $tables = $this->namespaceTables( $namespaces );
 610
 611                 $redirect = Xml::check( 'redirs', $this->searchRedirects, array( 'value' => '1', 'id' => 'redirs' ) );
 612                 $redirectLabel = Xml::label( wfMsg( 'powersearch-redir' ), 'redirs' );
 613                 $searchField = Xml::inputLabel( wfMsg('powersearch-field'), 'search', 'powerSearchText', 50, $term,
 614                         array( 'type' => 'text') );
 615                 $searchButton = Xml::submitButton( wfMsg( 'powersearch' ), array( 'name' => 'fulltext' )) . "\n";
 616                 $searchTitle = SpecialPage::getTitleFor( 'Search' );
 617
 618                 $redirectText = '';
 619                 // show redirects check only if backend supports it
 620                 if( $this->searchEngine->acceptListRedirects() ) {
 621                         $redirectText = "<p>". $redirect . " " . $redirectLabel ."</p>";
 622                 }
 623
 624                 $out = Xml::openElement( 'form', array( 'id' => 'powersearch', 'method' => 'get', 'action' => $wgScript ) ) .
 625                         Xml::hidden( 'title', $searchTitle->getPrefixedText() ) . "\n" .
 626                         "<p>" .
 627                         wfMsgExt( 'powersearch-ns', array( 'parseinline' ) ) .
 628                         "</p>\n" .
 629                         '<input type="hidden" name="advanced" value="'.$this->searchAdvanced."\"/>\n".
 630                         $tables .
 631                         "<hr style=\"clear: both;\" />\n".
 632                         $redirectText ."\n".
 633                         "<div style=\"padding-top:2px;padding-bottom:2px;\">".
 634                         $searchField .
 635                         "&nbsp;" .
 636                         Xml::hidden( 'fulltext', 'Advanced search' ) . "\n" .
 637                         $searchButton .
 638                         "</div>".
 639                         "</form>";
 640                 $t = Title::newFromText( $term );
 641                 /* if( $t != null && count($this->namespaces) === 1 ) {
 642                         $out .= wfMsgExt( 'searchmenu-prefix', array('parseinline'), $term );
 643                 } */
 644                 return Xml::openElement( 'fieldset', array('id' => 'mw-searchoptions','style' => 'margin:0em;') ) .
 645                         Xml::element( 'legend', null, wfMsg('powersearch-legend') ) .
 646                         $this->formHeader($term) . $out . $this->didYouMeanHtml .
 647                         Xml::closeElement( 'fieldset' );
 648         }
 649
 650         protected function searchFocus() {
 651                 global $wgJsMimeType;
 652                 return "<script type=\"$wgJsMimeType\">" .
 653                         "hookEvent(\"load\", function() {" .
 654                                 "document.getElementById('searchText').focus();" .
 655                         "});" .
 656                         "</script>";
 657         }
 658
 659         protected function powerSearchFocus() {
 660                 global $wgJsMimeType;
 661                 return "<script type=\"$wgJsMimeType\">" .
 662                         "hookEvent(\"load\", function() {" .
 663                                 "document.getElementById('powerSearchText').focus();" .
 664                         "});" .
 665                         "</script>";
 666         }
 667
 668         protected function formHeader( $term ) {
 669                 global $wgContLang, $wgCanonicalNamespaceNames;
 670
 671                 $sep = '&nbsp;&nbsp;&nbsp;';
 672                 $out = Xml::openElement('div', array( 'style' => 'padding-bottom:0.5em;' ) );
 673
 674                 $bareterm = $term;
 675                 if( $this->startsWithImage( $term ) )
 676                         $bareterm = substr( $term, strpos( $term, ':' ) + 1 ); // delete all/image prefix
 677
 678                 $nsAllSet = array_keys( SearchEngine::searchableNamespaces() );
 679
 680                 // search profiles headers
 681                 $m = wfMsg( 'searchprofile-articles' );
 682                 $tt = wfMsg( 'searchprofile-articles-tooltip',
 683                         implode( ', ', SearchEngine::namespacesAsText( SearchEngine::defaultNamespaces() ) ) );
 684                 if( $this->active == 'default' ) {
 685                         $out .= Xml::element( 'strong', array( 'title'=>$tt ), $m );
 686                 } else {
 687                         $out .= $this->makeSearchLink( $bareterm, SearchEngine::defaultNamespaces(), $m, $tt );
 688                 }
 689                 $out .= $sep;
 690
 691                 $m = wfMsg( 'searchprofile-images' );
 692                 $tt = wfMsg( 'searchprofile-images-tooltip' );
 693                 if( $this->active == 'images' ) {
 694                         $out .= Xml::element( 'strong', array( 'title'=>$tt ), $m );
 695                 } else {
 696                         $imageTextForm = $wgContLang->getFormattedNsText(NS_FILE).':'.$bareterm;
 697                         $out .= $this->makeSearchLink( $imageTextForm, array( NS_FILE ) , $m, $tt );
 698                 }
 699                 $out .= $sep;
 700
 701                 /*
 702                 $m = wfMsg( 'searchprofile-articles-and-proj' );
 703                 $tt = wfMsg( 'searchprofile-project-tooltip',
 704                         implode( ', ', SearchEngine::namespacesAsText( SearchEngine::defaultAndProjectNamespaces() ) ) );
 705                 if( $this->active == 'withproject' ) {
 706                         $out .= Xml::element( 'strong', array( 'title'=>$tt ), $m );
 707                 } else {
 708                         $out .= $this->makeSearchLink( $bareterm, SearchEngine::defaultAndProjectNamespaces(), $m, $tt );
 709                 }
 710                 $out .= $sep;
 711                 */
 712
 713                 $m = wfMsg( 'searchprofile-project' );
 714                 $tt = wfMsg( 'searchprofile-project-tooltip',
 715                         implode( ', ', SearchEngine::namespacesAsText( SearchEngine::projectNamespaces() ) ) );
 716                 if( $this->active == 'project' ) {
 717                         $out .= Xml::element( 'strong', array( 'title'=>$tt ), $m );
 718                 } else {
 719                         $out .= $this->makeSearchLink( $bareterm, SearchEngine::projectNamespaces(), $m, $tt );
 720                 }
 721                 $out .= $sep;
 722
 723                 $m = wfMsg( 'searchprofile-everything' );
 724                 $tt = wfMsg( 'searchprofile-everything-tooltip' );
 725                 if( $this->active == 'all' ) {
 726                         $out .= Xml::element( 'strong', array( 'title'=>$tt ), $m );
 727                 } else {
 728                         $out .= $this->makeSearchLink( $bareterm, $nsAllSet, $m, $tt );
 729                 }
 730                 $out .= $sep;
 731
 732                 $m = wfMsg( 'searchprofile-advanced' );
 733                 $tt = wfMsg( 'searchprofile-advanced-tooltip' );
 734                 if( $this->active == 'advanced' ) {
 735                         $out .= Xml::element( 'strong', array( 'title'=>$tt ), $m );
 736                 } else {
 737                         $out .= $this->makeSearchLink( $bareterm, $this->namespaces, $m, $tt, array( 'advanced' => '1' ) );
 738                 }
 739                 $out .= Xml::closeElement('div') ;
 740
 741                 return $out;
 742         }
 743
 744         protected function shortDialog( $term ) {
 745                 global $wgScript;
 746                 $searchTitle = SpecialPage::getTitleFor( 'Search' );
 747                 $searchable = SearchEngine::searchableNamespaces();
 748                 $out = Xml::openElement( 'form', array( 'id' => 'search', 'method' => 'get', 'action' => $wgScript ) );
 749                 $out .= Xml::hidden( 'title', $searchTitle->getPrefixedText() ) . "\n";
 750                 // show namespaces only for advanced search
 751                 if( $this->active == 'advanced' ) {
 752                         $active = array();
 753                         foreach( $this->namespaces as $ns ) {
 754                                 $active[$ns] = $searchable[$ns];
 755                         }
 756                         $out .= wfMsgExt( 'powersearch-ns', array( 'parseinline' ) ) . "<br/>\n";
 757                         $out .= $this->namespaceTables( $active, 1 )."<br/>\n";
 758                 // Still keep namespace settings otherwise, but don't show them
 759                 } else {
 760                         foreach( $this->namespaces as $ns ) {
 761                                 $out .= Xml::hidden( "ns{$ns}", '1' );
 762                         }
 763                 }
 764                 // Keep redirect setting
 765                 $out .= Xml::hidden( "redirs", (int)$this->searchRedirects );
 766                 // Term box
 767                 $out .= Xml::input( 'search', 50, $term, array( 'type' => 'text', 'id' => 'searchText' ) ) . "\n";
 768                 $out .= Xml::hidden( 'fulltext', 'Search' );
 769                 $out .= Xml::submitButton( wfMsg( 'searchbutton' ), array( 'name' => 'fulltext' ) );
 770                 $out .= ' (' . wfMsgExt('searchmenu-help',array('parseinline') ) . ')';
 771                 $out .= Xml::closeElement( 'form' );
 772                 // Add prefix link for single-namespace searches
 773                 $t = Title::newFromText( $term );
 774                 /*if( $t != null && count($this->namespaces) === 1 ) {
 775                         $out .= wfMsgExt( 'searchmenu-prefix', array('parseinline'), $term );
 776                 }*/
 777                 return Xml::openElement( 'fieldset', array('id' => 'mw-searchoptions','style' => 'margin:0em;') ) .
 778                         Xml::element( 'legend', null, wfMsg('searchmenu-legend') ) .
 779                         $this->formHeader($term) . $out . $this->didYouMeanHtml .
 780                         Xml::closeElement( 'fieldset' );
 781         }
 782
 783         /** Make a search link with some target namespaces */
 784         protected function makeSearchLink( $term, $namespaces, $label, $tooltip, $params=array() ) {
 785                 $opt = $params;
 786                 foreach( $namespaces as $n ) {
 787                         $opt['ns' . $n] = 1;
 788                 }
 789                 $opt['redirs'] = $this->searchRedirects ? 1 : 0;
 790
 791                 $st = SpecialPage::getTitleFor( 'Search' );
 792                 $stParams = wfArrayToCGI( array( 'search' => $term, 'fulltext' => wfMsg( 'search' ) ), $opt );
 793
 794                 return Xml::element( 'a',
 795                         array( 'href'=> $st->getLocalURL( $stParams ), 'title' => $tooltip ),
 796                         $label );
 797         }
 798
 799         /** Check if query starts with image: prefix */
 800         protected function startsWithImage( $term ) {
 801                 global $wgContLang;
 802
 803                 $p = explode( ':', $term );
 804                 if( count( $p ) > 1 ) {
 805                         return $wgContLang->getNsIndex( $p[0] ) == NS_FILE;
 806                 }
 807                 return false;
 808         }
 809
 810         protected function namespaceTables( $namespaces, $rowsPerTable = 3 ) {
 811                 global $wgContLang;
 812                 // Group namespaces into rows according to subject.
 813                 // Try not to make too many assumptions about namespace numbering.
 814                 $rows = array();
 815                 $tables = "";
 816                 foreach( $namespaces as $ns => $name ) {
 817                         $subj = MWNamespace::getSubject( $ns );
 818                         if( !array_key_exists( $subj, $rows ) ) {
 819                                 $rows[$subj] = "";
 820                         }
 821                         $name = str_replace( '_', ' ', $name );
 822                         if( '' == $name ) {
 823                                 $name = wfMsg( 'blanknamespace' );
 824                         }
 825                         $rows[$subj] .= Xml::openElement( 'td', array( 'style' => 'white-space: nowrap' ) ) .
 826                                 Xml::checkLabel( $name, "ns{$ns}", "mw-search-ns{$ns}", in_array( $ns, $this->namespaces ) ) .
 827                                 Xml::closeElement( 'td' ) . "\n";
 828                 }
 829                 $rows = array_values( $rows );
 830                 $numRows = count( $rows );
 831                 // Lay out namespaces in multiple floating two-column tables so they'll
 832                 // be arranged nicely while still accommodating different screen widths
 833                 // Float to the right on RTL wikis
 834                 $tableStyle = $wgContLang->isRTL() ?
 835                         'float: right; margin: 0 0 0em 1em' : 'float: left; margin: 0 1em 0em 0';
 836                 // Build the final HTML table...
 837                 for( $i = 0; $i < $numRows; $i += $rowsPerTable ) {
 838                         $tables .= Xml::openElement( 'table', array( 'style' => $tableStyle ) );
 839                         for( $j = $i; $j < $i + $rowsPerTable && $j < $numRows; $j++ ) {
 840                                 $tables .= "<tr>\n" . $rows[$j] . "</tr>";
 841                         }
 842                         $tables .= Xml::closeElement( 'table' ) . "\n";
 843                 }
 844                 return $tables;
 845         }
 846 }
 847
 848 /**
 849  * implements Special:Search - Run text & title search and display the output
 850  * @ingroup SpecialPage
 851  */
 852 class SpecialSearchOld {
 853
 854         /**
 855          * Set up basic search parameters from the request and user settings.
 856          * Typically you'll pass $wgRequest and $wgUser.
 857          *
 858          * @param WebRequest $request
 859          * @param User $user
 860          * @public
 861          */
 862         function __construct( &$request, &$user ) {
 863                 list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
 864                 $this->mPrefix = $request->getVal('prefix', '');
 865                 $this->namespaces = $this->powerSearch( $request );
 866                 if( empty( $this->namespaces ) ) {
 867                         $this->namespaces = SearchEngine::userNamespaces( $user );
 868                 }
 869
 870                 $this->searchRedirects = $request->getcheck( 'redirs' ) ? true : false;
 871         }
 872
 873         /**
 874          * If an exact title match can be found, jump straight ahead to it.
 875          * @param string $term
 876          * @public
 877          */
 878         function goResult( $term ) {
 879                 global $wgOut;
 880                 global $wgGoToEdit;
 881
 882                 $this->setupPage( $term );
 883
 884                 # Try to go to page as entered.
 885                 $t = Title::newFromText( $term );
 886
 887                 # If the string cannot be used to create a title
 888                 if( is_null( $t ) ){
 889                         return $this->showResults( $term );
 890                 }
 891
 892                 # If there's an exact or very near match, jump right there.
 893                 $t = SearchEngine::getNearMatch( $term );
 894                 if( !is_null( $t ) ) {
 895                         $wgOut->redirect( $t->getFullURL() );
 896                         return;
 897                 }
 898
 899                 # No match, generate an edit URL
 900                 $t = Title::newFromText( $term );
 901                 if( ! is_null( $t ) ) {
 902                         wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) );
 903                         # If the feature is enabled, go straight to the edit page
 904                         if ( $wgGoToEdit ) {
 905                                 $wgOut->redirect( $t->getFullURL( 'action=edit' ) );
 906                                 return;
 907                         }
 908                 }
 909
 910                 $extra = $wgOut->parse( '=='.wfMsgNoTrans( 'notitlematches' )."==\n" );
 911                 if( $t->quickUserCan( 'create' ) && $t->quickUserCan( 'edit' ) ) {
 912                         $extra .= wfMsgExt( 'noexactmatch', 'parse', wfEscapeWikiText( $term ) );
 913                 } else {
 914                         $extra .= wfMsgExt( 'noexactmatch-nocreate', 'parse', wfEscapeWikiText( $term ) );
 915                 }
 916
 917                 $this->showResults( $term, $extra );
 918         }
 919
 920         /**
 921          * @param string $term
 922          * @param string $extra Extra HTML to add after "did you mean"
 923          */
 924         public function showResults( $term, $extra = '' ) {
 925                 wfProfileIn( __METHOD__ );
 926                 global $wgOut, $wgUser;
 927                 $sk = $wgUser->getSkin();
 928
 929                 $search = SearchEngine::create();
 930                 $search->setLimitOffset( $this->limit, $this->offset );
 931                 $search->setNamespaces( $this->namespaces );
 932                 $search->showRedirects = $this->searchRedirects;
 933                 $search->prefix = $this->mPrefix;
 934                 $term = $search->transformSearchTerm($term);
 935
 936                 $this->setupPage( $term );
 937
 938                 $rewritten = $search->replacePrefixes($term);
 939                 $titleMatches = $search->searchTitle( $rewritten );
 940                 $textMatches = $search->searchText( $rewritten );
 941
 942                 // did you mean... suggestions
 943                 if($textMatches && $textMatches->hasSuggestion()){
 944                         $st = SpecialPage::getTitleFor( 'Search' );
 945                         $stParams = wfArrayToCGI( array(
 946                                         'search'        => $textMatches->getSuggestionQuery(),
 947                                         'fulltext'      => wfMsg('search')),
 948                                         $this->powerSearchOptions());
 949
 950                         $suggestLink = $sk->makeKnownLinkObj( $st,
 951                                 $textMatches->getSuggestionSnippet(),
 952                                 $stParams );
 953
 954                         $wgOut->addHTML('<div class="searchdidyoumean">'.wfMsg('search-suggest',$suggestLink).'</div>');
 955                 }
 956
 957                 $wgOut->addHTML( $extra );
 958
 959                 $wgOut->wrapWikiMsg( "<div class='mw-searchresult'>\n$1</div>", 'searchresulttext' );
 960
 961                 if( '' === trim( $term ) ) {
 962                         // Empty query -- straight view of search form
 963                         $wgOut->setSubtitle( '' );
 964                         $wgOut->addHTML( $this->powerSearchBox( $term ) );
 965                         $wgOut->addHTML( $this->powerSearchFocus() );
 966                         wfProfileOut( __METHOD__ );
 967                         return;
 968                 }
 969
 970                 global $wgDisableTextSearch;
 971                 if ( $wgDisableTextSearch ) {
 972                         global $wgSearchForwardUrl;
 973                         if( $wgSearchForwardUrl ) {
 974                                 $url = str_replace( '$1', urlencode( $term ), $wgSearchForwardUrl );
 975                                 $wgOut->redirect( $url );
 976                                 wfProfileOut( __METHOD__ );
 977                                 return;
 978                         }
 979                         global $wgInputEncoding;
 980                         $wgOut->addHTML(
 981                                 Xml::openElement( 'fieldset' ) .
 982                                 Xml::element( 'legend', null, wfMsg( 'search-external' ) ) .
 983                                 Xml::element( 'p', array( 'class' => 'mw-searchdisabled' ), wfMsg( 'searchdisabled' ) ) .
 984                                 wfMsg( 'googlesearch',
 985                                         htmlspecialchars( $term ),
 986                                         htmlspecialchars( $wgInputEncoding ),
 987                                         htmlspecialchars( wfMsg( 'searchbutton' ) )
 988                                 ) .
 989                                 Xml::closeElement( 'fieldset' )
 990                         );
 991                         wfProfileOut( __METHOD__ );
 992                         return;
 993                 }
 994
 995                 $wgOut->addHTML( $this->shortDialog( $term ) );
 996
 997                 // Sometimes the search engine knows there are too many hits
 998                 if ($titleMatches instanceof SearchResultTooMany) {
 999                         $wgOut->addWikiText( '==' . wfMsg( 'toomanymatches' ) . "==\n" );
1000                         $wgOut->addHTML( $this->powerSearchBox( $term ) );
1001                         $wgOut->addHTML( $this->powerSearchFocus() );
1002                         wfProfileOut( __METHOD__ );
1003                         return;
1004                 }
1005
1006                 // show number of results
1007                 $num = ( $titleMatches ? $titleMatches->numRows() : 0 )
1008                         + ( $textMatches ? $textMatches->numRows() : 0);
1009                 $totalNum = 0;
1010                 if($titleMatches && !is_null($titleMatches->getTotalHits()))
1011                         $totalNum += $titleMatches->getTotalHits();
1012                 if($textMatches && !is_null($textMatches->getTotalHits()))
1013                         $totalNum += $textMatches->getTotalHits();
1014                 if ( $num > 0 ) {
1015                         if ( $totalNum > 0 ){
1016                                 $top = wfMsgExt('showingresultstotal', array( 'parseinline' ),
1017                                         $this->offset+1, $this->offset+$num, $totalNum, $num );
1018                         } elseif ( $num >= $this->limit ) {
1019                                 $top = wfShowingResults( $this->offset, $this->limit );
1020                         } else {
1021                                 $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
1022                         }
1023                         $wgOut->addHTML( "<p class='mw-search-numberresults'>{$top}</p>\n" );
1024                 }
1025
1026                 // prev/next links
1027                 if( $num || $this->offset ) {
1028                         $prevnext = wfViewPrevNext( $this->offset, $this->limit,
1029                                 SpecialPage::getTitleFor( 'Search' ),
1030                                 wfArrayToCGI(
1031                                         $this->powerSearchOptions(),
1032                                         array( 'search' => $term ) ),
1033                                         ($num < $this->limit) );
1034                         $wgOut->addHTML( "<p class='mw-search-pager-top'>{$prevnext}</p>\n" );
1035                         wfRunHooks( 'SpecialSearchResults', array( $term, &$titleMatches, &$textMatches ) );
1036                 } else {
1037                         wfRunHooks( 'SpecialSearchNoResults', array( $term ) );
1038                 }
1039
1040                 if( $titleMatches ) {
1041                         if( $titleMatches->numRows() ) {
1042                                 $wgOut->wrapWikiMsg( "==$1==\n", 'titlematches' );
1043                                 $wgOut->addHTML( $this->showMatches( $titleMatches ) );
1044                         }
1045                         $titleMatches->free();
1046                 }
1047
1048                 if( $textMatches ) {
1049                         // output appropriate heading
1050                         if( $textMatches->numRows() ) {
1051                                 if($titleMatches)
1052                                         $wgOut->wrapWikiMsg( "==$1==\n", 'textmatches' );
1053                                 else // if no title matches the heading is redundant
1054                                         $wgOut->addHTML("<hr/>");
1055                         } elseif( $num == 0 ) {
1056                                 # Don't show the 'no text matches' if we received title matches
1057                                 $wgOut->wrapWikiMsg( "==$1==\n", 'notextmatches' );
1058                         }
1059                         // show interwiki results if any
1060                         if( $textMatches->hasInterwikiResults() )
1061                                 $wgOut->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(), $term ));
1062                         // show results
1063                         if( $textMatches->numRows() )
1064                                 $wgOut->addHTML( $this->showMatches( $textMatches ) );
1065
1066                         $textMatches->free();
1067                 }
1068
1069                 if ( $num == 0 ) {
1070                         $wgOut->addWikiMsg( 'nonefound' );
1071                 }
1072                 if( $num || $this->offset ) {
1073                         $wgOut->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
1074                 }
1075                 $wgOut->addHTML( $this->powerSearchBox( $term ) );
1076                 wfProfileOut( __METHOD__ );
1077         }
1078
1079         #------------------------------------------------------------------
1080         # Private methods below this line
1081
1082         /**
1083          *
1084          */
1085         function setupPage( $term ) {
1086                 global $wgOut;
1087                 if( !empty( $term ) ){
1088                         $wgOut->setPageTitle( wfMsg( 'searchresults') );
1089                         $wgOut->setHTMLTitle( wfMsg( 'pagetitle', wfMsg( 'searchresults-title', $term) ) );
1090                 }
1091                 $subtitlemsg = ( Title::newFromText( $term ) ? 'searchsubtitle' : 'searchsubtitleinvalid' );
1092                 $wgOut->setSubtitle( $wgOut->parse( wfMsg( $subtitlemsg, wfEscapeWikiText($term) ) ) );
1093                 $wgOut->setArticleRelated( false );
1094                 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1095         }
1096
1097         /**
1098          * Extract "power search" namespace settings from the request object,
1099          * returning a list of index numbers to search.
1100          *
1101          * @param WebRequest $request
1102          * @return array
1103          * @private
1104          */
1105         function powerSearch( &$request ) {
1106                 $arr = array();
1107                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
1108                         if( $request->getCheck( 'ns' . $ns ) ) {
1109                                 $arr[] = $ns;
1110                         }
1111                 }
1112                 return $arr;
1113         }
1114
1115         /**
1116          * Reconstruct the 'power search' options for links
1117          * @return array
1118          * @private
1119          */
1120         function powerSearchOptions() {
1121                 $opt = array();
1122                 foreach( $this->namespaces as $n ) {
1123                         $opt['ns' . $n] = 1;
1124                 }
1125                 $opt['redirs'] = $this->searchRedirects ? 1 : 0;
1126                 return $opt;
1127         }
1128
1129         /**
1130          * Show whole set of results
1131          *
1132          * @param SearchResultSet $matches
1133          */
1134         function showMatches( &$matches ) {
1135                 wfProfileIn( __METHOD__ );
1136
1137                 global $wgContLang;
1138                 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
1139
1140                 $out = "";
1141
1142                 $infoLine = $matches->getInfo();
1143                 if( !is_null($infoLine) )
1144                         $out .= "\n<!-- {$infoLine} -->\n";
1145
1146
1147                 $off = $this->offset + 1;
1148                 $out .= "<ul class='mw-search-results'>\n";
1149
1150                 while( $result = $matches->next() ) {
1151                         $out .= $this->showHit( $result, $terms );
1152                 }
1153                 $out .= "</ul>\n";
1154
1155                 // convert the whole thing to desired language variant
1156                 global $wgContLang;
1157                 $out = $wgContLang->convert( $out );
1158                 wfProfileOut( __METHOD__ );
1159                 return $out;
1160         }
1161
1162         /**
1163          * Format a single hit result
1164          * @param SearchResult $result
1165          * @param array $terms terms to highlight
1166          */
1167         function showHit( $result, $terms ) {
1168                 wfProfileIn( __METHOD__ );
1169                 global $wgUser, $wgContLang, $wgLang;
1170
1171                 if( $result->isBrokenTitle() ) {
1172                         wfProfileOut( __METHOD__ );
1173                         return "<!-- Broken link in search result -->\n";
1174                 }
1175
1176                 $t = $result->getTitle();
1177                 $sk = $wgUser->getSkin();
1178
1179                 $link = $sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
1180
1181                 //If page content is not readable, just return the title.
1182                 //This is not quite safe, but better than showing excerpts from non-readable pages
1183                 //Note that hiding the entry entirely would screw up paging.
1184                 if (!$t->userCanRead()) {
1185                         wfProfileOut( __METHOD__ );
1186                         return "<li>{$link}</li>\n";
1187                 }
1188
1189                 // If the page doesn't *exist*... our search index is out of date.
1190                 // The least confusing at this point is to drop the result.
1191                 // You may get less results, but... oh well. :P
1192                 if( $result->isMissingRevision() ) {
1193                         wfProfileOut( __METHOD__ );
1194                         return "<!-- missing page " .
1195                                 htmlspecialchars( $t->getPrefixedText() ) . "-->\n";
1196                 }
1197
1198                 // format redirects / relevant sections
1199                 $redirectTitle = $result->getRedirectTitle();
1200                 $redirectText = $result->getRedirectSnippet($terms);
1201                 $sectionTitle = $result->getSectionTitle();
1202                 $sectionText = $result->getSectionSnippet($terms);
1203                 $redirect = '';
1204                 if( !is_null($redirectTitle) )
1205                         $redirect = "<span class='searchalttitle'>"
1206                                 .wfMsg('search-redirect',$sk->makeKnownLinkObj( $redirectTitle, $redirectText))
1207                                 ."</span>";
1208                 $section = '';
1209                 if( !is_null($sectionTitle) )
1210                         $section = "<span class='searchalttitle'>"
1211                                 .wfMsg('search-section', $sk->makeKnownLinkObj( $sectionTitle, $sectionText))
1212                                 ."</span>";
1213
1214                 // format text extract
1215                 $extract = "<div class='searchresult'>".$result->getTextSnippet($terms)."</div>";
1216
1217                 // format score
1218                 if( is_null( $result->getScore() ) ) {
1219                         // Search engine doesn't report scoring info
1220                         $score = '';
1221                 } else {
1222                         $percent = sprintf( '%2.1f', $result->getScore() * 100 );
1223                         $score = wfMsg( 'search-result-score', $wgLang->formatNum( $percent ) )
1224                                 . ' - ';
1225                 }
1226
1227                 // format description
1228                 $byteSize = $result->getByteSize();
1229                 $wordCount = $result->getWordCount();
1230                 $timestamp = $result->getTimestamp();
1231                 $size = wfMsgExt( 'search-result-size', array( 'parsemag', 'escape' ),
1232                         $sk->formatSize( $byteSize ),
1233                         $wordCount );
1234                 $date = $wgLang->timeanddate( $timestamp );
1235
1236                 // link to related articles if supported
1237                 $related = '';
1238                 if( $result->hasRelated() ){
1239                         $st = SpecialPage::getTitleFor( 'Search' );
1240                         $stParams = wfArrayToCGI( $this->powerSearchOptions(),
1241                                 array('search'    => wfMsgForContent('searchrelated').':'.$t->getPrefixedText(),
1242                                       'fulltext'  => wfMsg('search') ));
1243
1244                         $related = ' -- ' . $sk->makeKnownLinkObj( $st,
1245                                 wfMsg('search-relatedarticle'), $stParams );
1246                 }
1247
1248                 // Include a thumbnail for media files...
1249                 if( $t->getNamespace() == NS_FILE ) {
1250                         $img = wfFindFile( $t );
1251                         if( $img ) {
1252                                 $thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
1253                                 if( $thumb ) {
1254                                         $desc = $img->getShortDesc();
1255                                         wfProfileOut( __METHOD__ );
1256                                         // Ugly table. :D
1257                                         // Float doesn't seem to interact well with the bullets.
1258                                         // Table messes up vertical alignment of the bullet, but I'm
1259                                         // not sure what more I can do about that. :(
1260                                         return "<li>" .
1261                                                 '<table class="searchResultImage">' .
1262                                                 '<tr>' .
1263                                                 '<td width="120" align="center">' .
1264                                                 $thumb->toHtml( array( 'desc-link' => true ) ) .
1265                                                 '</td>' .
1266                                                 '<td valign="top">' .
1267                                                 $link .
1268                                                 $extract .
1269                                                 "<div class='mw-search-result-data'>{$score}{$desc} - {$date}{$related}</div>" .
1270                                                 '</td>' .
1271                                                 '</tr>' .
1272                                                 '</table>' .
1273                                                 "</li>\n";
1274                                 }
1275                         }
1276                 }
1277
1278                 wfProfileOut( __METHOD__ );
1279                 return "<li>{$link} {$redirect} {$section} {$extract}\n" .
1280                         "<div class='mw-search-result-data'>{$score}{$size} - {$date}{$related}</div>" .
1281                         "</li>\n";
1282
1283         }
1284
1285         /**
1286          * Show results from other wikis
1287          *
1288          * @param SearchResultSet $matches
1289          */
1290         function showInterwiki( &$matches, $query ) {
1291                 wfProfileIn( __METHOD__ );
1292
1293                 global $wgContLang;
1294                 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
1295
1296                 $out = "<div id='mw-search-interwiki'><div id='mw-search-interwiki-caption'>".wfMsg('search-interwiki-caption')."</div>\n";
1297                 $off = $this->offset + 1;
1298                 $out .= "<ul start='{$off}' class='mw-search-iwresults'>\n";
1299
1300                 // work out custom project captions
1301                 $customCaptions = array();
1302                 $customLines = explode("\n",wfMsg('search-interwiki-custom')); // format per line <iwprefix>:<caption>
1303                 foreach($customLines as $line){
1304                         $parts = explode(":",$line,2);
1305                         if(count($parts) == 2) // validate line
1306                                 $customCaptions[$parts[0]] = $parts[1];
1307                 }
1308
1309
1310                 $prev = null;
1311                 while( $result = $matches->next() ) {
1312                         $out .= $this->showInterwikiHit( $result, $prev, $terms, $query, $customCaptions );
1313                         $prev = $result->getInterwikiPrefix();
1314                 }
1315                 // FIXME: should support paging in a non-confusing way (not sure how though, maybe via ajax)..
1316                 $out .= "</ul></div>\n";
1317
1318                 // convert the whole thing to desired language variant
1319                 global $wgContLang;
1320                 $out = $wgContLang->convert( $out );
1321                 wfProfileOut( __METHOD__ );
1322                 return $out;
1323         }
1324
1325         /**
1326          * Show single interwiki link
1327          *
1328          * @param SearchResult $result
1329          * @param string $lastInterwiki
1330          * @param array $terms
1331          * @param string $query
1332          * @param array $customCaptions iw prefix -> caption
1333          */
1334         function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) {
1335                 wfProfileIn( __METHOD__ );
1336                 global $wgUser, $wgContLang, $wgLang;
1337
1338                 if( $result->isBrokenTitle() ) {
1339                         wfProfileOut( __METHOD__ );
1340                         return "<!-- Broken link in search result -->\n";
1341                 }
1342
1343                 $t = $result->getTitle();
1344                 $sk = $wgUser->getSkin();
1345
1346                 $link = $sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
1347
1348                 // format redirect if any
1349                 $redirectTitle = $result->getRedirectTitle();
1350                 $redirectText = $result->getRedirectSnippet($terms);
1351                 $redirect = '';
1352                 if( !is_null($redirectTitle) )
1353                         $redirect = "<span class='searchalttitle'>"
1354                                 .wfMsg('search-redirect',$sk->makeKnownLinkObj( $redirectTitle, $redirectText))
1355                                 ."</span>";
1356
1357                 $out = "";
1358                 // display project name
1359                 if(is_null($lastInterwiki) || $lastInterwiki != $t->getInterwiki()){
1360                         if( key_exists($t->getInterwiki(),$customCaptions) )
1361                                 // captions from 'search-interwiki-custom'
1362                                 $caption = $customCaptions[$t->getInterwiki()];
1363                         else{
1364                                 // default is to show the hostname of the other wiki which might suck
1365                                 // if there are many wikis on one hostname
1366                                 $parsed = parse_url($t->getFullURL());
1367                                 $caption = wfMsg('search-interwiki-default', $parsed['host']);
1368                         }
1369                         // "more results" link (special page stuff could be localized, but we might not know target lang)
1370                         $searchTitle = Title::newFromText($t->getInterwiki().":Special:Search");
1371                         $searchLink = $sk->makeKnownLinkObj( $searchTitle, wfMsg('search-interwiki-more'),
1372                                 wfArrayToCGI(array('search' => $query, 'fulltext' => 'Search')));
1373                         $out .= "</ul><div class='mw-search-interwiki-project'><span class='mw-search-interwiki-more'>{$searchLink}</span>{$caption}</div>\n<ul>";
1374                 }
1375
1376                 $out .= "<li>{$link} {$redirect}</li>\n";
1377                 wfProfileOut( __METHOD__ );
1378                 return $out;
1379         }
1380
1381
1382         /**
1383          * Generates the power search box at bottom of [[Special:Search]]
1384          * @param $term string: search term
1385          * @return $out string: HTML form
1386          */
1387         function powerSearchBox( $term ) {
1388                 global $wgScript, $wgContLang;
1389
1390                 $namespaces = SearchEngine::searchableNamespaces();
1391
1392                 // group namespaces into rows according to subject; try not to make too
1393                 // many assumptions about namespace numbering
1394                 $rows = array();
1395                 foreach( $namespaces as $ns => $name ) {
1396                         $subj = MWNamespace::getSubject( $ns );
1397                         if( !array_key_exists( $subj, $rows ) ) {
1398                                 $rows[$subj] = "";
1399                         }
1400                         $name = str_replace( '_', ' ', $name );
1401                         if( '' == $name ) {
1402                                 $name = wfMsg( 'blanknamespace' );
1403                         }
1404                         $rows[$subj] .= Xml::openElement( 'td', array( 'style' => 'white-space: nowrap' ) ) .
1405                                         Xml::checkLabel( $name, "ns{$ns}", "mw-search-ns{$ns}", in_array( $ns, $this->namespaces ) ) .
1406                                         Xml::closeElement( 'td' ) . "\n";
1407                 }
1408                 $rows = array_values( $rows );
1409                 $numRows = count( $rows );
1410
1411                 // lay out namespaces in multiple floating two-column tables so they'll
1412                 // be arranged nicely while still accommodating different screen widths
1413                 $rowsPerTable = 3;  // seems to look nice
1414
1415                 // float to the right on RTL wikis
1416                 $tableStyle = ( $wgContLang->isRTL() ?
1417                                 'float: right; margin: 0 0 1em 1em' :
1418                                 'float: left; margin: 0 1em 1em 0' );
1419
1420                 $tables = "";
1421                 for( $i = 0; $i < $numRows; $i += $rowsPerTable ) {
1422                         $tables .= Xml::openElement( 'table', array( 'style' => $tableStyle ) );
1423                         for( $j = $i; $j < $i + $rowsPerTable && $j < $numRows; $j++ ) {
1424                                 $tables .= "<tr>\n" . $rows[$j] . "</tr>";
1425                         }
1426                         $tables .= Xml::closeElement( 'table' ) . "\n";
1427                 }
1428
1429                 $redirect = Xml::check( 'redirs', $this->searchRedirects, array( 'value' => '1', 'id' => 'redirs' ) );
1430                 $redirectLabel = Xml::label( wfMsg( 'powersearch-redir' ), 'redirs' );
1431                 $searchField = Xml::input( 'search', 50, $term, array( 'type' => 'text', 'id' => 'powerSearchText' ) );
1432                 $searchButton = Xml::submitButton( wfMsg( 'powersearch' ), array( 'name' => 'fulltext' ) ) . "\n";
1433                 $searchTitle = SpecialPage::getTitleFor( 'Search' );
1434                 $searchHiddens = Xml::hidden( 'title', $searchTitle->getPrefixedText() ) . "\n";
1435                 $searchHiddens .= Xml::hidden( 'fulltext', 'Advanced search' ) . "\n";
1436
1437                 $out = Xml::openElement( 'form', array( 'id' => 'powersearch', 'method' => 'get', 'action' => $wgScript ) ) .
1438                         Xml::fieldset( wfMsg( 'powersearch-legend' ),
1439                                 "<p>" .
1440                                 wfMsgExt( 'powersearch-ns', array( 'parseinline' ) ) .
1441                                 "</p>\n" .
1442                                 $tables .
1443                                 "<hr style=\"clear: both\" />\n" .
1444                                 "<p>" .
1445                                 $redirect . " " . $redirectLabel .
1446                                 "</p>\n" .
1447                                 wfMsgExt( 'powersearch-field', array( 'parseinline' ) ) .
1448                                 "&nbsp;" .
1449                                 $searchField .
1450                                 "&nbsp;" .
1451                                 $searchHiddens .
1452                                 $searchButton ) .
1453                         "</form>";
1454
1455                 return $out;
1456         }
1457
1458         function powerSearchFocus() {
1459                 global $wgJsMimeType;
1460                 return "<script type=\"$wgJsMimeType\">" .
1461                         "hookEvent(\"load\", function(){" .
1462                                 "document.getElementById('powerSearchText').focus();" .
1463                         "});" .
1464                         "</script>";
1465         }
1466
1467         function shortDialog($term) {
1468                 global $wgScript;
1469
1470                 $out  = Xml::openElement( 'form', array(
1471                         'id' => 'search',
1472                         'method' => 'get',
1473                         'action' => $wgScript
1474                 ));
1475                 $searchTitle = SpecialPage::getTitleFor( 'Search' );
1476                 $out .= Xml::input( 'search', 50, $term, array( 'type' => 'text', 'id' => 'searchText' ) ) . ' ';
1477                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
1478                         if( in_array( $ns, $this->namespaces ) ) {
1479                                 $out .= Xml::hidden( "ns{$ns}", '1' );
1480                         }
1481                 }
1482                 $out .= Xml::hidden( 'title', $searchTitle->getPrefixedText() );
1483                 $out .= Xml::hidden( 'fulltext', 'Search' );
1484                 $out .= Xml::submitButton( wfMsg( 'searchbutton' ), array( 'name' => 'fulltext' ) );
1485                 $out .= Xml::closeElement( 'form' );
1486
1487                 return $out;
1488         }
1489 }