Click to copy Log (#804)

* Add Click to copy logs

* Filter for logs max line

* Replace esc_html_* functions

Author: timotei-litespeed

assets/js/litespeed-cache-admin.js

@@ -581,3 +581,12 @@ function litespeed_add_zero(i) {
 	}
 	return i;
 }
+
+function litespeed_copy_to_clipboard(elementId) {
+	var range = document.createRange();
+	range.selectNode(document.getElementById(elementId));
+	window.getSelection().removeAllRanges();
+	window.getSelection().addRange(range);
+	document.execCommand('copy');
+	window.getSelection().removeAllRanges();
+}

src/doc.cls.php

@@ -174,7 +174,7 @@ public static function queue_issues($return = false)
 	{
 		$str =
 			'<div class="litespeed-desc">' .
-			esc_html__('The queue is processed asynchronously. It may take time.', 'litespeed-cache') .
+			__('The queue is processed asynchronously. It may take time.', 'litespeed-cache') .
 			self::learn_more('https://docs.litespeedtech.com/lscache/lscwp/troubleshoot/#quiccloud-queue-issues', false, false, false, true) .
 			'</div>';
 		if ($return) {

thirdparty/litespeed-check.cls.php

@@ -71,7 +71,7 @@ public static function detect()
 				'<div ' .
 					self::$_msg_id .
 					'>' .
-					esc_html__('Please consider disabling the following detected plugins, as they may conflict with LiteSpeed Cache:', 'litespeed-cache') .
+					__('Please consider disabling the following detected plugins, as they may conflict with LiteSpeed Cache:', 'litespeed-cache') .
 					'<p style="color: red; font-weight: 700;">' .
 					'PageSpeed Ninja' .
 					'</p>' .
@@ -122,7 +122,7 @@ public static function incompatible_plugin_notice($plugin, $_network_wide, $acti
 			'<div ' .
 				self::$_msg_id .
 				'>' .
-				esc_html__('Please consider disabling the following detected plugins, as they may conflict with LiteSpeed Cache:', 'litespeed-cache') .
+				__('Please consider disabling the following detected plugins, as they may conflict with LiteSpeed Cache:', 'litespeed-cache') .
 				'<p style="color: red; font-weight: 700;">' .
 				implode(', ', $active_incompatible_plugins) .
 				'</p>' .

tpl/presets/standard.tpl.php

@@ -84,11 +84,11 @@
 ?>
 
 <h3 class="litespeed-title-short">
-	<?php esc_html_e( 'LiteSpeed Cache Standard Presets', 'litespeed-cache' ); ?>
+	<?php _e( 'LiteSpeed Cache Standard Presets', 'litespeed-cache' ); ?>
 	<?php Doc::learn_more( 'https://docs.litespeedtech.com/lscache/lscwp/presets/#standard-tab' ); ?>
 </h3>
 
-<p><?php esc_html_e( 'Use an official LiteSpeed-designed Preset to configure your site in one click. Try no-risk caching essentials, extreme optimization, or something in between.', 'litespeed-cache' ); ?></p>
+<p><?php _e( 'Use an official LiteSpeed-designed Preset to configure your site in one click. Try no-risk caching essentials, extreme optimization, or something in between.', 'litespeed-cache' ); ?></p>
 
 <div class="litespeed-comparison-cards">
 	<?php
@@ -113,7 +113,7 @@
 				</ul>
 			</div>
 			<div class="litespeed-card-footer">
-				<h4><?php esc_html_e( 'Who should use this preset?', 'litespeed-cache' ); ?></h4>
+				<h4><?php _e( 'Who should use this preset?', 'litespeed-cache' ); ?></h4>
 				<?php foreach ( $presets[ $name ]['footer'] as $line ) : ?>
 				<p><?php echo esc_html( $line ); ?></p>
 				<?php endforeach; ?>
@@ -123,9 +123,9 @@
 			<a
 				href="<?php echo Utility::build_url( Router::ACTION_PRESET, Preset::TYPE_APPLY, false, null, array( 'preset' => $name ) ); ?>"
 				class="button <?php echo $button_class; ?>"
-				data-litespeed-cfm="<?php printf( esc_html__( 'This will back up your current settings and replace them with the %1$s preset settings. Do you want to continue?', 'litespeed-cache' ), $title ); ?>"
+				data-litespeed-cfm="<?php printf( __( 'This will back up your current settings and replace them with the %1$s preset settings. Do you want to continue?', 'litespeed-cache' ), $title ); ?>"
 			>
-				<?php esc_html_e( 'Apply Preset', 'litespeed-cache' ); ?>
+				<?php _e( 'Apply Preset', 'litespeed-cache' ); ?>
 			</a>
 		</div>
 	</div>
@@ -155,7 +155,7 @@ class="button <?php echo $button_class; ?>"
 if ( ! empty( $summary['preset'] ) || ! empty( $backups ) ) :
 ?>
 <h3 class="litespeed-title-short">
-	<?php esc_html_e( 'History', 'litespeed-cache' ); ?>
+	<?php _e( 'History', 'litespeed-cache' ); ?>
 </h3>
 <?php endif; ?>
 
@@ -165,12 +165,12 @@ class="button <?php echo $button_class; ?>"
 	$name = strtolower( $summary['preset'] );
 	$time = trim( Utility::readable_time( $summary['preset_timestamp'] ) );
 	if ( 'error' === $name ) {
-		printf( esc_html__( 'Error: Failed to apply the settings %1$s', 'litespeed-cache' ), $time );
+		printf( __( 'Error: Failed to apply the settings %1$s', 'litespeed-cache' ), $time );
 	} elseif ( 'backup' === $name ) {
-		printf( esc_html__( 'Restored backup settings %1$s', 'litespeed-cache' ), $time );
+		printf( __( 'Restored backup settings %1$s', 'litespeed-cache' ), $time );
 	} else {
 		printf(
-			esc_html__( 'Applied the %1$s preset %2$s', 'litespeed-cache' ),
+			__( 'Applied the %1$s preset %2$s', 'litespeed-cache' ),
 			'<strong>' . esc_html( $presets[ $name ]['title'] ) . '</strong>',
 			$time
 		);
@@ -181,13 +181,13 @@ class="button <?php echo $button_class; ?>"
 
 <?php foreach ( $backups as $backup ) : ?>
 <p>
-	<?php printf( esc_html__( 'Backup created %1$s before applying the %2$s preset', 'litespeed-cache' ), $backup['time'], $backup['title'] ); ?>
+	<?php printf( __( 'Backup created %1$s before applying the %2$s preset', 'litespeed-cache' ), $backup['time'], $backup['title'] ); ?>
 	<a
 		href="<?php echo Utility::build_url( Router::ACTION_PRESET, Preset::TYPE_RESTORE, false, null, array( 'timestamp' => $backup['timestamp'] ) ); ?>"
 		class="litespeed-left10"
-		data-litespeed-cfm="<?php printf( esc_html__( 'This will restore the backup settings created %1$s before applying the %2$s preset. Any changes made since then will be lost. Do you want to continue?', 'litespeed-cache' ), $backup['time'], $backup['title'] ); ?>"
+		data-litespeed-cfm="<?php printf( __( 'This will restore the backup settings created %1$s before applying the %2$s preset. Any changes made since then will be lost. Do you want to continue?', 'litespeed-cache' ), $backup['time'], $backup['title'] ); ?>"
 	>
-		<?php esc_html_e( 'Restore Settings', 'litespeed-cache' ); ?>
+		<?php _e( 'Restore Settings', 'litespeed-cache' ); ?>
 	</a>
 </p>
 <?php

tpl/toolbox/log_viewer.tpl.php

@@ -8,17 +8,17 @@
 	array(
 		array(
 			'name' => 'debug',
-			'label' => esc_html__('Debug Log', 'litespeed-cache'),
+			'label' => __('Debug Log', 'litespeed-cache'),
 			'accesskey' => 'A',
 		),
 		array(
 			'name' => 'purge',
-			'label' => esc_html__('Purge Log', 'litespeed-cache'),
+			'label' => __('Purge Log', 'litespeed-cache'),
 			'accesskey' => 'B',
 		),
 		array(
 			'name' => 'crawler',
-			'label' => esc_html__('Crawler Log', 'litespeed-cache'),
+			'label' => __('Crawler Log', 'litespeed-cache'),
 			'accesskey' => 'C',
 		),
 	);
@@ -48,7 +48,9 @@ function subnav_link($item)
 		: '';
 	$label = isset($item['label']) ? $item['label'] : $item['name'];
 
-	return "<a href='{$url}' class='{$class}' {$subtab} {$accesskey}>{$label}</a>";
+	$on_click = isset($item['onClick']) ? ' onClick="' . $item['onClick'].'"' : '';
+
+	return "<a href='{$url}' class='{$class}' {$subtab} {$accesskey} {$on_click}>{$label}</a>";
 }
 
 /**
@@ -59,7 +61,7 @@ function clear_logs_link($accesskey = null)
 {
 	$item =
 		array(
-			'label' => esc_html__('Clear Logs', 'litespeed-cache'),
+			'label' => __('Clear Logs', 'litespeed-cache'),
 			'url' => Utility::build_url(Router::ACTION_DEBUG2, Debug2::TYPE_CLEAR_LOG),
 		);
 	if (null !== $accesskey) {
@@ -68,6 +70,21 @@ function clear_logs_link($accesskey = null)
 	echo subnav_link($item);
 }
 
+/**
+ * Print a button to copy current log
+ * @since  7.0
+ */
+function copy_logs_link($id_to_copy)
+{
+	$item = array(
+			'name' => 'copy_links',
+			'label' => __('Copy Log', 'litespeed-cache'),
+			'cssClass' => 'litespeed-info-button',
+			'onClick' => "litespeed_copy_to_clipboard('".$id_to_copy."')"
+		);
+	return subnav_link($item);
+}
+
 $subnav_links = array();
 $log_views = array();
 
@@ -76,22 +93,25 @@ function clear_logs_link($accesskey = null)
 
 	$file = $this->cls('Debug2')->path($log['name']);
 	$lines = File::count_lines($file);
-	$start = $lines > 1000 ? $lines - 1000 : 0;
+	$max_lines = apply_filters('litespeed_debug_show_max_lines', 1000);
+	$start = $lines > $max_lines ? $lines - $max_lines : 0;
 	$lines = File::read($file, $start);
 	$lines = $lines ? trim(implode("\n", $lines)) : '';
+	
+	$log_body_id = 'litespeed-log-' . $log['name'];
 
 	$log_views[] =
 		"<div class='litespeed-log-view-wrapper' data-litespeed-sublayout='{$log['name']}_log'>"
-		. "<h3 class='litespeed-title'>{$log['label']}</h3>"
-		. '<div class="litespeed-log-body">'
+		. "<h3 class='litespeed-title'>{$log['label']}" . copy_logs_link($log_body_id) ."</h3>"
+		. '<div class="litespeed-log-body" id="' . $log_body_id . '">'
 		. nl2br(htmlspecialchars($lines))
 		. '</div>'
 		. '</div>';
 }
 ?>
 
 <h3 class="litespeed-title">
-	<?php esc_html_e('LiteSpeed Logs', 'litespeed-cache'); ?>
+	<?php _e('LiteSpeed Logs', 'litespeed-cache'); ?>
 	<?php Doc::learn_more('https://docs.litespeedtech.com/lscache/lscwp/toolbox/#log-view-tab'); ?>
 </h3>