ProviderManager.cs 32 KB

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