includes/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  * @addtogroup SpecialPage
  23  */
  24
  25 /**
  26  * Entry point
  27  *
  28  * @param $par String: (default '')
  29  */
  30 function wfSpecialSearch( $par = '' ) {
  31         global $wgRequest, $wgUser;
  32
  33         $search = $wgRequest->getText( 'search', $par );
  34         $searchPage = new SpecialSearch( $wgRequest, $wgUser );
  35         if( $wgRequest->getVal( 'fulltext' ) ||
  36                 !is_null( $wgRequest->getVal( 'offset' ) ) ||
  37                 !is_null ($wgRequest->getVal( 'searchx' ) ) ) {
  38                 $searchPage->showResults( $search );
  39         } else {
  40                 $searchPage->goResult( $search );
  41         }
  42 }
  43
  44 /**
  45  * implements Special:Search - Run text & title search and display the output
  46  * @addtogroup SpecialPage
  47  */
  48 class SpecialSearch {
  49
  50         /**
  51          * Set up basic search parameters from the request and user settings.
  52          * Typically you'll pass $wgRequest and $wgUser.
  53          *
  54          * @param WebRequest $request
  55          * @param User $user
  56          * @public
  57          */
  58         function SpecialSearch( &$request, &$user ) {
  59                 list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
  60
  61                 if( $request->getCheck( 'searchx' ) ) {
  62                         $this->namespaces = $this->powerSearch( $request );
  63                 } else {
  64                         $this->namespaces = $this->userNamespaces( $user );
  65                 }
  66
  67                 $this->searchRedirects = $request->getcheck( 'redirs' ) ? true : false;
  68         }
  69
  70         /**
  71          * If an exact title match can be found, jump straight ahead to it.
  72          * @param string $term
  73          * @public
  74          */
  75         function goResult( $term ) {
  76                 global $wgOut;
  77                 global $wgGoToEdit;
  78
  79                 $this->setupPage( $term );
  80
  81                 # Try to go to page as entered.
  82                 $t = Title::newFromText( $term );
  83
  84                 # If the string cannot be used to create a title
  85                 if( is_null( $t ) ){
  86                         return $this->showResults( $term );
  87                 }
  88
  89                 # If there's an exact or very near match, jump right there.
  90                 $t = SearchEngine::getNearMatch( $term );
  91                 if( !is_null( $t ) ) {
  92                         $wgOut->redirect( $t->getFullURL() );
  93                         return;
  94                 }
  95
  96                 # No match, generate an edit URL
  97                 $t = Title::newFromText( $term );
  98                 if( ! is_null( $t ) ) {
  99                         wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) );
 100                         # If the feature is enabled, go straight to the edit page
 101                         if ( $wgGoToEdit ) {
 102                                 $wgOut->redirect( $t->getFullURL( 'action=edit' ) );
 103                                 return;
 104                         }
 105                 }
 106                 $wgOut->addWikiText( wfMsg( 'noexactmatch', wfEscapeWikiText( $term ) ) );
 107
 108                 return $this->showResults( $term );
 109         }
 110
 111         /**
 112          * @param string $term
 113          * @public
 114          */
 115         function showResults( $term ) {
 116                 $fname = 'SpecialSearch::showResults';
 117                 wfProfileIn( $fname );
 118
 119                 $this->setupPage( $term );
 120
 121                 global $wgOut;
 122                 $wgOut->addWikiText( wfMsg( 'searchresulttext' ) );
 123
 124                 #if ( !$this->parseQuery() ) {
 125                 if( '' === trim( $term ) ) {
 126                         $wgOut->setSubtitle( '' );
 127                         $wgOut->addHTML( $this->powerSearchBox( $term ) );
 128                         wfProfileOut( $fname );
 129                         return;
 130                 }
 131
 132                 global $wgDisableTextSearch;
 133                 if ( $wgDisableTextSearch ) {
 134                         global $wgForwardSearchUrl;
 135                         if( $wgForwardSearchUrl ) {
 136                                 $url = str_replace( '$1', urlencode( $term ), $wgForwardSearchUrl );
 137                                 $wgOut->redirect( $url );
 138                                 return;
 139                         }
 140                         global $wgInputEncoding;
 141                         $wgOut->addHTML( wfMsg( 'searchdisabled' ) );
 142                         $wgOut->addHTML(
 143                                 wfMsg( 'googlesearch',
 144                                         htmlspecialchars( $term ),
 145                                         htmlspecialchars( $wgInputEncoding ),
 146                                         htmlspecialchars( wfMsg( 'searchbutton' ) )
 147                                 )
 148                         );
 149                         wfProfileOut( $fname );
 150                         return;
 151                 }
 152
 153                 $search = SearchEngine::create();
 154                 $search->setLimitOffset( $this->limit, $this->offset );
 155                 $search->setNamespaces( $this->namespaces );
 156                 $search->showRedirects = $this->searchRedirects;
 157                 $titleMatches = $search->searchTitle( $term );
 158                 $textMatches = $search->searchText( $term );
 159
 160                 $num = ( $titleMatches ? $titleMatches->numRows() : 0 )
 161                         + ( $textMatches ? $textMatches->numRows() : 0);
 162                 if ( $num > 0 ) {
 163                         if ( $num >= $this->limit ) {
 164                                 $top = wfShowingResults( $this->offset, $this->limit );
 165                         } else {
 166                                 $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
 167                         }
 168                         $wgOut->addHTML( "<p>{$top}</p>\n" );
 169                 }
 170
 171                 if( $num || $this->offset ) {
 172                         $prevnext = wfViewPrevNext( $this->offset, $this->limit,
 173                                 SpecialPage::getTitleFor( 'Search' ),
 174                                 wfArrayToCGI(
 175                                         $this->powerSearchOptions(),
 176                                         array( 'search' => $term ) ),
 177                                         ($num < $this->limit) );
 178                         $wgOut->addHTML( "<br />{$prevnext}\n" );
 179                 }
 180
 181                 if( $titleMatches ) {
 182                         if( $titleMatches->numRows() ) {
 183                                 $wgOut->addWikiText( '==' . wfMsg( 'titlematches' ) . "==\n" );
 184                                 $wgOut->addHTML( $this->showMatches( $titleMatches ) );
 185                         } else {
 186                                 $wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
 187                         }
 188                         $titleMatches->free();
 189                 }
 190
 191                 if( $textMatches ) {
 192                         if( $textMatches->numRows() ) {
 193                                 $wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
 194                                 $wgOut->addHTML( $this->showMatches( $textMatches ) );
 195                         } elseif( $num == 0 ) {
 196                                 # Don't show the 'no text matches' if we received title matches
 197                                 $wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
 198                         }
 199                         $textMatches->free();
 200                 }
 201
 202                 if ( $num == 0 ) {
 203                         $wgOut->addWikiText( wfMsg( 'nonefound' ) );
 204                 }
 205                 if( $num || $this->offset ) {
 206                         $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
 207                 }
 208                 $wgOut->addHTML( $this->powerSearchBox( $term ) );
 209                 wfProfileOut( $fname );
 210         }
 211
 212         #------------------------------------------------------------------
 213         # Private methods below this line
 214
 215         /**
 216          *
 217          */
 218         function setupPage( $term ) {
 219                 global $wgOut;
 220                 if ( $term ) {
 221                         $titlemsg = wfMsgHtml( 'searchresults-title', $term );
 222                 } else {
 223                         // Direct call of Special:Search or empty search string
 224                         $titlemsg = wfMsgHtml( 'search' );
 225                 }
 226                 $wgOut->setPageTitle( $titlemsg );
 227                 $subtitlemsg = ( Title::newFromText( $term ) ? 'searchsubtitle' : 'searchsubtitleinvalid' );
 228                 $wgOut->setSubtitle( $wgOut->parse( wfMsg( $subtitlemsg, wfEscapeWikiText( $term ) ) ) );
 229                 $wgOut->setArticleRelated( false );
 230                 $wgOut->setRobotpolicy( 'noindex,nofollow' );
 231         }
 232
 233         /**
 234          * Extract default namespaces to search from the given user's
 235          * settings, returning a list of index numbers.
 236          *
 237          * @param User $user
 238          * @return array
 239          * @private
 240          */
 241         function userNamespaces( &$user ) {
 242                 $arr = array();
 243                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 244                         if( $user->getOption( 'searchNs' . $ns ) ) {
 245                                 $arr[] = $ns;
 246                         }
 247                 }
 248                 return $arr;
 249         }
 250
 251         /**
 252          * Extract "power search" namespace settings from the request object,
 253          * returning a list of index numbers to search.
 254          *
 255          * @param WebRequest $request
 256          * @return array
 257          * @private
 258          */
 259         function powerSearch( &$request ) {
 260                 $arr = array();
 261                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 262                         if( $request->getCheck( 'ns' . $ns ) ) {
 263                                 $arr[] = $ns;
 264                         }
 265                 }
 266                 return $arr;
 267         }
 268
 269         /**
 270          * Reconstruct the 'power search' options for links
 271          * @return array
 272          * @private
 273          */
 274         function powerSearchOptions() {
 275                 $opt = array();
 276                 foreach( $this->namespaces as $n ) {
 277                         $opt['ns' . $n] = 1;
 278                 }
 279                 $opt['redirs'] = $this->searchRedirects ? 1 : 0;
 280                 $opt['searchx'] = 1;
 281                 return $opt;
 282         }
 283
 284         /**
 285          * @param SearchResultSet $matches
 286          * @param string $terms partial regexp for highlighting terms
 287          */
 288         function showMatches( &$matches ) {
 289                 $fname = 'SpecialSearch::showMatches';
 290                 wfProfileIn( $fname );
 291
 292                 global $wgContLang;
 293                 $tm = $wgContLang->convertForSearchResult( $matches->termMatches() );
 294                 $terms = implode( '|', $tm );
 295
 296                 $off = $this->offset + 1;
 297                 $out = "<ol start='{$off}'>\n";
 298
 299                 while( $result = $matches->next() ) {
 300                         $out .= $this->showHit( $result, $terms );
 301                 }
 302                 $out .= "</ol>\n";
 303
 304                 // convert the whole thing to desired language variant
 305                 global $wgContLang;
 306                 $out = $wgContLang->convert( $out );
 307                 wfProfileOut( $fname );
 308                 return $out;
 309         }
 310
 311         /**
 312          * Format a single hit result
 313          * @param SearchResult $result
 314          * @param string $terms partial regexp for highlighting terms
 315          */
 316         function showHit( $result, $terms ) {
 317                 $fname = 'SpecialSearch::showHit';
 318                 wfProfileIn( $fname );
 319                 global $wgUser, $wgContLang, $wgLang;
 320
 321                 $t = $result->getTitle();
 322                 if( is_null( $t ) ) {
 323                         wfProfileOut( $fname );
 324                         return "<!-- Broken link in search result -->\n";
 325                 }
 326                 $sk = $wgUser->getSkin();
 327
 328                 $contextlines = $wgUser->getOption( 'contextlines',  5 );
 329                 $contextchars = $wgUser->getOption( 'contextchars', 50 );
 330
 331                 $link = $sk->makeKnownLinkObj( $t );
 332
 333                 //If page content is not readable, just return the title.
 334                 //This is not quite safe, but better than showing excerpts from non-readable pages
 335                 //Note that hiding the entry entirely would screw up paging.
 336                 if (!$t->userCanRead()) {
 337                         return "<li>{$link}</li>\n";
 338                 }
 339
 340                 $revision = Revision::newFromTitle( $t );
 341                 $text = $revision->getText();
 342                 $size = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
 343                         $wgLang->formatNum( strlen( $text ) ) );
 344
 345                 $lines = explode( "\n", $text );
 346
 347                 $max = intval( $contextchars ) + 1;
 348                 $pat1 = "/(.*)($terms)(.{0,$max})/i";
 349
 350                 $lineno = 0;
 351
 352                 $extract = '';
 353                 wfProfileIn( "$fname-extract" );
 354                 foreach ( $lines as $line ) {
 355                         if ( 0 == $contextlines ) {
 356                                 break;
 357                         }
 358                         ++$lineno;
 359                         $m = array();
 360                         if ( ! preg_match( $pat1, $line, $m ) ) {
 361                                 continue;
 362                         }
 363                         --$contextlines;
 364                         $pre = $wgContLang->truncate( $m[1], -$contextchars, '...' );
 365
 366                         if ( count( $m ) < 3 ) {
 367                                 $post = '';
 368                         } else {
 369                                 $post = $wgContLang->truncate( $m[3], $contextchars, '...' );
 370                         }
 371
 372                         $found = $m[2];
 373
 374                         $line = htmlspecialchars( $pre . $found . $post );
 375                         $pat2 = '/(' . $terms . ")/i";
 376                         $line = preg_replace( $pat2,
 377                           "<span class='searchmatch'>\\1</span>", $line );
 378
 379                         $extract .= "<br /><small>{$lineno}: {$line}</small>\n";
 380                 }
 381                 wfProfileOut( "$fname-extract" );
 382                 wfProfileOut( $fname );
 383                 return "<li>{$link} ({$size}){$extract}</li>\n";
 384         }
 385
 386         function powerSearchBox( $term ) {
 387                 $namespaces = '';
 388                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 389                         $checked = in_array( $ns, $this->namespaces )
 390                                 ? ' checked="checked"'
 391                                 : '';
 392                         $name = str_replace( '_', ' ', $name );
 393                         if( '' == $name ) {
 394                                 $name = wfMsg( 'blanknamespace' );
 395                         }
 396                         $namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
 397                           "ns{$ns}\"{$checked} />{$name}</label>\n";
 398                 }
 399
 400                 $checked = $this->searchRedirects
 401                         ? ' checked="checked"'
 402                         : '';
 403                 $redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
 404
 405                 $searchField = '<input type="text" name="search" value="' .
 406                         htmlspecialchars( $term ) ."\" size=\"16\" />\n";
 407
 408                 $searchButton = '<input type="submit" name="searchx" value="' .
 409                   htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
 410
 411                 $ret = wfMsg( 'powersearchtext',
 412                         $namespaces, $redirect, $searchField,
 413                         '', '', '', '', '', # Dummy placeholders
 414                         $searchButton );
 415
 416                 $title = SpecialPage::getTitleFor( 'Search' );
 417                 $action = $title->escapeLocalURL();
 418                 return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
 419                   "action=\"$action\">\n{$ret}\n</form>\n";
 420         }
 421 }
 422
 423