EventEspresso\core\services\assets\Registry

Complexity

Total Complexity

76

Size/Duplication

Total Lines	742
Duplicated Lines	4.85 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	getJsDependencies()	0	4	1
A	getCssDependencies()	0	4	1
A	registerManifestFiles()	0	12	2
A	__construct()	0	13	1
A	getI18nRegistry()	0	4	1
A	registerScriptsAndStyles()	0	9	2
B	registerScripts()	0	31	6
A	registerStyles()	0	25	3
A	enqueueData()	0	17	3
A	addData()	0	6	2
B	pushData()	0	26	6
A	addTemplate()	14	22	4
A	getTemplate()	0	6	2
A	getData()	0	6	2
A	verifyDataNotExisting()	0	33	4
A	getAssetUrl()	0	18	2
A	getJsUrl()	0	4	1
A	getCssUrl()	0	4	1
A	getDependenciesForAsset()	0	18	6
A	getDependenciesForAssetType()	0	37	4
B	registerManifestFile()	14	44	7
A	decodeManifestFile()	0	7	2
A	addRegisteredScriptHandlesWithData()	0	4	1
A	removeAlreadyRegisteredDataForScriptHandles()	0	9	3
B	removeAlreadyRegisteredDataForScriptHandle()	8	22	6
A	registerTranslation()	0	4	1
A	debug()	0	7	2

<?php

namespace EventEspresso\core\services\assets;

use EE_Error;
use EventEspresso\core\domain\DomainInterface;
use EventEspresso\core\domain\services\assets\CoreAssetManager;
use EventEspresso\core\domain\values\assets\Asset;
use EventEspresso\core\domain\values\assets\JavascriptAsset;
use EventEspresso\core\domain\values\assets\StylesheetAsset;
use EventEspresso\core\exceptions\ExceptionStackTraceDisplay;
use EventEspresso\core\exceptions\InvalidDataTypeException;
use EventEspresso\core\exceptions\InvalidFilePathException;
use EventEspresso\core\exceptions\InvalidInterfaceException;
use EventEspresso\core\services\loaders\LoaderFactory;
use Exception;
use InvalidArgumentException;

/**
 * Used for registering assets used in EE.
 *
 * @package    EventEspresso
 * @subpackage services\assets
 * @author     Darren Ethier
 * @since      4.9.24.rc.004
 */
class Registry
{

    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';

    /**
     * @var AssetCollection $assets
     */
    protected $assets;

    /**
     * @var I18nRegistry
     */
    private $i18n_registry;

    /**
     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
     *
     * @var array
     */
    protected $jsdata = array();

    /**
     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
     * page source.
     *
     * @var array
     */
    private $script_handles_with_data = array();


    /**
     * Holds the manifest data obtained from registered manifest files.
     * Manifests are maps of asset chunk name to actual built asset file names.
     * Shape of this array is:
     * array(
     *  'some_namespace_slug' => array(
     *      'some_chunk_name' => array(
     *          'js' => 'filename.js'
     *          'css' => 'filename.js'
     *      ),
     *      'url_base' => 'https://baseurl.com/to/assets
     *  )
     * )
     *
     * @var array
     */
    private $manifest_data = array();


    /**
     * Holds any dependency data obtained from registered dependency map json.
     * Dependency map json is generated via the @wordpress/dependency-extraction-webpack-plugin via the webpack config.
     * @see https://github.com/WordPress/gutenberg/tree/master/packages/dependency-extraction-webpack-plugin
     *
     * @var array
     */
    private $dependencies_data = [];


    /**
     * This is a known array of possible wp css handles that correspond to what may be exposed as dependencies in our
     * build process.  Currently the dependency export process in webpack does not consider css imports, so we derive
     * them via the js dependencies (WP uses the same handle for both js and css). This is a list of known handles that
     * are used for both js and css.
     * @var array
     */
    private $wp_css_handle_dependencies = [
        'wp-components',
        'wp-block-editor',
        'wp-block-library',
        'wp-edit-post',
        'wp-edit-widgets',
        'wp-editor',
        'wp-format-library',
        'wp-list-reusable-blocks',
        'wp-nux',
    ];


