LegacyPaymentGatewayAdapter.php
369 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\LegacyPaymentGateways\Adapters; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\DonationForms\V2\Models\DonationForm; |
| 7 | use Give\Donations\Models\Donation; |
| 8 | use Give\Donations\ValueObjects\DonationType; |
| 9 | use Give\Donors\Models\Donor; |
| 10 | use Give\Framework\PaymentGateways\Contracts\PaymentGatewayInterface; |
| 11 | use Give\Framework\PaymentGateways\Controllers\GatewayPaymentController; |
| 12 | use Give\Framework\PaymentGateways\Controllers\GatewaySubscriptionController; |
| 13 | use Give\Framework\PaymentGateways\PaymentGateway; |
| 14 | use Give\Helpers\Form\Utils; |
| 15 | use Give\PaymentGateways\Actions\GetGatewayDataFromRequest; |
| 16 | use Give\PaymentGateways\DataTransferObjects\FormData; |
| 17 | use Give\PaymentGateways\DataTransferObjects\SubscriptionData; |
| 18 | use Give\Session\SessionDonation\DonationAccessor; |
| 19 | use Give\Subscriptions\Models\Subscription; |
| 20 | use Give\Subscriptions\ValueObjects\SubscriptionMode; |
| 21 | use Give\Subscriptions\ValueObjects\SubscriptionPeriod; |
| 22 | use Give\Subscriptions\ValueObjects\SubscriptionStatus; |
| 23 | |
| 24 | /** |
| 25 | * Class LegacyPaymentGatewayAdapter |
| 26 | * @since 2.18.0 |
| 27 | */ |
| 28 | class LegacyPaymentGatewayAdapter |
| 29 | { |
| 30 | |
| 31 | /** |
| 32 | * Get legacy form field markup to display gateway specific payment fields |
| 33 | * |
| 34 | * @since 2.18.0 |
| 35 | * @since 2.19.0 Added missing $args parameter for ID prefixing and general backwards compatibility. |
| 36 | */ |
| 37 | public function getLegacyFormFieldMarkup( |
| 38 | int $formId, |
| 39 | array $args, |
| 40 | PaymentGateway $registeredGateway |
| 41 | ): string { |
| 42 | return $registeredGateway->getLegacyFormFieldMarkup($formId, $args); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * First we create a payment, then move on to the gateway processing |
| 47 | * |
| 48 | * @since 2.30.0 Add success, cancel and failed URLs to gateway data. This will be used in both v2 and v3 forms so gateways can just refer to the gateway data. |
| 49 | * @since 2.24.0 add support for payment mode |
| 50 | * @since 2.21.0 Replace give_insert_payment with donation model. Store legacy subscription data in donation meta. |
| 51 | * Attach subscription id to donation. |
| 52 | * @since 2.19.0 Replace is_recurring with is_donation_recurring to detect recurring donations. |
| 53 | * @since 2.18.0 |
| 54 | * |
| 55 | * @throws Exception |
| 56 | */ |
| 57 | public function handleBeforeGateway(array $legacyDonationData, PaymentGateway $registeredGateway) |
| 58 | { |
| 59 | $formData = FormData::fromRequest($legacyDonationData); |
| 60 | |
| 61 | $this->validateGatewayNonce($formData->gatewayNonce); |
| 62 | |
| 63 | $this->validateDonationFormStatus($formData->formId); |
| 64 | |
| 65 | $donor = $this->getOrCreateDonor( |
| 66 | $formData->donorInfo->wpUserId, |
| 67 | $formData->donorInfo->email, |
| 68 | $formData->donorInfo->firstName, |
| 69 | $formData->donorInfo->lastName |
| 70 | ); |
| 71 | |
| 72 | $donation = $formData->toDonation($donor->id); |
| 73 | |
| 74 | if (give_recurring_is_donation_recurring($legacyDonationData)) { |
| 75 | $subscriptionData = SubscriptionData::fromRequest($legacyDonationData); |
| 76 | |
| 77 | $paymentMode = !empty($legacyDonationData['payment_mode']) ? new SubscriptionMode($legacyDonationData['payment_mode']) : null; |
| 78 | |
| 79 | if ( $paymentMode === null ) { |
| 80 | $paymentMode = give_is_test_mode() ? SubscriptionMode::TEST() : SubscriptionMode::LIVE(); |
| 81 | } |
| 82 | |
| 83 | $subscription = Subscription::create([ |
| 84 | 'amount' => $donation->amount, |
| 85 | 'period' => new SubscriptionPeriod($subscriptionData->period), |
| 86 | 'frequency' => (int)$subscriptionData->frequency, |
| 87 | 'donorId' => $donor->id, |
| 88 | 'installments' => (int)$subscriptionData->times, |
| 89 | 'status' => SubscriptionStatus::PENDING(), |
| 90 | 'mode' => $paymentMode, |
| 91 | 'donationFormId' => $formData->formId, |
| 92 | ]); |
| 93 | |
| 94 | $donation->type = DonationType::SUBSCRIPTION(); |
| 95 | $donation->subscriptionId = $subscription->id; |
| 96 | $donation->save(); |
| 97 | |
| 98 | give()->subscriptions->updateLegacyParentPaymentId($subscription->id, $donation->id); |
| 99 | |
| 100 | $this->setSession($donation->id); |
| 101 | |
| 102 | /** |
| 103 | * Filter hook to provide gateway data before initial transaction for subscription is processed by the gateway. |
| 104 | * |
| 105 | * @since 2.21.2 |
| 106 | */ |
| 107 | $gatewayData = apply_filters( |
| 108 | "givewp_create_subscription_gateway_data_{$registeredGateway::id()}", |
| 109 | (new GetGatewayDataFromRequest)(), |
| 110 | $donation, |
| 111 | $subscription |
| 112 | ); |
| 113 | |
| 114 | $gatewayData = $this->addUrlsToGatewayData($donation, $gatewayData, $registeredGateway); |
| 115 | |
| 116 | $controller = new GatewaySubscriptionController($registeredGateway); |
| 117 | $controller->create($donation, $subscription, $gatewayData); |
| 118 | } else { |
| 119 | $donation->type = DonationType::SINGLE(); |
| 120 | $donation->save(); |
| 121 | |
| 122 | $this->setSession($donation->id); |
| 123 | |
| 124 | /** |
| 125 | * Filter hook to provide gateway data before transaction is processed by the gateway. |
| 126 | * |
| 127 | * @since 2.21.2 |
| 128 | */ |
| 129 | $gatewayData = apply_filters( |
| 130 | "givewp_create_payment_gateway_data_{$registeredGateway::id()}", |
| 131 | (new GetGatewayDataFromRequest)(), |
| 132 | $donation |
| 133 | ); |
| 134 | |
| 135 | $gatewayData = $this->addUrlsToGatewayData($donation, $gatewayData, $registeredGateway); |
| 136 | |
| 137 | $controller = new GatewayPaymentController($registeredGateway); |
| 138 | $controller->create($donation, $gatewayData); |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * @since 2.30.0 |
| 144 | */ |
| 145 | protected function getGatewayDataSuccessUrl(int $donationId): string |
| 146 | { |
| 147 | $formId = give_get_payment_form_id($donationId); |
| 148 | $isEmbedDonationForm = !Utils::isLegacyForm($formId); |
| 149 | $donationFormPageUrl = (new DonationAccessor())->get()->formEntry->currentUrl ?: get_permalink($formId); |
| 150 | |
| 151 | return $isEmbedDonationForm ? |
| 152 | Utils::createSuccessPageURL($donationFormPageUrl) : |
| 153 | give_get_success_page_url(); |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * @since 2.30.0 |
| 158 | */ |
| 159 | protected function getGatewayDataFailedUrl(int $donationId): string |
| 160 | { |
| 161 | $formId = give_get_payment_form_id($donationId); |
| 162 | $isEmbedDonationForm = !Utils::isLegacyForm($formId); |
| 163 | $donationFormPageUrl = (new DonationAccessor())->get()->formEntry->currentUrl ?: get_permalink($formId); |
| 164 | |
| 165 | return $isEmbedDonationForm ? |
| 166 | Utils::createFailedPageURL($donationFormPageUrl) : |
| 167 | give_get_failed_transaction_uri(); |
| 168 | } |
| 169 | |
| 170 | /** |
| 171 | * @since 2.30.0 |
| 172 | */ |
| 173 | protected function getGatewayDataCancelUrl(int $donationId): string |
| 174 | { |
| 175 | $formId = give_get_payment_form_id($donationId); |
| 176 | |
| 177 | return (new DonationAccessor())->get()->formEntry->currentUrl ?: get_permalink($formId); |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Validate Gateway Nonce |
| 182 | * |
| 183 | * @since 2.18.0 |
| 184 | */ |
| 185 | private function validateGatewayNonce(string $gatewayNonce) |
| 186 | { |
| 187 | if (!wp_verify_nonce($gatewayNonce, 'give-gateway')) { |
| 188 | wp_die( |
| 189 | esc_html__( |
| 190 | 'We\'re unable to recognize your session. Please refresh the screen to try again; otherwise contact your website administrator for assistance.', |
| 191 | 'give' |
| 192 | ), |
| 193 | esc_html__('Error', 'give'), |
| 194 | ['response' => 403] |
| 195 | ); |
| 196 | } |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Validate Donation Form Status |
| 201 | * |
| 202 | * @since 2.33.2 |
| 203 | */ |
| 204 | private function validateDonationFormStatus(int $formId) |
| 205 | { |
| 206 | $donationForm = DonationForm::find($formId); |
| 207 | |
| 208 | if (!$donationForm || $donationForm->status->isTrash()) { |
| 209 | wp_die( |
| 210 | esc_html__( |
| 211 | 'This donation form is not accepting donations.', |
| 212 | 'give' |
| 213 | ), |
| 214 | esc_html__('Error', 'give'), |
| 215 | ['response' => 403] |
| 216 | ); |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Set donation id to purchase session for use in the donation receipt. |
| 222 | * |
| 223 | * @since 2.21.0 |
| 224 | * |
| 225 | * @param $donationId |
| 226 | * |
| 227 | * @return void |
| 228 | */ |
| 229 | private function setSession($donationId) |
| 230 | { |
| 231 | $purchaseSession = (array)give()->session->get('give_purchase'); |
| 232 | |
| 233 | if ($purchaseSession && array_key_exists('purchase_key', $purchaseSession)) { |
| 234 | $purchaseSession['donation_id'] = $donationId; |
| 235 | give()->session->set('give_purchase', $purchaseSession); |
| 236 | } |
| 237 | } |
| 238 | |
| 239 | /** |
| 240 | * @since 2.21.0 |
| 241 | * |
| 242 | * @param int|null $userId |
| 243 | * @param string $donorEmail |
| 244 | * @param string $firstName |
| 245 | * @param string $lastName |
| 246 | * |
| 247 | * @return Donor |
| 248 | * @throws Exception |
| 249 | */ |
| 250 | private function getOrCreateDonor( |
| 251 | int $userId, |
| 252 | string $donorEmail, |
| 253 | string $firstName, |
| 254 | string $lastName |
| 255 | ): Donor { |
| 256 | // first check if donor exists as a user |
| 257 | $donor = Donor::whereUserId($userId); |
| 258 | |
| 259 | // If they exist as a donor & user then make sure they don't already own this email before adding to their additional emails list.. |
| 260 | if ($donor && !$donor->hasEmail($donorEmail)) { |
| 261 | $donor->additionalEmails = array_merge($donor->additionalEmails ?? [], [$donorEmail]); |
| 262 | $donor->save(); |
| 263 | } |
| 264 | |
| 265 | // if donor is not a user than check for any donor matching this email |
| 266 | if (!$donor) { |
| 267 | $donor = Donor::whereEmail($donorEmail); |
| 268 | } |
| 269 | |
| 270 | // if no donor exists then create a new one using their personal information from the form. |
| 271 | if (!$donor) { |
| 272 | $donor = Donor::create([ |
| 273 | 'name' => trim("$firstName $lastName"), |
| 274 | 'firstName' => $firstName, |
| 275 | 'lastName' => $lastName, |
| 276 | 'email' => $donorEmail, |
| 277 | 'userId' => $userId ?: null, |
| 278 | ]); |
| 279 | } |
| 280 | |
| 281 | return $donor; |
| 282 | } |
| 283 | |
| 284 | /** |
| 285 | * @since 2.29.0 |
| 286 | */ |
| 287 | public function addOptRefundCheckbox(int $donationId, PaymentGatewayInterface $registeredGateway) |
| 288 | { |
| 289 | $donation = Donation::find($donationId); |
| 290 | if ($donation->gatewayId === $registeredGateway::id()) { |
| 291 | ?> |
| 292 | <div id="give-gateway-opt-refund-wrap" |
| 293 | class="give-gateway-opt-refund give-admin-box-inside give-hidden"> |
| 294 | <p> |
| 295 | <input type="checkbox" id="give-gateway-opt-refund" name="give_gateway_opt_refund" value="1" /> |
| 296 | <label for="give-gateway-opt-refund"> |
| 297 | <?php |
| 298 | esc_html_e(sprintf('Refund the donation at %s?', $registeredGateway->getName()), 'give'); |
| 299 | ?> |
| 300 | </label> |
| 301 | </p> |
| 302 | </div> |
| 303 | <script> |
| 304 | if (!!document.getElementById('give-payment-status') && |
| 305 | 1 === document.querySelectorAll('div.give-admin-box > div.give-hidden[id*="opt-refund"] input[type="checkbox"]').length |
| 306 | ) { |
| 307 | document.getElementById('give-payment-status').addEventListener('change', function (event) { |
| 308 | const refundCheckbox = document.getElementById('give-gateway-opt-refund'); |
| 309 | |
| 310 | if (null === refundCheckbox) { |
| 311 | return; |
| 312 | } |
| 313 | |
| 314 | refundCheckbox.checked = false; |
| 315 | |
| 316 | if ('refunded' === event.target.value) { |
| 317 | document.getElementById('give-gateway-opt-refund-wrap').style.display = 'block'; |
| 318 | } else { |
| 319 | document.getElementById('give-gateway-opt-refund-wrap').style.display = 'none'; |
| 320 | } |
| 321 | }); |
| 322 | } |
| 323 | </script> |
| 324 | <?php |
| 325 | } |
| 326 | } |
| 327 | |
| 328 | /** |
| 329 | * @since 2.29.0 |
| 330 | */ |
| 331 | public function maybeRefundOnGateway( |
| 332 | int $donationId, |
| 333 | string $newStatus, |
| 334 | string $oldStatus, |
| 335 | PaymentGateway $registeredGateway |
| 336 | ) { |
| 337 | $gatewayOptRefund = ! empty($_POST['give_gateway_opt_refund']) ? give_clean($_POST['give_gateway_opt_refund']) : ''; |
| 338 | $canProcessRefund = ! empty($gatewayOptRefund) ? $gatewayOptRefund : false; |
| 339 | |
| 340 | // Only move forward if refund requested. |
| 341 | if ( ! $canProcessRefund) { |
| 342 | return; |
| 343 | } |
| 344 | |
| 345 | $donation = Donation::find($donationId); |
| 346 | if ($donation->gatewayId === $registeredGateway::id() && |
| 347 | 'refunded' === $newStatus && |
| 348 | 'refunded' !== $oldStatus) { |
| 349 | $controller = new GatewayPaymentController($registeredGateway); |
| 350 | $controller->refund($donation); |
| 351 | } |
| 352 | } |
| 353 | |
| 354 | /** |
| 355 | * @since 2.30.0 |
| 356 | */ |
| 357 | protected function addUrlsToGatewayData(Donation $donation, $gatewayData, PaymentGateway $registeredGateway) |
| 358 | { |
| 359 | return array_merge($gatewayData, [ |
| 360 | 'successUrl' => add_query_arg( |
| 361 | ['payment-confirmation' => $registeredGateway::id()], |
| 362 | $this->getGatewayDataSuccessUrl($donation->id) |
| 363 | ), |
| 364 | 'cancelUrl' => $this->getGatewayDataCancelUrl($donation->id), |
| 365 | 'failedUrl' => $this->getGatewayDataFailedUrl($donation->id) |
| 366 | ]); |
| 367 | } |
| 368 | } |
| 369 |