@return boolean */ public static function has_trial_support() { return false; } /** * Checks whether the product can be upgraded to a different product. * * @return boolean */ public static function is_upgradable() { return ! static::has_paid_plan_for_product() && ! static::is_bundle_product(); } /** * Checks whether product is a bundle. * * @return boolean True if product is a bundle. Otherwise, False. */ public static function is_bundle_product() { return false; } /** * Check whether the product is upgradable * by a product bundle. * * @return boolean|array Bundles list or False if not upgradable by a bundle. */ public static function is_upgradable_by_bundle() { return false; } /** * In case it's a bundle product, * return all the products it contains. * Empty array by default. * * @return array Product slugs */ public static function get_supported_products() { return array(); } /** * Determine if the product is owned or not * An owned product is defined as a product that is any of the following * - Active * - Has historically been active * - The user has a plan that includes the product * - The user has the standalone plugin for the product installed * * @return boolean */ public static function is_owned() { $historically_active_modules = Jetpack_Options::get_option( 'historically_active_modules', array() ); $standalone_info = static::get_standalone_info(); if ( ( static::is_active() && Jetpack_Options::get_option( 'id' ) ) || $standalone_info['is_standalone_installed'] || in_array( static::$slug, $historically_active_modules, true ) || static::has_any_plan_for_product() ) { return true; } return false; } /** * Undocumented function * * @return string */ public static function get_status() { if ( ! static::is_plugin_installed() ) { $status = Products::STATUS_PLUGIN_ABSENT; if ( static::has_paid_plan_for_product() ) { $status = Products::STATUS_PLUGIN_ABSENT_WITH_PLAN; } } elseif ( static::is_active() ) { $status = Products::STATUS_ACTIVE; // We only consider missing site & user connection an error when the Product is active. if ( static::$requires_site_connection && ! ( new Connection_Manager() )->is_connected() ) { // Site has never been connected before if ( ! Jetpack_Options::get_option( 'id' ) && ! static::is_owned() ) { $status = Products::STATUS_NEEDS_FIRST_SITE_CONNECTION; } else { $status = Products::STATUS_SITE_CONNECTION_ERROR; } } elseif ( static::$requires_user_connection && ! ( new Connection_Manager() )->has_connected_owner() ) { $status = Products::STATUS_USER_CONNECTION_ERROR; } elseif ( static::has_paid_plan_for_product() ) { $needs_attention = static::does_module_need_attention(); if ( ! empty( $needs_attention ) && is_array( $needs_attention ) ) { $status = Products::STATUS_NEEDS_ATTENTION__WARNING; if ( isset( $needs_attention['type'] ) && 'error' === $needs_attention['type'] ) { $status = Products::STATUS_NEEDS_ATTENTION__ERROR; } } if ( static::is_paid_plan_expired() ) { $status = Products::STATUS_EXPIRED; } elseif ( static::is_paid_plan_expiring() ) { $status = Products::STATUS_EXPIRING_SOON; } } elseif ( static::is_upgradable() ) { $status = Products::STATUS_CAN_UPGRADE; } // Check specifically for inactive modules, which will prevent a product from being active } elseif ( static::$module_name && ! static::is_module_active() ) { $status = Products::STATUS_MODULE_DISABLED; // If there is not a plan associated with the disabled module, encourage a plan first // Getting a plan set up should help resolve any connection issues // However if the standalone plugin for this product is active, then we will defer to showing errors that prevent the module from being active // This is because if a standalone plugin is installed, we expect the product to not show as "inactive" on My Jetpack if ( static::$requires_plan || ( ! static::has_any_plan_for_product() && static::$has_standalone_plugin && ! self::is_plugin_active() ) ) { $status = static::is_owned() && static::$has_free_offering && ! static::$requires_plan ? Products::STATUS_NEEDS_ACTIVATION : Products::STATUS_NEEDS_PLAN; } elseif ( static::$requires_site_connection && ! ( new Connection_Manager() )->is_connected() ) { // Site has never been connected before and product is not owned if ( ! Jetpack_Options::get_option( 'id' ) && ! static::is_owned() ) { $status = Products::STATUS_NEEDS_FIRST_SITE_CONNECTION; } else { $status = Products::STATUS_SITE_CONNECTION_ERROR; } } elseif ( static::$requires_user_connection && ! ( new Connection_Manager() )->has_connected_owner() ) { $status = Products::STATUS_USER_CONNECTION_ERROR; } } elseif ( ! static::has_any_plan_for_product() ) { $status = static::is_owned() && static::$has_free_offering && ! static::$requires_plan ? Products::STATUS_NEEDS_ACTIVATION : Products::STATUS_NEEDS_PLAN; } else { $status = Products::STATUS_INACTIVE; } return $status; } /** * Checks whether the Product is active * * @return boolean */ public static function is_active() { return static::is_plugin_active() && ( static::has_any_plan_for_product() || ( ! static::$requires_plan && static::$has_free_offering ) ); } /** * Checks whether the plugin is installed * * @return boolean */ public static function is_plugin_installed() { return (bool) static::get_installed_plugin_filename(); } /** * Checks whether the plugin is active * * @return boolean */ public static function is_plugin_active() { return Plugins_Installer::is_plugin_active( static::get_installed_plugin_filename() ); } /** * Checks whether the Jetpack plugin is installed * * @return boolean */ public static function is_jetpack_plugin_installed() { return (bool) static::get_installed_plugin_filename( 'jetpack' ); } /** * Checks whether the Jetpack plugin is active * * @return boolean */ public static function is_jetpack_plugin_active() { return Plugins_Installer::is_plugin_active( static::get_installed_plugin_filename( 'jetpack' ) ); } /** * Checks whether the Jetpack module is active only if a module_name is defined * * @return bool */ public static function is_module_active() { if ( static::$module_name ) { return ( new Modules() )->is_active( static::$module_name ); } return true; } /** * Activates the plugin * * @return null|WP_Error Null on success, WP_Error on invalid file. */ public static function activate_plugin() { return activate_plugin( static::get_installed_plugin_filename() ); } /** * Perform the top level activation routines, which is installing and activating the required plugin * * @return bool|WP_Error */ private static function do_activation() { if ( static::is_active() ) { return true; } // Default to installing the standalone plugin for the product if ( ! self::is_plugin_installed() ) { $installed = Plugins_Installer::install_plugin( static::get_plugin_slug() ); if ( is_wp_error( $installed ) ) { return $installed; } } if ( ! current_user_can( 'activate_plugins' ) ) { return new WP_Error( 'not_allowed', __( 'You are not allowed to activate plugins on this site.', 'jetpack-my-jetpack' ) ); } $result = static::activate_plugin(); if ( is_wp_error( $result ) ) { return $result; } return true; } /** * Activates the product by installing and activating its plugin * * @return boolean|WP_Error */ final public static function activate() { $result = self::do_activation(); $result = static::do_product_specific_activation( $result ); $product_slug = static::$slug; /** * Fires after My Jetpack activates a product and filters the result * Use this filter to run additional routines for a product activation on stand-alone plugins * * @param bool|WP_Error $result The result of the previous steps of activation. */ $result = apply_filters( "my_jetpack_{$product_slug}_activation", $result ); return $result; } /** * Override this method to perform product specific activation routines. * * @param bool|WP_Error $current_result Is the result of the top level activation actions. You probably won't do anything if it is an WP_Error. * @return bool|WP_Error */ public static function do_product_specific_activation( $current_result ) { return $current_result; } /** * Deactivate the product * * @return boolean */ public static function deactivate() { deactivate_plugins( static::get_installed_plugin_filename() ); return true; } /** * Returns filtered Jetpack plugin actions links. * * @param array $actions - Jetpack plugin action links. * @return array Filtered Jetpack plugin actions links. */ public static function get_plugin_actions_links( $actions ) { // My Jetpack action link. $my_jetpack_home_link = array( 'jetpack-home' => sprintf( '%2$s', admin_url( 'admin.php?page=my-jetpack' ), __( 'My Jetpack', 'jetpack-my-jetpack' ), __( 'My Jetpack dashboard', 'jetpack-my-jetpack' ) ), ); // Otherwise, add it to the beginning of the array. return array_merge( $my_jetpack_home_link, $actions ); } /** * Filter the action links for the plugins specified. * * @param string|string[] $filenames The plugin filename(s) to filter the action links for. */ private static function filter_action_links( $filenames ) { foreach ( $filenames as $filename ) { $hook = 'plugin_action_links_' . $filename; $callback = array( static::class, 'get_plugin_actions_links' ); if ( ! has_filter( $hook, $callback ) ) { add_filter( $hook, $callback, 20, 2 ); } } } /** * Extend the plugin action links. */ public static function extend_plugin_action_links() { $filenames = static::get_plugin_filename(); if ( ! is_array( $filenames ) ) { $filenames = array( $filenames ); } self::filter_action_links( $filenames ); } /** * Extend the Jetpack plugin action links. */ public static function extend_core_plugin_action_links() { $filenames = self::JETPACK_PLUGIN_FILENAME; self::filter_action_links( $filenames ); } /** * Install and activate the standalone plugin in the case it's missing. * * @return boolean|WP_Error */ public static function install_and_activate_standalone() { /** * Check for the presence of the standalone plugin, ignoring Jetpack presence. * * If the standalone plugin is not installed and the user can install plugins, proceed with the installation. */ if ( ! static::is_plugin_installed() ) { /** * Check for permissions */ if ( ! current_user_can( 'install_plugins' ) ) { return new WP_Error( 'not_allowed', __( 'You are not allowed to install plugins on this site.', 'jetpack-my-jetpack' ) ); } /** * Install the plugin */ $installed = Plugins_Installer::install_plugin( static::get_plugin_slug() ); if ( is_wp_error( $installed ) ) { return $installed; } } /** * Activate the installed plugin */ $result = static::activate_plugin(); if ( is_wp_error( $result ) ) { return $result; } return true; } /** * Determines whether the module/plugin/product needs the users attention. * Typically due to some sort of error where user troubleshooting is needed. * * @return boolean */ public static function does_module_need_attention() { return false; } }