PregReplaceEModifierSniff::processRegexPattern() - Code Metrics - Inspection of "Merge pull request #636 from wimg/feature/new-abst..." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fc7ee8...1f8b59 )

by Wim

created 2018-06-10 15:44 UTC

PregReplaceEModifierSniff::processRegexPattern() C

↳ Parent: PregReplaceEModifierSniff

Complexity

Conditions	9
Paths	48

Size

Total Lines	49
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	49
rs	5.7446
c	0
b	0
f	0
cc	9
eloc	23
nc	48
nop	4

<?php
/**
 * \PHPCompatibility\Sniffs\PHP\PregReplaceEModifierSniff.
 *
 * PHP version 5.5
 *
 * @category  PHP
 * @package   PHPCompatibility
 * @author    Wim Godden <[email protected]>
 * @copyright 2014 Cu.be Solutions bvba
 */

namespace PHPCompatibility\Sniffs\PHP;

use PHPCompatibility\AbstractFunctionCallParameterSniff;

/**
 * \PHPCompatibility\Sniffs\PHP\PregReplaceEModifierSniff.
 *
 * Check for usage of the `e` modifier with PCRE functions which is deprecated since PHP 5.5
 * and removed as of PHP 7.0.
 *
 * PHP version 5.5
 *
 * @category  PHP
 * @package   PHPCompatibility
 * @author    Wim Godden <[email protected]>
 * @copyright 2014 Cu.be Solutions bvba
 */
class PregReplaceEModifierSniff extends AbstractFunctionCallParameterSniff
{

    /**
     * Functions to check for.
     *
     * @var array
     */
    protected $targetFunctions = array(
        'preg_replace' => true,
        'preg_filter'  => true,
    );

    /**
     * Regex bracket delimiters.
     *
     * @var array
     */
    protected $doublesSeparators = array(
        '{' => '}',
        '[' => ']',
        '(' => ')',
        '<' => '>',
    );


    /**
     * Process the parameters of a matched function.
     *
     * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
     * @param int                   $stackPtr     The position of the current token in the stack.
     * @param string                $functionName The token content (function name) which was matched.
     * @param array                 $parameters   Array with information about the parameters.
     *
     * @return int|void Integer stack pointer to skip forward or void to continue
     *                  normal file processing.
     */
    public function processParameters(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $parameters)
    {
        // Check the first parameter in the function call as that should contain the regex(es).
        if (isset($parameters[1]) === false) {
            return;
        }

        $tokens         = $phpcsFile->getTokens();
        $functionNameLc = strtolower($functionName);
        $firstParam     = $parameters[1];

        // Differentiate between an array of patterns passed and a single pattern.
        $nextNonEmpty = $phpcsFile->findNext(\PHP_CodeSniffer_Tokens::$emptyTokens, $firstParam['start'], ($firstParam['end'] + 1), true);
        if ($nextNonEmpty !== false && ($tokens[$nextNonEmpty]['code'] === T_ARRAY || $tokens[$nextNonEmpty]['code'] === T_OPEN_SHORT_ARRAY)) {
            $arrayValues = $this->getFunctionCallParameters($phpcsFile, $nextNonEmpty);
            if ($functionNameLc === 'preg_replace_callback_array') {
                // For preg_replace_callback_array(), the patterns will be in the array keys.
                foreach ($arrayValues as $value) {
                    $hasKey = $phpcsFile->findNext(T_DOUBLE_ARROW, $value['start'], ($value['end'] + 1));
                    if ($hasKey === false) {
                        continue;
                    }

                    $value['end'] = ($hasKey - 1);
                    $value['raw'] = trim($phpcsFile->getTokensAsString($value['start'], ($hasKey - $value['start'])));
                    $this->processRegexPattern($value, $phpcsFile, $value['end'], $functionName);
                }

            } else {
                // Otherwise, the patterns will be in the array values.
                foreach ($arrayValues as $value) {
                    $hasKey = $phpcsFile->findNext(T_DOUBLE_ARROW, $value['start'], ($value['end'] + 1));
                    if ($hasKey !== false) {
                        $value['start'] = ($hasKey + 1);
                        $value['raw']   = trim($phpcsFile->getTokensAsString($value['start'], (($value['end'] + 1) - $value['start'])));
                    }

                    $this->processRegexPattern($value, $phpcsFile, $value['end'], $functionName);
                }
            }

        } else {
            $this->processRegexPattern($firstParam, $phpcsFile, $stackPtr, $functionName);
        }
    }


