ContentModerationHooks.php

<?php

namespace Drupal\content_moderation\Hook;

use Drupal\Core\Access\AccessResultInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\views\Plugin\views\filter\Broken;
use Drupal\views\ViewExecutable;
use Drupal\views\Views;
use Drupal\workflows\Entity\Workflow;
use Drupal\content_moderation\Plugin\Action\ModerationOptOutUnpublish;
use Drupal\Core\Action\Plugin\Action\UnpublishAction;
use Drupal\content_moderation\Plugin\Action\ModerationOptOutPublish;
use Drupal\Core\Action\Plugin\Action\PublishAction;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\workflows\WorkflowInterface;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Entity\Display\EntityFormDisplayInterface;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\content_moderation\EntityOperations;
use Drupal\Core\Entity\EntityInterface;
use Drupal\content_moderation\EntityTypeInfo;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\views\Entity\View;
use Drupal\Core\Url;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Hook\Attribute\Hook;

/**
 * Hook implementations for content_moderation.
 */
class ContentModerationHooks {
  use StringTranslationTrait;
  
  /**
   * Implements hook_help().
   */
  public function help($route_name, RouteMatchInterface $route_match) : ?string {
    switch ($route_name) {
      // Main module help for the content_moderation module.
      case 'help.page.content_moderation':
        $output = '';
        $output .= '<h2>' . $this->t('About') . '</h2>';
        $output .= '<p>' . $this->t('The Content Moderation module allows you to expand on Drupal\'s "unpublished" and "published" states for content. It allows you to have a published version that is live, but have a separate working copy that is undergoing review before it is published. This is achieved by using <a href=":workflows">Workflows</a> to apply different states and transitions to entities as needed. For more information, see the <a href=":content_moderation">online documentation for the Content Moderation module</a>.', [
          ':content_moderation' => 'https://www.drupal.org/documentation/modules/content_moderation',
          ':workflows' => Url::fromRoute('help.page', [
            'name' => 'workflows',
          ])->toString(),
        ]) . '</p>';
        $output .= '<h2>' . $this->t('Uses') . '</h2>';
        $output .= '<dl>';
        $output .= '<dt>' . $this->t('Applying workflows') . '</dt>';
        $output .= '<dd>' . $this->t('Content Moderation allows you to apply <a href=":workflows">Workflows</a> to content, content blocks, and other <a href=":field_help" title="Field module help, with background on content entities">content entities</a>, to provide more fine-grained publishing options. For example, a Basic page might have states such as Draft and Published, with allowed transitions such as Draft to Published (making the current revision "live"), and Published to Draft (making a new draft revision of published content).', [
          ':workflows' => Url::fromRoute('help.page', [
            'name' => 'workflows',
          ])->toString(),
          ':field_help' => Url::fromRoute('help.page', [
            'name' => 'field',
          ])->toString(),
        ]) . '</dd>';
        if (\Drupal::moduleHandler()->moduleExists('views')) {
          $moderated_content_view = View::load('moderated_content');
          if (isset($moderated_content_view) && $moderated_content_view->status() === TRUE) {
            $output .= '<dt>' . $this->t('Moderating content') . '</dt>';
            $output .= '<dd>' . $this->t('You can view a list of content awaiting moderation on the <a href=":moderated">moderated content page</a>. This will show any content in an unpublished state, such as Draft or Archived, to help surface content that requires more work from content editors.', [
              ':moderated' => Url::fromRoute('view.moderated_content.moderated_content')->toString(),
            ]) . '</dd>';
          }
        }
        $output .= '<dt>' . $this->t('Configure Content Moderation permissions') . '</dt>';
        $output .= '<dd>' . $this->t('Each transition is exposed as a permission. If a user has the permission for a transition, they can use the transition to change the state of the content item, from Draft to Published.') . '</dd>';
        $output .= '</dl>';
        return $output;
    }
    return NULL;
  }
  
