<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin\Logging;

[2] Fix | Delete

[3] Fix | Delete

use Automattic\Jetpack\Constants;

[4] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Logging\FileV2\{ File, FileController };

[5] Fix | Delete

use WC_Log_Handler;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* LogHandlerFileV2 class.

[9] Fix | Delete

*/

[10] Fix | Delete

class LogHandlerFileV2 extends WC_Log_Handler {

[11] Fix | Delete

/**

[12] Fix | Delete

* Instance of the FileController class.

[13] Fix | Delete

*

[14] Fix | Delete

* @var FileController

[15] Fix | Delete

*/

[16] Fix | Delete

private $file_controller;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Instance of the Settings class.

[20] Fix | Delete

*

[21] Fix | Delete

* @var Settings

[22] Fix | Delete

*/

[23] Fix | Delete

private $settings;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* LogHandlerFileV2 class.

[27] Fix | Delete

*/

[28] Fix | Delete

public function __construct() {

[29] Fix | Delete

$this->file_controller = wc_get_container()->get( FileController::class );

[30] Fix | Delete

$this->settings = wc_get_container()->get( Settings::class );

[31] Fix | Delete

}

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Handle a log entry.

[35] Fix | Delete

*

[36] Fix | Delete

* @param int $timestamp Log timestamp.

[37] Fix | Delete

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

[38] Fix | Delete

* @param string $message Log message.

[39] Fix | Delete

* @param array $context {

[40] Fix | Delete

* Optional. Additional information for log handlers. Any data can be added here, but there are some array

[41] Fix | Delete

* keys that have special behavior.

[42] Fix | Delete

*

[43] Fix | Delete

* @type string $source Determines which log file to write to. Must be at least 3 characters in length.

[44] Fix | Delete

* @type bool $backtrace True to include a backtrace that shows where the logging function got called.

[45] Fix | Delete

* }

[46] Fix | Delete

*

[47] Fix | Delete

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

[48] Fix | Delete

*/

[49] Fix | Delete

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

[50] Fix | Delete

$context = (array) $context;

[51] Fix | Delete

[52] Fix | Delete

if ( isset( $context['source'] ) && is_string( $context['source'] ) && strlen( $context['source'] ) >= 3 ) {

[53] Fix | Delete

$source = sanitize_title( trim( $context['source'] ) );

[54] Fix | Delete

} else {

[55] Fix | Delete

$source = $this->determine_source();

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

$entry = static::format_entry( $timestamp, $level, $message, $context );

[59] Fix | Delete

[60] Fix | Delete

$written = $this->file_controller->write_to_file( $source, $entry, $timestamp );

[61] Fix | Delete

[62] Fix | Delete

if ( $written ) {

[63] Fix | Delete

$this->file_controller->invalidate_cache();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

return $written;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Builds a log entry text from level, timestamp, and message.

[71] Fix | Delete

*

[72] Fix | Delete

* @param int $timestamp Log timestamp.

[73] Fix | Delete

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

[74] Fix | Delete

* @param string $message Log message.

[75] Fix | Delete

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

[76] Fix | Delete

*

[77] Fix | Delete

* @return string Formatted log entry.

[78] Fix | Delete

*/

[79] Fix | Delete

protected static function format_entry( $timestamp, $level, $message, $context ) {

[80] Fix | Delete

$time_string = static::format_time( $timestamp );

[81] Fix | Delete

$level_string = strtoupper( $level );

[82] Fix | Delete

[83] Fix | Delete

if ( isset( $context['backtrace'] ) && true === filter_var( $context['backtrace'], FILTER_VALIDATE_BOOLEAN ) ) {

[84] Fix | Delete

$context['backtrace'] = static::get_backtrace();

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

$context_for_entry = $context;

[88] Fix | Delete

unset( $context_for_entry['source'] );

[89] Fix | Delete

[90] Fix | Delete

if ( ! empty( $context_for_entry ) ) {

[91] Fix | Delete

$formatted_context = wp_json_encode( $context_for_entry, JSON_UNESCAPED_UNICODE );

[92] Fix | Delete

$message .= stripslashes( " CONTEXT: $formatted_context" );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$entry = "$time_string $level_string $message";

[96] Fix | Delete

[97] Fix | Delete

// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment

[98] Fix | Delete

/** This filter is documented in includes/abstracts/abstract-wc-log-handler.php */

[99] Fix | Delete

return apply_filters(

[100] Fix | Delete

'woocommerce_format_log_entry',

[101] Fix | Delete

$entry,

[102] Fix | Delete

array(

[103] Fix | Delete

'timestamp' => $timestamp,

[104] Fix | Delete

'level' => $level,

[105] Fix | Delete

'message' => $message,

[106] Fix | Delete

'context' => $context,

[107] Fix | Delete

)

[108] Fix | Delete

);

[109] Fix | Delete

// phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Figures out a source string to use for a log entry based on where the log method was called from.

[114] Fix | Delete

*

[115] Fix | Delete

* @return string

[116] Fix | Delete

*/

[117] Fix | Delete

protected function determine_source(): string {

[118] Fix | Delete

$source_roots = array(

[119] Fix | Delete

'mu-plugin' => trailingslashit( Constants::get_constant( 'WPMU_PLUGIN_DIR' ) ),

[120] Fix | Delete

'plugin' => trailingslashit( Constants::get_constant( 'WP_PLUGIN_DIR' ) ),

[121] Fix | Delete

'theme' => trailingslashit( get_theme_root() ),

[122] Fix | Delete

);

[123] Fix | Delete

[124] Fix | Delete

$source = '';

[125] Fix | Delete

$backtrace = static::get_backtrace();

[126] Fix | Delete

[127] Fix | Delete

foreach ( $backtrace as $frame ) {

[128] Fix | Delete

if ( ! isset( $frame['file'] ) ) {

[129] Fix | Delete

continue;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

foreach ( $source_roots as $type => $path ) {

[133] Fix | Delete

if ( 0 === strpos( $frame['file'], $path ) ) {

[134] Fix | Delete

$relative_path = trim( substr( $frame['file'], strlen( $path ) ), DIRECTORY_SEPARATOR );

[135] Fix | Delete

[136] Fix | Delete

if ( 'mu-plugin' === $type ) {

[137] Fix | Delete

$info = pathinfo( $relative_path );

[138] Fix | Delete

[139] Fix | Delete

if ( '.' === $info['dirname'] ) {

[140] Fix | Delete

$source = "$type-" . $info['filename'];

[141] Fix | Delete

} else {

[142] Fix | Delete

$source = "$type-" . $info['dirname'];

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

break 2;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

$segments = explode( DIRECTORY_SEPARATOR, $relative_path );

[149] Fix | Delete

if ( is_array( $segments ) ) {

[150] Fix | Delete

$source = "$type-" . reset( $segments );

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

break 2;

[154] Fix | Delete

}

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

if ( ! $source ) {

[159] Fix | Delete

$source = 'log';

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

return sanitize_title( $source );

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Delete all logs from a specific source.

[167] Fix | Delete

*

[168] Fix | Delete

* @param string $source The source of the log entries.

[169] Fix | Delete

* @param bool $quiet Whether to suppress the deletion message.

[170] Fix | Delete

*

[171] Fix | Delete

* @return int The number of files that were deleted.

[172] Fix | Delete

*/

[173] Fix | Delete

public function clear( string $source, bool $quiet = false ): int {

[174] Fix | Delete

$source = File::sanitize_source( $source );

[175] Fix | Delete

[176] Fix | Delete

$files = $this->file_controller->get_files(

[177] Fix | Delete

array(

[178] Fix | Delete

'source' => $source,

[179] Fix | Delete

)

[180] Fix | Delete

);

[181] Fix | Delete

[182] Fix | Delete

if ( is_wp_error( $files ) || count( $files ) < 1 ) {

[183] Fix | Delete

return 0;

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

$file_ids = array_map(

[187] Fix | Delete

fn( $file ) => $file->get_file_id(),

[188] Fix | Delete

$files

[189] Fix | Delete

);

[190] Fix | Delete

[191] Fix | Delete

$deleted = $this->file_controller->delete_files( $file_ids );

[192] Fix | Delete

[193] Fix | Delete

if ( $deleted > 0 && ! $quiet ) {

[194] Fix | Delete

$this->handle(

[195] Fix | Delete

time(),

[196] Fix | Delete

'info',

[197] Fix | Delete

sprintf(

[198] Fix | Delete

esc_html(

[199] Fix | Delete

// translators: %1$s is a number of log files, %2$s is a slug-style name for a file.

[200] Fix | Delete

_n(

[201] Fix | Delete

'%1$s log file from source %2$s was deleted.',

[202] Fix | Delete

'%1$s log files from source %2$s were deleted.',

[203] Fix | Delete

$deleted,

[204] Fix | Delete

'woocommerce'

[205] Fix | Delete

)

[206] Fix | Delete

),

[207] Fix | Delete

number_format_i18n( $deleted ),

[208] Fix | Delete

sprintf(

[209] Fix | Delete

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

[210] Fix | Delete

esc_html( $source )

[211] Fix | Delete

)

[212] Fix | Delete

),

[213] Fix | Delete

array(

[214] Fix | Delete

'source' => 'wc_logger',

[215] Fix | Delete

'backtrace' => true,

[216] Fix | Delete

)

[217] Fix | Delete

);

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

return $deleted;

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Delete all logs older than a specified timestamp.

[225] Fix | Delete

*

[226] Fix | Delete

* @param int $timestamp All files created before this timestamp will be deleted.

[227] Fix | Delete

*

[228] Fix | Delete

* @return int The number of files that were deleted.

[229] Fix | Delete

*/

[230] Fix | Delete

public function delete_logs_before_timestamp( int $timestamp = 0 ): int {

[231] Fix | Delete

if ( ! $timestamp ) {

[232] Fix | Delete

return 0;

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

$files = $this->file_controller->get_files(

[236] Fix | Delete

array(

[237] Fix | Delete

'date_filter' => 'created',

[238] Fix | Delete

'date_start' => 1,

[239] Fix | Delete

'date_end' => $timestamp,

[240] Fix | Delete

)

[241] Fix | Delete

);

[242] Fix | Delete

[243] Fix | Delete

if ( is_wp_error( $files ) ) {

[244] Fix | Delete

return 0;

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

$files = array_filter(

[248] Fix | Delete

$files,

[249] Fix | Delete

function ( $file ) use ( $timestamp ) {

[250] Fix | Delete

/**

[251] Fix | Delete

* Allows preventing an expired log file from being deleted.

[252] Fix | Delete

*

[253] Fix | Delete

* @param bool $delete True to delete the file.

[254] Fix | Delete

* @param File $file The log file object.

[255] Fix | Delete

* @param int $timestamp The expiration threshold.

[256] Fix | Delete

*

[257] Fix | Delete

* @since 8.7.0

[258] Fix | Delete

*/

[259] Fix | Delete

$delete = apply_filters( 'woocommerce_logger_delete_expired_file', true, $file, $timestamp );

[260] Fix | Delete

[261] Fix | Delete

return boolval( $delete );

[262] Fix | Delete

}

[263] Fix | Delete

);

[264] Fix | Delete

[265] Fix | Delete

if ( count( $files ) < 1 ) {

[266] Fix | Delete

return 0;

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

$file_ids = array_map(

[270] Fix | Delete

fn( $file ) => $file->get_file_id(),

[271] Fix | Delete

$files

[272] Fix | Delete

);

[273] Fix | Delete

[274] Fix | Delete

$deleted = $this->file_controller->delete_files( $file_ids );

[275] Fix | Delete

$retention_days = $this->settings->get_retention_period();

[276] Fix | Delete

[277] Fix | Delete

if ( $deleted > 0 ) {

[278] Fix | Delete

$this->handle(

[279] Fix | Delete

time(),

[280] Fix | Delete

'info',

[281] Fix | Delete

sprintf(

[282] Fix | Delete

esc_html(

[283] Fix | Delete

// translators: %s is a number of log files.

[284] Fix | Delete

_n(

[285] Fix | Delete

'%s expired log file was deleted.',

[286] Fix | Delete

'%s expired log files were deleted.',

[287] Fix | Delete

$deleted,

[288] Fix | Delete

'woocommerce'

[289] Fix | Delete

)

[290] Fix | Delete

),

[291] Fix | Delete

number_format_i18n( $deleted )

[292] Fix | Delete

),

[293] Fix | Delete

array(

[294] Fix | Delete

'source' => 'wc_logger',

[295] Fix | Delete

)

[296] Fix | Delete

);

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

return $deleted;

[300] Fix | Delete

}

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete