Followup r80122, protected, just incase it's needed..
[lhc/web/wiklou.git] / includes / specials / SpecialSearch.php
index da7f0d3..64394b6 100644 (file)
@@ -1,66 +1,77 @@
 <?php
-# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
-# http://www.mediawiki.org/
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
-
 /**
- * Run text & title search and display the output
+ * Implements Special:Search
+ *
+ * Copyright © 2004 Brion Vibber <brion@pobox.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup SpecialPage
  */
 
-/**
- * Entry point
- *
- * @param $par String: (default '')
- */
-function wfSpecialSearch( $par = '' ) {
-       global $wgRequest, $wgUser, $wgUseOldSearchUI;
-       // Strip underscores from title parameter; most of the time we'll want
-       // text form here. But don't strip underscores from actual text params!
-       $titleParam = str_replace( '_', ' ', $par );
-       // Fetch the search term
-       $search = str_replace( "\n", " ", $wgRequest->getText( 'search', $titleParam ) );
-       $searchPage = new SpecialSearch( $wgRequest, $wgUser );
-       if( $wgRequest->getVal( 'fulltext' )
-               || !is_null( $wgRequest->getVal( 'offset' ))
-               || !is_null( $wgRequest->getVal( 'searchx' )) )
-       {
-               $searchPage->showResults( $search );
-       } else {
-               $searchPage->goResult( $search );
-       }
-}
-
 /**
  * implements Special:Search - Run text & title search and display the output
  * @ingroup SpecialPage
  */
