< 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: 155
Coverable lines: 158
Total lines: 322
Line coverage: 1.8%
Branch coverage
0%
Covered branches: 0
Total branches: 94
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 1/23/2026 - 12:11:06 AM Line coverage: 50% (3/6) Total lines: 3224/19/2026 - 12:14:27 AM Line coverage: 1.8% (3/158) Branch coverage: 0% (0/94) Total lines: 322 4/19/2026 - 12:14:27 AM Line coverage: 1.8% (3/158) Branch coverage: 0% (0/94) Total lines: 322

Coverage delta

Coverage delta 49 -49

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%8190900%
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        {
 2136            _httpClientFactory = httpClientFactory;
 2137            _tmdbClientManager = tmdbClientManager;
 2138        }
 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            var seriesTmdbId = Convert.ToInt32(tmdbId, CultureInfo.InvariantCulture);
 095            if (seriesTmdbId <= 0)
 96            {
 097                return metadataResult;
 98            }
 99
 0100            var seasonNumber = info.ParentIndexNumber ?? 1;
 0101            var episodeNumber = info.IndexNumber;
 102
 0103            if (!episodeNumber.HasValue)
 104            {
 0105                return metadataResult;
 106            }
 107
 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                        Name = result[0].Name,
 0129                        Overview = result[0].Overview,
 0130                        AirDate = result[0].AirDate,
 0131                        VoteAverage = result[0].VoteAverage,
 0132                        ExternalIds = result[0].ExternalIds,
 0133                        Videos = result[0].Videos,
 0134                        Credits = result[0].Credits
 0135                    };
 136
 0137                    if (result.Count > 1)
 138                    {
 0139                        var name = new StringBuilder(episodeResult.Name);
 0140                        var overview = new StringBuilder(episodeResult.Overview);
 141
 0142                        for (int i = 1; i < result.Count; i++)
 143                        {
 0144                            name.Append(" / ").Append(result[i].Name);
 0145                            overview.Append(" / ").Append(result[i].Overview);
 146                        }
 147
 0148                        episodeResult.Name = name.ToString();
 0149                        episodeResult.Overview = overview.ToString();
 150                    }
 151                }
 152                else
 153                {
 0154                    return metadataResult;
 155                }
 0156            }
 157            else
 158            {
 0159                episodeResult = await _tmdbClientManager
 0160                    .GetEpisodeAsync(seriesTmdbId, seasonNumber, episodeNumber.Value, info.SeriesDisplayOrder, info.Meta
 0161                    .ConfigureAwait(false);
 162            }
 163
 0164            if (episodeResult is null)
 165            {
 0166                return metadataResult;
 167            }
 168
 0169            metadataResult.HasMetadata = true;
 0170            metadataResult.QueriedById = true;
 171
 0172            if (!string.IsNullOrEmpty(episodeResult.Overview))
 173            {
 174                // if overview is non-empty, we can assume that localized data was returned
 0175                metadataResult.ResultLanguage = info.MetadataLanguage;
 176            }
 177
 0178            var item = new Episode
 0179            {
 0180                IndexNumber = episodeNumber,
 0181                ParentIndexNumber = seasonNumber,
 0182                IndexNumberEnd = info.IndexNumberEnd,
 0183                Name = episodeResult.Name,
 0184                PremiereDate = episodeResult.AirDate,
 0185                ProductionYear = episodeResult.AirDate?.Year,
 0186                Overview = episodeResult.Overview,
 0187                CommunityRating = Convert.ToSingle(episodeResult.VoteAverage)
 0188            };
 189
 0190            var externalIds = episodeResult.ExternalIds;
 0191            item.TrySetProviderId(MetadataProvider.Tvdb, externalIds?.TvdbId);
 0192            item.TrySetProviderId(MetadataProvider.Imdb, externalIds?.ImdbId);
 0193            item.TrySetProviderId(MetadataProvider.TvRage, externalIds?.TvrageId);
 194
 0195            if (episodeResult.Videos?.Results is not null)
 196            {
 0197                foreach (var video in episodeResult.Videos.Results)
 198                {
 0199                    if (TmdbUtils.IsTrailerType(video))
 200                    {
 0201                        item.AddTrailerUrl("https://www.youtube.com/watch?v=" + video.Key);
 202                    }
 203                }
 204            }
 205
 0206            var credits = episodeResult.Credits;
 207
 0208            if (credits?.Cast is not null)
 209            {
 0210                var castQuery = config.HideMissingCastMembers
 0211                    ? credits.Cast.Where(a => !string.IsNullOrEmpty(a.ProfilePath)).OrderBy(a => a.Order)
 0212                    : credits.Cast.OrderBy(a => a.Order);
 213
 0214                foreach (var actor in castQuery.Take(config.MaxCastMembers))
 215                {
 0216                    if (string.IsNullOrWhiteSpace(actor.Name))
 217                    {
 218                        continue;
 219                    }
 220
 0221                    var personInfo = new PersonInfo
 0222                    {
 0223                        Name = actor.Name.Trim(),
 0224                        Role = actor.Character?.Trim() ?? string.Empty,
 0225                        Type = PersonKind.Actor,
 0226                        SortOrder = actor.Order,
 0227                        ImageUrl = _tmdbClientManager.GetProfileUrl(actor.ProfilePath)
 0228                    };
 229
 0230                    if (actor.Id > 0)
 231                    {
 0232                        personInfo.SetProviderId(MetadataProvider.Tmdb, actor.Id.ToString(CultureInfo.InvariantCulture))
 233                    }
 234
 0235                    metadataResult.AddPerson(personInfo);
 236                }
 237            }
 238
 0239            if (credits?.GuestStars is not null)
 240            {
 0241                var guestQuery = config.HideMissingCastMembers
 0242                    ? credits.GuestStars.Where(a => !string.IsNullOrEmpty(a.ProfilePath)).OrderBy(a => a.Order)
 0243                    : credits.GuestStars.OrderBy(a => a.Order);
 244
 0245                foreach (var guest in guestQuery.Take(config.MaxCastMembers))
 246                {
 0247                    if (string.IsNullOrWhiteSpace(guest.Name))
 248                    {
 249                        continue;
 250                    }
 251
 0252                    var personInfo = new PersonInfo
 0253                    {
 0254                        Name = guest.Name.Trim(),
 0255                        Role = guest.Character?.Trim() ?? string.Empty,
 0256                        Type = PersonKind.GuestStar,
 0257                        SortOrder = guest.Order,
 0258                        ImageUrl = _tmdbClientManager.GetProfileUrl(guest.ProfilePath)
 0259                    };
 260
 0261                    if (guest.Id > 0)
 262                    {
 0263                        personInfo.SetProviderId(MetadataProvider.Tmdb, guest.Id.ToString(CultureInfo.InvariantCulture))
 264                    }
 265
 0266                    metadataResult.AddPerson(personInfo);
 267                }
 268            }
 269
 0270            if (credits?.Crew is not null)
 271            {
 0272                var crewQuery = credits.Crew
 0273                    .Select(crewMember => new
 0274                    {
 0275                        CrewMember = crewMember,
 0276                        PersonType = TmdbUtils.MapCrewToPersonType(crewMember)
 0277                    })
 0278                    .Where(entry => TmdbUtils.WantedCrewKinds.Contains(entry.PersonType));
 279
 0280                if (config.HideMissingCrewMembers)
 281                {
 0282                    crewQuery = crewQuery.Where(entry => !string.IsNullOrEmpty(entry.CrewMember.ProfilePath));
 283                }
 284
 0285                foreach (var entry in crewQuery.Take(config.MaxCrewMembers))
 286                {
 0287                    var crewMember = entry.CrewMember;
 288
 0289                    if (string.IsNullOrWhiteSpace(crewMember.Name))
 290                    {
 291                        continue;
 292                    }
 293
 0294                    var personInfo = new PersonInfo
 0295                    {
 0296                        Name = crewMember.Name.Trim(),
 0297                        Role = crewMember.Job?.Trim() ?? string.Empty,
 0298                        Type = entry.PersonType,
 0299                        ImageUrl = _tmdbClientManager.GetProfileUrl(crewMember.ProfilePath)
 0300                    };
 301
 0302                    if (crewMember.Id > 0)
 303                    {
 0304                        personInfo.SetProviderId(MetadataProvider.Tmdb, crewMember.Id.ToString(CultureInfo.InvariantCult
 305                    }
 306
 0307                    metadataResult.AddPerson(personInfo);
 308                }
 309            }
 310
 0311            metadataResult.Item = item;
 312
 0313            return metadataResult;
 0314        }
 315
 316        /// <inheritdoc />
 317        public Task<HttpResponseMessage> GetImageResponse(string url, CancellationToken cancellationToken)
 318        {
 0319            return _httpClientFactory.CreateClient(NamedClient.Default).GetAsync(url, cancellationToken);
 320        }
 321    }
 322}