Size::checkBin() - Code Metrics - Inspection of "Provide a web UI, running longer checks as batches" - OSInet/qa - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 8.x-1.x (#18)

by Frédéric G.

created 2020-08-16 07:23 UTC

Size::checkBin() A

↳ Parent: Size

Complexity

Conditions	3
Paths	3

Size

Total Lines	23
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	15
dl	0
loc	23
rs	9.7666
c	0
b	0
f	0
cc	3
nc	3
nop	1

<?php

namespace Drupal\qa\Plugin\Qa\Control\Cache;

use Drupal\qa\Plugin\Qa\Control\BaseControl;

class Size extends BaseControl {

  const DATA_SIZE_LIMIT = 524288; // Memcache default entry limit: 1024*1024 * 0.5 for safety

  const DATA_SUMMARY_LENGTH = 1024;

  /**
   * @param string $bin_name
   *
   * @return array
   *   - name: the name of the checked bin
   *   - status: 0 for KO, 1 for OK
   *   - result: information in case of failed check.
   */
  function checkBin($bin_name) {

    $ret = ['name' => $bin_name,];
    $ret['status'] = FALSE;
    $arg = ['@name' => $bin_name];

    if (!db_table_exists($bin_name)) {
    if (!/** @scrutinizer ignore-call */ db_table_exists($bin_name)) {
      $ret['result'] = t('Bin @name is missing in the database.', $arg);
      return $ret;
    }

    $sql = "SELECT cid, data, expire, created, serialized FROM {$bin_name} ORDER BY cid";
    $q = db_query($sql);
    $q = /** @scrutinizer ignore-call */ db_query($sql);
    if (!$q) {
      $ret['result'] = t('Failed fetching database data for bin @name.', $arg);
      return $ret;
    }

    [$status, $result] = $this->checkBinContents($q);

    $ret['status'] = $status;
    $ret['result'] = $result;

    return $ret;
  }

  /**
   * Check the contents of an existing and accessible bin.
   *
   * @param $q
   *   The DBTNG query object for the bin contents, already queried.
   *
   * @return array
   *   - 0 : status bool
   *   - 1 : result array
   */
  protected function checkBinContents($q) {
    $status = TRUE;
    $result = [];
    foreach ($q->fetchAll() as $row) {
      // Cache drivers will need to serialize anyway.
      $data = $row->serialized ? $row->data : serialize($row->data);
      $len = strlen($data);
      if ($len == 0 || $len >= static::DATA_SIZE_LIMIT) {
        $status = FALSE;
        $result[] = [
          $row->cid,
          number_format($len, 0, ',', ''),
          check_plain(drupal_substr($data, 0,
          check_plain(/** @scrutinizer ignore-call */ drupal_substr($data, 0,
            static::DATA_SUMMARY_LENGTH)) . '&hellip;',
        ];
      }
    }

    return [$status, $result];
  }

  /**
   * {@inheritdoc]
   */
  public function init() {
    $this->package_name = __NAMESPACE__;
    $this->title = t('Suspicious cache content');
    $this->description = t('Look for empty or extra-long (>= 1 MB) cache content.');
  }

  /**
   * Does the passed schema match the expected cache schema structure ?
   *
   * @param array $schema
   *
   * @return bool
   */
  public static function isSchemaCache(array $schema) {
    $reference_schema_keys = [
      'cid',
      'created',
      'data',
      'expire',
      'serialized',
    ];
    $keys = array_keys($schema['fields']);
    sort($keys);
    $ret = $keys == $reference_schema_keys;

    return $ret;
  }

  public static function getAllBins($rebuild = FALSE) {
    $schema = drupal_get_complete_schema($rebuild);
    $schema = /** @scrutinizer ignore-call */ drupal_get_complete_schema($rebuild);
    $ret = [];
    foreach ($schema as $name => $info) {
      if (static::isSchemaCache($info)) {
        $ret[] = $name;
      }
    }
    sort($ret);

    return $ret;
  }

  function run() {

    $pass = parent::run();
    $bins = self::getAllBins(TRUE);
    foreach ($bins as $bin_name) {
      $pass->record($this->checkBin($bin_name));
      $pass->record(/** @scrutinizer ignore-type */ $this->checkBin($bin_name));
    }
    $pass->life->end();

    if ($pass->status) {

      $pass->result = format_plural(count($bins),
      $pass->result = /** @scrutinizer ignore-call */ format_plural(count($bins),
        '1 bin checked, not containing suspicious values',
        '@count bins checked, none containing suspicious values', []);
    }
    else {
      $info = format_plural(count($bins),
        '1 view checked and containing suspicious values',
        '@count bins checked, @bins containing suspicious values', [
          '@bins' => count($pass->result),
        ]);

      // Prepare for theming
      $result = [];
      // @XXX May be inconsistent with non-BMP strings ?
      uksort($pass->result, 'strcasecmp');
      foreach ($pass->result as $bin_name => $bin_report) {
        foreach ($bin_report as $entry) {
          array_unshift($entry, $bin_name);
          $result[] = $entry;
        }
      }
      $header = [
        t('Bin'),
        t('CID'),
        t('Length'),
        t('Beginning of data'),
      ];

      $build = [
        'info' => [
          '#markup' => $info,
        ],
        'list' => [
          '#markup' => '<p>' . t('Checked: @checked',
              ['@checked' => implode(', ', $bins)]) . "</p>\n",
        ],
        'table' => [
          '#theme' => 'table',
          '#header' => $header,
          '#rows' => $result,
        ],
      ];
      $pass->result = drupal_render($build);
      $pass->result = /** @scrutinizer ignore-call */ drupal_render($build);
    }
    return $pass;
  }

}


OSInet / qa

Pull Request — 8.x-1.x (#18)

Size::checkBin() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like