MetadataService.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Controller.Configuration;
  3. using MediaBrowser.Controller.Entities;
  4. using MediaBrowser.Controller.Library;
  5. using MediaBrowser.Controller.Providers;
  6. using MediaBrowser.Model.Entities;
  7. using MediaBrowser.Model.Logging;
  8. using System;
  9. using System.Collections.Generic;
  10. using System.Linq;
  11. using System.Threading;
  12. using System.Threading.Tasks;
  13. using CommonIO;
  14. using MediaBrowser.Model.Providers;
  15. namespace MediaBrowser.Providers.Manager
  16. {
  17. public abstract class MetadataService<TItemType, TIdType> : IMetadataService
  18. where TItemType : IHasMetadata, IHasLookupInfo<TIdType>, new()
  19. where TIdType : ItemLookupInfo, new()
  20. {
  21. protected readonly IServerConfigurationManager ServerConfigurationManager;
  22. protected readonly ILogger Logger;
  23. protected readonly IProviderManager ProviderManager;
  24. protected readonly IFileSystem FileSystem;
  25. protected readonly IUserDataManager UserDataManager;
  26. protected readonly ILibraryManager LibraryManager;
  27. protected MetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, IFileSystem fileSystem, IUserDataManager userDataManager, ILibraryManager libraryManager)
  28. {
  29. ServerConfigurationManager = serverConfigurationManager;
  30. Logger = logger;
  31. ProviderManager = providerManager;
  32. FileSystem = fileSystem;
  33. UserDataManager = userDataManager;
  34. LibraryManager = libraryManager;
  35. }
  36. public async Task<ItemUpdateType> RefreshMetadata(IHasMetadata item, MetadataRefreshOptions refreshOptions, CancellationToken cancellationToken)
  37. {
  38. var itemOfType = (TItemType)item;
  39. var config = ProviderManager.GetMetadataOptions(item);
  40. var updateType = ItemUpdateType.None;
  41. var itemImageProvider = new ItemImageProvider(Logger, ProviderManager, ServerConfigurationManager, FileSystem);
  42. var localImagesFailed = false;
  43. var allImageProviders = ((ProviderManager)ProviderManager).GetImageProviders(item, refreshOptions).ToList();
  44. // Start by validating images
  45. try
  46. {
  47. // Always validate images and check for new locally stored ones.
  48. if (itemImageProvider.ValidateImages(item, allImageProviders.OfType<ILocalImageProvider>(), refreshOptions.DirectoryService))
  49. {
  50. updateType = updateType | ItemUpdateType.ImageUpdate;
  51. }
  52. }
  53. catch (Exception ex)
  54. {
  55. localImagesFailed = true;
  56. Logger.ErrorException("Error validating images for {0}", ex, item.Path ?? item.Name ?? "Unknown name");
  57. }
  58. var metadataResult = new MetadataResult<TItemType>
  59. {
  60. Item = itemOfType
  61. };
  62. bool hasRefreshedMetadata = true;
  63. bool hasRefreshedImages = true;
  64. var requiresRefresh = false;
  65. // Next run metadata providers
  66. if (refreshOptions.MetadataRefreshMode != MetadataRefreshMode.None)
  67. {
  68. // TODO: If this returns true, should we instead just change metadata refresh mode to Full?
  69. requiresRefresh = item.RequiresRefresh();
  70. var providers = GetProviders(item, refreshOptions, requiresRefresh)
  71. .ToList();
  72. var dateLastRefresh = item.DateLastRefreshed;
  73. if (providers.Count > 0 || dateLastRefresh == default(DateTime))
  74. {
  75. if (item.BeforeMetadataRefresh())
  76. {
  77. updateType = updateType | ItemUpdateType.MetadataImport;
  78. }
  79. }
  80. if (providers.Count > 0)
  81. {
  82. var id = itemOfType.GetLookupInfo();
  83. if (refreshOptions.SearchResult != null)
  84. {
  85. ApplySearchResult(id, refreshOptions.SearchResult);
  86. }
  87. //await FindIdentities(id, cancellationToken).ConfigureAwait(false);
  88. id.IsAutomated = refreshOptions.IsAutomated;
  89. var result = await RefreshWithProviders(metadataResult, id, refreshOptions, providers, itemImageProvider, cancellationToken).ConfigureAwait(false);
  90. updateType = updateType | result.UpdateType;
  91. if (result.Failures == 0)
  92. {
  93. hasRefreshedMetadata = true;
  94. }
  95. else
  96. {
  97. hasRefreshedMetadata = false;
  98. }
  99. }
  100. }
  101. // Next run remote image providers, but only if local image providers didn't throw an exception
  102. if (!localImagesFailed && refreshOptions.ImageRefreshMode != ImageRefreshMode.ValidationOnly)
  103. {
  104. var providers = GetNonLocalImageProviders(item, allImageProviders, refreshOptions).ToList();
  105. if (providers.Count > 0)
  106. {
  107. var result = await itemImageProvider.RefreshImages(itemOfType, providers, refreshOptions, config, cancellationToken).ConfigureAwait(false);
  108. updateType = updateType | result.UpdateType;
  109. if (result.Failures == 0)
  110. {
  111. hasRefreshedImages = true;
  112. }
  113. else
  114. {
  115. hasRefreshedImages = false;
  116. }
  117. }
  118. }
  119. var isFirstRefresh = GetLastRefreshDate(item) == default(DateTime);
  120. var beforeSaveResult = await BeforeSave(itemOfType, isFirstRefresh || refreshOptions.ReplaceAllMetadata || refreshOptions.MetadataRefreshMode == MetadataRefreshMode.FullRefresh || requiresRefresh, updateType).ConfigureAwait(false);
  121. updateType = updateType | beforeSaveResult;
  122. // Save if changes were made, or it's never been saved before
  123. if (refreshOptions.ForceSave || updateType > ItemUpdateType.None || isFirstRefresh || refreshOptions.ReplaceAllMetadata || requiresRefresh)
  124. {
  125. // If any of these properties are set then make sure the updateType is not None, just to force everything to save
  126. if (refreshOptions.ForceSave || refreshOptions.ReplaceAllMetadata)
  127. {
  128. updateType = updateType | ItemUpdateType.MetadataDownload;
  129. }
  130. if (hasRefreshedMetadata && hasRefreshedImages)
  131. {
  132. item.DateLastRefreshed = DateTime.UtcNow;
  133. item.DateModifiedDuringLastRefresh = item.DateModified;
  134. }
  135. else
  136. {
  137. item.DateLastRefreshed = default(DateTime);
  138. item.DateModifiedDuringLastRefresh = null;
  139. }
  140. // Save to database
  141. await SaveItem(metadataResult, updateType, cancellationToken).ConfigureAwait(false);
  142. }
  143. await AfterMetadataRefresh(itemOfType, refreshOptions, cancellationToken).ConfigureAwait(false);
  144. return updateType;
  145. }
  146. private void ApplySearchResult(ItemLookupInfo lookupInfo, RemoteSearchResult result)
  147. {
  148. lookupInfo.ProviderIds = result.ProviderIds;
  149. lookupInfo.Name = result.Name;
  150. lookupInfo.Year = result.ProductionYear;
  151. }
  152. private async Task FindIdentities(TIdType id, CancellationToken cancellationToken)
  153. {
  154. try
  155. {
  156. await ItemIdentifier<TIdType>.FindIdentities(id, ProviderManager, cancellationToken).ConfigureAwait(false);
  157. }
  158. catch (Exception ex)
  159. {
  160. Logger.ErrorException("Error in FindIdentities", ex);
  161. }
  162. }
  163. private DateTime GetLastRefreshDate(IHasMetadata item)
  164. {
  165. return item.DateLastRefreshed;
  166. }
  167. protected async Task SaveItem(MetadataResult<TItemType> result, ItemUpdateType reason, CancellationToken cancellationToken)
  168. {
  169. if (result.Item.SupportsPeople && result.People != null)
  170. {
  171. await LibraryManager.UpdatePeople(result.Item as BaseItem, result.People.ToList());
  172. await SavePeopleMetadata(result.People, cancellationToken).ConfigureAwait(false);
  173. }
  174. await result.Item.UpdateToRepository(reason, cancellationToken).ConfigureAwait(false);
  175. }
  176. private async Task SavePeopleMetadata(List<PersonInfo> people, CancellationToken cancellationToken)
  177. {
  178. foreach (var person in people)
  179. {
  180. cancellationToken.ThrowIfCancellationRequested();
  181. if (person.ProviderIds.Any() || !string.IsNullOrWhiteSpace(person.ImageUrl))
  182. {
  183. var updateType = ItemUpdateType.MetadataDownload;
  184. var saveEntity = false;
  185. var personEntity = LibraryManager.GetPerson(person.Name);
  186. foreach (var id in person.ProviderIds)
  187. {
  188. if (!string.Equals(personEntity.GetProviderId(id.Key), id.Value, StringComparison.OrdinalIgnoreCase))
  189. {
  190. personEntity.SetProviderId(id.Key, id.Value);
  191. saveEntity = true;
  192. }
  193. }
  194. if (!string.IsNullOrWhiteSpace(person.ImageUrl) && !personEntity.HasImage(ImageType.Primary))
  195. {
  196. await AddPersonImage(personEntity, person.ImageUrl, cancellationToken).ConfigureAwait(false);
  197. saveEntity = true;
  198. updateType = updateType | ItemUpdateType.ImageUpdate;
  199. }
  200. if (saveEntity)
  201. {
  202. await personEntity.UpdateToRepository(updateType, cancellationToken).ConfigureAwait(false);
  203. }
  204. }
  205. }
  206. }
  207. private async Task AddPersonImage(Person personEntity, string imageUrl, CancellationToken cancellationToken)
  208. {
  209. if (ServerConfigurationManager.Configuration.DownloadImagesInAdvance)
  210. {
  211. try
  212. {
  213. await ProviderManager.SaveImage(personEntity, imageUrl, null, ImageType.Primary, null, cancellationToken).ConfigureAwait(false);
  214. return;
  215. }
  216. catch (Exception ex)
  217. {
  218. Logger.ErrorException("Error in AddPersonImage", ex);
  219. }
  220. }
  221. personEntity.SetImage(new ItemImageInfo
  222. {
  223. Path = imageUrl,
  224. Type = ImageType.Primary,
  225. IsPlaceholder = true
  226. }, 0);
  227. }
  228. private readonly Task _cachedTask = Task.FromResult(true);
  229. protected virtual Task AfterMetadataRefresh(TItemType item, MetadataRefreshOptions refreshOptions, CancellationToken cancellationToken)
  230. {
  231. item.AfterMetadataRefresh();
  232. return _cachedTask;
  233. }
  234. /// <summary>
  235. /// Befores the save.
  236. /// </summary>
  237. /// <param name="item">The item.</param>
  238. /// <param name="isFullRefresh">if set to <c>true</c> [is full refresh].</param>
  239. /// <param name="currentUpdateType">Type of the current update.</param>
  240. /// <returns>ItemUpdateType.</returns>
  241. protected virtual async Task<ItemUpdateType> BeforeSave(TItemType item, bool isFullRefresh, ItemUpdateType currentUpdateType)
  242. {
  243. var updateType = ItemUpdateType.None;
  244. updateType |= SaveCumulativeRunTimeTicks(item, isFullRefresh, currentUpdateType);
  245. updateType |= SaveDateLastMediaAdded(item, isFullRefresh, currentUpdateType);
  246. return updateType;
  247. }
  248. private ItemUpdateType SaveCumulativeRunTimeTicks(TItemType item, bool isFullRefresh, ItemUpdateType currentUpdateType)
  249. {
  250. var updateType = ItemUpdateType.None;
  251. if (isFullRefresh || currentUpdateType > ItemUpdateType.None)
  252. {
  253. var folder = item as Folder;
  254. if (folder != null && folder.SupportsCumulativeRunTimeTicks)
  255. {
  256. var items = folder.GetRecursiveChildren(i => !i.IsFolder).ToList();
  257. var ticks = items.Select(i => i.RunTimeTicks ?? 0).Sum();
  258. if (!folder.RunTimeTicks.HasValue || folder.RunTimeTicks.Value != ticks)
  259. {
  260. folder.RunTimeTicks = ticks;
  261. updateType = ItemUpdateType.MetadataEdit;
  262. }
  263. }
  264. }
  265. return updateType;
  266. }
  267. private ItemUpdateType SaveDateLastMediaAdded(TItemType item, bool isFullRefresh, ItemUpdateType currentUpdateType)
  268. {
  269. var updateType = ItemUpdateType.None;
  270. if (isFullRefresh || currentUpdateType > ItemUpdateType.None)
  271. {
  272. var folder = item as Folder;
  273. if (folder != null && folder.SupportsDateLastMediaAdded)
  274. {
  275. var items = folder.GetRecursiveChildren(i => !i.IsFolder).Select(i => i.DateCreated).ToList();
  276. var date = items.Count == 0 ? (DateTime?)null : items.Max();
  277. if ((!folder.DateLastMediaAdded.HasValue && date.HasValue) || folder.DateLastMediaAdded != date)
  278. {
  279. folder.DateLastMediaAdded = date;
  280. updateType = ItemUpdateType.MetadataEdit;
  281. }
  282. }
  283. }
  284. return updateType;
  285. }
  286. /// <summary>
  287. /// Gets the providers.
  288. /// </summary>
  289. /// <returns>IEnumerable{`0}.</returns>
  290. protected IEnumerable<IMetadataProvider> GetProviders(IHasMetadata item, MetadataRefreshOptions options, bool requiresRefresh)
  291. {
  292. // Get providers to refresh
  293. var providers = ((ProviderManager)ProviderManager).GetMetadataProviders<TItemType>(item).ToList();
  294. var dateLastRefresh = item.DateLastRefreshed;
  295. // Run all if either of these flags are true
  296. var runAllProviders = options.ReplaceAllMetadata || options.MetadataRefreshMode == MetadataRefreshMode.FullRefresh || dateLastRefresh == default(DateTime) || requiresRefresh;
  297. if (!runAllProviders)
  298. {
  299. // Avoid implicitly captured closure
  300. var currentItem = item;
  301. var providersWithChanges = providers
  302. .Where(i =>
  303. {
  304. var hasFileChangeMonitor = i as IHasItemChangeMonitor;
  305. if (hasFileChangeMonitor != null)
  306. {
  307. return HasChanged(item, hasFileChangeMonitor, options.DirectoryService);
  308. }
  309. var hasChangeMonitor = i as IHasChangeMonitor;
  310. if (hasChangeMonitor != null)
  311. {
  312. return HasChanged(item, hasChangeMonitor, currentItem.DateLastSaved, options.DirectoryService);
  313. }
  314. return false;
  315. })
  316. .ToList();
  317. if (providersWithChanges.Count == 0)
  318. {
  319. providers = new List<IMetadataProvider<TItemType>>();
  320. }
  321. else
  322. {
  323. providers = providers.Where(i =>
  324. {
  325. // If any provider reports a change, always run local ones as well
  326. if (i is ILocalMetadataProvider)
  327. {
  328. return true;
  329. }
  330. var anyRemoteProvidersChanged = providersWithChanges.OfType<IRemoteMetadataProvider>()
  331. .Any();
  332. // If any remote providers changed, run them all so that priorities can be honored
  333. if (i is IRemoteMetadataProvider)
  334. {
  335. return anyRemoteProvidersChanged;
  336. }
  337. // Run custom providers if they report a change or any remote providers change
  338. return anyRemoteProvidersChanged || providersWithChanges.Contains(i);
  339. }).ToList();
  340. }
  341. }
  342. return providers;
  343. }
  344. protected virtual IEnumerable<IImageProvider> GetNonLocalImageProviders(IHasMetadata item, IEnumerable<IImageProvider> allImageProviders, ImageRefreshOptions options)
  345. {
  346. // Get providers to refresh
  347. var providers = allImageProviders.Where(i => !(i is ILocalImageProvider)).ToList();
  348. var dateLastImageRefresh = item.DateLastRefreshed;
  349. // Run all if either of these flags are true
  350. var runAllProviders = options.ImageRefreshMode == ImageRefreshMode.FullRefresh || dateLastImageRefresh == default(DateTime);
  351. if (!runAllProviders)
  352. {
  353. providers = providers
  354. .Where(i =>
  355. {
  356. var hasFileChangeMonitor = i as IHasItemChangeMonitor;
  357. if (hasFileChangeMonitor != null)
  358. {
  359. return HasChanged(item, hasFileChangeMonitor, options.DirectoryService);
  360. }
  361. return false;
  362. })
  363. .ToList();
  364. }
  365. return providers;
  366. }
  367. public bool CanRefresh(IHasMetadata item)
  368. {
  369. return item is TItemType;
  370. }
  371. protected virtual async Task<RefreshResult> RefreshWithProviders(MetadataResult<TItemType> metadata,
  372. TIdType id,
  373. MetadataRefreshOptions options,
  374. List<IMetadataProvider> providers,
  375. ItemImageProvider imageService,
  376. CancellationToken cancellationToken)
  377. {
  378. var refreshResult = new RefreshResult
  379. {
  380. UpdateType = ItemUpdateType.None,
  381. Providers = providers.Select(i => i.GetType().FullName.GetMD5()).ToList()
  382. };
  383. var item = metadata.Item;
  384. var customProviders = providers.OfType<ICustomMetadataProvider<TItemType>>().ToList();
  385. var logName = item.LocationType == LocationType.Remote ? item.Name ?? item.Path : item.Path ?? item.Name;
  386. foreach (var provider in customProviders.Where(i => i is IPreRefreshProvider))
  387. {
  388. await RunCustomProvider(provider, item, logName, options, refreshResult, cancellationToken).ConfigureAwait(false);
  389. }
  390. var temp = new MetadataResult<TItemType>
  391. {
  392. Item = CreateNew()
  393. };
  394. temp.Item.Path = item.Path;
  395. var userDataList = new List<UserItemData>();
  396. // If replacing all metadata, run internet providers first
  397. if (options.ReplaceAllMetadata)
  398. {
  399. var remoteResult = await ExecuteRemoteProviders(temp, logName, id, providers.OfType<IRemoteMetadataProvider<TItemType, TIdType>>(), cancellationToken)
  400. .ConfigureAwait(false);
  401. refreshResult.UpdateType = refreshResult.UpdateType | remoteResult.UpdateType;
  402. refreshResult.ErrorMessage = remoteResult.ErrorMessage;
  403. refreshResult.Failures += remoteResult.Failures;
  404. }
  405. var hasLocalMetadata = false;
  406. foreach (var provider in providers.OfType<ILocalMetadataProvider<TItemType>>().ToList())
  407. {
  408. var providerName = provider.GetType().Name;
  409. Logger.Debug("Running {0} for {1}", providerName, logName);
  410. var itemInfo = new ItemInfo(item);
  411. try
  412. {
  413. var localItem = await provider.GetMetadata(itemInfo, options.DirectoryService, cancellationToken).ConfigureAwait(false);
  414. if (localItem.HasMetadata)
  415. {
  416. if (imageService.MergeImages(item, localItem.Images))
  417. {
  418. refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.ImageUpdate;
  419. }
  420. if (localItem.UserDataList != null)
  421. {
  422. userDataList.AddRange(localItem.UserDataList);
  423. }
  424. MergeData(localItem, temp, new List<MetadataFields>(), !options.ReplaceAllMetadata, true);
  425. refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.MetadataImport;
  426. // Only one local provider allowed per item
  427. if (IsFullLocalMetadata(localItem.Item))
  428. {
  429. hasLocalMetadata = true;
  430. }
  431. break;
  432. }
  433. Logger.Debug("{0} returned no metadata for {1}", providerName, logName);
  434. }
  435. catch (OperationCanceledException)
  436. {
  437. throw;
  438. }
  439. catch (Exception ex)
  440. {
  441. refreshResult.Failures++;
  442. Logger.ErrorException("Error in {0}", ex, provider.Name);
  443. // If a local provider fails, consider that a failure
  444. refreshResult.ErrorMessage = ex.Message;
  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, IDirectoryService directoryService)
  594. {
  595. try
  596. {
  597. var hasChanged = changeMonitor.HasChanged(item, 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. }