Jetpack_Sync_Defaults::match_option_key() - Code Metrics - Inspection of "Bring changes from wacom" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — update/sync-defaults-from-wpco... ( 8ac9eb )

unknown
created 2017-06-28 17:39 UTC
Jetpack_Sync_Defaults::match_option_key() B

↳ Parent: Jetpack_Sync_Defaults
Complexity

Conditions	5
Paths	4
Size

Total Lines	11
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	5
eloc	7
nc	4
nop	2
dl	0
loc	11
rs	8.8571
c	0
b	0
f	0
<?php

/**
 * Just some defaults that we share with the server
 */
class Jetpack_Sync_Defaults {

	static $default_options_whitelist = array(
class A {
    var $property;
}
		'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-twitter-cards-site-tag',
		'wpcom_publish_posts_with_markdown',
		'wpcom_publish_comments_with_markdown',
		'jetpack_activated',
		'jetpack_active_modules',
		'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_protect_key',
		'jetpack_protect_global_whitelist',
		'jetpack_sso_require_two_step',
		'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',
	);

	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
		 *
		 * @param array The default list of options.
		 */
		return apply_filters( 'jetpack_sync_options_whitelist', $options_whitelist );
	}

	/**
	 * These are options that don't need to go in the regular wp_options table.
	 * The reason we're putting them here is that all wp_options are pre-loaded to memory and we don't want to abuse that.
	 *
	 * @var array
	 */
	private static $options_whitelist_no_autoload = array(
		'woocommerce_currency'                              => 'string',
		'woocommerce_db_version'                            => 'string',
		'woocommerce_weight_unit'                           => 'string',
		'woocommerce_version'                               => 'string',
		'woocommerce_unforce_ssl_checkout'                  => 'string',
		'woocommerce_tax_total_display'                     => 'string',
		'woocommerce_tax_round_at_subtotal'                 => 'string',
		'woocommerce_tax_display_shop'                      => 'string',
		'woocommerce_tax_display_cart'                      => 'string',
		'woocommerce_prices_include_tax'                    => 'string',
		'woocommerce_price_thousand_sep'                    => 'string',
		'woocommerce_price_num_decimals'                    => 'string',
		'woocommerce_price_decimal_sep'                     => 'string',
		'woocommerce_notify_low_stock'                      => 'string',
		'woocommerce_notify_low_stock_amount'               => 'int',
		'woocommerce_notify_no_stock'                       => 'string',
		'woocommerce_notify_no_stock_amount'                => 'int',
		'woocommerce_manage_stock'                          => 'string',
		'woocommerce_force_ssl_checkout'                    => 'string',
		'woocommerce_hide_out_of_stock_items'               => 'string',
		'woocommerce_file_download_method'                  => 'string',
		'woocommerce_enable_signup_and_login_from_checkout' => 'string',
		'woocommerce_enable_shipping_calc'                  => 'string',
		'woocommerce_enable_review_rating'                  => 'string',
		'woocommerce_enable_guest_checkout'                 => 'string',
		'woocommerce_enable_coupons'                        => 'string',
		'woocommerce_enable_checkout_login_reminder'        => 'string',
		'woocommerce_enable_ajax_add_to_cart'               => 'string',
		'woocommerce_dimension_unit'                        => 'string',
		'woocommerce_default_country'                       => 'string',
		'woocommerce_default_customer_address'              => 'string',
		'woocommerce_currency_pos'                          => 'string',
		'woocommerce_api_enabled'                           => 'string',
		'woocommerce_allow_tracking'                        => 'string',
	);

	static $default_constants_whitelist = array(
class A {
    var $property;
}
		'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
		 *
		 * @param array The default list of constants options.
		 */
		return apply_filters( 'jetpack_sync_constants_whitelist', self::$default_constants_whitelist );
	}

	private static $constants_whitelist_no_autoload = array(
		'WC_PLUGIN_FILE'            => 'string',
		'WC_ABSPATH'                => 'string',
		'WC_PLUGIN_BASENAME'        => 'string',
		'WC_VERSION'                => 'string',
		'WOOCOMMERCE_VERSION'       => 'string',
		'WC_ROUNDING_PRECISION'     => 'int',
		'WC_DISCOUNT_ROUNDING_MODE' => 'int',
		'WC_TAX_ROUNDING_MODE'      => 'int',
		'WC_DELIMITER'              => 'string',
		'WC_LOG_DIR'                => 'string',
		'WC_SESSION_CACHE_GROUP'    => 'string',
		'WC_TEMPLATE_DEBUG_MODE'    => 'bool',
	);

	static $default_callable_whitelist = array(
class A {
    var $property;
}
		'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' ),
		'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' ),
	);

	public static function get_callable_whitelist() {
		/**
		 * Filter the list of callables that are manageable via the JSON API.
		 *
		 * @module sync
		 *
		 * @since 4.8
		 *
		 * @param array The default list of callables.
		 */
		return apply_filters( 'jetpack_sync_callable_whitelist', self::$default_callable_whitelist );
	}

	static $blacklisted_post_types = array(
class A {
    var $property;
}
		'ai1ec_event',
		'snitch',
		'secupress_log_action',
		'http',
		'bwg_gallery',
		'bwg_album',
		'idx_page',
		'postman_sent_mail',
		'rssmi_feed_item',
		'rssap-feed',
		'wp_automatic',
	);

	static $default_post_checksum_columns = array(
class A {
    var $property;
}
		'ID',
		'post_modified',
	);

	static $default_post_meta_checksum_columns = array(
class A {
    var $property;
}
		'meta_id',
		'meta_value',
	);

	static $default_comment_checksum_columns = array(
class A {
    var $property;
}
		'comment_ID',
		'comment_content',
	);

	static $default_comment_meta_checksum_columns = array(
class A {
    var $property;
}
		'meta_id',
		'meta_value',
	);

	static $default_option_checksum_columns = array(
class A {
    var $property;
}
		'option_name',
		'option_value',
	);

	// returns escapted SQL that can be injected into a WHERE clause
	static function get_blacklisted_post_types_sql() {
		return 'post_type NOT IN (\'' . join( '\', \'', array_map( 'esc_sql', self::$blacklisted_post_types ) ) . '\')';
	}

	static $default_multisite_callable_whitelist = array(
class A {
    var $property;
}
		'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
		 *
		 * @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(
class A {
    var $property;
}
		'_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',
		'advanced_seo_description', // Jetpack_SEO_Posts::DESCRIPTION_META_KEY
		'content_width',
		'custom_css_add',
		'custom_css_preprocessor',
		'enclosure',
		'imagedata',
		'nova_price',
		'publicize_results',
		'sharing_disabled',
		'switch_like_status',
		'videopress_guid',
		'vimeo_poster_image',

		//woocommerce products
		'_stock_status',
		'_visibility',
		'total_sales',
		'_downloadable',
		'_virtual',
		'_regular_price',
		'_sale_price',
		'_tax_status',
		'_tax_class',
		'_featured',
		'_price',
		'_stock',
		'_backorders',
		'_manage_stock',

		//woocommerce orders
		'_order_currency',
		'_prices_include_tax',
		'_created_via',
		'_billing_country',
		'_billing_city',
		'_billing_state',
		'_billing_postcode',
		'_shipping_country',
		'_shipping_city',
		'_shipping_state',
		'_shipping_postcode',
		'_payment_method',
		'_payment_method_title',
		'_order_shipping',
		'_cart_discount',
		'_cart_discount_tax',
		'_order_tax',
		'_order_shipping_tax',
		'_order_total',
		'_download_permissions_granted',
		'_recorded_sales',
		'_order_stock_reduced',
	);

	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
		 *
		 * @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(
class A {
    var $property;
}
		'hc_avatar',
		'hc_post_as',
		'hc_wpcom_id_sig',
		'hc_foreign_user_id'
	);

	// 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(
class A {
    var $property;
}
		'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 ) {
		return null !== self::match_option_key( $option, self::$default_options_whitelist );
	}

	/**
	 * Gets the sanitization type of the option.
	 * Null means the option is either not whitelisted at all or is an auto loaded options.
	 *
	 * @param $option string The option name
	 *
	 * @return mixed|null null of nothing found, the type otherwise
	 */
	public static function get_option_type( $option ) {
		$key = self::match_option_key( $option, array_keys( self::$options_whitelist_no_autoload ) );

		return null === $key ? null : self::$options_whitelist_no_autoload[ $key ];
	}

	private static function match_option_key( $option, $list ) {
		foreach ( $list as $whitelisted_option ) {
			if ( '/' === $whitelisted_option[0] && preg_match( $whitelisted_option, $option ) ) {
				return $whitelisted_option;
			} elseif ( $whitelisted_option === $option ) {
				return $whitelisted_option;
			}
		}

		return null;
	}

	/**
	 * Gets the sanitization type of the constant.
	 * Null means the option is either not whitelisted at all or is an auto loaded options.
	 *
	 * @param $name string name of the constant
	 *
	 * @return mixed|null
	 */
	public static function get_constant_type( $name ) {
		if ( isset( self::$constants_whitelist_no_autoload[ $name ] ) ) {
			return self::$constants_whitelist_no_autoload[ $name ];
		}

		return null;
	}

	static function is_whitelisted_post_meta_key( $meta_key ) {
		if ( in_array( $meta_key, self::get_post_meta_whitelist() ) ) {
			return true;
		}

		$blog_id = get_current_blog_id();
		if ( ! empty( $blog_id ) ) {
			return in_array( $blog_id, self::$allow_all_post_meta_blog_ids );
		}

		return false;
	}

	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 $default_network_options_whitelist = array(
class A {
    var $property;
}
		'site_name',
		'jetpack_protect_key',
		'jetpack_protect_global_whitelist',
		'active_sitewide_plugins',
	);

	static $default_taxonomy_whitelist = array();
