RequestController::setupPager() - Code Metrics - Inspection of "Legacy cleanup." - FGM/mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2761013-watchdog_pager ( d635f7...2f2a35 )

by Frédéric G.

created 2016-07-08 16:56 UTC

RequestController::setupPager() A

↳ Parent: RequestController

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	12

Duplication

Lines	18
Ratio	100 %

Importance

Changes

Metric	Value
cc	3
eloc	12
c	0
b	0
f	0
nc	3
nop	2
dl	18
loc	18
rs	9.4285

<?php

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Component\Utility\Unicode;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Link;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\mongodb_watchdog\Logger;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Implements the controller for the request events page.
 */
class RequestController implements ContainerInjectionInterface {

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

  /**
   * The items_per_page configuration value.
   *
   * @var int
   */
  protected $itemsPerPage;

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

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

  /**
   * RequestController constructor.
   *
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The MongoDB logger service, to load event data.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The core date.formatter service.
   * @param int $items_per_page
   *   The items_per_page configuration value.
   */
  public function __construct(Logger $watchdog, DateFormatterInterface $date_formatter, $items_per_page) {
    $this->dateFormatter = $date_formatter;
    $this->itemsPerPage = $items_per_page;
    $this->watchdog = $watchdog;

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

  /**
   * Build the top part of the page, about the request.
   *
   * @param string $unique_id
   *   The unique request id.
   * @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
   *   A fully loaded array of events and their templates.
   *
   * @return array

   *   A render array for a table.
   */
  public function buildTrackRequest($unique_id, array $events) {
    if ($events) {

      $row = array_slice($events, 0, 1);
      /** @var \Drupal\mongodb_watchdog\Event $first */
      list($template, $first) = reset($row);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

      $location = $first->location;
      $timestamp = isset($first->timestamp)
        ? $this->dateFormatter->format($first->timestamp, 'long')
        : t('No information');
    }
    else {
      $location = $timestamp = t('No information');
    }

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

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

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

  /**
   * Build the bottom part of the page, about the events during the request.
   *
   * @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
   *   A fully loaded array of events and their templates.
   *
   * @return array

   *   A render array for a table.
   */
  public function buildTrackRows(array $events) {
    $header = [
      t('Sequence'),
      t('Type'),
      t('Severity'),
      t('Event'),
      t('File'),
      t('Line'),
    ];
    $rows = [];
    $levels = RfcLogLevel::getLevels();

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

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

        $template->type,

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

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

        ],
        [
          'data' => Link::createFromRoute($template->asString($event->variables), 'mongodb_watchdog.reports.detail', [

            'event_template' => $template->_id,

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

        $event->variables['%line'],

      ];
      $rows[] = $row;
    }

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

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

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

    /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
    $config_factory = $container->get('config.factory');
    $items_per_page = $config_factory->get('mongodb_watchdog.settings')->get('items_per_page');
    return new static($watchdog, $date_formatter, $items_per_page);
  }

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

    $count = $this->watchdog->requestEventsCount($uniqueId);
    $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;
  }

  /**
   * 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 = (Unicode::strpos($path, DRUPAL_ROOT) === 0)
      ? Unicode::substr($path, $this->rootLength)
      : $path;
    return $ret;
  }

  /**
   * Controller.
   *
   * @param string $uniqueId
   *   The unique request id from mod_unique_id. Unsafe.
   *
   * @return array

   *   A render array.
   */
  public function track(Request $request, $uniqueId) {
    if (!preg_match('/[\w-]+/', $uniqueId)) {
      return ['#markup' => ''];
    }

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

    $events = $this->watchdog->requestEvents($uniqueId, $skip, $height);
    $ret = [
      '#attached' => [
        'library' => ['mongodb_watchdog/styling'],
      ],
      'request' => $this->buildTrackRequest($uniqueId, $events),
      'events' => $this->buildTrackRows($events),
      'pager' => [
        '#type' => 'pager',
      ],
    ];
    return $ret;
  }

}



1		<?php
2
3		namespace Drupal\mongodb_watchdog\Controller;
4
5		use Drupal\Component\Utility\Unicode;
6		use Drupal\Core\Datetime\DateFormatterInterface;
7		use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
8		use Drupal\Core\Link;
9		use Drupal\Core\Logger\RfcLogLevel;
10		use Drupal\mongodb_watchdog\Logger;
11		use Symfony\Component\DependencyInjection\ContainerInterface;
12		use Symfony\Component\HttpFoundation\Request;
13
14		/**
15		* Implements the controller for the request events page.
16		*/
17		class RequestController implements ContainerInjectionInterface {
18
19		/**
20		* The core date.formatter service.
21		*
22		* @var \Drupal\Core\Datetime\DateFormatterInterface
23		*/
24		protected $dateFormatter;
25
26		/**
27		* The items_per_page configuration value.
28		*
29		* @var int
30		*/
31		protected $itemsPerPage;
32
33		/**
34		* The length of the absolute path to the site root, in runes.
35		*
36		* @var int
37		*/
38		protected $rootLength;
39
40		/**
41		* The mongodb_watchdog logger, to access events.
42		*
43		* @var \Drupal\mongodb_watchdog\Logger
44		*/
45		protected $watchdog;
46
47		/**
48		* RequestController constructor.
49		*
50		* @param \Drupal\mongodb_watchdog\Logger $watchdog
51		* The MongoDB logger service, to load event data.
52		* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
53		* The core date.formatter service.
54		* @param int $items_per_page
55		* The items_per_page configuration value.
56		*/
57		public function __construct(Logger $watchdog, DateFormatterInterface $date_formatter, $items_per_page) {
58		$this->dateFormatter = $date_formatter;
59		$this->itemsPerPage = $items_per_page;
60		$this->watchdog = $watchdog;
61
62		// Add terminal "/".
63		$this->rootLength = Unicode::strlen(DRUPAL_ROOT) + 1;
64		}
65
66		/**
67		* Build the top part of the page, about the request.
68		*
69		* @param string $unique_id
70		* The unique request id.
71		* @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
72		* A fully loaded array of events and their templates.
73		*
74		* @return array
		0 ignored issues – show Documentation introduced 2016-07-03 09:19 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...
75		* A render array for a table.
76		*/
77		public function buildTrackRequest($unique_id, array $events) {
78		if ($events) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report The expression `$events` of type `Drupal\mongodb_watchdog\...godb_watchdog\Event[][]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
79		$row = array_slice($events, 0, 1);
80		/** @var \Drupal\mongodb_watchdog\Event $first */
81		list($template, $first) = reset($row);
		0 ignored issues – show Unused Code introduced 2016-07-08 09:36 UTC by Report Bug Copy Issue Report The assignment to `$template` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history... introduced 2016-07-08 09:36 UTC by Report Bug Copy Issue Report Unused variable $template. Loading history...
82
83		$location = $first->location;
84		$timestamp = isset($first->timestamp)
85		? $this->dateFormatter->format($first->timestamp, 'long')
86		: t('No information');
87		}
88		else {
89		$location = $timestamp = t('No information');
90		}
91
92		$rows = [
93		[t('Request ID'), $unique_id],
94		[t('Location'), $location],
95		[t('Date/time'), $timestamp],
96		];
97
98		foreach ($rows as &$row) {
99		$row[0] = [
100		'data' => $row[0],
101		'header' => TRUE,
102		];
103		}
104
105		$ret = [
106		'#type' => 'table',
107		'#rows' => $rows,
108		];
109		return $ret;
110		}
111
112		/**
113		* Build the bottom part of the page, about the events during the request.
114		*
115		* @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
116		* A fully loaded array of events and their templates.
117		*
118		* @return array
		0 ignored issues – show Documentation introduced 2016-07-03 09:19 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...
119		* A render array for a table.
120		*/
121		public function buildTrackRows(array $events) {
122		$header = [
123		t('Sequence'),
124		t('Type'),
125		t('Severity'),
126		t('Event'),
127		t('File'),
128		t('Line'),
129		];
130		$rows = [];
131		$levels = RfcLogLevel::getLevels();
132
133		/** @var \Drupal\mongodb_watchdog\EventTemplate $template */
134		/** @var \Drupal\mongodb_watchdog\Event $event */
135		foreach ($events as list($template, $event)) {
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history... introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
136		$row = [
137		['data' => $event->requestTracking_sequence],
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
138		$template->type,
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
139		[
140		'data' => $levels[$template->severity],
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
141		'class' => OverviewController::SEVERITY_CLASSES[$template->severity],
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
142		],
143		[
144		'data' => Link::createFromRoute($template->asString($event->variables), 'mongodb_watchdog.reports.detail', [
		0 ignored issues – show introduced 2016-07-03 09:19 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history... introduced 2016-07-03 09:19 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
145		'event_template' => $template->_id,
		0 ignored issues – show introduced 2016-07-03 09:19 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
146		]),
147		],
148		$this->simplifyPath($event->variables['%file']),
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
149		$event->variables['%line'],
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
150		];
151		$rows[] = $row;
152		}
153
154		$ret = [
155		'#type' => 'table',
156		'#rows' => $rows,
157		'#header' => $header,
158		];
159		return $ret;
160		}
161
162		/**
163		* {@inheritdoc}
164		*/
165	View Code Duplication	public static function create(ContainerInterface $container) {
		0 ignored issues – show Duplication introduced 2016-07-08 09:36 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...
166		/** @var \Drupal\mongodb_watchdog\Logger $watchdog */
167		$watchdog = $container->get('mongodb.logger');
168
169		/** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
170		$date_formatter = $container->get('date.formatter');
171
172		/** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
173		$config_factory = $container->get('config.factory');
174		$items_per_page = $config_factory->get('mongodb_watchdog.settings')->get('items_per_page');
175		return new static($watchdog, $date_formatter, $items_per_page);
176		}
177
178		/**
179		* Set up the templates pager.
180		*
181		* @param \Symfony\Component\HttpFoundation\Request $request
182		* The current request.
183		* @param int $uniqueId
184		* The uniqueId of the current request.
185		*
186		* @return int
187		* The number of the page to display, starting at 0.
188		*/
189	View Code Duplication	public function setupPager(Request $request, $uniqueId) {
		0 ignored issues – show Duplication introduced 2016-07-08 09:36 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...
190		$count = $this->watchdog->requestEventsCount($uniqueId);
191		$height = $this->itemsPerPage;
192		pager_default_initialize($count, $height);
193
194		$page = intval($request->query->get('page'));
195		if ($page < 0) {
196		$page = 0;
197		}
198		else {
199		$page_max = intval(min(ceil($count / $height), PHP_INT_MAX) - 1);
200		if ($page > $page_max) {
201		$page = $page_max;
202		}
203		}
204
205		return $page;
206		}
207
208		/**
209		* Convert an absolute path to a relative one if below the site root.
210		*
211		* @param string $path
212		* An absolute path on the filesystem.
213		*
214		* @return string
215		* A relative path if possible, otherwise the input path.
216		*/
217		public function simplifyPath($path) {
218		$ret = (Unicode::strpos($path, DRUPAL_ROOT) === 0)
219		? Unicode::substr($path, $this->rootLength)
220		: $path;
221		return $ret;
222		}
223
224		/**
225		* Controller.
226		*
227		* @param string $uniqueId
228		* The unique request id from mod_unique_id. Unsafe.
229		*
230		* @return array
		0 ignored issues – show Documentation introduced 2016-07-08 09:36 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...
231		* A render array.
232		*/
233		public function track(Request $request, $uniqueId) {
234		if (!preg_match('/[\w-]+/', $uniqueId)) {
235		return ['#markup' => ''];
236		}
237
238		$page = $this->setupPager($request, $uniqueId);
239		$skip = $page * $this->itemsPerPage;
240		$height = $this->itemsPerPage;
241
242		$events = $this->watchdog->requestEvents($uniqueId, $skip, $height);
243		$ret = [
244		'#attached' => [
245		'library' => ['mongodb_watchdog/styling'],
246		],
247		'request' => $this->buildTrackRequest($uniqueId, $events),
248		'events' => $this->buildTrackRows($events),
249		'pager' => [
250		'#type' => 'pager',
251		],
252		];
253		return $ret;
254		}
255
256		}
		0 ignored issues – show Coding Style introduced 2016-06-29 08:39 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...
257

FGM / mongodb

Push — 2761013-watchdog_pager ( d635f7...2f2a35 )

RequestController::setupPager() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like