PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.5
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.5
16.3-a.5 16.3-a.7 16.3-a.3 16.3-a.1 16.2 16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 All 506 releases
← All changes | _inc/lib/core-api/wpcom-endpoints/memberships.php +232 -127 12.6.4 → 16.3-a.5 View file →
@@ -5,21 +5,31 @@
5 5 * @package Jetpack
6 6 * @since 7.3.0
7 7 */
8 8
9 -use Automattic\Jetpack\Connection\Client;
9 +use Automattic\Jetpack\Connection\Traits\WPCOM_REST_API_Proxy_Request;
10 10
11 +if ( ! defined( 'ABSPATH' ) ) {
12 + exit( 0 );
13 +}
14 +
11 15 /**
12 16 * Class WPCOM_REST_API_V2_Endpoint_Memberships
13 17 * This introduces V2 endpoints.
18 + *
19 + * @phan-constructor-used-for-side-effects
14 20 */
15 21 class WPCOM_REST_API_V2_Endpoint_Memberships extends WP_REST_Controller {
16 22
23 + use WPCOM_REST_API_Proxy_Request;
24 +
17 25 /**
18 26 * WPCOM_REST_API_V2_Endpoint_Memberships constructor.
19 27 */
20 28 public function __construct() {
21 - $this->namespace = 'wpcom/v2';
29 + $this->base_api_path = 'wpcom';
30 + $this->version = 'v2';
31 + $this->namespace = $this->base_api_path . '/' . $this->version;
22 32 $this->rest_base = 'memberships';
23 33 $this->wpcom_is_wpcom_only_endpoint = true;
24 34 $this->wpcom_is_site_specific_endpoint = true;
25 35 add_action( 'rest_api_init', array( $this, 'register_routes' ) );
@@ -57,8 +67,9 @@
57 67 'earn-newsletter',
58 68 'gutenberg',
59 69 'gutenberg-wpcom',
60 70 'launchpad',
71 + 'import-paid-subscribers',
61 72 ),
62 73 true
63 74 );
64 75 },
@@ -84,9 +95,9 @@
84 95 'type' => 'string',
85 96 'required' => true,
86 97 ),
87 98 'price' => array(
88 - 'type' => 'float',
99 + 'type' => 'number',
89 100 'required' => true,
90 101 ),
91 102 'currency' => array(
92 103 'type' => 'string',
@@ -102,8 +113,16 @@
102 113 ),
103 114 'buyer_can_change_amount' => array(
104 115 'type' => 'boolean',
105 116 ),
117 + 'tier' => array(
118 + 'type' => 'integer',
119 + 'required' => false,
120 + ),
121 + 'description' => array(
122 + 'type' => 'string',
123 + 'required' => false,
124 + ),
106 125 ),
107 126 ),
108 127 )
109 128 );
@@ -114,8 +133,22 @@
114 133 array(
115 134 'methods' => WP_REST_Server::CREATABLE,
116 135 'callback' => array( $this, 'create_products' ),
117 136 'permission_callback' => array( $this, 'can_modify_products_permission_check' ),
137 + 'args' => array(
138 + 'currency' => array(
139 + 'type' => 'string',
140 + 'required' => true,
141 + ),
142 + 'type' => array(
143 + 'type' => 'string',
144 + 'required' => true,
145 + ),
146 + 'is_editable' => array(
147 + 'type' => 'boolean',
148 + 'required' => false,
149 + ),
150 + ),
118 151 ),
119 152 array(
120 153 'methods' => WP_REST_Server::READABLE,
121 154 'callback' => array( $this, 'list_products' ),
@@ -136,9 +169,9 @@
136 169 'type' => 'string',
137 170 'required' => true,
138 171 ),
139 172 'price' => array(
140 - 'type' => 'float',
173 + 'type' => 'number',
141 174 'required' => true,
142 175 ),
143 176 'currency' => array(
144 177 'type' => 'string',
@@ -154,8 +187,16 @@
154 187 ),
155 188 'buyer_can_change_amount' => array(
156 189 'type' => 'boolean',
157 190 ),
191 + 'tier' => array(
192 + 'type' => 'integer',
193 + 'required' => false,
194 + ),
195 + 'description' => array(
196 + 'type' => 'string',
197 + 'required' => false,
198 + ),
158 199 ),
159 200 ),
160 201 array(
161 202 'methods' => WP_REST_Server::DELETABLE,
@@ -160,8 +201,14 @@
160 201 array(
161 202 'methods' => WP_REST_Server::DELETABLE,
162 203 'callback' => array( $this, 'delete_product' ),
163 204 'permission_callback' => array( $this, 'can_modify_products_permission_check' ),
205 + 'args' => array(
206 + 'cancel_subscriptions' => array(
207 + 'type' => 'boolean',
208 + 'required' => false,
209 + ),
210 + ),
164 211 ),
165 212 )
166 213 );
167 214 }
@@ -195,8 +242,9 @@
195 242 $is_editable = isset( $request['is_editable'] ) ? (bool) $request['is_editable'] : null;
196 243
197 244 if ( $this->is_wpcom() ) {
198 245 require_lib( 'memberships' );
246 + Memberships_Store_Sandbox::get_instance()->init( true );
199 247
200 248 $result = Memberships_Product::generate_default_products( get_current_blog_id(), $request['type'], $request['currency'], $is_editable );
201 249
202 250 if ( is_wp_error( $result ) ) {
@@ -204,39 +252,9 @@
204 252 return new WP_Error( $result->get_error_code(), $result->get_error_message(), array( 'status' => $status ) );
205 253 }
206 254 return $result;
207 255 } else {
208 - $payload = array(
209 - 'type' => $request['type'],
210 - 'currency' => $request['currency'],
211 - );
212 -
213 - // If we pass directly is_editable as null, it would break API argument validation.
214 - if ( null !== $is_editable ) {
215 - $payload['is_editable'] = $is_editable;
216 - }
217 -
218 - $blog_id = Jetpack_Options::get_option( 'id' );
219 - $response = Client::wpcom_json_api_request_as_user(
220 - "/sites/$blog_id/{$this->rest_base}/products",
221 - 'v2',
222 - array(
223 - 'method' => 'POST',
224 - ),
225 - $payload
226 - );
227 - if ( is_wp_error( $response ) ) {
228 - if ( $response->get_error_code() === 'missing_token' ) {
229 - return new WP_Error( 'missing_token', __( 'Please connect your user account to WordPress.com', 'jetpack' ), 404 );
230 - }
231 - return new WP_Error( 'wpcom_connection_error', __( 'Could not connect to WordPress.com', 'jetpack' ), 404 );
232 - }
233 - $data = isset( $response['body'] ) ? json_decode( $response['body'], true ) : null;
234 - // If endpoint returned error, we have to detect it.
235 - if ( 200 !== $response['response']['code'] && $data['code'] ) {
236 - return new WP_Error( $data['code'], $data['message'] ? $data['message'] : '', 401 );
237 - }
238 - return $data;
256 + return $this->proxy_request_to_wpcom_as_user( $request, 'products' );
239 257 }
240 258
241 259 return $request;
242 260 }
@@ -249,9 +267,9 @@
249 267 * @return WP_Error|array ['products']
250 268 */
251 269 public function list_products( WP_REST_Request $request ) {
252 270 $is_editable = isset( $request['is_editable'] ) ? (bool) $request['is_editable'] : null;
253 - $type = isset( $request['type'] ) ? $request['type'] : null;
271 + $type = $request['type'] ?? null;
254 272
255 273 if ( ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
256 274 require_lib( 'memberships' );
257 275 require_once JETPACK__PLUGIN_DIR . '/modules/memberships/class-jetpack-memberships.php';
@@ -260,19 +278,10 @@
260 278 } catch ( \Exception $e ) {
261 279 return array( 'error' => $e->getMessage() );
262 280 }
263 281 } else {
264 - $query_parts = array();
265 - if ( $type !== null ) {
266 - $query_parts[] = 'type=' . $type;
267 - }
268 - if ( $is_editable !== null ) {
269 - $query_parts[] = 'is_editable=' . $is_editable;
270 - }
271 - if ( ! empty( $query_parts ) ) {
272 - $query = '?' . implode( '&', $query_parts );
273 - }
274 - return $this->proxy_request_to_wpcom( "products$query", 'GET' );
282 +
283 + return $this->proxy_request_to_wpcom_as_user( $request, 'products' );
275 284 }
276 285 }
277 286
278 287 /**
@@ -284,8 +293,12 @@
284 293 */
285 294 public function create_product( WP_REST_Request $request ) {
286 295 $payload = $this->get_payload_for_product( $request );
287 296
297 + if ( is_wp_error( $payload ) ) {
298 + return $payload;
299 + }
300 +
288 301 if ( $this->is_wpcom() ) {
289 302 require_lib( 'memberships' );
290 303 try {
291 304 return $this->create_product_from_wpcom( $payload );
@@ -292,9 +305,9 @@
292 305 } catch ( \Exception $e ) {
293 306 return array( 'error' => $e->getMessage() );
294 307 }
295 308 } else {
296 - return $this->proxy_request_to_wpcom( 'product', 'POST', $payload );
309 + return $this->proxy_request_to_wpcom_as_user( $request, 'product' );
297 310 }
298 311 }
299 312
300 313 /**
@@ -307,8 +320,12 @@
307 320 public function update_product( \WP_REST_Request $request ) {
308 321 $product_id = $request->get_param( 'product_id' );
309 322 $payload = $this->get_payload_for_product( $request );
310 323
324 + if ( is_wp_error( $payload ) ) {
325 + return $payload;
326 + }
327 +
311 328 if ( $this->is_wpcom() ) {
312 329 require_lib( 'memberships' );
313 330 try {
314 331 return array( 'product' => $this->update_product_from_wpcom( $product_id, $payload ) );
@@ -315,9 +332,9 @@
315 332 } catch ( \Exception $e ) {
316 333 return array( 'error' => $e->getMessage() );
317 334 }
318 335 } else {
319 - return $this->proxy_request_to_wpcom( "product/$product_id", 'POST', $payload );
336 + return $this->proxy_request_to_wpcom_as_user( $request, "product/$product_id" );
320 337 }
321 338 }
322 339
323 340 /**
@@ -327,19 +344,20 @@
327 344 *
328 345 * @return array|WP_Error
329 346 */
330 347 public function delete_product( \WP_REST_Request $request ) {
331 - $product_id = $request->get_param( 'product_id' );
348 + $product_id = $request->get_param( 'product_id' );
349 + $cancel_subscriptions = $request->get_param( 'cancel_subscriptions' );
332 350 if ( $this->is_wpcom() ) {
333 351 require_lib( 'memberships' );
334 352 try {
335 - $this->delete_product_from_wpcom( $product_id );
353 + $this->delete_product_from_wpcom( $product_id, $cancel_subscriptions );
336 354 return array( 'deleted' => true );
337 355 } catch ( \Exception $e ) {
338 356 return array( 'error' => $e->getMessage() );
339 357 }
340 358 } else {
341 - return $this->proxy_request_to_wpcom( "product/$product_id", 'DELETE' );
359 + return $this->proxy_request_to_wpcom_as_user( $request, "product/$product_id" );
342 360 }
343 361 }
344 362
345 363 /**
@@ -350,87 +368,48 @@
350 368 * @return WP_Error|array ['products','connected_account_id','connect_url']
351 369 */
352 370 public function get_status( \WP_REST_Request $request ) {
353 371 $product_type = $request['type'];
354 - $source = $request['source'];
355 - $is_editable = ! isset( $request['is_editable'] ) ? null : (bool) $request['is_editable'];
356 372
373 + if ( ! empty( $request['source'] ) ) {
374 + $source = sanitize_text_field( wp_unslash( $request['source'] ) );
375 + } else {
376 + $source = 'gutenberg';
377 + }
378 +
379 + $is_editable = ! isset( $request['is_editable'] ) ? null : (bool) $request['is_editable'];
380 +
357 381 if ( $this->is_wpcom() ) {
358 382 require_lib( 'memberships' );
359 - $blog_id = get_current_blog_id();
360 - return (array) get_memberships_settings_for_site( $blog_id, $product_type, $is_editable, $source );
361 - } else {
362 - $payload = array(
363 - 'type' => $request['type'],
364 - 'source' => $source,
365 - );
383 + Memberships_Store_Sandbox::get_instance()->init( true );
384 + $blog_id = get_current_blog_id();
385 + $membership_settings = get_memberships_settings_for_site( $blog_id, $product_type, $is_editable, $source );
366 386
367 - // If we pass directly is_editable as null, it would break API argument validation.
368 - // This also needs to be converted to int because boolean false is ignored by add_query_arg.
369 - if ( null !== $is_editable ) {
370 - $payload['is_editable'] = (int) $is_editable;
371 - }
387 + if ( is_wp_error( $membership_settings ) ) {
388 + // Get error messages from the $membership_settings.
389 + $error_codes = $membership_settings->get_error_codes();
390 + $error_messages = array();
372 391
373 - $blog_id = Jetpack_Options::get_option( 'id' );
374 - $path = "/sites/$blog_id/{$this->rest_base}/status";
375 - if ( $product_type ) {
376 - $path = add_query_arg(
377 - $payload,
378 - $path
379 - );
380 - }
381 - $response = Client::wpcom_json_api_request_as_user( $path, 'v2' );
382 - if ( is_wp_error( $response ) ) {
383 - if ( $response->get_error_code() === 'missing_token' ) {
384 - return new WP_Error( 'missing_token', __( 'Please connect your user account to WordPress.com', 'jetpack' ), 404 );
392 + foreach ( $error_codes as $code ) {
393 + $messages = $membership_settings->get_error_messages( $code );
394 + foreach ( $messages as $message ) {
395 + // Sanitize error message
396 + $error_messages[] = esc_html( $message );
397 + }
385 398 }
386 - return new WP_Error( 'wpcom_connection_error', __( 'Could not connect to WordPress.com', 'jetpack' ), 404 );
387 - }
388 - $data = isset( $response['body'] ) ? json_decode( $response['body'], true ) : null;
389 - if ( 200 !== $response['response']['code'] && $data['code'] && $data['message'] ) {
390 - return new WP_Error( $data['code'], $data['message'], 401 );
391 - }
392 - return $data;
393 - }
394 - }
395 399
396 - /**
397 - * Proxy a request to WPCOM, look for errors and return a response or a WP_Error.
398 - *
399 - * @param string $uri Whatever would go at the end of the url after /sites/$blog_id/$this->rest_base/. This is usually `product`, `products`, or `product/$product_id`.
400 - * @param string $method The HTTP method being used.
401 - * @param array|null $payload An optional payload to be sent with the request.
402 - * @return string The response from WPCOM
403 - */
404 - private function proxy_request_to_wpcom( $uri, $method, $payload = null ) {
405 - // get blog id
406 - $blog_id = Jetpack_Options::get_option( 'id' );
400 + $error_messages_string = implode( ' ', $error_messages );
401 + // translators: %s is a list of error messages.
402 + $base_message = __( 'Could not get the membership settings due to the following error(s): %s', 'jetpack' );
403 + $full_message = sprintf( $base_message, $error_messages_string );
407 404
408 - // proxy request to wpcom
409 - $response = Client::wpcom_json_api_request_as_user(
410 - "/sites/$blog_id/{$this->rest_base}/$uri",
411 - 'v2',
412 - array(
413 - 'method' => strtoupper( $method ),
414 - ),
415 - $payload
416 - );
417 - if ( is_wp_error( $response ) ) {
418 - if ( $response->get_error_code() === 'missing_token' ) {
419 - return new WP_Error( 'missing_token', __( 'Please connect your user account to WordPress.com', 'jetpack' ), 404 );
405 + return new WP_Error( 'membership_settings_error', $full_message, array( 'status' => 404 ) );
420 406 }
421 - return new WP_Error( 'wpcom_connection_error', __( 'Could not connect to WordPress.com', 'jetpack' ), 404 );
422 - }
423 407
424 - // decode response
425 - $data = isset( $response['body'] ) ? json_decode( $response['body'], true ) : null;
426 - // If endpoint returned error, we have to detect it.
427 - if ( 200 !== $response['response']['code'] && $data['code'] && $data['message'] ) {
428 - return new WP_Error( $data['code'], $data['message'], 401 );
408 + return (array) $membership_settings;
409 + } else {
410 + return $this->proxy_request_to_wpcom_as_user( $request, 'status' );
429 411 }
430 -
431 - // return response
432 - return $data;
433 412 }
434 413
435 414 /**
436 415 * This function throws an exception if it is run outside of wpcom.
@@ -448,14 +427,15 @@
448 427 * List products via the WPCOM-specific Memberships_Product class.
449 428 *
450 429 * @param WP_REST_Request $request The request for this endpoint.
451 430 * @param ?string $type The type of the products to list.
452 - * @param ?string $is_editable This string will be interpreted as a bool to determine if we are looking for editable or non-editable products.
431 + * @param ?bool $is_editable If we are looking for editable or non-editable products.
453 432 * @throws \Exception If blog is not known or if there is an error getting products.
454 433 * @return array List of products.
455 434 */
456 435 private function list_products_from_wpcom( WP_REST_Request $request, $type, $is_editable ) {
457 436 $this->prevent_running_outside_of_wpcom();
437 + Memberships_Store_Sandbox::get_instance()->init( true );
458 438 $blog_id = $request->get_param( 'blog_id' );
459 439 if ( is_wp_error( $blog_id ) ) {
460 440 throw new \Exception( 'Unknown blog' );
461 441 }
@@ -474,8 +454,9 @@
474 454 * @return object The found product.
475 455 */
476 456 private function find_product_from_wpcom( $product_id ) {
477 457 $this->prevent_running_outside_of_wpcom();
458 + Memberships_Store_Sandbox::get_instance()->init( true );
478 459 $product = Memberships_Product::get_from_post( get_current_blog_id(), $product_id );
479 460 if ( is_wp_error( $product ) ) {
480 461 throw new \Exception( $product->get_error_message() );
481 462 }
@@ -489,12 +470,13 @@
489 470 * Create a product via the WPCOM-specific Memberships_Product class.
490 471 *
491 472 * @param array $payload The request payload which contains details about the product.
492 473 * @throws \Exception When the product failed to be created.
493 - * @return object The newly created product.
474 + * @return array The newly created product.
494 475 */
495 476 private function create_product_from_wpcom( $payload ) {
496 477 $this->prevent_running_outside_of_wpcom();
478 + Memberships_Store_Sandbox::get_instance()->init( true );
497 479 $product = Memberships_Product::create( get_current_blog_id(), $payload );
498 480 if ( is_wp_error( $product ) ) {
499 481 throw new \Exception( __( 'Creating product has failed.', 'jetpack' ) );
500 482 }
@@ -509,8 +491,9 @@
509 491 * @throws \Exception When there is a problem updating the product.
510 492 * @return object The newly updated product.
511 493 */
512 494 private function update_product_from_wpcom( $product_id, $payload ) {
495 + Memberships_Store_Sandbox::get_instance()->init( true );
513 496 $product = $this->find_product_from_wpcom( $product_id ); // prevents running outside of wpcom
514 497 $updated_product = $product->update( $payload );
515 498 if ( is_wp_error( $updated_product ) ) {
516 499 throw new \Exception( $updated_product->get_error_message() );
@@ -521,14 +504,16 @@
521 504 /**
522 505 * Delete a product via the WPCOM-specific Memberships_Product class.
523 506 *
524 507 * @param string|int $product_id The ID of the product being deleted.
508 + * @param bool $cancel_subscriptions Whether to cancel subscriptions to the product as well.
525 509 * @throws \Exception When there is a problem deleting the product.
526 510 * @return void
527 511 */
528 - private function delete_product_from_wpcom( $product_id ) {
512 + private function delete_product_from_wpcom( $product_id, $cancel_subscriptions = false ) {
513 + Memberships_Store_Sandbox::get_instance()->init( true );
529 514 $product = $this->find_product_from_wpcom( $product_id ); // prevents running outside of wpcom
530 - $result = $product->delete();
515 + $result = $product->delete( $cancel_subscriptions ? Memberships_Product::CANCEL_SUBSCRIPTIONS : Memberships_Product::KEEP_SUBSCRIPTIONS );
531 516 if ( is_wp_error( $result ) ) {
532 517 throw new \Exception( $result->get_error_message() );
533 518 }
534 519 }
@@ -536,21 +521,29 @@
536 521 /**
537 522 * Get a payload for creating or updating products by parsing the request.
538 523 *
539 524 * @param WP_REST_Request $request The request for this endpoint, containing the details needed to build the payload.
540 - * @return array The built payload.
525 + * @return array|WP_Error The built payload or WP_Error on validation failure.
541 526 */
542 527 private function get_payload_for_product( WP_REST_Request $request ) {
543 528 $is_editable = isset( $request['is_editable'] ) ? (bool) $request['is_editable'] : null;
544 - $type = isset( $request['type'] ) ? $request['type'] : null;
529 + $type = $request['type'] ?? null;
530 + $tier = $request['tier'] ?? null;
545 531 $buyer_can_change_amount = isset( $request['buyer_can_change_amount'] ) && (bool) $request['buyer_can_change_amount'];
532 + $interval = $request['interval'];
546 533
534 + // Validate tier field usage.
535 + $tier_validation = $this->validate_tier_field( $request, $tier, $type, $interval );
536 + if ( is_wp_error( $tier_validation ) ) {
537 + return $tier_validation;
538 + }
539 +
547 540 $payload = array(
548 541 'title' => $request['title'],
549 542 'price' => $request['price'],
550 543 'currency' => $request['currency'],
551 544 'buyer_can_change_amount' => $buyer_can_change_amount,
552 - 'interval' => $request['interval'],
545 + 'interval' => $interval,
553 546 'type' => $type,
554 547 'welcome_email_content' => $request['welcome_email_content'],
555 548 'subscribe_as_site_subscriber' => $request['subscribe_as_site_subscriber'],
556 549 'multiple_per_user' => $request['multiple_per_user'],
@@ -555,13 +548,125 @@
555 548 'subscribe_as_site_subscriber' => $request['subscribe_as_site_subscriber'],
556 549 'multiple_per_user' => $request['multiple_per_user'],
557 550 );
558 551
552 + if ( null !== $tier ) {
553 + $payload['tier'] = $tier;
554 + }
555 +
559 556 // If we pass directly the value "null", it will break the argument validation.
560 557 if ( null !== $is_editable ) {
561 558 $payload['is_editable'] = $is_editable;
562 559 }
560 +
561 + if ( isset( $request['description'] ) ) {
562 + $payload['description'] = $request['description'];
563 + }
564 +
563 565 return $payload;
566 + }
567 +
568 + /**
569 + * Validate tier field usage for newsletter plans.
570 + *
571 + * @param WP_REST_Request $request The request object.
572 + * @param string|null $tier The tier value to validate.
573 + * @param string|null $type The product type.
574 + * @param string $interval The product interval.
575 + * @return WP_Error|null Error object if validation fails, null if successful.
576 + */
577 + private function validate_tier_field( WP_REST_Request $request, $tier, $type, $interval ) {
578 + // Only apply tier validation for newsletter plans with type 'tier'.
579 + if ( null === $tier || 'tier' !== $type ) {
580 + return null;
581 + }
582 +
583 + // Monthly plans should not have a tier field.
584 + if ( '1 month' === $interval ) {
585 + return new WP_Error( 'invalid_tier_usage', __( 'Monthly plans should not have a tier field. The tier field is only used to link yearly plans to their corresponding monthly plans.', 'jetpack' ), array( 'status' => 400 ) );
586 + }
587 +
588 + // Yearly plans must have a valid tier that points to a monthly plan.
589 + if ( '1 year' === $interval ) {
590 + return $this->validate_yearly_tier( $request, $tier );
591 + }
592 +
593 + return null;
594 + }
595 +
596 + /**
597 + * Validate yearly tier requirements.
598 + *
599 + * @param WP_REST_Request $request The request object.
600 + * @param string|int $tier The tier value to validate.
601 + * @return WP_Error|null Error object if validation fails, null if successful.
602 + */
603 + private function validate_yearly_tier( WP_REST_Request $request, $tier ) {
604 + if ( ! is_numeric( $tier ) || $tier <= 0 ) {
605 + return new WP_Error( 'invalid_tier_id', __( 'Yearly plans must have a valid tier ID that points to an existing monthly plan.', 'jetpack' ), array( 'status' => 400 ) );
606 + }
607 +
608 + if ( ! $this->is_wpcom() ) {
609 + return null; // Validation will happen on WPCOM side.
610 + }
611 +
612 + return $this->validate_tier_references( $request, $tier );
613 + }
614 +
615 + /**
616 + * Validate that the tier references a valid monthly plan and check for duplicates.
617 + *
618 + * @param WP_REST_Request $request The request object.
619 + * @param string|int $tier The tier value to validate.
620 + * @return WP_Error|null Error object if validation fails, null if successful.
621 + */
622 + private function validate_tier_references( WP_REST_Request $request, $tier ) {
623 + require_lib( 'memberships' );
624 + Memberships_Store_Sandbox::get_instance()->init( true );
625 +
626 + // Check if the referenced monthly plan exists and is actually a monthly plan.
627 + $monthly_plan = Memberships_Product::get_from_post( get_current_blog_id(), $tier );
628 + if ( is_wp_error( $monthly_plan ) || ! $monthly_plan ) {
629 + return new WP_Error( 'tier_not_found', __( 'The specified tier ID does not correspond to an existing monthly plan.', 'jetpack' ), array( 'status' => 400 ) );
630 + }
631 +
632 + $monthly_plan_data = $monthly_plan->to_array();
633 + if ( '1 month' !== $monthly_plan_data['interval'] ) {
634 + return new WP_Error( 'invalid_tier_interval', __( 'The specified tier ID must point to a monthly plan (1 month interval).', 'jetpack' ), array( 'status' => 400 ) );
635 + }
636 +
637 + return $this->check_duplicate_tier_references( $request, $tier );
638 + }
639 +
640 + /**
641 + * Check for duplicate tier references.
642 + *
643 + * @param WP_REST_Request $request The request object.
644 + * @param string|int $tier The tier value to check.
645 + * @return WP_Error|null Error object if duplicate found, null if successful.
646 + */
647 + private function check_duplicate_tier_references( WP_REST_Request $request, $tier ) {
648 + $existing_yearly_plans = Memberships_Product::get_product_list( get_current_blog_id(), 'tier', null, false );
649 + if ( is_wp_error( $existing_yearly_plans ) ) {
650 + return new WP_Error( 'product_list_error', __( 'Could not retrieve existing products to check for duplicate tier references.', 'jetpack' ), array( 'status' => 500 ) );
651 + }
652 +
653 + // Ensure the result is iterable before foreach.
654 + if ( ! is_array( $existing_yearly_plans ) && ! $existing_yearly_plans instanceof Traversable ) {
655 + return new WP_Error( 'invalid_product_list', __( 'Unexpected error: product list is not iterable.', 'jetpack' ), array( 'status' => 500 ) );
656 + }
657 +
658 + foreach ( $existing_yearly_plans as $existing_plan ) {
659 + if ( isset( $existing_plan['tier'] ) && (string) $existing_plan['tier'] === (string) $tier && '1 year' === $existing_plan['interval'] ) {
660 + // If this is an update, allow it to reference itself.
661 + $product_id = $request->get_param( 'product_id' );
662 + if ( ! $product_id || (string) $existing_plan['id'] !== (string) $product_id ) {
663 + return new WP_Error( 'duplicate_tier_reference', __( 'Another yearly plan already references this monthly plan. Each monthly plan can only have one corresponding yearly plan.', 'jetpack' ), array( 'status' => 400 ) );
664 + }
665 + }
666 + }
667 +
668 + return null;
564 669 }
565 670
566 671 /**
567 672 * Returns true if run from WPCOM.