|
| 1 | +using System; |
| 2 | +using System.Collections.Generic; |
| 3 | +using System.Diagnostics.CodeAnalysis; |
| 4 | +using System.Linq; |
| 5 | +using Umbraco.Cms.Core; |
| 6 | +using Umbraco.Cms.Core.PropertyEditors; |
| 7 | +using Umbraco.Cms.Core.Serialization; |
| 8 | +using Umbraco.Deploy.Infrastructure.Migrators; |
| 9 | +using Umbraco.Extensions; |
| 10 | + |
| 11 | +namespace Umbraco.Deploy.Contrib.Migrators.Legacy; |
| 12 | + |
| 13 | +/// <inheritdoc /> |
| 14 | +public abstract class LegacyReplaceDataTypeArtifactMigratorBase : ReplaceDataTypeArtifactMigratorBase |
| 15 | +{ |
| 16 | + private readonly IConfigurationEditorJsonSerializer _configurationEditorJsonSerializer; |
| 17 | + |
| 18 | + /// <summary> |
| 19 | + /// Initializes a new instance of the <see cref="LegacyReplaceDataTypeArtifactMigratorBase" /> class. |
| 20 | + /// </summary> |
| 21 | + /// <param name="fromEditorAlias">The editor alias to migrate from.</param> |
| 22 | + /// <param name="toEditorAlias">The editor alias to migrate to.</param> |
| 23 | + /// <param name="propertyEditors">The property editors.</param> |
| 24 | + /// <param name="configurationEditorJsonSerializer">The configuration editor JSON serializer.</param> |
| 25 | + protected LegacyReplaceDataTypeArtifactMigratorBase(string fromEditorAlias, string toEditorAlias, PropertyEditorCollection propertyEditors, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer) |
| 26 | + : base(fromEditorAlias, toEditorAlias, propertyEditors, configurationEditorJsonSerializer) |
| 27 | + => _configurationEditorJsonSerializer = configurationEditorJsonSerializer; |
| 28 | + |
| 29 | + /// <summary> |
| 30 | + /// Replaces the old key with a new key. |
| 31 | + /// </summary> |
| 32 | + /// <param name="configuration">The configuration.</param> |
| 33 | + /// <param name="oldKey">The old key.</param> |
| 34 | + /// <param name="newKey">The new key.</param> |
| 35 | + protected static void ReplaceKey(ref IDictionary<string, object> configuration, string oldKey, string newKey) |
| 36 | + { |
| 37 | + if (configuration.Remove(oldKey, out var value)) |
| 38 | + { |
| 39 | + configuration[newKey] = value; |
| 40 | + } |
| 41 | + } |
| 42 | + |
| 43 | + /// <summary> |
| 44 | + /// Replaces the UDI value with the GUID. |
| 45 | + /// </summary> |
| 46 | + /// <param name="configuration">The configuration.</param> |
| 47 | + /// <param name="key">The key.</param> |
| 48 | + /// <param name="keepInvalid">If set to <c>true</c> keeps the invalid value.</param> |
| 49 | + protected static void ReplaceUdiWithGuid(ref IDictionary<string, object> configuration, string key, bool keepInvalid = false) |
| 50 | + { |
| 51 | + if (configuration.TryGetValue(key, out var value)) |
| 52 | + { |
| 53 | + if (value is string udi && UdiParser.TryParse(udi, out GuidUdi? guidUdi)) |
| 54 | + { |
| 55 | + configuration[key] = guidUdi.Guid; |
| 56 | + } |
| 57 | + else if (keepInvalid is false && (value is not string guid || Guid.TryParse(guid, out _) is false)) |
| 58 | + { |
| 59 | + configuration.Remove(key); |
| 60 | + } |
| 61 | + } |
| 62 | + } |
| 63 | + |
| 64 | + /// <summary> |
| 65 | + /// Replaces the integer value with a boolean (defaults to false). |
| 66 | + /// </summary> |
| 67 | + /// <param name="configuration">The configuration.</param> |
| 68 | + /// <param name="key">The key.</param> |
| 69 | + protected static void ReplaceIntegerWithBoolean(ref IDictionary<string, object> configuration, string key) |
| 70 | + { |
| 71 | + if (configuration.TryGetValue(key, out var value) && |
| 72 | + value is not bool) |
| 73 | + { |
| 74 | + configuration[key] = value?.ToString()?.ToLowerInvariant() switch |
| 75 | + { |
| 76 | + "1" or "true" => true, |
| 77 | + _ => false, |
| 78 | + }; |
| 79 | + } |
| 80 | + } |
| 81 | + |
| 82 | + /// <summary> |
| 83 | + /// Replaces the string value with an integer. |
| 84 | + /// </summary> |
| 85 | + /// <param name="configuration">The configuration.</param> |
| 86 | + /// <param name="key">The key.</param> |
| 87 | + /// <param name="keepInvalid">If set to <c>true</c> keeps the invalid value.</param> |
| 88 | + protected static void ReplaceStringWithInteger(ref IDictionary<string, object> configuration, string key, bool keepInvalid = false) |
| 89 | + { |
| 90 | + if (configuration.TryGetValue(key, out var value) && |
| 91 | + value is not int) |
| 92 | + { |
| 93 | + if (value is string stringValue && |
| 94 | + int.TryParse(stringValue, out int intValue)) |
| 95 | + { |
| 96 | + configuration[key] = intValue; |
| 97 | + } |
| 98 | + else if (keepInvalid is false) |
| 99 | + { |
| 100 | + configuration.Remove(key); |
| 101 | + } |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + /// <summary> |
| 106 | + /// Replaces the value list array with a string array. |
| 107 | + /// </summary> |
| 108 | + /// <param name="configuration">The configuration.</param> |
| 109 | + /// <param name="key">The key.</param> |
| 110 | + protected void ReplaceValueListArrayWithStringArray(ref IDictionary<string, object> configuration, string key) |
| 111 | + { |
| 112 | + if (TryDeserialize(ref configuration, key, out IEnumerable<LegacyValueListItem>? items)) |
| 113 | + { |
| 114 | + configuration[key] = items.Select(x => x.Value).ToArray(); |
| 115 | + } |
| 116 | + } |
| 117 | + |
| 118 | + /// <summary> |
| 119 | + /// Replaces the UDI in the tree source ID value with the GUID. |
| 120 | + /// </summary> |
| 121 | + /// <param name="configuration">The configuration.</param> |
| 122 | + /// <param name="key">The key.</param> |
| 123 | + /// <param name="treeSourceType">The entity type of the tree source.</param> |
| 124 | + protected void ReplaceTreeSourceIdUdiWithGuid(ref IDictionary<string, object> configuration, string key, out string? treeSourceType) |
| 125 | + { |
| 126 | + if (TryDeserialize(ref configuration, key, out LegacyTreeSource? treeSource)) |
| 127 | + { |
| 128 | + configuration[key] = new TreeSource() |
| 129 | + { |
| 130 | + Type = treeSource.Type, |
| 131 | + Id = treeSource.Id?.Guid, |
| 132 | + DynamicRoot = treeSource.DynamicRoot, |
| 133 | + }; |
| 134 | + } |
| 135 | + |
| 136 | + treeSourceType = treeSource?.Type; |
| 137 | + } |
| 138 | + |
| 139 | + /// <summary> |
| 140 | + /// Replaces the aliases with keys. |
| 141 | + /// </summary> |
| 142 | + /// <param name="configuration">The configuration.</param> |
| 143 | + /// <param name="key">The key.</param> |
| 144 | + /// <param name="getKeyByAlias">The delegate to get the key by alias.</param> |
| 145 | + protected static void ReplaceAliasesWithKeys(ref IDictionary<string, object> configuration, string key, Func<string, Guid?> getKeyByAlias) |
| 146 | + { |
| 147 | + if (configuration.TryGetValue(key, out var value) && |
| 148 | + value is string stringValue) |
| 149 | + { |
| 150 | + configuration[key] = string.Join(',', stringValue.Split(Constants.CharArrays.Comma).Select(getKeyByAlias).OfType<Guid>()); |
| 151 | + } |
| 152 | + } |
| 153 | + |
| 154 | + /// <summary> |
| 155 | + /// Attempts to JSON deserialize the value. |
| 156 | + /// </summary> |
| 157 | + /// <typeparam name="T">The type to deserialize to.</typeparam> |
| 158 | + /// <param name="configuration">The configuration.</param> |
| 159 | + /// <param name="key">The key.</param> |
| 160 | + /// <param name="value">The value.</param> |
| 161 | + /// <returns> |
| 162 | + /// <c>true</c> if the value was deserialized; otherwise, <c>false</c>. |
| 163 | + /// </returns> |
| 164 | + protected bool TryDeserialize<T>(ref IDictionary<string, object> configuration, string key, [NotNullWhen(true)] out T? value) |
| 165 | + { |
| 166 | + if (configuration.TryGetValue(key, out var configurationValue) && |
| 167 | + configurationValue?.ToString() is string stringValue && |
| 168 | + stringValue.DetectIsJson()) |
| 169 | + { |
| 170 | + value = _configurationEditorJsonSerializer.Deserialize<T>(stringValue); |
| 171 | + } |
| 172 | + else |
| 173 | + { |
| 174 | + value = default; |
| 175 | + } |
| 176 | + |
| 177 | + return value is not null; |
| 178 | + } |
| 179 | + |
| 180 | + private sealed class LegacyValueListItem |
| 181 | + { |
| 182 | + public required string Value { get; set; } |
| 183 | + } |
| 184 | + |
| 185 | + private sealed class LegacyTreeSource |
| 186 | + { |
| 187 | + public required string Type { get; set; } |
| 188 | + public GuidUdi? Id { get; set; } |
| 189 | + public object? DynamicRoot { get; set; } |
| 190 | + } |
| 191 | + |
| 192 | + private sealed class TreeSource |
| 193 | + { |
| 194 | + public required string Type { get; set; } |
| 195 | + public Guid? Id { get; set; } |
| 196 | + public object? DynamicRoot { get; set; } |
| 197 | + } |
| 198 | +} |
0 commit comments