vendor/sulu/community-bundle/Controller/AbstractController.php line 212

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\CommunityBundle\Controller;
  14. use Doctrine\ORM\EntityManagerInterface;
  15. use Sulu\Bundle\CommunityBundle\DependencyInjection\Configuration;
  16. use Sulu\Bundle\CommunityBundle\Manager\CommunityManagerInterface;
  17. use Sulu\Bundle\CommunityBundle\Manager\CommunityManagerRegistryInterface;
  18. use Sulu\Bundle\ContactBundle\Entity\Address;
  19. use Sulu\Bundle\ContactBundle\Entity\AddressType;
  20. use Sulu\Bundle\ContactBundle\Entity\ContactAddress;
  21. use Sulu\Bundle\SecurityBundle\Entity\User;
  22. use Sulu\Bundle\WebsiteBundle\Resolver\TemplateAttributeResolverInterface;
  23. use Sulu\Component\Security\Authentication\SaltGenerator;
  24. use Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface;
  25. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController as SymfonyAbstractController;
  26. use Symfony\Component\Form\FormInterface;
  27. use Symfony\Component\HttpFoundation\Response;
  28. use Symfony\Component\HttpKernel\Exception\HttpException;
  29. use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
  31. /**
  32.  * Contains helper function for all controllers.
  33.  */
  34. abstract class AbstractController extends SymfonyAbstractController
  35. {
  36.     /**
  37.      * @var string|null
  38.      */
  39.     private $webspaceKey;
  41.     /**
  42.      * Returns current or specific communityManager.
  43.      */
  44.     protected function getCommunityManager(string $webspaceKey): CommunityManagerInterface
  45.     {
  46.         return $this->getCommunityManagerRegistry()->get($webspaceKey);
  47.     }
  49.     /**
  50.      * Returns current webspace key.
  51.      */
  52.     protected function getWebspaceKey(): string
  53.     {
  54.         if (null === $this->webspaceKey) {
  55.             $this->webspaceKey = $this->getRequestAnalyzer()->getWebspace()->getKey();
  56.         }
  58.         return $this->webspaceKey;
  59.     }
  61.     /**
  62.      * Set Password and Salt by a Symfony Form.
  63.      */
  64.     protected function setUserPasswordAndSalt(User $user, FormInterface $form): User
  65.     {
  66.         /** @var string|null $plainPassword */
  67.         $plainPassword = $form->get('plainPassword')->getData();
  68.         if (null === $plainPassword) {
  69.             return $user;
  70.         }
  72.         $salt = $user->getSalt();
  73.         if (!$salt) {
  74.             $salt = $this->getSaltGenerator()->getRandomSalt();
  75.         }
  77.         $user->setSalt($salt);
  78.         $password = $this->encodePassword($user, $plainPassword);
  79.         $user->setPassword($password);
  81.         return $user;
  82.     }
  84.     protected function encodePassword(User $user, string $plainPassword): string
  85.     {
  86.         if ($this->container->has('?security.password_hasher')) {
  87.             /** @var UserPasswordHasherInterface $hasher */
  88.             $hasher = $this->container->get('?security.password_hasher');
  90.             return $hasher->hashPassword($user, $plainPassword);
  91.         } else {
  92.             /** @var \Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface $encoder */
  93.             $encoder = $this->container->get('?security.password_encoder');
  95.             return $encoder->encodePassword($user, $plainPassword);
  96.         }
  97.     }
  99.     /**
  100.      * Check if user should be logged in.
  101.      */
  102.     protected function checkAutoLogin(string $type): bool
  103.     {
  104.         /** @var bool */
  105.         return $this->getCommunityManager($this->getWebspaceKey())->getConfigTypeProperty(
  106.             $type,
  107.             Configuration::AUTO_LOGIN
  108.         );
  109.     }
  111.     /**
  112.      * Render a specific type template.
  113.      *
  114.      * @param mixed[] $data
  115.      */
  116.     protected function renderTemplate(string $type, array $data = []): Response
  117.     {
  118.         /** @var string $template */
  119.         $template = $this->getCommunityManager($this->getWebspaceKey())->getConfigTypeProperty(
  120.             $type,
  121.             Configuration::TEMPLATE
  122.         );
  124.         return $this->render(
  125.             $template,
  126.             $data
  127.         );
  128.     }
  130.     /**
  131.      * Save all persisted entities.
  132.      */
  133.     protected function saveEntities(): void
  134.     {
  135.         $this->getEntityManager()->flush();
  136.     }
  138.     /**
  139.      * Set Sulu template attributes.
  140.      *
  141.      * @param mixed[] $custom
  142.      *
  143.      * @return mixed[]
  144.      */
  145.     private function getTemplateAttributes(array $custom = []): array
  146.     {
  147.         return $this->getTemplateAttributeResolver()->resolve($custom);
  148.     }
  150.     /**
  151.      * @return User
  152.      */
  153.     public function getUser(): ?User
  154.     {
  155.         $user = parent::getUser();
  157.         if (!$user instanceof User) {
  158.             throw new HttpException(403);
  159.         }
  161.         if (null === $user->getContact()->getMainAddress()) {
  162.             // TODO this should be done by the form type not by the controller
  163.             $this->addAddress($user);
  164.         }
  166.         return $user;
  167.     }
  169.     /**
  170.      * Add address to user.
  171.      */
  172.     private function addAddress(User $user): void
  173.     {
  174.         $contact = $user->getContact();
  176.         $address = new Address();
  177.         $address->setPrimaryAddress(true);
  178.         $address->setNote('');
  179.         /** @var AddressType $addressType */
  180.         $addressType = $this->getEntityManager()->getReference(AddressType::class, 1);
  181.         $address->setAddressType($addressType);
  182.         $contactAddress = new ContactAddress();
  183.         $contactAddress->setMain(true);
  184.         $contactAddress->setAddress($address);
  185.         $contactAddress->setContact($contact);
  187.         $contact->addContactAddress($contactAddress);
  188.     }
  190.     /**
  191.      * @param mixed[] $parameters
  192.      */
  193.     public function render(string $view, array $parameters = [], Response $response = null): Response
  194.     {
  195.         return parent::render(
  196.             $view,
  197.             $this->getTemplateAttributes($parameters),
  198.             $response
  199.         );
  200.     }
  202.     /**
  203.      * @param mixed[] $parameters
  204.      */
  205.     public function renderView(string $view, array $parameters = []): string
  206.     {
  207.         return parent::renderView($view, $this->getTemplateAttributes($parameters));
  208.     }
  210.     protected function getCommunityManagerRegistry(): CommunityManagerRegistryInterface
  211.     {
  212.         return $this->container->get('sulu_community.community_manager.registry');
  213.     }
  215.     protected function getRequestAnalyzer(): RequestAnalyzerInterface
  216.     {
  217.         return $this->container->get('sulu_core.webspace.request_analyzer');
  218.     }
  220.     protected function getSaltGenerator(): SaltGenerator
  221.     {
  222.         return $this->container->get('sulu_security.salt_generator');
  223.     }
  225.     protected function getTemplateAttributeResolver(): TemplateAttributeResolverInterface
  226.     {
  227.         return $this->container->get('sulu_website.resolver.template_attribute');
  228.     }
  230.     protected function getEntityManager(): EntityManagerInterface
  231.     {
  232.         return $this->container->get('doctrine.orm.entity_manager');
  233.     }
  235.     /**
  236.      * @return array<string|int, string>
  237.      */
  238.     public static function getSubscribedServices(): array
  239.     {
  240.         $subscribedServices = parent::getSubscribedServices();
  242.         $subscribedServices['sulu_community.community_manager.registry'] = CommunityManagerRegistryInterface::class;
  243.         $subscribedServices['sulu_core.webspace.request_analyzer'] = RequestAnalyzerInterface::class;
  244.         $subscribedServices['sulu_security.salt_generator'] = SaltGenerator::class;
  245.         $subscribedServices['sulu_website.resolver.template_attribute'] = TemplateAttributeResolverInterface::class;
  246.         $subscribedServices['doctrine.orm.entity_manager'] = EntityManagerInterface::class;
  247.         $subscribedServices['?security.password_hasher'] = UserPasswordHasherInterface::class;
  249.         if (\class_exists('Symfony\\Component\\Security\\Core\\Encoder\\UserPasswordEncoderInterface')) {
  250.             $subscribedServices['?security.password_encoder'] = 'Symfony\\Component\\Security\\Core\\Encoder\\UserPasswordEncoderInterface';
  251.         }
  253.         return $subscribedServices;
  254.     }
  255. }