LibraryService.cs 35 KB

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