Part-DB / Part-DB-symfony

src/EventSubscriber/UserSystem/UpgradePermissionsSchemaSubscriber.php

<?php
/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
 *
 *  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/>.
 */

namespace App\EventSubscriber\UserSystem;

use App\Entity\UserSystem\User;
use App\Services\LogSystem\EventCommentHelper;
use App\Services\UserSystem\PermissionSchemaUpdater;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\Security\Core\Security;

/**
 * The purpose of this event subscriber is to check if the permission schema of the current user is up to date and upgrade it automatically if needed.
 */
class UpgradePermissionsSchemaSubscriber implements EventSubscriberInterface
{
    private Security $security;
    private PermissionSchemaUpdater $permissionSchemaUpdater;
    private EntityManagerInterface $entityManager;
    private FlashBagInterface $flashBag;
    private EventCommentHelper $eventCommentHelper;

    public function __construct(Security $security, PermissionSchemaUpdater $permissionSchemaUpdater, EntityManagerInterface $entityManager, FlashBagInterface $flashBag, EventCommentHelper $eventCommentHelper)
    {
        $this->security = $security;
        $this->permissionSchemaUpdater = $permissionSchemaUpdater;
        $this->entityManager = $entityManager;
        $this->flashBag = $flashBag;
        $this->eventCommentHelper = $eventCommentHelper;
    }

    public function onRequest(RequestEvent $event): void
    {
        if (!$event->isMainRequest()) {
            return;
        }

        $user = $this->security->getUser();
        if (null === $user) {
            //Retrieve anonymous user
            $user = $this->entityManager->getRepository(User::class)->getAnonymousUser();
        }

        if ($this->permissionSchemaUpdater->isSchemaUpdateNeeded($user)) {

It seems like $user can also be of type Symfony\Component\Security\Core\User\UserInterface and null; however, parameter $holder of App\Services\UserSystem\PermissionSchemaUpdater::isSchemaUpdateNeeded() does only seem to accept App\Security\Interfaces\HasPermissionsInterface, maybe add an additional type check?

            $this->eventCommentHelper->setMessage('Automatic permission schema update');
            $this->permissionSchemaUpdater->userUpgradeSchemaRecursively($user);

It seems like $user can also be of type null; however, parameter $user of App\Services\UserSystem\PermissionSchemaUpdater::userUpgradeSchemaRecursively() does only seem to accept App\Entity\UserSystem\User, maybe add an additional type check?

            $this->entityManager->flush();
            $this->flashBag->add('notice', 'user.permissions_schema_updated');
        }
    }

    public static function getSubscribedEvents(): array
    {
        return [KernelEvents::REQUEST => 'onRequest'];
    }
}