    /**
     * Do a version check to determine if this sniff needs to run at all.
     *
     * @return bool
     */
    protected function bowOutEarly()
    {
        return ($this->supportsAbove('5.5') === false);
    }


    /**
     * Analyse a potential regex pattern for usage of the /e modifier.
     *
     * @param array                 $pattern      Array containing the start and end token
     *                                            pointer of the potential regex pattern and
     *                                            the raw string value of the pattern.
     * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
     * @param int                   $stackPtr     The position of the current token in the
     *                                            stack passed in $tokens.
     * @param string                $functionName The function which contained the pattern.
     *
     * @return void
     */
    protected function processRegexPattern($pattern, \PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName)
    {
        $tokens = $phpcsFile->getTokens();

        /*
         * The pattern might be build up of a combination of strings, variables
         * and function calls. We are only concerned with the strings.
         */
        $regex = '';
        for ($i = $pattern['start']; $i <= $pattern['end']; $i++) {
            if (in_array($tokens[$i]['code'], \PHP_CodeSniffer_Tokens::$stringTokens, true) === true) {
                $content = $this->stripQuotes($tokens[$i]['content']);
                if ($tokens[$i]['code'] === T_DOUBLE_QUOTED_STRING) {
                    $content = $this->stripVariables($content);
                }

                $regex .= trim($content);
            }
        }

        // Deal with multi-line regexes which were broken up in several string tokens.
        if ($tokens[$pattern['start']]['line'] !== $tokens[$pattern['end']]['line']) {
            $regex = $this->stripQuotes($regex);
        }

        if ($regex === '') {
            // No string token found in the first parameter, so skip it (e.g. if variable passed in).
            return;
        }

        $regexFirstChar = substr($regex, 0, 1);

        // Make sure that the character identified as the delimiter is valid.
        // Otherwise, it is a false positive caused by the string concatenation.
        if (preg_match('`[a-z0-9\\\\ ]`i', $regexFirstChar) === 1) {
            return;
        }

        if (isset($this->doublesSeparators[$regexFirstChar])) {
            $regexEndPos = strrpos($regex, $this->doublesSeparators[$regexFirstChar]);
        } else {
            $regexEndPos = strrpos($regex, $regexFirstChar);
        }

        if ($regexEndPos !== false) {
            $modifiers = substr($regex, $regexEndPos + 1);
            $this->examineModifiers($phpcsFile, $stackPtr, $functionName, $modifiers);
        }
    }//end processRegexPattern()


    /**
     * Examine the regex modifier string.
     *
     * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
     * @param int                   $stackPtr     The position of the current token in the
     *                                            stack passed in $tokens.
     * @param string                $functionName The function which contained the pattern.
     * @param string                $modifiers    The regex modifiers found.
     *
     * @return void
     */
    protected function examineModifiers(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $modifiers)
    {
        if (strpos($modifiers, 'e') !== false) {
            $error     = '%s() - /e modifier is deprecated since PHP 5.5';
            $isError   = false;
            $errorCode = 'Deprecated';
            $data      = array($functionName);

            if ($this->supportsAbove('7.0')) {
                $error    .= ' and removed since PHP 7.0';
                $isError   = true;
                $errorCode = 'Removed';
            }

            $this->addMessage($phpcsFile, $error, $stackPtr, $isError, $errorCode, $data);
        }
    }

}//end class


