|
| 1 | +using System; |
| 2 | +using System.Collections.Generic; |
| 3 | +using System.Linq; |
| 4 | +using System.Text.RegularExpressions; |
| 5 | +using Newtonsoft.Json.Linq; |
| 6 | +using Umbraco.Cms.Core; |
| 7 | +using Umbraco.Cms.Core.Configuration.Grid; |
| 8 | +using Umbraco.Cms.Core.Models; |
| 9 | +using Umbraco.Cms.Core.PropertyEditors; |
| 10 | +using Umbraco.Cms.Core.Serialization; |
| 11 | +using Umbraco.Cms.Core.Services; |
| 12 | +using Umbraco.Cms.Core.Strings; |
| 13 | +using Umbraco.Deploy.Infrastructure.Artifacts; |
| 14 | +using Umbraco.Deploy.Infrastructure.Migrators; |
| 15 | +using Umbraco.Extensions; |
| 16 | +using static Umbraco.Cms.Core.PropertyEditors.BlockGridConfiguration; |
| 17 | + |
| 18 | +namespace Umbraco.Deploy.Contrib.Migrators; |
| 19 | + |
| 20 | +/// <summary> |
| 21 | +/// Migrates the <see cref="DataTypeArtifact" /> to replace the legacy/obsoleted <see cref="Constants.PropertyEditors.Aliases.Grid" /> editor with <see cref="Constants.PropertyEditors.Aliases.BlockGrid" /> and support DTGE grid editors. |
| 22 | +/// </summary> |
| 23 | +public class ReplaceDocTypeGridEditorDataTypeArtifactMigrator : ReplaceGridDataTypeArtifactMigrator |
| 24 | +{ |
| 25 | + private readonly IContentTypeService _contentTypeService; |
| 26 | + |
| 27 | + /// <summary> |
| 28 | + /// Gets or sets a value indicating whether to add the default DTGE grid editor (if not configured in the grid.editors.config.js files). |
| 29 | + /// </summary> |
| 30 | + /// <value> |
| 31 | + /// <c>true</c> if the default DTGE grid editor is added; otherwise, <c>false</c>. |
| 32 | + /// </value> |
| 33 | + /// <remarks> |
| 34 | + /// Defaults to <c>true</c>. |
| 35 | + /// </remarks> |
| 36 | + protected bool AddDefaultDocTypeGridEditor { get; init; } = true; |
| 37 | + |
| 38 | + /// <summary> |
| 39 | + /// Initializes a new instance of the <see cref="ReplaceDocTypeGridEditorDataTypeArtifactMigrator" /> class. |
| 40 | + /// </summary> |
| 41 | + /// <param name="propertyEditors">The property editors.</param> |
| 42 | + /// <param name="configurationEditorJsonSerializer">The configuration editor JSON serializer.</param> |
| 43 | + /// <param name="contentTypeService">The content type service.</param> |
| 44 | + /// <param name="dataTypeService">The data type service.</param> |
| 45 | + /// <param name="shortStringHelper">The short string helper.</param> |
| 46 | + /// <param name="gridConfig">The grid configuration.</param> |
| 47 | + public ReplaceDocTypeGridEditorDataTypeArtifactMigrator(PropertyEditorCollection propertyEditors, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer, IContentTypeService contentTypeService, IDataTypeService dataTypeService, IShortStringHelper shortStringHelper, IGridConfig gridConfig) |
| 48 | + : base(propertyEditors, configurationEditorJsonSerializer, contentTypeService, dataTypeService, shortStringHelper, gridConfig) |
| 49 | + => _contentTypeService = contentTypeService; |
| 50 | + |
| 51 | + /// <inheritdoc /> |
| 52 | + protected override IEnumerable<(string, BlockGridBlockConfiguration)> MigrateGridEditors(IEnumerable<GridConfigurationLayout> gridLayouts) |
| 53 | + { |
| 54 | + // Migrate regular grid editors (DTGE editors are skipped) |
| 55 | + foreach ((string alias, BlockGridBlockConfiguration blockGridBlockConfiguration) in base.MigrateGridEditors(gridLayouts)) |
| 56 | + { |
| 57 | + yield return (alias, blockGridBlockConfiguration); |
| 58 | + } |
| 59 | + |
| 60 | + // Migrate DTGE editors |
| 61 | + var allElementTypes = GetAllElementTypes().ToList(); |
| 62 | + foreach (IGridEditorConfig gridEditor in GetGridEditors(gridLayouts).Where(IsDocTypeGridEditor)) |
| 63 | + { |
| 64 | + foreach (Guid contentElementTypeKey in MigrateDocTypeGridEditor(gridEditor, allElementTypes)) |
| 65 | + { |
| 66 | + yield return (gridEditor.Alias, new BlockGridBlockConfiguration() |
| 67 | + { |
| 68 | + ContentElementTypeKey = contentElementTypeKey, |
| 69 | + Label = gridEditor.Config.TryGetValue("nameTemplate", out var nameTemplateConfig) && nameTemplateConfig is string nameTemplate && !string.IsNullOrEmpty(nameTemplate) |
| 70 | + ? nameTemplate |
| 71 | + : gridEditor.NameTemplate, |
| 72 | + EditorSize = gridEditor.Config.TryGetValue("overlaySize", out var overviewSizeConfig) && overviewSizeConfig is string overviewSize && !string.IsNullOrEmpty(overviewSize) |
| 73 | + ? overviewSize |
| 74 | + : null, |
| 75 | + }); |
| 76 | + } |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + /// <inheritdoc /> |
| 81 | + protected override IEnumerable<IGridEditorConfig> GetGridEditors() |
| 82 | + { |
| 83 | + foreach (IGridEditorConfig gridEditor in base.GetGridEditors()) |
| 84 | + { |
| 85 | + yield return gridEditor; |
| 86 | + } |
| 87 | + |
| 88 | + if (AddDefaultDocTypeGridEditor) |
| 89 | + { |
| 90 | + yield return new GridEditor() |
| 91 | + { |
| 92 | + Name = "Doc Type", |
| 93 | + Alias = "docType", |
| 94 | + View = "/App_Plugins/DocTypeGridEditor/Views/doctypegrideditor.html", |
| 95 | + Render = "/App_Plugins/DocTypeGridEditor/Render/DocTypeGridEditor.cshtml", |
| 96 | + Icon = "icon-item-arrangement", |
| 97 | + }; |
| 98 | + } |
| 99 | + } |
| 100 | + |
| 101 | + /// <inheritdoc /> |
| 102 | + protected override Guid? MigrateGridEditor(IGridEditorConfig gridEditor) |
| 103 | + // Skip migrating DocTypeGridEditor using base implementation (as that creates a new element type) |
| 104 | + => IsDocTypeGridEditor(gridEditor) is false ? base.MigrateGridEditor(gridEditor) : null; |
| 105 | + |
| 106 | + /// <summary> |
| 107 | + /// Migrates the DocTypeGridEditor. |
| 108 | + /// </summary> |
| 109 | + /// <param name="gridEditor">The grid editor.</param> |
| 110 | + /// <param name="allElementTypes">All element types.</param> |
| 111 | + /// <returns> |
| 112 | + /// The keys of the content element types of the migrated grid editor. |
| 113 | + /// </returns> |
| 114 | + protected virtual IEnumerable<Guid> MigrateDocTypeGridEditor(IGridEditorConfig gridEditor, IEnumerable<IContentType> allElementTypes) |
| 115 | + { |
| 116 | + if (gridEditor.Config.TryGetValue("allowedDocTypes", out var allowedDocTypesConfig) && |
| 117 | + allowedDocTypesConfig is JArray allowedDocTypes && |
| 118 | + allowedDocTypes.Values<string>().WhereNotNull().ToArray() is string[] docTypes && |
| 119 | + docTypes.Length > 0) |
| 120 | + { |
| 121 | + // Use regex matching |
| 122 | + return allElementTypes.Where(x => docTypes.Any(y => Regex.IsMatch(x.Alias, y))).Select(x => x.Key); |
| 123 | + } |
| 124 | + |
| 125 | + // Return all |
| 126 | + return allElementTypes.Select(x => x.Key); |
| 127 | + } |
| 128 | + |
| 129 | + /// <summary> |
| 130 | + /// Gets all element types. |
| 131 | + /// </summary> |
| 132 | + /// <returns> |
| 133 | + /// Returns all element types. |
| 134 | + /// </returns> |
| 135 | + /// <remarks> |
| 136 | + /// The default implementation excludes element types with aliases that start with <c>gridLayout_</c>, <c>gridRow_</c>, <c>gridEditor_</c> or <c>gridSettings_</c>. |
| 137 | + /// </remarks> |
| 138 | + protected virtual IEnumerable<IContentType> GetAllElementTypes() |
| 139 | + { |
| 140 | + static bool IsAllowedElementType(string alias) => !alias.StartsWith("gridLayout_") && !alias.StartsWith("gridRow_") && !alias.StartsWith("gridEditor_") && !alias.StartsWith("gridSettings_"); |
| 141 | + |
| 142 | + return _contentTypeService.GetAllElementTypes().Where(x => IsAllowedElementType(x.Alias)); |
| 143 | + } |
| 144 | + |
| 145 | + /// <summary> |
| 146 | + /// Determines whether the grid editor is the DocTypeGridEditor. |
| 147 | + /// </summary> |
| 148 | + /// <param name="gridEditor">The grid editor.</param> |
| 149 | + /// <returns> |
| 150 | + /// <c>true</c> if the grid editor is the DocTypeGridEditor; otherwise, <c>false</c>. |
| 151 | + /// </returns> |
| 152 | + protected static bool IsDocTypeGridEditor(IGridEditorConfig gridEditor) |
| 153 | + => gridEditor.View?.Contains("doctypegrideditor", StringComparison.OrdinalIgnoreCase) is true; |
| 154 | +} |
0 commit comments