<?php

[0] Fix | Delete

declare( strict_types=1 );

[1] Fix | Delete

[2] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin\Logging;

[3] Fix | Delete

[4] Fix | Delete

use Automattic\Jetpack\Constants;

[5] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Logging\FileV2\File;

[6] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Logging\LogHandlerFileV2;

[7] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Logging\FileV2\FileController;

[8] Fix | Delete

use Automattic\WooCommerce\Internal\Utilities\FilesystemUtil;

[9] Fix | Delete

use Automattic\WooCommerce\Proxies\LegacyProxy;

[10] Fix | Delete

use Exception;

[11] Fix | Delete

use WC_Admin_Settings;

[12] Fix | Delete

use WC_Log_Handler_DB, WC_Log_Handler_File, WC_Log_Levels;

[13] Fix | Delete

use WP_Filesystem_Direct;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Settings class.

[17] Fix | Delete

*/

[18] Fix | Delete

class Settings {

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Default values for logging settings.

[22] Fix | Delete

*

[23] Fix | Delete

* @const array

[24] Fix | Delete

*/

[25] Fix | Delete

private const DEFAULTS = array(

[26] Fix | Delete

'logging_enabled' => true,

[27] Fix | Delete

'default_handler' => LogHandlerFileV2::class,

[28] Fix | Delete

'retention_period_days' => 30,

[29] Fix | Delete

'level_threshold' => 'none',

[30] Fix | Delete

);

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* The prefix for settings keys used in the options table.

[34] Fix | Delete

*

[35] Fix | Delete

* @const string

[36] Fix | Delete

*/

[37] Fix | Delete

private const PREFIX = 'woocommerce_logs_';

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Class Settings.

[41] Fix | Delete

*/

[42] Fix | Delete

public function __construct() {

[43] Fix | Delete

add_action( 'wc_logs_load_tab', array( $this, 'save_settings' ) );

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Get the directory for storing log files.

[48] Fix | Delete

*

[49] Fix | Delete

* The `wp_upload_dir` function takes into account the possibility of multisite, and handles changing

[50] Fix | Delete

* the directory if the context is switched to a different site in the network mid-request.

[51] Fix | Delete

*

[52] Fix | Delete

* @param bool $create_dir Optional. True to attempt to create the log directory if it doesn't exist. Default true.

[53] Fix | Delete

*

[54] Fix | Delete

* @return string The full directory path, with trailing slash.

[55] Fix | Delete

*/

[56] Fix | Delete

public static function get_log_directory( bool $create_dir = true ): string {

[57] Fix | Delete

if ( true === Constants::get_constant( 'WC_LOG_DIR_CUSTOM' ) ) {

[58] Fix | Delete

$dir = Constants::get_constant( 'WC_LOG_DIR' );

[59] Fix | Delete

} else {

[60] Fix | Delete

$upload_dir = wc_get_container()->get( LegacyProxy::class )->call_function( 'wp_upload_dir', null, $create_dir );

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Filter to change the directory for storing WooCommerce's log files.

[64] Fix | Delete

*

[65] Fix | Delete

* @param string $dir The full directory path, with trailing slash.

[66] Fix | Delete

*

[67] Fix | Delete

* @since 8.8.0

[68] Fix | Delete

*/

[69] Fix | Delete

$dir = apply_filters( 'woocommerce_log_directory', $upload_dir['basedir'] . '/wc-logs/' );

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

$dir = trailingslashit( $dir );

[73] Fix | Delete

[74] Fix | Delete

if ( true === $create_dir ) {

[75] Fix | Delete

$realpath = realpath( $dir );

[76] Fix | Delete

if ( false === $realpath ) {

[77] Fix | Delete

$result = wp_mkdir_p( $dir );

[78] Fix | Delete

[79] Fix | Delete

if ( true === $result ) {

[80] Fix | Delete

// Create infrastructure to prevent listing contents of the logs directory.

[81] Fix | Delete

try {

[82] Fix | Delete

$filesystem = FilesystemUtil::get_wp_filesystem();

[83] Fix | Delete

$filesystem->put_contents( $dir . '.htaccess', 'deny from all' );

[84] Fix | Delete

$filesystem->put_contents( $dir . 'index.html', '' );

[85] Fix | Delete

} catch ( Exception $exception ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch

[86] Fix | Delete

// Creation failed.

[87] Fix | Delete

}

[88] Fix | Delete

}

[89] Fix | Delete

}

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

return $dir;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* The definitions used by WC_Admin_Settings to render and save settings controls.

[97] Fix | Delete

*

[98] Fix | Delete

* @return array

[99] Fix | Delete

*/

[100] Fix | Delete

private function get_settings_definitions(): array {

[101] Fix | Delete

$settings = array(

[102] Fix | Delete

'start' => array(

[103] Fix | Delete

'title' => __( 'Logs settings', 'woocommerce' ),

[104] Fix | Delete

'id' => self::PREFIX . 'settings',

[105] Fix | Delete

'type' => 'title',

[106] Fix | Delete

),

[107] Fix | Delete

'logging_enabled' => array(

[108] Fix | Delete

'title' => __( 'Logger', 'woocommerce' ),

[109] Fix | Delete

'desc' => __( 'Enable logging', 'woocommerce' ),

[110] Fix | Delete

'id' => self::PREFIX . 'logging_enabled',

[111] Fix | Delete

'type' => 'checkbox',

[112] Fix | Delete

'value' => $this->logging_is_enabled() ? 'yes' : 'no',

[113] Fix | Delete

'default' => self::DEFAULTS['logging_enabled'] ? 'yes' : 'no',

[114] Fix | Delete

'autoload' => false,

[115] Fix | Delete

),

[116] Fix | Delete

'default_handler' => array(),

[117] Fix | Delete

'retention_period_days' => array(),

[118] Fix | Delete

'level_threshold' => array(),

[119] Fix | Delete

'end' => array(

[120] Fix | Delete

'id' => self::PREFIX . 'settings',

[121] Fix | Delete

'type' => 'sectionend',

[122] Fix | Delete

),

[123] Fix | Delete

);

[124] Fix | Delete

[125] Fix | Delete

if ( true === $this->logging_is_enabled() ) {

[126] Fix | Delete

$settings['default_handler'] = $this->get_default_handler_setting_definition();

[127] Fix | Delete

$settings['retention_period_days'] = $this->get_retention_period_days_setting_definition();

[128] Fix | Delete

$settings['level_threshold'] = $this->get_level_threshold_setting_definition();

[129] Fix | Delete

[130] Fix | Delete

$default_handler = $this->get_default_handler();

[131] Fix | Delete

if ( in_array( $default_handler, array( LogHandlerFileV2::class, WC_Log_Handler_File::class ), true ) ) {

[132] Fix | Delete

$settings += $this->get_filesystem_settings_definitions();

[133] Fix | Delete

} elseif ( WC_Log_Handler_DB::class === $default_handler ) {

[134] Fix | Delete

$settings += $this->get_database_settings_definitions();

[135] Fix | Delete

}

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

return $settings;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* The definition for the default_handler setting.

[143] Fix | Delete

*

[144] Fix | Delete

* @return array

[145] Fix | Delete

*/

[146] Fix | Delete

private function get_default_handler_setting_definition(): array {

[147] Fix | Delete

$handler_options = array(

[148] Fix | Delete

LogHandlerFileV2::class => __( 'File system (default)', 'woocommerce' ),

[149] Fix | Delete

WC_Log_Handler_DB::class => __( 'Database (not recommended on live sites)', 'woocommerce' ),

[150] Fix | Delete

);

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Filter the list of logging handlers that can be set as the default handler.

[154] Fix | Delete

*

[155] Fix | Delete

* @param array $handler_options An associative array of class_name => description.

[156] Fix | Delete

*

[157] Fix | Delete

* @since 8.6.0

[158] Fix | Delete

*/

[159] Fix | Delete

$handler_options = apply_filters( 'woocommerce_logger_handler_options', $handler_options );

[160] Fix | Delete

[161] Fix | Delete

$current_value = $this->get_default_handler();

[162] Fix | Delete

if ( ! array_key_exists( $current_value, $handler_options ) ) {

[163] Fix | Delete

$handler_options[ $current_value ] = $current_value;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

$desc = array();

[167] Fix | Delete

[168] Fix | Delete

$desc[] = __( 'Note that if this setting is changed, any log entries that have already been recorded will remain stored in their current location, but will not migrate.', 'woocommerce' );

[169] Fix | Delete

[170] Fix | Delete

$hardcoded = ! is_null( Constants::get_constant( 'WC_LOG_HANDLER' ) );

[171] Fix | Delete

if ( $hardcoded ) {

[172] Fix | Delete

$desc[] = sprintf(

[173] Fix | Delete

// translators: %s is the name of a code variable.

[174] Fix | Delete

__( 'This setting cannot be changed here because it is defined in the %s constant.', 'woocommerce' ),

[175] Fix | Delete

'<code>WC_LOG_HANDLER</code>'

[176] Fix | Delete

);

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

return array(

[180] Fix | Delete

'title' => __( 'Log storage', 'woocommerce' ),

[181] Fix | Delete

'desc_tip' => __( 'This determines where log entries are saved.', 'woocommerce' ),

[182] Fix | Delete

'id' => self::PREFIX . 'default_handler',

[183] Fix | Delete

'type' => 'radio',

[184] Fix | Delete

'value' => $current_value,

[185] Fix | Delete

'default' => self::DEFAULTS['default_handler'],

[186] Fix | Delete

'autoload' => false,

[187] Fix | Delete

'options' => $handler_options,

[188] Fix | Delete

'disabled' => $hardcoded ? array_keys( $handler_options ) : array(),

[189] Fix | Delete

'desc' => implode( '<br><br>', $desc ),

[190] Fix | Delete

'desc_at_end' => true,

[191] Fix | Delete

);

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

/**

[195] Fix | Delete

* The definition for the retention_period_days setting.

[196] Fix | Delete

*

[197] Fix | Delete

* @return array

[198] Fix | Delete

*/

[199] Fix | Delete

private function get_retention_period_days_setting_definition(): array {

[200] Fix | Delete

$custom_attributes = array(

[201] Fix | Delete

'min' => 1,

[202] Fix | Delete

'step' => 1,

[203] Fix | Delete

);

[204] Fix | Delete

[205] Fix | Delete

$desc = array();

[206] Fix | Delete

[207] Fix | Delete

$hardcoded = has_filter( 'woocommerce_logger_days_to_retain_logs' );

[208] Fix | Delete

if ( $hardcoded ) {

[209] Fix | Delete

$custom_attributes['disabled'] = 'true';

[210] Fix | Delete

[211] Fix | Delete

$desc[] = sprintf(

[212] Fix | Delete

// translators: %s is the name of a filter hook.

[213] Fix | Delete

__( 'This setting cannot be changed here because it is being set by a filter on the %s hook.', 'woocommerce' ),

[214] Fix | Delete

'<code>woocommerce_logger_days_to_retain_logs</code>'

[215] Fix | Delete

);

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

$file_delete_has_filter = LogHandlerFileV2::class === $this->get_default_handler() && has_filter( 'woocommerce_logger_delete_expired_file' );

[219] Fix | Delete

if ( $file_delete_has_filter ) {

[220] Fix | Delete

$desc[] = sprintf(

[221] Fix | Delete

// translators: %s is the name of a filter hook.

[222] Fix | Delete

__( 'The %s hook has a filter set, so some log files may have different retention settings.', 'woocommerce' ),

[223] Fix | Delete

'<code>woocommerce_logger_delete_expired_file</code>'

[224] Fix | Delete

);

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

return array(

[228] Fix | Delete

'title' => __( 'Retention period', 'woocommerce' ),

[229] Fix | Delete

'desc_tip' => __( 'This sets how many days log entries will be kept before being auto-deleted.', 'woocommerce' ),

[230] Fix | Delete

'id' => self::PREFIX . 'retention_period_days',

[231] Fix | Delete

'type' => 'number',

[232] Fix | Delete

'value' => $this->get_retention_period(),

[233] Fix | Delete

'default' => self::DEFAULTS['retention_period_days'],

[234] Fix | Delete

'autoload' => false,

[235] Fix | Delete

'custom_attributes' => $custom_attributes,

[236] Fix | Delete

'css' => 'width:70px;',

[237] Fix | Delete

'row_class' => 'logs-retention-period-days',

[238] Fix | Delete

'suffix' => sprintf(

[239] Fix | Delete

' %s',

[240] Fix | Delete

__( 'days', 'woocommerce' ),

[241] Fix | Delete

),

[242] Fix | Delete

'desc' => implode( '<br><br>', $desc ),

[243] Fix | Delete

);

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* The definition for the level_threshold setting.

[248] Fix | Delete

*

[249] Fix | Delete

* @return array

[250] Fix | Delete

*/

[251] Fix | Delete

private function get_level_threshold_setting_definition(): array {

[252] Fix | Delete

$hardcoded = ! is_null( Constants::get_constant( 'WC_LOG_THRESHOLD' ) );

[253] Fix | Delete

$desc = '';

[254] Fix | Delete

if ( $hardcoded ) {

[255] Fix | Delete

$desc = sprintf(

[256] Fix | Delete

// translators: %1$s is the name of a code variable. %2$s is the name of a file.

[257] Fix | Delete

__( 'This setting cannot be changed here because it is defined in the %1$s constant, probably in your %2$s file.', 'woocommerce' ),

[258] Fix | Delete

'<code>WC_LOG_THRESHOLD</code>',

[259] Fix | Delete

'<b>wp-config.php</b>'

[260] Fix | Delete

);

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$labels = WC_Log_Levels::get_all_level_labels();

[264] Fix | Delete

$labels['none'] = __( 'None', 'woocommerce' );

[265] Fix | Delete

[266] Fix | Delete

$custom_attributes = array();

[267] Fix | Delete

if ( $hardcoded ) {

[268] Fix | Delete

$custom_attributes['disabled'] = 'true';

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

return array(

[272] Fix | Delete

'title' => __( 'Level threshold', 'woocommerce' ),

[273] Fix | Delete

'desc_tip' => __( 'This sets the minimum severity level of logs that will be stored. Lower severity levels will be ignored. "None" means all logs will be stored.', 'woocommerce' ),

[274] Fix | Delete

'id' => self::PREFIX . 'level_threshold',

[275] Fix | Delete

'type' => 'select',

[276] Fix | Delete

'value' => $this->get_level_threshold(),

[277] Fix | Delete

'default' => self::DEFAULTS['level_threshold'],

[278] Fix | Delete

'autoload' => false,

[279] Fix | Delete

'options' => $labels,

[280] Fix | Delete

'custom_attributes' => $custom_attributes,

[281] Fix | Delete

'css' => 'width:auto;',

[282] Fix | Delete

'desc' => $desc,

[283] Fix | Delete

);

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* The definitions used by WC_Admin_Settings to render settings related to filesystem log handlers.

[288] Fix | Delete

*

[289] Fix | Delete

* @return array

[290] Fix | Delete

*/

[291] Fix | Delete

private function get_filesystem_settings_definitions(): array {

[292] Fix | Delete

$location_info = array();

[293] Fix | Delete

$directory = self::get_log_directory();

[294] Fix | Delete

[295] Fix | Delete

$status_info = array();

[296] Fix | Delete

try {

[297] Fix | Delete

$filesystem = FilesystemUtil::get_wp_filesystem();

[298] Fix | Delete

if ( $filesystem instanceof WP_Filesystem_Direct ) {

[299] Fix | Delete

$status_info[] = __( '✅ Ready', 'woocommerce' );

[300] Fix | Delete

} else {

[301] Fix | Delete

$status_info[] = __( '⚠️ The file system is not configured for direct writes. This could cause problems for the logger.', 'woocommerce' );

[302] Fix | Delete

$status_info[] = __( 'You may want to switch to the database for log storage.', 'woocommerce' );

[303] Fix | Delete

}

[304] Fix | Delete

} catch ( Exception $exception ) {

[305] Fix | Delete

$status_info[] = __( '⚠️ The file system connection could not be initialized.', 'woocommerce' );

[306] Fix | Delete

$status_info[] = __( 'You may want to switch to the database for log storage.', 'woocommerce' );

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

$location_info[] = sprintf(

[310] Fix | Delete

// translators: %s is a location in the filesystem.

[311] Fix | Delete

__( 'Log files are stored in this directory: %s', 'woocommerce' ),

[312] Fix | Delete

sprintf(

[313] Fix | Delete

'<code>%s</code>',

[314] Fix | Delete

esc_html( $directory )

[315] Fix | Delete

)

[316] Fix | Delete

);

[317] Fix | Delete

[318] Fix | Delete

if ( ! wp_is_writable( $directory ) ) {

[319] Fix | Delete

$location_info[] = __( '⚠️ This directory does not appear to be writable.', 'woocommerce' );

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

$location_info[] = sprintf(

[323] Fix | Delete

// translators: %s is an amount of computer disk space, e.g. 5 KB.

[324] Fix | Delete

__( 'Directory size: %s', 'woocommerce' ),

[325] Fix | Delete

size_format( wc_get_container()->get( FileController::class )->get_log_directory_size() )

[326] Fix | Delete

);

[327] Fix | Delete

[328] Fix | Delete

return array(

[329] Fix | Delete

'file_start' => array(

[330] Fix | Delete

'title' => __( 'File system settings', 'woocommerce' ),

[331] Fix | Delete

'id' => self::PREFIX . 'settings',

[332] Fix | Delete

'type' => 'title',

[333] Fix | Delete

),

[334] Fix | Delete

'file_status' => array(

[335] Fix | Delete

'title' => __( 'Status', 'woocommerce' ),

[336] Fix | Delete

'type' => 'info',

[337] Fix | Delete

'text' => implode( "\n\n", $status_info ),

[338] Fix | Delete

),

[339] Fix | Delete

'log_directory' => array(

[340] Fix | Delete

'title' => __( 'Location', 'woocommerce' ),

[341] Fix | Delete

'type' => 'info',

[342] Fix | Delete

'text' => implode( "\n\n", $location_info ),

[343] Fix | Delete

),

[344] Fix | Delete

'entry_format' => array(),

[345] Fix | Delete

'file_end' => array(

[346] Fix | Delete

'id' => self::PREFIX . 'settings',

[347] Fix | Delete

'type' => 'sectionend',

[348] Fix | Delete

),

[349] Fix | Delete

);

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

/**

[353] Fix | Delete

* The definitions used by WC_Admin_Settings to render settings related to database log handlers.

[354] Fix | Delete

*

[355] Fix | Delete

* @return array

[356] Fix | Delete

*/

[357] Fix | Delete

private function get_database_settings_definitions(): array {

[358] Fix | Delete

global $wpdb;

[359] Fix | Delete

$table = "{$wpdb->prefix}woocommerce_log";

[360] Fix | Delete

[361] Fix | Delete

$location_info = sprintf(

[362] Fix | Delete

// translators: %s is the name of a table in the database.

[363] Fix | Delete

__( 'Log entries are stored in this database table: %s', 'woocommerce' ),

[364] Fix | Delete

"<code>$table</code>"

[365] Fix | Delete

);

[366] Fix | Delete

[367] Fix | Delete

return array(

[368] Fix | Delete

'file_start' => array(

[369] Fix | Delete

'title' => __( 'Database settings', 'woocommerce' ),

[370] Fix | Delete

'id' => self::PREFIX . 'settings',

[371] Fix | Delete

'type' => 'title',

[372] Fix | Delete

),

[373] Fix | Delete

'database_table' => array(

[374] Fix | Delete

'title' => __( 'Location', 'woocommerce' ),

[375] Fix | Delete

'type' => 'info',

[376] Fix | Delete

'text' => $location_info,

[377] Fix | Delete

),

[378] Fix | Delete

'file_end' => array(

[379] Fix | Delete

'id' => self::PREFIX . 'settings',

[380] Fix | Delete

'type' => 'sectionend',

[381] Fix | Delete

),

[382] Fix | Delete

);

[383] Fix | Delete

}

[384] Fix | Delete

[385] Fix | Delete

/**

[386] Fix | Delete

* Handle the submission of the settings form and update the settings values.

[387] Fix | Delete

*

[388] Fix | Delete

* @param string $view The current view within the Logs tab.

[389] Fix | Delete

*

[390] Fix | Delete

* @return void

[391] Fix | Delete

*

[392] Fix | Delete

* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.

[393] Fix | Delete

*/

[394] Fix | Delete

public function save_settings( string $view ): void {

[395] Fix | Delete

$is_saving = 'settings' === $view && isset( $_POST['save_settings'] );

[396] Fix | Delete

[397] Fix | Delete

if ( $is_saving ) {

[398] Fix | Delete

check_admin_referer( self::PREFIX . 'settings' );

[399] Fix | Delete

[400] Fix | Delete

if ( ! current_user_can( 'manage_woocommerce' ) ) {

[401] Fix | Delete

wp_die( esc_html__( 'You do not have permission to manage logging settings.', 'woocommerce' ) );

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

$settings = $this->get_settings_definitions();

[405] Fix | Delete

[406] Fix | Delete

WC_Admin_Settings::save_fields( $settings );

[407] Fix | Delete

}

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

/**

[411] Fix | Delete

* Render the settings page.

[412] Fix | Delete

*

[413] Fix | Delete

* @return void

[414] Fix | Delete

*/

[415] Fix | Delete

public function render_form(): void {

[416] Fix | Delete

$settings = $this->get_settings_definitions();

[417] Fix | Delete

[418] Fix | Delete

?>

[419] Fix | Delete

<form id="mainform" class="wc-logs-settings" method="post">

[420] Fix | Delete

<?php WC_Admin_Settings::output_fields( $settings ); ?>

[421] Fix | Delete

<?php

[422] Fix | Delete

/**

[423] Fix | Delete

* Action fires after the built-in logging settings controls have been rendered.

[424] Fix | Delete

*

[425] Fix | Delete

* This is intended as a way to allow other logging settings controls to be added by extensions.

[426] Fix | Delete

*

[427] Fix | Delete

* @param bool $enabled True if logging is currently enabled.

[428] Fix | Delete

*

[429] Fix | Delete

* @since 8.6.0

[430] Fix | Delete

*/

[431] Fix | Delete

do_action( 'wc_logs_settings_form_fields', $this->logging_is_enabled() );

[432] Fix | Delete

?>

[433] Fix | Delete

<?php wp_nonce_field( self::PREFIX . 'settings' ); ?>

[434] Fix | Delete

<?php submit_button( __( 'Save changes', 'woocommerce' ), 'primary', 'save_settings' ); ?>

[435] Fix | Delete

</form>

[436] Fix | Delete

<?php

[437] Fix | Delete

}

[438] Fix | Delete

[439] Fix | Delete

/**

[440] Fix | Delete

* Determine the current value of the logging_enabled setting.

[441] Fix | Delete

*

[442] Fix | Delete

* @return bool

[443] Fix | Delete

*/

[444] Fix | Delete

public function logging_is_enabled(): bool {

[445] Fix | Delete

$key = self::PREFIX . 'logging_enabled';

[446] Fix | Delete

[447] Fix | Delete

$enabled = WC_Admin_Settings::get_option( $key, self::DEFAULTS['logging_enabled'] );

[448] Fix | Delete

$enabled = filter_var( $enabled, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );

[449] Fix | Delete

[450] Fix | Delete

if ( is_null( $enabled ) ) {

[451] Fix | Delete

$enabled = self::DEFAULTS['logging_enabled'];

[452] Fix | Delete

}

[453] Fix | Delete

[454] Fix | Delete

return $enabled;

[455] Fix | Delete

}

[456] Fix | Delete

[457] Fix | Delete

/**

[458] Fix | Delete

* Determine the current value of the default_handler setting.

[459] Fix | Delete

*

[460] Fix | Delete

* @return string

[461] Fix | Delete

*/

[462] Fix | Delete

public function get_default_handler(): string {

[463] Fix | Delete

$key = self::PREFIX . 'default_handler';

[464] Fix | Delete

[465] Fix | Delete

$handler = Constants::get_constant( 'WC_LOG_HANDLER' );

[466] Fix | Delete

[467] Fix | Delete

if ( is_null( $handler ) ) {

[468] Fix | Delete

$handler = WC_Admin_Settings::get_option( $key );

[469] Fix | Delete

}

[470] Fix | Delete

[471] Fix | Delete

if ( ! class_exists( $handler ) || ! is_a( $handler, 'WC_Log_Handler_Interface', true ) ) {

[472] Fix | Delete

$handler = self::DEFAULTS['default_handler'];

[473] Fix | Delete

}

[474] Fix | Delete

[475] Fix | Delete

return $handler;

[476] Fix | Delete

}

[477] Fix | Delete

[478] Fix | Delete

/**

[479] Fix | Delete

* Determine the current value of the retention_period_days setting.

[480] Fix | Delete

*

[481] Fix | Delete

* @return int

[482] Fix | Delete

*/

[483] Fix | Delete

public function get_retention_period(): int {

[484] Fix | Delete

$key = self::PREFIX . 'retention_period_days';

[485] Fix | Delete

[486] Fix | Delete

$retention_period = self::DEFAULTS['retention_period_days'];

[487] Fix | Delete

[488] Fix | Delete

if ( has_filter( 'woocommerce_logger_days_to_retain_logs' ) ) {

[489] Fix | Delete

/**

[490] Fix | Delete

* Filter the retention period of log entries.

[491] Fix | Delete

*

[492] Fix | Delete

* @param int $days The number of days to retain log entries.

[493] Fix | Delete

*

[494] Fix | Delete

* @since 3.4.0

[495] Fix | Delete

*/

[496] Fix | Delete

$retention_period = apply_filters( 'woocommerce_logger_days_to_retain_logs', $retention_period );

[497] Fix | Delete

} else {

[498] Fix | Delete

$retention_period = WC_Admin_Settings::get_option( $key );

[499] Fix | Delete