diff options
Diffstat (limited to 'plugins/jetpack/sync/class.jetpack-sync-defaults.php')
| -rw-r--r-- | plugins/jetpack/sync/class.jetpack-sync-defaults.php | 637 |
1 files changed, 637 insertions, 0 deletions
diff --git a/plugins/jetpack/sync/class.jetpack-sync-defaults.php b/plugins/jetpack/sync/class.jetpack-sync-defaults.php new file mode 100644 index 00000000..787145c8 --- /dev/null +++ b/plugins/jetpack/sync/class.jetpack-sync-defaults.php @@ -0,0 +1,637 @@ +<?php +require_once JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php'; + +/** + * Just some defaults that we share with the server + */ +class Jetpack_Sync_Defaults { + + static $default_options_whitelist = array( + 'stylesheet', + 'blogname', + 'blogdescription', + 'blog_charset', + 'permalink_structure', + 'category_base', + 'tag_base', + 'sidebars_widgets', + 'comment_moderation', + 'default_comment_status', + 'page_on_front', + 'rss_use_excerpt', + 'subscription_options', + 'stb_enabled', + 'stc_enabled', + 'comment_registration', + 'show_avatars', + 'avatar_default', + 'avatar_rating', + 'highlander_comment_form_prompt', + 'jetpack_comment_form_color_scheme', + 'stats_options', + 'gmt_offset', + 'timezone_string', + 'jetpack_sync_non_public_post_stati', + 'jetpack_options', + 'site_icon', // (int) - ID of core's Site Icon attachment ID + 'default_post_format', + 'default_category', + 'large_size_w', + 'large_size_h', + 'thumbnail_size_w', + 'thumbnail_size_h', + 'medium_size_w', + 'medium_size_h', + 'thumbnail_crop', + 'image_default_link_type', + 'site_logo', + 'sharing-options', + 'sharing-services', + 'post_count', + 'default_ping_status', + 'sticky_posts', + 'blog_public', + 'default_pingback_flag', + 'require_name_email', + 'close_comments_for_old_posts', + 'close_comments_days_old', + 'thread_comments', + 'thread_comments_depth', + 'page_comments', + 'comments_per_page', + 'default_comments_page', + 'comment_order', + 'comments_notify', + 'moderation_notify', + 'social_notifications_like', + 'social_notifications_reblog', + 'social_notifications_subscribe', + 'comment_whitelist', + 'comment_max_links', + 'moderation_keys', + 'jetpack_wga', + 'disabled_likes', + 'disabled_reblogs', + 'jetpack_comment_likes_enabled', + 'twitter_via', + 'jetpack-memberships-connected-account-id', + 'jetpack-twitter-cards-site-tag', + 'wpcom_publish_posts_with_markdown', + 'wpcom_publish_comments_with_markdown', + 'jetpack_activated', + 'jetpack_available_modules', + 'jetpack_autoupdate_plugins', + 'jetpack_autoupdate_plugins_translations', + 'jetpack_autoupdate_themes', + 'jetpack_autoupdate_themes_translations', + 'jetpack_autoupdate_core', + 'jetpack_autoupdate_translations', + 'carousel_background_color', + 'carousel_display_exif', + 'jetpack_portfolio', + 'jetpack_portfolio_posts_per_page', + 'jetpack_testimonial', + 'jetpack_testimonial_posts_per_page', + 'tiled_galleries', + 'gravatar_disable_hovercards', + 'infinite_scroll', + 'infinite_scroll_google_analytics', + 'wp_mobile_excerpt', + 'wp_mobile_featured_images', + 'wp_mobile_app_promos', + 'monitor_receive_notifications', + 'post_by_email_address', + 'jetpack_mailchimp', + 'jetpack_protect_key', + 'jetpack_protect_global_whitelist', + 'jetpack_sso_require_two_step', + 'jetpack_sso_match_by_email', + 'jetpack_relatedposts', + 'verification_services_codes', + 'users_can_register', + 'active_plugins', + 'uninstall_plugins', + 'advanced_seo_front_page_description', // Jetpack_SEO_Utils::FRONT_PAGE_META_OPTION + 'advanced_seo_title_formats', // Jetpack_SEO_Titles::TITLE_FORMATS_OPTION + 'jetpack_api_cache_enabled', + 'start_of_week', + 'blacklist_keys', + 'posts_per_page', + 'posts_per_rss', + 'show_on_front', + 'ping_sites', + 'uploads_use_yearmonth_folders', + 'date_format', + 'time_format', + 'admin_email', + 'new_admin_email', + 'default_email_category', + 'default_role', + 'page_for_posts', + 'mailserver_url', + 'mailserver_login', // Not syncing contents, only the option name + 'mailserver_pass', // Not syncing contents, only the option name + 'mailserver_port', + 'wp_page_for_privacy_policy', + 'enable_header_ad', + 'wordads_second_belowpost', + 'wordads_display_front_page', + 'wordads_display_post', + 'wordads_display_page', + 'wordads_display_archive', + 'wordads_custom_adstxt', + 'site_segment', + 'site_user_type', + 'site_vertical', + 'jetpack_excluded_extensions', + ); + + public static function get_options_whitelist() { + /** This filter is already documented in json-endpoints/jetpack/class.wpcom-json-api-get-option-endpoint.php */ + $options_whitelist = apply_filters( 'jetpack_options_whitelist', self::$default_options_whitelist ); + /** + * Filter the list of WordPress options that are manageable via the JSON API. + * + * @module sync + * + * @since 4.8.0 + * + * @param array The default list of options. + */ + return apply_filters( 'jetpack_sync_options_whitelist', $options_whitelist ); + } + + // Do not sync contents for these events, only the option name + static $default_options_contentless = array( + 'mailserver_login', + 'mailserver_pass', + ); + + public static function get_options_contentless() { + /** + * Filter the list of WordPress options that should be synced without content + * + * @module sync + * + * @since 6.1.0 + * + * @param array The list of options synced without content. + */ + return apply_filters( 'jetpack_sync_options_contentless', self::$default_options_contentless ); + } + + static $default_constants_whitelist = array( + 'EMPTY_TRASH_DAYS', + 'WP_POST_REVISIONS', + 'AUTOMATIC_UPDATER_DISABLED', + 'ABSPATH', + 'WP_CONTENT_DIR', + 'FS_METHOD', + 'DISALLOW_FILE_EDIT', + 'DISALLOW_FILE_MODS', + 'WP_AUTO_UPDATE_CORE', + 'WP_HTTP_BLOCK_EXTERNAL', + 'WP_ACCESSIBLE_HOSTS', + 'JETPACK__VERSION', + 'IS_PRESSABLE', + 'DISABLE_WP_CRON', + 'ALTERNATE_WP_CRON', + 'WP_CRON_LOCK_TIMEOUT', + 'PHP_VERSION', + 'WP_MEMORY_LIMIT', + 'WP_MAX_MEMORY_LIMIT', + ); + + public static function get_constants_whitelist() { + /** + * Filter the list of PHP constants that are manageable via the JSON API. + * + * @module sync + * + * @since 4.8.0 + * + * @param array The default list of constants options. + */ + return apply_filters( 'jetpack_sync_constants_whitelist', self::$default_constants_whitelist ); + } + + static $default_callable_whitelist = array( + 'wp_max_upload_size' => 'wp_max_upload_size', + 'is_main_network' => array( 'Jetpack', 'is_multi_network' ), + 'is_multi_site' => 'is_multisite', + 'main_network_site' => array( 'Jetpack_Sync_Functions', 'main_network_site_url' ), + 'site_url' => array( 'Jetpack_Sync_Functions', 'site_url' ), + 'home_url' => array( 'Jetpack_Sync_Functions', 'home_url' ), + 'single_user_site' => array( 'Jetpack', 'is_single_user_site' ), + 'updates' => array( 'Jetpack', 'get_updates' ), + 'has_file_system_write_access' => array( 'Jetpack_Sync_Functions', 'file_system_write_access' ), + 'is_version_controlled' => array( 'Jetpack_Sync_Functions', 'is_version_controlled' ), + 'taxonomies' => array( 'Jetpack_Sync_Functions', 'get_taxonomies' ), + 'post_types' => array( 'Jetpack_Sync_Functions', 'get_post_types' ), + 'post_type_features' => array( 'Jetpack_Sync_Functions', 'get_post_type_features' ), + 'shortcodes' => array( 'Jetpack_Sync_Functions', 'get_shortcodes' ), + 'rest_api_allowed_post_types' => array( 'Jetpack_Sync_Functions', 'rest_api_allowed_post_types' ), + 'rest_api_allowed_public_metadata' => array( 'Jetpack_Sync_Functions', 'rest_api_allowed_public_metadata' ), + 'sso_is_two_step_required' => array( 'Jetpack_SSO_Helpers', 'is_two_step_required' ), + 'sso_should_hide_login_form' => array( 'Jetpack_SSO_Helpers', 'should_hide_login_form' ), + 'sso_match_by_email' => array( 'Jetpack_SSO_Helpers', 'match_by_email' ), + 'sso_new_user_override' => array( 'Jetpack_SSO_Helpers', 'new_user_override' ), + 'sso_bypass_default_login_form' => array( 'Jetpack_SSO_Helpers', 'bypass_login_forward_wpcom' ), + 'wp_version' => array( 'Jetpack_Sync_Functions', 'wp_version' ), + 'get_plugins' => array( 'Jetpack_Sync_Functions', 'get_plugins' ), + 'get_plugins_action_links' => array( 'Jetpack_Sync_functions', 'get_plugins_action_links' ), + 'active_modules' => array( 'Jetpack', 'get_active_modules' ), + 'hosting_provider' => array( 'Jetpack_Sync_Functions', 'get_hosting_provider' ), + 'locale' => 'get_locale', + 'site_icon_url' => array( 'Jetpack_Sync_Functions', 'site_icon_url' ), + 'roles' => array( 'Jetpack_Sync_Functions', 'roles' ), + 'timezone' => array( 'Jetpack_Sync_Functions', 'get_timezone' ), + 'available_jetpack_blocks' => array( 'Jetpack_Gutenberg', 'get_availability' ), // Includes both Gutenberg blocks *and* plugins + 'paused_themes' => array( 'Jetpack_Sync_Functions', 'get_paused_themes' ), + 'paused_plugins' => array( 'Jetpack_Sync_Functions', 'get_paused_plugins' ), + ); + + + static $default_post_type_attributes = array( + 'name' => '', + 'label' => '', + 'labels' => array(), + 'description' => '', + 'public' => false, + 'hierarchical' => false, + 'exclude_from_search' => true, + 'publicly_queryable' => null, + 'show_ui' => false, + 'show_in_menu' => null, + 'show_in_nav_menus' => null, + 'show_in_admin_bar' => false, + 'menu_position' => null, + 'menu_icon' => null, + 'supports' => array(), + 'capability_type' => 'post', + 'capabilities' => array(), + 'cap' => array(), + 'map_meta_cap' => true, + 'taxonomies' => array(), + 'has_archive' => false, + 'rewrite' => true, + 'query_var' => true, + 'can_export' => true, + 'delete_with_user' => null, + 'show_in_rest' => false, + 'rest_base' => false, + '_builtin' => false, + '_edit_link' => 'post.php?post=%d', + ); + + public static function get_callable_whitelist() { + /** + * Filter the list of callables that are manageable via the JSON API. + * + * @module sync + * + * @since 4.8.0 + * + * @param array The default list of callables. + */ + return apply_filters( 'jetpack_sync_callable_whitelist', self::$default_callable_whitelist ); + } + + static $blacklisted_post_types = array( + 'ai1ec_event', + 'bwg_album', + 'bwg_gallery', + 'customize_changeset', // WP built-in post type for Customizer changesets + 'dn_wp_yt_log', + 'http', + 'idx_page', + 'jetpack_migration', + 'postman_sent_mail', + 'rssap-feed', + 'rssmi_feed_item', + 'secupress_log_action', + 'sg_optimizer_jobs', + 'snitch', + 'wpephpcompat_jobs', + 'wprss_feed_item', + 'wp_automatic', + 'jp_sitemap_master', + 'jp_sitemap', + 'jp_sitemap_index', + 'jp_img_sitemap', + 'jp_img_sitemap_index', + 'jp_vid_sitemap', + 'jp_vid_sitemap_index', + 'vip-legacy-redirect', + ); + + static $default_post_checksum_columns = array( + 'ID', + 'post_modified', + ); + + static $default_post_meta_checksum_columns = array( + 'meta_id', + 'meta_value', + ); + + static $default_comment_checksum_columns = array( + 'comment_ID', + 'comment_content', + ); + + static $default_comment_meta_checksum_columns = array( + 'meta_id', + 'meta_value', + ); + + static $default_option_checksum_columns = array( + 'option_name', + 'option_value', + ); + + static $default_multisite_callable_whitelist = array( + 'network_name' => array( 'Jetpack', 'network_name' ), + 'network_allow_new_registrations' => array( 'Jetpack', 'network_allow_new_registrations' ), + 'network_add_new_users' => array( 'Jetpack', 'network_add_new_users' ), + 'network_site_upload_space' => array( 'Jetpack', 'network_site_upload_space' ), + 'network_upload_file_types' => array( 'Jetpack', 'network_upload_file_types' ), + 'network_enable_administration_menus' => array( 'Jetpack', 'network_enable_administration_menus' ), + ); + + public static function get_multisite_callable_whitelist() { + /** + * Filter the list of multisite callables that are manageable via the JSON API. + * + * @module sync + * + * @since 4.8.0 + * + * @param array The default list of multisite callables. + */ + return apply_filters( 'jetpack_sync_multisite_callable_whitelist', self::$default_multisite_callable_whitelist ); + } + + static $post_meta_whitelist = array( + '_feedback_akismet_values', + '_feedback_email', + '_feedback_extra_fields', + '_g_feedback_shortcode', + '_jetpack_post_thumbnail', + '_menu_item_classes', + '_menu_item_menu_item_parent', + '_menu_item_object', + '_menu_item_object_id', + '_menu_item_orphaned', + '_menu_item_type', + '_menu_item_xfn', + '_publicize_facebook_user', + '_publicize_twitter_user', + '_thumbnail_id', + '_wp_attached_file', + '_wp_attachment_backup_sizes', + '_wp_attachment_context', + '_wp_attachment_image_alt', + '_wp_attachment_is_custom_background', + '_wp_attachment_is_custom_header', + '_wp_attachment_metadata', + '_wp_page_template', + '_wp_trash_meta_comments_status', + '_wpas_mess', + 'content_width', + 'custom_css_add', + 'custom_css_preprocessor', + 'enclosure', + 'imagedata', + 'nova_price', + 'publicize_results', + 'sharing_disabled', + 'switch_like_status', + 'videopress_guid', + 'vimeo_poster_image', + 'advanced_seo_description', // Jetpack_SEO_Posts::DESCRIPTION_META_KEY + ); + + public static function get_post_meta_whitelist() { + /** + * Filter the list of post meta data that are manageable via the JSON API. + * + * @module sync + * + * @since 4.8.0 + * + * @param array The default list of meta data keys. + */ + return apply_filters( 'jetpack_sync_post_meta_whitelist', self::$post_meta_whitelist ); + } + + static $comment_meta_whitelist = array( + 'hc_avatar', + 'hc_post_as', + 'hc_wpcom_id_sig', + 'hc_foreign_user_id', + ); + + public static function get_comment_meta_whitelist() { + /** + * Filter the list of comment meta data that are manageable via the JSON API. + * + * @module sync + * + * @since 5.7.0 + * + * @param array The default list of comment meta data keys. + */ + return apply_filters( 'jetpack_sync_comment_meta_whitelist', self::$comment_meta_whitelist ); + } + + // TODO: move this to server? - these are theme support values + // that should be synced as jetpack_current_theme_supports_foo option values + static $default_theme_support_whitelist = array( + 'post-thumbnails', + 'post-formats', + 'custom-header', + 'custom-background', + 'custom-logo', + 'menus', + 'automatic-feed-links', + 'editor-style', + 'widgets', + 'html5', + 'title-tag', + 'jetpack-social-menu', + 'jetpack-responsive-videos', + 'infinite-scroll', + 'site-logo', + ); + + static function is_whitelisted_option( $option ) { + $whitelisted_options = self::get_options_whitelist(); + foreach ( $whitelisted_options as $whitelisted_option ) { + if ( $whitelisted_option[0] === '/' && preg_match( $whitelisted_option, $option ) ) { + return true; + } elseif ( $whitelisted_option === $option ) { + return true; + } + } + + return false; + } + + static $default_capabilities_whitelist = array( + 'switch_themes', + 'edit_themes', + 'edit_theme_options', + 'install_themes', + 'activate_plugins', + 'edit_plugins', + 'install_plugins', + 'edit_users', + 'edit_files', + 'manage_options', + 'moderate_comments', + 'manage_categories', + 'manage_links', + 'upload_files', + 'import', + 'unfiltered_html', + 'edit_posts', + 'edit_others_posts', + 'edit_published_posts', + 'publish_posts', + 'edit_pages', + 'read', + 'publish_pages', + 'edit_others_pages', + 'edit_published_pages', + 'delete_pages', + 'delete_others_pages', + 'delete_published_pages', + 'delete_posts', + 'delete_others_posts', + 'delete_published_posts', + 'delete_private_posts', + 'edit_private_posts', + 'read_private_posts', + 'delete_private_pages', + 'edit_private_pages', + 'read_private_pages', + 'delete_users', + 'create_users', + 'unfiltered_upload', + 'edit_dashboard', + 'customize', + 'delete_site', + 'update_plugins', + 'delete_plugins', + 'update_themes', + 'update_core', + 'list_users', + 'remove_users', + 'add_users', + 'promote_users', + 'delete_themes', + 'export', + 'edit_comment', + 'upload_plugins', + 'upload_themes', + ); + + public static function get_capabilities_whitelist() { + /** + * Filter the list of capabilities that we care about + * + * @module sync + * + * @since 5.5.0 + * + * @param array The default list of capabilities. + */ + return apply_filters( 'jetpack_sync_capabilities_whitelist', self::$default_capabilities_whitelist ); + } + + static function get_max_sync_execution_time() { + $max_exec_time = intval( ini_get( 'max_execution_time' ) ); + if ( 0 === $max_exec_time ) { + // 0 actually means "unlimited", but let's not treat it that way + $max_exec_time = 60; + } + return floor( $max_exec_time / 3 ); + } + + static function get_default_setting( $setting ) { + $default_name = "default_$setting"; // e.g. default_dequeue_max_bytes + return Jetpack_Sync_Defaults::$$default_name; + } + + static $default_network_options_whitelist = array( + 'site_name', + 'jetpack_protect_key', + 'jetpack_protect_global_whitelist', + 'active_sitewide_plugins', + ); + + /** + * A mapping of known importers to friendly names. + * + * Keys are the class name of the known importer. + * Values are the friendly name. + * + * @since 7.3.0 + * + * @var array + */ + public static $default_known_importers = array( + 'Blogger_Importer' => 'blogger', + 'LJ_API_Import' => 'livejournal', + 'MT_Import' => 'mt', + 'RSS_Import' => 'rss', + 'WC_Tax_Rate_Importer' => 'woo-tax-rate', + 'WP_Import' => 'wordpress', + ); + + /** + * Returns a list of known importers. + * + * @since 7.3.0 + * + * @return array Known importers with importer class names as keys and friendly names as values. + */ + public static function get_known_importers() { + /** + * Filter the list of known importers. + * + * @module sync + * + * @since 7.3.0 + * + * @param array The default list of known importers. + */ + return apply_filters( 'jetpack_sync_known_importers', self::$default_known_importers ); + } + + static $default_taxonomy_whitelist = array(); + static $default_dequeue_max_bytes = 500000; // very conservative value, 1/2 MB + static $default_upload_max_bytes = 600000; // a little bigger than the upload limit to account for serialization + static $default_upload_max_rows = 500; + static $default_sync_wait_time = 10; // seconds, between syncs + static $default_sync_wait_threshold = 5; // only wait before next send if the current send took more than X seconds + static $default_enqueue_wait_time = 10; // wait between attempting to continue a full sync, via requests + static $default_max_queue_size = 1000; + static $default_max_queue_lag = 900; // 15 minutes + static $default_queue_max_writes_sec = 100; // 100 rows a second + static $default_post_types_blacklist = array(); + static $default_post_meta_whitelist = array(); + static $default_comment_meta_whitelist = array(); + static $default_disable = 0; // completely disable sending data to wpcom + static $default_network_disable = 0; // completely disable sending data to wpcom network wide + static $default_sync_via_cron = 1; // use cron to sync + static $default_render_filtered_content = 0; // render post_filtered_content + static $default_max_enqueue_full_sync = 100; // max number of items to enqueue at a time when running full sync + static $default_max_queue_size_full_sync = 1000; // max number of total items in the full sync queue + static $default_sync_callables_wait_time = MINUTE_IN_SECONDS; // seconds before sending callables again + static $default_sync_constants_wait_time = HOUR_IN_SECONDS; // seconds before sending constants again + static $default_sync_queue_lock_timeout = 120; // 2 minutes + static $default_cron_sync_time_limit = 30; // 30 seconds + +} |