eca-1.0.x-dev/modules/miscellaneous/src/Plugin/ECA/Event/KernelEvent.php

<?php

namespace Drupal\eca_misc\Plugin\ECA\Event;

use Drupal\Core\DrupalKernelInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\eca\Attribute\EcaEvent;
use Drupal\eca\Attribute\Token;
use Drupal\eca\Plugin\DataType\DataTransferObject;
use Drupal\eca\Plugin\ECA\Event\EventBase;
use Drupal\eca_misc\Event\EcaExceptionEvent;
use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\Event\TerminateEvent;
use Symfony\Component\HttpKernel\Event\ViewEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Contracts\EventDispatcher\Event;

/**
 * Plugin implementation of the ECA Events for the kernel.
 */
#[EcaEvent(
  id: 'kernel',
  deriver: 'Drupal\eca_misc\Plugin\ECA\Event\KernelEventDeriver',
  version_introduced: '1.0.0',
)]
class KernelEvent extends EventBase {

  /**
   * An instance holding event data accessible as Token.
   *
   * @var \Drupal\eca\Plugin\DataType\DataTransferObject|null
   */
  protected ?DataTransferObject $eventData = NULL;

  /**
   * {@inheritdoc}
   */
  public static function definitions(): array {
    return [
      'view' => [
        'label' => 'Controller does not return a Response instance',
        'event_name' => KernelEvents::VIEW,
        'event_class' => ViewEvent::class,
        'description' => new TranslatableMarkup('Fires, when a controller does not return a Response instance.'),
      ],
      'controller' => [
        'label' => 'Controller found to handle request',
        'event_name' => KernelEvents::CONTROLLER,
        'event_class' => ControllerEvent::class,
        'description' => new TranslatableMarkup('Fires, once a controller was found for handling a request.'),
      ],
      'controller_arguments' => [
        'label' => 'Controller arguments have been resolved',
        'event_name' => KernelEvents::CONTROLLER_ARGUMENTS,
        'event_class' => ControllerArgumentsEvent::class,
        'description' => new TranslatableMarkup('Fires, once controller arguments have been resolved.'),
      ],
      'exception' => [
        'label' => 'Uncaught exception',
        'event_name' => KernelEvents::EXCEPTION,
        'event_class' => ExceptionEvent::class,
        'description' => new TranslatableMarkup('Fires, when an uncaught exception appears.'),
      ],
      'finish_request' => [
        'label' => 'Response for request created',
        'event_name' => KernelEvents::FINISH_REQUEST,
        'event_class' => FinishRequestEvent::class,
        'description' => new TranslatableMarkup('Fires, when a response was generated for a request.'),
      ],
      'request' => [
        'label' => 'Start dispatching request',
        'event_name' => KernelEvents::REQUEST,
        'event_class' => RequestEvent::class,
        'description' => new TranslatableMarkup('Fires at the very beginning of request dispatching.'),
      ],
      'response' => [
        'label' => 'Response created',
        'event_name' => KernelEvents::RESPONSE,
        'event_class' => ResponseEvent::class,
        'description' => new TranslatableMarkup('Fires, once a response was created for replying to a request.'),
      ],
      'terminate' => [
        'label' => 'Response was sent',
        'event_name' => KernelEvents::TERMINATE,
        'event_class' => TerminateEvent::class,
        'description' => new TranslatableMarkup('Fires, once a response was sent.'),
      ],
      'container_initialize_subrequest_finished' => [
        'label' => 'Service container finished initializing',
        'event_name' => DrupalKernelInterface::CONTAINER_INITIALIZE_SUBREQUEST_FINISHED,
        'event_class' => Event::class,
        'description' => new TranslatableMarkup('Fires, when the service container finished initializing in subrequest.'),
      ],
      'exception_status_code' => [
        'label' => 'Exception status code',
        'event_name' => EcaExceptionEvent::EVENT_NAME,
        'event_class' => EcaExceptionEvent::class,
        'description' => new TranslatableMarkup('Event that is dispatched when a routing exception 4xx or 5xx is found.'),
        'version_introduced' => '2.1.0',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  #[Token(
    name: 'event',
    description: 'The event.',
    classes: [
      RequestEvent::class,
      ResponseEvent::class,
    ],
    properties: [
      new Token(name: 'method', description: 'The request method, e.g. "GET" or "POST".'),
      new Token(name: 'path', description: 'The requested path.'),
      new Token(name: 'query', description: 'The query arguments of the request.'),
      new Token(name: 'headers', description: 'The request headers.'),
      new Token(name: 'content_type', description: 'The content type of the request.'),
      new Token(name: 'content', description: 'The content of the POST request.'),
      new Token(name: 'ip', description: 'The client IP.'),
      new Token(name: 'code', description: 'The response code.', classes: [
        EcaExceptionEvent::class,
        ResponseEvent::class,
      ]),
    ],
  )]
  protected function buildEventData(): array {
    $event = $this->event;
    $data = [];

    if ($event instanceof RequestEvent || $event instanceof ResponseEvent) {
      $data += [
        'method' => $event->getRequest()->getMethod(),
        'path' => $event->getRequest()->getPathInfo(),
        'query' => $event->getRequest()->query->all(),
        'headers' => $event->getRequest()->headers->all(),
        'content_type' => $event->getRequest()->getContentTypeFormat(),
        'content' => (string) $event->getRequest()->getContent(),
        'ip' => $event->getRequest()->getClientIp(),
      ];
    }
    if ($event instanceof EcaExceptionEvent) {
      $data += [
        'code' => $event->getStatusCode(),
      ];
    }
    if ($event instanceof ResponseEvent) {
      $data += [
        'code' => $event->getResponse()->getStatusCode(),
      ];
    }

    $data += parent::buildEventData();
    return $data;
  }

}