Functions::rest_api_allowed_public_metadata() - Code Metrics - Inspection of "Update class-functions.php" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/add-managed-wp-hosts ( 1b6daa...505170 )

unknown

created 2019-12-13 00:11 UTC

Functions::rest_api_allowed_public_metadata() A

↳ Parent: Functions

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Utility functions to generate data synced to wpcom
 *
 * @package automattic/jetpack-sync
 */

namespace Automattic\Jetpack\Sync;

use Automattic\Jetpack\Constants;

/**
 * Utility functions to generate data synced to wpcom
 */
class Functions {
	const HTTPS_CHECK_OPTION_PREFIX = 'jetpack_sync_https_history_';
	const HTTPS_CHECK_HISTORY       = 5;

	/**
	 * Return array of Jetpack modules.
	 *
	 * @return array
	 */
	public static function get_modules() {
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';

		return \Jetpack_Admin::init()->get_modules();
	}

	/**
	 * Return array of taxonomies registered on the site.
	 *
	 * @return array
	 */
	public static function get_taxonomies() {
		global $wp_taxonomies;
		$wp_taxonomies_without_callbacks = array();
		foreach ( $wp_taxonomies as $taxonomy_name => $taxonomy ) {
			$sanitized_taxonomy = self::sanitize_taxonomy( $taxonomy );
			if ( ! empty( $sanitized_taxonomy ) ) {
				$wp_taxonomies_without_callbacks[ $taxonomy_name ] = $sanitized_taxonomy;
			}
		}
		return $wp_taxonomies_without_callbacks;
	}

	/**
	 * Return array of registered shortcodes.
	 *
	 * @return array
	 */
	public static function get_shortcodes() {
		global $shortcode_tags;
		return array_keys( $shortcode_tags );
	}

	/**
	 * Removes any callback data since we will not be able to process it on our side anyways.
	 *
	 * @param \WP_Taxonomy $taxonomy \WP_Taxonomy item.
	 *
	 * @return mixed|null
	 */
	public static function sanitize_taxonomy( $taxonomy ) {

		// Lets clone the taxonomy object instead of modifing the global one.
		$cloned_taxonomy = json_decode( wp_json_encode( $taxonomy ) );

		// recursive taxonomies are no fun.
		if ( is_null( $cloned_taxonomy ) ) {
			return null;
		}
		// Remove any meta_box_cb if they are not the default wp ones.
		if ( isset( $cloned_taxonomy->meta_box_cb ) &&
			! in_array( $cloned_taxonomy->meta_box_cb, array( 'post_tags_meta_box', 'post_categories_meta_box' ), true ) ) {
			$cloned_taxonomy->meta_box_cb = null;
		}
		// Remove update call back.
		if ( isset( $cloned_taxonomy->update_count_callback ) &&
			! is_null( $cloned_taxonomy->update_count_callback ) ) {
			$cloned_taxonomy->update_count_callback = null;
		}
		// Remove rest_controller_class if it something other then the default.
		if ( isset( $cloned_taxonomy->rest_controller_class ) &&
			'WP_REST_Terms_Controller' !== $cloned_taxonomy->rest_controller_class ) {
			$cloned_taxonomy->rest_controller_class = null;
		}
		return $cloned_taxonomy;
	}

	/**
	 * Return array of registered post types.
	 *
	 * @return array
	 */
	public static function get_post_types() {
		global $wp_post_types;

		$post_types_without_callbacks = array();
		foreach ( $wp_post_types as $post_type_name => $post_type ) {
			$sanitized_post_type = self::sanitize_post_type( $post_type );
			if ( ! empty( $sanitized_post_type ) ) {
				$post_types_without_callbacks[ $post_type_name ] = $sanitized_post_type;
			}
		}
		return $post_types_without_callbacks;
	}

	/**
	 * Sanitizes by cloning post type object.
	 *
	 * @param object $post_type \WP_Post_Type.
	 *
	 * @return object
	 */
	public static function sanitize_post_type( $post_type ) {
		// Lets clone the post type object instead of modifing the global one.
		$sanitized_post_type = array();
		foreach ( Defaults::$default_post_type_attributes as $attribute_key => $default_value ) {
			if ( isset( $post_type->{ $attribute_key } ) ) {
				$sanitized_post_type[ $attribute_key ] = $post_type->{ $attribute_key };
			}
		}
		return (object) $sanitized_post_type;
	}

