| Server IP : 192.64.118.117 / Your IP : 3.144.252.197 Web Server : LiteSpeed System : Linux premium56.web-hosting.com 4.18.0-513.24.1.lve.1.el8.x86_64 #1 SMP Thu May 9 15:10:09 UTC 2024 x86_64 User : thecgapy ( 1160) PHP Version : 7.4.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/thecgapy/mcprintingandpromotions.com/wp-content/plugins/forminator/library/ |
Upload File : |
<?php
/**
* Forminator Export
*
* @package Forminator
*/
if ( ! defined( 'ABSPATH' ) ) {
die();
}
/**
* Class Forminator_Export
*
* Handle data exports
*
* @since 1.0
*/
class Forminator_Export {
/**
* Plugin instance
*
* @var null
*/
private static $instance = null;
/**
* Holds fields to be exported
*
* @since 1.0.5
*
* @var array
*/
private $global_fields_to_export = array();
/**
* Form registered addon
*
* @var Forminator_Integration[]
*/
private static $form_registered_addons = array();
/**
* Poll registered addon
*
* @var Forminator_Integration[]
*/
private static $poll_registered_addons = array();
/**
* Quiz registered addon
*
* @var Forminator_Integration[]
*/
private static $quiz_registered_addons = array();
/**
* Return the plugin instance
*
* @return Forminator_Export
*
* @since 1.0
*/
public static function get_instance() {
if ( is_null( self::$instance ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Main constructor
*
* @since 1.0
*/
public function __construct() {
add_action( 'wp_loaded', array( &$this, 'listen_for_csv_export' ) );
add_action( 'wp_loaded', array( &$this, 'listen_for_saving_export_schedule' ) );
// schedule for check and send export.
add_action( 'init', array( &$this, 'schedule_entries_exporter' ) );
add_action( 'forminator_send_export', array( &$this, 'maybe_send_export' ) );
}
/**
* Set up the schedule
*
* @since 1.0
* @since 1.27 Change from WP cron to Action Scheduler
*/
public function schedule_entries_exporter() {
forminator_set_recurring_action( 'forminator_send_export', MINUTE_IN_SECONDS );
}
/**
* Listen for export action
*
* @since 1.0
*/
public function listen_for_csv_export() {
$forminator_export = Forminator_Core::sanitize_text_field( 'forminator_export' );
if ( ! $forminator_export ) {
return;
}
if ( ! forminator_get_permission( 'forminator-entries' ) ) {
return;
}
$nonce = Forminator_Core::sanitize_text_field( '_forminator_nonce' );
if ( ! wp_verify_nonce( $nonce, 'forminator_export' ) ) {
return;
}
$form_id = filter_input( INPUT_POST, 'form_id', FILTER_VALIDATE_INT );
$type = Forminator_Core::sanitize_text_field( 'form_type' );
$filter = filter_input( INPUT_POST, 'submission-filter', FILTER_VALIDATE_BOOLEAN );
$form_id = intval( $form_id );
$export_data = $this->prepare_export_data( $form_id, $type, 0, $filter );
if ( ! $export_data instanceof Forminator_Export_Result ) {
return;
}
$data = $export_data->data;
$model = $export_data->model;
$count = $export_data->entries_count;
// save the time for later uses.
$logs = get_option( 'forminator_exporter_log', array() );
if ( ! isset( $logs[ $model->id ] ) ) {
$logs[ $model->id ] = array();
}
$logs[ $model->id ][] = array(
'time' => current_time( 'timestamp' ), // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested -- We are using the current timestamp based on the site's timezone.
'count' => $count,
);
update_option( 'forminator_exporter_log', $logs );
/**
* Action hook to trigger before Manual Export download.
*
* @param int $form_id Form ID
* @param string $form_type Form type(form/quiz/poll)
*
* @since 1.27.0
*/
do_action( 'forminator_before_manual_export_download', $form_id, $type );
$fp = fopen( 'php://output', 'w' ); // phpcs:disable WordPress.WP.AlternativeFunctions.file_system_read_fopen -- disable phpcs because it writes memory
ob_start();
foreach ( $data as $fields ) {
$fields = self::get_formatted_csv_fields( $fields );
fputcsv( $fp, $fields, ',', '"', '\\' );
}
$filename = sanitize_title( esc_html__( 'forminator', 'forminator' ) ) . '-' . sanitize_title( $model->name ) . '-' . gmdate( 'ymdHis' ) . '.csv';
$output = ob_get_clean();
header( 'Content-Encoding: UTF-8' );
header( 'Content-type: text/csv; charset=UTF-8' );
header( 'Content-Disposition: attachment; filename="' . $filename . '";' );
// print BOM Char for Excel Compatible.
echo chr( 239 ) . chr( 187 ) . chr( 191 ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
// make php send the generated csv lines to the browser.
exit( $output ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Listen for the POST request to store schedule data
*
* @since 1.0
*/
public function listen_for_saving_export_schedule() {
$action = Forminator_Core::sanitize_text_field( 'action' );
if ( 'forminator_export_entries' === $action ) {
$nonce = Forminator_Core::sanitize_text_field( '_forminator_nonce' );
if ( ! $nonce || ! wp_verify_nonce( $nonce, 'forminator_export' ) ) {
$redirect = add_query_arg(
array(
'err_msg' => rawurlencode( esc_html__( 'Invalid request, you are not allowed to do that action.', 'forminator' ) ),
)
);
wp_safe_redirect( $redirect );
exit;
}
$data = $this->get_entries_export_schedule();
$form_id = filter_input( INPUT_POST, 'form_id', FILTER_VALIDATE_INT );
if ( ! $form_id ) {
$redirect = add_query_arg(
array(
'err_msg' => rawurlencode( esc_html__( 'Invalid form ID.', 'forminator' ) ),
)
);
wp_safe_redirect( $redirect );
exit;
}
$form_type = Forminator_Core::sanitize_text_field( 'form_type' );
if ( ! $form_type ) {
$redirect = add_query_arg(
array(
'err_msg' => rawurlencode( esc_html__( 'Invalid form type.', 'forminator' ) ),
)
);
wp_safe_redirect( $redirect );
exit;
}
$enabled = filter_input( INPUT_POST, 'enabled', FILTER_VALIDATE_BOOLEAN );
$email = filter_input( INPUT_POST, 'email', FILTER_VALIDATE_EMAIL, FILTER_REQUIRE_ARRAY );
if ( $enabled && ! $email ) {
$redirect = add_query_arg(
array(
'err_msg' => rawurlencode( esc_html__( 'Invalid email.', 'forminator' ) ),
)
);
wp_safe_redirect( $redirect );
exit;
}
$key = $form_id . $form_type;
$current_form_export = isset( $data[ $key ] ) ? $data[ $key ] : array();
$last_sent = current_time( 'timestamp' ); // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested -- We are using the current timestamp based on the site's timezone.
$interval = Forminator_Core::sanitize_text_field( 'interval' );
if ( 'daily' === $interval ) {
$last_sent = strtotime( '-24 hours', current_time( 'timestamp' ) ); // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested -- We are using the current timestamp based on the site's timezone.
}
$data[ $key ] = array(
'enabled' => $enabled,
'form_id' => $form_id,
'form_type' => $form_type,
'email' => $email ? $email : '',
'interval' => $interval,
'month_day' => Forminator_Core::sanitize_text_field( 'month_day' ),
'day' => Forminator_Core::sanitize_text_field( 'day' ),
'hour' => Forminator_Core::sanitize_text_field( 'hour' ),
'last_sent' => $last_sent,
'if_new' => (bool) filter_input( INPUT_POST, 'if_new', FILTER_VALIDATE_BOOLEAN ),
'last_sent_row_id' => isset( $current_form_export['last_sent_row_id'] ) ? $current_form_export['last_sent_row_id'] : 0,
);
forminator_maybe_log( $data[ $key ] );
update_option( 'forminator_entries_export_schedule', $data );
/**
* Action hook to trigger after Schedule Export save.
*
* @param int $form_id Form ID
* @param string $form_type Form type(form/quiz/poll)
* @param array $data all the export form data
*
* @since 1.27.0
*/
do_action( 'forminator_after_export_schedule_save', $form_id, $form_type, $data );
$redirect = remove_query_arg( array( 'err_msg' ) );
$referer = wp_get_referer();
if ( empty( $referer ) ) {
// on same request uri `wp_get_referer` return false.
$referer = wp_get_raw_referer();
}
if ( ! empty( $referer ) && ! headers_sent() ) {
// probably header sent so skip this logic to avoid erro.
$referer_query = wp_parse_url( $referer, PHP_URL_QUERY );
if ( ! empty( $referer_query ) ) {
wp_parse_str( $referer_query, $query_strings );
if ( ! empty( $query_strings ) && isset( $query_strings['page'] ) && 'forminator-entries' === $query_strings['page'] ) {
// additional redirect parameter on global entries page.
$redirect = add_query_arg(
array(
'form_id' => $form_id,
),
$redirect
);
}
}
}
wp_safe_redirect( $redirect );
exit;
}
}
/**
* Try send export
*
* @since 1.0
* @since 1.5.4 add force param
*
* @param bool $force force send, ignore last_sent timestamp.
*/
public function maybe_send_export( $force = false ) {
$export_schedules = $this->get_entries_export_schedule();
if ( empty( $export_schedules ) ) {
return;
}
$receipts = array();
foreach ( $export_schedules as $row ) {
if ( ! isset( $row['enabled'] ) || ( isset( $row['enabled'] ) && ( 'false' === $row['enabled'] || ! $row['enabled'] ) ) || ( isset( $row['email'] ) && empty( $row['email'] ) ) ) {
continue;
}
$last_sent = $row['last_sent'];
// check the next sent.
$next_sent = null;
switch ( $row['interval'] ) {
case 'daily':
$next_sent = strtotime( '+24 hours', $last_sent );
$next_sent = gmdate( 'Y-m-d', $next_sent ) . ' ' . $row['hour'];
break;
case 'weekly':
$day = isset( $row['day'] ) ? $row['day'] : 'mon';
$next_sent = strtotime( 'next ' . $day, $last_sent );
$next_sent = gmdate( 'Y-m-d', $next_sent ) . ' ' . $row['hour'];
break;
case 'monthly':
$next_sent = $this->get_monthly_export_date( $last_sent, $row );
break;
default:
break;
}
$is_send = current_time( 'timestamp' ) > strtotime( $next_sent ); // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested -- We are using the current timestamp based on the site's timezone.
if ( $force ) {
$is_send = true;
}
if ( $is_send ) {
$last_entry_id = isset( $row['last_sent_row_id'] ) ? intval( $row['last_sent_row_id'] ) : 0;
// queue to prevent spam.
$info = $this->prepare_attachment( $row['form_id'], $row['form_type'], $row['email'], $last_entry_id );
if ( ! $info instanceof Forminator_Export_Result || empty( $info->file_path ) ) {
continue;
}
if ( ! empty( $row['email'] ) ) {
$export_email = is_array( $row['email'] ) ? $row['email'] : array( $row['email'] );
foreach ( $export_email as $email ) {
if ( ! isset( $receipts[ $email ] ) ) {
$receipts[ $email ] = array();
}
$receipts[ $email ][] = $info;
}
}
}
}
$files = array();
// now start to send.
foreach ( $receipts as $email => $info ) {
$current_files = array();
$export_results = array();
foreach ( $info as $export_result ) {
/**
* Forminator_Export_Result
*
* @var Forminator_Export_Result $export_result */
$schedule_key = $export_result->model->id . $export_result->form_type;
$export_schedule = $this->get_entries_export_schedule( $schedule_key );
$last_row_id = isset( $export_schedule['last_sent_row_id'] ) ? intval( $export_schedule['last_sent_row_id'] ) : 0;
$if_new = isset( $export_schedule['if_new'] ) ? filter_var( $export_schedule['if_new'], FILTER_VALIDATE_BOOLEAN ) : false;
// update last sent,.
// this options need to updated so it marked as email sent, and scheduled for next time.
$export_schedules[ $schedule_key ]['last_sent'] = current_time( 'timestamp' ); // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested -- We are using the current timestamp based on the site's timezone.
$export_schedules[ $schedule_key ]['last_sent_row_id'] = $export_result->latest_entry_id;
// only send email when new entry avail.
if ( $if_new ) {
// skip sending this email.
if ( $last_row_id >= $export_result->latest_entry_id ) {
forminator_maybe_log(
__METHOD__,
sprintf(
'Scheduled Export email for %s ID %s skipped, due to no new submissions last_sent_row_id: %s latest_entry_id: %s',
$export_result->form_type,
$export_result->model->id,
$last_row_id,
$export_result->latest_entry_id
)
);
continue;
}
}
// files reference needed for future deletion.
$current_files[] = $export_result->file_path;
$export_results[] = $export_result;
}
$files += $current_files;
if ( ! empty( $export_results ) ) {
$subject = $this->get_mail_subject( $export_results );
$mail_content = $this->get_mail_content( $export_results );
$mail_headers = $this->get_mail_headers( $email, $export_results );
wp_mail( $email, $subject, $mail_content, $mail_headers, $current_files );
}
}
$files = array_unique( $files );
foreach ( $files as $file ) {
wp_delete_file( $file );
}
if ( $receipts ) {
update_option( 'forminator_entries_export_schedule', $export_schedules );
}
}
/**
* Prepare export data
*
* @since 1.0
* @since 1.5
* @since 1.5.4 add `$latest_exported_entry_id` param to get new entries count
*
* @param int $form_id Form Id.
* @param string $type Form type.
* @param int $latest_exported_entry_id Entry Id.
* @param string $filter Filter.
*
* @return Forminator_Export_Result
*/
private function prepare_export_data( $form_id, $type, $latest_exported_entry_id = 0, $filter = '' ) {
$model = null;
$data = array();
$entries = array();
$export_result = new Forminator_Export_Result();
$export_result->form_type = $type;
switch ( $type ) {
case 'quiz':
$model = Forminator_Base_Form_Model::get_model( $form_id );
if ( ! is_object( $model ) ) {
return null;
}
$mappers = array();
$lead_headers = array();
$export_result->model = $model;
if ( ! empty( $filter ) ) {
$filters = $export_result->request_filters();
$entries = Forminator_Form_Entry_Model::get_all_entries( $form_id, $filters );
} else {
$entries = Forminator_Form_Entry_Model::get_all_entries( $form_id );
}
$headers = array(
esc_html__( 'Date', 'forminator' ),
esc_html__( 'Question', 'forminator' ),
esc_html__( 'Answer', 'forminator' ),
esc_html__( 'Result', 'forminator' ),
);
$has_leads = isset( $model->settings['hasLeads'] ) ? $model->settings['hasLeads'] : false;
$leads_id = isset( $model->settings['leadsId'] ) ? $model->settings['leadsId'] : 0;
if ( $has_leads && $leads_id ) {
$form_model = Forminator_Base_Form_Model::get_model( $leads_id );
if ( is_object( $form_model ) ) {
$mappers = $this->get_custom_form_export_mappers( $form_model );
foreach ( $mappers as $mapper ) {
if ( 'entry_time_created' === $mapper['type'] ) {
continue;
}
if ( ! isset( $mapper['sub_metas'] ) ) {
$lead_headers[ $mapper['meta_key'] ] = $mapper['label'];
} else {
foreach ( $mapper['sub_metas'] as $sub_meta ) {
$lead_headers[ $sub_meta['key'] ] = $sub_meta['label'];
}
}
}
$headers = array_merge( $headers, $lead_headers );
}
}
$addon_header = $this->attach_quiz_addons_on_export_render_title_row( $form_id, $entries );
$headers = array_merge( $headers, $addon_header );
foreach ( $entries as $entry ) {
if ( $entry->entry_id > $latest_exported_entry_id ) {
++$export_result->new_entries_count;
}
$lead_data = $this->get_mapper_export_data( $mappers, $entry );
if ( 'nowrong' === $model->quiz_type ) {
$meta = isset( $entry->meta_data['entry']['value'][0]['value'] ) ? $entry->meta_data['entry']['value'][0]['value'] : array();
if ( empty( $meta['answers'] ) && ! empty( $lead_data ) ) {
$meta['answers'] = array(
array(
'question' => '',
'answer' => '',
'result' => array(
'title' => '',
),
),
);
}
if ( isset( $meta['answers'] ) ) {
$i = 1;
foreach ( $meta['answers'] as $answer ) {
$row = array();
$row[] = 1 === $i ? $entry->time_created : '';
$row[] = ! empty( $answer['question'] ) ? sprintf( '"%s"', $answer['question'] ) : '';
$row[] = $answer['answer'];
if ( isset( $meta['result'] ) && isset( $meta['result']['title'] ) ) {
$row[] = $meta['result']['title'];
}
if ( ! empty( $lead_data ) ) {
foreach ( $lead_headers as $headers_id => $lead_header ) {
if ( isset( $lead_data[ $headers_id ] ) ) {
$row[] = 1 === $i ? $lead_data[ $headers_id ] : '';
}
}
}
$addon_data = $this->attach_quiz_addons_on_export_render_entry_row( $form_id, $entry );
foreach ( $addon_header as $header_id => $item ) {
if ( isset( $addon_data[ $header_id ] ) ) {
$row[] = 1 === $i ? $addon_data[ $header_id ] : '';
}
}
$data[] = $row;
++$i;
}
}
} elseif ( 'knowledge' === $model->quiz_type ) {
$meta = isset( $entry->meta_data['entry']['value'] ) ? $entry->meta_data['entry']['value'] : array();
if ( empty( $meta ) && ! empty( $lead_data ) ) {
$meta = array(
array(
'question' => '',
'answer' => '',
'isCorrect' => '',
),
);
}
if ( ! empty( $meta ) ) {
$i = 1;
foreach ( $meta as $answer ) {
$row = array();
$row[] = 1 === $i ? $entry->time_created : '';
$row[] = ! empty( $answer['question'] ) ? sprintf( '"%s"', $answer['question'] ) : '';
$row[] = $answer['answer'];
if ( ! empty( $answer['answer'] ) ) {
$row[] = ( ( $answer['isCorrect'] ) ? esc_html__( 'Correct', 'forminator' ) : esc_html__( 'Incorrect', 'forminator' ) );
} else {
$row[] = '';
}
if ( ! empty( $lead_data ) ) {
foreach ( $lead_headers as $headers_id => $lead_header ) {
if ( isset( $lead_data[ $headers_id ] ) ) {
$row[] = 1 === $i ? $lead_data[ $headers_id ] : '';
}
}
}
$addon_data = $this->attach_quiz_addons_on_export_render_entry_row( $form_id, $entry );
foreach ( $addon_header as $header_id => $item ) {
if ( isset( $addon_data[ $header_id ] ) ) {
$row[] = 1 === $i ? $addon_data[ $header_id ] : '';
}
}
$data[] = $row;
++$i;
}
}
}
}
$data = array_merge( array( $headers ), $data );
$export_result->data = $data;
break;
case 'poll':
$model = Forminator_Base_Form_Model::get_model( $form_id );
if ( ! is_object( $model ) ) {
return null;
}
$export_result->model = $model;
$entries = Forminator_Form_Entry_Model::get_all_entries( $form_id );
foreach ( $entries as $entry ) {
if ( $entry->entry_id > $latest_exported_entry_id ) {
++$export_result->new_entries_count;
}
}
$fields_array = $model->get_fields_as_array();
$map_entries = Forminator_Form_Entry_Model::map_polls_entries_for_export( $form_id, $fields_array );
$header = array(
esc_html__( 'Date', 'forminator' ),
esc_html__( 'Answer', 'forminator' ),
esc_html__( 'Extra', 'forminator' ),
);
$addon_header = $this->attach_poll_addons_on_export_render_title_row( $form_id, $entries );
$header = array_merge( $header, $addon_header );
$data = array();
$data[] = $header;
foreach ( $map_entries as $map_entry ) {
$label = $map_entry['meta_value'];
$entry = new Forminator_Form_Entry_Model( $map_entry['entry_id'] );
$extra = $entry->get_meta( 'extra', null );
$row = array(
$entry->time_created,
$label,
$extra,
);
$addon_data = $this->attach_poll_addons_on_export_render_entry_row( $form_id, $entry );
foreach ( $addon_header as $header_id => $item ) {
if ( isset( $addon_data[ $header_id ] ) ) {
$row[] = $addon_data[ $header_id ];
}
}
$data[] = $row;
}
$export_result->data = $data;
break;
case 'cform':
$model = Forminator_Base_Form_Model::get_model( $form_id );
if ( ! is_object( $model ) ) {
return null;
}
if ( ! empty( $filter ) ) {
$filters = $export_result->request_filters();
$entries = Forminator_Form_Entry_Model::get_all_entries( $form_id, $filters );
} else {
$entries = Forminator_Form_Entry_Model::get_all_entries( $form_id );
}
$mappers = $this->get_custom_form_export_mappers( $model );
$addon_mappers = $this->attach_form_addons_on_export_render_title_row( $form_id, $entries );
$export_result->model = $model;
$result = array();
foreach ( $entries as $entry ) {
if ( empty( $entry->meta_data ) ) {
continue;
}
if ( $entry->entry_id > $latest_exported_entry_id ) {
++$export_result->new_entries_count;
}
$data = array();
// traverse from fields to be correctly mapped with updated form fields.
foreach ( $mappers as $mapper ) {
// its from model's property.
if ( isset( $mapper['property'] ) ) {
if ( property_exists( $entry, $mapper['property'] ) ) {
$property = $mapper['property'];
// casting property to string.
$data[] = (string) $entry->$property;
} else {
$data[] = '';
}
} else {
$data = self::add_meta_value( $data, $mapper, $entry );
}
}
// Addon columns.
$addon_data = $this->attach_form_addons_on_export_render_entry_row( $form_id, $entry );
foreach ( $addon_mappers as $mapper_id => $mapper ) {
if ( isset( $addon_data[ $mapper_id ] ) ) {
$data[] = $addon_data[ $mapper_id ];
}
}
$result[ (string) $entry->entry_id ] = $data;
}
// flatten mappers to headers.
$headers = array();
foreach ( $mappers as $mapper ) {
if ( ! isset( $mapper['sub_metas'] ) ) {
$headers[] = $mapper['label'];
} else {
foreach ( $mapper['sub_metas'] as $sub_meta ) {
$headers[] = $sub_meta['label'];
}
}
}
// additional addon headers.
foreach ( $addon_mappers as $mapper ) {
$headers[] = $mapper;
}
$data = array_merge( array( 'headers' => $headers ), $result );
$export_result->data = $data;
break;
default:
break;
}
$export_result->entries_count = count( $entries );
// DESC order, latest entry will be first.
if ( isset( $entries[0] ) && $entries[0] instanceof Forminator_Form_Entry_Model ) {
$latest_entry = $entries[0];
$export_result->latest_entry_id = $latest_entry->entry_id;
}
return $export_result;
}
/**
* Add meta value
*
* @param array $data Saved data.
* @param array $mapper Mapper.
* @param object $entry Entry object.
* @return array Updated data.
*/
private static function add_meta_value( $data, $mapper, $entry ) {
$copies = array_filter(
$entry->meta_data,
function ( $key ) use ( $mapper ) {
return strpos( $key, $mapper['meta_key'] . '-' ) === 0 || $mapper['meta_key'] === $key;
},
ARRAY_FILTER_USE_KEY
);
if ( ! $copies ) {
$copies[ $mapper['meta_key'] ] = array();
}
$temp_data = array();
foreach ( $copies as $slug => $copy ) {
// meta_key based.
$meta_value = $entry->get_meta( $slug, '' );
if ( ! isset( $mapper['sub_metas'] ) ) {
if ( 'rating' === $mapper['type'] ) {
$meta_value = preg_replace_callback(
'/(\d+)\/(\d+)/',
function ( $matches ) {
return sprintf(
/* Translators: 1. Rating value, 2. Maximum rating */
esc_html__( ' %1$d out of %2$d', 'forminator' ),
$matches[1],
$matches[2]
);
},
$meta_value
);
}
$temp_data[ $mapper['type'] ][] = Forminator_Form_Entry_Model::meta_value_to_string( $mapper['type'], $meta_value );
} else {
// sub_metas available.
foreach ( $mapper['sub_metas'] as $sub_meta ) {
$sub_key = $sub_meta['key'];
if ( ! empty( $meta_value[ $sub_key ] ) ) {
$value = $meta_value[ $sub_key ];
$field_type = $mapper['type'] . '.' . $sub_key;
$temp_data[ $sub_key ][] = Forminator_Form_Entry_Model::meta_value_to_string( $field_type, $value );
} else {
$temp_data[ $sub_key ][] = '';
}
}
}
}
foreach ( $temp_data as $t_data ) {
$data[] = implode( ' / ', $t_data );
}
return $data;
}
/**
* Prepare mail attachment
*
* @since 1.0
* @since 1.5.4 add `$last_entry_id` to calculate new entries count
*
* @param int $form_id Form id.
* @param string $type Form type.
* @param string $email Email.
* @param int $last_entry_id Entry Id.
*
* @return Forminator_Export_Result|boolean
*/
private function prepare_attachment( $form_id, $type, $email, $last_entry_id = 0 ) {
$export_result = $this->prepare_export_data( $form_id, $type, $last_entry_id );
if ( ! $export_result instanceof Forminator_Export_Result ) {
return false;
}
$model = $export_result->model;
$data = $export_result->data;
$upload_dirs = wp_upload_dir();
// temp write to uploads.
$tmp_path = $upload_dirs['basedir'] . '/forminator/';
require_once ABSPATH . 'wp-admin/includes/file.php';
/**
* WP_Filesystem_Base
*
* @var WP_Filesystem_Base $wp_filesystem */
global $wp_filesystem;
WP_Filesystem();
if ( ! $wp_filesystem->is_dir( $tmp_path ) ) {
$wp_filesystem->mkdir( $tmp_path );
}
$filename = sanitize_title( $model->name ) . '-' . gmdate( 'ymdHis' ) . '.csv';
$tmp_path = $tmp_path . $filename;
$mode = defined( 'FS_CHMOD_FILE' ) ? FS_CHMOD_FILE : false;
if ( ! $wp_filesystem->put_contents( $tmp_path, $this->csvstr( $data ), $mode ) ) {
if ( is_wp_error( $wp_filesystem->errors ) ) {
forminator_maybe_log( __METHOD__, $wp_filesystem->errors->get_error_message() );
}
return false;
}
$export_result->file_path = $tmp_path;
return $export_result;
}
/**
* CSVString
*
* @param mixed $fields Fields.
* @return bool|string
*/
private function csvstr( $fields ) {
if ( ! is_array( $fields ) ) {
return false;
}
$output = array();
foreach ( $fields as $value ) {
$f = fopen( 'php://memory', 'r+' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fopen -- fputcsv() works with file pointers and the WordPress filesystem API does not directly support working with file pointers.
$value = self::get_formatted_csv_fields( $value );
$put = fputcsv( $f, $value, ',', '"', '\\' );
if ( false === $put ) {
return false;
}
rewind( $f );
$csv_line = stream_get_contents( $f );
$output[] = rtrim( $csv_line );
}
// prepend BOM Character for excel compatible.
return chr( 239 ) . chr( 187 ) . chr( 191 ) . implode( PHP_EOL, $output );
}
/**
* Get monthly export date
*
* @param string $last_sent Last sent.
* @param mixed $settings Settings.
* @return string
*/
private function get_monthly_export_date( $last_sent, $settings ) {
$month_date = isset( $settings['month_day'] ) ? $settings['month_day'] : 1;
$hour = isset( $settings['hour'] ) ? $settings['hour'] : '00:00';
// Maybe $month_date will be in the future this month.
$next_sent = strtotime( gmdate( "Y-m-{$month_date} {$hour}", $last_sent ) );
if ( $last_sent >= $next_sent ) {
// If not - next month.
$next_sent = strtotime( '+1 month', $next_sent );
while ( gmdate( 'm', $next_sent ) > gmdate( 'm', $last_sent ) + 1 ) {
// remove 1 day if 31, 30, 29 day doesn't exist in this month.
$next_sent = strtotime( '-1 day', $next_sent );
}
}
return gmdate( 'Y-m-d H:i:s', $next_sent );
}
/**
* Get data mappers for retrieving entries meta
*
* @example {
* [
* 'meta_key' => 'FIELD_ID',
* 'label' => 'LABEL',
* 'type' => 'TYPE',
* 'sub_metas' => [
* [
* 'key' => 'SUFFIX',
* 'label' => 'LABEL',
* ]
* ],
* ]...
* }
*
* @since 1.0.5
*
* @param Forminator_Form_Model|Forminator_Base_Form_Model $model Form model.
*
* @return array
*/
private function get_custom_form_export_mappers( $model ) {
/**
* Forminator_Form_Model
*
* @var Forminator_Form_Model $model */
$fields = $model->get_grouped_real_fields();
$field_mappers = self::get_mappers( $fields, $model );
$mappers = array_merge(
array(
array(
// read form model's property.
'property' => 'time_created', // must be on export.
'label' => esc_html__( 'Submission Time', 'forminator' ),
'type' => 'entry_time_created',
),
),
$field_mappers
);
/**
* Filter column mappers to be used on export custom form
*
* @since 1.6.3
*
* @param array $mappers
* @param int $form_id
* @param Forminator_Form_Model $model
*
* @return array
*/
$mappers = apply_filters( 'forminator_custom_form_export_mappers', $mappers, $model->id, $model );
return $mappers;
}
/**
* Get mappers
*
* @param array $fields Fields array.
* @param object $model Model object.
* @param null|object $group_field Group field.
* @return array
*/
private static function get_mappers( $fields, $model, $group_field = null ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput -- Sanitized in Forminator_Core::sanitize_array.
$visible_fields = isset( $_GET['field'] ) ? Forminator_Core::sanitize_array( $_GET['field'] ) : array();
$mappers = array();
foreach ( $fields as $field ) {
$field_type = $field->__get( 'type' );
if ( ! empty( $visible_fields ) ) {
if ( ! in_array( $field->slug, $visible_fields, true ) ) {
continue;
}
}
// base mapper for every field.
$mapper = array();
$mapper['meta_key'] = $field->slug; // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- false positive.
$mapper['label'] = $field->get_label_for_entry();
$mapper['type'] = $field_type;
if ( $group_field ) {
$mapper['label'] = $group_field->get_label_for_entry() . ' - ' . $mapper['label'];
}
// fields that should be displayed as multi column (sub_metas).
if ( 'name' === $field_type ) {
$is_multiple_name = filter_var( $field->__get( 'multiple_name' ), FILTER_VALIDATE_BOOLEAN );
if ( $is_multiple_name ) {
$prefix_enabled = filter_var( $field->__get( 'prefix' ), FILTER_VALIDATE_BOOLEAN );
$first_name_enabled = filter_var( $field->__get( 'fname' ), FILTER_VALIDATE_BOOLEAN );
$middle_name_enabled = filter_var( $field->__get( 'mname' ), FILTER_VALIDATE_BOOLEAN );
$last_name_enabled = filter_var( $field->__get( 'lname' ), FILTER_VALIDATE_BOOLEAN );
// at least one sub field enabled.
if ( $prefix_enabled || $first_name_enabled || $middle_name_enabled || $last_name_enabled ) {
// sub metas.
$mapper['sub_metas'] = array();
if ( $prefix_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'prefix' );
$label = $field->__get( 'prefix_label' );
$mapper['sub_metas'][] = array(
'key' => 'prefix',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $first_name_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'first-name' );
$label = $field->__get( 'fname_label' );
$mapper['sub_metas'][] = array(
'key' => 'first-name',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $middle_name_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'middle-name' );
$label = $field->__get( 'mname_label' );
$mapper['sub_metas'][] = array(
'key' => 'middle-name',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $last_name_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'last-name' );
$label = $field->__get( 'lname_label' );
$mapper['sub_metas'][] = array(
'key' => 'last-name',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
} else {
// if no subfield enabled when multiple name remove mapper (means dont show it on export).
$mapper = array();
}
}
} elseif ( 'address' === $field_type ) {
$street_enabled = filter_var( $field->__get( 'street_address' ), FILTER_VALIDATE_BOOLEAN );
$line_enabled = filter_var( $field->__get( 'address_line' ), FILTER_VALIDATE_BOOLEAN );
$city_enabled = filter_var( $field->__get( 'address_city' ), FILTER_VALIDATE_BOOLEAN );
$state_enabled = filter_var( $field->__get( 'address_state' ), FILTER_VALIDATE_BOOLEAN );
$zip_enabled = filter_var( $field->__get( 'address_zip' ), FILTER_VALIDATE_BOOLEAN );
$country_enabled = filter_var( $field->__get( 'address_country' ), FILTER_VALIDATE_BOOLEAN );
if ( $street_enabled || $line_enabled || $city_enabled || $state_enabled || $zip_enabled || $country_enabled ) {
$mapper['sub_metas'] = array();
if ( $street_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'street_address' );
$label = $field->__get( 'street_address_label' );
$mapper['sub_metas'][] = array(
'key' => 'street_address',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $line_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'address_line' );
$label = $field->__get( 'address_line_label' );
$mapper['sub_metas'][] = array(
'key' => 'address_line',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $city_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'city' );
$label = $field->__get( 'address_city_label' );
$mapper['sub_metas'][] = array(
'key' => 'city',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $state_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'state' );
$label = $field->__get( 'address_state_label' );
$mapper['sub_metas'][] = array(
'key' => 'state',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $zip_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'zip' );
$label = $field->__get( 'address_zip_label' );
$mapper['sub_metas'][] = array(
'key' => 'zip',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
if ( $country_enabled ) {
$default_label = Forminator_Form_Entry_Model::translate_suffix( 'country' );
$label = $field->__get( 'address_country_label' );
$mapper['sub_metas'][] = array(
'key' => 'country',
'label' => $mapper['label'] . ' - ' . ( $label ? $label : $default_label ),
);
}
} else {
// if no subfield enabled when multiple name remove mapper (means dont show it on export).
$mapper = array();
}
} elseif ( 'stripe' === $field_type || 'stripe-ocs' === $field_type || 'paypal' === $field_type ) {
$mapper['sub_metas'] = array();
$mapper['sub_metas'][] = array(
'key' => 'mode',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Mode', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'product_name',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Product / Plan Name', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'payment_type',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Payment type', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'amount',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Amount', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'currency',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Currency', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'quantity',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Quantity', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'transaction_id',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Transaction ID', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'status',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Status', 'forminator' ),
);
$mapper['sub_metas'][] = array(
'key' => 'subscription_id',
'label' => $mapper['label'] . ' - ' . esc_html__( 'Manage', 'forminator' ),
);
} elseif ( 'group' === $field_type ) {
$group_fields = $model->get_grouped_real_fields( $field->slug );
$group_mappers = self::get_mappers( $group_fields, $model, $field );
$mappers = array_merge( $mappers, $group_mappers );
continue;
}
if ( ! empty( $mapper ) ) {
$mappers[] = $mapper;
}
}
return $mappers;
}
/**
* Additional Column on Title(first) Row of Export data from Addon [Form]
*
* @see Forminator_Integration_Form_Hooks::on_export_render_title_row()
*
* @since 1.1
* @since 1.5.3 add $entries param to find addons that probably is/was connected
* @since 1.6.1 rename to attach_form_addons_on_export_render_title_row
*
* @param int $form_id Form Id.
* @param Forminator_Form_Entry_Model[] $entries Form entry model.
*
* @return array
*/
private function attach_form_addons_on_export_render_title_row( $form_id, $entries = array() ) {
$additional_headers = array();
// find all registered addons, so history can be shown even for deactivated addons.
$registered_addons = $this->get_form_registered_addons( $form_id, $entries );
foreach ( $registered_addons as $registered_addon ) {
try {
$form_hooks = $registered_addon->get_addon_hooks( $form_id, 'form' );
$addon_headers = $form_hooks->on_export_render_title_row();
$addon_headers = $this->format_addon_additional_headers( $registered_addon, $addon_headers );
$additional_headers = array_merge( $additional_headers, $addon_headers );
} catch ( Exception $e ) {
forminator_addon_maybe_log( $registered_addon->get_slug(), 'failed to on_export_render_title_row', $e->getMessage() );
}
}
return $additional_headers;
}
/**
* Format additional header given by addon
* Format used is `forminator_addon_export_title_{$addon_slug}_{$title_id_data_from_addon}`
*
* @since 1.1
*
* @param Forminator_Integration $addon Forminator Integration.
* @param array $addon_headers Addon headers.
*
* @return array
*/
private function format_addon_additional_headers( Forminator_Integration $addon, $addon_headers ) {
$formatted_headers = array();
if ( ! is_array( $addon_headers ) || empty( $addon_headers ) ) {
return $formatted_headers;
}
foreach ( $addon_headers as $title_id => $title ) {
if ( ! is_scalar( $title ) || empty( $title ) ) {
continue; // skip on empty title.
}
// avoid collistion with other addon ids.
$title_id = 'forminator_addon_export_title_' . $addon->get_slug() . '_' . $title_id;
$formatted_headers[ $title_id ] = $title;
}
return $formatted_headers;
}
/**
* Add addons export render entry row [Form]
*
* @see Forminator_Integration_Form_Hooks::on_export_render_entry()
* @since 1.1
* @since 1.6.1 rename to attach_form_addons_on_export_render_entry_row
*
* @param int $form_id Form Id.
* @param Forminator_Form_Entry_Model $entry_model Form entry Model.
*
* @return array
*/
private function attach_form_addons_on_export_render_entry_row( $form_id, Forminator_Form_Entry_Model $entry_model ) {
$additional_data = array();
// find all registered addons, so history can be shown even for deactivated addons.
$registered_addons = $this->get_form_registered_addons( $form_id );
foreach ( $registered_addons as $registered_addon ) {
try {
$form_hooks = $registered_addon->get_addon_hooks( $form_id, 'form' );
$meta_data = forminator_find_addon_meta_data_from_entry_model( $registered_addon, $entry_model );
$addon_data = $form_hooks->on_export_render_entry( $entry_model, $meta_data );
$addon_data = $this->format_addon_additional_data( $registered_addon, $addon_data );
$additional_data = array_merge( $additional_data, $addon_data );
} catch ( Exception $e ) {
forminator_addon_maybe_log( $registered_addon->get_slug(), 'failed to on_export_render_entry', $e->getMessage() );
}
}
return $additional_data;
}
/**
* Format addional data form addons to match requirement of export
* Format used is `forminator_addon_export_title_{$addon_slug}_{$title_id_data_from_addon}`
*
* @since 1.1
*
* @param Forminator_Integration $addon Forminator Integration.
* @param array $addon_data Addon data.
*
* @return array
*/
private function format_addon_additional_data( Forminator_Integration $addon, $addon_data ) {
$formatted_data = array();
if ( ! is_array( $addon_data ) || empty( $addon_data ) ) {
return $formatted_data;
}
foreach ( $addon_data as $title_id => $value ) {
$value = Forminator_Form_Entry_Model::meta_value_to_string( 'addon_' . $addon->get_slug(), $value );
// avoid collistion with other addon ids.
$title_id = 'forminator_addon_export_title_' . $addon->get_slug() . '_' . $title_id;
$formatted_data[ $title_id ] = $value;
}
return $formatted_data;
}
/**
* Get Globally Registered Addons for form_id, avoid overhead for checking registerd addons many times [Form]
*
* @since 1.5.3
* @since 1.6.1 rename to get_form_registered_addons
*
* @param int $form_id Form Id.
* @param Forminator_Form_Entry_Model[] $entries Form entry model.
*
* @return array|Forminator_Integration[]
*/
public function get_form_registered_addons( $form_id, $entries = array() ) {
if ( empty( self::$form_registered_addons ) ) {
self::$form_registered_addons = array();
$registered_addons = forminator_get_registered_addons();
foreach ( $entries as $entry ) {
// find registered addon by slug pattern.
$entry_addon_slugs = forminator_find_addon_slugs_from_entry_model( $entry );
foreach ( $entry_addon_slugs as $entry_addon_slug ) {
// check if this slug globally registered.
if ( in_array( $entry_addon_slug, array_keys( $registered_addons ), true ) ) {
// check if already in static $registered_addons.
if ( ! in_array( $entry_addon_slug, array_keys( self::$form_registered_addons ), true ) ) {
$addon = forminator_get_addon( $entry_addon_slug );
if ( $addon instanceof Forminator_Integration ) {
try {
$form_hooks = $addon->get_addon_hooks( $form_id, 'form' );
if ( $form_hooks instanceof Forminator_Integration_Form_Hooks ) {
self::$form_registered_addons[ $addon->get_slug() ] = $addon;
}
} catch ( Exception $e ) {
forminator_addon_maybe_log( $addon->get_slug(), 'failed to get_addon_hooks one export', $e->getMessage() );
}
}
}
}
}
}
}
return self::$form_registered_addons;
}
/**
* Get Entries Export Schedule
*
* Basic checking for export schedule
*
* @since 1.1
* @since 1.5.4 add $schedule_key param
*
* @param null|string $schedule_key Schedule key.
*
* @return array
*/
public function get_entries_export_schedule( $schedule_key = null ) {
$opt = get_option( 'forminator_entries_export_schedule', array() );
$validated_opt = $opt;
foreach ( $validated_opt as $key => $value ) {
if ( ! $value['form_id'] || ! $value['form_type'] ) {
// unschedule no form id exist.
unset( $validated_opt[ $key ] );
}
}
if ( $validated_opt !== $opt ) {
update_option( 'forminator_entries_export_schedule', $validated_opt );
}
if ( ! empty( $schedule_key ) ) {
if ( isset( $validated_opt[ $schedule_key ] ) && is_array( $validated_opt[ $schedule_key ] ) ) {
return $validated_opt[ $schedule_key ];
}
return array();
}
return $validated_opt;
}
/**
* Get email headers
*
* @since 1.5.4
*
* @param string $email Email.
* @param Forminator_Export_Result[] $export_results Export results.
*
* @return array
*/
public function get_mail_headers( $email = '', $export_results = array() ) {
$from_address = get_global_sender_email_address();
$from_name = get_global_sender_name();
$mail_headers = array(
'From: ' . $from_name . ' <' . $from_address . '>',
'Content-Type: text/html; charset=UTF-8',
);
/**
* Filter header for export mails
*
* @since 1.5.4
*
* @param array $mail_headers Mail headers.
* @param string $email email address which export mail will be sent.
* @param Forminator_Export_Result[] $export_results export results @see Forminator_Export_Result.
*/
$mail_headers = apply_filters( 'forminator_export_email_headers', $mail_headers, $email, $export_results );
return $mail_headers;
}
/**
* Get compiled mail subject for scheduled export
*
* @since 1.5.4
*
* @param Forminator_Export_Result[] $export_results Export result.
*
* @return string
*/
public function get_mail_subject( $export_results ) {
$form_names = array();
foreach ( $export_results as $export_result ) {
if ( isset( $export_result->model->settings['formName'] ) ) {
$form_names[] = $export_result->model->settings['formName'];
} else {
$form_names[] = $export_result->model->name;
}
}
/* translators: %s is form name. */
$subject = sprintf( esc_html__( 'Submissions data for %s', 'forminator' ), implode( ', ', $form_names ) );
/**
* Filter mail subject used for scheduled export email
*
* @since 1.5.4
*
* @param string $subject Subject.
* @param array $form_names Form names.
* @param Forminator_Export_Result[] $export_results Export results @see Forminator_Export_Result.
*
* @return string
*/
$subject = apply_filters( 'forminator_export_email_subject', $subject, $form_names, $export_results );
return $subject;
}
/**
* Get compiled mail content for scheduled export
*
* @since 1.5.4
*
* @param Forminator_Export_Result[] $export_results Export result.
*
* @return string
*/
public function get_mail_content( $export_results ) {
$submissions_link_format = admin_url( 'admin.php?page=forminator-entries&form_type=%1$s&form_id=%2$d' );
$entries_counts = array();
$new_entries_counts = array();
$form_names = array();
$submission_links = array();
foreach ( $export_results as $export_result ) {
if ( isset( $export_result->model->settings['formName'] ) ) {
$form_names[] = $export_result->model->settings['formName'];
} else {
$form_names[] = $export_result->model->name;
}
$entries_counts[] = $export_result->entries_count;
$new_entries_counts[] = $export_result->new_entries_count;
$form_type = 'forminator_forms';
switch ( $export_result->form_type ) {
case 'cform':
$form_type = 'forminator_forms';
break;
case 'poll':
$form_type = 'forminator_polls';
break;
case 'quiz':
$form_type = 'forminator_quizzes';
break;
default:
break;
}
$submission_links[] = sprintf( $submissions_link_format, $form_type, (int) $export_result->model->id );
}
$blog_name = get_option( 'blogname' );
$total_entries = array_sum( $entries_counts );
$total_new_entries = array_sum( $new_entries_counts );
/* translators: %s is Blog name. */
$mail_content = '<p>' . sprintf( esc_html__( 'Hi %s,', 'forminator' ), $blog_name ) . '</p>' . PHP_EOL;
$mail_content .= '<p>' . sprintf(
/* translators: 1$s is total new submission(s), %2$s is total submissions. */
esc_html__(
'Your scheduled exports have arrived! Forminator has captured %1$s new submission(s) and packaged %2$s total submissions from %3$s since the last scheduled export sent.',
'forminator'
),
'<strong>' . (int) $total_new_entries . '</strong>',
'<strong>' . (int) $total_entries . '</strong>',
implode( ', ', $form_names )
) . '</p>' . PHP_EOL;
$mail_content .= '<ul>' . PHP_EOL;
foreach ( $submission_links as $key => $submission_link ) {
$mail_content
.= sprintf(
'<li><strong>%1$s</strong>:
<ul>
<li>%2$s : %3$d</li>
<li>%4$s : %5$d</li>
<li><a href="%6$s">%7$s</a></li>
</ul>
</li>',
$form_names[ $key ],
esc_html__( 'New Submissions', 'forminator' ),
(int) $new_entries_counts[ $key ],
esc_html__( 'Total Submissions', 'forminator' ),
(int) $entries_counts[ $key ],
$submission_links[ $key ],
esc_html__( 'View Submissions', 'forminator' )
) . PHP_EOL;
}
$mail_content .= '</ul>' . PHP_EOL;
$mail_content .= '<p>' . esc_html__( 'Cheers,', 'forminator' ) . '</p>' . PHP_EOL;
$mail_content .= '<p>' . esc_html__( 'Forminator', 'forminator' ) . '</p>';
/**
* Filter mail content used for scheduled export email
*
* @since 1.5.4
*
* @param string $mail_content html formatted mail content.
* @param array $form_names form names.
* @param Forminator_Export_Result[] $export_results Export results @see Forminator_Export_Result.
*
* @return string
*/
$mail_content = apply_filters( 'forminator_export_email_content', $mail_content, $form_names, $export_results );
return $mail_content;
}
/**
* Escape a string to be used in a CSV context
*
* Taken from WooCommerce CSV Exporter
*
* @see https://github.com/woocommerce/woocommerce/blob/master/includes/export/abstract-wc-csv-exporter.php
*
* @since 1.6
*
* 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
*
* @since 3.1.0
*
* @param string $data CSV field to escape.
*
* @return string
*/
public static function escape_csv_data( $data ) {
$active_content_triggers = array( '=', '+', '-', '@' );
if ( in_array( mb_substr( $data, 0, 1 ), $active_content_triggers, true ) ) {
$data = "'" . $data . "'";
}
return $data;
}
/**
* Format csv fields
*
* @since 1.6
*
* @param mixed $fields Fields.
*
* @return array|string
*/
public static function get_formatted_csv_fields( $fields ) {
if ( empty( $fields ) || ! is_array( $fields ) ) {
return $fields;
}
$formatted_fields = array();
foreach ( $fields as $field ) {
if ( ! is_scalar( $field ) ) {
$formatted_fields[] = '';
continue;
}
if ( is_scalar( $field ) ) {
$formatted_fields[] = self::escape_csv_data( $field );
}
}
return $formatted_fields;
}
/**
* Get Globally Registered Addons for form_id, avoid overhead for checking registered addons many times [Poll]
*
* @since 1.6.1
*
* @param int $poll_id Poll Id.
* @param Forminator_Form_Entry_Model[] $entries Entries.
*
* @return array|Forminator_Integration[]
*/
public function get_poll_registered_addons( $poll_id, $entries = array() ) {
if ( empty( self::$poll_registered_addons ) ) {
self::$poll_registered_addons = array();
$registered_addons = forminator_get_registered_addons();
foreach ( $entries as $entry ) {
// find registered addon by slug pattern.
$entry_addon_slugs = forminator_find_addon_slugs_from_entry_model( $entry );
foreach ( $entry_addon_slugs as $entry_addon_slug ) {
// check if this slug globally registered.
if ( in_array( $entry_addon_slug, array_keys( $registered_addons ), true ) ) {
// check if already in static $registered_addons.
if ( ! in_array( $entry_addon_slug, array_keys( self::$poll_registered_addons ), true ) ) {
$addon = forminator_get_addon( $entry_addon_slug );
if ( $addon instanceof Forminator_Integration ) {
try {
$poll_hooks = $addon->get_addon_hooks( $poll_id, 'poll' );
if ( $poll_hooks instanceof Forminator_Integration_Poll_Hooks ) {
self::$poll_registered_addons[ $addon->get_slug() ] = $addon;
}
} catch ( Exception $e ) {
forminator_addon_maybe_log( $addon->get_slug(), 'failed to get_addon_hooks on export', $e->getMessage() );
}
}
}
}
}
}
}
return self::$poll_registered_addons;
}
/**
* Additional Column on Title(first) Row of Export data from Addon [Poll]
*
* @see Forminator_Integration_Poll_Hooks::on_export_render_title_row()
*
* @since 1.6.1
*
* @param int $poll_id Poll Id.
* @param Forminator_Form_Entry_Model[] $entries Entries.
*
* @return array
*/
private function attach_poll_addons_on_export_render_title_row( $poll_id, $entries = array() ) {
$additional_headers = array();
// find all registered addons, so history can be shown even for deactivated addons.
$registered_addons = $this->get_poll_registered_addons( $poll_id, $entries );
foreach ( $registered_addons as $registered_addon ) {
try {
$poll_hooks = $registered_addon->get_addon_hooks( $poll_id, 'poll' );
$addon_headers = $poll_hooks->on_export_render_title_row();
$addon_headers = $this->format_addon_additional_headers( $registered_addon, $addon_headers );
$additional_headers = array_merge( $additional_headers, $addon_headers );
} catch ( Exception $e ) {
forminator_addon_maybe_log( $registered_addon->get_slug(), 'failed to attach_poll_addons_on_export_render_title_row', $e->getMessage() );
}
}
return $additional_headers;
}
/**
* Add addons export render entry row [Poll]
*
* @see Forminator_Integration_Poll_Hooks::on_export_render_entry()
* @since 1.6.1
*
* @param int $form_id Form Id.
* @param Forminator_Form_Entry_Model $entry_model Form entry model.
*
* @return array
*/
private function attach_poll_addons_on_export_render_entry_row( $form_id, Forminator_Form_Entry_Model $entry_model ) {
$additional_data = array();
// find all registered addons, so history can be shown even for deactivated addons.
$registered_addons = $this->get_poll_registered_addons( $form_id );
foreach ( $registered_addons as $registered_addon ) {
try {
$poll_hooks = $registered_addon->get_addon_hooks( $form_id, 'poll' );
$meta_data = forminator_find_addon_meta_data_from_entry_model( $registered_addon, $entry_model );
$addon_data = $poll_hooks->on_export_render_entry( $entry_model, $meta_data );
$addon_data = $this->format_addon_additional_data( $registered_addon, $addon_data );
$additional_data = array_merge( $additional_data, $addon_data );
} catch ( Exception $e ) {
forminator_addon_maybe_log( $registered_addon->get_slug(), 'failed to attach_poll_addons_on_export_render_entry_row', $e->getMessage() );
}
}
return $additional_data;
}
/**
* Get Globally Registered Addons for form_id, avoid overhead for checking registered addons many times [Quiz]
*
* @since 1.6.2
*
* @param int $quiz_id Quiz Id.
* @param Forminator_Form_Entry_Model[] $entries Form entry model.
*
* @return array|Forminator_Integration[]
*/
public function get_quiz_registered_addons( $quiz_id, $entries = array() ) {
if ( empty( self::$quiz_registered_addons ) ) {
self::$quiz_registered_addons = array();
$registered_addons = forminator_get_registered_addons();
foreach ( $entries as $entry ) {
// find registered addon by slug pattern.
$entry_addon_slugs = forminator_find_addon_slugs_from_entry_model( $entry );
foreach ( $entry_addon_slugs as $entry_addon_slug ) {
// check if this slug globally registered.
if ( in_array( $entry_addon_slug, array_keys( $registered_addons ), true ) ) {
// check if already in static $registered_addons.
if ( ! in_array( $entry_addon_slug, array_keys( self::$quiz_registered_addons ), true ) ) {
$addon = forminator_get_addon( $entry_addon_slug );
if ( $addon instanceof Forminator_Integration ) {
try {
$quiz_hooks = $addon->get_addon_hooks( $quiz_id, 'quiz' );
if ( $quiz_hooks instanceof Forminator_Integration_Quiz_Hooks ) {
self::$quiz_registered_addons[ $addon->get_slug() ] = $addon;
}
} catch ( Exception $e ) {
forminator_addon_maybe_log( $addon->get_slug(), 'failed to get_addon_hooks on export', $e->getMessage() );
}
}
}
}
}
}
}
return self::$quiz_registered_addons;
}
/**
* Additional Column on Title(first) Row of Export data from Addon [Quiz]
*
* @see Forminator_Integration_Quiz_Hooks::on_export_render_title_row()
*
* @since 1.6.2
*
* @param int $quiz_id Quiz Id.
* @param Forminator_Form_Entry_Model[] $entries Entries.
*
* @return array
*/
private function attach_quiz_addons_on_export_render_title_row( $quiz_id, $entries = array() ) {
$additional_headers = array();
// find all registered addons, so history can be shown even for deactivated addons.
$registered_addons = $this->get_quiz_registered_addons( $quiz_id, $entries );
foreach ( $registered_addons as $registered_addon ) {
try {
$quiz_hooks = $registered_addon->get_addon_hooks( $quiz_id, 'quiz' );
$addon_headers = $quiz_hooks->on_export_render_title_row();
$addon_headers = $this->format_addon_additional_headers( $registered_addon, $addon_headers );
$additional_headers = array_merge( $additional_headers, $addon_headers );
} catch ( Exception $e ) {
forminator_addon_maybe_log( $registered_addon->get_slug(), 'failed to attach_quiz_addons_on_export_render_title_row', $e->getMessage() );
}
}
return $additional_headers;
}
/**
* Add addons export render entry row [Quiz]
*
* @see Forminator_Integration_Quiz_Hooks::on_export_render_entry()
* @since 1.6.2
*
* @param int $form_id Form Id.
* @param Forminator_Form_Entry_Model $entry_model Form entry model.
*
* @return array
*/
private function attach_quiz_addons_on_export_render_entry_row( $form_id, Forminator_Form_Entry_Model $entry_model ) {
$additional_data = array();
// find all registered addons, so history can be shown even for deactivated addons.
$registered_addons = $this->get_quiz_registered_addons( $form_id );
foreach ( $registered_addons as $registered_addon ) {
try {
$quiz_hooks = $registered_addon->get_addon_hooks( $form_id, 'quiz' );
$meta_data = forminator_find_addon_meta_data_from_entry_model( $registered_addon, $entry_model );
$addon_data = $quiz_hooks->on_export_render_entry( $entry_model, $meta_data );
$addon_data = $this->format_addon_additional_data( $registered_addon, $addon_data );
$additional_data = array_merge( $additional_data, $addon_data );
} catch ( Exception $e ) {
forminator_addon_maybe_log( $registered_addon->get_slug(), 'failed to attach_quiz_addons_on_export_render_entry_row', $e->getMessage() );
}
}
return $additional_data;
}
/**
* Get mapper data
*
* @param array $mappers Mappers.
* @param string $entry Entry.
*
* @return array
*/
public function get_mapper_export_data( $mappers, $entry ) {
$data = array();
if ( ! empty( $mappers ) ) {
// traverse from fields to be correctly mapped with updated form fields.
foreach ( $mappers as $mapper ) {
if ( 'entry_time_created' === $mapper['type'] ) {
continue;
}
// its from model's property.
if ( isset( $mapper['property'] ) ) {
if ( property_exists( $entry, $mapper['property'] ) ) {
$property = $mapper['property'];
// casting property to string.
$data[] = (string) $entry->$property;
} else {
$data[] = '';
}
} else {
// meta_key based.
$meta_value = $entry->get_meta( $mapper['meta_key'], '' );
if ( ! isset( $mapper['sub_metas'] ) ) {
$data[ $mapper['meta_key'] ] = Forminator_Form_Entry_Model::meta_value_to_string( $mapper['type'], $meta_value );
} else {
// sub_metas available.
foreach ( $mapper['sub_metas'] as $sub_meta ) {
$sub_key = $sub_meta['key'];
if ( isset( $meta_value[ $sub_key ] ) && ! empty( $meta_value[ $sub_key ] ) ) {
$value = $meta_value[ $sub_key ];
$field_type = $mapper['type'] . '.' . $sub_key;
$data[ $sub_key ] = Forminator_Form_Entry_Model::meta_value_to_string( $field_type, $value );
} else {
$data[ $sub_key ] = '';
}
}
}
}
}
}
return $data;
}
}