    /**
     * Registry constructor.
     * Hooking into WP actions for script registry.
     *
     * @param AssetCollection      $assets
     * @param I18nRegistry         $i18n_registry
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
    {
        $this->assets = $assets;
        $this->i18n_registry = $i18n_registry;
        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
    }


    /**
     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
     * translation handling.
     *
     * @return I18nRegistry
     */
    public function getI18nRegistry()
    {
        return $this->i18n_registry;
    }


    /**
     * Callback for the wp_enqueue_scripts actions used to register assets.
     *
     * @since 4.9.62.p
     * @throws Exception
     */
    public function registerScriptsAndStyles()
    {
        try {
            $this->registerScripts($this->assets->getJavascriptAssets());
            $this->registerStyles($this->assets->getStylesheetAssets());
        } catch (Exception $exception) {
            new ExceptionStackTraceDisplay($exception);
        }
    }


    /**
     * Registers JS assets with WP core
     *
     * @since 4.9.62.p
     * @param JavascriptAsset[] $scripts
     * @throws AssetRegistrationException
     * @throws InvalidDataTypeException
     */
    public function registerScripts(array $scripts)
    {
        foreach ($scripts as $script) {
            // skip to next script if this has already been done
            if ($script->isRegistered()) {
                continue;
            }
            do_action(
                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
                $script
            );
            $registered = wp_register_script(
                $script->handle(),
                $script->source(),
                $script->dependencies(),
                $script->version(),
                $script->loadInFooter()
            );
            if (! $registered && $this->debug()) {
                throw new AssetRegistrationException($script->handle());
            }
            $script->setRegistered($registered);
            if ($script->requiresTranslation()) {
                $this->registerTranslation($script->handle());
            }
            do_action(
                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
                $script
            );
        }
    }


    /**
     * Registers CSS assets with WP core
     *
     * @since 4.9.62.p
     * @param StylesheetAsset[] $styles
     * @throws InvalidDataTypeException
     */
    public function registerStyles(array $styles)
    {
        foreach ($styles as $style) {
            // skip to next style if this has already been done
            if ($style->isRegistered()) {
                continue;
            }
            do_action(
                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
                $style
            );
            wp_register_style(
                $style->handle(),
                $style->source(),
                $style->dependencies(),
                $style->version(),
                $style->media()
            );
            $style->setRegistered();
            do_action(
                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
                $style
            );
        }
    }


    /**
     * Call back for the script print in frontend and backend.
     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
     *
     * @since 4.9.31.rc.015
     */
    public function enqueueData()
    {
        $this->removeAlreadyRegisteredDataForScriptHandles();
        wp_add_inline_script(
            'eejs-core',
            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
            'before'
        );
        $scripts = $this->assets->getJavascriptAssetsWithData();
        foreach ($scripts as $script) {
            $this->addRegisteredScriptHandlesWithData($script->handle());
            if ($script->hasInlineDataCallback()) {
                $localize = $script->inlineDataCallback();
                $localize();
            }
        }
    }


    /**
     * Used to add data to eejs.data object.
     * Note:  Overriding existing data is not allowed.
     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
     * If the data you add is something like this:
     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
     * It will be exposed in the page source as:
     *  eejs.data.my_plugin_data.foo == gar
     *
     * @param string       $key   Key used to access your data
     * @param string|array $value Value to attach to key
     * @throws InvalidArgumentException
     */
    public function addData($key, $value)
    {
        if ($this->verifyDataNotExisting($key)) {
            $this->jsdata[ $key ] = $value;
        }
    }


