ProviderManager.cs 31 KB

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