Drupal\mongodb_watchdog\Controller\RequestController

Complexity

Total Complexity

15

Size/Duplication

Total Lines	262
Duplicated Lines	6.49 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	1
A	build()	0	20	3
A	buildMainTable()	8	8	1
A	buildMainTableHeader()	0	12	1
B	buildMainTableRows()	0	26	2
A	create()	0	19	1
A	getRowData()	9	9	1
B	getTop()	0	27	3
A	simplifyPath()	0	7	2

<?php

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Component\Utility\Unicode;
use Drupal\Core\Config\ImmutableConfig;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Link;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\mongodb_watchdog\Event;
use Drupal\mongodb_watchdog\Logger;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * The controller for the request events page.
 */
class RequestController extends ControllerBase {

  /**
   * The core date.formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The length of the absolute path to the site root, in runes.
   *
   * @var int
   */
  protected $rootLength;

  /**
   * A Unicode instance, to avoid static access.
   *
   * @var \Drupal\Component\Utility\Unicode
   */
  protected $unicode;

  /**
   * Controller constructor.
   *
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger service, to log intervening events.
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The MongoDB logger, to load stored events.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   The module configuration.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter
   *   The core date.formatter service.
   * @param \Drupal\Component\Utility\Unicode $unicode
   *   A Unicode instance, to avoid static access.
   */
  public function __construct(
    LoggerInterface $logger,
    Logger $watchdog,
    ImmutableConfig $config,
    DateFormatterInterface $dateFormatter,
    Unicode $unicode,
    RfcLogLevel $rfcLogLevel,
    Link $link) {
    parent::__construct($logger, $watchdog, $config);

    $this->dateFormatter = $dateFormatter;
    $this->link = $link;
    $this->rfcLogLevel = $rfcLogLevel;
    $this->unicode = $unicode;

    // Add terminal "/".
    $this->rootLength = $this->unicode->strlen(DRUPAL_ROOT) + 1;
  }

  /**
   * Controller.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param string $uniqueId
   *   The unique request id from mod_unique_id. Unsafe.
   *
   * @return array<string,string|array>
   *   A render array.
   */
  public function build(Request $request, $uniqueId) {
    if (!preg_match('/^[\w-]+$/', $uniqueId)) {
      throw new NotFoundHttpException(t('Request ID is not well-formed.'));
    }

    $events = $this->getRowData($request, $uniqueId);

    if (empty($events)) {
      $top = NULL;
      $main = $this->buildEmpty(t('No events found for this request.'));
    }
    else {
      list(, $first) = reset($events);
      $top = $this->getTop($uniqueId, $first);
      $main = $this->buildMainTable($events);
    }

    $ret = $this->buildDefaults($main, $top);
    return $ret;
  }

  /**
   * Build the main table.
   *
   * @param array $rows
   *   The event data.
   *
   * @return array<string,string|array>

Consider making the return type a bit more specific; maybe use array<string,\Drupal\Core\StringTranslation\TranslatableMarkup[]|array<string,array|string>|string>.

   *   A render array for the main table.
   */
  protected function buildMainTable(array $rows) {

This method seems to be duplicated in your project.

    $ret = [
      '#header' => $this->buildMainTableHeader(),
      '#rows' => $this->buildMainTableRows($rows),
      '#type' => 'table',
    ];
    return $ret;
  }

  /**
   * Build the main table header.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
   *   A table header array.
   */
  protected function buildMainTableHeader() {
    $header = [
      t('Sequence'),
      t('Type'),
      t('Severity'),
      t('Event'),
      t('File'),
      t('Line'),
    ];

    return $header;
  }

