Umbraco-CMS/src/Umbraco.Core/PublishedCache/PublishedCacheBase.cs

using System.Xml.XPath;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Models.PublishedContent;
using Umbraco.Cms.Core.Xml;
using Umbraco.Extensions;

namespace Umbraco.Cms.Core.PublishedCache;

public abstract class PublishedCacheBase : IPublishedCache
{
    private readonly IVariationContextAccessor? _variationContextAccessor;


    [Obsolete("Use ctor with all parameters. This will be removed in V15")]
    public PublishedCacheBase(IVariationContextAccessor variationContextAccessor)
        : this(variationContextAccessor, false)
    {
    }

    [Obsolete("Use ctor with all parameters. This will be removed in V15")]
    protected PublishedCacheBase(bool previewDefault)
        : this(StaticServiceProvider.Instance.GetRequiredService<IVariationContextAccessor>(), previewDefault)
    {
    }

    public PublishedCacheBase(IVariationContextAccessor variationContextAccessor, bool previewDefault)
    {
        _variationContextAccessor = variationContextAccessor;
        PreviewDefault = previewDefault;
    }

    public bool PreviewDefault { get; }

    public abstract IPublishedContent? GetById(bool preview, int contentId);

    public IPublishedContent? GetById(int contentId)
        => GetById(PreviewDefault, contentId);

    public abstract IPublishedContent? GetById(bool preview, Guid contentId);

    public IPublishedContent? GetById(Guid contentId)
        => GetById(PreviewDefault, contentId);

    public abstract IPublishedContent? GetById(bool preview, Udi contentId);

    public IPublishedContent? GetById(Udi contentId)
        => GetById(PreviewDefault, contentId);

    public abstract bool HasById(bool preview, int contentId);

    public bool HasById(int contentId)
        => HasById(PreviewDefault, contentId);

    public abstract IEnumerable<IPublishedContent> GetAtRoot(bool preview, string? culture = null);

    public IEnumerable<IPublishedContent> GetAtRoot(string? culture = null) => GetAtRoot(PreviewDefault, culture);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public abstract IPublishedContent? GetSingleByXPath(bool preview, string xpath, XPathVariable[] vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public IPublishedContent? GetSingleByXPath(string xpath, XPathVariable[] vars) =>
        GetSingleByXPath(PreviewDefault, xpath, vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public abstract IPublishedContent? GetSingleByXPath(bool preview, XPathExpression xpath, XPathVariable[] vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public IPublishedContent? GetSingleByXPath(XPathExpression xpath, XPathVariable[] vars) =>
        GetSingleByXPath(PreviewDefault, xpath, vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public abstract IEnumerable<IPublishedContent> GetByXPath(bool preview, string xpath, XPathVariable[] vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public IEnumerable<IPublishedContent> GetByXPath(string xpath, XPathVariable[] vars) =>
        GetByXPath(PreviewDefault, xpath, vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public abstract IEnumerable<IPublishedContent>
        GetByXPath(bool preview, XPathExpression xpath, XPathVariable[] vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public IEnumerable<IPublishedContent> GetByXPath(XPathExpression xpath, XPathVariable[] vars) =>
        GetByXPath(PreviewDefault, xpath, vars);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public abstract XPathNavigator CreateNavigator(bool preview);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public XPathNavigator CreateNavigator() => CreateNavigator(PreviewDefault);

    [Obsolete("The current implementation of this method is suboptimal and will be removed entirely in a future version. Scheduled for removal in v14")]
    public abstract XPathNavigator? CreateNodeNavigator(int id, bool preview);

    public abstract bool HasContent(bool preview);

    public bool HasContent() => HasContent(PreviewDefault);

    public abstract IPublishedContentType? GetContentType(int id);

    public abstract IPublishedContentType? GetContentType(string alias);

    public abstract IPublishedContentType? GetContentType(Guid key);

    public virtual IEnumerable<IPublishedContent> GetByContentType(IPublishedContentType contentType) =>

        // this is probably not super-efficient, but works
        // some cache implementation may want to override it, though
        GetAtRoot()
            .SelectMany(x => x.DescendantsOrSelf(_variationContextAccessor!))
            .Where(x => x.ContentType.Id == contentType.Id);
}