UserLibraryController.cs 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel.DataAnnotations;
  4. using System.Linq;
  5. using System.Threading;
  6. using System.Threading.Tasks;
  7. using Jellyfin.Api.Extensions;
  8. using Jellyfin.Api.Helpers;
  9. using Jellyfin.Api.ModelBinders;
  10. using Jellyfin.Data.Entities;
  11. using Jellyfin.Data.Enums;
  12. using Jellyfin.Extensions;
  13. using MediaBrowser.Controller.Dto;
  14. using MediaBrowser.Controller.Entities;
  15. using MediaBrowser.Controller.Entities.Audio;
  16. using MediaBrowser.Controller.Library;
  17. using MediaBrowser.Controller.Providers;
  18. using MediaBrowser.Model.Dto;
  19. using MediaBrowser.Model.Entities;
  20. using MediaBrowser.Model.IO;
  21. using MediaBrowser.Model.Querying;
  22. using Microsoft.AspNetCore.Authorization;
  23. using Microsoft.AspNetCore.Http;
  24. using Microsoft.AspNetCore.Mvc;
  25. namespace Jellyfin.Api.Controllers;
  26. /// <summary>
  27. /// User library controller.
  28. /// </summary>
  29. [Route("")]
  30. [Authorize]
  31. public class UserLibraryController : BaseJellyfinApiController
  32. {
  33. private readonly IUserManager _userManager;
  34. private readonly IUserDataManager _userDataRepository;
  35. private readonly ILibraryManager _libraryManager;
  36. private readonly IDtoService _dtoService;
  37. private readonly IUserViewManager _userViewManager;
  38. private readonly IFileSystem _fileSystem;
  39. /// <summary>
  40. /// Initializes a new instance of the <see cref="UserLibraryController"/> class.
  41. /// </summary>
  42. /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
  43. /// <param name="userDataRepository">Instance of the <see cref="IUserDataManager"/> interface.</param>
  44. /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
  45. /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
  46. /// <param name="userViewManager">Instance of the <see cref="IUserViewManager"/> interface.</param>
  47. /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param>
  48. public UserLibraryController(
  49. IUserManager userManager,
  50. IUserDataManager userDataRepository,
  51. ILibraryManager libraryManager,
  52. IDtoService dtoService,
  53. IUserViewManager userViewManager,
  54. IFileSystem fileSystem)
  55. {
  56. _userManager = userManager;
  57. _userDataRepository = userDataRepository;
  58. _libraryManager = libraryManager;
  59. _dtoService = dtoService;
  60. _userViewManager = userViewManager;
  61. _fileSystem = fileSystem;
  62. }
  63. /// <summary>
  64. /// Gets an item from a user's library.
  65. /// </summary>
  66. /// <param name="userId">User id.</param>
  67. /// <param name="itemId">Item id.</param>
  68. /// <response code="200">Item returned.</response>
  69. /// <returns>An <see cref="OkResult"/> containing the item.</returns>
  70. [HttpGet("Items/{itemId}")]
  71. [ProducesResponseType(StatusCodes.Status200OK)]
  72. public async Task<ActionResult<BaseItemDto>> GetItem(
  73. [FromQuery] Guid? userId,
  74. [FromRoute, Required] Guid itemId)
  75. {
  76. userId = RequestHelpers.GetUserId(User, userId);
  77. var user = _userManager.GetUserById(userId.Value);
  78. if (user is null)
  79. {
  80. return NotFound();
  81. }
  82. var item = itemId.IsEmpty()
  83. ? _libraryManager.GetUserRootFolder()
  84. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  85. if (item is null)
  86. {
  87. return NotFound();
  88. }
  89. await RefreshItemOnDemandIfNeeded(item).ConfigureAwait(false);
  90. var dtoOptions = new DtoOptions().AddClientFields(User);
  91. return _dtoService.GetBaseItemDto(item, dtoOptions, user);
  92. }
  93. /// <summary>
  94. /// Gets an item from a user's library.
  95. /// </summary>
  96. /// <param name="userId">User id.</param>
  97. /// <param name="itemId">Item id.</param>
  98. /// <response code="200">Item returned.</response>
  99. /// <returns>An <see cref="OkResult"/> containing the item.</returns>
  100. [HttpGet("Users/{userId}/Items/{itemId}")]
  101. [ProducesResponseType(StatusCodes.Status200OK)]
  102. [Obsolete("Kept for backwards compatibility")]
  103. [ApiExplorerSettings(IgnoreApi = true)]
  104. public Task<ActionResult<BaseItemDto>> GetItemLegacy(
  105. [FromRoute, Required] Guid userId,
  106. [FromRoute, Required] Guid itemId)
  107. => GetItem(userId, itemId);
  108. /// <summary>
  109. /// Gets the root folder from a user's library.
  110. /// </summary>
  111. /// <param name="userId">User id.</param>
  112. /// <response code="200">Root folder returned.</response>
  113. /// <returns>An <see cref="OkResult"/> containing the user's root folder.</returns>
  114. [HttpGet("Items/Root")]
  115. [ProducesResponseType(StatusCodes.Status200OK)]
  116. public ActionResult<BaseItemDto> GetRootFolder([FromQuery] Guid? userId)
  117. {
  118. userId = RequestHelpers.GetUserId(User, userId);
  119. var user = _userManager.GetUserById(userId.Value);
  120. if (user is null)
  121. {
  122. return NotFound();
  123. }
  124. var item = _libraryManager.GetUserRootFolder();
  125. var dtoOptions = new DtoOptions().AddClientFields(User);
  126. return _dtoService.GetBaseItemDto(item, dtoOptions, user);
  127. }
  128. /// <summary>
  129. /// Gets the root folder from a user's library.
  130. /// </summary>
  131. /// <param name="userId">User id.</param>
  132. /// <response code="200">Root folder returned.</response>
  133. /// <returns>An <see cref="OkResult"/> containing the user's root folder.</returns>
  134. [HttpGet("Users/{userId}/Items/Root")]
  135. [ProducesResponseType(StatusCodes.Status200OK)]
  136. [Obsolete("Kept for backwards compatibility")]
  137. [ApiExplorerSettings(IgnoreApi = true)]
  138. public ActionResult<BaseItemDto> GetRootFolderLegacy(
  139. [FromRoute, Required] Guid userId)
  140. => GetRootFolder(userId);
  141. /// <summary>
  142. /// Gets intros to play before the main media item plays.
  143. /// </summary>
  144. /// <param name="userId">User id.</param>
  145. /// <param name="itemId">Item id.</param>
  146. /// <response code="200">Intros returned.</response>
  147. /// <returns>An <see cref="OkResult"/> containing the intros to play.</returns>
  148. [HttpGet("Items/{itemId}/Intros")]
  149. [ProducesResponseType(StatusCodes.Status200OK)]
  150. public async Task<ActionResult<QueryResult<BaseItemDto>>> GetIntros(
  151. [FromQuery] Guid? userId,
  152. [FromRoute, Required] Guid itemId)
  153. {
  154. userId = RequestHelpers.GetUserId(User, userId);
  155. var user = _userManager.GetUserById(userId.Value);
  156. if (user is null)
  157. {
  158. return NotFound();
  159. }
  160. var item = itemId.IsEmpty()
  161. ? _libraryManager.GetUserRootFolder()
  162. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  163. if (item is null)
  164. {
  165. return NotFound();
  166. }
  167. var items = await _libraryManager.GetIntros(item, user).ConfigureAwait(false);
  168. var dtoOptions = new DtoOptions().AddClientFields(User);
  169. var dtos = items.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user)).ToArray();
  170. return new QueryResult<BaseItemDto>(dtos);
  171. }
  172. /// <summary>
  173. /// Gets intros to play before the main media item plays.
  174. /// </summary>
  175. /// <param name="userId">User id.</param>
  176. /// <param name="itemId">Item id.</param>
  177. /// <response code="200">Intros returned.</response>
  178. /// <returns>An <see cref="OkResult"/> containing the intros to play.</returns>
  179. [HttpGet("Users/{userId}/Items/{itemId}/Intros")]
  180. [ProducesResponseType(StatusCodes.Status200OK)]
  181. [Obsolete("Kept for backwards compatibility")]
  182. [ApiExplorerSettings(IgnoreApi = true)]
  183. public Task<ActionResult<QueryResult<BaseItemDto>>> GetIntrosLegacy(
  184. [FromRoute, Required] Guid userId,
  185. [FromRoute, Required] Guid itemId)
  186. => GetIntros(userId, itemId);
  187. /// <summary>
  188. /// Marks an item as a favorite.
  189. /// </summary>
  190. /// <param name="userId">User id.</param>
  191. /// <param name="itemId">Item id.</param>
  192. /// <response code="200">Item marked as favorite.</response>
  193. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  194. [HttpPost("UserFavoriteItems/{itemId}")]
  195. [ProducesResponseType(StatusCodes.Status200OK)]
  196. public ActionResult<UserItemDataDto> MarkFavoriteItem(
  197. [FromQuery] Guid? userId,
  198. [FromRoute, Required] Guid itemId)
  199. {
  200. userId = RequestHelpers.GetUserId(User, userId);
  201. var user = _userManager.GetUserById(userId.Value);
  202. if (user is null)
  203. {
  204. return NotFound();
  205. }
  206. var item = itemId.IsEmpty()
  207. ? _libraryManager.GetUserRootFolder()
  208. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  209. if (item is null)
  210. {
  211. return NotFound();
  212. }
  213. return MarkFavorite(user, item, true);
  214. }
  215. /// <summary>
  216. /// Marks an item as a favorite.
  217. /// </summary>
  218. /// <param name="userId">User id.</param>
  219. /// <param name="itemId">Item id.</param>
  220. /// <response code="200">Item marked as favorite.</response>
  221. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  222. [HttpPost("Users/{userId}/FavoriteItems/{itemId}")]
  223. [ProducesResponseType(StatusCodes.Status200OK)]
  224. [Obsolete("Kept for backwards compatibility")]
  225. [ApiExplorerSettings(IgnoreApi = true)]
  226. public ActionResult<UserItemDataDto> MarkFavoriteItemLegacy(
  227. [FromRoute, Required] Guid userId,
  228. [FromRoute, Required] Guid itemId)
  229. => MarkFavoriteItem(userId, itemId);
  230. /// <summary>
  231. /// Unmarks item as a favorite.
  232. /// </summary>
  233. /// <param name="userId">User id.</param>
  234. /// <param name="itemId">Item id.</param>
  235. /// <response code="200">Item unmarked as favorite.</response>
  236. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  237. [HttpDelete("UserFavoriteItems/{itemId}")]
  238. [ProducesResponseType(StatusCodes.Status200OK)]
  239. public ActionResult<UserItemDataDto> UnmarkFavoriteItem(
  240. [FromQuery] Guid? userId,
  241. [FromRoute, Required] Guid itemId)
  242. {
  243. userId = RequestHelpers.GetUserId(User, userId);
  244. var user = _userManager.GetUserById(userId.Value);
  245. if (user is null)
  246. {
  247. return NotFound();
  248. }
  249. var item = itemId.IsEmpty()
  250. ? _libraryManager.GetUserRootFolder()
  251. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  252. if (item is null)
  253. {
  254. return NotFound();
  255. }
  256. return MarkFavorite(user, item, false);
  257. }
  258. /// <summary>
  259. /// Unmarks item as a favorite.
  260. /// </summary>
  261. /// <param name="userId">User id.</param>
  262. /// <param name="itemId">Item id.</param>
  263. /// <response code="200">Item unmarked as favorite.</response>
  264. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  265. [HttpDelete("Users/{userId}/FavoriteItems/{itemId}")]
  266. [ProducesResponseType(StatusCodes.Status200OK)]
  267. [Obsolete("Kept for backwards compatibility")]
  268. [ApiExplorerSettings(IgnoreApi = true)]
  269. public ActionResult<UserItemDataDto> UnmarkFavoriteItemLegacy(
  270. [FromRoute, Required] Guid userId,
  271. [FromRoute, Required] Guid itemId)
  272. => UnmarkFavoriteItem(userId, itemId);
  273. /// <summary>
  274. /// Deletes a user's saved personal rating for an item.
  275. /// </summary>
  276. /// <param name="userId">User id.</param>
  277. /// <param name="itemId">Item id.</param>
  278. /// <response code="200">Personal rating removed.</response>
  279. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  280. [HttpDelete("UserItems/{itemId}/Rating")]
  281. [ProducesResponseType(StatusCodes.Status200OK)]
  282. public ActionResult<UserItemDataDto?> DeleteUserItemRating(
  283. [FromQuery] Guid? userId,
  284. [FromRoute, Required] Guid itemId)
  285. {
  286. userId = RequestHelpers.GetUserId(User, userId);
  287. var user = _userManager.GetUserById(userId.Value);
  288. if (user is null)
  289. {
  290. return NotFound();
  291. }
  292. var item = itemId.IsEmpty()
  293. ? _libraryManager.GetUserRootFolder()
  294. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  295. if (item is null)
  296. {
  297. return NotFound();
  298. }
  299. return UpdateUserItemRatingInternal(user, item, null);
  300. }
  301. /// <summary>
  302. /// Deletes a user's saved personal rating for an item.
  303. /// </summary>
  304. /// <param name="userId">User id.</param>
  305. /// <param name="itemId">Item id.</param>
  306. /// <response code="200">Personal rating removed.</response>
  307. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  308. [HttpDelete("Users/{userId}/Items/{itemId}/Rating")]
  309. [ProducesResponseType(StatusCodes.Status200OK)]
  310. [Obsolete("Kept for backwards compatibility")]
  311. [ApiExplorerSettings(IgnoreApi = true)]
  312. public ActionResult<UserItemDataDto?> DeleteUserItemRatingLegacy(
  313. [FromRoute, Required] Guid userId,
  314. [FromRoute, Required] Guid itemId)
  315. => DeleteUserItemRating(userId, itemId);
  316. /// <summary>
  317. /// Updates a user's rating for an item.
  318. /// </summary>
  319. /// <param name="userId">User id.</param>
  320. /// <param name="itemId">Item id.</param>
  321. /// <param name="likes">Whether this <see cref="UpdateUserItemRating" /> is likes.</param>
  322. /// <response code="200">Item rating updated.</response>
  323. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  324. [HttpPost("UserItems/{itemId}/Rating")]
  325. [ProducesResponseType(StatusCodes.Status200OK)]
  326. public ActionResult<UserItemDataDto?> UpdateUserItemRating(
  327. [FromQuery] Guid? userId,
  328. [FromRoute, Required] Guid itemId,
  329. [FromQuery] bool? likes)
  330. {
  331. userId = RequestHelpers.GetUserId(User, userId);
  332. var user = _userManager.GetUserById(userId.Value);
  333. if (user is null)
  334. {
  335. return NotFound();
  336. }
  337. var item = itemId.IsEmpty()
  338. ? _libraryManager.GetUserRootFolder()
  339. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  340. if (item is null)
  341. {
  342. return NotFound();
  343. }
  344. return UpdateUserItemRatingInternal(user, item, likes);
  345. }
  346. /// <summary>
  347. /// Updates a user's rating for an item.
  348. /// </summary>
  349. /// <param name="userId">User id.</param>
  350. /// <param name="itemId">Item id.</param>
  351. /// <param name="likes">Whether this <see cref="UpdateUserItemRating" /> is likes.</param>
  352. /// <response code="200">Item rating updated.</response>
  353. /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>.</returns>
  354. [HttpPost("Users/{userId}/Items/{itemId}/Rating")]
  355. [ProducesResponseType(StatusCodes.Status200OK)]
  356. [Obsolete("Kept for backwards compatibility")]
  357. [ApiExplorerSettings(IgnoreApi = true)]
  358. public ActionResult<UserItemDataDto?> UpdateUserItemRatingLegacy(
  359. [FromRoute, Required] Guid userId,
  360. [FromRoute, Required] Guid itemId,
  361. [FromQuery] bool? likes)
  362. => UpdateUserItemRating(userId, itemId, likes);
  363. /// <summary>
  364. /// Gets local trailers for an item.
  365. /// </summary>
  366. /// <param name="userId">User id.</param>
  367. /// <param name="itemId">Item id.</param>
  368. /// <response code="200">An <see cref="OkResult"/> containing the item's local trailers.</response>
  369. /// <returns>The items local trailers.</returns>
  370. [HttpGet("Items/{itemId}/LocalTrailers")]
  371. [ProducesResponseType(StatusCodes.Status200OK)]
  372. public ActionResult<IEnumerable<BaseItemDto>> GetLocalTrailers(
  373. [FromQuery] Guid? userId,
  374. [FromRoute, Required] Guid itemId)
  375. {
  376. userId = RequestHelpers.GetUserId(User, userId);
  377. var user = _userManager.GetUserById(userId.Value);
  378. if (user is null)
  379. {
  380. return NotFound();
  381. }
  382. var item = itemId.IsEmpty()
  383. ? _libraryManager.GetUserRootFolder()
  384. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  385. if (item is null)
  386. {
  387. return NotFound();
  388. }
  389. var dtoOptions = new DtoOptions().AddClientFields(User);
  390. if (item is IHasTrailers hasTrailers)
  391. {
  392. var trailers = hasTrailers.LocalTrailers;
  393. return Ok(_dtoService.GetBaseItemDtos(trailers, dtoOptions, user, item).AsEnumerable());
  394. }
  395. return Ok(item.GetExtras()
  396. .Where(e => e.ExtraType == ExtraType.Trailer)
  397. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item)));
  398. }
  399. /// <summary>
  400. /// Gets local trailers for an item.
  401. /// </summary>
  402. /// <param name="userId">User id.</param>
  403. /// <param name="itemId">Item id.</param>
  404. /// <response code="200">An <see cref="OkResult"/> containing the item's local trailers.</response>
  405. /// <returns>The items local trailers.</returns>
  406. [HttpGet("Users/{userId}/Items/{itemId}/LocalTrailers")]
  407. [ProducesResponseType(StatusCodes.Status200OK)]
  408. [Obsolete("Kept for backwards compatibility")]
  409. [ApiExplorerSettings(IgnoreApi = true)]
  410. public ActionResult<IEnumerable<BaseItemDto>> GetLocalTrailersLegacy(
  411. [FromRoute, Required] Guid userId,
  412. [FromRoute, Required] Guid itemId)
  413. => GetLocalTrailers(userId, itemId);
  414. /// <summary>
  415. /// Gets special features for an item.
  416. /// </summary>
  417. /// <param name="userId">User id.</param>
  418. /// <param name="itemId">Item id.</param>
  419. /// <response code="200">Special features returned.</response>
  420. /// <returns>An <see cref="OkResult"/> containing the special features.</returns>
  421. [HttpGet("Items/{itemId}/SpecialFeatures")]
  422. [ProducesResponseType(StatusCodes.Status200OK)]
  423. public ActionResult<IEnumerable<BaseItemDto>> GetSpecialFeatures(
  424. [FromQuery] Guid? userId,
  425. [FromRoute, Required] Guid itemId)
  426. {
  427. userId = RequestHelpers.GetUserId(User, userId);
  428. var user = _userManager.GetUserById(userId.Value);
  429. if (user is null)
  430. {
  431. return NotFound();
  432. }
  433. var item = itemId.IsEmpty()
  434. ? _libraryManager.GetUserRootFolder()
  435. : _libraryManager.GetItemById<BaseItem>(itemId, user);
  436. if (item is null)
  437. {
  438. return NotFound();
  439. }
  440. var dtoOptions = new DtoOptions().AddClientFields(User);
  441. return Ok(item
  442. .GetExtras()
  443. .Where(i => i.ExtraType.HasValue && BaseItem.DisplayExtraTypes.Contains(i.ExtraType.Value))
  444. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item)));
  445. }
  446. /// <summary>
  447. /// Gets special features for an item.
  448. /// </summary>
  449. /// <param name="userId">User id.</param>
  450. /// <param name="itemId">Item id.</param>
  451. /// <response code="200">Special features returned.</response>
  452. /// <returns>An <see cref="OkResult"/> containing the special features.</returns>
  453. [HttpGet("Users/{userId}/Items/{itemId}/SpecialFeatures")]
  454. [ProducesResponseType(StatusCodes.Status200OK)]
  455. [Obsolete("Kept for backwards compatibility")]
  456. [ApiExplorerSettings(IgnoreApi = true)]
  457. public ActionResult<IEnumerable<BaseItemDto>> GetSpecialFeaturesLegacy(
  458. [FromRoute, Required] Guid userId,
  459. [FromRoute, Required] Guid itemId)
  460. => GetSpecialFeatures(userId, itemId);
  461. /// <summary>
  462. /// Gets latest media.
  463. /// </summary>
  464. /// <param name="userId">User id.</param>
  465. /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
  466. /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
  467. /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
  468. /// <param name="isPlayed">Filter by items that are played, or not.</param>
  469. /// <param name="enableImages">Optional. include image information in output.</param>
  470. /// <param name="imageTypeLimit">Optional. the max number of images to return, per image type.</param>
  471. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  472. /// <param name="enableUserData">Optional. include user data.</param>
  473. /// <param name="limit">Return item limit.</param>
  474. /// <param name="groupItems">Whether or not to group items into a parent container.</param>
  475. /// <response code="200">Latest media returned.</response>
  476. /// <returns>An <see cref="OkResult"/> containing the latest media.</returns>
  477. [HttpGet("Items/Latest")]
  478. [ProducesResponseType(StatusCodes.Status200OK)]
  479. public ActionResult<IEnumerable<BaseItemDto>> GetLatestMedia(
  480. [FromQuery] Guid? userId,
  481. [FromQuery] Guid? parentId,
  482. [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
  483. [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
  484. [FromQuery] bool? isPlayed,
  485. [FromQuery] bool? enableImages,
  486. [FromQuery] int? imageTypeLimit,
  487. [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
  488. [FromQuery] bool? enableUserData,
  489. [FromQuery] int limit = 20,
  490. [FromQuery] bool groupItems = true)
  491. {
  492. var requestUserId = RequestHelpers.GetUserId(User, userId);
  493. var user = _userManager.GetUserById(requestUserId);
  494. if (user is null)
  495. {
  496. return NotFound();
  497. }
  498. if (!isPlayed.HasValue)
  499. {
  500. if (user.HidePlayedInLatest)
  501. {
  502. isPlayed = false;
  503. }
  504. }
  505. var dtoOptions = new DtoOptions { Fields = fields }
  506. .AddClientFields(User)
  507. .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
  508. var list = _userViewManager.GetLatestItems(
  509. new LatestItemsQuery
  510. {
  511. GroupItems = groupItems,
  512. IncludeItemTypes = includeItemTypes,
  513. IsPlayed = isPlayed,
  514. Limit = limit,
  515. ParentId = parentId ?? Guid.Empty,
  516. User = user,
  517. },
  518. dtoOptions);
  519. var dtos = list.Select(i =>
  520. {
  521. var item = i.Item2[0];
  522. var childCount = 0;
  523. if (i.Item1 is not null && (i.Item2.Count > 1 || i.Item1 is MusicAlbum))
  524. {
  525. item = i.Item1;
  526. childCount = i.Item2.Count;
  527. }
  528. var dto = _dtoService.GetBaseItemDto(item, dtoOptions, user);
  529. dto.ChildCount = childCount;
  530. return dto;
  531. });
  532. return Ok(dtos);
  533. }
  534. /// <summary>
  535. /// Gets latest media.
  536. /// </summary>
  537. /// <param name="userId">User id.</param>
  538. /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
  539. /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
  540. /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
  541. /// <param name="isPlayed">Filter by items that are played, or not.</param>
  542. /// <param name="enableImages">Optional. include image information in output.</param>
  543. /// <param name="imageTypeLimit">Optional. the max number of images to return, per image type.</param>
  544. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  545. /// <param name="enableUserData">Optional. include user data.</param>
  546. /// <param name="limit">Return item limit.</param>
  547. /// <param name="groupItems">Whether or not to group items into a parent container.</param>
  548. /// <response code="200">Latest media returned.</response>
  549. /// <returns>An <see cref="OkResult"/> containing the latest media.</returns>
  550. [HttpGet("Users/{userId}/Items/Latest")]
  551. [ProducesResponseType(StatusCodes.Status200OK)]
  552. [Obsolete("Kept for backwards compatibility")]
  553. [ApiExplorerSettings(IgnoreApi = true)]
  554. public ActionResult<IEnumerable<BaseItemDto>> GetLatestMediaLegacy(
  555. [FromRoute, Required] Guid userId,
  556. [FromQuery] Guid? parentId,
  557. [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
  558. [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
  559. [FromQuery] bool? isPlayed,
  560. [FromQuery] bool? enableImages,
  561. [FromQuery] int? imageTypeLimit,
  562. [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
  563. [FromQuery] bool? enableUserData,
  564. [FromQuery] int limit = 20,
  565. [FromQuery] bool groupItems = true)
  566. => GetLatestMedia(
  567. userId,
  568. parentId,
  569. fields,
  570. includeItemTypes,
  571. isPlayed,
  572. enableImages,
  573. imageTypeLimit,
  574. enableImageTypes,
  575. enableUserData,
  576. limit,
  577. groupItems);
  578. private async Task RefreshItemOnDemandIfNeeded(BaseItem item)
  579. {
  580. if (item is Person)
  581. {
  582. var hasMetadata = !string.IsNullOrWhiteSpace(item.Overview) && item.HasImage(ImageType.Primary);
  583. var performFullRefresh = !hasMetadata && (DateTime.UtcNow - item.DateLastRefreshed).TotalDays >= 3;
  584. if (!hasMetadata)
  585. {
  586. var options = new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  587. {
  588. MetadataRefreshMode = MetadataRefreshMode.FullRefresh,
  589. ImageRefreshMode = MetadataRefreshMode.FullRefresh,
  590. ForceSave = performFullRefresh
  591. };
  592. await item.RefreshMetadata(options, CancellationToken.None).ConfigureAwait(false);
  593. }
  594. }
  595. }
  596. /// <summary>
  597. /// Marks the favorite.
  598. /// </summary>
  599. /// <param name="user">The user.</param>
  600. /// <param name="item">The item.</param>
  601. /// <param name="isFavorite">if set to <c>true</c> [is favorite].</param>
  602. private UserItemDataDto MarkFavorite(User user, BaseItem item, bool isFavorite)
  603. {
  604. // Get the user data for this item
  605. var data = _userDataRepository.GetUserData(user, item);
  606. if (data is not null)
  607. {
  608. // Set favorite status
  609. data.IsFavorite = isFavorite;
  610. _userDataRepository.SaveUserData(user, item, data, UserDataSaveReason.UpdateUserRating, CancellationToken.None);
  611. }
  612. return _userDataRepository.GetUserDataDto(item, user)!;
  613. }
  614. /// <summary>
  615. /// Updates the user item rating.
  616. /// </summary>
  617. /// <param name="user">The user.</param>
  618. /// <param name="item">The item.</param>
  619. /// <param name="likes">if set to <c>true</c> [likes].</param>
  620. private UserItemDataDto? UpdateUserItemRatingInternal(User user, BaseItem item, bool? likes)
  621. {
  622. // Get the user data for this item
  623. var data = _userDataRepository.GetUserData(user, item);
  624. if (data is not null)
  625. {
  626. data.Likes = likes;
  627. _userDataRepository.SaveUserData(user, item, data, UserDataSaveReason.UpdateUserRating, CancellationToken.None);
  628. }
  629. return _userDataRepository.GetUserDataDto(item, user);
  630. }
  631. }