Prevent module activation when plan doesn't support them (#8983)

* Deactivate search when downgrading Jetpack plan * Centralise active plan checking and use all modules in 'supports' list * Add 'free' to plan classes, always * Fix bug showing correct plan support in premium * Return better error message via API * Remove rogue error_log * Fix typo * Fix spacing
Automattic · Mar 7, 2018 · d2fc8b9 · d2fc8b9
1 parent 00716b4
commit d2fc8b9
Show file tree

Hide file tree

Showing 11 changed files with 74 additions and 43 deletions.
diff --git a/_inc/lib/admin-pages/class.jetpack-admin-page.php b/_inc/lib/admin-pages/class.jetpack-admin-page.php
@@ -211,15 +211,15 @@ function check_plan_deactivate_modules( $page ) {
 				$active = Jetpack::get_active_modules();
 				switch ( $current->plan->product_slug ) {
 					case 'jetpack_free':
-						$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads' );
+						$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads', 'search' );
 						break;
 					case 'jetpack_personal':
 					case 'jetpack_personal_monthly':
-						$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads' );
+						$to_deactivate = array( 'seo-tools', 'videopress', 'google-analytics', 'wordads', 'search' );
 						break;
 					case 'jetpack_premium':
 					case 'jetpack_premium_monthly':
-						$to_deactivate = array( 'seo-tools', 'google-analytics' );
+						$to_deactivate = array( 'seo-tools', 'google-analytics', 'search' );
 						break;
 				}
 				$to_deactivate = array_intersect( $active, $to_deactivate );

diff --git a/_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php b/_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php
@@ -67,6 +67,14 @@ public function activate_module( $request ) {
 			);
 		}
 
+		if ( ! Jetpack::active_plan_supports( $module_slug ) ) {
+			return new WP_Error(
+				'not_supported',
+				esc_html__( 'The requested Jetpack module is not supported by your plan.', 'jetpack' ),
+				array( 'status' => 424 )
+			);
+		}
+
 		if ( Jetpack::activate_module( $module_slug, false, false ) ) {
 			return rest_ensure_response( array(
 				'code' 	  => 'success',

diff --git a/class.jetpack-admin.php b/class.jetpack-admin.php
@@ -184,7 +184,12 @@ static function is_module_available( $module ) {
 		if ( Jetpack::is_development_mode() ) {
 			return ! ( $module['requires_connection'] );
 		} else {
-			return Jetpack::is_active();
+			if ( ! Jetpack::is_active() ) {
+				return false;
+			}
+
+			$plan = Jetpack::get_active_plan();
+			return in_array( $module['module'], $plan['supports'] );
 		}
 	}
 

diff --git a/class.jetpack-cli.php b/class.jetpack-cli.php
@@ -362,8 +362,11 @@ public function module( $args, $assoc_args ) {
 			case 'activate':
 				$module = Jetpack::get_module( $module_slug );
 				Jetpack::log( 'activate', $module_slug );
-				Jetpack::activate_module( $module_slug, false, false );
-				WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) );
+				if ( Jetpack::activate_module( $module_slug, false, false ) ) {
+					WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) );
+				} else {
+					WP_CLI::error( sprintf( __( '%s could not be activated.', 'jetpack' ), $module['name'] ) );
+				}
 				break;
 			case 'activate_all':
 				$modules = Jetpack::get_available_modules();

diff --git a/class.jetpack-modules-list-table.php b/class.jetpack-modules-list-table.php
@@ -174,17 +174,6 @@ function filter_displayed_table_items( $modules ) {
 		return array_filter( $modules, array( $this, 'is_module_displayed' ) );
 	}
 
