nordsoftware/yii2-account

<?php
/*
 * This file is part of Account.
 *
 * (c) 2014 Nord Software
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace nord\yii\account\models;

use nord\yii\account\Module;
use Yii;
use yii\base\Model;
use yii\db\ActiveRecord;
use yii\db\Expression;

class LoginForm extends Model
{
    /**
     * @var string
     */
    public $email;

    /**
     * @var string
     */
    public $password;

    /**
     * @var boolean
     */
    public $rememberMe = true;

    /**
     * @var Account
     */
    private $_account;

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['email', 'password'], 'required'],
            ['rememberMe', 'boolean'],
            ['password', 'validatePassword', 'skipOnError' => true],
            ['password', 'validateAccountActivated', 'skipOnError' => true],
            ['password', 'validateAccountNotLocked', 'skipOnError' => true],
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'email' => Module::t('labels', 'Email'),
            'password' => Module::t('labels', 'Password'),
            'rememberMe' => Module::t('labels', 'Remember Me'),
        ];
    }

    /**
     * Validates the password.
     *
     * @param string $attribute validated attribute.
     * @param array $params additional parameters.
     */
    public function validatePassword($attribute, $params)
    {
        $account = $this->getAccount();
        if ($account === null || !$account->validatePassword($this->password)) {
            $this->addError($attribute, Module::t('errors', 'Invalid email or password.'));
        }
    }

    /**
     * Validates that the account is activated.
     *
     * @param string $attribute validated attribute.
     * @param array $params additional parameters.
     */
    public function validateAccountActivated($attribute, $params)
    {
        $account = $this->getAccount();
        if ($account !== null && !Module::getInstance()->getDataContract()->isAccountActivated($account)) {
            $this->addError($attribute, Module::t('errors', 'Your account has not yet been activated.'));
        }
    }

    /**
     * Validates that the account is not locked.
     *
     * @param string $attribute validated attribute.
     * @param array $params additional parameters.
     */
    public function validateAccountNotLocked($attribute, $params)
    {
        $account = $this->getAccount();
        if ($account !== null && Module::getInstance()->getDataContract()->isAccountLocked($account)) {
            $this->addError($attribute,
                Module::t('errors', 'Your account has been locked due to too many failed login attempts.'));
        }
    }

    /**
     * Logs in a user using the provided email and password.
     *
     * @return boolean whether the user is logged in successfully
     */
    public function login()
    {
        if ($this->validate()) {
            $account = $this->getAccount();
            $duration = $this->rememberMe ? Module::getParam(Module::PARAM_LOGIN_EXPIRE_TIME) : 0;
            $success = Yii::$app->user->login($account, $duration);
            $this->createHistoryEntry($account, $success);
            $dataContract = Module::getInstance()->getDataContract();
            $dataContract->updateAccountAttributes($account, ['lastLoginAt' => new Expression('NOW()')]);
            return $success;
        } else {
            return false;
        }
    }

    /**
     * Creates a login history entry.
     *
     * @param ActiveRecord $account account instance.
     * @param boolean $success whether login was successful.
     */
    protected function createHistoryEntry(ActiveRecord $account, $success)
    {
        $dataContract = Module::getInstance()->getDataContract();
        $dataContract->createLoginHistory([
            'accountId' => $account->getPrimaryKey(),
            'success' => $success,
            'numFailedAttempts' => $success ? 0 : $dataContract->getAccountNumFailedLoginAttempts($account),
        ]);
    }

    /**
     * Returns the account associated with the value of the login attribute.
     *
     * @return Account model instance.
     */
    public function getAccount()
    {
        if ($this->_account === null) {
            $this->_account = Module::getInstance()->getDataContract()->findAccount(
                [Module::getInstance()->emailAttribute => $this->email]);
        }
        return $this->_account;
    }
}