/**
* Perform a full text search query and return a result set.
* If title searches are not supported or disabled, return null.
+ * STUB
*
- * @param string $term - Raw search term
+ * @param $term String: raw search term
* @return SearchResultSet
- * @access public
- * @abstract
*/
function searchText( $term ) {
return null;
/**
* Perform a title-only search query and return a result set.
* If title searches are not supported or disabled, return null.
+ * STUB
*
- * @param string $term - Raw search term
+ * @param $term String: raw search term
* @return SearchResultSet
- * @access public
- * @abstract
*/
function searchTitle( $term ) {
return null;
return true;
}
+ /**
+ * When overridden in derived class, performs database-specific conversions
+ * on text to be used for searching or updating search index.
+ * Default implementation does nothing (simply returns $string).
+ *
+ * @param $string string: String to process
+ * @return string
+ */
+ public function normalizeText( $string ) {
+ return $string;
+ }
+
/**
* Transform search term in cases when parts of the query came as different GET params (when supported)
* e.g. for prefix queries: search=test&prefix=Main_Page/Archive -> test prefix:Main Page/Archive
}
/**
- * If an exact title match can be find, or a very slightly close match,
+ * If an exact title match can be found, or a very slightly close match,
* return the title. If no match, returns NULL.
*
- * @param string $term
+ * @param $searchterm String
* @return Title
*/
public static function getNearMatch( $searchterm ) {
+ $title = self::getNearMatchInternal( $searchterm );
+
+ wfRunHooks( 'SearchGetNearMatchComplete', array( $searchterm, &$title ) );
+ return $title;
+ }
+
+ /**
+ * Really find the title match.
+ */
+ private static function getNearMatchInternal( $searchterm ) {
global $wgContLang;
$allSearchTerms = array($searchterm);
- if($wgContLang->hasVariants()){
+ if ( $wgContLang->hasVariants() ) {
$allSearchTerms = array_merge($allSearchTerms,$wgContLang->convertLinkToAllVariants($searchterm));
}
- foreach($allSearchTerms as $term){
+ if( !wfRunHooks( 'SearchGetNearMatchBefore', array( $allSearchTerms, &$titleResult ) ) ) {
+ return $titleResult;
+ }
+
+ foreach($allSearchTerms as $term) {
# Exact match? No need to look further.
$title = Title::newFromText( $term );
if (is_null($title))
- return NULL;
+ return null;
if ( $title->getNamespace() == NS_SPECIAL || $title->isExternal() || $title->exists() ) {
return $title;
return SearchEngine::getNearMatch( $matches[1] );
}
- return NULL;
+ return null;
}
public static function legalSearchChars() {
* Set the maximum number of results to return
* and how many to skip before returning the first.
*
- * @param int $limit
- * @param int $offset
- * @access public
+ * @param $limit Integer
+ * @param $offset Integer
*/
function setLimitOffset( $limit, $offset = 0 ) {
$this->limit = intval( $limit );
* Set which namespaces the search should include.
* Give an array of namespace index numbers.
*
- * @param array $namespaces
- * @access public
+ * @param $namespaces Array
*/
function setNamespaces( $namespaces ) {
$this->namespaces = $namespaces;
* Parse some common prefixes: all (search everything)
* or namespace names
*
- * @param string $query
+ * @param $query String
*/
function replacePrefixes( $query ){
global $wgContLang;
- if( strpos($query,':') === false )
- return $query; // nothing to do
-
$parsed = $query;
+ if( strpos($query,':') === false ) { // nothing to do
+ wfRunHooks( 'SearchEngineReplacePrefixesComplete', array( $this, $query, &$parsed ) );
+ return $parsed;
+ }
+
$allkeyword = wfMsgForContent('searchall').":";
if( strncmp($query, $allkeyword, strlen($allkeyword)) == 0 ){
$this->namespaces = null;
}
}
if(trim($parsed) == '')
- return $query; // prefix was the whole query
+ $parsed = $query; // prefix was the whole query
+
+ wfRunHooks( 'SearchEngineReplacePrefixesComplete', array( $this, $query, &$parsed ) );
return $parsed;
}
/**
* Make a list of searchable namespaces and their canonical names.
- * @return array
+ * @return Array
*/
public static function searchableNamespaces() {
global $wgContLang;
$arr[$ns] = $name;
}
}
+
+ wfRunHooks( 'SearchableNamespaces', array( &$arr ) );
return $arr;
}
* Extract default namespaces to search from the given user's
* settings, returning a list of index numbers.
*
- * @param User $user
- * @return array
- * @static
+ * @param $user User
+ * @return Array
*/
- public static function userNamespaces( &$user ) {
- $arr = array();
- foreach( SearchEngine::searchableNamespaces() as $ns => $name ) {
- if( $user->getOption( 'searchNs' . $ns ) ) {
- $arr[] = $ns;
- }
- }
+ public static function userNamespaces( $user ) {
+ global $wgSearchEverythingOnlyLoggedIn;
+
+ // get search everything preference, that can be set to be read for logged-in users
+ $searcheverything = false;
+ if( ( $wgSearchEverythingOnlyLoggedIn && $user->isLoggedIn() )
+ || !$wgSearchEverythingOnlyLoggedIn )
+ $searcheverything = $user->getOption('searcheverything');
+
+ // searcheverything overrides other options
+ if( $searcheverything )
+ return array_keys(SearchEngine::searchableNamespaces());
+
+ $arr = Preferences::loadOldSearchNs( $user );
+ $searchableNamespaces = SearchEngine::searchableNamespaces();
+
+ $arr = array_intersect( $arr, array_keys($searchableNamespaces) ); // Filter
+
return $arr;
}
/**
* Find snippet highlight settings for a given user
*
- * @param User $user
- * @return array contextlines, contextchars
- * @static
+ * @param $user User
+ * @return Array contextlines, contextchars
*/
public static function userHighlightPrefs( &$user ){
//$contextlines = $user->getOption( 'contextlines', 5 );
/**
* An array of namespaces indexes to be searched by default
*
- * @return array
- * @static
+ * @return Array
*/
public static function defaultNamespaces(){
global $wgNamespacesToBeSearchedDefault;
* Get a list of namespace names useful for showing in tooltips
* and preferences
*
- * @param unknown_type $namespaces
+ * @param $namespaces Array
*/
public static function namespacesAsText( $namespaces ){
global $wgContLang;
}
/**
- * An array of "project" namespaces indexes typically searched
- * by logged-in users
+ * Return the help namespaces to be shown on Special:Search
*
- * @return array
- * @static
+ * @return Array
*/
- public static function projectNamespaces() {
- global $wgNamespacesToBeSearchedDefault, $wgNamespacesToBeSearchedProject;
+ public static function helpNamespaces() {
+ global $wgNamespacesToBeSearchedHelp;
- return array_keys( $wgNamespacesToBeSearchedProject, true );
- }
-
- /**
- * An array of "project" namespaces indexes typically searched
- * by logged-in users in addition to the default namespaces
- *
- * @return array
- * @static
- */
- public static function defaultAndProjectNamespaces() {
- global $wgNamespacesToBeSearchedDefault, $wgNamespacesToBeSearchedProject;
-
- return array_keys( $wgNamespacesToBeSearchedDefault +
- $wgNamespacesToBeSearchedProject, true);
+ return array_keys( $wgNamespacesToBeSearchedHelp, true );
}
/**
* Return a 'cleaned up' search string
*
- * @return string
- * @access public
+ * @param $text String
+ * @return String
*/
function filter( $text ) {
$lc = $this->legalSearchChars();
/**
* Create or update the search index record for the given page.
* Title and text should be pre-processed.
+ * STUB
*
- * @param int $id
- * @param string $title
- * @param string $text
- * @abstract
+ * @param $id Integer
+ * @param $title String
+ * @param $text String
*/
function update( $id, $title, $text ) {
// no-op
/**
* Update a search index record's title only.
* Title should be pre-processed.
+ * STUB
*
- * @param int $id
- * @param string $title
- * @abstract
+ * @param $id Integer
+ * @param $title String
*/
function updateTitle( $id, $title ) {
// no-op
/**
* Get OpenSearch suggestion template
*
- * @return string
- * @static
+ * @return String
*/
public static function getOpenSearchTemplate() {
global $wgOpenSearchTemplate, $wgServer, $wgScriptPath;
/**
* Get internal MediaWiki Suggest template
*
- * @return string
- * @static
+ * @return String
*/
public static function getMWSuggestTemplate() {
global $wgMWSuggestTemplate, $wgServer, $wgScriptPath;
/**
* Fetch an array of regular expression fragments for matching
* the search terms as parsed by this engine in a text extract.
+ * STUB
*
- * @return array
- * @access public
- * @abstract
+ * @return Array
*/
function termMatches() {
return array();
/**
* Return true if results are included in this result set.
- * @return bool
- * @abstract
+ * STUB
+ *
+ * @return Boolean
*/
function hasResults() {
return false;
*
* Return null if no total hits number is supported.
*
- * @return int
- * @access public
+ * @return Integer
*/
function getTotalHits() {
return null;
* 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
+ * @return Boolean
*/
function hasSuggestion() {
return false;
}
/**
- * @return string suggested query, null if none
+ * @return String: suggested query, null if none
*/
function getSuggestionQuery(){
return null;
}
/**
- * @return string HTML highlighted suggested query, '' if none
+ * @return String: HTML highlighted suggested query, '' if none
*/
function getSuggestionSnippet(){
return '';
* Return information about how and from where the results were fetched,
* should be useful for diagnostics and debugging
*
- * @return string
+ * @return String
*/
function getInfo() {
return null;
/**
* Check if there are results on other wikis
*
- * @return boolean
+ * @return Boolean
*/
function hasInterwikiResults() {
return $this->getInterwikiResults() != null;
/**
* Fetches next search result, or false.
+ * STUB
+ *
* @return SearchResult
- * @access public
- * @abstract
*/
function next() {
return false;
/**
* Frees the result set, if applicable.
- * @ access public
*/
function free() {
// ...
}
}
+/**
+ * This class is used for different SQL-based search engines shipped with MediaWiki
+ */
+class SqlSearchResultSet extends SearchResultSet {
+ function __construct( $resultSet, $terms ) {
+ $this->mResultSet = $resultSet;
+ $this->mTerms = $terms;
+ }
+
+ function termMatches() {
+ return $this->mTerms;
+ }
+
+ function numRows() {
+ return $this->mResultSet->numRows();
+ }
+
+ function next() {
+ if ($this->mResultSet === false )
+ return false;
+
+ $row = $this->mResultSet->fetchObject();
+ if ($row === false)
+ return false;
+ return new SearchResult($row);
+ }
+
+ function free() {
+ $this->mResultSet->free();
+ }
+}
/**
* @ingroup Search
/**
- * @fixme This class is horribly factored. It would probably be better to have
- * a useful base class to which you pass some standard information, then let
- * the fancy self-highlighters extend that.
+ * @todo Fixme: This class is horribly factored. It would probably be better to
+ * have a useful base class to which you pass some standard information, then
+ * let the fancy self-highlighters extend that.
* @ingroup Search
*/
class SearchResult {
/**
* Check if this is result points to an invalid title
*
- * @return boolean
- * @access public
+ * @return Boolean
*/
function isBrokenTitle(){
if( is_null($this->mTitle) )
/**
* Check if target page is missing, happens when index is out of date
*
- * @return boolean
- * @access public
+ * @return Boolean
*/
function isMissingRevision(){
return !$this->mRevision && !$this->mImage;
/**
* @return Title
- * @access public
*/
function getTitle() {
return $this->mTitle;
}
/**
- * @return double or null if not supported
+ * @return Double or null if not supported
*/
function getScore() {
return null;
}
/**
- * @param array $terms terms to highlight
- * @return string highlighted text snippet, null (and not '') if not supported
+ * @param $terms Array: terms to highlight
+ * @return String: highlighted text snippet, null (and not '') if not supported
*/
function getTextSnippet($terms){
global $wgUser, $wgAdvancedSearchHighlighting;
}
/**
- * @param array $terms terms to highlight
- * @return string highlighted title, '' if not supported
+ * @param $terms Array: terms to highlight
+ * @return String: highlighted title, '' if not supported
*/
function getTitleSnippet($terms){
return '';
}
/**
- * @param array $terms terms to highlight
- * @return string highlighted redirect name (redirect to this page), '' if none or not supported
+ * @param $terms Array: terms to highlight
+ * @return String: highlighted redirect name (redirect to this page), '' if none or not supported
*/
function getRedirectSnippet($terms){
return '';
}
/**
- * @return string timestamp
+ * @return String: timestamp
*/
function getTimestamp(){
if( $this->mRevision )
}
/**
- * @return int number of words
+ * @return Integer: number of words
*/
function getWordCount(){
$this->initText();
}
/**
- * @return int size in bytes
+ * @return Integer: size in bytes
*/
function getByteSize(){
$this->initText();
}
/**
- * @return boolean if hit has related articles
+ * @return Boolean if hit has related articles
*/
function hasRelated(){
return false;
}
/**
- * @return interwiki prefix of the title (return iw even if title is broken)
+ * @return String: interwiki prefix of the title (return iw even if title is broken)
*/
function getInterwikiPrefix(){
return '';
/**
* Default implementation of wikitext highlighting
*
- * @param string $text
- * @param array $terms Terms to highlight (unescaped)
- * @param int $contextlines
- * @param int $contextchars
- * @return string
+ * @param $text String
+ * @param $terms Array: terms to highlight (unescaped)
+ * @param $contextlines Integer
+ * @param $contextchars Integer
+ * @return String
*/
public function highlightText( $text, $terms, $contextlines, $contextchars ) {
global $wgLang, $wgContLang;
/**
* Split text into lines and add it to extracts array
*
- * @param array $extracts index -> $line
- * @param int $count
- * @param string $text
+ * @param $extracts Array: index -> $line
+ * @param $count Integer
+ * @param $text String
*/
function splitAndAdd(&$extracts, &$count, $text){
$split = explode( "\n", $this->mCleanWikitext? $this->removeWiki($text) : $text );
/**
* Do manual case conversion for non-ascii chars
*
- * @param unknown_type $matches
+ * @param $matches Array
*/
function caseCallback($matches){
global $wgContLang;
/**
* Extract part of the text from start to end, but by
* not chopping up words
- * @param string $text
- * @param int $start
- * @param int $end
- * @param int $posStart (out) actual start position
- * @param int $posEnd (out) actual end position
- * @return string
+ * @param $text String
+ * @param $start Integer
+ * @param $end Integer
+ * @param $posStart Integer: (out) actual start position
+ * @param $posEnd Integer: (out) actual end position
+ * @return String
*/
function extract($text, $start, $end, &$posStart = null, &$posEnd = null ){
global $wgContLang;
/**
* Find a nonletter near a point (index) in the text
*
- * @param string $text
- * @param int $point
- * @param int $offset to found index
- * @return int nearest nonletter index, or beginning of utf8 char if none
+ * @param $text String
+ * @param $point Integer
+ * @param $offset Integer: offset to found index
+ * @return Integer: nearest nonletter index, or beginning of utf8 char if none
*/
function position($text, $point, $offset=0 ){
$tolerance = 10;
/**
* Search extracts for a pattern, and return snippets
*
- * @param string $pattern regexp for matching lines
- * @param array $extracts extracts to search
- * @param int $linesleft number of extracts to make
- * @param int $contextchars length of snippet
- * @param array $out map for highlighted snippets
- * @param array $offsets map of starting points of snippets
+ * @param $pattern String: regexp for matching lines
+ * @param $extracts Array: extracts to search
+ * @param $linesleft Integer: number of extracts to make
+ * @param $contextchars Integer: length of snippet
+ * @param $out Array: map for highlighted snippets
+ * @param $offsets Array: map of starting points of snippets
* @protected
*/
function process( $pattern, $extracts, &$linesleft, &$contextchars, &$out, &$offsets ){
* callback to replace [[target|caption]] kind of links, if
* the target is category or image, leave it
*
- * @param array $matches
+ * @param $matches Array
*/
function linkReplace($matches){
$colon = strpos( $matches[1], ':' );
* Simple & fast snippet extraction, but gives completely unrelevant
* snippets
*
- * @param string $text
- * @param array $terms
- * @param int $contextlines
- * @param int $contextchars
- * @return string
+ * @param $text String
+ * @param $terms Array
+ * @param $contextlines Integer
+ * @param $contextchars Integer
+ * @return String
*/
public function highlightSimple( $text, $terms, $contextlines, $contextchars ) {
global $wgLang, $wgContLang;
/**
* Dummy class to be used when non-supported Database engine is present.
- * @fixme Dummy class should probably try something at least mildly useful,
+ * @todo Fixme: dummy class should probably try something at least mildly useful,
* such as a LIKE search through titles.
* @ingroup Search
*/
scripts.mit.edu / autoinstalls / mediawiki.git / blobdiff