WC_REST_Paypal_Standard_Controller{} │ WC 1.0└─ WC_REST_Controller
REST API PayPal Standard controller class.
Хуков нет.
Использование
$WC_REST_Paypal_Standard_Controller = new WC_REST_Paypal_Standard_Controller(); // use class methods
Методы
- public register_routes()
- public validate_shipping_callback_request( WP_REST_Request $request )
- public process_shipping_callback( WP_REST_Request $request )
- private rebuild_cart_from_order( $order )
- private get_variation_attributes_from_order_item( WC_Order_Item_Product $item, int $product_id )
- private decode_meta_values( array $meta_value_array, string $blog_charset )
- private update_shipping_method_and_totals_for_order( $order, $shipping_option_id )
- private update_order_shipping_address( $order, $shipping_address )
- private get_updated_shipping_options( $order, $selected_shipping_option, ?string &$updated_shipping_option_id )
- private get_order_shipping_rate_id( $order )
- private get_update_shipping_error_response( $issue = 'ADDRESS_ERROR' )
Заметки
| Пакет: WooCommerce\RestApi |
Код WC_REST_Paypal_Standard_Controller{} WC REST Paypal Standard Controller{} WC 11.3.0
class WC_REST_Paypal_Standard_Controller extends WC_REST_Controller {
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v3';
/**
* Route base.
*
* @var string
*/
protected $rest_base = 'paypal-standard';
/**
* Register the routes for PayPal Standard REST API requests.
*
* @return void
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/update-shipping',
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'process_shipping_callback' ),
'permission_callback' => array( $this, 'validate_shipping_callback_request' ),
)
);
}
/**
* Validate the shipping callback request.
*
* @since 10.6.0
* @param WP_REST_Request<array<string, mixed>> $request The request object.
* @return bool True if the request is valid, false otherwise.
*/
public function validate_shipping_callback_request( WP_REST_Request $request ) { // phpcs:ignore Squiz.Commenting.FunctionComment.IncorrectTypeHint
$purchase_units = $request->get_param( 'purchase_units' );
if ( empty( $purchase_units ) || empty( $purchase_units[0]['custom_id'] ) ) {
return false;
}
$order = PayPalHelper::get_wc_order_from_paypal_custom_id( $purchase_units[0]['custom_id'] );
if ( ! $order ) {
return false;
}
// If shipping callback token is not stored in order meta, return true for this order as the token is not generated for the original order.
// We will not validate the token if the order did not generate a token in the create order request.
// This is done to prevent orders created before the shipping callback token feature was introduced from being blocked from updating their shipping details.
if ( ! $order->meta_exists( PayPalConstants::PAYPAL_ORDER_META_SHIPPING_CALLBACK_TOKEN ) ) {
return true;
}
// Validate the token.
$token = $request->get_param( 'token' );
if ( empty( $token ) ) {
return false;
}
$shipping_callback_token = $order->get_meta( PayPalConstants::PAYPAL_ORDER_META_SHIPPING_CALLBACK_TOKEN, true );
if ( empty( $shipping_callback_token ) || ! hash_equals( $token, $shipping_callback_token ) ) {
return false;
}
return true;
}
/**
* Callback for when the customer updates their shipping details in PayPal.
* https://developer.paypal.com/docs/checkout/standard/customize/shipping-module/#server-side-shipping-callbacks
*
* @param WP_REST_Request $request The request object.
* @return WP_REST_Response The response object.
*/
public function process_shipping_callback( WP_REST_Request $request ) {
$paypal_order_id = $request->get_param( 'id' );
$shipping_address = $request->get_param( 'shipping_address' );
$shipping_option = $request->get_param( 'shipping_option' );
$purchase_units = $request->get_param( 'purchase_units' );
// Note: shipping_option may or may not be present.
if ( empty( $paypal_order_id ) || empty( $shipping_address ) || empty( $purchase_units ) ) {
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
if ( ! is_array( $shipping_option ) ) {
$shipping_option = array();
}
// Get the WC order.
$order = PayPalHelper::get_wc_order_from_paypal_custom_id( $purchase_units[0]['custom_id'] ?? '{}' );
if ( ! $order ) {
$custom_id = isset( $purchase_units[0]['custom_id'] ) ? $purchase_units[0]['custom_id'] : '{}';
WC_Gateway_Paypal::log( 'Unable to determine WooCommerce order from PayPal custom ID: ' . $custom_id );
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
// Compare PayPal order IDs.
$paypal_order_id_from_order_meta = $order->get_meta( '_paypal_order_id', true );
if ( empty( $paypal_order_id_from_order_meta ) || $paypal_order_id !== $paypal_order_id_from_order_meta ) {
WC_Gateway_Paypal::log(
'PayPal order ID mismatch. Order ID: ' . $order->get_id() .
'. PayPal order ID (request): ' . $paypal_order_id .
'. PayPal order ID (order meta): ' . $paypal_order_id_from_order_meta
);
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
// Validate that the order is in a valid state for shipping updates.
// Only draft or pending orders should accept shipping updates.
if ( ! in_array( $order->get_status(), array( OrderStatus::CHECKOUT_DRAFT, OrderStatus::PENDING ), true ) ) {
WC_Gateway_Paypal::log(
'Order is not in a valid state for shipping updates. Order ID: ' . $order->get_id() .
'. Order status: ' . $order->get_status()
);
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
// If the order has a PayPal transaction ID, a charge has already occurred, so we shouldn't change the shipping address.
$transaction_id = $order->get_transaction_id();
if ( ! empty( $transaction_id ) ) {
WC_Gateway_Paypal::log(
'Order already has a transaction ID, cannot update shipping. Order ID: ' . $order->get_id() .
'. Transaction ID: ' . $transaction_id
);
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
if ( ! WC()->session ) {
WC()->session = new WC_Session_Handler();
}
WC()->session->init();
// Update the shipping address before we do anything else.
$this->update_order_shipping_address( $order, $shipping_address );
$re_add_cart_item_fees = static function ( $cart ) use ( $order ) {
if ( ! ( $cart instanceof WC_Cart ) ) {
return;
}
foreach ( $order->get_fees() as $fee_item ) {
if ( ! ( $fee_item instanceof WC_Order_Item_Fee ) ) {
continue;
}
WC()->cart->add_fee(
$fee_item->get_name(),
(float) $fee_item->get_amount(),
ProductTaxStatus::TAXABLE === $fee_item->get_tax_status(),
$fee_item->get_tax_class()
);
}
};
add_action( 'woocommerce_cart_calculate_fees', $re_add_cart_item_fees );
try {
// We need to rebuild the cart from the order, as we do not have session cart data
// for REST API requests.
try {
$this->rebuild_cart_from_order( $order );
} catch ( Exception $e ) {
WC_Gateway_Paypal::log(
'Error rebuilding cart from order. Order ID: ' . $order->get_id() .
'. Error: ' . $e->getMessage()
);
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
// Get the new shipping options, which depend on the new shipping address.
$updated_shipping_options = $this->get_updated_shipping_options( $order, $shipping_option, $updated_shipping_option_id );
if ( empty( $updated_shipping_options ) ) {
WC_Gateway_Paypal::log(
'No shipping options found for address. Order ID: ' . $order->get_id() .
'. Address: ' . wp_json_encode( $shipping_address )
);
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
if ( null === $updated_shipping_option_id ) {
WC_Gateway_Paypal::log(
'No default shipping option selected after address update. Order ID: ' . $order->get_id() .
'. Shipping options: ' . wp_json_encode( $updated_shipping_options )
);
$response = $this->get_update_shipping_error_response();
return new WP_REST_Response( $response, 422 );
}
// Update the shipping method for the order and recompute the shipping and tax
// totals based on the address and shipping method updates.
$this->update_shipping_method_and_totals_for_order( $order, $updated_shipping_option_id );
$paypal_request = new PayPalRequest( WC_Gateway_Paypal::get_instance() );
$updated_amount = $paypal_request->get_paypal_order_purchase_unit_amount( $order );
$response = array(
'id' => $paypal_order_id,
'purchase_units' => array(
array(
'reference_id' => isset( $purchase_units[0]['reference_id'] ) ? $purchase_units[0]['reference_id'] : '', // No change.
'amount' => $updated_amount,
'shipping_options' => $updated_shipping_options,
),
),
);
return new WP_REST_Response( $response, 200 );
} finally {
remove_action( 'woocommerce_cart_calculate_fees', $re_add_cart_item_fees );
}
}
/**
* Rebuild the session cart.
*
* @param WC_Order $order The order object.
* @throws Exception If the cart cannot be rebuilt.
*/
private function rebuild_cart_from_order( $order ): void {
wc_load_cart();
WC()->cart->empty_cart();
foreach ( $order->get_items() as $item ) {
if ( ! ( $item instanceof WC_Order_Item_Product ) ) {
continue;
}
$product_id = $item->get_product_id();
$product = $item->get_product();
if ( ! $product instanceof WC_Product ) {
continue;
}
$order_product_subtotal = (float) $item->get_subtotal();
$order_product_quantity = (float) $item->get_quantity();
$order_product_price = round( $order_product_subtotal / $order_product_quantity, wc_get_price_decimals() );
if ( $product->is_type( ProductType::VARIATION ) ) {
$variation_id = $item->get_variation_id();
$cart_item_key = WC()->cart->add_to_cart(
$product_id,
$item->get_quantity(),
$variation_id,
$this->get_variation_attributes_from_order_item( $item, $product_id )
);
} else {
$cart_item_key = WC()->cart->add_to_cart( $product_id, $item->get_quantity() );
}
if ( ! is_string( $cart_item_key ) ) {
throw new Exception( 'Failed to add product to cart.' );
}
$cart_item = WC()->cart->get_cart_item( $cart_item_key );
if ( ! $cart_item ) {
throw new Exception( 'Failed to get cart item.' );
}
$cart_item['data']->set_price( (string) $order_product_price );
}
// Re-apply coupons present on the order so discounts/totals are accurate.
if ( method_exists( $order, 'get_coupon_codes' ) ) {
foreach ( (array) $order->get_coupon_codes() as $code ) {
if ( $code ) {
WC()->cart->apply_coupon( $code );
}
}
}
// Recalculate the cart totals after all changes have been applied.
// Note that fees are handled via a hook.
WC()->cart->calculate_totals();
// Re-apply shipping methods present on the order so totals are accurate.
$order_shipping_rate_id = $this->get_order_shipping_rate_id( $order );
if ( ! empty( $order_shipping_rate_id ) ) {
WC()->session->set( 'chosen_shipping_methods', array( $order_shipping_rate_id ) );
}
}
/**
* Get the variation attributes stored in an order item's meta, in the format expected by
* WC_Cart::add_to_cart(). This mirrors the attribute handling in {@see WC_Cart_Session::populate_cart_from_order()}.
*
* @param WC_Order_Item_Product $item The order item.
* @param int $product_id The ID of the parent variable product.
* @return array Attribute values keyed by 'attribute_{name}'.
*/
private function get_variation_attributes_from_order_item( WC_Order_Item_Product $item, int $product_id ): array {
$variation_attributes = array();
foreach ( $item->get_meta_data() as $meta ) {
$is_taxonomy_attribute = taxonomy_is_product_attribute( $meta->key );
if ( ! $is_taxonomy_attribute && ! meta_is_product_attribute( $meta->key, $meta->value, $product_id ) ) {
continue;
}
$attribute_key = 'attribute_' . sanitize_title( $meta->key );
if ( $is_taxonomy_attribute ) {
$variation_attributes[ $attribute_key ] = sanitize_title( $meta->value );
} else {
$meta_value = wc_clean( $meta->value );
$blog_charset = get_bloginfo( 'charset' );
if ( is_string( $meta_value ) ) {
$variation_attributes[ $attribute_key ] = html_entity_decode( $meta_value, ENT_QUOTES, $blog_charset );
} elseif ( is_array( $meta_value ) ) {
$variation_attributes[ $attribute_key ] = $this->decode_meta_values( $meta->value, $blog_charset );
}
}
}
return $variation_attributes;
}
/**
* Helper method to support recursively ensuring metadata string values are decoded.
*
* @param array $meta_value_array The metadata value array.
* @param string $blog_charset The blog charset.
* @return array The decoded metadata value array.
*/
private function decode_meta_values( array $meta_value_array, string $blog_charset ): array {
$decoded_values = array();
foreach ( $meta_value_array as $key => $value ) {
if ( is_string( $value ) ) {
$decoded_values[ $key ] = html_entity_decode( $value, ENT_QUOTES, $blog_charset );
} elseif ( is_array( $value ) ) {
$decoded_values[ $key ] = $this->decode_meta_values( $value, $blog_charset );
} elseif ( is_scalar( $value ) ) {
$decoded_values[ $key ] = $value;
}
}
return $decoded_values;
}
/**
* Update the shipping method for the order, and then recompute the order totals.
*
* @param WC_Order $order The order object.
* @param string $shipping_option_id The shipping option id.
* @return void
*/
private function update_shipping_method_and_totals_for_order( $order, $shipping_option_id ): void {
// Remove and recreate the shipping lines for the order.
$order->remove_order_items( 'shipping' );
$packages = WC()->shipping()->get_packages();
WC()->checkout()->create_order_shipping_lines( $order, array( $shipping_option_id ), $packages );
// Update the order totals based on the updated shipping method and any relevant taxes.
$order->calculate_totals( true );
}
/**
* Update the WooCommerce order with the new shipping address.
*
* @param WC_Order $order The order object.
* @param array $shipping_address The shipping address.
* @return void
*/
private function update_order_shipping_address( $order, $shipping_address ) {
$country = $shipping_address['country_code'] ?? '';
$postcode = $shipping_address['postal_code'] ?? '';
$state = $shipping_address['admin_area_1'] ?? '';
$city = $shipping_address['admin_area_2'] ?? '';
$order->set_shipping_country( $country );
$order->set_shipping_postcode( $postcode );
$order->set_shipping_state( $state );
$order->set_shipping_city( $city );
// We do not have the address line 1 and 2 -- we are clearing them here to avoid
// showing stale data. The final address will be updated when the
// customer approves the order, via 'woocommerce_thankyou_paypal' hook.
$order->set_shipping_address_1( '' );
$order->set_shipping_address_2( '' );
$order->save();
// Get customer from order and update their shipping location.
$customer = new WC_Customer();
$customer->set_location( $country, $state, $postcode, $city );
$customer->set_shipping_location( $country, $state, $postcode, $city );
$customer->set_calculated_shipping( true );
WC()->customer = $customer;
}
/**
* Get the shipping options for the order.
*
* @param WC_Order $order The order object.
* @param array $selected_shipping_option The selected shipping option.
* @param string|null $updated_shipping_option_id The updated shipping option id after the updates.
* @return array The shipping options.
*/
private function get_updated_shipping_options( $order, $selected_shipping_option, ?string &$updated_shipping_option_id ) {
$updated_shipping_option_id = null;
WC()->cart->calculate_shipping();
$packages = WC()->shipping()->get_packages();
$order_shipping_rate_id = $this->get_order_shipping_rate_id( $order );
$has_selected_shipping_option = false;
$options = array();
foreach ( $packages as $package ) {
$rates = $package['rates'] ?? array();
foreach ( $rates as $rate ) {
if ( ! $rate instanceof \WC_Shipping_Rate ) {
continue;
}
$shipping_option_id = $rate->get_id();
// If a selected shipping option is sent in the request, check if it matches the shipping option id.
// Otherwise, if the order has a shipping method, check if the rate id matches the shipping option id.
if ( isset( $selected_shipping_option['id'] ) ) {
$is_selected = $shipping_option_id === $selected_shipping_option['id'];
} else {
$is_selected = $shipping_option_id === $order_shipping_rate_id;
}
if ( $is_selected ) {
$has_selected_shipping_option = true;
$updated_shipping_option_id = $shipping_option_id;
}
$options[] = array(
'id' => $shipping_option_id,
'type' => 'SHIPPING',
'amount' => array(
'currency_code' => $order->get_currency(),
'value' => wc_format_decimal( (float) $rate->get_cost(), wc_get_price_decimals() ),
),
'label' => $rate->get_label(),
'selected' => $is_selected,
);
}
}
// Set first option as selected if no option is selected.
if ( ! empty( $options ) && ! $has_selected_shipping_option ) {
$options[0]['selected'] = true;
$updated_shipping_option_id = $options[0]['id'];
}
return $options;
}
/**
* Get the shipping rate id from the order.
*
* @param WC_Order $order The order object.
* @return string The shipping rate id.
*/
private function get_order_shipping_rate_id( $order ) {
$order_shipping_item = current( $order->get_items( 'shipping' ) ) ?? null;
if ( $order_shipping_item ) {
$method_id = $order_shipping_item->get_method_id();
$instance_id = $order_shipping_item->get_instance_id();
$rate_id = ( '' === $instance_id || null === $instance_id ) ? $method_id : "{$method_id}:{$instance_id}";
return $rate_id;
}
return '';
}
/**
* Get the error response for the update shipping request.
*
* @param string $issue The issue with the shipping address.
* @return array The error response.
*/
private function get_update_shipping_error_response( $issue = 'ADDRESS_ERROR' ) {
// See https://developer.paypal.com/docs/checkout/standard/customize/shipping-module/#merchant-decline-response.
return array(
'name' => 'UNPROCESSABLE_ENTITY',
'details' => array(
array( 'issue' => $issue ),
),
);
}
}