Add DNC Registry for Omnichannels (#467)

Author: MikeAlhayek

CrestApps.OrchardCore.slnx

@@ -18,6 +18,8 @@
   <Folder Name="/src/Abstractions/">
     <Project Path="src/Abstractions/CrestApps.OrchardCore.Abstractions/CrestApps.OrchardCore.Abstractions.csproj" />
     <Project Path="src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions.csproj" />
+    <Project Path="src/Abstractions/CrestApps.OrchardCore.DncRegistry.Abstractions/CrestApps.OrchardCore.DncRegistry.Abstractions.csproj" />
+    <Project Path="src/Abstractions/CrestApps.OrchardCore.PhoneNumbers.Abstractions/CrestApps.OrchardCore.PhoneNumbers.Abstractions.csproj" />
     <Project Path="src/Abstractions/CrestApps.OrchardCore.Users.Abstractions/CrestApps.OrchardCore.Users.Abstractions.csproj" />
   </Folder>
   <Folder Name="/src/Core/">
@@ -59,13 +61,17 @@
     <Project Path="src/Modules/CrestApps.OrchardCore.AzureAIInference/CrestApps.OrchardCore.AzureAIInference.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.ContentAccessControl/CrestApps.OrchardCore.ContentAccessControl.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.ContentTransfer/CrestApps.OrchardCore.ContentTransfer.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.ContentTransfer.OpenXml/CrestApps.OrchardCore.ContentTransfer.OpenXml.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.DncRegistry.Azure/CrestApps.OrchardCore.DncRegistry.Azure.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.DncRegistry/CrestApps.OrchardCore.DncRegistry.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Ollama/CrestApps.OrchardCore.Ollama.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Omnichannel.EventGrid/CrestApps.OrchardCore.Omnichannel.EventGrid.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Omnichannel.Managements/CrestApps.OrchardCore.Omnichannel.Managements.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Omnichannel.Sms/CrestApps.OrchardCore.Omnichannel.Sms.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Omnichannel/CrestApps.OrchardCore.Omnichannel.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.OpenAI.Azure/CrestApps.OrchardCore.OpenAI.Azure.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.OpenAI/CrestApps.OrchardCore.OpenAI.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.PhoneNumbers/CrestApps.OrchardCore.PhoneNumbers.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Recipes/CrestApps.OrchardCore.Recipes.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Resources/CrestApps.OrchardCore.Resources.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.Roles/CrestApps.OrchardCore.Roles.csproj" />

Directory.Packages.props

@@ -12,6 +12,7 @@
     <PackageVersion Include="DocumentFormat.OpenXml" Version="3.5.1" />
     <PackageVersion Include="Elastic.Clients.Elasticsearch" Version="8.19.21" />
     <PackageVersion Include="Fluid.Core" Version="2.31.0" />
+    <PackageVersion Include="libphonenumber-csharp" Version="9.0.31" />
     <PackageVersion Include="JsonSchema.Net" Version="8.0.5" />
     <PackageVersion Include="Lucene.Net.Analysis.Common" Version="4.8.0-beta00017" />
     <PackageVersion Include="Markdig" Version="1.1.3" />
@@ -152,14 +153,15 @@
   </ItemGroup>
   <ItemGroup>
     <!-- Aspire Packages -->
-    <PackageVersion Include="Aspire.Hosting.AppHost" Version="13.3.5" />
+    <PackageVersion Include="Aspire.Hosting.AppHost" Version="13.4.2" />
     <PackageVersion Include="Aspire.Hosting.Elasticsearch" Version="13.3.0" />
-    <PackageVersion Include="Aspire.Hosting.Redis" Version="13.3.5" />
-    <PackageVersion Include="CommunityToolkit.Aspire.Hosting.Ollama" Version="13.3.0" />
+    <PackageVersion Include="Aspire.Hosting.Redis" Version="13.4.2" />
+    <PackageVersion Include="CommunityToolkit.Aspire.Hosting.Ollama" Version="13.4.0" />
   </ItemGroup>
   <ItemGroup>
     <!-- Transitive Packages -->
     <PackageVersion Include="MailKit" Version="4.16.0" />
+    <PackageVersion Include="Nerdbank.MessagePack" Version="1.2.4" />
   </ItemGroup>
   <ItemGroup>
     <!-- Sample Packages -->

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentFieldImportMapContext.cs

@@ -4,6 +4,8 @@ namespace CrestApps.OrchardCore.ContentTransfer;
 
 public sealed class ContentFieldImportMapContext : ImportContentFieldContext
 {
+    public ContentTransferEntry Entry { get; set; }
+
     public DataColumnCollection Columns { get; set; }
 
     public DataRow Row { get; set; }

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentImportRowFilterBatchContext.cs

@@ -0,0 +1,30 @@
+using OrchardCore.ContentManagement.Metadata.Models;
+
+namespace CrestApps.OrchardCore.ContentTransfer;
+
+/// <summary>
+/// Context passed to <see cref="IContentImportRowFilter.PrepareBatchAsync(ContentImportRowFilterBatchContext)"/>
+/// so a filter can preload state for the next import batch.
+/// </summary>
+public sealed class ContentImportRowFilterBatchContext
+{
+    /// <summary>
+    /// Gets or sets the content type definition for the import.
+    /// </summary>
+    public ContentTypeDefinition ContentTypeDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the content transfer entry associated with the import.
+    /// </summary>
+    public ContentTransferEntry Entry { get; set; }
+
+    /// <summary>
+    /// Gets or sets the rows that will be evaluated in the current batch.
+    /// </summary>
+    public IReadOnlyList<ContentImportRowFilterContext> Rows { get; set; }
+
+    /// <summary>
+    /// Gets or sets the cancellation token for the current batch operation.
+    /// </summary>
+    public CancellationToken CancellationToken { get; set; }
+}

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentImportRowFilterContext.cs

@@ -0,0 +1,40 @@
+using System.Data;
+using OrchardCore.ContentManagement.Metadata.Models;
+
+namespace CrestApps.OrchardCore.ContentTransfer;
+
+/// <summary>
+/// Context passed to <see cref="IContentImportRowFilter.ShouldSkipRowAsync"/> to evaluate a single row.
+/// </summary>
+public sealed class ContentImportRowFilterContext
+{
+    /// <summary>
+    /// Gets or sets the data row being evaluated.
+    /// </summary>
+    public DataRow Row { get; set; }
+
+    /// <summary>
+    /// Gets or sets the data columns in the file.
+    /// </summary>
+    public DataColumnCollection Columns { get; set; }
+
+    /// <summary>
+    /// Gets or sets the content type definition.
+    /// </summary>
+    public ContentTypeDefinition ContentTypeDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the content transfer entry associated with this import.
+    /// </summary>
+    public ContentTransferEntry Entry { get; set; }
+
+    /// <summary>
+    /// Gets or sets the row index (1-based).
+    /// </summary>
+    public int RowIndex { get; set; }
+
+    /// <summary>
+    /// Gets or sets the reason the row should be skipped.
+    /// </summary>
+    public string SkipReason { get; set; }
+}

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentImportRowFilterInitContext.cs

@@ -0,0 +1,19 @@
+using OrchardCore.ContentManagement.Metadata.Models;
+
+namespace CrestApps.OrchardCore.ContentTransfer;
+
+/// <summary>
+/// Context passed to <see cref="IContentImportRowFilter.InitializeAsync"/> before import processing begins.
+/// </summary>
+public sealed class ContentImportRowFilterInitContext
+{
+    /// <summary>
+    /// Gets or sets the content type definition.
+    /// </summary>
+    public ContentTypeDefinition ContentTypeDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the content transfer entry associated with this import.
+    /// </summary>
+    public ContentTransferEntry Entry { get; set; }
+}

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentPartImportMapContext.cs

@@ -7,6 +7,8 @@ public sealed class ContentPartImportMapContext : ImportContentPartContext
 {
     public ContentItem ContentItem { get; set; }
 
+    public ContentTransferEntry Entry { get; set; }
+
     public DataColumnCollection Columns { get; set; }
 
     public DataRow Row { get; set; }

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentTransferEntry.cs

@@ -69,13 +69,14 @@ public sealed class ContentTransferEntry : Entity
 
 public enum ContentTransferEntryStatus
 {
-    New,
-    Processing,
-    Completed,
-    CompletedWithErrors,
-    Canceled,
-    CanceledWithImportedRecords,
-    Failed,
+    New = 0,
+    Processing = 1,
+    Completed = 2,
+    CompletedWithErrors = 3,
+    Failed = 6,
+    Pending = 7,
+    Paused = 8,
+    Deleting = 9,
 }
 
 public enum ContentTransferDirection

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/ContentTransferEntryStatusExtensions.cs

@@ -0,0 +1,63 @@
+namespace CrestApps.OrchardCore.ContentTransfer;
+
+/// <summary>
+/// Provides helpers for interpreting import-specific content transfer entry statuses.
+/// </summary>
+public static class ContentTransferEntryStatusExtensions
+{
+    /// <summary>
+    /// Determines whether the status represents a queued import waiting to start.
+    /// </summary>
+    /// <param name="status">The status to evaluate.</param>
+    /// <returns><c>true</c> when the import is pending; otherwise, <c>false</c>.</returns>
+    public static bool IsPendingImport(this ContentTransferEntryStatus status)
+        => status == ContentTransferEntryStatus.Pending
+            || status == ContentTransferEntryStatus.New;
+
+    /// <summary>
+    /// Determines whether the status represents a paused import.
+    /// </summary>
+    /// <param name="status">The status to evaluate.</param>
+    /// <returns><c>true</c> when the import is paused; otherwise, <c>false</c>.</returns>
+    public static bool IsPausedImport(this ContentTransferEntryStatus status)
+        => status == ContentTransferEntryStatus.Paused;
+
+    /// <summary>
+    /// Determines whether the status can be resumed for import processing.
+    /// </summary>
+    /// <param name="status">The status to evaluate.</param>
+    /// <returns><c>true</c> when the import can be resumed; otherwise, <c>false</c>.</returns>
+    public static bool CanResumeImport(this ContentTransferEntryStatus status)
+        => status.IsPendingImport()
+            || status.IsPausedImport()
+            || status == ContentTransferEntryStatus.Failed;
+
+    /// <summary>
+    /// Determines whether the status should stop import processing.
+    /// </summary>
+    /// <param name="status">The status to evaluate.</param>
+    /// <returns><c>true</c> when background import processing should stop; otherwise, <c>false</c>.</returns>
+    public static bool ShouldStopImport(this ContentTransferEntryStatus status)
+        => status.IsPausedImport()
+            || status == ContentTransferEntryStatus.Deleting;
+
+    /// <summary>
+    /// Maps import statuses to the normalized status used by the admin UI.
+    /// </summary>
+    /// <param name="status">The status to normalize.</param>
+    /// <returns>The normalized import status for display and filtering.</returns>
+    public static ContentTransferEntryStatus NormalizeImportStatus(this ContentTransferEntryStatus status)
+    {
+        if (status.IsPendingImport())
+        {
+            return ContentTransferEntryStatus.Pending;
+        }
+
+        if (status.IsPausedImport())
+        {
+            return ContentTransferEntryStatus.Paused;
+        }
+
+        return status;
+    }
+}

src/Abstractions/CrestApps.OrchardCore.ContentTransfer.Abstractions/IContentImportRowFilter.cs

@@ -0,0 +1,40 @@
+#nullable enable
+
+using System.Data;
+using OrchardCore.ContentManagement.Metadata.Models;
+
+namespace CrestApps.OrchardCore.ContentTransfer;
+
+/// <summary>
+/// Filters rows during content import. Implementations can reject rows before
+/// they are processed by the import pipeline (e.g., duplicate detection, DNC list checks).
+/// </summary>
+public interface IContentImportRowFilter
+{
+    /// <summary>
+    /// Called once before import processing begins to allow the filter to initialize state
+    /// for the active import.
+    /// </summary>
+    /// <param name="context">The context containing the entry metadata and content type information.</param>
+    /// <returns>
+    /// <see langword="true"/> when the filter should participate in row filtering for the
+    /// current import; otherwise, <see langword="false"/>.
+    /// </returns>
+    Task<bool> InitializeAsync(ContentImportRowFilterInitContext context);
+
+    /// <summary>
+    /// Prepares filter state for the next import batch.
+    /// </summary>
+    /// <param name="context">The context containing the rows that are about to be evaluated.</param>
+    /// <returns>A task that completes when the batch state is ready.</returns>
+    Task PrepareBatchAsync(ContentImportRowFilterBatchContext context);
+
+    /// <summary>
+    /// Determines whether a row should be skipped during import.
+    /// </summary>
+    /// <param name="context">The context containing the row data, entry metadata, and content type information.</param>
+    /// <returns>
+    /// <c>true</c> if the row should be skipped; <c>false</c> if it should be processed normally.
+    /// </returns>
+    Task<bool> ShouldSkipRowAsync(ContentImportRowFilterContext context);
+}