How to add captcha required only for a particular condition yii2

Question

I am trying make the captcha field required only when the number of failed login attempts exceed 3 times. For which I have written below code till now.

In LoginForm model I have added the below rules

 public function rules()
 {
    return [
        [['username', 'password'], 'required'],
        ['password', 'validatePassword'],
        ['verifyCode', 'captcha', 'when' => function($model) {
            return $this->checkattempts();
        }],
    ];
 }

  public function validatePassword($attribute, $params)
{
    if (!$this->hasErrors()) {
        $user = $this->getUser();
        if (!$user || !$user->validatePassword($this->password)) {
        $this->addLoginAttempt($user->id);
        $this->addError($attribute, 'Incorrect username or password.');
        }
    }
}

 public function checkattempts()
  {
    $user = $this->getUser();
    $ip = $this->get_client_ip();
    $data = (new Query())->select('*')  
                ->from('login_attempts')
                ->where(['ip' => $ip])->andWhere(['user_ref_id' => $user->id])
                ->one();
    if($data["attempts"] >=3){
        return false;
    }else{
        return true;
    }
}   

public function addLoginAttempt($uid) {
    $ip = $this->get_client_ip();
   $data = (new Query())->select('*')   
                ->from('login_attempts')
                ->where(['ip' => $ip])->andWhere(['user_ref_id' => $uid])
                ->one();
   if($data)
   {
     $attempts = $data["attempts"]+1; 
        @Yii::$app->db->createCommand("UPDATE login_attempts SET attempts=".$attempts." where ip = '$ip' AND user_ref_id=$uid")->execute();
   }
   else {
    Yii::$app->db->createCommand("INSERT into login_attempts (attempts, user_ref_id, ip) VALUES(1,'$uid', '$ip')")->execute();
   }
 }

Here I am validating the password first. If the password is incorrect then I am incrementing the count by 1. This part is working fine. The count is incrementing successfully.

After this I am trying to get the count of failed attempts while validating captcha using the function checkattempts(), but it is not working.

Can anyone please tell me where I have made mistake.

Thanks in advance.

Answer 1

In your model:

if (!$model->checkattempts())
//show the captcha

Then, in your model rules you'll need something like:

['captcha', 'captcha'],

In your case, what you can do is use different scenarios depending on the user attempts, and in one scenario (more than X attempts) make the captcha required.

More documentation about the captcha and about scenarios.