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