<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Stripe\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Integrations\Stripe\Helpers;

[4] Fix | Delete

use WPForms\Integrations\Stripe\WebhooksHealthCheck;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Stripe "Webhook Settings" section methods.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.8.4

[10] Fix | Delete

*/

[11] Fix | Delete

class WebhookSettings {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Initialization.

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.8.4

[17] Fix | Delete

*

[18] Fix | Delete

* @return WebhookSettings

[19] Fix | Delete

*/

[20] Fix | Delete

public function init() {

[21] Fix | Delete

[22] Fix | Delete

return $this;

[23] Fix | Delete

}

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Register "Stripe webhooks" settings fields.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 1.8.4

[29] Fix | Delete

*

[30] Fix | Delete

* @param array $settings Admin area settings list.

[31] Fix | Delete

*

[32] Fix | Delete

* @return array

[33] Fix | Delete

*/

[34] Fix | Delete

public function settings( $settings ) {

[35] Fix | Delete

[36] Fix | Delete

$this->maybe_set_default_settings();

[37] Fix | Delete

[38] Fix | Delete

// Do not display it as long as Stripe account is not connected.

[39] Fix | Delete

if ( ! Helpers::has_stripe_keys() ) {

[40] Fix | Delete

return $settings;

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

$settings['stripe-webhooks-enabled'] = [

[44] Fix | Delete

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

[45] Fix | Delete

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

[46] Fix | Delete

'type' => 'toggle',

[47] Fix | Delete

'status' => true,

[48] Fix | Delete

'default' => true,

[49] Fix | Delete

'desc' => sprintf(

[50] Fix | Delete

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

[51] Fix | Delete

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

[52] Fix | Delete

[

[53] Fix | Delete

'a' => [

[54] Fix | Delete

'href' => [],

[55] Fix | Delete

'target' => [],

[56] Fix | Delete

'rel' => [],

[57] Fix | Delete

],

[58] Fix | Delete

]

[59] Fix | Delete

),

[60] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setting-up-stripe-webhooks/', 'Stripe Settings', 'Enable webhooks' ) )

[61] Fix | Delete

),

[62] Fix | Delete

];

[63] Fix | Delete

[64] Fix | Delete

// Bail out if $_GET parameter is not passed or webhooks is configured and active.

[65] Fix | Delete

if (

[66] Fix | Delete

! isset( $_GET['webhooks_settings'] ) && // phpcs:ignore WordPress.Security.NonceVerification.Recommended

[67] Fix | Delete

Helpers::is_webhook_configured() &&

[68] Fix | Delete

( new WebhooksHealthCheck() )->is_webhooks_active()

[69] Fix | Delete

) {

[70] Fix | Delete

return $settings;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

$settings['stripe-webhooks-communication'] = [

[74] Fix | Delete

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

[75] Fix | Delete

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

[76] Fix | Delete

'type' => 'radio',

[77] Fix | Delete

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

[78] Fix | Delete

'options' => [

[79] Fix | Delete

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

[80] Fix | Delete

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

[81] Fix | Delete

],

[82] Fix | Delete

'desc' => sprintf(

[83] Fix | Delete

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

[84] Fix | Delete

__( 'Choose the method of communication between Stripe 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' ),

[85] Fix | Delete

[

[86] Fix | Delete

'a' => [

[87] Fix | Delete

'href' => [],

[88] Fix | Delete

'target' => [],

[89] Fix | Delete

'rel' => [],

[90] Fix | Delete

],

[91] Fix | Delete

]

[92] Fix | Delete

),

[93] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setting-up-stripe-webhooks/', 'Stripe Settings', 'Webhook Listener' ) )

[94] Fix | Delete

),

[95] Fix | Delete

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

[96] Fix | Delete

];

[97] Fix | Delete

[98] Fix | Delete

$settings['stripe-webhooks-endpoint-set'] = [

[99] Fix | Delete

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

[100] Fix | Delete

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

[101] Fix | Delete

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

[102] Fix | Delete

'type' => 'webhook_endpoint',

[103] Fix | Delete

'desc' => sprintf(

[104] Fix | Delete

wp_kses( /* translators: %s - Stripe Webhooks Settings url. */

[105] Fix | Delete

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

[106] Fix | Delete

[

[107] Fix | Delete

'a' => [

[108] Fix | Delete

'href' => [],

[109] Fix | Delete

'target' => [],

[110] Fix | Delete

'rel' => [],

[111] Fix | Delete

],

[112] Fix | Delete

]

[113] Fix | Delete

),

[114] Fix | Delete

Helpers::get_stripe_mode() === 'test' ? 'https://dashboard.stripe.com/test/workbench/webhooks/create' : 'https://dashboard.stripe.com/workbench/webhooks/create'

[115] Fix | Delete

),

[116] Fix | Delete

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

[117] Fix | Delete

];

[118] Fix | Delete

[119] Fix | Delete

$settings['stripe-webhooks-id-test'] = [

[120] Fix | Delete

'id' => 'stripe-webhooks-id-test',

[121] Fix | Delete

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

[122] Fix | Delete

'type' => 'text',

[123] Fix | Delete

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

[124] Fix | Delete

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

[125] Fix | Delete

];

[126] Fix | Delete

[127] Fix | Delete

$settings['stripe-webhooks-secret-test'] = [

[128] Fix | Delete

'id' => 'stripe-webhooks-secret-test',

[129] Fix | Delete

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

[130] Fix | Delete

'type' => 'password',

[131] Fix | Delete

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

[132] Fix | Delete

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

[133] Fix | Delete

];

[134] Fix | Delete

[135] Fix | Delete

$settings['stripe-webhooks-id-live'] = [

[136] Fix | Delete

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

[137] Fix | Delete

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

[138] Fix | Delete

'type' => 'text',

[139] Fix | Delete

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

[140] Fix | Delete

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

[141] Fix | Delete

];

[142] Fix | Delete

[143] Fix | Delete

$settings['stripe-webhooks-secret-live'] = [

[144] Fix | Delete

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

[145] Fix | Delete

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

[146] Fix | Delete

'type' => 'password',

[147] Fix | Delete

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

[148] Fix | Delete

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

[149] Fix | Delete

];

[150] Fix | Delete

[151] Fix | Delete

return $settings;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

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

[156] Fix | Delete

*

[157] Fix | Delete

* @since 1.8.4

[158] Fix | Delete

*

[159] Fix | Delete

* @param string $mode Stripe mode (e.g. 'live' or 'test').

[160] Fix | Delete

*

[161] Fix | Delete

* @return string

[162] Fix | Delete

*/

[163] Fix | Delete

private function get_webhooks_id_desc( $mode ) {

[164] Fix | Delete

[165] Fix | Delete

$modes = [

[166] Fix | Delete

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

[167] Fix | Delete

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

[168] Fix | Delete

];

[169] Fix | Delete

[170] Fix | Delete

return sprintf(

[171] Fix | Delete

wp_kses( /* translators: %1$s - Live Mode Endpoint ID or Test Mode Endpoint ID. %2$s - WPForms.com Stripe documentation article URL. */

[172] Fix | Delete

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

[173] Fix | Delete

[

[174] Fix | Delete

'a' => [

[175] Fix | Delete

'href' => [],

[176] Fix | Delete

'target' => [],

[177] Fix | Delete

'rel' => [],

[178] Fix | Delete

],

[179] Fix | Delete

]

[180] Fix | Delete

),

[181] Fix | Delete

$modes[ $mode ],

[182] Fix | Delete

$mode === 'test' ? 'https://dashboard.stripe.com/test/workbench/webhooks' : 'https://dashboard.stripe.com/workbench/webhooks'

[183] Fix | Delete

);

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

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

[188] Fix | Delete

*

[189] Fix | Delete

* @since 1.8.4

[190] Fix | Delete

*

[191] Fix | Delete

* @param string $mode Stripe mode (e.g. 'live' or 'test').

[192] Fix | Delete

*

[193] Fix | Delete

* @return string

[194] Fix | Delete

*/

[195] Fix | Delete

private function get_webhooks_secret_desc( $mode ) {

[196] Fix | Delete

[197] Fix | Delete

$modes = [

[198] Fix | Delete

'live' => __( 'Live Mode Signing Secret', 'wpforms-lite' ),

[199] Fix | Delete

'test' => __( 'Test Mode Signing Secret', 'wpforms-lite' ),

[200] Fix | Delete

];

[201] Fix | Delete

[202] Fix | Delete

return sprintf(

[203] Fix | Delete

wp_kses( /* translators: %1$s - Live Mode Signing Secret or Test Mode Signing Secret. %2$s - WPForms.com Stripe documentation article URL. */

[204] Fix | Delete

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

[205] Fix | Delete

[

[206] Fix | Delete

'a' => [

[207] Fix | Delete

'href' => [],

[208] Fix | Delete

'target' => [],

[209] Fix | Delete

'rel' => [],

[210] Fix | Delete

],

[211] Fix | Delete

]

[212] Fix | Delete

),

[213] Fix | Delete

$modes[ $mode ],

[214] Fix | Delete

$mode === 'test' ? 'https://dashboard.stripe.com/test/workbench/webhooks' : 'https://dashboard.stripe.com/workbench/webhooks'

[215] Fix | Delete

);

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Get HTML classes for the Webhooks section.

[220] Fix | Delete

*

[221] Fix | Delete

* @since 1.8.4

[222] Fix | Delete

*

[223] Fix | Delete

* @return array

[224] Fix | Delete

*/

[225] Fix | Delete

private function get_html_classes() {

[226] Fix | Delete

[227] Fix | Delete

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

[228] Fix | Delete

[229] Fix | Delete

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

[230] Fix | Delete

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

[231] Fix | Delete

return $classes;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

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

[235] Fix | Delete

$classes[] = 'wpforms-hide';

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

return $classes;

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Maybe set default settings.

[243] Fix | Delete

*

[244] Fix | Delete

* @since 1.8.4

[245] Fix | Delete

*/

[246] Fix | Delete

private function maybe_set_default_settings() {

[247] Fix | Delete

[248] Fix | Delete

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

[249] Fix | Delete

$is_updated = false;

[250] Fix | Delete

[251] Fix | Delete

// Enable Stripe webhooks by default if account is connected.

[252] Fix | Delete

// phpcs:ignore WPForms.PHP.BackSlash.UseShortSyntax

[253] Fix | Delete

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

[254] Fix | Delete

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

[255] Fix | Delete

[256] Fix | Delete

$is_updated = true;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

// Set a default communication method.

[260] Fix | Delete

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

[261] Fix | Delete

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

[262] Fix | Delete

[263] Fix | Delete

$is_updated = true;

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

// Save settings only if something is changed.

[267] Fix | Delete

if ( $is_updated ) {

[268] Fix | Delete

update_option( 'wpforms_settings', $settings );

[269] Fix | Delete

}

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Check if REST API is enabled.

[274] Fix | Delete

*

[275] Fix | Delete

* Testing configured webhook endpoint with non-authorised request.

[276] Fix | Delete

* Based on UsageTracking::is_rest_api_enabled().

[277] Fix | Delete

*

[278] Fix | Delete

* @since 1.8.4

[279] Fix | Delete

*

[280] Fix | Delete

* @return bool

[281] Fix | Delete

*/

[282] Fix | Delete

private function is_rest_api_enabled() {

[283] Fix | Delete

[284] Fix | Delete

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

[285] Fix | Delete

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

[286] Fix | Delete

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

[287] Fix | Delete

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

[288] Fix | Delete

[289] Fix | Delete

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

[290] Fix | Delete

$response = wp_remote_get(

[291] Fix | Delete

$url,

[292] Fix | Delete

[

[293] Fix | Delete

'timeout' => 10,

[294] Fix | Delete

'cookies' => [],

[295] Fix | Delete

'sslverify' => $sslverify,

[296] Fix | Delete

'headers' => [

[297] Fix | Delete

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

[298] Fix | Delete

],

[299] Fix | Delete

]

[300] Fix | Delete

);

[301] Fix | Delete

[302] Fix | Delete

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

[303] Fix | Delete

if ( is_wp_error( $response ) ) {

[304] Fix | Delete

return false;

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

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

[308] Fix | Delete

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

[309] Fix | Delete

return false;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

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

[313] Fix | Delete

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

[314] Fix | Delete

return false;

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

// We are all set. Confirm the connection.

[318] Fix | Delete

return true;

[319] Fix | Delete

}

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete