Skip to content

Commit 436b0fe

Browse files
jrfnlGaryJones
andcommitted
VIPMinimum ruleset: update excludes for the WP/AlternativeFunctions sniff
... to prevent introducing new duplicate error messages. Co-authored-by: Gary Jones <gary.jones@automattic.com>
1 parent 6d05fff commit 436b0fe

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

WordPress-VIP-Go/ruleset-test.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && $_SERVER['HTTP_USER_AGENT'] === 'so
5959
// Make sure nonce verification is done in global scope to silence notices about use of superglobals without later on in the file.
6060
isset( $_GET['my_nonce'] ) && wp_verify_nonce( sanitize_text_field( $_GET['my_nonce'] ) );
6161

62-
// WordPress.WP.AlternativeFunctions.file_system_read_fopen
62+
// WordPress.WP.AlternativeFunctions.file_system_operations_fopen
6363
fopen( 'file.txt', 'r' ); // Warning + Message.
6464

6565
// WordPressVIPMinimum.Performance.FetchingRemoteData.FileGetContentsUnknown

WordPress-VIP-Go/ruleset.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
This includes potential security holes as well as functions that may bring down sites for performance reasons.
105105
-->
106106
<!-- Should fix all of them but it doesn't need a manual review -->
107-
<rule ref="WordPress.WP.AlternativeFunctions.file_system_read_fopen">
107+
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fopen">
108108
<message>File system operations only work on the `/tmp/` and `wp-content/uploads/` directories. To avoid unexpected results, please use helper functions like `get_temp_dir()` or `wp_get_upload_dir()` to get the proper directory path when using functions such as %s(). For more details, please see: https://docs.wpvip.com/technical-references/vip-go-files-system/local-file-operations/</message>
109109
</rule>
110110
<rule ref="WordPressVIPMinimum.Performance.FetchingRemoteData.FileGetContentsUnknown">
@@ -249,10 +249,10 @@
249249
<rule ref="Generic.PHP.DisallowShortOpenTag.EchoFound">
250250
<severity>0</severity>
251251
</rule>
252-
<rule ref="WordPress.WP.AlternativeFunctions.file_system_read_readfile">
252+
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_readfile">
253253
<severity>0</severity>
254254
</rule>
255-
<rule ref="WordPress.WP.AlternativeFunctions.file_system_read_fclose">
255+
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fclose">
256256
<severity>0</severity>
257257
</rule>
258258

WordPressVIPMinimum/ruleset.xml

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,32 @@
135135
<exclude name="WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents"/>
136136
<!-- This is already covered in WordPressVIPMinimum.Functions.StripTags.StripTagsOneParameter -->
137137
<exclude name="WordPress.WP.AlternativeFunctions.strip_tags_strip_tags"/>
138-
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_fwrite -->
139-
<exclude name="WordPress.WP.AlternativeFunctions.file_system_read_fwrite"/>
140138
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_file_put_contents -->
141-
<exclude name="WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents"/>
139+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents"/>
140+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_fputs -->
141+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_fputs"/>
142+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_fwrite -->
143+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_fwrite"/>
144+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_is_writable -->
145+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_is_writable"/>
146+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_is_writeable -->
147+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_is_writeable"/>
148+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_rename -->
149+
<exclude name="WordPress.WP.AlternativeFunctions.rename_rename"/>
150+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_touch -->
151+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_touch"/>
152+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_unlink -->
153+
<exclude name="WordPress.WP.AlternativeFunctions.unlink_unlink"/>
154+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.directory_mkdir -->
155+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_mkdir"/>
156+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.directory_rmdir -->
157+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_rmdir"/>
158+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.chmod_chgrp -->
159+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_chgrp"/>
160+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.chmod_chown -->
161+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_chown"/>
162+
<!-- This is already covered in WordPressVIPMinimum.Functions.RestrictedFunctions.chmod_chmod -->
163+
<exclude name="WordPress.WP.AlternativeFunctions.file_system_operations_chmod"/>
142164
</rule>
143165
<!-- VIP recommends other functions -->
144166
<rule ref="WordPress.WP.AlternativeFunctions.curl_curl_init">

0 commit comments

Comments
 (0)