yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidy up & better checking for NC JSON with JSONPath & SelectTokens()

Browse Source 
Less code duplication.
No need for Publishing event as Saving event is called before publishing
This commit is contained in:
Warren Buckley
2020-05-28 21:35:39 +01:00
parent c81268995c
commit 732d574ec2
1 changed files with 48 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
src/Umbraco.Web/Compose/NestedContentPropertyComponent.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.Linq;
using Newtonsoft.Json.Linq;
using Umbraco.Core;
@@ -17,7 +18,6 @@ namespace Umbraco.Web.Compose
{
ContentService.Copying += ContentService_Copying;
ContentService.Saving += ContentService_Saving;
ContentService.Publishing += ContentService_Publishing;
}
private void ContentService_Copying(IContentService sender, CopyEventArgs<IContent> e)
@@ -25,7 +25,29 @@ namespace Umbraco.Web.Compose
// When a content node contains nested content property
// Check if the copied node contains a nested content
var nestedContentProps = e.Copy.Properties.Where(x => x.PropertyType.PropertyEditorAlias == Constants.PropertyEditors.Aliases.NestedContent);
UpdateNestedContentProperties(nestedContentProps, false);
}
private void ContentService_Saving(IContentService sender, ContentSavingEventArgs e)
{
// One or more content nodes could be saved in a bulk publish
foreach (var entity in e.SavedEntities)
{
// When a content node contains nested content property
// Check if the copied node contains a nested content
var nestedContentProps = entity.Properties.Where(x => x.PropertyType.PropertyEditorAlias == Constants.PropertyEditors.Aliases.NestedContent);
UpdateNestedContentProperties(nestedContentProps, true);
}
}
public void Terminate()
{
ContentService.Copying -= ContentService_Copying;
ContentService.Saving -= ContentService_Saving;
}
private void UpdateNestedContentProperties(IEnumerable<Property> nestedContentProps, bool onlyMissingKeys)
{
// Each NC Property on a doctype
foreach (var nestedContentProp in nestedContentProps)
{
@@ -34,104 +56,40 @@ namespace Umbraco.Web.Compose
foreach (var cultureVal in propVals)
{
// Remove keys from published value & any nested NC's
var updatedPublishedVal = CreateNestedContentKeys(cultureVal.PublishedValue?.ToString(), false);
var updatedPublishedVal = CreateNestedContentKeys(cultureVal.PublishedValue?.ToString(), onlyMissingKeys);
cultureVal.PublishedValue = updatedPublishedVal;
// Remove keys from edited/draft value & any nested NC's
var updatedEditedVal = CreateNestedContentKeys(cultureVal.EditedValue?.ToString(), false);
var updatedEditedVal = CreateNestedContentKeys(cultureVal.EditedValue?.ToString(), onlyMissingKeys);
cultureVal.EditedValue = updatedEditedVal;
}
}
}
private void ContentService_Saving(IContentService sender, ContentSavingEventArgs e)
private string CreateNestedContentKeys(string rawJson, bool onlyMissingKeys)
{
// One or more content nodes could be saved in a bulk publish
foreach(var entity in e.SavedEntities)
{
// When a content node contains nested content property
// Check if the copied node contains a nested content
var nestedContentProps = entity.Properties.Where(x => x.PropertyType.PropertyEditorAlias == Constants.PropertyEditors.Aliases.NestedContent);
if (string.IsNullOrWhiteSpace(rawJson))
return rawJson;
// Each NC Property on a doctype
foreach (var nestedContentProp in nestedContentProps)
{
// A NC Prop may have one or more values due to cultures
var propVals = nestedContentProp.Values;
foreach (var cultureVal in propVals)
{
// Remove keys from published value & any nested NC's
var updatedPublishedVal = CreateNestedContentKeys(cultureVal.PublishedValue?.ToString(), true);
cultureVal.PublishedValue = updatedPublishedVal;
// Remove keys from edited/draft value & any nested NC's
var updatedEditedVal = CreateNestedContentKeys(cultureVal.EditedValue?.ToString(), true);
cultureVal.EditedValue = updatedEditedVal;
}
}
}
}
private void ContentService_Publishing(IContentService sender, ContentPublishingEventArgs e)
{
// One or more content nodes could be saved in a bulk publish
foreach (var entity in e.PublishedEntities)
{
// When a content node contains nested content property
// Check if the copied node contains a nested content
var nestedContentProps = entity.Properties.Where(x => x.PropertyType.PropertyEditorAlias == Constants.PropertyEditors.Aliases.NestedContent);
// Each NC Property on a doctype
foreach (var nestedContentProp in nestedContentProps)
{
// A NC Prop may have one or more values due to cultures
var propVals = nestedContentProp.Values;
foreach (var cultureVal in propVals)
{
// Remove keys from published value & any nested NC's
var updatedPublishedVal = CreateNestedContentKeys(cultureVal.PublishedValue?.ToString(), true);
cultureVal.PublishedValue = updatedPublishedVal;
// Remove keys from edited/draft value & any nested NC's
var updatedEditedVal = CreateNestedContentKeys(cultureVal.EditedValue?.ToString(), true);
cultureVal.EditedValue = updatedEditedVal;
}
}
}
}
public void Terminate()
{
ContentService.Copying -= ContentService_Copying;
ContentService.Saving -= ContentService_Saving;
ContentService.Publishing -= ContentService_Publishing;
}
private string CreateNestedContentKeys(string ncJson, bool onlyMissingKeys)
{
if (string.IsNullOrWhiteSpace(ncJson))
return ncJson;
// Convert JSON to JArray (two props we will know should exist are key & ncContentTypeAlias)
var ncItems = JArray.Parse(ncJson);
// Parse JSON
var ncJson = JToken.Parse(rawJson);
// NC prop contains one or more items/rows of things
foreach (var nestedContentItem in ncItems.Children<JObject>())
foreach (var nestedContentItem in ncJson.Children<JObject>())
{
// If saving/publishing - we only generate keys for NC items that are missing
if (onlyMissingKeys)
{
var ncKeyProp = nestedContentItem.Properties().SingleOrDefault(x => x.Name.ToLowerInvariant() == "key");
var ncKeyProp = nestedContentItem.Properties().SingleOrDefault(x => x.Name.InvariantEquals("key"));
if (ncKeyProp == null)
{
nestedContentItem.Properties().Append(new JProperty("key", Guid.NewGuid().ToString()));
}
}
foreach (var ncItemProp in nestedContentItem.Properties())
{
if(onlyMissingKeys == false)
if (onlyMissingKeys == false)
{
// Only when copying a node - we generate new keys for all NC items
if (ncItemProp.Name.InvariantEquals("key"))
@@ -139,23 +97,32 @@ namespace Umbraco.Web.Compose
}
// No need to check this property for JSON - as this is a JSON prop we know
// That onyl contains the string of the doctype alias used as the NC item
// That only contains the string of the doctype alias used as the NC item
if (ncItemProp.Name == NestedContentPropertyEditor.ContentTypeAliasPropertyKey)
continue;
// As we don't know what properties in the JSON may contain the nested NC
// As we don't know what properties in the JSON may contain other complex editors or deep nested NC
// We are detecting if its value stores JSON to help filter the list AND that in its JSON it has ncContentTypeAlias prop
var ncItemPropVal = ncItemProp.Value?.ToString();
if (ncItemPropVal.DetectIsJson() && ncItemPropVal.Contains(NestedContentPropertyEditor.ContentTypeAliasPropertyKey))
if (ncItemPropVal.DetectIsJson())
{
// Recurse & update this JSON property
ncItemProp.Value = CreateNestedContentKeys(ncItemPropVal, onlyMissingKeys);
// Parse the nested JSON (complex editor)
var complexEditorJson = JToken.Parse(ncItemPropVal);
// Verify the complex editor is nested content (Will have one or more ncContentTypeAlias)
// One for each NC item/row
var hasNestedContentJsonProp = complexEditorJson.SelectTokens($"$..['{NestedContentPropertyEditor.ContentTypeAliasPropertyKey}']", false);
if (hasNestedContentJsonProp.Count() > 0)
{
// Recurse & update this JSON property
ncItemProp.Value = CreateNestedContentKeys(ncItemPropVal, onlyMissingKeys);
}
}
}
}
return ncItems.ToString();
return ncJson.ToString();
}
}
}