← All changes
|
_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php
+222
-277
12.5.2
→
16.3-a.1
View file →
| @@ -6,9 +6,8 @@ | ||
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | use Automattic\Jetpack\Connection\REST_Connector; |
| 9 | 9 | use Automattic\Jetpack\Current_Plan as Jetpack_Plan; |
| 10 | -use Automattic\Jetpack\Plugins_Installer; | |
| 11 | 10 | use Automattic\Jetpack\Stats\WPCOM_Stats; |
| 12 | 11 | use Automattic\Jetpack\Stats_Admin\Main as Stats_Admin_Main; |
| 13 | 12 | use Automattic\Jetpack\Status; |
| 14 | 13 | use Automattic\Jetpack\Waf\Brute_Force_Protection\Brute_Force_Protection; |
| @@ -13,13 +12,16 @@ | ||
| 13 | 12 | use Automattic\Jetpack\Status; |
| 14 | 13 | use Automattic\Jetpack\Waf\Brute_Force_Protection\Brute_Force_Protection; |
| 15 | 14 | use Automattic\Jetpack\Waf\Brute_Force_Protection\Brute_Force_Protection_Shared_Functions; |
| 16 | 15 | |
| 16 | +if ( ! defined( 'ABSPATH' ) ) { | |
| 17 | + exit( 0 ); | |
| 18 | +} | |
| 19 | + | |
| 17 | 20 | /** |
| 18 | 21 | * This is the base class for every Core API endpoint Jetpack uses. |
| 19 | 22 | */ |
| 20 | -class Jetpack_Core_API_Module_Toggle_Endpoint | |
| 21 | - extends Jetpack_Core_API_XMLRPC_Consumer_Endpoint { | |
| 23 | +class Jetpack_Core_API_Module_Toggle_Endpoint extends Jetpack_Core_API_XMLRPC_Consumer_Endpoint { | |
| 22 | 24 | |
| 23 | 25 | /** |
| 24 | 26 | * Check if the module requires the site to be publicly accessible from WPCOM. |
| 25 | 27 | * If the site meets this requirement, the module is activated. Otherwise an error is returned. |
| @@ -403,15 +405,17 @@ | ||
| 403 | 405 | $module['activated'] = false; |
| 404 | 406 | } |
| 405 | 407 | |
| 406 | 408 | $i18n = jetpack_get_module_i18n( $request['slug'] ); |
| 407 | - if ( isset( $module['name'] ) ) { | |
| 408 | - $module['name'] = $i18n['name']; | |
| 409 | + if ( $i18n ) { | |
| 410 | + if ( isset( $module['name'] ) ) { | |
| 411 | + $module['name'] = $i18n['name']; | |
| 412 | + } | |
| 413 | + if ( isset( $module['description'] ) ) { | |
| 414 | + $module['description'] = $i18n['description']; | |
| 415 | + $module['short_description'] = $i18n['description']; | |
| 416 | + } | |
| 409 | 417 | } |
| 410 | - if ( isset( $module['description'] ) ) { | |
| 411 | - $module['description'] = $i18n['description']; | |
| 412 | - $module['short_description'] = $i18n['description']; | |
| 413 | - } | |
| 414 | 418 | if ( isset( $module['module_tags'] ) ) { |
| 415 | 419 | $module['module_tags'] = array_map( 'jetpack_get_module_i18n_tag', $module['module_tags'] ); |
| 416 | 420 | } |
| 417 | 421 | |
| @@ -448,14 +452,18 @@ | ||
| 448 | 452 | $response[ $module ] = Jetpack::is_module_active( $module ); |
| 449 | 453 | } |
| 450 | 454 | } |
| 451 | 455 | |
| 452 | - $settings = Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list( 'settings' ); | |
| 456 | + $settings = Jetpack_Core_Json_Api_Endpoints::filter_options_for_response( | |
| 457 | + Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list( 'settings' ) | |
| 458 | + ); | |
| 453 | 459 | |
| 454 | 460 | if ( ! function_exists( 'is_plugin_active' ) ) { |
| 455 | 461 | require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
| 456 | 462 | } |
| 457 | 463 | |
| 464 | + $response['categories'] = get_categories( array( 'get' => 'all' ) ); | |
| 465 | + | |
| 458 | 466 | foreach ( $settings as $setting => $properties ) { |
| 459 | 467 | switch ( $setting ) { |
| 460 | 468 | case 'lang_id': |
| 461 | 469 | if ( ! current_user_can( 'install_languages' ) ) { |
| @@ -484,24 +492,8 @@ | ||
| 484 | 492 | $response[ $setting ] = class_exists( 'Akismet' ) ? Akismet::get_api_key() : ''; |
| 485 | 493 | } |
| 486 | 494 | break; |
| 487 | 495 | |
| 488 | - case 'onboarding': | |
| 489 | - $business_address = get_option( 'jpo_business_address' ); | |
| 490 | - $business_address = is_array( $business_address ) ? array_map( array( $this, 'decode_special_characters' ), $business_address ) : $business_address; | |
| 491 | - | |
| 492 | - $response[ $setting ] = array( | |
| 493 | - 'siteTitle' => $this->decode_special_characters( get_option( 'blogname' ) ), | |
| 494 | - 'siteDescription' => $this->decode_special_characters( get_option( 'blogdescription' ) ), | |
| 495 | - 'siteType' => get_option( 'jpo_site_type' ), | |
| 496 | - 'homepageFormat' => get_option( 'jpo_homepage_format' ), | |
| 497 | - 'addContactForm' => (int) get_option( 'jpo_contact_page' ), | |
| 498 | - 'businessAddress' => $business_address, | |
| 499 | - 'installWooCommerce' => is_plugin_active( 'woocommerce/woocommerce.php' ), | |
| 500 | - 'stats' => Jetpack::is_connection_ready() && Jetpack::is_module_active( 'stats' ), | |
| 501 | - ); | |
| 502 | - break; | |
| 503 | - | |
| 504 | 496 | case 'search_auto_config': |
| 505 | 497 | // Only writable. |
| 506 | 498 | $response[ $setting ] = 1; |
| 507 | 499 | break; |
| @@ -506,9 +498,9 @@ | ||
| 506 | 498 | $response[ $setting ] = 1; |
| 507 | 499 | break; |
| 508 | 500 | |
| 509 | 501 | default: |
| 510 | - $default = isset( $settings[ $setting ]['default'] ) ? $settings[ $setting ]['default'] : false; | |
| 502 | + $default = $settings[ $setting ]['default'] ?? false; | |
| 511 | 503 | $response[ $setting ] = Jetpack_Core_Json_Api_Endpoints::cast_value( get_option( $setting, $default ), $settings[ $setting ] ); |
| 512 | 504 | break; |
| 513 | 505 | } |
| 514 | 506 | } |
| @@ -514,25 +506,23 @@ | ||
| 514 | 506 | } |
| 515 | 507 | |
| 516 | 508 | $response['akismet'] = is_plugin_active( 'akismet/akismet.php' ); |
| 517 | 509 | |
| 510 | + require_once JETPACK__PLUGIN_DIR . '/modules/memberships/class-jetpack-memberships.php'; | |
| 511 | + if ( class_exists( 'Jetpack_Memberships' ) ) { | |
| 512 | + $response['newsletter_has_active_plan'] = count( Jetpack_Memberships::get_all_newsletter_plan_ids( false ) ) > 0; | |
| 513 | + } | |
| 514 | + | |
| 515 | + // Make sure we are returning a consistent type | |
| 516 | + if ( ! class_exists( 'Jetpack_Newsletter_Category_Helper' ) ) { | |
| 517 | + require_once JETPACK__PLUGIN_DIR . '_inc/lib/class-jetpack-newsletter-category-helper.php'; | |
| 518 | + } | |
| 519 | + $response['wpcom_newsletter_categories'] = Jetpack_Newsletter_Category_Helper::get_category_ids(); | |
| 520 | + | |
| 518 | 521 | return rest_ensure_response( $response ); |
| 519 | 522 | } |
| 520 | 523 | |
| 521 | 524 | /** |
| 522 | - * Decode the special HTML characters in a certain value. | |
| 523 | - * | |
| 524 | - * @since 5.8 | |
| 525 | - * | |
| 526 | - * @param string $value Value to decode. | |
| 527 | - * | |
| 528 | - * @return string Value with decoded HTML characters. | |
| 529 | - */ | |
| 530 | - private function decode_special_characters( $value ) { | |
| 531 | - return (string) htmlspecialchars_decode( $value, ENT_QUOTES ); | |
| 532 | - } | |
| 533 | - | |
| 534 | - /** | |
| 535 | 525 | * If it's a valid Jetpack module and configuration parameters have been sent, update it. |
| 536 | 526 | * |
| 537 | 527 | * @since 4.3.0 |
| 538 | 528 | * |
| @@ -541,9 +531,9 @@ | ||
| 541 | 531 | * |
| 542 | 532 | * @type string $slug Module slug. |
| 543 | 533 | * } |
| 544 | 534 | * |
| 545 | - * @return bool|WP_Error True if module was updated. Otherwise, a WP_Error instance with the corresponding error. | |
| 535 | + * @return bool|WP_REST_Response|WP_Error True or a WP_REST_Response if module was updated. Otherwise, a WP_Error instance with the corresponding error. | |
| 546 | 536 | */ |
| 547 | 537 | public function update_data( $request ) { |
| 548 | 538 | |
| 549 | 539 | // If it's null, we're trying to update many module options from different modules. |
| @@ -563,9 +553,9 @@ | ||
| 563 | 553 | } |
| 564 | 554 | |
| 565 | 555 | /* |
| 566 | 556 | * Get parameters to update the module. |
| 567 | - * We can not simply use $request->get_params() because when we registered this route, | |
| 557 | + * We cannot simply use $request->get_params() because when we registered this route, | |
| 568 | 558 | * we are adding the entire output of Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list() |
| 569 | 559 | * to the current request object's params. We are interested in body of the actual request. |
| 570 | 560 | * This may be JSON: |
| 571 | 561 | */ |
| @@ -650,13 +640,22 @@ | ||
| 650 | 640 | if ( ! $updated ) { |
| 651 | 641 | $not_updated[ $option ] = $error; |
| 652 | 642 | } |
| 653 | 643 | |
| 644 | + if ( $updated ) { | |
| 645 | + // Return the module state. | |
| 646 | + $response[ $option ] = $value; | |
| 647 | + } | |
| 648 | + | |
| 654 | 649 | // Remove module from list so we don't go through it again. |
| 655 | 650 | unset( $params[ $option ] ); |
| 656 | 651 | } |
| 657 | 652 | } |
| 658 | 653 | |
| 654 | + if ( ! class_exists( 'Jetpack_Newsletter_Category_Helper' ) ) { | |
| 655 | + require_once JETPACK__PLUGIN_DIR . '_inc/lib/class-jetpack-newsletter-category-helper.php'; | |
| 656 | + } | |
| 657 | + | |
| 659 | 658 | foreach ( $params as $option => $value ) { |
| 660 | 659 | |
| 661 | 660 | // Used if there was an error. Can be overwritten with specific error messages. |
| 662 | 661 | $error = ''; |
| @@ -666,8 +665,14 @@ | ||
| 666 | 665 | |
| 667 | 666 | // Get option attributes, including the group it belongs to. |
| 668 | 667 | $option_attrs = $options[ $option ]; |
| 669 | 668 | |
| 669 | + // Everything outside the Post by Email group requires the admin capability. | |
| 670 | + if ( 'post-by-email' !== $option_attrs['jp_group'] && ! current_user_can( 'jetpack_configure_modules' ) ) { | |
| 671 | + $not_updated[ $option ] = REST_Connector::get_user_permissions_error_msg(); | |
| 672 | + continue; | |
| 673 | + } | |
| 674 | + | |
| 670 | 675 | // If this is a module option and the related module isn't active for any reason, continue with the next one. |
| 671 | 676 | if ( 'settings' !== $option_attrs['jp_group'] ) { |
| 672 | 677 | if ( ! Jetpack::is_module( $option_attrs['jp_group'] ) ) { |
| 673 | 678 | $not_updated[ $option ] = esc_html__( 'The requested Jetpack module was not found.', 'jetpack' ); |
| @@ -718,8 +723,13 @@ | ||
| 718 | 723 | $updated = get_option( 'WPLANG' ) === $language ? true : update_option( 'WPLANG', $language ); |
| 719 | 724 | break; |
| 720 | 725 | |
| 721 | 726 | case 'monitor_receive_notifications': |
| 727 | + if ( ! class_exists( 'Jetpack_Monitor' ) ) { | |
| 728 | + $updated = false; | |
| 729 | + break; | |
| 730 | + } | |
| 731 | + | |
| 722 | 732 | $monitor = new Jetpack_Monitor(); |
| 723 | 733 | |
| 724 | 734 | // If we got true as response, consider it done. |
| 725 | 735 | $updated = true === $monitor->update_option_receive_jetpack_monitor_notification( $value ); |
| @@ -725,8 +735,13 @@ | ||
| 725 | 735 | $updated = true === $monitor->update_option_receive_jetpack_monitor_notification( $value ); |
| 726 | 736 | break; |
| 727 | 737 | |
| 728 | 738 | case 'post_by_email_address': |
| 739 | + if ( ! class_exists( 'Jetpack_Post_By_Email' ) ) { | |
| 740 | + $updated = false; | |
| 741 | + break; | |
| 742 | + } | |
| 743 | + | |
| 729 | 744 | $result = Jetpack_Post_By_Email::init()->process_api_request( $value ); |
| 730 | 745 | |
| 731 | 746 | // If we got an email address (create or regenerate) or 1 (delete), consider it done. |
| 732 | 747 | if ( is_string( $result ) && preg_match( '/[a-z0-9][email protected]/', $result ) ) { |
| @@ -747,9 +762,9 @@ | ||
| 747 | 762 | $result = false; |
| 748 | 763 | } |
| 749 | 764 | |
| 750 | 765 | // If we got one of Protect keys, consider it done. |
| 751 | - if ( preg_match( '/[a-z0-9]{40,}/i', $result ) ) { | |
| 766 | + if ( is_string( $result ) && preg_match( '/[a-z0-9]{40,}/i', $result ) ) { | |
| 752 | 767 | $response[ $option ] = $result; |
| 753 | 768 | $updated = true; |
| 754 | 769 | } |
| 755 | 770 | break; |
| @@ -813,8 +828,17 @@ | ||
| 813 | 828 | ? update_option( 'verification_services_codes', $grouped_options ) |
| 814 | 829 | : true; |
| 815 | 830 | break; |
| 816 | 831 | |
| 832 | + case Jetpack_SEO_Utils::FRONT_PAGE_META_OPTION: | |
| 833 | + Jetpack_SEO_Utils::update_front_page_meta_description( $value ); | |
| 834 | + $response[ $option ] = Jetpack_SEO_Utils::get_front_page_meta_description(); | |
| 835 | + // The helper returns an empty string for a successful clear or | |
| 836 | + // same-value write, so use its authoritative getter for the response | |
| 837 | + // and treat every valid request reaching this switch as handled. | |
| 838 | + $updated = true; | |
| 839 | + break; | |
| 840 | + | |
| 817 | 841 | case 'sharing_services': |
| 818 | 842 | if ( ! class_exists( 'Sharing_Service' ) && ! include_once JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) { |
| 819 | 843 | break; |
| 820 | 844 | } |
| @@ -962,27 +986,37 @@ | ||
| 962 | 986 | ? update_option( $option, (bool) $value ) |
| 963 | 987 | : true; |
| 964 | 988 | break; |
| 965 | 989 | |
| 966 | - case 'onboarding': | |
| 967 | - require_once JETPACK__PLUGIN_DIR . '_inc/lib/widgets.php'; | |
| 968 | - // Break apart and set Jetpack onboarding options. | |
| 969 | - $result = $this->process_onboarding( (array) $value ); | |
| 970 | - if ( empty( $result ) ) { | |
| 971 | - $updated = true; | |
| 972 | - } else { | |
| 973 | - $error = sprintf( | |
| 974 | - /* Translators: placeholder is a list of error codes. */ | |
| 975 | - esc_html__( 'Onboarding failed to process: %s', 'jetpack' ), | |
| 976 | - $result | |
| 977 | - ); | |
| 978 | - $updated = false; | |
| 979 | - } | |
| 990 | + case 'jetpack_subscriptions_reply_to': | |
| 991 | + // If option value was the same, consider it done. | |
| 992 | + require_once JETPACK__PLUGIN_DIR . 'modules/subscriptions/class-settings.php'; | |
| 993 | + $sub_value = Automattic\Jetpack\Modules\Subscriptions\Settings::is_valid_reply_to( $value ) | |
| 994 | + ? $value | |
| 995 | + : Automattic\Jetpack\Modules\Subscriptions\Settings::$default_reply_to; | |
| 996 | + | |
| 997 | + $updated = (string) get_option( $option ) !== (string) $sub_value ? update_option( $option, $sub_value ) : true; | |
| 980 | 998 | break; |
| 999 | + case 'jetpack_subscriptions_from_name': | |
| 1000 | + // If option value was the same, consider it done. | |
| 1001 | + $sub_value = sanitize_text_field( $value ); | |
| 1002 | + $updated = (string) get_option( $option ) !== (string) $sub_value ? update_option( $option, $sub_value ) : true; | |
| 1003 | + break; | |
| 981 | 1004 | |
| 982 | 1005 | case 'stb_enabled': |
| 983 | 1006 | case 'stc_enabled': |
| 984 | 1007 | case 'sm_enabled': |
| 1008 | + case 'jetpack_subscribe_overlay_enabled': | |
| 1009 | + case 'jetpack_subscribe_floating_button_enabled': | |
| 1010 | + case 'wpcom_newsletter_categories_enabled': | |
| 1011 | + case 'wpcom_featured_image_in_email': | |
| 1012 | + case 'jetpack_gravatar_in_email': | |
| 1013 | + case 'jetpack_author_in_email': | |
| 1014 | + case 'jetpack_post_date_in_email': | |
| 1015 | + case 'wpcom_subscription_emails_use_excerpt': | |
| 1016 | + case 'jetpack_subscriptions_subscribe_post_end_enabled': | |
| 1017 | + case 'jetpack_subscriptions_login_navigation_enabled': | |
| 1018 | + case 'jetpack_subscriptions_subscribe_navigation_enabled': | |
| 985 | 1019 | // Convert the false value to 0. This allows the option to be updated if it doesn't exist yet. |
| 986 | 1020 | $sub_value = $value ? $value : 0; |
| 987 | 1021 | $updated = (string) get_option( $option ) !== (string) $sub_value ? update_option( $option, $sub_value ) : true; |
| 988 | 1022 | break; |
| @@ -990,8 +1024,119 @@ | ||
| 990 | 1024 | case 'jetpack_blocks_disabled': |
| 991 | 1025 | $updated = (bool) get_option( $option ) !== (bool) $value ? update_option( $option, (bool) $value ) : true; |
| 992 | 1026 | break; |
| 993 | 1027 | |
| 1028 | + case 'subscription_options': | |
| 1029 | + if ( ! is_array( $value ) ) { | |
| 1030 | + break; | |
| 1031 | + } | |
| 1032 | + | |
| 1033 | + $allowed_keys = array( 'invitation', 'comment_follow', 'welcome', 'subscribe_modal_heading', 'free_tier_description', 'hide_free_tier' ); | |
| 1034 | + $filtered_value = array_filter( | |
| 1035 | + $value, | |
| 1036 | + function ( $key ) use ( $allowed_keys ) { | |
| 1037 | + return in_array( $key, $allowed_keys, true ); | |
| 1038 | + }, | |
| 1039 | + ARRAY_FILTER_USE_KEY | |
| 1040 | + ); | |
| 1041 | + | |
| 1042 | + if ( empty( $filtered_value ) ) { | |
| 1043 | + break; | |
| 1044 | + } | |
| 1045 | + | |
| 1046 | + // `hide_free_tier` is a boolean flag, so pull it out before the HTML | |
| 1047 | + // sanitization below (which expects strings). Sanitize it with | |
| 1048 | + // rest_sanitize_boolean() so stringy booleans (e.g. "false", "0") | |
| 1049 | + // are interpreted correctly rather than being treated as truthy by a | |
| 1050 | + // plain `! empty()`. | |
| 1051 | + $has_hide_free_tier = array_key_exists( 'hide_free_tier', $filtered_value ); | |
| 1052 | + $hide_free_tier = $has_hide_free_tier && rest_sanitize_boolean( $filtered_value['hide_free_tier'] ); | |
| 1053 | + unset( $filtered_value['hide_free_tier'] ); | |
| 1054 | + | |
| 1055 | + array_walk_recursive( | |
| 1056 | + $filtered_value, | |
| 1057 | + function ( &$value ) { | |
| 1058 | + $value = wp_kses( | |
| 1059 | + $value, | |
| 1060 | + array( | |
| 1061 | + 'ul' => array(), | |
| 1062 | + 'li' => array(), | |
| 1063 | + 'p' => array(), | |
| 1064 | + 'strong' => array(), | |
| 1065 | + 'ol' => array(), | |
| 1066 | + 'em' => array(), | |
| 1067 | + 'a' => array( | |
| 1068 | + 'href' => array(), | |
| 1069 | + ), | |
| 1070 | + ) | |
| 1071 | + ); | |
| 1072 | + } | |
| 1073 | + ); | |
| 1074 | + | |
| 1075 | + // Normalize whitespace-only `subscribe_modal_heading` input to empty so | |
| 1076 | + // the modal template's `empty()` fallback fires. PHP's `empty()` treats | |
| 1077 | + // `" "` as non-empty, which would otherwise render a blank heading. | |
| 1078 | + if ( isset( $filtered_value['subscribe_modal_heading'] ) ) { | |
| 1079 | + $filtered_value['subscribe_modal_heading'] = trim( $filtered_value['subscribe_modal_heading'] ); | |
| 1080 | + } | |
| 1081 | + | |
| 1082 | + // The free tier description is stored as plain markdown source, so strip | |
| 1083 | + // all HTML and cap its length to match the paid-tier description field. | |
| 1084 | + // WordPress core guarantees mb_substr() (polyfilled in wp-includes/compat.php | |
| 1085 | + // when the mbstring extension is unavailable), so it's safe to use directly. | |
| 1086 | + // A JSON payload could supply a non-scalar (array/object) for this field, | |
| 1087 | + // which would fatal in wp_kses()/mb_substr() on PHP 8+, so drop invalid values. | |
| 1088 | + if ( isset( $filtered_value['free_tier_description'] ) ) { | |
| 1089 | + if ( is_scalar( $filtered_value['free_tier_description'] ) ) { | |
| 1090 | + $filtered_value['free_tier_description'] = mb_substr( wp_kses( (string) $filtered_value['free_tier_description'], array() ), 0, 500 ); | |
| 1091 | + } else { | |
| 1092 | + unset( $filtered_value['free_tier_description'] ); | |
| 1093 | + } | |
| 1094 | + } | |
| 1095 | + | |
| 1096 | + if ( $has_hide_free_tier ) { | |
| 1097 | + $filtered_value['hide_free_tier'] = $hide_free_tier; | |
| 1098 | + } | |
| 1099 | + | |
| 1100 | + $old_subscription_options = get_option( 'subscription_options' ); | |
| 1101 | + if ( ! is_array( $old_subscription_options ) ) { | |
| 1102 | + $old_subscription_options = array(); | |
| 1103 | + } | |
| 1104 | + $new_subscription_options = array_merge( $old_subscription_options, $filtered_value ); | |
| 1105 | + $updated = true; | |
| 1106 | + | |
| 1107 | + if ( serialize( $old_subscription_options ) === serialize( $new_subscription_options ) ) { // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize | |
| 1108 | + break; // This prevents the option update to fail when the values are the same. | |
| 1109 | + } | |
| 1110 | + | |
| 1111 | + if ( ! update_option( $option, $new_subscription_options ) ) { | |
| 1112 | + $updated = false; | |
| 1113 | + $error = esc_html__( 'Subscription Options failed to process.', 'jetpack' ); | |
| 1114 | + } | |
| 1115 | + break; | |
| 1116 | + | |
| 1117 | + case Jetpack_Newsletter_Category_Helper::NEWSLETTER_CATEGORIES_OPTION: | |
| 1118 | + if ( ! is_array( $value ) || empty( $value ) ) { | |
| 1119 | + $updated = true; | |
| 1120 | + break; | |
| 1121 | + } | |
| 1122 | + | |
| 1123 | + // If we are already current, do nothing | |
| 1124 | + $current_value = Jetpack_Newsletter_Category_Helper::get_category_ids(); | |
| 1125 | + if ( $value === $current_value ) { | |
| 1126 | + $updated = true; | |
| 1127 | + break; | |
| 1128 | + } | |
| 1129 | + | |
| 1130 | + if ( Jetpack_Newsletter_Category_Helper::save_category_ids( $value ) ) { | |
| 1131 | + $updated = true; | |
| 1132 | + } else { | |
| 1133 | + $updated = false; | |
| 1134 | + $error = esc_html__( 'Newsletter category did not update.', 'jetpack' ); | |
| 1135 | + } | |
| 1136 | + | |
| 1137 | + break; | |
| 1138 | + | |
| 994 | 1139 | default: |
| 995 | 1140 | // Boolean values are stored as 1 or 0. |
| 996 | 1141 | if ( isset( $options[ $option ]['type'] ) && 'boolean' === $options[ $option ]['type'] ) { |
| 997 | 1142 | $value = (int) $value; |
| @@ -997,9 +1142,9 @@ | ||
| 997 | 1142 | $value = (int) $value; |
| 998 | 1143 | } |
| 999 | 1144 | |
| 1000 | 1145 | // If option value was the same as it's current value, or it's default, consider it done. |
| 1001 | - $default = isset( $options[ $option ]['default'] ) ? $options[ $option ]['default'] : false; | |
| 1146 | + $default = $options[ $option ]['default'] ?? false; | |
| 1002 | 1147 | $updated = get_option( $option, $default ) != $value // phpcs:ignore Universal.Operators.StrictComparisons.LooseNotEqual -- ensure we support scalars or strings saved by update_option. |
| 1003 | 1148 | ? update_option( $option, $value ) |
| 1004 | 1149 | : true; |
| 1005 | 1150 | break; |
| @@ -1053,218 +1198,30 @@ | ||
| 1053 | 1198 | * Perform tasks in the site based on onboarding choices. |
| 1054 | 1199 | * |
| 1055 | 1200 | * @since 5.4.0 |
| 1056 | 1201 | * |
| 1202 | + * @deprecated since 13.9 | |
| 1203 | + * | |
| 1057 | 1204 | * @param array $data Onboarding choices made by user. |
| 1058 | 1205 | * |
| 1059 | 1206 | * @return string Result of onboarding processing and, if there is one, an error message. |
| 1060 | 1207 | */ |
| 1061 | - private function process_onboarding( $data ) { | |
| 1062 | - if ( isset( $data['end'] ) && $data['end'] ) { | |
| 1063 | - return Jetpack::invalidate_onboarding_token() | |
| 1064 | - ? '' | |
| 1065 | - : esc_html__( "The onboarding token couldn't be deleted.", 'jetpack' ); | |
| 1066 | - } | |
| 1067 | - | |
| 1068 | - $error = array(); | |
| 1069 | - | |
| 1070 | - if ( ! empty( $data['siteTitle'] ) ) { | |
| 1071 | - // If option value was the same, consider it done. | |
| 1072 | - if ( ! ( | |
| 1073 | - update_option( 'blogname', $data['siteTitle'] ) | |
| 1074 | - || get_option( 'blogname' ) === $data['siteTitle'] | |
| 1075 | - ) ) { | |
| 1076 | - $error[] = 'siteTitle'; | |
| 1077 | - } | |
| 1078 | - } | |
| 1079 | - | |
| 1080 | - if ( isset( $data['siteDescription'] ) ) { | |
| 1081 | - // If option value was the same, consider it done. | |
| 1082 | - if ( ! ( | |
| 1083 | - update_option( 'blogdescription', $data['siteDescription'] ) | |
| 1084 | - || get_option( 'blogdescription' ) === $data['siteDescription'] | |
| 1085 | - ) ) { | |
| 1086 | - $error[] = 'siteDescription'; | |
| 1087 | - } | |
| 1088 | - } | |
| 1089 | - | |
| 1090 | - $site_title = get_option( 'blogname' ); | |
| 1091 | - $author = get_current_user_id() || 1; | |
| 1092 | - | |
| 1093 | - if ( ! empty( $data['siteType'] ) ) { | |
| 1094 | - if ( ! ( | |
| 1095 | - update_option( 'jpo_site_type', $data['siteType'] ) | |
| 1096 | - || get_option( 'jpo_site_type' ) === $data['siteType'] | |
| 1097 | - ) ) { | |
| 1098 | - $error[] = 'siteType'; | |
| 1099 | - } | |
| 1100 | - } | |
| 1101 | - | |
| 1102 | - if ( isset( $data['homepageFormat'] ) ) { | |
| 1103 | - /* | |
| 1104 | - * If $data['homepageFormat'] is 'posts', | |
| 1105 | - * we have nothing to do since it's WordPress' default | |
| 1106 | - * if it exists, just update | |
| 1107 | - */ | |
| 1108 | - $homepage_format = get_option( 'jpo_homepage_format' ); | |
| 1109 | - if ( ! $homepage_format || $homepage_format !== $data['homepageFormat'] ) { | |
| 1110 | - if ( 'page' === $data['homepageFormat'] ) { | |
| 1111 | - if ( ! ( | |
| 1112 | - update_option( 'show_on_front', 'page' ) | |
| 1113 | - || get_option( 'show_on_front' ) === 'page' | |
| 1114 | - ) ) { | |
| 1115 | - $error[] = 'homepageFormat'; | |
| 1116 | - } | |
| 1117 | - | |
| 1118 | - $home = wp_insert_post( | |
| 1119 | - array( | |
| 1120 | - 'post_type' => 'page', | |
| 1121 | - /* translators: this references the home page of a site, also called front page. */ | |
| 1122 | - 'post_title' => esc_html_x( 'Home Page', 'The home page of a website.', 'jetpack' ), | |
| 1123 | - 'post_content' => sprintf( | |
| 1124 | - /* Translators: placeholder is the site title. */ | |
| 1125 | - esc_html__( 'Welcome to %s.', 'jetpack' ), | |
| 1126 | - $site_title | |
| 1127 | - ), | |
| 1128 | - 'post_status' => 'publish', | |
| 1129 | - 'post_author' => $author, | |
| 1130 | - ) | |
| 1131 | - ); | |
| 1132 | - if ( 0 === $home ) { | |
| 1133 | - $error[] = 'home insert: 0'; | |
| 1134 | - } elseif ( is_wp_error( $home ) ) { | |
| 1135 | - $error[] = 'home creation: ' . $home->get_error_message(); | |
| 1136 | - } | |
| 1137 | - if ( ! ( | |
| 1138 | - update_option( 'page_on_front', $home ) | |
| 1139 | - || get_option( 'page_on_front' ) === $home | |
| 1140 | - ) ) { | |
| 1141 | - | |
| 1142 | - $error[] = 'home set'; | |
| 1143 | - } | |
| 1144 | - | |
| 1145 | - $blog = wp_insert_post( | |
| 1146 | - array( | |
| 1147 | - 'post_type' => 'page', | |
| 1148 | - /* translators: this references the page where blog posts are listed. */ | |
| 1149 | - 'post_title' => esc_html_x( 'Blog', 'The blog of a website.', 'jetpack' ), | |
| 1150 | - 'post_content' => sprintf( | |
| 1151 | - /* Translators: placeholder is the site title. */ | |
| 1152 | - esc_html__( 'These are the latest posts in %s.', 'jetpack' ), | |
| 1153 | - $site_title | |
| 1154 | - ), | |
| 1155 | - 'post_status' => 'publish', | |
| 1156 | - 'post_author' => $author, | |
| 1157 | - ) | |
| 1158 | - ); | |
| 1159 | - if ( 0 === $blog ) { | |
| 1160 | - $error[] = 'blog insert: 0'; | |
| 1161 | - } elseif ( is_wp_error( $blog ) ) { | |
| 1162 | - $error[] = 'blog creation: ' . $blog->get_error_message(); | |
| 1163 | - } | |
| 1164 | - if ( ! ( | |
| 1165 | - update_option( 'page_for_posts', $blog ) | |
| 1166 | - || get_option( 'page_for_posts' ) === $blog | |
| 1167 | - ) ) { | |
| 1168 | - $error[] = 'blog set'; | |
| 1169 | - } | |
| 1170 | - } else { | |
| 1171 | - $front_page = get_option( 'page_on_front' ); | |
| 1172 | - $posts_page = get_option( 'page_for_posts' ); | |
| 1173 | - if ( $posts_page && get_post( $posts_page ) ) { | |
| 1174 | - wp_delete_post( $posts_page ); | |
| 1175 | - } | |
| 1176 | - if ( $front_page && get_post( $front_page ) ) { | |
| 1177 | - wp_delete_post( $front_page ); | |
| 1178 | - } | |
| 1179 | - update_option( 'show_on_front', 'posts' ); | |
| 1180 | - } | |
| 1181 | - } | |
| 1182 | - update_option( 'jpo_homepage_format', $data['homepageFormat'] ); | |
| 1183 | - } | |
| 1184 | - | |
| 1185 | - // Setup contact page and add a form and/or business info. | |
| 1186 | - $contact_page = ''; | |
| 1187 | - if ( ! empty( $data['addContactForm'] ) && ! get_option( 'jpo_contact_page' ) ) { | |
| 1188 | - $contact_form_module_active = Jetpack::is_module_active( 'contact-form' ); | |
| 1189 | - if ( ! $contact_form_module_active ) { | |
| 1190 | - $contact_form_module_active = Jetpack::activate_module( 'contact-form', false, false ); | |
| 1191 | - } | |
| 1192 | - | |
| 1193 | - if ( $contact_form_module_active ) { | |
| 1194 | - $contact_page = '[contact-form][contact-field label="' . esc_html__( 'Name', 'jetpack' ) . '" type="name" required="true" /][contact-field label="' . esc_html__( 'Email', 'jetpack' ) . '" type="email" required="true" /][contact-field label="' . esc_html__( 'Website', 'jetpack' ) . '" type="url" /][contact-field label="' . esc_html__( 'Message', 'jetpack' ) . '" type="textarea" /][/contact-form]'; | |
| 1195 | - } else { | |
| 1196 | - $error[] = 'contact-form activate'; | |
| 1197 | - } | |
| 1198 | - } | |
| 1199 | - | |
| 1200 | - if ( isset( $data['businessPersonal'] ) && 'business' === $data['businessPersonal'] ) { | |
| 1201 | - $contact_page .= "\n" . implode( "\n", $data['businessInfo'] ); | |
| 1202 | - } | |
| 1203 | - | |
| 1204 | - if ( ! empty( $contact_page ) ) { | |
| 1205 | - $form = wp_insert_post( | |
| 1206 | - array( | |
| 1207 | - 'post_type' => 'page', | |
| 1208 | - /* translators: this references a page with contact details and possibly a form. */ | |
| 1209 | - 'post_title' => esc_html_x( 'Contact us', 'Contact page for your website.', 'jetpack' ), | |
| 1210 | - 'post_content' => esc_html__( 'Send us a message!', 'jetpack' ) . "\n" . $contact_page, | |
| 1211 | - 'post_status' => 'publish', | |
| 1212 | - 'post_author' => $author, | |
| 1213 | - ) | |
| 1214 | - ); | |
| 1215 | - if ( 0 === $form ) { | |
| 1216 | - $error[] = 'form insert: 0'; | |
| 1217 | - } elseif ( is_wp_error( $form ) ) { | |
| 1218 | - $error[] = 'form creation: ' . $form->get_error_message(); | |
| 1219 | - } else { | |
| 1220 | - update_option( 'jpo_contact_page', $form ); | |
| 1221 | - } | |
| 1222 | - } | |
| 1223 | - | |
| 1224 | - if ( isset( $data['businessAddress'] ) ) { | |
| 1225 | - $handled_business_address = self::handle_business_address( $data['businessAddress'] ); | |
| 1226 | - if ( is_wp_error( $handled_business_address ) ) { | |
| 1227 | - $error[] = 'BusinessAddress'; | |
| 1228 | - } | |
| 1229 | - } | |
| 1230 | - | |
| 1231 | - if ( ! empty( $data['installWooCommerce'] ) ) { | |
| 1232 | - $wc_install_result = Plugins_Installer::install_and_activate_plugin( 'woocommerce' ); | |
| 1233 | - delete_transient( '_wc_activation_redirect' ); // Redirecting to WC setup would kill our users' flow. | |
| 1234 | - if ( is_wp_error( $wc_install_result ) ) { | |
| 1235 | - $error[] = 'woocommerce installation'; | |
| 1236 | - } | |
| 1237 | - } | |
| 1238 | - | |
| 1239 | - if ( ! empty( $data['stats'] ) ) { | |
| 1240 | - if ( Jetpack::is_connection_ready() ) { | |
| 1241 | - $stats_module_active = Jetpack::is_module_active( 'stats' ); | |
| 1242 | - if ( ! $stats_module_active ) { | |
| 1243 | - $stats_module_active = Jetpack::activate_module( 'stats', false, false ); | |
| 1244 | - } | |
| 1245 | - | |
| 1246 | - if ( ! $stats_module_active ) { | |
| 1247 | - $error[] = 'stats activate'; | |
| 1248 | - } | |
| 1249 | - } else { | |
| 1250 | - $error[] = 'stats not connected'; | |
| 1251 | - } | |
| 1252 | - } | |
| 1253 | - | |
| 1254 | - return empty( $error ) | |
| 1255 | - ? '' | |
| 1256 | - : implode( ', ', $error ); | |
| 1208 | + private function process_onboarding( $data ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable | |
| 1209 | + _deprecated_function( __METHOD__, '13.9' ); | |
| 1210 | + return ''; | |
| 1257 | 1211 | } |
| 1258 | 1212 | |
| 1259 | 1213 | /** |
| 1260 | 1214 | * Add or update Business Address widget. |
| 1261 | 1215 | * |
| 1216 | + * @deprecated since 13.9 | |
| 1217 | + * | |
| 1262 | 1218 | * @param array $address Array of business address fields. |
| 1263 | 1219 | * |
| 1264 | 1220 | * @return WP_Error|true True if the data was saved correctly. |
| 1265 | 1221 | */ |
| 1266 | 1222 | private static function handle_business_address( $address ) { |
| 1223 | + _deprecated_function( __METHOD__, '13.9' ); | |
| 1267 | 1224 | $first_sidebar = Jetpack_Widgets::get_first_sidebar(); |
| 1268 | 1225 | |
| 1269 | 1226 | $widgets_module_active = Jetpack::is_module_active( 'widgets' ); |
| 1270 | 1227 | if ( ! $widgets_module_active ) { |
| @@ -1331,9 +1288,9 @@ | ||
| 1331 | 1288 | if ( ! isset( $sidebars_widgets[ $sidebar ] ) ) { |
| 1332 | 1289 | return false; |
| 1333 | 1290 | } |
| 1334 | 1291 | foreach ( $sidebars_widgets[ $sidebar ] as $widget ) { |
| 1335 | - if ( strpos( $widget, 'widget_contact_info' ) !== false ) { | |
| 1292 | + if ( str_contains( $widget, 'widget_contact_info' ) ) { | |
| 1336 | 1293 | return true; |
| 1337 | 1294 | } |
| 1338 | 1295 | } |
| 1339 | 1296 | return false; |
| @@ -1348,13 +1305,8 @@ | ||
| 1348 | 1305 | * |
| 1349 | 1306 | * @return bool |
| 1350 | 1307 | */ |
| 1351 | 1308 | public function can_request( $request ) { |
| 1352 | - $req_params = $request->get_params(); | |
| 1353 | - if ( ! empty( $req_params['onboarding']['token'] ) && isset( $req_params['rest_route'] ) ) { | |
| 1354 | - return Jetpack::validate_onboarding_token_action( $req_params['onboarding']['token'], $req_params['rest_route'] ); | |
| 1355 | - } | |
| 1356 | - | |
| 1357 | 1309 | if ( 'GET' === $request->get_method() ) { |
| 1358 | 1310 | return current_user_can( 'jetpack_admin_page' ); |
| 1359 | 1311 | } else { |
| 1360 | 1312 | $module = Jetpack_Core_Json_Api_Endpoints::get_module_requested(); |
| @@ -1363,13 +1315,13 @@ | ||
| 1363 | 1315 | if ( ! is_array( $params ) ) { |
| 1364 | 1316 | $params = $request->get_body_params(); |
| 1365 | 1317 | } |
| 1366 | 1318 | $options = Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list( $params ); |
| 1367 | - foreach ( $options as $option => $definition ) { | |
| 1368 | - if ( in_array( $options[ $option ]['jp_group'], array( 'post-by-email' ), true ) ) { | |
| 1369 | - $module = $options[ $option ]['jp_group']; | |
| 1370 | - break; | |
| 1371 | - } | |
| 1319 | + | |
| 1320 | + // The Post by Email gate applies only when the request contains nothing else. | |
| 1321 | + $groups = array_values( array_unique( array_column( $options, 'jp_group' ) ) ); | |
| 1322 | + if ( array( 'post-by-email' ) === $groups ) { | |
| 1323 | + $module = 'post-by-email'; | |
| 1372 | 1324 | } |
| 1373 | 1325 | } |
| 1374 | 1326 | // User is trying to create, regenerate or delete its PbE. |
| 1375 | 1327 | if ( 'post-by-email' === $module ) { |
| @@ -1385,9 +1337,8 @@ | ||
| 1385 | 1337 | * |
| 1386 | 1338 | * phpcs:disable Generic.Files.OneObjectStructurePerFile.MultipleFound |
| 1387 | 1339 | */ |
| 1388 | 1340 | class Jetpack_Core_API_Module_Data_Endpoint { |
| 1389 | - // phpcs:disable Generic.Files.OneObjectStructurePerFile.MultipleFound | |
| 1390 | 1341 | |
| 1391 | 1342 | /** |
| 1392 | 1343 | * Process request and return different data based on the module we are interested in. |
| 1393 | 1344 | * |
| @@ -1576,32 +1527,26 @@ | ||
| 1576 | 1527 | ) { |
| 1577 | 1528 | $range = 'day'; |
| 1578 | 1529 | } |
| 1579 | 1530 | |
| 1580 | - if ( ! function_exists( 'convert_stats_array_to_object' ) ) { | |
| 1581 | - require_once JETPACK__PLUGIN_DIR . 'modules/stats.php'; | |
| 1582 | - } | |
| 1583 | - | |
| 1584 | 1531 | $wpcom_stats = new WPCOM_Stats(); |
| 1585 | 1532 | switch ( $range ) { |
| 1586 | 1533 | |
| 1587 | 1534 | // This is always called first on page load. |
| 1588 | 1535 | case 'day': |
| 1589 | - $initial_stats = convert_stats_array_to_object( $wpcom_stats->get_stats() ); | |
| 1536 | + $initial_stats = $wpcom_stats->convert_stats_array_to_object( $wpcom_stats->get_stats() ); | |
| 1590 | 1537 | return rest_ensure_response( |
| 1591 | 1538 | array( |
| 1592 | 1539 | 'general' => $initial_stats, |
| 1593 | 1540 | |
| 1594 | 1541 | // Build data for 'day' as if it was $wpcom_stats ->get_visits( array( 'unit' => 'day, 'quantity' => 30). |
| 1595 | - 'day' => isset( $initial_stats->visits ) | |
| 1596 | - ? $initial_stats->visits | |
| 1597 | - : array(), | |
| 1542 | + 'day' => $initial_stats->visits ?? array(), | |
| 1598 | 1543 | ) |
| 1599 | 1544 | ); |
| 1600 | 1545 | case 'week': |
| 1601 | 1546 | return rest_ensure_response( |
| 1602 | 1547 | array( |
| 1603 | - 'week' => convert_stats_array_to_object( | |
| 1548 | + 'week' => $wpcom_stats->convert_stats_array_to_object( | |
| 1604 | 1549 | $wpcom_stats->get_visits( |
| 1605 | 1550 | array( |
| 1606 | 1551 | 'unit' => 'week', |
| 1607 | 1552 | 'quantity' => 14, |
| @@ -1612,9 +1557,9 @@ | ||
| 1612 | 1557 | ); |
| 1613 | 1558 | case 'month': |
| 1614 | 1559 | return rest_ensure_response( |
| 1615 | 1560 | array( |
| 1616 | - 'month' => convert_stats_array_to_object( | |
| 1561 | + 'month' => $wpcom_stats->convert_stats_array_to_object( | |
| 1617 | 1562 | $wpcom_stats->get_visits( |
| 1618 | 1563 | array( |
| 1619 | 1564 | 'unit' => 'month', |
| 1620 | 1565 | 'quantity' => 12, |
| @@ -1736,9 +1681,9 @@ | ||
| 1736 | 1681 | $last_service = $copy_services[ $last ]; |
| 1737 | 1682 | unset( $copy_services[ $last ] ); |
| 1738 | 1683 | $message = esc_html( |
| 1739 | 1684 | sprintf( |
| 1740 | - /* translators: %1$s is a comma separated list of services, and %2$s is a single service name like Google, Bing, Pinterest, etc. */ | |
| 1685 | + /* translators: %1$s is a comma-separated list of services, and %2$s is a single service name like Google, Bing, Pinterest, etc. */ | |
| 1741 | 1686 | __( 'Your site is verified with %1$s and %2$s.', 'jetpack' ), |
| 1742 | 1687 | implode( ', ', $copy_services ), |
| 1743 | 1688 | $last_service |
| 1744 | 1689 | ) |