Symplify\PHP7_CodeSniffer\Files\File::addMessage()

Complexity

Conditions	38
Paths	> 20000

Size

Total Lines	179
Code Lines	98

Duplication

Lines	26
Ratio	14.53 %

Importance

Changes

0

<?php
    protected function addMessage($error, $message, $line, $column, $code, $data, $severity, $fixable)
    {
        if (isset($this->tokenizer->ignoredLines[$line]) === true) {
            return false;
        }

        $includeAll = true;
        if ($this->configCache['cache'] === false

This code seems to be duplicated across your project.

            || $this->configCache['recordErrors'] === false
        ) {
            $includeAll = false;
        }

        // Work out which sniff generated the message.
        $parts = explode('.', $code);
        if ($parts[0] === 'Internal') {
            // An internal message.
            $listenerCode = Util\Common::getSniffCode($this->activeListener);
            $sniffCode    = $code;
            $checkCodes   = array($sniffCode);
        } else {
            if ($parts[0] !== $code) {
                // The full message code has been passed in.
                $sniffCode    = $code;
                $listenerCode = substr($sniffCode, 0, strrpos($sniffCode, '.'));
            } else {
                $listenerCode = Util\Common::getSniffCode($this->activeListener);
                $sniffCode    = $listenerCode.'.'.$code;
                $parts        = explode('.', $sniffCode);
            }

            $checkCodes = array(
                           $sniffCode,
                           $parts[0].'.'.$parts[1].'.'.$parts[2],
                           $parts[0].'.'.$parts[1],
                           $parts[0],
                          );
        }//end if

        // Filter out any messages for sniffs that shouldn't have run
        // due to the use of the --sniffs command line argument.
        if ($includeAll === false
            && empty($this->configCache['sniffs']) === false
            && in_array($listenerCode, $this->configCache['sniffs']) === false
        ) {
            return false;
        }

        // If we know this sniff code is being ignored for this file, return early.
        foreach ($checkCodes as $checkCode) {
            if (isset($this->ignoredCodes[$checkCode]) === true) {
                return false;
            }
        }

        $oppositeType = 'warning';
        if ($error === false) {
            $oppositeType = 'error';
        }

        foreach ($checkCodes as $checkCode) {

This code seems to be duplicated across your project.

            // Make sure this message type has not been set to the opposite message type.
            if (isset($this->ruleset->ruleset[$checkCode]['type']) === true
                && $this->ruleset->ruleset[$checkCode]['type'] === $oppositeType
            ) {
                $error = !$error;
                break;
            }
        }

        if ($error === true) {
            $configSeverity = $this->configCache['errorSeverity'];
            $messageCount   = &$this->errorCount;
            $messages       = &$this->errors;
        } else {
            $configSeverity = $this->configCache['warningSeverity'];
            $messageCount   = &$this->warningCount;
            $messages       = &$this->warnings;
        }

        if ($includeAll === false && $configSeverity === 0) {
            // Don't bother doing any processing as these messages are just going to
            // be hidden in the reports anyway.
            return false;
        }

        if ($severity === 0) {
            $severity = 5;
        }

        foreach ($checkCodes as $checkCode) {

This code seems to be duplicated across your project.

            // Make sure we are interested in this severity level.
            if (isset($this->ruleset->ruleset[$checkCode]['severity']) === true) {
                $severity = $this->ruleset->ruleset[$checkCode]['severity'];
                break;
            }
        }

        if ($includeAll === false && $configSeverity > $severity) {
            return false;
        }

        // Make sure we are not ignoring this file.
        foreach ($checkCodes as $checkCode) {
            if (isset($this->configCache['ignorePatterns'][$checkCode]) === false) {
                continue;
            }

            foreach ($this->configCache['ignorePatterns'][$checkCode] as $pattern => $type) {
                // While there is support for a type of each pattern
                // (absolute or relative) we don't actually support it here.
                $replacements = array(
                                 '\\,' => ',',
                                 '*'   => '.*',
                                );

                // We assume a / directory separator, as do the exclude rules
                // most developers write, so we need a special case for any system
                // that is different.
                if (DIRECTORY_SEPARATOR === '\\') {
                    $replacements['/'] = '\\\\';
                }

                $pattern = '`'.strtr($pattern, $replacements).'`i';
                if (preg_match($pattern, $this->path) === 1) {
                    $this->ignoredCodes[$checkCode] = true;
                    return false;
                }
            }//end foreach
        }//end foreach

        $messageCount++;
        if ($fixable === true) {
            $this->fixableCount++;
        }

        if ($this->configCache['recordErrors'] === false

This code seems to be duplicated across your project.

            && $includeAll === false
        ) {
            return true;
        }

        // Work out the error message.
        if (isset($this->ruleset->ruleset[$sniffCode]['message']) === true) {
            $message = $this->ruleset->ruleset[$sniffCode]['message'];
        }

        if (empty($data) === false) {
            $message = vsprintf($message, $data);
        }

        if (isset($messages[$line]) === false) {
            $messages[$line] = array();
        }

        if (isset($messages[$line][$column]) === false) {
            $messages[$line][$column] = array();
        }

        $messages[$line][$column][] = array(
                                       'message'  => $message,
                                       'source'   => $sniffCode,
                                       'listener' => $this->activeListener,
                                       'severity' => $severity,
                                       'fixable'  => $fixable,
                                      );

        if (PHP_CodeSniffer_VERBOSITY > 1
            && $this->fixer->enabled === true
            && $fixable === true
        ) {
            @ob_end_clean();

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

            echo "\tE: [Line $line] $message ($sniffCode)".PHP_EOL;
            ob_start();
        }

        return true;

    }//end addMessage()