FulfillmentsManager.php
<?php
/**
* WooCommerce Fulfillment Hooks
*/
declare( strict_types=1 );
namespace Automattic\WooCommerce\Admin\Features\Fulfillments;
use Automattic\WooCommerce\Admin\Features\Fulfillments\Providers\AbstractShippingProvider;
use Automattic\WooCommerce\Admin\Features\Fulfillments\Providers\CustomShippingProvider;
use Automattic\WooCommerce\Utilities\OrderUtil;
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\Admin\Features\Fulfillments
*/
class FulfillmentsManager {
/**
* The fulfillment order notes instance.
*
* @var FulfillmentOrderNotes|null
*/
private ?FulfillmentOrderNotes $fulfillment_order_notes = null;
/**
* 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_shipping_providers', array( $this, 'get_custom_shipping_providers' ), 20, 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();
$this->init_email_template_tracking_hooks();
$this->init_order_deletion_hooks();
if ( ! $this->fulfillment_order_notes ) {
$this->fulfillment_order_notes = wc_get_container()->get( FulfillmentOrderNotes::class );
}
$this->fulfillment_order_notes->register();
}
/**
* 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 );
}
/**
* Initialize hooks to track when fulfillment email templates are customized.
*
* Hooks into the WooCommerce email settings save action for each fulfillment email type
* so we can track when merchants customize these templates.
*/
private function init_email_template_tracking_hooks(): void {
$fulfillment_email_ids = array(
'customer_fulfillment_created',
'customer_fulfillment_updated',
'customer_fulfillment_deleted',
);
foreach ( $fulfillment_email_ids as $email_id ) {
add_action(
'woocommerce_update_options_email_' . $email_id,
function () use ( $email_id ) {
FulfillmentsTracker::track_fulfillment_email_template_customized( $email_id );
}
);
}
}
/**
* Initialize order deletion hooks.
*
* Registers hooks to clean up fulfillment records when an order is permanently deleted.
*/
private function init_order_deletion_hooks(): void {
add_action( 'woocommerce_before_delete_order', array( $this, 'delete_order_fulfillments' ), 10, 1 );
add_action( 'before_delete_post', array( $this, 'delete_order_fulfillments' ), 10, 1 );
}
/**
* Delete all fulfillment records for an order that is being permanently deleted.
*
* @since 10.7.0
*
* @param int $order_id The ID of the order being deleted.
*/
public function delete_order_fulfillments( int $order_id ): void {
try {
if ( ! OrderUtil::is_order( $order_id, wc_get_order_types() ) ) {
return;
}
/**
* Fulfillments data store.
*
* @var \Automattic\WooCommerce\Admin\Features\Fulfillments\DataStore\FulfillmentsDataStore $fulfillments_data_store
*/
$fulfillments_data_store = \WC_Data_Store::load( 'order-fulfillment' );
$fulfillments_data_store->delete_by_entity( WC_Order::class, (string) $order_id );
} catch ( \Throwable $e ) {
wc_get_logger()->error(
sprintf( 'Failed to delete fulfillments for order %d: %s', $order_id, $e->getMessage() ),
array( 'source' => 'fulfillments' )
);
}
}
/**
* 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;
}
/**
* Load custom shipping providers from the wc_fulfillment_shipping_provider taxonomy.
*
* @since 10.7.0
*
* @param array $shipping_providers The current list of shipping providers.
* @return array The modified list of shipping providers with custom providers appended.
*/
public function get_custom_shipping_providers( $shipping_providers ) {
if ( ! is_array( $shipping_providers ) ) {
$shipping_providers = array();
}
if ( ! taxonomy_exists( 'wc_fulfillment_shipping_provider' ) ) {
return $shipping_providers;
}
$terms = get_terms(
array(
'taxonomy' => 'wc_fulfillment_shipping_provider',
'hide_empty' => false,
)
);
if ( is_wp_error( $terms ) || empty( $terms ) ) {
return $shipping_providers;
}
foreach ( $terms as $term ) {
$icon = get_term_meta( $term->term_id, 'icon', true );
$tracking_url_template = get_term_meta( $term->term_id, 'tracking_url_template', true );
$shipping_providers[] = new CustomShippingProvider(
$term->slug,
$term->name,
is_string( $icon ) ? $icon : '',
is_string( $tracking_url_template ) ? $tracking_url_template : ''
);
}
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;
}
try {
/**
* Fulfillments data store.
*
* @var \Automattic\WooCommerce\Admin\Features\Fulfillments\DataStore\FulfillmentsDataStore $fulfillments_data_store
*/
$fulfillments_data_store = \WC_Data_Store::load( 'order-fulfillment' );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order->get_id() );
} catch ( \Throwable $e ) {
wc_get_logger()->error(
sprintf( 'Failed to load fulfillments for order %d: %s', $order->get_id(), $e->getMessage() ),
array( 'source' => 'fulfillments' )
);
return;
}
$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.
}
try {
/**
* Fulfillments data store.
*
* @var \Automattic\WooCommerce\Admin\Features\Fulfillments\DataStore\FulfillmentsDataStore $fulfillments_data_store
*/
$fulfillments_data_store = \WC_Data_Store::load( 'order-fulfillment' );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order_id );
} catch ( \Throwable $e ) {
wc_get_logger()->error(
sprintf( 'Failed to load fulfillments for order %d: %s', $order_id, $e->getMessage() ),
array( 'source' => 'fulfillments' )
);
return;
}
$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.
try {
/**
* Fulfillments data store.
*
* @var \Automattic\WooCommerce\Admin\Features\Fulfillments\DataStore\FulfillmentsDataStore $fulfillments_data_store
*/
$fulfillments_data_store = \WC_Data_Store::load( 'order-fulfillment' );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order_id );
} catch ( \Throwable $e ) {
wc_get_logger()->error(
sprintf( 'Failed to load fulfillments for order %d: %s', $order_id, $e->getMessage() ),
array( 'source' => 'fulfillments' )
);
return;
}
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() ) {
$old_status = FulfillmentUtils::get_order_fulfillment_status( $order );
$new_status = FulfillmentUtils::calculate_order_fulfillment_status( $order, $fulfillments );
if ( 'no_fulfillments' === $new_status ) {
$order->delete_meta_data( '_fulfillment_status' );
} else {
$order->update_meta_data( '_fulfillment_status', $new_status );
}
$order->save();
if ( $old_status !== $new_status && isset( $this->fulfillment_order_notes ) ) {
$this->fulfillment_order_notes->add_order_fulfillment_status_changed_note( $order, $old_status, $new_status );
}
}
/**
* 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 ) {
$parsing_result = $provider->try_parse_tracking_number( $tracking_number, $shipping_from, $shipping_to );
if ( ! is_null( $parsing_result ) ) {
$results[ $provider->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.
}
if ( isset( $results['shipping_provider'] ) ) {
// Record the tracking lookup attempt with url_generated indicating if a tracking URL was constructed.
FulfillmentsTracker::track_fulfillment_tracking_lookup_attempt( 'success', $results['shipping_provider'], ! empty( $results['tracking_url'] ) );
} else {
// If no provider could parse the tracking number, record a failure.
FulfillmentsTracker::track_fulfillment_tracking_lookup_attempt( 'not_found', '', false );
}
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'],
);
}
}
