# 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
* @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 ) );
$class = $wgUseOldSearchUI ? 'SpecialSearchOld' : 'SpecialSearch';
$searchPage = new $class( $wgRequest, $wgUser );
if( $wgRequest->getVal( 'fulltext' )
|| !is_null( $wgRequest->getVal( 'offset' ))
|| !is_null( $wgRequest->getVal( 'searchx' )) )
{
$searchPage->showResults( $search, 'search' );
} else {
$searchPage->goResult( $search );
}
}
/**
* implements Special:Search - Run text & title search and display the output
* @ingroup SpecialPage
*/
class SpecialSearch {
/**
* 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
*/
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' ) ? true : false;
$this->searchAdvanced = $request->getVal( 'advanced' );
$this->active = 'advanced';
$this->sk = $user->getSkin();
$this->didYouMeanHtml = ''; # html of did you mean... link
}
/**
* If an exact title match can be found, jump straight ahead to it.
* @param string $term
*/
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( !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 ) );
# If the feature is enabled, go straight to the edit page
if( $wgGoToEdit ) {
$wgOut->redirect( $t->getFullURL( 'action=edit' ) );
return;
}
}
return $this->showResults( $term );
}
/**
* @param string $term
*/
public function showResults( $term ) {
global $wgOut, $wgUser, $wgDisableTextSearch, $wgContLang;
wfProfileIn( __METHOD__ );
$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' );
$stParams = wfArrayToCGI(
array( 'search' => $textMatches->getSuggestionQuery(), 'fulltext' => wfMsg('search') ),
$this->powerSearchOptions()
);
$suggestLink = $sk->makeKnownLinkObj( $st,
$textMatches->getSuggestionSnippet(),
$stParams );
$this->didYouMeanHtml = '
\n";
// convert the whole thing to desired language variant
$out = $wgContLang->convert( $out );
wfProfileOut( __METHOD__ );
return $out;
}
/**
* Format a single hit result
* @param SearchResult $result
* @param array $terms terms to highlight
*/
protected function showHit( $result, $terms ) {
global $wgContLang, $wgLang, $wgUser;
wfProfileIn( __METHOD__ );
if( $result->isBrokenTitle() ) {
wfProfileOut( __METHOD__ );
return "\n";
}
$sk = $wgUser->getSkin();
$t = $result->getTitle();
$link = $this->sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
//If page content is not readable, just return the title.
//This is not quite safe, but better than showing excerpts from non-readable pages
//Note that hiding the entry entirely would screw up paging.
if( !$t->userCanRead() ) {
wfProfileOut( __METHOD__ );
return "
{$link}
\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() ) {
wfProfileOut( __METHOD__ );
return "\n";
}
// format redirects / relevant sections
$redirectTitle = $result->getRedirectTitle();
$redirectText = $result->getRedirectSnippet($terms);
$sectionTitle = $result->getSectionTitle();
$sectionText = $result->getSectionSnippet($terms);
$redirect = '';
if( !is_null($redirectTitle) )
$redirect = ""
.wfMsg('search-redirect',$this->sk->makeKnownLinkObj( $redirectTitle, $redirectText))
."";
$section = '';
if( !is_null($sectionTitle) )
$section = ""
.wfMsg('search-section', $this->sk->makeKnownLinkObj( $sectionTitle, $sectionText))
."";
// format text extract
$extract = "
".$result->getTextSnippet($terms)."
";
// 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 ) )
. ' - ';
}
// format description
$byteSize = $result->getByteSize();
$wordCount = $result->getWordCount();
$timestamp = $result->getTimestamp();
$size = wfMsgExt( 'search-result-size', array( 'parsemag', 'escape' ),
$this->sk->formatSize( $byteSize ), $wordCount );
$date = $wgLang->timeanddate( $timestamp );
// link to related articles if supported
$related = '';
if( $result->hasRelated() ) {
$st = SpecialPage::getTitleFor( 'Search' );
$stParams = wfArrayToCGI( $this->powerSearchOptions(),
array('search' => wfMsgForContent('searchrelated').':'.$t->getPrefixedText(),
'fulltext' => wfMsg('search') ));
$related = ' -- ' . $sk->makeKnownLinkObj( $st,
wfMsg('search-relatedarticle'), $stParams );
}
// Include a thumbnail for media files...
if( $t->getNamespace() == NS_FILE ) {
$img = wfFindFile( $t );
if( $img ) {
$thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
if( $thumb ) {
$desc = $img->getShortDesc();
wfProfileOut( __METHOD__ );
// 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 "
\n";
}
/**
* Show results from other wikis
*
* @param SearchResultSet $matches
*/
protected function showInterwiki( &$matches, $query ) {
global $wgContLang;
wfProfileIn( __METHOD__ );
$terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
$out = "
".
wfMsg('search-interwiki-caption')."
\n";
$off = $this->offset + 1;
$out .= "
\n";
// work out custom project captions
$customCaptions = array();
$customLines = explode("\n",wfMsg('search-interwiki-custom')); // format per line :
foreach($customLines as $line) {
$parts = explode(":",$line,2);
if(count($parts) == 2) // validate line
$customCaptions[$parts[0]] = $parts[1];
}
$prev = null;
while( $result = $matches->next() ) {
$out .= $this->showInterwikiHit( $result, $prev, $terms, $query, $customCaptions );
$prev = $result->getInterwikiPrefix();
}
// FIXME: should support paging in a non-confusing way (not sure how though, maybe via ajax)..
$out .= "
\n";
// convert the whole thing to desired language variant
$out = $wgContLang->convert( $out );
wfProfileOut( __METHOD__ );
return $out;
}
/**
* Show single interwiki link
*
* @param SearchResult $result
* @param string $lastInterwiki
* @param array $terms
* @param string $query
* @param array $customCaptions iw prefix -> caption
*/
protected function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) {
wfProfileIn( __METHOD__ );
global $wgContLang, $wgLang;
if( $result->isBrokenTitle() ) {
wfProfileOut( __METHOD__ );
return "\n";
}
$t = $result->getTitle();
$link = $this->sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
// format redirect if any
$redirectTitle = $result->getRedirectTitle();
$redirectText = $result->getRedirectSnippet($terms);
$redirect = '';
if( !is_null($redirectTitle) )
$redirect = ""
.wfMsg('search-redirect',$this->sk->makeKnownLinkObj( $redirectTitle, $redirectText))
."";
$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']);
}
// "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->makeKnownLinkObj( $searchTitle, wfMsg('search-interwiki-more'),
wfArrayToCGI(array('search' => $query, 'fulltext' => 'Search')));
$out .= "
{$searchLink}{$caption}
\n
";
}
$out .= "
{$link} {$redirect}
\n";
wfProfileOut( __METHOD__ );
return $out;
}
/**
* Generates the power search box at bottom of [[Special:Search]]
* @param $term string: search term
* @return $out string: HTML form
*/
protected function powerSearchBox( $term ) {
global $wgScript;
$namespaces = SearchEngine::searchableNamespaces();
$tables = $this->namespaceTables( $namespaces );
$redirect = Xml::check( 'redirs', $this->searchRedirects, array( 'value' => '1', 'id' => 'redirs' ) );
$redirectLabel = Xml::label( wfMsg( 'powersearch-redir' ), 'redirs' );
$searchField = Xml::input( 'search', 50, $term, array( 'type' => 'text', 'id' => 'powerSearchText' ) );
$searchButton = Xml::submitButton( wfMsg( 'powersearch' ), array( 'name' => 'fulltext' )) . "\n";
$searchTitle = SpecialPage::getTitleFor( 'Search' );
$redirectText = '';
// show redirects check only if backend supports it
if( $this->searchEngine->acceptListRedirects() ) {
$redirectText = "
\n";
// convert the whole thing to desired language variant
global $wgContLang;
$out = $wgContLang->convert( $out );
wfProfileOut( __METHOD__ );
return $out;
}
/**
* Format a single hit result
* @param SearchResult $result
* @param array $terms terms to highlight
*/
function showHit( $result, $terms ) {
wfProfileIn( __METHOD__ );
global $wgUser, $wgContLang, $wgLang;
if( $result->isBrokenTitle() ) {
wfProfileOut( __METHOD__ );
return "\n";
}
$t = $result->getTitle();
$sk = $wgUser->getSkin();
$link = $sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
//If page content is not readable, just return the title.
//This is not quite safe, but better than showing excerpts from non-readable pages
//Note that hiding the entry entirely would screw up paging.
if (!$t->userCanRead()) {
wfProfileOut( __METHOD__ );
return "
{$link}
\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() ) {
wfProfileOut( __METHOD__ );
return "\n";
}
// format redirects / relevant sections
$redirectTitle = $result->getRedirectTitle();
$redirectText = $result->getRedirectSnippet($terms);
$sectionTitle = $result->getSectionTitle();
$sectionText = $result->getSectionSnippet($terms);
$redirect = '';
if( !is_null($redirectTitle) )
$redirect = ""
.wfMsg('search-redirect',$sk->makeKnownLinkObj( $redirectTitle, $redirectText))
."";
$section = '';
if( !is_null($sectionTitle) )
$section = ""
.wfMsg('search-section', $sk->makeKnownLinkObj( $sectionTitle, $sectionText))
."";
// format text extract
$extract = "
".$result->getTextSnippet($terms)."
";
// 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 ) )
. ' - ';
}
// format description
$byteSize = $result->getByteSize();
$wordCount = $result->getWordCount();
$timestamp = $result->getTimestamp();
$size = wfMsgExt( 'search-result-size', array( 'parsemag', 'escape' ),
$sk->formatSize( $byteSize ),
$wordCount );
$date = $wgLang->timeanddate( $timestamp );
// link to related articles if supported
$related = '';
if( $result->hasRelated() ){
$st = SpecialPage::getTitleFor( 'Search' );
$stParams = wfArrayToCGI( $this->powerSearchOptions(),
array('search' => wfMsgForContent('searchrelated').':'.$t->getPrefixedText(),
'fulltext' => wfMsg('search') ));
$related = ' -- ' . $sk->makeKnownLinkObj( $st,
wfMsg('search-relatedarticle'), $stParams );
}
// Include a thumbnail for media files...
if( $t->getNamespace() == NS_FILE ) {
$img = wfFindFile( $t );
if( $img ) {
$thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
if( $thumb ) {
$desc = $img->getShortDesc();
wfProfileOut( __METHOD__ );
// Ugly table. :D
// Float doesn't seem to interact well with the bullets.
// Table messes up vertical alignment of the bullet, but I'm
// not sure what more I can do about that. :(
return "
\n";
}
/**
* Show results from other wikis
*
* @param SearchResultSet $matches
*/
function showInterwiki( &$matches, $query ) {
wfProfileIn( __METHOD__ );
global $wgContLang;
$terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
$out = "
".wfMsg('search-interwiki-caption')."
\n";
$off = $this->offset + 1;
$out .= "
\n";
// work out custom project captions
$customCaptions = array();
$customLines = explode("\n",wfMsg('search-interwiki-custom')); // format per line :
foreach($customLines as $line){
$parts = explode(":",$line,2);
if(count($parts) == 2) // validate line
$customCaptions[$parts[0]] = $parts[1];
}
$prev = null;
while( $result = $matches->next() ) {
$out .= $this->showInterwikiHit( $result, $prev, $terms, $query, $customCaptions );
$prev = $result->getInterwikiPrefix();
}
// FIXME: should support paging in a non-confusing way (not sure how though, maybe via ajax)..
$out .= "
\n";
// convert the whole thing to desired language variant
global $wgContLang;
$out = $wgContLang->convert( $out );
wfProfileOut( __METHOD__ );
return $out;
}
/**
* Show single interwiki link
*
* @param SearchResult $result
* @param string $lastInterwiki
* @param array $terms
* @param string $query
* @param array $customCaptions iw prefix -> caption
*/
function showInterwikiHit( $result, $lastInterwiki, $terms, $query, $customCaptions) {
wfProfileIn( __METHOD__ );
global $wgUser, $wgContLang, $wgLang;
if( $result->isBrokenTitle() ) {
wfProfileOut( __METHOD__ );
return "\n";
}
$t = $result->getTitle();
$sk = $wgUser->getSkin();
$link = $sk->makeKnownLinkObj( $t, $result->getTitleSnippet($terms));
// format redirect if any
$redirectTitle = $result->getRedirectTitle();
$redirectText = $result->getRedirectSnippet($terms);
$redirect = '';
if( !is_null($redirectTitle) )
$redirect = ""
.wfMsg('search-redirect',$sk->makeKnownLinkObj( $redirectTitle, $redirectText))
."";
$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']);
}
// "more results" link (special page stuff could be localized, but we might not know target lang)
$searchTitle = Title::newFromText($t->getInterwiki().":Special:Search");
$searchLink = $sk->makeKnownLinkObj( $searchTitle, wfMsg('search-interwiki-more'),
wfArrayToCGI(array('search' => $query, 'fulltext' => 'Search')));
$out .= "
{$searchLink}{$caption}
\n
";
}
$out .= "
{$link} {$redirect}
\n";
wfProfileOut( __METHOD__ );
return $out;
}
/**
* Generates the power search box at bottom of [[Special:Search]]
* @param $term string: search term
* @return $out string: HTML form
*/
function powerSearchBox( $term ) {
global $wgScript, $wgContLang;
$namespaces = SearchEngine::searchableNamespaces();
// group namespaces into rows according to subject; try not to make too
// many assumptions about namespace numbering
$rows = array();
foreach( $namespaces as $ns => $name ) {
$subj = MWNamespace::getSubject( $ns );
if( !array_key_exists( $subj, $rows ) ) {
$rows[$subj] = "";
}
$name = str_replace( '_', ' ', $name );
if( '' == $name ) {
$name = wfMsg( 'blanknamespace' );
}
$rows[$subj] .= Xml::openElement( 'td', array( 'style' => 'white-space: nowrap' ) ) .
Xml::checkLabel( $name, "ns{$ns}", "mw-search-ns{$ns}", in_array( $ns, $this->namespaces ) ) .
Xml::closeElement( 'td' ) . "\n";
}
$rows = array_values( $rows );
$numRows = count( $rows );
// lay out namespaces in multiple floating two-column tables so they'll
// be arranged nicely while still accommodating different screen widths
$rowsPerTable = 3; // seems to look nice
// float to the right on RTL wikis
$tableStyle = ( $wgContLang->isRTL() ?
'float: right; margin: 0 0 1em 1em' :
'float: left; margin: 0 1em 1em 0' );
$tables = "";
for( $i = 0; $i < $numRows; $i += $rowsPerTable ) {
$tables .= Xml::openElement( 'table', array( 'style' => $tableStyle ) );
for( $j = $i; $j < $i + $rowsPerTable && $j < $numRows; $j++ ) {
$tables .= "