LibraryService.cs 35 KB

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