    /**
     * Similar to addData except this allows for users to push values to an existing key where the values on key are
     * elements in an array.
     *
     * When you use this method, the value you include will be merged with the array on $key.
     * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
     * object like this, eejs.data.test = [ my_data,
     * ]
     * If there has already been a scalar value attached to the data object given key (via addData for instance), then
     * this will throw an exception.
     *
     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
     * key potentially overriding the existing data on merge (specifically with associative arrays).
     *
     * @param string       $key   Key to attach data to.
     * @param string|array $value Value being registered.
     * @throws InvalidArgumentException
     */
    public function pushData($key, $value)
    {
        if (isset($this->jsdata[ $key ])
            && ! is_array($this->jsdata[ $key ])
        ) {
            if (! $this->debug()) {
                return;
            }
            throw new InvalidArgumentException(
                sprintf(
                    __(
                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                         push values to this data element when it is an array.',
                        'event_espresso'
                    ),
                    $key,
                    __METHOD__
                )
            );
        }
        if ( ! isset( $this->jsdata[ $key ] ) ) {
            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
        } else {
            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
        }
    }


    /**
     * Used to set content used by javascript for a template.
     * Note: Overrides of existing registered templates are not allowed.
     *
     * @param string $template_reference
     * @param string $template_content
     * @throws InvalidArgumentException
     */
    public function addTemplate($template_reference, $template_content)
    {
        if (! isset($this->jsdata['templates'])) {
            $this->jsdata['templates'] = array();
        }
        //no overrides allowed.
        if (isset($this->jsdata['templates'][ $template_reference ])) {
            if (! $this->debug()) {
                return;
            }
            throw new InvalidArgumentException(
                sprintf(
                    __(
                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
                        'event_espresso'
                    ),
                    $template_reference
                )
            );
        }
        $this->jsdata['templates'][ $template_reference ] = $template_content;
    }


    /**
     * Retrieve the template content already registered for the given reference.
     *
     * @param string $template_reference
     * @return string
     */
    public function getTemplate($template_reference)
    {
        return isset($this->jsdata['templates'][ $template_reference ])
            ? $this->jsdata['templates'][ $template_reference ]
            : '';
    }


    /**
     * Retrieve registered data.
     *
     * @param string $key Name of key to attach data to.
     * @return mixed                If there is no for the given key, then false is returned.
     */
    public function getData($key)
    {
        return isset($this->jsdata[ $key ])
            ? $this->jsdata[ $key ]
            : false;
    }


    /**
     * Verifies whether the given data exists already on the jsdata array.
     * Overriding data is not allowed.
     *
     * @param string $key Index for data.
     * @return bool        If valid then return true.
     * @throws InvalidArgumentException if data already exists.
     */
    protected function verifyDataNotExisting($key)
    {
        if (isset($this->jsdata[ $key ])) {
            if (! $this->debug()) {
                return false;
            }
            if (is_array($this->jsdata[ $key ])) {
                throw new InvalidArgumentException(
                    sprintf(
                        __(
                            'The value for %1$s already exists in the Registry::eejs object.
                            Overrides are not allowed. Since the value of this data is an array, you may want to use the
                            %2$s method to push your value to the array.',
                            'event_espresso'
                        ),
                        $key,
                        'pushData()'
                    )
                );
            }
            throw new InvalidArgumentException(
                sprintf(
                    __(
                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                        allowed.  Consider attaching your value to a different key',
                        'event_espresso'
                    ),
                    $key
                )
            );
        }
        return true;
    }


    /**
     * Get the actual asset path for asset manifests.
     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
     *
     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
     *                           asset file location.
     * @param string $chunk_name
     * @param string $asset_type
     * @return string
     * @since 4.9.59.p
     */
    public function getAssetUrl($namespace, $chunk_name, $asset_type)
    {
        $url = isset(
            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
            $this->manifest_data[ $namespace ]['url_base']
        )
            ? $this->manifest_data[ $namespace ]['url_base']
              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
            : $chunk_name;

        return apply_filters(
            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
            $url,
            $namespace,
            $chunk_name,
            $asset_type
        );
    }



    /**
     * Return the url to a js file for the given namespace and chunk name.
     *
     * @param string $namespace
     * @param string $chunk_name
     * @return string
     */
    public function getJsUrl($namespace, $chunk_name)
    {
        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
    }


    /**
     * Return the url to a css file for the given namespace and chunk name.
     *
     * @param string $namespace
     * @param string $chunk_name
     * @return string
     */
    public function getCssUrl($namespace, $chunk_name)
    {
        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
    }


    /**
     * Return the dependencies for a given asset $chunk_name
     *
     * @param string $namespace
     * @param string $chunk_name
     * @param string $asset_type
     * @return array
     * @since 4.9.82.p
     */
    private function getDependenciesForAsset($namespace, $chunk_name, $asset_type)
    {
        $asset_index = $chunk_name . '.' . $asset_type;
        if (! isset( $this->dependencies_data[ $namespace ][ $asset_index ])) {
            $path = isset($this->manifest_data[ $namespace ]['path'])
                ? $this->manifest_data[ $namespace ]['path']
                : '';
            $dependencies_index = $chunk_name . '.' . Asset::TYPE_JSON;
            $file_path = isset($this->manifest_data[ $namespace ][ $dependencies_index ])
                ? $path . $this->manifest_data[ $namespace ][ $dependencies_index ]
                :
                '';
            $this->dependencies_data[ $namespace ][ $asset_index ] = $file_path !== '' && file_exists($file_path)
                ? $this->getDependenciesForAssetType($namespace, $asset_type, $file_path, $chunk_name)
                : [];
        }
        return $this->dependencies_data[ $namespace ][ $asset_index ];
    }


    /**
     * Return dependencies according to asset type.
     *
     * For css assets, this filters the auto generated dependencies by css type.
     *
     * @param string $namespace
     * @param string $asset_type
     * @param string $file_path
     * @param string $chunk_name
     * @return array
     * @since 4.9.82.p
     */
    private function getDependenciesForAssetType($namespace, $asset_type, $file_path, $chunk_name)
    {
        $asset_dependencies = json_decode(file_get_contents($file_path), true);
        if ($asset_type === Asset::TYPE_JS) {
            return $chunk_name === 'eejs-core' ? $asset_dependencies : array_merge(
                $asset_dependencies,
                [ CoreAssetManager::JS_HANDLE_JS_CORE ]
            );
        }
        // for css we need to make sure there is actually a css file related to this chunk.
        if (isset($this->manifest_data[ $namespace ])) {
            // array of css chunk files for ee.
            $css_chunks = array_map(
                function ($value) {
                    return str_replace('.css', '', $value);
                },
                array_filter(
                    array_keys($this->manifest_data[ $namespace ]),
                    function ($value) {
                        return strpos($value, '.css') !== false;
                    }
                )
            );
            // add known wp chunks with css
            $css_chunks = array_merge( $css_chunks, $this->wp_css_handle_dependencies);
            // flip for easier search
            $css_chunks = array_flip($css_chunks);
            // now let's filter the dependencies for the incoming chunk to actual chunks that have styles
            return array_filter(
                $asset_dependencies,
                function ($chunk_name) use ($css_chunks) {
                    return isset($css_chunks[ $chunk_name ]);
                }
            );
        }
        return [];
    }


    /**
     * Get the dependencies array for the given js asset chunk name
     *
     * @param string $namespace
     * @param string $chunk_name
     * @return array
     * @since 4.9.82.p
     */
    public function getJsDependencies($namespace, $chunk_name)
    {
        return $this->getDependenciesForAsset($namespace, $chunk_name, Asset::TYPE_JS);
    }


    /**
     * Get the dependencies array for the given css asset chunk name
     *
     * @param string $namespace
     * @param string $chunk_name
     * @return array
     * @since 4.9.82.p
     */
    public function getCssDependencies($namespace, $chunk_name)
    {
        return $this->getDependenciesForAsset($namespace, $chunk_name, Asset::TYPE_CSS);
    }


