Merge "Support more coupled DBs in AtomicSectionUpdate/AutoCommitUpdate"
[lhc/web/wiklou.git] / tests / phpunit / includes / BlockTest.php
1 <?php
2
3 use MediaWiki\Block\BlockRestriction;
4 use MediaWiki\Block\Restriction\PageRestriction;
5 use MediaWiki\Block\Restriction\NamespaceRestriction;
6
7 /**
8 * @group Database
9 * @group Blocking
10 */
11 class BlockTest extends MediaWikiLangTestCase {
12
13 /**
14 * @return User
15 */
16 private function getUserForBlocking() {
17 $testUser = $this->getMutableTestUser();
18 $user = $testUser->getUser();
19 $user->addToDatabase();
20 TestUser::setPasswordForUser( $user, 'UTBlockeePassword' );
21 $user->saveSettings();
22 return $user;
23 }
24
25 /**
26 * @param User $user
27 *
28 * @return Block
29 * @throws MWException
30 */
31 private function addBlockForUser( User $user ) {
32 // Delete the last round's block if it's still there
33 $oldBlock = Block::newFromTarget( $user->getName() );
34 if ( $oldBlock ) {
35 // An old block will prevent our new one from saving.
36 $oldBlock->delete();
37 }
38
39 $blockOptions = [
40 'address' => $user->getName(),
41 'user' => $user->getId(),
42 'by' => $this->getTestSysop()->getUser()->getId(),
43 'reason' => 'Parce que',
44 'expiry' => time() + 100500,
45 ];
46 $block = new Block( $blockOptions );
47
48 $block->insert();
49 // save up ID for use in assertion. Since ID is an autoincrement,
50 // its value might change depending on the order the tests are run.
51 // ApiBlockTest insert its own blocks!
52 if ( !$block->getId() ) {
53 throw new MWException( "Failed to insert block for BlockTest; old leftover block remaining?" );
54 }
55
56 $this->addXffBlocks();
57
58 return $block;
59 }
60
61 /**
62 * @covers Block::newFromTarget
63 */
64 public function testINewFromTargetReturnsCorrectBlock() {
65 $user = $this->getUserForBlocking();
66 $block = $this->addBlockForUser( $user );
67
68 $this->assertTrue(
69 $block->equals( Block::newFromTarget( $user->getName() ) ),
70 "newFromTarget() returns the same block as the one that was made"
71 );
72 }
73
74 /**
75 * @covers Block::newFromID
76 */
77 public function testINewFromIDReturnsCorrectBlock() {
78 $user = $this->getUserForBlocking();
79 $block = $this->addBlockForUser( $user );
80
81 $this->assertTrue(
82 $block->equals( Block::newFromID( $block->getId() ) ),
83 "newFromID() returns the same block as the one that was made"
84 );
85 }
86
87 /**
88 * per T28425
89 * @covers Block::__construct
90 */
91 public function testT28425BlockTimestampDefaultsToTime() {
92 $user = $this->getUserForBlocking();
93 $block = $this->addBlockForUser( $user );
94 $madeAt = wfTimestamp( TS_MW );
95
96 // delta to stop one-off errors when things happen to go over a second mark.
97 $delta = abs( $madeAt - $block->mTimestamp );
98 $this->assertLessThan(
99 2,
100 $delta,
101 "If no timestamp is specified, the block is recorded as time()"
102 );
103 }
104
105 /**
106 * CheckUser since being changed to use Block::newFromTarget started failing
107 * because the new function didn't accept empty strings like Block::load()
108 * had. Regression T31116.
109 *
110 * @dataProvider provideT31116Data
111 * @covers Block::newFromTarget
112 */
113 public function testT31116NewFromTargetWithEmptyIp( $vagueTarget ) {
114 $user = $this->getUserForBlocking();
115 $initialBlock = $this->addBlockForUser( $user );
116 $block = Block::newFromTarget( $user->getName(), $vagueTarget );
117
118 $this->assertTrue(
119 $initialBlock->equals( $block ),
120 "newFromTarget() returns the same block as the one that was made when "
121 . "given empty vagueTarget param " . var_export( $vagueTarget, true )
122 );
123 }
124
125 public static function provideT31116Data() {
126 return [
127 [ null ],
128 [ '' ],
129 [ false ]
130 ];
131 }
132
133 /**
134 * @covers Block::appliesToRight
135 */
136 public function testBlockedUserCanNotCreateAccount() {
137 $username = 'BlockedUserToCreateAccountWith';
138 $u = User::newFromName( $username );
139 $u->addToDatabase();
140 $userId = $u->getId();
141 $this->assertNotEquals( 0, $userId, 'sanity' );
142 TestUser::setPasswordForUser( $u, 'NotRandomPass' );
143 unset( $u );
144
145 // Sanity check
146 $this->assertNull(
147 Block::newFromTarget( $username ),
148 "$username should not be blocked"
149 );
150
151 // Reload user
152 $u = User::newFromName( $username );
153 $this->assertFalse(
154 $u->isBlockedFromCreateAccount(),
155 "Our sandbox user should be able to create account before being blocked"
156 );
157
158 // Foreign perspective (blockee not on current wiki)...
159 $blockOptions = [
160 'address' => $username,
161 'user' => $userId,
162 'reason' => 'crosswiki block...',
163 'timestamp' => wfTimestampNow(),
164 'expiry' => $this->db->getInfinity(),
165 'createAccount' => true,
166 'enableAutoblock' => true,
167 'hideName' => true,
168 'blockEmail' => true,
169 'byText' => 'm>MetaWikiUser',
170 ];
171 $block = new Block( $blockOptions );
172 $block->insert();
173
174 // Reload block from DB
175 $userBlock = Block::newFromTarget( $username );
176 $this->assertTrue(
177 (bool)$block->appliesToRight( 'createaccount' ),
178 "Block object in DB should block right 'createaccount'"
179 );
180
181 $this->assertInstanceOf(
182 Block::class,
183 $userBlock,
184 "'$username' block block object should be existent"
185 );
186
187 // Reload user
188 $u = User::newFromName( $username );
189 $this->assertTrue(
190 (bool)$u->isBlockedFromCreateAccount(),
191 "Our sandbox user '$username' should NOT be able to create account"
192 );
193 }
194
195 /**
196 * @covers Block::insert
197 */
198 public function testCrappyCrossWikiBlocks() {
199 // Delete the last round's block if it's still there
200 $oldBlock = Block::newFromTarget( 'UserOnForeignWiki' );
201 if ( $oldBlock ) {
202 // An old block will prevent our new one from saving.
203 $oldBlock->delete();
204 }
205
206 // Local perspective (blockee on current wiki)...
207 $user = User::newFromName( 'UserOnForeignWiki' );
208 $user->addToDatabase();
209 $userId = $user->getId();
210 $this->assertNotEquals( 0, $userId, 'sanity' );
211
212 // Foreign perspective (blockee not on current wiki)...
213 $blockOptions = [
214 'address' => 'UserOnForeignWiki',
215 'user' => $user->getId(),
216 'reason' => 'crosswiki block...',
217 'timestamp' => wfTimestampNow(),
218 'expiry' => $this->db->getInfinity(),
219 'createAccount' => true,
220 'enableAutoblock' => true,
221 'hideName' => true,
222 'blockEmail' => true,
223 'byText' => 'Meta>MetaWikiUser',
224 ];
225 $block = new Block( $blockOptions );
226
227 $res = $block->insert( $this->db );
228 $this->assertTrue( (bool)$res['id'], 'Block succeeded' );
229
230 $user = null; // clear
231
232 $block = Block::newFromID( $res['id'] );
233 $this->assertEquals(
234 'UserOnForeignWiki',
235 $block->getTarget()->getName(),
236 'Correct blockee name'
237 );
238 $this->assertEquals( $userId, $block->getTarget()->getId(), 'Correct blockee id' );
239 $this->assertEquals( 'Meta>MetaWikiUser', $block->getBlocker()->getName(),
240 'Correct blocker name' );
241 $this->assertEquals( 'Meta>MetaWikiUser', $block->getByName(), 'Correct blocker name' );
242 $this->assertEquals( 0, $block->getBy(), 'Correct blocker id' );
243 }
244
245 protected function addXffBlocks() {
246 static $inited = false;
247
248 if ( $inited ) {
249 return;
250 }
251
252 $inited = true;
253
254 $blockList = [
255 [ 'target' => '70.2.0.0/16',
256 'type' => Block::TYPE_RANGE,
257 'desc' => 'Range Hardblock',
258 'ACDisable' => false,
259 'isHardblock' => true,
260 'isAutoBlocking' => false,
261 ],
262 [ 'target' => '2001:4860:4001::/48',
263 'type' => Block::TYPE_RANGE,
264 'desc' => 'Range6 Hardblock',
265 'ACDisable' => false,
266 'isHardblock' => true,
267 'isAutoBlocking' => false,
268 ],
269 [ 'target' => '60.2.0.0/16',
270 'type' => Block::TYPE_RANGE,
271 'desc' => 'Range Softblock with AC Disabled',
272 'ACDisable' => true,
273 'isHardblock' => false,
274 'isAutoBlocking' => false,
275 ],
276 [ 'target' => '50.2.0.0/16',
277 'type' => Block::TYPE_RANGE,
278 'desc' => 'Range Softblock',
279 'ACDisable' => false,
280 'isHardblock' => false,
281 'isAutoBlocking' => false,
282 ],
283 [ 'target' => '50.1.1.1',
284 'type' => Block::TYPE_IP,
285 'desc' => 'Exact Softblock',
286 'ACDisable' => false,
287 'isHardblock' => false,
288 'isAutoBlocking' => false,
289 ],
290 ];
291
292 $blocker = $this->getTestUser()->getUser();
293 foreach ( $blockList as $insBlock ) {
294 $target = $insBlock['target'];
295
296 if ( $insBlock['type'] === Block::TYPE_IP ) {
297 $target = User::newFromName( IP::sanitizeIP( $target ), false )->getName();
298 } elseif ( $insBlock['type'] === Block::TYPE_RANGE ) {
299 $target = IP::sanitizeRange( $target );
300 }
301
302 $block = new Block();
303 $block->setTarget( $target );
304 $block->setBlocker( $blocker );
305 $block->mReason = $insBlock['desc'];
306 $block->mExpiry = 'infinity';
307 $block->isCreateAccountBlocked( $insBlock['ACDisable'] );
308 $block->isHardblock( $insBlock['isHardblock'] );
309 $block->isAutoblocking( $insBlock['isAutoBlocking'] );
310 $block->insert();
311 }
312 }
313
314 public static function providerXff() {
315 return [
316 [ 'xff' => '1.2.3.4, 70.2.1.1, 60.2.1.1, 2.3.4.5',
317 'count' => 2,
318 'result' => 'Range Hardblock'
319 ],
320 [ 'xff' => '1.2.3.4, 50.2.1.1, 60.2.1.1, 2.3.4.5',
321 'count' => 2,
322 'result' => 'Range Softblock with AC Disabled'
323 ],
324 [ 'xff' => '1.2.3.4, 70.2.1.1, 50.1.1.1, 2.3.4.5',
325 'count' => 2,
326 'result' => 'Exact Softblock'
327 ],
328 [ 'xff' => '1.2.3.4, 70.2.1.1, 50.2.1.1, 50.1.1.1, 2.3.4.5',
329 'count' => 3,
330 'result' => 'Exact Softblock'
331 ],
332 [ 'xff' => '1.2.3.4, 70.2.1.1, 50.2.1.1, 2.3.4.5',
333 'count' => 2,
334 'result' => 'Range Hardblock'
335 ],
336 [ 'xff' => '1.2.3.4, 70.2.1.1, 60.2.1.1, 2.3.4.5',
337 'count' => 2,
338 'result' => 'Range Hardblock'
339 ],
340 [ 'xff' => '50.2.1.1, 60.2.1.1, 2.3.4.5',
341 'count' => 2,
342 'result' => 'Range Softblock with AC Disabled'
343 ],
344 [ 'xff' => '1.2.3.4, 50.1.1.1, 60.2.1.1, 2.3.4.5',
345 'count' => 2,
346 'result' => 'Exact Softblock'
347 ],
348 [ 'xff' => '1.2.3.4, <$A_BUNCH-OF{INVALID}TEXT\>, 60.2.1.1, 2.3.4.5',
349 'count' => 1,
350 'result' => 'Range Softblock with AC Disabled'
351 ],
352 [ 'xff' => '1.2.3.4, 50.2.1.1, 2001:4860:4001:802::1003, 2.3.4.5',
353 'count' => 2,
354 'result' => 'Range6 Hardblock'
355 ],
356 ];
357 }
358
359 /**
360 * @dataProvider providerXff
361 * @covers Block::getBlocksForIPList
362 * @covers Block::chooseBlock
363 */
364 public function testBlocksOnXff( $xff, $exCount, $exResult ) {
365 $user = $this->getUserForBlocking();
366 $this->addBlockForUser( $user );
367
368 $list = array_map( 'trim', explode( ',', $xff ) );
369 $xffblocks = Block::getBlocksForIPList( $list, true );
370 $this->assertEquals( $exCount, count( $xffblocks ), 'Number of blocks for ' . $xff );
371 $block = Block::chooseBlock( $xffblocks, $list );
372 $this->assertEquals( $exResult, $block->mReason, 'Correct block type for XFF header ' . $xff );
373 }
374
375 /**
376 * @covers Block::getSystemBlockType
377 * @covers Block::insert
378 * @covers Block::doAutoblock
379 */
380 public function testSystemBlocks() {
381 $user = $this->getUserForBlocking();
382 $this->addBlockForUser( $user );
383
384 $blockOptions = [
385 'address' => $user->getName(),
386 'reason' => 'test system block',
387 'timestamp' => wfTimestampNow(),
388 'expiry' => $this->db->getInfinity(),
389 'byText' => 'MediaWiki default',
390 'systemBlock' => 'test',
391 'enableAutoblock' => true,
392 ];
393 $block = new Block( $blockOptions );
394
395 $this->assertSame( 'test', $block->getSystemBlockType() );
396
397 try {
398 $block->insert();
399 $this->fail( 'Expected exception not thrown' );
400 } catch ( MWException $ex ) {
401 $this->assertSame( 'Cannot insert a system block into the database', $ex->getMessage() );
402 }
403
404 try {
405 $block->doAutoblock( '192.0.2.2' );
406 $this->fail( 'Expected exception not thrown' );
407 } catch ( MWException $ex ) {
408 $this->assertSame( 'Cannot autoblock from a system block', $ex->getMessage() );
409 }
410 }
411
412 /**
413 * @covers Block::newFromRow
414 */
415 public function testNewFromRow() {
416 $badActor = $this->getTestUser()->getUser();
417 $sysop = $this->getTestSysop()->getUser();
418
419 $block = new Block( [
420 'address' => $badActor->getName(),
421 'user' => $badActor->getId(),
422 'by' => $sysop->getId(),
423 'expiry' => 'infinity',
424 ] );
425 $block->insert();
426
427 $blockQuery = Block::getQueryInfo();
428 $row = $this->db->select(
429 $blockQuery['tables'],
430 $blockQuery['fields'],
431 [
432 'ipb_id' => $block->getId(),
433 ],
434 __METHOD__,
435 [],
436 $blockQuery['joins']
437 )->fetchObject();
438
439 $block = Block::newFromRow( $row );
440 $this->assertInstanceOf( Block::class, $block );
441 $this->assertEquals( $block->getBy(), $sysop->getId() );
442 $this->assertEquals( $block->getTarget()->getName(), $badActor->getName() );
443 $block->delete();
444 }
445
446 /**
447 * @covers Block::equals
448 */
449 public function testEquals() {
450 $block = new Block();
451
452 $this->assertTrue( $block->equals( $block ) );
453
454 $partial = new Block( [
455 'sitewide' => false,
456 ] );
457 $this->assertFalse( $block->equals( $partial ) );
458 }
459
460 /**
461 * @covers Block::isSitewide
462 */
463 public function testIsSitewide() {
464 $block = new Block();
465 $this->assertTrue( $block->isSitewide() );
466
467 $block = new Block( [
468 'sitewide' => true,
469 ] );
470 $this->assertTrue( $block->isSitewide() );
471
472 $block = new Block( [
473 'sitewide' => false,
474 ] );
475 $this->assertFalse( $block->isSitewide() );
476
477 $block = new Block( [
478 'sitewide' => false,
479 ] );
480 $block->isSitewide( true );
481 $this->assertTrue( $block->isSitewide() );
482 }
483
484 /**
485 * @covers Block::getRestrictions
486 * @covers Block::setRestrictions
487 */
488 public function testRestrictions() {
489 $block = new Block();
490 $restrictions = [
491 new PageRestriction( 0, 1 )
492 ];
493 $block->setRestrictions( $restrictions );
494
495 $this->assertSame( $restrictions, $block->getRestrictions() );
496 }
497
498 /**
499 * @covers Block::getRestrictions
500 * @covers Block::insert
501 */
502 public function testRestrictionsFromDatabase() {
503 $badActor = $this->getTestUser()->getUser();
504 $sysop = $this->getTestSysop()->getUser();
505
506 $block = new Block( [
507 'address' => $badActor->getName(),
508 'user' => $badActor->getId(),
509 'by' => $sysop->getId(),
510 'expiry' => 'infinity',
511 ] );
512 $page = $this->getExistingTestPage( 'Foo' );
513 $restriction = new PageRestriction( 0, $page->getId() );
514 $block->setRestrictions( [ $restriction ] );
515 $block->insert();
516
517 // Refresh the block from the database.
518 $block = Block::newFromID( $block->getId() );
519 $restrictions = $block->getRestrictions();
520 $this->assertCount( 1, $restrictions );
521 $this->assertTrue( $restriction->equals( $restrictions[0] ) );
522 $block->delete();
523 }
524
525 /**
526 * @covers Block::insert
527 */
528 public function testInsertExistingBlock() {
529 $badActor = $this->getTestUser()->getUser();
530 $sysop = $this->getTestSysop()->getUser();
531
532 $block = new Block( [
533 'address' => $badActor->getName(),
534 'user' => $badActor->getId(),
535 'by' => $sysop->getId(),
536 'expiry' => 'infinity',
537 ] );
538 $page = $this->getExistingTestPage( 'Foo' );
539 $restriction = new PageRestriction( 0, $page->getId() );
540 $block->setRestrictions( [ $restriction ] );
541 $block->insert();
542
543 // Insert the block again, which should result in a failur
544 $result = $block->insert();
545
546 $this->assertFalse( $result );
547
548 // Ensure that there are no restrictions where the blockId is 0.
549 $count = $this->db->selectRowCount(
550 'ipblocks_restrictions',
551 '*',
552 [ 'ir_ipb_id' => 0 ],
553 __METHOD__
554 );
555 $this->assertSame( 0, $count );
556
557 $block->delete();
558 }
559
560 /**
561 * @covers Block::appliesToTitle
562 */
563 public function testAppliesToTitleReturnsTrueOnSitewideBlock() {
564 $this->setMwGlobals( [
565 'wgBlockDisablesLogin' => false,
566 ] );
567 $user = $this->getTestUser()->getUser();
568 $block = new Block( [
569 'expiry' => wfTimestamp( TS_MW, wfTimestamp() + ( 40 * 60 * 60 ) ),
570 'allowUsertalk' => true,
571 'sitewide' => true
572 ] );
573
574 $block->setTarget( $user );
575 $block->setBlocker( $this->getTestSysop()->getUser() );
576 $block->insert();
577
578 $title = $this->getExistingTestPage( 'Foo' )->getTitle();
579
580 $this->assertTrue( $block->appliesToTitle( $title ) );
581
582 // appliesToTitle() ignores allowUsertalk
583 $title = $user->getTalkPage();
584 $this->assertTrue( $block->appliesToTitle( $title ) );
585
586 $block->delete();
587 }
588
589 /**
590 * @covers Block::appliesToTitle
591 */
592 public function testAppliesToTitleOnPartialBlock() {
593 $this->setMwGlobals( [
594 'wgBlockDisablesLogin' => false,
595 ] );
596 $user = $this->getTestUser()->getUser();
597 $block = new Block( [
598 'expiry' => wfTimestamp( TS_MW, wfTimestamp() + ( 40 * 60 * 60 ) ),
599 'allowUsertalk' => true,
600 'sitewide' => false
601 ] );
602
603 $block->setTarget( $user );
604 $block->setBlocker( $this->getTestSysop()->getUser() );
605 $block->insert();
606
607 $pageFoo = $this->getExistingTestPage( 'Foo' );
608 $pageBar = $this->getExistingTestPage( 'Bar' );
609 $pageJohn = $this->getExistingTestPage( 'User:John' );
610
611 $pageRestriction = new PageRestriction( $block->getId(), $pageFoo->getId() );
612 $namespaceRestriction = new NamespaceRestriction( $block->getId(), NS_USER );
613 BlockRestriction::insert( [ $pageRestriction, $namespaceRestriction ] );
614
615 $this->assertTrue( $block->appliesToTitle( $pageFoo->getTitle() ) );
616 $this->assertFalse( $block->appliesToTitle( $pageBar->getTitle() ) );
617 $this->assertTrue( $block->appliesToTitle( $pageJohn->getTitle() ) );
618
619 $block->delete();
620 }
621
622 /**
623 * @covers Block::appliesToNamespace
624 * @covers Block::appliesToPage
625 */
626 public function testAppliesToReturnsTrueOnSitewideBlock() {
627 $this->setMwGlobals( [
628 'wgBlockDisablesLogin' => false,
629 ] );
630 $user = $this->getTestUser()->getUser();
631 $block = new Block( [
632 'expiry' => wfTimestamp( TS_MW, wfTimestamp() + ( 40 * 60 * 60 ) ),
633 'allowUsertalk' => true,
634 'sitewide' => true
635 ] );
636
637 $block->setTarget( $user );
638 $block->setBlocker( $this->getTestSysop()->getUser() );
639 $block->insert();
640
641 $title = $this->getExistingTestPage()->getTitle();
642
643 $this->assertTrue( $block->appliesToPage( $title->getArticleID() ) );
644 $this->assertTrue( $block->appliesToNamespace( NS_MAIN ) );
645 $this->assertTrue( $block->appliesToNamespace( NS_USER_TALK ) );
646
647 $block->delete();
648 }
649
650 /**
651 * @covers Block::appliesToPage
652 */
653 public function testAppliesToPageOnPartialPageBlock() {
654 $this->setMwGlobals( [
655 'wgBlockDisablesLogin' => false,
656 ] );
657 $user = $this->getTestUser()->getUser();
658 $block = new Block( [
659 'expiry' => wfTimestamp( TS_MW, wfTimestamp() + ( 40 * 60 * 60 ) ),
660 'allowUsertalk' => true,
661 'sitewide' => false
662 ] );
663
664 $block->setTarget( $user );
665 $block->setBlocker( $this->getTestSysop()->getUser() );
666 $block->insert();
667
668 $title = $this->getExistingTestPage()->getTitle();
669
670 $pageRestriction = new PageRestriction(
671 $block->getId(),
672 $title->getArticleID()
673 );
674 BlockRestriction::insert( [ $pageRestriction ] );
675
676 $this->assertTrue( $block->appliesToPage( $title->getArticleID() ) );
677
678 $block->delete();
679 }
680
681 /**
682 * @covers Block::appliesToNamespace
683 */
684 public function testAppliesToNamespaceOnPartialNamespaceBlock() {
685 $this->setMwGlobals( [
686 'wgBlockDisablesLogin' => false,
687 ] );
688 $user = $this->getTestUser()->getUser();
689 $block = new Block( [
690 'expiry' => wfTimestamp( TS_MW, wfTimestamp() + ( 40 * 60 * 60 ) ),
691 'allowUsertalk' => true,
692 'sitewide' => false
693 ] );
694
695 $block->setTarget( $user );
696 $block->setBlocker( $this->getTestSysop()->getUser() );
697 $block->insert();
698
699 $namespaceRestriction = new NamespaceRestriction( $block->getId(), NS_MAIN );
700 BlockRestriction::insert( [ $namespaceRestriction ] );
701
702 $this->assertTrue( $block->appliesToNamespace( NS_MAIN ) );
703 $this->assertFalse( $block->appliesToNamespace( NS_USER ) );
704
705 $block->delete();
706 }
707
708 /**
709 * @covers Block::appliesToRight
710 */
711 public function testBlockAllowsPurge() {
712 $this->setMwGlobals( [
713 'wgBlockDisablesLogin' => false,
714 ] );
715 $block = new Block();
716 $this->assertFalse( $block->appliesToRight( 'purge' ) );
717 }
718
719 }