Your IP : 216.73.217.176
class-evf-entry-csv-exporter.php 0000666 00000025647 15176450571 0012773 0 ustar 00 <?php
/**
* Handles entry CSV export.
*
* @package EverestForms\Export
* @since 1.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Include dependencies.
*/
if ( ! class_exists( 'EVF_CSV_Exporter', false ) ) {
require_once EVF_ABSPATH . 'includes/export/abstract-evf-csv-exporter.php';
}
/**
* EVF_Entry_CSV_Exporter Class.
*/
class EVF_Entry_CSV_Exporter extends EVF_CSV_Exporter {
/**
* Form ID.
*
* @var int|mixed
*/
public $form_id;
/**
* Entry ID.
*
* @var int|mixed
*/
public $entry_id;
/**
* Type of export used in filter names.
*
* @var string
*/
protected $export_type = 'entry';
/**
* Constructor.
*
* @param int $form_id Form ID.
* @param int $entry_id Entry ID.
*/
public function __construct( $form_id = '', $entry_id = '' ) {
$this->form_id = absint( $form_id );
$this->entry_id = absint( $entry_id );
$this->column_names = $this->get_default_column_names();
}
/**
* Return an array of columns to export.
*
* @return array
*/
public function get_default_column_names() {
$columns = array();
$form_obj = evf()->form->get( $this->form_id );
$form_data = ! empty( $form_obj->post_content ) ? evf_decode( $form_obj->post_content ) : '';
// Set Entry ID at first.
$columns['entry_id'] = esc_html__( 'ID', 'everest-forms' );
// Add whitelisted fields to export columns.
if ( ! empty( $form_data['form_fields'] ) ) {
foreach ( $form_data['form_fields'] as $field ) {
if ( ! in_array( $field['type'], array( 'html', 'title', 'captcha' ), true ) ) {
$columns[ $field['meta-key'] ] = evf_clean( $field['label'] );
}
}
}
// Set the default columns.
$columns['status'] = esc_html__( 'Status', 'everest-forms' );
$columns['date_created'] = esc_html__( 'Date Created', 'everest-forms' );
$columns['date_created_gmt'] = esc_html__( 'Date Created GMT', 'everest-forms' );
// If user details are disabled globally discard the IP and UA.
if ( 'yes' !== get_option( 'everest_forms_disable_user_details' ) ) {
$columns['user_device'] = esc_html__( 'User Device', 'everest-forms' );
$columns['user_ip_address'] = esc_html__( 'User IP Address', 'everest-forms' );
}
return apply_filters( "everest_forms_export_{$this->export_type}_default_columns", $columns );
}
/**
* Prepare data for export.
*
* @since 1.6.0
*/
public function prepare_data_to_export() {
$this->row_data = array();
if ( $this->entry_id ) {
$entry = evf_get_entry( $this->entry_id );
$this->row_data[] = $this->generate_row_data( $entry );
} else {
$entry_ids = evf_search_entries(
array(
'limit' => -1,
'order' => 'ASC',
'form_id' => $this->form_id,
)
);
// Get the entries.
$entries = array_map( 'evf_get_entry', $entry_ids );
foreach ( $entries as $entry ) {
$this->row_data[] = $this->generate_row_data( $entry );
}
}
return $this->row_data;
}
/**
* Prepare and get quiz report data in CSV format.
*/
public function get_quiz_report() {
$form_data = EVF()->form->get(
absint( $this->form_id ),
array(
'content_only' => true,
)
);
$form_fields = isset( $form_data['form_fields'] ) ? $form_data['form_fields'] : array();
$entry = evf_get_entry( $this->entry_id );
$columns = array( 'ID' );
$row = array( $this->entry_id );
$total_score = 0;
$respondent_score = 0;
$obtained_score = 0;
$include_all_fields = apply_filters( 'evf_include_all_fields_in_quiz_report_csv', false );
// Add form fields in the CSV content.
foreach ( $form_fields as $field_id => $field ) {
$quiz_enabled = isset( $field['quiz_status'] ) && '1' === $field['quiz_status'] ? true : false;
// Move onto next field if this field has quiz disabled and non-quiz fields are to be excluded.
if ( false === $include_all_fields && false === $quiz_enabled ) {
continue;
}
$meta_key = isset( $field['meta-key'] ) ? $field['meta-key'] : '';
$given_answer = isset( $entry->meta[ $meta_key ] ) ? $entry->meta[ $meta_key ] : null;
$correct_answer = isset( $field['correct_answer'] ) ? $field['correct_answer'] : array();
$field_score = empty( $field['score'] ) ? 0 : $field['score'];
$score = 0;
$total_score += $field_score;
$is_correct = false;
if ( ! is_null( $given_answer ) ) {
$respondent_score += $field_score;
if ( ! empty( $correct_answer ) ) {
// Determine if the given answer is correct.
if ( 'select' === $field['type'] ) {
foreach ( $correct_answer as $answer_key => $answer_status ) {
$choice = $field['choices'][ $answer_key ]['label'];
if ( $given_answer === $choice ) {
$is_correct = true;
break;
}
}
} elseif ( 'radio' === $field['type'] ) {
$correct_answer_key = array_keys( $correct_answer )[0];
$correct_answer = $field['choices'][ $correct_answer_key ]['label'];
$given_answer = maybe_unserialize( $given_answer )['label'];
$is_correct = ( $given_answer === $correct_answer );
} elseif ( 'checkbox' === $field['type'] ) {
$given_answer_data = maybe_unserialize( $given_answer )['label'];
$is_correct = true;
$choices = $field['choices'];
$correct_answer_keys = array_keys( $correct_answer );
$correct_answers = array();
$given_answers = array();
// Prepare list of correct answers.
foreach ( $correct_answer_keys as $correct_answer_key ) {
$correct_answers[] = $choices[ $correct_answer_key ]['label'];
}
// Prepare list of given answers.
foreach ( $given_answer_data as $given_answer ) {
$given_answers[] = $given_answer;
}
// See if all the given answers are correct answers.
foreach ( $given_answers as $given_answer ) {
if ( ! in_array( $given_answer, $correct_answers, true ) ) {
$is_correct = false;
break;
}
}
}
}
}
// Add score if the given answer is correct.
if ( true === $is_correct ) {
$score = $field_score;
$obtained_score += $field_score;
}
$columns[] = $this->sanitize_csv_cell_data( $field['label'] );
$row[] = $this->sanitize_csv_cell_data( $score );
}
// Add extra columns.
$extra_data = array(
'Total Score' => $total_score,
'Respondent Score' => $respondent_score,
'Obtained Score' => $obtained_score,
);
foreach ( $extra_data as $key => $value ) {
$columns[] = $this->sanitize_csv_cell_data( $key );
$row[] = $this->sanitize_csv_cell_data( $value );
}
ob_start();
echo implode( ', ', $columns );
echo "\n";
echo implode( ', ', $row );
return ob_get_clean();
}
/**
* Sanitize data for a cell in CSV.
*
* @param string $str Data to sanitize.
*/
public function sanitize_csv_cell_data( $str ) {
$str = (string) $str;
$str = str_replace( '"', '""', $str );
$str = '"' . $str . '"';
return $str;
}
/**
* Take a entry id and generate row data from it for export.
*
* @param object $entry Entry object.
* @return array
*/
protected function generate_row_data( $entry ) {
$columns = $this->get_column_names();
$row = array();
foreach ( $columns as $column_id => $column_name ) {
$column_id = strstr( $column_id, ':' ) ? current( explode( ':', $column_id ) ) : $column_id;
$value = '';
$raw_value = '';
if ( isset( $entry->meta[ $column_id ] ) ) {
// Filter for entry meta data.
$value = $entry->meta[ $column_id ];
$raw_value = $entry->meta[ $column_id ];
if ( is_serialized( $value ) ) {
$value = $this->implode_values( maybe_unserialize( $value ) );
}
$value = apply_filters( 'everest_forms_html_field_value', $value, $entry->meta[ $column_id ], $entry, 'export-csv', $column_id );
} elseif ( is_callable( array( $this, "get_column_value_{$column_id}" ) ) ) {
// Handle special columns which don't map 1:1 to entry data.
$value = $this->{"get_column_value_{$column_id}"}( $entry );
$raw_value = $value;
}
$column_type = $this->get_entry_type( $column_id, $entry );
$row[ $column_id ] = apply_filters( 'everest_forms_format_csv_field_data', preg_match( '/textarea/', $column_type ) ? sanitize_textarea_field( $value ) : sanitize_text_field( $value ), $raw_value, $column_id, $column_name, $columns, $entry );
}
return apply_filters( 'everest_forms_entry_export_row_data', $row, $entry );
}
/**
* Get entry type.
*
* @param string $column_id meta key of the column.
* @param object $entry Entry being exported.
* @return string
*/
protected function get_entry_type( $column_id, $entry ) {
$fields = json_decode( $entry->fields, 1 );
if ( is_null( $fields ) || ! is_array( $fields ) ) {
return false; // Conditional false with fake values.
}
foreach ( $fields as $field ) {
if ( $column_id === $field['meta_key'] ) {
return $field['type'];
}
}
return false;
}
/**
* Get entry id value.
*
* @param object $entry Entry being exported.
* @return int
*/
protected function get_column_value_entry_id( $entry ) {
return absint( $entry->entry_id );
}
/**
* Get entry status value.
*
* @param object $entry Entry being exported.
* @return string
*/
protected function get_column_value_status( $entry ) {
$statuses = evf_get_entry_statuses();
if ( isset( $statuses[ $entry->status ] ) ) {
return $statuses[ $entry->status ];
}
return $entry->status;
}
/**
* Get date created value.
*
* @param object $entry Entry being exported.
* @return string
*/
protected function get_column_value_date_created( $entry ) {
$timestamp = false;
if ( isset( $entry->date_created ) ) {
$timestamp = strtotime( $entry->date_created );
}
/* translators: 1: entry date 2: entry time */
return sprintf( esc_html__( '%1$s %2$s', 'everest-forms' ), date_i18n( evf_date_format(), $timestamp ), date_i18n( evf_time_format(), $timestamp ) );
}
/**
* Get GMT date created value.
*
* @param object $entry Entry being exported.
* @return string
*/
protected function get_column_value_date_created_gmt( $entry ) {
$timestamp = false;
if ( isset( $entry->date_created ) ) {
$timestamp = strtotime( $entry->date_created ) + ( get_option( 'gmt_offset' ) * 3600 );
}
/* translators: 1: entry date 2: entry time */
return sprintf( esc_html__( '%1$s %2$s', 'everest-forms' ), date_i18n( evf_date_format(), $timestamp ), date_i18n( evf_time_format(), $timestamp ) );
}
/**
* Get entry user device value.
*
* @param object $entry Entry being exported.
* @return string
*/
protected function get_column_value_user_device( $entry ) {
return sanitize_text_field( $entry->user_device );
}
/**
* Get entry user IP address value.
*
* @param object $entry Entry being exported.
* @return string
*/
protected function get_column_value_user_ip_address( $entry ) {
return sanitize_text_field( $entry->user_ip_address );
}
}
abstract-evf-csv-exporter.php 0000666 00000023163 15176450571 0012321 0 ustar 00 <?php
/**
* Handles CSV export.
*
* @package EverestForms/Export
* @version 1.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* EVF_CSV_Exporter Class.
*/
abstract class EVF_CSV_Exporter {
/**
* Type of export used in filter names.
*
* @var string
*/
protected $export_type = '';
/**
* Filename to export to.
*
* @var string
*/
protected $filename = 'evf-export.csv';
/**
* Raw data to export.
*
* @var array
*/
protected $row_data = array();
/**
* Columns ids and names.
*
* @var array
*/
protected $column_names = array();
/**
* List of columns to export, or empty for all.
*
* @var array
*/
protected $columns_to_export = array();
/**
* The delimiter parameter sets the field delimiter (one character only).
*
* @var string
*/
protected $delimiter = ',';
/**
* Prepare data that will be exported.
*/
abstract public function prepare_data_to_export();
/**
* Get quiz report in CSV format.
*/
abstract public function get_quiz_report();
/**
* Return the delimiter to use in CSV file
*
* @since 1.7.0
* @return string
*/
public function get_delimiter() {
return apply_filters( "everest_forms_{$this->export_type}_export_delimiter", $this->delimiter );
}
/**
* Return an array of supported column names and ids.
*
* @return array
*/
public function get_column_names() {
return apply_filters( "everest_forms_{$this->export_type}_export_column_names", $this->column_names, $this );
}
/**
* Set column names.
*
* @param array $column_names Column names array.
*/
public function set_column_names( $column_names ) {
$this->column_names = array();
foreach ( $column_names as $column_id => $column_name ) {
$this->column_names[ evf_clean( $column_id ) ] = evf_clean( $column_name );
}
}
/**
* Return an array of columns to export.
*
* @return array
*/
public function get_columns_to_export() {
return $this->columns_to_export;
}
/**
* Set columns to export.
*
* @param array $columns Columns array.
*/
public function set_columns_to_export( $columns ) {
$this->columns_to_export = array_map( 'evf_clean', $columns );
}
/**
* See if a column is to be exported or not.
*
* @param string $column_id ID of the column being exported.
* @return boolean
*/
public function is_column_exporting( $column_id ) {
$column_id = strstr( $column_id, ':' ) ? current( explode( ':', $column_id ) ) : $column_id;
$columns_to_export = $this->get_columns_to_export();
if ( empty( $columns_to_export ) ) {
return true;
}
if ( in_array( $column_id, $columns_to_export, true ) || 'meta' === $column_id ) {
return true;
}
return false;
}
/**
* Return default columns.
*
* @return array
*/
public function get_default_column_names() {
return array();
}
/**
* Do the export.
*
* @since 1.3.0
*/
public function export() {
$this->prepare_data_to_export();
$this->send_headers();
$this->send_content( chr( 239 ) . chr( 187 ) . chr( 191 ) . $this->export_column_headers() . $this->get_csv_data() );
die();
}
/**
* Export quiz report.
*/
public function export_quiz_report() {
$this->send_headers();
$this->send_content( $this->get_quiz_report() );
die();
}
/**
* Set the export headers.
*
* @since 1.3.0
*/
public function send_headers() {
if ( function_exists( 'gc_enable' ) ) {
gc_enable(); // phpcs:ignore PHPCompatibility.FunctionUse.gc_enableFound
}
if ( function_exists( 'apache_setenv' ) ) {
@apache_setenv( 'no-gzip', 1 ); // @codingStandardsIgnoreLine
}
@ini_set( 'zlib.output_compression', 'Off' ); // @codingStandardsIgnoreLine
@ini_set( 'output_buffering', 'Off' ); // @codingStandardsIgnoreLine
@ini_set( 'output_handler', '' ); // @codingStandardsIgnoreLine
ignore_user_abort( true );
evf_set_time_limit( 0 );
evf_nocache_headers();
header( 'Content-Type: text/csv; charset=utf-8' );
header( 'Content-Disposition: attachment; filename=' . $this->get_filename() );
header( 'Pragma: no-cache' );
header( 'Expires: 0' );
}
/**
* Set filename to export to.
*
* @param string $filename Filename to export to.
*/
public function set_filename( $filename ) {
$this->filename = sanitize_file_name( str_replace( '.csv', '', $filename ) . '.csv' );
}
/**
* Generate and return a filename.
*
* @return string
*/
public function get_filename() {
return sanitize_file_name( apply_filters( "everest_forms_{$this->export_type}_export_get_filename", $this->filename ) );
}
/**
* Set the export content.
*
* @param string $csv_data All CSV content.
*/
public function send_content( $csv_data ) {
echo $csv_data; // @codingStandardsIgnoreLine
}
/**
* Get CSV data for this export.
*
* @return string
*/
protected function get_csv_data() {
return $this->export_rows();
}
/**
* Export column headers in CSV format.
*
* @since 3.1.0
* @return string
*/
protected function export_column_headers() {
$columns = $this->get_column_names();
$export_row = array();
$buffer = fopen( 'php://output', 'w' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fopen
ob_start();
foreach ( $columns as $column_id => $column_name ) {
if ( ! $this->is_column_exporting( $column_id ) ) {
continue;
}
$export_row[] = $this->format_data( $column_name );
}
$this->fputcsv( $buffer, $export_row );
return ob_get_clean();
}
/**
* Get data that will be exported.
*
* @return array
*/
protected function get_data_to_export() {
return $this->row_data;
}
/**
* Export rows in CSV format.
*
* @return string
*/
protected function export_rows() {
$data = $this->get_data_to_export();
$buffer = fopen( 'php://output', 'w' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fopen
ob_start();
array_walk( $data, array( $this, 'export_row' ), $buffer );
return apply_filters( "everest_forms_{$this->export_type}_export_rows", ob_get_clean(), $this );
}
/**
* Export rows to an array ready for the CSV.
*
* @param array $row_data Data to export.
* @param string $key Column being exported.
* @param resource $buffer Output buffer.
*/
protected function export_row( $row_data, $key, $buffer ) {
$columns = $this->get_column_names();
$export_row = array();
foreach ( $columns as $column_id => $column_name ) {
if ( ! $this->is_column_exporting( $column_id ) ) {
continue;
}
if ( isset( $row_data[ $column_id ] ) ) {
$export_row[] = $this->format_data( $row_data[ $column_id ] );
} else {
$export_row[] = '';
}
}
$this->fputcsv( $buffer, $export_row );
}
/**
* Escape a string to be used in a CSV context
*
* Malicious input can inject formulas into CSV files, opening up the possibility
* for phishing attacks and disclosure of sensitive information.
*
* Additionally, Excel exposes the ability to launch arbitrary commands through
* the DDE protocol.
*
* @see http://www.contextis.com/resources/blog/comma-separated-vulnerabilities/
* @see https://hackerone.com/reports/72785
*
* @param string $data CSV field to escape.
* @return string
*/
public function escape_data( $data ) {
$active_content_triggers = array( '=', '+', '-', '@' );
if ( in_array( mb_substr( $data, 0, 1 ), $active_content_triggers, true ) ) { // @codingStandardsIgnoreLine
$data = "'" . $data;
}
return $data;
}
/**
* Format and escape data ready for the CSV file.
*
* @param string $data Data to format.
* @return string
*/
public function format_data( $data ) {
if ( ! is_scalar( $data ) ) {
$data = ''; // Not supported.
} elseif ( is_bool( $data ) ) {
$data = $data ? 1 : 0;
}
$use_mb = function_exists( 'mb_convert_encoding' );
if ( $use_mb ) {
$encoding = mb_detect_encoding( $data, 'UTF-8, ISO-8859-1', true );
$data = 'UTF-8' === $encoding ? $data : utf8_encode( $data );
}
return $this->escape_data( $data );
}
/**
* Implode CSV cell values using commas by default, and wrapping values
* which contain the separator.
*
* @param array $values Values to implode.
* @return string
*/
protected function implode_values( $values ) {
$values_to_implode = array();
// For checkbox and radio.
if ( ! empty( $values['label'] ) ) {
$values = $values['label'];
}
if ( is_array( $values ) ) {
foreach ( $values as $value ) {
$value = is_scalar( $value ) ? (string) $value : '';
$values_to_implode[] = str_replace( ',', '\\,', $value );
}
} else {
$values_to_implode[] = str_replace( ',', '\\,', $values );
}
return implode( ', ', $values_to_implode );
}
/**
* Write to the CSV file, ensuring escaping works across versions of
* PHP.
*
* PHP 5.5.4 uses '\' as the default escape character. This is not RFC-4180 compliant.
* \0 disables the escape character.
*
* @see https://bugs.php.net/bug.php?id=43225
* @see https://bugs.php.net/bug.php?id=50686
* @see https://github.com/woocommerce/woocommerce/issues/19514
*
* @param resource $buffer Resource we are writing to.
* @param array $export_row Row to export.
*/
protected function fputcsv( $buffer, $export_row ) {
if ( version_compare( PHP_VERSION, '5.5.4', '<' ) ) {
ob_start();
$temp = fopen( 'php://output', 'w' ); // @codingStandardsIgnoreLine
fputcsv( $temp, $export_row, $this->get_delimiter(), '"' ); // @codingStandardsIgnoreLine
fclose( $temp ); // @codingStandardsIgnoreLine
$row = ob_get_clean();
$row = str_replace( '\\"', '\\""', $row );
fwrite( $buffer, $row ); // @codingStandardsIgnoreLine
} else {
fputcsv( $buffer, $export_row, $this->get_delimiter(), '"', "\0" ); // @codingStandardsIgnoreLine
}
}
}