LibraryService.cs 38 KB

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