<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* LiteSpeed Cache option Interface CLI.

[2] Fix | Delete

*

[3] Fix | Delete

* @package LiteSpeed\CLI

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace LiteSpeed\CLI;

[7] Fix | Delete

[8] Fix | Delete

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

[9] Fix | Delete

[10] Fix | Delete

use LiteSpeed\Base;

[11] Fix | Delete

use LiteSpeed\Admin_Settings;

[12] Fix | Delete

use LiteSpeed\Utility;

[13] Fix | Delete

use WP_CLI;

[14] Fix | Delete

use WP_Filesystem;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* LiteSpeed Cache option Interface

[18] Fix | Delete

*/

[19] Fix | Delete

class Option extends Base {

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Set an individual LiteSpeed Cache option.

[23] Fix | Delete

*

[24] Fix | Delete

* ## OPTIONS

[25] Fix | Delete

*

[26] Fix | Delete

* <key>

[27] Fix | Delete

* : The option key to update.

[28] Fix | Delete

*

[29] Fix | Delete

* <newvalue>

[30] Fix | Delete

* : The new value to set the option to.

[31] Fix | Delete

*

[32] Fix | Delete

* ## EXAMPLES

[33] Fix | Delete

*

[34] Fix | Delete

* # Set to not cache the login page

[35] Fix | Delete

* $ wp litespeed-option set cache-priv false

[36] Fix | Delete

* $ wp litespeed-option set 'cdn-mapping[url][0]' https://cdn.EXAMPLE.com

[37] Fix | Delete

* $ wp litespeed-option set media-lqip_exc $'line1\nline2'

[38] Fix | Delete

*

[39] Fix | Delete

* @param array $args Positional arguments (key, newvalue).

[40] Fix | Delete

* @param array $assoc_args Associative arguments.

[41] Fix | Delete

*/

[42] Fix | Delete

public function set( $args, $assoc_args ) {

[43] Fix | Delete

// Note: If the value is multiple dimensions like cdn-mapping, need to specially handle it both here and in `const.default.json`

[44] Fix | Delete

// For CDN/Crawler multi dimension settings, if all children are empty in one line, will delete that line. To delete one line, just set all to empty.

[45] Fix | Delete

// E.g. to delete cdn-mapping[0], need to run below:

[46] Fix | Delete

// `set cdn-mapping[url][0] ''`

[47] Fix | Delete

// `set cdn-mapping[inc_img][0] ''`

[48] Fix | Delete

// `set cdn-mapping[inc_css][0] ''`

[49] Fix | Delete

// `set cdn-mapping[inc_js][0] ''`

[50] Fix | Delete

// `set cdn-mapping[filetype][0] ''`

[51] Fix | Delete

[52] Fix | Delete

$key = $args[0];

[53] Fix | Delete

$val = $args[1];

[54] Fix | Delete

[55] Fix | Delete

// For CDN mapping, allow:

[56] Fix | Delete

// `set 'cdn-mapping[url][0]' https://the1st_cdn_url`

[57] Fix | Delete

// `set 'cdn-mapping[inc_img][0]' true`

[58] Fix | Delete

// `set 'cdn-mapping[inc_img][0]' 1`

[59] Fix | Delete

//

[60] Fix | Delete

// For Crawler cookies:

[61] Fix | Delete

// `set 'crawler-cookies[name][0]' my_currency`

[62] Fix | Delete

// `set 'crawler-cookies[vals][0]' "USD\nTWD"`

[63] Fix | Delete

//

[64] Fix | Delete

// For multi lines setting:

[65] Fix | Delete

// `set media-lqip_exc $'img1.jpg\nimg2.jpg'`

[66] Fix | Delete

[67] Fix | Delete

// Build raw data

[68] Fix | Delete

$raw_data = array(

[69] Fix | Delete

Admin_Settings::ENROLL => array( $key ),

[70] Fix | Delete

);

[71] Fix | Delete

[72] Fix | Delete

// Contains child set

[73] Fix | Delete

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

[74] Fix | Delete

parse_str( $key . '=' . $val, $key2 );

[75] Fix | Delete

$raw_data = array_merge( $raw_data, $key2 );

[76] Fix | Delete

} else {

[77] Fix | Delete

$raw_data[ $key ] = $val;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

$this->cls( 'Admin_Settings' )->save( $raw_data );

[81] Fix | Delete

WP_CLI::line( "$key:" );

[82] Fix | Delete

$this->get( $args, $assoc_args );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Get all plugin options.

[87] Fix | Delete

*

[88] Fix | Delete

* ## OPTIONS

[89] Fix | Delete

*

[90] Fix | Delete

* [--format=<format>]

[91] Fix | Delete

* : Output format (e.g., json).

[92] Fix | Delete

*

[93] Fix | Delete

* ## EXAMPLES

[94] Fix | Delete

*

[95] Fix | Delete

* # Get all options

[96] Fix | Delete

* $ wp litespeed-option all

[97] Fix | Delete

* $ wp litespeed-option all --json

[98] Fix | Delete

* $ wp litespeed-option all --format=json

[99] Fix | Delete

*

[100] Fix | Delete

* @param array $args Positional arguments.

[101] Fix | Delete

* @param array $assoc_args Associative arguments.

[102] Fix | Delete

*/

[103] Fix | Delete

public function all( $args, $assoc_args ) {

[104] Fix | Delete

$options = $this->get_options();

[105] Fix | Delete

[106] Fix | Delete

if ( ! empty( $assoc_args['format'] ) ) {

[107] Fix | Delete

WP_CLI::print_value( $options, $assoc_args );

[108] Fix | Delete

return;

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

$option_out = array();

[112] Fix | Delete

[113] Fix | Delete

$buf = WP_CLI::colorize( '%CThe list of options:%n' );

[114] Fix | Delete

WP_CLI::line( $buf );

[115] Fix | Delete

[116] Fix | Delete

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

[117] Fix | Delete

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

[118] Fix | Delete

foreach ( $v as $k2 => $v2 ) {

[119] Fix | Delete

// $k2 is numeric

[120] Fix | Delete

if ( is_array( $v2 ) ) {

[121] Fix | Delete

foreach ( $v2 as $k3 => $v3 ) {

[122] Fix | Delete

// $k3 is 'url/inc_img/name/vals'

[123] Fix | Delete

if ( is_array( $v3 ) ) {

[124] Fix | Delete

$option_out[] = array(

[125] Fix | Delete

'key' => '',

[126] Fix | Delete

'value' => '',

[127] Fix | Delete

);

[128] Fix | Delete

foreach ( $v3 as $k4 => $v4 ) {

[129] Fix | Delete

$option_out[] = array(

[130] Fix | Delete

'key' => 0 === $k4 ? "{$k}[$k3][$k2]" : '',

[131] Fix | Delete

'value' => $v4,

[132] Fix | Delete

);

[133] Fix | Delete

}

[134] Fix | Delete

$option_out[] = array(

[135] Fix | Delete

'key' => '',

[136] Fix | Delete

'value' => '',

[137] Fix | Delete

);

[138] Fix | Delete

} else {

[139] Fix | Delete

$option_out[] = array(

[140] Fix | Delete

'key' => "{$k}[$k3][$k2]",

[141] Fix | Delete

'value' => $v3,

[142] Fix | Delete

);

[143] Fix | Delete

}

[144] Fix | Delete

}

[145] Fix | Delete

}

[146] Fix | Delete

}

[147] Fix | Delete

continue;

[148] Fix | Delete

} elseif ( is_array( $v ) && $v ) {

[149] Fix | Delete

$option_out[] = array(

[150] Fix | Delete

'key' => '',

[151] Fix | Delete

'value' => '',

[152] Fix | Delete

);

[153] Fix | Delete

foreach ( $v as $k2 => $v2 ) {

[154] Fix | Delete

$option_out[] = array(

[155] Fix | Delete

'key' => 0 === $k2 ? $k : '',

[156] Fix | Delete

'value' => $v2,

[157] Fix | Delete

);

[158] Fix | Delete

}

[159] Fix | Delete

$option_out[] = array(

[160] Fix | Delete

'key' => '',

[161] Fix | Delete

'value' => '',

[162] Fix | Delete

);

[163] Fix | Delete

continue;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

if ( array_key_exists( $k, self::$_default_options ) && is_bool( self::$_default_options[ $k ] ) && ! $v ) {

[167] Fix | Delete

$v = 0;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

if ( '' === $v || array() === $v ) {

[171] Fix | Delete

$v = "''";

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

$option_out[] = array(

[175] Fix | Delete

'key' => $k,

[176] Fix | Delete

'value' => $v,

[177] Fix | Delete

);

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

WP_CLI\Utils\format_items( 'table', $option_out, array( 'key', 'value' ) );

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Get a specific plugin option.

[185] Fix | Delete

*

[186] Fix | Delete

* ## OPTIONS

[187] Fix | Delete

*

[188] Fix | Delete

* <id>

[189] Fix | Delete

* : The option ID to retrieve (e.g., cache-priv, cdn-mapping[url][0]).

[190] Fix | Delete

*

[191] Fix | Delete

* ## EXAMPLES

[192] Fix | Delete

*

[193] Fix | Delete

* # Get one option

[194] Fix | Delete

* $ wp litespeed-option get cache-priv

[195] Fix | Delete

* $ wp litespeed-option get 'cdn-mapping[url][0]'

[196] Fix | Delete

*

[197] Fix | Delete

* @param array $args Positional arguments (id).

[198] Fix | Delete

* @param array $assoc_args Associative arguments.

[199] Fix | Delete

*/

[200] Fix | Delete

public function get( $args, $assoc_args ) {

[201] Fix | Delete

$id = $args[0];

[202] Fix | Delete

[203] Fix | Delete

$child = false;

[204] Fix | Delete

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

[205] Fix | Delete

parse_str( $id, $id2 );

[206] Fix | Delete

Utility::compatibility();

[207] Fix | Delete

$id = array_key_first( $id2 );

[208] Fix | Delete

[209] Fix | Delete

$child = array_key_first( $id2[ $id ] ); // is `url`

[210] Fix | Delete

if ( ! $child ) {

[211] Fix | Delete

WP_CLI::error( 'Wrong child key' );

[212] Fix | Delete

return;

[213] Fix | Delete

}

[214] Fix | Delete

$numeric = array_key_first( $id2[ $id ][ $child ] ); // `0`

[215] Fix | Delete

if ( null === $numeric ) {

[216] Fix | Delete

WP_CLI::error( 'Wrong 2nd level numeric key' );

[217] Fix | Delete

return;

[218] Fix | Delete

}

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

if ( ! isset( self::$_default_options[ $id ] ) ) {

[222] Fix | Delete

WP_CLI::error( 'ID not exist [id] ' . $id );

[223] Fix | Delete

return;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

$v = $this->conf( $id );

[227] Fix | Delete

$default_v = self::$_default_options[ $id ];

[228] Fix | Delete

[229] Fix | Delete

// For CDN_mapping and crawler_cookies

[230] Fix | Delete

// Examples of option name:

[231] Fix | Delete

// cdn-mapping[url][0]

[232] Fix | Delete

// crawler-cookies[name][1]

[233] Fix | Delete

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

[234] Fix | Delete

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

[235] Fix | Delete

WP_CLI::error( 'Wrong child key' );

[236] Fix | Delete

return;

[237] Fix | Delete

}

[238] Fix | Delete

}

[239] Fix | Delete

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

[240] Fix | Delete

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

[241] Fix | Delete

WP_CLI::error( 'Wrong child key' );

[242] Fix | Delete

return;

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

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

[247] Fix | Delete

if ( ! empty( $v[ $numeric ][ $child ] ) ) {

[248] Fix | Delete

$v = $v[ $numeric ][ $child ];

[249] Fix | Delete

} elseif ( self::O_CDN_MAPPING === $id ) {

[250] Fix | Delete

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

[251] Fix | Delete

$v = 0;

[252] Fix | Delete

} else {

[253] Fix | Delete

$v = "''";

[254] Fix | Delete

}

[255] Fix | Delete

} else {

[256] Fix | Delete

$v = "''";

[257] Fix | Delete

}

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

if ( is_array( $v ) ) {

[261] Fix | Delete

$v = implode( PHP_EOL, $v );

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

if ( ! $v && self::O_CDN_MAPPING !== $id && self::O_CRAWLER_COOKIES !== $id ) {

[265] Fix | Delete

// empty array for CDN/crawler has been handled

[266] Fix | Delete

if ( is_bool( $default_v ) ) {

[267] Fix | Delete

$v = 0;

[268] Fix | Delete

} elseif ( ! is_array( $default_v ) ) {

[269] Fix | Delete

$v = "''";

[270] Fix | Delete

}

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

WP_CLI::line( $v );

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Export plugin options to a file.

[278] Fix | Delete

*

[279] Fix | Delete

* ## OPTIONS

[280] Fix | Delete

*

[281] Fix | Delete

* [--filename=<path>]

[282] Fix | Delete

* : The default path used is CURRENTDIR/lscache_wp_options_DATE-TIME.txt.

[283] Fix | Delete

* To select a different file, use this option.

[284] Fix | Delete

*

[285] Fix | Delete

* ## EXAMPLES

[286] Fix | Delete

*

[287] Fix | Delete

* # Export options to a file.

[288] Fix | Delete

* $ wp litespeed-option export

[289] Fix | Delete

*

[290] Fix | Delete

* @param array $args Positional arguments.

[291] Fix | Delete

* @param array $assoc_args Associative arguments.

[292] Fix | Delete

*/

[293] Fix | Delete

public function export( $args, $assoc_args ) {

[294] Fix | Delete

if ( isset( $assoc_args['filename'] ) ) {

[295] Fix | Delete

$file = $assoc_args['filename'];

[296] Fix | Delete

} else {

[297] Fix | Delete

$file = getcwd() . '/litespeed_options_' . gmdate( 'd_m_Y-His' ) . '.data';

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

global $wp_filesystem;

[301] Fix | Delete

if ( ! $wp_filesystem ) {

[302] Fix | Delete

require_once ABSPATH . '/wp-admin/includes/file.php';

[303] Fix | Delete

WP_Filesystem();

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

if ( ! $wp_filesystem->is_writable( dirname( $file ) ) ) {

[307] Fix | Delete

WP_CLI::error( 'Directory not writable.' );

[308] Fix | Delete

return;

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

$data = $this->cls( 'Import' )->export( true );

[312] Fix | Delete

[313] Fix | Delete

if ( false === $wp_filesystem->put_contents( $file, $data ) ) {

[314] Fix | Delete

WP_CLI::error( 'Failed to create file.' );

[315] Fix | Delete

return;

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

WP_CLI::success( 'Created file ' . $file );

[319] Fix | Delete

}

[320] Fix | Delete

[321] Fix | Delete

/**

[322] Fix | Delete

* Import plugin options from a file.

[323] Fix | Delete

*

[324] Fix | Delete

* The file must be formatted as such:

[325] Fix | Delete

* option_key=option_value

[326] Fix | Delete

* One per line.

[327] Fix | Delete

* A semicolon at the beginning of the line indicates a comment and will be skipped.

[328] Fix | Delete

*

[329] Fix | Delete

* ## OPTIONS

[330] Fix | Delete

*

[331] Fix | Delete

* <file>

[332] Fix | Delete

* : The file to import options from.

[333] Fix | Delete

*

[334] Fix | Delete

* ## EXAMPLES

[335] Fix | Delete

*

[336] Fix | Delete

* # Import options from CURRENTDIR/options.txt

[337] Fix | Delete

* $ wp litespeed-option import options.txt

[338] Fix | Delete

*

[339] Fix | Delete

* @param array $args Positional arguments (file).

[340] Fix | Delete

* @param array $assoc_args Associative arguments.

[341] Fix | Delete

*/

[342] Fix | Delete

public function import( $args, $assoc_args ) {

[343] Fix | Delete

$file = $args[0];

[344] Fix | Delete

[345] Fix | Delete

global $wp_filesystem;

[346] Fix | Delete

if ( ! $wp_filesystem ) {

[347] Fix | Delete

require_once ABSPATH . '/wp-admin/includes/file.php';

[348] Fix | Delete

WP_Filesystem();

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

if ( ! $wp_filesystem->exists( $file ) || ! $wp_filesystem->is_readable( $file ) ) {

[352] Fix | Delete

WP_CLI::error( 'File does not exist or is not readable.' );

[353] Fix | Delete

return;

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

$res = $this->cls( 'Import' )->import( $file );

[357] Fix | Delete

[358] Fix | Delete

if ( ! $res ) {

[359] Fix | Delete

WP_CLI::error( 'Failed to parse serialized data from file.' );

[360] Fix | Delete

return;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

WP_CLI::success( 'Options imported. [File] ' . $file );

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

/**

[367] Fix | Delete

* Import plugin options from a remote file.

[368] Fix | Delete

*

[369] Fix | Delete

* The file must be formatted as such:

[370] Fix | Delete

* option_key=option_value

[371] Fix | Delete

* One per line.

[372] Fix | Delete

* A semicolon at the beginning of the line indicates a comment and will be skipped.

[373] Fix | Delete

*

[374] Fix | Delete

* ## OPTIONS

[375] Fix | Delete

*

[376] Fix | Delete

* <url>

[377] Fix | Delete

* : The URL to import options from.

[378] Fix | Delete

*

[379] Fix | Delete

* ## EXAMPLES

[380] Fix | Delete

*

[381] Fix | Delete

* # Import options from https://domain.com/options.txt

[382] Fix | Delete

* $ wp litespeed-option import_remote https://domain.com/options.txt

[383] Fix | Delete

*

[384] Fix | Delete

* @param array $args Positional arguments (url).

[385] Fix | Delete

*/

[386] Fix | Delete

public function import_remote( $args ) {

[387] Fix | Delete

$file = $args[0];

[388] Fix | Delete

[389] Fix | Delete

$tmp_file = download_url( $file );

[390] Fix | Delete

[391] Fix | Delete

if ( is_wp_error( $tmp_file ) ) {

[392] Fix | Delete

WP_CLI::error( 'Failed to download file.' );

[393] Fix | Delete

return;

[394] Fix | Delete

}

[395] Fix | Delete

[396] Fix | Delete

$res = $this->cls( 'Import' )->import( $tmp_file );

[397] Fix | Delete

[398] Fix | Delete

if ( ! $res ) {

[399] Fix | Delete

WP_CLI::error( 'Failed to parse serialized data from file.' );

[400] Fix | Delete

return;

[401] Fix | Delete

}

[402] Fix | Delete

[403] Fix | Delete

WP_CLI::success( 'Options imported. [File] ' . $file );

[404] Fix | Delete

}

[405] Fix | Delete

[406] Fix | Delete

/**

[407] Fix | Delete

* Reset all options to default.

[408] Fix | Delete

*

[409] Fix | Delete

* ## EXAMPLES

[410] Fix | Delete

*

[411] Fix | Delete

* # Reset all options

[412] Fix | Delete

* $ wp litespeed-option reset

[413] Fix | Delete

*/

[414] Fix | Delete

public function reset() {

[415] Fix | Delete

$this->cls( 'Import' )->reset();

[416] Fix | Delete

}

[417] Fix | Delete

}

[418] Fix | Delete

[419] Fix | Delete