aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/RemoteImageController.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Jellyfin.Api/Controllers/RemoteImageController.cs')
-rw-r--r--Jellyfin.Api/Controllers/RemoteImageController.cs277
1 files changed, 138 insertions, 139 deletions
diff --git a/Jellyfin.Api/Controllers/RemoteImageController.cs b/Jellyfin.Api/Controllers/RemoteImageController.cs
index da9e8cf90..445c5594f 100644
--- a/Jellyfin.Api/Controllers/RemoteImageController.cs
+++ b/Jellyfin.Api/Controllers/RemoteImageController.cs
@@ -15,165 +15,164 @@ using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
-namespace Jellyfin.Api.Controllers
+namespace Jellyfin.Api.Controllers;
+
+/// <summary>
+/// Remote Images Controller.
+/// </summary>
+[Route("")]
+public class RemoteImageController : BaseJellyfinApiController
{
+ private readonly IProviderManager _providerManager;
+ private readonly IServerApplicationPaths _applicationPaths;
+ private readonly ILibraryManager _libraryManager;
+
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RemoteImageController"/> class.
+ /// </summary>
+ /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
+ /// <param name="applicationPaths">Instance of the <see cref="IServerApplicationPaths"/> interface.</param>
+ /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
+ public RemoteImageController(
+ IProviderManager providerManager,
+ IServerApplicationPaths applicationPaths,
+ ILibraryManager libraryManager)
+ {
+ _providerManager = providerManager;
+ _applicationPaths = applicationPaths;
+ _libraryManager = libraryManager;
+ }
+
/// <summary>
- /// Remote Images Controller.
+ /// Gets available remote images for an item.
/// </summary>
- [Route("")]
- public class RemoteImageController : BaseJellyfinApiController
+ /// <param name="itemId">Item Id.</param>
+ /// <param name="type">The image type.</param>
+ /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
+ /// <param name="limit">Optional. The maximum number of records to return.</param>
+ /// <param name="providerName">Optional. The image provider to use.</param>
+ /// <param name="includeAllLanguages">Optional. Include all languages.</param>
+ /// <response code="200">Remote Images returned.</response>
+ /// <response code="404">Item not found.</response>
+ /// <returns>Remote Image Result.</returns>
+ [HttpGet("Items/{itemId}/RemoteImages")]
+ [Authorize(Policy = Policies.DefaultAuthorization)]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task<ActionResult<RemoteImageResult>> GetRemoteImages(
+ [FromRoute, Required] Guid itemId,
+ [FromQuery] ImageType? type,
+ [FromQuery] int? startIndex,
+ [FromQuery] int? limit,
+ [FromQuery] string? providerName,
+ [FromQuery] bool includeAllLanguages = false)
{
- private readonly IProviderManager _providerManager;
- private readonly IServerApplicationPaths _applicationPaths;
- private readonly ILibraryManager _libraryManager;
-
- /// <summary>
- /// Initializes a new instance of the <see cref="RemoteImageController"/> class.
- /// </summary>
- /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
- /// <param name="applicationPaths">Instance of the <see cref="IServerApplicationPaths"/> interface.</param>
- /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
- public RemoteImageController(
- IProviderManager providerManager,
- IServerApplicationPaths applicationPaths,
- ILibraryManager libraryManager)
+ var item = _libraryManager.GetItemById(itemId);
+ if (item is null)
{
- _providerManager = providerManager;
- _applicationPaths = applicationPaths;
- _libraryManager = libraryManager;
+ return NotFound();
}
- /// <summary>
- /// Gets available remote images for an item.
- /// </summary>
- /// <param name="itemId">Item Id.</param>
- /// <param name="type">The image type.</param>
- /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
- /// <param name="limit">Optional. The maximum number of records to return.</param>
- /// <param name="providerName">Optional. The image provider to use.</param>
- /// <param name="includeAllLanguages">Optional. Include all languages.</param>
- /// <response code="200">Remote Images returned.</response>
- /// <response code="404">Item not found.</response>
- /// <returns>Remote Image Result.</returns>
- [HttpGet("Items/{itemId}/RemoteImages")]
- [Authorize(Policy = Policies.DefaultAuthorization)]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult<RemoteImageResult>> GetRemoteImages(
- [FromRoute, Required] Guid itemId,
- [FromQuery] ImageType? type,
- [FromQuery] int? startIndex,
- [FromQuery] int? limit,
- [FromQuery] string? providerName,
- [FromQuery] bool includeAllLanguages = false)
+ var images = await _providerManager.GetAvailableRemoteImages(
+ item,
+ new RemoteImageQuery(providerName ?? string.Empty)
+ {
+ IncludeAllLanguages = includeAllLanguages,
+ IncludeDisabledProviders = true,
+ ImageType = type
+ },
+ CancellationToken.None)
+ .ConfigureAwait(false);
+
+ var imageArray = images.ToArray();
+ var allProviders = _providerManager.GetRemoteImageProviderInfo(item);
+ if (type.HasValue)
{
- var item = _libraryManager.GetItemById(itemId);
- if (item is null)
- {
- return NotFound();
- }
-
- var images = await _providerManager.GetAvailableRemoteImages(
- item,
- new RemoteImageQuery(providerName ?? string.Empty)
- {
- IncludeAllLanguages = includeAllLanguages,
- IncludeDisabledProviders = true,
- ImageType = type
- },
- CancellationToken.None)
- .ConfigureAwait(false);
-
- var imageArray = images.ToArray();
- var allProviders = _providerManager.GetRemoteImageProviderInfo(item);
- if (type.HasValue)
- {
- allProviders = allProviders.Where(o => o.SupportedImages.Contains(type.Value));
- }
-
- var result = new RemoteImageResult
- {
- TotalRecordCount = imageArray.Length,
- Providers = allProviders.Select(o => o.Name)
- .Distinct(StringComparer.OrdinalIgnoreCase)
- .ToArray()
- };
-
- if (startIndex.HasValue)
- {
- imageArray = imageArray.Skip(startIndex.Value).ToArray();
- }
-
- if (limit.HasValue)
- {
- imageArray = imageArray.Take(limit.Value).ToArray();
- }
-
- result.Images = imageArray;
- return result;
+ allProviders = allProviders.Where(o => o.SupportedImages.Contains(type.Value));
}
- /// <summary>
- /// Gets available remote image providers for an item.
- /// </summary>
- /// <param name="itemId">Item Id.</param>
- /// <response code="200">Returned remote image providers.</response>
- /// <response code="404">Item not found.</response>
- /// <returns>List of remote image providers.</returns>
- [HttpGet("Items/{itemId}/RemoteImages/Providers")]
- [Authorize(Policy = Policies.DefaultAuthorization)]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public ActionResult<IEnumerable<ImageProviderInfo>> GetRemoteImageProviders([FromRoute, Required] Guid itemId)
+ var result = new RemoteImageResult
{
- var item = _libraryManager.GetItemById(itemId);
- if (item is null)
- {
- return NotFound();
- }
+ TotalRecordCount = imageArray.Length,
+ Providers = allProviders.Select(o => o.Name)
+ .Distinct(StringComparer.OrdinalIgnoreCase)
+ .ToArray()
+ };
- return Ok(_providerManager.GetRemoteImageProviderInfo(item));
+ if (startIndex.HasValue)
+ {
+ imageArray = imageArray.Skip(startIndex.Value).ToArray();
}
- /// <summary>
- /// Downloads a remote image for an item.
- /// </summary>
- /// <param name="itemId">Item Id.</param>
- /// <param name="type">The image type.</param>
- /// <param name="imageUrl">The image url.</param>
- /// <response code="204">Remote image downloaded.</response>
- /// <response code="404">Remote image not found.</response>
- /// <returns>Download status.</returns>
- [HttpPost("Items/{itemId}/RemoteImages/Download")]
- [Authorize(Policy = Policies.RequiresElevation)]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult> DownloadRemoteImage(
- [FromRoute, Required] Guid itemId,
- [FromQuery, Required] ImageType type,
- [FromQuery] string? imageUrl)
+ if (limit.HasValue)
{
- var item = _libraryManager.GetItemById(itemId);
- if (item is null)
- {
- return NotFound();
- }
+ imageArray = imageArray.Take(limit.Value).ToArray();
+ }
- await _providerManager.SaveImage(item, imageUrl, type, null, CancellationToken.None)
- .ConfigureAwait(false);
+ result.Images = imageArray;
+ return result;
+ }
- await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
- return NoContent();
+ /// <summary>
+ /// Gets available remote image providers for an item.
+ /// </summary>
+ /// <param name="itemId">Item Id.</param>
+ /// <response code="200">Returned remote image providers.</response>
+ /// <response code="404">Item not found.</response>
+ /// <returns>List of remote image providers.</returns>
+ [HttpGet("Items/{itemId}/RemoteImages/Providers")]
+ [Authorize(Policy = Policies.DefaultAuthorization)]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult<IEnumerable<ImageProviderInfo>> GetRemoteImageProviders([FromRoute, Required] Guid itemId)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item is null)
+ {
+ return NotFound();
}
- /// <summary>
- /// Gets the full cache path.
- /// </summary>
- /// <param name="filename">The filename.</param>
- /// <returns>System.String.</returns>
- private string GetFullCachePath(string filename)
+ return Ok(_providerManager.GetRemoteImageProviderInfo(item));
+ }
+
+ /// <summary>
+ /// Downloads a remote image for an item.
+ /// </summary>
+ /// <param name="itemId">Item Id.</param>
+ /// <param name="type">The image type.</param>
+ /// <param name="imageUrl">The image url.</param>
+ /// <response code="204">Remote image downloaded.</response>
+ /// <response code="404">Remote image not found.</response>
+ /// <returns>Download status.</returns>
+ [HttpPost("Items/{itemId}/RemoteImages/Download")]
+ [Authorize(Policy = Policies.RequiresElevation)]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task<ActionResult> DownloadRemoteImage(
+ [FromRoute, Required] Guid itemId,
+ [FromQuery, Required] ImageType type,
+ [FromQuery] string? imageUrl)
+ {
+ var item = _libraryManager.GetItemById(itemId);
+ if (item is null)
{
- return Path.Combine(_applicationPaths.CachePath, "remote-images", filename.Substring(0, 1), filename);
+ return NotFound();
}
+
+ await _providerManager.SaveImage(item, imageUrl, type, null, CancellationToken.None)
+ .ConfigureAwait(false);
+
+ await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
+ return NoContent();
+ }
+
+ /// <summary>
+ /// Gets the full cache path.
+ /// </summary>
+ /// <param name="filename">The filename.</param>
+ /// <returns>System.String.</returns>
+ private string GetFullCachePath(string filename)
+ {
+ return Path.Combine(_applicationPaths.CachePath, "remote-images", filename.Substring(0, 1), filename);
}
}
generated by cgit v1.2.3 (git 2.46.0) at 2025-12-06 22:30:34 +0000