Log the name of the CLI user, when actions were done from the CLI.

This commit is contained in:
Jan Böhmer 2023-04-07 22:44:59 +02:00
parent c91a6640ff
commit 6443d8e2bf
6 changed files with 124 additions and 2 deletions

View file

@ -24,6 +24,7 @@ namespace App\Services\LogSystem;
use App\Entity\LogSystem\AbstractLogEntry;
use App\Entity\UserSystem\User;
use App\Services\Misc\ConsoleInfoHelper;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Security\Core\Security;
@ -34,14 +35,17 @@ class EventLogger
protected array $whitelist;
protected EntityManagerInterface $em;
protected Security $security;
protected ConsoleInfoHelper $console_info_helper;
public function __construct(int $minimum_log_level, array $blacklist, array $whitelist, EntityManagerInterface $em, Security $security)
public function __construct(int $minimum_log_level, array $blacklist, array $whitelist, EntityManagerInterface $em,
Security $security, ConsoleInfoHelper $console_info_helper)
{
$this->minimum_log_level = $minimum_log_level;
$this->blacklist = $blacklist;
$this->whitelist = $whitelist;
$this->em = $em;
$this->security = $security;
$this->console_info_helper = $console_info_helper;
}
/**
@ -67,6 +71,11 @@ class EventLogger
$logEntry->setUser($user);
}
//Set the console user info, if the log entry was created in a console command
if ($this->console_info_helper->isCLI()) {
$logEntry->setCLIUser($this->console_info_helper->getCLIUser() ?? 'Unknown');
}
if ($this->shouldBeAdded($logEntry)) {
$this->em->persist($logEntry);

View file

@ -0,0 +1,63 @@
<?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\Services\Misc;
class ConsoleInfoHelper
{
/**
* Returns true if the current script is executed in a CLI environment.
* @return bool true if the current script is executed in a CLI environment, false otherwise
*/
public function isCLI(): bool
{
return \in_array(\PHP_SAPI, ['cli', 'phpdbg'], true);
}
/**
* Returns the username of the user who started the current script if possible.
* @return string|null the username of the user who started the current script if possible, null otherwise
*/
public function getCLIUser(): ?string
{
if (!$this->isCLI()) {
return null;
}
//Try to use the posix extension if available (Linux)
if (function_exists('posix_getpwuid') && function_exists('posix_geteuid')) {
$user = posix_getpwuid(posix_geteuid());
return $user['name'];
}
//Try to retrieve the name via the environment variable Username (Windows)
if (isset($_SERVER['USERNAME'])) {
return $_SERVER['USERNAME'];
}
//Try to retrieve the name via the environment variable USER (Linux)
if (isset($_SERVER['USER'])) {
return $_SERVER['USER'];
}
//Otherwise we can't determine the username
return null;
}
}