<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Stripe;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Notice;

[4] Fix | Delete

use WPForms\Integrations\Stripe\Api\WebhooksManager;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Webhooks Health Check class.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.8.4

[10] Fix | Delete

*/

[11] Fix | Delete

class WebhooksHealthCheck {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Endpoint status option name.

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.8.4

[17] Fix | Delete

*/

[18] Fix | Delete

const ENDPOINT_OPTION = 'wpforms_stripe_webhooks_endpoint_status';

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Signature status option name.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 1.8.4

[24] Fix | Delete

*/

[25] Fix | Delete

const SIGNATURE_OPTION = 'wpforms_stripe_webhooks_signature_status';

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Signature verified key.

[29] Fix | Delete

*

[30] Fix | Delete

* @since 1.8.4

[31] Fix | Delete

*/

[32] Fix | Delete

const STATUS_OK = 'ok';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Signature error key.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.8.4

[38] Fix | Delete

*/

[39] Fix | Delete

const STATUS_ERROR = 'error';

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* AS task name.

[43] Fix | Delete

*

[44] Fix | Delete

* @since 1.8.4

[45] Fix | Delete

*/

[46] Fix | Delete

const ACTION = 'wpforms_stripe_webhooks_health_check';

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Admin notice ID.

[50] Fix | Delete

*

[51] Fix | Delete

* @since 1.8.4

[52] Fix | Delete

*/

[53] Fix | Delete

const NOTICE_ID = 'wpforms_stripe_webhooks_site_health';

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Webhooks manager.

[57] Fix | Delete

*

[58] Fix | Delete

* @since 1.8.4

[59] Fix | Delete

*

[60] Fix | Delete

* @var WebhooksManager

[61] Fix | Delete

*/

[62] Fix | Delete

private $webhooks_manager;

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Initialization.

[66] Fix | Delete

*

[67] Fix | Delete

* @since 1.8.4

[68] Fix | Delete

*/

[69] Fix | Delete

public function init() {

[70] Fix | Delete

[71] Fix | Delete

$this->webhooks_manager = new WebhooksManager();

[72] Fix | Delete

[73] Fix | Delete

$this->hooks();

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Register hooks.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 1.8.4

[80] Fix | Delete

*/

[81] Fix | Delete

private function hooks() {

[82] Fix | Delete

[83] Fix | Delete

add_action( 'admin_notices', [ $this, 'admin_notice' ] );

[84] Fix | Delete

add_action( self::ACTION, [ $this, 'process_webhooks_status_action' ] );

[85] Fix | Delete

add_action( 'action_scheduler/migration_complete', [ $this, 'maybe_schedule_task' ] );

[86] Fix | Delete

add_action( 'wpforms_settings_updated', [ $this, 'maybe_webhook_settings_is_updated' ], 10, 3 );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Schedule webhooks health check.

[91] Fix | Delete

*

[92] Fix | Delete

* @since 1.8.4

[93] Fix | Delete

*/

[94] Fix | Delete

public function maybe_schedule_task() {

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Allow customers to disable webhooks health check task.

[98] Fix | Delete

*

[99] Fix | Delete

* @since 1.8.4

[100] Fix | Delete

*

[101] Fix | Delete

* @param bool $cancel True if task needs to be canceled.

[102] Fix | Delete

*/

[103] Fix | Delete

$is_canceled = (bool) apply_filters( 'wpforms_integrations_stripe_webhooks_health_check_cancel', false );

[104] Fix | Delete

[105] Fix | Delete

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

[106] Fix | Delete

[107] Fix | Delete

// Bail early in some instances.

[108] Fix | Delete

if (

[109] Fix | Delete

$is_canceled ||

[110] Fix | Delete

! Helpers::has_stripe_keys() ||

[111] Fix | Delete

$tasks->is_scheduled( self::ACTION )

[112] Fix | Delete

) {

[113] Fix | Delete

return;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Filters the webhooks health check interval.

[118] Fix | Delete

*

[119] Fix | Delete

* @since 1.8.4

[120] Fix | Delete

*

[121] Fix | Delete

* @param int $interval Interval in seconds.

[122] Fix | Delete

*/

[123] Fix | Delete

$interval = (int) apply_filters( 'wpforms_integrations_stripe_webhooks_health_check_interval', HOUR_IN_SECONDS );

[124] Fix | Delete

[125] Fix | Delete

$tasks->create( self::ACTION )

[126] Fix | Delete

->recurring( time(), $interval )

[127] Fix | Delete

->register();

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Process webhooks status.

[132] Fix | Delete

*

[133] Fix | Delete

* @since 1.8.4

[134] Fix | Delete

*/

[135] Fix | Delete

public function process_webhooks_status_action() {

[136] Fix | Delete

[137] Fix | Delete

// Bail out if user unchecked option to enable webhooks.

[138] Fix | Delete

if ( ! Helpers::is_webhook_enabled() ) {

[139] Fix | Delete

return;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

$last_payment = $this->get_last_stripe_payment();

[143] Fix | Delete

[144] Fix | Delete

// Bail out if there is no Stripe payment,

[145] Fix | Delete

// and remove options for reason to avoid any edge cases.

[146] Fix | Delete

if ( ! $last_payment ) {

[147] Fix | Delete

delete_option( self::SIGNATURE_OPTION );

[148] Fix | Delete

delete_option( self::ENDPOINT_OPTION );

[149] Fix | Delete

[150] Fix | Delete

return;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

// Signing secret is expired, try to reconnect.

[154] Fix | Delete

if (

[155] Fix | Delete

( get_option( self::SIGNATURE_OPTION, self::STATUS_OK ) !== self::STATUS_OK ) &&

[156] Fix | Delete

! $this->webhooks_manager->connect()

[157] Fix | Delete

) {

[158] Fix | Delete

return;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

// If a last Stripe payment has processed status and webhooks are not valid,

[162] Fix | Delete

// most likely there is issue with webhooks.

[163] Fix | Delete

if (

[164] Fix | Delete

$last_payment['status'] === 'processed' &&

[165] Fix | Delete

time() > strtotime( $last_payment['date_created_gmt'] ) + 15 * MINUTE_IN_SECONDS &&

[166] Fix | Delete

! $this->webhooks_manager->is_valid()

[167] Fix | Delete

) {

[168] Fix | Delete

self::save_status( self::ENDPOINT_OPTION, self::STATUS_ERROR );

[169] Fix | Delete

[170] Fix | Delete

return;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

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

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Determine whether there is Stripe payment.

[178] Fix | Delete

*

[179] Fix | Delete

* @since 1.8.4

[180] Fix | Delete

*

[181] Fix | Delete

* @return array

[182] Fix | Delete

*/

[183] Fix | Delete

private function get_last_stripe_payment(): array {

[184] Fix | Delete

[185] Fix | Delete

$payment = wpforms()->obj( 'payment' )->get_payments(

[186] Fix | Delete

[

[187] Fix | Delete

'gateway' => 'stripe',

[188] Fix | Delete

'mode' => 'any',

[189] Fix | Delete

'number' => 1,

[190] Fix | Delete

]

[191] Fix | Delete

);

[192] Fix | Delete

[193] Fix | Delete

return ! empty( $payment[0] ) ? $payment[0] : [];

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Display notice about issues with webhooks.

[198] Fix | Delete

*

[199] Fix | Delete

* @since 1.8.4

[200] Fix | Delete

*/

[201] Fix | Delete

public function admin_notice() {

[202] Fix | Delete

[203] Fix | Delete

// Bail out if Stripe account is not connected.

[204] Fix | Delete

if ( ! Helpers::has_stripe_keys() ) {

[205] Fix | Delete

return;

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

// Bail out if webhooks is not enabled.

[209] Fix | Delete

if ( ! Helpers::is_webhook_enabled() ) {

[210] Fix | Delete

return;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

// Bail out if webhooks is configured and active.

[214] Fix | Delete

if ( Helpers::is_webhook_configured() && $this->is_webhooks_active() ) {

[215] Fix | Delete

return;

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

// Bail out if there are no Stripe payments.

[219] Fix | Delete

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

[220] Fix | Delete

return;

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

$notice = sprintf(

[224] Fix | Delete

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

[225] Fix | Delete

__( 'Heads up! Looks like you have a problem with your webhooks configuration. Please check and confirm that you\'ve configured the WPForms webhooks in your Stripe account. This notice will disappear automatically when a new Stripe request comes in. See our <a href="%1$s" rel="nofollow noopener" target="_blank">documentation</a> for more information.', 'wpforms-lite' ),

[226] Fix | Delete

[

[227] Fix | Delete

'a' => [

[228] Fix | Delete

'href' => [],

[229] Fix | Delete

'target' => [],

[230] Fix | Delete

'rel' => [],

[231] Fix | Delete

],

[232] Fix | Delete

]

[233] Fix | Delete

),

[234] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setting-up-stripe-webhooks/', 'Admin', 'Stripe Webhooks not active' ) )

[235] Fix | Delete

);

[236] Fix | Delete

[237] Fix | Delete

Notice::error(

[238] Fix | Delete

$notice,

[239] Fix | Delete

[

[240] Fix | Delete

'dismiss' => true,

[241] Fix | Delete

'slug' => self::NOTICE_ID,

[242] Fix | Delete

]

[243] Fix | Delete

);

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Maybe perform updating of endpoint URL or register AS task in certain cases.

[248] Fix | Delete

*

[249] Fix | Delete

* @since 1.8.4

[250] Fix | Delete

*

[251] Fix | Delete

* @param array $settings An array of plugin settings.

[252] Fix | Delete

* @param bool $updated Whether an option was updated or not.

[253] Fix | Delete

* @param array $old_settings An old array of plugin settings.

[254] Fix | Delete

*/

[255] Fix | Delete

public function maybe_webhook_settings_is_updated( $settings, $updated, $old_settings ) {

[256] Fix | Delete

[257] Fix | Delete

// Bail out early if Webhooks is not enabled.

[258] Fix | Delete

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

[259] Fix | Delete

return;

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

// Bail out early if it's not Settings > Payments admin page.

[263] Fix | Delete

if (

[264] Fix | Delete

! isset( $_POST['nonce'] ) ||

[265] Fix | Delete

! wpforms_is_admin_page( 'settings', 'payments' ) ||

[266] Fix | Delete

! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['nonce'] ) ), 'wpforms-settings-nonce' )

[267] Fix | Delete

) {

[268] Fix | Delete

return;

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

// If Webhooks Method is changed, we have to update an endpoint's URL.

[272] Fix | Delete

if (

[273] Fix | Delete

! empty( $settings['stripe-webhooks-communication'] ) &&

[274] Fix | Delete

! empty( $old_settings['stripe-webhooks-communication'] ) &&

[275] Fix | Delete

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

[276] Fix | Delete

) {

[277] Fix | Delete

$this->webhooks_manager->update(

[278] Fix | Delete

$this->webhooks_manager->get_id(),

[279] Fix | Delete

[

[280] Fix | Delete

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

[281] Fix | Delete

'disabled' => false,

[282] Fix | Delete

]

[283] Fix | Delete

);

[284] Fix | Delete

[285] Fix | Delete

return;

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

$this->maybe_schedule_task();

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Determine whether webhooks is active.

[293] Fix | Delete

*

[294] Fix | Delete

* @since 1.8.4

[295] Fix | Delete

*

[296] Fix | Delete

* @return bool

[297] Fix | Delete

*/

[298] Fix | Delete

public function is_webhooks_active() {

[299] Fix | Delete

[300] Fix | Delete

if ( get_option( self::ENDPOINT_OPTION, self::STATUS_OK ) !== self::STATUS_OK ) {

[301] Fix | Delete

return false;

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

if ( get_option( self::SIGNATURE_OPTION, self::STATUS_OK ) !== self::STATUS_OK ) {

[305] Fix | Delete

return false;

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

return true;

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

/**

[312] Fix | Delete

* Save webhooks status.

[313] Fix | Delete

*

[314] Fix | Delete

* @since 1.8.4

[315] Fix | Delete

*

[316] Fix | Delete

* @param string $option Option name.

[317] Fix | Delete

* @param string $value Status value.

[318] Fix | Delete

*/

[319] Fix | Delete

public static function save_status( $option, $value ) {

[320] Fix | Delete

[321] Fix | Delete

if ( ! in_array( $value, [ self::STATUS_OK, self::STATUS_ERROR ], true ) ) {

[322] Fix | Delete

return;

[323] Fix | Delete

}

[324] Fix | Delete

[325] Fix | Delete

update_option( $option, $value );

[326] Fix | Delete

}

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete