3 use Wikimedia\TestingAccessWrapper
;
8 class MessageTest
extends MediaWikiLangTestCase
{
10 protected function setUp() {
13 $this->setMwGlobals( [
14 'wgForceUIMsgAsContentMsg' => [],
16 $this->setUserLang( 'en' );
20 * @covers Message::__construct
21 * @dataProvider provideConstructor
23 public function testConstructor( $expectedLang, $key, $params, $language ) {
24 $message = new Message( $key, $params, $language );
26 $this->assertSame( $key, $message->getKey() );
27 $this->assertSame( $params, $message->getParams() );
28 $this->assertSame( $expectedLang->getCode(), $message->getLanguage()->getCode() );
30 $messageSpecifier = $this->getMockForAbstractClass( MessageSpecifier
::class );
31 $messageSpecifier->expects( $this->any() )
32 ->method( 'getKey' )->will( $this->returnValue( $key ) );
33 $messageSpecifier->expects( $this->any() )
34 ->method( 'getParams' )->will( $this->returnValue( $params ) );
35 $message = new Message( $messageSpecifier, [], $language );
37 $this->assertSame( $key, $message->getKey() );
38 $this->assertSame( $params, $message->getParams() );
39 $this->assertSame( $expectedLang->getCode(), $message->getLanguage()->getCode() );
42 public static function provideConstructor() {
43 $langDe = Language
::factory( 'de' );
44 $langEn = Language
::factory( 'en' );
47 [ $langDe, 'foo', [], $langDe ],
48 [ $langDe, 'foo', [ 'bar' ], $langDe ],
49 [ $langEn, 'foo', [ 'bar' ], null ]
53 public static function provideConstructorParams() {
80 [ Message
::rawParam( 'baz' ) ],
81 [ Message
::rawParam( 'baz' ) ],
84 [ Message
::rawParam( 'baz' ), 'foo' ],
85 [ Message
::rawParam( 'baz' ), 'foo' ],
88 [ Message
::rawParam( 'baz' ) ],
89 [ [ Message
::rawParam( 'baz' ) ] ],
92 [ Message
::rawParam( 'baz' ), 'foo' ],
93 [ [ Message
::rawParam( 'baz' ), 'foo' ] ],
96 // Test handling of erroneous input, to detect if it changes
98 [ [ 'baz', 'foo' ], 'hhh' ],
99 [ [ 'baz', 'foo' ], 'hhh' ],
102 [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
103 [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
106 [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
107 [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
110 [ [ 'baz' ], [ 'ahahahahha' ] ],
111 [ [ 'baz' ], [ 'ahahahahha' ] ],
117 * @covers Message::__construct
118 * @covers Message::getParams
119 * @dataProvider provideConstructorParams
121 public function testConstructorParams( $expected, $args ) {
122 $msg = new Message( 'imasomething' );
124 $returned = call_user_func_array( [ $msg, 'params' ], $args );
126 $this->assertSame( $msg, $returned );
127 $this->assertSame( $expected, $msg->getParams() );
130 public static function provideConstructorLanguage() {
132 [ 'foo', [ 'bar' ], 'en' ],
133 [ 'foo', [ 'bar' ], 'de' ]
138 * @covers Message::__construct
139 * @covers Message::getLanguage
140 * @dataProvider provideConstructorLanguage
142 public function testConstructorLanguage( $key, $params, $languageCode ) {
143 $language = Language
::factory( $languageCode );
144 $message = new Message( $key, $params, $language );
146 $this->assertEquals( $language, $message->getLanguage() );
149 public static function provideKeys() {
153 'expected' => [ 'mainpage' ],
156 'key' => [ 'mainpage' ],
157 'expected' => [ 'mainpage' ],
160 'key' => [ 'mainpage-foo', 'mainpage-bar', 'mainpage' ],
161 'expected' => [ 'mainpage-foo', 'mainpage-bar', 'mainpage' ],
166 'exception' => 'InvalidArgumentException',
171 'exception' => 'InvalidArgumentException',
176 'exception' => 'InvalidArgumentException',
182 * @covers Message::__construct
183 * @covers Message::getKey
184 * @covers Message::isMultiKey
185 * @covers Message::getKeysToTry
186 * @dataProvider provideKeys
188 public function testKeys( $key, $expected, $exception = null ) {
190 $this->setExpectedException( $exception );
193 $msg = new Message( $key );
194 $this->assertContains( $msg->getKey(), $expected );
195 $this->assertSame( $expected, $msg->getKeysToTry() );
196 $this->assertSame( count( $expected ) > 1, $msg->isMultiKey() );
200 * @covers ::wfMessage
202 public function testWfMessage() {
203 $this->assertInstanceOf( Message
::class, wfMessage( 'mainpage' ) );
204 $this->assertInstanceOf( Message
::class, wfMessage( 'i-dont-exist-evar' ) );
208 * @covers Message::newFromKey
210 public function testNewFromKey() {
211 $this->assertInstanceOf( Message
::class, Message
::newFromKey( 'mainpage' ) );
212 $this->assertInstanceOf( Message
::class, Message
::newFromKey( 'i-dont-exist-evar' ) );
216 * @covers ::wfMessage
217 * @covers Message::__construct
219 public function testWfMessageParams() {
220 $this->assertSame( 'Return to $1.', wfMessage( 'returnto' )->text() );
221 $this->assertSame( 'Return to $1.', wfMessage( 'returnto', [] )->text() );
224 wfMessage( 'returnto', Message
::numParam( 1024 ) )->text()
228 wfMessage( 'returnto', [ Message
::numParam( 1024 ) ] )->text()
231 'You have foo (bar).',
232 wfMessage( 'youhavenewmessages', 'foo', 'bar' )->text()
235 'You have foo (bar).',
236 wfMessage( 'youhavenewmessages', [ 'foo', 'bar' ] )->text()
239 'You have 1,024 (bar).',
241 'youhavenewmessages',
242 Message
::numParam( 1024 ), 'bar'
246 'You have foo (2,048).',
248 'youhavenewmessages',
249 'foo', Message
::numParam( 2048 )
253 'You have 1,024 (2,048).',
255 'youhavenewmessages',
256 [ Message
::numParam( 1024 ), Message
::numParam( 2048 ) ]
262 * @covers Message::exists
264 public function testExists() {
265 $this->assertTrue( wfMessage( 'mainpage' )->exists() );
266 $this->assertTrue( wfMessage( 'mainpage' )->params( [] )->exists() );
267 $this->assertTrue( wfMessage( 'mainpage' )->rawParams( 'foo', 123 )->exists() );
268 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->exists() );
269 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->params( [] )->exists() );
270 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->rawParams( 'foo', 123 )->exists() );
274 * @covers Message::__construct
275 * @covers Message::text
276 * @covers Message::plain
277 * @covers Message::escaped
278 * @covers Message::toString
280 public function testToStringKey() {
281 $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->text() );
282 $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->text() );
283 $this->assertSame( '⧼i<dont>exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->text() );
284 $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->plain() );
285 $this->assertSame( '⧼i<dont>exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->plain() );
286 $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->escaped() );
288 '⧼i<dont>exist-evar⧽',
289 wfMessage( 'i<dont>exist-evar' )->escaped()
293 public static function provideToString() {
295 // key, transformation, transformed, transformed implicitly
296 [ 'mainpage', 'plain', 'Main Page', 'Main Page' ],
297 [ 'i-dont-exist-evar', 'plain', '⧼i-dont-exist-evar⧽', '⧼i-dont-exist-evar⧽' ],
298 [ 'i-dont-exist-evar', 'escaped', '⧼i-dont-exist-evar⧽', '⧼i-dont-exist-evar⧽' ],
299 [ 'script>alert(1)</script', 'escaped', '⧼script>alert(1)</script⧽',
300 '⧼script>alert(1)</script⧽' ],
301 [ 'script>alert(1)</script', 'plain', '⧼script>alert(1)</script⧽',
302 '⧼script>alert(1)</script⧽' ],
307 * @covers Message::toString
308 * @covers Message::__toString
309 * @dataProvider provideToString
311 public function testToString( $key, $format, $expect, $expectImplicit ) {
312 $msg = new Message( $key );
313 $this->assertSame( $expect, $msg->$format() );
314 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' );
315 $this->assertSame( $expectImplicit, $msg->__toString() );
316 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' );
319 public static function provideToString_raw() {
321 [ '<span>foo</span>', 'parse', '<span>foo</span>', '<span>foo</span>' ],
322 [ '<span>foo</span>', 'escaped', '<span>foo</span>',
323 '<span>foo</span>' ],
324 [ '<span>foo</span>', 'plain', '<span>foo</span>', '<span>foo</span>' ],
325 [ '<script>alert(1)</script>', 'parse', '<script>alert(1)</script>',
326 '<script>alert(1)</script>' ],
327 [ '<script>alert(1)</script>', 'escaped', '<script>alert(1)</script>',
328 '<script>alert(1)</script>' ],
329 [ '<script>alert(1)</script>', 'plain', '<script>alert(1)</script>',
330 '<script>alert(1)</script>' ],
335 * @covers Message::toString
336 * @covers Message::__toString
337 * @dataProvider provideToString_raw
339 public function testToString_raw( $message, $format, $expect, $expectImplicit ) {
340 // make the message behave like RawMessage and use the key as-is
341 $msg = $this->getMockBuilder( Message
::class )->setMethods( [ 'fetchMessage' ] )
342 ->disableOriginalConstructor()
344 $msg->expects( $this->any() )->method( 'fetchMessage' )->willReturn( $message );
345 /** @var Message $msg */
346 $this->assertSame( $expect, $msg->$format() );
347 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' );
348 $this->assertSame( $expectImplicit, $msg->__toString() );
349 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' );
353 * @covers Message::inLanguage
355 public function testInLanguage() {
356 $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() );
357 $this->assertSame( 'Заглавная страница',
358 wfMessage( 'mainpage' )->inLanguage( 'ru' )->text() );
360 // NOTE: make sure internal caching of the message text is reset appropriately
361 $msg = wfMessage( 'mainpage' );
362 $this->assertSame( 'Main Page', $msg->inLanguage( Language
::factory( 'en' ) )->text() );
364 'Заглавная страница',
365 $msg->inLanguage( Language
::factory( 'ru' ) )->text()
370 * @covers Message::rawParam
371 * @covers Message::rawParams
373 public function testRawParams() {
375 '(Заглавная страница)',
376 wfMessage( 'parentheses', 'Заглавная страница' )->plain()
379 '(Заглавная страница $1)',
380 wfMessage( 'parentheses', 'Заглавная страница $1' )->plain()
383 '(Заглавная страница)',
384 wfMessage( 'parentheses' )->rawParams( 'Заглавная страница' )->plain()
387 '(Заглавная страница $1)',
388 wfMessage( 'parentheses' )->rawParams( 'Заглавная страница $1' )->plain()
393 * @covers RawMessage::__construct
394 * @covers RawMessage::fetchMessage
396 public function testRawMessage() {
397 $msg = new RawMessage( 'example &' );
398 $this->assertSame( 'example &', $msg->plain() );
399 $this->assertSame( 'example &', $msg->escaped() );
403 * @covers CoreTagHooks::html
405 public function testRawHtmlInMsg() {
406 $this->setMwGlobals( 'wgRawHtml', true );
408 $msg = new RawMessage( '<html><script>alert("xss")</script></html>' );
409 $txt = '<span class="error"><html> tags cannot be' .
410 ' used outside of normal pages.</span>';
411 $this->assertSame( $txt, $msg->parse() );
415 * @covers Message::params
416 * @covers Message::toString
417 * @covers Message::replaceParameters
419 public function testReplaceManyParams() {
420 $msg = new RawMessage( '$1$2$3$4$5$6$7$8$9$10$11$12' );
421 // One less than above has placeholders
422 $params = [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k' ];
425 $msg->params( $params )->plain(),
426 'Params > 9 are replaced correctly'
429 $msg = new RawMessage( 'Params$*' );
430 $params = [ 'ab', 'bc', 'cd' ];
432 'Params: ab, bc, cd',
433 $msg->params( $params )->text()
438 * @covers Message::numParam
439 * @covers Message::numParams
441 public function testNumParams() {
442 $lang = Language
::factory( 'en' );
443 $msg = new RawMessage( '$1' );
446 $lang->formatNum( 123456.789 ),
447 $msg->inLanguage( $lang )->numParams( 123456.789 )->plain(),
448 'numParams is handled correctly'
453 * @covers Message::durationParam
454 * @covers Message::durationParams
456 public function testDurationParams() {
457 $lang = Language
::factory( 'en' );
458 $msg = new RawMessage( '$1' );
461 $lang->formatDuration( 1234 ),
462 $msg->inLanguage( $lang )->durationParams( 1234 )->plain(),
463 'durationParams is handled correctly'
468 * FIXME: This should not need database, but Language#formatExpiry does (T57912)
469 * @covers Message::expiryParam
470 * @covers Message::expiryParams
472 public function testExpiryParams() {
473 $lang = Language
::factory( 'en' );
474 $msg = new RawMessage( '$1' );
477 $lang->formatExpiry( wfTimestampNow() ),
478 $msg->inLanguage( $lang )->expiryParams( wfTimestampNow() )->plain(),
479 'expiryParams is handled correctly'
484 * @covers Message::timeperiodParam
485 * @covers Message::timeperiodParams
487 public function testTimeperiodParams() {
488 $lang = Language
::factory( 'en' );
489 $msg = new RawMessage( '$1' );
492 $lang->formatTimePeriod( 1234 ),
493 $msg->inLanguage( $lang )->timeperiodParams( 1234 )->plain(),
494 'timeperiodParams is handled correctly'
499 * @covers Message::sizeParam
500 * @covers Message::sizeParams
502 public function testSizeParams() {
503 $lang = Language
::factory( 'en' );
504 $msg = new RawMessage( '$1' );
507 $lang->formatSize( 123456 ),
508 $msg->inLanguage( $lang )->sizeParams( 123456 )->plain(),
509 'sizeParams is handled correctly'
514 * @covers Message::bitrateParam
515 * @covers Message::bitrateParams
517 public function testBitrateParams() {
518 $lang = Language
::factory( 'en' );
519 $msg = new RawMessage( '$1' );
522 $lang->formatBitrate( 123456 ),
523 $msg->inLanguage( $lang )->bitrateParams( 123456 )->plain(),
524 'bitrateParams is handled correctly'
528 public static function providePlaintextParams() {
531 'one $2 <div>foo</div> [[Bar]] {{Baz}} <',
537 'one $2 <div>foo</div> [[Bar]] {{Baz}} <',
542 'one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;',
547 'one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;',
552 "<p>one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;\n</p>",
559 * @covers Message::plaintextParam
560 * @covers Message::plaintextParams
561 * @covers Message::formatPlaintext
562 * @covers Message::toString
563 * @covers Message::parse
564 * @covers Message::parseAsBlock
565 * @dataProvider providePlaintextParams
567 public function testPlaintextParams( $expect, $format ) {
568 $lang = Language
::factory( 'en' );
570 $msg = new RawMessage( '$1 $2' );
573 '<div>foo</div> [[Bar]] {{Baz}} <',
577 $msg->inLanguage( $lang )->plaintextParams( $params )->$format(),
578 "Fail formatting for $format"
582 public static function provideListParam() {
583 $lang = Language
::factory( 'de' );
584 $msg1 = new Message( 'mainpage', [], $lang );
585 $msg2 = new RawMessage( "''link''", [], $lang );
588 'Simple comma list' => [
595 'Simple semicolon list' => [
602 'Simple pipe list' => [
609 'Simple text list' => [
623 'List with all "before" params, ->text()' => [
624 [ "''link''", Message
::numParam( 12345678 ) ],
627 '\'\'link\'\'; 12,345,678'
630 'List with all "before" params, ->parse()' => [
631 [ "''link''", Message
::numParam( 12345678 ) ],
634 '<i>link</i>; 12,345,678'
637 'List with all "after" params, ->text()' => [
638 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ) ],
641 'Main Page; \'\'link\'\'; [[foo]]'
644 'List with all "after" params, ->parse()' => [
645 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ) ],
648 'Main Page; <i>link</i>; [[foo]]'
651 'List with both "before" and "after" params, ->text()' => [
652 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ), "''link''", Message
::numParam( 12345678 ) ],
655 'Main Page; \'\'link\'\'; [[foo]]; \'\'link\'\'; 12,345,678'
658 'List with both "before" and "after" params, ->parse()' => [
659 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ), "''link''", Message
::numParam( 12345678 ) ],
662 'Main Page; <i>link</i>; [[foo]]; <i>link</i>; 12,345,678'
668 * @covers Message::listParam
669 * @covers Message::extractParam
670 * @covers Message::formatListParam
671 * @dataProvider provideListParam
673 public function testListParam( $list, $type, $format, $expect ) {
674 $lang = Language
::factory( 'en' );
676 $msg = new RawMessage( '$1' );
677 $msg->params( [ Message
::listParam( $list, $type ) ] );
680 $msg->inLanguage( $lang )->$format()
685 * @covers Message::extractParam
687 public function testMessageAsParam() {
688 $this->setMwGlobals( [
689 'wgScript' => '/wiki/index.php',
690 'wgArticlePath' => '/wiki/$1',
693 $msg = new Message( 'returnto', [
694 new Message( 'apihelp-link', [
695 'foo', new Message( 'mainpage', [], Language
::factory( 'en' ) )
696 ], Language
::factory( 'de' ) )
697 ], Language
::factory( 'es' ) );
700 'Volver a [[Special:ApiHelp/foo|Página principal]].',
702 'Process with ->text()'
705 '<p>Volver a <a href="/wiki/Special:ApiHelp/foo" title="Special:ApiHelp/foo">Página '
706 . "principal</a>.\n</p>",
707 $msg->parseAsBlock(),
708 'Process with ->parseAsBlock()'
712 public static function provideParser() {
715 "''&'' <x><!-- x -->",
720 "''&'' <x><!-- x -->",
724 '<i>&</i> <x>',
729 "<p><i>&</i> <x>\n</p>",
736 * @covers Message::text
737 * @covers Message::parse
738 * @covers Message::parseAsBlock
739 * @covers Message::toString
740 * @covers Message::transformText
741 * @covers Message::parseText
742 * @dataProvider provideParser
744 public function testParser( $expect, $format ) {
745 $msg = new RawMessage( "''&'' <x><!-- x -->" );
748 $msg->inLanguage( 'en' )->$format()
753 * @covers Message::inContentLanguage
755 public function testInContentLanguage() {
756 $this->setUserLang( 'fr' );
758 // NOTE: make sure internal caching of the message text is reset appropriately
759 $msg = wfMessage( 'mainpage' );
760 $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
761 $this->assertSame( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" );
762 $this->assertSame( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" );
766 * @covers Message::inContentLanguage
768 public function testInContentLanguageOverride() {
769 $this->setMwGlobals( [
770 'wgForceUIMsgAsContentMsg' => [ 'mainpage' ],
772 $this->setUserLang( 'fr' );
774 // NOTE: make sure internal caching of the message text is reset appropriately.
775 // NOTE: wgForceUIMsgAsContentMsg forces the messages *current* language to be used.
776 $msg = wfMessage( 'mainpage' );
779 $msg->inContentLanguage()->plain(),
780 'inContentLanguage() with ForceUIMsg override enabled'
782 $this->assertSame( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" );
785 $msg->inContentLanguage()->plain(),
786 'inContentLanguage() with ForceUIMsg override enabled'
788 $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
792 * @expectedException MWException
793 * @covers Message::inLanguage
795 public function testInLanguageThrows() {
796 wfMessage( 'foo' )->inLanguage( 123 );
800 * @covers Message::serialize
801 * @covers Message::unserialize
803 public function testSerialization() {
804 $msg = new Message( 'parentheses' );
805 $msg->rawParams( '<a>foo</a>' );
806 $msg->title( Title
::newFromText( 'Testing' ) );
807 $this->assertSame( '(<a>foo</a>)', $msg->parse(), 'Sanity check' );
808 $msg = unserialize( serialize( $msg ) );
809 $this->assertSame( '(<a>foo</a>)', $msg->parse() );
810 $title = TestingAccessWrapper
::newFromObject( $msg )->title
;
811 $this->assertInstanceOf( Title
::class, $title );
812 $this->assertSame( 'Testing', $title->getFullText() );
814 $msg = new Message( 'mainpage' );
815 $msg->inLanguage( 'de' );
816 $this->assertSame( 'Hauptseite', $msg->plain(), 'Sanity check' );
817 $msg = unserialize( serialize( $msg ) );
818 $this->assertSame( 'Hauptseite', $msg->plain() );
822 * @covers Message::newFromSpecifier
823 * @dataProvider provideNewFromSpecifier
825 public function testNewFromSpecifier( $value, $expectedText ) {
826 $message = Message
::newFromSpecifier( $value );
827 $this->assertInstanceOf( Message
::class, $message );
828 if ( $value instanceof Message
) {
829 $this->assertInstanceOf( get_class( $value ), $message );
830 $this->assertEquals( $value, $message );
832 $this->assertSame( $expectedText, $message->text() );
835 public function provideNewFromSpecifier() {
836 $messageSpecifier = $this->getMockForAbstractClass( MessageSpecifier
::class );
837 $messageSpecifier->expects( $this->any() )->method( 'getKey' )->willReturn( 'mainpage' );
838 $messageSpecifier->expects( $this->any() )->method( 'getParams' )->willReturn( [] );
841 'string' => [ 'mainpage', 'Main Page' ],
842 'array' => [ [ 'youhavenewmessages', 'foo', 'bar' ], 'You have foo (bar).' ],
843 'Message' => [ new Message( 'youhavenewmessages', [ 'foo', 'bar' ] ), 'You have foo (bar).' ],
844 'RawMessage' => [ new RawMessage( 'foo ($1)', [ 'bar' ] ), 'foo (bar)' ],
845 'ApiMessage' => [ new ApiMessage( [ 'mainpage' ], 'code', [ 'data' ] ), 'Main Page' ],
846 'MessageSpecifier' => [ $messageSpecifier, 'Main Page' ],
847 'nested RawMessage' => [ [ new RawMessage( 'foo ($1)', [ 'bar' ] ) ], 'foo (bar)' ],