jetpack / class.jetpack-gutenberg.php

class.jetpack-gutenberg.php in Jetpack – WP Security, Backup, Speed, & Growth 13.5, at class.jetpack-gutenberg.php

1,291 lines 41.9 KB

Raw Download Zip

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