commerce_license-8.x-2.x-dev/src/Plugin/AdvancedQueue/JobType/LicenseExpire.php

<?php

namespace Drupal\commerce_license\Plugin\AdvancedQueue\JobType;

use Drupal\advancedqueue\Job;
use Drupal\advancedqueue\JobResult;
use Drupal\advancedqueue\Plugin\AdvancedQueue\JobType\JobTypeBase;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides the job type for expiring licenses.
 *
 * @AdvancedQueueJobType(
 *   id = "commerce_license_expire",
 *   label = @Translation("Expire licenses"),
 * )
 *
 * @phpstan-consistent-constructor
 */
class LicenseExpire extends JobTypeBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The time.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Constructs a new LicenseExpire object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, TimeInterface $time) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->entityTypeManager = $entity_type_manager;
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('entity_type.manager'),
      $container->get('datetime.time')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function process(Job $job) {
    $license_id = $job->getPayload()['license_id'];
    $license_storage = $this->entityTypeManager->getStorage('commerce_license');
    /** @var \Drupal\commerce_license\Entity\License $license */
    $license = $license_storage->load($license_id);
    if (!$license) {
      return JobResult::failure('License not found.');
    }

    if (!in_array($license->getState()->getId(), [
      'active',
      'renewal_in_progress',
    ], TRUE)) {
      return JobResult::failure('License is no longer active.');
    }

    if ($license->getExpiresTime() > $this->time->getRequestTime()) {
      return JobResult::failure('License is not expired.');
    }

    try {
      // Set the license to expired. The plugin will take care of revoking it.
      $license->getState()->applyTransitionById('expire');
      $license->save();
    }
    catch (\Exception $exception) {
      return JobResult::failure($exception->getMessage());
    }

    // If the license was successfully expired, create and queue a job to send
    // a notification.
    // Use a different queue so a) they can be processed differently, and b)
    // so if the expiry queue is very full, it doesn't delay notifications.
    // We send the email from here rather than in the License entity, as if
    // something else chooses to expire a license (e.g. Commerce Recurring), it
    // may want to be in control of the messages it sends.
    $queue_storage = $this->entityTypeManager->getStorage('advancedqueue_queue');
    /** @var \Drupal\advancedqueue\Entity\QueueInterface $queue */
    $queue = $queue_storage->load('commerce_license_notify');
    $expire_notification_job = Job::create('commerce_license_expire_notify', [
      'license_id' => $license_id,
    ]);
    $queue->enqueueJob($expire_notification_job);

    return JobResult::success();
  }

}