vendor/contao/core-bundle/src/Cron/Cron.php line 62

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Cron;
  15. use Contao\CoreBundle\Entity\CronJob as CronJobEntity;
  16. use Contao\CoreBundle\Repository\CronJobRepository;
  17. use Cron\CronExpression;
  18. use Doctrine\ORM\EntityManagerInterface;
  19. use Psr\Log\LoggerInterface;
  21. class Cron
  22. {
  23.     public const SCOPE_WEB = 'web';
  24.     public const SCOPE_CLI = 'cli';
  26.     /**
  27.      * @var \Closure():CronJobRepository
  28.      */
  29.     private \Closure $repository;
  31.     /**
  32.      * @var \Closure():EntityManagerInterface
  33.      */
  34.     private \Closure $entityManager;
  36.     private ?LoggerInterface $logger;
  38.     /**
  39.      * @var array<CronJob>
  40.      */
  41.     private array $cronJobs = [];
  43.     /**
  44.      * @param \Closure():CronJobRepository      $repository
  45.      * @param \Closure():EntityManagerInterface $entityManager
  46.      */
  47.     public function __construct(\Closure $repository, \Closure $entityManager, LoggerInterface $logger = null)
  48.     {
  49.         $this->repository = $repository;
  50.         $this->entityManager = $entityManager;
  51.         $this->logger = $logger;
  52.     }
  54.     public function addCronJob(CronJob $cronjob): void
  55.     {
  56.         $this->cronJobs[] = $cronjob;
  57.     }
  59.     /**
  60.      * Run all the registered Contao cron jobs.
  61.      */
  62.     public function run(string $scope): void
  63.     {
  64.         // Validate scope
  65.         if (self::SCOPE_WEB !== $scope && self::SCOPE_CLI !== $scope) {
  66.             throw new \InvalidArgumentException('Invalid scope "'.$scope.'"');
  67.         }
  69.         /** @var CronJobRepository $repository */
  70.         $repository = ($this->repository)();
  72.         /** @var EntityManagerInterface $entityManager */
  73.         $entityManager = ($this->entityManager)();
  75.         /** @var array<CronJob> */
  76.         $cronJobsToBeRun = [];
  77.         $now = new \DateTimeImmutable();
  79.         try {
  80.             // Lock cron table
  81.             $repository->lockTable();
  83.             // Go through each cron job
  84.             foreach ($this->cronJobs as $cron) {
  85.                 $interval = $cron->getInterval();
  86.                 $name = $cron->getName();
  88.                 // Determine the last run date
  89.                 $lastRunDate = null;
  91.                 /** @var CronJobEntity|null $lastRunEntity */
  92.                 $lastRunEntity = $repository->findOneByName($name);
  94.                 if (null !== $lastRunEntity) {
  95.                     $lastRunDate = $lastRunEntity->getLastRun();
  96.                 } else {
  97.                     $lastRunEntity = new CronJobEntity($name);
  98.                     $entityManager->persist($lastRunEntity);
  99.                 }
  101.                 // Check if the cron should be run
  102.                 $expression = CronExpression::factory($interval);
  104.                 if (null !== $lastRunDate && $now < $expression->getNextRunDate($lastRunDate)) {
  105.                     continue;
  106.                 }
  108.                 // Update the cron entry
  109.                 $lastRunEntity->setLastRun($now);
  111.                 // Add job to the crons to be run
  112.                 $cronJobsToBeRun[] = $cron;
  113.             }
  115.             $entityManager->flush();
  116.         } finally {
  117.             $repository->unlockTable();
  118.         }
  120.         // Execute all crons to be run
  121.         foreach ($cronJobsToBeRun as $cron) {
  122.             if (null !== $this->logger) {
  123.                 $this->logger->debug(sprintf('Executing cron job "%s"', $cron->getName()));
  124.             }
  126.             $cron($scope);
  127.         }
  128.     }
  129. }