Your IP : 216.73.216.5
<?php
namespace WPForms\Pro\Admin\Entries\Export;
use Goodby\CSV\Export\Standard\CsvFileObject;
/**
* File-related routines.
*
* @since 1.5.5
*/
class File {
/**
* Instance of Export Class.
*
* @since 1.5.5
*
* @var \WPForms\Pro\Admin\Entries\Export\Export
*/
protected $export;
/**
* Constructor.
*
* @since 1.5.5
*
* @param \WPForms\Pro\Admin\Entries\Export\Export $export Instance of Export.
*/
public function __construct( $export ) {
$this->export = $export;
$this->hooks();
}
/**
* Register hooks.
*
* @since 1.5.5
*/
public function hooks() {
add_action( 'wpforms_tools_init', [ $this, 'entries_export_download_file' ] );
add_action( 'wpforms_tools_init', [ $this, 'single_entry_export_download_file' ] );
add_action( Export::TASK_CLEANUP, [ $this, 'remove_old_export_files' ] );
}
/**
* Export helper. Write data to a temporary .csv file.
*
* @since 1.5.5
*
* @param array $request_data Request data array.
*/
public function write_csv( $request_data ) {
$export_file = $this->get_tmpfname( $request_data );
if ( empty( $export_file ) ) {
return;
}
$csv = new CsvFileObject( $export_file, 'a' );
$enclosure = '"';
$csv->fputcsv( $request_data['columns_row'], $this->export->configuration['csv_export_separator'], $enclosure );
for ( $i = 1; $i <= $request_data['total_steps']; $i ++ ) {
$entries = wpforms()->entry->get_entries( $request_data['db_args'] );
foreach ( $this->export->ajax->get_entry_data( $entries ) as $entry ) {
$csv->fputcsv( $entry, $this->export->configuration['csv_export_separator'], $enclosure );
}
$request_data['db_args']['offset'] = $i * $this->export->configuration['entries_per_step'];
}
$csv->fflush();
}
/**
* Write data to .xlsx file.
*
* @since 1.6.5
*
* @param array $request_data Request data array.
*/
public function write_xlsx( $request_data ) {
$export_file = $this->get_tmpfname( $request_data );
if ( empty( $export_file ) ) {
return;
}
$writer = new \XLSXWriter();
$sheet_name = 'WPForms';
$widths = [];
foreach ( $request_data['columns_row'] as $header ) {
$widths[] = strlen( $header ) + 2;
}
$writer->writeSheetHeader( $sheet_name, array_fill_keys( $request_data['columns_row'], 'string' ), [ 'widths' => $widths ] );
for ( $i = 1; $i <= $request_data['total_steps']; $i ++ ) {
$entries = wpforms()->entry->get_entries( $request_data['db_args'] );
foreach ( $this->export->ajax->get_entry_data( $entries ) as $entry ) {
$writer->writeSheetRow( $sheet_name, $entry, [ 'wrap_text' => true ] );
}
$request_data['db_args']['offset'] = $i * $this->export->configuration['entries_per_step'];
}
$writer->writeToFile( $export_file );
}
/**
* Tmp files directory.
*
* @since 1.5.5
*
* @return string Temporary files directory path.
*/
public function get_tmpdir() {
$upload_dir = wpforms_upload_dir();
$upload_path = $upload_dir['path'];
$export_path = trailingslashit( $upload_path ) . 'export';
if ( ! file_exists( $export_path ) ) {
wp_mkdir_p( $export_path );
}
// Check if the .htaccess exists in the upload directory, if not - create it.
wpforms_create_upload_dir_htaccess_file();
// Check if the index.html exists in the directories, if not - create it.
wpforms_create_index_html_file( $upload_path );
wpforms_create_index_html_file( $export_path );
// Normalize slashes for Windows.
$export_path = wp_normalize_path( $export_path );
return $export_path;
}
/**
* Full pathname of the tmp file.
*
* @since 1.5.5
*
* @param array $request_data Request data.
*
* @return string Temporary file full pathname.
*/
public function get_tmpfname( $request_data ) {
if ( empty( $request_data ) ) {
return '';
}
$export_dir = $this->get_tmpdir();
$export_file = $export_dir . '/' . sanitize_key( $request_data['request_id'] );
touch( $export_file );
return $export_file;
}
/**
* Send HTTP headers for .csv file download.
*
* @since 1.5.5.1
*
* @param string $file_name File name.
*/
public function http_headers( $file_name ) {
$file_name = empty( $file_name ) ? 'wpforms-entries.csv' : $file_name;
nocache_headers();
header( 'Content-Description: File Transfer' );
header( 'Content-Type: text/csv' );
header( 'Content-Disposition: attachment; filename=' . $file_name );
header( 'Content-Transfer-Encoding: binary' );
}
/**
* Output the file.
*
* @since 1.6.0.2
*
* @param array $request_data Request data.
*
* @throws \Exception In case of file error.
*/
public function output_file( $request_data ) {
$export_file = $this->get_tmpfname( $request_data );
if ( empty( $export_file ) ) {
throw new \Exception( $this->export->errors['unknown_request'] );
}
clearstatcache( true, $export_file );
if ( ! is_readable( $export_file ) || is_dir( $export_file ) ) {
throw new \Exception( $this->export->errors['file_not_readable'] );
}
if ( @filesize( $export_file ) === 0 ) { //phpcs:ignore
throw new \Exception( $this->export->errors['file_empty'] );
}
$entry_suffix = ! empty( $request_data['db_args']['entry_id'] ) ? '-entry-' . $request_data['db_args']['entry_id'] : '';
$file_name = 'wpforms-' . $request_data['db_args']['form_id'] . '-' . sanitize_file_name( get_the_title( $request_data['db_args']['form_id'] ) ) . $entry_suffix . '-' . current_time( 'Y-m-d-H-i-s' ) . '.' . $request_data['type'];
$this->http_headers( $file_name );
readfile( $export_file ); // phpcs:ignore
// Schedule clean up.
$this->schedule_remove_old_export_files();
exit;
}
/**
* Entries export file download.
*
* @since 1.5.5
*
* @throws \Exception Try-catch.
*/
public function entries_export_download_file() {
$args = $this->export->data['get_args'];
if ( 'wpforms_tools_entries_export_download' !== $args['action'] ) {
return;
}
try {
// Security check.
if (
! wp_verify_nonce( $args['nonce'], 'wpforms-tools-entries-export-nonce' ) ||
! wpforms_current_user_can( 'view_entries' )
) {
throw new \Exception( $this->export->errors['security'] );
}
// Check for request_id.
if ( empty( $args['request_id'] ) ) {
throw new \Exception( $this->export->errors['unknown_request'] );
}
// Get stored request data.
$request_data = get_transient( 'wpforms-tools-entries-export-request-' . $args['request_id'] );
$this->output_file( $request_data );
} catch ( \Exception $e ) {
// phpcs:disable
$error = $this->export->errors['common'] . '<br>' . $e->getMessage();
if ( wpforms_debug() ) {
$error .= '<br><b>WPFORMS DEBUG</b>: ' . $e->__toString();
}
$error = str_replace( "'", ''', $error );
echo "
<script>
( function() {
var w = window;
if ( w.frameElement != null &&
w.frameElement.nodeName === 'IFRAME' &&
w.parent.jQuery )
{
w.parent.jQuery( w.parent.document ).trigger( 'csv_file_error', [ '" . str_replace( "\n", '', $error ) . "' ] );
w.parent.WPFormsEntriesExport.displaySubmitSpinner( false );
}
} )();
</script>
<pre>" . $error . '</pre>';
exit;
// phpcs:enable
}
}
/**
* Single entry export file download.
*
* @since 1.5.5
*
* @throws \Exception Try-catch.
*/
public function single_entry_export_download_file() {
$args = $this->export->data['get_args'];
if ( 'wpforms_tools_single_entry_export_download' !== $args['action'] ) {
return;
}
try {
// Check for form_id.
if ( empty( $args['form_id'] ) ) {
throw new \Exception( $this->export->errors['unknown_form_id'] );
}
// Check for entry_id.
if ( empty( $args['entry_id'] ) ) {
throw new \Exception( $this->export->errors['unknown_entry_id'] );
}
// Security check.
if (
! wp_verify_nonce( $args['nonce'], 'wpforms-tools-single-entry-export-nonce' ) ||
! wpforms_current_user_can( 'view_entries' )
) {
throw new \Exception( $this->export->errors['security'] );
}
// Get stored request data.
$request_data = $this->export->ajax->get_request_data( $args );
$this->export->ajax->request_data = $request_data;
if ( empty( $request_data['type'] ) || $request_data['type'] === 'csv' ) {
$this->write_csv( $request_data );
} elseif ( $request_data['type'] === 'xlsx' ) {
$this->write_xlsx( $request_data );
}
$this->output_file( $request_data );
} catch ( \Exception $e ) {
$error = $this->export->errors['common'] . '<br>' . $e->getMessage();
if ( wpforms_debug() ) {
$error .= '<br><b>WPFORMS DEBUG</b>: ' . $e->__toString();
}
\WPForms_Admin_Notice::error( $error );
}
}
/**
* Register a cleanup task to remove temp export files.
*
* @since 1.6.5
*/
public function schedule_remove_old_export_files() {
$tasks = wpforms()->get( 'tasks' );
if ( ! empty( $tasks->is_scheduled( Export::TASK_CLEANUP ) ) ) {
return;
}
$tasks->create( Export::TASK_CLEANUP )
->recurring( time() + 60, $this->export->configuration['request_data_ttl'] )
->params()
->register();
}
/**
* Garbage clearing.
* We need to clear only temporary files because transients are cleared automagically.
*
* @since 1.5.5
* @since 1.6.5 Stop using transients. Now we use ActionScheduler for this task.
*/
public function remove_old_export_files() {
clearstatcache();
$files = glob( $this->get_tmpdir() . '/*' );
$now = time();
foreach ( $files as $file ) {
if (
is_file( $file ) &&
pathinfo( $file, PATHINFO_BASENAME ) !== 'index.html' &&
( $now - filemtime( $file ) ) > $this->export->configuration['request_data_ttl']
) {
unlink( $file );
}
}
}
}