| | 1 | | using System; |
| | 2 | | using System.Collections.Generic; |
| | 3 | | using System.Globalization; |
| | 4 | | using System.IO; |
| | 5 | | using System.Linq; |
| | 6 | | using System.Text; |
| | 7 | | using System.Threading; |
| | 8 | | using System.Xml; |
| | 9 | | using Jellyfin.Data.Enums; |
| | 10 | | using Jellyfin.Extensions; |
| | 11 | | using MediaBrowser.Common.Configuration; |
| | 12 | | using MediaBrowser.Common.Providers; |
| | 13 | | using MediaBrowser.Controller.Entities; |
| | 14 | | using MediaBrowser.Controller.Entities.Movies; |
| | 15 | | using MediaBrowser.Controller.Entities.TV; |
| | 16 | | using MediaBrowser.Controller.Extensions; |
| | 17 | | using MediaBrowser.Controller.Library; |
| | 18 | | using MediaBrowser.Controller.Providers; |
| | 19 | | using MediaBrowser.Model.Entities; |
| | 20 | | using MediaBrowser.XbmcMetadata.Configuration; |
| | 21 | | using MediaBrowser.XbmcMetadata.Savers; |
| | 22 | | using Microsoft.Extensions.Logging; |
| | 23 | |
|
| | 24 | | namespace MediaBrowser.XbmcMetadata.Parsers |
| | 25 | | { |
| | 26 | | /// <summary> |
| | 27 | | /// The BaseNfoParser class. |
| | 28 | | /// </summary> |
| | 29 | | /// <typeparam name="T">The type.</typeparam> |
| | 30 | | public class BaseNfoParser<T> |
| | 31 | | where T : BaseItem |
| | 32 | | { |
| | 33 | | private readonly IConfigurationManager _config; |
| | 34 | | private readonly IUserManager _userManager; |
| | 35 | | private readonly IUserDataManager _userDataManager; |
| | 36 | | private readonly IDirectoryService _directoryService; |
| | 37 | | private Dictionary<string, string> _validProviderIds; |
| | 38 | |
|
| | 39 | | /// <summary> |
| | 40 | | /// Initializes a new instance of the <see cref="BaseNfoParser{T}" /> class. |
| | 41 | | /// </summary> |
| | 42 | | /// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param> |
| | 43 | | /// <param name="config">Instance of the <see cref="IConfigurationManager"/> interface.</param> |
| | 44 | | /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param> |
| | 45 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | 46 | | /// <param name="userDataManager">Instance of the <see cref="IUserDataManager"/> interface.</param> |
| | 47 | | /// <param name="directoryService">Instance of the <see cref="IDirectoryService"/> interface.</param> |
| | 48 | | public BaseNfoParser( |
| | 49 | | ILogger logger, |
| | 50 | | IConfigurationManager config, |
| | 51 | | IProviderManager providerManager, |
| | 52 | | IUserManager userManager, |
| | 53 | | IUserDataManager userDataManager, |
| | 54 | | IDirectoryService directoryService) |
| | 55 | | { |
| 31 | 56 | | Logger = logger; |
| 31 | 57 | | _config = config; |
| 31 | 58 | | ProviderManager = providerManager; |
| 31 | 59 | | _validProviderIds = new Dictionary<string, string>(); |
| 31 | 60 | | _userManager = userManager; |
| 31 | 61 | | _userDataManager = userDataManager; |
| 31 | 62 | | _directoryService = directoryService; |
| 31 | 63 | | } |
| | 64 | |
|
| | 65 | | /// <summary> |
| | 66 | | /// Gets the logger. |
| | 67 | | /// </summary> |
| | 68 | | protected ILogger Logger { get; } |
| | 69 | |
|
| | 70 | | /// <summary> |
| | 71 | | /// Gets the provider manager. |
| | 72 | | /// </summary> |
| | 73 | | protected IProviderManager ProviderManager { get; } |
| | 74 | |
|
| | 75 | | /// <summary> |
| | 76 | | /// Gets a value indicating whether URLs after a closing XML tag are supported. |
| | 77 | | /// </summary> |
| 3 | 78 | | protected virtual bool SupportsUrlAfterClosingXmlTag => false; |
| | 79 | |
|
| | 80 | | /// <summary> |
| | 81 | | /// Fetches metadata for an item from one xml file. |
| | 82 | | /// </summary> |
| | 83 | | /// <param name="item">The <see cref="MetadataResult{T}"/>.</param> |
| | 84 | | /// <param name="metadataFile">The metadata file.</param> |
| | 85 | | /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param> |
| | 86 | | /// <exception cref="ArgumentNullException"><c>item</c> is <c>null</c>.</exception> |
| | 87 | | /// <exception cref="ArgumentException"><c>metadataFile</c> is <c>null</c> or empty.</exception> |
| | 88 | | public void Fetch(MetadataResult<T> item, string metadataFile, CancellationToken cancellationToken) |
| | 89 | | { |
| 31 | 90 | | if (item.Item is null) |
| | 91 | | { |
| 7 | 92 | | throw new ArgumentException("Item can't be null.", nameof(item)); |
| | 93 | | } |
| | 94 | |
|
| 24 | 95 | | ArgumentException.ThrowIfNullOrEmpty(metadataFile); |
| | 96 | |
|
| 17 | 97 | | _validProviderIds = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase); |
| | 98 | |
|
| 17 | 99 | | var idInfos = ProviderManager.GetExternalIdInfos(item.Item); |
| | 100 | |
|
| 60 | 101 | | foreach (var info in idInfos) |
| | 102 | | { |
| 13 | 103 | | var id = info.Key + "Id"; |
| 13 | 104 | | _validProviderIds.TryAdd(id, info.Key); |
| | 105 | | } |
| | 106 | |
|
| | 107 | | // Additional Mappings |
| 17 | 108 | | _validProviderIds.Add("collectionnumber", "TmdbCollection"); |
| 17 | 109 | | _validProviderIds.Add("tmdbcolid", "TmdbCollection"); |
| 17 | 110 | | _validProviderIds.Add("tmdbcol", "TmdbCollection"); |
| 17 | 111 | | _validProviderIds.Add("imdb_id", "Imdb"); |
| | 112 | |
|
| 17 | 113 | | Fetch(item, metadataFile, GetXmlReaderSettings(), cancellationToken); |
| 17 | 114 | | } |
| | 115 | |
|
| | 116 | | /// <summary> |
| | 117 | | /// Fetches the specified item. |
| | 118 | | /// </summary> |
| | 119 | | /// <param name="item">The <see cref="MetadataResult{T}"/>.</param> |
| | 120 | | /// <param name="metadataFile">The metadata file.</param> |
| | 121 | | /// <param name="settings">The <see cref="XmlReaderSettings"/>.</param> |
| | 122 | | /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param> |
| | 123 | | protected virtual void Fetch(MetadataResult<T> item, string metadataFile, XmlReaderSettings settings, Cancellati |
| | 124 | | { |
| 13 | 125 | | if (!SupportsUrlAfterClosingXmlTag) |
| | 126 | | { |
| 3 | 127 | | using (var fileStream = File.OpenRead(metadataFile)) |
| 3 | 128 | | using (var streamReader = new StreamReader(fileStream, Encoding.UTF8)) |
| 3 | 129 | | using (var reader = XmlReader.Create(streamReader, settings)) |
| | 130 | | { |
| 3 | 131 | | item.ResetPeople(); |
| | 132 | |
|
| 3 | 133 | | reader.MoveToContent(); |
| 3 | 134 | | reader.Read(); |
| | 135 | |
|
| | 136 | | // Loop through each element |
| 187 | 137 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 138 | | { |
| 184 | 139 | | cancellationToken.ThrowIfCancellationRequested(); |
| | 140 | |
|
| 184 | 141 | | if (reader.NodeType == XmlNodeType.Element) |
| | 142 | | { |
| 82 | 143 | | FetchDataFromXmlNode(reader, item); |
| | 144 | | } |
| | 145 | | else |
| | 146 | | { |
| 102 | 147 | | reader.Read(); |
| | 148 | | } |
| | 149 | | } |
| 3 | 150 | | } |
| | 151 | |
|
| 3 | 152 | | return; |
| | 153 | | } |
| | 154 | |
|
| 10 | 155 | | item.ResetPeople(); |
| | 156 | |
|
| | 157 | | // Need to handle a url after the xml data |
| | 158 | | // http://kodi.wiki/view/NFO_files/movies |
| | 159 | |
|
| 10 | 160 | | var xml = File.ReadAllText(metadataFile); |
| | 161 | |
|
| | 162 | | // Find last closing Tag |
| | 163 | | // Need to do this in two steps to account for random > characters after the closing xml |
| 10 | 164 | | var index = xml.LastIndexOf("</", StringComparison.Ordinal); |
| | 165 | |
|
| | 166 | | // If closing tag exists, move to end of Tag |
| 10 | 167 | | if (index != -1) |
| | 168 | | { |
| 6 | 169 | | index = xml.IndexOf('>', index); |
| | 170 | | } |
| | 171 | |
|
| 10 | 172 | | if (index != -1) |
| | 173 | | { |
| 6 | 174 | | var endingXml = xml.AsSpan().Slice(index); |
| | 175 | |
|
| 6 | 176 | | ParseProviderLinks(item.Item, endingXml); |
| | 177 | |
|
| | 178 | | // If the file is just an IMDb url, don't go any further |
| 6 | 179 | | if (index == 0) |
| | 180 | | { |
| 0 | 181 | | return; |
| | 182 | | } |
| | 183 | |
|
| 6 | 184 | | xml = xml.Substring(0, index + 1); |
| | 185 | | } |
| | 186 | | else |
| | 187 | | { |
| | 188 | | // If the file is just provider urls, handle that |
| 4 | 189 | | ParseProviderLinks(item.Item, xml); |
| | 190 | |
|
| 4 | 191 | | return; |
| | 192 | | } |
| | 193 | |
|
| | 194 | | // These are not going to be valid xml so no sense in causing the provider to fail and spamming the log with |
| | 195 | | try |
| | 196 | | { |
| 6 | 197 | | using (var stringReader = new StringReader(xml)) |
| 6 | 198 | | using (var reader = XmlReader.Create(stringReader, settings)) |
| | 199 | | { |
| 6 | 200 | | reader.MoveToContent(); |
| 6 | 201 | | reader.Read(); |
| | 202 | |
|
| | 203 | | // Loop through each element |
| 617 | 204 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 205 | | { |
| 611 | 206 | | cancellationToken.ThrowIfCancellationRequested(); |
| | 207 | |
|
| 611 | 208 | | if (reader.NodeType == XmlNodeType.Element) |
| | 209 | | { |
| 285 | 210 | | FetchDataFromXmlNode(reader, item); |
| | 211 | | } |
| | 212 | | else |
| | 213 | | { |
| 326 | 214 | | reader.Read(); |
| | 215 | | } |
| | 216 | | } |
| 6 | 217 | | } |
| 6 | 218 | | } |
| 0 | 219 | | catch (XmlException) |
| | 220 | | { |
| 0 | 221 | | } |
| 6 | 222 | | } |
| | 223 | |
|
| | 224 | | /// <summary> |
| | 225 | | /// Parses a XML tag to a provider id. |
| | 226 | | /// </summary> |
| | 227 | | /// <param name="item">The item.</param> |
| | 228 | | /// <param name="xml">The xml tag.</param> |
| | 229 | | protected void ParseProviderLinks(T item, ReadOnlySpan<char> xml) |
| | 230 | | { |
| 10 | 231 | | if (ProviderIdParsers.TryFindImdbId(xml, out var imdbId)) |
| | 232 | | { |
| 2 | 233 | | item.SetProviderId(MetadataProvider.Imdb, imdbId.ToString()); |
| | 234 | | } |
| | 235 | |
|
| 10 | 236 | | if (item is Movie) |
| | 237 | | { |
| 7 | 238 | | if (ProviderIdParsers.TryFindTmdbMovieId(xml, out var tmdbId)) |
| | 239 | | { |
| 2 | 240 | | item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString()); |
| | 241 | | } |
| | 242 | | } |
| | 243 | |
|
| 10 | 244 | | if (item is Series) |
| | 245 | | { |
| 2 | 246 | | if (ProviderIdParsers.TryFindTmdbSeriesId(xml, out var tmdbId)) |
| | 247 | | { |
| 0 | 248 | | item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString()); |
| | 249 | | } |
| | 250 | |
|
| 2 | 251 | | if (ProviderIdParsers.TryFindTvdbId(xml, out var tvdbId)) |
| | 252 | | { |
| 1 | 253 | | item.SetProviderId(MetadataProvider.Tvdb, tvdbId.ToString()); |
| | 254 | | } |
| | 255 | | } |
| 10 | 256 | | } |
| | 257 | |
|
| | 258 | | /// <summary> |
| | 259 | | /// Fetches metadata from an XML node. |
| | 260 | | /// </summary> |
| | 261 | | /// <param name="reader">The <see cref="XmlReader"/>.</param> |
| | 262 | | /// <param name="itemResult">The <see cref="MetadataResult{T}"/>.</param> |
| | 263 | | protected virtual void FetchDataFromXmlNode(XmlReader reader, MetadataResult<T> itemResult) |
| | 264 | | { |
| 449 | 265 | | var item = itemResult.Item; |
| 449 | 266 | | var nfoConfiguration = _config.GetNfoConfiguration(); |
| | 267 | | UserItemData? userData; |
| | 268 | |
|
| 449 | 269 | | switch (reader.Name) |
| | 270 | | { |
| | 271 | | case "dateadded": |
| 5 | 272 | | if (reader.TryReadDateTime(out var dateCreated)) |
| | 273 | | { |
| 5 | 274 | | item.DateCreated = dateCreated; |
| | 275 | | } |
| | 276 | |
|
| 5 | 277 | | break; |
| | 278 | | case "originaltitle": |
| 8 | 279 | | item.OriginalTitle = reader.ReadNormalizedString(); |
| 8 | 280 | | break; |
| | 281 | | case "name": |
| | 282 | | case "title": |
| | 283 | | case "localtitle": |
| 15 | 284 | | item.Name = reader.ReadNormalizedString(); |
| 15 | 285 | | break; |
| | 286 | | case "sortname": |
| 1 | 287 | | item.SortName = reader.ReadNormalizedString(); |
| 1 | 288 | | break; |
| | 289 | | case "criticrating": |
| 1 | 290 | | var criticRatingText = reader.ReadElementContentAsString(); |
| 1 | 291 | | if (float.TryParse(criticRatingText, CultureInfo.InvariantCulture, out var value)) |
| | 292 | | { |
| 1 | 293 | | item.CriticRating = value; |
| | 294 | | } |
| | 295 | |
|
| 1 | 296 | | break; |
| | 297 | | case "sorttitle": |
| 1 | 298 | | item.ForcedSortName = reader.ReadNormalizedString(); |
| 1 | 299 | | break; |
| | 300 | | case "biography": |
| | 301 | | case "plot": |
| | 302 | | case "review": |
| 13 | 303 | | item.Overview = reader.ReadNormalizedString(); |
| 13 | 304 | | break; |
| | 305 | | case "language": |
| 1 | 306 | | item.PreferredMetadataLanguage = reader.ReadNormalizedString(); |
| 1 | 307 | | break; |
| | 308 | | case "watched": |
| 8 | 309 | | var played = reader.ReadElementContentAsBoolean(); |
| 8 | 310 | | if (Guid.TryParse(nfoConfiguration.UserId, out var userId)) |
| | 311 | | { |
| 1 | 312 | | var user = _userManager.GetUserById(userId); |
| 1 | 313 | | if (user is not null) |
| | 314 | | { |
| 1 | 315 | | userData = _userDataManager.GetUserData(user, item); |
| 1 | 316 | | if (userData is not null) |
| | 317 | | { |
| 1 | 318 | | userData.Played = played; |
| 1 | 319 | | _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, Cancellat |
| | 320 | | } |
| | 321 | | } |
| | 322 | | } |
| | 323 | |
|
| 1 | 324 | | break; |
| | 325 | | case "playcount": |
| 4 | 326 | | if (reader.TryReadInt(out var count) |
| 4 | 327 | | && Guid.TryParse(nfoConfiguration.UserId, out var playCountUserId)) |
| | 328 | | { |
| 1 | 329 | | var user = _userManager.GetUserById(playCountUserId); |
| 1 | 330 | | if (user is not null) |
| | 331 | | { |
| 1 | 332 | | userData = _userDataManager.GetUserData(user, item); |
| 1 | 333 | | if (userData is not null) |
| | 334 | | { |
| 1 | 335 | | userData.PlayCount = count; |
| 1 | 336 | | _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, Cancellat |
| | 337 | | } |
| | 338 | | } |
| | 339 | | } |
| | 340 | |
|
| 1 | 341 | | break; |
| | 342 | | case "lastplayed": |
| 4 | 343 | | if (reader.TryReadDateTime(out var lastPlayed) |
| 4 | 344 | | && Guid.TryParse(nfoConfiguration.UserId, out var lastPlayedUserId)) |
| | 345 | | { |
| 1 | 346 | | var user = _userManager.GetUserById(lastPlayedUserId); |
| 1 | 347 | | if (user is not null) |
| | 348 | | { |
| 1 | 349 | | userData = _userDataManager.GetUserData(user, item); |
| 1 | 350 | | if (userData is not null) |
| | 351 | | { |
| 1 | 352 | | userData.LastPlayedDate = lastPlayed; |
| 1 | 353 | | _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, Cancellat |
| | 354 | | } |
| | 355 | | } |
| | 356 | | } |
| | 357 | |
|
| 1 | 358 | | break; |
| | 359 | | case "countrycode": |
| 1 | 360 | | item.PreferredMetadataCountryCode = reader.ReadNormalizedString(); |
| 1 | 361 | | break; |
| | 362 | | case "lockedfields": |
| | 363 | | { |
| 0 | 364 | | var val = reader.ReadElementContentAsString(); |
| | 365 | |
|
| 0 | 366 | | if (!string.IsNullOrWhiteSpace(val)) |
| | 367 | | { |
| 0 | 368 | | item.LockedFields = val.Split('|').Select(i => |
| 0 | 369 | | { |
| 0 | 370 | | if (Enum.TryParse(i, true, out MetadataField field)) |
| 0 | 371 | | { |
| 0 | 372 | | return (MetadataField?)field; |
| 0 | 373 | | } |
| 0 | 374 | |
|
| 0 | 375 | | return null; |
| 0 | 376 | | }).OfType<MetadataField>().ToArray(); |
| | 377 | | } |
| | 378 | |
|
| 0 | 379 | | break; |
| | 380 | | } |
| | 381 | |
|
| | 382 | | case "tagline": |
| 4 | 383 | | item.Tagline = reader.ReadNormalizedString(); |
| 4 | 384 | | break; |
| | 385 | | case "country": |
| | 386 | | { |
| 3 | 387 | | var val = reader.ReadElementContentAsString(); |
| | 388 | |
|
| 3 | 389 | | if (!string.IsNullOrWhiteSpace(val)) |
| | 390 | | { |
| 3 | 391 | | item.ProductionLocations = val.Split('/') |
| 3 | 392 | | .Select(i => i.Trim()) |
| 3 | 393 | | .Where(i => !string.IsNullOrWhiteSpace(i)) |
| 3 | 394 | | .ToArray(); |
| | 395 | | } |
| | 396 | |
|
| 3 | 397 | | break; |
| | 398 | | } |
| | 399 | |
|
| | 400 | | case "mpaa": |
| 4 | 401 | | item.OfficialRating = reader.ReadNormalizedString(); |
| 4 | 402 | | break; |
| | 403 | | case "customrating": |
| 1 | 404 | | item.CustomRating = reader.ReadNormalizedString(); |
| 1 | 405 | | break; |
| | 406 | | case "runtime": |
| 4 | 407 | | var runtimeText = reader.ReadElementContentAsString(); |
| 4 | 408 | | if (int.TryParse(runtimeText.AsSpan().LeftPart(' '), NumberStyles.Integer, CultureInfo.InvariantCult |
| | 409 | | { |
| 4 | 410 | | item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks; |
| | 411 | | } |
| | 412 | |
|
| 4 | 413 | | break; |
| | 414 | | case "aspectratio": |
| 1 | 415 | | var aspectRatio = reader.ReadNormalizedString(); |
| 1 | 416 | | if (!string.IsNullOrEmpty(aspectRatio) && item is IHasAspectRatio hasAspectRatio) |
| | 417 | | { |
| 1 | 418 | | hasAspectRatio.AspectRatio = aspectRatio; |
| | 419 | | } |
| | 420 | |
|
| 1 | 421 | | break; |
| | 422 | | case "lockdata": |
| 1 | 423 | | item.IsLocked = string.Equals(reader.ReadElementContentAsString(), "true", StringComparison.OrdinalI |
| 1 | 424 | | break; |
| | 425 | | case "studio": |
| 4 | 426 | | var studio = reader.ReadNormalizedString(); |
| 4 | 427 | | if (!string.IsNullOrEmpty(studio)) |
| | 428 | | { |
| 4 | 429 | | item.AddStudio(studio); |
| | 430 | | } |
| | 431 | |
|
| 4 | 432 | | break; |
| | 433 | | case "director": |
| 12 | 434 | | foreach (var director in reader.GetPersonArray(PersonKind.Director)) |
| | 435 | | { |
| 3 | 436 | | itemResult.AddPerson(director); |
| | 437 | | } |
| | 438 | |
|
| | 439 | | break; |
| | 440 | | case "credits": |
| | 441 | | { |
| 4 | 442 | | var val = reader.ReadElementContentAsString(); |
| | 443 | |
|
| 4 | 444 | | if (!string.IsNullOrWhiteSpace(val)) |
| | 445 | | { |
| 4 | 446 | | var parts = val.Split('/').Select(i => i.Trim()) |
| 4 | 447 | | .Where(i => !string.IsNullOrEmpty(i)); |
| | 448 | |
|
| 16 | 449 | | foreach (var p in parts.Select(v => new PersonInfo { Name = v.Trim(), Type = PersonKind.Writ |
| | 450 | | { |
| 4 | 451 | | if (string.IsNullOrWhiteSpace(p.Name)) |
| | 452 | | { |
| | 453 | | continue; |
| | 454 | | } |
| | 455 | |
|
| 4 | 456 | | itemResult.AddPerson(p); |
| | 457 | | } |
| | 458 | | } |
| | 459 | |
|
| | 460 | | break; |
| | 461 | | } |
| | 462 | |
|
| | 463 | | case "writer": |
| 4 | 464 | | foreach (var writer in reader.GetPersonArray(PersonKind.Writer)) |
| | 465 | | { |
| 1 | 466 | | itemResult.AddPerson(writer); |
| | 467 | | } |
| | 468 | |
|
| | 469 | | break; |
| | 470 | | case "actor": |
| 55 | 471 | | var person = reader.GetPersonFromXmlNode(); |
| 55 | 472 | | if (person is not null) |
| | 473 | | { |
| 55 | 474 | | itemResult.AddPerson(person); |
| | 475 | | } |
| | 476 | |
|
| 55 | 477 | | break; |
| | 478 | | case "trailer": |
| 4 | 479 | | var trailer = reader.ReadNormalizedString(); |
| 4 | 480 | | if (!string.IsNullOrEmpty(trailer)) |
| | 481 | | { |
| 1 | 482 | | if (trailer.StartsWith("plugin://plugin.video.youtube/?action=play_video&videoid=", StringCompar |
| | 483 | | { |
| | 484 | | // Deprecated format |
| 1 | 485 | | item.AddTrailerUrl(trailer.Replace( |
| 1 | 486 | | "plugin://plugin.video.youtube/?action=play_video&videoid=", |
| 1 | 487 | | BaseNfoSaver.YouTubeWatchUrl, |
| 1 | 488 | | StringComparison.OrdinalIgnoreCase)); |
| | 489 | |
|
| 1 | 490 | | var suggestedUrl = trailer.Replace( |
| 1 | 491 | | "plugin://plugin.video.youtube/?action=play_video&videoid=", |
| 1 | 492 | | "plugin://plugin.video.youtube/play/?video_id=", |
| 1 | 493 | | StringComparison.OrdinalIgnoreCase); |
| 1 | 494 | | Logger.LogWarning("Trailer URL uses a deprecated format : {Url}. Using {NewUrl} instead is a |
| | 495 | | } |
| 0 | 496 | | else if (trailer.StartsWith("plugin://plugin.video.youtube/play/?video_id=", StringComparison.Or |
| | 497 | | { |
| | 498 | | // Proper format |
| 0 | 499 | | item.AddTrailerUrl(trailer.Replace( |
| 0 | 500 | | "plugin://plugin.video.youtube/play/?video_id=", |
| 0 | 501 | | BaseNfoSaver.YouTubeWatchUrl, |
| 0 | 502 | | StringComparison.OrdinalIgnoreCase)); |
| | 503 | | } |
| | 504 | | } |
| | 505 | |
|
| 0 | 506 | | break; |
| | 507 | | case "displayorder": |
| 0 | 508 | | var displayOrder = reader.ReadNormalizedString(); |
| 0 | 509 | | if (!string.IsNullOrEmpty(displayOrder) && item is IHasDisplayOrder hasDisplayOrder) |
| | 510 | | { |
| 0 | 511 | | hasDisplayOrder.DisplayOrder = displayOrder; |
| | 512 | | } |
| | 513 | |
|
| 0 | 514 | | break; |
| | 515 | | case "year": |
| 6 | 516 | | if (reader.TryReadInt(out var productionYear) && productionYear > 1850) |
| | 517 | | { |
| 6 | 518 | | item.ProductionYear = productionYear; |
| | 519 | | } |
| | 520 | |
|
| 6 | 521 | | break; |
| | 522 | | case "rating": |
| 7 | 523 | | var rating = reader.ReadElementContentAsString().Replace(',', '.'); |
| | 524 | | // All external meta is saving this as '.' for decimal I believe...but just to be sure |
| 7 | 525 | | if (float.TryParse(rating, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var com |
| | 526 | | { |
| 6 | 527 | | item.CommunityRating = communityRating; |
| | 528 | | } |
| | 529 | |
|
| 6 | 530 | | break; |
| | 531 | | case "ratings": |
| 3 | 532 | | FetchFromRatingsNode(reader, item); |
| 3 | 533 | | break; |
| | 534 | | case "aired": |
| | 535 | | case "formed": |
| | 536 | | case "premiered": |
| | 537 | | case "releasedate": |
| 19 | 538 | | if (reader.TryReadDateTimeExact(nfoConfiguration.ReleaseDateFormat, out var releaseDate)) |
| | 539 | | { |
| 14 | 540 | | item.PremiereDate = releaseDate; |
| | 541 | |
|
| | 542 | | // Production year can already be set by the year tag |
| 14 | 543 | | item.ProductionYear ??= releaseDate.Year; |
| | 544 | | } |
| | 545 | |
|
| | 546 | | break; |
| | 547 | | case "enddate": |
| 1 | 548 | | if (reader.TryReadDateTimeExact(nfoConfiguration.ReleaseDateFormat, out var endDate)) |
| | 549 | | { |
| 1 | 550 | | item.EndDate = endDate; |
| | 551 | | } |
| | 552 | |
|
| 1 | 553 | | break; |
| | 554 | | case "genre": |
| | 555 | | { |
| 13 | 556 | | var val = reader.ReadElementContentAsString(); |
| | 557 | |
|
| 13 | 558 | | if (!string.IsNullOrWhiteSpace(val)) |
| | 559 | | { |
| 13 | 560 | | var parts = val.Split('/') |
| 13 | 561 | | .Select(i => i.Trim()) |
| 13 | 562 | | .Where(i => !string.IsNullOrWhiteSpace(i)); |
| | 563 | |
|
| 52 | 564 | | foreach (var p in parts) |
| | 565 | | { |
| 13 | 566 | | item.AddGenre(p); |
| | 567 | | } |
| | 568 | | } |
| | 569 | |
|
| | 570 | | break; |
| | 571 | | } |
| | 572 | |
|
| | 573 | | case "style": |
| | 574 | | case "tag": |
| 2 | 575 | | var tag = reader.ReadNormalizedString(); |
| 2 | 576 | | if (!string.IsNullOrEmpty(tag)) |
| | 577 | | { |
| 2 | 578 | | item.AddTag(tag); |
| | 579 | | } |
| | 580 | |
|
| 2 | 581 | | break; |
| | 582 | | case "fileinfo": |
| 3 | 583 | | FetchFromFileInfoNode(reader, item); |
| 3 | 584 | | break; |
| | 585 | | case "uniqueid": |
| 8 | 586 | | if (reader.IsEmptyElement) |
| | 587 | | { |
| 0 | 588 | | reader.Read(); |
| 0 | 589 | | break; |
| | 590 | | } |
| | 591 | |
|
| 8 | 592 | | var provider = reader.GetAttribute("type"); |
| 8 | 593 | | var providerId = reader.ReadElementContentAsString(); |
| | 594 | |
|
| 8 | 595 | | if (!string.IsNullOrEmpty(provider)) |
| | 596 | | { |
| 8 | 597 | | if (_validProviderIds.TryGetValue(provider, out string? normalizedProvider)) |
| | 598 | | { |
| 2 | 599 | | item.TrySetProviderId(normalizedProvider, providerId); |
| | 600 | | } |
| | 601 | | else |
| | 602 | | { |
| 6 | 603 | | item.TrySetProviderId(provider, providerId); |
| | 604 | | } |
| | 605 | | } |
| | 606 | |
|
| 6 | 607 | | break; |
| | 608 | | case "thumb": |
| 166 | 609 | | FetchThumbNode(reader, itemResult, "thumb"); |
| 166 | 610 | | break; |
| | 611 | | case "fanart": |
| | 612 | | { |
| 4 | 613 | | if (reader.IsEmptyElement) |
| | 614 | | { |
| 0 | 615 | | reader.Read(); |
| 0 | 616 | | break; |
| | 617 | | } |
| | 618 | |
|
| 4 | 619 | | using var subtree = reader.ReadSubtree(); |
| 4 | 620 | | if (!subtree.ReadToDescendant("thumb")) |
| | 621 | | { |
| 0 | 622 | | break; |
| | 623 | | } |
| | 624 | |
|
| 4 | 625 | | FetchThumbNode(subtree, itemResult, "fanart"); |
| 4 | 626 | | break; |
| | 627 | | } |
| | 628 | |
|
| | 629 | | default: |
| 66 | 630 | | string readerName = reader.Name; |
| 66 | 631 | | if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue)) |
| | 632 | | { |
| 3 | 633 | | var id = reader.ReadElementContentAsString(); |
| 3 | 634 | | item.TrySetProviderId(providerIdValue, id); |
| | 635 | | } |
| | 636 | | else |
| | 637 | | { |
| 63 | 638 | | reader.Skip(); |
| | 639 | | } |
| | 640 | |
|
| | 641 | | break; |
| | 642 | | } |
| 113 | 643 | | } |
| | 644 | |
|
| | 645 | | private void FetchThumbNode(XmlReader reader, MetadataResult<T> itemResult, string parentNode) |
| | 646 | | { |
| 170 | 647 | | var artType = reader.GetAttribute("aspect"); |
| 170 | 648 | | var val = reader.ReadElementContentAsString(); |
| | 649 | |
|
| | 650 | | // artType is null if the thumb node is a child of the fanart tag |
| | 651 | | // -> set image type to fanart |
| 170 | 652 | | if (string.IsNullOrWhiteSpace(artType) && parentNode.Equals("fanart", StringComparison.Ordinal)) |
| | 653 | | { |
| 4 | 654 | | artType = "fanart"; |
| | 655 | | } |
| 166 | 656 | | else if (string.IsNullOrWhiteSpace(artType)) |
| | 657 | | { |
| | 658 | | // Sonarr writes thumb tags for posters without aspect property |
| 14 | 659 | | artType = "poster"; |
| | 660 | | } |
| | 661 | |
|
| | 662 | | // skip: |
| | 663 | | // - empty uri |
| | 664 | | // - tag containing '.' because we can't set images for seasons, episodes or movie sets within series or mov |
| 170 | 665 | | if (string.IsNullOrEmpty(val) || artType.Contains('.', StringComparison.Ordinal)) |
| | 666 | | { |
| 11 | 667 | | return; |
| | 668 | | } |
| | 669 | |
|
| 159 | 670 | | ImageType imageType = GetImageType(artType); |
| | 671 | |
|
| 159 | 672 | | if (!Uri.TryCreate(val, UriKind.Absolute, out var uri)) |
| | 673 | | { |
| 1 | 674 | | Logger.LogError("Image location {Path} specified in nfo file for {ItemName} is not a valid URL or file p |
| 1 | 675 | | return; |
| | 676 | | } |
| | 677 | |
|
| 158 | 678 | | if (uri.IsFile) |
| | 679 | | { |
| | 680 | | // only allow one item of each type |
| 2 | 681 | | if (itemResult.Images.Any(x => x.Type == imageType)) |
| | 682 | | { |
| 0 | 683 | | return; |
| | 684 | | } |
| | 685 | |
|
| 2 | 686 | | var fileSystemMetadata = _directoryService.GetFile(val); |
| | 687 | | // nonexistent file returns null |
| 2 | 688 | | if (fileSystemMetadata is null || !fileSystemMetadata.Exists) |
| | 689 | | { |
| 1 | 690 | | Logger.LogWarning("Artwork file {Path} specified in nfo file for {ItemName} does not exist.", uri, i |
| 1 | 691 | | return; |
| | 692 | | } |
| | 693 | |
|
| 1 | 694 | | itemResult.Images.Add(new LocalImageInfo() |
| 1 | 695 | | { |
| 1 | 696 | | FileInfo = fileSystemMetadata, |
| 1 | 697 | | Type = imageType |
| 1 | 698 | | }); |
| | 699 | | } |
| | 700 | | else |
| | 701 | | { |
| | 702 | | // only allow one item of each type |
| 156 | 703 | | if (itemResult.RemoteImages.Any(x => x.Type == imageType)) |
| | 704 | | { |
| 121 | 705 | | return; |
| | 706 | | } |
| | 707 | |
|
| 35 | 708 | | itemResult.RemoteImages.Add((uri.ToString(), imageType)); |
| | 709 | | } |
| 35 | 710 | | } |
| | 711 | |
|
| | 712 | | private void FetchFromFileInfoNode(XmlReader parentReader, T item) |
| | 713 | | { |
| 3 | 714 | | if (parentReader.IsEmptyElement) |
| | 715 | | { |
| 0 | 716 | | parentReader.Read(); |
| 0 | 717 | | return; |
| | 718 | | } |
| | 719 | |
|
| 3 | 720 | | using var reader = parentReader.ReadSubtree(); |
| 3 | 721 | | reader.MoveToContent(); |
| 3 | 722 | | reader.Read(); |
| | 723 | |
|
| | 724 | | // Loop through each element |
| 18 | 725 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 726 | | { |
| 15 | 727 | | if (reader.NodeType != XmlNodeType.Element) |
| | 728 | | { |
| 12 | 729 | | reader.Read(); |
| 12 | 730 | | continue; |
| | 731 | | } |
| | 732 | |
|
| 3 | 733 | | switch (reader.Name) |
| | 734 | | { |
| | 735 | | case "streamdetails": |
| 3 | 736 | | FetchFromStreamDetailsNode(reader, item); |
| 3 | 737 | | break; |
| | 738 | | default: |
| 0 | 739 | | reader.Skip(); |
| | 740 | | break; |
| | 741 | | } |
| | 742 | | } |
| 6 | 743 | | } |
| | 744 | |
|
| | 745 | | private void FetchFromStreamDetailsNode(XmlReader parentReader, T item) |
| | 746 | | { |
| 3 | 747 | | if (parentReader.IsEmptyElement) |
| | 748 | | { |
| 0 | 749 | | parentReader.Read(); |
| 0 | 750 | | return; |
| | 751 | | } |
| | 752 | |
|
| 3 | 753 | | using var reader = parentReader.ReadSubtree(); |
| 3 | 754 | | reader.MoveToContent(); |
| 3 | 755 | | reader.Read(); |
| | 756 | |
|
| | 757 | | // Loop through each element |
| 32 | 758 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 759 | | { |
| 29 | 760 | | if (reader.NodeType != XmlNodeType.Element) |
| | 761 | | { |
| 20 | 762 | | reader.Read(); |
| 20 | 763 | | continue; |
| | 764 | | } |
| | 765 | |
|
| 9 | 766 | | switch (reader.Name) |
| | 767 | | { |
| | 768 | | case "video": |
| 3 | 769 | | FetchFromVideoNode(reader, item); |
| 3 | 770 | | break; |
| | 771 | | case "subtitle": |
| 2 | 772 | | FetchFromSubtitleNode(reader, item); |
| 2 | 773 | | break; |
| | 774 | | default: |
| 4 | 775 | | reader.Skip(); |
| | 776 | | break; |
| | 777 | | } |
| | 778 | | } |
| 6 | 779 | | } |
| | 780 | |
|
| | 781 | | private void FetchFromVideoNode(XmlReader parentReader, T item) |
| | 782 | | { |
| 3 | 783 | | if (parentReader.IsEmptyElement) |
| | 784 | | { |
| 0 | 785 | | parentReader.Read(); |
| 0 | 786 | | return; |
| | 787 | | } |
| | 788 | |
|
| 3 | 789 | | using var reader = parentReader.ReadSubtree(); |
| 3 | 790 | | reader.MoveToContent(); |
| 3 | 791 | | reader.Read(); |
| | 792 | |
|
| | 793 | | // Loop through each element |
| 53 | 794 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 795 | | { |
| 50 | 796 | | if (reader.NodeType != XmlNodeType.Element || item is not Video video) |
| | 797 | | { |
| 28 | 798 | | reader.Read(); |
| 28 | 799 | | continue; |
| | 800 | | } |
| | 801 | |
|
| 22 | 802 | | switch (reader.Name) |
| | 803 | | { |
| | 804 | | case "format3d": |
| 1 | 805 | | var format = reader.ReadElementContentAsString(); |
| 1 | 806 | | if (string.Equals("HSBS", format, StringComparison.OrdinalIgnoreCase)) |
| | 807 | | { |
| 1 | 808 | | video.Video3DFormat = Video3DFormat.HalfSideBySide; |
| | 809 | | } |
| 0 | 810 | | else if (string.Equals("HTAB", format, StringComparison.OrdinalIgnoreCase)) |
| | 811 | | { |
| 0 | 812 | | video.Video3DFormat = Video3DFormat.HalfTopAndBottom; |
| | 813 | | } |
| 0 | 814 | | else if (string.Equals("FTAB", format, StringComparison.OrdinalIgnoreCase)) |
| | 815 | | { |
| 0 | 816 | | video.Video3DFormat = Video3DFormat.FullTopAndBottom; |
| | 817 | | } |
| 0 | 818 | | else if (string.Equals("FSBS", format, StringComparison.OrdinalIgnoreCase)) |
| | 819 | | { |
| 0 | 820 | | video.Video3DFormat = Video3DFormat.FullSideBySide; |
| | 821 | | } |
| 0 | 822 | | else if (string.Equals("MVC", format, StringComparison.OrdinalIgnoreCase)) |
| | 823 | | { |
| 0 | 824 | | video.Video3DFormat = Video3DFormat.MVC; |
| | 825 | | } |
| | 826 | |
|
| 0 | 827 | | break; |
| | 828 | | case "aspect": |
| 3 | 829 | | video.AspectRatio = reader.ReadNormalizedString(); |
| 3 | 830 | | break; |
| | 831 | | case "width": |
| 3 | 832 | | video.Width = reader.ReadElementContentAsInt(); |
| 3 | 833 | | break; |
| | 834 | | case "height": |
| 3 | 835 | | video.Height = reader.ReadElementContentAsInt(); |
| 3 | 836 | | break; |
| | 837 | | case "durationinseconds": |
| 3 | 838 | | video.RunTimeTicks = new TimeSpan(0, 0, reader.ReadElementContentAsInt()).Ticks; |
| 3 | 839 | | break; |
| | 840 | | default: |
| 9 | 841 | | reader.Skip(); |
| | 842 | | break; |
| | 843 | | } |
| | 844 | | } |
| 6 | 845 | | } |
| | 846 | |
|
| | 847 | | private void FetchFromSubtitleNode(XmlReader parentReader, T item) |
| | 848 | | { |
| 2 | 849 | | if (parentReader.IsEmptyElement) |
| | 850 | | { |
| 0 | 851 | | parentReader.Read(); |
| 0 | 852 | | return; |
| | 853 | | } |
| | 854 | |
|
| 2 | 855 | | using var reader = parentReader.ReadSubtree(); |
| 2 | 856 | | reader.MoveToContent(); |
| 2 | 857 | | reader.Read(); |
| | 858 | |
|
| | 859 | | // Loop through each element |
| 10 | 860 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 861 | | { |
| 8 | 862 | | if (reader.NodeType != XmlNodeType.Element) |
| | 863 | | { |
| 6 | 864 | | reader.Read(); |
| 6 | 865 | | continue; |
| | 866 | | } |
| | 867 | |
|
| 2 | 868 | | switch (reader.Name) |
| | 869 | | { |
| | 870 | | case "language": |
| 2 | 871 | | _ = reader.ReadElementContentAsString(); |
| 2 | 872 | | if (item is Video video) |
| | 873 | | { |
| 2 | 874 | | video.HasSubtitles = true; |
| | 875 | | } |
| | 876 | |
|
| 2 | 877 | | break; |
| | 878 | | default: |
| 0 | 879 | | reader.Skip(); |
| | 880 | | break; |
| | 881 | | } |
| | 882 | | } |
| 4 | 883 | | } |
| | 884 | |
|
| | 885 | | private void FetchFromRatingsNode(XmlReader parentReader, T item) |
| | 886 | | { |
| 3 | 887 | | if (parentReader.IsEmptyElement) |
| | 888 | | { |
| 0 | 889 | | parentReader.Read(); |
| 0 | 890 | | return; |
| | 891 | | } |
| | 892 | |
|
| 3 | 893 | | using var reader = parentReader.ReadSubtree(); |
| 3 | 894 | | reader.MoveToContent(); |
| 3 | 895 | | reader.Read(); |
| | 896 | |
|
| | 897 | | // Loop through each element |
| 42 | 898 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 899 | | { |
| 39 | 900 | | if (reader.NodeType == XmlNodeType.Element) |
| | 901 | | { |
| 11 | 902 | | switch (reader.Name) |
| | 903 | | { |
| | 904 | | case "rating": |
| | 905 | | { |
| 11 | 906 | | if (reader.IsEmptyElement) |
| | 907 | | { |
| 0 | 908 | | reader.Read(); |
| 0 | 909 | | continue; |
| | 910 | | } |
| | 911 | |
|
| 11 | 912 | | var ratingName = reader.GetAttribute("name"); |
| | 913 | |
|
| 11 | 914 | | using var subtree = reader.ReadSubtree(); |
| 11 | 915 | | FetchFromRatingNode(subtree, item, ratingName); |
| | 916 | |
|
| 11 | 917 | | break; |
| | 918 | | } |
| | 919 | |
|
| | 920 | | default: |
| 0 | 921 | | reader.Skip(); |
| 0 | 922 | | break; |
| | 923 | | } |
| | 924 | | } |
| | 925 | | else |
| | 926 | | { |
| 28 | 927 | | reader.Read(); |
| | 928 | | } |
| | 929 | | } |
| 6 | 930 | | } |
| | 931 | |
|
| | 932 | | private void FetchFromRatingNode(XmlReader reader, T item, string? ratingName) |
| | 933 | | { |
| 11 | 934 | | reader.MoveToContent(); |
| 11 | 935 | | reader.Read(); |
| | 936 | |
|
| | 937 | | // Loop through each element |
| 77 | 938 | | while (!reader.EOF && reader.ReadState == ReadState.Interactive) |
| | 939 | | { |
| 66 | 940 | | if (reader.NodeType == XmlNodeType.Element) |
| | 941 | | { |
| 22 | 942 | | switch (reader.Name) |
| | 943 | | { |
| | 944 | | case "value": |
| 11 | 945 | | var val = reader.ReadElementContentAsString(); |
| | 946 | |
|
| 11 | 947 | | if (float.TryParse(val, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out va |
| | 948 | | { |
| | 949 | | // if ratingName contains tomato --> assume critic rating |
| 11 | 950 | | if (ratingName is not null |
| 11 | 951 | | && ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase) |
| 11 | 952 | | && !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase)) |
| | 953 | | { |
| 2 | 954 | | if (!ratingName.Contains("avg", StringComparison.OrdinalIgnoreCase)) |
| | 955 | | { |
| 2 | 956 | | item.CriticRating = ratingValue; |
| | 957 | | } |
| | 958 | | } |
| | 959 | | else |
| | 960 | | { |
| 9 | 961 | | item.CommunityRating = ratingValue; |
| | 962 | | } |
| | 963 | | } |
| | 964 | |
|
| 9 | 965 | | break; |
| | 966 | | default: |
| 11 | 967 | | reader.Skip(); |
| 11 | 968 | | break; |
| | 969 | | } |
| | 970 | | } |
| | 971 | | else |
| | 972 | | { |
| 44 | 973 | | reader.Read(); |
| | 974 | | } |
| | 975 | | } |
| 11 | 976 | | } |
| | 977 | |
|
| | 978 | | internal XmlReaderSettings GetXmlReaderSettings() |
| 20 | 979 | | => new XmlReaderSettings() |
| 20 | 980 | | { |
| 20 | 981 | | ValidationType = ValidationType.None, |
| 20 | 982 | | CheckCharacters = false, |
| 20 | 983 | | IgnoreProcessingInstructions = true, |
| 20 | 984 | | IgnoreComments = true |
| 20 | 985 | | }; |
| | 986 | |
|
| | 987 | | /// <summary> |
| | 988 | | /// Parses the <see cref="ImageType"/> from the NFO aspect property. |
| | 989 | | /// </summary> |
| | 990 | | /// <param name="aspect">The NFO aspect property.</param> |
| | 991 | | /// <returns>The <see cref="ImageType"/>.</returns> |
| | 992 | | private static ImageType GetImageType(string aspect) |
| | 993 | | { |
| 159 | 994 | | return aspect switch |
| 159 | 995 | | { |
| 23 | 996 | | "banner" => ImageType.Banner, |
| 23 | 997 | | "clearlogo" => ImageType.Logo, |
| 12 | 998 | | "discart" => ImageType.Disc, |
| 18 | 999 | | "landscape" => ImageType.Thumb, |
| 8 | 1000 | | "clearart" => ImageType.Art, |
| 6 | 1001 | | "fanart" => ImageType.Backdrop, |
| 159 | 1002 | | // unknown type (including "poster") --> primary |
| 69 | 1003 | | _ => ImageType.Primary, |
| 159 | 1004 | | }; |
| | 1005 | | } |
| | 1006 | | } |
| | 1007 | | } |