class.jetpack-plan.php — Jetpack – WP Security, Backup, Speed, & Growth 9.4.1

jetpack / class.jetpack-plan.php

jetpack Last commit date

class.jetpack-plan.php

346 lines

1	<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Handles fetching of the site's plan and products from WordPress.com and caching values 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 site's plan and products 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	/**
25	* The name of the option that will store the site's plan.
26	*
27	* @var string
28	*/
29	const PLAN_OPTION = 'jetpack_active_plan';
30
31	/**
32	* The name of the option that will store the site's products.
33	*
34	* @var string
35	*/
36	const SITE_PRODUCTS_OPTION = 'jetpack_site_products';
37
38	const PLAN_DATA = array(
39	'free' => array(
40	'plans' => array(
41	'jetpack_free',
42	),
43	'supports' => array(
44	'opentable',
45	'calendly',
46	'send-a-message',
47	'social-previews',
48
49	'core/video',
50	'core/cover',
51	'core/audio',
52	),
53	),
54	'personal' => array(
55	'plans' => array(
56	'jetpack_personal',
57	'jetpack_personal_monthly',
58	'personal-bundle',
59	'personal-bundle-monthly',
60	'personal-bundle-2y',
61	),
62	'supports' => array(
63	'akismet',
64	'recurring-payments',
65	'premium-content/container',
66	),
67	),
68	'premium' => array(
69	'plans' => array(
70	'jetpack_premium',
71	'jetpack_premium_monthly',
72	'value_bundle',
73	'value_bundle-monthly',
74	'value_bundle-2y',
75	),
76	'supports' => array(
77	'donations',
78	'simple-payments',
79	'vaultpress',
80	'videopress',
81	),
82	),
83	'security' => array(
84	'plans' => array(
85	'jetpack_security_daily',
86	'jetpack_security_daily_monthly',
87	'jetpack_security_realtime',
88	'jetpack_security_realtime_monthly',
89	),
90	'supports' => array(),
91	),
92	'business' => array(
93	'plans' => array(
94	'jetpack_business',
95	'jetpack_business_monthly',
96	'business-bundle',
97	'business-bundle-monthly',
98	'business-bundle-2y',
99	'ecommerce-bundle',
100	'ecommerce-bundle-monthly',
101	'ecommerce-bundle-2y',
102	'vip',
103	),
104	'supports' => array(),
105	),
106
107	'complete' => array(
108	'plans' => array(
109	'jetpack_complete',
110	'jetpack_complete_monthly',
111	),
112	'supports' => array(),
113	),
114	);
115
116	/**
117	* Given a response to the `/sites/%d` endpoint, will parse the response and attempt to set the
118	* site's plan and products from the response.
119	*
120	* @param array $response The response from `/sites/%d`.
121	* @return bool Was the plan successfully updated?
122	*/
123	public static function update_from_sites_response( $response ) {
124	// Bail if there was an error or malformed response.
125	if ( is_wp_error( $response ) \|\| ! is_array( $response ) \|\| ! isset( $response['body'] ) ) {
126	return false;
127	}
128
129	$body = wp_remote_retrieve_body( $response );
130	if ( is_wp_error( $body ) ) {
131	return false;
132	}
133
134	// Decode the results.
135	$results = json_decode( $body, true );
136
137	if ( ! is_array( $results ) ) {
138	return false;
139	}
140
141	if ( isset( $results['products'] ) ) {
142	// Store the site's products in an option and return true if updated.
143	self::store_data_in_option( self::SITE_PRODUCTS_OPTION, $results['products'] );
144	}
145
146	if ( ! isset( $results['plan'] ) ) {
147	return false;
148	}
149
150	$current_plan = get_option( self::PLAN_OPTION, array() );
151
152	if ( ! empty( $current_plan ) && $current_plan === $results['plan'] ) {
153	// Bail if the plans array hasn't changed.
154	return false;
155	}
156
157	// Store the new plan in an option and return true if updated.
158	$result = self::store_data_in_option( self::PLAN_OPTION, $results['plan'] );
159
160	if ( $result ) {
161	// Reset the cache since we've just updated the plan.
162	self::$active_plan_cache = null;
163	}
164
165	return $result;
166	}
167
168	/**
169	* Store data in an option.
170	*
171	* @param string $option The name of the option that will store the data.
172	* @param array $data Data to be store in an option.
173	* @return bool Were the subscriptions successfully updated?
174	*/
175	private static function store_data_in_option( $option, $data ) {
176	$result = update_option( $option, $data, true );
177
178	// If something goes wrong with the update, so delete the current option and then update it.
179	if ( ! $result ) {
180	delete_option( $option );
181	$result = update_option( $option, $data, true );
182	}
183
184	return $result;
185	}
186
187	/**
188	* Make an API call to WordPress.com for plan status
189	*
190	* @uses Jetpack_Options::get_option()
191	* @uses Client::wpcom_json_api_request_as_blog()
192	* @uses update_option()
193	*
194	* @access public
195	* @static
196	*
197	* @return bool True if plan is updated, false if no update
198	*/
199	public static function refresh_from_wpcom() {
200	// Make the API request.
201	$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
202	$response = Client::wpcom_json_api_request_as_blog( $request, '1.1' );
203
204	return self::update_from_sites_response( $response );
205	}
206
207	/**
208	* Get the plan that this Jetpack site is currently using.
209	*
210	* @uses get_option()
211	*
212	* @access public
213	* @static
214	*
215	* @return array Active Jetpack plan details
216	*/
217	public static function get() {
218	// this can be expensive to compute so we cache for the duration of a request.
219	if ( is_array( self::$active_plan_cache ) && ! empty( self::$active_plan_cache ) ) {
220	return self::$active_plan_cache;
221	}
222
223	$plan = get_option( self::PLAN_OPTION, array() );
224
225	// Set the default options.
226	$plan = wp_parse_args(
227	$plan,
228	array(
229	'product_slug' => 'jetpack_free',
230	'class' => 'free',
231	'features' => array(
232	'active' => array(),
233	),
234	)
235	);
236
237	list( $plan['class'], $supports ) = self::get_class_and_features( $plan['product_slug'] );
238
239	// get available features.
240	foreach ( Jetpack::get_available_modules() as $module_slug ) {
241	$module = Jetpack::get_module( $module_slug );
242	if ( ! isset( $module ) \|\| ! is_array( $module ) ) {
243	continue;
244	}
245	if ( in_array( 'free', $module['plan_classes'], true ) \|\| in_array( $plan['class'], $module['plan_classes'], true ) ) {
246	$supports[] = $module_slug;
247	}
248	}
249
250	$plan['supports'] = $supports;
251
252	self::$active_plan_cache = $plan;
253
254	return $plan;
255	}
256
257	/**
258	* Get the site's products.
259	*
260	* @uses get_option()
261	*
262	* @access public
263	* @static
264	*
265	* @return array Active Jetpack products
266	*/
267	public static function get_products() {
268	return get_option( self::SITE_PRODUCTS_OPTION, array() );
269	}
270
271	/**
272	* Get the class of plan and a list of features it supports
273	*
274	* @param string $plan_slug The plan that we're interested in.
275	* @return array Two item array, the plan class and the an array of features.
276	*/
277	private static function get_class_and_features( $plan_slug ) {
278	$features = array();
279	foreach ( self::PLAN_DATA as $class => $details ) {
280	$features = array_merge( $features, $details['supports'] );
281	if ( in_array( $plan_slug, $details['plans'], true ) ) {
282	return array( $class, $features );
283	}
284	}
285	return array( 'free', self::PLAN_DATA['free']['supports'] );
286	}
287
288	/**
289	* Gets the minimum plan slug that supports the given feature
290	*
291	* @param string $feature The name of the feature.
292	* @return string\|bool The slug for the minimum plan that supports.
293	* the feature or false if not found
294	*/
295	public static function get_minimum_plan_for_feature( $feature ) {
296	foreach ( self::PLAN_DATA as $details ) {
297	if ( in_array( $feature, $details['supports'], true ) ) {
298	return $details['plans'][0];
299	}
300	}
301	return false;
302	}
303
304	/**
305	* Determine whether the active plan supports a particular feature
306	*
307	* @uses Jetpack_Plan::get()
308	*
309	* @access public
310	* @static
311	*
312	* @param string $feature The module or feature to check.
313	*
314	* @return bool True if plan supports feature, false if not
315	*/
316	public static function supports( $feature ) {
317	// Search product bypasses plan feature check.
318	if ( 'search' === $feature && (bool) get_option( 'has_jetpack_search_product' ) ) {
319	return true;
320	}
321
322	$plan = self::get();
323
324	// Manually mapping WordPress.com features to Jetpack module slugs.
325	foreach ( $plan['features']['active'] as $wpcom_feature ) {
326	switch ( $wpcom_feature ) {
327	case 'wordads-jetpack':
328	// WordAds are supported for this site.
329	if ( 'wordads' === $feature ) {
330	return true;
331	}
332	break;
333	}
334	}
335
336	if (
337	in_array( $feature, $plan['supports'], true )
338	\|\| in_array( $feature, $plan['features']['active'], true )
339	) {
340	return true;
341	}
342
343	return false;
344	}
345	}
346