PregReplaceEModifierSniff::bowOutEarly() - Code Metrics - Inspection of ":sparkles: New PCRENewModifiers sniff" - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/556-detect-new-PCRE-J-... ( 3ca882 )

by Juliette

created 2018-03-01 16:06 UTC

PregReplaceEModifierSniff::bowOutEarly() A

↳ Parent: PregReplaceEModifierSniff

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?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\Sniff;

/**
 * \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 Sniff
{

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

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

    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        return array(T_STRING);
    }//end register()

    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param int                   $stackPtr  The position of the current token in the
     *                                         stack passed in $tokens.
     *
     * @return void
     */
    public function process(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        if ($this->bowOutEarly() === true) {
            return;
        }

        $tokens         = $phpcsFile->getTokens();
        $functionName   = $tokens[$stackPtr]['content'];
        $functionNameLc = strtolower($functionName);

        // Bow out if not one of the functions we're targetting.
        if (isset($this->functions[$functionNameLc]) === false) {
            return;
        }

        // Get the first parameter in the function call as that should contain the regex(es).
        $firstParam = $this->getFunctionCallParameter($phpcsFile, $stackPtr, 1);
        if ($firstParam === false) {
            return;
        }

        // 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 ($functionName === '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);
        }

    }//end process()


    /**
     * 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\Sniff;
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 Sniff
31			{
32
33			/**
34			* Functions to check for.
35			*
36			* @var array
37			*/
38			protected $functions = 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			* Returns an array of tokens this test wants to listen for.
57			*
58			* @return array
59			*/
60			public function register()
61			{
62			return array(T_STRING);
63			}//end register()
64
65			/**
66			* Processes this test, when one of its tokens is encountered.
67			*
68			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
69			* @param int $stackPtr The position of the current token in the
70			* stack passed in $tokens.
71			*
72			* @return void
73			*/
74			public function process(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
75			{
76			if ($this->bowOutEarly() === true) {
77			return;
78			}
79
80			$tokens = $phpcsFile->getTokens();
81			$functionName = $tokens[$stackPtr]['content'];
82			$functionNameLc = strtolower($functionName);
83
84			// Bow out if not one of the functions we're targetting.
85			if (isset($this->functions[$functionNameLc]) === false) {
86			return;
87			}
88
89			// Get the first parameter in the function call as that should contain the regex(es).
90			$firstParam = $this->getFunctionCallParameter($phpcsFile, $stackPtr, 1);
91			if ($firstParam === false) {
92			return;
93			}
94
95			// Differentiate between an array of patterns passed and a single pattern.
96			$nextNonEmpty = $phpcsFile->findNext(\PHP_CodeSniffer_Tokens::$emptyTokens, $firstParam['start'], ($firstParam['end'] + 1), true);
97			if ($nextNonEmpty !== false && ($tokens[$nextNonEmpty]['code'] === T_ARRAY \|\| $tokens[$nextNonEmpty]['code'] === T_OPEN_SHORT_ARRAY)) {
98			$arrayValues = $this->getFunctionCallParameters($phpcsFile, $nextNonEmpty);
99			if ($functionName === 'preg_replace_callback_array') {
100			// For preg_replace_callback_array(), the patterns will be in the array keys.
101			foreach ($arrayValues as $value) {
102			$hasKey = $phpcsFile->findNext(T_DOUBLE_ARROW, $value['start'], ($value['end'] + 1));
103			if ($hasKey === false) {
104			continue;
105			}
106
107			$value['end'] = ($hasKey - 1);
108			$value['raw'] = trim($phpcsFile->getTokensAsString($value['start'], ($hasKey - $value['start'])));
109			$this->processRegexPattern($value, $phpcsFile, $value['end'], $functionName);
110			}
111
112			} else {
113			// Otherwise, the patterns will be in the array values.
114			foreach ($arrayValues as $value) {
115			$hasKey = $phpcsFile->findNext(T_DOUBLE_ARROW, $value['start'], ($value['end'] + 1));
116			if ($hasKey !== false) {
117			$value['start'] = ($hasKey + 1);
118			$value['raw'] = trim($phpcsFile->getTokensAsString($value['start'], (($value['end'] + 1) - $value['start'])));
119			}
120
121			$this->processRegexPattern($value, $phpcsFile, $value['end'], $functionName);
122			}
123			}
124
125			} else {
126			$this->processRegexPattern($firstParam, $phpcsFile, $stackPtr, $functionName);
127			}
128
129			}//end process()
130
131
132			/**
133			* Do a version check to determine if this sniff needs to run at all.
134			*
135			* @return bool
136			*/
137			protected function bowOutEarly()
138			{
139			return ($this->supportsAbove('5.5') === false);
140			}
141
142
143			/**
144			* Analyse a potential regex pattern for usage of the /e modifier.
145			*
146			* @param array $pattern Array containing the start and end token
147			* pointer of the potential regex pattern and
148			* the raw string value of the pattern.
149			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
150			* @param int $stackPtr The position of the current token in the
151			* stack passed in $tokens.
152			* @param string $functionName The function which contained the pattern.
153			*
154			* @return void
155			*/
156			protected function processRegexPattern($pattern, \PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName)
157			{
158			$tokens = $phpcsFile->getTokens();
159
160			/*
161			* The pattern might be build up of a combination of strings, variables
162			* and function calls. We are only concerned with the strings.
163			*/
164			$regex = '';
165			for ($i = $pattern['start']; $i <= $pattern['end']; $i++) {
166			if (in_array($tokens[$i]['code'], \PHP_CodeSniffer_Tokens::$stringTokens, true) === true) {
167			$content = $this->stripQuotes($tokens[$i]['content']);
168			if ($tokens[$i]['code'] === T_DOUBLE_QUOTED_STRING) {
169			$content = $this->stripVariables($content);
170			}
171
172			$regex .= trim($content);
173			}
174			}
175
176			// Deal with multi-line regexes which were broken up in several string tokens.
177			if ($tokens[$pattern['start']]['line'] !== $tokens[$pattern['end']]['line']) {
178			$regex = $this->stripQuotes($regex);
179			}
180
181			if ($regex === '') {
182			// No string token found in the first parameter, so skip it (e.g. if variable passed in).
183			return;
184			}
185
186			$regexFirstChar = substr($regex, 0, 1);
187
188			// Make sure that the character identified as the delimiter is valid.
189			// Otherwise, it is a false positive caused by the string concatenation.
190			if (preg_match('`[a-z0-9\\\\ ]`i', $regexFirstChar) === 1) {
191			return;
192			}
193
194			if (isset($this->doublesSeparators[$regexFirstChar])) {
195			$regexEndPos = strrpos($regex, $this->doublesSeparators[$regexFirstChar]);
196			} else {
197			$regexEndPos = strrpos($regex, $regexFirstChar);
198			}
199
200			if ($regexEndPos !== false) {
201			$modifiers = substr($regex, $regexEndPos + 1);
202			$this->examineModifiers($phpcsFile, $stackPtr, $functionName, $modifiers);
203			}
204			}//end processRegexPattern()
205
206
207			/**
208			* Examine the regex modifier string.
209			*
210			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
211			* @param int $stackPtr The position of the current token in the
212			* stack passed in $tokens.
213			* @param string $functionName The function which contained the pattern.
214			* @param string $modifiers The regex modifiers found.
215			*
216			* @return void
217			*/
218			protected function examineModifiers(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $modifiers)
219			{
220			if (strpos($modifiers, 'e') !== false) {
221			$error = '%s() - /e modifier is deprecated since PHP 5.5';
222			$isError = false;
223			$errorCode = 'Deprecated';
224			$data = array($functionName);
225
226			if ($this->supportsAbove('7.0')) {
227			$error .= ' and removed since PHP 7.0';
228			$isError = true;
229			$errorCode = 'Removed';
230			}
231
232			$this->addMessage($phpcsFile, $error, $stackPtr, $isError, $errorCode, $data);
233			}
234			}
235
236			}//end class
237

wimg / PHPCompatibility

Push — feature/556-detect-new-PCRE-J-... ( 3ca882 )

PregReplaceEModifierSniff::bowOutEarly() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like