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
|
<?php
declare( strict_types=1 );
namespace Automattic\WooCommerce\Internal\Orders;
use Automattic\WooCommerce\Utilities\StringUtil;
use WC_Abstract_Order;
/**
* Class PaymentInfo.
*/
class PaymentInfo {
/**
* This array must contain all the names of the files in the CardIcons directory (without extension),
* except 'unknown'.
*/
private const KNOWN_CARD_BRANDS = array(
'amex',
'diners',
'discover',
'interac',
'jcb',
'mastercard',
'visa',
);
/**
* Get info about the card used for payment on an order.
*
* @param WC_Abstract_Order $order The order in question.
*
* @return array
*/
public static function get_card_info( WC_Abstract_Order $order ): array {
$method = $order->get_payment_method();
/**
* Filter to allow payment gateways to provide payment card info for an order.
*
* @since 9.5.0
*
* @param array|null $info The card info.
* @param WC_Abstract_Order $order The order.
*/
$info = apply_filters( 'wc_order_payment_card_info', array(), $order );
if ( ! is_array( $info ) ) {
$info = array();
}
// Fallback for WooPayments.
if ( empty( $info ) && 'woocommerce_payments' === $method ) {
$info = self::get_wcpay_card_info( $order );
}
$defaults = array(
'payment_method' => $method,
'brand' => '',
'icon' => '',
'last4' => '',
);
$info = wp_parse_args( $info, $defaults );
if ( empty( $info['icon'] ) ) {
$info['icon'] = self::get_card_icon( $info['brand'] );
}
return $info;
}
/**
* Generate a CSS-compatible SVG icon of a card brand.
*
* @param string $brand The brand of the card.
*
* @return string
*/
private static function get_card_icon( ?string $brand ): string {
$brand = strtolower( (string) $brand );
if ( ! in_array( $brand, self::KNOWN_CARD_BRANDS, true ) ) {
$brand = 'unknown';
}
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
return base64_encode( file_get_contents( __DIR__ . "/CardIcons/{$brand}.svg" ) );
}
/**
* Get info about the card used for payment on an order, when the payment gateway is WooPayments.
*
* @see https://docs.stripe.com/api/charges/object#charge_object-payment_method_details
*
* @param WC_Abstract_Order $order The order in question.
*
* @return array
*/
private static function get_wcpay_card_info( WC_Abstract_Order $order ): array {
if ( 'woocommerce_payments' !== $order->get_payment_method() ) {
return array();
}
// This is a Woo-specific meta key, not used within WooPayments.
$cache_meta_key = '_wcpay_raw_payment_method_details';
$payment_details = null;
$stored_payment_details = $order->get_meta( $cache_meta_key );
if ( is_string( $stored_payment_details ) && strlen( $stored_payment_details ) > 0 ) {
$payment_details = json_decode( $stored_payment_details, true );
}
if ( ! $payment_details ) {
if ( ! class_exists( \WC_Payments::class ) ) {
return array();
}
$payment_method_id = $order->get_meta( '_payment_method_id' );
if ( ! $payment_method_id ) {
return array();
}
try {
$payment_details = \WC_Payments::get_payments_api_client()->get_payment_method( $payment_method_id );
} catch ( \Throwable $ex ) {
$order_id = $order->get_id();
$message = $ex->getMessage();
wc_get_logger()->error(
sprintf(
'%s - retrieving info for payment method %s for order %s: %s',
StringUtil::class_name_without_namespace( static::class ),
$payment_method_id,
$order_id,
$message
),
array(
'source' => 'payment-info',
)
);
return array();
}
// Cache payment method details.
$order->update_meta_data( $cache_meta_key, wp_json_encode( $payment_details ) );
$order->save_meta_data();
}
$card_info = array();
if ( isset( $payment_details['type'], $payment_details[ $payment_details['type'] ] ) ) {
$details = $payment_details[ $payment_details['type'] ];
switch ( $payment_details['type'] ) {
case 'card':
default:
$card_info['brand'] = $details['brand'] ?? '';
$card_info['last4'] = $details['last4'] ?? '';
break;
case 'card_present':
case 'interac_present':
$card_info['brand'] = $details['brand'] ?? '';
$card_info['last4'] = $details['last4'] ?? '';
$card_info['account_type'] = $details['receipt']['account_type'] ?? '';
$card_info['aid'] = $details['receipt']['dedicated_file_name'] ?? '';
$card_info['app_name'] = $details['receipt']['application_preferred_name'] ?? '';
break;
}
}
return array_map( 'sanitize_text_field', $card_info );
}
}
|