Functions::get_paused_themes() - Code Metrics - Inspection of "[not verified] Rebase from the master branch and r..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/sub-pending-error ( 24ed1c...c790bd )

unknown

created 2020-01-16 14:15 UTC

Functions::get_paused_themes() A

↳ Parent: Functions

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	7
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_detection_methods = array(
			'get_hosting_provider_by_known_constant',
			'get_hosting_provider_by_known_class',
			'get_hosting_provider_by_known_function',
		);

		$functions = new Functions();
		foreach ( $hosting_provider_detection_methods as $method ) {
			$hosting_provider = call_user_func( array( $functions, $method ) );
			if ( false !== $hosting_provider ) {
				return $hosting_provider;
			}
		}

		return 'unknown';
	}

	/**
	 * Return a hosting provider using a set of known constants.
	 *
	 * @return mixed A host identifier string or false.
	 */
	public function get_hosting_provider_by_known_constant() {
		$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',
			'VIP_GO_ENV'           => 'vip-go',
		);

		foreach ( $hosting_provider_constants as $constant => $constant_value ) {
			if ( Constants::is_defined( $constant ) ) {
				if ( 'VIP_GO_ENV' === $constant && false === Constants::get_constant( 'VIP_GO_ENV' ) ) {
					continue;
				}
				return $constant_value;
			}
		}

		return false;
	}

	/**
	 * Return a hosting provider using a set of known classes.
	 *
	 * @return mixed A host identifier string or false.
	 */
	public function get_hosting_provider_by_known_class() {
		$hosting_provider = false;

		switch ( true ) {
			case ( class_exists( '\\WPaaS\\Plugin' ) ):
				$hosting_provider = 'gd-managed-wp';
				break;
		}

		return $hosting_provider;
	}

	/**
	 * Return a hosting provider using a set of known functions.
	 *
	 * @return mixed A host identifier string or false.
	 */
	public function get_hosting_provider_by_known_function() {
		$hosting_provider = false;

		switch ( true ) {
			case ( function_exists( 'is_wpe' ) || function_exists( 'is_wpe_snapshot' ) ):
				$hosting_provider = 'wpe';
				break;
		}

		return $hosting_provider;
	}

	/**
	 * 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_detection_methods = array(
165		'get_hosting_provider_by_known_constant',
166		'get_hosting_provider_by_known_class',
167		'get_hosting_provider_by_known_function',
168		);
169
170		$functions = new Functions();
171		foreach ( $hosting_provider_detection_methods as $method ) {
172		$hosting_provider = call_user_func( array( $functions, $method ) );
173		if ( false !== $hosting_provider ) {
174		return $hosting_provider;
175		}
176		}
177
178		return 'unknown';
179		}
180
181		/**
182		* Return a hosting provider using a set of known constants.
183		*
184		* @return mixed A host identifier string or false.
185		*/
186		public function get_hosting_provider_by_known_constant() {
187		$hosting_provider_constants = array(
188		'GD_SYSTEM_PLUGIN_DIR' => 'gd-managed-wp',
189		'MM_BASE_DIR' => 'bh',
190		'PAGELYBIN' => 'pagely',
191		'KINSTAMU_VERSION' => 'kinsta',
192		'FLYWHEEL_CONFIG_DIR' => 'flywheel',
193		'IS_PRESSABLE' => 'pressable',
194		'VIP_GO_ENV' => 'vip-go',
195		);
196
197		foreach ( $hosting_provider_constants as $constant => $constant_value ) {
198		if ( Constants::is_defined( $constant ) ) {
199		if ( 'VIP_GO_ENV' === $constant && false === Constants::get_constant( 'VIP_GO_ENV' ) ) {
200		continue;
201		}
202		return $constant_value;
203		}
204		}
205
206		return false;
207		}
208
209		/**
210		* Return a hosting provider using a set of known classes.
211		*
212		* @return mixed A host identifier string or false.
213		*/
214		public function get_hosting_provider_by_known_class() {
215		$hosting_provider = false;
216
217		switch ( true ) {
218		case ( class_exists( '\\WPaaS\\Plugin' ) ):
219		$hosting_provider = 'gd-managed-wp';
220		break;
221		}
222
223		return $hosting_provider;
224		}
225
226		/**
227		* Return a hosting provider using a set of known functions.
228		*
229		* @return mixed A host identifier string or false.
230		*/
231		public function get_hosting_provider_by_known_function() {
232		$hosting_provider = false;
233
234		switch ( true ) {
235		case ( function_exists( 'is_wpe' ) \|\| function_exists( 'is_wpe_snapshot' ) ):
236		$hosting_provider = 'wpe';
237		break;
238		}
239
240		return $hosting_provider;
241		}
242
243		/**
244		* Return array of allowed REST API post types.
245		*
246		* @return array Array of allowed post types.
247		*/
248		public static function rest_api_allowed_post_types() {
249		/** This filter is already documented in class.json-api-endpoints.php */
250		return apply_filters( 'rest_api_allowed_post_types', array( 'post', 'page', 'revision' ) );
251		}
252
253		/**
254		* Return array of allowed REST API public metadata.
255		*
256		* @return array Array of allowed metadata.
257		*/
258		public static function rest_api_allowed_public_metadata() {
259		/** This filter is documented in json-endpoints/class.wpcom-json-api-post-endpoint.php */
260		return apply_filters( 'rest_api_allowed_public_metadata', array() );
261		}
262
263		/**
264		* Finds out if a site is using a version control system.
265		*
266		* @return bool
267		**/
268		public static function is_version_controlled() {
269
270		if ( ! class_exists( 'WP_Automatic_Updater' ) ) {
271		require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
272		}
273		$updater = new \WP_Automatic_Updater();
274
275		return (bool) strval( $updater->is_vcs_checkout( ABSPATH ) );
276		}
277
278		/**
279		* Returns true if the site has file write access false otherwise.
280		*
281		* @return bool
282		**/
283		public static function file_system_write_access() {
284		if ( ! function_exists( 'get_filesystem_method' ) ) {
285		require_once ABSPATH . 'wp-admin/includes/file.php';
286		}
287
288		require_once ABSPATH . 'wp-admin/includes/template.php';
289
290		$filesystem_method = get_filesystem_method();
291		if ( 'direct' === $filesystem_method ) {
292		return true;
293		}
294
295		ob_start();
296
297		if ( ! function_exists( 'request_filesystem_credentials' ) ) {
298		require_once ABSPATH . 'wp-admin/includes/file.php';
299		}
300
301		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
302		ob_end_clean();
303		if ( $filesystem_credentials_are_stored ) {
304		return true;
305		}
306
307		return false;
308		}
309
310		/**
311		* Helper function that is used when getting home or siteurl values. Decides
312		* whether to get the raw or filtered value.
313		*
314		* @param string $url_type URL to get, home or siteurl.
315		* @return string
316		*/
317		public static function get_raw_or_filtered_url( $url_type ) {
318		$url_function = ( 'home' === $url_type )
319		? 'home_url'
320		: 'site_url';
321
322		if (
323		! Constants::is_defined( 'JETPACK_SYNC_USE_RAW_URL' ) \|\|
324		Constants::get_constant( 'JETPACK_SYNC_USE_RAW_URL' )
325		) {
326		$scheme = is_ssl() ? 'https' : 'http';
327		$url = self::get_raw_url( $url_type );
328		$url = set_url_scheme( $url, $scheme );
329		} else {
330		$url = self::normalize_www_in_url( $url_type, $url_function );
331		}
332
333		return self::get_protocol_normalized_url( $url_function, $url );
334		}
335
336		/**
337		* Return the escaped home_url.
338		*
339		* @return string
340		*/
341		public static function home_url() {
342		$url = self::get_raw_or_filtered_url( 'home' );
343
344		/**
345		* Allows overriding of the home_url value that is synced back to WordPress.com.
346		*
347		* @since 5.2.0
348		*
349		* @param string $home_url
350		*/
351		return esc_url_raw( apply_filters( 'jetpack_sync_home_url', $url ) );
352		}
353
354		/**
355		* Return the escaped siteurl.
356		*
357		* @return string
358		*/
359		public static function site_url() {
360		$url = self::get_raw_or_filtered_url( 'siteurl' );
361
362		/**
363		* Allows overriding of the site_url value that is synced back to WordPress.com.
364		*
365		* @since 5.2.0
366		*
367		* @param string $site_url
368		*/
369		return esc_url_raw( apply_filters( 'jetpack_sync_site_url', $url ) );
370		}
371
372		/**
373		* Return main site URL with a normalized protocol.
374		*
375		* @return string
376		*/
377		public static function main_network_site_url() {
378		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
379		}
380
381		/**
382		* Return URL with a normalized protocol.
383		*
384		* @param callable $callable Function to retrieve URL option.
385		* @param string $new_value URL Protocol to set URLs to.
386		* @return string Normalized URL.
387		*/
388		public static function get_protocol_normalized_url( $callable, $new_value ) {
389		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
390
391		$parsed_url = wp_parse_url( $new_value );
392		if ( ! $parsed_url ) {
393		return $new_value;
394		}
395		if ( array_key_exists( 'scheme', $parsed_url ) ) {
396		$scheme = $parsed_url['scheme'];
397		} else {
398		$scheme = '';
399		}
400		$scheme_history = get_option( $option_key, array() );
401		$scheme_history[] = $scheme;
402
403		// Limit length to self::HTTPS_CHECK_HISTORY.
404		$scheme_history = array_slice( $scheme_history, ( self::HTTPS_CHECK_HISTORY * -1 ) );
405
406		update_option( $option_key, $scheme_history );
407
408		$forced_scheme = in_array( 'https', $scheme_history, true ) ? 'https' : 'http';
409
410		return set_url_scheme( $new_value, $forced_scheme );
411		}
412
413		/**
414		* Return URL from option or PHP constant.
415		*
416		* @param string $option_name (e.g. 'home').
417		*
418		* @return mixed\|null URL.
419		*/
420		public static function get_raw_url( $option_name ) {
421		$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...
422		$constant = ( 'home' === $option_name )
423		? 'WP_HOME'
424		: 'WP_SITEURL';
425
426		// Since we disregard the constant for multisites in ms-default-filters.php,
427		// let's also use the db value if this is a multisite.
428		if ( ! is_multisite() && Constants::is_defined( $constant ) ) {
429		$value = Constants::get_constant( $constant );
430		} else {
431		// Let's get the option from the database so that we can bypass filters. This will help
432		// ensure that we get more uniform values.
433		$value = \Jetpack_Options::get_raw_option( $option_name );
434		}
435
436		return $value;
437		}
438
439		/**
440		* Normalize domains by removing www unless declared in the site's option.
441		*
442		* @param string $option Option value from the site.
443		* @param callable $url_function Function retrieving the URL to normalize.
444		* @return mixed\|string URL.
445		*/
446		public static function normalize_www_in_url( $option, $url_function ) {
447		$url = wp_parse_url( call_user_func( $url_function ) );
448		$option_url = wp_parse_url( get_option( $option ) );
449
450		if ( ! $option_url \|\| ! $url ) {
451		return $url;
452		}
453
454	View Code Duplication	if ( "www.{$option_url[ 'host' ]}" === $url['host'] ) {
455		// remove www if not present in option URL.
456		$url['host'] = $option_url['host'];
457		}
458	View Code Duplication	if ( "www.{$url[ 'host' ]}" === $option_url['host'] ) {
459		// add www if present in option URL.
460		$url['host'] = $option_url['host'];
461		}
462
463		$normalized_url = "{$url['scheme']}://{$url['host']}";
464		if ( isset( $url['path'] ) ) {
465		$normalized_url .= "{$url['path']}";
466		}
467
468		if ( isset( $url['query'] ) ) {
469		$normalized_url .= "?{$url['query']}";
470		}
471
472		return $normalized_url;
473		}
474
475		/**
476		* Return filtered value of get_plugins.
477		*
478		* @return mixed\|void
479		*/
480		public static function get_plugins() {
481		if ( ! function_exists( 'get_plugins' ) ) {
482		require_once ABSPATH . 'wp-admin/includes/plugin.php';
483		}
484
485		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
486		return apply_filters( 'all_plugins', get_plugins() );
487		}
488
489		/**
490		* Get custom action link tags that the plugin is using
491		* Ref: https://codex.wordpress.org/Plugin_API/Filter_Reference/plugin_action_links_(plugin_file_name)
492		*
493		* @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...
494		* @return array of plugin action links (key: link name value: url)
495		*/
496		public static function get_plugins_action_links( $plugin_file_singular = null ) {
497		// Some sites may have DOM disabled in PHP fail early.
498		if ( ! class_exists( 'DOMDocument' ) ) {
499		return array();
500		}
501		$plugins_action_links = get_option( 'jetpack_plugin_api_action_links', array() );
502		if ( ! empty( $plugins_action_links ) ) {
503		if ( is_null( $plugin_file_singular ) ) {
504		return $plugins_action_links;
505		}
506		return ( isset( $plugins_action_links[ $plugin_file_singular ] ) ? $plugins_action_links[ $plugin_file_singular ] : null );
507		}
508		return array();
509		}
510
511		/**
512		* Return the WP version as defined in the $wp_version global.
513		*
514		* @return string
515		*/
516		public static function wp_version() {
517		global $wp_version;
518		return $wp_version;
519		}
520
521		/**
522		* Return site icon url used on the site.
523		*
524		* @param int $size Size of requested icon in pixels.
525		* @return mixed\|string\|void
526		*/
527		public static function site_icon_url( $size = 512 ) {
528		$site_icon = get_site_icon_url( $size );
529		return $site_icon ? $site_icon : get_option( 'jetpack_site_icon_url' );
530		}
531
532		/**
533		* Return roles registered on the site.
534		*
535		* @return array
536		*/
537		public static function roles() {
538		$wp_roles = wp_roles();
539		return $wp_roles->roles;
540		}
541
542		/**
543		* Determine time zone from WordPress' options "timezone_string"
544		* and "gmt_offset".
545		*
546		* 1. Check if `timezone_string` is set and return it.
547		* 2. Check if `gmt_offset` is set, formats UTC-offset from it and return it.
548		* 3. Default to "UTC+0" if nothing is set.
549		*
550		* Note: This function is specifically not using wp_timezone() to keep consistency with
551		* the existing formatting of the timezone string.
552		*
553		* @return string
554		*/
555		public static function get_timezone() {
556		$timezone_string = get_option( 'timezone_string' );
557
558		if ( ! empty( $timezone_string ) ) {
559		return str_replace( '_', ' ', $timezone_string );
560		}
561
562		$gmt_offset = get_option( 'gmt_offset', 0 );
563
564		$formatted_gmt_offset = sprintf( '%+g', floatval( $gmt_offset ) );
565
566		$formatted_gmt_offset = str_replace(
567		array( '.25', '.5', '.75' ),
568		array( ':15', ':30', ':45' ),
569		(string) $formatted_gmt_offset
570		);
571
572		/* translators: %s is UTC offset, e.g. "+1" */
573		return sprintf( __( 'UTC%s', 'jetpack' ), $formatted_gmt_offset );
574		}
575
576		/**
577		* Return list of paused themes.
578		*
579		* @todo Remove function_exists check when WP 5.2 is the minimum.
580		*
581		* @return array\|bool Array of paused themes or false if unsupported.
582		*/
583		public static function get_paused_themes() {
584		if ( function_exists( 'wp_paused_themes' ) ) {
585		$paused_themes = wp_paused_themes();
586		return $paused_themes->get_all();
587		}
588		return false;
589		}
590
591		/**
592		* Return list of paused plugins.
593		*
594		* @todo Remove function_exists check when WP 5.2 is the minimum.
595		*
596		* @return array\|bool Array of paused plugins or false if unsupported.
597		*/
598		public static function get_paused_plugins() {
599		if ( function_exists( 'wp_paused_plugins' ) ) {
600		$paused_plugins = wp_paused_plugins();
601		return $paused_plugins->get_all();
602		}
603		return false;
604		}
605		}
606

Automattic / jetpack

Push — fix/sub-pending-error ( 24ed1c...c790bd )

Functions::get_paused_themes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like