wikimedia/mediawiki-extensions-LoginNotify
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/LoginNotify synced 2024-11-15 03:04:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Fix various docblock formatting"

Browse source
This commit is contained in:
jenkins-bot 2017-04-05 13:03:45 +00:00 committed by Gerrit Code Review
parent 733fb5eb2f 8a10910992
commit a9f9d1ed03
2 changed files with 48 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
LoginNotify.hooks.php
View file

@ -16,9 +16,9 @@ class LoginNotifyHooks {
/**
* Add LoginNotify events to Echo
*
* @param $notifications array of Echo notifications
* @param $notificationCategories array of Echo notification categories
* @param $icons array of icon details
* @param string[] &$notifications Array of Echo notifications
* @param string[] &$notificationCategories Array of Echo notification categories
* @param string[] &$icons Array of icon details
* @return bool
*/
public static function onBeforeCreateEchoEvent(
@ -83,9 +83,9 @@ class LoginNotifyHooks {
* Old hook for pre 1.27 or wikis with auth manager disabled.
*
* @todo Doesn't catcha captcha or throttle failures
* @param $user User User in question
* @param $pass String password
* @param $retval int LoginForm constant (e.g. LoginForm::SUCCESS)
* @param User $user User in question.
* @param string $pass The password (parameter not used).
* @param integer $retval A LoginForm constant (e.g. LoginForm::SUCCESS).
*/
public static function onLoginAuthenticateAudit( User $user, $pass, $retval ) {
if ( $retval === LoginForm::WRONG_PASS ) {
@ -98,9 +98,9 @@ class LoginNotifyHooks {
/**
* Hook for login auditing post 1.27
*
* @param $ret AuthenticationResponse Is login succesful?
* @param $user User|null User object on successful auth
* @param $username String Username for failed attempts.
* @param AuthenticationResponse $ret Is login successful?
* @param User|null $user User object on successful auth
* @param string $username Username for failed attempts.
*/
public static function onAuthManagerLoginAuthenticateAudit(
AuthenticationResponse $ret, $user, $username
@ -123,6 +123,12 @@ class LoginNotifyHooks {
// statuses.
}
/**
* Handle a successful login (clear the attempt counter, send a notice, and record the
* current IP address as known).
*
* @param User $user The user who logged in.
*/
public static function doSuccessfulLogin( User $user ) {
$loginNotify = new LoginNotify();
$loginNotify->clearCounters( $user );
@ -130,6 +136,11 @@ class LoginNotifyHooks {
$loginNotify->setCurrentAddressAsKnown( $user );
}
/**
* Handle a failed login (record the failure).
*
* @param User $user The user that failed to log in.
*/
public static function doFailedLogin( User $user ) {
$loginNotify = new LoginNotify();
$loginNotify->recordFailure( $user );
@ -140,8 +151,8 @@ class LoginNotifyHooks {
*
* Set a cookie saying this is a known computer when creating an account.
*
* @todo This still sets cookies if user creates account well logged in as someone else.
* @param User $user
* @todo This still sets cookies if user creates an account while logged in as someone else.
* @param User $user The user that has been created.
* @param boolean $byMail Account created by email
*/
public static function onAddNewAccount( User $user, $byMail ) {
@ -173,8 +184,8 @@ class LoginNotifyHooks {
* This is a bit hacky. Used to be able to set a different
* default for admins then other users
*
* @param $user User
* @param &$options array
* @param User $user The user in question.
* @param mixed[] &$options The options.
* @return bool
*/
public static function onUserLoadOptions( User $user, array &$options ) {
@ -215,8 +226,8 @@ class LoginNotifyHooks {
* @todo This is a bit icky. Need to decide if we really want to do this.
* @todo If someone explicitly enables, gets admin rights, gets de-admined,
* this will then disable the preference, which is definitely non-ideal.
* @param $user User
* @param &$options array
* @param User $user The user that is being saved.
* @param mixed[] &$options The options.
* @return bool
*/
public static function onUserSaveOptions( User $user, array &$options ) {

40
LoginNotify_body.php
View file

@ -26,15 +26,14 @@ class LoginNotify implements LoggerAwareInterface {
private $config;
/** @var LoggerInterface Usually instance of LoginNotify log */
private $log;
/** @var Salt for cookie hash */
/** @var string|boolean Salt for cookie hash */
private $gSalt;
/**
* Constructor
*
* @param $cfg Config Optional. Set if you have handy.
* @param $cache BagOStuff Optional. Only set if you want to override default
* caching behaviour.
* @param Config $cfg Optional. Set if you have handy.
* @param BagOStuff $cache Optional. Only set if you want to override default caching behaviour.
*/
public function __construct( Config $cfg = null, BagOStuff $cache = null ) {
if ( !$cache ) {
@ -59,6 +58,10 @@ class LoginNotify implements LoggerAwareInterface {
$this->log = $log;
}
/**
* Set the logger.
* @param LoggerInterface $logger The logger object.
*/
public function setLogger( LoggerInterface $logger ) {
$this->log = $logger;
}
@ -345,7 +348,7 @@ class LoginNotify implements LoggerAwareInterface {
*
* It is expected this be called upon successful log in.
*
* @param $user User The user in question.
* @param User $user The user in question.
*/
public function setCurrentAddressAsKnown( User $user ) {
$this->cacheLoginIP( $user );
@ -353,9 +356,9 @@ class LoginNotify implements LoggerAwareInterface {
}
/**
* Cache the current IP subnet as being known location for user
* Cache the current IP subnet as being a known location for the given user.
*
* @param $user User
* @param User $user The user.
*/
private function cacheLoginIP( User $user ) {
// For simplicity, this only stores the last IP subnet used.
@ -365,15 +368,15 @@ class LoginNotify implements LoggerAwareInterface {
if ( $expiry !== false ) {
$ipPrefix = $this->getIPNetwork( $user->getRequest()->getIP() );
$key = $this->getKey( $user, 'prevSubnet' );
$res = $this->cache->set( $key, $ipPrefix, $expiry );
$this->cache->set( $key, $ipPrefix, $expiry );
}
}
/**
* Check if a certain user is in the cookie.
*
* @param $user User User in question
* @return Mixed true, false or self::NO_INFO_AVAILABLE.
* @param User $user User in question
* @return boolean|integer Either true, false, or self::NO_INFO_AVAILABLE.
*/
private function checkUserInCookie( User $user ) {
$cookie = $this->getPrevLoginCookie( $user->getRequest() );
@ -400,10 +403,11 @@ class LoginNotify implements LoggerAwareInterface {
*
* When generating a new cookie, it will add the current user to the top,
* remove any previous instances of the current user, and remove older user
* references, if there is too many records.
* references, if there are too many records.
*
* @param $user User User that person is attempting to log in as
* @param $cookie String A cookie, which has records separated by '!'
* @param user $user User that person is attempting to log in as.
* @param string $cookie A cookie, which has records separated by '.'.
* @return array Element 0 is boolean (user seen before?), 1 is the new cookie value.
*/
private function checkAndGenerateCookie( User $user, $cookie ) {
$userSeenBefore = false;
@ -607,10 +611,10 @@ class LoginNotify implements LoggerAwareInterface {
/**
* Clear attempt counter for user.
*
* When a user succesfully logs in, we start back from 0, as
* When a user successfully logs in, we start back from 0, as
* otherwise a mistake here and there will trigger the warning.
*
* @param $user User
* @param user $user The user for whom to clear the attempt counter.
*/
public function clearCounters( User $user ) {
$cache = $this->cache;
@ -624,7 +628,7 @@ class LoginNotify implements LoggerAwareInterface {
/**
* On login failure, record failure and maybe send notice
*
* @param $user User The user whose account was attempted to log into
* @param User $user The user whose account was attempted to log into.
*/
public function recordFailure( User $user ) {
$fromKnownIP = $this->isFromKnownIP( $user );
@ -636,9 +640,9 @@ class LoginNotify implements LoggerAwareInterface {
}
/**
* Send a notice on successful login if not known ip
* Send a notice on successful login from an unknown IP.
*
* @param $user User Account in question
* @param User $user User account in question.
*/
public function sendSuccessNotice( User $user ) {
if ( $this->config->get( 'LoginNotifyEnableOnSuccess' )