cms_content_sync-3.0.x-dev/modules/cms_content_sync_simple_sitemap/src/EventSubscriber/SimpleSitemapSyncExtend.php

<?php

namespace Drupal\cms_content_sync_simple_sitemap\EventSubscriber;

use Drupal\cms_content_sync\Event\AfterEntityPull;
use Drupal\cms_content_sync\Event\BeforeEntityPush;
use Drupal\cms_content_sync\Event\BeforeEntityTypeExport;
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\simple_sitemap\Entity\SimpleSitemap;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Event subscriptions for events dispatched by Content Sync.
 */
class SimpleSitemapSyncExtend implements EventSubscriberInterface {
  public const PROPERTY_NAME = 'simple_sitemap';

  /**
   * Returns an array of event names this subscriber wants to listen to.
   *
   * @return array
   *   The event names to listen to
   */
  public static function getSubscribedEvents(): array {
    $events[BeforeEntityPush::EVENT_NAME][] = ['extendPush'];
    $events[AfterEntityPull::EVENT_NAME][] = ['extendPull'];
    $events[BeforeEntityTypeExport::EVENT_NAME][] = ['extendEntityType'];

    return $events;
  }

  /**
   * Add the field to the entity type for the simple sitemap configuration.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function extendEntityType(BeforeEntityTypeExport $event) {
    if (!$this->sitemapSupportsEntityType($event->getEntityTypeName(), $event->getBundleName())) {
      return;
    }

    $event
      ->getDefinition()
      ->addObjectProperty(self::PROPERTY_NAME, 'Simple sitemap', FALSE, FALSE, 'simple_sitemap');
  }

  /**
   * Alter the push to include the sitemap settings, if enabled for the entity
   * type and cached by the form values.
   * Will not support programmatically added sitemap settings, so that's not
   * supported out of the box.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function extendPush(BeforeEntityPush $event) {
    $intent = $event->intent;
    $entity = $event->entity;

    if (!$this->sitemapSupportsEntityType($entity->getEntityTypeId(), $entity->bundle())) {
      return;
    }

    // Use values from the entity form if present as the database might not be updated yet.
    $values = _cms_content_sync_submit_cache($entity->getEntityTypeId(), $entity->uuid());

    $v4 = $this->isV4();

    // Push isn't related to submitting the entity form. So we can take the values out of the database.
    if (empty($values)) {
      /**
       * @var \Drupal\simple_sitemap\Simplesitemap $generator
       */
      $generator = \Drupal::service('simple_sitemap.generator');

      if ($v4) {
        $sitemaps = SimpleSitemap::loadMultiple();
        $values = [];
        if (!empty($sitemaps)) {
          foreach ($sitemaps as $variant => $settings) {
            $values[$variant] = $generator
              ->setVariants($variant)
              ->entityManager()
              ->getEntityInstanceSettings($entity->getEntityTypeId(), $entity->id())[$variant];
          }
        }
      }
      else {
        $values = $generator->getEntityInstanceSettings(
          $entity->getEntityTypeId(),
          $entity->id()
              );
      }

      $intent->setProperty(self::PROPERTY_NAME, $values);

