Charcoal\User\Authenticator

Complexity

Total Complexity

23

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	login()	0	10	2
A	validateAuthentication()	0	10	3
B	touchUserLogin()	0	50	9
B	changeUserPassword()	0	56	9

<?php

namespace Charcoal\User;

use InvalidArgumentException;

// From 'charcoal-object'
use Charcoal\Object\ContentInterface;

// From 'charcoal-user'
use Charcoal\User\Access\AuthenticatableInterface;
use Charcoal\User\UserInterface;

/**
 * The User Authenticator
 */
class Authenticator extends AbstractAuthenticator
{
    /**
     * Log a user into the application.
     *
     * @param  AuthenticatableInterface $user     The authenticated user to log in.
     * @param  boolean                  $remember Whether to "remember" the user or not.
     * @return boolean Success / Failure
     */
    public function login(AuthenticatableInterface $user, $remember = false)
    {
        $result = parent::login($user, $remember);

Are you sure the assignment to $result is correct as parent::login($user, $remember) (which targets Charcoal\User\AbstractAuthenticator::login()) seems to always return null.

        if ($result) {
            $this->touchUserLogin($user);
        }

        return $result;
    }

    /**
     * Validate the user authentication state is okay.
     *
     * For example, inactive users can not authenticate.
     *
     * @param  AuthenticatableInterface $user The user to validate.
     * @return boolean
     */
    public function validateAuthentication(AuthenticatableInterface $user)
    {
        if ($user instanceof ContentInterface) {
            if (!$user['active']) {
                return false;
            }
        }

        return parent::validateAuthentication($user);
    }

    /**
     * Updates the user's timestamp for their last log in.
     *
     * @param  AuthenticatableInterface $user     The user to update.
     * @param  string                   $password The plain-text password to hash.

There is no parameter named $password. Was it maybe removed?

     * @param  boolean                  $update   Whether to persist changes to storage.
     * @return boolean Returns TRUE if the password was changed, or FALSE otherwise.
     */
    protected function touchUserLogin(AuthenticatableInterface $user, $update = true)
    {
        if (!($user instanceof UserInterface)) {
            return false;
        }

        if (!$user->getAuthId()) {
            throw new InvalidArgumentException(
                'Can not touch user: user has no ID'
            );
        }

        $userId = $user->getAuthId();

        if ($update && $userId) {
            $userClass = get_class($user);

            $this->logger->info(sprintf(
                'Updating last login fields for user "%s" (%s)',
                $userId,
                $userClass
            ));
        }

        $user['lastLoginDate'] = 'now';
        $user['lastLoginIp']   = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null;

        if ($update && $userId) {
            $result = $user->update([
                'last_login_ip',
                'last_login_date',
            ]);

            if ($result) {
                $this->logger->notice(sprintf(
                    'Last login fields were updated for user "%s" (%s)',
                    $userId,
                    $userClass

The variable $userClass does not seem to be defined for all execution paths leading up to this point.

                ));
            } else {
                $this->logger->warning(sprintf(
                    'Last login fields failed to be updated for user "%s" (%s)',
                    $userId,
                    $userClass
                ));
            }
        }

        return $result;

The variable $result does not seem to be defined for all execution paths leading up to this point.

    }

    /**
     * Updates the user's password hash.
     *
     * @param  AuthenticatableInterface $user     The user to update.
     * @param  string                   $password The plain-text password to hash.
     * @param  boolean                  $update   Whether to persist changes to storage.
     * @throws InvalidArgumentException If the password is invalid.
     * @return boolean Returns TRUE if the password was changed, or FALSE otherwise.
     */
    protected function changeUserPassword(AuthenticatableInterface $user, $password, $update = true)
    {
        if (!($user instanceof UserInterface)) {
            return parent::changeUserPassword($user, $password);
        }

        if (!$this->validateAuthPassword($password)) {
            throw new InvalidArgumentException(
                'Can not reset password: password is invalid'
            );
        }

        $userId = $user->getAuthId();

        if ($update && $userId) {
            $userClass = get_class($user);

            $this->logger->info(sprintf(
                'Changing password for user "%s" (%s)',
                $userId,
                $userClass
            ));
        }

        $passwordKey = $user->getAuthPasswordKey();

        $user[$passwordKey]       = password_hash($password, PASSWORD_DEFAULT);
        $user['lastPasswordDate'] = 'now';
        $user['lastPasswordIp']   = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null;

        if ($update && $userId) {
            $result = $user->update([
                $passwordKey,
                'last_password_date',
                'last_password_ip',
            ]);

            if ($result) {
                $this->logger->notice(sprintf(
                    'Password was changed for user "%s" (%s)',
                    $userId,
                    $userClass

The variable $userClass does not seem to be defined for all execution paths leading up to this point.

                ));
            } else {
                $this->logger->warning(sprintf(
                    'Password failed to be changed for user "%s" (%s)',
                    $userId,
                    $userClass
                ));
            }

            return $result;
        }

        return true;
    }
}