From 6d3b1296661a486d511fa12163456f96cfa3fcc7 Mon Sep 17 00:00:00 2001 From: Joe Rogers <1337joe@gmail.com> Date: Fri, 19 Nov 2021 22:02:26 +0100 Subject: [PATCH 1/2] Add image scaling options for tmdb --- .../Tmdb/Configuration/PluginConfiguration.cs | 41 +++++++++ .../Plugins/Tmdb/Configuration/config.html | 41 ++++++++- .../Plugins/Tmdb/TmdbClientManager.cs | 91 +++++++++++++++++-- 3 files changed, 162 insertions(+), 11 deletions(-) diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs index 9a78a75362..b043da76ca 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs +++ b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs @@ -1,3 +1,4 @@ +using System.Collections.Generic; using MediaBrowser.Model.Plugins; namespace MediaBrowser.Providers.Plugins.Tmdb @@ -26,5 +27,45 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// Gets or sets a value indicating the maximum number of cast members to fetch for an item. /// public int MaxCastMembers { get; set; } = 15; + + /// + /// Gets or sets a value indicating the poster image size to fetch. + /// + public string? PosterSize { get; set; } + + /// + /// Gets or sets the available options for poster size. + /// + public List PosterSizeOptions { get; set; } = new List(); + + /// + /// Gets or sets a value indicating the backdrop image size to fetch. + /// + public string? BackdropSize { get; set; } + + /// + /// Gets or sets the available options for backdrop size. + /// + public List BackdropSizeOptions { get; set; } = new List(); + + /// + /// Gets or sets a value indicating the profile image size to fetch. + /// + public string? ProfileSize { get; set; } + + /// + /// Gets or sets the available options for profile size. + /// + public List ProfileSizeOptions { get; set; } = new List(); + + /// + /// Gets or sets a value indicating the still image size to fetch. + /// + public string? StillSize { get; set; } + + /// + /// Gets or sets the available options for still size. + /// + public List StillSizeOptions { get; set; } = new List(); } } diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html index 12b4c7ca4e..d376df96cc 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html +++ b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html @@ -24,7 +24,22 @@
The maximum number of cast members to fetch for an item.
-
+
+

Image Scaling

+

If size options are not populated then refresh metadata for any item from TMDb and reload this page.

