PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.1
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.1
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 13.9.2 14.0.1 All 504 releases
← All changes | _inc/lib/core-api/wpcom-endpoints/memberships.php +172 -129 13.5.2 → 16.3-a.1 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',
@@ -106,8 +117,12 @@
106 117 'tier' => array(
107 118 'type' => 'integer',
108 119 'required' => false,
109 120 ),
121 + 'description' => array(
122 + 'type' => 'string',
123 + 'required' => false,
124 + ),
110 125 ),
111 126 ),
112 127 )
113 128 );
@@ -118,8 +133,22 @@
118 133 array(
119 134 'methods' => WP_REST_Server::CREATABLE,
120 135 'callback' => array( $this, 'create_products' ),
121 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 + ),
122 151 ),
123 152 array(
124 153 'methods' => WP_REST_Server::READABLE,
125 154 'callback' => array( $this, 'list_products' ),
@@ -140,9 +169,9 @@
140 169 'type' => 'string',
141 170 'required' => true,
142 171 ),
143 172 'price' => array(
144 - 'type' => 'float',
173 + 'type' => 'number',
145 174 'required' => true,
146 175 ),
147 176 'currency' => array(
148 177 'type' => 'string',
@@ -162,8 +191,12 @@
162 191 'tier' => array(
163 192 'type' => 'integer',
164 193 'required' => false,
165 194 ),
195 + 'description' => array(
196 + 'type' => 'string',
197 + 'required' => false,
198 + ),
166 199 ),
167 200 ),
168 201 array(
169 202 'methods' => WP_REST_Server::DELETABLE,
@@ -219,39 +252,9 @@
219 252 return new WP_Error( $result->get_error_code(), $result->get_error_message(), array( 'status' => $status ) );
220 253 }
221 254 return $result;
222 255 } else {
223 - $payload = array(
224 - 'type' => $request['type'],
225 - 'currency' => $request['currency'],
226 - );
227 -
228 - // If we pass directly is_editable as null, it would break API argument validation.
229 - if ( null !== $is_editable ) {
230 - $payload['is_editable'] = $is_editable;
231 - }
232 -
233 - $blog_id = Jetpack_Options::get_option( 'id' );
234 - $response = Client::wpcom_json_api_request_as_user(
235 - "/sites/$blog_id/{$this->rest_base}/products",
236 - 'v2',
237 - array(
238 - 'method' => 'POST',
239 - ),
240 - $payload
241 - );
242 - if ( is_wp_error( $response ) ) {
243 - if ( $response->get_error_code() === 'missing_token' ) {
244 - return new WP_Error( 'missing_token', __( 'Please connect your user account to WordPress.com', 'jetpack' ), 404 );
245 - }
246 - return new WP_Error( 'wpcom_connection_error', __( 'Could not connect to WordPress.com', 'jetpack' ), 404 );
247 - }
248 - $data = isset( $response['body'] ) ? json_decode( $response['body'], true ) : null;
249 - // If endpoint returned error, we have to detect it.
250 - if ( 200 !== $response['response']['code'] && $data['code'] ) {
251 - return new WP_Error( $data['code'], $data['message'] ? $data['message'] : '', 401 );
252 - }
253 - return $data;
256 + return $this->proxy_request_to_wpcom_as_user( $request, 'products' );
254 257 }
255 258
256 259 return $request;
257 260 }
@@ -263,11 +266,10 @@
263 266 *
264 267 * @return WP_Error|array ['products']
265 268 */
266 269 public function list_products( WP_REST_Request $request ) {
267 - $query = null;
268 270 $is_editable = isset( $request['is_editable'] ) ? (bool) $request['is_editable'] : null;
269 - $type = isset( $request['type'] ) ? $request['type'] : null;
271 + $type = $request['type'] ?? null;
270 272
271 273 if ( ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
272 274 require_lib( 'memberships' );
273 275 require_once JETPACK__PLUGIN_DIR . '/modules/memberships/class-jetpack-memberships.php';
@@ -276,19 +278,10 @@
276 278 } catch ( \Exception $e ) {
277 279 return array( 'error' => $e->getMessage() );
278 280 }
279 281 } else {
280 - $query_parts = array();
281 - if ( $type !== null ) {
282 - $query_parts[] = 'type=' . $type;
283 - }
284 - if ( $is_editable !== null ) {
285 - $query_parts[] = 'is_editable=' . $is_editable;
286 - }
287 - if ( ! empty( $query_parts ) ) {
288 - $query = '?' . implode( '&', $query_parts );
289 - }
290 - return $this->proxy_request_to_wpcom( "products$query", 'GET' );
282 +
283 + return $this->proxy_request_to_wpcom_as_user( $request, 'products' );
291 284 }
292 285 }
293 286
294 287 /**
@@ -300,8 +293,12 @@
300 293 */
301 294 public function create_product( WP_REST_Request $request ) {
302 295 $payload = $this->get_payload_for_product( $request );
303 296
297 + if ( is_wp_error( $payload ) ) {
298 + return $payload;
299 + }
300 +
304 301 if ( $this->is_wpcom() ) {
305 302 require_lib( 'memberships' );
306 303 try {
307 304 return $this->create_product_from_wpcom( $payload );
@@ -308,9 +305,9 @@
308 305 } catch ( \Exception $e ) {
309 306 return array( 'error' => $e->getMessage() );
310 307 }
311 308 } else {
312 - return $this->proxy_request_to_wpcom( 'product', 'POST', $payload );
309 + return $this->proxy_request_to_wpcom_as_user( $request, 'product' );
313 310 }
314 311 }
315 312
316 313 /**
@@ -323,8 +320,12 @@
323 320 public function update_product( \WP_REST_Request $request ) {
324 321 $product_id = $request->get_param( 'product_id' );
325 322 $payload = $this->get_payload_for_product( $request );
326 323
324 + if ( is_wp_error( $payload ) ) {
325 + return $payload;
326 + }
327 +
327 328 if ( $this->is_wpcom() ) {
328 329 require_lib( 'memberships' );
329 330 try {
330 331 return array( 'product' => $this->update_product_from_wpcom( $product_id, $payload ) );
@@ -331,9 +332,9 @@
331 332 } catch ( \Exception $e ) {
332 333 return array( 'error' => $e->getMessage() );
333 334 }
334 335 } else {
335 - return $this->proxy_request_to_wpcom( "product/$product_id", 'POST', $payload );
336 + return $this->proxy_request_to_wpcom_as_user( $request, "product/$product_id" );
336 337 }
337 338 }
338 339
339 340 /**
@@ -354,13 +355,9 @@
354 355 } catch ( \Exception $e ) {
355 356 return array( 'error' => $e->getMessage() );
356 357 }
357 358 } else {
358 - return $this->proxy_request_to_wpcom(
359 - "product/$product_id",
360 - 'DELETE',
361 - array( 'cancel_subscriptions' => $cancel_subscriptions )
362 - );
359 + return $this->proxy_request_to_wpcom_as_user( $request, "product/$product_id" );
363 360 }
364 361 }
365 362
366 363 /**
@@ -409,82 +406,13 @@
409 406 }
410 407
411 408 return (array) $membership_settings;
412 409 } else {
413 - $payload = array(
414 - 'type' => $request['type'],
415 - 'source' => $source,
416 - );
417 -
418 - // If we pass directly is_editable as null, it would break API argument validation.
419 - // This also needs to be converted to int because boolean false is ignored by add_query_arg.
420 - if ( null !== $is_editable ) {
421 - $payload['is_editable'] = (int) $is_editable;
422 - }
423 -
424 - $blog_id = Jetpack_Options::get_option( 'id' );
425 - $path = "/sites/$blog_id/{$this->rest_base}/status";
426 - if ( $product_type ) {
427 - $path = add_query_arg(
428 - $payload,
429 - $path
430 - );
431 - }
432 - $response = Client::wpcom_json_api_request_as_user( $path, 'v2' );
433 - if ( is_wp_error( $response ) ) {
434 - if ( $response->get_error_code() === 'missing_token' ) {
435 - return new WP_Error( 'missing_token', __( 'Please connect your user account to WordPress.com', 'jetpack' ), 404 );
436 - }
437 - return new WP_Error( 'wpcom_connection_error', __( 'Could not connect to WordPress.com', 'jetpack' ), 404 );
438 - }
439 - $data = isset( $response['body'] ) ? json_decode( $response['body'], true ) : null;
440 - if ( 200 !== $response['response']['code'] && $data['code'] && $data['message'] ) {
441 - return new WP_Error( $data['code'], $data['message'], 401 );
442 - }
443 - return $data;
410 + return $this->proxy_request_to_wpcom_as_user( $request, 'status' );
444 411 }
445 412 }
446 413
447 414 /**
448 - * Proxy a request to WPCOM, look for errors and return a response or a WP_Error.
449 - *
450 - * @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`.
451 - * @param string $method The HTTP method being used.
452 - * @param array|null $payload An optional payload to be sent with the request.
453 - * @return string The response from WPCOM
454 - */
455 - private function proxy_request_to_wpcom( $uri, $method, $payload = null ) {
456 - // get blog id
457 - $blog_id = Jetpack_Options::get_option( 'id' );
458 -
459 - // proxy request to wpcom
460 - $response = Client::wpcom_json_api_request_as_user(
461 - "/sites/$blog_id/{$this->rest_base}/$uri",
462 - 'v2',
463 - array(
464 - 'method' => strtoupper( $method ),
465 - ),
466 - $payload
467 - );
468 - if ( is_wp_error( $response ) ) {
469 - if ( $response->get_error_code() === 'missing_token' ) {
470 - return new WP_Error( 'missing_token', __( 'Please connect your user account to WordPress.com', 'jetpack' ), 404 );
471 - }
472 - return new WP_Error( 'wpcom_connection_error', __( 'Could not connect to WordPress.com', 'jetpack' ), 404 );
473 - }
474 -
475 - // decode response
476 - $data = isset( $response['body'] ) ? json_decode( $response['body'], true ) : null;
477 - // If endpoint returned error, we have to detect it.
478 - if ( 200 !== $response['response']['code'] && $data['code'] && $data['message'] ) {
479 - return new WP_Error( $data['code'], $data['message'], 401 );
480 - }
481 -
482 - // return response
483 - return $data;
484 - }
485 -
486 - /**
487 415 * This function throws an exception if it is run outside of wpcom.
488 416 *
489 417 * @return void
490 418 * @throws \Exception If the function is run outside of WPCOM.
@@ -593,22 +521,29 @@
593 521 /**
594 522 * Get a payload for creating or updating products by parsing the request.
595 523 *
596 524 * @param WP_REST_Request $request The request for this endpoint, containing the details needed to build the payload.
597 - * @return array The built payload.
525 + * @return array|WP_Error The built payload or WP_Error on validation failure.
598 526 */
599 527 private function get_payload_for_product( WP_REST_Request $request ) {
600 528 $is_editable = isset( $request['is_editable'] ) ? (bool) $request['is_editable'] : null;
601 - $type = isset( $request['type'] ) ? $request['type'] : null;
602 - $tier = isset( $request['tier'] ) ? $request['tier'] : null;
529 + $type = $request['type'] ?? null;
530 + $tier = $request['tier'] ?? null;
603 531 $buyer_can_change_amount = isset( $request['buyer_can_change_amount'] ) && (bool) $request['buyer_can_change_amount'];
532 + $interval = $request['interval'];
604 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 +
605 540 $payload = array(
606 541 'title' => $request['title'],
607 542 'price' => $request['price'],
608 543 'currency' => $request['currency'],
609 544 'buyer_can_change_amount' => $buyer_can_change_amount,
610 - 'interval' => $request['interval'],
545 + 'interval' => $interval,
611 546 'type' => $type,
612 547 'welcome_email_content' => $request['welcome_email_content'],
613 548 'subscribe_as_site_subscriber' => $request['subscribe_as_site_subscriber'],
614 549 'multiple_per_user' => $request['multiple_per_user'],
@@ -621,9 +556,117 @@
621 556 // If we pass directly the value "null", it will break the argument validation.
622 557 if ( null !== $is_editable ) {
623 558 $payload['is_editable'] = $is_editable;
624 559 }
560 +
561 + if ( isset( $request['description'] ) ) {
562 + $payload['description'] = $request['description'];
563 + }
564 +
625 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;
626 669 }
627 670
628 671 /**
629 672 * Returns true if run from WPCOM.