Skip to content

Commit 9880d2d

Browse files
jrfnljrfnl
committed
4.0 | Remove all CS/JS-specific code from sniffs
PHP_CodeSniffer 4.0 no longer support scanning of JS/CSS code. These sniffs all sniff both PHP files, as well as CSS and/or JS files. This commit removes any JS/CSS specific tests and removes the JS/CSS specific code from the sniffs. Follow up on 839 Closes 442
1 parent 4539af1 commit 9880d2d

File tree

9 files changed

+65
-481
lines changed

9 files changed

+65
-481
lines changed

‎WordPressVIPMinimum/Sniffs/Security/MustacheSniff.php‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,17 @@
1313
use WordPressVIPMinimum\Sniffs\Sniff;
1414

1515
/**
16-
* Looks for instances of unescaped output for Mustache templating engine and Handlebars.js.
16+
* Looks for instances of unescaped output for Mustache templating engine and Handlebars.js within PHP code.
1717
*/
1818
class MustacheSniff extends Sniff {
1919

20-
/**
21-
* A list of tokenizers this sniff supports.
22-
*
23-
* @var string[]
24-
*/
25-
public $supportedTokenizers = [ 'JS', 'PHP' ];
26-
2720
/**
2821
* Returns an array of tokens this test wants to listen for.
2922
*
3023
* @return array<int|string>
3124
*/
3225
public function register() {
33-
$targets = Tokens::$textStringTokens;
34-
$targets[ T_STRING ] = T_STRING;
35-
36-
return $targets;
26+
return Tokens::$textStringTokens;
3727
}
3828

3929
/**

‎WordPressVIPMinimum/Sniffs/Security/UnderscorejsSniff.php‎

Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@
1010
namespace WordPressVIPMinimum\Sniffs\Security;
1111

1212
use PHP_CodeSniffer\Util\Tokens;
13-
use PHPCSUtils\Utils\FilePath;
1413
use PHPCSUtils\Utils\TextStrings;
1514
use WordPressVIPMinimum\Sniffs\Sniff;
1615

1716
/**
18-
* Looks for instances of unescaped output for Underscore.js templating engine.
17+
* Looks for instances of unescaped output for Underscore.js templating engine within PHP code.
1918
*/
2019
class UnderscorejsSniff extends Sniff {
2120

@@ -42,24 +41,13 @@ class UnderscorejsSniff extends Sniff {
4241
*/
4342
const INTERPOLATE_KEYWORD_REGEX = '`(?:templateSettings\.interpolate|\.interpolate\s*=\s*/|interpolate\s*:\s*/)`';
4443

45-
/**
46-
* A list of tokenizers this sniff supports.
47-
*
48-
* @var string[]
49-
*/
50-
public $supportedTokenizers = [ 'JS', 'PHP' ];
51-
5244
/**
5345
* Returns an array of tokens this test wants to listen for.
5446
*
5547
* @return array<int|string>
5648
*/
5749
public function register() {
58-
$targets = Tokens::$textStringTokens;
59-
$targets[] = T_PROPERTY;
60-
$targets[] = T_STRING;
61-
62-
return $targets;
50+
return Tokens::$textStringTokens;
6351
}
6452

6553
/**
@@ -70,57 +58,6 @@ public function register() {
7058
* @return void
7159
*/
7260
public function process_token( $stackPtr ) {
73-
/*
74-
* Ignore Gruntfile.js files as they are configuration, not code.
75-
*/
76-
$file_name = FilePath::getName( $this->phpcsFile );
77-
$file_name = strtolower( basename( $file_name ) );
78-
79-
if ( $file_name === 'gruntfile.js' ) {
80-
return;
81-
}
82-
83-
/*
84-
* Check for delimiter change in JS files.
85-
*/
86-
if ( $this->tokens[ $stackPtr ]['code'] === T_STRING
87-
|| $this->tokens[ $stackPtr ]['code'] === T_PROPERTY
88-
) {
89-
if ( $this->phpcsFile->tokenizerType !== 'JS' ) {
90-
// These tokens are only relevant for JS files.
91-
return;
92-
}
93-
94-
if ( $this->tokens[ $stackPtr ]['content'] !== 'interpolate' ) {
95-
return;
96-
}
97-
98-
// Check the context to prevent false positives.
99-
if ( $this->tokens[ $stackPtr ]['code'] === T_STRING ) {
100-
$prev = $this->phpcsFile->findPrevious( Tokens::$emptyTokens, ( $stackPtr - 1 ), null, true );
101-
if ( $prev === false || $this->tokens[ $prev ]['code'] !== T_OBJECT_OPERATOR ) {
102-
return;
103-
}
104-
105-
$prevPrev = $this->phpcsFile->findPrevious( Tokens::$emptyTokens, ( $stackPtr - 1 ), null, true );
106-
$next = $this->phpcsFile->findNext( Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true );
107-
if ( ( $prevPrev === false
108-
|| $this->tokens[ $prevPrev ]['code'] !== T_STRING
109-
|| $this->tokens[ $prevPrev ]['content'] !== 'templateSettings' )
110-
&& ( $next === false
111-
|| $this->tokens[ $next ]['code'] !== T_EQUAL )
112-
) {
113-
return;
114-
}
115-
}
116-
117-
// Underscore.js delimiter change.
118-
$message = 'Found Underscore.js delimiter change notation.';
119-
$this->phpcsFile->addWarning( $message, $stackPtr, 'InterpolateFound' );
120-
121-
return;
122-
}
123-
12461
$content = TextStrings::stripQuotes( $this->tokens[ $stackPtr ]['content'] );
12562

12663
$match_count = preg_match_all( self::UNESCAPED_INTERPOLATE_REGEX, $content, $matches );
@@ -151,9 +88,7 @@ public function process_token( $stackPtr ) {
15188
}
15289
}
15390

154-
if ( $this->phpcsFile->tokenizerType !== 'JS'
155-
&& preg_match( self::INTERPOLATE_KEYWORD_REGEX, $content ) > 0
156-
) {
91+
if ( preg_match( self::INTERPOLATE_KEYWORD_REGEX, $content ) > 0 ) {
15792
// Underscore.js delimiter change.
15893
$message = 'Found Underscore.js delimiter change notation.';
15994
$this->phpcsFile->addWarning( $message, $stackPtr, 'InterpolateFound' );

‎WordPressVIPMinimum/Sniffs/Security/VuejsSniff.php‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,10 @@
1111
use WordPressVIPMinimum\Sniffs\Sniff;
1212

1313
/**
14-
* Looks for instances of unescaped output for Twig templating engine.
14+
* Looks for instances of unescaped output for Twig templating engine within PHP code.
1515
*/
1616
class VuejsSniff extends Sniff {
1717

18-
/**
19-
* A list of tokenizers this sniff supports.
20-
*
21-
* @var string[]
22-
*/
23-
public $supportedTokenizers = [ 'JS', 'PHP' ];
24-
2518
/**
2619
* Returns an array of tokens this test wants to listen for.
2720
*

‎WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php‎

Lines changed: 2 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
namespace WordPressVIPMinimum\Sniffs\UserExperience;
1212

1313
use PHP_CodeSniffer\Util\Tokens;
14-
use PHPCSUtils\Utils\FilePath;
1514
use PHPCSUtils\Utils\GetTokensAsString;
1615
use PHPCSUtils\Utils\PassedParameters;
1716
use PHPCSUtils\Utils\TextStrings;
@@ -24,16 +23,6 @@
2423
*/
2524
class AdminBarRemovalSniff extends AbstractFunctionParameterSniff {
2625

27-
/**
28-
* A list of tokenizers this sniff supports.
29-
*
30-
* @var array<string>
31-
*/
32-
public $supportedTokenizers = [
33-
'PHP',
34-
'CSS',
35-
];
36-
3726
/**
3827
* Whether or not the sniff only checks for removal of the admin bar
3928
* or any manipulation to the visibility of the admin bar.
@@ -128,9 +117,6 @@ public function register() {
128117

129118
$targets = $this->string_tokens;
130119

131-
// Add CSS style target.
132-
$targets[] = \T_STYLE;
133-
134120
// Set the target selectors regex only once.
135121
$selectors = array_map(
136122
'preg_quote',
@@ -159,15 +145,9 @@ public function register() {
159145
*/
160146
public function process_token( $stackPtr ) {
161147

162-
$file_name = FilePath::getName( $this->phpcsFile );
163-
$file_extension = pathinfo( $file_name, \PATHINFO_EXTENSION );
148+
$file_name = $this->phpcsFile->getFilename();
164149

165-
if ( $file_extension === 'css' ) {
166-
if ( $this->tokens[ $stackPtr ]['code'] === \T_STYLE ) {
167-
$this->process_css_style( $stackPtr );
168-
return;
169-
}
170-
} elseif ( isset( $this->string_tokens[ $this->tokens[ $stackPtr ]['code'] ] ) ) {
150+
if ( isset( $this->string_tokens[ $this->tokens[ $stackPtr ]['code'] ] ) ) {
171151
/*
172152
* Set $in_style && $in_target_selector to false if it is the first time
173153
* this sniff is run on a file.
@@ -340,57 +320,6 @@ public function process_text_for_style( $stackPtr, $file_name ) {
340320
}
341321
}
342322

343-
/**
344-
* Processes this test for T_STYLE tokens in CSS files.
345-
*
346-
* @param int $stackPtr The position of the current token in the stack passed in $tokens.
347-
*
348-
* @return void
349-
*/
350-
protected function process_css_style( $stackPtr ) {
351-
if ( ! isset( $this->target_css_properties[ $this->tokens[ $stackPtr ]['content'] ] ) ) {
352-
// Not one of the CSS properties we're interested in.
353-
return;
354-
}
355-
356-
$css_property = $this->target_css_properties[ $this->tokens[ $stackPtr ]['content'] ];
357-
358-
// Check if the CSS selector matches.
359-
$opener = $this->phpcsFile->findPrevious( \T_OPEN_CURLY_BRACKET, $stackPtr );
360-
if ( $opener !== false ) {
361-
for ( $i = ( $opener - 1 ); $i >= 0; $i-- ) {
362-
if ( isset( Tokens::$commentTokens[ $this->tokens[ $i ]['code'] ] )
363-
|| $this->tokens[ $i ]['code'] === \T_CLOSE_CURLY_BRACKET
364-
) {
365-
break;
366-
}
367-
}
368-
$start = ( $i + 1 );
369-
$selector = trim( GetTokensAsString::normal( $this->phpcsFile, $start, ( $opener - 1 ) ) );
370-
unset( $i );
371-
372-
foreach ( $this->target_css_selectors as $target_selector ) {
373-
if ( strpos( $selector, $target_selector ) !== false ) {
374-
$error = true;
375-
376-
if ( $this->remove_only === true ) {
377-
// Check the value of the CSS property.
378-
$valuePtr = $this->phpcsFile->findNext( [ \T_COLON, \T_WHITESPACE ], $stackPtr + 1, null, true );
379-
$value = $this->tokens[ $valuePtr ]['content'];
380-
$valid = $this->validate_css_property_value( $value, $css_property['type'], $css_property['value'] );
381-
if ( $valid === true ) {
382-
$error = false;
383-
}
384-
}
385-
386-
if ( $error === true ) {
387-
$this->addHidingDetectedError( $stackPtr );
388-
}
389-
}
390-
}
391-
}
392-
}
393-
394323
/**
395324
* Consolidated violation.
396325
*

‎WordPressVIPMinimum/Tests/Security/Gruntfile.js‎

Lines changed: 0 additions & 100 deletions
This file was deleted.

0 commit comments

Comments
 (0)