class-jetpack-subscription-site.php
1 year ago
constants.php
2 years ago
subscriptions.php
1 year ago
subscriptions.php
1334 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Subscriptions Block. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | namespace Automattic\Jetpack\Extensions\Subscriptions; |
| 9 | |
| 10 | use Automattic\Jetpack\Blocks; |
| 11 | use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Abstract_Token_Subscription_Service; |
| 12 | use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Jetpack_Token_Subscription_Service; |
| 13 | use Automattic\Jetpack\Modules; |
| 14 | use Automattic\Jetpack\Status\Host; |
| 15 | use Jetpack_Gutenberg; |
| 16 | use Jetpack_Memberships; |
| 17 | use Jetpack_Subscriptions_Widget; |
| 18 | |
| 19 | require_once __DIR__ . '/class-jetpack-subscription-site.php'; |
| 20 | require_once __DIR__ . '/constants.php'; |
| 21 | require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php'; |
| 22 | |
| 23 | /** |
| 24 | * These block defaults should match ./constants.js |
| 25 | */ |
| 26 | const DEFAULT_BORDER_RADIUS_VALUE = 0; |
| 27 | const DEFAULT_BORDER_WEIGHT_VALUE = 1; |
| 28 | const DEFAULT_FONTSIZE_VALUE = '16px'; |
| 29 | const DEFAULT_PADDING_VALUE = 15; |
| 30 | const DEFAULT_SPACING_VALUE = 10; |
| 31 | const DEFAULT_BUTTON_WIDTH = 'auto'; |
| 32 | |
| 33 | /** |
| 34 | * Registers the block for use in Gutenberg |
| 35 | * This is done via an action so that we can disable |
| 36 | * registration if we need to. |
| 37 | */ |
| 38 | function register_block() { |
| 39 | /* |
| 40 | * Disable the feature on P2 blogs |
| 41 | */ |
| 42 | if ( function_exists( '\WPForTeams\is_wpforteams_site' ) && |
| 43 | \WPForTeams\is_wpforteams_site( get_current_blog_id() ) ) { |
| 44 | return; |
| 45 | } |
| 46 | |
| 47 | /* |
| 48 | * Do not proceed if the newsletter feature (Subscriptions module) is not enabled |
| 49 | */ |
| 50 | if ( ! ( new Modules() )->is_active( 'subscriptions' ) ) { |
| 51 | return; |
| 52 | } |
| 53 | |
| 54 | require_once JETPACK__PLUGIN_DIR . '/modules/memberships/class-jetpack-memberships.php'; |
| 55 | |
| 56 | if ( \Jetpack_Memberships::should_enable_monetize_blocks_in_editor() ) { |
| 57 | Blocks::jetpack_register_block( |
| 58 | __DIR__, |
| 59 | array( |
| 60 | 'render_callback' => __NAMESPACE__ . '\render_block', |
| 61 | 'supports' => array( |
| 62 | 'spacing' => array( |
| 63 | 'margin' => true, |
| 64 | 'padding' => true, |
| 65 | ), |
| 66 | 'align' => array( 'wide', 'full' ), |
| 67 | ), |
| 68 | ) |
| 69 | ); |
| 70 | } |
| 71 | |
| 72 | register_post_meta( |
| 73 | 'post', |
| 74 | META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, |
| 75 | array( |
| 76 | 'show_in_rest' => true, |
| 77 | 'single' => true, |
| 78 | 'type' => 'string', |
| 79 | 'auth_callback' => function () { |
| 80 | return wp_get_current_user()->has_cap( 'edit_posts' ); |
| 81 | }, |
| 82 | ) |
| 83 | ); |
| 84 | |
| 85 | register_post_meta( |
| 86 | 'post', |
| 87 | META_NAME_FOR_POST_DONT_EMAIL_TO_SUBS, |
| 88 | array( |
| 89 | 'default' => false, |
| 90 | 'show_in_rest' => true, |
| 91 | 'single' => true, |
| 92 | 'type' => 'boolean', |
| 93 | 'auth_callback' => function () { |
| 94 | return wp_get_current_user()->has_cap( 'edit_posts' ); |
| 95 | }, |
| 96 | ) |
| 97 | ); |
| 98 | |
| 99 | register_post_meta( |
| 100 | 'post', |
| 101 | META_NAME_FOR_POST_TIER_ID_SETTINGS, |
| 102 | array( |
| 103 | 'show_in_rest' => true, |
| 104 | 'single' => true, |
| 105 | 'type' => 'integer', |
| 106 | 'auth_callback' => function () { |
| 107 | return wp_get_current_user()->has_cap( 'edit_posts' ); |
| 108 | }, |
| 109 | ) |
| 110 | ); |
| 111 | |
| 112 | register_post_meta( |
| 113 | 'post', |
| 114 | META_NAME_CONTAINS_PAYWALLED_CONTENT, |
| 115 | array( |
| 116 | 'show_in_rest' => true, |
| 117 | 'single' => true, |
| 118 | 'type' => 'boolean', |
| 119 | 'auth_callback' => function () { |
| 120 | return wp_get_current_user()->has_cap( 'edit_posts' ); |
| 121 | }, |
| 122 | ) |
| 123 | ); |
| 124 | |
| 125 | // This ensures Jetpack will sync this post meta to WPCOM. |
| 126 | add_filter( |
| 127 | 'jetpack_sync_post_meta_whitelist', |
| 128 | function ( $allowed_meta ) { |
| 129 | return array_merge( |
| 130 | $allowed_meta, |
| 131 | array( |
| 132 | META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, |
| 133 | META_NAME_FOR_POST_DONT_EMAIL_TO_SUBS, |
| 134 | META_NAME_CONTAINS_PAYWALLED_CONTENT, |
| 135 | ) |
| 136 | ); |
| 137 | } |
| 138 | ); |
| 139 | |
| 140 | // Hide the content – Priority 8 makes it run before do_blocks gets called for the content |
| 141 | add_filter( 'the_content', __NAMESPACE__ . '\add_paywall', 8 ); |
| 142 | |
| 143 | // Close comments on the front-end |
| 144 | add_filter( 'comments_open', __NAMESPACE__ . '\maybe_close_comments', 10, 2 ); |
| 145 | add_filter( 'pings_open', __NAMESPACE__ . '\maybe_close_comments', 10, 2 ); |
| 146 | |
| 147 | // Hide existing comments |
| 148 | add_filter( 'get_comment', __NAMESPACE__ . '\maybe_gate_existing_comments' ); |
| 149 | |
| 150 | // Gate the excerpt for a post |
| 151 | add_filter( 'get_the_excerpt', __NAMESPACE__ . '\jetpack_filter_excerpt_for_newsletter', 10, 2 ); |
| 152 | |
| 153 | // Add a 'Newsletter' column to the Edit posts page |
| 154 | // We only display the "Newsletter" column if we have configured the paid newsletter plan |
| 155 | if ( defined( 'WP_ADMIN' ) && WP_ADMIN && Jetpack_Memberships::has_configured_plans_jetpack_recurring_payments( 'newsletter' ) ) { |
| 156 | add_action( 'manage_post_posts_columns', __NAMESPACE__ . '\register_newsletter_access_column' ); |
| 157 | add_action( 'manage_post_posts_custom_column', __NAMESPACE__ . '\render_newsletter_access_rows', 10, 2 ); |
| 158 | add_action( 'admin_head', __NAMESPACE__ . '\newsletter_access_column_styles' ); |
| 159 | } |
| 160 | |
| 161 | add_action( 'init', __NAMESPACE__ . '\maybe_prevent_super_cache_caching' ); |
| 162 | |
| 163 | add_action( 'wp_after_insert_post', __NAMESPACE__ . '\add_paywalled_content_post_meta', 99, 2 ); |
| 164 | |
| 165 | add_filter( |
| 166 | 'jetpack_options_whitelist', |
| 167 | function ( $options ) { |
| 168 | $options[] = 'jetpack_subscriptions_subscribe_post_end_enabled'; |
| 169 | $options[] = 'jetpack_subscriptions_subscribe_navigation_enabled'; |
| 170 | |
| 171 | return $options; |
| 172 | } |
| 173 | ); |
| 174 | |
| 175 | // If called via REST API, we need to register later in the lifecycle |
| 176 | if ( ( new Host() )->is_wpcom_platform() && ! jetpack_is_frontend() ) { |
| 177 | add_action( |
| 178 | 'restapi_theme_init', |
| 179 | function () { |
| 180 | Jetpack_Subscription_Site::init()->handle_subscribe_block_placements(); |
| 181 | } |
| 182 | ); |
| 183 | } else { |
| 184 | Jetpack_Subscription_Site::init()->handle_subscribe_block_placements(); |
| 185 | } |
| 186 | } |
| 187 | add_action( 'init', __NAMESPACE__ . '\register_block', 9 ); |
| 188 | |
| 189 | /** |
| 190 | * Returns true when in a WP.com environment. |
| 191 | * |
| 192 | * @return boolean |
| 193 | */ |
| 194 | function is_wpcom() { |
| 195 | return defined( 'IS_WPCOM' ) && IS_WPCOM; |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * Adds a 'Newsletter' column after the 'Title' column in the post list |
| 200 | * |
| 201 | * @param array $columns An array of column names. |
| 202 | * @return array An array of column names. |
| 203 | */ |
| 204 | function register_newsletter_access_column( $columns ) { |
| 205 | $position = array_search( 'title', array_keys( $columns ), true ); |
| 206 | $new_column = array( NEWSLETTER_COLUMN_ID => __( 'Newsletter', 'jetpack' ) ); |
| 207 | return array_merge( |
| 208 | array_slice( $columns, 0, $position + 1, true ), |
| 209 | $new_column, |
| 210 | array_slice( $columns, $position, null, true ) |
| 211 | ); |
| 212 | } |
| 213 | |
| 214 | /** |
| 215 | * Add a meta to prevent publication on firehose, ES AI or Reader |
| 216 | * |
| 217 | * @param int $post_id Post id being saved. |
| 218 | * @param \WP_Post $post Post being saved. |
| 219 | * @return void |
| 220 | */ |
| 221 | function add_paywalled_content_post_meta( int $post_id, \WP_Post $post ) { |
| 222 | if ( $post->post_type !== 'post' ) { |
| 223 | return; |
| 224 | } |
| 225 | |
| 226 | $access_level = get_post_meta( $post_id, META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, true ); |
| 227 | |
| 228 | $is_paywalled = false; |
| 229 | switch ( $access_level ) { |
| 230 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS_ALL_TIERS: |
| 231 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS: |
| 232 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_SUBSCRIBERS: |
| 233 | $is_paywalled = true; |
| 234 | } |
| 235 | if ( $is_paywalled ) { |
| 236 | update_post_meta( $post_id, META_NAME_CONTAINS_PAYWALLED_CONTENT, $is_paywalled ); |
| 237 | } |
| 238 | if ( ! $is_paywalled ) { |
| 239 | delete_post_meta( $post_id, META_NAME_CONTAINS_PAYWALLED_CONTENT ); |
| 240 | } |
| 241 | } |
| 242 | |
| 243 | /** |
| 244 | * Displays the newsletter access level. |
| 245 | * |
| 246 | * @param string $column_id The ID of the column to display. |
| 247 | * @param int $post_id The current post ID. |
| 248 | */ |
| 249 | function render_newsletter_access_rows( $column_id, $post_id ) { |
| 250 | if ( NEWSLETTER_COLUMN_ID !== $column_id ) { |
| 251 | return; |
| 252 | } |
| 253 | |
| 254 | $access_level = get_post_meta( $post_id, META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, true ); |
| 255 | |
| 256 | switch ( $access_level ) { |
| 257 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS_ALL_TIERS: |
| 258 | echo esc_html__( 'Paid Subscribers (all plans)', 'jetpack' ); |
| 259 | break; |
| 260 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS: |
| 261 | echo esc_html__( 'Paid Subscribers', 'jetpack' ); |
| 262 | break; |
| 263 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_SUBSCRIBERS: |
| 264 | echo esc_html__( 'Subscribers', 'jetpack' ); |
| 265 | break; |
| 266 | case Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY: |
| 267 | echo esc_html__( 'Everybody', 'jetpack' ); |
| 268 | break; |
| 269 | default: |
| 270 | echo ''; |
| 271 | } |
| 272 | } |
| 273 | |
| 274 | /** |
| 275 | * Adds the Newsletter column styles |
| 276 | */ |
| 277 | function newsletter_access_column_styles() { |
| 278 | echo '<style id="jetpack-newsletter-newsletter-access-column"> table.fixed .column-newsletter_access { width: 10%; } </style>'; |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * Determine the amount of folks currently subscribed to the blog, splitted out in email_subscribers & social_followers & paid_subscribers |
| 283 | * |
| 284 | * @return array containing ['value' => ['email_subscribers' => 0, 'paid_subscribers' => 0, 'social_followers' => 0]] |
| 285 | */ |
| 286 | function fetch_subscriber_counts() { |
| 287 | $subs_count = 0; |
| 288 | if ( is_wpcom() ) { |
| 289 | $subs_count = array( |
| 290 | 'value' => \wpcom_fetch_subs_counts( true ), |
| 291 | ); |
| 292 | } else { |
| 293 | $cache_key = 'wpcom_subscribers_totals'; |
| 294 | $subs_count = get_transient( $cache_key ); |
| 295 | if ( false === $subs_count || 'failed' === $subs_count['status'] ) { |
| 296 | $xml = new \Jetpack_IXR_Client(); |
| 297 | $xml->query( 'jetpack.fetchSubscriberCounts' ); |
| 298 | |
| 299 | if ( $xml->isError() ) { // If we get an error from .com, set the status to failed so that we will try again next time the data is requested. |
| 300 | $subs_count = array( |
| 301 | 'status' => 'failed', |
| 302 | 'code' => $xml->getErrorCode(), |
| 303 | 'message' => $xml->getErrorMessage(), |
| 304 | 'value' => ( isset( $subs_count['value'] ) ) ? $subs_count['value'] : array( |
| 305 | 'email_subscribers' => 0, |
| 306 | 'social_followers' => 0, |
| 307 | 'paid_subscribers' => 0, |
| 308 | ), |
| 309 | ); |
| 310 | } else { |
| 311 | $subs_count = array( |
| 312 | 'status' => 'success', |
| 313 | 'value' => $xml->getResponse(), |
| 314 | ); |
| 315 | } |
| 316 | set_transient( $cache_key, $subs_count, 3600 ); // Try to cache the result for at least 1 hour. |
| 317 | } |
| 318 | } |
| 319 | return $subs_count; |
| 320 | } |
| 321 | |
| 322 | /** |
| 323 | * Returns subscriber count based on include_social_followers attribute |
| 324 | * |
| 325 | * @param bool $include_social_followers Whether to include social followers in the count. |
| 326 | * @return int |
| 327 | */ |
| 328 | function get_subscriber_count( $include_social_followers ) { |
| 329 | $counts = fetch_subscriber_counts(); |
| 330 | |
| 331 | if ( $include_social_followers ) { |
| 332 | $subscriber_count = $counts['value']['email_subscribers'] + $counts['value']['social_followers']; |
| 333 | } else { |
| 334 | $subscriber_count = $counts['value']['email_subscribers']; |
| 335 | } |
| 336 | return $subscriber_count; |
| 337 | } |
| 338 | |
| 339 | /** |
| 340 | * Returns true if the block attributes contain a value for the given key. |
| 341 | * |
| 342 | * @param array $attributes Array containing the block attributes. |
| 343 | * @param string $key Block attribute key. |
| 344 | * |
| 345 | * @return boolean |
| 346 | */ |
| 347 | function has_attribute( $attributes, $key ) { |
| 348 | return isset( $attributes[ $key ] ) && $attributes[ $key ] !== 'undefined'; |
| 349 | } |
| 350 | |
| 351 | /** |
| 352 | * Returns the value for the given attribute key, with the option of providing a default fallback value. |
| 353 | * |
| 354 | * @param array $attributes Array containing the block attributes. |
| 355 | * @param string $key Block attribute key. |
| 356 | * @param mixed $default Optional fallback value in case the key doesn't exist. |
| 357 | * |
| 358 | * @return mixed |
| 359 | */ |
| 360 | function get_attribute( $attributes, $key, $default = null ) { |
| 361 | return has_attribute( $attributes, $key ) ? $attributes[ $key ] : $default; |
| 362 | } |
| 363 | |
| 364 | /** |
| 365 | * Mimics getColorClassName, getFontSizeClass and getGradientClass from @wordpress/block-editor js package. |
| 366 | * |
| 367 | * @param string $setting Setting name. |
| 368 | * @param string $value Setting value. |
| 369 | * |
| 370 | * @return string |
| 371 | */ |
| 372 | function get_setting_class_name( $setting, $value ) { |
| 373 | if ( ! $setting || ! $value ) { |
| 374 | return ''; |
| 375 | } |
| 376 | |
| 377 | return sprintf( 'has-%s-%s', $value, $setting ); |
| 378 | } |
| 379 | |
| 380 | /** |
| 381 | * Uses block attributes to generate an array containing the classes for various block elements. |
| 382 | * Based on Jetpack_Subscriptions_Widget::do_subscription_form() which the block was originally using. |
| 383 | * |
| 384 | * @param array $attributes Array containing the block attributes. |
| 385 | * |
| 386 | * @return array |
| 387 | */ |
| 388 | function get_element_class_names_from_attributes( $attributes ) { |
| 389 | $text_color_class = get_setting_class_name( 'color', get_attribute( $attributes, 'textColor' ) ); |
| 390 | $font_size_class = get_setting_class_name( 'font-size', get_attribute( $attributes, 'fontSize' ) ); |
| 391 | $border_class = get_setting_class_name( 'border-color', get_attribute( $attributes, 'borderColor' ) ); |
| 392 | |
| 393 | $button_background_class = get_setting_class_name( 'background-color', get_attribute( $attributes, 'buttonBackgroundColor' ) ); |
| 394 | $button_gradient_class = get_setting_class_name( 'gradient-background', get_attribute( $attributes, 'buttonGradient' ) ); |
| 395 | |
| 396 | $email_field_background_class = get_setting_class_name( 'background-color', get_attribute( $attributes, 'emailFieldBackgroundColor' ) ); |
| 397 | $email_field_gradient_class = get_setting_class_name( 'gradient-background', get_attribute( $attributes, 'emailFieldGradient' ) ); |
| 398 | |
| 399 | $submit_button_classes = array_filter( |
| 400 | array( |
| 401 | 'wp-block-button__link' => true, |
| 402 | 'no-border-radius' => 0 === get_attribute( $attributes, 'borderRadius', 0 ), |
| 403 | $font_size_class => true, |
| 404 | $border_class => true, |
| 405 | 'has-text-color' => ! empty( $text_color_class ), |
| 406 | $text_color_class => true, |
| 407 | 'has-background' => ! empty( $button_background_class ) || ! empty( $button_gradient_class ), |
| 408 | $button_background_class => ! empty( $button_background_class ), |
| 409 | $button_gradient_class => ! empty( $button_gradient_class ), |
| 410 | ) |
| 411 | ); |
| 412 | |
| 413 | $email_field_classes = array_filter( |
| 414 | array( |
| 415 | 'no-border-radius' => 0 === get_attribute( $attributes, 'borderRadius', 0 ), |
| 416 | $font_size_class => true, |
| 417 | $border_class => true, |
| 418 | $email_field_background_class => true, |
| 419 | $email_field_gradient_class => true, |
| 420 | ) |
| 421 | ); |
| 422 | |
| 423 | $block_wrapper_classes = array_filter( |
| 424 | array( |
| 425 | 'wp-block-jetpack-subscriptions__supports-newline' => true, |
| 426 | 'wp-block-jetpack-subscriptions__use-newline' => (bool) get_attribute( $attributes, 'buttonOnNewLine' ), |
| 427 | 'wp-block-jetpack-subscriptions__show-subs' => (bool) get_attribute( $attributes, 'showSubscribersTotal' ), |
| 428 | ) |
| 429 | ); |
| 430 | |
| 431 | return array( |
| 432 | 'block_wrapper' => implode( ' ', array_keys( $block_wrapper_classes ) ), |
| 433 | 'email_field' => implode( ' ', array_keys( $email_field_classes ) ), |
| 434 | 'submit_button' => implode( ' ', array_keys( $submit_button_classes ) ), |
| 435 | ); |
| 436 | } |
| 437 | |
| 438 | /** |
| 439 | * Checks if block style is "button only" |
| 440 | * |
| 441 | * @param string $class_name Block attribute className; multiple names are spearated by space. |
| 442 | * |
| 443 | * @return bool |
| 444 | */ |
| 445 | function is_button_only_style( $class_name ) { |
| 446 | if ( empty( $class_name ) ) { |
| 447 | return false; |
| 448 | } |
| 449 | |
| 450 | $class_names = explode( ' ', $class_name ); |
| 451 | return in_array( 'is-style-button', $class_names, true ); |
| 452 | } |
| 453 | |
| 454 | /** |
| 455 | * Uses block attributes to generate an array containing the styles for various block elements. |
| 456 | * Based on Jetpack_Subscriptions_Widget::do_subscription_form() which the block was originally using. |
| 457 | * |
| 458 | * @param array $attributes Array containing the block attributes. |
| 459 | * |
| 460 | * @return array |
| 461 | */ |
| 462 | function get_element_styles_from_attributes( $attributes ) { |
| 463 | $is_button_only_style = is_button_only_style( get_attribute( $attributes, 'className', '' ) ); |
| 464 | |
| 465 | $button_background_style = ! has_attribute( $attributes, 'buttonBackgroundColor' ) && has_attribute( $attributes, 'customButtonGradient' ) |
| 466 | ? get_attribute( $attributes, 'customButtonGradient' ) |
| 467 | : get_attribute( $attributes, 'customButtonBackgroundColor' ); |
| 468 | |
| 469 | $email_field_styles = ''; |
| 470 | $submit_button_wrapper_styles = ''; |
| 471 | $submit_button_styles = ''; |
| 472 | |
| 473 | if ( ! empty( $button_background_style ) ) { |
| 474 | $submit_button_styles .= sprintf( 'background: %s;', $button_background_style ); |
| 475 | } |
| 476 | |
| 477 | if ( has_attribute( $attributes, 'customTextColor' ) ) { |
| 478 | $submit_button_styles .= sprintf( 'color: %s;', get_attribute( $attributes, 'customTextColor' ) ); |
| 479 | } |
| 480 | |
| 481 | if ( has_attribute( $attributes, 'buttonWidth' ) ) { |
| 482 | $submit_button_wrapper_styles .= sprintf( 'width: %s;', get_attribute( $attributes, 'buttonWidth', DEFAULT_BUTTON_WIDTH ) ); |
| 483 | $submit_button_wrapper_styles .= 'max-width: 100%;'; |
| 484 | |
| 485 | // Account for custom margins on inline forms. |
| 486 | $submit_button_styles .= true === get_attribute( $attributes, 'buttonOnNewLine' ) |
| 487 | ? 'width: 100%;' |
| 488 | : sprintf( 'width: calc(100%% - %dpx);', get_attribute( $attributes, 'spacing', DEFAULT_SPACING_VALUE ) ); |
| 489 | } |
| 490 | |
| 491 | $font_size = get_attribute( $attributes, 'customFontSize', DEFAULT_FONTSIZE_VALUE ); |
| 492 | $style = sprintf( 'font-size: %s%s;', $font_size, is_numeric( $font_size ) ? 'px' : '' ); |
| 493 | |
| 494 | $submit_button_styles .= $style; |
| 495 | $email_field_styles .= $style; |
| 496 | |
| 497 | $padding = get_attribute( $attributes, 'padding', DEFAULT_PADDING_VALUE ); |
| 498 | $style = sprintf( 'padding: %1$dpx %2$dpx %1$dpx %2$dpx;', $padding, round( $padding * 1.5 ) ); |
| 499 | |
| 500 | $submit_button_styles .= $style; |
| 501 | $email_field_styles .= $style; |
| 502 | |
| 503 | if ( ! $is_button_only_style ) { |
| 504 | $button_spacing = get_attribute( $attributes, 'spacing', DEFAULT_SPACING_VALUE ); |
| 505 | if ( true === get_attribute( $attributes, 'buttonOnNewLine' ) ) { |
| 506 | $submit_button_styles .= sprintf( 'margin-top: %dpx;', $button_spacing ); |
| 507 | } else { |
| 508 | $submit_button_styles .= 'margin: 0; '; // Reset Safari's 2px default margin for buttons affecting input and button union |
| 509 | $submit_button_styles .= sprintf( 'margin-left: %dpx;', $button_spacing ); |
| 510 | } |
| 511 | } |
| 512 | |
| 513 | if ( has_attribute( $attributes, 'borderColor' ) ) { |
| 514 | $style = sprintf( 'border-color: %s;', get_attribute( $attributes, 'borderColor', '' ) ); |
| 515 | $submit_button_styles .= $style; |
| 516 | $email_field_styles .= $style; |
| 517 | } |
| 518 | |
| 519 | $style = sprintf( 'border-radius: %dpx;', get_attribute( $attributes, 'borderRadius', DEFAULT_BORDER_RADIUS_VALUE ) ); |
| 520 | $submit_button_styles .= $style; |
| 521 | $email_field_styles .= $style; |
| 522 | |
| 523 | $style = sprintf( 'border-width: %dpx;', get_attribute( $attributes, 'borderWeight', DEFAULT_BORDER_WEIGHT_VALUE ) ); |
| 524 | $submit_button_styles .= $style; |
| 525 | $email_field_styles .= $style; |
| 526 | |
| 527 | if ( has_attribute( $attributes, 'customBorderColor' ) ) { |
| 528 | $style = sprintf( 'border-color: %s; border-style: solid;', get_attribute( $attributes, 'customBorderColor' ) ); |
| 529 | |
| 530 | $submit_button_styles .= $style; |
| 531 | $email_field_styles .= $style; |
| 532 | } |
| 533 | |
| 534 | if ( ! jetpack_is_frontend() ) { |
| 535 | $background_color_style = get_attribute_color( 'buttonBackgroundColor', $attributes, '#113AF5' /* default lettre theme color */ ); |
| 536 | $text_color_style = get_attribute_color( 'textColor', $attributes, '#FFFFFF' ); |
| 537 | $submit_button_styles .= sprintf( ' background-color: %s; color: %s;', $background_color_style, $text_color_style ); |
| 538 | } |
| 539 | |
| 540 | return array( |
| 541 | 'email_field' => $email_field_styles, |
| 542 | 'submit_button' => $submit_button_styles, |
| 543 | 'submit_button_wrapper' => $submit_button_wrapper_styles, |
| 544 | ); |
| 545 | } |
| 546 | |
| 547 | /** |
| 548 | * Retrieve the resolved color for a given attribute. |
| 549 | * |
| 550 | * @param string $attribute_name The name of the attribute to resolve. |
| 551 | * @param array $attributes An array of all attributes. |
| 552 | * @param string $default_color A fallback color in case no color can be resolved. |
| 553 | * |
| 554 | * @return string Returns the resolved color or the default color if no color is found. |
| 555 | */ |
| 556 | function get_attribute_color( $attribute_name, $attributes, $default_color ) { |
| 557 | if ( has_attribute( $attributes, $attribute_name ) ) { |
| 558 | $color_slug = get_attribute( $attributes, $attribute_name ); |
| 559 | $resolved_color = get_color_from_slug( $color_slug ); |
| 560 | |
| 561 | if ( $resolved_color ) { |
| 562 | return $resolved_color; |
| 563 | } |
| 564 | } |
| 565 | |
| 566 | return get_global_style_color( $attribute_name, $default_color ); |
| 567 | } |
| 568 | |
| 569 | /** |
| 570 | * Retrieve the global style color based on a provided style key. |
| 571 | * |
| 572 | * @param string $style_key The key for the desired style. |
| 573 | * @param string $default_color A fallback color in case the global style is not set. |
| 574 | * |
| 575 | * @return string Returns the color defined in global styles or the default color if not defined. |
| 576 | */ |
| 577 | function get_global_style_color( $style_key, $default_color ) { |
| 578 | $global_styles = wp_get_global_styles( |
| 579 | array( 'color' ), |
| 580 | array( |
| 581 | 'block_name' => 'core/button', |
| 582 | 'transforms' => array( 'resolve-variables' ), |
| 583 | ) |
| 584 | ); |
| 585 | |
| 586 | if ( isset( $global_styles[ $style_key ] ) ) { |
| 587 | return $global_styles[ $style_key ]; |
| 588 | } |
| 589 | |
| 590 | return $default_color; |
| 591 | } |
| 592 | |
| 593 | /** |
| 594 | * Convert a color slug into its corresponding color value. |
| 595 | * |
| 596 | * @param string $slug The slug representation of the color. |
| 597 | * |
| 598 | * @return string|null Returns the color value if found, or null otherwise. |
| 599 | */ |
| 600 | function get_color_from_slug( $slug ) { |
| 601 | $color_palettes = wp_get_global_settings( array( 'color', 'palette' ) ); |
| 602 | |
| 603 | if ( ! is_array( $color_palettes ) ) { |
| 604 | return null; |
| 605 | } |
| 606 | |
| 607 | foreach ( $color_palettes as $palette ) { |
| 608 | if ( is_array( $palette ) ) { |
| 609 | foreach ( $palette as $color ) { |
| 610 | if ( isset( $color['slug'] ) && $color['slug'] === $slug && isset( $color['color'] ) ) { |
| 611 | return $color['color']; |
| 612 | } |
| 613 | } |
| 614 | } |
| 615 | } |
| 616 | |
| 617 | return null; |
| 618 | } |
| 619 | |
| 620 | /** |
| 621 | * Subscriptions block render callback. |
| 622 | * |
| 623 | * @param array $attributes Array containing the block attributes. |
| 624 | * |
| 625 | * @return string |
| 626 | */ |
| 627 | function render_block( $attributes ) { |
| 628 | // If the Subscriptions module is not active, don't render the block. |
| 629 | if ( ! ( new Modules() )->is_active( 'subscriptions' ) ) { |
| 630 | return ''; |
| 631 | } |
| 632 | |
| 633 | if ( class_exists( '\Jetpack_Memberships' ) ) { |
| 634 | // We only want the sites that have newsletter feature enabled to be graced by this JavaScript. |
| 635 | Jetpack_Gutenberg::load_assets_as_required( __DIR__ ); |
| 636 | } else { |
| 637 | Jetpack_Gutenberg::load_styles_as_required( FEATURE_NAME ); |
| 638 | } |
| 639 | |
| 640 | if ( ! class_exists( 'Jetpack_Subscriptions_Widget' ) ) { |
| 641 | return ''; |
| 642 | } |
| 643 | |
| 644 | // Prefill the email field with the current user's email if they are logged in via Memberships premium content token |
| 645 | $subscribe_email = Jetpack_Memberships::get_current_user_email(); |
| 646 | |
| 647 | // If no email, then prefill the email field with the current user's email if they are logged in |
| 648 | if ( empty( $subscribe_email ) ) { |
| 649 | $current_user = wp_get_current_user(); |
| 650 | if ( ! empty( $current_user->user_email ) ) { |
| 651 | $subscribe_email = $current_user->user_email; |
| 652 | } |
| 653 | } |
| 654 | |
| 655 | // The block is using the Jetpack_Subscriptions_Widget backend, hence the need to increase the instance count. |
| 656 | ++Jetpack_Subscriptions_Widget::$instance_count; |
| 657 | |
| 658 | $classes = get_element_class_names_from_attributes( $attributes ); |
| 659 | $styles = get_element_styles_from_attributes( $attributes ); |
| 660 | |
| 661 | // The default value was previously "true" in block.json. We don't want to rely setting "default" in block.json to falsy, |
| 662 | // because it would change the setting for previously saved blocks. Block editor doesn't store default values in attributes at all. |
| 663 | // Hence users without this set will still get social counts included in the subscriber counter. |
| 664 | // Lowering the subscriber count on their behalf with code change would be controversial. |
| 665 | // We want to disencourage including social count as it's misleading. |
| 666 | $include_social_followers = isset( $attributes['includeSocialFollowers'] ) ? (bool) get_attribute( $attributes, 'includeSocialFollowers' ) : true; |
| 667 | |
| 668 | $data = array( |
| 669 | 'widget_id' => Jetpack_Subscriptions_Widget::$instance_count, |
| 670 | 'subscribe_email' => $subscribe_email, |
| 671 | 'is_paid_subscriber' => get_attribute( $attributes, 'isPaidSubscriber', false ), |
| 672 | 'wrapper_attributes' => get_block_wrapper_attributes( |
| 673 | array( |
| 674 | 'class' => $classes['block_wrapper'], |
| 675 | ) |
| 676 | ), |
| 677 | 'subscribe_placeholder' => get_attribute( $attributes, 'subscribePlaceholder', __( 'Type your email…', 'jetpack' ) ), |
| 678 | 'submit_button_text' => get_attribute( $attributes, 'submitButtonText', __( 'Subscribe', 'jetpack' ) ), |
| 679 | 'submit_button_text_subscribed' => get_attribute( $attributes, 'submitButtonTextSubscribed', __( 'Subscribed', 'jetpack' ) ), |
| 680 | 'submit_button_text_upgrade' => get_attribute( $attributes, 'submitButtonTextUpgrade', __( 'Upgrade subscription', 'jetpack' ) ), |
| 681 | 'success_message' => get_attribute( |
| 682 | $attributes, |
| 683 | 'successMessage', |
| 684 | esc_html__( "Success! An email was just sent to confirm your subscription. Please find the email now and click 'Confirm' to start subscribing.", 'jetpack' ) |
| 685 | ), |
| 686 | 'show_subscribers_total' => (bool) get_attribute( $attributes, 'showSubscribersTotal' ), |
| 687 | 'subscribers_total' => get_attribute( $attributes, 'showSubscribersTotal' ) ? get_subscriber_count( $include_social_followers ) : 0, |
| 688 | 'referer' => esc_url_raw( |
| 689 | ( is_ssl() ? 'https' : 'http' ) . '://' . ( isset( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : '' ) . |
| 690 | ( isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : '' ) |
| 691 | ), |
| 692 | 'source' => 'subscribe-block', |
| 693 | 'app_source' => get_attribute( $attributes, 'appSource', null ), |
| 694 | 'class_name' => get_attribute( $attributes, 'className' ), |
| 695 | 'selected_newsletter_categories' => get_attribute( $attributes, 'selectedNewsletterCategoryIds', array() ), |
| 696 | 'preselected_newsletter_categories' => get_attribute( $attributes, 'preselectNewsletterCategories', false ), |
| 697 | ); |
| 698 | |
| 699 | // Only render the email version in non-frontend contexts. |
| 700 | if ( is_feed() || wp_is_xml_request() || |
| 701 | ( defined( 'REST_REQUEST' ) && REST_REQUEST && ! wp_is_json_request() ) || |
| 702 | ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST ) || |
| 703 | ( defined( 'WP_CLI' ) && WP_CLI ) || |
| 704 | wp_is_jsonp_request() ) { |
| 705 | return render_for_email( $data, $styles ); |
| 706 | } |
| 707 | |
| 708 | return render_for_website( $data, $classes, $styles ); |
| 709 | } |
| 710 | |
| 711 | /** |
| 712 | * Get the post access level for the current post. Defaults to 'everybody' if the query is not for a single post |
| 713 | * |
| 714 | * @return string the actual post access level (see projects/plugins/jetpack/extensions/blocks/subscriptions/constants.js for the values). |
| 715 | */ |
| 716 | function get_post_access_level_for_current_post() { |
| 717 | if ( ! is_singular() ) { |
| 718 | // There is no "actual" current post. |
| 719 | return Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY; |
| 720 | } |
| 721 | |
| 722 | return Jetpack_Memberships::get_post_access_level(); |
| 723 | } |
| 724 | |
| 725 | /** |
| 726 | * Renders the subscriptions block at the site. |
| 727 | * |
| 728 | * @param array $data Array containing block view data. |
| 729 | * @param array $classes Array containing the classes for different block elements. |
| 730 | * @param array $styles Array containing the styles for different block elements. |
| 731 | * |
| 732 | * @return string |
| 733 | */ |
| 734 | function render_for_website( $data, $classes, $styles ) { |
| 735 | $lang = get_locale(); |
| 736 | $blog_id = \Jetpack_Options::get_option( 'id' ); |
| 737 | $widget_id_suffix = Jetpack_Subscriptions_Widget::$instance_count > 1 ? '-' . Jetpack_Subscriptions_Widget::$instance_count : ''; |
| 738 | $form_id = 'subscribe-blog' . $widget_id_suffix; |
| 739 | $form_url = 'https://wordpress.com/email-subscriptions'; |
| 740 | $post_access_level = get_post_access_level_for_current_post(); |
| 741 | $is_button_only_style = ! empty( $data['class_name'] ) ? is_button_only_style( $data['class_name'] ) : false; |
| 742 | |
| 743 | // Post ID is used for pulling post-specific paid status, and returning to the right post after confirming subscription |
| 744 | $post_id = null; |
| 745 | if ( in_the_loop() ) { |
| 746 | $post_id = get_the_ID(); |
| 747 | } elseif ( is_singular( 'post' ) || is_page() ) { |
| 748 | $post_id = get_queried_object_id(); |
| 749 | } else { |
| 750 | $post_id = get_option( 'page_on_front' ); |
| 751 | } |
| 752 | |
| 753 | $subscribe_field_id = apply_filters( 'subscribe_field_id', 'subscribe-field' . $widget_id_suffix, $data['widget_id'] ); |
| 754 | $tier_id = get_post_meta( $post_id, META_NAME_FOR_POST_TIER_ID_SETTINGS, true ); |
| 755 | $is_subscribed = Jetpack_Memberships::is_current_user_subscribed(); |
| 756 | $button_text = get_submit_button_text( $data ); |
| 757 | $show_subscriber_count = $data['show_subscribers_total'] && $data['subscribers_total'] && ! $is_subscribed; |
| 758 | |
| 759 | ob_start(); |
| 760 | |
| 761 | Jetpack_Subscriptions_Widget::render_widget_status_messages( |
| 762 | array( |
| 763 | 'success_message' => $data['success_message'], |
| 764 | ) |
| 765 | ); |
| 766 | ?> |
| 767 | <div <?php echo wp_kses_data( $data['wrapper_attributes'] ); ?>> |
| 768 | <div class="wp-block-jetpack-subscriptions__container<?php echo ! $is_subscribed ? ' is-not-subscriber' : ''; ?>"> |
| 769 | <?php if ( is_top_subscription() ) : ?> |
| 770 | <p id="subscribe-submit" class="is-link" |
| 771 | <?php if ( ! empty( $styles['submit_button_wrapper'] ) ) : ?> |
| 772 | style="<?php echo esc_attr( $styles['submit_button_wrapper'] ); ?>" |
| 773 | <?php endif; ?> |
| 774 | > |
| 775 | <a |
| 776 | href="<?php echo esc_url( 'https://wordpress.com/reader/site/subscription/' . $blog_id ); ?>" |
| 777 | <?php if ( ! empty( $classes['submit_button'] ) ) : ?> |
| 778 | class="<?php echo esc_attr( $classes['submit_button'] ); ?>" |
| 779 | <?php endif; ?> |
| 780 | <?php if ( ! empty( $styles['submit_button'] ) ) : ?> |
| 781 | style="<?php echo esc_attr( $styles['submit_button'] ); ?>" |
| 782 | <?php endif; ?> |
| 783 | > |
| 784 | <?php echo sanitize_submit_text( $button_text ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?> |
| 785 | </a> |
| 786 | </p> |
| 787 | <?php else : ?> |
| 788 | <form |
| 789 | action="<?php echo esc_url( $form_url ); ?>" |
| 790 | method="post" |
| 791 | accept-charset="utf-8" |
| 792 | data-blog="<?php echo esc_attr( $blog_id ); ?>" |
| 793 | data-post_access_level="<?php echo esc_attr( $post_access_level ); ?>" |
| 794 | data-subscriber_email="<?php echo esc_attr( $data['subscribe_email'] ); ?>" |
| 795 | id="<?php echo esc_attr( $form_id ); ?>" |
| 796 | > |
| 797 | <div class="wp-block-jetpack-subscriptions__form-elements"> |
| 798 | <?php if ( ! $is_subscribed && ! $is_button_only_style ) : ?> |
| 799 | <p id="subscribe-email"> |
| 800 | <label |
| 801 | id="<?php echo esc_attr( $subscribe_field_id . '-label' ); ?>" |
| 802 | for="<?php echo esc_attr( $subscribe_field_id ); ?>" |
| 803 | class="screen-reader-text" |
| 804 | > |
| 805 | <?php echo esc_html( $data['subscribe_placeholder'] ); ?> |
| 806 | </label> |
| 807 | <?php |
| 808 | printf( |
| 809 | '<input |
| 810 | required="required" |
| 811 | type="email" |
| 812 | name="email" |
| 813 | %1$s |
| 814 | style="%2$s" |
| 815 | placeholder="%3$s" |
| 816 | value="%4$s" |
| 817 | id="%5$s" |
| 818 | %6$s |
| 819 | />', |
| 820 | ( ! empty( $classes['email_field'] ) |
| 821 | ? 'class="' . esc_attr( $classes['email_field'] ) . '"' |
| 822 | : '' |
| 823 | ), |
| 824 | ( ! empty( $styles['email_field'] ) |
| 825 | ? esc_attr( $styles['email_field'] ) |
| 826 | : 'width: 95%; padding: 1px 10px' |
| 827 | ), |
| 828 | esc_attr( $data['subscribe_placeholder'] ), |
| 829 | esc_attr( $data['subscribe_email'] ), |
| 830 | esc_attr( $subscribe_field_id ), |
| 831 | ( ! empty( $data['subscribe_email'] ) |
| 832 | ? 'disabled title="' . esc_attr__( "You're logged in with this email", 'jetpack' ) . '"' |
| 833 | : 'title="' . esc_attr__( 'Please fill in this field.', 'jetpack' ) . '"' |
| 834 | ) |
| 835 | ); |
| 836 | ?> |
| 837 | </p> |
| 838 | <?php endif; ?> |
| 839 | <p id="subscribe-submit" |
| 840 | <?php if ( ! empty( $styles['submit_button_wrapper'] ) ) : ?> |
| 841 | style="<?php echo esc_attr( $styles['submit_button_wrapper'] ); ?>" |
| 842 | <?php endif; ?> |
| 843 | > |
| 844 | <input type="hidden" name="action" value="subscribe"/> |
| 845 | <input type="hidden" name="blog_id" value="<?php echo (int) $blog_id; ?>"/> |
| 846 | <input type="hidden" name="source" value="<?php echo esc_url( $data['referer'] ); ?>"/> |
| 847 | <input type="hidden" name="sub-type" value="<?php echo esc_attr( $data['source'] ); ?>"/> |
| 848 | <input type="hidden" name="app_source" value="<?php echo esc_attr( $data['app_source'] ); ?>"/> |
| 849 | <input type="hidden" name="redirect_fragment" value="<?php echo esc_attr( $form_id ); ?>"/> |
| 850 | <input type="hidden" name="lang" value="<?php echo esc_attr( $lang ); ?>"/> |
| 851 | <?php |
| 852 | wp_nonce_field( 'blogsub_subscribe_' . $blog_id ); |
| 853 | |
| 854 | if ( ! empty( $post_id ) ) { |
| 855 | echo '<input type="hidden" name="post_id" value="' . esc_attr( $post_id ) . '"/>'; |
| 856 | } |
| 857 | |
| 858 | if ( ! empty( $tier_id ) ) { |
| 859 | echo '<input type="hidden" name="tier_id" value="' . esc_attr( $tier_id ) . '"/>'; |
| 860 | } |
| 861 | |
| 862 | if ( $data['preselected_newsletter_categories'] && ! empty( $data['selected_newsletter_categories'] ) ) { |
| 863 | echo '<input type="hidden" name="selected_newsletter_categories" value="' . esc_attr( implode( ',', $data['selected_newsletter_categories'] ) ) . '"/>'; |
| 864 | } |
| 865 | ?> |
| 866 | <button type="submit" |
| 867 | <?php if ( ! empty( $classes['submit_button'] ) ) : ?> |
| 868 | class="<?php echo esc_attr( $classes['submit_button'] ); ?>" |
| 869 | <?php endif; ?> |
| 870 | <?php if ( ! empty( $styles['submit_button'] ) ) : ?> |
| 871 | style="<?php echo esc_attr( $styles['submit_button'] ); ?>" |
| 872 | <?php endif; ?> |
| 873 | name="jetpack_subscriptions_widget" |
| 874 | > |
| 875 | <?php echo sanitize_submit_text( $button_text ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?> |
| 876 | </button> |
| 877 | </p> |
| 878 | </div> |
| 879 | </form> |
| 880 | <?php endif; ?> |
| 881 | <?php if ( $show_subscriber_count ) : ?> |
| 882 | <div class="wp-block-jetpack-subscriptions__subscount"> |
| 883 | <?php echo esc_html( Jetpack_Memberships::get_join_others_text( $data['subscribers_total'] ) ); ?> |
| 884 | </div> |
| 885 | <?php endif; ?> |
| 886 | </div> |
| 887 | </div> |
| 888 | <?php |
| 889 | return ob_get_clean(); |
| 890 | } |
| 891 | |
| 892 | /** |
| 893 | * Renders the email version of the subscriptions block. |
| 894 | * |
| 895 | * @param array $data Array containing block view data. |
| 896 | * @param array $styles Array containing the styles for different block elements. |
| 897 | * |
| 898 | * @return string |
| 899 | */ |
| 900 | function render_for_email( $data, $styles ) { |
| 901 | $submit_button_wrapper_style = ! empty( $styles['submit_button_wrapper'] ) ? 'style="' . esc_attr( $styles['submit_button_wrapper'] ) . '"' : ''; |
| 902 | $button_text = get_submit_button_text( $data ); |
| 903 | |
| 904 | $html = '<div ' . wp_kses_data( $data['wrapper_attributes'] ) . '> |
| 905 | <div> |
| 906 | <div> |
| 907 | <div> |
| 908 | <p ' . $submit_button_wrapper_style . '> |
| 909 | <a href="' . esc_url( get_post_permalink() ) . '" style="' . esc_attr( $styles['submit_button'] ) . ' text-decoration: none; white-space: nowrap; margin-left: 0">' . sanitize_submit_text( $button_text ) . '</a> |
| 910 | </p> |
| 911 | </div> |
| 912 | </div> |
| 913 | </div> |
| 914 | </div>'; |
| 915 | |
| 916 | return $html; |
| 917 | } |
| 918 | |
| 919 | /** |
| 920 | * Filter excerpts looking for subscription data. |
| 921 | * |
| 922 | * @param string $excerpt The extrapolated excerpt string. |
| 923 | * @param \WP_Post $post The current post being processed (in `get_the_excerpt`). |
| 924 | * |
| 925 | * @return mixed |
| 926 | */ |
| 927 | function jetpack_filter_excerpt_for_newsletter( $excerpt, $post = null ) { |
| 928 | // The blogmagazine theme is overriding WP core `get_the_excerpt` filter and only passing the excerpt |
| 929 | // TODO: Until this is fixed, return the excerpt without gating. See https://github.com/Automattic/jetpack/pull/28102#issuecomment-1369161116 |
| 930 | if ( $post && str_contains( $post->post_content, '<!-- wp:jetpack/subscriptions -->' ) ) { |
| 931 | $excerpt .= sprintf( |
| 932 | // translators: %s is the permalink url to the current post. |
| 933 | __( "<p><a href='%s'>View post</a> to subscribe to site newsletter.</p>", 'jetpack' ), |
| 934 | get_post_permalink() |
| 935 | ); |
| 936 | } |
| 937 | return $excerpt; |
| 938 | } |
| 939 | |
| 940 | /** |
| 941 | * Gate access to posts |
| 942 | * |
| 943 | * @param string $the_content Post content. |
| 944 | * |
| 945 | * @return string |
| 946 | */ |
| 947 | function add_paywall( $the_content ) { |
| 948 | require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php'; |
| 949 | |
| 950 | $post_access_level = Jetpack_Memberships::get_post_access_level(); |
| 951 | |
| 952 | if ( Jetpack_Memberships::user_can_view_post() ) { |
| 953 | if ( $post_access_level !== Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY ) { |
| 954 | do_action( |
| 955 | 'earn_track_paywalled_post_view', |
| 956 | array( |
| 957 | 'post_id' => get_the_ID(), |
| 958 | ) |
| 959 | ); |
| 960 | } |
| 961 | return $the_content; |
| 962 | } |
| 963 | |
| 964 | $paywalled_content = get_paywall_content( $post_access_level ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 965 | |
| 966 | if ( has_block( \Automattic\Jetpack\Extensions\Paywall\BLOCK_NAME ) ) { |
| 967 | if ( strpos( $the_content, \Automattic\Jetpack\Extensions\Paywall\BLOCK_HTML ) ) { |
| 968 | return strstr( $the_content, \Automattic\Jetpack\Extensions\Paywall\BLOCK_HTML, true ) . $paywalled_content; |
| 969 | } |
| 970 | // WordPress generates excerpts by either rendering or stripping blocks before invoking the `the_content` filter. |
| 971 | // In the context of generating an excerpt, the Paywall block specifically renders THE_EXCERPT_BLOCK. |
| 972 | if ( strpos( $the_content, \Automattic\Jetpack\Extensions\Paywall\THE_EXCERPT_BLOCK ) ) { |
| 973 | return strstr( $the_content, \Automattic\Jetpack\Extensions\Paywall\THE_EXCERPT_BLOCK, true ); |
| 974 | } |
| 975 | } |
| 976 | |
| 977 | return $paywalled_content; |
| 978 | } |
| 979 | |
| 980 | /** |
| 981 | * Gate access to comments. We want to close comments on private sites. |
| 982 | * |
| 983 | * @param bool $default_comments_open Default state of the comments_open filter. |
| 984 | * @param int $post_id Current post id. |
| 985 | * |
| 986 | * @return bool |
| 987 | */ |
| 988 | function maybe_close_comments( $default_comments_open, $post_id ) { |
| 989 | if ( ! $default_comments_open || ! $post_id ) { |
| 990 | return $default_comments_open; |
| 991 | } |
| 992 | |
| 993 | require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php'; |
| 994 | return Jetpack_Memberships::user_can_view_post(); |
| 995 | } |
| 996 | |
| 997 | /** |
| 998 | * Gate access to existing comments |
| 999 | * |
| 1000 | * @param string $comment The comment. |
| 1001 | * |
| 1002 | * @return string |
| 1003 | */ |
| 1004 | function maybe_gate_existing_comments( $comment ) { |
| 1005 | if ( empty( $comment ) ) { |
| 1006 | return $comment; |
| 1007 | } |
| 1008 | |
| 1009 | require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php'; |
| 1010 | if ( Jetpack_Memberships::user_can_view_post() ) { |
| 1011 | return $comment; |
| 1012 | } |
| 1013 | return ''; |
| 1014 | } |
| 1015 | |
| 1016 | /** |
| 1017 | * Is the Jetpack_Token_Subscription_Service class loaded |
| 1018 | * |
| 1019 | * @return bool |
| 1020 | */ |
| 1021 | function is_jetpack_token_subscription_service_loaded(): bool { |
| 1022 | return class_exists( 'Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Jetpack_Token_Subscription_Service' ); |
| 1023 | } |
| 1024 | |
| 1025 | /** |
| 1026 | * Adds support for WP Super cache and Boost cache |
| 1027 | */ |
| 1028 | function maybe_prevent_super_cache_caching() { |
| 1029 | // Prevents cached page to be served if the Membership cookie is present |
| 1030 | if ( is_jetpack_token_subscription_service_loaded() ) { |
| 1031 | do_action( 'wpsc_add_cookie', Jetpack_Token_Subscription_Service::JWT_AUTH_TOKEN_COOKIE_NAME ); |
| 1032 | } |
| 1033 | |
| 1034 | if ( is_user_auth() ) { |
| 1035 | // Do not cache the page if user is auth with Membership token |
| 1036 | if ( ! defined( 'DONOTCACHEPAGE' ) ) { |
| 1037 | define( 'DONOTCACHEPAGE', true ); |
| 1038 | } |
| 1039 | } |
| 1040 | } |
| 1041 | |
| 1042 | /** |
| 1043 | * Returns paywall content blocks |
| 1044 | * |
| 1045 | * @param string $post_access_level The newsletter access level. |
| 1046 | * @return string |
| 1047 | */ |
| 1048 | function get_paywall_content( $post_access_level ) { |
| 1049 | if ( Jetpack_Memberships::user_is_pending_subscriber() ) { |
| 1050 | return get_paywall_blocks_subscribe_pending(); |
| 1051 | } |
| 1052 | if ( doing_filter( 'get_the_excerpt' ) ) { |
| 1053 | return ''; |
| 1054 | } |
| 1055 | return get_paywall_blocks( $post_access_level ); |
| 1056 | } |
| 1057 | |
| 1058 | /** |
| 1059 | * Returns the current URL. |
| 1060 | * |
| 1061 | * TODO: Copied from https://github.com/Automattic/jetpack/blob/bb885061dc3ee7a80a78a5f0116ab3fcebfddb09/projects/packages/boost-core/src/lib/class-url.php#L39 |
| 1062 | * TODO: Move to a shared package |
| 1063 | * |
| 1064 | * @return string |
| 1065 | */ |
| 1066 | function get_current_url() { |
| 1067 | // Fallback to the site URL if we're unable to determine the URL from $_SERVER global. |
| 1068 | $current_url = site_url(); |
| 1069 | |
| 1070 | if ( isset( $_SERVER ) && is_array( $_SERVER ) ) { |
| 1071 | // phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitization happens at the end |
| 1072 | $scheme = isset( $_SERVER['HTTPS'] ) && 'on' === $_SERVER['HTTPS'] ? 'https' : 'http'; |
| 1073 | $host = ! empty( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : null; |
| 1074 | $path = ! empty( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : ''; |
| 1075 | |
| 1076 | // Support for local plugin development and testing using ngrok. |
| 1077 | if ( ! empty( $_SERVER['HTTP_X_ORIGINAL_HOST'] ) && str_contains( $_SERVER['HTTP_X_ORIGINAL_HOST'], 'ngrok.io' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput -- This is validating. |
| 1078 | $host = wp_unslash( $_SERVER['HTTP_X_ORIGINAL_HOST'] ); |
| 1079 | } |
| 1080 | // phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized |
| 1081 | |
| 1082 | if ( $host ) { |
| 1083 | $current_url = esc_url_raw( sprintf( '%s://%s%s', $scheme, $host, $path ) ); |
| 1084 | } |
| 1085 | } |
| 1086 | |
| 1087 | return $current_url; |
| 1088 | } |
| 1089 | |
| 1090 | /** |
| 1091 | * Get the submit button text based on the subscription status. |
| 1092 | * |
| 1093 | * @param array $data Array containing block view data. |
| 1094 | * |
| 1095 | * @return string |
| 1096 | */ |
| 1097 | function get_submit_button_text( $data ) { |
| 1098 | if ( ! Jetpack_Memberships::is_current_user_subscribed() ) { |
| 1099 | return $data['submit_button_text']; |
| 1100 | } |
| 1101 | if ( ! Jetpack_Memberships::user_can_view_post() ) { |
| 1102 | return $data['submit_button_text_upgrade']; |
| 1103 | } |
| 1104 | return '✓ ' . $data['submit_button_text_subscribed']; |
| 1105 | } |
| 1106 | |
| 1107 | /** |
| 1108 | * Returns true if there are no more tiers to upgrade to. |
| 1109 | * |
| 1110 | * @return boolean |
| 1111 | */ |
| 1112 | function is_top_subscription() { |
| 1113 | if ( ! Jetpack_Memberships::is_current_user_subscribed() ) { |
| 1114 | return false; |
| 1115 | } |
| 1116 | if ( ! Jetpack_Memberships::user_can_view_post() ) { |
| 1117 | return false; |
| 1118 | } |
| 1119 | return true; |
| 1120 | } |
| 1121 | |
| 1122 | /** |
| 1123 | * Sanitize the submit button text. |
| 1124 | * |
| 1125 | * @param string $text String containing the submit button text. |
| 1126 | * |
| 1127 | * @return string |
| 1128 | */ |
| 1129 | function sanitize_submit_text( $text ) { |
| 1130 | return wp_kses( |
| 1131 | html_entity_decode( $text, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ), |
| 1132 | Jetpack_Subscriptions_Widget::$allowed_html_tags_for_submit_button |
| 1133 | ); |
| 1134 | } |
| 1135 | |
| 1136 | /** |
| 1137 | * Returns paywall content blocks if user is not authenticated |
| 1138 | * |
| 1139 | * @param string $newsletter_access_level The newsletter access level. |
| 1140 | * @return string |
| 1141 | */ |
| 1142 | function get_paywall_blocks( $newsletter_access_level ) { |
| 1143 | $custom_paywall = apply_filters( 'jetpack_custom_paywall_blocks', false ); |
| 1144 | if ( ! empty( $custom_paywall ) ) { |
| 1145 | return $custom_paywall; |
| 1146 | } |
| 1147 | if ( ! jetpack_is_frontend() ) { // emails |
| 1148 | return get_paywall_simple(); |
| 1149 | } |
| 1150 | require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php'; |
| 1151 | // Only display paid texts when Stripe is connected and the post is marked for paid subscribers |
| 1152 | $is_paid_post = $newsletter_access_level === 'paid_subscribers' && Jetpack_Memberships::has_connected_account(); |
| 1153 | $is_paid_subscriber = Jetpack_Memberships::user_is_paid_subscriber(); |
| 1154 | |
| 1155 | $access_heading = $is_paid_subscriber |
| 1156 | ? esc_html__( 'Upgrade to continue reading', 'jetpack' ) |
| 1157 | : esc_html__( 'Subscribe to continue reading', 'jetpack' ); |
| 1158 | |
| 1159 | $subscribe_text = $is_paid_post |
| 1160 | // translators: %s is the name of the site. |
| 1161 | ? $is_paid_subscriber |
| 1162 | ? esc_html__( 'Upgrade to get access to the rest of this post and other exclusive content.', 'jetpack' ) |
| 1163 | : esc_html__( 'Become a paid subscriber to get access to the rest of this post and other exclusive content.', 'jetpack' ) |
| 1164 | // translators: %s is the name of the site. |
| 1165 | : esc_html__( 'Subscribe to get access to the rest of this post and other subscriber-only content.', 'jetpack' ); |
| 1166 | |
| 1167 | $login_block = ''; |
| 1168 | |
| 1169 | if ( is_user_auth() ) { |
| 1170 | if ( ( new Host() )->is_wpcom_simple() ) { |
| 1171 | // We cannot use wpcom_logmein_redirect_url since it returns redirect URL when user is already logged in. |
| 1172 | $login_link = add_query_arg( |
| 1173 | array( |
| 1174 | 'redirect_to' => rawurlencode( get_current_url() ), |
| 1175 | 'blog_id' => get_current_blog_id(), |
| 1176 | ), |
| 1177 | 'https://wordpress.com/log-in/link' |
| 1178 | ); |
| 1179 | $switch_accounts_link = wp_logout_url( $login_link ); |
| 1180 | $login_block = '<!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"14px"}}} --> |
| 1181 | <p class="has-text-align-center" style="font-size:14px"> |
| 1182 | <a href="' . $switch_accounts_link . '">' . __( 'Switch accounts', 'jetpack' ) . '</a> |
| 1183 | </p> |
| 1184 | <!-- /wp:paragraph -->'; |
| 1185 | } |
| 1186 | } else { |
| 1187 | $access_question = $is_paid_post ? esc_html__( 'Already a paid subscriber?', 'jetpack' ) : esc_html__( 'Already a subscriber?', 'jetpack' ); |
| 1188 | $login_block = '<!-- wp:group {"style":{"typography":{"fontSize":"14px"}},"layout":{"type":"flex","justifyContent":"center"}} --> |
| 1189 | <div class="wp-block-group" style="font-size:14px"> |
| 1190 | <!-- wp:jetpack/subscriber-login {"logInLabel":"' . $access_question . '"} /--> |
| 1191 | </div> |
| 1192 | <!-- /wp:group -->'; |
| 1193 | } |
| 1194 | |
| 1195 | $lock_svg = plugins_url( 'images/lock-paywall.svg', JETPACK__PLUGIN_FILE ); |
| 1196 | |
| 1197 | return ' |
| 1198 | <!-- wp:group {"style":{"border":{"width":"1px","radius":"4px"},"spacing":{"padding":{"top":"32px","bottom":"32px","left":"32px","right":"32px"}}},"borderColor":"primary","className":"jetpack-subscribe-paywall","layout":{"type":"constrained","contentSize":"400px"}} --> |
| 1199 | <div class="wp-block-group jetpack-subscribe-paywall has-border-color has-primary-border-color" style="border-width:1px;border-radius:4px;padding-top:32px;padding-right:32px;padding-bottom:32px;padding-left:32px"> |
| 1200 | <!-- wp:image {"align":"center","width":24,"height":24,"sizeSlug":"large","linkDestination":"none"} --> |
| 1201 | <figure class="wp-block-image aligncenter size-large is-resized"><img src="' . $lock_svg . '" alt="" width="24" height="24"/></figure> |
| 1202 | <!-- /wp:image --> |
| 1203 | |
| 1204 | <!-- wp:heading {"textAlign":"center","style":{"typography":{"fontStyle":"normal","fontWeight":"600","fontSize":"24px"},"layout":{"selfStretch":"fit"}}} --> |
| 1205 | <h2 class="wp-block-heading has-text-align-center" style="font-size:24px;font-style:normal;font-weight:600">' . $access_heading . '</h2> |
| 1206 | <!-- /wp:heading --> |
| 1207 | |
| 1208 | <!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"14px"},"spacing":{"margin":{"top":"10px","bottom":"10px"}}}} --> |
| 1209 | <p class="has-text-align-center" style="margin-top:10px;margin-bottom:10px;font-size:14px">' . $subscribe_text . '</p> |
| 1210 | <!-- /wp:paragraph --> |
| 1211 | |
| 1212 | <!-- wp:jetpack/subscriptions {"borderRadius":50,"borderColor":"primary","className":"is-style-compact","isPaidSubscriber":' . ( $is_paid_subscriber ? 'true' : 'false' ) . '} /--> |
| 1213 | ' . $login_block . ' |
| 1214 | </div> |
| 1215 | <!-- /wp:group --> |
| 1216 | '; |
| 1217 | } |
| 1218 | |
| 1219 | /** |
| 1220 | * Returns true if user is auth for subscriptions check, otherwise returns false. |
| 1221 | * |
| 1222 | * @return bool |
| 1223 | */ |
| 1224 | function is_user_auth(): bool { |
| 1225 | if ( ( new Host() )->is_wpcom_simple() && is_user_logged_in() ) { |
| 1226 | return true; |
| 1227 | } |
| 1228 | if ( current_user_can( 'manage_options' ) ) { |
| 1229 | return true; |
| 1230 | } |
| 1231 | |
| 1232 | if ( is_jetpack_token_subscription_service_loaded() ) { |
| 1233 | if ( Jetpack_Token_Subscription_Service::has_token_from_cookie() ) { |
| 1234 | return true; |
| 1235 | } |
| 1236 | } |
| 1237 | return false; |
| 1238 | } |
| 1239 | |
| 1240 | /** |
| 1241 | * Returns paywall content blocks when email confirmation is pending |
| 1242 | * |
| 1243 | * @return string |
| 1244 | */ |
| 1245 | function get_paywall_blocks_subscribe_pending() { |
| 1246 | $subscribe_email = Jetpack_Memberships::get_current_user_email(); |
| 1247 | |
| 1248 | /** This filter is documented in \Automattic\Jetpack\Forms\ContactForm\Contact_Form */ |
| 1249 | if ( is_wpcom() || false !== apply_filters( 'jetpack_auto_fill_logged_in_user', false ) ) { |
| 1250 | $current_user = wp_get_current_user(); |
| 1251 | if ( ! empty( $current_user->user_email ) ) { |
| 1252 | $subscribe_email = $current_user->user_email; |
| 1253 | } |
| 1254 | } |
| 1255 | |
| 1256 | $access_heading = esc_html__( 'Confirm your subscription to continue reading', 'jetpack' ); |
| 1257 | |
| 1258 | /* translators: %s: email address */ |
| 1259 | $subscribe_text = sprintf( esc_html__( 'Head to your inbox and confirm your email address %s.', 'jetpack' ), $subscribe_email ); |
| 1260 | |
| 1261 | $lock_svg = plugins_url( 'images/lock-paywall.svg', JETPACK__PLUGIN_FILE ); |
| 1262 | |
| 1263 | return ' |
| 1264 | <!-- wp:group {"style":{"border":{"width":"1px","radius":"4px"},"spacing":{"padding":{"top":"32px","bottom":"32px","left":"32px","right":"32px"}}},"borderColor":"primary","className":"jetpack-subscribe-paywall","layout":{"type":"constrained","contentSize":"400px"}} --> |
| 1265 | <div class="wp-block-group jetpack-subscribe-paywall has-border-color has-primary-border-color" style="border-width:1px;border-radius:4px;padding-top:32px;padding-right:32px;padding-bottom:32px;padding-left:32px"> |
| 1266 | <!-- wp:image {"align":"center","width":24,"height":24,"sizeSlug":"large","linkDestination":"none"} --> |
| 1267 | <figure class="wp-block-image aligncenter size-large is-resized"><img src="' . $lock_svg . '" alt="" width="24" height="24"/></figure> |
| 1268 | <!-- /wp:image --> |
| 1269 | |
| 1270 | <!-- wp:heading {"textAlign":"center","style":{"typography":{"fontStyle":"normal","fontWeight":"600","fontSize":"24px", "maxWidth":"initial"},"layout":{"selfStretch":"fit"}}} --> |
| 1271 | <h2 class="wp-block-heading has-text-align-center" style="font-size:24px;font-style:normal;font-weight:600;max-width:initial">' . $access_heading . '</h2> |
| 1272 | <!-- /wp:heading --> |
| 1273 | |
| 1274 | <!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"14px"},"spacing":{"margin":{"top":"10px","bottom":"10px"}}}} --> |
| 1275 | <p class="has-text-align-center" style="margin-top:10px;margin-bottom:10px;font-size:14px">' . $subscribe_text . '</p> |
| 1276 | <!-- /wp:paragraph --> |
| 1277 | </div> |
| 1278 | <!-- /wp:group --> |
| 1279 | '; |
| 1280 | } |
| 1281 | |
| 1282 | /** |
| 1283 | * Return content for non frontend views like emails. |
| 1284 | * |
| 1285 | * @return string |
| 1286 | */ |
| 1287 | function get_paywall_simple() { |
| 1288 | $access_heading = esc_html__( "You're currently a free subscriber. Upgrade your subscription to get access to the rest of this post and other paid-subscriber only content.", 'jetpack' ); |
| 1289 | |
| 1290 | $subscribe_text = esc_html__( 'Upgrade subscription', 'jetpack' ); |
| 1291 | |
| 1292 | return ' |
| 1293 | <!-- wp:columns --> |
| 1294 | <div class="wp-block-columns" style="display: inline-block; width: 90%"> |
| 1295 | <!-- wp:column --> |
| 1296 | <div class="wp-block-column" style="background-color: #F6F7F7; padding: 32px; 24px;"> |
| 1297 | <!-- wp:paragraph --> |
| 1298 | <p class="has-text-align-center" |
| 1299 | style="text-align: center; |
| 1300 | color: #50575E; |
| 1301 | font-weight: 400; |
| 1302 | font-size: 16px; |
| 1303 | font-family: \'SF Pro Text\', sans-serif; |
| 1304 | line-height: 28.8px;"> |
| 1305 | ' . $access_heading . ' |
| 1306 | </p> |
| 1307 | <!-- /wp:paragraph --> |
| 1308 | <!-- wp:buttons --> |
| 1309 | <div class="wp-block-buttons" style="text-align: center;"> |
| 1310 | <!-- wp:button --> |
| 1311 | <div class="wp-block-button" style="display: inline-block; margin: 10px 0;"> |
| 1312 | <a href="' . esc_url( get_post_permalink() ) . '" class="wp-block-button__link wp-element-button" |
| 1313 | data-wpcom-track data-tracks-link-desc="paywall-email-click" |
| 1314 | style="display: inline-block; |
| 1315 | padding: 15px 20px; |
| 1316 | background-color: #0675C4; |
| 1317 | color: #FFFFFF; |
| 1318 | text-decoration: none; |
| 1319 | border-radius: 5px; |
| 1320 | font-family: \'SF Pro Display\', sans-serif; |
| 1321 | font-weight: 500; |
| 1322 | font-size: 16px; |
| 1323 | text-align: center;">' . $subscribe_text . '</a> |
| 1324 | </div> |
| 1325 | <!-- /wp:button --> |
| 1326 | </div> |
| 1327 | <!-- /wp:buttons --> |
| 1328 | </div> |
| 1329 | <!-- /wp:column --> |
| 1330 | </div> |
| 1331 | <!-- /wp:columns --> |
| 1332 | '; |
| 1333 | } |
| 1334 |