class A {
    var $property;
}
	static $default_dequeue_max_bytes = 500000; // very conservative value, 1/2 MB
class A {
    var $property;
}
	static $default_upload_max_bytes = 600000; // a little bigger than the upload limit to account for serialization
class A {
    var $property;
}
	static $default_upload_max_rows = 500;
class A {
    var $property;
}
	static $default_sync_wait_time = 10; // seconds, between syncs
class A {
    var $property;
}
	static $default_sync_wait_threshold = 5; // only wait before next send if the current send took more than X seconds
class A {
    var $property;
}
	static $default_enqueue_wait_time = 10; // wait between attempting to continue a full sync, via requests
class A {
    var $property;
}
	static $default_max_queue_size = 1000;
class A {
    var $property;
}
	static $default_max_queue_lag = 900; // 15 minutes
class A {
    var $property;
}
	static $default_queue_max_writes_sec = 100; // 100 rows a second
class A {
    var $property;
}
	static $default_post_types_blacklist = array();
class A {
    var $property;
}
	static $default_post_meta_whitelist = array();
class A {
    var $property;
}
	static $default_comment_meta_whitelist = array();
class A {
    var $property;
}
	static $default_disable = 0; // completely disable sending data to wpcom
class A {
    var $property;
}
	static $default_sync_via_cron = 1; // use cron to sync
