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