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

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 CronJobRepository
  28.      */
  29.     private $repository;
  31.     /**
  32.      * @var EntityManagerInterface
  33.      */
  34.     private $entityManager;
  36.     /**
  37.      * @var LoggerInterface
  38.      */
  39.     private $logger;
  41.     /**
  42.      * @var array<CronJob>
  43.      */
  44.     private $cronJobs = [];
  46.     public function __construct(CronJobRepository $repository, EntityManagerInterface $entityManager, LoggerInterface $logger = null)
  47.     {
  48.         $this->repository = $repository;
  49.         $this->entityManager = $entityManager;
  50.         $this->logger = $logger;
  51.     }
  53.     public function addCronJob(CronJob $cronjob): void
  54.     {
  55.         $this->cronJobs[] = $cronjob;
  56.     }
  58.     /**
  59.      * Run all the registered Contao cron jobs.
  60.      */
  61.     public function run(string $scope): void
  62.     {
  63.         // Validate scope
  64.         if (self::SCOPE_WEB !== $scope && self::SCOPE_CLI !== $scope) {
  65.             throw new \InvalidArgumentException('Invalid scope "'.$scope.'"');
  66.         }
  68.         /** @var array<CronJob> */
  69.         $cronJobsToBeRun = [];
  70.         $now = new \DateTimeImmutable();
  72.         try {
  73.             // Lock cron table
  74.             $this->repository->lockTable();
  76.             // Go through each cron job
  77.             foreach ($this->cronJobs as $cron) {
  78.                 $interval = $cron->getInterval();
  79.                 $name = $cron->getName();
  81.                 // Determine the last run date
  82.                 $lastRunDate = null;
  84.                 /** @var CronJobEntity|null $lastRunEntity */
  85.                 $lastRunEntity = $this->repository->findOneByName($name);
  87.                 if (null !== $lastRunEntity) {
  88.                     $lastRunDate = $lastRunEntity->getLastRun();
  89.                 } else {
  90.                     $lastRunEntity = new CronJobEntity($name);
  91.                     $this->entityManager->persist($lastRunEntity);
  92.                 }
  94.                 // Check if the cron should be run
  95.                 $expression = CronExpression::factory($interval);
  97.                 if (null !== $lastRunDate && $now < $expression->getNextRunDate($lastRunDate)) {
  98.                     continue;
  99.                 }
  101.                 // Update the cron entry
  102.                 $lastRunEntity->setLastRun($now);
  104.                 // Add job to the crons to be run
  105.                 $cronJobsToBeRun[] = $cron;
  106.             }
  108.             $this->entityManager->flush();
  109.         } finally {
  110.             $this->repository->unlockTable();
  111.         }
  113.         // Execute all crons to be run
  114.         foreach ($cronJobsToBeRun as $cron) {
  115.             if (null !== $this->logger) {
  116.                 $this->logger->debug(sprintf('Executing cron job "%s"', $cron->getName()));
  117.             }
  119.             $cron($scope);
  120.         }
  121.     }
  122. }