Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
24.16%
79 / 327
4.55%
1 / 22
 CRAP
0.00%
0 / 1
Help_Center
24.23%
79 / 326
4.55%
1 / 22
 6174.23
0.00%
0 / 1
 __construct
71.43%
10 / 14
0.00%
0 / 1
 6.84
 calypso_preferences_update
0.00%
0 / 23
0.00%
0 / 1
 42
 determine_iso_639_locale
75.00%
6 / 8
0.00%
0 / 1
 3.14
 jetpack_remove_core_help_tab
0.00%
0 / 2
0.00%
0 / 1
 2
 is_proxied
66.67%
2 / 3
0.00%
0 / 1
 3.33
 init
80.00%
4 / 5
0.00%
0 / 1
 5.20
 get_instance
100.00%
1 / 1
100.00%
1 / 1
 1
 enqueue_script
0.00%
0 / 75
0.00%
0 / 1
 462
 is_menu_panel_enabled
0.00%
0 / 25
0.00%
0 / 1
 90
 get_current_site
93.33%
28 / 30
0.00%
0 / 1
 5.01
 get_help_center_data
93.33%
28 / 30
0.00%
0 / 1
 10.03
 register_rest_api
0.00%
0 / 45
0.00%
0 / 1
 2
 is_admin_bar
0.00%
0 / 1
0.00%
0 / 1
 2
 is_block_editor
0.00%
0 / 3
0.00%
0 / 1
 12
 is_wc_admin_home_page
0.00%
0 / 1
0.00%
0 / 1
 6
 is_jetpack_disconnected
0.00%
0 / 7
0.00%
0 / 1
 20
 is_loading_on_frontend
0.00%
0 / 2
0.00%
0 / 1
 20
 get_help_center_url
0.00%
0 / 4
0.00%
0 / 1
 20
 get_assets_json
0.00%
0 / 7
0.00%
0 / 1
 12
 enqueue_customizer_scripts
0.00%
0 / 12
0.00%
0 / 1
 30
 add_help_center_container
0.00%
0 / 2
0.00%
0 / 1
 2
 enqueue_wp_admin_scripts
0.00%
0 / 26
0.00%
0 / 1
 420
