LibraryService.cs 35 KB

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