Actions
4 years ago
DataTransferObjects
4 years ago
Exceptions
4 years ago
Migrations
4 years ago
Models
3 years ago
PayPalCheckoutSdk
3 years ago
Repositories
3 years ago
Webhooks
4 years ago
AccountAdminNotices.php
4 years ago
AdminSettingFields.php
3 years ago
AdvancedCardFields.php
4 years ago
AjaxRequestHandler.php
3 years ago
DonationDetailsPage.php
4 years ago
DonationFormPaymentMethod.php
4 years ago
PayPalClient.php
3 years ago
PayPalCommerce.php
3 years ago
RefreshToken.php
3 years ago
RefundPaymentHandler.php
4 years ago
ScriptLoader.php
4 years ago
Utils.php
4 years ago
onBoardingRedirectHandler.php
3 years ago
RefreshToken.php
147 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 | |
| 11 | /** |
| 12 | * Class RefreshToken |
| 13 | * |
| 14 | * @since 2.9.0 |
| 15 | */ |
| 16 | class RefreshToken |
| 17 | { |
| 18 | /* @var MerchantDetail */ |
| 19 | private $merchantDetail; |
| 20 | |
| 21 | /** |
| 22 | * @since 2.9.0 |
| 23 | * |
| 24 | * @var MerchantDetails |
| 25 | */ |
| 26 | private $detailsRepository; |
| 27 | |
| 28 | /** |
| 29 | * @since 2.9.0 |
| 30 | * |
| 31 | * @var PayPalAuth |
| 32 | */ |
| 33 | private $payPalAuth; |
| 34 | |
| 35 | /** |
| 36 | * This time reduced from token expiration time to refresh token before it expires. |
| 37 | * |
| 38 | * @since 2.25.0 |
| 39 | * |
| 40 | * @var int $expirationTimeOffset Expiration time offset in seconds. |
| 41 | */ |
| 42 | private $expirationTimeOffset = 1800; // 30 minutes |
| 43 | |
| 44 | /** |
| 45 | * RefreshToken constructor. |
| 46 | * |
| 47 | * @since 2.9.0 |
| 48 | * @since 2.9.6 Add MerchantDetail constructor param. |
| 49 | * |
| 50 | * @param MerchantDetails $detailsRepository |
| 51 | * @param PayPalAuth $payPalAuth |
| 52 | * @param MerchantDetail $merchantDetail |
| 53 | */ |
| 54 | public function __construct( |
| 55 | MerchantDetails $detailsRepository, |
| 56 | PayPalAuth $payPalAuth, |
| 57 | MerchantDetail $merchantDetail |
| 58 | ) { |
| 59 | $this->detailsRepository = $detailsRepository; |
| 60 | $this->payPalAuth = $payPalAuth; |
| 61 | $this->merchantDetail = $merchantDetail; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Return cron json name which uses to refresh token. |
| 66 | * |
| 67 | * @since 2.9.0 |
| 68 | */ |
| 69 | private function getCronJobHookName(): string |
| 70 | { |
| 71 | return 'give_paypal_commerce_refresh_token'; |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Register cron job to refresh access token. |
| 76 | * Note: only for internal use. |
| 77 | * |
| 78 | * @since 2.9.0 |
| 79 | * |
| 80 | * @param string $tokenExpires |
| 81 | * |
| 82 | */ |
| 83 | public function registerCronJobToRefreshToken($tokenExpires) |
| 84 | { |
| 85 | // Refresh token before half hours of expires date. |
| 86 | wp_schedule_single_event( |
| 87 | time() + ($tokenExpires - $this->expirationTimeOffset), |
| 88 | $this->getCronJobHookName() |
| 89 | ); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Delete cron job which refresh access token. |
| 94 | * Note: only for internal use. |
| 95 | * |
| 96 | * @since 2.9.0 |
| 97 | * |
| 98 | */ |
| 99 | public function deleteRefreshTokenCronJob() |
| 100 | { |
| 101 | wp_clear_scheduled_hook($this->getCronJobHookName()); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Refresh token. |
| 106 | * Note: only for internal use |
| 107 | * |
| 108 | * @since 2.25.0 Handle exception. Refresh access token every 5 minute on faliure. |
| 109 | * @since 2.9.6 Refresh token only if paypal merchant id exist. |
| 110 | * @since 2.9.0 |
| 111 | */ |
| 112 | public function refreshToken() |
| 113 | { |
| 114 | // Exit if account is not connected. |
| 115 | if (! $this->detailsRepository->accountIsConnected()) { |
| 116 | return; |
| 117 | } |
| 118 | |
| 119 | // Default expiration date of access token. |
| 120 | // This is used when we are unable to get access token from PayPal. |
| 121 | $expiresIn = $this->expirationTimeOffset - 1500; // 5 minutes |
| 122 | |
| 123 | try { |
| 124 | $tokenDetails = $this->payPalAuth->getTokenFromClientCredentials( |
| 125 | $this->merchantDetail->clientId, |
| 126 | $this->merchantDetail->clientSecret |
| 127 | ); |
| 128 | |
| 129 | $this->merchantDetail->setTokenDetails($tokenDetails); |
| 130 | $this->detailsRepository->save($this->merchantDetail); |
| 131 | |
| 132 | $expiresIn = $tokenDetails['expiresIn']; |
| 133 | } catch (Exception $exception) { |
| 134 | give(Log::class)->warning( |
| 135 | 'PayPal Commerce: Error refresh access token', |
| 136 | [ |
| 137 | 'category' => 'Payment Gateway', |
| 138 | 'source' => 'Paypal Commerce', |
| 139 | 'exception' => $exception, |
| 140 | ] |
| 141 | ); |
| 142 | } |
| 143 | |
| 144 | $this->registerCronJobToRefreshToken($expiresIn); |
| 145 | } |
| 146 | } |
| 147 |