UPSShippingProvider.php — WooCommerce 10.9.4

woocommerce / src / Admin / Features / Fulfillments / Providers / UPSShippingProvider.php

woocommerce / src / Admin / Features / Fulfillments / Providers Last commit date

UPSShippingProvider.php

183 lines

1	<?php declare(strict_types=1);
2
3	namespace Automattic\WooCommerce\Admin\Features\Fulfillments\Providers;
4
5	use Automattic\WooCommerce\Admin\Features\Fulfillments\FulfillmentUtils;
6
7	/**
8	* UPS Shipping Provider class.
9	*/
10	class UPSShippingProvider extends AbstractShippingProvider {
11	/**
12	* Countries that support international UPS shipping.
13	*
14	* @var array
15	*/
16	private array $international_shipping_countries = array( 'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BQ', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF', 'BI', 'CV', 'KH', 'CM', 'CA', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CD', 'CG', 'CK', 'CR', 'CI', 'HR', 'CU', 'CW', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'SZ', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'KR', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MK', 'MP', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'SS', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU', 'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW' );
17
18	/**
19	* Countries that support domestic UPS shipping.
20	*
21	* @var array
22	*/
23	private array $domestic_shipping_countries = array( 'US', 'CA', 'MX', 'BR', 'AR', 'CL', 'CO', 'PE', 'CR', 'PR', 'DE', 'GB', 'FR', 'IT', 'ES', 'NL', 'BE', 'PL', 'SE', 'DK', 'AT', 'CH', 'PT', 'IE', 'CZ', 'HU', 'FI', 'NO', 'CN', 'HK', 'IN', 'JP', 'KR', 'SG', 'MY', 'TH', 'VN', 'PH', 'AU', 'NZ', 'AE', 'SA', 'ZA', 'TR', 'IL', 'KE', 'NG' );
24
25	/**
26	* Countries that support UPS domestic shipping but use international tracking formats.
27	*
28	* @var array
29	*/
30	private array $domestic_but_international_tracking = array( 'IN', 'ZA', 'VN', 'NG', 'PR', 'HK', 'MO', 'CN', 'BR', 'KE' );
31
32	/**
33	* Get the key of the shipping provider.
34	*
35	* @return string
36	*/
37	public function get_key(): string {
38	return 'ups';
39	}
40
41	/**
42	* Get the name of the shipping provider.
43	*
44	* @return string
45	*/
46	public function get_name(): string {
47	return 'UPS';
48	}
49
50	/**
51	* Get the path of the icon of the shipping provider.
52	*
53	* @return string
54	*/
55	public function get_icon(): string {
56	return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/ups.png';
57	}
58
59	/**
60	* Get the tracking URL for a given tracking number.
61	*
62	* @param string $tracking_number The tracking number.
63	* @return string The tracking URL.
64	*/
65	public function get_tracking_url( string $tracking_number ): string {
66	return 'https://www.ups.com/track?tracknum=' . rawurlencode( $tracking_number );
67	}
68
69	/**
70	* Get the countries from which this provider can ship.
71	*
72	* @return array An array of country codes.
73	*/
74	public function get_shipping_from_countries(): array {
75	return $this->international_shipping_countries;
76	}
77
78	/**
79	* Get the countries to which this provider can ship.
80	*
81	* @return array An array of country codes.
82	*/
83	public function get_shipping_to_countries(): array {
84	return $this->international_shipping_countries;
85	}
86
87	/**
88	* Check if this provider can ship from a specific country.
89	*
90	* @param string $shipping_from The country code from which the shipment is sent.
91	* @param string $shipping_to The country code to which the shipment is sent.
92	*
93	* @return bool True if this provider can ship from the country, false otherwise.
94	*/
95	public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
96	if ( $shipping_from === $shipping_to ) {
97	return in_array( $shipping_from, $this->domestic_shipping_countries, true ) \|\|
98	in_array( $shipping_from, $this->domestic_but_international_tracking, true );
99	} else {
100	return in_array( $shipping_from, $this->international_shipping_countries, true ) &&
101	in_array( $shipping_to, $this->international_shipping_countries, true );
102	}
103	}
104
105	/**
106	* Try to parse the tracking number with additional parameters.
107	*
108	* @param string $tracking_number The tracking number.
109	* @param string $shipping_from The country code from which the shipment is sent.
110	* @param string $shipping_to The country code to which the shipment is sent.
111	*
112	* @return array\|null The tracking URL with ambiguity score, or null if parsing fails.
113	*/
114	public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): ?array {
115	if ( empty( $tracking_number ) \|\| empty( $shipping_from ) \|\| empty( $shipping_to ) \|\| ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
116	return null;
117	}
118
119	$tracking_number = strtoupper( $tracking_number );
120	$is_domestic_shipping = $shipping_from === $shipping_to;
121
122	// UPS tracking number patterns (ordered by confidence).
123	$patterns = array(
124	// 1Z format (standard UPS) - 18 chars, check digit validation.
125	'/^1Z[0-9A-Z]{16}$/' => function () use ( $tracking_number ) {
126	return FulfillmentUtils::validate_ups_1z_check_digit( $tracking_number ) ? 100 : 95;
127	},
128
129	// Numeric only: 12 digits (common for UPS Air/Ground, with mod10 check digit).
130	'/^\d{12}$/' => function () use ( $tracking_number ) {
131	return FulfillmentUtils::validate_mod10_check_digit( $tracking_number ) ? 90 : 80;
132	},
133
134	// Numeric only: 9 or 10 digits (legacy/freight).
135	'/^\d{10}$/' => 75,
136	'/^\d{9}$/' => 70,
137
138	// T, H, or V prefix + 10 digits (special international/freight).
139	'/^[THV]\d{10}$/' => 85,
140
141	// UPS InfoNotice (J + 10 digits).
142	'/^J\d{10}$/' => 80,
143
144	// UPS Mail Innovations Parcel ID (MI + 6 digits + up to 22 alphanum).
145	'/^MI\d{6}[A-Z0-9]{6,22}$/' => 80,
146
147	// USPS Delivery Confirmation (Mail Innovations, 22–34 digits).
148	'/^9\d{21,33}$/' => function () use ( $shipping_from ) {
149	return in_array( $shipping_from, array( 'US', 'CA' ), true ) ? 85 : 70;
150	},
151
152	// UPU S10 format (international, e.g. 'AA123456789CC').
153	'/^[A-Z]{2}\d{9}[A-Z]{2}$/' => function () use ( $shipping_from ) {
154	return in_array( $shipping_from, $this->domestic_but_international_tracking, true ) ? 80 : 65;
155	},
156
157	// Long mail format (22 digits).
158	'/^\d{22}$/' => 60,
159	);
160
161	$match = false;
162	$ambiguity_score = 0;
163
164	foreach ( $patterns as $pattern => $score ) {
165	if ( preg_match( $pattern, $tracking_number ) ) {
166	$match = true;
167	$ambiguity_score = is_callable( $score ) ? $score() : $score;
168	break;
169	}
170	}
171
172	// Boost score for domestic-but-international-tracking countries.
173	if ( $match && $is_domestic_shipping && in_array( $shipping_from, $this->domestic_but_international_tracking, true ) ) {
174	$ambiguity_score += 5;
175	}
176
177	return $match ? array(
178	'url' => $this->get_tracking_url( $tracking_number ),
179	'ambiguity_score' => $ambiguity_score,
180	) : null;
181	}
182	}
183