<?php
# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
-#
+#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
+# 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.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# 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
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
*/
-/** */
-require_once( 'SearchEngine.php' );
-require_once( 'Revision.php' );
-
/**
* Entry point
*
- * @param string $par (default '')
+ * @param $par String: (default '')
*/
function wfSpecialSearch( $par = '' ) {
global $wgRequest, $wgUser;
-
+
$search = $wgRequest->getText( 'search', $par );
$searchPage = new SpecialSearch( $wgRequest, $wgUser );
if( $wgRequest->getVal( 'fulltext' ) ||
}
/**
- * @todo document
- * @package MediaWiki
- * @subpackage SpecialPage
+ * implements Special:Search - Run text & title search and display the output
+ * @addtogroup SpecialPage
*/
class SpecialSearch {
*
* @param WebRequest $request
* @param User $user
- * @access public
+ * @public
*/
function SpecialSearch( &$request, &$user ) {
list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, 'searchlimit' );
-
+
if( $request->getCheck( 'searchx' ) ) {
$this->namespaces = $this->powerSearch( $request );
} else {
$this->namespaces = $this->userNamespaces( $user );
}
-
- $this->searchRedirects = false;
+
+ $this->searchRedirects = $request->getcheck( 'redirs' ) ? true : false;
}
-
+
/**
- * If an exact title match can be found, jump straight ahead to
+ * If an exact title match can be found, jump straight ahead to it.
* @param string $term
- * @access public
+ * @public
*/
function goResult( $term ) {
global $wgOut;
global $wgGoToEdit;
-
+
$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 ) ){
+ if( is_null( $t ) ){
return $this->showResults( $term );
}
$wgOut->redirect( $t->getFullURL() );
return;
}
-
+
# No match, generate an edit URL
$t = Title::newFromText( $term );
- if( is_null( $t ) ) {
- $editurl = ''; # hrm...
- } else {
+ if( ! is_null( $t ) ) {
+ wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) );
# If the feature is enabled, go straight to the edit page
if ( $wgGoToEdit ) {
$wgOut->redirect( $t->getFullURL( 'action=edit' ) );
return;
- } else {
- $editurl = $t->escapeLocalURL( 'action=edit' );
- }
+ }
}
- $wgOut->addWikiText( wfMsg('nogomatch', ":$term" ) );
+ $wgOut->addWikiText( wfMsg( 'noexactmatch', wfEscapeWikiText( $term ) ) );
return $this->showResults( $term );
}
-
+
/**
* @param string $term
- * @access public
+ * @public
*/
function showResults( $term ) {
$fname = 'SpecialSearch::showResults';
wfProfileIn( $fname );
-
+
$this->setupPage( $term );
-
- global $wgUser, $wgOut;
- $sk = $wgUser->getSkin();
+
+ global $wgOut;
$wgOut->addWikiText( wfMsg( 'searchresulttext' ) );
-
+
#if ( !$this->parseQuery() ) {
if( '' === trim( $term ) ) {
- $wgOut->addWikiText(
- '==' . wfMsg( 'badquery' ) . "==\n" .
- wfMsg( 'badquerytext' ) );
+ $wgOut->setSubtitle( '' );
+ $wgOut->addHTML( $this->powerSearchBox( $term ) );
wfProfileOut( $fname );
return;
}
-
+
global $wgDisableTextSearch;
if ( $wgDisableTextSearch ) {
global $wgForwardSearchUrl;
wfMsg( 'googlesearch',
htmlspecialchars( $term ),
htmlspecialchars( $wgInputEncoding ),
- htmlspecialchars( wfMsg( 'search' ) )
+ htmlspecialchars( wfMsg( 'searchbutton' ) )
)
);
wfProfileOut( $fname );
return;
}
- $search =& SearchEngine::create();
+ $search = SearchEngine::create();
$search->setLimitOffset( $this->limit, $this->offset );
$search->setNamespaces( $this->namespaces );
+ $search->showRedirects = $this->searchRedirects;
$titleMatches = $search->searchTitle( $term );
$textMatches = $search->searchText( $term );
-
+
$num = ( $titleMatches ? $titleMatches->numRows() : 0 )
+ ( $textMatches ? $textMatches->numRows() : 0);
- if ( $num >= $this->limit ) {
- $top = wfShowingResults( $this->offset, $this->limit );
- } else {
- $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
+ if ( $num > 0 ) {
+ if ( $num >= $this->limit ) {
+ $top = wfShowingResults( $this->offset, $this->limit );
+ } else {
+ $top = wfShowingResultsNum( $this->offset, $this->limit, $num );
+ }
+ $wgOut->addHTML( "<p>{$top}</p>\n" );
}
- $wgOut->addHTML( "<p>{$top}</p>\n" );
if( $num || $this->offset ) {
$prevnext = wfViewPrevNext( $this->offset, $this->limit,
- 'Special:Search',
+ SpecialPage::getTitleFor( 'Search' ),
wfArrayToCGI(
$this->powerSearchOptions(),
- array( 'search' => $term ) ) );
+ array( 'search' => $term ) ),
+ ($num < $this->limit) );
$wgOut->addHTML( "<br />{$prevnext}\n" );
}
} else {
$wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
}
+ $titleMatches->free();
}
-
+
if( $textMatches ) {
if( $textMatches->numRows() ) {
$wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
# Don't show the 'no text matches' if we received title matches
$wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
}
+ $textMatches->free();
}
-
+
if ( $num == 0 ) {
$wgOut->addWikiText( wfMsg( 'nonefound' ) );
}
$wgOut->addHTML( $this->powerSearchBox( $term ) );
wfProfileOut( $fname );
}
-
+
#------------------------------------------------------------------
# Private methods below this line
-
+
/**
- *
+ *
*/
function setupPage( $term ) {
global $wgOut;
$wgOut->setPageTitle( wfMsg( 'searchresults' ) );
- $wgOut->setSubtitle( wfMsg( 'searchquery', $term ) );
+ $subtitlemsg = ( Title::newFromText($term) ? 'searchsubtitle' : 'searchsubtitleinvalid' );
+ $wgOut->setSubtitle( $wgOut->parse( wfMsg( $subtitlemsg, wfEscapeWikiText($term) ) ) );
$wgOut->setArticleRelated( false );
$wgOut->setRobotpolicy( 'noindex,nofollow' );
}
-
+
/**
* Extract default namespaces to search from the given user's
* settings, returning a list of index numbers.
*
* @param User $user
* @return array
- * @access private
+ * @private
*/
function userNamespaces( &$user ) {
$arr = array();
}
return $arr;
}
-
+
/**
* Extract "power search" namespace settings from the request object,
* returning a list of index numbers to search.
*
* @param WebRequest $request
* @return array
- * @access private
+ * @private
*/
function powerSearch( &$request ) {
$arr = array();
}
return $arr;
}
-
+
/**
* Reconstruct the 'power search' options for links
* @return array
- * @access private
+ * @private
*/
function powerSearchOptions() {
$opt = array();
$opt['searchx'] = 1;
return $opt;
}
-
+
/**
* @param SearchResultSet $matches
* @param string $terms partial regexp for highlighting terms
function showMatches( &$matches ) {
$fname = 'SpecialSearch::showMatches';
wfProfileIn( $fname );
-
+
global $wgContLang;
$tm = $wgContLang->convertForSearchResult( $matches->termMatches() );
$terms = implode( '|', $tm );
-
- global $wgOut;
+
$off = $this->offset + 1;
$out = "<ol start='{$off}'>\n";
wfProfileOut( $fname );
return $out;
}
-
+
/**
* Format a single hit result
* @param SearchResult $result
function showHit( $result, $terms ) {
$fname = 'SpecialSearch::showHit';
wfProfileIn( $fname );
- global $wgUser, $wgContLang;
+ global $wgUser, $wgContLang, $wgLang;
$t = $result->getTitle();
if( is_null( $t ) ) {
wfProfileOut( $fname );
return "<!-- Broken link in search result -->\n";
}
- $sk =& $wgUser->getSkin();
+ $sk = $wgUser->getSkin();
- $contextlines = $wgUser->getOption( 'contextlines' );
- if ( '' == $contextlines ) { $contextlines = 5; }
- $contextchars = $wgUser->getOption( 'contextchars' );
- if ( '' == $contextchars ) { $contextchars = 50; }
+ $contextlines = $wgUser->getOption( 'contextlines', 5 );
+ $contextchars = $wgUser->getOption( 'contextchars', 50 );
$link = $sk->makeKnownLinkObj( $t );
+
+ //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()) {
+ return "<li>{$link}</li>\n";
+ }
+
$revision = Revision::newFromTitle( $t );
$text = $revision->getText();
- $size = wfMsg( 'nbytes', strlen( $text ) );
+ $size = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
+ $wgLang->formatNum( strlen( $text ) ) );
$lines = explode( "\n", $text );
- $max = IntVal( $contextchars ) + 1;
+ $max = intval( $contextchars ) + 1;
$pat1 = "/(.*)($terms)(.{0,$max})/i";
$lineno = 0;
-
+
$extract = '';
wfProfileIn( "$fname-extract" );
foreach ( $lines as $line ) {
break;
}
++$lineno;
+ $m = array();
if ( ! preg_match( $pat1, $line, $m ) ) {
continue;
}
wfProfileOut( $fname );
return "<li>{$link} ({$size}){$extract}</li>\n";
}
-
+
function powerSearchBox( $term ) {
$namespaces = '';
foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
$namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
"ns{$ns}\"{$checked} />{$name}</label>\n";
}
-
+
$checked = $this->searchRedirects
? ' checked="checked"'
: '';
$redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
-
- $searchField = "<input type='text' name=\"search\" value=\"" .
- htmlspecialchars( $term ) ."\" width=\"80\" />\n";
-
+
+ $searchField = '<input type="text" name="search" value="' .
+ htmlspecialchars( $term ) ."\" size=\"16\" />\n";
+
$searchButton = '<input type="submit" name="searchx" value="' .
htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
-
+
$ret = wfMsg( 'powersearchtext',
$namespaces, $redirect, $searchField,
'', '', '', '', '', # Dummy placeholders
$searchButton );
-
- $title = Title::makeTitle( NS_SPECIAL, 'Search' );
+
+ $title = SpecialPage::getTitleFor( 'Search' );
$action = $title->escapeLocalURL();
return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
"action=\"$action\">\n{$ret}\n</form>\n";
}
}
-?>
+