LibraryService.cs 35 KB

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