<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Square\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Integrations\Square\Api\Api;

[4] Fix | Delete

use WPForms\Vendor\Square\Models\Location;

[5] Fix | Delete

use WPForms\Vendor\Square\Models\LocationCapability;

[6] Fix | Delete

use WPForms\Vendor\Square\Models\LocationStatus;

[7] Fix | Delete

use WPForms\Vendor\Square\Environment;

[8] Fix | Delete

use WP_Error;

[9] Fix | Delete

use WPForms\Admin\Notice;

[10] Fix | Delete

use WPForms\Helpers\Transient;

[11] Fix | Delete

use WPForms\Tasks\Tasks;

[12] Fix | Delete

use WPForms\Integrations\Square\Connection;

[13] Fix | Delete

use WPForms\Integrations\Square\Helpers;

[14] Fix | Delete

use WPForms\Integrations\Square\Api\WebhooksManager;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Square Connect functionality.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.9.5

[20] Fix | Delete

*/

[21] Fix | Delete

class Connect {

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* WPForms website URL.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 1.9.5

[27] Fix | Delete

*/

[28] Fix | Delete

private const WPFORMS_URL = 'https://wpforms.com';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Webhooks manager.

[32] Fix | Delete

*

[33] Fix | Delete

* @since 1.9.5

[34] Fix | Delete

*

[35] Fix | Delete

* @var WebhooksManager

[36] Fix | Delete

*/

[37] Fix | Delete

private $webhooks_manager;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Initialize.

[41] Fix | Delete

*

[42] Fix | Delete

* @since 1.9.5

[43] Fix | Delete

*

[44] Fix | Delete

* @return Connect

[45] Fix | Delete

*/

[46] Fix | Delete

public function init() {

[47] Fix | Delete

[48] Fix | Delete

$this->webhooks_manager = new WebhooksManager();

[49] Fix | Delete

[50] Fix | Delete

$this->hooks();

[51] Fix | Delete

[52] Fix | Delete

return $this;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Connect hooks.

[57] Fix | Delete

*

[58] Fix | Delete

* @since 1.9.5

[59] Fix | Delete

*/

[60] Fix | Delete

private function hooks() {

[61] Fix | Delete

[62] Fix | Delete

add_action( 'admin_init', [ $this, 'handle_actions' ] );

[63] Fix | Delete

add_action( 'wpforms_square_refresh_connection', [ $this, 'refresh_connection_schedule' ] );

[64] Fix | Delete

add_action( 'wp_ajax_wpforms_square_refresh_connection', [ $this, 'refresh_connection_manual' ] );

[65] Fix | Delete

add_action( 'wp_ajax_wpforms_square_create_webhook', [ $this->webhooks_manager, 'connect' ] );

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Handle actions.

[70] Fix | Delete

*

[71] Fix | Delete

* @since 1.9.5

[72] Fix | Delete

*/

[73] Fix | Delete

public function handle_actions() {

[74] Fix | Delete

[75] Fix | Delete

if ( ! wpforms_current_user_can() || wp_doing_ajax() ) {

[76] Fix | Delete

return;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

$this->validate_scopes();

[80] Fix | Delete

[81] Fix | Delete

if (

[82] Fix | Delete

isset( $_GET['_wpnonce'] ) &&

[83] Fix | Delete

wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'wpforms_square_disconnect' )

[84] Fix | Delete

) {

[85] Fix | Delete

$this->handle_disconnect();

[86] Fix | Delete

[87] Fix | Delete

return;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

$this->schedule_refresh();

[91] Fix | Delete

[92] Fix | Delete

if (

[93] Fix | Delete

! empty( $_GET['state'] ) &&

[94] Fix | Delete

isset( $_GET['square_connect'] ) &&

[95] Fix | Delete

$_GET['square_connect'] === 'complete'

[96] Fix | Delete

) {

[97] Fix | Delete

$this->handle_connected();

[98] Fix | Delete

}

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Validate connection scopes.

[103] Fix | Delete

*

[104] Fix | Delete

* @since 1.9.5

[105] Fix | Delete

*/

[106] Fix | Delete

private function validate_scopes() {

[107] Fix | Delete

[108] Fix | Delete

if ( Helpers::is_license_ok() ) {

[109] Fix | Delete

return;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

$connection = Connection::get();

[113] Fix | Delete

[114] Fix | Delete

if ( ! $connection || ! $connection->is_configured() ) {

[115] Fix | Delete

return;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

// Bail early if currency is not supported for applying a fee.

[119] Fix | Delete

if ( ! Helpers::is_application_fee_supported() ) {

[120] Fix | Delete

return;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

if ( $connection->get_scopes_updated() ) {

[124] Fix | Delete

return;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

// Revoke tokens if the license is not valid and scopes are missing.

[128] Fix | Delete

$connection->revoke_tokens();

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Handle a successful connection.

[133] Fix | Delete

*

[134] Fix | Delete

* @since 1.9.5

[135] Fix | Delete

*/

[136] Fix | Delete

private function handle_connected() {

[137] Fix | Delete

[138] Fix | Delete

$state = sanitize_text_field( wp_unslash( $_GET['state'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated

[139] Fix | Delete

[140] Fix | Delete

if ( empty( $state ) ) {

[141] Fix | Delete

return;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

$connection_raw = $this->fetch_new_connection( $state );

[145] Fix | Delete

$connection = $this->maybe_save_connection( $connection_raw );

[146] Fix | Delete

[147] Fix | Delete

if ( ! $connection ) {

[148] Fix | Delete

return;

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

$mode = $connection->get_mode();

[152] Fix | Delete

[153] Fix | Delete

// Sync the Square settings mode with a connection mode.

[154] Fix | Delete

Helpers::set_mode( $mode );

[155] Fix | Delete

[156] Fix | Delete

$this->prepare_locations( $mode );

[157] Fix | Delete

[158] Fix | Delete

$redirect_url = Helpers::get_settings_page_url();

[159] Fix | Delete

[160] Fix | Delete

if ( ! $connection->is_usable() ) {

[161] Fix | Delete

$redirect_url .= '#wpforms-setting-row-square-heading';

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

wp_safe_redirect( $redirect_url );

[165] Fix | Delete

exit;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Handle disconnection.

[170] Fix | Delete

*

[171] Fix | Delete

* @since 1.9.5

[172] Fix | Delete

*/

[173] Fix | Delete

private function handle_disconnect() {

[174] Fix | Delete

[175] Fix | Delete

$live_mode = isset( $_GET['live_mode'] ) ? absint( $_GET['live_mode'] ) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended

[176] Fix | Delete

$mode = $live_mode ? Environment::PRODUCTION : Environment::SANDBOX;

[177] Fix | Delete

$connection = Connection::get( $mode );

[178] Fix | Delete

[179] Fix | Delete

if ( $connection ) {

[180] Fix | Delete

$connection->delete();

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

if ( Helpers::is_production_mode() ) {

[184] Fix | Delete

$this->unschedule_refresh();

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

if ( Helpers::is_webhook_enabled() ) {

[188] Fix | Delete

Helpers::reset_webhook_configuration( true );

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

Helpers::set_locataion_id( '', $mode );

[192] Fix | Delete

Helpers::detete_transients( $mode );

[193] Fix | Delete

[194] Fix | Delete

wp_safe_redirect( Helpers::get_settings_page_url() );

[195] Fix | Delete

exit;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* Handle refresh connection triggered by AS task.

[200] Fix | Delete

*

[201] Fix | Delete

* @since 1.9.5

[202] Fix | Delete

*/

[203] Fix | Delete

public function refresh_connection_schedule() {

[204] Fix | Delete

[205] Fix | Delete

// Don't run refresh tokens for Sandbox connection.

[206] Fix | Delete

if ( Helpers::is_sandbox_mode() ) {

[207] Fix | Delete

return;

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

$connection = Connection::get();

[211] Fix | Delete

[212] Fix | Delete

// Check connection and cancel AS task if connection is not exists, broken OR already invalid.

[213] Fix | Delete

if ( ! $connection || ! $connection->is_configured() || ! $connection->is_valid() ) {

[214] Fix | Delete

$this->unschedule_refresh();

[215] Fix | Delete

[216] Fix | Delete

return;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

// If connection is not expired, we'll just fetch active locations.

[220] Fix | Delete

if ( ! $connection->is_expired() ) {

[221] Fix | Delete

$this->prepare_locations( $connection->get_mode() );

[222] Fix | Delete

[223] Fix | Delete

return;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

// If connection is expired, try to refresh tokens.

[227] Fix | Delete

$connection = $this->try_refresh_connection( $connection );

[228] Fix | Delete

[229] Fix | Delete

if ( is_wp_error( $connection ) ) {

[230] Fix | Delete

return;

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

// If connection is invalid, we'll cancel AS task.

[234] Fix | Delete

if ( $connection && ! $connection->is_valid() ) {

[235] Fix | Delete

$this->unschedule_refresh();

[236] Fix | Delete

[237] Fix | Delete

return;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

// Make sure and check connection tokens through fetching active locations.

[241] Fix | Delete

$this->prepare_locations( $connection->get_mode() );

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Handle refresh connection triggered manually.

[246] Fix | Delete

*

[247] Fix | Delete

* @since 1.9.5

[248] Fix | Delete

*/

[249] Fix | Delete

public function refresh_connection_manual() {

[250] Fix | Delete

[251] Fix | Delete

// Security and permissions check.

[252] Fix | Delete

if (

[253] Fix | Delete

! check_ajax_referer( 'wpforms-admin', 'nonce', false ) ||

[254] Fix | Delete

! wpforms_current_user_can()

[255] Fix | Delete

) {

[256] Fix | Delete

wp_send_json_error( esc_html__( 'You are not allowed to perform this action', 'wpforms-lite' ) );

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

$error_general = esc_html__( 'Something went wrong while performing a refresh tokens request', 'wpforms-lite' );

[260] Fix | Delete

[261] Fix | Delete

// Required data check.

[262] Fix | Delete

if ( empty( $_POST['mode'] ) ) {

[263] Fix | Delete

wp_send_json_error( $error_general );

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

$mode = sanitize_key( $_POST['mode'] );

[267] Fix | Delete

$connection = Connection::get( $mode );

[268] Fix | Delete

[269] Fix | Delete

// Connection check.

[270] Fix | Delete

if ( ! $connection || ! $connection->is_configured() ) {

[271] Fix | Delete

wp_send_json_error( $error_general );

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

// Try to refresh connection.

[275] Fix | Delete

$connection = $this->try_refresh_connection( $connection );

[276] Fix | Delete

[277] Fix | Delete

if ( is_wp_error( $connection ) ) {

[278] Fix | Delete

$error_specific = $connection->get_error_message();

[279] Fix | Delete

$error_message = empty( $error_specific ) ? $error_general : $error_general . ': ' . $error_specific;

[280] Fix | Delete

[281] Fix | Delete

wp_send_json_error( $error_message );

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

$this->prepare_locations( $mode );

[285] Fix | Delete

[286] Fix | Delete

wp_send_json_success();

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Try to refresh connection.

[291] Fix | Delete

*

[292] Fix | Delete

* @since 1.9.5

[293] Fix | Delete

*

[294] Fix | Delete

* @param Connection $connection Connection object.

[295] Fix | Delete

*

[296] Fix | Delete

* @return Connection|WP_Error

[297] Fix | Delete

*/

[298] Fix | Delete

private function try_refresh_connection( $connection ) {

[299] Fix | Delete

[300] Fix | Delete

$response = $this->fetch_refresh_connection( $connection->get_refresh_token(), $connection->get_mode() );

[301] Fix | Delete

[302] Fix | Delete

if ( is_wp_error( $response ) ) {

[303] Fix | Delete

[304] Fix | Delete

if ( $response->get_error_code() === 'refresh_connection_fail' && $connection->is_valid() ) {

[305] Fix | Delete

$connection

[306] Fix | Delete

->set_status( Connection::STATUS_INVALID )

[307] Fix | Delete

->save();

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

return $response;

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

$refreshed_connection = $this->maybe_save_connection( $response, true );

[314] Fix | Delete

[315] Fix | Delete

return $refreshed_connection ?? new WP_Error();

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

/**

[319] Fix | Delete

* Schedule the connection refresh.

[320] Fix | Delete

*

[321] Fix | Delete

* @since 1.9.5

[322] Fix | Delete

*/

[323] Fix | Delete

private function schedule_refresh() {

[324] Fix | Delete

[325] Fix | Delete

/**

[326] Fix | Delete

* Allow modifying a condition check where the AS task will be registered.

[327] Fix | Delete

*

[328] Fix | Delete

* @since 1.9.5

[329] Fix | Delete

*

[330] Fix | Delete

* @param int $interval The refresh interval.

[331] Fix | Delete

*/

[332] Fix | Delete

if ( (bool) apply_filters( 'wpforms_square_admin_connect_schedule_refresh_prevent_task_registration', ! wpforms_is_admin_page() ) ) { // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[333] Fix | Delete

return;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

$tasks = wpforms()->obj( 'tasks' );

[337] Fix | Delete

[338] Fix | Delete

if ( is_null( $tasks ) ) {

[339] Fix | Delete

return;

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

if ( $tasks->is_scheduled( 'wpforms_square_refresh_connection' ) !== false ) {

[343] Fix | Delete

return;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

// Register AS task only if a Production connection exists.

[347] Fix | Delete

if ( ! Connection::get( Environment::PRODUCTION ) ) {

[348] Fix | Delete

return;

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

/**

[352] Fix | Delete

* Filter the frequency with which the OAuth connection should be refreshed.

[353] Fix | Delete

*

[354] Fix | Delete

* @since 1.9.5

[355] Fix | Delete

*

[356] Fix | Delete

* @param int $interval The refresh interval.

[357] Fix | Delete

*/

[358] Fix | Delete

$interval = (int) apply_filters( 'wpforms_square_admin_connect_schedule_refresh_interval', 12 * HOUR_IN_SECONDS ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[359] Fix | Delete

[360] Fix | Delete

$tasks->create( 'wpforms_square_refresh_connection' )

[361] Fix | Delete

->recurring( time() + $interval, $interval )

[362] Fix | Delete

->register();

[363] Fix | Delete

}

[364] Fix | Delete

[365] Fix | Delete

/**

[366] Fix | Delete

* Unschedule the connection refresh.

[367] Fix | Delete

*

[368] Fix | Delete

* @since 1.9.5

[369] Fix | Delete

*/

[370] Fix | Delete

private function unschedule_refresh() {

[371] Fix | Delete

[372] Fix | Delete

// Exit if AS function does not exist.

[373] Fix | Delete

if ( ! function_exists( 'as_unschedule_all_actions' ) ) {

[374] Fix | Delete

return;

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

as_unschedule_all_actions(

[378] Fix | Delete

'wpforms_square_refresh_connection',

[379] Fix | Delete

[ 'tasks_meta_id' => null ],

[380] Fix | Delete

Tasks::GROUP

[381] Fix | Delete

);

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

/**

[385] Fix | Delete

* Check connection raw data and save it if everything is OK.

[386] Fix | Delete

*

[387] Fix | Delete

* @since 1.9.5

[388] Fix | Delete

*

[389] Fix | Delete

* @param array $raw Connection raw data.

[390] Fix | Delete

* @param bool $silent Optional. Whether to prevent showing admin notices. Default false.

[391] Fix | Delete

*

[392] Fix | Delete

* @return Connection|null

[393] Fix | Delete

*/

[394] Fix | Delete

private function maybe_save_connection( array $raw, bool $silent = false ) {

[395] Fix | Delete

[396] Fix | Delete

$connection = new Connection( $raw, false );

[397] Fix | Delete

[398] Fix | Delete

// Bail if a connection doesn't have required data.

[399] Fix | Delete

if ( ! $connection->is_configured() ) {

[400] Fix | Delete

$silent ? wpforms_log(

[401] Fix | Delete

'Square error',

[402] Fix | Delete

'We could not connect to Square. No tokens were given.',

[403] Fix | Delete

[

[404] Fix | Delete

'type' => [ 'payment', 'error' ],

[405] Fix | Delete

]

[406] Fix | Delete

) : Notice::error( esc_html__( 'Square Error: We could not connect to Square. No tokens were given.', 'wpforms-lite' ) );

[407] Fix | Delete

[408] Fix | Delete

return null;

[409] Fix | Delete

}

[410] Fix | Delete

[411] Fix | Delete

// Prepare connection for save.

[412] Fix | Delete

$connection

[413] Fix | Delete

->set_renew_at()

[414] Fix | Delete

->set_scopes_updated()

[415] Fix | Delete

->encrypt_tokens();

[416] Fix | Delete

[417] Fix | Delete

// Bail if a connection is not ready for save.

[418] Fix | Delete

if ( ! $connection->is_saveable() ) {

[419] Fix | Delete

$silent ? wpforms_log(

[420] Fix | Delete

'Square error',

[421] Fix | Delete

'We could not save an account connection safely. Please, try again later.',

[422] Fix | Delete

[

[423] Fix | Delete

'type' => [ 'payment', 'error' ],

[424] Fix | Delete

]

[425] Fix | Delete

) : Notice::error( esc_html__( 'Square Error: We could not save an account connection safely. Please, try again later.', 'wpforms-lite' ) );

[426] Fix | Delete

[427] Fix | Delete

return null;

[428] Fix | Delete

}

[429] Fix | Delete

[430] Fix | Delete

$connection->save();

[431] Fix | Delete

[432] Fix | Delete

return $connection;

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

/**

[436] Fix | Delete

* Prepare Square business locations.

[437] Fix | Delete

*

[438] Fix | Delete

* @since 1.9.5

[439] Fix | Delete

*

[440] Fix | Delete

* @param string $mode Square mode.

[441] Fix | Delete

*

[442] Fix | Delete

* @return array

[443] Fix | Delete

*/

[444] Fix | Delete

private function prepare_locations( string $mode ): array {

[445] Fix | Delete

[446] Fix | Delete

$locations = $this->fetch_locations( $mode );

[447] Fix | Delete

[448] Fix | Delete

if ( $locations === null ) {

[449] Fix | Delete

$this->reset_location( $mode );

[450] Fix | Delete

[451] Fix | Delete

Transient::delete( 'wpforms_square_active_locations_' . $mode );

[452] Fix | Delete

[453] Fix | Delete

return [];

[454] Fix | Delete

}

[455] Fix | Delete

[456] Fix | Delete

$locations = $this->active_locations_filter( $locations );

[457] Fix | Delete

[458] Fix | Delete

if ( empty( $locations ) ) {

[459] Fix | Delete

$this->reset_location( $mode );

[460] Fix | Delete

[461] Fix | Delete

Transient::set( 'wpforms_square_active_locations_' . $mode, [] );

[462] Fix | Delete

[463] Fix | Delete

return [];

[464] Fix | Delete

}

[465] Fix | Delete

[466] Fix | Delete

$this->set_location( $locations, $mode );

[467] Fix | Delete

[468] Fix | Delete

Transient::set( 'wpforms_square_active_locations_' . $mode, $locations );

[469] Fix | Delete

[470] Fix | Delete

return $locations;

[471] Fix | Delete

}

[472] Fix | Delete

[473] Fix | Delete

/**

[474] Fix | Delete

* Fetch Square business locations.

[475] Fix | Delete

*

[476] Fix | Delete

* @since 1.9.5

[477] Fix | Delete

*

[478] Fix | Delete

* @param string $mode Square mode.

[479] Fix | Delete

*

[480] Fix | Delete

* @return array|null

[481] Fix | Delete

*/

[482] Fix | Delete

private function fetch_locations( string $mode ) {

[483] Fix | Delete

[484] Fix | Delete

$connection = Connection::get( $mode );

[485] Fix | Delete

[486] Fix | Delete

if ( ! $connection ) {

[487] Fix | Delete

return null;

[488] Fix | Delete

}

[489] Fix | Delete

[490] Fix | Delete

$api = new Api( $connection );

[491] Fix | Delete

$locations = $api->get_locations();

[492] Fix | Delete

[493] Fix | Delete

if ( ! $locations ) {

[494] Fix | Delete

$connection

[495] Fix | Delete

->set_status( Connection::STATUS_INVALID )

[496] Fix | Delete

->save();

[497] Fix | Delete

[498] Fix | Delete

return null;

[499] Fix | Delete