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 =& $this->getSearchEngine();
145 $titleMatches = $search->searchTitle( $term );
146 $textMatches = $search->searchText( $term );
148 $num = $titleMatches->numRows() +
$textMatches->numRows();
149 if ( $num >= $this->limit
) {
150 $top = wfShowingResults( $this->offset
, $this->limit
);
152 $top = wfShowingResultsNum( $this->offset
, $this->limit
, $num );
154 $wgOut->addHTML( "<p>{$top}</p>\n" );
156 if( $num ||
$this->offset
) {
157 $prevnext = wfViewPrevNext( $this->offset
, $this->limit
,
160 $this->powerSearchOptions(),
161 array( 'search' => $term ) ) );
162 $wgOut->addHTML( "<br />{$prevnext}\n" );
166 $tm = $wgContLang->convertForSearchResult( $search->termMatches() );
167 $terms = implode( '|', $tm );
169 if( $titleMatches->numRows() ) {
170 $wgOut->addWikiText( '==' . wfMsg( 'titlematches' ) . "==\n" );
171 $wgOut->addHTML( $this->showMatches( $titleMatches, $terms ) );
173 $wgOut->addWikiText( '==' . wfMsg( 'notitlematches' ) . "==\n" );
176 if( $textMatches->numRows() ) {
177 $wgOut->addWikiText( '==' . wfMsg( 'textmatches' ) . "==\n" );
178 $wgOut->addHTML( $this->showMatches( $textMatches, $terms ) );
179 } elseif( $num == 0 ) {
180 # Don't show the 'no text matches' if we received title matches
181 $wgOut->addWikiText( '==' . wfMsg( 'notextmatches' ) . "==\n" );
185 $wgOut->addWikiText( wfMsg( 'nonefound' ) );
187 if( $num ||
$this->offset
) {
188 $wgOut->addHTML( "<p>{$prevnext}</p>\n" );
190 $wgOut->addHTML( $this->powerSearchBox( $term ) );
191 wfProfileOut( $fname );
194 #------------------------------------------------------------------
195 # Private methods below this line
200 function setupPage( $term ) {
202 $wgOut->setPageTitle( wfMsg( 'searchresults' ) );
203 $wgOut->setSubtitle( wfMsg( 'searchquery', htmlspecialchars( $term ) ) );
204 $wgOut->setArticleRelated( false );
205 $wgOut->setRobotpolicy( 'noindex,nofollow' );
209 * Load up the appropriate search engine class for the currently
210 * active database backend, and return a configured instance.
212 * @return SearchEngine
215 function &getSearchEngine() {
216 global $wgDBtype, $wgDBmysql4, $wgSearchType;
217 if( $wgDBtype == 'mysql' ) {
219 $class = 'SearchMySQL4';
220 require_once( 'SearchMySQL4.php' );
222 $class = 'SearchMysql3';
223 require_once( 'SearchMySQL3.php' );
225 } else if ( $wgDBtype == 'PostgreSQL' ) {
226 $class = 'SearchTsearch2';
227 require_once( 'SearchTsearch2.php' );
229 $class = 'SearchEngineDummy';
231 $search = new $class( wfGetDB( DB_SLAVE
) );
232 $search->setLimitOffset( $this->limit
, $this->offset
);
233 $search->setNamespaces( $this->namespaces
);
238 * Extract default namespaces to search from the given user's
239 * settings, returning a list of index numbers.
245 function userNamespaces( &$user ) {
247 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
248 if( $user->getOption( 'searchNs' . $ns ) ) {
256 * Extract "power search" namespace settings from the request object,
257 * returning a list of index numbers to search.
259 * @param WebRequest $request
263 function powerSearch( &$request ) {
265 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
266 if( $request->getCheck( 'ns' . $ns ) ) {
274 * Reconstruct the 'power search' options for links
278 function powerSearchOptions() {
280 foreach( $this->namespaces
as $n ) {
283 $opt['redirs'] = $this->searchRedirects ?
1 : 0;
289 * @param ResultWrapper $matches
290 * @param string $terms partial regexp for highlighting terms
292 function showMatches( &$matches, $terms ) {
293 $fname = 'SpecialSearch::showMatches';
294 wfProfileIn( $fname );
297 $off = $this->offset +
1;
298 $out = "<ol start='{$off}'>\n";
300 while( $row = $matches->fetchObject() ) {
301 $out .= $this->showHit( $row, $terms );
305 // convert the whole thing to desired language variant
307 $out = $wgContLang->convert( $out );
308 wfProfileOut( $fname );
313 * Format a single hit result
315 * @param string $terms partial regexp for highlighting terms
317 function showHit( $row, $terms ) {
318 $fname = 'SpecialSearch::showHit';
319 wfProfileIn( $fname );
320 global $wgUser, $wgContLang;
322 $t = Title
::makeTitle( $row->cur_namespace
, $row->cur_title
);
323 if( is_null( $t ) ) {
324 wfProfileOut( $fname );
325 return "<!-- Broken link in search result -->\n";
327 $sk =& $wgUser->getSkin();
329 $contextlines = $wgUser->getOption( 'contextlines' );
330 if ( '' == $contextlines ) { $contextlines = 5; }
331 $contextchars = $wgUser->getOption( 'contextchars' );
332 if ( '' == $contextchars ) { $contextchars = 50; }
334 $link = $sk->makeKnownLinkObj( $t, '' );
335 $size = wfMsg( 'nbytes', strlen( $row->cur_text
) );
337 $lines = explode( "\n", $row->cur_text
);
339 $max = IntVal( $contextchars ) +
1;
340 $pat1 = "/(.*)($terms)(.{0,$max})/i";
345 wfProfileIn( "$fname-extract" );
346 foreach ( $lines as $line ) {
347 if ( 0 == $contextlines ) {
351 if ( ! preg_match( $pat1, $line, $m ) ) {
355 $pre = $wgContLang->truncate( $m[1], -$contextchars, '...' );
357 if ( count( $m ) < 3 ) {
360 $post = $wgContLang->truncate( $m[3], $contextchars, '...' );
365 $line = htmlspecialchars( $pre . $found . $post );
366 $pat2 = '/(' . $terms . ")/i";
367 $line = preg_replace( $pat2,
368 "<span class='searchmatch'>\\1</span>", $line );
370 $extract .= "<br /><small>{$lineno}: {$line}</small>\n";
372 wfProfileOut( "$fname-extract" );
373 wfProfileOut( $fname );
374 return "<li>{$link} ({$size}){$extract}</li>\n";
377 function powerSearchBox( $term ) {
379 foreach( SearchEngine
::searchableNamespaces() as $ns => $name ) {
380 $checked = in_array( $ns, $this->namespaces
)
381 ?
' checked="checked"'
383 $name = str_replace( '_', ' ', $name );
385 $name = wfMsg( 'blanknamespace' );
387 $namespaces .= " <label><input type='checkbox' value=\"1\" name=\"" .
388 "ns{$ns}\"{$checked} />{$name}</label>\n";
391 $checked = $this->searchRedirects
392 ?
' checked="checked"'
394 $redirect = "<input type='checkbox' value='1' name=\"redirs\"{$checked} />\n";
396 $searchField = "<input type='text' name=\"search\" value=\"" .
397 htmlspecialchars( $term ) ."\" width=\"80\" />\n";
399 $searchButton = '<input type="submit" name="searchx" value="' .
400 htmlspecialchars( wfMsg('powersearch') ) . "\" />\n";
402 $ret = wfMsg( 'powersearchtext',
403 $namespaces, $redirect, $searchField,
404 '', '', '', '', '', # Dummy placeholders
407 $title = Title
::makeTitle( NS_SPECIAL
, 'Search' );
408 $action = $title->escapeLocalURL();
409 return "<br /><br />\n<form id=\"powersearch\" method=\"get\" " .
410 "action=\"$action\">\n{$ret}\n</form>\n";