3 use MediaWiki\MediaWikiServices
;
4 use Wikimedia\TestingAccessWrapper
;
9 class MessageTest
extends MediaWikiLangTestCase
{
11 protected function setUp() {
14 $this->setMwGlobals( [
15 'wgForceUIMsgAsContentMsg' => [],
17 $this->setUserLang( 'en' );
21 * @covers Message::__construct
22 * @dataProvider provideConstructor
24 public function testConstructor( $expectedLang, $key, $params, $language ) {
25 $message = new Message( $key, $params, $language );
27 $this->assertSame( $key, $message->getKey() );
28 $this->assertSame( $params, $message->getParams() );
29 $this->assertSame( $expectedLang->getCode(), $message->getLanguage()->getCode() );
31 $messageSpecifier = $this->getMockForAbstractClass( MessageSpecifier
::class );
32 $messageSpecifier->expects( $this->any() )
33 ->method( 'getKey' )->will( $this->returnValue( $key ) );
34 $messageSpecifier->expects( $this->any() )
35 ->method( 'getParams' )->will( $this->returnValue( $params ) );
36 $message = new Message( $messageSpecifier, [], $language );
38 $this->assertSame( $key, $message->getKey() );
39 $this->assertSame( $params, $message->getParams() );
40 $this->assertSame( $expectedLang->getCode(), $message->getLanguage()->getCode() );
43 public static function provideConstructor() {
44 $langDe = Language
::factory( 'de' );
45 $langEn = Language
::factory( 'en' );
48 [ $langDe, 'foo', [], $langDe ],
49 [ $langDe, 'foo', [ 'bar' ], $langDe ],
50 [ $langEn, 'foo', [ 'bar' ], null ]
54 public static function provideConstructorParams() {
81 [ Message
::rawParam( 'baz' ) ],
82 [ Message
::rawParam( 'baz' ) ],
85 [ Message
::rawParam( 'baz' ), 'foo' ],
86 [ Message
::rawParam( 'baz' ), 'foo' ],
89 [ Message
::rawParam( 'baz' ) ],
90 [ [ Message
::rawParam( 'baz' ) ] ],
93 [ Message
::rawParam( 'baz' ), 'foo' ],
94 [ [ Message
::rawParam( 'baz' ), 'foo' ] ],
97 // Test handling of erroneous input, to detect if it changes
99 [ [ 'baz', 'foo' ], 'hhh' ],
100 [ [ 'baz', 'foo' ], 'hhh' ],
103 [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
104 [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
107 [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
108 [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
111 [ [ 'baz' ], [ 'ahahahahha' ] ],
112 [ [ 'baz' ], [ 'ahahahahha' ] ],
118 * @covers Message::__construct
119 * @covers Message::getParams
120 * @dataProvider provideConstructorParams
122 public function testConstructorParams( $expected, $args ) {
123 $msg = new Message( 'imasomething' );
125 $returned = call_user_func_array( [ $msg, 'params' ], $args );
127 $this->assertSame( $msg, $returned );
128 $this->assertSame( $expected, $msg->getParams() );
131 public static function provideConstructorLanguage() {
133 [ 'foo', [ 'bar' ], 'en' ],
134 [ 'foo', [ 'bar' ], 'de' ]
139 * @covers Message::__construct
140 * @covers Message::getLanguage
141 * @dataProvider provideConstructorLanguage
143 public function testConstructorLanguage( $key, $params, $languageCode ) {
144 $language = Language
::factory( $languageCode );
145 $message = new Message( $key, $params, $language );
147 $this->assertEquals( $language, $message->getLanguage() );
150 public static function provideKeys() {
154 'expected' => [ 'mainpage' ],
157 'key' => [ 'mainpage' ],
158 'expected' => [ 'mainpage' ],
161 'key' => [ 'mainpage-foo', 'mainpage-bar', 'mainpage' ],
162 'expected' => [ 'mainpage-foo', 'mainpage-bar', 'mainpage' ],
167 'exception' => 'InvalidArgumentException',
172 'exception' => 'InvalidArgumentException',
177 'exception' => 'InvalidArgumentException',
183 * @covers Message::__construct
184 * @covers Message::getKey
185 * @covers Message::isMultiKey
186 * @covers Message::getKeysToTry
187 * @dataProvider provideKeys
189 public function testKeys( $key, $expected, $exception = null ) {
191 $this->setExpectedException( $exception );
194 $msg = new Message( $key );
195 $this->assertContains( $msg->getKey(), $expected );
196 $this->assertSame( $expected, $msg->getKeysToTry() );
197 $this->assertSame( count( $expected ) > 1, $msg->isMultiKey() );
201 * @covers ::wfMessage
203 public function testWfMessage() {
204 $this->assertInstanceOf( Message
::class, wfMessage( 'mainpage' ) );
205 $this->assertInstanceOf( Message
::class, wfMessage( 'i-dont-exist-evar' ) );
209 * @covers Message::newFromKey
211 public function testNewFromKey() {
212 $this->assertInstanceOf( Message
::class, Message
::newFromKey( 'mainpage' ) );
213 $this->assertInstanceOf( Message
::class, Message
::newFromKey( 'i-dont-exist-evar' ) );
217 * @covers ::wfMessage
218 * @covers Message::__construct
220 public function testWfMessageParams() {
221 $this->assertSame( 'Return to $1.', wfMessage( 'returnto' )->text() );
222 $this->assertSame( 'Return to $1.', wfMessage( 'returnto', [] )->text() );
225 wfMessage( 'returnto', Message
::numParam( 1024 ) )->text()
229 wfMessage( 'returnto', [ Message
::numParam( 1024 ) ] )->text()
232 'You have foo (bar).',
233 wfMessage( 'youhavenewmessages', 'foo', 'bar' )->text()
236 'You have foo (bar).',
237 wfMessage( 'youhavenewmessages', [ 'foo', 'bar' ] )->text()
240 'You have 1,024 (bar).',
242 'youhavenewmessages',
243 Message
::numParam( 1024 ), 'bar'
247 'You have foo (2,048).',
249 'youhavenewmessages',
250 'foo', Message
::numParam( 2048 )
254 'You have 1,024 (2,048).',
256 'youhavenewmessages',
257 [ Message
::numParam( 1024 ), Message
::numParam( 2048 ) ]
263 * @covers Message::exists
265 public function testExists() {
266 $this->assertTrue( wfMessage( 'mainpage' )->exists() );
267 $this->assertTrue( wfMessage( 'mainpage' )->params( [] )->exists() );
268 $this->assertTrue( wfMessage( 'mainpage' )->rawParams( 'foo', 123 )->exists() );
269 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->exists() );
270 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->params( [] )->exists() );
271 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->rawParams( 'foo', 123 )->exists() );
275 * @covers Message::__construct
276 * @covers Message::text
277 * @covers Message::plain
278 * @covers Message::escaped
279 * @covers Message::toString
281 public function testToStringKey() {
282 $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->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' )->text() );
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' )->plain() );
287 $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->escaped() );
289 '⧼i<dont>exist-evar⧽',
290 wfMessage( 'i<dont>exist-evar' )->escaped()
294 public static function provideToString() {
296 // key, transformation, transformed, transformed implicitly
297 [ 'mainpage', 'plain', 'Main Page', 'Main Page' ],
298 [ 'i-dont-exist-evar', 'plain', '⧼i-dont-exist-evar⧽', '⧼i-dont-exist-evar⧽' ],
299 [ 'i-dont-exist-evar', 'escaped', '⧼i-dont-exist-evar⧽', '⧼i-dont-exist-evar⧽' ],
300 [ 'script>alert(1)</script', 'escaped', '⧼script>alert(1)</script⧽',
301 '⧼script>alert(1)</script⧽' ],
302 [ 'script>alert(1)</script', 'plain', '⧼script>alert(1)</script⧽',
303 '⧼script>alert(1)</script⧽' ],
308 * @covers Message::toString
309 * @covers Message::__toString
310 * @dataProvider provideToString
312 public function testToString( $key, $format, $expect, $expectImplicit ) {
313 $msg = new Message( $key );
314 $this->assertSame( $expect, $msg->$format() );
315 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' );
316 $this->assertSame( $expectImplicit, $msg->__toString() );
317 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' );
320 public static function provideToString_raw() {
322 [ '<span>foo</span>', 'parse', '<span>foo</span>', '<span>foo</span>' ],
323 [ '<span>foo</span>', 'escaped', '<span>foo</span>',
324 '<span>foo</span>' ],
325 [ '<span>foo</span>', 'plain', '<span>foo</span>', '<span>foo</span>' ],
326 [ '<script>alert(1)</script>', 'parse', '<script>alert(1)</script>',
327 '<script>alert(1)</script>' ],
328 [ '<script>alert(1)</script>', 'escaped', '<script>alert(1)</script>',
329 '<script>alert(1)</script>' ],
330 [ '<script>alert(1)</script>', 'plain', '<script>alert(1)</script>',
331 '<script>alert(1)</script>' ],
336 * @covers Message::toString
337 * @covers Message::__toString
338 * @dataProvider provideToString_raw
340 public function testToString_raw( $message, $format, $expect, $expectImplicit ) {
341 // make the message behave like RawMessage and use the key as-is
342 $msg = $this->getMockBuilder( Message
::class )->setMethods( [ 'fetchMessage' ] )
343 ->disableOriginalConstructor()
345 $msg->expects( $this->any() )->method( 'fetchMessage' )->willReturn( $message );
346 /** @var Message $msg */
347 $this->assertSame( $expect, $msg->$format() );
348 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' );
349 $this->assertSame( $expectImplicit, $msg->__toString() );
350 $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' );
354 * @covers Message::inLanguage
356 public function testInLanguage() {
357 $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() );
358 $this->assertSame( 'Заглавная страница',
359 wfMessage( 'mainpage' )->inLanguage( 'ru' )->text() );
361 // NOTE: make sure internal caching of the message text is reset appropriately
362 $msg = wfMessage( 'mainpage' );
363 $this->assertSame( 'Main Page', $msg->inLanguage( Language
::factory( 'en' ) )->text() );
365 'Заглавная страница',
366 $msg->inLanguage( Language
::factory( 'ru' ) )->text()
371 * @covers Message::rawParam
372 * @covers Message::rawParams
374 public function testRawParams() {
376 '(Заглавная страница)',
377 wfMessage( 'parentheses', 'Заглавная страница' )->plain()
380 '(Заглавная страница $1)',
381 wfMessage( 'parentheses', 'Заглавная страница $1' )->plain()
384 '(Заглавная страница)',
385 wfMessage( 'parentheses' )->rawParams( 'Заглавная страница' )->plain()
388 '(Заглавная страница $1)',
389 wfMessage( 'parentheses' )->rawParams( 'Заглавная страница $1' )->plain()
394 * @covers RawMessage::__construct
395 * @covers RawMessage::fetchMessage
397 public function testRawMessage() {
398 $msg = new RawMessage( 'example &' );
399 $this->assertSame( 'example &', $msg->plain() );
400 $this->assertSame( 'example &', $msg->escaped() );
403 public function testRawHtmlInMsg() {
404 $this->setMwGlobals( 'wgRawHtml', true );
405 // We have to reset the core hook registration.
406 // to register the html hook
407 MessageCache
::destroyInstance();
408 $this->setMwGlobals( 'wgParser',
409 MediaWikiServices
::getInstance()->getParserFactory()->create() );
411 $msg = new RawMessage( '<html><script>alert("xss")</script></html>' );
412 $txt = '<span class="error"><html> tags cannot be' .
413 ' used outside of normal pages.</span>';
414 $this->assertSame( $txt, $msg->parse() );
418 * @covers Message::params
419 * @covers Message::toString
420 * @covers Message::replaceParameters
422 public function testReplaceManyParams() {
423 $msg = new RawMessage( '$1$2$3$4$5$6$7$8$9$10$11$12' );
424 // One less than above has placeholders
425 $params = [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k' ];
428 $msg->params( $params )->plain(),
429 'Params > 9 are replaced correctly'
432 $msg = new RawMessage( 'Params$*' );
433 $params = [ 'ab', 'bc', 'cd' ];
435 'Params: ab, bc, cd',
436 $msg->params( $params )->text()
441 * @covers Message::numParam
442 * @covers Message::numParams
444 public function testNumParams() {
445 $lang = Language
::factory( 'en' );
446 $msg = new RawMessage( '$1' );
449 $lang->formatNum( 123456.789 ),
450 $msg->inLanguage( $lang )->numParams( 123456.789 )->plain(),
451 'numParams is handled correctly'
456 * @covers Message::durationParam
457 * @covers Message::durationParams
459 public function testDurationParams() {
460 $lang = Language
::factory( 'en' );
461 $msg = new RawMessage( '$1' );
464 $lang->formatDuration( 1234 ),
465 $msg->inLanguage( $lang )->durationParams( 1234 )->plain(),
466 'durationParams is handled correctly'
471 * FIXME: This should not need database, but Language#formatExpiry does (T57912)
472 * @covers Message::expiryParam
473 * @covers Message::expiryParams
475 public function testExpiryParams() {
476 $lang = Language
::factory( 'en' );
477 $msg = new RawMessage( '$1' );
480 $lang->formatExpiry( wfTimestampNow() ),
481 $msg->inLanguage( $lang )->expiryParams( wfTimestampNow() )->plain(),
482 'expiryParams is handled correctly'
487 * @covers Message::timeperiodParam
488 * @covers Message::timeperiodParams
490 public function testTimeperiodParams() {
491 $lang = Language
::factory( 'en' );
492 $msg = new RawMessage( '$1' );
495 $lang->formatTimePeriod( 1234 ),
496 $msg->inLanguage( $lang )->timeperiodParams( 1234 )->plain(),
497 'timeperiodParams is handled correctly'
502 * @covers Message::sizeParam
503 * @covers Message::sizeParams
505 public function testSizeParams() {
506 $lang = Language
::factory( 'en' );
507 $msg = new RawMessage( '$1' );
510 $lang->formatSize( 123456 ),
511 $msg->inLanguage( $lang )->sizeParams( 123456 )->plain(),
512 'sizeParams is handled correctly'
517 * @covers Message::bitrateParam
518 * @covers Message::bitrateParams
520 public function testBitrateParams() {
521 $lang = Language
::factory( 'en' );
522 $msg = new RawMessage( '$1' );
525 $lang->formatBitrate( 123456 ),
526 $msg->inLanguage( $lang )->bitrateParams( 123456 )->plain(),
527 'bitrateParams is handled correctly'
531 public static function providePlaintextParams() {
534 'one $2 <div>foo</div> [[Bar]] {{Baz}} <',
540 'one $2 <div>foo</div> [[Bar]] {{Baz}} <',
545 'one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;',
550 'one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;',
555 "<p>one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;\n</p>",
562 * @covers Message::plaintextParam
563 * @covers Message::plaintextParams
564 * @covers Message::formatPlaintext
565 * @covers Message::toString
566 * @covers Message::parse
567 * @covers Message::parseAsBlock
568 * @dataProvider providePlaintextParams
570 public function testPlaintextParams( $expect, $format ) {
571 $lang = Language
::factory( 'en' );
573 $msg = new RawMessage( '$1 $2' );
576 '<div>foo</div> [[Bar]] {{Baz}} <',
580 $msg->inLanguage( $lang )->plaintextParams( $params )->$format(),
581 "Fail formatting for $format"
585 public static function provideListParam() {
586 $lang = Language
::factory( 'de' );
587 $msg1 = new Message( 'mainpage', [], $lang );
588 $msg2 = new RawMessage( "''link''", [], $lang );
591 'Simple comma list' => [
598 'Simple semicolon list' => [
605 'Simple pipe list' => [
612 'Simple text list' => [
626 'List with all "before" params, ->text()' => [
627 [ "''link''", Message
::numParam( 12345678 ) ],
630 '\'\'link\'\'; 12,345,678'
633 'List with all "before" params, ->parse()' => [
634 [ "''link''", Message
::numParam( 12345678 ) ],
637 '<i>link</i>; 12,345,678'
640 'List with all "after" params, ->text()' => [
641 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ) ],
644 'Main Page; \'\'link\'\'; [[foo]]'
647 'List with all "after" params, ->parse()' => [
648 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ) ],
651 'Main Page; <i>link</i>; [[foo]]'
654 'List with both "before" and "after" params, ->text()' => [
655 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ), "''link''", Message
::numParam( 12345678 ) ],
658 'Main Page; \'\'link\'\'; [[foo]]; \'\'link\'\'; 12,345,678'
661 'List with both "before" and "after" params, ->parse()' => [
662 [ $msg1, $msg2, Message
::rawParam( '[[foo]]' ), "''link''", Message
::numParam( 12345678 ) ],
665 'Main Page; <i>link</i>; [[foo]]; <i>link</i>; 12,345,678'
671 * @covers Message::listParam
672 * @covers Message::extractParam
673 * @covers Message::formatListParam
674 * @dataProvider provideListParam
676 public function testListParam( $list, $type, $format, $expect ) {
677 $lang = Language
::factory( 'en' );
679 $msg = new RawMessage( '$1' );
680 $msg->params( [ Message
::listParam( $list, $type ) ] );
683 $msg->inLanguage( $lang )->$format()
688 * @covers Message::extractParam
690 public function testMessageAsParam() {
691 $this->setMwGlobals( [
692 'wgScript' => '/wiki/index.php',
693 'wgArticlePath' => '/wiki/$1',
696 $msg = new Message( 'returnto', [
697 new Message( 'apihelp-link', [
698 'foo', new Message( 'mainpage', [], Language
::factory( 'en' ) )
699 ], Language
::factory( 'de' ) )
700 ], Language
::factory( 'es' ) );
703 'Volver a [[Special:ApiHelp/foo|Página principal]].',
705 'Process with ->text()'
708 '<p>Volver a <a href="/wiki/Special:ApiHelp/foo" title="Special:ApiHelp/foo">Página '
709 . "principal</a>.\n</p>",
710 $msg->parseAsBlock(),
711 'Process with ->parseAsBlock()'
715 public static function provideParser() {
718 "''&'' <x><!-- x -->",
723 "''&'' <x><!-- x -->",
727 '<i>&</i> <x>',
732 "<p><i>&</i> <x>\n</p>",
739 * @covers Message::text
740 * @covers Message::parse
741 * @covers Message::parseAsBlock
742 * @covers Message::toString
743 * @covers Message::transformText
744 * @covers Message::parseText
745 * @dataProvider provideParser
747 public function testParser( $expect, $format ) {
748 $msg = new RawMessage( "''&'' <x><!-- x -->" );
751 $msg->inLanguage( 'en' )->$format()
756 * @covers Message::inContentLanguage
758 public function testInContentLanguage() {
759 $this->setUserLang( 'fr' );
761 // NOTE: make sure internal caching of the message text is reset appropriately
762 $msg = wfMessage( 'mainpage' );
763 $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
764 $this->assertSame( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" );
765 $this->assertSame( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" );
769 * @covers Message::inContentLanguage
771 public function testInContentLanguageOverride() {
772 $this->setMwGlobals( [
773 'wgForceUIMsgAsContentMsg' => [ 'mainpage' ],
775 $this->setUserLang( 'fr' );
777 // NOTE: make sure internal caching of the message text is reset appropriately.
778 // NOTE: wgForceUIMsgAsContentMsg forces the messages *current* language to be used.
779 $msg = wfMessage( 'mainpage' );
782 $msg->inContentLanguage()->plain(),
783 'inContentLanguage() with ForceUIMsg override enabled'
785 $this->assertSame( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" );
788 $msg->inContentLanguage()->plain(),
789 'inContentLanguage() with ForceUIMsg override enabled'
791 $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
795 * @expectedException MWException
796 * @covers Message::inLanguage
798 public function testInLanguageThrows() {
799 wfMessage( 'foo' )->inLanguage( 123 );
803 * @covers Message::serialize
804 * @covers Message::unserialize
806 public function testSerialization() {
807 $msg = new Message( 'parentheses' );
808 $msg->rawParams( '<a>foo</a>' );
809 $msg->title( Title
::newFromText( 'Testing' ) );
810 $this->assertSame( '(<a>foo</a>)', $msg->parse(), 'Sanity check' );
811 $msg = unserialize( serialize( $msg ) );
812 $this->assertSame( '(<a>foo</a>)', $msg->parse() );
813 $title = TestingAccessWrapper
::newFromObject( $msg )->title
;
814 $this->assertInstanceOf( Title
::class, $title );
815 $this->assertSame( 'Testing', $title->getFullText() );
817 $msg = new Message( 'mainpage' );
818 $msg->inLanguage( 'de' );
819 $this->assertSame( 'Hauptseite', $msg->plain(), 'Sanity check' );
820 $msg = unserialize( serialize( $msg ) );
821 $this->assertSame( 'Hauptseite', $msg->plain() );
825 * @covers Message::newFromSpecifier
826 * @dataProvider provideNewFromSpecifier
828 public function testNewFromSpecifier( $value, $expectedText ) {
829 $message = Message
::newFromSpecifier( $value );
830 $this->assertInstanceOf( Message
::class, $message );
831 if ( $value instanceof Message
) {
832 $this->assertInstanceOf( get_class( $value ), $message );
833 $this->assertEquals( $value, $message );
835 $this->assertSame( $expectedText, $message->text() );
838 public function provideNewFromSpecifier() {
839 $messageSpecifier = $this->getMockForAbstractClass( MessageSpecifier
::class );
840 $messageSpecifier->expects( $this->any() )->method( 'getKey' )->willReturn( 'mainpage' );
841 $messageSpecifier->expects( $this->any() )->method( 'getParams' )->willReturn( [] );
844 'string' => [ 'mainpage', 'Main Page' ],
845 'array' => [ [ 'youhavenewmessages', 'foo', 'bar' ], 'You have foo (bar).' ],
846 'Message' => [ new Message( 'youhavenewmessages', [ 'foo', 'bar' ] ), 'You have foo (bar).' ],
847 'RawMessage' => [ new RawMessage( 'foo ($1)', [ 'bar' ] ), 'foo (bar)' ],
848 'ApiMessage' => [ new ApiMessage( [ 'mainpage' ], 'code', [ 'data' ] ), 'Main Page' ],
849 'MessageSpecifier' => [ $messageSpecifier, 'Main Page' ],
850 'nested RawMessage' => [ [ new RawMessage( 'foo ($1)', [ 'bar' ] ) ], 'foo (bar)' ],