< Summary - Jellyfin

Information
Class: MediaBrowser.Providers.Plugins.Tmdb.TV.TmdbEpisodeProvider
Assembly: MediaBrowser.Providers
File(s): /srv/git/jellyfin/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeProvider.cs
Line coverage
1%
Covered lines: 3
Uncovered lines: 160
Coverable lines: 163
Total lines: 330
Line coverage: 1.8%
Branch coverage
0%
Covered branches: 0
Total branches: 100
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 5/31/2026 - 12:15:44 AM Line coverage: 1.8% (3/158) Branch coverage: 0% (0/94) Total lines: 3226/19/2026 - 12:16:12 AM Line coverage: 1.8% (3/160) Branch coverage: 0% (0/96) Total lines: 32410/29/2026 - 12:17:11 AM Line coverage: 1.8% (3/163) Branch coverage: 0% (0/100) Total lines: 330 5/31/2026 - 12:15:44 AM Line coverage: 1.8% (3/158) Branch coverage: 0% (0/94) Total lines: 3226/19/2026 - 12:16:12 AM Line coverage: 1.8% (3/160) Branch coverage: 0% (0/96) Total lines: 32410/29/2026 - 12:17:11 AM Line coverage: 1.8% (3/163) Branch coverage: 0% (0/100) Total lines: 330

Coverage delta

Coverage delta 1 -1

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
get_Order()100%210%
get_Name()100%210%
GetSearchResults()0%2040%
GetMetadata()0%9312960%
GetImageResponse(...)100%210%

File(s)