+
+ +
+
+ +
+
+ +
+
+ +
+
@@ -51,6 +66,26 @@ cancelable: false })); + var sizeOptionsGenerator = function (size) { + return ''; + } + + var selPosterSize = document.querySelector('#selectPosterSize'); + selPosterSize.innerHTML = config.PosterSizeOptions.map(sizeOptionsGenerator); + selPosterSize.value = config.PosterSize; + + var selBackdropSize = document.querySelector('#selectBackdropSize'); + selBackdropSize.innerHTML = config.BackdropSizeOptions.map(sizeOptionsGenerator); + selBackdropSize.value = config.BackdropSize; + + var selProfileSize = document.querySelector('#selectProfileSize'); + selProfileSize.innerHTML = config.ProfileSizeOptions.map(sizeOptionsGenerator); + selProfileSize.value = config.ProfileSize; + + var selStillSize = document.querySelector('#selectStillSize'); + selStillSize.innerHTML = config.StillSizeOptions.map(sizeOptionsGenerator); + selStillSize.value = config.StillSize; + Dashboard.hideLoadingMsg(); }); }); @@ -65,6 +100,10 @@ config.ExcludeTagsSeries = document.querySelector('#excludeTagsSeries').checked; config.ExcludeTagsMovies = document.querySelector('#excludeTagsMovies').checked; config.MaxCastMembers = document.querySelector('#maxCastMembers').value; + config.PosterSize = document.querySelector('#selectPosterSize').value; + config.BackdropSize = document.querySelector('#selectBackdropSize').value; + config.ProfileSize = document.querySelector('#selectProfileSize').value; + config.StillSize = document.querySelector('#selectStillSize').value; ApiClient.updatePluginConfiguration(PluginConfig.pluginId, config).then(Dashboard.processPluginConfigurationUpdateResult); }); diff --git a/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs b/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs index cb644c8ca1..c082a6cc4b 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs +++ b/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; using System.Globalization; +using System.Text.RegularExpressions; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Model.Dto; @@ -508,7 +509,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The absolute URL. public string GetPosterUrl(string posterPath) { - return GetUrl(_tmDbClient.Config.Images.PosterSizes[^1], posterPath); + return GetUrl(Plugin.Instance.Configuration.PosterSize, posterPath); } /// @@ -518,7 +519,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The absolute URL. public string GetProfileUrl(string actorProfilePath) { - return GetUrl(_tmDbClient.Config.Images.ProfileSizes[^1], actorProfilePath); + return GetUrl(Plugin.Instance.Configuration.ProfileSize, actorProfilePath); } /// @@ -529,7 +530,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The collection to add the remote images into. public void ConvertPostersToRemoteImageInfo(List images, string requestLanguage, List results) { - ConvertToRemoteImageInfo(images, _tmDbClient.Config.Images.PosterSizes[^1], ImageType.Primary, requestLanguage, results); + ConvertToRemoteImageInfo(images, Plugin.Instance.Configuration.PosterSize, ImageType.Primary, requestLanguage, results); } /// @@ -540,7 +541,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The collection to add the remote images into. public void ConvertBackdropsToRemoteImageInfo(List images, string requestLanguage, List results) { - ConvertToRemoteImageInfo(images, _tmDbClient.Config.Images.BackdropSizes[^1], ImageType.Backdrop, requestLanguage, results); + ConvertToRemoteImageInfo(images, Plugin.Instance.Configuration.BackdropSize, ImageType.Backdrop, requestLanguage, results); } /// @@ -551,7 +552,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The collection to add the remote images into. public void ConvertProfilesToRemoteImageInfo(List images, string requestLanguage, List results) { - ConvertToRemoteImageInfo(images, _tmDbClient.Config.Images.ProfileSizes[^1], ImageType.Primary, requestLanguage, results); + ConvertToRemoteImageInfo(images, Plugin.Instance.Configuration.ProfileSize, ImageType.Primary, requestLanguage, results); } /// @@ -562,7 +563,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The collection to add the remote images into. public void ConvertStillsToRemoteImageInfo(List images, string requestLanguage, List results) { - ConvertToRemoteImageInfo(images, _tmDbClient.Config.Images.StillSizes[^1], ImageType.Primary, requestLanguage, results); + ConvertToRemoteImageInfo(images, Plugin.Instance.Configuration.StillSize, ImageType.Primary, requestLanguage, results); } /// @@ -575,16 +576,51 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The collection to add the remote images into. private void ConvertToRemoteImageInfo(List images, string size, ImageType type, string requestLanguage, List results) { + int? targetHeight = null; + int? targetWidth = null; + var match = Regex.Match(size, @"(?[hw])(?[0-9]+)"); + if (match.Success) + { + var targetSize = int.Parse(match.Groups["size"].Value, NumberStyles.Integer, CultureInfo.InvariantCulture); + if (string.Equals(match.Groups["dimension"].Value, "h", StringComparison.OrdinalIgnoreCase)) + { + targetHeight = targetSize; + } + else + { + targetWidth = targetSize; + } + } + for (var i = 0; i < images.Count; i++) { var image = images[i]; + + int width; + int height; + if (targetHeight.HasValue) + { + width = (int)Math.Round((double)targetHeight.Value / image.Height * image.Width); + height = targetHeight.Value; + } + else if (targetWidth.HasValue) + { + height = (int)Math.Round((double)targetWidth.Value / image.Width * image.Height); + width = targetWidth.Value; + } + else + { + width = image.Width; + height = image.Height; + } + results.Add(new RemoteImageInfo { Url = GetUrl(size, image.FilePath), CommunityRating = image.VoteAverage, VoteCount = image.VoteCount, - Width = image.Width, - Height = image.Height, + Width = width, + Height = height, Language = TmdbUtils.AdjustImageLanguage(image.Iso_639_1, requestLanguage), ProviderName = TmdbUtils.ProviderName, Type = type, @@ -593,9 +629,44 @@ namespace MediaBrowser.Providers.Plugins.Tmdb } } - private Task EnsureClientConfigAsync() + private async Task EnsureClientConfigAsync() { - return !_tmDbClient.HasConfig ? _tmDbClient.GetConfigAsync() : Task.CompletedTask; + if (!_tmDbClient.HasConfig) + { + var config = await _tmDbClient.GetConfigAsync().ConfigureAwait(false); + ValidatePreferences(config); + } + } + + private static void ValidatePreferences(TMDbConfig config) + { + var imageConfig = config.Images; + + var pluginConfig = Plugin.Instance.Configuration; + + pluginConfig.PosterSizeOptions = imageConfig.PosterSizes; + if (!pluginConfig.PosterSizeOptions.Contains(pluginConfig.PosterSize)) + { + pluginConfig.PosterSize = pluginConfig.PosterSizeOptions[^1]; + } + + pluginConfig.BackdropSizeOptions = imageConfig.BackdropSizes; + if (!pluginConfig.BackdropSizeOptions.Contains(pluginConfig.BackdropSize)) + { + pluginConfig.BackdropSize = pluginConfig.BackdropSizeOptions[^1]; + } + + pluginConfig.ProfileSizeOptions = imageConfig.ProfileSizes; + if (!pluginConfig.ProfileSizeOptions.Contains(pluginConfig.ProfileSize)) + { + pluginConfig.ProfileSize = pluginConfig.ProfileSizeOptions[^1]; + } + + pluginConfig.StillSizeOptions = imageConfig.StillSizes; + if (!pluginConfig.StillSizeOptions.Contains(pluginConfig.StillSize)) + { + pluginConfig.StillSize = pluginConfig.StillSizeOptions[^1]; + } } /// From 0af5e600946231df73f1783330ad8cd0bbbed2ee Mon Sep 17 00:00:00 2001 From: Joe Rogers <1337joe@gmail.com> Date: Mon, 22 Nov 2021 21:08:07 +0100 Subject: [PATCH 2/2] Address review comments Store null instead of calculating scaled image sizes. Add endpoint to provide TMDb image size options. --- .../Plugins/Tmdb/Api/TmdbController.cs | 41 +++++++++++ .../Tmdb/Configuration/PluginConfiguration.cs | 21 ------ .../Plugins/Tmdb/Configuration/config.html | 59 ++++++++++----- .../Plugins/Tmdb/TmdbClientManager.cs | 71 ++++++------------- 4 files changed, 104 insertions(+), 88 deletions(-) create mode 100644 MediaBrowser.Providers/Plugins/Tmdb/Api/TmdbController.cs diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Api/TmdbController.cs b/MediaBrowser.Providers/Plugins/Tmdb/Api/TmdbController.cs new file mode 100644 index 0000000000..0bab7c3cad --- /dev/null +++ b/MediaBrowser.Providers/Plugins/Tmdb/Api/TmdbController.cs @@ -0,0 +1,41 @@ +using System.Net.Mime; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc; +using TMDbLib.Objects.General; + +namespace MediaBrowser.Providers.Plugins.Tmdb.Api +{ + /// + /// The TMDb api controller. + /// + [ApiController] + [Authorize(Policy = "DefaultAuthorization")] + [Route("[controller]")] + [Produces(MediaTypeNames.Application.Json)] + public class TmdbController : ControllerBase + { + private readonly TmdbClientManager _tmdbClientManager; + + /// + /// Initializes a new instance of the class. + /// + /// The TMDb client manager. + public TmdbController(TmdbClientManager tmdbClientManager) + { + _tmdbClientManager = tmdbClientManager; + } + + /// + /// Gets the TMDb image configuration options. + /// + /// The image portion of the TMDb client configuration. + [HttpGet("ClientConfiguration")] + [ProducesResponseType(StatusCodes.Status200OK)] + public async Task TmdbClientConfiguration() + { + return (await _tmdbClientManager.GetClientConfiguration().ConfigureAwait(false)).Images; + } + } +} diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs index b043da76ca..dec7961484 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs +++ b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/PluginConfiguration.cs @@ -1,4 +1,3 @@ -using System.Collections.Generic; using MediaBrowser.Model.Plugins; namespace MediaBrowser.Providers.Plugins.Tmdb @@ -33,39 +32,19 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// public string? PosterSize { get; set; } - /// - /// Gets or sets the available options for poster size. - /// - public List PosterSizeOptions { get; set; } = new List(); - /// /// Gets or sets a value indicating the backdrop image size to fetch. /// public string? BackdropSize { get; set; } - /// - /// Gets or sets the available options for backdrop size. - /// - public List BackdropSizeOptions { get; set; } = new List(); - /// /// Gets or sets a value indicating the profile image size to fetch. /// public string? ProfileSize { get; set; } - /// - /// Gets or sets the available options for profile size. - /// - public List ProfileSizeOptions { get; set; } = new List(); - /// /// Gets or sets a value indicating the still image size to fetch. /// public string? StillSize { get; set; } - - /// - /// Gets or sets the available options for still size. - /// - public List StillSizeOptions { get; set; } = new List(); } } diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html index d376df96cc..52693795b5 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html +++ b/MediaBrowser.Providers/Plugins/Tmdb/Configuration/config.html @@ -26,7 +26,6 @@

