290 lines
11 KiB
PHP
290 lines
11 KiB
PHP
<?php
|
|
namespace Automattic\WooCommerce\Blocks;
|
|
|
|
use Automattic\WooCommerce\Blocks\Package;
|
|
use Automattic\WooCommerce\Blocks\Assets\Api as AssetApi;
|
|
use Automattic\WooCommerce\Blocks\Assets\AssetDataRegistry as AssetDataRegistry;
|
|
|
|
/**
|
|
* AssetsController class.
|
|
*
|
|
* @since 5.0.0
|
|
* @internal
|
|
*/
|
|
final class AssetsController {
|
|
|
|
/**
|
|
* Asset API interface for various asset registration.
|
|
*
|
|
* @var AssetApi
|
|
*/
|
|
private $api;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param AssetApi $asset_api Asset API interface for various asset registration.
|
|
*/
|
|
public function __construct( AssetApi $asset_api ) {
|
|
$this->api = $asset_api;
|
|
$this->init();
|
|
}
|
|
|
|
/**
|
|
* Initialize class features.
|
|
*/
|
|
protected function init() {
|
|
add_action( 'init', array( $this, 'register_assets' ) );
|
|
add_filter( 'wp_resource_hints', array( $this, 'add_resource_hints' ), 10, 2 );
|
|
add_action( 'body_class', array( $this, 'add_theme_body_class' ), 1 );
|
|
add_action( 'admin_body_class', array( $this, 'add_theme_body_class' ), 1 );
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'update_block_style_dependencies' ), 20 );
|
|
add_action( 'wp_enqueue_scripts', array( $this, 'update_block_settings_dependencies' ), 100 );
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'update_block_settings_dependencies' ), 100 );
|
|
}
|
|
|
|
/**
|
|
* Register block scripts & styles.
|
|
*/
|
|
public function register_assets() {
|
|
$this->register_style( 'wc-blocks-vendors-style', plugins_url( $this->api->get_block_asset_build_path( 'wc-blocks-vendors-style', 'css' ), __DIR__ ) );
|
|
$this->register_style( 'wc-blocks-editor-style', plugins_url( $this->api->get_block_asset_build_path( 'wc-blocks-editor-style', 'css' ), __DIR__ ), [ 'wp-edit-blocks' ], 'all', true );
|
|
$this->register_style( 'wc-blocks-style', plugins_url( $this->api->get_block_asset_build_path( 'wc-blocks-style', 'css' ), __DIR__ ), [ 'wc-blocks-vendors-style' ], 'all', true );
|
|
|
|
$this->api->register_script( 'wc-blocks-middleware', 'build/wc-blocks-middleware.js', [], false );
|
|
$this->api->register_script( 'wc-blocks-data-store', 'build/wc-blocks-data.js', [ 'wc-blocks-middleware' ] );
|
|
$this->api->register_script( 'wc-blocks-vendors', $this->api->get_block_asset_build_path( 'wc-blocks-vendors' ), [], false );
|
|
$this->api->register_script( 'wc-blocks-registry', 'build/wc-blocks-registry.js', [], false );
|
|
$this->api->register_script( 'wc-blocks', $this->api->get_block_asset_build_path( 'wc-blocks' ), [ 'wc-blocks-vendors' ], false );
|
|
$this->api->register_script( 'wc-blocks-shared-context', 'build/wc-blocks-shared-context.js', [] );
|
|
$this->api->register_script( 'wc-blocks-shared-hocs', 'build/wc-blocks-shared-hocs.js', [], false );
|
|
|
|
// The price package is shared externally so has no blocks prefix.
|
|
$this->api->register_script( 'wc-price-format', 'build/price-format.js', [], false );
|
|
|
|
if ( Package::feature()->is_feature_plugin_build() ) {
|
|
$this->api->register_script( 'wc-blocks-checkout', 'build/blocks-checkout.js', [] );
|
|
}
|
|
|
|
wp_add_inline_script(
|
|
'wc-blocks-middleware',
|
|
"
|
|
var wcBlocksMiddlewareConfig = {
|
|
storeApiNonce: '" . esc_js( wp_create_nonce( 'wc_store_api' ) ) . "',
|
|
wcStoreApiNonceTimestamp: '" . esc_js( time() ) . "'
|
|
};
|
|
",
|
|
'before'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Defines resource hints to help speed up the loading of some critical blocks.
|
|
*
|
|
* These will not impact page loading times negatively because they are loaded once the current page is idle.
|
|
*
|
|
* @param array $urls URLs to print for resource hints. Each URL is an array of resource attributes, or a URL string.
|
|
* @param string $relation_type The relation type the URLs are printed. Possible values: preconnect, dns-prefetch, prefetch, prerender.
|
|
* @return array URLs to print for resource hints.
|
|
*/
|
|
public function add_resource_hints( $urls, $relation_type ) {
|
|
if ( ! Package::feature()->is_feature_plugin_build() || ! in_array( $relation_type, [ 'prefetch', 'prerender' ], true ) ) {
|
|
return $urls;
|
|
}
|
|
|
|
// We only need to prefetch when the cart has contents.
|
|
$cart = wc()->cart;
|
|
|
|
if ( ! $cart || ! $cart instanceof \WC_Cart || 0 === $cart->get_cart_contents_count() ) {
|
|
return $urls;
|
|
}
|
|
|
|
$resources = [];
|
|
$is_block_cart = has_block( 'woocommerce/cart' );
|
|
$is_block_checkout = has_block( 'woocommerce/checkout' );
|
|
|
|
if ( 'prefetch' === $relation_type ) {
|
|
if ( ! $is_block_cart ) {
|
|
$resources = array_merge( $resources, $this->get_block_asset_resource_hints( 'cart-frontend' ) );
|
|
}
|
|
|
|
if ( ! $is_block_checkout ) {
|
|
$resources = array_merge( $resources, $this->get_block_asset_resource_hints( 'checkout-frontend' ) );
|
|
}
|
|
|
|
$urls = array_merge(
|
|
$urls,
|
|
array_map(
|
|
function( $src ) {
|
|
return array(
|
|
'href' => $src,
|
|
'as' => 'script',
|
|
);
|
|
},
|
|
array_unique( array_filter( $resources ) )
|
|
)
|
|
);
|
|
}
|
|
|
|
if ( 'prerender' === $relation_type && $is_block_cart ) {
|
|
$checkout_page_id = wc_get_page_id( 'checkout' );
|
|
$checkout_page_url = $checkout_page_id ? get_permalink( $checkout_page_id ) : '';
|
|
if ( $checkout_page_url ) {
|
|
$urls[] = $checkout_page_url;
|
|
}
|
|
}
|
|
|
|
return $urls;
|
|
}
|
|
|
|
/**
|
|
* Get resource hint for a block by name.
|
|
*
|
|
* @param string $filename Block filename.
|
|
* @return array
|
|
*/
|
|
private function get_block_asset_resource_hints( $filename = '' ) {
|
|
if ( ! $filename ) {
|
|
return [];
|
|
}
|
|
$script_data = $this->api->get_script_data(
|
|
$this->api->get_block_asset_build_path( $filename )
|
|
);
|
|
return array_merge( [ add_query_arg( 'ver', $script_data['version'], $script_data['src'] ) ], $this->get_script_dependency_src_array( $script_data['dependencies'] ) );
|
|
}
|
|
|
|
/**
|
|
* Get the src of all script dependencies (handles).
|
|
*
|
|
* @param array $dependencies Array of dependency handles.
|
|
* @return string[] Array of src strings.
|
|
*/
|
|
private function get_script_dependency_src_array( array $dependencies ) {
|
|
$wp_scripts = wp_scripts();
|
|
return array_reduce(
|
|
$dependencies,
|
|
function( $src, $handle ) use ( $wp_scripts ) {
|
|
if ( isset( $wp_scripts->registered[ $handle ] ) ) {
|
|
$src[] = add_query_arg( 'ver', $wp_scripts->registered[ $handle ]->ver, $wp_scripts->registered[ $handle ]->src );
|
|
$src = array_merge( $src, $this->get_script_dependency_src_array( $wp_scripts->registered[ $handle ]->deps ) );
|
|
}
|
|
return $src;
|
|
},
|
|
[]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add body classes to the frontend and within admin.
|
|
*
|
|
* @param string|array $classes Array or string of CSS classnames.
|
|
* @return string|array Modified classnames.
|
|
*/
|
|
public function add_theme_body_class( $classes ) {
|
|
$class = 'theme-' . get_template();
|
|
|
|
if ( is_array( $classes ) ) {
|
|
$classes[] = $class;
|
|
} else {
|
|
$classes .= ' ' . $class . ' ';
|
|
}
|
|
|
|
return $classes;
|
|
}
|
|
|
|
/**
|
|
* Get the file modified time as a cache buster if we're in dev mode.
|
|
*
|
|
* @param string $file Local path to the file.
|
|
* @return string The cache buster value to use for the given file.
|
|
*/
|
|
protected function get_file_version( $file ) {
|
|
if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG && file_exists( \Automattic\WooCommerce\Blocks\Package::get_path() . $file ) ) {
|
|
return filemtime( \Automattic\WooCommerce\Blocks\Package::get_path() . $file );
|
|
}
|
|
return \Automattic\WooCommerce\Blocks\Package::get_version();
|
|
}
|
|
|
|
/**
|
|
* Registers a style according to `wp_register_style`.
|
|
*
|
|
* @param string $handle Name of the stylesheet. Should be unique.
|
|
* @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
|
|
* @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
|
|
* @param string $media Optional. The media for which this stylesheet has been defined. Default 'all'. Accepts media types like
|
|
* 'all', 'print' and 'screen', or media queries like '(orientation: portrait)' and '(max-width: 640px)'.
|
|
* @param boolean $rtl Optional. Whether or not to register RTL styles.
|
|
*/
|
|
protected function register_style( $handle, $src, $deps = [], $media = 'all', $rtl = false ) {
|
|
$filename = str_replace( plugins_url( '/', __DIR__ ), '', $src );
|
|
$ver = self::get_file_version( $filename );
|
|
|
|
wp_register_style( $handle, $src, $deps, $ver, $media );
|
|
|
|
if ( $rtl ) {
|
|
wp_style_add_data( $handle, 'rtl', 'replace' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update block style dependencies after they have been registered.
|
|
*/
|
|
public function update_block_style_dependencies() {
|
|
$wp_styles = wp_styles();
|
|
$style = $wp_styles->query( 'wc-blocks-style', 'registered' );
|
|
|
|
if ( ! $style ) {
|
|
return;
|
|
}
|
|
|
|
// In WC < 5.5, `woocommerce-general` is not registered in block editor
|
|
// screens, so we don't add it as a dependency if it's not registered.
|
|
// In WC >= 5.5, `woocommerce-general` is registered on `admin_enqueue_scripts`,
|
|
// so we need to check if it's registered here instead of on `init`.
|
|
if (
|
|
wp_style_is( 'woocommerce-general', 'registered' ) &&
|
|
! in_array( 'woocommerce-general', $style->deps, true )
|
|
) {
|
|
$style->deps[] = 'woocommerce-general';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fix scripts with wc-settings dependency.
|
|
*
|
|
* The wc-settings script only works correctly when enqueued in the footer. This is to give blocks etc time to
|
|
* register their settings data before it's printed.
|
|
*
|
|
* This code will look at registered scripts, and if they have a wc-settings dependency, force them to print in the
|
|
* footer instead of the header.
|
|
*
|
|
* This only supports packages known to require wc-settings!
|
|
*
|
|
* @see https://github.com/woocommerce/woocommerce-gutenberg-products-block/issues/5052
|
|
*/
|
|
public function update_block_settings_dependencies() {
|
|
$wp_scripts = wp_scripts();
|
|
$known_packages = [ 'wc-settings', 'wc-blocks-checkout', 'wc-price-format' ];
|
|
|
|
foreach ( $wp_scripts->registered as $handle => $script ) {
|
|
// scripts that are loaded in the footer has extra->group = 1.
|
|
if ( array_intersect( $known_packages, $script->deps ) && ! isset( $script->extra['group'] ) ) {
|
|
// Append the script to footer.
|
|
$wp_scripts->add_data( $handle, 'group', 1 );
|
|
// Show a warning.
|
|
$error_handle = 'wc-settings-dep-in-header';
|
|
$used_deps = implode( ', ', array_intersect( $known_packages, $script->deps ) );
|
|
$error_message = "Scripts that have a dependency on [$used_deps] must be loaded in the footer, {$handle} was registered to load in the header, but has been switched to load in the footer instead. See https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/5059";
|
|
// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter,WordPress.WP.EnqueuedResourceParameters.MissingVersion
|
|
wp_register_script( $error_handle, '' );
|
|
wp_enqueue_script( $error_handle );
|
|
wp_add_inline_script(
|
|
$error_handle,
|
|
sprintf( 'console.warn( "%s" );', $error_message )
|
|
);
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|