LibraryService.cs 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939
  1. using MediaBrowser.Api.Movies;
  2. using MediaBrowser.Api.Music;
  3. using MediaBrowser.Controller.Activity;
  4. using MediaBrowser.Controller.Channels;
  5. using MediaBrowser.Controller.Dto;
  6. using MediaBrowser.Controller.Entities;
  7. using MediaBrowser.Controller.Entities.Audio;
  8. using MediaBrowser.Controller.Entities.Movies;
  9. using MediaBrowser.Controller.Entities.TV;
  10. using MediaBrowser.Controller.Library;
  11. using MediaBrowser.Controller.LiveTv;
  12. using MediaBrowser.Controller.Localization;
  13. using MediaBrowser.Controller.Net;
  14. using MediaBrowser.Controller.Persistence;
  15. using MediaBrowser.Controller.TV;
  16. using MediaBrowser.Model.Activity;
  17. using MediaBrowser.Model.Channels;
  18. using MediaBrowser.Model.Dto;
  19. using MediaBrowser.Model.Entities;
  20. using MediaBrowser.Model.Querying;
  21. using ServiceStack;
  22. using System;
  23. using System.Collections;
  24. using System.Collections.Generic;
  25. using System.Globalization;
  26. using System.IO;
  27. using System.Linq;
  28. using System.Threading;
  29. using System.Threading.Tasks;
  30. namespace MediaBrowser.Api.Library
  31. {
  32. [Route("/Items/{Id}/File", "GET", Summary = "Gets the original file of an item")]
  33. [Authenticated]
  34. public class GetFile
  35. {
  36. /// <summary>
  37. /// Gets or sets the id.
  38. /// </summary>
  39. /// <value>The id.</value>
  40. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  41. public string Id { get; set; }
  42. }
  43. /// <summary>
  44. /// Class GetCriticReviews
  45. /// </summary>
  46. [Route("/Items/{Id}/CriticReviews", "GET", Summary = "Gets critic reviews for an item")]
  47. [Authenticated]
  48. public class GetCriticReviews : IReturn<QueryResult<ItemReview>>
  49. {
  50. /// <summary>
  51. /// Gets or sets the id.
  52. /// </summary>
  53. /// <value>The id.</value>
  54. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  55. public string Id { get; set; }
  56. /// <summary>
  57. /// Skips over a given number of items within the results. Use for paging.
  58. /// </summary>
  59. /// <value>The start index.</value>
  60. [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")]
  61. public int? StartIndex { get; set; }
  62. /// <summary>
  63. /// The maximum number of items to return
  64. /// </summary>
  65. /// <value>The limit.</value>
  66. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  67. public int? Limit { get; set; }
  68. }
  69. /// <summary>
  70. /// Class GetThemeSongs
  71. /// </summary>
  72. [Route("/Items/{Id}/ThemeSongs", "GET", Summary = "Gets theme songs for an item")]
  73. [Authenticated]
  74. public class GetThemeSongs : IReturn<ThemeMediaResult>
  75. {
  76. /// <summary>
  77. /// Gets or sets the user id.
  78. /// </summary>
  79. /// <value>The user id.</value>
  80. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  81. public string UserId { get; set; }
  82. /// <summary>
  83. /// Gets or sets the id.
  84. /// </summary>
  85. /// <value>The id.</value>
  86. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  87. public string Id { get; set; }
  88. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  89. public bool InheritFromParent { get; set; }
  90. }
  91. /// <summary>
  92. /// Class GetThemeVideos
  93. /// </summary>
  94. [Route("/Items/{Id}/ThemeVideos", "GET", Summary = "Gets theme videos for an item")]
  95. [Authenticated]
  96. public class GetThemeVideos : IReturn<ThemeMediaResult>
  97. {
  98. /// <summary>
  99. /// Gets or sets the user id.
  100. /// </summary>
  101. /// <value>The user id.</value>
  102. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  103. public string UserId { get; set; }
  104. /// <summary>
  105. /// Gets or sets the id.
  106. /// </summary>
  107. /// <value>The id.</value>
  108. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  109. public string Id { get; set; }
  110. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  111. public bool InheritFromParent { get; set; }
  112. }
  113. /// <summary>
  114. /// Class GetThemeVideos
  115. /// </summary>
  116. [Route("/Items/{Id}/ThemeMedia", "GET", Summary = "Gets theme videos and songs for an item")]
  117. [Authenticated]
  118. public class GetThemeMedia : IReturn<AllThemeMediaResult>
  119. {
  120. /// <summary>
  121. /// Gets or sets the user id.
  122. /// </summary>
  123. /// <value>The user id.</value>
  124. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  125. public string UserId { get; set; }
  126. /// <summary>
  127. /// Gets or sets the id.
  128. /// </summary>
  129. /// <value>The id.</value>
  130. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  131. public string Id { get; set; }
  132. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  133. public bool InheritFromParent { get; set; }
  134. }
  135. [Route("/Library/Refresh", "POST", Summary = "Starts a library scan")]
  136. [Authenticated(Roles = "Admin")]
  137. public class RefreshLibrary : IReturnVoid
  138. {
  139. }
  140. [Route("/Items/{Id}", "DELETE", Summary = "Deletes an item from the library and file system")]
  141. [Authenticated]
  142. public class DeleteItem : IReturnVoid
  143. {
  144. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  145. public string Id { get; set; }
  146. }
  147. [Route("/Items/Counts", "GET")]
  148. [Authenticated]
  149. public class GetItemCounts : IReturn<ItemCounts>
  150. {
  151. [ApiMember(Name = "UserId", Description = "Optional. Get counts from a specific user's library.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  152. public string UserId { get; set; }
  153. [ApiMember(Name = "IsFavorite", Description = "Optional. Get counts of favorite items", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  154. public bool? IsFavorite { get; set; }
  155. }
  156. [Route("/Items/{Id}/Ancestors", "GET", Summary = "Gets all parents of an item")]
  157. [Authenticated]
  158. public class GetAncestors : IReturn<BaseItemDto[]>
  159. {
  160. /// <summary>
  161. /// Gets or sets the user id.
  162. /// </summary>
  163. /// <value>The user id.</value>
  164. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  165. public string UserId { get; set; }
  166. /// <summary>
  167. /// Gets or sets the id.
  168. /// </summary>
  169. /// <value>The id.</value>
  170. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  171. public string Id { get; set; }
  172. }
  173. [Route("/Items/YearIndex", "GET", Summary = "Gets a year index based on an item query.")]
  174. [Authenticated]
  175. public class GetYearIndex : IReturn<List<ItemIndex>>
  176. {
  177. /// <summary>
  178. /// Gets or sets the user id.
  179. /// </summary>
  180. /// <value>The user id.</value>
  181. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  182. public string UserId { get; set; }
  183. [ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  184. public string IncludeItemTypes { get; set; }
  185. }
  186. /// <summary>
  187. /// Class GetPhyscialPaths
  188. /// </summary>
  189. [Route("/Library/PhysicalPaths", "GET", Summary = "Gets a list of physical paths from virtual folders")]
  190. [Authenticated(Roles = "Admin")]
  191. public class GetPhyscialPaths : IReturn<List<string>>
  192. {
  193. }
  194. [Route("/Library/MediaFolders", "GET", Summary = "Gets all user media folders.")]
  195. [Authenticated]
  196. public class GetMediaFolders : IReturn<ItemsResult>
  197. {
  198. [ApiMember(Name = "IsHidden", Description = "Optional. Filter by folders that are marked hidden, or not.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  199. public bool? IsHidden { get; set; }
  200. }
  201. [Route("/Library/Series/Added", "POST", Summary = "Reports that new episodes of a series have been added by an external source")]
  202. [Route("/Library/Series/Updated", "POST", Summary = "Reports that new episodes of a series have been added by an external source")]
  203. [Authenticated]
  204. public class PostUpdatedSeries : IReturnVoid
  205. {
  206. [ApiMember(Name = "TvdbId", Description = "Tvdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "GET")]
  207. public string TvdbId { get; set; }
  208. }
  209. [Route("/Library/Movies/Added", "POST", Summary = "Reports that new movies have been added by an external source")]
  210. [Route("/Library/Movies/Updated", "POST", Summary = "Reports that new movies have been added by an external source")]
  211. [Authenticated]
  212. public class PostUpdatedMovies : IReturnVoid
  213. {
  214. [ApiMember(Name = "TmdbId", Description = "Tmdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "GET")]
  215. public string TmdbId { get; set; }
  216. [ApiMember(Name = "ImdbId", Description = "Imdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "GET")]
  217. public string ImdbId { get; set; }
  218. }
  219. [Route("/Items/{Id}/Download", "GET", Summary = "Downloads item media")]
  220. [Authenticated(Roles = "download")]
  221. public class GetDownload
  222. {
  223. /// <summary>
  224. /// Gets or sets the id.
  225. /// </summary>
  226. /// <value>The id.</value>
  227. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  228. public string Id { get; set; }
  229. }
  230. [Route("/Items/{Id}/Similar", "GET", Summary = "Gets similar items")]
  231. [Authenticated]
  232. public class GetSimilarItems : BaseGetSimilarItemsFromItem
  233. {
  234. }
  235. /// <summary>
  236. /// Class LibraryService
  237. /// </summary>
  238. public class LibraryService : BaseApiService
  239. {
  240. /// <summary>
  241. /// The _item repo
  242. /// </summary>
  243. private readonly IItemRepository _itemRepo;
  244. private readonly ILibraryManager _libraryManager;
  245. private readonly IUserManager _userManager;
  246. private readonly IUserDataManager _userDataManager;
  247. private readonly IDtoService _dtoService;
  248. private readonly IAuthorizationContext _authContext;
  249. private readonly IActivityManager _activityManager;
  250. private readonly ILocalizationManager _localization;
  251. private readonly ILiveTvManager _liveTv;
  252. private readonly IChannelManager _channelManager;
  253. private readonly ITVSeriesManager _tvManager;
  254. private readonly ILibraryMonitor _libraryMonitor;
  255. /// <summary>
  256. /// Initializes a new instance of the <see cref="LibraryService" /> class.
  257. /// </summary>
  258. public LibraryService(IItemRepository itemRepo, ILibraryManager libraryManager, IUserManager userManager,
  259. IDtoService dtoService, IUserDataManager userDataManager, IAuthorizationContext authContext, IActivityManager activityManager, ILocalizationManager localization, ILiveTvManager liveTv, IChannelManager channelManager, ITVSeriesManager tvManager)
  260. {
  261. _itemRepo = itemRepo;
  262. _libraryManager = libraryManager;
  263. _userManager = userManager;
  264. _dtoService = dtoService;
  265. _userDataManager = userDataManager;
  266. _authContext = authContext;
  267. _activityManager = activityManager;
  268. _localization = localization;
  269. _liveTv = liveTv;
  270. _channelManager = channelManager;
  271. _tvManager = tvManager;
  272. }
  273. public object Get(GetSimilarItems request)
  274. {
  275. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  276. var item = string.IsNullOrEmpty(request.Id) ?
  277. (!string.IsNullOrWhiteSpace(request.UserId) ? user.RootFolder :
  278. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  279. if (item is Game)
  280. {
  281. return new GamesService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService)
  282. {
  283. AuthorizationContext = AuthorizationContext,
  284. Logger = Logger,
  285. Request = Request,
  286. SessionContext = SessionContext,
  287. ResultFactory = ResultFactory
  288. }.Get(new GetSimilarGames
  289. {
  290. Fields = request.Fields,
  291. Id = request.Id,
  292. Limit = request.Limit,
  293. UserId = request.UserId
  294. });
  295. }
  296. if (item is MusicAlbum)
  297. {
  298. return new AlbumsService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService)
  299. {
  300. AuthorizationContext = AuthorizationContext,
  301. Logger = Logger,
  302. Request = Request,
  303. SessionContext = SessionContext,
  304. ResultFactory = ResultFactory
  305. }.Get(new GetSimilarAlbums
  306. {
  307. Fields = request.Fields,
  308. Id = request.Id,
  309. Limit = request.Limit,
  310. UserId = request.UserId
  311. });
  312. }
  313. if (item is MusicArtist)
  314. {
  315. return new AlbumsService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService)
  316. {
  317. AuthorizationContext = AuthorizationContext,
  318. Logger = Logger,
  319. Request = Request,
  320. SessionContext = SessionContext,
  321. ResultFactory = ResultFactory
  322. }.Get(new GetSimilarArtists
  323. {
  324. Fields = request.Fields,
  325. Id = request.Id,
  326. Limit = request.Limit,
  327. UserId = request.UserId
  328. });
  329. }
  330. var program = item as IHasProgramAttributes;
  331. var channelItem = item as ChannelVideoItem;
  332. if (item is Movie || (program != null && program.IsMovie) || (channelItem != null && channelItem.ContentType == ChannelMediaContentType.Movie) || (channelItem != null && channelItem.ContentType == ChannelMediaContentType.MovieExtra))
  333. {
  334. return new MoviesService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService, _channelManager)
  335. {
  336. AuthorizationContext = AuthorizationContext,
  337. Logger = Logger,
  338. Request = Request,
  339. SessionContext = SessionContext,
  340. ResultFactory = ResultFactory
  341. }.Get(new GetSimilarMovies
  342. {
  343. Fields = request.Fields,
  344. Id = request.Id,
  345. Limit = request.Limit,
  346. UserId = request.UserId
  347. });
  348. }
  349. if (item is Series || (program != null && program.IsSeries) || (channelItem != null && channelItem.ContentType == ChannelMediaContentType.Episode))
  350. {
  351. return new TvShowsService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService, _tvManager)
  352. {
  353. AuthorizationContext = AuthorizationContext,
  354. Logger = Logger,
  355. Request = Request,
  356. SessionContext = SessionContext,
  357. ResultFactory = ResultFactory
  358. }.Get(new GetSimilarShows
  359. {
  360. Fields = request.Fields,
  361. Id = request.Id,
  362. Limit = request.Limit,
  363. UserId = request.UserId
  364. });
  365. }
  366. return new ItemsResult();
  367. }
  368. public object Get(GetMediaFolders request)
  369. {
  370. var items = _libraryManager.GetUserRootFolder().Children.OrderBy(i => i.SortName).ToList();
  371. if (request.IsHidden.HasValue)
  372. {
  373. var val = request.IsHidden.Value;
  374. items = items.Where(i => i.IsHidden == val).ToList();
  375. }
  376. var dtoOptions = GetDtoOptions(request);
  377. var result = new ItemsResult
  378. {
  379. TotalRecordCount = items.Count,
  380. Items = items.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions)).ToArray()
  381. };
  382. return ToOptimizedResult(result);
  383. }
  384. public void Post(PostUpdatedSeries request)
  385. {
  386. var series = _libraryManager.GetItems(new InternalItemsQuery
  387. {
  388. IncludeItemTypes = new[] { typeof(Series).Name }
  389. }).Items;
  390. series = series.Where(i => string.Equals(request.TvdbId, i.GetProviderId(MetadataProviders.Tvdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  391. if (series.Length > 0)
  392. {
  393. foreach (var item in series)
  394. {
  395. _libraryMonitor.ReportFileSystemChanged(item.Path);
  396. }
  397. }
  398. else
  399. {
  400. Task.Run(() => _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None));
  401. }
  402. }
  403. public void Post(PostUpdatedMovies request)
  404. {
  405. var movies = _libraryManager.GetItems(new InternalItemsQuery
  406. {
  407. IncludeItemTypes = new[] { typeof(Movie).Name }
  408. }).Items;
  409. if (!string.IsNullOrWhiteSpace(request.ImdbId))
  410. {
  411. movies = movies.Where(i => string.Equals(request.ImdbId, i.GetProviderId(MetadataProviders.Imdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  412. }
  413. else if (!string.IsNullOrWhiteSpace(request.TmdbId))
  414. {
  415. movies = movies.Where(i => string.Equals(request.TmdbId, i.GetProviderId(MetadataProviders.Tmdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  416. }
  417. else
  418. {
  419. movies = new BaseItem[] { };
  420. }
  421. if (movies.Length > 0)
  422. {
  423. foreach (var item in movies)
  424. {
  425. _libraryMonitor.ReportFileSystemChanged(item.Path);
  426. }
  427. }
  428. else
  429. {
  430. Task.Run(() => _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None));
  431. }
  432. }
  433. public object Get(GetDownload request)
  434. {
  435. var item = _libraryManager.GetItemById(request.Id);
  436. var auth = _authContext.GetAuthorizationInfo(Request);
  437. var user = _userManager.GetUserById(auth.UserId);
  438. if (user != null)
  439. {
  440. if (!item.CanDownload(user))
  441. {
  442. throw new ArgumentException("Item does not support downloading");
  443. }
  444. }
  445. else
  446. {
  447. if (!item.CanDownload())
  448. {
  449. throw new ArgumentException("Item does not support downloading");
  450. }
  451. }
  452. var headers = new Dictionary<string, string>();
  453. // Quotes are valid in linux. They'll possibly cause issues here
  454. var filename = Path.GetFileName(item.Path).Replace("\"", string.Empty);
  455. headers["Content-Disposition"] = string.Format("attachment; filename=\"{0}\"", filename);
  456. if (user != null)
  457. {
  458. LogDownload(item, user, auth);
  459. }
  460. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  461. {
  462. Path = item.Path,
  463. ResponseHeaders = headers
  464. });
  465. }
  466. private async void LogDownload(BaseItem item, User user, AuthorizationInfo auth)
  467. {
  468. try
  469. {
  470. await _activityManager.Create(new ActivityLogEntry
  471. {
  472. Name = string.Format(_localization.GetLocalizedString("UserDownloadingItemWithValues"), user.Name, item.Name),
  473. Type = "UserDownloadingContent",
  474. ShortOverview = string.Format(_localization.GetLocalizedString("AppDeviceValues"), auth.Client, auth.Device),
  475. UserId = auth.UserId
  476. }).ConfigureAwait(false);
  477. }
  478. catch
  479. {
  480. // Logged at lower levels
  481. }
  482. }
  483. public object Get(GetFile request)
  484. {
  485. var item = _libraryManager.GetItemById(request.Id);
  486. var locationType = item.LocationType;
  487. if (locationType == LocationType.Remote || locationType == LocationType.Virtual)
  488. {
  489. throw new ArgumentException("This command cannot be used for remote or virtual items.");
  490. }
  491. if (Directory.Exists(item.Path))
  492. {
  493. throw new ArgumentException("This command cannot be used for directories.");
  494. }
  495. return ToStaticFileResult(item.Path);
  496. }
  497. /// <summary>
  498. /// Gets the specified request.
  499. /// </summary>
  500. /// <param name="request">The request.</param>
  501. /// <returns>System.Object.</returns>
  502. public object Get(GetPhyscialPaths request)
  503. {
  504. var result = _libraryManager.RootFolder.Children
  505. .SelectMany(c => c.PhysicalLocations)
  506. .ToList();
  507. return ToOptimizedSerializedResultUsingCache(result);
  508. }
  509. /// <summary>
  510. /// Gets the specified request.
  511. /// </summary>
  512. /// <param name="request">The request.</param>
  513. /// <returns>System.Object.</returns>
  514. public object Get(GetAncestors request)
  515. {
  516. var result = GetAncestors(request);
  517. return ToOptimizedSerializedResultUsingCache(result);
  518. }
  519. /// <summary>
  520. /// Gets the ancestors.
  521. /// </summary>
  522. /// <param name="request">The request.</param>
  523. /// <returns>Task{BaseItemDto[]}.</returns>
  524. public List<BaseItemDto> GetAncestors(GetAncestors request)
  525. {
  526. var item = _libraryManager.GetItemById(request.Id);
  527. var baseItemDtos = new List<BaseItemDto>();
  528. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  529. var dtoOptions = GetDtoOptions(request);
  530. BaseItem parent = item.Parent;
  531. while (parent != null)
  532. {
  533. if (user != null)
  534. {
  535. parent = TranslateParentItem(parent, user);
  536. }
  537. baseItemDtos.Add(_dtoService.GetBaseItemDto(parent, dtoOptions, user));
  538. parent = parent.Parent;
  539. }
  540. return baseItemDtos.ToList();
  541. }
  542. private BaseItem TranslateParentItem(BaseItem item, User user)
  543. {
  544. if (item.Parent is AggregateFolder)
  545. {
  546. return user.RootFolder.GetChildren(user, true).FirstOrDefault(i => i.PhysicalLocations.Contains(item.Path));
  547. }
  548. return item;
  549. }
  550. /// <summary>
  551. /// Gets the specified request.
  552. /// </summary>
  553. /// <param name="request">The request.</param>
  554. /// <returns>System.Object.</returns>
  555. public object Get(GetCriticReviews request)
  556. {
  557. var result = GetCriticReviews(request);
  558. return ToOptimizedSerializedResultUsingCache(result);
  559. }
  560. /// <summary>
  561. /// Gets the specified request.
  562. /// </summary>
  563. /// <param name="request">The request.</param>
  564. /// <returns>System.Object.</returns>
  565. public object Get(GetItemCounts request)
  566. {
  567. var filteredItems = GetAllLibraryItems(request.UserId, _userManager, _libraryManager, null, i => i.LocationType != LocationType.Virtual && FilterItem(i, request, request.UserId));
  568. var counts = new ItemCounts
  569. {
  570. AlbumCount = filteredItems.Count(i => i is MusicAlbum),
  571. EpisodeCount = filteredItems.Count(i => i is Episode),
  572. GameCount = filteredItems.Count(i => i is Game),
  573. GameSystemCount = filteredItems.Count(i => i is GameSystem),
  574. MovieCount = filteredItems.Count(i => i is Movie),
  575. SeriesCount = filteredItems.Count(i => i is Series),
  576. SongCount = filteredItems.Count(i => i is Audio),
  577. MusicVideoCount = filteredItems.Count(i => i is MusicVideo),
  578. BoxSetCount = filteredItems.Count(i => i is BoxSet),
  579. BookCount = filteredItems.Count(i => i is Book),
  580. UniqueTypes = filteredItems.Select(i => i.GetClientTypeName()).Distinct().ToList()
  581. };
  582. return ToOptimizedSerializedResultUsingCache(counts);
  583. }
  584. private bool FilterItem(BaseItem item, GetItemCounts request, string userId)
  585. {
  586. if (!string.IsNullOrWhiteSpace(userId))
  587. {
  588. if (request.IsFavorite.HasValue)
  589. {
  590. var val = request.IsFavorite.Value;
  591. if (_userDataManager.GetUserData(userId, item.GetUserDataKey()).IsFavorite != val)
  592. {
  593. return false;
  594. }
  595. }
  596. }
  597. return true;
  598. }
  599. /// <summary>
  600. /// Posts the specified request.
  601. /// </summary>
  602. /// <param name="request">The request.</param>
  603. public void Post(RefreshLibrary request)
  604. {
  605. try
  606. {
  607. _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
  608. }
  609. catch (Exception ex)
  610. {
  611. Logger.ErrorException("Error refreshing library", ex);
  612. }
  613. }
  614. /// <summary>
  615. /// Deletes the specified request.
  616. /// </summary>
  617. /// <param name="request">The request.</param>
  618. public void Delete(DeleteItem request)
  619. {
  620. var item = _libraryManager.GetItemById(request.Id);
  621. var auth = _authContext.GetAuthorizationInfo(Request);
  622. var user = _userManager.GetUserById(auth.UserId);
  623. if (!item.CanDelete(user))
  624. {
  625. throw new UnauthorizedAccessException();
  626. }
  627. if (item is ILiveTvRecording)
  628. {
  629. var task = _liveTv.DeleteRecording(request.Id);
  630. Task.WaitAll(task);
  631. }
  632. else
  633. {
  634. var task = _libraryManager.DeleteItem(item);
  635. Task.WaitAll(task);
  636. }
  637. }
  638. /// <summary>
  639. /// Gets the critic reviews async.
  640. /// </summary>
  641. /// <param name="request">The request.</param>
  642. /// <returns>Task{ItemReviewsResult}.</returns>
  643. private QueryResult<ItemReview> GetCriticReviews(GetCriticReviews request)
  644. {
  645. var reviews = _itemRepo.GetCriticReviews(new Guid(request.Id));
  646. var reviewsArray = reviews.ToArray();
  647. var result = new QueryResult<ItemReview>
  648. {
  649. TotalRecordCount = reviewsArray.Length
  650. };
  651. if (request.StartIndex.HasValue)
  652. {
  653. reviewsArray = reviewsArray.Skip(request.StartIndex.Value).ToArray();
  654. }
  655. if (request.Limit.HasValue)
  656. {
  657. reviewsArray = reviewsArray.Take(request.Limit.Value).ToArray();
  658. }
  659. result.Items = reviewsArray;
  660. return result;
  661. }
  662. public object Get(GetThemeMedia request)
  663. {
  664. var themeSongs = GetThemeSongs(new GetThemeSongs
  665. {
  666. InheritFromParent = request.InheritFromParent,
  667. Id = request.Id,
  668. UserId = request.UserId
  669. });
  670. var themeVideos = GetThemeVideos(new GetThemeVideos
  671. {
  672. InheritFromParent = request.InheritFromParent,
  673. Id = request.Id,
  674. UserId = request.UserId
  675. });
  676. return ToOptimizedSerializedResultUsingCache(new AllThemeMediaResult
  677. {
  678. ThemeSongsResult = themeSongs,
  679. ThemeVideosResult = themeVideos,
  680. SoundtrackSongsResult = new ThemeMediaResult()
  681. });
  682. }
  683. /// <summary>
  684. /// Gets the specified request.
  685. /// </summary>
  686. /// <param name="request">The request.</param>
  687. /// <returns>System.Object.</returns>
  688. public object Get(GetThemeSongs request)
  689. {
  690. var result = GetThemeSongs(request);
  691. return ToOptimizedSerializedResultUsingCache(result);
  692. }
  693. private ThemeMediaResult GetThemeSongs(GetThemeSongs request)
  694. {
  695. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  696. var item = string.IsNullOrEmpty(request.Id)
  697. ? (!string.IsNullOrWhiteSpace(request.UserId)
  698. ? user.RootFolder
  699. : (Folder)_libraryManager.RootFolder)
  700. : _libraryManager.GetItemById(request.Id);
  701. while (GetThemeSongIds(item).Count == 0 && request.InheritFromParent && item.Parent != null)
  702. {
  703. item = item.Parent;
  704. }
  705. var dtoOptions = GetDtoOptions(request);
  706. var dtos = GetThemeSongIds(item).Select(_libraryManager.GetItemById)
  707. .OrderBy(i => i.SortName)
  708. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item));
  709. var items = dtos.ToArray();
  710. return new ThemeMediaResult
  711. {
  712. Items = items,
  713. TotalRecordCount = items.Length,
  714. OwnerId = _dtoService.GetDtoId(item)
  715. };
  716. }
  717. /// <summary>
  718. /// Gets the specified request.
  719. /// </summary>
  720. /// <param name="request">The request.</param>
  721. /// <returns>System.Object.</returns>
  722. public object Get(GetThemeVideos request)
  723. {
  724. var result = GetThemeVideos(request);
  725. return ToOptimizedSerializedResultUsingCache(result);
  726. }
  727. public ThemeMediaResult GetThemeVideos(GetThemeVideos request)
  728. {
  729. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  730. var item = string.IsNullOrEmpty(request.Id)
  731. ? (!string.IsNullOrWhiteSpace(request.UserId)
  732. ? user.RootFolder
  733. : (Folder)_libraryManager.RootFolder)
  734. : _libraryManager.GetItemById(request.Id);
  735. while (GetThemeVideoIds(item).Count == 0 && request.InheritFromParent && item.Parent != null)
  736. {
  737. item = item.Parent;
  738. }
  739. var dtoOptions = GetDtoOptions(request);
  740. var dtos = GetThemeVideoIds(item).Select(_libraryManager.GetItemById)
  741. .OrderBy(i => i.SortName)
  742. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item));
  743. var items = dtos.ToArray();
  744. return new ThemeMediaResult
  745. {
  746. Items = items,
  747. TotalRecordCount = items.Length,
  748. OwnerId = _dtoService.GetDtoId(item)
  749. };
  750. }
  751. private List<Guid> GetThemeVideoIds(BaseItem item)
  752. {
  753. var i = item as IHasThemeMedia;
  754. if (i != null)
  755. {
  756. return i.ThemeVideoIds;
  757. }
  758. return new List<Guid>();
  759. }
  760. private List<Guid> GetThemeSongIds(BaseItem item)
  761. {
  762. var i = item as IHasThemeMedia;
  763. if (i != null)
  764. {
  765. return i.ThemeSongIds;
  766. }
  767. return new List<Guid>();
  768. }
  769. private readonly CultureInfo _usCulture = new CultureInfo("en-US");
  770. public object Get(GetYearIndex request)
  771. {
  772. var includeTypes = string.IsNullOrWhiteSpace(request.IncludeItemTypes)
  773. ? new string[] { }
  774. : request.IncludeItemTypes.Split(',');
  775. Func<BaseItem, bool> filter = i =>
  776. {
  777. if (includeTypes.Length > 0)
  778. {
  779. if (!includeTypes.Contains(i.GetType().Name, StringComparer.OrdinalIgnoreCase))
  780. {
  781. return false;
  782. }
  783. }
  784. return true;
  785. };
  786. IEnumerable<BaseItem> items = GetAllLibraryItems(request.UserId, _userManager, _libraryManager, null, filter);
  787. var lookup = items
  788. .ToLookup(i => i.ProductionYear ?? -1)
  789. .OrderBy(i => i.Key)
  790. .Select(i => new ItemIndex
  791. {
  792. ItemCount = i.Count(),
  793. Name = i.Key == -1 ? string.Empty : i.Key.ToString(_usCulture)
  794. })
  795. .ToList();
  796. return ToOptimizedSerializedResultUsingCache(lookup);
  797. }
  798. }
  799. }