class ExtensionsDuplicate in Site Audit 8.3

Provides the ExtensionsDuplicate Check.

Plugin annotation


@SiteAuditCheck(
 id = "extensions_duplicate",
 name = @Translation("Duplicates"),
 description = @Translation("Check for duplicate extensions in the site codebase."),
 report = "extensions"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\site_audit\Plugin\SiteAuditCheckBase implements SiteAuditCheckInterface uses StringTranslationTrait
  - class \Drupal\site_audit\Plugin\SiteAuditCheck\ExtensionsDuplicate

Expanded class hierarchy of ExtensionsDuplicate

File

src/Plugin/SiteAuditCheck/ExtensionsDuplicate.php, line 17

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck

View source

class ExtensionsDuplicate extends SiteAuditCheckBase {

  /**
   * {@inheritdoc}.
   */
  public function getResultFail() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('No duplicate extensions were detected.', []);
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    $paths = [];
    foreach ($this->registry->extensions_dupe as $name => $instances) {
      foreach ($instances as $instance) {
        $paths[$name][] = $instance['path'];
      }
    }
    $headers = [
      $this
        ->t('Name'),
      $this
        ->t('Paths'),
    ];
    $rows = [];
    switch (isset($this->options['format']) ? $this->options['format'] : 'html') {
      case 'html':
        foreach ($this->registry->extensions_dupe as $name => $infos) {
          $rows[] = [
            $name,
            implode('<br/>', $paths[$name]),
          ];
        }
        break;
      case 'text':
        foreach ($this->registry->extensions_dupe as $name => $infos) {
          $rows[] = [
            $name,
            implode("\n", $paths[$name]),
          ];
        }
        break;
      case 'json':
        foreach ($this->registry->extensions_dupe as $name => $infos) {
          $rows[] = [
            'module' => $name,
            'paths' => $paths[$name],
          ];
        }
        break;
    }
    return [
      '#theme' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
    ];
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this->score != SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS) {
      return $this
        ->t('Prune your codebase to have only one copy of any given extension.');
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    $extension_list = \Drupal::service('extension.list.module');
    $this->registry->extensions_dupe = [];
    $drupal_root = DRUPAL_ROOT;
    $settings = \Drupal::service('settings');
    $kernel = \Drupal::service('kernel');
    $command = "find {$drupal_root} -xdev -type f -name '*.info.yml' -o -path './" . $settings
      ->get('file_public_path', $kernel
      ->getSitePath() . '/files') . "' -prune";
    exec($command, $result);
    foreach ($result as $path) {
      $path_parts = explode('/', $path);
      $name = substr(array_pop($path_parts), 0, -9);

      // Safe duplicates.
      if (in_array($name, [
        'drupal_system_listing_compatible_test',
        'drupal_system_listing_incompatible_test',
        'aaa_update_test',
      ])) {
        continue;
      }
      if (!isset($this->registry->extensions_dupe[$name])) {
        $this->registry->extensions_dupe[$name] = [];
      }
      $path = substr($path, strlen($drupal_root) + 1);
      $version = '';
      $info = file($drupal_root . '/' . $path);
      foreach ($info as $line) {
        if (strpos($line, 'version') === 0) {
          $version_split = explode(':', $line);
          if (isset($version_split[1])) {
            $version .= trim(str_replace("'", '', $version_split[1]));
            $path = $path . ' (' . $version . ')';
          }
        }
      }
      $this->registry->extensions_dupe[$name][] = [
        'path' => $path,
        'version' => $version,
      ];
    }

    // Review the detected extensions.
    $moduleHandler = \Drupal::service('module_handler');
    foreach ($this->registry->extensions_dupe as $extension => $instances) {

      // No duplicates.
      if (count($instances) == 1) {
        unset($this->registry->extensions_dupe[$extension]);
        continue;
      }
      $paths_in_profile = 0;
      $non_profile_index = 0;
      $test_extensions = 0;
      foreach ($instances as $index => $instance) {

        // Ignore if it is a test extension.
        if (strpos($instance['path'], '/tests/') !== FALSE) {
          $test_extensions++;
          continue;
        }
        if (strpos($instance['path'], 'profiles/') === 0) {
          $paths_in_profile++;
        }
        else {
          $non_profile_index = $index;
        }
      }

      // If every path is within an installation profile
      // or is a test extension, ignore.
      if ($paths_in_profile + $test_extensions == count($instances)) {
        unset($this->registry->extensions_dupe[$extension]);
        continue;
      }

      // Allow versions that are greater than what's in an installation profile
      // if that version is enabled.
      if ($paths_in_profile > 0 && count($instances) - $paths_in_profile == 1 && $moduleHandler
        ->moduleExists($extension) && $extension_list
        ->getExtensionInfo($extension)['version'] == $instances[$non_profile_index]['version'] && $instances[$non_profile_index]['version'] != '') {
        $skip = TRUE;
        foreach ($instances as $index => $info) {
          if ($index != $non_profile_index && $info['version'] != '') {
            if (version_compare($instances[$non_profile_index]['version'], $info['version']) < 1) {
              $skip = FALSE;
              break;
            }
          }
          elseif ($info['version'] == '') {
            $skip = FALSE;
            break;
          }
        }
        if ($skip === TRUE) {
          unset($this->registry->extensions_dupe[$extension]);
        }
      }
    }

    // Determine score.
    if (count($this->registry->extensions_dupe)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExtensionsDuplicate::calculateScore	public	function	. Overrides SiteAuditCheckBase::calculateScore
ExtensionsDuplicate::getAction	public	function	. Overrides SiteAuditCheckBase::getAction
ExtensionsDuplicate::getResultFail	public	function	. Overrides SiteAuditCheckBase::getResultFail
ExtensionsDuplicate::getResultInfo	public	function	. Overrides SiteAuditCheckBase::getResultInfo
ExtensionsDuplicate::getResultPass	public	function	. Overrides SiteAuditCheckBase::getResultPass
ExtensionsDuplicate::getResultWarn	public	function	. Overrides SiteAuditCheckBase::getResultWarn
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SiteAuditCheckBase::$abort	protected	property	Names of checks that should not run as a result of this check.
SiteAuditCheckBase::$options	protected	property	Options passed in for reports and checks.
SiteAuditCheckBase::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckBase::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckBase::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckBase::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckBase::$static	protected	property	Are we in a static context.
SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckBase::checkInvokeCalculateScore	protected	function	Invoke another check's calculateScore() method if it is needed.
SiteAuditCheckBase::getDescription	public	function	Get a more verbose description of what is being checked.
SiteAuditCheckBase::getId	public	function	Get the ID or machine name for the check.
SiteAuditCheckBase::getLabel	public	function	Get the label for the check that describes, high level what is happening.
SiteAuditCheckBase::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckBase::getRegistry	public	function	Get the check registry.
SiteAuditCheckBase::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckBase::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckBase::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckBase::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckBase::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckBase::__construct	public	function	Constructor. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class ExtensionsDuplicate in Site Audit 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation