Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Debug Logging Utility

[2] Fix | Delete

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Class PUM_Utils_Logging

[9] Fix | Delete

[10] Fix | Delete

* @since 1.8.0

[11] Fix | Delete

[12] Fix | Delete

class PUM_Utils_Logging {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Whether the log file is writable.

[16] Fix | Delete

[17] Fix | Delete

* @var bool

[18] Fix | Delete

[19] Fix | Delete

public $is_writable = false;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Log file name.

[23] Fix | Delete

[24] Fix | Delete

* @var string

[25] Fix | Delete

[26] Fix | Delete

private $filename = '';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Log file path.

[30] Fix | Delete

[31] Fix | Delete

* @var string

[32] Fix | Delete

[33] Fix | Delete

private $file = '';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* File system API.

[37] Fix | Delete

[38] Fix | Delete

* @var WP_Filesystem_Base|false

[39] Fix | Delete

[40] Fix | Delete

private $fs;

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Log file content.

[44] Fix | Delete

[45] Fix | Delete

* @var string

[46] Fix | Delete

[47] Fix | Delete

private $content;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Instance.

[51] Fix | Delete

[52] Fix | Delete

* @var PUM_Utils_Logging

[53] Fix | Delete

[54] Fix | Delete

public static $instance;

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Get instance.

[58] Fix | Delete

[59] Fix | Delete

* @return PUM_Utils_Logging

[60] Fix | Delete

[61] Fix | Delete

public static function instance() {

[62] Fix | Delete

if ( ! isset( self::$instance ) ) {

[63] Fix | Delete

self::$instance = new self();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

return self::$instance;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Get things started

[71] Fix | Delete

[72] Fix | Delete

public function __construct() {

[73] Fix | Delete

if ( $this->disabled() ) {

[74] Fix | Delete

return;

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

$this->init_fs();

[78] Fix | Delete

$this->init();

[79] Fix | Delete

[80] Fix | Delete

// On shutdown, save the log file.

[81] Fix | Delete

add_action( 'shutdown', [ $this, 'save_logs' ] );

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Check if logging is disabled.

[86] Fix | Delete

[87] Fix | Delete

* @return bool

[88] Fix | Delete

[89] Fix | Delete

public function disabled() {

[90] Fix | Delete

// Disable logging by adding define( 'PUM_DISABLE_LOGGING', true );.

[91] Fix | Delete

return defined( 'PUM_DISABLE_LOGGING' ) && PUM_DISABLE_LOGGING;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Check if logging is writeable & not disabled.

[96] Fix | Delete

[97] Fix | Delete

* If this is true the $fs property will be set.

[98] Fix | Delete

[99] Fix | Delete

* @return bool

[100] Fix | Delete

[101] Fix | Delete

public function enabled() {

[102] Fix | Delete

return ! $this->disabled() && $this->is_writable;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Initialize the file system.

[107] Fix | Delete

[108] Fix | Delete

* - Check if the file system is writable.

[109] Fix | Delete

* - Check if the upload directory is writable.

[110] Fix | Delete

* - Set the file system instance.

[111] Fix | Delete

[112] Fix | Delete

* @return void

[113] Fix | Delete

[114] Fix | Delete

public function init_fs() {

[115] Fix | Delete

$this->fs = $this->file_system();

[116] Fix | Delete

[117] Fix | Delete

// If the file system is not set, we can't check if it's writable.

[118] Fix | Delete

if ( ! $this->fs ) {

[119] Fix | Delete

return;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

$this->is_writable = false !== $this->fs && 'direct' === $this->fs->method;

[123] Fix | Delete

[124] Fix | Delete

if ( ! $this->is_writable ) {

[125] Fix | Delete

return;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

$upload_dir = PUM_Helpers::get_upload_dir();

[129] Fix | Delete

[130] Fix | Delete

if ( ! $upload_dir ) {

[131] Fix | Delete

$this->is_writable = false;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

if (

[135] Fix | Delete

! method_exists( $this->fs, 'is_writable' ) ||

[136] Fix | Delete

! $this->fs->is_writable( $upload_dir['basedir'] )

[137] Fix | Delete

) {

[138] Fix | Delete

$this->is_writable = false;

[139] Fix | Delete

}

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

/**

[143] Fix | Delete

* Get working WP Filesystem instance

[144] Fix | Delete

[145] Fix | Delete

* @return WP_Filesystem_Base|false

[146] Fix | Delete

[147] Fix | Delete

public function file_system() {

[148] Fix | Delete

global $wp_filesystem;

[149] Fix | Delete

[150] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/file.php';

[151] Fix | Delete

[152] Fix | Delete

// If for some reason the include doesn't work as expected just return false.

[153] Fix | Delete

if ( ! function_exists( 'WP_Filesystem' ) ) {

[154] Fix | Delete

return false;

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

$writable = WP_Filesystem( false, '', true );

[158] Fix | Delete

[159] Fix | Delete

// We consider the directory as writable if it uses the direct transport,

[160] Fix | Delete

// otherwise credentials would be needed.

[161] Fix | Delete

return ( $writable && 'direct' === $wp_filesystem->method ) ? $wp_filesystem : false;

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Get things started.

[166] Fix | Delete

[167] Fix | Delete

* - Get filetoken & name.

[168] Fix | Delete

* - Check if old log file exists, move it to new location.

[169] Fix | Delete

* - Check if new log file exists, if not create it.

[170] Fix | Delete

* - Set log content.

[171] Fix | Delete

* - Truncate long log files.

[172] Fix | Delete

[173] Fix | Delete

* @return void

[174] Fix | Delete

[175] Fix | Delete

public function init() {

[176] Fix | Delete

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

[177] Fix | Delete

return;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

$upload_dir = PUM_Helpers::get_upload_dir();

[181] Fix | Delete

[182] Fix | Delete

$file_token = get_option( 'pum_debug_log_token' );

[183] Fix | Delete

if ( false === $file_token ) {

[184] Fix | Delete

$file_token = uniqid( wp_rand(), true );

[185] Fix | Delete

update_option( 'pum_debug_log_token', $file_token );

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

$this->filename = "pum-debug-{$file_token}.log"; // ex. pum-debug-5c2f6a9b9b5a3.log.

[189] Fix | Delete

$this->file = trailingslashit( $upload_dir['basedir'] ) . $this->filename;

[190] Fix | Delete

$old_file = trailingslashit( $upload_dir['basedir'] ) . 'pum-debug.log';

[191] Fix | Delete

[192] Fix | Delete

// If old file exists, move it.

[193] Fix | Delete

if ( $this->fs->exists( $old_file ) ) {

[194] Fix | Delete

$old_content = $this->get_file( $old_file );

[195] Fix | Delete

$this->set_log_content( $old_content, true );

[196] Fix | Delete

[197] Fix | Delete

// Move old log file to new obfuscated location() .

[198] Fix | Delete

$this->log_unique( 'Renaming log file.' );

[199] Fix | Delete

[200] Fix | Delete

// Move old file to new location.

[201] Fix | Delete

$this->fs->move( $old_file, $this->file );

[202] Fix | Delete

[203] Fix | Delete

if ( $this->fs->exists( $old_file ) ) {

[204] Fix | Delete

$this->fs->delete( $old_file );

[205] Fix | Delete

}

[206] Fix | Delete

} elseif ( ! $this->fs->exists( $this->file ) ) {

[207] Fix | Delete

$this->setup_new_log();

[208] Fix | Delete

} else {

[209] Fix | Delete

$this->content = $this->get_file( $this->file );

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

// Truncate long log files.

[213] Fix | Delete

if ( $this->fs->exists( $this->file ) && $this->fs->size( $this->file ) >= 1048576 ) {

[214] Fix | Delete

$this->truncate_log();

[215] Fix | Delete

}

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Retrieves the url to the file

[220] Fix | Delete

[221] Fix | Delete

* @returns string

[222] Fix | Delete

* @since 1.12.0

[223] Fix | Delete

[224] Fix | Delete

public function get_file_url() {

[225] Fix | Delete

return PUM_Helpers::get_upload_dir_url( $this->filename );

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Retrieve the log data

[230] Fix | Delete

[231] Fix | Delete

* @return string

[232] Fix | Delete

[233] Fix | Delete

public function get_log() {

[234] Fix | Delete

return $this->get_log_content();

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

/**

[238] Fix | Delete

* Log message to file

[239] Fix | Delete

[240] Fix | Delete

* @param string $message The message to log.

[241] Fix | Delete

[242] Fix | Delete

public function log( $message = '' ) {

[243] Fix | Delete

$this->write_to_log( wp_date( 'Y-n-d H:i:s' ) . ' - ' . $message );

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Log unique message to file.

[248] Fix | Delete

[249] Fix | Delete

* @param string $message The unique message to log.

[250] Fix | Delete

[251] Fix | Delete

public function log_unique( $message = '' ) {

[252] Fix | Delete

$contents = $this->get_log_content();

[253] Fix | Delete

[254] Fix | Delete

if ( strpos( $contents, $message ) !== false ) {

[255] Fix | Delete

return;

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

$this->log( $message );

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Get the log file contents.

[263] Fix | Delete

[264] Fix | Delete

* @return string

[265] Fix | Delete

[266] Fix | Delete

public function get_log_content() {

[267] Fix | Delete

if ( ! isset( $this->content ) ) {

[268] Fix | Delete

$this->content = $this->get_file();

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

return $this->content;

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

/**

[275] Fix | Delete

* Set the log file contents in memory.

[276] Fix | Delete

[277] Fix | Delete

* @param mixed $content The content to set.

[278] Fix | Delete

* @param bool $save Whether to save the content to the file immediately.

[279] Fix | Delete

* @return void

[280] Fix | Delete

[281] Fix | Delete

private function set_log_content( $content, $save = false ) {

[282] Fix | Delete

$this->content = $content;

[283] Fix | Delete

[284] Fix | Delete

if ( $save ) {

[285] Fix | Delete

$this->save_logs();

[286] Fix | Delete

}

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Retrieve the contents of a file.

[291] Fix | Delete

[292] Fix | Delete

* @param string|boolean $file File to get contents of.

[293] Fix | Delete

[294] Fix | Delete

* @return string

[295] Fix | Delete

[296] Fix | Delete

protected function get_file( $file = false ) {

[297] Fix | Delete

$file = $file ? $file : $this->file;

[298] Fix | Delete

[299] Fix | Delete

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

[300] Fix | Delete

return '';

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

$content = '';

[304] Fix | Delete

[305] Fix | Delete

if ( $this->fs->exists( $file ) ) {

[306] Fix | Delete

$content = $this->fs->get_contents( $file );

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

return $content;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

/**

[313] Fix | Delete

* Write the log message

[314] Fix | Delete

[315] Fix | Delete

* @param string $message The message to write.

[316] Fix | Delete

[317] Fix | Delete

protected function write_to_log( $message = '' ) {

[318] Fix | Delete

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

[319] Fix | Delete

return;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

$contents = $this->get_log_content();

[323] Fix | Delete

[324] Fix | Delete

// If it doesn't end with a new line, add one. \r\n length is 2.

[325] Fix | Delete

if ( substr( $contents, -2 ) !== "\r\n" ) {

[326] Fix | Delete

$contents .= "\r\n";

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

$this->set_log_content( $contents . $message );

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

/**

[333] Fix | Delete

* Save the current contents to file.

[334] Fix | Delete

[335] Fix | Delete

public function save_logs() {

[336] Fix | Delete

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

[337] Fix | Delete

return;

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

$this->fs->put_contents( $this->file, $this->content, FS_CHMOD_FILE );

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

/**

[344] Fix | Delete

* Get a line count.

[345] Fix | Delete

[346] Fix | Delete

* @return int

[347] Fix | Delete

[348] Fix | Delete

public function count_lines() {

[349] Fix | Delete

$file = $this->get_log_content();

[350] Fix | Delete

$lines = explode( "\r\n", $file );

[351] Fix | Delete

[352] Fix | Delete

return count( $lines );

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete

/**

[356] Fix | Delete

* Truncates a log file to maximum of 250 lines.

[357] Fix | Delete

[358] Fix | Delete

public function truncate_log() {

[359] Fix | Delete

$content = $this->get_log_content();

[360] Fix | Delete

$lines = explode( "\r\n", $content );

[361] Fix | Delete

$lines = array_slice( $lines, 0, 250 ); // 50 is how many lines you want to keep

[362] Fix | Delete

$truncated_content = implode( "\r\n", $lines );

[363] Fix | Delete

$this->set_log_content( $truncated_content, true );

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

/**

[367] Fix | Delete

* Set up a new log file.

[368] Fix | Delete

[369] Fix | Delete

* @return void

[370] Fix | Delete

[371] Fix | Delete

public function setup_new_log() {

[372] Fix | Delete

$this->set_log_content( "Popup Maker Debug Logs:\r\n" . wp_date( 'Y-n-d H:i:s' ) . " - Log file initialized\r\n", true );

[373] Fix | Delete

}

[374] Fix | Delete

[375] Fix | Delete

/**

[376] Fix | Delete

* Delete the log file.

[377] Fix | Delete

[378] Fix | Delete

public function clear_log() {

[379] Fix | Delete

// Delete the file.

[380] Fix | Delete

if ( $this->fs && method_exists( $this->fs, 'delete' ) ) {

[381] Fix | Delete

@$this->fs->delete( $this->file );

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

if ( $this->enabled() ) {

[385] Fix | Delete

$this->setup_new_log();

[386] Fix | Delete

}

[387] Fix | Delete

}

[388] Fix | Delete

[389] Fix | Delete

/**

[390] Fix | Delete

* Log a deprecated notice.

[391] Fix | Delete

[392] Fix | Delete

* @param string $func_name Function name.

[393] Fix | Delete

* @param string $version Versoin deprecated.

[394] Fix | Delete

* @param string $replacement Replacement function (optional).

[395] Fix | Delete

[396] Fix | Delete

public function log_deprecated_notice( $func_name, $version, $replacement = null ) {

[397] Fix | Delete

if ( ! is_null( $replacement ) ) {

[398] Fix | Delete

$notice = sprintf( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $func_name, $version, $replacement );

[399] Fix | Delete

} else {

[400] Fix | Delete

$notice = sprintf( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $func_name, $version );

[401] Fix | Delete

}

[402] Fix | Delete

[403] Fix | Delete

$this->log_unique( $notice );

[404] Fix | Delete

}

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete