File: //home/timetracker.panomity.com/src/Controller/UserController.php
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Controller;
use App\Configuration\SystemConfiguration;
use App\Entity\User;
use App\Event\UserPreferenceDisplayEvent;
use App\Export\Spreadsheet\UserExporter;
use App\Export\Spreadsheet\Writer\BinaryFileResponseWriter;
use App\Export\Spreadsheet\Writer\XlsxWriter;
use App\Form\Toolbar\UserToolbarForm;
use App\Form\Type\UserType;
use App\Form\UserCreateType;
use App\Repository\Query\UserFormTypeQuery;
use App\Repository\Query\UserQuery;
use App\Repository\TimesheetRepository;
use App\Repository\UserRepository;
use App\User\UserService;
use App\Utils\DataTable;
use App\Utils\PageSetup;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Http\Attribute\IsGranted;
/**
* Controller used to manage users in the admin part of the site.
*/
#[Route(path: '/admin/user')]
#[IsGranted('IS_AUTHENTICATED_FULLY')]
#[IsGranted('view_user')]
final class UserController extends AbstractController
{
public function __construct(private UserPasswordHasherInterface $passwordHasher, private UserRepository $repository, private EventDispatcherInterface $dispatcher)
{
}
#[Route(path: '/', defaults: ['page' => 1], name: 'admin_user', methods: ['GET'])]
#[Route(path: '/page/{page}', requirements: ['page' => '[1-9]\d*'], name: 'admin_user_paginated', methods: ['GET'])]
public function indexAction(int $page, Request $request): Response
{
$query = new UserQuery();
$query->setCurrentUser($this->getUser());
$query->setPage($page);
$form = $this->getToolbarForm($query);
if ($this->handleSearch($form, $request)) {
return $this->redirectToRoute('admin_user');
}
$entries = $this->repository->getPagerfantaForQuery($query);
$event = new UserPreferenceDisplayEvent(UserPreferenceDisplayEvent::USERS);
$this->dispatcher->dispatch($event);
$table = new DataTable('user_admin', $query);
$table->setPagination($entries);
$table->setSearchForm($form);
$table->setPaginationRoute('admin_user_paginated');
$table->setReloadEvents('kimai.userUpdate');
$table->addColumn('avatar', ['class' => 'alwaysVisible w-avatar', 'title' => null, 'orderBy' => false]);
$table->addColumn('user', ['class' => 'alwaysVisible', 'orderBy' => 'user']);
$table->addColumn('username', ['class' => 'd-none']);
$table->addColumn('alias', ['class' => 'd-none']);
$table->addColumn('account_number', ['class' => 'd-none']);
$table->addColumn('title', ['class' => 'd-none']);
$table->addColumn('email', ['class' => 'd-none', 'orderBy' => false]);
$table->addColumn('lastLogin', ['class' => 'd-none', 'orderBy' => false]);
$table->addColumn('roles', ['class' => 'd-none', 'orderBy' => false]);
foreach ($event->getPreferences() as $userPreference) {
$table->addColumn('mf_' . $userPreference->getName(), ['title' => $userPreference->getLabel(), 'class' => 'd-none', 'orderBy' => false, 'translation_domain' => 'messages', 'data' => $userPreference]);
}
$table->addColumn('team', ['class' => 'text-center w-min', 'orderBy' => false]);
$table->addColumn('active', ['class' => 'd-none w-min', 'orderBy' => false]);
$table->addColumn('actions', ['class' => 'actions']);
$page = new PageSetup('users');
$page->setHelp('users.html');
$page->setActionName('users');
$page->setDataTable($table);
return $this->render('user/index.html.twig', [
'page_setup' => $page,
'dataTable' => $table,
'preferences' => $event->getPreferences(),
]);
}
private function createNewDefaultUser(SystemConfiguration $config): User
{
$user = new User();
$user->setEnabled(true);
$user->setRoles([User::DEFAULT_ROLE]);
$user->setTimezone($config->getUserDefaultTimezone());
$user->setLanguage($config->getUserDefaultLanguage());
return $user;
}
#[Route(path: '/create', name: 'admin_user_create', methods: ['GET', 'POST'])]
#[IsGranted('create_user')]
public function createAction(Request $request, SystemConfiguration $config, UserRepository $userRepository): Response
{
$user = $this->createNewDefaultUser($config);
$editForm = $this->getCreateUserForm($user);
$editForm->handleRequest($request);
if ($editForm->isSubmitted() && $editForm->isValid()) {
$password = $this->passwordHasher->hashPassword($user, $user->getPlainPassword());
$user->setPassword($password);
$userRepository->saveUser($user);
$this->flashSuccess('action.update.success');
return $this->redirectToRouteAfterCreate('user_profile_edit', ['username' => $user->getUserIdentifier()]);
}
$page = new PageSetup('users');
$page->setHelp('users.html');
return $this->render('user/create.html.twig', [
'page_setup' => $page,
'user' => $user,
'form' => $editForm->createView()
]);
}
#[Route(path: '/{id}/delete', name: 'admin_user_delete', methods: ['GET', 'POST'])]
#[IsGranted('delete', 'userToDelete')]
public function deleteAction(User $userToDelete, Request $request, TimesheetRepository $repository, UserService $userService): Response
{
// $userToDelete MUST not be called $user, as $user is always the current user!
$stats = $repository->getUserStatistics($userToDelete);
$deleteForm = $this->createFormBuilder(null, [
'attr' => [
'data-form-event' => 'kimai.userUpdate kimai.userDelete',
'data-msg-success' => 'action.delete.success',
'data-msg-error' => 'action.delete.error',
]
])
->add('user', UserType::class, [
'query_builder' => function (UserRepository $repo) use ($userToDelete) {
$query = new UserFormTypeQuery();
$query->addUserToIgnore($userToDelete);
$query->setUser($this->getUser());
return $repo->getQueryBuilderForFormType($query);
},
'required' => false,
])
->setAction($this->generateUrl('admin_user_delete', ['id' => $userToDelete->getId()]))
->setMethod('POST')
->getForm();
$deleteForm->handleRequest($request);
if ($deleteForm->isSubmitted() && $deleteForm->isValid()) {
try {
$userService->deleteUser($userToDelete, $deleteForm->get('user')->getData());
$this->flashSuccess('action.delete.success');
} catch (\Exception $ex) {
$this->flashDeleteException($ex);
}
return $this->redirectToRoute('admin_user');
}
$page = new PageSetup('users');
$page->setHelp('users.html');
return $this->render('user/delete.html.twig', [
'page_setup' => $page,
'user' => $userToDelete,
'stats' => $stats,
'form' => $deleteForm->createView(),
]);
}
#[Route(path: '/export', name: 'user_export', methods: ['GET'])]
#[IsGranted('view_user')]
public function exportAction(Request $request, UserExporter $exporter)
{
$query = new UserQuery();
$query->setCurrentUser($this->getUser());
$form = $this->getToolbarForm($query);
$form->setData($query);
$form->submit($request->query->all(), false);
if (!$form->isValid()) {
$query->resetByFormError($form->getErrors());
}
$entries = $this->repository->getUsersForQuery($query);
$spreadsheet = $exporter->export(
$entries,
new UserPreferenceDisplayEvent(UserPreferenceDisplayEvent::EXPORT)
);
$writer = new BinaryFileResponseWriter(new XlsxWriter(), 'kimai-users');
return $writer->getFileResponse($spreadsheet);
}
protected function getToolbarForm(UserQuery $query): FormInterface
{
return $this->createSearchForm(UserToolbarForm::class, $query, [
'action' => $this->generateUrl('admin_user', [
'page' => $query->getPage(),
]),
]);
}
private function getCreateUserForm(User $user): FormInterface
{
return $this->createForm(UserCreateType::class, $user, [
'action' => $this->generateUrl('admin_user_create'),
'method' => 'POST',
'include_active_flag' => true,
'include_preferences' => true,
'include_teams' => $this->isGranted('teams_other_profile'),
'include_roles' => $this->isGranted('roles_other_profile'),
]);
}
}