class A {
    var $property;
}
	static $default_render_filtered_content = 0; // render post_filtered_content
class A {
    var $property;
}
	static $default_max_enqueue_full_sync = 100; // max number of items to enqueue at a time when running full sync
class A {
    var $property;
}
	static $default_max_queue_size_full_sync = 1000; // max number of total items in the full sync queue
class A {
    var $property;
}
	static $default_sync_callables_wait_time = MINUTE_IN_SECONDS; // seconds before sending callables again
class A {
    var $property;
}
	static $default_sync_constants_wait_time = HOUR_IN_SECONDS; // seconds before sending constants again
class A {
    var $property;
}
	static $default_sync_queue_lock_timeout = 120; // 2 minutes
class A {
    var $property;
}
	static $default_cron_sync_time_limit = 30; // 30 seconds
class A {
    var $property;
}
}

1			<?php
2
3			/**
4			* Just some defaults that we share with the server
5			*/
6			class Jetpack_Sync_Defaults {
7
8			static $default_options_whitelist = array(
			0 ignored issues – show Coding Style introduced 2016-04-27 23:36 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$default_options_whitelist`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
9			'stylesheet',
10			'blogname',
11			'blogdescription',
12			'blog_charset',
13			'permalink_structure',
14			'category_base',
15			'tag_base',
16			'sidebars_widgets',
17			'comment_moderation',
18			'default_comment_status',
19			'page_on_front',
20			'rss_use_excerpt',
21			'subscription_options',
22			'stb_enabled',
23			'stc_enabled',
24			'comment_registration',
25			'show_avatars',
26			'avatar_default',
27			'avatar_rating',
28			'highlander_comment_form_prompt',
29			'jetpack_comment_form_color_scheme',
30			'stats_options',
31			'gmt_offset',
32			'timezone_string',
33			'jetpack_sync_non_public_post_stati',
34			'jetpack_options',
35			'site_icon', // (int) - ID of core's Site Icon attachment ID
36			'default_post_format',
37			'default_category',
38			'large_size_w',
39			'large_size_h',
Automattic / jetpack

Push — update/sync-defaults-from-wpco... ( 8ac9eb )

Jetpack_Sync_Defaults::match_option_key() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
