<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Square\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Integrations\Square\Helpers;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Square "Webhook Settings" section methods.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.9.5

[9] Fix | Delete

*/

[10] Fix | Delete

class WebhookSettings {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Square Apps URL.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.9.5

[16] Fix | Delete

*/

[17] Fix | Delete

public const SQUARE_APPS_URL = 'https://developer.squareup.com/apps';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Initialization.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.9.5

[23] Fix | Delete

*

[24] Fix | Delete

* @return WebhookSettings

[25] Fix | Delete

*/

[26] Fix | Delete

public function init(): WebhookSettings {

[27] Fix | Delete

[28] Fix | Delete

return $this;

[29] Fix | Delete

}

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Register "Square webhooks" settings fields.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.9.5

[35] Fix | Delete

*

[36] Fix | Delete

* @param array $settings Admin area settings list.

[37] Fix | Delete

*

[38] Fix | Delete

* @return array

[39] Fix | Delete

*/

[40] Fix | Delete

public function settings( $settings ): array {

[41] Fix | Delete

[42] Fix | Delete

$settings = (array) $settings;

[43] Fix | Delete

[44] Fix | Delete

$this->maybe_set_default_settings();

[45] Fix | Delete

[46] Fix | Delete

// Do not display it as long as a Square account is not connected.

[47] Fix | Delete

if ( ! Helpers::is_square_configured() ) {

[48] Fix | Delete

return $settings;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

$settings['payments']['square-webhooks-enabled'] = [

[52] Fix | Delete

'id' => 'square-webhooks-enabled',

[53] Fix | Delete

'name' => esc_html__( 'Enable Webhooks', 'wpforms-lite' ),

[54] Fix | Delete

'type' => 'toggle',

[55] Fix | Delete

'status' => true,

[56] Fix | Delete

'default' => true,

[57] Fix | Delete

'desc' => sprintf(

[58] Fix | Delete

wp_kses( /* translators: %s - WPForms.com URL for Square webhooks documentation. */

[59] Fix | Delete

__( 'Square uses webhooks to notify WPForms when an event has occurred in your Square account. Please see <a href="%s" target="_blank" rel="noopener noreferrer">our documentation on Square webhooks</a> for full details.', 'wpforms-lite' ),

[60] Fix | Delete

[

[61] Fix | Delete

'a' => [

[62] Fix | Delete

'href' => [],

[63] Fix | Delete

'target' => [],

[64] Fix | Delete

'rel' => [],

[65] Fix | Delete

],

[66] Fix | Delete

]

[67] Fix | Delete

),

[68] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setting-up-square-webhooks/', 'Settings - Payments', 'Square Webhooks Documentation' ) )

[69] Fix | Delete

),

[70] Fix | Delete

];

[71] Fix | Delete

[72] Fix | Delete

$mode = Helpers::get_mode();

[73] Fix | Delete

[74] Fix | Delete

$settings['payments'][ 'square-webhooks-connect-status-' . $mode ] = [

[75] Fix | Delete

'id' => 'square-webhooks-connect-status-' . $mode,

[76] Fix | Delete

'name' => '',

[77] Fix | Delete

'content' => $this->get_webhook_connection_notice(),

[78] Fix | Delete

'type' => 'content',

[79] Fix | Delete

'class' => Helpers::is_webhook_enabled() && ! Helpers::is_webhook_configured() ? '' : 'wpforms-hide',

[80] Fix | Delete

];

[81] Fix | Delete

[82] Fix | Delete

$settings['payments']['square-webhooks-connect'] = [

[83] Fix | Delete

'id' => 'square-webhooks-connect',

[84] Fix | Delete

'name' => '',

[85] Fix | Delete

'content' => $this->get_connect_button(),

[86] Fix | Delete

'type' => 'content',

[87] Fix | Delete

'class' => ! Helpers::is_webhook_enabled() ? 'wpforms-hide' : '',

[88] Fix | Delete

];

[89] Fix | Delete

[90] Fix | Delete

// Bail out if $_GET parameter is not passed.

[91] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[92] Fix | Delete

if ( ! isset( $_GET['webhooks_settings'] ) ) {

[93] Fix | Delete

return $settings;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

$settings['payments']['square-webhooks-communication'] = [

[97] Fix | Delete

'id' => 'square-webhooks-communication',

[98] Fix | Delete

'name' => esc_html__( 'Webhooks Method', 'wpforms-lite' ),

[99] Fix | Delete

'type' => 'radio',

[100] Fix | Delete

'default' => wpforms_setting( 'square-webhooks-communication', 'rest' ),

[101] Fix | Delete

'options' => [

[102] Fix | Delete

'rest' => esc_html__( 'REST API (recommended)', 'wpforms-lite' ),

[103] Fix | Delete

'curl' => esc_html__( 'PHP listener', 'wpforms-lite' ),

[104] Fix | Delete

],

[105] Fix | Delete

'desc' => sprintf(

[106] Fix | Delete

wp_kses( /* translators: %s - WPForms.com URL for Square webhooks documentation. */

[107] Fix | Delete

__( 'Choose the method of communication between Square and WPForms. If REST API support is disabled for WordPress, use PHP listener. <a href="%s" rel="nofollow noopener" target="_blank">Learn more</a>.', 'wpforms-lite' ),

[108] Fix | Delete

[

[109] Fix | Delete

'a' => [

[110] Fix | Delete

'href' => [],

[111] Fix | Delete

'target' => [],

[112] Fix | Delete

'rel' => [],

[113] Fix | Delete

],

[114] Fix | Delete

]

[115] Fix | Delete

),

[116] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setting-up-square-webhooks/', 'Settings - Payments', 'Square Webhooks Documentation' ) )

[117] Fix | Delete

),

[118] Fix | Delete

'class' => $this->get_html_classes(),

[119] Fix | Delete

];

[120] Fix | Delete

[121] Fix | Delete

$settings['payments']['square-webhooks-communication-status'] = [

[122] Fix | Delete

'id' => 'square-webhooks-communication-status',

[123] Fix | Delete

'name' => '',

[124] Fix | Delete

'content' => $this->display_webhooks_communication_notice(),

[125] Fix | Delete

'type' => 'content',

[126] Fix | Delete

'class' => 'wpforms-hide',

[127] Fix | Delete

];

[128] Fix | Delete

[129] Fix | Delete

$settings['payments']['square-webhooks-endpoint-set'] = [

[130] Fix | Delete

'id' => 'square-webhooks-endpoint-set',

[131] Fix | Delete

'name' => esc_html__( 'Webhooks Endpoint', 'wpforms-lite' ),

[132] Fix | Delete

'url' => Helpers::get_webhook_url(),

[133] Fix | Delete

'type' => 'webhook_endpoint',

[134] Fix | Delete

'provider' => 'square',

[135] Fix | Delete

'desc' => sprintf(

[136] Fix | Delete

wp_kses( /* translators: %s - Square Dashboard Webhooks Settings URL. */

[137] Fix | Delete

__( 'Ensure an endpoint with the above URL is present in the <a href="%s" target="_blank" rel="noopener noreferrer">Square webhook settings</a>.', 'wpforms-lite' ),

[138] Fix | Delete

[

[139] Fix | Delete

'a' => [

[140] Fix | Delete

'href' => [],

[141] Fix | Delete

'target' => [],

[142] Fix | Delete

'rel' => [],

[143] Fix | Delete

],

[144] Fix | Delete

]

[145] Fix | Delete

),

[146] Fix | Delete

esc_url( self::SQUARE_APPS_URL )

[147] Fix | Delete

),

[148] Fix | Delete

'class' => $this->get_html_classes(),

[149] Fix | Delete

];

[150] Fix | Delete

[151] Fix | Delete

$settings['payments']['square-webhooks-id-sandbox'] = [

[152] Fix | Delete

'id' => 'square-webhooks-id-sandbox',

[153] Fix | Delete

'name' => esc_html__( 'Webhooks Test ID', 'wpforms-lite' ),

[154] Fix | Delete

'type' => 'text',

[155] Fix | Delete

'desc' => $this->get_webhooks_id_desc( 'sandbox' ),

[156] Fix | Delete

'class' => $this->get_html_classes(),

[157] Fix | Delete

];

[158] Fix | Delete

[159] Fix | Delete

$settings['payments']['square-webhooks-secret-sandbox'] = [

[160] Fix | Delete

'id' => 'square-webhooks-secret-sandbox',

[161] Fix | Delete

'name' => esc_html__( 'Webhooks Test Signature Key', 'wpforms-lite' ),

[162] Fix | Delete

'type' => 'password',

[163] Fix | Delete

'desc' => $this->get_webhooks_secret_desc( 'sandbox' ),

[164] Fix | Delete

'class' => $this->get_html_classes(),

[165] Fix | Delete

];

[166] Fix | Delete

[167] Fix | Delete

$settings['payments']['square-webhooks-id-live'] = [

[168] Fix | Delete

'id' => 'square-webhooks-id-live',

[169] Fix | Delete

'name' => esc_html__( 'Webhooks Live ID', 'wpforms-lite' ),

[170] Fix | Delete

'type' => 'text',

[171] Fix | Delete

'desc' => $this->get_webhooks_id_desc( 'live' ),

[172] Fix | Delete

'class' => $this->get_html_classes(),

[173] Fix | Delete

];

[174] Fix | Delete

[175] Fix | Delete

$settings['payments']['square-webhooks-secret-live'] = [

[176] Fix | Delete

'id' => 'square-webhooks-secret-live',

[177] Fix | Delete

'name' => esc_html__( 'Webhooks Live Signature Key', 'wpforms-lite' ),

[178] Fix | Delete

'type' => 'password',

[179] Fix | Delete

'desc' => $this->get_webhooks_secret_desc( 'live' ),

[180] Fix | Delete

'class' => $this->get_html_classes(),

[181] Fix | Delete

];

[182] Fix | Delete

[183] Fix | Delete

return $settings;

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Get the Webhook connection notice.

[188] Fix | Delete

*

[189] Fix | Delete

* @since 1.9.5

[190] Fix | Delete

*

[191] Fix | Delete

* @return string

[192] Fix | Delete

*/

[193] Fix | Delete

private function get_webhook_connection_notice(): string {

[194] Fix | Delete

[195] Fix | Delete

if ( ! Helpers::is_webhook_enabled() ) {

[196] Fix | Delete

return '';

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

if ( Helpers::is_webhook_configured() ) {

[200] Fix | Delete

return '';

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

return sprintf(

[204] Fix | Delete

'<div class="wpforms-notice notice-error"><p><span class="wpforms-error-icon"></span>%1$s</p></div>',

[205] Fix | Delete

esc_html__( 'Webhooks are enabled, but not yet connected.', 'wpforms-lite' )

[206] Fix | Delete

);

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

/**

[210] Fix | Delete

* Display the Webhooks communication notice. The notice is displayed when a user tries to change communication method manually

[211] Fix | Delete

* and needs to be informed that the Webhook URL should be updated after that accordingly.

[212] Fix | Delete

*

[213] Fix | Delete

* @since 1.9.5

[214] Fix | Delete

*

[215] Fix | Delete

* @return string

[216] Fix | Delete

*/

[217] Fix | Delete

private function display_webhooks_communication_notice(): string {

[218] Fix | Delete

[219] Fix | Delete

return sprintf(

[220] Fix | Delete

'<div class="wpforms-notice notice-warning"><p>%1$s</p></div>',

[221] Fix | Delete

esc_html__( 'Make sure that Webhooks Endpoint is updated inside the Square app after Webhooks Method switch.', 'wpforms-lite' )

[222] Fix | Delete

);

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Show the link to the documentation about the Webhooks ID.

[227] Fix | Delete

*

[228] Fix | Delete

* @since 1.9.5

[229] Fix | Delete

*

[230] Fix | Delete

* @param string $mode Square mode (e.g. 'live' or 'sandbox').

[231] Fix | Delete

*

[232] Fix | Delete

* @return string

[233] Fix | Delete

*/

[234] Fix | Delete

private function get_webhooks_id_desc( string $mode ): string {

[235] Fix | Delete

[236] Fix | Delete

$modes = [

[237] Fix | Delete

'live' => __( 'Live Mode Endpoint Subscription ID', 'wpforms-lite' ),

[238] Fix | Delete

'sandbox' => __( 'Test Mode Endpoint Subscription ID', 'wpforms-lite' ),

[239] Fix | Delete

];

[240] Fix | Delete

[241] Fix | Delete

return sprintf(

[242] Fix | Delete

wp_kses( /* translators: %1$s - Live Mode Endpoint ID or Test Mode Endpoint ID. %2$s - Square Dashboard Webhooks Settings URL. */

[243] Fix | Delete

__( 'Retrieve your %1$s from your <a href="%2$s" target="_blank" rel="noopener noreferrer">Square webhook settings</a>. Select the endpoint, then click Copy button.', 'wpforms-lite' ),

[244] Fix | Delete

[

[245] Fix | Delete

'a' => [

[246] Fix | Delete

'href' => [],

[247] Fix | Delete

'target' => [],

[248] Fix | Delete

'rel' => [],

[249] Fix | Delete

],

[250] Fix | Delete

]

[251] Fix | Delete

),

[252] Fix | Delete

$modes[ $mode ],

[253] Fix | Delete

esc_url( self::SQUARE_APPS_URL )

[254] Fix | Delete

);

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

/**

[258] Fix | Delete

* Show the link to the documentation about the Webhook Signature Key.

[259] Fix | Delete

*

[260] Fix | Delete

* @since 1.9.5

[261] Fix | Delete

*

[262] Fix | Delete

* @param string $mode Square mode (e.g. 'live' or 'sandbox').

[263] Fix | Delete

*

[264] Fix | Delete

* @return string

[265] Fix | Delete

*/

[266] Fix | Delete

private function get_webhooks_secret_desc( string $mode ): string {

[267] Fix | Delete

[268] Fix | Delete

$modes = [

[269] Fix | Delete

'live' => __( 'Live Mode Signature Key', 'wpforms-lite' ),

[270] Fix | Delete

'sandbox' => __( 'Test Mode Signature Key', 'wpforms-lite' ),

[271] Fix | Delete

];

[272] Fix | Delete

[273] Fix | Delete

return sprintf(

[274] Fix | Delete

wp_kses( /* translators: %1$s - Live Mode Signing Secret or Test Mode Signing Secret. %2$s - Square Dashboard Webhooks Settings URL. */

[275] Fix | Delete

__( 'Retrieve your %1$s from your <a href="%2$s" target="_blank" rel="noopener noreferrer">Square webhook settings</a>. Select the endpoint, then click Reveal.', 'wpforms-lite' ),

[276] Fix | Delete

[

[277] Fix | Delete

'a' => [

[278] Fix | Delete

'href' => [],

[279] Fix | Delete

'target' => [],

[280] Fix | Delete

'rel' => [],

[281] Fix | Delete

],

[282] Fix | Delete

]

[283] Fix | Delete

),

[284] Fix | Delete

$modes[ $mode ],

[285] Fix | Delete

esc_url( self::SQUARE_APPS_URL )

[286] Fix | Delete

);

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Get HTML classes for the Webhooks section.

[291] Fix | Delete

*

[292] Fix | Delete

* @since 1.9.5

[293] Fix | Delete

*

[294] Fix | Delete

* @return array

[295] Fix | Delete

*/

[296] Fix | Delete

private function get_html_classes(): array {

[297] Fix | Delete

[298] Fix | Delete

$classes = [ 'wpforms-settings-square-webhooks' ];

[299] Fix | Delete

[300] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[301] Fix | Delete

if ( isset( $_GET['webhooks_settings'] ) ) {

[302] Fix | Delete

return $classes;

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

if ( ! wpforms_setting( 'square-webhooks-enabled' ) ) {

[306] Fix | Delete

$classes[] = 'wpforms-hide';

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

return $classes;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

/**

[313] Fix | Delete

* Maybe set default settings.

[314] Fix | Delete

*

[315] Fix | Delete

* @since 1.9.5

[316] Fix | Delete

*/

[317] Fix | Delete

private function maybe_set_default_settings() {

[318] Fix | Delete

[319] Fix | Delete

$settings = (array) get_option( 'wpforms_settings', [] );

[320] Fix | Delete

$is_updated = false;

[321] Fix | Delete

[322] Fix | Delete

// Enable Square webhooks by default if an account is connected.

[323] Fix | Delete

if ( ! isset( $settings['square-webhooks-enabled'] ) && Helpers::is_square_configured() ) {

[324] Fix | Delete

$settings['square-webhooks-enabled'] = true;

[325] Fix | Delete

[326] Fix | Delete

$is_updated = true;

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

// Set a default communication method.

[330] Fix | Delete

if ( ! isset( $settings['square-webhooks-communication'] ) ) {

[331] Fix | Delete

$settings['square-webhooks-communication'] = $this->is_rest_api_enabled() ? 'rest' : 'curl';

[332] Fix | Delete

[333] Fix | Delete

$is_updated = true;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

// Save settings only if something is changed.

[337] Fix | Delete

if ( $is_updated ) {

[338] Fix | Delete

update_option( 'wpforms_settings', $settings );

[339] Fix | Delete

}

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

/**

[343] Fix | Delete

* Check if REST API is enabled.

[344] Fix | Delete

*

[345] Fix | Delete

* Testing configured webhook endpoint with non-authorised request.

[346] Fix | Delete

* Based on UsageTracking::is_rest_api_enabled().

[347] Fix | Delete

*

[348] Fix | Delete

* @since 1.9.5

[349] Fix | Delete

*

[350] Fix | Delete

* @return bool

[351] Fix | Delete

*/

[352] Fix | Delete

private function is_rest_api_enabled(): bool {

[353] Fix | Delete

[354] Fix | Delete

// phpcs:disable WPForms.PHP.ValidateHooks.InvalidHookName

[355] Fix | Delete

/** This filter is documented in wp-includes/class-wp-http-streams.php */

[356] Fix | Delete

$sslverify = apply_filters( 'https_local_ssl_verify', false );

[357] Fix | Delete

// phpcs:enable WPForms.PHP.ValidateHooks.InvalidHookName

[358] Fix | Delete

[359] Fix | Delete

$url = add_query_arg( [ 'verify' => 1 ], Helpers::get_webhook_url_for_rest() );

[360] Fix | Delete

$response = wp_remote_get(

[361] Fix | Delete

$url,

[362] Fix | Delete

[

[363] Fix | Delete

'timeout' => 10,

[364] Fix | Delete

'cookies' => [],

[365] Fix | Delete

'sslverify' => $sslverify,

[366] Fix | Delete

'headers' => [

[367] Fix | Delete

'Cache-Control' => 'no-cache',

[368] Fix | Delete

],

[369] Fix | Delete

]

[370] Fix | Delete

);

[371] Fix | Delete

[372] Fix | Delete

// When testing the REST API, an error was encountered, leave early.

[373] Fix | Delete

if ( is_wp_error( $response ) ) {

[374] Fix | Delete

return false;

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

// When testing the REST API, an unexpected result was returned, leave early.

[378] Fix | Delete

if ( wp_remote_retrieve_response_code( $response ) !== 200 ) {

[379] Fix | Delete

return false;

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

// The REST API did not behave correctly, leave early.

[383] Fix | Delete

if ( ! wpforms_is_json( wp_remote_retrieve_body( $response ) ) ) {

[384] Fix | Delete

return false;

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

// We are all set. Confirm the connection.

[388] Fix | Delete

return true;

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete

/**

[392] Fix | Delete

* Get the "Connect Webhooks" button.

[393] Fix | Delete

*

[394] Fix | Delete

* @since 1.9.5

[395] Fix | Delete

*

[396] Fix | Delete

* @return string

[397] Fix | Delete

*/

[398] Fix | Delete

private function get_connect_button(): string {

[399] Fix | Delete

[400] Fix | Delete

$is_connected = Helpers::is_webhook_enabled() && Helpers::is_webhook_configured();

[401] Fix | Delete

[402] Fix | Delete

if ( $is_connected ) {

[403] Fix | Delete

return sprintf(

[404] Fix | Delete

'<div><span class="%s"></span>%s</div>',

[405] Fix | Delete

esc_attr( 'wpforms-success-icon' ),

[406] Fix | Delete

esc_html__( 'Webhooks are connected and active.', 'wpforms-lite' )

[407] Fix | Delete

);

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

$button = sprintf(

[411] Fix | Delete

'<button class="wpforms-btn wpforms-btn-md wpforms-btn-blue" type="button" id="wpforms-setting-square-webhooks-connect" title="%1$s">%2$s</button>',

[412] Fix | Delete

esc_attr__( 'Press here to see the further instructions.', 'wpforms-lite' ),

[413] Fix | Delete

esc_html__( 'Connect Webhooks', 'wpforms-lite' )

[414] Fix | Delete

);

[415] Fix | Delete

[416] Fix | Delete

$description = sprintf(

[417] Fix | Delete

'<p class="desc">%s</p>',

[418] Fix | Delete

wp_kses(

[419] Fix | Delete

/* translators: %s - WPForms.com URL for Square webhooks documentation. */

[420] Fix | Delete

__( 'To start using webhooks, please register a webhook route inside our application. You can do this by pressing the button above or setting the credentials manually. Please see <a href="%1$s" target="_blank">our documentation on Square webhooks</a> for full details.', 'wpforms-lite' ),

[421] Fix | Delete

[

[422] Fix | Delete

'a' => [

[423] Fix | Delete

'href' => [],

[424] Fix | Delete

'target' => [],

[425] Fix | Delete

],

[426] Fix | Delete

]

[427] Fix | Delete

)

[428] Fix | Delete

);

[429] Fix | Delete

[430] Fix | Delete

$description = sprintf( $description, esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setting-up-square-webhooks/', 'Settings - Payments', 'Square Webhooks Documentation' ) ) );

[431] Fix | Delete

[432] Fix | Delete

return $button . $description;

[433] Fix | Delete

}

[434] Fix | Delete

}

[435] Fix | Delete

[436] Fix | Delete