Stub implementation of sign provider for documents with a scheduled publish pending.

Author: AndyButland

src/Umbraco.Cms.Api.Management/Controllers/Tree/EntityTreeControllerBase.cs

@@ -147,7 +147,7 @@ protected virtual TItem[] MapTreeItemViewModels(Guid? parentKey, IEntitySlim[] e
 
     protected virtual async Task PopulateSigns(TItem[] treeItemViewModels, IEnumerable<IEntitySlim> entities)
     {
-        foreach (ISignProvider signProvider in _signProviders)
+        foreach (ISignProvider signProvider in _signProviders.Where(x => x.CanProvideTreeSigns<TItem>()))
         {
             await signProvider.PopulateTreeSignsAsync(treeItemViewModels, entities);
         }

src/Umbraco.Cms.Api.Management/DependencyInjection/UmbracoBuilder.Collections.cs

@@ -0,0 +1,24 @@
+using Umbraco.Cms.Api.Management.Services.Signs;
+using Umbraco.Cms.Core.DependencyInjection;
+
+namespace Umbraco.Extensions
+{
+    /// <summary>
+    /// Extension methods for <see cref="IUmbracoBuilder"/> for the Umbraco back office
+    /// </summary>
+    public static partial class UmbracoBuilderExtensions
+    {
+        internal static void AddCollectionBuilders(this IUmbracoBuilder builder)
+        {
+            builder.SignProviders()
+                .Append<HasScheduleSignProvider>();
+        }
+
+        /// <summary>
+        /// Gets the sign providers collection builder.
+        /// </summary>
+        /// <param name="builder">The builder.</param>
+        public static SignProviderCollectionBuilder SignProviders(this IUmbracoBuilder builder)
+            => builder.WithCollectionBuilder<SignProviderCollectionBuilder>();
+    }
+}

src/Umbraco.Cms.Api.Management/DependencyInjection/UmbracoBuilderExtensions.cs

@@ -7,11 +7,9 @@
 using Umbraco.Cms.Api.Management.Routing;
 using Umbraco.Cms.Api.Management.Serialization;
 using Umbraco.Cms.Api.Management.Services;
-using Umbraco.Cms.Api.Management.Services.Signs;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Services;
-using Umbraco.Cms.Core.Services.Filters;
 using Umbraco.Cms.Web.Common.ApplicationBuilder;
 
 namespace Umbraco.Extensions;
@@ -97,15 +95,8 @@ public static IUmbracoBuilder AddUmbracoManagementApi(this IUmbracoBuilder build
             });
         }
 
-        builder.SignProviders();
+        builder.AddCollectionBuilders();
 
         return builder;
     }
-
-    /// <summary>
-    /// Gets the sign providers collection builder.
-    /// </summary>
-    /// <param name="builder">The builder.</param>
-    public static SignProviderCollectionBuilder SignProviders(this IUmbracoBuilder builder)
-        => builder.WithCollectionBuilder<SignProviderCollectionBuilder>();
 }

src/Umbraco.Cms.Api.Management/Services/Signs/HasScheduleSignProvider.cs

@@ -0,0 +1,37 @@
+using Umbraco.Cms.Api.Management.ViewModels.Tree;
+using Umbraco.Cms.Core.Models.Entities;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Extensions;
+
+namespace Umbraco.Cms.Api.Management.Services.Signs;
+
+/// <summary>
+/// Implements a <see cref="SignProviderCollection"/> that provides signs for content items that have a schedule.
+/// </summary>
+internal class HasScheduleSignProvider : ISignProvider
+{
+    private const string Alias = "ScheduledForPublish";
+
+    private readonly IContentService _contentService;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="HasScheduleSignProvider"/> class.
+    /// </summary>
+    public HasScheduleSignProvider(IContentService contentService) => _contentService = contentService;
+
+    /// <inheritdoc/>
+    public bool CanProvideTreeSigns<TItem>() => typeof(TItem) == typeof(DocumentTreeItemResponseModel);
+
+    /// <inheritdoc/>
+    public Task PopulateTreeSignsAsync<TItem>(TItem[] treeItemViewModels, IEnumerable<IEntitySlim> entities)
+        where TItem : EntityTreeItemResponseModel, new()
+    {
+        IEnumerable<Guid> contentKeysScheduledForPublishing = _contentService.GetScheduledContentKeys(treeItemViewModels.Select(x => x.Id));
+        foreach (Guid key in contentKeysScheduledForPublishing)
+        {
+            treeItemViewModels.First(x => x.Id == key).AddSign(Core.Constants.System.UmbracoSignProvider, Alias);
+        }
+
+        return Task.CompletedTask;
+    }
+}

src/Umbraco.Cms.Api.Management/Services/Signs/ISignProvider.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics.Eventing.Reader;
 using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Core.Models.Entities;
 
@@ -8,6 +9,13 @@ namespace Umbraco.Cms.Api.Management.Services.Signs;
 /// </summary>
 public interface ISignProvider
 {
+    /// <summary>
+    /// Gets a value indicating whether this provider can provide tree signs for the specified item type.
+    /// </summary>
+    /// <typeparam name="TItem">Type of tree item view model.</typeparam>
+    /// <returns></returns>
+    bool CanProvideTreeSigns<TItem>();
+
     /// <summary>
     /// Populates the provided tree item view models with signs.
     /// </summary>

src/Umbraco.Cms.Api.Management/ViewModels/Tree/EntityTreeItemResponseModel.cs

@@ -2,9 +2,15 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Tree;
 
 public class EntityTreeItemResponseModel : TreeItemPresentationModel
 {
+    private readonly List<SignModel> _signs = [];
+
     public Guid Id { get; set; }
 
     public ReferenceByIdModel? Parent { get; set; }
 
-    public IEnumerable<SignModel> Signs { get; set; } = [];
+    public IEnumerable<SignModel> Signs => _signs.AsEnumerable();
+
+    public void AddSign(string provider, string alias) => _signs.Add(new SignModel { Provider = provider, Alias = alias });
+
+    public void RemoveSign(string provider, string alias) => _signs.RemoveAll(x => x.Provider == provider && x.Alias == alias);
 }

src/Umbraco.Core/Constants-System.cs

@@ -115,5 +115,10 @@ public static class System
         public const string DataDirectoryPlaceholder = "|DataDirectory|";
 
         public const string InvariantCulture = "*";
+
+        /// <summary>
+        /// The provider name for Umbraco core backoffice tree and collection signs.
+        /// </summary>
+        public const string UmbracoSignProvider = "umbCore";
     }
 }

src/Umbraco.Core/Services/IContentService.cs

@@ -275,6 +275,15 @@ IContent CreateBlueprintFromContent(IContent blueprint, string name, int userId
     /// </summary>
     bool HasChildren(int id);
 
+    /// <summary>
+    ///     Gets the content Ids from the provided collection of content Ids that are scheduled for publishing.
+    /// </summary>
+    /// <param name="keys">The content keys </param>
+    /// <returns>
+    ///     The provided collection of content Ids filtered for those that are scheduled for publishing.
+    /// </returns>
+    IEnumerable<Guid> GetScheduledContentKeys(IEnumerable<Guid> keys) => keys.Count() > 0 ? [keys.First()] : [];
+
     #endregion
 
     #region Save, Delete Document