Revert r32811 -- regression in search.
[lhc/web/wiklou.git] / includes / SpecialSearch.php
index a8aadfa..b16ceb1 100644 (file)
@@ -19,8 +19,7 @@
 
 /**
  * Run text & title search and display the output
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
  */
 
 /**
@@ -31,7 +30,7 @@
 function wfSpecialSearch( $par = '' ) {
        global $wgRequest, $wgUser;
 
-       $search = $wgRequest->getText( 'search', $par );
+       $search = str_replace( "\n", " ", $wgRequest->getText( 'search', $par ) );
        $searchPage = new SpecialSearch( $wgRequest, $wgUser );
        if( $wgRequest->getVal( 'fulltext' ) ||
                !is_null( $wgRequest->getVal( 'offset' ) ) ||
@@ -43,9 +42,8 @@ function wfSpecialSearch( $par = '' ) {
 }
 
 /**
- * @todo document
- * @package MediaWiki
- * @subpackage SpecialPage
+ * implements Special:Search - Run text & title search and display the output
+ * @addtogroup SpecialPage
  */
 class SpecialSearch {
 
@@ -60,9 +58,8 @@ class SpecialSearch {
        function SpecialSearch( &$request, &$user ) {
                list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
 
-               if( $request->getCheck( 'searchx' ) ) {
-                       $this->namespaces = $this->powerSearch( $request );
-               } else {
+               $this->namespaces = $this->powerSearch( $request );
+               if( empty( $this->namespaces ) ) {
                        $this->namespaces = $this->userNamespaces( $user );
                }
 
@@ -70,19 +67,17 @@ class SpecialSearch {
        }
 
        /**
-        * If an exact title match can be found, jump straight ahead to
+        * If an exact title match can be found, jump straight ahead to it.
         * @param string $term
         * @public
         */
        function goResult( $term ) {
                global $wgOut;
                global $wgGoToEdit;
-               global $wgContLang;
 
                $this->setupPage( $term );
 
                # Try to go to page as entered.
-               #
                $t = Title::newFromText( $term );
 
                # If the string cannot be used to create a title
@@ -97,35 +92,21 @@ class SpecialSearch {
                        return;
                }
 
-               # if language supports variants, search in all variants
-               if(sizeof($wgContLang->getVariants())>1){
-                       $allTermVariants = $wgContLang->convertLinkToAllVariants($term);
-
-                       foreach($allTermVariants as $termVariant){
-                               $t = SearchEngine::getNearMatch( $termVariant );
-                               if( !is_null( $t ) ) {
-                                       $wgOut->redirect( $t->getFullURL() );
-                                       wfProfileOut( $fname );
-                                       return;
-                               }
-                       }
-               }
-
                # No match, generate an edit URL
                $t = Title::newFromText( $term );
-               if( is_null( $t ) ) {
-                       $editurl = ''; # hrm...
-               } else {
+               if( ! is_null( $t ) ) {
                        wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) );
                        # If the feature is enabled, go straight to the edit page
                        if ( $wgGoToEdit ) {
                                $wgOut->redirect( $t->getFullURL( 'action=edit' ) );
                                return;
-                       } else {
-                               $editurl = $t->escapeLocalURL( 'action=edit' );
-                       }
+                       } 
+               }
+               if( $t->quickUserCan( 'create' ) && $t->quickUserCan( 'edit' ) ) {
+                       $wgOut->addWikiMsg( 'noexactmatch', wfEscapeWikiText( $term ) );
+               } else {
+                       $wgOut->addWikiMsg( 'noexactmatch-nocreate', wfEscapeWikiText( $term ) );
                }
-               $wgOut->addWikiText( wfMsg( 'noexactmatch', wfEscapeWikiText( $term ) ) );
 
                return $this->showResults( $term );
        }
@@ -140,14 +121,14 @@ class SpecialSearch {
 
                $this->setupPage( $term );
 
-               global $wgUser, $wgOut;
-               $sk = $wgUser->getSkin();
-               $wgOut->addWikiText( wfMsg( 'searchresulttext' ) );
+               global $wgOut;
+               $wgOut->addWikiMsg( 'searchresulttext' );
 
-               #if ( !$this->parseQuery() ) {
                if( '' === trim( $term ) ) {
+                       // Empty query -- straight view of search form
                        $wgOut->setSubtitle( '' );
                        $wgOut->addHTML( $this->powerSearchBox( $term ) );
+                       $wgOut->addHTML( $this->powerSearchFocus() );
                        wfProfileOut( $fname );
                        return;
                }
@@ -161,64 +142,109 @@ class SpecialSearch {
                                return;
                        }
                        global $wgInputEncoding;
-                       $wgOut->addHTML( wfMsg( 'searchdisabled' ) );
-                       $wgOut->addHTML(
+                       $wgOut->addHTML( 
+                               Xml::openElement( 'fieldset' ) .
+                               Xml::element( 'legend', null, wfMsg( 'search-external' ) ) .
+                               Xml::element( 'p', array( 'class' => 'mw-searchdisabled' ), wfMsg( 'searchdisabled' ) ) .
                                wfMsg( 'googlesearch',
                                        htmlspecialchars( $term ),
                                        htmlspecialchars( $wgInputEncoding ),
-                                       htmlspecialchars( wfMsg( 'search' ) )
-                               )
+                                       htmlspecialchars( wfMsg( 'searchbutton' ) )
+                               ) .
+                               Xml::closeElement( 'fieldset' )
                        );
                        wfProfileOut( $fname );
                        return;
                }
+               
+               $wgOut->addHTML( $this->shortDialog( $term ) );
 
                $search = SearchEngine::create();
                $search->setLimitOffset( $this->limit, $this->offset );
                $search->setNamespaces( $this->namespaces );
-               $search->showRedirects = $this->searchRedirects;
-               $titleMatches = $search->searchTitle( $term );
-               $textMatches = $search->searchText( $term );
+               $search->showRedirects = $this->searchRedirects;                
+               $rewritten = $search->replacePrefixes($term);
+               
+               $titleMatches = $search->searchTitle( $rewritten );
+
+               // Sometimes the search engine knows there are too many hits
+               if ($titleMatches instanceof SearchResultTooMany) {
+                       $wgOut->addWikiText( '==' . wfMsg( 'toomanymatches' ) . "==\n" );
+                       $wgOut->addHTML( $this->powerSearchBox( $term ) );
+                       $wgOut->addHTML( $this->powerSearchFocus() );
+                       wfProfileOut( $fname );
+                       return;
+               }
+               $textMatches = $search->searchText( $rewritten );
+               
+               // did you mean...
+               if($textMatches && $textMatches->hasSuggestion()){
+                       global $wgScript;
+                       $fulltext = htmlspecialchars(wfMsg('search'));
+                       $suggestLink = '<a href="'.$wgScript.'?title=Special:Search&amp;search='.
+                               urlencode($textMatches->getSuggestionQuery()).'&amp;fulltext='.$fulltext.'">'
+                               .$textMatches->getSuggestionSnippet().'</a>';
+                       $wgOut->addHTML('<div class="searchdidyoumean">'.wfMsg('search-suggest',$suggestLink).'</div>');
+               } 
+               
 
                $num = ( $titleMatches ? $titleMatches->numRows() : 0 )
                        + ( $textMatches ? $textMatches->numRows() : 0);
-               if ( $num >= $this->limit ) {
-                       $top = wfShowingResults( $this->offset, $this->limit );
-               } else {
-                       $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
+               $totalNum = 0;
+               if($titleMatches && !is_null($titleMatches->getTotalHits()))
+                       $totalNum += $titleMatches->getTotalHits();
+               if($textMatches && !is_null($textMatches->getTotalHits()))
+                       $totalNum += $textMatches->getTotalHits();
+               if ( $num > 0 ) {
+                       if ( $totalNum > 0 ){
+                               $top = wfMsgExt('showingresultstotal',array( 'parseinline' ), $this->offset+1, $this->offset+$num, $totalNum);
+                       } elseif ( $num >= $this->limit ) {
+                               $top = wfShowingResults( $this->offset, $this->limit );
+                       } else {
+                               $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
+                       }
+                       $wgOut->addHTML( "<p>{$top}</p>\n" );
                }
-               $wgOut->addHTML( "<p>{$top}</p>\n" );
 
                if( $num || $this->offset ) {
                        $prevnext = wfViewPrevNext( $this->offset, $this->limit,
-                               'Special:Search',
+                               SpecialPage::getTitleFor( 'Search' ),
                                wfArrayToCGI(
                                        $this->powerSearchOptions(),
-                                       array( 'search' => $term ) ) );
-                       $wgOut->addHTML( "<br />{$prevnext}\n" );
+                                       array( 'search' => $term ) ),
+                                       ($num < $this->limit) );
+                       $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
+                       wfRunHooks( 'SpecialSearchResults', array( $term, $titleMatches, $textMatches ) );
+               } else {
+                       wfRunHooks( 'SpecialSearchNoResults', array( $term ) );
                }
 
                if( $titleMatches ) {
                        if( $titleMatches->numRows() ) {
-                               $wgOut->addWikiText( '==' . wfMsg( 'titlematches' ) . "==\n" );
+                               $wgOut->wrapWikiMsg( "==$1==\n", 'titlematches' );
                                $wgOut->addHTML( $this->showMatches( $titleMatches ) );
                        } else {
-                               $wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
+                               $wgOut->wrapWikiMsg( "==$1==\n", 'notitlematches' );
                        }
+                       $titleMatches->free();
                }
 
                if( $textMatches ) {
                        if( $textMatches->numRows() ) {
-                               $wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
+                               if($titleMatches) 
+                                       $wgOut->wrapWikiMsg( "==$1==\n", 'textmatches' );
+                               else // if no title matches the heading is redundant
+                                       $wgOut->addHTML("<hr/>");
                                $wgOut->addHTML( $this->showMatches( $textMatches ) );
                        } elseif( $num == 0 ) {
                                # Don't show the 'no text matches' if we received title matches
-                               $wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
+                               $wgOut->wrapWikiMsg( "==$1==\n", 'notextmatches' );
                        }
+                       $textMatches->free();
                }
 
                if ( $num == 0 ) {
-                       $wgOut->addWikiText( wfMsg( 'nonefound' ) );
+                       $wgOut->addWikiMsg( 'nonefound' );
                }
                if( $num || $this->offset ) {
                        $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
@@ -289,9 +315,10 @@ class SpecialSearch {
                        $opt['ns' . $n] = 1;
                }
                $opt['redirs'] = $this->searchRedirects ? 1 : 0;
-               $opt['searchx'] = 1;
                return $opt;
        }
+       
+
 
        /**
         * @param SearchResultSet $matches
@@ -306,12 +333,12 @@ class SpecialSearch {
                $terms = implode( '|', $tm );
 
                $off = $this->offset + 1;
-               $out = "<ol start='{$off}'>\n";
+               $out = "<ul start='{$off}' class='mw-search-results'>\n";
 
                while( $result = $matches->next() ) {
                        $out .= $this->showHit( $result, $terms );
                }
-               $out .= "</ol>\n";
+               $out .= "</ul>\n";
 
                // convert the whole thing to desired language variant
                global $wgContLang;
@@ -335,19 +362,125 @@ class SpecialSearch {
                        wfProfileOut( $fname );
                        return "<!-- Broken link in search result -->\n";
                }
-               $sk =& $wgUser->getSkin();
-
-               $contextlines = $wgUser->getOption( 'contextlines' );
-               if ( '' == $contextlines ) { $contextlines = 5; }
-               $contextchars = $wgUser->getOption( 'contextchars' );
-               if ( '' == $contextchars ) { $contextchars = 50; }
+               $sk = $wgUser->getSkin();
 
-               $link = $sk->makeKnownLinkObj( $t );
+               //$contextlines = $wgUser->getOption( 'contextlines',  5 );
+               $contextlines = 2; // Hardcode this. Old defaults sucked. :)
+               $contextchars = $wgUser->getOption( 'contextchars', 50 );
+               
+               $link = $sk->makeKnownLinkObj( $t, $result->getTitleSnippet());
+
+               //If page content is not readable, just return the title.
+               //This is not quite safe, but better than showing excerpts from non-readable pages
+               //Note that hiding the entry entirely would screw up paging.
+               if (!$t->userCanRead()) {
+                       return "<li>{$link}</li>\n";
+               }
+               
                $revision = Revision::newFromTitle( $t );
-               $text = $revision->getText();
-               $size = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
-                       $wgLang->formatNum( strlen( $text ) ) );
+               // If the page doesn't *exist*... our search index is out of date.
+               // The least confusing at this point is to drop the result.
+               // You may get less results, but... oh well. :P
+               if( !$revision ) {
+                       return "<!-- missing page " .
+                               htmlspecialchars( $t->getPrefixedText() ) . "-->\n";
+               }
+               
+               if( is_null( $result->getScore() ) ) {
+                       // Search engine doesn't report scoring info
+                       $score = '';
+               } else {
+                       $percent = sprintf( '%2.1f', $result->getScore() * 100 );
+                       $score = wfMsg( 'search-result-score', $wgLang->formatNum( $percent ) )
+                               . ' - ';
+               }
+               
+               // try to fetch everything from the search engine backend
+               // then fill-in what couldn't be fetched
+               $extract = $result->getTextSnippet();
+               $byteSize = $result->getByteSize();
+               $wordCount = $result->getWordCount();
+               $timestamp = $result->getTimestamp();
+               $redirectTitle = $result->getRedirectTitle();
+               $redirectText = $result->getRedirectSnippet();
+               $sectionTitle = $result->getSectionTitle();
+               $sectionText = $result->getSectionSnippet();
+
+               // fallback
+               if( is_null($extract) || is_null($wordCount) || is_null($byteSize) ){
+                       $text = $revision->getText();
+                       if( is_null($extract) )
+                               $extract = $this->extractText( $text, $terms, $contextlines, $contextchars );
+                       if( is_null($byteSize) )
+                               $byteSize = strlen( $text );
+                       if( is_null($wordCount) )
+                               $wordCount = str_word_count( $text );
+               }
+               if( is_null($timestamp) ){
+                       $timestamp = $revision->getTimestamp();
+               }
+               
+               // format description           
+               $size = wfMsgExt( 'search-result-size', array( 'parsemag', 'escape' ),
+                       $sk->formatSize( $byteSize ),
+                       $wordCount );
+               $date = $wgLang->timeanddate( $timestamp );
+               
+               // format redirects / sections
+               $redirect = '';
+               if( !is_null($redirectTitle) )
+                       $redirect = "<span class='searchalttitle'>"
+                               .wfMsg('search-redirect',$sk->makeKnownLinkObj( $redirectTitle, $redirectText))
+                               ."</span>";
+               $section = '';
+               if( !is_null($sectionTitle) )
+                       $section = "<span class='searchalttitle'>" 
+                               .wfMsg('search-section', $sk->makeKnownLinkObj( $sectionTitle, $sectionText))
+                               ."</span>";
+               // wrap extract
+               $extract = "<div class='searchresult'>".$extract."</div>";
+               
+               // Include a thumbnail for media files...
+               if( $t->getNamespace() == NS_IMAGE ) {
+                       $img = wfFindFile( $t );
+                       if( $img ) {
+                               $thumb = $img->getThumbnail( 120, 120 );
+                               if( $thumb ) {
+                                       $desc = $img->getShortDesc();
+                                       wfProfileOut( $fname );
+                                       // Ugly table. :D
+                                       // Float doesn't seem to interact well with the bullets.
+                                       // Table messes up vertical alignment of the bullet, but I'm
+                                       // not sure what more I can do about that. :(
+                                       return "<li>" .
+                                               '<table class="searchResultImage">' .
+                                               '<tr>' .
+                                               '<td width="120" align="center">' .
+                                               $thumb->toHtml( array( 'desc-link' => true ) ) .
+                                               '</td>' .
+                                               '<td valign="top">' .
+                                               $link .
+                                               $extract .
+                                               "<div class='mw-search-result-data'>{$score}{$desc} - {$date}</div>" .
+                                               '</td>' .
+                                               '</tr>' .
+                                               '</table>' .
+                                               "</li>\n";
+                               }
+                       }
+               }
 
+               wfProfileOut( $fname );
+               return "<li>{$link} {$redirect} {$section} {$extract}\n" .
+                       "<div class='mw-search-result-data'>{$score}{$size} - {$date}</div>" .
+                       "</li>\n";
+
+       }
+       
+       private function extractText( $text, $terms, $contextlines, $contextchars ) {
+               global $wgLang, $wgContLang;
+               $fname = __METHOD__;
+       
                $lines = explode( "\n", $text );
 
                $max = intval( $contextchars ) + 1;
@@ -355,23 +488,24 @@ class SpecialSearch {
 
                $lineno = 0;
 
-               $extract = '';
+               $extract = "";
                wfProfileIn( "$fname-extract" );
                foreach ( $lines as $line ) {
                        if ( 0 == $contextlines ) {
                                break;
                        }
                        ++$lineno;
+                       $m = array();
                        if ( ! preg_match( $pat1, $line, $m ) ) {
                                continue;
                        }
                        --$contextlines;
-                       $pre = $wgContLang->truncate( $m[1], -$contextchars, '...' );
+                       $pre = $wgContLang->truncate( $m[1], -$contextchars, ' ... ' );
 
                        if ( count( $m ) < 3 ) {
                                $post = '';
                        } else {
-                               $post = $wgContLang->truncate( $m[3], $contextchars, '...' );
+                               $post = $wgContLang->truncate( $m[3], $contextchars, ' ... ' );
                        }
 
                        $found = $m[2];
@@ -381,48 +515,74 @@ class SpecialSearch {
                        $line = preg_replace( $pat2,
                          "<span class='searchmatch'>\\1</span>", $line );
 
-                       $extract .= "<br /><small>{$lineno}: {$line}</small>\n";
+                       $extract .= "${line}\n";
                }
                wfProfileOut( "$fname-extract" );
-               wfProfileOut( $fname );
-               return "<li>{$link} ({$size}){$extract}</li>\n";
+               
+               return $extract;
        }
 
+       /**
+        * Generates the power search box at bottom of [[Special:Search]]
+        * @param $term string: search term
+        * @return $out string: HTML form
+        */
        function powerSearchBox( $term ) {
+               global $wgScript;
+
                $namespaces = '';
                foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
-                       $checked = in_array( $ns, $this->namespaces )
-                               ? ' checked="checked"'
-                               : '';
                        $name = str_replace( '_', ' ', $name );
                        if( '' == $name ) {
                                $name = wfMsg( 'blanknamespace' );
                        }
-                       $namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
-                         "ns{$ns}\"{$checked} />{$name}</label>\n";
+                       $namespaces .= Xml::openElement( 'span', array( 'style' => 'white-space: nowrap' ) ) .
+                                       Xml::checkLabel( $name, "ns{$ns}", $name, in_array( $ns, $this->namespaces ) ) . 
+                                       Xml::closeElement( 'span' ) . "\n";
                }
 
-               $checked = $this->searchRedirects
-                       ? ' checked="checked"'
-                       : '';
-               $redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
-
-               $searchField = '<input type="text" name="search" value="' .
-                       htmlspecialchars( $term ) ."\" size=\"16\" />\n";
+               $redirect = Xml::check( 'redirs', $this->searchRedirects, array( 'value' => '1' ) );
+               $searchField = Xml::input( 'search', 50, $term, array( 'type' => 'text', 'id' => 'powerSearchText' ) );
+               $searchButton = Xml::submitButton( wfMsg( 'powersearch' ), array( 'name' => 'fulltext' ) ) . "\n";
+
+               $out = Xml::openElement( 'form', array( 'id' => 'powersearch', 'method' => 'get', 'action' => $wgScript ) ) .
+                       Xml::openElement( 'fieldset' ) .
+                       Xml::element( 'legend', array( ), wfMsg( 'powersearch-legend' ) ) .
+                       Xml::hidden( 'title', 'Special:Search' ) .
+                       wfMsgExt( 'powersearchtext', array( 'parse', 'replaceafter' ),
+                               $namespaces, $redirect, $searchField,
+                               '', '', '', '', '', # Dummy placeholders
+                               $searchButton ) .
+                       Xml::closeElement( 'fieldset' ) .
+                       Xml::closeElement( 'form' );
 
-               $searchButton = '<input type="submit" name="searchx" value="' .
-                 htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
-
-               $ret = wfMsg( 'powersearchtext',
-                       $namespaces, $redirect, $searchField,
-                       '', '', '', '', '', # Dummy placeholders
-                       $searchButton );
+               return $out;
+       }
 
-               $title = Title::makeTitle( NS_SPECIAL, 'Search' );
-               $action = $title->escapeLocalURL();
-               return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
-                 "action=\"$action\">\n{$ret}\n</form>\n";
+       function powerSearchFocus() {
+               return "<script type='text/javascript'>" .
+                       "document.getElementById('powerSearchText').focus();" .
+                       "</script>";
+       }
+       
+       function shortDialog($term) {
+               global $wgScript;
+               
+               $out  = Xml::openElement( 'form', array(
+                       'id' => 'search',
+                       'method' => 'get',
+                       'action' => $wgScript
+               ));
+               $out .= Xml::hidden( 'title', 'Special:Search' );
+               $out .= Xml::input( 'search', 50, $term ) . ' ';
+               foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
+                       if( in_array( $ns, $this->namespaces ) ) {
+                               $out .= Xml::hidden( "ns{$ns}", '1' );
+                       }
+               }
+               $out .= Xml::submitButton( wfMsg( 'searchbutton' ), array( 'name' => 'fulltext' ) );
+               $out .= Xml::closeElement( 'form' );
+               
+               return $out;
        }
 }
-
-?>