UserSettingsController.php

<?php

/**
 * @copyright Copyright (C) Ibexa AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

namespace Ibexa\Bundle\User\Controller;

use Ibexa\Contracts\Core\Repository\PermissionResolver;
use Ibexa\User\ExceptionHandler\ActionResultHandler;
use Ibexa\User\Form\Data\UserSettingUpdateData;
use Ibexa\User\Form\Factory\FormFactory;
use Ibexa\User\Form\SubmitHandler;
use Ibexa\User\Form\Type\UserSettingUpdateType;
use Ibexa\User\UserSetting\UserSettingService;
use Ibexa\User\UserSetting\ValueDefinitionRegistry;
use Ibexa\User\View\UserSettings\ListView;
use Ibexa\User\View\UserSettings\UpdateView;
use JMS\TranslationBundle\Annotation\Desc;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\Form\Button;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Exception\ExceptionInterface as RouteExceptionInterface;
use Symfony\Component\Routing\RouterInterface;

class UserSettingsController extends Controller implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    /** @var \Ibexa\User\Form\Factory\FormFactory */
    private $formFactory;

    /** @var \Ibexa\User\Form\SubmitHandler */
    private $submitHandler;

    /** @var \Ibexa\User\UserSetting\UserSettingService */
    private $userSettingService;

    /** @var \Ibexa\User\UserSetting\ValueDefinitionRegistry */
    private $valueDefinitionRegistry;

    /** @var \Ibexa\User\ExceptionHandler\ActionResultHandler */
    private $actionResultHandler;

    private PermissionResolver $permissionResolver;

    private RouterInterface $router;

    public function __construct(
        FormFactory $formFactory,
        SubmitHandler $submitHandler,
        UserSettingService $userSettingService,
        ValueDefinitionRegistry $valueDefinitionRegistry,
        ActionResultHandler $actionResultHandler,
        PermissionResolver $permissionResolver,
        RouterInterface $router,
        LoggerInterface $logger = null
    ) {
        $this->formFactory = $formFactory;
        $this->submitHandler = $submitHandler;
        $this->userSettingService = $userSettingService;
        $this->valueDefinitionRegistry = $valueDefinitionRegistry;
        $this->actionResultHandler = $actionResultHandler;
        $this->permissionResolver = $permissionResolver;
        $this->router = $router;
        $this->logger = $logger ?? new NullLogger();
    }

    /**
     * @param int $page
     *
     * @return \Ibexa\User\View\UserSettings\ListView
     *
     * @throws \Ibexa\Core\Base\Exceptions\InvalidArgumentType
     */
    public function listAction(int $page = 1): ListView
    {
        $user = $this->getUser()->getAPIUser();
        $canChangePassword = $this->permissionResolver->canUser('user', 'password', $user);

        return new ListView(null, [
            'grouped_settings' => $this->userSettingService->loadGroupedUserSettings(),
            'value_definitions' => $this->valueDefinitionRegistry->getValueDefinitions(),
            'can_change_password' => $canChangePassword,
        ]);
    }

    public function updateAction(Request $request, UpdateView $view)
    {
        $userSettingGroup = $view->getUserSettingGroup();

        $values = [];
        foreach ($userSettingGroup->getSettings() as $setting) {
            $values[$setting->identifier] = ['value' => $setting->value];
        }

        $data = new UserSettingUpdateData($userSettingGroup->getIdentifier(), $values);
        $form = $this->formFactory->updateUserSetting($userSettingGroup->getIdentifier(), $data);
        $form->handleRequest($request);

        if ($form->isSubmitted()) {
            $result = $this->submitHandler->handle($form, function (UserSettingUpdateData $data) use ($form, $request) {
                foreach ($data->getValues() as $identifier => $value) {
                    $this->userSettingService->setUserSetting($identifier, (string)$value['value']);
                }

                $this->actionResultHandler->success(
                    /** @Desc("User settings '%identifier%' updated.") */
                    'user_setting.update.success',
                    ['%identifier%' => $data->getIdentifier()],
                    'ibexa_user_settings'
                );

                $route = $request->query->get('route');
                $routeParameters = $request->query->all('routeParameters');
                if (!$this->routeExists($route, $routeParameters)) {
                    $route = null;
                    $routeParameters = [];
                }

                if ($form->getClickedButton() instanceof Button
                    && $form->getClickedButton()->getName() === UserSettingUpdateType::BTN_UPDATE_AND_EDIT
                ) {
                    return $this->redirectToRoute('ibexa.user_settings.update', [
                        'identifier' => $data->getIdentifier(),
                        'route' => $route,
                        'routeParameters' => $routeParameters,
                    ]);
                }

                if ($route !== null) {
                    return $this->redirectToRoute($route, $routeParameters);
                }

                return $this->redirectToRoute('ibexa.user_settings.list');
            });

            if ($result instanceof Response) {
                return $result;
            }
        }

        $view->addParameters([
            'form' => $form->createView(),
            'title' => $userSettingGroup->getName(),
        ]);

        return $view;
    }

    private function routeExists($route, array $routeParameters): bool
    {
        try {
            $this->router->generate($route, $routeParameters);

            return true;
        } catch (RouteExceptionInterface $e) {
            $this->logger->warning(
                sprintf('Invalid route in query. %s.', $e->getMessage()),
                [
                    'exception' => $e,
                ],
            );
        }

        return false;
    }
}

class_alias(UserSettingsController::class, 'EzSystems\EzPlatformUserBundle\Controller\UserSettingsController');