New: Record Import Exclusion reasons (#14)

Author: sampulsar

frontend/src/Settings/ImportLists/ImportListExclusions/ImportListExclusionRow.tsx

@@ -20,8 +20,15 @@ interface ImportListExclusionRowProps extends ImportListExclusion {
 }
 
 function ImportListExclusionRow(props: ImportListExclusionRowProps) {
-  const { id, foreignId, type, movieTitle, isSelected, onSelectedChange } =
-    props;
+  const {
+    id,
+    foreignId,
+    type,
+    reason,
+    movieTitle,
+    isSelected,
+    onSelectedChange,
+  } = props;
 
   const dispatch = useDispatch();
 
@@ -52,6 +59,7 @@ function ImportListExclusionRow(props: ImportListExclusionRowProps) {
       <TableRowCell>{movieTitle}</TableRowCell>
       <TableRowCell className={styles.foreignId}>{foreignId}</TableRowCell>
       <TableRowCell>{type}</TableRowCell>
+      <TableRowCell>{reason}</TableRowCell>
 
       <TableRowCell className={styles.actions}>
         <IconButton

frontend/src/Settings/ImportLists/ImportListExclusions/ImportListExclusions.tsx

@@ -60,6 +60,12 @@ const COLUMNS: Column[] = [
     isVisible: true,
     isSortable: true,
   },
+  {
+    name: 'reason',
+    label: () => translate('Reason'),
+    isVisible: true,
+    isSortable: true,
+  },
   {
     className: styles.actions,
     name: 'actions',
@@ -255,7 +261,7 @@ function ImportListExclusions() {
             })}
 
             <TableRow>
-              <TableRowCell colSpan={4}>
+              <TableRowCell colSpan={5}>
                 <SpinnerButton
                   kind={kinds.DANGER}
                   isSpinning={isDeleting}

frontend/src/typings/ImportListExclusion.ts

@@ -4,4 +4,5 @@ export default interface ImportListExclusion extends ModelBase {
   foreignId: string;
   movieTitle: string;
   type: string;
+  reason: string;
 }

src/NzbDrone.Core/Datastore/Migration/014_import_exclusion_reason.cs

@@ -0,0 +1,15 @@
+using FluentMigrator;
+using NzbDrone.Core.Datastore.Migration.Framework;
+
+namespace NzbDrone.Core.Datastore.Migration
+{
+    [Migration(014)]
+    public class import_exclusion_reason : NzbDroneMigrationBase
+    {
+        protected override void MainDbUpgrade()
+        {
+            // Add 'Reason' column to 'ImportExclusions' table with default value 0 (Manual)
+            Alter.Table("ImportExclusions").AddColumn("Reason").AsInt32().WithDefaultValue(0);
+        }
+    }
+}

src/NzbDrone.Core/ImportLists/ImportExclusions/ImportExclusionReason.cs

@@ -0,0 +1,12 @@
+namespace NzbDrone.Core.ImportLists.ImportExclusions
+{
+    public enum ImportExclusionReason
+    {
+        Manual,
+        DuringDelete,
+        PerformerExclusion,
+        StudioExclusion,
+        StudioAfterDate,
+        TagExclusion
+    }
+}

src/NzbDrone.Core/ImportLists/ImportExclusions/ImportListExclusion.cs

@@ -4,13 +4,19 @@ namespace NzbDrone.Core.ImportLists.ImportExclusions
 {
     public class ImportListExclusion : ModelBase
     {
+        public ImportListExclusion()
+        {
+            Reason = ImportExclusionReason.Manual;
+        }
+
         public string ForeignId { get; set; }
         public string MovieTitle { get; set; }
         public ImportExclusionType Type { get; set; }
+        public ImportExclusionReason Reason { get; set; }
 
         public new string ToString()
         {
-            return string.Format("Exclusion: [{0}][{1}][{2}]", Type, ForeignId, MovieTitle);
+            return string.Format("Exclusion: [{0}-{1}] [{2}] [{3}]", Type, Reason, ForeignId, MovieTitle);
         }
     }
 }

src/NzbDrone.Core/Movies/AddMovieService.cs

@@ -263,6 +263,7 @@ private Movie SetPropertiesAndValidate(Movie newMovie)
                     {
                         if (_configService.WhisparrAlwaysExcludeStudiosTag.IsNullOrWhiteSpace())
                         {
+                            newExclusion.Reason = ImportExclusionReason.StudioExclusion;
                             _importListExclusionService.AddExclusion(newExclusion);
                             throw new ValidationException($"Studio: [{newMovie.MovieMetadata.Value.Studio.Title}] has been excluded");
                         }
@@ -288,6 +289,7 @@ private Movie SetPropertiesAndValidate(Movie newMovie)
                             {
                                 if (_configService.WhisparrAlwaysExcludeStudiosAfterTag.IsNullOrWhiteSpace())
                                 {
+                                    newExclusion.Reason = ImportExclusionReason.StudioAfterDate;
                                     _importListExclusionService.AddExclusion(newExclusion);
                                     throw new ValidationException($"Studio After Date: [{newMovie.MovieMetadata.Value.Studio.Title}] has an after date of {dateTime.ToString("yyyy-MM-dd")}. Marking movie as unmonitored.");
                                 }
@@ -316,6 +318,7 @@ private Movie SetPropertiesAndValidate(Movie newMovie)
                     {
                         if (_configService.WhisparrAlwaysExcludePerformersTag.IsNullOrWhiteSpace())
                         {
+                            newExclusion.Reason = ImportExclusionReason.PerformerExclusion;
                             _importListExclusionService.AddExclusion(newExclusion);
                             throw new ValidationException($"Performer: [{string.Join(",", excludedPerformers.Select(ep => ep.ToString()).ToList())}] has been excluded");
                         }
@@ -351,6 +354,7 @@ private Movie SetPropertiesAndValidate(Movie newMovie)
                 {
                     if (_configService.WhisparrAlwaysExcludeTagsTag.IsNullOrWhiteSpace())
                     {
+                        newExclusion.Reason = ImportExclusionReason.TagExclusion;
                         _importListExclusionService.AddExclusion(newExclusion);
                         throw new ValidationException($"Tag(s): [{string.Join(",", exclusions.Select(et => et.ToString()).ToList())}] excluded");
                     }

src/Whisparr.Api.V3/ImportLists/ImportListExclusionController.cs

@@ -98,7 +98,8 @@ public PagingResource<ImportListExclusionResource> GetImportListExclusionsPaged(
                     "id",
                     "foreignId",
                     "movieTitle",
-                    "movieYear"
+                    "type",
+                    "reason"
                 },
                 "id",
                 SortDirection.Descending);

src/Whisparr.Api.V3/ImportLists/ImportListExclusionResource.cs

@@ -10,6 +10,7 @@ public class ImportListExclusionResource : ProviderResource<ImportListExclusionR
         public string ForeignId { get; set; }
         public string MovieTitle { get; set; }
         public ImportExclusionType Type { get; set; }
+        public ImportExclusionReason Reason { get; set; }
     }
 
     public static class ImportListExclusionResourceMapper
@@ -27,6 +28,7 @@ public static ImportListExclusionResource ToResource(this ImportListExclusion mo
                 ForeignId = model.ForeignId,
                 MovieTitle = model.MovieTitle,
                 Type = model.Type,
+                Reason = model.Reason,
             };
         }
 
@@ -43,6 +45,7 @@ public static ImportListExclusion ToModel(this ImportListExclusionResource resou
                 ForeignId = resource.ForeignId,
                 MovieTitle = resource.MovieTitle,
                 Type = resource.Type,
+                Reason = resource.Reason,
             };
         }
 

src/Whisparr.Api.V3/Performers/PerformerController.cs

@@ -206,6 +206,7 @@ public void DeletePerformer(int id, bool deleteFiles = false, bool addImportExcl
                 exclusion.ForeignId = performer.ForeignId;
                 exclusion.MovieTitle = performer.Name;
                 exclusion.Type = ImportExclusionType.Performer;
+                exclusion.Reason = ImportExclusionReason.DuringDelete;
 
                 _exclusionService.AddExclusion(exclusion);
             }