LibraryService.cs 35 KB

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