Umbraco-CMS/src/Umbraco.Core/Models/ContentRepositoryExtensions.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Umbraco.Cms.Core.Models;

namespace Umbraco.Extensions
{
    /// <summary>
    /// Extension methods used to manipulate content variations by the document repository
    /// </summary>
    public static class ContentRepositoryExtensions
    {
        public static void SetCultureInfo(this IContentBase content, string? culture, string? name, DateTime date)
        {
            if (name == null) throw new ArgumentNullException(nameof(name));
            if (string.IsNullOrWhiteSpace(name)) throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(name));

            if (culture == null) throw new ArgumentNullException(nameof(culture));
            if (string.IsNullOrWhiteSpace(culture)) throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(culture));

            content.CultureInfos?.AddOrUpdate(culture, name, date);
        }

        /// <summary>
        /// Updates a culture date, if the culture exists.
        /// </summary>
        public static void TouchCulture(this IContentBase content, string? culture)
        {
            if (culture.IsNullOrWhiteSpace() || content.CultureInfos is null)
            {
                return;
            }

            if (!content.CultureInfos.TryGetValue(culture!, out var infos))
            {
                return;
            }

            content.CultureInfos?.AddOrUpdate(culture!, infos.Name, DateTime.Now);
        }

        /// <summary>
        /// Used to synchronize all culture dates to the same date if they've been modified
        /// </summary>
        /// <param name="content"></param>
        /// <param name="date"></param>
        /// <remarks>
        /// This is so that in an operation where (for example) 2 languages are updates like french and english, it is possible that
        /// these dates assigned to them differ by a couple of Ticks, but we need to ensure they are persisted at the exact same time.
        /// </remarks>
        public static void AdjustDates(this IContent content, DateTime date, bool publishing)
        {
            if (content.EditedCultures is not null)
            {
                foreach(var culture in content.EditedCultures.ToList())
                {
                    if (content.CultureInfos is null)
                    {
                        continue;
                    }

                    if (!content.CultureInfos.TryGetValue(culture, out var editedInfos))
                    {
                        continue;
                    }

                    // if it's not dirty, it means it hasn't changed so there's nothing to adjust
                    if (!editedInfos.IsDirty())
                    {
                        continue;
                    }

                    content.CultureInfos?.AddOrUpdate(culture, editedInfos?.Name, date);
                }
            }


            if (!publishing)
            {
                return;
            }

            foreach (var culture in content.PublishedCultures.ToList())
            {
                if (content.PublishCultureInfos is null)
                {
                    continue;
                }
                if (!content.PublishCultureInfos.TryGetValue(culture, out ContentCultureInfos publishInfos))
                {
                    continue;
                }

                // if it's not dirty, it means it hasn't changed so there's nothing to adjust
                if (!publishInfos.IsDirty())
                {
                    continue;
                }

                content.PublishCultureInfos.AddOrUpdate(culture, publishInfos.Name, date);

                if (content.CultureInfos?.TryGetValue(culture, out ContentCultureInfos infos) ?? false)
                {
                    SetCultureInfo(content, culture, infos.Name, date);
                }
            }
        }

        /// <summary>
        /// Gets the cultures that have been flagged for unpublishing.
        /// </summary>
        /// <remarks>Gets cultures for which content.UnpublishCulture() has been invoked.</remarks>
        public static IReadOnlyList<string>? GetCulturesUnpublishing(this IContent content)
        {
            if (!content.Published || !content.ContentType.VariesByCulture() || !content.IsPropertyDirty("PublishCultureInfos"))
                return Array.Empty<string>();

            var culturesUnpublishing = content.CultureInfos?.Values
                .Where(x => content.IsPropertyDirty(ContentBase.ChangeTrackingPrefix.UnpublishedCulture + x.Culture))
                .Select(x => x.Culture);

            return culturesUnpublishing?.ToList();
        }

        /// <summary>
        /// Copies values from another document.
        /// </summary>
        public static void CopyFrom(this IContent content, IContent other, string? culture = "*")
        {
            if (other.ContentTypeId != content.ContentTypeId)
                throw new InvalidOperationException("Cannot copy values from a different content type.");

            culture = culture?.ToLowerInvariant().NullOrWhiteSpaceAsNull();

            // the variation should be supported by the content type properties
            //  if the content type is invariant, only '*' and 'null' is ok
            //  if the content type varies, everything is ok because some properties may be invariant
            if (!content.ContentType.SupportsPropertyVariation(culture, "*", true))
                throw new NotSupportedException($"Culture \"{culture}\" is not supported by content type \"{content.ContentType.Alias}\" with variation \"{content.ContentType.Variations}\".");

            // copying from the same Id and VersionPk
            var copyingFromSelf = content.Id == other.Id && content.VersionId == other.VersionId;
            var published = copyingFromSelf;

            // note: use property.SetValue(), don't assign pvalue.EditValue, else change tracking fails

            // clear all existing properties for the specified culture
            foreach (var property in content.Properties)
            {
                // each property type may or may not support the variation
                if (!property.PropertyType?.SupportsVariation(culture, "*", wildcards: true) ?? false)
                    continue;

                foreach (var pvalue in property.Values)
                    if ((property.PropertyType?.SupportsVariation(pvalue.Culture, pvalue.Segment, wildcards: true) ?? false) &&
                        (culture == "*" || (pvalue.Culture?.InvariantEquals(culture) ?? false)))
                    {
                        property.SetValue(null, pvalue.Culture, pvalue.Segment);
                    }
            }

            // copy properties from 'other'
            var otherProperties = other.Properties;
            foreach (var otherProperty in otherProperties)
            {
                if (!otherProperty?.PropertyType?.SupportsVariation(culture, "*", wildcards: true) ?? true)
                    continue;

                var alias = otherProperty?.PropertyType.Alias;
                if (otherProperty is not null && alias is not null)
                {
                    foreach (var pvalue in otherProperty.Values)
                    {
                        if (otherProperty.PropertyType.SupportsVariation(pvalue.Culture, pvalue.Segment, wildcards: true) &&
                            (culture == "*" || (pvalue.Culture?.InvariantEquals(culture) ?? false)))
                        {
                            var value = published ? pvalue.PublishedValue : pvalue.EditedValue;
                            content.SetValue(alias, value, pvalue.Culture, pvalue.Segment);
                        }
                    }
                }
            }

            // copy names, too

            if (culture == "*")
            {
                content.CultureInfos?.Clear();
                content.CultureInfos = null;
            }

            if (culture == null || culture == "*")
                content.Name = other.Name;

            // ReSharper disable once UseDeconstruction
            if (other.CultureInfos is not null)
            {
                foreach (var cultureInfo in other.CultureInfos)
                {
                    if (culture == "*" || culture == cultureInfo.Culture)
                        content.SetCultureName(cultureInfo.Name, cultureInfo.Culture);
                }
            }
        }

        public static void SetPublishInfo(this IContent content, string? culture, string? name, DateTime date)
        {
            if (name == null) throw new ArgumentNullException(nameof(name));
            if (string.IsNullOrWhiteSpace(name)) throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(name));

            if (culture == null) throw new ArgumentNullException(nameof(culture));
            if (string.IsNullOrWhiteSpace(culture)) throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(culture));

            content.PublishCultureInfos?.AddOrUpdate(culture, name, date);
        }

        // sets the edited cultures on the content
        public static void SetCultureEdited(this IContent content, IEnumerable<string?>? cultures)
        {
            if (cultures == null)
                content.EditedCultures = null;
            else
            {
                var editedCultures = new HashSet<string>(cultures.Where(x => !x.IsNullOrWhiteSpace())!, StringComparer.OrdinalIgnoreCase);
                content.EditedCultures = editedCultures.Count > 0 ? editedCultures : null;
            }
        }

        /// <summary>
        /// Sets the publishing values for names and properties.
        /// </summary>
        /// <param name="content"></param>
        /// <param name="impact"></param>
        /// <returns>A value indicating whether it was possible to publish the names and values for the specified
        /// culture(s). The method may fail if required names are not set, but it does NOT validate property data</returns>
        public static bool PublishCulture(this IContent content, CultureImpact? impact)
        {
            if (impact == null) throw new ArgumentNullException(nameof(impact));

            // the variation should be supported by the content type properties
            //  if the content type is invariant, only '*' and 'null' is ok
            //  if the content type varies, everything is ok because some properties may be invariant
            if (!content.ContentType.SupportsPropertyVariation(impact.Culture, "*", true))
                throw new NotSupportedException($"Culture \"{impact.Culture}\" is not supported by content type \"{content.ContentType.Alias}\" with variation \"{content.ContentType.Variations}\".");

            // set names
            if (impact.ImpactsAllCultures)
            {
                foreach (var c in content.AvailableCultures) // does NOT contain the invariant culture
                {
                    var name = content.GetCultureName(c);
                    if (string.IsNullOrWhiteSpace(name))
                        return false;
                    content.SetPublishInfo(c, name, DateTime.Now);
                }
            }
            else if (impact.ImpactsOnlyInvariantCulture)
            {
                if (string.IsNullOrWhiteSpace(content.Name))
                    return false;
                // PublishName set by repository - nothing to do here
            }
            else if (impact.ImpactsExplicitCulture)
            {
                var name = content.GetCultureName(impact.Culture);
                if (string.IsNullOrWhiteSpace(name))
                    return false;
                content.SetPublishInfo(impact.Culture, name, DateTime.Now);
            }

            // set values
            // property.PublishValues only publishes what is valid, variation-wise,
            // but accepts any culture arg: null, all, specific
            foreach (var property in content.Properties)
            {
                // for the specified culture (null or all or specific)
                property.PublishValues(impact.Culture);

                // maybe the specified culture did not impact the invariant culture, so PublishValues
                // above would skip it, yet it *also* impacts invariant properties
                if (impact.ImpactsAlsoInvariantProperties)
                    property.PublishValues(null);
            }

            content.PublishedState = PublishedState.Publishing;
            return true;
        }

        /// <summary>
        /// Returns false if the culture is already unpublished
        /// </summary>
        /// <param name="content"></param>
        /// <param name="culture"></param>
        /// <returns></returns>
        public static bool UnpublishCulture(this IContent content, string? culture = "*")
        {
            culture = culture?.NullOrWhiteSpaceAsNull();

            // the variation should be supported by the content type properties
            if (!content.ContentType.SupportsPropertyVariation(culture, "*", true))
                throw new NotSupportedException($"Culture \"{culture}\" is not supported by content type \"{content.ContentType.Alias}\" with variation \"{content.ContentType.Variations}\".");

            var keepProcessing = true;

            if (culture == "*")
            {
                // all cultures
                content.ClearPublishInfos();
            }
            else
            {
                // one single culture
                keepProcessing = content.ClearPublishInfo(culture);
            }

            if (keepProcessing)
            {
                // property.PublishValues only publishes what is valid, variation-wise
                foreach (var property in content.Properties)
                    property.UnpublishValues(culture);

                content.PublishedState = PublishedState.Publishing;
            }

            return keepProcessing;
        }

        public static void ClearPublishInfos(this IContent content)
        {
            content.PublishCultureInfos = null;
        }

        /// <summary>
        /// Returns false if the culture is already unpublished
        /// </summary>
        /// <param name="content"></param>
        /// <param name="culture"></param>
        /// <returns></returns>
        public static bool ClearPublishInfo(this IContent content, string? culture)
        {
            if (culture == null) throw new ArgumentNullException(nameof(culture));
            if (string.IsNullOrWhiteSpace(culture)) throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(culture));

            var removed = content.PublishCultureInfos?.Remove(culture);
            if (removed ?? false)
            {
                // set the culture to be dirty - it's been modified
                content.TouchCulture(culture);
            }
            return removed ?? false;
        }
    }
}