From ead7741ee2397541719b613750c920272df8d586 Mon Sep 17 00:00:00 2001
From: Andy Butland <abutland73@gmail.com>
Date: Thu, 16 Nov 2023 06:33:36 +0100
Subject: [PATCH] Updated rich text parser interfaces to support context cache.
 (#15220)

---
 src/Umbraco.Core/Deploy/IImageSourceParser.cs | 25 ++++++++++++
 src/Umbraco.Core/Deploy/ILocalLinkParser.cs   | 28 ++++++++++++++
 src/Umbraco.Core/Deploy/IMacroParser.cs       | 38 +++++++++++++++++++
 3 files changed, 91 insertions(+)

diff --git a/src/Umbraco.Core/Deploy/IImageSourceParser.cs b/src/Umbraco.Core/Deploy/IImageSourceParser.cs
index 0180ec0b3d..cbbaa6bc9a 100644
--- a/src/Umbraco.Core/Deploy/IImageSourceParser.cs
+++ b/src/Umbraco.Core/Deploy/IImageSourceParser.cs
@@ -12,13 +12,38 @@ public interface IImageSourceParser
     /// <param name="dependencies">A list of dependencies.</param>
     /// <returns>The parsed value.</returns>
     /// <remarks>Turns src="/media/..." into src="umb://media/..." and adds the corresponding udi to the dependencies.</remarks>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string ToArtifact(string value, ICollection<Udi> dependencies);
 
+    /// <summary>
+    ///     Parses an Umbraco property value and produces an artifact property value.
+    /// </summary>
+    /// <param name="value">The property value.</param>
+    /// <param name="dependencies">A list of dependencies.</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>The parsed value.</returns>
+    /// <remarks>Turns src="/media/..." into src="umb://media/..." and adds the corresponding udi to the dependencies.</remarks>
+#pragma warning disable CS0618 // Type or member is obsolete
+    string ToArtifact(string value, ICollection<Udi> dependencies, IContextCache contextCache) => ToArtifact(value, dependencies);
+#pragma warning restore CS0618 // Type or member is obsolete
+
     /// <summary>
     ///     Parses an artifact property value and produces an Umbraco property value.
     /// </summary>
     /// <param name="value">The artifact property value.</param>
     /// <returns>The parsed value.</returns>
     /// <remarks>Turns umb://media/... into /media/....</remarks>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string FromArtifact(string value);
+
+    /// <summary>
+    ///     Parses an artifact property value and produces an Umbraco property value.
+    /// </summary>
+    /// <param name="value">The artifact property value.</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>The parsed value.</returns>
+    /// <remarks>Turns umb://media/... into /media/....</remarks>
+#pragma warning disable CS0618 // Type or member is obsolete
+    string FromArtifact(string value, IContextCache contextCache) => FromArtifact(value);
+#pragma warning restore CS0618 // Type or member is obsolete
 }
diff --git a/src/Umbraco.Core/Deploy/ILocalLinkParser.cs b/src/Umbraco.Core/Deploy/ILocalLinkParser.cs
index 7ec3fff0fa..d84bf35af1 100644
--- a/src/Umbraco.Core/Deploy/ILocalLinkParser.cs
+++ b/src/Umbraco.Core/Deploy/ILocalLinkParser.cs
@@ -15,13 +15,41 @@ public interface ILocalLinkParser
     ///     Turns {{localLink:1234}} into {{localLink:umb://{type}/{id}}} and adds the corresponding udi to the
     ///     dependencies.
     /// </remarks>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string ToArtifact(string value, ICollection<Udi> dependencies);
 
+    /// <summary>
+    ///     Parses an Umbraco property value and produces an artifact property value.
+    /// </summary>
+    /// <param name="value">The property value.</param>
+    /// <param name="dependencies">A list of dependencies.</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>The parsed value.</returns>
+    /// <remarks>
+    ///     Turns {{localLink:1234}} into {{localLink:umb://{type}/{id}}} and adds the corresponding udi to the
+    ///     dependencies.
+    /// </remarks>
+#pragma warning disable CS0618 // Type or member is obsolete
+    string ToArtifact(string value, ICollection<Udi> dependencies, IContextCache contextCache) => ToArtifact(value, dependencies);
+#pragma warning restore CS0618 // Type or member is obsolete
+
     /// <summary>
     ///     Parses an artifact property value and produces an Umbraco property value.
     /// </summary>
     /// <param name="value">The artifact property value.</param>
     /// <returns>The parsed value.</returns>
     /// <remarks>Turns {{localLink:umb://{type}/{id}}} into {{localLink:1234}}.</remarks>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string FromArtifact(string value);
