nystudio107\twigpack\helpers\Manifest

Complexity

Total Complexity

96

Size/Duplication

Total Lines	753
Duplicated Lines	0 %

Importance

Changes	40
Bugs	0	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
B	getModule()	0	29	10
A	getCriticalCssTags()	0	25	3
A	getCssRelPreloadPolyfill()	0	5	1
A	getJsModuleTags()	0	27	5
A	getCssModuleTags()	0	24	3
A	getSafariNomoduleFix()	0	14	2
A	getCssInlineTags()	0	16	3
A	getCspNonceType()	0	7	2
B	getFileContents()	0	83	10
A	getJsonFile()	0	3	1
A	reportError()	0	10	4
A	getModuleEntry()	0	27	4
B	getFileFromUri()	0	32	9
A	invalidateCaches()	0	5	1
A	jsonFileDecode()	0	9	2
A	combinePaths()	0	24	3
A	includeNonce()	0	18	5
A	getNonce()	0	12	3
A	getFile()	0	3	1
B	getFileFromManifest()	0	46	11
A	getModuleHash()	0	18	3
A	getHttpResponseCode()	0	8	2
B	getManifestFile()	0	40	8

<?php
/**
 * Twigpack plugin for Craft CMS 3.x
 *
 * Twigpack is the conduit between Twig and webpack, with manifest.json &
 * webpack-dev-server HMR support
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\twigpack\helpers;

use Craft;
use craft\errors\DeprecationException;
use craft\helpers\Html;
use craft\helpers\Json as JsonHelper;
use craft\helpers\UrlHelper;
use GuzzleHttp\Client;
use GuzzleHttp\RequestOptions;
use nystudio107\twigpack\models\Settings;
use nystudio107\twigpack\Twigpack;
use Throwable;
use Twig\Error\LoaderError;
use yii\base\Exception;
use yii\caching\ChainedDependency;
use yii\caching\FileDependency;
use yii\caching\TagDependency;
use yii\web\NotFoundHttpException;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Twigpack

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Manifest
{
    // Constants
    // =========================================================================

    public const CACHE_KEY = 'twigpack';
    public const CACHE_TAG = 'twigpack';

    public const DEVMODE_CACHE_DURATION = 1;

    public const CSP_HEADERS = [
        'Content-Security-Policy',
        'X-Content-Security-Policy',
        'X-WebKit-CSP',
    ];

    public const SUPPRESS_ERRORS_FOR_MODULES = [
        'styles.js',
    ];

    // Protected Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var array
     */
    protected static $files;

    /**

Missing short description in doc comment

     * @var bool
     */
    protected static $isHot = false;

    // Public Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $moduleName

Missing parameter comment

     * @param bool $async

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 2 spaces after parameter type; 1 found

     *
     * @return string
     * @throws NotFoundHttpException
     */
    public static function getCssModuleTags(array $config, string $moduleName, bool $async, array $attributes = []): string
    {
        $legacyModule = self::getModule($config, $moduleName, 'legacy', true);
        if ($legacyModule === null) {
            return '';
        }
        $lines = [];
        if ($async) {
            $lines[] = Html::cssFile($legacyModule, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'rel' => 'stylesheet',
                'media' => 'print',
                'onload' => "this.media='all'",
            ], $attributes));

For multi-line function calls, the closing parenthesis should be on a new line.

            $lines[] = Html::cssFile($legacyModule, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'rel' => 'stylesheet',
                'noscript' => true,
            ], $attributes));

For multi-line function calls, the closing parenthesis should be on a new line.

        } else {
            $lines[] = Html::cssFile($legacyModule, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'rel' => 'stylesheet',
            ], $attributes));

