-
Notifications
You must be signed in to change notification settings - Fork 69
/
class-wc-payments-payment-request-button-handler.php
1834 lines (1557 loc) · 64.1 KB
/
class-wc-payments-payment-request-button-handler.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Class WC_Payments_Payment_Request_Button_Handler
* Adds support for Apple Pay, Google Pay and Payment Request API buttons.
* Utilizes the Stripe Payment Request Button to support checkout from the product detail and cart pages.
*
* Adapted from WooCommerce Stripe Gateway extension.
*
* @package WooCommerce\Payments
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
use WCPay\Constants\Country_Code;
use WCPay\Exceptions\Invalid_Price_Exception;
use WCPay\Fraud_Prevention\Fraud_Prevention_Service;
use WCPay\Logger;
use WCPay\Payment_Information;
/**
* WC_Payments_Payment_Request_Button_Handler class.
*/
class WC_Payments_Payment_Request_Button_Handler {
const BUTTON_LOCATIONS = 'payment_request_button_locations';
/**
* WC_Payments_Account instance to get information about the account
*
* @var WC_Payments_Account
*/
private $account;
/**
* WC_Payment_Gateway_WCPay instance.
*
* @var WC_Payment_Gateway_WCPay
*/
private $gateway;
/**
* Express Checkout Helper instance.
*
* @var WC_Payments_Express_Checkout_Button_Helper
*/
private $express_checkout_helper;
/**
* Initialize class actions.
*
* @param WC_Payments_Account $account Account information.
* @param WC_Payment_Gateway_WCPay $gateway WCPay gateway.
* @param WC_Payments_Express_Checkout_Button_Helper $express_checkout_helper Express checkout helper.
*/
public function __construct( WC_Payments_Account $account, WC_Payment_Gateway_WCPay $gateway, WC_Payments_Express_Checkout_Button_Helper $express_checkout_helper ) {
$this->account = $account;
$this->gateway = $gateway;
$this->express_checkout_helper = $express_checkout_helper;
}
/**
* Initialize hooks.
*
* @return void
*/
public function init() {
// Checks if WCPay is enabled.
if ( ! $this->gateway->is_enabled() ) {
return;
}
if ( WC_Payments_Features::is_stripe_ece_enabled() ) {
return;
}
// Checks if Payment Request is enabled.
if ( 'yes' !== $this->gateway->get_option( 'payment_request' ) ) {
return;
}
// Don't load for change payment method page.
if ( isset( $_GET['change_payment_method'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
return;
}
add_action( 'template_redirect', [ $this, 'set_session' ] );
add_action( 'template_redirect', [ $this, 'handle_payment_request_redirect' ] );
add_action( 'wp_enqueue_scripts', [ $this, 'scripts' ] );
add_action( 'before_woocommerce_pay_form', [ $this, 'display_pay_for_order_page_html' ], 1 );
add_action( 'wc_ajax_wcpay_get_cart_details', [ $this, 'ajax_get_cart_details' ] );
add_action( 'wc_ajax_wcpay_get_shipping_options', [ $this, 'ajax_get_shipping_options' ] );
add_action( 'wc_ajax_wcpay_update_shipping_method', [ $this, 'ajax_update_shipping_method' ] );
add_action( 'wc_ajax_wcpay_create_order', [ $this, 'ajax_create_order' ] );
add_action( 'wc_ajax_wcpay_get_selected_product_data', [ $this, 'ajax_get_selected_product_data' ] );
add_action( 'wc_ajax_wcpay_pay_for_order', [ $this, 'ajax_pay_for_order' ] );
add_filter( 'woocommerce_gateway_title', [ $this, 'filter_gateway_title' ], 10, 2 );
add_action( 'woocommerce_checkout_order_processed', [ $this, 'add_order_meta' ], 10, 2 );
add_filter( 'woocommerce_login_redirect', [ $this, 'get_login_redirect_url' ], 10, 3 );
add_filter( 'woocommerce_registration_redirect', [ $this, 'get_login_redirect_url' ], 10, 3 );
add_filter( 'woocommerce_cart_needs_shipping_address', [ $this, 'filter_cart_needs_shipping_address' ], 11, 1 );
// Add a filter for the value of `wcpay_is_apple_pay_enabled`.
// This option does not get stored in the database at all, and this function
// will be used to calculate it whenever the option value is retrieved instead.
// It's used for displaying inbox notifications.
add_filter( 'pre_option_wcpay_is_apple_pay_enabled', [ $this, 'get_option_is_apple_pay_enabled' ], 10, 1 );
if ( WC_Payments_Features::is_tokenized_cart_prb_enabled() ) {
add_action(
'woocommerce_store_api_checkout_update_order_from_request',
[
$this,
'tokenized_cart_set_payment_method_type',
],
10,
2
);
add_filter( 'rest_pre_dispatch', [ $this, 'tokenized_cart_store_api_address_normalization' ], 10, 3 );
add_filter( 'rest_pre_dispatch', [ $this, 'tokenized_cart_store_api_nonce_overwrite' ], 10, 3 );
add_filter(
'rest_post_dispatch',
[ $this, 'tokenized_cart_store_api_nonce_headers' ],
10,
3
);
}
}
/**
* Updates the checkout order based on the request, to set the Apple Pay/Google Pay payment method title.
*
* @param \WC_Order $order The order to be updated.
* @param \WP_REST_Request $request Store API request to update the order.
*/
public function tokenized_cart_set_payment_method_type( \WC_Order $order, \WP_REST_Request $request ) {
if ( ! isset( $request['payment_method'] ) || 'woocommerce_payments' !== $request['payment_method'] ) {
return;
}
if ( empty( $request['payment_data'] ) ) {
return;
}
$payment_data = [];
foreach ( $request['payment_data'] as $data ) {
$payment_data[ sanitize_key( $data['key'] ) ] = wc_clean( $data['value'] );
}
if ( empty( $payment_data['payment_request_type'] ) ) {
return;
}
$payment_request_type = wc_clean( wp_unslash( $payment_data['payment_request_type'] ) );
$payment_method_titles = [
'apple_pay' => 'Apple Pay',
'google_pay' => 'Google Pay',
];
$suffix = apply_filters( 'wcpay_payment_request_payment_method_title_suffix', 'WooPayments' );
if ( ! empty( $suffix ) ) {
$suffix = " ($suffix)";
}
$payment_method_title = isset( $payment_method_titles[ $payment_request_type ] ) ? $payment_method_titles[ $payment_request_type ] : 'Payment Request';
$order->set_payment_method_title( $payment_method_title . $suffix );
}
/**
* The nonce supplied by the frontend can be overwritten in this middleware:
* https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce-blocks/assets/js/middleware/store-api-nonce.js
*
* This is a workaround to use instead a different nonce key, when supplied.
*
* @param mixed $response Response to replace the requested version with.
* @param \WP_REST_Server $server Server instance.
* @param \WP_REST_Request $request Request used to generate the response.
*
* @return mixed
*/
public function tokenized_cart_store_api_nonce_overwrite( $response, $server, $request ) {
$nonce = $request->get_header( 'X-WooPayments-Store-Api-Nonce' );
if ( empty( $nonce ) ) {
return $response;
}
$request->set_header( 'Nonce', $nonce );
return $response;
}
/**
* Google Pay/Apple Pay parameters for address data might need some massaging for some of the countries.
* Ensuring that the Store API doesn't throw a `rest_invalid_param` error message for some of those scenarios.
*
* @param mixed $response Response to replace the requested version with.
* @param \WP_REST_Server $server Server instance.
* @param \WP_REST_Request $request Request used to generate the response.
*
* @return mixed
*/
public function tokenized_cart_store_api_address_normalization( $response, $server, $request ) {
if ( 'true' !== $request->get_header( 'X-WooPayments-Express-Payment-Request' ) ) {
return $response;
}
// header added as additional layer of security.
$nonce = $request->get_header( 'X-WooPayments-Express-Payment-Request-Nonce' );
if ( ! wp_verify_nonce( $nonce, 'woopayments_tokenized_cart_nonce' ) ) {
return $response;
}
// This route is used to get shipping rates.
// GooglePay/ApplePay might provide us with "trimmed" zip codes.
// If that's the case, let's temporarily allow to skip the zip code validation, in order to get some shipping rates.
$is_update_customer_route = $request->get_route() === '/wc/store/v1/cart/update-customer';
if ( $is_update_customer_route ) {
add_filter( 'woocommerce_validate_postcode', [ $this, 'maybe_skip_postcode_validation' ], 10, 3 );
}
$request_data = $request->get_json_params();
if ( isset( $request_data['shipping_address'] ) ) {
$request->set_param( 'shipping_address', $this->transform_prb_address_state_data( $request_data['shipping_address'] ) );
// on the "update customer" route, GooglePay/Apple pay might provide redacted postcode data.
// we need to modify the zip code to ensure that shipping zone identification still works.
if ( $is_update_customer_route ) {
$request->set_param( 'shipping_address', $this->transform_prb_address_postcode_data( $request_data['shipping_address'] ) );
}
}
if ( isset( $request_data['billing_address'] ) ) {
$request->set_param( 'billing_address', $this->transform_prb_address_state_data( $request_data['billing_address'] ) );
// on the "update customer" route, GooglePay/Apple pay might provide redacted postcode data.
// we need to modify the zip code to ensure that shipping zone identification still works.
if ( $is_update_customer_route ) {
$request->set_param( 'billing_address', $this->transform_prb_address_postcode_data( $request_data['billing_address'] ) );
}
}
return $response;
}
/**
* In order to create an additional layer of security, we're adding a custom nonce to the Store API REST responses.
* This nonce is added as a response header on the Store API, because nonces are tied to user sessions,
* and anonymous carts count as separate user sessions.
*
* @param \WP_HTTP_Response $response Response to replace the requested version with.
* @param \WP_REST_Server $server Server instance.
* @param \WP_REST_Request $request Request used to generate the response.
*
* @return \WP_HTTP_Response
*/
public function tokenized_cart_store_api_nonce_headers( $response, $server, $request ) {
if ( $request->get_route() === '/wc/store/v1/cart' ) {
$response->header( 'X-WooPayments-Express-Payment-Request-Nonce', wp_create_nonce( 'woopayments_tokenized_cart_nonce' ) );
}
return $response;
}
/**
* Allows certain "redacted" postcodes for some countries to bypass WC core validation.
*
* @param bool $valid Whether the postcode is valid.
* @param string $postcode The postcode in question.
* @param string $country The country for the postcode.
*
* @return bool
*/
public function maybe_skip_postcode_validation( $valid, $postcode, $country ) {
if ( ! in_array( $country, [ Country_Code::UNITED_KINGDOM, Country_Code::CANADA ], true ) ) {
return $valid;
}
// We padded the string with `0` in the `get_normalized_postal_code` method.
// It's a flimsy check, but better than nothing.
// Plus, this check is only made for the scenarios outlined in the `tokenized_cart_store_api_address_normalization` method.
if ( substr( $postcode, - 1 ) === '0' ) {
return true;
}
return $valid;
}
/**
* Transform a GooglePay/ApplePay state address data fields into values that are valid for WooCommerce.
*
* @param array $address The address to normalize from the GooglePay/ApplePay request.
*
* @return array
*/
private function transform_prb_address_state_data( $address ) {
$country = $address['country'] ?? '';
if ( empty( $country ) ) {
return $address;
}
// States from Apple Pay or Google Pay are in long format, we need their short format..
$state = $address['state'] ?? '';
if ( ! empty( $state ) ) {
$address['state'] = $this->get_normalized_state( $state, $country );
}
return $address;
}
/**
* Transform a GooglePay/ApplePay postcode address data fields into values that are valid for WooCommerce.
*
* @param array $address The address to normalize from the GooglePay/ApplePay request.
*
* @return array
*/
private function transform_prb_address_postcode_data( $address ) {
$country = $address['country'] ?? '';
if ( empty( $country ) ) {
return $address;
}
// Normalizes postal code in case of redacted data from Apple Pay or Google Pay.
$postcode = $address['postcode'] ?? '';
if ( ! empty( $postcode ) ) {
$address['postcode'] = $this->get_normalized_postal_code( $postcode, $country );
}
return $address;
}
/**
* Checks whether authentication is required for checkout.
*
* @return bool
*/
public function is_authentication_required() {
// If guest checkout is disabled and account creation is not possible, authentication is required.
if ( 'no' === get_option( 'woocommerce_enable_guest_checkout', 'yes' ) && ! $this->is_account_creation_possible() ) {
return true;
}
// If cart contains subscription and account creation is not posible, authentication is required.
if ( $this->has_subscription_product() && ! $this->is_account_creation_possible() ) {
return true;
}
return false;
}
/**
* Checks whether account creation is possible during checkout.
*
* @return bool
*/
public function is_account_creation_possible() {
$is_signup_from_checkout_allowed = 'yes' === get_option( 'woocommerce_enable_signup_and_login_from_checkout', 'no' );
// If a subscription is being purchased, check if account creation is allowed for subscriptions.
if ( ! $is_signup_from_checkout_allowed && $this->has_subscription_product() ) {
$is_signup_from_checkout_allowed = 'yes' === get_option( 'woocommerce_enable_signup_from_checkout_for_subscriptions', 'no' );
}
// If automatically generate username/password are disabled, the Payment Request API
// can't include any of those fields, so account creation is not possible.
return (
$is_signup_from_checkout_allowed &&
'yes' === get_option( 'woocommerce_registration_generate_username', 'yes' ) &&
'yes' === get_option( 'woocommerce_registration_generate_password', 'yes' )
);
}
/**
* Sets the WC customer session if one is not set.
* This is needed so nonces can be verified by AJAX Request.
*
* @return void
*/
public function set_session() {
// Don't set session cookies on product pages to allow for caching when payment request
// buttons are disabled. But keep cookies if there is already an active WC session in place.
if (
! ( $this->express_checkout_helper->is_product() && $this->should_show_payment_request_button() )
|| ( isset( WC()->session ) && WC()->session->has_session() )
) {
return;
}
WC()->session->set_customer_session_cookie( true );
}
/**
* Handles payment request redirect when the redirect dialog "Continue" button is clicked.
*/
public function handle_payment_request_redirect() {
if (
! empty( $_GET['wcpay_payment_request_redirect_url'] )
&& ! empty( $_GET['_wpnonce'] )
&& wp_verify_nonce( $_GET['_wpnonce'], 'wcpay-set-redirect-url' ) // @codingStandardsIgnoreLine
) {
$url = rawurldecode( esc_url_raw( wp_unslash( $_GET['wcpay_payment_request_redirect_url'] ) ) );
// Sets a redirect URL cookie for 10 minutes, which we will redirect to after authentication.
// Users will have a 10 minute timeout to login/create account, otherwise redirect URL expires.
wc_setcookie( 'wcpay_payment_request_redirect_url', $url, time() + MINUTE_IN_SECONDS * 10 );
// Redirects to "my-account" page.
wp_safe_redirect( get_permalink( get_option( 'woocommerce_myaccount_page_id' ) ) );
}
}
/**
* The settings for the `button` attribute - they depend on the "grouped settings" flag value.
*
* @return array
*/
public function get_button_settings() {
$button_type = $this->gateway->get_option( 'payment_request_button_type' );
$common_settings = $this->express_checkout_helper->get_common_button_settings();
$payment_request_button_settings = [
// Default format is en_US.
'locale' => apply_filters( 'wcpay_payment_request_button_locale', substr( get_locale(), 0, 2 ) ),
'branded_type' => 'default' === $button_type ? 'short' : 'long',
];
return array_merge( $common_settings, $payment_request_button_settings );
}
/**
* Gets the product total price.
*
* @param object $product WC_Product_* object.
* @param bool $is_deposit Whether customer is paying a deposit.
* @param int $deposit_plan_id The ID of the deposit plan.
*
* @return mixed Total price.
*
* @throws Invalid_Price_Exception Whenever a product has no price.
*/
public function get_product_price( $product, ?bool $is_deposit = null, int $deposit_plan_id = 0 ) {
// If prices should include tax, using tax inclusive price.
if ( $this->express_checkout_helper->cart_prices_include_tax() ) {
$base_price = wc_get_price_including_tax( $product );
} else {
$base_price = wc_get_price_excluding_tax( $product );
}
// If WooCommerce Deposits is active, we need to get the correct price for the product.
if ( class_exists( 'WC_Deposits_Product_Manager' ) && class_exists( 'WC_Deposits_Plans_Manager' ) && WC_Deposits_Product_Manager::deposits_enabled( $product->get_id() ) ) {
// If is_deposit is null, we use the default deposit type for the product.
if ( is_null( $is_deposit ) ) {
$is_deposit = 'deposit' === WC_Deposits_Product_Manager::get_deposit_selected_type( $product->get_id() );
}
if ( $is_deposit ) {
$deposit_type = WC_Deposits_Product_Manager::get_deposit_type( $product->get_id() );
$available_plan_ids = WC_Deposits_Plans_Manager::get_plan_ids_for_product( $product->get_id() );
// Default to first (default) plan if no plan is specified.
if ( 'plan' === $deposit_type && 0 === $deposit_plan_id && ! empty( $available_plan_ids ) ) {
$deposit_plan_id = $available_plan_ids[0];
}
// Ensure the selected plan is available for the product.
if ( 0 === $deposit_plan_id || in_array( $deposit_plan_id, $available_plan_ids, true ) ) {
$base_price = WC_Deposits_Product_Manager::get_deposit_amount( $product, $deposit_plan_id, 'display', $base_price );
}
}
}
// Add subscription sign-up fees to product price.
$sign_up_fee = 0;
$subscription_types = [
'subscription',
'subscription_variation',
];
if ( in_array( $product->get_type(), $subscription_types, true ) && class_exists( 'WC_Subscriptions_Product' ) ) {
// When there is no sign-up fee, `get_sign_up_fee` falls back to an int 0.
$sign_up_fee = WC_Subscriptions_Product::get_sign_up_fee( $product );
}
if ( ! is_numeric( $base_price ) || ! is_numeric( $sign_up_fee ) ) {
$error_message = sprintf(
// Translators: %d is the numeric ID of the product without a price.
__( 'Express checkout does not support products without prices! Please add a price to product #%d', 'woocommerce-payments' ),
(int) $product->get_id()
);
throw new Invalid_Price_Exception(
esc_html( $error_message )
);
}
return $base_price + $sign_up_fee;
}
/**
* Gets the product data for the currently viewed page.
*
* @return mixed Returns false if not on a product page, the product information otherwise.
*/
public function get_product_data() {
if ( ! $this->express_checkout_helper->is_product() ) {
return false;
}
/** @var WC_Product_Variable $product */ // phpcs:ignore
$product = $this->express_checkout_helper->get_product();
$currency = get_woocommerce_currency();
if ( 'variable' === $product->get_type() || 'variable-subscription' === $product->get_type() ) {
$variation_attributes = $product->get_variation_attributes();
$attributes = [];
foreach ( $variation_attributes as $attribute_name => $attribute_values ) {
$attribute_key = 'attribute_' . sanitize_title( $attribute_name );
// Passed value via GET takes precedence. Otherwise get the default value for given attribute.
$attributes[ $attribute_key ] = isset( $_GET[ $attribute_key ] ) // phpcs:ignore WordPress.Security.NonceVerification
? wc_clean( wp_unslash( $_GET[ $attribute_key ] ) ) // phpcs:ignore WordPress.Security.NonceVerification
: $product->get_variation_default_attribute( $attribute_name );
}
$data_store = WC_Data_Store::load( 'product' );
$variation_id = $data_store->find_matching_product_variation( $product, $attributes );
if ( ! empty( $variation_id ) ) {
$product = wc_get_product( $variation_id );
}
}
try {
$price = $this->get_product_price( $product );
} catch ( Invalid_Price_Exception $e ) {
Logger::log( $e->getMessage() );
return false;
}
$data = [];
$items = [];
$items[] = [
'label' => $product->get_name(),
'amount' => WC_Payments_Utils::prepare_amount( $price, $currency ),
];
$total_tax = 0;
foreach ( $this->get_taxes_like_cart( $product, $price ) as $tax ) {
$total_tax += $tax;
$items[] = [
'label' => __( 'Tax', 'woocommerce-payments' ),
'amount' => WC_Payments_Utils::prepare_amount( $tax, $currency ),
'pending' => 0 === $tax,
];
}
if ( wc_shipping_enabled() && 0 !== wc_get_shipping_method_count( true ) && $product->needs_shipping() ) {
$items[] = [
'label' => __( 'Shipping', 'woocommerce-payments' ),
'amount' => 0,
'pending' => true,
];
$data['shippingOptions'] = [
'id' => 'pending',
'label' => __( 'Pending', 'woocommerce-payments' ),
'detail' => '',
'amount' => 0,
];
}
$data['displayItems'] = $items;
$data['total'] = [
'label' => apply_filters( 'wcpay_payment_request_total_label', $this->express_checkout_helper->get_total_label() ),
'amount' => WC_Payments_Utils::prepare_amount( $price + $total_tax, $currency ),
'pending' => true,
];
$data['needs_shipping'] = ( wc_shipping_enabled() && 0 !== wc_get_shipping_method_count( true ) && $product->needs_shipping() );
$data['currency'] = strtolower( $currency );
$data['country_code'] = substr( get_option( 'woocommerce_default_country' ), 0, 2 );
return apply_filters( 'wcpay_payment_request_product_data', $data, $product );
}
/**
* Displays the necessary HTML for the Pay for Order page.
*
* @param WC_Order $order The order that needs payment.
*/
public function display_pay_for_order_page_html( $order ) {
$currency = get_woocommerce_currency();
$data = [];
$items = [];
foreach ( $order->get_items() as $item ) {
if ( method_exists( $item, 'get_total' ) ) {
$items[] = [
'label' => $item->get_name(),
'amount' => WC_Payments_Utils::prepare_amount( $item->get_total(), $currency ),
];
}
}
if ( $order->get_total_tax() ) {
$items[] = [
'label' => __( 'Tax', 'woocommerce-payments' ),
'amount' => WC_Payments_Utils::prepare_amount( $order->get_total_tax(), $currency ),
];
}
if ( $order->get_shipping_total() ) {
$shipping_label = sprintf(
// Translators: %s is the name of the shipping method.
__( 'Shipping (%s)', 'woocommerce-payments' ),
$order->get_shipping_method()
);
$items[] = [
'label' => $shipping_label,
'amount' => WC_Payments_Utils::prepare_amount( $order->get_shipping_total(), $currency ),
];
}
foreach ( $order->get_fees() as $fee ) {
$items[] = [
'label' => $fee->get_name(),
'amount' => WC_Payments_Utils::prepare_amount( $fee->get_amount(), $currency ),
];
}
$data['order'] = $order->get_id();
$data['displayItems'] = $items;
$data['needs_shipping'] = false; // This should be already entered/prepared.
$data['total'] = [
'label' => apply_filters( 'wcpay_payment_request_total_label', $this->express_checkout_helper->get_total_label() ),
'amount' => WC_Payments_Utils::prepare_amount( $order->get_total(), $currency ),
'pending' => true,
];
wp_localize_script( 'WCPAY_PAYMENT_REQUEST', 'wcpayPaymentRequestPayForOrderParams', $data );
}
/**
* Get cart data.
*
* @return mixed Returns false if on a product page, the product information otherwise.
*/
public function get_cart_data() {
if ( $this->express_checkout_helper->is_product() ) {
return false;
}
return $this->express_checkout_helper->build_display_items();
}
/**
* Filters the gateway title to reflect Payment Request type
*
* @param string $title Gateway title.
* @param string $id Gateway ID.
*/
public function filter_gateway_title( $title, $id ) {
if ( 'woocommerce_payments' !== $id || ! is_admin() ) {
return $title;
}
$order = $this->get_current_order();
$method_title = is_object( $order ) ? $order->get_payment_method_title() : '';
if ( ! empty( $method_title ) ) {
if (
strpos( $method_title, 'Apple Pay' ) === 0
|| strpos( $method_title, 'Google Pay' ) === 0
|| strpos( $method_title, 'Payment Request' ) === 0
) {
return $method_title;
}
}
return $title;
}
/**
* Used to get the order in admin edit page.
*
* @return WC_Order|WC_Order_Refund|bool
*/
private function get_current_order() {
global $theorder;
global $post;
if ( is_object( $theorder ) ) {
return $theorder;
}
if ( is_object( $post ) ) {
return wc_get_order( $post->ID );
}
return false;
}
/**
* Normalizes postal code in case of redacted data from Apple Pay.
*
* @param string $postcode Postal code.
* @param string $country Country.
*/
public function get_normalized_postal_code( $postcode, $country ) {
/**
* Currently, Apple Pay truncates the UK and Canadian postal codes to the first 4 and 3 characters respectively
* when passing it back from the shippingcontactselected object. This causes WC to invalidate
* the postal code and not calculate shipping zones correctly.
*/
if ( Country_Code::UNITED_KINGDOM === $country ) {
// Replaces a redacted string with something like N1C0000.
return str_pad( preg_replace( '/\s+/', '', $postcode ), 7, '0' );
}
if ( Country_Code::CANADA === $country ) {
// Replaces a redacted string with something like H3B000.
return str_pad( preg_replace( '/\s+/', '', $postcode ), 6, '0' );
}
return $postcode;
}
/**
* Add needed order meta
*
* @param integer $order_id The order ID.
*
* @return void
*/
public function add_order_meta( $order_id ) {
if ( empty( $_POST['payment_request_type'] ) || ! isset( $_POST['payment_method'] ) || 'woocommerce_payments' !== $_POST['payment_method'] ) { // phpcs:ignore WordPress.Security.NonceVerification
return;
}
$order = wc_get_order( $order_id );
$payment_request_type = wc_clean( wp_unslash( $_POST['payment_request_type'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
$payment_method_titles = [
'apple_pay' => 'Apple Pay',
'google_pay' => 'Google Pay',
];
$suffix = apply_filters( 'wcpay_payment_request_payment_method_title_suffix', 'WooPayments' );
if ( ! empty( $suffix ) ) {
$suffix = " ($suffix)";
}
$payment_method_title = isset( $payment_method_titles[ $payment_request_type ] ) ? $payment_method_titles[ $payment_request_type ] : 'Payment Request';
$order->set_payment_method_title( $payment_method_title . $suffix );
$order->save();
}
/**
* Checks whether Payment Request Button should be available on this page.
*
* @return bool
*/
public function should_show_payment_request_button() {
// If account is not connected, then bail.
if ( ! $this->account->is_stripe_connected() ) {
return false;
}
// If no SSL, bail.
if ( ! WC_Payments::mode()->is_test() && ! is_ssl() ) {
Logger::log( 'Stripe Payment Request live mode requires SSL.' );
return false;
}
// Page not supported.
if ( ! $this->express_checkout_helper->is_product() && ! $this->express_checkout_helper->is_cart() && ! $this->express_checkout_helper->is_checkout() ) {
return false;
}
// Product page, but not available in settings.
if ( $this->express_checkout_helper->is_product() && ! $this->express_checkout_helper->is_available_at( 'product', self::BUTTON_LOCATIONS ) ) {
return false;
}
// Checkout page, but not available in settings.
if ( $this->express_checkout_helper->is_checkout() && ! $this->express_checkout_helper->is_available_at( 'checkout', self::BUTTON_LOCATIONS ) ) {
return false;
}
// Cart page, but not available in settings.
if ( $this->express_checkout_helper->is_cart() && ! $this->express_checkout_helper->is_available_at( 'cart', self::BUTTON_LOCATIONS ) ) {
return false;
}
// Product page, but has unsupported product type.
if ( $this->express_checkout_helper->is_product() && ! apply_filters( 'wcpay_payment_request_is_product_supported', $this->is_product_supported(), $this->express_checkout_helper->get_product() ) ) {
Logger::log( 'Product page has unsupported product type ( Payment Request button disabled )' );
return false;
}
// Cart has unsupported product type.
if ( ( $this->express_checkout_helper->is_checkout() || $this->express_checkout_helper->is_cart() ) && ! $this->has_allowed_items_in_cart() ) {
Logger::log( 'Items in the cart have unsupported product type ( Payment Request button disabled )' );
return false;
}
// Order total doesn't matter for Pay for Order page. Thus, this page should always display payment buttons.
if ( $this->express_checkout_helper->is_pay_for_order_page() ) {
return true;
}
// Cart total is 0 or is on product page and product price is 0.
// Exclude pay-for-order pages from this check.
if (
( ! $this->express_checkout_helper->is_product() && ! $this->express_checkout_helper->is_pay_for_order_page() && 0.0 === (float) WC()->cart->get_total( 'edit' ) ) ||
( $this->express_checkout_helper->is_product() && 0.0 === (float) $this->express_checkout_helper->get_product()->get_price() )
) {
Logger::log( 'Order price is 0 ( Payment Request button disabled )' );
return false;
}
return true;
}
/**
* Checks to make sure product type is supported.
*
* @return array
*/
public function supported_product_types() {
return apply_filters(
'wcpay_payment_request_supported_types',
[
'simple',
'variable',
'variation',
'subscription',
'variable-subscription',
'subscription_variation',
'booking',
'bundle',
'composite',
'mix-and-match',
]
);
}
/**
* Checks the cart to see if all items are allowed to be used.
*
* @return boolean
*/
public function has_allowed_items_in_cart() {
// Pre Orders compatbility where we don't support charge upon release.
if ( class_exists( 'WC_Pre_Orders_Cart' ) && WC_Pre_Orders_Cart::cart_contains_pre_order() && class_exists( 'WC_Pre_Orders_Product' ) && WC_Pre_Orders_Product::product_is_charged_upon_release( WC_Pre_Orders_Cart::get_pre_order_product() ) ) {
return false;
}
foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
$_product = apply_filters( 'woocommerce_cart_item_product', $cart_item['data'], $cart_item, $cart_item_key );
if ( ! in_array( $_product->get_type(), $this->supported_product_types(), true ) ) {
return false;
}
/**
* Filter whether product supports Payment Request Button on cart page.
*
* @param boolean $is_supported Whether product supports Payment Request Button on cart page.
* @param object $_product Product object.
*
* @since 6.9.0
*/
if ( ! apply_filters( 'wcpay_payment_request_is_cart_supported', true, $_product ) ) {
return false;
}
// Trial subscriptions with shipping are not supported.
if ( class_exists( 'WC_Subscriptions_Product' ) && WC_Subscriptions_Product::is_subscription( $_product ) && $_product->needs_shipping() && WC_Subscriptions_Product::get_trial_length( $_product ) > 0 ) {
return false;
}
}
// We don't support multiple packages with Payment Request Buttons because we can't offer a good UX.
$packages = WC()->cart->get_shipping_packages();
if ( 1 < ( is_countable( $packages ) ? count( $packages ) : 0 ) ) {
return false;
}
return true;
}
/**
* Checks whether cart contains a subscription product or this is a subscription product page.
*
* @return boolean
*/
public function has_subscription_product() {
if ( ! class_exists( 'WC_Subscriptions_Product' ) ) {
return false;
}
if ( $this->express_checkout_helper->is_product() ) {
$product = $this->express_checkout_helper->get_product();
if ( WC_Subscriptions_Product::is_subscription( $product ) ) {
return true;
}
}
if ( $this->express_checkout_helper->is_checkout() || $this->express_checkout_helper->is_cart() ) {
if ( WC_Subscriptions_Cart::cart_contains_subscription() ) {
return true;
}
}
return false;
}
/**
* Returns the login redirect URL.
*
* @param string $redirect Default redirect URL.
*
* @return string Redirect URL.
*/
public function get_login_redirect_url( $redirect ) {
$url = esc_url_raw( wp_unslash( $_COOKIE['wcpay_payment_request_redirect_url'] ?? '' ) );
if ( empty( $url ) ) {
return $redirect;
}
wc_setcookie( 'wcpay_payment_request_redirect_url', '' );
return $url;
}
/**
* Load public scripts and styles.
*/
public function scripts() {
// Don't load scripts if page is not supported.
if ( ! $this->should_show_payment_request_button() ) {
return;
}
$payment_request_params = [
'ajax_url' => admin_url( 'admin-ajax.php' ),
'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ),
'stripe' => [
'publishableKey' => $this->account->get_publishable_key( WC_Payments::mode()->is_test() ),
'accountId' => $this->account->get_stripe_account_id(),
'locale' => WC_Payments_Utils::convert_to_stripe_locale( get_locale() ),
],
'nonce' => [
'get_cart_details' => wp_create_nonce( 'wcpay-get-cart-details' ),
'shipping' => wp_create_nonce( 'wcpay-payment-request-shipping' ),
'update_shipping' => wp_create_nonce( 'wcpay-update-shipping-method' ),
'checkout' => wp_create_nonce( 'woocommerce-process_checkout' ),
'add_to_cart' => wp_create_nonce( 'wcpay-add-to-cart' ),
'empty_cart' => wp_create_nonce( 'wcpay-empty-cart' ),
'get_selected_product_data' => wp_create_nonce( 'wcpay-get-selected-product-data' ),
'platform_tracker' => wp_create_nonce( 'platform_tracks_nonce' ),
'pay_for_order' => wp_create_nonce( 'pay_for_order' ),
'tokenized_cart_nonce' => wp_create_nonce( 'woopayments_tokenized_cart_nonce' ),
'tokenized_order_nonce' => wp_create_nonce( 'wc_store_api' ),
],
'checkout' => [
'currency_code' => strtolower( get_woocommerce_currency() ),
'currency_decimals' => WC_Payments::get_localization_service()->get_currency_format( get_woocommerce_currency() )['num_decimals'],
'country_code' => substr( get_option( 'woocommerce_default_country' ), 0, 2 ),
'needs_shipping' => WC()->cart->needs_shipping(),
// Defaults to 'required' to match how core initializes this option.
'needs_payer_phone' => 'required' === get_option( 'woocommerce_checkout_phone_field', 'required' ),
],
'button' => $this->get_button_settings(),
'login_confirmation' => $this->get_login_confirmation_settings(),
'has_block' => has_block( 'woocommerce/cart' ) || has_block( 'woocommerce/checkout' ),
'product' => $this->get_product_data(),
'total_label' => $this->express_checkout_helper->get_total_label(),
'button_context' => $this->express_checkout_helper->get_button_context(),
'is_product_page' => $this->express_checkout_helper->is_product(),
'is_pay_for_order' => $this->express_checkout_helper->is_pay_for_order_page(),
'is_checkout_page' => $this->express_checkout_helper->is_checkout(),
];
if ( WC_Payments_Features::is_tokenized_cart_prb_enabled() && ( $this->express_checkout_helper->is_product() || $this->express_checkout_helper->is_pay_for_order_page() || $this->express_checkout_helper->is_cart() || $this->express_checkout_helper->is_checkout() ) ) {
WC_Payments::register_script_with_dependencies(
'WCPAY_PAYMENT_REQUEST',
'dist/tokenized-payment-request',
[
'jquery',
'stripe',
]
);
WC_Payments_Utils::enqueue_style(
'WCPAY_PAYMENT_REQUEST',