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

Merge pull request #20730 from woocommerce/fix/20716 

Fix log file deletion
This commit is contained in:
Claudiu Lodromanean 2018-07-09 11:35:45 -07:00 committed by GitHub
parent 24a1ccf5fc bc3c780b92
commit af98ef66e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
includes/admin/class-wc-admin-status.php
View File

@ -162,7 +162,7 @@ class WC_Admin_Status {
* @return string
*/
public static function get_log_file_handle( $filename ) {
return substr( $filename, 0, strlen( $filename ) > 37 ? strlen( $filename ) - 37 : strlen( $filename ) - 4 );
return substr( $filename, 0, strlen( $filename ) > 48 ? strlen( $filename ) - 48 : strlen( $filename ) - 4 );
}
/**

4
includes/admin/views/html-admin-page-status-logs.php
View File

@ -15,8 +15,8 @@ if ( ! defined( 'ABSPATH' ) ) {
<div class="alignleft">
<h2>
<?php echo esc_html( $viewed_log ); ?>
<?php if ( ! empty( $handle ) ) : ?>
<a class="page-title-action" href="<?php echo esc_url( wp_nonce_url( add_query_arg( array( 'handle' => $handle ), admin_url( 'admin.php?page=wc-status&tab=logs' ) ), 'remove_log' ) ); ?>" class="button"><?php esc_html_e( 'Delete log', 'woocommerce' ); ?></a>
<?php if ( ! empty( $viewed_log ) ) : ?>
<a class="page-title-action" href="<?php echo esc_url( wp_nonce_url( add_query_arg( array( 'handle' => $viewed_log ), admin_url( 'admin.php?page=wc-status&tab=logs' ) ), 'remove_log' ) ); ?>" class="button"><?php esc_html_e( 'Delete log', 'woocommerce' ); ?></a>
<?php endif; ?>
</h2>
</div>

6
includes/log-handlers/class-wc-log-handler-file.php
View File

@ -248,16 +248,14 @@ class WC_Log_Handler_File extends WC_Log_Handler {
*/
public function remove( $handle ) {
$removed = false;
$file = self::get_log_file_path( $handle );
$file = trailingslashit( WC_LOG_DIR ) . $handle;
if ( $file ) {
if ( is_file( $file ) && is_writable( $file ) ) { // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
$this->close( $handle ); // Close first to be certain no processes keep it alive after it is unlinked.
$this->close( $file ); // Close first to be certain no processes keep it alive after it is unlinked.
$removed = unlink( $file ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink
}
do_action( 'woocommerce_log_remove', $handle, $removed );
}
return $removed;
}

39
tests/unit-tests/log/log-handler-file.php
View File

@ -11,25 +11,25 @@ class WC_Tests_Log_Handler_File extends WC_Unit_Test_Case {
$log_files = array(
'unit-tests',
'log',
'_test_clear',
'_test_remove',
'_test_log_rotate',
'_test_log_rotate.0',
'_test_log_rotate.1',
'_test_log_rotate.2',
'_test_log_rotate.3',
'_test_log_rotate.4',
'_test_log_rotate.5',
'_test_log_rotate.6',
'_test_log_rotate.7',
'_test_log_rotate.8',
'_test_log_rotate.9',
'_test_clear',
'_test_remove',
'_test_log_rotate',
'_test_log_rotate.0',
'_test_log_rotate.1',
'_test_log_rotate.2',
'_test_log_rotate.3',
'_test_log_rotate.4',
'_test_log_rotate.5',
'_test_log_rotate.6',
'_test_log_rotate.7',
'_test_log_rotate.8',
'_test_log_rotate.9',
);
foreach ( $log_files as $file ) {
$file_path = WC_Log_Handler_File::get_log_file_path( $file );
if ( file_exists( $file_path ) && is_writable( $file_path ) ) {
unlink( $file_path );
if ( file_exists( $file_path ) && is_writable( $file_path ) ) { // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
unlink( $file_path ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink
}
}
parent::tearDown();
@ -47,7 +47,10 @@ class WC_Tests_Log_Handler_File extends WC_Unit_Test_Case {
public function test_legacy_format() {
$handler = new WC_Log_Handler_File( array( 'threshold' => 'debug' ) );
$handler->handle( time(), 'info', 'this is a message', array( 'source' => 'unit-tests', '_legacy' => true ) );
$handler->handle( time(), 'info', 'this is a message', array(
'source' => 'unit-tests',
'_legacy' => true,
) );
$this->assertStringMatchesFormat( '%d-%d-%d @ %d:%d:%d - %s', $this->read_content( 'unit-tests' ) );
$this->assertStringEndsWith( ' - this is a message' . PHP_EOL, $this->read_content( 'unit-tests' ) );
@ -75,7 +78,7 @@ class WC_Tests_Log_Handler_File extends WC_Unit_Test_Case {
$handler = new WC_Log_Handler_File();
$log_name = '_test_remove';
$handler->handle( time(), 'debug', 'debug', array( 'source' => $log_name ) );
$handler->remove( $log_name );
$handler->remove( wc_get_log_file_name( $log_name ) );
$this->assertFileNotExists( WC_Log_Handler_File::get_log_file_path( $log_name ) );
}
@ -172,7 +175,7 @@ class WC_Tests_Log_Handler_File extends WC_Unit_Test_Case {
// Write some files to ensure they've rotated correctly
for ( $i = 0; $i < 10; $i++ ) {
file_put_contents( WC_Log_Handler_File::get_log_file_path( $log_name . ".{$i}" ), $i );
file_put_contents( WC_Log_Handler_File::get_log_file_path( $log_name . ".{$i}" ), $i ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_file_put_contents
}
$context_source = array( 'source' => $log_name );