DPDShippingProvider.php — WooCommerce 10.9.4

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

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

DPDShippingProvider.php

468 lines

1	<?php declare(strict_types=1);
2
3	namespace Automattic\WooCommerce\Admin\Features\Fulfillments\Providers;
4
5	/**
6	* DPD Shipping Provider class.
7	*
8	* Provides DPD tracking number validation, supported countries, and tracking URL generation.
9	*/
10	class DPDShippingProvider extends AbstractShippingProvider {
11
12	/**
13	* DPD tracking number patterns by country with service differentiation.
14	*
15	* @var array<string, array{patterns: array<int, string>, confidence: int, services?: array<string, int>}>
16	*/
17	private const TRACKING_PATTERNS = array(
18	'DE' => array( // Germany.
19	'patterns' => array(
20	'/^\d{14}$/',
21	'/^\d{12}$/',
22	'/^02\d{12}$/', // DPD Classic.
23	'/^05\d{12}$/', // DPD Express.
24	'/^09\d{12}$/', // DPD Predict.
25	'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
26	'/^\d{24}$/', // 24-digit fallback.
27	),
28	'confidence' => 80,
29	'services' => array(
30	'classic' => 80,
31	'express' => 85,
32	'predict' => 85,
33	's10' => 90,
34	),
35	),
36	'GB' => array( // United Kingdom.
37	'patterns' => array(
38	'/^\d{14}$/',
39	'/^[A-Z]{2}\d{9}GB$/',
40	'/^03\d{12}$/', // DPD Next Day.
41	'/^06\d{12}$/', // DPD Express.
42	'/^1[56]\d{12}$/', // Predict/Return.
43	'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
44	'/^\d{24}$/', // 24-digit fallback.
45	),
46	'confidence' => 90,
47	'services' => array(
48	'next_day' => 88,
49	'express' => 88,
50	's10' => 90,
51	),
52	),
53	'FR' => array( // France.
54	'patterns' => array(
55	'/^\d{14}$/',
56	'/^\d{12}$/',
57	'/^02\d{12}$/', // DPD Relais.
58	'/^04\d{12}$/', // DPD Predict.
59	'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
60	'/^\d{24}$/', // 24-digit fallback.
61	),
62	'confidence' => 78,
63	'services' => array(
64	'relais' => 82,
65	'predict' => 82,
66	's10' => 90,
67	),
68	),
69	'NL' => array( // Netherlands.
70	'patterns' => array(
71	'/^\d{14}$/',
72	'/^\d{12}$/',
73	'/^03\d{12}$/', // DPD Classic.
74	'/^07\d{12}$/', // DPD Express.
75	'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
76	'/^\d{24}$/', // 24-digit fallback.
77	),
78	'confidence' => 78,
79	'services' => array(
80	'classic' => 82,
81	'express' => 85,
82	's10' => 90,
83	),
84	),
85	'BE' => array( // Belgium.
86	'patterns' => array(
87	'/^\d{14}$/',
88	'/^\d{12}$/',
89	'/^03\d{12}$/', // DPD Classic.
90	'/^08\d{12}$/', // DPD Express.
91	'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
92	'/^\d{24}$/', // 24-digit fallback.
93	),
94	'confidence' => 78,
95	'services' => array(
96	'classic' => 82,
97	'express' => 85,
98	's10' => 90,
99	),
100	),
101	'PL' => array( // Poland.
102	'patterns' => array(
103	'/^\d{14}$/',
104	'/^[A-Z]{2}\d{10}$/',
105	'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
106	'/^\d{24}$/', // 24-digit fallback.
107	),
108	'confidence' => 90,
109	),
110	'IE' => array( // Ireland.
111	'patterns' => array(
112	'/^\d{14}$/',
113	'/^[A-Z]{2}\d{9}IE$/',
114	),
115	'confidence' => 85,
116	),
117	'AT' => array( // Austria.
118	'patterns' => array(
119	'/^\d{14}$/',
120	'/^\d{12}$/',
121	),
122	'confidence' => 75, // Reduced: generic patterns.
123	),
124	'CH' => array( // Switzerland.
125	'patterns' => array(
126	'/^\d{14}$/',
127	'/^[A-Z]{2}\d{9}CH$/',
128	),
129	'confidence' => 85,
130	),
131	'ES' => array( // Spain.
132	'patterns' => array(
133	'/^\d{14}$/',
134	'/^[A-Z]{2}\d{10}$/',
135	),
136	'confidence' => 85,
137	),
138	'IT' => array( // Italy.
139	'patterns' => array(
140	'/^\d{14}$/',
141	'/^[A-Z]{2}\d{10}$/',
142	),
143	'confidence' => 85,
144	),
145	'LU' => array( // Luxembourg.
146	'patterns' => array(
147	'/^\d{14}$/',
148	'/^\d{12}$/',
149	),
150	'confidence' => 75, // Reduced: generic patterns.
151	),
152	'CZ' => array( // Czech Republic.
153	'patterns' => array(
154	'/^\d{14}$/',
155	'/^[A-Z]{2}\d{10}$/',
156	),
157	'confidence' => 90,
158	),
159	'SK' => array( // Slovakia.
160	'patterns' => array(
161	'/^\d{14}$/',
162	'/^[A-Z]{2}\d{10}$/',
163	),
164	'confidence' => 90,
165	),
166	'HU' => array( // Hungary.
167	'patterns' => array(
168	'/^\d{14}$/',
169	'/^[A-Z]{2}\d{10}$/',
170	),
171	'confidence' => 90,
172	),
173	'SI' => array( // Slovenia.
174	'patterns' => array(
175	'/^\d{14}$/',
176	'/^[A-Z]{2}\d{10}$/',
177	),
178	'confidence' => 80,
179	),
180	'HR' => array( // Croatia.
181	'patterns' => array(
182	'/^\d{14}$/',
183	'/^[A-Z]{2}\d{10}$/',
184	),
185	'confidence' => 80,
186	),
187	'RO' => array( // Romania.
188	'patterns' => array(
189	'/^\d{14}$/',
190	'/^[A-Z]{2}\d{10}$/',
191	),
192	'confidence' => 75,
193	),
194	'BG' => array( // Bulgaria.
195	'patterns' => array(
196	'/^\d{14}$/',
197	'/^[A-Z]{2}\d{10}$/',
198	),
199	'confidence' => 70,
200	),
201	'LT' => array( // Lithuania.
202	'patterns' => array(
203	'/^\d{14}$/',
204	'/^\d{12}$/',
205	),
206	'confidence' => 70, // Reduced: generic patterns, limited DPD presence.
207	),
208	'LV' => array( // Latvia.
209	'patterns' => array(
210	'/^\d{14}$/',
211	'/^\d{12}$/',
212	),
213	'confidence' => 70, // Reduced: generic patterns, limited DPD presence.
214	),
215	'EE' => array( // Estonia.
216	'patterns' => array(
217	'/^\d{14}$/',
218	'/^\d{12}$/',
219	),
220	'confidence' => 70, // Reduced: generic patterns, limited DPD presence.
221	),
222	'FI' => array( // Finland.
223	'patterns' => array(
224	'/^\d{14}$/',
225	'/^\d{12}$/',
226	),
227	'confidence' => 65, // Reduced: partnership-based, not direct DPD.
228	),
229	'DK' => array( // Denmark.
230	'patterns' => array(
231	'/^\d{14}$/',
232	'/^\d{12}$/',
233	),
234	'confidence' => 65, // Reduced: partnership-based, not direct DPD.
235	),
236	'SE' => array( // Sweden.
237	'patterns' => array(
238	'/^\d{14}$/',
239	'/^\d{12}$/',
240	),
241	'confidence' => 65, // Reduced: partnership-based, not direct DPD.
242	),
243	'NO' => array( // Norway.
244	'patterns' => array(
245	'/^\d{14}$/',
246	'/^\d{12}$/',
247	),
248	'confidence' => 60, // Reduced: limited DPD presence.
249	),
250	'GR' => array( // Greece.
251	'patterns' => array(
252	'/^\d{14}$/',
253	'/^[A-Z]{2}\d{10}$/',
254	),
255	'confidence' => 85,
256	),
257	'PT' => array( // Portugal.
258	'patterns' => array(
259	'/^\d{14}$/',
260	'/^[A-Z]{2}\d{10}$/',
261	),
262	'confidence' => 85,
263	),
264	);
265
266	/**
267	* International shipment pattern (28 digits)
268	*/
269	private const INTERNATIONAL_PATTERN = '/^\d{28}$/';
270
271	/**
272	* S10/UPU international pattern.
273	*/
274	private const S10_PATTERN = '/^[A-Z]{2}\d{9}[A-Z]{2}$/';
275
276	/**
277	* Get the unique key for this shipping provider.
278	*
279	* @return string Unique key.
280	*/
281	public function get_key(): string {
282	return 'dpd';
283	}
284
285	/**
286	* Get the name of this shipping provider.
287	*
288	* @return string Name of the shipping provider.
289	*/
290	public function get_name(): string {
291	return 'DPD';
292	}
293
294	/**
295	* Get the icon URL for this shipping provider.
296	*
297	* @return string URL of the shipping provider icon.
298	*/
299	public function get_icon(): string {
300	return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/dpd.png';
301	}
302
303	/**
304	* Get the description of this shipping provider.
305	*
306	* @return array Description of the shipping provider.
307	*/
308	public function get_shipping_from_countries(): array {
309	return array_keys( self::TRACKING_PATTERNS );
310	}
311
312	/**
313	* Get the countries this shipping provider can ship to.
314	*
315	* DPD typically ships within Europe, so we return the same countries as shipping from.
316	*
317	* @return array List of country codes.
318	*/
319	public function get_shipping_to_countries(): array {
320	return $this->get_shipping_from_countries();
321	}
322
323	/**
324	* Get the tracking URL for a given tracking number.
325	*
326	* @param string $tracking_number The tracking number to generate the URL for.
327	* @return string The tracking URL.
328	*/
329	public function get_tracking_url( string $tracking_number ): string {
330	return 'https://www.dpd.com/tracking/' . rawurlencode( $tracking_number );
331	}
332
333	/**
334	* Validate tracking number against country-specific patterns and determine service type.
335	*
336	* @param string $tracking_number The tracking number to validate.
337	* @param string $country_code The country code for the shipment.
338	* @return array\|bool Array with service info if valid, false otherwise.
339	*/
340	private function validate_country_pattern( string $tracking_number, string $country_code ) {
341	if ( ! isset( self::TRACKING_PATTERNS[ $country_code ] ) ) {
342	return false;
343	}
344
345	$country_data = self::TRACKING_PATTERNS[ $country_code ];
346	$detected_service = null;
347	$confidence_boost = 0;
348
349	// Check service-specific patterns first.
350	if ( isset( $country_data['services'] ) ) {
351	if ( preg_match( '/^02\d{12}$/', $tracking_number ) ) {
352	$detected_service = 'classic';
353	$confidence_boost = $country_data['services']['classic'] ?? 0;
354	} elseif ( preg_match( '/^0[34578]\d{12}$/', $tracking_number ) ) {
355	$detected_service = 'express';
356	$confidence_boost = $country_data['services']['express'] ?? 0;
357	} elseif ( preg_match( '/^0[49]\d{12}$/', $tracking_number ) ) {
358	$detected_service = 'predict';
359	$confidence_boost = $country_data['services']['predict'] ?? 0;
360	} elseif ( preg_match( '/^03\d{12}$/', $tracking_number ) && 'GB' === $country_code ) {
361	$detected_service = 'next_day';
362	$confidence_boost = $country_data['services']['next_day'] ?? 0;
363	} elseif ( preg_match( '/^02\d{12}$/', $tracking_number ) && 'FR' === $country_code ) {
364	$detected_service = 'relais';
365	$confidence_boost = $country_data['services']['relais'] ?? 0;
366	} elseif ( preg_match( self::S10_PATTERN, $tracking_number ) ) {
367	$detected_service = 's10';
368	$confidence_boost = $country_data['services']['s10'] ?? 90;
369	}
370	}
371
372	// Check all patterns.
373	foreach ( $country_data['patterns'] as $pattern ) {
374	if ( preg_match( $pattern, $tracking_number ) ) {
375	return array(
376	'valid' => true,
377	'service' => $detected_service,
378	'confidence_boost' => $confidence_boost,
379	);
380	}
381	}
382
383	return false;
384	}
385
386	/**
387	* Try to parse a DPD tracking number.
388	*
389	* @param string $tracking_number The tracking number to parse.
390	* @param string $shipping_from The country code of the shipping origin.
391	* @param string $shipping_to The country code of the shipping destination.
392	* @return array\|null An array with 'url' and 'ambiguity_score' if valid, null otherwise.
393	*/
394	public function try_parse_tracking_number(
395	string $tracking_number,
396	string $shipping_from,
397	string $shipping_to
398	): ?array {
399	if ( empty( $tracking_number ) \|\| empty( $shipping_from ) \|\| empty( $shipping_to ) ) {
400	return null;
401	}
402
403	$normalized = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) );
404	if ( empty( $normalized ) ) {
405	return null;
406	}
407
408	$shipping_from = strtoupper( $shipping_from );
409	$shipping_to = strtoupper( $shipping_to );
410
411	// 1. Check international 28-digit format first.
412	if ( preg_match( self::INTERNATIONAL_PATTERN, $normalized ) ) {
413	if ( in_array( $shipping_from, $this->get_shipping_from_countries(), true ) &&
414	in_array( $shipping_to, $this->get_shipping_to_countries(), true ) ) {
415	return array(
416	'url' => $this->get_tracking_url( $normalized ),
417	'ambiguity_score' => 95,
418	);
419	}
420	return null;
421	}
422
423	// 2. Check S10/UPU format (international DPD).
424	if ( preg_match( self::S10_PATTERN, $normalized ) ) {
425	return array(
426	'url' => $this->get_tracking_url( $normalized ),
427	'ambiguity_score' => 90,
428	);
429	}
430
431	// 3. Check country-specific patterns.
432	$validation_result = $this->validate_country_pattern( $normalized, $shipping_from );
433	if ( $validation_result && is_array( $validation_result ) ) {
434	$confidence = self::TRACKING_PATTERNS[ $shipping_from ]['confidence'];
435
436	// Apply service-specific confidence boost.
437	if ( $validation_result['confidence_boost'] > 0 ) {
438	$confidence = min( 95, $validation_result['confidence_boost'] );
439	}
440
441	// Boost confidence for intra-DPD shipments.
442	if ( in_array( $shipping_to, $this->get_shipping_to_countries(), true ) ) {
443	$confidence = min( 98, $confidence + 3 );
444	}
445
446	// Additional boost for express services.
447	if ( 'express' === $validation_result['service'] ) {
448	$confidence = min( 98, $confidence + 2 );
449	}
450
451	return array(
452	'url' => $this->get_tracking_url( $normalized ),
453	'ambiguity_score' => $confidence,
454	);
455	}
456
457	// 4. Fallback: 12–24 digit numeric.
458	if ( preg_match( '/^\d{12,24}$/', $normalized ) ) {
459	return array(
460	'url' => $this->get_tracking_url( $normalized ),
461	'ambiguity_score' => 60,
462	);
463	}
464
465	return null;
466	}
467	}
468