Jetpack_Gutenberg::is_available() - Code Metrics - Inspection of "Add fix for the rest route" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — mailchimp/introduce-shortcode ( b80f24...10eaea )

unknown

created 2018-12-28 12:29 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 `index.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',
		'subscriptions',
	);

	/**
	 * @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',
		'shortlinks',
	);
	/**
	 * @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' ), 10, 3 );
			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( $response = null, $handler = null, $request = null ) {
		$is_availability_endpoint_beta = ! is_null( $request ) && $request->get_param( 'beta' ) && wp_endswith( $request->get_route(), 'gutenberg/available-extensions' );

		/**
		 * Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
		 *
		 * @since 6.9.0
		 *
		 * @param boolean
		 */
		if ( apply_filters( 'jetpack_load_beta_blocks', $is_availability_endpoint_beta ) ) {
			Jetpack_Constants::set_constant( 'JETPACK_BETA_BLOCKS', true );
		}

		/**
		 * 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 $response;
	}

	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( 'index' ) ? self::get_preset( 'index' ) : (object) array( 'blocks' => $blocks );
		// manifest shouldn't remove default blocks...

		$preset_blocks = isset( $preset_blocks_manifest->production ) ? (array) $preset_blocks_manifest->production : array() ;
		$preset_blocks = array_unique( array_merge( $preset_blocks, $blocks ) );

		if ( Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ) {
			$beta_blocks = isset( $preset_blocks_manifest->beta ) ? (array) $preset_blocks_manifest->beta : 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 `index.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		'subscriptions',
