diff --git a/Jellyfin.Api/Controllers/ImageController.cs b/Jellyfin.Api/Controllers/ImageController.cs
new file mode 100644
index 0000000000..18220c5f34
--- /dev/null
+++ b/Jellyfin.Api/Controllers/ImageController.cs
@@ -0,0 +1,1300 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
+using System.IO;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Jellyfin.Api.Constants;
+using Jellyfin.Api.Helpers;
+using MediaBrowser.Controller.Configuration;
+using MediaBrowser.Controller.Drawing;
+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 Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using Microsoft.Net.Http.Headers;
+
+namespace Jellyfin.Api.Controllers
+{
+ ///
+ /// Image controller.
+ ///
+ public class ImageController : BaseJellyfinApiController
+ {
+ private readonly IUserManager _userManager;
+ private readonly ILibraryManager _libraryManager;
+ private readonly IProviderManager _providerManager;
+ private readonly IImageProcessor _imageProcessor;
+ private readonly IFileSystem _fileSystem;
+ private readonly IAuthorizationContext _authContext;
+ private readonly ILogger _logger;
+ private readonly IServerConfigurationManager _serverConfigurationManager;
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ public ImageController(
+ IUserManager userManager,
+ ILibraryManager libraryManager,
+ IProviderManager providerManager,
+ IImageProcessor imageProcessor,
+ IFileSystem fileSystem,
+ IAuthorizationContext authContext,
+ ILogger logger,
+ IServerConfigurationManager serverConfigurationManager)
+ {
+ _userManager = userManager;
+ _libraryManager = libraryManager;
+ _providerManager = providerManager;
+ _imageProcessor = imageProcessor;
+ _fileSystem = fileSystem;
+ _authContext = authContext;
+ _logger = logger;
+ _serverConfigurationManager = serverConfigurationManager;
+ }
+
+ ///
+ /// Sets the user image.
+ ///
+ /// User Id.
+ /// (Unused) Image type.
+ /// (Unused) Image index.
+ /// Image updated.
+ /// User does not have permission to delete the image.
+ /// A .
+ [HttpPost("/Users/{userId}/Images/{imageType}")]
+ [HttpPost("/Users/{userId}/Images/{imageType}/{index?}")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status403Forbidden)]
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageType", Justification = "Imported from ServiceStack")]
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
+ public async Task PostUserImage(
+ [FromRoute] Guid userId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int? index = null)
+ {
+ if (!RequestHelpers.AssertCanUpdateUser(_authContext, HttpContext.Request, userId, true))
+ {
+ return Forbid("User is not allowed to update the image.");
+ }
+
+ var user = _userManager.GetUserById(userId);
+ await using var memoryStream = await GetMemoryStream(Request.Body).ConfigureAwait(false);
+
+ // Handle image/png; charset=utf-8
+ var mimeType = Request.ContentType.Split(';').FirstOrDefault();
+ var userDataPath = Path.Combine(_serverConfigurationManager.ApplicationPaths.UserConfigurationDirectoryPath, user.Username);
+ if (user.ProfileImage != null)
+ {
+ _userManager.ClearProfileImage(user);
+ }
+
+ user.ProfileImage = new 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).ConfigureAwait(false);
+
+ return NoContent();
+ }
+
+ ///
+ /// Delete the user's image.
+ ///
+ /// User Id.
+ /// (Unused) Image type.
+ /// (Unused) Image index.
+ /// Image deleted.
+ /// User does not have permission to delete the image.
+ /// A .
+ [HttpDelete("/Users/{userId}/Images/{itemType}")]
+ [HttpDelete("/Users/{userId}/Images/{itemType}/{index?}")]
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageType", Justification = "Imported from ServiceStack")]
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status403Forbidden)]
+ public ActionResult DeleteUserImage(
+ [FromRoute] Guid userId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int? index = null)
+ {
+ if (!RequestHelpers.AssertCanUpdateUser(_authContext, HttpContext.Request, userId, true))
+ {
+ return Forbid("User is not allowed to delete the image.");
+ }
+
+ var user = _userManager.GetUserById(userId);
+ try
+ {
+ System.IO.File.Delete(user.ProfileImage.Path);
+ }
+ catch (IOException e)
+ {
+ _logger.LogError(e, "Error deleting user profile image:");
+ }
+
+ _userManager.ClearProfileImage(user);
+ return NoContent();
+ }
+
+ ///
+ /// Delete an item's image.
+ ///
+ /// Item id.
+ /// Image type.
+ /// The image index.
+ /// Image deleted.
+ /// Item not found.
+ /// A on success, or a if item not found.
+ [HttpDelete("/Items/{itemId}/Images/{imageType}")]
+ [HttpDelete("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
+ [Authorize(Policy = Policies.RequiresElevation)]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult DeleteItemImage(
+ [FromRoute] Guid itemId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ item.DeleteImage(imageType, imageIndex ?? 0);
+ return NoContent();
+ }
+
+ ///
+ /// Set item image.
+ ///
+ /// Item id.
+ /// Image type.
+ /// (Unused) Image index.
+ /// Image saved.
+ /// Item not found.
+ /// A on success, or a if item not found.
+ [HttpPost("/Items/{itemId}/Images/{imageType}")]
+ [HttpPost("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
+ [Authorize(Policy = Policies.RequiresElevation)]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
+ public async Task SetItemImage(
+ [FromRoute] Guid itemId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ // Handle image/png; charset=utf-8
+ var mimeType = Request.ContentType.Split(';').FirstOrDefault();
+ await _providerManager.SaveImage(item, Request.Body, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
+ item.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None);
+
+ return NoContent();
+ }
+
+ ///
+ /// Updates the index for an item image.
+ ///
+ /// Item id.
+ /// Image type.
+ /// Old image index.
+ /// New image index.
+ /// Image index updated.
+ /// Item not found.
+ /// A on success, or a if item not found.
+ [HttpPost("/Items/{itemId}/Images/{imageType}/{imageIndex}/Index")]
+ [Authorize(Policy = Policies.RequiresElevation)]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult UpdateItemImageIndex(
+ [FromRoute] Guid itemId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int imageIndex,
+ [FromQuery] int newIndex)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ item.SwapImages(imageType, imageIndex, newIndex);
+ return NoContent();
+ }
+
+ ///
+ /// Get item image infos.
+ ///
+ /// Item id.
+ /// Item images returned.
+ /// Item not found.
+ /// The list of image infos on success, or if item not found.
+ [HttpGet("/Items/{itemId}/Images")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult> GetItemImageInfos([FromRoute] Guid itemId)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ 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;
+ }
+
+ ///
+ /// Gets the item's image.
+ ///
+ /// Item id.
+ /// Image type.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// Optional. Add a played indicator.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Items/{itemId}/Images/{imageType}")]
+ [HttpHead("/Items/{itemId}/Images/{imageType}")]
+ [HttpGet("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetItemImage(
+ [FromRoute] Guid itemId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] string? tag,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] string? format,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] double? percentPlayed,
+ [FromQuery] int? unplayedCount,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ itemId,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Gets the item's image.
+ ///
+ /// Item id.
+ /// Image type.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// Optional. Add a played indicator.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
+ [HttpHead("/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetItemImage2(
+ [FromRoute] Guid itemId,
+ [FromRoute] ImageType imageType,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromRoute] string tag,
+ [FromQuery] bool? cropWhitespace,
+ [FromRoute] string format,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromRoute] double? percentPlayed,
+ [FromRoute] int? unplayedCount,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ itemId,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Get artist image by name.
+ ///
+ /// Artist name.
+ /// Image type.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Optional. Add a played indicator.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Artists/{name}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/Artists/{name}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetArtistImage(
+ [FromRoute] string name,
+ [FromRoute] ImageType imageType,
+ [FromRoute] string tag,
+ [FromRoute] string format,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromRoute] double? percentPlayed,
+ [FromRoute] int? unplayedCount,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetArtist(name);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ item.Id,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Get genre image by name.
+ ///
+ /// Genre name.
+ /// Image type.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Optional. Add a played indicator.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Genres/{name}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/Genres/{name}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetGenreImage(
+ [FromRoute] string name,
+ [FromRoute] ImageType imageType,
+ [FromRoute] string tag,
+ [FromRoute] string format,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromRoute] double? percentPlayed,
+ [FromRoute] int? unplayedCount,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetGenre(name);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ item.Id,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Get music genre image by name.
+ ///
+ /// Music genre name.
+ /// Image type.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Optional. Add a played indicator.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/MusicGenres/{name}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/MusicGenres/{name}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetMusicGenreImage(
+ [FromRoute] string name,
+ [FromRoute] ImageType imageType,
+ [FromRoute] string tag,
+ [FromRoute] string format,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromRoute] double? percentPlayed,
+ [FromRoute] int? unplayedCount,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetMusicGenre(name);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ item.Id,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Get person image by name.
+ ///
+ /// Person name.
+ /// Image type.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Optional. Add a played indicator.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Persons/{name}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/Persons/{name}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetPersonImage(
+ [FromRoute] string name,
+ [FromRoute] ImageType imageType,
+ [FromRoute] string tag,
+ [FromRoute] string format,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromRoute] double? percentPlayed,
+ [FromRoute] int? unplayedCount,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetPerson(name);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ item.Id,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Get studio image by name.
+ ///
+ /// Studio name.
+ /// Image type.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Optional. Add a played indicator.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Studios/{name}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/Studios/{name}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetStudioImage(
+ [FromRoute] string name,
+ [FromRoute] ImageType imageType,
+ [FromRoute] string tag,
+ [FromRoute] string format,
+ [FromRoute] int? maxWidth,
+ [FromRoute] int? maxHeight,
+ [FromRoute] double? percentPlayed,
+ [FromRoute] int? unplayedCount,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var item = _libraryManager.GetStudio(name);
+ if (item == null)
+ {
+ return NotFound();
+ }
+
+ return await GetImageInternal(
+ item.Id,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ item,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
+ .ConfigureAwait(false);
+ }
+
+ ///
+ /// Get user profile image.
+ ///
+ /// User id.
+ /// Image type.
+ /// Optional. Supply the cache tag from the item object to receive strong caching headers.
+ /// Determines the output format of the image - original,gif,jpg,png.
+ /// The maximum image width to return.
+ /// The maximum image height to return.
+ /// Optional. Percent to render for the percent played overlay.
+ /// Optional. Unplayed count overlay to render.
+ /// The fixed image width to return.
+ /// The fixed image height to return.
+ /// Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
+ /// Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
+ /// Optional. Add a played indicator.
+ /// Optional. Blur image.
+ /// Optional. Apply a background color for transparent images.
+ /// Optional. Apply a foreground layer on top of the image.
+ /// Image index.
+ /// Image stream returned.
+ /// Item not found.
+ ///
+ /// A containing the file stream on success,
+ /// or a if item not found.
+ ///
+ [HttpGet("/Users/{userId}/Images/{imageType}/{imageIndex?}")]
+ [HttpHead("/Users/{userId}/Images/{imageType}/{imageIndex?}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task GetUserImage(
+ [FromRoute] Guid userId,
+ [FromRoute] ImageType imageType,
+ [FromQuery] string? tag,
+ [FromQuery] string? format,
+ [FromQuery] int? maxWidth,
+ [FromQuery] int? maxHeight,
+ [FromQuery] double? percentPlayed,
+ [FromQuery] int? unplayedCount,
+ [FromQuery] int? width,
+ [FromQuery] int? height,
+ [FromQuery] int? quality,
+ [FromQuery] bool? cropWhitespace,
+ [FromQuery] bool? addPlayedIndicator,
+ [FromQuery] int? blur,
+ [FromQuery] string? backgroundColor,
+ [FromQuery] string? foregroundLayer,
+ [FromRoute] int? imageIndex = null)
+ {
+ var user = _userManager.GetUserById(userId);
+ if (user == null)
+ {
+ return NotFound();
+ }
+
+ var info = new ItemImageInfo
+ {
+ Path = user.ProfileImage.Path,
+ Type = ImageType.Profile,
+ DateModified = user.ProfileImage.LastModified
+ };
+
+ if (width.HasValue)
+ {
+ info.Width = width.Value;
+ }
+
+ if (height.HasValue)
+ {
+ info.Height = height.Value;
+ }
+
+ return await GetImageInternal(
+ user.Id,
+ imageType,
+ imageIndex,
+ tag,
+ format,
+ maxWidth,
+ maxHeight,
+ percentPlayed,
+ unplayedCount,
+ width,
+ height,
+ quality,
+ cropWhitespace,
+ addPlayedIndicator,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ null,
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase),
+ info)
+ .ConfigureAwait(false);
+ }
+
+ 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 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;
+ }
+ }
+
+ private async Task GetImageInternal(
+ Guid itemId,
+ ImageType imageType,
+ int? imageIndex,
+ string? tag,
+ string? format,
+ int? maxWidth,
+ int? maxHeight,
+ double? percentPlayed,
+ int? unplayedCount,
+ int? width,
+ int? height,
+ int? quality,
+ bool? cropWhitespace,
+ bool? addPlayedIndicator,
+ int? blur,
+ string? backgroundColor,
+ string? foregroundLayer,
+ BaseItem? item,
+ bool isHeadRequest,
+ ItemImageInfo? imageInfo = null)
+ {
+ if (percentPlayed.HasValue)
+ {
+ if (percentPlayed.Value <= 0)
+ {
+ percentPlayed = null;
+ }
+ else if (percentPlayed.Value >= 100)
+ {
+ percentPlayed = null;
+ addPlayedIndicator = true;
+ }
+ }
+
+ if (percentPlayed.HasValue)
+ {
+ unplayedCount = null;
+ }
+
+ if (unplayedCount.HasValue
+ && unplayedCount.Value <= 0)
+ {
+ unplayedCount = null;
+ }
+
+ if (imageInfo == null)
+ {
+ imageInfo = item?.GetImageInfo(imageType, imageIndex ?? 0);
+ if (imageInfo == null)
+ {
+ return NotFound(string.Format(NumberFormatInfo.InvariantInfo, "{0} does not have an image of type {1}", item?.Name, imageType));
+ }
+ }
+
+ cropWhitespace ??= imageType == ImageType.Logo || imageType == ImageType.Art;
+
+ var outputFormats = GetOutputFormats(format);
+
+ TimeSpan? cacheDuration = null;
+
+ if (!string.IsNullOrEmpty(tag))
+ {
+ cacheDuration = TimeSpan.FromDays(365);
+ }
+
+ var responseHeaders = new Dictionary
+ {
+ { "transferMode.dlna.org", "Interactive" },
+ { "realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*" }
+ };
+
+ return await GetImageResult(
+ item,
+ itemId,
+ imageIndex,
+ height,
+ maxHeight,
+ maxWidth,
+ quality,
+ width,
+ addPlayedIndicator,
+ percentPlayed,
+ unplayedCount,
+ blur,
+ backgroundColor,
+ foregroundLayer,
+ imageInfo,
+ cropWhitespace.Value,
+ outputFormats,
+ cacheDuration,
+ responseHeaders,
+ isHeadRequest).ConfigureAwait(false);
+ }
+
+ private ImageFormat[] GetOutputFormats(string? format)
+ {
+ if (!string.IsNullOrWhiteSpace(format)
+ && Enum.TryParse(format, true, out ImageFormat parsedFormat))
+ {
+ return new[] { parsedFormat };
+ }
+
+ return GetClientSupportedFormats();
+ }
+
+ private ImageFormat[] GetClientSupportedFormats()
+ {
+ var acceptTypes = Request.Headers[HeaderNames.Accept];
+ var supportedFormats = new List();
+ if (acceptTypes.Count > 0)
+ {
+ foreach (var type in acceptTypes)
+ {
+ int index = type.IndexOf(';', StringComparison.Ordinal);
+ if (index != -1)
+ {
+ supportedFormats.Add(type.Substring(0, index));
+ }
+ }
+ }
+
+ var acceptParam = Request.Query[HeaderNames.Accept];
+
+ var supportsWebP = SupportsFormat(supportedFormats, acceptParam, "webp", false);
+
+ if (!supportsWebP)
+ {
+ var userAgent = Request.Headers[HeaderNames.UserAgent].ToString();
+ 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(IReadOnlyCollection 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(acceptParam, format, StringComparison.OrdinalIgnoreCase);
+ }
+
+ private async Task GetImageResult(
+ BaseItem? item,
+ Guid itemId,
+ int? index,
+ int? height,
+ int? maxHeight,
+ int? maxWidth,
+ int? quality,
+ int? width,
+ bool? addPlayedIndicator,
+ double? percentPlayed,
+ int? unplayedCount,
+ int? blur,
+ string? backgroundColor,
+ string? foregroundLayer,
+ ItemImageInfo imageInfo,
+ bool cropWhitespace,
+ IReadOnlyCollection supportedFormats,
+ TimeSpan? cacheDuration,
+ IDictionary headers,
+ bool isHeadRequest)
+ {
+ if (!imageInfo.IsLocalFile && item != null)
+ {
+ imageInfo = await _libraryManager.ConvertImageToLocal(item, imageInfo, index ?? 0).ConfigureAwait(false);
+ }
+
+ var options = new ImageProcessingOptions
+ {
+ CropWhiteSpace = cropWhitespace,
+ Height = height,
+ ImageIndex = index ?? 0,
+ Image = imageInfo,
+ Item = item,
+ ItemId = itemId,
+ MaxHeight = maxHeight,
+ MaxWidth = maxWidth,
+ Quality = quality ?? 100,
+ Width = width,
+ AddPlayedIndicator = addPlayedIndicator ?? false,
+ PercentPlayed = percentPlayed ?? 0,
+ UnplayedCount = unplayedCount,
+ Blur = blur,
+ BackgroundColor = backgroundColor,
+ ForegroundLayer = foregroundLayer,
+ SupportedOutputFormats = supportedFormats
+ };
+
+ var (imagePath, imageContentType, dateImageModified) = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
+
+ var disableCaching = Request.Headers[HeaderNames.CacheControl].Contains("no-cache");
+ var parsingSuccessful = DateTime.TryParse(Request.Headers[HeaderNames.IfModifiedSince], out var ifModifiedSinceHeader);
+
+ // if the parsing of the IfModifiedSince header was not successful, disable caching
+ if (!parsingSuccessful)
+ {
+ // disableCaching = true;
+ }
+
+ foreach (var (key, value) in headers)
+ {
+ Response.Headers.Add(key, value);
+ }
+
+ Response.ContentType = imageContentType;
+ Response.Headers.Add(HeaderNames.Age, Convert.ToInt64((DateTime.UtcNow - dateImageModified).TotalSeconds).ToString(CultureInfo.InvariantCulture));
+ Response.Headers.Add(HeaderNames.Vary, HeaderNames.Accept);
+
+ if (disableCaching)
+ {
+ Response.Headers.Add(HeaderNames.CacheControl, "no-cache, no-store, must-revalidate");
+ Response.Headers.Add(HeaderNames.Pragma, "no-cache, no-store, must-revalidate");
+ }
+ else
+ {
+ if (cacheDuration.HasValue)
+ {
+ Response.Headers.Add(HeaderNames.CacheControl, "public, max-age=" + cacheDuration.Value.TotalSeconds);
+ }
+ else
+ {
+ Response.Headers.Add(HeaderNames.CacheControl, "public");
+ }
+
+ Response.Headers.Add(HeaderNames.LastModified, dateImageModified.ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss \"GMT\"", new CultureInfo("en-US", false)));
+
+ // if the image was not modified since "ifModifiedSinceHeader"-header, return a HTTP status code 304 not modified
+ if (!(dateImageModified > ifModifiedSinceHeader))
+ {
+ if (ifModifiedSinceHeader.Add(cacheDuration!.Value) < DateTime.UtcNow)
+ {
+ Response.StatusCode = StatusCodes.Status304NotModified;
+ return new ContentResult();
+ }
+ }
+ }
+
+ // if the request is a head request, return a NoContent result with the same headers as it would with a GET request
+ if (isHeadRequest)
+ {
+ return NoContent();
+ }
+
+ var stream = new FileStream(imagePath, FileMode.Open, FileAccess.Read);
+ return File(stream, imageContentType);
+ }
+ }
+}
diff --git a/MediaBrowser.Api/Images/ImageRequest.cs b/MediaBrowser.Api/Images/ImageRequest.cs
deleted file mode 100644
index 0f3455548d..0000000000
--- a/MediaBrowser.Api/Images/ImageRequest.cs
+++ /dev/null
@@ -1,100 +0,0 @@
-using MediaBrowser.Model.Entities;
-using MediaBrowser.Model.Services;
-
-namespace MediaBrowser.Api.Images
-{
- ///
- /// Class ImageRequest.
- ///
- public class ImageRequest : DeleteImageRequest
- {
- ///
- /// The max width.
- ///
- [ApiMember(Name = "MaxWidth", Description = "The maximum image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? MaxWidth { get; set; }
-
- ///
- /// The max height.
- ///
- [ApiMember(Name = "MaxHeight", Description = "The maximum image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? MaxHeight { get; set; }
-
- ///
- /// The width.
- ///
- [ApiMember(Name = "Width", Description = "The fixed image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? Width { get; set; }
-
- ///
- /// The height.
- ///
- [ApiMember(Name = "Height", Description = "The fixed image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? Height { get; set; }
-
- ///
- /// Gets or sets the quality.
- ///
- /// The quality.
- [ApiMember(Name = "Quality", Description = "Optional quality setting, from 0-100. Defaults to 90 and should suffice in most cases.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? Quality { get; set; }
-
- ///
- /// Gets or sets the tag.
- ///
- /// The tag.
- [ApiMember(Name = "Tag", Description = "Optional. Supply the cache tag from the item object to receive strong caching headers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string Tag { get; set; }
-
- [ApiMember(Name = "CropWhitespace", Description = "Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public bool? CropWhitespace { get; set; }
-
- [ApiMember(Name = "EnableImageEnhancers", Description = "Enable or disable image enhancers such as cover art.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public bool EnableImageEnhancers { get; set; }
-
- [ApiMember(Name = "Format", Description = "Determines the output foramt of the image - original,gif,jpg,png", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public string Format { get; set; }
-
- [ApiMember(Name = "AddPlayedIndicator", Description = "Optional. Add a played indicator", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public bool AddPlayedIndicator { get; set; }
-
- [ApiMember(Name = "PercentPlayed", Description = "Optional percent to render for the percent played overlay", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public double? PercentPlayed { get; set; }
-
- [ApiMember(Name = "UnplayedCount", Description = "Optional unplayed count overlay to render", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? UnplayedCount { get; set; }
-
- public int? Blur { get; set; }
-
- [ApiMember(Name = "BackgroundColor", Description = "Optional. Apply a background color for transparent images.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string BackgroundColor { get; set; }
-
- [ApiMember(Name = "ForegroundLayer", Description = "Optional. Apply a foreground layer on top of the image.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string ForegroundLayer { get; set; }
-
- public ImageRequest()
- {
- EnableImageEnhancers = true;
- }
- }
-
- ///
- /// Class DeleteImageRequest.
- ///
- public class DeleteImageRequest
- {
- ///
- /// 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 = "GET,POST,DELETE")]
- 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 = "GET,POST,DELETE")]
- public int? Index { get; set; }
- }
-}
diff --git a/MediaBrowser.Api/Images/ImageService.cs b/MediaBrowser.Api/Images/ImageService.cs
deleted file mode 100644
index 575b1157a4..0000000000
--- a/MediaBrowser.Api/Images/ImageService.cs
+++ /dev/null
@@ -1,911 +0,0 @@
-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