2020-11-21 13:26:03 +00:00
using System ;
2020-06-20 23:06:33 +00:00
using System.Collections.Generic ;
2020-09-05 23:11:44 +00:00
using System.ComponentModel.DataAnnotations ;
2020-06-20 23:06:33 +00:00
using System.Diagnostics.CodeAnalysis ;
2020-06-21 17:31:44 +00:00
using System.Globalization ;
2020-06-19 21:08:35 +00:00
using System.IO ;
using System.Linq ;
2020-11-13 16:04:31 +00:00
using System.Net.Mime ;
2020-06-20 23:06:33 +00:00
using System.Threading ;
2020-06-19 21:08:35 +00:00
using System.Threading.Tasks ;
2020-09-01 23:26:49 +00:00
using Jellyfin.Api.Attributes ;
2020-06-20 23:06:33 +00:00
using Jellyfin.Api.Constants ;
using Jellyfin.Api.Helpers ;
2020-06-19 21:08:35 +00:00
using MediaBrowser.Controller.Configuration ;
using MediaBrowser.Controller.Drawing ;
2020-06-20 23:06:33 +00:00
using MediaBrowser.Controller.Entities ;
2020-06-19 21:08:35 +00:00
using MediaBrowser.Controller.Library ;
using MediaBrowser.Controller.Net ;
using MediaBrowser.Controller.Providers ;
2020-06-21 17:31:44 +00:00
using MediaBrowser.Model.Drawing ;
2020-06-20 23:06:33 +00:00
using MediaBrowser.Model.Dto ;
2020-06-19 21:08:35 +00:00
using MediaBrowser.Model.Entities ;
using MediaBrowser.Model.IO ;
using MediaBrowser.Model.Net ;
2020-06-20 23:06:33 +00:00
using Microsoft.AspNetCore.Authorization ;
using Microsoft.AspNetCore.Http ;
2020-06-19 21:08:35 +00:00
using Microsoft.AspNetCore.Mvc ;
using Microsoft.Extensions.Logging ;
2020-06-21 17:31:44 +00:00
using Microsoft.Net.Http.Headers ;
2020-06-19 21:08:35 +00:00
namespace Jellyfin.Api.Controllers
{
/// <summary>
/// Image controller.
/// </summary>
2020-08-04 18:48:53 +00:00
[Route("")]
2020-06-19 21:08:35 +00:00
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 < ImageController > _logger ;
private readonly IServerConfigurationManager _serverConfigurationManager ;
/// <summary>
/// Initializes a new instance of the <see cref="ImageController"/> class.
/// </summary>
/// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
/// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
/// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
/// <param name="imageProcessor">Instance of the <see cref="IImageProcessor"/> interface.</param>
/// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param>
/// <param name="authContext">Instance of the <see cref="IAuthorizationContext"/> interface.</param>
/// <param name="logger">Instance of the <see cref="ILogger{ImageController}"/> interface.</param>
/// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
public ImageController (
IUserManager userManager ,
ILibraryManager libraryManager ,
IProviderManager providerManager ,
IImageProcessor imageProcessor ,
IFileSystem fileSystem ,
IAuthorizationContext authContext ,
ILogger < ImageController > logger ,
IServerConfigurationManager serverConfigurationManager )
{
_userManager = userManager ;
_libraryManager = libraryManager ;
_providerManager = providerManager ;
_imageProcessor = imageProcessor ;
_fileSystem = fileSystem ;
_authContext = authContext ;
_logger = logger ;
_serverConfigurationManager = serverConfigurationManager ;
}
/// <summary>
/// Sets the user image.
/// </summary>
/// <param name="userId">User Id.</param>
/// <param name="imageType">(Unused) Image type.</param>
/// <param name="index">(Unused) Image index.</param>
/// <response code="204">Image updated.</response>
2020-07-22 14:03:45 +00:00
/// <response code="403">User does not have permission to delete the image.</response>
2020-06-19 21:08:35 +00:00
/// <returns>A <see cref="NoContentResult"/>.</returns>
2020-08-04 18:48:53 +00:00
[HttpPost("Users/{userId}/Images/{imageType}")]
2020-08-06 14:17:45 +00:00
[Authorize(Policy = Policies.DefaultAuthorization)]
2021-02-10 23:12:52 +00:00
[AcceptsImageFile]
2020-07-22 14:03:45 +00:00
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
2020-06-20 23:06:33 +00:00
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageType", Justification = "Imported from ServiceStack")]
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
2020-06-19 21:08:35 +00:00
public async Task < ActionResult > PostUserImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid userId ,
[FromRoute, Required] ImageType imageType ,
2020-11-15 17:58:39 +00:00
[FromQuery] int? index = null )
{
2021-05-21 03:56:59 +00:00
if ( ! await RequestHelpers . AssertCanUpdateUser ( _authContext , HttpContext . Request , userId , true ) . ConfigureAwait ( false ) )
2020-11-15 17:58:39 +00:00
{
2020-12-07 15:55:42 +00:00
return StatusCode ( StatusCodes . Status403Forbidden , "User is not allowed to update the image." ) ;
2020-11-15 17:58:39 +00:00
}
var user = _userManager . GetUserById ( userId ) ;
await using var memoryStream = await GetMemoryStream ( Request . Body ) . ConfigureAwait ( false ) ;
// Handle image/png; charset=utf-8
2021-02-14 14:11:46 +00:00
var mimeType = Request . ContentType ? . Split ( ';' ) . FirstOrDefault ( ) ;
2020-11-15 17:58:39 +00:00
var userDataPath = Path . Combine ( _serverConfigurationManager . ApplicationPaths . UserConfigurationDirectoryPath , user . Username ) ;
if ( user . ProfileImage ! = null )
{
await _userManager . ClearProfileImageAsync ( user ) . ConfigureAwait ( false ) ;
}
2021-02-20 22:34:15 +00:00
user . ProfileImage = new Data . Entities . ImageInfo ( Path . Combine ( userDataPath , "profile" + MimeTypes . ToExtension ( mimeType ? ? string . Empty ) ) ) ;
2020-11-15 17:58:39 +00:00
await _providerManager
. SaveImage ( memoryStream , mimeType , user . ProfileImage . Path )
. ConfigureAwait ( false ) ;
await _userManager . UpdateUserAsync ( user ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Sets the user image.
/// </summary>
/// <param name="userId">User Id.</param>
/// <param name="imageType">(Unused) Image type.</param>
/// <param name="index">(Unused) Image index.</param>
/// <response code="204">Image updated.</response>
/// <response code="403">User does not have permission to delete the image.</response>
/// <returns>A <see cref="NoContentResult"/>.</returns>
[HttpPost("Users/{userId}/Images/{imageType}/{index}")]
[Authorize(Policy = Policies.DefaultAuthorization)]
2021-02-10 23:12:52 +00:00
[AcceptsImageFile]
2020-11-15 17:58:39 +00:00
[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 < ActionResult > PostUserImageByIndex (
[FromRoute, Required] Guid userId ,
[FromRoute, Required] ImageType imageType ,
[FromRoute] int index )
2020-06-19 21:08:35 +00:00
{
2021-05-21 03:56:59 +00:00
if ( ! await RequestHelpers . AssertCanUpdateUser ( _authContext , HttpContext . Request , userId , true ) . ConfigureAwait ( false ) )
2020-06-20 23:06:33 +00:00
{
2020-12-07 15:55:42 +00:00
return StatusCode ( StatusCodes . Status403Forbidden , "User is not allowed to update the image." ) ;
2020-06-20 23:06:33 +00:00
}
2020-06-19 21:08:35 +00:00
var user = _userManager . GetUserById ( userId ) ;
await using var memoryStream = await GetMemoryStream ( Request . Body ) . ConfigureAwait ( false ) ;
// Handle image/png; charset=utf-8
2021-02-14 14:11:46 +00:00
var mimeType = Request . ContentType ? . Split ( ';' ) . FirstOrDefault ( ) ;
2020-06-19 21:08:35 +00:00
var userDataPath = Path . Combine ( _serverConfigurationManager . ApplicationPaths . UserConfigurationDirectoryPath , user . Username ) ;
2020-07-21 14:05:21 +00:00
if ( user . ProfileImage ! = null )
{
2020-10-30 00:30:33 +00:00
await _userManager . ClearProfileImageAsync ( user ) . ConfigureAwait ( false ) ;
2020-07-21 14:05:21 +00:00
}
2021-02-20 22:34:15 +00:00
user . ProfileImage = new Data . Entities . ImageInfo ( Path . Combine ( userDataPath , "profile" + MimeTypes . ToExtension ( mimeType ? ? string . Empty ) ) ) ;
2020-06-19 21:08:35 +00:00
await _providerManager
2020-08-07 17:26:28 +00:00
. SaveImage ( memoryStream , mimeType , user . ProfileImage . Path )
2020-06-19 21:08:35 +00:00
. ConfigureAwait ( false ) ;
await _userManager . UpdateUserAsync ( user ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Delete the user's image.
/// </summary>
/// <param name="userId">User Id.</param>
/// <param name="imageType">(Unused) Image type.</param>
/// <param name="index">(Unused) Image index.</param>
/// <response code="204">Image deleted.</response>
2020-07-22 14:03:45 +00:00
/// <response code="403">User does not have permission to delete the image.</response>
2020-06-19 21:08:35 +00:00
/// <returns>A <see cref="NoContentResult"/>.</returns>
2020-11-15 17:58:39 +00:00
[HttpDelete("Users/{userId}/Images/{imageType}")]
2020-08-06 23:59:48 +00:00
[Authorize(Policy = Policies.DefaultAuthorization)]
2020-06-20 23:06:33 +00:00
[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)]
2020-07-22 14:03:45 +00:00
[ProducesResponseType(StatusCodes.Status403Forbidden)]
2020-10-30 00:30:33 +00:00
public async Task < ActionResult > DeleteUserImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid userId ,
[FromRoute, Required] ImageType imageType ,
2020-11-15 17:58:39 +00:00
[FromQuery] int? index = null )
{
2021-05-21 03:56:59 +00:00
if ( ! await RequestHelpers . AssertCanUpdateUser ( _authContext , HttpContext . Request , userId , true ) . ConfigureAwait ( false ) )
2020-11-15 17:58:39 +00:00
{
2020-12-07 15:55:42 +00:00
return StatusCode ( StatusCodes . Status403Forbidden , "User is not allowed to delete the image." ) ;
2020-11-15 17:58:39 +00:00
}
var user = _userManager . GetUserById ( userId ) ;
2021-03-06 22:43:01 +00:00
if ( user ? . ProfileImage = = null )
{
return NoContent ( ) ;
}
2020-11-15 17:58:39 +00:00
try
{
System . IO . File . Delete ( user . ProfileImage . Path ) ;
}
catch ( IOException e )
{
_logger . LogError ( e , "Error deleting user profile image:" ) ;
}
await _userManager . ClearProfileImageAsync ( user ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Delete the user's image.
/// </summary>
/// <param name="userId">User Id.</param>
/// <param name="imageType">(Unused) Image type.</param>
/// <param name="index">(Unused) Image index.</param>
/// <response code="204">Image deleted.</response>
/// <response code="403">User does not have permission to delete the image.</response>
/// <returns>A <see cref="NoContentResult"/>.</returns>
[HttpDelete("Users/{userId}/Images/{imageType}/{index}")]
[Authorize(Policy = Policies.DefaultAuthorization)]
[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 async Task < ActionResult > DeleteUserImageByIndex (
[FromRoute, Required] Guid userId ,
[FromRoute, Required] ImageType imageType ,
[FromRoute] int index )
2020-06-19 21:08:35 +00:00
{
2021-05-21 03:56:59 +00:00
if ( ! await RequestHelpers . AssertCanUpdateUser ( _authContext , HttpContext . Request , userId , true ) . ConfigureAwait ( false ) )
2020-06-20 23:06:33 +00:00
{
2020-12-07 15:55:42 +00:00
return StatusCode ( StatusCodes . Status403Forbidden , "User is not allowed to delete the image." ) ;
2020-06-20 23:06:33 +00:00
}
2020-06-19 21:08:35 +00:00
var user = _userManager . GetUserById ( userId ) ;
2021-03-06 22:43:01 +00:00
if ( user ? . ProfileImage = = null )
{
return NoContent ( ) ;
}
2020-06-19 21:08:35 +00:00
try
{
System . IO . File . Delete ( user . ProfileImage . Path ) ;
}
catch ( IOException e )
{
_logger . LogError ( e , "Error deleting user profile image:" ) ;
}
2020-10-30 00:30:33 +00:00
await _userManager . ClearProfileImageAsync ( user ) . ConfigureAwait ( false ) ;
2020-06-19 21:08:35 +00:00
return NoContent ( ) ;
}
2020-06-20 23:06:33 +00:00
/// <summary>
/// Delete an item's image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">The image index.</param>
/// <response code="204">Image deleted.</response>
/// <response code="404">Item not found.</response>
/// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
2020-08-04 18:48:53 +00:00
[HttpDelete("Items/{itemId}/Images/{imageType}")]
2020-06-20 23:06:33 +00:00
[Authorize(Policy = Policies.RequiresElevation)]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-08-21 20:01:19 +00:00
public async Task < ActionResult > DeleteItemImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
2020-11-15 17:58:39 +00:00
[FromQuery] int? imageIndex )
2020-06-20 23:06:33 +00:00
{
var item = _libraryManager . GetItemById ( itemId ) ;
if ( item = = null )
{
return NotFound ( ) ;
}
2020-08-21 20:01:19 +00:00
await item . DeleteImageAsync ( imageType , imageIndex ? ? 0 ) . ConfigureAwait ( false ) ;
2020-06-20 23:06:33 +00:00
return NoContent ( ) ;
}
2020-11-15 17:58:39 +00:00
/// <summary>
/// Delete an item's image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">The image index.</param>
/// <response code="204">Image deleted.</response>
/// <response code="404">Item not found.</response>
/// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
[HttpDelete("Items/{itemId}/Images/{imageType}/{imageIndex}")]
[Authorize(Policy = Policies.RequiresElevation)]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > DeleteItemImageByIndex (
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
[FromRoute] int imageIndex )
{
var item = _libraryManager . GetItemById ( itemId ) ;
if ( item = = null )
{
return NotFound ( ) ;
}
await item . DeleteImageAsync ( imageType , imageIndex ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
2020-06-20 23:06:33 +00:00
/// <summary>
/// Set item image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <response code="204">Image saved.</response>
2020-07-22 14:03:45 +00:00
/// <response code="404">Item not found.</response>
2020-06-20 23:06:33 +00:00
/// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
2020-08-04 18:48:53 +00:00
[HttpPost("Items/{itemId}/Images/{imageType}")]
2020-06-20 23:06:33 +00:00
[Authorize(Policy = Policies.RequiresElevation)]
2021-02-10 23:12:52 +00:00
[AcceptsImageFile]
2020-06-20 23:06:33 +00:00
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
public async Task < ActionResult > SetItemImage (
2020-11-15 17:58:39 +00:00
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType )
{
var item = _libraryManager . GetItemById ( itemId ) ;
if ( item = = null )
{
return NotFound ( ) ;
}
2020-12-15 08:27:33 +00:00
await using var memoryStream = await GetMemoryStream ( Request . Body ) . ConfigureAwait ( false ) ;
2020-11-15 17:58:39 +00:00
// Handle image/png; charset=utf-8
2021-02-14 14:11:46 +00:00
var mimeType = Request . ContentType ? . Split ( ';' ) . FirstOrDefault ( ) ;
2020-12-15 08:27:33 +00:00
await _providerManager . SaveImage ( item , memoryStream , mimeType , imageType , null , CancellationToken . None ) . ConfigureAwait ( false ) ;
2020-11-15 17:58:39 +00:00
await item . UpdateToRepositoryAsync ( ItemUpdateType . ImageUpdate , CancellationToken . None ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Set item image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">(Unused) Image index.</param>
/// <response code="204">Image saved.</response>
/// <response code="404">Item not found.</response>
/// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
[HttpPost("Items/{itemId}/Images/{imageType}/{imageIndex}")]
[Authorize(Policy = Policies.RequiresElevation)]
2021-02-10 23:12:52 +00:00
[AcceptsImageFile]
2020-11-15 17:58:39 +00:00
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
public async Task < ActionResult > SetItemImageByIndex (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
2020-11-15 17:58:39 +00:00
[FromRoute] int imageIndex )
2020-06-20 23:06:33 +00:00
{
var item = _libraryManager . GetItemById ( itemId ) ;
if ( item = = null )
{
return NotFound ( ) ;
}
2020-12-15 08:27:33 +00:00
await using var memoryStream = await GetMemoryStream ( Request . Body ) . ConfigureAwait ( false ) ;
2020-06-20 23:06:33 +00:00
// Handle image/png; charset=utf-8
2021-02-14 14:11:46 +00:00
var mimeType = Request . ContentType ? . Split ( ';' ) . FirstOrDefault ( ) ;
2020-12-15 08:27:33 +00:00
await _providerManager . SaveImage ( item , memoryStream , mimeType , imageType , null , CancellationToken . None ) . ConfigureAwait ( false ) ;
2020-08-21 20:01:19 +00:00
await item . UpdateToRepositoryAsync ( ItemUpdateType . ImageUpdate , CancellationToken . None ) . ConfigureAwait ( false ) ;
2020-06-20 23:06:33 +00:00
return NoContent ( ) ;
}
/// <summary>
/// Updates the index for an item image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">Old image index.</param>
/// <param name="newIndex">New image index.</param>
/// <response code="204">Image index updated.</response>
/// <response code="404">Item not found.</response>
/// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
2020-08-04 18:48:53 +00:00
[HttpPost("Items/{itemId}/Images/{imageType}/{imageIndex}/Index")]
2020-06-20 23:06:33 +00:00
[Authorize(Policy = Policies.RequiresElevation)]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-08-21 20:01:19 +00:00
public async Task < ActionResult > UpdateItemImageIndex (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
[FromRoute, Required] int imageIndex ,
2021-03-05 01:25:52 +00:00
[FromQuery, Required] int newIndex )
2020-06-20 23:06:33 +00:00
{
var item = _libraryManager . GetItemById ( itemId ) ;
if ( item = = null )
{
return NotFound ( ) ;
}
2020-08-21 20:01:19 +00:00
await item . SwapImagesAsync ( imageType , imageIndex , newIndex ) . ConfigureAwait ( false ) ;
2020-06-20 23:06:33 +00:00
return NoContent ( ) ;
}
/// <summary>
/// Get item image infos.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <response code="200">Item images returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>The list of image infos on success, or <see cref="NotFoundResult"/> if item not found.</returns>
2020-08-04 18:48:53 +00:00
[HttpGet("Items/{itemId}/Images")]
2020-08-06 14:17:45 +00:00
[Authorize(Policy = Policies.DefaultAuthorization)]
2020-06-20 23:06:33 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-06 15:07:27 +00:00
public async Task < ActionResult < IEnumerable < ImageInfo > > > GetItemImageInfos ( [ FromRoute , Required ] Guid itemId )
2020-06-20 23:06:33 +00:00
{
var item = _libraryManager . GetItemById ( itemId ) ;
if ( item = = null )
{
return NotFound ( ) ;
}
var list = new List < ImageInfo > ( ) ;
var itemImages = item . ImageInfos ;
if ( itemImages . Length = = 0 )
{
// short-circuit
return list ;
}
2020-08-21 20:01:19 +00:00
await _libraryManager . UpdateImagesAsync ( item ) . ConfigureAwait ( false ) ; // this makes sure dimensions and hashes are correct
2020-06-20 23:06:33 +00:00
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 ;
}
2020-06-21 17:31:44 +00:00
/// <summary>
/// Gets the item's image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-06-21 17:31:44 +00:00
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
2020-10-03 19:35:57 +00:00
/// <param name="format">Optional. The <see cref="ImageFormat"/> of the returned image.</param>
2020-06-21 17:31:44 +00:00
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <param name="imageIndex">Image index.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-08-04 18:48:53 +00:00
[HttpGet("Items/{itemId}/Images/{imageType}")]
[HttpHead("Items/{itemId}/Images/{imageType}", Name = "HeadItemImage")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-06-21 17:31:44 +00:00
public async Task < ActionResult > GetItemImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
2020-09-08 00:45:06 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
2020-06-21 17:31:44 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2020-07-21 19:17:08 +00:00
[FromQuery] string? tag ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-10-02 17:05:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
2020-06-21 17:31:44 +00:00
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? blur ,
2020-07-21 19:17:08 +00:00
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? imageIndex )
2020-11-15 17:58:39 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-11-15 17:58:39 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Gets the item's image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">Image index.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-11-15 17:58:39 +00:00
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="format">Optional. The <see cref="ImageFormat"/> of the returned image.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
[HttpGet("Items/{itemId}/Images/{imageType}/{imageIndex}")]
[HttpHead("Items/{itemId}/Images/{imageType}/{imageIndex}", Name = "HeadItemImageByIndex")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesImageFile]
public async Task < ActionResult > GetItemImageByIndex (
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
[FromRoute] int imageIndex ,
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2020-11-15 17:58:39 +00:00
[FromQuery] string? tag ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-11-15 17:58:39 +00:00
[FromQuery] ImageFormat ? format ,
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
2021-03-17 18:45:28 +00:00
[FromQuery] string? foregroundLayer )
2020-06-21 17:31:44 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-06-21 17:31:44 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Gets the item's image.
/// </summary>
/// <param name="itemId">Item id.</param>
/// <param name="imageType">Image type.</param>
2020-07-21 19:17:08 +00:00
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-07-21 19:17:08 +00:00
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
2020-06-21 17:31:44 +00:00
/// <param name="imageIndex">Image index.</param>
2020-07-21 19:17:08 +00:00
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-08-04 18:48:53 +00:00
[HttpGet("Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
[HttpHead("Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}", Name = "HeadItemImage2")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-02 17:14:59 +00:00
[ProducesImageFile]
2020-07-21 19:17:08 +00:00
public async Task < ActionResult > GetItemImage2 (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] Guid itemId ,
[FromRoute, Required] ImageType imageType ,
2020-09-08 00:45:06 +00:00
[FromRoute, Required] int maxWidth ,
[FromRoute, Required] int maxHeight ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2020-09-06 15:07:27 +00:00
[FromRoute, Required] string tag ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-10-02 17:05:39 +00:00
[FromRoute, Required] ImageFormat format ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
2020-09-08 00:45:06 +00:00
[FromRoute, Required] double percentPlayed ,
[FromRoute, Required] int unplayedCount ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromRoute, Required] int imageIndex )
2020-07-21 19:17:08 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get artist image by name.
/// </summary>
/// <param name="name">Artist name.</param>
/// <param name="imageType">Image type.</param>
2020-06-21 17:31:44 +00:00
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-06-21 17:31:44 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
2020-07-21 19:17:08 +00:00
/// <param name="imageIndex">Image index.</param>
2020-06-21 17:31:44 +00:00
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-11-15 17:58:39 +00:00
[HttpGet("Artists/{name}/Images/{imageType}/{imageIndex}")]
[HttpHead("Artists/{name}/Images/{imageType}/{imageIndex}", Name = "HeadArtistImage")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-07-21 19:17:08 +00:00
public async Task < ActionResult > GetArtistImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-10-02 17:05:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-09-08 00:45:06 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
2020-06-21 17:31:44 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
2020-06-21 17:31:44 +00:00
[FromQuery] int? blur ,
2020-07-21 19:17:08 +00:00
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromRoute, Required] int imageIndex )
2020-06-21 17:31:44 +00:00
{
2020-07-21 19:17:08 +00:00
var item = _libraryManager . GetArtist ( name ) ;
2020-06-21 17:31:44 +00:00
if ( item = = null )
{
return NotFound ( ) ;
}
2020-07-21 19:17:08 +00:00
return await GetImageInternal (
item . Id ,
imageType ,
imageIndex ,
tag ,
format ,
maxWidth ,
maxHeight ,
percentPlayed ,
unplayedCount ,
width ,
height ,
quality ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get genre image by name.
/// </summary>
/// <param name="name">Genre name.</param>
/// <param name="imageType">Image type.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-07-21 19:17:08 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <param name="imageIndex">Image index.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-11-15 17:58:39 +00:00
[HttpGet("Genres/{name}/Images/{imageType}")]
[HttpHead("Genres/{name}/Images/{imageType}", Name = "HeadGenreImage")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-07-21 19:17:08 +00:00
public async Task < ActionResult > GetGenreImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-10-02 17:05:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-09-08 00:45:06 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? imageIndex )
2020-07-21 19:17:08 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
2020-11-15 17:58:39 +00:00
/// Get genre image by name.
2020-07-21 19:17:08 +00:00
/// </summary>
2020-11-15 17:58:39 +00:00
/// <param name="name">Genre name.</param>
2020-07-21 19:17:08 +00:00
/// <param name="imageType">Image type.</param>
2020-11-15 17:58:39 +00:00
/// <param name="imageIndex">Image index.</param>
2020-07-21 19:17:08 +00:00
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-07-21 19:17:08 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-11-15 17:58:39 +00:00
[HttpGet("Genres/{name}/Images/{imageType}/{imageIndex}")]
[HttpHead("Genres/{name}/Images/{imageType}/{imageIndex}", Name = "HeadGenreImageByIndex")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-11-15 17:58:39 +00:00
public async Task < ActionResult > GetGenreImageByIndex (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
2020-11-15 17:58:39 +00:00
[FromRoute, Required] int imageIndex ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-10-02 17:05:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-09-08 00:45:06 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
2021-03-17 18:45:28 +00:00
[FromQuery] string? foregroundLayer )
2020-07-21 19:17:08 +00:00
{
2020-11-15 17:58:39 +00:00
var item = _libraryManager . GetGenre ( name ) ;
2020-07-21 19:17:08 +00:00
if ( item = = null )
{
return NotFound ( ) ;
}
return await GetImageInternal (
item . Id ,
imageType ,
imageIndex ,
tag ,
format ,
maxWidth ,
maxHeight ,
percentPlayed ,
unplayedCount ,
width ,
height ,
quality ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
2020-11-15 17:58:39 +00:00
/// Get music genre image by name.
2020-07-21 19:17:08 +00:00
/// </summary>
2020-11-15 17:58:39 +00:00
/// <param name="name">Music genre name.</param>
2020-07-21 19:17:08 +00:00
/// <param name="imageType">Image type.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-07-21 19:17:08 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <param name="imageIndex">Image index.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-11-15 17:58:39 +00:00
[HttpGet("MusicGenres/{name}/Images/{imageType}")]
[HttpHead("MusicGenres/{name}/Images/{imageType}", Name = "HeadMusicGenreImage")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-11-15 17:58:39 +00:00
public async Task < ActionResult > GetMusicGenreImage (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-10-02 17:05:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-09-08 00:45:06 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? imageIndex )
2020-07-21 19:17:08 +00:00
{
2020-11-15 17:58:39 +00:00
var item = _libraryManager . GetMusicGenre ( name ) ;
2020-07-21 19:17:08 +00:00
if ( item = = null )
{
return NotFound ( ) ;
}
return await GetImageInternal (
item . Id ,
imageType ,
imageIndex ,
tag ,
format ,
maxWidth ,
maxHeight ,
percentPlayed ,
unplayedCount ,
width ,
height ,
quality ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
2020-11-15 17:58:39 +00:00
/// Get music genre image by name.
2020-07-21 19:17:08 +00:00
/// </summary>
2020-11-15 17:58:39 +00:00
/// <param name="name">Music genre name.</param>
2020-07-21 19:17:08 +00:00
/// <param name="imageType">Image type.</param>
2020-11-15 17:58:39 +00:00
/// <param name="imageIndex">Image index.</param>
2020-07-21 19:17:08 +00:00
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-07-21 19:17:08 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-11-15 17:58:39 +00:00
[HttpGet("MusicGenres/{name}/Images/{imageType}/{imageIndex}")]
[HttpHead("MusicGenres/{name}/Images/{imageType}/{imageIndex}", Name = "HeadMusicGenreImageByIndex")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-11-15 17:58:39 +00:00
public async Task < ActionResult > GetMusicGenreImageByIndex (
2020-09-06 15:07:27 +00:00
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
2020-11-15 17:58:39 +00:00
[FromRoute, Required] int imageIndex ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-11-15 17:58:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-09-09 20:28:30 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
2021-03-17 18:45:28 +00:00
[FromQuery] string? foregroundLayer )
2020-07-21 19:17:08 +00:00
{
2020-11-15 17:58:39 +00:00
var item = _libraryManager . GetMusicGenre ( name ) ;
2020-07-21 19:17:08 +00:00
if ( item = = null )
{
return NotFound ( ) ;
}
return await GetImageInternal (
item . Id ,
imageType ,
imageIndex ,
tag ,
format ,
maxWidth ,
maxHeight ,
percentPlayed ,
unplayedCount ,
width ,
height ,
quality ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
2020-11-15 17:58:39 +00:00
/// Get person image by name.
2020-07-21 19:17:08 +00:00
/// </summary>
2020-11-15 17:58:39 +00:00
/// <param name="name">Person name.</param>
2020-07-21 19:17:08 +00:00
/// <param name="imageType">Image type.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-07-21 19:17:08 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <param name="imageIndex">Image index.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
2020-11-15 17:58:39 +00:00
[HttpGet("Persons/{name}/Images/{imageType}")]
[HttpHead("Persons/{name}/Images/{imageType}", Name = "HeadPersonImage")]
2020-07-21 19:17:08 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
2020-09-01 23:26:49 +00:00
[ProducesImageFile]
2020-11-15 17:58:39 +00:00
public async Task < ActionResult > GetPersonImage (
[FromRoute, Required] string name ,
2020-09-06 15:07:27 +00:00
[FromRoute, Required] ImageType imageType ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-10-02 17:05:39 +00:00
[FromQuery] ImageFormat ? format ,
2020-07-21 19:17:08 +00:00
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-07-21 19:17:08 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? imageIndex )
2020-11-15 17:58:39 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-11-15 17:58:39 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get person image by name.
/// </summary>
/// <param name="name">Person name.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">Image index.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-11-15 17:58:39 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
[HttpGet("Persons/{name}/Images/{imageType}/{imageIndex}")]
[HttpHead("Persons/{name}/Images/{imageType}/{imageIndex}", Name = "HeadPersonImageByIndex")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesImageFile]
public async Task < ActionResult > GetPersonImageByIndex (
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
[FromRoute, Required] int imageIndex ,
2021-03-05 01:25:52 +00:00
[FromQuery] string? tag ,
2020-11-15 17:58:39 +00:00
[FromQuery] ImageFormat ? format ,
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-11-15 17:58:39 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
2021-03-17 18:45:28 +00:00
[FromQuery] string? foregroundLayer )
2020-11-15 17:58:39 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-11-15 17:58:39 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get studio image by name.
/// </summary>
/// <param name="name">Studio name.</param>
/// <param name="imageType">Image type.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-11-15 17:58:39 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <param name="imageIndex">Image index.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
[HttpGet("Studios/{name}/Images/{imageType}")]
[HttpHead("Studios/{name}/Images/{imageType}", Name = "HeadStudioImage")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesImageFile]
public async Task < ActionResult > GetStudioImage (
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
[FromQuery] string? tag ,
[FromQuery] ImageFormat ? format ,
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-11-15 17:58:39 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? imageIndex )
2020-11-15 17:58:39 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-11-15 17:58:39 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get studio image by name.
/// </summary>
/// <param name="name">Studio name.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">Image index.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-11-15 17:58:39 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
[HttpGet("Studios/{name}/Images/{imageType}/{imageIndex}")]
[HttpHead("Studios/{name}/Images/{imageType}/{imageIndex}", Name = "HeadStudioImageByIndex")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesImageFile]
public async Task < ActionResult > GetStudioImageByIndex (
[FromRoute, Required] string name ,
[FromRoute, Required] ImageType imageType ,
[FromRoute, Required] int imageIndex ,
[FromQuery] string? tag ,
[FromQuery] ImageFormat ? format ,
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-11-15 17:58:39 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
2021-03-17 18:45:28 +00:00
[FromQuery] string? foregroundLayer )
2020-11-15 17:58:39 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-11-15 17:58:39 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
item ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get user profile image.
/// </summary>
/// <param name="userId">User id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-11-15 17:58:39 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <param name="imageIndex">Image index.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
[HttpGet("Users/{userId}/Images/{imageType}")]
[HttpHead("Users/{userId}/Images/{imageType}", Name = "HeadUserImage")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesImageFile]
public async Task < ActionResult > GetUserImage (
[FromRoute, Required] Guid userId ,
[FromRoute, Required] ImageType imageType ,
[FromQuery] string? tag ,
[FromQuery] ImageFormat ? format ,
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-11-15 17:58:39 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
[FromQuery] string? foregroundLayer ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? imageIndex )
2020-11-15 17:58:39 +00:00
{
var user = _userManager . GetUserById ( userId ) ;
2021-03-06 22:43:01 +00:00
if ( user ? . ProfileImage = = null )
2020-11-15 17:58:39 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-11-15 17:58:39 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
null ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) ,
info )
. ConfigureAwait ( false ) ;
}
/// <summary>
/// Get user profile image.
/// </summary>
/// <param name="userId">User id.</param>
/// <param name="imageType">Image type.</param>
/// <param name="imageIndex">Image index.</param>
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
/// <param name="maxWidth">The maximum image width to return.</param>
/// <param name="maxHeight">The maximum image height to return.</param>
/// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
/// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
/// <param name="width">The fixed image width to return.</param>
/// <param name="height">The fixed image height to return.</param>
/// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
2021-03-16 23:15:09 +00:00
/// <param name="fillWidth">Width of box to fill.</param>
/// <param name="fillHeight">Height of box to fill.</param>
2020-11-15 17:58:39 +00:00
/// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
/// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
/// <param name="blur">Optional. Blur image.</param>
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
/// <response code="200">Image stream returned.</response>
/// <response code="404">Item not found.</response>
/// <returns>
/// A <see cref="FileStreamResult"/> containing the file stream on success,
/// or a <see cref="NotFoundResult"/> if item not found.
/// </returns>
[HttpGet("Users/{userId}/Images/{imageType}/{imageIndex}")]
[HttpHead("Users/{userId}/Images/{imageType}/{imageIndex}", Name = "HeadUserImageByIndex")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesImageFile]
public async Task < ActionResult > GetUserImageByIndex (
[FromRoute, Required] Guid userId ,
[FromRoute, Required] ImageType imageType ,
[FromRoute, Required] int imageIndex ,
[FromQuery] string? tag ,
[FromQuery] ImageFormat ? format ,
[FromQuery] int? maxWidth ,
[FromQuery] int? maxHeight ,
[FromQuery] double? percentPlayed ,
[FromQuery] int? unplayedCount ,
[FromQuery] int? width ,
[FromQuery] int? height ,
[FromQuery] int? quality ,
2021-03-17 18:45:28 +00:00
[FromQuery] int? fillWidth ,
[FromQuery] int? fillHeight ,
2021-04-12 13:50:24 +00:00
[FromQuery, ParameterObsolete] bool? cropWhitespace ,
2020-11-15 17:58:39 +00:00
[FromQuery] bool? addPlayedIndicator ,
[FromQuery] int? blur ,
[FromQuery] string? backgroundColor ,
2021-03-17 18:45:28 +00:00
[FromQuery] string? foregroundLayer )
2020-07-21 19:17:08 +00:00
{
var user = _userManager . GetUserById ( userId ) ;
2020-11-21 11:28:32 +00:00
if ( user ? . ProfileImage = = null )
2020-07-21 19:17:08 +00:00
{
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 ,
2021-03-16 23:15:09 +00:00
fillWidth ,
2021-03-17 18:45:28 +00:00
fillHeight ,
2020-07-21 19:17:08 +00:00
addPlayedIndicator ,
blur ,
backgroundColor ,
foregroundLayer ,
null ,
Request . Method . Equals ( HttpMethods . Head , StringComparison . OrdinalIgnoreCase ) ,
info )
. ConfigureAwait ( false ) ;
2020-06-21 17:31:44 +00:00
}
2020-06-19 21:08:35 +00:00
private static async Task < MemoryStream > GetMemoryStream ( Stream inputStream )
{
using var reader = new StreamReader ( inputStream ) ;
var text = await reader . ReadToEndAsync ( ) . ConfigureAwait ( false ) ;
var bytes = Convert . FromBase64String ( text ) ;
2020-08-07 15:38:01 +00:00
return new MemoryStream ( bytes , 0 , bytes . Length , false , true ) ;
2020-06-19 21:08:35 +00:00
}
2020-06-20 23:06:33 +00:00
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 ;
}
}
2020-06-21 17:31:44 +00:00
private async Task < ActionResult > GetImageInternal (
Guid itemId ,
ImageType imageType ,
int? imageIndex ,
2020-07-21 19:17:08 +00:00
string? tag ,
2020-10-02 17:05:39 +00:00
ImageFormat ? format ,
2020-06-21 17:31:44 +00:00
int? maxWidth ,
int? maxHeight ,
double? percentPlayed ,
int? unplayedCount ,
int? width ,
int? height ,
int? quality ,
2021-03-16 23:15:09 +00:00
int? fillWidth ,
2021-03-17 18:45:28 +00:00
int? fillHeight ,
2020-07-21 19:17:08 +00:00
bool? addPlayedIndicator ,
2020-06-21 17:31:44 +00:00
int? blur ,
2020-07-21 19:17:08 +00:00
string? backgroundColor ,
string? foregroundLayer ,
BaseItem ? item ,
bool isHeadRequest ,
ItemImageInfo ? imageInfo = null )
2020-06-21 17:31:44 +00:00
{
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 )
{
2020-07-21 19:17:08 +00:00
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 ) ) ;
}
2020-06-21 17:31:44 +00:00
}
var outputFormats = GetOutputFormats ( format ) ;
TimeSpan ? cacheDuration = null ;
if ( ! string . IsNullOrEmpty ( tag ) )
{
cacheDuration = TimeSpan . FromDays ( 365 ) ;
}
2020-07-21 19:17:08 +00:00
var responseHeaders = new Dictionary < string , string >
{
{ "transferMode.dlna.org" , "Interactive" } ,
{ "realTimeInfo.dlna.org" , "DLNA.ORG_TLAG=*" }
} ;
2020-06-21 17:31:44 +00:00
return await GetImageResult (
item ,
itemId ,
imageIndex ,
2021-03-17 18:45:28 +00:00
width ,
2020-06-21 17:31:44 +00:00
height ,
maxWidth ,
2021-03-17 18:45:28 +00:00
maxHeight ,
fillWidth ,
fillHeight ,
2020-06-21 17:31:44 +00:00
quality ,
addPlayedIndicator ,
percentPlayed ,
unplayedCount ,
blur ,
backgroundColor ,
foregroundLayer ,
imageInfo ,
outputFormats ,
cacheDuration ,
responseHeaders ,
2021-03-17 18:45:28 +00:00
isHeadRequest ) . ConfigureAwait ( false ) ;
2020-06-21 17:31:44 +00:00
}
2020-10-02 17:05:39 +00:00
private ImageFormat [ ] GetOutputFormats ( ImageFormat ? format )
2020-06-21 17:31:44 +00:00
{
2020-10-02 17:05:39 +00:00
if ( format . HasValue )
2020-06-21 17:31:44 +00:00
{
2020-10-02 17:05:39 +00:00
return new [ ] { format . Value } ;
2020-06-21 17:31:44 +00:00
}
return GetClientSupportedFormats ( ) ;
}
private ImageFormat [ ] GetClientSupportedFormats ( )
{
2021-04-12 17:54:32 +00:00
var supportedFormats = Request . Headers . GetCommaSeparatedValues ( HeaderNames . Accept ) ;
for ( var i = 0 ; i < supportedFormats . Length ; i + + )
2020-06-21 17:31:44 +00:00
{
2021-04-12 17:54:32 +00:00
// Remove charsets etc. (anything after semi-colon)
var type = supportedFormats [ i ] ;
int index = type . IndexOf ( ';' , StringComparison . Ordinal ) ;
if ( index ! = - 1 )
2020-06-21 17:31:44 +00:00
{
2021-04-12 17:54:32 +00:00
supportedFormats [ i ] = type . Substring ( 0 , index ) ;
2020-06-21 17:31:44 +00:00
}
}
var acceptParam = Request . Query [ HeaderNames . Accept ] ;
2020-10-02 17:05:39 +00:00
var supportsWebP = SupportsFormat ( supportedFormats , acceptParam , ImageFormat . Webp , false ) ;
2020-06-21 17:31:44 +00:00
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 < ImageFormat > ( 4 ) ;
if ( supportsWebP )
{
formats . Add ( ImageFormat . Webp ) ;
}
formats . Add ( ImageFormat . Jpg ) ;
formats . Add ( ImageFormat . Png ) ;
2020-10-02 17:05:39 +00:00
if ( SupportsFormat ( supportedFormats , acceptParam , ImageFormat . Gif , true ) )
2020-06-21 17:31:44 +00:00
{
formats . Add ( ImageFormat . Gif ) ;
}
return formats . ToArray ( ) ;
}
2020-10-02 17:05:39 +00:00
private bool SupportsFormat ( IReadOnlyCollection < string > requestAcceptTypes , string acceptParam , ImageFormat format , bool acceptAll )
2020-06-21 17:31:44 +00:00
{
2020-10-02 17:05:39 +00:00
var normalized = format . ToString ( ) . ToLowerInvariant ( ) ;
var mimeType = "image/" + normalized ;
2020-06-21 17:31:44 +00:00
if ( requestAcceptTypes . Contains ( mimeType ) )
{
return true ;
}
if ( acceptAll & & requestAcceptTypes . Contains ( "*/*" ) )
{
return true ;
}
2020-10-02 17:05:39 +00:00
return string . Equals ( acceptParam , normalized , StringComparison . OrdinalIgnoreCase ) ;
2020-06-21 17:31:44 +00:00
}
private async Task < ActionResult > GetImageResult (
2020-07-21 19:17:08 +00:00
BaseItem ? item ,
2020-06-21 17:31:44 +00:00
Guid itemId ,
int? index ,
2021-03-17 18:45:28 +00:00
int? width ,
2020-06-21 17:31:44 +00:00
int? height ,
int? maxWidth ,
2021-03-17 18:45:28 +00:00
int? maxHeight ,
int? fillWidth ,
int? fillHeight ,
2020-06-21 17:31:44 +00:00
int? quality ,
2020-07-21 19:17:08 +00:00
bool? addPlayedIndicator ,
2020-06-21 17:31:44 +00:00
double? percentPlayed ,
int? unplayedCount ,
int? blur ,
2020-07-21 19:17:08 +00:00
string? backgroundColor ,
string? foregroundLayer ,
2020-06-21 17:31:44 +00:00
ItemImageInfo imageInfo ,
IReadOnlyCollection < ImageFormat > supportedFormats ,
TimeSpan ? cacheDuration ,
IDictionary < string , string > headers ,
2021-03-17 18:45:28 +00:00
bool isHeadRequest )
2020-06-21 17:31:44 +00:00
{
2020-07-21 19:17:08 +00:00
if ( ! imageInfo . IsLocalFile & & item ! = null )
2020-06-21 17:31:44 +00:00
{
imageInfo = await _libraryManager . ConvertImageToLocal ( item , imageInfo , index ? ? 0 ) . ConfigureAwait ( false ) ;
}
var options = new ImageProcessingOptions
{
Height = height ,
ImageIndex = index ? ? 0 ,
Image = imageInfo ,
Item = item ,
ItemId = itemId ,
MaxHeight = maxHeight ,
MaxWidth = maxWidth ,
2021-03-16 23:15:09 +00:00
FillHeight = fillHeight ,
FillWidth = fillWidth ,
2020-06-21 17:31:44 +00:00
Quality = quality ? ? 100 ,
Width = width ,
2020-07-21 19:17:08 +00:00
AddPlayedIndicator = addPlayedIndicator ? ? false ,
2020-06-21 17:31:44 +00:00
PercentPlayed = percentPlayed ? ? 0 ,
UnplayedCount = unplayedCount ,
Blur = blur ,
BackgroundColor = backgroundColor ,
ForegroundLayer = foregroundLayer ,
SupportedOutputFormats = supportedFormats
} ;
2020-07-21 19:17:08 +00:00
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 ) ;
}
2020-11-13 16:04:31 +00:00
Response . ContentType = imageContentType ? ? MediaTypeNames . Text . Plain ;
2020-07-21 19:17:08 +00:00
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" ) ;
}
2021-09-26 14:14:36 +00:00
Response . Headers . Add ( HeaderNames . LastModified , dateImageModified . ToUniversalTime ( ) . ToString ( "ddd, dd MMM yyyy HH:mm:ss \"GMT\"" , CultureInfo . InvariantCulture ) ) ;
2020-07-21 19:17:08 +00:00
// if the image was not modified since "ifModifiedSinceHeader"-header, return a HTTP status code 304 not modified
2020-08-31 13:24:23 +00:00
if ( ! ( dateImageModified > ifModifiedSinceHeader ) & & cacheDuration . HasValue )
2020-07-21 19:17:08 +00:00
{
2020-08-31 13:24:23 +00:00
if ( ifModifiedSinceHeader . Add ( cacheDuration . Value ) < DateTime . UtcNow )
2020-07-21 19:17:08 +00:00
{
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 ( ) ;
}
2021-02-14 14:11:46 +00:00
return PhysicalFile ( imagePath , imageContentType ? ? MediaTypeNames . Text . Plain ) ;
2020-06-21 17:31:44 +00:00
}
2020-06-19 21:08:35 +00:00
}
}
