3 * Contain a class for special pages
9 var $searchTerms = array();
10 var $namespaces = array( NS_MAIN
);
11 var $showRedirects = false;
14 * Perform a full text search query and return a result set.
15 * If title searches are not supported or disabled, return null.
17 * @param string $term - Raw search term
18 * @return SearchResultSet
22 function searchText( $term ) {
27 * Perform a title-only search query and return a result set.
28 * If title searches are not supported or disabled, return null.
30 * @param string $term - Raw search term
31 * @return SearchResultSet
35 function searchTitle( $term ) {
40 * If an exact title match can be find, or a very slightly close match,
41 * return the title. If no match, returns NULL.
46 public static function getNearMatch( $searchterm ) {
49 $allSearchTerms = array($searchterm);
51 if($wgContLang->hasVariants()){
52 $allSearchTerms = array_merge($allSearchTerms,$wgContLang->convertLinkToAllVariants($searchterm));
55 foreach($allSearchTerms as $term){
57 # Exact match? No need to look further.
58 $title = Title
::newFromText( $term );
62 if ( $title->getNamespace() == NS_SPECIAL ||
$title->exists() ) {
66 # Now try all lower case (i.e. first letter capitalized)
68 $title = Title
::newFromText( $wgContLang->lc( $term ) );
69 if ( $title->exists() ) {
73 # Now try capitalized string
75 $title = Title
::newFromText( $wgContLang->ucwords( $term ) );
76 if ( $title->exists() ) {
80 # Now try all upper case
82 $title = Title
::newFromText( $wgContLang->uc( $term ) );
83 if ( $title->exists() ) {
87 # Now try Word-Caps-Breaking-At-Word-Breaks, for hyphenated names etc
88 $title = Title
::newFromText( $wgContLang->ucwordbreaks($term) );
89 if ( $title->exists() ) {
93 global $wgCapitalLinks, $wgContLang;
94 if( !$wgCapitalLinks ) {
95 // Catch differs-by-first-letter-case-only
96 $title = Title
::newFromText( $wgContLang->ucfirst( $term ) );
97 if ( $title->exists() ) {
100 $title = Title
::newFromText( $wgContLang->lcfirst( $term ) );
101 if ( $title->exists() ) {
106 // Give hooks a chance at better match variants
108 if( !wfRunHooks( 'SearchGetNearMatch', array( $term, &$title ) ) ) {
113 $title = Title
::newFromText( $searchterm );
115 # Entering an IP address goes to the contributions page
116 if ( ( $title->getNamespace() == NS_USER
&& User
::isIP($title->getText() ) )
117 || User
::isIP( trim( $searchterm ) ) ) {
118 return SpecialPage
::getTitleFor( 'Contributions', $title->getDBkey() );
122 # Entering a user goes to the user page whether it's there or not
123 if ( $title->getNamespace() == NS_USER
) {
127 # Go to images that exist even if there's no local page.
128 # There may have been a funny upload, or it may be on a shared
129 # file repository such as Wikimedia Commons.
130 if( $title->getNamespace() == NS_IMAGE
) {
131 $image = wfFindFile( $title );
137 # MediaWiki namespace? Page may be "implied" if not customized.
138 # Just return it, with caps forced as the message system likes it.
139 if( $title->getNamespace() == NS_MEDIAWIKI
) {
140 return Title
::makeTitle( NS_MEDIAWIKI
, $wgContLang->ucfirst( $title->getText() ) );
143 # Quoted term? Try without the quotes...
145 if( preg_match( '/^"([^"]+)"$/', $searchterm, $matches ) ) {
146 return SearchEngine
::getNearMatch( $matches[1] );
152 public static function legalSearchChars() {
153 return "A-Za-z_'0-9\\x80-\\xFF\\-";
157 * Set the maximum number of results to return
158 * and how many to skip before returning the first.
164 function setLimitOffset( $limit, $offset = 0 ) {
165 $this->limit
= intval( $limit );
166 $this->offset
= intval( $offset );
170 * Set which namespaces the search should include.
171 * Give an array of namespace index numbers.
173 * @param array $namespaces
176 function setNamespaces( $namespaces ) {
177 $this->namespaces
= $namespaces;
181 * Make a list of searchable namespaces and their canonical names.
184 public static function searchableNamespaces() {
187 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
188 if( $ns >= NS_MAIN
) {
196 * Return a 'cleaned up' search string
201 function filter( $text ) {
202 $lc = $this->legalSearchChars();
203 return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
206 * Load up the appropriate search engine class for the currently
207 * active database backend, and return a configured instance.
209 * @return SearchEngine
211 public static function create() {
212 global $wgDBtype, $wgSearchType;
213 if( $wgSearchType ) {
214 $class = $wgSearchType;
215 } elseif( $wgDBtype == 'mysql' ) {
216 $class = 'SearchMySQL4';
217 } else if ( $wgDBtype == 'postgres' ) {
218 $class = 'SearchPostgres';
219 } else if ( $wgDBtype == 'oracle' ) {
220 $class = 'SearchOracle';
222 $class = 'SearchEngineDummy';
224 $search = new $class( wfGetDB( DB_SLAVE
) );
225 $search->setLimitOffset(0,0);
230 * Create or update the search index record for the given page.
231 * Title and text should be pre-processed.
234 * @param string $title
235 * @param string $text
238 function update( $id, $title, $text ) {
243 * Update a search index record's title only.
244 * Title should be pre-processed.
247 * @param string $title
250 function updateTitle( $id, $title ) {
259 class SearchResultSet
{
261 * Fetch an array of regular expression fragments for matching
262 * the search terms as parsed by this engine in a text extract.
268 function termMatches() {
277 * Return true if results are included in this result set.
281 function hasResults() {
286 * Some search modes return a total hit count for the query
287 * in the entire article database. This may include pages
288 * in namespaces that would not be matched on the given
291 * Return null if no total hits number is supported.
296 function getTotalHits() {
301 * Some search modes return a suggested alternate term if there are
302 * no exact hits. Returns true if there is one on this set.
307 function hasSuggestion() {
312 * Some search modes return a suggested alternate term if there are
313 * no exact hits. Check hasSuggestion() first.
318 function getSuggestion() {
323 * Fetches next search result, or false.
324 * @return SearchResult
333 * Frees the result set, if applicable.
345 class SearchResultTooMany
{
346 ## Some search engines may bail out if too many matches are found
355 function SearchResult( $row ) {
356 $this->mTitle
= Title
::makeTitle( $row->page_namespace
, $row->page_title
);
363 function getTitle() {
364 return $this->mTitle
;
368 * @return double or null if not supported
370 function getScore() {
378 class SearchEngineDummy
{
379 function search( $term ) {
382 function setLimitOffset($l, $o) {}
383 function legalSearchChars() {}
385 function setnamespaces() {}
386 function searchtitle() {}
387 function searchtext() {}