MetadataService.cs 30 KB

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