You are here

Home » API reference » Acquia Content Hub 8.2 » ContentHubWebhookController.php

class ContentHubWebhookController in Acquia Content Hub 8.2

Same name and namespace in other branches
  1. 8 src/Controller/ContentHubWebhookController.php \Drupal\acquia_contenthub\Controller\ContentHubWebhookController

Controller for ContentHub webhooks.

Hierarchy

Expanded class hierarchy of ContentHubWebhookController

File

src/Controller/ContentHubWebhookController.php, line 19

Namespace

Drupal\acquia_contenthub\Controller
View source 
class ContentHubWebhookController extends ControllerBase {

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $dispatcher;

  /**
   * Content Hub Client Factory.
   *
   * @var \Drupal\acquia_contenthub\Client\ClientFactory
   */
  protected $clientFactory;

  /**
   * WebhooksSettingsForm constructor.
   *
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
   *   The event dispatcher.
   * @param \Drupal\acquia_contenthub\Client\ClientFactory $client_factory
   *   The client factory.
   */
  public function __construct(EventDispatcherInterface $dispatcher, ClientFactory $client_factory) {
    $this->dispatcher = $dispatcher;
    $this->clientFactory = $client_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('event_dispatcher'), $container
      ->get('acquia_contenthub.client.factory'));
  }

  /**
   * Process an incoming webhook from the ContentHub Service.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   A Symfony request object.
   *
   * @return mixed
   *   The response.
   */
  public function receiveWebhook(Request $request) {

    // If you're using a host re-writer, you need to find the original host.
    if ($request->headers
      ->has('x-original-host')) {
      $request->headers
        ->set('host', $request->headers
        ->get('x-original-host'));
    }

    // Obtain the headers.
    $payload = $request
      ->getContent();
    try {
      $key = $this
        ->validateWebhookSignature($request);
      if ($key) {

        // Notify about the arrival of the webhook request.
        $this
          ->getLogger('acquia_contenthub')
          ->debug(new FormattableMarkup('Webhook landing: @whook', [
          '@whook' => print_r($payload, TRUE),
        ]));
        if ($payload = Json::decode($payload)) {
          $event = new HandleWebhookEvent($request, $payload, $key, $this->clientFactory
            ->getClient());
          $this->dispatcher
            ->dispatch(AcquiaContentHubEvents::HANDLE_WEBHOOK, $event);
          return $event
            ->getResponse();
        }
      }
      else {
        $ip_address = $request
          ->getClientIp();
        $message = new FormattableMarkup('Webhook [from IP = @IP] rejected (Signatures do not match): @whook', [
          '@IP' => $ip_address,
          '@whook' => print_r($payload, TRUE),
        ]);
        $this
          ->getLogger('acquia_contenthub')
          ->debug($message);
      }
    } catch (\Exception $e) {
      $ip_address = $request
        ->getClientIp();
      $message = new FormattableMarkup('Webhook [from IP = @IP] rejected. @error', [
        '@IP' => $ip_address,
        '@error' => print_r($e
          ->getMessage(), TRUE),
      ]);
      $this
        ->getLogger('acquia_contenthub')
        ->debug($message);
    }
    return new Response();
  }

  /**
   * Validates a webhook signature.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return bool|\Acquia\Hmac\KeyInterface
   *   TRUE if signature verification passes, FALSE otherwise.
   */
  public function validateWebhookSignature(Request $request) {
    return $this->clientFactory
      ->authenticate($request);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentHubWebhookController::$clientFactory protected property Content Hub Client Factory.
ContentHubWebhookController::$dispatcher protected property The event dispatcher.
ContentHubWebhookController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ContentHubWebhookController::receiveWebhook public function Process an incoming webhook from the ContentHub Service.
ContentHubWebhookController::validateWebhookSignature public function Validates a webhook signature.
ContentHubWebhookController::__construct public function WebhooksSettingsForm constructor.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.