* The core plugin config class.
* This maintains all the options and settings for this plugin.
defined('WPINC') || exit();
* Maintains all LiteSpeed plugin configuration, including CRUD for single-site
* and multisite options, upgrade flows, and side effects like purging/cron.
class Conf extends Base {
* IDs that were updated during a save cycle.
* @var array<string|int,mixed>
private $_updated_ids = [];
* Whether current blog is the network primary site.
private $_is_primary = false;
* Specify init logic to avoid infinite loop when calling conf.cls instance
// Check if conf exists or not. If not, create them in DB (won't change version if is converting v2.9- data)
// Conf may be stale, upgrade later
* Detect if has quic.cloud set
if ( $this->conf( self::O_CDN_QUIC ) ) {
if ( ! defined( 'LITESPEED_ALLOWED' ) ) {
define( 'LITESPEED_ALLOWED', true );
add_action( 'litespeed_conf_append', [ $this, 'option_append' ], 10, 2 );
add_action( 'litespeed_conf_force', [ $this, 'force_option' ], 10, 2 );
private function _conf_db_init() {
* Try to load options first, network sites can override this later
* NOTE: Load before run `conf_upgrade()` to avoid infinite loop when getting conf in `conf_upgrade()`
// Init debug as early as possible
if ( $this->conf( Base::O_DEBUG ) ) {
$this->cls( 'Debug2' )->init();
$ver = $this->conf( self::_VER );
* Version is less than v3.0, or, is a new installation
if ( ! defined( 'LSCWP_CUR_V' ) ) {
define( 'LSCWP_CUR_V', $ver );
if ( Core::VER !== $ver ) {
// Plugin version will be set inside
// Site plugin upgrade & version change will do in load_site_conf
$ver_check_tag = Data::cls()->conf_upgrade( $ver );
* Sync latest new options
if ( ! $ver || Core::VER !== $ver ) {
$this->load_default_vals();
$this->set_conf( self::$_default_options );
$ver_check_tag .= ' activate' . ( defined( 'LSCWP_REF' ) ? '_' . constant( 'LSCWP_REF' ) : '' );
// Init new default/missing options
foreach ( self::$_default_options as $k => $v ) {
// If the option existed, bypass updating
// Bcos we may ask clients to deactivate for debug temporarily, we need to keep the current cfg in deactivation, hence we need to only try adding default cfg when activating.
self::add_option( $k, $v );
// Force correct version in case a rare unexpected case that `_ver` exists but empty
self::update_option( Base::_VER, Core::VER );
Cloud::version_check( $ver_check_tag );
* Override conf if is network subsites and chose `Use Primary Config`
$this->_try_load_site_options();
// Init debug as early as possible
if ( $this->conf( Base::O_DEBUG ) ) {
$this->cls( 'Debug2' )->init();
if ( ! defined( 'LITESPEED_CONF_LOADED' ) ) {
define( 'LITESPEED_CONF_LOADED', true );
if ( ! $ver || Core::VER !== $ver ) {
// Only trigger once in upgrade progress, don't run always
$this->update_confs(); // Files only get corrected in activation or saving settings actions.
* Load all latest options from DB
* @param int|null $blog_id Blog ID to load from. Null for current.
* @param bool $dry_run Return options instead of setting them.
* @return array<string,mixed>|void
public function load_options( $blog_id = null, $dry_run = false ) {
foreach ( self::$_default_options as $k => $v ) {
if ( null !== $blog_id ) {
$options[ $k ] = self::get_blog_option( $blog_id, $k, $v );
$options[ $k ] = self::get_option( $k, $v );
$options[ $k ] = $this->type_casting( $options[ $k ], $k );
// Bypass site special settings
if ( null !== $blog_id ) {
// This is to load the primary settings ONLY
// These options are the ones that can be overwritten by primary
$options = array_diff_key( $options, array_flip( self::$single_site_options ) );
$this->set_primary_conf( $options );
$this->set_conf( $options );
if ( defined( 'LITESPEED_CONF' ) && LITESPEED_CONF ) {
foreach ( self::$_default_options as $k => $v ) {
$const = Base::conf_const( $k );
if ( defined( $const ) ) {
$this->set_const_conf( $k, $this->type_casting( constant( $const ), $k ) );
* For multisite installations, the single site options need to be updated with the network wide options.
private function _try_load_site_options() {
if ( ! $this->_if_need_site_options() ) {
$this->_conf_site_db_init();
$this->_is_primary = BLOG_ID_CURRENT_SITE === get_current_blog_id();
// If network set to use primary setting
if ( $this->network_conf( self::NETWORK_O_USE_PRIMARY ) && ! $this->_is_primary ) {
// subsites or network admin
// Get the primary site settings
// If it's just upgraded, 2nd blog is being visited before primary blog, can just load default config (won't hurt as this could only happen shortly)
$this->load_options( BLOG_ID_CURRENT_SITE );
// Overwrite single blog options with site options
foreach ( self::$_default_options as $k => $v ) {
if ( ! $this->has_network_conf( $k ) ) {
// $this->_options[ $k ] = $this->_network_options[ $k ];
// Special handler to `Enable Cache` option if the value is set to OFF
if ( self::O_CACHE === $k ) {
if ( $this->_is_primary ) {
if ( $this->conf( $k ) !== $this->network_conf( $k ) ) {
if ( self::VAL_ON2 !== $this->conf( $k ) ) {
} elseif ( $this->network_conf( self::NETWORK_O_USE_PRIMARY ) ) {
if ( $this->has_primary_conf( $k ) && self::VAL_ON2 !== $this->primary_conf( $k ) ) {
// This case will use primary_options override always
} elseif ( self::VAL_ON2 !== $this->conf( $k ) ) {
// primary_options will store primary settings + network settings, OR, store the network settings for subsites
$this->set_primary_conf( $k, $this->network_conf( $k ) );
// var_dump($this->_options);
* Check if needs to load site_options for network sites
private function _if_need_site_options() {
if ( ! is_multisite() ) {
// Check if needs to use site_options or not
// todo: check if site settings are separate bcos it will affect .htaccess
* In case this is called outside the admin page
* @see https://codex.wordpress.org/Function_Reference/is_plugin_active_for_network
if ( ! function_exists( 'is_plugin_active_for_network' ) ) {
require_once ABSPATH . '/wp-admin/includes/plugin.php';
// If is not activated on network, it will not have site options
if ( ! is_plugin_active_for_network( Core::PLUGIN_FILE ) ) {
if ( self::VAL_ON2 === (int) $this->conf( self::O_CACHE ) ) {
$this->set_conf( self::_CACHE, true );
* Init site conf and upgrade if necessary
private function _conf_site_db_init() {
$this->load_site_options();
$ver = $this->network_conf( self::_VER );
* Don't upgrade or run new installations other than from backend visit
* In this case, just use default conf
if ( ! $ver || Core::VER !== $ver ) {
if ( ! is_admin() && ! defined( 'LITESPEED_CLI' ) ) {
$this->set_network_conf( $this->load_default_site_vals() );
if ( $ver && Core::VER !== $ver ) {
// Site plugin version will change inside
Data::cls()->conf_site_upgrade( $ver );
if ( ! $ver || Core::VER !== $ver ) {
$this->load_default_site_vals();
// Init new default/missing options
foreach ( self::$_default_site_options as $k => $v ) {
// If the option existed, bypass updating
self::add_site_option( $k, $v );
* Get the plugin's site wide options.
* If the site wide options are not set yet, set it to default.
public function load_site_options() {
if ( ! is_multisite() ) {
foreach ( self::$_default_site_options as $k => $v ) {
$val = self::get_site_option( $k, $v );
$val = $this->type_casting( $val, $k, true );
$this->set_network_conf( $k, $val );
* Append a 3rd party option to default options
* This will not be affected by network use primary site setting.
* NOTE: If it is a multi switch option, need to call `_conf_multi_switch()` first
* @param string $name Option name.
* @param mixed $default_val Default value.
public function option_append( $name, $default_val ) {
self::$_default_options[ $name ] = $default_val;
$this->set_conf( $name, self::get_option( $name, $default_val ) );
$this->set_conf( $name, $this->type_casting( $this->conf( $name ), $name ) );
* Force an option to a certain value
* @param string $k Option key.
* @param mixed $v Option value.
public function force_option( $k, $v ) {
if ( ! $this->has_conf( $k ) ) {
$v = $this->type_casting( $v, $k );
if ( $this->conf( $k ) === $v ) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
Debug2::debug( '[Conf] ** ' . $k . ' forced from ' . var_export( $this->conf( $k ), true ) . ' to ' . var_export( $v, true ) );
$this->set_conf( $k, $v );
* Define `_CACHE` const in options ( for both single and network )
public function define_cache() {
// Init global const cache on setting
$this->set_conf( self::_CACHE, false );
if ( self::VAL_ON === (int) $this->conf( self::O_CACHE ) || $this->conf( self::O_CDN_QUIC ) ) {
$this->set_conf( self::_CACHE, true );
if ( ! $this->_if_need_site_options() ) {
$this->_define_cache_on();
// If use network setting
if ( self::VAL_ON2 === (int) $this->conf( self::O_CACHE ) && $this->network_conf( self::O_CACHE ) ) {
$this->set_conf( self::_CACHE, true );
$this->_define_cache_on();
private function _define_cache_on() {
if ( ! $this->conf( self::_CACHE ) ) {
if ( defined( 'LITESPEED_ALLOWED' ) && ! defined( 'LITESPEED_ON' ) ) {
define( 'LITESPEED_ON', true );
* @param array<string,mixed> $the_matrix Option-value map.
public function update_confs( $the_matrix = [] ) {
foreach ( $the_matrix as $id => $val ) {
$this->update( $id, $val );
if ( $this->_updated_ids ) {
foreach ( $this->_updated_ids as $id ) {
// Check if need to do a purge all or not
if ( $this->_conf_purge_all( $id ) ) {
Purge::purge_all( 'conf changed [id] ' . $id );
// Check if need to purge a tag
$tag = $this->_conf_purge_tag( $id );
if ( $this->_conf_cron( $id ) ) {
$this->cls( 'Task' )->try_clean( $id );
// Reset crawler bypassed list when any of the options WebP replace, guest mode, or cache mobile got changed
if ( self::O_IMG_OPTM_WEBP === $id || self::O_GUEST === $id || self::O_CACHE_MOBILE === $id ) {
$this->cls( 'Crawler' )->clear_disabled_list();