DoorGuard.php

<?php


namespace App\Guards;

use Source\Entities\Door;
use Illuminate\Http\Request;
use Illuminate\Auth\GuardHelpers;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\Authenticatable;
use Source\Gateways\Doors\DatabaseDoorsRepository;
use Source\UseCases\Door\Authenticate\AuthenticateUseCase;
use Source\UseCases\Door\Authenticate\TranslationPresenter;

class DoorGuard implements Guard
{
    use GuardHelpers;

    /**
     * The request instance.
     *
     * @var Request
     */
    protected Request $request;

    /**
     * The name of the query string item from the request containing the API token.
     *
     * @var string
     */
    protected string $inputKey;

    /**
     * @var AuthenticateUseCase
     */
    protected AuthenticateUseCase $authenticator;

    /**
     * Create a new authentication guard.
     *
     * @param AuthenticateUseCase $authenticator
     * @param Request             $request
     * @param string              $inputKey
     */
    public function __construct(
        AuthenticateUseCase $authenticator,
        Request $request,
        $inputKey = 'api_token'
    ) {
        $this->request = $request;
        $this->inputKey = $inputKey;
        $this->authenticator = $authenticator;
    }

    /**
     * Get the currently authenticated user.
     *
     * @return Authenticatable|\Source\Entities\Door|null
     */
    public function user()
    {
        // If we've already retrieved the user for the current request we can just
        // return it back immediately. We do not want to fetch the user data on
        // every call to this method because that would be tremendously slow.
        if ($this->user !== null) {
            return $this->user;
        }

        $token = $this->getTokenForRequest();

        $user = $this->retrieveByToken($token);

        return $this->user = $user;
    }

    /**
     * @return \Source\Entities\Door|null
     */
    public function getDoor(): ?Door
    {
        /** @var \App\Door|null $door */
        $door = $this->user();

        if ($door) {
            return DatabaseDoorsRepository::makeDoorFromDb($door);
        }

        return null;
    }

    /**
     * Get the token for the current request.
     *
     * @return string|null
     */
    protected function getTokenForRequest(): ?string
    {
        $token = $this->request->bearerToken();

        if (empty($token)) {
            $token = $this->request->input($this->inputKey);
        }

        return $token;
    }

    /**
     * Validate a user's credentials.
     *
     * @param array $credentials
     * @return bool
     */
    public function validate(array $credentials = [])
    {
        if (!isset($credentials[$this->inputKey])) {
            return false;
        }

        return (bool)$this->retrieveByToken($credentials[$this->inputKey]);
    }

    protected function getDoorVersion(): ?string
    {
        return $this->request->header('Door-Controller-Version', null);
    }

    /**
     * @param string|null $token
     *
     * @return Authenticatable|null
     */
    protected function retrieveByToken(?string $token): ?Authenticatable
    {
        $presenter = new TranslationPresenter();

        $version = $this->getDoorVersion();

        $this->authenticator->check($presenter, $token, $version);

        return $presenter->getViewModel();
    }
}