File Content: Checkout.php <?php namespace Automattic\Kkart\Blocks\StoreApi\Routes; use \Exception; use Automattic\Kkart\Blocks\Package; use Automattic\Kkart\Blocks\Domain\Services\CreateAccount; use Automattic\Kkart\Blocks\StoreApi\Utilities\CartController; use Automattic\Kkart\Blocks\StoreApi\Utilities\OrderController; use Automattic\Kkart\Blocks\StoreApi\Utilities\ReserveStock; use Automattic\Kkart\Blocks\StoreApi\Utilities\ReserveStockException; use Automattic\Kkart\Blocks\Payments\PaymentResult; use Automattic\Kkart\Blocks\Payments\PaymentContext; /** * Checkout class. * * @internal This API is used internally by Blocks--it is still in flux and may be subject to revisions. */ class Checkout extends AbstractRoute { /** * Get the path of this REST route. * * @return string */ public function get_path() { return '/checkout'; } /** * Enforce nonces for all checkout endpoints. * * @param \WP_REST_Request $request Request object. * @return \WP_Error|\WP_REST_Response */ public function get_response( \WP_REST_Request $request ) { $this->maybe_load_cart(); $response = null; try { $this->check_nonce( $request ); $response = parent::get_response( $request ); } catch ( RouteException $error ) { $response = $this->get_route_error_response( $error->getErrorCode(), $error->getMessage(), $error->getCode() ); } catch ( \Exception $error ) { $response = $this->get_route_error_response( 'unknown_server_error', $error->getMessage(), 500 ); } return $response; } /** * Get method arguments for this REST route. * * @return array An array of endpoints. */ public function get_args() { return [ [ 'methods' => \WP_REST_Server::READABLE, 'callback' => [ $this, 'get_response' ], 'permission_callback' => '__return_true', 'args' => [ 'context' => $this->get_context_param( [ 'default' => 'view' ] ), ], ], [ 'methods' => \WP_REST_Server::EDITABLE, 'callback' => array( $this, 'get_response' ), 'permission_callback' => '__return_true', 'args' => $this->schema->get_endpoint_args_for_item_schema( \WP_REST_Server::EDITABLE ), ], [ 'methods' => \WP_REST_Server::CREATABLE, 'callback' => [ $this, 'get_response' ], 'permission_callback' => '__return_true', 'args' => array_merge( [ 'payment_data' => [ 'description' => __( 'Data to pass through to the payment method when processing payment.', 'kkart' ), 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => [ 'type' => 'string', ], 'value' => [ 'type' => 'string', ], ], ], ], ], $this->schema->get_endpoint_args_for_item_schema( \WP_REST_Server::CREATABLE ) ), ], 'schema' => [ $this->schema, 'get_public_item_schema' ], ]; } /** * Convert the cart into a new draft order, or update an existing draft order, and return an updated cart response. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return \WP_REST_Response */ protected function get_route_response( \WP_REST_Request $request ) { $order_object = $this->create_or_update_draft_order(); return $this->prepare_item_for_response( (object) [ 'order' => $order_object, 'payment_result' => new PaymentResult(), ], $request ); } /** * Update the order. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return \WP_REST_Response */ protected function get_route_update_response( \WP_REST_Request $request ) { $order_object = $this->create_or_update_draft_order(); $this->update_order_from_request( $order_object, $request ); return $this->prepare_item_for_response( (object) [ 'order' => $order_object, 'payment_result' => new PaymentResult(), ], $request ); } /** * Update and process payment for the order. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return \WP_REST_Response */ protected function get_route_post_response( \WP_REST_Request $request ) { $order_controller = new OrderController(); $order_object = $this->get_draft_order_object( $this->get_draft_order_id() ); if ( ! $order_object ) { throw new RouteException( 'kkart_rest_checkout_invalid_order', __( 'This session has no orders pending payment.', 'kkart' ), 500 ); } // Ensure order still matches cart. $order_controller->update_order_from_cart( $order_object ); // Create a new user account as necessary. // Note - CreateAccount class includes feature gating logic (i.e. this // may not create an account depending on build). if ( defined( 'KKART_VERSION' ) && version_compare( KKART_VERSION, '4.7', '>=' ) ) { // Checkout signup is feature gated to Kkart 4.7 and newer; // Because it requires updated my-account/lost-password screen in 4.7+ // for setting initial password. try { $create_account = Package::container()->get( CreateAccount::class ); $create_account->from_order_request( $request ); $order_object->set_customer_id( get_current_user_id() ); } catch ( Exception $error ) { $this->handle_error( $error ); } } // If any form fields were posted, update the order. $this->update_order_from_request( $order_object, $request ); // Check order is still valid. $order_controller->validate_order_before_payment( $order_object ); // Persist customer address data to account. $order_controller->sync_customer_data_with_order( $order_object ); /* * Fire kkart_blocks_checkout_order_processed, should work the same way as kkart_checkout_order_processed * But we're opting for a new action because the original ones attaches POST data. * NOTE: this hook is still experimental, and might change or get removed. * @todo: Document and stabilize __experimental_kkart_blocks_checkout_order_processed */ do_action( '__experimental_kkart_blocks_checkout_order_processed', $order_object ); if ( ! $order_object->needs_payment() ) { $payment_result = $this->process_without_payment( $order_object, $request ); } else { $payment_result = $this->process_payment( $order_object, $request ); } $response = $this->prepare_item_for_response( (object) [ 'order' => kkart_get_order( $order_object ), 'payment_result' => $payment_result, ], $request ); switch ( $payment_result->status ) { case 'success': $response->set_status( 200 ); break; case 'pending': $response->set_status( 202 ); break; case 'failure': $response->set_status( 400 ); break; case 'error': $response->set_status( 500 ); break; } return $response; } /** * Get route response when something went wrong. * * @param string $error_code String based error code. * @param string $error_message User facing error message. * @param int $http_status_code HTTP status. Defaults to 500. * @param array $additional_data Extra data (key value pairs) to expose in the error response. * @return \WP_Error WP Error object. */ protected function get_route_error_response( $error_code, $error_message, $http_status_code = 500, $additional_data = [] ) { switch ( $http_status_code ) { case 409: // If there was a conflict, return the cart so the client can resolve it. $controller = new CartController(); $cart = $controller->get_cart_instance(); return new \WP_Error( $error_code, $error_message, array_merge( $additional_data, [ 'status' => $http_status_code, 'cart' => kkart()->api->get_endpoint_data( '/kkart/store/cart' ), ] ) ); } return new \WP_Error( $error_code, $error_message, [ 'status' => $http_status_code ] ); } /** * Gets draft order data from the customer session. * * @return array */ protected function get_draft_order_id() { return kkart()->session->get( 'store_api_draft_order', 0 ); } /** * Updates draft order data in the customer session. * * @param integer $order_id Draft order ID. */ protected function set_draft_order_id( $order_id ) { kkart()->session->set( 'store_api_draft_order', $order_id ); } /** * Get an order object, either using a current draft order, or returning a new one. * * @param integer $order_id Draft order ID. * @return \KKART_Order|boolean Either the draft order, or false if one has not yet been created. */ protected function get_draft_order_object( $order_id ) { $draft_order_object = $order_id ? kkart_get_order( $order_id ) : false; if ( ! $draft_order_object ) { return false; } // Draft orders are okay. if ( $draft_order_object->has_status( 'checkout-draft' ) ) { return $draft_order_object; } // Pending and failed orders can be retried if the cart hasn't changed. if ( $draft_order_object->needs_payment() && $draft_order_object->has_cart_hash( kkart()->cart->get_cart_hash() ) ) { return $draft_order_object; } return false; } /** * Create or update a draft order based on the cart. * * @throws RouteException On error. * * @return \KKART_Order Order object. */ protected function create_or_update_draft_order() { $cart_controller = new CartController(); $order_controller = new OrderController(); $reserve_stock = \class_exists( '\Automattic\Kkart\Checkout\Helpers\ReserveStock' ) ? new \Automattic\Kkart\Checkout\Helpers\ReserveStock() : new ReserveStock(); $order_object = $this->get_draft_order_object( $this->get_draft_order_id() ); $created = false; // Validate items etc are allowed in the order before it gets created. $cart_controller->validate_cart_items(); $cart_controller->validate_cart_coupons(); if ( ! $order_object ) { $order_object = $order_controller->create_order_from_cart(); $created = true; } else { $order_controller->update_order_from_cart( $order_object ); } // Store order ID to session. $this->set_draft_order_id( $order_object->get_id() ); // Try to reserve stock for 10 mins, if available. try { $reserve_stock->reserve_stock_for_order( $order_object, 10 ); } catch ( ReserveStockException $e ) { $error_data = $e->getErrorData(); throw new RouteException( $e->getErrorCode(), $e->getMessage(), $e->getCode() ); } return $order_object; } /** * Convert an account creation error to a Store API error. * * @param \Exception $error Caught exception. * * @throws RouteException API error object with error details. */ private function handle_error( Exception $error ) { switch ( $error->getMessage() ) { case 'registration-error-invalid-email': throw new RouteException( 'registration-error-invalid-email', __( 'Please provide a valid email address.', 'kkart' ), 400 ); case 'registration-error-email-exists': throw new RouteException( 'registration-error-email-exists', apply_filters( 'kkart_registration_error_email_exists', __( 'An account is already registered with your email address. Please log in.', 'kkart' ) ), 400 ); } } /** * Update an order using the posted values from the request. * * @param \KKART_Order $order Object to prepare for the response. * @param \WP_REST_Request $request Full details about the request. */ protected function update_order_from_request( \KKART_Order $order, \WP_REST_Request $request ) { $schema = $this->get_item_schema(); if ( isset( $request['billing_address'] ) ) { $allowed_billing_values = array_intersect_key( $request['billing_address'], $schema['properties']['billing_address']['properties'] ); foreach ( $allowed_billing_values as $key => $value ) { $order->{"set_billing_$key"}( $value ); } } if ( isset( $request['shipping_address'] ) ) { $allowed_shipping_values = array_intersect_key( $request['shipping_address'], $schema['properties']['shipping_address']['properties'] ); foreach ( $allowed_shipping_values as $key => $value ) { $order->{"set_shipping_$key"}( $value ); } } if ( isset( $request['customer_note'] ) ) { $order->set_customer_note( $request['customer_note'] ); } if ( isset( $request['payment_method'] ) ) { $order->set_payment_method( $this->get_request_payment_method( $request ) ); } $order->save(); } /** * For orders which do not require payment, just update status. * * @param \KKART_Order $order Order object. * @param \WP_REST_Request $request Request object. * @return PaymentResult */ protected function process_without_payment( \KKART_Order $order, \WP_REST_Request $request ) { $order->payment_complete(); $result = new PaymentResult( 'success' ); $result->set_redirect_url( $order->get_checkout_order_received_url() ); return $result; } /** * Fires an action hook instructing active payment gateways to process the payment for an order and provide a result. * * @throws RouteException On error. * @param \KKART_Order $order Order object. * @param \WP_REST_Request $request Request object. * @return PaymentResult */ protected function process_payment( \KKART_Order $order, \WP_REST_Request $request ) { $context = new PaymentContext(); $result = new PaymentResult(); $order->update_status( 'pending' ); $context->set_order( $order ); $context->set_payment_method( $this->get_request_payment_method_id( $request ) ); $context->set_payment_data( $this->get_request_payment_data( $request ) ); try { /** * Process payment with context. * * @hook kkart_rest_checkout_process_payment_with_context * * @throws \Exception If there is an error taking payment, an Exception object can be thrown * with an error message. * * @param PaymentContext $context Holds context for the payment, including order ID and payment method. * @param PaymentResult $result Result object for the transaction. */ do_action_ref_array( 'kkart_rest_checkout_process_payment_with_context', [ $context, &$result ] ); if ( ! $result instanceof PaymentResult ) { throw new RouteException( 'kkart_rest_checkout_invalid_payment_result', __( 'Invalid payment result received from payment method.', 'kkart' ), 500 ); } return $result; } catch ( \Exception $e ) { throw new RouteException( 'kkart_rest_checkout_process_payment_error', $e->getMessage(), 400 ); } } /** * Gets the chosen payment method ID from the request. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return string */ protected function get_request_payment_method_id( \WP_REST_Request $request ) { $payment_method = isset( $request['payment_method'] ) ? kkart_clean( wp_unslash( $request['payment_method'] ) ) : ''; $valid_methods = kkart()->payment_gateways->get_payment_gateway_ids(); if ( empty( $payment_method ) ) { throw new RouteException( 'kkart_rest_checkout_missing_payment_method', __( 'No payment method provided.', 'kkart' ), 400 ); } if ( ! in_array( $payment_method, $valid_methods, true ) ) { throw new RouteException( 'kkart_rest_checkout_invalid_payment_method', sprintf( // Translators: %s list of gateway ids. __( 'Invalid payment method provided. Please provide one of the following: %s', 'kkart' ), '`' . implode( '`, `', $valid_methods ) . '`' ), 400 ); } return $payment_method; } /** * Gets the chosen payment method from the request. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return \KKART_Payment_Gateway */ protected function get_request_payment_method( \WP_REST_Request $request ) { $payment_method = $this->get_request_payment_method_id( $request ); $gateways = kkart()->payment_gateways->payment_gateways(); $payment_method_object = isset( $gateways[ $payment_method ] ) ? $gateways[ $payment_method ] : false; // The abstract gateway is available method uses the cart global, so instead, check enabled directly. if ( ! $payment_method_object || ! kkart_string_to_bool( $payment_method_object->enabled ) ) { throw new RouteException( 'kkart_rest_checkout_payment_method_disabled', __( 'This payment gateway is not available.', 'kkart' ), 400 ); } return $payment_method_object; } /** * Gets and formats payment request data. * * @param \WP_REST_Request $request Request object. * @return array */ protected function get_request_payment_data( \WP_REST_Request $request ) { static $payment_data = []; if ( ! empty( $payment_data ) ) { return $payment_data; } if ( ! empty( $request['payment_data'] ) ) { foreach ( $request['payment_data'] as $data ) { $payment_data[ sanitize_key( $data['key'] ) ] = kkart_clean( $data['value'] ); } } return $payment_data; } } Submit