3 * Contain a class for special pages
14 var $searchTerms = array();
15 var $namespaces = array( 0 );
16 var $showRedirects = false;
19 * Perform a full text search query and return a result set.
20 * If title searches are not supported or disabled, return null.
22 * @param string $term - Raw search term
23 * @return SearchResultSet
27 function searchText( $term ) {
32 * Perform a title-only search query and return a result set.
33 * If title searches are not supported or disabled, return null.
35 * @param string $term - Raw search term
36 * @return SearchResultSet
40 function searchTitle( $term ) {
45 * If an exact title match can be find, or a very slightly close match,
46 * return the title. If no match, returns NULL.
53 function getNearMatch( $term ) {
54 # Exact match? No need to look further.
55 $title = Title
::newFromText( $term );
59 if ( $title->getNamespace() == NS_SPECIAL ||
$title->exists() ) {
63 # Now try all lower case (i.e. first letter capitalized)
65 $title = Title
::newFromText( strtolower( $term ) );
66 if ( $title->exists() ) {
70 # Now try capitalized string
72 $title = Title
::newFromText( ucwords( strtolower( $term ) ) );
73 if ( $title->exists() ) {
77 # Now try all upper case
79 $title = Title
::newFromText( strtoupper( $term ) );
80 if ( $title->exists() ) {
84 global $wgCapitalLinks, $wgContLang;
85 if( !$wgCapitalLinks ) {
86 // Catch differs-by-first-letter-case-only
87 $title = Title
::newFromText( $wgContLang->ucfirst( $term ) );
88 if ( $title->exists() ) {
91 $title = Title
::newFromText( $wgContLang->lcfirst( $term ) );
92 if ( $title->exists() ) {
97 $title = Title
::newFromText( $term );
99 # Entering an IP address goes to the contributions page
100 if ( ( $title->getNamespace() == NS_USER
&& User
::isIP($title->getText() ) )
101 || User
::isIP( trim( $term ) ) ) {
102 return Title
::makeTitle( NS_SPECIAL
, "Contributions/" . $title->getDbkey() );
106 # Entering a user goes to the user page whether it's there or not
107 if ( $title->getNamespace() == NS_USER
) {
111 # Quoted term? Try without the quotes...
112 if( preg_match( '/^"([^"]+)"$/', $term, $matches ) ) {
113 return SearchEngine
::getNearMatch( $matches[1] );
119 function legalSearchChars() {
120 return "A-Za-z_'0-9\\x80-\\xFF\\-";
124 * Set the maximum number of results to return
125 * and how many to skip before returning the first.
131 function setLimitOffset( $limit, $offset = 0 ) {
132 $this->limit
= intval( $limit );
133 $this->offset
= intval( $offset );
137 * Set which namespaces the search should include.
138 * Give an array of namespace index numbers.
140 * @param array $namespaces
143 function setNamespaces( $namespaces ) {
144 $this->namespaces
= $namespaces;
148 * Make a list of searchable namespaces and their canonical names.
152 function searchableNamespaces() {
155 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
156 if( $ns >= NS_MAIN
) {
164 * Return a 'cleaned up' search string
169 function filter( $text ) {
170 $lc = $this->legalSearchChars();
171 return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
174 * Load up the appropriate search engine class for the currently
175 * active database backend, and return a configured instance.
177 * @return SearchEngine
181 global $wgDBtype, $wgDBmysql4, $wgSearchType;
182 if( $wgSearchType ) {
183 $class = $wgSearchType;
184 } elseif( $wgDBtype == 'mysql' ) {
186 $class = 'SearchMySQL4';
187 require_once( 'SearchMySQL4.php' );
189 $class = 'SearchMysql3';
190 require_once( 'SearchMySQL3.php' );
192 } else if ( $wgDBtype == 'PostgreSQL' ) {
193 $class = 'SearchTsearch2';
194 require_once( 'SearchTsearch2.php' );
196 $class = 'SearchEngineDummy';
198 $search = new $class( wfGetDB( DB_SLAVE
) );
199 $search->setLimitOffset(0,0);
204 * Create or update the search index record for the given page.
205 * Title and text should be pre-processed.
208 * @param string $title
209 * @param string $text
212 function update( $id, $title, $text ) {
217 * Update a search index record's title only.
218 * Title should be pre-processed.
221 * @param string $title
224 function updateTitle( $id, $title ) {
229 /** @package MediaWiki */
230 class SearchResultSet
{
232 * Fetch an array of regular expression fragments for matching
233 * the search terms as parsed by this engine in a text extract.
239 function termMatches() {
248 * Return true if results are included in this result set.
252 function hasResults() {
257 * Some search modes return a total hit count for the query
258 * in the entire article database. This may include pages
259 * in namespaces that would not be matched on the given
262 * Return null if no total hits number is supported.
267 function getTotalHits() {
272 * Some search modes return a suggested alternate term if there are
273 * no exact hits. Returns true if there is one on this set.
278 function hasSuggestion() {
283 * Some search modes return a suggested alternate term if there are
284 * no exact hits. Check hasSuggestion() first.
289 function getSuggestion() {
294 * Fetches next search result, or false.
295 * @return SearchResult
304 /** @package MediaWiki */
306 function SearchResult( $row ) {
307 $this->mTitle
= Title
::makeTitle( $row->page_namespace
, $row->page_title
);
314 function getTitle() {
315 return $this->mTitle
;
319 * @return double or null if not supported
321 function getScore() {
329 class SearchEngineDummy
{
330 function search( $term ) {
333 function setLimitOffset($l, $o) {}
334 function legalSearchChars() {}
336 function setnamespaces() {}
337 function searchtitle() {}
338 function searchtext() {}