Umbraco-CMS/src/Umbraco.Infrastructure/PropertyEditors/BlockEditorPropertyNotificationHandlerBase.cs

using System.Text.RegularExpressions;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json.Linq;
using Umbraco.Cms.Core.Models.Blocks;
using Umbraco.Extensions;

namespace Umbraco.Cms.Core.PropertyEditors;

public abstract class BlockEditorPropertyNotificationHandlerBase<TBlockLayoutItem> : ComplexPropertyEditorContentNotificationHandler
    where TBlockLayoutItem : IBlockLayoutItem, new()
{
    private readonly ILogger<BlockEditorPropertyNotificationHandlerBase<TBlockLayoutItem>> _logger;
    private readonly List<string> _udisToReplace = new List<string>();

    protected BlockEditorPropertyNotificationHandlerBase(ILogger<BlockEditorPropertyNotificationHandlerBase<TBlockLayoutItem>> logger) => _logger = logger;

    protected override string FormatPropertyValue(string rawJson, bool onlyMissingKeys)
    {
        // the block editor doesn't ever have missing UDIs so when this is true there's nothing to process
        if (onlyMissingKeys)
        {
            return rawJson;
        }

        return ReplaceBlockEditorUdis(rawJson);
    }

    // internal for tests
    // the purpose of this method is to replace the content and settings UDIs throughout the JSON structure of a block editor value.
    // the challenge is nested block editor values, which must also have their UDIs replaced. this becomes particularly tricky because
    // other nested property values could also contain UDIs, which should *not* be replaced (i.e. a content picker value).
    internal string ReplaceBlockEditorUdis(string rawJson, Func<Guid, Guid>? createGuid = null)
    {
        // used so we can test nicely
        createGuid ??= _ => Guid.NewGuid();

        if (string.IsNullOrWhiteSpace(rawJson))
        {
            return rawJson;
        }

        JObject? jObject = ParseObject(rawJson);
        if (jObject == null)
        {
            return rawJson;
        }

        TraverseObject(jObject);

        var oldToNewKeys = new Dictionary<Guid, Guid>();

        rawJson = Regex.Replace(
            rawJson,
            @"(umb:\/\/\w*\/)(\w*)",
            match =>
            {
                if (_udisToReplace.Contains(match.Value) == false)
                {
                    return match.Value;
                }

                var oldKey = Guid.Parse(match.Groups[2].Value);
                if (oldToNewKeys.ContainsKey(oldKey) == false)
                {
                    oldToNewKeys[oldKey] = createGuid(oldKey);
                }

                return $"{match.Groups[1]}{oldToNewKeys[oldKey].ToString("N")}";
            });

        return rawJson;
    }

    private void TraverseProperty(JProperty property)
    {
        if (property.Value is JArray jArray)
        {
            foreach (JToken token in jArray)
            {
                TraverseToken(token);
            }
        }
        else
        {
            TraverseToken(property.Value);
        }
    }

    private void TraverseToken(JToken token)
    {
        var obj = token as JObject;
        if (obj == null && token is JValue { Value: string str })
        {
            obj = ParseObject(str);
        }

        if (obj == null)
        {
            return;
        }

        TraverseObject(obj);
    }

    private void TraverseObject(JObject obj)
    {
        var contentData = obj.SelectToken("$.contentData") as JArray;
        var settingsData = obj.SelectToken("$.settingsData") as JArray;

        // we'll assume that the object is a data representation of a block based editor if it contains "contentData" and "settingsData".
        if (contentData != null && settingsData != null)
        {
            ParseUdis(contentData, settingsData);
            return;
        }

        foreach (JProperty property in obj.Properties())
        {
            TraverseProperty(property);
        }
    }

    private void ParseUdis(JArray contentData, JArray settingsData)
    {
        // grab all UDIs from the objects of contentData and settingsData
        var udis = contentData.Select(c => c.SelectToken("$.udi"))
            .Union(settingsData.Select(s => s.SelectToken("$.udi")))
            .Select(udiToken => udiToken?.Value<string>()?.NullOrWhiteSpaceAsNull())
            .ToArray();

        // the following is solely for avoiding functionality wise breakage. we should consider removing it eventually, but for the time being it's harmless.
        foreach (var udiToReplace in udis)
        {
            if (UdiParser.TryParse(udiToReplace ?? string.Empty, out Udi? udi) == false || udi is not GuidUdi)
            {
                throw new FormatException($"Could not parse a valid {nameof(GuidUdi)} from the string: \"{udiToReplace}\"");
            }
        }

        _udisToReplace.AddRange(udis.WhereNotNull());

        foreach (JObject item in contentData.Union(settingsData).OfType<JObject>())
        {
            foreach (JProperty property in item.Properties().Where(p => p.Name != "contentTypeKey" && p.Name != "udi"))
            {
                TraverseProperty(property);
            }
        }
    }

    private JObject? ParseObject(string json)
    {
        if (json.DetectIsJson() == false)
        {
            return null;
        }

        try
        {
            return JObject.Parse(json);
        }
        catch (Exception)
        {
            // See issue https://github.com/umbraco/Umbraco-CMS/issues/10879
            // We are detecting JSON data by seeing if a string is surrounded by [] or {}
            // If people enter text like [PLACEHOLDER] JToken  parsing fails, it's safe to ignore though
            // Logging this just in case in the future we find values that are not safe to ignore
            _logger.LogWarning("The following value was recognized as JSON but could not be parsed: {Json}", json);
            return null;
        }
    }
}