WorkflowAccessControlHandler.php in Workflow 8

Namespace

Drupal\workflow

File

src/WorkflowAccessControlHandler.php

<?php

namespace Drupal\workflow;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityAccessControlHandler;
use Drupal\Core\Entity\EntityHandlerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\workflow\Entity\WorkflowManager;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines the access control handler for the workflow entity type.
 *
 * @see \Drupal\workflow\Entity\Workflow
 * @ingroup workflow_access
 */
class WorkflowAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {

  /**
   * This is a hack.
   *
   * {@inheritdoc}
   */
  public function __construct(EntityTypeInterface $entity_type = NULL) {
    $this->entityType = $entity_type;
    if ($entity_type) {
      parent::__construct($entity_type);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type);
  }

  /**
   * {@inheritdoc}
   */
  public function access(EntityInterface $entity, $operation, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $account = workflow_current_user($account);
    $result = parent::access($entity, $operation, $account, TRUE);

    // Only for Edit/Delete transition. For Add/create, use createAccess.
    switch ($entity
      ->getEntityTypeId()) {
      case 'workflow_scheduled_transition':
        switch ($operation) {
          case 'update':

            // This operation is not defined for Scheduled Transitions.
            $result = AccessResult::forbidden();
            break;
          case 'delete':

            // This operation is not defined for Scheduled Transitions.
            $result = AccessResult::forbidden();
            break;
          case 'revert':

            // This operation is not defined for Scheduled Transitions.
            $result = AccessResult::forbidden();
            break;
          default:
            $result = parent::access($entity, $operation, $account, TRUE);
            break;
        }
        break;
      case 'workflow_transition':

        /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $transition */
        $transition = $entity;
        $is_owner = WorkflowManager::isOwner($account, $transition);
        $type_id = $transition
          ->getWorkflowId();
        switch ($operation) {
          case 'update':
            if ($account
              ->hasPermission("bypass {$type_id} workflow_transition access")) {
              $result = AccessResult::allowed()
                ->cachePerPermissions();
            }
            elseif ($account
              ->hasPermission("edit any {$type_id} workflow_transition")) {
              $result = AccessResult::allowed()
                ->cachePerPermissions();
            }
            elseif ($is_owner && $account
              ->hasPermission("edit own {$type_id} workflow_transition")) {
              $result = AccessResult::allowed()
                ->cachePerPermissions();
            }
            return $return_as_object ? $result : $result
              ->isAllowed();
          case 'delete':

            // The delete operation is not defined for Transitions.
            $result = AccessResult::forbidden();
            break;
          case 'revert':
            if (!$transition
              ->isRevertable()) {

              // No access for same state transitions.
              $result = AccessResult::forbidden();
            }
            elseif ($account
              ->hasPermission("revert any {$type_id} workflow_transition")) {

              // OK, add operation.
              $result = AccessResult::allowed();
            }
            elseif ($is_owner && $account
              ->hasPermission("revert own {$type_id} workflow_transition")) {

              // OK, add operation.
              $result = AccessResult::allowed();
            }
            else {

              // No access.
              $result = AccessResult::forbidden();
            }
            if ($result == AccessResult::allowed()) {

              // Ask other modules if the reversion is allowed.
              // Reversing old and new sid!
              $permitted = \Drupal::moduleHandler()
                ->invokeAll('workflow', [
                'transition revert',
                $transition,
                $account,
              ]);

              // Remove access if it is vetoed by other module.
              if (in_array(FALSE, $permitted, TRUE)) {
                $result = AccessResult::forbidden();
              }
            }
            break;
          default:
            $result = parent::access($entity, $operation, $account, TRUE);
            break;
        }
        break;
      case 'workflow_config_transition':

        // This is not (yet) configured.
        break;
      case 'workflow_state':
        switch ($operation) {
          case 'view label':

            // The following two lines are copied from below, and need to be reviewed carefully.
            $result = AccessResult::allowed();
            return $return_as_object ? $result : $result
              ->isAllowed();
          default:

            // E.g., operation 'update' on the WorkflowStates config page.
            break;
        }
        break;
    }
    $result = $result
      ->cachePerPermissions();
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function createAccess($entity_bundle = NULL, AccountInterface $account = NULL, array $context = [], $return_as_object = FALSE) {
    workflow_debug(__FILE__, __FUNCTION__, __LINE__);

    // @todo D8: test this snippet.

    /** @var \Drupal\Core\Access\AccessResult $result */
    $result = parent::createAccess($entity_bundle, $account, $context, TRUE);
    $result = $result
      ->cachePerPermissions();
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    workflow_debug(__FILE__, __FUNCTION__, __LINE__);

    // @todo D8: test this snippet.
    return AccessResult::allowedIf($account
      ->hasPermission('create ' . $entity_bundle . ' content'))
      ->cachePerPermissions();
  }

}

Classes

Name	Description
WorkflowAccessControlHandler	Defines the access control handler for the workflow entity type.