LibraryService.cs 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211
  1. using System;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using System.Linq;
  5. using System.Threading;
  6. using System.Threading.Tasks;
  7. using MediaBrowser.Api.Movies;
  8. using MediaBrowser.Common.Extensions;
  9. using MediaBrowser.Common.Progress;
  10. using MediaBrowser.Controller.Configuration;
  11. using MediaBrowser.Controller.Dto;
  12. using MediaBrowser.Controller.Entities;
  13. using MediaBrowser.Controller.Entities.Audio;
  14. using MediaBrowser.Controller.Entities.Movies;
  15. using MediaBrowser.Controller.Entities.TV;
  16. using MediaBrowser.Controller.Library;
  17. using MediaBrowser.Controller.LiveTv;
  18. using MediaBrowser.Controller.Net;
  19. using MediaBrowser.Controller.Persistence;
  20. using MediaBrowser.Controller.Providers;
  21. using MediaBrowser.Controller.TV;
  22. using MediaBrowser.Model.Activity;
  23. using MediaBrowser.Model.Configuration;
  24. using MediaBrowser.Model.Dto;
  25. using MediaBrowser.Model.Entities;
  26. using MediaBrowser.Model.Extensions;
  27. using MediaBrowser.Model.Globalization;
  28. using MediaBrowser.Model.IO;
  29. using MediaBrowser.Model.Querying;
  30. using MediaBrowser.Model.Services;
  31. using Microsoft.Extensions.Logging;
  32. using Microsoft.Net.Http.Headers;
  33. namespace MediaBrowser.Api.Library
  34. {
  35. [Route("/Items/{Id}/File", "GET", Summary = "Gets the original file of an item")]
  36. [Authenticated]
  37. public class GetFile
  38. {
  39. /// <summary>
  40. /// Gets or sets the id.
  41. /// </summary>
  42. /// <value>The id.</value>
  43. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  44. public string Id { get; set; }
  45. }
  46. /// <summary>
  47. /// Class GetCriticReviews
  48. /// </summary>
  49. [Route("/Items/{Id}/CriticReviews", "GET", Summary = "Gets critic reviews for an item")]
  50. [Authenticated]
  51. public class GetCriticReviews : IReturn<QueryResult<BaseItemDto>>
  52. {
  53. /// <summary>
  54. /// Gets or sets the id.
  55. /// </summary>
  56. /// <value>The id.</value>
  57. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  58. public string Id { get; set; }
  59. /// <summary>
  60. /// Skips over a given number of items within the results. Use for paging.
  61. /// </summary>
  62. /// <value>The start index.</value>
  63. [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")]
  64. public int? StartIndex { get; set; }
  65. /// <summary>
  66. /// The maximum number of items to return
  67. /// </summary>
  68. /// <value>The limit.</value>
  69. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  70. public int? Limit { get; set; }
  71. }
  72. /// <summary>
  73. /// Class GetThemeSongs
  74. /// </summary>
  75. [Route("/Items/{Id}/ThemeSongs", "GET", Summary = "Gets theme songs for an item")]
  76. [Authenticated]
  77. public class GetThemeSongs : IReturn<ThemeMediaResult>
  78. {
  79. /// <summary>
  80. /// Gets or sets the user id.
  81. /// </summary>
  82. /// <value>The user id.</value>
  83. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  84. public Guid UserId { get; set; }
  85. /// <summary>
  86. /// Gets or sets the id.
  87. /// </summary>
  88. /// <value>The id.</value>
  89. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  90. public string Id { get; set; }
  91. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  92. public bool InheritFromParent { get; set; }
  93. }
  94. /// <summary>
  95. /// Class GetThemeVideos
  96. /// </summary>
  97. [Route("/Items/{Id}/ThemeVideos", "GET", Summary = "Gets theme videos for an item")]
  98. [Authenticated]
  99. public class GetThemeVideos : IReturn<ThemeMediaResult>
  100. {
  101. /// <summary>
  102. /// Gets or sets the user id.
  103. /// </summary>
  104. /// <value>The user id.</value>
  105. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  106. public Guid UserId { get; set; }
  107. /// <summary>
  108. /// Gets or sets the id.
  109. /// </summary>
  110. /// <value>The id.</value>
  111. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  112. public string Id { get; set; }
  113. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  114. public bool InheritFromParent { get; set; }
  115. }
  116. /// <summary>
  117. /// Class GetThemeVideos
  118. /// </summary>
  119. [Route("/Items/{Id}/ThemeMedia", "GET", Summary = "Gets theme videos and songs for an item")]
  120. [Authenticated]
  121. public class GetThemeMedia : IReturn<AllThemeMediaResult>
  122. {
  123. /// <summary>
  124. /// Gets or sets the user id.
  125. /// </summary>
  126. /// <value>The user id.</value>
  127. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  128. public Guid UserId { get; set; }
  129. /// <summary>
  130. /// Gets or sets the id.
  131. /// </summary>
  132. /// <value>The id.</value>
  133. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  134. public string Id { get; set; }
  135. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  136. public bool InheritFromParent { get; set; }
  137. }
  138. [Route("/Library/Refresh", "POST", Summary = "Starts a library scan")]
  139. [Authenticated(Roles = "Admin")]
  140. public class RefreshLibrary : IReturnVoid
  141. {
  142. }
  143. [Route("/Items/{Id}", "DELETE", Summary = "Deletes an item from the library and file system")]
  144. [Authenticated]
  145. public class DeleteItem : IReturnVoid
  146. {
  147. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  148. public string Id { get; set; }
  149. }
  150. [Route("/Items", "DELETE", Summary = "Deletes an item from the library and file system")]
  151. [Authenticated]
  152. public class DeleteItems : IReturnVoid
  153. {
  154. [ApiMember(Name = "Ids", Description = "Ids", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  155. public string Ids { get; set; }
  156. }
  157. [Route("/Items/Counts", "GET")]
  158. [Authenticated]
  159. public class GetItemCounts : IReturn<ItemCounts>
  160. {
  161. [ApiMember(Name = "UserId", Description = "Optional. Get counts from a specific user's library.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  162. public Guid UserId { get; set; }
  163. [ApiMember(Name = "IsFavorite", Description = "Optional. Get counts of favorite items", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  164. public bool? IsFavorite { get; set; }
  165. }
  166. [Route("/Items/{Id}/Ancestors", "GET", Summary = "Gets all parents of an item")]
  167. [Authenticated]
  168. public class GetAncestors : IReturn<BaseItemDto[]>
  169. {
  170. /// <summary>
  171. /// Gets or sets the user id.
  172. /// </summary>
  173. /// <value>The user id.</value>
  174. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  175. public Guid UserId { get; set; }
  176. /// <summary>
  177. /// Gets or sets the id.
  178. /// </summary>
  179. /// <value>The id.</value>
  180. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  181. public string Id { get; set; }
  182. }
  183. /// <summary>
  184. /// Class GetPhyscialPaths
  185. /// </summary>
  186. [Route("/Library/PhysicalPaths", "GET", Summary = "Gets a list of physical paths from virtual folders")]
  187. [Authenticated(Roles = "Admin")]
  188. public class GetPhyscialPaths : IReturn<List<string>>
  189. {
  190. }
  191. [Route("/Library/MediaFolders", "GET", Summary = "Gets all user media folders.")]
  192. [Authenticated]
  193. public class GetMediaFolders : IReturn<QueryResult<BaseItemDto>>
  194. {
  195. [ApiMember(Name = "IsHidden", Description = "Optional. Filter by folders that are marked hidden, or not.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  196. public bool? IsHidden { get; set; }
  197. }
  198. [Route("/Library/Series/Added", "POST", Summary = "Reports that new episodes of a series have been added by an external source")]
  199. [Route("/Library/Series/Updated", "POST", Summary = "Reports that new episodes of a series have been added by an external source")]
  200. [Authenticated]
  201. public class PostUpdatedSeries : IReturnVoid
  202. {
  203. [ApiMember(Name = "TvdbId", Description = "Tvdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "POST")]
  204. public string TvdbId { get; set; }
  205. }
  206. [Route("/Library/Movies/Added", "POST", Summary = "Reports that new movies have been added by an external source")]
  207. [Route("/Library/Movies/Updated", "POST", Summary = "Reports that new movies have been added by an external source")]
  208. [Authenticated]
  209. public class PostUpdatedMovies : IReturnVoid
  210. {
  211. [ApiMember(Name = "TmdbId", Description = "Tmdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "POST")]
  212. public string TmdbId { get; set; }
  213. [ApiMember(Name = "ImdbId", Description = "Imdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "POST")]
  214. public string ImdbId { get; set; }
  215. }
  216. public class MediaUpdateInfo
  217. {
  218. public string Path { get; set; }
  219. // Created, Modified, Deleted
  220. public string UpdateType { get; set; }
  221. }
  222. [Route("/Library/Media/Updated", "POST", Summary = "Reports that new movies have been added by an external source")]
  223. [Authenticated]
  224. public class PostUpdatedMedia : IReturnVoid
  225. {
  226. [ApiMember(Name = "Updates", Description = "A list of updated media paths", IsRequired = false, DataType = "string", ParameterType = "body", Verb = "POST")]
  227. public List<MediaUpdateInfo> Updates { get; set; }
  228. }
  229. [Route("/Items/{Id}/Download", "GET", Summary = "Downloads item media")]
  230. [Authenticated(Roles = "download")]
  231. public class GetDownload
  232. {
  233. /// <summary>
  234. /// Gets or sets the id.
  235. /// </summary>
  236. /// <value>The id.</value>
  237. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  238. public string Id { get; set; }
  239. }
  240. [Route("/Artists/{Id}/Similar", "GET", Summary = "Finds albums similar to a given album.")]
  241. [Route("/Items/{Id}/Similar", "GET", Summary = "Gets similar items")]
  242. [Route("/Albums/{Id}/Similar", "GET", Summary = "Finds albums similar to a given album.")]
  243. [Route("/Shows/{Id}/Similar", "GET", Summary = "Finds tv shows similar to a given one.")]
  244. [Route("/Movies/{Id}/Similar", "GET", Summary = "Finds movies and trailers similar to a given movie.")]
  245. [Route("/Trailers/{Id}/Similar", "GET", Summary = "Finds movies and trailers similar to a given trailer.")]
  246. [Authenticated]
  247. public class GetSimilarItems : BaseGetSimilarItemsFromItem
  248. {
  249. }
  250. [Route("/Libraries/AvailableOptions", "GET")]
  251. [Authenticated(AllowBeforeStartupWizard = true)]
  252. public class GetLibraryOptionsInfo : IReturn<LibraryOptionsResult>
  253. {
  254. public string LibraryContentType { get; set; }
  255. public bool IsNewLibrary { get; set; }
  256. }
  257. public class LibraryOptionInfo
  258. {
  259. public string Name { get; set; }
  260. public bool DefaultEnabled { get; set; }
  261. }
  262. public class LibraryOptionsResult
  263. {
  264. public LibraryOptionInfo[] MetadataSavers { get; set; }
  265. public LibraryOptionInfo[] MetadataReaders { get; set; }
  266. public LibraryOptionInfo[] SubtitleFetchers { get; set; }
  267. public LibraryTypeOptions[] TypeOptions { get; set; }
  268. }
  269. public class LibraryTypeOptions
  270. {
  271. public string Type { get; set; }
  272. public LibraryOptionInfo[] MetadataFetchers { get; set; }
  273. public LibraryOptionInfo[] ImageFetchers { get; set; }
  274. public ImageType[] SupportedImageTypes { get; set; }
  275. public ImageOption[] DefaultImageOptions { get; set; }
  276. }
  277. /// <summary>
  278. /// Class LibraryService
  279. /// </summary>
  280. public class LibraryService : BaseApiService
  281. {
  282. /// <summary>
  283. /// The _item repo
  284. /// </summary>
  285. private readonly IItemRepository _itemRepo;
  286. private readonly ILibraryManager _libraryManager;
  287. private readonly IUserManager _userManager;
  288. private readonly IUserDataManager _userDataManager;
  289. private readonly IDtoService _dtoService;
  290. private readonly IAuthorizationContext _authContext;
  291. private readonly IActivityManager _activityManager;
  292. private readonly ILocalizationManager _localization;
  293. private readonly ILiveTvManager _liveTv;
  294. private readonly ITVSeriesManager _tvManager;
  295. private readonly ILibraryMonitor _libraryMonitor;
  296. private readonly IFileSystem _fileSystem;
  297. private readonly IServerConfigurationManager _config;
  298. private readonly IProviderManager _providerManager;
  299. /// <summary>
  300. /// Initializes a new instance of the <see cref="LibraryService" /> class.
  301. /// </summary>
  302. public LibraryService(IProviderManager providerManager, IItemRepository itemRepo, ILibraryManager libraryManager, IUserManager userManager,
  303. IDtoService dtoService, IUserDataManager userDataManager, IAuthorizationContext authContext, IActivityManager activityManager, ILocalizationManager localization, ILiveTvManager liveTv, ITVSeriesManager tvManager, ILibraryMonitor libraryMonitor, IFileSystem fileSystem, IServerConfigurationManager config)
  304. {
  305. _itemRepo = itemRepo;
  306. _libraryManager = libraryManager;
  307. _userManager = userManager;
  308. _dtoService = dtoService;
  309. _userDataManager = userDataManager;
  310. _authContext = authContext;
  311. _activityManager = activityManager;
  312. _localization = localization;
  313. _liveTv = liveTv;
  314. _tvManager = tvManager;
  315. _libraryMonitor = libraryMonitor;
  316. _fileSystem = fileSystem;
  317. _config = config;
  318. _providerManager = providerManager;
  319. }
  320. private string[] GetRepresentativeItemTypes(string contentType)
  321. {
  322. switch (contentType)
  323. {
  324. case CollectionType.BoxSets:
  325. return new string[] { "BoxSet" };
  326. case CollectionType.Playlists:
  327. return new string[] { "Playlist" };
  328. case CollectionType.Movies:
  329. return new string[] { "Movie" };
  330. case CollectionType.TvShows:
  331. return new string[] { "Series", "Season", "Episode" };
  332. case CollectionType.Books:
  333. return new string[] { "Book" };
  334. case CollectionType.Music:
  335. return new string[] { "MusicAlbum", "MusicArtist", "Audio", "MusicVideo" };
  336. case CollectionType.HomeVideos:
  337. case CollectionType.Photos:
  338. return new string[] { "Video", "Photo" };
  339. case CollectionType.MusicVideos:
  340. return new string[] { "MusicVideo" };
  341. default:
  342. return new string[] { "Series", "Season", "Episode", "Movie" };
  343. }
  344. }
  345. private bool IsSaverEnabledByDefault(string name, string[] itemTypes, bool isNewLibrary)
  346. {
  347. if (isNewLibrary)
  348. {
  349. return false;
  350. }
  351. var metadataOptions = _config.Configuration.MetadataOptions
  352. .Where(i => itemTypes.Contains(i.ItemType ?? string.Empty, StringComparer.OrdinalIgnoreCase))
  353. .ToArray();
  354. if (metadataOptions.Length == 0)
  355. {
  356. return true;
  357. }
  358. return metadataOptions.Any(i => !i.DisabledMetadataSavers.Contains(name, StringComparer.OrdinalIgnoreCase));
  359. }
  360. private bool IsMetadataFetcherEnabledByDefault(string name, string type, bool isNewLibrary)
  361. {
  362. if (isNewLibrary)
  363. {
  364. if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase))
  365. {
  366. if (string.Equals(type, "Series", StringComparison.OrdinalIgnoreCase))
  367. {
  368. return true;
  369. }
  370. if (string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase))
  371. {
  372. return false;
  373. }
  374. if (string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase))
  375. {
  376. return false;
  377. }
  378. if (string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase))
  379. {
  380. return false;
  381. }
  382. return true;
  383. }
  384. else if (string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase))
  385. {
  386. return true;
  387. }
  388. else if (string.Equals(name, "The Open Movie Database", StringComparison.OrdinalIgnoreCase))
  389. {
  390. return false;
  391. }
  392. else if (string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase))
  393. {
  394. return true;
  395. }
  396. else if (string.Equals(name, "MusicBrainz", StringComparison.OrdinalIgnoreCase))
  397. {
  398. return true;
  399. }
  400. return false;
  401. }
  402. var metadataOptions = _config.Configuration.MetadataOptions
  403. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  404. .ToArray();
  405. if (metadataOptions.Length == 0)
  406. {
  407. return true;
  408. }
  409. return metadataOptions.Any(i => !i.DisabledMetadataFetchers.Contains(name, StringComparer.OrdinalIgnoreCase));
  410. }
  411. private bool IsImageFetcherEnabledByDefault(string name, string type, bool isNewLibrary)
  412. {
  413. if (isNewLibrary)
  414. {
  415. if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase))
  416. {
  417. if (string.Equals(type, "Series", StringComparison.OrdinalIgnoreCase))
  418. {
  419. return false;
  420. }
  421. if (string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase))
  422. {
  423. return false;
  424. }
  425. if (string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase))
  426. {
  427. return false;
  428. }
  429. if (string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase))
  430. {
  431. return false;
  432. }
  433. return true;
  434. }
  435. else if (string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase))
  436. {
  437. return true;
  438. }
  439. else if (string.Equals(name, "The Open Movie Database", StringComparison.OrdinalIgnoreCase))
  440. {
  441. return false;
  442. }
  443. else if (string.Equals(name, "FanArt", StringComparison.OrdinalIgnoreCase))
  444. {
  445. if (string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase))
  446. {
  447. return false;
  448. }
  449. if (string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase))
  450. {
  451. return false;
  452. }
  453. return true;
  454. }
  455. else if (string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase))
  456. {
  457. return true;
  458. }
  459. else if (string.Equals(name, "Emby Designs", StringComparison.OrdinalIgnoreCase))
  460. {
  461. return true;
  462. }
  463. else if (string.Equals(name, "Screen Grabber", StringComparison.OrdinalIgnoreCase))
  464. {
  465. return true;
  466. }
  467. else if (string.Equals(name, "Image Extractor", StringComparison.OrdinalIgnoreCase))
  468. {
  469. return true;
  470. }
  471. return false;
  472. }
  473. var metadataOptions = _config.Configuration.MetadataOptions
  474. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  475. .ToArray();
  476. if (metadataOptions.Length == 0)
  477. {
  478. return true;
  479. }
  480. return metadataOptions.Any(i => !i.DisabledImageFetchers.Contains(name, StringComparer.OrdinalIgnoreCase));
  481. }
  482. public object Get(GetLibraryOptionsInfo request)
  483. {
  484. var result = new LibraryOptionsResult();
  485. var types = GetRepresentativeItemTypes(request.LibraryContentType);
  486. var isNewLibrary = request.IsNewLibrary;
  487. var typesList = types.ToList();
  488. var plugins = _providerManager.GetAllMetadataPlugins()
  489. .Where(i => types.Contains(i.ItemType, StringComparer.OrdinalIgnoreCase))
  490. .OrderBy(i => typesList.IndexOf(i.ItemType))
  491. .ToList();
  492. result.MetadataSavers = plugins
  493. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataSaver))
  494. .Select(i => new LibraryOptionInfo
  495. {
  496. Name = i.Name,
  497. DefaultEnabled = IsSaverEnabledByDefault(i.Name, types, isNewLibrary)
  498. })
  499. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  500. .Select(x => x.First())
  501. .ToArray();
  502. result.MetadataReaders = plugins
  503. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.LocalMetadataProvider))
  504. .Select(i => new LibraryOptionInfo
  505. {
  506. Name = i.Name,
  507. DefaultEnabled = true
  508. })
  509. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  510. .Select(x => x.First())
  511. .ToArray();
  512. result.SubtitleFetchers = plugins
  513. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.SubtitleFetcher))
  514. .Select(i => new LibraryOptionInfo
  515. {
  516. Name = i.Name,
  517. DefaultEnabled = true
  518. })
  519. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  520. .Select(x => x.First())
  521. .ToArray();
  522. var typeOptions = new List<LibraryTypeOptions>();
  523. foreach (var type in types)
  524. {
  525. ImageOption[] defaultImageOptions = null;
  526. TypeOptions.DefaultImageOptions.TryGetValue(type, out defaultImageOptions);
  527. typeOptions.Add(new LibraryTypeOptions
  528. {
  529. Type = type,
  530. MetadataFetchers = plugins
  531. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  532. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataFetcher))
  533. .Select(i => new LibraryOptionInfo
  534. {
  535. Name = i.Name,
  536. DefaultEnabled = IsMetadataFetcherEnabledByDefault(i.Name, type, isNewLibrary)
  537. })
  538. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  539. .Select(x => x.First())
  540. .ToArray(),
  541. ImageFetchers = plugins
  542. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  543. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.ImageFetcher))
  544. .Select(i => new LibraryOptionInfo
  545. {
  546. Name = i.Name,
  547. DefaultEnabled = IsImageFetcherEnabledByDefault(i.Name, type, isNewLibrary)
  548. })
  549. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  550. .Select(x => x.First())
  551. .ToArray(),
  552. SupportedImageTypes = plugins
  553. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  554. .SelectMany(i => i.SupportedImageTypes ?? Array.Empty<ImageType>())
  555. .Distinct()
  556. .ToArray(),
  557. DefaultImageOptions = defaultImageOptions ?? Array.Empty<ImageOption>()
  558. });
  559. }
  560. result.TypeOptions = typeOptions.ToArray();
  561. return result;
  562. }
  563. public object Get(GetSimilarItems request)
  564. {
  565. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  566. var item = string.IsNullOrEmpty(request.Id) ?
  567. (!request.UserId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() :
  568. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  569. var program = item as IHasProgramAttributes;
  570. if (item is Movie || (program != null && program.IsMovie) || item is Trailer)
  571. {
  572. return new MoviesService(_userManager, _libraryManager, _dtoService, _config, _authContext)
  573. {
  574. Request = Request,
  575. }.GetSimilarItemsResult(request);
  576. }
  577. if (program != null && program.IsSeries)
  578. {
  579. return GetSimilarItemsResult(request, new[] { typeof(Series).Name });
  580. }
  581. if (item is Episode || (item is IItemByName && !(item is MusicArtist)))
  582. {
  583. return new QueryResult<BaseItemDto>();
  584. }
  585. return GetSimilarItemsResult(request, new[] { item.GetType().Name });
  586. }
  587. private QueryResult<BaseItemDto> GetSimilarItemsResult(BaseGetSimilarItemsFromItem request, string[] includeItemTypes)
  588. {
  589. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  590. var item = string.IsNullOrEmpty(request.Id) ?
  591. (!request.UserId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() :
  592. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  593. var dtoOptions = GetDtoOptions(_authContext, request);
  594. var query = new InternalItemsQuery(user)
  595. {
  596. Limit = request.Limit,
  597. IncludeItemTypes = includeItemTypes,
  598. SimilarTo = item,
  599. DtoOptions = dtoOptions,
  600. EnableTotalRecordCount = false
  601. };
  602. // ExcludeArtistIds
  603. if (!string.IsNullOrEmpty(request.ExcludeArtistIds))
  604. {
  605. query.ExcludeArtistIds = BaseApiService.GetGuids(request.ExcludeArtistIds);
  606. }
  607. List<BaseItem> itemsResult;
  608. if (item is MusicArtist)
  609. {
  610. query.IncludeItemTypes = Array.Empty<string>();
  611. itemsResult = _libraryManager.GetArtists(query).Items.Select(i => i.Item1).ToList();
  612. }
  613. else
  614. {
  615. itemsResult = _libraryManager.GetItemList(query);
  616. }
  617. var returnList = _dtoService.GetBaseItemDtos(itemsResult, dtoOptions, user);
  618. var result = new QueryResult<BaseItemDto>
  619. {
  620. Items = returnList,
  621. TotalRecordCount = itemsResult.Count
  622. };
  623. return result;
  624. }
  625. public object Get(GetMediaFolders request)
  626. {
  627. var items = _libraryManager.GetUserRootFolder().Children.Concat(_libraryManager.RootFolder.VirtualChildren).OrderBy(i => i.SortName).ToList();
  628. if (request.IsHidden.HasValue)
  629. {
  630. var val = request.IsHidden.Value;
  631. items = items.Where(i => i.IsHidden == val).ToList();
  632. }
  633. var dtoOptions = GetDtoOptions(_authContext, request);
  634. var result = new QueryResult<BaseItemDto>
  635. {
  636. TotalRecordCount = items.Count,
  637. Items = items.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions)).ToArray()
  638. };
  639. return result;
  640. }
  641. public void Post(PostUpdatedSeries request)
  642. {
  643. var series = _libraryManager.GetItemList(new InternalItemsQuery
  644. {
  645. IncludeItemTypes = new[] { typeof(Series).Name },
  646. DtoOptions = new DtoOptions(false)
  647. {
  648. EnableImages = false
  649. }
  650. }).Where(i => string.Equals(request.TvdbId, i.GetProviderId(MetadataProviders.Tvdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  651. foreach (var item in series)
  652. {
  653. _libraryMonitor.ReportFileSystemChanged(item.Path);
  654. }
  655. }
  656. public void Post(PostUpdatedMedia request)
  657. {
  658. if (request.Updates != null)
  659. {
  660. foreach (var item in request.Updates)
  661. {
  662. _libraryMonitor.ReportFileSystemChanged(item.Path);
  663. }
  664. }
  665. }
  666. public void Post(PostUpdatedMovies request)
  667. {
  668. var movies = _libraryManager.GetItemList(new InternalItemsQuery
  669. {
  670. IncludeItemTypes = new[] { typeof(Movie).Name },
  671. DtoOptions = new DtoOptions(false)
  672. {
  673. EnableImages = false
  674. }
  675. });
  676. if (!string.IsNullOrWhiteSpace(request.ImdbId))
  677. {
  678. movies = movies.Where(i => string.Equals(request.ImdbId, i.GetProviderId(MetadataProviders.Imdb), StringComparison.OrdinalIgnoreCase)).ToList();
  679. }
  680. else if (!string.IsNullOrWhiteSpace(request.TmdbId))
  681. {
  682. movies = movies.Where(i => string.Equals(request.TmdbId, i.GetProviderId(MetadataProviders.Tmdb), StringComparison.OrdinalIgnoreCase)).ToList();
  683. }
  684. else
  685. {
  686. movies = new List<BaseItem>();
  687. }
  688. foreach (var item in movies)
  689. {
  690. _libraryMonitor.ReportFileSystemChanged(item.Path);
  691. }
  692. }
  693. public Task<object> Get(GetDownload request)
  694. {
  695. var item = _libraryManager.GetItemById(request.Id);
  696. var auth = _authContext.GetAuthorizationInfo(Request);
  697. var user = auth.User;
  698. if (user != null)
  699. {
  700. if (!item.CanDownload(user))
  701. {
  702. throw new ArgumentException("Item does not support downloading");
  703. }
  704. }
  705. else
  706. {
  707. if (!item.CanDownload())
  708. {
  709. throw new ArgumentException("Item does not support downloading");
  710. }
  711. }
  712. var headers = new Dictionary<string, string>();
  713. if (user != null)
  714. {
  715. LogDownload(item, user, auth);
  716. }
  717. var path = item.Path;
  718. // Quotes are valid in linux. They'll possibly cause issues here
  719. var filename = (Path.GetFileName(path) ?? string.Empty).Replace("\"", string.Empty);
  720. if (!string.IsNullOrWhiteSpace(filename))
  721. {
  722. headers[HeaderNames.ContentDisposition] = "attachment; filename=\"" + filename + "\"";
  723. }
  724. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  725. {
  726. Path = path,
  727. ResponseHeaders = headers
  728. });
  729. }
  730. private void LogDownload(BaseItem item, User user, AuthorizationInfo auth)
  731. {
  732. try
  733. {
  734. _activityManager.Create(new ActivityLogEntry
  735. {
  736. Name = string.Format(_localization.GetLocalizedString("UserDownloadingItemWithValues"), user.Name, item.Name),
  737. Type = "UserDownloadingContent",
  738. ShortOverview = string.Format(_localization.GetLocalizedString("AppDeviceValues"), auth.Client, auth.Device),
  739. UserId = auth.UserId
  740. });
  741. }
  742. catch
  743. {
  744. // Logged at lower levels
  745. }
  746. }
  747. public Task<object> Get(GetFile request)
  748. {
  749. var item = _libraryManager.GetItemById(request.Id);
  750. return ResultFactory.GetStaticFileResult(Request, item.Path);
  751. }
  752. /// <summary>
  753. /// Gets the specified request.
  754. /// </summary>
  755. /// <param name="request">The request.</param>
  756. /// <returns>System.Object.</returns>
  757. public object Get(GetPhyscialPaths request)
  758. {
  759. var result = _libraryManager.RootFolder.Children
  760. .SelectMany(c => c.PhysicalLocations)
  761. .ToList();
  762. return ToOptimizedResult(result);
  763. }
  764. /// <summary>
  765. /// Gets the specified request.
  766. /// </summary>
  767. /// <param name="request">The request.</param>
  768. /// <returns>System.Object.</returns>
  769. public object Get(GetAncestors request)
  770. {
  771. var result = GetAncestors(request);
  772. return ToOptimizedResult(result);
  773. }
  774. /// <summary>
  775. /// Gets the ancestors.
  776. /// </summary>
  777. /// <param name="request">The request.</param>
  778. /// <returns>Task{BaseItemDto[]}.</returns>
  779. public List<BaseItemDto> GetAncestors(GetAncestors request)
  780. {
  781. var item = _libraryManager.GetItemById(request.Id);
  782. var baseItemDtos = new List<BaseItemDto>();
  783. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  784. var dtoOptions = GetDtoOptions(_authContext, request);
  785. BaseItem parent = item.GetParent();
  786. while (parent != null)
  787. {
  788. if (user != null)
  789. {
  790. parent = TranslateParentItem(parent, user);
  791. }
  792. baseItemDtos.Add(_dtoService.GetBaseItemDto(parent, dtoOptions, user));
  793. parent = parent.GetParent();
  794. }
  795. return baseItemDtos;
  796. }
  797. private BaseItem TranslateParentItem(BaseItem item, User user)
  798. {
  799. if (item.GetParent() is AggregateFolder)
  800. {
  801. return _libraryManager.GetUserRootFolder().GetChildren(user, true).FirstOrDefault(i => i.PhysicalLocations.Contains(item.Path));
  802. }
  803. return item;
  804. }
  805. /// <summary>
  806. /// Gets the specified request.
  807. /// </summary>
  808. /// <param name="request">The request.</param>
  809. /// <returns>System.Object.</returns>
  810. public object Get(GetCriticReviews request)
  811. {
  812. return new QueryResult<BaseItemDto>();
  813. }
  814. /// <summary>
  815. /// Gets the specified request.
  816. /// </summary>
  817. /// <param name="request">The request.</param>
  818. /// <returns>System.Object.</returns>
  819. public object Get(GetItemCounts request)
  820. {
  821. var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
  822. var counts = new ItemCounts
  823. {
  824. AlbumCount = GetCount(typeof(MusicAlbum), user, request),
  825. EpisodeCount = GetCount(typeof(Episode), user, request),
  826. MovieCount = GetCount(typeof(Movie), user, request),
  827. SeriesCount = GetCount(typeof(Series), user, request),
  828. SongCount = GetCount(typeof(Audio), user, request),
  829. MusicVideoCount = GetCount(typeof(MusicVideo), user, request),
  830. BoxSetCount = GetCount(typeof(BoxSet), user, request),
  831. BookCount = GetCount(typeof(Book), user, request)
  832. };
  833. return ToOptimizedResult(counts);
  834. }
  835. private int GetCount(Type type, User user, GetItemCounts request)
  836. {
  837. var query = new InternalItemsQuery(user)
  838. {
  839. IncludeItemTypes = new[] { type.Name },
  840. Limit = 0,
  841. Recursive = true,
  842. IsVirtualItem = false,
  843. IsFavorite = request.IsFavorite,
  844. DtoOptions = new DtoOptions(false)
  845. {
  846. EnableImages = false
  847. }
  848. };
  849. return _libraryManager.GetItemsResult(query).TotalRecordCount;
  850. }
  851. /// <summary>
  852. /// Posts the specified request.
  853. /// </summary>
  854. /// <param name="request">The request.</param>
  855. public void Post(RefreshLibrary request)
  856. {
  857. Task.Run(() =>
  858. {
  859. try
  860. {
  861. _libraryManager.ValidateMediaLibrary(new SimpleProgress<double>(), CancellationToken.None);
  862. }
  863. catch (Exception ex)
  864. {
  865. Logger.LogError(ex, "Error refreshing library");
  866. }
  867. });
  868. }
  869. /// <summary>
  870. /// Deletes the specified request.
  871. /// </summary>
  872. /// <param name="request">The request.</param>
  873. public void Delete(DeleteItems request)
  874. {
  875. var ids = string.IsNullOrWhiteSpace(request.Ids)
  876. ? Array.Empty<string>()
  877. : request.Ids.Split(',');
  878. foreach (var i in ids)
  879. {
  880. var item = _libraryManager.GetItemById(i);
  881. var auth = _authContext.GetAuthorizationInfo(Request);
  882. var user = auth.User;
  883. if (!item.CanDelete(user))
  884. {
  885. if (ids.Length > 1)
  886. {
  887. throw new SecurityException("Unauthorized access");
  888. }
  889. continue;
  890. }
  891. _libraryManager.DeleteItem(item, new DeleteOptions
  892. {
  893. DeleteFileLocation = true
  894. }, true);
  895. }
  896. }
  897. /// <summary>
  898. /// Deletes the specified request.
  899. /// </summary>
  900. /// <param name="request">The request.</param>
  901. public void Delete(DeleteItem request)
  902. {
  903. Delete(new DeleteItems
  904. {
  905. Ids = request.Id
  906. });
  907. }
  908. public object Get(GetThemeMedia request)
  909. {
  910. var themeSongs = GetThemeSongs(new GetThemeSongs
  911. {
  912. InheritFromParent = request.InheritFromParent,
  913. Id = request.Id,
  914. UserId = request.UserId
  915. });
  916. var themeVideos = GetThemeVideos(new GetThemeVideos
  917. {
  918. InheritFromParent = request.InheritFromParent,
  919. Id = request.Id,
  920. UserId = request.UserId
  921. });
  922. return ToOptimizedResult(new AllThemeMediaResult
  923. {
  924. ThemeSongsResult = themeSongs,
  925. ThemeVideosResult = themeVideos,
  926. SoundtrackSongsResult = new ThemeMediaResult()
  927. });
  928. }
  929. /// <summary>
  930. /// Gets the specified request.
  931. /// </summary>
  932. /// <param name="request">The request.</param>
  933. /// <returns>System.Object.</returns>
  934. public object Get(GetThemeSongs request)
  935. {
  936. var result = GetThemeSongs(request);
  937. return ToOptimizedResult(result);
  938. }
  939. private ThemeMediaResult GetThemeSongs(GetThemeSongs request)
  940. {
  941. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  942. var item = string.IsNullOrEmpty(request.Id)
  943. ? (!request.UserId.Equals(Guid.Empty)
  944. ? _libraryManager.GetUserRootFolder()
  945. : (Folder)_libraryManager.RootFolder)
  946. : _libraryManager.GetItemById(request.Id);
  947. if (item == null)
  948. {
  949. throw new ResourceNotFoundException("Item not found.");
  950. }
  951. BaseItem[] themeItems = Array.Empty<BaseItem>();
  952. while (true)
  953. {
  954. themeItems = item.GetThemeSongs().ToArray();
  955. if (themeItems.Length > 0)
  956. {
  957. break;
  958. }
  959. if (!request.InheritFromParent)
  960. {
  961. break;
  962. }
  963. var parent = item.GetParent();
  964. if (parent == null)
  965. {
  966. break;
  967. }
  968. item = parent;
  969. }
  970. var dtoOptions = GetDtoOptions(_authContext, request);
  971. var dtos = themeItems
  972. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item));
  973. var items = dtos.ToArray();
  974. return new ThemeMediaResult
  975. {
  976. Items = items,
  977. TotalRecordCount = items.Length,
  978. OwnerId = item.Id
  979. };
  980. }
  981. /// <summary>
  982. /// Gets the specified request.
  983. /// </summary>
  984. /// <param name="request">The request.</param>
  985. /// <returns>System.Object.</returns>
  986. public object Get(GetThemeVideos request)
  987. {
  988. var result = GetThemeVideos(request);
  989. return ToOptimizedResult(result);
  990. }
  991. public ThemeMediaResult GetThemeVideos(GetThemeVideos request)
  992. {
  993. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  994. var item = string.IsNullOrEmpty(request.Id)
  995. ? (!request.UserId.Equals(Guid.Empty)
  996. ? _libraryManager.GetUserRootFolder()
  997. : (Folder)_libraryManager.RootFolder)
  998. : _libraryManager.GetItemById(request.Id);
  999. if (item == null)
  1000. {
  1001. throw new ResourceNotFoundException("Item not found.");
  1002. }
  1003. BaseItem[] themeItems = Array.Empty<BaseItem>();
  1004. while (true)
  1005. {
  1006. themeItems = item.GetThemeVideos().ToArray();
  1007. if (themeItems.Length > 0)
  1008. {
  1009. break;
  1010. }
  1011. if (!request.InheritFromParent)
  1012. {
  1013. break;
  1014. }
  1015. var parent = item.GetParent();
  1016. if (parent == null)
  1017. {
  1018. break;
  1019. }
  1020. item = parent;
  1021. }
  1022. var dtoOptions = GetDtoOptions(_authContext, request);
  1023. var dtos = themeItems
  1024. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item));
  1025. var items = dtos.ToArray();
  1026. return new ThemeMediaResult
  1027. {
  1028. Items = items,
  1029. TotalRecordCount = items.Length,
  1030. OwnerId = item.Id
  1031. };
  1032. }
  1033. }
  1034. }