X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/specials/SpecialSearch.php diff --git a/includes/specials/SpecialSearch.php b/includes/specials/SpecialSearch.php index fd6e858e..85b4572b 100644 --- a/includes/specials/SpecialSearch.php +++ b/includes/specials/SpecialSearch.php @@ -23,1017 +23,699 @@ * @ingroup SpecialPage */ -/** - * Entry point - * - * @param $par String: (default '') - */ -function wfSpecialSearch( $par = '' ) { - global $wgRequest, $wgUser, $wgOut; - $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 ) ); - $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 ); - } -} +use MediaWiki\MediaWikiServices; +use MediaWiki\Widget\Search\BasicSearchResultSetWidget; +use MediaWiki\Widget\Search\FullSearchResultWidget; +use MediaWiki\Widget\Search\InterwikiSearchResultWidget; +use MediaWiki\Widget\Search\InterwikiSearchResultSetWidget; +use MediaWiki\Widget\Search\SimpleSearchResultWidget; +use MediaWiki\Widget\Search\SimpleSearchResultSetWidget; /** * implements Special:Search - Run text & title search and display the output * @ingroup SpecialPage */ -class SpecialSearch { - +class SpecialSearch extends SpecialPage { /** - * Set up basic search parameters from the request and user settings. - * Typically you'll pass $wgRequest and $wgUser. - * - * @param $request WebRequest - * @param $user User + * Current search profile. Search profile is just a name that identifies + * the active search tab on the search page (content, discussions...) + * For users tt replaces the set of enabled namespaces from the query + * string when applicable. Extensions can add new profiles with hooks + * with custom search options just for that profile. + * @var null|string */ - public function __construct( &$request, &$user ) { - list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' ); - $this->mPrefix = $request->getVal('prefix', ''); - # Extract requested namespaces - $this->namespaces = $this->powerSearch( $request ); - if( empty( $this->namespaces ) ) { - $this->namespaces = SearchEngine::userNamespaces( $user ); - } - $this->searchRedirects = $request->getCheck( 'redirs' ); - $this->searchAdvanced = $request->getVal( 'advanced' ); - $this->active = 'advanced'; - $this->sk = $user->getSkin(); - $this->didYouMeanHtml = ''; # html of did you mean... link - $this->fulltext = $request->getVal('fulltext'); - } + protected $profile; + + /** @var SearchEngine Search engine */ + protected $searchEngine; + + /** @var string Search engine type, if not default */ + protected $searchEngineType; + + /** @var array For links */ + protected $extraParams = []; /** - * If an exact title match can be found, jump straight ahead to it. - * - * @param $term String + * @var string The prefix url parameter. Set on the searcher and the + * is expected to treat it as prefix filter on titles. */ - public function goResult( $term ) { - global $wgOut; - $this->setupPage( $term ); - # Try to go to page as entered. - $t = Title::newFromText( $term ); - # If the string cannot be used to create a title - if( is_null( $t ) ) { - return $this->showResults( $term ); - } - # 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; - } - # No match, generate an edit URL - $t = Title::newFromText( $term ); - if( !is_null( $t ) ) { - global $wgGoToEdit; - wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) ); - wfDebugLog( 'nogomatch', $t->getText(), false ); - - # If the feature is enabled, go straight to the edit page - if( $wgGoToEdit ) { - $wgOut->redirect( $t->getFullURL( array( 'action' => 'edit' ) ) ); - return; - } - } - return $this->showResults( $term ); - } + protected $mPrefix; /** - * @param $term String + * @var int */ - public function showResults( $term ) { - global $wgOut, $wgUser, $wgDisableTextSearch, $wgContLang, $wgScript; - wfProfileIn( __METHOD__ ); + protected $limit, $offset; - $sk = $wgUser->getSkin(); - - $this->searchEngine = SearchEngine::create(); - $search =& $this->searchEngine; - $search->setLimitOffset( $this->limit, $this->offset ); - $search->setNamespaces( $this->namespaces ); - $search->showRedirects = $this->searchRedirects; - $search->prefix = $this->mPrefix; - $term = $search->transformSearchTerm($term); - - $this->setupPage( $term ); - - if( $wgDisableTextSearch ) { - global $wgSearchForwardUrl; - if( $wgSearchForwardUrl ) { - $url = str_replace( '$1', urlencode( $term ), $wgSearchForwardUrl ); - $wgOut->redirect( $url ); - wfProfileOut( __METHOD__ ); - return; - } - global $wgInputEncoding; - $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( 'searchbutton' ) ) - ) . - Xml::closeElement( 'fieldset' ) - ); - wfProfileOut( __METHOD__ ); - return; - } - - $t = Title::newFromText( $term ); - - // fetch search results - $rewritten = $search->replacePrefixes($term); - - $titleMatches = $search->searchTitle( $rewritten ); - if( !($titleMatches instanceof SearchResultTooMany)) - $textMatches = $search->searchText( $rewritten ); - - // did you mean... suggestions - if( $textMatches && $textMatches->hasSuggestion() ) { - $st = SpecialPage::getTitleFor( 'Search' ); - - # mirror Go/Search behaviour of original request .. - $didYouMeanParams = array( 'search' => $textMatches->getSuggestionQuery() ); - - if($this->fulltext != null) - $didYouMeanParams['fulltext'] = $this->fulltext; + /** + * @var array + */ + protected $namespaces; - $stParams = array_merge( - $didYouMeanParams, - $this->powerSearchOptions() - ); + /** + * @var string + */ + protected $fulltext; - $suggestionSnippet = $textMatches->getSuggestionSnippet(); + /** + * @var bool + */ + protected $runSuggestion = true; - if( $suggestionSnippet == '' ) - $suggestionSnippet = null; + /** + * Search engine configurations. + * @var SearchEngineConfig + */ + protected $searchConfig; - $suggestLink = $sk->linkKnown( - $st, - $suggestionSnippet, - array(), - $stParams - ); + const NAMESPACES_CURRENT = 'sense'; - $this->didYouMeanHtml = '
{$prevnext}
\n" ); - wfRunHooks( 'SpecialSearchResults', array( $term, &$titleMatches, &$textMatches ) ); - } else { - wfRunHooks( 'SpecialSearchNoResults', array( $term ) ); - } - - if( $titleMatches ) { - if( $numTitleMatches > 0 ) { - $wgOut->wrapWikiMsg( "==$1==\n", 'titlematches' ); - $wgOut->addHTML( $this->showMatches( $titleMatches ) ); - } - $titleMatches->free(); - } - if( $textMatches ) { - // output appropriate heading - if( $numTextMatches > 0 && $numTitleMatches > 0 ) { - // if no title matches the heading is redundant - $wgOut->wrapWikiMsg( "==$1==\n", 'textmatches' ); - } elseif( $totalRes == 0 ) { - # Don't show the 'no text matches' if we received title matches - # $wgOut->wrapWikiMsg( "==$1==\n", 'notextmatches' ); - } - // show interwiki results if any - if( $textMatches->hasInterwikiResults() ) { - $wgOut->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(), $term ) ); + $this->searchEngineType = $request->getVal( 'srbackend' ); + if ( + !$request->getVal( 'fulltext' ) && + $request->getVal( 'offset' ) === null + ) { + $url = $this->goResult( $term ); + if ( $url !== null ) { + // successful 'go' + $out->redirect( $url ); + return; } - // show results - if( $numTextMatches > 0 ) { - $wgOut->addHTML( $this->showMatches( $textMatches ) ); + // No match. If it could plausibly be a title + // run the No go match hook. + $title = Title::newFromText( $term ); + if ( !is_null( $title ) ) { + Hooks::run( 'SpecialSearchNogomatch', [ &$title ] ); } - - $textMatches->free(); - } - if( $num === 0 ) { - $wgOut->wrapWikiMsg( "\n$1
", array( 'search-nonefound', wfEscapeWikiText( $term ) ) ); - $this->showCreateLink( $t ); } - $wgOut->addHtml( "{$prevnext}
\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'; + $this->setupPage( $term ); + + if ( $this->getConfig()->get( 'DisableTextSearch' ) ) { + $searchForwardUrl = $this->getConfig()->get( 'SearchForwardUrl' ); + if ( $searchForwardUrl ) { + $url = str_replace( '$1', urlencode( $term ), $searchForwardUrl ); + $out->redirect( $url ); } else { - $messageName = 'searchmenu-new-nocreate'; + $out->addHTML( + "" + ); } - } - if( $messageName ) { - $wgOut->wrapWikiMsg( "\n$1
", array( $messageName, wfEscapeWikiText( $t->getPrefixedText() ) ) ); - } else { - // preserve the paragraph for margins etc... - $wgOut->addHtml( '' ); + + return; } + + $this->showResults( $term ); } /** + * Set up basic search parameters from the request and user settings. * + * @see tests/phpunit/includes/specials/SpecialSearchTest.php */ - protected function setupPage( $term ) { - global $wgOut; - // Figure out the active search profile header - 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; - } - + public function load() { + $request = $this->getRequest(); + list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, '' ); + $this->mPrefix = $request->getVal( 'prefix', '' ); + + $user = $this->getUser(); + + # Extract manually requested namespaces + $nslist = $this->powerSearch( $request ); + if ( !count( $nslist ) ) { + # Fallback to user preference + $nslist = $this->searchConfig->userNamespaces( $user ); } - # 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 ) ) ); + + $profile = null; + if ( !count( $nslist ) ) { + $profile = 'default'; } - $wgOut->setArticleRelated( false ); - $wgOut->setRobotPolicy( 'noindex,nofollow' ); - // add javascript specific to special:search - $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 $request WebRequest - * @return Array - */ - protected function powerSearch( &$request ) { - $arr = array(); - foreach( SearchEngine::searchableNamespaces() as $ns => $name ) { - if( $request->getCheck( 'ns' . $ns ) ) { - $arr[] = $ns; + $profile = $request->getVal( 'profile', $profile ); + $profiles = $this->getSearchProfiles(); + if ( $profile === null ) { + // BC with old request format + $profile = 'advanced'; + foreach ( $profiles as $key => $data ) { + if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) { + $profile = $key; + } + } + $this->namespaces = $nslist; + } elseif ( $profile === 'advanced' ) { + $this->namespaces = $nslist; + } else { + if ( isset( $profiles[$profile]['namespaces'] ) ) { + $this->namespaces = $profiles[$profile]['namespaces']; + } else { + // Unknown profile requested + $profile = 'default'; + $this->namespaces = $profiles['default']['namespaces']; } } - return $arr; + + $this->fulltext = $request->getVal( 'fulltext' ); + $this->runSuggestion = (bool)$request->getVal( 'runsuggestion', true ); + $this->profile = $profile; } /** - * Reconstruct the 'power search' options for links + * If an exact title match can be found, jump straight ahead to it. * - * @return Array + * @param string $term + * @return string|null The url to redirect to, or null if no redirect. */ - protected function powerSearchOptions() { - $opt = array(); - foreach( $this->namespaces as $n ) { - $opt['ns' . $n] = 1; + public function goResult( $term ) { + # If the string cannot be used to create a title + if ( is_null( Title::newFromText( $term ) ) ) { + return null; } - $opt['redirs'] = $this->searchRedirects ? 1 : 0; - if( $this->searchAdvanced ) { - $opt['advanced'] = $this->searchAdvanced; + # If there's an exact or very near match, jump right there. + $title = $this->getSearchEngine() + ->getNearMatcher( $this->getConfig() )->getNearMatch( $term ); + if ( is_null( $title ) ) { + return null; + } + $url = null; + if ( !Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] ) ) { + return null; } - return $opt; + + return $url === null ? $title->getFullUrlForRedirect() : $url; } /** - * Show whole set of results - * - * @param $matches SearchResultSet + * @param string $term */ - protected function showMatches( &$matches ) { + public function showResults( $term ) { global $wgContLang; - wfProfileIn( __METHOD__ ); - - $terms = $wgContLang->convertForSearchResult( $matches->termMatches() ); - $out = ""; - $infoLine = $matches->getInfo(); - if( !is_null($infoLine) ) { - $out .= "\n\n"; + if ( $this->searchEngineType !== null ) { + $this->setExtraParam( 'srbackend', $this->searchEngineType ); } - $out .= "\n$1
", [ + $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound', + wfEscapeWikiText( $term ) + ] ); } - // format text extract - $extract = "' . - $thumb->toHtml( array( 'desc-link' => true ) ) . - ' | ' . - '' .
- $link .
- $extract .
- " {$score}{$desc} - {$date}{$related} " .
- ' | ' .
- '
{$prevnext}
\n" ); } - wfProfileOut( __METHOD__ ); - return "\n$1
", $params ); + } else { + // preserve the paragraph for margins etc... + $this->getOutput()->addHTML( '' ); + } } /** - * Show single interwiki link + * Sets up everything for the HTML output page including styles, javascript, + * page title, etc. * - * @param $result SearchResult - * @param $lastInterwiki String - * @param $terms Array - * @param $query String - * @param $customCaptions Array: iw prefix -> caption + * @param string $term */ - protected function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) { - wfProfileIn( __METHOD__ ); - - if( $result->isBrokenTitle() ) { - wfProfileOut( __METHOD__ ); - return "\n"; + protected function setupPage( $term ) { + $out = $this->getOutput(); + + $this->setHeaders(); + $this->outputHeader(); + // TODO: Is this true? The namespace remember uses a user token + // on save. + $out->allowClickjacking(); + $this->addHelpLink( 'Help:Searching' ); + + if ( strval( $term ) !== '' ) { + $out->setPageTitle( $this->msg( 'searchresults' ) ); + $out->setHTMLTitle( $this->msg( 'pagetitle' ) + ->rawParams( $this->msg( 'searchresults-title' )->rawParams( $term )->text() ) + ->inContentLanguage()->text() + ); } - $t = $result->getTitle(); - - $titleSnippet = $result->getTitleSnippet($terms); - - if( $titleSnippet == '' ) - $titleSnippet = null; + $out->addJsConfigVars( [ 'searchTerm' => $term ] ); + $out->addModules( 'mediawiki.special.search' ); + $out->addModuleStyles( [ + 'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button', + 'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles', + ] ); + } - $link = $this->sk->linkKnown( - $t, - $titleSnippet - ); + /** + * Return true if current search is a power (advanced) search + * + * @return bool + */ + protected function isPowerSearch() { + return $this->profile === 'advanced'; + } - // format redirect if any - $redirectTitle = $result->getRedirectTitle(); - $redirectText = $result->getRedirectSnippet($terms); - $redirect = ''; - if( !is_null($redirectTitle) ) { - if( $redirectText == '' ) - $redirectText = null; - - $redirect = "" . - wfMsg( - 'search-redirect', - $this->sk->linkKnown( - $redirectTitle, - $redirectText - ) - ) . - ""; + /** + * Extract "power search" namespace settings from the request object, + * returning a list of index numbers to search. + * + * @param WebRequest &$request + * @return array + */ + protected function powerSearch( &$request ) { + $arr = []; + foreach ( $this->searchConfig->searchableNamespaces() as $ns => $name ) { + if ( $request->getCheck( 'ns' . $ns ) ) { + $arr[] = $ns; + } } - $out = ""; - // display project name - if(is_null($lastInterwiki) || $lastInterwiki != $t->getInterwiki()) { - if( key_exists($t->getInterwiki(),$customCaptions) ) - // captions from 'search-interwiki-custom' - $caption = $customCaptions[$t->getInterwiki()]; - else{ - // default is to show the hostname of the other wiki which might suck - // if there are many wikis on one hostname - $parsed = parse_url($t->getFullURL()); - $caption = wfMsg('search-interwiki-default', $parsed['host']); + return $arr; + } + + /** + * Reconstruct the 'power search' options for links + * TODO: Instead of exposing this publicly, could we instead expose + * a function for creating search links? + * + * @return array + */ + public function powerSearchOptions() { + $opt = []; + if ( $this->isPowerSearch() ) { + foreach ( $this->namespaces as $n ) { + $opt['ns' . $n] = 1; } - // "more results" link (special page stuff could be localized, but we might not know target lang) - $searchTitle = Title::newFromText($t->getInterwiki().":Special:Search"); - $searchLink = $this->sk->linkKnown( - $searchTitle, - wfMsg('search-interwiki-more'), - array(), - array( - 'search' => $query, - 'fulltext' => 'Search' - ) - ); - $out .= "