Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Tasks\Actions;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Integrations\Stripe\Api\PaymentIntents;

[4] Fix | Delete

use WPForms\Tasks\Task;

[5] Fix | Delete

use WPForms\Integrations\Stripe\Helpers;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Class StripeLinkSubscriptionsTask.

[9] Fix | Delete

[10] Fix | Delete

* @since 1.8.7

[11] Fix | Delete

[12] Fix | Delete

class StripeLinkSubscriptionsTask extends Task {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Action name for this task.

[16] Fix | Delete

[17] Fix | Delete

* @since 1.8.7

[18] Fix | Delete

[19] Fix | Delete

const ACTION = 'wpforms_process_stripe_link_subscriptions';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Status option name.

[23] Fix | Delete

[24] Fix | Delete

* @since 1.8.7

[25] Fix | Delete

[26] Fix | Delete

const STATUS = 'wpforms_process_stripe_link_subscriptions_status';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Start status.

[30] Fix | Delete

[31] Fix | Delete

* @since 1.8.7

[32] Fix | Delete

[33] Fix | Delete

const START = 'start';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* In progress status.

[37] Fix | Delete

[38] Fix | Delete

* @since 1.8.7

[39] Fix | Delete

[40] Fix | Delete

const IN_PROGRESS = 'in_progress';

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Completed status.

[44] Fix | Delete

[45] Fix | Delete

* @since 1.8.7

[46] Fix | Delete

[47] Fix | Delete

const COMPLETED = 'completed';

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Latest processed payment id.

[51] Fix | Delete

[52] Fix | Delete

* @since 1.8.7

[53] Fix | Delete

[54] Fix | Delete

const LATEST_PROCESSED_OPTION = 'wpforms_stripe_link_subscriptions_latest_processed';

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Stripe PaymentIntents API.

[58] Fix | Delete

[59] Fix | Delete

* @since 1.8.7

[60] Fix | Delete

[61] Fix | Delete

* @var PaymentIntents

[62] Fix | Delete

[63] Fix | Delete

private $api;

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Class constructor.

[67] Fix | Delete

[68] Fix | Delete

* @since 1.8.7

[69] Fix | Delete

[70] Fix | Delete

public function __construct() {

[71] Fix | Delete

[72] Fix | Delete

parent::__construct( self::ACTION );

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Initialize the task.

[77] Fix | Delete

[78] Fix | Delete

* @since 1.8.7

[79] Fix | Delete

[80] Fix | Delete

public function init() {

[81] Fix | Delete

[82] Fix | Delete

// Get a task status.

[83] Fix | Delete

$status = get_option( self::STATUS );

[84] Fix | Delete

[85] Fix | Delete

// This task is run in \WPForms\Migrations\Upgrade187::run(),

[86] Fix | Delete

// and started in \WPForms\Migrations\UpgradeBase::run_async().

[87] Fix | Delete

// Bail out if a task is not started or completed.

[88] Fix | Delete

if ( ! $status || $status === self::COMPLETED ) {

[89] Fix | Delete

return;

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

// Mark that the task is in progress.

[93] Fix | Delete

if ( $status === self::START ) {

[94] Fix | Delete

update_option( self::STATUS, self::IN_PROGRESS );

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

// Register hooks.

[98] Fix | Delete

$this->hooks();

[99] Fix | Delete

[100] Fix | Delete

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

[101] Fix | Delete

[102] Fix | Delete

// Add new if none exists.

[103] Fix | Delete

if ( $tasks->is_scheduled( self::ACTION ) !== false ) {

[104] Fix | Delete

return;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

// Add a new task if none exists.

[108] Fix | Delete

$tasks->create( self::ACTION )

[109] Fix | Delete

->async()

[110] Fix | Delete

->register();

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Register hooks.

[115] Fix | Delete

[116] Fix | Delete

* @since 1.8.7

[117] Fix | Delete

[118] Fix | Delete

private function hooks() {

[119] Fix | Delete

[120] Fix | Delete

// Register the migrate action.

[121] Fix | Delete

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

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Run a process task.

[126] Fix | Delete

[127] Fix | Delete

* @since 1.8.7

[128] Fix | Delete

[129] Fix | Delete

public function run() {

[130] Fix | Delete

[131] Fix | Delete

// Bail if no Stripe account is connected.

[132] Fix | Delete

if ( ! Helpers::has_stripe_keys() ) {

[133] Fix | Delete

$this->complete();

[134] Fix | Delete

[135] Fix | Delete

return;

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

$link_subscriptions = $this->get_link_subscriptions();

[139] Fix | Delete

[140] Fix | Delete

// Bail if all subscription were processed.

[141] Fix | Delete

if ( empty( $link_subscriptions ) ) {

[142] Fix | Delete

$this->complete();

[143] Fix | Delete

[144] Fix | Delete

return;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

$this->api = new PaymentIntents();

[148] Fix | Delete

[149] Fix | Delete

$this->process( $link_subscriptions );

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Process subscriptions.

[154] Fix | Delete

[155] Fix | Delete

* @since 1.8.7

[156] Fix | Delete

[157] Fix | Delete

* @param array $subscriptions Array of subscriptions.

[158] Fix | Delete

[159] Fix | Delete

private function process( array $subscriptions ) {

[160] Fix | Delete

[161] Fix | Delete

foreach ( $subscriptions as $subscription ) {

[162] Fix | Delete

[163] Fix | Delete

$this->update_latest_processed( $subscription->id );

[164] Fix | Delete

[165] Fix | Delete

// Use subscription mode to cover all cases (e.g. mode might be switched to test while upgrading).

[166] Fix | Delete

$payment = $this->api->retrieve_payment_intent( $subscription->transaction_id, [ 'mode' => $subscription->mode ] );

[167] Fix | Delete

[168] Fix | Delete

// Bail if original payment was unsuccessful.

[169] Fix | Delete

if ( is_null( $payment ) || empty( $payment->status ) || $payment->status !== 'succeeded' ) {

[170] Fix | Delete

continue;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

$setup_intent_data = $this->prepare_setup_intent_data( $payment, $subscription );

[174] Fix | Delete

[175] Fix | Delete

// Bail if subscription has already had correct mandate.

[176] Fix | Delete

if ( ! $setup_intent_data ) {

[177] Fix | Delete

continue;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

$intent = $this->api->create_setup_intent( $setup_intent_data, [ 'mode' => $subscription->mode ] );

[181] Fix | Delete

[182] Fix | Delete

// Log failed subscription payment id.

[183] Fix | Delete

if ( empty( $intent ) ) {

[184] Fix | Delete

$this->log( 'Failed ' . $subscription->id );

[185] Fix | Delete

}

[186] Fix | Delete

}

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Update latest processed id.

[191] Fix | Delete

[192] Fix | Delete

* @since 1.8.7

[193] Fix | Delete

[194] Fix | Delete

* @param int $id Subscription ID.

[195] Fix | Delete

[196] Fix | Delete

private function update_latest_processed( int $id ) {

[197] Fix | Delete

[198] Fix | Delete

update_option( self::LATEST_PROCESSED_OPTION, $id );

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Get all Stripe subscriptions charged through Link.

[203] Fix | Delete

[204] Fix | Delete

* @since 1.8.7

[205] Fix | Delete

[206] Fix | Delete

* @return array

[207] Fix | Delete

[208] Fix | Delete

private function get_link_subscriptions(): array {

[209] Fix | Delete

[210] Fix | Delete

global $wpdb;

[211] Fix | Delete

[212] Fix | Delete

$latest_payment = (int) get_option( self::LATEST_PROCESSED_OPTION, 0 );

[213] Fix | Delete

$payments_table = wpforms()->get( 'payment' )->table_name;

[214] Fix | Delete

$paymentmeta_table = wpforms()->get( 'payment_meta' )->table_name;

[215] Fix | Delete

[216] Fix | Delete

$query[] = "SELECT p.* FROM {$payments_table} as p";

[217] Fix | Delete

$query[] = "INNER JOIN {$paymentmeta_table} as pm ON p.id = pm.payment_id";

[218] Fix | Delete

$query[] = "WHERE p.id > %d AND p.gateway = 'stripe' AND p.type = 'subscription' AND pm.meta_key = 'method_type' AND pm.meta_value = 'link'";

[219] Fix | Delete

[220] Fix | Delete

// Stripe API allows up to 100 read operations per second and 100 write operations per second in live mode,

[221] Fix | Delete

// and 25 operations per second for each in test mode.

[222] Fix | Delete

$query[] = 'ORDER BY p.id LIMIT 20';

[223] Fix | Delete

[224] Fix | Delete

// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare

[225] Fix | Delete

return $wpdb->get_results( $wpdb->prepare( implode( ' ', $query ), $latest_payment ), OBJECT_K );

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Prepare Setup Intent data.

[230] Fix | Delete

[231] Fix | Delete

* @since 1.8.7

[232] Fix | Delete

[233] Fix | Delete

* @param object $payment Stripe payment object.

[234] Fix | Delete

* @param object $subscription Subscription object.

[235] Fix | Delete

[236] Fix | Delete

* @return array

[237] Fix | Delete

[238] Fix | Delete

private function prepare_setup_intent_data( $payment, $subscription ): array {

[239] Fix | Delete

[240] Fix | Delete

if ( ! empty( $payment->mandate ) ) {

[241] Fix | Delete

$mandate = $this->api->retrieve_mandate( $payment->mandate, [ 'mode' => $subscription->mode ] );

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

$data = [

[245] Fix | Delete

'payment_method_types' => [ 'link' ],

[246] Fix | Delete

'customer' => $payment->customer,

[247] Fix | Delete

'payment_method' => $payment->payment_method,

[248] Fix | Delete

'usage' => 'off_session',

[249] Fix | Delete

'confirm' => true,

[250] Fix | Delete

];

[251] Fix | Delete

[252] Fix | Delete

// Prepare default data in case mandate is not available.

[253] Fix | Delete

if ( empty( $mandate ) ) {

[254] Fix | Delete

[255] Fix | Delete

$subscription_meta = wpforms()->get( 'payment_meta' )->get_all( $subscription->id );

[256] Fix | Delete

[257] Fix | Delete

$data['mandate_data'] = [

[258] Fix | Delete

'customer_acceptance' => [

[259] Fix | Delete

'type' => 'online',

[260] Fix | Delete

'online' => [

[261] Fix | Delete

'ip_address' => $subscription_meta['ip_address']->value,

[262] Fix | Delete

'user_agent' => $subscription_meta['user_agent']->value,

[263] Fix | Delete

[264] Fix | Delete

[265] Fix | Delete

];

[266] Fix | Delete

[267] Fix | Delete

return $data;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

// Mandate is correct so no actions needed.

[271] Fix | Delete

if ( $mandate->type !== 'single_use' ) {

[272] Fix | Delete

return [];

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

$data['mandate_data'] = [

[276] Fix | Delete

'customer_acceptance' => [

[277] Fix | Delete

'type' => 'online',

[278] Fix | Delete

'online' => [

[279] Fix | Delete

'ip_address' => $mandate->customer_acceptance->online->ip_address,

[280] Fix | Delete

'user_agent' => $mandate->customer_acceptance->online->user_agent,

[281] Fix | Delete

[282] Fix | Delete

[283] Fix | Delete

];

[284] Fix | Delete

[285] Fix | Delete

return $data;

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

/**

[289] Fix | Delete

* Mark that the task is completed.

[290] Fix | Delete

[291] Fix | Delete

* @since 1.8.7

[292] Fix | Delete

[293] Fix | Delete

public function complete() {

[294] Fix | Delete

[295] Fix | Delete

$this->log( 'Completed' );

[296] Fix | Delete

[297] Fix | Delete

update_option( self::STATUS, self::COMPLETED );

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

/**

[301] Fix | Delete

* Log message.

[302] Fix | Delete

[303] Fix | Delete

* @since 1.8.7

[304] Fix | Delete

[305] Fix | Delete

* @param string $message Message to log.

[306] Fix | Delete

[307] Fix | Delete

private function log( string $message ) {

[308] Fix | Delete

[309] Fix | Delete

wpforms_log( 'Migration', 'Stripe Link Subscriptions: ' . $message, [ 'type' => 'log' ] );

[310] Fix | Delete

}

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete