firefly-iii/app/Http/Middleware/Authenticate.php

<?php

/**
 * Authenticate.php
 * Copyright (c) 2019 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Http\Middleware;

use Closure;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\User;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Contracts\Auth\Factory as Auth;
use Illuminate\Http\Request;
use Log;

/**
 * Class Authenticate
 */
class Authenticate
{
    /**
     * The authentication factory instance.
     *
     * @var Auth
     */
    protected $auth;

    /**
     * Create a new middleware instance.
     *
     * @param  Auth  $auth
     *
     * @return void
     */
    public function __construct(Auth $auth)
    {
        $this->auth = $auth;
    }

    /**
     * Handle an incoming request.
     *
     * @param  Request  $request
     * @param  Closure  $next
     * @param  string[]  ...$guards
     *
     * @return mixed
     *
     * @throws FireflyException
     * @throws AuthenticationException
     */
    public function handle($request, Closure $next, ...$guards)
    {
        $this->authenticate($request, $guards);

        return $next($request);
    }

    /**
     * Determine if the user is logged in to any of the given guards.
     *
     * @param  mixed  $request
     * @param  array  $guards
     *
     * @return mixed
     * @throws FireflyException
     * @throws AuthenticationException
     */
    protected function authenticate($request, array $guards)
    {
        Log::debug(sprintf('Now in %s', __METHOD__));
        if (0 === count($guards)) {
            Log::debug('No guards present.');
            // go for default guard:
            /** @noinspection PhpUndefinedMethodInspection */
            if ($this->auth->check()) {
                Log::debug('Default guard says user is authenticated.');
                // do an extra check on user object.
                /** @noinspection PhpUndefinedMethodInspection */
                /** @var User $user */
                $user = $this->auth->authenticate();
                $this->validateBlockedUser($user, $guards);
            }

            return $this->auth->authenticate(); // @phpstan-ignore-line (thinks function returns void)
        }
        Log::debug('Guard array is not empty.');

        foreach ($guards as $guard) {
            Log::debug(sprintf('Now in guard loop, guard is "%s"', $guard));
            if ('api' !== $guard) {
                Log::debug('Guard is "api", call authenticate()');
                $this->auth->guard($guard)->authenticate();
            }
            $result = $this->auth->guard($guard)->check();
            Log::debug(sprintf('Result is %s', var_export($result, true)));
            if ($result) {
                Log::debug('Guard says user is authenticated.');
                $user = $this->auth->guard($guard)->user();
                $this->validateBlockedUser($user, $guards);
                // According to PHPstan the method returns void, but we'll see.
                return $this->auth->shouldUse($guard); // @phpstan-ignore-line
            }
        }

        throw new AuthenticationException('Unauthenticated.', $guards);
    }

    /**
     * @param  User|null  $user
     * @param  array  $guards
     * @return void
     * @throws AuthenticationException
     */
    private function validateBlockedUser(?User $user, array $guards): void
    {
        Log::debug(sprintf('Now in %s', __METHOD__));
        if (null === $user) {
            Log::warning('User is null, throw exception?');
        }
        if (null !== $user) {
            // Log::debug(get_class($user));
            if (1 === (int)$user->blocked) {
                $message = (string)trans('firefly.block_account_logout');
                if ('email_changed' === $user->blocked_code) {
                    $message = (string)trans('firefly.email_changed_logout');
                }
                Log::warning('User is blocked, cannot use authentication method.');
                app('session')->flash('logoutMessage', $message);
                $this->auth->logout(); // @phpstan-ignore-line (thinks function is undefined)

                throw new AuthenticationException('Blocked account.', $guards);
            }
        }
    }
}