Settings.php
12.9 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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<?php
declare(strict_types=1);
namespace WP_Rocket\Engine\Optimization\RUCSS\Admin;
use WP_Rocket\Admin\Options_Data;
use WP_Rocket\Engine\Admin\Beacon\Beacon;
use WP_Rocket\Engine\Admin\Settings\Settings as AdminSettings;
use WP_Rocket\Engine\Optimization\RUCSS\Database\Tables\UsedCSS;
class Settings {
/**
* Instance of options handler.
*
* @var Options_Data
*/
private $options;
/**
* Instance of Beacon class.
*
* @var Beacon
*/
private $beacon;
/**
* Used CSS table.
*
* @var UsedCSS
*/
private $used_css;
/**
* Creates an instance of the class.
*
* @param Options_Data $options WP Rocket Options instance.
* @param Beacon $beacon Beacon instance.
* @param UsedCSS $used_css Used CSS table.
*/
public function __construct( Options_Data $options, Beacon $beacon, UsedCSS $used_css ) {
$this->options = $options;
$this->beacon = $beacon;
$this->used_css = $used_css;
}
/**
* Add the RUCSS options to the WP Rocket options array
*
* @since 3.9
*
* @param array $options WP Rocket options array.
*
* @return array
*/
public function add_options( $options ) : array {
$options = (array) $options;
$options['remove_unused_css'] = 0;
$options['remove_unused_css_safelist'] = [];
return $options;
}
/**
* Determines if Remove Unused CSS option is enabled.
*
* @since 3.9
*
* @return boolean
*/
public function is_enabled() : bool {
return (bool) $this->options->get( 'remove_unused_css', 0 );
}
/**
* Sanitizes RUCSS options values when the settings form is submitted
*
* @since 3.9
*
* @param array $input Array of values submitted from the form.
* @param AdminSettings $settings Settings class instance.
*
* @return array
*/
public function sanitize_options( array $input, AdminSettings $settings ) : array {
$input['remove_unused_css'] = $settings->sanitize_checkbox( $input, 'remove_unused_css' );
$input['remove_unused_css_safelist'] = ! empty( $input['remove_unused_css_safelist'] ) ? rocket_sanitize_textarea_field( 'remove_unused_css_safelist', $input['remove_unused_css_safelist'] ) : [];
return $input;
}
/**
* Add Clean used CSS link to WP Rocket admin bar item
*
* @since 3.9
*
* @param \WP_Admin_Bar $wp_admin_bar WP_Admin_Bar instance, passed by reference.
*
* @return void
*/
public function add_clean_used_css_menu_item( $wp_admin_bar ) {
if ( 'local' === wp_get_environment_type() ) {
return;
}
if ( ! current_user_can( 'rocket_remove_unused_css' ) ) {
return;
}
if ( ! is_admin() ) {
return;
}
if ( ! $this->is_enabled() ) {
return;
}
$referer = '';
$action = 'rocket_clear_usedcss';
if ( ! empty( $_SERVER['REQUEST_URI'] ) ) {
$referer_url = filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL );
$referer = '&_wp_http_referer=' . rawurlencode( remove_query_arg( 'fl_builder', $referer_url ) );
}
$wp_admin_bar->add_menu(
[
'parent' => 'wp-rocket',
'id' => 'clean-used-css',
'title' => __( 'Clear Used CSS', 'rocket' ),
'href' => wp_nonce_url( admin_url( "admin-post.php?action={$action}{$referer}" ), $action ),
]
);
}
/**
* Set optimize css delivery value
*
* @since 3.10
*
* @param array $field_args Array of field to be added to settings page.
*
* @return array
*/
public function set_optimize_css_delivery_value( $field_args ): array {
if ( 'optimize_css_delivery' !== $field_args['id'] ) {
return $field_args;
}
$async_css_value = (bool) $this->options->get( 'async_css', 0 );
$remove_unused_css_value = (bool) $this->options->get( 'remove_unused_css', 0 );
$field_args['value'] = ( $remove_unused_css_value || $async_css_value );
return $field_args;
}
/**
* Set optimize css delivery method value
*
* @since 3.10
*
* @param array $field_args Array of field to be added to settings page.
*
* @return array
*/
public function set_optimize_css_delivery_method_value( $field_args ): array {
if ( 'optimize_css_delivery_method' !== $field_args['id'] ) {
return $field_args;
}
$value = '';
if ( (bool) $this->options->get( 'async_css', 0 ) ) {
$value = 'async_css';
}
if ( (bool) $this->options->get( 'remove_unused_css', 0 ) ) {
$value = 'remove_unused_css';
}
$field_args['value'] = $value;
return $field_args;
}
/**
* Displays the RUCSS currently processing notice
*
* @since 3.11
*
* @return void
*/
public function display_processing_notice() {
if ( ! $this->can_display_notice() ) {
return;
}
if ( ! $this->used_css->exists() ) {
return;
}
$transient = get_transient( 'rocket_rucss_processing' );
if ( false === $transient ) {
return;
}
$current_time = time();
if ( $transient < $current_time ) {
return;
}
$remaining = $transient - $current_time;
$message = sprintf(
// translators: %1$s = plugin name, %2$s = number of seconds.
__( '%1$s: Please wait %2$s seconds. The Remove Unused CSS service is processing your pages.', 'rocket' ),
'<strong>WP Rocket</strong>',
'<span id="rocket-rucss-timer">' . $remaining . '</span>'
);
rocket_notice_html(
[
'status' => 'info',
'message' => $message,
'id' => 'rocket-notice-rucss-processing',
]
);
}
/**
* Displays the RUCSS success notice
*
* @since 3.11
*
* @return void
*/
public function display_success_notice() {
if ( ! $this->can_display_notice() ) {
return;
}
if ( ! $this->used_css->exists() ) {
return;
}
$boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true );
if ( in_array( 'rucss_success_notice', (array) $boxes, true ) ) {
return;
}
$transient = get_transient( 'rocket_rucss_processing' );
$class = '';
if ( false !== $transient ) {
$class = 'hidden';
}
$message = sprintf(
// translators: %1$s = plugin name, %2$s = number of URLs, %3$s = number of seconds.
__( '%1$s: The Used CSS of your homepage has been processed. WP Rocket will continue to generate Used CSS for up to %2$s URLs per %3$s second(s).', 'rocket' ),
'<strong>WP Rocket</strong>',
apply_filters( 'rocket_rucss_pending_jobs_cron_rows_count', 100 ),
apply_filters( 'rocket_rucss_pending_jobs_cron_interval', MINUTE_IN_SECONDS )
);
if ( ! $this->options->get( 'manual_preload', 0 ) ) {
$message .= ' ' . sprintf(
// translators: %1$s = opening link tag, %2$s = closing link tag.
__( 'We suggest enabling %1$sPreload%2$s for the fastest results.', 'rocket' ),
'<a href="#preload">',
'</a>'
);
}
$beacon = $this->beacon->get_suggest( 'async_opti' );
$message .= '<br>' . sprintf(
// translators: %1$s = opening link tag, %2$s = closing link tag.
__( 'To learn more about the process check our %1$sdocumentation%2$s.', 'rocket' ),
'<a href="' . esc_url( $beacon['url'] ) . '" data-beacon-article="' . esc_attr( $beacon['id'] ) . '" rel="noopener noreferrer" target="_blank">',
'</a>'
);
rocket_notice_html(
[
'message' => $message,
'dismissible' => $class,
'id' => 'rocket-notice-rucss-success',
'dismiss_button' => 'rucss_success_notice',
'dismiss_button_class' => 'button-primary',
]
);
}
/**
* Checks if we can display the RUCSS notices
*
* @param bool $check_enabled check if RUCSS is enabled.
*
* @since 3.11
*
* @return bool
*/
private function can_display_notice( $check_enabled = true ): bool {
$screen = get_current_screen();
if ( ! rocket_direct_filesystem()->is_writable( rocket_get_constant( 'WP_ROCKET_USED_CSS_PATH' ) ) ) {
return false;
}
if (
isset( $screen->id )
&&
'settings_page_wprocket' !== $screen->id
) {
return false;
}
if ( ! current_user_can( 'rocket_manage_options' ) ) {
return false;
}
if ( $check_enabled && ! $this->is_enabled() ) {
return false;
}
return true;
}
/**
* Adds the notice end time to WP Rocket localize script data
*
* @since 3.11
*
* @param array $data Localize script data.
*
* @return array
*/
public function add_localize_script_data( $data ): array {
if ( ! is_array( $data ) ) {
$data = (array) $data;
}
if ( ! $this->is_enabled() ) {
return $data;
}
$transient = get_transient( 'rocket_rucss_processing' );
if ( false === $transient ) {
return $data;
}
$data['notice_end_time'] = $transient;
return $data;
}
/**
* Disable combine CSS option when RUCSS is enabled
*
* @since 3.11
*
* @param array $value The new, unserialized option value.
* @param array $old_value The old option value.
*
* @return array
*/
public function maybe_disable_combine_css( $value, $old_value ): array {
if ( ! isset( $value['remove_unused_css'], $value['minify_concatenate_css'] ) ) {
return $value;
}
if (
0 === $value['minify_concatenate_css']
||
0 === $value['remove_unused_css']
) {
return $value;
}
if (
isset( $old_value['remove_unused_css'], $old_value['minify_concatenate_css'] )
&&
$value['remove_unused_css'] === $old_value['remove_unused_css']
&&
$value['minify_concatenate_css'] === $old_value['minify_concatenate_css']
&&
0 === $old_value['minify_concatenate_css']
) {
return $value;
}
$value['minify_concatenate_css'] = 0;
return $value;
}
/**
* Disables combine CSS if RUCSS is enabled when updating to 3.11
*
* @since 3.11
*
* @param string $old_version Previous plugin version.
*
* @return void
*/
public function set_option_on_update( $old_version ) {
if ( version_compare( $old_version, '3.11', '>=' ) ) {
return;
}
$options = get_option( 'wp_rocket_settings', [] );
if ( 'local' === wp_get_environment_type() ) {
$options['optimize_css_delivery'] = 0;
$options['remove_unused_css'] = 0;
$options['async_css'] = 0;
}
if (
isset( $options['remove_unused_css'] )
&&
1 === (int) $options['remove_unused_css']
) {
$options['minify_concatenate_css'] = 0;
}
update_option( 'wp_rocket_settings', $options );
}
/**
* Updates safelist items for new SaaS compatibility
*
* @since 3.11.0.2
*
* @param string $old_version Previous plugin version.
*
* @return void
*/
public function update_safelist_items( $old_version ) {
if ( version_compare( $old_version, '3.11.0.2', '>=' ) ) {
return;
}
$options = get_option( 'wp_rocket_settings', [] );
if ( empty( $options['remove_unused_css_safelist'] ) ) {
return;
}
foreach ( $options['remove_unused_css_safelist'] as $key => $value ) {
if ( str_contains( $value, '.css' ) ) {
continue;
}
if ( str_starts_with( $value, '(' ) ) {
continue;
}
$options['remove_unused_css_safelist'][ $key ] = '(.*)' . $value;
}
update_option( 'wp_rocket_settings', $options );
}
/**
* Display a notification on wrong license.
*
* @return void
*/
public function display_wrong_license_notice() {
if ( ! $this->can_display_notice( false ) ) {
return;
}
$main_message = __( "We couldn't generate the used CSS because you're using a nulled version of WP Rocket. You need an active license to use the Remove Unused CSS feature and further improve your website's performance.", 'rocket' );
$cta_message = sprintf(
// translators: %1$s = promo percentage.
__( 'Click here to get a WP Rocket single license at %1$s off!', 'rocket' ),
'10%%'
);
$message = sprintf(
// translators: %1$s = plugin name, %2$s = opening anchor tag, %3$s = closing anchor tag.
"%1\$s: <p>$main_message</p>%2\$s$cta_message%3\$s",
'<strong>WP Rocket</strong>',
'<a href="https://wp-rocket.me/?add-to-cart=191&coupon_code=iamnotapirate10" class="button button-primary" rel="noopener noreferrer" target="_blank">',
'</a>'
);
rocket_notice_html(
[
'status' => 'error',
'dismissible' => '',
'message' => $message,
'id' => 'rocket-notice-rucss-wrong-licence',
]
);
}
/**
* Display a notice on table missing.
*
* @return void
*/
public function display_no_table_notice() {
if ( ! $this->can_display_notice() ) {
return;
}
if ( $this->used_css->exists() ) {
return;
}
// translators: %2$s = table name, %3$s = support url.
$main_message = __( 'Could not create the %2$s table in the database which is necessary for the Remove Unused CSS feature to work. Please reach out to <a href="%3$s">our support</a>.', 'rocket' );
$message = sprintf(
// translators: %1$s = plugin name, %2$s = table name, %3$s = support url.
"%1\$s: $main_message",
'<strong>WP Rocket</strong>',
$this->used_css->get_name(),
$this->get_support_url()
);
rocket_notice_html(
[
'status' => 'error',
'dismissible' => '',
'message' => $message,
'id' => 'rocket-notice-rucss-missing-table',
]
);
}
/**
* Get support URL.
*
* @return string
*/
protected function get_support_url() {
return rocket_get_external_url(
'support',
[
'utm_source' => 'wp_plugin',
'utm_medium' => 'wp_rocket',
]
);
}
}