Add task handler for PageTree update

Controller/TaskController.php

@@ -121,8 +121,6 @@ public function __construct(
 
     /**
      * Returns fields for tasks.
-     *
-     * @return Response
      */
     public function cgetFieldsAction(): Response
     {
@@ -131,10 +129,6 @@ public function cgetFieldsAction(): Response
 
     /**
      * Returns list of tasks.
-     *
-     * @param Request $request
-     *
-     * @return Response
      */
     public function cgetAction(Request $request): Response
     {
@@ -195,10 +189,6 @@ private function extendResponseItem(array $item): array
      * Prepares list-builder.
      *
      * @param FieldDescriptorInterface[] $fieldDescriptors
-     * @param Request $request
-     * @param ListBuilderInterface $listBuilder
-     *
-     * @return ListBuilderInterface
      */
     private function prepareListBuilder(array $fieldDescriptors, Request $request, ListBuilderInterface $listBuilder): ListBuilderInterface
     {
@@ -238,8 +228,6 @@ private function prepareListBuilder(array $fieldDescriptors, Request $request, L
      * Executes given list-builder and returns result.
      *
      * @param FieldDescriptorInterface[] $fieldDescriptors
-     * @param Request $request
-     * @param ListBuilderInterface $listBuilder
      *
      * @return mixed[]
      */
@@ -265,10 +253,6 @@ private function executeListBuilder(array $fieldDescriptors, Request $request, L
     /**
      * Returns task for given id.
      *
-     * @param string $id
-     *
-     * @return Response
-     *
      * @throws TaskNotFoundException
      */
     public function getAction(string $id): Response
@@ -278,10 +262,6 @@ public function getAction(string $id): Response
 
     /**
      * Create new task.
-     *
-     * @param Request $request
-     *
-     * @return Response
      */
     public function postAction(Request $request): Response
     {
@@ -320,11 +300,6 @@ public function postAction(Request $request): Response
 
     /**
      * Update task with given id.
-     *
-     * @param string $id
-     * @param Request $request
-     *
-     * @return Response
      */
     public function putAction(string $id, Request $request): Response
     {
@@ -360,10 +335,6 @@ public function putAction(string $id, Request $request): Response
 
     /**
      * Removes task with given id.
-     *
-     * @param string $id
-     *
-     * @return Response
      */
     public function deleteAction(string $id): Response
     {
@@ -377,10 +348,6 @@ public function deleteAction(string $id): Response
 
     /**
      * Removes multiple tasks identified by ids parameter.
-     *
-     * @param Request $request
-     *
-     * @return Response
      */
     public function cdeleteAction(Request $request): Response
     {

Controller/TaskHandlerController.php

@@ -35,11 +35,6 @@ public function __construct(TaskHandlerFactoryInterface $taskHandlerFactory)
         $this->taskHandlerFactory = $taskHandlerFactory;
     }
 
-    /**
-     * @param Request $request
-     *
-     * @return Response
-     */
     public function getAction(Request $request): Response
     {
         $entityClass = $this->getRequestParameter($request, 'entityClass', true);

DependencyInjection/SuluAutomationExtension.php

@@ -92,6 +92,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');
+        $loader->load('page_tree_route.xml');
 
         $this->configurePersistence($config['objects'], $container);
     }

Entity/Task.php

@@ -78,6 +78,8 @@ public function getId(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
     public function setId(string $id): TaskInterface
     {
@@ -109,6 +111,9 @@ public function getSchedule(): \DateTime
         return $this->schedule;
     }
 
+    /**
+     * @return self
+     */
     public function setSchedule(\DateTime $schedule): TaskInterface
     {
         $this->schedule = $schedule;
@@ -163,6 +168,9 @@ public function getTaskId(): string
         return $this->taskId;
     }
 
+    /**
+     * @return self
+     */
     public function setTaskId(string $taskId): TaskInterface
     {
         $this->taskId = $taskId;

EventSubscriber/PHPTaskEventSubscriber.php

@@ -33,10 +33,6 @@ class PHPTaskEventSubscriber implements EventSubscriberInterface
      */
     private $taskRepository;
 
-    /**
-     * @param RequestStack $requestStack
-     * @param TaskRepositoryInterface $taskRepository
-     */
     public function __construct(RequestStack $requestStack, TaskRepositoryInterface $taskRepository)
     {
         $this->requestStack = $requestStack;
@@ -56,8 +52,6 @@ public static function getSubscribedEvents(): array
 
     /**
      * Create and push new request to requests-stack.
-     *
-     * @param TaskEvent $event
      */
     public function pushRequest(TaskEvent $event): void
     {
@@ -82,8 +76,6 @@ public function pushRequest(TaskEvent $event): void
 
     /**
      * Pop request from request stack.
-     *
-     * @param TaskEvent $event
      */
     public function popRequest(TaskEvent $event): void
     {

Events/CancelTrait.php

@@ -23,8 +23,6 @@ trait CancelTrait
 
     /**
      * Returns canceled.
-     *
-     * @return bool
      */
     public function isCanceled(): bool
     {

Handler/BaseDocumentHandler.php

@@ -53,9 +53,6 @@ public function handle($workload)
 
     /**
      * Handle given document.
-     *
-     * @param WorkflowStageBehavior $document
-     * @param string $locale
      */
     abstract protected function handleDocument(WorkflowStageBehavior $document, string $locale): void;
 

PageTree/AutomationPageTreeUpdater.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\AutomationBundle\PageTree;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Sulu\Bundle\AutomationBundle\Entity\Task;
+use Sulu\Bundle\AutomationBundle\Tasks\Manager\TaskManagerInterface;
+use Sulu\Bundle\PageBundle\Document\BasePageDocument;
+use Sulu\Bundle\RouteBundle\PageTree\PageTreeUpdaterInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * Schedules the route-update task.
+ */
+class AutomationPageTreeUpdater implements PageTreeUpdaterInterface
+{
+    /**
+     * @var TaskManagerInterface
+     */
+    private $taskManager;
+
+    /**
+     * @var EntityManagerInterface
+     */
+    private $entityManager;
+
+    /**
+     * @var RequestStack
+     */
+    private $requestStack;
+
+    public function __construct(
+        TaskManagerInterface $taskManager,
+        EntityManagerInterface $entityManager,
+        RequestStack $requestStack
+    ) {
+        $this->taskManager = $taskManager;
+        $this->entityManager = $entityManager;
+        $this->requestStack = $requestStack;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function update(BasePageDocument $document)
+    {
+        $request = $this->requestStack->getCurrentRequest();
+        if (!$request) {
+            return;
+        }
+
+        $task = new Task();
+        $task->setEntityClass(BasePageDocument::class)
+            ->setEntityId($document->getUuid())
+            ->setLocale($document->getLocale())
+            ->setHandlerClass(PageTreeRouteUpdateHandler::class)
+            ->setSchedule(new \DateTime())
+            ->setHost($request->getHost())
+            ->setScheme($request->getScheme());
+
+        $this->taskManager->create($task);
+        $this->entityManager->flush();
+    }
+}

PageTree/PageTreeRouteUpdateHandler.php

@@ -0,0 +1,117 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\AutomationBundle\PageTree;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Exception;
+use Sulu\Bundle\AutomationBundle\TaskHandler\AutomationTaskHandlerInterface;
+use Sulu\Bundle\AutomationBundle\TaskHandler\TaskHandlerConfiguration;
+use Sulu\Bundle\PageBundle\Document\BasePageDocument;
+use Sulu\Bundle\RouteBundle\PageTree\PageTreeUpdaterInterface;
+use Sulu\Component\DocumentManager\DocumentManagerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Task\Executor\RetryTaskHandlerInterface;
+use Task\Lock\LockingTaskHandlerInterface;
+
+/**
+ * Task-Handler to update page-tree-routes.
+ */
+class PageTreeRouteUpdateHandler implements AutomationTaskHandlerInterface, LockingTaskHandlerInterface, RetryTaskHandlerInterface
+{
+    /**
+     * @var PageTreeUpdaterInterface
+     */
+    private $routeUpdater;
+
+    /**
+     * @var DocumentManagerInterface
+     */
+    private $documentManager;
+
+    /**
+     * @var EntityManagerInterface
+     */
+    private $entityManager;
+
+    public function __construct(
+        PageTreeUpdaterInterface $routeUpdater,
+        DocumentManagerInterface $documentManager,
+        EntityManagerInterface $entityManager
+    ) {
+        $this->routeUpdater = $routeUpdater;
+        $this->documentManager = $documentManager;
+        $this->entityManager = $entityManager;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureOptionsResolver(OptionsResolver $optionsResolver): OptionsResolver
+    {
+        return $optionsResolver->setRequired(['id', 'locale'])
+            ->setAllowedTypes('id', 'string')
+            ->setAllowedTypes('locale', 'string');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($entityClass): bool
+    {
+        return is_subclass_of($entityClass, BasePageDocument::class);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfiguration(): TaskHandlerConfiguration
+    {
+        return TaskHandlerConfiguration::create('sulu_automation.update_page_tree_route');
+    }
+
+    /**
+     * @param array<string, mixed> $workload
+     */
+    public function handle($workload)
+    {
+        $this->entityManager->beginTransaction();
+
+        try {
+            /** @var BasePageDocument $document */
+            $document = $this->documentManager->find($workload['id'], $workload['locale']);
+            $this->routeUpdater->update($document);
+
+            $this->documentManager->flush();
+            $this->entityManager->commit();
+        } catch (Exception $exception) {
+            $this->entityManager->rollback();
+
+            throw $exception;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getLockKey($workload)
+    {
+        return self::class;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getMaximumAttempts()
+    {
+        return 3;
+    }
+}