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