<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\AI\API;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Integrations\AI\Admin\Ajax\Forms as FormsAjax;

[4] Fix | Delete

use WPForms\Integrations\AI\Helpers;

[5] Fix | Delete

use WPForms\Forms\Fields\Pagebreak\Field as PagebreakField;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Form API class.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.9.2

[11] Fix | Delete

*/

[12] Fix | Delete

class Forms extends API {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* API endpoint.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.9.2

[18] Fix | Delete

*/

[19] Fix | Delete

private const ENDPOINT = '/ai-forms';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Get form from the API.

[23] Fix | Delete

*

[24] Fix | Delete

* @since 1.9.2

[25] Fix | Delete

*

[26] Fix | Delete

* @param string $prompt Prompt to get the form.

[27] Fix | Delete

* @param string $session_id Session ID.

[28] Fix | Delete

*

[29] Fix | Delete

* @return array

[30] Fix | Delete

* @noinspection PhpUndefinedConstantInspection

[31] Fix | Delete

*/

[32] Fix | Delete

public function form( string $prompt, string $session_id = '' ): array {

[33] Fix | Delete

[34] Fix | Delete

$args = [

[35] Fix | Delete

'userPrompt' => $this->prepare_prompt( $prompt ),

[36] Fix | Delete

'limit' => $this->get_limit(),

[37] Fix | Delete

];

[38] Fix | Delete

[39] Fix | Delete

if ( ! empty( $session_id ) ) {

[40] Fix | Delete

$args['sessionId'] = $session_id;

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

// Flag requests from Lite plugin.

[44] Fix | Delete

$args['lite'] = ! wpforms()->is_pro();

[45] Fix | Delete

[46] Fix | Delete

// Add available addons to the request arguments.

[47] Fix | Delete

$args['addons'] = $this->get_available_addons();

[48] Fix | Delete

[49] Fix | Delete

// Add GDPR setting to the request arguments.

[50] Fix | Delete

$args['gdpr'] = wpforms_setting( 'gdpr' );

[51] Fix | Delete

[52] Fix | Delete

// Add a Page break field support.

[53] Fix | Delete

$args['pagebreak'] = true;

[54] Fix | Delete

[55] Fix | Delete

// Add prompt debug info support.

[56] Fix | Delete

$args['debug'] = defined( 'WPFORMS_AI_DEBUG' ) && WPFORMS_AI_DEBUG;

[57] Fix | Delete

[58] Fix | Delete

$response = $this->request->post( self::ENDPOINT, $args );

[59] Fix | Delete

[60] Fix | Delete

if ( $response->has_errors() ) {

[61] Fix | Delete

$error_data = $response->get_error_data();

[62] Fix | Delete

[63] Fix | Delete

Helpers::log_error( $response->get_log_message( $error_data ), self::ENDPOINT, $args );

[64] Fix | Delete

[65] Fix | Delete

return $error_data;

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

return $this->normalize_form_data( $response->get_body() );

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Get available addons.

[73] Fix | Delete

*

[74] Fix | Delete

* @since 1.9.2

[75] Fix | Delete

*

[76] Fix | Delete

* @return array

[77] Fix | Delete

*/

[78] Fix | Delete

private function get_available_addons(): array {

[79] Fix | Delete

[80] Fix | Delete

// Since starting from 1.9.4, we display unavailable addon fields in Lite and all Pro licenses,

[81] Fix | Delete

// we need to return all required addons to let AI generate addon fields.

[82] Fix | Delete

return FormsAjax::FORM_GENERATOR_REQUIRED_ADDONS;

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Normalize form data.

[87] Fix | Delete

*

[88] Fix | Delete

* @since 1.9.2

[89] Fix | Delete

*

[90] Fix | Delete

* @param array $form_data Form data.

[91] Fix | Delete

*

[92] Fix | Delete

* @return array

[93] Fix | Delete

*/

[94] Fix | Delete

private function normalize_form_data( array $form_data ): array {

[95] Fix | Delete

[96] Fix | Delete

// Recursively normalize form data.

[97] Fix | Delete

$form_data = $this->normalize_form_data_recursive( $form_data );

[98] Fix | Delete

[99] Fix | Delete

// Fix fields data.

[100] Fix | Delete

$form_data = $this->fix_fields_data( $form_data );

[101] Fix | Delete

[102] Fix | Delete

// Notifications and confirmations arrays should be indexed from 1.

[103] Fix | Delete

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

[104] Fix | Delete

$form_data['settings']['notifications'] = array_combine(

[105] Fix | Delete

range( 1, count( $form_data['settings']['notifications'] ) ),

[106] Fix | Delete

array_values( $form_data['settings']['notifications'] )

[107] Fix | Delete

);

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

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

[111] Fix | Delete

$form_data['settings']['confirmations'] = array_combine(

[112] Fix | Delete

range( 1, count( $form_data['settings']['confirmations'] ) ),

[113] Fix | Delete

array_values( $form_data['settings']['confirmations'] )

[114] Fix | Delete

);

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

$form_data['form_title'] = empty( $form_data['form_title'] ) ? esc_html__( 'Untitled Form', 'wpforms-lite' ) : $form_data['form_title'];

[118] Fix | Delete

$form_data['settings']['form_title'] = $form_data['form_title'];

[119] Fix | Delete

[120] Fix | Delete

return $form_data;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Normalize form data recursive.

[125] Fix | Delete

*

[126] Fix | Delete

* @since 1.9.2

[127] Fix | Delete

*

[128] Fix | Delete

* @param array $form_data Form data.

[129] Fix | Delete

*

[130] Fix | Delete

* @return array

[131] Fix | Delete

*/

[132] Fix | Delete

private function normalize_form_data_recursive( array $form_data ): array {

[133] Fix | Delete

[134] Fix | Delete

foreach ( $form_data as $key => $value ) {

[135] Fix | Delete

if ( is_array( $value ) ) {

[136] Fix | Delete

$form_data[ $key ] = $this->normalize_form_data_recursive( $value );

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

// Convert `false` and `true` values to '0' and '1'.

[140] Fix | Delete

$form_data[ $key ] = $form_data[ $key ] === false ? '0' : $form_data[ $key ];

[141] Fix | Delete

$form_data[ $key ] = $form_data[ $key ] === true ? '1' : $form_data[ $key ];

[142] Fix | Delete

[143] Fix | Delete

// Remove null values.

[144] Fix | Delete

if ( $form_data[ $key ] === null ) {

[145] Fix | Delete

unset( $form_data[ $key ] );

[146] Fix | Delete

}

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return $form_data;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Fix fields' data.

[154] Fix | Delete

*

[155] Fix | Delete

* @since 1.9.2

[156] Fix | Delete

*

[157] Fix | Delete

* @param array $form_data Form data.

[158] Fix | Delete

*

[159] Fix | Delete

* @return array

[160] Fix | Delete

*/

[161] Fix | Delete

private function fix_fields_data( array $form_data ): array {

[162] Fix | Delete

[163] Fix | Delete

$updated_fields_data = [];

[164] Fix | Delete

$page_breaks = [];

[165] Fix | Delete

[166] Fix | Delete

// Fix array keys. The key should be identical to `id`.

[167] Fix | Delete

foreach ( $form_data['fields'] as $field_data ) {

[168] Fix | Delete

$updated_fields_data[ (string) $field_data['id'] ] = $field_data;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

$form_data['fields'] = $updated_fields_data;

[172] Fix | Delete

[173] Fix | Delete

// Fix choice values and choices array indexes.

[174] Fix | Delete

foreach ( $form_data['fields'] as $id => $field_data ) {

[175] Fix | Delete

$field_data = $this->fix_field_defaults( $field_data );

[176] Fix | Delete

$form_data['fields'][ $id ] = $this->fix_choices( $field_data );

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

// Fix conditional logic rules and detect page breaks.

[180] Fix | Delete

foreach ( $form_data['fields'] as $id => $field_data ) {

[181] Fix | Delete

$form_data['fields'][ $id ] = $this->fix_field_cl( $field_data, $form_data );

[182] Fix | Delete

[183] Fix | Delete

if ( $field_data['type'] === 'pagebreak' ) {

[184] Fix | Delete

$page_breaks[] = $id;

[185] Fix | Delete

}

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

// Fix page breaks.

[189] Fix | Delete

if ( ! empty( $page_breaks ) ) {

[190] Fix | Delete

$form_data = $this->fix_page_breaks( $form_data, $page_breaks );

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

return $form_data;

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Fix field's conditional logic rules.

[198] Fix | Delete

*

[199] Fix | Delete

* @since 1.9.2

[200] Fix | Delete

*

[201] Fix | Delete

* @param array $field Field data.

[202] Fix | Delete

* @param array $form_data Form data.

[203] Fix | Delete

*

[204] Fix | Delete

* @return array

[205] Fix | Delete

*/

[206] Fix | Delete

private function fix_field_cl( array $field, array $form_data ): array {

[207] Fix | Delete

[208] Fix | Delete

if ( empty( $field['conditionals'] ) || empty( $field['conditional_logic'] ) ) {

[209] Fix | Delete

return $field;

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

// Loop groups.

[213] Fix | Delete

foreach ( $field['conditionals'] as $group_key => $group ) {

[214] Fix | Delete

[215] Fix | Delete

// Loop rules.

[216] Fix | Delete

foreach ( $group as $rule_key => $rule ) {

[217] Fix | Delete

$choices = $form_data['fields'][ $rule['field'] ]['choices'] ?? [];

[218] Fix | Delete

[219] Fix | Delete

// We only need to update rules for choice-based fields.

[220] Fix | Delete

if ( empty( $choices ) ) {

[221] Fix | Delete

continue;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

// AI uses choice value, but we should use the index of the choice in the `choices` array.

[225] Fix | Delete

$field['conditionals'][ $group_key ][ $rule_key ]['value'] = $this->get_choice_index( $choices, $rule['value'] );

[226] Fix | Delete

[227] Fix | Delete

// Continue if the operator is supported by the choice-based field.

[228] Fix | Delete

if ( in_array( $rule['operator'], [ '==', '!=', 'e', '!e' ], true ) ) {

[229] Fix | Delete

continue;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

// Fix `operator` value for choice-based fields.

[233] Fix | Delete

$rule['operator'] = in_array( $rule['operator'], [ 'c', '^', '>', '<' ], true ) ? '==' : $rule['operator'];

[234] Fix | Delete

$rule['operator'] = in_array( $rule['operator'], [ '!c', '~' ], true ) ? '!=' : $rule['operator'];

[235] Fix | Delete

[236] Fix | Delete

$field['conditionals'][ $group_key ][ $rule_key ]['operator'] = $rule['operator'];

[237] Fix | Delete

}

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

return $field;

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

/**

[244] Fix | Delete

* Find choice index in the `choices` array.

[245] Fix | Delete

*

[246] Fix | Delete

* @since 1.9.2

[247] Fix | Delete

*

[248] Fix | Delete

* @param array $choices Choices data.

[249] Fix | Delete

* @param string $value Value to find in choices.

[250] Fix | Delete

*

[251] Fix | Delete

* @return string|null

[252] Fix | Delete

*/

[253] Fix | Delete

private function get_choice_index( array $choices, string $value ) {

[254] Fix | Delete

[255] Fix | Delete

$index = array_search( $value, array_column( $choices, 'value' ), true );

[256] Fix | Delete

[257] Fix | Delete

if ( $index === false ) {

[258] Fix | Delete

$index = array_search( $value, array_column( $choices, 'label' ), true );

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

$choices_keys = array_keys( $choices );

[262] Fix | Delete

[263] Fix | Delete

return $index === false ? null : $choices_keys[ $index ];

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

/**

[267] Fix | Delete

* Add missing default attributes to the field.

[268] Fix | Delete

*

[269] Fix | Delete

* @since 1.9.4

[270] Fix | Delete

*

[271] Fix | Delete

* @param array $field Field data.

[272] Fix | Delete

*

[273] Fix | Delete

* @return array

[274] Fix | Delete

*/

[275] Fix | Delete

private function fix_field_defaults( array $field ): array {

[276] Fix | Delete

[277] Fix | Delete

/**

[278] Fix | Delete

* Allow the default field settings to be filtered.

[279] Fix | Delete

*

[280] Fix | Delete

* @since 1.0.8

[281] Fix | Delete

*

[282] Fix | Delete

* @param array $field Default field settings.

[283] Fix | Delete

*/

[284] Fix | Delete

$field = (array) apply_filters( 'wpforms_field_new_default', $field ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[285] Fix | Delete

[286] Fix | Delete

// Set the defaults for certain fields.

[287] Fix | Delete

if ( $field['type'] === 'content' ) {

[288] Fix | Delete

$field['label'] = empty( $field['label'] ) ? esc_html__( 'Content', 'wpforms-lite' ) : $field['label'];

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

if ( $field['type'] === 'richtext' ) {

[292] Fix | Delete

$field['default_value'] = '';

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

return $field;

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

/**

[299] Fix | Delete

* Fix choices.

[300] Fix | Delete

*

[301] Fix | Delete

* Remove unnecessary values from choices.

[302] Fix | Delete

*

[303] Fix | Delete

* @since 1.9.2

[304] Fix | Delete

*

[305] Fix | Delete

* @param array $field Field data.

[306] Fix | Delete

*

[307] Fix | Delete

* @return array

[308] Fix | Delete

*/

[309] Fix | Delete

private function fix_choices( array $field ): array {

[310] Fix | Delete

[311] Fix | Delete

if ( empty( $field['choices'] ) ) {

[312] Fix | Delete

return $field;

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

// Remove values from choices for non-payment fields.

[316] Fix | Delete

if ( ! in_array( $field['type'], [ 'payment-multiple', 'payment-checkbox', 'payment-select' ], true ) ) {

[317] Fix | Delete

// Remove values from choices.

[318] Fix | Delete

foreach ( $field['choices'] as $i => $choice ) {

[319] Fix | Delete

$field['choices'][ $i ]['value'] = '';

[320] Fix | Delete

}

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

$updated_choices = [];

[324] Fix | Delete

[325] Fix | Delete

// Update array keys to start from 1.

[326] Fix | Delete

foreach ( $field['choices'] as $i => $choice ) {

[327] Fix | Delete

$updated_choices[ $i + 1 ] = $choice;

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

$field['choices'] = $updated_choices;

[331] Fix | Delete

[332] Fix | Delete

return $field;

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

/**

[336] Fix | Delete

* Fix page breaks.

[337] Fix | Delete

*

[338] Fix | Delete

* Add top and bottom page breaks to the form, set `nav_align` for all page breaks.

[339] Fix | Delete

*

[340] Fix | Delete

* @since 1.9.3

[341] Fix | Delete

*

[342] Fix | Delete

* @param array $form_data Form data.

[343] Fix | Delete

* @param array $page_breaks Page break IDs.

[344] Fix | Delete

*

[345] Fix | Delete

* @return array

[346] Fix | Delete

*/

[347] Fix | Delete

private function fix_page_breaks( array $form_data, array $page_breaks ): array { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh

[348] Fix | Delete

[349] Fix | Delete

reset( $form_data['fields'] );

[350] Fix | Delete

[351] Fix | Delete

$max_field_id = max( array_keys( $form_data['fields'] ) );

[352] Fix | Delete

[353] Fix | Delete

// Update or add the top page break.

[354] Fix | Delete

$first_field_id = key( $form_data['fields'] );

[355] Fix | Delete

[356] Fix | Delete

// If the first field is a page break, use its ID, otherwise create a new one.

[357] Fix | Delete

if ( $form_data['fields'][ $first_field_id ]['type'] === 'pagebreak_top' ) {

[358] Fix | Delete

$top_id = $first_field_id;

[359] Fix | Delete

} else {

[360] Fix | Delete

$top_id = '0';

[361] Fix | Delete

$form_data['fields'] = [ $top_id => [] ] + $form_data['fields'];

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

$form_data['fields'][ $top_id ] = [

[365] Fix | Delete

'type' => 'pagebreak',

[366] Fix | Delete

'id' => $top_id,

[367] Fix | Delete

'position' => 'top',

[368] Fix | Delete

'indicator' => 'progress',

[369] Fix | Delete

'indicator_color' => PagebreakField::get_default_indicator_color(),

[370] Fix | Delete

'title' => $form_data['fields'][ $top_id ]['title'] ?? '',

[371] Fix | Delete

'nav_align' => $form_data['fields'][ $top_id ]['nav_align'] ?? 'left',

[372] Fix | Delete

];

[373] Fix | Delete

[374] Fix | Delete

// Remove the Previous button from the first normal pagebreak.

[375] Fix | Delete

$form_data['fields'][ $page_breaks[0] ]['prev'] = '';

[376] Fix | Delete

$form_data['fields'][ $page_breaks[0] ]['prev_toggle'] = '';

[377] Fix | Delete

[378] Fix | Delete

end( $form_data['fields'] );

[379] Fix | Delete

[380] Fix | Delete

// Update or add the bottom page break.

[381] Fix | Delete

// If the last field is a page break, use its ID, otherwise create a new one.

[382] Fix | Delete

$last_field_id = key( $form_data['fields'] );

[383] Fix | Delete

$last_field = $form_data['fields'][ key( $form_data['fields'] ) ];

[384] Fix | Delete

$bottom_id = $last_field['type'] === 'pagebreak_bottom' ? $last_field_id : (string) ++$max_field_id;

[385] Fix | Delete

$form_data['fields'][ $bottom_id ] = [

[386] Fix | Delete

'type' => 'pagebreak',

[387] Fix | Delete

'id' => $bottom_id,

[388] Fix | Delete

'position' => 'bottom',

[389] Fix | Delete

'title' => '',

[390] Fix | Delete

'prev' => $form_data['fields'][ $bottom_id ]['prev'] ?? '',

[391] Fix | Delete

'prev_toggle' => $form_data['fields'][ $bottom_id ]['prev_toggle'] ?? '',

[392] Fix | Delete

];

[393] Fix | Delete

[394] Fix | Delete

// Remove the Previous button from the bottom pagebreak.

[395] Fix | Delete

if ( empty( $form_data['fields'][ $bottom_id ]['prev_toggle'] ) ) {

[396] Fix | Delete

unset( $form_data['fields'][ $bottom_id ]['prev'], $form_data['fields'][ $bottom_id ]['prev_toggle'] );

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete

// Prevent wrong pagebreaks.

[400] Fix | Delete

foreach ( $form_data['fields'] as $d => $field ) {

[401] Fix | Delete

$field['type'] = $field['type'] === 'pagebreak_top' ? 'pagebreak' : $field['type'];

[402] Fix | Delete

$field['type'] = $field['type'] === 'pagebreak_bottom' ? 'pagebreak' : $field['type'];

[403] Fix | Delete

[404] Fix | Delete

$form_data['fields'][ $d ] = $field;

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

return $form_data;

[408] Fix | Delete

}

[409] Fix | Delete

}

[410] Fix | Delete

[411] Fix | Delete