Jetpack_Gutenberg::is_available() - Code Metrics - Inspection of "Update webpack.config to work with new version" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — renovate/webpack-4.x ( 921a57...5704ad )

unknown

created 2018-12-12 10:03 UTC

Jetpack_Gutenberg::is_available() A

↳ Parent: Jetpack_Gutenberg

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	6
rs	10
c	0
b	0
f	0

<?php
/**
 * Handles server-side registration and use of all blocks available in Jetpack for the block editor, aka Gutenberg.
 * Works in tandem with client-side block registration via `block-manifest.json`
 *
 * @package Jetpack
 */

/**
 * Helper function to register a Jetpack Gutenberg block
 *
 * @param string $slug Slug of the block
 * @param array  $args Arguments that are passed into the register_block_type.
 * @param array  $avalibility Arguments that tells us what kind of avalibility the block has
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 *
 * @see register_block_type
 *
 * @since 6.7.0
 *
 * @return void
 */
function jetpack_register_block( $slug, $args = array(), $availability = array( 'available' => true ) ) {
	Jetpack_Gutenberg::register( $slug, $args, $availability );
}

/**
 * Helper function to register a Jetpack Gutenberg plugin
 *
 * @param string $slug Slug of the plugin.
 * @param array  $avalibility Arguments that tells us what kind of avalibility the plugin has
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 *
 * @see register_block_type
 *
 * @since 6.9.0
 *
 * @return void
 */
function jetpack_register_plugin( $slug, $availability = array( 'available' => true ) ) {
	Jetpack_Gutenberg::register( $slug, array(), $availability );
}

/**
 * General Gutenberg editor specific functionality
 */
class Jetpack_Gutenberg {

	// BLOCKS
	private static $default_blocks = array(
		'map',
		'markdown',
		'simple-payments',
		'related-posts',
		'contact-form',
		'field-text',
		'field-name',
		'field-email',
		'field-url',
		'field-date',
		'field-telephone',
		'field-textarea',
		'field-checkbox',
		'field-checkbox-multiple',
		'field-radio',
		'field-select'
	);

	/**
	 * @var array Array of blocks information.
	 *
	 * For each block we have information about the availability for the current user
	 */
	private static $blocks = array();

	private static $availability = array();

	// PLUGINS
	private static $default_plugins = array(
		'publicize',
	);
	/**
	 * @var array Array of plugins information.
	 *
	 * For each block we have information about the availability for the current user
	 */
	private static $plugins = array();

	/**
	 * @var array Array of extensions we will be registering.
	 */
	private static $registered = array();

	/**
	 * Add a block to the list of blocks to be registered.
	 *
	 * @param string $slug Slug of the block.
	 * @param array  $args Arguments that are passed into the register_block_type.
	 * @param array $availability array containing if a block is available and the reason when it is not.
	 */
	public static function register( $slug, $args, $availability ) {
		$sanitized_slug = sanitize_title_with_dashes( $slug );
		self::$registered[ $sanitized_slug ] = array( 'args' => $args, 'availability' => $availability );
	}

	/**
	 * Register all Jetpack blocks available.
	 *
	 * @return void
	 */
	public static function init() {
		if ( ! self::is_gutenberg_available() ) {
			return;
		}

		if ( ! self::should_load() ) {
			return;
		}

		if ( Jetpack_Constants::is_true( 'REST_API_REQUEST' ) ) {
			// We defer the loading of the blocks until we have a better scope in reset requests.

			add_filter( 'rest_request_before_callbacks', array( __CLASS__, 'load' ) );
			return;
		}

		self::load();
	}

	/**
	 * @deprecated
	 */
	static function load_blocks() {
		self::init();
	}

	/**
	 * Add a block to the list of blocks to be registered.
	 *
	 * @param string $slug Slug of the block.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param array  $args Arguments that are passed into the register_block_type.
	 * @param array $availability array containing if a block is available and the reason when it is not.
	 *
	 * @deprecated
	 */
	static function add_block( $type, $args, $availability ) {
		self::register( $type, $args, $availability );
	}

