abstract-wc-csv-batch-exporter.php
<?php
/**
* Handles Batch CSV export.
*
* Based on https://pippinsplugins.com/batch-processing-for-big-data/
*
* @package WooCommerce\Export
* @version 3.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Include dependencies.
*/
if ( ! class_exists( 'WC_CSV_Exporter', false ) ) {
require_once WC_ABSPATH . 'includes/export/abstract-wc-csv-exporter.php';
}
/**
* WC_CSV_Exporter Class.
*/
abstract class WC_CSV_Batch_Exporter extends WC_CSV_Exporter {
/**
* Page being exported
*
* @var integer
*/
protected $page = 1;
/**
* Constructor.
*/
public function __construct() {
$this->column_names = $this->get_default_column_names();
}
/**
* Get file path to export to.
*
* @return string
*/
protected function get_file_path() {
$upload_dir = wp_upload_dir();
return trailingslashit( $upload_dir['basedir'] ) . $this->get_filename();
}
/**
* Get CSV headers row file path to export to.
*
* @return string
*/
protected function get_headers_row_file_path() {
return $this->get_file_path() . '.headers';
}
/**
* Get the contents of the CSV headers row file. Defaults to the original known headers.
*
* @since 3.1.0
* @return string
*/
public function get_headers_row_file() {
$file = chr( 239 ) . chr( 187 ) . chr( 191 ) . $this->export_column_headers();
if ( @file_exists( $this->get_headers_row_file_path() ) ) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
$file = @file_get_contents( $this->get_headers_row_file_path() ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.WP.AlternativeFunctions.file_system_read_file_get_contents
}
return $file;
}
/**
* Get the file contents.
*
* @since 3.1.0
* @return string
*/
public function get_file() {
$file = '';
if ( @file_exists( $this->get_file_path() ) ) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
$file = @file_get_contents( $this->get_file_path() ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.WP.AlternativeFunctions.file_system_read_file_get_contents
} else {
@file_put_contents( $this->get_file_path(), '' ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_file_put_contents, Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
@chmod( $this->get_file_path(), 0664 ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.chmod_chmod, WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents, Generic.PHP.NoSilencedErrors.Discouraged
}
return $file;
}
/**
* Serve the file and remove once sent to the client.
*
* @since 3.1.0
*/
public function export() {
$this->send_headers();
$this->send_content( $this->get_headers_row_file() . $this->get_file() );
@unlink( $this->get_file_path() ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink, Generic.PHP.NoSilencedErrors.Discouraged
@unlink( $this->get_headers_row_file_path() ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink, Generic.PHP.NoSilencedErrors.Discouraged
die();
}
/**
* Generate the CSV file.
*
* @since 3.1.0
*/
public function generate_file() {
if ( 1 === $this->get_page() ) {
if ( file_exists( $this->get_file_path() ) ) {
wp_delete_file( $this->get_file_path() );
}
// We need to initialize the file here.
$this->get_file();
}
$this->prepare_data_to_export();
$this->write_csv_data( $this->get_csv_data() );
}
/**
* Write data to the file.
*
* @since 3.1.0
* @param string $data Data.
*/
protected function write_csv_data( $data ) {
$log_context = array( 'source' => 'wc-csv-exporter' );
if ( ! file_exists( $this->get_file_path() ) || ! is_writeable( $this->get_file_path() ) ) {
wc_get_logger()->error(
sprintf(
/* translators: %s is file path. */
__( 'Unable to create or write to %s during CSV export. Please check file permissions.', 'woocommerce' ),
$this->get_file_path()
),
$log_context
);
return false;
}
/**
* Filters the mode parameter which specifies the type of access you require to the stream (used during file
* writing for CSV exports). Defaults to 'a' (append, write-only, placing the file pointer at the end of the
* file), which is all CSV export needs and is supported by the widest range of stream wrappers.
*
* @see https://www.php.net/manual/en/function.fopen.php
* @since 6.8.0
*
* @param string $fopen_mode One of (r, r+, w, w+, a, a+, x, x+, c, c+), optionally followed by flags such as "b", "t" or "e". Defaults to "a" (append, write-only) for broad stream-wrapper compatibility.
*/
$fopen_mode = apply_filters( 'woocommerce_csv_exporter_fopen_mode', 'a' );
$fp = fopen( $this->get_file_path(), $fopen_mode );
if ( $fp ) {
// WP_Filesystem has no streaming write API, so it would mean rewriting the whole export on every batch.
$bytes_written = fwrite( $fp, $data ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fwrite
// Append-mode stream wrappers may buffer locally and only transfer the data on close, so closing can fail too.
$closed = fclose( $fp ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fclose
if ( false === $bytes_written || strlen( $data ) !== $bytes_written || ! $closed ) {
wc_get_logger()->error(
sprintf(
/* translators: %s: file path */
__( 'Failed to write CSV export data to %s. The exported file may be incomplete.', 'woocommerce' ),
$this->get_file_path()
),
$log_context
);
}
} else {
// fopen() raises a warning when it fails, so the last PHP error usually explains why (permissions, an
// invalid mode, or a stream wrapper that doesn't support the requested mode).
$last_error = error_get_last();
wc_get_logger()->error(
sprintf(
/* translators: 1: file path, 2: fopen mode, 3: last PHP error message */
__( 'Unable to open file for writing: %1$s (mode: %2$s). Last PHP error: %3$s', 'woocommerce' ),
$this->get_file_path(),
$fopen_mode,
isset( $last_error['message'] ) ? $last_error['message'] : 'n/a'
),
$log_context
);
}
// Add all columns when finished.
if ( 100 === $this->get_percent_complete() ) {
$header = chr( 239 ) . chr( 187 ) . chr( 191 ) . $this->export_column_headers();
// We need to use a temporary file to store headers, this will make our life so much easier.
@file_put_contents( $this->get_headers_row_file_path(), $header ); //phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_file_put_contents, Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
}
}
/**
* Get page.
*
* @since 3.1.0
* @return int
*/
public function get_page() {
return $this->page;
}
/**
* Set page.
*
* @since 3.1.0
* @param int $page Page Nr.
*/
public function set_page( $page ) {
$this->page = absint( $page );
}
/**
* Get count of records exported.
*
* @since 3.1.0
* @return int
*/
public function get_total_exported() {
return ( ( $this->get_page() - 1 ) * $this->get_limit() ) + $this->exported_row_count;
}
/**
* Get total % complete.
*
* @since 3.1.0
* @return int
*/
public function get_percent_complete() {
return $this->total_rows ? (int) floor( ( $this->get_total_exported() / $this->total_rows ) * 100 ) : 100;
}
}