+
+    /// <summary>
+    ///     Parses an artifact property value and produces an Umbraco property value.
+    /// </summary>
+    /// <param name="value">The artifact property value.</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>The parsed value.</returns>
+    /// <remarks>Turns {{localLink:umb://{type}/{id}}} into {{localLink:1234}}.</remarks>
+#pragma warning disable CS0618 // Type or member is obsolete
+    string FromArtifact(string value, IContextCache contextCache) => FromArtifact(value);
+#pragma warning restore CS0618 // Type or member is obsolete
 }
diff --git a/src/Umbraco.Core/Deploy/IMacroParser.cs b/src/Umbraco.Core/Deploy/IMacroParser.cs
index fed9dcc3af..17f06992d5 100644
--- a/src/Umbraco.Core/Deploy/IMacroParser.cs
+++ b/src/Umbraco.Core/Deploy/IMacroParser.cs
@@ -8,15 +8,38 @@ public interface IMacroParser
     /// <param name="value">Property value.</param>
     /// <param name="dependencies">A list of dependencies.</param>
     /// <returns>Parsed value.</returns>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string ToArtifact(string value, ICollection<Udi> dependencies);
 
+    /// <summary>
+    ///     Parses an Umbraco property value and produces an artifact property value.
+    /// </summary>
+    /// <param name="value">Property value.</param>
+    /// <param name="dependencies">A list of dependencies.</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>Parsed value.</returns>
+#pragma warning disable CS0618 // Type or member is obsolete
+    string ToArtifact(string value, ICollection<Udi> dependencies, IContextCache contextCache) => ToArtifact(value, dependencies);
+#pragma warning restore CS0618 // Type or member is obsolete
+
     /// <summary>
     ///     Parses an artifact property value and produces an Umbraco property value.
     /// </summary>
     /// <param name="value">Artifact property value.</param>
     /// <returns>Parsed value.</returns>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string FromArtifact(string value);
 
+    /// <summary>
+    ///     Parses an artifact property value and produces an Umbraco property value.
+    /// </summary>
+    /// <param name="value">Artifact property value.</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>Parsed value.</returns>
+#pragma warning disable CS0618 // Type or member is obsolete
+    string FromArtifact(string value, IContextCache contextCache) => FromArtifact(value);
+#pragma warning restore CS0618 // Type or member is obsolete
+
     /// <summary>
     ///     Tries to replace the value of the attribute/parameter with a value containing a converted identifier.
     /// </summary>
@@ -25,5 +48,20 @@ public interface IMacroParser
     /// <param name="dependencies">Collection to add dependencies to when performing ToArtifact</param>
     /// <param name="direction">Indicates which action is being performed (to or from artifact)</param>
     /// <returns>Value with converted identifiers</returns>
+    [Obsolete("Please use the overload taking all parameters. This method will be removed in Umbraco 14.")]
     string ReplaceAttributeValue(string value, string editorAlias, ICollection<Udi> dependencies, Direction direction);
+
+    /// <summary>
+    ///     Tries to replace the value of the attribute/parameter with a value containing a converted identifier.
+    /// </summary>
+    /// <param name="value">Value to attempt to convert</param>
+    /// <param name="editorAlias">Alias of the editor used for the parameter</param>
+    /// <param name="dependencies">Collection to add dependencies to when performing ToArtifact</param>
+    /// <param name="direction">Indicates which action is being performed (to or from artifact)</param>
+    /// <param name="contextCache">The context cache.</param>
+    /// <returns>Value with converted identifiers</returns>
+    string ReplaceAttributeValue(string value, string editorAlias, ICollection<Udi> dependencies, Direction direction, IContextCache contextCache)
+#pragma warning disable CS0618 // Type or member is obsolete
+        => ReplaceAttributeValue(value, editorAlias, dependencies, direction);
+#pragma warning restore CS0618 // Type or member is obsolete
 }