Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
16.51%
18 / 109
9.09%
1 / 11
 CRAP
0.00%
0 / 1
Jetpack_React_Page
14.95%
16 / 107
9.09%
1 / 11
 1290.66
0.00%
0 / 1
 get_page_hook
0.00%
0 / 2
0.00%
0 / 1
 2
 add_page_actions
0.00%
0 / 17
0.00%
0 / 1
 56
 remove_jetpack_menu
0.00%
0 / 8
0.00%
0 / 1
 42
 can_access_settings
36.84%
7 / 19
0.00%
0 / 1
 48.28
 jetpack_add_settings_sub_nav_item
100.00%
9 / 9
100.00%
1 / 1
 2
 add_fallback_head_meta
0.00%
0 / 1
0.00%
0 / 1
 2
 add_noscript_head_meta
0.00%
0 / 3
0.00%
0 / 1
 2
 page_render
0.00%
0 / 8
0.00%
0 / 1
 6
 react_redirects
0.00%
0 / 9
0.00%
0 / 1
 20
 additional_styles
0.00%
0 / 1
0.00%
0 / 1
 2
 page_admin_scripts
0.00%
0 / 30
0.00%
0 / 1
 72
1<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3use Automattic\Jetpack\Admin_UI\Admin_Menu;
4use Automattic\Jetpack\Assets\Logo;
5use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
6use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7use Automattic\Jetpack\Publicize\Publicize_Script_Data;
8use Automattic\Jetpack\Status;
9
10require_once __DIR__ . '/class.jetpack-admin-page.php';
11require_once __DIR__ . '/class-jetpack-redux-state-helper.php';
12
13/**
14 * Builds the landing page and its menu.
15 */
16class Jetpack_React_Page extends Jetpack_Admin_Page {
17    /**
18     * Show the landing page only when Jetpack is connected.
19     *
20     * @var bool
21     */
22    protected $dont_show_if_not_active = false;
23
24    /**
25     * Used for fallback when REST API is disabled.
26     *
27     * @var bool
28     */
29    protected $is_redirecting = false;
30
31    /**
32     * Add the main admin Jetpack menu.
33     *
34     * @return string|false Return value from WordPress's `add_menu_page()`.
35     */
36    public function get_page_hook() {
37        $icon = ( new Logo() )->get_base64_logo();
38        return add_menu_page( 'Jetpack', 'Jetpack', 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), $icon, 3 );
39    }
40
41    /**
42     * Add page action.
43     *
44     * @param string $hook Hook of current page.
45     * @return void
46     */
47    public function add_page_actions( $hook ) {
48        /** This action is documented in class.jetpack-admin.php */
49        do_action( 'jetpack_admin_menu', $hook );
50
51        if ( ! isset( $_GET['page'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
52            return;
53        }
54        $page = sanitize_text_field( wp_unslash( $_GET['page'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
55        if ( 'jetpack' !== $page ) {
56            if ( strpos( $page, 'jetpack/' ) === 0 ) {
57                $section = substr( $page, 8 );
58                wp_safe_redirect( admin_url( 'admin.php?page=jetpack#/' . $section ) );
59                exit( 0 );
60            }
61            return; // No need to handle the fallback redirection if we are not on the Jetpack page.
62        }
63
64        // Adding a redirect meta tag if the REST API is disabled.
65        if ( ! $this->is_rest_api_enabled() ) {
66            $this->is_redirecting = true;
67            add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
68        }
69
70        // Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled.
71        add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
72
73        // If this is the first time the user is viewing the admin, don't show JITMs.
74        // This filter is added just in time because this function is called on admin_menu
75        // and JITMs are initialized on admin_init.
76        if ( Jetpack::is_connection_ready() && ! Jetpack_Options::get_option( 'first_admin_view', false ) ) {
77            Jetpack_Options::update_option( 'first_admin_view', true );
78            add_filter( 'jetpack_just_in_time_msgs', '__return_false' );
79        }
80    }
81
82    /**
83     * Remove the main Jetpack submenu if a site is in offline mode or connected
84     * or if My Jetpack is available.
85     * At that point, admins can access the Jetpack Dashboard instead.
86     *
87     * @since 13.8
88     */
89    public function remove_jetpack_menu() {
90        $is_offline_mode = ( new Status() )->is_offline_mode();
91        $has_my_jetpack  = (
92            class_exists( 'Automattic\Jetpack\My_Jetpack\Initializer' ) &&
93            method_exists( 'Automattic\Jetpack\My_Jetpack\Initializer', 'should_initialize' ) &&
94            \Automattic\Jetpack\My_Jetpack\Initializer::should_initialize()
95        );
96
97        if ( $is_offline_mode || $has_my_jetpack || Jetpack::is_connection_ready() ) {
98            remove_submenu_page( 'jetpack', 'jetpack' );
99        }
100    }
101
102    /**
103     * Determine whether a user can access the Jetpack Settings page.
104     *
105     * Rules are:
106     * - user is allowed to see the Jetpack Admin
107     * - site is connected or in offline mode
108     * - non-admins only need access to the settings when there are modules they can manage.
109     *
110     * @return bool $can_access_settings Can the user access settings.
111     */
112    private function can_access_settings() {
113        $connection = new Connection_Manager( 'jetpack' );
114        $status     = new Status();
115
116        // User must have the necessary permissions to see the Jetpack settings pages.
117        if ( ! current_user_can( 'edit_posts' ) ) {
118            return false;
119        }
120
121        // In offline mode, allow access to admins.
122        if ( $status->is_offline_mode() && current_user_can( 'manage_options' ) ) {
123            return true;
124        }
125
126        // If not in offline mode but site is not connected, bail.
127        if ( ! Jetpack::is_connection_ready() ) {
128            return false;
129        }
130
131        /*
132         * Additional checks for non-admins.
133        */
134        if ( ! current_user_can( 'manage_options' ) ) {
135            // If the site isn't connected at all, bail.
136            if ( ! $connection->has_connected_owner() ) {
137                return false;
138            }
139
140            /*
141             * If they haven't connected their own account yet,
142             * they have no use for the settings page.
143             * They will not be able to manage any settings.
144             */
145            if ( ! $connection->is_user_connected() ) {
146                return false;
147            }
148
149            /*
150             * Non-admins only have access to settings
151             * for the following modules:
152             * - Publicize
153             * - Post By Email
154             * If those modules are not available, bail.
155             */
156            if (
157                ! Jetpack::is_module_active( 'post-by-email' )
158                    && (
159                        Publicize_Script_Data::has_feature_flag( 'admin-page' ) ||
160                        ! Jetpack::is_module_active( 'publicize' ) ||
161                        ! current_user_can( 'publish_posts' )
162                    )
163            ) {
164                return false;
165            }
166        }
167
168        // fallback.
169        return true;
170    }
171
172    /**
173     * Jetpack Settings sub-link.
174     *
175     * @since 4.3.0
176     * @since 9.7.0 If Connection does not have an owner, restrict it to admins
177     */
178    public function jetpack_add_settings_sub_nav_item() {
179        if ( $this->can_access_settings() ) {
180            Admin_Menu::add_menu(
181                __( 'Settings', 'jetpack' ),
182                __( 'Settings', 'jetpack' ),
183                'jetpack_admin_page',
184                Jetpack::admin_url( array( 'page' => 'jetpack#/settings' ) ),
185                null,
186                13
187            );
188        }
189    }
190
191    /**
192     * Fallback redirect meta tag if the REST API is disabled.
193     *
194     * @return void
195     */
196    public function add_fallback_head_meta() {
197        echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
198    }
199
200    /**
201     * Fallback meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled.
202     *
203     * @return void
204     */
205    public function add_noscript_head_meta() {
206        echo '<noscript>';
207        $this->add_fallback_head_meta();
208        echo '</noscript>';
209    }
210
211    /**
212     * Add action to render page specific HTML.
213     *
214     * @return void
215     */
216    public function page_render() {
217        /** This action is already documented in class.jetpack-admin-page.php */
218        do_action( 'jetpack_notices' );
219
220        // Fetch static.html.
221        $static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' ); //phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, Not fetching a remote file.
222
223        if ( false === $static_html ) {
224
225            // If we still have nothing, display an error.
226            echo '<p>';
227            esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
228            echo '<code>pnpm run distclean && pnpm jetpack build plugins/jetpack</code>';
229            echo '</p>';
230        } else {
231            // We got the static.html so let's display it.
232            echo $static_html; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
233        }
234    }
235    /**
236     * Allow robust deep links to React.
237     *
238     * The Jetpack dashboard requires fragments/hash values to make
239     * a deep link to it but passing fragments as part of a return URL
240     * will most often be discarded throughout the process.
241     * This logic aims to bridge this gap and reduce the chance of React
242     * specific links being broken while passing them along.
243     */
244    public function react_redirects() {
245        global $pagenow;
246
247        // phpcs:ignore WordPress.Security.NonceVerification.Recommended
248        if ( 'admin.php' !== $pagenow || ! isset( $_GET['jp-react-redirect'] ) ) {
249            return;
250        }
251
252        $allowed_paths = array(
253            'product-purchased' => admin_url( '/admin.php?page=jetpack#/recommendations/product-purchased' ),
254        );
255
256        // phpcs:ignore WordPress.Security.NonceVerification.Recommended
257        $target = sanitize_text_field( wp_unslash( $_GET['jp-react-redirect'] ) );
258        if ( isset( $allowed_paths[ $target ] ) ) {
259            wp_safe_redirect( $allowed_paths[ $target ] );
260            exit( 0 );
261        }
262    }
263
264    /**
265     * Load styles for static page.
266     */
267    public function additional_styles() {
268        Jetpack_Admin_Page::load_wrapper_styles();
269    }
270
271    /**
272     * Load admin page scripts.
273     */
274    public function page_admin_scripts() {
275        if ( $this->is_redirecting ) {
276            return; // No need for scripts on a fallback page.
277        }
278
279        $status              = new Status();
280        $is_offline_mode     = $status->is_offline_mode();
281        $site_suffix         = $status->get_site_suffix();
282        $script_deps_path    = JETPACK__PLUGIN_DIR . '_inc/build/admin.asset.php';
283        $script_dependencies = array( 'jquery', 'wp-polyfill' );
284        $version             = JETPACK__VERSION;
285        if ( file_exists( $script_deps_path ) ) {
286            $asset_manifest      = include $script_deps_path;
287            $script_dependencies = $asset_manifest['dependencies'];
288            $version             = $asset_manifest['version'];
289        }
290
291        $blog_id_prop = '';
292        if ( ! defined( 'IS_WPCOM' ) || ! IS_WPCOM ) {
293            $blog_id = Connection_Manager::get_site_id( true );
294            if ( $blog_id ) {
295                $blog_id_prop = ', currentBlogID: "' . (int) $blog_id . '"';
296            }
297        }
298
299        wp_enqueue_script(
300            'react-plugin',
301            plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ),
302            $script_dependencies,
303            $version,
304            true
305        );
306
307        if ( ! $is_offline_mode && Jetpack::is_connection_ready() ) {
308            // Required for Analytics.
309            wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
310        }
311
312        wp_set_script_translations( 'react-plugin', 'jetpack' );
313
314        // Add objects to be passed to the initial state of the app.
315        // Use wp_add_inline_script instead of wp_localize_script, see https://core.trac.wordpress.org/ticket/25280.
316        wp_add_inline_script( 'react-plugin', 'var Initial_State=JSON.parse(decodeURIComponent("' . rawurlencode( wp_json_encode( Jetpack_Redux_State_Helper::get_initial_state() ) ) . '"));', 'before' );
317
318        // This will set the default URL of the jp_redirects lib.
319        wp_add_inline_script( 'react-plugin', 'var jetpack_redirects = { currentSiteRawUrl: "' . $site_suffix . '"' . $blog_id_prop . ' };', 'before' );
320
321        // Adds Connection package initial state.
322        Connection_Initial_State::render_script( 'react-plugin' );
323    }
324}