aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/ItemRefreshController.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Jellyfin.Api/Controllers/ItemRefreshController.cs')
-rw-r--r--Jellyfin.Api/Controllers/ItemRefreshController.cs125
1 files changed, 62 insertions, 63 deletions
diff --git a/Jellyfin.Api/Controllers/ItemRefreshController.cs b/Jellyfin.Api/Controllers/ItemRefreshController.cs
index 0dc3fbd05..b8f6e91ad 100644
--- a/Jellyfin.Api/Controllers/ItemRefreshController.cs
+++ b/Jellyfin.Api/Controllers/ItemRefreshController.cs
@@ -9,78 +9,77 @@ using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
-namespace Jellyfin.Api.Controllers
+namespace Jellyfin.Api.Controllers;
+
+/// <summary>
+/// Item Refresh Controller.
+/// </summary>
+[Route("Items")]
+[Authorize(Policy = Policies.RequiresElevation)]
+public class ItemRefreshController : BaseJellyfinApiController
{
+ private readonly ILibraryManager _libraryManager;
+ private readonly IProviderManager _providerManager;
+ private readonly IFileSystem _fileSystem;
+
/// <summary>
- /// Item Refresh Controller.
+ /// Initializes a new instance of the <see cref="ItemRefreshController"/> class.
/// </summary>
- [Route("Items")]
- [Authorize(Policy = Policies.RequiresElevation)]
- public class ItemRefreshController : BaseJellyfinApiController
+ /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param>
+ /// <param name="providerManager">Instance of <see cref="IProviderManager"/> interface.</param>
+ /// <param name="fileSystem">Instance of <see cref="IFileSystem"/> interface.</param>
+ public ItemRefreshController(
+ ILibraryManager libraryManager,
+ IProviderManager providerManager,
+ IFileSystem fileSystem)
{
- private readonly ILibraryManager _libraryManager;
- private readonly IProviderManager _providerManager;
- private readonly IFileSystem _fileSystem;
+ _libraryManager = libraryManager;
+ _providerManager = providerManager;
+ _fileSystem = fileSystem;
+ }
- /// <summary>
- /// Initializes a new instance of the <see cref="ItemRefreshController"/> class.
- /// </summary>
- /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param>
- /// <param name="providerManager">Instance of <see cref="IProviderManager"/> interface.</param>
- /// <param name="fileSystem">Instance of <see cref="IFileSystem"/> interface.</param>
- public ItemRefreshController(
- ILibraryManager libraryManager,
- IProviderManager providerManager,
- IFileSystem fileSystem)
+ /// <summary>
+ /// Refreshes metadata for an item.
+ /// </summary>
+ /// <param name="itemId">Item id.</param>
+ /// <param name="metadataRefreshMode">(Optional) Specifies the metadata refresh mode.</param>
+ /// <param name="imageRefreshMode">(Optional) Specifies the image refresh mode.</param>
+ /// <param name="replaceAllMetadata">(Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.</param>
+ /// <param name="replaceAllImages">(Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.</param>
+ /// <response code="204">Item metadata refresh queued.</response>
+ /// <response code="404">Item to refresh not found.</response>
+ /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the item could not be found.</returns>
+ [HttpPost("{itemId}/Refresh")]
+ [Description("Refreshes metadata for an item.")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult RefreshItem(
+ [FromRoute, Required] Guid itemId,
+ [FromQuery] MetadataRefreshMode metadataRefreshMode = MetadataRefreshMode.None,
+ [FromQuery] MetadataRefreshMode imageRefreshMode = MetadataRefreshMode.None,
+ [FromQuery] bool replaceAllMetadata = false,
+ [FromQuery] bool replaceAllImages = false)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item is null)
{
- _libraryManager = libraryManager;
- _providerManager = providerManager;
- _fileSystem = fileSystem;
+ return NotFound();
}
- /// <summary>
- /// Refreshes metadata for an item.
- /// </summary>
- /// <param name="itemId">Item id.</param>
- /// <param name="metadataRefreshMode">(Optional) Specifies the metadata refresh mode.</param>
- /// <param name="imageRefreshMode">(Optional) Specifies the image refresh mode.</param>
- /// <param name="replaceAllMetadata">(Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.</param>
- /// <param name="replaceAllImages">(Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.</param>
- /// <response code="204">Item metadata refresh queued.</response>
- /// <response code="404">Item to refresh not found.</response>
- /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the item could not be found.</returns>
- [HttpPost("{itemId}/Refresh")]
- [Description("Refreshes metadata for an item.")]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public ActionResult RefreshItem(
- [FromRoute, Required] Guid itemId,
- [FromQuery] MetadataRefreshMode metadataRefreshMode = MetadataRefreshMode.None,
- [FromQuery] MetadataRefreshMode imageRefreshMode = MetadataRefreshMode.None,
- [FromQuery] bool replaceAllMetadata = false,
- [FromQuery] bool replaceAllImages = false)
+ var refreshOptions = new MetadataRefreshOptions(new DirectoryService(_fileSystem))
{
- var item = _libraryManager.GetItemById(itemId);
- if (item is null)
- {
- return NotFound();
- }
+ MetadataRefreshMode = metadataRefreshMode,
+ ImageRefreshMode = imageRefreshMode,
+ ReplaceAllImages = replaceAllImages,
+ ReplaceAllMetadata = replaceAllMetadata,
+ ForceSave = metadataRefreshMode == MetadataRefreshMode.FullRefresh
+ || imageRefreshMode == MetadataRefreshMode.FullRefresh
+ || replaceAllImages
+ || replaceAllMetadata,
+ IsAutomated = false
+ };
- var refreshOptions = new MetadataRefreshOptions(new DirectoryService(_fileSystem))
- {
- MetadataRefreshMode = metadataRefreshMode,
- ImageRefreshMode = imageRefreshMode,
- ReplaceAllImages = replaceAllImages,
- ReplaceAllMetadata = replaceAllMetadata,
- ForceSave = metadataRefreshMode == MetadataRefreshMode.FullRefresh
- || imageRefreshMode == MetadataRefreshMode.FullRefresh
- || replaceAllImages
- || replaceAllMetadata,
- IsAutomated = false
- };
-
- _providerManager.QueueRefresh(item.Id, refreshOptions, RefreshPriority.High);
- return NoContent();
- }
+ _providerManager.QueueRefresh(item.Id, refreshOptions, RefreshPriority.High);
+ return NoContent();
}
}