MediaWiki  1.29.1
SearchNearMatcher.php
Go to the documentation of this file.
1 <?php
2 
12  protected $config;
13 
18  private $language;
19 
20  public function __construct( Config $config, Language $lang ) {
21  $this->config = $config;
22  $this->language = $lang;
23  }
24 
32  public function getNearMatch( $searchterm ) {
33  $title = $this->getNearMatchInternal( $searchterm );
34 
35  Hooks::run( 'SearchGetNearMatchComplete', [ $searchterm, &$title ] );
36  return $title;
37  }
38 
46  public function getNearMatchResultSet( $searchterm ) {
47  return new SearchNearMatchResultSet( $this->getNearMatch( $searchterm ) );
48  }
49 
55  protected function getNearMatchInternal( $searchterm ) {
57 
58  $allSearchTerms = [ $searchterm ];
59 
60  if ( $lang->hasVariants() ) {
61  $allSearchTerms = array_unique( array_merge(
62  $allSearchTerms,
63  $lang->autoConvertToAllVariants( $searchterm )
64  ) );
65  }
66 
67  $titleResult = null;
68  if ( !Hooks::run( 'SearchGetNearMatchBefore', [ $allSearchTerms, &$titleResult ] ) ) {
69  return $titleResult;
70  }
71 
72  foreach ( $allSearchTerms as $term ) {
73 
74  # Exact match? No need to look further.
76  if ( is_null( $title ) ) {
77  return null;
78  }
79 
80  # Try files if searching in the Media: namespace
81  if ( $title->getNamespace() == NS_MEDIA ) {
82  $title = Title::makeTitle( NS_FILE, $title->getText() );
83  }
84 
85  if ( $title->isSpecialPage() || $title->isExternal() || $title->exists() ) {
86  return $title;
87  }
88 
89  # See if it still otherwise has content is some sane sense
91  if ( $page->hasViewableContent() ) {
92  return $title;
93  }
94 
95  if ( !Hooks::run( 'SearchAfterNoDirectMatch', [ $term, &$title ] ) ) {
96  return $title;
97  }
98 
99  # Now try all lower case (i.e. first letter capitalized)
100  $title = Title::newFromText( $lang->lc( $term ) );
101  if ( $title && $title->exists() ) {
102  return $title;
103  }
104 
105  # Now try capitalized string
106  $title = Title::newFromText( $lang->ucwords( $term ) );
107  if ( $title && $title->exists() ) {
108  return $title;
109  }
110 
111  # Now try all upper case
112  $title = Title::newFromText( $lang->uc( $term ) );
113  if ( $title && $title->exists() ) {
114  return $title;
115  }
116 
117  # Now try Word-Caps-Breaking-At-Word-Breaks, for hyphenated names etc
118  $title = Title::newFromText( $lang->ucwordbreaks( $term ) );
119  if ( $title && $title->exists() ) {
120  return $title;
121  }
122 
123  // Give hooks a chance at better match variants
124  $title = null;
125  if ( !Hooks::run( 'SearchGetNearMatch', [ $term, &$title ] ) ) {
126  return $title;
127  }
128  }
129 
130  $title = Title::newFromText( $searchterm );
131 
132  # Entering an IP address goes to the contributions page
133  if ( $this->config->get( 'EnableSearchContributorsByIP' ) ) {
134  if ( ( $title->getNamespace() == NS_USER && User::isIP( $title->getText() ) )
135  || User::isIP( trim( $searchterm ) ) ) {
136  return SpecialPage::getTitleFor( 'Contributions', $title->getDBkey() );
137  }
138  }
139 
140  # Entering a user goes to the user page whether it's there or not
141  if ( $title->getNamespace() == NS_USER ) {
142  return $title;
143  }
144 
145  # Go to images that exist even if there's no local page.
146  # There may have been a funny upload, or it may be on a shared
147  # file repository such as Wikimedia Commons.
148  if ( $title->getNamespace() == NS_FILE ) {
149  $image = wfFindFile( $title );
150  if ( $image ) {
151  return $title;
152  }
153  }
154 
155  # MediaWiki namespace? Page may be "implied" if not customized.
156  # Just return it, with caps forced as the message system likes it.
157  if ( $title->getNamespace() == NS_MEDIAWIKI ) {
158  return Title::makeTitle( NS_MEDIAWIKI, $lang->ucfirst( $title->getText() ) );
159  }
160 
161  # Quoted term? Try without the quotes...
162  $matches = [];
163  if ( preg_match( '/^"([^"]+)"$/', $searchterm, $matches ) ) {
164  return self::getNearMatch( $matches[1] );
165  }
166 
167  return null;
168  }
169 }
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
SearchNearMatcher\getNearMatchInternal
getNearMatchInternal( $searchterm)
Really find the title match.
Definition: SearchNearMatcher.php:55
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
NS_FILE
const NS_FILE
Definition: Defines.php:68
SearchNearMatcher\getNearMatch
getNearMatch( $searchterm)
If an exact title match can be found, or a very slightly close match, return the title.
Definition: SearchNearMatcher.php:32
$term
external whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2759
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Config
Interface for configuration instances.
Definition: Config.php:28
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:120
SearchNearMatcher
Implementation of near match title search.
Definition: SearchNearMatcher.php:7
$page
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2536
$matches
$matches
Definition: NoLocalSettings.php:24
User\isIP
static isIP( $name)
Does the string match an anonymous IP address?
Definition: User.php:819
SearchNearMatchResultSet
A SearchResultSet wrapper for SearchNearMatcher.
Definition: SearchNearMatchResultSet.php:5
SearchNearMatcher\getNearMatchResultSet
getNearMatchResultSet( $searchterm)
Do a near match (see SearchEngine::getNearMatch) and wrap it into a SearchResultSet.
Definition: SearchNearMatcher.php:46
SearchNearMatcher\$language
Language $language
Current language.
Definition: SearchNearMatcher.php:18
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:514
$image
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition: hooks.txt:783
NS_MEDIA
const NS_MEDIA
Definition: Defines.php:50
language
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two distribute and or modify the software for each author s protection and we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed we want its recipients to know that what they have is not the so that any problems introduced by others will not reflect on the original authors reputations any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent in effect making the program proprietary To prevent we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for distribution and modification follow GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR DISTRIBUTION AND MODIFICATION This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The refers to any such program or and a work based on the Program means either the Program or any derivative work under copyright a work containing the Program or a portion of either verbatim or with modifications and or translated into another language(Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:3101
SearchNearMatcher\$config
$config
Configuration object.
Definition: SearchNearMatcher.php:12
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
SearchNearMatcher\__construct
__construct(Config $config, Language $lang)
Definition: SearchNearMatcher.php:20
NS_USER
const NS_USER
Definition: Defines.php:64
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:70
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
Language
Internationalisation code.
Definition: Language.php:35