MetadataService.cs 30 KB

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