drupalorg-1.0.x-dev/src/Controller/WebhooksController.php

<?php

namespace Drupal\drupalorg\Controller;

use Drupal\Component\Serialization\Json;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Queue\QueueFactory;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;

/**
 * Controller to manage system webhooks.
 */
class WebhooksController extends ControllerBase {

  /**
   * Queue factory service.
   *
   * @var \Drupal\Core\Queue\QueueFactory
   */
  protected QueueFactory $queueFactory;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('queue')
    );
  }

  /**
   * Construct method.
   *
   * @param \Drupal\Core\Queue\QueueFactory $queue_factory
   *   Queue factory.
   */
  public function __construct(QueueFactory $queue_factory) {
    $this->queueFactory = $queue_factory;
  }

  /**
   * Webhook callback.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   Response object.
   */
  public function projectWebhook(Request $request): JsonResponse {
    $result = [
      'status' => 'error',
      'message' => $this->t('Unknown error'),
    ];

    // Check headers and token.
    $gitlab_token = $this->config('drupalorg.gitlab_settings')->get('webhook_token');
    if (
      !empty($gitlab_token) &&
      ($request->server->get('HTTP_X_GITLAB_TOKEN') === $gitlab_token)
    ) {
      $data = Json::decode($request->getContent());
      if (empty($data['event_name'])) {
        $result['message'] = $this->t('Webhook payload does not contain the event name');
      }
      elseif ($data['event_name'] == 'repository_update') {
        $this->queueFactory->get('drupalorg_project_activity_webhook_queue_worker')->createItem([
          'event_name' => 'repository_update',
          'project_id' => $data['project_id'] ?? NULL,
        ]);
        $result['message'] = $this->t('Event was queued successfully');
        $result['status'] = 'success';
      }
      else {
        $result['message'] = $this->t('Event not covered by code');
        $result['status'] = 'warning';
      }
    }
    else {
      $result['message'] = $this->t('Invalid token');
    }

    return new JsonResponse($result);
  }

  /**
   * Webhook callback for activities related to contributions.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   Response object.
   */
  public function contributionActivityWebhook(Request $request): JsonResponse {
    $result = [
      'status' => 'error',
      'message' => $this->t('Unknown error'),
    ];

    // Requests might come from www.drupal.org issues or GitLab issues.
    $gitlab_token = $this->config('drupalorg.gitlab_settings')->get('webhook_token');
    $drupalorg_credit_migration_token = $this->config('drupalorg.settings')->get('credit_migration_token');
    if (
      !empty($gitlab_token) &&
      ($request->server->get('HTTP_X_GITLAB_TOKEN') === $gitlab_token)
    ) {
      $result = $this->contributionActivityWebhookFromGitLab($request);
    }
    elseif (
      !empty($drupalorg_credit_migration_token) &&
      ($request->headers->get('Drupalorg-Credit-Migration-Token') === $drupalorg_credit_migration_token)
    ) {
      // Depends on https://www.drupal.org/project/drupalorg/issues/3327584
      $result = $this->contributionActivityWebhookFromDrupal($request);
    }
    else {
      $result['message'] = $this->t('Invalid token');
    }

    return new JsonResponse($result);
  }

  /**
   * Process the webhook request from gitlab.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request object.
   *
   * @return array
   *   Result to return.
   */
  protected function contributionActivityWebhookFromGitLab(Request $request): array {
    $result = [
      'status' => 'error',
    ];

    $data = Json::decode($request->getContent());
    if (empty($data['event_type'])) {
      $result['message'] = $this->t('Webhook payload does not contain the event type');
    }
    elseif ($data['event_type'] == 'issue') {
      $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
        'event_name' => 'issue_update',
        'project_id' => $data['object_attributes']['project_id'] ?? NULL,
        'iid' => $data['object_attributes']['iid'] ?? NULL,
        'url' => $data['object_attributes']['url'],
        'action' => $data['object_attributes']['action'],
      ]);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    elseif ($data['event_type'] == 'merge_request') {
      $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
        'event_name' => 'merge_request_update',
        'project_id' => $data['project']['id'] ?? $data['object_attributes']['target_project_id'] ?? NULL,
        'iid' => $data['object_attributes']['iid'] ?? NULL,
        'url' => $data['object_attributes']['url'],
        'action' => $data['object_attributes']['action'],
      ]);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    elseif ($data['event_type'] == 'note') {
      // For now, we only consider issues and merge requests.
      $type = '-unknown-';
      if (!empty($data['issue'])) {
        $type = 'issue';
      }
      elseif (!empty($data['merge_request'])) {
        $type = 'merge_request';
      }

      if (!empty($data[$type])) {
        $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
          'event_name' => 'comment_update',
          'project_id' => $data['project_id'] ?? NULL,
          'iid' => $data[$type]['iid'] ?? NULL,
          'url' => $data[$type]['url'],
          'comment' => $data['object_attributes']['note'] ?? NULL,
          'comment_id' => $data['object_attributes']['id'] ?? NULL,
          'user' => $data['user'] ?? NULL,
        ]);
        $result['message'] = $this->t('Event was queued successfully');
        $result['status'] = 'success';
      }
      else {
        $result['message'] = $this->t('Comments are only processed for issues and merge requests.');
      }
    }
    elseif ($data['event_type'] == 'award') {
      $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
        'event_name' => 'emoji',
        'issue_link' => $data['issue']['url'] ?? NULL,
        'note' => $data['note']['note'] ?? NULL,
        'emoji' => $data['object_attributes']['name'] ?? NULL,
        'user_id' => $data['user']['id'] ?? NULL,
      ]);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    else {
      $result['message'] = $this->t('Event not covered by code');
      $result['status'] = 'warning';
    }

    return $result;
  }

  /**
   * Process the webhook request from Drupal.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request object.
   *
   * @return array
   *   Result to return.
   */
  protected function contributionActivityWebhookFromDrupal(Request $request): array {
    $result = [
      'status' => 'error',
    ];

    $data = $request->request->all();
    if (empty($data['event_type'])) {
      $result['message'] = $this->t('Webhook payload does not contain the event type');
    }
    elseif ($data['event_type'] == 'issue') {
      $action = $data['action'] ?? '-';
      $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
        'event_name' => 'drupalorg_issue_update',
        'url' => $data['url'],
        'action' => $action,
      ]);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    elseif ($data['event_type'] == 'issue_migration') {
      $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
        'event_name' => 'drupalorg_issue_migrated',
        'url' => $data['url'],
        'new_url' => $data['new_url'],
      ]);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    elseif ($data['event_type'] == 'comment') {
      $this->queueFactory->get('drupalorg_contribution_activity_webhook_queue_worker')->createItem([
        'event_name' => 'drupalorg_comment_update',
        'url' => $data['url'],
      ]);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    else {
      $result['message'] = $this->t('Event not covered by code');
      $result['status'] = 'warning';
    }

    return $result;
  }

  /**
   * Webhook callback for activities related to security issues.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   Response object.
   */
  public function securityIssueWebhook(Request $request): JsonResponse {
    $result = [
      'status' => 'error',
    ];

    $gitlab_token = $this->config('drupalorg.gitlab_settings')->get('webhook_token');
    if (
      !empty($gitlab_token) &&
      ($request->server->get('HTTP_X_GITLAB_TOKEN') === $gitlab_token)
    ) {
      $data = Json::decode($request->getContent());
      $item = [
        'object_kind' => $data['object_kind'],
        'action' => $data['object_attributes']['action'],
        'project_id' => $data['object_attributes']['project_id'] ?? NULL,
        'object_id' => $data['object_attributes']['id'] ?? NULL,
        'iid' => $data['object_attributes']['iid'] ?? $data['issue']['iid'] ?? NULL,
        'discussion_id' => $data['object_attributes']['discussion_id'] ?? NULL,
      ];
      if (!empty($data['changes']['labels']['previous'])) {
        $item['previous_labels'] = array_column($data['changes']['labels']['previous'], 'id', 'title');
      }
      if (!empty($data['changes']['labels']['current'])) {
        $item['current_labels'] = array_column($data['changes']['labels']['current'], 'id', 'title');
      }
      $this->queueFactory->get('drupalorg_security_issue_webhook_queue_worker')->createItem($item);
      $result['message'] = $this->t('Event was queued successfully');
      $result['status'] = 'success';
    }
    else {
      $result['message'] = $this->t('Invalid token');
    }

    return new JsonResponse($result);
  }

}