*/
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
*/
protected $runSuggestion = true;
- /**
- * Names of the wikis, in format: Interwiki prefix -> caption
- * @var array
- */
- protected $customCaptions;
-
/**
* Search engine configurations.
* @var SearchEngineConfig
*/
public function execute( $par ) {
$request = $this->getRequest();
+ $out = $this->getOutput();
// Fetch the search term
- $search = str_replace( "\n", " ", $request->getText( 'search' ) );
+ $term = str_replace( "\n", " ", $request->getText( 'search' ) );
// Historically search terms have been accepted not only in the search query
// parameter, but also as part of the primary url. This can have PII implications
// in releasing page view data. As such issue a 301 redirect to the correct
// URL.
- if ( strlen( $par ) && !strlen( $search ) ) {
+ if ( strlen( $par ) && !strlen( $term ) ) {
$query = $request->getValues();
unset( $query['title'] );
// Strip underscores from title parameter; most of the time we'll want
// text form here. But don't strip underscores from actual text params!
$query['search'] = str_replace( '_', ' ', $par );
- $this->getOutput()->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
+ $out->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
return;
}
- $this->setHeaders();
- $this->outputHeader();
- $out = $this->getOutput();
- $out->allowClickjacking();
- $out->addModuleStyles( [
- 'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
- 'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
- ] );
- $this->addHelpLink( 'Help:Searching' );
-
+ // Need to load selected namespaces before handling nsRemember
$this->load();
+ // TODO: This performs database actions on GET request, which is going to
+ // be a problem for our multi-datacenter work.
if ( !is_null( $request->getVal( 'nsRemember' ) ) ) {
$this->saveNamespaces();
// Remove the token from the URL to prevent the user from inadvertently
return;
}
- $out->addJsConfigVars( [ 'searchTerm' => $search ] );
$this->searchEngineType = $request->getVal( 'srbackend' );
-
- if ( $request->getVal( 'fulltext' )
- || !is_null( $request->getVal( 'offset' ) )
+ if (
+ !$request->getVal( 'fulltext' ) &&
+ $request->getVal( 'offset' ) === null
) {
- $this->showResults( $search );
- } else {
- $this->goResult( $search );
+ $url = $this->goResult( $term );
+ if ( $url !== null ) {
+ // successful 'go'
+ $out->redirect( $url );
+ return;
+ }
+ }
+
+ $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 {
+ $out->addHTML(
+ "<fieldset>" .
+ "<legend>" .
+ $this->msg( 'search-external' )->escaped() .
+ "</legend>" .
+ "<p class='mw-searchdisabled'>" .
+ $this->msg( 'searchdisabled' )->escaped() .
+ "</p>" .
+ $this->msg( 'googlesearch' )->rawParams(
+ htmlspecialchars( $term ),
+ 'UTF-8',
+ $this->msg( 'searchbutton' )->escaped()
+ )->text() .
+ "</fieldset>"
+ );
+ }
+
+ return;
}
+
+ $this->showResults( $term );
}
/**
* If an exact title match can be found, jump straight ahead to it.
*
* @param string $term
+ * @return string|null The url to redirect to, or null if no redirect.
*/
public function goResult( $term ) {
- $this->setupPage( $term );
- # Try to go to page as entered.
- $title = Title::newFromText( $term );
# If the string cannot be used to create a title
- if ( is_null( $title ) ) {
- $this->showResults( $term );
-
- return;
+ if ( is_null( Title::newFromText( $term ) ) ) {
+ return null;
}
# If there's an exact or very near match, jump right there.
$title = $this->getSearchEngine()
->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
-
- if ( !is_null( $title ) &&
- Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] )
- ) {
- if ( $url === null ) {
- $url = $title->getFullURL();
- }
- $this->getOutput()->redirect( $url );
-
- return;
+ if ( is_null( $title ) ) {
+ return null;
}
- $this->showResults( $term );
+ $url = null;
+ if ( !Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] ) ) {
+ return null;
+ }
+
+ return $url === null ? $title->getFullURL() : $url;
}
/**
public function showResults( $term ) {
global $wgContLang;
+ if ( $this->searchEngineType !== null ) {
+ $this->setExtraParam( 'srbackend', $this->searchEngineType );
+ }
+
+ $out = $this->getOutput();
+ $formWidget = new MediaWiki\Widget\Search\SearchFormWidget(
+ $this,
+ $this->searchConfig,
+ $this->getSearchProfiles()
+ );
+ $filePrefix = $wgContLang->getFormattedNsText( NS_FILE ) . ':';
+ if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
+ // Empty query -- straight view of search form
+ if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
+ # Hook requested termination
+ return;
+ }
+ $out->enableOOUI();
+ // The form also contains the 'Showing results 0 - 20 of 1234' so we can
+ // only do the form render here for the empty $term case. Rendering
+ // the form when a search is provided is repeated below.
+ $out->addHTML( $formWidget->render(
+ $this->profile, $term, 0, 0, $this->offset, $this->isPowerSearch()
+ ) );
+ return;
+ }
+
$search = $this->getSearchEngine();
$search->setFeatureData( 'rewrite', $this->runSuggestion );
$search->setLimitOffset( $this->limit, $this->offset );
$term = $search->transformSearchTerm( $term );
Hooks::run( 'SpecialSearchSetupEngine', [ $this, $this->profile, $search ] );
-
- $this->setupPage( $term );
-
- $out = $this->getOutput();
-
- if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
- $searchFowardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
- if ( $searchFowardUrl ) {
- $url = str_replace( '$1', urlencode( $term ), $searchFowardUrl );
- $out->redirect( $url );
- } else {
- $out->addHTML(
- Xml::openElement( 'fieldset' ) .
- Xml::element( 'legend', null, $this->msg( 'search-external' )->text() ) .
- Xml::element(
- 'p',
- [ 'class' => 'mw-searchdisabled' ],
- $this->msg( 'searchdisabled' )->text()
- ) .
- $this->msg( 'googlesearch' )->rawParams(
- htmlspecialchars( $term ),
- 'UTF-8',
- $this->msg( 'searchbutton' )->escaped()
- )->text() .
- Xml::closeElement( 'fieldset' )
- );
- }
-
+ if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
+ # Hook requested termination
return;
}
$textMatches = $textStatus->getValue();
}
- // did you mean... suggestions
- $didYouMeanHtml = '';
- if ( $showSuggestion && $textMatches ) {
- if ( $textMatches->hasRewrittenQuery() ) {
- $didYouMeanHtml = $this->getDidYouMeanRewrittenHtml( $term, $textMatches );
- } elseif ( $textMatches->hasSuggestion() ) {
- $didYouMeanHtml = $this->getDidYouMeanHtml( $textMatches );
- }
- }
-
- if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
- # Hook requested termination
- return;
- }
-
- // start rendering the page
- $out->addHTML(
- Xml::openElement(
- 'form',
- [
- 'id' => ( $this->isPowerSearch() ? 'powersearch' : 'search' ),
- 'method' => 'get',
- 'action' => wfScript(),
- ]
- )
- );
-
// Get number of results
$titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
if ( $titleMatches ) {
if ( $textMatches ) {
$textMatchesNum = $textMatches->numRows();
$numTextMatches = $textMatches->getTotalHits();
+ if ( $textMatchesNum > 0 ) {
+ $search->augmentSearchResults( $textMatches );
+ }
}
$num = $titleMatchesNum + $textMatchesNum;
$totalRes = $numTitleMatches + $numTextMatches;
+ // start rendering the page
$out->enableOOUI();
- $out->addHTML(
- # This is an awful awful ID name. It's not a table, but we
- # named it poorly from when this was a table so now we're
- # stuck with it
- Xml::openElement( 'div', [ 'id' => 'mw-search-top-table' ] ) .
- $this->shortDialog( $term, $num, $totalRes ) .
- Xml::closeElement( 'div' ) .
- $this->searchProfileTabs( $term ) .
- $this->searchOptions( $term ) .
- Xml::closeElement( 'form' ) .
- $didYouMeanHtml
- );
+ $out->addHTML( $formWidget->render(
+ $this->profile, $term, $num, $totalRes, $this->offset, $this->isPowerSearch()
+ ) );
- $filePrefix = $wgContLang->getFormattedNsText( NS_FILE ) . ':';
- if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
- // Empty query -- straight view of search form
- return;
+ // did you mean... suggestions
+ if ( $textMatches ) {
+ $dymWidget = new MediaWiki\Widget\Search\DidYouMeanWidget( $this );
+ $out->addHTML( $dymWidget->render( $term, $textMatches ) );
}
$out->addHTML( "<div class='searchresults'>" );
$hasErrors = $textStatus && $textStatus->getErrors();
+ $hasOtherResults = $textMatches &&
+ $textMatches->hasInterwikiResults( SearchResultSet::INLINE_RESULTS );
+
if ( $hasErrors ) {
list( $error, $warning ) = $textStatus->splitByErrorType();
if ( $error->getErrors() ) {
}
}
- // prev/next links
- $prevnext = null;
- if ( $num || $this->offset ) {
- // Show the create link ahead
- $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
- if ( $totalRes > $this->limit || $this->offset ) {
- if ( $this->searchEngineType !== null ) {
- $this->setExtraParam( 'srbackend', $this->searchEngineType );
- }
- $prevnext = $this->getLanguage()->viewPrevNext(
- $this->getPageTitle(),
- $this->offset,
- $this->limit,
- $this->powerSearchOptions() + [ 'search' => $term ],
- $this->limit + $this->offset >= $totalRes
- );
- }
- }
+ // Show the create link ahead
+ $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
+
Hooks::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
- $out->parserOptions()->setEditSection( false );
- if ( $titleMatches ) {
- if ( $numTitleMatches > 0 ) {
- $out->wrapWikiMsg( "==$1==\n", 'titlematches' );
- $out->addHTML( $this->showMatches( $titleMatches ) );
- }
- $titleMatches->free();
+ // If we have no results and have not already displayed an error message
+ if ( $num === 0 && !$hasErrors ) {
+ $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
+ $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
+ wfEscapeWikiText( $term )
+ ] );
}
- if ( $textMatches ) {
- // output appropriate heading
- if ( $numTextMatches > 0 && $numTitleMatches > 0 ) {
- $out->addHTML( '<div class="mw-search-visualclear"></div>' );
- // if no title matches the heading is redundant
- $out->wrapWikiMsg( "==$1==\n", 'textmatches' );
- }
+ // Although $num might be 0 there can still be secondary or inline
+ // results to display.
+ $linkRenderer = $this->getLinkRenderer();
+ $mainResultWidget = new FullSearchResultWidget( $this, $linkRenderer );
- // show results
- if ( $numTextMatches > 0 ) {
- $search->augmentSearchResults( $textMatches );
- $out->addHTML( $this->showMatches( $textMatches ) );
- }
+ if ( $search->getFeatureData( 'enable-new-crossproject-page' ) ) {
- // show secondary interwiki results if any
- if ( $textMatches->hasInterwikiResults( SearchResultSet::SECONDARY_RESULTS ) ) {
- $out->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(
- SearchResultSet::SECONDARY_RESULTS ), $term ) );
- }
+ $sidebarResultWidget = new InterwikiSearchResultWidget( $this, $linkRenderer );
+ $sidebarResultsWidget = new InterwikiSearchResultSetWidget(
+ $this,
+ $sidebarResultWidget,
+ $linkRenderer,
+ MediaWikiServices::getInstance()->getInterwikiLookup()
+ );
+ } else {
+ $sidebarResultWidget = new SimpleSearchResultWidget( $this, $linkRenderer );
+ $sidebarResultsWidget = new SimpleSearchResultSetWidget(
+ $this,
+ $sidebarResultWidget,
+ $linkRenderer,
+ MediaWikiServices::getInstance()->getInterwikiLookup()
+ );
}
- $hasOtherResults = $textMatches &&
- $textMatches->hasInterwikiResults( SearchResultSet::INLINE_RESULTS );
+ $widget = new BasicSearchResultSetWidget( $this, $mainResultWidget, $sidebarResultsWidget );
- // If we have no results and we have not already displayed an error message
- if ( $num === 0 && !$hasErrors ) {
- if ( !$this->offset ) {
- // If we have an offset the create link was rendered earlier in this function.
- // This class needs a good de-spaghettification, but for now this will
- // do the job.
- $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
- }
- $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
- $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
- wfEscapeWikiText( $term )
- ] );
- }
+ $out->addHTML( $widget->render(
+ $term, $this->offset, $titleMatches, $textMatches
+ ) );
- if ( $hasOtherResults ) {
- foreach ( $textMatches->getInterwikiResults( SearchResultSet::INLINE_RESULTS )
- as $interwiki => $interwikiResult ) {
- if ( $interwikiResult instanceof Status || $interwikiResult->numRows() == 0 ) {
- // ignore bad interwikis for now
- continue;
- }
- // TODO: wiki header
- $out->addHTML( $this->showMatches( $interwikiResult, $interwiki ) );
- }
+ if ( $titleMatches ) {
+ $titleMatches->free();
}
if ( $textMatches ) {
$out->addHTML( '<div class="mw-search-visualclear"></div>' );
- if ( $prevnext ) {
+ // prev/next links
+ if ( $totalRes > $this->limit || $this->offset ) {
+ $prevnext = $this->getLanguage()->viewPrevNext(
+ $this->getPageTitle(),
+ $this->offset,
+ $this->limit,
+ $this->powerSearchOptions() + [ 'search' => $term ],
+ $this->limit + $this->offset >= $totalRes
+ );
$out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
}
+ // Close <div class='searchresults'>
$out->addHTML( "</div>" );
Hooks::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
}
- /**
- * Produce wiki header for interwiki results
- * @param string $interwiki Interwiki name
- * @param SearchResultSet $interwikiResult The result set
- * @return string
- */
- protected function interwikiHeader( $interwiki, $interwikiResult ) {
- // TODO: we need to figure out how to name wikis correctly
- $wikiMsg = $this->msg( 'search-interwiki-results-' . $interwiki )->parse();
- return "<p class=\"mw-search-interwiki-header mw-search-visualclear\">\n$wikiMsg</p>";
- }
-
- /**
- * Generates HTML shown to the user when we have a suggestion about a query
- * that might give more results than their current query.
- */
- protected function getDidYouMeanHtml( SearchResultSet $textMatches ) {
- # mirror Go/Search behavior of original request ..
- $params = [ 'search' => $textMatches->getSuggestionQuery() ];
- if ( $this->fulltext === null ) {
- $params['fulltext'] = 'Search';
- } else {
- $params['fulltext'] = $this->fulltext;
- }
- $stParams = array_merge( $params, $this->powerSearchOptions() );
-
- $suggest = Linker::linkKnown(
- $this->getPageTitle(),
- $textMatches->getSuggestionSnippet() ?: null,
- [ 'id' => 'mw-search-DYM-suggestion' ],
- $stParams
- );
-
- # HTML of did you mean... search suggestion link
- return Html::rawElement(
- 'div',
- [ 'class' => 'searchdidyoumean' ],
- $this->msg( 'search-suggest' )->rawParams( $suggest )->parse()
- );
- }
-
- /**
- * Generates HTML shown to user when their query has been internally rewritten,
- * and the results of the rewritten query are being returned.
- *
- * @param string $term The users search input
- * @param SearchResultSet $textMatches The response to the users initial search request
- * @return string HTML linking the user to their original $term query, and the one
- * suggested by $textMatches.
- */
- protected function getDidYouMeanRewrittenHtml( $term, SearchResultSet $textMatches ) {
- // Showing results for '$rewritten'
- // Search instead for '$orig'
-
- $params = [ 'search' => $textMatches->getQueryAfterRewrite() ];
- if ( $this->fulltext === null ) {
- $params['fulltext'] = 'Search';
- } else {
- $params['fulltext'] = $this->fulltext;
- }
- $stParams = array_merge( $params, $this->powerSearchOptions() );
-
- $rewritten = Linker::linkKnown(
- $this->getPageTitle(),
- $textMatches->getQueryAfterRewriteSnippet() ?: null,
- [ 'id' => 'mw-search-DYM-rewritten' ],
- $stParams
- );
-
- $stParams['search'] = $term;
- $stParams['runsuggestion'] = 0;
- $original = Linker::linkKnown(
- $this->getPageTitle(),
- htmlspecialchars( $term ),
- [ 'id' => 'mw-search-DYM-original' ],
- $stParams
- );
-
- return Html::rawElement(
- 'div',
- [ 'class' => 'searchdidyoumean' ],
- $this->msg( 'search-rewritten' )->rawParams( $rewritten, $original )->escaped()
- );
- }
-
/**
* @param Title $title
* @param int $num The number of search results found
}
/**
+ * Sets up everything for the HTML output page including styles, javascript,
+ * page title, etc.
+ *
* @param string $term
*/
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' )
->inContentLanguage()->text()
);
}
- // add javascript specific to special:search
+
+ $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',
+ ] );
}
/**
/**
* 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
*/
- protected function powerSearchOptions() {
+ public function powerSearchOptions() {
$opt = [];
- if ( !$this->isPowerSearch() ) {
- $opt['profile'] = $this->profile;
- } else {
+ if ( $this->isPowerSearch() ) {
foreach ( $this->namespaces as $n ) {
$opt['ns' . $n] = 1;
}
+ } else {
+ $opt['profile'] = $this->profile;
}
return $opt + $this->extraParams;
return false;
}
- /**
- * Show whole set of results
- *
- * @param SearchResultSet $matches
- * @param string $interwiki Interwiki name
- *
- * @return string
- */
- protected function showMatches( $matches, $interwiki = null ) {
- global $wgContLang;
-
- $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
- $out = '';
- $result = $matches->next();
- $pos = $this->offset;
-
- if ( $result && $interwiki ) {
- $out .= $this->interwikiHeader( $interwiki, $matches );
- }
-
- $out .= "<ul class='mw-search-results'>\n";
- while ( $result ) {
- $out .= $this->showHit( $result, $terms, $pos++ );
- $result = $matches->next();
- }
- $out .= "</ul>\n";
-
- // convert the whole thing to desired language variant
- $out = $wgContLang->convert( $out );
-
- return $out;
- }
-
- /**
- * Format a single hit result
- *
- * @param SearchResult $result
- * @param array $terms Terms to highlight
- * @param int $position Position within the search results, including offset.
- *
- * @return string
- */
- protected function showHit( SearchResult $result, $terms, $position ) {
- if ( $result->isBrokenTitle() ) {
- return '';
- }
-
- $title = $result->getTitle();
-
- $titleSnippet = $result->getTitleSnippet();
-
- if ( $titleSnippet == '' ) {
- $titleSnippet = null;
- }
-
- $link_t = clone $title;
- $query = [];
-
- Hooks::run( 'ShowSearchHitTitle',
- [ &$link_t, &$titleSnippet, $result, $terms, $this, &$query ] );
-
- $link = Linker::linkKnown(
- $link_t,
- $titleSnippet,
- [ 'data-serp-pos' => $position ], // HTML attributes
- $query
- );
-
- // 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 ( !$title->userCan( 'read', $this->getUser() ) ) {
- return "<li>{$link}</li>\n";
- }
-
- // 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 ( $result->isMissingRevision() ) {
- return '';
- }
-
- // format redirects / relevant sections
- $redirectTitle = $result->getRedirectTitle();
- $redirectText = $result->getRedirectSnippet();
- $sectionTitle = $result->getSectionTitle();
- $sectionText = $result->getSectionSnippet();
- $categorySnippet = $result->getCategorySnippet();
-
- $redirect = '';
- if ( !is_null( $redirectTitle ) ) {
- if ( $redirectText == '' ) {
- $redirectText = null;
- }
-
- $redirect = "<span class='searchalttitle'>" .
- $this->msg( 'search-redirect' )->rawParams(
- Linker::linkKnown( $redirectTitle, $redirectText ) )->text() .
- "</span>";
- }
-
- $section = '';
- if ( !is_null( $sectionTitle ) ) {
- if ( $sectionText == '' ) {
- $sectionText = null;
- }
-
- $section = "<span class='searchalttitle'>" .
- $this->msg( 'search-section' )->rawParams(
- Linker::linkKnown( $sectionTitle, $sectionText ) )->text() .
- "</span>";
- }
-
- $category = '';
- if ( $categorySnippet ) {
- $category = "<span class='searchalttitle'>" .
- $this->msg( 'search-category' )->rawParams( $categorySnippet )->text() .
- "</span>";
- }
-
- // format text extract
- $extract = "<div class='searchresult'>" . $result->getTextSnippet( $terms ) . "</div>";
-
- $lang = $this->getLanguage();
-
- // format description
- $byteSize = $result->getByteSize();
- $wordCount = $result->getWordCount();
- $timestamp = $result->getTimestamp();
- $size = $this->msg( 'search-result-size', $lang->formatSize( $byteSize ) )
- ->numParams( $wordCount )->escaped();
-
- if ( $title->getNamespace() == NS_CATEGORY ) {
- $cat = Category::newFromTitle( $title );
- $size = $this->msg( 'search-result-category-size' )
- ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
- ->escaped();
- }
-
- $date = $lang->userTimeAndDate( $timestamp, $this->getUser() );
-
- $fileMatch = '';
- // Include a thumbnail for media files...
- if ( $title->getNamespace() == NS_FILE ) {
- $img = $result->getFile();
- $img = $img ?: wfFindFile( $title );
- if ( $result->isFileMatch() ) {
- $fileMatch = "<span class='searchalttitle'>" .
- $this->msg( 'search-file-match' )->escaped() . "</span>";
- }
- if ( $img ) {
- $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
- if ( $thumb ) {
- $desc = $this->msg( 'parentheses' )->rawParams( $img->getShortDesc() )->escaped();
- // Float doesn't seem to interact well with the bullets.
- // Table messes up vertical alignment of the bullets.
- // Bullets are therefore disabled (didn't look great anyway).
- return "<li>" .
- '<table class="searchResultImage">' .
- '<tr>' .
- '<td style="width: 120px; text-align: center; vertical-align: top;">' .
- $thumb->toHtml( [ 'desc-link' => true ] ) .
- '</td>' .
- '<td style="vertical-align: top;">' .
- "{$link} {$redirect} {$category} {$section} {$fileMatch}" .
- $extract .
- "<div class='mw-search-result-data'>{$desc} - {$date}</div>" .
- '</td>' .
- '</tr>' .
- '</table>' .
- "</li>\n";
- }
- }
- }
-
- $html = null;
-
- $score = '';
- $related = '';
- if ( Hooks::run( 'ShowSearchHit', [
- $this, $result, $terms,
- &$link, &$redirect, &$section, &$extract,
- &$score, &$size, &$date, &$related,
- &$html
- ] ) ) {
- $html = "<li><div class='mw-search-result-heading'>" .
- "{$link} {$redirect} {$category} {$section} {$fileMatch}</div> {$extract}\n" .
- "<div class='mw-search-result-data'>{$size} - {$date}</div>" .
- "</li>\n";
- }
-
- return $html;
- }
-
- /**
- * Extract custom captions from search-interwiki-custom message
- */
- protected function getCustomCaptions() {
- if ( is_null( $this->customCaptions ) ) {
- $this->customCaptions = [];
- // format per line <iwprefix>:<caption>
- $customLines = explode( "\n", $this->msg( 'search-interwiki-custom' )->text() );
- foreach ( $customLines as $line ) {
- $parts = explode( ":", $line, 2 );
- if ( count( $parts ) == 2 ) { // validate line
- $this->customCaptions[$parts[0]] = $parts[1];
- }
- }
- }
- }
-
- /**
- * Show results from other wikis
- *
- * @param SearchResultSet|array $matches
- * @param string $query
- *
- * @return string
- */
- protected function showInterwiki( $matches, $query ) {
- global $wgContLang;
-
- $out = "<div id='mw-search-interwiki'><div id='mw-search-interwiki-caption'>" .
- $this->msg( 'search-interwiki-caption' )->text() . "</div>\n";
- $out .= "<ul class='mw-search-iwresults'>\n";
-
- // work out custom project captions
- $this->getCustomCaptions();
-
- if ( !is_array( $matches ) ) {
- $matches = [ $matches ];
- }
-
- foreach ( $matches as $set ) {
- $prev = null;
- $result = $set->next();
- while ( $result ) {
- $out .= $this->showInterwikiHit( $result, $prev, $query );
- $prev = $result->getInterwikiPrefix();
- $result = $set->next();
- }
- }
-
- // @todo Should support paging in a non-confusing way (not sure how though, maybe via ajax)..
- $out .= "</ul></div>\n";
-
- // convert the whole thing to desired language variant
- $out = $wgContLang->convert( $out );
-
- return $out;
- }
-
- /**
- * Show single interwiki link
- *
- * @param SearchResult $result
- * @param string $lastInterwiki
- * @param string $query
- *
- * @return string
- */
- protected function showInterwikiHit( $result, $lastInterwiki, $query ) {
- if ( $result->isBrokenTitle() ) {
- return '';
- }
-
- $title = $result->getTitle();
-
- $titleSnippet = $result->getTitleSnippet();
-
- if ( $titleSnippet == '' ) {
- $titleSnippet = null;
- }
-
- $link = Linker::linkKnown(
- $title,
- $titleSnippet
- );
-
- // format redirect if any
- $redirectTitle = $result->getRedirectTitle();
- $redirectText = $result->getRedirectSnippet();
- $redirect = '';
- if ( !is_null( $redirectTitle ) ) {
- if ( $redirectText == '' ) {
- $redirectText = null;
- }
-
- $redirect = "<span class='searchalttitle'>" .
- $this->msg( 'search-redirect' )->rawParams(
- Linker::linkKnown( $redirectTitle, $redirectText ) )->text() .
- "</span>";
- }
-
- $out = "";
- // display project name
- if ( is_null( $lastInterwiki ) || $lastInterwiki != $title->getInterwiki() ) {
- if ( array_key_exists( $title->getInterwiki(), $this->customCaptions ) ) {
- // captions from 'search-interwiki-custom'
- $caption = $this->customCaptions[$title->getInterwiki()];
- } else {
- // default is to show the hostname of the other wiki which might suck
- // if there are many wikis on one hostname
- $parsed = wfParseUrl( $title->getFullURL() );
- $caption = $this->msg( 'search-interwiki-default', $parsed['host'] )->text();
- }
- // "more results" link (special page stuff could be localized, but we might not know target lang)
- $searchTitle = Title::newFromText( $title->getInterwiki() . ":Special:Search" );
- $searchLink = Linker::linkKnown(
- $searchTitle,
- $this->msg( 'search-interwiki-more' )->text(),
- [],
- [
- 'search' => $query,
- 'fulltext' => 'Search'
- ]
- );
- $out .= "</ul><div class='mw-search-interwiki-project'><span class='mw-search-interwiki-more'>
- {$searchLink}</span>{$caption}</div>\n<ul>";
- }
-
- $out .= "<li>{$link} {$redirect}</li>\n";
-
- return $out;
- }
-
- /**
- * Generates the power search box at [[Special:Search]]
- *
- * @param string $term Search term
- * @param array $opts
- * @return string HTML form
- */
- protected function powerSearchBox( $term, $opts ) {
- global $wgContLang;
-
- // Groups namespaces into rows according to subject
- $rows = [];
- foreach ( $this->searchConfig->searchableNamespaces() as $namespace => $name ) {
- $subject = MWNamespace::getSubject( $namespace );
- if ( !array_key_exists( $subject, $rows ) ) {
- $rows[$subject] = "";
- }
-
- $name = $wgContLang->getConverter()->convertNamespace( $namespace );
- if ( $name == '' ) {
- $name = $this->msg( 'blanknamespace' )->text();
- }
-
- $rows[$subject] .=
- Xml::openElement( 'td' ) .
- Xml::checkLabel(
- $name,
- "ns{$namespace}",
- "mw-search-ns{$namespace}",
- in_array( $namespace, $this->namespaces )
- ) .
- Xml::closeElement( 'td' );
- }
-
- $rows = array_values( $rows );
- $numRows = count( $rows );
-
- // Lays out namespaces in multiple floating two-column tables so they'll
- // be arranged nicely while still accommodating different screen widths
- $namespaceTables = '';
- for ( $i = 0; $i < $numRows; $i += 4 ) {
- $namespaceTables .= Xml::openElement( 'table' );
-
- for ( $j = $i; $j < $i + 4 && $j < $numRows; $j++ ) {
- $namespaceTables .= Xml::tags( 'tr', null, $rows[$j] );
- }
-
- $namespaceTables .= Xml::closeElement( 'table' );
- }
-
- $showSections = [ 'namespaceTables' => $namespaceTables ];
-
- Hooks::run( 'SpecialSearchPowerBox', [ &$showSections, $term, $opts ] );
-
- $hidden = '';
- foreach ( $opts as $key => $value ) {
- $hidden .= Html::hidden( $key, $value );
- }
-
- # Stuff to feed saveNamespaces()
- $remember = '';
- $user = $this->getUser();
- if ( $user->isLoggedIn() ) {
- $remember .= Xml::checkLabel(
- $this->msg( 'powersearch-remember' )->text(),
- 'nsRemember',
- 'mw-search-powersearch-remember',
- false,
- // The token goes here rather than in a hidden field so it
- // is only sent when necessary (not every form submission).
- [ 'value' => $user->getEditToken(
- 'searchnamespace',
- $this->getRequest()
- ) ]
- );
- }
-
- // Return final output
- return Xml::openElement( 'fieldset', [ 'id' => 'mw-searchoptions' ] ) .
- Xml::element( 'legend', null, $this->msg( 'powersearch-legend' )->text() ) .
- Xml::tags( 'h4', null, $this->msg( 'powersearch-ns' )->parse() ) .
- Xml::element( 'div', [ 'id' => 'mw-search-togglebox' ], '', false ) .
- Xml::element( 'div', [ 'class' => 'divider' ], '', false ) .
- implode( Xml::element( 'div', [ 'class' => 'divider' ], '', false ), $showSections ) .
- $hidden .
- Xml::element( 'div', [ 'class' => 'divider' ], '', false ) .
- $remember .
- Xml::closeElement( 'fieldset' );
- }
-
/**
* @return array
*/
return $profiles;
}
- /**
- * @param string $term
- * @return string
- */
- protected function searchProfileTabs( $term ) {
- $out = Html::element( 'div', [ 'class' => 'mw-search-visualclear' ] ) .
- Xml::openElement( 'div', [ 'class' => 'mw-search-profile-tabs' ] );
-
- $bareterm = $term;
- if ( $this->startsWithImage( $term ) ) {
- // Deletes prefixes
- $bareterm = substr( $term, strpos( $term, ':' ) + 1 );
- }
-
- $profiles = $this->getSearchProfiles();
- $lang = $this->getLanguage();
-
- // Outputs XML for Search Types
- $out .= Xml::openElement( 'div', [ 'class' => 'search-types' ] );
- $out .= Xml::openElement( 'ul' );
- foreach ( $profiles as $id => $profile ) {
- if ( !isset( $profile['parameters'] ) ) {
- $profile['parameters'] = [];
- }
- $profile['parameters']['profile'] = $id;
-
- $tooltipParam = isset( $profile['namespace-messages'] ) ?
- $lang->commaList( $profile['namespace-messages'] ) : null;
- $out .= Xml::tags(
- 'li',
- [
- 'class' => $this->profile === $id ? 'current' : 'normal'
- ],
- $this->makeSearchLink(
- $bareterm,
- [],
- $this->msg( $profile['message'] )->text(),
- $this->msg( $profile['tooltip'], $tooltipParam )->text(),
- $profile['parameters']
- )
- );
- }
- $out .= Xml::closeElement( 'ul' );
- $out .= Xml::closeElement( 'div' );
- $out .= Xml::element( 'div', [ 'style' => 'clear:both' ], '', false );
- $out .= Xml::closeElement( 'div' );
-
- return $out;
- }
-
- /**
- * @param string $term Search term
- * @return string
- */
- protected function searchOptions( $term ) {
- $out = '';
- $opts = [];
- $opts['profile'] = $this->profile;
-
- if ( $this->isPowerSearch() ) {
- $out .= $this->powerSearchBox( $term, $opts );
- } else {
- $form = '';
- Hooks::run( 'SpecialSearchProfileForm', [ $this, &$form, $this->profile, $term, $opts ] );
- $out .= $form;
- }
-
- return $out;
- }
-
- /**
- * @param string $term
- * @param int $resultsShown
- * @param int $totalNum
- * @return string
- */
- protected function shortDialog( $term, $resultsShown, $totalNum ) {
- $searchWidget = new MediaWiki\Widget\SearchInputWidget( [
- 'id' => 'searchText',
- 'name' => 'search',
- 'autofocus' => trim( $term ) === '',
- 'value' => $term,
- 'dataLocation' => 'content',
- 'infusable' => true,
- ] );
-
- $layout = new OOUI\ActionFieldLayout( $searchWidget, new OOUI\ButtonInputWidget( [
- 'type' => 'submit',
- 'label' => $this->msg( 'searchbutton' )->text(),
- 'flags' => [ 'progressive', 'primary' ],
- ] ), [
- 'align' => 'top',
- ] );
-
- $out =
- Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
- Html::hidden( 'profile', $this->profile ) .
- Html::hidden( 'fulltext', 'Search' ) .
- $layout;
-
- // Results-info
- if ( $totalNum > 0 && $this->offset < $totalNum ) {
- $top = $this->msg( 'search-showingresults' )
- ->numParams( $this->offset + 1, $this->offset + $resultsShown, $totalNum )
- ->numParams( $resultsShown )
- ->parse();
- $out .= Xml::tags( 'div', [ 'class' => 'results-info' ], $top );
- }
-
- return $out;
- }
-
- /**
- * Make a search link with some target namespaces
- *
- * @param string $term
- * @param array $namespaces Ignored
- * @param string $label Link's text
- * @param string $tooltip Link's tooltip
- * @param array $params Query string parameters
- * @return string HTML fragment
- */
- protected function makeSearchLink( $term, $namespaces, $label, $tooltip, $params = [] ) {
- $opt = $params;
- foreach ( $namespaces as $n ) {
- $opt['ns' . $n] = 1;
- }
-
- $stParams = array_merge(
- [
- 'search' => $term,
- 'fulltext' => $this->msg( 'search' )->text()
- ],
- $opt
- );
-
- return Xml::element(
- 'a',
- [
- 'href' => $this->getPageTitle()->getLocalURL( $stParams ),
- 'title' => $tooltip
- ],
- $label
- );
- }
-
- /**
- * Check if query starts with image: prefix
- *
- * @param string $term The string to check
- * @return bool
- */
- protected function startsWithImage( $term ) {
- global $wgContLang;
-
- $parts = explode( ':', $term );
- if ( count( $parts ) > 1 ) {
- return $wgContLang->getNsIndex( $parts[0] ) == NS_FILE;
- }
-
- return false;
- }
-
/**
* @since 1.18
*
dépôts / lhc / web / wiklou.git / blobdiff