ProviderManager.cs 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831
  1. using MediaBrowser.Common.IO;
  2. using MediaBrowser.Common.Net;
  3. using MediaBrowser.Controller.Configuration;
  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.Providers;
  11. using MediaBrowser.Model.Configuration;
  12. using MediaBrowser.Model.Entities;
  13. using MediaBrowser.Model.Logging;
  14. using MediaBrowser.Model.Providers;
  15. using System;
  16. using System.Collections.Concurrent;
  17. using System.Collections.Generic;
  18. using System.IO;
  19. using System.Linq;
  20. using System.Threading;
  21. using System.Threading.Tasks;
  22. namespace MediaBrowser.Providers.Manager
  23. {
  24. /// <summary>
  25. /// Class ProviderManager
  26. /// </summary>
  27. public class ProviderManager : IProviderManager
  28. {
  29. /// <summary>
  30. /// The _logger
  31. /// </summary>
  32. private readonly ILogger _logger;
  33. /// <summary>
  34. /// The _HTTP client
  35. /// </summary>
  36. private readonly IHttpClient _httpClient;
  37. /// <summary>
  38. /// The _directory watchers
  39. /// </summary>
  40. private readonly ILibraryMonitor _libraryMonitor;
  41. /// <summary>
  42. /// Gets or sets the configuration manager.
  43. /// </summary>
  44. /// <value>The configuration manager.</value>
  45. private IServerConfigurationManager ConfigurationManager { get; set; }
  46. private IImageProvider[] ImageProviders { get; set; }
  47. private readonly IFileSystem _fileSystem;
  48. private IMetadataService[] _metadataServices = { };
  49. private IItemIdentityProvider[] _identityProviders = { };
  50. private IItemIdentityConverter[] _identityConverters = { };
  51. private IMetadataProvider[] _metadataProviders = { };
  52. private IEnumerable<IMetadataSaver> _savers;
  53. private IImageSaver[] _imageSavers;
  54. private IExternalId[] _externalIds;
  55. /// <summary>
  56. /// Initializes a new instance of the <see cref="ProviderManager" /> class.
  57. /// </summary>
  58. /// <param name="httpClient">The HTTP client.</param>
  59. /// <param name="configurationManager">The configuration manager.</param>
  60. /// <param name="libraryMonitor">The directory watchers.</param>
  61. /// <param name="logManager">The log manager.</param>
  62. /// <param name="fileSystem">The file system.</param>
  63. public ProviderManager(IHttpClient httpClient, IServerConfigurationManager configurationManager, ILibraryMonitor libraryMonitor, ILogManager logManager, IFileSystem fileSystem)
  64. {
  65. _logger = logManager.GetLogger("ProviderManager");
  66. _httpClient = httpClient;
  67. ConfigurationManager = configurationManager;
  68. _libraryMonitor = libraryMonitor;
  69. _fileSystem = fileSystem;
  70. }
  71. /// <summary>
  72. /// Adds the metadata providers.
  73. /// </summary>
  74. /// <param name="imageProviders">The image providers.</param>
  75. /// <param name="metadataServices">The metadata services.</param>
  76. /// <param name="identityProviders">The identity providers.</param>
  77. /// <param name="identityConverters">The identity converters.</param>
  78. /// <param name="metadataProviders">The metadata providers.</param>
  79. /// <param name="metadataSavers">The metadata savers.</param>
  80. /// <param name="imageSavers">The image savers.</param>
  81. /// <param name="externalIds">The external ids.</param>
  82. public void AddParts(IEnumerable<IImageProvider> imageProviders, IEnumerable<IMetadataService> metadataServices,
  83. IEnumerable<IItemIdentityProvider> identityProviders, IEnumerable<IItemIdentityConverter> identityConverters,
  84. IEnumerable<IMetadataProvider> metadataProviders, IEnumerable<IMetadataSaver> metadataSavers,
  85. IEnumerable<IImageSaver> imageSavers, IEnumerable<IExternalId> externalIds)
  86. {
  87. ImageProviders = imageProviders.ToArray();
  88. _metadataServices = metadataServices.OrderBy(i => i.Order).ToArray();
  89. _identityProviders = identityProviders.ToArray();
  90. _identityConverters = identityConverters.ToArray();
  91. _metadataProviders = metadataProviders.ToArray();
  92. _savers = metadataSavers.ToArray();
  93. _imageSavers = imageSavers.ToArray();
  94. _externalIds = externalIds.OrderBy(i => i.Name).ToArray();
  95. }
  96. public Task RefreshMetadata(IHasMetadata item, MetadataRefreshOptions options, CancellationToken cancellationToken)
  97. {
  98. var service = _metadataServices.FirstOrDefault(i => i.CanRefresh(item));
  99. if (service != null)
  100. {
  101. return service.RefreshMetadata(item, options, cancellationToken);
  102. }
  103. _logger.Error("Unable to find a metadata service for item of type " + item.GetType().Name);
  104. return Task.FromResult(true);
  105. }
  106. public async Task SaveImage(IHasImages item, string url, SemaphoreSlim resourcePool, ImageType type, int? imageIndex, CancellationToken cancellationToken)
  107. {
  108. var response = await _httpClient.GetResponse(new HttpRequestOptions
  109. {
  110. CancellationToken = cancellationToken,
  111. ResourcePool = resourcePool,
  112. Url = url
  113. }).ConfigureAwait(false);
  114. await SaveImage(item, response.Content, response.ContentType, type, imageIndex, cancellationToken)
  115. .ConfigureAwait(false);
  116. }
  117. public Task SaveImage(IHasImages item, Stream source, string mimeType, ImageType type, int? imageIndex, CancellationToken cancellationToken)
  118. {
  119. return new ImageSaver(ConfigurationManager, _libraryMonitor, _fileSystem, _logger).SaveImage(item, source, mimeType, type, imageIndex, cancellationToken);
  120. }
  121. public async Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(IHasImages item, RemoteImageQuery query, CancellationToken cancellationToken)
  122. {
  123. var providers = GetRemoteImageProviders(item, query.IncludeDisabledProviders);
  124. if (!string.IsNullOrEmpty(query.ProviderName))
  125. {
  126. var providerName = query.ProviderName;
  127. providers = providers.Where(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase));
  128. }
  129. var preferredLanguage = item.GetPreferredMetadataLanguage();
  130. var languages = new List<string>();
  131. if (!query.IncludeAllLanguages && !string.IsNullOrWhiteSpace(preferredLanguage))
  132. {
  133. languages.Add(preferredLanguage);
  134. }
  135. var tasks = providers.Select(i => GetImages(item, cancellationToken, i, languages, query.ImageType));
  136. var results = await Task.WhenAll(tasks).ConfigureAwait(false);
  137. var images = results.SelectMany(i => i);
  138. return images;
  139. }
  140. /// <summary>
  141. /// Gets the images.
  142. /// </summary>
  143. /// <param name="item">The item.</param>
  144. /// <param name="cancellationToken">The cancellation token.</param>
  145. /// <param name="provider">The provider.</param>
  146. /// <param name="preferredLanguages">The preferred languages.</param>
  147. /// <param name="type">The type.</param>
  148. /// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns>
  149. private async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, CancellationToken cancellationToken, IRemoteImageProvider provider, List<string> preferredLanguages, ImageType? type = null)
  150. {
  151. try
  152. {
  153. var result = await provider.GetImages(item, cancellationToken).ConfigureAwait(false);
  154. if (type.HasValue)
  155. {
  156. result = result.Where(i => i.Type == type.Value);
  157. }
  158. if (preferredLanguages.Count > 0)
  159. {
  160. result = result.Where(i => string.IsNullOrEmpty(i.Language) ||
  161. preferredLanguages.Contains(i.Language, StringComparer.OrdinalIgnoreCase) ||
  162. string.Equals(i.Language, "en", StringComparison.OrdinalIgnoreCase));
  163. }
  164. return result;
  165. }
  166. catch (OperationCanceledException)
  167. {
  168. return new List<RemoteImageInfo>();
  169. }
  170. catch (Exception ex)
  171. {
  172. _logger.ErrorException("{0} failed in GetImageInfos for type {1}", ex, provider.GetType().Name, item.GetType().Name);
  173. return new List<RemoteImageInfo>();
  174. }
  175. }
  176. /// <summary>
  177. /// Gets the supported image providers.
  178. /// </summary>
  179. /// <param name="item">The item.</param>
  180. /// <returns>IEnumerable{IImageProvider}.</returns>
  181. public IEnumerable<ImageProviderInfo> GetRemoteImageProviderInfo(IHasImages item)
  182. {
  183. return GetRemoteImageProviders(item, true).Select(i => new ImageProviderInfo
  184. {
  185. Name = i.Name,
  186. SupportedImages = i.GetSupportedImages(item).ToList()
  187. });
  188. }
  189. public IEnumerable<IImageProvider> GetImageProviders(IHasImages item)
  190. {
  191. return GetImageProviders(item, GetMetadataOptions(item), false);
  192. }
  193. private IEnumerable<IImageProvider> GetImageProviders(IHasImages item, MetadataOptions options, bool includeDisabled)
  194. {
  195. // Avoid implicitly captured closure
  196. var currentOptions = options;
  197. return ImageProviders.Where(i => CanRefresh(i, item, options, includeDisabled))
  198. .OrderBy(i =>
  199. {
  200. // See if there's a user-defined order
  201. if (!(i is ILocalImageProvider))
  202. {
  203. var index = Array.IndexOf(currentOptions.ImageFetcherOrder, i.Name);
  204. if (index != -1)
  205. {
  206. return index;
  207. }
  208. }
  209. // Not configured. Just return some high number to put it at the end.
  210. return 100;
  211. })
  212. .ThenBy(GetOrder);
  213. }
  214. public IEnumerable<IMetadataProvider<T>> GetMetadataProviders<T>(IHasMetadata item)
  215. where T : IHasMetadata
  216. {
  217. var options = GetMetadataOptions(item);
  218. return GetMetadataProvidersInternal<T>(item, options, false);
  219. }
  220. private IEnumerable<IMetadataProvider<T>> GetMetadataProvidersInternal<T>(IHasMetadata item, MetadataOptions options, bool includeDisabled)
  221. where T : IHasMetadata
  222. {
  223. // Avoid implicitly captured closure
  224. var currentOptions = options;
  225. return _metadataProviders.OfType<IMetadataProvider<T>>()
  226. .Where(i => CanRefresh(i, item, currentOptions, includeDisabled))
  227. .OrderBy(i => GetConfiguredOrder(i, options))
  228. .ThenBy(GetDefaultOrder);
  229. }
  230. public IEnumerable<IItemIdentityProvider<TLookupInfo, TIdentity>> GetItemIdentityProviders<TLookupInfo, TIdentity>()
  231. where TLookupInfo : ItemLookupInfo
  232. where TIdentity : IItemIdentity
  233. {
  234. return _identityProviders.OfType<IItemIdentityProvider<TLookupInfo, TIdentity>>();
  235. }
  236. public IEnumerable<IItemIdentityConverter<TIdentity>> GetItemIdentityConverters<TIdentity>()
  237. where TIdentity : IItemIdentity
  238. {
  239. return _identityConverters.OfType<IItemIdentityConverter<TIdentity>>();
  240. }
  241. private IEnumerable<IRemoteImageProvider> GetRemoteImageProviders(IHasImages item, bool includeDisabled)
  242. {
  243. var options = GetMetadataOptions(item);
  244. return GetImageProviders(item, options, includeDisabled).OfType<IRemoteImageProvider>();
  245. }
  246. private bool CanRefresh(IMetadataProvider provider, IHasMetadata item, MetadataOptions options, bool includeDisabled)
  247. {
  248. if (!includeDisabled)
  249. {
  250. // If locked only allow local providers
  251. if (item.IsLocked && !(provider is ILocalMetadataProvider) && !(provider is IForcedProvider))
  252. {
  253. return false;
  254. }
  255. if (provider is IRemoteMetadataProvider)
  256. {
  257. if (!ConfigurationManager.Configuration.EnableInternetProviders)
  258. {
  259. return false;
  260. }
  261. if (Array.IndexOf(options.DisabledMetadataFetchers, provider.Name) != -1)
  262. {
  263. return false;
  264. }
  265. }
  266. }
  267. if (!item.SupportsLocalMetadata && provider is ILocalMetadataProvider)
  268. {
  269. return false;
  270. }
  271. // If this restriction is ever lifted, movie xml providers will have to be updated to prevent owned items like trailers from reading those files
  272. if (item.IsOwnedItem)
  273. {
  274. if (provider is ILocalMetadataProvider || provider is IRemoteMetadataProvider)
  275. {
  276. return false;
  277. }
  278. }
  279. return true;
  280. }
  281. private bool CanRefresh(IImageProvider provider, IHasImages item, MetadataOptions options, bool includeDisabled)
  282. {
  283. if (!includeDisabled)
  284. {
  285. // If locked only allow local providers
  286. if (item.IsLocked && !(provider is ILocalImageProvider))
  287. {
  288. return false;
  289. }
  290. if (provider is IRemoteImageProvider || provider is IDynamicImageProvider)
  291. {
  292. if (Array.IndexOf(options.DisabledImageFetchers, provider.Name) != -1)
  293. {
  294. return false;
  295. }
  296. if (provider is IRemoteImageProvider)
  297. {
  298. if (!ConfigurationManager.Configuration.EnableInternetProviders)
  299. {
  300. return false;
  301. }
  302. }
  303. }
  304. }
  305. try
  306. {
  307. return provider.Supports(item);
  308. }
  309. catch (Exception ex)
  310. {
  311. _logger.ErrorException("{0} failed in Supports for type {1}", ex, provider.GetType().Name, item.GetType().Name);
  312. return false;
  313. }
  314. }
  315. /// <summary>
  316. /// Gets the order.
  317. /// </summary>
  318. /// <param name="provider">The provider.</param>
  319. /// <returns>System.Int32.</returns>
  320. private int GetOrder(IImageProvider provider)
  321. {
  322. var hasOrder = provider as IHasOrder;
  323. if (hasOrder == null)
  324. {
  325. return 0;
  326. }
  327. return hasOrder.Order;
  328. }
  329. private int GetConfiguredOrder(IMetadataProvider provider, MetadataOptions options)
  330. {
  331. // See if there's a user-defined order
  332. if (provider is ILocalMetadataProvider)
  333. {
  334. var index = Array.IndexOf(options.LocalMetadataReaderOrder, provider.Name);
  335. if (index != -1)
  336. {
  337. return index;
  338. }
  339. }
  340. // See if there's a user-defined order
  341. if (provider is IRemoteMetadataProvider)
  342. {
  343. var index = Array.IndexOf(options.MetadataFetcherOrder, provider.Name);
  344. if (index != -1)
  345. {
  346. return index;
  347. }
  348. }
  349. // Not configured. Just return some high number to put it at the end.
  350. return 100;
  351. }
  352. private int GetDefaultOrder(IMetadataProvider provider)
  353. {
  354. var hasOrder = provider as IHasOrder;
  355. if (hasOrder != null)
  356. {
  357. return hasOrder.Order;
  358. }
  359. return 0;
  360. }
  361. public IEnumerable<MetadataPluginSummary> GetAllMetadataPlugins()
  362. {
  363. var list = new List<MetadataPluginSummary>
  364. {
  365. GetPluginSummary<Game>(),
  366. GetPluginSummary<GameSystem>(),
  367. GetPluginSummary<Movie>(),
  368. GetPluginSummary<Trailer>(),
  369. GetPluginSummary<BoxSet>(),
  370. GetPluginSummary<Book>(),
  371. GetPluginSummary<Series>(),
  372. GetPluginSummary<Season>(),
  373. GetPluginSummary<Episode>(),
  374. GetPluginSummary<Person>(),
  375. GetPluginSummary<MusicAlbum>(),
  376. GetPluginSummary<MusicArtist>(),
  377. GetPluginSummary<Audio>(),
  378. GetPluginSummary<Genre>(),
  379. GetPluginSummary<Studio>(),
  380. GetPluginSummary<GameGenre>(),
  381. GetPluginSummary<MusicGenre>(),
  382. GetPluginSummary<MusicVideo>(),
  383. GetPluginSummary<Video>(),
  384. GetPluginSummary<LiveTvChannel>(),
  385. GetPluginSummary<LiveTvProgram>(),
  386. GetPluginSummary<LiveTvVideoRecording>(),
  387. GetPluginSummary<LiveTvAudioRecording>()
  388. };
  389. return list;
  390. }
  391. private MetadataPluginSummary GetPluginSummary<T>()
  392. where T : BaseItem, new()
  393. {
  394. // Give it a dummy path just so that it looks like a file system item
  395. var dummy = new T()
  396. {
  397. Path = "C:\\",
  398. // Dummy this up to fool the local trailer check
  399. Parent = new Folder()
  400. };
  401. var options = GetMetadataOptions(dummy);
  402. var summary = new MetadataPluginSummary
  403. {
  404. ItemType = typeof(T).Name
  405. };
  406. var imageProviders = GetImageProviders(dummy, options, true).ToList();
  407. AddMetadataPlugins(summary.Plugins, dummy, options);
  408. AddImagePlugins(summary.Plugins, dummy, imageProviders);
  409. var supportedImageTypes = imageProviders.OfType<IRemoteImageProvider>()
  410. .SelectMany(i => i.GetSupportedImages(dummy))
  411. .ToList();
  412. supportedImageTypes.AddRange(imageProviders.OfType<IDynamicImageProvider>()
  413. .SelectMany(i => i.GetSupportedImages(dummy)));
  414. summary.SupportedImageTypes = supportedImageTypes.Distinct().ToList();
  415. return summary;
  416. }
  417. private void AddMetadataPlugins<T>(List<MetadataPlugin> list, T item, MetadataOptions options)
  418. where T : IHasMetadata
  419. {
  420. var providers = GetMetadataProvidersInternal<T>(item, options, true).ToList();
  421. // Locals
  422. list.AddRange(providers.Where(i => (i is ILocalMetadataProvider)).Select(i => new MetadataPlugin
  423. {
  424. Name = i.Name,
  425. Type = MetadataPluginType.LocalMetadataProvider
  426. }));
  427. if (ConfigurationManager.Configuration.EnableInternetProviders)
  428. {
  429. // Fetchers
  430. list.AddRange(providers.Where(i => (i is IRemoteMetadataProvider)).Select(i => new MetadataPlugin
  431. {
  432. Name = i.Name,
  433. Type = MetadataPluginType.MetadataFetcher
  434. }));
  435. }
  436. if (item.IsSaveLocalMetadataEnabled())
  437. {
  438. // Savers
  439. list.AddRange(_savers.Where(i => IsSaverEnabledForItem(i, item, ItemUpdateType.MetadataEdit, true)).OrderBy(i => i.Name).Select(i => new MetadataPlugin
  440. {
  441. Name = i.Name,
  442. Type = MetadataPluginType.MetadataSaver
  443. }));
  444. }
  445. }
  446. private void AddImagePlugins<T>(List<MetadataPlugin> list, T item, List<IImageProvider> imageProviders)
  447. where T : IHasImages
  448. {
  449. // Locals
  450. list.AddRange(imageProviders.Where(i => (i is ILocalImageProvider)).Select(i => new MetadataPlugin
  451. {
  452. Name = i.Name,
  453. Type = MetadataPluginType.LocalImageProvider
  454. }));
  455. var enableInternet = ConfigurationManager.Configuration.EnableInternetProviders;
  456. // Fetchers
  457. list.AddRange(imageProviders.Where(i => i is IDynamicImageProvider || (enableInternet && i is IRemoteImageProvider)).Select(i => new MetadataPlugin
  458. {
  459. Name = i.Name,
  460. Type = MetadataPluginType.ImageFetcher
  461. }));
  462. }
  463. public MetadataOptions GetMetadataOptions(IHasImages item)
  464. {
  465. var type = item.GetType().Name;
  466. return ConfigurationManager.Configuration.MetadataOptions
  467. .FirstOrDefault(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase)) ??
  468. new MetadataOptions();
  469. }
  470. private readonly ConcurrentDictionary<string, SemaphoreSlim> _fileLocks = new ConcurrentDictionary<string, SemaphoreSlim>();
  471. /// <summary>
  472. /// Saves the metadata.
  473. /// </summary>
  474. /// <param name="item">The item.</param>
  475. /// <param name="updateType">Type of the update.</param>
  476. /// <returns>Task.</returns>
  477. public Task SaveMetadata(IHasMetadata item, ItemUpdateType updateType)
  478. {
  479. return SaveMetadata(item, updateType, _savers);
  480. }
  481. /// <summary>
  482. /// Saves the metadata.
  483. /// </summary>
  484. /// <param name="item">The item.</param>
  485. /// <param name="updateType">Type of the update.</param>
  486. /// <param name="savers">The savers.</param>
  487. /// <returns>Task.</returns>
  488. public Task SaveMetadata(IHasMetadata item, ItemUpdateType updateType, IEnumerable<string> savers)
  489. {
  490. return SaveMetadata(item, updateType, _savers.Where(i => savers.Contains(i.Name, StringComparer.OrdinalIgnoreCase)));
  491. }
  492. /// <summary>
  493. /// Saves the metadata.
  494. /// </summary>
  495. /// <param name="item">The item.</param>
  496. /// <param name="updateType">Type of the update.</param>
  497. /// <param name="savers">The savers.</param>
  498. /// <returns>Task.</returns>
  499. private async Task SaveMetadata(IHasMetadata item, ItemUpdateType updateType, IEnumerable<IMetadataSaver> savers)
  500. {
  501. foreach (var saver in savers.Where(i => IsSaverEnabledForItem(i, item, updateType, false)))
  502. {
  503. _logger.Debug("Saving {0} to {1}.", item.Path ?? item.Name, saver.Name);
  504. var fileSaver = saver as IMetadataFileSaver;
  505. if (fileSaver != null)
  506. {
  507. string path = null;
  508. try
  509. {
  510. path = fileSaver.GetSavePath(item);
  511. }
  512. catch (Exception ex)
  513. {
  514. _logger.ErrorException("Error in {0} GetSavePath", ex, saver.Name);
  515. continue;
  516. }
  517. var semaphore = _fileLocks.GetOrAdd(path, key => new SemaphoreSlim(1, 1));
  518. await semaphore.WaitAsync().ConfigureAwait(false);
  519. try
  520. {
  521. _libraryMonitor.ReportFileSystemChangeBeginning(path);
  522. saver.Save(item, CancellationToken.None);
  523. }
  524. catch (Exception ex)
  525. {
  526. _logger.ErrorException("Error in metadata saver", ex);
  527. }
  528. finally
  529. {
  530. _libraryMonitor.ReportFileSystemChangeComplete(path, false);
  531. semaphore.Release();
  532. }
  533. }
  534. else
  535. {
  536. try
  537. {
  538. saver.Save(item, CancellationToken.None);
  539. }
  540. catch (Exception ex)
  541. {
  542. _logger.ErrorException("Error in metadata saver", ex);
  543. }
  544. }
  545. }
  546. }
  547. /// <summary>
  548. /// Determines whether [is saver enabled for item] [the specified saver].
  549. /// </summary>
  550. /// <param name="saver">The saver.</param>
  551. /// <param name="item">The item.</param>
  552. /// <param name="updateType">Type of the update.</param>
  553. /// <param name="includeDisabled">if set to <c>true</c> [include disabled].</param>
  554. /// <returns><c>true</c> if [is saver enabled for item] [the specified saver]; otherwise, <c>false</c>.</returns>
  555. private bool IsSaverEnabledForItem(IMetadataSaver saver, IHasMetadata item, ItemUpdateType updateType, bool includeDisabled)
  556. {
  557. var options = GetMetadataOptions(item);
  558. try
  559. {
  560. var isEnabledFor = saver.IsEnabledFor(item, updateType);
  561. if (!includeDisabled)
  562. {
  563. if (options.DisabledMetadataSavers.Contains(saver.Name, StringComparer.OrdinalIgnoreCase))
  564. {
  565. return false;
  566. }
  567. if (!item.IsSaveLocalMetadataEnabled())
  568. {
  569. if (updateType >= ItemUpdateType.MetadataEdit)
  570. {
  571. var fileSaver = saver as IMetadataFileSaver;
  572. // Manual edit occurred
  573. // Even if save local is off, save locally anyway if the metadata file already exists
  574. if (fileSaver == null || !isEnabledFor || !File.Exists(fileSaver.GetSavePath(item)))
  575. {
  576. return false;
  577. }
  578. }
  579. else
  580. {
  581. // Manual edit did not occur
  582. // Since local metadata saving is disabled, consider it disabled
  583. return false;
  584. }
  585. }
  586. }
  587. return isEnabledFor;
  588. }
  589. catch (Exception ex)
  590. {
  591. _logger.ErrorException("Error in {0}.IsEnabledFor", ex, saver.Name);
  592. return false;
  593. }
  594. }
  595. public async Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo,
  596. CancellationToken cancellationToken)
  597. where TItemType : BaseItem, new()
  598. where TLookupType : ItemLookupInfo
  599. {
  600. // Give it a dummy path just so that it looks like a file system item
  601. var dummy = new TItemType
  602. {
  603. Path = "C:\\",
  604. // Dummy this up to fool the local trailer check
  605. Parent = new Folder()
  606. };
  607. var options = GetMetadataOptions(dummy);
  608. var providers = GetMetadataProvidersInternal<TItemType>(dummy, options, searchInfo.IncludeDisabledProviders)
  609. .OfType<IRemoteSearchProvider<TLookupType>>();
  610. if (!string.IsNullOrEmpty(searchInfo.SearchProviderName))
  611. {
  612. providers = providers.Where(i => string.Equals(i.Name, searchInfo.SearchProviderName, StringComparison.OrdinalIgnoreCase));
  613. }
  614. if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataLanguage))
  615. {
  616. searchInfo.SearchInfo.MetadataLanguage = ConfigurationManager.Configuration.PreferredMetadataLanguage;
  617. }
  618. if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataCountryCode))
  619. {
  620. searchInfo.SearchInfo.MetadataCountryCode = ConfigurationManager.Configuration.MetadataCountryCode;
  621. }
  622. foreach (var provider in providers)
  623. {
  624. var results = await GetSearchResults(provider, searchInfo.SearchInfo, cancellationToken).ConfigureAwait(false);
  625. var list = results.ToList();
  626. if (list.Count > 0)
  627. {
  628. return list.Take(10);
  629. }
  630. }
  631. // Nothing found
  632. return new List<RemoteSearchResult>();
  633. }
  634. private async Task<IEnumerable<RemoteSearchResult>> GetSearchResults<TLookupType>(IRemoteSearchProvider<TLookupType> provider, TLookupType searchInfo,
  635. CancellationToken cancellationToken)
  636. where TLookupType : ItemLookupInfo
  637. {
  638. var results = await provider.GetSearchResults(searchInfo, cancellationToken).ConfigureAwait(false);
  639. var list = results.ToList();
  640. foreach (var item in list)
  641. {
  642. item.SearchProviderName = provider.Name;
  643. }
  644. return list;
  645. }
  646. public Task<HttpResponseInfo> GetSearchImage(string providerName, string url, CancellationToken cancellationToken)
  647. {
  648. var provider = _metadataProviders.OfType<IRemoteSearchProvider>().FirstOrDefault(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase));
  649. if (provider == null)
  650. {
  651. throw new ArgumentException("Search provider not found.");
  652. }
  653. return provider.GetImageResponse(url, cancellationToken);
  654. }
  655. public IEnumerable<IExternalId> GetExternalIds(IHasProviderIds item)
  656. {
  657. return _externalIds.Where(i =>
  658. {
  659. try
  660. {
  661. return i.Supports(item);
  662. }
  663. catch (Exception ex)
  664. {
  665. _logger.ErrorException("Error in {0}.Suports", ex, i.GetType().Name);
  666. return false;
  667. }
  668. });
  669. }
  670. public IEnumerable<ExternalUrl> GetExternalUrls(IHasProviderIds item)
  671. {
  672. return GetExternalIds(item)
  673. .Select(i =>
  674. {
  675. if (string.IsNullOrEmpty(i.UrlFormatString))
  676. {
  677. return null;
  678. }
  679. var value = item.GetProviderId(i.Key);
  680. if (string.IsNullOrEmpty(value))
  681. {
  682. return null;
  683. }
  684. return new ExternalUrl
  685. {
  686. Name = i.Name,
  687. Url = string.Format(i.UrlFormatString, value)
  688. };
  689. }).Where(i => i != null);
  690. }
  691. public IEnumerable<ExternalIdInfo> GetExternalIdInfos(IHasProviderIds item)
  692. {
  693. return GetExternalIds(item)
  694. .Select(i => new ExternalIdInfo
  695. {
  696. Name = i.Name,
  697. Key = i.Key,
  698. UrlFormatString = i.UrlFormatString
  699. });
  700. }
  701. }
  702. }