-	static function is_module_available( $module ) {
-		if ( ! is_array( $module ) || empty( $module ) )
-			return false;
-
-		if ( Jetpack::is_development_mode() ) {
-			return ! ( $module['requires_connection'] );
-		} else {
-			return Jetpack::is_active();
-		}
-	}
-
 	static function is_module_displayed( $module ) {
 		// Handle module tag based filtering.
 		if ( ! empty( $_REQUEST['module_tag'] ) ) {
@@ -231,8 +220,9 @@ function single_row( $item ) {
 		if ( ! empty( $item['activated'] )  )
 			$row_class .= ' active';
 
-		if ( ! $this->is_module_available( $item ) )
+		if ( ! Jetpack_Admin::is_module_available( $item ) ) {
 			$row_class .= ' unavailable';
+		}
 
 		echo '<tr class="jetpack-module' . esc_attr( $row_class ) . '" id="' . esc_attr( $item['module'] ) . '">';
 		$this->single_row_columns( $item );
@@ -244,7 +234,7 @@ function get_table_classes() {
 	}
 
 	function column_cb( $item ) {
-		if ( ! $this->is_module_available( $item ) )
+		if ( ! Jetpack_Admin::is_module_available( $item ) )
 			return '';
 
 		return sprintf( '<input type="checkbox" name="modules[]" value="%s" />', $item['module'] );
@@ -273,7 +263,7 @@ function column_name( $item ) {
 			$actions['configure'] = $item['configurable'];
 		}
 
-		if ( empty( $item['activated'] ) && $this->is_module_available( $item ) ) {
+		if ( empty( $item['activated'] ) && Jetpack_Admin::is_module_available( $item ) ) {
 			$url = wp_nonce_url(
 				Jetpack::admin_url( array(
 					'page'   => 'jetpack',

diff --git a/class.jetpack.php b/class.jetpack.php
@@ -1452,6 +1452,13 @@ public static function refresh_active_plan_from_wpcom() {
 	 * @return array Active Jetpack plan details
 	 */
 	public static function get_active_plan() {
+		global $active_plan_cache;
+
+		// this can be expensive to compute so we cache for the duration of a request
+		if ( $active_plan_cache ) {
+			return $active_plan_cache;
+		}
+
 		$plan = get_option( 'jetpack_active_plan', array() );
 
 		// Set the default options
@@ -1463,6 +1470,8 @@ public static function get_active_plan() {
 			) );
 		}
 
+		$supports = array();
+
 		// Define what paid modules are supported by personal plans
 		$personal_plans = array(
 			'jetpack_personal',
@@ -1471,9 +1480,8 @@ public static function get_active_plan() {
 		);
 
 		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
-			$plan['supports'] = array(
-				'akismet',
-			);
+			// special support value, not a module but a separate plugin
+			$supports[] = 'akismet';
 			$plan['class'] = 'personal';
 		}
 
@@ -1485,12 +1493,8 @@ public static function get_active_plan() {
 		);
 
 		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
-			$plan['supports'] = array(
-				'videopress',
-				'akismet',
-				'vaultpress',
-				'wordads',
-			);
+			$supports[] = 'akismet';
+			$supports[] = 'vaultpress';
 			$plan['class'] = 'premium';
 		}
 
@@ -1503,23 +1507,23 @@ public static function get_active_plan() {
 		);
 
 		if ( in_array( $plan['product_slug'], $business_plans ) ) {
-			$plan['supports'] = array(
-				'videopress',
-				'akismet',
-				'vaultpress',
-				'seo-tools',
-				'google-analytics',
-				'wordads',
-				'search',
-			);
+			$supports[] = 'akismet';
+			$supports[] = 'vaultpress';
 			$plan['class'] = 'business';
 		}
 
-		// Make sure we have an array here in the event database data is stale
-		if ( ! isset( $plan['supports'] ) ) {
-			$plan['supports'] = array();
+		// get available features
+		foreach ( self::get_available_modules() as $module_slug ) {
+			$module = self::get_module( $module_slug );
+			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
+				$supports[] = $module_slug;
+			}
 		}
 
+		$plan['supports'] = $supports;
+
+		$active_plan_cache = $plan;
+
 		return $plan;
 	}
 
@@ -2411,6 +2415,7 @@ public static function get_module( $module ) {
 			'module_tags'               => 'Module Tags',
 			'feature'                   => 'Feature',
 			'additional_search_queries' => 'Additional Search Queries',
+			'plan_classes'              => 'Plans',
 		);
 
 		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
@@ -2440,6 +2445,13 @@ public static function get_module( $module ) {
 			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
 		}
 
+		if ( $mod['plan_classes'] ) {
+			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
+			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
+		} else {
+			$mod['plan_classes'] = array( 'free' );
+		}
+
 		if ( $mod['feature'] ) {
 			$mod['feature'] = explode( ',', $mod['feature'] );
 			$mod['feature'] = array_map( 'trim', $mod['feature'] );
@@ -2840,6 +2852,12 @@ public static function activate_module( $module, $exit = true, $redirect = true
 			}
 		}
 
+		$plan = Jetpack::get_active_plan();
+
+		if ( ! in_array( $module, $plan['supports'] ) ) {
+			return false;
+		}
+
 		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
 		Jetpack::state( 'module', $module );
 		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
@@ -2876,7 +2894,7 @@ public static function activate_module( $module, $exit = true, $redirect = true
 	}
 
 	function activate_module_actions( $module ) {
-		_deprecated_function( __METHOD__, 'jeptack-4.2' );
+		_deprecated_function( __METHOD__, 'jetpack-4.2' );
 	}
 
 	public static function deactivate_module( $module ) {
@@ -4033,7 +4051,9 @@ function admin_page_load() {
 				$module = stripslashes( $_GET['module'] );
 				check_admin_referer( "jetpack_activate-$module" );
 				Jetpack::log( 'activate', $module );
-				Jetpack::activate_module( $module );
+				if ( ! Jetpack::activate_module( $module ) ) {
+					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
+				}
 				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
 				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
 				exit;

diff --git a/modules/google-analytics.php b/modules/google-analytics.php
@@ -9,6 +9,7 @@
  * Auto Activate: No
  * Feature: Engagement
  * Additional Search Queries: webmaster, google, analytics, console
+ * Plans: business
  */
 
 include dirname( __FILE__ ) . "/google-analytics/wp-google-analytics.php";
diff --git a/modules/search.php b/modules/search.php
@@ -10,6 +10,7 @@
  * Auto Activate: No
  * Feature: Search
  * Additional Search Queries: search
+ * Plans: business
  */
 
 require_once( dirname( __FILE__ ) . '/search/class.jetpack-search.php' );

diff --git a/modules/seo-tools.php b/modules/seo-tools.php
@@ -10,6 +10,7 @@
  * Module Tags: Social, Appearance
  * Feature: Traffic
  * Additional Search Queries: search engine optimization, social preview, meta description, custom title format
+ * Plans: business
  */
 
 include dirname( __FILE__ ) . '/seo-tools/jetpack-seo.php';

diff --git a/modules/videopress.php b/modules/videopress.php
@@ -9,6 +9,7 @@
  * Module Tags: Photos and Videos
  * Feature: Writing
  * Additional Search Queries: video, videos, videopress
+ * Plans: business, premium
  */
 
 include_once dirname( __FILE__ ) . '/videopress/utility-functions.php';

diff --git a/modules/wordads.php b/modules/wordads.php
@@ -8,6 +8,7 @@
  * Auto Activate: No
  * Module Tags: Traffic, Appearance
  * Additional Search Queries: advertising, ad codes, ads
+ * Plans: premium, business
  */
 
 function jetpack_load_wordads() {