Skip to content

Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.

5.4 KB
Raw Blame
using Grand.Domain.Seo;

namespace Grand.Web.Common.Page;

/// <summary>
///     Page head builder
/// </summary>
public class PageHeadBuilder : IPageHeadBuilder
{
    #region Ctor

    /// <summary>
    ///     Constuctor
    /// </summary>
    /// <param name="seoSettings">SEO settings</param>
    public PageHeadBuilder(SeoSettings seoSettings)
    {
        _title = [];
        _metaDescription = [];
        _metaKeyword = [];
        _canonicalUrl = [];
        _headCustom = [];
        _pageCssClass = [];
        _seoSettings = seoSettings;
        ConfigureHeadParts();
    }

    #endregion

    #region Fields

    private readonly List<string> _title;
    private readonly List<string> _metaDescription;
    private readonly List<string> _metaKeyword;
    private readonly List<string> _canonicalUrl;
    private readonly List<string> _headCustom;
    private readonly List<string> _pageCssClass;

    private readonly SeoSettings _seoSettings;

    #endregion

    #region Methods

    private void ConfigureHeadParts()
    {
        if (!string.IsNullOrEmpty(_seoSettings.CustomHeadTags))
        {
            AppendHeadCustomParts(_seoSettings.CustomHeadTags);
        }
    }

    public virtual void AddTitleParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _title.Add(part);
    }

    public virtual void AppendTitleParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _title.Insert(0, part);
    }

    public virtual string GenerateTitle(bool addDefaultTitle)
    {
        string result;
        var titleParts = string.Join(_seoSettings.PageTitleSeparator, _title.AsEnumerable().Reverse().ToList());
        if (!string.IsNullOrEmpty(titleParts))
        {
            if (addDefaultTitle)
                result = _seoSettings.PageTitleSeoAdjustment
                    ? string.Join(_seoSettings.PageTitleSeparator, _seoSettings.DefaultTitle, titleParts)
                    : string.Join(_seoSettings.PageTitleSeparator, titleParts, _seoSettings.DefaultTitle);
            else
                result = titleParts;
        }
        else
        {
            result = _seoSettings.DefaultTitle;
        }

        return result;
    }

    public virtual void AddMetaDescriptionParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _metaDescription.Add(part);
    }

    public virtual void AppendMetaDescriptionParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _metaDescription.Insert(0, part);
    }

    public virtual string GenerateMetaDescription()
    {
        var description = string.Join(", ", _metaDescription.AsEnumerable().Reverse().ToList());
        var result = !string.IsNullOrEmpty(description) ? description : _seoSettings.DefaultMetaDescription;
        return result;
    }

    public virtual void AddMetaKeywordParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _metaKeyword.Add(part);
    }

    public virtual void AppendMetaKeywordParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _metaKeyword.Insert(0, part);
    }

    public virtual string GenerateMetaKeywords()
    {
        var keyword = string.Join(", ", _metaKeyword.AsEnumerable().Reverse().ToList());
        var result = !string.IsNullOrEmpty(keyword) ? keyword : _seoSettings.DefaultMetaKeywords;
        return result;
    }

    public virtual void AddCanonicalUrlParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _canonicalUrl.Add(part);
    }

    public virtual void AppendCanonicalUrlParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _canonicalUrl.Insert(0, part);
    }

    public virtual string GenerateCanonicalUrls()
    {
        var result = new StringBuilder();
        foreach (var canonicalUrl in _canonicalUrl)
        {
            result.Append($"<link rel=\"canonical\" href=\"{canonicalUrl}\" />");
            result.Append(Environment.NewLine);
        }

        return result.ToString();
    }

    public virtual void AddHeadCustomParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _headCustom.Add(part);
    }

    public virtual void AppendHeadCustomParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _headCustom.Insert(0, part);
    }

    public virtual string GenerateHeadCustom()
    {
        var distinctParts = _headCustom.Distinct().ToList();
        if (!distinctParts.Any())
            return "";

        var result = new StringBuilder();
        foreach (var path in distinctParts)
        {
            result.Append(path);
            result.Append(Environment.NewLine);
        }

        return result.ToString();
    }

    public virtual void AddPageCssClassParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _pageCssClass.Add(part);
    }

    public virtual void AppendPageCssClassParts(string part)
    {
        if (string.IsNullOrEmpty(part))
            return;

        _pageCssClass.Insert(0, part);
    }

    public virtual string GeneratePageCssClasses()
    {
        var result = string.Join(" ", _pageCssClass.AsEnumerable().Reverse().ToArray());
        return result;
    }

    public virtual string EditPageUrl { get; set; }

    #endregion
}