      return;
    }

    // Fix for values appearing in a sub array on a commerce product entity.
    $values = $values['simple_sitemap'] ?? $values;

    if (empty($values)) {
      $intent->setProperty(self::PROPERTY_NAME, NULL);

      return;
    }

    if (!$v4) {
      $values = [
        'index' => empty($values['simple_sitemap_index_content']) ? (empty($values['index_default_node_settings']) ? NULL : $values['index_default_node_settings']) : $values['simple_sitemap_index_content'],
        'priority' => empty($values['simple_sitemap_priority']) ? (empty($values['priority_default_node_settings']) ? NULL : $values['priority_default_node_settings']) : $values['simple_sitemap_priority'],
        'changefreq' => empty($values['simple_sitemap_changefreq']) ? (empty($values['changefreq_default_node_settings']) ? NULL : $values['changefreq_default_node_settings']) : $values['simple_sitemap_changefreq'],
        'include_images' => empty($values['simple_sitemap_include_images']) ? (empty($values['include_images_default_node_settings']) ? NULL : $values['include_images_default_node_settings']) : $values['simple_sitemap_include_images'],
      ];
    }

    $intent->setProperty(self::PROPERTY_NAME, $values);
  }

  /**
   * @internal param $entity
   * @internal param $intent
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function extendPull(AfterEntityPull $event) {
    $v4 = $this->isV4();
    $intent = $event->intent;

    $entity = $intent->getEntity();
    if (!$this->sitemapSupportsEntityType($entity->getEntityTypeId(), $entity->bundle())) {
      return;
    }

    /**
     * @var \Drupal\simple_sitemap\Simplesitemap $generator
     */
    $generator = \Drupal::service('simple_sitemap.generator');

    $values = $intent->getProperty(self::PROPERTY_NAME);
    if (empty($values)) {
      return;
    }

    if ($v4) {
      $sitemaps = SimpleSitemap::loadMultiple();
      if (empty($sitemaps)) {
        return;
      }

      if (isset($values['index'], $values['priority'], $values['changefreq'], $values['include_images'])) {
        $default = array_keys($sitemaps)[0];
        $generator
          ->setVariants($default)
          ->entityManager()
          ->setEntityInstanceSettings($entity->getEntityTypeId(), $entity->id(), $values);
      }
      else {
        foreach ($sitemaps as $variant => $sitemap) {
          if (empty($values[$variant])) {
            continue;
          }

          $generator
            ->setVariants($variant)
            ->entityManager()
            ->setEntityInstanceSettings($entity->getEntityTypeId(), $entity->id(), $values[$variant]);
        }
      }
    }
    else {
      $generator->setEntityInstanceSettings(
        $entity->getEntityTypeId(),
        $entity->id(),
        $values
          );
    }
  }

  /**
   *
   */
  protected function isV4() {
    /**
     * @var \Drupal\simple_sitemap\Simplesitemap $generator
     */
    $generator = \Drupal::service('simple_sitemap.generator');

    return !method_exists($generator, 'getEntityInstanceSettings');
  }

  /**
   * Basically copied from different parts of the simple sitemap module.
   * Must be updated when the logic of simple sitemap changes.
   *
   * @param string $entity_type_name
   * @param string $bundle_name
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   *
   * @return bool whether or not the simple sitemap module supports configuring
   *   sitemap settings for the given entity type + bundle
   */
  protected function sitemapSupportsEntityType($entity_type_name, $bundle_name) {
    /**
     * @var \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
     */
    $entity_type_manager = \Drupal::service('entity_type.manager');
    $entity_type = $entity_type_manager->getDefinition($entity_type_name, FALSE);

    if (
      !$entity_type instanceof ContentEntityTypeInterface
      || !method_exists($entity_type, 'getBundleEntityType')
      || !$entity_type->hasLinkTemplate('canonical')
    ) {
      return FALSE;
    }

    /**
     * @var \Drupal\Core\Config\ConfigFactory $config_factory
     */
    $config_factory = \Drupal::service('config.factory');

    $setting = $config_factory
      ->get('simple_sitemap.settings')
      ->get('enabled_entity_types');
    if (empty($setting) || !in_array($entity_type_name, $setting)) {
      return FALSE;
    }

    $bundle_settings = $config_factory
      ->get("simple_sitemap.bundle_settings.{$entity_type_name}.{$bundle_name}")
      ->get();

    // @todo Add support for multiple sitemap variants which have been
    // added by Simple Sitemap Version 3.0.
    if (empty($bundle_settings)) {
      $bundle_settings = $config_factory
        ->get("simple_sitemap.bundle_settings.default.{$entity_type_name}.{$bundle_name}")
        ->get();
    }
    if (empty($bundle_settings) || empty($bundle_settings['index'])) {
      return FALSE;
    }

    return TRUE;
  }

}