MetadataService.cs 30 KB

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