| | | 1 | | #nullable disable |
| | | 2 | | |
| | | 3 | | #pragma warning disable CS1591 |
| | | 4 | | |
| | | 5 | | using System; |
| | | 6 | | using System.Collections.Generic; |
| | | 7 | | using System.Linq; |
| | | 8 | | using System.Net.Http; |
| | | 9 | | using System.Threading; |
| | | 10 | | using System.Threading.Tasks; |
| | | 11 | | using Jellyfin.Extensions; |
| | | 12 | | using MediaBrowser.Controller.Configuration; |
| | | 13 | | using MediaBrowser.Controller.Entities; |
| | | 14 | | using MediaBrowser.Controller.Entities.Audio; |
| | | 15 | | using MediaBrowser.Controller.IO; |
| | | 16 | | using MediaBrowser.Controller.Library; |
| | | 17 | | using MediaBrowser.Controller.Persistence; |
| | | 18 | | using MediaBrowser.Controller.Providers; |
| | | 19 | | using MediaBrowser.Model.Configuration; |
| | | 20 | | using MediaBrowser.Model.Entities; |
| | | 21 | | using MediaBrowser.Model.IO; |
| | | 22 | | using MediaBrowser.Model.Providers; |
| | | 23 | | using Microsoft.Extensions.Logging; |
| | | 24 | | |
| | | 25 | | namespace MediaBrowser.Providers.Manager |
| | | 26 | | { |
| | | 27 | | public abstract class MetadataService<TItemType, TIdType> : IMetadataService |
| | | 28 | | where TItemType : BaseItem, IHasLookupInfo<TIdType>, new() |
| | | 29 | | where TIdType : ItemLookupInfo, new() |
| | | 30 | | { |
| | | 31 | | protected MetadataService( |
| | | 32 | | IServerConfigurationManager serverConfigurationManager, |
| | | 33 | | ILogger<MetadataService<TItemType, TIdType>> logger, |
| | | 34 | | IProviderManager providerManager, |
| | | 35 | | IFileSystem fileSystem, |
| | | 36 | | ILibraryManager libraryManager, |
| | | 37 | | IExternalDataManager externalDataManager, |
| | | 38 | | IItemRepository itemRepository) |
| | | 39 | | { |
| | 575 | 40 | | ServerConfigurationManager = serverConfigurationManager; |
| | 575 | 41 | | Logger = logger; |
| | 575 | 42 | | ProviderManager = providerManager; |
| | 575 | 43 | | FileSystem = fileSystem; |
| | 575 | 44 | | LibraryManager = libraryManager; |
| | 575 | 45 | | ExternalDataManager = externalDataManager; |
| | 575 | 46 | | ItemRepository = itemRepository; |
| | 575 | 47 | | ImageProvider = new ItemImageProvider(Logger, ProviderManager, FileSystem); |
| | 575 | 48 | | } |
| | | 49 | | |
| | | 50 | | protected ItemImageProvider ImageProvider { get; } |
| | | 51 | | |
| | | 52 | | protected IServerConfigurationManager ServerConfigurationManager { get; } |
| | | 53 | | |
| | | 54 | | protected ILogger<MetadataService<TItemType, TIdType>> Logger { get; } |
| | | 55 | | |
| | | 56 | | protected IProviderManager ProviderManager { get; } |
| | | 57 | | |
| | | 58 | | protected IFileSystem FileSystem { get; } |
| | | 59 | | |
| | | 60 | | protected ILibraryManager LibraryManager { get; } |
| | | 61 | | |
| | | 62 | | protected IExternalDataManager ExternalDataManager { get; } |
| | | 63 | | |
| | | 64 | | protected IItemRepository ItemRepository { get; } |
| | | 65 | | |
| | 37 | 66 | | protected virtual bool EnableUpdatingPremiereDateFromChildren => false; |
| | | 67 | | |
| | 37 | 68 | | protected virtual bool EnableUpdatingGenresFromChildren => false; |
| | | 69 | | |
| | 37 | 70 | | protected virtual bool EnableUpdatingStudiosFromChildren => false; |
| | | 71 | | |
| | 37 | 72 | | protected virtual bool EnableUpdatingOfficialRatingFromChildren => false; |
| | | 73 | | |
| | 528 | 74 | | public virtual int Order => 0; |
| | | 75 | | |
| | | 76 | | private FileSystemMetadata TryGetFileSystemMetadata(string path, IDirectoryService directoryService) |
| | | 77 | | { |
| | | 78 | | try |
| | | 79 | | { |
| | 37 | 80 | | return directoryService.GetFileSystemEntry(path); |
| | | 81 | | } |
| | 0 | 82 | | catch (Exception ex) |
| | | 83 | | { |
| | 0 | 84 | | Logger.LogError(ex, "Error getting file {Path}", path); |
| | 0 | 85 | | return null; |
| | | 86 | | } |
| | 37 | 87 | | } |
| | | 88 | | |
| | | 89 | | public virtual async Task<ItemUpdateType> RefreshMetadata(BaseItem item, MetadataRefreshOptions refreshOptions, |
| | | 90 | | { |
| | 60 | 91 | | var itemOfType = (TItemType)item; |
| | 60 | 92 | | var updateType = ItemUpdateType.None; |
| | | 93 | | |
| | 60 | 94 | | var libraryOptions = LibraryManager.GetLibraryOptions(item); |
| | 60 | 95 | | var isFirstRefresh = item.DateLastRefreshed == DateTime.MinValue; |
| | 60 | 96 | | var hasRefreshedMetadata = true; |
| | 60 | 97 | | var hasRefreshedImages = true; |
| | | 98 | | |
| | 60 | 99 | | var requiresRefresh = libraryOptions.AutomaticRefreshIntervalDays > 0 && (DateTime.UtcNow - item.DateLastRef |
| | | 100 | | |
| | 60 | 101 | | if (!requiresRefresh && refreshOptions.MetadataRefreshMode != MetadataRefreshMode.None) |
| | | 102 | | { |
| | | 103 | | // TODO: If this returns true, should we instead just change metadata refresh mode to Full? |
| | 60 | 104 | | requiresRefresh = item.RequiresRefresh(); |
| | | 105 | | |
| | 60 | 106 | | if (requiresRefresh) |
| | | 107 | | { |
| | 18 | 108 | | Logger.LogDebug("Refreshing {Type} {Item} because item.RequiresRefresh() returned true", typeof(TIte |
| | | 109 | | } |
| | | 110 | | } |
| | | 111 | | |
| | 60 | 112 | | if (refreshOptions.RemoveOldMetadata && refreshOptions.ReplaceAllImages) |
| | | 113 | | { |
| | 0 | 114 | | if (ImageProvider.RemoveImages(item)) |
| | | 115 | | { |
| | 0 | 116 | | updateType |= ItemUpdateType.ImageUpdate; |
| | | 117 | | } |
| | | 118 | | } |
| | | 119 | | |
| | 60 | 120 | | var localImagesFailed = false; |
| | 60 | 121 | | var allImageProviders = ProviderManager.GetImageProviders(item, refreshOptions).ToList(); |
| | | 122 | | |
| | | 123 | | // Only validate already registered images if we are replacing and saving locally |
| | 60 | 124 | | if (item.IsSaveLocalMetadataEnabled() && refreshOptions.ReplaceAllImages) |
| | | 125 | | { |
| | 0 | 126 | | item.ValidateImages(); |
| | | 127 | | } |
| | | 128 | | else |
| | | 129 | | { |
| | | 130 | | // Run full image validation and register new local images |
| | | 131 | | try |
| | | 132 | | { |
| | 60 | 133 | | if (ImageProvider.ValidateImages(item, allImageProviders.OfType<ILocalImageProvider>(), refreshOptio |
| | | 134 | | { |
| | 0 | 135 | | updateType |= ItemUpdateType.ImageUpdate; |
| | | 136 | | } |
| | 60 | 137 | | } |
| | 0 | 138 | | catch (Exception ex) |
| | | 139 | | { |
| | 0 | 140 | | localImagesFailed = true; |
| | 0 | 141 | | Logger.LogError(ex, "Error validating images for {Item}", item.Path ?? item.Name ?? "Unknown name"); |
| | 0 | 142 | | } |
| | | 143 | | } |
| | | 144 | | |
| | 60 | 145 | | var metadataResult = new MetadataResult<TItemType> |
| | 60 | 146 | | { |
| | 60 | 147 | | Item = itemOfType |
| | 60 | 148 | | }; |
| | | 149 | | |
| | 60 | 150 | | var beforeSaveResult = await BeforeSave(itemOfType, isFirstRefresh || refreshOptions.ReplaceAllMetadata || r |
| | 60 | 151 | | .ConfigureAwait(false); |
| | 60 | 152 | | updateType |= beforeSaveResult; |
| | | 153 | | |
| | 60 | 154 | | if (isFirstRefresh) |
| | | 155 | | { |
| | 36 | 156 | | await SaveItemAsync(metadataResult, ItemUpdateType.MetadataImport, false, cancellationToken).ConfigureAw |
| | | 157 | | } |
| | | 158 | | |
| | | 159 | | // Next run metadata providers |
| | 60 | 160 | | if (refreshOptions.MetadataRefreshMode != MetadataRefreshMode.None) |
| | | 161 | | { |
| | 60 | 162 | | var providers = GetProviders(item, libraryOptions, refreshOptions, isFirstRefresh, requiresRefresh) |
| | 60 | 163 | | .ToList(); |
| | | 164 | | |
| | 60 | 165 | | if (providers.Count > 0 || isFirstRefresh || requiresRefresh) |
| | | 166 | | { |
| | 37 | 167 | | if (item.BeforeMetadataRefresh(refreshOptions.ReplaceAllMetadata)) |
| | | 168 | | { |
| | 35 | 169 | | updateType |= ItemUpdateType.MetadataImport; |
| | | 170 | | } |
| | | 171 | | } |
| | | 172 | | |
| | 60 | 173 | | if (providers.Count > 0) |
| | | 174 | | { |
| | 37 | 175 | | var id = itemOfType.GetLookupInfo(); |
| | | 176 | | |
| | 37 | 177 | | if (refreshOptions.SearchResult is not null) |
| | | 178 | | { |
| | 0 | 179 | | ApplySearchResult(id, refreshOptions.SearchResult); |
| | | 180 | | } |
| | | 181 | | |
| | 37 | 182 | | id.IsAutomated = refreshOptions.IsAutomated; |
| | | 183 | | |
| | 37 | 184 | | var hasMetadataSavers = ProviderManager.GetMetadataSavers(item, libraryOptions).Any(); |
| | 37 | 185 | | var result = await RefreshWithProviders(metadataResult, id, refreshOptions, providers, ImageProvider |
| | | 186 | | |
| | 37 | 187 | | updateType |= result.UpdateType; |
| | 37 | 188 | | if (result.Failures > 0) |
| | | 189 | | { |
| | 0 | 190 | | hasRefreshedMetadata = false; |
| | | 191 | | } |
| | | 192 | | } |
| | | 193 | | } |
| | | 194 | | |
| | | 195 | | // Next run remote image providers, but only if local image providers didn't throw an exception |
| | 60 | 196 | | if (!localImagesFailed && refreshOptions.ImageRefreshMode > MetadataRefreshMode.ValidationOnly) |
| | | 197 | | { |
| | 60 | 198 | | var providers = GetNonLocalImageProviders(item, allImageProviders, refreshOptions).ToList(); |
| | | 199 | | |
| | 60 | 200 | | if (providers.Count > 0) |
| | | 201 | | { |
| | 0 | 202 | | var result = await ImageProvider.RefreshImages(itemOfType, libraryOptions, providers, refreshOptions |
| | | 203 | | |
| | 0 | 204 | | updateType |= result.UpdateType; |
| | 0 | 205 | | if (result.Failures > 0) |
| | | 206 | | { |
| | 0 | 207 | | hasRefreshedImages = false; |
| | | 208 | | } |
| | | 209 | | } |
| | | 210 | | } |
| | | 211 | | |
| | 60 | 212 | | if (hasRefreshedMetadata && hasRefreshedImages) |
| | | 213 | | { |
| | 60 | 214 | | item.DateLastRefreshed = DateTime.UtcNow; |
| | 60 | 215 | | updateType |= item.OnMetadataChanged(); |
| | | 216 | | } |
| | | 217 | | |
| | 60 | 218 | | updateType = await SaveInternal(item, refreshOptions, updateType, isFirstRefresh, requiresRefresh, metadataR |
| | | 219 | | |
| | 59 | 220 | | await AfterMetadataRefresh(itemOfType, refreshOptions, cancellationToken).ConfigureAwait(false); |
| | | 221 | | |
| | 59 | 222 | | return updateType; |
| | | 223 | | |
| | | 224 | | async Task<ItemUpdateType> SaveInternal(BaseItem item, MetadataRefreshOptions refreshOptions, ItemUpdateType |
| | | 225 | | { |
| | | 226 | | // Save if changes were made, or it's never been saved before |
| | | 227 | | if (refreshOptions.ForceSave || updateType > ItemUpdateType.None || isFirstRefresh || refreshOptions.Rep |
| | | 228 | | { |
| | | 229 | | if (item.IsFileProtocol) |
| | | 230 | | { |
| | | 231 | | var file = TryGetFileSystemMetadata(item.Path, refreshOptions.DirectoryService); |
| | | 232 | | if (file is not null) |
| | | 233 | | { |
| | | 234 | | item.DateModified = file.LastWriteTimeUtc; |
| | | 235 | | |
| | | 236 | | if (!file.IsDirectory) |
| | | 237 | | { |
| | | 238 | | item.Size = file.Length; |
| | | 239 | | } |
| | | 240 | | } |
| | | 241 | | } |
| | | 242 | | |
| | | 243 | | // If any of these properties are set then make sure the updateType is not None, just to force every |
| | | 244 | | if (refreshOptions.ForceSave || refreshOptions.ReplaceAllMetadata) |
| | | 245 | | { |
| | | 246 | | updateType |= ItemUpdateType.MetadataDownload; |
| | | 247 | | } |
| | | 248 | | |
| | | 249 | | // Save to database |
| | | 250 | | await SaveItemAsync(metadataResult, updateType, isFirstRefresh, cancellationToken).ConfigureAwait(fa |
| | | 251 | | } |
| | | 252 | | |
| | | 253 | | return updateType; |
| | | 254 | | } |
| | 59 | 255 | | } |
| | | 256 | | |
| | | 257 | | private void ApplySearchResult(ItemLookupInfo lookupInfo, RemoteSearchResult result) |
| | | 258 | | { |
| | | 259 | | // Episode and Season do not support Identify, so the search results are the Series' |
| | | 260 | | switch (lookupInfo) |
| | | 261 | | { |
| | | 262 | | case EpisodeInfo episodeInfo: |
| | 0 | 263 | | episodeInfo.SeriesProviderIds = result.ProviderIds; |
| | 0 | 264 | | episodeInfo.ProviderIds.Clear(); |
| | 0 | 265 | | break; |
| | | 266 | | case SeasonInfo seasonInfo: |
| | 0 | 267 | | seasonInfo.SeriesProviderIds = result.ProviderIds; |
| | 0 | 268 | | seasonInfo.ProviderIds.Clear(); |
| | 0 | 269 | | break; |
| | | 270 | | default: |
| | 0 | 271 | | lookupInfo.ProviderIds = result.ProviderIds; |
| | 0 | 272 | | lookupInfo.Name = result.Name; |
| | 0 | 273 | | lookupInfo.Year = result.ProductionYear; |
| | | 274 | | break; |
| | | 275 | | } |
| | 0 | 276 | | } |
| | | 277 | | |
| | | 278 | | protected async Task SaveItemAsync(MetadataResult<TItemType> result, ItemUpdateType reason, bool reattachUserDat |
| | | 279 | | { |
| | 73 | 280 | | await result.Item.UpdateToRepositoryAsync(reason, cancellationToken).ConfigureAwait(false); |
| | 72 | 281 | | if (reattachUserData) |
| | | 282 | | { |
| | 35 | 283 | | await result.Item.ReattachUserDataAsync(cancellationToken).ConfigureAwait(false); |
| | | 284 | | } |
| | | 285 | | |
| | 72 | 286 | | if (result.Item.SupportsPeople && result.People is not null) |
| | | 287 | | { |
| | 0 | 288 | | var baseItem = result.Item; |
| | | 289 | | |
| | 0 | 290 | | await LibraryManager.UpdatePeopleAsync(baseItem, result.People, cancellationToken).ConfigureAwait(false) |
| | | 291 | | } |
| | 72 | 292 | | } |
| | | 293 | | |
| | | 294 | | protected virtual Task AfterMetadataRefresh(TItemType item, MetadataRefreshOptions refreshOptions, CancellationT |
| | | 295 | | { |
| | 59 | 296 | | item.AfterMetadataRefresh(); |
| | 59 | 297 | | return Task.CompletedTask; |
| | | 298 | | } |
| | | 299 | | |
| | | 300 | | /// <summary> |
| | | 301 | | /// Before the save. |
| | | 302 | | /// </summary> |
| | | 303 | | /// <param name="item">The item.</param> |
| | | 304 | | /// <param name="isFullRefresh">if set to <c>true</c> [is full refresh].</param> |
| | | 305 | | /// <param name="currentUpdateType">Type of the current update.</param> |
| | | 306 | | /// <returns>ItemUpdateType.</returns> |
| | | 307 | | private async Task<ItemUpdateType> BeforeSave(TItemType item, bool isFullRefresh, ItemUpdateType currentUpdateTy |
| | | 308 | | { |
| | 60 | 309 | | var updateType = BeforeSaveInternal(item, isFullRefresh, currentUpdateType); |
| | | 310 | | |
| | 60 | 311 | | updateType |= item.OnMetadataChanged(); |
| | | 312 | | |
| | 60 | 313 | | if (updateType == ItemUpdateType.None) |
| | | 314 | | { |
| | 24 | 315 | | if (!await ItemRepository.ItemExistsAsync(item.Id).ConfigureAwait(false)) |
| | | 316 | | { |
| | 0 | 317 | | return ItemUpdateType.MetadataImport; |
| | | 318 | | } |
| | | 319 | | } |
| | | 320 | | |
| | 60 | 321 | | return updateType; |
| | 60 | 322 | | } |
| | | 323 | | |
| | | 324 | | protected virtual ItemUpdateType BeforeSaveInternal(TItemType item, bool isFullRefresh, ItemUpdateType updateTyp |
| | | 325 | | { |
| | 60 | 326 | | if (EnableUpdateMetadataFromChildren(item, isFullRefresh, updateType)) |
| | | 327 | | { |
| | 0 | 328 | | var children = GetChildrenForMetadataUpdates(item); |
| | 0 | 329 | | updateType = UpdateMetadataFromChildren(item, children, isFullRefresh, updateType); |
| | | 330 | | } |
| | | 331 | | |
| | 60 | 332 | | var presentationUniqueKey = item.CreatePresentationUniqueKey(); |
| | 60 | 333 | | if (!string.Equals(item.PresentationUniqueKey, presentationUniqueKey, StringComparison.Ordinal)) |
| | | 334 | | { |
| | 36 | 335 | | item.PresentationUniqueKey = presentationUniqueKey; |
| | 36 | 336 | | updateType |= ItemUpdateType.MetadataImport; |
| | | 337 | | } |
| | | 338 | | |
| | | 339 | | // Cleanup extracted files if source file was modified |
| | 60 | 340 | | var itemPath = item.Path; |
| | 60 | 341 | | if (!string.IsNullOrEmpty(itemPath)) |
| | | 342 | | { |
| | 60 | 343 | | var info = FileSystem.GetFileSystemInfo(itemPath); |
| | 60 | 344 | | if (info.Exists && item.HasChanged(info.LastWriteTimeUtc)) |
| | | 345 | | { |
| | 0 | 346 | | Logger.LogDebug("File modification time changed from {Then} to {Now}: {Path}", item.DateModified, in |
| | | 347 | | |
| | 0 | 348 | | item.DateModified = info.LastWriteTimeUtc; |
| | 0 | 349 | | if (ServerConfigurationManager.GetMetadataConfiguration().UseFileCreationTimeForDateAdded) |
| | | 350 | | { |
| | 0 | 351 | | if (info.CreationTimeUtc > DateTime.MinValue) |
| | | 352 | | { |
| | 0 | 353 | | item.DateCreated = info.CreationTimeUtc; |
| | | 354 | | } |
| | | 355 | | } |
| | | 356 | | |
| | 0 | 357 | | if (item is Video video) |
| | | 358 | | { |
| | 0 | 359 | | Logger.LogInformation("File changed, pruning extracted data: {Path}", item.Path); |
| | 0 | 360 | | ExternalDataManager.DeleteExternalItemDataAsync(video, CancellationToken.None).GetAwaiter().GetR |
| | | 361 | | } |
| | | 362 | | |
| | 0 | 363 | | updateType |= ItemUpdateType.MetadataImport; |
| | | 364 | | } |
| | | 365 | | } |
| | | 366 | | |
| | 60 | 367 | | return updateType; |
| | | 368 | | } |
| | | 369 | | |
| | | 370 | | protected virtual bool EnableUpdateMetadataFromChildren(TItemType item, bool isFullRefresh, ItemUpdateType curre |
| | | 371 | | { |
| | 60 | 372 | | if (item is Folder folder) |
| | | 373 | | { |
| | 60 | 374 | | if (!isFullRefresh && currentUpdateType == ItemUpdateType.None) |
| | | 375 | | { |
| | 23 | 376 | | return folder.SupportsDateLastMediaAdded; |
| | | 377 | | } |
| | | 378 | | |
| | 37 | 379 | | if (isFullRefresh || currentUpdateType > ItemUpdateType.None) |
| | | 380 | | { |
| | 37 | 381 | | if (EnableUpdatingPremiereDateFromChildren || EnableUpdatingGenresFromChildren || EnableUpdatingStud |
| | | 382 | | { |
| | 0 | 383 | | return true; |
| | | 384 | | } |
| | | 385 | | |
| | 37 | 386 | | if (folder.SupportsDateLastMediaAdded || folder.SupportsCumulativeRunTimeTicks) |
| | | 387 | | { |
| | 0 | 388 | | return true; |
| | | 389 | | } |
| | | 390 | | } |
| | | 391 | | } |
| | | 392 | | |
| | 37 | 393 | | return false; |
| | | 394 | | } |
| | | 395 | | |
| | | 396 | | protected virtual IReadOnlyList<BaseItem> GetChildrenForMetadataUpdates(TItemType item) |
| | | 397 | | { |
| | 0 | 398 | | if (item is Folder folder) |
| | | 399 | | { |
| | 0 | 400 | | return folder.GetRecursiveChildren(); |
| | | 401 | | } |
| | | 402 | | |
| | 0 | 403 | | return []; |
| | | 404 | | } |
| | | 405 | | |
| | | 406 | | protected virtual ItemUpdateType UpdateMetadataFromChildren(TItemType item, IReadOnlyList<BaseItem> children, bo |
| | | 407 | | { |
| | 0 | 408 | | var updateType = ItemUpdateType.None; |
| | | 409 | | |
| | 0 | 410 | | if (item is Folder folder) |
| | | 411 | | { |
| | 0 | 412 | | if (folder.SupportsDateLastMediaAdded) |
| | | 413 | | { |
| | 0 | 414 | | updateType |= UpdateDateLastMediaAdded(item, children); |
| | | 415 | | } |
| | | 416 | | |
| | 0 | 417 | | if ((isFullRefresh || currentUpdateType > ItemUpdateType.None) && folder.SupportsCumulativeRunTimeTicks) |
| | | 418 | | { |
| | 0 | 419 | | updateType |= UpdateCumulativeRunTimeTicks(item, children); |
| | | 420 | | } |
| | | 421 | | } |
| | | 422 | | |
| | 0 | 423 | | if (!(isFullRefresh || currentUpdateType > ItemUpdateType.None) || item.IsLocked) |
| | | 424 | | { |
| | 0 | 425 | | return updateType; |
| | | 426 | | } |
| | | 427 | | |
| | 0 | 428 | | if (EnableUpdatingPremiereDateFromChildren) |
| | | 429 | | { |
| | 0 | 430 | | updateType |= UpdatePremiereDate(item, children); |
| | | 431 | | } |
| | | 432 | | |
| | 0 | 433 | | if (EnableUpdatingGenresFromChildren) |
| | | 434 | | { |
| | 0 | 435 | | updateType |= UpdateGenres(item, children); |
| | | 436 | | } |
| | | 437 | | |
| | 0 | 438 | | if (EnableUpdatingStudiosFromChildren) |
| | | 439 | | { |
| | 0 | 440 | | updateType |= UpdateStudios(item, children); |
| | | 441 | | } |
| | | 442 | | |
| | 0 | 443 | | if (EnableUpdatingOfficialRatingFromChildren) |
| | | 444 | | { |
| | 0 | 445 | | updateType |= UpdateOfficialRating(item, children); |
| | | 446 | | } |
| | | 447 | | |
| | 0 | 448 | | return updateType; |
| | | 449 | | } |
| | | 450 | | |
| | | 451 | | private ItemUpdateType UpdateCumulativeRunTimeTicks(TItemType item, IReadOnlyList<BaseItem> children) |
| | | 452 | | { |
| | 0 | 453 | | if (item is Folder folder && folder.SupportsCumulativeRunTimeTicks) |
| | | 454 | | { |
| | 0 | 455 | | long ticks = 0; |
| | | 456 | | |
| | 0 | 457 | | foreach (var child in children) |
| | | 458 | | { |
| | 0 | 459 | | if (!child.IsFolder) |
| | | 460 | | { |
| | 0 | 461 | | ticks += child.RunTimeTicks ?? 0; |
| | | 462 | | } |
| | | 463 | | } |
| | | 464 | | |
| | 0 | 465 | | if (!folder.RunTimeTicks.HasValue || folder.RunTimeTicks.Value != ticks) |
| | | 466 | | { |
| | 0 | 467 | | folder.RunTimeTicks = ticks; |
| | 0 | 468 | | return ItemUpdateType.MetadataImport; |
| | | 469 | | } |
| | | 470 | | } |
| | | 471 | | |
| | 0 | 472 | | return ItemUpdateType.None; |
| | | 473 | | } |
| | | 474 | | |
| | | 475 | | private ItemUpdateType UpdateDateLastMediaAdded(TItemType item, IReadOnlyList<BaseItem> children) |
| | | 476 | | { |
| | 0 | 477 | | var updateType = ItemUpdateType.None; |
| | | 478 | | |
| | 0 | 479 | | if (item is Folder folder && folder.SupportsDateLastMediaAdded) |
| | | 480 | | { |
| | 0 | 481 | | var dateLastMediaAdded = DateTime.MinValue; |
| | 0 | 482 | | var any = false; |
| | | 483 | | |
| | 0 | 484 | | foreach (var child in children) |
| | | 485 | | { |
| | | 486 | | // Exclude any folders and virtual items since they are only placeholders |
| | 0 | 487 | | if (!child.IsFolder && !child.IsVirtualItem) |
| | | 488 | | { |
| | 0 | 489 | | var childDateCreated = child.DateCreated; |
| | 0 | 490 | | if (childDateCreated > dateLastMediaAdded) |
| | | 491 | | { |
| | 0 | 492 | | dateLastMediaAdded = childDateCreated; |
| | | 493 | | } |
| | | 494 | | |
| | 0 | 495 | | any = true; |
| | | 496 | | } |
| | | 497 | | } |
| | | 498 | | |
| | 0 | 499 | | if ((!folder.DateLastMediaAdded.HasValue && any) || folder.DateLastMediaAdded != dateLastMediaAdded) |
| | | 500 | | { |
| | 0 | 501 | | folder.DateLastMediaAdded = dateLastMediaAdded; |
| | 0 | 502 | | updateType = ItemUpdateType.MetadataImport; |
| | | 503 | | } |
| | | 504 | | } |
| | | 505 | | |
| | 0 | 506 | | return updateType; |
| | | 507 | | } |
| | | 508 | | |
| | | 509 | | private ItemUpdateType UpdatePremiereDate(TItemType item, IReadOnlyList<BaseItem> children) |
| | | 510 | | { |
| | 0 | 511 | | var updateType = ItemUpdateType.None; |
| | | 512 | | |
| | 0 | 513 | | if (children.Count == 0) |
| | | 514 | | { |
| | 0 | 515 | | return updateType; |
| | | 516 | | } |
| | | 517 | | |
| | 0 | 518 | | var date = children.Select(i => i.PremiereDate ?? DateTime.MaxValue).Min(); |
| | | 519 | | |
| | 0 | 520 | | var originalPremiereDate = item.PremiereDate; |
| | 0 | 521 | | var originalProductionYear = item.ProductionYear; |
| | | 522 | | |
| | 0 | 523 | | if (date > DateTime.MinValue && date < DateTime.MaxValue) |
| | | 524 | | { |
| | 0 | 525 | | item.PremiereDate = date; |
| | 0 | 526 | | item.ProductionYear = date.Year; |
| | | 527 | | } |
| | | 528 | | else |
| | | 529 | | { |
| | 0 | 530 | | var year = children.Select(i => i.ProductionYear ?? 0).Min(); |
| | | 531 | | |
| | 0 | 532 | | if (year > 0) |
| | | 533 | | { |
| | 0 | 534 | | item.ProductionYear = year; |
| | | 535 | | } |
| | | 536 | | } |
| | | 537 | | |
| | 0 | 538 | | if ((originalPremiereDate ?? DateTime.MinValue) != (item.PremiereDate ?? DateTime.MinValue) |
| | 0 | 539 | | || (originalProductionYear ?? -1) != (item.ProductionYear ?? -1)) |
| | | 540 | | { |
| | 0 | 541 | | updateType |= ItemUpdateType.MetadataEdit; |
| | | 542 | | } |
| | | 543 | | |
| | 0 | 544 | | return updateType; |
| | | 545 | | } |
| | | 546 | | |
| | | 547 | | private ItemUpdateType UpdateGenres(TItemType item, IReadOnlyList<BaseItem> children) |
| | | 548 | | { |
| | 0 | 549 | | var updateType = ItemUpdateType.None; |
| | | 550 | | |
| | 0 | 551 | | if (!item.LockedFields.Contains(MetadataField.Genres)) |
| | | 552 | | { |
| | 0 | 553 | | var currentList = item.Genres; |
| | | 554 | | |
| | 0 | 555 | | item.Genres = children.SelectMany(i => i.Genres) |
| | 0 | 556 | | .Distinct(StringComparer.OrdinalIgnoreCase) |
| | 0 | 557 | | .ToArray(); |
| | | 558 | | |
| | 0 | 559 | | if (currentList.Length != item.Genres.Length || !currentList.Order().SequenceEqual(item.Genres.Order(), |
| | | 560 | | { |
| | 0 | 561 | | updateType |= ItemUpdateType.MetadataEdit; |
| | | 562 | | } |
| | | 563 | | } |
| | | 564 | | |
| | 0 | 565 | | return updateType; |
| | | 566 | | } |
| | | 567 | | |
| | | 568 | | private ItemUpdateType UpdateStudios(TItemType item, IReadOnlyList<BaseItem> children) |
| | | 569 | | { |
| | 0 | 570 | | var updateType = ItemUpdateType.None; |
| | | 571 | | |
| | 0 | 572 | | if (!item.LockedFields.Contains(MetadataField.Studios)) |
| | | 573 | | { |
| | 0 | 574 | | var currentList = item.Studios; |
| | | 575 | | |
| | 0 | 576 | | item.Studios = children.SelectMany(i => i.Studios) |
| | 0 | 577 | | .Distinct(StringComparer.OrdinalIgnoreCase) |
| | 0 | 578 | | .ToArray(); |
| | | 579 | | |
| | 0 | 580 | | if (currentList.Length != item.Studios.Length || !currentList.Order().SequenceEqual(item.Studios.Order() |
| | | 581 | | { |
| | 0 | 582 | | updateType |= ItemUpdateType.MetadataEdit; |
| | | 583 | | } |
| | | 584 | | } |
| | | 585 | | |
| | 0 | 586 | | return updateType; |
| | | 587 | | } |
| | | 588 | | |
| | | 589 | | private ItemUpdateType UpdateOfficialRating(TItemType item, IReadOnlyList<BaseItem> children) |
| | | 590 | | { |
| | 0 | 591 | | var updateType = ItemUpdateType.None; |
| | | 592 | | |
| | 0 | 593 | | if (!item.LockedFields.Contains(MetadataField.OfficialRating)) |
| | | 594 | | { |
| | 0 | 595 | | if (item.UpdateRatingToItems(children)) |
| | | 596 | | { |
| | 0 | 597 | | updateType |= ItemUpdateType.MetadataEdit; |
| | | 598 | | } |
| | | 599 | | } |
| | | 600 | | |
| | 0 | 601 | | return updateType; |
| | | 602 | | } |
| | | 603 | | |
| | | 604 | | /// <summary> |
| | | 605 | | /// Gets the providers. |
| | | 606 | | /// </summary> |
| | | 607 | | /// <param name="item">A media item.</param> |
| | | 608 | | /// <param name="libraryOptions">The LibraryOptions to use.</param> |
| | | 609 | | /// <param name="options">The MetadataRefreshOptions to use.</param> |
| | | 610 | | /// <param name="isFirstRefresh">Specifies first refresh mode.</param> |
| | | 611 | | /// <param name="requiresRefresh">Specifies refresh mode.</param> |
| | | 612 | | /// <returns>IEnumerable{`0}.</returns> |
| | | 613 | | protected IEnumerable<IMetadataProvider> GetProviders(BaseItem item, LibraryOptions libraryOptions, MetadataRefr |
| | | 614 | | { |
| | | 615 | | // Get providers to refresh |
| | 60 | 616 | | var providers = ProviderManager.GetMetadataProviders<TItemType>(item, libraryOptions).ToList(); |
| | | 617 | | |
| | 60 | 618 | | var metadataRefreshMode = options.MetadataRefreshMode; |
| | | 619 | | |
| | | 620 | | // Run all if either of these flags are true |
| | 60 | 621 | | var runAllProviders = options.ReplaceAllMetadata || |
| | 60 | 622 | | metadataRefreshMode == MetadataRefreshMode.FullRefresh || |
| | 60 | 623 | | (isFirstRefresh && metadataRefreshMode >= MetadataRefreshMode.Default) || |
| | 60 | 624 | | (requiresRefresh && metadataRefreshMode >= MetadataRefreshMode.Default); |
| | | 625 | | |
| | 60 | 626 | | if (!runAllProviders) |
| | | 627 | | { |
| | 23 | 628 | | var providersWithChanges = providers |
| | 23 | 629 | | .Where(i => |
| | 23 | 630 | | { |
| | 23 | 631 | | if (i is IHasItemChangeMonitor hasFileChangeMonitor) |
| | 23 | 632 | | { |
| | 23 | 633 | | return HasChanged(item, hasFileChangeMonitor, options.DirectoryService); |
| | 23 | 634 | | } |
| | 23 | 635 | | |
| | 23 | 636 | | return false; |
| | 23 | 637 | | }) |
| | 23 | 638 | | .ToList(); |
| | | 639 | | |
| | 23 | 640 | | if (providersWithChanges.Count == 0) |
| | | 641 | | { |
| | 23 | 642 | | providers = new List<IMetadataProvider<TItemType>>(); |
| | | 643 | | } |
| | | 644 | | else |
| | | 645 | | { |
| | 0 | 646 | | var anyRemoteProvidersChanged = providersWithChanges.OfType<IRemoteMetadataProvider>() |
| | 0 | 647 | | .Any(); |
| | | 648 | | |
| | 0 | 649 | | var anyLocalProvidersChanged = providersWithChanges.OfType<ILocalMetadataProvider>() |
| | 0 | 650 | | .Any(); |
| | | 651 | | |
| | 0 | 652 | | var anyLocalPreRefreshProvidersChanged = providersWithChanges.OfType<IPreRefreshProvider>() |
| | 0 | 653 | | .Any(); |
| | | 654 | | |
| | 0 | 655 | | providers = providers.Where(i => |
| | 0 | 656 | | { |
| | 0 | 657 | | // If any provider reports a change, always run local ones as well |
| | 0 | 658 | | if (i is ILocalMetadataProvider) |
| | 0 | 659 | | { |
| | 0 | 660 | | return anyRemoteProvidersChanged || anyLocalProvidersChanged || anyLocalPreRefreshProvidersC |
| | 0 | 661 | | } |
| | 0 | 662 | | |
| | 0 | 663 | | // If any remote providers changed, run them all so that priorities can be honored |
| | 0 | 664 | | if (i is IRemoteMetadataProvider) |
| | 0 | 665 | | { |
| | 0 | 666 | | if (options.MetadataRefreshMode == MetadataRefreshMode.ValidationOnly) |
| | 0 | 667 | | { |
| | 0 | 668 | | return false; |
| | 0 | 669 | | } |
| | 0 | 670 | | |
| | 0 | 671 | | return anyRemoteProvidersChanged; |
| | 0 | 672 | | } |
| | 0 | 673 | | |
| | 0 | 674 | | // Run custom refresh providers if they report a change or any remote providers change |
| | 0 | 675 | | return anyRemoteProvidersChanged || providersWithChanges.Contains(i); |
| | 0 | 676 | | }).ToList(); |
| | | 677 | | } |
| | | 678 | | } |
| | | 679 | | |
| | 60 | 680 | | return providers; |
| | | 681 | | } |
| | | 682 | | |
| | | 683 | | protected virtual IEnumerable<IImageProvider> GetNonLocalImageProviders(BaseItem item, IEnumerable<IImageProvide |
| | | 684 | | { |
| | | 685 | | // Get providers to refresh |
| | 60 | 686 | | var providers = allImageProviders.Where(i => i is not ILocalImageProvider); |
| | | 687 | | |
| | | 688 | | // When identifying, run the provider the user picked first so the correct image is used. |
| | 60 | 689 | | if (!string.IsNullOrEmpty(options.SearchResult?.SearchProviderName)) |
| | | 690 | | { |
| | 0 | 691 | | providers = providers |
| | 0 | 692 | | .OrderBy(i => string.Equals(i.Name, options.SearchResult.SearchProviderName, StringComparison.Ordina |
| | | 693 | | } |
| | | 694 | | |
| | 60 | 695 | | var dateLastImageRefresh = item.DateLastRefreshed; |
| | | 696 | | |
| | | 697 | | // Run all if either of these flags are true |
| | 60 | 698 | | var runAllProviders = options.ImageRefreshMode == MetadataRefreshMode.FullRefresh || dateLastImageRefresh.Da |
| | | 699 | | |
| | 60 | 700 | | if (!runAllProviders) |
| | | 701 | | { |
| | 24 | 702 | | providers = providers |
| | 24 | 703 | | .Where(i => |
| | 24 | 704 | | { |
| | 24 | 705 | | if (i is IHasItemChangeMonitor hasFileChangeMonitor) |
| | 24 | 706 | | { |
| | 24 | 707 | | return HasChanged(item, hasFileChangeMonitor, options.DirectoryService); |
| | 24 | 708 | | } |
| | 24 | 709 | | |
| | 24 | 710 | | return false; |
| | 24 | 711 | | }); |
| | | 712 | | } |
| | | 713 | | |
| | 60 | 714 | | return providers; |
| | | 715 | | } |
| | | 716 | | |
| | | 717 | | public bool CanRefresh(BaseItem item) |
| | | 718 | | { |
| | 1196 | 719 | | return item is TItemType; |
| | | 720 | | } |
| | | 721 | | |
| | | 722 | | public bool CanRefreshPrimary(Type type) |
| | | 723 | | { |
| | 1462 | 724 | | return type == typeof(TItemType); |
| | | 725 | | } |
| | | 726 | | |
| | | 727 | | protected virtual async Task<RefreshResult> RefreshWithProviders( |
| | | 728 | | MetadataResult<TItemType> metadata, |
| | | 729 | | TIdType id, |
| | | 730 | | MetadataRefreshOptions options, |
| | | 731 | | ICollection<IMetadataProvider> providers, |
| | | 732 | | ItemImageProvider imageService, |
| | | 733 | | bool isSavingMetadata, |
| | | 734 | | CancellationToken cancellationToken) |
| | | 735 | | { |
| | 37 | 736 | | var refreshResult = new RefreshResult |
| | 37 | 737 | | { |
| | 37 | 738 | | UpdateType = ItemUpdateType.None |
| | 37 | 739 | | }; |
| | | 740 | | |
| | 37 | 741 | | var item = metadata.Item; |
| | | 742 | | |
| | 37 | 743 | | var customProviders = providers.OfType<ICustomMetadataProvider<TItemType>>().ToList(); |
| | 37 | 744 | | var logName = !item.IsFileProtocol ? item.Name ?? item.Path : item.Path ?? item.Name; |
| | | 745 | | |
| | 74 | 746 | | foreach (var provider in customProviders.Where(i => i is IPreRefreshProvider)) |
| | | 747 | | { |
| | 0 | 748 | | await RunCustomProvider(provider, item, logName, options, refreshResult, cancellationToken).ConfigureAwa |
| | | 749 | | } |
| | | 750 | | |
| | 37 | 751 | | if (item.IsLocked) |
| | | 752 | | { |
| | 0 | 753 | | return refreshResult; |
| | | 754 | | } |
| | | 755 | | |
| | 37 | 756 | | var temp = new MetadataResult<TItemType> |
| | 37 | 757 | | { |
| | 37 | 758 | | Item = CreateNew() |
| | 37 | 759 | | }; |
| | 37 | 760 | | temp.Item.Path = item.Path; |
| | 37 | 761 | | temp.Item.Id = item.Id; |
| | 37 | 762 | | temp.Item.ParentIndexNumber = item.ParentIndexNumber; |
| | 37 | 763 | | temp.Item.PreferredMetadataCountryCode = item.PreferredMetadataCountryCode; |
| | 37 | 764 | | temp.Item.PreferredMetadataLanguage = item.PreferredMetadataLanguage; |
| | | 765 | | |
| | 37 | 766 | | var foundImageTypes = new List<ImageType>(); |
| | | 767 | | |
| | | 768 | | // Do not execute local providers if we are identifying or replacing with local metadata saving enabled |
| | 37 | 769 | | if (options.SearchResult is null && !(isSavingMetadata && options.ReplaceAllMetadata)) |
| | | 770 | | { |
| | 74 | 771 | | foreach (var provider in providers.OfType<ILocalMetadataProvider<TItemType>>()) |
| | | 772 | | { |
| | 0 | 773 | | var providerName = provider.GetType().Name; |
| | 0 | 774 | | Logger.LogDebug("Running {Provider} for {Item}", providerName, logName); |
| | | 775 | | |
| | 0 | 776 | | var itemInfo = new ItemInfo(item); |
| | | 777 | | |
| | | 778 | | try |
| | | 779 | | { |
| | 0 | 780 | | var localItem = await provider.GetMetadata(itemInfo, options.DirectoryService, cancellationToken |
| | | 781 | | |
| | 0 | 782 | | if (localItem.HasMetadata) |
| | | 783 | | { |
| | 0 | 784 | | foreach (var remoteImage in localItem.RemoteImages) |
| | | 785 | | { |
| | | 786 | | try |
| | | 787 | | { |
| | 0 | 788 | | if (item.ImageInfos.Any(x => x.Type == remoteImage.Type) |
| | 0 | 789 | | && !options.IsReplacingImage(remoteImage.Type)) |
| | | 790 | | { |
| | 0 | 791 | | continue; |
| | | 792 | | } |
| | | 793 | | |
| | 0 | 794 | | await ProviderManager.SaveImage(item, remoteImage.Url, remoteImage.Type, null, cance |
| | 0 | 795 | | refreshResult.UpdateType |= ItemUpdateType.ImageUpdate; |
| | | 796 | | |
| | | 797 | | // remember imagetype that has just been downloaded |
| | 0 | 798 | | foundImageTypes.Add(remoteImage.Type); |
| | 0 | 799 | | } |
| | 0 | 800 | | catch (HttpRequestException ex) |
| | | 801 | | { |
| | 0 | 802 | | Logger.LogError(ex, "Could not save {ImageType} image: {Url}", Enum.GetName(remoteIm |
| | 0 | 803 | | } |
| | 0 | 804 | | } |
| | | 805 | | |
| | 0 | 806 | | if (foundImageTypes.Count > 0) |
| | | 807 | | { |
| | 0 | 808 | | imageService.UpdateReplaceImages(options, foundImageTypes); |
| | | 809 | | } |
| | | 810 | | |
| | 0 | 811 | | if (imageService.MergeImages(item, localItem.Images, options)) |
| | | 812 | | { |
| | 0 | 813 | | refreshResult.UpdateType |= ItemUpdateType.ImageUpdate; |
| | | 814 | | } |
| | | 815 | | |
| | 0 | 816 | | MergeData(localItem, temp, [], false, true); |
| | 0 | 817 | | refreshResult.UpdateType |= ItemUpdateType.MetadataImport; |
| | | 818 | | |
| | 0 | 819 | | break; |
| | | 820 | | } |
| | | 821 | | |
| | 0 | 822 | | Logger.LogDebug("{Provider} returned no metadata for {Item}", providerName, logName); |
| | 0 | 823 | | } |
| | 0 | 824 | | catch (OperationCanceledException) |
| | | 825 | | { |
| | 0 | 826 | | throw; |
| | | 827 | | } |
| | 0 | 828 | | catch (Exception ex) |
| | | 829 | | { |
| | 0 | 830 | | Logger.LogError(ex, "Error in {Provider} for {Item}", provider.Name, logName); |
| | | 831 | | |
| | | 832 | | // If a local provider fails, consider that a failure |
| | 0 | 833 | | refreshResult.ErrorMessage = ex.Message; |
| | 0 | 834 | | } |
| | 0 | 835 | | } |
| | | 836 | | } |
| | | 837 | | |
| | 37 | 838 | | var isLocalLocked = temp.Item.IsLocked; |
| | 37 | 839 | | if (!isLocalLocked && (options.ReplaceAllMetadata || options.MetadataRefreshMode > MetadataRefreshMode.Valid |
| | | 840 | | { |
| | 37 | 841 | | var remoteProviders = providers.OfType<IRemoteMetadataProvider<TItemType, TIdType>>(); |
| | | 842 | | |
| | | 843 | | // When identifying, run the provider the user picked first so the correct IDs are used. |
| | 37 | 844 | | if (!string.IsNullOrEmpty(options.SearchResult?.SearchProviderName)) |
| | | 845 | | { |
| | 0 | 846 | | remoteProviders = remoteProviders |
| | 0 | 847 | | .OrderBy(i => string.Equals(i.Name, options.SearchResult.SearchProviderName, StringComparison.Or |
| | | 848 | | } |
| | | 849 | | |
| | 37 | 850 | | var remoteResult = await ExecuteRemoteProviders(temp, logName, false, id, remoteProviders, cancellationT |
| | | 851 | | |
| | 37 | 852 | | refreshResult.UpdateType |= remoteResult.UpdateType; |
| | 37 | 853 | | refreshResult.ErrorMessage = remoteResult.ErrorMessage; |
| | 37 | 854 | | refreshResult.Failures += remoteResult.Failures; |
| | | 855 | | } |
| | | 856 | | |
| | 37 | 857 | | if (providers.Any(i => i is not ICustomMetadataProvider)) |
| | | 858 | | { |
| | 0 | 859 | | if (refreshResult.UpdateType > ItemUpdateType.None) |
| | | 860 | | { |
| | 0 | 861 | | if (!options.RemoveOldMetadata) |
| | | 862 | | { |
| | | 863 | | // Add existing metadata to provider result if it does not exist there |
| | 0 | 864 | | MergeData(metadata, temp, [], false, false); |
| | | 865 | | } |
| | | 866 | | |
| | 0 | 867 | | if (isLocalLocked) |
| | | 868 | | { |
| | 0 | 869 | | MergeData(temp, metadata, item.LockedFields, true, true); |
| | | 870 | | } |
| | | 871 | | else |
| | | 872 | | { |
| | 0 | 873 | | var shouldReplace = (options.MetadataRefreshMode > MetadataRefreshMode.ValidationOnly && options |
| | 0 | 874 | | // Case for Scan for new and updated files |
| | 0 | 875 | | || (options.MetadataRefreshMode == MetadataRefreshMode.Default && !options.ReplaceAllMetadat |
| | 0 | 876 | | MergeData(temp, metadata, item.LockedFields, shouldReplace, true); |
| | | 877 | | } |
| | | 878 | | } |
| | | 879 | | } |
| | | 880 | | |
| | 148 | 881 | | foreach (var provider in customProviders.Where(i => i is not IPreRefreshProvider)) |
| | | 882 | | { |
| | 37 | 883 | | await RunCustomProvider(provider, item, logName, options, refreshResult, cancellationToken).ConfigureAwa |
| | | 884 | | } |
| | | 885 | | |
| | 37 | 886 | | return refreshResult; |
| | 37 | 887 | | } |
| | | 888 | | |
| | | 889 | | private async Task RunCustomProvider(ICustomMetadataProvider<TItemType> provider, TItemType item, string logName |
| | | 890 | | { |
| | 37 | 891 | | Logger.LogDebug("Running {Provider} for {Item}", provider.GetType().Name, logName); |
| | | 892 | | |
| | | 893 | | try |
| | | 894 | | { |
| | 37 | 895 | | refreshResult.UpdateType |= await provider.FetchAsync(item, options, cancellationToken).ConfigureAwait(f |
| | 37 | 896 | | } |
| | 0 | 897 | | catch (OperationCanceledException) |
| | | 898 | | { |
| | 0 | 899 | | throw; |
| | | 900 | | } |
| | 0 | 901 | | catch (Exception ex) |
| | | 902 | | { |
| | 0 | 903 | | refreshResult.ErrorMessage = ex.Message; |
| | 0 | 904 | | Logger.LogError(ex, "Error in {Provider} for {Item}", provider.Name, logName); |
| | 0 | 905 | | } |
| | 37 | 906 | | } |
| | | 907 | | |
| | | 908 | | protected virtual TItemType CreateNew() |
| | | 909 | | { |
| | 37 | 910 | | return new TItemType(); |
| | | 911 | | } |
| | | 912 | | |
| | | 913 | | private async Task<RefreshResult> ExecuteRemoteProviders(MetadataResult<TItemType> temp, string logName, bool re |
| | | 914 | | { |
| | 37 | 915 | | var refreshResult = new RefreshResult(); |
| | | 916 | | |
| | 37 | 917 | | if (id is not null) |
| | | 918 | | { |
| | 37 | 919 | | MergeNewData(temp.Item, id); |
| | | 920 | | } |
| | | 921 | | |
| | 74 | 922 | | foreach (var provider in providers) |
| | | 923 | | { |
| | 0 | 924 | | var providerName = provider.GetType().Name; |
| | 0 | 925 | | Logger.LogDebug("Running {Provider} for {Item}", providerName, logName); |
| | | 926 | | |
| | | 927 | | try |
| | | 928 | | { |
| | 0 | 929 | | var result = await provider.GetMetadata(id, cancellationToken).ConfigureAwait(false); |
| | | 930 | | |
| | 0 | 931 | | if (result.HasMetadata) |
| | | 932 | | { |
| | 0 | 933 | | result.Provider = provider.Name; |
| | | 934 | | |
| | 0 | 935 | | MergeData(result, temp, [], replaceData, false); |
| | 0 | 936 | | MergeNewData(temp.Item, id); |
| | | 937 | | |
| | 0 | 938 | | refreshResult.UpdateType |= ItemUpdateType.MetadataDownload; |
| | | 939 | | } |
| | | 940 | | else |
| | | 941 | | { |
| | 0 | 942 | | Logger.LogDebug("{Provider} returned no metadata for {Item}", providerName, logName); |
| | | 943 | | } |
| | 0 | 944 | | } |
| | 0 | 945 | | catch (OperationCanceledException) |
| | | 946 | | { |
| | 0 | 947 | | throw; |
| | | 948 | | } |
| | 0 | 949 | | catch (Exception ex) |
| | | 950 | | { |
| | 0 | 951 | | refreshResult.Failures++; |
| | 0 | 952 | | refreshResult.ErrorMessage = ex.Message; |
| | 0 | 953 | | Logger.LogError(ex, "Error in {Provider} for {Item}", provider.Name, logName); |
| | 0 | 954 | | } |
| | 0 | 955 | | } |
| | | 956 | | |
| | 37 | 957 | | return refreshResult; |
| | 37 | 958 | | } |
| | | 959 | | |
| | | 960 | | private void MergeNewData(TItemType source, TIdType lookupInfo) |
| | | 961 | | { |
| | | 962 | | // Copy new provider id's that may have been obtained |
| | 74 | 963 | | foreach (var providerId in source.ProviderIds) |
| | | 964 | | { |
| | 0 | 965 | | var key = providerId.Key; |
| | | 966 | | |
| | | 967 | | // Don't replace existing Id's. |
| | 0 | 968 | | lookupInfo.ProviderIds.TryAdd(key, providerId.Value); |
| | | 969 | | } |
| | 37 | 970 | | } |
| | | 971 | | |
| | | 972 | | private bool HasChanged(BaseItem item, IHasItemChangeMonitor changeMonitor, IDirectoryService directoryService) |
| | | 973 | | { |
| | | 974 | | try |
| | | 975 | | { |
| | 23 | 976 | | var hasChanged = changeMonitor.HasChanged(item, directoryService); |
| | | 977 | | |
| | 23 | 978 | | if (hasChanged) |
| | | 979 | | { |
| | 0 | 980 | | Logger.LogDebug("{Monitor} reports change to {Item}", changeMonitor.GetType().Name, item.Path ?? ite |
| | | 981 | | } |
| | | 982 | | |
| | 23 | 983 | | return hasChanged; |
| | | 984 | | } |
| | 0 | 985 | | catch (Exception ex) |
| | | 986 | | { |
| | 0 | 987 | | Logger.LogError(ex, "Error in {Monitor}.HasChanged", changeMonitor.GetType().Name); |
| | 0 | 988 | | return false; |
| | | 989 | | } |
| | 23 | 990 | | } |
| | | 991 | | |
| | | 992 | | /// <summary> |
| | | 993 | | /// Merges metadata from source into target. |
| | | 994 | | /// </summary> |
| | | 995 | | /// <param name="source">The source for new metadata.</param> |
| | | 996 | | /// <param name="target">The target to insert new metadata into.</param> |
| | | 997 | | /// <param name="lockedFields">The fields that are locked and should not be updated.</param> |
| | | 998 | | /// <param name="replaceData"><c>true</c> if existing data should be replaced.</param> |
| | | 999 | | /// <param name="mergeMetadataSettings"><c>true</c> if the metadata settings in target should be updated to matc |
| | | 1000 | | /// <exception cref="ArgumentException">Thrown if source or target are null.</exception> |
| | | 1001 | | protected virtual void MergeData( |
| | | 1002 | | MetadataResult<TItemType> source, |
| | | 1003 | | MetadataResult<TItemType> target, |
| | | 1004 | | MetadataField[] lockedFields, |
| | | 1005 | | bool replaceData, |
| | | 1006 | | bool mergeMetadataSettings) |
| | | 1007 | | { |
| | 3 | 1008 | | MergeBaseItemData(source, target, lockedFields, replaceData, mergeMetadataSettings); |
| | 3 | 1009 | | } |
| | | 1010 | | |
| | | 1011 | | internal static void MergeBaseItemData( |
| | | 1012 | | MetadataResult<TItemType> sourceResult, |
| | | 1013 | | MetadataResult<TItemType> targetResult, |
| | | 1014 | | MetadataField[] lockedFields, |
| | | 1015 | | bool replaceData, |
| | | 1016 | | bool mergeMetadataSettings) |
| | | 1017 | | { |
| | 132 | 1018 | | var source = sourceResult.Item; |
| | 132 | 1019 | | var target = targetResult.Item; |
| | | 1020 | | |
| | 132 | 1021 | | ArgumentNullException.ThrowIfNull(sourceResult); |
| | 132 | 1022 | | ArgumentNullException.ThrowIfNull(targetResult); |
| | | 1023 | | |
| | 132 | 1024 | | if (!lockedFields.Contains(MetadataField.Name)) |
| | | 1025 | | { |
| | 129 | 1026 | | if (replaceData || string.IsNullOrEmpty(target.Name)) |
| | | 1027 | | { |
| | | 1028 | | // Safeguard against incoming data having an empty name |
| | 128 | 1029 | | if (!string.IsNullOrWhiteSpace(source.Name)) |
| | | 1030 | | { |
| | 3 | 1031 | | target.Name = source.Name; |
| | | 1032 | | } |
| | | 1033 | | } |
| | | 1034 | | } |
| | | 1035 | | |
| | 132 | 1036 | | if (replaceData || string.IsNullOrEmpty(target.OriginalTitle)) |
| | | 1037 | | { |
| | 131 | 1038 | | target.OriginalTitle = source.OriginalTitle; |
| | | 1039 | | } |
| | | 1040 | | |
| | 132 | 1041 | | if (replaceData || string.IsNullOrEmpty(target.OriginalLanguage)) |
| | | 1042 | | { |
| | 132 | 1043 | | target.OriginalLanguage = source.OriginalLanguage; |
| | | 1044 | | } |
| | | 1045 | | |
| | 132 | 1046 | | if (replaceData || !target.CommunityRating.HasValue) |
| | | 1047 | | { |
| | 131 | 1048 | | target.CommunityRating = source.CommunityRating; |
| | | 1049 | | } |
| | | 1050 | | |
| | 132 | 1051 | | if (replaceData || !target.EndDate.HasValue) |
| | | 1052 | | { |
| | 131 | 1053 | | target.EndDate = source.EndDate; |
| | | 1054 | | } |
| | | 1055 | | |
| | 132 | 1056 | | if (!lockedFields.Contains(MetadataField.Genres)) |
| | | 1057 | | { |
| | 130 | 1058 | | if (replaceData || target.Genres.Length == 0) |
| | | 1059 | | { |
| | 129 | 1060 | | target.Genres = source.Genres; |
| | | 1061 | | } |
| | | 1062 | | } |
| | | 1063 | | |
| | 132 | 1064 | | if (replaceData || !target.IndexNumber.HasValue) |
| | | 1065 | | { |
| | 131 | 1066 | | target.IndexNumber = source.IndexNumber; |
| | | 1067 | | } |
| | | 1068 | | |
| | 132 | 1069 | | if (!lockedFields.Contains(MetadataField.OfficialRating)) |
| | | 1070 | | { |
| | 129 | 1071 | | if (replaceData || string.IsNullOrEmpty(target.OfficialRating)) |
| | | 1072 | | { |
| | 128 | 1073 | | target.OfficialRating = source.OfficialRating; |
| | | 1074 | | } |
| | | 1075 | | } |
| | | 1076 | | |
| | 132 | 1077 | | if (replaceData || string.IsNullOrEmpty(target.CustomRating)) |
| | | 1078 | | { |
| | 131 | 1079 | | target.CustomRating = source.CustomRating; |
| | | 1080 | | } |
| | | 1081 | | |
| | 132 | 1082 | | if (replaceData || string.IsNullOrEmpty(target.Tagline)) |
| | | 1083 | | { |
| | 131 | 1084 | | target.Tagline = source.Tagline; |
| | | 1085 | | } |
| | | 1086 | | |
| | 132 | 1087 | | if (!lockedFields.Contains(MetadataField.Overview)) |
| | | 1088 | | { |
| | 129 | 1089 | | if (replaceData || string.IsNullOrEmpty(target.Overview)) |
| | | 1090 | | { |
| | 128 | 1091 | | target.Overview = source.Overview; |
| | | 1092 | | } |
| | | 1093 | | } |
| | | 1094 | | |
| | 132 | 1095 | | if (replaceData || !target.ParentIndexNumber.HasValue) |
| | | 1096 | | { |
| | 128 | 1097 | | target.ParentIndexNumber = source.ParentIndexNumber; |
| | | 1098 | | } |
| | | 1099 | | |
| | 132 | 1100 | | if (!lockedFields.Contains(MetadataField.Cast)) |
| | | 1101 | | { |
| | 131 | 1102 | | if (replaceData || targetResult.People is null || targetResult.People.Count == 0) |
| | | 1103 | | { |
| | 127 | 1104 | | targetResult.People = sourceResult.People; |
| | | 1105 | | } |
| | 4 | 1106 | | else if (sourceResult.People is not null && sourceResult.People.Count > 0) |
| | | 1107 | | { |
| | 4 | 1108 | | MergePeople(sourceResult.People, targetResult.People); |
| | | 1109 | | } |
| | | 1110 | | } |
| | | 1111 | | |
| | 132 | 1112 | | if (replaceData || !target.PremiereDate.HasValue) |
| | | 1113 | | { |
| | 131 | 1114 | | target.PremiereDate = source.PremiereDate; |
| | | 1115 | | } |
| | | 1116 | | |
| | 132 | 1117 | | if (replaceData || !target.ProductionYear.HasValue) |
| | | 1118 | | { |
| | 131 | 1119 | | target.ProductionYear = source.ProductionYear; |
| | | 1120 | | } |
| | | 1121 | | |
| | 132 | 1122 | | if (!lockedFields.Contains(MetadataField.Runtime)) |
| | | 1123 | | { |
| | 132 | 1124 | | if (replaceData || !target.RunTimeTicks.HasValue) |
| | | 1125 | | { |
| | 132 | 1126 | | if (target is not Audio && target is not Video) |
| | | 1127 | | { |
| | 49 | 1128 | | target.RunTimeTicks = source.RunTimeTicks; |
| | | 1129 | | } |
| | | 1130 | | } |
| | | 1131 | | } |
| | | 1132 | | |
| | 132 | 1133 | | if (!lockedFields.Contains(MetadataField.Studios)) |
| | | 1134 | | { |
| | 130 | 1135 | | if (replaceData || target.Studios.Length == 0) |
| | | 1136 | | { |
| | 129 | 1137 | | target.Studios = source.Studios; |
| | | 1138 | | } |
| | | 1139 | | else |
| | | 1140 | | { |
| | 1 | 1141 | | target.Studios = target.Studios.Concat(source.Studios).Distinct(StringComparer.OrdinalIgnoreCase).To |
| | | 1142 | | } |
| | | 1143 | | } |
| | | 1144 | | |
| | 132 | 1145 | | if (!lockedFields.Contains(MetadataField.Tags)) |
| | | 1146 | | { |
| | 130 | 1147 | | if (replaceData || target.Tags.Length == 0) |
| | | 1148 | | { |
| | 129 | 1149 | | target.Tags = source.Tags; |
| | | 1150 | | } |
| | | 1151 | | else |
| | | 1152 | | { |
| | 1 | 1153 | | target.Tags = target.Tags.Concat(source.Tags).Distinct(StringComparer.OrdinalIgnoreCase).ToArray(); |
| | | 1154 | | } |
| | | 1155 | | } |
| | | 1156 | | |
| | 132 | 1157 | | if (!lockedFields.Contains(MetadataField.ProductionLocations)) |
| | | 1158 | | { |
| | 130 | 1159 | | if (replaceData || target.ProductionLocations.Length == 0) |
| | | 1160 | | { |
| | 129 | 1161 | | target.ProductionLocations = source.ProductionLocations; |
| | | 1162 | | } |
| | | 1163 | | else |
| | | 1164 | | { |
| | 1 | 1165 | | target.ProductionLocations = target.ProductionLocations.Concat(source.ProductionLocations).Distinct( |
| | | 1166 | | } |
| | | 1167 | | } |
| | | 1168 | | |
| | 272 | 1169 | | foreach (var id in source.ProviderIds) |
| | | 1170 | | { |
| | 4 | 1171 | | var key = id.Key; |
| | | 1172 | | |
| | | 1173 | | // Don't replace existing Id's. |
| | 4 | 1174 | | if (replaceData) |
| | | 1175 | | { |
| | 1 | 1176 | | target.ProviderIds[key] = id.Value; |
| | | 1177 | | } |
| | | 1178 | | else |
| | | 1179 | | { |
| | 3 | 1180 | | target.ProviderIds.TryAdd(key, id.Value); |
| | | 1181 | | } |
| | | 1182 | | } |
| | | 1183 | | |
| | 132 | 1184 | | if (replaceData || !target.CriticRating.HasValue) |
| | | 1185 | | { |
| | 131 | 1186 | | target.CriticRating = source.CriticRating; |
| | | 1187 | | } |
| | | 1188 | | |
| | 132 | 1189 | | if (replaceData || target.RemoteTrailers.Count == 0) |
| | | 1190 | | { |
| | 131 | 1191 | | target.RemoteTrailers = source.RemoteTrailers; |
| | | 1192 | | } |
| | | 1193 | | else |
| | | 1194 | | { |
| | 1 | 1195 | | target.RemoteTrailers = target.RemoteTrailers.Concat(source.RemoteTrailers).DistinctBy(t => t.Url).ToArr |
| | | 1196 | | } |
| | | 1197 | | |
| | 132 | 1198 | | MergeAlbumArtist(source, target, replaceData); |
| | 132 | 1199 | | MergeVideoInfo(source, target, replaceData); |
| | 132 | 1200 | | MergeDisplayOrder(source, target, replaceData); |
| | | 1201 | | |
| | 132 | 1202 | | if (replaceData || string.IsNullOrEmpty(target.ForcedSortName)) |
| | | 1203 | | { |
| | 131 | 1204 | | var forcedSortName = source.ForcedSortName; |
| | 131 | 1205 | | if (!string.IsNullOrEmpty(forcedSortName)) |
| | | 1206 | | { |
| | 3 | 1207 | | target.ForcedSortName = forcedSortName; |
| | | 1208 | | } |
| | | 1209 | | } |
| | | 1210 | | |
| | 132 | 1211 | | if (mergeMetadataSettings) |
| | | 1212 | | { |
| | 4 | 1213 | | if (replaceData || !target.IsLocked) |
| | | 1214 | | { |
| | 4 | 1215 | | target.IsLocked = target.IsLocked || source.IsLocked; |
| | | 1216 | | } |
| | | 1217 | | |
| | 4 | 1218 | | if (target.LockedFields.Length == 0) |
| | | 1219 | | { |
| | 2 | 1220 | | target.LockedFields = source.LockedFields; |
| | | 1221 | | } |
| | | 1222 | | else |
| | | 1223 | | { |
| | 2 | 1224 | | target.LockedFields = target.LockedFields.Concat(source.LockedFields).Distinct().ToArray(); |
| | | 1225 | | } |
| | | 1226 | | |
| | 4 | 1227 | | if (source.DateCreated != DateTime.MinValue) |
| | | 1228 | | { |
| | 1 | 1229 | | target.DateCreated = source.DateCreated; |
| | | 1230 | | } |
| | | 1231 | | |
| | 4 | 1232 | | if (replaceData || source.DateModified != DateTime.MinValue) |
| | | 1233 | | { |
| | 2 | 1234 | | target.DateModified = source.DateModified; |
| | | 1235 | | } |
| | | 1236 | | |
| | 4 | 1237 | | if (replaceData || string.IsNullOrEmpty(target.PreferredMetadataCountryCode)) |
| | | 1238 | | { |
| | 4 | 1239 | | target.PreferredMetadataCountryCode = source.PreferredMetadataCountryCode; |
| | | 1240 | | } |
| | | 1241 | | |
| | 4 | 1242 | | if (replaceData || string.IsNullOrEmpty(target.PreferredMetadataLanguage)) |
| | | 1243 | | { |
| | 4 | 1244 | | target.PreferredMetadataLanguage = source.PreferredMetadataLanguage; |
| | | 1245 | | } |
| | | 1246 | | } |
| | 132 | 1247 | | } |
| | | 1248 | | |
| | | 1249 | | private static void MergePeople(IReadOnlyList<PersonInfo> source, IReadOnlyList<PersonInfo> target) |
| | | 1250 | | { |
| | 4 | 1251 | | var sourceByName = source.ToLookup(p => p.Name.RemoveDiacritics(), StringComparer.OrdinalIgnoreCase); |
| | 4 | 1252 | | var targetByName = target.ToLookup(p => p.Name.RemoveDiacritics(), StringComparer.OrdinalIgnoreCase); |
| | | 1253 | | |
| | 16 | 1254 | | foreach (var name in targetByName.Select(g => g.Key)) |
| | | 1255 | | { |
| | 4 | 1256 | | var targetPeople = targetByName[name].ToArray(); |
| | 4 | 1257 | | var sourcePeople = sourceByName[name].ToArray(); |
| | | 1258 | | |
| | 4 | 1259 | | if (sourcePeople.Length == 0) |
| | | 1260 | | { |
| | | 1261 | | continue; |
| | | 1262 | | } |
| | | 1263 | | |
| | 12 | 1264 | | for (int i = 0; i < targetPeople.Length; i++) |
| | | 1265 | | { |
| | 3 | 1266 | | var person = targetPeople[i]; |
| | 3 | 1267 | | var personInSource = i < sourcePeople.Length ? sourcePeople[i] : sourcePeople[0]; |
| | | 1268 | | |
| | 10 | 1269 | | foreach (var providerId in personInSource.ProviderIds) |
| | | 1270 | | { |
| | 2 | 1271 | | person.ProviderIds.TryAdd(providerId.Key, providerId.Value); |
| | | 1272 | | } |
| | | 1273 | | |
| | 3 | 1274 | | if (string.IsNullOrWhiteSpace(person.ImageUrl)) |
| | | 1275 | | { |
| | 2 | 1276 | | person.ImageUrl = personInSource.ImageUrl; |
| | | 1277 | | } |
| | | 1278 | | |
| | 3 | 1279 | | if (!string.IsNullOrWhiteSpace(personInSource.Role) && string.IsNullOrWhiteSpace(person.Role)) |
| | | 1280 | | { |
| | 0 | 1281 | | person.Role = personInSource.Role; |
| | | 1282 | | } |
| | | 1283 | | |
| | 3 | 1284 | | if (personInSource.SortOrder.HasValue && !person.SortOrder.HasValue) |
| | | 1285 | | { |
| | 0 | 1286 | | person.SortOrder = personInSource.SortOrder; |
| | | 1287 | | } |
| | | 1288 | | } |
| | | 1289 | | } |
| | 4 | 1290 | | } |
| | | 1291 | | |
| | | 1292 | | private static void MergeDisplayOrder(BaseItem source, BaseItem target, bool replaceData) |
| | | 1293 | | { |
| | 132 | 1294 | | if (source is IHasDisplayOrder sourceHasDisplayOrder |
| | 132 | 1295 | | && target is IHasDisplayOrder targetHasDisplayOrder) |
| | | 1296 | | { |
| | 49 | 1297 | | if (replaceData || string.IsNullOrEmpty(targetHasDisplayOrder.DisplayOrder)) |
| | | 1298 | | { |
| | 48 | 1299 | | var displayOrder = sourceHasDisplayOrder.DisplayOrder; |
| | 48 | 1300 | | if (!string.IsNullOrWhiteSpace(displayOrder)) |
| | | 1301 | | { |
| | 3 | 1302 | | targetHasDisplayOrder.DisplayOrder = displayOrder; |
| | | 1303 | | } |
| | | 1304 | | } |
| | | 1305 | | } |
| | 132 | 1306 | | } |
| | | 1307 | | |
| | | 1308 | | private static void MergeAlbumArtist(BaseItem source, BaseItem target, bool replaceData) |
| | | 1309 | | { |
| | 132 | 1310 | | if (source is IHasAlbumArtist sourceHasAlbumArtist |
| | 132 | 1311 | | && target is IHasAlbumArtist targetHasAlbumArtist) |
| | | 1312 | | { |
| | 28 | 1313 | | if (replaceData || targetHasAlbumArtist.AlbumArtists.Count == 0) |
| | | 1314 | | { |
| | 27 | 1315 | | targetHasAlbumArtist.AlbumArtists = sourceHasAlbumArtist.AlbumArtists; |
| | | 1316 | | } |
| | 1 | 1317 | | else if (sourceHasAlbumArtist.AlbumArtists.Count > 0) |
| | | 1318 | | { |
| | 1 | 1319 | | targetHasAlbumArtist.AlbumArtists = targetHasAlbumArtist.AlbumArtists.Concat(sourceHasAlbumArtist.Al |
| | | 1320 | | } |
| | | 1321 | | } |
| | 105 | 1322 | | } |
| | | 1323 | | |
| | | 1324 | | private static void MergeVideoInfo(BaseItem source, BaseItem target, bool replaceData) |
| | | 1325 | | { |
| | 132 | 1326 | | if (source is Video sourceCast && target is Video targetCast) |
| | | 1327 | | { |
| | 55 | 1328 | | if (sourceCast.Video3DFormat.HasValue && (replaceData || !targetCast.Video3DFormat.HasValue)) |
| | | 1329 | | { |
| | 2 | 1330 | | targetCast.Video3DFormat = sourceCast.Video3DFormat; |
| | | 1331 | | } |
| | | 1332 | | } |
| | 132 | 1333 | | } |
| | | 1334 | | } |
| | | 1335 | | } |