chromed

Back Back Up Advanced Editor

<?php

declare( strict_types = 1 );

namespace Automattic\WooCommerce\Internal\PushNotifications\Controllers;

defined( 'ABSPATH' ) || exit;

use Automattic\Jetpack\Connection\Rest_Authentication;
use Automattic\WooCommerce\Internal\PushNotifications\DataStores\PushTokensDataStore;
use Automattic\WooCommerce\Internal\PushNotifications\Entities\PushToken;
use Automattic\WooCommerce\Internal\PushNotifications\Exceptions\PushTokenNotFoundException;
use Automattic\WooCommerce\Internal\PushNotifications\PushNotifications;
use Automattic\WooCommerce\Internal\PushNotifications\Traits\AuthorizesPushNotificationRequests;
use Automattic\WooCommerce\Internal\PushNotifications\Traits\ConvertsExceptionsToWpError;
use Automattic\WooCommerce\Internal\PushNotifications\Validators\PushTokenValidator;
use Automattic\WooCommerce\Internal\RestApiControllerBase;
use Exception;
use WC_Data_Exception;
use WP_REST_Server;
use WP_REST_Request;
use WP_REST_Response;
use WP_Error;
use WP_Http;

/**
 * Controller for the REST endpoints associated with push notification device
 * tokens.
 *
 * @since 10.6.0
 */
