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

jetpack / class.jetpack-gutenberg.php

jetpack Last commit date

class.jetpack-gutenberg.php

1304 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[] = 'wp-polyfill';
566	$script_dependencies[] = 'jetpack-blocks-assets-base-url';
567	if ( file_exists( $script_deps_path ) ) {
568	$asset_manifest = include $script_deps_path;
569	$script_dependencies = array_unique( array_merge( $script_dependencies, $asset_manifest['dependencies'] ) );
570	}
571
572	if ( ! Blocks::is_amp_request() && self::block_has_asset( $script_relative_path ) ) {
573	$script_version = self::get_asset_version( $script_relative_path );
574	$view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
575	$view_script = add_query_arg( 'minify', 'false', $view_script );
576
577	// Enqueue dependencies.
578	wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
579
580	// If this is a customizer preview, enqueue the dependencies and render the script directly to the preview after autosave.
581	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
582	if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
583	// The Map block is dependent on wp-element, and it doesn't appear to to be possible to load
584	// this dynamically into the customizer iframe currently.
585	if ( 'map' === $type ) {
586	echo '<div>' . esc_html_e( 'No map preview available. Publish and refresh to see this widget.', 'jetpack' ) . '</div>';
587	echo '<script>';
588	echo 'Array.from(document.getElementsByClassName(\'wp-block-jetpack-map\')).forEach(function(element){element.style.display = \'none\';})';
589	echo '</script>';
590	} else {
591	echo '<script id="jetpack-block-' . esc_attr( $type ) . '" src="' . esc_attr( $view_script ) . '&ver=' . esc_attr( $script_version ) . '"></script>';
592	}
593	}
594	}
595	}
596
597	/**
598	* Check if an asset exists for a block.
599	*
600	* @param string $file Path of the file we are looking for.
601	*
602	* @return bool $block_has_asset Does the file exist.
603	*/
604	public static function block_has_asset( $file ) {
605	return file_exists( JETPACK__PLUGIN_DIR . $file );
606	}
607
608	/**
609	* Get the version number to use when loading the file. Allows us to bypass cache when developing.
610	*
611	* @param string $file Path of the file we are looking for.
612	*
613	* @return string $script_version Version number.
614	*/
615	public static function get_asset_version( $file ) {
616	return Jetpack::is_development_version() && self::block_has_asset( $file )
617	? filemtime( JETPACK__PLUGIN_DIR . $file )
618	: JETPACK__VERSION;
619	}
620
621	/**
622	* Load Gutenberg editor assets
623	*
624	* @since 6.7.0
625	*
626	* @return void
627	*/
628	public static function enqueue_block_editor_assets() {
629	if ( ! self::should_load() ) {
630	return;
631	}
632
633	/**
634	* This can be called multiple times per page load in the admin, during the `enqueue_block_assets` action.
635	* These assets are necessary for the admin for editing but are not necessary for each pattern preview.
636	* Therefore we dequeue them, so they don't load for each pattern preview iframe.
637	*/
638	if ( ! wp_should_load_block_editor_scripts_and_styles() ) {
639	wp_dequeue_script( 'jp-tracks' );
640	wp_dequeue_script( 'jetpack-blocks-editor' );
641
642	return;
643	}
644
645	$status = new Status();
646
647	// Required for Analytics. See _inc/lib/admin-pages/class.jetpack-admin-page.php.
648	if ( ! $status->is_offline_mode() && Jetpack::is_connection_ready() ) {
649	wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
650	}
651
652	$blocks_dir = self::get_blocks_directory();
653	$blocks_variation = self::blocks_variation();
654
655	if ( 'production' !== $blocks_variation ) {
656	$blocks_env = '-' . esc_attr( $blocks_variation );
657	} else {
658	$blocks_env = '';
659	}
660
661	self::register_blocks_assets_base_url();
662
663	Assets::register_script(
664	'jetpack-blocks-editor',
665	"{$blocks_dir}editor{$blocks_env}.js",
666	JETPACK__PLUGIN_FILE,
667	array(
668	'textdomain' => 'jetpack',
669	'dependencies' => array( 'jetpack-blocks-assets-base-url' ),
670	)
671	);
672
673	// Hack around #20357 (specifically, that the editor bundle depends on
674	// wp-edit-post but wp-edit-post's styles break the Widget Editor and
675	// Site Editor) until a real fix gets unblocked.
676	// @todo Remove this once #20357 is properly fixed.
677	wp_styles()->query( 'jetpack-blocks-editor', 'registered' )->deps = array();
678
679	Assets::enqueue_script( 'jetpack-blocks-editor' );
680
681	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
682	$user = wp_get_current_user();
683	$user_data = array(
684	'email' => $user->user_email,
685	'userid' => $user->ID,
686	'username' => $user->user_login,
687	);
688	$blog_id = get_current_blog_id();
689	$is_current_user_connected = true;
690	} else {
691	$user_data = Jetpack_Tracks_Client::get_connected_user_tracks_identity();
692	$blog_id = Jetpack_Options::get_option( 'id', 0 );
693	$is_current_user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected();
694	}
695
696	if ( $blocks_variation === 'beta' && $is_current_user_connected ) {
697	wp_enqueue_style( 'recoleta-font', '//s1.wp.com/i/fonts/recoleta/css/400.min.css', array(), Constants::get_constant( 'JETPACK__VERSION' ) );
698	}
699	// AI Assistant
700	$ai_assistant_state = array(
701	'is-enabled' => apply_filters( 'jetpack_ai_enabled', true ),
702	);
703
704	$screen_base = null;
705	if ( function_exists( 'get_current_screen' ) ) {
706	$screen_base = get_current_screen()->base;
707	}
708
709	$modules = array();
710	if ( class_exists( 'Jetpack_Core_API_Module_List_Endpoint' ) ) {
711	$module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
712	$modules = $module_list_endpoint->get_modules();
713	}
714
715	$initial_state = array(
716	'available_blocks' => self::get_availability(),
717	'blocks_variation' => $blocks_variation,
718	'modules' => $modules,
719	'jetpack' => array(
720	'is_active' => Jetpack::is_connection_ready(),
721	'is_current_user_connected' => $is_current_user_connected,
722	/** This filter is documented in class.jetpack-gutenberg.php */
723	'enable_upgrade_nudge' => apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ),
724	'is_private_site' => $status->is_private_site(),
725	'is_coming_soon' => $status->is_coming_soon(),
726	'is_offline_mode' => $status->is_offline_mode(),
727	'is_newsletter_feature_enabled' => class_exists( '\Jetpack_Memberships' ),
728	// this is the equivalent of JP initial state siteData.showMyJetpack (class-jetpack-redux-state-helper)
729	// used to determine if we can link to My Jetpack from the block editor
730	'is_my_jetpack_available' => My_Jetpack_Initializer::should_initialize(),
731	/**
732	* Enable the RePublicize UI in the block editor context.
733	*
734	* @module publicize
735	*
736	* @since 10.3.0
737	* @deprecated 11.5 This is a feature flag that is no longer used.
738	*
739	* @param bool true Enable the RePublicize UI in the block editor context. Defaults to true.
740	*/
741	'republicize_enabled' => apply_filters( 'jetpack_block_editor_republicize_feature', true ),
742	),
743	'siteFragment' => $status->get_site_suffix(),
744	'adminUrl' => esc_url( admin_url() ),
745	'tracksUserData' => $user_data,
746	'wpcomBlogId' => $blog_id,
747	'allowedMimeTypes' => wp_get_mime_types(),
748	'siteLocale' => str_replace( '_', '-', get_locale() ),
749	'ai-assistant' => $ai_assistant_state,
750	'screenBase' => $screen_base,
751	'pluginBasePath' => plugins_url( '', Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ),
752	);
753
754	if ( Jetpack::is_module_active( 'publicize' ) && function_exists( 'publicize_init' ) ) {
755	$publicize = publicize_init();
756	$jetpack_social_settings = new Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Settings();
757	$social_initial_state = $jetpack_social_settings->get_initial_state();
758
759	$initial_state['social'] = array(
760	'sharesData' => $publicize->get_publicize_shares_info( $blog_id ),
761	'hasPaidPlan' => $publicize->has_paid_plan(),
762	'hasPaidFeatures' => $publicize->has_paid_features(),
763	'isEnhancedPublishingEnabled' => $publicize->has_enhanced_publishing_feature(),
764	'isSocialImageGeneratorAvailable' => $social_initial_state['socialImageGeneratorSettings']['available'],
765	'isSocialImageGeneratorEnabled' => $social_initial_state['socialImageGeneratorSettings']['enabled'],
766	'dismissedNotices' => Dismissed_Notices::get_dismissed_notices(),
767	'supportedAdditionalConnections' => $publicize->get_supported_additional_connections(),
768	'jetpackSharingSettingsUrl' => esc_url_raw( admin_url( 'admin.php?page=jetpack#/sharing' ) ),
769	'userConnectionUrl' => esc_url_raw( admin_url( 'admin.php?page=my-jetpack#/connection' ) ),
770	'useAdminUiV1' => $social_initial_state['useAdminUiV1'],
771	);
772
773	// Add connectionData if we are using the new Connection UI.
774	if ( $social_initial_state['useAdminUiV1'] ) {
775	$initial_state['social']['connectionData'] = $social_initial_state['connectionData'];
776
777	$initial_state['social']['connectionRefreshPath'] = $social_initial_state['connectionRefreshPath'];
778	}
779
780	$initial_state['social']['featureFlags'] = $social_initial_state['featureFlags'];
781	}
782
783	wp_localize_script(
784	'jetpack-blocks-editor',
785	'Jetpack_Editor_Initial_State',
786	$initial_state
787	);
788
789	// Adds Connection package initial state.
790	Connection_Initial_State::render_script( 'jetpack-blocks-editor' );
791	}
792
793	/**
794	* Some blocks do not depend on a specific module,
795	* and can consequently be loaded outside of the usual modules.
796	* We will look for such modules in the extensions/ directory.
797	*
798	* @since 7.1.0
799	* @see wp_common_block_scripts_and_styles()
800	*/
801	public static function load_independent_blocks() {
802	if ( self::should_load() ) {
803	/**
804	* Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
805	* If available, load them.
806	*/
807	$directories = array( 'blocks', 'plugins', 'extended-blocks', 'shared', 'store' );
808
809	foreach ( static::get_extensions() as $extension ) {
810	foreach ( $directories as $dirname ) {
811	$path = JETPACK__PLUGIN_DIR . "extensions/{$dirname}/{$extension}/{$extension}.php";
812
813	if ( file_exists( $path ) ) {
814	include_once $path;
815	continue 2;
816	}
817	}
818	}
819	}
820	}
821
822	/**
823	* Loads PHP components of block editor extensions.
824	*
825	* @since 8.9.0
826	*/
827	public static function load_block_editor_extensions() {
828	if ( self::should_load() ) {
829	// Block editor extensions to load.
830	$extensions_to_load = array(
831	'extended-blocks',
832	'plugins',
833	);
834
835	// Collect the extension paths.
836	foreach ( $extensions_to_load as $extension_to_load ) {
837	$extensions_folder = glob( JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/*' );
838
839	// Require each of the extension files, in case it exists.
840	foreach ( $extensions_folder as $extension_folder ) {
841	$name = basename( $extension_folder );
842	$extension_file_path = JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/' . $name . '/' . $name . '.php';
843
844	if ( file_exists( $extension_file_path ) ) {
845	include_once $extension_file_path;
846	}
847	}
848	}
849	}
850	}
851
852	/**
853	* Determine whether a site should use the default set of blocks, or a custom set.
854	* Possible variations are currently beta, experimental, and production.
855	*
856	* @since 8.1.0
857	*
858	* @return string $block_varation production\|beta\|experimental
859	*/
860	public static function blocks_variation() {
861	// Default to production blocks.
862	$block_varation = 'production';
863
864	/*
865	* Prefer to use this JETPACK_BLOCKS_VARIATION constant
866	* or the jetpack_blocks_variation filter
867	* to set the block variation in your code.
868	*/
869	$default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
870	if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
871	$block_varation = $default;
872	}
873
874	/**
875	* Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
876	*
877	* @since 6.9.0
878	* @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
879	*
880	* @param boolean
881	*/
882	$is_beta = apply_filters_deprecated(
883	'jetpack_load_beta_blocks',
884	array( false ),
885	'jetpack-11.8.0',
886	'jetpack_blocks_variation'
887	);
888
889	/*
890	* Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
891	* or the deprecated jetpack_load_beta_blocks filter.
892	* This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
893	*/
894	if (
895	empty( $default )
896	&& (
897	$is_beta
898	\|\| Constants::is_true( 'JETPACK_BETA_BLOCKS' )
899	)
900	) {
901	$block_varation = 'beta';
902	}
903
904	/**
905	* Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
906	*
907	* @since 6.9.0
908	* @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
909	*
910	* @param boolean
911	*/
912	$is_experimental = apply_filters_deprecated(
913	'jetpack_load_experimental_blocks',
914	array( false ),
915	'jetpack-11.8.0',
916	'jetpack_blocks_variation'
917	);
918
919	/*
920	* Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
921	* or the deprecated jetpack_load_experimental_blocks filter.
922	* This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
923	*/
924	if (
925	empty( $default )
926	&& (
927	$is_experimental
928	\|\| Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
929	)
930	) {
931	$block_varation = 'experimental';
932	}
933
934	/**
935	* Allow customizing the variation of blocks in use on a site.
936	* Overwrites any previously set values, whether by constant or filter.
937	*
938	* @since 8.1.0
939	*
940	* @param string $block_variation Can be beta, experimental, and production. Defaults to production.
941	*/
942	return apply_filters( 'jetpack_blocks_variation', $block_varation );
943	}
944
945	/**
946	* Get a list of extensions available for the variation you chose.
947	*
948	* @since 8.1.0
949	*
950	* @param object $preset_extensions_manifest List of extensions available in Jetpack.
951	* @param string $blocks_variation Subset of blocks. production\|beta\|experimental.
952	*
953	* @return array $preset_extensions Array of extensions for that variation
954	*/
955	public static function get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation ) {
956	$preset_extensions = isset( $preset_extensions_manifest->{ $blocks_variation } )
957	? (array) $preset_extensions_manifest->{ $blocks_variation }
958	: array();
959
960	/*
961	* Experimental and Beta blocks need the production blocks as well.
962	*/
963	if (
964	'experimental' === $blocks_variation
965	\|\| 'beta' === $blocks_variation
966	) {
967	$production_extensions = isset( $preset_extensions_manifest->production )
968	? (array) $preset_extensions_manifest->production
969	: array();
970
971	$preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
972	}
973
974	/*
975	* Beta blocks need the experimental blocks as well.
976	*
977	* If you've chosen to see Beta blocks,
978	* we want to make all blocks available to you:
979	* - Production
980	* - Experimental
981	* - Beta
982	*/
983	if ( 'beta' === $blocks_variation ) {
984	$production_extensions = isset( $preset_extensions_manifest->experimental )
985	? (array) $preset_extensions_manifest->experimental
986	: array();
987
988	$preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
989	}
990
991	return $preset_extensions;
992	}
993
994	/**
995	* Validate a URL used in a SSR block.
996	*
997	* @since 8.3.0
998	*
999	* @param string $url URL saved as an attribute in block.
1000	* @param array $allowed Array of allowed hosts for that block, or regexes to check against.
1001	* @param bool $is_regex Array of regexes matching the URL that could be used in block.
1002	*
1003	* @return bool\|string
1004	*/
1005	public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
1006	if (
1007	empty( $url )
1008	\|\| ! is_array( $allowed )
1009	\|\| empty( $allowed )
1010	) {
1011	return false;
1012	}
1013
1014	$url_components = wp_parse_url( $url );
1015
1016	// Bail early if we cannot find a host.
1017	if ( empty( $url_components['host'] ) ) {
1018	return false;
1019	}
1020
1021	// Normalize URL.
1022	$url = sprintf(
1023	'%s://%s%s%s',
1024	isset( $url_components['scheme'] ) ? $url_components['scheme'] : 'https',
1025	$url_components['host'],
1026	isset( $url_components['path'] ) ? $url_components['path'] : '/',
1027	isset( $url_components['query'] ) ? '?' . $url_components['query'] : ''
1028	);
1029
1030	if ( ! empty( $url_components['fragment'] ) ) {
1031	$url = $url . '#' . rawurlencode( $url_components['fragment'] );
1032	}
1033
1034	/*
1035	* If we're using an allowed list of hosts,
1036	* check if the URL belongs to one of the domains allowed for that block.
1037	*/
1038	if (
1039	false === $is_regex
1040	&& in_array( $url_components['host'], $allowed, true )
1041	) {
1042	return $url;
1043	}
1044
1045	/*
1046	* If we are using an array of regexes to check against,
1047	* loop through that.
1048	*/
1049	if ( true === $is_regex ) {
1050	foreach ( $allowed as $regex ) {
1051	if ( 1 === preg_match( $regex, $url ) ) {
1052	return $url;
1053	}
1054	}
1055	}
1056
1057	return false;
1058	}
1059
1060	/**
1061	* Determines whether a preview of the block with an upgrade nudge should
1062	* be displayed for admins on the site frontend.
1063	*
1064	* @since 8.4.0
1065	*
1066	* @param array $availability_for_block The availability for the block.
1067	*
1068	* @return bool
1069	*/
1070	public static function should_show_frontend_preview( $availability_for_block ) {
1071	return (
1072	isset( $availability_for_block['details']['required_plan'] )
1073	&& current_user_can( 'manage_options' )
1074	&& ! is_feed()
1075	);
1076	}
1077
1078	/**
1079	* Output an UpgradeNudge Component on the frontend of a site.
1080	*
1081	* @since 8.4.0
1082	*
1083	* @param string $plan The plan that users need to purchase to make the block work.
1084	*
1085	* @return string
1086	*/
1087	public static function upgrade_nudge( $plan ) {
1088	require_once JETPACK__PLUGIN_DIR . '_inc/lib/components.php';
1089	return Jetpack_Components::render_upgrade_nudge(
1090	array(
1091	'plan' => $plan,
1092	)
1093	);
1094	}
1095
1096	/**
1097	* Output a notice within a block.
1098	*
1099	* @since 8.6.0
1100	*
1101	* @param string $message Notice we want to output.
1102	* @param string $status Status of the notice. Can be one of success, info, warning, error. info by default.
1103	* @param string $classes List of CSS classes.
1104	*
1105	* @return string
1106	*/
1107	public static function notice( $message, $status = 'info', $classes = '' ) {
1108	if (
1109	empty( $message )
1110	\|\| ! in_array( $status, array( 'success', 'info', 'warning', 'error' ), true )
1111	) {
1112	return '';
1113	}
1114
1115	$color = '';
1116	switch ( $status ) {
1117	case 'success':
1118	$color = '#00a32a';
1119	break;
1120	case 'warning':
1121	$color = '#dba617';
1122	break;
1123	case 'error':
1124	$color = '#d63638';
1125	break;
1126	case 'info':
1127	default:
1128	$color = '#72aee6';
1129	break;
1130	}
1131
1132	return sprintf(
1133	'<div class="jetpack-block__notice %1$s %3$s" style="border-left:5px solid %4$s;padding:1em;background-color:#f8f9f9;">%2$s</div>',
1134	esc_attr( $status ),
1135	wp_kses(
1136	$message,
1137	array(
1138	'br' => array(),
1139	'p' => array(),
1140	'a' => array(
1141	'href' => array(),
1142	'target' => array(),
1143	'rel' => array(),
1144	),
1145	)
1146	),
1147	esc_attr( $classes ),
1148	sanitize_hex_color( $color )
1149	);
1150	}
1151
1152	/**
1153	* Retrieve site-specific features for Simple sites.
1154	*
1155	* We're caching the data for the lifetime of the request, because it can be slow to calculate,
1156	* and it can be called multiple times per single request.
1157	*
1158	* We intentionally don't use object caching or any other type of persistent caching,
1159	* in order to avoid complex cache invalidation on subscription addition or removal.
1160	*
1161	* @since 10.7
1162	*
1163	* @return array
1164	*/
1165	private static function get_site_specific_features() {
1166	$current_blog_id = get_current_blog_id();
1167
1168	if ( isset( self::$site_specific_features[ $current_blog_id ] ) ) {
1169	return self::$site_specific_features[ $current_blog_id ];
1170	}
1171
1172	if ( ! class_exists( 'Store_Product_List' ) ) {
1173	require WP_CONTENT_DIR . '/admin-plugins/wpcom-billing/store-product-list.php';
1174	}
1175
1176	$site_specific_features = Store_Product_List::get_site_specific_features_data( $current_blog_id );
1177	self::$site_specific_features[ $current_blog_id ] = $site_specific_features;
1178
1179	return $site_specific_features;
1180	}
1181
1182	/**
1183	* Set the availability of the block as the editor
1184	* is loaded.
1185	*
1186	* @param string $slug Slug of the block.
1187	*/
1188	public static function set_availability_for_plan( $slug ) {
1189	$slug = self::remove_extension_prefix( $slug );
1190
1191	if ( Jetpack_Plan::supports( $slug ) ) {
1192	self::set_extension_available( $slug );
1193	return;
1194	}
1195
1196	// Check what's the minimum plan where the feature is available.
1197	$plan = '';
1198	$features_data = array();
1199	$is_simple_site = defined( 'IS_WPCOM' ) && IS_WPCOM;
1200	$is_atomic_site = ( new Host() )->is_woa_site();
1201
1202	if ( $is_simple_site \|\| $is_atomic_site ) {
1203	// Simple sites.
1204	if ( $is_simple_site ) {
1205	$features_data = self::get_site_specific_features();
1206	} else {
1207	// Atomic sites.
1208	$option = get_option( 'jetpack_active_plan' );
1209	if ( isset( $option['features'] ) ) {
1210	$features_data = $option['features'];
1211	}
1212	}
1213
1214	if ( ! empty( $features_data['available'][ $slug ] ) ) {
1215	$plan = $features_data['available'][ $slug ][0];
1216	}
1217	} else {
1218	// Jetpack sites.
1219	$plan = Jetpack_Plan::get_minimum_plan_for_feature( $slug );
1220	}
1221
1222	self::set_extension_unavailable(
1223	$slug,
1224	'missing_plan',
1225	array(
1226	'required_feature' => $slug,
1227	'required_plan' => $plan,
1228	)
1229	);
1230	}
1231
1232	/**
1233	* Wraps the suplied render_callback in a function to check
1234	* the availability of the block before rendering it.
1235	*
1236	* @param string $slug The block slug, used to check for availability.
1237	* @param callable $render_callback The render_callback that will be called if the block is available.
1238	*/
1239	public static function get_render_callback_with_availability_check( $slug, $render_callback ) {
1240	return function ( $prepared_attributes, $block_content, $block ) use ( $render_callback, $slug ) {
1241	$availability = self::get_cached_availability();
1242	$bare_slug = self::remove_extension_prefix( $slug );
1243	if ( isset( $availability[ $bare_slug ] ) && $availability[ $bare_slug ]['available'] ) {
1244	return call_user_func( $render_callback, $prepared_attributes, $block_content );
1245	}
1246
1247	// A preview of the block is rendered for admins on the frontend with an upgrade nudge.
1248	if ( isset( $availability[ $bare_slug ] ) ) {
1249	if ( self::should_show_frontend_preview( $availability[ $bare_slug ] ) ) {
1250	$block_preview = call_user_func( $render_callback, $prepared_attributes, $block_content );
1251
1252	// If the upgrade nudge isn't already being displayed by a parent block, display the nudge.
1253	if ( isset( $block->attributes['shouldDisplayFrontendBanner'] ) && $block->attributes['shouldDisplayFrontendBanner'] ) {
1254	$upgrade_nudge = self::upgrade_nudge( $availability[ $bare_slug ]['details']['required_plan'] );
1255	return $upgrade_nudge . $block_preview;
1256	}
1257
1258	return $block_preview;
1259	}
1260	}
1261
1262	return null;
1263	};
1264	}
1265
1266	/**
1267	* Display a message to site editors and roles above when a block is no longer supported.
1268	* This is only displayed on the frontend.
1269	*
1270	* @since 12.3
1271	*
1272	* @param string $block_content The block content.
1273	* @param array $block The full block, including name and attributes.
1274	*
1275	* @return string
1276	*/
1277	public static function display_deprecated_block_message( $block_content, $block ) {
1278	if ( in_array( $block['blockName'], self::$deprecated_blocks, true ) ) {
1279	if ( current_user_can( 'edit_posts' ) ) {
1280	$block_content = self::notice(
1281	__( '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' ),
1282	'warning',
1283	'jetpack-block-deprecated'
1284	);
1285	} else {
1286	$block_content = '';
1287	}
1288	}
1289
1290	return $block_content;
1291	}
1292	}
1293
1294	if ( ( new Host() )->is_woa_site() ) {
1295	/**
1296	* Enable upgrade nudge for Atomic sites.
1297	* This feature is false as default,
1298	* so let's enable it through this filter.
1299	*
1300	* More doc: https://github.com/Automattic/jetpack/blob/trunk/projects/plugins/jetpack/extensions/README.md#upgrades-for-blocks
1301	*/
1302	add_filter( 'jetpack_block_editor_enable_upgrade_nudge', '__return_true' );
1303	}
1304