LibraryService.cs 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526
  1. using MediaBrowser.Controller.Dto;
  2. using MediaBrowser.Controller.Entities;
  3. using MediaBrowser.Controller.Entities.Audio;
  4. using MediaBrowser.Controller.Entities.Movies;
  5. using MediaBrowser.Controller.Entities.TV;
  6. using MediaBrowser.Controller.Library;
  7. using MediaBrowser.Controller.Persistence;
  8. using MediaBrowser.Model.Dto;
  9. using MediaBrowser.Model.Entities;
  10. using MediaBrowser.Model.Querying;
  11. using ServiceStack.ServiceHost;
  12. using System;
  13. using System.Collections.Generic;
  14. using System.IO;
  15. using System.Linq;
  16. using System.Threading;
  17. using System.Threading.Tasks;
  18. namespace MediaBrowser.Api
  19. {
  20. /// <summary>
  21. /// Class GetCriticReviews
  22. /// </summary>
  23. [Route("/Items/{Id}/CriticReviews", "GET")]
  24. [Api(Description = "Gets critic reviews for an item")]
  25. public class GetCriticReviews : IReturn<ItemReviewsResult>
  26. {
  27. /// <summary>
  28. /// Gets or sets the id.
  29. /// </summary>
  30. /// <value>The id.</value>
  31. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  32. public string Id { get; set; }
  33. /// <summary>
  34. /// Skips over a given number of items within the results. Use for paging.
  35. /// </summary>
  36. /// <value>The start index.</value>
  37. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  38. public int? StartIndex { get; set; }
  39. /// <summary>
  40. /// The maximum number of items to return
  41. /// </summary>
  42. /// <value>The limit.</value>
  43. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  44. public int? Limit { get; set; }
  45. }
  46. /// <summary>
  47. /// Class GetThemeSongs
  48. /// </summary>
  49. [Route("/Items/{Id}/ThemeSongs", "GET")]
  50. [Api(Description = "Gets theme songs for an item")]
  51. public class GetThemeSongs : IReturn<ThemeSongsResult>
  52. {
  53. /// <summary>
  54. /// Gets or sets the user id.
  55. /// </summary>
  56. /// <value>The user id.</value>
  57. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  58. public Guid? UserId { get; set; }
  59. /// <summary>
  60. /// Gets or sets the id.
  61. /// </summary>
  62. /// <value>The id.</value>
  63. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  64. public string Id { get; set; }
  65. }
  66. /// <summary>
  67. /// Class GetThemeVideos
  68. /// </summary>
  69. [Route("/Items/{Id}/ThemeVideos", "GET")]
  70. [Api(Description = "Gets video backdrops for an item")]
  71. public class GetThemeVideos : IReturn<ThemeVideosResult>
  72. {
  73. /// <summary>
  74. /// Gets or sets the user id.
  75. /// </summary>
  76. /// <value>The user id.</value>
  77. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  78. public Guid? UserId { get; set; }
  79. /// <summary>
  80. /// Gets or sets the id.
  81. /// </summary>
  82. /// <value>The id.</value>
  83. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  84. public string Id { get; set; }
  85. }
  86. [Route("/Library/Refresh", "POST")]
  87. [Api(Description = "Starts a library scan")]
  88. public class RefreshLibrary : IReturnVoid
  89. {
  90. }
  91. [Route("/Items/{Id}/Refresh", "POST")]
  92. [Api(Description = "Refreshes metadata for an item")]
  93. public class RefreshItem : IReturnVoid
  94. {
  95. [ApiMember(Name = "Forced", Description = "Indicates if a normal or forced refresh should occur.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
  96. public bool Forced { get; set; }
  97. [ApiMember(Name = "Recursive", Description = "Indicates if the refresh should occur recursively.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
  98. public bool Recursive { get; set; }
  99. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  100. public string Id { get; set; }
  101. }
  102. [Route("/Items/{Id}", "DELETE")]
  103. [Api(Description = "Deletes an item from the library and file system")]
  104. public class DeleteItem : IReturnVoid
  105. {
  106. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  107. public string Id { get; set; }
  108. }
  109. [Route("/Items/Counts", "GET")]
  110. [Api(Description = "Gets counts of various item types")]
  111. public class GetItemCounts : IReturn<ItemCounts>
  112. {
  113. [ApiMember(Name = "UserId", Description = "Optional. Get counts from a specific user's library.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  114. public Guid? UserId { get; set; }
  115. }
  116. [Route("/Items/{ItemId}", "POST")]
  117. [Api(("Updates an item"))]
  118. public class UpdateItem : BaseItemDto, IReturnVoid
  119. {
  120. public string ItemId { get; set; }
  121. }
  122. /// <summary>
  123. /// Class LibraryService
  124. /// </summary>
  125. public class LibraryService : BaseApiService
  126. {
  127. /// <summary>
  128. /// The _item repo
  129. /// </summary>
  130. private readonly IItemRepository _itemRepo;
  131. private readonly ILibraryManager _libraryManager;
  132. private readonly IUserManager _userManager;
  133. private readonly IUserDataRepository _userDataRepository;
  134. /// <summary>
  135. /// Initializes a new instance of the <see cref="LibraryService" /> class.
  136. /// </summary>
  137. /// <param name="itemRepo">The item repo.</param>
  138. /// <param name="libraryManager">The library manager.</param>
  139. /// <param name="userManager">The user manager.</param>
  140. /// <param name="userDataRepository">The user data repository.</param>
  141. public LibraryService(IItemRepository itemRepo, ILibraryManager libraryManager, IUserManager userManager,
  142. IUserDataRepository userDataRepository)
  143. {
  144. _itemRepo = itemRepo;
  145. _libraryManager = libraryManager;
  146. _userManager = userManager;
  147. _userDataRepository = userDataRepository;
  148. }
  149. /// <summary>
  150. /// Gets the specified request.
  151. /// </summary>
  152. /// <param name="request">The request.</param>
  153. /// <returns>System.Object.</returns>
  154. public object Get(GetCriticReviews request)
  155. {
  156. var result = GetCriticReviewsAsync(request).Result;
  157. return ToOptimizedResult(result);
  158. }
  159. /// <summary>
  160. /// Gets the specified request.
  161. /// </summary>
  162. /// <param name="request">The request.</param>
  163. /// <returns>System.Object.</returns>
  164. public object Get(GetItemCounts request)
  165. {
  166. var items = GetItems(request.UserId).ToList();
  167. var counts = new ItemCounts
  168. {
  169. AlbumCount = items.OfType<MusicAlbum>().Count(),
  170. EpisodeCount = items.OfType<Episode>().Count(),
  171. GameCount = items.OfType<Game>().Count(),
  172. MovieCount = items.OfType<Movie>().Count(),
  173. SeriesCount = items.OfType<Series>().Count(),
  174. SongCount = items.OfType<Audio>().Count(),
  175. TrailerCount = items.OfType<Trailer>().Count(),
  176. MusicVideoCount = items.OfType<MusicVideo>().Count()
  177. };
  178. return ToOptimizedResult(counts);
  179. }
  180. protected IEnumerable<BaseItem> GetItems(Guid? userId)
  181. {
  182. if (userId.HasValue)
  183. {
  184. var user = _userManager.GetUserById(userId.Value);
  185. return _userManager.GetUserById(userId.Value).RootFolder.GetRecursiveChildren(user);
  186. }
  187. return _libraryManager.RootFolder.RecursiveChildren;
  188. }
  189. /// <summary>
  190. /// Posts the specified request.
  191. /// </summary>
  192. /// <param name="request">The request.</param>
  193. public async void Post(RefreshLibrary request)
  194. {
  195. try
  196. {
  197. await
  198. _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None)
  199. .ConfigureAwait(false);
  200. }
  201. catch (Exception ex)
  202. {
  203. Logger.ErrorException("Error refreshing library", ex);
  204. }
  205. }
  206. public void Post(UpdateItem request)
  207. {
  208. var task = UpdateItem(request);
  209. Task.WaitAll(task);
  210. }
  211. private Task UpdateItem(UpdateItem request)
  212. {
  213. var item = DtoBuilder.GetItemByClientId(request.ItemId, _userManager, _libraryManager);
  214. item.Name = request.Name;
  215. item.ForcedSortName = request.SortName;
  216. item.DisplayMediaType = request.DisplayMediaType;
  217. item.CommunityRating = request.CommunityRating;
  218. item.HomePageUrl = request.HomePageUrl;
  219. item.Budget = request.Budget;
  220. item.Revenue = request.Revenue;
  221. item.CriticRating = request.CriticRating;
  222. item.CriticRatingSummary = request.CriticRatingSummary;
  223. item.IndexNumber = request.IndexNumber;
  224. item.ParentIndexNumber = request.ParentIndexNumber;
  225. item.Overview = request.Overview;
  226. item.Genres = request.Genres;
  227. item.Tags = request.Tags;
  228. item.Studios = request.Studios.Select(x=>x.Name).ToList();
  229. item.People = request.People.Select(x=> new PersonInfo{Name = x.Name,Role = x.Role,Type = x.Type}).ToList();
  230. item.EndDate = request.EndDate != default(DateTime) ? request.EndDate : null;
  231. item.PremiereDate = request.PremiereDate != default(DateTime)? request.PremiereDate : null;
  232. item.ProductionYear = request.ProductionYear;
  233. item.AspectRatio = request.AspectRatio;
  234. item.Language = request.Language;
  235. item.OfficialRating = request.OfficialRating;
  236. item.CustomRating = request.CustomRating;
  237. item.DontFetchMeta = !(request.EnableInternetProviders ?? true);
  238. if (request.EnableInternetProviders ?? true)
  239. {
  240. item.LockedFields = request.LockedFields;
  241. }
  242. else
  243. {
  244. item.LockedFields.Clear();
  245. }
  246. foreach (var pair in request.ProviderIds.ToList())
  247. {
  248. if (string.IsNullOrEmpty(pair.Value))
  249. {
  250. request.ProviderIds.Remove(pair.Key);
  251. }
  252. }
  253. item.ProviderIds = request.ProviderIds;
  254. var game = item as Game;
  255. if (game != null)
  256. {
  257. game.PlayersSupported = request.Players;
  258. }
  259. var song = item as Audio;
  260. if (song != null)
  261. {
  262. song.Album = request.Album;
  263. song.AlbumArtist = request.AlbumArtist;
  264. song.Artist = request.Artists[0];
  265. }
  266. var musicAlbum = item as MusicAlbum;
  267. if (musicAlbum != null)
  268. {
  269. musicAlbum.MusicBrainzReleaseGroupId = request.ProviderIds["MusicBrainzReleaseGroupId"];
  270. }
  271. var series = item as Series;
  272. if (series != null)
  273. {
  274. series.Status = request.Status;
  275. series.AirDays = request.AirDays;
  276. series.AirTime = request.AirTime;
  277. }
  278. return _libraryManager.UpdateItem(item, CancellationToken.None);
  279. }
  280. /// <summary>
  281. /// Deletes the specified request.
  282. /// </summary>
  283. /// <param name="request">The request.</param>
  284. public void Delete(DeleteItem request)
  285. {
  286. var task = DeleteItem(request);
  287. Task.WaitAll(task);
  288. }
  289. private async Task DeleteItem(DeleteItem request)
  290. {
  291. var item = DtoBuilder.GetItemByClientId(request.Id, _userManager, _libraryManager);
  292. var parent = item.Parent;
  293. if (item.LocationType == LocationType.FileSystem)
  294. {
  295. if (Directory.Exists(item.Path))
  296. {
  297. Directory.Delete(item.Path, true);
  298. }
  299. else if (File.Exists(item.Path))
  300. {
  301. File.Delete(item.Path);
  302. }
  303. if (parent != null)
  304. {
  305. try
  306. {
  307. await
  308. parent.ValidateChildren(new Progress<double>(), CancellationToken.None)
  309. .ConfigureAwait(false);
  310. }
  311. catch (Exception ex)
  312. {
  313. Logger.ErrorException("Error refreshing item", ex);
  314. }
  315. }
  316. }
  317. else if (parent != null)
  318. {
  319. try
  320. {
  321. await parent.RemoveChild(item, CancellationToken.None).ConfigureAwait(false);
  322. }
  323. catch (Exception ex)
  324. {
  325. Logger.ErrorException("Error removing item", ex);
  326. }
  327. }
  328. else
  329. {
  330. throw new InvalidOperationException("Don't know how to delete " + item.Name);
  331. }
  332. }
  333. /// <summary>
  334. /// Gets the critic reviews async.
  335. /// </summary>
  336. /// <param name="request">The request.</param>
  337. /// <returns>Task{ItemReviewsResult}.</returns>
  338. private async Task<ItemReviewsResult> GetCriticReviewsAsync(GetCriticReviews request)
  339. {
  340. var reviews = await _itemRepo.GetCriticReviews(new Guid(request.Id)).ConfigureAwait(false);
  341. var reviewsArray = reviews.ToArray();
  342. var result = new ItemReviewsResult
  343. {
  344. TotalRecordCount = reviewsArray.Length
  345. };
  346. if (request.StartIndex.HasValue)
  347. {
  348. reviewsArray = reviewsArray.Skip(request.StartIndex.Value).ToArray();
  349. }
  350. if (request.Limit.HasValue)
  351. {
  352. reviewsArray = reviewsArray.Take(request.Limit.Value).ToArray();
  353. }
  354. result.ItemReviews = reviewsArray;
  355. return result;
  356. }
  357. /// <summary>
  358. /// Gets the specified request.
  359. /// </summary>
  360. /// <param name="request">The request.</param>
  361. /// <returns>System.Object.</returns>
  362. public object Get(GetThemeSongs request)
  363. {
  364. var user = request.UserId.HasValue ? _userManager.GetUserById(request.UserId.Value) : null;
  365. var item = string.IsNullOrEmpty(request.Id)
  366. ? (request.UserId.HasValue
  367. ? user.RootFolder
  368. : (Folder)_libraryManager.RootFolder)
  369. : DtoBuilder.GetItemByClientId(request.Id, _userManager, _libraryManager, request.UserId);
  370. // Get everything
  371. var fields = Enum.GetNames(typeof(ItemFields))
  372. .Select(i => (ItemFields)Enum.Parse(typeof(ItemFields), i, true))
  373. .ToList();
  374. var dtoBuilder = new DtoBuilder(Logger, _libraryManager, _userDataRepository, _itemRepo);
  375. var items = _itemRepo.RetrieveItems<Audio>(item.ThemeSongIds)
  376. .OrderBy(i => i.SortName)
  377. .Select(i => dtoBuilder.GetBaseItemDto(i, fields, user))
  378. .Select(t => t.Result)
  379. .ToArray();
  380. var result = new ThemeSongsResult
  381. {
  382. Items = items,
  383. TotalRecordCount = items.Length,
  384. OwnerId = DtoBuilder.GetClientItemId(item)
  385. };
  386. return ToOptimizedResult(result);
  387. }
  388. /// <summary>
  389. /// Gets the specified request.
  390. /// </summary>
  391. /// <param name="request">The request.</param>
  392. /// <returns>System.Object.</returns>
  393. public object Get(GetThemeVideos request)
  394. {
  395. var user = request.UserId.HasValue ? _userManager.GetUserById(request.UserId.Value) : null;
  396. var item = string.IsNullOrEmpty(request.Id)
  397. ? (request.UserId.HasValue
  398. ? user.RootFolder
  399. : (Folder)_libraryManager.RootFolder)
  400. : DtoBuilder.GetItemByClientId(request.Id, _userManager, _libraryManager, request.UserId);
  401. // Get everything
  402. var fields =
  403. Enum.GetNames(typeof(ItemFields))
  404. .Select(i => (ItemFields)Enum.Parse(typeof(ItemFields), i, true))
  405. .ToList();
  406. var dtoBuilder = new DtoBuilder(Logger, _libraryManager, _userDataRepository, _itemRepo);
  407. var items =
  408. _itemRepo.RetrieveItems<Video>(item.ThemeVideoIds)
  409. .OrderBy(i => i.SortName)
  410. .Select(i => dtoBuilder.GetBaseItemDto(i, fields, user))
  411. .Select(t => t.Result)
  412. .ToArray();
  413. var result = new ThemeVideosResult
  414. {
  415. Items = items,
  416. TotalRecordCount = items.Length,
  417. OwnerId = DtoBuilder.GetClientItemId(item)
  418. };
  419. return ToOptimizedResult(result);
  420. }
  421. /// <summary>
  422. /// Posts the specified request.
  423. /// </summary>
  424. /// <param name="request">The request.</param>
  425. public void Post(RefreshItem request)
  426. {
  427. var task = RefreshItem(request);
  428. Task.WaitAll(task);
  429. }
  430. /// <summary>
  431. /// Refreshes the item.
  432. /// </summary>
  433. /// <param name="request">The request.</param>
  434. /// <returns>Task.</returns>
  435. private async Task RefreshItem(RefreshItem request)
  436. {
  437. var item = DtoBuilder.GetItemByClientId(request.Id, _userManager, _libraryManager);
  438. var folder = item as Folder;
  439. try
  440. {
  441. await item.RefreshMetadata(CancellationToken.None, forceRefresh: request.Forced).ConfigureAwait(false);
  442. if (folder != null)
  443. {
  444. await folder.ValidateChildren(new Progress<double>(), CancellationToken.None, request.Recursive,
  445. request.Forced).ConfigureAwait(false);
  446. }
  447. }
  448. catch (Exception ex)
  449. {
  450. Logger.ErrorException("Error refreshing library", ex);
  451. }
  452. }
  453. }
  454. }