MediaWiki  REL1_31
MessageCacheTest.php
Go to the documentation of this file.
1 <?php
2 
9 
10  protected function setUp() {
11  parent::setUp();
12  $this->configureLanguages();
13  MessageCache::singleton()->enable();
14  }
15 
19  protected function configureLanguages() {
20  // for the test, we need the content language to be anything but English,
21  // let's choose e.g. German (de)
22  $this->setUserLang( 'de' );
23  $this->setContentLang( 'de' );
24  }
25 
26  function addDBDataOnce() {
27  $this->configureLanguages();
28 
29  // Set up messages and fallbacks ab -> ru -> de
30  $this->makePage( 'FallbackLanguageTest-Full', 'ab' );
31  $this->makePage( 'FallbackLanguageTest-Full', 'ru' );
32  $this->makePage( 'FallbackLanguageTest-Full', 'de' );
33 
34  // Fallbacks where ab does not exist
35  $this->makePage( 'FallbackLanguageTest-Partial', 'ru' );
36  $this->makePage( 'FallbackLanguageTest-Partial', 'de' );
37 
38  // Fallback to the content language
39  $this->makePage( 'FallbackLanguageTest-ContLang', 'de' );
40 
41  // Add customizations for an existing message.
42  $this->makePage( 'sunday', 'ru' );
43 
44  // Full key tests -- always want russian
45  $this->makePage( 'MessageCacheTest-FullKeyTest', 'ab' );
46  $this->makePage( 'MessageCacheTest-FullKeyTest', 'ru' );
47 
48  // In content language -- get base if no derivative
49  $this->makePage( 'FallbackLanguageTest-NoDervContLang', 'de', 'de/none' );
50  }
51 
59  protected function makePage( $title, $lang, $content = null ) {
61 
62  if ( $content === null ) {
63  $content = $lang;
64  }
65  if ( $lang !== $wgContLang->getCode() ) {
66  $title = "$title/$lang";
67  }
68 
70  $wikiPage = new WikiPage( $title );
71  $contentHandler = ContentHandler::makeContent( $content, $title );
72  $wikiPage->doEditContent( $contentHandler, "$lang translation test case" );
73  }
74 
80  public function testMessageFallbacks( $message, $lang, $expectedContent ) {
81  $result = MessageCache::singleton()->get( $message, true, $lang );
82  $this->assertEquals( $expectedContent, $result, "Message fallback failed." );
83  }
84 
86  return [
87  [ 'FallbackLanguageTest-Full', 'ab', 'ab' ],
88  [ 'FallbackLanguageTest-Partial', 'ab', 'ru' ],
89  [ 'FallbackLanguageTest-ContLang', 'ab', 'de' ],
90  [ 'FallbackLanguageTest-None', 'ab', false ],
91 
92  // Existing message with customizations on the fallbacks
93  [ 'sunday', 'ab', 'амҽыш' ],
94 
95  // T48579
96  [ 'FallbackLanguageTest-NoDervContLang', 'de', 'de/none' ],
97  // UI language different from content language should only use de/none as last option
98  [ 'FallbackLanguageTest-NoDervContLang', 'fit', 'de/none' ],
99  ];
100  }
101 
102  public function testReplaceMsg() {
104 
105  $messageCache = MessageCache::singleton();
106  $message = 'go';
107  $uckey = $wgContLang->ucfirst( $message );
108  $oldText = $messageCache->get( $message ); // "Ausführen"
109 
110  $dbw = wfGetDB( DB_MASTER );
111  $dbw->startAtomic( __METHOD__ ); // simulate request and block deferred updates
112  $messageCache->replace( $uckey, 'Allez!' );
113  $this->assertEquals( 'Allez!',
114  $messageCache->getMsgFromNamespace( $uckey, 'de' ),
115  'Updates are reflected in-process immediately' );
116  $this->assertEquals( 'Allez!',
117  $messageCache->get( $message ),
118  'Updates are reflected in-process immediately' );
119  $this->makePage( 'Go', 'de', 'Race!' );
120  $dbw->endAtomic( __METHOD__ );
121 
122  $this->assertEquals( 0,
124  'Post-commit deferred update triggers a run of all updates' );
125 
126  $this->assertEquals( 'Race!', $messageCache->get( $message ), 'Correct final contents' );
127 
128  $this->makePage( 'Go', 'de', $oldText );
129  $messageCache->replace( $uckey, $oldText ); // deferred update runs immediately
130  $this->assertEquals( $oldText, $messageCache->get( $message ), 'Content restored' );
131  }
132 
139  public function testFullKeyBehaviour( $message, $lang, $expectedContent ) {
140  $result = MessageCache::singleton()->get( $message, true, $lang, true );
141  $this->assertEquals( $expectedContent, $result, "Full key message fallback failed." );
142  }
143 
145  return [
146  [ 'MessageCacheTest-FullKeyTest/ru', 'ru', 'ru' ],
147  [ 'MessageCacheTest-FullKeyTest/ru', 'ab', 'ru' ],
148  [ 'MessageCacheTest-FullKeyTest/ru/foo', 'ru', false ],
149  ];
150  }
151 
155  public function testNormalizeKey( $key, $expected ) {
156  $actual = MessageCache::normalizeKey( $key );
157  $this->assertEquals( $expected, $actual );
158  }
159 
160  public function provideNormalizeKey() {
161  return [
162  [ 'Foo', 'foo' ],
163  [ 'foo', 'foo' ],
164  [ 'fOo', 'fOo' ],
165  [ 'FOO', 'fOO' ],
166  [ 'Foo bar', 'foo_bar' ],
167  [ 'Ćab', 'ćab' ],
168  [ 'Ćab_e 3', 'ćab_e_3' ],
169  [ 'ĆAB', 'ćAB' ],
170  [ 'ćab', 'ćab' ],
171  [ 'ćaB', 'ćaB' ],
172  ];
173  }
174 }
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:273
MessageCacheTest
Database Cache MessageCache.
Definition: MessageCacheTest.php:8
MessageCache\normalizeKey
static normalizeKey( $key)
Normalize message key input.
Definition: MessageCache.php:145
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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
Definition: hooks.txt:1993
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:37
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
MessageCacheTest\configureLanguages
configureLanguages()
Helper function – setup site language for testing.
Definition: MessageCacheTest.php:19
MessageCacheTest\provideMessagesForFallback
provideMessagesForFallback()
Definition: MessageCacheTest.php:85
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
MediaWikiTestCase\setUserLang
setUserLang( $lang)
Definition: MediaWikiTestCase.php:883
DB_MASTER
const DB_MASTER
Definition: defines.php:26
MessageCacheTest\addDBDataOnce
addDBDataOnce()
Stub.
Definition: MessageCacheTest.php:26
MessageCache\singleton
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:113
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
MessageCacheTest\testMessageFallbacks
testMessageFallbacks( $message, $lang, $expectedContent)
Test message fallbacks, bug #1495.
Definition: MessageCacheTest.php:80
MediaWikiTestCase\setContentLang
setContentLang( $lang)
Definition: MediaWikiTestCase.php:892
MessageCacheTest\makePage
makePage( $title, $lang, $content=null)
Helper function for addDBData – adds a simple page to the database.
Definition: MessageCacheTest.php:59
MessageCacheTest\testNormalizeKey
testNormalizeKey( $key, $expected)
provideNormalizeKey
Definition: MessageCacheTest.php:155
MessageCacheTest\setUp
setUp()
Definition: MessageCacheTest.php:10
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
MessageCacheTest\testReplaceMsg
testReplaceMsg()
Definition: MessageCacheTest.php:102
DeferredUpdates\pendingUpdatesCount
static pendingUpdatesCount()
Definition: DeferredUpdates.php:330
MessageCacheTest\provideNormalizeKey
provideNormalizeKey()
Definition: MessageCacheTest.php:160
MessageCacheTest\testFullKeyBehaviour
testFullKeyBehaviour( $message, $lang, $expectedContent)
There's a fallback case where the message key is given as fully qualified – this should ignore the pa...
Definition: MessageCacheTest.php:139
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:82
MessageCacheTest\provideMessagesForFullKeys
provideMessagesForFullKeys()
Definition: MessageCacheTest.php:144
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57