using System; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Net; using System.Net.Http; using System.Text; using System.Text.RegularExpressions; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Configuration; using MediaBrowser.Model.Drawing; using MediaBrowser.Model.Entities; using MediaBrowser.Model.IO; using MediaBrowser.Model.MediaInfo; using MediaBrowser.Model.Providers; using MediaBrowser.Providers.Manager; using Microsoft.Extensions.Logging.Abstractions; using Moq; using Xunit; namespace Jellyfin.Providers.Tests.Manager { public class ItemImageProviderTests { private const string TestDataImagePath = "Test Data/Images/blank{0}.jpg"; [Fact] public void ValidateImages_PhotoEmptyProviders_NoChange() { var itemImageProvider = GetItemImageProvider(null, null); var changed = itemImageProvider.ValidateImages(new Photo(), Enumerable.Empty(), null); Assert.False(changed); } [Fact] public void ValidateImages_EmptyItemEmptyProviders_NoChange() { ValidateImages_Test(ImageType.Primary, 0, true, 0, false, 0); } private static TheoryData GetImageTypesWithCount() { var theoryTypes = new TheoryData { // minimal test cases that hit different handling { ImageType.Primary, 1 }, { ImageType.Backdrop, 2 } }; return theoryTypes; } [Theory] [MemberData(nameof(GetImageTypesWithCount))] public void ValidateImages_EmptyItemAndPopulatedProviders_AddsImages(ImageType imageType, int imageCount) { ValidateImages_Test(imageType, 0, true, imageCount, true, imageCount); } [Theory] [MemberData(nameof(GetImageTypesWithCount))] public void ValidateImages_PopulatedItemWithGoodPathsAndEmptyProviders_NoChange(ImageType imageType, int imageCount) { ValidateImages_Test(imageType, imageCount, true, 0, false, imageCount); } [Theory] [MemberData(nameof(GetImageTypesWithCount))] public void ValidateImages_PopulatedItemWithBadPathsAndEmptyProviders_RemovesImage(ImageType imageType, int imageCount) { ValidateImages_Test(imageType, imageCount, false, 0, true, 0); } private void ValidateImages_Test(ImageType imageType, int initialImageCount, bool initialPathsValid, int providerImageCount, bool expectedChange, int expectedImageCount) { var item = GetItemWithImages(imageType, initialImageCount, initialPathsValid); var imageProvider = GetImageProvider(imageType, providerImageCount, true); var itemImageProvider = GetItemImageProvider(null, null); var actualChange = itemImageProvider.ValidateImages(item, new[] { imageProvider }, null); Assert.Equal(expectedChange, actualChange); Assert.Equal(expectedImageCount, item.GetImages(imageType).Count()); } [Fact] public void MergeImages_EmptyItemNewImagesEmpty_NoChange() { var itemImageProvider = GetItemImageProvider(null, null); var changed = itemImageProvider.MergeImages(new Video(), Array.Empty()); Assert.False(changed); } [Theory] [MemberData(nameof(GetImageTypesWithCount))] public void MergeImages_PopulatedItemWithGoodPathsAndPopulatedNewImages_AddsUpdatesImages(ImageType imageType, int imageCount) { // valid and not valid paths - should replace the valid paths with the invalid ones var item = GetItemWithImages(imageType, imageCount, true); var images = GetImages(imageType, imageCount, false); var itemImageProvider = GetItemImageProvider(null, null); var changed = itemImageProvider.MergeImages(item, images); Assert.True(changed); // adds for types that allow multiple, replaces singular type images if (item.AllowsMultipleImages(imageType)) { Assert.Equal(imageCount * 2, item.GetImages(imageType).Count()); } else { Assert.Single(item.GetImages(imageType)); Assert.Same(images[0].FileInfo.FullName, item.GetImages(imageType).First().Path); } } [Theory] [InlineData(ImageType.Primary, 1, false)] [InlineData(ImageType.Backdrop, 2, false)] [InlineData(ImageType.Primary, 1, true)] [InlineData(ImageType.Backdrop, 2, true)] public void MergeImages_PopulatedItemWithGoodPathsAndSameNewImages_ResetIfTimeChanges(ImageType imageType, int imageCount, bool updateTime) { var oldTime = new DateTime(1970, 1, 1); var updatedTime = updateTime ? new DateTime(2021, 1, 1) : oldTime; var fileSystem = new Mock(); fileSystem.Setup(fs => fs.GetLastWriteTimeUtc(It.IsAny())) .Returns(updatedTime); BaseItem.FileSystem = fileSystem.Object; // all valid paths - matching for strictly updating var item = GetItemWithImages(imageType, imageCount, true); // set size to non-zero to allow for image size reset to occur foreach (var image in item.GetImages(imageType)) { image.DateModified = oldTime; image.Height = 1; image.Width = 1; } var images = GetImages(imageType, imageCount, true); var itemImageProvider = GetItemImageProvider(null, fileSystem); var changed = itemImageProvider.MergeImages(item, images); if (updateTime) { Assert.True(changed); // before and after paths are the same, verify updated by size reset to 0 Assert.Equal(imageCount, item.GetImages(imageType).Count()); foreach (var image in item.GetImages(imageType)) { Assert.Equal(updatedTime, image.DateModified); Assert.Equal(0, image.Height); Assert.Equal(0, image.Width); } } else { Assert.False(changed); } } [Theory] [InlineData(ImageType.Primary, 1, false)] [InlineData(ImageType.Backdrop, 2, false)] [InlineData(ImageType.Primary, 1, true)] [InlineData(ImageType.Backdrop, 2, true)] public async void RefreshImages_PopulatedItemPopulatedProviderDynamic_UpdatesImagesIfForced(ImageType imageType, int imageCount, bool forceRefresh) { var item = GetItemWithImages(imageType, imageCount, false); var libraryOptions = GetLibraryOptions(item, imageType, imageCount); var imageResponse = new DynamicImageResponse { HasImage = true, Format = ImageFormat.Jpg, Path = "url path", Protocol = MediaProtocol.Http }; var dynamicProvider = new Mock(MockBehavior.Strict); dynamicProvider.Setup(rp => rp.Name).Returns("MockDynamicProvider"); dynamicProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); dynamicProvider.Setup(rp => rp.GetImage(item, imageType, It.IsAny())) .ReturnsAsync(imageResponse); var refreshOptions = forceRefresh ? new ImageRefreshOptions(Mock.Of()) { ImageRefreshMode = MetadataRefreshMode.FullRefresh, ReplaceAllImages = true } : new ImageRefreshOptions(Mock.Of()); var itemImageProvider = GetItemImageProvider(null, new Mock()); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { dynamicProvider.Object }, refreshOptions, CancellationToken.None); Assert.Equal(forceRefresh, result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); if (forceRefresh) { // replaces multi-types Assert.Single(item.GetImages(imageType)); } else { // adds to multi-types if room Assert.Equal(imageCount, item.GetImages(imageType).Count()); } } [Theory] [InlineData(ImageType.Primary, 1, true, MediaProtocol.Http)] [InlineData(ImageType.Backdrop, 2, true, MediaProtocol.Http)] [InlineData(ImageType.Primary, 1, true, MediaProtocol.File)] [InlineData(ImageType.Backdrop, 2, true, MediaProtocol.File)] [InlineData(ImageType.Primary, 1, false, MediaProtocol.File)] [InlineData(ImageType.Backdrop, 2, false, MediaProtocol.File)] public async void RefreshImages_EmptyItemPopulatedProviderDynamic_AddsImages(ImageType imageType, int imageCount, bool responseHasPath, MediaProtocol protocol) { // Has to exist for querying DateModified time on file, results stored but not checked so not populating BaseItem.FileSystem = Mock.Of(); var item = new Video(); var libraryOptions = GetLibraryOptions(item, imageType, imageCount); // Path must exist if set: is read in as a stream by AsyncFile.OpenRead var imageResponse = new DynamicImageResponse { HasImage = true, Format = ImageFormat.Jpg, Path = responseHasPath ? string.Format(CultureInfo.InvariantCulture, TestDataImagePath, 0) : null, Protocol = protocol }; var dynamicProvider = new Mock(MockBehavior.Strict); dynamicProvider.Setup(rp => rp.Name).Returns("MockDynamicProvider"); dynamicProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); dynamicProvider.Setup(rp => rp.GetImage(item, imageType, It.IsAny())) .ReturnsAsync(imageResponse); var refreshOptions = new ImageRefreshOptions(Mock.Of()); var providerManager = new Mock(MockBehavior.Strict); providerManager.Setup(pm => pm.SaveImage(item, It.IsAny(), It.IsAny(), imageType, null, It.IsAny())) .Callback((callbackItem, _, _, callbackType, _, _) => callbackItem.SetImagePath(callbackType, 0, new FileSystemMetadata())) .Returns(Task.CompletedTask); var itemImageProvider = GetItemImageProvider(providerManager.Object, null); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { dynamicProvider.Object }, refreshOptions, CancellationToken.None); Assert.True(result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); // dynamic provider unable to return multiple images Assert.Single(item.GetImages(imageType)); if (protocol == MediaProtocol.Http) { Assert.Equal(imageResponse.Path, item.GetImagePath(imageType, 0)); } } [Theory] [InlineData(ImageType.Primary, 1, false)] [InlineData(ImageType.Backdrop, 1, false)] [InlineData(ImageType.Backdrop, 2, false)] [InlineData(ImageType.Primary, 1, true)] [InlineData(ImageType.Backdrop, 1, true)] [InlineData(ImageType.Backdrop, 2, true)] public async void RefreshImages_PopulatedItemPopulatedProviderRemote_UpdatesImagesIfForced(ImageType imageType, int imageCount, bool forceRefresh) { var item = GetItemWithImages(imageType, imageCount, false); var libraryOptions = GetLibraryOptions(item, imageType, imageCount); var remoteProvider = new Mock(MockBehavior.Strict); remoteProvider.Setup(rp => rp.Name).Returns("MockRemoteProvider"); remoteProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); var refreshOptions = forceRefresh ? new ImageRefreshOptions(Mock.Of()) { ImageRefreshMode = MetadataRefreshMode.FullRefresh, ReplaceAllImages = true } : new ImageRefreshOptions(Mock.Of()); var remoteInfo = new RemoteImageInfo[imageCount]; for (int i = 0; i < imageCount; i++) { remoteInfo[i] = new RemoteImageInfo { Type = imageType, Url = "image url " + i }; } var providerManager = new Mock(MockBehavior.Strict); providerManager.Setup(pm => pm.GetAvailableRemoteImages(It.IsAny(), It.IsAny(), It.IsAny())) .ReturnsAsync(remoteInfo); var itemImageProvider = GetItemImageProvider(providerManager.Object, new Mock()); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { remoteProvider.Object }, refreshOptions, CancellationToken.None); Assert.Equal(forceRefresh, result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); Assert.Equal(imageCount, item.GetImages(imageType).Count()); foreach (var image in item.GetImages(imageType)) { if (forceRefresh) { Assert.Matches(@"image url [0-9]", image.Path); } else { Assert.DoesNotMatch(@"image url [0-9]", image.Path); } } } [Theory] [InlineData(ImageType.Primary, 0, false)] // singular type only fetches if type is missing from item, no caching [InlineData(ImageType.Backdrop, 0, false)] // empty item, no cache to check [InlineData(ImageType.Backdrop, 1, false)] // populated item, cached so no download [InlineData(ImageType.Backdrop, 1, true)] // populated item, forced to download public async void RefreshImages_NonStubItemPopulatedProviderRemote_DownloadsIfNecessary(ImageType imageType, int initialImageCount, bool fullRefresh) { var targetImageCount = 1; // Set path and media source manager so images will be downloaded (EnableImageStub will return false) var item = GetItemWithImages(imageType, initialImageCount, false); item.Path = "non-empty path"; BaseItem.MediaSourceManager = Mock.Of(); // seek 2 so it won't short-circuit out of downloading when populated var libraryOptions = GetLibraryOptions(item, imageType, 2); const string Content = "Content"; var remoteProvider = new Mock(MockBehavior.Strict); remoteProvider.Setup(rp => rp.Name).Returns("MockRemoteProvider"); remoteProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); remoteProvider.Setup(rp => rp.GetImageResponse(It.IsAny(), It.IsAny())) .ReturnsAsync((string url, CancellationToken _) => new HttpResponseMessage { ReasonPhrase = url, StatusCode = HttpStatusCode.OK, Content = new StringContent(Content, Encoding.UTF8, "image/jpeg") }); var refreshOptions = fullRefresh ? new ImageRefreshOptions(Mock.Of()) { ImageRefreshMode = MetadataRefreshMode.FullRefresh, ReplaceAllImages = true } : new ImageRefreshOptions(Mock.Of()); var remoteInfo = new RemoteImageInfo[targetImageCount]; for (int i = 0; i < targetImageCount; i++) { remoteInfo[i] = new RemoteImageInfo { Type = imageType, Url = "image url " + i }; } var providerManager = new Mock(MockBehavior.Strict); providerManager.Setup(pm => pm.GetAvailableRemoteImages(It.IsAny(), It.IsAny(), It.IsAny())) .ReturnsAsync(remoteInfo); providerManager.Setup(pm => pm.SaveImage(item, It.IsAny(), It.IsAny(), imageType, null, It.IsAny())) .Callback((callbackItem, _, _, callbackType, _, _) => callbackItem.SetImagePath(callbackType, callbackItem.AllowsMultipleImages(callbackType) ? callbackItem.GetImages(callbackType).Count() : 0, new FileSystemMetadata())) .Returns(Task.CompletedTask); var fileSystem = new Mock(); // match reported file size to image content length - condition for skipping already downloaded multi-images fileSystem.Setup(fs => fs.GetFileInfo(It.IsAny())) .Returns(new FileSystemMetadata { Length = Content.Length }); var itemImageProvider = GetItemImageProvider(providerManager.Object, fileSystem); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { remoteProvider.Object }, refreshOptions, CancellationToken.None); Assert.Equal(initialImageCount == 0 || fullRefresh, result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); Assert.Equal(targetImageCount, item.GetImages(imageType).Count()); } [Theory] [MemberData(nameof(GetImageTypesWithCount))] public async void RefreshImages_EmptyItemPopulatedProviderRemoteExtras_LimitsImages(ImageType imageType, int imageCount) { var item = new Video(); var libraryOptions = GetLibraryOptions(item, imageType, imageCount); var remoteProvider = new Mock(MockBehavior.Strict); remoteProvider.Setup(rp => rp.Name).Returns("MockRemoteProvider"); remoteProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); var refreshOptions = new ImageRefreshOptions(Mock.Of()); // populate remote with double the required images to verify count is trimmed to the library option count var remoteInfoCount = imageCount * 2; var remoteInfo = new RemoteImageInfo[remoteInfoCount]; for (int i = 0; i < remoteInfoCount; i++) { remoteInfo[i] = new RemoteImageInfo { Type = imageType, Url = "image url " + i }; } var providerManager = new Mock(MockBehavior.Strict); providerManager.Setup(pm => pm.GetAvailableRemoteImages(It.IsAny(), It.IsAny(), It.IsAny())) .ReturnsAsync(remoteInfo); var itemImageProvider = GetItemImageProvider(providerManager.Object, null); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { remoteProvider.Object }, refreshOptions, CancellationToken.None); Assert.True(result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); var actualImages = item.GetImages(imageType).ToList(); Assert.Equal(imageCount, actualImages.Count); // images from the provider manager are sorted by preference (earlier images are higher priority) so we can verify that low url numbers are chosen foreach (var image in actualImages) { var index = int.Parse(Regex.Match(image.Path, @"[0-9]+").Value, NumberStyles.Integer, CultureInfo.InvariantCulture); Assert.True(index < imageCount); } } [Theory] [MemberData(nameof(GetImageTypesWithCount))] public async void RefreshImages_PopulatedItemEmptyProviderRemoteFullRefresh_DoesntClearImages(ImageType imageType, int imageCount) { var item = GetItemWithImages(imageType, imageCount, false); var libraryOptions = GetLibraryOptions(item, imageType, imageCount); var remoteProvider = new Mock(MockBehavior.Strict); remoteProvider.Setup(rp => rp.Name).Returns("MockRemoteProvider"); remoteProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); var refreshOptions = new ImageRefreshOptions(Mock.Of()) { ImageRefreshMode = MetadataRefreshMode.FullRefresh, ReplaceAllImages = true }; var itemImageProvider = GetItemImageProvider(Mock.Of(), null); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { remoteProvider.Object }, refreshOptions, CancellationToken.None); Assert.False(result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); Assert.Equal(imageCount, item.GetImages(imageType).Count()); } [Theory] [InlineData(9, false)] [InlineData(10, true)] [InlineData(null, true)] public async void RefreshImages_ProviderRemote_FiltersByWidth(int? remoteImageWidth, bool expectedToUpdate) { var imageType = ImageType.Primary; var item = new Video(); var libraryOptions = new LibraryOptions { TypeOptions = new[] { new TypeOptions { Type = item.GetType().Name, ImageOptions = new[] { new ImageOption { Type = imageType, MinWidth = 10 } } } } }; var remoteProvider = new Mock(MockBehavior.Strict); remoteProvider.Setup(rp => rp.Name).Returns("MockRemoteProvider"); remoteProvider.Setup(rp => rp.GetSupportedImages(item)) .Returns(new[] { imageType }); var refreshOptions = new ImageRefreshOptions(Mock.Of()); // set width on image from remote var remoteInfo = new[] { new RemoteImageInfo() { Type = imageType, Url = "image url", Width = remoteImageWidth } }; var providerManager = new Mock(MockBehavior.Strict); providerManager.Setup(pm => pm.GetAvailableRemoteImages(It.IsAny(), It.IsAny(), It.IsAny())) .ReturnsAsync(remoteInfo); var itemImageProvider = GetItemImageProvider(providerManager.Object, null); var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List { remoteProvider.Object }, refreshOptions, CancellationToken.None); Assert.Equal(expectedToUpdate, result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate)); } private static ItemImageProvider GetItemImageProvider(IProviderManager? providerManager, Mock? mockFileSystem) { // strict to ensure this isn't accidentally used where a prepared mock is intended providerManager ??= Mock.Of(MockBehavior.Strict); // BaseItem.ValidateImages depends on the directory service being able to list directory contents, give it the expected valid file paths mockFileSystem ??= new Mock(MockBehavior.Strict); mockFileSystem.Setup(fs => fs.GetFilePaths(It.IsAny(), It.IsAny())) .Returns(new[] { string.Format(CultureInfo.InvariantCulture, TestDataImagePath, 0), string.Format(CultureInfo.InvariantCulture, TestDataImagePath, 1) }); return new ItemImageProvider(new NullLogger(), providerManager, mockFileSystem.Object); } private static BaseItem GetItemWithImages(ImageType type, int count, bool validPaths) { // Has to exist for querying DateModified time on file, results stored but not checked so not populating BaseItem.FileSystem ??= Mock.Of(); var item = new Video(); var path = validPaths ? TestDataImagePath : "invalid path {0}"; for (int i = 0; i < count; i++) { item.SetImagePath(type, i, new FileSystemMetadata { FullName = string.Format(CultureInfo.InvariantCulture, path, i), }); } return item; } private static ILocalImageProvider GetImageProvider(ImageType type, int count, bool validPaths) { var images = GetImages(type, count, validPaths); var imageProvider = new Mock(); imageProvider.Setup(ip => ip.GetImages(It.IsAny(), It.IsAny())) .Returns(images); return imageProvider.Object; } /// /// Creates a list of references of the specified type and size, optionally pointing to files that exist. /// private static LocalImageInfo[] GetImages(ImageType type, int count, bool validPaths) { var path = validPaths ? TestDataImagePath : "invalid path {0}"; var images = new LocalImageInfo[count]; for (int i = 0; i < count; i++) { images[i] = new LocalImageInfo { Type = type, FileInfo = new FileSystemMetadata { FullName = string.Format(CultureInfo.InvariantCulture, path, i) } }; } return images; } /// /// Generates a object that will allow for the requested number of images for the target type. /// private static LibraryOptions GetLibraryOptions(BaseItem item, ImageType type, int count) { return new LibraryOptions { TypeOptions = new[] { new TypeOptions { Type = item.GetType().Name, ImageOptions = new[] { new ImageOption { Type = type, Limit = count, } } } } }; } } }