<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* The admin settings handler of the plugin.

[2] Fix | Delete

*

[3] Fix | Delete

* Handles saving and validating settings from the admin UI and network admin.

[4] Fix | Delete

*

[5] Fix | Delete

* @since 1.1.0

[6] Fix | Delete

* @package LiteSpeed

[7] Fix | Delete

*/

[8] Fix | Delete

[9] Fix | Delete

namespace LiteSpeed;

[10] Fix | Delete

[11] Fix | Delete

defined( 'WPINC' ) || exit();

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Class Admin_Settings

[15] Fix | Delete

*

[16] Fix | Delete

* Saves, sanitizes, and validates LiteSpeed Cache settings.

[17] Fix | Delete

*/

[18] Fix | Delete

class Admin_Settings extends Base {

[19] Fix | Delete

const LOG_TAG = '[Settings]';

[20] Fix | Delete

[21] Fix | Delete

const ENROLL = '_settings-enroll';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Save settings (single site).

[25] Fix | Delete

*

[26] Fix | Delete

* Accepts data from $_POST or WP-CLI.

[27] Fix | Delete

* Importers may call the Conf class directly.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 3.0

[30] Fix | Delete

*

[31] Fix | Delete

* @param array<string,mixed> $raw_data Raw data from request/CLI.

[32] Fix | Delete

* @return void

[33] Fix | Delete

*/

[34] Fix | Delete

public function save( $raw_data ) {

[35] Fix | Delete

self::debug( 'saving' );

[36] Fix | Delete

[37] Fix | Delete

if ( empty( $raw_data[ self::ENROLL ] ) ) {

[38] Fix | Delete

wp_die( esc_html__( 'No fields', 'litespeed-cache' ) );

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

$raw_data = Admin::cleanup_text( $raw_data );

[42] Fix | Delete

[43] Fix | Delete

// Convert data to config format.

[44] Fix | Delete

$the_matrix = [];

[45] Fix | Delete

foreach ( array_unique( $raw_data[ self::ENROLL ] ) as $id ) {

[46] Fix | Delete

$child = false;

[47] Fix | Delete

[48] Fix | Delete

// Drop array format.

[49] Fix | Delete

if ( false !== strpos( $id, '[' ) ) {

[50] Fix | Delete

if ( 0 === strpos( $id, self::O_CDN_MAPPING ) || 0 === strpos( $id, self::O_CRAWLER_COOKIES ) ) {

[51] Fix | Delete

// CDN child | Cookie Crawler settings.

[52] Fix | Delete

$child = substr( $id, strpos( $id, '[' ) + 1, strpos( $id, ']' ) - strpos( $id, '[' ) - 1 );

[53] Fix | Delete

// Drop ending []; Compatible with xx[0] way from CLI.

[54] Fix | Delete

$id = substr( $id, 0, strpos( $id, '[' ) );

[55] Fix | Delete

} else {

[56] Fix | Delete

// Drop ending [].

[57] Fix | Delete

$id = substr( $id, 0, strpos( $id, '[' ) );

[58] Fix | Delete

}

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

if ( ! array_key_exists( $id, self::$_default_options ) ) {

[62] Fix | Delete

continue;

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

// Validate $child.

[66] Fix | Delete

if ( self::O_CDN_MAPPING === $id ) {

[67] Fix | Delete

if ( ! in_array( $child, [ self::CDN_MAPPING_URL, self::CDN_MAPPING_INC_IMG, self::CDN_MAPPING_INC_CSS, self::CDN_MAPPING_INC_JS, self::CDN_MAPPING_FILETYPE ], true ) ) {

[68] Fix | Delete

continue;

[69] Fix | Delete

}

[70] Fix | Delete

}

[71] Fix | Delete

if ( self::O_CRAWLER_COOKIES === $id ) {

[72] Fix | Delete

if ( ! in_array( $child, [ self::CRWL_COOKIE_NAME, self::CRWL_COOKIE_VALS ], true ) ) {

[73] Fix | Delete

continue;

[74] Fix | Delete

}

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

// Pull value from request.

[78] Fix | Delete

if ( $child ) {

[79] Fix | Delete

// []=xxx or [0]=xxx

[80] Fix | Delete

$data = ! empty( $raw_data[ $id ][ $child ] ) ? $raw_data[ $id ][ $child ] : $this->type_casting(false, $id);

[81] Fix | Delete

} else {

[82] Fix | Delete

$data = ! empty( $raw_data[ $id ] ) ? $raw_data[ $id ] : $this->type_casting(false, $id);

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

// Sanitize/normalize complex fields.

[86] Fix | Delete

if ( self::O_CDN_MAPPING === $id || self::O_CRAWLER_COOKIES === $id ) {

[87] Fix | Delete

// Use existing queued data if available (only when $child != false).

[88] Fix | Delete

$data2 = array_key_exists( $id, $the_matrix )

[89] Fix | Delete

? $the_matrix[ $id ]

[90] Fix | Delete

: ( defined( 'WP_CLI' ) && WP_CLI ? $this->conf( $id ) : [] );

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

switch ( $id ) {

[94] Fix | Delete

// Don't allow Editor/admin to be used in crawler role simulator.

[95] Fix | Delete

case self::O_CRAWLER_ROLES:

[96] Fix | Delete

$data = Utility::sanitize_lines( $data );

[97] Fix | Delete

if ( $data ) {

[98] Fix | Delete

foreach ( $data as $k => $v ) {

[99] Fix | Delete

if ( user_can( $v, 'edit_posts' ) ) {

[100] Fix | Delete

/* translators: %s: user id in <code> tags */

[101] Fix | Delete

$msg = sprintf(

[102] Fix | Delete

esc_html__( 'The user with id %s has editor access, which is not allowed for the role simulator.', 'litespeed-cache' ),

[103] Fix | Delete

'<code>' . esc_html( $v ) . '</code>'

[104] Fix | Delete

);

[105] Fix | Delete

Admin_Display::error( $msg );

[106] Fix | Delete

unset( $data[ $k ] );

[107] Fix | Delete

}

[108] Fix | Delete

}

[109] Fix | Delete

}

[110] Fix | Delete

break;

[111] Fix | Delete

[112] Fix | Delete

case self::O_CDN_MAPPING:

[113] Fix | Delete

/**

[114] Fix | Delete

* CDN setting

[115] Fix | Delete

*

[116] Fix | Delete

* Raw data format:

[117] Fix | Delete

* cdn-mapping[url][] = 'xxx'

[118] Fix | Delete

* cdn-mapping[url][2] = 'xxx2'

[119] Fix | Delete

* cdn-mapping[inc_js][] = 1

[120] Fix | Delete

*

[121] Fix | Delete

* Final format:

[122] Fix | Delete

* cdn-mapping[0][url] = 'xxx'

[123] Fix | Delete

* cdn-mapping[2][url] = 'xxx2'

[124] Fix | Delete

*/

[125] Fix | Delete

if ( $data ) {

[126] Fix | Delete

foreach ( $data as $k => $v ) {

[127] Fix | Delete

if ( self::CDN_MAPPING_FILETYPE === $child ) {

[128] Fix | Delete

$v = Utility::sanitize_lines( $v );

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

if ( self::CDN_MAPPING_URL === $child ) {

[132] Fix | Delete

// If not a valid URL, turn off CDN.

[133] Fix | Delete

if ( 0 !== strpos( $v, 'https://' ) ) {

[134] Fix | Delete

self::debug( '❌ CDN mapping set to OFF due to invalid URL' );

[135] Fix | Delete

$the_matrix[ self::O_CDN ] = false;

[136] Fix | Delete

}

[137] Fix | Delete

$v = trailingslashit( $v );

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

if ( in_array( $child, [ self::CDN_MAPPING_INC_IMG, self::CDN_MAPPING_INC_CSS, self::CDN_MAPPING_INC_JS ], true ) ) {

[141] Fix | Delete

// Because these can't be auto detected in `config->update()`, need to format here.

[142] Fix | Delete

$v = 'false' === $v ? 0 : (bool) $v;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

if ( empty( $data2[ $k ] ) ) {

[146] Fix | Delete

$data2[ $k ] = [];

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

$data2[ $k ][ $child ] = $v;

[150] Fix | Delete

}

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

$data = $data2;

[154] Fix | Delete

break;

[155] Fix | Delete

[156] Fix | Delete

case self::O_CRAWLER_COOKIES:

[157] Fix | Delete

/**

[158] Fix | Delete

* Cookie Crawler setting

[159] Fix | Delete

* Raw Format:

[160] Fix | Delete

* crawler-cookies[name][] = xxx

[161] Fix | Delete

* crawler-cookies[name][2] = xxx2

[162] Fix | Delete

* crawler-cookies[vals][] = xxx

[163] Fix | Delete

*

[164] Fix | Delete

* Final format:

[165] Fix | Delete

* crawler-cookie[0][name] = 'xxx'

[166] Fix | Delete

* crawler-cookie[0][vals] = 'xxx'

[167] Fix | Delete

* crawler-cookie[2][name] = 'xxx2'

[168] Fix | Delete

*

[169] Fix | Delete

* Empty line for `vals` uses literal `_null`.

[170] Fix | Delete

*/

[171] Fix | Delete

if ( $data ) {

[172] Fix | Delete

foreach ( $data as $k => $v ) {

[173] Fix | Delete

if ( self::CRWL_COOKIE_VALS === $child ) {

[174] Fix | Delete

$v = Utility::sanitize_lines( $v );

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

if ( empty( $data2[ $k ] ) ) {

[178] Fix | Delete

$data2[ $k ] = [];

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

$data2[ $k ][ $child ] = $v;

[182] Fix | Delete

}

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

$data = $data2;

[186] Fix | Delete

break;

[187] Fix | Delete

[188] Fix | Delete

// Cache exclude category.

[189] Fix | Delete

case self::O_CACHE_EXC_CAT:

[190] Fix | Delete

$data2 = [];

[191] Fix | Delete

$data = Utility::sanitize_lines( $data );

[192] Fix | Delete

foreach ( $data as $v ) {

[193] Fix | Delete

$cat_id = get_cat_ID( $v );

[194] Fix | Delete

if ( ! $cat_id ) {

[195] Fix | Delete

continue;

[196] Fix | Delete

}

[197] Fix | Delete

$data2[] = $cat_id;

[198] Fix | Delete

}

[199] Fix | Delete

$data = $data2;

[200] Fix | Delete

break;

[201] Fix | Delete

[202] Fix | Delete

// Cache exclude tag.

[203] Fix | Delete

case self::O_CACHE_EXC_TAG:

[204] Fix | Delete

$data2 = [];

[205] Fix | Delete

$data = Utility::sanitize_lines( $data );

[206] Fix | Delete

foreach ( $data as $v ) {

[207] Fix | Delete

$term = get_term_by( 'name', $v, 'post_tag' );

[208] Fix | Delete

if ( ! $term ) {

[209] Fix | Delete

// Could surface an admin error here if desired.

[210] Fix | Delete

continue;

[211] Fix | Delete

}

[212] Fix | Delete

$data2[] = $term->term_id;

[213] Fix | Delete

}

[214] Fix | Delete

$data = $data2;

[215] Fix | Delete

break;

[216] Fix | Delete

[217] Fix | Delete

case self::O_IMG_OPTM_SIZES_SKIPPED: // Skip image sizes

[218] Fix | Delete

$image_sizes = Utility::prepare_image_sizes_array();

[219] Fix | Delete

$saved_sizes = isset( $raw_data[$id] ) ? $raw_data[$id] : [];

[220] Fix | Delete

$data = array_diff( $image_sizes, $saved_sizes );

[221] Fix | Delete

break;

[222] Fix | Delete

[223] Fix | Delete

default:

[224] Fix | Delete

break;

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

$the_matrix[ $id ] = $data;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

// Special handler for CDN/Crawler 2d list to drop empty rows.

[231] Fix | Delete

foreach ( $the_matrix as $id => $data ) {

[232] Fix | Delete

/**

[233] Fix | Delete

* Format:

[234] Fix | Delete

* cdn-mapping[0][url] = 'xxx'

[235] Fix | Delete

* cdn-mapping[2][url] = 'xxx2'

[236] Fix | Delete

* crawler-cookie[0][name] = 'xxx'

[237] Fix | Delete

* crawler-cookie[0][vals] = 'xxx'

[238] Fix | Delete

* crawler-cookie[2][name] = 'xxx2'

[239] Fix | Delete

*/

[240] Fix | Delete

if ( self::O_CDN_MAPPING === $id || self::O_CRAWLER_COOKIES === $id ) {

[241] Fix | Delete

// Drop row if all children are empty.

[242] Fix | Delete

foreach ( $data as $k => $v ) {

[243] Fix | Delete

foreach ( $v as $v2 ) {

[244] Fix | Delete

if ( $v2 ) {

[245] Fix | Delete

continue 2;

[246] Fix | Delete

}

[247] Fix | Delete

}

[248] Fix | Delete

// All empty.

[249] Fix | Delete

unset( $the_matrix[ $id ][ $k ] );

[250] Fix | Delete

}

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

// Don't allow repeated cookie names.

[254] Fix | Delete

if ( self::O_CRAWLER_COOKIES === $id ) {

[255] Fix | Delete

$existed = [];

[256] Fix | Delete

foreach ( $the_matrix[ $id ] as $k => $v ) {

[257] Fix | Delete

if ( empty( $v[ self::CRWL_COOKIE_NAME ] ) || in_array( $v[ self::CRWL_COOKIE_NAME ], $existed, true ) ) {

[258] Fix | Delete

// Filter repeated or empty name.

[259] Fix | Delete

unset( $the_matrix[ $id ][ $k ] );

[260] Fix | Delete

continue;

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$existed[] = $v[ self::CRWL_COOKIE_NAME ];

[264] Fix | Delete

}

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

// tmp fix the 3rd part woo update hook issue when enabling vary cookie.

[268] Fix | Delete

if ( 'wc_cart_vary' === $id ) {

[269] Fix | Delete

if ( $data ) {

[270] Fix | Delete

add_filter(

[271] Fix | Delete

'litespeed_vary_cookies',

[272] Fix | Delete

function ( $arr ) {

[273] Fix | Delete

$arr[] = 'woocommerce_cart_hash';

[274] Fix | Delete

return array_unique( $arr );

[275] Fix | Delete

}

[276] Fix | Delete

);

[277] Fix | Delete

} else {

[278] Fix | Delete

add_filter(

[279] Fix | Delete

'litespeed_vary_cookies',

[280] Fix | Delete

function ( $arr ) {

[281] Fix | Delete

$key = array_search( 'woocommerce_cart_hash', $arr, true );

[282] Fix | Delete

if ( false !== $key ) {

[283] Fix | Delete

unset( $arr[ $key ] );

[284] Fix | Delete

}

[285] Fix | Delete

return array_unique( $arr );

[286] Fix | Delete

}

[287] Fix | Delete

);

[288] Fix | Delete

}

[289] Fix | Delete

}

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

// id validation will be inside.

[293] Fix | Delete

$this->cls( 'Conf' )->update_confs( $the_matrix );

[294] Fix | Delete

[295] Fix | Delete

$msg = __( 'Options saved.', 'litespeed-cache' );

[296] Fix | Delete

Admin_Display::success( $msg );

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

/**

[300] Fix | Delete

* Parses any changes made by the network admin on the network settings.

[301] Fix | Delete

*

[302] Fix | Delete

* @since 3.0

[303] Fix | Delete

*

[304] Fix | Delete

* @param array<string,mixed> $raw_data Raw data from request/CLI.

[305] Fix | Delete

* @return void

[306] Fix | Delete

*/

[307] Fix | Delete

public function network_save( $raw_data ) {

[308] Fix | Delete

self::debug( 'network saving' );

[309] Fix | Delete

[310] Fix | Delete

if ( empty( $raw_data[ self::ENROLL ] ) ) {

[311] Fix | Delete

wp_die( esc_html__( 'No fields', 'litespeed-cache' ) );

[312] Fix | Delete

}

[313] Fix | Delete

[314] Fix | Delete

$raw_data = Admin::cleanup_text( $raw_data );

[315] Fix | Delete

[316] Fix | Delete

foreach ( array_unique( $raw_data[ self::ENROLL ] ) as $id ) {

[317] Fix | Delete

// Append current field to setting save.

[318] Fix | Delete

if ( ! array_key_exists( $id, self::$_default_site_options ) ) {

[319] Fix | Delete

continue;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

$data = ! empty( $raw_data[ $id ] ) ? $raw_data[ $id ] : false;

[323] Fix | Delete

[324] Fix | Delete

// id validation will be inside.

[325] Fix | Delete

$this->cls( 'Conf' )->network_update( $id, $data );

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

// Update related files.

[329] Fix | Delete

Activation::cls()->update_files();

[330] Fix | Delete

[331] Fix | Delete

$msg = __( 'Options saved.', 'litespeed-cache' );

[332] Fix | Delete

Admin_Display::success( $msg );

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

/**

[336] Fix | Delete

* Hooked to the wp_redirect filter when saving widgets fails validation.

[337] Fix | Delete

*

[338] Fix | Delete

* @since 1.1.3

[339] Fix | Delete

*

[340] Fix | Delete

* @param string $location The redirect location.

[341] Fix | Delete

* @return string Updated location string.

[342] Fix | Delete

*/

[343] Fix | Delete

public static function widget_save_err( $location ) {

[344] Fix | Delete

return str_replace( '?message=0', '?error=0', $location );

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

/**

[348] Fix | Delete

* Validate the LiteSpeed Cache settings on widget save.

[349] Fix | Delete

*

[350] Fix | Delete

* @since 1.1.3

[351] Fix | Delete

*

[352] Fix | Delete

* @param array $instance The new settings.

[353] Fix | Delete

* @param array $new_instance The raw submitted settings.

[354] Fix | Delete

* @param array $old_instance The original settings.

[355] Fix | Delete

* @param \WP_Widget $widget The widget instance.

[356] Fix | Delete

* @return array|false Updated settings on success, false on error.

[357] Fix | Delete

*/

[358] Fix | Delete

public static function validate_widget_save( $instance, $new_instance, $old_instance, $widget ) {

[359] Fix | Delete

if ( empty( $new_instance ) ) {

[360] Fix | Delete

return $instance;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

if ( ! isset( $new_instance[ ESI::WIDGET_O_ESIENABLE ], $new_instance[ ESI::WIDGET_O_TTL ] ) ) {

[364] Fix | Delete

return $instance;

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

$esi = (int) $new_instance[ ESI::WIDGET_O_ESIENABLE ] % 3;

[368] Fix | Delete

$ttl = (int) $new_instance[ ESI::WIDGET_O_TTL ];

[369] Fix | Delete

[370] Fix | Delete

if ( 0 !== $ttl && $ttl < 30 ) {

[371] Fix | Delete

add_filter( 'wp_redirect', __CLASS__ . '::widget_save_err' );

[372] Fix | Delete

return false; // Invalid ttl.

[373] Fix | Delete

}

[374] Fix | Delete

[375] Fix | Delete

if ( empty( $instance[ Conf::OPTION_NAME ] ) ) {

[376] Fix | Delete

// @todo to be removed.

[377] Fix | Delete

$instance[ Conf::OPTION_NAME ] = [];

[378] Fix | Delete

}

[379] Fix | Delete

$instance[ Conf::OPTION_NAME ][ ESI::WIDGET_O_ESIENABLE ] = $esi;

[380] Fix | Delete

$instance[ Conf::OPTION_NAME ][ ESI::WIDGET_O_TTL ] = $ttl;

[381] Fix | Delete

[382] Fix | Delete

$current = ! empty( $old_instance[ Conf::OPTION_NAME ] ) ? $old_instance[ Conf::OPTION_NAME ] : false;

[383] Fix | Delete

[384] Fix | Delete

// Avoid unsanitized superglobal usage.

[385] Fix | Delete

$referrer = isset( $_SERVER['HTTP_REFERER'] ) ? esc_url_raw( wp_unslash( $_SERVER['HTTP_REFERER'] ) ) : '';

[386] Fix | Delete

[387] Fix | Delete

// Only purge when not in the Customizer.

[388] Fix | Delete

if ( false === strpos( $referrer, '/wp-admin/customize.php' ) ) {

[389] Fix | Delete

if ( ! $current || $esi !== (int) $current[ ESI::WIDGET_O_ESIENABLE ] ) {

[390] Fix | Delete

Purge::purge_all( 'Widget ESI_enable changed' );

[391] Fix | Delete

} elseif ( 0 !== $ttl && $ttl !== (int) $current[ ESI::WIDGET_O_TTL ] ) {

[392] Fix | Delete

Purge::add( Tag::TYPE_WIDGET . $widget->id );

[393] Fix | Delete

}

[394] Fix | Delete

[395] Fix | Delete

Purge::purge_all( 'Widget saved' );

[396] Fix | Delete

}

[397] Fix | Delete

[398] Fix | Delete

return $instance;

[399] Fix | Delete

}

[400] Fix | Delete

}

[401] Fix | Delete

[402] Fix | Delete