For multi-line function calls, the closing parenthesis should be on a new line.

        }

        return implode("\r\n", $lines);
    }

    /**

Missing short description in doc comment

     * @param string $path

Missing parameter comment

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 2 spaces after parameter type; 1 found

     *
     * @return string
     */
    public static function getCssInlineTags(string $path, array $attributes = []): string
    {
        $result = self::getFile($path);
        if ($result) {
            $config = [];
            $nonce = self::getNonce();
            if ($nonce !== null) {
                $config['nonce'] = $nonce;
                self::includeNonce($nonce, 'style-src');
            }
            $result = Html::style($result, array_merge($config, $attributes));

            return $result;
        }

        return '';
    }

    /**

Missing short description in doc comment

     * @param array $config

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param string|null $name

Missing parameter comment

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 7 spaces after parameter type; 1 found

     *
     * @return string
     * @throws LoaderError
     */
    public static function getCriticalCssTags(array $config, ?string $name = null, array $attributes = []): string
    {
        // Resolve the template name
        $template = Craft::$app->getView()->resolveTemplate($name ?? Twigpack::$templateName ?? '');
        if ($template) {
            $name = self::combinePaths(
                pathinfo($template, PATHINFO_DIRNAME),

It seems like pathinfo($template, nystudio107\twigpack\helpers\PATHINFO_DIRNAME) can also be of type array; however, parameter $paths of nystudio107\twigpack\helpers\Manifest::combinePaths() does only seem to accept null|string, maybe add an additional type check?

                pathinfo($template, PATHINFO_FILENAME)
            );
            $dirPrefix = 'templates/';
            if (defined('CRAFT_TEMPLATES_PATH')) {
                $dirPrefix = CRAFT_TEMPLATES_PATH;
            }
            $name = strstr($name, $dirPrefix);
            $name = (string)str_replace($dirPrefix, '', $name);
            $path = self::combinePaths(
                    $config['localFiles']['basePath'],

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.

                    $config['localFiles']['criticalPrefix'],

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.

                    $name

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.

                ) . $config['localFiles']['criticalSuffix'];

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

            return self::getCssInlineTags($path, $attributes);
        }

        return '';
    }

    /**
     * Returns the uglified loadCSS rel=preload Polyfill as per:
     * https://github.com/filamentgroup/loadCSS#how-to-use-loadcss-recommended-example
     *
     * @return string

Tag value for @return tag indented incorrectly; expected 5 spaces but found 1

     * @throws DeprecationException

Tag value for @throws tag indented incorrectly; expected 5 spaces but found 1

     * @deprecated in 1.2.0
     */
    public static function getCssRelPreloadPolyfill(): string
    {
        Craft::$app->getDeprecator()->log('craft.twigpack.includeCssRelPreloadPolyfill()', 'craft.twigpack.includeCssRelPreloadPolyfill() has been deprecated, this function now does nothing. You can safely remove craft.twigpack.includeCssRelPreloadPolyfill() from your templates.');

        return '';
    }

    /**

Missing short description in doc comment

     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $moduleName

Missing parameter comment

     * @param bool $async

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 2 spaces after parameter type; 1 found

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public static function getJsModuleTags(array $config, string $moduleName, bool $async, array $attributes = []): ?string
    {
        $legacyModule = self::getModule($config, $moduleName, 'legacy', true);
        if ($legacyModule === null) {
            return '';
        }
        $modernModule = '';
        if ($async) {
            $modernModule = self::getModule($config, $moduleName, 'modern', true);
            if ($modernModule === null) {
                return '';
            }
        }
        $lines = [];
        if ($async) {
            $lines[] = Html::jsFile($modernModule, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'type' => 'module',
            ], $attributes));

For multi-line function calls, the closing parenthesis should be on a new line.

            $lines[] = Html::jsFile($legacyModule, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'nomodule' => true,
            ], $attributes));

For multi-line function calls, the closing parenthesis should be on a new line.

        } else {
            $lines[] = Html::jsFile($legacyModule, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

            ], $attributes));

For multi-line function calls, the closing parenthesis should be on a new line.

        }

        return implode("\r\n", $lines);
    }

    /**
     * Safari 10.1 supports modules, but does not support the `nomodule`
     * attribute - it will load <script nomodule> anyway. This snippet solve
     * this problem, but only for script tags that load external code, e.g.:
     * <script nomodule src="nomodule.js"></script>
     *
     * Again: this will **not* # prevent inline script, e.g.:
     * <script nomodule>alert('no modules');</script>.
     *
     * This workaround is possible because Safari supports the non-standard
     * 'beforeload' event. This allows us to trap the module and nomodule load.
     *
     * Note also that `nomodule` is supported in later versions of Safari -
     * it's just 10.1 that omits this attribute.
     *
     * c.f.: https://gist.github.com/samthor/64b114e4a4f539915a95b91ffd340acc
     *
     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag
     *
     * @return string
     */
    public static function getSafariNomoduleFix(array $attributes = []): string
    {
        $code = /** @lang JavaScript */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            <<<EOT
!function(){var e=document,t=e.createElement("script");if(!("noModule"in t)&&"onbeforeload"in t){var n=!1;e.addEventListener("beforeload",function(e){if(e.target===t)n=!0;else if(!e.target.hasAttribute("nomodule")||!n)return;e.preventDefault()},!0),t.type="module",t.src=".",e.head.appendChild(t),t.remove()}}();
EOT;
        $config = [];
        $nonce = self::getNonce();
        if ($nonce !== null) {
            $config['nonce'] = $nonce;
            self::includeNonce($nonce, 'script-src');
        }

        return Html::script($code, array_merge($config, $attributes));
    }

    /**
     * Return the URI to a module
     *
     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param bool $soft

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public static function getModule(array $config, string $moduleName, string $type = 'modern', bool $soft = false): ?string
    {
        // Get the module entry
        $module = self::getModuleEntry($config, $moduleName, $type, $soft);
        if ($module !== null) {
            $prefix = self::$isHot
                ? $config['devServer']['publicPath']
                : $config['server']['publicPath'];
            $useAbsoluteUrl = $config['useAbsoluteUrl'];
            // If the module isn't a full URL, prefix it as required
            if ($useAbsoluteUrl && !UrlHelper::isAbsoluteUrl($module)) {
                $module = self::combinePaths($prefix, $module);
            }
            // Resolve any aliases
            $alias = Craft::getAlias($module, false);
            if ($alias) {
                $module = $alias;
            }
            // Make sure it's a full URL, as required
            try {
                if ($useAbsoluteUrl && !UrlHelper::isAbsoluteUrl($module) && !is_file($module)) {
                    $module = UrlHelper::siteUrl($module);
                }
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return $module;
    }

    /**
     * Return the HASH value from to module
     *
     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param bool $soft

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return null|string
     */
    public static function getModuleHash(array $config, string $moduleName, string $type = 'modern', bool $soft = false): ?string
    {
        $moduleHash = '';
        try {
            // Get the module entry
            $module = self::getModuleEntry($config, $moduleName, $type, $soft);
            if ($module !== null) {
                // Extract only the Hash Value
                $modulePath = pathinfo($module);
                $moduleFilename = $modulePath['filename'];
                $moduleHash = substr($moduleFilename, strpos($moduleFilename, ".") + 1);
            }
        } catch (Exception $e) {
            // return empty string if no module is found
            return '';
        }

        return $moduleHash;
    }

    /**
     * Return a module's raw entry from the manifest
     *
     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param bool $soft

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public static function getModuleEntry(
        array  $config,
        string $moduleName,
        string $type = 'modern',
        bool   $soft = false,
    ): ?string {
        $module = null;
        // Get the manifest file
        $manifest = self::getManifestFile($config, $type);
        if ($manifest !== null) {
            // Make sure it exists in the manifest
            if (empty($manifest[$moduleName])) {
                // Don't report errors for any files in SUPPRESS_ERRORS_FOR_MODULES
                if (!in_array($moduleName, self::SUPPRESS_ERRORS_FOR_MODULES)) {
                    self::reportError(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                        'twigpack',
                        'Module does not exist in the manifest: {moduleName}',
                        ['moduleName' => $moduleName]
                    ), $soft);

For multi-line function calls, the closing parenthesis should be on a new line.

                }

                return null;
            }
            $module = $manifest[$moduleName];
        }

        return $module;
    }

    /**
     * Return a JSON-decoded manifest file
     *
     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $type

Missing parameter comment

     *
     * @return null|array
     * @throws NotFoundHttpException
     */
    public static function getManifestFile(array $config, string $type = 'modern'): ?array
    {
        $manifest = null;
        // Determine whether we should use the devServer for HMR or not
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        self::$isHot = ($devMode && $config['useDevServer']);
        // Try to get the manifest
        while ($manifest === null) {
            $manifestPath = self::$isHot
                ? $config['devServer']['manifestPath']
                : $config['server']['manifestPath'];
            // If this is a dev-server, use the defined build type
            $thisType = $type;
            if (self::$isHot) {
                $thisType = $config['devServerBuildType'] === 'combined'
                    ? $thisType
                    : $config['devServerBuildType'];
            }
            // Normalize the path
            $path = self::combinePaths($manifestPath, $config['manifest'][$thisType]);
            $manifest = self::getJsonFile($path);
            // If the manifest isn't found, and it was hot, fall back on non-hot
            if ($manifest === null) {
                // We couldn't find a manifest; throw an error
                self::reportError(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'twigpack',
                    'Manifest file not found at: {manifestPath}',
                    ['manifestPath' => $manifestPath]
                ), true);

For multi-line function calls, the closing parenthesis should be on a new line.

                if (self::$isHot) {
                    // Try again, but not with home module replacement
                    self::$isHot = false;
                } else {
                    // Give up and return null
                    return null;
                }
            }
        }

        return $manifest;
    }

    /**
     * Returns the contents of a file from a URI path
     *
     * @param string $path

Missing parameter comment

     *
     * @return string
     */
    public static function getFile(string $path): string
    {
        return self::getFileFromUri($path, null, true) ?? '';
    }

    /**

Missing short description in doc comment

     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $fileName

Missing parameter comment

     * @param string $type

Missing parameter comment

     *
     * @return string
     */
    public static function getFileFromManifest(array $config, string $fileName, string $type = 'legacy'): string
    {
        $path = null;

The assignment to $path is dead and can be removed.

        try {
            $path = self::getModuleEntry($config, $fileName, $type, true);
        } catch (NotFoundHttpException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        if ($path !== null) {
            // Determine whether we should use the devServer for HMR or not
            $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
            if ($devMode) {
                $devServerPrefix = $config['devServer']['publicPath'];
                // If we're using the devserver, swap in the deverserver path
                if (UrlHelper::isAbsoluteUrl($path) && self::$isHot) {
                    $path = parse_url($path, PHP_URL_PATH);
                }
                $devServerPath = self::combinePaths(
                    $devServerPrefix,
                    $path
                );
                $devServerFile = self::getFileFromUri($devServerPath, null);
                if ($devServerFile) {
                    return $devServerFile;
                }
            }
            // Otherwise, try not-hot files
            $localPrefix = $config['localFiles']['basePath'];
            $localPath = self::combinePaths(
                $localPrefix,
                $path
            );
            $alias = Craft::getAlias($localPath, false);
            if ($alias && is_string($alias)) {
                $localPath = $alias;
            }
            try {
                if (is_file($localPath)) {
                    return self::getFile($localPath);
                }
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return '';
    }

    /**
     * Invalidate all of the manifest caches
     */

Missing @return tag in function comment

    public static function invalidateCaches(): void
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, self::CACHE_TAG);
        Craft::info('All manifest caches cleared', __METHOD__);
    }

    /**
     * Return the contents of a JSON file from a URI path
     *
     * @param string $path

Missing parameter comment

     *
     * @return null|array
     */
    protected static function getJsonFile(string $path): ?array
    {
        return self::getFileFromUri($path, [self::class, 'jsonFileDecode']);
    }

    // Protected Static Methods
    // =========================================================================

    /**
     * Return the contents of a file from a URI path
     *
     * @param string $path

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     * @param callable|null $callback

Missing parameter comment

     * @param bool $pathOnly

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     *
     * @return null|mixed
     */
    protected static function getFileFromUri(string $path, callable $callback = null, bool $pathOnly = false): mixed
    {
        // Resolve any aliases
        $alias = Craft::getAlias($path, false);
        if ($alias && is_string($alias)) {
            $path = $alias;
        }
        // If we only want the file via path, make sure it exists
        try {
            if ($pathOnly && !is_file($path)) {
                Craft::warning(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'twigpack',
                    'File does not exist: {path}',
                    ['path' => $path]
                ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

                return '';
            }
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        // Make sure it's a full URL
        try {
            if (!UrlHelper::isAbsoluteUrl($path) && !is_file($path)) {
                $path = UrlHelper::siteUrl($path);
            }
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return self::getFileContents($path, $callback);
    }

    /**
     * Return the contents of a file from the passed in path
     *
     * @param string $path