.
*/
declare(strict_types=1);
namespace App\Command\Logs;
use Symfony\Component\Console\Attribute\AsCommand;
use App\Entity\UserSystem\User;
use App\Entity\Base\AbstractNamedDBElement;
use App\Entity\LogSystem\AbstractLogEntry;
use App\Repository\LogEntryRepository;
use App\Services\ElementTypeNameGenerator;
use App\Services\LogSystem\LogEntryExtraFormatter;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Contracts\Translation\TranslatorInterface;
#[AsCommand('partdb:logs:show|app:show-logs', 'List the last event log entries.')]
class ShowEventLogCommand extends Command
{
protected LogEntryRepository $repo;
public function __construct(protected EntityManagerInterface $entityManager,
protected TranslatorInterface $translator, protected ElementTypeNameGenerator $elementTypeNameGenerator, protected LogEntryExtraFormatter $formatter)
{
$this->repo = $this->entityManager->getRepository(AbstractLogEntry::class);
parent::__construct();
}
public function execute(InputInterface $input, OutputInterface $output): int
{
$io = new SymfonyStyle($input, $output);
$onePage = $input->getOption('onePage');
$desc = (bool) $input->getOption('oldest_first');
$limit = (int) $input->getOption('count');
$page = (int) $input->getOption('page');
$showExtra = $input->getOption('showExtra');
$total_count = $this->repo->count([]);
$max_page = (int) ceil($total_count / $limit);
if ($page > $max_page && $max_page > 0) {
$io->error("There is no page $page! The maximum page is $max_page.");
return Command::FAILURE;
}
$io->note("There are a total of $total_count log entries in the DB.");
$continue = true;
while ($continue && $page <= $max_page) {
$this->showPage($output, $desc, $limit, $page, $max_page, $showExtra);
if ($onePage) {
return Command::SUCCESS;
}
$continue = $io->confirm('Do you want to show the next page?');
++$page;
}
return Command::SUCCESS;
}
protected function configure(): void
{
$this->addOption('count', 'c', InputOption::VALUE_REQUIRED, 'How many log entries should be shown per page.', 50)
->addOption('oldest_first', null, InputOption::VALUE_NONE, 'Show older entries first.')
->addOption('page', 'p', InputOption::VALUE_REQUIRED, 'Which page should be shown?', 1)
->addOption('onePage', null, InputOption::VALUE_NONE, 'Show only one page (dont ask to go to next).')
->addOption('showExtra', 'x', InputOption::VALUE_NONE, 'Show a column with the extra data.');
}
protected function showPage(OutputInterface $output, bool $desc, int $limit, int $page, int $max_page, bool $showExtra): void
{
$sorting = $desc ? 'ASC' : 'DESC';
$offset = ($page - 1) * $limit;
/** @var AbstractLogEntry[] $entries */
$entries = $this->repo->getLogsOrderedByTimestamp($sorting, $limit, $offset);
$table = new Table($output);
$table->setHeaderTitle("Page $page / $max_page");
$headers = ['ID', 'Timestamp', 'Type', 'User', 'Target Type', 'Target'];
if ($showExtra) {
$headers[] = 'Extra data';
$table->setColumnMaxWidth(6, 50);
}
$table->setHeaders($headers);
foreach ($entries as $entry) {
$this->addTableRow($table, $entry, $showExtra);
}
$table->setColumnMaxWidth(3, 20);
$table->setColumnMaxWidth(5, 30);
$table->render();
}
protected function addTableRow(Table $table, AbstractLogEntry $entry, bool $showExtra): void
{
$target = $this->repo->getTargetElement($entry);
$target_name = '';
if ($target instanceof AbstractNamedDBElement) {
$target_name = $target->getName().' ('.$target->getID().')';
} elseif ($entry->getTargetID()) {
$target_name = '('.$entry->getTargetID().')';
}
$target_class = '';
if (null !== $entry->getTargetClass()) {
$target_class = $this->elementTypeNameGenerator->getLocalizedTypeLabel($entry->getTargetClass());
}
if ($entry->getUser() instanceof User) {
$user = $entry->getUser()->getFullName(true);
} elseif ($entry->isCLIEntry()) {
$user = $entry->getCLIUsername() . ' [CLI]';
} else {
$user = $entry->getUsername() . ' [deleted]';
}
$row = [
$entry->getID(),
$entry->getTimestamp()->format('Y-m-d H:i:s'),
$entry->getType(),
$user,
$target_class,
$target_name,
];
if ($showExtra) {
$row[] = $this->formatter->formatConsole($entry);
}
$table->addRow($row);
}
}