2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
3 # http://www.mediawiki.org/
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 # http://www.gnu.org/copyleft/gpl.html
21 * Run text & title search and display the output
22 * @addtogroup SpecialPage
28 * @param $par String: (default '')
30 function wfSpecialSearch( $par = '' ) {
31 global $wgRequest, $wgUser;
33 $search = $wgRequest->getText( 'search', $par );
34 $searchPage = new SpecialSearch( $wgRequest, $wgUser );
35 if( $wgRequest->getVal( 'fulltext' ) ||
36 !is_null( $wgRequest->getVal( 'offset' ) ) ||
37 !is_null ($wgRequest->getVal( 'searchx' ) ) ) {
38 $searchPage->showResults( $search );
40 $searchPage->goResult( $search );
45 * implements Special:Search - Run text & title search and display the output
46 * @addtogroup SpecialPage
51 * Set up basic search parameters from the request and user settings.
52 * Typically you'll pass $wgRequest and $wgUser.
54 * @param WebRequest $request
58 function SpecialSearch( &$request, &$user ) {
59 list( $this->limit
, $this->offset
) = $request->getLimitOffset( 20, 'searchlimit' );
61 if( $request->getCheck( 'searchx' ) ) {
62 $this->namespaces
= $this->powerSearch( $request );
64 $this->namespaces
= $this->userNamespaces( $user );
67 $this->searchRedirects
= $request->getcheck( 'redirs' ) ?
true : false;
71 * If an exact title match can be found, jump straight ahead to it.
75 function goResult( $term ) {
79 $this->setupPage( $term );
81 # Try to go to page as entered.
82 $t = Title
::newFromText( $term );
84 # If the string cannot be used to create a title
86 return $this->showResults( $term );
89 # If there's an exact or very near match, jump right there.
90 $t = SearchEngine
::getNearMatch( $term );
91 if( !is_null( $t ) ) {
92 $wgOut->redirect( $t->getFullURL() );
96 # No match, generate an edit URL
97 $t = Title
::newFromText( $term );
98 if( ! is_null( $t ) ) {
99 wfRunHooks( 'SpecialSearchNogomatch', array( &$t ) );
100 # If the feature is enabled, go straight to the edit page
102 $wgOut->redirect( $t->getFullURL( 'action=edit' ) );
106 if( $t->quickUserCan( 'create' ) && $t->quickUserCan( 'edit' ) ) {
107 $wgOut->addWikiText( wfMsg( 'noexactmatch', wfEscapeWikiText( $term ) ) );
109 $wgOut->addWikiText( wfMsg( 'noexactmatch-nocreate', wfEscapeWikiText( $term ) ) );
112 return $this->showResults( $term );
116 * @param string $term
119 function showResults( $term ) {
120 $fname = 'SpecialSearch::showResults';
121 wfProfileIn( $fname );
123 $this->setupPage( $term );
126 $wgOut->addWikiText( wfMsg( 'searchresulttext' ) );
128 if( '' === trim( $term ) ) {
129 // Empty query -- straight view of search form
130 $wgOut->setSubtitle( '' );
131 $wgOut->addHTML( $this->powerSearchBox( $term ) );
132 $wgOut->addHTML( $this->powerSearchFocus() );
133 wfProfileOut( $fname );
137 global $wgDisableTextSearch;
138 if ( $wgDisableTextSearch ) {
139 global $wgForwardSearchUrl;
140 if( $wgForwardSearchUrl ) {
141 $url = str_replace( '$1', urlencode( $term ), $wgForwardSearchUrl );
142 $wgOut->redirect( $url );
145 global $wgInputEncoding;
146 $wgOut->addHTML( wfMsg( 'searchdisabled' ) );
148 wfMsg( 'googlesearch',
149 htmlspecialchars( $term ),
150 htmlspecialchars( $wgInputEncoding ),
151 htmlspecialchars( wfMsg( 'searchbutton' ) )
154 wfProfileOut( $fname );
158 $search = SearchEngine
::create();
159 $search->setLimitOffset( $this->limit
, $this->offset
);
160 $search->setNamespaces( $this->namespaces
);
161 $search->showRedirects
= $this->searchRedirects
;
162 $titleMatches = $search->searchTitle( $term );
163 $textMatches = $search->searchText( $term );
165 $num = ( $titleMatches ?
$titleMatches->numRows() : 0 )
166 +
( $textMatches ?
$textMatches->numRows() : 0);
168 if ( $num >= $this->limit
) {
169 $top = wfShowingResults( $this->offset
, $this->limit
);
171 $top = wfShowingResultsNum( $this->offset
, $this->limit
, $num );
173 $wgOut->addHTML( "<p>{$top}</p>\n" );
176 if( $num ||
$this->offset
) {
177 $prevnext = wfViewPrevNext( $this->offset
, $this->limit
,
178 SpecialPage
::getTitleFor( 'Search' ),
180 $this->powerSearchOptions(),
181 array( 'search' => $term ) ),
182 ($num < $this->limit
) );
183 $wgOut->addHTML( "<br />{$prevnext}\n" );
186 if( $titleMatches ) {
187 if( $titleMatches->numRows() ) {
188 $wgOut->addWikiText( '==' . wfMsg( 'titlematches' ) . "==\n" );
189 $wgOut->addHTML( $this->showMatches( $titleMatches ) );
191 $wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
193 $titleMatches->free();
197 if( $textMatches->numRows() ) {
198 $wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
199 $wgOut->addHTML( $this->showMatches( $textMatches ) );
200 } elseif( $num == 0 ) {
201 # Don't show the 'no text matches' if we received title matches
202 $wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
204 $textMatches->free();
208 $wgOut->addWikiText( wfMsg( 'nonefound' ) );
210 if( $num ||
$this->offset
) {
211 $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
213 $wgOut->addHTML( $this->powerSearchBox( $term ) );
214 wfProfileOut( $fname );
217 #------------------------------------------------------------------
218 # Private methods below this line
223 function setupPage( $term ) {
225 $wgOut->setPageTitle( wfMsg( 'searchresults' ) );
226 $subtitlemsg = ( Title
::newFromText($term) ?
'searchsubtitle' : 'searchsubtitleinvalid' );
227 $wgOut->setSubtitle( $wgOut->parse( wfMsg( $subtitlemsg, wfEscapeWikiText($term) ) ) );
228 $wgOut->setArticleRelated( false );
229 $wgOut->setRobotpolicy( 'noindex,nofollow' );
233 * Extract default namespaces to search from the given user's
234 * settings, returning a list of index numbers.
240 function userNamespaces( &$user ) {
242 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
243 if( $user->getOption( 'searchNs' . $ns ) ) {
251 * Extract "power search" namespace settings from the request object,
252 * returning a list of index numbers to search.
254 * @param WebRequest $request
258 function powerSearch( &$request ) {
260 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
261 if( $request->getCheck( 'ns' . $ns ) ) {
269 * Reconstruct the 'power search' options for links
273 function powerSearchOptions() {
275 foreach( $this->namespaces
as $n ) {
278 $opt['redirs'] = $this->searchRedirects ?
1 : 0;
284 * @param SearchResultSet $matches
285 * @param string $terms partial regexp for highlighting terms
287 function showMatches( &$matches ) {
288 $fname = 'SpecialSearch::showMatches';
289 wfProfileIn( $fname );
292 $tm = $wgContLang->convertForSearchResult( $matches->termMatches() );
293 $terms = implode( '|', $tm );
295 $off = $this->offset +
1;
296 $out = "<ol start='{$off}'>\n";
298 while( $result = $matches->next() ) {
299 $out .= $this->showHit( $result, $terms );
303 // convert the whole thing to desired language variant
305 $out = $wgContLang->convert( $out );
306 wfProfileOut( $fname );
311 * Format a single hit result
312 * @param SearchResult $result
313 * @param string $terms partial regexp for highlighting terms
315 function showHit( $result, $terms ) {
316 $fname = 'SpecialSearch::showHit';
317 wfProfileIn( $fname );
318 global $wgUser, $wgContLang, $wgLang;
320 $t = $result->getTitle();
321 if( is_null( $t ) ) {
322 wfProfileOut( $fname );
323 return "<!-- Broken link in search result -->\n";
325 $sk = $wgUser->getSkin();
327 $contextlines = $wgUser->getOption( 'contextlines', 5 );
328 $contextchars = $wgUser->getOption( 'contextchars', 50 );
330 $link = $sk->makeKnownLinkObj( $t );
332 //If page content is not readable, just return the title.
333 //This is not quite safe, but better than showing excerpts from non-readable pages
334 //Note that hiding the entry entirely would screw up paging.
335 if (!$t->userCanRead()) {
336 return "<li>{$link}</li>\n";
339 $revision = Revision
::newFromTitle( $t );
340 $text = $revision->getText();
341 $size = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
342 $wgLang->formatNum( strlen( $text ) ) );
344 $lines = explode( "\n", $text );
346 $max = intval( $contextchars ) +
1;
347 $pat1 = "/(.*)($terms)(.{0,$max})/i";
352 wfProfileIn( "$fname-extract" );
353 foreach ( $lines as $line ) {
354 if ( 0 == $contextlines ) {
359 if ( ! preg_match( $pat1, $line, $m ) ) {
363 $pre = $wgContLang->truncate( $m[1], -$contextchars, '...' );
365 if ( count( $m ) < 3 ) {
368 $post = $wgContLang->truncate( $m[3], $contextchars, '...' );
373 $line = htmlspecialchars( $pre . $found . $post );
374 $pat2 = '/(' . $terms . ")/i";
375 $line = preg_replace( $pat2,
376 "<span class='searchmatch'>\\1</span>", $line );
378 $extract .= "<br /><small>{$lineno}: {$line}</small>\n";
380 wfProfileOut( "$fname-extract" );
381 wfProfileOut( $fname );
382 return "<li>{$link} ({$size}){$extract}</li>\n";
385 function powerSearchBox( $term ) {
387 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
388 $checked = in_array( $ns, $this->namespaces
)
389 ?
' checked="checked"'
391 $name = str_replace( '_', ' ', $name );
393 $name = wfMsg( 'blanknamespace' );
395 $namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
396 "ns{$ns}\"{$checked} />{$name}</label>\n";
399 $checked = $this->searchRedirects
400 ?
' checked="checked"'
402 $redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
404 $searchField = '<input type="text" id="powerSearchText" name="search" value="' .
405 htmlspecialchars( $term ) ."\" size=\"16\" />\n";
407 $searchButton = '<input type="submit" name="searchx" value="' .
408 htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
410 $ret = wfMsg( 'powersearchtext',
411 $namespaces, $redirect, $searchField,
412 '', '', '', '', '', # Dummy placeholders
415 $title = SpecialPage
::getTitleFor( 'Search' );
416 $action = $title->escapeLocalURL();
417 return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
418 "action=\"$action\">\n{$ret}\n</form>\n";
421 function powerSearchFocus() {
422 return "<script type='text/javascript'>" .
423 "document.getElementById('powerSearchText').focus();" .