4 * Implementation of near match title search.
5 * TODO: split into service/implementation.
7 class SearchNearMatcher
{
19 public function __construct( Config
$config, Language
$lang ) {
20 $this->config
= $config;
21 $this->language
= $lang;
25 * If an exact title match can be found, or a very slightly close match,
26 * return the title. If no match, returns NULL.
28 * @param string $searchterm
31 public function getNearMatch( $searchterm ) {
32 $title = $this->getNearMatchInternal( $searchterm );
34 Hooks
::run( 'SearchGetNearMatchComplete', [ $searchterm, &$title ] );
39 * Do a near match (see SearchEngine::getNearMatch) and wrap it into a
42 * @param string $searchterm
43 * @return SearchResultSet
45 public function getNearMatchResultSet( $searchterm ) {
46 return new SearchNearMatchResultSet( $this->getNearMatch( $searchterm ) );
50 * Really find the title match.
51 * @param string $searchterm
54 protected function getNearMatchInternal( $searchterm ) {
55 $lang = $this->language
;
56 $allSearchTerms = [ $searchterm ];
58 if ( $lang->hasVariants() ) {
59 $allSearchTerms = array_unique( array_merge(
61 $lang->autoConvertToAllVariants( $searchterm )
66 if ( !Hooks
::run( 'SearchGetNearMatchBefore', [ $allSearchTerms, &$titleResult ] ) ) {
70 // Most of our handling here deals with finding a valid title for the search term,
71 // but almost anything starting with '#' is "valid" and points to Main_Page#searchterm.
72 // Rather than doing something completely wrong, do nothing.
73 if ( $searchterm === '' ||
$searchterm[0] === '#' ) {
77 foreach ( $allSearchTerms as $term ) {
78 # Exact match? No need to look further.
79 $title = Title
::newFromText( $term );
80 if ( is_null( $title ) ) {
84 # Try files if searching in the Media: namespace
85 if ( $title->getNamespace() == NS_MEDIA
) {
86 $title = Title
::makeTitle( NS_FILE
, $title->getText() );
89 if ( $title->isSpecialPage() ||
$title->isExternal() ||
$title->exists() ) {
93 # See if it still otherwise has content is some sane sense
94 $page = WikiPage
::factory( $title );
95 if ( $page->hasViewableContent() ) {
99 if ( !Hooks
::run( 'SearchAfterNoDirectMatch', [ $term, &$title ] ) ) {
103 # Now try all lower case (i.e. first letter capitalized)
104 $title = Title
::newFromText( $lang->lc( $term ) );
105 if ( $title && $title->exists() ) {
109 # Now try capitalized string
110 $title = Title
::newFromText( $lang->ucwords( $term ) );
111 if ( $title && $title->exists() ) {
115 # Now try all upper case
116 $title = Title
::newFromText( $lang->uc( $term ) );
117 if ( $title && $title->exists() ) {
121 # Now try Word-Caps-Breaking-At-Word-Breaks, for hyphenated names etc
122 $title = Title
::newFromText( $lang->ucwordbreaks( $term ) );
123 if ( $title && $title->exists() ) {
127 // Give hooks a chance at better match variants
129 if ( !Hooks
::run( 'SearchGetNearMatch', [ $term, &$title ] ) ) {
134 $title = Title
::newFromText( $searchterm );
136 # Entering an IP address goes to the contributions page
137 if ( $this->config
->get( 'EnableSearchContributorsByIP' ) ) {
138 if ( ( $title->getNamespace() == NS_USER
&& User
::isIP( $title->getText() ) )
139 || User
::isIP( trim( $searchterm ) ) ) {
140 return SpecialPage
::getTitleFor( 'Contributions', $title->getDBkey() );
144 # Entering a user goes to the user page whether it's there or not
145 if ( $title->getNamespace() == NS_USER
) {
149 # Go to images that exist even if there's no local page.
150 # There may have been a funny upload, or it may be on a shared
151 # file repository such as Wikimedia Commons.
152 if ( $title->getNamespace() == NS_FILE
) {
153 $image = wfFindFile( $title );
159 # MediaWiki namespace? Page may be "implied" if not customized.
160 # Just return it, with caps forced as the message system likes it.
161 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
162 return Title
::makeTitle( NS_MEDIAWIKI
, $lang->ucfirst( $title->getText() ) );
165 # Quoted term? Try without the quotes...
167 if ( preg_match( '/^"([^"]+)"$/', $searchterm, $matches ) ) {
168 return $this->getNearMatch( $matches[1] );