using System; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Runtime.CompilerServices; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Common.Extensions; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Dto; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Drawing; using MediaBrowser.Model.Dto; using MediaBrowser.Model.Entities; using MediaBrowser.Model.IO; using MediaBrowser.Model.Net; using MediaBrowser.Model.Services; using Microsoft.Extensions.Logging; using Microsoft.Net.Http.Headers; using User = Jellyfin.Data.Entities.User; namespace MediaBrowser.Api.Images { /// /// Class GetItemImage. /// [Route("/Items/{Id}/Images", "GET", Summary = "Gets information about an item's images")] [Authenticated] public class GetItemImageInfos : IReturn> { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public string Id { get; set; } } [Route("/Items/{Id}/Images/{Type}", "GET")] [Route("/Items/{Id}/Images/{Type}/{Index}", "GET")] [Route("/Items/{Id}/Images/{Type}", "HEAD")] [Route("/Items/{Id}/Images/{Type}/{Index}", "HEAD")] [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "GET")] [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "HEAD")] public class GetItemImage : ImageRequest { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path")] public Guid Id { get; set; } } /// /// Class UpdateItemImageIndex. /// [Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST", Summary = "Updates the index for an item image")] [Authenticated(Roles = "admin")] public class UpdateItemImageIndex : IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public string Id { get; set; } /// /// Gets or sets the type of the image. /// /// The type of the image. [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public ImageType Type { get; set; } /// /// Gets or sets the index. /// /// The index. [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")] public int Index { get; set; } /// /// Gets or sets the new index. /// /// The new index. [ApiMember(Name = "NewIndex", Description = "The new image index", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")] public int NewIndex { get; set; } } /// /// Class GetPersonImage. /// [Route("/Artists/{Name}/Images/{Type}", "GET")] [Route("/Artists/{Name}/Images/{Type}/{Index}", "GET")] [Route("/Genres/{Name}/Images/{Type}", "GET")] [Route("/Genres/{Name}/Images/{Type}/{Index}", "GET")] [Route("/MusicGenres/{Name}/Images/{Type}", "GET")] [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "GET")] [Route("/Persons/{Name}/Images/{Type}", "GET")] [Route("/Persons/{Name}/Images/{Type}/{Index}", "GET")] [Route("/Studios/{Name}/Images/{Type}", "GET")] [Route("/Studios/{Name}/Images/{Type}/{Index}", "GET")] ////[Route("/Years/{Year}/Images/{Type}", "GET")] ////[Route("/Years/{Year}/Images/{Type}/{Index}", "GET")] [Route("/Artists/{Name}/Images/{Type}", "HEAD")] [Route("/Artists/{Name}/Images/{Type}/{Index}", "HEAD")] [Route("/Genres/{Name}/Images/{Type}", "HEAD")] [Route("/Genres/{Name}/Images/{Type}/{Index}", "HEAD")] [Route("/MusicGenres/{Name}/Images/{Type}", "HEAD")] [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "HEAD")] [Route("/Persons/{Name}/Images/{Type}", "HEAD")] [Route("/Persons/{Name}/Images/{Type}/{Index}", "HEAD")] [Route("/Studios/{Name}/Images/{Type}", "HEAD")] [Route("/Studios/{Name}/Images/{Type}/{Index}", "HEAD")] ////[Route("/Years/{Year}/Images/{Type}", "HEAD")] ////[Route("/Years/{Year}/Images/{Type}/{Index}", "HEAD")] public class GetItemByNameImage : ImageRequest { /// /// Gets or sets the name. /// /// The name. [ApiMember(Name = "Name", Description = "Item name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public string Name { get; set; } } /// /// Class GetUserImage. /// [Route("/Users/{Id}/Images/{Type}", "GET")] [Route("/Users/{Id}/Images/{Type}/{Index}", "GET")] [Route("/Users/{Id}/Images/{Type}", "HEAD")] [Route("/Users/{Id}/Images/{Type}/{Index}", "HEAD")] public class GetUserImage : ImageRequest { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } /// /// Class DeleteItemImage. /// [Route("/Items/{Id}/Images/{Type}", "DELETE")] [Route("/Items/{Id}/Images/{Type}/{Index}", "DELETE")] [Authenticated(Roles = "admin")] public class DeleteItemImage : DeleteImageRequest, IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")] public string Id { get; set; } } /// /// Class DeleteUserImage. /// [Route("/Users/{Id}/Images/{Type}", "DELETE")] [Route("/Users/{Id}/Images/{Type}/{Index}", "DELETE")] [Authenticated] public class DeleteUserImage : DeleteImageRequest, IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")] public Guid Id { get; set; } } /// /// Class PostUserImage. /// [Route("/Users/{Id}/Images/{Type}", "POST")] [Route("/Users/{Id}/Images/{Type}/{Index}", "POST")] [Authenticated] public class PostUserImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public string Id { get; set; } /// /// The raw Http Request Input Stream. /// /// The request stream. public Stream RequestStream { get; set; } } /// /// Class PostItemImage. /// [Route("/Items/{Id}/Images/{Type}", "POST")] [Route("/Items/{Id}/Images/{Type}/{Index}", "POST")] [Authenticated(Roles = "admin")] public class PostItemImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public string Id { get; set; } /// /// The raw Http Request Input Stream. /// /// The request stream. public Stream RequestStream { get; set; } } /// /// Class ImageService. /// public class ImageService : BaseApiService { private readonly IUserManager _userManager; private readonly ILibraryManager _libraryManager; private readonly IProviderManager _providerManager; private readonly IImageProcessor _imageProcessor; private readonly IFileSystem _fileSystem; private readonly IAuthorizationContext _authContext; /// /// Initializes a new instance of the class. /// public ImageService( ILogger logger, IServerConfigurationManager serverConfigurationManager, IHttpResultFactory httpResultFactory, IUserManager userManager, ILibraryManager libraryManager, IProviderManager providerManager, IImageProcessor imageProcessor, IFileSystem fileSystem, IAuthorizationContext authContext) : base(logger, serverConfigurationManager, httpResultFactory) { _userManager = userManager; _libraryManager = libraryManager; _providerManager = providerManager; _imageProcessor = imageProcessor; _fileSystem = fileSystem; _authContext = authContext; } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetItemImageInfos request) { var item = _libraryManager.GetItemById(request.Id); var result = GetItemImageInfos(item); return ToOptimizedResult(result); } /// /// Gets the item image infos. /// /// The item. /// Task{List{ImageInfo}}. public List GetItemImageInfos(BaseItem item) { var list = new List(); var itemImages = item.ImageInfos; if (itemImages.Length == 0) { // short-circuit return list; } _libraryManager.UpdateImages(item); // this makes sure dimensions and hashes are correct foreach (var image in itemImages) { if (!item.AllowsMultipleImages(image.Type)) { var info = GetImageInfo(item, image, null); if (info != null) { list.Add(info); } } } foreach (var imageType in itemImages.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages)) { var index = 0; // Prevent implicitly captured closure var currentImageType = imageType; foreach (var image in itemImages.Where(i => i.Type == currentImageType)) { var info = GetImageInfo(item, image, index); if (info != null) { list.Add(info); } index++; } } return list; } private ImageInfo GetImageInfo(BaseItem item, ItemImageInfo info, int? imageIndex) { int? width = null; int? height = null; string blurhash = null; long length = 0; try { if (info.IsLocalFile) { var fileInfo = _fileSystem.GetFileInfo(info.Path); length = fileInfo.Length; blurhash = info.BlurHash; width = info.Width; height = info.Height; if (width <= 0 || height <= 0) { width = null; height = null; } } } catch (Exception ex) { Logger.LogError(ex, "Error getting image information for {Item}", item.Name); } try { return new ImageInfo { Path = info.Path, ImageIndex = imageIndex, ImageType = info.Type, ImageTag = _imageProcessor.GetImageCacheTag(item, info), Size = length, BlurHash = blurhash, Width = width, Height = height }; } catch (Exception ex) { Logger.LogError(ex, "Error getting image information for {Path}", info.Path); return null; } } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetItemImage request) { return GetImage(request, request.Id, null, false); } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Head(GetItemImage request) { return GetImage(request, request.Id, null, true); } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetUserImage request) { var item = _userManager.GetUserById(request.Id); return GetImage(request, item, false); } public object Head(GetUserImage request) { var item = _userManager.GetUserById(request.Id); return GetImage(request, item, true); } public object Get(GetItemByNameImage request) { var type = GetPathValue(0).ToString(); var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false)); return GetImage(request, item.Id, item, false); } public object Head(GetItemByNameImage request) { var type = GetPathValue(0).ToString(); var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false)); return GetImage(request, item.Id, item, true); } /// /// Posts the specified request. /// /// The request. public Task Post(PostUserImage request) { var id = Guid.Parse(GetPathValue(1)); AssertCanUpdateUser(_authContext, _userManager, id, true); request.Type = Enum.Parse(GetPathValue(3).ToString(), true); var user = _userManager.GetUserById(id); return PostImage(user, request.RequestStream, Request.ContentType); } /// /// Posts the specified request. /// /// The request. public Task Post(PostItemImage request) { var id = Guid.Parse(GetPathValue(1)); request.Type = Enum.Parse(GetPathValue(3).ToString(), true); var item = _libraryManager.GetItemById(id); return PostImage(item, request.RequestStream, request.Type, Request.ContentType); } /// /// Deletes the specified request. /// /// The request. public void Delete(DeleteUserImage request) { var userId = request.Id; AssertCanUpdateUser(_authContext, _userManager, userId, true); var user = _userManager.GetUserById(userId); try { File.Delete(user.ProfileImage.Path); } catch (IOException e) { Logger.LogError(e, "Error deleting user profile image:"); } _userManager.ClearProfileImage(user); } /// /// Deletes the specified request. /// /// The request. public void Delete(DeleteItemImage request) { var item = _libraryManager.GetItemById(request.Id); item.DeleteImage(request.Type, request.Index ?? 0); } /// /// Posts the specified request. /// /// The request. public void Post(UpdateItemImageIndex request) { var item = _libraryManager.GetItemById(request.Id); UpdateItemIndex(item, request.Type, request.Index, request.NewIndex); } /// /// Updates the index of the item. /// /// The item. /// The type. /// Index of the current. /// The new index. /// Task. private void UpdateItemIndex(BaseItem item, ImageType type, int currentIndex, int newIndex) { item.SwapImages(type, currentIndex, newIndex); } /// /// Gets the image. /// /// The request. /// The item. /// if set to true [is head request]. /// System.Object. /// public Task GetImage(ImageRequest request, Guid itemId, BaseItem item, bool isHeadRequest) { if (request.PercentPlayed.HasValue) { if (request.PercentPlayed.Value <= 0) { request.PercentPlayed = null; } else if (request.PercentPlayed.Value >= 100) { request.PercentPlayed = null; request.AddPlayedIndicator = true; } } if (request.PercentPlayed.HasValue) { request.UnplayedCount = null; } if (request.UnplayedCount.HasValue && request.UnplayedCount.Value <= 0) { request.UnplayedCount = null; } if (item == null) { item = _libraryManager.GetItemById(itemId); if (item == null) { throw new ResourceNotFoundException(string.Format("Item {0} not found.", itemId.ToString("N", CultureInfo.InvariantCulture))); } } var imageInfo = GetImageInfo(request, item); if (imageInfo == null) { throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type)); } bool cropWhitespace; if (request.CropWhitespace.HasValue) { cropWhitespace = request.CropWhitespace.Value; } else { cropWhitespace = request.Type == ImageType.Logo || request.Type == ImageType.Art; } var outputFormats = GetOutputFormats(request); TimeSpan? cacheDuration = null; if (!string.IsNullOrEmpty(request.Tag)) { cacheDuration = TimeSpan.FromDays(365); } var responseHeaders = new Dictionary { {"transferMode.dlna.org", "Interactive"}, {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"} }; return GetImageResult( item, itemId, request, imageInfo, cropWhitespace, outputFormats, cacheDuration, responseHeaders, isHeadRequest); } public Task GetImage(ImageRequest request, User user, bool isHeadRequest) { var imageInfo = GetImageInfo(request, user); TimeSpan? cacheDuration = null; if (!string.IsNullOrEmpty(request.Tag)) { cacheDuration = TimeSpan.FromDays(365); } var responseHeaders = new Dictionary { {"transferMode.dlna.org", "Interactive"}, {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"} }; var outputFormats = GetOutputFormats(request); return GetImageResult(user.Id, request, imageInfo, outputFormats, cacheDuration, responseHeaders, isHeadRequest); } private async Task GetImageResult( Guid itemId, ImageRequest request, ItemImageInfo info, IReadOnlyCollection supportedFormats, TimeSpan? cacheDuration, IDictionary headers, bool isHeadRequest) { info.Type = ImageType.Profile; var options = new ImageProcessingOptions { CropWhiteSpace = true, Height = request.Height, ImageIndex = request.Index ?? 0, Image = info, Item = null, // Hack alert ItemId = itemId, MaxHeight = request.MaxHeight, MaxWidth = request.MaxWidth, Quality = request.Quality ?? 100, Width = request.Width, AddPlayedIndicator = request.AddPlayedIndicator, PercentPlayed = 0, UnplayedCount = request.UnplayedCount, Blur = request.Blur, BackgroundColor = request.BackgroundColor, ForegroundLayer = request.ForegroundLayer, SupportedOutputFormats = supportedFormats }; var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false); headers[HeaderNames.Vary] = HeaderNames.Accept; return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions { CacheDuration = cacheDuration, ResponseHeaders = headers, ContentType = imageResult.Item2, DateLastModified = imageResult.Item3, IsHeadRequest = isHeadRequest, Path = imageResult.Item1, FileShare = FileShare.Read }).ConfigureAwait(false); } private async Task GetImageResult( BaseItem item, Guid itemId, ImageRequest request, ItemImageInfo image, bool cropwhitespace, IReadOnlyCollection supportedFormats, TimeSpan? cacheDuration, IDictionary headers, bool isHeadRequest) { if (!image.IsLocalFile) { item ??= _libraryManager.GetItemById(itemId); image = await _libraryManager.ConvertImageToLocal(item, image, request.Index ?? 0).ConfigureAwait(false); } var options = new ImageProcessingOptions { CropWhiteSpace = cropwhitespace, Height = request.Height, ImageIndex = request.Index ?? 0, Image = image, Item = item, ItemId = itemId, MaxHeight = request.MaxHeight, MaxWidth = request.MaxWidth, Quality = request.Quality ?? 100, Width = request.Width, AddPlayedIndicator = request.AddPlayedIndicator, PercentPlayed = request.PercentPlayed ?? 0, UnplayedCount = request.UnplayedCount, Blur = request.Blur, BackgroundColor = request.BackgroundColor, ForegroundLayer = request.ForegroundLayer, SupportedOutputFormats = supportedFormats }; var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false); headers[HeaderNames.Vary] = HeaderNames.Accept; return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions { CacheDuration = cacheDuration, ResponseHeaders = headers, ContentType = imageResult.Item2, DateLastModified = imageResult.Item3, IsHeadRequest = isHeadRequest, Path = imageResult.Item1, FileShare = FileShare.Read }).ConfigureAwait(false); } private ImageFormat[] GetOutputFormats(ImageRequest request) { if (!string.IsNullOrWhiteSpace(request.Format) && Enum.TryParse(request.Format, true, out ImageFormat format)) { return new[] { format }; } return GetClientSupportedFormats(); } private ImageFormat[] GetClientSupportedFormats() { var supportedFormats = Request.AcceptTypes ?? Array.Empty(); if (supportedFormats.Length > 0) { for (int i = 0; i < supportedFormats.Length; i++) { int index = supportedFormats[i].IndexOf(';'); if (index != -1) { supportedFormats[i] = supportedFormats[i].Substring(0, index); } } } var acceptParam = Request.QueryString["accept"]; var supportsWebP = SupportsFormat(supportedFormats, acceptParam, "webp", false); if (!supportsWebP) { var userAgent = Request.UserAgent ?? string.Empty; if (userAgent.IndexOf("crosswalk", StringComparison.OrdinalIgnoreCase) != -1 && userAgent.IndexOf("android", StringComparison.OrdinalIgnoreCase) != -1) { supportsWebP = true; } } var formats = new List(4); if (supportsWebP) { formats.Add(ImageFormat.Webp); } formats.Add(ImageFormat.Jpg); formats.Add(ImageFormat.Png); if (SupportsFormat(supportedFormats, acceptParam, "gif", true)) { formats.Add(ImageFormat.Gif); } return formats.ToArray(); } private bool SupportsFormat(IEnumerable requestAcceptTypes, string acceptParam, string format, bool acceptAll) { var mimeType = "image/" + format; if (requestAcceptTypes.Contains(mimeType)) { return true; } if (acceptAll && requestAcceptTypes.Contains("*/*")) { return true; } return string.Equals(Request.QueryString["accept"], format, StringComparison.OrdinalIgnoreCase); } /// /// Gets the image path. /// /// The request. /// The item. /// System.String. private static ItemImageInfo GetImageInfo(ImageRequest request, BaseItem item) { var index = request.Index ?? 0; return item.GetImageInfo(request.Type, index); } private static ItemImageInfo GetImageInfo(ImageRequest request, User user) { var info = new ItemImageInfo { Path = user.ProfileImage.Path, Type = ImageType.Primary, DateModified = user.ProfileImage.LastModified, }; if (request.Width.HasValue) { info.Width = request.Width.Value; } if (request.Height.HasValue) { info.Height = request.Height.Value; } return info; } /// /// Posts the image. /// /// The entity. /// The input stream. /// Type of the image. /// Type of the MIME. /// Task. public async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType) { var memoryStream = await GetMemoryStream(inputStream); // Handle image/png; charset=utf-8 mimeType = mimeType.Split(';').FirstOrDefault(); await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false); entity.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None); } private static async Task GetMemoryStream(Stream inputStream) { using var reader = new StreamReader(inputStream); var text = await reader.ReadToEndAsync().ConfigureAwait(false); var bytes = Convert.FromBase64String(text); return new MemoryStream(bytes) { Position = 0 }; } private async Task PostImage(User user, Stream inputStream, string mimeType) { var memoryStream = await GetMemoryStream(inputStream); // Handle image/png; charset=utf-8 mimeType = mimeType.Split(';').FirstOrDefault(); var userDataPath = Path.Combine(ServerConfigurationManager.ApplicationPaths.UserConfigurationDirectoryPath, user.Username); if (user.ProfileImage != null) { _userManager.ClearProfileImage(user); } user.ProfileImage = new Jellyfin.Data.Entities.ImageInfo(Path.Combine(userDataPath, "profile" + MimeTypes.ToExtension(mimeType))); await _providerManager .SaveImage(user, memoryStream, mimeType, user.ProfileImage.Path) .ConfigureAwait(false); await _userManager.UpdateUserAsync(user); } } }