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 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 # http://www.gnu.org/copyleft/gpl.html
21 * Run text & title search and display the output
23 * @subpackage SpecialPage
26 require_once( 'SearchEngine.php' );
28 function wfSpecialSearch( $par='' ) {
29 global $wgRequest, $wgUser;
31 $search = $wgRequest->getText( 'search', $par );
32 $searchPage = new SpecialSearch( $wgRequest, $wgUser );
33 if( $wgRequest->getVal( 'fulltext' ) ||
34 !is_null( $wgRequest->getVal( 'offset' ) ) ||
35 !is_null ($wgRequest->getVal( 'searchx' ) ) ) {
36 $searchPage->showResults( $search );
38 $searchPage->goResult( $search );
45 * Set up basic search parameters from the request and user settings.
46 * Typically you'll pass $wgRequest and $wgUser.
48 * @param WebRequest $request
52 function SpecialSearch( &$request, &$user ) {
53 list( $this->limit
, $this->offset
) = $request->getLimitOffset( 20, 'searchlimit' );
55 if( $request->getCheck( 'searchx' ) ) {
56 $this->namespaces
= $this->powerSearch( $request );
58 $this->namespaces
= $this->userNamespaces( $user );
61 $this->searchRedirects
= false;
65 * If an exact title match can be found, jump straight ahead to
69 function goResult( $term ) {
73 $this->setupPage( $term );
75 # Try to go to page as entered.
77 $t = Title
::newFromText( $term );
79 # If the string cannot be used to create a title
81 return $this->showResults( $term );
84 # If there's an exact or very near match, jump right there.
85 $t = SearchEngine
::getNearMatch( $term );
86 if( !is_null( $t ) ) {
87 $wgOut->redirect( $t->getFullURL() );
91 # No match, generate an edit URL
92 $t = Title
::newFromText( $term );
94 $editurl = ''; # hrm...
96 # If the feature is enabled, go straight to the edit page
98 $wgOut->redirect( $t->getFullURL( 'action=edit' ) );
101 $editurl = $t->escapeLocalURL( 'action=edit' );
104 # FIXME: HTML in wiki message
105 $wgOut->addHTML( '<p>' . wfMsg('nogomatch', $editurl, htmlspecialchars( $term ) ) . "</p>\n" );
107 return $this->showResults( $term );
111 * @param string $term
114 function showResults( $term ) {
115 $fname = 'SpecialSearch::showResults';
116 wfProfileIn( $fname );
118 $this->setupPage( $term );
120 global $wgUser, $wgOut;
121 $sk = $wgUser->getSkin();
122 $wgOut->addWikiText( wfMsg( 'searchresulttext' ) );
124 #if ( !$this->parseQuery() ) {
125 if( '' === trim( $term ) ) {
127 '==' . wfMsg( 'badquery' ) . "==\n" .
128 wfMsg( 'badquerytext' ) );
129 wfProfileOut( $fname );
133 global $wgDisableTextSearch;
134 if ( $wgDisableTextSearch ) {
135 global $wgInputEncoding;
136 $wgOut->addHTML( wfMsg( 'searchdisabled' ) );
137 $wgOut->addHTML( wfMsg( 'googlesearch',
138 htmlspecialchars( $term ),
139 htmlspecialchars( $wgInputEncoding ) ) );
140 wfProfileOut( $fname );
144 $search =& SearchEngine
::create();
145 $search->setLimitOffset( $this->limit
, $this->offset
);
146 $search->setNamespaces( $this->namespaces
);
147 $titleMatches = $search->searchTitle( $term );
148 $textMatches = $search->searchText( $term );
150 $num = $titleMatches->numRows() +
$textMatches->numRows();
151 if ( $num >= $this->limit
) {
152 $top = wfShowingResults( $this->offset
, $this->limit
);
154 $top = wfShowingResultsNum( $this->offset
, $this->limit
, $num );
156 $wgOut->addHTML( "<p>{$top}</p>\n" );
158 if( $num ||
$this->offset
) {
159 $prevnext = wfViewPrevNext( $this->offset
, $this->limit
,
162 $this->powerSearchOptions(),
163 array( 'search' => $term ) ) );
164 $wgOut->addHTML( "<br />{$prevnext}\n" );
168 $tm = $wgContLang->convertForSearchResult( $search->termMatches() );
169 $terms = implode( '|', $tm );
171 if( $titleMatches->numRows() ) {
172 $wgOut->addWikiText( '==' . wfMsg( 'titlematches' ) . "==\n" );
173 $wgOut->addHTML( $this->showMatches( $titleMatches, $terms ) );
175 $wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
178 if( $textMatches->numRows() ) {
179 $wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
180 $wgOut->addHTML( $this->showMatches( $textMatches, $terms ) );
181 } elseif( $num == 0 ) {
182 # Don't show the 'no text matches' if we received title matches
183 $wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
187 $wgOut->addWikiText( wfMsg( 'nonefound' ) );
189 if( $num ||
$this->offset
) {
190 $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
192 $wgOut->addHTML( $this->powerSearchBox( $term ) );
193 wfProfileOut( $fname );
196 #------------------------------------------------------------------
197 # Private methods below this line
202 function setupPage( $term ) {
204 $wgOut->setPageTitle( wfMsg( 'searchresults' ) );
205 $wgOut->setSubtitle( wfMsg( 'searchquery', htmlspecialchars( $term ) ) );
206 $wgOut->setArticleRelated( false );
207 $wgOut->setRobotpolicy( 'noindex,nofollow' );
211 * Extract default namespaces to search from the given user's
212 * settings, returning a list of index numbers.
218 function userNamespaces( &$user ) {
220 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
221 if( $user->getOption( 'searchNs' . $ns ) ) {
229 * Extract "power search" namespace settings from the request object,
230 * returning a list of index numbers to search.
232 * @param WebRequest $request
236 function powerSearch( &$request ) {
238 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
239 if( $request->getCheck( 'ns' . $ns ) ) {
247 * Reconstruct the 'power search' options for links
251 function powerSearchOptions() {
253 foreach( $this->namespaces
as $n ) {
256 $opt['redirs'] = $this->searchRedirects ?
1 : 0;
262 * @param ResultWrapper $matches
263 * @param string $terms partial regexp for highlighting terms
265 function showMatches( &$matches, $terms ) {
266 $fname = 'SpecialSearch::showMatches';
267 wfProfileIn( $fname );
270 $off = $this->offset +
1;
271 $out = "<ol start='{$off}'>\n";
273 while( $row = $matches->fetchObject() ) {
274 $out .= $this->showHit( $row, $terms );
278 // convert the whole thing to desired language variant
280 $out = $wgContLang->convert( $out );
281 wfProfileOut( $fname );
286 * Format a single hit result
288 * @param string $terms partial regexp for highlighting terms
290 function showHit( $row, $terms ) {
291 $fname = 'SpecialSearch::showHit';
292 wfProfileIn( $fname );
293 global $wgUser, $wgContLang;
295 $t = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
296 if( is_null( $t ) ) {
297 wfProfileOut( $fname );
298 return "<!-- Broken link in search result -->\n";
300 $sk =& $wgUser->getSkin();
302 $contextlines = $wgUser->getOption( 'contextlines' );
303 if ( '' == $contextlines ) { $contextlines = 5; }
304 $contextchars = $wgUser->getOption( 'contextchars' );
305 if ( '' == $contextchars ) { $contextchars = 50; }
307 $link = $sk->makeKnownLinkObj( $t, '' );
308 $text = Article
::getRevisionText( $row );
309 $size = wfMsg( 'nbytes', strlen( $text ) );
311 $lines = explode( "\n", $text );
313 $max = IntVal( $contextchars ) +
1;
314 $pat1 = "/(.*)($terms)(.{0,$max})/i";
319 wfProfileIn( "$fname-extract" );
320 foreach ( $lines as $line ) {
321 if ( 0 == $contextlines ) {
325 if ( ! preg_match( $pat1, $line, $m ) ) {
329 $pre = $wgContLang->truncate( $m[1], -$contextchars, '...' );
331 if ( count( $m ) < 3 ) {
334 $post = $wgContLang->truncate( $m[3], $contextchars, '...' );
339 $line = htmlspecialchars( $pre . $found . $post );
340 $pat2 = '/(' . $terms . ")/i";
341 $line = preg_replace( $pat2,
342 "<span class='searchmatch'>\\1</span>", $line );
344 $extract .= "<br /><small>{$lineno}: {$line}</small>\n";
346 wfProfileOut( "$fname-extract" );
347 wfProfileOut( $fname );
348 return "<li>{$link} ({$size}){$extract}</li>\n";
351 function powerSearchBox( $term ) {
353 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
354 $checked = in_array( $ns, $this->namespaces
)
355 ?
' checked="checked"'
357 $name = str_replace( '_', ' ', $name );
359 $name = wfMsg( 'blanknamespace' );
361 $namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
362 "ns{$ns}\"{$checked} />{$name}</label>\n";
365 $checked = $this->searchRedirects
366 ?
' checked="checked"'
368 $redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
370 $searchField = "<input type='text' name=\"search\" value=\"" .
371 htmlspecialchars( $term ) ."\" width=\"80\" />\n";
373 $searchButton = '<input type="submit" name="searchx" value="' .
374 htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
376 $ret = wfMsg( 'powersearchtext',
377 $namespaces, $redirect, $searchField,
378 '', '', '', '', '', # Dummy placeholders
381 $title = Title
::makeTitle( NS_SPECIAL
, 'Search' );
382 $action = $title->escapeLocalURL();
383 return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
384 "action=\"$action\">\n{$ret}\n</form>\n";