Go to the documentation of this file.
3 define(
'NS_UNITTEST', 5600 );
4 define(
'NS_UNITTEST_TALK', 5601 );
8 use Wikimedia\TestingAccessWrapper;
23 'wgGroupPermissions' => [],
24 'wgRevokePermissions' => [],
37 # Data for regular $wgGroupPermissions test
50 # Data for regular $wgRevokePermissions test
55 # For the options test
57 'editmyoptions' =>
true,
66 $this->assertContains(
'runtest', $rights );
67 $this->assertNotContains(
'writetest', $rights );
68 $this->assertNotContains(
'modifytest', $rights );
69 $this->assertNotContains(
'nukeworld', $rights );
72 $this->assertContains(
'runtest', $rights );
73 $this->assertContains(
'writetest', $rights );
74 $this->assertContains(
'modifytest', $rights );
75 $this->assertNotContains(
'nukeworld', $rights );
83 $this->assertNotContains(
'runtest', $rights );
84 $this->assertNotContains(
'writetest', $rights );
85 $this->assertNotContains(
'modifytest', $rights );
86 $this->assertNotContains(
'nukeworld', $rights );
93 $rights = $this->
user->getRights();
94 $this->assertContains(
'runtest', $rights );
95 $this->assertNotContains(
'writetest', $rights );
96 $this->assertNotContains(
'modifytest', $rights );
97 $this->assertNotContains(
'nukeworld', $rights );
105 $userWrapper = TestingAccessWrapper::newFromObject(
$user );
108 $this->assertContains(
'test', $rights,
'sanity check' );
109 $this->assertContains(
'runtest', $rights,
'sanity check' );
110 $this->assertContains(
'writetest', $rights,
'sanity check' );
111 $this->assertNotContains(
'nukeworld', $rights,
'sanity check' );
115 $rights[] =
'nukeworld';
116 $rights = array_diff( $rights, [
'writetest' ] );
119 $userWrapper->mRights =
null;
121 $this->assertContains(
'test', $rights );
122 $this->assertContains(
'runtest', $rights );
123 $this->assertNotContains(
'writetest', $rights );
124 $this->assertContains(
'nukeworld', $rights );
128 ->setMethods( [
'getAllowedUserRights',
'deregisterSession',
'getSessionId' ] )
130 $mock->method(
'getAllowedUserRights' )->willReturn( [
'test',
'writetest' ] );
131 $mock->method(
'getSessionId' )->willReturn(
132 new MediaWiki\Session\SessionId( str_repeat(
'X', 32 ) )
136 ->setMethods( [
'getSession' ] )
138 $mockRequest->method(
'getSession' )->willReturn( $session );
139 $userWrapper->mRequest = $mockRequest;
141 $userWrapper->mRights =
null;
143 $this->assertContains(
'test', $rights );
144 $this->assertNotContains(
'runtest', $rights );
145 $this->assertNotContains(
'writetest', $rights );
146 $this->assertNotContains(
'nukeworld', $rights );
158 $this->assertEquals( $expected,
$result,
"Groups with permission $right" );
164 [
'unittesters',
'testwriters' ],
192 [
'',
false,
'Empty string' ],
193 [
' ',
false,
'Blank space' ],
194 [
'10.0.0.0',
true,
'IPv4 private 10/8' ],
195 [
'10.255.255.255',
true,
'IPv4 private 10/8' ],
196 [
'192.168.1.1',
true,
'IPv4 private 192.168/16' ],
197 [
'203.0.113.0',
true,
'IPv4 example' ],
198 [
'2002:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
true,
'IPv6 example' ],
202 [
'300.300.300.300',
true,
'Looks too much like an IPv4 address' ],
203 [
'203.0.113.xxx',
true,
'Assigned by UseMod to cloaked logged-out users' ],
217 [
'',
false,
'Empty string' ],
218 [
' ',
false,
'Blank space' ],
219 [
'abcd',
false,
'Starts with small letter' ],
220 [
'Ab/cd',
false,
'Contains slash' ],
221 [
'Ab cd',
true,
'Whitespace' ],
222 [
'192.168.1.1',
false,
'IP' ],
223 [
'116.17.184.5/32',
false,
'IP range' ],
224 [
'::e:f:2001/96',
false,
'IPv6 range' ],
225 [
'User:Abcd',
false,
'Reserved Namespace' ],
226 [
'12abcd232',
true,
'Starts with Numbers' ],
227 [
'?abcd',
true,
'Start with ? mark' ],
228 [
'#abcd',
false,
'Start with #' ],
229 [
'Abcdകഖഗഘ',
true,
' Mixed scripts' ],
230 [
'ജോസ്തോമസ്',
false,
'ZWNJ- Format control character' ],
231 [
'Ab cd',
false,
' Ideographic space' ],
232 [
'300.300.300.300',
false,
'Looks too much like an IPv4 address' ],
233 [
'302.113.311.900',
false,
'Looks too much like an IPv4 address' ],
234 [
'203.0.113.xxx',
false,
'Reserved for usage by UseMod for cloaked logged-out users' ],
248 for ( $i = 0; $i < 3; $i++ ) {
249 $page->doEditContent(
261 'After three edits, the user edit count should be 3'
270 'After increasing the edit count manually, the user edit count should be 4'
284 'Edit count starts null for anonymous users.'
291 'Edit count remains null for anonymous users despite calls to increase it.'
305 $reloadedUser->incEditCount();
309 $reloadedUser->getEditCount(),
310 'Increasing the edit count after a fresh load leaves the object up to date.'
329 $this->assertEquals(
'test',
$user->
getOption(
'userjs-someoption' ) );
333 MediaWikiServices::getInstance()->getMainWANObjectCache()->clearProcessCache();
334 $this->assertEquals(
'test',
$user->
getOption(
'userjs-someoption' ) );
350 $this->
user->setOption(
'userjs-someoption',
'test' );
352 $this->assertEquals(
'test', $this->
user->getOption(
'userjs-someoption' ) );
366 'wgPasswordPolicy' => [
369 'MinimalPasswordLength' => 8,
370 'MinimumPasswordLengthToLogin' => 1,
371 'PasswordCannotMatchUsername' => 1,
374 'MinimalPasswordLength' => 6,
375 'PasswordCannotMatchUsername' =>
true,
376 'PasswordCannotMatchBlacklist' =>
true,
377 'MaximalPasswordLength' => 40,
381 'MinimalPasswordLength' =>
'PasswordPolicyChecks::checkMinimalPasswordLength',
382 'MinimumPasswordLengthToLogin' =>
'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
383 'PasswordCannotMatchUsername' =>
'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
384 'PasswordCannotMatchBlacklist' =>
'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
385 'MaximalPasswordLength' =>
'PasswordPolicyChecks::checkMaximalPasswordLength',
390 $user = static::getTestUser()->getUser();
402 $longPass = str_repeat(
'a', 41 );
426 'InterwikiLoadPrefix' => [
427 function ( $prefix, &$iwdata ) {
428 if ( $prefix ===
'interwiki' ) {
430 'iw_url' =>
'http://example.com/',
440 foreach ( $expectedArray
as $validate => $expected ) {
449 'Leading space' => [
' Leading space', [
'creatable' =>
'Leading space' ] ],
450 'Trailing space ' => [
'Trailing space ', [
'creatable' =>
'Trailing space' ] ],
451 'Namespace prefix' => [
'Talk:Username', [
'creatable' =>
false,
'usable' =>
false,
452 'valid' =>
false,
'false' =>
'Talk:Username' ] ],
453 'Interwiki prefix' => [
'interwiki:Username', [
'creatable' =>
false,
'usable' =>
false,
454 'valid' =>
false,
'false' =>
'Interwiki:Username' ] ],
455 'With hash' => [
'name with # hash', [
'creatable' =>
false,
'usable' =>
false ] ],
456 'Multi spaces' => [
'Multi spaces', [
'creatable' =>
'Multi spaces',
457 'usable' =>
'Multi spaces' ] ],
458 'Lowercase' => [
'lowercase', [
'creatable' =>
'Lowercase' ] ],
459 'Invalid character' => [
'in[]valid', [
'creatable' =>
false,
'usable' =>
false,
460 'valid' =>
false,
'false' =>
'In[]valid' ] ],
461 'With slash' => [
'with / slash', [
'creatable' =>
false,
'usable' =>
false,
'valid' =>
false,
462 'false' =>
'With / slash' ] ],
473 $this->assertTrue( $first->equals( $first ) );
474 $this->assertTrue( $first->equals( $second ) );
475 $this->assertTrue( $second->equals( $first ) );
480 $this->assertFalse( $third->equals( $fourth ) );
481 $this->assertFalse( $fourth->equals( $third ) );
487 $this->assertTrue( $fifth->equals( $sixth ) );
494 $user = static::getTestUser()->getUser();
522 $user = TestingAccessWrapper::newFromObject(
$user );
528 $this->assertGreaterThan(
534 $this->assertGreaterThan(
535 $touched,
$user->
getDBTouched(),
"user_touched increased with casOnTouched() #2" );
546 $this->assertEquals( 0, iterator_count(
$users ) );
549 $this->assertEquals( 0, iterator_count(
$users ) );
553 $this->assertEquals( 1, iterator_count(
$users ) );
560 $this->assertEquals( 2, iterator_count(
$users ) );
564 $this->assertTrue( $user2->equals(
$users->current() ) );
569 $this->assertEquals( 1, iterator_count(
$users ) );
582 'wgCookieSetOnAutoblock' =>
true,
583 'wgCookiePrefix' =>
'wmsitetitle',
589 'PerformRetroactiveAutoblock' => []
596 $request1->getSession()->setUser( $user1tmp );
597 $expiryFiveHours =
wfTimestamp() + ( 5 * 60 * 60 );
598 $block =
new Block( [
599 'enableAutoblock' =>
true,
600 'expiry' =>
wfTimestamp( TS_MW, $expiryFiveHours ),
603 $block->setTarget( $user1tmp );
604 $block->setBlocker( $userBlocker );
605 $res = $block->insert();
606 $this->assertTrue( (
bool)
$res[
'id'],
'Failed to insert block' );
608 $user1->mBlock = $block;
612 $this->assertTrue( $user1->isLoggedIn() );
613 $this->assertTrue( $user1->isBlocked() );
615 $this->assertTrue( $block->isAutoblocking() );
616 $this->assertGreaterThanOrEqual( 1, $block->getId() );
619 $cookies = $request1->response()->getCookies();
620 $this->assertArrayHasKey(
'wmsitetitleBlockID', $cookies );
621 $this->assertEquals( $expiryFiveHours, $cookies[
'wmsitetitleBlockID'][
'expire'] );
623 $this->assertEquals( $block->getId(), $cookieValue );
627 $request2->setCookie(
'BlockID', $block->getCookieValue() );
630 $this->assertNotEquals( $user1->getId(), $user2->getId() );
631 $this->assertNotEquals( $user1->getToken(), $user2->getToken() );
632 $this->assertTrue( $user2->isAnon() );
633 $this->assertFalse( $user2->isLoggedIn() );
634 $this->assertTrue( $user2->isBlocked() );
636 $this->assertEquals(
true, $user2->getBlock()->isAutoblocking(),
'Autoblock does not work' );
639 $this->assertEquals( $block->getId(), $user2->getBlock()->getId() );
640 $this->assertEquals( $block->getExpiry(), $user2->getBlock()->getExpiry() );
645 $request3->getSession()->setUser( $user3tmp );
646 $request3->setCookie(
'BlockID', $block->getId() );
649 $this->assertTrue( $user3->isLoggedIn() );
650 $this->assertTrue( $user3->isBlocked() );
651 $this->assertEquals(
true, $user3->getBlock()->isAutoblocking() );
664 'wgCookieSetOnAutoblock' =>
false,
665 'wgCookiePrefix' =>
'wm_no_cookies',
671 'PerformRetroactiveAutoblock' => []
678 $request1->getSession()->setUser( $testUser );
679 $block =
new Block( [
'enableAutoblock' =>
true ] );
681 $block->setTarget( $testUser );
682 $block->setBlocker( $userBlocker );
683 $res = $block->insert();
684 $this->assertTrue( (
bool)
$res[
'id'],
'Failed to insert block' );
686 $user->mBlock = $block;
693 $this->assertTrue( $block->isAutoblocking() );
695 $this->assertGreaterThanOrEqual( $block->getId(),
$user->
getBlockId() );
696 $cookies = $request1->response()->getCookies();
697 $this->assertArrayNotHasKey(
'wm_no_cookiesBlockID', $cookies );
710 'wgCookieSetOnAutoblock' =>
true,
711 'wgCookiePrefix' =>
'wm_infinite_block',
717 'PerformRetroactiveAutoblock' => []
724 $request1->getSession()->setUser( $user1Tmp );
725 $block =
new Block( [
'enableAutoblock' =>
true,
'expiry' =>
'infinity' ] );
727 $block->setTarget( $user1Tmp );
728 $block->setBlocker( $userBlocker );
729 $res = $block->insert();
730 $this->assertTrue( (
bool)
$res[
'id'],
'Failed to insert block' );
732 $user1->mBlock = $block;
736 $this->assertTrue( $user1->isLoggedIn() );
737 $this->assertTrue( $user1->isBlocked() );
739 $this->assertTrue( $block->isAutoblocking() );
740 $this->assertGreaterThanOrEqual( 1, $user1->getBlockId() );
741 $cookies = $request1->response()->getCookies();
743 $this->assertArrayHasKey(
'wm_infinite_blockBlockID', $cookies );
748 $cookies[
'wm_infinite_blockBlockID'][
'expire'],
755 $block->mExpiry =
wfTimestamp( TS_MW, $newExpiry );
759 $request2->getSession()->setUser( $user2tmp );
761 $user2->mBlock = $block;
763 $cookies = $request2->response()->getCookies();
764 $this->assertEquals(
wfTimestamp( TS_MW, $newExpiry ), $block->getExpiry() );
765 $this->assertEquals( $newExpiry, $cookies[
'wm_infinite_blockBlockID'][
'expire'] );
776 TestingAccessWrapper::newFromObject(
$user )->mRequest =
$request;
779 $this->
setMwGlobals(
'wgSoftBlockRanges', [
'10.0.0.0/8' ] );
782 $wgUser =
new User();
785 $setSessionUser( $wgUser,
$request );
786 $this->assertNull( $wgUser->getBlock() );
789 $wgUser =
new User();
792 $setSessionUser( $wgUser,
$request );
793 $block = $wgUser->getBlock();
795 $this->assertSame(
'wgSoftBlockRanges', $block->getSystemBlockType() );
801 $setSessionUser( $wgUser,
$request );
802 $this->assertFalse( $wgUser->isAnon(),
'sanity check' );
803 $this->assertNull( $wgUser->getBlock() );
812 'wgCookieSetOnAutoblock' =>
true,
813 'wgCookiePrefix' =>
'wmsitetitle',
819 'PerformRetroactiveAutoblock' => []
826 $request1->getSession()->setUser( $user1tmp );
827 $block =
new Block( [
'enableAutoblock' =>
true ] );
829 $block->setTarget( $user1tmp );
830 $block->setBlocker( $userBlocker );
831 $res = $block->insert();
832 $this->assertTrue( (
bool)
$res[
'id'],
'Failed to insert block' );
834 $user1->mBlock = $block;
840 $request2->setCookie(
'BlockID', $block->getId() .
'!zzzzzzz' );
843 $this->assertTrue( $user2->isAnon() );
844 $this->assertFalse( $user2->isLoggedIn() );
845 $this->assertFalse( $user2->isBlocked() );
858 'wgCookieSetOnAutoblock' =>
true,
859 'wgCookiePrefix' =>
'wmsitetitle',
860 'wgSecretKey' =>
null,
865 'PerformRetroactiveAutoblock' => []
872 $request1->getSession()->setUser( $user1tmp );
873 $block =
new Block( [
'enableAutoblock' =>
true ] );
875 $block->setTarget( $user1tmp );
876 $block->setBlocker( $userBlocker );
877 $res = $block->insert();
878 $this->assertTrue( (
bool)
$res[
'id'],
'Failed to insert block' );
880 $user1->mBlock = $block;
882 $this->assertTrue( $user1->isBlocked() );
887 $request2->setCookie(
'BlockID', $block->getId() );
890 $this->assertNotEquals( $user1->getId(), $user2->getId() );
891 $this->assertNotEquals( $user1->getToken(), $user2->getToken() );
892 $this->assertTrue( $user2->isAnon() );
893 $this->assertFalse( $user2->isLoggedIn() );
894 $this->assertTrue( $user2->isBlocked() );
895 $this->assertEquals(
true, $user2->getBlock()->isAutoblocking() );
912 $this->
setMwGlobals(
'wgRateLimitsExcludedIPs', [
'1.2.3.4' ] );
915 $this->
setMwGlobals(
'wgRateLimitsExcludedIPs', [
'1.2.3.0/8' ] );
919 $noRateLimitUser = $this->getMockBuilder(
User::class )->disableOriginalConstructor()
920 ->setMethods( [
'getIP',
'getRights' ] )->getMock();
921 $noRateLimitUser->expects( $this->
any() )->method(
'getIP' )->willReturn(
'1.2.3.4' );
922 $noRateLimitUser->expects( $this->
any() )->method(
'getRights' )->willReturn( [
'noratelimit' ] );
923 $this->assertFalse( $noRateLimitUser->isPingLimitable() );
928 [ 2, 2,
'newcomer' ],
929 [ 12, 3,
'newcomer' ],
930 [ 8, 5,
'newcomer' ],
931 [ 15, 10,
'learner' ],
932 [ 450, 20,
'learner' ],
933 [ 460, 33,
'learner' ],
934 [ 525, 28,
'learner' ],
935 [ 538, 33,
'experienced' ],
945 'wgLearnerEdits' => 10,
946 'wgLearnerMemberSince' => 4,
947 'wgExperiencedUserEdits' => 500,
948 'wgExperiencedUserMemberSince' => 30,
953 $row =
$db->selectRow(
954 $userQuery[
'tables'],
955 $userQuery[
'fields'],
956 [
'user_id' => $this->
getTestUser()->getUser()->getId() ],
961 $row->user_editcount = $editCount;
962 $row->user_registration =
$db->timestamp( time() - $memberSince * 86400 );
979 [
'1.2.3.4',
'1.2.3.4' ],
980 [
'1.2.3.4',
'1.2.3.0/16' ],
1005 'test' => $blockListEntry
1011 'IP addresses in the keys of $wgProxyList (found the following IP ' .
1012 'addresses in keys: ' . $blockListEntry .
', please move them to values)'
1017 $blockListEntry =>
'test'
1024 $domain = MediaWikiServices::getInstance()->getDBLoadBalancer()->getLocalDomainID();
1030 $this->assertTrue(
$user->
getActorId() > 0,
'User::createNew sets an actor ID' );
1034 $this->assertTrue(
$user->
getActorId() > 0,
'User::addToDatabase sets an actor ID' );
1037 $this->assertTrue(
$user->
getActorId() > 0,
'Actor ID can be retrieved for user loaded by name' );
1040 $this->assertTrue(
$user->
getActorId() > 0,
'Actor ID can be retrieved for user loaded by ID' );
1043 $this->assertEquals(
$user->
getId(), $user2->getId(),
1044 'User::newFromActorId works for an existing user' );
1046 $row = $this->db->selectRow(
'user',
User::selectFields(), [
'user_id' => $id ], __METHOD__ );
1049 'Actor ID can be retrieved for user loaded with User::selectFields()' );
1051 $this->db->delete(
'actor', [
'actor_user' => $id ], __METHOD__ );
1057 $this->assertFalse(
$user->
getActorId() > 0,
'No Actor ID by default if none in database' );
1058 $this->assertTrue(
$user->
getActorId( $this->db ) > 0,
'Actor ID can be created if none in db' );
1062 $this->assertEquals(
1064 $this->db->selectField(
1065 'actor',
'actor_name', [
'actor_id' =>
$user->
getActorId() ], __METHOD__
1067 'User::saveSettings updates actor table for name change'
1071 $ip =
'192.168.12.34';
1072 $this->db->delete(
'actor', [
'actor_name' => $ip ], __METHOD__ );
1075 $this->assertFalse(
$user->
getActorId() > 0,
'Anonymous user has no actor ID by default' );
1077 'Actor ID can be created for an anonymous user' );
1080 $this->assertTrue(
$user->
getActorId() > 0,
'Actor ID can be loaded for an anonymous user' );
1082 $this->assertEquals(
$user->
getName(), $user2->getName(),
1083 'User::newFromActorId works for an anonymous user' );
1089 for ( $i = 1; $i <= 7; $i++ ) {
1095 $this->assertSame(
$user->
getId(), $test->getId() );
1096 $this->assertSame(
$user->
getName(), $test->getName() );
1105 $this->assertSame(
$user->
getId(), $test->getId() );
1106 $this->assertSame(
$user->
getName(), $test->getName() );
1109 $this->assertSame(
$user->
getId(), $test->getId() );
1110 $this->assertSame(
$user->
getName(), $test->getName() );
1116 $this->assertSame( 123456, $test->getId() );
1117 $this->assertSame(
'Bogus', $test->getName() );
1118 $this->assertSame( 654321, $test->getActorId() );
1123 $this->fail(
'Expected exception not thrown' );
1124 }
catch ( InvalidArgumentException $ex ) {
1128 $this->fail(
'Expected exception not thrown' );
1129 }
catch ( InvalidArgumentException $ex ) {
1179 $this->assertNull(
$user->
getBlock(
false ),
'sanity check' );
1182 $this->assertFalse( (
bool)
$user->
isHidden(),
'sanity check' );
1187 $block =
new Block( [
1189 'allowUsertalk' =>
false,
1190 'reason' =>
'Because',
1192 $block->setTarget(
$user );
1193 $block->setBlocker( $blocker );
1194 $res = $block->insert();
1195 $this->assertTrue( (
bool)
$res[
'id'],
'sanity check: Failed to insert block' );
1223 'wgCookieSetOnIpBlock' =>
true,
1224 'wgCookiePrefix' =>
'wiki',
1229 $block =
new Block( [
1232 $block->setTarget(
'1.2.3.4' );
1233 $block->setBlocker( $this->
getTestSysop()->getUser() );
1245 $cookies =
$request->response()->getCookies();
1246 $this->assertArrayHasKey(
'wikiBlockID', $cookies );
1258 'wgCookieSetOnIpBlock' =>
false,
1259 'wgCookiePrefix' =>
'wiki',
1264 $block =
new Block( [
1267 $block->setTarget(
'1.2.3.4' );
1268 $block->setBlocker( $this->
getTestSysop()->getUser() );
1280 $cookies =
$request->response()->getCookies();
1281 $this->assertArrayNotHasKey(
'wikiBlockID', $cookies );
1293 'wgAutoblockExpiry' => 8000,
1294 'wgCookieSetOnIpBlock' =>
true,
1295 'wgCookiePrefix' =>
'wiki',
1300 $block =
new Block( [
1303 $block->setTarget(
'1.2.3.4' );
1304 $block->setBlocker( $this->
getTestSysop()->getUser() );
1311 $request->setCookie(
'BlockID', $block->getCookieValue() );
1320 $cookies =
$request->response()->getCookies();
1321 $this->assertEquals(
'', $cookies[
'wikiBlockID'][
'value'] );
load( $flags=self::READ_NORMAL)
Load the user table data for this object from the source given by mFrom.
testGetCanonicalName( $name, $expectedArray)
User::getCanonicalName() provideGetCanonicalName.
static provideGetGroupsWithPermission()
WebRequest clone which takes values from a provided array.
static newFromId( $id)
Static factory method for creation from a given user ID.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
processing should stop and the error should be shown to the user * false
isValidPassword( $password)
Is the input a valid password for this user?
getId()
Get the user's ID.
testCheckAndSetTouched()
User::checkAndSetTouched.
isAnon()
Get whether the user is anonymous.
testIsIP( $value, $result, $message)
provideIPs User::isIP
getActorId(IDatabase $dbw=null)
Get the user's actor ID.
static isLocallyBlockedProxy( $ip)
Check if an IP address is in the local proxy list.
testIpBlockCookieIgnoredWhenUserLoggedIn()
When an ip user is blocked and then they log in, cookie block should be invalid and the cookie remove...
$wgRevokePermissions
Permission keys revoked from users in each group.
getEditCount()
Get the user's edit count.
incEditCount()
Deferred version of incEditCountImmediate()
static newFromSession(WebRequest $request=null)
Create a new user object using data from session.
testFindUsersByGroup()
User::findUsersByGroup.
getBlock( $bFromSlave=true)
Get the block affecting the user, or null if the user is not blocked.
getBlockId()
If user is blocked, return the ID for the block.
testUserGetRightsHooks()
User::getRights.
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 since 1.16! 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 since 1.28! 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
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgDefaultUserOptions
Settings added to this array will override the default globals for the user preferences used by anony...
testLoggedIn()
User::isLoggedIn User::isAnon.
testAutoblockCookieInauthentic()
Test that a modified BlockID cookie doesn't actually load the relevant block (T152951).
testOptions()
Test changing user options.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
static provideIsLocallBlockedProxy()
static newFromAnyId( $userId, $userName, $actorId)
Static factory method for creation from an ID, name, and/or actor ID.
static newFromIdentity(UserIdentity $identity)
Returns a User object corresponding to the given UserIdentity.
static newFromRow( $row, $data=null)
Create a new user object from a user row.
testExperienceLevel( $editCount, $memberSince, $expLevel)
User::getExperienceLevel provideExperienceLevel.
testIsLocallyBlockedProxy( $ip, $blockListEntry)
provideIsLocallBlockedProxy User::isLocallyBlockedProxy
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
getRights()
Get the permissions this user has.
static createNew( $name, $params=[])
Add a user to the database, return the user object.
testGroupPermissions()
User::getGroupPermissions.
isBlockedFrom( $title, $bFromSlave=false)
Check if user is blocked from editing a particular article.
testBlockInstanceCache()
User::getBlockedStatus User::getBlock User::blockedBy User::blockedFor User::isHidden User::isBlocked...
addToDatabase()
Add this existing user object to the database.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
checkPasswordValidity( $password)
Check if this is a valid password for this user.
blockedFor()
If user is blocked, return the specified reason for the block.
testAnonOptions()
T39963 Make sure defaults are loaded when setOption is called.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
testGetEditCountForAnons()
Test User::editCount medium User::getEditCount.
testAutoblockCookieNoSecretKey()
The BlockID cookie is normally verified with a HMAC, but not if wgSecretKey is not set.
testIpBlockCookieNotSet()
Block cookie should NOT be set when wgCookieSetOnIpBlock is disabled.
isHidden()
Check if user account is hidden.
testCheckPasswordValidity()
Test password validity checks.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
isPingLimitable()
Is this user subject to rate limiting?
clearInstanceCache( $reloadFrom=false)
Clear various cached data stored in this object.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
testUserPermissions()
User::getRights.
testIpBlockCookieSet()
Block cookie should be set for IP Blocks if wgCookieSetOnIpBlock is set to true.
setName( $str)
Set the user name.
saveSettings()
Save this user's settings into the database.
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
testIsPingLimitable()
User::isPingLimitable.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Allows to change the fields on the form that will be generated $name
they could even be mouse clicks or menu items whatever suits your program You should also get your if any
static getIdFromCookieValue( $cookieValue)
Get the stored ID from the 'BlockID' cookie.
getOption( $oname, $defaultOverride=null, $ignoreHidden=false)
Get the user's current setting for a given option.
testAutoblockCookiesDisabled()
Make sure that no cookie is set to track autoblocked users when $wgCookieSetOnAutoblock is false.
static provideGetCanonicalName()
checkAndSetTouched()
Bump user_touched if it didn't change since this object was loaded.
static getGroupPermissions( $groups)
Get the permissions associated with a given list of groups.
testIncEditCount()
Test User::editCount medium User::incEditCount.
testAutoblockCookieInfiniteExpiry()
When a user is autoblocked and a cookie is set to track them, the expiry time of the cookie should ma...
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format.
static getMain()
Get the RequestContext object associated with the main request.
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new user object.
blockedBy()
If user is blocked, return the name of the user who placed the block.
getDBTouched()
Get the user_touched timestamp field (time of last DB updates)
testGetGroupsWithPermission( $expected, $right)
provideGetGroupsWithPermission User::getGroupsWithPermission
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
getExperienceLevel()
Compute experienced level based on edit count and registration date.
static getMainWANInstance()
Get the main WAN cache object.
isLoggedIn()
Get whether the user is logged in.
static findUsersByGroup( $groups, $limit=5000, $after=null)
Return the users who are members of the given group(s).
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const SCHEMA_COMPAT_WRITE_BOTH
static newFromActorId( $id)
Static factory method for creation from a given actor ID.
testExperienceLevelAnon()
User::getExperienceLevel.
equals(UserIdentity $user)
Checks if two user objects point to the same user.
static selectFields()
Return the list of user fields that should be selected to create a new user object.
$wgGroupPermissions['sysop']['replacetext']
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
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 MediaWikiServices
isBlocked( $bFromSlave=true)
Check if user is blocked.
static purge( $wikiId, $userId)
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
setOption( $oname, $val)
Set the given option for a user.
this hook is for auditing only or null if authentication failed before getting that far $username
static provideUserNames()
getPasswordValidity( $password)
Given unvalidated password input, return error message on failure.
testRevokePermissions()
User::getGroupPermissions.
getName()
Get the user name, or the IP of an anonymous user.
testGetEditCount()
Test User::editCount medium User::getEditCount.
testEquals()
User::equals.
const SCHEMA_COMPAT_READ_OLD
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
testIsValidUserName( $username, $result, $message)
provideUserNames User::isValidUserName
testAutoblockCookies()
When a user is autoblocked a cookie is set with which to track them in case they log out and change I...
testNewFromIdentity()
User::newFromIdentity.
trackBlockWithCookie()
Set the 'BlockID' cookie depending on block type and user authentication status.