Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
91.04% covered (success)
91.04%
122 / 134
64.71% covered (warning)
64.71%
11 / 17
CRAP
0.00% covered (danger)
0.00%
0 / 1
Initial_State
91.04% covered (success)
91.04%
122 / 134
64.71% covered (warning)
64.71%
11 / 17
47.52
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
3
 render
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 get_initial_state
100.00% covered (success)
100.00%
40 / 40
100.00% covered (success)
100.00%
1 / 1
3
 get_wp_api_root
66.67% covered (warning)
66.67%
2 / 3
0.00% covered (danger)
0.00%
0 / 1
2.15
 get_reader_chat_guidelines_url
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_guidelines_url
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
4.13
 guidelines_page_will_register
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
 get_block_template_overlay_config
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
2
 get_product_overlay_template_config
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
5
 get_search_template_config
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
3
 get_product_search_template_config
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
4
 build_singleton_template_config
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
4
 current_user_data
100.00% covered (success)
100.00%
15 / 15
100.00% covered (success)
100.00%
1 / 1
3
 get_post_types_with_labels
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
2
 get_purchase_token
28.57% covered (danger)
28.57%
2 / 7
0.00% covered (danger)
0.00%
0 / 1
6.28
 generate_purchase_token
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 current_user_can_purchase
40.00% covered (danger)
40.00%
2 / 5
0.00% covered (danger)
0.00%
0 / 1
4.94
1<?php
2/**
3 * The React initial state.
4 *
5 * @package automattic/jetpack-search
6 */
7
8namespace Automattic\Jetpack\Search;
9
10use Automattic\Jetpack\Connection\Manager as Connection_Manager;
11use Automattic\Jetpack\Status;
12use Jetpack_Options;
13
14/**
15 * The React initial state.
16 */
17class Initial_State {
18
19    /**
20     * Connection Manager
21     *
22     * @var Connection_Manager
23     */
24    protected $connection_manager;
25
26    /**
27     * Search Module Control
28     *
29     * @var Module_Control
30     */
31    protected $module_control;
32
33    /**
34     * Constructor
35     *
36     * @param Connection_Manager $connection_manager - Connection mananger instance.
37     * @param Module_Control     $module_control - Module control instance.
38     */
39    public function __construct( $connection_manager = null, $module_control = null ) {
40        $this->connection_manager = $connection_manager ? $connection_manager : new Connection_Manager( Package::SLUG );
41        $this->module_control     = $module_control ? $module_control : new Module_Control();
42    }
43
44    /**
45     * Render JS for the initial state
46     *
47     * @return string - JS string.
48     */
49    public function render() {
50        return 'var JETPACK_SEARCH_DASHBOARD_INITIAL_STATE=' . wp_json_encode( $this->get_initial_state(), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';';
51    }
52
53    /**
54     * Get the initial state data.
55     *
56     * @return array
57     */
58    public function get_initial_state() {
59        return array(
60            'siteData'        => array(
61                'WP_API_root'             => esc_url_raw( rest_url() ),
62                'wpcomOriginApiUrl'       => $this->get_wp_api_root(),
63                'WP_API_nonce'            => wp_create_nonce( 'wp_rest' ),
64                'registrationNonce'       => wp_create_nonce( 'jetpack-registration-nonce' ),
65                'purchaseToken'           => $this->get_purchase_token(),
66                /**
67                 * Whether promotions are visible or not.
68                 *
69                 * @param bool $are_promotions_active Status of promotions visibility. True by default.
70                 */
71                'showPromotions'          => apply_filters( 'jetpack_show_promotions', true ),
72                'adminUrl'                => esc_url( admin_url() ),
73                'readerChatGuidelinesUrl' => $this->get_reader_chat_guidelines_url(),
74                'blogId'                  => Jetpack_Options::get_option( 'id', 0 ),
75                'version'                 => Package::VERSION,
76                'calypsoSlug'             => ( new Status() )->get_site_suffix(),
77                'title'                   => get_bloginfo( 'name' ),
78                'postTypes'               => $this->get_post_types_with_labels(),
79                'isWpcom'                 => Helper::is_wpcom(),
80                // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
81                'isPlanJustUpgraded'      => isset( $_GET['just_upgraded'] ) && wp_unslash( $_GET['just_upgraded'] ),
82                /**
83                 * Whether the Jetpack Search 3.0 Interactivity API blocks are enabled.
84                 * Mirrors the `jetpack_search_blocks_enabled` server-side filter so the
85                 * dashboard React app can gate the new feature-selection UI on the
86                 * same flag the back end uses to register the blocks themselves.
87                 */
88                'searchBlocksEnabled'     => (bool) apply_filters( 'jetpack_search_blocks_enabled', true ),
89                /**
90                 * Whether the experimental blocks-powered Overlay search experience
91                 * is available in the Experience Selector. Mirrors the
92                 * `jetpack_search_overlay_block_template_enabled` server-side filter
93                 * so the dashboard React app can gate the new card on the same flag
94                 * the back end uses to enable the runtime swap. Defaults to true so
95                 * the Beta card ships to every site; operators that pin the filter
96                 * to false fall back to the original four-card selector.
97                 */
98                'blockOverlayEnabled'     => (bool) apply_filters( 'jetpack_search_overlay_block_template_enabled', true ),
99                /**
100                 * Editor affordances for the experimental blocks-powered overlay.
101                 * Surfaces in the new Overlay search card so admins can edit the
102                 * rendered template via the standard block editor on `post.php` â€”
103                 * works on both block and classic themes. URLs are null for any
104                 * visitor without `manage_options`; the action handlers also
105                 * enforce that capability server-side.
106                 */
107                'blockTemplateOverlay'    => $this->get_block_template_overlay_config(),
108                /**
109                 * Same as `blockTemplateOverlay` but for the WooCommerce product
110                 * variant of the overlay â€” the Overlay card surfaces a second
111                 * "Edit the product Search overlay" entry on Woo stores so the
112                 * product-search overlay template is customizable too.
113                 */
114                'productOverlayTemplate'  => $this->get_product_overlay_template_config(),
115                /**
116                 * Editor affordances for the classic-theme search-template
117                 * singleton CPT. The Embedded card surfaces these on
118                 * classic themes (which can't reach the Site Editor) so
119                 * admins still get an "Edit search template" entry â€” same
120                 * shape and same React link as `blockTemplateOverlay`.
121                 */
122                'searchTemplate'          => $this->get_search_template_config(),
123                /**
124                 * Same as `searchTemplate` but for the WooCommerce product
125                 * search shim â€” the `WooCommerceProductSearchControl`
126                 * surfaces this on classic themes so the "Edit the product
127                 * search template" link routes to `post.php` on the hidden
128                 * CPT instead of a useless Site Editor URL.
129                 */
130                'productSearchTemplate'   => $this->get_product_search_template_config(),
131                // Gates the WooCommerce Product Search control to stores.
132                'isWooCommerceActive'     => Search_Blocks::woocommerce_blocks_enabled(),
133                /**
134                 * Active theme stylesheet â€” used by the experience-selector to deep-link
135                 * the "Edit search template" action to the right Site Editor entry
136                 * (`?p=/wp_template/<stylesheet>//jetpack-search`).
137                 */
138                'activeThemeStylesheet'   => get_stylesheet(),
139                /**
140                 * Whether the active theme is a block theme. Embedded itself
141                 * works on every theme â€” block themes through the FSE
142                 * `search_template_hierarchy` route, classic themes through
143                 * the singleton-CPT shim â€” but the Embedded card's
144                 * customization affordances diverge: block themes get the
145                 * Site-Editor entry points ("Edit search template" / "Insert
146                 * pattern"), classic themes get the block-editor-on-a-hidden-
147                 * CPT path via `searchTemplate`. This flag is the dashboard's
148                 * branch selector for which to render.
149                 */
150                'themeSupportsBlocks'     => wp_is_block_theme(),
151            ),
152            'userData'        => array(
153                'currentUser' => $this->current_user_data(),
154            ),
155            'jetpackSettings' => array(
156                'search'                 => $this->module_control->is_active(),
157                'instant_search_enabled' => $this->module_control->is_instant_search_enabled(),
158                'experience'             => $this->module_control->get_experience(),
159            ),
160            'features'        => array_map(
161                'sanitize_text_field',
162                // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
163                isset( $_GET['features'] ) ? explode( ',', wp_unslash( $_GET['features'] ) ) : array()
164            ),
165        );
166    }
167
168    /**
169     * Get API root.
170     *
171     * It return first party API root for WPCOM simple sites.
172     */
173    protected function get_wp_api_root() {
174        if ( ! Helper::is_wpcom() ) {
175            return esc_url_raw( rest_url() );
176        }
177        // First party API prefix for WPCOM.
178        return esc_url_raw( site_url( '/wp-json/wpcom-origin/' ) );
179    }
180
181    /**
182     * Get the Reader Chat guidelines admin page URL when it is registered.
183     *
184     * The guidelines page is controlled outside Jetpack. Returning an empty
185     * URL lets the dashboard hide the link when that experiment is unavailable.
186     *
187     * @return string Guidelines admin URL, or an empty string when unavailable.
188     */
189    protected function get_reader_chat_guidelines_url() {
190        return $this->get_guidelines_url();
191    }
192
193    /**
194     * Get the Guidelines admin page URL when it is registered.
195     *
196     * @return string Guidelines admin URL, or an empty string when unavailable.
197     */
198    protected function get_guidelines_url() {
199        // No admin menu here: see Admin_Shell::guest_assets().
200        if ( wp_doing_ajax() ) {
201            return self::guidelines_page_will_register() ? esc_url_raw( admin_url( 'options-general.php?page=guidelines-wp-admin' ) ) : '';
202        }
203
204        if ( ! function_exists( 'menu_page_url' ) ) {
205            return '';
206        }
207
208        return esc_url_raw( menu_page_url( 'guidelines-wp-admin', false ) );
209    }
210
211    /**
212     * Whether the Guidelines page registers for this user, for requests that never build the menu.
213     *
214     * Gutenberg's Guidelines experiment hooks this registrar only while the experiment is on.
215     *
216     * @return bool
217     */
218    private static function guidelines_page_will_register() {
219        return current_user_can( 'manage_options' )
220            && false !== has_action( 'admin_menu', 'gutenberg_register_guidelines_settings_submenu' );
221    }
222
223    /**
224     * Build the block-template overlay editor config exposed to the dashboard.
225     *
226     * `enabled` mirrors `Search_Blocks::is_block_template_overlay_enabled()`
227     * â€” true only when the user is currently *on* the blocks Overlay arm.
228     * The editor URLs, by contrast, are gated on the operator filter alone
229     * so admins can edit the template from the Beta card even before
230     * activating it (otherwise the React store, computed at page load
231     * before any switch, would carry a null `editorUrl` and the link would
232     * become a no-op once the card flipped to Active without a refresh).
233     *
234     * @return array{enabled: bool, editorUrl: string|null, postType: string|null, isCustomized: bool}
235     */
236    protected function get_block_template_overlay_config(): array {
237        return $this->build_singleton_template_config(
238            Search_Blocks::is_block_template_overlay_enabled(),
239            Search_Blocks::is_block_template_overlay_filter_on() && current_user_can( 'manage_options' ),
240            Overlay_Template::class
241        );
242    }
243
244    /**
245     * Build the product-overlay editor config exposed to the dashboard.
246     * Counterpart of `get_block_template_overlay_config()` for the WooCommerce
247     * product variant. `enabled` adds the override-on + WC check on top of the
248     * overlay-arm gate â€” it signals the product overlay's front-end render path
249     * is actually wired. `$can_edit` mirrors the init gate: the editable CPT
250     * only registers on Woo stores with the overlay filter on (see
251     * `Search_Blocks::init()`), so exposing the editor URL off Woo would produce
252     * a link that silently does nothing.
253     *
254     * @return array{enabled: bool, editorUrl: string|null, postType: string|null, isCustomized: bool}
255     */
256    protected function get_product_overlay_template_config(): array {
257        $wc_enabled = Search_Blocks::woocommerce_blocks_enabled();
258        return $this->build_singleton_template_config(
259            Search_Blocks::is_block_template_overlay_enabled()
260                && $wc_enabled
261                && Search_Blocks::woocommerce_search_template_override_enabled(),
262            Search_Blocks::is_block_template_overlay_filter_on()
263                && $wc_enabled
264                && current_user_can( 'manage_options' ),
265            Product_Overlay_Template::class
266        );
267    }
268
269    /**
270     * Build the classic-theme search-template editor config exposed to the
271     * dashboard. Counterpart of `get_block_template_overlay_config()` â€”
272     * same `{enabled, editorUrl, postType, isCustomized}` shape and the
273     * same "expose URLs before activation" rule: admins can edit the
274     * template from the Embedded card on any classic theme, even before
275     * actually switching to Embedded.
276     *
277     * @return array{enabled: bool, editorUrl: string|null, postType: string|null, isCustomized: bool}
278     */
279    protected function get_search_template_config(): array {
280        $is_classic = ! wp_is_block_theme();
281        return $this->build_singleton_template_config(
282            $is_classic && Module_Control::EXPERIENCE_EMBEDDED === $this->module_control->get_experience(),
283            $is_classic && current_user_can( 'manage_options' ),
284            Search_Template::class
285        );
286    }
287
288    /**
289     * Build the classic-theme product-search-template editor config exposed
290     * to the dashboard. Counterpart of `get_search_template_config()` for the
291     * WooCommerce product shim â€” same `{enabled, editorUrl, postType, isCustomized}`
292     * shape. `enabled` adds the override-on check on top of the classic +
293     * server-rendered-experience gate â€” it signals "the front-end render path
294     * is actually wired", distinct from "the override toggle is on" in
295     * `jetpackSettings.override_woocommerce_search_template`. `$can_edit`
296     * mirrors the init gate: `Product_Search_Template::init()` (in
297     * `Search_Blocks::init()`) registers `maybe_handle_editor_request` on
298     * classic Embedded **and** classic Inline (both route the product shim),
299     * so the editor URL surfaces for both â€” but not on a block theme, where
300     * the Site Editor link is used instead.
301     *
302     * @return array{enabled: bool, editorUrl: string|null, postType: string|null, isCustomized: bool}
303     */
304    protected function get_product_search_template_config(): array {
305        $experience = $this->module_control->get_experience();
306        $is_classic = ! wp_is_block_theme();
307        // Embedded and Inline both route the classic product shim, so both
308        // expose the CPT editor.
309        $is_classic_product_override = $is_classic
310            && in_array(
311                $experience,
312                array( Module_Control::EXPERIENCE_EMBEDDED, Module_Control::EXPERIENCE_INLINE ),
313                true
314            );
315        return $this->build_singleton_template_config(
316            $is_classic_product_override && Search_Blocks::woocommerce_search_template_override_enabled(),
317            $is_classic_product_override && current_user_can( 'manage_options' ),
318            Product_Search_Template::class
319        );
320    }
321
322    /**
323     * Shared assembly for a {@see Singleton_Template_Cpt}-backed editor
324     * config block. Both `blockTemplateOverlay` and `searchTemplate` ship
325     * the same `{enabled, editorUrl, postType, isCustomized}` shape to
326     * the React dashboard. The `$enabled` and `$can_edit` flags are
327     * intentionally separate: the card lights up as "active" on
328     * `$enabled`, but the URLs / `postType` surface as soon as `$can_edit`
329     * is true so admins can pre-customize the template before activating
330     * the experience â€” without forcing a page reload after the switch.
331     *
332     * `postType` (rather than a pre-built REST path) is what the dashboard
333     * needs: the React "Restore default" handler builds the
334     * `${wpcomOriginApiUrl}jetpack/v4/search/templates/<post_type>` URL
335     * itself, which is how the request reaches the right route on wpcom
336     * Simple sites (the local /wp-json/ surface there doesn't expose
337     * Jetpack routes). The handler re-checks `manage_options` server-side,
338     * so omitting the URLs / postType here just keeps the wire payload
339     * tight for non-admins.
340     *
341     * @param bool   $enabled   Whether the CPT-backed route is currently live on the site.
342     * @param bool   $can_edit  Whether to expose the editor URL + postType (operator-level gate + capability).
343     * @param string $cpt_class Concrete `Singleton_Template_Cpt` subclass to query.
344     * @return array{enabled: bool, editorUrl: string|null, postType: string|null, isCustomized: bool}
345     */
346    protected function build_singleton_template_config( bool $enabled, bool $can_edit, string $cpt_class ): array {
347        return array(
348            'enabled'      => $enabled,
349            'editorUrl'    => $can_edit ? $cpt_class::get_editor_url() : null,
350            'postType'     => $can_edit ? $cpt_class::POST_TYPE : null,
351            'isCustomized' => $can_edit && $cpt_class::is_customized(),
352        );
353    }
354
355    /**
356     * Gather data about the current user.
357     *
358     * @return array
359     */
360    protected function current_user_data() {
361        $current_user      = wp_get_current_user();
362        $is_user_connected = $this->connection_manager->is_user_connected( $current_user->ID );
363        $is_master_user    = $is_user_connected && (int) $current_user->ID && (int) Jetpack_Options::get_option( 'master_user' ) === (int) $current_user->ID;
364        $dotcom_data       = $this->connection_manager->get_connected_user_data();
365
366        $current_user_data = array(
367            'isConnected' => $is_user_connected,
368            'isMaster'    => $is_master_user,
369            'username'    => $current_user->user_login,
370            'id'          => $current_user->ID,
371            'wpcomUser'   => $dotcom_data,
372            'permissions' => array(
373                'manage_options' => current_user_can( 'manage_options' ),
374            ),
375        );
376
377        return $current_user_data;
378    }
379
380    /**
381     * Gets the post type labels for all of the site's post types (including custom post types)
382     *
383     * @return array
384     */
385    protected function get_post_types_with_labels() {
386
387        $args = array(
388            'public' => true,
389        );
390
391        $post_types_with_labels = array();
392
393        $post_types = get_post_types( $args, 'objects' );
394
395        // We don't need all the additional post_type data, just the slug & label
396        foreach ( $post_types as $post_type ) {
397            $post_type_with_label = array(
398                'slug'  => $post_type->name,
399                'label' => $post_type->label,
400            );
401
402            $post_types_with_labels[ $post_type->name ] = $post_type_with_label;
403        }
404        return $post_types_with_labels;
405    }
406
407    /**
408     * Gets a purchase token that is used for Jetpack logged out visitor checkout.
409     * The purchase token should be appended to all CTA url's that lead to checkout.
410     *
411     * @return string|boolean
412     */
413    protected function get_purchase_token() {
414        if ( ! $this->current_user_can_purchase() ) {
415            return false;
416        }
417
418        $purchase_token = Jetpack_Options::get_option( 'purchase_token', false );
419
420        if ( $purchase_token ) {
421            return $purchase_token;
422        }
423        // If the purchase token is not saved in the options table yet, then add it.
424        Jetpack_Options::update_option( 'purchase_token', $this->generate_purchase_token(), true );
425        return Jetpack_Options::get_option( 'purchase_token', false );
426    }
427
428    /**
429     * Generates a purchase token that is used for Jetpack logged out visitor checkout.
430     *
431     * @return string
432     */
433    protected function generate_purchase_token() {
434        return wp_generate_password( 12, false );
435    }
436
437    /**
438     * Determine if the current user is allowed to make Jetpack purchases without
439     * a WordPress.com account
440     *
441     * @return boolean True if the user can make purchases, false if not
442     */
443    public function current_user_can_purchase() {
444        // The site must be site-connected to Jetpack (no users connected).
445        if ( ! $this->connection_manager->is_site_connection() ) {
446            return false;
447        }
448
449        // Make sure only administrators can make purchases.
450        if ( ! current_user_can( 'manage_options' ) ) {
451            return false;
452        }
453
454        return true;
455    }
456}