<?php
-
+/**
+ * Contain a class for special pages
+ * @addtogroup Search
+ */
class SearchEngine {
var $limit = 10;
var $offset = 0;
var $searchTerms = array();
- var $namespaces = array( 0 );
+ var $namespaces = array( NS_MAIN );
var $showRedirects = false;
-
+
/**
* Perform a full text search query and return a result set.
+ * If title searches are not supported or disabled, return null.
*
* @param string $term - Raw search term
- * @param array $namespaces - List of namespaces to search
- * @return ResultWrapper
+ * @return SearchResultSet
* @access public
+ * @abstract
*/
function searchText( $term ) {
- return $this->db->resultObject( $this->db->query( $this->getQuery( $this->filter( $term ), true ) ) );
+ return null;
}
/**
* Perform a title-only search query and return a result set.
+ * If title searches are not supported or disabled, return null.
*
* @param string $term - Raw search term
- * @param array $namespaces - List of namespaces to search
- * @return ResultWrapper
+ * @return SearchResultSet
* @access public
+ * @abstract
*/
function searchTitle( $term ) {
- return $this->db->resultObject( $this->db->query( $this->getQuery( $this->filter( $term ), false ) ) );
+ return null;
}
-
+
/**
* If an exact title match can be find, or a very slightly close match,
* return the title. If no match, returns NULL.
*
* @param string $term
* @return Title
- * @access private
*/
- function getNearMatch( $term ) {
- # Exact match? No need to look further.
- $title = Title::newFromText( $term );
- if ( $title->getNamespace() == NS_SPECIAL || 0 != $title->getArticleID() ) {
- return $title;
+ public static function getNearMatch( $searchterm ) {
+ global $wgContLang;
+
+ $allSearchTerms = array($searchterm);
+
+ if($wgContLang->hasVariants()){
+ $allSearchTerms = array_merge($allSearchTerms,$wgContLang->convertLinkToAllVariants($searchterm));
}
+
+ foreach($allSearchTerms as $term){
- # Now try all lower case (i.e. first letter capitalized)
- #
- $title = Title::newFromText( strtolower( $term ) );
- if ( 0 != $title->getArticleID() ) {
- return $title;
+ # Exact match? No need to look further.
+ $title = Title::newFromText( $term );
+ if (is_null($title))
+ return NULL;
+
+ if ( $title->getNamespace() == NS_SPECIAL || $title->exists() ) {
+ return $title;
+ }
+
+ # Now try all lower case (i.e. first letter capitalized)
+ #
+ $title = Title::newFromText( $wgContLang->lc( $term ) );
+ if ( $title->exists() ) {
+ return $title;
+ }
+
+ # Now try capitalized string
+ #
+ $title = Title::newFromText( $wgContLang->ucwords( $term ) );
+ if ( $title->exists() ) {
+ return $title;
+ }
+
+ # Now try all upper case
+ #
+ $title = Title::newFromText( $wgContLang->uc( $term ) );
+ if ( $title->exists() ) {
+ return $title;
+ }
+
+ # Now try Word-Caps-Breaking-At-Word-Breaks, for hyphenated names etc
+ $title = Title::newFromText( $wgContLang->ucwordbreaks($term) );
+ if ( $title->exists() ) {
+ return $title;
+ }
+
+ global $wgCapitalLinks, $wgContLang;
+ if( !$wgCapitalLinks ) {
+ // Catch differs-by-first-letter-case-only
+ $title = Title::newFromText( $wgContLang->ucfirst( $term ) );
+ if ( $title->exists() ) {
+ return $title;
+ }
+ $title = Title::newFromText( $wgContLang->lcfirst( $term ) );
+ if ( $title->exists() ) {
+ return $title;
+ }
+ }
+
+ // Give hooks a chance at better match variants
+ $title = null;
+ if( !wfRunHooks( 'SearchGetNearMatch', array( $term, &$title ) ) ) {
+ return $title;
+ }
}
- # Now try capitalized string
- #
- $title = Title::newFromText( ucwords( strtolower( $term ) ) );
- if ( 0 != $title->getArticleID() ) {
- return $title;
+ $title = Title::newFromText( $searchterm );
+
+ # Entering an IP address goes to the contributions page
+ if ( ( $title->getNamespace() == NS_USER && User::isIP($title->getText() ) )
+ || User::isIP( trim( $searchterm ) ) ) {
+ return SpecialPage::getTitleFor( 'Contributions', $title->getDBkey() );
}
- # Now try all upper case
- #
- $title = Title::newFromText( strtoupper( $term ) );
- if ( 0 != $title->getArticleID() ) {
+
+ # Entering a user goes to the user page whether it's there or not
+ if ( $title->getNamespace() == NS_USER ) {
return $title;
}
+
+ # Go to images that exist even if there's no local page.
+ # There may have been a funny upload, or it may be on a shared
+ # file repository such as Wikimedia Commons.
+ if( $title->getNamespace() == NS_IMAGE ) {
+ $image = wfFindFile( $title );
+ if( $image ) {
+ return $title;
+ }
+ }
- # Entering an IP address goes to the contributions page
- if ( preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $term ) ) {
- $title = Title::makeTitle( NS_SPECIAL, "Contributions/" . $term );
- return $title;
+ # MediaWiki namespace? Page may be "implied" if not customized.
+ # Just return it, with caps forced as the message system likes it.
+ if( $title->getNamespace() == NS_MEDIAWIKI ) {
+ return Title::makeTitle( NS_MEDIAWIKI, $wgContLang->ucfirst( $title->getText() ) );
+ }
+
+ # Quoted term? Try without the quotes...
+ $matches = array();
+ if( preg_match( '/^"([^"]+)"$/', $searchterm, $matches ) ) {
+ return SearchEngine::getNearMatch( $matches[1] );
}
return NULL;
}
-
- function legalSearchChars() {
+
+ public static function legalSearchChars() {
return "A-Za-z_'0-9\\x80-\\xFF\\-";
}
* @access public
*/
function setLimitOffset( $limit, $offset = 0 ) {
- $this->limit = IntVal( $limit );
- $this->offset = IntVal( $offset );
+ $this->limit = intval( $limit );
+ $this->offset = intval( $offset );
}
-
+
/**
* Set which namespaces the search should include.
* Give an array of namespace index numbers.
function setNamespaces( $namespaces ) {
$this->namespaces = $namespaces;
}
-
+
/**
* Make a list of searchable namespaces and their canonical names.
* @return array
- * @access public
*/
- function searchableNamespaces() {
+ public static function searchableNamespaces() {
global $wgContLang;
$arr = array();
foreach( $wgContLang->getNamespaces() as $ns => $name ) {
- if( $ns >= 0 ) {
+ if( $ns >= NS_MAIN ) {
$arr[$ns] = $name;
}
}
return $arr;
}
-
+
+ /**
+ * Return a 'cleaned up' search string
+ *
+ * @return string
+ * @access public
+ */
+ function filter( $text ) {
+ $lc = $this->legalSearchChars();
+ return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
+ }
+ /**
+ * Load up the appropriate search engine class for the currently
+ * active database backend, and return a configured instance.
+ *
+ * @return SearchEngine
+ */
+ public static function create() {
+ global $wgDBtype, $wgSearchType;
+ if( $wgSearchType ) {
+ $class = $wgSearchType;
+ } elseif( $wgDBtype == 'mysql' ) {
+ $class = 'SearchMySQL4';
+ } else if ( $wgDBtype == 'postgres' ) {
+ $class = 'SearchPostgres';
+ } else if ( $wgDBtype == 'oracle' ) {
+ $class = 'SearchOracle';
+ } else {
+ $class = 'SearchEngineDummy';
+ }
+ $search = new $class( wfGetDB( DB_SLAVE ) );
+ $search->setLimitOffset(0,0);
+ return $search;
+ }
+
+ /**
+ * Create or update the search index record for the given page.
+ * Title and text should be pre-processed.
+ *
+ * @param int $id
+ * @param string $title
+ * @param string $text
+ * @abstract
+ */
+ function update( $id, $title, $text ) {
+ // no-op
+ }
+
+ /**
+ * Update a search index record's title only.
+ * Title should be pre-processed.
+ *
+ * @param int $id
+ * @param string $title
+ * @abstract
+ */
+ function updateTitle( $id, $title ) {
+ // no-op
+ }
+}
+
+
+/**
+ * @addtogroup Search
+ */
+class SearchResultSet {
/**
* Fetch an array of regular expression fragments for matching
* the search terms as parsed by this engine in a text extract.
*
* @return array
* @access public
+ * @abstract
*/
function termMatches() {
- return $this->searchTerms;
+ return array();
}
-
+
+ function numRows() {
+ return 0;
+ }
+
/**
- * Return a 'cleaned up' search string
+ * Return true if results are included in this result set.
+ * @return bool
+ * @abstract
+ */
+ function hasResults() {
+ return false;
+ }
+
+ /**
+ * Some search modes return a total hit count for the query
+ * in the entire article database. This may include pages
+ * in namespaces that would not be matched on the given
+ * settings.
*
- * @return string
+ * Return null if no total hits number is supported.
+ *
+ * @return int
* @access public
*/
- function filter( $text ) {
- $lc = $this->legalSearchChars();
- return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
+ function getTotalHits() {
+ return null;
}
-
+
/**
- * Return a partial WHERE clause to exclude redirects, if so set
- * @return string
- * @access private
+ * Some search modes return a suggested alternate term if there are
+ * no exact hits. Returns true if there is one on this set.
+ *
+ * @return bool
+ * @access public
*/
- function queryRedirect() {
- if( $this->showRedirects ) {
- return 'AND cur_is_redirect=0';
- } else {
- return '';
- }
+ function hasSuggestion() {
+ return false;
}
-
+
/**
- * Return a partial WHERE clause to limit the search to the given namespaces
+ * Some search modes return a suggested alternate term if there are
+ * no exact hits. Check hasSuggestion() first.
+ *
* @return string
- * @access private
+ * @access public
*/
- function queryNamespaces() {
- $namespaces = implode( ',', $this->namespaces );
- if ($namespaces == '') {
- $namespaces = '0';
- }
- return 'AND cur_namespace IN (' . $namespaces . ')';
+ function getSuggestion() {
+ return '';
}
-
+
/**
- * Return a LIMIT clause to limit results on the query.
- * @return string
- * @access private
+ * Fetches next search result, or false.
+ * @return SearchResult
+ * @access public
+ * @abstract
*/
- function queryLimit() {
- return $this->db->limitResult( $this->limit, $this->offset );
+ function next() {
+ return false;
}
/**
- * Construct the full SQL query to do the search.
- * The guts shoulds be constructed in queryMain()
- * @param string $filteredTerm
- * @param bool $fulltext
- * @access private
+ * Frees the result set, if applicable.
+ * @ access public
*/
- function getQuery( $filteredTerm, $fulltext ) {
- return $this->queryMain( $filteredTerm, $fulltext ) . ' ' .
- $this->queryRedirect() . ' ' .
- $this->queryNamespaces() . ' ' .
- $this->queryLimit();
+ function free() {
+ // ...
+ }
+}
+
+
+/**
+ * @addtogroup Search
+ */
+class SearchResultTooMany {
+ ## Some search engines may bail out if too many matches are found
+}
+
+
+/**
+ * @addtogroup Search
+ */
+class SearchResult {
+
+ function SearchResult( $row ) {
+ $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title );
+ }
+
+ /**
+ * @return Title
+ * @access public
+ */
+ function getTitle() {
+ return $this->mTitle;
+ }
+
+ /**
+ * @return double or null if not supported
+ */
+ function getScore() {
+ return null;
}
-
}
+/**
+ * @addtogroup Search
+ */
class SearchEngineDummy {
function search( $term ) {
return null;
}
+ function setLimitOffset($l, $o) {}
+ function legalSearchChars() {}
+ function update() {}
+ function setnamespaces() {}
+ function searchtitle() {}
+ function searchtext() {}
}
-
-?>
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff