parent = $parent;
$this->has = $parent->has_sqlite();
$this->base = 'sqlite_object_cache_';
// Register plugin settings.
add_action( 'admin_init', array( $this, 'register_my_settings' ) );
// Add settings page to menu.
add_action( 'admin_menu', array( $this, 'add_menu_item' ) );
// Add settings link to plugins page.
add_filter(
'plugin_action_links_' . plugin_basename( $this->parent->file ),
array(
$this,
'add_settings_link',
)
);
// Configure placement of plugin settings page. See readme for implementation.
add_filter( $this->base . 'menu_settings', array( $this, 'configure_settings' ) );
// Load admin JS & CSS.
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_assets' ), 10, 1 );
}
/**
* Build settings fields
*
* @return array Fields to be displayed on settings page
*/
private function settings_fields() {
$fields = array(
array(
'id' => 'flush',
'label' => __( 'Flush now', 'sqlite-object-cache' ),
'description' => __( 'Check to flush the cache (delete all its entries) now.', 'sqlite-object-cache' ) . ' ' .
__( 'This briefly puts your site into maintenance mode.', 'sqlite-object-cache' ),
'type' => 'checkbox',
'default' => '',
'reset' => '',
),
array(
'id' => 'vacuum',
'label' => __( 'Vacuum now', 'sqlite-object-cache' ),
'description' => __( 'Check to vacuum (defragment) the cache now.', 'sqlite-object-cache' ) . ' ' .
__( 'This briefly puts your site into maintenance mode.', 'sqlite-object-cache' ),
'type' => 'checkbox',
'default' => '',
'reset' => '',
),
array(
'id' => 'target_size',
'label' => __( 'Cached data size', 'sqlite-object-cache' ),
'description' => __( 'MiB. When data in the cache grows larger than this, hourly cleanup removes the oldest entries.', 'sqlite-object-cache' ),
'type' => 'number',
'default' => 16,
'min' => 1,
'step' => 'any',
'cssclass' => 'narrow',
'placeholder' => __( 'MiB.', 'sqlite-object-cache' ),
),
array(
'id' => 'cleanup',
'label' => __( 'Clean up now', 'sqlite-object-cache' ),
'description' => __( 'Check to clean up the cache (delete old data) now.', 'sqlite-object-cache' ),
'type' => 'checkbox',
'default' => '',
'reset' => '',
),
array(
'id' => 'capture',
'label' => __( 'Measure performance', 'sqlite-object-cache' ),
'description' => __( 'Check to enable cache performance measurement. ', 'sqlite-object-cache' ),
'type' => 'checkbox',
'default' => '',
),
array(
'id' => 'samplerate',
'label' => __( 'Measure', 'sqlite-object-cache' ),
'description' => __( 'percent of requests, randomly sampled.', 'sqlite-object-cache' ),
'type' => 'number',
'default' => 1,
'max' => 100,
'min' => 0,
'step' => 'any',
'cssclass' => 'narrow',
'placeholder' => __( 'Sampling percentage.', 'sqlite-object-cache' ),
),
array(
'id' => 'retainmeasurements',
'label' => __( 'Retain measurements for', 'sqlite-object-cache' ),
'description' => __( 'hours.', 'sqlite-object-cache' ),
'type' => 'number',
'default' => 2,
'min' => 0.1,
'step' => 'any',
'cssclass' => 'narrow',
'placeholder' => __( 'Hours to retain.', 'sqlite-object-cache' ),
)
);
if ( $this->parent->apcu_extension_is_enabled() ) {
array_unshift( $fields, array(
'id' => 'use_apcu',
'label' => __( 'Use APCu', 'sqlite-object-cache' ),
'description' => __( 'Check to enable the use of php\'s APCu cache to improve performance.', 'sqlite-object-cache' ),
'type' => 'checkbox',
'default' => '',
) );
}
$settings['standard'] = array(
'title' => __( 'Settings', 'sqlite-object-cache' ),
'submit' => __( 'Save Settings', 'sqlite-object-cache' ),
'description' => '',
'render_section_header' => array( $this, 'settings_section_header' ),
'form_post_callback' => array( $this, 'validate_settings' ),
'fields' => $fields,
);
$settings['stats'] = array(
'title' => __( 'Statistics', 'sqlite-object-cache' ),
'submit' => __( 'Reset Statistics', 'sqlite-object-cache' ),
'render_section_header' => array( $this, 'stats_section_header' ),
'form_post_callback' => array( $this, 'validate_reset_stats' ),
);
return apply_filters( $this->parent->_token . '_settings_fields', $settings );
}
/**
* Validate the options presented to the Settings tab.
*
* This is an options update filter. It filters an option value following sanitization.
*
* @param mixed $option The sanitized option value.
* @param string $name The option name.
* @param string $original_value The original value passed to the function.
*
* @throws Exception Announce SQLite failure.
* @since 2.3.0
* @since 4.3.0 Added the `$original_value` parameter.
*
* @noinspection PhpUnusedParameterInspection
*/
public function validate_settings( $option, $name, $original_value ) {
if ( ! is_array( $option ) ) {
/* Weird. not an option array */
return $option;
}
global $wp_object_cache;
$former_value = get_option( $name, array() );
/* Opt in or opt out of the APCu. */
if ( $this->parent->apcu_extension_is_enabled() ) {
$apcu_choice = array_key_exists( 'use_apcu', $option ) && $option ['use_apcu'] === 'on';
$apcu_former = array_key_exists( 'use_apcu', $former_value ) && $former_value ['use_apcu'] === 'on';
if ( $apcu_choice !== $apcu_former ) {
if ( method_exists( $wp_object_cache, 'apcu_clear_cache' ) ) {
$wp_object_cache->apcu_clear_cache();
}
$this->update_wp_config_constant( 'WP_SQLITE_OBJECT_CACHE_APCU', $apcu_choice );
$option['use_apcu_updated'] = true;
}
$option['use_apcu'] = $apcu_choice ? 'on' : 'off';
}
if ( array_key_exists( 'flush', $option ) && $option ['flush'] === 'on' ) {
if ( method_exists( $wp_object_cache, 'flush' ) ) {
try {
$this->enter_maintenance_mode();
$wp_object_cache->flush( true );
} finally {
$this->exit_maintenance_mode();
}
} else {
wp_cache_flush();
}
unset ( $option['flush'] );
}
if ( array_key_exists( 'vacuum', $option ) && $option ['vacuum'] === 'on' ) {
if ( method_exists( $wp_object_cache, 'vacuum' ) ) {
try {
$this->enter_maintenance_mode();
$wp_object_cache->vacuum();
} finally {
$this->exit_maintenance_mode();
}
} else {
wp_cache_flush();
}
unset ( $option['vacuum'] );
}
if ( array_key_exists( 'cleanup', $option ) && $option ['cleanup'] === 'on' ) {
$this->parent->clean_job();
unset ( $option['cleanup'] );
}
$this->numeric_option( $option, 'target_size', 4 );
$this->numeric_option( $option, 'samplerate', 10 );
$this->numeric_option( $option, 'retainmeasurements', 2 );
if ( array_key_exists( 'capture', $option ) && $option['capture'] === 'on' ) {
$option['previouscapture'] = 0;
}
return $option;
}
/**
* Retrieve a numeric option, and set the default if it isn't present.
*
* @param array $option Option array value.
* @param string $name Name of the element in the option array.
* @param mixed $default Default value to use.
*
* @return float|int|mixed|string
*/
private function numeric_option( &$option, $name, $default ) {
$result = $default;
if ( array_key_exists( $name, $option ) && is_numeric( $option[ $name ] ) ) {
$result = $option[ $name ];
$result = $result ?: $default;
} else {
$option[ $name ] = $default;
}
return $result;
}
/**
* Filters an option value following sanitization.
*
* @param string $option The sanitized option value.
* @param string $name The option name.
* @param string $original_value The original value passed to the function.
*
* @throws Exception Announce SQLite failure.
* @since 2.3.0
* @since 4.3.0 Added the `$original_value` parameter.
*
* @noinspection PhpUnusedParameterInspection
*/
public function validate_reset_stats( $option, $name, $original_value ) {
global $wp_object_cache;
if ( method_exists( $wp_object_cache, 'sqlite_reset_statistics' ) ) {
$wp_object_cache->sqlite_reset_statistics();
}
/* for this post operation, we don't want to change any plugin options. */
return get_option( $name );
}
/**
* Add settings page to admin menu
*
* @return void
*/
public function add_menu_item() {
$args = $this->menu_settings();
// Do nothing if wrong location key is set.
if ( is_array( $args ) && isset( $args['location'] ) && function_exists( 'add_' . $args['location'] . '_page' ) ) {
switch ( $args['location'] ) {
case 'options':
case 'submenu':
$page =
add_submenu_page( $args['parent_slug'], $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
break;
case 'menu':
$page =
add_menu_page( $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'], $args['icon_url'], $args['position'] );
break;
default:
return;
}
add_action( 'admin_print_styles-' . $page, array( $this, 'settings_assets' ) );
}
}
/**
* Prepare default settings page arguments
*
* @return mixed|void
*/
private function menu_settings() {
$this->complain_if_sqlite3_unavailable();
return apply_filters(
$this->base . 'menu_settings',
array(
'location' => 'options', // Possible settings: options, menu, submenu.
'parent_slug' => 'options-general.php',
'page_title' => __( 'SQLite Persistent Object Cache', 'sqlite-object-cache' ),
'menu_title' => __( 'Object Cache', 'sqlite-object-cache' ),
'capability' => 'manage_options',
'menu_slug' => $this->parent->_token . '_settings',
'function' => array( $this, 'settings_page' ),
'icon_url' => '',
'position' => null,
)
);
}
/**
* Emit a message if SQLite3 is not available.
*
* @param bool $verbose False means emit a notice. True means emit a longer explanation.
*
* @return void
*/
private function complain_if_sqlite3_unavailable( $verbose = false ) {
if ( true !== $this->has ) {
if ( ! $verbose ) {
echo '';
echo esc_html( $this->has );
echo '
';
} else {
echo '';
echo '
' . esc_html__( 'Server configuration problem', 'sqlite-object-cache' ) . '
';
echo '
';
if ( ! class_exists( 'SQLite3' ) || ! extension_loaded( 'sqlite3' ) ) {
echo esc_html__( 'The SQLite Persistent Object Cache plugin requires php\'s SQLite3 extension.', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'That extension is not installed in your server, so the plugin cannot work.', 'sqlite-object-cache' ) . ' ';
}
$sqlite_version = $this->parent->sqlite_get_version();
if ( version_compare( $sqlite_version, $this->parent->minimum_sqlite_version ) < 0 ) {
echo esc_html( sprintf(
/* translators: 1 actual SQLite version. 2 required SQLite version) */
__( 'You cannot use the SQLite Object Cache plugin. Your server only offers SQLite3 version %1$s, but at least %2$s is required.', 'sqlite-object-cache' ),
$sqlite_version, $this->parent->minimum_sqlite_version ) );
}
echo '
' . esc_html( $this->settings[ $section['id'] ]['description'] ) . '
' . PHP_EOL;
}
}
/**
* Display support and rating links.
*
* @return void
*/
private function support_links() {
$supportUrl = "https://wordpress.org/support/plugin/sqlite-object-cache/";
$reviewUrl = "https://wordpress.org/support/plugin/sqlite-object-cache/reviews/";
echo '';
echo esc_html__( 'For support please', 'sqlite-object-cache' ) . ' ';
echo '' . esc_html__( 'click here', 'sqlite-object-cache' ) . '. ';
echo esc_html__( 'To rate this plugin please', 'sqlite-object-cache' ) . ' ';
echo '' . esc_html__( 'click here', 'sqlite-object-cache' ) . '. ';
echo esc_html__( 'Your feedback helps make it better, faster, and more useful', 'sqlite-object-cache' ) . '.';
echo '
';
}
private function apcu_admonition() {
echo '';
echo esc_html__( 'You can use WP-CLI to configure this plugin. Please type', 'sqlite-object-cache' ) . ' ';
echo 'wp help sqlite-object-cache ';
echo esc_html__( 'into your shell for details', 'sqlite-object-cache' ) . '.';
echo '
';
$option = get_option( $this->parent->_token . '_settings', array() );
$apcu_active = array_key_exists( 'use_apcu', $option ) && 'on' == $option['use_apcu'];
$apcu_enabled = $this->parent->apcu_extension_is_enabled();
if ( $apcu_enabled && ! $apcu_active ) {
echo '';
echo esc_html__( 'On your site you can use php\'s', 'sqlite-object-cache' ) . ' ';
echo '' . esc_html__( 'APCu User Cache', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'to improve the performance of this SQLite Object Cache. ', 'sqlite-object-cache' );
echo esc_html__( 'To enable APCu caching please check the "Use APCu" box.', 'sqlite-object-cache' ) . ' ';
echo '
';
}
if ( $apcu_enabled && $apcu_active ) {
echo '';
echo esc_html__( 'You are using php\'s', 'sqlite-object-cache' ) . ' ';
echo '' . esc_html__( 'APCu User Cache', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'to improve the performance of this SQLite Object Cache. ', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'To disable APCu caching please uncheck the "Use APCu" box.', 'sqlite-object-cache' ) . ' ';
echo '
';
}
if ( ! $apcu_enabled ) {
echo '';
echo esc_html__( 'This object cache performs better when used with php\'s', 'sqlite-object-cache' ) . ' ';
echo '' . esc_html__( 'APCu User Cache', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'extension. ', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'However, it is not available on your server.', 'sqlite-object-cache' ) . ' ';
echo esc_html__( 'It may be possible for you or your hosting service to install it.', 'sqlite-object-cache' ) . ' ';
echo '
';
}
}
/**
* Display versions.
*
* @return void
* @throws Exception Announce database failure.
*/
private function versions() {
global $wp_object_cache;
global $wp_version;
$igbinary = function_exists( 'igbinary_serialize' ) && function_exists( 'igbinary_unserialize' )
? phpversion( 'igbinary' )
: __( 'unavailable', 'sqlite-object-cache' );
$force_serialize = defined( 'WP_SQLITE_OBJECT_CACHE_SERIALIZE' ) && WP_SQLITE_OBJECT_CACHE_SERIALIZE;
$igbinary .= $force_serialize ? esc_html__( '(disabled by WP_SQLITE_OBJECT_CACHE_SERIALIZE)', 'sqlite-object-cache' ) : '';
$apcu_version = $this->parent->apcu_extension_is_enabled()
? phpversion( "apcu" )
: __( 'unavailable', 'sqlite-object-cache' );
if ( method_exists( $wp_object_cache, 'sqlite_get_version' ) ) {
echo '' . esc_html( sprintf(
/* translators: 1: version for sqlite 2: version for php 3: webserver version 4: version for plugin 5: igbinary 6:APCu 7:WordPress */
__( 'Versions: WordPress: %7$s SQLite: %1$s php: %2$s Server: %3$s Plugin: %4$s APCu: %6$s igbinary: %5$s.', 'sqlite-object-cache' ),
$wp_object_cache->sqlite_get_version(),
PHP_VERSION,
$_SERVER['SERVER_SOFTWARE'],
$this->parent->_version,
$igbinary,
$apcu_version,
$wp_version ) ) . '
';
}
}
/**
* Statistics tab section.
*
* @param array $section Array of section ids.
*
* @return void
* @throws Exception Announce Database Failure.
* @noinspection PhpUnusedParameterInspection
*/
public function stats_section_header( $section ) {
$this->support_links();
$this->versions();
$stats = new SQLite_Object_Cache_Statistics ( get_option( $this->parent->_token . '_settings', array() ) );
$stats->init();
$stats->render();
$stats->render_usage();
}
/**
* Load settings page content.
*
* @return void
*/
public function settings_page() {
/* get the tab chosen by the user ('standard' by default or 'stats') */
$tab = isset ( $_REQUEST['tab'] ) ? sanitize_key( $_REQUEST['tab'] ) : 'standard';
// Build page HTML.
echo '' . PHP_EOL;
echo '
' . esc_html__( 'SQLite Persistent Object Cache', 'sqlite-object-cache' ) . '
' . PHP_EOL;
$submit_caption = __( 'Save Settings', 'sqlite-object-cache' );
$this->complain_if_sqlite3_unavailable( true );
// Show page tabs.
if ( is_array( $this->settings ) && 1 < count( $this->settings ) ) {
echo '
' . PHP_EOL;
foreach ( $this->settings as $section => $data ) {
// Set tab class.
$class = 'nav-tab';
if ( $section === $tab ) {
$class .= ' nav-tab-active';
$submit_caption = $data['submit'];
}
// Set tab link.
$tab_link = add_query_arg( array( 'tab' => $section ) );
$tab_link = remove_query_arg( 'settings-updated', $tab_link );
// Output tab.
echo '' . esc_html( $data['title'] ) . '' . PHP_EOL;
}
echo '
' . PHP_EOL;
}
/** @noinspection HtmlUnknownTarget */
echo '