class SiteAuditCheckCodebasePhpCopyPasteDetection in Site Audit 8.2

Class SiteAuditCheckCodebasePhpCopyPasteDetection.

Hierarchy

class \SiteAuditCheckAbstract
- class \SiteAuditCheckCodebasePhpCopyPasteDetection

Expanded class hierarchy of SiteAuditCheckCodebasePhpCopyPasteDetection

File

Check/Codebase/PhpCopyPasteDetection.php, line 12: Contains \SiteAudit\Check\Codebase\PhpMessDetection.

View source

class SiteAuditCheckCodebasePhpCopyPasteDetection extends SiteAuditCheckAbstract {

  /**
   * Implements \SiteAudit\Check\Abstract\getLabel().
   */
  public function getLabel() {
    return dt('PHP Copy/Paste Detector');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Check for lazily duplicated custom code.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultFail().
   */
  public function getResultFail() {
    return dt('Cannot check for copy/pasted code; an invalid custom code path was specified!');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultInfo().
   */
  public function getResultInfo() {
    if (isset($this->registry['phpcpd_path_error'])) {
      return dt('Missing phpcpd.');
    }
    return dt('Cannot check for copy/pasted code; no custom code path specified.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultPass().
   */
  public function getResultPass() {
    return dt('No duplicate code found by PHP Copy/Paste Detector');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultWarn().
   */
  public function getResultWarn() {
    $ret_val = '';
    if (drush_get_option('html') == TRUE) {
      $ret_val .= '<table class="table table-condensed">';
      $ret_val .= '<thead><tr><th>' . dt('File: Lines') . '</th></thead>';
      foreach ($this->registry['phpcpd_out'] as $duplication) {
        $lines = (int) $duplication['lines'];
        $ret_val .= '<tr><td>';
        foreach ($duplication->file as $file) {
          $path = $this
            ->getRelativePath($file['path']);
          $line_start = (int) $file['line'];
          $line_end = $line_start + $lines;
          $ret_val .= "{$path}: {$line_start}-{$line_end}<br>";
        }
        $ret_val .= '</tr></td>';
      }
      $ret_val .= '</table>';
    }
    else {
      $ret_val .= 'Duplications: ' . count($this->registry['phpcpd_out']);
      foreach ($this->registry['phpcpd_out'] as $duplication) {
        $rows = 0;
        $lines = (int) $duplication['lines'];
        foreach ($duplication->file as $file) {
          $ret_val .= PHP_EOL;
          if ($rows++ == 0) {
            $ret_val .= str_repeat(' ', 6) . '- ';
          }
          else {
            if (!drush_get_option('json')) {
              $ret_val .= str_repeat(' ', 8);
            }
          }
          $path = $this
            ->getRelativePath((string) $file['path']);
          $line_start = (int) $file['line'];
          $line_end = $line_start + $lines;
          $ret_val .= "{$path}: {$line_start}-{$line_end}";
        }
      }
    }
    return $ret_val;
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getAction().
   */
  public function getAction() {
    if (isset($this->registry['phpcpd_path_error'])) {
      return dt('Run "composer install" from the site_audit installation root to install missing dependencies.');
    }
    if (isset($this->registry['custom_code'])) {
      return dt('Use the --custom-code option.');
    }
  }

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {

    // Get the path of phpcpd.
    $phpcpd_path = $this
      ->getExecPath('phpcpd');
    if ($phpcpd_path === '') {
      $this->registry['phpcpd_path'] = TRUE;
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
    }

    // Get the custom code paths.
    // Get the custom code paths.
    $custom_code = $this
      ->getCustomCodePaths();
    if ($custom_code === FALSE) {
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL;
    }
    if (empty($custom_code)) {
      $this->registry['custom_code'] = TRUE;
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
    }

    // Get options.
    $valid_options = array(
      'names' => '*.php,*.module,*.install,*.test,*.inc,*.profile,*.theme',
      'names-exclude' => '*.features.*,*_default.inc,*.ds.inc,*.strongarm.inc,*.panelizer.inc,*_defaults.inc,*.box.inc,*.context.inc,*displays.inc',
    );
    $options = $this
      ->getOptions($valid_options, 'phpcpd-');
    $temp_file = tempnam(sys_get_temp_dir(), 'site_audit');
    $option_string = " --log-pmd={$temp_file}";
    foreach ($options as $option => $value) {
      $option_string .= " --{$option}";
      if ($value !== TRUE) {
        $option_string .= "={$value}";
      }
    }

    // Suppress XML errors which will be handled by try catch instead.
    libxml_use_internal_errors(TRUE);
    foreach ($custom_code as $path) {
      $command = $phpcpd_path . ' ' . $path . $option_string;
      $process = new Process($command);
      $process
        ->run();
      try {
        $output = simplexml_load_file($temp_file);
        foreach ($output as $duplication) {
          $this->registry['phpcpd_out'][] = $duplication;
        }
      } catch (Exception $e) {
        $this
          ->logXmlError($path, 'phpcpd');
        continue;
      }
    }
    if (empty($this->registry['phpcpd_out'])) {
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS;
    }
    return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN;
  }

}

Members

Name	Modifiers	Type	Description
SiteAuditCheckAbstract::$abort	protected	property	Indicate that no other checks should be run after this check.
SiteAuditCheckAbstract::$customCode	private static	property	Use for checking whether custom code paths have been validated.
SiteAuditCheckAbstract::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckAbstract::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckAbstract::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckAbstract::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckAbstract::getCustomCodePaths	public	function	Returns an array containing custom code paths or AUDIT_CHECK_SCORE_INFO.
SiteAuditCheckAbstract::getExecPath	public	function	Returns the path of the executable.
SiteAuditCheckAbstract::getOptions	public	function	Returns the values of the valid options for a command.
SiteAuditCheckAbstract::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckAbstract::getRegistry	public	function	Get the check registry.
SiteAuditCheckAbstract::getRelativePath	public	function	Gives path relative to DRUPAL_ROOT of the path is inside Drupal.
SiteAuditCheckAbstract::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckAbstract::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckAbstract::getScoreCssClass	public	function	Get the CSS class associated with a score.
SiteAuditCheckAbstract::getScoreDrushLevel	public	function	Get the Drush message level associated with a score.
SiteAuditCheckAbstract::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckAbstract::logXmlError	public	function	Logs error if unable to parse XML output.
SiteAuditCheckAbstract::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckAbstract::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckAbstract::__construct	public	function	Constructor.
SiteAuditCheckCodebasePhpCopyPasteDetection::calculateScore	public	function	Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckCodebasePhpCopyPasteDetection::getAction	public	function	Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckCodebasePhpCopyPasteDetection::getDescription	public	function	Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckCodebasePhpCopyPasteDetection::getLabel	public	function	Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckCodebasePhpCopyPasteDetection::getResultFail	public	function	Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckCodebasePhpCopyPasteDetection::getResultInfo	public	function	Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckCodebasePhpCopyPasteDetection::getResultPass	public	function	Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckCodebasePhpCopyPasteDetection::getResultWarn	public	function	Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn

You are here

class SiteAuditCheckCodebasePhpCopyPasteDetection in Site Audit 8.2

Hierarchy

File

Members

API Navigation