ProviderManager.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805
  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 language = query.IncludeAllLanguages ? null : preferredLanguage;
  131. var tasks = providers.Select(i => GetImages(item, cancellationToken, i, language, query.ImageType));
  132. var results = await Task.WhenAll(tasks).ConfigureAwait(false);
  133. var images = results.SelectMany(i => i);
  134. return images;
  135. }
  136. /// <summary>
  137. /// Gets the images.
  138. /// </summary>
  139. /// <param name="item">The item.</param>
  140. /// <param name="cancellationToken">The cancellation token.</param>
  141. /// <param name="provider">The provider.</param>
  142. /// <param name="preferredLanguage">The preferred language.</param>
  143. /// <param name="type">The type.</param>
  144. /// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns>
  145. private async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, CancellationToken cancellationToken, IRemoteImageProvider provider, string preferredLanguage, ImageType? type = null)
  146. {
  147. try
  148. {
  149. var result = await provider.GetImages(item, cancellationToken).ConfigureAwait(false);
  150. if (type.HasValue)
  151. {
  152. result = result.Where(i => i.Type == type.Value);
  153. }
  154. if (string.Equals(preferredLanguage, "en", StringComparison.OrdinalIgnoreCase))
  155. {
  156. result = result.Where(i => string.IsNullOrEmpty(i.Language) ||
  157. string.Equals(i.Language, "en", StringComparison.OrdinalIgnoreCase));
  158. }
  159. return result;
  160. }
  161. catch (OperationCanceledException)
  162. {
  163. return new List<RemoteImageInfo>();
  164. }
  165. catch (Exception ex)
  166. {
  167. _logger.ErrorException("{0} failed in GetImageInfos for type {1}", ex, provider.GetType().Name, item.GetType().Name);
  168. return new List<RemoteImageInfo>();
  169. }
  170. }
  171. /// <summary>
  172. /// Gets the supported image providers.
  173. /// </summary>
  174. /// <param name="item">The item.</param>
  175. /// <returns>IEnumerable{IImageProvider}.</returns>
  176. public IEnumerable<ImageProviderInfo> GetRemoteImageProviderInfo(IHasImages item)
  177. {
  178. return GetRemoteImageProviders(item, true).Select(i => new ImageProviderInfo
  179. {
  180. Name = i.Name,
  181. SupportedImages = i.GetSupportedImages(item).ToList()
  182. });
  183. }
  184. public IEnumerable<IImageProvider> GetImageProviders(IHasImages item)
  185. {
  186. return GetImageProviders(item, GetMetadataOptions(item), false);
  187. }
  188. private IEnumerable<IImageProvider> GetImageProviders(IHasImages item, MetadataOptions options, bool includeDisabled)
  189. {
  190. // Avoid implicitly captured closure
  191. var currentOptions = options;
  192. return ImageProviders.Where(i => CanRefresh(i, item, options, includeDisabled))
  193. .OrderBy(i =>
  194. {
  195. // See if there's a user-defined order
  196. if (!(i is ILocalImageProvider))
  197. {
  198. var index = Array.IndexOf(currentOptions.ImageFetcherOrder, i.Name);
  199. if (index != -1)
  200. {
  201. return index;
  202. }
  203. }
  204. // Not configured. Just return some high number to put it at the end.
  205. return 100;
  206. })
  207. .ThenBy(GetOrder);
  208. }
  209. public IEnumerable<IMetadataProvider<T>> GetMetadataProviders<T>(IHasMetadata item)
  210. where T : IHasMetadata
  211. {
  212. var options = GetMetadataOptions(item);
  213. return GetMetadataProvidersInternal<T>(item, options, false);
  214. }
  215. private IEnumerable<IMetadataProvider<T>> GetMetadataProvidersInternal<T>(IHasMetadata item, MetadataOptions options, bool includeDisabled)
  216. where T : IHasMetadata
  217. {
  218. // Avoid implicitly captured closure
  219. var currentOptions = options;
  220. return _metadataProviders.OfType<IMetadataProvider<T>>()
  221. .Where(i => CanRefresh(i, item, currentOptions, includeDisabled))
  222. .OrderBy(i => GetConfiguredOrder(i, options))
  223. .ThenBy(GetDefaultOrder);
  224. }
  225. public IEnumerable<IItemIdentityProvider<TLookupInfo, TIdentity>> GetItemIdentityProviders<TLookupInfo, TIdentity>()
  226. where TLookupInfo : ItemLookupInfo
  227. where TIdentity : IItemIdentity
  228. {
  229. return _identityProviders.OfType<IItemIdentityProvider<TLookupInfo, TIdentity>>();
  230. }
  231. public IEnumerable<IItemIdentityConverter<TIdentity>> GetItemIdentityConverters<TIdentity>()
  232. where TIdentity : IItemIdentity
  233. {
  234. return _identityConverters.OfType<IItemIdentityConverter<TIdentity>>();
  235. }
  236. private IEnumerable<IRemoteImageProvider> GetRemoteImageProviders(IHasImages item, bool includeDisabled)
  237. {
  238. var options = GetMetadataOptions(item);
  239. return GetImageProviders(item, options, includeDisabled).OfType<IRemoteImageProvider>();
  240. }
  241. private bool CanRefresh(IMetadataProvider provider, IHasMetadata item, MetadataOptions options, bool includeDisabled)
  242. {
  243. if (!includeDisabled)
  244. {
  245. // If locked only allow local providers
  246. if (item.IsLocked && !(provider is ILocalMetadataProvider) && !(provider is IForcedProvider))
  247. {
  248. return false;
  249. }
  250. if (provider is IRemoteMetadataProvider)
  251. {
  252. if (!ConfigurationManager.Configuration.EnableInternetProviders)
  253. {
  254. return false;
  255. }
  256. if (Array.IndexOf(options.DisabledMetadataFetchers, provider.Name) != -1)
  257. {
  258. return false;
  259. }
  260. }
  261. }
  262. if (!item.SupportsLocalMetadata && provider is ILocalMetadataProvider)
  263. {
  264. return false;
  265. }
  266. // If this restriction is ever lifted, movie xml providers will have to be updated to prevent owned items like trailers from reading those files
  267. if (item.IsOwnedItem)
  268. {
  269. if (provider is ILocalMetadataProvider || provider is IRemoteMetadataProvider)
  270. {
  271. return false;
  272. }
  273. }
  274. return true;
  275. }
  276. private bool CanRefresh(IImageProvider provider, IHasImages item, MetadataOptions options, bool includeDisabled)
  277. {
  278. if (!includeDisabled)
  279. {
  280. // If locked only allow local providers
  281. if (item.IsLocked && !(provider is ILocalImageProvider))
  282. {
  283. return false;
  284. }
  285. if (provider is IRemoteImageProvider)
  286. {
  287. if (!ConfigurationManager.Configuration.EnableInternetProviders)
  288. {
  289. return false;
  290. }
  291. if (Array.IndexOf(options.DisabledImageFetchers, provider.Name) != -1)
  292. {
  293. return false;
  294. }
  295. }
  296. }
  297. if (!item.SupportsLocalMetadata && provider is ILocalImageProvider)
  298. {
  299. return false;
  300. }
  301. try
  302. {
  303. return provider.Supports(item);
  304. }
  305. catch (Exception ex)
  306. {
  307. _logger.ErrorException("{0} failed in Supports for type {1}", ex, provider.GetType().Name, item.GetType().Name);
  308. return false;
  309. }
  310. }
  311. /// <summary>
  312. /// Gets the order.
  313. /// </summary>
  314. /// <param name="provider">The provider.</param>
  315. /// <returns>System.Int32.</returns>
  316. private int GetOrder(IImageProvider provider)
  317. {
  318. var hasOrder = provider as IHasOrder;
  319. if (hasOrder == null)
  320. {
  321. return 0;
  322. }
  323. return hasOrder.Order;
  324. }
  325. private int GetConfiguredOrder(IMetadataProvider provider, MetadataOptions options)
  326. {
  327. // See if there's a user-defined order
  328. if (provider is ILocalMetadataProvider)
  329. {
  330. var index = Array.IndexOf(options.LocalMetadataReaderOrder, provider.Name);
  331. if (index != -1)
  332. {
  333. return index;
  334. }
  335. }
  336. // See if there's a user-defined order
  337. if (provider is IRemoteMetadataProvider)
  338. {
  339. var index = Array.IndexOf(options.MetadataFetcherOrder, provider.Name);
  340. if (index != -1)
  341. {
  342. return index;
  343. }
  344. }
  345. // Not configured. Just return some high number to put it at the end.
  346. return 100;
  347. }
  348. private int GetDefaultOrder(IMetadataProvider provider)
  349. {
  350. var hasOrder = provider as IHasOrder;
  351. if (hasOrder != null)
  352. {
  353. return hasOrder.Order;
  354. }
  355. return 0;
  356. }
  357. public IEnumerable<MetadataPluginSummary> GetAllMetadataPlugins()
  358. {
  359. var list = new List<MetadataPluginSummary>
  360. {
  361. GetPluginSummary<Game>(),
  362. GetPluginSummary<GameSystem>(),
  363. GetPluginSummary<Movie>(),
  364. GetPluginSummary<Trailer>(),
  365. GetPluginSummary<BoxSet>(),
  366. GetPluginSummary<Book>(),
  367. GetPluginSummary<Series>(),
  368. GetPluginSummary<Season>(),
  369. GetPluginSummary<Episode>(),
  370. GetPluginSummary<Person>(),
  371. GetPluginSummary<MusicAlbum>(),
  372. GetPluginSummary<MusicArtist>(),
  373. GetPluginSummary<Audio>(),
  374. GetPluginSummary<Genre>(),
  375. GetPluginSummary<Studio>(),
  376. GetPluginSummary<GameGenre>(),
  377. GetPluginSummary<MusicGenre>(),
  378. GetPluginSummary<AdultVideo>(),
  379. GetPluginSummary<MusicVideo>(),
  380. GetPluginSummary<Video>(),
  381. GetPluginSummary<LiveTvChannel>(),
  382. GetPluginSummary<LiveTvProgram>(),
  383. GetPluginSummary<LiveTvVideoRecording>(),
  384. GetPluginSummary<LiveTvAudioRecording>()
  385. };
  386. return list;
  387. }
  388. private MetadataPluginSummary GetPluginSummary<T>()
  389. where T : BaseItem, new()
  390. {
  391. // Give it a dummy path just so that it looks like a file system item
  392. var dummy = new T()
  393. {
  394. Path = "C:\\",
  395. // Dummy this up to fool the local trailer check
  396. Parent = new Folder()
  397. };
  398. var options = GetMetadataOptions(dummy);
  399. var summary = new MetadataPluginSummary
  400. {
  401. ItemType = typeof(T).Name
  402. };
  403. var imageProviders = GetImageProviders(dummy, options, true).ToList();
  404. AddMetadataPlugins(summary.Plugins, dummy, options);
  405. AddImagePlugins(summary.Plugins, dummy, imageProviders);
  406. var supportedImageTypes = imageProviders.OfType<IRemoteImageProvider>()
  407. .SelectMany(i => i.GetSupportedImages(dummy))
  408. .ToList();
  409. supportedImageTypes.AddRange(imageProviders.OfType<IDynamicImageProvider>()
  410. .SelectMany(i => i.GetSupportedImages(dummy)));
  411. summary.SupportedImageTypes = supportedImageTypes.Distinct().ToList();
  412. return summary;
  413. }
  414. private void AddMetadataPlugins<T>(List<MetadataPlugin> list, T item, MetadataOptions options)
  415. where T : IHasMetadata
  416. {
  417. var providers = GetMetadataProvidersInternal<T>(item, options, true).ToList();
  418. // Locals
  419. list.AddRange(providers.Where(i => (i is ILocalMetadataProvider)).Select(i => new MetadataPlugin
  420. {
  421. Name = i.Name,
  422. Type = MetadataPluginType.LocalMetadataProvider
  423. }));
  424. if (ConfigurationManager.Configuration.EnableInternetProviders)
  425. {
  426. // Fetchers
  427. list.AddRange(providers.Where(i => (i is IRemoteMetadataProvider)).Select(i => new MetadataPlugin
  428. {
  429. Name = i.Name,
  430. Type = MetadataPluginType.MetadataFetcher
  431. }));
  432. }
  433. if (item.IsSaveLocalMetadataEnabled())
  434. {
  435. // Savers
  436. list.AddRange(_savers.Where(i => IsSaverEnabledForItem(i, item, ItemUpdateType.MetadataEdit, true)).OrderBy(i => i.Name).Select(i => new MetadataPlugin
  437. {
  438. Name = i.Name,
  439. Type = MetadataPluginType.MetadataSaver
  440. }));
  441. }
  442. }
  443. private void AddImagePlugins<T>(List<MetadataPlugin> list, T item, List<IImageProvider> imageProviders)
  444. where T : IHasImages
  445. {
  446. // Locals
  447. list.AddRange(imageProviders.Where(i => (i is ILocalImageProvider)).Select(i => new MetadataPlugin
  448. {
  449. Name = i.Name,
  450. Type = MetadataPluginType.LocalImageProvider
  451. }));
  452. if (ConfigurationManager.Configuration.EnableInternetProviders)
  453. {
  454. // Fetchers
  455. list.AddRange(imageProviders.Where(i => i is IRemoteImageProvider).Select(i => new MetadataPlugin
  456. {
  457. Name = i.Name,
  458. Type = MetadataPluginType.ImageFetcher
  459. }));
  460. }
  461. // Fetchers
  462. list.AddRange(imageProviders.Where(i => i is IDynamicImageProvider).Select(i => new MetadataPlugin
  463. {
  464. Name = i.Name,
  465. Type = MetadataPluginType.ImageFetcher
  466. }));
  467. }
  468. public MetadataOptions GetMetadataOptions(IHasImages item)
  469. {
  470. var type = item.GetType().Name;
  471. return ConfigurationManager.Configuration.MetadataOptions
  472. .FirstOrDefault(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase)) ??
  473. new MetadataOptions();
  474. }
  475. private readonly ConcurrentDictionary<string, SemaphoreSlim> _fileLocks = new ConcurrentDictionary<string, SemaphoreSlim>();
  476. /// <summary>
  477. /// Saves the metadata.
  478. /// </summary>
  479. /// <param name="item">The item.</param>
  480. /// <param name="updateType">Type of the update.</param>
  481. /// <returns>Task.</returns>
  482. public async Task SaveMetadata(IHasMetadata item, ItemUpdateType updateType)
  483. {
  484. foreach (var saver in _savers.Where(i => IsSaverEnabledForItem(i, item, updateType, false)))
  485. {
  486. _logger.Debug("Saving {0} to {1}.", item.Path ?? item.Name, saver.Name);
  487. var fileSaver = saver as IMetadataFileSaver;
  488. if (fileSaver != null)
  489. {
  490. string path = null;
  491. try
  492. {
  493. path = fileSaver.GetSavePath(item);
  494. }
  495. catch (Exception ex)
  496. {
  497. _logger.ErrorException("Error in {0} GetSavePath", ex, saver.Name);
  498. continue;
  499. }
  500. var semaphore = _fileLocks.GetOrAdd(path, key => new SemaphoreSlim(1, 1));
  501. await semaphore.WaitAsync().ConfigureAwait(false);
  502. try
  503. {
  504. _libraryMonitor.ReportFileSystemChangeBeginning(path);
  505. saver.Save(item, CancellationToken.None);
  506. }
  507. catch (Exception ex)
  508. {
  509. _logger.ErrorException("Error in metadata saver", ex);
  510. }
  511. finally
  512. {
  513. _libraryMonitor.ReportFileSystemChangeComplete(path, false);
  514. semaphore.Release();
  515. }
  516. }
  517. else
  518. {
  519. try
  520. {
  521. saver.Save(item, CancellationToken.None);
  522. }
  523. catch (Exception ex)
  524. {
  525. _logger.ErrorException("Error in metadata saver", ex);
  526. }
  527. }
  528. }
  529. }
  530. private bool IsSaverEnabledForItem(IMetadataSaver saver, IHasMetadata item, ItemUpdateType updateType, bool includeDisabled)
  531. {
  532. var options = GetMetadataOptions(item);
  533. try
  534. {
  535. var isEnabledFor = saver.IsEnabledFor(item, updateType);
  536. if (!includeDisabled)
  537. {
  538. if (options.DisabledMetadataSavers.Contains(saver.Name, StringComparer.OrdinalIgnoreCase))
  539. {
  540. return false;
  541. }
  542. if (!item.IsSaveLocalMetadataEnabled())
  543. {
  544. if (updateType >= ItemUpdateType.MetadataEdit)
  545. {
  546. var fileSaver = saver as IMetadataFileSaver;
  547. // Manual edit occurred
  548. // Even if save local is off, save locally anyway if the metadata file already exists
  549. if (fileSaver == null || !isEnabledFor || !File.Exists(fileSaver.GetSavePath(item)))
  550. {
  551. return false;
  552. }
  553. }
  554. else
  555. {
  556. // Manual edit did not occur
  557. // Since local metadata saving is disabled, consider it disabled
  558. return false;
  559. }
  560. }
  561. }
  562. return isEnabledFor;
  563. }
  564. catch (Exception ex)
  565. {
  566. _logger.ErrorException("Error in {0}.IsEnabledFor", ex, saver.Name);
  567. return false;
  568. }
  569. }
  570. public async Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo,
  571. CancellationToken cancellationToken)
  572. where TItemType : BaseItem, new()
  573. where TLookupType : ItemLookupInfo
  574. {
  575. // Give it a dummy path just so that it looks like a file system item
  576. var dummy = new TItemType
  577. {
  578. Path = "C:\\",
  579. // Dummy this up to fool the local trailer check
  580. Parent = new Folder()
  581. };
  582. var options = GetMetadataOptions(dummy);
  583. var providers = GetMetadataProvidersInternal<TItemType>(dummy, options, searchInfo.IncludeDisabledProviders)
  584. .OfType<IRemoteSearchProvider<TLookupType>>();
  585. if (!string.IsNullOrEmpty(searchInfo.SearchProviderName))
  586. {
  587. providers = providers.Where(i => string.Equals(i.Name, searchInfo.SearchProviderName, StringComparison.OrdinalIgnoreCase));
  588. }
  589. if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataLanguage))
  590. {
  591. searchInfo.SearchInfo.MetadataLanguage = ConfigurationManager.Configuration.PreferredMetadataLanguage;
  592. }
  593. if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataCountryCode))
  594. {
  595. searchInfo.SearchInfo.MetadataCountryCode = ConfigurationManager.Configuration.MetadataCountryCode;
  596. }
  597. foreach (var provider in providers)
  598. {
  599. var results = await GetSearchResults(provider, searchInfo.SearchInfo, cancellationToken).ConfigureAwait(false);
  600. var list = results.ToList();
  601. if (list.Count > 0)
  602. {
  603. return list.Take(10);
  604. }
  605. }
  606. // Nothing found
  607. return new List<RemoteSearchResult>();
  608. }
  609. private async Task<IEnumerable<RemoteSearchResult>> GetSearchResults<TLookupType>(IRemoteSearchProvider<TLookupType> provider, TLookupType searchInfo,
  610. CancellationToken cancellationToken)
  611. where TLookupType : ItemLookupInfo
  612. {
  613. var results = await provider.GetSearchResults(searchInfo, cancellationToken).ConfigureAwait(false);
  614. var list = results.ToList();
  615. foreach (var item in list)
  616. {
  617. item.SearchProviderName = provider.Name;
  618. }
  619. return list;
  620. }
  621. public Task<HttpResponseInfo> GetSearchImage(string providerName, string url, CancellationToken cancellationToken)
  622. {
  623. var provider = _metadataProviders.OfType<IRemoteSearchProvider>().FirstOrDefault(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase));
  624. if (provider == null)
  625. {
  626. throw new ArgumentException("Search provider not found.");
  627. }
  628. return provider.GetImageResponse(url, cancellationToken);
  629. }
  630. public IEnumerable<IExternalId> GetExternalIds(IHasProviderIds item)
  631. {
  632. return _externalIds.Where(i =>
  633. {
  634. try
  635. {
  636. return i.Supports(item);
  637. }
  638. catch (Exception ex)
  639. {
  640. _logger.ErrorException("Error in {0}.Suports", ex, i.GetType().Name);
  641. return false;
  642. }
  643. });
  644. }
  645. public IEnumerable<ExternalUrl> GetExternalUrls(IHasProviderIds item)
  646. {
  647. return GetExternalIds(item)
  648. .Select(i =>
  649. {
  650. if (string.IsNullOrEmpty(i.UrlFormatString))
  651. {
  652. return null;
  653. }
  654. var value = item.GetProviderId(i.Key);
  655. if (string.IsNullOrEmpty(value))
  656. {
  657. return null;
  658. }
  659. return new ExternalUrl
  660. {
  661. Name = i.Name,
  662. Url = string.Format(i.UrlFormatString, value)
  663. };
  664. }).Where(i => i != null);
  665. }
  666. public IEnumerable<ExternalIdInfo> GetExternalIdInfos(IHasProviderIds item)
  667. {
  668. return GetExternalIds(item)
  669. .Select(i => new ExternalIdInfo
  670. {
  671. Name = i.Name,
  672. Key = i.Key,
  673. UrlFormatString = i.UrlFormatString
  674. });
  675. }
  676. }
  677. }