config_writer = $config_writer; $this->include_checker = $include_checker instanceof Include_Checker ? $include_checker : new Include_Checker( $config_writer ); $this->brotli_checker = $brotli_checker instanceof Brotli_Checker ? $brotli_checker : new Brotli_Checker( $config_writer ); } /** @return void */ public function init() { add_action( 'admin_menu', array( $this, 'add_menu_page' ) ); add_action( 'admin_init', array( $this, 'register_settings' ) ); add_action( 'admin_post_getpagespeed_cache_configuration_regenerate', array( $this, 'handle_regenerate' ) ); add_action( 'admin_post_getpagespeed_cache_configuration_check', array( $this, 'handle_check' ) ); add_action( 'admin_notices', array( $this, 'admin_notices' ) ); } /** @return void */ public function add_menu_page() { add_options_page( esc_html__( 'GetPageSpeed Cache Configuration', 'getpagespeed-cache-configuration' ), esc_html__( 'GetPageSpeed Cache Configuration', 'getpagespeed-cache-configuration' ), 'manage_options', 'getpagespeed-cache-configuration', array( $this, 'render_page' ) ); } /** @return void */ public function register_settings() { register_setting( 'getpagespeed_cache_configuration_settings', Settings_Reader::OPTION_NAME, array( 'type' => 'object', 'sanitize_callback' => array( $this, 'sanitize_settings' ), 'default' => array( 'debug' => false ), ) ); } /** * Sanitize the intentionally small settings surface. * * @param mixed $input Submitted settings. * @return array */ public function sanitize_settings( $input ) { $input = is_array( $input ) ? $input : array(); return array( 'debug' => ! empty( $input['debug'] ) ); } /** @return void */ public function render_page() { if ( ! current_user_can( 'manage_options' ) ) { return; } $settings = get_option( Settings_Reader::OPTION_NAME, array() ); $debug = ! empty( $settings['debug'] ); $config_exists = $this->config_writer->config_exists(); $output_file = $this->config_writer->get_output_file(); $last_generated = $this->config_writer->get_last_generated(); $integrations = $this->config_writer->get_integrations(); $integration = $integrations->get_active(); $brotli = ( new Settings_Reader() )->get_brotli_status(); $link_tags = array( 'a' => array( 'href' => array(), 'target' => array(), 'rel' => array(), ), ); ?>

get_label() ); ?> get_detected() ? esc_html__( '(detected)', 'getpagespeed-cache-configuration' ) : esc_html__( '(not detected, used by default)', 'getpagespeed-cache-configuration' ); ?>

get_brotli_summary( $brotli ) ); ?> Brotli module for Nginx is available from the GetPageSpeed repository, a subscription service with a free 30-day trial.', 'getpagespeed-cache-configuration' ), $link_tags ), esc_url( self::BROTLI_URL ) ); } ?>

include ;
nginx -t && systemctl reload nginx

GetPageSpeed Amplify charts its requests, errors and configuration issues over time, with a free tier.', 'getpagespeed-cache-configuration' ), $link_tags ), esc_url( self::AMPLIFY_URL ) ); ?>

