Add support for TMDB series absolute and DVD order

MediaBrowser.Providers/MediaBrowser.Providers.csproj

@@ -22,7 +22,7 @@
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="OptimizedPriorityQueue" Version="5.0.0" />
     <PackageReference Include="PlaylistsNET" Version="1.1.3" />
-    <PackageReference Include="TMDbLib" Version="1.7.3-alpha" />
+    <PackageReference Include="TMDbLib" Version="1.8.1" />
   </ItemGroup>
 
   <PropertyGroup>

MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeImageProvider.cs

@@ -65,7 +65,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb.TV
 
             // TODO use image languages if All Languages isn't toggled, but there's currently no way to get that value in here
             var episodeResult = await _tmdbClientManager
-                .GetEpisodeAsync(seriesTmdbId, seasonNumber.Value, episodeNumber.Value, null, null, cancellationToken)
+                .GetEpisodeAsync(seriesTmdbId, seasonNumber.Value, episodeNumber.Value, series.DisplayOrder, null, null, cancellationToken)
                 .ConfigureAwait(false);
 
             var stills = episodeResult?.Images?.Stills;

MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeProvider.cs

@@ -92,7 +92,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb.TV
             }
 
             var episodeResult = await _tmdbClientManager
-                .GetEpisodeAsync(seriesTmdbId, seasonNumber.Value, episodeNumber.Value, info.MetadataLanguage, TmdbUtils.GetImageLanguagesParam(info.MetadataLanguage), cancellationToken)
+                .GetEpisodeAsync(seriesTmdbId, seasonNumber.Value, episodeNumber.Value, info.SeriesDisplayOrder, info.MetadataLanguage, TmdbUtils.GetImageLanguagesParam(info.MetadataLanguage), cancellationToken)
                 .ConfigureAwait(false);
 
             if (episodeResult == null)

MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs

@@ -125,7 +125,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb
                 tmdbId,
                 language: TmdbUtils.NormalizeLanguage(language),
                 includeImageLanguage: imageLanguages,
-                extraMethods: TvShowMethods.Credits | TvShowMethods.Images | TvShowMethods.Keywords | TvShowMethods.ExternalIds | TvShowMethods.Videos | TvShowMethods.ContentRatings,
+                extraMethods: TvShowMethods.Credits | TvShowMethods.Images | TvShowMethods.Keywords | TvShowMethods.ExternalIds | TvShowMethods.Videos | TvShowMethods.ContentRatings | TvShowMethods.EpisodeGroups,
                 cancellationToken: cancellationToken).ConfigureAwait(false);
 
             if (series != null)
@@ -136,6 +136,56 @@ namespace MediaBrowser.Providers.Plugins.Tmdb
             return series;
         }
 
+        /// <summary>
+        /// Gets a tv show episode group from the TMDb API based on the show id and the display order.
+        /// </summary>
+        /// <param name="tvShowId">The tv show's TMDb id.</param>
+        /// <param name="displayOrder">The display order.</param>
+        /// <param name="language">The tv show's language.</param>
+        /// <param name="imageLanguages">A comma-separated list of image languages.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>The TMDb tv show episode group information or null if not found.</returns>
+        public async Task<TvGroupCollection> GetSeriesGroupAsync(int tvShowId, string displayOrder, string language, string imageLanguages, CancellationToken cancellationToken)
+        {
+            var key = $"group-{tvShowId.ToString(CultureInfo.InvariantCulture)}-{displayOrder}-{language}";
+            if (_memoryCache.TryGetValue(key, out TvGroupCollection group))
+            {
+                return group;
+            }
+
+            await EnsureClientConfigAsync().ConfigureAwait(false);
+
+            TvGroupType? groupType =
+                displayOrder == "absolute" ? TvGroupType.Absolute :
+                displayOrder == "dvd" ? TvGroupType.DVD :
+                null;
+
+            if (groupType == null)
+            {
+                return null;
+            }
+
+            var series = await GetSeriesAsync(tvShowId, language, imageLanguages, cancellationToken);
+            var episodeGroupId = series.EpisodeGroups.Results.Find(g => g.Type == groupType)?.Id;
+
+            if (episodeGroupId == null)
+            {
+                return null;
+            }
+
+            group = await _tmDbClient.GetTvEpisodeGroupsAsync(
+                episodeGroupId,
+                language: TmdbUtils.NormalizeLanguage(language),
+                cancellationToken: cancellationToken).ConfigureAwait(false);
+
+            if (group != null)
+            {
+                _memoryCache.Set(key, group, TimeSpan.FromHours(CacheDurationInHours));
+            }
+
+            return group;
+        }
+
         /// <summary>
         /// Gets a tv season from the TMDb API based on the tv show's TMDb id.
         /// </summary>
@@ -177,13 +227,14 @@ namespace MediaBrowser.Providers.Plugins.Tmdb
         /// <param name="tvShowId">The tv show's TMDb id.</param>
         /// <param name="seasonNumber">The season number.</param>
         /// <param name="episodeNumber">The episode number.</param>
+        /// <param name="displayOrder">The display order.</param>
         /// <param name="language">The episode's language.</param>
         /// <param name="imageLanguages">A comma-separated list of image languages.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The TMDb tv episode information or null if not found.</returns>
-        public async Task<TvEpisode> GetEpisodeAsync(int tvShowId, int seasonNumber, int episodeNumber, string language, string imageLanguages, CancellationToken cancellationToken)
+        public async Task<TvEpisode> GetEpisodeAsync(int tvShowId, int seasonNumber, int episodeNumber, string displayOrder, string language, string imageLanguages, CancellationToken cancellationToken)
         {
-            var key = $"episode-{tvShowId.ToString(CultureInfo.InvariantCulture)}-s{seasonNumber.ToString(CultureInfo.InvariantCulture)}e{episodeNumber.ToString(CultureInfo.InvariantCulture)}-{language}";
+            var key = $"episode-{tvShowId.ToString(CultureInfo.InvariantCulture)}-s{seasonNumber.ToString(CultureInfo.InvariantCulture)}e{episodeNumber.ToString(CultureInfo.InvariantCulture)}-{displayOrder}-{language}";
             if (_memoryCache.TryGetValue(key, out TvEpisode episode))
             {
                 return episode;
@@ -191,6 +242,18 @@ namespace MediaBrowser.Providers.Plugins.Tmdb
 
             await EnsureClientConfigAsync().ConfigureAwait(false);
 
+            var group = await GetSeriesGroupAsync(tvShowId, displayOrder, language, imageLanguages, cancellationToken);
+            if (group != null)
+            {
+                var season = group.Groups.Find(s => s.Order == seasonNumber);
+                var ep = season?.Episodes.Find(e => e.Order == episodeNumber - 1);
+                if (ep != null)
+                {
+                    seasonNumber = ep.SeasonNumber;
+                    episodeNumber = ep.EpisodeNumber;
+                }
+            }
+
             episode = await _tmDbClient.GetTvEpisodeAsync(
                 tvShowId,
                 seasonNumber,