options.php
10.1 KB
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<?php
use WP_Rocket\Logger\Logger;
defined( 'ABSPATH' ) || exit;
/**
* When our settings are saved: purge, flush, preload!
*
* @since 1.0
*
* When the settins menu is hidden, redirect on the main settings page to avoid the same thing
* (Only when a form is sent from our options page )
*
* @since 2.1
*
* @param array $oldvalue An array of previous values for the settings.
* @param array $value An array of submitted values for the settings.
*/
function rocket_after_save_options( $oldvalue, $value ) {
if ( ! is_array( $oldvalue ) || ! is_array( $value ) ) {
return;
}
// These values do not need to clean the cache domain.
$removed = [
'cache_mobile' => true,
'purge_cron_interval' => true,
'purge_cron_unit' => true,
'database_revisions' => true,
'database_auto_drafts' => true,
'database_trashed_posts' => true,
'database_spam_comments' => true,
'database_trashed_comments' => true,
'database_all_transients' => true,
'database_optimize_tables' => true,
'schedule_automatic_cleanup' => true,
'automatic_cleanup_frequency' => true,
'do_cloudflare' => true,
'cloudflare_email' => true,
'cloudflare_api_key' => true,
'cloudflare_zone_id' => true,
'cloudflare_devmode' => true,
'cloudflare_auto_settings' => true,
'cloudflare_old_settings' => true,
'heartbeat_admin_behavior' => true,
'heartbeat_editor_behavior' => true,
'varnish_auto_purge' => true,
'analytics_enabled' => true,
'sucury_waf_cache_sync' => true,
'sucury_waf_api_key' => true,
'manual_preload' => true,
'preload_excluded_uri' => true,
];
// Create 2 arrays to compare.
$oldvalue_diff = array_diff_key( $oldvalue, $removed );
$value_diff = array_diff_key( $value, $removed );
// phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( ( array_key_exists( 'minify_js', $oldvalue ) && array_key_exists( 'minify_js', $value ) && $oldvalue['minify_js'] !== $value['minify_js'] )
||
( array_key_exists( 'exclude_js', $oldvalue ) && array_key_exists( 'exclude_js', $value ) && $oldvalue['exclude_js'] !== $value['exclude_js'] )
||
( array_key_exists( 'cdn', $oldvalue ) && array_key_exists( 'cdn', $value ) && $oldvalue['cdn'] !== $value['cdn'] )
||
( array_key_exists( 'cdn_cnames', $oldvalue ) && array_key_exists( 'cdn_cnames', $value ) && $oldvalue['cdn_cnames'] !== $value['cdn_cnames'] )
) {
rocket_clean_minify( 'js' );
}
// Regenerate advanced-cache.php file.
// phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( ! empty( $_POST ) && ( ( isset( $oldvalue['do_caching_mobile_files'] ) && ! isset( $value['do_caching_mobile_files'] ) ) || ( ! isset( $oldvalue['do_caching_mobile_files'] ) && isset( $value['do_caching_mobile_files'] ) ) || ( isset( $oldvalue['do_caching_mobile_files'], $value['do_caching_mobile_files'] ) ) && $oldvalue['do_caching_mobile_files'] !== $value['do_caching_mobile_files'] ) ) {
rocket_generate_advanced_cache_file();
}
// Update .htaccess file rules.
flush_rocket_htaccess( ! rocket_valid_key() );
// Update config file.
rocket_generate_config_file();
if ( isset( $oldvalue['analytics_enabled'], $value['analytics_enabled'] ) && $oldvalue['analytics_enabled'] !== $value['analytics_enabled'] && 1 === (int) $value['analytics_enabled'] ) {
set_transient( 'rocket_analytics_optin', 1 );
}
ksort( $oldvalue_diff );
ksort( $value_diff );
// If it's different, clean the domain.
if ( md5( wp_json_encode( $oldvalue_diff ) ) !== md5( wp_json_encode( $value_diff ) ) ) {
// Purge all cache files.
rocket_clean_domain();
/**
* Fires after WP Rocket options that require a cache purge have changed
*
* @since 3.11
*
* @param array $value An array of submitted values for the settings.
*/
do_action( 'rocket_options_changed', $value );
}
}
add_action( 'update_option_' . rocket_get_constant( 'WP_ROCKET_SLUG' ), 'rocket_after_save_options', 10, 2 );
/**
* Perform actions when settings are saved.
*
* @since 1.0
*
* @param array $newvalue An array of submitted options values.
* @param array $oldvalue An array of previous options values.
* @return array Updated submitted options values.
*/
function rocket_pre_main_option( $newvalue, $oldvalue ) {
$rocket_settings_errors = [];
// Make sure that fields that allow users to enter patterns are well formatted.
$is_form_submit = isset( $_POST['option_page'] ) ? sanitize_key( $_POST['option_page'] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
$is_form_submit = WP_ROCKET_PLUGIN_SLUG === $is_form_submit;
$errors = [];
$pattern_labels = [
'exclude_css' => __( 'Excluded CSS Files', 'rocket' ),
'exclude_inline_js' => __( 'Excluded Inline JavaScript', 'rocket' ),
'exclude_js' => __( 'Excluded JavaScript Files', 'rocket' ),
'exclude_defer_js' => __( 'Defer JavaScript Files', 'rocket' ),
'delay_js_exclusions' => __( 'Excluded Delay JavaScript Files', 'rocket' ),
'cache_reject_uri' => __( 'Never Cache URL(s)', 'rocket' ),
'cache_reject_ua' => __( 'Never Cache User Agent(s)', 'rocket' ),
'cache_purge_pages' => __( 'Always Purge URL(s)', 'rocket' ),
'cdn_reject_files' => __( 'Exclude files from CDN', 'rocket' ),
];
foreach ( $pattern_labels as $pattern_field => $label ) {
if ( empty( $newvalue[ $pattern_field ] ) ) {
// The field is empty.
continue;
}
// Sanitize.
$newvalue[ $pattern_field ] = rocket_sanitize_textarea_field( $pattern_field, $newvalue[ $pattern_field ] );
// Validate.
$newvalue[ $pattern_field ] = array_filter(
$newvalue[ $pattern_field ],
function( $excluded ) use ( $pattern_field, $label, $is_form_submit, &$errors ) {
if ( false === @preg_match( '#' . str_replace( '#', '\#', $excluded ) . '#', 'dummy-sample' ) && $is_form_submit ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
/* translators: 1 and 2 can be anything. */
$errors[ $pattern_field ][] = sprintf( __( '%1$s: <em>%2$s</em>', 'rocket' ), $label, esc_html( $excluded ) );
return false;
}
return true;
}
);
}
if ( $errors ) {
$error_message = _n( 'The following pattern is invalid and has been removed:', 'The following patterns are invalid and have been removed:', array_sum( array_map( 'count', $errors ) ), 'rocket' );
$error_message .= '</strong></p>'; // close out default opening tags from WP's settings_errors().
foreach ( $errors as $error ) {
$error_message .= '<ul><li>' . implode( '</li><li>', $error ) . '</li></ul>';
}
$error_message .= '<p><strong>'; // Re-open tags that WP's settings_errors() will close at end of notice box.
$container = apply_filters( 'rocket_container', [] );
$invalid_exclusions_beacon = $container->get( 'beacon' )->get_suggest( 'invalid_exclusions' );
$error_message .= sprintf(
'<a href="%1$s" data-beacon-article="%2$s" rel="noopener noreferrer" target="_blank">%3$s</a>',
$invalid_exclusions_beacon['url'],
$invalid_exclusions_beacon['id'],
__( 'More info', 'rocket' )
);
$errors = [];
$rocket_settings_errors[] = [
'setting' => 'general',
'code' => 'invalid_patterns',
'message' => __( 'WP Rocket: ', 'rocket' ) . $error_message,
'type' => 'error',
];
}
// Clear WP Rocket database optimize cron if the setting has been modified.
if ( ( isset( $newvalue['schedule_automatic_cleanup'], $oldvalue['schedule_automatic_cleanup'] ) && $newvalue['schedule_automatic_cleanup'] !== $oldvalue['schedule_automatic_cleanup'] ) || ( ( isset( $newvalue['automatic_cleanup_frequency'], $oldvalue['automatic_cleanup_frequency'] ) && $newvalue['automatic_cleanup_frequency'] !== $oldvalue['automatic_cleanup_frequency'] ) ) ) {
if ( wp_next_scheduled( 'rocket_database_optimization_time_event' ) ) {
wp_clear_scheduled_hook( 'rocket_database_optimization_time_event' );
}
}
// Regenerate the minify key if JS files have been modified.
// phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
if ( ( isset( $newvalue['minify_js'], $oldvalue['minify_js'] ) && $newvalue['minify_js'] != $oldvalue['minify_js'] )
|| ( isset( $newvalue['exclude_js'], $oldvalue['exclude_js'] ) && $newvalue['exclude_js'] !== $oldvalue['exclude_js'] )
|| ( isset( $oldvalue['cdn'] ) && ! isset( $newvalue['cdn'] ) || ! isset( $oldvalue['cdn'] ) && isset( $newvalue['cdn'] ) )
) {
$newvalue['minify_js_key'] = create_rocket_uniqid();
}
// Checked the SSL option if the whole website is on SSL.
if ( rocket_is_ssl_website() ) {
$newvalue['cache_ssl'] = 1;
}
if ( 'local' === wp_get_environment_type() ) {
$newvalue['optimize_css_delivery'] = 0;
$newvalue['remove_unused_css'] = 0;
$newvalue['async_css'] = 0;
}
if ( ! rocket_get_constant( 'WP_ROCKET_ADVANCED_CACHE' ) ) {
rocket_generate_advanced_cache_file();
}
$keys = get_transient( WP_ROCKET_SLUG );
if ( $keys ) {
delete_transient( WP_ROCKET_SLUG );
$newvalue = array_merge( $newvalue, $keys );
}
if ( ! $rocket_settings_errors ) {
return $newvalue;
}
$transient_errors = get_transient( 'settings_errors' );
if ( ! $transient_errors || ! is_array( $transient_errors ) ) {
$transient_errors = [];
}
$settings_errors = array_merge( $transient_errors, $rocket_settings_errors );
foreach ( $settings_errors as $error ) {
add_settings_error( $error['setting'], $error['code'], $error['message'], $error['type'] );
}
return $newvalue;
}
add_filter( 'pre_update_option_' . rocket_get_constant( 'WP_ROCKET_SLUG' ), 'rocket_pre_main_option', 10, 2 );
/**
* Auto-activate the SSL cache if the website URL is updated with https protocol
*
* @since 2.7
*
* @param array $old_value An array of previous options values.
* @param array $value An array of submitted options values.
*/
function rocket_update_ssl_option_after_save_home_url( $old_value, $value ) {
if ( $old_value === $value || get_rocket_option( 'cache_ssl' ) ) {
return;
}
$scheme = rocket_extract_url_component( $value, PHP_URL_SCHEME );
update_rocket_option( 'cache_ssl', 'https' === $scheme ? 1 : 0 );
}
add_action( 'update_option_home', 'rocket_update_ssl_option_after_save_home_url', 10, 2 );