From bafd980e7d743e9db30d48d3aecd5eee4462585a Mon Sep 17 00:00:00 2001 From: MusikAnimal Date: Tue, 18 Apr 2017 16:30:48 +0000 Subject: [PATCH] Rename functions so as to not confuse with with CheckUser extension Bug: T162748 Change-Id: If2ad9d65cedc8124b2570e2b66574736a8f112f9 --- LoginNotify.hooks.php | 2 +- LoginNotify_body.php | 28 ++++++++++++++-------------- tests/phpunit/LoginNotifyTests.php | 18 +++++++++--------- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/LoginNotify.hooks.php b/LoginNotify.hooks.php index 3c9c706..3fa6426 100644 --- a/LoginNotify.hooks.php +++ b/LoginNotify.hooks.php @@ -100,7 +100,7 @@ class LoginNotifyHooks { /** * Old hook for pre 1.27 or wikis with auth manager disabled. * - * @todo Doesn't catcha captcha or throttle failures + * @todo Doesn't catch CAPTCHA or throttle failures * @param User $user User in question. * @param string $pass The password (parameter not used). * @param integer $retval A LoginForm constant (e.g. LoginForm::SUCCESS). diff --git a/LoginNotify_body.php b/LoginNotify_body.php index 4e473bd..71e6f2c 100644 --- a/LoginNotify_body.php +++ b/LoginNotify_body.php @@ -99,18 +99,18 @@ class LoginNotify implements LoggerAwareInterface { * @return boolean true if the user has used this computer before */ private function isFromKnownIP( User $user ) { - $cookieResult = $this->checkUserInCookie( $user ); + $cookieResult = $this->isUserInCookie( $user ); if ( $cookieResult === true ) { // User has cookie return true; } - $cacheResult = $this->checkUserInCache( $user ); + $cacheResult = $this->isUserInCache( $user ); if ( $cacheResult === true ) { return true; } - $cuResult = $this->checkUserInCheckUser( $user ); + $cuResult = $this->isUserInCheckUser( $user ); if ( $cuResult === true ) { return true; } @@ -145,7 +145,7 @@ class LoginNotify implements LoggerAwareInterface { * @param $user User User in question. * @return Mixed true, false or self::NO_INFO_AVAILABLE. */ - private function checkUserInCache( User $user ) { + private function isUserInCache( User $user ) { $ipPrefix = $this->getIPNetwork( $user->getRequest()->getIP() ); $key = $this->getKey( $user, 'prevSubnet' ); $res = $this->cache->get( $key ); @@ -164,7 +164,7 @@ class LoginNotify implements LoggerAwareInterface { * @param $user User User in question. * @return Mixed true, false or self::NO_INFO_AVAILABLE. */ - private function checkUserInCheckUser( User $user ) { + private function isUserInCheckUser( User $user ) { if ( !$this->config->get( 'LoginNotifyCheckKnownIPs' ) || !class_exists( 'CheckUser' ) ) { @@ -177,13 +177,13 @@ class LoginNotify implements LoggerAwareInterface { $prefix = $this->getIPNetwork( $user->getRequest()->getIP() ); $dbr = wfGetDB( DB_SLAVE ); - $localResult = $this->checkUserInCheckUserQuery( $user->getId(), $prefix, $dbr ); + $localResult = $this->isUserInCheckUserQuery( $user->getId(), $prefix, $dbr ); if ( $localResult ) { return true; } if ( !$haveAnyInfo ) { - $haveAnyInfo = $this->checkUserInCheckUserAnyInfo( $user->getId(), $dbr ); + $haveAnyInfo = $this->isUserInCheckUserAnyInfo( $user->getId(), $dbr ); } // Also check checkuser table on the top ten wikis where this user has @@ -220,7 +220,7 @@ class LoginNotify implements LoggerAwareInterface { } // FIXME The case where there are no CU entries for // this user. - $res = $this->checkUserInCheckUserQuery( + $res = $this->isUserInCheckUserQuery( $localInfo['id'], $prefix, $dbrLocal @@ -231,7 +231,7 @@ class LoginNotify implements LoggerAwareInterface { return true; } if ( !$haveAnyInfo ) { - $haveAnyInfo = $this->checkUserInCheckUserAnyInfo( $user->getId(), $dbr ); + $haveAnyInfo = $this->isUserInCheckUserAnyInfo( $user->getId(), $dbr ); } $lb->reuseConnection( $dbrLocal ); $count++; @@ -253,7 +253,7 @@ class LoginNotify implements LoggerAwareInterface { * @param $dbr Database A database connection (possibly foreign) * @return boolean If $ipFragment is in check user db */ - private function checkUserInCheckUserQuery( $userId, $ipFragment, Database $dbr ) { + private function isUserInCheckUserQuery( $userId, $ipFragment, Database $dbr ) { // For some unknown reason, the index is on // (cuc_user, cuc_ip, cuc_timestamp), instead of // cuc_ip_hex which would be ideal. @@ -284,7 +284,7 @@ class LoginNotify implements LoggerAwareInterface { * @param $userId int User id number (possibly on foreign wiki) * @param $dbr Database DB connection (possibly to foreign wiki) */ - private function checkUserInCheckUserAnyInfo( $userId, Database $dbr ) { + private function isUserInCheckUserAnyInfo( $userId, Database $dbr ) { // Verify that we actually have IP info for // this user. // @todo: Should this instead be if we have a @@ -378,7 +378,7 @@ class LoginNotify implements LoggerAwareInterface { * @param User $user User in question * @return boolean|integer Either true, false, or self::NO_INFO_AVAILABLE. */ - private function checkUserInCookie( User $user ) { + private function isUserInCookie( User $user ) { $cookie = $this->getPrevLoginCookie( $user->getRequest() ); if ( $cookie === '' ) { // FIXME, does this really make sense? @@ -425,7 +425,7 @@ class LoginNotify implements LoggerAwareInterface { // Skip invalid or old cookie records. continue; } - $curUser = $this->checkUserRecordGivenCookie( $user, $cookieRecords[$i] ); + $curUser = $this->isUserRecordGivenCookie( $user, $cookieRecords[$i] ); $userSeenBefore = $userSeenBefore || $curUser; if ( $i < $maxCookieRecords && !$curUser ) { $newCookie .= '.' . $cookieRecords[$i]; @@ -446,7 +446,7 @@ class LoginNotify implements LoggerAwareInterface { * can after the fact figure out a single user has used both * machines. */ - private function checkUserRecordGivenCookie( User $user, $cookieRecord ) { + private function isUserRecordGivenCookie( User $user, $cookieRecord ) { if ( !$this->validateCookieRecord( $cookieRecord ) ) { // Most callers will probably already check this, but // doesn't hurt to be careful. diff --git a/tests/phpunit/LoginNotifyTests.php b/tests/phpunit/LoginNotifyTests.php index 3438569..7999aca 100644 --- a/tests/phpunit/LoginNotifyTests.php +++ b/tests/phpunit/LoginNotifyTests.php @@ -84,14 +84,14 @@ class LoginNotifyTests extends MediaWikiTestCase { } /** - * @dataProvider provideCheckUserRecordGivenCookie + * @dataProvider provideIsUserRecordGivenCookie */ - public function testCheckUserRecordGivenCookie( User $user, $cookieRecord, $expected, $desc ) { - $actual = $this->inst->checkUserRecordGivenCookie( $user, $cookieRecord ); + public function testIsUserRecordGivenCookie( User $user, $cookieRecord, $expected, $desc ) { + $actual = $this->inst->isUserRecordGivenCookie( $user, $cookieRecord ); $this->assertEquals( $expected, $actual, "For {$user->getName()} on test $desc." ); } - public function provideCheckUserRecordGivenCookie() { + public function provideIsUserRecordGivenCookie() { $this->setUpLoginNotify(); $u = User::newFromName( 'Foo', false ); $cookie1 = $this->inst->generateUserCookieRecord( 'Foo2' ); @@ -208,7 +208,7 @@ class LoginNotifyTests extends MediaWikiTestCase { if ( !isset( $newCookieParts[1] ) ) { $newCookieParts[1] = ''; } - $this->assertTrue( $this->inst->checkUserRecordGivenCookie( $user, $newCookieParts[0] ), "[Cookie new entry] $desc" ); + $this->assertTrue( $this->inst->isUserRecordGivenCookie( $user, $newCookieParts[0] ), "[Cookie new entry] $desc" ); $this->assertEquals( $expectedNewCookie, $newCookieParts[1], "[Cookie] $desc" ); } @@ -300,18 +300,18 @@ class LoginNotifyTests extends MediaWikiTestCase { ]; } - public function testCheckUserInCache() { + public function testIsUserInCache() { $u = User::newFromName( 'Xyzzy' ); $uWrap = TestingAccessWrapper::newFromObject( $u ); - $this->assertEquals( $this->inst->checkUserInCache( $u ), LoginNotify::NO_INFO_AVAILABLE ); + $this->assertEquals( $this->inst->IsUserInCache( $u ), LoginNotify::NO_INFO_AVAILABLE ); $this->inst->cacheLoginIP( $u ); - $this->assertTrue( $this->inst->checkUserInCache( $u ) ); + $this->assertTrue( $this->inst->IsUserInCache( $u ) ); $uWrap->mRequest = new FauxRequest(); $uWrap->mRequest->setIP( '10.1.2.3' ); - $this->assertFalse( $this->inst->checkUserInCache( $u ) ); + $this->assertFalse( $this->inst->IsUserInCache( $u ) ); } } // @codingStandardsIgnoreEnd