OverviewController - Code Metrics - Inspection of "Issue #2763495: Reduce duplication in controllers..." - FGM/mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 8.x-2.x (#24)

by Frédéric G.

created 2016-07-09 20:36 UTC

OverviewController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	303
Duplicated Lines	5.94 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	18
loc	303
rs	10
wmc	17
lcom	1
cbo	5

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	1
A	build()	0	16	1
B	buildRows()	0	40	2
A	create()	0	21	1
A	getEventLink()	0	21	3
B	getEventSource()	0	36	6
A	setupPager()	18	18	3

How to fix Duplicated Code

<?php

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Component\Utility\SafeMarkup;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Config\ImmutableConfig;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Form\FormBuilderInterface;
use Drupal\Core\Link;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\mongodb_watchdog\Event;
use Drupal\mongodb_watchdog\EventTemplate;
use Drupal\mongodb_watchdog\Form\OverviewFilterForm;
use Drupal\mongodb_watchdog\Logger;
use Psr\Log\LogLevel;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Class OverviewController provides the main MongoDB Watchdog report page.
 */
class OverviewController extends ControllerBase {
  const EVENT_TYPE_MAP = [
    'typeMap' => [
      'array' => 'array',
      'document' => 'array',
      'root' => 'Drupal\mongodb_watchdog\Event',
    ],
  ];
  const SEVERITY_PREFIX = 'mongodb_watchdog__severity_';
  const SEVERITY_CLASSES = [
    RfcLogLevel::DEBUG => self::SEVERITY_PREFIX . LogLevel::DEBUG,
    RfcLogLevel::INFO => self::SEVERITY_PREFIX . LogLevel::INFO,
    RfcLogLevel::NOTICE => self::SEVERITY_PREFIX . LogLevel::NOTICE,
    RfcLogLevel::WARNING => self::SEVERITY_PREFIX . LogLevel::WARNING,
    RfcLogLevel::ERROR => self::SEVERITY_PREFIX . LogLevel::ERROR,
    RfcLogLevel::CRITICAL => self::SEVERITY_PREFIX . LogLevel::CRITICAL,
    RfcLogLevel::ALERT => self::SEVERITY_PREFIX . LogLevel::ALERT,
    RfcLogLevel::EMERGENCY => self::SEVERITY_PREFIX . LogLevel::EMERGENCY,
  ];

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

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The core logger channel, to log intervening events.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The length of the disk path to DRUPAL_ROOT.
   *
   * @var int
   *
   * @see \Drupal\mongodb_watchdog\Controller\OverviewController::getEventSource()
   */
  protected $rootLength;

  /**
   * The MongoDB logger, to load events.
   *
   * @var \Drupal\mongodb_watchdog\Logger
   */
  protected $watchdog;

  /**
   * 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\Extension\ModuleHandlerInterface $module_handler
   *   A module handler.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The core date_formatter service.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   The module configuration.
   */
  public function __construct(
    LoggerInterface $logger,
    Logger $watchdog,
    ModuleHandlerInterface $module_handler,
    FormBuilderInterface $form_builder,
    DateFormatterInterface $date_formatter,
    ImmutableConfig $config) {
    parent::__construct($config);
    $this->dateFormatter = $date_formatter;
    $this->formBuilder = $form_builder;
    $this->logger = $logger;
    $this->moduleHandler = $module_handler;
    $this->watchdog = $watchdog;

    // Add terminal "/".
    $this->rootLength = Unicode::strlen(DRUPAL_ROOT);

  }

  /**
   * Controller.
   *
   * @return array
   *   A render array.
   */
  public function build(Request $request) {
    $page = $this->setupPager($request);

    $ret = [
      'filter_form' => $this->formBuilder->getForm('Drupal\mongodb_watchdog\Form\OverviewFilterForm'),
      'rows' => $this->buildRows($page),
      'pager' => [
        '#type' => 'pager',
      ],
      '#attached' => [
        'library' => ['mongodb_watchdog/styling'],
      ],
    ];

    return $ret;
  }

  /**
   * Build a table from the event rows.
   *
   * @param int $page
   *   The number of the page to display.
   *
   * @return array

   *   A render array.
   */
  public function buildRows($page) {
    $header = [
      t('#'),
      t('Latest'),
      t('Severity'),
      t('Type'),
      t('Message'),
      t('Source'),
    ];
    $rows = [];
    $levels = RfcLogLevel::getLevels();
    $filters = $_SESSION[OverviewFilterForm::SESSION_KEY] ?? NULL;

    $skip = $page * $this->itemsPerPage;
    $limit = $this->itemsPerPage;
    $cursor = $this->watchdog->templates($filters['type'] ?? [], $filters['severity'] ?? [], $skip, $limit);


    /** @var \Drupal\mongodb_watchdog\EventTemplate $template */
    foreach ($cursor as $template) {
      $row = [];
      $row[] = $template->count;
      $row[] = $this->dateFormatter->format($template->changed, 'short');
      $row[] = [
        'class' => static::SEVERITY_CLASSES[$template->severity],
        'data' => $levels[$template->severity],
      ];
      $row[] = $template->type;
      $row[] = $this->getEventLink($template);
      $row[] = [
        'data' => $this->getEventSource($template, $row),
      ];

      $rows[] = $row;
    }

    return [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
    $date_formatter = $container->get('date.formatter');

    /** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */
    $form_builder = $container->get('form_builder');

    /** @var \Psr\Log\LoggerInterface $logger */
    $logger = $container->get('logger.channel.mongodb_watchdog');

    /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
    $module_handler = $container->get('module_handler');

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

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

    return new static($logger, $watchdog, $module_handler, $form_builder, $date_formatter, $config);
  }

  /**
   * Build the link to the event or top report for the event template.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate $template
   *   The event template for which to buildl the link.
   *
   * @return string
   *   An internal link in string form.
   */
  protected function getEventLink(EventTemplate $template) {
    switch ($template->type) {
      case 'page not found':

        $cell = Link::createFromRoute(t('( Top 404 )'), 'mongodb_watchdog.reports.top404');
        break;

      case 'access denied':

        $cell = Link::createFromRoute(t('( Top 403 )'), 'mongodb_watchdog.reports.top403');
        break;

      default:

        // Limited-length message.
        $message = Unicode::truncate(strip_tags(SafeMarkup::format($template->message, [])), 56, TRUE, TRUE);
        $cell = Link::createFromRoute($message, 'mongodb_watchdog.reports.detail', [
          'event_template' => $template->_id,
        ]);
        break;
    }

    return $cell;
  }

  /**
   * Get the location in source code where the event was logged.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate $template
   *   The template for which to find a source location.
   *
   * @return array

   *   A render array for the source location, possibly empty or wrong.
   */
  protected function getEventSource(EventTemplate $template) {
    if (in_array($template->type, TopController::TYPES)) {
      return '';
    }

    $event_collection = $this->watchdog->eventCollection($template->_id);
    $event = $event_collection->findOne([], static::EVENT_TYPE_MAP);
    if (!($event instanceof Event)) {
      return '';
    }

    $file = $event->variables['%file'] ?? '';

    if ($file && strncmp($file, DRUPAL_ROOT, $this->rootLength) === 0) {
      $hover = Unicode::substr($file, $this->rootLength + 1);
      $file = Unicode::truncate(basename($file), 30);
    }
    else {
      $hover = NULL;
    }

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

    $cell = [
      '#type' => 'html_tag',
      '#tag' => 'span',
      '#value' => "${file}#${line}",
    ];

    if ($hover) {
      $cell['#attributes'] = [
        'class' => 'mongodb_watchdog__code_path',
        'title' => $hover,
      ];
    }

    return $cell;
  }

  /**
   * Set up the templates pager.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return int
   *   The number of the page to display, starting at 0.
   */
  public function setupPager(Request $request) {

    $count = $this->watchdog->templatesCount();
    $height = $this->itemsPerPage;
    pager_default_initialize($count, $height);

    $page = intval($request->query->get('page'));
    if ($page < 0) {
      $page = 0;
    }
    else {
      $page_max = intval(min(ceil($count / $height), PHP_INT_MAX) - 1);
      if ($page > $page_max) {
        $page = $page_max;
      }
    }

    return $page;
  }

}



1		<?php
2
3		namespace Drupal\mongodb_watchdog\Controller;
4
5		use Drupal\Component\Utility\SafeMarkup;
6		use Drupal\Component\Utility\Unicode;
7		use Drupal\Core\Config\ImmutableConfig;
8		use Drupal\Core\Datetime\DateFormatterInterface;
9		use Drupal\Core\Extension\ModuleHandlerInterface;
10		use Drupal\Core\Form\FormBuilderInterface;
11		use Drupal\Core\Link;
12		use Drupal\Core\Logger\RfcLogLevel;
13		use Drupal\mongodb_watchdog\Event;
14		use Drupal\mongodb_watchdog\EventTemplate;
15		use Drupal\mongodb_watchdog\Form\OverviewFilterForm;
16		use Drupal\mongodb_watchdog\Logger;
17		use Psr\Log\LogLevel;
18		use Psr\Log\LoggerInterface;
19		use Symfony\Component\DependencyInjection\ContainerInterface;
20		use Symfony\Component\HttpFoundation\Request;
21
22		/**
23		* Class OverviewController provides the main MongoDB Watchdog report page.
24		*/
25		class OverviewController extends ControllerBase {
26		const EVENT_TYPE_MAP = [
27		'typeMap' => [
28		'array' => 'array',
29		'document' => 'array',
30		'root' => 'Drupal\mongodb_watchdog\Event',
31		],
32		];
33		const SEVERITY_PREFIX = 'mongodb_watchdog__severity_';
34		const SEVERITY_CLASSES = [
35		RfcLogLevel::DEBUG => self::SEVERITY_PREFIX . LogLevel::DEBUG,
36		RfcLogLevel::INFO => self::SEVERITY_PREFIX . LogLevel::INFO,
37		RfcLogLevel::NOTICE => self::SEVERITY_PREFIX . LogLevel::NOTICE,
38		RfcLogLevel::WARNING => self::SEVERITY_PREFIX . LogLevel::WARNING,
39		RfcLogLevel::ERROR => self::SEVERITY_PREFIX . LogLevel::ERROR,
40		RfcLogLevel::CRITICAL => self::SEVERITY_PREFIX . LogLevel::CRITICAL,
41		RfcLogLevel::ALERT => self::SEVERITY_PREFIX . LogLevel::ALERT,
42		RfcLogLevel::EMERGENCY => self::SEVERITY_PREFIX . LogLevel::EMERGENCY,
43		];
44
45		/**
46		* The core date.formatter service.
47		*
48		* @var \Drupal\Core\Datetime\DateFormatterInterface
49		*/
50		protected $dateFormatter;
51
52		/**
53		* The form builder service.
54		*
55		* @var \Drupal\Core\Form\FormBuilderInterface
56		*/
57		protected $formBuilder;
58
59		/**
60		* The core logger channel, to log intervening events.
61		*
62		* @var \Psr\Log\LoggerInterface
63		*/
64		protected $logger;
65
66		/**
67		* The module handler service.
68		*
69		* @var \Drupal\Core\Extension\ModuleHandlerInterface
70		*/
71		protected $moduleHandler;
72
73		/**
74		* The length of the disk path to DRUPAL_ROOT.
75		*
76		* @var int
77		*
78		* @see \Drupal\mongodb_watchdog\Controller\OverviewController::getEventSource()
79		*/
80		protected $rootLength;
81
82		/**
83		* The MongoDB logger, to load events.
84		*
85		* @var \Drupal\mongodb_watchdog\Logger
86		*/
87		protected $watchdog;
88
89		/**
90		* Controller constructor.
91		*
92		* @param \Psr\Log\LoggerInterface $logger
93		* The logger service, to log intervening events.
94		* @param \Drupal\mongodb_watchdog\Logger $watchdog
95		* The MongoDB logger, to load stored events.
96		* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
97		* A module handler.
98		* @param \Drupal\Core\Form\FormBuilderInterface $form_builder
99		* The form builder service.
100		* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
101		* The core date_formatter service.
102		* @param \Drupal\Core\Config\ImmutableConfig $config
103		* The module configuration.
104		*/
105		public function __construct(
106		LoggerInterface $logger,
107		Logger $watchdog,
108		ModuleHandlerInterface $module_handler,
109		FormBuilderInterface $form_builder,
110		DateFormatterInterface $date_formatter,
111		ImmutableConfig $config) {
112		parent::__construct($config);
113		$this->dateFormatter = $date_formatter;
114		$this->formBuilder = $form_builder;
115		$this->logger = $logger;
116		$this->moduleHandler = $module_handler;
117		$this->watchdog = $watchdog;
118
119		// Add terminal "/".
120		$this->rootLength = Unicode::strlen(DRUPAL_ROOT);
121
122		}
123
124		/**
125		* Controller.
126		*
127		* @return array
128		* A render array.
129		*/
130		public function build(Request $request) {
131		$page = $this->setupPager($request);
132
133		$ret = [
134		'filter_form' => $this->formBuilder->getForm('Drupal\mongodb_watchdog\Form\OverviewFilterForm'),
135		'rows' => $this->buildRows($page),
136		'pager' => [
137		'#type' => 'pager',
138		],
139		'#attached' => [
140		'library' => ['mongodb_watchdog/styling'],
141		],
142		];
143
144		return $ret;
145		}
146
147		/**
148		* Build a table from the event rows.
149		*
150		* @param int $page
151		* The number of the page to display.
152		*
153		* @return array
		0 ignored issues – show Documentation introduced 2016-07-02 17:46 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string\|array>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
154		* A render array.
155		*/
156		public function buildRows($page) {
157		$header = [
158		t('#'),
159		t('Latest'),
160		t('Severity'),
161		t('Type'),
162		t('Message'),
163		t('Source'),
164		];
165		$rows = [];
166		$levels = RfcLogLevel::getLevels();
167		$filters = $_SESSION[OverviewFilterForm::SESSION_KEY] ?? NULL;
		1 ignored issue – show introduced 2016-07-02 10:51 UTC by Report Bug Copy Issue Report Expected 1 space after "?"; 0 found Loading history...
168		$skip = $page * $this->itemsPerPage;
169		$limit = $this->itemsPerPage;
170		$cursor = $this->watchdog->templates($filters['type'] ?? [], $filters['severity'] ?? [], $skip, $limit);
		1 ignored issue – show introduced 2016-07-02 10:51 UTC by Report Bug Copy Issue Report Expected 1 space after "?"; 0 found Loading history...
171
172		/** @var \Drupal\mongodb_watchdog\EventTemplate $template */
173		foreach ($cursor as $template) {
174		$row = [];
175		$row[] = $template->count;
176		$row[] = $this->dateFormatter->format($template->changed, 'short');
177		$row[] = [
178		'class' => static::SEVERITY_CLASSES[$template->severity],
179		'data' => $levels[$template->severity],
180		];
181		$row[] = $template->type;
182		$row[] = $this->getEventLink($template);
183		$row[] = [
184		'data' => $this->getEventSource($template, $row),
185		];
186
187		$rows[] = $row;
188		}
189
190		return [
191		'#type' => 'table',
192		'#header' => $header,
193		'#rows' => $rows,
194		];
195		}
196
197		/**
198		* {@inheritdoc}
199		*/
200		public static function create(ContainerInterface $container) {
201		/** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
202		$date_formatter = $container->get('date.formatter');
203
204		/** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */
205		$form_builder = $container->get('form_builder');
206
207		/** @var \Psr\Log\LoggerInterface $logger */
208		$logger = $container->get('logger.channel.mongodb_watchdog');
209
210		/** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
211		$module_handler = $container->get('module_handler');
212
213		/** @var \Drupal\mongodb_watchdog\Logger $logger */
214		$watchdog = $container->get('mongodb.logger');
215
216		/** @var \Drupal\Core\Config\ImmutableConfig $config */
217		$config = $container->get('config.factory')->get('mongodb_watchdog.settings');
218
219		return new static($logger, $watchdog, $module_handler, $form_builder, $date_formatter, $config);
220		}
221
222		/**
223		* Build the link to the event or top report for the event template.
224		*
225		* @param \Drupal\mongodb_watchdog\EventTemplate $template
226		* The event template for which to buildl the link.
227		*
228		* @return string
229		* An internal link in string form.
230		*/
231		protected function getEventLink(EventTemplate $template) {
232		switch ($template->type) {
233		case 'page not found':
		1 ignored issue – show introduced 2016-07-09 20:39 UTC by Report Bug Copy Issue Report Expected 1 space before ":"; 0 found Loading history...
234		$cell = Link::createFromRoute(t('( Top 404 )'), 'mongodb_watchdog.reports.top404');
235		break;
236
237		case 'access denied':
		1 ignored issue – show introduced 2016-07-09 20:39 UTC by Report Bug Copy Issue Report Expected 1 space before ":"; 0 found Loading history...
238		$cell = Link::createFromRoute(t('( Top 403 )'), 'mongodb_watchdog.reports.top403');
239		break;
240
241		default:
		1 ignored issue – show Coding Style introduced 2016-07-09 20:39 UTC by Report Bug Copy Issue Report Blank lines are not allowed after DEFAULT statements Loading history... introduced 2016-07-09 20:39 UTC by Report Bug Copy Issue Report Expected 1 space before ":"; 0 found Loading history...
242		// Limited-length message.
243		$message = Unicode::truncate(strip_tags(SafeMarkup::format($template->message, [])), 56, TRUE, TRUE);
244		$cell = Link::createFromRoute($message, 'mongodb_watchdog.reports.detail', [
245		'event_template' => $template->_id,
246		]);
247		break;
248		}
249
250		return $cell;
251		}
252
253		/**
254		* Get the location in source code where the event was logged.
255		*
256		* @param \Drupal\mongodb_watchdog\EventTemplate $template
257		* The template for which to find a source location.
258		*
259		* @return array
		0 ignored issues – show Documentation introduced 2016-07-02 17:46 UTC by Report Bug Copy Issue Report Should the return type not be `string\|array<string,string\|array>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
260		* A render array for the source location, possibly empty or wrong.
261		*/
262		protected function getEventSource(EventTemplate $template) {
263		if (in_array($template->type, TopController::TYPES)) {
264		return '';
265		}
266
267		$event_collection = $this->watchdog->eventCollection($template->_id);
268		$event = $event_collection->findOne([], static::EVENT_TYPE_MAP);
269		if (!($event instanceof Event)) {
270		return '';
271		}
272
273		$file = $event->variables['%file'] ?? '';
		1 ignored issue – show introduced 2016-07-02 17:46 UTC by Report Bug Copy Issue Report Expected 1 space after "?"; 0 found Loading history...
274		if ($file && strncmp($file, DRUPAL_ROOT, $this->rootLength) === 0) {
275		$hover = Unicode::substr($file, $this->rootLength + 1);
276		$file = Unicode::truncate(basename($file), 30);
277		}
278		else {
279		$hover = NULL;
280		}
281
282		$line = $event->variables['%line'] ?? NULL;
		1 ignored issue – show introduced 2016-07-02 17:46 UTC by Report Bug Copy Issue Report Expected 1 space after "?"; 0 found Loading history...
283		$cell = [
284		'#type' => 'html_tag',
285		'#tag' => 'span',
286		'#value' => "${file}#${line}",
287		];
288
289		if ($hover) {
290		$cell['#attributes'] = [
291		'class' => 'mongodb_watchdog__code_path',
292		'title' => $hover,
293		];
294		}
295
296		return $cell;
297		}
298
299		/**
300		* Set up the templates pager.
301		*
302		* @param \Symfony\Component\HttpFoundation\Request $request
303		* The current request.
304		*
305		* @return int
306		* The number of the page to display, starting at 0.
307		*/
308	View Code Duplication	public function setupPager(Request $request) {
		0 ignored issues – show Duplication introduced 2016-07-06 07:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
309		$count = $this->watchdog->templatesCount();
310		$height = $this->itemsPerPage;
311		pager_default_initialize($count, $height);
312
313		$page = intval($request->query->get('page'));
314		if ($page < 0) {
315		$page = 0;
316		}
317		else {
318		$page_max = intval(min(ceil($count / $height), PHP_INT_MAX) - 1);
319		if ($page > $page_max) {
320		$page = $page_max;
321		}
322		}
323
324		return $page;
325		}
326
327		}
		0 ignored issues – show Coding Style introduced 2016-07-02 08:08 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
328

FGM / mongodb

Pull Request — 8.x-2.x (#24)

OverviewController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like