  /**
   * Implements hook_entity_base_field_info().
   */
  public function entityBaseFieldInfo(EntityTypeInterface $entity_type) : array {
    return \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityTypeInfo::class)
      ->entityBaseFieldInfo($entity_type);
  }
  
  /**
   * Implements hook_entity_bundle_field_info().
   */
  public function entityBundleFieldInfo(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) : array {
    if (isset($base_field_definitions['moderation_state'])) {
      // Add the target bundle to the moderation state field. Since each bundle
      // can be attached to a different moderation workflow, adding this
      // information to the field definition allows the associated workflow to
      // be derived where a field definition is present.
      $base_field_definitions['moderation_state']->setTargetBundle($bundle);
      return [
        'moderation_state' => $base_field_definitions['moderation_state'],
      ];
    }
    return [];
  }
  
  /**
   * Implements hook_entity_type_alter().
   */
  public function entityTypeAlter(array &$entity_types) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityTypeInfo::class)
      ->entityTypeAlter($entity_types);
  }
  
  /**
   * Implements hook_entity_presave().
   */
  public function entityPresave(EntityInterface $entity) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityPresave($entity);
  }
  
  /**
   * Implements hook_entity_insert().
   */
  public function entityInsert(EntityInterface $entity) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityInsert($entity);
  }
  
  /**
   * Implements hook_entity_update().
   */
  public function entityUpdate(EntityInterface $entity) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityUpdate($entity);
  }
  
  /**
   * Implements hook_entity_delete().
   */
  public function entityDelete(EntityInterface $entity) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityDelete($entity);
  }
  
  /**
   * Implements hook_entity_revision_delete().
   */
  public function entityRevisionDelete(EntityInterface $entity) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityRevisionDelete($entity);
  }
  
  /**
   * Implements hook_entity_translation_delete().
   */
  public function entityTranslationDelete(EntityInterface $translation) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityTranslationDelete($translation);
  }
  
  /**
   * Implements hook_entity_prepare_form().
   */
  public function entityPrepareForm(EntityInterface $entity, $operation, FormStateInterface $form_state) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityTypeInfo::class)
      ->entityPrepareForm($entity, $operation, $form_state);
  }
  
  /**
   * Implements hook_form_alter().
   */
  public function formAlter(&$form, FormStateInterface $form_state, $form_id) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityTypeInfo::class)
      ->formAlter($form, $form_state, $form_id);
  }
  
  /**
   * Implements hook_entity_extra_field_info().
   */
  public function entityExtraFieldInfo() : array {
    return \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityTypeInfo::class)
      ->entityExtraFieldInfo();
  }
  
  /**
   * Implements hook_entity_view().
   */
  public function entityView(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) : void {
    \Drupal::service('class_resolver')->getInstanceFromDefinition(EntityOperations::class)
      ->entityView($build, $entity, $display, $view_mode);
  }
  
  /**
   * Implements hook_entity_form_display_alter().
   */
  public function entityFormDisplayAlter(EntityFormDisplayInterface $form_display, array $context) : void {
    if ($context['form_mode'] === 'layout_builder') {
      $form_display->setComponent('moderation_state', [
        'type' => 'moderation_state_default',
        'weight' => -900,
        'settings' => [],
      ]);
    }
  }
  
  /**
   * Implements hook_entity_access().
   *
   * Entities should be viewable if unpublished and the user has the appropriate
   * permission. This permission is therefore effectively mandatory for any user
   * that wants to moderate things.
   */
  public function entityAccess(EntityInterface $entity, $operation, AccountInterface $account) : AccessResultInterface {
    /** @var \Drupal\content_moderation\ModerationInformationInterface $moderation_info */
    $moderation_info = \Drupal::service('content_moderation.moderation_information');
    $access_result = AccessResult::neutral();
    if ($operation === 'view') {
      $access_result = $entity instanceof EntityPublishedInterface && !$entity->isPublished() ? AccessResult::allowedIfHasPermission($account, 'view any unpublished content') : AccessResult::neutral();
      $access_result->addCacheableDependency($entity);
    }
    elseif ($operation === 'update' && $moderation_info->isModeratedEntity($entity) && $entity->moderation_state) {
      /** @var \Drupal\content_moderation\StateTransitionValidation $transition_validation */
      $transition_validation = \Drupal::service('content_moderation.state_transition_validation');
      $valid_transition_targets = $transition_validation->getValidTransitions($entity, $account);
      $access_result = $valid_transition_targets ? AccessResult::neutral() : AccessResult::forbidden('No valid transitions exist for given account.');
      $access_result->addCacheableDependency($entity);
      $workflow = $moderation_info->getWorkflowForEntity($entity);
      $access_result->addCacheableDependency($workflow);
      // The state transition validation service returns a list of transitions
      // based on the user's permission to use them.
      $access_result->cachePerPermissions();
    }
    // Do not allow users to delete the state that is configured as the default
    // state for the workflow.
    if ($entity instanceof WorkflowInterface) {
      $configuration = $entity->getTypePlugin()
        ->getConfiguration();
      if (!empty($configuration['default_moderation_state']) && $operation === sprintf('delete-state:%s', $configuration['default_moderation_state'])) {
        return AccessResult::forbidden()->addCacheableDependency($entity);
      }
    }
    return $access_result;
  }
  
  /**
   * Implements hook_entity_field_access().
   */
  public function entityFieldAccess($operation, FieldDefinitionInterface $field_definition, AccountInterface $account, ?FieldItemListInterface $items = NULL) : AccessResultInterface {
    if ($items && $operation === 'edit') {
      /** @var \Drupal\content_moderation\ModerationInformationInterface $moderation_info */
      $moderation_info = \Drupal::service('content_moderation.moderation_information');
      $entity_type = \Drupal::entityTypeManager()->getDefinition($field_definition->getTargetEntityTypeId());
      $entity = $items->getEntity();
      // Deny edit access to the published field if the entity is being
      // moderated.
      if ($entity_type->hasKey('published') && $moderation_info->isModeratedEntity($entity) && $entity->moderation_state && $field_definition->getName() == $entity_type->getKey('published')) {
        return AccessResult::forbidden('Cannot edit the published field of moderated entities.');
      }
    }
    return AccessResult::neutral();
  }
  
  /**
   * Implements hook_theme().
   */
  public function theme() : array {
    return [
      'entity_moderation_form' => [
        'render element' => 'form',
      ],
    ];
  }
  
  /**
   * Implements hook_action_info_alter().
   */
  public function actionInfoAlter(&$definitions) : void {
    // The publish/unpublish actions are not valid on moderated entities. So
    // swap their implementations out for alternates that will become a no-op on
    // a moderated entity. If another module has already swapped out those
    // classes, though, we'll be polite and do nothing.
    foreach ($definitions as &$definition) {
      if ($definition['id'] === 'entity:publish_action' && $definition['class'] == PublishAction::class) {
        $definition['class'] = ModerationOptOutPublish::class;
      }
      if ($definition['id'] === 'entity:unpublish_action' && $definition['class'] == UnpublishAction::class) {
        $definition['class'] = ModerationOptOutUnpublish::class;
      }
    }
  }
  
  /**
   * Implements hook_entity_bundle_info_alter().
   */
  public function entityBundleInfoAlter(&$bundles) : void {
    $translatable = FALSE;
    /** @var \Drupal\workflows\WorkflowInterface $workflow */
    foreach (Workflow::loadMultipleByType('content_moderation') as $workflow) {
      /** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModeration $plugin */
      $plugin = $workflow->getTypePlugin();
      foreach ($plugin->getEntityTypes() as $entity_type_id) {
        foreach ($plugin->getBundlesForEntityType($entity_type_id) as $bundle_id) {
          if (isset($bundles[$entity_type_id][$bundle_id])) {
            $bundles[$entity_type_id][$bundle_id]['workflow'] = $workflow->id();
            // If we have even one moderation-enabled translatable bundle, we
            // need to make the moderation state bundle translatable as well, to
            // enable the revision translation merge logic also for content
            // moderation state revisions.
            if (!empty($bundles[$entity_type_id][$bundle_id]['translatable'])) {
              $translatable = TRUE;
            }
          }
        }
      }
    }
    $bundles['content_moderation_state']['content_moderation_state']['translatable'] = $translatable;
  }
  
  /**
   * Implements hook_entity_bundle_delete().
   */
  public function entityBundleDelete($entity_type_id, $bundle_id) : void {
    // Remove non-configuration based bundles from content moderation based
    // workflows when they are removed.
    foreach (Workflow::loadMultipleByType('content_moderation') as $workflow) {
      if ($workflow->getTypePlugin()
        ->appliesToEntityTypeAndBundle($entity_type_id, $bundle_id)) {
        $workflow->getTypePlugin()
          ->removeEntityTypeAndBundle($entity_type_id, $bundle_id);
        $workflow->save();
      }
    }
  }
  
  /**
   * Implements hook_ENTITY_TYPE_insert().
   */
  public function workflowInsert(WorkflowInterface $entity) : void {
    // Clear bundle cache so workflow gets added or removed from the bundle
    // information.
    \Drupal::service('entity_type.bundle.info')->clearCachedBundles();
    // Clear field cache so extra field is added or removed.
    \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
    // Clear the views data cache so the extra field is available in views.
    if (\Drupal::moduleHandler()->moduleExists('views')) {
      Views::viewsData()->clear();
    }
  }
  
  /**
   * Implements hook_ENTITY_TYPE_update().
   */
  public function workflowUpdate(WorkflowInterface $entity) : void {
    // Clear bundle cache so workflow gets added or removed from the bundle
    // information.
    \Drupal::service('entity_type.bundle.info')->clearCachedBundles();
    // Clear field cache so extra field is added or removed.
    \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
    // Clear the views data cache so the extra field is available in views.
    if (\Drupal::moduleHandler()->moduleExists('views')) {
      Views::viewsData()->clear();
    }
  }
  
  /**
   * Implements hook_views_post_execute().
   */
  public function viewsPostExecute(ViewExecutable $view) : void {
    // @todo Remove this once broken handlers in views configuration result in
    //   a view no longer returning results. https://www.drupal.org/i/2907954.
    foreach ($view->filter as $id => $filter) {
      if (str_starts_with($id, 'moderation_state') && $filter instanceof Broken) {
        $view->result = [];
        break;

      }
    }
  }

}