66		);
67
68		/**
69		* @var array Array of blocks information.
70		*
71		* For each block we have information about the availability for the current user
72		*/
73		private static $blocks = array();
74
75		private static $availability = array();
76
77		// PLUGINS
78		private static $default_plugins = array(
79		'publicize',
80		'shortlinks',
81		);
82		/**
83		* @var array Array of plugins information.
84		*
85		* For each block we have information about the availability for the current user
86		*/
87		private static $plugins = array();
88
89		/**
90		* @var array Array of extensions we will be registering.
91		*/
92		private static $registered = array();
93
94		/**
95		* Add a block to the list of blocks to be registered.
96		*
97		* @param string $slug Slug of the block.
98		* @param array $args Arguments that are passed into the register_block_type.
99		* @param array $availability array containing if a block is available and the reason when it is not.
100		*/
101		public static function register( $slug, $args, $availability ) {
102		$sanitized_slug = sanitize_title_with_dashes( $slug );
103		self::$registered[ $sanitized_slug ] = array( 'args' => $args, 'availability' => $availability );
104		}
105
106		/**
107		* Register all Jetpack blocks available.
108		*
109		* @return void
110		*/
111		public static function init() {
112		if ( ! self::is_gutenberg_available() ) {
113		return;
114		}
115
116		if ( ! self::should_load() ) {
117		return;
118		}
119
120		if ( Jetpack_Constants::is_true( 'REST_API_REQUEST' ) ) {
121		// We defer the loading of the blocks until we have a better scope in reset requests.
122		add_filter( 'rest_request_before_callbacks', array( __CLASS__, 'load' ), 10, 3 );
123		return;
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( $response = null, $handler = null, $request = null ) {
149		$is_availability_endpoint_beta = ! is_null( $request ) && $request->get_param( 'beta' ) && wp_endswith( $request->get_route(), 'gutenberg/available-extensions' );
150
151		/**
152		* Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
153		*
154		* @since 6.9.0
155		*
156		* @param boolean
157		*/
158		if ( apply_filters( 'jetpack_load_beta_blocks', $is_availability_endpoint_beta ) ) {
159		Jetpack_Constants::set_constant( 'JETPACK_BETA_BLOCKS', true );
160		}
161
162		/**
163		* Filter the list of block editor blocks that are available through jetpack.
164		*
165		* This filter is populated by Jetpack_Gutenberg::jetpack_set_available_blocks
166		*
167		* @since 6.8.0
168		*
169		* @param array
170		*/
171		self::$blocks = apply_filters( 'jetpack_set_available_blocks', self::$default_blocks );
172
173		/**
174		* Filter the list of block editor plugins that are available through jetpack.
175		*
176		* This filter is populated by Jetpack_Gutenberg::jetpack_set_available_blocks
177		*
178		* @since 6.9.0
179		*
180		* @param array
181		*/
182		self::$plugins = apply_filters( 'jetpack_set_available_plugins', self::$default_plugins );
183		self::set_blocks_availability();
184		self::set_plugins_availability();
185		self::register_blocks();
186		return $response;
187		}
188
189		static function is_registered( $slug ) {
190		return isset( self::$registered[ $slug ] );
191		}
192
193		static function get_registered_args( $slug ) {
194		return self::$registered[ $slug ]['args'];
195		}
196		static function get_registered_type( $slug ) {
197		return self::$registered[ $slug ]['type'];
198		}
199
200		static function is_available( $slug ) {
201		if ( ! isset( self::$availability[ $slug ]['available'] ) ) {
202		return false;
203		}
204		return (bool) self::$availability[ $slug ]['available'];
205		}
206
207
208		static function get_extension_availability( $slug ) {
209		if ( ! self::is_registered( $slug ) ) {
210		return array( 'available' => false, 'unavailable_reason' => 'missing_module' );
211		}
212
213		$availability = self::$registered[ $slug ]['availability'];
214
215		if ( isset( $availability['callback'] ) ) {
216		$availability = call_user_func( $availability['callback'] );
217		}
218
219		$availability['available'] = isset( $availability['available'] )
220		? (bool) $availability['available']
221		: true ; // this is the default value
222
223		if ( ! $availability['available'] ) {
224		$availability['unavailable_reason'] = isset( $availability['unavailable_reason'] )
225		? $availability['unavailable_reason']
226		: 'unknown'; //
227		}
228
229		return $availability;
230		}
231
232		static function set_blocks_availability() {
233		foreach ( self::$blocks as $slug ) {
234		self::$availability[ $slug ] = self::get_extension_availability( $slug );
235		}
236		}
237
238		static function set_plugins_availability() {
239		foreach ( self::$plugins as $slug ) {
240		self::$availability[ $slug ] = self::get_extension_availability( $slug );
241		}
242		}
243
244		static function register_blocks() {
245		foreach ( self::$blocks as $slug ) {
246		if ( self::is_available( $slug ) ) {
247		register_block_type( 'jetpack/' . $slug, self::get_registered_args( $slug ) );
248		}
249		}
250		}
251
252		/**
253		* Return the Gutenberg extensions (blocks and plugins) directory
254		*
255		* @return string The Gutenberg extensions directory
256		*/
257		public static function get_blocks_directory() {
258		/**
259		* Filter to select Gutenberg blocks directory
260		*
261		* @since 6.9
262		*
263		* @param string default: '_inc/blocks/'
264		*/
265		return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
266		}
267
268		/**
269		* Checks for a given .json file in the blocks folder.
270		*
271		* @param $preset The name of the .json file to look for.
272		*
273		* @return bool True if the file is found.
274		*/
275		public static function preset_exists( $preset ) {
276		return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
277		}
278
279		/**
280		* Decodes JSON loaded from a preset file in the blocks folder
281		*
282		* @param $preset The name of the .json file to load.
283		*
284		* @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
285		*/
286		public static function get_preset( $preset ) {
287		return json_decode( file_get_contents( JETPACK__PLUGIN_DIR .self::get_blocks_directory() . $preset . '.json' ) );
288		}
289
290		/**
291		* Filters the results of `apply_filter( 'jetpack_set_available_blocks', array() )`
292		* using the merged contents of `blocks-manifest.json` ( $preset_blocks )
293		* and self::$jetpack_blocks ( $internal_blocks )
294		*
295		* @param $blocks The default list.
296		*
297		* @return array A list of blocks: eg [ 'publicize', 'markdown' ]
298		*/
299		public static function jetpack_set_available_blocks( $blocks ) {
300		$preset_blocks_manifest = self::preset_exists( 'index' ) ? self::get_preset( 'index' ) : (object) array( 'blocks' => $blocks );
301		// manifest shouldn't remove default blocks...
302
303		$preset_blocks = isset( $preset_blocks_manifest->production ) ? (array) $preset_blocks_manifest->production : array() ;
304		$preset_blocks = array_unique( array_merge( $preset_blocks, $blocks ) );
305
306		if ( Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ) {
307		$beta_blocks = isset( $preset_blocks_manifest->beta ) ? (array) $preset_blocks_manifest->beta : array();
308		return array_unique( array_merge( $preset_blocks, $beta_blocks ) );
309		}
310
311		return $preset_blocks;
312		}
313
314		/**
315		* @deprecated
316		* @return array A list of block-availability information, eg: [ "publicize" => ["available" => true ], "markdown" => [ "available" => false, "unavailable_reason" => 'missing_module' ] ]
317		*/
318		public static function get_block_availability() {
319		return self::get_availability();
320		}
321
322		/**
323		* @return array A list of block and plugins and their availablity status
324		*/
325		public static function get_availability() {
326		if ( ! self::should_load() ) {
327		return array();
328		}
329
330		return self::$availability;
331		}
332
333		/**
334		* Check if Gutenberg editor is available
335		*
336		* @since 6.7.0
337		*
338		* @return bool
339		*/
340		public static function is_gutenberg_available() {
341		return function_exists( 'register_block_type' );
342		}
343
344		/**
345		* Check whether conditions indicate Gutenberg blocks should be loaded
346		*
347		* Loading blocks is enabled by default and may be disabled via filter:
348		* add_filter( 'jetpack_gutenberg', '__return_false' );
349		*
350		* @since 6.7.0
351		* @deprecated
352		* @return bool
353		*/
354		public static function should_load_blocks() {
355		return self::should_load();
356		}
357
358		/**
359		* Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
360		*
361		* Loading blocks and plugins is enabled by default and may be disabled via filter:
362		* add_filter( 'jetpack_gutenberg', '__return_false' );
363		*
364		* @since 6.9.0
365		*
366		* @return bool
367		*/
368		public static function should_load() {
369		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
370		return false;
371		}
372
373		/**
374		* Filter to disable Gutenberg blocks
375		*
376		* @since 6.5.0
377		*
378		* @param bool true Whether to load Gutenberg blocks
379		*/
380		return (bool) apply_filters( 'jetpack_gutenberg', true );
381		}
382
383		/**
384		* Only enqueue block assets when needed.
385		*
386		* @param string $type slug of the block.
387		* @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
388		*
389		* @return void
390		*/
391		public static function load_assets_as_required( $type, $script_dependencies = array() ) {
392		if ( is_admin() ) {
393		// A block's view assets will not be required in wp-admin.
394		return;
395		}
396
397		$type = sanitize_title_with_dashes( $type );
398		// Enqueue styles.
399		$style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
400	View Code Duplication	if ( self::block_has_asset( $style_relative_path ) ) {
401		$style_version = self::get_asset_version( $style_relative_path );
402		$view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
403		wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
404		}
405
406		// Enqueue script.
407		$script_relative_path = self::get_blocks_directory() . $type . '/view.js';
408	View Code Duplication	if ( self::block_has_asset( $script_relative_path ) ) {
409		$script_version = self::get_asset_version( $script_relative_path );
410		$view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
411		wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
412		}
413
414		wp_localize_script(
415		'jetpack-block-' . $type,
416		'Jetpack_Block_Assets_Base_Url',
417		plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE )
418		);
419		}
420
421		/**
422		* Check if an asset exists for a block.
423		*
424		* @param string $file Path of the file we are looking for.
425		*
426		* @return bool $block_has_asset Does the file exist.
427		*/
428		public static function block_has_asset( $file ) {
429		return file_exists( JETPACK__PLUGIN_DIR . $file );
430		}
431
432		/**
433		* Get the version number to use when loading the file. Allows us to bypass cache when developing.
434		*
435		* @param string $file Path of the file we are looking for.
436		*
437		* @return string $script_version Version number.
438		*/
439		public static function get_asset_version( $file ) {
440		return Jetpack::is_development_version() && self::block_has_asset( $file )
441		? filemtime( JETPACK__PLUGIN_DIR . $file )
442		: JETPACK__VERSION;
443		}
444
445		/**
446		* Load Gutenberg editor assets
447		*
448		* @since 6.7.0
449		*
450		* @return void
451		*/
452		public static function enqueue_block_editor_assets() {
453		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...
454		return;
455		}
456
457		$rtl = is_rtl() ? '.rtl' : '';
458		$beta = Jetpack_Constants::is_true('JETPACK_BETA_BLOCKS' ) ? '-beta' : '';
459		$blocks_dir = self::get_blocks_directory();
460
461		$editor_script = plugins_url( "{$blocks_dir}editor{$beta}.js", JETPACK__PLUGIN_FILE );
462		$editor_style = plugins_url( "{$blocks_dir}editor{$beta}{$rtl}.css", JETPACK__PLUGIN_FILE );
463
464		$version = Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
465		? filemtime( JETPACK__PLUGIN_DIR . $blocks_dir . 'editor.js' )
466		: JETPACK__VERSION;
467
468		wp_enqueue_script(
469		'jetpack-blocks-editor',
470		$editor_script,
471		array(
472		'lodash',
473		'wp-api-fetch',
474		'wp-blocks',
475		'wp-components',
476		'wp-compose',
477		'wp-data',
478		'wp-date',
479		'wp-edit-post',
480		'wp-editor',
481		'wp-element',
482		'wp-hooks',
483		'wp-i18n',
484		'wp-keycodes',
485		'wp-plugins',
486		'wp-rich-text',
487		'wp-token-list',
488		'wp-url',
489		),
490		$version,
491		false
492		);
493
494		wp_localize_script(
495		'jetpack-blocks-editor',
496		'Jetpack_Block_Assets_Base_Url',
497		plugins_url( $blocks_dir . '/', JETPACK__PLUGIN_FILE )
498		);
499
500		wp_localize_script(
501		'jetpack-blocks-editor',
502		'Jetpack_Editor_Initial_State',
503		array(
504		'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...
505		'jetpack' => array( 'is_active' => Jetpack::is_active() ),
506		)
507		);
508
509		Jetpack::setup_wp_i18n_locale_data();
510
511		wp_enqueue_style( 'jetpack-blocks-editor', $editor_style, array(), $version );
512
513		// The social-logos styles are used for Publicize service icons
514		// TODO: Remove when we ship the icons with the Gutenberg blocks build
515		wp_enqueue_style( 'social-logos' );
516		}
517		}
518

Automattic / jetpack

Push — mailchimp/introduce-shortcode ( b80f24...10eaea )

Jetpack_Gutenberg::is_available() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like