class DuplicateEntrySniff

class DuplicateEntrySniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_INLINE_HTML,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token in the
     *                                               stack passed in $tokens.
     *
     * @return int
     */
    public function process(File $phpcsFile, $stackPtr) {
        // Only run this sniff once per info file.
        $fileExtension = strtolower(substr($phpcsFile->getFilename(), -4));
        if ($fileExtension !== 'info') {
            return $phpcsFile->numTokens + 1;
        }
        $contents = file_get_contents($phpcsFile->getFilename());
        $duplicates = $this->findDuplicateInfoFileEntries($contents);
        if (empty($duplicates) === false) {
            foreach ($duplicates as $duplicate) {
                $error = 'Duplicate entry for "%s" in info file';
                $phpcsFile->addError($error, $stackPtr, 'DuplicateEntry', [
                    $duplicate,
                ]);
            }
        }
        return $phpcsFile->numTokens + 1;
    }
    
    //end process()
    
    /**
     * Parses a Drupal info file and checks if a key appears more than once.
     *
     * @param string $data The contents of the info file to parse
     *
     * @return array<string> A list of configuration keys that appear more than once.
     */
    protected function findDuplicateInfoFileEntries($data) {
        $info = [];
        $duplicates = [];
        $constants = get_defined_constants();
        if (preg_match_all('
          @^\\s*                           # Start at the beginning of a line, ignoring leading whitespace
          ((?:
            [^=;\\[\\]]|                    # Key names cannot contain equal signs, semi-colons or square brackets,
            \\[[^\\[\\]]*\\]                  # unless they are balanced and not nested
          )+?)
          \\s*=\\s*                         # Key/value pairs are separated by equal signs (ignoring white-space)
          (?:
            ("(?:[^"]|(?<=\\\\)")*")|     # Double-quoted string, which may contain slash-escaped quotes/slashes
            (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
            ([^\\r\\n]*?)                   # Non-quoted string
          )\\s*$                           # Stop at the next end of a line, ignoring trailing whitespace
          @msx', $data, $matches, PREG_SET_ORDER) !== false) {
            foreach ($matches as $match) {
                // Fetch the key and value string.
                $i = 0;
                foreach ([
                    'key',
                    'value1',
                    'value2',
                    'value3',
                ] as $var) {
                    if (isset($match[++$i]) === true) {
                        ${$var} = $match[$i];
                    }
                    else {
                        ${$var} = '';
                    }
                }
                $value = stripslashes(substr($value1, 1, -1)) . stripslashes(substr($value2, 1, -1)) . $value3;
                // Parse array syntax.
                $keys = preg_split('/\\]?\\[/', rtrim($key, ']'));
                $last = array_pop($keys);
                $parent =& $info;
                // Create nested arrays.
                foreach ($keys as $key) {
                    if ($key === '') {
                        $key = count($parent);
                    }
                    if (isset($parent[$key]) === false || is_array($parent[$key]) === false) {
                        $parent[$key] = [];
                    }
                    $parent =& $parent[$key];
                }
                // Handle PHP constants.
                if (isset($constants[$value]) === true) {
                    $value = $constants[$value];
                }
                // Insert actual value.
                if ($last === '') {
                    $last = count($parent);
                }
                if (array_key_exists($last, $parent) === true) {
                    $duplicates[] = $last;
                }
                $parent[$last] = $value;
            }
            
            //end foreach
        }
        
        //end if
        return $duplicates;
    }
    
    //end findDuplicateInfoFileEntries()

}