<?php

[0] Fix | Delete

declare( strict_types = 1 );

[1] Fix | Delete

[2] Fix | Delete

namespace Automattic\WooCommerce\Internal\Logging;

[3] Fix | Delete

[4] Fix | Delete

use Automattic\WooCommerce\Utilities\FeaturesUtil;

[5] Fix | Delete

use Automattic\WooCommerce\Utilities\StringUtil;

[6] Fix | Delete

use Automattic\WooCommerce\Internal\McStats;

[7] Fix | Delete

use Jetpack_Options;

[8] Fix | Delete

use WC_Rate_Limiter;

[9] Fix | Delete

use WC_Log_Levels;

[10] Fix | Delete

use WC_Site_Tracking;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* WooCommerce Remote Logger

[14] Fix | Delete

*

[15] Fix | Delete

* The WooCommerce remote logger class adds functionality to log WooCommerce errors remotely based on if the customer opted in and several other conditions.

[16] Fix | Delete

*

[17] Fix | Delete

* No personal information is logged, only error information and relevant context.

[18] Fix | Delete

*

[19] Fix | Delete

* @class RemoteLogger

[20] Fix | Delete

* @since 9.2.0

[21] Fix | Delete

* @package WooCommerce\Classes

[22] Fix | Delete

*/

[23] Fix | Delete

