<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName

[0] Fix | Delete

/**

[1] Fix | Delete

* A message logger for the Jetpack Sitemap module.

[2] Fix | Delete

*

[3] Fix | Delete

* @package automattic/jetpack

[4] Fix | Delete

* @since 4.8.0

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit( 0 );

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Handles logging errors and debug messages for sitemap generator.

[13] Fix | Delete

*

[14] Fix | Delete

* A Jetpack_Sitemap_Logger object keeps track of its birth time as well

[15] Fix | Delete

* as a "unique" ID string. Calling the report() method writes a message

[16] Fix | Delete

* to the PHP error log as well as the ID string for easier grepping.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 4.8.0

[19] Fix | Delete

*/

[20] Fix | Delete

class Jetpack_Sitemap_Logger {

[21] Fix | Delete

/**

[22] Fix | Delete

* A unique-ish string for each logger, enabling us to grep

[23] Fix | Delete

* for the messages written by an individual generation phase.

[24] Fix | Delete

*

[25] Fix | Delete

* @access private

[26] Fix | Delete

* @since 4.8.0

[27] Fix | Delete

* @var string $key The key string.

[28] Fix | Delete

*/

[29] Fix | Delete

private $key;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* The birth time of this object in microseconds.

[33] Fix | Delete

*

[34] Fix | Delete

* @access private

[35] Fix | Delete

* @since 4.8.0

[36] Fix | Delete

* @var int $starttime The birth time.

[37] Fix | Delete

*/

[38] Fix | Delete

private $starttime;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Initializes a new logger object.

[42] Fix | Delete

*

[43] Fix | Delete

* @access public

[44] Fix | Delete

* @since 4.8.0

[45] Fix | Delete

*

[46] Fix | Delete

* @param string $message An optional message string to be written to the debug log on initialization.

[47] Fix | Delete

*/

[48] Fix | Delete

public function __construct( $message = null ) {

[49] Fix | Delete

$this->key = wp_generate_password( 5, false );

[50] Fix | Delete

$this->starttime = microtime( true );

[51] Fix | Delete

if ( $message !== null ) {

[52] Fix | Delete

$this->report( $message );

[53] Fix | Delete

}

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Writes a string to the debug log, including the logger's ID string.

[58] Fix | Delete

*

[59] Fix | Delete

* @access public

[60] Fix | Delete

* @since 4.8.0

[61] Fix | Delete

*

[62] Fix | Delete

* @param string $message The string to be written to the log.

[63] Fix | Delete

* @param boolean $is_error If true, $message will be logged even if JETPACK_DEV_DEBUG is not enabled.

[64] Fix | Delete

*/

[65] Fix | Delete

public function report( $message, $is_error = false ) {

[66] Fix | Delete

$message = 'jp-sitemap-' . $this->key . ': ' . $message;

[67] Fix | Delete

if ( ! ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {

[68] Fix | Delete

return;

[69] Fix | Delete

}

[70] Fix | Delete

if ( ! $is_error && ! ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) ) {

[71] Fix | Delete

return;

[72] Fix | Delete

}

[73] Fix | Delete

// Append memory usage in MB (human readable)

[74] Fix | Delete

$usage = memory_get_usage( true );

[75] Fix | Delete

$usage_mb = round( $usage / MB_IN_BYTES, 2 );

[76] Fix | Delete

$message .= ' [Memory usage: ' . $usage_mb . ' MB]';

[77] Fix | Delete

error_log( $message ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Writes the elapsed lifetime of the logger to the debug log, with an optional message.

[82] Fix | Delete

*

[83] Fix | Delete

* @access public

[84] Fix | Delete

* @since 4.8.0

[85] Fix | Delete

*

[86] Fix | Delete

* @param string $message The optional message string. Default is the empty string.

[87] Fix | Delete

*/

[88] Fix | Delete

public function time( $message = '' ) {

[89] Fix | Delete

$time = round( microtime( true ) - $this->starttime, 3 );

[90] Fix | Delete

$this->report( $message . ' ' . $time . ' seconds elapsed.' );

[91] Fix | Delete

}

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete