LibraryService.cs 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936
  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.Common.IO;
  25. using MediaBrowser.Model.IO;
  26. using MediaBrowser.Controller.Configuration;
  27. using MediaBrowser.Controller.IO;
  28. using MediaBrowser.Model.Globalization;
  29. using MediaBrowser.Model.Services;
  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)
  292. {
  293. AuthorizationContext = AuthorizationContext,
  294. Logger = Logger,
  295. Request = Request,
  296. SessionContext = SessionContext,
  297. ResultFactory = ResultFactory
  298. }.Get(new GetSimilarGames
  299. {
  300. Fields = request.Fields,
  301. Id = request.Id,
  302. Limit = request.Limit,
  303. UserId = request.UserId
  304. });
  305. }
  306. if (item is MusicAlbum)
  307. {
  308. return new AlbumsService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService)
  309. {
  310. AuthorizationContext = AuthorizationContext,
  311. Logger = Logger,
  312. Request = Request,
  313. SessionContext = SessionContext,
  314. ResultFactory = ResultFactory
  315. }.Get(new GetSimilarAlbums
  316. {
  317. Fields = request.Fields,
  318. Id = request.Id,
  319. Limit = request.Limit,
  320. UserId = request.UserId,
  321. ExcludeArtistIds = request.ExcludeArtistIds
  322. });
  323. }
  324. if (item is MusicArtist)
  325. {
  326. return new AlbumsService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService)
  327. {
  328. AuthorizationContext = AuthorizationContext,
  329. Logger = Logger,
  330. Request = Request,
  331. SessionContext = SessionContext,
  332. ResultFactory = ResultFactory
  333. }.Get(new GetSimilarArtists
  334. {
  335. Fields = request.Fields,
  336. Id = request.Id,
  337. Limit = request.Limit,
  338. UserId = request.UserId
  339. });
  340. }
  341. var program = item as IHasProgramAttributes;
  342. if (item is Movie || (program != null && program.IsMovie) || item is Trailer)
  343. {
  344. return new MoviesService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService, _config)
  345. {
  346. AuthorizationContext = AuthorizationContext,
  347. Logger = Logger,
  348. Request = Request,
  349. SessionContext = SessionContext,
  350. ResultFactory = ResultFactory
  351. }.Get(new GetSimilarMovies
  352. {
  353. Fields = request.Fields,
  354. Id = request.Id,
  355. Limit = request.Limit,
  356. UserId = request.UserId
  357. });
  358. }
  359. if (item is Series || (program != null && program.IsSeries))
  360. {
  361. return new TvShowsService(_userManager, _userDataManager, _libraryManager, _itemRepo, _dtoService, _tvManager)
  362. {
  363. AuthorizationContext = AuthorizationContext,
  364. Logger = Logger,
  365. Request = Request,
  366. SessionContext = SessionContext,
  367. ResultFactory = ResultFactory
  368. }.Get(new GetSimilarShows
  369. {
  370. Fields = request.Fields,
  371. Id = request.Id,
  372. Limit = request.Limit,
  373. UserId = request.UserId
  374. });
  375. }
  376. return new ItemsResult();
  377. }
  378. public object Get(GetMediaFolders request)
  379. {
  380. var items = _libraryManager.GetUserRootFolder().Children.Concat(_libraryManager.RootFolder.VirtualChildren).OrderBy(i => i.SortName).ToList();
  381. if (request.IsHidden.HasValue)
  382. {
  383. var val = request.IsHidden.Value;
  384. items = items.Where(i => i.IsHidden == val).ToList();
  385. }
  386. var dtoOptions = GetDtoOptions(request);
  387. var result = new ItemsResult
  388. {
  389. TotalRecordCount = items.Count,
  390. Items = items.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions)).ToArray()
  391. };
  392. return ToOptimizedResult(result);
  393. }
  394. public void Post(PostUpdatedSeries request)
  395. {
  396. var series = _libraryManager.GetItemList(new InternalItemsQuery
  397. {
  398. IncludeItemTypes = new[] { typeof(Series).Name }
  399. }).Where(i => string.Equals(request.TvdbId, i.GetProviderId(MetadataProviders.Tvdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  400. if (series.Length > 0)
  401. {
  402. foreach (var item in series)
  403. {
  404. _libraryMonitor.ReportFileSystemChanged(item.Path);
  405. }
  406. }
  407. else
  408. {
  409. Task.Run(() => _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None));
  410. }
  411. }
  412. public void Post(PostUpdatedMovies request)
  413. {
  414. var movies = _libraryManager.GetItemList(new InternalItemsQuery
  415. {
  416. IncludeItemTypes = new[] { typeof(Movie).Name }
  417. }).ToArray();
  418. if (!string.IsNullOrWhiteSpace(request.ImdbId))
  419. {
  420. movies = movies.Where(i => string.Equals(request.ImdbId, i.GetProviderId(MetadataProviders.Imdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  421. }
  422. else if (!string.IsNullOrWhiteSpace(request.TmdbId))
  423. {
  424. movies = movies.Where(i => string.Equals(request.TmdbId, i.GetProviderId(MetadataProviders.Tmdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  425. }
  426. else
  427. {
  428. movies = new BaseItem[] { };
  429. }
  430. if (movies.Length > 0)
  431. {
  432. foreach (var item in movies)
  433. {
  434. _libraryMonitor.ReportFileSystemChanged(item.Path);
  435. }
  436. }
  437. else
  438. {
  439. Task.Run(() => _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None));
  440. }
  441. }
  442. public Task<object> Get(GetDownload request)
  443. {
  444. var item = _libraryManager.GetItemById(request.Id);
  445. var auth = _authContext.GetAuthorizationInfo(Request);
  446. var user = _userManager.GetUserById(auth.UserId);
  447. if (user != null)
  448. {
  449. if (!item.CanDownload(user))
  450. {
  451. throw new ArgumentException("Item does not support downloading");
  452. }
  453. }
  454. else
  455. {
  456. if (!item.CanDownload())
  457. {
  458. throw new ArgumentException("Item does not support downloading");
  459. }
  460. }
  461. var headers = new Dictionary<string, string>();
  462. // Quotes are valid in linux. They'll possibly cause issues here
  463. var filename = Path.GetFileName(item.Path).Replace("\"", string.Empty);
  464. headers["Content-Disposition"] = string.Format("attachment; filename=\"{0}\"", filename);
  465. if (user != null)
  466. {
  467. LogDownload(item, user, auth);
  468. }
  469. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  470. {
  471. Path = item.Path,
  472. ResponseHeaders = headers
  473. });
  474. }
  475. private async void LogDownload(BaseItem item, User user, AuthorizationInfo auth)
  476. {
  477. try
  478. {
  479. await _activityManager.Create(new ActivityLogEntry
  480. {
  481. Name = string.Format(_localization.GetLocalizedString("UserDownloadingItemWithValues"), user.Name, item.Name),
  482. Type = "UserDownloadingContent",
  483. ShortOverview = string.Format(_localization.GetLocalizedString("AppDeviceValues"), auth.Client, auth.Device),
  484. UserId = auth.UserId
  485. }).ConfigureAwait(false);
  486. }
  487. catch
  488. {
  489. // Logged at lower levels
  490. }
  491. }
  492. public Task<object> Get(GetFile request)
  493. {
  494. var item = _libraryManager.GetItemById(request.Id);
  495. var locationType = item.LocationType;
  496. if (locationType == LocationType.Remote || locationType == LocationType.Virtual)
  497. {
  498. throw new ArgumentException("This command cannot be used for remote or virtual items.");
  499. }
  500. if (_fileSystem.DirectoryExists(item.Path))
  501. {
  502. throw new ArgumentException("This command cannot be used for directories.");
  503. }
  504. return ResultFactory.GetStaticFileResult(Request, item.Path);
  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(GetPhyscialPaths request)
  512. {
  513. var result = _libraryManager.RootFolder.Children
  514. .SelectMany(c => c.PhysicalLocations)
  515. .ToList();
  516. return ToOptimizedSerializedResultUsingCache(result);
  517. }
  518. /// <summary>
  519. /// Gets the specified request.
  520. /// </summary>
  521. /// <param name="request">The request.</param>
  522. /// <returns>System.Object.</returns>
  523. public object Get(GetAncestors request)
  524. {
  525. var result = GetAncestors(request);
  526. return ToOptimizedSerializedResultUsingCache(result);
  527. }
  528. /// <summary>
  529. /// Gets the ancestors.
  530. /// </summary>
  531. /// <param name="request">The request.</param>
  532. /// <returns>Task{BaseItemDto[]}.</returns>
  533. public List<BaseItemDto> GetAncestors(GetAncestors request)
  534. {
  535. var item = _libraryManager.GetItemById(request.Id);
  536. var baseItemDtos = new List<BaseItemDto>();
  537. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  538. var dtoOptions = GetDtoOptions(request);
  539. BaseItem parent = item.GetParent();
  540. while (parent != null)
  541. {
  542. if (user != null)
  543. {
  544. parent = TranslateParentItem(parent, user);
  545. }
  546. baseItemDtos.Add(_dtoService.GetBaseItemDto(parent, dtoOptions, user));
  547. parent = parent.GetParent();
  548. }
  549. return baseItemDtos.ToList();
  550. }
  551. private BaseItem TranslateParentItem(BaseItem item, User user)
  552. {
  553. if (item.GetParent() is AggregateFolder)
  554. {
  555. return user.RootFolder.GetChildren(user, true).FirstOrDefault(i => i.PhysicalLocations.Contains(item.Path));
  556. }
  557. return item;
  558. }
  559. /// <summary>
  560. /// Gets the specified request.
  561. /// </summary>
  562. /// <param name="request">The request.</param>
  563. /// <returns>System.Object.</returns>
  564. public object Get(GetCriticReviews request)
  565. {
  566. var result = GetCriticReviews(request);
  567. return ToOptimizedSerializedResultUsingCache(result);
  568. }
  569. /// <summary>
  570. /// Gets the specified request.
  571. /// </summary>
  572. /// <param name="request">The request.</param>
  573. /// <returns>System.Object.</returns>
  574. public object Get(GetItemCounts request)
  575. {
  576. var user = string.IsNullOrWhiteSpace(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  577. var counts = new ItemCounts
  578. {
  579. AlbumCount = GetCount(typeof(MusicAlbum), user, request),
  580. EpisodeCount = GetCount(typeof(Episode), user, request),
  581. GameCount = GetCount(typeof(Game), user, request),
  582. GameSystemCount = GetCount(typeof(GameSystem), user, request),
  583. MovieCount = GetCount(typeof(Movie), user, request),
  584. SeriesCount = GetCount(typeof(Series), user, request),
  585. SongCount = GetCount(typeof(Audio), user, request),
  586. MusicVideoCount = GetCount(typeof(MusicVideo), user, request),
  587. BoxSetCount = GetCount(typeof(BoxSet), user, request),
  588. BookCount = GetCount(typeof(Book), user, request)
  589. };
  590. return ToOptimizedSerializedResultUsingCache(counts);
  591. }
  592. private int GetCount(Type type, User user, GetItemCounts request)
  593. {
  594. var query = new InternalItemsQuery(user)
  595. {
  596. IncludeItemTypes = new[] { type.Name },
  597. Limit = 0,
  598. Recursive = true,
  599. ExcludeLocationTypes = new[] { LocationType.Virtual },
  600. SourceTypes = new[] { SourceType.Library },
  601. IsFavorite = request.IsFavorite
  602. };
  603. return _libraryManager.GetItemsResult(query).TotalRecordCount;
  604. }
  605. /// <summary>
  606. /// Posts the specified request.
  607. /// </summary>
  608. /// <param name="request">The request.</param>
  609. public void Post(RefreshLibrary request)
  610. {
  611. try
  612. {
  613. _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
  614. }
  615. catch (Exception ex)
  616. {
  617. Logger.ErrorException("Error refreshing library", ex);
  618. }
  619. }
  620. /// <summary>
  621. /// Deletes the specified request.
  622. /// </summary>
  623. /// <param name="request">The request.</param>
  624. public void Delete(DeleteItems request)
  625. {
  626. var ids = string.IsNullOrWhiteSpace(request.Ids)
  627. ? new string[] { }
  628. : request.Ids.Split(',');
  629. var tasks = ids.Select(i =>
  630. {
  631. var item = _libraryManager.GetItemById(i);
  632. var auth = _authContext.GetAuthorizationInfo(Request);
  633. var user = _userManager.GetUserById(auth.UserId);
  634. if (!item.CanDelete(user))
  635. {
  636. if (ids.Length > 1)
  637. {
  638. throw new SecurityException("Unauthorized access");
  639. }
  640. return Task.FromResult(true);
  641. }
  642. return item.Delete(new DeleteOptions
  643. {
  644. DeleteFileLocation = true
  645. });
  646. }).ToArray();
  647. Task.WaitAll(tasks);
  648. }
  649. /// <summary>
  650. /// Deletes the specified request.
  651. /// </summary>
  652. /// <param name="request">The request.</param>
  653. public void Delete(DeleteItem request)
  654. {
  655. Delete(new DeleteItems
  656. {
  657. Ids = request.Id
  658. });
  659. }
  660. /// <summary>
  661. /// Gets the critic reviews async.
  662. /// </summary>
  663. /// <param name="request">The request.</param>
  664. /// <returns>Task{ItemReviewsResult}.</returns>
  665. private QueryResult<ItemReview> GetCriticReviews(GetCriticReviews request)
  666. {
  667. var reviews = _itemRepo.GetCriticReviews(new Guid(request.Id));
  668. var reviewsArray = reviews.ToArray();
  669. var result = new QueryResult<ItemReview>
  670. {
  671. TotalRecordCount = reviewsArray.Length
  672. };
  673. if (request.StartIndex.HasValue)
  674. {
  675. reviewsArray = reviewsArray.Skip(request.StartIndex.Value).ToArray();
  676. }
  677. if (request.Limit.HasValue)
  678. {
  679. reviewsArray = reviewsArray.Take(request.Limit.Value).ToArray();
  680. }
  681. result.Items = reviewsArray;
  682. return result;
  683. }
  684. public object Get(GetThemeMedia request)
  685. {
  686. var themeSongs = GetThemeSongs(new GetThemeSongs
  687. {
  688. InheritFromParent = request.InheritFromParent,
  689. Id = request.Id,
  690. UserId = request.UserId
  691. });
  692. var themeVideos = GetThemeVideos(new GetThemeVideos
  693. {
  694. InheritFromParent = request.InheritFromParent,
  695. Id = request.Id,
  696. UserId = request.UserId
  697. });
  698. return ToOptimizedSerializedResultUsingCache(new AllThemeMediaResult
  699. {
  700. ThemeSongsResult = themeSongs,
  701. ThemeVideosResult = themeVideos,
  702. SoundtrackSongsResult = new ThemeMediaResult()
  703. });
  704. }
  705. /// <summary>
  706. /// Gets the specified request.
  707. /// </summary>
  708. /// <param name="request">The request.</param>
  709. /// <returns>System.Object.</returns>
  710. public object Get(GetThemeSongs request)
  711. {
  712. var result = GetThemeSongs(request);
  713. return ToOptimizedSerializedResultUsingCache(result);
  714. }
  715. private ThemeMediaResult GetThemeSongs(GetThemeSongs request)
  716. {
  717. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  718. var item = string.IsNullOrEmpty(request.Id)
  719. ? (!string.IsNullOrWhiteSpace(request.UserId)
  720. ? user.RootFolder
  721. : (Folder)_libraryManager.RootFolder)
  722. : _libraryManager.GetItemById(request.Id);
  723. while (item.ThemeSongIds.Count == 0 && request.InheritFromParent && item.GetParent() != null)
  724. {
  725. item = item.GetParent();
  726. }
  727. var dtoOptions = GetDtoOptions(request);
  728. var dtos = item.ThemeSongIds.Select(_libraryManager.GetItemById)
  729. .Where(i => i != null)
  730. .OrderBy(i => i.SortName)
  731. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item));
  732. var items = dtos.ToArray();
  733. return new ThemeMediaResult
  734. {
  735. Items = items,
  736. TotalRecordCount = items.Length,
  737. OwnerId = _dtoService.GetDtoId(item)
  738. };
  739. }
  740. /// <summary>
  741. /// Gets the specified request.
  742. /// </summary>
  743. /// <param name="request">The request.</param>
  744. /// <returns>System.Object.</returns>
  745. public object Get(GetThemeVideos request)
  746. {
  747. var result = GetThemeVideos(request);
  748. return ToOptimizedSerializedResultUsingCache(result);
  749. }
  750. public ThemeMediaResult GetThemeVideos(GetThemeVideos request)
  751. {
  752. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  753. var item = string.IsNullOrEmpty(request.Id)
  754. ? (!string.IsNullOrWhiteSpace(request.UserId)
  755. ? user.RootFolder
  756. : (Folder)_libraryManager.RootFolder)
  757. : _libraryManager.GetItemById(request.Id);
  758. while (item.ThemeVideoIds.Count == 0 && request.InheritFromParent && item.GetParent() != null)
  759. {
  760. item = item.GetParent();
  761. }
  762. var dtoOptions = GetDtoOptions(request);
  763. var dtos = item.ThemeVideoIds.Select(_libraryManager.GetItemById)
  764. .Where(i => i != null)
  765. .OrderBy(i => i.SortName)
  766. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item));
  767. var items = dtos.ToArray();
  768. return new ThemeMediaResult
  769. {
  770. Items = items,
  771. TotalRecordCount = items.Length,
  772. OwnerId = _dtoService.GetDtoId(item)
  773. };
  774. }
  775. private readonly CultureInfo _usCulture = new CultureInfo("en-US");
  776. public object Get(GetYearIndex request)
  777. {
  778. var includeTypes = string.IsNullOrWhiteSpace(request.IncludeItemTypes)
  779. ? new string[] { }
  780. : request.IncludeItemTypes.Split(',');
  781. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  782. var query = new InternalItemsQuery(user)
  783. {
  784. IncludeItemTypes = includeTypes,
  785. Recursive = true
  786. };
  787. var items = _libraryManager.GetItemList(query);
  788. var lookup = items
  789. .ToLookup(i => i.ProductionYear ?? -1)
  790. .OrderBy(i => i.Key)
  791. .Select(i => new ItemIndex
  792. {
  793. ItemCount = i.Count(),
  794. Name = i.Key == -1 ? string.Empty : i.Key.ToString(_usCulture)
  795. })
  796. .ToList();
  797. return ToOptimizedSerializedResultUsingCache(lookup);
  798. }
  799. }
  800. }