config_writer->write(); $status = is_wp_error( $result ) ? 'error' : 'success'; $this->redirect_to_page( array( 'getpagespeed_cache_configuration_status' => $status ) ); } /** @return void */ public function handle_check() { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to check this configuration.', 'getpagespeed-cache-configuration' ) ); } check_admin_referer( 'getpagespeed_cache_configuration_check', 'getpagespeed_cache_configuration_nonce' ); // The Brotli result may rewrite the file, so it has to be known before the include is compared. $brotli = $this->brotli_checker->check(); $flags = array(); if ( $this->brotli_checker->remember( $brotli ) ) { $flags['getpagespeed_cache_configuration_brotli'] = 'changed'; } elseif ( Brotli_Checker::STATUS_UNKNOWN === $brotli ) { $flags['getpagespeed_cache_configuration_brotli'] = Brotli_Checker::STATUS_UNKNOWN; } $this->redirect_to_page( $flags + array( 'getpagespeed_cache_configuration_check' => $this->include_checker->check() ) ); } /** * Return to the settings page with display-only result flags. * * @param array $flags Query argument => result. * @return void */ private function redirect_to_page( $flags ) { wp_safe_redirect( add_query_arg( array( 'page' => 'getpagespeed-cache-configuration' ) + $flags, admin_url( 'options-general.php' ) ) ); exit; } /** * Return the settings-page sentence for a Brotli status. * * @param string $status One of the Brotli_Checker::STATUS_* constants. * @return string */ public function get_brotli_summary( $status ) { if ( Brotli_Checker::STATUS_ACTIVE === $status ) { return __( 'active. Nginx compresses pages with Brotli.', 'getpagespeed-cache-configuration' ); } if ( Brotli_Checker::STATUS_INACTIVE === $status ) { return __( 'not detected in the responses of this site.', 'getpagespeed-cache-configuration' ); } return __( 'not checked yet. Press "Check Nginx include" below.', 'getpagespeed-cache-configuration' ); } /** * Return the notice for an include-check result. * * @param string $status One of the Include_Checker::STATUS_* constants. * @return array|null Notice class and message, or null for an unknown status. */ public function get_check_notice( $status ) { $notices = array( Include_Checker::STATUS_ACTIVE => array( 'notice-success', __( 'Nginx is serving the current generated configuration.', 'getpagespeed-cache-configuration' ) ), Include_Checker::STATUS_STALE => array( 'notice-warning', __( 'Nginx includes the configuration but has not been reloaded since it was last generated. Run: nginx -t && systemctl reload nginx', 'getpagespeed-cache-configuration' ) ), Include_Checker::STATUS_MISSING => array( 'notice-error', __( 'Nginx did not answer the probe. The include line is probably missing from the server block of this site, or another server in front of Nginx answered instead.', 'getpagespeed-cache-configuration' ) ), Include_Checker::STATUS_UNREACHABLE => array( 'notice-warning', __( 'WordPress could not request its own site address, so the check is inconclusive.', 'getpagespeed-cache-configuration' ) ), Include_Checker::STATUS_NOT_GENERATED => array( 'notice-error', __( 'There is no generated configuration to check. Regenerate the configuration first.', 'getpagespeed-cache-configuration' ) ), ); return isset( $notices[ $status ] ) ? $notices[ $status ] : null; } /** @return void */ public function admin_notices() { $screen = get_current_screen(); if ( ! $screen || 'settings_page_getpagespeed-cache-configuration' !== $screen->id ) { return; } // Display-only status flag set by the nonce-checked regenerate handler's redirect. // phpcs:ignore WordPress.Security.NonceVerification.Recommended $status = isset( $_GET['getpagespeed_cache_configuration_status'] ) ? sanitize_key( wp_unslash( $_GET['getpagespeed_cache_configuration_status'] ) ) : ''; if ( 'success' === $status ) { echo '

' . esc_html__( 'Nginx configuration generated.', 'getpagespeed-cache-configuration' ) . '

'; } elseif ( 'error' === $status ) { echo '

' . esc_html( $this->config_writer->get_last_error() ) . '

'; } // Display-only result flags set by the nonce-checked check handler's redirect. // phpcs:ignore WordPress.Security.NonceVerification.Recommended $brotli = isset( $_GET['getpagespeed_cache_configuration_brotli'] ) ? sanitize_key( wp_unslash( $_GET['getpagespeed_cache_configuration_brotli'] ) ) : ''; if ( 'changed' === $brotli ) { echo '

' . esc_html__( 'The Brotli result changed which file clients that accept Brotli receive, so the configuration was regenerated.', 'getpagespeed-cache-configuration' ) . '

'; } elseif ( Brotli_Checker::STATUS_UNKNOWN === $brotli ) { echo '

' . esc_html__( 'WordPress could not request its own front page, so the Brotli check is inconclusive.', 'getpagespeed-cache-configuration' ) . '

'; } // phpcs:ignore WordPress.Security.NonceVerification.Recommended $check = isset( $_GET['getpagespeed_cache_configuration_check'] ) ? sanitize_key( wp_unslash( $_GET['getpagespeed_cache_configuration_check'] ) ) : ''; $notice = $this->get_check_notice( $check ); if ( $notice ) { echo '

' . esc_html( $notice[1] ) . '

'; } $legacy_file = $this->config_writer->get_legacy_output_file(); if ( $legacy_file !== $this->config_writer->get_output_file() && file_exists( $legacy_file ) ) { echo '

' . esc_html( sprintf( /* translators: 1: old configuration path, 2: new configuration path. */ __( 'The generated configuration moved. Replace %1$s with %2$s in the Nginx server block, reload Nginx, then delete the old file.', 'getpagespeed-cache-configuration' ), $legacy_file, $this->config_writer->get_output_file() ) ) . '

'; } $integrations = $this->config_writer->get_integrations(); if ( ! $integrations->get_detected() ) { echo '

' . esc_html__( 'No supported cache plugin is active (WP Rocket or WP Super Cache). The configuration can be generated, but there will be no cache files to serve.', 'getpagespeed-cache-configuration' ) . '

'; } foreach ( $integrations->get_active()->get_notices() as $message ) { echo '

' . esc_html( $message ) . '

'; } } }