class-wc-payments-platform-checkout-button-handler.php
15.4 KB
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
<?php
/**
* Class WC_Payments_Platform_Checkout_Button_Handler
* Adds support for the WooPay express checkout button.
*
* Borrowed heavily from the WC_Payments_Payment_Request_Button_Handler class.
*
* @package WooCommerce\Payments
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
// TODO: Not sure which of these are needed yet.
use WCPay\Exceptions\Invalid_Price_Exception;
use WCPay\Logger;
use WCPay\Payment_Information;
/**
* WC_Payments_Platform_Checkout_Button_Handler class.
*/
class WC_Payments_Platform_Checkout_Button_Handler {
/**
* 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;
/**
* Initialize class actions.
*
* @param WC_Payments_Account $account Account information.
* @param WC_Payment_Gateway_WCPay $gateway WCPay gateway.
*/
public function __construct( WC_Payments_Account $account, WC_Payment_Gateway_WCPay $gateway ) {
$this->account = $account;
$this->gateway = $gateway;
add_action( 'init', [ $this, 'init' ] );
}
/**
* Initialize hooks.
*
* @return void
*/
public function init() {
// Checks if WCPay is enabled.
if ( ! $this->gateway->is_enabled() ) {
return;
}
// Checks if WooPay is enabled.
$is_platform_checkout_eligible = WC_Payments_Features::is_platform_checkout_eligible(); // Feature flag.
$is_platform_checkout_enabled = 'yes' === $this->gateway->get_option( 'platform_checkout', 'no' );
$is_platform_checkout_express_button_enabled = WC_Payments_Features::is_woopay_express_checkout_enabled();
if ( ! ( $is_platform_checkout_eligible && $is_platform_checkout_enabled && $is_platform_checkout_express_button_enabled ) ) {
return;
}
// Don't load for change payment method page.
if ( isset( $_GET['change_payment_method'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
return;
}
add_action( 'wp_enqueue_scripts', [ $this, 'scripts' ] );
add_filter( 'wcpay_payment_fields_js_config', [ $this, 'add_platform_checkout_config' ] );
add_action( 'wc_ajax_wcpay_add_to_cart', [ $this, 'ajax_add_to_cart' ] );
add_action( 'woocommerce_after_add_to_cart_quantity', [ $this, 'display_platform_checkout_button_html' ], -2 );
add_action( 'woocommerce_after_add_to_cart_quantity', [ $this, 'display_platform_checkout_button_separator_html' ], -1 );
add_action( 'woocommerce_proceed_to_checkout', [ $this, 'display_platform_checkout_button_html' ], -2 );
add_action( 'woocommerce_proceed_to_checkout', [ $this, 'display_platform_checkout_button_separator_html' ], -1 );
add_action( 'woocommerce_checkout_before_customer_details', [ $this, 'display_platform_checkout_button_html' ], -2 );
add_action( 'woocommerce_checkout_before_customer_details', [ $this, 'display_platform_checkout_button_separator_html' ], -1 );
add_action( 'wp_ajax_woopay_express_checkout_button_show_error_notice', [ $this, 'show_error_notice' ] );
add_action( 'wp_ajax_nopriv_woopay_express_checkout_button_show_error_notice', [ $this, 'show_error_notice' ] );
}
/**
* Add the platform checkout button config to wcpay_config.
*
* @param array $config The existing config array.
*
* @return array The modified config array.
*/
public function add_platform_checkout_config( $config ) {
$config['platformCheckoutButton'] = $this->get_button_settings();
$config['platformCheckoutButtonNonce'] = wp_create_nonce( 'platform_checkout_button_nonce' );
$config['addToCartNonce'] = wp_create_nonce( 'wcpay-add-to-cart' );
return $config;
}
/**
* Load public scripts and styles.
*/
public function scripts() {
// Don't load scripts if we should not show the button.
if ( ! $this->should_show_platform_checkout_button() ) {
return;
}
$script_src_url = plugins_url( 'dist/platform-checkout-express-button.js', WCPAY_PLUGIN_FILE );
$script_asset_path = WCPAY_ABSPATH . 'dist/platform-checkout-express-button.asset.php';
$script_asset = file_exists( $script_asset_path ) ? require $script_asset_path : [ 'dependencies' => [] ];
wp_register_script( 'WCPAY_PLATFORM_CHECKOUT_EXPRESS_BUTTON', $script_src_url, $script_asset['dependencies'], WC_Payments::get_file_version( 'dist/platform-checkout-express-button.js' ), true );
$wcpay_config = rawurlencode( wp_json_encode( WC_Payments::get_wc_payments_checkout()->get_payment_fields_js_config() ) );
wp_add_inline_script(
'WCPAY_PLATFORM_CHECKOUT_EXPRESS_BUTTON',
"
var wcpay_config = wcpay_config || JSON.parse( decodeURIComponent( '" . esc_js( $wcpay_config ) . "' ) );
",
'before'
);
wp_set_script_translations( 'WCPAY_PLATFORM_CHECKOUT_EXPRESS_BUTTON', 'woocommerce-payments' );
wp_enqueue_script( 'WCPAY_PLATFORM_CHECKOUT_EXPRESS_BUTTON' );
wp_register_style(
'WCPAY_PLATFORM_CHECKOUT',
plugins_url( 'dist/platform-checkout.css', WCPAY_PLUGIN_FILE ),
[],
WCPAY_VERSION_NUMBER
);
wp_enqueue_style( 'WCPAY_PLATFORM_CHECKOUT' );
}
/**
* Returns the error notice HTML.
*/
public function show_error_notice() {
$is_nonce_valid = check_ajax_referer( 'platform_checkout_button_nonce', false, false );
if ( ! $is_nonce_valid ) {
wp_send_json_error(
__( 'You aren’t authorized to do that.', 'woocommerce-payments' ),
403
);
}
$message = isset( $_POST['message'] ) ? sanitize_text_field( wp_unslash( $_POST['message'] ) ) : '';
// $message has already been translated.
wc_add_notice( $message, 'error' );
$notice = wc_print_notices( true );
wp_send_json_success(
[
'notice' => $notice,
]
);
wp_die();
}
/**
* Adds the current product to the cart. Used on product detail page.
*/
public function ajax_add_to_cart() {
check_ajax_referer( 'wcpay-add-to-cart', 'security' );
if ( ! defined( 'WOOCOMMERCE_CART' ) ) {
define( 'WOOCOMMERCE_CART', true );
}
WC()->shipping->reset_shipping();
$product_id = isset( $_POST['product_id'] ) ? absint( $_POST['product_id'] ) : false;
$qty = ! isset( $_POST['qty'] ) ? 1 : absint( $_POST['qty'] );
$product = wc_get_product( $product_id );
$product_type = $product->get_type();
// First empty the cart to prevent wrong calculation.
WC()->cart->empty_cart();
if ( ( 'variable' === $product_type || 'variable-subscription' === $product_type ) && isset( $_POST['attributes'] ) ) {
$attributes = wc_clean( wp_unslash( $_POST['attributes'] ) );
$data_store = WC_Data_Store::load( 'product' );
$variation_id = $data_store->find_matching_product_variation( $product, $attributes );
WC()->cart->add_to_cart( $product->get_id(), $qty, $variation_id, $attributes );
}
if ( 'simple' === $product_type || 'subscription' === $product_type ) {
WC()->cart->add_to_cart( $product->get_id(), $qty );
}
WC()->cart->calculate_totals();
$data = [];
$data += $this->build_display_items();
$data['result'] = 'success';
wp_send_json( $data );
}
/**
* Builds the line items to pass to Payment Request
*
* @param boolean $itemized_display_items Indicates whether to show subtotals or itemized views.
*/
protected function build_display_items( $itemized_display_items = false ) {
if ( ! defined( 'WOOCOMMERCE_CART' ) ) {
define( 'WOOCOMMERCE_CART', true );
}
$items = [];
$subtotal = 0;
$discounts = 0;
$currency = get_woocommerce_currency();
// Default show only subtotal instead of itemization.
if ( ! apply_filters( 'wcpay_payment_request_hide_itemization', true ) || $itemized_display_items ) {
foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
$amount = $cart_item['line_subtotal'];
$subtotal += $cart_item['line_subtotal'];
$quantity_label = 1 < $cart_item['quantity'] ? ' (x' . $cart_item['quantity'] . ')' : '';
$product_name = $cart_item['data']->get_name();
$item_tax = $this->prices_exclude_tax() ? 0 : ( $cart_item['line_subtotal_tax'] ?? 0 );
$item = [
'label' => $product_name . $quantity_label,
'amount' => WC_Payments_Utils::prepare_amount( $amount + $item_tax, $currency ),
];
$items[] = $item;
}
}
if ( version_compare( WC_VERSION, '3.2', '<' ) ) {
$discounts = wc_format_decimal( WC()->cart->get_cart_discount_total(), WC()->cart->dp );
} else {
$applied_coupons = array_values( WC()->cart->get_coupon_discount_totals() );
foreach ( $applied_coupons as $amount ) {
$discounts += (float) $amount;
}
}
$discounts = wc_format_decimal( $discounts, WC()->cart->dp );
$tax = wc_format_decimal( WC()->cart->tax_total + WC()->cart->shipping_tax_total, WC()->cart->dp );
$shipping = wc_format_decimal( WC()->cart->shipping_total, WC()->cart->dp );
$items_total = wc_format_decimal( WC()->cart->cart_contents_total, WC()->cart->dp ) + $discounts;
$order_total = version_compare( WC_VERSION, '3.2', '<' ) ? wc_format_decimal( $items_total + $tax + $shipping - $discounts, WC()->cart->dp ) : WC()->cart->get_total( '' );
if ( $this->prices_exclude_tax() ) {
$items[] = [
'label' => esc_html( __( 'Tax', 'woocommerce-payments' ) ),
'amount' => WC_Payments_Utils::prepare_amount( $tax, $currency ),
];
}
if ( WC()->cart->needs_shipping() ) {
$shipping_tax = $this->prices_exclude_tax() ? 0 : WC()->cart->shipping_tax_total;
$items[] = [
'label' => esc_html( __( 'Shipping', 'woocommerce-payments' ) ),
'amount' => WC_Payments_Utils::prepare_amount( $shipping + $shipping_tax, $currency ),
];
}
if ( WC()->cart->has_discount() ) {
$items[] = [
'label' => esc_html( __( 'Discount', 'woocommerce-payments' ) ),
'amount' => WC_Payments_Utils::prepare_amount( $discounts, $currency ),
];
}
if ( version_compare( WC_VERSION, '3.2', '<' ) ) {
$cart_fees = WC()->cart->fees;
} else {
$cart_fees = WC()->cart->get_fees();
}
// Include fees and taxes as display items.
foreach ( $cart_fees as $key => $fee ) {
$items[] = [
'label' => $fee->name,
'amount' => WC_Payments_Utils::prepare_amount( $fee->amount, $currency ),
];
}
return [
'displayItems' => $items,
'total' => [
'label' => $this->get_total_label(),
'amount' => max( 0, apply_filters( 'wcpay_calculated_total', WC_Payments_Utils::prepare_amount( $order_total, $currency ), $order_total, WC()->cart ) ),
'pending' => false,
],
];
}
/**
* Whether tax should be displayed on seperate line.
* returns true if tax is enabled & display of tax in checkout is set to exclusive.
*
* @return boolean
*/
private function prices_exclude_tax() {
return wc_tax_enabled() && 'incl' !== get_option( 'woocommerce_tax_display_cart' );
}
/**
* Gets total label.
*
* @return string
*/
public function get_total_label() {
// Get statement descriptor from API/cached account data.
$statement_descriptor = $this->account->get_statement_descriptor();
return str_replace( "'", '', $statement_descriptor ) . apply_filters( 'wcpay_payment_request_total_label_suffix', ' (via WooCommerce)' );
}
/**
* Checks if this is a product page or content contains a product_page shortcode.
*
* @return boolean
*/
public function is_product() {
return is_product() || wc_post_content_has_shortcode( 'product_page' );
}
/**
* Checks if this is the Pay for Order page.
*
* @return boolean
*/
public function is_pay_for_order_page() {
return is_checkout() && isset( $_GET['pay_for_order'] ); // phpcs:ignore WordPress.Security.NonceVerification
}
/**
* Checks if this is the cart page or content contains a cart block.
*
* @return boolean
*/
public function is_cart() {
return is_cart() || has_block( 'woocommerce/cart' );
}
/**
* Checks if this is the checkout page or content contains a cart block.
*
* @return boolean
*/
public function is_checkout() {
return is_checkout() || has_block( 'woocommerce/checkout' );
}
/**
* Checks if payment request is available at a given location.
*
* @param string $location Location.
* @return boolean
*/
public function is_available_at( $location ) {
$available_locations = $this->gateway->get_option( 'platform_checkout_button_locations' );
if ( $available_locations && is_array( $available_locations ) ) {
return in_array( $location, $available_locations, true );
}
return false;
}
/**
* Gets the context for where the button is being displayed.
*
* @return string
*/
public function get_button_context() {
if ( $this->is_product() ) {
return 'product';
}
if ( $this->is_cart() ) {
return 'cart';
}
if ( $this->is_checkout() ) {
return 'checkout';
}
if ( $this->is_pay_for_order_page() ) {
return 'pay_for_order';
}
return '';
}
/**
* 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', 'default' );
return [
'type' => $button_type,
'text' => ucfirst( $button_type ),
'theme' => $this->gateway->get_option( 'payment_request_button_theme', 'dark' ),
'height' => $this->get_button_height(),
'size' => $this->gateway->get_option( 'payment_request_button_size' ),
'context' => $this->get_button_context(),
];
}
/**
* Gets the button height.
*
* @return string
*/
public function get_button_height() {
$height = $this->gateway->get_option( 'payment_request_button_size' );
if ( 'medium' === $height ) {
return '48';
}
if ( 'large' === $height ) {
return '56';
}
// for the "default" and "catch-all" scenarios.
return '40';
}
/**
* Checks whether Payment Request Button should be available on this page.
*
* @return bool
*/
public function should_show_platform_checkout_button() {
// Page not supported.
if ( ! $this->is_product() && ! $this->is_cart() && ! $this->is_checkout() ) {
return false;
}
// Product page, but not available in settings.
if ( $this->is_product() && ! $this->is_available_at( 'product' ) ) {
return false;
}
// Checkout page, but not available in settings.
if ( $this->is_checkout() && ! $this->is_available_at( 'checkout' ) ) {
return false;
}
// Cart page, but not available in settings.
if ( $this->is_cart() && ! $this->is_available_at( 'cart' ) ) {
return false;
}
/**
* TODO: We need to do some research here and see if there are any product types that we
* absolutely cannot support with WooPay at this time. There are some examples in the
* `WC_Payments_Payment_Request_Button_Handler->is_product_supported()` method.
*/
return true;
}
/**
* Display the payment request button.
*/
public function display_platform_checkout_button_html() {
if ( ! $this->should_show_platform_checkout_button() ) {
return;
}
?>
<div id="wcpay-payment-request-wrapper" style="clear:both;padding-top:1.5em;">
<div id="wcpay-platform-checkout-button" data-product_page=<?php echo esc_attr( $this->is_product() ); ?>>
<?php // The WooPay express checkout button React component will go here. ?>
</div>
</div>
<?php
}
/**
* Display payment request button separator.
*/
public function display_platform_checkout_button_separator_html() {
if ( ! $this->should_show_platform_checkout_button() ) {
return;
}
?>
<p id="wcpay-payment-request-button-separator" style="margin-top:1.5em;text-align:center;">— <?php esc_html_e( 'OR', 'woocommerce-payments' ); ?> —</p>
<?php
}
}