chill-bundles/src/Bundle/ChillPersonBundle/Controller/PersonController.php

<?php

/**
 * Chill is a software for social workers
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Chill\PersonBundle\Controller;

use Chill\PersonBundle\Config\ConfigPersonAltNamesHelper;
use Chill\PersonBundle\Entity\Person;
use Chill\PersonBundle\Form\CreationPersonType;
use Chill\PersonBundle\Form\PersonType;
use Chill\PersonBundle\Privacy\PrivacyEvent;
use Chill\PersonBundle\Repository\PersonACLAwareRepositoryInterface;
use Chill\PersonBundle\Repository\PersonRepository;
use Doctrine\ORM\EntityManagerInterface;
use Psr\Log\LoggerInterface;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\Form\Form;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Core\Security;
use Symfony\Component\Translation\TranslatorInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;

use function count;
use function hash;
use function implode;
use function in_array;
use function is_array;

final class PersonController extends AbstractController
{
    /**
     * @var ConfigPersonAltNamesHelper
     */
    protected $configPersonAltNameHelper;

    /**
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * @var PersonRepository;
     */
    protected $personRepository;

    /**
     * @var TranslatorInterface
     */
    protected $translator;

    /**
     * @var EntityManagerInterface
     */
    private $em;

    /**
     * @var \Psr\Log\LoggerInterface
     */
    private $logger;

    private PersonACLAwareRepositoryInterface $personACLAwareRepository;

    /**
     * @var ValidatorInterface
     */
    private $validator;

    public function __construct(
        TranslatorInterface $translator,
        EventDispatcherInterface $eventDispatcher,
        PersonRepository $personRepository,
        ConfigPersonAltNamesHelper $configPersonAltNameHelper,
        LoggerInterface $logger,
        ValidatorInterface $validator,
        EntityManagerInterface $em,
        Security $security,
        PersonACLAwareRepositoryInterface $personACLAwareRepository
    ) {
        $this->translator = $translator;
        $this->eventDispatcher = $eventDispatcher;
        $this->configPersonAltNameHelper = $configPersonAltNameHelper;
        $this->personRepository = $personRepository;
        $this->logger = $logger;
        $this->validator = $validator;
        $this->em = $em;
        $this->security = $security;
        $this->personACLAwareRepository = $personACLAwareRepository;
    }

    public function editAction($person_id, Request $request)
    {
        $person = $this->_getPerson($person_id);

        if (null === $person) {
            throw $this->createNotFoundException();
        }

        $this->denyAccessUnlessGranted(
            'CHILL_PERSON_UPDATE',
            $person,
            'You are not allowed to edit this person'
        );

        $form = $this->createForm(
            PersonType::class,
            $person,
            [
                'cFGroup' => $this->getCFGroup(),
            ]
        );

        $form->handleRequest($request);

        if ($form->isSubmitted() && !$form->isValid()) {
            $this->get('session')
                ->getFlashBag()->add('error', $this->translator
                ->trans('This form contains errors'));
        } elseif ($form->isSubmitted() && $form->isValid()) {
            $this->em->flush();

            $this->get('session')->getFlashBag()
                ->add(
                    'success',
                    $this->get('translator')
                        ->trans('The person data has been updated')
                );

            return $this->redirectToRoute('chill_person_view', [
                'person_id' => $person->getId(),
            ]);
        }

        return $this->render(
            'ChillPersonBundle:Person:edit.html.twig',
            ['person' => $person, 'form' => $form->createView()]
        );
    }

    public function getCFGroup()
    {
        $cFGroup = null;

        $cFDefaultGroup = $this->em->getRepository('ChillCustomFieldsBundle:CustomFieldsDefaultGroup')
            ->findOneByEntity('Chill\\PersonBundle\\Entity\\Person');

        if ($cFDefaultGroup) {
            $cFGroup = $cFDefaultGroup->getCustomFieldsGroup();
        }

        return $cFGroup;
    }

    /**
     * @Route(
     *     "/{_locale}/person/household/{person_id}/history",
     *     name="chill_person_household_person_history",
     *     methods={"GET", "POST"}
     * )
     * @ParamConverter("person", options={"id": "person_id"})
     */
    public function householdHistoryByPerson(Request $request, Person $person): Response
    {
        $this->denyAccessUnlessGranted(
            'CHILL_PERSON_SEE',
            $person,
            'You are not allowed to see this person.'
        );

        $event = new PrivacyEvent($person);
        $this->eventDispatcher->dispatch(PrivacyEvent::PERSON_PRIVACY_EVENT, $event);

        return $this->render(
            '@ChillPerson/Person/household_history.html.twig',
            [
                'person' => $person,
            ]
        );
    }

    /**
     * Method for creating a new person.
     *
     *The controller register data from a previous post on the form, and
     * register it in the session.
     *
     * The next post compare the data with previous one and, if yes, show a
     * review page if there are "alternate persons".
     *
     * @return Response|\Symfony\Component\HttpFoundation\RedirectResponse
     */
    public function newAction(Request $request)
    {
        $person = new Person();

        if (
            1 === count($this->security->getUser()
                ->getGroupCenters())
        ) {
            $person->setCenter(
                $this->security->getUser()
                    ->getGroupCenters()[0]
                    ->getCenter()
            );
        }

        $form = $this->createForm(CreationPersonType::class, $person)
            ->add('editPerson', SubmitType::class, [
                'label' => 'Add the person',
            ])->add('createPeriod', SubmitType::class, [
                'label' => 'Add the person and create an accompanying period',
            ])->add('createHousehold', SubmitType::class, [
                'label' => 'Add the person and create a household',
            ]);

        $form->handleRequest($request);

        if ($request->getMethod() === Request::METHOD_GET) {
            $this->lastPostDataReset();
        } elseif (
            $request->getMethod() === Request::METHOD_POST
            && $form->isValid()
        ) {
            $alternatePersons = $this->personACLAwareRepository
                ->findMatchingPersons($person);

            if (
                false === $this->isLastPostDataChanges($form, $request, true)
                || count($alternatePersons) === 0
            ) {
                $this->em->persist($person);

                $this->em->flush();
                $this->lastPostDataReset();

                if ($form->get('createPeriod')->isClicked()) {
                    return $this->redirectToRoute('chill_person_accompanying_course_new', [
                        'person_id' => [$person->getId()],
                    ]);
                }

                if ($form->get('createHousehold')->isClicked()) {
                    return $this->redirectToRoute('chill_person_household_members_editor', [
                        'persons' => [$person->getId()],
                    ]);
                }

                return $this->redirectToRoute(
                    'chill_person_general_edit',
                    ['person_id' => $person->getId()]
                );
            }
        } elseif ($request->getMethod() === Request::METHOD_POST && !$form->isValid()) {
            $this->addFlash('error', $this->translator->trans('This form contains errors'));
        }

        return $this->render(
            '@ChillPerson/Person/create.html.twig',
            [
                'form' => $form->createView(),
                'alternatePersons' => $alternatePersons ?? [],
            ]
        );
    }

    public function viewAction($person_id)
    {
        $person = $this->_getPerson($person_id);

        if (null === $person) {
            throw $this->createNotFoundException("Person with id {$person_id} not"
                    . ' found on this server');
        }

        $this->denyAccessUnlessGranted(
            'CHILL_PERSON_SEE',
            $person,
            'You are not allowed to see this person.'
        );

        $event = new PrivacyEvent($person);
        $this->eventDispatcher->dispatch(PrivacyEvent::PERSON_PRIVACY_EVENT, $event);

        return $this->render(
            'ChillPersonBundle:Person:view.html.twig',
            [
                'person' => $person,
                'cFGroup' => $this->getCFGroup(),
                'alt_names' => $this->configPersonAltNameHelper->getChoices(),
            ]
        );
    }

    /**
     * easy getting a person by his id.
     *
     * @param mixed $id
     *
     * @return \Chill\PersonBundle\Entity\Person
     */
    private function _getPerson($id)
    {
        return $this->personRepository->find($id);
    }

    /**
     * @return \Symfony\Component\Validator\ConstraintViolationListInterface
     */
    private function _validatePersonAndAccompanyingPeriod(Person $person)
    {
        $errors = $this->validator
            ->validate($person, null, ['creation']);

        //validate accompanying periods
        $periods = $person->getAccompanyingPeriods();

        foreach ($periods as $period) {
            $period_errors = $this->validator
                ->validate($period);

            //group errors :
            foreach ($period_errors as $error) {
                $errors->add($error);
            }
        }

        return $errors;
    }

    private function isLastPostDataChanges(Form $form, Request $request, bool $replace = false): bool
    {
        /** @var SessionInterface $session */
        $session = $this->get('session');

        if (!$session->has('last_person_data')) {
            return true;
        }

        $newPost = $this->lastPostDataBuildHash($form, $request);

        $isChanged = $session->get('last_person_data') !== $newPost;

        if ($replace) {
            $session->set('last_person_data', $newPost);
        }

        return $isChanged;
    }

    /**
     * build the hash for posted data.
     *
     * For privacy reasons, the data are hashed using sha512
     */
    private function lastPostDataBuildHash(Form $form, Request $request): string
    {
        $fields = [];
        $ignoredFields = ['form_status', '_token'];

        foreach ($request->request->all()[$form->getName()] as $field => $value) {
            if (in_array($field, $ignoredFields, true)) {
                continue;
            }
            $fields[$field] = is_array($value) ?
                implode(',', $value) : $value;
        }
        ksort($fields);

        return hash('sha512', implode('&', $fields));
    }

    private function lastPostDataReset(): void
    {
        $this->get('session')->set('last_person_data', '');
    }
}