turnstile

TurnstileConfigSubscriber.php (7458B)

---

 <?php
 
 /**
  * @file
  * Location: src/EventSubscriber/TurnstileConfigSubscriber.php
  *
  * Subscriber for turnstile config changes.
  */
 
 namespace Drupal\taler_turnstile\EventSubscriber;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Drupal\Core\StringTranslation\TranslationInterface;
 use Drupal\Core\Config\ConfigCrudEvent;
 use Drupal\Core\Config\ConfigEvents;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\taler_turnstile\TurnstileFieldManager;
 use Drupal\taler_turnstile\TalerMerchantApiService;
 use Drupal\Core\Messenger\MessengerInterface;
 
 class TurnstileConfigSubscriber implements EventSubscriberInterface {
 
   // This provides the $this->t() method.
   use StringTranslationTrait;
 
   /**
    * The entity type manager.
    *
    * @var \Drupal\Core\Entity\EntityTypeManagerInterface
    */
   protected $entityTypeManager;
 
   /**
    * The Turnstile field manager.
    *
    * @var \Drupal\taler_turnstile\TurnstileFieldManager
    */
   protected $fieldManager;
 
 
   /**
    * The messenger service.
    *
    * @var \Drupal\Core\Messenger\MessengerInterface
    */
   protected $messenger;
 
   /**
    * The Turnstile API service.
    *
    * @var \Drupal\taler_turnstile\TalerMerchantApiService
    */
   protected $apiService;
 
   /**
    * Constructs a TurnstileSettingsForm object.
    *
    * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
    *   The translation interface.
    * @param \Drupal\Core\Messenger\MessengerInterface
    *   The messenger interface.
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    *   The entity type manager.
    * @param \Drupal\taler_turnstile\TurnstileFieldManager $field_manager
    *   The field manager.
    * @param \Drupal\taler_turnstile\TalerMerchantApiService $api_service
    *   The Turnstile API service.
    */
   public function __construct(TranslationInterface $string_translation,
                               MessengerInterface $messenger,
                               EntityTypeManagerInterface $entity_type_manager,
                               TurnstileFieldManager $field_manager,
                               TalerMerchantApiService $api_service) {
     $this->stringTranslation = $string_translation;
     $this->messenger = $messenger;
     $this->entityTypeManager = $entity_type_manager;
     $this->fieldManager = $field_manager;
     $this->apiService = $api_service;
   }
 
   /**
    * {@inheritdoc}
    */
   public static function getSubscribedEvents() {
     // Listen for the configuration save event.
     $events[ConfigEvents::SAVE][] = ['onConfigSave'];
     return $events;
   }
 
   /**
    * React to configuration changes.
    *
    * @param \Drupal\Core\Config\ConfigCrudEvent $event
    * The configuration event.
    */
   public function onConfigSave(ConfigCrudEvent $event) {
     $config = $event->getConfig();
     if ($config->getName() !== 'taler_turnstile.settings') {
       return;
     }
     if ($event->isChanged('enabled_content_types')) {
       $old_enabled_types = $config->getOriginal('enabled_content_types') ?? [];
       $new_enabled_types = $config->get('enabled_content_types');
 
       // FIXME: Consider validating new_enabled_types.
 
       // Find content types to add and remove.
       $types_to_add = array_diff($new_enabled_types, $old_enabled_types);
       $types_to_remove = array_diff($old_enabled_types, $new_enabled_types);
 
       // Add fields to newly enabled content types.
       if (!empty($types_to_add)) {
         $this->fieldManager->addFieldsToContentTypes($types_to_add);
       }
 
       // Remove fields from disabled content types.
       if (!empty($types_to_remove)) {
         $this->fieldManager->removeFieldsFromContentTypes($types_to_remove);
       }
       if (empty($new_enabled_types)) {
         $this->fieldManager->cleanupFieldStorage();
       }
       // Display summary of changes.
       if (!empty($types_to_add) || !empty($types_to_remove)) {
         $this->displayFieldChanges($types_to_add, $types_to_remove);
       }
       \Drupal::logger('taler_turnstile')->info('Turnstile content types changed from @old to @new.', [
         '@old' => json_encode($old_enabled_types),
         '@new' => json_encode($new_enabled_types),
       ]);
     }
     // Subscription prices feed every category's "buy subscription"
     // choices, so keep all merchant templates in sync when they
     // change. Also re-push everything when the operator (re)configures
     // the backend or rotates the access token: the new instance will
     // not yet have any of our templates.
     $needs_sync = $event->isChanged('subscription_prices')
       || $event->isChanged('payment_backend_url')
       || $event->isChanged('access_token');
     if ($needs_sync) {
       $results = $this->apiService->syncAllTemplates();
       $this->reportSyncResults($results, (string) ($config->get('payment_backend_url') ?? ''));
     }
   }
 
   /**
    * Report the outcome of syncAllTemplates() to the admin via the
    * messenger. Categories that hit NOT_CONFIGURED are ignored: this
    * is the expected state when the operator deliberately clears the
    * backend URL.
    *
    * @param array<string, \Drupal\taler_turnstile\TalerBackendResult> $results
    *   Map of price-category id => sync result.
    * @param string $backend_url
    *   Backend URL the calls were made against (for the error message).
    */
   protected function reportSyncResults(array $results, string $backend_url): void {
     $failed = [];
     foreach ($results as $id => $r) {
       if (!$r->isOk()
           && $r->kind !== \Drupal\taler_turnstile\TalerBackendErrorKind::NOT_CONFIGURED) {
         $failed[$id] = $r;
       }
     }
     if (empty($failed)) {
       return;
     }
     $first = reset($failed);
     $this->messenger->addError($this->t(
       'Settings saved, but @n of @t price-category templates failed to publish to the merchant backend. First failure (@id): @err',
       [
         '@n'   => count($failed),
         '@t'   => count($results),
         '@id'  => array_key_first($failed),
         '@err' => $first->toUserMessage($backend_url),
       ]
     ));
   }
 
   /**
    * Display messages about field changes.
    *
    * @param array $types_added
    *   Content types that had fields added.
    * @param array $types_removed
    *   Content types that had fields removed.
    */
   protected function displayFieldChanges(array $types_added, array $types_removed) {
     $content_types = $this->entityTypeManager->getStorage('node_type')->loadMultiple();
 
     if (!empty($types_added)) {
       $added_labels = [];
       foreach ($types_added as $type) {
         if (isset($content_types[$type])) {
           $added_labels[] = $content_types[$type]->label();
         }
       }
       if (!empty($added_labels)) {
         $this->messenger->addStatus(
           $this->t('Price category fields added to: @types', [
             '@types' => implode(', ', $added_labels),
           ])
         );
       }
     }
 
     if (!empty($types_removed)) {
       $removed_labels = [];
       foreach ($types_removed as $type) {
         if (isset($content_types[$type])) {
           $removed_labels[] = $content_types[$type]->label();
         }
       }
       if (!empty($removed_labels)) {
         $this->messenger->addStatus(
           $this->t('Price category fields removed from: @types', [
             '@types' => implode(', ', $removed_labels),
           ])
         );
       }
     }
   }
 }