observium-ce-archive/.phpcs.xml at main · mews-se/observium-ce-archive · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<?xml version="1.0"?>
<ruleset name="Observium ruleset">
    <description>Observium rules for PHP CodeSniffer</description>

    <arg value="sp"/>
    <arg name="extensions" value="php"/>

    <file>.</file>

    <!-- <arg name="report" value="xml"/>
    <arg name="report-file" value="phpcs-report.xml"/> -->

    <!-- Exclude unused code. -->
    <exclude-pattern>*/attic/*</exclude-pattern>
    <!-- Exclude devel code. -->
    <exclude-pattern>*/devel/*</exclude-pattern>
    <!-- Exclude Composer vendor directory. -->
    <exclude-pattern>*/vendor/*</exclude-pattern>
    <!-- Weathermap exclude -->
    <exclude-pattern>*/weathermap/*</exclude-pattern>
    <!-- Self PHPCompatibility exclude -->
    <exclude-pattern>tests/php-compatibility/*</exclude-pattern>

    <!-- Strip the filepaths down to the relevant bit. -->
    <arg name="basepath" value="./"/>

    <!-- Check up to 8 files simultanously. -->
    <arg name="parallel" value="8"/>

    <!-- PHPCompatibility standard path -->
    <!-- <config name="installed_paths" value="tests/php-compatibility"/> -->

    <!-- Check for cross-version support for PHP 5.6 and higher. -->
    <config name="testVersion" value="5.6-"/>

    <!-- Run against the PHPCompatibility ruleset -->
    <rule ref="PHPCompatibility">
        <exclude-pattern>irc\.php$</exclude-pattern>
        <exclude-pattern>*/weathermap/*</exclude-pattern>
        <!-- random_bytes() already exist by compatibility lib -->
        <exclude name="PHPCompatibility.FunctionUse.NewFunctions.random_bytesFound"/>
        <exclude name="PHPCompatibility.FunctionUse.NewFunctions.random_intFound"/>
        <!-- array_key_first() already exist by compatibility -->
        <exclude name="PHPCompatibility.FunctionUse.NewFunctions.array_key_firstFound"/>
    </rule>

    <!-- Whitelist the mysql_to_rfc3339() and mysql_another_function() functions. -->
    <rule ref="PHPCompatibility.Extensions.RemovedExtensions">
        <properties>
            <property name="functionWhitelist" type="array" value="mysql_authenticate,mysql_auth_can_logout,mysql_auth_can_change_password,mysql_auth_change_password,mysql_auth_usermanagement,mysql_adduser,mysql_auth_user_exists,mysql_auth_username_by_id,mysql_auth_user_level,mysql_auth_user_id,mysql_deluser,mysql_auth_user_list,mysql_auth_user_info"/>
        </properties>
    </rule>

    <!-- random_compat lib -->
    <rule ref="PHPCompatibility.Classes.NewClasses.typeerrorFound">
        <exclude-pattern>libs/random_compat/*</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Classes.NewClasses.errorFound">
        <exclude-pattern>libs/random_compat/*</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.IniDirectives.RemovedIniDirectives.mbstring_func_overloadDeprecated">
        <exclude-pattern>libs/random_compat/*</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_create_ivDeprecatedRemoved">
        <exclude-pattern>libs/random_compat/*</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.RemovedConstants.mcrypt_dev_urandomDeprecatedRemoved">
        <exclude-pattern>libs/random_compat/*</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>

    <!-- pear chap lib excludes -->
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_module_openDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.RemovedConstants.mcrypt_desDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_enc_get_iv_sizeDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.RemovedConstants.mcrypt_randDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_generic_initDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_genericDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_generic_deinitDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_module_closeDeprecatedRemoved">
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>

    <!-- pear net socket excludes -->
    <rule ref="PHPCompatibility.IniDirectives.RemovedIniDirectives.track_errorsDeprecated">
        <exclude-pattern>libs/pear/Net/Socket\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Variables.RemovedPredefinedGlobalVariables.php_errormsgDeprecated">
        <exclude-pattern>libs/pear/Net/Socket\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctions.error_clear_lastFound">
        <exclude-pattern>libs/pear/Net/Socket\.php</exclude-pattern>
    </rule>

    <!-- Exclude shiff on specific patterns -->
    <rule ref="PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection">
        <exclude-pattern>includes/common\.inc\.php</exclude-pattern>
        <exclude-pattern>libs/Fabiang/Xmpp/*</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Miscellaneous.ValidIntegers.HexNumericStringFound">
        <exclude-pattern>tests/*</exclude-pattern>
        <exclude-pattern>libs/pear/*</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.IniDirectives.RemovedIniDirectives.magic_quotes_runtimeDeprecatedRemoved">
        <exclude-pattern>libs/pear/Mail/mime*</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.NewConstants.json_preserve_zero_fractionFound">
        <exclude-pattern>includes/definitions\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved">
        <exclude-pattern>includes/db/mysql\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.IniDirectives.RemovedIniDirectives.session_hash_functionRemoved">
        <exclude-pattern>html/includes/authenticate\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.NewConstants.sodium_crypto_secretbox_keybytesFound">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.NewConstants.sodium_crypto_secretbox_noncebytesFound">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctions.sodium_padFound">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctions.sodium_crypto_secretboxFound">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Classes.NewClasses.sodiumexceptionFound">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctions.sodium_crypto_secretbox_openFound">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Extensions.RemovedExtensions.mcryptDeprecatedRemoved">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
        <exclude-pattern>libs/random_compat/*</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_encryptDeprecatedRemoved">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.mcrypt_decryptDeprecatedRemoved">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.RemovedConstants.mcrypt_rijndael_256DeprecatedRemoved">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.RemovedConstants.mcrypt_mode_ecbDeprecatedRemoved">
        <exclude-pattern>tests/IncludesEncryptTest\.php</exclude-pattern>
        <exclude-pattern>includes/encrypt\.inc\.php</exclude-pattern>
        <exclude-pattern>libs/pear/Crypt/CHAP\.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.get_magic_quotes_gpcDeprecated">
        <exclude-pattern>html/includes/collectd/functions.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctions.session_create_idFound">
        <exclude-pattern>html/includes/authenticate.inc.php</exclude-pattern>
    </rule>
    <!-- compatability fixed in code -->
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.ldap_control_paged_resultDeprecated">
        <exclude-pattern>html/includes/authentication/ldap.inc.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.RemovedFunctions.ldap_control_paged_result_responseDeprecated">
        <exclude-pattern>html/includes/authentication/ldap.inc.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctionParameters.ldap_search_serverctrlsFound">
        <exclude-pattern>html/includes/authentication/ldap.inc.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.FunctionUse.NewFunctionParameters.ldap_parse_result_serverctrlsFound">
        <exclude-pattern>html/includes/authentication/ldap.inc.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.NewConstants.ldap_control_pagedresultsFound">
        <exclude-pattern>html/includes/authentication/ldap.inc.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Miscellaneous.ValidIntegers.HexNumericStringFound">
        <exclude-pattern>includes/entities/sensor.inc.php</exclude-pattern>
    </rule>
    <rule ref="PHPCompatibility.Constants.NewConstants.mysqli_client_ssl_dont_verify_server_certFound">
        <exclude-pattern>includes/db/mysqli.inc.php</exclude-pattern>
    </rule>

    <!-- Run against a second ruleset -->
    <!-- <rule ref="PSR2"/> -->

</ruleset>