Webiant Logo Webiant Logo
  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

NopScriptTagHelper.cs

using System.Text.Encodings.Web;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Html;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Razor.TagHelpers;
using Microsoft.AspNetCore.Mvc.Rendering;
using Microsoft.AspNetCore.Mvc.Routing;
using Microsoft.AspNetCore.Mvc.TagHelpers;
using Microsoft.AspNetCore.Razor.TagHelpers;
using Microsoft.Extensions.Hosting;
using Nop.Core;
using Nop.Core.Configuration;
using Nop.Web.Framework.Extensions;
using Nop.Web.Framework.UI;
using Nop.Web.Framework.WebOptimizer;

namespace Nop.Web.Framework.TagHelpers.Shared;

/// 
/// Script bundling tag helper
/// 
[HtmlTargetElement(SCRIPT_TAG_NAME)]
public partial class NopScriptTagHelper : UrlResolutionTagHelper
{
    #region Constants

    protected const string SCRIPT_TAG_NAME = "script";
    protected const string EXCLUDE_FROM_BUNDLE_ATTRIBUTE_NAME = "asp-exclude-from-bundle";
    protected const string DEBUG_SRC_ATTRIBUTE_NAME = "asp-debug-src";
    protected const string LOCATION_ATTRIBUTE_NAME = "asp-location";
    protected const string SRC_ATTRIBUTE_NAME = "src";

    #endregion

    #region Fields

    protected readonly AppSettings _appSettings;
    protected readonly INopAssetHelper _bundleHelper;
    protected readonly INopHtmlHelper _nopHtmlHelper;
    protected readonly IWebHelper _webHelper;
    protected readonly IWebHostEnvironment _webHostEnvironment;

    #endregion

    #region Ctor

    public NopScriptTagHelper(AppSettings appSettings,
        HtmlEncoder htmlEncoder,
        INopAssetHelper bundleHelper,
        INopHtmlHelper nopHtmlHelper,
        IUrlHelperFactory urlHelperFactory,
        IWebHelper webHelper,
        IWebHostEnvironment webHostEnvironment) : base(urlHelperFactory, htmlEncoder)
    {
        _appSettings = appSettings;
        _bundleHelper = bundleHelper;
        _nopHtmlHelper = nopHtmlHelper;
        _webHelper = webHelper;
        _webHostEnvironment = webHostEnvironment;
    }

    #endregion

    #region Utilities

    protected static async Task BuildInlineScriptTagAsync(TagHelperOutput output)
    {
        //get JavaScript
        var scriptTag = new TagBuilder(SCRIPT_TAG_NAME);

        var childContent = await output.GetChildContentAsync();
        var script = childContent.GetContent();

        if (!string.IsNullOrEmpty(script))
            scriptTag.InnerHtml.SetHtmlContent(new HtmlString(script));

        scriptTag.MergeAttributes(await output.GetAttributeDictionaryAsync(), replaceExisting: false);

        return await scriptTag.RenderHtmlContentAsync() + Environment.NewLine;
    }

    protected void ProcessSrcAttribute(TagHelperContext context, TagHelperOutput output)
    {
        if (!string.IsNullOrEmpty(DebugSrc) && _webHostEnvironment.IsDevelopment())
            Src = DebugSrc;

        // Pass through attribute that is also a well-known HTML attribute.
        if (Src != null)
            output.CopyHtmlAttribute(SRC_ATTRIBUTE_NAME, context);

        // If there's no "src" attribute in output.Attributes this will noop.
        ProcessUrlAttribute(SRC_ATTRIBUTE_NAME, output);

        // Retrieve the TagHelperOutput variation of the "src" attribute in case other TagHelpers in the
        // pipeline have touched the value. If the value is already encoded this ScriptTagHelper may
        // not function properly.
        if (output.Attributes[SRC_ATTRIBUTE_NAME]?.Value is string srcAttribute)
            Src = srcAttribute;
    }

    protected void ProcessAsset(TagHelperOutput output)
    {
        if (string.IsNullOrEmpty(Src))
            return;

        var urlHelper = UrlHelperFactory.GetUrlHelper(ViewContext);
        if (!urlHelper.IsLocalUrl(Src))
        {
            output.Attributes.SetAttribute(SRC_ATTRIBUTE_NAME, Src);
            return;
        }

        //remove the application path from the generated URL if exists
        var pathBase = ViewContext.HttpContext?.Request?.PathBase ?? PathString.Empty;
        PathString.FromUriComponent(Src).StartsWithSegments(pathBase, out var sourceFile);

        var asset = _bundleHelper.GetOrCreateJavaScriptAsset(sourceFile, [sourceFile]);
        output.Attributes.SetAttribute(SRC_ATTRIBUTE_NAME, _bundleHelper.CacheBusting(asset));
    }

    #endregion

    #region Methods

    public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
    {
        ArgumentNullException.ThrowIfNull(context);

        ArgumentNullException.ThrowIfNull(output);

        if (_webHelper.IsAjaxRequest(ViewContext.HttpContext?.Request))
            return;

        output.TagMode = TagMode.StartTagAndEndTag;

        if (!output.Attributes.ContainsName("type")) // we don't touch other types e.g. text/template
            output.Attributes.SetAttribute("type", MimeTypes.TextJavascript);

        var woConfig = _appSettings.Get();

        if (Location == ResourceLocation.Auto)
        {
            // move script to the footer bundle when bundling is enabled
            Location = woConfig.EnableJavaScriptBundling ? ResourceLocation.Footer : ResourceLocation.None;
        }

        if (Location == ResourceLocation.None)
        {
            if (!string.IsNullOrEmpty(Src))
            {
                ProcessSrcAttribute(context, output);
                ProcessAsset(output);
            }

            return;
        }

        if (string.IsNullOrEmpty(Src))
            _nopHtmlHelper.AddInlineScriptParts(Location, await BuildInlineScriptTagAsync(output));
        else
            _nopHtmlHelper.AddScriptParts(Location, Src, DebugSrc, ExcludeFromBundle);

        output.SuppressOutput();
    }

    #endregion

    #region Properties

    /// 
    /// Script path (e.g. full debug version). If empty, then minified version will be used
    /// 
    [HtmlAttributeName(DEBUG_SRC_ATTRIBUTE_NAME)]
    public string DebugSrc { get; set; }

    /// 
    /// Indicates where the script should be rendered
    /// 
    [HtmlAttributeName(LOCATION_ATTRIBUTE_NAME)]
    public ResourceLocation Location { set; get; }

    /// 
    /// A value indicating if a file should be excluded from the bundle
    /// 
    [HtmlAttributeName(EXCLUDE_FROM_BUNDLE_ATTRIBUTE_NAME)]
    public bool ExcludeFromBundle { get; set; }

    /// 
    /// Address of the external script to use
    /// 
    [HtmlAttributeName(SRC_ATTRIBUTE_NAME)]
    public string Src { get; set; }

    #endregion
}