<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Square;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Notice;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Webhooks Health Check class.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.9.5

[9] Fix | Delete

*/

[10] Fix | Delete

class WebhooksHealthCheck {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Endpoint status option name.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.9.5

[16] Fix | Delete

*/

[17] Fix | Delete

public const ENDPOINT_OPTION = 'wpforms_square_webhooks_endpoint_status';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Signature verified key.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.9.5

[23] Fix | Delete

*/

[24] Fix | Delete

public const STATUS_OK = 'ok';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Signature error key.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 1.9.5

[30] Fix | Delete

*/

[31] Fix | Delete

private const STATUS_ERROR = 'error';

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* AS task name.

[35] Fix | Delete

*

[36] Fix | Delete

* @since 1.9.5

[37] Fix | Delete

*/

[38] Fix | Delete

private const ACTION = 'wpforms_square_webhooks_health_check';

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Admin notice ID.

[42] Fix | Delete

*

[43] Fix | Delete

* @since 1.9.5

[44] Fix | Delete

*/

[45] Fix | Delete

private const NOTICE_ID = 'wpforms_square_webhooks_site_health';

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Initialization.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.9.5

[51] Fix | Delete

*/

[52] Fix | Delete

public function init() {

[53] Fix | Delete

[54] Fix | Delete

$this->hooks();

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Register hooks.

[59] Fix | Delete

*

[60] Fix | Delete

* @since 1.9.5

[61] Fix | Delete

*/

[62] Fix | Delete

private function hooks() {

[63] Fix | Delete

[64] Fix | Delete

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

[65] Fix | Delete

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

[66] Fix | Delete

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

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Schedule webhook health check.

[71] Fix | Delete

*

[72] Fix | Delete

* @since 1.9.5

[73] Fix | Delete

*/

[74] Fix | Delete

public function maybe_schedule_task() {

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Allow customers to disable a webhook health check task.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 1.9.5

[80] Fix | Delete

*

[81] Fix | Delete

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

[82] Fix | Delete

*/

[83] Fix | Delete

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

[84] Fix | Delete

[85] Fix | Delete

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

[86] Fix | Delete

[87] Fix | Delete

// Bail early in some instances.

[88] Fix | Delete

if (

[89] Fix | Delete

$is_canceled ||

[90] Fix | Delete

$tasks === null ||

[91] Fix | Delete

! Helpers::is_square_configured() ||

[92] Fix | Delete

$tasks->is_scheduled( self::ACTION )

[93] Fix | Delete

) {

[94] Fix | Delete

return;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Filters the webhook health check interval.

[99] Fix | Delete

*

[100] Fix | Delete

* @since 1.9.5

[101] Fix | Delete

*

[102] Fix | Delete

* @param int $interval Interval in seconds.

[103] Fix | Delete

*/

[104] Fix | Delete

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

[105] Fix | Delete

[106] Fix | Delete

$tasks->create( self::ACTION )

[107] Fix | Delete

->recurring( time(), $interval )

[108] Fix | Delete

->register();

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Process webhook status.

[113] Fix | Delete

*

[114] Fix | Delete

* @since 1.9.5

[115] Fix | Delete

*/

[116] Fix | Delete

public function process_webhooks_status_action() {

[117] Fix | Delete

[118] Fix | Delete

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

[119] Fix | Delete

if ( ! Helpers::is_webhook_enabled() ) {

[120] Fix | Delete

return;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

$last_payment = $this->get_last_square_payment();

[124] Fix | Delete

[125] Fix | Delete

// Bail out if there is no Square payment,

[126] Fix | Delete

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

[127] Fix | Delete

if ( ! $last_payment ) {

[128] Fix | Delete

delete_option( self::ENDPOINT_OPTION );

[129] Fix | Delete

[130] Fix | Delete

return;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

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

[134] Fix | Delete

// most likely there is an issue with webhooks.

[135] Fix | Delete

if (

[136] Fix | Delete

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

[137] Fix | Delete

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

[138] Fix | Delete

) {

[139] Fix | Delete

Helpers::reset_webhook_configuration();

[140] Fix | Delete

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

[141] Fix | Delete

[142] Fix | Delete

return;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

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

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Determine whether there is Square payment.

[150] Fix | Delete

*

[151] Fix | Delete

* @since 1.9.5

[152] Fix | Delete

*

[153] Fix | Delete

* @return array

[154] Fix | Delete

*/

[155] Fix | Delete

private function get_last_square_payment(): array {

[156] Fix | Delete

[157] Fix | Delete

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

[158] Fix | Delete

[

[159] Fix | Delete

'gateway' => 'square',

[160] Fix | Delete

'mode' => 'any',

[161] Fix | Delete

'number' => 1,

[162] Fix | Delete

]

[163] Fix | Delete

);

[164] Fix | Delete

[165] Fix | Delete

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

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Display notice about issues with webhooks.

[170] Fix | Delete

*

[171] Fix | Delete

* @since 1.9.5

[172] Fix | Delete

*/

[173] Fix | Delete

public function admin_notice() {

[174] Fix | Delete

[175] Fix | Delete

// Bail out if a Square account is not connected.

[176] Fix | Delete

if ( ! Helpers::is_square_configured() ) {

[177] Fix | Delete

return;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

// Bail out if webhooks are not enabled.

[181] Fix | Delete

if ( ! Helpers::is_webhook_enabled() ) {

[182] Fix | Delete

return;

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

// Bail out if webhooks are configured and active.

[186] Fix | Delete

if ( Helpers::is_webhook_configured() ) {

[187] Fix | Delete

return;

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

// Show notice only in case if ENDPOINT_OPTION has error status.

[191] Fix | Delete

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

[192] Fix | Delete

return;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

// Bail out if there are no Square payments.

[196] Fix | Delete

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

[197] Fix | Delete

return;

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

$notice = sprintf(

[201] Fix | Delete

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

[202] Fix | Delete

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

[203] Fix | Delete

[

[204] Fix | Delete

'a' => [

[205] Fix | Delete

'href' => [],

[206] Fix | Delete

'target' => [],

[207] Fix | Delete

'rel' => [],

[208] Fix | Delete

],

[209] Fix | Delete

]

[210] Fix | Delete

),

[211] Fix | Delete

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

[212] Fix | Delete

);

[213] Fix | Delete

[214] Fix | Delete

Notice::error(

[215] Fix | Delete

$notice,

[216] Fix | Delete

[

[217] Fix | Delete

'dismiss' => true,

[218] Fix | Delete

'slug' => self::NOTICE_ID,

[219] Fix | Delete

]

[220] Fix | Delete

);

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Save webhooks status.

[225] Fix | Delete

*

[226] Fix | Delete

* @since 1.9.5

[227] Fix | Delete

*

[228] Fix | Delete

* @param string $option Option name.

[229] Fix | Delete

* @param string $value Status value.

[230] Fix | Delete

*/

[231] Fix | Delete

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

[232] Fix | Delete

[233] Fix | Delete

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

[234] Fix | Delete

return;

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

update_option( $option, $value );

[238] Fix | Delete

}

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete