| | | 1 | | using System; |
| | | 2 | | using System.Collections.Frozen; |
| | | 3 | | using System.Collections.Generic; |
| | | 4 | | using System.Diagnostics.CodeAnalysis; |
| | | 5 | | using System.Text.RegularExpressions; |
| | | 6 | | using Jellyfin.Data.Enums; |
| | | 7 | | using MediaBrowser.Model.Entities; |
| | | 8 | | using TMDbLib.Objects.General; |
| | | 9 | | |
| | | 10 | | namespace MediaBrowser.Providers.Plugins.Tmdb |
| | | 11 | | { |
| | | 12 | | /// <summary> |
| | | 13 | | /// Utilities for the TMDb provider. |
| | | 14 | | /// </summary> |
| | | 15 | | public static partial class TmdbUtils |
| | | 16 | | { |
| | | 17 | | /// <summary> |
| | | 18 | | /// URL of the TMDb instance to use. |
| | | 19 | | /// </summary> |
| | | 20 | | public const string BaseTmdbUrl = "https://www.themoviedb.org/"; |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// Name of the provider. |
| | | 24 | | /// </summary> |
| | | 25 | | public const string ProviderName = "TheMovieDb"; |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// API key to use when performing an API call. |
| | | 29 | | /// </summary> |
| | | 30 | | public const string ApiKey = "4219e299c89411838049ab0dab19ebd5"; |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// The crew types to keep. |
| | | 34 | | /// </summary> |
| | 0 | 35 | | public static readonly string[] WantedCrewTypes = |
| | 0 | 36 | | { |
| | 0 | 37 | | PersonType.Director, |
| | 0 | 38 | | PersonType.Writer, |
| | 0 | 39 | | PersonType.Producer |
| | 0 | 40 | | }; |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// The crew kinds to keep. |
| | | 44 | | /// </summary> |
| | 0 | 45 | | public static readonly PersonKind[] WantedCrewKinds = |
| | 0 | 46 | | { |
| | 0 | 47 | | PersonKind.Director, |
| | 0 | 48 | | PersonKind.Writer, |
| | 0 | 49 | | PersonKind.Producer |
| | 0 | 50 | | }; |
| | | 51 | | |
| | | 52 | | /// <summary> |
| | | 53 | | /// Writing jobs to keep. |
| | | 54 | | /// </summary> |
| | 0 | 55 | | private static readonly FrozenSet<string> _writerJobs = new[] |
| | 0 | 56 | | { |
| | 0 | 57 | | "writer", |
| | 0 | 58 | | "screenplay", |
| | 0 | 59 | | "novel" |
| | 0 | 60 | | }.ToFrozenSet(StringComparer.OrdinalIgnoreCase); |
| | | 61 | | |
| | | 62 | | [GeneratedRegex(@"[\W_-[·]]+")] |
| | | 63 | | private static partial Regex NonWordRegex(); |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Cleans the name according to TMDb requirements. |
| | | 67 | | /// </summary> |
| | | 68 | | /// <param name="name">The name of the entity.</param> |
| | | 69 | | /// <returns>The cleaned name.</returns> |
| | | 70 | | public static string CleanName(string name) |
| | | 71 | | { |
| | | 72 | | // TMDb expects a space separated list of words make sure that is the case |
| | 0 | 73 | | return NonWordRegex().Replace(name, " "); |
| | | 74 | | } |
| | | 75 | | |
| | | 76 | | /// <summary> |
| | | 77 | | /// Maps the TMDb provided roles for crew members to Jellyfin roles. |
| | | 78 | | /// </summary> |
| | | 79 | | /// <param name="crew">Crew member to map against the Jellyfin person types.</param> |
| | | 80 | | /// <returns>The Jellyfin person type.</returns> |
| | | 81 | | public static PersonKind MapCrewToPersonType(Crew crew) |
| | | 82 | | { |
| | 0 | 83 | | if (string.Equals(crew.Department, "directing", StringComparison.OrdinalIgnoreCase) |
| | 0 | 84 | | && string.Equals(crew.Job, "director", StringComparison.OrdinalIgnoreCase)) |
| | | 85 | | { |
| | 0 | 86 | | return PersonKind.Director; |
| | | 87 | | } |
| | | 88 | | |
| | 0 | 89 | | if (string.Equals(crew.Department, "production", StringComparison.OrdinalIgnoreCase) |
| | 0 | 90 | | && string.Equals(crew.Job, "producer", StringComparison.OrdinalIgnoreCase)) |
| | | 91 | | { |
| | 0 | 92 | | return PersonKind.Producer; |
| | | 93 | | } |
| | | 94 | | |
| | 0 | 95 | | if (string.Equals(crew.Department, "writing", StringComparison.OrdinalIgnoreCase) |
| | 0 | 96 | | && crew.Job is not null && _writerJobs.Contains(crew.Job)) |
| | | 97 | | { |
| | 0 | 98 | | return PersonKind.Writer; |
| | | 99 | | } |
| | | 100 | | |
| | 0 | 101 | | return PersonKind.Unknown; |
| | | 102 | | } |
| | | 103 | | |
| | | 104 | | /// <summary> |
| | | 105 | | /// Determines whether a video is a trailer. |
| | | 106 | | /// </summary> |
| | | 107 | | /// <param name="video">The TMDb video.</param> |
| | | 108 | | /// <returns>A boolean indicating whether the video is a trailer.</returns> |
| | | 109 | | public static bool IsTrailerType(Video video) |
| | | 110 | | { |
| | 0 | 111 | | return string.Equals(video.Site, "youtube", StringComparison.OrdinalIgnoreCase) |
| | 0 | 112 | | && (string.Equals(video.Type, "trailer", StringComparison.OrdinalIgnoreCase) |
| | 0 | 113 | | || string.Equals(video.Type, "teaser", StringComparison.OrdinalIgnoreCase)); |
| | | 114 | | } |
| | | 115 | | |
| | | 116 | | /// <summary> |
| | | 117 | | /// Normalizes a language string for use with TMDb's include image language parameter. |
| | | 118 | | /// </summary> |
| | | 119 | | /// <param name="preferredLanguage">The preferred language as either a 2 letter code with or without country cod |
| | | 120 | | /// <param name="countryCode">The country code, ISO 3166-1.</param> |
| | | 121 | | /// <returns>The comma separated language string.</returns> |
| | | 122 | | public static string GetImageLanguagesParam(string preferredLanguage, string? countryCode = null) |
| | | 123 | | { |
| | 0 | 124 | | var languages = new List<string>(); |
| | | 125 | | |
| | 0 | 126 | | if (!string.IsNullOrEmpty(preferredLanguage)) |
| | | 127 | | { |
| | 0 | 128 | | preferredLanguage = NormalizeLanguage(preferredLanguage, countryCode); |
| | | 129 | | |
| | 0 | 130 | | languages.Add(preferredLanguage); |
| | | 131 | | } |
| | | 132 | | |
| | 0 | 133 | | languages.Add("null"); |
| | | 134 | | |
| | | 135 | | // Always add English as fallback language |
| | 0 | 136 | | if (!string.Equals(preferredLanguage, "en", StringComparison.OrdinalIgnoreCase)) |
| | | 137 | | { |
| | 0 | 138 | | languages.Add("en"); |
| | | 139 | | } |
| | | 140 | | |
| | 0 | 141 | | return string.Join(',', languages); |
| | | 142 | | } |
| | | 143 | | |
| | | 144 | | /// <summary> |
| | | 145 | | /// Normalizes a language string for use with TMDb's language parameter. |
| | | 146 | | /// </summary> |
| | | 147 | | /// <param name="language">The language code.</param> |
| | | 148 | | /// <param name="countryCode">The country code.</param> |
| | | 149 | | /// <returns>The normalized language code.</returns> |
| | | 150 | | [return: NotNullIfNotNull(nameof(language))] |
| | | 151 | | public static string? NormalizeLanguage(string? language, string? countryCode = null) |
| | | 152 | | { |
| | 7 | 153 | | if (string.IsNullOrEmpty(language)) |
| | | 154 | | { |
| | 2 | 155 | | return language; |
| | | 156 | | } |
| | | 157 | | |
| | | 158 | | // Handle es-419 (Latin American Spanish) by converting to regional variant |
| | 5 | 159 | | if (string.Equals(language, "es-419", StringComparison.OrdinalIgnoreCase) && !string.IsNullOrEmpty(countryCo |
| | | 160 | | { |
| | 0 | 161 | | language = string.Equals(countryCode, "AR", StringComparison.OrdinalIgnoreCase) |
| | 0 | 162 | | ? "es-AR" |
| | 0 | 163 | | : "es-MX"; |
| | | 164 | | } |
| | | 165 | | |
| | | 166 | | // TMDb requires this to be uppercase |
| | | 167 | | // Everything after the hyphen must be written in uppercase due to a way TMDb wrote their API. |
| | | 168 | | // See here: https://www.themoviedb.org/talk/5119221d760ee36c642af4ad?page=3#56e372a0c3a3685a9e0019ab |
| | 5 | 169 | | var parts = language.Split('-'); |
| | | 170 | | |
| | 5 | 171 | | if (parts.Length == 2) |
| | | 172 | | { |
| | | 173 | | // TMDb doesn't support Switzerland (de-CH, it-CH or fr-CH) so use the language (de, it or fr) without c |
| | 3 | 174 | | if (string.Equals(parts[1], "CH", StringComparison.OrdinalIgnoreCase)) |
| | | 175 | | { |
| | 1 | 176 | | return parts[0]; |
| | | 177 | | } |
| | | 178 | | |
| | 2 | 179 | | language = parts[0] + "-" + parts[1].ToUpperInvariant(); |
| | | 180 | | } |
| | | 181 | | |
| | 4 | 182 | | return language; |
| | | 183 | | } |
| | | 184 | | |
| | | 185 | | /// <summary> |
| | | 186 | | /// Adjusts the image's language code preferring the 5 letter language code eg. en-US. |
| | | 187 | | /// </summary> |
| | | 188 | | /// <param name="imageLanguage">The image's actual language code.</param> |
| | | 189 | | /// <param name="requestLanguage">The requested language code.</param> |
| | | 190 | | /// <returns>The language code.</returns> |
| | | 191 | | public static string AdjustImageLanguage(string? imageLanguage, string requestLanguage) |
| | | 192 | | { |
| | 5 | 193 | | if (string.IsNullOrEmpty(imageLanguage)) |
| | | 194 | | { |
| | 1 | 195 | | return string.Empty; |
| | | 196 | | } |
| | | 197 | | |
| | 4 | 198 | | if (!string.IsNullOrEmpty(requestLanguage) |
| | 4 | 199 | | && requestLanguage.Length > 2 |
| | 4 | 200 | | && imageLanguage.Length == 2 |
| | 4 | 201 | | && requestLanguage.StartsWith(imageLanguage, StringComparison.OrdinalIgnoreCase)) |
| | | 202 | | { |
| | 1 | 203 | | return requestLanguage; |
| | | 204 | | } |
| | | 205 | | |
| | | 206 | | // TMDb now returns xx for no language instead of an empty string. |
| | 3 | 207 | | return string.Equals(imageLanguage, "xx", StringComparison.OrdinalIgnoreCase) |
| | 3 | 208 | | ? string.Empty |
| | 3 | 209 | | : imageLanguage; |
| | | 210 | | } |
| | | 211 | | |
| | | 212 | | /// <summary> |
| | | 213 | | /// Combines the metadata country code and the parental rating from the API into the value we store in our datab |
| | | 214 | | /// </summary> |
| | | 215 | | /// <param name="countryCode">The ISO 3166-1 country code of the rating country.</param> |
| | | 216 | | /// <param name="ratingValue">The rating value returned by the TMDb API.</param> |
| | | 217 | | /// <returns>The combined parental rating of country code+rating value.</returns> |
| | | 218 | | public static string BuildParentalRating(string countryCode, string ratingValue) |
| | | 219 | | { |
| | | 220 | | // Exclude US because we store US values as TV-14 without the country code. |
| | 0 | 221 | | var ratingPrefix = string.Equals(countryCode, "US", StringComparison.OrdinalIgnoreCase) ? string.Empty : cou |
| | 0 | 222 | | var newRating = ratingPrefix + ratingValue; |
| | | 223 | | |
| | 0 | 224 | | return newRating.Replace("DE-", "FSK-", StringComparison.OrdinalIgnoreCase); |
| | | 225 | | } |
| | | 226 | | } |
| | | 227 | | } |