1			<?php
2			/**
3			* \PHPCompatibility\Sniffs\PHP\PregReplaceEModifierSniff.
4			*
5			* PHP version 5.5
6			*
7			* @category PHP
8			* @package PHPCompatibility
9			* @author Wim Godden <[email protected]>
10			* @copyright 2014 Cu.be Solutions bvba
11			*/
12
13			namespace PHPCompatibility\Sniffs\PHP;
14
15			use PHPCompatibility\AbstractFunctionCallParameterSniff;
16
17			/**
18			* \PHPCompatibility\Sniffs\PHP\PregReplaceEModifierSniff.
19			*
20			* Check for usage of the `e` modifier with PCRE functions which is deprecated since PHP 5.5
21			* and removed as of PHP 7.0.
22			*
23			* PHP version 5.5
24			*
25			* @category PHP
26			* @package PHPCompatibility
27			* @author Wim Godden <[email protected]>
28			* @copyright 2014 Cu.be Solutions bvba
29			*/
30			class PregReplaceEModifierSniff extends AbstractFunctionCallParameterSniff
31			{
32
33			/**
34			* Functions to check for.
35			*
36			* @var array
37			*/
38			protected $targetFunctions = array(
39			'preg_replace' => true,
40			'preg_filter' => true,
41			);
42
43			/**
44			* Regex bracket delimiters.
45			*
46			* @var array
47			*/
48			protected $doublesSeparators = array(
49			'{' => '}',
50			'[' => ']',
51			'(' => ')',
52			'<' => '>',
53			);
54
55
56			/**
57			* Process the parameters of a matched function.
58			*
59			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
60			* @param int $stackPtr The position of the current token in the stack.
61			* @param string $functionName The token content (function name) which was matched.
62			* @param array $parameters Array with information about the parameters.
63			*
64			* @return int\|void Integer stack pointer to skip forward or void to continue
65			* normal file processing.
66			*/
67			public function processParameters(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $parameters)
68			{
69			// Check the first parameter in the function call as that should contain the regex(es).
70			if (isset($parameters[1]) === false) {
71			return;
72			}
73
74			$tokens = $phpcsFile->getTokens();
75			$functionNameLc = strtolower($functionName);
76			$firstParam = $parameters[1];
77
78			// Differentiate between an array of patterns passed and a single pattern.
79			$nextNonEmpty = $phpcsFile->findNext(\PHP_CodeSniffer_Tokens::$emptyTokens, $firstParam['start'], ($firstParam['end'] + 1), true);
80			if ($nextNonEmpty !== false && ($tokens[$nextNonEmpty]['code'] === T_ARRAY \|\| $tokens[$nextNonEmpty]['code'] === T_OPEN_SHORT_ARRAY)) {
81			$arrayValues = $this->getFunctionCallParameters($phpcsFile, $nextNonEmpty);
82			if ($functionNameLc === 'preg_replace_callback_array') {
83			// For preg_replace_callback_array(), the patterns will be in the array keys.
84			foreach ($arrayValues as $value) {
85			$hasKey = $phpcsFile->findNext(T_DOUBLE_ARROW, $value['start'], ($value['end'] + 1));
86			if ($hasKey === false) {
87			continue;
88			}
89
90			$value['end'] = ($hasKey - 1);
91			$value['raw'] = trim($phpcsFile->getTokensAsString($value['start'], ($hasKey - $value['start'])));
92			$this->processRegexPattern($value, $phpcsFile, $value['end'], $functionName);
93			}
94
95			} else {
96			// Otherwise, the patterns will be in the array values.
97			foreach ($arrayValues as $value) {
98			$hasKey = $phpcsFile->findNext(T_DOUBLE_ARROW, $value['start'], ($value['end'] + 1));
99			if ($hasKey !== false) {
100			$value['start'] = ($hasKey + 1);
101			$value['raw'] = trim($phpcsFile->getTokensAsString($value['start'], (($value['end'] + 1) - $value['start'])));
102			}
103
104			$this->processRegexPattern($value, $phpcsFile, $value['end'], $functionName);
105			}
106			}
107
108			} else {
109			$this->processRegexPattern($firstParam, $phpcsFile, $stackPtr, $functionName);
110			}
111			}
112
113
114			/**
115			* Do a version check to determine if this sniff needs to run at all.
116			*
117			* @return bool
118			*/
119			protected function bowOutEarly()
120			{
121			return ($this->supportsAbove('5.5') === false);
122			}
123
124
125			/**
126			* Analyse a potential regex pattern for usage of the /e modifier.
127			*
128			* @param array $pattern Array containing the start and end token
129			* pointer of the potential regex pattern and
130			* the raw string value of the pattern.
131			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
132			* @param int $stackPtr The position of the current token in the
133			* stack passed in $tokens.
134			* @param string $functionName The function which contained the pattern.
135			*
136			* @return void
137			*/
138			protected function processRegexPattern($pattern, \PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName)
139			{
140			$tokens = $phpcsFile->getTokens();
141
142			/*
143			* The pattern might be build up of a combination of strings, variables
144			* and function calls. We are only concerned with the strings.
145			*/
146			$regex = '';
147			for ($i = $pattern['start']; $i <= $pattern['end']; $i++) {
148			if (in_array($tokens[$i]['code'], \PHP_CodeSniffer_Tokens::$stringTokens, true) === true) {
149			$content = $this->stripQuotes($tokens[$i]['content']);
150			if ($tokens[$i]['code'] === T_DOUBLE_QUOTED_STRING) {
151			$content = $this->stripVariables($content);
152			}
153
154			$regex .= trim($content);
155			}
156			}
157
158			// Deal with multi-line regexes which were broken up in several string tokens.
159			if ($tokens[$pattern['start']]['line'] !== $tokens[$pattern['end']]['line']) {
160			$regex = $this->stripQuotes($regex);
161			}
162
163			if ($regex === '') {
164			// No string token found in the first parameter, so skip it (e.g. if variable passed in).
165			return;
166			}
167
168			$regexFirstChar = substr($regex, 0, 1);
169
170			// Make sure that the character identified as the delimiter is valid.
171			// Otherwise, it is a false positive caused by the string concatenation.
172			if (preg_match('`[a-z0-9\\\\ ]`i', $regexFirstChar) === 1) {
173			return;
174			}
175
176			if (isset($this->doublesSeparators[$regexFirstChar])) {
177			$regexEndPos = strrpos($regex, $this->doublesSeparators[$regexFirstChar]);
178			} else {
179			$regexEndPos = strrpos($regex, $regexFirstChar);
180			}
181
182			if ($regexEndPos !== false) {
183			$modifiers = substr($regex, $regexEndPos + 1);
184			$this->examineModifiers($phpcsFile, $stackPtr, $functionName, $modifiers);
185			}
186			}//end processRegexPattern()
187
188
189			/**
190			* Examine the regex modifier string.
191			*
192			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
193			* @param int $stackPtr The position of the current token in the
194			* stack passed in $tokens.
195			* @param string $functionName The function which contained the pattern.
196			* @param string $modifiers The regex modifiers found.
197			*
198			* @return void
199			*/
200			protected function examineModifiers(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $modifiers)
201			{
202			if (strpos($modifiers, 'e') !== false) {
203			$error = '%s() - /e modifier is deprecated since PHP 5.5';
204			$isError = false;
205			$errorCode = 'Deprecated';
206			$data = array($functionName);
207
208			if ($this->supportsAbove('7.0')) {
209			$error .= ' and removed since PHP 7.0';
210			$isError = true;
211			$errorCode = 'Removed';
212			}
213
214			$this->addMessage($phpcsFile, $error, $stackPtr, $isError, $errorCode, $data);
215			}
216			}
217
218			}//end class
219

wimg / PHPCompatibility

Push — master ( fc7ee8...1f8b59 )

PregReplaceEModifierSniff::processRegexPattern() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like