Jetpack_Plan::refresh_from_wpcom() - Code Metrics - Inspection of "Fixes gutter spacing on tracklist and mejs to alig..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/podcast-player-gutter-spac... ( cb45ba )

unknown

created 2020-04-07 19:29 UTC

Jetpack_Plan::refresh_from_wpcom() A

↳ Parent: Jetpack_Plan

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	7
rs	10
c	0
b	0
f	0

<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
 * Handles fetching of the site's plan from WordPress.com and caching the value locally.
 *
 * Not to be confused with the `Jetpack_Plans` class (in `_inc/lib/plans.php`), which
 * fetches general information about all available plans from WordPress.com, side-effect free.
 *
 * @package Jetpack
 */

use Automattic\Jetpack\Connection\Client;

/**
 * Provides methods methods for fetching the plan from WordPress.com.
 */
class Jetpack_Plan {
	/**
	 * A cache variable to hold the active plan for the current request.
	 *
	 * @var array
	 */
	private static $active_plan_cache;

	const PLAN_OPTION = 'jetpack_active_plan';

	/**
	 * Given a response to the `/sites/%d` endpoint, will parse the response and attempt to set the
	 * plan from the response.
	 *
	 * @param array $response The response from `/sites/%d`.
	 * @return bool Was the plan successfully updated?
	 */
	public static function update_from_sites_response( $response ) {
		// Bail if there was an error or malformed response.
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
			return false;
		}

		$body = wp_remote_retrieve_body( $response );
		if ( is_wp_error( $body ) ) {
			return false;
		}

		// Decode the results.
		$results = json_decode( $body, true );

		// Bail if there were no results or plan details returned.
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
			return false;
		}

		// Store the new plan in an option and return true if updated.
		$result = update_option( self::PLAN_OPTION, $results['plan'], true );
		if ( ! $result ) {
			// If we got to this point, then we know we need to update. So, assume there is an issue
			// with caching. To fix that issue, we can delete the current option and then update.
			delete_option( self::PLAN_OPTION );
			$result = update_option( self::PLAN_OPTION, $results['plan'], true );
		}

		if ( $result ) {
			// Reset the cache since we've just updated the plan.
			self::$active_plan_cache = null;

		}

		return $result;
	}

	/**
	 * Make an API call to WordPress.com for plan status
	 *
	 * @uses Jetpack_Options::get_option()
	 * @uses Client::wpcom_json_api_request_as_blog()
	 * @uses update_option()
	 *
	 * @access public
	 * @static
	 *
	 * @return bool True if plan is updated, false if no update
	 */
	public static function refresh_from_wpcom() {
		// Make the API request.
		$request  = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
		$response = Client::wpcom_json_api_request_as_blog( $request, '1.1' );

		return self::update_from_sites_response( $response );
	}

	/**
	 * Get the plan that this Jetpack site is currently using.
	 *
	 * @uses get_option()
	 *
	 * @access public
	 * @static
	 *
	 * @return array Active Jetpack plan details
	 */
	public static function get() {
		// this can be expensive to compute so we cache for the duration of a request.
		if ( is_array( self::$active_plan_cache ) && ! empty( self::$active_plan_cache ) ) {
			return self::$active_plan_cache;
		}

		$plan = get_option( self::PLAN_OPTION, array() );

		// Set the default options.
		$plan = wp_parse_args(
			$plan,
			array(
				'product_slug' => 'jetpack_free',
				'class'        => 'free',
				'features'     => array(
					'active' => array(),
				),
			)
		);

		$supports = array();

		// Define what paid modules are supported by personal plans.
		$personal_plans = array(
			'jetpack_personal',
			'jetpack_personal_monthly',
			'personal-bundle',
			'personal-bundle-monthly',
			'personal-bundle-2y',
		);

		if ( in_array( $plan['product_slug'], $personal_plans, true ) ) {
			// special support value, not a module but a separate plugin.
			$supports[]    = 'akismet';
			$supports[]    = 'recurring-payments';
			$plan['class'] = 'personal';
		}

		// Define what paid modules are supported by premium plans.
		$premium_plans = array(
			'jetpack_premium',
			'jetpack_premium_monthly',
			'value_bundle',
			'value_bundle-monthly',
			'value_bundle-2y',
		);

		if ( in_array( $plan['product_slug'], $premium_plans, true ) ) {
			$supports[]    = 'akismet';
			$supports[]    = 'recurring-payments';
			$supports[]    = 'simple-payments';
			$supports[]    = 'vaultpress';
			$supports[]    = 'videopress';
			$plan['class'] = 'premium';
		}

		// Define what paid modules are supported by professional plans.
		$business_plans = array(
			'jetpack_business',
			'jetpack_business_monthly',
			'business-bundle',
			'business-bundle-monthly',
			'business-bundle-2y',
			'ecommerce-bundle',
			'ecommerce-bundle-monthly',
			'ecommerce-bundle-2y',
			'vip',
		);

		if ( in_array( $plan['product_slug'], $business_plans, true ) ) {
			$supports[]    = 'akismet';
			$supports[]    = 'recurring-payments';
			$supports[]    = 'simple-payments';
			$supports[]    = 'vaultpress';
			$supports[]    = 'videopress';
			$plan['class'] = 'business';
		}

		// get available features.
		foreach ( Jetpack::get_available_modules() as $module_slug ) {
			$module = Jetpack::get_module( $module_slug );
			if ( ! isset( $module ) || ! is_array( $module ) ) {
				continue;
			}
			if ( in_array( 'free', $module['plan_classes'], true ) || in_array( $plan['class'], $module['plan_classes'], true ) ) {
				$supports[] = $module_slug;
			}
		}

		$plan['supports'] = $supports;

		self::$active_plan_cache = $plan;

		return $plan;
	}

	/**
	 * Determine whether the active plan supports a particular feature
	 *
	 * @uses Jetpack_Plan::get()
	 *
	 * @access public
	 * @static
	 *
	 * @param string $feature The module or feature to check.
	 *
	 * @return bool True if plan supports feature, false if not
	 */
	public static function supports( $feature ) {
		// Search product bypasses plan feature check.
		if ( 'search' === $feature && (bool) get_option( 'has_jetpack_search_product' ) ) {
			return true;
		}

		$plan = self::get();

		// Manually mapping WordPress.com features to Jetpack module slugs.
		foreach ( $plan['features']['active'] as $wpcom_feature ) {
			switch ( $wpcom_feature ) {
				case 'wordads-jetpack':
					// WordAds are supported for this site.
					if ( 'wordads' === $feature ) {
						return true;
					}
					break;
			}
		}

		if (
			in_array( $feature, $plan['supports'], true )
			|| in_array( $feature, $plan['features']['active'], true )
		) {
			return true;
		}

		return false;
	}
}


