Banners
2 years ago
DataTransferObjects
4 years ago
Exceptions
3 years ago
Migrations
3 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
2 years ago
AdvancedCardFields.php
4 years ago
AjaxRequestHandler.php
2 years ago
DonationDetailsPage.php
4 years ago
DonationFormPaymentMethod.php
2 years ago
PayPalClient.php
2 years ago
PayPalCommerce.php
2 years ago
RefreshToken.php
3 years ago
RefundPaymentHandler.php
4 years ago
ScriptLoader.php
2 years ago
Utils.php
2 years ago
onBoardingRedirectHandler.php
2 years ago
onBoardingRedirectHandler.php
521 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\PayPalCommerce; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Framework\Exceptions\Primitives\Exception as GiveException; |
| 7 | use Give\Log\Log; |
| 8 | use Give\PaymentGateways\PayPalCommerce\Models\MerchantDetail; |
| 9 | use Give\PaymentGateways\PayPalCommerce\Repositories\MerchantDetails; |
| 10 | use Give\PaymentGateways\PayPalCommerce\Repositories\PayPalAuth; |
| 11 | use Give\PaymentGateways\PayPalCommerce\Repositories\Settings; |
| 12 | use Give\PaymentGateways\PayPalCommerce\Repositories\Webhooks; |
| 13 | use Give_Admin_Settings; |
| 14 | |
| 15 | /** |
| 16 | * Class PayPalOnBoardingRedirectHandler |
| 17 | * @package Give\PaymentGateways\PayPalCommerce |
| 18 | * |
| 19 | * @since 2.9.0 |
| 20 | */ |
| 21 | class onBoardingRedirectHandler |
| 22 | { |
| 23 | /** |
| 24 | * @since 2.9.0 |
| 25 | * |
| 26 | * @var PayPalAuth |
| 27 | */ |
| 28 | private $payPalAuth; |
| 29 | |
| 30 | /** |
| 31 | * @since 2.9.0 |
| 32 | * |
| 33 | * @var Webhooks |
| 34 | */ |
| 35 | private $webhooksRepository; |
| 36 | |
| 37 | /** |
| 38 | * @since 2.9.0 |
| 39 | * |
| 40 | * @var MerchantDetails |
| 41 | */ |
| 42 | private $merchantRepository; |
| 43 | |
| 44 | /** |
| 45 | * @since 2.9.0 |
| 46 | * |
| 47 | * @var Settings |
| 48 | */ |
| 49 | private $settings; |
| 50 | |
| 51 | /** |
| 52 | * onBoardingRedirectHandler constructor. |
| 53 | * |
| 54 | * @since 2.9.0 |
| 55 | * |
| 56 | * @param Webhooks $webhooks |
| 57 | * @param MerchantDetails $merchantRepository |
| 58 | * @param Settings $settings |
| 59 | * @param PayPalAuth $payPalAuth |
| 60 | */ |
| 61 | public function __construct( |
| 62 | Webhooks $webhooks, |
| 63 | MerchantDetails $merchantRepository, |
| 64 | Settings $settings, |
| 65 | PayPalAuth $payPalAuth |
| 66 | ) { |
| 67 | $this->webhooksRepository = $webhooks; |
| 68 | $this->merchantRepository = $merchantRepository; |
| 69 | $this->settings = $settings; |
| 70 | $this->payPalAuth = $payPalAuth; |
| 71 | |
| 72 | $this->setModeFromRequest(); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * This function set mode from request. |
| 77 | * |
| 78 | * @since 2.30.0 |
| 79 | * @return void |
| 80 | */ |
| 81 | private function setModeFromRequest() |
| 82 | { |
| 83 | if (isset($_GET['mode']) && in_array($_GET['mode'], ['live', 'sandbox'], true)) { |
| 84 | $mode = $_GET['mode']; |
| 85 | |
| 86 | $this->setModeForServices($mode); |
| 87 | } |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Set mode for services. |
| 92 | * |
| 93 | * Use this function to manually set connection mode. Values can be 'live' or 'sandbox'. |
| 94 | * Services are classes which depends upon connection mode and used to interact with PayPal API or core logic. |
| 95 | * |
| 96 | * @since 3.0.0 |
| 97 | * |
| 98 | * @return void |
| 99 | */ |
| 100 | public function setModeForServices(string $mode) |
| 101 | { |
| 102 | $this->webhooksRepository->setMode($mode); |
| 103 | $this->merchantRepository->setMode($mode); |
| 104 | give(PayPalClient::class)->setMode($mode); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Bootstrap class |
| 109 | * |
| 110 | * @since 2.9.0 |
| 111 | */ |
| 112 | public function boot() |
| 113 | { |
| 114 | if ($this->isPayPalUserRedirected()) { |
| 115 | $details = $this->savePayPalMerchantDetails(); |
| 116 | $this->setUpWebhook($details); |
| 117 | $this->redirectAccountConnected(); |
| 118 | } |
| 119 | |
| 120 | if ($this->isPayPalAccountDetailsSaved()) { |
| 121 | $this->registerPayPalSSLNotice(); |
| 122 | $this->registerPayPalAccountConnectedNotice(); |
| 123 | } |
| 124 | |
| 125 | if ($this->isStatusRefresh()) { |
| 126 | $this->refreshAccountStatus(); |
| 127 | } |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Save PayPal merchant details |
| 132 | * |
| 133 | * @since 2.32.0 Remove second argument from updateSellerAccessToken function. |
| 134 | * @since 2.25.0 Handle exception. |
| 135 | * @since 2.9.0 |
| 136 | * |
| 137 | * @return MerchantDetail |
| 138 | */ |
| 139 | private function savePayPalMerchantDetails() |
| 140 | { |
| 141 | $paypalGetData = wp_parse_args($_SERVER['QUERY_STRING']); |
| 142 | $partnerLinkInfo = $this->settings->getPartnerLinkDetails(); |
| 143 | $tokenInfo = $this->settings->getAccessToken(); |
| 144 | |
| 145 | $allowedPayPalData = [ |
| 146 | 'merchantId', |
| 147 | 'merchantIdInPayPal', |
| 148 | ]; |
| 149 | |
| 150 | $payPalAccount = array_intersect_key($paypalGetData, array_flip($allowedPayPalData)); |
| 151 | |
| 152 | if (! array_key_exists('merchantIdInPayPal', $payPalAccount) || empty($payPalAccount['merchantIdInPayPal'])) { |
| 153 | $errors[] = [ |
| 154 | 'type' => 'url', |
| 155 | 'message' => esc_html__( |
| 156 | 'The Merchant ID for PayPal was not found. Try connecting to PayPal again. The PayPal return URL is:', |
| 157 | 'give' |
| 158 | ) . "\n", |
| 159 | 'value' => urlencode($_SERVER['QUERY_STRING']), |
| 160 | ]; |
| 161 | |
| 162 | $this->merchantRepository->saveAccountErrors($errors); |
| 163 | $this->redirectWhenOnBoardingFail(); |
| 164 | } |
| 165 | |
| 166 | $restApiCredentials = (array)$this->payPalAuth->getSellerRestAPICredentials( |
| 167 | $tokenInfo ? $tokenInfo['accessToken'] : '' |
| 168 | ); |
| 169 | $this->didWeGetValidSellerRestApiCredentials($restApiCredentials); |
| 170 | |
| 171 | try { |
| 172 | $tokenInfo = $this->payPalAuth->getTokenFromClientCredentials( |
| 173 | $restApiCredentials['client_id'], |
| 174 | $restApiCredentials['client_secret'] |
| 175 | ); |
| 176 | } catch (GiveException $e) { |
| 177 | give(Log::class)->warning( |
| 178 | 'PayPal Commerce: Error retrieving access token on boarding redirect.', |
| 179 | [ |
| 180 | 'category' => 'Payment Gateway', |
| 181 | 'source' => 'Paypal Commerce', |
| 182 | 'exception' => $e, |
| 183 | ] |
| 184 | ); |
| 185 | |
| 186 | $errors[] = esc_html__( |
| 187 | 'There was a problem with retrieving PayPal access token. Please try again or contact support.', |
| 188 | 'give' |
| 189 | ); |
| 190 | |
| 191 | $this->merchantRepository->saveAccountErrors($errors); |
| 192 | $this->redirectWhenOnBoardingFail(); |
| 193 | } |
| 194 | |
| 195 | $payPalAccount['clientId'] = $restApiCredentials['client_id']; |
| 196 | $payPalAccount['clientSecret'] = $restApiCredentials['client_secret']; |
| 197 | $payPalAccount['token'] = $tokenInfo; |
| 198 | $payPalAccount['supportsCustomPayments'] = 'PPCP' === $partnerLinkInfo['product']; |
| 199 | $payPalAccount['accountIsReady'] = true; |
| 200 | $payPalAccount['accountCountry'] = $this->settings->getAccountCountry(); |
| 201 | |
| 202 | $merchantDetails = MerchantDetail::fromArray($payPalAccount); |
| 203 | $this->merchantRepository->save($merchantDetails); |
| 204 | |
| 205 | // Preserve the seller access token. |
| 206 | // This is required to get the merchant rest api credentials. |
| 207 | $this->settings->updateSellerAccessToken($this->settings->getAccessToken()); |
| 208 | |
| 209 | $this->deleteTempOptions(); |
| 210 | |
| 211 | return $merchantDetails; |
| 212 | } |
| 213 | |
| 214 | /** |
| 215 | * Redirects the user to the account connected url |
| 216 | * |
| 217 | * @since 2.9.0 |
| 218 | */ |
| 219 | private function redirectAccountConnected() |
| 220 | { |
| 221 | $this->refreshAccountStatus(); |
| 222 | |
| 223 | wp_redirect( |
| 224 | add_query_arg( |
| 225 | [ |
| 226 | 'post_type' => 'give_forms', |
| 227 | 'page' => 'give-settings', |
| 228 | 'tab' => 'gateways', |
| 229 | 'section' => 'paypal', |
| 230 | 'group' => 'paypal-commerce', |
| 231 | 'paypal-commerce-account-connected' => '1' |
| 232 | ], |
| 233 | admin_url('edit.php') |
| 234 | ) |
| 235 | ); |
| 236 | |
| 237 | exit(); |
| 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Sets up the webhook for the connected account |
| 242 | * |
| 243 | * @since 2.32.0 Remove second argument from createWebhook function. |
| 244 | * @since 2.9.0 |
| 245 | * |
| 246 | * @param MerchantDetail $merchant_details |
| 247 | */ |
| 248 | private function setUpWebhook(MerchantDetail $merchant_details) |
| 249 | { |
| 250 | if (! is_ssl()) { |
| 251 | return; |
| 252 | } |
| 253 | |
| 254 | try { |
| 255 | $webhookConfig = $this->webhooksRepository->createWebhook(); |
| 256 | $this->webhooksRepository->saveWebhookConfig($webhookConfig); |
| 257 | } catch (Exception $ex) { |
| 258 | $errors[] = esc_html__( |
| 259 | 'There was a problem with creating webhook on PayPal. A gateway error log also added to get details information about PayPal response.', |
| 260 | 'give' |
| 261 | ); |
| 262 | |
| 263 | $this->merchantRepository->saveAccountErrors($errors); |
| 264 | $this->redirectWhenOnBoardingFail(); |
| 265 | } |
| 266 | } |
| 267 | |
| 268 | /** |
| 269 | * Delete temp data |
| 270 | * |
| 271 | * @since 2.9.0 |
| 272 | * @return void |
| 273 | */ |
| 274 | private function deleteTempOptions() |
| 275 | { |
| 276 | $this->settings->deletePartnerLinkDetails(); |
| 277 | $this->settings->deleteAccessToken(); |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Register notice if account connect success fully. |
| 282 | * |
| 283 | * @since 2.9.0 |
| 284 | */ |
| 285 | private function registerPayPalAccountConnectedNotice() |
| 286 | { |
| 287 | Give_Admin_Settings::add_message( |
| 288 | 'paypal-commerce-account-connected', |
| 289 | esc_html__('PayPal account connected successfully.', 'give') |
| 290 | ); |
| 291 | } |
| 292 | |
| 293 | /** |
| 294 | * Returns whether or not the current request is for refreshing the account status |
| 295 | * |
| 296 | * @since 2.9.0 |
| 297 | * |
| 298 | * @return bool |
| 299 | */ |
| 300 | private function isStatusRefresh() |
| 301 | { |
| 302 | return isset($_GET['paypalStatusCheck']) && Give_Admin_Settings::is_setting_page('gateways', 'paypal'); |
| 303 | } |
| 304 | |
| 305 | /** |
| 306 | * Return whether or not PayPal user redirect to GiveWP setting page after successful onboarding. |
| 307 | * |
| 308 | * @since 2.9.0 |
| 309 | * |
| 310 | * @return bool |
| 311 | */ |
| 312 | private function isPayPalUserRedirected() |
| 313 | { |
| 314 | return isset($_GET['merchantIdInPayPal']) && Give_Admin_Settings::is_setting_page('gateways', 'paypal'); |
| 315 | } |
| 316 | |
| 317 | /** |
| 318 | * Return whether or not PayPal account details saved. |
| 319 | * |
| 320 | * @since 2.9.0 |
| 321 | * |
| 322 | * @return bool |
| 323 | */ |
| 324 | private function isPayPalAccountDetailsSaved() |
| 325 | { |
| 326 | return isset($_GET['paypal-commerce-account-connected']) && Give_Admin_Settings::is_setting_page( |
| 327 | 'gateways', |
| 328 | 'paypal' |
| 329 | ); |
| 330 | } |
| 331 | |
| 332 | /** |
| 333 | * validate rest api credential. |
| 334 | * |
| 335 | * @since 2.9.0 |
| 336 | * |
| 337 | * @param array $array |
| 338 | * |
| 339 | */ |
| 340 | private function didWeGetValidSellerRestApiCredentials($array) |
| 341 | { |
| 342 | $required = ['client_id', 'client_secret']; |
| 343 | $array = array_filter($array); // Remove empty values. |
| 344 | |
| 345 | if (array_diff($required, array_keys($array))) { |
| 346 | $errors[] = [ |
| 347 | 'type' => 'json', |
| 348 | 'message' => esc_html__('PayPal client access token API request response is:', 'give'), |
| 349 | 'value' => wp_json_encode($this->settings->getAccessToken()), |
| 350 | ]; |
| 351 | |
| 352 | $errors[] = [ |
| 353 | 'type' => 'json', |
| 354 | 'message' => esc_html__('PayPal client rest api credentials API request response is:', 'give'), |
| 355 | 'value' => wp_json_encode($array), |
| 356 | ]; |
| 357 | |
| 358 | $errors[] = esc_html__( |
| 359 | 'There was a problem with PayPal client rest API request and we could not find valid client id and secret.', |
| 360 | 'give' |
| 361 | ); |
| 362 | |
| 363 | $this->merchantRepository->saveAccountErrors($errors); |
| 364 | $this->redirectWhenOnBoardingFail(); |
| 365 | } |
| 366 | } |
| 367 | |
| 368 | /** |
| 369 | * Handles the request for refreshing the account status |
| 370 | * |
| 371 | * @since 3.0.0 Make function publicly accessible. |
| 372 | * @since 2.9.0 |
| 373 | */ |
| 374 | public function refreshAccountStatus() |
| 375 | { |
| 376 | $merchantDetails = $this->merchantRepository->getDetails(); |
| 377 | |
| 378 | $statusErrors = $this->isAdminSuccessfullyOnBoarded( |
| 379 | $merchantDetails->merchantIdInPayPal, |
| 380 | $merchantDetails->accessToken, |
| 381 | $merchantDetails->supportsCustomPayments |
| 382 | ); |
| 383 | if ($statusErrors !== true) { |
| 384 | $merchantDetails->accountIsReady = false; |
| 385 | $this->merchantRepository->saveAccountErrors($statusErrors); |
| 386 | } else { |
| 387 | $merchantDetails->accountIsReady = true; |
| 388 | $this->merchantRepository->deleteAccountErrors(); |
| 389 | } |
| 390 | |
| 391 | $this->merchantRepository->save($merchantDetails); |
| 392 | } |
| 393 | |
| 394 | /** |
| 395 | * Validate seller on Boarding status |
| 396 | * |
| 397 | * @since 2.29.0 Validate only primary capabilities during PayPal donations on-boarding. |
| 398 | * @since 2.9.0 |
| 399 | * |
| 400 | * @param string $merchantId |
| 401 | * @param string $accessToken |
| 402 | * @param bool $usesCustomPayments |
| 403 | * |
| 404 | * @return true|string[] |
| 405 | */ |
| 406 | private function isAdminSuccessfullyOnBoarded($merchantId, $accessToken, $usesCustomPayments) |
| 407 | { |
| 408 | $onBoardedData = (array)$this->payPalAuth->getSellerOnBoardingDetailsFromPayPal($merchantId, $accessToken); |
| 409 | $onBoardedData = array_filter($onBoardedData); // Remove empty values. |
| 410 | $errorMessages[] = [ |
| 411 | 'type' => 'json', |
| 412 | 'message' => esc_html__('PayPal merchant status check API request response is:', 'give'), |
| 413 | 'value' => wp_json_encode($onBoardedData), |
| 414 | ]; |
| 415 | |
| 416 | if (! is_ssl()) { |
| 417 | $errorMessages[] = esc_html__( |
| 418 | 'A valid SSL certificate is required to accept donations and set up your PayPal account. Once a |
| 419 | certificate is installed and the site is using https, please disconnect and reconnect your account.', |
| 420 | 'give' |
| 421 | ); |
| 422 | } |
| 423 | |
| 424 | if (array_diff(['payments_receivable', 'primary_email_confirmed'], array_keys($onBoardedData))) { |
| 425 | $errorMessages[] = __( |
| 426 | 'Your account is not fully set up and ready to receive payments. Please log into your PayPal account at <a href="https://paypal.com">paypal.com</a> and address the following issues. Reach out to PayPal support if you need help setting up your account.', |
| 427 | 'give' |
| 428 | ); |
| 429 | |
| 430 | // Return here since the rest of the validations will definitely fail |
| 431 | return $errorMessages; |
| 432 | } |
| 433 | |
| 434 | if (! $onBoardedData['payments_receivable']) { |
| 435 | $errorMessages[] = esc_html__('An banking account needs to be connected to your PayPal account and verified', 'give'); |
| 436 | } |
| 437 | |
| 438 | if (! $onBoardedData['primary_email_confirmed']) { |
| 439 | $errorMessages[] = esc_html__('Your primary email address needs to be confirmed', 'give'); |
| 440 | } |
| 441 | |
| 442 | // This error message is only for the case when the user is using custom payments. |
| 443 | // Host card fields are supported only for specific countries and PayPal seller account of PPCP type. |
| 444 | if ($usesCustomPayments) { |
| 445 | $sellerCapabilities = array_key_exists('capabilities', $onBoardedData) |
| 446 | ? wp_list_pluck($onBoardedData['capabilities'], 'name') |
| 447 | : []; |
| 448 | $requiredCapability = 'CUSTOM_CARD_PROCESSING'; |
| 449 | $customCardProcessingCapabilityIndex = array_search($requiredCapability, $sellerCapabilities, true); |
| 450 | $hasCustomCardProcessingCapability = false !== $customCardProcessingCapabilityIndex; |
| 451 | |
| 452 | // If the capability is found then check if it is active. |
| 453 | if (false !== $customCardProcessingCapabilityIndex) { |
| 454 | $customCardProcessingCapability = $onBoardedData['capabilities'][$customCardProcessingCapabilityIndex]; |
| 455 | $hasCustomCardProcessingCapability = 'ACTIVE' === $customCardProcessingCapability['status']; |
| 456 | } |
| 457 | |
| 458 | if (! $hasCustomCardProcessingCapability) { |
| 459 | $errorMessages[] = __( |
| 460 | 'Advance card processing is not active on your PayPal account. That capability is required in order to display card fields directly on your website. To accept donations with card fields directly on your site, called <a href="https://developer.paypal.com/docs/checkout/advanced/#enable-your-account" title="Link to PayPal Docs">hosted fields</a>, you\'ll need to enable custom card processing. This is something PayPal support can help with, and depends on factors outside of GiveWP\'s control. You can still accept donations with <a href="https://developer.paypal.com/docs/checkout/" title="Link to PayPal Docs">PayPal smart buttons</a>, which allow donors to log into PayPal and complete the donation in a modal window, in the meantime.', |
| 461 | 'give' |
| 462 | ); |
| 463 | } |
| 464 | } |
| 465 | |
| 466 | // If there were errors then redirect the user with notices |
| 467 | return count($errorMessages) > 1 ? $errorMessages : true; |
| 468 | } |
| 469 | |
| 470 | /** |
| 471 | * Redirect admin to setting section with error. |
| 472 | * |
| 473 | * @since 2.9.0 |
| 474 | */ |
| 475 | private function redirectWhenOnBoardingFail() |
| 476 | { |
| 477 | wp_redirect( |
| 478 | add_query_arg( |
| 479 | [ |
| 480 | 'post_type' => 'give_forms', |
| 481 | 'page' => 'give-settings', |
| 482 | 'tab' => 'gateways', |
| 483 | 'section' => 'paypal', |
| 484 | 'group' => 'paypal-commerce', |
| 485 | 'paypal-error' => '1', |
| 486 | ], |
| 487 | admin_url('edit.php') |
| 488 | ) |
| 489 | ); |
| 490 | |
| 491 | exit(); |
| 492 | } |
| 493 | |
| 494 | /** |
| 495 | * Displays a notice of the site is not using SSL |
| 496 | * |
| 497 | * @since 2.9.0 |
| 498 | */ |
| 499 | private function registerPayPalSSLNotice() |
| 500 | { |
| 501 | if (is_ssl() && empty($this->webhooksRepository->getWebhookConfig())) { |
| 502 | $logLink = sprintf( |
| 503 | '<a href="%1$s">%2$s</a>', |
| 504 | admin_url('/edit.php?post_type=give_forms&page=give-tools&tab=logs'), |
| 505 | esc_html__('logs data', 'give') |
| 506 | ); |
| 507 | |
| 508 | Give_Admin_Settings::add_error( |
| 509 | 'paypal-webhook-error', |
| 510 | sprintf( |
| 511 | esc_html__( |
| 512 | 'There was a problem setting up the webhooks for your PayPal account. Please try disconnecting and reconnecting your PayPal account. If the problem persists, please contact support and provide them with the latest %1$s', |
| 513 | 'give' |
| 514 | ), |
| 515 | $logLink |
| 516 | ) |
| 517 | ); |
| 518 | } |
| 519 | } |
| 520 | } |
| 521 |