Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Logging: Handle multibyte characters and slashes in context data (#48341) 

The json_encode function encodes multibyte characters literally by
default, which makes them unreadable in the log files. This change
ensures those characters remain intact, rather than encoded. It also
adds better handling for characters that get escaped with slashes.

Fixes #44743
This commit is contained in:
Corey McKrill 2024-06-12 10:14:55 -07:00 committed by GitHub
parent ed310fede4
commit 4b40a3170c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/fix-44743-log-multibyte-context Normal file
View File

@ -0,0 +1,4 @@
Significance: minor
Type: fix
Ensure that data containing multibyte characters and/or slashes that is appended to log entries gets encoded and rendered correctly

4
plugins/woocommerce/src/Internal/Admin/Logging/LogHandlerFileV2.php
View File

@ -88,8 +88,8 @@ class LogHandlerFileV2 extends WC_Log_Handler {
unset( $context_for_entry['source'] ); unset( $context_for_entry['source'] );
if ( ! empty( $context_for_entry ) ) { if ( ! empty( $context_for_entry ) ) {
$formatted_context = wp_json_encode( $context_for_entry ); $formatted_context = wp_json_encode( $context_for_entry, JSON_UNESCAPED_UNICODE );
$message .= " CONTEXT: $formatted_context"; $message .= stripslashes( " CONTEXT: $formatted_context" );
} }
$entry = "$time_string $level_string $message"; $entry = "$time_string $level_string $message";

11
plugins/woocommerce/src/Internal/Admin/Logging/PageController.php
View File

@ -715,13 +715,18 @@ class PageController {
$message_chunks = explode( 'CONTEXT:', $segments[2], 2 ); $message_chunks = explode( 'CONTEXT:', $segments[2], 2 );
if ( isset( $message_chunks[1] ) ) { if ( isset( $message_chunks[1] ) ) {
try { try {
$maybe_json = stripslashes( html_entity_decode( trim( $message_chunks[1] ) ) ); $maybe_json = html_entity_decode( addslashes( trim( $message_chunks[1] ) ) );
$context = json_decode( $maybe_json, false, 512, JSON_THROW_ON_ERROR );
// Decode for validation.
$context = json_decode( $maybe_json, false, 512, JSON_THROW_ON_ERROR );
// Re-encode to make it pretty.
$context = wp_json_encode( $context, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE );
$message_chunks[1] = sprintf( $message_chunks[1] = sprintf(
'<details><summary>%1$s</summary>%2$s</details>', '<details><summary>%1$s</summary>%2$s</details>',
esc_html__( 'Additional context', 'woocommerce' ), esc_html__( 'Additional context', 'woocommerce' ),
wp_json_encode( $context, JSON_PRETTY_PRINT ) stripslashes( $context )
); );
$segments[2] = implode( ' ', $message_chunks ); $segments[2] = implode( ' ', $message_chunks );

7
plugins/woocommerce/tests/php/src/Internal/Admin/Logging/LogHandlerFileV2Test.php
View File

@ -187,6 +187,13 @@ MESSAGE;
), ),
$context_delineator . '{"yin":"yang","apple":"orange"}', $context_delineator . '{"yin":"yang","apple":"orange"}',
); );
yield 'custom keys with multibyte and slashed values' => array(
array(
'multibyte' => '中文字',
'backslashes' => 'C:\MS-DOS\\',
),
$context_delineator . '{"multibyte":"中文字","backslashes":"C:\MS-DOS\"}',
);
yield 'backtrace boolean only' => array( yield 'backtrace boolean only' => array(
array( 'backtrace' => true ), array( 'backtrace' => true ),
$context_delineator . wp_json_encode( array( 'backtrace' => $this->get_mock_backtrace() ) ), $context_delineator . wp_json_encode( array( 'backtrace' => $this->get_mock_backtrace() ) ),