<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Square;

[2] Fix | Delete

[3] Fix | Delete

use WP_Post;

[4] Fix | Delete

use WPForms\Integrations\Square\Api\Api;

[5] Fix | Delete

use WPForms\Vendor\Square\Models\Card;

[6] Fix | Delete

use WPForms\Vendor\Square\Models\ErrorCode;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Square payment processing.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.9.5

[12] Fix | Delete

*/

[13] Fix | Delete

class Process {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Form ID.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.9.5

[19] Fix | Delete

*

[20] Fix | Delete

* @var int

[21] Fix | Delete

*/

[22] Fix | Delete

public $form_id = 0;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Sanitized submitted field values and data.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.9.5

[28] Fix | Delete

*

[29] Fix | Delete

* @var array

[30] Fix | Delete

*/

[31] Fix | Delete

public $fields = [];

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Form submission raw data ($_POST).

[35] Fix | Delete

*

[36] Fix | Delete

* @since 1.9.5

[37] Fix | Delete

*

[38] Fix | Delete

* @var array

[39] Fix | Delete

*/

[40] Fix | Delete

public $entry = [];

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Form data and settings.

[44] Fix | Delete

*

[45] Fix | Delete

* @since 1.9.5

[46] Fix | Delete

*

[47] Fix | Delete

* @var array

[48] Fix | Delete

*/

[49] Fix | Delete

public $form_data = [];

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Square payment settings.

[53] Fix | Delete

*

[54] Fix | Delete

* @since 1.9.5

[55] Fix | Delete

*

[56] Fix | Delete

* @var array

[57] Fix | Delete

*/

[58] Fix | Delete

public $settings = [];

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Square credit card field.

[62] Fix | Delete

*

[63] Fix | Delete

* @since 1.9.5

[64] Fix | Delete

*

[65] Fix | Delete

* @var array

[66] Fix | Delete

*/

[67] Fix | Delete

public $cc_field = [];

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Payment amount.

[71] Fix | Delete

*

[72] Fix | Delete

* @since 1.9.5

[73] Fix | Delete

*

[74] Fix | Delete

* @var string

[75] Fix | Delete

*/

[76] Fix | Delete

public $amount = '';

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Payment currency.

[80] Fix | Delete

*

[81] Fix | Delete

* @since 1.9.5

[82] Fix | Delete

*

[83] Fix | Delete

* @var string

[84] Fix | Delete

*/

[85] Fix | Delete

public $currency = '';

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Connection data.

[89] Fix | Delete

*

[90] Fix | Delete

* @since 1.9.5

[91] Fix | Delete

*

[92] Fix | Delete

* @var Connection

[93] Fix | Delete

*/

[94] Fix | Delete

public $connection;

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Main class that communicates with the Square API.

[98] Fix | Delete

*

[99] Fix | Delete

* @since 1.9.5

[100] Fix | Delete

*

[101] Fix | Delete

* @var Api

[102] Fix | Delete

*/

[103] Fix | Delete

protected $api;

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Processing errors.

[107] Fix | Delete

*

[108] Fix | Delete

* @since 1.9.5

[109] Fix | Delete

*

[110] Fix | Delete

* @var array

[111] Fix | Delete

*/

[112] Fix | Delete

protected $errors;

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* Save matched subscription settings.

[116] Fix | Delete

*

[117] Fix | Delete

* @since 1.9.5

[118] Fix | Delete

*

[119] Fix | Delete

* @var array

[120] Fix | Delete

*/

[121] Fix | Delete

private $subscription_settings = [];

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Whether the payment has been processed.

[125] Fix | Delete

*

[126] Fix | Delete

* @since 1.9.5

[127] Fix | Delete

*

[128] Fix | Delete

* @var bool

[129] Fix | Delete

*/

[130] Fix | Delete

protected $is_payment_processed = false;

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Initialize.

[134] Fix | Delete

*

[135] Fix | Delete

* @since 1.9.5

[136] Fix | Delete

*/

[137] Fix | Delete

public function init(): Process {

[138] Fix | Delete

[139] Fix | Delete

$this->hooks();

[140] Fix | Delete

[141] Fix | Delete

return $this;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Hooks.

[146] Fix | Delete

*

[147] Fix | Delete

* @since 1.9.5

[148] Fix | Delete

*/

[149] Fix | Delete

protected function hooks() {

[150] Fix | Delete

[151] Fix | Delete

add_action( 'wpforms_process', [ $this, 'process_entry' ], 10, 3 );

[152] Fix | Delete

add_action( 'wpforms_process_entry_saved', [ $this, 'update_entry_meta' ], 10, 4 );

[153] Fix | Delete

add_filter( 'wpforms_forms_submission_prepare_payment_data', [ $this, 'prepare_payment_data' ], 10, 3 );

[154] Fix | Delete

add_filter( 'wpforms_forms_submission_prepare_payment_meta', [ $this, 'prepare_payment_meta' ], 10, 3 );

[155] Fix | Delete

add_action( 'wpforms_process_payment_saved', [ $this, 'process_payment_saved' ], 10, 3 );

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Check if a payment exists with an entry, if so validate and process.

[160] Fix | Delete

*

[161] Fix | Delete

* @since 1.9.5

[162] Fix | Delete

*

[163] Fix | Delete

* @param array $fields Final/sanitized submitted fields data.

[164] Fix | Delete

* @param array $entry Copy of original $_POST.

[165] Fix | Delete

* @param array $form_data Form data and settings.

[166] Fix | Delete

*/

[167] Fix | Delete

public function process_entry( $fields, array $entry, array $form_data ) {

[168] Fix | Delete

[169] Fix | Delete

$fields = (array) $fields;

[170] Fix | Delete

[171] Fix | Delete

// Check if payment method exists and is enabled.

[172] Fix | Delete

if ( ! Helpers::is_payments_enabled( $form_data ) ) {

[173] Fix | Delete

return;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

$this->fields = $fields;

[177] Fix | Delete

$this->entry = $entry;

[178] Fix | Delete

$this->form_data = $form_data;

[179] Fix | Delete

$this->form_id = isset( $form_data['id'] ) ? (int) $form_data['id'] : 0;

[180] Fix | Delete

$this->settings = $form_data['payments']['square'];

[181] Fix | Delete

$this->cc_field = $this->get_credit_card_field();

[182] Fix | Delete

$this->currency = $this->get_currency();

[183] Fix | Delete

$this->amount = $this->get_amount();

[184] Fix | Delete

$this->connection = Connection::get();

[185] Fix | Delete

[186] Fix | Delete

// Before proceeding, check if any basic errors were detected.

[187] Fix | Delete

if ( ! $this->is_form_processed() ) {

[188] Fix | Delete

$this->display_errors();

[189] Fix | Delete

[190] Fix | Delete

return;

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

// Set an API instance.

[194] Fix | Delete

$this->api = new Api( $this->connection );

[195] Fix | Delete

[196] Fix | Delete

// Set tokens provided by Web Payments SDK.

[197] Fix | Delete

$this->api->set_payment_tokens( $entry );

[198] Fix | Delete

[199] Fix | Delete

// Proceed to executing the purchase.

[200] Fix | Delete

$this->process_payment();

[201] Fix | Delete

[202] Fix | Delete

// Update the card field value to contain basic details.

[203] Fix | Delete

$this->update_credit_card_field_value();

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

/**

[207] Fix | Delete

* Bypass captcha if payment has been processed.

[208] Fix | Delete

*

[209] Fix | Delete

* @since 1.9.5

[210] Fix | Delete

* @deprecated 1.9.6

[211] Fix | Delete

*

[212] Fix | Delete

* @param bool $bypass_captcha Whether to bypass captcha.

[213] Fix | Delete

*

[214] Fix | Delete

* @return bool

[215] Fix | Delete

*/

[216] Fix | Delete

public function bypass_captcha( $bypass_captcha ): bool {

[217] Fix | Delete

[218] Fix | Delete

_deprecated_function( __METHOD__, '1.9.6 of the WPForms plugin' );

[219] Fix | Delete

[220] Fix | Delete

if ( (bool) $bypass_captcha ) {

[221] Fix | Delete

return true;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

return $this->is_payment_processed;

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

/**

[228] Fix | Delete

* Check if form has errors before payment processing.

[229] Fix | Delete

*

[230] Fix | Delete

* @since 1.9.5

[231] Fix | Delete

*

[232] Fix | Delete

* @return bool

[233] Fix | Delete

*/

[234] Fix | Delete

private function is_form_processed(): bool {

[235] Fix | Delete

[236] Fix | Delete

// Bail in case there are form processing errors.

[237] Fix | Delete

if ( ! empty( wpforms()->obj( 'process' )->errors[ $this->form_id ] ) ) {

[238] Fix | Delete

return false;

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

if ( ! $this->is_card_field_visibility_ok() ) {

[242] Fix | Delete

return false;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

return $this->is_form_ok();

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

/**

[249] Fix | Delete

* Check form settings, fields, etc.

[250] Fix | Delete

*

[251] Fix | Delete

* @since 1.9.5

[252] Fix | Delete

*

[253] Fix | Delete

* @return bool

[254] Fix | Delete

*/

[255] Fix | Delete

private function is_form_ok(): bool {

[256] Fix | Delete

[257] Fix | Delete

// Check for Square connection.

[258] Fix | Delete

if ( ! $this->is_connection_ok() ) {

[259] Fix | Delete

$error_title = esc_html__( 'Square payment stopped, account connection is missing.', 'wpforms-lite' );

[260] Fix | Delete

$this->errors[] = $error_title;

[261] Fix | Delete

[262] Fix | Delete

$this->log_errors( $error_title );

[263] Fix | Delete

[264] Fix | Delete

return false;

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

// Check total charge amount.

[268] Fix | Delete

// Square has different minimum amount limits by country.

[269] Fix | Delete

if ( ! $this->is_amount_ok() ) {

[270] Fix | Delete

$error_title = esc_html__( 'Square payment stopped, amount is smaller than the allowed minimum amount for a payment.', 'wpforms-lite' );

[271] Fix | Delete

$this->errors[] = $error_title;

[272] Fix | Delete

[273] Fix | Delete

$this->log_errors(

[274] Fix | Delete

$error_title,

[275] Fix | Delete

[

[276] Fix | Delete

'amount' => $this->amount,

[277] Fix | Delete

'currency' => $this->currency,

[278] Fix | Delete

]

[279] Fix | Delete

);

[280] Fix | Delete

[281] Fix | Delete

return false;

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

// Check that, despite how the form is configured, the form and

[285] Fix | Delete

// entry actually contain payment fields, otherwise no need to proceed.

[286] Fix | Delete

if ( empty( $this->cc_field ) || ! wpforms_has_payment( 'form', $this->fields ) ) {

[287] Fix | Delete

$error_title = esc_html__( 'Square payment stopped, missing payment fields.', 'wpforms-lite' );

[288] Fix | Delete

$this->errors[] = $error_title;

[289] Fix | Delete

[290] Fix | Delete

$this->log_errors( $error_title );

[291] Fix | Delete

[292] Fix | Delete

return false;

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

return true;

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

/**

[299] Fix | Delete

* Check if the Square credit card field in the form is visible (not hidden by conditional logic).

[300] Fix | Delete

*

[301] Fix | Delete

* @since 1.9.5

[302] Fix | Delete

*

[303] Fix | Delete

* @return bool

[304] Fix | Delete

*/

[305] Fix | Delete

private function is_card_field_visibility_ok(): bool {

[306] Fix | Delete

[307] Fix | Delete

// If the form doesn't contain the credit card field.

[308] Fix | Delete

if ( empty( $this->cc_field ) ) {

[309] Fix | Delete

return false;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

// If the form contains no fields with conditional logic, the credit card field is visible by default.

[313] Fix | Delete

if ( empty( $this->form_data['conditional_fields'] ) ) {

[314] Fix | Delete

return true;

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

// If the credit card field is NOT in array of conditional fields, it's visible.

[318] Fix | Delete

if ( ! in_array( $this->cc_field['id'], $this->form_data['conditional_fields'], true ) ) {

[319] Fix | Delete

return true;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

// If the credit card field IS in array of conditional fields and marked as visible, it's visible.

[323] Fix | Delete

if ( ! empty( $this->cc_field['visible'] ) ) {

[324] Fix | Delete

return true;

[325] Fix | Delete

}

[326] Fix | Delete

[327] Fix | Delete

return false;

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

/**

[331] Fix | Delete

* Check if connection exists, configured and valid.

[332] Fix | Delete

*

[333] Fix | Delete

* @since 1.9.5

[334] Fix | Delete

*

[335] Fix | Delete

* @return bool

[336] Fix | Delete

*/

[337] Fix | Delete

private function is_connection_ok(): bool {

[338] Fix | Delete

[339] Fix | Delete

return $this->connection !== null && $this->connection->is_usable();

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

/**

[343] Fix | Delete

* Check if an amount is greater than the minimum amount.

[344] Fix | Delete

*

[345] Fix | Delete

* @since 1.9.5

[346] Fix | Delete

*

[347] Fix | Delete

* @link https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts#monetary-amount-limits

[348] Fix | Delete

*

[349] Fix | Delete

* @return bool

[350] Fix | Delete

*/

[351] Fix | Delete

private function is_amount_ok(): bool {

[352] Fix | Delete

[353] Fix | Delete

$amount = Helpers::format_amount( $this->amount );

[354] Fix | Delete

[355] Fix | Delete

if ( $amount < 1 && in_array( $this->currency, [ 'USD', 'CAD' ], true ) ) {

[356] Fix | Delete

return false;

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

if ( $amount < 100 && in_array( $this->currency, [ 'EUR', 'GBP', 'AUD', 'JPY' ], true ) ) {

[360] Fix | Delete

return false;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

return true;

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

/**

[367] Fix | Delete

* Process a payment.

[368] Fix | Delete

*

[369] Fix | Delete

* @since 1.9.5

[370] Fix | Delete

*/

[371] Fix | Delete

private function process_payment() {

[372] Fix | Delete

[373] Fix | Delete

if ( ! empty( $this->settings['enable_recurring'] ) ) {

[374] Fix | Delete

[375] Fix | Delete

$this->process_payment_subscription();

[376] Fix | Delete

[377] Fix | Delete

return;

[378] Fix | Delete

}

[379] Fix | Delete

[380] Fix | Delete

$this->process_payment_single();

[381] Fix | Delete

}

[382] Fix | Delete

[383] Fix | Delete

/**

[384] Fix | Delete

* Process a single payment.

[385] Fix | Delete

*

[386] Fix | Delete

* @since 1.9.5

[387] Fix | Delete

*/

[388] Fix | Delete

protected function process_payment_single() {

[389] Fix | Delete

[390] Fix | Delete

$args = $this->get_payment_args_single();

[391] Fix | Delete

[392] Fix | Delete

$this->api->process_single_transaction( $args );

[393] Fix | Delete

[394] Fix | Delete

// Set payment processing flag.

[395] Fix | Delete

$this->is_payment_processed = true;

[396] Fix | Delete

[397] Fix | Delete

$this->process_api_errors( 'single' );

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

/**

[401] Fix | Delete

* Process a subscription payment.

[402] Fix | Delete

*

[403] Fix | Delete

* @since 1.9.5

[404] Fix | Delete

*/

[405] Fix | Delete

private function process_payment_subscription() {

[406] Fix | Delete

[407] Fix | Delete

$args = $this->get_payment_args_general();

[408] Fix | Delete

[409] Fix | Delete

foreach ( $this->settings['recurring'] as $recurring ) {

[410] Fix | Delete

[411] Fix | Delete

if ( ! $this->is_subscription_plan_valid( $recurring ) ) {

[412] Fix | Delete

continue;

[413] Fix | Delete

}

[414] Fix | Delete

[415] Fix | Delete

// Put subscription arguments into its own key.

[416] Fix | Delete

$args['subscription'] = $this->get_payment_args_subscription( $recurring );

[417] Fix | Delete

$this->subscription_settings = $args['subscription'];

[418] Fix | Delete

[419] Fix | Delete

$this->api->process_subscription_transaction( $args );

[420] Fix | Delete

[421] Fix | Delete

// Set payment processing flag.

[422] Fix | Delete

$this->is_payment_processed = true;

[423] Fix | Delete

[424] Fix | Delete

$this->process_api_errors( 'subscription' );

[425] Fix | Delete

[426] Fix | Delete

return;

[427] Fix | Delete

}

[428] Fix | Delete

[429] Fix | Delete

if ( ! empty( $this->settings['enable_one_time'] ) ) {

[430] Fix | Delete

$this->process_payment_single();

[431] Fix | Delete

[432] Fix | Delete

return;

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

$this->log_errors(

[436] Fix | Delete

esc_html__( 'Square Subscription payment stopped, validation error.', 'wpforms-lite' ),

[437] Fix | Delete

$this->fields,

[438] Fix | Delete

'conditional_logic'

[439] Fix | Delete

);

[440] Fix | Delete

}

[441] Fix | Delete

[442] Fix | Delete

/**

[443] Fix | Delete

* Retrieve subscription payment args.

[444] Fix | Delete

*

[445] Fix | Delete

* @since 1.9.5

[446] Fix | Delete

*

[447] Fix | Delete

* @param array $plan Plan settings.

[448] Fix | Delete

*

[449] Fix | Delete

* @return array

[450] Fix | Delete

*/

[451] Fix | Delete

private function get_payment_args_subscription( array $plan ): array {

[452] Fix | Delete

[453] Fix | Delete

$args_sub['customer']['email'] = sanitize_email( $this->fields[ $plan['customer_email'] ]['value'] );

[454] Fix | Delete

$args_sub['customer']['first_name'] = sanitize_text_field( $this->fields[ $plan['customer_name'] ]['first'] );

[455] Fix | Delete

$args_sub['customer']['last_name'] = sanitize_text_field( $this->fields[ $plan['customer_name'] ]['last'] );

[456] Fix | Delete

[457] Fix | Delete

// If a Name field has the `Simple` format.

[458] Fix | Delete

if (

[459] Fix | Delete

empty( $args_sub['customer']['first_name'] ) &&

[460] Fix | Delete

empty( $args_sub['customer']['last_name'] ) &&

[461] Fix | Delete

! empty( $this->fields[ $plan['customer_name'] ]['value'] )

[462] Fix | Delete

) {

[463] Fix | Delete

$args_sub['customer']['last_name'] = sanitize_text_field( $this->fields[ $plan['customer_name'] ]['value'] );

[464] Fix | Delete

}

[465] Fix | Delete

[466] Fix | Delete

// Customer address.

[467] Fix | Delete

if ( isset( $plan['customer_address'] ) && $plan['customer_address'] !== '' && wpforms()->is_pro() ) {

[468] Fix | Delete

$args_sub['customer']['address'] = $this->fields[ $plan['customer_address'] ];

[469] Fix | Delete

}

[470] Fix | Delete

[471] Fix | Delete

$cadences_list = Helpers::get_subscription_cadences();

[472] Fix | Delete

$phase_cadence = $cadences_list[ $plan['phase_cadence'] ] ?? $cadences_list['yearly'];

[473] Fix | Delete

[474] Fix | Delete

// Subscription cadence.

[475] Fix | Delete

$args_sub['phase_cadence'] = $phase_cadence;

[476] Fix | Delete

[477] Fix | Delete

$plan_name = $this->get_form_name();

[478] Fix | Delete

$plan_name .= empty( $plan['name'] ) ? '' : ': ' . $plan['name'];

[479] Fix | Delete

[480] Fix | Delete

$args_sub['plan_name'] = sprintf( '%s (%s)', $plan_name, $phase_cadence['name'] );

[481] Fix | Delete

$args_sub['plan_variation_name'] = sprintf( '%s (%s %s %s)', $plan['name'], $this->amount, $this->currency, $phase_cadence['name'] );

[482] Fix | Delete

[483] Fix | Delete

// Card holder.

[484] Fix | Delete

$args_sub['card_name'] = empty( $this->fields[ $this->cc_field['id'] ]['cardname'] ) ? '' : sanitize_text_field( $this->fields[ $this->cc_field['id'] ]['cardname'] );

[485] Fix | Delete

[486] Fix | Delete

/**

[487] Fix | Delete

* Filter subscription payment arguments.

[488] Fix | Delete

*

[489] Fix | Delete

* @since 1.9.5

[490] Fix | Delete

*

[491] Fix | Delete

* @param array $args The subscription payment arguments.

[492] Fix | Delete

* @param Process $process The Process instance.

[493] Fix | Delete

*/

[494] Fix | Delete

return (array) apply_filters( 'wpforms_integrations_square_process_get_payment_args_subscription', $args_sub, $this );

[495] Fix | Delete

}

[496] Fix | Delete

[497] Fix | Delete

/**

[498] Fix | Delete

* Validate plan before process.

[499] Fix | Delete