class PushTokenRestController extends RestApiControllerBase {
	use AuthorizesPushNotificationRequests;
	use ConvertsExceptionsToWpError;

/**
	 * The root namespace for the JSON REST API endpoints.
	 *
	 * @var string
	 */
	protected string $route_namespace = 'wc-push-notifications';

/**
	 * The REST base for the endpoints URL.
	 *
	 * @var string
	 */
	protected string $rest_base = 'push-tokens';

/**
	 * Class identifier used by `woocommerce_rest_api_get_rest_namespaces`.
	 *
	 * Intentionally distinct from the URL `$route_namespace` — the filter keys
	 * one class per value here, so sharing the value with sibling controllers
	 * in the same module would overwrite them.
	 *
	 * @since 10.6.0
	 *
	 * @return string
	 */
	protected function get_rest_api_namespace(): string {
		return 'wc-push-notifications-push-tokens';
	}

/**
	 * Register the REST API endpoints handled by this controller.
	 *
	 * @since 10.6.0
	 *
	 * @return void
	 */
	public function register_routes(): void {
		register_rest_route(
			$this->route_namespace,
			$this->rest_base,
			array(
				array(
					'methods'             => WP_REST_Server::READABLE,
					'callback'            => fn ( WP_REST_Request $request ) => $this->run( $request, 'index' ),
					'permission_callback' => array( $this, 'authorize_as_from_wpcom' ),
					'args'                => array(
						'page'     => array(
							'description'       => __( 'Current page of the collection.', 'woocommerce' ),
							'type'              => 'integer',
							'default'           => 1,
							'minimum'           => 1,
							'sanitize_callback' => 'absint',
							'validate_callback' => 'rest_validate_request_arg',
						),
						'per_page' => array(
							'description'       => __( 'Maximum number of items to be returned in result set.', 'woocommerce' ),
							'type'              => 'integer',
							'default'           => 10,
							'minimum'           => 1,
							'maximum'           => 100,
							'sanitize_callback' => 'absint',
							'validate_callback' => 'rest_validate_request_arg',
						),
					),
				),
				array(
					'methods'             => WP_REST_Server::CREATABLE,
					'callback'            => fn ( WP_REST_Request $request ) => $this->run( $request, 'create' ),
					'args'                => $this->get_args( 'create' ),
					'permission_callback' => array( $this, 'authorize_as_authenticated' ),
					'schema'              => array( $this, 'get_schema' ),
				),
			)
		);

register_rest_route(
			$this->route_namespace,
			$this->rest_base . '/(?P<id>[\d]+)',
			array(
				array(
					'methods'             => WP_REST_Server::DELETABLE,
					'callback'            => fn ( WP_REST_Request $request ) => $this->run( $request, 'delete' ),
					'args'                => $this->get_args( 'delete' ),
					'permission_callback' => array( $this, 'authorize_as_authenticated' ),
					'schema'              => array( $this, 'get_schema' ),
				),
			)
		);
	}

/**
	 * Returns all push tokens for roles that can receive push notifications,
	 * formatted for the WPCOM push notifications endpoint.
	 *
	 * @since 10.8.0
	 *
	 * @param WP_REST_Request $request The request object.
	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
	 * @return WP_REST_Response|WP_Error
	 */
	public function index( WP_REST_Request $request ) {
		$page     = (int) $request->get_param( 'page' );
		$per_page = (int) $request->get_param( 'per_page' );

try {
			/**
			 * Paginated result from get_tokens_for_roles.
			 *
			 * @var array{tokens: PushToken[], total: int, total_pages: int} $result
			 */
			$result = wc_get_container()
				->get( PushTokensDataStore::class )
				->get_tokens_for_roles(
					PushNotifications::ROLES_WITH_PUSH_NOTIFICATIONS_ENABLED,
					$page,
					$per_page
				);
		} catch ( Exception $e ) {
			return $this->convert_exception_to_wp_error( $e );
		}

$response = new WP_REST_Response(
			array(
				'tokens' => array_map(
					fn ( $token ) => $token->to_wpcom_format(),
					$result['tokens']
				),
			),
			WP_Http::OK
		);

$response->header( 'X-WP-Total', (string) $result['total'] );
		$response->header( 'X-WP-TotalPages', (string) $result['total_pages'] );

return $response;
	}

/**
	 * Creates a push token record.
	 *
	 * @since 10.6.0
	 *
	 * @param WP_REST_Request $request The request object.
	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
	 * @return WP_REST_Response|WP_Error
	 */
	public function create( WP_REST_Request $request ) {
		try {
			$data = array(
				'user_id'       => get_current_user_id(),
				'token'         => $request->get_param( 'token' ),
				'platform'      => $request->get_param( 'platform' ),
				'device_uuid'   => $request->get_param( 'device_uuid' ),
				'origin'        => $request->get_param( 'origin' ),
				'device_locale' => $request->get_param( 'device_locale' ),
				'metadata'      => $request->get_param( 'metadata' ) ?? array(),
			);

$data_store = wc_get_container()->get( PushTokensDataStore::class );
			$push_token = $data_store->get_by_token_or_device_id( $data );

if ( $push_token ) {
				$push_token->set_token( $data['token'] );
				$push_token->set_device_uuid( $data['device_uuid'] );
				$push_token->set_device_locale( $data['device_locale'] );
				$push_token->set_metadata( $data['metadata'] );
				$data_store->update( $push_token );
			} else {
				$push_token = $data_store->create( $data );
			}
		} catch ( Exception $e ) {
			return $this->convert_exception_to_wp_error( $e );
		}

return new WP_REST_Response(
			array( 'id' => $push_token->get_id() ),
			WP_Http::CREATED
		);
	}

/**
	 * Deletes a push token record.
	 *
	 * @since 10.6.0
	 *
	 * @param WP_REST_Request $request The request object.
	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
	 * @throws PushTokenNotFoundException If token does not belong to authenticated user.
	 * @throws WC_Data_Exception If token wasn't deleted.
	 * @return WP_REST_Response|WP_Error
	 */
	public function delete( WP_REST_Request $request ) {
		try {
			$id         = (int) $request->get_param( 'id' );
			$data_store = wc_get_container()->get( PushTokensDataStore::class );
			$push_token = $data_store->read( $id );

if ( $push_token->get_user_id() !== get_current_user_id() ) {
				throw new PushTokenNotFoundException();
			}

$deleted = $data_store->delete( $id );

if ( ! $deleted ) {
				throw new WC_Data_Exception(
					'woocommerce_push_token_not_deleted',
					'The push token could not be deleted.',
					WP_Http::INTERNAL_SERVER_ERROR
				);
			}
		} catch ( Exception $e ) {
			return $this->convert_exception_to_wp_error( $e );
		}

return new WP_REST_Response( null, WP_Http::NO_CONTENT );
	}

/**
	 * Validates the arguments from the request via PushTokenValidator.
	 *
	 * @since 10.6.0
	 *
	 * @param mixed           $value The value being validated.
	 * @param WP_REST_Request $request The request object.
	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
	 * @param string          $param The name of the parameter being validated.
	 * @return bool|WP_Error
	 */
	public function validate_argument( $value, WP_REST_Request $request, string $param ) {
		return PushTokenValidator::validate( $request->get_params(), array( $param ) );
	}

/**
	 * Get the schema for the POST endpoint.
	 *
	 * @since 10.6.0
	 *
	 * @return array[]
	 */
	public function get_schema(): array {
		return array_merge(
			$this->get_base_schema(),
			array(
				'title'      => PushToken::POST_TYPE,
				'properties' => array_map(
					fn ( $item ) => array_intersect_key(
						$item,
						array(
							'description' => null,
							'type'        => null,
							'enum'        => null,
							'minimum'     => null,
							'default'     => null,
							'required'    => null,
						)
					),
					$this->get_args()
				),
			)
		);
	}

/**
	 * Validates that the request is signed with a Jetpack blog token,
	 * ensuring only WPCOM can access this endpoint.
	 *
	 * @since 10.8.0
	 *
	 * @param WP_REST_Request $request The request object.
	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
	 * @return bool|WP_Error
	 */
	public function authorize_as_from_wpcom( WP_REST_Request $request ) {
		if ( ! wc_get_container()->get( PushNotifications::class )->should_be_enabled() ) {
			return false;
		}

if (
			class_exists( Rest_Authentication::class )
			&& Rest_Authentication::is_signed_with_blog_token()
		) {
			return true;
		}

return new WP_Error(
			'woocommerce_rest_cannot_view',
			__( 'Sorry, you are not allowed to do that.', 'woocommerce' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}

/**
	 * Get the accepted arguments for the POST request.
	 *
	 * @since 10.6.0
	 *
	 * @param string $context The context to return args for.
	 * @return array
	 */
	private function get_args( ?string $context = null ): array {
		$args = array(
			'id'            => array(
				'description'       => __( 'Push Token ID', 'woocommerce' ),
				'type'              => 'integer',
				'required'          => true,
				'context'           => array( 'delete' ),
				'minimum'           => 1,
				'sanitize_callback' => 'absint',
				'validate_callback' => array( $this, 'validate_argument' ),
			),
			'origin'        => array(
				'description'       => __( 'Origin', 'woocommerce' ),
				'type'              => 'string',
				'required'          => true,
				'context'           => array( 'create' ),
				'enum'              => PushToken::ORIGINS,
				'validate_callback' => array( $this, 'validate_argument' ),
			),
			'device_uuid'   => array(
				'description'       => __( 'Device UUID', 'woocommerce' ),
				'default'           => '',
				'type'              => 'string',
				'context'           => array( 'create' ),
				'validate_callback' => array( $this, 'validate_argument' ),
				'sanitize_callback' => 'sanitize_text_field',
			),
			'device_locale' => array(
				'description'       => __( 'Device Locale', 'woocommerce' ),
				'type'              => 'string',
				'required'          => true,
				'context'           => array( 'create' ),
				'validate_callback' => array( $this, 'validate_argument' ),
				'sanitize_callback' => 'sanitize_text_field',
			),
			'platform'      => array(
				'description'       => __( 'Platform', 'woocommerce' ),
				'type'              => 'string',
				'required'          => true,
				'context'           => array( 'create' ),
				'enum'              => PushToken::PLATFORMS,
				'validate_callback' => array( $this, 'validate_argument' ),
			),
			'token'         => array(
				'description'       => __( 'Push Token', 'woocommerce' ),
				'type'              => 'string',
				'required'          => true,
				'context'           => array( 'create' ),
				'validate_callback' => array( $this, 'validate_argument' ),
				'sanitize_callback' => 'wp_unslash',
			),
			'metadata'      => array(
				'description'       => __( 'Metadata', 'woocommerce' ),
				'type'              => 'object',
				'context'           => array( 'create' ),
				'validate_callback' => array( $this, 'validate_argument' ),
				'sanitize_callback' => 'wp_unslash',
			),
		);

if ( $context ) {
			$args = array_filter(
				$args,
				fn ( $arg ) => in_array( $context, $arg['context'], true )
			);
		}

return $args;
	}
}