vendor/shopware/core/Framework/MessageQueue/ScheduledTask/ScheduledTaskHandler.php line 56

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\MessageQueue\ScheduledTask;
  5. use Shopware\Core\Defaults;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Shopware\Core\Framework\MessageQueue\Handler\AbstractMessageHandler;
  12. /**
  13.  * @deprecated tag:v6.5.0 - reason:class-hierarchy-change - Will only implement MessageHandlerInterface
  14.  */
  15. #[Package('core')]
  16. abstract class ScheduledTaskHandler extends AbstractMessageHandler
  17. {
  18.     /**
  19.      * @var EntityRepositoryInterface
  20.      */
  21.     protected $scheduledTaskRepository;
  23.     public function __construct(EntityRepositoryInterface $scheduledTaskRepository)
  24.     {
  25.         $this->scheduledTaskRepository = $scheduledTaskRepository;
  26.     }
  28.     abstract public function run(): void;
  30.     /**
  31.      * @param ScheduledTask $task
  32.      */
  33.     public function handle($task): void
  34.     {
  35.         $taskId = $task->getTaskId();
  37.         if ($taskId === null) {
  38.             // run task independent of the schedule
  39.             $this->run();
  41.             return;
  42.         }
  44.         /** @var ScheduledTaskEntity|null $taskEntity */
  45.         $taskEntity = $this->scheduledTaskRepository
  46.             ->search(new Criteria([$taskId]), Context::createDefaultContext())
  47.             ->get($taskId);
  49.         if ($taskEntity === null || !$taskEntity->isExecutionAllowed()) {
  50.             return;
  51.         }
  53.         $this->markTaskRunning($task);
  55.         try {
  56.             $this->run();
  57.         } catch (\Throwable $e) {
  58.             $this->markTaskFailed($task);
  60.             throw $e;
  61.         }
  63.         $this->rescheduleTask($task, $taskEntity);
  64.     }
  66.     protected function markTaskRunning(ScheduledTask $task): void
  67.     {
  68.         $this->scheduledTaskRepository->update([
  69.             [
  70.                 'id' => $task->getTaskId(),
  71.                 'status' => ScheduledTaskDefinition::STATUS_RUNNING,
  72.             ],
  73.         ], Context::createDefaultContext());
  74.     }
  76.     protected function markTaskFailed(ScheduledTask $task): void
  77.     {
  78.         $this->scheduledTaskRepository->update([
  79.             [
  80.                 'id' => $task->getTaskId(),
  81.                 'status' => ScheduledTaskDefinition::STATUS_FAILED,
  82.             ],
  83.         ], Context::createDefaultContext());
  84.     }
  86.     protected function rescheduleTask(ScheduledTask $task, ScheduledTaskEntity $taskEntity): void
  87.     {
  88.         $now = new \DateTimeImmutable();
  90.         $nextExecutionTimeString = $taskEntity->getNextExecutionTime()->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  91.         $nextExecutionTime = new \DateTimeImmutable($nextExecutionTimeString);
  92.         $newNextExecutionTime = $nextExecutionTime->modify(sprintf('+%d seconds', $taskEntity->getRunInterval()));
  94.         if ($newNextExecutionTime < $now) {
  95.             $newNextExecutionTime = $now;
  96.         }
  98.         $this->scheduledTaskRepository->update([
  99.             [
  100.                 'id' => $task->getTaskId(),
  101.                 'status' => ScheduledTaskDefinition::STATUS_SCHEDULED,
  102.                 'lastExecutionTime' => $now,
  103.                 'nextExecutionTime' => $newNextExecutionTime,
  104.             ],
  105.         ], Context::createDefaultContext());
  106.     }
  107. }