Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
69.07% covered (warning)
69.07%
402 / 582
39.58% covered (danger)
39.58%
19 / 48
CRAP
0.00% covered (danger)
0.00%
0 / 1
Jetpack_Gutenberg
69.67% covered (warning)
69.67%
402 / 577
39.58% covered (danger)
39.58%
19 / 48
1861.39
0.00% covered (danger)
0.00%
0 / 1
 is_gutenberg_version_available
87.50% covered (warning)
87.50%
21 / 24
0.00% covered (danger)
0.00%
0 / 1
8.12
 prepend_block_prefix
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 remove_extension_prefix
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
3
 share_items
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 set_extension_available
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 set_extension_unavailable
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
4
 init
n/a
0 / 0
n/a
0 / 0
1
 reset
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
1
 get_blocks_directory
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 preset_exists
n/a
0 / 0
n/a
0 / 0
1
 get_preset
66.67% covered (warning)
66.67%
6 / 9
0.00% covered (danger)
0.00%
0 / 1
4.59
 get_jetpack_gutenberg_extensions_allowed_list
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
3
 get_available_extensions
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
3.07
 get_excluded_extensions
66.67% covered (warning)
66.67%
2 / 3
0.00% covered (danger)
0.00%
0 / 1
2.15
 is_registered_and_no_entry_in_availability
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 is_available
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 get_cached_availability
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 get_availability
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
6
 get_extensions
75.00% covered (warning)
75.00%
6 / 8
0.00% covered (danger)
0.00%
0 / 1
4.25
 is_registered
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 is_gutenberg_available
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 should_load
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
4
 register_blocks_assets_base_url
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
3
 load_assets_as_required
90.00% covered (success)
90.00%
9 / 10
0.00% covered (danger)
0.00%
0 / 1
4.02
 load_styles_as_required
27.27% covered (danger)
27.27%
3 / 11
0.00% covered (danger)
0.00%
0 / 1
19.85
 load_scripts_as_required
31.82% covered (danger)
31.82%
7 / 22
0.00% covered (danger)
0.00%
0 / 1
28.29
 block_has_asset
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_asset_version
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
12
 enqueue_block_editor_assets
80.00% covered (warning)
80.00%
92 / 115
0.00% covered (danger)
0.00%
0 / 1
28.61
 get_no_post_editor_extensions
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
4
 load_independent_blocks
100.00% covered (success)
100.00%
17 / 17
100.00% covered (success)
100.00%
1 / 1
10
 lazy_register_deferred_block
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
4
 register_deferred_blocks_in_subtree
95.00% covered (success)
95.00%
19 / 20
0.00% covered (danger)
0.00%
0 / 1
14
 load_and_register_deferred_block
85.00% covered (warning)
85.00%
17 / 20
0.00% covered (danger)
0.00%
0 / 1
9.27
 warn_about_deferred_block_registration_failure
90.91% covered (success)
90.91%
10 / 11
0.00% covered (danger)
0.00%
0 / 1
4.01
 is_block_editor_context
96.43% covered (success)
96.43%
27 / 28
0.00% covered (danger)
0.00%
0 / 1
14
 load_block_editor_extensions
100.00% covered (success)
100.00%
16 / 16
100.00% covered (success)
100.00%
1 / 1
7
 blocks_variation
88.00% covered (warning)
88.00%
22 / 25
0.00% covered (danger)
0.00%
0 / 1
9.14
 get_extensions_preset_for_variation
40.00% covered (danger)
40.00%
6 / 15
0.00% covered (danger)
0.00%
0 / 1
17.58
 validate_block_embed_url
92.59% covered (success)
92.59%
25 / 27
0.00% covered (danger)
0.00%
0 / 1
14.08
 should_show_frontend_preview
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 upgrade_nudge
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
2
 notice
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 1
72
 get_site_specific_features
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
 set_availability_for_plan
66.67% covered (warning)
66.67%
18 / 27
0.00% covered (danger)
0.00%
0 / 1
12.00
 get_render_callback_with_availability_check
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
56
 display_deprecated_block_message
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
20
 register_block_metadata_collection
33.33% covered (danger)
33.33%
2 / 6
0.00% covered (danger)
0.00%
0 / 1
3.19
 set_block_js_loading_strategy
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_block_js_loading_strategy
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
2
1<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2/**
3 * Handles server-side registration and use of all blocks and plugins available in Jetpack for the block editor, aka Gutenberg.
4 * Works in tandem with client-side block registration via `index.json`
5 *
6 * @package automattic/jetpack
7 */
8
9use Automattic\Jetpack\Assets;
10use Automattic\Jetpack\Assets\Shared_Stores_Assets;
11use Automattic\Jetpack\Blocks;
12use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
13use Automattic\Jetpack\Connection\Manager as Connection_Manager;
14use Automattic\Jetpack\Constants;
15use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
16use Automattic\Jetpack\Modules;
17use Automattic\Jetpack\My_Jetpack\Initializer as My_Jetpack_Initializer;
18use Automattic\Jetpack\Plugin\Unavailable_Blocks;
19use Automattic\Jetpack\Status;
20use Automattic\Jetpack\Status\Host;
21
22if ( ! defined( 'ABSPATH' ) ) {
23    exit( 0 );
24}
25
26// Required directly so the AI master-gate helper is available regardless of
27// which loader pulled this class in.
28require_once __DIR__ . '/_inc/lib/class-jetpack-ai-settings.php';
29
30/**
31 * General Gutenberg editor specific functionality
32 */
33class Jetpack_Gutenberg {
34
35    /**
36     * Only these extensions can be registered. Used to control availability of beta blocks.
37     *
38     * @var array|null Extensions allowed list or `null` if not initialized yet.
39     * @see static::get_extensions()
40     */
41    private static $extensions = null;
42
43    /**
44     * Keeps track of the reasons why a given extension is unavailable.
45     *
46     * @var array Extensions availability information
47     */
48    private static $availability = array();
49
50    /**
51     * A cached array of the fully processed availability data. Keeps track of
52     * reasons why an extension is unavailable or missing.
53     *
54     * @var array Extensions availability information.
55     */
56    private static $cached_availability = null;
57
58    /**
59     * Site-specific features available.
60     * Their calculation can be expensive and slow, so we're caching it for the request.
61     *
62     * @var array Site-specific features
63     */
64    private static $site_specific_features = array();
65
66    /**
67     * List of deprecated blocks.
68     *
69     * @var array List of deprecated blocks.
70     */
71    private static $deprecated_blocks = array(
72        'jetpack/revue',
73    );
74
75    /**
76     * Display-only blocks whose registration PHP can be deferred until the block
77     * actually appears on a front-end page.
78     *
79     * Every block listed here has been verified to be "pure": the callback it hooks
80     * to `init` does nothing but call Blocks::jetpack_register_block() (plus trivial
81     * connection/module guards). It registers exactly one block type named
82     * `jetpack/<dir>` (matching its directory), and any front-end hooks it adds (asset
83     * enqueues, wp_footer, filters, â€¦) live inside its render callback, so they only
84     * run when the block is rendered.
85     *
86     * On plain front-end requests these blocks are NOT loaded on `init`. Instead they
87     * are registered just-in-time the first time the block (or a block whose subtree
88     * contains it) is encountered while rendering, via self::lazy_register_deferred_block()
89     * on `pre_render_block`. On admin/REST/cron/CLI/XML-RPC (block-editor) requests they
90     * keep loading eagerly so the editor, the block-types REST endpoint and server-side
91     * rendering are unaffected.
92     *
93     * One class of front-end request is NOT safe to defer on: front-end block editors
94     * (e.g. P2) render the inserter on a plain front-end page, so is_block_editor_context()
95     * is false, yet the block must be registered at `init` for get_availability() to report
96     * it as available. self::load_independent_blocks() therefore never defers a block that
97     * ships in the `no-post-editor` preset (extensions/index.json) â€” those are exactly the
98     * blocks available in editors other than the post editor. A block listed here that is
99     * also in `no-post-editor` simply keeps loading eagerly.
100     *
101     * A block must NOT be added here if:
102     *   - its `init` callback registers any other hook, post meta, REST route,
103     *     shortcode, block pattern or hooked-block;
104     *   - it registers more than one block type, or a block name that differs from its
105     *     directory name (e.g. videopress registers `jetpack/videopress-block`); or
106     *   - it uses `plan_check` (its availability is computed from the init-time
107     *     `jetpack_register_gutenberg_extensions` hook, which lazy registration bypasses,
108     *     so the front-end availability nudge/render could read a stale value); or
109     *   - a front-end path reads its entry from get_cached_availability() before the
110     *     block renders. Deferred blocks appear unavailable there until the lazy
111     *     registration callback runs; or
112     *   - its block file can be `require`d by another runtime code path after `init`
113     *     (e.g. slideshow is included by modules/shortcodes/slideshow.php). The lazy
114     *     loader registers a block by running the `init` callback its include adds; if
115     *     the file was already included elsewhere, the include is a no-op and the
116     *     callback would never run, so the block would silently fail to register; or
117     *   - another runtime code path calls a function defined in its block file
118     *     (e.g. button defines Button\render_email(), called by subscriptions and
119     *     memberships for WooCommerce e-mail rendering). Deferring the file would leave
120     *     that function undefined when the dependent path runs; or
121     *   - it registers a `render_email_callback`. That callback is read off the
122     *     registered block type by the WooCommerce e-mail editor â€” an out-of-band
123     *     renderer that does not go through `pre_render_block`/`do_blocks` â€” so the block
124     *     must already be registered when an e-mail containing it is rendered, which can
125     *     happen on a front-end request (e.g. a transactional e-mail sent during checkout).
126     *
127     * When in doubt, leave it out: omitted blocks simply keep their current eager
128     * behavior.
129     *
130     * @since 16.0
131     * @var string[] Block feature names (directory names, without the `jetpack/` prefix).
132     */
133    private static $lazy_blocks = array(
134        'blog-stats',
135        'blogging-prompt',
136        'business-hours',
137        'eventbrite',
138        'gif',
139        'goodreads',
140        'google-calendar',
141        'google-docs-embed',
142        'image-compare',
143        'like',
144        'nextdoor',
145        'payments-intro',
146        'pinterest',
147        'related-posts',
148        'repeat-visitor',
149        'sharing-buttons',
150        'story',
151        'tock',
152        'top-posts',
153        'voice-to-content',
154    );
155
156    /**
157     * Blocks that were deferred on the current request and still need to be
158     * registered just-in-time when first rendered. Keyed by block feature name.
159     *
160     * @since 16.0
161     * @var array<string,bool>
162     */
163    private static $deferred_blocks = array();
164
165    /**
166     * Fallback minimum plan requirements for WordPress.com/Atomic sites.
167     *
168     * Used when features have conditional availability (e.g., sticker-based gating)
169     * and don't appear in features_data['available']. This only affects the upsell
170     * message shown to users.
171     *
172     * @since 15.5
173     * @var array Feature slug => minimum WordPress.com plan slug.
174     */
175    private static $wpcom_minimum_plan_fallbacks = array(
176        'donations'              => 'value_bundle',
177        'payment-buttons'        => 'value_bundle',
178        'paypal-payment-buttons' => 'value_bundle',
179    );
180
181    /**
182     * Storing the contents of the preset file.
183     *
184     * Already been json_decode.
185     *
186     * @var null|object JSON decoded object after first usage.
187     */
188    private static $preset_cache = null;
189
190    /**
191     * Keep track of JS loading strategies for each block that needs it.
192     *
193     * @var array<string, array|bool>
194     *
195     * @since 15.0
196     */
197    private static $block_js_loading_strategies = array();
198
199    /**
200     * Check to see if a minimum version of Gutenberg is available. Because a Gutenberg version is not available in
201     * php if the Gutenberg plugin is not installed, if we know which minimum WP release has the required version we can
202     * optionally fall back to that.
203     *
204     * @param array  $version_requirements An array containing the required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
205     * @param string $slug The slug of the block or plugin that has the gutenberg version requirement.
206     *
207     * @since 8.3.0
208     *
209     * @return boolean True if the version of gutenberg required by the block or plugin is available.
210     */
211    public static function is_gutenberg_version_available( $version_requirements, $slug ) {
212        global $wp_version;
213
214        // Bail if we don't at least have the gutenberg version requirement, the WP version is optional.
215        if ( empty( $version_requirements['gutenberg'] ) ) {
216            return false;
217        }
218
219        // If running a local dev build of gutenberg plugin GUTENBERG_DEVELOPMENT_MODE is set so assume correct version.
220        if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
221            return true;
222        }
223
224        $version_available = false;
225
226        // If running a production build of the gutenberg plugin then GUTENBERG_VERSION is set, otherwise if WP version
227        // with required version of Gutenberg is known check that.
228        if ( defined( 'GUTENBERG_VERSION' ) ) {
229            $version_available = version_compare( GUTENBERG_VERSION, $version_requirements['gutenberg'], '>=' );
230        } elseif ( ! empty( $version_requirements['wp'] ) ) {
231            $version_available = version_compare( $wp_version, $version_requirements['wp'], '>=' );
232        }
233
234        if ( ! $version_available ) {
235            $slug = self::remove_extension_prefix( $slug );
236            self::set_extension_unavailable(
237                $slug,
238                'incorrect_gutenberg_version',
239                array(
240                    'required_feature' => $slug,
241                    'required_version' => $version_requirements,
242                    'current_version'  => array(
243                        'wp'        => $wp_version,
244                        'gutenberg' => defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : null,
245                    ),
246                )
247            );
248        }
249
250        return $version_available;
251    }
252
253    /**
254     * Prepend the 'jetpack/' prefix to a block name
255     *
256     * @param string $block_name The block name.
257     *
258     * @return string The prefixed block name.
259     */
260    private static function prepend_block_prefix( $block_name ) {
261        return 'jetpack/' . $block_name;
262    }
263
264    /**
265     * Remove the 'jetpack/' or jetpack-' prefix from an extension name
266     *
267     * @param string $extension_name The extension name.
268     *
269     * @return string The unprefixed extension name.
270     */
271    public static function remove_extension_prefix( $extension_name ) {
272        if ( str_starts_with( $extension_name, 'jetpack/' ) || str_starts_with( $extension_name, 'jetpack-' ) ) {
273            return substr( $extension_name, strlen( 'jetpack/' ) );
274        }
275        return $extension_name;
276    }
277
278    /**
279     * Whether two arrays share at least one item
280     *
281     * @param array $a An array.
282     * @param array $b Another array.
283     *
284     * @return boolean True if $a and $b share at least one item
285     */
286    protected static function share_items( $a, $b ) {
287        return array_intersect( $a, $b ) !== array();
288    }
289
290    /**
291     * Set a (non-block) extension as available
292     *
293     * @param string $slug Slug of the extension.
294     */
295    public static function set_extension_available( $slug ) {
296        $slug                        = self::remove_extension_prefix( $slug );
297        self::$availability[ $slug ] = true;
298    }
299
300    /**
301     * Set the reason why an extension (block or plugin) is unavailable
302     *
303     * @param string $slug Slug of the extension.
304     * @param string $reason A string representation of why the extension is unavailable.
305     * @param array  $details A free-form array containing more information on why the extension is unavailable.
306     */
307    public static function set_extension_unavailable( $slug, $reason, $details = array() ) {
308        if (
309            // Extensions that require a plan may be eligible for upgrades.
310            'missing_plan' === $reason
311            && (
312                /**
313                 * Filter 'jetpack_block_editor_enable_upgrade_nudge' with `true` to enable or `false`
314                 * to disable paid feature upgrade nudges in the block editor.
315                 *
316                 * When this is changed to default to `true`, you should also update `modules/memberships/class-jetpack-memberships.php`
317                 * See https://github.com/Automattic/jetpack/pull/13394#pullrequestreview-293063378
318                 *
319                 * @since 7.7.0
320                 *
321                 * @param boolean
322                 */
323                ! apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false )
324                /** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
325                || ! apply_filters( 'jetpack_show_promotions', true )
326            )
327        ) {
328            // The block editor may apply an upgrade nudge if `missing_plan` is the reason.
329            // Add a descriptive suffix to disable behavior but provide informative reason.
330            $reason .= '__nudge_disabled';
331        }
332        $slug                        = self::remove_extension_prefix( $slug );
333        self::$availability[ $slug ] = array(
334            'reason'  => $reason,
335            'details' => $details,
336        );
337    }
338
339    /**
340     * Used to initialize the class, no longer in use.
341     *
342     * @return void
343     * @deprecated 12.2 No longer needed.
344     */
345    public static function init() {
346        _deprecated_function( __METHOD__, '12.2' );
347    }
348
349    /**
350     * Resets the class to its original state
351     *
352     * Used in unit tests
353     *
354     * @return void
355     */
356    public static function reset() {
357        self::$extensions                  = null;
358        self::$availability                = array();
359        self::$cached_availability         = null;
360        self::$block_js_loading_strategies = array();
361        self::$deferred_blocks             = array();
362    }
363
364    /**
365     * Return the Gutenberg extensions (blocks and plugins) directory
366     *
367     * @return string The Gutenberg extensions directory
368     */
369    public static function get_blocks_directory() {
370        /**
371         * Filter to select Gutenberg blocks directory
372         *
373         * @since 6.9.0
374         *
375         * @param string default: '_inc/blocks/'
376         */
377        return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
378    }
379
380    /**
381     * Checks for a given .json file in the blocks folder.
382     *
383     * @deprecated 14.3
384     *
385     * @param string $preset The name of the .json file to look for.
386     *
387     * @return bool True if the file is found.
388     */
389    public static function preset_exists( $preset ) {
390        _deprecated_function( __METHOD__, '14.3' );
391        return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
392    }
393
394    /**
395     * Decodes JSON loaded from the preset file in the blocks folder
396     *
397     * @since 14.3 Deprecated argument. Only one value is ever used.
398     *
399     * @param null $deprecated No longer used.
400     *
401     * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
402     */
403    public static function get_preset( $deprecated = null ) {
404        if ( $deprecated ) {
405            _deprecated_argument( __METHOD__, '14.3', 'The $preset argument is no longer needed or used.' );
406        }
407
408        if ( self::$preset_cache ) {
409            return self::$preset_cache;
410        }
411
412        /*
413         * The manifest is a build artifact and is absent in a source checkout (e.g. when
414         * running the test suite). Return false â€” as documented â€” rather than calling
415         * wp_json_file_decode() on a missing file, which triggers _doing_it_wrong().
416         */
417        $preset_file = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . 'index.json';
418        if ( ! file_exists( $preset_file ) ) {
419            return false;
420        }
421
422        self::$preset_cache = wp_json_file_decode( $preset_file );
423        return self::$preset_cache;
424    }
425
426    /**
427     * Returns a list of Jetpack Gutenberg extensions (blocks and plugins), based on index.json
428     *
429     * @return array A list of blocks: eg [ 'publicize', 'markdown' ]
430     */
431    public static function get_jetpack_gutenberg_extensions_allowed_list() {
432        $preset_extensions_manifest = ( defined( 'TESTING_IN_JETPACK' ) && TESTING_IN_JETPACK ) ? array() : self::get_preset();
433        $blocks_variation           = self::blocks_variation();
434
435        return self::get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation );
436    }
437
438    /**
439     * Returns a diff from a combined list of allowed extensions and extensions determined to be excluded
440     *
441     * @param  array $allowed_extensions An array of allowed extensions.
442     *
443     * @return array A list of blocks: eg array( 'publicize', 'markdown' )
444     */
445    public static function get_available_extensions( $allowed_extensions = null ) {
446        $exclusions         = self::get_excluded_extensions();
447        $allowed_extensions = $allowed_extensions === null ? self::get_jetpack_gutenberg_extensions_allowed_list() : $allowed_extensions;
448
449        // Avoid errors if option data is not as expected.
450        if ( ! is_array( $exclusions ) ) {
451            $exclusions = array();
452        }
453
454        return array_diff( $allowed_extensions, $exclusions );
455    }
456
457    /**
458     * Returns the extensions a site has excluded via the `jetpack_excluded_extensions` option.
459     *
460     * @return mixed The stored option value, or an empty array when none is set.
461     */
462    private static function get_excluded_extensions() {
463        // Without a persistent object cache, a missing option costs a query on every request, so store the empty default.
464        if ( ! wp_using_ext_object_cache() ) {
465            return Jetpack_Options::get_option_and_ensure_autoload( 'jetpack_excluded_extensions', array() );
466        }
467
468        return get_option( 'jetpack_excluded_extensions', array() );
469    }
470
471    /**
472     * Return true if the extension has been registered and there's nothing in the availablilty array.
473     *
474     * @param string $extension The name of the extension.
475     *
476     * @return bool whether the extension has been registered and there's nothing in the availablilty array.
477     */
478    public static function is_registered_and_no_entry_in_availability( $extension ) {
479        return self::is_registered( 'jetpack/' . $extension ) && ! isset( self::$availability[ $extension ] );
480    }
481
482    /**
483     * Return true if the extension has a true entry in the availablilty array.
484     *
485     * @param string $extension The name of the extension.
486     *
487     * @return bool whether the extension has a true entry in the availablilty array.
488     */
489    public static function is_available( $extension ) {
490        return isset( self::$availability[ $extension ] ) && true === self::$availability[ $extension ];
491    }
492
493    /**
494     * Get the availability of each block / plugin, or return the cached availability
495     * if it has already been calculated. Avoids re-registering extensions when not
496     * necessary.
497     *
498     * @return array A list of block and plugins and their availability status.
499     */
500    public static function get_cached_availability() {
501        if ( null === self::$cached_availability ) {
502            self::$cached_availability = self::get_availability();
503        }
504        return self::$cached_availability;
505    }
506
507    /**
508     * Get availability of each block / plugin.
509     *
510     * @return array A list of block and plugins and their availablity status
511     */
512    public static function get_availability() {
513        /**
514         * Fires before Gutenberg extensions availability is computed.
515         *
516         * In the function call you supply, use `Blocks::jetpack_register_block()` to set a block as available.
517         * Alternatively, use `Jetpack_Gutenberg::set_extension_available()` (for a non-block plugin), and
518         * `Jetpack_Gutenberg::set_extension_unavailable()` (if the block or plugin should not be registered
519         * but marked as unavailable).
520         *
521         * @since 7.0.0
522         */
523        do_action( 'jetpack_register_gutenberg_extensions' );
524
525        $available_extensions = array();
526
527        foreach ( static::get_extensions() as $extension ) {
528            $is_available                       = self::is_registered_and_no_entry_in_availability( $extension ) || self::is_available( $extension );
529            $available_extensions[ $extension ] = array(
530                'available' => $is_available,
531            );
532
533            if ( ! $is_available ) {
534                $reason  = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['reason'] : 'missing_module';
535                $details = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['details'] : array();
536                $available_extensions[ $extension ]['unavailable_reason'] = $reason;
537                $available_extensions[ $extension ]['details']            = $details;
538            }
539        }
540
541        return $available_extensions;
542    }
543
544    /**
545     * Return the list of extensions that are available.
546     *
547     * @since 11.9
548     *
549     * @return array A list of block and plugins and their availability status.
550     */
551    public static function get_extensions() {
552        if ( ! static::should_load() ) {
553            return array();
554        }
555
556        if ( null === self::$extensions ) {
557            /**
558             * Filter the list of block editor extensions that are available through Jetpack.
559             *
560             * @since 7.0.0
561             *
562             * @param array
563             */
564            self::$extensions = apply_filters( 'jetpack_set_available_extensions', self::get_available_extensions() );
565
566            if ( ! is_array( self::$extensions ) ) {
567                _doing_it_wrong( __METHOD__, esc_html__( 'The jetpack_set_available_extensions filter must return an array.', 'jetpack' ), '14.9' );
568                self::$extensions = array();
569            }
570        }
571
572        return self::$extensions;
573    }
574
575    /**
576     * Check if an extension/block is already registered
577     *
578     * @since 7.2
579     *
580     * @param string $slug Name of extension/block to check.
581     *
582     * @return bool
583     */
584    public static function is_registered( $slug ) {
585        return WP_Block_Type_Registry::get_instance()->is_registered( $slug );
586    }
587
588    /**
589     * Check if Gutenberg editor is available
590     *
591     * @since 6.7.0
592     *
593     * @return bool
594     */
595    public static function is_gutenberg_available() {
596        return true;
597    }
598
599    /**
600     * Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
601     *
602     * Loading blocks and plugins is enabled by default and may be disabled via filter:
603     *   add_filter( 'jetpack_gutenberg', '__return_false' );
604     *
605     * @since 6.9.0
606     *
607     * @return bool
608     */
609    public static function should_load() {
610        if ( ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
611            return false;
612        }
613
614        $return = true;
615
616        if ( ! ( new Modules() )->is_active( 'blocks' ) ) {
617            $return = false;
618        }
619
620        /**
621         * Filter to enable Gutenberg blocks.
622         *
623         * Defaults to true if (connected or in offline mode) and the Blocks module is active.
624         *
625         * @since 6.5.0
626         * @since 13.9 Filter is able to activate or deactivate Gutenberg blocks.
627         *
628         * @param bool true Whether to load Gutenberg blocks
629         */
630        return (bool) apply_filters( 'jetpack_gutenberg', $return );
631    }
632
633    /**
634     * Queue a script to set `Jetpack_Block_Assets_Base_Url`.
635     *
636     * In certain cases Webpack needs to know a base to load additional assets from.
637     * Normally it can determine that itself, but when JS concatenation is involved that tends to confuse it.
638     * We work around that by explicitly outputting a variable with the correct URL.
639     * We set that as its own "script" so we can reliably only output it once.
640     */
641    private static function register_blocks_assets_base_url() {
642        if ( ! wp_script_is( 'jetpack-blocks-assets-base-url', 'registered' ) ) {
643            // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- No actual script, so no version needed.
644            wp_register_script( 'jetpack-blocks-assets-base-url', false, array(), null, array( 'in_footer' => false ) );
645            $json_encode_flags = JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP;
646            if ( get_option( 'blog_charset' ) === 'UTF-8' ) {
647                $json_encode_flags |= JSON_UNESCAPED_UNICODE;
648            }
649            wp_add_inline_script(
650                'jetpack-blocks-assets-base-url',
651                'var Jetpack_Block_Assets_Base_Url=' . wp_json_encode( plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE ), $json_encode_flags ) . ';',
652                'before'
653            );
654        }
655    }
656
657    /**
658     * Only enqueue block assets when needed.
659     *
660     * @param string $type Slug of the block or absolute path to the block source code directory.
661     * @param array  $script_dependencies Script dependencies. Will be merged with automatically
662     *                                    detected script dependencies from the webpack build.
663     *
664     * @return void
665     */
666    public static function load_assets_as_required( $type, $script_dependencies = array() ) {
667        if ( is_admin() ) {
668            // A block's view assets will not be required in wp-admin.
669            return;
670        }
671
672        // Retrieve the feature from block.json if a path is passed.
673        if ( path_is_absolute( $type ) ) {
674            $metadata = Blocks::get_block_metadata_from_file( Blocks::get_path_to_block_metadata( $type ) );
675            $feature  = Blocks::get_block_feature_from_metadata( $metadata );
676
677            if ( ! empty( $feature ) ) {
678                $type = $feature;
679            }
680        }
681
682        $type = sanitize_title_with_dashes( $type );
683        self::load_styles_as_required( $type );
684        self::load_scripts_as_required( $type, $script_dependencies );
685    }
686
687    /**
688     * Only enqueue block sytles when needed.
689     *
690     * @param string $type Slug of the block.
691     *
692     * @since 7.2.0
693     *
694     * @return void
695     */
696    public static function load_styles_as_required( $type ) {
697        if ( is_admin() ) {
698            // A block's view assets will not be required in wp-admin.
699            return;
700        }
701
702        // Enqueue styles.
703        $style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
704        if ( self::block_has_asset( $style_relative_path ) ) {
705            $style_version = self::get_asset_version( $style_relative_path );
706            $view_style    = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
707            $view_style    = add_query_arg( 'minify', 'false', $view_style );
708
709            // If this is a customizer preview, render the style directly to the preview after autosave.
710            // phpcs:ignore WordPress.Security.NonceVerification.Recommended
711            if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
712                // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
713                echo '<link rel="stylesheet" id="jetpack-block-' . esc_attr( $type ) . '" href="' . esc_attr( $view_style ) . '&amp;ver=' . esc_attr( $style_version ) . '" media="all">';
714            } else {
715                wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
716                wp_style_add_data( 'jetpack-block-' . $type, 'path', JETPACK__PLUGIN_DIR . $style_relative_path );
717            }
718        }
719    }
720
721    /**
722     * Only enqueue block scripts when needed.
723     *
724     * @param string $type Slug of the block.
725     * @param array  $script_dependencies Script dependencies. Will be merged with automatically
726     *                             detected script dependencies from the webpack build.
727     *
728     * @since 7.2.0
729     *
730     * @return void
731     */
732    public static function load_scripts_as_required( $type, $script_dependencies = array() ) {
733        if ( is_admin() ) {
734            // A block's view assets will not be required in wp-admin.
735            return;
736        }
737
738        self::register_blocks_assets_base_url();
739
740        // Enqueue script.
741        $script_relative_path  = self::get_blocks_directory() . $type . '/view.js';
742        $script_deps_path      = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $type . '/view.asset.php';
743        $script_dependencies[] = 'jetpack-blocks-assets-base-url';
744        if ( file_exists( $script_deps_path ) ) {
745            $asset_manifest      = include $script_deps_path;
746            $script_dependencies = array_unique( array_merge( $script_dependencies, $asset_manifest['dependencies'] ) );
747        }
748
749        if ( ! Blocks::is_amp_request() && self::block_has_asset( $script_relative_path ) ) {
750            $script_version = self::get_asset_version( $script_relative_path );
751            $view_script    = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
752            $view_script    = add_query_arg( 'minify', 'false', $view_script );
753            $strategy       = self::get_block_js_loading_strategy( $type );
754
755            // Enqueue dependencies.
756            wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, $strategy );
757
758            // If this is a customizer preview, enqueue the dependencies and render the script directly to the preview after autosave.
759            // phpcs:ignore WordPress.Security.NonceVerification.Recommended
760            if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
761                // The Map block is dependent on wp-element, and it doesn't appear to to be possible to load
762                // this dynamically into the customizer iframe currently.
763                if ( 'map' === $type ) {
764                    echo '<div>' . esc_html__( 'No map preview available. Publish and refresh to see this widget.', 'jetpack' ) . '</div>';
765                    echo '<script>';
766                    echo 'Array.from(document.getElementsByClassName(\'wp-block-jetpack-map\')).forEach(function(element){element.style.display = \'none\';})';
767                    echo '</script>';
768                } else {
769                    echo '<script id="jetpack-block-' . esc_attr( $type ) . '" src="' . esc_attr( $view_script ) . '&amp;ver=' . esc_attr( $script_version ) . '"></script>';
770                }
771            }
772        }
773    }
774
775    /**
776     * Check if an asset exists for a block.
777     *
778     * @param string $file Path of the file we are looking for.
779     *
780     * @return bool $block_has_asset Does the file exist.
781     */
782    public static function block_has_asset( $file ) {
783        return file_exists( JETPACK__PLUGIN_DIR . $file );
784    }
785
786    /**
787     * Get the version number to use when loading the file. Allows us to bypass cache when developing.
788     *
789     * @param string $file Path of the file we are looking for.
790     *
791     * @return string $script_version Version number.
792     */
793    public static function get_asset_version( $file ) {
794        return Jetpack::is_development_version() && self::block_has_asset( $file )
795            ? filemtime( JETPACK__PLUGIN_DIR . $file )
796            : JETPACK__VERSION;
797    }
798
799    /**
800     * Load Gutenberg editor assets
801     *
802     * @since 6.7.0
803     *
804     * @return void
805     */
806    public static function enqueue_block_editor_assets() {
807        if ( ! self::should_load() ) {
808            return;
809        }
810
811        /*
812         * When the user returns to the editor right after a successful plan
813         * purchase (signalled by the `plan_upgraded` redirect argument), refresh
814         * the locally cached plan from WordPress.com before block availability is
815         * computed below. Otherwise `available_blocks` is derived from the stale
816         * `jetpack_active_plan` option (only refreshed by the daily heartbeat) and
817         * paid blocks keep showing their upgrade nudge even though the plan is now
818         * active. Simple sites gate features live via `wpcom_site_has_feature()`,
819         * so they neither need nor benefit from this.
820         *
821         * The refresh is a blocking WordPress.com request, so it is guarded to run
822         * only on a connected, non-WPCOM site, throttled to once per minute (a
823         * repeated or bookmarked `?plan_upgraded` URL cannot trigger a request on
824         * every load), and time-boxed so a slow origin cannot hang the editor. The
825         * client-side reload fallback covers a skipped or failed refresh. The value
826         * is only used to trigger a cache refresh from an authoritative source, so
827         * no nonce is required. See FORMS-712.
828         */
829        if (
830            ! empty( $_GET['plan_upgraded'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended
831            && ! ( defined( 'IS_WPCOM' ) && IS_WPCOM )
832            && Jetpack::is_connection_ready()
833            && ! get_transient( 'jetpack_plan_upgraded_refresh' )
834        ) {
835            set_transient( 'jetpack_plan_upgraded_refresh', 1, MINUTE_IN_SECONDS );
836
837            $cap_plan_refresh_timeout = static function () {
838                return 5;
839            };
840            add_filter( 'http_request_timeout', $cap_plan_refresh_timeout, PHP_INT_MAX );
841            Jetpack_Plan::refresh_from_wpcom();
842            remove_filter( 'http_request_timeout', $cap_plan_refresh_timeout, PHP_INT_MAX );
843        }
844
845        $status = new Status();
846
847        // Required for Analytics. See _inc/lib/admin-pages/class.jetpack-admin-page.php.
848        if ( ! $status->is_offline_mode() && Jetpack::is_connection_ready() ) {
849            wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
850        }
851
852        $blocks_dir       = self::get_blocks_directory();
853        $blocks_variation = self::blocks_variation();
854
855        if ( 'production' !== $blocks_variation ) {
856            $blocks_env = '-' . esc_attr( $blocks_variation );
857        } else {
858            $blocks_env = '';
859        }
860
861        self::register_blocks_assets_base_url();
862
863        Assets::register_script(
864            'jetpack-blocks-editor',
865            "{$blocks_dir}editor{$blocks_env}.js",
866            JETPACK__PLUGIN_FILE,
867            array(
868                'textdomain'   => 'jetpack',
869                'dependencies' => array( 'jetpack-blocks-assets-base-url' ),
870            )
871        );
872
873        /**
874         * This can be called multiple times per page load in the admin, during the `enqueue_block_assets` action.
875         * These assets are necessary for the admin for editing but are not necessary for each pattern preview.
876         * Therefore we dequeue them, so they don't load for each pattern preview iframe.
877         */
878        if ( ! wp_should_load_block_editor_scripts_and_styles() ) {
879            wp_dequeue_script( 'jp-tracks' );
880            wp_dequeue_script( 'jetpack-blocks-editor' );
881
882            return;
883        }
884
885        // Hack around #20357 (specifically, that the editor bundle depends on
886        // wp-edit-post but wp-edit-post's styles break the Widget Editor and
887        // Site Editor) until a real fix gets unblocked.
888        // @todo Remove this once #20357 is properly fixed.
889        $wp_styles_fix = wp_styles()->query( 'jetpack-blocks-editor', 'registered' );
890        if ( empty( $wp_styles_fix ) ) {
891            wp_die( 'Your installation of Jetpack is incomplete. Please run "jetpack build plugins/jetpack" in your dev env.' );
892        }
893        wp_styles()->query( 'jetpack-blocks-editor', 'registered' )->deps = array();
894
895        Assets::enqueue_script( 'jetpack-blocks-editor' );
896
897        if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
898            $user                      = wp_get_current_user();
899            $user_data                 = array(
900                'email'    => $user->user_email,
901                'userid'   => $user->ID,
902                'username' => $user->user_login,
903            );
904            $blog_id                   = get_current_blog_id();
905            $is_current_user_connected = true;
906        } else {
907            $user_data                 = Jetpack_Tracks_Client::get_connected_user_tracks_identity();
908            $blog_id                   = Jetpack_Options::get_option( 'id', 0 );
909            $is_current_user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected();
910        }
911
912        if ( $blocks_variation === 'beta' && $is_current_user_connected ) {
913            wp_enqueue_style( 'recoleta-font', '//s1.wp.com/i/fonts/recoleta/css/400.min.css', array(), Constants::get_constant( 'JETPACK__VERSION' ) );
914        }
915        // AI Assistant
916        // The SEO package registers the setting for saving once it starts; see the seo-enhancer store.
917        // Not `Initializer::is_available()`: WordPress.com may not start it on every site the plan allows.
918        $is_seo_auto_enhance_switchable = apply_filters( 'ai_seo_enhancer_enabled', true )
919            && did_action( 'jetpack_seo_init' ) > 0;
920        $ai_assistant_state             = array(
921            'is-enabled'                     => Jetpack_AI_Settings::is_ai_enabled(),
922            'is-seo-enabled'                 => Jetpack_AI_Settings::is_ai_seo_enabled(),
923            'is-seo-auto-enhance-switchable' => $is_seo_auto_enhance_switchable,
924            'is-seo-auto-enhance-enabled'    => $is_seo_auto_enhance_switchable && (bool) get_option( 'ai_seo_enhancer_enabled', false ),
925        );
926
927        $screen_base = null;
928        if ( function_exists( 'get_current_screen' ) ) {
929            $current_screen = get_current_screen();
930            $screen_base    = $current_screen ? $current_screen->base : null;
931        }
932
933        $modules = array();
934        if ( class_exists( 'Jetpack_Core_API_Module_List_Endpoint' ) ) {
935            $module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
936            $modules              = $module_list_endpoint->get_modules();
937        }
938
939        // WordPress.com Simple can load this class without the plugin's autoloaded classes.
940        $available_blocks = class_exists( Unavailable_Blocks::class )
941            ? Unavailable_Blocks::describe_inactive_modules( self::get_availability() )
942            : self::get_availability();
943
944        $jetpack_plan  = Jetpack_Plan::get();
945        $initial_state = array(
946            'available_blocks' => $available_blocks,
947            'blocks_variation' => $blocks_variation,
948            'modules'          => $modules,
949            'jetpack'          => array(
950                'is_active'                     => Jetpack::is_connection_ready(),
951                'is_current_user_connected'     => $is_current_user_connected,
952                /** This filter is documented in class.jetpack-gutenberg.php */
953                'enable_upgrade_nudge'          => apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ),
954                'is_private_site'               => $status->is_private_site(),
955                'is_coming_soon'                => $status->is_coming_soon(),
956                'is_offline_mode'               => $status->is_offline_mode(),
957                'is_newsletter_feature_enabled' => class_exists( '\Jetpack_Memberships' ),
958                // Whether the current user may send a newsletter test email to an
959                // address other than their own. The wpcom guard enforces this on send
960                // (also checking add_users and site stickers); this flag only controls
961                // whether the editor's recipient field is editable. Approximated with
962                // manage_options so editors, who can only test-send to themselves,
963                // aren't shown an editable field that would always be rejected.
964                'can_send_test_email_to_others' => current_user_can( 'manage_options' ),
965                // Which settings-driven subscribe placements are on, for the Site Editor's admin-only notice.
966                'subscribe_placements'          => current_user_can( 'manage_options' ) ? array(
967                    'sm_enabled'                        => (bool) get_option( 'sm_enabled', false ),
968                    'jetpack_subscribe_overlay_enabled' => (bool) get_option( 'jetpack_subscribe_overlay_enabled', false ),
969                    'jetpack_subscribe_floating_button_enabled' => (bool) get_option( 'jetpack_subscribe_floating_button_enabled', false ),
970                    'wpcom_action_bar'                  => ( new Host() )->is_wpcom_simple() && ! get_option( 'wpcom_hide_action_bar' ),
971                ) : null,
972                // this is the equivalent of JP initial state siteData.showMyJetpack (class-jetpack-redux-state-helper)
973                // used to determine if we can link to My Jetpack from the block editor
974                'is_my_jetpack_available'       => My_Jetpack_Initializer::should_initialize(),
975                'jetpack_plan'                  => array(
976                    'data' => $jetpack_plan['product_slug'],
977                ),
978                /**
979                 * Enable the RePublicize UI in the block editor context.
980                 *
981                 * @module publicize
982                 *
983                 * @since 10.3.0
984                 * @deprecated 11.5 This is a feature flag that is no longer used.
985                 *
986                 * @param bool true Enable the RePublicize UI in the block editor context. Defaults to true.
987                 */
988                'republicize_enabled'           => apply_filters( 'jetpack_block_editor_republicize_feature', true ),
989            ),
990            'siteFragment'     => $status->get_site_suffix(),
991            'adminUrl'         => esc_url( admin_url() ),
992            'tracksUserData'   => $user_data,
993            'wpcomBlogId'      => $blog_id,
994            'allowedMimeTypes' => wp_get_mime_types(),
995            'siteLocale'       => str_replace( '_', '-', get_locale() ),
996            'ai-assistant'     => $ai_assistant_state,
997            'screenBase'       => $screen_base,
998            /**
999             * Add your own feature flags to the block editor.
1000             *
1001             * You can access the feature flags in the block editor via hasFeatureFlag( 'your-feature-flag' ) function.
1002             *
1003             * @since 14.8
1004             *
1005             * @param array true Enable the RePublicize UI in the block editor context. Defaults to true.
1006             */
1007            'feature_flags'    => apply_filters( 'jetpack_block_editor_feature_flags', array() ),
1008            'pluginBasePath'   => plugins_url( '', Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ),
1009        );
1010
1011        wp_localize_script(
1012            Shared_Stores_Assets::SCRIPT_HANDLE,
1013            'Jetpack_Editor_Initial_State',
1014            $initial_state
1015        );
1016
1017        // Adds Connection package initial state.
1018        Connection_Initial_State::render_script( 'jetpack-blocks-editor' );
1019    }
1020
1021    /**
1022     * Block feature names in the `no-post-editor` preset (extensions/index.json): blocks
1023     * whose editor bundle is usable outside the post editor, so they appear in front-end
1024     * block editors such as P2. These must never be deferred (see self::$lazy_blocks and
1025     * self::load_independent_blocks()).
1026     *
1027     * @since 16.2
1028     *
1029     * @return string[] Feature names, or an empty array when the preset is unavailable.
1030     */
1031    private static function get_no_post_editor_extensions() {
1032        $preset = self::get_preset();
1033        if ( is_object( $preset ) && isset( $preset->{'no-post-editor'} ) && is_array( $preset->{'no-post-editor'} ) ) {
1034            return $preset->{'no-post-editor'};
1035        }
1036        return array();
1037    }
1038
1039    /**
1040     * Some blocks do not depend on a specific module,
1041     * and can consequently be loaded outside of the usual modules.
1042     * We will look for such modules in the extensions/ directory.
1043     *
1044     * @since 7.1.0
1045     * @since 16.0 Pure display blocks are deferred on front-end requests and registered on first render.
1046     * @since 16.2 Blocks in the `no-post-editor` preset are never deferred, so front-end editors (e.g. P2) keep them.
1047     * @see wp_common_block_scripts_and_styles()
1048     */
1049    public static function load_independent_blocks() {
1050        if ( self::should_load() ) {
1051            /**
1052             * Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
1053             * If available, load them.
1054             */
1055            $directories = array( 'blocks', 'plugins', 'extended-blocks' );
1056
1057            /*
1058             * On plain front-end requests, defer the registration PHP of pure display
1059             * blocks (see self::$lazy_blocks) until the block is actually encountered
1060             * while rendering. The block editor, the block-types REST endpoint and
1061             * server-side rendering all run in a "block-editor context" and keep loading
1062             * every block eagerly, so their behavior is unchanged.
1063             */
1064            $defer = ! self::is_block_editor_context();
1065
1066            /*
1067             * Front-end block editors (e.g. P2) render the inserter on a plain front-end
1068             * request, so is_block_editor_context() is false there, yet a block must be
1069             * registered on `init` for get_availability() to report it and keep it in the
1070             * inserter. Never defer a block that ships in the `no-post-editor` preset â€”
1071             * those are precisely the blocks usable outside the post editor.
1072             */
1073            $no_post_editor_blocks = $defer ? self::get_no_post_editor_extensions() : array();
1074
1075            foreach ( static::get_extensions() as $extension ) {
1076                if (
1077                    $defer
1078                    && in_array( $extension, self::$lazy_blocks, true )
1079                    && ! in_array( $extension, $no_post_editor_blocks, true )
1080                ) {
1081                    self::$deferred_blocks[ $extension ] = true;
1082                    continue;
1083                }
1084
1085                foreach ( $directories as $dirname ) {
1086                    $path = JETPACK__PLUGIN_DIR . "extensions/{$dirname}/{$extension}/{$extension}.php";
1087
1088                    if ( file_exists( $path ) ) {
1089                        include_once $path;
1090                        continue 2;
1091                    }
1092                }
1093            }
1094
1095            if ( ! empty( self::$deferred_blocks ) ) {
1096                add_filter( 'pre_render_block', array( __CLASS__, 'lazy_register_deferred_block' ), 10, 3 );
1097            }
1098        }
1099    }
1100
1101    /**
1102     * Register deferred blocks present in a top-level block's subtree before it renders.
1103     *
1104     * Hooked to `pre_render_block`. For a top-level block ($parent_block is null) the
1105     * filter fires before core builds the block's WP_Block object, so we walk the whole
1106     * parsed subtree and register every deferred Jetpack block it contains. This must
1107     * happen at the top level: core resolves an inner block's `block_type` when it
1108     * constructs that inner WP_Block, which is *before* the inner block's own
1109     * `pre_render_block` fires â€” so registering a deferred dynamic block only when its
1110     * own inner filter fires would be too late and its render_callback would be skipped.
1111     * Inner-block invocations (non-null $parent_block) are ignored because the top-level
1112     * walk has already handled the whole tree. Returns $pre_render untouched.
1113     *
1114     * @since 16.0
1115     *
1116     * @param string|null    $pre_render   The pre-rendered content. Default null.
1117     * @param array          $parsed_block The parsed block being rendered.
1118     * @param \WP_Block|null $parent_block Parent block, or null for a top-level block.
1119     *
1120     * @return string|null Unchanged $pre_render.
1121     */
1122    public static function lazy_register_deferred_block( $pre_render, $parsed_block, $parent_block = null ) {
1123        // Respect any earlier short-circuit, only act on top-level blocks, and stop
1124        // once every deferred block on the page has been registered.
1125        if ( null !== $pre_render || null !== $parent_block || empty( self::$deferred_blocks ) ) {
1126            return $pre_render;
1127        }
1128
1129        self::register_deferred_blocks_in_subtree( $parsed_block );
1130
1131        return $pre_render;
1132    }
1133
1134    /**
1135     * Recursively register any deferred Jetpack blocks found in a parsed block subtree.
1136     *
1137     * @since 16.0
1138     *
1139     * @param array $parsed_block A parsed block (with optional `innerBlocks`).
1140     * @param array $seen_refs    Reusable-block IDs already visited, to guard against cycles.
1141     *
1142     * @return void
1143     */
1144    private static function register_deferred_blocks_in_subtree( $parsed_block, &$seen_refs = array() ) {
1145        if ( empty( self::$deferred_blocks ) ) {
1146            return;
1147        }
1148
1149        $block_name = $parsed_block['blockName'] ?? '';
1150        if ( '' !== $block_name && str_starts_with( $block_name, 'jetpack/' ) ) {
1151            $feature = substr( $block_name, strlen( 'jetpack/' ) );
1152            if ( ! empty( self::$deferred_blocks[ $feature ] ) ) {
1153                // Only attempt registration once per block, whether or not it succeeds
1154                // (a block guarded by a connection/module check may intentionally not register).
1155                unset( self::$deferred_blocks[ $feature ] );
1156
1157                if ( ! self::is_registered( $block_name ) ) {
1158                    self::load_and_register_deferred_block( $feature );
1159                }
1160            }
1161        }
1162
1163        /*
1164         * A synced pattern / reusable block (core/block) keeps its content in a separate
1165         * wp_block post that core only parses at render time (render_block_core_block),
1166         * so it is absent from this parsed tree. Resolve the reference and recurse so a
1167         * deferred block inside the pattern is registered before core builds its WP_Block.
1168         *
1169         * core/navigation has the same ref-based hidden-content shape (a wp_navigation
1170         * post) but is intentionally not handled: none of the deferred blocks can be
1171         * inserted into a navigation menu through the editor, and resolving the ref would
1172         * add a get_post()/parse_blocks() on essentially every front-end page (menus are
1173         * near-ubiquitous) for a case that cannot occur without hand-authored markup.
1174         */
1175        if ( 'core/block' === $block_name && ! empty( $parsed_block['attrs']['ref'] ) ) {
1176            $ref = (int) $parsed_block['attrs']['ref'];
1177            if ( ! isset( $seen_refs[ $ref ] ) ) {
1178                $seen_refs[ $ref ] = true;
1179                $reusable_block    = get_post( $ref );
1180                if ( $reusable_block instanceof \WP_Post && 'wp_block' === $reusable_block->post_type ) {
1181                    foreach ( parse_blocks( $reusable_block->post_content ) as $inner_block ) {
1182                        self::register_deferred_blocks_in_subtree( $inner_block, $seen_refs );
1183                    }
1184                }
1185            }
1186        }
1187
1188        if ( ! empty( $parsed_block['innerBlocks'] ) ) {
1189            foreach ( $parsed_block['innerBlocks'] as $inner_block ) {
1190                self::register_deferred_blocks_in_subtree( $inner_block, $seen_refs );
1191            }
1192        }
1193    }
1194
1195    /**
1196     * Include a deferred block's registration PHP and run the `init` callback it
1197     * adds, immediately.
1198     *
1199     * The block files register themselves with `add_action( 'init', â€¦ )`. By render
1200     * time `init` has long since fired, so including the file is not enough on its
1201     * own: we capture the callback(s) the include adds to `init` and invoke them now.
1202     * Only blocks in self::$lazy_blocks reach this path, and each adds exactly its
1203     * own registration callback to `init`, so this runs that single registration.
1204     *
1205     * @since 16.0
1206     *
1207     * @param string $feature Block feature name (directory name without the `jetpack/` prefix).
1208     *
1209     * @return void
1210     */
1211    private static function load_and_register_deferred_block( $feature ) {
1212        $path = JETPACK__PLUGIN_DIR . "extensions/blocks/{$feature}/{$feature}.php";
1213        if ( ! file_exists( $path ) ) {
1214            self::warn_about_deferred_block_registration_failure( $feature, 'missing block registration file' );
1215            return;
1216        }
1217
1218        global $wp_filter;
1219
1220        $before = isset( $wp_filter['init'] ) ? $wp_filter['init']->callbacks : array();
1221
1222        include_once $path;
1223
1224        if ( ! isset( $wp_filter['init'] ) ) {
1225            self::warn_about_deferred_block_registration_failure( $feature, 'block file did not add an init callback' );
1226            return;
1227        }
1228
1229        $registered_callback = false;
1230
1231        // Run (and then detach) any callback the include just added to `init`.
1232        foreach ( $wp_filter['init']->callbacks as $priority => $callbacks ) {
1233            foreach ( $callbacks as $id => $callback ) {
1234                if ( isset( $before[ $priority ][ $id ] ) ) {
1235                    continue;
1236                }
1237                $registered_callback = true;
1238                if ( is_callable( $callback['function'] ) ) {
1239                    call_user_func( $callback['function'] );
1240                }
1241                remove_action( 'init', $callback['function'], $priority );
1242            }
1243        }
1244
1245        if ( ! $registered_callback ) {
1246            self::warn_about_deferred_block_registration_failure( $feature, 'block file did not add a new init callback' );
1247        }
1248    }
1249
1250    /**
1251     * Surface lazy-registration mistakes during debugging without adding front-end noise.
1252     *
1253     * @since 16.0
1254     *
1255     * @param string $feature Block feature name (directory name without the `jetpack/` prefix).
1256     * @param string $reason  Short reason for the failure.
1257     *
1258     * @return void
1259     */
1260    private static function warn_about_deferred_block_registration_failure( $feature, $reason ) {
1261        if ( ! ( defined( 'WP_DEBUG' ) && WP_DEBUG ) || ! function_exists( '_doing_it_wrong' ) ) {
1262            return;
1263        }
1264
1265        _doing_it_wrong(
1266            __METHOD__,
1267            sprintf(
1268                /* translators: 1: Jetpack block feature name. 2: Failure reason. */
1269                esc_html__( 'Lazy Jetpack block registration failed for "%1$s": %2$s.', 'jetpack' ),
1270                esc_html( $feature ),
1271                esc_html( $reason )
1272            ),
1273            '16.0'
1274        );
1275    }
1276
1277    /**
1278     * Determine whether the current request is a block-editor context that needs
1279     * every Jetpack block loaded eagerly on `init`.
1280     *
1281     * Returns true for admin, REST, cron, WP-CLI and XML-RPC requests so the editor,
1282     * the `/wp/v2/block-types` endpoint and server-side rendering keep seeing the full
1283     * set of blocks. Returns false only for plain front-end web requests, where pure
1284     * display blocks are registered just-in-time as they render.
1285     *
1286     * This runs at module-load time (around after_setup_theme), before core defines
1287     * REST_REQUEST during parse_request, so self-hosted and Atomic REST requests are
1288     * detected from the request URL instead of the constant. That URL check cannot
1289     * work on WordPress.com Simple: its public API filters `rest_url_prefix` to an
1290     * empty string, so rest_get_url_prefix() returns '' and the REST roots computed
1291     * below collapse to '//', which no request path can match. Simple's requests are
1292     * detected via REST_API_REQUEST instead, which its API entry points define before
1293     * wp-load.php runs.
1294     *
1295     * @since 16.0
1296     *
1297     * @return bool True for block-editor (non-front-end) contexts, false for plain front-end requests.
1298     */
1299    private static function is_block_editor_context() {
1300        if ( is_admin() ) {
1301            return true;
1302        }
1303
1304        /*
1305         * Treat any non-front-end execution context as block-editor. These are not the
1306         * front-end hot path this gate optimizes, and some still render block content
1307         * (e.g. cron-generated subscription e-mails) that depends on full registration.
1308         *
1309         * Core defines REST_REQUEST during parse_request, after this runs, so it is
1310         * normally still unset here; it is checked anyway so the result stays correct
1311         * if this is ever called later in the request. REST_API_REQUEST is what catches
1312         * WordPress.com Simple, where the URL check below cannot work at all (see the
1313         * method docblock).
1314         */
1315        if (
1316            Constants::is_true( 'DOING_CRON' )
1317            || Constants::is_true( 'WP_CLI' )
1318            || Constants::is_true( 'XMLRPC_REQUEST' )
1319            || Constants::is_true( 'REST_REQUEST' )
1320            || Constants::is_true( 'REST_API_REQUEST' )
1321        ) {
1322            return true;
1323        }
1324
1325        /*
1326         * No request URI means a non-web execution context (WP-CLI without it, test
1327         * suites, etc.). A genuine front-end page request always carries one, so it
1328         * costs nothing on the hot path to treat the empty case as "load eagerly".
1329         */
1330        $request_uri = isset( $_SERVER['REQUEST_URI'] ) ? sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : '';
1331        if ( '' === $request_uri ) {
1332            return true;
1333        }
1334
1335        /*
1336         * Anchor the REST root (home path + prefix) at the start of the request path,
1337         * so a front-end URL that merely carries the prefix in a query value or a
1338         * deeper path segment is not misread as a REST request. home_url() is used
1339         * rather than rest_url() so detection does not depend on permalink structure.
1340         * Both the rewritten `/wp-json/` form and the index-permalink
1341         * `/index.php/wp-json/` form (used when the site lacks pretty permalinks) are
1342         * matched.
1343         */
1344        $path = (string) wp_parse_url( $request_uri, PHP_URL_PATH );
1345        if ( '' !== $path ) {
1346            $home_path   = trailingslashit( (string) wp_parse_url( home_url(), PHP_URL_PATH ) );
1347            $rest_prefix = trailingslashit( rest_get_url_prefix() );
1348            $rest_roots  = array(
1349                $home_path . $rest_prefix,
1350                $home_path . 'index.php/' . $rest_prefix,
1351            );
1352            foreach ( $rest_roots as $rest_root ) {
1353                if ( str_starts_with( trailingslashit( $path ), $rest_root ) ) {
1354                    return true;
1355                }
1356            }
1357        }
1358
1359        // Plain-permalink REST uses a `rest_route` query var; match the exact key.
1360        $query = (string) wp_parse_url( $request_uri, PHP_URL_QUERY );
1361        if ( '' !== $query ) {
1362            parse_str( $query, $query_vars );
1363            if ( ! empty( $query_vars['rest_route'] ) ) {
1364                return true;
1365            }
1366        }
1367
1368        return false;
1369    }
1370
1371    /**
1372     * Editor-oriented extensions that nonetheless have front-end side effects and must
1373     * therefore keep loading on every request, even outside the block editor.
1374     *
1375     * Keyed by directory ('plugins' / 'extended-blocks') for an exact, intentional match.
1376     *
1377     * @since 16.0
1378     *
1379     * @var array
1380     */
1381    private static $frontend_editor_extensions = array(
1382        'plugins'         => array(
1383            // Mounts the Reader Chat widget on the front end (wp_enqueue_scripts) and
1384            // wires the AI sidebar/provider registration AI Assistant depends on.
1385            'ai-assistant-plugin',
1386            // Signals Big Sky via the jetpack_image_studio_enabled filter on `init`,
1387            // which can run on the front end.
1388            'image-studio',
1389        ),
1390        'extended-blocks' => array(
1391            // Registers the videopress/video block on `init`, required to render it on the front end.
1392            'videopress-video',
1393            // Registers the `premium-content/container` plan availability that the Premium Content
1394            // block's front-end render reads via required_plan_checks(); skipping it breaks the paywall.
1395            'premium-content-container',
1396        ),
1397    );
1398
1399    /**
1400     * Loads PHP components of block editor extensions.
1401     *
1402     * @since 8.9.0
1403     */
1404    public static function load_block_editor_extensions() {
1405        if ( self::should_load() ) {
1406            // Block editor extensions to load.
1407            $extensions_to_load = array(
1408                'extended-blocks',
1409                'plugins',
1410            );
1411
1412            $is_editor_context = self::is_block_editor_context();
1413
1414            // Collect the extension paths.
1415            foreach ( $extensions_to_load as $extension_to_load ) {
1416                $extensions_folder = glob( JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/*' );
1417
1418                $frontend_allow_list = self::$frontend_editor_extensions[ $extension_to_load ] ?? array();
1419
1420                // Require each of the extension files, in case it exists.
1421                foreach ( $extensions_folder as $extension_folder ) {
1422                    $name = basename( $extension_folder );
1423
1424                    /*
1425                     * On plain front-end requests, only load extensions that have known
1426                     * front-end side effects. Editor-only extensions are skipped here and
1427                     * loaded on admin/REST (block-editor) requests instead, reducing the
1428                     * per-front-end-request PHP/opcache footprint.
1429                     */
1430                    if ( ! $is_editor_context && ! in_array( $name, $frontend_allow_list, true ) ) {
1431                        continue;
1432                    }
1433
1434                    $extension_file_path = JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/' . $name . '/' . $name . '.php';
1435
1436                    if ( file_exists( $extension_file_path ) ) {
1437                        include_once $extension_file_path;
1438                    }
1439                }
1440            }
1441        }
1442    }
1443
1444    /**
1445     * Determine whether a site should use the default set of blocks, or a custom set.
1446     * Possible variations are currently beta, experimental, and production.
1447     *
1448     * @since 8.1.0
1449     *
1450     * @return string $block_varation production|beta|experimental
1451     */
1452    public static function blocks_variation() {
1453        // Default to production blocks.
1454        $block_varation = 'production';
1455
1456        /*
1457         * Prefer to use this JETPACK_BLOCKS_VARIATION constant
1458         * or the jetpack_blocks_variation filter
1459         * to set the block variation in your code.
1460         */
1461        $default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
1462        if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
1463            $block_varation = $default;
1464        }
1465
1466        /**
1467        * Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
1468        *
1469        * @since 6.9.0
1470        * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
1471        *
1472        * @param boolean
1473        */
1474        $is_beta = apply_filters_deprecated(
1475            'jetpack_load_beta_blocks',
1476            array( false ),
1477            'jetpack-11.8.0',
1478            'jetpack_blocks_variation'
1479        );
1480
1481        /*
1482         * Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
1483         * or the deprecated jetpack_load_beta_blocks filter.
1484         * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
1485         */
1486        if (
1487            empty( $default )
1488            && (
1489                $is_beta
1490                || Constants::is_true( 'JETPACK_BETA_BLOCKS' )
1491            )
1492        ) {
1493            $block_varation = 'beta';
1494        }
1495
1496        /**
1497        * Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
1498        *
1499        * @since 6.9.0
1500        * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
1501        *
1502        * @param boolean
1503        */
1504        $is_experimental = apply_filters_deprecated(
1505            'jetpack_load_experimental_blocks',
1506            array( false ),
1507            'jetpack-11.8.0',
1508            'jetpack_blocks_variation'
1509        );
1510
1511        /*
1512         * Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
1513         * or the deprecated jetpack_load_experimental_blocks filter.
1514         * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
1515         */
1516        if (
1517            empty( $default )
1518            && (
1519                $is_experimental
1520                || Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
1521            )
1522        ) {
1523            $block_varation = 'experimental';
1524        }
1525
1526        /**
1527         * Allow customizing the variation of blocks in use on a site.
1528         * Overwrites any previously set values, whether by constant or filter.
1529         *
1530         * @since 8.1.0
1531         *
1532         * @param string $block_variation Can be beta, experimental, and production. Defaults to production.
1533         */
1534        return apply_filters( 'jetpack_blocks_variation', $block_varation );
1535    }
1536
1537    /**
1538     * Get a list of extensions available for the variation you chose.
1539     *
1540     * @since 8.1.0
1541     *
1542     * @param object $preset_extensions_manifest List of extensions available in Jetpack.
1543     * @param string $blocks_variation           Subset of blocks. production|beta|experimental.
1544     *
1545     * @return array $preset_extensions Array of extensions for that variation
1546     */
1547    public static function get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation ) {
1548        $preset_extensions = isset( $preset_extensions_manifest->{ $blocks_variation } )
1549                ? (array) $preset_extensions_manifest->{ $blocks_variation }
1550                : array();
1551
1552        /*
1553         * Experimental and Beta blocks need the production blocks as well.
1554         */
1555        if (
1556            'experimental' === $blocks_variation
1557            || 'beta' === $blocks_variation
1558        ) {
1559            $production_extensions = isset( $preset_extensions_manifest->production )
1560                ? (array) $preset_extensions_manifest->production
1561                : array();
1562
1563            $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
1564        }
1565
1566        /*
1567         * Beta blocks need the experimental blocks as well.
1568         *
1569         * If you've chosen to see Beta blocks,
1570         * we want to make all blocks available to you:
1571         * - Production
1572         * - Experimental
1573         * - Beta
1574         */
1575        if ( 'beta' === $blocks_variation ) {
1576            $production_extensions = isset( $preset_extensions_manifest->experimental )
1577                ? (array) $preset_extensions_manifest->experimental
1578                : array();
1579
1580            $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
1581        }
1582
1583        return $preset_extensions;
1584    }
1585
1586    /**
1587     * Validate a URL used in a SSR block.
1588     *
1589     * @since 8.3.0
1590     *
1591     * @param string $url      URL saved as an attribute in block.
1592     * @param array  $allowed  Array of allowed hosts for that block, or regexes to check against.
1593     * @param bool   $is_regex Array of regexes matching the URL that could be used in block.
1594     *
1595     * @return bool|string
1596     */
1597    public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
1598        if (
1599            empty( $url )
1600            || ! is_array( $allowed )
1601            || empty( $allowed )
1602        ) {
1603            return false;
1604        }
1605
1606        $url_components = wp_parse_url( $url );
1607
1608        // Bail early if we cannot find a host.
1609        if ( empty( $url_components['host'] ) ) {
1610            return false;
1611        }
1612
1613        // Only http and https URLs are valid.
1614        if (
1615            isset( $url_components['scheme'] )
1616            && ! in_array( strtolower( $url_components['scheme'] ), array( 'http', 'https' ), true )
1617        ) {
1618            return false;
1619        }
1620
1621        // Normalize URL.
1622        $url = sprintf(
1623            '%s://%s%s%s',
1624            $url_components['scheme'] ?? 'https',
1625            $url_components['host'],
1626            $url_components['path'] ?? '/',
1627            isset( $url_components['query'] ) ? '?' . $url_components['query'] : ''
1628        );
1629
1630        if ( ! empty( $url_components['fragment'] ) ) {
1631            $url = $url . '#' . rawurlencode( $url_components['fragment'] );
1632        }
1633
1634        /*
1635         * If we're using an allowed list of hosts,
1636         * check if the URL belongs to one of the domains allowed for that block.
1637         */
1638        if (
1639            false === $is_regex
1640            && in_array( $url_components['host'], $allowed, true )
1641        ) {
1642            return $url;
1643        }
1644
1645        /*
1646         * If we are using an array of regexes to check against,
1647         * loop through that.
1648         */
1649        if ( true === $is_regex ) {
1650            foreach ( $allowed as $regex ) {
1651                if ( 1 === preg_match( $regex, $url ) ) {
1652                    return $url;
1653                }
1654            }
1655        }
1656
1657        return false;
1658    }
1659
1660    /**
1661     * Determines whether a preview of the block with an upgrade nudge should
1662     * be displayed for admins on the site frontend.
1663     *
1664     * @since 8.4.0
1665     *
1666     * @param array $availability_for_block The availability for the block.
1667     *
1668     * @return bool
1669     */
1670    public static function should_show_frontend_preview( $availability_for_block ) {
1671        return (
1672            isset( $availability_for_block['details']['required_plan'] )
1673            && current_user_can( 'manage_options' )
1674            && ! is_feed()
1675        );
1676    }
1677
1678    /**
1679     * Output an UpgradeNudge Component on the frontend of a site.
1680     *
1681     * @since 8.4.0
1682     *
1683     * @param string $plan The plan that users need to purchase to make the block work.
1684     *
1685     * @return string
1686     */
1687    public static function upgrade_nudge( $plan ) {
1688        require_once JETPACK__PLUGIN_DIR . '_inc/lib/components.php';
1689        return Jetpack_Components::render_upgrade_nudge(
1690            array(
1691                'plan' => $plan,
1692            )
1693        );
1694    }
1695
1696    /**
1697     * Output a notice within a block.
1698     *
1699     * @since 8.6.0
1700     *
1701     * @param string $message Notice we want to output.
1702     * @param string $status  Status of the notice. Can be one of success, info, warning, error. info by default.
1703     * @param string $classes List of CSS classes.
1704     *
1705     * @return string
1706     */
1707    public static function notice( $message, $status = 'info', $classes = '' ) {
1708        if (
1709            empty( $message )
1710            || ! in_array( $status, array( 'success', 'info', 'warning', 'error' ), true )
1711        ) {
1712            return '';
1713        }
1714
1715        $color = '';
1716        switch ( $status ) {
1717            case 'success':
1718                $color = '#00a32a';
1719                break;
1720            case 'warning':
1721                $color = '#dba617';
1722                break;
1723            case 'error':
1724                $color = '#d63638';
1725                break;
1726            case 'info':
1727            default:
1728                $color = '#72aee6';
1729                break;
1730        }
1731
1732        return sprintf(
1733            '<div class="jetpack-block__notice %1$s %3$s" style="border-left:5px solid %4$s;padding:1em;background-color:#f8f9f9;">%2$s</div>',
1734            esc_attr( $status ),
1735            wp_kses(
1736                $message,
1737                array(
1738                    'br' => array(),
1739                    'p'  => array(),
1740                    'a'  => array(
1741                        'href'   => array(),
1742                        'target' => array(),
1743                        'rel'    => array(),
1744                    ),
1745                )
1746            ),
1747            esc_attr( $classes ),
1748            sanitize_hex_color( $color )
1749        );
1750    }
1751
1752    /**
1753     * Retrieve site-specific features for Simple sites.
1754     *
1755     * We're caching the data for the lifetime of the request, because it can be slow to calculate,
1756     * and it can be called multiple times per single request.
1757     *
1758     * We intentionally don't use object caching or any other type of persistent caching,
1759     * in order to avoid complex cache invalidation on subscription addition or removal.
1760     *
1761     * @since 10.7
1762     *
1763     * @return array
1764     */
1765    private static function get_site_specific_features() {
1766        $current_blog_id = get_current_blog_id();
1767
1768        if ( isset( self::$site_specific_features[ $current_blog_id ] ) ) {
1769            return self::$site_specific_features[ $current_blog_id ];
1770        }
1771
1772        if ( ! class_exists( 'Store_Product_List' ) ) {
1773            require WP_CONTENT_DIR . '/admin-plugins/wpcom-billing/store-product-list.php';
1774        }
1775
1776        $site_specific_features                           = Store_Product_List::get_site_specific_features_data( $current_blog_id );
1777        self::$site_specific_features[ $current_blog_id ] = $site_specific_features;
1778
1779        return $site_specific_features;
1780    }
1781
1782    /**
1783     * Set the availability of the block as the editor
1784     * is loaded.
1785     *
1786     * @param string $slug Slug of the block.
1787     */
1788    public static function set_availability_for_plan( $slug ) {
1789        $slug = self::remove_extension_prefix( $slug );
1790
1791        if ( Jetpack_Plan::supports( $slug ) ) {
1792            self::set_extension_available( $slug );
1793            return;
1794        }
1795
1796        // Check what's the minimum plan where the feature is available.
1797        $plan           = '';
1798        $features_data  = array();
1799        $is_simple_site = defined( 'IS_WPCOM' ) && IS_WPCOM;
1800        $is_atomic_site = ( new Host() )->is_woa_site();
1801
1802        if ( $is_simple_site || $is_atomic_site ) {
1803            // Simple sites.
1804            if ( $is_simple_site ) {
1805                $features_data = self::get_site_specific_features();
1806            } else {
1807                // Atomic sites.
1808                $option = get_option( 'jetpack_active_plan' );
1809                if ( isset( $option['features'] ) ) {
1810                    $features_data = $option['features'];
1811                }
1812            }
1813
1814            if ( ! empty( $features_data['available'][ $slug ] ) ) {
1815                $plan = $features_data['available'][ $slug ][0];
1816            } elseif ( isset( self::$wpcom_minimum_plan_fallbacks[ $slug ] ) ) {
1817                // Fallback for features with conditional availability (e.g., sticker-based gating)
1818                // that don't appear in features_data['available'].
1819                $plan = self::$wpcom_minimum_plan_fallbacks[ $slug ];
1820            }
1821        } else {
1822            // Jetpack sites.
1823            $plan = Jetpack_Plan::get_minimum_plan_for_feature( $slug );
1824        }
1825
1826        self::set_extension_unavailable(
1827            $slug,
1828            'missing_plan',
1829            array(
1830                'required_feature' => $slug,
1831                'required_plan'    => $plan,
1832            )
1833        );
1834    }
1835
1836    /**
1837     * Wraps the suplied render_callback in a function to check
1838     * the availability of the block before rendering it.
1839     *
1840     * @param string   $slug The block slug, used to check for availability.
1841     * @param callable $render_callback The render_callback that will be called if the block is available.
1842     */
1843    public static function get_render_callback_with_availability_check( $slug, $render_callback ) {
1844        return function ( $prepared_attributes, $block_content, $block ) use ( $render_callback, $slug ) {
1845            $availability = self::get_cached_availability();
1846            $bare_slug    = self::remove_extension_prefix( $slug );
1847            if ( isset( $availability[ $bare_slug ] ) && $availability[ $bare_slug ]['available'] ) {
1848                return call_user_func( $render_callback, $prepared_attributes, $block_content, $block );
1849            }
1850
1851            // A preview of the block is rendered for admins on the frontend with an upgrade nudge.
1852            if ( isset( $availability[ $bare_slug ] ) ) {
1853                if ( self::should_show_frontend_preview( $availability[ $bare_slug ] ) ) {
1854                    $block_preview = call_user_func( $render_callback, $prepared_attributes, $block_content, $block );
1855
1856                    // If the upgrade nudge isn't already being displayed by a parent block, display the nudge.
1857                    if ( isset( $block->attributes['shouldDisplayFrontendBanner'] ) && $block->attributes['shouldDisplayFrontendBanner'] ) {
1858                        $upgrade_nudge = self::upgrade_nudge( $availability[ $bare_slug ]['details']['required_plan'] );
1859                        return $upgrade_nudge . $block_preview;
1860                    }
1861
1862                    return $block_preview;
1863                }
1864            }
1865
1866            return null;
1867        };
1868    }
1869
1870    /**
1871     * Display a message to site editors and roles above when a block is no longer supported.
1872     * This is only displayed on the frontend.
1873     *
1874     * @since 12.3
1875     *
1876     * @param string $block_content The block content.
1877     * @param array  $block         The full block, including name and attributes.
1878     *
1879     * @return string
1880     */
1881    public static function display_deprecated_block_message( $block_content, $block ) {
1882        if ( isset( $block['blockName'] ) && in_array( $block['blockName'], self::$deprecated_blocks, true ) ) {
1883            if ( current_user_can( 'edit_posts' ) ) {
1884                $block_content = self::notice(
1885                    __( 'This block is no longer supported. Its contents will no longer be displayed to your visitors and as such this block should be removed.', 'jetpack' ),
1886                    'warning',
1887                    'jetpack-block-deprecated'
1888                );
1889            } else {
1890                $block_content = '';
1891            }
1892        }
1893
1894        return $block_content;
1895    }
1896
1897    /**
1898     * Register block metadata collection for Jetpack blocks.
1899     * This allows for more efficient block metadata loading by avoiding
1900     * individual block.json file reads at runtime.
1901     *
1902     * Uses wp_register_block_metadata_collection() if the manifest file
1903     * exists. The manifest file is auto-generated during the build process.
1904     *
1905     * Runs on plugins_loaded to ensure registration happens before individual
1906     * blocks register themselves on init.
1907     *
1908     * @static
1909     * @since 14.1
1910     * @return void
1911     */
1912    public static function register_block_metadata_collection() {
1913        $meta_file_path = JETPACK__PLUGIN_DIR . '_inc/blocks/blocks-manifest.php';
1914        if ( file_exists( $meta_file_path ) ) {
1915            wp_register_block_metadata_collection(
1916                JETPACK__PLUGIN_DIR . '_inc/blocks/',
1917                $meta_file_path
1918            );
1919        }
1920    }
1921
1922    /**
1923     * Set the JS loading strategy for a block.
1924     *
1925     * @param string     $block_name The block name.
1926     * @param array|bool $strategy   The JS loading strategy.
1927     *
1928     * @since 15.0
1929     */
1930    public static function set_block_js_loading_strategy( $block_name, $strategy ) {
1931        self::$block_js_loading_strategies[ $block_name ] = $strategy;
1932    }
1933
1934    /**
1935     * Get the JS loading strategy for a block.
1936     *
1937     * @param string $block_name The block name.
1938     *
1939     * @return array|bool The JS loading strategy for the block.
1940     *
1941     * @since 15.0
1942     */
1943    public static function get_block_js_loading_strategy( $block_name ) {
1944        $strategy = array(
1945            'strategy'  => 'defer',
1946            'in_footer' => true,
1947        );
1948
1949        if ( isset( self::$block_js_loading_strategies[ $block_name ] ) ) {
1950            $strategy = self::$block_js_loading_strategies[ $block_name ];
1951        }
1952
1953        return $strategy;
1954    }
1955}
1956
1957if ( ( new Host() )->is_woa_site() ) {
1958    /**
1959    * Enable upgrade nudge for Atomic sites.
1960     * This feature is false as default,
1961     * so let's enable it through this filter.
1962     *
1963     * More doc: https://github.com/Automattic/jetpack/blob/trunk/projects/plugins/jetpack/extensions/README.md#upgrades-for-blocks
1964     */
1965    add_filter( 'jetpack_block_editor_enable_upgrade_nudge', '__return_true' );
1966}