Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
59.57%
28 / 47
66.67%
6 / 9
 CRAP
0.00%
0 / 1
Hybrid_Product
60.00%
27 / 45
66.67%
6 / 9
 97.54
0.00%
0 / 1
 is_plugin_installed
100.00%
1 / 1
100.00%
1 / 1
 2
 is_plugin_active
100.00%
1 / 1
100.00%
1 / 1
 2
 is_standalone_plugin_active
100.00%
1 / 1
100.00%
1 / 1
 1
 is_active
100.00%
1 / 1
100.00%
1 / 1
 2
 is_activated
100.00%
1 / 1
100.00%
1 / 1
 3
 activate_plugin
40.00%
2 / 5
0.00%
0 / 1
 4.94
 do_product_specific_activation
26.67%
4 / 15
0.00%
0 / 1
 40.94
 deactivate
100.00%
12 / 12
100.00%
1 / 1
 5
 install_and_activate_standalone
50.00%
4 / 8
0.00%
0 / 1
 8.12
1<?php
2/**
3 * Base product
4 *
5 * @package my-jetpack
6 */
7
8namespace Automattic\Jetpack\My_Jetpack;
9
10use Automattic\Jetpack\Modules;
11use Automattic\Jetpack\Plugins_Installer;
12use WP_Error;
13
14if ( ! defined( 'ABSPATH' ) ) {
15    exit( 0 );
16}
17
18/**
19 * Class responsible for handling the hybrid products
20 *
21 * Hybrid products are those that may work both as a stand-alone plugin or with the Jetpack plugin.
22 */
23abstract class Hybrid_Product extends Product {
24    /**
25     * All hybrid products have a standalone plugin
26     *
27     * @var bool
28     */
29    public static $has_standalone_plugin = true;
30
31    /**
32     * For Hybrid products, we can use either the standalone or Jetpack plugin
33     *
34     * @return bool
35     */
36    public static function is_plugin_installed() {
37        return parent::is_plugin_installed() || parent::is_jetpack_plugin_installed();
38    }
39
40    /**
41     * Checks whether the Product is active
42     *
43     * @return boolean
44     */
45    public static function is_plugin_active() {
46        return parent::is_plugin_active() || parent::is_jetpack_plugin_active();
47    }
48
49    /**
50     * Checks whether the standalone plugin for this product is active
51     *
52     * @return boolean
53     */
54    public static function is_standalone_plugin_active() {
55        return parent::is_plugin_active();
56    }
57
58    /**
59     * Checks whether the Product is active
60     *
61     * @return boolean
62     */
63    public static function is_active() {
64        return parent::is_active() && static::is_module_active();
65    }
66
67    /**
68     * Checks whether the site has switched the product on, whether or not it has a plan for it.
69     *
70     * The standalone plugin being active is enough: off the Jetpack plugin, the module may not be available at all.
71     *
72     * @return boolean
73     */
74    public static function is_activated() {
75        return static::is_standalone_plugin_active() || ( static::is_jetpack_plugin_active() && static::is_module_active() );
76    }
77
78    /**
79     * Activates the plugin
80     *
81     * @return null|WP_Error Null on success, WP_Error on invalid file.
82     */
83    public static function activate_plugin() {
84        /*
85         * Activate self-installed plugin if it's installed.
86         */
87        if ( parent::is_plugin_installed() ) {
88            return activate_plugin( static::get_installed_plugin_filename() );
89        }
90
91        /*
92         * Otherwise, activate Jetpack plugin.
93         */
94        if ( static::is_jetpack_plugin_installed() ) {
95            return activate_plugin( static::get_installed_plugin_filename( 'jetpack' ) );
96        }
97
98        return new WP_Error( 'plugin_not_found', __( 'Activation failed. Plugin is not installed', 'jetpack-my-jetpack' ) );
99    }
100
101    /**
102     * Activates the product. If the Hybrid product has declared a jetpack module name, let's try to activate it if Jetpack plugin is active
103     *
104     * @param bool|WP_Error $product_activation Is the result of the top level activation actions. You probably won't do anything if it is an WP_Error.
105     * @return bool|WP_Error
106     */
107    public static function do_product_specific_activation( $product_activation ) {
108
109        if ( is_wp_error( $product_activation ) ) {
110            // If we failed to install the stand-alone plugin because the package was not found, let's try and install Jetpack plugin instead.
111            // This might happen, for example, while the stand-alone plugin was not released to the WP.org repository yet.
112            if ( 'no_package' === $product_activation->get_error_code() ) {
113                $product_activation = Plugins_Installer::install_plugin( self::JETPACK_PLUGIN_SLUG );
114                if ( ! is_wp_error( $product_activation ) ) {
115                    $product_activation = static::activate_plugin();
116                }
117            }
118            if ( is_wp_error( $product_activation ) ) {
119                return $product_activation;
120            }
121        }
122
123        if ( ! empty( static::$module_name ) ) {
124            // Only activate the module if the plan supports it
125            // We don't want to throw an error for a missing plan here since we try activation before purchase
126            if ( static::$requires_plan && ! static::has_any_plan_for_product() ) {
127                return true;
128            }
129
130            $module_activation = ( new Modules() )->activate( static::$module_name, false, false );
131
132            if ( ! $module_activation ) {
133                return new WP_Error( 'module_activation_failed', __( 'Error activating Jetpack module', 'jetpack-my-jetpack' ) );
134            }
135
136            return $module_activation;
137        }
138
139        return true;
140    }
141
142    /**
143     * Deactivates the product.
144     *
145     * In addition to the parent's plugin deactivation, also deactivates the
146     * matching Jetpack module when `static::$module_name` is set and the
147     * module is saved and active — otherwise Hybrid products activated via
148     * the Jetpack-module path stay half-on after "deactivation".
149     *
150     * @return bool|WP_Error True on success (matches Product::deactivate()),
151     *                       WP_Error if the module deactivation failed.
152     */
153    public static function deactivate() {
154        $result               = parent::deactivate();
155        $modules              = new Modules();
156        $saved_active_modules = (array) \Jetpack_Options::get_option( 'active_modules', array() );
157
158        // Modules::deactivate() can't remove a module only a plugin's filter forces on, nor a saved one that is unavailable.
159        if (
160            ! empty( static::$module_name )
161            && in_array( static::$module_name, $saved_active_modules, true )
162            && $modules->is_active( static::$module_name )
163        ) {
164            if ( ! $modules->deactivate( static::$module_name ) ) {
165                return new WP_Error(
166                    'module_deactivation_failed',
167                    __( 'Error deactivating Jetpack module', 'jetpack-my-jetpack' )
168                );
169            }
170        }
171
172        return $result;
173    }
174
175    /**
176     * Install and activate the standalone plugin in the case it's missing.
177     *
178     * @return boolean|WP_Error
179     */
180    public static function install_and_activate_standalone() {
181        $result = parent::install_and_activate_standalone();
182
183        if ( is_wp_error( $result ) ) {
184            return $result;
185        }
186
187        /**
188         * Activate the module as well, if the user has a plan
189         * or the product does not require a plan to work
190         */
191        if ( static::has_any_plan_for_product() && isset( static::$module_name ) ) {
192            $module_activation = ( new Modules() )->activate( static::$module_name, false, false );
193
194            if ( ! $module_activation ) {
195                return new WP_Error( 'module_activation_failed', __( 'Error activating Jetpack module', 'jetpack-my-jetpack' ) );
196            }
197        }
198
199        return true;
200    }
201}