AssetManager.php

<?php
/**
 * @link https://craftcms.com/
 * @copyright Copyright (c) Pixel & Tonic, Inc.
 * @license https://craftcms.github.io/license/
 */

namespace craft\web;

use Craft;
use craft\db\Table;
use craft\errors\DbConnectException;
use craft\helpers\App;
use craft\helpers\Db;
use craft\helpers\FileHelper;
use craft\helpers\UrlHelper;
use yii\caching\TagDependency;
use yii\db\Exception as DbException;

/**
 * @inheritdoc
 * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
 * @since 3.0.0
 */
class AssetManager extends \yii\web\AssetManager
{
    /**
     * @var bool Whether asset source paths should be cached for subsequent requests.
     * @see hash()
     * @since 4.5.10
     */
    public bool $cacheSourcePaths = true;

    private const CACHE_TAG = 'assetmanager';

    /**
     * @inheritdoc
     */
    public function publish($path, $options = []): array
    {
        if (App::isEphemeral()) {
            return [$path, $this->getPublishedUrl($path)];
        }

        return parent::publish($path, $options);
    }

    /**
     * Returns the URL of a published file/directory path.
     *
     * @param string $path directory or file path being published
     * @param bool $publish whether the directory or file should be published, if not already
     * @param string|null $filePath A file path, relative to $sourcePath if $sourcePath is a directory, that should be appended to the returned URL.
     * @return string|false the published URL for the file or directory, or false if $publish is false and the file or directory does not exist
     */
    public function getPublishedUrl($path, bool $publish = false, ?string $filePath = null): string|false
    {
        if ($publish === true && !App::isEphemeral()) {
            [, $url] = $this->publish($path);
        } else {
            $url = parent::getPublishedUrl($path);
        }

        if ($filePath !== null) {
            $url .= '/' . $filePath;

            // Should we append a timestamp?
            if ($this->appendTimestamp) {
                $fullPath = FileHelper::normalizePath(Craft::getAlias($path) . DIRECTORY_SEPARATOR . $filePath);
                if (($timestamp = @filemtime($fullPath)) > 0) {
                    $url .= '?v=' . $timestamp;
                }
            }

            $url = $this->_addBuildIdParam($url);
        }

        return $url;
    }

    /**
     * @inheritdoc
     */
    protected function hash($path): string
    {
        if (is_callable($this->hashCallback)) {
            return call_user_func($this->hashCallback, $path);
        }

        $dir = is_file($path) ? dirname($path) : $path;
        $alias = Craft::alias($dir);
        $hash = sprintf('%x', crc32($alias . '|' . FileHelper::lastModifiedTime($path) . '|' . $this->linkAssets));

        if ($this->cacheSourcePaths) {
            // Store the hash for later
            Craft::$app->onAfterRequest(function() use ($hash, $alias) {
                try {
                    Db::upsert(Table::RESOURCEPATHS, [
                        'hash' => $hash,
                        'path' => $alias,
                    ]);
                } catch (DbException|DbConnectException) {
                    // Craft is either not installed or not updated to 3.0.3+ yet,
                    // so cache the source path instead
                    Craft::$app->getCache()->set(
                        $this->getCacheKeyForPathHash($hash),
                        $alias,
                        dependency: new TagDependency(['tags' => [self::CACHE_TAG]]),
                    );
                }
            });
        }

        return $hash;
    }

    /**
     * Get the cache key for a given asset hash
     *
     * @param string $hash
     * @return string
     */
    public function getCacheKeyForPathHash(string $hash): string
    {
        return implode(':', [self::CACHE_TAG, $hash]);
    }

    /**
     * @inheritdoc
     */
    protected function publishDirectory($src, $options): array
    {
        [$dir, $url] = parent::publishDirectory($src, $options);

        // A backslash can cause issues on Windows here.
        $url = str_replace('\\', '/', $url);

        return [$dir, $url];
    }

    /**
     * @inheritdoc
     */
    protected function publishFile($src): array
    {
        [$file, $url] = parent::publishFile($src);

        // A backslash can cause issues on Windows here.
        $url = str_replace('\\', '/', $url);

        if ($this->appendTimestamp && !str_contains($url, '?') && ($timestamp = @filemtime($src)) > 0) {
            $url .= '?v=' . $timestamp;
        }

        return [$file, $this->_addBuildIdParam($url)];
    }

    public function getAssetUrl($bundle, $asset, $appendTimestamp = null): string
    {
        return $this->_addBuildIdParam(
            parent::getAssetUrl($bundle, $asset, $appendTimestamp),
        );
    }

    private function _addBuildIdParam($url): string
    {
        $generalConfig = Craft::$app->getConfig()->getGeneral();
        if ($generalConfig->buildId) {
            return UrlHelper::urlWithParams($url, [
                'buildId' => $generalConfig->buildId,
            ]);
        }
        return $url;
    }
}