RefreshToken.php — GiveWP – Donation Plugin and Fundraising Platform 3.19.4

give / src / PaymentGateways / PayPalCommerce / RefreshToken.php

give / src / PaymentGateways / PayPalCommerce Last commit date

Banners 2 years ago DataTransferObjects 4 years ago Exceptions 3 years ago Migrations 2 years ago Models 2 years ago PayPalCheckoutSdk 2 years ago Repositories 2 years ago Webhooks 2 years ago AccountAdminNotices.php 4 years ago AdminSettingFields.php 1 year ago AdvancedCardFields.php 4 years ago AjaxRequestHandler.php 1 year ago DonationDetailsPage.php 4 years ago DonationFormPaymentMethod.php 2 years ago PayPalClient.php 2 years ago PayPalCommerce.php 2 years ago RefreshToken.php 2 years ago RefundPaymentHandler.php 4 years ago ScriptLoader.php 2 years ago Utils.php 2 years ago onBoardingRedirectHandler.php 1 year ago

RefreshToken.php

184 lines

1	<?php
2
3	namespace Give\PaymentGateways\PayPalCommerce;
4
5	use Give\Framework\Exceptions\Primitives\Exception;
6	use Give\Log\Log;
7	use Give\PaymentGateways\PayPalCommerce\Models\MerchantDetail;
8	use Give\PaymentGateways\PayPalCommerce\Repositories\MerchantDetails;
9	use Give\PaymentGateways\PayPalCommerce\Repositories\PayPalAuth;
10	use Give\PaymentGateways\PayPalCommerce\Repositories\Traits\HasMode;
11
12	/**
13	* Class RefreshToken
14	*
15	* @since 2.30.0 Add support for mode.
16	* @since 2.9.0
17	*/
18	class RefreshToken
19	{
20	use HasMode;
21
22	/* @var MerchantDetail */
23	private $merchantDetail;
24
25	/**
26	* @since 2.9.0
27	*
28	* @var MerchantDetails
29	*/
30	private $detailsRepository;
31
32	/**
33	* @since 2.9.0
34	*
35	* @var PayPalAuth
36	*/
37	private $payPalAuth;
38
39	/**
40	* This time reduced from token expiration time to refresh token before it expires.
41	*
42	* @since 2.25.0
43	*
44	* @var int $expirationTimeOffset Expiration time offset in seconds.
45	*/
46	private $expirationTimeOffset = 1800; // 30 minutes
47
48	/**
49	* RefreshToken constructor.
50	*
51	* @since 2.9.0
52	* @since 2.9.6 Add MerchantDetail constructor param.
53	*
54	* @param MerchantDetails $detailsRepository
55	* @param PayPalAuth $payPalAuth
56	* @param MerchantDetail $merchantDetail
57	*/
58	public function __construct(
59	MerchantDetails $detailsRepository,
60	PayPalAuth $payPalAuth,
61	MerchantDetail $merchantDetail
62	) {
63	$this->detailsRepository = $detailsRepository;
64	$this->payPalAuth = $payPalAuth;
65	$this->merchantDetail = $merchantDetail;
66
67	$this->setMode(give_is_test_mode() ? 'sandbox' : 'live');
68	}
69
70	/**
71	* Return cron json name which uses to refresh token.
72	*
73	* @since 2.9.0
74	*/
75	private function getCronJobHookName(): string
76	{
77	return "give_paypal_commerce_refresh_{$this->mode}_token";
78	}
79
80	/**
81	* Register cron job to refresh access token.
82	* Note: only for internal use.
83	*
84	* @since 2.9.0
85	*
86	* @param string $tokenExpires
87	*
88	*/
89	public function registerCronJobToRefreshToken($tokenExpires)
90	{
91	// Refresh token before half hours of expires date.
92	wp_schedule_single_event(
93	time() + ($tokenExpires - $this->expirationTimeOffset),
94	$this->getCronJobHookName()
95	);
96	}
97
98	/**
99	* Delete cron job which refresh access token.
100	* Note: only for internal use.
101	*
102	* @since 2.9.0
103	*
104	*/
105	public function deleteRefreshTokenCronJob()
106	{
107	wp_clear_scheduled_hook($this->getCronJobHookName());
108	}
109
110	/**
111	* Refresh token.
112	* Note: only for internal use
113	*
114	* @since 2.25.0 Handle exception. Refresh access token every 5 minute on faliure.
115	* @since 2.9.6 Refresh token only if paypal merchant id exist.
116	* @since 2.9.0
117	*/
118	public function refreshToken()
119	{
120	// Exit if account is not connected.
121	if (! $this->detailsRepository->accountIsConnected()) {
122	return;
123	}
124
125	// Default expiration date of access token.
126	// This is used when we are unable to get access token from PayPal.
127	$expiresIn = $this->expirationTimeOffset - 1500; // 5 minutes
128
129	try {
130	$tokenDetails = $this->payPalAuth->getTokenFromClientCredentials(
131	$this->merchantDetail->clientId,
132	$this->merchantDetail->clientSecret
133	);
134
135	$this->merchantDetail->setTokenDetails($tokenDetails);
136	$this->detailsRepository->save($this->merchantDetail);
137
138	$expiresIn = $tokenDetails['expiresIn'];
139	} catch (Exception $exception) {
140	give(Log::class)->warning(
141	'PayPal Commerce: Error refresh access token',
142	[
143	'category' => 'Payment Gateway',
144	'source' => 'Paypal Commerce',
145	'exception' => $exception,
146	]
147	);
148	}
149
150	$this->deleteRefreshTokenCronJob();
151	$this->registerCronJobToRefreshToken($expiresIn);
152	}
153
154	/**
155	* This function handles cron job to refresh access token.
156	*
157	* Cron job action names:
158	* - give_paypal_commerce_refresh_sandbox_token
159	* - give_paypal_commerce_refresh_live_token
160	*
161	* @since 2.30.0
162	* @return void
163	*/
164	public function cronJobRefreshToken()
165	{
166	// Set mode.
167	$mode = 'live';
168	if (doing_action('give_paypal_commerce_refresh_sandbox_token')) {
169	$mode = 'sandbox';
170	}
171	$this->setMode($mode);
172
173	// Fetch merchant details.
174	$this->detailsRepository->setMode($mode);
175	$this->merchantDetail = $this->detailsRepository->getDetails();
176
177	// Set mode to PayPalClient. PayPalAuth use it to make api request to paypal.
178	$paypalClient = give(PayPalClient::class);
179	$paypalClient->setMode($mode);
180
181	$this->refreshToken();
182	}
183	}
184