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->addWikiText(
 138                                 '==' . wfMsg( 'badquery' ) . "==\n" .
 139                                 wfMsg( 'badquerytext' ) );
 140                         wfProfileOut( $fname );
 141                         return;
 142                 }
 143
 144                 global $wgDisableTextSearch;
 145                 if ( $wgDisableTextSearch ) {
 146                         global $wgForwardSearchUrl;
 147                         if( $wgForwardSearchUrl ) {
 148                                 $url = str_replace( '$1', urlencode( $term ), $wgForwardSearchUrl );
 149                                 $wgOut->redirect( $url );
 150                                 return;
 151                         }
 152                         global $wgInputEncoding;
 153                         $wgOut->addHTML( wfMsg( 'searchdisabled' ) );
 154                         $wgOut->addHTML( wfMsg( 'googlesearch',
 155                                 htmlspecialchars( $term ),
 156                                 htmlspecialchars( $wgInputEncoding ) ) );
 157                         wfProfileOut( $fname );
 158                         return;
 159                 }
 160
 161                 $search =& SearchEngine::create();
 162                 $search->setLimitOffset( $this->limit, $this->offset );
 163                 $search->setNamespaces( $this->namespaces );
 164                 $titleMatches = $search->searchTitle( $term );
 165                 $textMatches = $search->searchText( $term );
 166
 167                 $num = $titleMatches->numRows() + $textMatches->numRows();
 168                 if ( $num >= $this->limit ) {
 169                         $top = wfShowingResults( $this->offset, $this->limit );
 170                 } else {
 171                         $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
 172                 }
 173                 $wgOut->addHTML( "<p>{$top}</p>\n" );
 174
 175                 if( $num || $this->offset ) {
 176                         $prevnext = wfViewPrevNext( $this->offset, $this->limit,
 177                                 'Special:Search',
 178                                 wfArrayToCGI(
 179                                         $this->powerSearchOptions(),
 180                                         array( 'search' => $term ) ) );
 181                         $wgOut->addHTML( "<br />{$prevnext}\n" );
 182                 }
 183
 184                 global $wgContLang;
 185                 $tm = $wgContLang->convertForSearchResult( $search->termMatches() );
 186                 $terms = implode( '|', $tm );
 187
 188                 if( $titleMatches->numRows() ) {
 189                         $wgOut->addWikiText( '==' . wfMsg( 'titlematches' ) . "==\n" );
 190                         $wgOut->addHTML( $this->showMatches( $titleMatches, $terms ) );
 191                 } else {
 192                         $wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
 193                 }
 194
 195                 if( $textMatches->numRows() ) {
 196                         $wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
 197                         $wgOut->addHTML( $this->showMatches( $textMatches, $terms ) );
 198                 } elseif( $num == 0 ) {
 199                         # Don't show the 'no text matches' if we received title matches
 200                         $wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
 201                 }
 202
 203                 if ( $num == 0 ) {
 204                         $wgOut->addWikiText( wfMsg( 'nonefound' ) );
 205                 }
 206                 if( $num || $this->offset ) {
 207                         $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
 208                 }
 209                 $wgOut->addHTML( $this->powerSearchBox( $term ) );
 210                 wfProfileOut( $fname );
 211         }
 212
 213         #------------------------------------------------------------------
 214         # Private methods below this line
 215
 216         /**
 217          *
 218          */
 219         function setupPage( $term ) {
 220                 global $wgOut;
 221                 $wgOut->setPageTitle( wfMsg( 'searchresults' ) );
 222                 $wgOut->setSubtitle( wfMsg( 'searchquery', htmlspecialchars( $term ) ) );
 223                 $wgOut->setArticleRelated( false );
 224                 $wgOut->setRobotpolicy( 'noindex,nofollow' );
 225         }
 226
 227         /**
 228          * Extract default namespaces to search from the given user's
 229          * settings, returning a list of index numbers.
 230          *
 231          * @param User $user
 232          * @return array
 233          * @access private
 234          */
 235         function userNamespaces( &$user ) {
 236                 $arr = array();
 237                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 238                         if( $user->getOption( 'searchNs' . $ns ) ) {
 239                                 $arr[] = $ns;
 240                         }
 241                 }
 242                 return $arr;
 243         }
 244
 245         /**
 246          * Extract "power search" namespace settings from the request object,
 247          * returning a list of index numbers to search.
 248          *
 249          * @param WebRequest $request
 250          * @return array
 251          * @access private
 252          */
 253         function powerSearch( &$request ) {
 254                 $arr = array();
 255                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 256                         if( $request->getCheck( 'ns' . $ns ) ) {
 257                                 $arr[] = $ns;
 258                         }
 259                 }
 260                 return $arr;
 261         }
 262
 263         /**
 264          * Reconstruct the 'power search' options for links
 265          * @return array
 266          * @access private
 267          */
 268         function powerSearchOptions() {
 269                 $opt = array();
 270                 foreach( $this->namespaces as $n ) {
 271                         $opt['ns' . $n] = 1;
 272                 }
 273                 $opt['redirs'] = $this->searchRedirects ? 1 : 0;
 274                 $opt['searchx'] = 1;
 275                 return $opt;
 276         }
 277
 278         /**
 279          * @param ResultWrapper $matches
 280          * @param string $terms partial regexp for highlighting terms
 281          */
 282         function showMatches( &$matches, $terms ) {
 283                 $fname = 'SpecialSearch::showMatches';
 284                 wfProfileIn( $fname );
 285
 286                 global $wgOut;
 287                 $off = $this->offset + 1;
 288                 $out = "<ol start='{$off}'>\n";
 289
 290                 while( $row = $matches->fetchObject() ) {
 291                         $out .= $this->showHit( $row, $terms );
 292                 }
 293                 $out .= "</ol>\n";
 294
 295                 // convert the whole thing to desired language variant
 296                 global $wgContLang;
 297                 $out = $wgContLang->convert( $out );
 298                 wfProfileOut( $fname );
 299                 return $out;
 300         }
 301
 302         /**
 303          * Format a single hit result
 304          * @param object $row
 305          * @param string $terms partial regexp for highlighting terms
 306          */
 307         function showHit( $row, $terms ) {
 308                 $fname = 'SpecialSearch::showHit';
 309                 wfProfileIn( $fname );
 310                 global $wgUser, $wgContLang;
 311
 312                 $t = Title::makeTitle( $row->page_namespace, $row->page_title );
 313                 if( is_null( $t ) ) {
 314                         wfProfileOut( $fname );
 315                         return "<!-- Broken link in search result -->\n";
 316                 }
 317                 $sk =& $wgUser->getSkin();
 318
 319                 $contextlines = $wgUser->getOption( 'contextlines' );
 320                 if ( '' == $contextlines ) { $contextlines = 5; }
 321                 $contextchars = $wgUser->getOption( 'contextchars' );
 322                 if ( '' == $contextchars ) { $contextchars = 50; }
 323
 324                 $link = $sk->makeKnownLinkObj( $t, '' );
 325                 $text = Revision::getRevisionText( $row );
 326                 $size = wfMsg( 'nbytes', strlen( $text ) );
 327
 328                 $lines = explode( "\n", $text );
 329
 330                 $max = IntVal( $contextchars ) + 1;
 331                 $pat1 = "/(.*)($terms)(.{0,$max})/i";
 332
 333                 $lineno = 0;
 334
 335                 $extract = '';
 336                 wfProfileIn( "$fname-extract" );
 337                 foreach ( $lines as $line ) {
 338                         if ( 0 == $contextlines ) {
 339                                 break;
 340                         }
 341                         ++$lineno;
 342                         if ( ! preg_match( $pat1, $line, $m ) ) {
 343                                 continue;
 344                         }
 345                         --$contextlines;
 346                         $pre = $wgContLang->truncate( $m[1], -$contextchars, '...' );
 347
 348                         if ( count( $m ) < 3 ) {
 349                                 $post = '';
 350                         } else {
 351                                 $post = $wgContLang->truncate( $m[3], $contextchars, '...' );
 352                         }
 353
 354                         $found = $m[2];
 355
 356                         $line = htmlspecialchars( $pre . $found . $post );
 357                         $pat2 = '/(' . $terms . ")/i";
 358                         $line = preg_replace( $pat2,
 359                           "<span class='searchmatch'>\\1</span>", $line );
 360
 361                         $extract .= "<br /><small>{$lineno}: {$line}</small>\n";
 362                 }
 363                 wfProfileOut( "$fname-extract" );
 364                 wfProfileOut( $fname );
 365                 return "<li>{$link} ({$size}){$extract}</li>\n";
 366         }
 367
 368         function powerSearchBox( $term ) {
 369                 $namespaces = '';
 370                 foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
 371                         $checked = in_array( $ns, $this->namespaces )
 372                                 ? ' checked="checked"'
 373                                 : '';
 374                         $name = str_replace( '_', ' ', $name );
 375                         if( '' == $name ) {
 376                                 $name = wfMsg( 'blanknamespace' );
 377                         }
 378                         $namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
 379                           "ns{$ns}\"{$checked} />{$name}</label>\n";
 380                 }
 381
 382                 $checked = $this->searchRedirects
 383                         ? ' checked="checked"'
 384                         : '';
 385                 $redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
 386
 387                 $searchField = "<input type='text' name=\"search\" value=\"" .
 388                         htmlspecialchars( $term ) ."\" width=\"80\" />\n";
 389
 390                 $searchButton = '<input type="submit" name="searchx" value="' .
 391                   htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
 392
 393                 $ret = wfMsg( 'powersearchtext',
 394                         $namespaces, $redirect, $searchField,
 395                         '', '', '', '', '', # Dummy placeholders
 396                         $searchButton );
 397
 398                 $title = Title::makeTitle( NS_SPECIAL, 'Search' );
 399                 $action = $title->escapeLocalURL();
 400                 return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
 401                   "action=\"$action\">\n{$ret}\n</form>\n";
 402         }
 403 }
 404
 405 ?>