Part-DB.Part-DB-server/src/Services/UserCacheKeyGenerator.php

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

declare(strict_types=1);

/**
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 * Copyright (C) 2019 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 General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

namespace App\Services;

use App\Entity\UserSystem\User;
use Locale;
use Symfony\Component\Security\Core\Security;

/**
 * Purpose of this service is to generate a key unique for a user, to use in Cache keys and tags.
 */
class UserCacheKeyGenerator
{
    protected Security $security;

    public function __construct(Security $security)
    {
        $this->security = $security;
    }

    /**
     * Generates a key for the given user.
     *
     * @param User|null $user The user for which the key should be generated. When set to null, the currently logged in
     *                        user is used.
     */
    public function generateKey(?User $user = null): string
    {
        $locale = Locale::getDefault();

        //If no user was specified, use the currently used one.
        if (null === $user) {
            $user = $this->security->getUser();
        }

        if (!$user instanceof User){
           throw new \RuntimeException('UserCacheKeyGenerator::generateKey() was called without a user, but no user is logged in!');
        }

        //If the user is null, then treat it as anonymous user.
        //When the anonymous user is passed as user then use this path too.
        if (null === $user || User::ID_ANONYMOUS === $user->getID()) {
            return 'user$_'.User::ID_ANONYMOUS;
        }

        //In the most cases we can just use the username (its unique)
        return 'user_'.$user->getUsername().'_'.$locale;
    }
}