class RemoteLogger extends \WC_Log_Handler {

[24] Fix | Delete

[25] Fix | Delete

const LOG_ENDPOINT = 'https://public-api.wordpress.com/rest/v1.1/logstash';

[26] Fix | Delete

const RATE_LIMIT_ID = 'woocommerce_remote_logging';

[27] Fix | Delete

const RATE_LIMIT_DELAY = 60; // 1 minute.

[28] Fix | Delete

const WC_NEW_VERSION_TRANSIENT = 'woocommerce_new_version';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Handle a log entry.

[32] Fix | Delete

*

[33] Fix | Delete

* @param int $timestamp Log timestamp.

[34] Fix | Delete

* @param string $level emergency|alert|critical|error|warning|notice|info|debug.

[35] Fix | Delete

* @param string $message Log message.

[36] Fix | Delete

* @param array $context Additional information for log handlers.

[37] Fix | Delete

*

[38] Fix | Delete

* @throws \Exception If the remote logging fails. The error is caught and logged locally.

[39] Fix | Delete

*

[40] Fix | Delete

* @return bool False if value was not handled and true if value was handled.

[41] Fix | Delete

*/

[42] Fix | Delete

public function handle( $timestamp, $level, $message, $context ) {

[43] Fix | Delete

try {

[44] Fix | Delete

if ( ! $this->should_handle( $level, $message, $context ) ) {

[45] Fix | Delete

return false;

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

return $this->log( $level, $message, $context );

[49] Fix | Delete

} catch ( \Throwable $e ) {

[50] Fix | Delete

// Log the error to the local logger so we can investigate.

[51] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->error( 'Failed to handle the log: ' . $e->getMessage(), array( 'source' => 'remote-logging' ) );

[52] Fix | Delete

return false;

[53] Fix | Delete

}

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Get formatted log data to be sent to the remote logging service.

[58] Fix | Delete

*

[59] Fix | Delete

* This method formats the log data by sanitizing the message, adding default fields, and including additional context

[60] Fix | Delete

* such as backtrace, tags, and extra attributes. It also integrates with WC_Tracks to include blog and store details.

[61] Fix | Delete

* The formatted log data is then filtered before being sent to the remote logging service.

[62] Fix | Delete

*

[63] Fix | Delete

* @param string $level Log level (e.g., 'error', 'warning', 'info').

[64] Fix | Delete

* @param string $message Log message to be recorded.

[65] Fix | Delete

* @param array $context Optional. Additional information for log handlers, such as 'backtrace', 'tags', 'extra', and 'error'.

[66] Fix | Delete

*

[67] Fix | Delete

* @return array Formatted log data ready to be sent to the remote logging service.

[68] Fix | Delete

*/

[69] Fix | Delete

public function get_formatted_log( $level, $message, $context = array() ) {

[70] Fix | Delete

$log_data = array(

[71] Fix | Delete

// Default fields.

[72] Fix | Delete

'feature' => 'woocommerce_core',

[73] Fix | Delete

'severity' => $level,

[74] Fix | Delete

'message' => $this->sanitize( $message ),

[75] Fix | Delete

'host' => SafeGlobalFunctionProxy::wp_parse_url( SafeGlobalFunctionProxy::home_url(), PHP_URL_HOST ) ?? 'Unable to retrieve host',

[76] Fix | Delete

'tags' => array( 'woocommerce', 'php' ),

[77] Fix | Delete

'properties' => array(

[78] Fix | Delete

'wc_version' => $this->get_wc_version(),

[79] Fix | Delete

'php_version' => phpversion(),

[80] Fix | Delete

'wp_version' => SafeGlobalFunctionProxy::get_bloginfo( 'version' ) ?? 'Unable to retrieve wp version',

[81] Fix | Delete

'request_uri' => $this->sanitize_request_uri( filter_input( INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL ) ),

[82] Fix | Delete

'store_id' => SafeGlobalFunctionProxy::get_option( \WC_Install::STORE_ID_OPTION, null ) ?? 'Unable to retrieve store id',

[83] Fix | Delete

),

[84] Fix | Delete

);

[85] Fix | Delete

[86] Fix | Delete

$blog_id = class_exists( 'Jetpack_Options' ) ? Jetpack_Options::get_option( 'id' ) : null;

[87] Fix | Delete

[88] Fix | Delete

if ( ! empty( $blog_id ) && is_int( $blog_id ) ) {

[89] Fix | Delete

$log_data['blog_id'] = $blog_id;

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

if ( isset( $context['backtrace'] ) ) {

[93] Fix | Delete

if ( is_array( $context['backtrace'] ) || is_string( $context['backtrace'] ) ) {

[94] Fix | Delete

$log_data['trace'] = $this->sanitize_trace( $context['backtrace'] );

[95] Fix | Delete

} elseif ( true === $context['backtrace'] ) {

[96] Fix | Delete

$log_data['trace'] = $this->sanitize_trace( self::get_backtrace() );

[97] Fix | Delete

}

[98] Fix | Delete

unset( $context['backtrace'] );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

if ( isset( $context['tags'] ) && is_array( $context['tags'] ) ) {

[102] Fix | Delete

$log_data['tags'] = array_merge( $log_data['tags'], $context['tags'] );

[103] Fix | Delete

unset( $context['tags'] );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

if ( isset( $context['error']['file'] ) && is_string( $context['error']['file'] ) && '' !== $context['error']['file'] ) {

[107] Fix | Delete

$log_data['file'] = $this->normalize_paths( $context['error']['file'] );

[108] Fix | Delete

unset( $context['error']['file'] );

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

$extra_attrs = $context['extra'] ?? array();

[112] Fix | Delete

unset( $context['extra'] );

[113] Fix | Delete

unset( $context['remote-logging'] );

[114] Fix | Delete

[115] Fix | Delete

// Merge the extra attributes with the remaining context since we can't send arbitrary fields to Logstash.

[116] Fix | Delete

$log_data['extra'] = array_merge( $extra_attrs, $context );

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Filters the formatted log data before sending it to the remote logging service.

[120] Fix | Delete

* Returning a non-array value will prevent the log from being sent.

[121] Fix | Delete

*

[122] Fix | Delete

* @since 9.2.0

[123] Fix | Delete

*

[124] Fix | Delete

* @param array $log_data The formatted log data.

[125] Fix | Delete

* @param string $level The log level (e.g., 'error', 'warning').

[126] Fix | Delete

* @param string $message The log message.

[127] Fix | Delete

* @param array $context The original context array.

[128] Fix | Delete

*

[129] Fix | Delete

* @return array The filtered log data.

[130] Fix | Delete

*/

[131] Fix | Delete

return apply_filters( 'woocommerce_remote_logger_formatted_log_data', $log_data, $level, $message, $context );

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Determines if remote logging is allowed based on the following conditions:

[136] Fix | Delete

*

[137] Fix | Delete

* 1. The feature flag for remote error logging is enabled.

[138] Fix | Delete

* 2. The user has opted into tracking/logging.

[139] Fix | Delete

* 3. The store is allowed to log based on the variant assignment percentage.

[140] Fix | Delete

* 4. The current WooCommerce version is the latest so we don't log errors that might have been fixed in a newer version.

[141] Fix | Delete

*

[142] Fix | Delete

* @return bool

[143] Fix | Delete

*/

[144] Fix | Delete

public function is_remote_logging_allowed() {

[145] Fix | Delete

if ( ! FeaturesUtil::feature_is_enabled( 'remote_logging' ) ) {

[146] Fix | Delete

return false;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

if ( ! WC_Site_Tracking::is_tracking_enabled() ) {

[150] Fix | Delete

return false;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

if ( ! $this->should_current_version_be_logged() ) {

[154] Fix | Delete

return false;

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

return true;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

/**

[161] Fix | Delete

* Determine whether to handle or ignore log.

[162] Fix | Delete

*

[163] Fix | Delete

* @param string $level emergency|alert|critical|error|warning|notice|info|debug.

[164] Fix | Delete

* @param string $message Log message to be recorded.

[165] Fix | Delete

* @param array $context Additional information for log handlers.

[166] Fix | Delete

*

[167] Fix | Delete

* @return bool True if the log should be handled.

[168] Fix | Delete

*/

[169] Fix | Delete

protected function should_handle( $level, $message, $context ) {

[170] Fix | Delete

// Ignore logs that are not opted in for remote logging.

[171] Fix | Delete

if ( ! isset( $context['remote-logging'] ) || false === $context['remote-logging'] ) {

[172] Fix | Delete

return false;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

if ( ! $this->is_remote_logging_allowed() ) {

[176] Fix | Delete

return false;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

if ( $this->is_third_party_error( (string) $message, (array) $context ) ) {

[180] Fix | Delete

return false;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

// Record fatal error stats.

[184] Fix | Delete

if ( WC_Log_Levels::get_level_severity( $level ) >= WC_Log_Levels::get_level_severity( WC_Log_Levels::CRITICAL ) ) {

[185] Fix | Delete

try {

[186] Fix | Delete

$mc_stats = wc_get_container()->get( McStats::class );

[187] Fix | Delete

$mc_stats->add( 'error', 'critical-errors' );

[188] Fix | Delete

$mc_stats->do_server_side_stats();

[189] Fix | Delete

} catch ( \Throwable $e ) {

[190] Fix | Delete

error_log( 'Warning: Failed to record fatal error stats: ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

if ( WC_Rate_Limiter::retried_too_soon( self::RATE_LIMIT_ID ) ) {

[195] Fix | Delete

// Log locally that the remote logging is throttled.

[196] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->warning( 'Remote logging throttled.', array( 'source' => 'remote-logging' ) );

[197] Fix | Delete

return false;

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

return true;

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Send the log to the remote logging service.

[206] Fix | Delete

*

[207] Fix | Delete

* @param string $level Log level (e.g., 'error', 'warning', 'info').

[208] Fix | Delete

* @param string $message Log message to be recorded.

[209] Fix | Delete

* @param array $context Optional. Additional information for log handlers, such as 'backtrace', 'tags', 'extra', and 'error'.

[210] Fix | Delete

*

[211] Fix | Delete

* @throws \Exception|\Error If the remote logging fails. The error is caught and logged locally.

[212] Fix | Delete

* @return bool

[213] Fix | Delete

*/

[214] Fix | Delete

private function log( $level, $message, $context ) {

[215] Fix | Delete

$log_data = $this->get_formatted_log( $level, $message, $context );

[216] Fix | Delete

[217] Fix | Delete

// Ensure the log data is valid.

[218] Fix | Delete

if ( ! is_array( $log_data ) || empty( $log_data['message'] ) || empty( $log_data['feature'] ) ) {

[219] Fix | Delete

return false;

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

$body = SafeGlobalFunctionProxy::wp_json_encode( array( 'params' => SafeGlobalFunctionProxy::wp_json_encode( $log_data ) ) );

[223] Fix | Delete

if ( is_null( $body ) ) { // if the json encoding fails the API will reject the API call so let's not bother.

[224] Fix | Delete

throw new \Error( 'Remote Logger encountered error while attempting to JSON encode $log_data' );

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

WC_Rate_Limiter::set_rate_limit( self::RATE_LIMIT_ID, self::RATE_LIMIT_DELAY );

[228] Fix | Delete

[229] Fix | Delete

if ( $this->is_dev_or_local_environment() ) {

[230] Fix | Delete

return false;

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

$response = SafeGlobalFunctionProxy::wp_safe_remote_post(

[234] Fix | Delete

self::LOG_ENDPOINT,

[235] Fix | Delete

array(

[236] Fix | Delete

'body' => $body,

[237] Fix | Delete

'timeout' => 3,

[238] Fix | Delete

'headers' => array(

[239] Fix | Delete

'Content-Type' => 'application/json',

[240] Fix | Delete

),

[241] Fix | Delete

'blocking' => false,

[242] Fix | Delete

)

[243] Fix | Delete

);

[244] Fix | Delete

[245] Fix | Delete

if ( is_null( $response ) ) { // SafeGlobalFunctionProxy will return a null if an error occurs within, so there will be a separate log entry with the details.

[246] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->error( 'Failed to call wp_safe_remote_post while sending the log to the remote logging service.', array( 'source' => 'remote-logging' ) );

[247] Fix | Delete

return false;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

$is_api_call_error = SafeGlobalFunctionProxy::is_wp_error( $response );

[251] Fix | Delete

[252] Fix | Delete

if ( $is_api_call_error ) {

[253] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->error( 'Failed to send the log to the remote logging service: ' . $response->get_error_message(), array( 'source' => 'remote-logging' ) );

[254] Fix | Delete

return false;

[255] Fix | Delete

} elseif ( is_null( $is_api_call_error ) ) {

[256] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->error( 'Failed to parse the response after sending log to the remote logging service. ', array( 'source' => 'remote-logging' ) );

[257] Fix | Delete

return false;

[258] Fix | Delete

}

[259] Fix | Delete

return true;

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Check if the current WooCommerce version is the latest.

[264] Fix | Delete

*

[265] Fix | Delete

* @return bool

[266] Fix | Delete

*/

[267] Fix | Delete

private function should_current_version_be_logged() {

[268] Fix | Delete

$new_version = SafeGlobalFunctionProxy::get_site_transient( self::WC_NEW_VERSION_TRANSIENT ) ?? '';

[269] Fix | Delete

[270] Fix | Delete

if ( false === $new_version ) {

[271] Fix | Delete

$new_version = $this->fetch_new_woocommerce_version();

[272] Fix | Delete

// Cache the new version for a week since we want to keep logging in with the same version for a while even if the new version is available.

[273] Fix | Delete

SafeGlobalFunctionProxy::set_site_transient( self::WC_NEW_VERSION_TRANSIENT, $new_version, WEEK_IN_SECONDS );

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

if ( ! is_string( $new_version ) || '' === $new_version ) {

[277] Fix | Delete

// If the new version is not available, we consider the current version to be the latest.

[278] Fix | Delete

return true;

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

// If the current version is the latest, we don't want to log errors.

[282] Fix | Delete

return version_compare( $this->get_wc_version(), $new_version, '>=' );

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Get the current WooCommerce version reliably through a series of fallbacks

[287] Fix | Delete

*

[288] Fix | Delete

* @return string The current WooCommerce version.

[289] Fix | Delete

*/

[290] Fix | Delete

private function get_wc_version() {

[291] Fix | Delete

if ( class_exists( '\Automattic\Jetpack\Constants' ) && method_exists( '\Automattic\Jetpack\Constants', 'get_constant' ) ) {

[292] Fix | Delete

$wc_version = \Automattic\Jetpack\Constants::get_constant( 'WC_VERSION' );

[293] Fix | Delete

if ( $wc_version ) {

[294] Fix | Delete

return $wc_version;

[295] Fix | Delete

}

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

if ( function_exists( 'WC' ) && method_exists( WC(), 'version' ) ) {

[299] Fix | Delete

return WC()->version();

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

if ( defined( 'WC_VERSION' ) ) {

[303] Fix | Delete

return WC_VERSION;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

// Return null since none of the above worked.

[307] Fix | Delete

return null;

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

/**

[311] Fix | Delete

* Check if the error exclusively contains third-party stack frames for fatal-errors source context.

[312] Fix | Delete

*

[313] Fix | Delete

* @param string $message The error message.

[314] Fix | Delete

* @param array $context The error context.

[315] Fix | Delete

*

[316] Fix | Delete

* @return bool

[317] Fix | Delete

*/

[318] Fix | Delete

protected function is_third_party_error( string $message, array $context ): bool {

[319] Fix | Delete

// Only check for fatal-errors source context.

[320] Fix | Delete

if ( ! isset( $context['source'] ) || 'fatal-errors' !== $context['source'] ) {

[321] Fix | Delete

return false;

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

$wc_plugin_dir = StringUtil::normalize_local_path_slashes( WC_ABSPATH );

[325] Fix | Delete

[326] Fix | Delete

// Check if the error message contains the WooCommerce plugin directory.

[327] Fix | Delete

if ( str_contains( $message, $wc_plugin_dir ) ) {

[328] Fix | Delete

return false;

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

// Without a backtrace, it's impossible to ascertain if the error is third-party. To avoid logging numerous irrelevant errors, we'll consider it a third-party error and ignore it.

[332] Fix | Delete

if ( isset( $context['backtrace'] ) && is_array( $context['backtrace'] ) ) {

[333] Fix | Delete

$wp_includes_dir = StringUtil::normalize_local_path_slashes( ABSPATH . WPINC );

[334] Fix | Delete

$wp_admin_dir = StringUtil::normalize_local_path_slashes( ABSPATH . 'wp-admin' );

[335] Fix | Delete

[336] Fix | Delete

// Find the first relevant frame that is not from WordPress core and not empty.

[337] Fix | Delete

$relevant_frame = null;

[338] Fix | Delete

foreach ( $context['backtrace'] as $frame ) {

[339] Fix | Delete

if ( empty( $frame ) || ! is_string( $frame ) ) {

[340] Fix | Delete

continue;

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

// Skip frames from WordPress core.

[344] Fix | Delete

if ( strpos( $frame, $wp_includes_dir ) !== false || strpos( $frame, $wp_admin_dir ) !== false ) {

[345] Fix | Delete

continue;

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

$relevant_frame = $frame;

[349] Fix | Delete

break;

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

// Check if the relevant frame is from WooCommerce.

[353] Fix | Delete

if ( $relevant_frame && strpos( $relevant_frame, $wc_plugin_dir ) !== false ) {

[354] Fix | Delete

return false;

[355] Fix | Delete

}

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

if ( ! function_exists( 'apply_filters' ) ) {

[359] Fix | Delete

require_once ABSPATH . WPINC . '/plugin.php';

[360] Fix | Delete

}

[361] Fix | Delete

/**

[362] Fix | Delete

* Filter to allow other plugins to overwrite the result of the third-party error check for remote logging.

[363] Fix | Delete

*

[364] Fix | Delete

* @since 9.2.0

[365] Fix | Delete

*

[366] Fix | Delete

* @param bool $is_third_party_error The result of the third-party error check.

[367] Fix | Delete

* @param string $message The error message.

[368] Fix | Delete

* @param array $context The error context.

[369] Fix | Delete

*/

[370] Fix | Delete

return apply_filters( 'woocommerce_remote_logging_is_third_party_error', true, $message, $context );

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

/**

[374] Fix | Delete

* Fetch the new version of WooCommerce from the WordPress API.

[375] Fix | Delete

*

[376] Fix | Delete

* @return string|null New version if an update is available, null otherwise.

[377] Fix | Delete

*/

[378] Fix | Delete

private function fetch_new_woocommerce_version() {

[379] Fix | Delete

$plugin_updates = SafeGlobalFunctionProxy::get_plugin_updates();

[380] Fix | Delete

[381] Fix | Delete

// Check if WooCommerce plugin update information is available.

[382] Fix | Delete

if ( ! is_array( $plugin_updates ) || ! isset( $plugin_updates[ WC_PLUGIN_BASENAME ] ) ) {

[383] Fix | Delete

return null;

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete

$wc_plugin_update = $plugin_updates[ WC_PLUGIN_BASENAME ];

[387] Fix | Delete

[388] Fix | Delete

// Ensure the update object exists and has the required information.

[389] Fix | Delete

if ( ! $wc_plugin_update || ! isset( $wc_plugin_update->update->new_version ) ) {

[390] Fix | Delete

return null;

[391] Fix | Delete

}

[392] Fix | Delete

[393] Fix | Delete

$new_version = $wc_plugin_update->update->new_version;

[394] Fix | Delete

return is_string( $new_version ) ? $new_version : null;

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

/**

[398] Fix | Delete

* Sanitize the content to exclude sensitive data.

[399] Fix | Delete

*

[400] Fix | Delete

* The trace is sanitized by:

[401] Fix | Delete

*

[402] Fix | Delete

* 1. Remove the absolute path to the plugin directory based on WC_ABSPATH. This is more accurate than using WP_PLUGIN_DIR when the plugin is symlinked.

[403] Fix | Delete

* 2. Remove the absolute path to the WordPress root directory.

[404] Fix | Delete

* 3. Redact potential user data such as email addresses and phone numbers.

[405] Fix | Delete

*

[406] Fix | Delete

* For example, the trace:

[407] Fix | Delete

*

[408] Fix | Delete

* /var/www/html/wp-content/plugins/woocommerce/includes/class-wc-remote-logger.php on line 123

[409] Fix | Delete

* will be sanitized to: **\/woocommerce/includes/class-wc-remote-logger.php on line 123

[410] Fix | Delete

*

[411] Fix | Delete

* Additionally, any user data like email addresses or phone numbers will be redacted.

[412] Fix | Delete

*

[413] Fix | Delete

* @param string $content The content to sanitize.

[414] Fix | Delete

*

[415] Fix | Delete

* @return string The sanitized content.

[416] Fix | Delete

*/

[417] Fix | Delete

private function sanitize( $content ) {

[418] Fix | Delete

if ( ! is_string( $content ) ) {

[419] Fix | Delete

return $content;

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

$sanitized = $this->normalize_paths( $content );

[423] Fix | Delete

$sanitized = $this->redact_user_data( $sanitized );

[424] Fix | Delete

[425] Fix | Delete

if ( ! function_exists( 'apply_filters' ) ) {

[426] Fix | Delete

require_once ABSPATH . WPINC . '/plugin.php';

[427] Fix | Delete

}

[428] Fix | Delete

[429] Fix | Delete

/**

[430] Fix | Delete

* Filter the sanitized log content before it's sent to the remote logging service.

[431] Fix | Delete

*

[432] Fix | Delete

* @since 9.5.0

[433] Fix | Delete

*

[434] Fix | Delete

* @param string $sanitized The sanitized content.

[435] Fix | Delete

* @param string $content The original content.

[436] Fix | Delete

*/

[437] Fix | Delete

return apply_filters( 'woocommerce_remote_logger_sanitized_content', $sanitized, $content );

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete

/**

[441] Fix | Delete

* Normalize file paths by replacing absolute paths with relative ones.

[442] Fix | Delete

*

[443] Fix | Delete

* @param string $content The content containing paths to normalize.

[444] Fix | Delete

*

[445] Fix | Delete

* @return string The content with normalized paths.

[446] Fix | Delete

*/

[447] Fix | Delete

private function normalize_paths( string $content ): string {

[448] Fix | Delete

$plugin_path = StringUtil::normalize_local_path_slashes( trailingslashit( dirname( WC_ABSPATH ) ) );

[449] Fix | Delete

$wp_path = StringUtil::normalize_local_path_slashes( trailingslashit( ABSPATH ) );

[450] Fix | Delete

[451] Fix | Delete

return str_replace(

[452] Fix | Delete

array( $plugin_path, $wp_path ),

[453] Fix | Delete

array( './', './' ),

[454] Fix | Delete

$content

[455] Fix | Delete

);

[456] Fix | Delete

}

[457] Fix | Delete

[458] Fix | Delete

/**

[459] Fix | Delete

* Sanitize the error trace to exclude sensitive data.

[460] Fix | Delete

*

[461] Fix | Delete

* @param array|string $trace The error trace.

[462] Fix | Delete

* @return string The sanitized trace.

[463] Fix | Delete

*/

[464] Fix | Delete

private function sanitize_trace( $trace ): string {

[465] Fix | Delete

if ( is_string( $trace ) ) {

[466] Fix | Delete

return $this->sanitize( $trace );

[467] Fix | Delete

}

[468] Fix | Delete

[469] Fix | Delete

if ( ! is_array( $trace ) ) {

[470] Fix | Delete

return '';

[471] Fix | Delete

}

[472] Fix | Delete

[473] Fix | Delete

$sanitized_trace = array_map(

[474] Fix | Delete

function ( $trace_item ) {

[475] Fix | Delete

if ( is_array( $trace_item ) && isset( $trace_item['file'] ) ) {

[476] Fix | Delete

$trace_item['file'] = $this->sanitize( $trace_item['file'] );

[477] Fix | Delete

return $trace_item;

[478] Fix | Delete

}

[479] Fix | Delete

[480] Fix | Delete

return $this->sanitize( $trace_item );

[481] Fix | Delete

},

[482] Fix | Delete

$trace

[483] Fix | Delete

);

[484] Fix | Delete

[485] Fix | Delete

$is_array_by_file = isset( $sanitized_trace[0]['file'] );

[486] Fix | Delete

if ( $is_array_by_file ) {

[487] Fix | Delete

return SafeGlobalFunctionProxy::wc_print_r( $sanitized_trace, true );

[488] Fix | Delete

}

[489] Fix | Delete

[490] Fix | Delete

return implode( "\n", $sanitized_trace );

[491] Fix | Delete

}

[492] Fix | Delete

[493] Fix | Delete

[494] Fix | Delete

/**

[495] Fix | Delete

* Redact potential user data from the content.

[496] Fix | Delete

*

[497] Fix | Delete

* @param string $content The content to redact.

[498] Fix | Delete

* @return string The redacted message.

[499] Fix | Delete