	/**
	 * Return information about a synced post type.
	 *
	 * @param array  $sanitized_post_type Array of args used in constructing \WP_Post_Type.
	 * @param string $post_type Post type name.
	 *
	 * @return object \WP_Post_Type
	 */
	public static function expand_synced_post_type( $sanitized_post_type, $post_type ) {
		$post_type        = sanitize_key( $post_type );
		$post_type_object = new \WP_Post_Type( $post_type, $sanitized_post_type );
		$post_type_object->add_supports();
		$post_type_object->add_rewrite_rules();
		$post_type_object->add_hooks();
		$post_type_object->register_taxonomies();
		return (object) $post_type_object;
	}

	/**
	 * Returns site's post_type_features.
	 *
	 * @return array
	 */
	public static function get_post_type_features() {
		global $_wp_post_type_features;

		return $_wp_post_type_features;
	}

	/**
	 * Return hosting provider.
	 *
	 * Uses a set of known constants, classes, or functions to help determine the hosting platform.
	 *
	 * @return string Hosting provider.
	 */
	public static function get_hosting_provider() {
		$hosting_provider_constants = array(
			'GD_SYSTEM_PLUGIN_DIR' => 'gd-managed-wp',
			'MM_BASE_DIR'          => 'bh',
			'PAGELYBIN'            => 'pagely',
			'KINSTAMU_VERSION'     => 'kinsta',
			'FLYWHEEL_CONFIG_DIR'  => 'flywheel',
			'IS_PRESSABLE'         => 'pressable',
		);

		foreach ( $hosting_provider_constants as $constant => $constant_value ) {
			if ( defined( $constant ) ) {
				return $constant_value;
			}
		}

		if ( function_exists( 'is_wpe' ) || function_exists( 'is_wpe_snapshot' ) ) {
			return 'wpe';
		}
		if ( defined( 'VIP_GO_ENV' ) && false !== VIP_GO_ENV ) {
			return 'vip-go';
		}
		return 'unknown';
	}

	/**
	 * Return array of allowed REST API post types.
	 *
	 * @return array Array of allowed post types.
	 */
	public static function rest_api_allowed_post_types() {
		/** This filter is already documented in class.json-api-endpoints.php */
		return apply_filters( 'rest_api_allowed_post_types', array( 'post', 'page', 'revision' ) );
	}

	/**
	 * Return array of allowed REST API public metadata.
	 *
	 * @return array Array of allowed metadata.
	 */
	public static function rest_api_allowed_public_metadata() {
		/** This filter is documented in json-endpoints/class.wpcom-json-api-post-endpoint.php */
		return apply_filters( 'rest_api_allowed_public_metadata', array() );
	}

	/**
	 * Finds out if a site is using a version control system.
	 *
	 * @return bool
	 **/
	public static function is_version_controlled() {

		if ( ! class_exists( 'WP_Automatic_Updater' ) ) {
			require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
		}
		$updater = new \WP_Automatic_Updater();

		return (bool) strval( $updater->is_vcs_checkout( ABSPATH ) );
	}

	/**
	 * Returns true if the site has file write access false otherwise.
	 *
	 * @return bool
	 **/
	public static function file_system_write_access() {
		if ( ! function_exists( 'get_filesystem_method' ) ) {
			require_once ABSPATH . 'wp-admin/includes/file.php';
		}

		require_once ABSPATH . 'wp-admin/includes/template.php';

		$filesystem_method = get_filesystem_method();
		if ( 'direct' === $filesystem_method ) {
			return true;
		}

		ob_start();

		if ( ! function_exists( 'request_filesystem_credentials' ) ) {
			require_once ABSPATH . 'wp-admin/includes/file.php';
		}

		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
		ob_end_clean();
		if ( $filesystem_credentials_are_stored ) {
			return true;
		}

		return false;
	}

	/**
	 * Helper function that is used when getting home or siteurl values. Decides
	 * whether to get the raw or filtered value.
	 *
	 * @param string $url_type URL to get, home or siteurl.
	 * @return string
	 */
	public static function get_raw_or_filtered_url( $url_type ) {
		$url_function = ( 'home' === $url_type )
			? 'home_url'
			: 'site_url';

		if (
			! Constants::is_defined( 'JETPACK_SYNC_USE_RAW_URL' ) ||
			Constants::get_constant( 'JETPACK_SYNC_USE_RAW_URL' )
		) {
			$scheme = is_ssl() ? 'https' : 'http';
			$url    = self::get_raw_url( $url_type );
			$url    = set_url_scheme( $url, $scheme );
		} else {
			$url = self::normalize_www_in_url( $url_type, $url_function );
		}

		return self::get_protocol_normalized_url( $url_function, $url );
	}

