Merged PR 5859: Add options for allowed parents;

Add options for allowed parents;
Clean up code with vs warnings

Author: EelmanE

Infocaster.Umbraco.DateFolders.Website/appsettings.json

@@ -24,10 +24,12 @@
     }
   },
   "DateFolders": {
-    "ItemDateProperty": "",
+    "ItemDateProperty": "publicationDate",
     "CreateDayFolders": false,
     "OrderByDescending": true,
     "FolderDocType": "dateFolder",
-    "ItemDocTypes": [ "contentPage" ]
+    "ItemDocTypes": [ "blogpost" ],
+    "AllowedParentIds": [ 2222 ],
+    "AllowedParentDocTypes": ["blog"]
   }
 }

README.md

@@ -38,7 +38,9 @@ After installing the package, just complete the configuration steps below and yo
     "CreateDayFolders": false,          
     "OrderByDescending": true,          
     "FolderDocType": "dateFolder",      
-    "ItemDocTypes": [ "contentPage" ]   
+    "ItemDocTypes": [ "contentPage" ],
+    "AllowedParentIds": [ 2222 ],
+    "AllowedParentDocTypes": ["blog"]
 }
 ```
 
@@ -47,6 +49,8 @@ After installing the package, just complete the configuration steps below and yo
 - **DateFolderDocType** | The doctype to use for creating the year/month/day folders. (e.g "DateFolder")
 - **CreateDayFolders** | Boolean indicating whether or not day folders should be created, if false only years and months are created.
 - **OrderByDecending** | Boolean indicating sort order for date folders (default: false)
+- **AllowedParentIds** | (Optional) The node id for the parent(s) to limit the creation of datefolders to. (e.g. 1234) - comma separated values are allowed for multiple note ids
+- **AllowedParentDocTypes** | (Optional) The doctype alias for the parent(s) to limit the creation of datefolders to. (e.g. "blog") - comma separated values are allowed for multiple doctype aliases
 
 ## Changelog
 Version 10.0.0

ReadMe.txt

@@ -15,14 +15,19 @@ Add the following configuration to your appsettings.json file:
     "CreateDayFolders": false,          
     "OrderByDescending": true,          
     "FolderDocType": "dateFolder",      
-    "ItemDocTypes": [ "contentPage" ]   
+    "ItemDocTypes": [ "contentPage" ],
+    "AllowedParentIds": [ 2222 ],
+    "AllowedParentDocTypes": ["blog"]
 }
 
 ItemDocType | The doctype alias to create datefolders for. (e.g. "contentPage") - comma separated values are allowed for multiple doctype aliases
 ItemDateProperty | The property of the itemDocType to read the date from. (e.g. "startDate") (don't add this key if you just want to use the document's create date)
 DateFolderDocType | The doctype to use for creating the year/month/day folders. (e.g "DateFolder")
 CreateDayFolders | Boolean indicating whether or not day folders should be created, if false only years and months are created.
 OrderByDecending | Boolean indicating sort order for date folders (default: false)
+AllowedParentIds | (Optional) The node id for the parent(s) to limit the creation of datefolders to. (e.g. 1234) - comma separated values are allowed for multiple note ids
+AllowedParentDocTypes | (Optional) The doctype alias for the parent(s) to limit the creation of datefolders to. (e.g. "blog") - comma separated values are allowed for multiple doctype aliases
+
 
 For more information, check out the links below:
 Github - https://github.com/Infocaster/Datefolders

src/Infocaster.Umbraco.DateFolders/Composers/DatefoldersComposer.cs

@@ -164,10 +164,16 @@ public DateFoldersContentSavedNotification(IOptions<DateFoldersConfigBase> optio
 
         public void Handle(ContentSavedNotification notification)
         {
-            foreach (var content in notification.SavedEntities)
+            foreach (IContent savedContent in notification.SavedEntities)
             {
+                // Fix for 'cannot save non-current version' error: https://our.umbraco.com/forum/using-umbraco-and-getting-started/99320-cannot-save-a-non-current-version
+                // Error occurs when no datefolders available yet and multiple items are moved into datefolders
+                IContent content = _contentService.GetById(savedContent.Id);
+
                 if (!_options.ItemDocTypes.Contains(content.ContentType.Alias)) continue;
 
+                if (!ParentValid(content)) continue;
+
                 IContentType folderDocType = _contentTypeService.Get(_options.FolderDocType);
                 if (folderDocType is not null)
                 {
@@ -176,9 +182,9 @@ public void Handle(ContentSavedNotification notification)
                         var date = GetItemDate(content, _options.ItemDateProperty);
                         IContent parent = _contentService.GetById(content.ParentId);
 
-                        IContent? monthFolder = null;
-                        IContent? yearFolder = null;
-                        IContent? dayFolder = null;
+                        IContent monthFolder = null;
+                        IContent yearFolder = null;
+                        IContent dayFolder = null;
 
                         bool dayChanged = false;
                         bool monthChanged;
@@ -196,9 +202,9 @@ public void Handle(ContentSavedNotification notification)
 
                                 dayChanged = date.Day.ToString("00") != dayFolder.Name;
                             }
-                            
+
                             yearFolder = _contentService.GetById(monthFolder.ParentId);
-                            
+
                             // Set item parent to source folder which contains the datefolders for sorting
                             parent = _contentService.GetById(yearFolder.ParentId);
 
@@ -214,7 +220,7 @@ public void Handle(ContentSavedNotification notification)
 
                         if (yearChanged || monthChanged || dayChanged)
                         {
-                            IContent? newDayFolder = null;
+                            IContent newDayFolder = null;
 
                             IContent newYearFolder = yearChanged || yearFolder is null ? GetOrCreateAndPublishDateFolder(_contentService, parent, date.Year.ToString(), content.CreatorId) : yearFolder;
                             IContent newMonthFolder = GetOrCreateAndPublishDateFolder(_contentService, newYearFolder, date.Month.ToString("00"), content.CreatorId);
@@ -256,7 +262,7 @@ public void Handle(ContentSavedNotification notification)
 
                             // Sort all content in folders by date
                             OrderChildrenByDateProperty(orderParent, _options.OrderByDescending, !string.IsNullOrEmpty(_options.ItemDateProperty) ? _options.ItemDateProperty : null);
-                            
+
                             // Sort all folders by name
                             OrderChildrenByName(parent, _options.OrderByDescending);
                             OrderChildrenByName(newYearFolder, _options.OrderByDescending);
@@ -292,7 +298,8 @@ private static DateTime GetItemDate(IContentBase content, string propertyAlias)
 
             if (content.HasProperty(propertyAlias))
             {
-                return content.GetValue<DateTime>(propertyAlias);
+                DateTime propertyDate = content.GetValue<DateTime>(propertyAlias);
+                return propertyDate == DateTime.MinValue ? content.CreateDate : propertyDate;
             }
             else
             {
@@ -310,7 +317,7 @@ private static DateTime GetItemDate(IContentBase content, string propertyAlias)
         /// <returns></returns>
         private IContent GetOrCreateAndPublishDateFolder(IContentService contentService, IContent parent, string nodeName, int currentUserId)
         {
-            IContent? content = null;
+            IContent content = null;
             var parentChildren = parent.GetAllChildren(_contentService);
 
             // Get first child of FolderDocType if it exists
@@ -338,7 +345,7 @@ private void OrderChildrenByName(IContent parent, bool orderByDesc)
         {
             try
             {
-                var allChildren = parent.GetAllChildren(_contentService); 
+                var allChildren = parent.GetAllChildren(_contentService);
 
                 var orderedChildren = (orderByDesc
                     ? allChildren.Where(c => int.TryParse(c.Name, out int i)).OrderByDescending(x => int.Parse(x.Name))
@@ -360,7 +367,7 @@ private void OrderChildrenByName(IContent parent, bool orderByDesc)
         /// <param name="parent"></param>
         /// <param name="orderByDesc"></param>
         /// <param name="propertyAlias"></param>
-        private void OrderChildrenByDateProperty(IContent parent, bool orderByDesc, string? propertyAlias = null)
+        private void OrderChildrenByDateProperty(IContent parent, bool orderByDesc, string propertyAlias = "")
         {
             try
             {
@@ -386,5 +393,16 @@ private void OrderChildrenByDateProperty(IContent parent, bool orderByDesc, stri
                 _logger.LogError(ex, "DateFolders OrderChildrenByDateProperty exception");
             }
         }
+
+        private bool ParentValid(IContent content)
+        {
+            if (!_options.AllowedParentIds.Any() && !_options.AllowedParentDocTypes.Any()) return true;
+
+            IContent parentContentItem = _contentService.GetAncestors(content).Reverse().FirstOrDefault(x => !x.ContentType.Alias.Equals(_options.FolderDocType));
+            if (_options.AllowedParentIds.Any() && _options.AllowedParentIds.Contains(parentContentItem.Id)) return true;
+            if (_options.AllowedParentDocTypes.Any() && _options.AllowedParentDocTypes.Contains(parentContentItem.ContentType.Alias)) return true;
+
+            return false;
+        }
     }
 }

src/Infocaster.Umbraco.DateFolders/Models/DateFoldersConfigBase.cs

@@ -5,6 +5,8 @@ namespace Infocaster.Umbraco.DateFolders.Models
     public class DateFoldersConfigBase
     {
         public List<string> ItemDocTypes { get; set; } = new List<string>();
+        public List<int> AllowedParentIds { get; set; } = new List<int>();
+        public List<string> AllowedParentDocTypes { get; set; } = new List<string>();
         public string FolderDocType { get; set; }
         public bool OrderByDescending { get; set; } = true;
         public bool CreateDayFolders { get; set; } = false;