Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\Exception;
Chris@18: 
Chris@18: use Drupal\Core\Access\AccessResultInterface;
Chris@18: use Drupal\Core\Access\AccessResultReasonInterface;
Chris@18: use Drupal\Core\Cache\CacheableMetadata;
Chris@18: use Drupal\Core\DependencyInjection\DependencySerializationTrait;
Chris@18: use Drupal\Core\Entity\EntityInterface;
Chris@18: use Drupal\Core\Http\Exception\CacheableAccessDeniedHttpException;
Chris@18: use Drupal\jsonapi\JsonApiResource\ResourceIdentifier;
Chris@18: use Drupal\jsonapi\JsonApiResource\ResourceIdentifierInterface;
Chris@18: use Drupal\jsonapi\JsonApiResource\ResourceIdentifierTrait;
Chris@18: 
Chris@18: /**
Chris@18:  * Enhances the access denied exception with information about the entity.
Chris@18:  *
Chris@18:  * @internal JSON:API maintains no PHP API. The API is the HTTP API. This class
Chris@18:  *   may change at any time and could break any dependencies on it.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18:  * @see jsonapi.api.php
Chris@18:  */
Chris@18: class EntityAccessDeniedHttpException extends CacheableAccessDeniedHttpException implements ResourceIdentifierInterface {
Chris@18: 
Chris@18:   use DependencySerializationTrait;
Chris@18:   use ResourceIdentifierTrait;
Chris@18: 
Chris@18:   /**
Chris@18:    * The error which caused the 403.
Chris@18:    *
Chris@18:    * The error contains:
Chris@18:    *   - entity: The entity which the current user doens't have access to.
Chris@18:    *   - pointer: A path in the JSON:API response structure pointing to the
Chris@18:    *     entity.
Chris@18:    *   - reason: (Optional) An optional reason for this failure.
Chris@18:    *
Chris@18:    * @var array
Chris@18:    */
Chris@18:   protected $error = [];
Chris@18: 
Chris@18:   /**
Chris@18:    * EntityAccessDeniedHttpException constructor.
Chris@18:    *
Chris@18:    * @param \Drupal\Core\Entity\EntityInterface|null $entity
Chris@18:    *   The entity, or NULL when an entity is being created.
Chris@18:    * @param \Drupal\Core\Access\AccessResultInterface $entity_access
Chris@18:    *   The access result.
Chris@18:    * @param string $pointer
Chris@18:    *   (optional) The pointer.
Chris@18:    * @param string $message
Chris@18:    *   (Optional) The display to display.
Chris@18:    * @param string $relationship_field
Chris@18:    *   (Optional) A relationship field name if access was denied because the
Chris@18:    *   user does not have permission to view an entity's relationship field.
Chris@18:    * @param \Exception|null $previous
Chris@18:    *   The previous exception.
Chris@18:    * @param int $code
Chris@18:    *   The code.
Chris@18:    */
Chris@18:   public function __construct($entity, AccessResultInterface $entity_access, $pointer, $message = 'The current user is not allowed to GET the selected resource.', $relationship_field = NULL, \Exception $previous = NULL, $code = 0) {
Chris@18:     assert(is_null($entity) || $entity instanceof EntityInterface);
Chris@18:     parent::__construct(CacheableMetadata::createFromObject($entity_access), $message, $previous, $code);
Chris@18:     $error = [
Chris@18:       'entity' => $entity,
Chris@18:       'pointer' => $pointer,
Chris@18:       'reason' => NULL,
Chris@18:       'relationship_field' => $relationship_field,
Chris@18:     ];
Chris@18:     if ($entity_access instanceof AccessResultReasonInterface) {
Chris@18:       $error['reason'] = $entity_access->getReason();
Chris@18:     }
Chris@18:     $this->error = $error;
Chris@18:     // @todo: remove this ternary operation in https://www.drupal.org/project/jsonapi/issues/2997594.
Chris@18:     $this->resourceIdentifier = $entity ? ResourceIdentifier::fromEntity($entity) : NULL;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Returns the error.
Chris@18:    *
Chris@18:    * @return array
Chris@18:    *   The error.
Chris@18:    */
Chris@18:   public function getError() {
Chris@18:     return $this->error;
Chris@18:   }
Chris@18: 
Chris@18: }