jetpack / class.jetpack-gutenberg.php

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

663 lines 19.4 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 Jetpack
7	*/
8
9	/**
10	* Wrapper function to safely register a gutenberg block type
11	*
12	* @param string $slug Slug of the block.
13	* @param array $args Arguments that are passed into register_block_type.
14	*
15	* @see register_block_type
16	*
17	* @since 6.7.0
18	*
19	* @return WP_Block_Type\|false The registered block type on success, or false on failure.
20	*/
21	function jetpack_register_block( $slug, $args = array() ) {
22	if ( 0 !== strpos( $slug, 'jetpack/' ) && ! strpos( $slug, '/' ) ) {
23	_doing_it_wrong( 'jetpack_register_block', 'Prefix the block with jetpack/ ', '7.1.0' );
24	$slug = 'jetpack/' . $slug;
25	}
26
27	// Checking whether block is registered to ensure it isn't registered twice.
28	if ( Jetpack_Gutenberg::is_registered( $slug ) ) {
29	return false;
30	}
31
32	return register_block_type( $slug, $args );
33	}
34
35	/**
36	* Helper function to register a Jetpack Gutenberg plugin
37	*
38	* @deprecated 7.1.0 Use Jetpack_Gutenberg::set_extension_available() instead
39	*
40	* @param string $slug Slug of the plugin.
41	*
42	* @since 6.9.0
43	*
44	* @return void
45	*/
46	function jetpack_register_plugin( $slug ) {
47	_deprecated_function( __FUNCTION__, '7.1', 'Jetpack_Gutenberg::set_extension_available' );
48
49	Jetpack_Gutenberg::register_plugin( $slug );
50	}
51
52	/**
53	* Set the reason why an extension (block or plugin) is unavailable
54	*
55	* @deprecated 7.1.0 Use Jetpack_Gutenberg::set_extension_unavailable() instead
56	*
57	* @param string $slug Slug of the block.
58	* @param string $reason A string representation of why the extension is unavailable.
59	*
60	* @since 7.0.0
61	*
62	* @return void
63	*/
64	function jetpack_set_extension_unavailability_reason( $slug, $reason ) {
65	_deprecated_function( __FUNCTION__, '7.1', 'Jetpack_Gutenberg::set_extension_unavailable' );
66
67	Jetpack_Gutenberg::set_extension_unavailability_reason( $slug, $reason );
68	}
69
70	/**
71	* General Gutenberg editor specific functionality
72	*/
73	class Jetpack_Gutenberg {
74
75	/**
76	* Only these extensions can be registered. Used to control availability of beta blocks.
77	*
78	* @var array Extensions whitelist
79	*/
80	private static $extensions = array();
81
82	/**
83	* Keeps track of the reasons why a given extension is unavailable.
84	*
85	* @var array Extensions availability information
86	*/
87	private static $availability = array();
88
89	/**
90	* Prepend the 'jetpack/' prefix to a block name
91	*
92	* @param string $block_name The block name.
93	*
94	* @return string The prefixed block name.
95	*/
96	private static function prepend_block_prefix( $block_name ) {
97	return 'jetpack/' . $block_name;
98	}
99
100	/**
101	* Remove the 'jetpack/' or jetpack-' prefix from an extension name
102	*
103	* @param string $extension_name The extension name.
104	*
105	* @return string The unprefixed extension name.
106	*/
107	private static function remove_extension_prefix( $extension_name ) {
108	if ( wp_startswith( $extension_name, 'jetpack/' ) \|\| wp_startswith( $extension_name, 'jetpack-' ) ) {
109	return substr( $extension_name, strlen( 'jetpack/' ) );
110	}
111	return $extension_name;
112	}
113
114	/**
115	* Whether two arrays share at least one item
116	*
117	* @param array $a An array.
118	* @param array $b Another array.
119	*
120	* @return boolean True if $a and $b share at least one item
121	*/
122	protected static function share_items( $a, $b ) {
123	return count( array_intersect( $a, $b ) ) > 0;
124	}
125
126	/**
127	* Register a block
128	*
129	* @deprecated 7.1.0 Use jetpack_register_block() instead
130	*
131	* @param string $slug Slug of the block.
132	* @param array $args Arguments that are passed into register_block_type().
133	*/
134	public static function register_block( $slug, $args ) {
135	_deprecated_function( __METHOD__, '7.1', 'jetpack_register_block' );
136
137	jetpack_register_block( 'jetpack/' . $slug, $args );
138	}
139
140	/**
141	* Register a plugin
142	*
143	* @deprecated 7.1.0 Use Jetpack_Gutenberg::set_extension_available() instead
144	*
145	* @param string $slug Slug of the plugin.
146	*/
147	public static function register_plugin( $slug ) {
148	_deprecated_function( __METHOD__, '7.1', 'Jetpack_Gutenberg::set_extension_available' );
149
150	self::set_extension_available( $slug );
151	}
152
153	/**
154	* Register a block
155	*
156	* @deprecated 7.0.0 Use jetpack_register_block() instead
157	*
158	* @param string $slug Slug of the block.
159	* @param array $args Arguments that are passed into the register_block_type.
160	* @param array $availability array containing if a block is available and the reason when it is not.
161	*/
162	public static function register( $slug, $args, $availability ) {
163	_deprecated_function( __METHOD__, '7.0', 'jetpack_register_block' );
164
165	if ( isset( $availability['available'] ) && ! $availability['available'] ) {
166	self::set_extension_unavailability_reason( $slug, $availability['unavailable_reason'] );
167	} else {
168	self::register_block( $slug, $args );
169	}
170	}
171
172	/**
173	* Set a (non-block) extension as available
174	*
175	* @param string $slug Slug of the extension.
176	*/
177	public static function set_extension_available( $slug ) {
178	self::$availability[ self::remove_extension_prefix( $slug ) ] = true;
179	}
180
181	/**
182	* Set the reason why an extension (block or plugin) is unavailable
183	*
184	* @param string $slug Slug of the extension.
185	* @param string $reason A string representation of why the extension is unavailable.
186	*/
187	public static function set_extension_unavailable( $slug, $reason ) {
188	self::$availability[ self::remove_extension_prefix( $slug ) ] = $reason;
189	}
190
191	/**
192	* Set the reason why an extension (block or plugin) is unavailable
193	*
194	* @deprecated 7.1.0 Use set_extension_unavailable() instead
195	*
196	* @param string $slug Slug of the extension.
197	* @param string $reason A string representation of why the extension is unavailable.
198	*/
199	public static function set_extension_unavailability_reason( $slug, $reason ) {
200	_deprecated_function( __METHOD__, '7.1', 'Jetpack_Gutenberg::set_extension_unavailable' );
201
202	self::set_extension_unavailable( $slug, $reason );
203	}
204
205	/**
206	* Set up a whitelist of allowed block editor extensions
207	*
208	* @return void
209	*/
210	public static function init() {
211	if ( ! self::should_load() ) {
212	return;
213	}
214
215	/**
216	* Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
217	*
218	* @since 6.9.0
219	*
220	* @param boolean
221	*/
222	if ( apply_filters( 'jetpack_load_beta_blocks', false ) ) {
223	Jetpack_Constants::set_constant( 'JETPACK_BETA_BLOCKS', true );
224	}
225
226	/**
227	* Filter the whitelist of block editor extensions that are available through Jetpack.
228	*
229	* @since 7.0.0
230	*
231	* @param array
232	*/
233	self::$extensions = apply_filters( 'jetpack_set_available_extensions', self::get_jetpack_gutenberg_extensions_whitelist() );
234
235	/**
236	* Filter the whitelist of block editor plugins that are available through Jetpack.
237	*
238	* @deprecated 7.0.0 Use jetpack_set_available_extensions instead
239	*
240	* @since 6.8.0
241	*
242	* @param array
243	*/
244	self::$extensions = apply_filters( 'jetpack_set_available_blocks', self::$extensions );
245
246	/**
247	* Filter the whitelist of block editor plugins that are available through Jetpack.
248	*
249	* @deprecated 7.0.0 Use jetpack_set_available_extensions instead
250	*
251	* @since 6.9.0
252	*
253	* @param array
254	*/
255	self::$extensions = apply_filters( 'jetpack_set_available_plugins', self::$extensions );
256	}
257
258	/**
259	* Resets the class to its original state
260	*
261	* Used in unit tests
262	*
263	* @return void
264	*/
265	public static function reset() {
266	self::$extensions = array();
267	self::$availability = array();
268	}
269
270	/**
271	* Return the Gutenberg extensions (blocks and plugins) directory
272	*
273	* @return string The Gutenberg extensions directory
274	*/
275	public static function get_blocks_directory() {
276	/**
277	* Filter to select Gutenberg blocks directory
278	*
279	* @since 6.9.0
280	*
281	* @param string default: '_inc/blocks/'
282	*/
283	return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
284	}
285
286	/**
287	* Checks for a given .json file in the blocks folder.
288	*
289	* @param string $preset The name of the .json file to look for.
290	*
291	* @return bool True if the file is found.
292	*/
293	public static function preset_exists( $preset ) {
294	return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
295	}
296
297	/**
298	* Decodes JSON loaded from a preset file in the blocks folder
299	*
300	* @param string $preset The name of the .json file to load.
301	*
302	* @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
303	*/
304	public static function get_preset( $preset ) {
305	return json_decode(
306	// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
307	file_get_contents( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' )
308	);
309	}
310
311	/**
312	* Returns a whitelist of Jetpack Gutenberg extensions (blocks and plugins), based on index.json
313	*
314	* @return array A list of blocks: eg [ 'publicize', 'markdown' ]
315	*/
316	public static function get_jetpack_gutenberg_extensions_whitelist() {
317	$preset_extensions_manifest = self::preset_exists( 'index' ) ? self::get_preset( 'index' ) : (object) array();
318
319	$preset_extensions = isset( $preset_extensions_manifest->production ) ? (array) $preset_extensions_manifest->production : array();
320
321	if ( Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ) {
322	$beta_extensions = isset( $preset_extensions_manifest->beta ) ? (array) $preset_extensions_manifest->beta : array();
323	return array_unique( array_merge( $preset_extensions, $beta_extensions ) );
324	}
325
326	return $preset_extensions;
327	}
328
329	/**
330	* Get availability of each block / plugin.
331	*
332	* @return array A list of block and plugins and their availablity status
333	*/
334	public static function get_availability() {
335	/**
336	* Fires before Gutenberg extensions availability is computed.
337	*
338	* In the function call you supply, use `jetpack_register_block()` to set a block as available.
339	* Alternatively, use `Jetpack_Gutenberg::set_extension_available()` (for a non-block plugin), and
340	* `Jetpack_Gutenberg::set_extension_unavailable()` (if the block or plugin should not be registered
341	* but marked as unavailable).
342	*
343	* @since 7.0.0
344	*/
345	do_action( 'jetpack_register_gutenberg_extensions' );
346
347	$available_extensions = array();
348
349	foreach ( self::$extensions as $extension ) {
350	$is_available = self::is_registered( 'jetpack/' . $extension ) \|\|
351	( isset( self::$availability[ $extension ] ) && true === self::$availability[ $extension ] );
352
353	$available_extensions[ $extension ] = array(
354	'available' => $is_available,
355	);
356
357	if ( ! $is_available ) {
358	$reason = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ] : 'missing_module';
359	$available_extensions[ $extension ]['unavailable_reason'] = $reason;
360	}
361	}
362
363	$unwhitelisted_blocks = array();
364	$all_registered_blocks = WP_Block_Type_Registry::get_instance()->get_all_registered();
365	foreach ( $all_registered_blocks as $block_name => $block_type ) {
366	if ( ! wp_startswith( $block_name, 'jetpack/' ) \|\| isset( $block_type->parent ) ) {
367	continue;
368	}
369
370	$unprefixed_block_name = self::remove_extension_prefix( $block_name );
371
372	if ( in_array( $unprefixed_block_name, self::$extensions, true ) ) {
373	continue;
374	}
375
376	$unwhitelisted_blocks[ $unprefixed_block_name ] = array(
377	'available' => false,
378	'unavailable_reason' => 'not_whitelisted',
379	);
380	}
381
382	// Finally: Unwhitelisted non-block extensions. These are in $availability.
383	$unwhitelisted_extensions = array_fill_keys(
384	array_diff( array_keys( self::$availability ), self::$extensions ),
385	array(
386	'available' => false,
387	'unavailable_reason' => 'not_whitelisted',
388	)
389	);
390	return array_merge( $available_extensions, $unwhitelisted_blocks, $unwhitelisted_extensions );
391	}
392
393	/**
394	* Check if an extension/block is already registered
395	*
396	* @since 7.2
397	*
398	* @param string $slug Name of extension/block to check.
399	*
400	* @return bool
401	*/
402	public static function is_registered( $slug ) {
403	return WP_Block_Type_Registry::get_instance()->is_registered( $slug );
404	}
405
406	/**
407	* Check if Gutenberg editor is available
408	*
409	* @since 6.7.0
410	*
411	* @return bool
412	*/
413	public static function is_gutenberg_available() {
414	return true;
415	}
416
417	/**
418	* Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
419	*
420	* Loading blocks and plugins is enabled by default and may be disabled via filter:
421	* add_filter( 'jetpack_gutenberg', '__return_false' );
422	*
423	* @since 6.9.0
424	*
425	* @return bool
426	*/
427	public static function should_load() {
428	if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
429	return false;
430	}
431
432	/**
433	* Filter to disable Gutenberg blocks
434	*
435	* @since 6.5.0
436	*
437	* @param bool true Whether to load Gutenberg blocks
438	*/
439	return (bool) apply_filters( 'jetpack_gutenberg', true );
440	}
441
442	/**
443	* Only enqueue block assets when needed.
444	*
445	* @param string $type Slug of the block.
446	* @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
447	*
448	* @return void
449	*/
450	public static function load_assets_as_required( $type, $script_dependencies = array() ) {
451	if ( is_admin() ) {
452	// A block's view assets will not be required in wp-admin.
453	return;
454	}
455
456	$type = sanitize_title_with_dashes( $type );
457	self::load_styles_as_required( $type );
458	self::load_scripts_as_required( $type, $script_dependencies );
459	}
460
461	/**
462	* Only enqueue block sytles when needed.
463	*
464	* @param string $type Slug of the block.
465	*
466	* @since 7.2.0
467	*
468	* @return void
469	*/
470	public static function load_styles_as_required( $type ) {
471	if ( is_admin() ) {
472	// A block's view assets will not be required in wp-admin.
473	return;
474	}
475
476	// Enqueue styles.
477	$style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
478	if ( self::block_has_asset( $style_relative_path ) ) {
479	$style_version = self::get_asset_version( $style_relative_path );
480	$view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
481	wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
482	}
483
484	}
485	/**
486	* Only enqueue block scripts when needed.
487	*
488	* @param string $type Slug of the block.
489	* @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
490	*
491	* @since 7.2.0
492	*
493	* @return void
494	*/
495	public static function load_scripts_as_required( $type, $script_dependencies = array() ) {
496	if ( is_admin() ) {
497	// A block's view assets will not be required in wp-admin.
498	return;
499	}
500
501	// Enqueue script.
502	$script_relative_path = self::get_blocks_directory() . $type . '/view.js';
503	if ( self::block_has_asset( $script_relative_path ) ) {
504	$script_version = self::get_asset_version( $script_relative_path );
505	$view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
506	wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
507	}
508
509	wp_localize_script(
510	'jetpack-block-' . $type,
511	'Jetpack_Block_Assets_Base_Url',
512	plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE )
513	);
514	}
515
516	/**
517	* Check if an asset exists for a block.
518	*
519	* @param string $file Path of the file we are looking for.
520	*
521	* @return bool $block_has_asset Does the file exist.
522	*/
523	public static function block_has_asset( $file ) {
524	return file_exists( JETPACK__PLUGIN_DIR . $file );
525	}
526
527	/**
528	* Get the version number to use when loading the file. Allows us to bypass cache when developing.
529	*
530	* @param string $file Path of the file we are looking for.
531	*
532	* @return string $script_version Version number.
533	*/
534	public static function get_asset_version( $file ) {
535	return Jetpack::is_development_version() && self::block_has_asset( $file )
536	? filemtime( JETPACK__PLUGIN_DIR . $file )
537	: JETPACK__VERSION;
538	}
539
540	/**
541	* Load Gutenberg editor assets
542	*
543	* @since 6.7.0
544	*
545	* @return void
546	*/
547	public static function enqueue_block_editor_assets() {
548	if ( ! self::should_load() ) {
549	return;
550	}
551
552	$rtl = is_rtl() ? '.rtl' : '';
553	$beta = Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ? '-beta' : '';
554	$blocks_dir = self::get_blocks_directory();
555
556	$editor_script = plugins_url( "{$blocks_dir}editor{$beta}.js", JETPACK__PLUGIN_FILE );
557	$editor_style = plugins_url( "{$blocks_dir}editor{$beta}{$rtl}.css", JETPACK__PLUGIN_FILE );
558
559	$version = Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
560	? filemtime( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
561	: JETPACK__VERSION;
562
563	if ( method_exists( 'Jetpack', 'build_raw_urls' ) ) {
564	$site_fragment = Jetpack::build_raw_urls( home_url() );
565	} elseif ( class_exists( 'WPCOM_Masterbar' ) && method_exists( 'WPCOM_Masterbar', 'get_calypso_site_slug' ) ) {
566	$site_fragment = WPCOM_Masterbar::get_calypso_site_slug( get_current_blog_id() );
567	} else {
568	$site_fragment = '';
569	}
570
571	wp_enqueue_script(
572	'jetpack-blocks-editor',
573	$editor_script,
574	array(
575	'lodash',
576	'wp-api-fetch',
577	'wp-blob',
578	'wp-blocks',
579	'wp-components',
580	'wp-compose',
581	'wp-data',
582	'wp-date',
583	'wp-edit-post',
584	'wp-editor',
585	'wp-element',
586	'wp-hooks',
587	'wp-i18n',
588	'wp-keycodes',
589	'wp-plugins',
590	'wp-polyfill',
591	'wp-rich-text',
592	'wp-token-list',
593	'wp-url',
594	),
595	$version,
596	false
597	);
598
599	wp_localize_script(
600	'jetpack-blocks-editor',
601	'Jetpack_Block_Assets_Base_Url',
602	plugins_url( $blocks_dir . '/', JETPACK__PLUGIN_FILE )
603	);
604
605	wp_localize_script(
606	'jetpack-blocks-editor',
607	'Jetpack_Editor_Initial_State',
608	array(
609	'available_blocks' => self::get_availability(),
610	'jetpack' => array( 'is_active' => Jetpack::is_active() ),
611	'siteFragment' => $site_fragment,
612	)
613	);
614
615	wp_set_script_translations( 'jetpack-blocks-editor', 'jetpack', plugins_url( 'languages/json', JETPACK__PLUGIN_FILE ) );
616
617	// Adding a filter late to allow every other filter to process the path, including the CDN.
618	add_filter( 'pre_load_script_translations', array( __CLASS__, 'filter_pre_load_script_translations' ), 1000, 3 );
619
620	wp_enqueue_style( 'jetpack-blocks-editor', $editor_style, array(), $version );
621	}
622
623	/**
624	* A workaround for setting i18n data for WordPress client-side i18n mechanism.
625	* We are not yet using dotorg language packs for the editor file, so this short-circuits
626	* the translation loading and feeds our JSON data directly into the translation getter.
627	*
628	* @param NULL $null not used.
629	* @param String $file the file path that is being loaded, ignored.
630	* @param String $handle the script handle.
631	* @return NULL\|String the translation data only if we're working with our handle.
632	*/
633	public static function filter_pre_load_script_translations( $null, $file, $handle ) {
634	if ( 'jetpack-blocks-editor' !== $handle ) {
635	return null;
636	}
637
638	return Jetpack::get_i18n_data_json();
639	}
640
641	/**
642	* Some blocks do not depend on a specific module,
643	* and can consequently be loaded outside of the usual modules.
644	* We will look for such modules in the extensions/ directory.
645	*
646	* @since 7.1.0
647	*/
648	public static function load_independent_blocks() {
649	if ( self::should_load() ) {
650	/**
651	* Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
652	* If available, load them.
653	*/
654	foreach ( self::$extensions as $extension ) {
655	$extension_file_glob = glob( JETPACK__PLUGIN_DIR . 'extensions/*/' . $extension . '/' . $extension . '.php' );
656	if ( ! empty( $extension_file_glob ) ) {
657	include_once $extension_file_glob[0];
658	}
659	}
660	}
661	}
662	}
663