aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/UserViewsController.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Jellyfin.Api/Controllers/UserViewsController.cs')
-rw-r--r--Jellyfin.Api/Controllers/UserViewsController.cs195
1 files changed, 97 insertions, 98 deletions
diff --git a/Jellyfin.Api/Controllers/UserViewsController.cs b/Jellyfin.Api/Controllers/UserViewsController.cs
index 3aeb444df..aa7ba8891 100644
--- a/Jellyfin.Api/Controllers/UserViewsController.cs
+++ b/Jellyfin.Api/Controllers/UserViewsController.cs
@@ -17,122 +17,121 @@ using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
-namespace Jellyfin.Api.Controllers
+namespace Jellyfin.Api.Controllers;
+
+/// <summary>
+/// User views controller.
+/// </summary>
+[Route("")]
+[Authorize(Policy = Policies.DefaultAuthorization)]
+public class UserViewsController : BaseJellyfinApiController
{
+ private readonly IUserManager _userManager;
+ private readonly IUserViewManager _userViewManager;
+ private readonly IDtoService _dtoService;
+ private readonly ILibraryManager _libraryManager;
+
/// <summary>
- /// User views controller.
+ /// Initializes a new instance of the <see cref="UserViewsController"/> class.
/// </summary>
- [Route("")]
- [Authorize(Policy = Policies.DefaultAuthorization)]
- public class UserViewsController : BaseJellyfinApiController
+ /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
+ /// <param name="userViewManager">Instance of the <see cref="IUserViewManager"/> interface.</param>
+ /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
+ /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
+ public UserViewsController(
+ IUserManager userManager,
+ IUserViewManager userViewManager,
+ IDtoService dtoService,
+ ILibraryManager libraryManager)
{
- private readonly IUserManager _userManager;
- private readonly IUserViewManager _userViewManager;
- private readonly IDtoService _dtoService;
- private readonly ILibraryManager _libraryManager;
+ _userManager = userManager;
+ _userViewManager = userViewManager;
+ _dtoService = dtoService;
+ _libraryManager = libraryManager;
+ }
- /// <summary>
- /// Initializes a new instance of the <see cref="UserViewsController"/> class.
- /// </summary>
- /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
- /// <param name="userViewManager">Instance of the <see cref="IUserViewManager"/> interface.</param>
- /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
- /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
- public UserViewsController(
- IUserManager userManager,
- IUserViewManager userViewManager,
- IDtoService dtoService,
- ILibraryManager libraryManager)
+ /// <summary>
+ /// Get user views.
+ /// </summary>
+ /// <param name="userId">User id.</param>
+ /// <param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</param>
+ /// <param name="presetViews">Preset views.</param>
+ /// <param name="includeHidden">Whether or not to include hidden content.</param>
+ /// <response code="200">User views returned.</response>
+ /// <returns>An <see cref="OkResult"/> containing the user views.</returns>
+ [HttpGet("Users/{userId}/Views")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ public QueryResult<BaseItemDto> GetUserViews(
+ [FromRoute, Required] Guid userId,
+ [FromQuery] bool? includeExternalContent,
+ [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] string[] presetViews,
+ [FromQuery] bool includeHidden = false)
+ {
+ var query = new UserViewQuery
{
- _userManager = userManager;
- _userViewManager = userViewManager;
- _dtoService = dtoService;
- _libraryManager = libraryManager;
- }
+ UserId = userId,
+ IncludeHidden = includeHidden
+ };
- /// <summary>
- /// Get user views.
- /// </summary>
- /// <param name="userId">User id.</param>
- /// <param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</param>
- /// <param name="presetViews">Preset views.</param>
- /// <param name="includeHidden">Whether or not to include hidden content.</param>
- /// <response code="200">User views returned.</response>
- /// <returns>An <see cref="OkResult"/> containing the user views.</returns>
- [HttpGet("Users/{userId}/Views")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- public QueryResult<BaseItemDto> GetUserViews(
- [FromRoute, Required] Guid userId,
- [FromQuery] bool? includeExternalContent,
- [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] string[] presetViews,
- [FromQuery] bool includeHidden = false)
+ if (includeExternalContent.HasValue)
{
- var query = new UserViewQuery
- {
- UserId = userId,
- IncludeHidden = includeHidden
- };
+ query.IncludeExternalContent = includeExternalContent.Value;
+ }
- if (includeExternalContent.HasValue)
- {
- query.IncludeExternalContent = includeExternalContent.Value;
- }
+ if (presetViews.Length != 0)
+ {
+ query.PresetViews = presetViews;
+ }
- if (presetViews.Length != 0)
- {
- query.PresetViews = presetViews;
- }
+ var folders = _userViewManager.GetUserViews(query);
- var folders = _userViewManager.GetUserViews(query);
+ var dtoOptions = new DtoOptions().AddClientFields(User);
+ var fields = dtoOptions.Fields.ToList();
- var dtoOptions = new DtoOptions().AddClientFields(User);
- var fields = dtoOptions.Fields.ToList();
+ fields.Add(ItemFields.PrimaryImageAspectRatio);
+ fields.Add(ItemFields.DisplayPreferencesId);
+ fields.Remove(ItemFields.BasicSyncInfo);
+ dtoOptions.Fields = fields.ToArray();
- fields.Add(ItemFields.PrimaryImageAspectRatio);
- fields.Add(ItemFields.DisplayPreferencesId);
- fields.Remove(ItemFields.BasicSyncInfo);
- dtoOptions.Fields = fields.ToArray();
+ var user = _userManager.GetUserById(userId);
- var user = _userManager.GetUserById(userId);
+ var dtos = folders.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user))
+ .ToArray();
- var dtos = folders.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user))
- .ToArray();
+ return new QueryResult<BaseItemDto>(dtos);
+ }
- return new QueryResult<BaseItemDto>(dtos);
+ /// <summary>
+ /// Get user view grouping options.
+ /// </summary>
+ /// <param name="userId">User id.</param>
+ /// <response code="200">User view grouping options returned.</response>
+ /// <response code="404">User not found.</response>
+ /// <returns>
+ /// An <see cref="OkResult"/> containing the user view grouping options
+ /// or a <see cref="NotFoundResult"/> if user not found.
+ /// </returns>
+ [HttpGet("Users/{userId}/GroupingOptions")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult<IEnumerable<SpecialViewOptionDto>> GetGroupingOptions([FromRoute, Required] Guid userId)
+ {
+ var user = _userManager.GetUserById(userId);
+ if (user is null)
+ {
+ return NotFound();
}
- /// <summary>
- /// Get user view grouping options.
- /// </summary>
- /// <param name="userId">User id.</param>
- /// <response code="200">User view grouping options returned.</response>
- /// <response code="404">User not found.</response>
- /// <returns>
- /// An <see cref="OkResult"/> containing the user view grouping options
- /// or a <see cref="NotFoundResult"/> if user not found.
- /// </returns>
- [HttpGet("Users/{userId}/GroupingOptions")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public ActionResult<IEnumerable<SpecialViewOptionDto>> GetGroupingOptions([FromRoute, Required] Guid userId)
- {
- var user = _userManager.GetUserById(userId);
- if (user is null)
+ return Ok(_libraryManager.GetUserRootFolder()
+ .GetChildren(user, true)
+ .OfType<Folder>()
+ .Where(UserView.IsEligibleForGrouping)
+ .Select(i => new SpecialViewOptionDto
{
- return NotFound();
- }
-
- return Ok(_libraryManager.GetUserRootFolder()
- .GetChildren(user, true)
- .OfType<Folder>()
- .Where(UserView.IsEligibleForGrouping)
- .Select(i => new SpecialViewOptionDto
- {
- Name = i.Name,
- Id = i.Id.ToString("N", CultureInfo.InvariantCulture)
- })
- .OrderBy(i => i.Name)
- .AsEnumerable());
- }
+ Name = i.Name,
+ Id = i.Id.ToString("N", CultureInfo.InvariantCulture)
+ })
+ .OrderBy(i => i.Name)
+ .AsEnumerable());
}
}