arch-8.x-1.x-dev/modules/product/src/Access/ProductAccessControlHandler.php

<?php

namespace Drupal\arch_product\Access;

use Drupal\arch_product\Entity\ProductInterface;
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\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Session\AccountInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines the access control handler for the product entity type.
 *
 * @package Drupal\arch_product\Access
 * @ingroup product_access
 */
class ProductAccessControlHandler extends EntityAccessControlHandler implements ProductAccessControlHandlerInterface, EntityHandlerInterface {

  /**
   * The product grant storage.
   *
   * @var \Drupal\arch_product\Access\ProductGrantDatabaseStorageInterface
   */
  protected $grantStorage;

  /**
   * {@inheritdoc}
   */
  public function __construct(
    EntityTypeInterface $entity_type,
    ProductGrantDatabaseStorageInterface $grant_storage,
  ) {
    parent::__construct($entity_type);
    $this->grantStorage = $grant_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(
    ContainerInterface $container,
    EntityTypeInterface $entity_type,
  ) {
    return new static(
      $entity_type,
      $container->get('product.grant_storage')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function access(
    EntityInterface $entity,
    $operation,
    ?AccountInterface $account = NULL,
    $return_as_object = FALSE,
  ) {
    $account = $this->prepareUser($account);

    if ($account->hasPermission('bypass product access')) {
      $result = AccessResult::allowed()->cachePerPermissions();
      return $return_as_object ? $result : $result->isAllowed();
    }
    if (!$account->hasPermission('access product')) {
      $result = AccessResult::forbidden("The 'access product' permission is required.")->cachePerPermissions();
      return $return_as_object ? $result : $result->isAllowed();
    }
    $result = parent::access($entity, $operation, $account, TRUE)->cachePerPermissions();

    return $return_as_object ? $result : $result->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function createAccess(
    $entity_bundle = NULL,
    ?AccountInterface $account = NULL,
    array $context = [],
    $return_as_object = FALSE,
  ) {
    $account = $this->prepareUser($account);

    if ($account->hasPermission('bypass product access')) {
      $result = AccessResult::allowed()->cachePerPermissions();
      return $return_as_object ? $result : $result->isAllowed();
    }
    if (!$account->hasPermission('access product')) {
      $result = AccessResult::forbidden()->cachePerPermissions();
      return $return_as_object ? $result : $result->isAllowed();
    }

    $result = parent::createAccess($entity_bundle, $account, $context, TRUE)->cachePerPermissions();
    return $return_as_object ? $result : $result->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(
    EntityInterface $product,
    $operation,
    AccountInterface $account,
  ) {
    /** @var \Drupal\arch_product\Entity\ProductInterface $product */
    // Fetch information from the product object if possible.
    $status = $product->isPublished();
    $uid = $product->getOwnerId();

    // Check if creator can view their own unpublished products.
    if (
      $operation === 'view'
      && !$status
      && $account->hasPermission('view own unpublished product')
      && $account->isAuthenticated()
      && $account->id() == $uid
    ) {
      return AccessResult::allowed()
        ->cachePerPermissions()
        ->cachePerUser()
        ->addCacheableDependency($product);
    }

    // Evaluate product grants.
    return $this->grantStorage->access($product, $operation, $account);
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(
    AccountInterface $account,
    array $context,
    $entity_bundle = NULL,
  ) {
    $result = $account->hasPermission('create ' . $entity_bundle . ' product');
    return AccessResult::allowedIf($result)->cachePerPermissions();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkFieldAccess(
    $operation,
    FieldDefinitionInterface $field_definition,
    AccountInterface $account,
    ?FieldItemListInterface $items = NULL,
  ) {
    // Only users with the administer products permission can edit
    // administrative fields.
    $administrative_fields = [
      'uid',
      'status',
      'created',
      'promote',
      'sticky',
    ];
    if (
      $operation == 'edit'
      && in_array($field_definition->getName(), $administrative_fields, TRUE)
    ) {
      return AccessResult::allowedIfHasPermission($account, 'administer products');
    }

    // No user can change read only fields.
    $read_only_fields = [
      'revision_timestamp',
      'revision_uid',
    ];
    if (
      $operation == 'edit'
      && in_array($field_definition->getName(), $read_only_fields, TRUE)
    ) {
      return AccessResult::forbidden();
    }

    // Users have access to the revision_log field either if they have
    // administrative permissions or if the new revision option is enabled.
    if (
      $operation == 'edit'
      && $field_definition->getName() == 'revision_log'
    ) {
      if ($account->hasPermission('administer products')) {
        return AccessResult::allowed()->cachePerPermissions();
      }
      return AccessResult::allowedIf($items->getEntity()->type->entity->isNewRevision())->cachePerPermissions();
    }
    return parent::checkFieldAccess($operation, $field_definition, $account, $items);
  }

  /**
   * {@inheritdoc}
   */
  public function acquireGrants(ProductInterface $product) {
    $grants = $this->moduleHandler->invokeAll('product_access_records', [$product]);
    // Let modules alter the grants.
    $this->moduleHandler->alter('product_access_records', $grants, $product);
    // If no grants are set and the product is published, then use the default
    // grant.
    if (empty($grants) && $product->isPublished()) {
      $grants[] = [
        'realm' => 'all',
        'gid' => 0,
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,
      ];
    }
    return $grants;
  }

  /**
   * {@inheritdoc}
   */
  public function writeGrants(ProductInterface $product, $delete = TRUE) {
    $grants = $this->acquireGrants($product);
    $this->grantStorage->write($product, $grants, NULL, $delete);
  }

  /**
   * {@inheritdoc}
   */
  public function writeDefaultGrant() {
    $this->grantStorage->writeDefault();
  }

  /**
   * {@inheritdoc}
   */
  public function deleteGrants() {
    $this->grantStorage->delete();
  }

  /**
   * {@inheritdoc}
   */
  public function countGrants() {
    return $this->grantStorage->count();
  }

  /**
   * {@inheritdoc}
   */
  public function checkAllGrants(AccountInterface $account) {
    return $this->grantStorage->checkAll($account);
  }

}