1		<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2		/**
3		* Handles fetching of the site's plan from WordPress.com and caching the value locally.
4		*
5		* Not to be confused with the `Jetpack_Plans` class (in `_inc/lib/plans.php`), which
6		* fetches general information about all available plans from WordPress.com, side-effect free.
7		*
8		* @package Jetpack
9		*/
10
11		use Automattic\Jetpack\Connection\Client;
12
13		/**
14		* Provides methods methods for fetching the plan from WordPress.com.
15		*/
16		class Jetpack_Plan {
17		/**
18		* A cache variable to hold the active plan for the current request.
19		*
20		* @var array
21		*/
22		private static $active_plan_cache;
23
24		const PLAN_OPTION = 'jetpack_active_plan';
25
26		/**
27		* Given a response to the `/sites/%d` endpoint, will parse the response and attempt to set the
28		* plan from the response.
29		*
30		* @param array $response The response from `/sites/%d`.
31		* @return bool Was the plan successfully updated?
32		*/
33		public static function update_from_sites_response( $response ) {
34		// Bail if there was an error or malformed response.
35		if ( is_wp_error( $response ) \|\| ! is_array( $response ) \|\| ! isset( $response['body'] ) ) {
36		return false;
37		}
38
39		$body = wp_remote_retrieve_body( $response );
40		if ( is_wp_error( $body ) ) {
41		return false;
42		}
43
44		// Decode the results.
45		$results = json_decode( $body, true );
46
47		// Bail if there were no results or plan details returned.
48		if ( ! is_array( $results ) \|\| ! isset( $results['plan'] ) ) {
49		return false;
50		}
51
52		// Store the new plan in an option and return true if updated.
53		$result = update_option( self::PLAN_OPTION, $results['plan'], true );
54		if ( ! $result ) {
55		// If we got to this point, then we know we need to update. So, assume there is an issue
56		// with caching. To fix that issue, we can delete the current option and then update.
57		delete_option( self::PLAN_OPTION );
58		$result = update_option( self::PLAN_OPTION, $results['plan'], true );
59		}
60
61		if ( $result ) {
62		// Reset the cache since we've just updated the plan.
63		self::$active_plan_cache = null;
		0 ignored issues – show Documentation Bug introduced 2019-03-20 21:18 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$active_plan_cache`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
64		}
65
66		return $result;
67		}
68
69		/**
70		* Make an API call to WordPress.com for plan status
71		*
72		* @uses Jetpack_Options::get_option()
73		* @uses Client::wpcom_json_api_request_as_blog()
74		* @uses update_option()
75		*
76		* @access public
77		* @static
78		*
79		* @return bool True if plan is updated, false if no update
80		*/
81		public static function refresh_from_wpcom() {
82		// Make the API request.
83		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
84		$response = Client::wpcom_json_api_request_as_blog( $request, '1.1' );
85
86		return self::update_from_sites_response( $response );
87		}
88
89		/**
90		* Get the plan that this Jetpack site is currently using.
91		*
92		* @uses get_option()
93		*
94		* @access public
95		* @static
96		*
97		* @return array Active Jetpack plan details
98		*/
99		public static function get() {
100		// this can be expensive to compute so we cache for the duration of a request.
101		if ( is_array( self::$active_plan_cache ) && ! empty( self::$active_plan_cache ) ) {
102		return self::$active_plan_cache;
103		}
104
105		$plan = get_option( self::PLAN_OPTION, array() );
106
107		// Set the default options.
108		$plan = wp_parse_args(
109		$plan,
110		array(
111		'product_slug' => 'jetpack_free',
112		'class' => 'free',
113		'features' => array(
114		'active' => array(),
115		),
116		)
117		);
118
119		$supports = array();
120
121		// Define what paid modules are supported by personal plans.
122		$personal_plans = array(
123		'jetpack_personal',
124		'jetpack_personal_monthly',
125		'personal-bundle',
126		'personal-bundle-monthly',
127		'personal-bundle-2y',
128		);
129
130		if ( in_array( $plan['product_slug'], $personal_plans, true ) ) {
131		// special support value, not a module but a separate plugin.
132		$supports[] = 'akismet';
133		$supports[] = 'recurring-payments';
134		$plan['class'] = 'personal';
135		}
136
137		// Define what paid modules are supported by premium plans.
138		$premium_plans = array(
139		'jetpack_premium',
140		'jetpack_premium_monthly',
141		'value_bundle',
142		'value_bundle-monthly',
143		'value_bundle-2y',
144		);
145
146	View Code Duplication	if ( in_array( $plan['product_slug'], $premium_plans, true ) ) {
147		$supports[] = 'akismet';
148		$supports[] = 'recurring-payments';
149		$supports[] = 'simple-payments';
150		$supports[] = 'vaultpress';
151		$supports[] = 'videopress';
152		$plan['class'] = 'premium';
153		}
154
155		// Define what paid modules are supported by professional plans.
156		$business_plans = array(
157		'jetpack_business',
158		'jetpack_business_monthly',
159		'business-bundle',
160		'business-bundle-monthly',
161		'business-bundle-2y',
162		'ecommerce-bundle',
163		'ecommerce-bundle-monthly',
164		'ecommerce-bundle-2y',
165		'vip',
166		);
167
168	View Code Duplication	if ( in_array( $plan['product_slug'], $business_plans, true ) ) {
169		$supports[] = 'akismet';
170		$supports[] = 'recurring-payments';
171		$supports[] = 'simple-payments';
172		$supports[] = 'vaultpress';
173		$supports[] = 'videopress';
174		$plan['class'] = 'business';
175		}
176
177		// get available features.
178		foreach ( Jetpack::get_available_modules() as $module_slug ) {
179		$module = Jetpack::get_module( $module_slug );
180		if ( ! isset( $module ) \|\| ! is_array( $module ) ) {
181		continue;
182		}
183		if ( in_array( 'free', $module['plan_classes'], true ) \|\| in_array( $plan['class'], $module['plan_classes'], true ) ) {
184		$supports[] = $module_slug;
185		}
186		}
187
188		$plan['supports'] = $supports;
189
190		self::$active_plan_cache = $plan;
191
192		return $plan;
193		}
194
195		/**
196		* Determine whether the active plan supports a particular feature
197		*
198		* @uses Jetpack_Plan::get()
199		*
200		* @access public
201		* @static
202		*
203		* @param string $feature The module or feature to check.
204		*
205		* @return bool True if plan supports feature, false if not
206		*/
207		public static function supports( $feature ) {
208		// Search product bypasses plan feature check.
209		if ( 'search' === $feature && (bool) get_option( 'has_jetpack_search_product' ) ) {
210		return true;
211		}
212
213		$plan = self::get();
214
215		// Manually mapping WordPress.com features to Jetpack module slugs.
216		foreach ( $plan['features']['active'] as $wpcom_feature ) {
217		switch ( $wpcom_feature ) {
218		case 'wordads-jetpack':
219		// WordAds are supported for this site.
220		if ( 'wordads' === $feature ) {
221		return true;
222		}
223		break;
224		}
225		}
226
227		if (
228		in_array( $feature, $plan['supports'], true )
229		\|\| in_array( $feature, $plan['features']['active'], true )
230		) {
231		return true;
232		}
233
234		return false;
235		}
236		}
237

Automattic / jetpack

Push — fix/podcast-player-gutter-spac... ( cb45ba )

Jetpack_Plan::refresh_from_wpcom() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like