/srv/git/jellyfin/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeProvider.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.Globalization;
 4using System.Linq;
 5using System.Net.Http;
 6using System.Text;
 7using System.Threading;
 8using System.Threading.Tasks;
 9using Jellyfin.Data.Enums;
 10using Jellyfin.Extensions;
 11using MediaBrowser.Common.Net;
 12using MediaBrowser.Controller.Entities;
 13using MediaBrowser.Controller.Entities.TV;
 14using MediaBrowser.Controller.Providers;
 15using MediaBrowser.Model.Entities;
 16using MediaBrowser.Model.Providers;
 17using TMDbLib.Objects.TvShows;
 18
 19namespace MediaBrowser.Providers.Plugins.Tmdb.TV
 20{
 21    /// <summary>
 22    /// TV episode provider powered by TheMovieDb.
 23    /// </summary>
 24    public class TmdbEpisodeProvider : IRemoteMetadataProvider<Episode, EpisodeInfo>, IHasOrder
 25    {
 26        private readonly IHttpClientFactory _httpClientFactory;
 27        private readonly TmdbClientManager _tmdbClientManager;
 28
 29        /// <summary>
 30        /// Initializes a new instance of the <see cref="TmdbEpisodeProvider"/> class.
 31        /// </summary>
 32        /// <param name="httpClientFactory">The <see cref="IHttpClientFactory"/>.</param>
 33        /// <param name="tmdbClientManager">The <see cref="TmdbClientManager"/>.</param>
 34        public TmdbEpisodeProvider(IHttpClientFactory httpClientFactory, TmdbClientManager tmdbClientManager)
 35        {
 2736            _httpClientFactory = httpClientFactory;
 2737            _tmdbClientManager = tmdbClientManager;
 2738        }
 39
 40        /// <inheritdoc />
 041        public int Order => 1;
 42
 43        /// <inheritdoc />
 044        public string Name => TmdbUtils.ProviderName;
 45
 46        /// <inheritdoc />
 47        public async Task<IEnumerable<RemoteSearchResult>> GetSearchResults(EpisodeInfo searchInfo, CancellationToken ca
 48        {
 49            // The search query must either provide an episode number or date
 050            if (!searchInfo.IndexNumber.HasValue)
 51            {
 052                return Enumerable.Empty<RemoteSearchResult>();
 53            }
 54
 055            var metadataResult = await GetMetadata(searchInfo, cancellationToken).ConfigureAwait(false);
 56
 057            if (!metadataResult.HasMetadata)
 58            {
 059                return Enumerable.Empty<RemoteSearchResult>();
 60            }
 61
 062            var item = metadataResult.Item;
 63
 064            return new[]
 065            {
 066                new RemoteSearchResult
 067                {
 068                    IndexNumber = item.IndexNumber,
 069                    Name = item.Name,
 070                    ParentIndexNumber = item.ParentIndexNumber,
 071                    PremiereDate = item.PremiereDate,
 072                    ProductionYear = item.ProductionYear,
 073                    ProviderIds = item.ProviderIds,
 074                    SearchProviderName = Name,
 075                    IndexNumberEnd = item.IndexNumberEnd
 076                }
 077            };
 078        }
 79
 80        /// <inheritdoc />
 81        public async Task<MetadataResult<Episode>> GetMetadata(EpisodeInfo info, CancellationToken cancellationToken)
 82        {
 083            var metadataResult = new MetadataResult<Episode>();
 084            var config = Plugin.Instance.Configuration;
 85
 86            // Allowing this will dramatically increase scan times
 087            if (info.IsMissingEpisode)
 88            {
 089                return metadataResult;
 90            }
 91
 092            info.SeriesProviderIds.TryGetValue(MetadataProvider.Tmdb.ToString(), out string? tmdbId);
 93
 094            if (!TmdbUtils.TryParseTmdbId(tmdbId, out var seriesTmdbId))
 95            {
 096                return metadataResult;
 97            }
 98
 099            var seasonNumber = info.ParentIndexNumber ?? 1;
 0100            var episodeNumber = info.IndexNumber;
 101
 0102            if (!episodeNumber.HasValue)
 103            {
 0104                return metadataResult;
 105            }
 106
 0107            var episodeGroup = info.SeriesProviderIds.GetValueOrDefault(TmdbEpisodeGroupId.ProviderKey);
 0108            TvEpisode? episodeResult = null;
 0109            if (info.IndexNumberEnd.HasValue)
 110            {
 0111                var startindex = episodeNumber;
 0112                var endindex = info.IndexNumberEnd;
 0113                List<TvEpisode>? result = null;
 0114                for (int? episode = startindex; episode <= endindex; episode++)
 115                {
 0116                    var episodeInfo = await _tmdbClientManager.GetEpisodeAsync(seriesTmdbId, seasonNumber, episode.Value
 0117                    if (episodeInfo is not null)
 118                    {
 0119                        (result ??= new List<TvEpisode>()).Add(episodeInfo);
 120                    }
 121                }
 122
 0123                if (result is not null)
 124                {
 125                    // Forces a deep copy of the first TvEpisode, so we don't modify the original because it's cached
 0126                    episodeResult = new TvEpisode()
 0127                    {
 0128                        Id = result[0].Id,
 0129                        Name = result[0].Name,
 0130                        Overview = result[0].Overview,
 0131                        AirDate = result[0].AirDate,
 0132                        VoteAverage = result[0].VoteAverage,
 0133                        ExternalIds = result[0].ExternalIds,
 0134                        Videos = result[0].Videos,
 0135                        Credits = result[0].Credits
 0136                    };
 137
 0138                    if (result.Count > 1)
 139                    {
 0140                        var name = new StringBuilder(episodeResult.Name);
 0141                        var overview = new StringBuilder(episodeResult.Overview);
 142
 0143                        for (int i = 1; i < result.Count; i++)
 144                        {
 0145                            name.Append(" / ").Append(result[i].Name);
 0146                            overview.Append(" / ").Append(result[i].Overview);
 147                        }
 148
 0149                        episodeResult.Name = name.ToString();
 0150                        episodeResult.Overview = overview.ToString();
 151                    }
 152                }
 153                else
 154                {
 0155                    return metadataResult;
 156                }
 0157            }
 158            else
 159            {
 0160                episodeResult = await _tmdbClientManager
 0161                    .GetEpisodeAsync(seriesTmdbId, seasonNumber, episodeNumber.Value, episodeGroup, info.MetadataLanguag
 0162                    .ConfigureAwait(false);
 163            }
 164
 0165            if (episodeResult is null)
 166            {
 0167                return metadataResult;
 168            }
 169
 0170            metadataResult.HasMetadata = true;
 0171            metadataResult.QueriedById = true;
 172
 0173            if (!string.IsNullOrEmpty(episodeResult.Overview))
 174            {
 175                // if overview is non-empty, we can assume that localized data was returned
 0176                metadataResult.ResultLanguage = info.MetadataLanguage;
 177            }
 178
 0179            var item = new Episode
 0180            {
 0181                IndexNumber = episodeNumber,
 0182                ParentIndexNumber = seasonNumber,
 0183                IndexNumberEnd = info.IndexNumberEnd,
 0184                Name = episodeResult.Name,
 0185                PremiereDate = episodeResult.AirDate.HasValue
 0186                    ? DateTime.SpecifyKind(episodeResult.AirDate.Value, DateTimeKind.Local).ToUniversalTime()
 0187                    : null,
 0188                ProductionYear = episodeResult.AirDate?.Year,
 0189                Overview = episodeResult.Overview,
 0190                CommunityRating = Convert.ToSingle(episodeResult.VoteAverage)
 0191            };
 192
 0193            if (episodeResult.Id is int episodeTmdbId and > 0)
 194            {
 0195                item.SetProviderId(MetadataProvider.Tmdb, episodeTmdbId.ToString(CultureInfo.InvariantCulture));
 196            }
 197
 0198            var externalIds = episodeResult.ExternalIds;
 0199            item.TrySetProviderId(MetadataProvider.Tvdb, externalIds?.TvdbId);
 0200            item.TrySetProviderId(MetadataProvider.Imdb, externalIds?.ImdbId);
 0201            item.TrySetProviderId(MetadataProvider.TvRage, externalIds?.TvrageId);
 202
 0203            if (episodeResult.Videos?.Results is not null)
 204            {
 0205                foreach (var video in episodeResult.Videos.Results)
 206                {
 0207                    if (TmdbUtils.IsTrailerType(video))
 208                    {
 0209                        item.AddTrailerUrl("https://www.youtube.com/watch?v=" + video.Key);
 210                    }
 211                }
 212            }
 213
 0214            var credits = episodeResult.Credits;
 215
 0216            if (credits?.Cast is not null)
 217            {
 0218                var castQuery = config.HideMissingCastMembers
 0219                    ? credits.Cast.Where(a => !string.IsNullOrEmpty(a.ProfilePath)).OrderBy(a => a.Order)
 0220                    : credits.Cast.OrderBy(a => a.Order);
 221
 0222                foreach (var actor in castQuery.Take(config.MaxCastMembers))
 223                {
 0224                    if (string.IsNullOrWhiteSpace(actor.Name))
 225                    {
 226                        continue;
 227                    }
 228
 0229                    var personInfo = new PersonInfo
 0230                    {
 0231                        Name = actor.Name.Trim(),
 0232                        Role = actor.Character?.Trim() ?? string.Empty,
 0233                        Type = PersonKind.Actor,
 0234                        SortOrder = actor.Order,
 0235                        ImageUrl = _tmdbClientManager.GetProfileUrl(actor.ProfilePath)
 0236                    };
 237
 0238                    if (actor.Id > 0)
 239                    {
 0240                        personInfo.SetProviderId(MetadataProvider.Tmdb, actor.Id.ToString(CultureInfo.InvariantCulture))
 241                    }
 242
 0243                    metadataResult.AddPerson(personInfo);
 244                }
 245            }
 246
 0247            if (credits?.GuestStars is not null)
 248            {
 0249                var guestQuery = config.HideMissingCastMembers
 0250                    ? credits.GuestStars.Where(a => !string.IsNullOrEmpty(a.ProfilePath)).OrderBy(a => a.Order)
 0251                    : credits.GuestStars.OrderBy(a => a.Order);
 252
 0253                foreach (var guest in guestQuery.Take(config.MaxCastMembers))
 254                {
 0255                    if (string.IsNullOrWhiteSpace(guest.Name))
 256                    {
 257                        continue;
 258                    }
 259
 0260                    var personInfo = new PersonInfo
 0261                    {
 0262                        Name = guest.Name.Trim(),
 0263                        Role = guest.Character?.Trim() ?? string.Empty,
 0264                        Type = PersonKind.GuestStar,
 0265                        SortOrder = guest.Order,
 0266                        ImageUrl = _tmdbClientManager.GetProfileUrl(guest.ProfilePath)
 0267                    };
 268
 0269                    if (guest.Id > 0)
 270                    {
 0271                        personInfo.SetProviderId(MetadataProvider.Tmdb, guest.Id.ToString(CultureInfo.InvariantCulture))
 272                    }
 273
 0274                    metadataResult.AddPerson(personInfo);
 275                }
 276            }
 277
 0278            if (credits?.Crew is not null)
 279            {
 0280                var crewQuery = credits.Crew
 0281                    .Select(crewMember => new
 0282                    {
 0283                        CrewMember = crewMember,
 0284                        PersonType = TmdbUtils.MapCrewToPersonType(crewMember)
 0285                    })
 0286                    .Where(entry => TmdbUtils.WantedCrewKinds.Contains(entry.PersonType));
 287
 0288                if (config.HideMissingCrewMembers)
 289                {
 0290                    crewQuery = crewQuery.Where(entry => !string.IsNullOrEmpty(entry.CrewMember.ProfilePath));
 291                }
 292
 0293                foreach (var entry in crewQuery.Take(config.MaxCrewMembers))
 294                {
 0295                    var crewMember = entry.CrewMember;
 296
 0297                    if (string.IsNullOrWhiteSpace(crewMember.Name))
 298                    {
 299                        continue;
 300                    }
 301
 0302                    var personInfo = new PersonInfo
 0303                    {
 0304                        Name = crewMember.Name.Trim(),
 0305                        Role = crewMember.Job?.Trim() ?? string.Empty,
 0306                        Type = entry.PersonType,
 0307                        ImageUrl = _tmdbClientManager.GetProfileUrl(crewMember.ProfilePath)
 0308                    };
 309
 0310                    if (crewMember.Id > 0)
 311                    {
 0312                        personInfo.SetProviderId(MetadataProvider.Tmdb, crewMember.Id.ToString(CultureInfo.InvariantCult
 313                    }
 314
 0315                    metadataResult.AddPerson(personInfo);
 316                }
 317            }
 318
 0319            metadataResult.Item = item;
 320
 0321            return metadataResult;
 0322        }
 323
 324        /// <inheritdoc />
 325        public Task<HttpResponseMessage> GetImageResponse(string url, CancellationToken cancellationToken)
 326        {
 0327            return _httpClientFactory.CreateClient(NamedClient.Default).GetAsync(url, cancellationToken);
 328        }
 329    }
 330}