Image Scaling

-

If size options are not populated then refresh metadata for any item from TMDb and reload this page.

@@ -54,39 +53,61 @@ document.querySelector('.configPage') .addEventListener('pageshow', function () { Dashboard.showLoadingMsg(); - ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) { - document.querySelector('#includeAdult').checked = config.IncludeAdult; - document.querySelector('#excludeTagsSeries').checked = config.ExcludeTagsSeries; - document.querySelector('#excludeTagsMovies').checked = config.ExcludeTagsMovies; - var maxCastMembers = document.querySelector('#maxCastMembers'); - maxCastMembers.value = config.MaxCastMembers; - maxCastMembers.dispatchEvent(new Event('change', { - bubbles: true, - cancelable: false - })); + var clientConfig, pluginConfig; + var configureImageScaling = function() { + if (clientConfig === null || pluginConfig === null) { + return; + } var sizeOptionsGenerator = function (size) { return ''; } var selPosterSize = document.querySelector('#selectPosterSize'); - selPosterSize.innerHTML = config.PosterSizeOptions.map(sizeOptionsGenerator); - selPosterSize.value = config.PosterSize; + selPosterSize.innerHTML = clientConfig.PosterSizes.map(sizeOptionsGenerator); + selPosterSize.value = pluginConfig.PosterSize; var selBackdropSize = document.querySelector('#selectBackdropSize'); - selBackdropSize.innerHTML = config.BackdropSizeOptions.map(sizeOptionsGenerator); - selBackdropSize.value = config.BackdropSize; + selBackdropSize.innerHTML = clientConfig.BackdropSizes.map(sizeOptionsGenerator); + selBackdropSize.value = pluginConfig.BackdropSize; var selProfileSize = document.querySelector('#selectProfileSize'); - selProfileSize.innerHTML = config.ProfileSizeOptions.map(sizeOptionsGenerator); - selProfileSize.value = config.ProfileSize; + selProfileSize.innerHTML = clientConfig.ProfileSizes.map(sizeOptionsGenerator); + selProfileSize.value = pluginConfig.ProfileSize; var selStillSize = document.querySelector('#selectStillSize'); - selStillSize.innerHTML = config.StillSizeOptions.map(sizeOptionsGenerator); - selStillSize.value = config.StillSize; + selStillSize.innerHTML = clientConfig.StillSizes.map(sizeOptionsGenerator); + selStillSize.value = pluginConfig.StillSize; Dashboard.hideLoadingMsg(); + } + + const request = { + url: ApiClient.getUrl('tmdb/ClientConfiguration'), + dataType: 'json', + type: 'GET', + headers: { accept: 'application/json' } + } + ApiClient.fetch(request).then(function (config) { + clientConfig = config; + configureImageScaling(); + }); + + ApiClient.getPluginConfiguration(PluginConfig.pluginId).then(function (config) { + document.querySelector('#includeAdult').checked = config.IncludeAdult; + document.querySelector('#excludeTagsSeries').checked = config.ExcludeTagsSeries; + document.querySelector('#excludeTagsMovies').checked = config.ExcludeTagsMovies; + + var maxCastMembers = document.querySelector('#maxCastMembers'); + maxCastMembers.value = config.MaxCastMembers; + maxCastMembers.dispatchEvent(new Event('change', { + bubbles: true, + cancelable: false + })); + + pluginConfig = config; + configureImageScaling(); }); }); diff --git a/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs b/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs index c082a6cc4b..9a3af1f4af 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs +++ b/MediaBrowser.Providers/Plugins/Tmdb/TmdbClientManager.cs @@ -3,7 +3,6 @@ using System; using System.Collections.Generic; using System.Globalization; -using System.Text.RegularExpressions; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Model.Dto; @@ -576,51 +575,20 @@ namespace MediaBrowser.Providers.Plugins.Tmdb /// The collection to add the remote images into. private void ConvertToRemoteImageInfo(List images, string size, ImageType type, string requestLanguage, List results) { - int? targetHeight = null; - int? targetWidth = null; - var match = Regex.Match(size, @"(?[hw])(?[0-9]+)"); - if (match.Success) - { - var targetSize = int.Parse(match.Groups["size"].Value, NumberStyles.Integer, CultureInfo.InvariantCulture); - if (string.Equals(match.Groups["dimension"].Value, "h", StringComparison.OrdinalIgnoreCase)) - { - targetHeight = targetSize; - } - else - { - targetWidth = targetSize; - } - } + // sizes provided are for original resolution, don't store them when downloading scaled images + var scaleImage = !string.Equals(size, "original", StringComparison.OrdinalIgnoreCase); for (var i = 0; i < images.Count; i++) { var image = images[i]; - int width; - int height; - if (targetHeight.HasValue) - { - width = (int)Math.Round((double)targetHeight.Value / image.Height * image.Width); - height = targetHeight.Value; - } - else if (targetWidth.HasValue) - { - height = (int)Math.Round((double)targetWidth.Value / image.Width * image.Height); - width = targetWidth.Value; - } - else - { - width = image.Width; - height = image.Height; - } - results.Add(new RemoteImageInfo { Url = GetUrl(size, image.FilePath), CommunityRating = image.VoteAverage, VoteCount = image.VoteCount, - Width = width, - Height = height, + Width = scaleImage ? null : image.Width, + Height = scaleImage ? null : image.Height, Language = TmdbUtils.AdjustImageLanguage(image.Iso_639_1, requestLanguage), ProviderName = TmdbUtils.ProviderName, Type = type, @@ -644,31 +612,38 @@ namespace MediaBrowser.Providers.Plugins.Tmdb var pluginConfig = Plugin.Instance.Configuration; - pluginConfig.PosterSizeOptions = imageConfig.PosterSizes; - if (!pluginConfig.PosterSizeOptions.Contains(pluginConfig.PosterSize)) + if (!imageConfig.PosterSizes.Contains(pluginConfig.PosterSize)) { - pluginConfig.PosterSize = pluginConfig.PosterSizeOptions[^1]; + pluginConfig.PosterSize = imageConfig.PosterSizes[^1]; } - pluginConfig.BackdropSizeOptions = imageConfig.BackdropSizes; - if (!pluginConfig.BackdropSizeOptions.Contains(pluginConfig.BackdropSize)) + if (!imageConfig.BackdropSizes.Contains(pluginConfig.BackdropSize)) { - pluginConfig.BackdropSize = pluginConfig.BackdropSizeOptions[^1]; + pluginConfig.BackdropSize = imageConfig.BackdropSizes[^1]; } - pluginConfig.ProfileSizeOptions = imageConfig.ProfileSizes; - if (!pluginConfig.ProfileSizeOptions.Contains(pluginConfig.ProfileSize)) + if (!imageConfig.ProfileSizes.Contains(pluginConfig.ProfileSize)) { - pluginConfig.ProfileSize = pluginConfig.ProfileSizeOptions[^1]; + pluginConfig.ProfileSize = imageConfig.ProfileSizes[^1]; } - pluginConfig.StillSizeOptions = imageConfig.StillSizes; - if (!pluginConfig.StillSizeOptions.Contains(pluginConfig.StillSize)) + if (!imageConfig.StillSizes.Contains(pluginConfig.StillSize)) { - pluginConfig.StillSize = pluginConfig.StillSizeOptions[^1]; + pluginConfig.StillSize = imageConfig.StillSizes[^1]; } } + /// + /// Gets the configuration. + /// + /// The configuration. + public async Task GetClientConfiguration() + { + await EnsureClientConfigAsync().ConfigureAwait(false); + + return _tmDbClient.Config; + } + /// public void Dispose() {