| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Globalization; |
| | | 4 | | using System.IO; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Text.Json; |
| | | 7 | | using System.Threading; |
| | | 8 | | using System.Threading.Tasks; |
| | | 9 | | using Jellyfin.Data.Enums; |
| | | 10 | | using Jellyfin.Database.Implementations; |
| | | 11 | | using Jellyfin.Database.Implementations.Entities; |
| | | 12 | | using Jellyfin.Database.Implementations.Enums; |
| | | 13 | | using Jellyfin.Extensions; |
| | | 14 | | using Jellyfin.Extensions.Json; |
| | | 15 | | using MediaBrowser.Common.Extensions; |
| | | 16 | | using MediaBrowser.Controller; |
| | | 17 | | using MediaBrowser.Controller.Configuration; |
| | | 18 | | using MediaBrowser.Controller.Dto; |
| | | 19 | | using MediaBrowser.Controller.Entities; |
| | | 20 | | using MediaBrowser.Controller.Library; |
| | | 21 | | using MediaBrowser.Controller.Persistence; |
| | | 22 | | using MediaBrowser.Model.Configuration; |
| | | 23 | | using MediaBrowser.Model.Dto; |
| | | 24 | | using MediaBrowser.Model.Entities; |
| | | 25 | | using MediaBrowser.Model.IO; |
| | | 26 | | using MediaBrowser.Model.Querying; |
| | | 27 | | using Microsoft.EntityFrameworkCore; |
| | | 28 | | using Microsoft.Extensions.Logging; |
| | | 29 | | |
| | | 30 | | namespace Emby.Server.Implementations.Library.SimilarItems; |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// Manages similar items providers and orchestrates similar items operations. |
| | | 34 | | /// </summary> |
| | | 35 | | public class SimilarItemsManager : ISimilarItemsManager |
| | | 36 | | { |
| | | 37 | | private readonly ILogger<SimilarItemsManager> _logger; |
| | | 38 | | private readonly IServerApplicationPaths _appPaths; |
| | | 39 | | private readonly ILibraryManager _libraryManager; |
| | | 40 | | private readonly IFileSystem _fileSystem; |
| | | 41 | | private readonly IServerConfigurationManager _serverConfigurationManager; |
| | | 42 | | private readonly IDbContextFactory<JellyfinDbContext> _dbProvider; |
| | | 43 | | private readonly IItemQueryHelpers _queryHelpers; |
| | 27 | 44 | | private ISimilarItemsProvider[] _similarItemsProviders = []; |
| | | 45 | | |
| | | 46 | | /// <summary> |
| | | 47 | | /// Initializes a new instance of the <see cref="SimilarItemsManager"/> class. |
| | | 48 | | /// </summary> |
| | | 49 | | /// <param name="logger">The logger.</param> |
| | | 50 | | /// <param name="appPaths">The server application paths.</param> |
| | | 51 | | /// <param name="libraryManager">The library manager.</param> |
| | | 52 | | /// <param name="fileSystem">The file system.</param> |
| | | 53 | | /// <param name="serverConfigurationManager">The server configuration manager.</param> |
| | | 54 | | /// <param name="dbProvider">The database context factory.</param> |
| | | 55 | | /// <param name="queryHelpers">The shared item query helpers.</param> |
| | | 56 | | public SimilarItemsManager( |
| | | 57 | | ILogger<SimilarItemsManager> logger, |
| | | 58 | | IServerApplicationPaths appPaths, |
| | | 59 | | ILibraryManager libraryManager, |
| | | 60 | | IFileSystem fileSystem, |
| | | 61 | | IServerConfigurationManager serverConfigurationManager, |
| | | 62 | | IDbContextFactory<JellyfinDbContext> dbProvider, |
| | | 63 | | IItemQueryHelpers queryHelpers) |
| | | 64 | | { |
| | 27 | 65 | | _logger = logger; |
| | 27 | 66 | | _appPaths = appPaths; |
| | 27 | 67 | | _libraryManager = libraryManager; |
| | 27 | 68 | | _fileSystem = fileSystem; |
| | 27 | 69 | | _serverConfigurationManager = serverConfigurationManager; |
| | 27 | 70 | | _dbProvider = dbProvider; |
| | 27 | 71 | | _queryHelpers = queryHelpers; |
| | 27 | 72 | | } |
| | | 73 | | |
| | | 74 | | /// <inheritdoc/> |
| | | 75 | | public void AddParts(IEnumerable<ISimilarItemsProvider> providers) |
| | | 76 | | { |
| | 27 | 77 | | _similarItemsProviders = providers.ToArray(); |
| | 27 | 78 | | } |
| | | 79 | | |
| | | 80 | | /// <inheritdoc/> |
| | | 81 | | public IReadOnlyList<ISimilarItemsProvider> GetSimilarItemsProviders<T>() |
| | | 82 | | where T : BaseItem |
| | | 83 | | { |
| | 0 | 84 | | var itemType = typeof(T); |
| | 0 | 85 | | return _similarItemsProviders |
| | 0 | 86 | | .Where(p => (p is ILocalSimilarItemsProvider local && local.Supports(itemType)) |
| | 0 | 87 | | || (p is IRemoteSimilarItemsProvider remote && remote.Supports(itemType))) |
| | 0 | 88 | | .ToList(); |
| | | 89 | | } |
| | | 90 | | |
| | | 91 | | /// <inheritdoc/> |
| | | 92 | | public async Task<IReadOnlyList<BaseItem>> GetSimilarItemsAsync( |
| | | 93 | | BaseItem item, |
| | | 94 | | IReadOnlyList<Guid> excludeArtistIds, |
| | | 95 | | User? user, |
| | | 96 | | DtoOptions dtoOptions, |
| | | 97 | | int? limit, |
| | | 98 | | LibraryOptions? libraryOptions, |
| | | 99 | | CancellationToken cancellationToken) |
| | | 100 | | { |
| | 0 | 101 | | ArgumentNullException.ThrowIfNull(item); |
| | 0 | 102 | | ArgumentNullException.ThrowIfNull(excludeArtistIds); |
| | | 103 | | |
| | 0 | 104 | | var itemType = item.GetType(); |
| | 0 | 105 | | var requestedLimit = limit ?? 50; |
| | 0 | 106 | | var itemKind = item.GetBaseItemKind(); |
| | | 107 | | |
| | | 108 | | // Ensure ProviderIds is included in DtoOptions for matching remote provider responses |
| | 0 | 109 | | if (!dtoOptions.Fields.Contains(ItemFields.ProviderIds)) |
| | | 110 | | { |
| | 0 | 111 | | dtoOptions.Fields = dtoOptions.Fields.Concat([ItemFields.ProviderIds]).ToArray(); |
| | | 112 | | } |
| | | 113 | | |
| | | 114 | | // Local providers are always enabled. Remote providers must be explicitly enabled. |
| | 0 | 115 | | var localProviders = _similarItemsProviders |
| | 0 | 116 | | .OfType<ILocalSimilarItemsProvider>() |
| | 0 | 117 | | .Where(p => p.Supports(itemType)) |
| | 0 | 118 | | .ToList(); |
| | 0 | 119 | | var remoteProviders = _similarItemsProviders |
| | 0 | 120 | | .OfType<IRemoteSimilarItemsProvider>() |
| | 0 | 121 | | .Where(p => p.Supports(itemType)); |
| | 0 | 122 | | var matchingProviders = new List<ISimilarItemsProvider>(localProviders); |
| | | 123 | | |
| | 0 | 124 | | var typeOptions = libraryOptions?.GetTypeOptions(itemType.Name); |
| | 0 | 125 | | if (typeOptions?.SimilarItemProviders?.Length > 0) |
| | | 126 | | { |
| | 0 | 127 | | matchingProviders.AddRange(remoteProviders |
| | 0 | 128 | | .Where(p => typeOptions.SimilarItemProviders.Contains(p.Name, StringComparer.OrdinalIgnoreCase))); |
| | | 129 | | } |
| | | 130 | | |
| | 0 | 131 | | var orderConfig = typeOptions?.SimilarItemProviderOrder is { Length: > 0 } order |
| | 0 | 132 | | ? order |
| | 0 | 133 | | : typeOptions?.SimilarItemProviders; |
| | 0 | 134 | | var orderedProviders = matchingProviders |
| | 0 | 135 | | .OrderBy(p => GetConfiguredSimilarProviderOrder(orderConfig, p.Name)) |
| | 0 | 136 | | .ToList(); |
| | | 137 | | |
| | 0 | 138 | | var allResults = new List<(BaseItem Item, float Score)>(); |
| | 0 | 139 | | var excludeIds = new HashSet<Guid> { item.Id }; |
| | 0 | 140 | | var excludeKeys = new HashSet<string>(StringComparer.OrdinalIgnoreCase) { item.GetPresentationUniqueKey() }; |
| | 0 | 141 | | foreach (var (providerOrder, provider) in orderedProviders.Index()) |
| | | 142 | | { |
| | 0 | 143 | | if (allResults.Count >= requestedLimit || cancellationToken.IsCancellationRequested) |
| | | 144 | | { |
| | | 145 | | break; |
| | | 146 | | } |
| | | 147 | | |
| | | 148 | | try |
| | | 149 | | { |
| | 0 | 150 | | if (provider is ILocalSimilarItemsProvider localProvider) |
| | | 151 | | { |
| | 0 | 152 | | var query = new SimilarItemsQuery |
| | 0 | 153 | | { |
| | 0 | 154 | | User = user, |
| | 0 | 155 | | Limit = requestedLimit - allResults.Count, |
| | 0 | 156 | | DtoOptions = dtoOptions, |
| | 0 | 157 | | ExcludeItemIds = [.. excludeIds], |
| | 0 | 158 | | ExcludeArtistIds = excludeArtistIds |
| | 0 | 159 | | }; |
| | | 160 | | |
| | 0 | 161 | | var items = await localProvider.GetSimilarItemsAsync(item, query, cancellationToken).ConfigureAwait( |
| | | 162 | | |
| | 0 | 163 | | foreach (var (position, resultItem) in items.Index()) |
| | | 164 | | { |
| | 0 | 165 | | var isNewId = excludeIds.Add(resultItem.Id); |
| | 0 | 166 | | var isNewKey = excludeKeys.Add(resultItem.GetPresentationUniqueKey()); |
| | 0 | 167 | | if (isNewId && isNewKey) |
| | | 168 | | { |
| | 0 | 169 | | var score = CalculateScore(null, providerOrder, position); |
| | 0 | 170 | | allResults.Add((resultItem, score)); |
| | | 171 | | } |
| | | 172 | | } |
| | | 173 | | } |
| | 0 | 174 | | else if (provider is IRemoteSimilarItemsProvider remoteProvider) |
| | | 175 | | { |
| | 0 | 176 | | var cachePath = GetSimilarItemsCachePath(provider.Name, itemType.Name, item.Id); |
| | | 177 | | |
| | 0 | 178 | | var cachedReferences = await TryReadSimilarItemsCacheAsync(cachePath, cancellationToken).ConfigureAw |
| | 0 | 179 | | if (cachedReferences is not null) |
| | | 180 | | { |
| | 0 | 181 | | var resolvedItems = ResolveRemoteReferences(cachedReferences, providerOrder, user, dtoOptions, i |
| | 0 | 182 | | allResults.AddRange(resolvedItems); |
| | 0 | 183 | | continue; |
| | | 184 | | } |
| | | 185 | | |
| | 0 | 186 | | var query = new SimilarItemsQuery |
| | 0 | 187 | | { |
| | 0 | 188 | | User = user, |
| | 0 | 189 | | Limit = requestedLimit - allResults.Count, |
| | 0 | 190 | | DtoOptions = dtoOptions, |
| | 0 | 191 | | ExcludeItemIds = [.. excludeIds], |
| | 0 | 192 | | ExcludeArtistIds = excludeArtistIds |
| | 0 | 193 | | }; |
| | | 194 | | |
| | | 195 | | // Collect references in batches and resolve against local library. |
| | | 196 | | // Stop fetching once we have enough resolved local items. |
| | | 197 | | const int BatchSize = 20; |
| | | 198 | | const int MaxRemoteReferenceFetchLimit = 500; |
| | 0 | 199 | | var remaining = requestedLimit - allResults.Count; |
| | 0 | 200 | | var collectedReferences = new List<SimilarItemReference>(); |
| | 0 | 201 | | var pendingBatch = new List<SimilarItemReference>(); |
| | | 202 | | |
| | 0 | 203 | | await foreach (var reference in remoteProvider.GetSimilarItemsAsync(item, query, cancellationToken). |
| | | 204 | | { |
| | 0 | 205 | | collectedReferences.Add(reference); |
| | 0 | 206 | | pendingBatch.Add(reference); |
| | | 207 | | |
| | 0 | 208 | | if (pendingBatch.Count >= BatchSize) |
| | | 209 | | { |
| | 0 | 210 | | var resolvedItems = ResolveRemoteReferences(pendingBatch, providerOrder, user, dtoOptions, i |
| | 0 | 211 | | allResults.AddRange(resolvedItems); |
| | 0 | 212 | | remaining -= resolvedItems.Count; |
| | 0 | 213 | | pendingBatch.Clear(); |
| | | 214 | | |
| | 0 | 215 | | if (remaining <= 0 || collectedReferences.Count >= MaxRemoteReferenceFetchLimit) |
| | | 216 | | { |
| | | 217 | | break; |
| | | 218 | | } |
| | | 219 | | } |
| | | 220 | | } |
| | | 221 | | |
| | | 222 | | // Resolve any remaining references in the last partial batch |
| | 0 | 223 | | if (pendingBatch.Count > 0) |
| | | 224 | | { |
| | 0 | 225 | | var resolvedItems = ResolveRemoteReferences(pendingBatch, providerOrder, user, dtoOptions, itemK |
| | 0 | 226 | | allResults.AddRange(resolvedItems); |
| | | 227 | | } |
| | | 228 | | |
| | 0 | 229 | | if (collectedReferences.Count > 0 && provider.CacheDuration is not null) |
| | | 230 | | { |
| | 0 | 231 | | await SaveSimilarItemsCacheAsync(cachePath, collectedReferences, provider.CacheDuration.Value, c |
| | | 232 | | } |
| | 0 | 233 | | } |
| | 0 | 234 | | } |
| | 0 | 235 | | catch (OperationCanceledException) |
| | | 236 | | { |
| | 0 | 237 | | break; |
| | | 238 | | } |
| | 0 | 239 | | catch (Exception ex) |
| | | 240 | | { |
| | 0 | 241 | | _logger.LogWarning(ex, "Similar items provider {ProviderName} failed for item {ItemId}", provider.Name, |
| | 0 | 242 | | } |
| | 0 | 243 | | } |
| | | 244 | | |
| | 0 | 245 | | var ordered = allResults |
| | 0 | 246 | | .OrderByDescending(x => x.Score) |
| | 0 | 247 | | .Select(x => x.Item) |
| | 0 | 248 | | .Take(requestedLimit) |
| | 0 | 249 | | .ToList(); |
| | | 250 | | |
| | 0 | 251 | | return await FilterByLibraryAccessAsync(ordered, user, cancellationToken).ConfigureAwait(false); |
| | 0 | 252 | | } |
| | | 253 | | |
| | | 254 | | private async Task<IReadOnlyList<BaseItem>> FilterByLibraryAccessAsync( |
| | | 255 | | IReadOnlyList<BaseItem> candidates, |
| | | 256 | | User? user, |
| | | 257 | | CancellationToken cancellationToken) |
| | | 258 | | { |
| | 0 | 259 | | if (candidates.Count == 0 || user is null) |
| | | 260 | | { |
| | 0 | 261 | | return candidates; |
| | | 262 | | } |
| | | 263 | | |
| | 0 | 264 | | var accessFilter = SimilarItemsAccessFilter.Build(user, _libraryManager); |
| | | 265 | | |
| | | 266 | | // No accessible libraries means nothing to compare against, and an empty TopParentIds set |
| | | 267 | | // would disable the filter rather than reject everything. |
| | 0 | 268 | | if (accessFilter.TopParentIds.Length == 0) |
| | | 269 | | { |
| | 0 | 270 | | return candidates; |
| | | 271 | | } |
| | | 272 | | |
| | 0 | 273 | | Guid[] candidateIds = [.. candidates.Select(c => c.Id)]; |
| | | 274 | | |
| | 0 | 275 | | var dbContext = await _dbProvider.CreateDbContextAsync(cancellationToken).ConfigureAwait(false); |
| | 0 | 276 | | await using (dbContext.ConfigureAwait(false)) |
| | | 277 | | { |
| | 0 | 278 | | var baseQuery = dbContext.BaseItems |
| | 0 | 279 | | .AsNoTracking() |
| | 0 | 280 | | .WhereOneOrMany(candidateIds, e => e.Id); |
| | | 281 | | |
| | 0 | 282 | | baseQuery = _queryHelpers.ApplyAccessFiltering(dbContext, baseQuery, accessFilter); |
| | | 283 | | |
| | 0 | 284 | | var allowedCount = await baseQuery.CountAsync(cancellationToken).ConfigureAwait(false); |
| | 0 | 285 | | if (allowedCount == candidates.Count) |
| | | 286 | | { |
| | 0 | 287 | | return candidates; |
| | | 288 | | } |
| | | 289 | | |
| | 0 | 290 | | var allowedIds = await baseQuery |
| | 0 | 291 | | .Select(e => e.Id) |
| | 0 | 292 | | .ToHashSetAsync(cancellationToken) |
| | 0 | 293 | | .ConfigureAwait(false); |
| | | 294 | | |
| | 0 | 295 | | var filtered = candidates.Where(c => allowedIds.Contains(c.Id)).ToList(); |
| | 0 | 296 | | _logger.LogDebug( |
| | 0 | 297 | | "Dropped {Dropped} of {Total} similar-item candidates due to user access filtering", |
| | 0 | 298 | | candidates.Count - filtered.Count, |
| | 0 | 299 | | candidates.Count); |
| | | 300 | | |
| | 0 | 301 | | return filtered; |
| | | 302 | | } |
| | 0 | 303 | | } |
| | | 304 | | |
| | | 305 | | /// <inheritdoc/> |
| | | 306 | | public async Task<IReadOnlyList<SimilarItemsRecommendation>> GetMovieRecommendationsAsync( |
| | | 307 | | User? user, |
| | | 308 | | Guid parentId, |
| | | 309 | | int categoryLimit, |
| | | 310 | | int itemLimit, |
| | | 311 | | DtoOptions dtoOptions, |
| | | 312 | | CancellationToken cancellationToken) |
| | | 313 | | { |
| | 0 | 314 | | ArgumentNullException.ThrowIfNull(dtoOptions); |
| | | 315 | | |
| | 0 | 316 | | var recentlyPlayedMovies = _libraryManager.GetItemList(new InternalItemsQuery(user) |
| | 0 | 317 | | { |
| | 0 | 318 | | IncludeItemTypes = [BaseItemKind.Movie], |
| | 0 | 319 | | OrderBy = [(ItemSortBy.DatePlayed, SortOrder.Descending), (ItemSortBy.Random, SortOrder.Descending)], |
| | 0 | 320 | | Limit = 7, |
| | 0 | 321 | | ParentId = parentId, |
| | 0 | 322 | | Recursive = true, |
| | 0 | 323 | | IsPlayed = true, |
| | 0 | 324 | | EnableGroupByMetadataKey = true, |
| | 0 | 325 | | DtoOptions = dtoOptions |
| | 0 | 326 | | }); |
| | | 327 | | |
| | 0 | 328 | | var itemTypes = new List<BaseItemKind> { BaseItemKind.Movie }; |
| | 0 | 329 | | if (_serverConfigurationManager.Configuration.EnableExternalContentInSuggestions) |
| | | 330 | | { |
| | 0 | 331 | | itemTypes.Add(BaseItemKind.Trailer); |
| | 0 | 332 | | itemTypes.Add(BaseItemKind.LiveTvProgram); |
| | | 333 | | } |
| | | 334 | | |
| | 0 | 335 | | var likedMovies = _libraryManager.GetItemList(new InternalItemsQuery(user) |
| | 0 | 336 | | { |
| | 0 | 337 | | IncludeItemTypes = itemTypes.ToArray(), |
| | 0 | 338 | | IsMovie = true, |
| | 0 | 339 | | OrderBy = [(ItemSortBy.Random, SortOrder.Descending)], |
| | 0 | 340 | | Limit = 10, |
| | 0 | 341 | | IsFavoriteOrLiked = true, |
| | 0 | 342 | | ExcludeItemIds = recentlyPlayedMovies.Select(i => i.Id).ToArray(), |
| | 0 | 343 | | EnableGroupByMetadataKey = true, |
| | 0 | 344 | | ParentId = parentId, |
| | 0 | 345 | | Recursive = true, |
| | 0 | 346 | | DtoOptions = dtoOptions |
| | 0 | 347 | | }); |
| | | 348 | | |
| | 0 | 349 | | var mostRecentMovies = recentlyPlayedMovies.Take(Math.Min(recentlyPlayedMovies.Count, 6)).ToList(); |
| | 0 | 350 | | var recentDirectors = GetPeopleNames(mostRecentMovies, [PersonType.Director]); |
| | 0 | 351 | | var recentActors = GetPeopleNames(mostRecentMovies, [PersonType.Actor, PersonType.GuestStar]); |
| | | 352 | | |
| | | 353 | | // Cap baseline items to categoryLimit - the round-robin can't use more categories than that. |
| | 0 | 354 | | var recentlyPlayedBaseline = recentlyPlayedMovies.Count > categoryLimit |
| | 0 | 355 | | ? recentlyPlayedMovies.Take(categoryLimit).ToList() |
| | 0 | 356 | | : recentlyPlayedMovies; |
| | 0 | 357 | | var likedBaseline = likedMovies.Count > categoryLimit |
| | 0 | 358 | | ? likedMovies.Take(categoryLimit).ToList() |
| | 0 | 359 | | : likedMovies; |
| | | 360 | | |
| | 0 | 361 | | var batchQuery = new SimilarItemsQuery |
| | 0 | 362 | | { |
| | 0 | 363 | | User = user, |
| | 0 | 364 | | Limit = itemLimit, |
| | 0 | 365 | | DtoOptions = dtoOptions |
| | 0 | 366 | | }; |
| | | 367 | | |
| | 0 | 368 | | var similarToRecentlyPlayed = await GetSimilarItemsRecommendationsAsync( |
| | 0 | 369 | | recentlyPlayedBaseline, |
| | 0 | 370 | | RecommendationType.SimilarToRecentlyPlayed, |
| | 0 | 371 | | batchQuery, |
| | 0 | 372 | | cancellationToken).ConfigureAwait(false); |
| | | 373 | | |
| | 0 | 374 | | var similarToLiked = await GetSimilarItemsRecommendationsAsync( |
| | 0 | 375 | | likedBaseline, |
| | 0 | 376 | | RecommendationType.SimilarToLikedItem, |
| | 0 | 377 | | batchQuery, |
| | 0 | 378 | | cancellationToken).ConfigureAwait(false); |
| | | 379 | | |
| | 0 | 380 | | var hasDirectorFromRecentlyPlayed = GetPersonRecommendations(user, recentDirectors, itemLimit, dtoOptions, Recom |
| | 0 | 381 | | var hasActorFromRecentlyPlayed = GetPersonRecommendations(user, recentActors, itemLimit, dtoOptions, Recommendat |
| | | 382 | | |
| | | 383 | | // Use a single enumerator per list, listed twice so MoveNext advances it |
| | | 384 | | // twice per round-robin pass (giving these categories double weight). |
| | | 385 | | // IMPORTANT: Declare as IEnumerator<T> to box the List<T>.Enumerator struct once; |
| | | 386 | | // using var would box separately per list insertion, creating independent copies. |
| | 0 | 387 | | IEnumerator<SimilarItemsRecommendation> similarToRecentlyPlayedEnum = similarToRecentlyPlayed.GetEnumerator(); |
| | 0 | 388 | | IEnumerator<SimilarItemsRecommendation> similarToLikedEnum = similarToLiked.GetEnumerator(); |
| | | 389 | | |
| | 0 | 390 | | var categoryTypes = new List<IEnumerator<SimilarItemsRecommendation>> |
| | 0 | 391 | | { |
| | 0 | 392 | | similarToRecentlyPlayedEnum, |
| | 0 | 393 | | similarToRecentlyPlayedEnum, |
| | 0 | 394 | | similarToLikedEnum, |
| | 0 | 395 | | similarToLikedEnum, |
| | 0 | 396 | | hasDirectorFromRecentlyPlayed.GetEnumerator(), |
| | 0 | 397 | | hasActorFromRecentlyPlayed.GetEnumerator() |
| | 0 | 398 | | }; |
| | | 399 | | |
| | 0 | 400 | | var categories = new List<SimilarItemsRecommendation>(); |
| | 0 | 401 | | while (categories.Count < categoryLimit) |
| | | 402 | | { |
| | 0 | 403 | | var allEmpty = true; |
| | 0 | 404 | | foreach (var category in categoryTypes) |
| | | 405 | | { |
| | 0 | 406 | | if (category.MoveNext()) |
| | | 407 | | { |
| | 0 | 408 | | categories.Add(category.Current); |
| | 0 | 409 | | allEmpty = false; |
| | | 410 | | |
| | 0 | 411 | | if (categories.Count >= categoryLimit) |
| | | 412 | | { |
| | | 413 | | break; |
| | | 414 | | } |
| | | 415 | | } |
| | | 416 | | } |
| | | 417 | | |
| | 0 | 418 | | if (allEmpty) |
| | | 419 | | { |
| | | 420 | | break; |
| | | 421 | | } |
| | | 422 | | } |
| | | 423 | | |
| | 0 | 424 | | return [.. categories.OrderBy(i => i.RecommendationType)]; |
| | 0 | 425 | | } |
| | | 426 | | |
| | | 427 | | private async Task<IReadOnlyList<SimilarItemsRecommendation>> GetSimilarItemsRecommendationsAsync( |
| | | 428 | | IReadOnlyList<BaseItem> baselineItems, |
| | | 429 | | RecommendationType recommendationType, |
| | | 430 | | SimilarItemsQuery query, |
| | | 431 | | CancellationToken cancellationToken) |
| | | 432 | | { |
| | 0 | 433 | | var batchProvider = _similarItemsProviders |
| | 0 | 434 | | .OfType<IBatchLocalSimilarItemsProvider>() |
| | 0 | 435 | | .FirstOrDefault(); |
| | | 436 | | |
| | 0 | 437 | | if (batchProvider is null || baselineItems.Count == 0) |
| | | 438 | | { |
| | 0 | 439 | | return []; |
| | | 440 | | } |
| | | 441 | | |
| | 0 | 442 | | var batchResults = await batchProvider.GetBatchSimilarItemsAsync(baselineItems, query, cancellationToken).Config |
| | | 443 | | |
| | | 444 | | // Filter once across every category rather than per baseline, so a batch provider costs one |
| | | 445 | | // access query no matter how many categories it produced. |
| | 0 | 446 | | var allItems = batchResults.Values.SelectMany(items => items).DistinctBy(item => item.Id).ToList(); |
| | 0 | 447 | | var allowed = await FilterByLibraryAccessAsync(allItems, query.User, cancellationToken).ConfigureAwait(false); |
| | | 448 | | |
| | 0 | 449 | | HashSet<Guid>? allowedIds = allowed.Count == allItems.Count |
| | 0 | 450 | | ? null |
| | 0 | 451 | | : [.. allowed.Select(item => item.Id)]; |
| | | 452 | | |
| | 0 | 453 | | var recommendations = new List<SimilarItemsRecommendation>(baselineItems.Count); |
| | 0 | 454 | | foreach (var baseline in baselineItems) |
| | | 455 | | { |
| | 0 | 456 | | if (!batchResults.TryGetValue(baseline.Id, out var similar) || similar.Count == 0) |
| | | 457 | | { |
| | | 458 | | continue; |
| | | 459 | | } |
| | | 460 | | |
| | 0 | 461 | | if (allowedIds is not null) |
| | | 462 | | { |
| | 0 | 463 | | similar = similar.Where(item => allowedIds.Contains(item.Id)).ToList(); |
| | 0 | 464 | | if (similar.Count == 0) |
| | | 465 | | { |
| | | 466 | | continue; |
| | | 467 | | } |
| | | 468 | | } |
| | | 469 | | |
| | 0 | 470 | | recommendations.Add(new SimilarItemsRecommendation |
| | 0 | 471 | | { |
| | 0 | 472 | | BaselineItemName = baseline.Name, |
| | 0 | 473 | | CategoryId = baseline.Id, |
| | 0 | 474 | | RecommendationType = recommendationType, |
| | 0 | 475 | | Items = similar |
| | 0 | 476 | | }); |
| | | 477 | | } |
| | | 478 | | |
| | 0 | 479 | | return recommendations; |
| | 0 | 480 | | } |
| | | 481 | | |
| | | 482 | | private IEnumerable<SimilarItemsRecommendation> GetPersonRecommendations( |
| | | 483 | | User? user, |
| | | 484 | | IReadOnlyList<string> names, |
| | | 485 | | int itemLimit, |
| | | 486 | | DtoOptions dtoOptions, |
| | | 487 | | RecommendationType type, |
| | | 488 | | IReadOnlyList<BaseItemKind> itemTypes) |
| | | 489 | | { |
| | 0 | 490 | | var personTypes = type == RecommendationType.HasDirectorFromRecentlyPlayed |
| | 0 | 491 | | ? [PersonType.Director] |
| | 0 | 492 | | : Array.Empty<string>(); |
| | | 493 | | |
| | 0 | 494 | | foreach (var name in names) |
| | | 495 | | { |
| | 0 | 496 | | var items = _libraryManager.GetItemList(new InternalItemsQuery(user) |
| | 0 | 497 | | { |
| | 0 | 498 | | Person = name, |
| | 0 | 499 | | Limit = itemLimit + 2, |
| | 0 | 500 | | PersonTypes = personTypes, |
| | 0 | 501 | | IncludeItemTypes = itemTypes.ToArray(), |
| | 0 | 502 | | IsMovie = true, |
| | 0 | 503 | | IsPlayed = false, |
| | 0 | 504 | | EnableGroupByMetadataKey = true, |
| | 0 | 505 | | DtoOptions = dtoOptions |
| | 0 | 506 | | }) |
| | 0 | 507 | | .DistinctBy(i => i.GetProviderId(MetadataProvider.Imdb) ?? Guid.NewGuid().ToString("N", CultureInfo.Inva |
| | 0 | 508 | | .Take(itemLimit) |
| | 0 | 509 | | .ToList(); |
| | | 510 | | |
| | 0 | 511 | | if (items.Count > 0) |
| | | 512 | | { |
| | 0 | 513 | | yield return new SimilarItemsRecommendation |
| | 0 | 514 | | { |
| | 0 | 515 | | BaselineItemName = name, |
| | 0 | 516 | | CategoryId = name.GetMD5(), |
| | 0 | 517 | | RecommendationType = type, |
| | 0 | 518 | | Items = items |
| | 0 | 519 | | }; |
| | | 520 | | } |
| | | 521 | | } |
| | 0 | 522 | | } |
| | | 523 | | |
| | | 524 | | private IReadOnlyList<string> GetPeopleNames(IReadOnlyList<BaseItem> items, IReadOnlyList<string> personTypes) |
| | | 525 | | { |
| | 0 | 526 | | var itemIds = items.Select(i => i.Id).ToArray(); |
| | 0 | 527 | | return _libraryManager.GetPeopleNamesByItems(itemIds, personTypes) |
| | 0 | 528 | | .Values |
| | 0 | 529 | | .SelectMany(names => names) |
| | 0 | 530 | | .Distinct() |
| | 0 | 531 | | .ToArray(); |
| | | 532 | | } |
| | | 533 | | |
| | | 534 | | private List<(BaseItem Item, float Score)> ResolveRemoteReferences( |
| | | 535 | | IReadOnlyList<SimilarItemReference> references, |
| | | 536 | | int providerOrder, |
| | | 537 | | User? user, |
| | | 538 | | DtoOptions dtoOptions, |
| | | 539 | | BaseItemKind itemKind, |
| | | 540 | | HashSet<Guid> excludeIds, |
| | | 541 | | HashSet<string> excludeKeys) |
| | | 542 | | { |
| | 0 | 543 | | if (references.Count == 0) |
| | | 544 | | { |
| | 0 | 545 | | return []; |
| | | 546 | | } |
| | | 547 | | |
| | 0 | 548 | | var resolvedByKey = new Dictionary<string, (BaseItem Item, float Score)>(StringComparer.OrdinalIgnoreCase); |
| | 0 | 549 | | var providerLookup = new Dictionary<(string ProviderName, string ProviderId), (float? Score, int Position)>(Stri |
| | | 550 | | |
| | 0 | 551 | | foreach (var (position, match) in references.Index()) |
| | | 552 | | { |
| | 0 | 553 | | var lookupKey = (match.ProviderName, match.ProviderId); |
| | 0 | 554 | | if (!providerLookup.TryGetValue(lookupKey, out var existing)) |
| | | 555 | | { |
| | 0 | 556 | | providerLookup[lookupKey] = (match.Score, position); |
| | | 557 | | } |
| | 0 | 558 | | else if (match.Score > existing.Score || (match.Score == existing.Score && position < existing.Position)) |
| | | 559 | | { |
| | 0 | 560 | | providerLookup[lookupKey] = (match.Score, position); |
| | | 561 | | } |
| | | 562 | | } |
| | | 563 | | |
| | 0 | 564 | | var allProviderIds = providerLookup |
| | 0 | 565 | | .GroupBy(kvp => kvp.Key.ProviderName) |
| | 0 | 566 | | .ToDictionary(g => g.Key, g => g.Select(x => x.Key.ProviderId).ToArray()); |
| | | 567 | | |
| | 0 | 568 | | var query = new InternalItemsQuery(user) |
| | 0 | 569 | | { |
| | 0 | 570 | | HasAnyProviderIds = allProviderIds, |
| | 0 | 571 | | IncludeItemTypes = [itemKind], |
| | 0 | 572 | | DtoOptions = dtoOptions |
| | 0 | 573 | | }; |
| | | 574 | | |
| | 0 | 575 | | var items = _libraryManager.GetItemList(query); |
| | | 576 | | |
| | 0 | 577 | | foreach (var item in items) |
| | | 578 | | { |
| | 0 | 579 | | if (excludeIds.Contains(item.Id)) |
| | | 580 | | { |
| | | 581 | | continue; |
| | | 582 | | } |
| | | 583 | | |
| | 0 | 584 | | var presentationKey = item.GetPresentationUniqueKey(); |
| | 0 | 585 | | if (excludeKeys.Contains(presentationKey)) |
| | | 586 | | { |
| | | 587 | | continue; |
| | | 588 | | } |
| | | 589 | | |
| | 0 | 590 | | foreach (var providerName in allProviderIds.Keys) |
| | | 591 | | { |
| | 0 | 592 | | if (item.TryGetProviderId(providerName, out var itemProviderId) && providerLookup.TryGetValue((providerN |
| | | 593 | | { |
| | 0 | 594 | | var score = CalculateScore(matchInfo.Score, providerOrder, matchInfo.Position); |
| | 0 | 595 | | if (!resolvedByKey.TryGetValue(presentationKey, out var existing) || existing.Score < score) |
| | | 596 | | { |
| | 0 | 597 | | resolvedByKey[presentationKey] = (item, score); |
| | | 598 | | } |
| | | 599 | | |
| | 0 | 600 | | break; |
| | | 601 | | } |
| | | 602 | | } |
| | | 603 | | } |
| | | 604 | | |
| | 0 | 605 | | foreach (var (key, entry) in resolvedByKey) |
| | | 606 | | { |
| | 0 | 607 | | excludeIds.Add(entry.Item.Id); |
| | 0 | 608 | | excludeKeys.Add(key); |
| | | 609 | | } |
| | | 610 | | |
| | 0 | 611 | | return [.. resolvedByKey.Values]; |
| | | 612 | | } |
| | | 613 | | |
| | | 614 | | private static float CalculateScore(float? matchScore, int providerOrder, int position) |
| | | 615 | | { |
| | | 616 | | // Use provider-supplied score if available, otherwise derive from position |
| | 0 | 617 | | var baseScore = matchScore ?? (1.0f - (position * 0.02f)); |
| | | 618 | | |
| | | 619 | | // Apply small boost based on provider order (higher priority providers get small bonus) |
| | 0 | 620 | | var priorityBoost = Math.Max(0, 10 - providerOrder) * 0.005f; |
| | | 621 | | |
| | 0 | 622 | | return Math.Clamp(baseScore + priorityBoost, 0f, 1f); |
| | | 623 | | } |
| | | 624 | | |
| | | 625 | | private static int GetConfiguredSimilarProviderOrder(string[]? orderConfig, string providerName) |
| | | 626 | | { |
| | 0 | 627 | | if (orderConfig is null || orderConfig.Length == 0) |
| | | 628 | | { |
| | 0 | 629 | | return int.MaxValue; |
| | | 630 | | } |
| | | 631 | | |
| | 0 | 632 | | var index = Array.FindIndex(orderConfig, name => string.Equals(name, providerName, StringComparison.OrdinalIgnor |
| | 0 | 633 | | return index >= 0 ? index : int.MaxValue; |
| | | 634 | | } |
| | | 635 | | |
| | | 636 | | private string GetSimilarItemsCachePath(string providerName, string baseItemType, Guid itemId) |
| | | 637 | | { |
| | 0 | 638 | | var dataPath = Path.Combine( |
| | 0 | 639 | | _appPaths.CachePath, |
| | 0 | 640 | | $"{providerName.ToLowerInvariant()}-similar-{baseItemType.ToLowerInvariant()}"); |
| | 0 | 641 | | return Path.Combine(dataPath, $"{itemId.ToString("N", CultureInfo.InvariantCulture)}.json"); |
| | | 642 | | } |
| | | 643 | | |
| | | 644 | | private async Task<List<SimilarItemReference>?> TryReadSimilarItemsCacheAsync(string cachePath, CancellationToken ca |
| | | 645 | | { |
| | 0 | 646 | | var fileInfo = _fileSystem.GetFileSystemInfo(cachePath); |
| | 0 | 647 | | if (!fileInfo.Exists || fileInfo.Length == 0) |
| | | 648 | | { |
| | 0 | 649 | | return null; |
| | | 650 | | } |
| | | 651 | | |
| | | 652 | | try |
| | | 653 | | { |
| | 0 | 654 | | var stream = new FileStream( |
| | 0 | 655 | | cachePath, |
| | 0 | 656 | | FileMode.Open, |
| | 0 | 657 | | FileAccess.Read, |
| | 0 | 658 | | FileShare.ReadWrite | FileShare.Delete, |
| | 0 | 659 | | IODefaults.FileStreamBufferSize, |
| | 0 | 660 | | FileOptions.Asynchronous | FileOptions.SequentialScan); |
| | 0 | 661 | | await using (stream.ConfigureAwait(false)) |
| | | 662 | | { |
| | 0 | 663 | | var cache = await JsonSerializer.DeserializeAsync<SimilarItemsCache>(stream, JsonDefaults.Options, cance |
| | 0 | 664 | | if (cache?.References is not null && DateTime.UtcNow < cache.ExpiresAt) |
| | | 665 | | { |
| | 0 | 666 | | return cache.References; |
| | | 667 | | } |
| | | 668 | | } |
| | 0 | 669 | | } |
| | 0 | 670 | | catch (IOException ex) |
| | | 671 | | { |
| | 0 | 672 | | _logger.LogWarning(ex, "Failed to read similar items cache from {CachePath}", cachePath); |
| | 0 | 673 | | } |
| | 0 | 674 | | catch (JsonException ex) |
| | | 675 | | { |
| | 0 | 676 | | _logger.LogWarning(ex, "Failed to parse similar items cache from {CachePath}", cachePath); |
| | 0 | 677 | | } |
| | | 678 | | |
| | 0 | 679 | | return null; |
| | 0 | 680 | | } |
| | | 681 | | |
| | | 682 | | private async Task SaveSimilarItemsCacheAsync(string cachePath, List<SimilarItemReference> references, TimeSpan cach |
| | | 683 | | { |
| | 0 | 684 | | string? tempPath = null; |
| | | 685 | | try |
| | | 686 | | { |
| | 0 | 687 | | var directory = Path.GetDirectoryName(cachePath); |
| | 0 | 688 | | if (!string.IsNullOrEmpty(directory)) |
| | | 689 | | { |
| | 0 | 690 | | Directory.CreateDirectory(directory); |
| | | 691 | | } |
| | | 692 | | |
| | 0 | 693 | | var cache = new SimilarItemsCache |
| | 0 | 694 | | { |
| | 0 | 695 | | References = references, |
| | 0 | 696 | | ExpiresAt = DateTime.UtcNow.Add(cacheDuration) |
| | 0 | 697 | | }; |
| | | 698 | | |
| | 0 | 699 | | tempPath = cachePath + "." + Guid.NewGuid().ToString("N", CultureInfo.InvariantCulture) + ".tmp"; |
| | 0 | 700 | | var stream = File.Create(tempPath); |
| | 0 | 701 | | await using (stream.ConfigureAwait(false)) |
| | | 702 | | { |
| | 0 | 703 | | await JsonSerializer.SerializeAsync(stream, cache, JsonDefaults.Options, cancellationToken).ConfigureAwa |
| | | 704 | | } |
| | | 705 | | |
| | 0 | 706 | | File.Move(tempPath, cachePath, true); |
| | 0 | 707 | | tempPath = null; |
| | 0 | 708 | | } |
| | 0 | 709 | | catch (IOException ex) |
| | | 710 | | { |
| | 0 | 711 | | _logger.LogWarning(ex, "Failed to save similar items cache to {CachePath}", cachePath); |
| | 0 | 712 | | } |
| | | 713 | | finally |
| | | 714 | | { |
| | 0 | 715 | | if (tempPath is not null) |
| | | 716 | | { |
| | | 717 | | try |
| | | 718 | | { |
| | 0 | 719 | | File.Delete(tempPath); |
| | 0 | 720 | | } |
| | 0 | 721 | | catch (IOException ex) |
| | | 722 | | { |
| | 0 | 723 | | _logger.LogDebug(ex, "Failed to delete temporary similar items cache file {TempPath}", tempPath); |
| | 0 | 724 | | } |
| | | 725 | | } |
| | | 726 | | } |
| | 0 | 727 | | } |
| | | 728 | | |
| | | 729 | | private sealed class SimilarItemsCache |
| | | 730 | | { |
| | | 731 | | public List<SimilarItemReference>? References { get; set; } |
| | | 732 | | |
| | | 733 | | public DateTime ExpiresAt { get; set; } |
| | | 734 | | } |
| | | 735 | | |
| | | 736 | | private sealed class StringTupleComparer : IEqualityComparer<(string Key, string Value)> |
| | | 737 | | { |
| | 0 | 738 | | public static readonly StringTupleComparer Instance = new(); |
| | | 739 | | |
| | | 740 | | public bool Equals((string Key, string Value) x, (string Key, string Value) y) |
| | 0 | 741 | | => string.Equals(x.Key, y.Key, StringComparison.OrdinalIgnoreCase) && |
| | 0 | 742 | | string.Equals(x.Value, y.Value, StringComparison.OrdinalIgnoreCase); |
| | | 743 | | |
| | | 744 | | public int GetHashCode((string Key, string Value) obj) |
| | 0 | 745 | | => HashCode.Combine( |
| | 0 | 746 | | StringComparer.OrdinalIgnoreCase.GetHashCode(obj.Key), |
| | 0 | 747 | | StringComparer.OrdinalIgnoreCase.GetHashCode(obj.Value)); |
| | | 748 | | } |
| | | 749 | | } |