Feat 108625 form mail protection

README.md

@@ -5,16 +5,27 @@ A bundle that provides quick password protection on Contents.
 # How it works
 
 Allows you to add 1 on N password on a Content in the Admin UI.
+Once a protection is set, the Content becomes Protected.
+In this situation you can have 3 new variables in the view full
+ - canReadProtectedContent (always)
+ - requestProtectedContentPasswordForm (if content is protected by password)
+ - requestProtectedContentEmailForm (if content is protected with email verification)
 
-Once a Password is set, the Content becomes Protected. In this situation you will have 2 new variables in the view full.
 Allowing you do:
 ```twig
 <h2>{{ ez_content_name(content) }}</h2>
 {% if not canReadProtectedContent %}
-    <p>This content has been protected by a password</p>
-    <div class="protected-content-form">
-        {{ form(requestProtectedContentPasswordForm) }}
-    </div>
+    {% if requestProtectedContentPasswordForm is defined %}
+        <p>This content has been protected by a password</p>
+        <div class="protected-content-form">
+            {{ form(requestProtectedContentPasswordForm) }}
+        </div>
+    {% elseif requestProtectedContentEmailForm is defined %}
+        <p>This content has been protected by an email verification</p>
+            <div class="protected-content-form">
+                {{ form(requestProtectedContentEmailForm) }}
+            </div>
+    {% endif %}
 {% else %}
     {% for field in content.fieldsByLanguage(language|default(null)) %}
         <h3>{{ field.fieldDefIdentifier }}</h3>

bundle/Command/CleanTokenCommand.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * NovaeZProtectedContentBundle.
+ *
+ * @package   Novactive\Bundle\eZProtectedContentBundle
+ *
+ * @author    Novactive
+ * @copyright 2023 Novactive
+ * @license   https://github.com/Novactive/eZProtectedContentBundle/blob/master/LICENSE MIT Licence
+ */
+declare(strict_types=1);
+
+namespace Novactive\Bundle\eZProtectedContentBundle\Command;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Novactive\Bundle\eZProtectedContentBundle\Entity\ProtectedTokenStorage;
+use Novactive\Bundle\eZProtectedContentBundle\Repository\ProtectedTokenStorageRepository;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+class CleanTokenCommand extends Command
+{
+    /**
+     * @var EntityManagerInterface
+     */
+    private $entityManager;
+
+    public function __construct(EntityManagerInterface $entityManager)
+    {
+        parent::__construct();
+        $this->entityManager = $entityManager;
+
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName('novaezprotectedcontent:cleantoken')
+            ->setDescription('Remove expired token in the DB');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        /** @var ProtectedTokenStorageRepository $protectedTokenStorageRepository */
+        $protectedTokenStorageRepository  = $this->entityManager->getRepository(ProtectedTokenStorage::class);
+
+        $entities =  $protectedTokenStorageRepository->findExpired();
+
+        foreach ($entities as $entity) {
+            $this->entityManager->remove($entity);
+        }
+
+        $this->entityManager->flush();
+
+        $io->success(sprintf('%d entities deleted', count($entities)));
+        $io->success('Done.');
+    }
+}

bundle/Controller/Admin/ProtectedAccessController.php

@@ -14,32 +14,43 @@
 
 use DateTime;
 use Doctrine\ORM\EntityManagerInterface;
-use eZ\Publish\API\Repository\Values\Content\Location;
-use EzSystems\PlatformHttpCacheBundle\PurgeClient\PurgeClientInterface;
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query;
+use Ibexa\Contracts\HttpCache\Handler\ContentTagInterface;
+use Ibexa\Core\Repository\SiteAccessAware\Repository;
 use Novactive\Bundle\eZProtectedContentBundle\Entity\ProtectedAccess;
 use Novactive\Bundle\eZProtectedContentBundle\Form\ProtectedAccessType;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-use Symfony\Component\Form\FormFactory;
+use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Routing\RouterInterface;
 
 class ProtectedAccessController
 {
+    public function __construct(
+        protected readonly Repository $repository,
+        protected readonly \Ibexa\Contracts\Core\Search\Handler $searchHandler,
+        protected readonly \Ibexa\Contracts\Core\Persistence\Handler $persistenceHandler,
+    ) { }
+
     /**
      * @Route("/handle/{locationId}/{access}", name="novaezprotectedcontent_bundle_admin_handle_form",
      *                                           defaults={"accessId": null})
      */
+    //#[Route(path: '/handle/{locationId}/{access}', name: 'novaezprotectedcontent_bundle_admin_handle_form')]
     public function handle(
-        Location $location,
+        int $locationId,
         Request $request,
-        FormFactory $formFactory,
+        FormFactoryInterface $formFactory,
         EntityManagerInterface $entityManager,
         RouterInterface $router,
-        PurgeClientInterface $httpCachePurgeClient,
-        ?ProtectedAccess $access = null
+        ContentTagInterface $responseTagger,
+        ?ProtectedAccess $access = null,
     ): RedirectResponse {
         if ($request->isMethod('post')) {
+            $location = $this->repository->getLocationService()->loadLocation($locationId);
             $now = new DateTime();
             if (null === $access) {
                 $access = new ProtectedAccess();
@@ -52,38 +63,95 @@ public function handle(
                 $access->setUpdated($now);
                 $entityManager->persist($access);
                 $entityManager->flush();
-                $httpCachePurgeClient->purge(
-                    [
-                        'location-'.$location->id,
-                        'location-'.$location->parentLocationId,
-                    ]
-                );
+                $responseTagger->addLocationTags([$location->id]);
+                $responseTagger->addParentLocationTags([$location->parentLocationId]);
+
+                $content = $location->getContent();
+                $this->reindexContent($content);
+                if ($access->isProtectChildren()) {
+                    $this->reindexChildren($content);
+                }
             }
         }
 
-        return new RedirectResponse($router->generate($location).'#ez-tab-location-view-protect-content#tab');
+        return new RedirectResponse(
+            $router->generate('ibexa.content.view', ['contentId' => $location->contentId,
+                'locationId' => $location->id,
+            ]).
+            '#ibexa-tab-location-view-protect-content#tab'
+        );
     }
 
-    /**
-     * @Route("/remove/{locationId}/{access}", name="novaezprotectedcontent_bundle_admin_remove_protection")
-     */
+    #[Route(path: '/remove/{locationId}/{access}', name: 'novaezprotectedcontent_bundle_admin_remove_protection')]
     public function remove(
         Location $location,
         EntityManagerInterface $entityManager,
         RouterInterface $router,
-        ProtectedAccess $access,
-        PurgeClientInterface $httpCachePurgeClient
+        int $access,
+        ContentTagInterface $responseTagger
     ): RedirectResponse {
+        $access = $entityManager->find(ProtectedAccess::class, $access);
         $entityManager->remove($access);
         $entityManager->flush();
+        $responseTagger->addLocationTags([$location->id]);
+        $responseTagger->addParentLocationTags([$location->parentLocationId]);
 
-        $httpCachePurgeClient->purge(
-            [
-                'location-'.$location->id,
-                'location-'.$location->parentLocationId,
-            ]
+        $content = $location->getContent();
+        $this->reindexContent($content);
+        if ($access->isProtectChildren()) {
+            $this->reindexChildren($content);
+        }
+
+        return new RedirectResponse(
+            $router->generate('ibexa.content.view', ['contentId' => $location->contentId,
+                'locationId' => $location->id,
+            ]).
+            '#ibexa-tab-location-view-protect-content#tab'
         );
+    }
 
-        return new RedirectResponse($router->generate($location).'#ez-tab-location-view-protect-content#tab');
+    /**
+     * @param Content $content
+     * @return void
+     */
+    protected function reindexContent(Content $content)
+    {
+        $contentId = $content->id;
+        $contentVersionNo = $content->getVersionInfo()->versionNo;
+
+        $this->searchHandler->indexContent(
+            $this->persistenceHandler->contentHandler()->load($contentId, $contentVersionNo)
+        );
+
+        $locations = $this->persistenceHandler->locationHandler()->loadLocationsByContent($contentId);
+        foreach ($locations as $location) {
+            $this->searchHandler->indexLocation($location);
+        }
+    }
+
+    protected function reindexChildren(Content $content, int $limit = 100)
+    {
+        $locations = $this->repository->getLocationService()->loadLocations($content->contentInfo);
+        $pathStringArray = [];
+        foreach ($locations as $location) {
+            /** @var Location $location */
+            $pathStringArray[] = $location->pathString;
+        }
+
+        if ($pathStringArray) {
+            $query = new Query();
+            $query->limit = $limit;
+            $query->filter = new Query\Criterion\LogicalAnd([
+                new Query\Criterion\Subtree($pathStringArray)
+            ]);
+            $query->sortClauses = [
+                new Query\SortClause\ContentId(),
+                // new Query\SortClause\Visibility(), // domage..
+            ];
+            $searchResult = $this->repository->getSearchService()->findContent($query);
+            foreach ($searchResult->searchHits as $hit) {
+                $this->reindexContent($hit->valueObject);
+            }
+        }
     }
 }

bundle/Entity/ProtectedAccess.php

@@ -38,8 +38,7 @@ class ProtectedAccess implements ContentInterface
     /**
      * @var string
      *
-     * @ORM\Column(type="string", length=255, nullable=false)
-     * @Assert\NotBlank()
+     * @ORM\Column(type="string", length=255, nullable=true)
      * @Assert\Length(max=255)
      */
     protected $password;
@@ -51,13 +50,27 @@ class ProtectedAccess implements ContentInterface
      */
     protected $enabled;
 
+    /**
+     * @var bool
+     *
+     * @ORM\Column(type="boolean", nullable=false)
+     */
+    protected $asEmail = false;
+
     /**
      * @var bool
      *
      * @ORM\Column(type="boolean", nullable=false)
      */
     protected $protectChildren;
 
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="string", nullable=true)
+     */
+    protected $emailMessage;
+
     public function __construct()
     {
         $this->enabled         = true;
@@ -76,12 +89,24 @@ public function setId(int $id): self
         return $this;
     }
 
+    public function getAsEmail(): bool
+    {
+        return $this->asEmail ?? false;
+    }
+
+    public function setAsEmail(bool $asEmail): self
+    {
+        $this->asEmail = $asEmail;
+
+        return $this;
+    }
+
     public function getPassword(): string
     {
         return $this->password ?? '';
     }
 
-    public function setPassword(string $password): self
+    public function setPassword(?string $password = ''): self
     {
         $this->password = $password;
 
@@ -109,4 +134,14 @@ public function setProtectChildren(bool $protectChildren): void
     {
         $this->protectChildren = $protectChildren;
     }
+
+    public function getEmailMessage(): ?string
+    {
+        return $this->emailMessage;
+    }
+
+    public function setEmailMessage(string $emailMessage): void
+    {
+        $this->emailMessage = $emailMessage;
+    }
 }