    /**
     * @since 4.9.62.p
     * @throws InvalidArgumentException
     * @throws InvalidFilePathException
     */
    public function registerManifestFiles()
    {
        $manifest_files = $this->assets->getManifestFiles();
        foreach ($manifest_files as $manifest_file) {
            $this->registerManifestFile(
                $manifest_file->assetNamespace(),
                $manifest_file->urlBase(),
                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST,
                $manifest_file->filepath()
            );
        }
    }


    /**
     * Used to register a js/css manifest file with the registered_manifest_files property.
     *
     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
     * @param string $url_base      The url base for the manifest file location.
     * @param string $manifest_file The absolute path to the manifest file.
     * @param string $manifest_file_path  The path to the folder containing the manifest file. If not provided will be
     *                                    default to `plugin_root/assets/dist`.
     * @throws InvalidArgumentException
     * @throws InvalidFilePathException
     * @since 4.9.59.p
     */
    public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
    {
        if (isset($this->manifest_data[ $namespace ])) {
            if (! $this->debug()) {
                return;
            }
            throw new InvalidArgumentException(
                sprintf(
                    esc_html__(
                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
                        'event_espresso'
                    ),
                    $namespace
                )
            );
        }
        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
            if (is_admin()) {
                EE_Error::add_error(
                    sprintf(
                        esc_html__(
                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
                            'event_espresso'
                        ),
                        'Event Espresso',
                        $url_base,
                        'plugins_url',
                        'WP_PLUGIN_URL'
                    ),
                    __FILE__,
                    __FUNCTION__,
                    __LINE__
                );
            }
            return;
        }
        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
        }
        if (! isset($this->manifest_data[ $namespace ]['path'])) {
            $this->manifest_data[ $namespace ]['path'] = $manifest_file_path;
        }
    }


    /**
     * Decodes json from the provided manifest file.
     *
     * @since 4.9.59.p
     * @param string $manifest_file Path to manifest file.
     * @return array
     * @throws InvalidFilePathException
     */
    private function decodeManifestFile($manifest_file)
    {
        if (! file_exists($manifest_file)) {
            throw new InvalidFilePathException($manifest_file);
        }
        return json_decode(file_get_contents($manifest_file), true);
    }


    /**
     * This is used to set registered script handles that have data.
     *
     * @param string $script_handle
     */
    private function addRegisteredScriptHandlesWithData($script_handle)
    {
        $this->script_handles_with_data[ $script_handle ] = $script_handle;
    }


    /**i
     * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
     * Dependency stored in WP_Scripts if its set.
     */
    private function removeAlreadyRegisteredDataForScriptHandles()
    {
        if (empty($this->script_handles_with_data)) {
            return;
        }
        foreach ($this->script_handles_with_data as $script_handle) {
            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
        }
    }


    /**
     * Removes any data dependency registered in WP_Scripts if its set.
     *
     * @param string $script_handle
     */
    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
    {
        if (isset($this->script_handles_with_data[ $script_handle ])) {
            global $wp_scripts;
            $unset_handle = false;
            if ($wp_scripts->get_data($script_handle, 'data')) {
                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
                $unset_handle = true;
            }
            //deal with inline_scripts
            if ($wp_scripts->get_data($script_handle, 'before')) {
                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
                $unset_handle = true;
            }
            if ($wp_scripts->get_data($script_handle, 'after')) {
                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
            }
            if ($unset_handle) {
                unset($this->script_handles_with_data[ $script_handle ]);
            }
        }
    }


    /**
     * register translations for a registered script
     *
     * @param string $handle
     */
    public function registerTranslation($handle)
    {
        $this->i18n_registry->registerScriptI18n($handle);
    }


    /**
     * @since 4.9.63.p
     * @return bool
     */
    private function debug()
    {
        return apply_filters(
            'FHEE__EventEspresso_core_services_assets_Registry__debug',
            defined('EE_DEBUG') && EE_DEBUG
        );
    }
}