PluginProbe
Autoptimize / 3.0.2
Autoptimize v3.0.2
2.2.2 2.3.0 2.3.1 2.3.2 2.3.3 2.3.4 2.4.0 2.4.1 2.4.2 2.4.3 2.4.4 2.5.0 2.5.1 2.6.0 2.6.1 2.6.2 2.7.0 2.7.1 2.7.2 2.7.3 2.7.4 2.7.5 2.7.6 2.7.7 2.7.8 All 107 releases
autoptimize / classes / autoptimizeCriticalCSSSettings.php

autoptimizeCriticalCSSSettings.php in Autoptimize 3.0.2, at classes/autoptimizeCriticalCSSSettings.php

432 lines 23.0 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Critical CSS Options page.
4 */
5
6 if ( ! defined( 'ABSPATH' ) ) {
7 exit;
8 }
9
10 class autoptimizeCriticalCSSSettings {
11 /**
12 * Options.
13 *
14 * @var bool
15 */
16 private $settings_screen_do_remote_http = true;
17
18 public function __construct() {
19 $this->criticalcss = autoptimize()->criticalcss();
20 $this->settings_screen_do_remote_http = apply_filters( 'autoptimize_settingsscreen_remotehttp', $this->settings_screen_do_remote_http );
21 $this->run();
22 }
23
24 protected function enabled()
25 {
26 return apply_filters( 'autoptimize_filter_show_criticalcss_tabs', true );
27 }
28
29 public function run()
30 {
31 if ( $this->enabled() ) {
32 add_filter( 'autoptimize_filter_settingsscreen_tabs', array( $this, 'add_critcss_tabs' ), 10, 1 );
33 add_action( 'admin_enqueue_scripts', array( $this, 'admin_assets' ) );
34
35 if ( $this->is_multisite_network_admin() && autoptimizeOptionWrapper::is_ao_active_for_network() ) {
36 add_action( 'network_admin_menu', array( $this, 'add_critcss_admin_menu' ) );
37 } else {
38 add_action( 'admin_menu', array( $this, 'add_critcss_admin_menu' ) );
39 }
40
41 $criticalcss_ajax = new autoptimizeCriticalCSSSettingsAjax();
42 }
43 }
44
45 public function add_critcss_tabs( $in )
46 {
47 $in = array_merge( $in, array( 'ao_critcss' => 'âš¡ ' . __( 'Critical CSS', 'autoptimize' ) ) );
48
49 return $in;
50 }
51
52 public function add_critcss_admin_menu()
53 {
54 // Register settings.
55 register_setting( 'ao_ccss_options_group', 'autoptimize_css_defer_inline' );
56 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_rules' );
57 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_additional' );
58 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_queue' );
59 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_viewport' );
60 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_finclude' );
61 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_rtimelimit' );
62 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_noptimize' );
63 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_debug' );
64 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_key' );
65 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_keyst' );
66 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_loggedin' );
67 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_forcepath' );
68 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_deferjquery' );
69 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_domain' );
70 register_setting( 'ao_ccss_options_group', 'autoptimize_ccss_unloadccss' );
71
72 // And add submenu-page.
73 add_submenu_page( null, 'Critical CSS', 'Critical CSS', 'manage_options', 'ao_critcss', array( $this, 'ao_criticalcsssettings_page' ) );
74 }
75
76 public function admin_assets( $hook ) {
77 // Return if plugin is not hooked.
78 if ( 'settings_page_ao_critcss' != $hook && 'admin_page_ao_critcss' != $hook ) {
79 return;
80 }
81
82 // Stylesheets to add.
83 wp_enqueue_style( 'wp-jquery-ui-dialog' );
84 wp_enqueue_style( 'ao-tablesorter', plugins_url( 'critcss-inc/css/ao-tablesorter/style.css', __FILE__ ) );
85 wp_enqueue_style( 'ao-ccss-admin-css', plugins_url( 'critcss-inc/css/admin_styles.css', __FILE__ ) );
86
87 // Scripts to add.
88 wp_enqueue_script( 'jquery-ui-dialog', array( 'jquery' ) );
89 wp_enqueue_script( 'md5', plugins_url( 'critcss-inc/js/md5.min.js', __FILE__ ), null, null, true );
90 wp_enqueue_script( 'tablesorter', plugins_url( 'critcss-inc/js/jquery.tablesorter.min.js', __FILE__ ), array( 'jquery' ), null, true );
91 wp_enqueue_script( 'ao-ccss-admin-license', plugins_url( 'critcss-inc/js/admin_settings.js', __FILE__ ), array( 'jquery' ), null, true );
92 }
93
94 public function ao_criticalcsssettings_page()
95 {
96 // these are not OO yet, simply require for now.
97 require_once( 'critcss-inc/admin_settings_rules.php' );
98 require_once( 'critcss-inc/admin_settings_queue.php' );
99 require_once( 'critcss-inc/admin_settings_key.php' );
100 require_once( 'critcss-inc/admin_settings_adv.php' );
101 require_once( 'critcss-inc/admin_settings_explain.php' );
102
103 $ao_ccss_key = $this->criticalcss->get_option( 'key' );
104 $ao_ccss_keyst = $this->criticalcss->get_option( 'keyst' );
105 $ao_css_defer = $this->criticalcss->get_option( 'css_defer' );
106 $ao_ccss_deferjquery = $this->criticalcss->get_option( 'deferjquery' );
107 $ao_ccss_queue = $this->criticalcss->get_option( 'queue' );
108 $ao_ccss_rules = $this->criticalcss->get_option( 'rules' );
109 $ao_ccss_servicestatus = $this->criticalcss->get_option( 'servicestatus' );
110 $ao_ccss_finclude = $this->criticalcss->get_option( 'finclude' );
111 $ao_ccss_rtimelimit = $this->criticalcss->get_option( 'rtimelimit' );
112 $ao_ccss_debug = $this->criticalcss->get_option( 'debug' );
113 $ao_ccss_noptimize = $this->criticalcss->get_option( 'noptimize' );
114 $ao_css_defer_inline = $this->criticalcss->get_option( 'css_defer_inline' );
115 $ao_ccss_loggedin = $this->criticalcss->get_option( 'loggedin' );
116 $ao_ccss_forcepath = $this->criticalcss->get_option( 'forcepath' );
117 ?>
118 <script>document.title = "Autoptimize: <?php _e( 'Critical CSS', 'autoptimize' ); ?> " + document.title;</script>
119 <div class="wrap">
120 <div id="autoptimize_main">
121 <div id="ao_title_and_button">
122 <h1><?php apply_filters( 'autoptimize_filter_settings_is_pro', false ) ? _e( 'Autoptimize Pro Settings', 'autoptimize' ) : _e( 'Autoptimize Settings', 'autoptimize' ); ?></h1>
123 </div>
124
125 <?php
126 // Print AO settings tabs.
127 echo autoptimizeConfig::ao_admin_tabs();
128
129 $mkdirresult = $this->criticalcss->create_ao_ccss_dir();
130
131 // Warn if we could not create those files.
132 if ( ( true !== $mkdirresult ) ) {
133 ?>
134 <div class="notice-error notice"><p>
135 <?php
136 _e( 'Could not create the required directory. Make sure the webserver can write to the wp-content/uploads directory.', 'autoptimize' );
137 ?>
138 </p></div>
139 <?php
140 }
141
142 // Check if CSS optimization is on.
143 if ( 'on' !== autoptimizeOptionWrapper::get_option( 'autoptimize_css' ) || 'on' !== autoptimizeOptionWrapper::get_option( 'autoptimize_css_defer' ) ) {
144 ?>
145 <div class="notice-info notice"><p>
146 <?php
147 _e( 'To be able to use Critical CSS you will have to enable CSS optimization and make sure "eliminate render-blocking CSS" is active on the main Autoptimize settings page.', 'autoptimize' );
148 ?>
149 </p></div>
150 <?php
151 }
152
153 // Check for "inline & defer CSS" being active in Autoptimize.
154 if ( ! empty( $ao_ccss_key ) && ! $ao_css_defer ) {
155 if ( empty( $ao_ccss_keyst ) ) {
156 // no keystate so likely in activation-process of CCSS, let's enable "inline & defer CSS" immediately to make things easier!
157 autoptimizeOptionWrapper::update_option( 'autoptimize_css_defer', 'on' );
158 ?>
159 <div class="notice-info notice"><p>
160 <?php
161 _e( "The \"Eliminate render-blocking CSS\" option was activated to allow critical CSS to be used.", 'autoptimize' );
162 ?>
163 </p></div>
164 <?php
165 } else {
166 // we have keystate, so "inline & defer CSS" was probably disabled for troubleshooting, warn but let users continue.
167 ?>
168 <div class="notice-warning notice"><p>
169 <?php
170 _e( "Please <strong>activate the \"Eliminate render-blocking CSS\" option</strong> on Autoptimize's main settings page to ensure critical CSS is used on the front-end.", 'autoptimize' );
171 ?>
172 </p></div>
173 <?php
174 }
175 }
176
177 // check if WordPress cron is disabled and warn if so.
178 if ( ! empty( $ao_ccss_key ) && defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON && PAnD::is_admin_notice_active( 'i-know-about-disable-cron-forever' ) ) {
179 ?>
180 <div data-dismissible="i-know-about-disable-cron-forever" class="notice-warning notice is-dismissible"><p>
181 <?php
182 _e( 'WordPress cron (for task scheduling) seems to be disabled. Have a look at <a href="https://wordpress.org/plugins/autoptimize-criticalcss/faq/" target="_blank">the FAQ</a> or the info in the Job Queue instructions if all jobs remain in "N" status and no rules are created.', 'autoptimize' );
183 ?>
184 </p></div>
185 <?php
186 }
187
188 // check if defer jQuery is active and warn if so.
189 if ( 1 == $ao_ccss_deferjquery && PAnD::is_admin_notice_active( 'i-know-about-defer-inline-forever' ) ) {
190 ?>
191 <div data-dismissible="i-know-about-defer-inline-forever" class="notice-warning notice is-dismissible"><p>
192 <?php
193 _e( 'You have "defer jQuery and other non-aggregated JS-files" active (under Advanced Settings), but that functionality is deprecated and will be removed in the next major version of Autoptimize. Consider using the new "Do not aggregate but defer" and "Also defer inline JS" options on the main settings page instead.', 'autoptimize' );
194 ?>
195 </p></div>
196 <?php
197 }
198
199 // warn if it looks as though the queue processing job looks isn't running
200 // but store result in transient as to not to have to go through 2 arrays each and every time.
201 $_warn_cron = get_transient( 'ao_ccss_cronwarning' );
202 if ( ! empty( $ao_ccss_key ) && false === $_warn_cron ) {
203 $_jobs_all_new = true;
204 $_oldest_job_timestamp = microtime( true ); // now.
205 $_jobs_too_old = true;
206
207 // go over queue array.
208 if ( empty( $ao_ccss_queue ) ) {
209 // no jobs, then no warning.
210 $_jobs_all_new = false;
211 } else {
212 foreach ( $ao_ccss_queue as $job ) {
213 if ( $job['jctime'] < $_oldest_job_timestamp ) {
214 // we need to catch the oldest job's timestamp.
215 $_oldest_job_timestamp = $job['jctime'];
216 }
217
218 if ( 'NEW' !== $job['jqstat'] && 'firstrun' !== $job['ljid'] ) {
219 // we have a non-"NEW" job which is not our pending firstrun job either, break the loop.
220 $_jobs_all_new = false;
221 break;
222 }
223 }
224 }
225
226 // is the oldest job too old (4h)?
227 if ( $_oldest_job_timestamp > microtime( true ) - 60 * 60 * 4 ) {
228 $_jobs_too_old = false;
229 }
230
231 if ( $_jobs_all_new && ! $this->ao_ccss_has_autorules() && $_jobs_too_old ) {
232 $_warn_cron = 'on';
233 $_transient_multiplier = 1; // store for 1 hour.
234 } else {
235 $_warn_cron = 'off';
236 $_transient_multiplier = 4; // store for 4 hours.
237 }
238 // and set transient.
239 set_transient( 'ao_ccss_cronwarning', $_warn_cron, $_transient_multiplier * HOUR_IN_SECONDS );
240 }
241
242 if ( ! empty( $ao_ccss_key ) && 'on' == $_warn_cron && PAnD::is_admin_notice_active( 'i-know-about-cron-1' ) ) {
243 ?>
244 <div data-dismissible="i-know-about-cron-1" class="notice-warning notice is-dismissible"><p>
245 <?php
246 _e( 'It looks like there might be a problem with WordPress cron (task scheduling). Have a look at <a href="https://wordpress.org/plugins/autoptimize-criticalcss/faq/" target="_blank">the FAQ</a> or the info in the Job Queue instructions if all jobs remain in "N" status and no rules are created.', 'autoptimize' );
247 ?>
248 </p></div>
249 <?php
250 } elseif ( ! empty( $ao_ccss_key ) && '2' == $ao_ccss_keyst && 'on' != $_warn_cron && ! $this->ao_ccss_has_autorules() ) {
251 ?>
252 <div class="notice-success notice"><p>
253 <?php
254 _e( 'Great, Autoptimize will now automatically start creating new critical CSS rules, you should see those appearing below in the next couple of hours.', 'autoptimize' );
255 echo ' ';
256 _e( 'In the meantime you might want to <strong>edit default rule CSS now</strong>, to avoid all CSS being inlined when no (applicable) rules are found.', 'autoptimize' );
257 ?>
258 </p></div>
259 <?php
260 }
261
262 // warn if service is down.
263 if ( ! empty( $ao_ccss_key ) && ! empty( $ao_ccss_servicestatus ) && is_array( $ao_ccss_servicestatus ) && 'down' === $ao_ccss_servicestatus['critcss']['status'] ) {
264 ?>
265 <div class="notice-warning notice"><p>
266 <?php
267 _e( 'The critical CSS service has been reported to be down. Although no new rules will be created for now, this does not prevent existing rules from being applied.', 'autoptimize' );
268 ?>
269 </p></div>
270 <?php
271 }
272
273 // warn if too many rules (based on length of ao_ccss_rules option) as that might cause issues at e.g. wpengine
274 // see https://wpengine.com/support/database-optimization-best-practices/#Autoloaded_Data
275 $_raw_rules_length = strlen( get_option( 'autoptimize_ccss_rules', '') );
276 if ( $_raw_rules_length > apply_filters( 'autoptimize_ccss_rules_length_warning', 500000 ) ) {
277 ?>
278 <div class="notice-warning notice"><p>
279 <?php
280 _e( 'It looks like the amount of Critical CSS rules is very high, it is recommended to reconfigure Autoptimize (e.g. by manually creating broader rules) to ensure less rules are created.', 'autoptimize' );
281 ?>
282 </p></div>
283 <?php
284 }
285
286 // Settings Form.
287 ?>
288 <form id="settings" method="post" action="options.php">
289 <?php
290 settings_fields( 'ao_ccss_options_group' );
291
292 // Get API key status.
293 $key = $this->criticalcss->key_status( true );
294
295 if ( $this->is_multisite_network_admin() ) {
296 ?>
297 <ul id="key-panel">
298 <li class="itemDetail">
299 <?php
300 // translators: the placesholder is for a line of code in wp-config.php.
301 echo sprintf( __( '<p>Critical CSS settings cannot be set at network level as critical CSS is specific to each sub-site.</p><p>You can however provide the critical CSS API key for use by all sites by adding this your wp-config.php as %s</p>', 'autoptimize' ), '<br/><code>define(\'AUTOPTIMIZE_CRITICALCSS_API_KEY\', \'eyJhbGmorestringsherexHa7MkOQFtDFkZgLmBLe-LpcHx4\');</code>' );
302 ?>
303 </li>
304 </ul>
305 <?php
306 } else {
307 if ( 'valid' == $key['status'] ) {
308 // If key status is valid, render other panels.
309 // Render rules section.
310 ao_ccss_render_rules();
311 // Render queue section.
312 ao_ccss_render_queue();
313 // Render advanced panel.
314 ao_ccss_render_adv();
315 } else {
316 if ( apply_filters( 'autoptimize_filter_ccss_rules_without_api', true ) ) {
317 // Render rules section for manual rules.
318 ao_ccss_render_rules();
319 } else {
320 echo "<input class='hidden' name='autoptimize_ccss_queue' value='" . json_encode( $ao_ccss_rules, JSON_FORCE_OBJECT ) . "'>";
321 }
322
323 // But if key is other than valid, add hidden fields to persist settings when submitting form
324 // Show explanation of why and how to get a API key.
325 ao_ccss_render_explain();
326
327 // Get viewport size.
328 $viewport = $this->criticalcss->viewport();
329
330 // Add hidden fields.
331 echo "<input class='hidden' name='autoptimize_ccss_queue' value='" . json_encode( $ao_ccss_queue, JSON_FORCE_OBJECT ) . "'>";
332 echo '<input class="hidden" name="autoptimize_ccss_viewport[w]" value="' . esc_attr( $viewport['w'] ) . '">';
333 echo '<input class="hidden" name="autoptimize_ccss_viewport[h]" value="' . esc_attr( $viewport['h'] ) . '">';
334 echo '<input class="hidden" name="autoptimize_ccss_finclude" value="' . esc_attr( $ao_ccss_finclude ) . '">';
335 echo '<input class="hidden" name="autoptimize_ccss_rtimelimit" value="' . esc_attr( $ao_ccss_rtimelimit ) . '">';
336 echo '<input class="hidden" name="autoptimize_ccss_debug" value="' . esc_attr( $ao_ccss_debug ) . '">';
337 echo '<input class="hidden" name="autoptimize_ccss_noptimize" value="' . esc_attr( $ao_ccss_noptimize ) . '">';
338 echo '<input class="hidden" name="autoptimize_css_defer_inline" value="' . esc_attr( $ao_css_defer_inline ) . '">';
339 echo '<input class="hidden" name="autoptimize_ccss_loggedin" value="' . esc_attr( $ao_ccss_loggedin ). '">';
340 echo '<input class="hidden" name="autoptimize_ccss_forcepath" value="' . esc_attr( $ao_ccss_forcepath ) . '">';
341 }
342 // Render key panel unconditionally.
343 ao_ccss_render_key( $ao_ccss_key, $key['status'], $key['stmsg'], $key['msg'], $key['color'] );
344 ?>
345 <p class="submit left">
346 <input type="submit" class="button-primary" value="<?php _e( 'Save Changes', 'autoptimize' ); ?>" />
347 </p>
348 <?php
349 }
350 ?>
351 </form>
352 <script>
353 jQuery("form#settings").submit(function(){
354 var input = jQuery("#autoptimize_ccss_domain");
355 input.val(rot(input.val(), 13));
356 });
357 // rot JS from http://stackoverflow.com/a/617685/987044 .
358 function rot(domainstring, itype) {
359 return domainstring.toString().replace(/[a-zA-Z]/g, function (letter) {
360 return String.fromCharCode((letter <= 'Z' ? 90 : 122) >= (letter = letter.charCodeAt(0) + itype) ? letter : letter - 26);
361 });
362 }
363 </script>
364 <form id="importSettingsForm"<?php if ( $this->is_multisite_network_admin() ) { echo ' class="hidden"'; } ?>>
365 <span id="exportSettings" class="button-secondary"><?php _e( 'Export Settings', 'autoptimize' ); ?></span>
366 <input class="button-secondary" id="importSettings" type="button" value="<?php _e( 'Import Settings', 'autoptimize' ); ?>" onclick="upload();return false;" />
367 <input class="button-secondary" id="settingsfile" name="settingsfile" type="file" />
368 </form>
369 <div id="importdialog"></div>
370 </div><!-- /#autoptimize_main -->
371 </div><!-- /#wrap -->
372 <?php
373 if ( ! $this->is_multisite_network_admin() ) {
374 // Include debug panel if debug mode is enable.
375 if ( $ao_ccss_debug ) {
376 ?>
377 <div id="debug">
378 <?php
379 // Include debug panel.
380 include( 'critcss-inc/admin_settings_debug.php' );
381 ?>
382 </div><!-- /#debug -->
383 <?php
384 }
385 echo '<script>';
386 include( 'critcss-inc/admin_settings_rules.js.php' );
387 include( 'critcss-inc/admin_settings_queue.js.php' );
388 include( 'critcss-inc/admin_settings_impexp.js.php' );
389 echo '</script>';
390 }
391 }
392
393 public function ao_ccss_has_autorules() {
394 static $_has_auto_rules = null;
395
396 if ( null === $_has_auto_rules ) {
397 $ao_ccss_rules = $this->criticalcss->get_option( 'rules' );
398 $_has_auto_rules = false;
399 if ( ! empty( $ao_ccss_rules ) ) {
400 foreach ( array( 'types', 'paths' ) as $_typat ) {
401 foreach ( $ao_ccss_rules[ $_typat ] as $rule ) {
402 if ( ! empty( $rule['hash'] ) ) {
403 // we have at least one AUTO job, so all is fine.
404 $_has_auto_rules = true;
405 break;
406 }
407 }
408 if ( $_has_auto_rules ) {
409 break;
410 }
411 }
412 }
413 }
414
415 return $_has_auto_rules;
416 }
417
418 public function is_multisite_network_admin() {
419 static $_multisite_network_admin = null;
420
421 if ( null === $_multisite_network_admin ) {
422 if ( is_multisite() && is_network_admin() ) {
423 $_multisite_network_admin = true;
424 } else {
425 $_multisite_network_admin = false;
426 }
427 }
428
429 return $_multisite_network_admin;
430 }
431 }
432