	/**
	 * Return the escaped home_url.
	 *
	 * @return string
	 */
	public static function home_url() {
		$url = self::get_raw_or_filtered_url( 'home' );

		/**
		 * Allows overriding of the home_url value that is synced back to WordPress.com.
		 *
		 * @since 5.2.0
		 *
		 * @param string $home_url
		 */
		return esc_url_raw( apply_filters( 'jetpack_sync_home_url', $url ) );
	}

	/**
	 * Return the escaped siteurl.
	 *
	 * @return string
	 */
	public static function site_url() {
		$url = self::get_raw_or_filtered_url( 'siteurl' );

		/**
		 * Allows overriding of the site_url value that is synced back to WordPress.com.
		 *
		 * @since 5.2.0
		 *
		 * @param string $site_url
		 */
		return esc_url_raw( apply_filters( 'jetpack_sync_site_url', $url ) );
	}

	/**
	 * Return main site URL with a normalized protocol.
	 *
	 * @return string
	 */
	public static function main_network_site_url() {
		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
	}

	/**
	 * Return URL with a normalized protocol.
	 *
	 * @param callable $callable Function to retrieve URL option.
	 * @param string   $new_value URL Protocol to set URLs to.
	 * @return string Normalized URL.
	 */
	public static function get_protocol_normalized_url( $callable, $new_value ) {
		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;

		$parsed_url = wp_parse_url( $new_value );
		if ( ! $parsed_url ) {
			return $new_value;
		}
		if ( array_key_exists( 'scheme', $parsed_url ) ) {
			$scheme = $parsed_url['scheme'];
		} else {
			$scheme = '';
		}
		$scheme_history   = get_option( $option_key, array() );
		$scheme_history[] = $scheme;

		// Limit length to self::HTTPS_CHECK_HISTORY.
		$scheme_history = array_slice( $scheme_history, ( self::HTTPS_CHECK_HISTORY * -1 ) );

		update_option( $option_key, $scheme_history );

		$forced_scheme = in_array( 'https', $scheme_history, true ) ? 'https' : 'http';

		return set_url_scheme( $new_value, $forced_scheme );
	}

	/**
	 * Return URL from option or PHP constant.
	 *
	 * @param string $option_name (e.g. 'home').
	 *
	 * @return mixed|null URL.
	 */
	public static function get_raw_url( $option_name ) {
		$value    = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$constant = ( 'home' === $option_name )
			? 'WP_HOME'
			: 'WP_SITEURL';

		// Since we disregard the constant for multisites in ms-default-filters.php,
		// let's also use the db value if this is a multisite.
		if ( ! is_multisite() && Constants::is_defined( $constant ) ) {
			$value = Constants::get_constant( $constant );
		} else {
			// Let's get the option from the database so that we can bypass filters. This will help
			// ensure that we get more uniform values.
			$value = \Jetpack_Options::get_raw_option( $option_name );
		}

		return $value;
	}

	/**
	 * Normalize domains by removing www unless declared in the site's option.
	 *
	 * @param string   $option Option value from the site.
	 * @param callable $url_function Function retrieving the URL to normalize.
	 * @return mixed|string URL.
	 */
	public static function normalize_www_in_url( $option, $url_function ) {
		$url        = wp_parse_url( call_user_func( $url_function ) );
		$option_url = wp_parse_url( get_option( $option ) );

		if ( ! $option_url || ! $url ) {
			return $url;
		}

		if ( "www.{$option_url[ 'host' ]}" === $url['host'] ) {
			// remove www if not present in option URL.
			$url['host'] = $option_url['host'];
		}
		if ( "www.{$url[ 'host' ]}" === $option_url['host'] ) {
			// add www if present in option URL.
			$url['host'] = $option_url['host'];
		}

		$normalized_url = "{$url['scheme']}://{$url['host']}";
		if ( isset( $url['path'] ) ) {
			$normalized_url .= "{$url['path']}";
		}

		if ( isset( $url['query'] ) ) {
			$normalized_url .= "?{$url['query']}";
		}

		return $normalized_url;
	}

	/**
	 * Return filtered value of get_plugins.
	 *
	 * @return mixed|void
	 */
	public static function get_plugins() {
		if ( ! function_exists( 'get_plugins' ) ) {
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
		}

		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
		return apply_filters( 'all_plugins', get_plugins() );
	}

