PluginProbe ʕ •ᴥ•ʔ
Jetpack – WP Security, Backup, Speed, & Growth / 14.2.2
Jetpack – WP Security, Backup, Speed, & Growth v14.2.2
12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 14.4.2 14.5.1 14.6.1 14.7.1 14.8.1 14.9.2 15.0.3 15.1.2 15.2.1 15.3.2 15.4.1 15.5.1 15.6.1 15.7.2 15.8.1 15.9.2 16.0.2 16.1.3 16.2-a.5 16.2-a.3 16.1.2 16.2-a.1 16.1.1 16.1 16.1-beta 16.1-beta.2 16.1-beta.3 16.1-a.5 16.1-a.3 16.0.1 16.1-a.1 16.0 16.0-beta 16.0-a.7 16.0-a.5 15.9.1 16.0-a.3 16.0-a.1 15.9 15.9-beta 15.9-a.7 15.9-a.5 15.9-a.3 15.9-a.1 15.8 15.8-beta 15.8-a.7 15.8-a.5 5.2.5 5.3.4 5.4.4 5.5.5 5.6.5 5.7.5 5.8.4 5.9.4 6.0.4 6.1 6.1.1 6.1.2 6.1.3 6.1.4 6.1.5 6.2 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.3 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 6.3.7 6.4 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.5 6.5.1 6.5.2 6.5.3 6.5.4 6.6 6.6.1 6.6.2 6.6.3 6.6.4 6.6.5 6.7 6.7.1 6.7.2 6.7.3 6.7.4 6.8 6.8.1 6.8.2 6.8.3 6.8.4 6.8.5 6.9 6.9.1 6.9.2 6.9.3 6.9.4 7.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.1 7.1.1 7.1.2 7.1.3 7.1.4 7.1.5 7.2 7.2.1 7.2.1.1 7.2.2 7.2.3 7.2.4 7.2.5 7.3 7.3.0.1 7.3.1 7.3.1.1 7.3.2 7.3.3 7.3.4 7.3.5 7.4 7.4.1 7.4.2 7.4.3 7.4.4 7.4.5 7.5 7.5.0.1 7.5.1 7.5.2 7.5.3 7.5.4 7.5.5 7.5.6 7.5.7 7.6 7.6.1 7.6.2 7.6.3 7.6.4 7.7 7.7.1 7.7.2 7.7.3 7.7.4 7.7.5 7.7.6 7.8 7.8.1 7.8.2 7.8.3 7.8.4 7.9 7.9.1 7.9.2 7.9.3 7.9.4 8.0 8.0.1 8.0.2 8.0.3 8.1 8.1.1 8.1.2 8.1.3 8.1.4 8.2 8.2.0.1 8.2.1 8.2.2 8.2.3 8.2.4 8.2.5 8.2.6 8.3 8.3.1 8.3.2 8.3.3 8.4 8.4.1 8.4.2 8.4.3 8.4.4 8.4.5 8.5 8.5.1 8.5.2 8.5.3 8.6 8.6.1 8.6.2 8.6.3 8.6.4 8.7 8.7.0.1 8.7.1 8.7.2 8.7.3 8.7.4 8.8 8.8.1 8.8.2 8.8.3 8.8.4 8.8.5 8.9 8.9.1 8.9.2 8.9.3 8.9.4 9.0 9.0.1 9.0.2 9.0.3 9.0.4 9.0.5 9.1 9.1.1 9.1.2 9.1.3 9.2 9.2.1 9.2.2 9.2.3 9.2.4 9.3 9.3.1 9.3.2 9.3.3 9.3.4 9.3.5 9.4 9.4.1 9.4.2 9.4.3 9.4.4 9.5 9.5.1 9.5.2 9.5.3 9.5.4 9.5.5 9.6 9.6.1 9.6.2 9.6.3 9.6.4 9.7 9.7.1 9.7.2 15.7-beta.2 9.7.3 15.7.1 9.8 15.8-a.1 9.8.1 15.8-a.3 9.8.2 2.0.9 9.8.3 2.1.7 9.9 2.2.10 9.9.1 2.3.10 9.9.2 2.4.7 9.9.3 2.5.5 2.6.6 2.7.5 2.8.5 2.9.6 3.0.6 3.1.5 3.2.5 3.3.6 3.4.6 3.5.6 3.6.4 3.7.5 3.8.5 3.9.10 4.0.7 4.1.4 4.2.5 4.3.5 4.4.5 4.5.3 4.6.3 4.7.4 4.8.5 4.9.3 5.0.3 5.1.4 trunk 10.0 10.0.1 10.0.2 10.1 10.1.1 10.1.2 10.2 10.2.1 10.2.2 10.2.3 10.3 10.3.1 10.3.2 10.4 10.4.1 10.4.2 10.5 10.5.1 10.5.2 10.5.3 10.6 10.6.1 10.6.2 10.7 10.7.1 10.7.2 10.8 10.8.1 10.8.2 10.9 10.9.1 10.9.2 10.9.3 11.0 11.0.1 11.0.2 11.1 11.1.1 11.1.2 11.1.3 11.1.4 11.2 11.2.1 11.2.2 11.3 11.3.1 11.3.2 11.3.3 11.3.4 11.4 11.4.1 11.4.2 11.5 11.5.1 11.5.2 11.5.3 11.6 11.6.1 11.6.2 11.7 11.7.1 11.7.2 11.7.3 11.8 11.8.3 11.8.4 11.8.5 11.8.6 11.9 11.9.1 11.9.2 11.9.3 12.0 12.0.1 12.0.2 12.1 12.1.1 12.1.2 12.2 12.2.1 12.2.2 12.3 12.3.1 12.4 12.4.1 12.5 12.5.1 12.6 12.6.1 12.6.2 12.6.3 12.7 12.7.1 12.7.2 12.8 12.8.1 12.8.2 12.9 12.9.1 12.9.2 12.9.3 12.9.4 13.0 13.0.1 13.1 13.1.1 13.1.2 13.1.3 13.1.4 13.2 13.2.1 13.2.2 13.2.3 13.3 13.3.1 13.3.2 13.4 13.4.1 13.4.2 13.4.3 13.4.4 13.5 13.5.1 13.6 13.6.1 13.7 13.7.1 13.8 13.8.1 13.8.2 13.9 13.9.1 14.0 14.1 14.2 14.2.1 14.3 14.4 14.4.1 14.5 14.6 14.7 14.8 14.9 14.9.1 15.0 15.0.1 15.0.2 15.1 15.1.1 15.2 15.3 15.3.1 15.4 15.5 15.6 15.7 15.7-a.1 15.7-a.3 15.7-a.5 15.7-a.7 15.7-beta
jetpack / class.jetpack-gutenberg.php
jetpack Last commit date
3rd-party 1 year ago _inc 1 year ago css 1 year ago extensions 1 year ago images 1 year ago jetpack_vendor 1 day ago json-endpoints 1 year ago modules 1 year ago sal 1 year ago src 1 year ago vendor 1 year ago views 2 years ago CHANGELOG.md 1 year ago LICENSE.txt 5 years ago SECURITY.md 2 years ago class-jetpack-connection-status.php 2 years ago class-jetpack-gallery-settings.php 3 years ago class-jetpack-pre-connection-jitms.php 2 years ago class-jetpack-stats-dashboard-widget.php 2 years ago class-jetpack-xmlrpc-methods.php 1 year ago class.frame-nonce-preview.php 4 years ago class.jetpack-admin.php 1 year ago class.jetpack-affiliate.php 2 years ago class.jetpack-autoupdate.php 2 years ago class.jetpack-bbpress-json-api.compat.php 2 years ago class.jetpack-cli.php 1 year ago class.jetpack-client-server.php 2 years ago class.jetpack-gutenberg.php 1 year ago class.jetpack-heartbeat.php 2 years ago class.jetpack-modules-list-table.php 2 years ago class.jetpack-network-sites-list-table.php 2 years ago class.jetpack-network.php 1 year ago class.jetpack-plan.php 3 years ago class.jetpack-post-images.php 2 years ago class.jetpack-twitter-cards.php 2 years ago class.jetpack-user-agent.php 2 years ago class.jetpack.php 1 year ago class.json-api-endpoints.php 1 year ago class.json-api.php 2 years ago class.photon.php 3 years ago composer.json 1 year ago enhanced-open-graph.php 3 years ago functions.compat.php 2 years ago functions.cookies.php 2 years ago functions.global.php 1 year ago functions.is-mobile.php 2 years ago functions.opengraph.php 1 year ago functions.photon.php 2 years ago global.d.ts 2 years ago jetpack.php 1 day ago json-api-config.php 3 years ago json-endpoints.php 2 years ago load-jetpack.php 2 years ago locales.php 4 years ago readme.txt 1 day ago uninstall.php 1 year ago wpml-config.xml 4 years ago
class.jetpack-gutenberg.php
1407 lines
1 <?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2 /**
3 * Handles server-side registration and use of all blocks and plugins available in Jetpack for the block editor, aka Gutenberg.
4 * Works in tandem with client-side block registration via `index.json`
5 *
6 * @package automattic/jetpack
7 */
8
9 use Automattic\Jetpack\Assets;
10 use Automattic\Jetpack\Blocks;
11 use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
12 use Automattic\Jetpack\Connection\Manager as Connection_Manager;
13 use Automattic\Jetpack\Constants;
14 use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
15 use Automattic\Jetpack\Modules;
16 use Automattic\Jetpack\My_Jetpack\Initializer as My_Jetpack_Initializer;
17 use Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Dismissed_Notices;
18 use Automattic\Jetpack\Status;
19 use Automattic\Jetpack\Status\Host;
20
21 // phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move the functions and such to some other file.
22
23 /**
24 * General Gutenberg editor specific functionality
25 */
26 class Jetpack_Gutenberg {
27
28 /**
29 * Only these extensions can be registered. Used to control availability of beta blocks.
30 *
31 * @var array|null Extensions allowed list or `null` if not initialized yet.
32 * @see static::get_extensions()
33 */
34 private static $extensions = null;
35
36 /**
37 * Keeps track of the reasons why a given extension is unavailable.
38 *
39 * @var array Extensions availability information
40 */
41 private static $availability = array();
42
43 /**
44 * A cached array of the fully processed availability data. Keeps track of
45 * reasons why an extension is unavailable or missing.
46 *
47 * @var array Extensions availability information.
48 */
49 private static $cached_availability = null;
50
51 /**
52 * Site-specific features available.
53 * Their calculation can be expensive and slow, so we're caching it for the request.
54 *
55 * @var array Site-specific features
56 */
57 private static $site_specific_features = array();
58
59 /**
60 * List of deprecated blocks.
61 *
62 * @var array List of deprecated blocks.
63 */
64 private static $deprecated_blocks = array(
65 'jetpack/revue',
66 );
67
68 /**
69 * Check to see if a minimum version of Gutenberg is available. Because a Gutenberg version is not available in
70 * php if the Gutenberg plugin is not installed, if we know which minimum WP release has the required version we can
71 * optionally fall back to that.
72 *
73 * @param array $version_requirements An array containing the required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
74 * @param string $slug The slug of the block or plugin that has the gutenberg version requirement.
75 *
76 * @since 8.3.0
77 *
78 * @return boolean True if the version of gutenberg required by the block or plugin is available.
79 */
80 public static function is_gutenberg_version_available( $version_requirements, $slug ) {
81 global $wp_version;
82
83 // Bail if we don't at least have the gutenberg version requirement, the WP version is optional.
84 if ( empty( $version_requirements['gutenberg'] ) ) {
85 return false;
86 }
87
88 // If running a local dev build of gutenberg plugin GUTENBERG_DEVELOPMENT_MODE is set so assume correct version.
89 if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
90 return true;
91 }
92
93 $version_available = false;
94
95 // If running a production build of the gutenberg plugin then GUTENBERG_VERSION is set, otherwise if WP version
96 // with required version of Gutenberg is known check that.
97 if ( defined( 'GUTENBERG_VERSION' ) ) {
98 $version_available = version_compare( GUTENBERG_VERSION, $version_requirements['gutenberg'], '>=' );
99 } elseif ( ! empty( $version_requirements['wp'] ) ) {
100 $version_available = version_compare( $wp_version, $version_requirements['wp'], '>=' );
101 }
102
103 if ( ! $version_available ) {
104 self::set_extension_unavailable(
105 $slug,
106 'incorrect_gutenberg_version',
107 array(
108 'required_feature' => $slug,
109 'required_version' => $version_requirements,
110 'current_version' => array(
111 'wp' => $wp_version,
112 'gutenberg' => defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : null,
113 ),
114 )
115 );
116 }
117
118 return $version_available;
119 }
120
121 /**
122 * Prepend the 'jetpack/' prefix to a block name
123 *
124 * @param string $block_name The block name.
125 *
126 * @return string The prefixed block name.
127 */
128 private static function prepend_block_prefix( $block_name ) {
129 return 'jetpack/' . $block_name;
130 }
131
132 /**
133 * Remove the 'jetpack/' or jetpack-' prefix from an extension name
134 *
135 * @param string $extension_name The extension name.
136 *
137 * @return string The unprefixed extension name.
138 */
139 public static function remove_extension_prefix( $extension_name ) {
140 if ( str_starts_with( $extension_name, 'jetpack/' ) || str_starts_with( $extension_name, 'jetpack-' ) ) {
141 return substr( $extension_name, strlen( 'jetpack/' ) );
142 }
143 return $extension_name;
144 }
145
146 /**
147 * Whether two arrays share at least one item
148 *
149 * @param array $a An array.
150 * @param array $b Another array.
151 *
152 * @return boolean True if $a and $b share at least one item
153 */
154 protected static function share_items( $a, $b ) {
155 return array_intersect( $a, $b ) !== array();
156 }
157
158 /**
159 * Set a (non-block) extension as available
160 *
161 * @param string $slug Slug of the extension.
162 */
163 public static function set_extension_available( $slug ) {
164 self::$availability[ self::remove_extension_prefix( $slug ) ] = true;
165 }
166
167 /**
168 * Set the reason why an extension (block or plugin) is unavailable
169 *
170 * @param string $slug Slug of the extension.
171 * @param string $reason A string representation of why the extension is unavailable.
172 * @param array $details A free-form array containing more information on why the extension is unavailable.
173 */
174 public static function set_extension_unavailable( $slug, $reason, $details = array() ) {
175 if (
176 // Extensions that require a plan may be eligible for upgrades.
177 'missing_plan' === $reason
178 && (
179 /**
180 * Filter 'jetpack_block_editor_enable_upgrade_nudge' with `true` to enable or `false`
181 * to disable paid feature upgrade nudges in the block editor.
182 *
183 * When this is changed to default to `true`, you should also update `modules/memberships/class-jetpack-memberships.php`
184 * See https://github.com/Automattic/jetpack/pull/13394#pullrequestreview-293063378
185 *
186 * @since 7.7.0
187 *
188 * @param boolean
189 */
190 ! apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false )
191 /** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
192 || ! apply_filters( 'jetpack_show_promotions', true )
193 )
194 ) {
195 // The block editor may apply an upgrade nudge if `missing_plan` is the reason.
196 // Add a descriptive suffix to disable behavior but provide informative reason.
197 $reason .= '__nudge_disabled';
198 }
199
200 self::$availability[ self::remove_extension_prefix( $slug ) ] = array(
201 'reason' => $reason,
202 'details' => $details,
203 );
204 }
205
206 /**
207 * Used to initialize the class, no longer in use.
208 *
209 * @return void
210 * @deprecated 12.2 No longer needed.
211 */
212 public static function init() {
213 _deprecated_function( __METHOD__, '12.2' );
214 }
215
216 /**
217 * Resets the class to its original state
218 *
219 * Used in unit tests
220 *
221 * @return void
222 */
223 public static function reset() {
224 self::$extensions = null;
225 self::$availability = array();
226 self::$cached_availability = null;
227 }
228
229 /**
230 * Return the Gutenberg extensions (blocks and plugins) directory
231 *
232 * @return string The Gutenberg extensions directory
233 */
234 public static function get_blocks_directory() {
235 /**
236 * Filter to select Gutenberg blocks directory
237 *
238 * @since 6.9.0
239 *
240 * @param string default: '_inc/blocks/'
241 */
242 return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
243 }
244
245 /**
246 * Checks for a given .json file in the blocks folder.
247 *
248 * @param string $preset The name of the .json file to look for.
249 *
250 * @return bool True if the file is found.
251 */
252 public static function preset_exists( $preset ) {
253 return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
254 }
255
256 /**
257 * Decodes JSON loaded from a preset file in the blocks folder
258 *
259 * @param string $preset The name of the .json file to load.
260 *
261 * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
262 */
263 public static function get_preset( $preset ) {
264 return json_decode(
265 // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
266 file_get_contents( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' )
267 );
268 }
269
270 /**
271 * Returns a list of Jetpack Gutenberg extensions (blocks and plugins), based on index.json
272 *
273 * @return array A list of blocks: eg [ 'publicize', 'markdown' ]
274 */
275 public static function get_jetpack_gutenberg_extensions_allowed_list() {
276 $preset_extensions_manifest = self::preset_exists( 'index' )
277 ? self::get_preset( 'index' )
278 : (object) array();
279 $blocks_variation = self::blocks_variation();
280
281 return self::get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation );
282 }
283
284 /**
285 * Returns a diff from a combined list of allowed extensions and extensions determined to be excluded
286 *
287 * @param array $allowed_extensions An array of allowed extensions.
288 *
289 * @return array A list of blocks: eg array( 'publicize', 'markdown' )
290 */
291 public static function get_available_extensions( $allowed_extensions = null ) {
292 $exclusions = get_option( 'jetpack_excluded_extensions', array() );
293 $allowed_extensions = $allowed_extensions === null ? self::get_jetpack_gutenberg_extensions_allowed_list() : $allowed_extensions;
294
295 return array_diff( $allowed_extensions, $exclusions );
296 }
297
298 /**
299 * Return true if the extension has been registered and there's nothing in the availablilty array.
300 *
301 * @param string $extension The name of the extension.
302 *
303 * @return bool whether the extension has been registered and there's nothing in the availablilty array.
304 */
305 public static function is_registered_and_no_entry_in_availability( $extension ) {
306 return self::is_registered( 'jetpack/' . $extension ) && ! isset( self::$availability[ $extension ] );
307 }
308
309 /**
310 * Return true if the extension has a true entry in the availablilty array.
311 *
312 * @param string $extension The name of the extension.
313 *
314 * @return bool whether the extension has a true entry in the availablilty array.
315 */
316 public static function is_available( $extension ) {
317 return isset( self::$availability[ $extension ] ) && true === self::$availability[ $extension ];
318 }
319
320 /**
321 * Get the availability of each block / plugin, or return the cached availability
322 * if it has already been calculated. Avoids re-registering extensions when not
323 * necessary.
324 *
325 * @return array A list of block and plugins and their availability status.
326 */
327 public static function get_cached_availability() {
328 if ( null === self::$cached_availability ) {
329 self::$cached_availability = self::get_availability();
330 }
331 return self::$cached_availability;
332 }
333
334 /**
335 * Get availability of each block / plugin.
336 *
337 * @return array A list of block and plugins and their availablity status
338 */
339 public static function get_availability() {
340 /**
341 * Fires before Gutenberg extensions availability is computed.
342 *
343 * In the function call you supply, use `Blocks::jetpack_register_block()` to set a block as available.
344 * Alternatively, use `Jetpack_Gutenberg::set_extension_available()` (for a non-block plugin), and
345 * `Jetpack_Gutenberg::set_extension_unavailable()` (if the block or plugin should not be registered
346 * but marked as unavailable).
347 *
348 * @since 7.0.0
349 */
350 do_action( 'jetpack_register_gutenberg_extensions' );
351
352 $available_extensions = array();
353
354 foreach ( static::get_extensions() as $extension ) {
355 $is_available = self::is_registered_and_no_entry_in_availability( $extension ) || self::is_available( $extension );
356 $available_extensions[ $extension ] = array(
357 'available' => $is_available,
358 );
359
360 if ( ! $is_available ) {
361 $reason = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['reason'] : 'missing_module';
362 $details = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['details'] : array();
363 $available_extensions[ $extension ]['unavailable_reason'] = $reason;
364 $available_extensions[ $extension ]['details'] = $details;
365 }
366 }
367
368 return $available_extensions;
369 }
370
371 /**
372 * Return the list of extensions that are available.
373 *
374 * @since 11.9
375 *
376 * @return array A list of block and plugins and their availability status.
377 */
378 public static function get_extensions() {
379 if ( ! static::should_load() ) {
380 return array();
381 }
382
383 if ( null === self::$extensions ) {
384 /**
385 * Filter the list of block editor extensions that are available through Jetpack.
386 *
387 * @since 7.0.0
388 *
389 * @param array
390 */
391 self::$extensions = apply_filters( 'jetpack_set_available_extensions', self::get_available_extensions() );
392 }
393
394 return self::$extensions;
395 }
396
397 /**
398 * Check if an extension/block is already registered
399 *
400 * @since 7.2
401 *
402 * @param string $slug Name of extension/block to check.
403 *
404 * @return bool
405 */
406 public static function is_registered( $slug ) {
407 return WP_Block_Type_Registry::get_instance()->is_registered( $slug );
408 }
409
410 /**
411 * Check if Gutenberg editor is available
412 *
413 * @since 6.7.0
414 *
415 * @return bool
416 */
417 public static function is_gutenberg_available() {
418 return true;
419 }
420
421 /**
422 * Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
423 *
424 * Loading blocks and plugins is enabled by default and may be disabled via filter:
425 * add_filter( 'jetpack_gutenberg', '__return_false' );
426 *
427 * @since 6.9.0
428 *
429 * @return bool
430 */
431 public static function should_load() {
432 if ( ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
433 return false;
434 }
435
436 $return = true;
437
438 if ( ! ( new Modules() )->is_active( 'blocks' ) ) {
439 $return = false;
440 }
441
442 /**
443 * Filter to enable Gutenberg blocks.
444 *
445 * Defaults to true if (connected or in offline mode) and the Blocks module is active.
446 *
447 * @since 6.5.0
448 * @since 13.9 Filter is able to activate or deactivate Gutenberg blocks.
449 *
450 * @param bool true Whether to load Gutenberg blocks
451 */
452 return (bool) apply_filters( 'jetpack_gutenberg', $return );
453 }
454
455 /**
456 * Queue a script to set `Jetpack_Block_Assets_Base_Url`.
457 *
458 * In certain cases Webpack needs to know a base to load additional assets from.
459 * Normally it can determine that itself, but when JS concatenation is involved that tends to confuse it.
460 * We work around that by explicitly outputting a variable with the correct URL.
461 * We set that as its own "script" so we can reliably only output it once.
462 */
463 private static function register_blocks_assets_base_url() {
464 if ( ! wp_script_is( 'jetpack-blocks-assets-base-url', 'registered' ) ) {
465 // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- No actual script, so no version needed.
466 wp_register_script( 'jetpack-blocks-assets-base-url', false, array(), null, array( 'in_footer' => false ) );
467 $json_encode_flags = JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP;
468 if ( get_option( 'blog_charset' ) === 'UTF-8' ) {
469 $json_encode_flags |= JSON_UNESCAPED_UNICODE;
470 }
471 wp_add_inline_script(
472 'jetpack-blocks-assets-base-url',
473 'var Jetpack_Block_Assets_Base_Url=' . wp_json_encode( plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE ), $json_encode_flags ) . ';',
474 'before'
475 );
476 }
477 }
478
479 /**
480 * Only enqueue block assets when needed.
481 *
482 * @param string $type Slug of the block or absolute path to the block source code directory.
483 * @param array $script_dependencies Script dependencies. Will be merged with automatically
484 * detected script dependencies from the webpack build.
485 *
486 * @return void
487 */
488 public static function load_assets_as_required( $type, $script_dependencies = array() ) {
489 if ( is_admin() ) {
490 // A block's view assets will not be required in wp-admin.
491 return;
492 }
493
494 // Retrieve the feature from block.json if a path is passed.
495 if ( path_is_absolute( $type ) ) {
496 $metadata = Blocks::get_block_metadata_from_file( Blocks::get_path_to_block_metadata( $type ) );
497 $feature = Blocks::get_block_feature_from_metadata( $metadata );
498
499 if ( ! empty( $feature ) ) {
500 $type = $feature;
501 }
502 }
503
504 $type = sanitize_title_with_dashes( $type );
505 self::load_styles_as_required( $type );
506 self::load_scripts_as_required( $type, $script_dependencies );
507 }
508
509 /**
510 * Only enqueue block sytles when needed.
511 *
512 * @param string $type Slug of the block.
513 *
514 * @since 7.2.0
515 *
516 * @return void
517 */
518 public static function load_styles_as_required( $type ) {
519 if ( is_admin() ) {
520 // A block's view assets will not be required in wp-admin.
521 return;
522 }
523
524 // Enqueue styles.
525 $style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
526 if ( self::block_has_asset( $style_relative_path ) ) {
527 $style_version = self::get_asset_version( $style_relative_path );
528 $view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
529 $view_style = add_query_arg( 'minify', 'false', $view_style );
530
531 // If this is a customizer preview, render the style directly to the preview after autosave.
532 // phpcs:ignore WordPress.Security.NonceVerification.Recommended
533 if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
534 // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
535 echo '<link rel="stylesheet" id="jetpack-block-' . esc_attr( $type ) . '" href="' . esc_attr( $view_style ) . '&amp;ver=' . esc_attr( $style_version ) . '" media="all">';
536 } else {
537 wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
538 wp_style_add_data( 'jetpack-block-' . $type, 'path', JETPACK__PLUGIN_DIR . $style_relative_path );
539 }
540 }
541 }
542
543 /**
544 * Only enqueue block scripts when needed.
545 *
546 * @param string $type Slug of the block.
547 * @param array $script_dependencies Script dependencies. Will be merged with automatically
548 * detected script dependencies from the webpack build.
549 *
550 * @since 7.2.0
551 *
552 * @return void
553 */
554 public static function load_scripts_as_required( $type, $script_dependencies = array() ) {
555 if ( is_admin() ) {
556 // A block's view assets will not be required in wp-admin.
557 return;
558 }
559
560 self::register_blocks_assets_base_url();
561
562 // Enqueue script.
563 $script_relative_path = self::get_blocks_directory() . $type . '/view.js';
564 $script_deps_path = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $type . '/view.asset.php';
565 $script_dependencies[] = 'jetpack-blocks-assets-base-url';
566 if ( file_exists( $script_deps_path ) ) {
567 $asset_manifest = include $script_deps_path;
568 $script_dependencies = array_unique( array_merge( $script_dependencies, $asset_manifest['dependencies'] ) );
569 }
570
571 if ( ! Blocks::is_amp_request() && self::block_has_asset( $script_relative_path ) ) {
572 $script_version = self::get_asset_version( $script_relative_path );
573 $view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
574 $view_script = add_query_arg( 'minify', 'false', $view_script );
575
576 // Enqueue dependencies.
577 wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
578
579 // If this is a customizer preview, enqueue the dependencies and render the script directly to the preview after autosave.
580 // phpcs:ignore WordPress.Security.NonceVerification.Recommended
581 if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
582 // The Map block is dependent on wp-element, and it doesn't appear to to be possible to load
583 // this dynamically into the customizer iframe currently.
584 if ( 'map' === $type ) {
585 echo '<div>' . esc_html_e( 'No map preview available. Publish and refresh to see this widget.', 'jetpack' ) . '</div>';
586 echo '<script>';
587 echo 'Array.from(document.getElementsByClassName(\'wp-block-jetpack-map\')).forEach(function(element){element.style.display = \'none\';})';
588 echo '</script>';
589 } else {
590 echo '<script id="jetpack-block-' . esc_attr( $type ) . '" src="' . esc_attr( $view_script ) . '&amp;ver=' . esc_attr( $script_version ) . '"></script>';
591 }
592 }
593 }
594 }
595
596 /**
597 * Check if an asset exists for a block.
598 *
599 * @param string $file Path of the file we are looking for.
600 *
601 * @return bool $block_has_asset Does the file exist.
602 */
603 public static function block_has_asset( $file ) {
604 return file_exists( JETPACK__PLUGIN_DIR . $file );
605 }
606
607 /**
608 * Get the version number to use when loading the file. Allows us to bypass cache when developing.
609 *
610 * @param string $file Path of the file we are looking for.
611 *
612 * @return string $script_version Version number.
613 */
614 public static function get_asset_version( $file ) {
615 return Jetpack::is_development_version() && self::block_has_asset( $file )
616 ? filemtime( JETPACK__PLUGIN_DIR . $file )
617 : JETPACK__VERSION;
618 }
619
620 /**
621 * Load Gutenberg editor assets
622 *
623 * @since 6.7.0
624 *
625 * @return void
626 */
627 public static function enqueue_block_editor_assets() {
628 if ( ! self::should_load() ) {
629 return;
630 }
631
632 /**
633 * This can be called multiple times per page load in the admin, during the `enqueue_block_assets` action.
634 * These assets are necessary for the admin for editing but are not necessary for each pattern preview.
635 * Therefore we dequeue them, so they don't load for each pattern preview iframe.
636 */
637 if ( ! wp_should_load_block_editor_scripts_and_styles() ) {
638 wp_dequeue_script( 'jp-tracks' );
639 wp_dequeue_script( 'jetpack-blocks-editor' );
640
641 return;
642 }
643
644 $status = new Status();
645
646 // Required for Analytics. See _inc/lib/admin-pages/class.jetpack-admin-page.php.
647 if ( ! $status->is_offline_mode() && Jetpack::is_connection_ready() ) {
648 wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
649 }
650
651 $blocks_dir = self::get_blocks_directory();
652 $blocks_variation = self::blocks_variation();
653
654 if ( 'production' !== $blocks_variation ) {
655 $blocks_env = '-' . esc_attr( $blocks_variation );
656 } else {
657 $blocks_env = '';
658 }
659
660 self::register_blocks_assets_base_url();
661
662 Assets::register_script(
663 'jetpack-blocks-editor',
664 "{$blocks_dir}editor{$blocks_env}.js",
665 JETPACK__PLUGIN_FILE,
666 array(
667 'textdomain' => 'jetpack',
668 'dependencies' => array( 'jetpack-blocks-assets-base-url' ),
669 )
670 );
671
672 // Hack around #20357 (specifically, that the editor bundle depends on
673 // wp-edit-post but wp-edit-post's styles break the Widget Editor and
674 // Site Editor) until a real fix gets unblocked.
675 // @todo Remove this once #20357 is properly fixed.
676 $wp_styles_fix = wp_styles()->query( 'jetpack-blocks-editor', 'registered' );
677 if ( empty( $wp_styles_fix ) ) {
678 wp_die( 'Your installation of Jetpack is incomplete. Please run "jetpack build plugins/jetpack" in your dev env.' );
679 }
680 wp_styles()->query( 'jetpack-blocks-editor', 'registered' )->deps = array();
681
682 Assets::enqueue_script( 'jetpack-blocks-editor' );
683
684 if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
685 $user = wp_get_current_user();
686 $user_data = array(
687 'email' => $user->user_email,
688 'userid' => $user->ID,
689 'username' => $user->user_login,
690 );
691 $blog_id = get_current_blog_id();
692 $is_current_user_connected = true;
693 } else {
694 $user_data = Jetpack_Tracks_Client::get_connected_user_tracks_identity();
695 $blog_id = Jetpack_Options::get_option( 'id', 0 );
696 $is_current_user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected();
697 }
698
699 if ( $blocks_variation === 'beta' && $is_current_user_connected ) {
700 wp_enqueue_style( 'recoleta-font', '//s1.wp.com/i/fonts/recoleta/css/400.min.css', array(), Constants::get_constant( 'JETPACK__VERSION' ) );
701 }
702 // AI Assistant
703 $ai_assistant_state = array(
704 'is-enabled' => apply_filters( 'jetpack_ai_enabled', true ),
705 );
706
707 $screen_base = null;
708 if ( function_exists( 'get_current_screen' ) ) {
709 $screen_base = get_current_screen()->base;
710 }
711
712 $modules = array();
713 if ( class_exists( 'Jetpack_Core_API_Module_List_Endpoint' ) ) {
714 $module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
715 $modules = $module_list_endpoint->get_modules();
716 }
717
718 $jetpack_plan = Jetpack_Plan::get();
719 $initial_state = array(
720 'available_blocks' => self::get_availability(),
721 'blocks_variation' => $blocks_variation,
722 'modules' => $modules,
723 'jetpack' => array(
724 'is_active' => Jetpack::is_connection_ready(),
725 'is_current_user_connected' => $is_current_user_connected,
726 /** This filter is documented in class.jetpack-gutenberg.php */
727 'enable_upgrade_nudge' => apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ),
728 'is_private_site' => $status->is_private_site(),
729 'is_coming_soon' => $status->is_coming_soon(),
730 'is_offline_mode' => $status->is_offline_mode(),
731 'is_newsletter_feature_enabled' => class_exists( '\Jetpack_Memberships' ),
732 // this is the equivalent of JP initial state siteData.showMyJetpack (class-jetpack-redux-state-helper)
733 // used to determine if we can link to My Jetpack from the block editor
734 'is_my_jetpack_available' => My_Jetpack_Initializer::should_initialize(),
735 'jetpack_plan' => array(
736 'data' => $jetpack_plan['product_slug'],
737 ),
738 /**
739 * Enable the RePublicize UI in the block editor context.
740 *
741 * @module publicize
742 *
743 * @since 10.3.0
744 * @deprecated 11.5 This is a feature flag that is no longer used.
745 *
746 * @param bool true Enable the RePublicize UI in the block editor context. Defaults to true.
747 */
748 'republicize_enabled' => apply_filters( 'jetpack_block_editor_republicize_feature', true ),
749 ),
750 'siteFragment' => $status->get_site_suffix(),
751 'adminUrl' => esc_url( admin_url() ),
752 'tracksUserData' => $user_data,
753 'wpcomBlogId' => $blog_id,
754 'allowedMimeTypes' => wp_get_mime_types(),
755 'siteLocale' => str_replace( '_', '-', get_locale() ),
756 'ai-assistant' => $ai_assistant_state,
757 'screenBase' => $screen_base,
758 'pluginBasePath' => plugins_url( '', Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ),
759 'next40pxDefaultSize' => self::site_supports_next_default_size(),
760 );
761
762 if ( Jetpack::is_module_active( 'publicize' ) && function_exists( 'publicize_init' ) ) {
763 $publicize = publicize_init();
764 $jetpack_social_settings = new Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Settings();
765 $social_initial_state = $jetpack_social_settings->get_initial_state();
766
767 $initial_state['social'] = array(
768 'sharesData' => $publicize->get_publicize_shares_info( $blog_id ),
769 'hasPaidPlan' => $publicize->has_paid_plan(),
770 'hasPaidFeatures' => $publicize->has_paid_features(),
771 'isEnhancedPublishingEnabled' => $publicize->has_enhanced_publishing_feature(),
772 'isSocialImageGeneratorAvailable' => $social_initial_state['socialImageGeneratorSettings']['available'],
773 'isSocialImageGeneratorEnabled' => $social_initial_state['socialImageGeneratorSettings']['enabled'],
774 'dismissedNotices' => Dismissed_Notices::get_dismissed_notices(),
775 'supportedAdditionalConnections' => $publicize->get_supported_additional_connections(),
776 'jetpackSharingSettingsUrl' => esc_url_raw( admin_url( 'admin.php?page=jetpack#/sharing' ) ),
777 'userConnectionUrl' => esc_url_raw( admin_url( 'admin.php?page=my-jetpack#/connection' ) ),
778 'useAdminUiV1' => $social_initial_state['useAdminUiV1'],
779 );
780
781 // Add connectionData if we are using the new Connection UI.
782 if ( $social_initial_state['useAdminUiV1'] ) {
783 $initial_state['social']['connectionData'] = $social_initial_state['connectionData'];
784
785 $initial_state['social']['connectionRefreshPath'] = $social_initial_state['connectionRefreshPath'];
786 }
787
788 $initial_state['social']['featureFlags'] = $social_initial_state['featureFlags'];
789 }
790
791 wp_localize_script(
792 'jetpack-blocks-editor',
793 'Jetpack_Editor_Initial_State',
794 $initial_state
795 );
796
797 // Adds Connection package initial state.
798 Connection_Initial_State::render_script( 'jetpack-blocks-editor' );
799 }
800
801 /**
802 * Some blocks do not depend on a specific module,
803 * and can consequently be loaded outside of the usual modules.
804 * We will look for such modules in the extensions/ directory.
805 *
806 * @since 7.1.0
807 * @see wp_common_block_scripts_and_styles()
808 */
809 public static function load_independent_blocks() {
810 if ( self::should_load() ) {
811 /**
812 * Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
813 * If available, load them.
814 */
815 $directories = array( 'blocks', 'plugins', 'extended-blocks', 'shared', 'store' );
816
817 foreach ( static::get_extensions() as $extension ) {
818 foreach ( $directories as $dirname ) {
819 $path = JETPACK__PLUGIN_DIR . "extensions/{$dirname}/{$extension}/{$extension}.php";
820
821 if ( file_exists( $path ) ) {
822 include_once $path;
823 continue 2;
824 }
825 }
826 }
827 }
828 }
829
830 /**
831 * Loads PHP components of block editor extensions.
832 *
833 * @since 8.9.0
834 */
835 public static function load_block_editor_extensions() {
836 if ( self::should_load() ) {
837 // Block editor extensions to load.
838 $extensions_to_load = array(
839 'extended-blocks',
840 'plugins',
841 );
842
843 // Collect the extension paths.
844 foreach ( $extensions_to_load as $extension_to_load ) {
845 $extensions_folder = glob( JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/*' );
846
847 // Require each of the extension files, in case it exists.
848 foreach ( $extensions_folder as $extension_folder ) {
849 $name = basename( $extension_folder );
850 $extension_file_path = JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/' . $name . '/' . $name . '.php';
851
852 if ( file_exists( $extension_file_path ) ) {
853 include_once $extension_file_path;
854 }
855 }
856 }
857 }
858 }
859
860 /**
861 * Determine whether a site should use the default set of blocks, or a custom set.
862 * Possible variations are currently beta, experimental, and production.
863 *
864 * @since 8.1.0
865 *
866 * @return string $block_varation production|beta|experimental
867 */
868 public static function blocks_variation() {
869 // Default to production blocks.
870 $block_varation = 'production';
871
872 /*
873 * Prefer to use this JETPACK_BLOCKS_VARIATION constant
874 * or the jetpack_blocks_variation filter
875 * to set the block variation in your code.
876 */
877 $default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
878 if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
879 $block_varation = $default;
880 }
881
882 /**
883 * Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
884 *
885 * @since 6.9.0
886 * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
887 *
888 * @param boolean
889 */
890 $is_beta = apply_filters_deprecated(
891 'jetpack_load_beta_blocks',
892 array( false ),
893 'jetpack-11.8.0',
894 'jetpack_blocks_variation'
895 );
896
897 /*
898 * Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
899 * or the deprecated jetpack_load_beta_blocks filter.
900 * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
901 */
902 if (
903 empty( $default )
904 && (
905 $is_beta
906 || Constants::is_true( 'JETPACK_BETA_BLOCKS' )
907 )
908 ) {
909 $block_varation = 'beta';
910 }
911
912 /**
913 * Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
914 *
915 * @since 6.9.0
916 * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
917 *
918 * @param boolean
919 */
920 $is_experimental = apply_filters_deprecated(
921 'jetpack_load_experimental_blocks',
922 array( false ),
923 'jetpack-11.8.0',
924 'jetpack_blocks_variation'
925 );
926
927 /*
928 * Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
929 * or the deprecated jetpack_load_experimental_blocks filter.
930 * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
931 */
932 if (
933 empty( $default )
934 && (
935 $is_experimental
936 || Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
937 )
938 ) {
939 $block_varation = 'experimental';
940 }
941
942 /**
943 * Allow customizing the variation of blocks in use on a site.
944 * Overwrites any previously set values, whether by constant or filter.
945 *
946 * @since 8.1.0
947 *
948 * @param string $block_variation Can be beta, experimental, and production. Defaults to production.
949 */
950 return apply_filters( 'jetpack_blocks_variation', $block_varation );
951 }
952
953 /**
954 * Get a list of extensions available for the variation you chose.
955 *
956 * @since 8.1.0
957 *
958 * @param object $preset_extensions_manifest List of extensions available in Jetpack.
959 * @param string $blocks_variation Subset of blocks. production|beta|experimental.
960 *
961 * @return array $preset_extensions Array of extensions for that variation
962 */
963 public static function get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation ) {
964 $preset_extensions = isset( $preset_extensions_manifest->{ $blocks_variation } )
965 ? (array) $preset_extensions_manifest->{ $blocks_variation }
966 : array();
967
968 /*
969 * Experimental and Beta blocks need the production blocks as well.
970 */
971 if (
972 'experimental' === $blocks_variation
973 || 'beta' === $blocks_variation
974 ) {
975 $production_extensions = isset( $preset_extensions_manifest->production )
976 ? (array) $preset_extensions_manifest->production
977 : array();
978
979 $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
980 }
981
982 /*
983 * Beta blocks need the experimental blocks as well.
984 *
985 * If you've chosen to see Beta blocks,
986 * we want to make all blocks available to you:
987 * - Production
988 * - Experimental
989 * - Beta
990 */
991 if ( 'beta' === $blocks_variation ) {
992 $production_extensions = isset( $preset_extensions_manifest->experimental )
993 ? (array) $preset_extensions_manifest->experimental
994 : array();
995
996 $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
997 }
998
999 return $preset_extensions;
1000 }
1001
1002 /**
1003 * Validate a URL used in a SSR block.
1004 *
1005 * @since 8.3.0
1006 *
1007 * @param string $url URL saved as an attribute in block.
1008 * @param array $allowed Array of allowed hosts for that block, or regexes to check against.
1009 * @param bool $is_regex Array of regexes matching the URL that could be used in block.
1010 *
1011 * @return bool|string
1012 */
1013 public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
1014 if (
1015 empty( $url )
1016 || ! is_array( $allowed )
1017 || empty( $allowed )
1018 ) {
1019 return false;
1020 }
1021
1022 $url_components = wp_parse_url( $url );
1023
1024 // Bail early if we cannot find a host.
1025 if ( empty( $url_components['host'] ) ) {
1026 return false;
1027 }
1028
1029 // Normalize URL.
1030 $url = sprintf(
1031 '%s://%s%s%s',
1032 isset( $url_components['scheme'] ) ? $url_components['scheme'] : 'https',
1033 $url_components['host'],
1034 isset( $url_components['path'] ) ? $url_components['path'] : '/',
1035 isset( $url_components['query'] ) ? '?' . $url_components['query'] : ''
1036 );
1037
1038 if ( ! empty( $url_components['fragment'] ) ) {
1039 $url = $url . '#' . rawurlencode( $url_components['fragment'] );
1040 }
1041
1042 /*
1043 * If we're using an allowed list of hosts,
1044 * check if the URL belongs to one of the domains allowed for that block.
1045 */
1046 if (
1047 false === $is_regex
1048 && in_array( $url_components['host'], $allowed, true )
1049 ) {
1050 return $url;
1051 }
1052
1053 /*
1054 * If we are using an array of regexes to check against,
1055 * loop through that.
1056 */
1057 if ( true === $is_regex ) {
1058 foreach ( $allowed as $regex ) {
1059 if ( 1 === preg_match( $regex, $url ) ) {
1060 return $url;
1061 }
1062 }
1063 }
1064
1065 return false;
1066 }
1067
1068 /**
1069 * Determines whether a preview of the block with an upgrade nudge should
1070 * be displayed for admins on the site frontend.
1071 *
1072 * @since 8.4.0
1073 *
1074 * @param array $availability_for_block The availability for the block.
1075 *
1076 * @return bool
1077 */
1078 public static function should_show_frontend_preview( $availability_for_block ) {
1079 return (
1080 isset( $availability_for_block['details']['required_plan'] )
1081 && current_user_can( 'manage_options' )
1082 && ! is_feed()
1083 );
1084 }
1085
1086 /**
1087 * Output an UpgradeNudge Component on the frontend of a site.
1088 *
1089 * @since 8.4.0
1090 *
1091 * @param string $plan The plan that users need to purchase to make the block work.
1092 *
1093 * @return string
1094 */
1095 public static function upgrade_nudge( $plan ) {
1096 require_once JETPACK__PLUGIN_DIR . '_inc/lib/components.php';
1097 return Jetpack_Components::render_upgrade_nudge(
1098 array(
1099 'plan' => $plan,
1100 )
1101 );
1102 }
1103
1104 /**
1105 * Output a notice within a block.
1106 *
1107 * @since 8.6.0
1108 *
1109 * @param string $message Notice we want to output.
1110 * @param string $status Status of the notice. Can be one of success, info, warning, error. info by default.
1111 * @param string $classes List of CSS classes.
1112 *
1113 * @return string
1114 */
1115 public static function notice( $message, $status = 'info', $classes = '' ) {
1116 if (
1117 empty( $message )
1118 || ! in_array( $status, array( 'success', 'info', 'warning', 'error' ), true )
1119 ) {
1120 return '';
1121 }
1122
1123 $color = '';
1124 switch ( $status ) {
1125 case 'success':
1126 $color = '#00a32a';
1127 break;
1128 case 'warning':
1129 $color = '#dba617';
1130 break;
1131 case 'error':
1132 $color = '#d63638';
1133 break;
1134 case 'info':
1135 default:
1136 $color = '#72aee6';
1137 break;
1138 }
1139
1140 return sprintf(
1141 '<div class="jetpack-block__notice %1$s %3$s" style="border-left:5px solid %4$s;padding:1em;background-color:#f8f9f9;">%2$s</div>',
1142 esc_attr( $status ),
1143 wp_kses(
1144 $message,
1145 array(
1146 'br' => array(),
1147 'p' => array(),
1148 'a' => array(
1149 'href' => array(),
1150 'target' => array(),
1151 'rel' => array(),
1152 ),
1153 )
1154 ),
1155 esc_attr( $classes ),
1156 sanitize_hex_color( $color )
1157 );
1158 }
1159
1160 /**
1161 * Retrieve site-specific features for Simple sites.
1162 *
1163 * We're caching the data for the lifetime of the request, because it can be slow to calculate,
1164 * and it can be called multiple times per single request.
1165 *
1166 * We intentionally don't use object caching or any other type of persistent caching,
1167 * in order to avoid complex cache invalidation on subscription addition or removal.
1168 *
1169 * @since 10.7
1170 *
1171 * @return array
1172 */
1173 private static function get_site_specific_features() {
1174 $current_blog_id = get_current_blog_id();
1175
1176 if ( isset( self::$site_specific_features[ $current_blog_id ] ) ) {
1177 return self::$site_specific_features[ $current_blog_id ];
1178 }
1179
1180 if ( ! class_exists( 'Store_Product_List' ) ) {
1181 require WP_CONTENT_DIR . '/admin-plugins/wpcom-billing/store-product-list.php';
1182 }
1183
1184 $site_specific_features = Store_Product_List::get_site_specific_features_data( $current_blog_id );
1185 self::$site_specific_features[ $current_blog_id ] = $site_specific_features;
1186
1187 return $site_specific_features;
1188 }
1189
1190 /**
1191 * Set the availability of the block as the editor
1192 * is loaded.
1193 *
1194 * @param string $slug Slug of the block.
1195 */
1196 public static function set_availability_for_plan( $slug ) {
1197 $slug = self::remove_extension_prefix( $slug );
1198
1199 if ( Jetpack_Plan::supports( $slug ) ) {
1200 self::set_extension_available( $slug );
1201 return;
1202 }
1203
1204 // Check what's the minimum plan where the feature is available.
1205 $plan = '';
1206 $features_data = array();
1207 $is_simple_site = defined( 'IS_WPCOM' ) && IS_WPCOM;
1208 $is_atomic_site = ( new Host() )->is_woa_site();
1209
1210 if ( $is_simple_site || $is_atomic_site ) {
1211 // Simple sites.
1212 if ( $is_simple_site ) {
1213 $features_data = self::get_site_specific_features();
1214 } else {
1215 // Atomic sites.
1216 $option = get_option( 'jetpack_active_plan' );
1217 if ( isset( $option['features'] ) ) {
1218 $features_data = $option['features'];
1219 }
1220 }
1221
1222 if ( ! empty( $features_data['available'][ $slug ] ) ) {
1223 $plan = $features_data['available'][ $slug ][0];
1224 }
1225 } else {
1226 // Jetpack sites.
1227 $plan = Jetpack_Plan::get_minimum_plan_for_feature( $slug );
1228 }
1229
1230 self::set_extension_unavailable(
1231 $slug,
1232 'missing_plan',
1233 array(
1234 'required_feature' => $slug,
1235 'required_plan' => $plan,
1236 )
1237 );
1238 }
1239
1240 /**
1241 * Wraps the suplied render_callback in a function to check
1242 * the availability of the block before rendering it.
1243 *
1244 * @param string $slug The block slug, used to check for availability.
1245 * @param callable $render_callback The render_callback that will be called if the block is available.
1246 */
1247 public static function get_render_callback_with_availability_check( $slug, $render_callback ) {
1248 return function ( $prepared_attributes, $block_content, $block ) use ( $render_callback, $slug ) {
1249 $availability = self::get_cached_availability();
1250 $bare_slug = self::remove_extension_prefix( $slug );
1251 if ( isset( $availability[ $bare_slug ] ) && $availability[ $bare_slug ]['available'] ) {
1252 return call_user_func( $render_callback, $prepared_attributes, $block_content );
1253 }
1254
1255 // A preview of the block is rendered for admins on the frontend with an upgrade nudge.
1256 if ( isset( $availability[ $bare_slug ] ) ) {
1257 if ( self::should_show_frontend_preview( $availability[ $bare_slug ] ) ) {
1258 $block_preview = call_user_func( $render_callback, $prepared_attributes, $block_content );
1259
1260 // If the upgrade nudge isn't already being displayed by a parent block, display the nudge.
1261 if ( isset( $block->attributes['shouldDisplayFrontendBanner'] ) && $block->attributes['shouldDisplayFrontendBanner'] ) {
1262 $upgrade_nudge = self::upgrade_nudge( $availability[ $bare_slug ]['details']['required_plan'] );
1263 return $upgrade_nudge . $block_preview;
1264 }
1265
1266 return $block_preview;
1267 }
1268 }
1269
1270 return null;
1271 };
1272 }
1273
1274 /**
1275 * Display a message to site editors and roles above when a block is no longer supported.
1276 * This is only displayed on the frontend.
1277 *
1278 * @since 12.3
1279 *
1280 * @param string $block_content The block content.
1281 * @param array $block The full block, including name and attributes.
1282 *
1283 * @return string
1284 */
1285 public static function display_deprecated_block_message( $block_content, $block ) {
1286 if ( in_array( $block['blockName'], self::$deprecated_blocks, true ) ) {
1287 if ( current_user_can( 'edit_posts' ) ) {
1288 $block_content = self::notice(
1289 __( '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' ),
1290 'warning',
1291 'jetpack-block-deprecated'
1292 );
1293 } else {
1294 $block_content = '';
1295 }
1296 }
1297
1298 return $block_content;
1299 }
1300
1301 /**
1302 * Check whether the environment supports the newer default size of elements, gradually introduced starting with WP 6.4.
1303 *
1304 * @since 14.0
1305 *
1306 * @see https://make.wordpress.org/core/2023/10/16/editor-components-updates-in-wordpress-6-4/#improving-size-consistency-for-ui-components
1307 *
1308 * @to-do: Deprecate this method and the logic around it when Jetpack requires WordPress 6.7.
1309 *
1310 * @return bool
1311 */
1312 public static function site_supports_next_default_size() {
1313 /*
1314 * If running a local dev build of gutenberg,
1315 * let's assume it supports the newest changes included in Gutenberg.
1316 */
1317 if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
1318 return true;
1319 }
1320
1321 // Let's now check if the Gutenberg plugin is installed on the site.
1322 if (
1323 defined( 'GUTENBERG_VERSION' )
1324 && version_compare( GUTENBERG_VERSION, '19.4', '>=' )
1325 ) {
1326 return true;
1327 }
1328
1329 // Finally, let's check for the WordPress version.
1330 global $wp_version;
1331 if ( version_compare( $wp_version, '6.7', '>=' ) ) {
1332 return true;
1333 }
1334
1335 // Final fallback.
1336 return false;
1337 }
1338
1339 /**
1340 * Temporarily bypasses _doing_it_wrong() notices for block metadata collection registration.
1341 *
1342 * WordPress 6.7 introduced block metadata collections (with strict path validation).
1343 * Any sites using symlinks for plugins will fail the validation which causes the metadata
1344 * collection to not be registered. However, the blocks will still fall back to the regular
1345 * registration and no functionality is affected.
1346 * While this validation is being discussed in WordPress Core (#62140),
1347 * this method allows registration to proceed by temporarily disabling
1348 * the relevant notice.
1349 *
1350 * @since 14.2
1351 *
1352 * @param bool $trigger Whether to trigger the error.
1353 * @param string $function The function that was called.
1354 * @param string $message A message explaining what was done incorrectly.
1355 * @param string $version The version of WordPress where the message was added.
1356 * @return bool Whether to trigger the error.
1357 */
1358 public static function bypass_block_metadata_doing_it_wrong( $trigger, $function, $message, $version ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
1359 if ( $function === 'WP_Block_Metadata_Registry::register_collection' ) {
1360 return false;
1361 }
1362 return $trigger;
1363 }
1364
1365 /**
1366 * Register block metadata collection for Jetpack blocks.
1367 * This allows for more efficient block metadata loading by avoiding
1368 * individual block.json file reads at runtime.
1369 *
1370 * Uses wp_register_block_metadata_collection() if available (WordPress 6.7+)
1371 * and if the manifest file exists. The manifest file is auto-generated
1372 * during the build process.
1373 *
1374 * Runs on plugins_loaded to ensure registration happens before individual
1375 * blocks register themselves on init.
1376 *
1377 * @static
1378 * @since 14.1
1379 * @return void
1380 */
1381 public static function register_block_metadata_collection() {
1382 $meta_file_path = JETPACK__PLUGIN_DIR . '_inc/blocks/blocks-manifest.php';
1383 if ( function_exists( 'wp_register_block_metadata_collection' ) && file_exists( $meta_file_path ) ) {
1384 add_filter( 'doing_it_wrong_trigger_error', array( __CLASS__, 'bypass_block_metadata_doing_it_wrong' ), 10, 4 );
1385
1386 // @phan-suppress-next-line PhanUndeclaredFunction -- New in WP 6.7. We're checking if it exists first. @phan-suppress-current-line UnusedPluginSuppression
1387 wp_register_block_metadata_collection(
1388 JETPACK__PLUGIN_DIR . '_inc/blocks/',
1389 $meta_file_path
1390 );
1391
1392 remove_filter( 'doing_it_wrong_trigger_error', array( __CLASS__, 'bypass_block_metadata_doing_it_wrong' ), 10 );
1393 }
1394 }
1395 }
1396
1397 if ( ( new Host() )->is_woa_site() ) {
1398 /**
1399 * Enable upgrade nudge for Atomic sites.
1400 * This feature is false as default,
1401 * so let's enable it through this filter.
1402 *
1403 * More doc: https://github.com/Automattic/jetpack/blob/trunk/projects/plugins/jetpack/extensions/README.md#upgrades-for-blocks
1404 */
1405 add_filter( 'jetpack_block_editor_enable_upgrade_nudge', '__return_true' );
1406 }
1407