	static function load( $request = null ) {
		/**
		 * Filter the list of block editor blocks that are available through jetpack.
		 *
		 * This filter is populated by Jetpack_Gutenberg::jetpack_set_available_blocks
		 *
		 * @since 6.8.0
		 *
		 * @param array
		 */
		self::$blocks = apply_filters( 'jetpack_set_available_blocks', self::$default_blocks );

		/**
		 * Filter the list of block editor plugins that are available through jetpack.
		 *
		 * This filter is populated by Jetpack_Gutenberg::jetpack_set_available_blocks
		 *
		 * @since 6.9.0
		 *
		 * @param array
		 */
		self::$plugins = apply_filters( 'jetpack_set_available_plugins', self::$default_plugins );
		self::set_blocks_availability();
		self::set_plugins_availability();
		self::register_blocks();
		return $request;
	}

	static function is_registered( $slug ) {
		return isset( self::$registered[ $slug ] );
	}

	static function get_registered_args( $slug ) {
		return self::$registered[ $slug ]['args'];
	}
	static function get_registered_type( $slug ) {
		return self::$registered[ $slug ]['type'];
	}

	static function is_available( $slug ) {
		if ( ! isset( self::$availability[ $slug ]['available'] ) ) {
			return false;
		}
		return (bool) self::$availability[ $slug ]['available'];
	}


	static function get_extension_availability( $slug ) {
		if ( ! self::is_registered( $slug ) ) {
			return array( 'available' => false, 'unavailable_reason' => 'missing_module' );
		}

		$availability = self::$registered[ $slug ]['availability'];

		if ( isset( $availability['callback'] ) ) {
			$availability = call_user_func( $availability['callback'] );
		}

		$availability['available'] = isset( $availability['available'] )
			? (bool) $availability['available']
			: true ; // this is the default value

		if ( ! $availability['available'] ) {
			$availability['unavailable_reason'] = isset( $availability['unavailable_reason'] )
				? $availability['unavailable_reason']
				: 'unknown'; //
		}

		return $availability;
	}

	static function set_blocks_availability() {
		foreach ( self::$blocks as $slug ) {
			self::$availability[ $slug ] = self::get_extension_availability( $slug );
		}
	}

	static function set_plugins_availability() {
		foreach ( self::$plugins as $slug ) {
			self::$availability[ $slug ] = self::get_extension_availability( $slug );
		}
	}

	static function register_blocks() {
		foreach ( self::$blocks as $slug ) {
			if ( self::is_available( $slug ) ) {
				register_block_type( 'jetpack/' . $slug, self::get_registered_args( $slug ) );
			}
		}
	}

	/**
	 * Return the Gutenberg extensions (blocks and plugins) directory
	 *
	 * @return string The Gutenberg extensions directory
	 */
	public static function get_blocks_directory() {
		/**
		 * Filter to select Gutenberg blocks directory
		 *
		 * @since 6.9
		 *
		 * @param string default: '_inc/blocks/'
		 */
		return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
	}

	/**
	 * Checks for a given .json file in the blocks folder.
	 *
	 * @param $preset The name of the .json file to look for.
	 *
	 * @return bool True if the file is found.
	 */
	public static function preset_exists( $preset ) {
		return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
	}

	/**
	 * Decodes JSON loaded from a preset file in the blocks folder
	 *
	 * @param $preset The name of the .json file to load.
	 *
	 * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
	 */
	public static function get_preset( $preset ) {
		return json_decode( file_get_contents(  JETPACK__PLUGIN_DIR .self::get_blocks_directory() . $preset . '.json' ) );
	}

	/**
	 * Filters the results of `apply_filter( 'jetpack_set_available_blocks', array() )`
	 * using the merged contents of `blocks-manifest.json` ( $preset_blocks )
	 * and self::$jetpack_blocks ( $internal_blocks )
	 *
	 * @param $blocks The default list.
	 *
	 * @return array A list of blocks: eg [ 'publicize', 'markdown' ]
	 */
	public static function jetpack_set_available_blocks( $blocks ) {
		$preset_blocks_manifest =  self::preset_exists( 'block-manifest' ) ? self::get_preset( 'block-manifest' ) : (object) array( 'blocks' => $blocks );
		// manifest shouldn't remove default blocks...

		$preset_blocks = isset( $preset_blocks_manifest->blocks ) ? (array) $preset_blocks_manifest->blocks : array() ;
		$preset_blocks = array_unique( array_merge( $preset_blocks, $blocks ) );
		if ( Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ) {
			$beta_blocks = isset( $preset_blocks_manifest->betaBlocks ) ? (array) $preset_blocks_manifest->betaBlocks : array();
			return array_unique( array_merge( $preset_blocks, $beta_blocks ) );
		}

		return $preset_blocks;
	}

