AgenticCheckoutUtils.php
1 month ago
ArrayUtils.php
2 years ago
CartController.php
2 months ago
CartTokenUtils.php
3 weeks ago
CheckoutTrait.php
2 months ago
DraftOrderTrait.php
2 years ago
JsonWebToken.php
1 year ago
LocalPickupUtils.php
7 months ago
NoticeHandler.php
2 weeks ago
OrderAuthorizationTrait.php
1 month ago
OrderController.php
3 weeks ago
Pagination.php
2 years ago
PaymentUtils.php
1 year ago
ProductItemTrait.php
2 months ago
ProductLinksTrait.php
5 months ago
ProductQuery.php
1 month ago
ProductQueryFilters.php
1 month ago
QuantityLimits.php
1 year ago
RateLimits.php
1 year ago
SanitizationUtils.php
2 years ago
ValidationUtils.php
2 years ago
CartTokenUtils.php
108 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Cart token utility functions. |
| 4 | */ |
| 5 | |
| 6 | declare(strict_types=1); |
| 7 | |
| 8 | namespace Automattic\WooCommerce\StoreApi\Utilities; |
| 9 | |
| 10 | use Automattic\WooCommerce\StoreApi\Authentication; |
| 11 | use Automattic\WooCommerce\StoreApi\Utilities\JsonWebToken; |
| 12 | |
| 13 | /** |
| 14 | * Cart token utility functions. |
| 15 | */ |
| 16 | class CartTokenUtils { |
| 17 | /** |
| 18 | * Generate a cart token. |
| 19 | * |
| 20 | * @param string $customer_id The customer ID. |
| 21 | * @return string |
| 22 | */ |
| 23 | public static function get_cart_token( string $customer_id ): string { |
| 24 | return JsonWebToken::create( |
| 25 | array( |
| 26 | 'user_id' => $customer_id, |
| 27 | 'exp' => self::get_cart_token_expiration(), |
| 28 | 'iss' => 'store-api', |
| 29 | ), |
| 30 | self::get_cart_token_secret() |
| 31 | ); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Get the cart token sent with the current HTTP request. |
| 36 | * |
| 37 | * @since 11.1.0 |
| 38 | * @return string |
| 39 | */ |
| 40 | public static function get_request_cart_token(): string { |
| 41 | $cart_token = wc_clean( wp_unslash( $_SERVER['HTTP_CART_TOKEN'] ?? '' ) ); |
| 42 | |
| 43 | return is_string( $cart_token ) ? $cart_token : ''; |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Validate the cart token. |
| 48 | * |
| 49 | * @param string $cart_token The cart token. |
| 50 | * @return bool |
| 51 | */ |
| 52 | public static function validate_cart_token( string $cart_token ): bool { |
| 53 | return JsonWebToken::validate( $cart_token, self::get_cart_token_secret() ); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Get the cart token payload. |
| 58 | * |
| 59 | * Returns an empty payload unless the signature validates. |
| 60 | * |
| 61 | * @since 11.1.0 Returns an empty payload for tokens that fail signature validation. |
| 62 | * @param string $cart_token The cart token. |
| 63 | * @return array |
| 64 | */ |
| 65 | public static function get_cart_token_payload( string $cart_token ): array { |
| 66 | if ( ! self::validate_cart_token( $cart_token ) ) { |
| 67 | return array( |
| 68 | 'user_id' => '', |
| 69 | 'exp' => 0, |
| 70 | 'iss' => '', |
| 71 | ); |
| 72 | } |
| 73 | |
| 74 | $parts = JsonWebToken::get_parts( $cart_token )->payload; |
| 75 | |
| 76 | return array( |
| 77 | 'user_id' => $parts->user_id ?? '', |
| 78 | 'exp' => $parts->exp ?? 0, |
| 79 | 'iss' => $parts->iss ?? '', |
| 80 | ); |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Get the cart token secret. |
| 85 | * |
| 86 | * @return string |
| 87 | */ |
| 88 | private static function get_cart_token_secret(): string { |
| 89 | return '@' . wp_salt(); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Gets the expiration of the cart token. Defaults to 48h. |
| 94 | * |
| 95 | * @since 11.1.0 Made public. |
| 96 | * @return int |
| 97 | */ |
| 98 | public static function get_cart_token_expiration(): int { |
| 99 | /** |
| 100 | * Filters the session expiration. |
| 101 | * |
| 102 | * @since 5.0.0 |
| 103 | * @param int $expiration Expiration in seconds. |
| 104 | */ |
| 105 | return time() + intval( apply_filters( 'wc_session_expiration', DAY_IN_SECONDS * 2 ) ); |
| 106 | } |
| 107 | } |
| 108 |