1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149 |
- using System;
- using System.Collections.Generic;
- using System.Collections.Immutable;
- using System.ComponentModel.DataAnnotations;
- using System.Diagnostics.CodeAnalysis;
- using System.Globalization;
- using System.IO;
- using System.Linq;
- using System.Net.Mime;
- using System.Security.Cryptography;
- using System.Threading;
- using System.Threading.Tasks;
- using Jellyfin.Api.Attributes;
- using Jellyfin.Api.Extensions;
- using Jellyfin.Api.Helpers;
- using Jellyfin.Extensions;
- using MediaBrowser.Common.Api;
- using MediaBrowser.Common.Configuration;
- using MediaBrowser.Controller.Configuration;
- using MediaBrowser.Controller.Drawing;
- using MediaBrowser.Controller.Entities;
- using MediaBrowser.Controller.Library;
- using MediaBrowser.Controller.Providers;
- using MediaBrowser.Model.Branding;
- 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;
- /// <summary>
- /// Image controller.
- /// </summary>
- [Route("")]
- 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 ILogger<ImageController> _logger;
- private readonly IServerConfigurationManager _serverConfigurationManager;
- private readonly IApplicationPaths _appPaths;
- /// <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="logger">Instance of the <see cref="ILogger{ImageController}"/> interface.</param>
- /// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
- /// <param name="appPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param>
- public ImageController(
- IUserManager userManager,
- ILibraryManager libraryManager,
- IProviderManager providerManager,
- IImageProcessor imageProcessor,
- IFileSystem fileSystem,
- ILogger<ImageController> logger,
- IServerConfigurationManager serverConfigurationManager,
- IApplicationPaths appPaths)
- {
- _userManager = userManager;
- _libraryManager = libraryManager;
- _providerManager = providerManager;
- _imageProcessor = imageProcessor;
- _fileSystem = fileSystem;
- _logger = logger;
- _serverConfigurationManager = serverConfigurationManager;
- _appPaths = appPaths;
- }
- private static CryptoStream GetFromBase64Stream(Stream inputStream)
- => new CryptoStream(inputStream, new FromBase64Transform(), CryptoStreamMode.Read);
- /// <summary>
- /// Sets the user image.
- /// </summary>
- /// <param name="userId">User Id.</param>
- /// <response code="204">Image updated.</response>
- /// <response code="403">User does not have permission to delete the image.</response>
- /// <response code="404">Item not found.</response>
- /// <returns>A <see cref="NoContentResult"/>.</returns>
- [HttpPost("UserImage")]
- [Authorize]
- [AcceptsImageFile]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [ProducesResponseType(StatusCodes.Status403Forbidden)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult> PostUserImage(
- [FromQuery] Guid? userId)
- {
- var requestUserId = RequestHelpers.GetUserId(User, userId);
- var user = _userManager.GetUserById(requestUserId);
- if (user is null)
- {
- return NotFound();
- }
- if (!RequestHelpers.AssertCanUpdateUser(HttpContext.User, user, true))
- {
- return StatusCode(StatusCodes.Status403Forbidden, "User is not allowed to update the image.");
- }
- if (!TryGetImageExtensionFromContentType(Request.ContentType, out string? extension))
- {
- return BadRequest("Incorrect ContentType.");
- }
- var stream = GetFromBase64Stream(Request.Body);
- await using (stream.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 is not null)
- {
- await _userManager.ClearProfileImageAsync(user).ConfigureAwait(false);
- }
- user.ProfileImage = new Database.Implementations.Entities.ImageInfo(Path.Combine(userDataPath, "profile" + extension));
- await _providerManager
- .SaveImage(stream, 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>
- /// <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}")]
- [Authorize]
- [Obsolete("Kept for backwards compatibility")]
- [ApiExplorerSettings(IgnoreApi = true)]
- [AcceptsImageFile]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [ProducesResponseType(StatusCodes.Status403Forbidden)]
- [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageType", Justification = "Imported from ServiceStack")]
- public Task<ActionResult> PostUserImageLegacy(
- [FromRoute, Required] Guid userId,
- [FromRoute, Required] ImageType imageType)
- => PostUserImage(userId);
- /// <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]
- [Obsolete("Kept for backwards compatibility")]
- [ApiExplorerSettings(IgnoreApi = true)]
- [AcceptsImageFile]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [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 Task<ActionResult> PostUserImageByIndexLegacy(
- [FromRoute, Required] Guid userId,
- [FromRoute, Required] ImageType imageType,
- [FromRoute] int index)
- => PostUserImage(userId);
- /// <summary>
- /// Delete the user's image.
- /// </summary>
- /// <param name="userId">User Id.</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("UserImage")]
- [Authorize]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status403Forbidden)]
- public async Task<ActionResult> DeleteUserImage(
- [FromQuery] Guid? userId)
- {
- var requestUserId = RequestHelpers.GetUserId(User, userId);
- var user = _userManager.GetUserById(requestUserId);
- if (user is null)
- {
- return NotFound();
- }
- if (!RequestHelpers.AssertCanUpdateUser(HttpContext.User, user, true))
- {
- return StatusCode(StatusCodes.Status403Forbidden, "User is not allowed to delete the image.");
- }
- if (user.ProfileImage is null)
- {
- return NoContent();
- }
- 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}")]
- [Authorize]
- [Obsolete("Kept for backwards compatibility")]
- [ApiExplorerSettings(IgnoreApi = true)]
- [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 Task<ActionResult> DeleteUserImageLegacy(
- [FromRoute, Required] Guid userId,
- [FromRoute, Required] ImageType imageType,
- [FromQuery] int? index = null)
- => DeleteUserImage(userId);
- /// <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]
- [Obsolete("Kept for backwards compatibility")]
- [ApiExplorerSettings(IgnoreApi = true)]
- [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 Task<ActionResult> DeleteUserImageByIndexLegacy(
- [FromRoute, Required] Guid userId,
- [FromRoute, Required] ImageType imageType,
- [FromRoute] int index)
- => DeleteUserImage(userId);
- /// <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}")]
- [Authorize(Policy = Policies.RequiresElevation)]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult> DeleteItemImage(
- [FromRoute, Required] Guid itemId,
- [FromRoute, Required] ImageType imageType,
- [FromQuery] int? imageIndex)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- await item.DeleteImageAsync(imageType, imageIndex ?? 0).ConfigureAwait(false);
- return NoContent();
- }
- /// <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<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- await item.DeleteImageAsync(imageType, imageIndex).ConfigureAwait(false);
- return NoContent();
- }
- /// <summary>
- /// Set item image.
- /// </summary>
- /// <param name="itemId">Item id.</param>
- /// <param name="imageType">Image type.</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}")]
- [Authorize(Policy = Policies.RequiresElevation)]
- [AcceptsImageFile]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
- public async Task<ActionResult> SetItemImage(
- [FromRoute, Required] Guid itemId,
- [FromRoute, Required] ImageType imageType)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- if (!TryGetImageExtensionFromContentType(Request.ContentType, out _))
- {
- return BadRequest("Incorrect ContentType.");
- }
- var stream = GetFromBase64Stream(Request.Body);
- await using (stream.ConfigureAwait(false))
- {
- // Handle image/png; charset=utf-8
- var mimeType = Request.ContentType?.Split(';').FirstOrDefault();
- await _providerManager.SaveImage(item, stream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
- 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)]
- [AcceptsImageFile]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
- public async Task<ActionResult> SetItemImageByIndex(
- [FromRoute, Required] Guid itemId,
- [FromRoute, Required] ImageType imageType,
- [FromRoute] int imageIndex)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- if (!TryGetImageExtensionFromContentType(Request.ContentType, out _))
- {
- return BadRequest("Incorrect ContentType.");
- }
- var stream = GetFromBase64Stream(Request.Body);
- await using (stream.ConfigureAwait(false))
- {
- // Handle image/png; charset=utf-8
- var mimeType = Request.ContentType?.Split(';').FirstOrDefault();
- await _providerManager.SaveImage(item, stream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
- await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
- 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>
- [HttpPost("Items/{itemId}/Images/{imageType}/{imageIndex}/Index")]
- [Authorize(Policy = Policies.RequiresElevation)]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult> UpdateItemImageIndex(
- [FromRoute, Required] Guid itemId,
- [FromRoute, Required] ImageType imageType,
- [FromRoute, Required] int imageIndex,
- [FromQuery, Required] int newIndex)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- await item.SwapImagesAsync(imageType, imageIndex, newIndex).ConfigureAwait(false);
- 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>
- [HttpGet("Items/{itemId}/Images")]
- [Authorize]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult<IEnumerable<ImageInfo>>> GetItemImageInfos([FromRoute, Required] Guid itemId)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- var list = new List<ImageInfo>();
- var itemImages = item.ImageInfos;
- if (itemImages.Length == 0)
- {
- // short-circuit
- return list;
- }
- await _libraryManager.UpdateImagesAsync(item).ConfigureAwait(false); // 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 is not 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 is not null)
- {
- list.Add(info);
- }
- index++;
- }
- }
- return list;
- }
- /// <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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</param>
- /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
- /// <param name="format">Optional. The <see cref="ImageFormat"/> of the returned image.</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>
- [HttpGet("Items/{itemId}/Images/{imageType}")]
- [HttpHead("Items/{itemId}/Images/{imageType}", Name = "HeadItemImage")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetItemImage(
- [FromRoute, Required] Guid itemId,
- [FromRoute, Required] ImageType imageType,
- [FromQuery] int? maxWidth,
- [FromQuery] int? maxHeight,
- [FromQuery] int? width,
- [FromQuery] int? height,
- [FromQuery] int? quality,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] string? tag,
- [FromQuery] ImageFormat? format,
- [FromQuery] double? percentPlayed,
- [FromQuery] int? unplayedCount,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- itemId,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</param>
- /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
- /// <param name="format">Optional. The <see cref="ImageFormat"/> of the returned image.</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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] string? tag,
- [FromQuery] ImageFormat? format,
- [FromQuery] double? percentPlayed,
- [FromQuery] int? unplayedCount,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- itemId,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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="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>
- [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")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetItemImage2(
- [FromRoute, Required] Guid itemId,
- [FromRoute, Required] ImageType imageType,
- [FromRoute, Required] int maxWidth,
- [FromRoute, Required] int maxHeight,
- [FromQuery] int? width,
- [FromQuery] int? height,
- [FromQuery] int? quality,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromRoute, Required] string tag,
- [FromRoute, Required] ImageFormat format,
- [FromRoute, Required] double percentPlayed,
- [FromRoute, Required] int unplayedCount,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromRoute, Required] int imageIndex)
- {
- var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- itemId,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Get artist image by name.
- /// </summary>
- /// <param name="name">Artist 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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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("Artists/{name}/Images/{imageType}/{imageIndex}")]
- [HttpHead("Artists/{name}/Images/{imageType}/{imageIndex}", Name = "HeadArtistImage")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetArtistImage(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromRoute, Required] int imageIndex)
- {
- var item = _libraryManager.GetArtist(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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("Genres/{name}/Images/{imageType}")]
- [HttpHead("Genres/{name}/Images/{imageType}", Name = "HeadGenreImage")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetGenreImage(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- {
- var item = _libraryManager.GetGenre(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Get genre image by name.
- /// </summary>
- /// <param name="name">Genre 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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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("Genres/{name}/Images/{imageType}/{imageIndex}")]
- [HttpHead("Genres/{name}/Images/{imageType}/{imageIndex}", Name = "HeadGenreImageByIndex")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetGenreImageByIndex(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer)
- {
- var item = _libraryManager.GetGenre(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Get music genre image by name.
- /// </summary>
- /// <param name="name">Music 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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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("MusicGenres/{name}/Images/{imageType}")]
- [HttpHead("MusicGenres/{name}/Images/{imageType}", Name = "HeadMusicGenreImage")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetMusicGenreImage(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- {
- var item = _libraryManager.GetMusicGenre(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Get music genre image by name.
- /// </summary>
- /// <param name="name">Music genre 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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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("MusicGenres/{name}/Images/{imageType}/{imageIndex}")]
- [HttpHead("MusicGenres/{name}/Images/{imageType}/{imageIndex}", Name = "HeadMusicGenreImageByIndex")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetMusicGenreImageByIndex(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer)
- {
- var item = _libraryManager.GetMusicGenre(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Get person image by name.
- /// </summary>
- /// <param name="name">Person 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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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("Persons/{name}/Images/{imageType}")]
- [HttpHead("Persons/{name}/Images/{imageType}", Name = "HeadPersonImage")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetPersonImage(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- {
- var item = _libraryManager.GetPerson(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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,
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer)
- {
- var item = _libraryManager.GetPerson(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- {
- var item = _libraryManager.GetStudio(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer)
- {
- var item = _libraryManager.GetStudio(name);
- if (item is null)
- {
- return NotFound();
- }
- return await GetImageInternal(
- item.Id,
- imageType,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- item)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Get user profile image.
- /// </summary>
- /// <param name="userId">User id.</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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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="400">User id not provided.</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("UserImage")]
- [HttpHead("UserImage", Name = "HeadUserImage")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public async Task<ActionResult> GetUserImage(
- [FromQuery] Guid? userId,
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- {
- var requestUserId = userId ?? User.GetUserId();
- if (requestUserId.IsEmpty())
- {
- return BadRequest("UserId is required if unauthenticated");
- }
- var user = _userManager.GetUserById(requestUserId);
- if (user?.ProfileImage is 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.Profile,
- imageIndex,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- null,
- info)
- .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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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 = "HeadUserImageLegacy")]
- [Obsolete("Kept for backwards compatibility")]
- [ApiExplorerSettings(IgnoreApi = true)]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public Task<ActionResult> GetUserImageLegacy(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery] int? imageIndex)
- => GetUserImage(
- userId,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- imageIndex);
- /// <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>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</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 = "HeadUserImageByIndexLegacy")]
- [Obsolete("Kept for backwards compatibility")]
- [ApiExplorerSettings(IgnoreApi = true)]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- [ProducesImageFile]
- public Task<ActionResult> GetUserImageByIndexLegacy(
- [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,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer)
- => GetUserImage(
- userId,
- tag,
- format,
- maxWidth,
- maxHeight,
- percentPlayed,
- unplayedCount,
- width,
- height,
- quality,
- fillWidth,
- fillHeight,
- blur,
- backgroundColor,
- foregroundLayer,
- imageIndex);
- /// <summary>
- /// Generates or gets the splashscreen.
- /// </summary>
- /// <param name="tag">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="width">The fixed image width to return.</param>
- /// <param name="height">The fixed image height to return.</param>
- /// <param name="fillWidth">Width of box to fill.</param>
- /// <param name="fillHeight">Height of box to fill.</param>
- /// <param name="blur">Blur image.</param>
- /// <param name="backgroundColor">Apply a background color for transparent images.</param>
- /// <param name="foregroundLayer">Apply a foreground layer on top of the image.</param>
- /// <param name="quality">Quality setting, from 0-100.</param>
- /// <response code="200">Splashscreen returned successfully.</response>
- /// <returns>The splashscreen.</returns>
- [HttpGet("Branding/Splashscreen")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesImageFile]
- public async Task<ActionResult> GetSplashscreen(
- [FromQuery] string? tag,
- [FromQuery] ImageFormat? format,
- [FromQuery] int? maxWidth,
- [FromQuery] int? maxHeight,
- [FromQuery] int? width,
- [FromQuery] int? height,
- [FromQuery] int? fillWidth,
- [FromQuery] int? fillHeight,
- [FromQuery] int? blur,
- [FromQuery] string? backgroundColor,
- [FromQuery] string? foregroundLayer,
- [FromQuery, Range(0, 100)] int quality = 90)
- {
- var brandingOptions = _serverConfigurationManager.GetConfiguration<BrandingOptions>("branding");
- if (!brandingOptions.SplashscreenEnabled)
- {
- return NotFound();
- }
- string splashscreenPath;
- if (!string.IsNullOrWhiteSpace(brandingOptions.SplashscreenLocation)
- && System.IO.File.Exists(brandingOptions.SplashscreenLocation))
- {
- splashscreenPath = brandingOptions.SplashscreenLocation;
- }
- else
- {
- splashscreenPath = Path.Combine(_appPaths.DataPath, "splashscreen.png");
- if (!System.IO.File.Exists(splashscreenPath))
- {
- return NotFound();
- }
- }
- var outputFormats = GetOutputFormats(format);
- TimeSpan? cacheDuration = null;
- if (!string.IsNullOrEmpty(tag))
- {
- cacheDuration = TimeSpan.FromDays(365);
- }
- var options = new ImageProcessingOptions
- {
- Image = new ItemImageInfo
- {
- Path = splashscreenPath
- },
- Height = height,
- MaxHeight = maxHeight,
- MaxWidth = maxWidth,
- FillHeight = fillHeight,
- FillWidth = fillWidth,
- Quality = quality,
- Width = width,
- Blur = blur,
- BackgroundColor = backgroundColor,
- ForegroundLayer = foregroundLayer,
- SupportedOutputFormats = outputFormats
- };
- return await GetImageResult(
- options,
- cacheDuration,
- ImmutableDictionary<string, string>.Empty)
- .ConfigureAwait(false);
- }
- /// <summary>
- /// Uploads a custom splashscreen.
- /// The body is expected to the image contents base64 encoded.
- /// </summary>
- /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
- /// <response code="204">Successfully uploaded new splashscreen.</response>
- /// <response code="400">Error reading MimeType from uploaded image.</response>
- /// <response code="403">User does not have permission to upload splashscreen..</response>
- /// <exception cref="ArgumentException">Error reading the image format.</exception>
- [HttpPost("Branding/Splashscreen")]
- [Authorize(Policy = Policies.RequiresElevation)]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status400BadRequest)]
- [ProducesResponseType(StatusCodes.Status403Forbidden)]
- [AcceptsImageFile]
- public async Task<ActionResult> UploadCustomSplashscreen()
- {
- if (!TryGetImageExtensionFromContentType(Request.ContentType, out var extension))
- {
- return BadRequest("Incorrect ContentType.");
- }
- var stream = GetFromBase64Stream(Request.Body);
- await using (stream.ConfigureAwait(false))
- {
- var filePath = Path.Combine(_appPaths.DataPath, "splashscreen-upload" + extension);
- var brandingOptions = _serverConfigurationManager.GetConfiguration<BrandingOptions>("branding");
- brandingOptions.SplashscreenLocation = filePath;
- _serverConfigurationManager.SaveConfiguration("branding", brandingOptions);
- var fs = new FileStream(filePath, FileMode.Create, FileAccess.Write, FileShare.None, IODefaults.FileStreamBufferSize, FileOptions.Asynchronous);
- await using (fs.ConfigureAwait(false))
- {
- await stream.CopyToAsync(fs, CancellationToken.None).ConfigureAwait(false);
- }
- return NoContent();
- }
- }
- /// <summary>
- /// Delete a custom splashscreen.
- /// </summary>
- /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
- /// <response code="204">Successfully deleted the custom splashscreen.</response>
- /// <response code="403">User does not have permission to delete splashscreen..</response>
- [HttpDelete("Branding/Splashscreen")]
- [Authorize(Policy = Policies.RequiresElevation)]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- public ActionResult DeleteCustomSplashscreen()
- {
- var brandingOptions = _serverConfigurationManager.GetConfiguration<BrandingOptions>("branding");
- if (!string.IsNullOrEmpty(brandingOptions.SplashscreenLocation)
- && System.IO.File.Exists(brandingOptions.SplashscreenLocation))
- {
- System.IO.File.Delete(brandingOptions.SplashscreenLocation);
- brandingOptions.SplashscreenLocation = null;
- _serverConfigurationManager.SaveConfiguration("branding", brandingOptions);
- }
- return NoContent();
- }
- 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<ActionResult> GetImageInternal(
- Guid itemId,
- ImageType imageType,
- int? imageIndex,
- string? tag,
- ImageFormat? format,
- int? maxWidth,
- int? maxHeight,
- double? percentPlayed,
- int? unplayedCount,
- int? width,
- int? height,
- int? quality,
- int? fillWidth,
- int? fillHeight,
- int? blur,
- string? backgroundColor,
- string? foregroundLayer,
- BaseItem? item,
- ItemImageInfo? imageInfo = null)
- {
- if (percentPlayed.HasValue)
- {
- if (percentPlayed.Value <= 0)
- {
- percentPlayed = null;
- }
- else if (percentPlayed.Value >= 100)
- {
- percentPlayed = null;
- }
- }
- if (percentPlayed.HasValue)
- {
- unplayedCount = null;
- }
- if (unplayedCount.HasValue
- && unplayedCount.Value <= 0)
- {
- unplayedCount = null;
- }
- if (imageInfo is null)
- {
- imageInfo = item?.GetImageInfo(imageType, imageIndex ?? 0);
- if (imageInfo is null)
- {
- return NotFound(string.Format(NumberFormatInfo.InvariantInfo, "{0} does not have an image of type {1}", item?.Name, imageType));
- }
- }
- var outputFormats = GetOutputFormats(format);
- TimeSpan? cacheDuration = null;
- if (!string.IsNullOrEmpty(tag))
- {
- cacheDuration = TimeSpan.FromDays(365);
- }
- var responseHeaders = new Dictionary<string, string>
- {
- { "transferMode.dlna.org", "Interactive" },
- { "realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*" }
- };
- if (!imageInfo.IsLocalFile && item is not null)
- {
- imageInfo = await _libraryManager.ConvertImageToLocal(item, imageInfo, imageIndex ?? 0).ConfigureAwait(false);
- }
- var options = new ImageProcessingOptions
- {
- Height = height,
- ImageIndex = imageIndex ?? 0,
- Image = imageInfo,
- Item = item,
- ItemId = itemId,
- MaxHeight = maxHeight,
- MaxWidth = maxWidth,
- FillHeight = fillHeight,
- FillWidth = fillWidth,
- Quality = quality ?? 100,
- Width = width,
- PercentPlayed = percentPlayed ?? 0,
- UnplayedCount = unplayedCount,
- Blur = blur,
- BackgroundColor = backgroundColor,
- ForegroundLayer = foregroundLayer,
- SupportedOutputFormats = outputFormats
- };
- return await GetImageResult(
- options,
- cacheDuration,
- responseHeaders).ConfigureAwait(false);
- }
- private ImageFormat[] GetOutputFormats(ImageFormat? format)
- {
- if (format.HasValue)
- {
- return [format.Value];
- }
- return GetClientSupportedFormats();
- }
- private ImageFormat[] GetClientSupportedFormats()
- {
- var supportedFormats = Request.Headers.GetCommaSeparatedValues(HeaderNames.Accept);
- for (var i = 0; i < supportedFormats.Length; i++)
- {
- // Remove charsets etc. (anything after semi-colon)
- var type = supportedFormats[i];
- int index = type.IndexOf(';', StringComparison.Ordinal);
- if (index != -1)
- {
- supportedFormats[i] = type.Substring(0, index);
- }
- }
- var acceptParam = Request.Query[HeaderNames.Accept];
- var supportsWebP = SupportsFormat(supportedFormats, acceptParam, ImageFormat.Webp, false);
- if (!supportsWebP)
- {
- var userAgent = Request.Headers[HeaderNames.UserAgent].ToString();
- if (userAgent.Contains("crosswalk", StringComparison.OrdinalIgnoreCase)
- && userAgent.Contains("android", StringComparison.OrdinalIgnoreCase))
- {
- supportsWebP = true;
- }
- }
- var formats = new List<ImageFormat>(4);
- if (supportsWebP)
- {
- formats.Add(ImageFormat.Webp);
- }
- formats.Add(ImageFormat.Jpg);
- formats.Add(ImageFormat.Png);
- if (SupportsFormat(supportedFormats, acceptParam, ImageFormat.Gif, true))
- {
- formats.Add(ImageFormat.Gif);
- }
- return formats.ToArray();
- }
- private bool SupportsFormat(IReadOnlyCollection<string> requestAcceptTypes, string? acceptParam, ImageFormat format, bool acceptAll)
- {
- if (requestAcceptTypes.Contains(format.GetMimeType()))
- {
- return true;
- }
- if (acceptAll && requestAcceptTypes.Contains("*/*"))
- {
- return true;
- }
- // Review if this should be jpeg, jpg or both for ImageFormat.Jpg
- var normalized = format.ToString().ToLowerInvariant();
- return string.Equals(acceptParam, normalized, StringComparison.OrdinalIgnoreCase);
- }
- private async Task<ActionResult> GetImageResult(
- ImageProcessingOptions imageProcessingOptions,
- TimeSpan? cacheDuration,
- IDictionary<string, string> headers)
- {
- var (imagePath, imageContentType, dateImageModified) = await _imageProcessor.ProcessImage(imageProcessingOptions).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.Append(key, value);
- }
- Response.ContentType = imageContentType ?? MediaTypeNames.Text.Plain;
- Response.Headers.Append(HeaderNames.Age, Convert.ToInt64((DateTime.UtcNow - dateImageModified).TotalSeconds).ToString(CultureInfo.InvariantCulture));
- Response.Headers.Append(HeaderNames.Vary, HeaderNames.Accept);
- Response.Headers.ContentDisposition = "attachment";
- if (disableCaching)
- {
- Response.Headers.Append(HeaderNames.CacheControl, "no-cache, no-store, must-revalidate");
- Response.Headers.Append(HeaderNames.Pragma, "no-cache, no-store, must-revalidate");
- }
- else
- {
- if (cacheDuration.HasValue)
- {
- Response.Headers.Append(HeaderNames.CacheControl, "public, max-age=" + cacheDuration.Value.TotalSeconds);
- }
- else
- {
- Response.Headers.Append(HeaderNames.CacheControl, "public");
- }
- Response.Headers.Append(HeaderNames.LastModified, dateImageModified.ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss \"GMT\"", CultureInfo.InvariantCulture));
- // if the image was not modified since "ifModifiedSinceHeader"-header, return a HTTP status code 304 not modified
- if (!(dateImageModified > ifModifiedSinceHeader) && cacheDuration.HasValue)
- {
- if (ifModifiedSinceHeader.Add(cacheDuration.Value) < DateTime.UtcNow)
- {
- Response.StatusCode = StatusCodes.Status304NotModified;
- return new ContentResult();
- }
- }
- }
- return PhysicalFile(imagePath, imageContentType ?? MediaTypeNames.Text.Plain);
- }
- internal static bool TryGetImageExtensionFromContentType(string? contentType, [NotNullWhen(true)] out string? extension)
- {
- extension = null;
- if (string.IsNullOrEmpty(contentType))
- {
- return false;
- }
- if (MediaTypeHeaderValue.TryParse(contentType, out var parsedValue)
- && parsedValue.MediaType.HasValue
- && MimeTypes.IsImage(parsedValue.MediaType.Value))
- {
- extension = MimeTypes.ToExtension(parsedValue.MediaType.Value);
- return extension is not null;
- }
- return false;
- }
- }
|