using MediaBrowser.Common.Configuration; using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Net; using MediaBrowser.Controller; using MediaBrowser.Controller.Dto; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Persistence; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Dto; using MediaBrowser.Model.Entities; using ServiceStack.ServiceHost; using ServiceStack.Text.Controller; using System; using System.Collections.Generic; using System.Drawing; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; namespace MediaBrowser.Api.Images { /// /// Class GetItemImage /// [Route("/Items/{Id}/Images", "GET")] [Api(Description = "Gets information about an item's images")] 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("/Artists/{Name}/Images", "GET")] [Route("/Genres/{Name}/Images", "GET")] [Route("/GameGenres/{Name}/Images", "GET")] [Route("/MusicGenres/{Name}/Images", "GET")] [Route("/Persons/{Name}/Images", "GET")] [Route("/Studios/{Name}/Images", "GET")] [Api(Description = "Gets information about an item's images")] public class GetItemByNameImageInfos : IReturn> { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Name", Description = "Name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public string Name { get; set; } } [Route("/Items/{Id}/Images/{Type}", "GET")] [Route("/Items/{Id}/Images/{Type}/{Index}", "GET")] [Api(Description = "Gets an item image")] public class GetItemImage : ImageRequest { /// /// 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; } } /// /// Class UpdateItemImageIndex /// [Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST")] [Api(Description = "Updates the index for an item image")] public class UpdateItemImageIndex : IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid 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 = "GET")] public int NewIndex { get; set; } } [Route("/Artists/{Name}/Images/{Type}/{Index}/Index", "POST")] [Route("/Genres/{Name}/Images/{Type}/{Index}/Index", "POST")] [Route("/GameGenres/{Name}/Images/{Type}/{Index}/Index", "POST")] [Route("/MusicGenres/{Name}/Images/{Type}/{Index}/Index", "POST")] [Route("/Persons/{Name}/Images/{Type}/{Index}/Index", "POST")] [Route("/Studios/{Name}/Images/{Type}/{Index}/Index", "POST")] [Route("/Years/{Year}/Images/{Type}/{Index}/Index", "POST")] [Api(Description = "Updates the index for an item image")] public class UpdateItemByNameImageIndex : IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Name", Description = "Item name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public string Name { 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 = "GET")] 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("/GameGenres/{Name}/Images/{Type}", "GET")] [Route("/GameGenres/{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")] [Api(Description = "Gets an item by name image")] 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")] [Api(Description = "Gets a user image")] 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")] [Api(Description = "Deletes an item image")] 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 Guid Id { get; set; } } [Route("/Artists/{Name}/Images/{Type}", "DELETE")] [Route("/Artists/{Name}/Images/{Type}/{Index}", "DELETE")] [Route("/Genres/{Name}/Images/{Type}", "DELETE")] [Route("/Genres/{Name}/Images/{Type}/{Index}", "DELETE")] [Route("/GameGenres/{Name}/Images/{Type}", "DELETE")] [Route("/GameGenres/{Name}/Images/{Type}/{Index}", "DELETE")] [Route("/MusicGenres/{Name}/Images/{Type}", "DELETE")] [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "DELETE")] [Route("/Persons/{Name}/Images/{Type}", "DELETE")] [Route("/Persons/{Name}/Images/{Type}/{Index}", "DELETE")] [Route("/Studios/{Name}/Images/{Type}", "DELETE")] [Route("/Studios/{Name}/Images/{Type}/{Index}", "DELETE")] [Route("/Years/{Year}/Images/{Type}", "DELETE")] [Route("/Years/{Year}/Images/{Type}/{Index}", "DELETE")] [Api(Description = "Deletes an item image")] public class DeleteItemByNameImage : DeleteImageRequest, IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Name", Description = "Item name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")] public string Name { get; set; } } /// /// Class DeleteUserImage /// [Route("/Users/{Id}/Images/{Type}", "DELETE")] [Route("/Users/{Id}/Images/{Type}/{Index}", "DELETE")] [Api(Description = "Deletes a user image")] 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")] [Api(Description = "Posts a user image")] 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 Guid 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")] [Api(Description = "Posts an item image")] 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; } } [Route("/Artists/{Name}/Images/{Type}", "POST")] [Route("/Artists/{Name}/Images/{Type}/{Index}", "POST")] [Route("/Genres/{Name}/Images/{Type}", "POST")] [Route("/Genres/{Name}/Images/{Type}/{Index}", "POST")] [Route("/GameGenres/{Name}/Images/{Type}", "POST")] [Route("/GameGenres/{Name}/Images/{Type}/{Index}", "POST")] [Route("/MusicGenres/{Name}/Images/{Type}", "POST")] [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "POST")] [Route("/Persons/{Name}/Images/{Type}", "POST")] [Route("/Persons/{Name}/Images/{Type}/{Index}", "POST")] [Route("/Studios/{Name}/Images/{Type}", "POST")] [Route("/Studios/{Name}/Images/{Type}/{Index}", "POST")] [Route("/Years/{Year}/Images/{Type}", "POST")] [Route("/Years/{Year}/Images/{Type}/{Index}", "POST")] [Api(Description = "Posts an item image")] public class PostItemByNameImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid { /// /// Gets or sets the id. /// /// The id. [ApiMember(Name = "Name", Description = "Item name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public string Name { get; set; } /// /// The raw Http Request Input Stream /// /// The request stream. public Stream RequestStream { get; set; } } /// /// Class ImageService /// public class ImageService : BaseApiService { /// /// The _user manager /// private readonly IUserManager _userManager; /// /// The _library manager /// private readonly ILibraryManager _libraryManager; private readonly IApplicationPaths _appPaths; private readonly IProviderManager _providerManager; private readonly IItemRepository _itemRepo; private readonly IDtoService _dtoService; /// /// Initializes a new instance of the class. /// public ImageService(IUserManager userManager, ILibraryManager libraryManager, IApplicationPaths appPaths, IProviderManager providerManager, IItemRepository itemRepo, IDtoService dtoService) { _userManager = userManager; _libraryManager = libraryManager; _appPaths = appPaths; _providerManager = providerManager; _itemRepo = itemRepo; _dtoService = dtoService; } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetItemImageInfos request) { var item = _dtoService.GetItemByDtoId(request.Id); var result = GetItemImageInfos(item).Result; return ToOptimizedResult(result); } public object Get(GetItemByNameImageInfos request) { var result = GetItemByNameImageInfos(request).Result; return ToOptimizedResult(result); } /// /// Gets the item by name image infos. /// /// The request. /// Task{List{ImageInfo}}. public async Task> GetItemByNameImageInfos(GetItemByNameImageInfos request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var type = pathInfo.GetArgumentValue(0); var item = await GetItemByName(request.Name, type, _libraryManager).ConfigureAwait(false); return await GetItemImageInfos(item).ConfigureAwait(false); } /// /// Gets the item image infos. /// /// The item. /// Task{List{ImageInfo}}. public async Task> GetItemImageInfos(BaseItem item) { var list = new List(); foreach (var image in item.Images) { var path = image.Value; var fileInfo = new FileInfo(path); var dateModified = Kernel.Instance.ImageManager.GetImageDateModified(item, path); var size = await Kernel.Instance.ImageManager.GetImageSize(path, dateModified).ConfigureAwait(false); list.Add(new ImageInfo { Path = path, ImageType = image.Key, ImageTag = Kernel.Instance.ImageManager.GetImageCacheTag(item, image.Key, path), Size = fileInfo.Length, Width = Convert.ToInt32(size.Width), Height = Convert.ToInt32(size.Height) }); } var index = 0; foreach (var image in item.BackdropImagePaths) { var fileInfo = new FileInfo(image); var dateModified = Kernel.Instance.ImageManager.GetImageDateModified(item, image); var size = await Kernel.Instance.ImageManager.GetImageSize(image, dateModified).ConfigureAwait(false); list.Add(new ImageInfo { Path = image, ImageIndex = index, ImageType = ImageType.Backdrop, ImageTag = Kernel.Instance.ImageManager.GetImageCacheTag(item, ImageType.Backdrop, image), Size = fileInfo.Length, Width = Convert.ToInt32(size.Width), Height = Convert.ToInt32(size.Height) }); index++; } index = 0; foreach (var image in item.ScreenshotImagePaths) { var fileInfo = new FileInfo(image); var dateModified = Kernel.Instance.ImageManager.GetImageDateModified(item, image); var size = await Kernel.Instance.ImageManager.GetImageSize(image, dateModified).ConfigureAwait(false); list.Add(new ImageInfo { Path = image, ImageIndex = index, ImageType = ImageType.Screenshot, ImageTag = Kernel.Instance.ImageManager.GetImageCacheTag(item, ImageType.Screenshot, image), Size = fileInfo.Length, Width = Convert.ToInt32(size.Width), Height = Convert.ToInt32(size.Height) }); index++; } var video = item as Video; if (video != null) { index = 0; foreach (var chapter in _itemRepo.GetChapters(video.Id)) { if (!string.IsNullOrEmpty(chapter.ImagePath)) { var image = chapter.ImagePath; var fileInfo = new FileInfo(image); var dateModified = Kernel.Instance.ImageManager.GetImageDateModified(item, image); var size = await Kernel.Instance.ImageManager.GetImageSize(image, dateModified).ConfigureAwait(false); list.Add(new ImageInfo { Path = image, ImageIndex = index, ImageType = ImageType.Chapter, ImageTag = Kernel.Instance.ImageManager.GetImageCacheTag(item, ImageType.Chapter, image), Size = fileInfo.Length, Width = Convert.ToInt32(size.Width), Height = Convert.ToInt32(size.Height) }); } index++; } } return list; } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetItemImage request) { var item = string.IsNullOrEmpty(request.Id) ? _libraryManager.RootFolder : _dtoService.GetItemByDtoId(request.Id); return GetImage(request, item); } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetUserImage request) { var item = _userManager.Users.First(i => i.Id == request.Id); return GetImage(request, item); } public object Get(GetItemByNameImage request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var type = pathInfo.GetArgumentValue(0); var item = GetItemByName(request.Name, type, _libraryManager).Result; return GetImage(request, item); } /// /// Posts the specified request. /// /// The request. public void Post(PostUserImage request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var id = new Guid(pathInfo.GetArgumentValue(1)); request.Type = (ImageType)Enum.Parse(typeof(ImageType), pathInfo.GetArgumentValue(3), true); var item = _userManager.Users.First(i => i.Id == id); var task = PostImage(item, request.RequestStream, request.Type, RequestContext.ContentType); Task.WaitAll(task); } public void Post(PostItemByNameImage request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var type = pathInfo.GetArgumentValue(0); var name = pathInfo.GetArgumentValue(1); request.Type = (ImageType)Enum.Parse(typeof(ImageType), pathInfo.GetArgumentValue(3), true); var item = GetItemByName(name, type, _libraryManager).Result; var task = PostImage(item, request.RequestStream, request.Type, RequestContext.ContentType); Task.WaitAll(task); } /// /// Posts the specified request. /// /// The request. public void Post(PostItemImage request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var id = new Guid(pathInfo.GetArgumentValue(1)); request.Type = (ImageType)Enum.Parse(typeof(ImageType), pathInfo.GetArgumentValue(3), true); var item = _libraryManager.GetItemById(id); var task = PostImage(item, request.RequestStream, request.Type, RequestContext.ContentType); Task.WaitAll(task); } /// /// Deletes the specified request. /// /// The request. public void Delete(DeleteUserImage request) { var item = _userManager.Users.First(i => i.Id == request.Id); var task = item.DeleteImage(request.Type, request.Index); Task.WaitAll(task); } /// /// Deletes the specified request. /// /// The request. public void Delete(DeleteItemImage request) { var item = _libraryManager.GetItemById(request.Id); var task = item.DeleteImage(request.Type, request.Index); Task.WaitAll(task); } /// /// Deletes the specified request. /// /// The request. public void Delete(DeleteItemByNameImage request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var type = pathInfo.GetArgumentValue(0); var item = GetItemByName(request.Name, type, _libraryManager).Result; var task = item.DeleteImage(request.Type, request.Index); Task.WaitAll(task); } /// /// Posts the specified request. /// /// The request. public void Post(UpdateItemImageIndex request) { var item = _libraryManager.GetItemById(request.Id); var task = UpdateItemIndex(item, request.Type, request.Index, request.NewIndex); Task.WaitAll(task); } /// /// Posts the specified request. /// /// The request. public void Post(UpdateItemByNameImageIndex request) { var pathInfo = PathInfo.Parse(RequestContext.PathInfo); var type = pathInfo.GetArgumentValue(0); var item = GetItemByName(request.Name, type, _libraryManager).Result; var task = UpdateItemIndex(item, request.Type, request.Index, request.NewIndex); Task.WaitAll(task); } /// /// Updates the index of the item. /// /// The item. /// The type. /// Index of the current. /// The new index. /// Task. /// The change index operation is only applicable to backdrops and screenshots private Task UpdateItemIndex(BaseItem item, ImageType type, int currentIndex, int newIndex) { string file1; string file2; if (type == ImageType.Screenshot) { file1 = item.ScreenshotImagePaths[currentIndex]; file2 = item.ScreenshotImagePaths[newIndex]; } else if (type == ImageType.Backdrop) { file1 = item.BackdropImagePaths[currentIndex]; file2 = item.BackdropImagePaths[newIndex]; } else { throw new ArgumentException("The change index operation is only applicable to backdrops and screenshots"); } SwapFiles(file1, file2); // Directory watchers should repeat this, but do a quick refresh first return item.RefreshMetadata(CancellationToken.None, forceSave: true, allowSlowProviders: false); } /// /// Swaps the files. /// /// The file1. /// The file2. private void SwapFiles(string file1, string file2) { var temp1 = Path.Combine(_appPaths.TempDirectory, Guid.NewGuid() + ".tmp"); var temp2 = Path.Combine(_appPaths.TempDirectory, Guid.NewGuid() + ".tmp"); File.Copy(file1, temp1); File.Copy(file2, temp2); File.Copy(temp1, file2, true); File.Copy(temp2, file1, true); } /// /// Gets the image. /// /// The request. /// The item. /// System.Object. /// /// private object GetImage(ImageRequest request, BaseItem item) { var kernel = Kernel.Instance; var index = request.Index ?? 0; var imagePath = GetImagePath(kernel, request, item); if (string.IsNullOrEmpty(imagePath)) { throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type)); } // See if we can avoid a file system lookup by looking for the file in ResolveArgs var originalFileImageDateModified = kernel.ImageManager.GetImageDateModified(item, imagePath); var supportedImageEnhancers = request.EnableImageEnhancers ? kernel.ImageManager.ImageEnhancers.Where(i => { try { return i.Supports(item, request.Type); } catch (Exception ex) { Logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name); return false; } }).ToList() : new List(); // If the file does not exist GetLastWriteTimeUtc will return jan 1, 1601 as opposed to throwing an exception // http://msdn.microsoft.com/en-us/library/system.io.file.getlastwritetimeutc.aspx if (originalFileImageDateModified.Year == 1601 && !File.Exists(imagePath)) { throw new ResourceNotFoundException(string.Format("File not found: {0}", imagePath)); } var contentType = MimeTypes.GetMimeType(imagePath); var cacheGuid = kernel.ImageManager.GetImageCacheTag(imagePath, originalFileImageDateModified, supportedImageEnhancers, item, request.Type); TimeSpan? cacheDuration = null; if (!string.IsNullOrEmpty(request.Tag) && cacheGuid == new Guid(request.Tag)) { cacheDuration = TimeSpan.FromDays(365); } // Avoid implicitly captured closure var currentItem = item; var currentRequest = request; return ToCachedResult(cacheGuid, originalFileImageDateModified, cacheDuration, () => new ImageWriter { Item = currentItem, Request = currentRequest, OriginalImageDateModified = originalFileImageDateModified, Enhancers = supportedImageEnhancers, OriginalImagePath = imagePath }, contentType); } /// /// Gets the image path. /// /// The kernel. /// The request. /// The item. /// System.String. private string GetImagePath(Kernel kernel, ImageRequest request, BaseItem item) { var index = request.Index ?? 0; return kernel.ImageManager.GetImagePath(item, request.Type, index); } /// /// Posts the image. /// /// The entity. /// The input stream. /// Type of the image. /// Type of the MIME. /// Task. private async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType) { using (var reader = new StreamReader(inputStream)) { var text = await reader.ReadToEndAsync().ConfigureAwait(false); var bytes = Convert.FromBase64String(text); // Validate first using (var validationStream = new MemoryStream(bytes)) { using (var image = Image.FromStream(validationStream)) { Logger.Info("New image is {0}x{1}", image.Width, image.Height); } } var memoryStream = new MemoryStream(bytes) { Position = 0 }; var imageIndex = 0; if (imageType == ImageType.Screenshot) { imageIndex = entity.ScreenshotImagePaths.Count; } else if (imageType == ImageType.Backdrop) { imageIndex = entity.BackdropImagePaths.Count; } // Handle image/png; charset=utf-8 mimeType = mimeType.Split(';').FirstOrDefault(); await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, imageIndex, CancellationToken.None).ConfigureAwait(false); await entity.RefreshMetadata(CancellationToken.None, forceRefresh: true, forceSave: true, allowSlowProviders: false).ConfigureAwait(false); } } } }