Go to the documentation of this file.
25 $dbType = $this->db->getType();
26 $dbSupported = ( $dbType ===
'mysql' )
27 || ( $dbType ===
'sqlite' && $this->db->getFulltextSearchModule() ==
'FTS3' );
29 if ( !$dbSupported ) {
30 $this->markTestSkipped(
"MySQL or SQLite with FTS3 only" );
35 'wgSearchType' => $searchType,
36 'wgCapitalLinks' =>
true,
37 'wgCapitalLinkOverrides' => [
42 $this->search =
new $searchType( $this->db );
46 unset( $this->search );
60 'wgSearchType' =>
null,
61 'wgCapitalLinks' =>
true,
62 'wgCapitalLinkOverrides' => [
67 $this->
insertPage(
'Not_Main_Page',
'This is not a main page' );
70 'This is not a talk page to the main page, see [[smithee]]'
72 $this->
insertPage(
'Smithee',
'A smithee is one who smiths. See also [[Alan Smithee]]' );
73 $this->
insertPage(
'Talk:Smithee',
'This article sucks.' );
74 $this->
insertPage(
'Unrelated_page',
'Nothing in this page is about the S word.' );
75 $this->
insertPage(
'Another_page',
'This page also is unrelated.' );
84 $this->
insertPage(
'HalfNumbers',
'1234567890' );
85 $this->
insertPage(
'FullNumbers',
'1234567890' );
86 $this->
insertPage(
'DomainName',
'example.com' );
87 $this->
insertPage(
'DomainName',
'example.com' );
88 $this->
insertPage(
'Category:search is not Search',
'' );
89 $this->
insertPage(
'Category:Search is not search',
'' );
94 $this->markTestIncomplete( __CLASS__ .
" does no yet support non-wikitext content "
95 .
"in the main namespace" );
97 $this->assertTrue( is_object( $results ) );
100 foreach ( $results
as $row ) {
101 $matches[] = $row->getTitle()->getPrefixedText();
104 # Search is not guaranteed to return results in a certain order;
105 # sort them numerically so we will compare simply that we received
106 # the expected matches.
114 [
'FullOneUp',
'FullTwoLow',
'HalfOneUp',
'HalfTwoLow' ],
115 $this->
fetchIds( $this->search->searchText(
'AZ' ) ),
116 "Search for normalized from Half-width Upper" );
118 [
'FullOneUp',
'FullTwoLow',
'HalfOneUp',
'HalfTwoLow' ],
119 $this->
fetchIds( $this->search->searchText(
'az' ) ),
120 "Search for normalized from Half-width Lower" );
122 [
'FullOneUp',
'FullTwoLow',
'HalfOneUp',
'HalfTwoLow' ],
123 $this->
fetchIds( $this->search->searchText(
'AZ' ) ),
124 "Search for normalized from Full-width Upper" );
126 [
'FullOneUp',
'FullTwoLow',
'HalfOneUp',
'HalfTwoLow' ],
127 $this->
fetchIds( $this->search->searchText(
'az' ) ),
128 "Search for normalized from Full-width Lower" );
134 $this->
fetchIds( $this->search->searchText(
'smithee' ) ),
139 $res = $this->search->searchText(
'smith*' );
143 "Search with wildcards" );
145 $res = $this->search->searchText(
'smithson*' );
149 "Search with wildcards must not find unrelated articles" );
151 $res = $this->search->searchText(
'smith* smithee' );
155 "Search with wildcards can be combined with simple terms" );
157 $res = $this->search->searchText(
'smith* "one who smiths"' );
161 "Search with wildcards can be combined with phrase search" );
165 $res = $this->search->searchText(
'"smithee is one who smiths"' );
171 $res = $this->search->searchText(
'"smithee is who smiths"' );
175 "Phrase search is not sloppy, search terms must be adjacent" );
177 $res = $this->search->searchText(
'"is smithee one who smiths"' );
181 "Phrase search is ordered" );
185 $phrase =
"smithee is one who smiths";
186 $res = $this->search->searchText(
"\"$phrase\"" );
187 $match =
$res->getIterator()->current();
188 $snippet =
"A <span class='searchmatch'>" . $phrase .
"</span>";
189 $this->assertStringStartsWith( $snippet,
190 $match->getTextSnippet(
$res->termMatches() ),
191 "Highlight a phrase search" );
195 $this->search->setNamespaces( [ 0, 1, 4 ] );
199 'Talk:Not Main Page',
201 $this->
fetchIds( $this->search->searchText(
'smithee' ) ),
211 $this->
fetchIds( $this->search->searchTitle(
'smithee' ) ),
216 $this->search->setNamespaces( [ 0, 1, 4 ] );
223 $this->
fetchIds( $this->search->searchTitle(
'smithee' ) ),
224 "Title power search" );
229 'Searching for "smithee" finds Smithee on NS_MAIN' => [
234 'Searching for "search is" will finds "search is not Search" on NS_CATEGORY' => [
236 'Category:search is not Search',
239 'Searching for "Search is" will finds "search is not Search" on NS_CATEGORY' => [
241 'Category:Search is not search',
264 $results = $this->search->completionSearch(
$search );
265 $this->assertEquals( 1, $results->getSize() );
266 $this->assertEquals( $expectedSuggestion, $results->getSuggestions()[0]->getText() );
277 ->setMethods( [
'makeSearchFieldMapping' ] )->getMock();
279 $mockFieldBuilder =
function (
$name,
$type ) {
286 $mockField->expects( $this->
any() )->method(
'getMapping' )->willReturn( [
287 'testData' =>
'test',
292 $mockField->expects( $this->
any() )
294 ->willReturn( $mockField );
299 $mockEngine->expects( $this->atLeastOnce() )
300 ->method(
'makeSearchFieldMapping' )
301 ->willReturnCallback( $mockFieldBuilder );
306 $fields[
'testField'] =
311 $fields = $mockEngine->getSearchIndexFields();
312 $this->assertArrayHasKey(
'language', $fields );
313 $this->assertArrayHasKey(
'category', $fields );
316 $mapping = $fields[
'testField']->getMapping( $mockEngine );
317 $this->assertArrayHasKey(
'testData', $mapping );
318 $this->assertEquals(
'test', $mapping[
'testData'] );
327 $this->search->setNamespaces( [ 0, 1, 4 ] );
328 $resultSet = $this->search->searchText(
'smithee' );
331 [
'SearchResultsAugment' => [ [ $this,
'addAugmentors' ] ] ] );
332 $this->search->augmentSearchResults( $resultSet );
334 $id =
$result->getTitle()->getArticleID();
335 $augmentData =
"Result:$id:" .
$result->getTitle()->getText();
336 $augmentData2 =
"Result2:$id:" .
$result->getTitle()->getText();
337 $this->assertEquals( [
'testSet' => $augmentData,
'testRow' => $augmentData2 ],
344 $setAugmentor->expects( $this->once() )
345 ->method(
'augmentAll' )
349 $id =
$result->getTitle()->getArticleID();
350 $data[$id] =
"Result:$id:" .
$result->getTitle()->getText();
354 $setAugmentors[
'testSet'] = $setAugmentor;
357 $rowAugmentor->expects( $this->exactly( 2 ) )
358 ->method(
'augment' )
360 $id =
$result->getTitle()->getArticleID();
361 return "Result2:$id:" .
$result->getTitle()->getText();
367 $availableResults = [];
368 foreach ( range( 0, 11 )
as $i ) {
369 $title =
"Search_Result_$i";
370 $availableResults[] =
$title;
379 $engine->setLimitOffset( 10, 0 );
380 $results =
$engine->completionSearch(
'foo' );
381 $this->assertEquals( 5, $results->getSize() );
382 $this->assertTrue( $results->hasMoreResults() );
384 $engine->setLimitOffset( 10, 10 );
385 $results =
$engine->completionSearch(
'foo' );
386 $this->assertEquals( 1, $results->getSize() );
387 $this->assertFalse( $results->hasMoreResults() );
392 $page->doEditContent(
413 'namespace prefix' => [
415 'query' =>
'help:test',
419 'accented namespace prefix with hook' => [
421 'query' =>
'hélp:test',
426 'accented namespace prefix without hook' => [
428 'query' =>
'hélp:test',
433 'all with all keyword allowed' => [
435 'query' =>
'all:test',
440 'all with all keyword disallowed' => [
442 'query' =>
'all:test',
460 'all wins over namespace when first' => [
462 'query' =>
'all:help:test',
465 [
'help:test',
null ]
467 'ns wins over all when first' => [
469 'query' =>
'help:all:test',
486 if ( strpos(
$query,
'hélp:' ) === 0 ) {
493 if ( isset(
$params[
'withAll'] ) && isset(
$params[
'withHook'] ) ) {
495 } elseif ( isset(
$params[
'withAll'] ) ) {
498 } elseif ( isset(
$params[
'withHook'] ) ) {
502 $testSet[] =
$params + [
'withAll' =>
true,
'withHook' =>
true ];
503 $testSet[] =
$params + [
'withAll' =>
true,
'withHook' =>
false ];
504 $testSet[] =
$params + [
'withAll' =>
false,
'withHook' =>
false ];
505 $testSet[] =
$params + [
'withAll' =>
true,
'withHook' =>
false ];
508 foreach ( $testSet
as $test ) {
510 $test[
'withAll'], $test[
'withHook'] );
511 $this->assertEquals( $expected, $actual,
'with params: ' . print_r( $test,
true ) );
testSearchIndexFields()
SearchEngine::getSearchIndexFields.
the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor & $rowAugmentors
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
processing should stop and the error should be shown to the user * false
testPhraseSearchHighlight()
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
namespace and then decline to actually register it & $namespaces
static parseNamespacePrefixes( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
Parse some common prefixes: all (search everything) or namespace names.
provideCompletionSearchMustRespectCapitalLinkOverrides()
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
provideDataForParseNamespacePrefix()
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
namespace and then decline to actually register it file or subcat img or subcat $title
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
testCompletionSearchMustRespectCapitalLinkOverrides( $search, $expectedSuggestion, array $namespaces)
Test that the search query is not munged using wrong CapitalLinks setup (in other test that the defau...
testTextTitlePowerSearch()
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static getSearchEngineClass(IDatabase $db)
the value to return A Title object or null for latest all implement SearchIndexField $engine
Content object for wiki text pages.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
SearchEngine implementation for returning mocked completion search results.
editSearchResultPage( $title)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Allows to change the fields on the form that will be generated $name
they could even be mouse clicks or menu items whatever suits your program You should also get your if any
addAugmentors(&$setAugmentors, &$rowAugmentors)
Contain a class for special pages.
testParseNamespacePrefix(array $params, $expected)
provideDataForParseNamespacePrefix
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
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
hookSearchIndexFields( $mockFieldBuilder, &$fields, SearchEngine $engine)
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
static addMockResults( $query, array $result)
Allows returning arbitrary lists of titles for completion search.
setUp()
Checks for database type & version.
const INDEX_TYPE_TEXT
TEXT fields are suitable for natural language and may be subject to analysis such as stemming.