MetadataService.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Common.IO;
  3. using MediaBrowser.Controller.Configuration;
  4. using MediaBrowser.Controller.Entities;
  5. using MediaBrowser.Controller.Library;
  6. using MediaBrowser.Controller.Providers;
  7. using MediaBrowser.Model.Entities;
  8. using MediaBrowser.Model.Logging;
  9. using System;
  10. using System.Collections.Generic;
  11. using System.Linq;
  12. using System.Threading;
  13. using System.Threading.Tasks;
  14. using CommonIO;
  15. using MediaBrowser.Controller.Entities.Audio;
  16. using MediaBrowser.Controller.Entities.Movies;
  17. namespace MediaBrowser.Providers.Manager
  18. {
  19. public abstract class MetadataService<TItemType, TIdType> : IMetadataService
  20. where TItemType : IHasMetadata, IHasLookupInfo<TIdType>, new()
  21. where TIdType : ItemLookupInfo, new()
  22. {
  23. protected readonly IServerConfigurationManager ServerConfigurationManager;
  24. protected readonly ILogger Logger;
  25. protected readonly IProviderManager ProviderManager;
  26. protected readonly IProviderRepository ProviderRepo;
  27. protected readonly IFileSystem FileSystem;
  28. protected readonly IUserDataManager UserDataManager;
  29. protected readonly ILibraryManager LibraryManager;
  30. protected MetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, IProviderRepository providerRepo, IFileSystem fileSystem, IUserDataManager userDataManager, ILibraryManager libraryManager)
  31. {
  32. ServerConfigurationManager = serverConfigurationManager;
  33. Logger = logger;
  34. ProviderManager = providerManager;
  35. ProviderRepo = providerRepo;
  36. FileSystem = fileSystem;
  37. UserDataManager = userDataManager;
  38. LibraryManager = libraryManager;
  39. }
  40. /// <summary>
  41. /// Saves the provider result.
  42. /// </summary>
  43. /// <param name="item">The item.</param>
  44. /// <param name="result">The result.</param>
  45. /// <param name="directoryService">The directory service.</param>
  46. /// <returns>Task.</returns>
  47. protected Task SaveProviderResult(TItemType item, MetadataStatus result, IDirectoryService directoryService)
  48. {
  49. result.ItemId = item.Id;
  50. //var locationType = item.LocationType;
  51. //if (locationType == LocationType.FileSystem || locationType == LocationType.Offline)
  52. //{
  53. // if (!string.IsNullOrWhiteSpace(item.Path))
  54. // {
  55. // var file = directoryService.GetFile(item.Path);
  56. // if ((file.Attributes & FileAttributes.Directory) != FileAttributes.Directory && file.Exists)
  57. // {
  58. // result.ItemDateModified = FileSystem.GetLastWriteTimeUtc(file);
  59. // }
  60. // }
  61. //}
  62. result.ItemDateModified = item.DateModified;
  63. return ProviderRepo.SaveMetadataStatus(result, CancellationToken.None);
  64. }
  65. /// <summary>
  66. /// Gets the last result.
  67. /// </summary>
  68. /// <param name="item">The item.</param>
  69. /// <returns>ProviderResult.</returns>
  70. protected MetadataStatus GetLastResult(IHasMetadata item)
  71. {
  72. if (GetLastRefreshDate(item) == default(DateTime))
  73. {
  74. return new MetadataStatus { ItemId = item.Id };
  75. }
  76. return ProviderRepo.GetMetadataStatus(item.Id) ?? new MetadataStatus { ItemId = item.Id };
  77. }
  78. public async Task<ItemUpdateType> RefreshMetadata(IHasMetadata item, MetadataRefreshOptions refreshOptions, CancellationToken cancellationToken)
  79. {
  80. var itemOfType = (TItemType)item;
  81. var config = ProviderManager.GetMetadataOptions(item);
  82. var updateType = ItemUpdateType.None;
  83. var refreshResult = GetLastResult(item);
  84. var itemImageProvider = new ItemImageProvider(Logger, ProviderManager, ServerConfigurationManager, FileSystem);
  85. var localImagesFailed = false;
  86. var allImageProviders = ((ProviderManager)ProviderManager).GetImageProviders(item, refreshOptions).ToList();
  87. // Start by validating images
  88. try
  89. {
  90. // Always validate images and check for new locally stored ones.
  91. if (itemImageProvider.ValidateImages(item, allImageProviders.OfType<ILocalImageProvider>(), refreshOptions.DirectoryService))
  92. {
  93. updateType = updateType | ItemUpdateType.ImageUpdate;
  94. }
  95. }
  96. catch (Exception ex)
  97. {
  98. localImagesFailed = true;
  99. Logger.ErrorException("Error validating images for {0}", ex, item.Path ?? item.Name ?? "Unknown name");
  100. }
  101. var metadataResult = new MetadataResult<TItemType>
  102. {
  103. Item = itemOfType
  104. };
  105. // Next run metadata providers
  106. if (refreshOptions.MetadataRefreshMode != MetadataRefreshMode.None)
  107. {
  108. var providers = GetProviders(item, refreshResult, refreshOptions)
  109. .ToList();
  110. if (providers.Count > 0 || !refreshResult.DateLastMetadataRefresh.HasValue)
  111. {
  112. if (item.BeforeMetadataRefresh())
  113. {
  114. updateType = updateType | ItemUpdateType.MetadataImport;
  115. }
  116. }
  117. if (providers.Count > 0)
  118. {
  119. var id = itemOfType.GetLookupInfo();
  120. //await FindIdentities(id, cancellationToken).ConfigureAwait(false);
  121. var result = await RefreshWithProviders(metadataResult, id, refreshOptions, providers, itemImageProvider, cancellationToken).ConfigureAwait(false);
  122. updateType = updateType | result.UpdateType;
  123. if (result.Failures == 0)
  124. {
  125. refreshResult.SetDateLastMetadataRefresh(DateTime.UtcNow);
  126. }
  127. else
  128. {
  129. refreshResult.SetDateLastMetadataRefresh(null);
  130. }
  131. }
  132. }
  133. // Next run remote image providers, but only if local image providers didn't throw an exception
  134. if (!localImagesFailed && refreshOptions.ImageRefreshMode != ImageRefreshMode.ValidationOnly)
  135. {
  136. var providers = GetNonLocalImageProviders(item, allImageProviders, refreshResult, refreshOptions).ToList();
  137. if (providers.Count > 0)
  138. {
  139. var result = await itemImageProvider.RefreshImages(itemOfType, providers, refreshOptions, config, cancellationToken).ConfigureAwait(false);
  140. updateType = updateType | result.UpdateType;
  141. if (result.Failures == 0)
  142. {
  143. refreshResult.SetDateLastImagesRefresh(DateTime.UtcNow);
  144. }
  145. else
  146. {
  147. refreshResult.SetDateLastImagesRefresh(null);
  148. }
  149. }
  150. }
  151. var isFirstRefresh = GetLastRefreshDate(item) == default(DateTime);
  152. var beforeSaveResult = await BeforeSave(itemOfType, isFirstRefresh || refreshOptions.ReplaceAllMetadata || refreshOptions.MetadataRefreshMode == MetadataRefreshMode.FullRefresh, updateType).ConfigureAwait(false);
  153. updateType = updateType | beforeSaveResult;
  154. // Save if changes were made, or it's never been saved before
  155. if (refreshOptions.ForceSave || updateType > ItemUpdateType.None || isFirstRefresh || refreshOptions.ReplaceAllMetadata)
  156. {
  157. // If any of these properties are set then make sure the updateType is not None, just to force everything to save
  158. if (refreshOptions.ForceSave || refreshOptions.ReplaceAllMetadata)
  159. {
  160. updateType = updateType | ItemUpdateType.MetadataDownload;
  161. }
  162. if (refreshOptions.MetadataRefreshMode >= MetadataRefreshMode.Default && refreshOptions.ImageRefreshMode >= ImageRefreshMode.Default)
  163. {
  164. item.DateLastRefreshed = DateTime.UtcNow;
  165. }
  166. // Save to database
  167. await SaveItem(metadataResult, updateType, cancellationToken).ConfigureAwait(false);
  168. }
  169. if (updateType > ItemUpdateType.None || refreshResult.IsDirty)
  170. {
  171. await SaveProviderResult(itemOfType, refreshResult, refreshOptions.DirectoryService).ConfigureAwait(false);
  172. }
  173. await AfterMetadataRefresh(itemOfType, refreshOptions, cancellationToken).ConfigureAwait(false);
  174. return updateType;
  175. }
  176. private async Task FindIdentities(TIdType id, CancellationToken cancellationToken)
  177. {
  178. try
  179. {
  180. await ItemIdentifier<TIdType>.FindIdentities(id, ProviderManager, cancellationToken).ConfigureAwait(false);
  181. }
  182. catch (Exception ex)
  183. {
  184. Logger.ErrorException("Error in FindIdentities", ex);
  185. }
  186. }
  187. private DateTime GetLastRefreshDate(IHasMetadata item)
  188. {
  189. if (EnableDateLastRefreshed(item))
  190. {
  191. return item.DateLastRefreshed;
  192. }
  193. return item.DateLastSaved;
  194. }
  195. private bool EnableDateLastRefreshed(IHasMetadata item)
  196. {
  197. if (ServerConfigurationManager.Configuration.EnableDateLastRefresh)
  198. {
  199. return true;
  200. }
  201. if (item.DateLastRefreshed != default(DateTime))
  202. {
  203. return true;
  204. }
  205. if (item is BoxSet || (item is IItemByName && !(item is MusicArtist)))
  206. {
  207. return true;
  208. }
  209. return false;
  210. }
  211. protected async Task SaveItem(MetadataResult<TItemType> result, ItemUpdateType reason, CancellationToken cancellationToken)
  212. {
  213. if (result.Item.SupportsPeople && result.People != null)
  214. {
  215. await LibraryManager.UpdatePeople(result.Item as BaseItem, result.People.ToList());
  216. await SavePeopleMetadata(result.People, cancellationToken).ConfigureAwait(false);
  217. }
  218. await result.Item.UpdateToRepository(reason, cancellationToken).ConfigureAwait(false);
  219. }
  220. private async Task SavePeopleMetadata(List<PersonInfo> people, CancellationToken cancellationToken)
  221. {
  222. foreach (var person in people)
  223. {
  224. cancellationToken.ThrowIfCancellationRequested();
  225. if (person.ProviderIds.Any() || !string.IsNullOrWhiteSpace(person.ImageUrl))
  226. {
  227. var updateType = ItemUpdateType.MetadataDownload;
  228. var saveEntity = false;
  229. var personEntity = LibraryManager.GetPerson(person.Name);
  230. foreach (var id in person.ProviderIds)
  231. {
  232. if (!string.Equals(personEntity.GetProviderId(id.Key), id.Value, StringComparison.OrdinalIgnoreCase))
  233. {
  234. personEntity.SetProviderId(id.Key, id.Value);
  235. saveEntity = true;
  236. }
  237. }
  238. if (!string.IsNullOrWhiteSpace(person.ImageUrl) && !personEntity.HasImage(ImageType.Primary))
  239. {
  240. personEntity.SetImage(new ItemImageInfo
  241. {
  242. Path = person.ImageUrl,
  243. Type = ImageType.Primary,
  244. IsPlaceholder = true
  245. }, 0);
  246. saveEntity = true;
  247. updateType = updateType | ItemUpdateType.ImageUpdate;
  248. }
  249. if (saveEntity)
  250. {
  251. await personEntity.UpdateToRepository(updateType, cancellationToken).ConfigureAwait(false);
  252. }
  253. }
  254. }
  255. }
  256. private readonly Task _cachedTask = Task.FromResult(true);
  257. protected virtual Task AfterMetadataRefresh(TItemType item, MetadataRefreshOptions refreshOptions, CancellationToken cancellationToken)
  258. {
  259. item.AfterMetadataRefresh();
  260. return _cachedTask;
  261. }
  262. private readonly Task<ItemUpdateType> _cachedResult = Task.FromResult(ItemUpdateType.None);
  263. /// <summary>
  264. /// Befores the save.
  265. /// </summary>
  266. /// <param name="item">The item.</param>
  267. /// <param name="isFullRefresh">if set to <c>true</c> [is full refresh].</param>
  268. /// <param name="currentUpdateType">Type of the current update.</param>
  269. /// <returns>ItemUpdateType.</returns>
  270. protected virtual Task<ItemUpdateType> BeforeSave(TItemType item, bool isFullRefresh, ItemUpdateType currentUpdateType)
  271. {
  272. return _cachedResult;
  273. }
  274. /// <summary>
  275. /// Gets the providers.
  276. /// </summary>
  277. /// <param name="item">The item.</param>
  278. /// <param name="status">The status.</param>
  279. /// <param name="options">The options.</param>
  280. /// <returns>IEnumerable{`0}.</returns>
  281. protected IEnumerable<IMetadataProvider> GetProviders(IHasMetadata item, MetadataStatus status, MetadataRefreshOptions options)
  282. {
  283. // Get providers to refresh
  284. var providers = ((ProviderManager)ProviderManager).GetMetadataProviders<TItemType>(item).ToList();
  285. // Run all if either of these flags are true
  286. var runAllProviders = options.ReplaceAllMetadata || options.MetadataRefreshMode == MetadataRefreshMode.FullRefresh || !status.DateLastMetadataRefresh.HasValue;
  287. if (!runAllProviders)
  288. {
  289. // Avoid implicitly captured closure
  290. var currentItem = item;
  291. var providersWithChanges = providers
  292. .Where(i =>
  293. {
  294. var hasChangeMonitor = i as IHasChangeMonitor;
  295. if (hasChangeMonitor != null)
  296. {
  297. return HasChanged(item, hasChangeMonitor, currentItem.DateLastSaved, options.DirectoryService);
  298. }
  299. var hasFileChangeMonitor = i as IHasItemChangeMonitor;
  300. if (hasFileChangeMonitor != null)
  301. {
  302. return HasChanged(item, hasFileChangeMonitor, status, options.DirectoryService);
  303. }
  304. return false;
  305. })
  306. .ToList();
  307. if (providersWithChanges.Count == 0)
  308. {
  309. providers = new List<IMetadataProvider<TItemType>>();
  310. }
  311. else
  312. {
  313. providers = providers.Where(i =>
  314. {
  315. // If any provider reports a change, always run local ones as well
  316. if (i is ILocalMetadataProvider)
  317. {
  318. return true;
  319. }
  320. var anyRemoteProvidersChanged = providersWithChanges.OfType<IRemoteMetadataProvider>()
  321. .Any();
  322. // If any remote providers changed, run them all so that priorities can be honored
  323. if (i is IRemoteMetadataProvider)
  324. {
  325. return anyRemoteProvidersChanged;
  326. }
  327. // Run custom providers if they report a change or any remote providers change
  328. return anyRemoteProvidersChanged || providersWithChanges.Contains(i);
  329. }).ToList();
  330. }
  331. }
  332. return providers;
  333. }
  334. protected virtual IEnumerable<IImageProvider> GetNonLocalImageProviders(IHasMetadata item, IEnumerable<IImageProvider> allImageProviders, MetadataStatus status, ImageRefreshOptions options)
  335. {
  336. // Get providers to refresh
  337. var providers = allImageProviders.Where(i => !(i is ILocalImageProvider)).ToList();
  338. // Run all if either of these flags are true
  339. var runAllProviders = options.ImageRefreshMode == ImageRefreshMode.FullRefresh || !status.DateLastImagesRefresh.HasValue;
  340. if (!runAllProviders)
  341. {
  342. providers = providers
  343. .Where(i =>
  344. {
  345. var hasChangeMonitor = i as IHasChangeMonitor;
  346. if (hasChangeMonitor != null)
  347. {
  348. return HasChanged(item, hasChangeMonitor, status.DateLastImagesRefresh.Value, options.DirectoryService);
  349. }
  350. var hasFileChangeMonitor = i as IHasItemChangeMonitor;
  351. if (hasFileChangeMonitor != null)
  352. {
  353. return HasChanged(item, hasFileChangeMonitor, status, options.DirectoryService);
  354. }
  355. return false;
  356. })
  357. .ToList();
  358. }
  359. return providers;
  360. }
  361. public bool CanRefresh(IHasMetadata item)
  362. {
  363. return item is TItemType;
  364. }
  365. protected virtual async Task<RefreshResult> RefreshWithProviders(MetadataResult<TItemType> metadata,
  366. TIdType id,
  367. MetadataRefreshOptions options,
  368. List<IMetadataProvider> providers,
  369. ItemImageProvider imageService,
  370. CancellationToken cancellationToken)
  371. {
  372. var refreshResult = new RefreshResult
  373. {
  374. UpdateType = ItemUpdateType.None,
  375. Providers = providers.Select(i => i.GetType().FullName.GetMD5()).ToList()
  376. };
  377. var item = metadata.Item;
  378. var customProviders = providers.OfType<ICustomMetadataProvider<TItemType>>().ToList();
  379. var logName = item.LocationType == LocationType.Remote ? item.Name ?? item.Path : item.Path ?? item.Name;
  380. foreach (var provider in customProviders.Where(i => i is IPreRefreshProvider))
  381. {
  382. await RunCustomProvider(provider, item, logName, options, refreshResult, cancellationToken).ConfigureAwait(false);
  383. }
  384. var temp = new MetadataResult<TItemType>
  385. {
  386. Item = CreateNew()
  387. };
  388. temp.Item.Path = item.Path;
  389. var userDataList = new List<UserItemData>();
  390. // If replacing all metadata, run internet providers first
  391. if (options.ReplaceAllMetadata)
  392. {
  393. var remoteResult = await ExecuteRemoteProviders(temp, logName, id, providers.OfType<IRemoteMetadataProvider<TItemType, TIdType>>(), cancellationToken)
  394. .ConfigureAwait(false);
  395. refreshResult.UpdateType = refreshResult.UpdateType | remoteResult.UpdateType;
  396. refreshResult.ErrorMessage = remoteResult.ErrorMessage;
  397. refreshResult.Failures += remoteResult.Failures;
  398. }
  399. var hasLocalMetadata = false;
  400. foreach (var provider in providers.OfType<ILocalMetadataProvider<TItemType>>().ToList())
  401. {
  402. var providerName = provider.GetType().Name;
  403. Logger.Debug("Running {0} for {1}", providerName, logName);
  404. var itemInfo = new ItemInfo(item);
  405. try
  406. {
  407. var localItem = await provider.GetMetadata(itemInfo, options.DirectoryService, cancellationToken).ConfigureAwait(false);
  408. if (localItem.HasMetadata)
  409. {
  410. if (imageService.MergeImages(item, localItem.Images))
  411. {
  412. refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.ImageUpdate;
  413. }
  414. if (localItem.UserDataList != null)
  415. {
  416. userDataList.AddRange(localItem.UserDataList);
  417. }
  418. MergeData(localItem, temp, new List<MetadataFields>(), !options.ReplaceAllMetadata, true);
  419. refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.MetadataImport;
  420. // Only one local provider allowed per item
  421. if (IsFullLocalMetadata(localItem.Item))
  422. {
  423. hasLocalMetadata = true;
  424. }
  425. break;
  426. }
  427. Logger.Debug("{0} returned no metadata for {1}", providerName, logName);
  428. }
  429. catch (OperationCanceledException)
  430. {
  431. throw;
  432. }
  433. catch (Exception ex)
  434. {
  435. refreshResult.Failures++;
  436. Logger.ErrorException("Error in {0}", ex, provider.Name);
  437. // If a local provider fails, consider that a failure
  438. refreshResult.ErrorMessage = ex.Message;
  439. if (options.MetadataRefreshMode != MetadataRefreshMode.FullRefresh)
  440. {
  441. // If the local provider fails don't continue with remote providers because the user's saved metadata could be lost
  442. return refreshResult;
  443. }
  444. }
  445. }
  446. // Local metadata is king - if any is found don't run remote providers
  447. if (!options.ReplaceAllMetadata && (!hasLocalMetadata || options.MetadataRefreshMode == MetadataRefreshMode.FullRefresh))
  448. {
  449. var remoteResult = await ExecuteRemoteProviders(temp, logName, id, providers.OfType<IRemoteMetadataProvider<TItemType, TIdType>>(), cancellationToken)
  450. .ConfigureAwait(false);
  451. refreshResult.UpdateType = refreshResult.UpdateType | remoteResult.UpdateType;
  452. refreshResult.ErrorMessage = remoteResult.ErrorMessage;
  453. refreshResult.Failures += remoteResult.Failures;
  454. }
  455. if (providers.Any(i => !(i is ICustomMetadataProvider)))
  456. {
  457. if (refreshResult.UpdateType > ItemUpdateType.None)
  458. {
  459. // If no local metadata, take data from item itself
  460. if (!hasLocalMetadata)
  461. {
  462. // TODO: If the new metadata from above has some blank data, this can cause old data to get filled into those empty fields
  463. MergeData(metadata, temp, new List<MetadataFields>(), false, true);
  464. }
  465. MergeData(temp, metadata, item.LockedFields, true, true);
  466. }
  467. }
  468. //var isUnidentified = failedProviderCount > 0 && successfulProviderCount == 0;
  469. foreach (var provider in customProviders.Where(i => !(i is IPreRefreshProvider)))
  470. {
  471. await RunCustomProvider(provider, item, logName, options, refreshResult, cancellationToken).ConfigureAwait(false);
  472. }
  473. await ImportUserData(item, userDataList, cancellationToken).ConfigureAwait(false);
  474. return refreshResult;
  475. }
  476. protected virtual bool IsFullLocalMetadata(TItemType item)
  477. {
  478. if (string.IsNullOrWhiteSpace(item.Name))
  479. {
  480. return false;
  481. }
  482. return true;
  483. }
  484. private async Task ImportUserData(TItemType item, List<UserItemData> userDataList, CancellationToken cancellationToken)
  485. {
  486. var hasUserData = item as IHasUserData;
  487. if (hasUserData != null)
  488. {
  489. foreach (var userData in userDataList)
  490. {
  491. await UserDataManager.SaveUserData(userData.UserId, hasUserData, userData, UserDataSaveReason.Import, cancellationToken)
  492. .ConfigureAwait(false);
  493. }
  494. }
  495. }
  496. private async Task RunCustomProvider(ICustomMetadataProvider<TItemType> provider, TItemType item, string logName, MetadataRefreshOptions options, RefreshResult refreshResult, CancellationToken cancellationToken)
  497. {
  498. Logger.Debug("Running {0} for {1}", provider.GetType().Name, logName);
  499. try
  500. {
  501. refreshResult.UpdateType = refreshResult.UpdateType | await provider.FetchAsync(item, options, cancellationToken).ConfigureAwait(false);
  502. }
  503. catch (OperationCanceledException)
  504. {
  505. throw;
  506. }
  507. catch (Exception ex)
  508. {
  509. refreshResult.ErrorMessage = ex.Message;
  510. Logger.ErrorException("Error in {0}", ex, provider.Name);
  511. }
  512. }
  513. protected virtual TItemType CreateNew()
  514. {
  515. return new TItemType();
  516. }
  517. private async Task<RefreshResult> ExecuteRemoteProviders(MetadataResult<TItemType> temp, string logName, TIdType id, IEnumerable<IRemoteMetadataProvider<TItemType, TIdType>> providers, CancellationToken cancellationToken)
  518. {
  519. var refreshResult = new RefreshResult();
  520. foreach (var provider in providers)
  521. {
  522. var providerName = provider.GetType().Name;
  523. Logger.Debug("Running {0} for {1}", providerName, logName);
  524. if (id != null)
  525. {
  526. MergeNewData(temp.Item, id);
  527. }
  528. try
  529. {
  530. var result = await provider.GetMetadata(id, cancellationToken).ConfigureAwait(false);
  531. if (result.HasMetadata)
  532. {
  533. NormalizeRemoteResult(result.Item);
  534. MergeData(result, temp, new List<MetadataFields>(), false, false);
  535. refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.MetadataDownload;
  536. }
  537. else
  538. {
  539. refreshResult.Failures++;
  540. Logger.Debug("{0} returned no metadata for {1}", providerName, logName);
  541. }
  542. }
  543. catch (OperationCanceledException)
  544. {
  545. throw;
  546. }
  547. catch (Exception ex)
  548. {
  549. refreshResult.Failures++;
  550. refreshResult.ErrorMessage = ex.Message;
  551. Logger.ErrorException("Error in {0}", ex, provider.Name);
  552. }
  553. }
  554. return refreshResult;
  555. }
  556. private void NormalizeRemoteResult(TItemType item)
  557. {
  558. if (!ServerConfigurationManager.Configuration.FindInternetTrailers)
  559. {
  560. var hasTrailers = item as IHasTrailers;
  561. if (hasTrailers != null)
  562. {
  563. hasTrailers.RemoteTrailers.Clear();
  564. }
  565. }
  566. }
  567. private void MergeNewData(TItemType source, TIdType lookupInfo)
  568. {
  569. // Copy new provider id's that may have been obtained
  570. foreach (var providerId in source.ProviderIds)
  571. {
  572. var key = providerId.Key;
  573. // Don't replace existing Id's.
  574. if (!lookupInfo.ProviderIds.ContainsKey(key))
  575. {
  576. lookupInfo.ProviderIds[key] = providerId.Value;
  577. }
  578. }
  579. }
  580. protected abstract void MergeData(MetadataResult<TItemType> source,
  581. MetadataResult<TItemType> target,
  582. List<MetadataFields> lockedFields,
  583. bool replaceData,
  584. bool mergeMetadataSettings);
  585. public virtual int Order
  586. {
  587. get
  588. {
  589. return 0;
  590. }
  591. }
  592. private bool HasChanged(IHasMetadata item, IHasItemChangeMonitor changeMonitor, MetadataStatus status, IDirectoryService directoryService)
  593. {
  594. try
  595. {
  596. var hasChanged = changeMonitor.HasChanged(item, status, directoryService);
  597. //if (hasChanged)
  598. //{
  599. // Logger.Debug("{0} reports change to {1}", changeMonitor.GetType().Name, item.Path ?? item.Name);
  600. //}
  601. return hasChanged;
  602. }
  603. catch (Exception ex)
  604. {
  605. Logger.ErrorException("Error in {0}.HasChanged", ex, changeMonitor.GetType().Name);
  606. return false;
  607. }
  608. }
  609. private bool HasChanged(IHasMetadata item, IHasChangeMonitor changeMonitor, DateTime date, IDirectoryService directoryService)
  610. {
  611. try
  612. {
  613. var hasChanged = changeMonitor.HasChanged(item, directoryService, date);
  614. //if (hasChanged)
  615. //{
  616. // Logger.Debug("{0} reports change to {1} since {2}", changeMonitor.GetType().Name,
  617. // item.Path ?? item.Name, date);
  618. //}
  619. return hasChanged;
  620. }
  621. catch (Exception ex)
  622. {
  623. Logger.ErrorException("Error in {0}.HasChanged", ex, changeMonitor.GetType().Name);
  624. return false;
  625. }
  626. }
  627. }
  628. public class RefreshResult
  629. {
  630. public ItemUpdateType UpdateType { get; set; }
  631. public string ErrorMessage { get; set; }
  632. public List<Guid> Providers { get; set; }
  633. public int Failures { get; set; }
  634. }
  635. }