	/**
	 * Get custom action link tags that the plugin is using
	 * Ref: https://codex.wordpress.org/Plugin_API/Filter_Reference/plugin_action_links_(plugin_file_name)
	 *
	 * @param string $plugin_file_singular Particular plugin.

	 * @return array of plugin action links (key: link name value: url)
	 */
	public static function get_plugins_action_links( $plugin_file_singular = null ) {
		// Some sites may have DOM disabled in PHP fail early.
		if ( ! class_exists( 'DOMDocument' ) ) {
			return array();
		}
		$plugins_action_links = get_option( 'jetpack_plugin_api_action_links', array() );
		if ( ! empty( $plugins_action_links ) ) {
			if ( is_null( $plugin_file_singular ) ) {
				return $plugins_action_links;
			}
			return ( isset( $plugins_action_links[ $plugin_file_singular ] ) ? $plugins_action_links[ $plugin_file_singular ] : null );
		}
		return array();
	}

	/**
	 * Return the WP version as defined in the $wp_version global.
	 *
	 * @return string
	 */
	public static function wp_version() {
		global $wp_version;
		return $wp_version;
	}

	/**
	 * Return site icon url used on the site.
	 *
	 * @param int $size Size of requested icon in pixels.
	 * @return mixed|string|void
	 */
	public static function site_icon_url( $size = 512 ) {
		$site_icon = get_site_icon_url( $size );
		return $site_icon ? $site_icon : get_option( 'jetpack_site_icon_url' );
	}

	/**
	 * Return roles registered on the site.
	 *
	 * @return array
	 */
	public static function roles() {
		$wp_roles = wp_roles();
		return $wp_roles->roles;
	}

	/**
	 * Determine time zone from WordPress' options "timezone_string"
	 * and "gmt_offset".
	 *
	 * 1. Check if `timezone_string` is set and return it.
	 * 2. Check if `gmt_offset` is set, formats UTC-offset from it and return it.
	 * 3. Default to "UTC+0" if nothing is set.
	 *
	 * Note: This function is specifically not using wp_timezone() to keep consistency with
	 * the existing formatting of the timezone string.
	 *
	 * @return string
	 */
	public static function get_timezone() {
		$timezone_string = get_option( 'timezone_string' );

		if ( ! empty( $timezone_string ) ) {
			return str_replace( '_', ' ', $timezone_string );
		}

		$gmt_offset = get_option( 'gmt_offset', 0 );

		$formatted_gmt_offset = sprintf( '%+g', floatval( $gmt_offset ) );

		$formatted_gmt_offset = str_replace(
			array( '.25', '.5', '.75' ),
			array( ':15', ':30', ':45' ),
			(string) $formatted_gmt_offset
		);

		/* translators: %s is UTC offset, e.g. "+1" */
		return sprintf( __( 'UTC%s', 'jetpack' ), $formatted_gmt_offset );
	}

	/**
	 * Return list of paused themes.
	 *
	 * @todo Remove function_exists check when WP 5.2 is the minimum.
	 *
	 * @return array|bool Array of paused themes or false if unsupported.
	 */
	public static function get_paused_themes() {
		if ( function_exists( 'wp_paused_themes' ) ) {
			$paused_themes = wp_paused_themes();
			return $paused_themes->get_all();
		}
		return false;
	}

	/**
	 * Return list of paused plugins.
	 *
	 * @todo Remove function_exists check when WP 5.2 is the minimum.
	 *
	 * @return array|bool Array of paused plugins or false if unsupported.
	 */
	public static function get_paused_plugins() {
		if ( function_exists( 'wp_paused_plugins' ) ) {
			$paused_plugins = wp_paused_plugins();
			return $paused_plugins->get_all();
		}
		return false;
	}
}


