Remove ImageType.Screenshot and ItemFields.Screenshot

jellyfin · Nov 6, 2021 · b4bf5af · b4bf5af
1 parent 0cd817b
commit b4bf5af
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 38 deletions.
diff --git a/Emby.Server.Implementations/Dto/DtoService.cs b/Emby.Server.Implementations/Dto/DtoService.cs
@@ -755,15 +755,6 @@ private void AttachBasicFields(BaseItemDto dto, BaseItem item, BaseItem owner, D
                 dto.BackdropImageTags = GetTagsAndFillBlurhashes(dto, item, ImageType.Backdrop, backdropLimit);
             }
 
-            if (options.ContainsField(ItemFields.ScreenshotImageTags))
-            {
-                var screenshotLimit = options.GetImageLimit(ImageType.Screenshot);
-                if (screenshotLimit > 0)
-                {
-                    dto.ScreenshotImageTags = GetTagsAndFillBlurhashes(dto, item, ImageType.Screenshot, screenshotLimit);
-                }
-            }
-
             if (options.ContainsField(ItemFields.Genres))
             {
                 dto.Genres = item.Genres;

diff --git a/MediaBrowser.Controller/Entities/BaseItem.cs b/MediaBrowser.Controller/Entities/BaseItem.cs
@@ -2577,7 +2577,7 @@ protected List<FileSystemMetadata> GetLocalMetadataFilesToDelete()
 
         public bool AllowsMultipleImages(ImageType type)
         {
-            return type == ImageType.Backdrop || type == ImageType.Screenshot || type == ImageType.Chapter;
+            return type == ImageType.Backdrop || type == ImageType.Chapter;
         }
 
         public Task SwapImagesAsync(ImageType type, int index1, int index2)

diff --git a/MediaBrowser.Model/Entities/ImageType.cs b/MediaBrowser.Model/Entities/ImageType.cs
@@ -1,3 +1,5 @@
+using System;
+
 namespace MediaBrowser.Model.Entities
 {
     /// <summary>
@@ -48,6 +50,7 @@ public enum ImageType
         /// <summary>
         /// The screenshot.
         /// </summary>
+        [Obsolete("Screenshot image type is no longer used.")]
         Screenshot = 8,
 
         /// <summary>

diff --git a/MediaBrowser.Model/Querying/ItemFields.cs b/MediaBrowser.Model/Querying/ItemFields.cs
@@ -1,5 +1,7 @@
 #pragma warning disable CS1591
 
+using System;
+
 namespace MediaBrowser.Model.Querying
 {
     /// <summary>
@@ -143,6 +145,7 @@ public enum ItemFields
         /// <summary>
         /// The screenshot image tags.
         /// </summary>
+        [Obsolete("Screenshot image type is no longer used.")]
         ScreenshotImageTags,
 
         SeriesPrimaryImage,

diff --git a/MediaBrowser.Providers/Manager/ImageSaver.cs b/MediaBrowser.Providers/Manager/ImageSaver.cs
@@ -439,9 +439,6 @@ private string GetStandardSavePath(BaseItem item, ImageType type, int? imageInde
                 case ImageType.Backdrop:
                     filename = GetBackdropSaveFilename(item.GetImages(type), "backdrop", "backdrop", imageIndex);
                     break;
-                case ImageType.Screenshot:
-                    filename = GetBackdropSaveFilename(item.GetImages(type), "screenshot", "screenshot", imageIndex);
-                    break;
                 default:
                     filename = type.ToString().ToLowerInvariant();
                     break;

diff --git a/MediaBrowser.Providers/Manager/ItemImageProvider.cs b/MediaBrowser.Providers/Manager/ItemImageProvider.cs
@@ -109,27 +109,20 @@ public bool ValidateImages(BaseItem item, IEnumerable<IImageProvider> providers,
                 oldBackdropImages = item.GetImages(ImageType.Backdrop).ToArray();
             }
 
-            var oldScreenshotImages = Array.Empty<ItemImageInfo>();
-            if (refreshOptions.IsReplacingImage(ImageType.Screenshot))
-            {
-                oldScreenshotImages = item.GetImages(ImageType.Screenshot).ToArray();
-            }
-
             var result = new RefreshResult { UpdateType = ItemUpdateType.None };
 
             var typeName = item.GetType().Name;
             var typeOptions = libraryOptions.GetTypeOptions(typeName) ?? new TypeOptions { Type = typeName };
 
             // track library limits, adding buffer to allow lazy replacing of current images
             var backdropLimit = typeOptions.GetLimit(ImageType.Backdrop) + oldBackdropImages.Length;
-            var screenshotLimit = typeOptions.GetLimit(ImageType.Screenshot) + oldScreenshotImages.Length;
             var downloadedImages = new List<ImageType>();
 
             foreach (var provider in providers)
             {
                 if (provider is IRemoteImageProvider remoteProvider)
                 {
-                    await RefreshFromProvider(item, remoteProvider, refreshOptions, typeOptions, backdropLimit, screenshotLimit, downloadedImages, result, cancellationToken).ConfigureAwait(false);
+                    await RefreshFromProvider(item, remoteProvider, refreshOptions, typeOptions, backdropLimit, downloadedImages, result, cancellationToken).ConfigureAwait(false);
                     continue;
                 }
 
@@ -145,11 +138,6 @@ public bool ValidateImages(BaseItem item, IEnumerable<IImageProvider> providers,
                 PruneImages(item, oldBackdropImages);
             }
 
-            if (oldScreenshotImages.Length > 0 && oldScreenshotImages.Length < item.GetImages(ImageType.Screenshot).Count())
-            {
-                PruneImages(item, oldScreenshotImages);
-            }
-
             return result;
         }
 
@@ -243,9 +231,8 @@ private bool HasImage(BaseItem item, ImageType type)
         /// <param name="images">The images.</param>
         /// <param name="savedOptions">The saved options.</param>
         /// <param name="backdropLimit">The backdrop limit.</param>
-        /// <param name="screenshotLimit">The screenshot limit.</param>
         /// <returns><c>true</c> if the specified item contains images; otherwise, <c>false</c>.</returns>
-        private bool ContainsImages(BaseItem item, List<ImageType> images, TypeOptions savedOptions, int backdropLimit, int screenshotLimit)
+        private bool ContainsImages(BaseItem item, List<ImageType> images, TypeOptions savedOptions, int backdropLimit)
         {
             // Using .Any causes the creation of a DisplayClass aka. variable capture
             for (var i = 0; i < _singularImages.Length; i++)
@@ -262,11 +249,6 @@ private bool ContainsImages(BaseItem item, List<ImageType> images, TypeOptions s
                 return false;
             }
 
-            if (images.Contains(ImageType.Screenshot) && item.GetImages(ImageType.Screenshot).Count() < screenshotLimit)
-            {
-                return false;
-            }
-
             return true;
         }
 
@@ -278,7 +260,6 @@ private bool ContainsImages(BaseItem item, List<ImageType> images, TypeOptions s
         /// <param name="refreshOptions">The refresh options.</param>
         /// <param name="savedOptions">The saved options.</param>
         /// <param name="backdropLimit">The backdrop limit.</param>
-        /// <param name="screenshotLimit">The screenshot limit.</param>
         /// <param name="downloadedImages">The downloaded images.</param>
         /// <param name="result">The result.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
@@ -289,7 +270,6 @@ private bool ContainsImages(BaseItem item, List<ImageType> images, TypeOptions s
             ImageRefreshOptions refreshOptions,
             TypeOptions savedOptions,
             int backdropLimit,
-            int screenshotLimit,
             ICollection<ImageType> downloadedImages,
             RefreshResult result,
             CancellationToken cancellationToken)
@@ -303,7 +283,7 @@ private bool ContainsImages(BaseItem item, List<ImageType> images, TypeOptions s
 
                 if (!refreshOptions.ReplaceAllImages &&
                     refreshOptions.ReplaceImages.Length == 0 &&
-                    ContainsImages(item, provider.GetSupportedImages(item).ToList(), savedOptions, backdropLimit, screenshotLimit))
+                    ContainsImages(item, provider.GetSupportedImages(item).ToList(), savedOptions, backdropLimit))
                 {
                     return;
                 }

diff --git a/tests/Jellyfin.Providers.Tests/Manager/ItemImageProviderTests.cs b/tests/Jellyfin.Providers.Tests/Manager/ItemImageProviderTests.cs
@@ -207,10 +207,8 @@ public void MergeImages_PopulatedItemWithGoodPathsAndSameNewImagesWithNewTimesta
         [Theory]
         [InlineData(ImageType.Primary, 1, false)]
         [InlineData(ImageType.Backdrop, 2, false)]
-        [InlineData(ImageType.Screenshot, 2, false)]
         [InlineData(ImageType.Primary, 1, true)]
         [InlineData(ImageType.Backdrop, 2, true)]
-        [InlineData(ImageType.Screenshot, 2, true)]
         public async void RefreshImages_PopulatedItemPopulatedProviderDynamic_UpdatesImagesIfForced(ImageType imageType, int imageCount, bool forceRefresh)
         {
             var item = GetItemWithImages(imageType, imageCount, false);