	/**
	 * @deprecated
	 * @return array A list of block-availability information, eg: [ "publicize" => ["available" => true ], "markdown" => [ "available" => false, "unavailable_reason" => 'missing_module' ] ]
	 */
	public static function get_block_availability() {
		return self::get_availability();
	}

	/**
	 * @return array A list of block and plugins and their availablity status
	 */
	public static function get_availability() {
		if ( ! self::should_load() ) {
			return array();
		}

		return self::$availability;
	}

	/**
	 * Check if Gutenberg editor is available
	 *
	 * @since 6.7.0
	 *
	 * @return bool
	 */
	public static function is_gutenberg_available() {
		return function_exists( 'register_block_type' );
	}

	/**
	 * Check whether conditions indicate Gutenberg blocks should be loaded
	 *
	 * Loading blocks is enabled by default and may be disabled via filter:
	 *   add_filter( 'jetpack_gutenberg', '__return_false' );
	 *
	 * @since 6.7.0
	 * @deprecated
	 * @return bool
	 */
	public static function should_load_blocks() {
		return self::should_load();
	}

	/**
	 * Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
	 *
	 * Loading blocks and plugins is enabled by default and may be disabled via filter:
	 *   add_filter( 'jetpack_gutenberg', '__return_false' );
	 *
	 * @since 6.9.0
	 *
	 * @return bool
	 */
	public static function should_load() {
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
			return false;
		}

		/**
		 * Filter to disable Gutenberg blocks
		 *
		 * @since 6.5.0
		 *
		 * @param bool true Whether to load Gutenberg blocks
		 */
		return (bool) apply_filters( 'jetpack_gutenberg', true );
	}

	/**
	 * Only enqueue block assets when needed.
	 *
	 * @param string $type slug of the block.
	 * @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
	 *
	 * @return void
	 */
	public static function load_assets_as_required( $type, $script_dependencies = array() ) {
		if ( is_admin() ) {
			// A block's view assets will not be required in wp-admin.
			return;
		}

		$type = sanitize_title_with_dashes( $type );
		// Enqueue styles.
		$style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
		if ( self::block_has_asset( $style_relative_path ) ) {
			$style_version = self::get_asset_version( $style_relative_path );
			$view_style    = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
			wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
		}

		// Enqueue script.
		$script_relative_path = self::get_blocks_directory() . $type . '/view.js';
		if ( self::block_has_asset( $script_relative_path ) ) {
			$script_version = self::get_asset_version( $script_relative_path );
			$view_script    = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
			wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
		}

		wp_localize_script(
			'jetpack-block-' . $type,
			'Jetpack_Block_Assets_Base_Url',
			plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE )
		);
	}

	/**
	 * Check if an asset exists for a block.
	 *
	 * @param string $file Path of the file we are looking for.
	 *
	 * @return bool $block_has_asset Does the file exist.
	 */
	public static function block_has_asset( $file ) {
		return file_exists( JETPACK__PLUGIN_DIR . $file );
	}

	/**
	 * Get the version number to use when loading the file. Allows us to bypass cache when developing.
	 *
	 * @param string $file Path of the file we are looking for.
	 *
	 * @return string $script_version Version number.
	 */
	public static function get_asset_version( $file ) {
		return Jetpack::is_development_version() && self::block_has_asset( $file )
			? filemtime( JETPACK__PLUGIN_DIR . $file )
			: JETPACK__VERSION;
	}

	/**
	 * Load Gutenberg editor assets
	 *
	 * @since 6.7.0
	 *
	 * @return void
	 */
	public static function enqueue_block_editor_assets() {
		if ( ! self::should_load_blocks() ) {

			return;
		}

		$rtl = is_rtl() ? '.rtl' : '';
		$beta = Jetpack_Constants::is_true('JETPACK_BETA_BLOCKS' ) ? '-beta' : '';
		$blocks_dir = self::get_blocks_directory();

		$editor_script = plugins_url( "{$blocks_dir}editor{$beta}.js", JETPACK__PLUGIN_FILE );
		$editor_style  = plugins_url( "{$blocks_dir}editor{$beta}{$rtl}.css", JETPACK__PLUGIN_FILE );

		$version       = Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
			? filemtime( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
			: JETPACK__VERSION;

		wp_enqueue_script(
			'jetpack-blocks-editor',
			$editor_script,
			array(
				'lodash',
				'wp-api-fetch',
				'wp-blocks',
				'wp-components',
				'wp-compose',
				'wp-data',
				'wp-date',
				'wp-edit-post',
				'wp-editor',
				'wp-element',
				'wp-hooks',
				'wp-i18n',
				'wp-keycodes',
				'wp-plugins',
				'wp-rich-text',
				'wp-token-list',
				'wp-url',
			),
			$version,
			false
		);

		wp_localize_script(
			'jetpack-blocks-editor',
			'Jetpack_Block_Assets_Base_Url',
			plugins_url( $blocks_dir . '/', JETPACK__PLUGIN_FILE )
		);

		wp_localize_script(
			'jetpack-blocks-editor',
			'Jetpack_Editor_Initial_State',
			array(
				'available_blocks' => self::get_block_availability(),

				'jetpack' => array( 'is_active' => Jetpack::is_active() ),
			)
		);

		Jetpack::setup_wp_i18n_locale_data();

		wp_enqueue_style( 'jetpack-blocks-editor', $editor_style, array(), $version );

		// The social-logos styles are used for Publicize service icons
		// TODO: Remove when we ship the icons with the Gutenberg blocks build
		wp_enqueue_style( 'social-logos' );
	}
}