-class SpecialSearch {
+class SpecialSearch extends SpecialPage {
+
+       public function __construct() {
+               parent::__construct( 'Search' );
+       }
+
+       /**
+        * Entry point
+        *
+        * @param $par String or null
+        */
+       public function execute( $par ) {
+               global $wgRequest, $wgUser, $wgOut;
+
+               $this->setHeaders();
+               $this->outputHeader();
+               $wgOut->allowClickjacking();
+
+               // Strip underscores from title parameter; most of the time we'll want
+               // text form here. But don't strip underscores from actual text params!
+               $titleParam = str_replace( '_', ' ', $par );
+
+               // Fetch the search term
+               $search = str_replace( "\n", " ", $wgRequest->getText( 'search', $titleParam ) );
+
+               $this->load( $wgRequest, $wgUser );
+
+               if ( $wgRequest->getVal( 'fulltext' )
+                       || !is_null( $wgRequest->getVal( 'offset' ) )
+                       || !is_null( $wgRequest->getVal( 'searchx' ) ) )
+               {
+                       $this->showResults( $search );
+               } else {
+                       $this->goResult( $search );
+               }
+       }
 
        /**
         * Set up basic search parameters from the request and user settings.
         * Typically you'll pass $wgRequest and $wgUser.
         *
-        * @param WebRequest $request
-        * @param User $user
-        * @public
+        * @param $request WebRequest
+        * @param $user User
         */
-       function __construct( &$request, &$user ) {
+       public function load( &$request, &$user ) {
                list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
                $this->mPrefix = $request->getVal('prefix', '');
                # Extract requested namespaces
@@ -68,7 +79,7 @@ class SpecialSearch {
                if( empty( $this->namespaces ) ) {
                        $this->namespaces = SearchEngine::userNamespaces( $user );
                }
-               $this->searchRedirects = $request->getcheck( 'redirs' ) ? true : false;
+               $this->searchRedirects = $request->getCheck( 'redirs' );
                $this->searchAdvanced = $request->getVal( 'advanced' );
                $this->active = 'advanced';
                $this->sk = $user->getSkin();
@@ -78,7 +89,8 @@ class SpecialSearch {
 
        /**
         * If an exact title match can be found, jump straight ahead to it.
-        * @param string $term
+        *
+        * @param $term String
         */
        public function goResult( $term ) {
                global $wgOut;
@@ -91,6 +103,12 @@ class SpecialSearch {
                }
                # If there's an exact or very near match, jump right there.
                $t = SearchEngine::getNearMatch( $term );
+               
+               if ( !wfRunHooks( 'SpecialSearchGo', array( &$t, &$term ) ) ) {
+                       # Hook requested termination
+                       return;
+               }
+               
                if( !is_null( $t ) ) {
                        $wgOut->redirect( $t->getFullURL() );
                        return;
@@ -110,7 +128,7 @@ class SpecialSearch {
        }
 
        /**
-        * @param string $term
+        * @param $term String
         */
        public function showResults( $term ) {
                global $wgOut, $wgUser, $wgDisableTextSearch, $wgContLang, $wgScript;
@@ -168,7 +186,7 @@ class SpecialSearch {
                        # mirror Go/Search behaviour of original request ..
                        $didYouMeanParams = array( 'search' => $textMatches->getSuggestionQuery() );
 
-                       if($this->fulltext != NULL)
+                       if($this->fulltext != null)
                                $didYouMeanParams['fulltext'] = $this->fulltext;
 
                        $stParams = array_merge(
@@ -219,8 +237,7 @@ class SpecialSearch {
                }
 
                $filePrefix = $wgContLang->getFormattedNsText(NS_FILE).':';
-               if( '' === trim( $term ) || $filePrefix === trim( $term ) ) {
-                       $wgOut->addHTML( $this->searchFocus() );
+               if( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
                        $wgOut->addHTML( $this->formHeader($term, 0, 0));
                        if( $this->searchAdvanced ) {
                                $wgOut->addHTML( $this->powerSearchBox( $term ) );
@@ -258,21 +275,11 @@ class SpecialSearch {
                
                $wgOut->addHtml( Xml::closeElement( 'form' ) );
                $wgOut->addHtml( "<div class='searchresults'>" );
-               
-               // show direct page/create link
-               if( !is_null($t) ) {
-                       if( !$t->exists() ) {
-                               $wgOut->addWikiMsg( 'searchmenu-new', wfEscapeWikiText( $t->getPrefixedText() ) );
-                       } else {
-                               $wgOut->addWikiMsg( 'searchmenu-exists', wfEscapeWikiText( $t->getPrefixedText() ) );
-                       }
-               } else {
-                       // preserve the paragraph for margins etc...
-                       $wgOut->addHTML('<p></p>');
-               }
 
                // prev/next links
                if( $num || $this->offset ) {
+                       // Show the create link ahead
+                       $this->showCreateLink( $t );
                        $prevnext = wfViewPrevNext( $this->offset, $this->limit,
                                SpecialPage::getTitleFor( 'Search' ),
                                wfArrayToCGI( $this->powerSearchOptions(), array( 'search' => $term ) ),
@@ -284,6 +291,7 @@ class SpecialSearch {
                        wfRunHooks( 'SpecialSearchNoResults', array( $term ) );
                } 
 
+               $wgOut->parserOptions()->setEditSection( false );
                if( $titleMatches ) {
                        if( $numTitleMatches > 0 ) {
                                $wgOut->wrapWikiMsg( "==$1==\n", 'titlematches' );
@@ -312,18 +320,38 @@ class SpecialSearch {
                        $textMatches->free();
                }
                if( $num === 0 ) {
-                       $wgOut->addWikiMsg( 'search-nonefound', wfEscapeWikiText( $term ) );
+                       $wgOut->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", array( 'search-nonefound', wfEscapeWikiText( $term ) ) );
+                       $this->showCreateLink( $t );
                }
                $wgOut->addHtml( "</div>" );
-               if( $num === 0 ) {
-                       $wgOut->addHTML( $this->searchFocus() );
-               }
 
                if( $num || $this->offset ) {
                        $wgOut->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
                }
                wfProfileOut( __METHOD__ );
        }
+       
+       protected function showCreateLink( $t ) {
+               global $wgOut;
+               
+               // show direct page/create link if applicable
+               $messageName = null;
+               if( !is_null($t) ) {
+                       if( $t->isKnown() ) {
+                               $messageName = 'searchmenu-exists';
+                       } elseif( $t->userCan( 'create' ) ) {
+                               $messageName = 'searchmenu-new';
+                       } else {
+                               $messageName = 'searchmenu-new-nocreate';
+                       }
+               } 
+               if( $messageName ) {
+                       $wgOut->wrapWikiMsg( "<p class=\"mw-search-createlink\">\n$1</p>", array( $messageName, wfEscapeWikiText( $t->getPrefixedText() ) ) );
+               } else {
+                       // preserve the paragraph for margins etc...
+                       $wgOut->addHtml( '<p></p>' );
+               }
+       }
 
        /**
         *
@@ -331,37 +359,34 @@ class SpecialSearch {
        protected function setupPage( $term ) {
                global $wgOut;
                // Figure out the active search profile header
-               $nsAllSet = array_keys( SearchEngine::searchableNamespaces() );
-               if( $this->searchAdvanced )
-                       $this->active = 'advanced';
-               else if( $this->namespaces === array(NS_FILE) || $this->startsWithImage( $term ) )
-                       $this->active = 'images';
-               elseif( $this->namespaces === $nsAllSet || $this->startsWithAll( $term ) )
-                       $this->active = 'all';
-               elseif( $this->namespaces === SearchEngine::defaultNamespaces() )
-                       $this->active = 'default';
-               elseif( $this->namespaces === SearchEngine::helpNamespaces() )
-                       $this->active = 'help';
-               else
+               if( $this->searchAdvanced ) {
                        $this->active = 'advanced';
+               } else {
+                       $profiles = $this->getSearchProfiles();
+                       
+                       foreach( $profiles as $key => $data ) {
+                               if ( $this->namespaces == $data['namespaces'] && $key != 'advanced')
+                                       $this->active = $key;
+                       }
+                       
+               }
                # Should advanced UI be used?
                $this->searchAdvanced = ($this->active === 'advanced');
                if( !empty( $term ) ) {
                        $wgOut->setPageTitle( wfMsg( 'searchresults') );
                        $wgOut->setHTMLTitle( wfMsg( 'pagetitle', wfMsg( 'searchresults-title', $term ) ) );
                }
-               $wgOut->setArticleRelated( false );
-               $wgOut->setRobotPolicy( 'noindex,nofollow' );
                // add javascript specific to special:search
-               $wgOut->addScriptFile( 'search.js' );
+               $wgOut->addModules( 'mediawiki.legacy.search' );
+               $wgOut->addModules( 'mediawiki.special.search' );
        }
 
        /**
         * Extract "power search" namespace settings from the request object,
         * returning a list of index numbers to search.
         *
-        * @param WebRequest $request
-        * @return array
+        * @param $request WebRequest
+        * @return Array
         */
        protected function powerSearch( &$request ) {
                $arr = array();
@@ -375,7 +400,8 @@ class SpecialSearch {
 
        /**
         * Reconstruct the 'power search' options for links
-        * @return array
+        *
+        * @return Array
         */
        protected function powerSearchOptions() {
                $opt = array();
@@ -392,7 +418,7 @@ class SpecialSearch {
        /**
         * Show whole set of results
         *
-        * @param SearchResultSet $matches
+        * @param $matches SearchResultSet
         */
        protected function showMatches( &$matches ) {
                global $wgContLang;
@@ -405,7 +431,6 @@ class SpecialSearch {
                if( !is_null($infoLine) ) {
                        $out .= "\n<!-- {$infoLine} -->\n";
                }
-               $off = $this->offset + 1;
                $out .= "<ul class='mw-search-results'>\n";
                while( $result = $matches->next() ) {
                        $out .= $this->showHit( $result, $terms );
@@ -420,11 +445,12 @@ class SpecialSearch {
 
        /**
         * Format a single hit result
-        * @param SearchResult $result
-        * @param array $terms terms to highlight
+        *
+        * @param $result SearchResult
+        * @param $terms Array: terms to highlight
         */
        protected function showHit( $result, $terms ) {
-               global $wgContLang, $wgLang, $wgUser;
+               global $wgLang, $wgUser;
                wfProfileIn( __METHOD__ );
 
                if( $result->isBrokenTitle() ) {
@@ -439,9 +465,14 @@ class SpecialSearch {
 
                if( $titleSnippet == '' )
                        $titleSnippet = null;
+               
+               $link_t = clone $t;
+               
+               wfRunHooks( 'ShowSearchHitTitle',
+                                       array( &$link_t, &$titleSnippet, $result, $terms, $this ) );
 
                $link = $this->sk->linkKnown(
-                       $t,
+                       $link_t,
                        $titleSnippet
                );
 
@@ -521,8 +552,20 @@ class SpecialSearch {
                        'search-result-size',
                        array( 'parsemag', 'escape' ),
                        $this->sk->formatSize( $byteSize ),
-                       $wordCount
+                       $wgLang->formatNum( $wordCount )
                );
+
+               if( $t->getNamespace() == NS_CATEGORY ) {
+                       $cat = Category::newFromTitle( $t );
+                       $size = wfMsgExt(
+                               'search-result-category-size',
+                               array( 'parsemag', 'escape' ),
+                               $wgLang->formatNum( $cat->getPageCount() ),
+                               $wgLang->formatNum( $cat->getSubcatCount() ),
+                               $wgLang->formatNum( $cat->getFileCount() )
+                       );
+               }
+
                $date = $wgLang->timeanddate( $timestamp );
 
                // link to related articles if supported
@@ -551,7 +594,7 @@ class SpecialSearch {
                        if( $img ) {
                                $thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
                                if( $thumb ) {
-                                       $desc = $img->getShortDesc();
+                                       $desc = wfMsgExt( 'parentheses', 'parseinline', $img->getShortDesc() );
                                        wfProfileOut( __METHOD__ );
                                        // Float doesn't seem to interact well with the bullets.
                                        // Table messes up vertical alignment of the bullets.
@@ -575,7 +618,7 @@ class SpecialSearch {
                }
 
                wfProfileOut( __METHOD__ );
-               return "<li>{$link} {$redirect} {$section} {$extract}\n" .
+               return "<li><div class='mw-search-result-heading'>{$link} {$redirect} {$section}</div> {$extract}\n" .
                        "<div class='mw-search-result-data'>{$score}{$size} - {$date}{$related}</div>" .
                        "</li>\n";
 
@@ -584,7 +627,8 @@ class SpecialSearch {
        /**
         * Show results from other wikis
         *
-        * @param SearchResultSet $matches
+        * @param $matches SearchResultSet
+        * @param $query String
         */
        protected function showInterwiki( &$matches, $query ) {
                global $wgContLang;
@@ -593,7 +637,6 @@ class SpecialSearch {
 
                $out = "<div id='mw-search-interwiki'><div id='mw-search-interwiki-caption'>".
                        wfMsg('search-interwiki-caption')."</div>\n";
-               $off = $this->offset + 1;
                $out .= "<ul class='mw-search-iwresults'>\n";
 
                // work out custom project captions
@@ -622,15 +665,14 @@ class SpecialSearch {
        /**
         * Show single interwiki link
         *
-        * @param SearchResult $result
-        * @param string $lastInterwiki
-        * @param array $terms
-        * @param string $query
-        * @param array $customCaptions iw prefix -> caption
+        * @param $result SearchResult
+        * @param $lastInterwiki String
+        * @param $terms Array
+        * @param $query String
+        * @param $customCaptions Array: iw prefix -> caption
         */
        protected function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) {
                wfProfileIn( __METHOD__ );
-               global $wgContLang, $wgLang;
 
                if( $result->isBrokenTitle() ) {
                        wfProfileOut( __METHOD__ );
@@ -703,12 +745,11 @@ class SpecialSearch {
 
        /**
         * Generates the power search box at bottom of [[Special:Search]]
-        * @param $term string: search term
-        * @return $out string: HTML form
+        *
+        * @param $term String: search term
+        * @return String: HTML form
         */
        protected function powerSearchBox( $term ) {
-               global $wgScript, $wgContLang;
-               
                // Groups namespaces into rows according to subject
                $rows = array();
                foreach( SearchEngine::searchableNamespaces() as $namespace => $name ) {
@@ -785,41 +826,24 @@ class SpecialSearch {
                                                        'type'=>'button',
                                                        'id' => 'mw-search-togglenone',
                                                        'onclick' => 'mwToggleSearchCheckboxes("none");',
-                                                       'value' => wfMsg( 'powersearch-togglenone'
+                                                       'value' => wfMsg( 'powersearch-togglenone' )
                                                )
                                        )
-                               )
                        ) .
                        Xml::element( 'div', array( 'class' => 'divider' ), '', false ) .
                        $namespaceTables .
                        Xml::element( 'div', array( 'class' => 'divider' ), '', false ) .
                        $redirects .
-                       Xml::hidden( 'title', SpecialPage::getTitleFor( 'Search' )->getPrefixedText() ) .
-                       Xml::hidden( 'advanced', $this->searchAdvanced ) .
-                       Xml::hidden( 'fulltext', 'Advanced search' ) .
+                       Html::hidden( 'title', SpecialPage::getTitleFor( 'Search' )->getPrefixedText() ) .
+                       Html::hidden( 'advanced', $this->searchAdvanced ) .
+                       Html::hidden( 'fulltext', 'Advanced search' ) .
                        Xml::closeElement( 'fieldset' );
        }
-
-       protected function searchFocus() {
-               return Html::inlineScript(
-                       "hookEvent(\"load\", function() {" .
-                               "document.getElementById('searchText').focus();" .
-                       "});" );
-       }
-
-       protected function formHeader( $term, $resultsShown, $totalNum ) {
-               global $wgContLang, $wgCanonicalNamespaceNames, $wgLang;
-               
-               $out = Xml::openElement('div', array( 'class' =>  'mw-search-formheader' ) );
-               
-               $bareterm = $term;
-               if( $this->startsWithImage( $term ) ) {
-                       // Deletes prefixes
-                       $bareterm = substr( $term, strpos( $term, ':' ) + 1 );
-               }
+       
+       protected function getSearchProfiles() {
+               // Builds list of Search Types (profiles)
                $nsAllSet = array_keys( SearchEngine::searchableNamespaces() );
                
-               // Builds list of Search Types (profiles)
                $profiles = array(
                        'default' => array(
                                'message' => 'searchprofile-articles',
@@ -854,6 +878,29 @@ class SpecialSearch {
                                'parameters' => array( 'advanced' => 1 ),
                        )
                );
+               
+               wfRunHooks( 'SpecialSearchProfiles', array( &$profiles ) );
+
+               foreach( $profiles as &$data ) {
+                       sort($data['namespaces']);
+               }
+               
+               return $profiles;
+       }
+
+       protected function formHeader( $term, $resultsShown, $totalNum ) {
+               global $wgLang;
+               
+               $out = Xml::openElement('div', array( 'class' =>  'mw-search-formheader' ) );
+               
+               $bareterm = $term;
+               if( $this->startsWithImage( $term ) ) {
+                       // Deletes prefixes
+                       $bareterm = substr( $term, strpos( $term, ':' ) + 1 );
+               }
+
+               $profiles = $this->getSearchProfiles();
+               
                // Outputs XML for Search Types
                $out .= Xml::openElement( 'div', array( 'class' => 'search-types' ) );
                $out .= Xml::openElement( 'ul' );
@@ -876,12 +923,17 @@ class SpecialSearch {
                }
                $out .= Xml::closeElement( 'ul' );
                $out .= Xml::closeElement('div') ;
-               
+
                // Results-info
                if ( $resultsShown > 0 ) {
                        if ( $totalNum > 0 ){
-                               $top = wfMsgExt('showingresultsheader', array( 'parseinline' ),
-                                       $this->offset+1, $this->offset+$resultsShown, $totalNum, wfEscapeWikiText($term), $resultsShown );
+                               $top = wfMsgExt( 'showingresultsheader', array( 'parseinline' ),
+                                       $wgLang->formatNum( $this->offset + 1 ),
+                                       $wgLang->formatNum( $this->offset + $resultsShown ),
+                                       $wgLang->formatNum( $totalNum ),
+                                       wfEscapeWikiText( $term ),
+                                       $wgLang->formatNum( $resultsShown )
+                               );
                        } elseif ( $resultsShown >= $this->limit ) {
                                $top = wfShowingResults( $this->offset, $this->limit );
                        } else {
@@ -898,7 +950,7 @@ class SpecialSearch {
                // Adds hidden namespace fields
                if ( !$this->searchAdvanced ) {
                        foreach( $this->namespaces as $ns ) {
-                               $out .= Xml::hidden( "ns{$ns}", '1' );
+                               $out .= Html::hidden( "ns{$ns}", '1' );
                        }
                }
                
@@ -907,18 +959,30 @@ class SpecialSearch {
 
        protected function shortDialog( $term ) {
                $searchTitle = SpecialPage::getTitleFor( 'Search' );
-               $searchable = SearchEngine::searchableNamespaces();
-               $out = Xml::hidden( 'title', $searchTitle->getPrefixedText() ) . "\n";
+               $out = Html::hidden( 'title', $searchTitle->getPrefixedText() ) . "\n";
                // Keep redirect setting
-               $out .= Xml::hidden( "redirs", (int)$this->searchRedirects );
+               $out .= Html::hidden( "redirs", (int)$this->searchRedirects ) . "\n";
                // Term box
-               $out .= Xml::input( 'search', 50, $term, array( 'type' => 'text', 'id' => 'searchText' ) ) . "\n";
-               $out .= Xml::hidden( 'fulltext', 'Search' );
-               $out .= Xml::submitButton( wfMsg( 'searchbutton' ) );
+               $out .= Html::input( 'search', $term, 'search', array(
+                       'id' => $this->searchAdvanced ? 'powerSearchText' : 'searchText',
+                       'size' => '50',
+                       'autofocus'
+               ) ) . "\n";
+               $out .= Html::hidden( 'fulltext', 'Search' ) . "\n";
+               $out .= Xml::submitButton( wfMsg( 'searchbutton' ) ) . "\n";
                return $out . $this->didYouMeanHtml;            
        }
 
-       /** Make a search link with some target namespaces */
+       /**
+        * Make a search link with some target namespaces
+        *
+        * @param $term String
+        * @param $namespaces Array
+        * @param $label String: link's text
+        * @param $tooltip String: link's tooltip
+        * @param $params Array: query string parameters
+        * @return String: HTML fragment
+        */
        protected function makeSearchLink( $term, $namespaces, $label, $tooltip, $params=array() ) {
                $opt = $params;
                foreach( $namespaces as $n ) {
@@ -946,7 +1010,12 @@ class SpecialSearch {
                );
        }
 
-       /** Check if query starts with image: prefix */
+       /**
+        * Check if query starts with image: prefix
+        *
+        * @param $term String: the string to check
+        * @return Boolean
+        */
        protected function startsWithImage( $term ) {
                global $wgContLang;
 
@@ -957,7 +1026,12 @@ class SpecialSearch {
                return false;
        }
        
-       /** Check if query starts with all: prefix */
+       /**
+        * Check if query starts with all: prefix
+        *
+        * @param $term String: the string to check
+        * @return Boolean
+        */
        protected function startsWithAll( $term ) {
 
                $allkeyword = wfMsgForContent('searchall');