diff options
Diffstat (limited to 'plugins/jetpack/class.jetpack-plan.php')
| -rw-r--r-- | plugins/jetpack/class.jetpack-plan.php | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/plugins/jetpack/class.jetpack-plan.php b/plugins/jetpack/class.jetpack-plan.php new file mode 100644 index 00000000..99351503 --- /dev/null +++ b/plugins/jetpack/class.jetpack-plan.php @@ -0,0 +1,231 @@ +<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName +/** + * Handles fetching of the site's plan from WordPress.com and caching the value locally. + * + * @package Jetpack + */ + +/** + * 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; + } + + $current_plan = get_option( self::PLAN_OPTION, array() ); + + // If the plans don't differ, then there's nothing to do. + if ( ! empty( $current_plan ) && $current_plan['product_slug'] === $results['plan']['product_slug'] ) { + return false; + } + + // Set flag for newly purchased plan. + if ( 'jetpack_free' !== $results['plan']['product_slug'] ) { + update_option( 'show_welcome_for_new_plan', true ); + } + + // 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 Jetpack_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 = Jetpack_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-2y', + ); + + if ( in_array( $plan['product_slug'], $personal_plans, true ) ) { + // special support value, not a module but a separate plugin. + $supports[] = 'akismet'; + $plan['class'] = 'personal'; + } + + // Define what paid modules are supported by premium plans. + $premium_plans = array( + 'jetpack_premium', + 'jetpack_premium_monthly', + 'value_bundle', + 'value_bundle-2y', + ); + + if ( in_array( $plan['product_slug'], $premium_plans, true ) ) { + $supports[] = 'akismet'; + $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-2y', + 'ecommerce-bundle', + 'ecommerce-bundle-2y', + 'vip', + ); + + if ( in_array( $plan['product_slug'], $business_plans, true ) ) { + $supports[] = 'akismet'; + $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 ) { + $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; + } +} |