1		<?php
2		/**
3		* Utility functions to generate data synced to wpcom
4		*
5		* @package automattic/jetpack-sync
6		*/
7
8		namespace Automattic\Jetpack\Sync;
9
10		use Automattic\Jetpack\Constants;
11
12		/**
13		* Utility functions to generate data synced to wpcom
14		*/
15		class Functions {
16		const HTTPS_CHECK_OPTION_PREFIX = 'jetpack_sync_https_history_';
17		const HTTPS_CHECK_HISTORY = 5;
18
19		/**
20		* Return array of Jetpack modules.
21		*
22		* @return array
23		*/
24		public static function get_modules() {
25		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
26
27		return \Jetpack_Admin::init()->get_modules();
28		}
29
30		/**
31		* Return array of taxonomies registered on the site.
32		*
33		* @return array
34		*/
35		public static function get_taxonomies() {
36		global $wp_taxonomies;
37		$wp_taxonomies_without_callbacks = array();
38		foreach ( $wp_taxonomies as $taxonomy_name => $taxonomy ) {
39		$sanitized_taxonomy = self::sanitize_taxonomy( $taxonomy );
40		if ( ! empty( $sanitized_taxonomy ) ) {
41		$wp_taxonomies_without_callbacks[ $taxonomy_name ] = $sanitized_taxonomy;
42		}
43		}
44		return $wp_taxonomies_without_callbacks;
45		}
46
47		/**
48		* Return array of registered shortcodes.
49		*
50		* @return array
51		*/
52		public static function get_shortcodes() {
53		global $shortcode_tags;
54		return array_keys( $shortcode_tags );
55		}
56
57		/**
58		* Removes any callback data since we will not be able to process it on our side anyways.
59		*
60		* @param \WP_Taxonomy $taxonomy \WP_Taxonomy item.
61		*
62		* @return mixed\|null
63		*/
64		public static function sanitize_taxonomy( $taxonomy ) {
65
66		// Lets clone the taxonomy object instead of modifing the global one.
67		$cloned_taxonomy = json_decode( wp_json_encode( $taxonomy ) );
68
69		// recursive taxonomies are no fun.
70		if ( is_null( $cloned_taxonomy ) ) {
71		return null;
72		}
73		// Remove any meta_box_cb if they are not the default wp ones.
74		if ( isset( $cloned_taxonomy->meta_box_cb ) &&
75		! in_array( $cloned_taxonomy->meta_box_cb, array( 'post_tags_meta_box', 'post_categories_meta_box' ), true ) ) {
76		$cloned_taxonomy->meta_box_cb = null;
77		}
78		// Remove update call back.
79		if ( isset( $cloned_taxonomy->update_count_callback ) &&
80		! is_null( $cloned_taxonomy->update_count_callback ) ) {
81		$cloned_taxonomy->update_count_callback = null;
82		}
83		// Remove rest_controller_class if it something other then the default.
84		if ( isset( $cloned_taxonomy->rest_controller_class ) &&
85		'WP_REST_Terms_Controller' !== $cloned_taxonomy->rest_controller_class ) {
86		$cloned_taxonomy->rest_controller_class = null;
87		}
88		return $cloned_taxonomy;
89		}
90
91		/**
92		* Return array of registered post types.
93		*
94		* @return array
95		*/
96		public static function get_post_types() {
97		global $wp_post_types;
98
99		$post_types_without_callbacks = array();
100		foreach ( $wp_post_types as $post_type_name => $post_type ) {
101		$sanitized_post_type = self::sanitize_post_type( $post_type );
102		if ( ! empty( $sanitized_post_type ) ) {
103		$post_types_without_callbacks[ $post_type_name ] = $sanitized_post_type;
104		}
105		}
106		return $post_types_without_callbacks;
107		}
108
109		/**
110		* Sanitizes by cloning post type object.
111		*
112		* @param object $post_type \WP_Post_Type.
113		*
114		* @return object
115		*/
116		public static function sanitize_post_type( $post_type ) {
117		// Lets clone the post type object instead of modifing the global one.
118		$sanitized_post_type = array();
119		foreach ( Defaults::$default_post_type_attributes as $attribute_key => $default_value ) {
120		if ( isset( $post_type->{ $attribute_key } ) ) {
121		$sanitized_post_type[ $attribute_key ] = $post_type->{ $attribute_key };
122		}
123		}
124		return (object) $sanitized_post_type;
125		}
126
127		/**
128		* Return information about a synced post type.
129		*
130		* @param array $sanitized_post_type Array of args used in constructing \WP_Post_Type.
131		* @param string $post_type Post type name.
132		*
133		* @return object \WP_Post_Type
134		*/
135		public static function expand_synced_post_type( $sanitized_post_type, $post_type ) {
136		$post_type = sanitize_key( $post_type );
137		$post_type_object = new \WP_Post_Type( $post_type, $sanitized_post_type );
138		$post_type_object->add_supports();
139		$post_type_object->add_rewrite_rules();
140		$post_type_object->add_hooks();
141		$post_type_object->register_taxonomies();
142		return (object) $post_type_object;
143		}
144
145		/**
146		* Returns site's post_type_features.
147		*
148		* @return array
149		*/
150		public static function get_post_type_features() {
151		global $_wp_post_type_features;
152
153		return $_wp_post_type_features;
154		}
155
156		/**
157		* Return hosting provider.
158		*
159		* Uses a set of known constants, classes, or functions to help determine the hosting platform.
160		*
161		* @return string Hosting provider.
162		*/
163		public static function get_hosting_provider() {
164		$hosting_provider_constants = array(
165		'GD_SYSTEM_PLUGIN_DIR' => 'gd-managed-wp',
166		'MM_BASE_DIR' => 'bh',
167		'PAGELYBIN' => 'pagely',
168		'KINSTAMU_VERSION' => 'kinsta',
169		'FLYWHEEL_CONFIG_DIR' => 'flywheel',
170		'IS_PRESSABLE' => 'pressable',
171		);
172
173		foreach ( $hosting_provider_constants as $constant => $constant_value ) {
174		if ( defined( $constant ) ) {
175		return $constant_value;
176		}
177		}
178
179		if ( function_exists( 'is_wpe' ) \|\| function_exists( 'is_wpe_snapshot' ) ) {
180		return 'wpe';
181		}
182		if ( defined( 'VIP_GO_ENV' ) && false !== VIP_GO_ENV ) {
183		return 'vip-go';
184		}
185		return 'unknown';
186		}
187
188		/**
189		* Return array of allowed REST API post types.
190		*
191		* @return array Array of allowed post types.
192		*/
193		public static function rest_api_allowed_post_types() {
194		/** This filter is already documented in class.json-api-endpoints.php */
195		return apply_filters( 'rest_api_allowed_post_types', array( 'post', 'page', 'revision' ) );
196		}
197
198		/**
199		* Return array of allowed REST API public metadata.
200		*
201		* @return array Array of allowed metadata.
202		*/
203		public static function rest_api_allowed_public_metadata() {
204		/** This filter is documented in json-endpoints/class.wpcom-json-api-post-endpoint.php */
205		return apply_filters( 'rest_api_allowed_public_metadata', array() );
206		}
207
208		/**
209		* Finds out if a site is using a version control system.
210		*
211		* @return bool
212		**/
213		public static function is_version_controlled() {
214
215		if ( ! class_exists( 'WP_Automatic_Updater' ) ) {
216		require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
217		}
218		$updater = new \WP_Automatic_Updater();
219
220		return (bool) strval( $updater->is_vcs_checkout( ABSPATH ) );
221		}
222
223		/**
224		* Returns true if the site has file write access false otherwise.
225		*
226		* @return bool
227		**/
228		public static function file_system_write_access() {
229		if ( ! function_exists( 'get_filesystem_method' ) ) {
230		require_once ABSPATH . 'wp-admin/includes/file.php';
231		}
232
233		require_once ABSPATH . 'wp-admin/includes/template.php';
234
235		$filesystem_method = get_filesystem_method();
236		if ( 'direct' === $filesystem_method ) {
237		return true;
238		}
239
240		ob_start();
241
242		if ( ! function_exists( 'request_filesystem_credentials' ) ) {
243		require_once ABSPATH . 'wp-admin/includes/file.php';
244		}
245
246		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
247		ob_end_clean();
248		if ( $filesystem_credentials_are_stored ) {
249		return true;
250		}
251
252		return false;
253		}
254
255		/**
256		* Helper function that is used when getting home or siteurl values. Decides
257		* whether to get the raw or filtered value.
258		*
259		* @param string $url_type URL to get, home or siteurl.
260		* @return string
261		*/
262		public static function get_raw_or_filtered_url( $url_type ) {
263		$url_function = ( 'home' === $url_type )
264		? 'home_url'
265		: 'site_url';
266
267		if (
268		! Constants::is_defined( 'JETPACK_SYNC_USE_RAW_URL' ) \|\|
269		Constants::get_constant( 'JETPACK_SYNC_USE_RAW_URL' )
270		) {
271		$scheme = is_ssl() ? 'https' : 'http';
272		$url = self::get_raw_url( $url_type );
273		$url = set_url_scheme( $url, $scheme );
274		} else {
275		$url = self::normalize_www_in_url( $url_type, $url_function );
276		}
277
278		return self::get_protocol_normalized_url( $url_function, $url );
279		}
280
281		/**
282		* Return the escaped home_url.
283		*
284		* @return string
285		*/
286		public static function home_url() {
287		$url = self::get_raw_or_filtered_url( 'home' );
288
289		/**
290		* Allows overriding of the home_url value that is synced back to WordPress.com.
291		*
292		* @since 5.2.0
293		*
294		* @param string $home_url
295		*/
296		return esc_url_raw( apply_filters( 'jetpack_sync_home_url', $url ) );
297		}
298
299		/**
300		* Return the escaped siteurl.
301		*
302		* @return string
303		*/
304		public static function site_url() {
305		$url = self::get_raw_or_filtered_url( 'siteurl' );
306
307		/**
308		* Allows overriding of the site_url value that is synced back to WordPress.com.
309		*
310		* @since 5.2.0
311		*
312		* @param string $site_url
313		*/
314		return esc_url_raw( apply_filters( 'jetpack_sync_site_url', $url ) );
315		}
316
317		/**
318		* Return main site URL with a normalized protocol.
319		*
320		* @return string
321		*/
322		public static function main_network_site_url() {
323		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
324		}
325
326		/**
327		* Return URL with a normalized protocol.
328		*
329		* @param callable $callable Function to retrieve URL option.
330		* @param string $new_value URL Protocol to set URLs to.
331		* @return string Normalized URL.
332		*/
333		public static function get_protocol_normalized_url( $callable, $new_value ) {
334		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
335
336		$parsed_url = wp_parse_url( $new_value );
337		if ( ! $parsed_url ) {
338		return $new_value;
339		}
340		if ( array_key_exists( 'scheme', $parsed_url ) ) {
341		$scheme = $parsed_url['scheme'];
342		} else {
343		$scheme = '';
344		}
345		$scheme_history = get_option( $option_key, array() );
346		$scheme_history[] = $scheme;
347
348		// Limit length to self::HTTPS_CHECK_HISTORY.
349		$scheme_history = array_slice( $scheme_history, ( self::HTTPS_CHECK_HISTORY * -1 ) );
350
351		update_option( $option_key, $scheme_history );
352
353		$forced_scheme = in_array( 'https', $scheme_history, true ) ? 'https' : 'http';
354
355		return set_url_scheme( $new_value, $forced_scheme );
356		}
357
358		/**
359		* Return URL from option or PHP constant.
360		*
361		* @param string $option_name (e.g. 'home').
362		*
363		* @return mixed\|null URL.
364		*/
365		public static function get_raw_url( $option_name ) {
366		$value = null;
		0 ignored issues – show Unused Code introduced 2017-07-25 00:48 UTC by Report Bug Copy Issue Report `$value` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
367		$constant = ( 'home' === $option_name )
368		? 'WP_HOME'
369		: 'WP_SITEURL';
370
371		// Since we disregard the constant for multisites in ms-default-filters.php,
372		// let's also use the db value if this is a multisite.
373		if ( ! is_multisite() && Constants::is_defined( $constant ) ) {
374		$value = Constants::get_constant( $constant );
375		} else {
376		// Let's get the option from the database so that we can bypass filters. This will help
377		// ensure that we get more uniform values.
378		$value = \Jetpack_Options::get_raw_option( $option_name );
379		}
380
381		return $value;
382		}
383
384		/**
385		* Normalize domains by removing www unless declared in the site's option.
386		*
387		* @param string $option Option value from the site.
388		* @param callable $url_function Function retrieving the URL to normalize.
389		* @return mixed\|string URL.
390		*/
391		public static function normalize_www_in_url( $option, $url_function ) {
392		$url = wp_parse_url( call_user_func( $url_function ) );
393		$option_url = wp_parse_url( get_option( $option ) );
394
395		if ( ! $option_url \|\| ! $url ) {
396		return $url;
397		}
398
399	View Code Duplication	if ( "www.{$option_url[ 'host' ]}" === $url['host'] ) {
400		// remove www if not present in option URL.
401		$url['host'] = $option_url['host'];
402		}
403	View Code Duplication	if ( "www.{$url[ 'host' ]}" === $option_url['host'] ) {
404		// add www if present in option URL.
405		$url['host'] = $option_url['host'];
406		}
407
408		$normalized_url = "{$url['scheme']}://{$url['host']}";
409		if ( isset( $url['path'] ) ) {
410		$normalized_url .= "{$url['path']}";
411		}
412
413		if ( isset( $url['query'] ) ) {
414		$normalized_url .= "?{$url['query']}";
415		}
416
417		return $normalized_url;
418		}
419
420		/**
421		* Return filtered value of get_plugins.
422		*
423		* @return mixed\|void
424		*/
425		public static function get_plugins() {
426		if ( ! function_exists( 'get_plugins' ) ) {
427		require_once ABSPATH . 'wp-admin/includes/plugin.php';
428		}
429
430		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
431		return apply_filters( 'all_plugins', get_plugins() );
432		}
433
434		/**
435		* Get custom action link tags that the plugin is using
436		* Ref: https://codex.wordpress.org/Plugin_API/Filter_Reference/plugin_action_links_(plugin_file_name)
437		*
438		* @param string $plugin_file_singular Particular plugin.
		0 ignored issues – show Documentation introduced 2019-09-27 16:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$plugin_file_singular` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
439		* @return array of plugin action links (key: link name value: url)
440		*/
441		public static function get_plugins_action_links( $plugin_file_singular = null ) {
442		// Some sites may have DOM disabled in PHP fail early.
443		if ( ! class_exists( 'DOMDocument' ) ) {
444		return array();
445		}
446		$plugins_action_links = get_option( 'jetpack_plugin_api_action_links', array() );
447		if ( ! empty( $plugins_action_links ) ) {
448		if ( is_null( $plugin_file_singular ) ) {
449		return $plugins_action_links;
450		}
451		return ( isset( $plugins_action_links[ $plugin_file_singular ] ) ? $plugins_action_links[ $plugin_file_singular ] : null );
452		}
453		return array();
454		}
455
456		/**
457		* Return the WP version as defined in the $wp_version global.
458		*
459		* @return string
460		*/
461		public static function wp_version() {
462		global $wp_version;
463		return $wp_version;
464		}
465
466		/**
467		* Return site icon url used on the site.
468		*
469		* @param int $size Size of requested icon in pixels.
470		* @return mixed\|string\|void
471		*/
472		public static function site_icon_url( $size = 512 ) {
473		$site_icon = get_site_icon_url( $size );
474		return $site_icon ? $site_icon : get_option( 'jetpack_site_icon_url' );
475		}
476
477		/**
478		* Return roles registered on the site.
479		*
480		* @return array
481		*/
482		public static function roles() {
483		$wp_roles = wp_roles();
484		return $wp_roles->roles;
485		}
486
487		/**
488		* Determine time zone from WordPress' options "timezone_string"
489		* and "gmt_offset".
490		*
491		* 1. Check if `timezone_string` is set and return it.
492		* 2. Check if `gmt_offset` is set, formats UTC-offset from it and return it.
493		* 3. Default to "UTC+0" if nothing is set.
494		*
495		* Note: This function is specifically not using wp_timezone() to keep consistency with
496		* the existing formatting of the timezone string.
497		*
498		* @return string
499		*/
500		public static function get_timezone() {
501		$timezone_string = get_option( 'timezone_string' );
502
503		if ( ! empty( $timezone_string ) ) {
504		return str_replace( '_', ' ', $timezone_string );
505		}
506
507		$gmt_offset = get_option( 'gmt_offset', 0 );
508
509		$formatted_gmt_offset = sprintf( '%+g', floatval( $gmt_offset ) );
510
511		$formatted_gmt_offset = str_replace(
512		array( '.25', '.5', '.75' ),
513		array( ':15', ':30', ':45' ),
514		(string) $formatted_gmt_offset
515		);
516
517		/* translators: %s is UTC offset, e.g. "+1" */
518		return sprintf( __( 'UTC%s', 'jetpack' ), $formatted_gmt_offset );
519		}
520
521		/**
522		* Return list of paused themes.
523		*
524		* @todo Remove function_exists check when WP 5.2 is the minimum.
525		*
526		* @return array\|bool Array of paused themes or false if unsupported.
527		*/
528		public static function get_paused_themes() {
529		if ( function_exists( 'wp_paused_themes' ) ) {
530		$paused_themes = wp_paused_themes();
531		return $paused_themes->get_all();
532		}
533		return false;
534		}
535
536		/**
537		* Return list of paused plugins.
538		*
539		* @todo Remove function_exists check when WP 5.2 is the minimum.
540		*
541		* @return array\|bool Array of paused plugins or false if unsupported.
542		*/
543		public static function get_paused_plugins() {
544		if ( function_exists( 'wp_paused_plugins' ) ) {
545		$paused_plugins = wp_paused_plugins();
546		return $paused_plugins->get_all();
547		}
548		return false;
549		}
550		}
551

Automattic / jetpack

Push — update/add-managed-wp-hosts ( 1b6daa...505170 )

Functions::rest_api_allowed_public_metadata() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like