* @ingroup SpecialPage
*/
class SpecialSearch extends SpecialPage {
- /// Current search profile
+ /**
+ * Current search profile. Search profile is just a name that identifies
+ * the active search tab on the search page (content, help, 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.
+ * null|string
+ */
protected $profile;
/// Search engine
/// No idea, apparently used by some other classes
protected $mPrefix;
+ /**
+ * @var int
+ */
+ protected $limit, $offset;
+
+ /**
+ * @var array
+ */
+ protected $namespaces;
+
+ /**
+ * @var bool
+ */
+ protected $searchRedirects;
+
+ /**
+ * @var string
+ */
+ protected $didYouMeanHtml, $fulltext;
+
const NAMESPACES_CURRENT = 'sense';
public function __construct() {
* @param $par String or null
*/
public function execute( $par ) {
- global $wgRequest, $wgUser, $wgOut;
-
$this->setHeaders();
$this->outputHeader();
- $wgOut->allowClickjacking();
- $wgOut->addModuleStyles( 'mediawiki.special' );
+ $out = $this->getOutput();
+ $out->allowClickjacking();
+ $out->addModuleStyles( 'mediawiki.special' );
// 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 );
+ $request = $this->getRequest();
+
// Fetch the search term
- $search = str_replace( "\n", " ", $wgRequest->getText( 'search', $titleParam ) );
+ $search = str_replace( "\n", " ", $request->getText( 'search', $titleParam ) );
- $this->load( $wgRequest, $wgUser );
+ $this->load();
- if ( $wgRequest->getVal( 'fulltext' )
- || !is_null( $wgRequest->getVal( 'offset' ) )
- || !is_null( $wgRequest->getVal( 'searchx' ) ) )
+ if ( $request->getVal( 'fulltext' )
+ || !is_null( $request->getVal( 'offset' ) )
+ || !is_null( $request->getVal( 'searchx' ) ) )
{
$this->showResults( $search );
} else {
/**
* Set up basic search parameters from the request and user settings.
- * Typically you'll pass $wgRequest and $wgUser.
- *
- * @param $request WebRequest
- * @param $user User
*/
- public function load( &$request, &$user ) {
+ public function load() {
+ $request = $this->getRequest();
list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
$this->mPrefix = $request->getVal( 'prefix', '' );
-
+ $user = $this->getUser();
# Extract manually requested namespaces
$nslist = $this->powerSearch( $request );
$this->profile = $profile = $request->getVal( 'profile', null );
// Redirects defaults to true, but we don't know whether it was ticked of or just missing
$default = $request->getBool( 'profile' ) ? 0 : 1;
$this->searchRedirects = $request->getBool( 'redirs', $default ) ? 1 : 0;
- $this->sk = $this->getSkin();
$this->didYouMeanHtml = ''; # html of did you mean... link
$this->fulltext = $request->getVal('fulltext');
}
* @param $term String
*/
public function goResult( $term ) {
- global $wgOut;
$this->setupPage( $term );
# Try to go to page as entered.
$t = Title::newFromText( $term );
}
if( !is_null( $t ) ) {
- $wgOut->redirect( $t->getFullURL() );
+ $this->getOutput()->redirect( $t->getFullURL() );
return;
}
# No match, generate an edit URL
# If the feature is enabled, go straight to the edit page
if( $wgGoToEdit ) {
- $wgOut->redirect( $t->getFullURL( array( 'action' => 'edit' ) ) );
+ $this->getOutput()->redirect( $t->getFullURL( array( 'action' => 'edit' ) ) );
return;
}
}
* @param $term String
*/
public function showResults( $term ) {
- global $wgOut, $wgDisableTextSearch, $wgContLang, $wgScript;
+ global $wgDisableTextSearch, $wgSearchForwardUrl, $wgContLang, $wgScript;
wfProfileIn( __METHOD__ );
- $sk = $this->getSkin();
-
$search = $this->getSearchEngine();
$search->setLimitOffset( $this->limit, $this->offset );
$search->setNamespaces( $this->namespaces );
$this->setupPage( $term );
- if( $wgDisableTextSearch ) {
- global $wgSearchForwardUrl;
- if( $wgSearchForwardUrl ) {
+ $out = $this->getOutput();
+
+ if ( $wgDisableTextSearch ) {
+ if ( $wgSearchForwardUrl ) {
$url = str_replace( '$1', urlencode( $term ), $wgSearchForwardUrl );
- $wgOut->redirect( $url );
- wfProfileOut( __METHOD__ );
- return;
+ $out->redirect( $url );
+ } else {
+ $out->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( 'UTF-8' ),
+ htmlspecialchars( wfMsg( 'searchbutton' ) )
+ ) .
+ Xml::closeElement( 'fieldset' )
+ );
}
- $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( 'UTF-8' ),
- htmlspecialchars( wfMsg( 'searchbutton' ) )
- ) .
- Xml::closeElement( 'fieldset' )
- );
wfProfileOut( __METHOD__ );
return;
}
$rewritten = $search->replacePrefixes($term);
$titleMatches = $search->searchTitle( $rewritten );
- if( !($titleMatches instanceof SearchResultTooMany))
+ if( !( $titleMatches instanceof SearchResultTooMany ) ) {
$textMatches = $search->searchText( $rewritten );
+ }
// did you mean... suggestions
if( $textMatches && $textMatches->hasSuggestion() ) {
# 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(
$didYouMeanParams,
$suggestionSnippet = $textMatches->getSuggestionSnippet();
- if( $suggestionSnippet == '' )
+ if( $suggestionSnippet == '' ) {
$suggestionSnippet = null;
+ }
- $suggestLink = $sk->linkKnown(
+ $suggestLink = Linker::linkKnown(
$st,
$suggestionSnippet,
array(),
$this->didYouMeanHtml = '<div class="searchdidyoumean">'.wfMsg('search-suggest',$suggestLink).'</div>';
}
// start rendering the page
- $wgOut->addHtml(
+ $out->addHtml(
Xml::openElement(
'form',
array(
)
)
);
- $wgOut->addHtml(
+ $out->addHtml(
Xml::openElement( 'table', array( 'id'=>'mw-search-top-table', 'border'=>0, 'cellpadding'=>0, 'cellspacing'=>0 ) ) .
Xml::openElement( 'tr' ) .
Xml::openElement( 'td' ) . "\n" .
// Sometimes the search engine knows there are too many hits
if( $titleMatches instanceof SearchResultTooMany ) {
- $wgOut->wrapWikiMsg( "==$1==\n", 'toomanymatches' );
+ $out->wrapWikiMsg( "==$1==\n", 'toomanymatches' );
wfProfileOut( __METHOD__ );
return;
}
$filePrefix = $wgContLang->getFormattedNsText(NS_FILE).':';
if( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
- $wgOut->addHTML( $this->formHeader( $term, 0, 0 ) );
- $wgOut->addHtml( $this->getProfileForm( $this->profile, $term ) );
- $wgOut->addHTML( '</form>' );
+ $out->addHTML( $this->formHeader( $term, 0, 0 ) );
+ $out->addHtml( $this->getProfileForm( $this->profile, $term ) );
+ $out->addHTML( '</form>' );
// Empty query -- straight view of search form
wfProfileOut( __METHOD__ );
return;
$totalRes += $textMatches->getTotalHits();
// show number of results and current offset
- $wgOut->addHTML( $this->formHeader( $term, $num, $totalRes ) );
- $wgOut->addHtml( $this->getProfileForm( $this->profile, $term ) );
+ $out->addHTML( $this->formHeader( $term, $num, $totalRes ) );
+ $out->addHtml( $this->getProfileForm( $this->profile, $term ) );
- $wgOut->addHtml( Xml::closeElement( 'form' ) );
- $wgOut->addHtml( "<div class='searchresults'>" );
+ $out->addHtml( Xml::closeElement( 'form' ) );
+ $out->addHtml( "<div class='searchresults'>" );
// prev/next links
if( $num || $this->offset ) {
wfArrayToCGI( $this->powerSearchOptions(), array( 'search' => $term ) ),
max( $titleMatchesNum, $textMatchesNum ) < $this->limit
);
- //$wgOut->addHTML( "<p class='mw-search-pager-top'>{$prevnext}</p>\n" );
+ //$out->addHTML( "<p class='mw-search-pager-top'>{$prevnext}</p>\n" );
wfRunHooks( 'SpecialSearchResults', array( $term, &$titleMatches, &$textMatches ) );
} else {
wfRunHooks( 'SpecialSearchNoResults', array( $term ) );
}
- $wgOut->parserOptions()->setEditSection( false );
+ $out->parserOptions()->setEditSection( false );
if( $titleMatches ) {
if( $numTitleMatches > 0 ) {
- $wgOut->wrapWikiMsg( "==$1==\n", 'titlematches' );
- $wgOut->addHTML( $this->showMatches( $titleMatches ) );
+ $out->wrapWikiMsg( "==$1==\n", 'titlematches' );
+ $out->addHTML( $this->showMatches( $titleMatches ) );
}
$titleMatches->free();
}
// output appropriate heading
if( $numTextMatches > 0 && $numTitleMatches > 0 ) {
// if no title matches the heading is redundant
- $wgOut->wrapWikiMsg( "==$1==\n", 'textmatches' );
+ $out->wrapWikiMsg( "==$1==\n", 'textmatches' );
} elseif( $totalRes == 0 ) {
# Don't show the 'no text matches' if we received title matches
- # $wgOut->wrapWikiMsg( "==$1==\n", 'notextmatches' );
+ # $out->wrapWikiMsg( "==$1==\n", 'notextmatches' );
}
// show interwiki results if any
if( $textMatches->hasInterwikiResults() ) {
- $wgOut->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(), $term ) );
+ $out->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(), $term ) );
}
// show results
if( $numTextMatches > 0 ) {
- $wgOut->addHTML( $this->showMatches( $textMatches ) );
+ $out->addHTML( $this->showMatches( $textMatches ) );
}
$textMatches->free();
}
if( $num === 0 ) {
- $wgOut->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", array( 'search-nonefound', wfEscapeWikiText( $term ) ) );
+ $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", array( 'search-nonefound', wfEscapeWikiText( $term ) ) );
$this->showCreateLink( $t );
}
- $wgOut->addHtml( "</div>" );
+ $out->addHtml( "</div>" );
if( $num || $this->offset ) {
- $wgOut->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
+ $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
}
wfProfileOut( __METHOD__ );
}
+ /**
+ * @param $t Title
+ */
protected function showCreateLink( $t ) {
- global $wgOut;
-
// show direct page/create link if applicable
+
// Check DBkey !== '' in case of fragment link only.
- $messageName = null;
- if( !is_null($t) && $t->getDBkey() !== '' ) {
- if( $t->isKnown() ) {
- $messageName = 'searchmenu-exists';
- } elseif( $t->userCan( 'create' ) ) {
- $messageName = 'searchmenu-new';
- } else {
- $messageName = 'searchmenu-new-nocreate';
- }
+ if( is_null( $t ) || $t->getDBkey() === '' ) {
+ // invalid title
+ // preserve the paragraph for margins etc...
+ $this->getOutput()->addHtml( '<p></p>' );
+ return;
+ }
+ $messageName = '';
+ if( $t->isKnown() ) {
+ $messageName = 'searchmenu-exists';
+ } elseif( $t->userCan( 'create' ) ) {
+ $messageName = 'searchmenu-new';
+ } else {
+ $messageName = 'searchmenu-new-nocreate';
}
+ $params = array( $messageName, wfEscapeWikiText( $t->getPrefixedText() ) );
+ wfRunHooks( 'SpecialSearchCreateLink', array( $t, &$params ) );
+
+ // Extensions using the hook might still return an empty $messageName
if( $messageName ) {
- $wgOut->wrapWikiMsg( "<p class=\"mw-search-createlink\">\n$1</p>", array( $messageName, wfEscapeWikiText( $t->getPrefixedText() ) ) );
+ $this->getOutput()->wrapWikiMsg( "<p class=\"mw-search-createlink\">\n$1</p>", $params );
} else {
// preserve the paragraph for margins etc...
- $wgOut->addHtml( '<p></p>' );
+ $this->getOutput()->addHtml( '<p></p>' );
}
}
/**
- *
+ * @param $term string
*/
protected function setupPage( $term ) {
- global $wgOut;
-
# Should advanced UI be used?
$this->searchAdvanced = ($this->profile === 'advanced');
+ $out = $this->getOutput();
if( strval( $term ) !== '' ) {
- $wgOut->setPageTitle( wfMsg( 'searchresults') );
- $wgOut->setHTMLTitle( wfMsg( 'pagetitle', wfMsg( 'searchresults-title', $term ) ) );
+ $out->setPageTitle( wfMsg( 'searchresults') );
+ $out->setHTMLTitle( wfMsg( 'pagetitle', wfMsg( 'searchresults-title', $term ) ) );
}
// add javascript specific to special:search
- $wgOut->addModules( 'mediawiki.legacy.search' );
- $wgOut->addModules( 'mediawiki.special.search' );
+ $out->addModules( 'mediawiki.special.search' );
}
/**
* Show whole set of results
*
* @param $matches SearchResultSet
+ *
+ * @return string
*/
protected function showMatches( &$matches ) {
global $wgContLang;
*
* @param $result SearchResult
* @param $terms Array: terms to highlight
+ *
+ * @return string
*/
protected function showHit( $result, $terms ) {
- global $wgLang;
wfProfileIn( __METHOD__ );
if( $result->isBrokenTitle() ) {
return "<!-- Broken link in search result -->\n";
}
- $sk = $this->getSkin();
$t = $result->getTitle();
$titleSnippet = $result->getTitleSnippet($terms);
wfRunHooks( 'ShowSearchHitTitle',
array( &$link_t, &$titleSnippet, $result, $terms, $this ) );
- $link = $this->sk->linkKnown(
+ $link = Linker::linkKnown(
$link_t,
$titleSnippet
);
$redirect = "<span class='searchalttitle'>" .
wfMsg(
'search-redirect',
- $this->sk->linkKnown(
+ Linker::linkKnown(
$redirectTitle,
$redirectText
)
$section = "<span class='searchalttitle'>" .
wfMsg(
- 'search-section', $this->sk->linkKnown(
+ 'search-section', Linker::linkKnown(
$sectionTitle,
$sectionText
)
// format text extract
$extract = "<div class='searchresult'>".$result->getTextSnippet($terms)."</div>";
+ $lang = $this->getLang();
+
// format score
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 ) )
+ $score = wfMsg( 'search-result-score', $lang->formatNum( $percent ) )
. ' - ';
}
$size = wfMsgExt(
'search-result-size',
array( 'parsemag', 'escape' ),
- $wgLang->formatSize( $byteSize ),
- $wgLang->formatNum( $wordCount )
+ $lang->formatSize( $byteSize ),
+ $lang->formatNum( $wordCount )
);
if( $t->getNamespace() == NS_CATEGORY ) {
$size = wfMsgExt(
'search-result-category-size',
array( 'parsemag', 'escape' ),
- $wgLang->formatNum( $cat->getPageCount() ),
- $wgLang->formatNum( $cat->getSubcatCount() ),
- $wgLang->formatNum( $cat->getFileCount() )
+ $lang->formatNum( $cat->getPageCount() ),
+ $lang->formatNum( $cat->getSubcatCount() ),
+ $lang->formatNum( $cat->getFileCount() )
);
}
- $date = $wgLang->timeanddate( $timestamp );
+ $date = $lang->timeanddate( $timestamp );
// link to related articles if supported
$related = '';
)
);
- $related = ' -- ' . $sk->linkKnown(
+ $related = ' -- ' . Linker::linkKnown(
$st,
wfMsg('search-relatedarticle'),
array(),
*
* @param $matches SearchResultSet
* @param $query String
+ *
+ * @return string
*/
protected function showInterwiki( &$matches, $query ) {
global $wgContLang;
* @param $terms Array
* @param $query String
* @param $customCaptions Array: iw prefix -> caption
+ *
+ * @return string
*/
protected function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) {
wfProfileIn( __METHOD__ );
if( $titleSnippet == '' )
$titleSnippet = null;
- $link = $this->sk->linkKnown(
+ $link = Linker::linkKnown(
$t,
$titleSnippet
);
$redirect = "<span class='searchalttitle'>" .
wfMsg(
'search-redirect',
- $this->sk->linkKnown(
+ Linker::linkKnown(
$redirectTitle,
$redirectText
)
$out = "";
// display project name
if(is_null($lastInterwiki) || $lastInterwiki != $t->getInterwiki()) {
- if( key_exists($t->getInterwiki(),$customCaptions) )
+ if( array_key_exists($t->getInterwiki(),$customCaptions) ) {
// captions from 'search-interwiki-custom'
$caption = $customCaptions[$t->getInterwiki()];
- else{
+ } 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());
+ $parsed = wfParseUrl( $t->getFullURL() );
$caption = wfMsg('search-interwiki-default', $parsed['host']);
}
// "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(
+ $searchLink = Linker::linkKnown(
$searchTitle,
wfMsg('search-interwiki-more'),
array(),
return $out;
}
+ /**
+ * @param $profile
+ * @param $term
+ * @return String
+ */
protected function getProfileForm( $profile, $term ) {
// Hidden stuff
$opts = array();
* Generates the power search box at [[Special:Search]]
*
* @param $term String: search term
+ * @param $opts array
* @return String: HTML form
*/
protected function powerSearchBox( $term, $opts ) {
}
$namespaceTables .= Xml::closeElement( 'table' );
}
+
+ $showSections = array( 'namespaceTables' => $namespaceTables );
+
// Show redirects check only if backend supports it
- $redirects = '';
if( $this->getSearchEngine()->supports( 'list-redirects' ) ) {
- $redirects =
+ $showSections['redirects'] =
Xml::checkLabel( wfMsg( 'powersearch-redir' ), 'redirs', 'redirs', $this->searchRedirects );
}
+ wfRunHooks( 'SpecialSearchPowerBox', array( &$showSections, $term, $opts ) );
+
$hidden = '';
unset( $opts['redirs'] );
foreach( $opts as $key => $value ) {
array(
'type'=>'button',
'id' => 'mw-search-toggleall',
- 'onclick' => 'mwToggleSearchCheckboxes("all");',
'value' => wfMsg( 'powersearch-toggleall' )
)
) .
array(
'type'=>'button',
'id' => 'mw-search-togglenone',
- 'onclick' => 'mwToggleSearchCheckboxes("none");',
'value' => wfMsg( 'powersearch-togglenone' )
)
)
) .
Xml::element( 'div', array( 'class' => 'divider' ), '', false ) .
- $namespaceTables .
- Xml::element( 'div', array( 'class' => 'divider' ), '', false ) .
- $redirects . $hidden .
+ implode( Xml::element( 'div', array( 'class' => 'divider' ), '', false ), $showSections ) .
+ $hidden .
Xml::closeElement( 'fieldset' );
}
+ /**
+ * @return array
+ */
protected function getSearchProfiles() {
// Builds list of Search Types (profiles)
$nsAllSet = array_keys( SearchEngine::searchableNamespaces() );
return $profiles;
}
+ /**
+ * @param $term
+ * @param $resultsShown
+ * @param $totalNum
+ * @return string
+ */
protected function formHeader( $term, $resultsShown, $totalNum ) {
- global $wgLang;
-
$out = Xml::openElement('div', array( 'class' => 'mw-search-formheader' ) );
$bareterm = $term;
}
$profiles = $this->getSearchProfiles();
+ $lang = $this->getLang();
// Outputs XML for Search Types
$out .= Xml::openElement( 'div', array( 'class' => 'search-types' ) );
$profile['parameters']['profile'] = $id;
$tooltipParam = isset( $profile['namespace-messages'] ) ?
- $wgLang->commaList( $profile['namespace-messages'] ) : null;
+ $lang->commaList( $profile['namespace-messages'] ) : null;
$out .= Xml::tags(
'li',
array(
if ( $resultsShown > 0 ) {
if ( $totalNum > 0 ){
$top = wfMsgExt( 'showingresultsheader', array( 'parseinline' ),
- $wgLang->formatNum( $this->offset + 1 ),
- $wgLang->formatNum( $this->offset + $resultsShown ),
- $wgLang->formatNum( $totalNum ),
+ $lang->formatNum( $this->offset + 1 ),
+ $lang->formatNum( $this->offset + $resultsShown ),
+ $lang->formatNum( $totalNum ),
wfEscapeWikiText( $term ),
- $wgLang->formatNum( $resultsShown )
+ $lang->formatNum( $resultsShown )
);
} elseif ( $resultsShown >= $this->limit ) {
$top = wfShowingResults( $this->offset, $this->limit );
} else {
- $top = wfShowingResultsNum( $this->offset, $this->limit, $resultsShown );
+ $top = wfMsgExt( 'showingresultsnum', array( 'parseinline' ),
+ $lang->formatNum( $this->limit ),
+ $lang->formatNum( $this->offset + 1 ),
+ $lang->formatNum( $resultsShown )
+ );
}
$out .= Xml::tags( 'div', array( 'class' => 'results-info' ),
Xml::tags( 'ul', null, Xml::tags( 'li', null, $top ) )
return $out;
}
+ /**
+ * @param $term string
+ * @return string
+ */
protected function shortDialog( $term ) {
$out = Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
// Term box
'a',
array(
'href' => $this->getTitle()->getLocalURL( $stParams ),
- 'title' => $tooltip,
- 'onmousedown' => 'mwSearchHeaderClick(this);',
- 'onkeydown' => 'mwSearchHeaderClick(this);'),
+ 'title' => $tooltip),
$label
);
}
/**
* @since 1.18
+ *
+ * @return SearchEngine
*/
public function getSearchEngine() {
if ( $this->searchEngine === null ) {
* add more params to links to not lose selection when
* user navigates search results.
* @since 1.18
+ *
+ * @param $key
+ * @param $value
*/
public function setExtraParam( $key, $value ) {
$this->extraParams[$key] = $value;