  /**
   * Build the main table rows.
   *
   * @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
   *   A fully loaded array of events and their templates.
   *
   * @return array<string,array|string>
   *   A render array for a table.
   */
  protected function buildMainTableRows(array $events) {
    $rows = [];
    $levels = $this->rfcLogLevel->getLevels();

    /** @var \Drupal\mongodb_watchdog\EventTemplate $template */
    /** @var \Drupal\mongodb_watchdog\Event $event */
    foreach ($events as list($template, $event)) {

Variable $template is undefined.

Variable $event is undefined.

      $row = [];
      $row[] = ['data' => $event->requestTracking_sequence];

Variable $event is undefined.

      $row[] = $template->type;

Variable $template is undefined.

      $row[] = [
        'data' => $levels[$template->severity],

Variable $template is undefined.

        'class' => OverviewController::SEVERITY_CLASSES[$template->severity],

Variable $template is undefined.

      ];
      $row[] = [
        'data' => $this->link->createFromRoute($template->asString($event->variables), 'mongodb_watchdog.reports.detail', [

Variable $template is undefined.

Variable $event is undefined.

          'eventTemplate' => $template->_id,

Variable $template is undefined.

        ]),
      ];
      $row[] = $this->simplifyPath($event->variables['%file']);

Variable $event is undefined.

      $row[] = $event->variables['%line'];

Variable $event is undefined.

      $rows[] = $row;
    }

    return $rows;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    /** @var \Psr\Log\LoggerInterface $logger */
    $logger = $container->get('logger.channel.mongodb_watchdog');

    /** @var \Drupal\mongodb_watchdog\Logger $watchdog */
    $watchdog = $container->get('mongodb.logger');

    /** @var \Drupal\Core\Config\ImmutableConfig $config */
    $config = $container->get('config.factory')->get('mongodb_watchdog.settings');

    /** @var \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter */
    $dateFormatter = $container->get('date.formatter');

    $link = new Link();
    $rfcLogLevel = new RfcLogLevel();
    $unicode = new Unicode();

    return new static($logger, $watchdog, $config, $dateFormatter, $unicode, $rfcLogLevel, $link);
  }

  /**
   * Obtain the data from the logger.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request. Needed for paging.
   * @param string $uniqueId
   *   The request for which to build the detail page.
   *
   * @return \Drupal\mongodb_watchdog\Event[]

Should the return type not be \Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[][]?

   *   The data array.
   */
  protected function getRowData(Request $request, $uniqueId) {

This method seems to be duplicated in your project.

    $count = $this->watchdog->requestEventsCount($uniqueId);
    $page = $this->setupPager($request, $count);
    $skip = $page * $this->itemsPerPage;
    $height = $this->itemsPerPage;

    $events = $this->watchdog->requestEvents($uniqueId, $skip, $height);
    return $events;
  }

  /**
   * Build the heading rows on the per-request event occurrences page.
   *
   * @param string $uniqueId

Should the type for parameter $uniqueId not be string|null?

   *   The unique request id.
   * @param \Drupal\mongodb_watchdog\Event $first

Should the type for parameter $first not be null|Event?

   *   A fully loaded array of events and their templates.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
   *   A render array for a table.
   */
  protected function getTop($uniqueId = NULL, Event $first = NULL) {
    $location = $first->location;
    $timestamp = isset($first->timestamp)
      ? $this->dateFormatter->format($first->timestamp, 'long')
      : t('No information');

    $rows = [
      [t('Request ID'), $uniqueId],
      [t('Location'), $location],
      [t('Date/time'), $timestamp],
    ];

    foreach ($rows as &$row) {
      $row[0] = [
        'data' => $row[0],
        'header' => TRUE,
      ];
    }

    $ret = [
      '#caption' => t('Request'),
      '#rows' => $rows,
      '#type' => 'table',
    ];

    return $ret;
  }

  /**
   * Convert an absolute path to a relative one if below the site root.
   *
   * @param string $path
   *   An absolute path on the filesystem.
   *
   * @return string
   *   A relative path if possible, otherwise the input path.
   */
  public function simplifyPath($path) {
    $ret = ($this->unicode->strpos($path, DRUPAL_ROOT) === 0)
      ? $this->unicode->substr($path, $this->rootLength)
      : $path;

    return $ret;
  }

}