Deprecate Message::$format (mostly)
[lhc/web/wiklou.git] / tests / phpunit / includes / MessageTest.php
1 <?php
2
3 class MessageTest extends MediaWikiLangTestCase {
4
5 protected function setUp() {
6 parent::setUp();
7
8 $this->setMwGlobals( [
9 'wgForceUIMsgAsContentMsg' => [],
10 ] );
11 $this->setUserLang( 'en' );
12 }
13
14 /**
15 * @covers Message::__construct
16 * @dataProvider provideConstructor
17 */
18 public function testConstructor( $expectedLang, $key, $params, $language ) {
19 $message = new Message( $key, $params, $language );
20
21 $this->assertEquals( $key, $message->getKey() );
22 $this->assertEquals( $params, $message->getParams() );
23 $this->assertEquals( $expectedLang, $message->getLanguage() );
24
25 $messageSpecifier = $this->getMockForAbstractClass( 'MessageSpecifier' );
26 $messageSpecifier->expects( $this->any() )
27 ->method( 'getKey' )->will( $this->returnValue( $key ) );
28 $messageSpecifier->expects( $this->any() )
29 ->method( 'getParams' )->will( $this->returnValue( $params ) );
30 $message = new Message( $messageSpecifier, [], $language );
31
32 $this->assertEquals( $key, $message->getKey() );
33 $this->assertEquals( $params, $message->getParams() );
34 $this->assertEquals( $expectedLang, $message->getLanguage() );
35 }
36
37 public static function provideConstructor() {
38 $langDe = Language::factory( 'de' );
39 $langEn = Language::factory( 'en' );
40
41 return [
42 [ $langDe, 'foo', [], $langDe ],
43 [ $langDe, 'foo', [ 'bar' ], $langDe ],
44 [ $langEn, 'foo', [ 'bar' ], null ]
45 ];
46 }
47
48 public static function provideConstructorParams() {
49 return [
50 [
51 [],
52 [],
53 ],
54 [
55 [ 'foo' ],
56 [ 'foo' ],
57 ],
58 [
59 [ 'foo', 'bar' ],
60 [ 'foo', 'bar' ],
61 ],
62 [
63 [ 'baz' ],
64 [ [ 'baz' ] ],
65 ],
66 [
67 [ 'baz', 'foo' ],
68 [ [ 'baz', 'foo' ] ],
69 ],
70 [
71 [ 'baz', 'foo' ],
72 [ [ 'baz', 'foo' ], 'hhh' ],
73 ],
74 [
75 [ 'baz', 'foo' ],
76 [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
77 ],
78 [
79 [ 'baz', 'foo' ],
80 [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
81 ],
82 [
83 [ 'baz' ],
84 [ [ 'baz' ], [ 'ahahahahha' ] ],
85 ],
86 ];
87 }
88
89 /**
90 * @covers Message::__construct
91 * @covers Message::getParams
92 * @dataProvider provideConstructorParams
93 */
94 public function testConstructorParams( $expected, $args ) {
95 $msg = new Message( 'imasomething' );
96
97 $returned = call_user_func_array( [ $msg, 'params' ], $args );
98
99 $this->assertSame( $msg, $returned );
100 $this->assertEquals( $expected, $msg->getParams() );
101 }
102
103 public static function provideConstructorLanguage() {
104 return [
105 [ 'foo', [ 'bar' ], 'en' ],
106 [ 'foo', [ 'bar' ], 'de' ]
107 ];
108 }
109
110 /**
111 * @covers Message::__construct
112 * @covers Message::getLanguage
113 * @dataProvider provideConstructorLanguage
114 */
115 public function testConstructorLanguage( $key, $params, $languageCode ) {
116 $language = Language::factory( $languageCode );
117 $message = new Message( $key, $params, $language );
118
119 $this->assertEquals( $language, $message->getLanguage() );
120 }
121
122 public static function provideKeys() {
123 return [
124 'string' => [
125 'key' => 'mainpage',
126 'expected' => [ 'mainpage' ],
127 ],
128 'single' => [
129 'key' => [ 'mainpage' ],
130 'expected' => [ 'mainpage' ],
131 ],
132 'multi' => [
133 'key' => [ 'mainpage-foo', 'mainpage-bar', 'mainpage' ],
134 'expected' => [ 'mainpage-foo', 'mainpage-bar', 'mainpage' ],
135 ],
136 'empty' => [
137 'key' => [],
138 'expected' => null,
139 'exception' => 'InvalidArgumentException',
140 ],
141 'null' => [
142 'key' => null,
143 'expected' => null,
144 'exception' => 'InvalidArgumentException',
145 ],
146 'bad type' => [
147 'key' => 123,
148 'expected' => null,
149 'exception' => 'InvalidArgumentException',
150 ],
151 ];
152 }
153
154 /**
155 * @covers Message::__construct
156 * @covers Message::getKey
157 * @covers Message::isMultiKey
158 * @covers Message::getKeysToTry
159 * @dataProvider provideKeys
160 */
161 public function testKeys( $key, $expected, $exception = null ) {
162 if ( $exception ) {
163 $this->setExpectedException( $exception );
164 }
165
166 $msg = new Message( $key );
167 $this->assertContains( $msg->getKey(), $expected );
168 $this->assertEquals( $expected, $msg->getKeysToTry() );
169 $this->assertEquals( count( $expected ) > 1, $msg->isMultiKey() );
170 }
171
172 /**
173 * @covers ::wfMessage
174 */
175 public function testWfMessage() {
176 $this->assertInstanceOf( 'Message', wfMessage( 'mainpage' ) );
177 $this->assertInstanceOf( 'Message', wfMessage( 'i-dont-exist-evar' ) );
178 }
179
180 /**
181 * @covers Message::newFromKey
182 */
183 public function testNewFromKey() {
184 $this->assertInstanceOf( 'Message', Message::newFromKey( 'mainpage' ) );
185 $this->assertInstanceOf( 'Message', Message::newFromKey( 'i-dont-exist-evar' ) );
186 }
187
188 /**
189 * @covers ::wfMessage
190 * @covers Message::__construct
191 */
192 public function testWfMessageParams() {
193 $this->assertEquals( 'Return to $1.', wfMessage( 'returnto' )->text() );
194 $this->assertEquals( 'Return to $1.', wfMessage( 'returnto', [] )->text() );
195 $this->assertEquals(
196 'You have foo (bar).',
197 wfMessage( 'youhavenewmessages', 'foo', 'bar' )->text()
198 );
199 $this->assertEquals(
200 'You have foo (bar).',
201 wfMessage( 'youhavenewmessages', [ 'foo', 'bar' ] )->text()
202 );
203 }
204
205 /**
206 * @covers Message::exists
207 */
208 public function testExists() {
209 $this->assertTrue( wfMessage( 'mainpage' )->exists() );
210 $this->assertTrue( wfMessage( 'mainpage' )->params( [] )->exists() );
211 $this->assertTrue( wfMessage( 'mainpage' )->rawParams( 'foo', 123 )->exists() );
212 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->exists() );
213 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->params( [] )->exists() );
214 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->rawParams( 'foo', 123 )->exists() );
215 }
216
217 /**
218 * @covers Message::__construct
219 * @covers Message::text
220 * @covers Message::plain
221 * @covers Message::escaped
222 * @covers Message::toString
223 */
224 public function testToStringKey() {
225 $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->text() );
226 $this->assertEquals( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->text() );
227 $this->assertEquals( '⧼i&lt;dont&gt;exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->text() );
228 $this->assertEquals( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->plain() );
229 $this->assertEquals( '⧼i&lt;dont&gt;exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->plain() );
230 $this->assertEquals( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->escaped() );
231 $this->assertEquals(
232 '⧼i&lt;dont&gt;exist-evar⧽',
233 wfMessage( 'i<dont>exist-evar' )->escaped()
234 );
235 }
236
237 public static function provideToString() {
238 return [
239 // key, transformation, transformed, transformed implicitly
240 [ 'mainpage', 'plain', 'Main Page', 'Main Page' ],
241 [ 'i-dont-exist-evar', 'plain', '⧼i-dont-exist-evar⧽', '⧼i-dont-exist-evar⧽' ],
242 [ 'i-dont-exist-evar', 'escaped', '⧼i-dont-exist-evar⧽', '⧼i-dont-exist-evar⧽' ],
243 [ 'script>alert(1)</script', 'escaped', '⧼script&gt;alert(1)&lt;/script⧽',
244 '⧼script&gt;alert(1)&lt;/script⧽' ],
245 [ 'script>alert(1)</script', 'plain', '⧼script&gt;alert(1)&lt;/script⧽',
246 '⧼script&gt;alert(1)&lt;/script⧽' ],
247 ];
248 }
249
250 /**
251 * @covers Message::toString
252 * @covers Message::__toString
253 * @dataProvider provideToString
254 */
255 public function testToString( $key, $format, $expect, $expectImplicit ) {
256 $msg = new Message( $key );
257 $this->assertEquals( $expect, $msg->$format() );
258 $this->assertEquals( $expect, $msg->toString() );
259 $this->assertEquals( $expectImplicit, $msg->__toString() );
260 $this->assertEquals( $expect, $msg->toString() );
261 }
262
263 public static function provideToString_raw() {
264 return [
265 [ '<span>foo</span>', 'parse', '<span>foo</span>', '<span>foo</span>' ],
266 [ '<span>foo</span>', 'escaped', '&lt;span&gt;foo&lt;/span&gt;',
267 '<span>foo</span>' ],
268 [ '<span>foo</span>', 'plain', '<span>foo</span>', '<span>foo</span>' ],
269 [ '<script>alert(1)</script>', 'parse', '&lt;script&gt;alert(1)&lt;/script&gt;',
270 '&lt;script&gt;alert(1)&lt;/script&gt;' ],
271 [ '<script>alert(1)</script>', 'escaped', '&lt;script&gt;alert(1)&lt;/script&gt;',
272 '&lt;script&gt;alert(1)&lt;/script&gt;' ],
273 [ '<script>alert(1)</script>', 'plain', '<script>alert(1)</script>',
274 '&lt;script&gt;alert(1)&lt;/script&gt;' ],
275 ];
276 }
277
278 /**
279 * @covers Message::toString
280 * @covers Message::__toString
281 * @dataProvider provideToString_raw
282 */
283 public function testToString_raw( $key, $format, $expect, $expectImplicit ) {
284 // make the message behave like RawMessage and use the key as-is
285 $msg = $this->getMockBuilder( Message::class )->setMethods( [ 'fetchMessage' ] )
286 ->setConstructorArgs( [ $key ] )
287 ->getMock();
288 $msg->expects( $this->any() )->method( 'fetchMessage' )->willReturn( $key );
289 /** @var Message $msg */
290 $this->assertEquals( $expect, $msg->$format() );
291 $this->assertEquals( $expect, $msg->toString() );
292 $this->assertEquals( $expectImplicit, $msg->__toString() );
293 $this->assertEquals( $expect, $msg->toString() );
294 }
295
296 /**
297 * @covers Message::inLanguage
298 */
299 public function testInLanguage() {
300 $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() );
301 $this->assertEquals( 'Заглавная страница',
302 wfMessage( 'mainpage' )->inLanguage( 'ru' )->text() );
303
304 // NOTE: make sure internal caching of the message text is reset appropriately
305 $msg = wfMessage( 'mainpage' );
306 $this->assertEquals( 'Main Page', $msg->inLanguage( Language::factory( 'en' ) )->text() );
307 $this->assertEquals(
308 'Заглавная страница',
309 $msg->inLanguage( Language::factory( 'ru' ) )->text()
310 );
311 }
312
313 /**
314 * @covers Message::rawParam
315 * @covers Message::rawParams
316 */
317 public function testRawParams() {
318 $this->assertEquals(
319 '(Заглавная страница)',
320 wfMessage( 'parentheses', 'Заглавная страница' )->plain()
321 );
322 $this->assertEquals(
323 '(Заглавная страница $1)',
324 wfMessage( 'parentheses', 'Заглавная страница $1' )->plain()
325 );
326 $this->assertEquals(
327 '(Заглавная страница)',
328 wfMessage( 'parentheses' )->rawParams( 'Заглавная страница' )->plain()
329 );
330 $this->assertEquals(
331 '(Заглавная страница $1)',
332 wfMessage( 'parentheses' )->rawParams( 'Заглавная страница $1' )->plain()
333 );
334 }
335
336 /**
337 * @covers RawMessage::__construct
338 * @covers RawMessage::fetchMessage
339 */
340 public function testRawMessage() {
341 $msg = new RawMessage( 'example &' );
342 $this->assertEquals( 'example &', $msg->plain() );
343 $this->assertEquals( 'example &amp;', $msg->escaped() );
344 }
345
346 /**
347 * @covers Message::params
348 * @covers Message::toString
349 * @covers Message::replaceParameters
350 */
351 public function testReplaceManyParams() {
352 $msg = new RawMessage( '$1$2$3$4$5$6$7$8$9$10$11$12' );
353 // One less than above has placeholders
354 $params = [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k' ];
355 $this->assertEquals(
356 'abcdefghijka2',
357 $msg->params( $params )->plain(),
358 'Params > 9 are replaced correctly'
359 );
360
361 $msg = new RawMessage( 'Params$*' );
362 $params = [ 'ab', 'bc', 'cd' ];
363 $this->assertEquals(
364 'Params: ab, bc, cd',
365 $msg->params( $params )->text()
366 );
367 }
368
369 /**
370 * @covers Message::numParam
371 * @covers Message::numParams
372 */
373 public function testNumParams() {
374 $lang = Language::factory( 'en' );
375 $msg = new RawMessage( '$1' );
376
377 $this->assertEquals(
378 $lang->formatNum( 123456.789 ),
379 $msg->inLanguage( $lang )->numParams( 123456.789 )->plain(),
380 'numParams is handled correctly'
381 );
382 }
383
384 /**
385 * @covers Message::durationParam
386 * @covers Message::durationParams
387 */
388 public function testDurationParams() {
389 $lang = Language::factory( 'en' );
390 $msg = new RawMessage( '$1' );
391
392 $this->assertEquals(
393 $lang->formatDuration( 1234 ),
394 $msg->inLanguage( $lang )->durationParams( 1234 )->plain(),
395 'durationParams is handled correctly'
396 );
397 }
398
399 /**
400 * FIXME: This should not need database, but Language#formatExpiry does (bug 55912)
401 * @group Database
402 * @covers Message::expiryParam
403 * @covers Message::expiryParams
404 */
405 public function testExpiryParams() {
406 $lang = Language::factory( 'en' );
407 $msg = new RawMessage( '$1' );
408
409 $this->assertEquals(
410 $lang->formatExpiry( wfTimestampNow() ),
411 $msg->inLanguage( $lang )->expiryParams( wfTimestampNow() )->plain(),
412 'expiryParams is handled correctly'
413 );
414 }
415
416 /**
417 * @covers Message::timeperiodParam
418 * @covers Message::timeperiodParams
419 */
420 public function testTimeperiodParams() {
421 $lang = Language::factory( 'en' );
422 $msg = new RawMessage( '$1' );
423
424 $this->assertEquals(
425 $lang->formatTimePeriod( 1234 ),
426 $msg->inLanguage( $lang )->timeperiodParams( 1234 )->plain(),
427 'timeperiodParams is handled correctly'
428 );
429 }
430
431 /**
432 * @covers Message::sizeParam
433 * @covers Message::sizeParams
434 */
435 public function testSizeParams() {
436 $lang = Language::factory( 'en' );
437 $msg = new RawMessage( '$1' );
438
439 $this->assertEquals(
440 $lang->formatSize( 123456 ),
441 $msg->inLanguage( $lang )->sizeParams( 123456 )->plain(),
442 'sizeParams is handled correctly'
443 );
444 }
445
446 /**
447 * @covers Message::bitrateParam
448 * @covers Message::bitrateParams
449 */
450 public function testBitrateParams() {
451 $lang = Language::factory( 'en' );
452 $msg = new RawMessage( '$1' );
453
454 $this->assertEquals(
455 $lang->formatBitrate( 123456 ),
456 $msg->inLanguage( $lang )->bitrateParams( 123456 )->plain(),
457 'bitrateParams is handled correctly'
458 );
459 }
460
461 public static function providePlaintextParams() {
462 return [
463 [
464 'one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;',
465 'plain',
466 ],
467
468 [
469 // expect
470 'one $2 <div>foo</div> [[Bar]] {{Baz}} &lt;',
471 // format
472 'text',
473 ],
474 [
475 'one $2 &lt;div&gt;foo&lt;/div&gt; [[Bar]] {{Baz}} &amp;lt;',
476 'escaped',
477 ],
478
479 [
480 'one $2 &lt;div&gt;foo&lt;/div&gt; [[Bar]] {{Baz}} &amp;lt;',
481 'parse',
482 ],
483
484 [
485 "<p>one $2 &lt;div&gt;foo&lt;/div&gt; [[Bar]] {{Baz}} &amp;lt;\n</p>",
486 'parseAsBlock',
487 ],
488 ];
489 }
490
491 /**
492 * @covers Message::plaintextParam
493 * @covers Message::plaintextParams
494 * @covers Message::formatPlaintext
495 * @covers Message::toString
496 * @covers Message::parse
497 * @covers Message::parseAsBlock
498 * @dataProvider providePlaintextParams
499 */
500 public function testPlaintextParams( $expect, $format ) {
501 $lang = Language::factory( 'en' );
502
503 $msg = new RawMessage( '$1 $2' );
504 $params = [
505 'one $2',
506 '<div>foo</div> [[Bar]] {{Baz}} &lt;',
507 ];
508 $this->assertEquals(
509 $expect,
510 $msg->inLanguage( $lang )->plaintextParams( $params )->$format(),
511 "Fail formatting for $format"
512 );
513 }
514
515 public static function provideParser() {
516 return [
517 [
518 "''&'' <x><!-- x -->",
519 'plain',
520 ],
521
522 [
523 "''&'' <x><!-- x -->",
524 'text',
525 ],
526 [
527 '<i>&amp;</i> &lt;x&gt;',
528 'parse',
529 ],
530
531 [
532 "<p><i>&amp;</i> &lt;x&gt;\n</p>",
533 'parseAsBlock',
534 ],
535 ];
536 }
537
538 /**
539 * @covers Message::text
540 * @covers Message::parse
541 * @covers Message::parseAsBlock
542 * @covers Message::toString
543 * @covers Message::transformText
544 * @covers Message::parseText
545 * @dataProvider provideParser
546 */
547 public function testParser( $expect, $format ) {
548 $msg = new RawMessage( "''&'' <x><!-- x -->" );
549 $this->assertEquals(
550 $expect,
551 $msg->inLanguage( 'en' )->$format()
552 );
553 }
554
555 /**
556 * @covers Message::inContentLanguage
557 */
558 public function testInContentLanguage() {
559 $this->setUserLang( 'fr' );
560
561 // NOTE: make sure internal caching of the message text is reset appropriately
562 $msg = wfMessage( 'mainpage' );
563 $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
564 $this->assertEquals( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" );
565 $this->assertEquals( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" );
566 }
567
568 /**
569 * @covers Message::inContentLanguage
570 */
571 public function testInContentLanguageOverride() {
572 $this->setMwGlobals( [
573 'wgForceUIMsgAsContentMsg' => [ 'mainpage' ],
574 ] );
575 $this->setUserLang( 'fr' );
576
577 // NOTE: make sure internal caching of the message text is reset appropriately.
578 // NOTE: wgForceUIMsgAsContentMsg forces the messages *current* language to be used.
579 $msg = wfMessage( 'mainpage' );
580 $this->assertEquals(
581 'Accueil',
582 $msg->inContentLanguage()->plain(),
583 'inContentLanguage() with ForceUIMsg override enabled'
584 );
585 $this->assertEquals( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" );
586 $this->assertEquals(
587 'Main Page',
588 $msg->inContentLanguage()->plain(),
589 'inContentLanguage() with ForceUIMsg override enabled'
590 );
591 $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
592 }
593
594 /**
595 * @expectedException MWException
596 * @covers Message::inLanguage
597 */
598 public function testInLanguageThrows() {
599 wfMessage( 'foo' )->inLanguage( 123 );
600 }
601
602 /**
603 * @covers Message::serialize
604 * @covers Message::unserialize
605 */
606 public function testSerialization() {
607 $msg = new Message( 'parentheses' );
608 $msg->rawParams( '<a>foo</a>' );
609 $msg->title( Title::newFromText( 'Testing' ) );
610 $this->assertEquals( '(<a>foo</a>)', $msg->parse(), 'Sanity check' );
611 $msg = unserialize( serialize( $msg ) );
612 $this->assertEquals( '(<a>foo</a>)', $msg->parse() );
613 $title = TestingAccessWrapper::newFromObject( $msg )->title;
614 $this->assertInstanceOf( 'Title', $title );
615 $this->assertEquals( 'Testing', $title->getFullText() );
616
617 $msg = new Message( 'mainpage' );
618 $msg->inLanguage( 'de' );
619 $this->assertEquals( 'Hauptseite', $msg->plain(), 'Sanity check' );
620 $msg = unserialize( serialize( $msg ) );
621 $this->assertEquals( 'Hauptseite', $msg->plain() );
622 }
623
624 /**
625 * @covers Message::newFromSpecifier
626 * @dataProvider provideNewFromSpecifier
627 */
628 public function testNewFromSpecifier( $value, $expectedText ) {
629 $message = Message::newFromSpecifier( $value );
630 $this->assertInstanceOf( Message::class, $message );
631 if ( $value instanceof Message ) {
632 $this->assertInstanceOf( get_class( $value ), $message );
633 $this->assertEquals( $value, $message );
634 }
635 $this->assertSame( $expectedText, $message->text() );
636 }
637
638 public function provideNewFromSpecifier() {
639 $messageSpecifier = $this->getMockForAbstractClass( MessageSpecifier::class );
640 $messageSpecifier->expects( $this->any() )->method( 'getKey' )->willReturn( 'mainpage' );
641 $messageSpecifier->expects( $this->any() )->method( 'getParams' )->willReturn( [] );
642
643 return [
644 'string' => [ 'mainpage', 'Main Page' ],
645 'array' => [ [ 'youhavenewmessages', 'foo', 'bar' ], 'You have foo (bar).' ],
646 'Message' => [ new Message( 'youhavenewmessages', [ 'foo', 'bar' ] ), 'You have foo (bar).' ],
647 'RawMessage' => [ new RawMessage( 'foo ($1)', [ 'bar' ] ), 'foo (bar)' ],
648 'ApiMessage' => [ new ApiMessage( [ 'mainpage' ], 'code', [ 'data' ] ), 'Main Page' ],
649 'MessageSpecifier' => [ $messageSpecifier, 'Main Page' ],
650 'nested RawMessage' => [ [ new RawMessage( 'foo ($1)', [ 'bar' ] ) ], 'foo (bar)' ],
651 ];
652 }
653 }
654