<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Builder;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Requirements\Requirements;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Addons class.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.9.2

[9] Fix | Delete

*/

[10] Fix | Delete

class Addons {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* List of addon options.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.9.2

[16] Fix | Delete

*/

[17] Fix | Delete

private const FIELD_OPTIONS = [

[18] Fix | Delete

'calculations' => [

[19] Fix | Delete

'calculation_code',

[20] Fix | Delete

'calculation_code_js',

[21] Fix | Delete

'calculation_code_php',

[22] Fix | Delete

'calculation_is_enabled',

[23] Fix | Delete

],

[24] Fix | Delete

'form-locker' => [

[25] Fix | Delete

'unique_answer',

[26] Fix | Delete

],

[27] Fix | Delete

'geolocation' => [

[28] Fix | Delete

'display_map',

[29] Fix | Delete

'enable_address_autocomplete',

[30] Fix | Delete

'map_position',

[31] Fix | Delete

],

[32] Fix | Delete

'surveys-polls' => [

[33] Fix | Delete

'survey',

[34] Fix | Delete

],

[35] Fix | Delete

'quiz' => [

[36] Fix | Delete

'quiz_enabled',

[37] Fix | Delete

'choices' => [

[38] Fix | Delete

'quiz_personality',

[39] Fix | Delete

'quiz_weight',

[40] Fix | Delete

],

[41] Fix | Delete

],

[42] Fix | Delete

];

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Initialize.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 1.9.2

[48] Fix | Delete

*

[49] Fix | Delete

* @noinspection ReturnTypeCanBeDeclaredInspection

[50] Fix | Delete

*/

[51] Fix | Delete

public function init() {

[52] Fix | Delete

[53] Fix | Delete

$this->hooks();

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Add hooks.

[58] Fix | Delete

*

[59] Fix | Delete

* @since 1.9.2

[60] Fix | Delete

*/

[61] Fix | Delete

private function hooks(): void {

[62] Fix | Delete

[63] Fix | Delete

add_filter( 'wpforms_save_form_args', [ $this, 'save_disabled_addons_options' ], 10, 3 );

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Field's options added by an addon can be deleted when the addon is deactivated or have incompatible status.

[69] Fix | Delete

* The options are fully controlled by the addon when addon is active and compatible.

[70] Fix | Delete

*

[71] Fix | Delete

* @since 1.9.2

[72] Fix | Delete

*

[73] Fix | Delete

* @param array|mixed $post_data Post data.

[74] Fix | Delete

*

[75] Fix | Delete

* @return array

[76] Fix | Delete

*/

[77] Fix | Delete

public function save_disabled_addons_options( $post_data ): array {

[78] Fix | Delete

[79] Fix | Delete

$post_data = (array) $post_data;

[80] Fix | Delete

$form_obj = wpforms()->obj( 'form' );

[81] Fix | Delete

$form_data = json_decode( stripslashes( $post_data['post_content'] ?? '' ), true );

[82] Fix | Delete

$form_id = $form_data['id'] ?? '';

[83] Fix | Delete

[84] Fix | Delete

if ( ! $form_obj || ! $form_id ) {

[85] Fix | Delete

return $post_data;

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

$previous_form_data = $form_obj->get( $form_id, [ 'content_only' => true ] );

[89] Fix | Delete

$not_validated_addons = Requirements::get_instance()->get_not_validated_addons();

[90] Fix | Delete

[91] Fix | Delete

if ( empty( $previous_form_data ) || empty( $not_validated_addons ) ) {

[92] Fix | Delete

return $post_data;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

foreach ( $not_validated_addons as $path ) {

[96] Fix | Delete

$slug = str_replace( 'wpforms-', '', basename( $path, '.php' ) );

[97] Fix | Delete

[98] Fix | Delete

$this->preserve_addon( $slug, $form_data, $previous_form_data );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

$this->preserve_providers( $form_data, $previous_form_data );

[102] Fix | Delete

$this->preserve_payments( $form_data, $previous_form_data );

[103] Fix | Delete

[104] Fix | Delete

$post_data['post_content'] = wpforms_encode( $form_data );

[105] Fix | Delete

[106] Fix | Delete

return $post_data;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Preserve addon fields, settings, panels, notifications, etc.

[111] Fix | Delete

*

[112] Fix | Delete

* @since 1.9.3

[113] Fix | Delete

*

[114] Fix | Delete

* @param string $slug Addon slug.

[115] Fix | Delete

* @param array $form_data Form data.

[116] Fix | Delete

* @param array $previous_form_data Previous form data.

[117] Fix | Delete

*

[118] Fix | Delete

* @return void

[119] Fix | Delete

*/

[120] Fix | Delete

private function preserve_addon( string $slug, array &$form_data, array $previous_form_data ): void {

[121] Fix | Delete

[122] Fix | Delete

if ( ! empty( $form_data['fields'] ) && ! empty( $previous_form_data['fields'] ) ) {

[123] Fix | Delete

$this->preserve_addon_fields_settings( $slug, $form_data['fields'], $previous_form_data['fields'] );

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

$this->preserve_addon_panel( $slug, $form_data, $previous_form_data );

[127] Fix | Delete

[128] Fix | Delete

if ( ! empty( $form_data['settings'] ) && ! empty( $previous_form_data['settings'] ) ) {

[129] Fix | Delete

$this->preserve_addon_settings( $slug, $form_data['settings'], $previous_form_data['settings'] );

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

if ( ! empty( $form_data['settings']['notifications'] ) && ! empty( $previous_form_data['settings']['notifications'] ) ) {

[133] Fix | Delete

$this->preserve_addon_notifications(

[134] Fix | Delete

$slug,

[135] Fix | Delete

$form_data['settings']['notifications'],

[136] Fix | Delete

$previous_form_data['settings']['notifications']

[137] Fix | Delete

);

[138] Fix | Delete

}

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Preserve addon fields.

[143] Fix | Delete

*

[144] Fix | Delete

* @since 1.9.5

[145] Fix | Delete

*

[146] Fix | Delete

* @param string $slug Addon slug.

[147] Fix | Delete

* @param array $new_fields Form fields settings.

[148] Fix | Delete

* @param array $previous_fields Previous form fields settings.

[149] Fix | Delete

*

[150] Fix | Delete

* @return void

[151] Fix | Delete

*/

[152] Fix | Delete

private function preserve_addon_fields_settings( string $slug, array &$new_fields, array $previous_fields ): void {

[153] Fix | Delete

[154] Fix | Delete

foreach ( $previous_fields as $field_id => $previous_field ) {

[155] Fix | Delete

$new_field = $new_fields[ $field_id ] ?? [];

[156] Fix | Delete

[157] Fix | Delete

if ( empty( $new_field ) ) {

[158] Fix | Delete

continue;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

$this->preserve_addon_field_settings( $slug, $new_field, $previous_field );

[162] Fix | Delete

[163] Fix | Delete

$new_fields[ $field_id ] = $new_field;

[164] Fix | Delete

}

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* Preserve addon field.

[169] Fix | Delete

*

[170] Fix | Delete

* @since 1.9.5

[171] Fix | Delete

*

[172] Fix | Delete

* @param string $slug Addon slug.

[173] Fix | Delete

* @param array $new_field Previous form fields settings.

[174] Fix | Delete

* @param array $previous_field Form fields settings.

[175] Fix | Delete

*

[176] Fix | Delete

* @return void

[177] Fix | Delete

*/

[178] Fix | Delete

private function preserve_addon_field_settings( string $slug, array &$new_field, array $previous_field ): void {

[179] Fix | Delete

[180] Fix | Delete

$prefix = $this->prepare_prefix( $slug );

[181] Fix | Delete

$changed_settings = array_diff_key( $previous_field, $new_field );

[182] Fix | Delete

$preserve_fields = self::FIELD_OPTIONS[ $slug ] ?? [];

[183] Fix | Delete

[184] Fix | Delete

foreach ( $changed_settings as $setting_name => $setting_value ) {

[185] Fix | Delete

if (

[186] Fix | Delete

strpos( $setting_name, $prefix ) === 0 ||

[187] Fix | Delete

in_array( $setting_name, $preserve_fields, true )

[188] Fix | Delete

) {

[189] Fix | Delete

$new_field[ $setting_name ] = $setting_value;

[190] Fix | Delete

}

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

if (

[194] Fix | Delete

! empty( $preserve_fields['choices'] ) &&

[195] Fix | Delete

is_array( $preserve_fields['choices'] ) &&

[196] Fix | Delete

! empty( $new_field['choices'] ) &&

[197] Fix | Delete

is_array( $new_field['choices'] )

[198] Fix | Delete

) {

[199] Fix | Delete

$this->preserve_addon_field_choices_settings( $preserve_fields['choices'], $new_field, $previous_field );

[200] Fix | Delete

}

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

/**

[204] Fix | Delete

* Preserve addon field choices settings.

[205] Fix | Delete

*

[206] Fix | Delete

* @since 1.9.9

[207] Fix | Delete

*

[208] Fix | Delete

* @param array $choice_settings Choice settings.

[209] Fix | Delete

* @param array $new_field Previous form fields settings.

[210] Fix | Delete

* @param array $previous_field Form fields settings.

[211] Fix | Delete

*

[212] Fix | Delete

* @return void

[213] Fix | Delete

*/

[214] Fix | Delete

private function preserve_addon_field_choices_settings( array $choice_settings, array &$new_field, array $previous_field ): void {

[215] Fix | Delete

[216] Fix | Delete

if ( ! isset( $previous_field['choices'] ) || ! is_array( $previous_field['choices'] ) ) {

[217] Fix | Delete

return;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

$previous_choices = $previous_field['choices'];

[221] Fix | Delete

[222] Fix | Delete

foreach ( $new_field['choices'] as $choice_id => $choice ) {

[223] Fix | Delete

foreach ( $choice_settings as $setting_name ) {

[224] Fix | Delete

if ( isset( $previous_choices[ $choice_id ][ $setting_name ] ) ) {

[225] Fix | Delete

$new_field['choices'][ $choice_id ][ $setting_name ] = $previous_choices[ $choice_id ][ $setting_name ];

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

}

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* Preserve addon panel.

[233] Fix | Delete

*

[234] Fix | Delete

* @since 1.9.3

[235] Fix | Delete

*

[236] Fix | Delete

* @param string $slug Addon slug.

[237] Fix | Delete

* @param array $form_data Form data.

[238] Fix | Delete

* @param array $previous_form_data Previous form data.

[239] Fix | Delete

*/

[240] Fix | Delete

private function preserve_addon_panel( string $slug, array &$form_data, array $previous_form_data ): void {

[241] Fix | Delete

[242] Fix | Delete

$panel = $this->prepare_prefix( $slug );

[243] Fix | Delete

[244] Fix | Delete

// The addon settings stored its own panel, e.g., $form_data[lead_forms], $form_data[webhooks], etc.

[245] Fix | Delete

if ( ! empty( $previous_form_data[ $panel ] ) ) {

[246] Fix | Delete

$form_data[ $panel ] = $previous_form_data[ $panel ];

[247] Fix | Delete

}

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Preserve addon settings stored inside the settings panel with a specific prefix.

[252] Fix | Delete

* e.g. $form_data[settings][{$prefix}_enabled], $form_data[settings][{$prefix}_email], etc.

[253] Fix | Delete

*

[254] Fix | Delete

* @since 1.9.4

[255] Fix | Delete

*

[256] Fix | Delete

* @param string $slug Addon option prefix.

[257] Fix | Delete

* @param array $new_settings Form settings.

[258] Fix | Delete

* @param array $previous_settings Previous form settings.

[259] Fix | Delete

*/

[260] Fix | Delete

private function preserve_addon_settings( string $slug, array &$new_settings, array $previous_settings ): void {

[261] Fix | Delete

[262] Fix | Delete

$prefix = $this->prepare_prefix( $slug );

[263] Fix | Delete

[264] Fix | Delete

static $legacy_options = [

[265] Fix | Delete

'offline_forms' => [ 'offline_form' ],

[266] Fix | Delete

'user_registration' => [ 'user_login_hide', 'user_reset_hide' ],

[267] Fix | Delete

'surveys_polls' => [ 'survey_enable', 'poll_enable' ],

[268] Fix | Delete

];

[269] Fix | Delete

[270] Fix | Delete

// BC: User Registration addon has `registration_` prefix instead of `user_registration`.

[271] Fix | Delete

if ( $prefix === 'user_registration' ) {

[272] Fix | Delete

$prefix = 'registration';

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

foreach ( $previous_settings as $setting_name => $value ) {

[276] Fix | Delete

if ( strpos( $setting_name, $prefix ) === 0 ) {

[277] Fix | Delete

$new_settings[ $setting_name ] = $value;

[278] Fix | Delete

[279] Fix | Delete

continue;

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

// BC: The options don't have a prefix and hard-coded in the `$legacy_options` variable.

[283] Fix | Delete

if ( isset( $legacy_options[ $prefix ] ) && in_array( $setting_name, $legacy_options[ $prefix ], true ) ) {

[284] Fix | Delete

$new_settings[ $setting_name ] = $value;

[285] Fix | Delete

}

[286] Fix | Delete

}

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Preserve addon notifications.

[291] Fix | Delete

*

[292] Fix | Delete

* @since 1.9.4

[293] Fix | Delete

*

[294] Fix | Delete

* @param string $slug Addon slug.

[295] Fix | Delete

* @param array $new_notifications List of form notifications.

[296] Fix | Delete

* @param array $previous_notifications Previously saved list of form notifications.

[297] Fix | Delete

*

[298] Fix | Delete

* @return void

[299] Fix | Delete

*/

[300] Fix | Delete

private function preserve_addon_notifications( string $slug, array &$new_notifications, array $previous_notifications ): void {

[301] Fix | Delete

[302] Fix | Delete

$prefix = $this->prepare_prefix( $slug );

[303] Fix | Delete

[304] Fix | Delete

foreach ( $previous_notifications as $notification_id => $notification_settings ) {

[305] Fix | Delete

if ( empty( $new_notifications[ $notification_id ] ) ) {

[306] Fix | Delete

continue;

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

$changed_notification_settings = array_diff_key( $notification_settings, $new_notifications[ $notification_id ] );

[310] Fix | Delete

[311] Fix | Delete

foreach ( $changed_notification_settings as $setting_name => $value ) {

[312] Fix | Delete

if ( strpos( $setting_name, $prefix ) === 0 ) {

[313] Fix | Delete

$new_notifications[ $notification_id ][ $setting_name ] = $value;

[314] Fix | Delete

}

[315] Fix | Delete

}

[316] Fix | Delete

}

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

/**

[320] Fix | Delete

* Preserve Providers that are not active.

[321] Fix | Delete

*

[322] Fix | Delete

* @since 1.9.4

[323] Fix | Delete

*

[324] Fix | Delete

* @param array $form_data Form data.

[325] Fix | Delete

* @param array $previous_form_data Previous form data.

[326] Fix | Delete

*/

[327] Fix | Delete

private function preserve_providers( array &$form_data, array $previous_form_data ): void {

[328] Fix | Delete

[329] Fix | Delete

if ( empty( $previous_form_data['providers'] ) ) {

[330] Fix | Delete

return;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

$active_providers = wpforms_get_providers_available();

[334] Fix | Delete

[335] Fix | Delete

foreach ( $previous_form_data['providers'] as $slug => $provider ) {

[336] Fix | Delete

if ( ! empty( $active_providers[ $slug ] ) ) {

[337] Fix | Delete

continue;

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

$form_data['providers'][ $slug ] = $provider;

[341] Fix | Delete

}

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

/**

[345] Fix | Delete

* Preserve Payments providers that are not active.

[346] Fix | Delete

*

[347] Fix | Delete

* @since 1.9.4

[348] Fix | Delete

*

[349] Fix | Delete

* @param array $form_data Form data.

[350] Fix | Delete

* @param array $previous_form_data Previous form data.

[351] Fix | Delete

*/

[352] Fix | Delete

private function preserve_payments( array &$form_data, array $previous_form_data ): void {

[353] Fix | Delete

[354] Fix | Delete

if ( empty( $previous_form_data['payments'] ) ) {

[355] Fix | Delete

return;

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

foreach ( $previous_form_data['payments'] as $slug => $value ) {

[359] Fix | Delete

if ( ! empty( $form_data['payments'][ $slug ] ) ) {

[360] Fix | Delete

continue;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

$form_data['payments'][ $slug ] = $value;

[364] Fix | Delete

}

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Convert slug to a addon prefix.

[369] Fix | Delete

*

[370] Fix | Delete

* @since 1.9.4

[371] Fix | Delete

*

[372] Fix | Delete

* @param string $slug Addon slug.

[373] Fix | Delete

*

[374] Fix | Delete

* @return string

[375] Fix | Delete

*/

[376] Fix | Delete

private function prepare_prefix( string $slug ): string {

[377] Fix | Delete

[378] Fix | Delete

return str_replace( '-', '_', $slug );

[379] Fix | Delete

}

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete