<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Emails;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Class Preview.

[5] Fix | Delete

* Handles previewing email templates.

[6] Fix | Delete

*

[7] Fix | Delete

* @since 1.8.5

[8] Fix | Delete

*/

[9] Fix | Delete

class Preview {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* List of preview fields.

[13] Fix | Delete

*

[14] Fix | Delete

* @since 1.8.5

[15] Fix | Delete

*

[16] Fix | Delete

* @var array

[17] Fix | Delete

*/

[18] Fix | Delete

private $fields = [];

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Current email template.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 1.8.5

[24] Fix | Delete

*

[25] Fix | Delete

* @var string

[26] Fix | Delete

*/

[27] Fix | Delete

private $current_template;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Field template.

[31] Fix | Delete

*

[32] Fix | Delete

* @since 1.8.5

[33] Fix | Delete

*

[34] Fix | Delete

* @var string

[35] Fix | Delete

*/

[36] Fix | Delete

private $field_template;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Content is plain text type.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.8.5

[42] Fix | Delete

*

[43] Fix | Delete

* @var bool

[44] Fix | Delete

*/

[45] Fix | Delete

private $plain_text;

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Preview nonce name.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.8.5

[51] Fix | Delete

*

[52] Fix | Delete

* @var string

[53] Fix | Delete

*/

[54] Fix | Delete

const PREVIEW_NONCE_NAME = 'wpforms_email_preview';

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* XOR key.

[58] Fix | Delete

*

[59] Fix | Delete

* The encryption key is a critical element in encryption algorithms,

[60] Fix | Delete

* playing a crucial role in XOR encryption as employed in the WPFormsXOR plugin class.

[61] Fix | Delete

* This key serves to govern the transformation of data during both encryption and decryption processes.

[62] Fix | Delete

*

[63] Fix | Delete

* The default and placeholder value for the key, as defined in the plugin class, is set to 42.

[64] Fix | Delete

* If you wish to employ a different key (any numerical value is acceptable), you must provide

[65] Fix | Delete

* that specific number to the plugin instance. It's essential to use the exact same key for

[66] Fix | Delete

* both encrypting and decrypting data in the PHP environment as well.

[67] Fix | Delete

*

[68] Fix | Delete

* @since 1.8.6

[69] Fix | Delete

*

[70] Fix | Delete

* @var int

[71] Fix | Delete

*/

[72] Fix | Delete

const XOR_KEY = 42;

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Initialize class.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 1.8.5

[78] Fix | Delete

*/

[79] Fix | Delete

public function init() {

[80] Fix | Delete

[81] Fix | Delete

// Leave if user can't access.

[82] Fix | Delete

if ( ! wpforms_current_user_can() ) {

[83] Fix | Delete

return;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

// Leave early if nonce verification failed.

[87] Fix | Delete

if ( ! isset( $_GET['_wpnonce'] ) || ! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), self::PREVIEW_NONCE_NAME ) ) {

[88] Fix | Delete

return;

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

// Leave early if preview is not requested.

[92] Fix | Delete

if ( ! isset( $_GET['wpforms_email_preview'], $_GET['wpforms_email_template'] ) ) {

[93] Fix | Delete

return;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

$this->current_template = sanitize_key( $_GET['wpforms_email_template'] );

[97] Fix | Delete

$this->plain_text = $this->current_template === 'none';

[98] Fix | Delete

[99] Fix | Delete

$this->hooks();

[100] Fix | Delete

$this->preview();

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Hooks.

[105] Fix | Delete

*

[106] Fix | Delete

* @since 1.8.6

[107] Fix | Delete

*/

[108] Fix | Delete

private function hooks() {

[109] Fix | Delete

[110] Fix | Delete

add_filter( 'wpforms_emails_templates_notifications_get_header_image', [ $this, 'edit_current_template_header_image' ] );

[111] Fix | Delete

add_filter( 'wpforms_emails_helpers_style_overrides_args', [ $this, 'edit_current_template_style_overrides' ] );

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* This filter is used to override the current email template header image.

[116] Fix | Delete

*

[117] Fix | Delete

* This is needed to make sure the preview link is able to reflect the

[118] Fix | Delete

* changes made in the email template style settings without saving the settings page.

[119] Fix | Delete

*

[120] Fix | Delete

* @since 1.8.6

[121] Fix | Delete

*

[122] Fix | Delete

* @param array $header_image The current email template header image.

[123] Fix | Delete

*

[124] Fix | Delete

* @return array

[125] Fix | Delete

*/

[126] Fix | Delete

public function edit_current_template_header_image( $header_image ) {

[127] Fix | Delete

[128] Fix | Delete

// Get style overrides.

[129] Fix | Delete

$overrides = $this->get_style_overrides();

[130] Fix | Delete

[131] Fix | Delete

// Leave early if no overrides are passed for the preview.

[132] Fix | Delete

if ( empty( $header_image ) || empty( $overrides ) ) {

[133] Fix | Delete

return $header_image;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

// Check for the presence of light mode header image in the query string.

[137] Fix | Delete

if ( isset( $overrides['email_header_image'] ) ) {

[138] Fix | Delete

$header_image['url_light'] = esc_url_raw( $overrides['email_header_image'] );

[139] Fix | Delete

[140] Fix | Delete

// Check for the presence of light mode header image size in the query string.

[141] Fix | Delete

if ( ! empty( $overrides['email_header_image_size'] ) ) {

[142] Fix | Delete

$header_image['size_light'] = sanitize_text_field( $overrides['email_header_image_size'] );

[143] Fix | Delete

}

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

// Check for the presence of dark mode header image in the query string.

[147] Fix | Delete

if ( isset( $overrides['email_header_image_dark'] ) ) {

[148] Fix | Delete

$header_image['url_dark'] = esc_url_raw( $overrides['email_header_image_dark'] );

[149] Fix | Delete

[150] Fix | Delete

if ( ! empty( $overrides['email_header_image_size_dark'] ) ) {

[151] Fix | Delete

$header_image['size_dark'] = sanitize_text_field( $overrides['email_header_image_size_dark'] );

[152] Fix | Delete

}

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

return $header_image;

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* This filter is used to override the current email template style overrides.

[160] Fix | Delete

*

[161] Fix | Delete

* This is needed to make sure the preview link is able to reflect the

[162] Fix | Delete

* changes made in the email template style settings without saving the settings page.

[163] Fix | Delete

*

[164] Fix | Delete

* @since 1.8.6

[165] Fix | Delete

*

[166] Fix | Delete

* @param array $styles The current email template styles.

[167] Fix | Delete

*

[168] Fix | Delete

* @return array

[169] Fix | Delete

*/

[170] Fix | Delete

public function edit_current_template_style_overrides( $styles ) {

[171] Fix | Delete

[172] Fix | Delete

// Get style overrides.

[173] Fix | Delete

$overrides = $this->get_style_overrides();

[174] Fix | Delete

[175] Fix | Delete

// Leave early if no overrides are passed for the preview.

[176] Fix | Delete

if ( empty( $overrides ) ) {

[177] Fix | Delete

return $styles;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

// Check for the presence of light mode background color in the query string.

[181] Fix | Delete

if ( ! empty( $overrides['email_background_color'] ) ) {

[182] Fix | Delete

$styles['email_background_color'] = sanitize_hex_color( $overrides['email_background_color'] );

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

// Check for the presence of dark mode background color in the query string.

[186] Fix | Delete

if ( ! empty( $overrides['email_background_color_dark'] ) ) {

[187] Fix | Delete

$styles['email_background_color_dark'] = sanitize_hex_color( $overrides['email_background_color_dark'] );

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

// Leave early if the user has the Lite version.

[191] Fix | Delete

if ( ! wpforms()->is_pro() ) {

[192] Fix | Delete

// The only allowed override for the Lite version is the header image size.

[193] Fix | Delete

// This is needed to make sure the preview link is able to reflect the

[194] Fix | Delete

// changes made in the email template style settings without saving the settings page.

[195] Fix | Delete

if ( empty( $overrides['email_header_image_size'] ) ) {

[196] Fix | Delete

// Return the styles if no header image size override is passed for the preview.

[197] Fix | Delete

return $styles;

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

// Override and process the header image size.

[201] Fix | Delete

$overrides = [ 'email_header_image_size' => $overrides['email_header_image_size'] ];

[202] Fix | Delete

[203] Fix | Delete

return $this->process_allowed_overrides( $styles, $overrides );

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

// Process allowed overrides using a separate function.

[207] Fix | Delete

return $this->process_allowed_overrides( $styles, $overrides );

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

/**

[211] Fix | Delete

* Get style overrides.

[212] Fix | Delete

*

[213] Fix | Delete

* @since 1.8.6

[214] Fix | Delete

*

[215] Fix | Delete

* @return array

[216] Fix | Delete

*/

[217] Fix | Delete

private function get_style_overrides() {

[218] Fix | Delete

[219] Fix | Delete

// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized

[220] Fix | Delete

// Check if the 'wpforms_email_style_overrides' parameter is empty.

[221] Fix | Delete

if ( empty( $_GET['wpforms_email_style_overrides'] ) ) {

[222] Fix | Delete

return [];

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

// Retrieve and unslash the encoded style overrides from the query string.

[226] Fix | Delete

$style_overrides = wp_unslash( $_GET['wpforms_email_style_overrides'] );

[227] Fix | Delete

// phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized

[228] Fix | Delete

[229] Fix | Delete

$overrides = '';

[230] Fix | Delete

$overrides_len = strlen( $style_overrides );

[231] Fix | Delete

[232] Fix | Delete

// Decode the overrides.

[233] Fix | Delete

// This is needed because the overrides are encoded before being passed in the query string.

[234] Fix | Delete

for ( $i = 0; $i < $overrides_len; $i++ ) {

[235] Fix | Delete

$overrides .= chr( ord( $style_overrides[ $i ] ) ^ self::XOR_KEY );

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

// Return the decoded overrides as an associative array.

[239] Fix | Delete

return json_decode( $overrides, true );

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Process allowed style overrides.

[244] Fix | Delete

*

[245] Fix | Delete

* @since 1.8.6

[246] Fix | Delete

*

[247] Fix | Delete

* @param array $styles Current styles.

[248] Fix | Delete

* @param array $overrides Style overrides.

[249] Fix | Delete

*

[250] Fix | Delete

* @return array Updated styles.

[251] Fix | Delete

*/

[252] Fix | Delete

private function process_allowed_overrides( $styles, $overrides ) {

[253] Fix | Delete

[254] Fix | Delete

// Leave early if no overrides are passed for the preview.

[255] Fix | Delete

if ( empty( $overrides ) ) {

[256] Fix | Delete

return $styles;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

// Define an array of allowed query parameters.

[260] Fix | Delete

$allowed_overrides = [

[261] Fix | Delete

'email_body_color',

[262] Fix | Delete

'email_text_color',

[263] Fix | Delete

'email_links_color',

[264] Fix | Delete

'email_typography',

[265] Fix | Delete

'email_header_image_size',

[266] Fix | Delete

'email_body_color_dark',

[267] Fix | Delete

'email_text_color_dark',

[268] Fix | Delete

'email_links_color_dark',

[269] Fix | Delete

'email_typography_dark',

[270] Fix | Delete

'email_header_image_size_dark',

[271] Fix | Delete

];

[272] Fix | Delete

[273] Fix | Delete

// Loop through allowed parameters and update $overrides if present in the query string.

[274] Fix | Delete

foreach ( $allowed_overrides as $param ) {

[275] Fix | Delete

// Leave early if the parameter is not present in the query string.

[276] Fix | Delete

if ( empty( $overrides[ $param ] ) ) {

[277] Fix | Delete

continue;

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

$styles = $this->process_override( $param, $styles, $overrides );

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

return $styles;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Process a specific style override.

[288] Fix | Delete

*

[289] Fix | Delete

* @since 1.8.6

[290] Fix | Delete

*

[291] Fix | Delete

* @param string $param Style parameter.

[292] Fix | Delete

* @param array $styles Current styles.

[293] Fix | Delete

* @param array $overrides Style overrides.

[294] Fix | Delete

*

[295] Fix | Delete

* @return array Updated styles.

[296] Fix | Delete

*/

[297] Fix | Delete

private function process_override( $param, $styles, $overrides ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh

[298] Fix | Delete

[299] Fix | Delete

// Use a switch to handle specific cases.

[300] Fix | Delete

switch ( $param ) {

[301] Fix | Delete

case 'email_body_color':

[302] Fix | Delete

case 'email_text_color':

[303] Fix | Delete

case 'email_links_color':

[304] Fix | Delete

case 'email_body_color_dark':

[305] Fix | Delete

case 'email_text_color_dark':

[306] Fix | Delete

case 'email_links_color_dark':

[307] Fix | Delete

$styles[ $param ] = sanitize_hex_color( $overrides[ $param ] );

[308] Fix | Delete

break;

[309] Fix | Delete

[310] Fix | Delete

case 'email_typography':

[311] Fix | Delete

case 'email_typography_dark':

[312] Fix | Delete

$styles[ $param ] = Helpers::get_template_typography( sanitize_text_field( $overrides[ $param ] ) );

[313] Fix | Delete

break;

[314] Fix | Delete

[315] Fix | Delete

case 'email_header_image_size':

[316] Fix | Delete

$header_image_size = Helpers::get_template_header_image_size( sanitize_text_field( $overrides[ $param ] ) );

[317] Fix | Delete

$styles['header_image_max_width'] = $header_image_size['width'];

[318] Fix | Delete

$styles['header_image_max_height'] = $header_image_size['height'];

[319] Fix | Delete

break;

[320] Fix | Delete

[321] Fix | Delete

case 'email_header_image_size_dark':

[322] Fix | Delete

$header_image_size_dark = Helpers::get_template_header_image_size( sanitize_text_field( $overrides[ $param ] ) );

[323] Fix | Delete

$styles['header_image_max_width_dark'] = $header_image_size_dark['width'];

[324] Fix | Delete

$styles['header_image_max_height_dark'] = $header_image_size_dark['height'];

[325] Fix | Delete

break;

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

return $styles;

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Preview email template.

[333] Fix | Delete

*

[334] Fix | Delete

* @since 1.8.5

[335] Fix | Delete

*/

[336] Fix | Delete

private function preview() {

[337] Fix | Delete

[338] Fix | Delete

$template = Notifications::get_available_templates( $this->current_template );

[339] Fix | Delete

[340] Fix | Delete

/**

[341] Fix | Delete

* Filter the email template to be previewed.

[342] Fix | Delete

*

[343] Fix | Delete

* @since 1.8.5

[344] Fix | Delete

*

[345] Fix | Delete

* @param array $template Email template.

[346] Fix | Delete

*/

[347] Fix | Delete

$template = (array) apply_filters( 'wpforms_emails_preview_template', $template );

[348] Fix | Delete

[349] Fix | Delete

// Redirect to the email settings page if the template is not set.

[350] Fix | Delete

if ( ! isset( $template['path'] ) || ! class_exists( $template['path'] ) ) {

[351] Fix | Delete

wp_safe_redirect(

[352] Fix | Delete

add_query_arg(

[353] Fix | Delete

[

[354] Fix | Delete

'page' => 'wpforms-settings',

[355] Fix | Delete

'view' => 'email',

[356] Fix | Delete

],

[357] Fix | Delete

admin_url( 'admin.php' )

[358] Fix | Delete

)

[359] Fix | Delete

);

[360] Fix | Delete

exit;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

// Set the email template, i.e. WPForms\Emails\Templates\Classic.

[364] Fix | Delete

$template = new $template['path']( '', true );

[365] Fix | Delete

[366] Fix | Delete

// Set the field template.

[367] Fix | Delete

// This is used to replace the placeholders in the email template.

[368] Fix | Delete

$this->field_template = $template->get_field_template();

[369] Fix | Delete

[370] Fix | Delete

// Set the email template fields.

[371] Fix | Delete

$template->set_field( $this->get_placeholder_message() );

[372] Fix | Delete

[373] Fix | Delete

// Get the email template content.

[374] Fix | Delete

$content = $template->get();

[375] Fix | Delete

[376] Fix | Delete

// Return if the template is empty.

[377] Fix | Delete

if ( ! $content ) {

[378] Fix | Delete

return;

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

// Echo the email template content.

[382] Fix | Delete

echo $content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[383] Fix | Delete

[384] Fix | Delete

exit; // No need to continue. WordPress will die() after this.

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

/**

[388] Fix | Delete

* Get preview content.

[389] Fix | Delete

*

[390] Fix | Delete

* @since 1.8.5

[391] Fix | Delete

*

[392] Fix | Delete

* @return string Placeholder message.

[393] Fix | Delete

*/

[394] Fix | Delete

private function get_placeholder_message() {

[395] Fix | Delete

[396] Fix | Delete

$this->fields = [

[397] Fix | Delete

[

[398] Fix | Delete

'type' => 'name',

[399] Fix | Delete

'name' => __( 'Name', 'wpforms-lite' ),

[400] Fix | Delete

'value' => 'Sullie Eloso',

[401] Fix | Delete

],

[402] Fix | Delete

[

[403] Fix | Delete

'type' => 'email',

[404] Fix | Delete

'name' => __( 'Email', 'wpforms-lite' ),

[405] Fix | Delete

'value' => 'sullie@wpforms.com',

[406] Fix | Delete

],

[407] Fix | Delete

[

[408] Fix | Delete

'type' => 'textarea',

[409] Fix | Delete

'name' => __( 'Comment or Message', 'wpforms-lite' ),

[410] Fix | Delete

'value' => "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Odio ut sem nulla pharetra diam sit amet. Sed risus pretium quam vulputate dignissim suspendisse in est ante. Risus ultricies tristique nulla aliquet enim tortor at auctor. Nisl tincidunt eget nullam non nisi est sit amet facilisis. Duis at tellus at urna condimentum mattis pellentesque id nibh. Curabitur vitae nunc sed velit dignissim.\r\n\r\nLeo urna molestie at elementum eu facilisis sed odio. Scelerisque mauris pellentesque pulvinar pellentesque habitant morbi. Volutpat maecenas volutpat blandit aliquam. Libero id faucibus nisl tincidunt. Et malesuada fames ac turpis egestas.",

[411] Fix | Delete

],

[412] Fix | Delete

];

[413] Fix | Delete

[414] Fix | Delete

// Early return if the template is plain text.

[415] Fix | Delete

if ( $this->plain_text ) {

[416] Fix | Delete

return $this->process_plain_message();

[417] Fix | Delete

}

[418] Fix | Delete

[419] Fix | Delete

return $this->process_html_message();

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

/**

[423] Fix | Delete

* Process the HTML email message.

[424] Fix | Delete

*

[425] Fix | Delete

* @since 1.8.5

[426] Fix | Delete

*

[427] Fix | Delete

* @return string

[428] Fix | Delete

*/

[429] Fix | Delete

private function process_html_message() {

[430] Fix | Delete

[431] Fix | Delete

$message = '';

[432] Fix | Delete

[433] Fix | Delete

foreach ( $this->fields as $field ) {

[434] Fix | Delete

$message .= str_replace(

[435] Fix | Delete

[ '{field_type}', '{field_name}', '{field_value}', "\r\n" ],

[436] Fix | Delete

[ $field['type'], $field['name'], $field['value'], '<br>' ],

[437] Fix | Delete

$this->field_template

[438] Fix | Delete

);

[439] Fix | Delete

}

[440] Fix | Delete

[441] Fix | Delete

return $message;

[442] Fix | Delete

}

[443] Fix | Delete

[444] Fix | Delete

/**

[445] Fix | Delete

* Process the plain text email message.

[446] Fix | Delete

*

[447] Fix | Delete

* @since 1.8.5

[448] Fix | Delete

*

[449] Fix | Delete

* @return string

[450] Fix | Delete

*/

[451] Fix | Delete

private function process_plain_message() {

[452] Fix | Delete

[453] Fix | Delete

$message = '';

[454] Fix | Delete

[455] Fix | Delete

foreach ( $this->fields as $field ) {

[456] Fix | Delete

$message .= '--- ' . $field['name'] . " ---\r\n\r\n" . str_replace( [ "\n", "\r" ], '', $field['value'] ) . "\r\n\r\n";

[457] Fix | Delete

}

[458] Fix | Delete

[459] Fix | Delete

return nl2br( $message );

[460] Fix | Delete

}

[461] Fix | Delete

}

[462] Fix | Delete

[463] Fix | Delete