Add CSV download for individual log entries

Introduces a Download_Log_Service using league/csv to export single log entries as CSV files. Adds a 'Download' action to the log list and view pages, updates admin page logic to handle download requests, and updates dependencies to include league/csv.

Author: colinmurphy

plugins/wpgraphql-logging/composer.json

@@ -27,6 +27,7 @@
 	],
 	"require": {
 		"php": "^8.1",
+		"league/csv": "^9.9",
 		"monolog/monolog": "^3.9"
 	},
 	"minimum-stability": "dev",

plugins/wpgraphql-logging/composer.lock

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WPGraphQL\Logging\Admin\View\Download;
+
+use League\Csv\Writer;
+use WPGraphQL\Logging\Logger\Database\LogsRepository;
+
+/**
+ * Service for handling log downloads.
+ *
+ * @package WPGraphQL\Logging
+ *
+ * @since 0.0.1
+ */
+class Download_Log_Service {
+	/**
+	 * Generates and serves a CSV file for a single log entry.
+	 *
+	 * @param int $log_id The ID of the log to download.
+	 */
+	public function generate_csv( int $log_id ): void {
+		if ( ! current_user_can( 'manage_options' ) || ! is_admin() ) {
+			wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'wpgraphql-logging' ) );
+		}
+
+		if ( 0 === $log_id ) {
+			wp_die( esc_html__( 'Invalid log ID.', 'wpgraphql-logging' ) );
+		}
+
+		$repository = new LogsRepository();
+		$log        = $repository->get_log( $log_id );
+		if ( is_null( $log ) ) {
+			wp_die( esc_html__( 'Log not found.', 'wpgraphql-logging' ) );
+		}
+
+		// Set headers for CSV download.
+		$filename = apply_filters( 'wpgraphql_logging_csv_filename', 'graphql_log_' . $log_id . '.csv' );
+		header( 'Content-Type: text/csv; charset=utf-8' );
+		header( 'Content-Disposition: attachment; filename="' . $filename . '"' );
+		header( 'Cache-Control: must-revalidate, post-check=0, pre-check=0' );
+		header( 'Expires: 0' );
+
+		// Create CSV.
+		$output = fopen( 'php://output', 'w' );
+		if ( ! is_resource( $output ) ) {
+			wp_die( esc_html__( 'Failed to create CSV output.', 'wpgraphql-logging' ) );
+		}
+		$writer = Writer::createFromStream( $output );
+
+		$headers = [
+			'ID',
+			'Date',
+			'Level',
+			'Level Name',
+			'Message',
+			'Channel',
+			'Context',
+			'Extra',
+		];
+
+		$content = [
+			$log->get_id(),
+			$log->get_datetime(),
+			$log->get_level(),
+			$log->get_level_name(),
+			$log->get_message(),
+			wp_json_encode( $log->get_context() ),
+			$log->get_channel(),
+			wp_json_encode( $log->get_extra() ),
+		];
+
+
+		$headers = apply_filters( 'wpgraphql_logging_csv_headers', $headers, $log_id, $log );
+		$content = apply_filters( 'wpgraphql_logging_csv_content', $content, $log_id, $log );
+		$writer->insertOne( $headers );
+		$writer->insertOne( $content );
+		fclose( $output );
+		exit;
+	}
+}

plugins/wpgraphql-logging/src/Admin/View/Download/Download_Log_Service.php

@@ -235,13 +235,20 @@ public function column_cb( $item ): string {
 	public function column_id( DatabaseEntity $item ): string {
 		$url     = \WPGraphQL\Logging\Admin\View_Logs_Page::ADMIN_PAGE_SLUG;
 		$actions = [
-			'view' => sprintf(
+			'view'     => sprintf(
 				'<a href="?page=%s&action=%s&log=%d">%s</a>',
 				esc_attr( $url ),
 				'view',
 				$item->get_id(),
 				esc_html__( 'View', 'wpgraphql-logging' )
 			),
+			'download' => sprintf(
+				'<a href="?page=%s&action=%s&log=%d">%s</a>',
+				esc_attr( $url ),
+				'download',
+				$item->get_id(),
+				esc_html__( 'Download', 'wpgraphql-logging' )
+			),
 		];
 
 		return sprintf(

plugins/wpgraphql-logging/src/Admin/View/List/List_Table.php

@@ -9,7 +9,25 @@
  */
 ?>
 <div class="wrap">
-	<h1><?php esc_html_e( 'Log Entry', 'wpgraphql-logging' ); ?></h1>
+	<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 20px;">
+		<h1><?php esc_html_e( 'Log Entry', 'wpgraphql-logging' ); ?></h1>
+		<a href="
+		<?php
+		echo esc_url(
+			admin_url(
+				sprintf(
+					'admin.php?page=%s&action=%s&log=%d',
+					\WPGraphQL\Logging\Admin\View_Logs_Page::ADMIN_PAGE_SLUG,
+					'download',
+					$log->get_id()
+				)
+			)
+		);
+		?>
+		" class="button">
+			<?php esc_html_e( 'Download Log', 'wpgraphql-logging' ); ?>
+		</a>
+	</div>
 
 	<table class="widefat striped">
 		<tbody>

plugins/wpgraphql-logging/src/Admin/View/List/Templates/wpgraphql-logger-view.php

@@ -4,6 +4,7 @@
 
 namespace WPGraphQL\Logging\Admin;
 
+use WPGraphQL\Logging\Admin\View\Download\Download_Log_Service;
 use WPGraphQL\Logging\Admin\View\List\List_Table;
 use WPGraphQL\Logging\Logger\Database\LogsRepository;
 
@@ -79,7 +80,7 @@ public function register_settings_page(): void {
 		);
 
 		// Updates the list table when filters are applied.
-		add_action( 'load-' . $menu_page, [ $this, 'process_filters_redirect' ], 10, 0 );
+		add_action( 'load-' . $menu_page, [ $this, 'process_page_actions_before_rendering' ], 10, 0 );
 	}
 
 	/**
@@ -93,12 +94,28 @@ public function render_admin_page(): void {
 			case 'view':
 				$this->render_view_page();
 				break;
+			case 'download':
+				// Handled in process_page_actions_before_rendering.
+				break;
 			default:
 				$this->render_list_page();
 				break;
 		}
 	}
 
+	/**
+	 * Processes actions for the page, such as filtering and downloading logs.
+	 * This runs before any HTML is output.
+	 */
+	public function process_page_actions_before_rendering(): void {
+		// Check for a download request.
+		if ( isset( $_GET['action'] ) && 'download' === $_GET['action'] ) { // @phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$this->process_log_download();
+		}
+
+		$this->process_filters_redirect();
+	}
+
 	/**
 	 * Process filter form submission and redirect to a GET request.
 	 * This runs before any HTML is output.
@@ -173,6 +190,19 @@ protected function render_list_page(): void {
 		require_once $list_template; // @phpcs:ignore WordPressVIPMinimum.Files.IncludingFile.UsingVariable
 	}
 
+		/**
+		 * Renders the list page for log entries.
+		 */
+	protected function process_log_download(): void {
+		if ( ! current_user_can( 'manage_options' ) || ! is_admin() ) {
+			wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'wpgraphql-logging' ) );
+		}
+
+		$log_id     = isset( $_GET['log'] ) ? absint( $_GET['log'] ) : 0; // @phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$downloader = new Download_Log_Service();
+		$downloader->generate_csv( $log_id );
+	}
+
 	/**
 	 * Renders the view page for a single log entry.
 	 */