Scif\LaravelPretend\Service\Impersonator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	exitImpersonation()	0	15	2
A	retrieveUser()	0	14	2
A	enterImpersonation()	0	18	3
A	isImpersonated()	0	4	1
A	continueImpersonation()	0	6	1
A	getImpersonatingIdentifier()	0	4	1

<?php declare(strict_types=1);

namespace Scif\LaravelPretend\Service;

use HttpException;
use Illuminate\Auth\AuthManager;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Contracts\Config\Repository;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Session\Store;
use Scif\LaravelPretend\Event\Impersonated;
use Scif\LaravelPretend\Event\Unimpersonated;

class Impersonator
{
    /** @var  Guard $guard */
    protected $guard;

    /** @var Repository $config */
    protected $config;

    /** @var  UserProvider */
    protected $userProvider;

    /** @var Store $session */
    protected $session;

    /** @var Dispatcher $eventDispatcher */
    protected $eventDispatcher;

    /** @var  Authenticatable */
    protected $impersonationUser;

    /** @var  bool */
    protected $isForbidden;

    const SESSION_NAME = 'pretend:_switch_user';

    public function __construct(
        AuthManager $auth,
        Repository $config,
        UserProvider $userProvider,
        Store $session,
        Dispatcher $eventDispatcher
    ) {
        $this->guard           = $auth->guard();
        $this->config          = $config;
        $this->userProvider    = $userProvider;
        $this->session         = $session;
        $this->eventDispatcher = $eventDispatcher;
        $this->isForbidden     = false;
    }

    /**
     * @throws HttpException Throw 403 exception if cannot find user
     */
    public function exitImpersonation()
    {
        $username = $this->session->get(static::SESSION_NAME);

        if (null === $username) {
            return;
        }

        $this->session->remove(static::SESSION_NAME);

        $user  = $this->retrieveUser($username);
        $event = new Unimpersonated($this->guard->user(), $user);

It seems like $this->guard->user() can be null; however, __construct() does not accept null, maybe add an additional type check?

        $this->eventDispatcher->fire($event);

The method fire() does not seem to exist on object<Illuminate\Contracts\Events\Dispatcher>.

    }

    /**
     * @throws HttpException Throw 403 exception if cannot find user
     */
    protected function retrieveUser(string $username): Authenticatable
    {
        $conditions = [
            $this->config->get('pretend.impersonate.user_identifier') => $username,
        ];

        $user = $this->userProvider->retrieveByCredentials($conditions);

        if (null === $user) {
            abort(403, 'Cannot find user by this credentials');
        }

        return $user;
    }

    /**
     * @throws HttpException Throw 403 exception if you try to impersonate yourself
     *
     * @param string $username Username of user you want to enter impersonate
     */
    public function enterImpersonation(string $username)
    {
        $user     = $this->retrieveUser($username);
        $realUser = $this->guard->user();

        if ($user->getAuthIdentifier() === $realUser->getAuthIdentifier()) {
            abort(403, 'Cannot impersonate yourself');
        }

        $this->impersonationUser = $user;
        $this->guard->setUser($user);

        if (!$this->session->has(static::SESSION_NAME)) {
            $this->session->put(static::SESSION_NAME, $username);

            $this->eventDispatcher->fire(new Impersonated($realUser, $user));

It seems like $realUser defined by $this->guard->user() on line 101 can be null; however, Scif\LaravelPretend\Event\Impersonated::__construct() does not accept null, maybe add an additional type check?

The method fire() does not seem to exist on object<Illuminate\Contracts\Events\Dispatcher>.

        }
    }

    public function isImpersonated(): bool
    {
        return $this->session->has(static::SESSION_NAME);
    }

    /**
     * @throws HttpException Throw 403 exception if cannot find data in session
     */
    public function continueImpersonation()
    {
        $name = $this->getImpersonatingIdentifier();

        $this->enterImpersonation($name);
    }

    public function getImpersonatingIdentifier(): string
    {
        return $this->session->get(static::SESSION_NAME, '');
    }
}