MetadataService.cs 30 KB

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