PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.7
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.7
16.3-beta 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 All 507 releases
← All changes | modules/memberships/class-jetpack-memberships.php +578 -63 12.5.2 → 16.3-a.7 View file →
@@ -6,10 +6,19 @@
6 6 * @since 7.3.0
7 7 */
8 8
9 9 use Automattic\Jetpack\Blocks;
10 -use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Token_Subscription_Service;
10 +use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Abstract_Token_Subscription_Service;
11 +use Automattic\Jetpack\Status;
12 +use Automattic\Jetpack\Status\Host;
13 +use Automattic\Jetpack\Status\Request;
14 +use const Automattic\Jetpack\Extensions\Subscriptions\META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS;
15 +use const Automattic\Jetpack\Extensions\Subscriptions\META_NAME_FOR_POST_TIER_ID_SETTINGS;
11 16
17 +if ( ! defined( 'ABSPATH' ) ) {
18 + exit( 0 );
19 +}
20 +
12 21 require_once __DIR__ . '/../../extensions/blocks/subscriptions/constants.php';
13 22
14 23 /**
15 24 * Class Jetpack_Memberships
@@ -29,20 +38,23 @@
29 38 */
30 39 public static $post_type_plan = 'jp_mem_plan';
31 40
32 41 /**
33 - * Option that will store currently set up account (Stripe etc) id for memberships.
42 + * Our CPT type for the product (plan).
34 43 *
35 - * TODO: remove
44 + * @var string
45 + */
46 + public static $post_type_coupon = 'memberships_coupon';
47 +
48 + /**
49 + * Tier type for plans
36 50 *
37 - * @deprecated
38 51 * @var string
39 52 */
40 - public static $connected_account_id_option_name = 'jetpack-memberships-connected-account-id';
53 + public static $type_tier = 'tier';
41 54
42 55 /**
43 - * Option that will toggle account enabled for memberships (i.e. Stripe is
44 - * configured, etc. ).
56 + * Option stores status for memberships (Stripe, etc.).
45 57 *
46 58 * @var string
47 59 */
48 60 public static $has_connected_account_option_name = 'jetpack-memberships-has-connected-account';
@@ -51,11 +63,18 @@
51 63 * Post meta that will store the level of access for newsletters
52 64 *
53 65 * @var string
54 66 */
55 - public static $post_access_level_meta_name = \Automattic\Jetpack\Extensions\Subscriptions\META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS;
67 + public static $post_access_level_meta_name = META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS;
56 68
57 69 /**
70 + * Post meta that will store the tier ID of access for newsletters
71 + *
72 + * @var string
73 + */
74 + public static $post_access_tier_meta_name = META_NAME_FOR_POST_TIER_ID_SETTINGS;
75 +
76 + /**
58 77 * Button block type to use.
59 78 *
60 79 * @var string
61 80 */
@@ -68,8 +87,33 @@
68 87 */
69 88 private static $tags_allowed_in_the_button = array( 'br' => array() );
70 89
71 90 /**
91 + * Allowed HTML tags for a rendered tier description. Mirrors the wp.com
92 + * subscribe modal's allowlist so the rendered markdown stays consistent
93 + * across surfaces.
94 + *
95 + * @var array
96 + */
97 + const TIER_DESCRIPTION_ALLOWED_HTML = array(
98 + 'p' => array(),
99 + 'br' => array(),
100 + 'ul' => array(),
101 + 'ol' => array(),
102 + 'li' => array(),
103 + 'strong' => array(),
104 + 'em' => array(),
105 + 'del' => array(),
106 + 'code' => array(),
107 + 'blockquote' => array(),
108 + 'a' => array(
109 + 'href' => true,
110 + 'rel' => true,
111 + 'target' => true,
112 + ),
113 + );
114 +
115 + /**
72 116 * The minimum required plan for this Gutenberg block.
73 117 *
74 118 * @var string Plan slug
75 119 */
@@ -96,14 +140,34 @@
96 140 */
97 141 private static $user_can_view_post_cache = array();
98 142
99 143 /**
144 + * Cached results of user_is_paid_subscriber() method.
145 + *
146 + * @var array
147 + */
148 + private static $user_is_paid_subscriber_cache = array();
149 +
150 + /**
151 + * Cached results of get_post_access_level method.
152 + *
153 + * @var array
154 + */
155 + private static $post_access_level_cache = array();
156 +
157 + /**
158 + * Clear cached results of get_post_access_level method.
159 + */
160 + public static function clear_post_access_level_cache() {
161 + self::$post_access_level_cache = array();
162 + }
163 +
164 + /**
100 165 * Currencies we support and Stripe's minimum amount for a transaction in that currency.
101 166 *
102 167 * @link https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts
103 168 *
104 - * List has to be in with `SUPPORTED_CURRENCIES` in extensions/shared/currencies.js and
105 - * `Memberships_Product::SUPPORTED_CURRENCIES` in the WP.com memberships library.
169 + * List has to be in with `SUPPORTED_CURRENCIES` in extensions/shared/currencies.js.
106 170 */
107 171 const SUPPORTED_CURRENCIES = array(
108 172 'USD' => 0.5,
109 173 'AUD' => 0.5,
@@ -121,8 +185,17 @@
121 185 'NZD' => 0.5,
122 186 'PLN' => 2.0,
123 187 'SEK' => 3.0,
124 188 'SGD' => 0.5,
189 + 'CZK' => 15.0,
190 + 'HUF' => 175.0,
191 + 'TWD' => 10.0,
192 + 'IDR' => 0,
193 + 'ILS' => 0,
194 + 'PHP' => 0,
195 + 'RUB' => 0,
196 + 'TRY' => 0,
197 + 'MYR' => 2.00,
125 198 );
126 199
127 200 /**
128 201 * Jetpack_Memberships constructor.
@@ -139,9 +212,9 @@
139 212 self::$instance = new self();
140 213 self::$instance->register_init_hook();
141 214 // Yes, `pro-plan` with a dash, `jetpack_personal` with an underscore. Check the v1.5 endpoint to verify.
142 215 $wpcom_plan_slug = defined( 'ENABLE_PRO_PLAN' ) ? 'pro-plan' : 'personal-bundle';
143 - self::$required_plan = ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ? $wpcom_plan_slug : 'jetpack_personal';
216 + self::$required_plan = ( new Host() )->is_wpcom_simple() ? $wpcom_plan_slug : 'jetpack_personal';
144 217 }
145 218
146 219 return self::$instance;
147 220 }
@@ -162,8 +235,20 @@
162 235 ),
163 236 'site_subscriber' => array(
164 237 'meta' => $meta_prefix . 'site_subscriber',
165 238 ),
239 + 'product_id' => array(
240 + 'meta' => $meta_prefix . 'product_id',
241 + ),
242 + 'tier' => array(
243 + 'meta' => $meta_prefix . 'tier',
244 + ),
245 + 'is_deleted' => array(
246 + 'meta' => $meta_prefix . 'is_deleted',
247 + ),
248 + 'is_sandboxed' => array(
249 + 'meta' => $meta_prefix . 'is_sandboxed',
250 + ),
166 251 );
167 252 return $properties;
168 253 }
169 254
@@ -172,8 +257,10 @@
172 257 */
173 258 private function register_init_hook() {
174 259 add_action( 'init', array( $this, 'init_hook_action' ) );
175 260 add_action( 'jetpack_register_gutenberg_extensions', array( $this, 'register_gutenberg_block' ) );
261 + // phpcs:ignore WPCUT.SwitchBlog.SwitchBlog -- wpcom flags **every** use of switch_blog, apparently expecting valid instances to ignore or suppress the sniff.
262 + add_action( 'switch_blog', array( $this, 'clear_post_access_level_cache' ) );
176 263 }
177 264
178 265 /**
179 266 * Actual hooks initializing on init.
@@ -181,11 +268,26 @@
181 268 public function init_hook_action() {
182 269 add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_rest_api_types' ) );
183 270 add_filter( 'jetpack_sync_post_meta_whitelist', array( $this, 'allow_sync_post_meta' ) );
184 271 $this->setup_cpts();
272 +
273 + if ( Jetpack::is_module_active( 'subscriptions' ) && Request::is_frontend() ) {
274 + add_action( 'wp_logout', array( $this, 'subscriber_logout' ) );
275 + }
185 276 }
186 277
187 278 /**
279 + * Logs the subscriber out by clearing out the premium content cookie.
280 + */
281 + public function subscriber_logout() {
282 + if ( ! class_exists( 'Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Abstract_Token_Subscription_Service' ) ) {
283 + return;
284 + }
285 +
286 + Abstract_Token_Subscription_Service::clear_token_cookie();
287 + }
288 +
289 + /**
188 290 * Sets up the custom post types for the module.
189 291 */
190 292 private function setup_cpts() {
191 293 /*
@@ -218,8 +320,27 @@
218 320 'capabilities' => $capabilities,
219 321 'show_in_rest' => false,
220 322 );
221 323 register_post_type( self::$post_type_plan, $order_args );
324 + $coupon_args = array(
325 + 'label' => esc_html__( 'Coupon', 'jetpack' ),
326 + 'description' => esc_html__( 'Memberships coupons', 'jetpack' ),
327 + 'supports' => array( 'title', 'custom-fields', 'content' ),
328 + 'hierarchical' => false,
329 + 'public' => false,
330 + 'show_ui' => false,
331 + 'show_in_menu' => false,
332 + 'show_in_admin_bar' => false,
333 + 'show_in_nav_menus' => false,
334 + 'can_export' => true,
335 + 'has_archive' => false,
336 + 'exclude_from_search' => true,
337 + 'publicly_queryable' => false,
338 + 'rewrite' => false,
339 + 'capabilities' => $capabilities,
340 + 'show_in_rest' => false,
341 + );
342 + register_post_type( self::$post_type_coupon, $coupon_args );
222 343 }
223 344
224 345 /**
225 346 * Allows custom post types to be used by REST API.
@@ -230,8 +351,9 @@
230 351 * @return array
231 352 */
232 353 public function allow_rest_api_types( $post_types ) {
233 354 $post_types[] = self::$post_type_plan;
355 + $post_types[] = self::$post_type_coupon;
234 356
235 357 return $post_types;
236 358 }
237 359
@@ -242,13 +364,37 @@
242 364 *
243 365 * @return array
244 366 */
245 367 public function allow_sync_post_meta( $post_meta ) {
246 - $meta_keys = array_map(
368 + $meta_keys_plans = array_map(
247 369 array( $this, 'return_meta' ),
248 370 self::get_plan_property_mapping()
249 371 );
250 - return array_merge( $post_meta, array_values( $meta_keys ) );
372 +
373 + $meta_coupons_prefix = self::$post_type_coupon . '_';
374 + $meta_keys_coupons = array(
375 + $meta_coupons_prefix . 'coupon_code',
376 + $meta_coupons_prefix . 'can_be_combined',
377 + $meta_coupons_prefix . 'first_time_purchase_only',
378 + $meta_coupons_prefix . 'limit_per_user',
379 + $meta_coupons_prefix . 'discount_type',
380 + $meta_coupons_prefix . 'discount_value',
381 + $meta_coupons_prefix . 'discount_percentage',
382 + $meta_coupons_prefix . 'discount_currency',
383 + $meta_coupons_prefix . 'start_date',
384 + $meta_coupons_prefix . 'end_date',
385 + $meta_coupons_prefix . 'plan_ids_allow_list',
386 + $meta_coupons_prefix . 'duration',
387 + $meta_coupons_prefix . 'email_allow_list',
388 + $meta_coupons_prefix . 'is_deleted',
389 + $meta_coupons_prefix . 'is_sandboxed',
390 + );
391 +
392 + return array_merge(
393 + $post_meta,
394 + array_values( $meta_keys_plans ),
395 + $meta_keys_coupons
396 + );
251 397 }
252 398
253 399 /**
254 400 * This returns meta attribute of passet array.
@@ -262,8 +408,21 @@
262 408 return $map['meta'];
263 409 }
264 410
265 411 /**
412 + * Show an error to the user (or embed a clue in the HTML) when the button does not get rendered properly.
413 + *
414 + * @param WP_Error $error The error message with error code.
415 + * @return string The error message rendered as HTML.
416 + */
417 + public function render_button_error( $error ) {
418 + if ( static::user_can_edit() ) {
419 + return '<div><strong>Jetpack Memberships Error: ' . $error->get_error_code() . '</strong><br />' . $error->get_error_message() . '</div>';
420 + }
421 + return '<div>Sorry! This product is not available for purchase at this time.</div><!-- Jetpack Memberships Error: ' . $error->get_error_code() . ' -->';
422 + }
423 +
424 + /**
266 425 * Renders a preview of the Recurring Payment button, which is not hooked
267 426 * up to the subscription url. Used to preview the block on the frontend
268 427 * for site editors when Stripe has not been connected.
269 428 *
@@ -303,11 +462,11 @@
303 462 $is_premium_content_child = (int) $block->context['isPremiumContentChild'];
304 463 }
305 464
306 465 return $is_premium_content_child &&
307 - $user_can_edit &&
308 - $requires_stripe_connection &&
309 - $jetpack_ready;
466 + $user_can_edit &&
467 + $requires_stripe_connection &&
468 + $jetpack_ready;
310 469 }
311 470
312 471 /**
313 472 * Callback that parses the membership purchase shortcode.
@@ -315,38 +474,68 @@
315 474 * @param array $attributes - attributes in the shortcode. `id` here is the CPT id of the plan.
316 475 * @param string $content - Recurring Payment block content.
317 476 * @param WP_Block $block - Recurring Payment block instance.
318 477 *
319 - * @return string|void
478 + * @return string|void - HTML for the button, void removes the button.
320 479 */
321 480 public function render_button( $attributes, $content = null, $block = null ) {
322 - Jetpack_Gutenberg::load_assets_as_required( self::$button_block_name, array( 'thickbox', 'wp-polyfill' ) );
481 + Jetpack_Gutenberg::load_assets_as_required( self::$button_block_name );
323 482
324 483 if ( $this->should_render_button_preview( $block ) ) {
325 484 return $this->render_button_preview( $attributes, $content );
326 485 }
327 486
328 - if ( empty( $attributes['planId'] ) ) {
329 - return;
487 + if ( empty( $attributes['planId'] ) && empty( $attributes['planIds'] ) ) {
488 + return $this->render_button_error( new WP_Error( 'jetpack-memberships-rb-npi', __( 'No plan was configured for this button.', 'jetpack' ) . ' ' . __( 'Edit this post and confirm that an existing payment plan is selected for this block.', 'jetpack' ) ) );
330 489 }
331 490
332 - $plan_id = (int) $attributes['planId'];
333 - $product = get_post( $plan_id );
334 - if ( ! $product || is_wp_error( $product ) ) {
335 - return;
491 + // This is string of '+` separated plan ids. Loop through them and
492 + // filter out the ones that are not valid.
493 + $plan_ids = array();
494 + if ( ! empty( $attributes['planIds'] ) ) {
495 + $plan_ids = $attributes['planIds'];
496 + } elseif ( ! empty( $attributes['planId'] ) ) {
497 + $plan_ids = explode( '+', $attributes['planId'] );
336 498 }
337 - if ( $product->post_type !== self::$post_type_plan || 'publish' !== $product->post_status ) {
499 + $valid_plans = array();
500 + foreach ( $plan_ids as $plan_id ) {
501 + if ( ! is_numeric( $plan_id ) ) {
502 + continue;
503 + }
504 + $product = get_post( $plan_id );
505 + if ( ! $product ) {
506 + return $this->render_button_error( new WP_Error( 'jetpack-memberships-rb-npf', __( 'Could not find a plan for this button.', 'jetpack' ) . ' ' . __( 'Edit this post and confirm that the selected payment plan still exists and is available for purchase.', 'jetpack' ) ) );
507 + }
508 + if ( is_wp_error( $product ) ) {
509 + '@phan-var WP_Error $product'; // `get_post` isn't supposed to return a WP_Error, so Phan is confused here. See also https://github.com/phan/phan/issues/3127
510 + return $this->render_button_error( new WP_Error( 'jetpack-memberships-rb-npf-we', __( 'Encountered an error when getting the plan associated with this button:', 'jetpack' ) . ' ' . $product->get_error_message() . '. ' . __( ' Edit this post and confirm that the selected payment plan still exists and is available for purchase.', 'jetpack' ) ) );
511 + }
512 + if ( $product->post_type !== self::$post_type_plan ) {
513 + return $this->render_button_error( new WP_Error( 'jetpack-memberships-rb-pnplan', __( 'The payment plan selected is not actually a payment plan.', 'jetpack' ) . ' ' . __( 'Edit this post and confirm that the selected payment plan still exists and is available for purchase.', 'jetpack' ) ) );
514 + }
515 + if ( 'publish' !== $product->post_status ) {
516 + return $this->render_button_error( new WP_Error( 'jetpack-memberships-rb-psnpub', __( 'The selected payment plan is not active.', 'jetpack' ) . ' ' . __( 'Edit this post and confirm that the selected payment plan still exists and is available for purchase.', 'jetpack' ) ) );
517 + }
518 + $valid_plans[] = $plan_id;
519 + }
520 +
521 + // If none are valid, return.
522 + // (Returning like this makes the button disappear.)
523 + if ( empty( $valid_plans ) ) {
338 524 return;
339 525 }
526 + $plan_id = implode( '+', $valid_plans );
340 527
341 - add_thickbox();
342 -
343 528 if ( ! empty( $content ) ) {
344 529 $block_id = esc_attr( wp_unique_id( 'recurring-payments-block-' ) );
345 530 $content = str_replace( 'recurring-payments-id', $block_id, $content );
346 531 $content = str_replace( 'wp-block-jetpack-recurring-payments', 'wp-block-jetpack-recurring-payments wp-block-button', $content );
347 532 $subscribe_url = $this->get_subscription_url( $plan_id );
348 - return preg_replace( '/(href=".*")/U', 'href="' . $subscribe_url . '"', $content );
533 +
534 + $content = preg_replace( '/(href=".*")/U', 'href="' . $subscribe_url . '"', $content );
535 + $content = wp_kses_post( $content );
536 +
537 + return $content;
349 538 }
350 539
351 540 return $this->deprecated_render_button_v1( $attributes, $plan_id );
352 541 }
@@ -351,8 +540,45 @@
351 540 return $this->deprecated_render_button_v1( $attributes, $plan_id );
352 541 }
353 542
354 543 /**
544 + * Render email callback.
545 + *
546 + * @param string $block_content The block content.
547 + * @param array $parsed_block The parsed block data.
548 + * @param object $rendering_context The email rendering context.
549 + *
550 + * @return string
551 + */
552 + public function render_button_email( $block_content, array $parsed_block, $rendering_context ) {
553 + // Check for the required renderers.
554 + if ( ! function_exists( '\Automattic\Jetpack\Extensions\Button\render_email' ) || ! class_exists( '\Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Button' ) ) {
555 + return '';
556 + }
557 +
558 + // Get the first inner block, which should be the button block.
559 + $button_block = $parsed_block['innerBlocks'][0] ?? array();
560 +
561 + // We should only accept button blocks.
562 + if ( empty( $button_block['blockName'] ) || 'jetpack/button' !== $button_block['blockName'] ) {
563 + return '';
564 + }
565 +
566 + // We need attributes.
567 + if ( ! isset( $button_block['attrs'] ) || ! is_array( $button_block['attrs'] ) ) {
568 + return '';
569 + }
570 +
571 + // If the button block is missing text or url, return empty string.
572 + if ( empty( $button_block['attrs']['text'] ) || empty( $button_block['attrs']['url'] ) ) {
573 + return '';
574 + }
575 +
576 + // Reuse the button block's email rendering method.
577 + return \Automattic\Jetpack\Extensions\Button\render_email( $block_content, $button_block, $rendering_context );
578 + }
579 +
580 + /**
355 581 * Builds subscription URL for this membership using the current blog and
356 582 * supplied plan IDs.
357 583 *
358 584 * @param integer $plan_id - Unique ID for the plan being subscribed to.
@@ -381,11 +607,9 @@
381 607 *
382 608 * @return string
383 609 */
384 610 public function deprecated_render_button_v1( $attrs, $plan_id ) {
385 - $button_label = isset( $attrs['submitButtonText'] )
386 - ? $attrs['submitButtonText']
387 - : __( 'Your contribution', 'jetpack' );
611 + $button_label = $attrs['submitButtonText'] ?? __( 'Your contribution', 'jetpack' );
388 612
389 613 $button_styles = array();
390 614 if ( ! empty( $attrs['customBackgroundButtonColor'] ) ) {
391 615 array_push(
@@ -407,9 +631,9 @@
407 631 }
408 632 $button_styles = implode( ';', $button_styles );
409 633
410 634 return sprintf(
411 - '<div class="%1$s"><a role="button" %6$s href="%2$s" class="%3$s" style="%4$s">%5$s</a></div>',
635 + '<div class="%1$s"><a role="button" href="%2$s" class="%3$s" style="%4$s">%5$s</a></div>',
412 636 esc_attr(
413 637 Blocks::classes(
414 638 self::$button_block_name,
415 639 $attrs,
@@ -418,10 +642,9 @@
418 642 ),
419 643 esc_url( $this->get_subscription_url( $plan_id ) ),
420 644 isset( $attrs['submitButtonClasses'] ) ? esc_attr( $attrs['submitButtonClasses'] ) : 'wp-block-button__link',
421 645 esc_attr( $button_styles ),
422 - wp_kses( $button_label, self::$tags_allowed_in_the_button ),
423 - isset( $attrs['submitButtonAttributes'] ) ? sanitize_text_field( $attrs['submitButtonAttributes'] ) : '' // Needed for arbitrary target=_blank on WPCOM VIP.
646 + wp_kses( $button_label, self::$tags_allowed_in_the_button )
424 647 );
425 648 }
426 649
427 650 /**
@@ -449,11 +672,9 @@
449 672 if ( $has_option ) {
450 673 return true;
451 674 }
452 675
453 - // This is the fallback solution.
454 - // TODO: Remove this once the has_connected_account_option is migrated to all sites.
455 - return get_option( 'jetpack-memberships-connected-account-id', false ) ? true : false;
676 + return false;
456 677 }
457 678
458 679 /**
459 680 * Get the post access level
@@ -468,19 +689,70 @@
468 689 if ( ! $post_id ) {
469 690 $post_id = get_the_ID();
470 691 }
471 692 if ( ! $post_id ) {
472 - return Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY;
693 + return Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY;
473 694 }
474 695
696 + $blog_id = get_current_blog_id();
697 + $cache_key = $blog_id . '_' . $post_id;
698 +
699 + if ( isset( self::$post_access_level_cache[ $cache_key ] ) ) {
700 + return self::$post_access_level_cache[ $cache_key ];
701 + }
702 +
475 703 $post_access_level = get_post_meta( $post_id, self::$post_access_level_meta_name, true );
476 - if ( empty( $post_access_level ) ) {
477 - $post_access_level = Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY;
704 + // Defaults to "everybody" when unset, and also when the stored value is not a
705 + // string. Corrupt rows (e.g. a serialized array like a:1:{i:0;s:0:"";}) can be
706 + // persisted by non-REST write paths, and an array flows unchanged into the
707 + // strict string-typed `earn_user_has_access` callback on WPCOM, fataling the
708 + // render. Coercing here keeps this canonical accessor's documented string
709 + // contract regardless of how the meta was written.
710 + if ( empty( $post_access_level ) || ! is_string( $post_access_level ) ) {
711 + $post_access_level = Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY;
478 712 }
713 +
714 + // Only the editor switches a Paywall post to subscribers; REST, WP-CLI and importer saves don't.
715 + // The block's name constant isn't loaded everywhere this runs, hence the literal.
716 + if (
717 + Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY === $post_access_level
718 + && has_block( 'jetpack/paywall', $post_id )
719 + ) {
720 + $post_access_level = Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_SUBSCRIBERS;
721 + }
722 +
723 + self::$post_access_level_cache[ $cache_key ] = $post_access_level;
724 +
479 725 return $post_access_level;
480 726 }
481 727
482 728 /**
729 + * Get the post tier plan
730 + *
731 + * If no ID is provided, the method tries to get it from the global post object.
732 + *
733 + * @param int|null $post_id The ID of the post. Default is null.
734 + *
735 + * @return WP_Post|null the actual post tier.
736 + */
737 + public static function get_post_tier( $post_id = null ) {
738 + if ( ! $post_id ) {
739 + $post_id = get_the_ID();
740 + }
741 +
742 + if ( ! $post_id ) {
743 + return null;
744 + }
745 +
746 + $post_tier_id = get_post_meta( $post_id, self::$post_access_tier_meta_name, true );
747 + if ( empty( $post_tier_id ) ) {
748 + return null;
749 + }
750 +
751 + return get_post( $post_tier_id );
752 + }
753 +
754 + /**
483 755 * Determines whether the current user can edit.
484 756 *
485 757 * @return bool Whether the user can edit.
486 758 */
@@ -485,21 +757,80 @@
485 757 * @return bool Whether the user can edit.
486 758 */
487 759 public static function user_can_edit() {
488 760 $user = wp_get_current_user();
489 - // phpcs:ignore ImportDetection.Imports.RequireImports.Symbol
490 761 return 0 !== $user->ID && current_user_can( 'edit_post', get_the_ID() );
491 762 }
492 763
493 764 /**
765 + * Clears the static cache for all users or for a given user.
766 + *
767 + * @param int|null $user_id The user_id to unset in the cache, otherwise the entire static cache is cleared.
768 + * @return void
769 + */
770 + public static function clear_cache( ?int $user_id = null ) {
771 + if ( empty( $user_id ) ) {
772 + self::$user_is_paid_subscriber_cache = array();
773 + self::$user_can_view_post_cache = array();
774 + return;
775 + }
776 + unset( self::$user_is_paid_subscriber_cache[ $user_id ] );
777 + unset( self::$user_can_view_post_cache[ $user_id ] );
778 + }
779 +
780 + /**
781 + * Determines whether the current user is a paid subscriber and caches the result.
782 + *
783 + * @param array $valid_plan_ids An array of valid plan ids that the user could be subscribed to which would make the user able to view this content. Defaults to an empty array which will be filled with all newsletter plan IDs.
784 + * @param int|null $user_id An optional user_id that can be used to determine service availability (defaults to checking if user is logged in if omitted).
785 + * @return bool Whether the post can be viewed
786 + */
787 + public static function user_is_paid_subscriber( $valid_plan_ids = array(), $user_id = null ) {
788 + if ( empty( $user_id ) ) {
789 + $user_id = get_current_user_id();
790 + if ( empty( $user_id ) ) {
791 + return false;
792 + }
793 + }
794 + // sort and stringify sorted valid plan ids to use as a cache key
795 + sort( $valid_plan_ids );
796 + $cache_key = $user_id . '_' . implode( ',', $valid_plan_ids );
797 + if ( ! isset( self::$user_is_paid_subscriber_cache[ $cache_key ] ) ) {
798 + require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
799 + if ( empty( $valid_plan_ids ) ) {
800 + $valid_plan_ids = self::get_all_newsletter_plan_ids();
801 + }
802 + $paywall = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service( $user_id );
803 + $is_paid_subscriber = $paywall->visitor_can_view_content( $valid_plan_ids, Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS );
804 + self::$user_is_paid_subscriber_cache[ $cache_key ] = $is_paid_subscriber;
805 + }
806 + return self::$user_is_paid_subscriber_cache[ $cache_key ];
807 + }
808 +
809 + /**
810 + * Determines whether the current user has a pending subscription.
811 + *
812 + * @return bool Whether the user has a pending subscription
813 + */
814 + public static function user_is_pending_subscriber() {
815 + require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
816 + $subscription_service = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
817 + return $subscription_service->is_current_user_pending_subscriber();
818 + }
819 +
820 + /**
494 821 * Determines whether the current user can view the post based on the newsletter access level
495 822 * and caches the result.
496 823 *
824 + * @param int|null $post_id Explicit post id to check against.
825 + *
497 826 * @return bool Whether the post can be viewed
498 827 */
499 - public static function user_can_view_post() {
828 + public static function user_can_view_post( $post_id = null ) {
500 829 $user_id = get_current_user_id();
501 - $post_id = get_the_ID();
830 + if ( null === $post_id ) {
831 + $post_id = get_the_ID();
832 + }
502 833
503 834 if ( false === $post_id ) {
504 835 $post_id = 0;
505 836 }
@@ -508,18 +839,38 @@
508 839 if ( isset( self::$user_can_view_post_cache[ $cache_key ] ) ) {
509 840 return self::$user_can_view_post_cache[ $cache_key ];
510 841 }
511 842
512 - $post_access_level = self::get_post_access_level();
513 - if ( Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY === $post_access_level ) {
843 + $post_access_level = self::get_post_access_level( $post_id );
844 + if ( Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY === $post_access_level ) {
514 845 self::$user_can_view_post_cache[ $cache_key ] = true;
515 846 return true;
516 847 }
517 848
849 + // we are sending the post to subscribers so the user is a subscriber
850 + if ( defined( 'WPCOM_SENDING_POST_TO_SUBSCRIBERS' ) && WPCOM_SENDING_POST_TO_SUBSCRIBERS && Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_SUBSCRIBERS === $post_access_level ) {
851 + self::$user_can_view_post_cache[ $cache_key ] = true;
852 + return true;
853 + }
854 +
518 855 require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
519 - $paywall = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
520 - $can_view_post = $paywall->visitor_can_view_content( self::get_all_newsletter_plan_ids(), $post_access_level );
856 + $paywall = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
521 857
858 + $all_newsletters_plan_ids = self::get_all_newsletter_plan_ids();
859 +
860 + if ( 0 === count( $all_newsletters_plan_ids ) &&
861 + (
862 + Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS === $post_access_level ||
863 + Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS_ALL_TIERS === $post_access_level
864 + )
865 + ) {
866 + // The post is paywalled but there is no newsletter plans on the site.
867 + // We downgrade the post level to subscribers-only
868 + $post_access_level = Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_SUBSCRIBERS;
869 + }
870 +
871 + $can_view_post = $paywall->visitor_can_view_content( $all_newsletters_plan_ids, $post_access_level );
872 +
522 873 self::$user_can_view_post_cache[ $cache_key ] = $can_view_post;
523 874 return $can_view_post;
524 875 }
525 876
@@ -530,13 +881,31 @@
530 881 *
531 882 * @return bool
532 883 */
533 884 public static function is_enabled_jetpack_recurring_payments() {
534 - $api_available = ( ( defined( 'IS_WPCOM' ) && IS_WPCOM ) || Jetpack::is_connection_ready() );
885 + $api_available = ( new Host() )->is_wpcom_simple() || Jetpack::is_connection_ready();
535 886 return $api_available;
536 887 }
537 888
538 889 /**
890 + * Whether to enable the blocks in the editor.
891 + * All Monetize blocks (except Simple Payments) need a user with at least `edit_posts` capability
892 + *
893 + * @return bool
894 + */
895 + public static function should_enable_monetize_blocks_in_editor() {
896 + if ( ! is_admin() ) {
897 + // We enable the block for the front-end in all cases
898 + return true;
899 +
900 + }
901 +
902 + $is_offline_mode = ( new Status() )->is_offline_mode();
903 + $enable_monetize_blocks_in_editor = ( new Host() )->is_wpcom_simple() || ( ! $is_offline_mode );
904 + return $enable_monetize_blocks_in_editor;
905 + }
906 +
907 + /**
539 908 * Whether site has any paid plan.
540 909 *
541 910 * @param string $type - Type of a plan for which site is configured. For now supports empty and newsletter.
542 911 *
@@ -561,26 +930,90 @@
561 930 return ( is_countable( $plans ) && count( $plans ) > 0 );
562 931 }
563 932
564 933 /**
565 - * Return membership plans
934 + * Return the list of plan posts
566 935 *
936 + * @return WP_Post[]|WP_Error
937 + */
938 + public static function get_all_plans() {
939 + if ( ! self::is_enabled_jetpack_recurring_payments() ) {
940 + return array();
941 + }
942 +
943 + // We can retrieve the data directly except on a Jetpack/Atomic cached site or
944 + $is_cached_site = ( new Host() )->is_wpcom_simple() && is_jetpack_site();
945 + if ( ! $is_cached_site ) {
946 + return get_posts(
947 + array(
948 + 'posts_per_page' => -1,
949 + 'post_type' => self::$post_type_plan,
950 + )
951 + );
952 + } else {
953 + // On cached site on WPCOM
954 + require_lib( 'memberships' );
955 + return Memberships_Product::get_plans_posts_list( get_current_blog_id() );
956 + }
957 + }
958 +
959 + /**
960 + * Return all membership plans ids (deleted or not)
961 + * This function is used both on WPCOM or on Jetpack self-hosted.
962 + * Depending on the environment we need to mitigate where the data is retrieved from.
963 + *
964 + * @param bool $allow_deleted Whether to allow deleted plans to be returned. Defaults to true.
965 + *
567 966 * @return array
568 967 */
569 - public static function get_all_newsletter_plan_ids() {
968 + public static function get_all_newsletter_plan_ids( $allow_deleted = true ) {
969 +
570 970 if ( ! self::is_enabled_jetpack_recurring_payments() ) {
571 971 return array();
572 972 }
573 973
574 - return get_posts(
575 - array(
576 - 'posts_per_page' => -1,
577 - 'fields' => 'ids',
578 - 'meta_value' => true,
579 - 'post_type' => self::$post_type_plan,
580 - 'meta_key' => 'jetpack_memberships_site_subscriber',
581 - )
582 - );
974 + // We can retrieve the data directly except on a Jetpack/Atomic cached site or
975 + $is_cached_site = ( new Host() )->is_wpcom_simple() && is_jetpack_site();
976 + if ( ! $is_cached_site ) {
977 + $meta_query = array(
978 + array(
979 + 'key' => 'jetpack_memberships_type',
980 + 'value' => self::$type_tier,
981 + ),
982 + );
983 +
984 + if ( $allow_deleted === false ) {
985 + $meta_query[] = array(
986 + 'key' => 'jetpack_memberships_is_deleted',
987 + 'compare' => 'NOT EXISTS',
988 + );
989 + }
990 +
991 + return get_posts(
992 + array(
993 + 'posts_per_page' => -1,
994 + 'fields' => 'ids',
995 + 'post_type' => self::$post_type_plan,
996 + 'meta_query' => $meta_query,
997 + )
998 + );
999 +
1000 + } else {
1001 + // On cached site on WPCOM
1002 + require_lib( 'memberships' );
1003 + $list = Memberships_Product::get_product_list( get_current_blog_id(), self::$type_tier, null, $allow_deleted );
1004 +
1005 + if ( is_wp_error( $list ) ) {
1006 + return array();
1007 + }
1008 +
1009 + return array_map(
1010 + function ( $product ) {
1011 + return $product['id'];
1012 + }, // Returning only post ids
1013 + $list
1014 + );
1015 + }
583 1016 }
584 1017
585 1018 /**
586 1019 * Register the Recurring Payments Gutenberg block
@@ -596,11 +1029,12 @@
596 1029 if ( self::is_enabled_jetpack_recurring_payments() ) {
597 1030 Blocks::jetpack_register_block(
598 1031 'jetpack/recurring-payments',
599 1032 array(
600 - 'render_callback' => array( $this, 'render_button' ),
601 - 'uses_context' => array( 'isPremiumContentChild' ),
602 - 'provides_context' => array(
1033 + 'render_callback' => array( $this, 'render_button' ),
1034 + 'render_email_callback' => array( $this, 'render_button_email' ),
1035 + 'uses_context' => array( 'isPremiumContentChild' ),
1036 + 'provides_context' => array(
603 1037 'jetpack/parentBlockWidth' => 'width',
604 1038 ),
605 1039 )
606 1040 );
@@ -605,9 +1039,9 @@
605 1039 )
606 1040 );
607 1041 } else {
608 1042 Jetpack_Gutenberg::set_extension_unavailable(
609 - 'jetpack/recurring-payments',
1043 + 'recurring-payments',
610 1044 'missing_plan',
611 1045 array(
612 1046 'required_feature' => 'memberships',
613 1047 'required_plan' => self::$required_plan,
@@ -615,7 +1049,88 @@
615 1049 );
616 1050 }
617 1051
618 1052 self::$has_registered_block = true;
1053 + }
1054 +
1055 + /**
1056 + * Transforms a number into it's short human-readable version.
1057 + *
1058 + * @param int $subscribers_total The extrapolated excerpt string.
1059 + *
1060 + * @return string Human-readable version of the number. ie. 1.9 M.
1061 + */
1062 + public static function get_join_others_text( $subscribers_total ) {
1063 + if ( $subscribers_total >= 1000000 ) {
1064 + /* translators: %s: number of folks following the blog, millions(M) with one decimal. i.e. 1.1 */
1065 + return sprintf( __( 'Join %sM other subscribers', 'jetpack' ), floatval( number_format_i18n( $subscribers_total / 1000000, 1 ) ) );
1066 + }
1067 + if ( $subscribers_total >= 10000 ) {
1068 + /* translators: %s: number of folks following the blog, thousands(K) with one decimal. i.e. 1.1 */
1069 + return sprintf( __( 'Join %sK other subscribers', 'jetpack' ), floatval( number_format_i18n( $subscribers_total / 1000, 1 ) ) );
1070 + }
1071 +
1072 + /* translators: %s: number of folks following the blog */
1073 + return sprintf( _n( 'Join %s other subscriber', 'Join %s other subscribers', $subscribers_total, 'jetpack' ), number_format_i18n( $subscribers_total ) );
1074 + }
1075 +
1076 + /**
1077 + * Returns the email of the current user.
1078 + *
1079 + * @return string
1080 + */
1081 + public static function get_current_user_email() {
1082 + require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
1083 + $subscription_service = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
1084 + return $subscription_service->get_subscriber_email();
1085 + }
1086 +
1087 + /**
1088 + * Returns if the current user is subscribed or not.
1089 + *
1090 + * @return boolean
1091 + */
1092 + public static function is_current_user_subscribed() {
1093 + require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
1094 + $subscription_service = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
1095 + return $subscription_service->is_current_user_subscribed();
1096 + }
1097 +
1098 + /**
1099 + * Render a tier description (stored as markdown text) to safe HTML.
1100 + *
1101 + * Uses Jetpack's markdown parser, restores paragraph structure (the parser
1102 + * strips <p> tags expecting wpautop to run later), forces links to open in a
1103 + * new tab (descriptions are shown inside the subscribe modal's iframe), and
1104 + * finally sanitizes the output to a small tag allowlist.
1105 + *
1106 + * @param mixed $description Raw tier description (markdown text). Non-scalar
1107 + * values are treated as empty.
1108 + * @return string Sanitized HTML, or an empty string for an empty description.
1109 + */
1110 + public static function render_tier_description_html( $description ) {
1111 + if ( ! is_scalar( $description ) ) {
1112 + return '';
1113 + }
1114 + $description = (string) $description;
1115 + if ( '' === trim( $description ) ) {
1116 + return '';
1117 + }
1118 +
1119 + if ( ! class_exists( 'WPCom_Markdown' ) ) {
1120 + require_once JETPACK__PLUGIN_DIR . 'modules/markdown/easy-markdown.php';
1121 + }
1122 +
1123 + $html = WPCom_Markdown::get_instance()->transform(
1124 + $description,
1125 + array(
1126 + 'unslash' => false,
1127 + 'id' => false,
1128 + )
1129 + );
1130 + $html = wpautop( $html );
1131 + $html = links_add_target( $html, '_blank' );
1132 +
1133 + return wp_kses( $html, self::TIER_DESCRIPTION_ALLOWED_HTML );
619 1134 }
620 1135 }
621 1136 Jetpack_Memberships::get_instance();