1<?php
2/**
3 * Help center
4 *
5 * @package automattic/jetpack-mu-wpcom
6 */
7
8namespace A8C\FSE;
9
10use Automattic\Jetpack\Connection\Client;
11use Automattic\Jetpack\Connection\Manager as Connection_Manager;
12use Automattic\Jetpack\Status\Host;
13
14/**
15 * Class Help_Center
16 */
17class Help_Center {
18    /**
19     * Class instance.
20     *
21     * @var Help_Center|null
22     */
23    private static $instance = null;
24
25    /**
26     * Whether the current site is a support site.
27     *
28     * @var bool
29     */
30    private $is_support_site = false;
31
32    /**
33     * Whether the current site is a forum site.
34     *
35     * @var bool
36     */
37    private $is_forum_site = false;
38
39    /**
40     * The purchases of the current site.
41     *
42     * @var array
43     */
44    private $purchases = array();
45
46    /**
47     * Help_Center constructor.
48     */
49    public function __construct() {
50        if ( function_exists( 'wpcom_get_site_purchases' ) ) {
51            $this->purchases = wp_list_filter( wpcom_get_site_purchases(), array( 'product_type' => 'bundle' ) );
52        }
53
54        $blog_id               = get_current_blog_id();
55        $this->is_forum_site   = defined( 'WPCOM_FORUM_BLOG_IDS' ) && in_array( $blog_id, (array) WPCOM_FORUM_BLOG_IDS, true );
56        $this->is_support_site = ( defined( 'WPCOM_SUPPORT_BLOG_IDS' ) && in_array( $blog_id, (array) WPCOM_SUPPORT_BLOG_IDS, true ) ) || $this->is_forum_site;
57
58        // Always register REST API endpoints.
59        add_action( 'rest_api_init', array( $this, 'register_rest_api' ) );
60        add_filter( 'calypso_preferences_update', array( $this, 'calypso_preferences_update' ) );
61
62        // Handle customizer separately.
63        if ( is_customize_preview() ) {
64            add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_customizer_scripts' ) );
65            add_action( 'customize_controls_print_footer_scripts', array( $this, 'add_help_center_container' ) );
66            return;
67        }
68
69        add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_wp_admin_scripts' ), 100 );
70        add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_wp_admin_scripts' ), 100 );
71        add_filter( 'in_admin_header', array( $this, 'jetpack_remove_core_help_tab' ) );
72    }
73
74    /**
75     * Update the calypso preferences.
76     *
77     * @param \stdClass $preferences The preferences.
78     * @return \stdClass The preferences.
79     */
80    public function calypso_preferences_update( $preferences ) {
81        // Check if help_center_router_history exists and is a valid array structure
82        if ( ! isset( $preferences->help_center_router_history ) ||
83            ! is_array( $preferences->help_center_router_history ) ) {
84            return $preferences;
85        }
86
87        $router_history = $preferences->help_center_router_history;
88
89        // Check if entries exist and is an array
90        if ( ! isset( $router_history['entries'] ) ||
91            ! is_array( $router_history['entries'] ) ) {
92            return $preferences;
93        }
94
95        $entries = $router_history['entries'];
96
97        // Limit entries to 50 to prevent spamming entries in the router history.
98        if ( count( $entries ) > 50 ) {
99            // Keep only the last 49 entries and add the root entry at the beginning.
100            $entries = array_slice( $entries, -49 );
101            // Keep the start at root so the back button always works.
102            array_unshift(
103                $entries,
104                array(
105                    'pathname' => '/',
106                    'search'   => '',
107                    'hash'     => '',
108                    'key'      => 'default',
109                    'state'    => null,
110                )
111            );
112
113            // Update the preferences object directly
114            $preferences->help_center_router_history['entries'] = $entries;
115            $preferences->help_center_router_history['index']   = 49;
116        }
117
118        return $preferences;
119    }
120
121    /**
122     * Returns ISO 639 conforming locale string of the current user.
123     *
124     * @return string ISO 639 locale string e.g. "en"
125     */
126    private static function determine_iso_639_locale() {
127        $language = get_user_locale();
128        $language = strtolower( $language );
129
130        if ( in_array( $language, array( 'pt_br', 'pt-br', 'zh_tw', 'zh-tw', 'zh_cn', 'zh-cn' ), true ) ) {
131            $language = str_replace( '_', '-', $language );
132        } else {
133            $language = preg_replace( '/([-_].*)$/i', '', $language );
134        }
135
136        if ( empty( $language ) ) {
137            return 'en';
138        }
139
140        return $language;
141    }
142
143    /**
144     * We prefer to use the Help Center instead of the Help tab.
145     */
146    public function jetpack_remove_core_help_tab() {
147        ?>
148            <style>#contextual-help-link-wrap { display: none; }</style>
149        <?php
150    }
151
152    /**
153     * Returns whether the current request is coming from the a8c proxy.
154     */
155    private static function is_proxied() {
156        return isset( $_SERVER['A8C_PROXIED_REQUEST'] )
157            ? sanitize_text_field( wp_unslash( $_SERVER['A8C_PROXIED_REQUEST'] ) )
158            : defined( 'A8C_PROXIED_REQUEST' ) && A8C_PROXIED_REQUEST;
159    }
160
161    /**
162     * Creates instance.
163     *
164     * @return void
165     */
166    public static function init() {
167        $request_uri = isset( $_SERVER['REQUEST_URI'] ) ? sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : '';
168
169        if ( str_contains( $request_uri, 'wp-content/plugins/gutenberg-core' ) || str_contains( $request_uri, 'preview=true' ) ) {
170            return;
171        }
172
173        if ( self::$instance === null ) {
174            self::$instance = new self();
175        }
176    }
177
178    /**
179     * Returns the singleton instance, or null if init() hasn't run or short-circuited.
180     *
181     * @return self|null
182     */
183    public static function get_instance(): ?self {
184        return self::$instance;
185    }
186
187    /**
188     * Enqueue Help Center assets.
189     *
190     * @param string $variant The variant of the asset file to get.
191     * @param array  $dependencies The asset file to get.
192     * @param string $version The version of the asset file to get.
193     */
194    public function enqueue_script( $variant, $dependencies, $version ) {
195        $script_dependencies = $dependencies ?? array();
196
197        if ( $variant === 'wp-admin' || $variant === 'wp-admin-disconnected' || $variant === 'gutenberg' || $variant === 'gutenberg-disconnected' ) {
198            add_action(
199                'admin_bar_menu',
200                function ( $wp_admin_bar ) {
201                    $wp_admin_bar->add_menu(
202                        array(
203                            'id'     => 'help-center',
204                            'title'  => '<span title="' . __( 'Help Center', 'jetpack-mu-wpcom' ) . '"><svg id="help-center-icon" class="ab-icon" width="24" height="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
205                                                <path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M12 2C6.477 2 2 6.477 2 12s4.477 10 10 10 10-4.477 10-10S17.523 2 12 2zm-1 16v-2h2v2h-2zm2-3v-1.141A3.991 3.991 0 0016 10a4 4 0 00-8 0h2c0-1.103.897-2 2-2s2 .897 2 2-.897 2-2 2a1 1 0 00-1 1v2h2z" />
206                                            </svg>
207                                            <svg id="help-center-icon-with-notification" class="ab-icon"  width="24" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg">
208                                                <path d="M12 2C6.477 2 2 6.477 2 12C2 17.523 6.477 22 12 22C17.523 22 22 17.523 22 12C22 6.477 17.523 2 12 2ZM13 18H11V16H13V18ZM13 13.859V15H11V13C11 12.448 11.448 12 12 12C13.103 12 14 11.103 14 10C14 8.897 13.103 8 12 8C10.897 8 10 8.897 10 10H8C8 7.791 9.791 6 12 6C14.209 6 16 7.791 16 10C16 11.862 14.722 13.413 13 13.859Z" fill="currentColor"/>
209                                                <circle cx="20" cy="3.5" r="4.3" fill="#e65054" stroke="#1d2327" stroke-width="2"/>
210                                            </svg>
211                                        </span>',
212                            'parent' => 'top-secondary',
213                            'href'   => $this->get_help_center_url(),
214                            'meta'   => array(
215                                'html'   => '<div id="help-center-masterbar" />',
216                                'class'  => 'menupop',
217                                'target' => '_blank',
218                            ),
219                        )
220                    );
221                },
222                // Add the help center icon to the admin bar after the reader icon.
223                12
224            );
225
226            if ( is_user_logged_in() && $variant === 'wp-admin' && $this->is_menu_panel_enabled() ) {
227                // Initialize the help center menu panel
228                require_once __DIR__ . '/class-help-center-menu-panel.php';
229                Help_Center_Menu_Panel::init();
230            }
231        }
232
233        if ( $variant !== 'wp-admin-disconnected' && $variant !== 'gutenberg-disconnected' ) {
234            $locale = self::determine_iso_639_locale();
235
236            if ( 'en' !== $locale ) {
237                // Load translations directly from widgets.wp.com.
238                wp_enqueue_script(
239                    'help-center-translations',
240                    'https://widgets.wp.com/help-center/languages/' . $locale . '-v1.js',
241                    array( 'wp-i18n' ),
242                    $version,
243                    true
244                );
245
246                $script_dependencies[] = 'help-center-translations';
247            }
248        }
249
250        // If the user is not connected, the Help Center icon will link to the support page.
251        // The disconnected version is significantly smaller than the connected version.
252        wp_enqueue_script(
253            'help-center',
254            'https://widgets.wp.com/help-center/help-center-' . $variant . '.min.js',
255            $script_dependencies,
256            $version,
257            true
258        );
259
260        wp_enqueue_style(
261            'help-center-' . $variant . '-style',
262            'https://widgets.wp.com/help-center/help-center-' . $variant . ( is_rtl() ? '.rtl.css' : '.css' ),
263            array(),
264            $version
265        );
266
267        // In the block editor the Help Center is already present in the editor toolbar
268        // via SlotFill at viewports >= 600px. Hide the admin bar item at those widths
269        // to avoid showing it in two places; keep it visible on mobile where the admin
270        // bar is the primary navigation and the SlotFill button is hidden.
271        if ( $variant === 'gutenberg' || $variant === 'gutenberg-disconnected' ) {
272            wp_add_inline_style(
273                'help-center-' . $variant . '-style',
274                '@media (min-width:600px){#wpadminbar #wp-admin-bar-help-center{display:none!important;}}'
275            );
276        }
277
278        // This information is only needed for the connected version of the help center.
279        if ( $variant !== 'wp-admin-disconnected' && $variant !== 'gutenberg-disconnected' ) {
280            wp_add_inline_script(
281                'help-center',
282                'if ( typeof helpCenterData === "undefined" ) { var helpCenterData = ' . wp_json_encode(
283                    $this->get_help_center_data( $variant ),
284                    JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
285                ) . '; }',
286                'before'
287            );
288        }
289
290        $should_enqueue_wp_components = ! is_admin() || ( is_customize_preview() && ( new Host() )->is_wpcom_simple() );
291
292        if ( $should_enqueue_wp_components ) {
293            $stylesheet     = is_rtl() ? 'build/components/style-rtl.css' : 'build/components/style.css';
294            $stylesheet_url = plugins_url( 'gutenberg/' . $stylesheet );
295
296            if ( function_exists( 'gutenberg_url' ) ) {
297                // @phan-suppress-next-line PhanUndeclaredFunction
298                $stylesheet_url = gutenberg_url( $stylesheet );
299            }
300            // Enqueue wp-component styles because they're not enqueued in wp-admin outside of the editor.
301            wp_enqueue_style(
302                'wp-components',
303                $stylesheet_url,
304                array( 'dashicons' ),
305                $version
306            );
307        }
308    }
309
310    /**
311     * Returns whether the menu panel experiment is enabled for the current user.
312     *
313     * @return boolean True if the menu panel experiment variation is enabled, false otherwise.
314     */
315    private function is_menu_panel_enabled() {
316        $experiment_name      = 'calypso_help_center_menu_popover_increase_exposure';
317        $experiment_variation = 'menu_popover';
318        $user_id              = get_current_user_id();
319        $cache_key            = 'help-center-menu-panel-enabled-' . $user_id . '-' . $experiment_name;
320
321        // Check cache first.
322        $cached_result = get_transient( $cache_key );
323        if ( false !== $cached_result ) {
324            return (bool) $cached_result;
325        }
326
327        $result = false;
328
329        if ( ( new Host() )->is_wpcom_simple() ) {
330            $result = $experiment_variation === \ExPlat\assign_current_user( $experiment_name );
331        } elseif ( ( new Connection_Manager() )->is_user_connected() ) {
332            $request_path = '/experiments/0.1.0/assignments/calypso';
333            $response     = Client::wpcom_json_api_request_as_user(
334                add_query_arg( array( 'experiment_name' => $experiment_name ), $request_path ),
335                'v2'
336            );
337
338            if ( ! is_wp_error( $response ) ) {
339                $response_code = wp_remote_retrieve_response_code( $response );
340                if ( 200 === $response_code ) {
341                    $data = json_decode( wp_remote_retrieve_body( $response ), true );
342                    if ( isset( $data['variations'] ) && isset( $data['variations'][ $experiment_name ] ) ) {
343                        $variation = $data['variations'][ $experiment_name ];
344                        $result    = $experiment_variation === $variation;
345                    }
346                }
347            }
348        }
349
350        // Cache the result for 1 hour.
351        set_transient( $cache_key, $result ? 1 : 0, HOUR_IN_SECONDS );
352
353        return $result;
354    }
355
356    /**
357     * Get current site details.
358     */
359    public function get_current_site() {
360        if ( $this->is_support_site ) {
361            return null;
362        }
363
364        /*
365        * Atomic sites have the WP.com blog ID stored as a Jetpack option. This code deliberately
366        * doesn't use `Jetpack_Options::get_option` so it works even when Jetpack has not been loaded.
367        */
368        $jetpack_options = get_option( 'jetpack_options' );
369        if ( is_array( $jetpack_options ) && isset( $jetpack_options['id'] ) ) {
370            $site = (int) $jetpack_options['id'];
371        } else {
372            $site = get_current_blog_id();
373        }
374
375        $logo_id = get_option( 'site_logo' );
376        $bundles = $this->purchases;
377        $plan    = array_pop( $bundles );
378
379        $return_data = array(
380            'ID'              => $site,
381            'name'            => get_bloginfo( 'name' ),
382            'URL'             => get_bloginfo( 'url' ),
383            'plan'            => array(
384                'product_slug' => $plan->product_slug ?? null,
385            ),
386            'is_wpcom_atomic' => defined( 'IS_ATOMIC' ) && IS_ATOMIC,
387            'jetpack'         => true === apply_filters( 'is_jetpack_site', false, $site ),
388            'logo'            => array(
389                'id'    => $logo_id,
390                'sizes' => array(),
391                'url'   => wp_get_attachment_image_src( $logo_id, 'thumbnail' )[0] ?? '',
392            ),
393            'options'         => array(
394                'launchpad_screen' => get_option( 'launchpad_screen' ),
395                'site_intent'      => get_option( 'site_intent' ),
396                'admin_url'        => get_admin_url(),
397            ),
398        );
399
400        return $return_data;
401    }
402
403    /**
404     * Build the helpCenterData payload for the connected Help Center bundles.
405     *
406     * Exposed so frontend consumers can mount Help Center outside the
407     * admin-only enqueue path without re-implementing the payload
408     * field-for-field.
409     *
410     * Note: this is the payload for the *connected* bundles. The disconnected
411     * variants ('wp-admin-disconnected', 'gutenberg-disconnected') do not
412     * consume helpCenterData and are not valid input here.
413     *
414     * @param string $variant   Bundle variant driving the default sectionName.
415     *                          One of 'wp-admin', 'logged-out', 'customizer',
416     *                          'gutenberg'.
417     * @param array  $overrides Shallow-merged onto the result via array_replace
418     *                          (e.g. array( 'sectionName' => 'landpack' )).
419     *                          Replacing a sub-array (e.g. 'currentUser')
420     *                          replaces it whole — no deep merge.
421     * @return array            JSON-ready associative array.
422     */
423    public function get_help_center_data( string $variant = 'wp-admin', array $overrides = array() ): array {
424        $user_id            = get_current_user_id();
425        $user_data          = get_userdata( $user_id );
426        $username           = $user_data ? $user_data->user_login : null;
427        $user_email         = $user_data ? $user_data->user_email : null;
428        $display_name       = $user_data ? $user_data->display_name : null;
429        $avatar_url         = $user_data ? ( function_exists( 'wpcom_get_avatar_url' ) ? wpcom_get_avatar_url( $user_email, 64, '', true )[0] : get_avatar_url( $user_id ) ) : null;
430        $is_commerce_garden = defined( 'IS_COMMERCE_GARDEN' );
431
432        if ( $this->is_forum_site ) {
433            $section_name = 'wp.com/forums';
434        } elseif ( $this->is_support_site ) {
435            $section_name = 'wp.com/support';
436        } else {
437            $section_name = $variant;
438        }
439
440        $data = array(
441            'isProxied'        => boolval( self::is_proxied() ),
442            'isSU'             => defined( 'WPCOM_SUPPORT_SESSION' ) && WPCOM_SUPPORT_SESSION,
443            'isSSP'            => isset( $_COOKIE['ssp'] ),
444            'sectionName'      => $section_name,
445            'isCommerceGarden' => $is_commerce_garden,
446            'currentUser'      => array(
447                'ID'           => $user_id,
448                'username'     => $username,
449                'display_name' => $display_name,
450                'avatar_URL'   => $avatar_url,
451                'email'        => $user_email,
452                'is_a11n'      => function_exists( '\is_automattician' ) && \is_automattician( $user_id ),
453            ),
454            'site'             => $this->get_current_site(),
455            'locale'           => self::determine_iso_639_locale(),
456        );
457
458        return array_replace( $data, $overrides );
459    }
460
461    /**
462     * Register the Help Center endpoints.
463     */
464    public function register_rest_api() {
465        require_once __DIR__ . '/class-wp-rest-help-center-authenticate.php';
466        $controller = new WP_REST_Help_Center_Authenticate();
467        $controller->register_rest_route();
468
469        require_once __DIR__ . '/class-wp-rest-help-center-sibyl.php';
470        $controller = new WP_REST_Help_Center_Sibyl();
471        $controller->register_rest_route();
472
473        require_once __DIR__ . '/class-wp-rest-help-center-support-status.php';
474        $controller = new WP_REST_Help_Center_Support_Status();
475        $controller->register_rest_route();
476
477        require_once __DIR__ . '/class-wp-rest-help-center-search.php';
478        $controller = new WP_REST_Help_Center_Search();
479        $controller->register_rest_route();
480
481        require_once __DIR__ . '/class-wp-rest-help-center-jetpack-search-ai.php';
482        $controller = new WP_REST_Help_Center_Jetpack_Search_AI();
483        $controller->register_rest_route();
484
485        require_once __DIR__ . '/class-wp-rest-help-center-fetch-post.php';
486        $controller = new WP_REST_Help_Center_Fetch_Post();
487        $controller->register_rest_route();
488
489        require_once __DIR__ . '/class-wp-rest-help-center-ticket.php';
490        $controller = new WP_REST_Help_Center_Ticket();
491        $controller->register_rest_route();
492
493        require_once __DIR__ . '/class-wp-rest-help-center-forum.php';
494        $controller = new WP_REST_Help_Center_Forum();
495        $controller->register_rest_route();
496
497        require_once __DIR__ . '/class-wp-rest-help-center-support-activity.php';
498        $controller = new WP_REST_Help_Center_Support_Activity();
499        $controller->register_rest_route();
500
501        require_once __DIR__ . '/class-wp-rest-help-center-support-interactions.php';
502        $controller = new WP_REST_Help_Center_Support_Interactions();
503        $controller->register_rest_route();
504
505        require_once __DIR__ . '/class-wp-rest-help-center-user-fields.php';
506        $controller = new WP_REST_Help_Center_User_Fields();
507        $controller->register_rest_route();
508
509        require_once __DIR__ . '/class-wp-rest-help-center-odie.php';
510        $controller = new WP_REST_Help_Center_Odie();
511        $controller->register_rest_route();
512
513        require_once __DIR__ . '/class-wp-rest-help-center-persisted-open-state.php';
514        $controller = new WP_REST_Help_Center_Persisted_Open_State();
515        $controller->register_rest_route();
516
517        require_once __DIR__ . '/class-wp-rest-help-center-email-support-enabled.php';
518        $controller = new WP_REST_Help_Center_Email_Support_Enabled();
519        $controller->register_rest_route();
520
521        require_once __DIR__ . '/class-wp-rest-help-center-ticket-csat.php';
522        $controller = new WP_REST_Help_Center_Ticket_CSAT();
523        $controller->register_rest_route();
524    }
525
526    /**
527     * Returns true if the admin bar is set.
528     */
529    public function is_admin_bar() {
530        global $wp_admin_bar;
531        return is_object( $wp_admin_bar );
532    }
533
534    /**
535     * Returns true if the current screen if the block editor.
536     */
537    public function is_block_editor() {
538        global $current_screen;
539
540        if ( ! $current_screen ) {
541            return false;
542        }
543
544        // widgets screen does have the block editor but also no Gutenberg top bar.
545        return $current_screen->is_block_editor() && $current_screen->id !== 'widgets';
546    }
547
548    /**
549     * Returns true if the current screen is the woo commerce admin home page.
550     */
551    private function is_wc_admin_home_page() {
552        global $current_screen;
553        return $current_screen && $current_screen->id === 'woocommerce_page_wc-admin';
554    }
555
556    /**
557     * Returns true if the current user is connected through Jetpack
558     */
559    public function is_jetpack_disconnected() {
560        $user_id = get_current_user_id();
561        $blog_id = get_current_blog_id();
562
563        if ( defined( 'IS_ATOMIC' ) && IS_ATOMIC ) {
564            return ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected( $user_id );
565        }
566
567        if ( true === apply_filters( 'is_jetpack_site', false, $blog_id ) ) {
568            return ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected( $user_id );
569        }
570
571        return false;
572    }
573
574    /**
575     * Returns true if...
576     * 1. The current user can edit posts.
577     * 2. The current user is a member of the blog.
578     * 3. The current request is not in the admin.
579     * 4. The current request is not in the block editor.
580     *
581     * @return bool True if the this is being loaded on the frontend.
582     */
583    public function is_loading_on_frontend() {
584        $can_edit_posts = current_user_can( 'edit_posts' ) && is_user_member_of_blog();
585
586        return ! is_admin() && ! $this->is_block_editor() && $can_edit_posts;
587    }
588
589    /**
590     * Returns the URL for the Help Center redirect.
591     * Used for the Help Center when disconnected.
592     */
593    public function get_help_center_url() {
594        $help_url = 'https://wordpress.com/help?help-center=home';
595
596        if ( $this->is_jetpack_disconnected() || ( $this->is_loading_on_frontend() && ! $this->is_support_site ) ) {
597            return $help_url;
598        }
599
600        return false;
601    }
602
603    /**
604     * Get the asset via file-system on wpcom and via network on Atomic sites.
605     *
606     * @param string $filepath The URL to download the asset file from.
607     */
608    private static function get_assets_json( $filepath ) {
609        $accessible_directly = file_exists( ABSPATH . '/' . $filepath );
610        if ( $accessible_directly ) {
611            return json_decode( file_get_contents( ABSPATH . $filepath ), true );
612        }
613        $request = wp_remote_get( 'https://' . $filepath );
614        if ( is_wp_error( $request ) ) {
615            return null;
616        }
617        return json_decode( wp_remote_retrieve_body( $request ), true );
618    }
619
620    /**
621     * Enqueue Help Center assets for the customizer.
622     */
623    public function enqueue_customizer_scripts() {
624        if ( $this->is_jetpack_disconnected() ) {
625            $variant = 'wp-admin-disconnected';
626        } else {
627            $variant = 'customizer';
628        }
629
630        $cache_key  = 'help-center-asset-' . $variant . '.asset.json';
631        $asset_file = get_transient( $cache_key );
632
633        if ( ! $asset_file ) {
634            $asset_file = self::get_assets_json( 'widgets.wp.com/help-center/help-center-' . $variant . '.asset.json' );
635            if ( ! $asset_file ) {
636                return;
637            }
638            set_transient( $cache_key, $asset_file, HOUR_IN_SECONDS );
639        }
640
641        // When the request is proxied, use a random cache buster as the version for easier debugging.
642        $version = self::is_proxied() ? wp_rand() : $asset_file['version'];
643
644        $this->enqueue_script( $variant, $asset_file['dependencies'], $version );
645    }
646
647    /**
648     * Add Help Center container div in customizer.
649     */
650    public function add_help_center_container() {
651        ?>
652        <div id="help-center-customizer"></div>
653        <?php
654    }
655
656    /**
657     * Add icon to WP-ADMIN admin bar.
658     */
659    public function enqueue_wp_admin_scripts() {
660        if ( $this->is_wc_admin_home_page() ) {
661            return;
662        }
663
664        require_once ABSPATH . 'wp-admin/includes/screen.php';
665
666        $can_edit_posts = current_user_can( 'edit_posts' ) && is_user_member_of_blog();
667        $is_p2          = str_contains( get_stylesheet(), 'pub/p2' ) || function_exists( '\WPForTeams\is_wpforteams_site' ) && is_wpforteams_site( get_current_blog_id() );
668
669        // We will show the help center icon in the admin bar when;
670        // 1. On wp-admin
671        // 2. On the front end of the site if the current user can edit posts
672        // 3. On the front end of the site and the theme is not P2
673        // 4. If it is the frontend we show the disconnected version of the help center.
674        if ( ! is_admin() && ( ! $can_edit_posts || $is_p2 ) && ! $this->is_support_site ) {
675            return;
676        }
677
678        // Do not load Help Center for logged-out users if we are not on support sites.
679        if ( ! is_user_logged_in() && ! $this->is_support_site ) {
680            return;
681        }
682
683        $suffix = $this->is_jetpack_disconnected() ? '-disconnected' : '';
684
685        if ( $this->is_support_site ) {
686            if ( ! is_user_logged_in() ) {
687                $variant = 'logged-out';
688            } else {
689                $variant = ( $this->is_block_editor() ? 'gutenberg' : 'wp-admin' ) . $suffix;
690            }
691        } elseif ( $this->is_loading_on_frontend() ) {
692            $variant = 'wp-admin-disconnected';
693        } else {
694            $variant = ( $this->is_block_editor() ? 'gutenberg' : 'wp-admin' ) . $suffix;
695        }
696
697        $cache_key  = 'help-center-asset-' . $variant . '.asset.json';
698        $asset_file = get_transient( $cache_key );
699
700        if ( ! $asset_file ) {
701            $asset_file = self::get_assets_json( 'widgets.wp.com/help-center/help-center-' . $variant . '.asset.json' );
702            if ( ! $asset_file ) {
703                return;
704            }
705            set_transient( $cache_key, $asset_file, HOUR_IN_SECONDS );
706        }
707
708        // When the request is proxied, use a random cache buster as the version for easier debugging.
709        $version = self::is_proxied() ? wp_rand() : $asset_file['version'];
710
711        $this->enqueue_script( $variant, $asset_file['dependencies'], $version );
712    }
713}
714
715add_action( 'init', array( __NAMESPACE__ . '\Help_Center', 'init' ) );