<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Stripe\Api;

[2] Fix | Delete

[3] Fix | Delete

use Exception;

[4] Fix | Delete

use WPForms\Vendor\Stripe\WebhookEndpoint;

[5] Fix | Delete

use WPForms\Integrations\Stripe\Helpers;

[6] Fix | Delete

use WPForms\Integrations\Stripe\WebhooksHealthCheck;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Webhooks Manager.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.8.4

[12] Fix | Delete

*/

[13] Fix | Delete

class WebhooksManager {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* API version.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.8.4

[19] Fix | Delete

*

[20] Fix | Delete

* @var string

[21] Fix | Delete

*/

[22] Fix | Delete

const STRIPE_API_VERSION = '2023-08-16';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Determine whether a webhook endpoint is valid.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.8.4

[28] Fix | Delete

*

[29] Fix | Delete

* @return bool

[30] Fix | Delete

*/

[31] Fix | Delete

public function is_valid(): bool {

[32] Fix | Delete

[33] Fix | Delete

$webhook_id = $this->get_id();

[34] Fix | Delete

[35] Fix | Delete

// It's not valid if either endpoint ID or secret is empty.

[36] Fix | Delete

if ( empty( $webhook_id ) || empty( $this->get_secret() ) ) {

[37] Fix | Delete

return false;

[38] Fix | Delete

}

[39] Fix | Delete

[40] Fix | Delete

$webhook = $this->get( $webhook_id );

[41] Fix | Delete

[42] Fix | Delete

if (

[43] Fix | Delete

! $webhook ||

[44] Fix | Delete

$webhook->status !== 'enabled' ||

[45] Fix | Delete

$webhook->url !== Helpers::get_webhook_url() ||

[46] Fix | Delete

! empty( array_diff( WebhookRoute::get_webhooks_events_list(), $webhook->enabled_events ) ) // Has unconfigured events.

[47] Fix | Delete

) {

[48] Fix | Delete

return false;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

return true;

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Retrieve a webhook endpoint ID.

[56] Fix | Delete

*

[57] Fix | Delete

* @since 1.8.4

[58] Fix | Delete

*

[59] Fix | Delete

* @return string

[60] Fix | Delete

*/

[61] Fix | Delete

public function get_id() {

[62] Fix | Delete

[63] Fix | Delete

return wpforms_setting( 'stripe-webhooks-id-' . Helpers::get_stripe_mode(), '' );

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Retrieve a webhook endpoint secret.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 1.8.4

[70] Fix | Delete

*

[71] Fix | Delete

* @return string

[72] Fix | Delete

*/

[73] Fix | Delete

private function get_secret() {

[74] Fix | Delete

[75] Fix | Delete

return wpforms_setting( 'stripe-webhooks-secret-' . Helpers::get_stripe_mode(), '' );

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Retrieve a webhook endpoint object.

[80] Fix | Delete

*

[81] Fix | Delete

* @since 1.8.4

[82] Fix | Delete

*

[83] Fix | Delete

* @param string $webhook_id Endpoint ID.

[84] Fix | Delete

*

[85] Fix | Delete

* @return WebhookEndpoint|null

[86] Fix | Delete

*/

[87] Fix | Delete

private function get( $webhook_id ) {

[88] Fix | Delete

[89] Fix | Delete

try {

[90] Fix | Delete

$webhook = WebhookEndpoint::retrieve( $webhook_id, Helpers::get_auth_opts() );

[91] Fix | Delete

} catch ( Exception $e ) {

[92] Fix | Delete

return null;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

return $webhook;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Update a webhook endpoint.

[100] Fix | Delete

*

[101] Fix | Delete

* @since 1.8.4

[102] Fix | Delete

*

[103] Fix | Delete

* @param string $id Endpoint ID.

[104] Fix | Delete

* @param array $params Params.

[105] Fix | Delete

*

[106] Fix | Delete

* @return WebhookEndpoint|null

[107] Fix | Delete

*/

[108] Fix | Delete

public function update( $id, $params ) {

[109] Fix | Delete

[110] Fix | Delete

try {

[111] Fix | Delete

$webhook = WebhookEndpoint::update( $id, $params, Helpers::get_auth_opts() );

[112] Fix | Delete

} catch ( Exception $e ) {

[113] Fix | Delete

return null;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

return $webhook;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* Connect webhook endpoint.

[121] Fix | Delete

*

[122] Fix | Delete

* Remove existing endpoints and create a new one.

[123] Fix | Delete

*

[124] Fix | Delete

* @since 1.8.4

[125] Fix | Delete

*

[126] Fix | Delete

* @return bool

[127] Fix | Delete

*/

[128] Fix | Delete

public function connect(): bool {

[129] Fix | Delete

[130] Fix | Delete

// Prevent duplication of endpoints.

[131] Fix | Delete

if ( $this->is_valid() ) {

[132] Fix | Delete

return true;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

// Clean up existing endpoints.

[136] Fix | Delete

$this->cleanup();

[137] Fix | Delete

[138] Fix | Delete

// Always create a new because you can't get a secret for existing.

[139] Fix | Delete

$webhook = $this->create();

[140] Fix | Delete

[141] Fix | Delete

// Register AS task.

[142] Fix | Delete

( new WebhooksHealthCheck() )->maybe_schedule_task();

[143] Fix | Delete

[144] Fix | Delete

// Store endpoint ID and secret.

[145] Fix | Delete

if ( $webhook ) {

[146] Fix | Delete

$this->save_settings( $webhook );

[147] Fix | Delete

[148] Fix | Delete

return true;

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

return false;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

* Cleanup endpoints.

[156] Fix | Delete

*

[157] Fix | Delete

* @since 1.8.4

[158] Fix | Delete

*

[159] Fix | Delete

* @return bool

[160] Fix | Delete

*/

[161] Fix | Delete

private function cleanup() {

[162] Fix | Delete

[163] Fix | Delete

try {

[164] Fix | Delete

$webhooks = $this->get_all();

[165] Fix | Delete

[166] Fix | Delete

if ( ! $webhooks ) {

[167] Fix | Delete

return false;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

$valid_urls = $this->get_valid_urls();

[171] Fix | Delete

[172] Fix | Delete

foreach ( $webhooks as $wh ) {

[173] Fix | Delete

if ( in_array( $wh->url, $valid_urls, true ) ) {

[174] Fix | Delete

$wh->delete();

[175] Fix | Delete

}

[176] Fix | Delete

}

[177] Fix | Delete

} catch ( Exception $e ) {

[178] Fix | Delete

return false;

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

return true;

[182] Fix | Delete

}

[183] Fix | Delete

[184] Fix | Delete

/**

[185] Fix | Delete

* Retrieve possible endpoint URLs.

[186] Fix | Delete

*

[187] Fix | Delete

* @since 1.8.4

[188] Fix | Delete

*

[189] Fix | Delete

* @return array

[190] Fix | Delete

*/

[191] Fix | Delete

private function get_valid_urls() {

[192] Fix | Delete

[193] Fix | Delete

$urls = [

[194] Fix | Delete

Helpers::get_webhook_url_for_rest(),

[195] Fix | Delete

Helpers::get_webhook_url_for_curl(),

[196] Fix | Delete

];

[197] Fix | Delete

[198] Fix | Delete

if ( defined( 'WPFORMS_STRIPE_WHURL' ) ) {

[199] Fix | Delete

$urls[] = WPFORMS_STRIPE_WHURL;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

return $urls;

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* Create a webhook endpoint.

[207] Fix | Delete

*

[208] Fix | Delete

* @since 1.8.4

[209] Fix | Delete

*

[210] Fix | Delete

* @return WebhookEndpoint|bool

[211] Fix | Delete

*/

[212] Fix | Delete

private function create() {

[213] Fix | Delete

[214] Fix | Delete

try {

[215] Fix | Delete

$webhook = WebhookEndpoint::create(

[216] Fix | Delete

[

[217] Fix | Delete

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

[218] Fix | Delete

'enabled_events' => WebhookRoute::get_webhooks_events_list(),

[219] Fix | Delete

'connect' => false,

[220] Fix | Delete

'api_version' => self::STRIPE_API_VERSION,

[221] Fix | Delete

'description' => sprintf(

[222] Fix | Delete

'WPForms endpoint (%1$s mode)',

[223] Fix | Delete

Helpers::get_stripe_mode()

[224] Fix | Delete

),

[225] Fix | Delete

],

[226] Fix | Delete

Helpers::get_auth_opts()

[227] Fix | Delete

);

[228] Fix | Delete

} catch ( Exception $e ) {

[229] Fix | Delete

return false;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

return $webhook;

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

/**

[236] Fix | Delete

* Get list of all webhook endpoints.

[237] Fix | Delete

*

[238] Fix | Delete

* @since 1.8.4

[239] Fix | Delete

*

[240] Fix | Delete

* @return array

[241] Fix | Delete

*/

[242] Fix | Delete

private function get_all(): array {

[243] Fix | Delete

[244] Fix | Delete

try {

[245] Fix | Delete

$webhooks = WebhookEndpoint::all( [], Helpers::get_auth_opts() );

[246] Fix | Delete

} catch ( Exception $e ) {

[247] Fix | Delete

return [];

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

return isset( $webhooks->data ) ? (array) $webhooks->data : [];

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

/**

[254] Fix | Delete

* Save webhook settings.

[255] Fix | Delete

*

[256] Fix | Delete

* @since 1.8.4

[257] Fix | Delete

*

[258] Fix | Delete

* @param WebhookEndpoint $webhook Webhook endpoint.

[259] Fix | Delete

*/

[260] Fix | Delete

private function save_settings( $webhook ) {

[261] Fix | Delete

[262] Fix | Delete

$mode = Helpers::get_stripe_mode();

[263] Fix | Delete

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

[264] Fix | Delete

[265] Fix | Delete

// Save webhooks endpoint ID.

[266] Fix | Delete

$settings[ 'stripe-webhooks-id-' . $mode ] = sanitize_text_field( $webhook->id );

[267] Fix | Delete

[268] Fix | Delete

// Store webhooks endpoint secret, but it is not defined on ::update() call.

[269] Fix | Delete

if ( ! empty( $webhook->secret ) ) {

[270] Fix | Delete

$settings[ 'stripe-webhooks-secret-' . $mode ] = sanitize_text_field( $webhook->secret );

[271] Fix | Delete

[272] Fix | Delete

WebhooksHealthCheck::save_status( WebhooksHealthCheck::SIGNATURE_OPTION, WebhooksHealthCheck::STATUS_OK );

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

WebhooksHealthCheck::save_status( WebhooksHealthCheck::ENDPOINT_OPTION, WebhooksHealthCheck::STATUS_OK );

[276] Fix | Delete

[277] Fix | Delete

// Enable webhooks setting shouldn't be rewritten.

[278] Fix | Delete

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

[279] Fix | Delete

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

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

update_option( 'wpforms_settings', $settings );

[283] Fix | Delete

}

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete