class.jetpack-gutenberg.php — Jetpack – WP Security, Backup, Speed, & Growth 14.0.1

jetpack / class.jetpack-gutenberg.php

jetpack Last commit date

class.jetpack-gutenberg.php

1346 lines

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
9	use Automattic\Jetpack\Assets;
10	use Automattic\Jetpack\Blocks;
11	use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
12	use Automattic\Jetpack\Connection\Manager as Connection_Manager;
13	use Automattic\Jetpack\Constants;
14	use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
15	use Automattic\Jetpack\Modules;
16	use Automattic\Jetpack\My_Jetpack\Initializer as My_Jetpack_Initializer;
17	use Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Dismissed_Notices;
18	use Automattic\Jetpack\Status;
19	use Automattic\Jetpack\Status\Host;
20
21	// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move the functions and such to some other file.
22
23	/**
24	* General Gutenberg editor specific functionality
25	*/
26	class Jetpack_Gutenberg {
27
28	/**
29	* Only these extensions can be registered. Used to control availability of beta blocks.
30	*
31	* @var array\|null Extensions allowed list or `null` if not initialized yet.
32	* @see static::get_extensions()
33	*/
34	private static $extensions = null;
35
36	/**
37	* Keeps track of the reasons why a given extension is unavailable.
38	*
39	* @var array Extensions availability information
40	*/
41	private static $availability = array();
42
43	/**
44	* A cached array of the fully processed availability data. Keeps track of
45	* reasons why an extension is unavailable or missing.
46	*
47	* @var array Extensions availability information.
48	*/
49	private static $cached_availability = null;
50
51	/**
52	* Site-specific features available.
53	* Their calculation can be expensive and slow, so we're caching it for the request.
54	*
55	* @var array Site-specific features
56	*/
57	private static $site_specific_features = array();
58
59	/**
60	* List of deprecated blocks.
61	*
62	* @var array List of deprecated blocks.
63	*/
64	private static $deprecated_blocks = array(
65	'jetpack/revue',
66	);
67
68	/**
69	* Check to see if a minimum version of Gutenberg is available. Because a Gutenberg version is not available in
70	* php if the Gutenberg plugin is not installed, if we know which minimum WP release has the required version we can
71	* optionally fall back to that.
72	*
73	* @param array $version_requirements An array containing the required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
74	* @param string $slug The slug of the block or plugin that has the gutenberg version requirement.
75	*
76	* @since 8.3.0
77	*
78	* @return boolean True if the version of gutenberg required by the block or plugin is available.
79	*/
80	public static function is_gutenberg_version_available( $version_requirements, $slug ) {
81	global $wp_version;
82
83	// Bail if we don't at least have the gutenberg version requirement, the WP version is optional.
84	if ( empty( $version_requirements['gutenberg'] ) ) {
85	return false;
86	}
87
88	// If running a local dev build of gutenberg plugin GUTENBERG_DEVELOPMENT_MODE is set so assume correct version.
89	if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
90	return true;
91	}
92
93	$version_available = false;
94
95	// If running a production build of the gutenberg plugin then GUTENBERG_VERSION is set, otherwise if WP version
96	// with required version of Gutenberg is known check that.
97	if ( defined( 'GUTENBERG_VERSION' ) ) {
98	$version_available = version_compare( GUTENBERG_VERSION, $version_requirements['gutenberg'], '>=' );
99	} elseif ( ! empty( $version_requirements['wp'] ) ) {
100	$version_available = version_compare( $wp_version, $version_requirements['wp'], '>=' );
101	}
102
103	if ( ! $version_available ) {
104	self::set_extension_unavailable(
105	$slug,
106	'incorrect_gutenberg_version',
107	array(
108	'required_feature' => $slug,
109	'required_version' => $version_requirements,
110	'current_version' => array(
111	'wp' => $wp_version,
112	'gutenberg' => defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : null,
113	),
114	)
115	);
116	}
117
118	return $version_available;
119	}
120
121	/**
122	* Prepend the 'jetpack/' prefix to a block name
123	*
124	* @param string $block_name The block name.
125	*
126	* @return string The prefixed block name.
127	*/
128	private static function prepend_block_prefix( $block_name ) {
129	return 'jetpack/' . $block_name;
130	}
131
132	/**
133	* Remove the 'jetpack/' or jetpack-' prefix from an extension name
134	*
135	* @param string $extension_name The extension name.
136	*
137	* @return string The unprefixed extension name.
138	*/
139	public static function remove_extension_prefix( $extension_name ) {
140	if ( str_starts_with( $extension_name, 'jetpack/' ) \|\| str_starts_with( $extension_name, 'jetpack-' ) ) {
141	return substr( $extension_name, strlen( 'jetpack/' ) );
142	}
143	return $extension_name;
144	}
145
146	/**
147	* Whether two arrays share at least one item
148	*
149	* @param array $a An array.
150	* @param array $b Another array.
151	*
152	* @return boolean True if $a and $b share at least one item
153	*/
154	protected static function share_items( $a, $b ) {
155	return array_intersect( $a, $b ) !== array();
156	}
157
158	/**
159	* Set a (non-block) extension as available
160	*
161	* @param string $slug Slug of the extension.
162	*/
163	public static function set_extension_available( $slug ) {
164	self::$availability[ self::remove_extension_prefix( $slug ) ] = true;
165	}
166
167	/**
168	* Set the reason why an extension (block or plugin) is unavailable
169	*
170	* @param string $slug Slug of the extension.
171	* @param string $reason A string representation of why the extension is unavailable.
172	* @param array $details A free-form array containing more information on why the extension is unavailable.
173	*/
174	public static function set_extension_unavailable( $slug, $reason, $details = array() ) {
175	if (
176	// Extensions that require a plan may be eligible for upgrades.
177	'missing_plan' === $reason
178	&& (
179	/**
180	* Filter 'jetpack_block_editor_enable_upgrade_nudge' with `true` to enable or `false`
181	* to disable paid feature upgrade nudges in the block editor.
182	*
183	* When this is changed to default to `true`, you should also update `modules/memberships/class-jetpack-memberships.php`
184	* See https://github.com/Automattic/jetpack/pull/13394#pullrequestreview-293063378
185	*
186	* @since 7.7.0
187	*
188	* @param boolean
189	*/
190	! apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false )
191	/** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
192	\|\| ! apply_filters( 'jetpack_show_promotions', true )
193	)
194	) {
195	// The block editor may apply an upgrade nudge if `missing_plan` is the reason.
196	// Add a descriptive suffix to disable behavior but provide informative reason.
197	$reason .= '__nudge_disabled';
198	}
199
200	self::$availability[ self::remove_extension_prefix( $slug ) ] = array(
201	'reason' => $reason,
202	'details' => $details,
203	);
204	}
205
206	/**
207	* Used to initialize the class, no longer in use.
208	*
209	* @return void
210	* @deprecated 12.2 No longer needed.
211	*/
212	public static function init() {
213	_deprecated_function( __METHOD__, '12.2' );
214	}
215
216	/**
217	* Resets the class to its original state
218	*
219	* Used in unit tests
220	*
221	* @return void
222	*/
223	public static function reset() {
224	self::$extensions = null;
225	self::$availability = array();
226	self::$cached_availability = null;
227	}
228
229	/**
230	* Return the Gutenberg extensions (blocks and plugins) directory
231	*
232	* @return string The Gutenberg extensions directory
233	*/
234	public static function get_blocks_directory() {
235	/**
236	* Filter to select Gutenberg blocks directory
237	*
238	* @since 6.9.0
239	*
240	* @param string default: '_inc/blocks/'
241	*/
242	return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
243	}
244
245	/**
246	* Checks for a given .json file in the blocks folder.
247	*
248	* @param string $preset The name of the .json file to look for.
249	*
250	* @return bool True if the file is found.
251	*/
252	public static function preset_exists( $preset ) {
253	return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
254	}
255
256	/**
257	* Decodes JSON loaded from a preset file in the blocks folder
258	*
259	* @param string $preset The name of the .json file to load.
260	*
261	* @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
262	*/
263	public static function get_preset( $preset ) {
264	return json_decode(
265	// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
266	file_get_contents( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' )
267	);
268	}
269
270	/**
271	* Returns a list of Jetpack Gutenberg extensions (blocks and plugins), based on index.json
272	*
273	* @return array A list of blocks: eg [ 'publicize', 'markdown' ]
274	*/
275	public static function get_jetpack_gutenberg_extensions_allowed_list() {
276	$preset_extensions_manifest = self::preset_exists( 'index' )
277	? self::get_preset( 'index' )
278	: (object) array();
279	$blocks_variation = self::blocks_variation();
280
281	return self::get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation );
282	}
283
284	/**
285	* Returns a diff from a combined list of allowed extensions and extensions determined to be excluded
286	*
287	* @param array $allowed_extensions An array of allowed extensions.
288	*
289	* @return array A list of blocks: eg array( 'publicize', 'markdown' )
290	*/
291	public static function get_available_extensions( $allowed_extensions = null ) {
292	$exclusions = get_option( 'jetpack_excluded_extensions', array() );
293	$allowed_extensions = $allowed_extensions === null ? self::get_jetpack_gutenberg_extensions_allowed_list() : $allowed_extensions;
294
295	return array_diff( $allowed_extensions, $exclusions );
296	}
297
298	/**
299	* Return true if the extension has been registered and there's nothing in the availablilty array.
300	*
301	* @param string $extension The name of the extension.
302	*
303	* @return bool whether the extension has been registered and there's nothing in the availablilty array.
304	*/
305	public static function is_registered_and_no_entry_in_availability( $extension ) {
306	return self::is_registered( 'jetpack/' . $extension ) && ! isset( self::$availability[ $extension ] );
307	}
308
309	/**
310	* Return true if the extension has a true entry in the availablilty array.
311	*
312	* @param string $extension The name of the extension.
313	*
314	* @return bool whether the extension has a true entry in the availablilty array.
315	*/
316	public static function is_available( $extension ) {
317	return isset( self::$availability[ $extension ] ) && true === self::$availability[ $extension ];
318	}
319
320	/**
321	* Get the availability of each block / plugin, or return the cached availability
322	* if it has already been calculated. Avoids re-registering extensions when not
323	* necessary.
324	*
325	* @return array A list of block and plugins and their availability status.
326	*/
327	public static function get_cached_availability() {
328	if ( null === self::$cached_availability ) {
329	self::$cached_availability = self::get_availability();
330	}
331	return self::$cached_availability;
332	}
333
334	/**
335	* Get availability of each block / plugin.
336	*
337	* @return array A list of block and plugins and their availablity status
338	*/
339	public static function get_availability() {
340	/**
341	* Fires before Gutenberg extensions availability is computed.
342	*
343	* In the function call you supply, use `Blocks::jetpack_register_block()` to set a block as available.
344	* Alternatively, use `Jetpack_Gutenberg::set_extension_available()` (for a non-block plugin), and
345	* `Jetpack_Gutenberg::set_extension_unavailable()` (if the block or plugin should not be registered
346	* but marked as unavailable).
347	*
348	* @since 7.0.0
349	*/
350	do_action( 'jetpack_register_gutenberg_extensions' );
351
352	$available_extensions = array();
353
354	foreach ( static::get_extensions() as $extension ) {
355	$is_available = self::is_registered_and_no_entry_in_availability( $extension ) \|\| self::is_available( $extension );
356	$available_extensions[ $extension ] = array(
357	'available' => $is_available,
358	);
359
360	if ( ! $is_available ) {
361	$reason = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['reason'] : 'missing_module';
362	$details = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['details'] : array();
363	$available_extensions[ $extension ]['unavailable_reason'] = $reason;
364	$available_extensions[ $extension ]['details'] = $details;
365	}
366	}
367
368	return $available_extensions;
369	}
370
371	/**
372	* Return the list of extensions that are available.
373	*
374	* @since 11.9
375	*
376	* @return array A list of block and plugins and their availability status.
377	*/
378	public static function get_extensions() {
379	if ( ! static::should_load() ) {
380	return array();
381	}
382
383	if ( null === self::$extensions ) {
384	/**
385	* Filter the list of block editor extensions that are available through Jetpack.
386	*
387	* @since 7.0.0
388	*
389	* @param array
390	*/
391	self::$extensions = apply_filters( 'jetpack_set_available_extensions', self::get_available_extensions() );
392	}
393
394	return self::$extensions;
395	}
396
397	/**
398	* Check if an extension/block is already registered
399	*
400	* @since 7.2
401	*
402	* @param string $slug Name of extension/block to check.
403	*
404	* @return bool
405	*/
406	public static function is_registered( $slug ) {
407	return WP_Block_Type_Registry::get_instance()->is_registered( $slug );
408	}
409
410	/**
411	* Check if Gutenberg editor is available
412	*
413	* @since 6.7.0
414	*
415	* @return bool
416	*/
417	public static function is_gutenberg_available() {
418	return true;
419	}
420
421	/**
422	* Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
423	*
424	* Loading blocks and plugins is enabled by default and may be disabled via filter:
425	* add_filter( 'jetpack_gutenberg', '__return_false' );
426	*
427	* @since 6.9.0
428	*
429	* @return bool
430	*/
431	public static function should_load() {
432	if ( ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
433	return false;
434	}
435
436	$return = true;
437
438	if ( ! ( new Modules() )->is_active( 'blocks' ) ) {
439	$return = false;
440	}
441
442	/**
443	* Filter to enable Gutenberg blocks.
444	*
445	* Defaults to true if (connected or in offline mode) and the Blocks module is active.
446	*
447	* @since 6.5.0
448	* @since 13.9 Filter is able to activate or deactivate Gutenberg blocks.
449	*
450	* @param bool true Whether to load Gutenberg blocks
451	*/
452	return (bool) apply_filters( 'jetpack_gutenberg', $return );
453	}
454
455	/**
456	* Queue a script to set `Jetpack_Block_Assets_Base_Url`.
457	*
458	* In certain cases Webpack needs to know a base to load additional assets from.
459	* Normally it can determine that itself, but when JS concatenation is involved that tends to confuse it.
460	* We work around that by explicitly outputting a variable with the correct URL.
461	* We set that as its own "script" so we can reliably only output it once.
462	*/
463	private static function register_blocks_assets_base_url() {
464	if ( ! wp_script_is( 'jetpack-blocks-assets-base-url', 'registered' ) ) {
465	// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- No actual script, so no version needed.
466	wp_register_script( 'jetpack-blocks-assets-base-url', false, array(), null, array( 'in_footer' => false ) );
467	$json_encode_flags = JSON_UNESCAPED_SLASHES \| JSON_HEX_TAG \| JSON_HEX_AMP;
468	if ( get_option( 'blog_charset' ) === 'UTF-8' ) {
469	$json_encode_flags \|= JSON_UNESCAPED_UNICODE;
470	}
471	wp_add_inline_script(
472	'jetpack-blocks-assets-base-url',
473	'var Jetpack_Block_Assets_Base_Url=' . wp_json_encode( plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE ), $json_encode_flags ) . ';',
474	'before'
475	);
476	}
477	}
478
479	/**
480	* Only enqueue block assets when needed.
481	*
482	* @param string $type Slug of the block or absolute path to the block source code directory.
483	* @param array $script_dependencies Script dependencies. Will be merged with automatically
484	* detected script dependencies from the webpack build.
485	*
486	* @return void
487	*/
488	public static function load_assets_as_required( $type, $script_dependencies = array() ) {
489	if ( is_admin() ) {
490	// A block's view assets will not be required in wp-admin.
491	return;
492	}
493
494	// Retrieve the feature from block.json if a path is passed.
495	if ( path_is_absolute( $type ) ) {
496	$metadata = Blocks::get_block_metadata_from_file( Blocks::get_path_to_block_metadata( $type ) );
497	$feature = Blocks::get_block_feature_from_metadata( $metadata );
498
499	if ( ! empty( $feature ) ) {
500	$type = $feature;
501	}
502	}
503
504	$type = sanitize_title_with_dashes( $type );
505	self::load_styles_as_required( $type );
506	self::load_scripts_as_required( $type, $script_dependencies );
507	}
508
509	/**
510	* Only enqueue block sytles when needed.
511	*
512	* @param string $type Slug of the block.
513	*
514	* @since 7.2.0
515	*
516	* @return void
517	*/
518	public static function load_styles_as_required( $type ) {
519	if ( is_admin() ) {
520	// A block's view assets will not be required in wp-admin.
521	return;
522	}
523
524	// Enqueue styles.
525	$style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
526	if ( self::block_has_asset( $style_relative_path ) ) {
527	$style_version = self::get_asset_version( $style_relative_path );
528	$view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
529	$view_style = add_query_arg( 'minify', 'false', $view_style );
530
531	// If this is a customizer preview, render the style directly to the preview after autosave.
532	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
533	if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
534	// phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
535	echo '<link rel="stylesheet" id="jetpack-block-' . esc_attr( $type ) . '" href="' . esc_attr( $view_style ) . '&ver=' . esc_attr( $style_version ) . '" media="all">';
536	} else {
537	wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
538	wp_style_add_data( 'jetpack-block-' . $type, 'path', JETPACK__PLUGIN_DIR . $style_relative_path );
539	}
540	}
541	}
542
543	/**
544	* Only enqueue block scripts when needed.
545	*
546	* @param string $type Slug of the block.
547	* @param array $script_dependencies Script dependencies. Will be merged with automatically
548	* detected script dependencies from the webpack build.
549	*
550	* @since 7.2.0
551	*
552	* @return void
553	*/
554	public static function load_scripts_as_required( $type, $script_dependencies = array() ) {
555	if ( is_admin() ) {
556	// A block's view assets will not be required in wp-admin.
557	return;
558	}
559
560	self::register_blocks_assets_base_url();
561
562	// Enqueue script.
563	$script_relative_path = self::get_blocks_directory() . $type . '/view.js';
564	$script_deps_path = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $type . '/view.asset.php';
565	$script_dependencies[] = 'jetpack-blocks-assets-base-url';
566	if ( file_exists( $script_deps_path ) ) {
567	$asset_manifest = include $script_deps_path;
568	$script_dependencies = array_unique( array_merge( $script_dependencies, $asset_manifest['dependencies'] ) );
569	}
570
571	if ( ! Blocks::is_amp_request() && self::block_has_asset( $script_relative_path ) ) {
572	$script_version = self::get_asset_version( $script_relative_path );
573	$view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
574	$view_script = add_query_arg( 'minify', 'false', $view_script );
575
576	// Enqueue dependencies.
577	wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
578
579	// If this is a customizer preview, enqueue the dependencies and render the script directly to the preview after autosave.
580	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
581	if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
582	// The Map block is dependent on wp-element, and it doesn't appear to to be possible to load
583	// this dynamically into the customizer iframe currently.
584	if ( 'map' === $type ) {
585	echo '<div>' . esc_html_e( 'No map preview available. Publish and refresh to see this widget.', 'jetpack' ) . '</div>';
586	echo '<script>';
587	echo 'Array.from(document.getElementsByClassName(\'wp-block-jetpack-map\')).forEach(function(element){element.style.display = \'none\';})';
588	echo '</script>';
589	} else {
590	echo '<script id="jetpack-block-' . esc_attr( $type ) . '" src="' . esc_attr( $view_script ) . '&ver=' . esc_attr( $script_version ) . '"></script>';
591	}
592	}
593	}
594	}
595
596	/**
597	* Check if an asset exists for a block.
598	*
599	* @param string $file Path of the file we are looking for.
600	*
601	* @return bool $block_has_asset Does the file exist.
602	*/
603	public static function block_has_asset( $file ) {
604	return file_exists( JETPACK__PLUGIN_DIR . $file );
605	}
606
607	/**
608	* Get the version number to use when loading the file. Allows us to bypass cache when developing.
609	*
610	* @param string $file Path of the file we are looking for.
611	*
612	* @return string $script_version Version number.
613	*/
614	public static function get_asset_version( $file ) {
615	return Jetpack::is_development_version() && self::block_has_asset( $file )
616	? filemtime( JETPACK__PLUGIN_DIR . $file )
617	: JETPACK__VERSION;
618	}
619
620	/**
621	* Load Gutenberg editor assets
622	*
623	* @since 6.7.0
624	*
625	* @return void
626	*/
627	public static function enqueue_block_editor_assets() {
628	if ( ! self::should_load() ) {
629	return;
630	}
631
632	/**
633	* This can be called multiple times per page load in the admin, during the `enqueue_block_assets` action.
634	* These assets are necessary for the admin for editing but are not necessary for each pattern preview.
635	* Therefore we dequeue them, so they don't load for each pattern preview iframe.
636	*/
637	if ( ! wp_should_load_block_editor_scripts_and_styles() ) {
638	wp_dequeue_script( 'jp-tracks' );
639	wp_dequeue_script( 'jetpack-blocks-editor' );
640
641	return;
642	}
643
644	$status = new Status();
645
646	// Required for Analytics. See _inc/lib/admin-pages/class.jetpack-admin-page.php.
647	if ( ! $status->is_offline_mode() && Jetpack::is_connection_ready() ) {
648	wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
649	}
650
651	$blocks_dir = self::get_blocks_directory();
652	$blocks_variation = self::blocks_variation();
653
654	if ( 'production' !== $blocks_variation ) {
655	$blocks_env = '-' . esc_attr( $blocks_variation );
656	} else {
657	$blocks_env = '';
658	}
659
660	self::register_blocks_assets_base_url();
661
662	Assets::register_script(
663	'jetpack-blocks-editor',
664	"{$blocks_dir}editor{$blocks_env}.js",
665	JETPACK__PLUGIN_FILE,
666	array(
667	'textdomain' => 'jetpack',
668	'dependencies' => array( 'jetpack-blocks-assets-base-url' ),
669	)
670	);
671
672	// Hack around #20357 (specifically, that the editor bundle depends on
673	// wp-edit-post but wp-edit-post's styles break the Widget Editor and
674	// Site Editor) until a real fix gets unblocked.
675	// @todo Remove this once #20357 is properly fixed.
676	$wp_styles_fix = wp_styles()->query( 'jetpack-blocks-editor', 'registered' );
677	if ( empty( $wp_styles_fix ) ) {
678	wp_die( 'Your installation of Jetpack is incomplete. Please run "jetpack build plugins/jetpack" in your dev env.' );
679	}
680	wp_styles()->query( 'jetpack-blocks-editor', 'registered' )->deps = array();
681
682	Assets::enqueue_script( 'jetpack-blocks-editor' );
683
684	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
685	$user = wp_get_current_user();
686	$user_data = array(
687	'email' => $user->user_email,
688	'userid' => $user->ID,
689	'username' => $user->user_login,
690	);
691	$blog_id = get_current_blog_id();
692	$is_current_user_connected = true;
693	} else {
694	$user_data = Jetpack_Tracks_Client::get_connected_user_tracks_identity();
695	$blog_id = Jetpack_Options::get_option( 'id', 0 );
696	$is_current_user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected();
697	}
698
699	if ( $blocks_variation === 'beta' && $is_current_user_connected ) {
700	wp_enqueue_style( 'recoleta-font', '//s1.wp.com/i/fonts/recoleta/css/400.min.css', array(), Constants::get_constant( 'JETPACK__VERSION' ) );
701	}
702	// AI Assistant
703	$ai_assistant_state = array(
704	'is-enabled' => apply_filters( 'jetpack_ai_enabled', true ),
705	);
706
707	$screen_base = null;
708	if ( function_exists( 'get_current_screen' ) ) {
709	$screen_base = get_current_screen()->base;
710	}
711
712	$modules = array();
713	if ( class_exists( 'Jetpack_Core_API_Module_List_Endpoint' ) ) {
714	$module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
715	$modules = $module_list_endpoint->get_modules();
716	}
717
718	$initial_state = array(
719	'available_blocks' => self::get_availability(),
720	'blocks_variation' => $blocks_variation,
721	'modules' => $modules,
722	'jetpack' => array(
723	'is_active' => Jetpack::is_connection_ready(),
724	'is_current_user_connected' => $is_current_user_connected,
725	/** This filter is documented in class.jetpack-gutenberg.php */
726	'enable_upgrade_nudge' => apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ),
727	'is_private_site' => $status->is_private_site(),
728	'is_coming_soon' => $status->is_coming_soon(),
729	'is_offline_mode' => $status->is_offline_mode(),
730	'is_newsletter_feature_enabled' => class_exists( '\Jetpack_Memberships' ),
731	// this is the equivalent of JP initial state siteData.showMyJetpack (class-jetpack-redux-state-helper)
732	// used to determine if we can link to My Jetpack from the block editor
733	'is_my_jetpack_available' => My_Jetpack_Initializer::should_initialize(),
734	/**
735	* Enable the RePublicize UI in the block editor context.
736	*
737	* @module publicize
738	*
739	* @since 10.3.0
740	* @deprecated 11.5 This is a feature flag that is no longer used.
741	*
742	* @param bool true Enable the RePublicize UI in the block editor context. Defaults to true.
743	*/
744	'republicize_enabled' => apply_filters( 'jetpack_block_editor_republicize_feature', true ),
745	),
746	'siteFragment' => $status->get_site_suffix(),
747	'adminUrl' => esc_url( admin_url() ),
748	'tracksUserData' => $user_data,
749	'wpcomBlogId' => $blog_id,
750	'allowedMimeTypes' => wp_get_mime_types(),
751	'siteLocale' => str_replace( '_', '-', get_locale() ),
752	'ai-assistant' => $ai_assistant_state,
753	'screenBase' => $screen_base,
754	'pluginBasePath' => plugins_url( '', Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ),
755	'next40pxDefaultSize' => self::site_supports_next_default_size(),
756	);
757
758	if ( Jetpack::is_module_active( 'publicize' ) && function_exists( 'publicize_init' ) ) {
759	$publicize = publicize_init();
760	$jetpack_social_settings = new Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Settings();
761	$social_initial_state = $jetpack_social_settings->get_initial_state();
762
763	$initial_state['social'] = array(
764	'sharesData' => $publicize->get_publicize_shares_info( $blog_id ),
765	'hasPaidPlan' => $publicize->has_paid_plan(),
766	'hasPaidFeatures' => $publicize->has_paid_features(),
767	'isEnhancedPublishingEnabled' => $publicize->has_enhanced_publishing_feature(),
768	'isSocialImageGeneratorAvailable' => $social_initial_state['socialImageGeneratorSettings']['available'],
769	'isSocialImageGeneratorEnabled' => $social_initial_state['socialImageGeneratorSettings']['enabled'],
770	'dismissedNotices' => Dismissed_Notices::get_dismissed_notices(),
771	'supportedAdditionalConnections' => $publicize->get_supported_additional_connections(),
772	'jetpackSharingSettingsUrl' => esc_url_raw( admin_url( 'admin.php?page=jetpack#/sharing' ) ),
773	'userConnectionUrl' => esc_url_raw( admin_url( 'admin.php?page=my-jetpack#/connection' ) ),
774	'useAdminUiV1' => $social_initial_state['useAdminUiV1'],
775	);
776
777	// Add connectionData if we are using the new Connection UI.
778	if ( $social_initial_state['useAdminUiV1'] ) {
779	$initial_state['social']['connectionData'] = $social_initial_state['connectionData'];
780
781	$initial_state['social']['connectionRefreshPath'] = $social_initial_state['connectionRefreshPath'];
782	}
783
784	$initial_state['social']['featureFlags'] = $social_initial_state['featureFlags'];
785	}
786
787	wp_localize_script(
788	'jetpack-blocks-editor',
789	'Jetpack_Editor_Initial_State',
790	$initial_state
791	);
792
793	// Adds Connection package initial state.
794	Connection_Initial_State::render_script( 'jetpack-blocks-editor' );
795	}
796
797	/**
798	* Some blocks do not depend on a specific module,
799	* and can consequently be loaded outside of the usual modules.
800	* We will look for such modules in the extensions/ directory.
801	*
802	* @since 7.1.0
803	* @see wp_common_block_scripts_and_styles()
804	*/
805	public static function load_independent_blocks() {
806	if ( self::should_load() ) {
807	/**
808	* Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
809	* If available, load them.
810	*/
811	$directories = array( 'blocks', 'plugins', 'extended-blocks', 'shared', 'store' );
812
813	foreach ( static::get_extensions() as $extension ) {
814	foreach ( $directories as $dirname ) {
815	$path = JETPACK__PLUGIN_DIR . "extensions/{$dirname}/{$extension}/{$extension}.php";
816
817	if ( file_exists( $path ) ) {
818	include_once $path;
819	continue 2;
820	}
821	}
822	}
823	}
824	}
825
826	/**
827	* Loads PHP components of block editor extensions.
828	*
829	* @since 8.9.0
830	*/
831	public static function load_block_editor_extensions() {
832	if ( self::should_load() ) {
833	// Block editor extensions to load.
834	$extensions_to_load = array(
835	'extended-blocks',
836	'plugins',
837	);
838
839	// Collect the extension paths.
840	foreach ( $extensions_to_load as $extension_to_load ) {
841	$extensions_folder = glob( JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/*' );
842
843	// Require each of the extension files, in case it exists.
844	foreach ( $extensions_folder as $extension_folder ) {
845	$name = basename( $extension_folder );
846	$extension_file_path = JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/' . $name . '/' . $name . '.php';
847
848	if ( file_exists( $extension_file_path ) ) {
849	include_once $extension_file_path;
850	}
851	}
852	}
853	}
854	}
855
856	/**
857	* Determine whether a site should use the default set of blocks, or a custom set.
858	* Possible variations are currently beta, experimental, and production.
859	*
860	* @since 8.1.0
861	*
862	* @return string $block_varation production\|beta\|experimental
863	*/
864	public static function blocks_variation() {
865	// Default to production blocks.
866	$block_varation = 'production';
867
868	/*
869	* Prefer to use this JETPACK_BLOCKS_VARIATION constant
870	* or the jetpack_blocks_variation filter
871	* to set the block variation in your code.
872	*/
873	$default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
874	if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
875	$block_varation = $default;
876	}
877
878	/**
879	* Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
880	*
881	* @since 6.9.0
882	* @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
883	*
884	* @param boolean
885	*/
886	$is_beta = apply_filters_deprecated(
887	'jetpack_load_beta_blocks',
888	array( false ),
889	'jetpack-11.8.0',
890	'jetpack_blocks_variation'
891	);
892
893	/*
894	* Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
895	* or the deprecated jetpack_load_beta_blocks filter.
896	* This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
897	*/
898	if (
899	empty( $default )
900	&& (
901	$is_beta
902	\|\| Constants::is_true( 'JETPACK_BETA_BLOCKS' )
903	)
904	) {
905	$block_varation = 'beta';
906	}
907
908	/**
909	* Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
910	*
911	* @since 6.9.0
912	* @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
913	*
914	* @param boolean
915	*/
916	$is_experimental = apply_filters_deprecated(
917	'jetpack_load_experimental_blocks',
918	array( false ),
919	'jetpack-11.8.0',
920	'jetpack_blocks_variation'
921	);
922
923	/*
924	* Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
925	* or the deprecated jetpack_load_experimental_blocks filter.
926	* This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
927	*/
928	if (
929	empty( $default )
930	&& (
931	$is_experimental
932	\|\| Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
933	)
934	) {
935	$block_varation = 'experimental';
936	}
937
938	/**
939	* Allow customizing the variation of blocks in use on a site.
940	* Overwrites any previously set values, whether by constant or filter.
941	*
942	* @since 8.1.0
943	*
944	* @param string $block_variation Can be beta, experimental, and production. Defaults to production.
945	*/
946	return apply_filters( 'jetpack_blocks_variation', $block_varation );
947	}
948
949	/**
950	* Get a list of extensions available for the variation you chose.
951	*
952	* @since 8.1.0
953	*
954	* @param object $preset_extensions_manifest List of extensions available in Jetpack.
955	* @param string $blocks_variation Subset of blocks. production\|beta\|experimental.
956	*
957	* @return array $preset_extensions Array of extensions for that variation
958	*/
959	public static function get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation ) {
960	$preset_extensions = isset( $preset_extensions_manifest->{ $blocks_variation } )
961	? (array) $preset_extensions_manifest->{ $blocks_variation }
962	: array();
963
964	/*
965	* Experimental and Beta blocks need the production blocks as well.
966	*/
967	if (
968	'experimental' === $blocks_variation
969	\|\| 'beta' === $blocks_variation
970	) {
971	$production_extensions = isset( $preset_extensions_manifest->production )
972	? (array) $preset_extensions_manifest->production
973	: array();
974
975	$preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
976	}
977
978	/*
979	* Beta blocks need the experimental blocks as well.
980	*
981	* If you've chosen to see Beta blocks,
982	* we want to make all blocks available to you:
983	* - Production
984	* - Experimental
985	* - Beta
986	*/
987	if ( 'beta' === $blocks_variation ) {
988	$production_extensions = isset( $preset_extensions_manifest->experimental )
989	? (array) $preset_extensions_manifest->experimental
990	: array();
991
992	$preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
993	}
994
995	return $preset_extensions;
996	}
997
998	/**
999	* Validate a URL used in a SSR block.
1000	*
1001	* @since 8.3.0
1002	*
1003	* @param string $url URL saved as an attribute in block.
1004	* @param array $allowed Array of allowed hosts for that block, or regexes to check against.
1005	* @param bool $is_regex Array of regexes matching the URL that could be used in block.
1006	*
1007	* @return bool\|string
1008	*/
1009	public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
1010	if (
1011	empty( $url )
1012	\|\| ! is_array( $allowed )
1013	\|\| empty( $allowed )
1014	) {
1015	return false;
1016	}
1017
1018	$url_components = wp_parse_url( $url );
1019
1020	// Bail early if we cannot find a host.
1021	if ( empty( $url_components['host'] ) ) {
1022	return false;
1023	}
1024
1025	// Normalize URL.
1026	$url = sprintf(
1027	'%s://%s%s%s',
1028	isset( $url_components['scheme'] ) ? $url_components['scheme'] : 'https',
1029	$url_components['host'],
1030	isset( $url_components['path'] ) ? $url_components['path'] : '/',
1031	isset( $url_components['query'] ) ? '?' . $url_components['query'] : ''
1032	);
1033
1034	if ( ! empty( $url_components['fragment'] ) ) {
1035	$url = $url . '#' . rawurlencode( $url_components['fragment'] );
1036	}
1037
1038	/*
1039	* If we're using an allowed list of hosts,
1040	* check if the URL belongs to one of the domains allowed for that block.
1041	*/
1042	if (
1043	false === $is_regex
1044	&& in_array( $url_components['host'], $allowed, true )
1045	) {
1046	return $url;
1047	}
1048
1049	/*
1050	* If we are using an array of regexes to check against,
1051	* loop through that.
1052	*/
1053	if ( true === $is_regex ) {
1054	foreach ( $allowed as $regex ) {
1055	if ( 1 === preg_match( $regex, $url ) ) {
1056	return $url;
1057	}
1058	}
1059	}
1060
1061	return false;
1062	}
1063
1064	/**
1065	* Determines whether a preview of the block with an upgrade nudge should
1066	* be displayed for admins on the site frontend.
1067	*
1068	* @since 8.4.0
1069	*
1070	* @param array $availability_for_block The availability for the block.
1071	*
1072	* @return bool
1073	*/
1074	public static function should_show_frontend_preview( $availability_for_block ) {
1075	return (
1076	isset( $availability_for_block['details']['required_plan'] )
1077	&& current_user_can( 'manage_options' )
1078	&& ! is_feed()
1079	);
1080	}
1081
1082	/**
1083	* Output an UpgradeNudge Component on the frontend of a site.
1084	*
1085	* @since 8.4.0
1086	*
1087	* @param string $plan The plan that users need to purchase to make the block work.
1088	*
1089	* @return string
1090	*/
1091	public static function upgrade_nudge( $plan ) {
1092	require_once JETPACK__PLUGIN_DIR . '_inc/lib/components.php';
1093	return Jetpack_Components::render_upgrade_nudge(
1094	array(
1095	'plan' => $plan,
1096	)
1097	);
1098	}
1099
1100	/**
1101	* Output a notice within a block.
1102	*
1103	* @since 8.6.0
1104	*
1105	* @param string $message Notice we want to output.
1106	* @param string $status Status of the notice. Can be one of success, info, warning, error. info by default.
1107	* @param string $classes List of CSS classes.
1108	*
1109	* @return string
1110	*/
1111	public static function notice( $message, $status = 'info', $classes = '' ) {
1112	if (
1113	empty( $message )
1114	\|\| ! in_array( $status, array( 'success', 'info', 'warning', 'error' ), true )
1115	) {
1116	return '';
1117	}
1118
1119	$color = '';
1120	switch ( $status ) {
1121	case 'success':
1122	$color = '#00a32a';
1123	break;
1124	case 'warning':
1125	$color = '#dba617';
1126	break;
1127	case 'error':
1128	$color = '#d63638';
1129	break;
1130	case 'info':
1131	default:
1132	$color = '#72aee6';
1133	break;
1134	}
1135
1136	return sprintf(
1137	'<div class="jetpack-block__notice %1$s %3$s" style="border-left:5px solid %4$s;padding:1em;background-color:#f8f9f9;">%2$s</div>',
1138	esc_attr( $status ),
1139	wp_kses(
1140	$message,
1141	array(
1142	'br' => array(),
1143	'p' => array(),
1144	'a' => array(
1145	'href' => array(),
1146	'target' => array(),
1147	'rel' => array(),
1148	),
1149	)
1150	),
1151	esc_attr( $classes ),
1152	sanitize_hex_color( $color )
1153	);
1154	}
1155
1156	/**
1157	* Retrieve site-specific features for Simple sites.
1158	*
1159	* We're caching the data for the lifetime of the request, because it can be slow to calculate,
1160	* and it can be called multiple times per single request.
1161	*
1162	* We intentionally don't use object caching or any other type of persistent caching,
1163	* in order to avoid complex cache invalidation on subscription addition or removal.
1164	*
1165	* @since 10.7
1166	*
1167	* @return array
1168	*/
1169	private static function get_site_specific_features() {
1170	$current_blog_id = get_current_blog_id();
1171
1172	if ( isset( self::$site_specific_features[ $current_blog_id ] ) ) {
1173	return self::$site_specific_features[ $current_blog_id ];
1174	}
1175
1176	if ( ! class_exists( 'Store_Product_List' ) ) {
1177	require WP_CONTENT_DIR . '/admin-plugins/wpcom-billing/store-product-list.php';
1178	}
1179
1180	$site_specific_features = Store_Product_List::get_site_specific_features_data( $current_blog_id );
1181	self::$site_specific_features[ $current_blog_id ] = $site_specific_features;
1182
1183	return $site_specific_features;
1184	}
1185
1186	/**
1187	* Set the availability of the block as the editor
1188	* is loaded.
1189	*
1190	* @param string $slug Slug of the block.
1191	*/
1192	public static function set_availability_for_plan( $slug ) {
1193	$slug = self::remove_extension_prefix( $slug );
1194
1195	if ( Jetpack_Plan::supports( $slug ) ) {
1196	self::set_extension_available( $slug );
1197	return;
1198	}
1199
1200	// Check what's the minimum plan where the feature is available.
1201	$plan = '';
1202	$features_data = array();
1203	$is_simple_site = defined( 'IS_WPCOM' ) && IS_WPCOM;
1204	$is_atomic_site = ( new Host() )->is_woa_site();
1205
1206	if ( $is_simple_site \|\| $is_atomic_site ) {
1207	// Simple sites.
1208	if ( $is_simple_site ) {
1209	$features_data = self::get_site_specific_features();
1210	} else {
1211	// Atomic sites.
1212	$option = get_option( 'jetpack_active_plan' );
1213	if ( isset( $option['features'] ) ) {
1214	$features_data = $option['features'];
1215	}
1216	}
1217
1218	if ( ! empty( $features_data['available'][ $slug ] ) ) {
1219	$plan = $features_data['available'][ $slug ][0];
1220	}
1221	} else {
1222	// Jetpack sites.
1223	$plan = Jetpack_Plan::get_minimum_plan_for_feature( $slug );
1224	}
1225
1226	self::set_extension_unavailable(
1227	$slug,
1228	'missing_plan',
1229	array(
1230	'required_feature' => $slug,
1231	'required_plan' => $plan,
1232	)
1233	);
1234	}
1235
1236	/**
1237	* Wraps the suplied render_callback in a function to check
1238	* the availability of the block before rendering it.
1239	*
1240	* @param string $slug The block slug, used to check for availability.
1241	* @param callable $render_callback The render_callback that will be called if the block is available.
1242	*/
1243	public static function get_render_callback_with_availability_check( $slug, $render_callback ) {
1244	return function ( $prepared_attributes, $block_content, $block ) use ( $render_callback, $slug ) {
1245	$availability = self::get_cached_availability();
1246	$bare_slug = self::remove_extension_prefix( $slug );
1247	if ( isset( $availability[ $bare_slug ] ) && $availability[ $bare_slug ]['available'] ) {
1248	return call_user_func( $render_callback, $prepared_attributes, $block_content );
1249	}
1250
1251	// A preview of the block is rendered for admins on the frontend with an upgrade nudge.
1252	if ( isset( $availability[ $bare_slug ] ) ) {
1253	if ( self::should_show_frontend_preview( $availability[ $bare_slug ] ) ) {
1254	$block_preview = call_user_func( $render_callback, $prepared_attributes, $block_content );
1255
1256	// If the upgrade nudge isn't already being displayed by a parent block, display the nudge.
1257	if ( isset( $block->attributes['shouldDisplayFrontendBanner'] ) && $block->attributes['shouldDisplayFrontendBanner'] ) {
1258	$upgrade_nudge = self::upgrade_nudge( $availability[ $bare_slug ]['details']['required_plan'] );
1259	return $upgrade_nudge . $block_preview;
1260	}
1261
1262	return $block_preview;
1263	}
1264	}
1265
1266	return null;
1267	};
1268	}
1269
1270	/**
1271	* Display a message to site editors and roles above when a block is no longer supported.
1272	* This is only displayed on the frontend.
1273	*
1274	* @since 12.3
1275	*
1276	* @param string $block_content The block content.
1277	* @param array $block The full block, including name and attributes.
1278	*
1279	* @return string
1280	*/
1281	public static function display_deprecated_block_message( $block_content, $block ) {
1282	if ( in_array( $block['blockName'], self::$deprecated_blocks, true ) ) {
1283	if ( current_user_can( 'edit_posts' ) ) {
1284	$block_content = self::notice(
1285	__( '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' ),
1286	'warning',
1287	'jetpack-block-deprecated'
1288	);
1289	} else {
1290	$block_content = '';
1291	}
1292	}
1293
1294	return $block_content;
1295	}
1296
1297	/**
1298	* Check whether the environment supports the newer default size of elements, gradually introduced starting with WP 6.4.
1299	*
1300	* @since 14.0
1301	*
1302	* @see https://make.wordpress.org/core/2023/10/16/editor-components-updates-in-wordpress-6-4/#improving-size-consistency-for-ui-components
1303	*
1304	* @to-do: Deprecate this method and the logic around it when Jetpack requires WordPress 6.7.
1305	*
1306	* @return bool
1307	*/
1308	public static function site_supports_next_default_size() {
1309	/*
1310	* If running a local dev build of gutenberg,
1311	* let's assume it supports the newest changes included in Gutenberg.
1312	*/
1313	if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
1314	return true;
1315	}
1316
1317	// Let's now check if the Gutenberg plugin is installed on the site.
1318	if (
1319	defined( 'GUTENBERG_VERSION' )
1320	&& version_compare( GUTENBERG_VERSION, '19.4', '>=' )
1321	) {
1322	return true;
1323	}
1324
1325	// Finally, let's check for the WordPress version.
1326	global $wp_version;
1327	if ( version_compare( $wp_version, '6.7', '>=' ) ) {
1328	return true;
1329	}
1330
1331	// Final fallback.
1332	return false;
1333	}
1334	}
1335
1336	if ( ( new Host() )->is_woa_site() ) {
1337	/**
1338	* Enable upgrade nudge for Atomic sites.
1339	* This feature is false as default,
1340	* so let's enable it through this filter.
1341	*
1342	* More doc: https://github.com/Automattic/jetpack/blob/trunk/projects/plugins/jetpack/extensions/README.md#upgrades-for-blocks
1343	*/
1344	add_filter( 'jetpack_block_editor_enable_upgrade_nudge', '__return_true' );
1345	}
1346