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
|
<?php
/**
* WooCommerce Fulfillment Hooks
*/
declare( strict_types=1 );
namespace Automattic\WooCommerce\Internal\Fulfillments;
use Automattic\WooCommerce\Internal\DataStores\Fulfillments\FulfillmentsDataStore;
use Automattic\WooCommerce\Internal\Fulfillments\Providers\AbstractShippingProvider;
use WC_Order;
use WC_Order_Refund;
/**
* FulfillmentsManager class.
*
* This class is responsible for adding hooks related to fulfillments in WooCommerce.
*
* @since 10.1.0
* @package WooCommerce\Internal\Fulfillments
*/
class FulfillmentsManager {
/**
* This method registers the hooks related to fulfillments.
*/
public function register() {
add_filter( 'woocommerce_fulfillment_shipping_providers', array( $this, 'get_initial_shipping_providers' ), 10, 1 );
add_filter( 'woocommerce_fulfillment_translate_meta_key', array( $this, 'translate_fulfillment_meta_key' ), 10, 1 );
add_filter( 'woocommerce_fulfillment_parse_tracking_number', array( $this, 'try_parse_tracking_number' ), 10, 3 );
$this->init_fulfillment_status_hooks();
$this->init_refund_hooks();
}
/**
* Hook fulfillment status events.
*
* This method hooks into the fulfillment status events to update the order fulfillment status
* when a fulfillment is created, updated, or deleted.
*/
private function init_fulfillment_status_hooks() {
// Update order fulfillment status when a fulfillment is created, updated, or deleted.
add_action( 'woocommerce_fulfillment_after_create', array( $this, 'update_order_fulfillment_status_on_fulfillment_update' ), 10, 1 );
add_action( 'woocommerce_fulfillment_after_update', array( $this, 'update_order_fulfillment_status_on_fulfillment_update' ), 10, 1 );
add_action( 'woocommerce_fulfillment_after_delete', array( $this, 'update_order_fulfillment_status_on_fulfillment_update' ), 10, 1 );
}
/**
* Initialize refund-related hooks.
*
* This method initializes the hooks related to refunds, such as updating fulfillments after a refund is created
*/
private function init_refund_hooks() {
add_action( 'woocommerce_refund_created', array( $this, 'update_fulfillments_after_refund' ), 10, 1 );
add_action( 'woocommerce_delete_order_refund', array( $this, 'update_fulfillment_status_after_refund_deleted' ), 10, 1 );
}
/**
* Translate fulfillment meta keys.
*
* @param string $meta_key The meta key to translate.
* @return string Translated meta key.
*/
public function translate_fulfillment_meta_key( $meta_key ) {
/**
* Filter to translate fulfillment meta keys.
*
* This filter allows us to translate fulfillment meta keys
* to make them more user-friendly in the admin interface and emails.
*
* @since 10.1.0
*/
$meta_key_translations = apply_filters(
'woocommerce_fulfillment_meta_key_translations',
array(
'fulfillment_status' => __( 'Fulfillment Status', 'woocommerce' ),
'shipment_tracking' => __( 'Shipment Tracking', 'woocommerce' ),
'shipment_provider' => __( 'Shipment Provider', 'woocommerce' ),
)
);
return isset( $meta_key_translations[ $meta_key ] ) ? $meta_key_translations[ $meta_key ] : $meta_key;
}
/**
* Get initial shipping providers.
*
* This method provides the initial shipping providers that feeds the `woocommerce_fulfillment_shipping_providers` filter,
* which is used to populate the list of available shipping providers on the fulfillment UI.
*
* @param array $shipping_providers The current list of shipping providers.
*
* @return array The modified list of shipping providers.
*/
public function get_initial_shipping_providers( $shipping_providers ) {
if ( ! is_array( $shipping_providers ) ) {
$shipping_providers = array();
}
$shipping_providers = array_merge(
$shipping_providers,
include __DIR__ . '/ShippingProviders.php'
);
ksort( $shipping_providers );
return $shipping_providers;
}
/**
* Update order fulfillment status after a fulfillment is created, updated, or deleted.
*
* @param Fulfillment $data The fulfillment data.
*/
public function update_order_fulfillment_status_on_fulfillment_update( Fulfillment $data ) {
if ( ! $data instanceof Fulfillment ) {
return;
}
$order = $data->get_order();
if ( ! $order instanceof \WC_Order ) {
return;
}
/**
* Get the FulfillmentsDataStore instance.
*
* @var FulfillmentsDataStore $fulfillments_data_store
*/
$fulfillments_data_store = wc_get_container()->get( FulfillmentsDataStore::class );
// Read all fulfillments for the order.
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order->get_id() );
$this->update_fulfillment_status( $order, $fulfillments );
}
/**
* Update fulfillment status after a refund is deleted.
*
* This method updates the fulfillment status after a refund is deleted to ensure that the fulfillment status
* and items are correctly adjusted based on the refund deletion.
*
* @param int $refund_id The ID of the refund being deleted.
*
* @return void
*/
public function update_fulfillment_status_after_refund_deleted( int $refund_id ): void {
$refund = wc_get_order( $refund_id );
if ( ! $refund instanceof \WC_Order ) {
return; // If the refund is not a valid order, do nothing.
}
$order_id = $refund->get_parent_id();
if ( ! $order_id ) {
return; // If the refund does not have a parent order, do nothing.
}
$order = wc_get_order( $order_id );
if ( ! $order instanceof \WC_Order ) {
return; // If the order is not valid, do nothing.
}
$fulfillments_data_store = wc_get_container()->get( FulfillmentsDataStore::class );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order_id );
$this->update_fulfillment_status( $order, $fulfillments );
}
/**
* Update fulfillments after a refund is created.
*
* @param int $refund_id The ID of the refund created.
*
* @return void
*/
public function update_fulfillments_after_refund( int $refund_id ): void {
// Get the order object.
$refund = $refund_id ? wc_get_order( $refund_id ) : null;
if ( ! $refund instanceof WC_Order_Refund ) {
return; // If the order is not valid, do nothing.
}
$order_id = $refund->get_parent_id();
if ( ! $order_id ) {
return; // If the refund does not have a parent order, do nothing.
}
$order = wc_get_order( $order_id );
if ( ! $order instanceof \WC_Order ) {
return; // If the order is not valid, do nothing.
}
// If there are no refunded items, we can skip the fulfillment update.
$items_refunded = FulfillmentUtils::get_refunded_items( $order );
if ( empty( $items_refunded ) ) {
return; // No items were refunded, so no need to update fulfillments.
}
// Get the fulfillments data store and read all fulfillments for the order.
$fulfillments_data_store = wc_get_container()->get( FulfillmentsDataStore::class );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order_id );
if ( empty( $fulfillments ) ) {
return; // No fulfillments found for the order.
}
// Get all refunded items from the order.
$pending_items_without_refunds = FulfillmentUtils::get_pending_items( $order, $fulfillments, false );
$pending_items_without_refunds = array_map(
function ( $item ) {
return array(
'item_id' => $item['item_id'],
'qty' => $item['qty'],
);
},
$pending_items_without_refunds
);
// Check if the refunded items can be removed from pending items.
foreach ( $items_refunded as $item_id => &$refunded_qty ) {
$pending_item_record = array_filter(
$pending_items_without_refunds,
function ( $item ) use ( $item_id ) {
return isset( $item['item_id'] ) && $item['item_id'] === $item_id;
}
);
if ( ! empty( $pending_item_record ) ) {
$pending_item_record = reset( $pending_item_record );
if ( isset( $pending_item_record['qty'] ) && $pending_item_record['qty'] > 0 ) {
// If the pending item quantity is greater than the refunded quantity, reduce it.
$refunded_qty -= $pending_item_record['qty'];
}
}
}
// If all refunded items can be removed from pending items, we can skip the fulfillment update.
$items_need_removal_from_fulfillments = array_filter(
$items_refunded,
function ( $actual_qty ) {
return $actual_qty > 0;
}
);
if ( empty( $items_need_removal_from_fulfillments ) ) {
return;
}
// Now we need to adjust the fulfillments based on the refunded items.
// Loop through each fulfillment and adjust the items based on the refunded quantities.
// We will remove items from fulfillments if they are fully refunded, or reduce their quantity if partially refunded.
// If a fulfillment has no items left after adjustment, we will delete it.
// If a fulfillment has items left, we will update the fulfillment with the new items.
foreach ( $fulfillments as $fulfillment ) {
if ( ! $fulfillment instanceof Fulfillment ) {
continue; // Skip if the fulfillment is not an instance of Fulfillment.
}
if ( $fulfillment->get_is_fulfilled() ) {
continue; // Skip if the fulfillment is already fulfilled. We don't remove items from fulfilled fulfillments.
}
// Get the items from the fulfillment.
$items = $fulfillment->get_items();
if ( empty( $items ) ) {
continue; // Skip if there are no items in the fulfillment.
}
// Adjust the items based on the refund.
$new_items = array();
foreach ( $items as $item ) {
if ( isset( $item['qty'] ) && isset( $item['item_id'] ) && isset( $items_need_removal_from_fulfillments[ $item['item_id'] ] ) ) {
if ( $items_need_removal_from_fulfillments[ $item['item_id'] ] <= $item['qty'] ) {
// If the refunded quantity is less than or equal to the item quantity, reduce the item quantity.
$item['qty'] -= $items_need_removal_from_fulfillments[ $item['item_id'] ];
$items_need_removal_from_fulfillments[ $item['item_id'] ] = 0; // Set refunded quantity to zero after adjustment.
} else {
// If the refunded quantity is greater than the item quantity, set the item quantity to zero.
$item['qty'] = 0;
$items_need_removal_from_fulfillments[ $item['item_id'] ] -= $item['qty']; // Reduce the refunded quantity.
}
$new_items[] = $item; // Add the adjusted item to the new items array.
} else {
$new_items[] = $item; // If the item is not in the refunded items, keep it as is.
}
}
$new_items = array_filter(
$new_items,
function ( $item ) {
return isset( $item['qty'] ) && $item['qty'] > 0; // Only keep items with a positive quantity.
}
);
if ( empty( $new_items ) ) {
// If no items remain after adjustment, delete the fulfillment.
$fulfillment->delete();
} else {
// Update the fulfillment items with the new items.
$fulfillment->set_items( $new_items );
$fulfillment->save();
}
}
$this->update_fulfillment_status( $order, $fulfillments );
}
/**
* Update the fulfillment status for the order.
*
* @param \WC_Order $order The order object.
* @param array $fulfillments The fulfillments data store.
*
* This method updates the fulfillment status for the order based on the fulfillments data store.
*/
private function update_fulfillment_status( $order, $fulfillments = array() ) {
$last_status = FulfillmentUtils::calculate_order_fulfillment_status( $order, $fulfillments );
if ( 'no_fulfillments' === $last_status ) {
$order->delete_meta_data( '_fulfillment_status' );
} else {
// Update the fulfillment status meta data.
$order->update_meta_data( '_fulfillment_status', $last_status );
}
$order->save();
}
/**
* Try to parse the tracking number with additional parameters.
*
* @param string $tracking_number The tracking number.
* @param string $shipping_from The country code from which the shipment is sent.
* @param string $shipping_to The country code to which the shipment is sent.
*
* @return array An array containing the provider as key, and the parsing results.
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): array {
// Validate the tracking number format and length.
if ( ! is_string( $tracking_number ) || empty( $tracking_number ) || strlen( $tracking_number ) > 50 ) {
$tracking_number = is_string( $tracking_number ) && ! empty( $tracking_number ) ? substr( $tracking_number, 0, 50 ) : '';
return array(
'tracking_number' => $tracking_number,
'shipping_provider' => '',
'tracking_url' => '',
);
}
// Normalize the tracking number to uppercase.
$tracking_number = strtoupper( $tracking_number );
$tracking_number = preg_replace( '/[^A-Z0-9]/', '', $tracking_number ); // Remove non-alphanumeric characters.
$shipping_providers = FulfillmentUtils::get_shipping_providers();
$results = array();
foreach ( $shipping_providers as $provider ) {
if ( class_exists( $provider ) && is_subclass_of( $provider, AbstractShippingProvider::class ) ) {
try {
/**
* Instantiate the shipping provider class.
*
* @var AbstractShippingProvider $provider_instance
*/
$provider_instance = wc_get_container()->get( $provider );
} catch ( \Throwable $e ) {
$logger = wc_get_logger();
$logger->error(
sprintf(
'Error instantiating shipping provider class %s: %s',
$provider,
$e->getMessage()
),
array( 'source' => 'woocommerce-fulfillments' )
);
continue; // Skip if the provider class cannot be instantiated.
}
} else {
continue; // Skip if the provider class does not exist or is not a valid shipping provider.
}
$parsing_result = $provider_instance->try_parse_tracking_number( $tracking_number, $shipping_from, $shipping_to );
if ( ! is_null( $parsing_result ) ) {
$results[ $provider_instance->get_key() ] = $parsing_result;
}
}
if ( 1 === count( $results ) ) {
$result = reset( $results );
$key = key( $results );
$results = array(
'tracking_number' => $tracking_number,
'shipping_provider' => $key,
'tracking_url' => $result['url'] ?? '',
);
} elseif ( 1 < count( $results ) ) {
// If multiple providers could parse the tracking number, find the one with the highest ambiguity score.
$possibilities = $results;
$results = $this->get_best_parsing_result( $results, $tracking_number );
$results['possibilities'] = $possibilities; // Include all possibilities for reference.
}
return $results;
}
/**
* Get the best parsing result from multiple results.
*
* This method finds the provider with the highest ambiguity score from the results.
*
* @param array $results The results from multiple providers.
* @param string $tracking_number The tracking number being parsed.
*
* @return array The best parsing result.
*/
private function get_best_parsing_result( array $results, string $tracking_number ): array {
$best_result = null;
$best_provider = '';
$best_score = 0;
foreach ( $results as $provider_key => $result ) {
if ( ! isset( $result['ambiguity_score'] ) || ! is_numeric( $result['ambiguity_score'] ) ) {
continue; // Skip if ambiguity score is not set or not numeric.
}
if ( is_null( $best_result ) || $result['ambiguity_score'] > $best_score ) {
$best_result = $result;
$best_provider = $provider_key;
$best_score = $result['ambiguity_score'];
}
}
return is_null( $best_result ) ? array() : array(
'tracking_number' => $tracking_number,
'shipping_provider' => $best_provider,
'tracking_url' => $best_result['url'],
);
}
}
|