1		<?php
2		/**
3		* Handles server-side registration and use of all blocks available in Jetpack for the block editor, aka Gutenberg.
4		* Works in tandem with client-side block registration via `block-manifest.json`
5		*
6		* @package Jetpack
7		*/
8
9		/**
10		* Helper function to register a Jetpack Gutenberg block
11		*
12		* @param string $slug Slug of the block
13		* @param array $args Arguments that are passed into the register_block_type.
14		* @param array $avalibility Arguments that tells us what kind of avalibility the block has
		0 ignored issues – show Bug introduced 2018-11-01 18:41 UTC by Report Bug Copy Issue Report There is no parameter named `$avalibility`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
15		*
16		* @see register_block_type
17		*
18		* @since 6.7.0
19		*
20		* @return void
21		*/
22		function jetpack_register_block( $slug, $args = array(), $availability = array( 'available' => true ) ) {
23		Jetpack_Gutenberg::register( $slug, $args, $availability );
24		}
25
26		/**
27		* Helper function to register a Jetpack Gutenberg plugin
28		*
29		* @param string $slug Slug of the plugin.
30		* @param array $avalibility Arguments that tells us what kind of avalibility the plugin has
		0 ignored issues – show Bug introduced 2018-12-10 18:37 UTC by Report Bug Copy Issue Report There is no parameter named `$avalibility`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
31		*
32		* @see register_block_type
33		*
34		* @since 6.9.0
35		*
36		* @return void
37		*/
38		function jetpack_register_plugin( $slug, $availability = array( 'available' => true ) ) {
39		Jetpack_Gutenberg::register( $slug, array(), $availability );
40		}
41
42		/**
43		* General Gutenberg editor specific functionality
44		*/
45		class Jetpack_Gutenberg {
46
47		// BLOCKS
48		private static $default_blocks = array(
49		'map',
50		'markdown',
51		'simple-payments',
52		'related-posts',
53		'contact-form',
54		'field-text',
55		'field-name',
56		'field-email',
57		'field-url',
58		'field-date',
59		'field-telephone',
60		'field-textarea',
61		'field-checkbox',
62		'field-checkbox-multiple',
63		'field-radio',
64		'field-select'
65		);
66
67		/**
68		* @var array Array of blocks information.
69		*
70		* For each block we have information about the availability for the current user
71		*/
72		private static $blocks = array();
73
74		private static $availability = array();
75
76		// PLUGINS
77		private static $default_plugins = array(
78		'publicize',
79		);
80		/**
81		* @var array Array of plugins information.
82		*
83		* For each block we have information about the availability for the current user
84		*/
85		private static $plugins = array();
86
87		/**
88		* @var array Array of extensions we will be registering.
89		*/
90		private static $registered = array();
91
92		/**
93		* Add a block to the list of blocks to be registered.
94		*
95		* @param string $slug Slug of the block.
96		* @param array $args Arguments that are passed into the register_block_type.
97		* @param array $availability array containing if a block is available and the reason when it is not.
98		*/
99		public static function register( $slug, $args, $availability ) {
100		$sanitized_slug = sanitize_title_with_dashes( $slug );
101		self::$registered[ $sanitized_slug ] = array( 'args' => $args, 'availability' => $availability );
102		}
103
104		/**
105		* Register all Jetpack blocks available.
106		*
107		* @return void
108		*/
109		public static function init() {
110		if ( ! self::is_gutenberg_available() ) {
111		return;
112		}
113
114		if ( ! self::should_load() ) {
115		return;
116		}
117
118		if ( Jetpack_Constants::is_true( 'REST_API_REQUEST' ) ) {
119		// We defer the loading of the blocks until we have a better scope in reset requests.
120
121		add_filter( 'rest_request_before_callbacks', array( __CLASS__, 'load' ) );
122		return;
123		}
124
125		self::load();
126		}
127
128		/**
129		* @deprecated
130		*/
131		static function load_blocks() {
132		self::init();
133		}
134
135		/**
136		* Add a block to the list of blocks to be registered.
137		*
138		* @param string $slug Slug of the block.
		0 ignored issues – show Bug introduced 2018-12-10 18:37 UTC by Report Bug Copy Issue Report There is no parameter named `$slug`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
139		* @param array $args Arguments that are passed into the register_block_type.
140		* @param array $availability array containing if a block is available and the reason when it is not.
141		*
142		* @deprecated
143		*/
144		static function add_block( $type, $args, $availability ) {
145		self::register( $type, $args, $availability );
146		}
147
148		static function load( $request = null ) {
149		/**
150		* Filter the list of block editor blocks that are available through jetpack.
151		*
152		* This filter is populated by Jetpack_Gutenberg::jetpack_set_available_blocks
153		*
154		* @since 6.8.0
155		*
156		* @param array
157		*/
158		self::$blocks = apply_filters( 'jetpack_set_available_blocks', self::$default_blocks );
159
160		/**
161		* Filter the list of block editor plugins that are available through jetpack.
162		*
163		* This filter is populated by Jetpack_Gutenberg::jetpack_set_available_blocks
164		*
165		* @since 6.9.0
166		*
167		* @param array
168		*/
169		self::$plugins = apply_filters( 'jetpack_set_available_plugins', self::$default_plugins );
170		self::set_blocks_availability();
171		self::set_plugins_availability();
172		self::register_blocks();
173		return $request;
174		}
175
176		static function is_registered( $slug ) {
177		return isset( self::$registered[ $slug ] );
178		}
179
180		static function get_registered_args( $slug ) {
181		return self::$registered[ $slug ]['args'];
182		}
183		static function get_registered_type( $slug ) {
184		return self::$registered[ $slug ]['type'];
185		}
186
187		static function is_available( $slug ) {
188		if ( ! isset( self::$availability[ $slug ]['available'] ) ) {
189		return false;
190		}
191		return (bool) self::$availability[ $slug ]['available'];
192		}
193
194
195		static function get_extension_availability( $slug ) {
196		if ( ! self::is_registered( $slug ) ) {
197		return array( 'available' => false, 'unavailable_reason' => 'missing_module' );
198		}
199
200		$availability = self::$registered[ $slug ]['availability'];
201
202		if ( isset( $availability['callback'] ) ) {
203		$availability = call_user_func( $availability['callback'] );
204		}
205
206		$availability['available'] = isset( $availability['available'] )
207		? (bool) $availability['available']
208		: true ; // this is the default value
209
210		if ( ! $availability['available'] ) {
211		$availability['unavailable_reason'] = isset( $availability['unavailable_reason'] )
212		? $availability['unavailable_reason']
213		: 'unknown'; //
214		}
215
216		return $availability;
217		}
218
219		static function set_blocks_availability() {
220		foreach ( self::$blocks as $slug ) {
221		self::$availability[ $slug ] = self::get_extension_availability( $slug );
222		}
223		}
224
225		static function set_plugins_availability() {
226		foreach ( self::$plugins as $slug ) {
227		self::$availability[ $slug ] = self::get_extension_availability( $slug );
228		}
229		}
230
231		static function register_blocks() {
232		foreach ( self::$blocks as $slug ) {
233		if ( self::is_available( $slug ) ) {
234		register_block_type( 'jetpack/' . $slug, self::get_registered_args( $slug ) );
235		}
236		}
237		}
238
239		/**
240		* Return the Gutenberg extensions (blocks and plugins) directory
241		*
242		* @return string The Gutenberg extensions directory
243		*/
244		public static function get_blocks_directory() {
245		/**
246		* Filter to select Gutenberg blocks directory
247		*
248		* @since 6.9
249		*
250		* @param string default: '_inc/blocks/'
251		*/
252		return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
253		}
254
255		/**
256		* Checks for a given .json file in the blocks folder.
257		*
258		* @param $preset The name of the .json file to look for.
259		*
260		* @return bool True if the file is found.
261		*/
262		public static function preset_exists( $preset ) {
263		return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
264		}
265
266		/**
267		* Decodes JSON loaded from a preset file in the blocks folder
268		*
269		* @param $preset The name of the .json file to load.
270		*
271		* @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
272		*/
273		public static function get_preset( $preset ) {
274		return json_decode( file_get_contents( JETPACK__PLUGIN_DIR .self::get_blocks_directory() . $preset . '.json' ) );
275		}
276
277		/**
278		* Filters the results of `apply_filter( 'jetpack_set_available_blocks', array() )`
279		* using the merged contents of `blocks-manifest.json` ( $preset_blocks )
280		* and self::$jetpack_blocks ( $internal_blocks )
281		*
282		* @param $blocks The default list.
283		*
284		* @return array A list of blocks: eg [ 'publicize', 'markdown' ]
285		*/
286		public static function jetpack_set_available_blocks( $blocks ) {
287		$preset_blocks_manifest = self::preset_exists( 'block-manifest' ) ? self::get_preset( 'block-manifest' ) : (object) array( 'blocks' => $blocks );
288		// manifest shouldn't remove default blocks...
289
290		$preset_blocks = isset( $preset_blocks_manifest->blocks ) ? (array) $preset_blocks_manifest->blocks : array() ;
291		$preset_blocks = array_unique( array_merge( $preset_blocks, $blocks ) );
292		if ( Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ) {
293		$beta_blocks = isset( $preset_blocks_manifest->betaBlocks ) ? (array) $preset_blocks_manifest->betaBlocks : array();
294		return array_unique( array_merge( $preset_blocks, $beta_blocks ) );
295		}
296
297		return $preset_blocks;
298		}
299
300		/**
301		* @deprecated
302		* @return array A list of block-availability information, eg: [ "publicize" => ["available" => true ], "markdown" => [ "available" => false, "unavailable_reason" => 'missing_module' ] ]
303		*/
304		public static function get_block_availability() {
305		return self::get_availability();
306		}
307
308		/**
309		* @return array A list of block and plugins and their availablity status
310		*/
311		public static function get_availability() {
312		if ( ! self::should_load() ) {
313		return array();
314		}
315
316		return self::$availability;
317		}
318
319		/**
320		* Check if Gutenberg editor is available
321		*
322		* @since 6.7.0
323		*
324		* @return bool
325		*/
326		public static function is_gutenberg_available() {
327		return function_exists( 'register_block_type' );
328		}
329
330		/**
331		* Check whether conditions indicate Gutenberg blocks should be loaded
332		*
333		* Loading blocks is enabled by default and may be disabled via filter:
334		* add_filter( 'jetpack_gutenberg', '__return_false' );
335		*
336		* @since 6.7.0
337		* @deprecated
338		* @return bool
339		*/
340		public static function should_load_blocks() {
341		return self::should_load();
342		}
343
344		/**
345		* Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
346		*
347		* Loading blocks and plugins is enabled by default and may be disabled via filter:
348		* add_filter( 'jetpack_gutenberg', '__return_false' );
349		*
350		* @since 6.9.0
351		*
352		* @return bool
353		*/
354		public static function should_load() {
355		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
356		return false;
357		}
358
359		/**
360		* Filter to disable Gutenberg blocks
361		*
362		* @since 6.5.0
363		*
364		* @param bool true Whether to load Gutenberg blocks
365		*/
366		return (bool) apply_filters( 'jetpack_gutenberg', true );
367		}
368
369		/**
370		* Only enqueue block assets when needed.
371		*
372		* @param string $type slug of the block.
373		* @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
374		*
375		* @return void
376		*/
377		public static function load_assets_as_required( $type, $script_dependencies = array() ) {
378		if ( is_admin() ) {
379		// A block's view assets will not be required in wp-admin.
380		return;
381		}
382
383		$type = sanitize_title_with_dashes( $type );
384		// Enqueue styles.
385		$style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
386	View Code Duplication	if ( self::block_has_asset( $style_relative_path ) ) {
387		$style_version = self::get_asset_version( $style_relative_path );
388		$view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
389		wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
390		}
391
392		// Enqueue script.
393		$script_relative_path = self::get_blocks_directory() . $type . '/view.js';
394	View Code Duplication	if ( self::block_has_asset( $script_relative_path ) ) {
395		$script_version = self::get_asset_version( $script_relative_path );
396		$view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
397		wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
398		}
399
400		wp_localize_script(
401		'jetpack-block-' . $type,
402		'Jetpack_Block_Assets_Base_Url',
403		plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE )
404		);
405		}
406
407		/**
408		* Check if an asset exists for a block.
409		*
410		* @param string $file Path of the file we are looking for.
411		*
412		* @return bool $block_has_asset Does the file exist.
413		*/
414		public static function block_has_asset( $file ) {
415		return file_exists( JETPACK__PLUGIN_DIR . $file );
416		}
417
418		/**
419		* Get the version number to use when loading the file. Allows us to bypass cache when developing.
420		*
421		* @param string $file Path of the file we are looking for.
422		*
423		* @return string $script_version Version number.
424		*/
425		public static function get_asset_version( $file ) {
426		return Jetpack::is_development_version() && self::block_has_asset( $file )
427		? filemtime( JETPACK__PLUGIN_DIR . $file )
428		: JETPACK__VERSION;
429		}
430
431		/**
432		* Load Gutenberg editor assets
433		*
434		* @since 6.7.0
435		*
436		* @return void
437		*/
438		public static function enqueue_block_editor_assets() {
439		if ( ! self::should_load_blocks() ) {
		0 ignored issues – show Deprecated Code introduced 2018-12-10 18:37 UTC by Report Bug Copy Issue Report The method `Jetpack_Gutenberg::should_load_blocks()` has been deprecated. This method has been deprecated. Loading history...
440		return;
441		}
442
443		$rtl = is_rtl() ? '.rtl' : '';
444		$beta = Jetpack_Constants::is_true('JETPACK_BETA_BLOCKS' ) ? '-beta' : '';
445		$blocks_dir = self::get_blocks_directory();
446
447		$editor_script = plugins_url( "{$blocks_dir}editor{$beta}.js", JETPACK__PLUGIN_FILE );
448		$editor_style = plugins_url( "{$blocks_dir}editor{$beta}{$rtl}.css", JETPACK__PLUGIN_FILE );
449
450		$version = Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
451		? filemtime( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
452		: JETPACK__VERSION;
453
454		wp_enqueue_script(
455		'jetpack-blocks-editor',
456		$editor_script,
457		array(
458		'lodash',
459		'wp-api-fetch',
460		'wp-blocks',
461		'wp-components',
462		'wp-compose',
463		'wp-data',
464		'wp-date',
465		'wp-edit-post',
466		'wp-editor',
467		'wp-element',
468		'wp-hooks',
469		'wp-i18n',
470		'wp-keycodes',
471		'wp-plugins',
472		'wp-rich-text',
473		'wp-token-list',
474		'wp-url',
475		),
476		$version,
477		false
478		);
479
480		wp_localize_script(
481		'jetpack-blocks-editor',
482		'Jetpack_Block_Assets_Base_Url',
483		plugins_url( $blocks_dir . '/', JETPACK__PLUGIN_FILE )
484		);
485
486		wp_localize_script(
487		'jetpack-blocks-editor',
488		'Jetpack_Editor_Initial_State',
489		array(
490		'available_blocks' => self::get_block_availability(),
		0 ignored issues – show Deprecated Code introduced 2018-12-10 18:37 UTC by Report Bug Copy Issue Report The method `Jetpack_Gutenberg::get_block_availability()` has been deprecated. This method has been deprecated. Loading history...
491		'jetpack' => array( 'is_active' => Jetpack::is_active() ),
492		)
493		);
494
495		Jetpack::setup_wp_i18n_locale_data();
496
497		wp_enqueue_style( 'jetpack-blocks-editor', $editor_style, array(), $version );
498
499		// The social-logos styles are used for Publicize service icons
500		// TODO: Remove when we ship the icons with the Gutenberg blocks build
501		wp_enqueue_style( 'social-logos' );
502		}
503		}
504

Automattic / jetpack

Push — renovate/webpack-4.x ( 921a57...5704ad )

Jetpack_Gutenberg::is_available() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like