using System; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Text; using System.Threading; using System.Xml; using Jellyfin.Data.Enums; using Jellyfin.Extensions; using MediaBrowser.Common.Configuration; using MediaBrowser.Common.Providers; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Movies; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Extensions; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.XbmcMetadata.Configuration; using MediaBrowser.XbmcMetadata.Savers; using Microsoft.Extensions.Logging; namespace MediaBrowser.XbmcMetadata.Parsers { /// /// The BaseNfoParser class. /// /// The type. public class BaseNfoParser where T : BaseItem { private readonly IConfigurationManager _config; private readonly IUserManager _userManager; private readonly IUserDataManager _userDataManager; private readonly IDirectoryService _directoryService; private Dictionary _validProviderIds; /// /// Initializes a new instance of the class. /// /// Instance of the interface. /// Instance of the interface. /// Instance of the interface. /// Instance of the interface. /// Instance of the interface. /// Instance of the interface. public BaseNfoParser( ILogger logger, IConfigurationManager config, IProviderManager providerManager, IUserManager userManager, IUserDataManager userDataManager, IDirectoryService directoryService) { Logger = logger; _config = config; ProviderManager = providerManager; _validProviderIds = new Dictionary(); _userManager = userManager; _userDataManager = userDataManager; _directoryService = directoryService; } /// /// Gets the logger. /// protected ILogger Logger { get; } /// /// Gets the provider manager. /// protected IProviderManager ProviderManager { get; } /// /// Gets a value indicating whether URLs after a closing XML tag are supporrted. /// protected virtual bool SupportsUrlAfterClosingXmlTag => false; /// /// Fetches metadata for an item from one xml file. /// /// The . /// The metadata file. /// The . /// item is null. /// metadataFile is null or empty. public void Fetch(MetadataResult item, string metadataFile, CancellationToken cancellationToken) { if (item.Item is null) { throw new ArgumentException("Item can't be null.", nameof(item)); } ArgumentException.ThrowIfNullOrEmpty(metadataFile); _validProviderIds = new Dictionary(StringComparer.OrdinalIgnoreCase); var idInfos = ProviderManager.GetExternalIdInfos(item.Item); foreach (var info in idInfos) { var id = info.Key + "Id"; _validProviderIds.TryAdd(id, info.Key); } // Additional Mappings _validProviderIds.Add("collectionnumber", "TmdbCollection"); _validProviderIds.Add("tmdbcolid", "TmdbCollection"); _validProviderIds.Add("imdb_id", "Imdb"); Fetch(item, metadataFile, GetXmlReaderSettings(), cancellationToken); } /// /// Fetches the specified item. /// /// The . /// The metadata file. /// The . /// The . protected virtual void Fetch(MetadataResult item, string metadataFile, XmlReaderSettings settings, CancellationToken cancellationToken) { if (!SupportsUrlAfterClosingXmlTag) { using (var fileStream = File.OpenRead(metadataFile)) using (var streamReader = new StreamReader(fileStream, Encoding.UTF8)) using (var reader = XmlReader.Create(streamReader, settings)) { item.ResetPeople(); reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { cancellationToken.ThrowIfCancellationRequested(); if (reader.NodeType == XmlNodeType.Element) { FetchDataFromXmlNode(reader, item); } else { reader.Read(); } } } return; } item.ResetPeople(); // Need to handle a url after the xml data // http://kodi.wiki/view/NFO_files/movies var xml = File.ReadAllText(metadataFile); // Find last closing Tag // Need to do this in two steps to account for random > characters after the closing xml var index = xml.LastIndexOf("', index); } if (index != -1) { var endingXml = xml.AsSpan().Slice(index); ParseProviderLinks(item.Item, endingXml); // If the file is just an IMDb url, don't go any further if (index == 0) { return; } xml = xml.Substring(0, index + 1); } else { // If the file is just provider urls, handle that ParseProviderLinks(item.Item, xml); return; } // These are not going to be valid xml so no sense in causing the provider to fail and spamming the log with exceptions try { using (var stringReader = new StringReader(xml)) using (var reader = XmlReader.Create(stringReader, settings)) { reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { cancellationToken.ThrowIfCancellationRequested(); if (reader.NodeType == XmlNodeType.Element) { FetchDataFromXmlNode(reader, item); } else { reader.Read(); } } } } catch (XmlException) { } } /// /// Parses a XML tag to a provider id. /// /// The item. /// The xml tag. protected void ParseProviderLinks(T item, ReadOnlySpan xml) { if (ProviderIdParsers.TryFindImdbId(xml, out var imdbId)) { item.SetProviderId(MetadataProvider.Imdb, imdbId.ToString()); } if (item is Movie) { if (ProviderIdParsers.TryFindTmdbMovieId(xml, out var tmdbId)) { item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString()); } } if (item is Series) { if (ProviderIdParsers.TryFindTmdbSeriesId(xml, out var tmdbId)) { item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString()); } if (ProviderIdParsers.TryFindTvdbId(xml, out var tvdbId)) { item.SetProviderId(MetadataProvider.Tvdb, tvdbId.ToString()); } } } /// /// Fetches metadata from an XML node. /// /// The . /// The . protected virtual void FetchDataFromXmlNode(XmlReader reader, MetadataResult itemResult) { var item = itemResult.Item; var nfoConfiguration = _config.GetNfoConfiguration(); UserItemData? userData; switch (reader.Name) { case "dateadded": if (reader.TryReadDateTime(out var dateCreated)) { item.DateCreated = dateCreated; } break; case "originaltitle": item.OriginalTitle = reader.ReadNormalizedString(); break; case "name": case "title": case "localtitle": item.Name = reader.ReadNormalizedString(); break; case "sortname": item.SortName = reader.ReadNormalizedString(); break; case "criticrating": var criticRatingText = reader.ReadElementContentAsString(); if (float.TryParse(criticRatingText, CultureInfo.InvariantCulture, out var value)) { item.CriticRating = value; } break; case "sorttitle": item.ForcedSortName = reader.ReadNormalizedString(); break; case "biography": case "plot": case "review": item.Overview = reader.ReadNormalizedString(); break; case "language": item.PreferredMetadataLanguage = reader.ReadNormalizedString(); break; case "watched": var played = reader.ReadElementContentAsBoolean(); if (!string.IsNullOrWhiteSpace(nfoConfiguration.UserId)) { var user = _userManager.GetUserById(Guid.Parse(nfoConfiguration.UserId)); userData = _userDataManager.GetUserData(user, item); userData.Played = played; _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None); } break; case "playcount": if (reader.TryReadInt(out var count) && Guid.TryParse(nfoConfiguration.UserId, out var playCountUserId)) { var user = _userManager.GetUserById(playCountUserId); userData = _userDataManager.GetUserData(user, item); userData.PlayCount = count; _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None); } break; case "lastplayed": if (reader.TryReadDateTime(out var lastPlayed) && Guid.TryParse(nfoConfiguration.UserId, out var lastPlayedUserId)) { var user = _userManager.GetUserById(lastPlayedUserId); userData = _userDataManager.GetUserData(user, item); userData.LastPlayedDate = lastPlayed; _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None); } break; case "countrycode": item.PreferredMetadataCountryCode = reader.ReadNormalizedString(); break; case "lockedfields": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { item.LockedFields = val.Split('|').Select(i => { if (Enum.TryParse(i, true, out MetadataField field)) { return (MetadataField?)field; } return null; }).OfType().ToArray(); } break; } case "tagline": item.Tagline = reader.ReadNormalizedString(); break; case "country": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { item.ProductionLocations = val.Split('/') .Select(i => i.Trim()) .Where(i => !string.IsNullOrWhiteSpace(i)) .ToArray(); } break; } case "mpaa": item.OfficialRating = reader.ReadNormalizedString(); break; case "customrating": item.CustomRating = reader.ReadNormalizedString(); break; case "runtime": var runtimeText = reader.ReadElementContentAsString(); if (int.TryParse(runtimeText.AsSpan().LeftPart(' '), NumberStyles.Integer, CultureInfo.InvariantCulture, out var runtime)) { item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks; } break; case "aspectratio": var aspectRatio = reader.ReadNormalizedString(); if (!string.IsNullOrEmpty(aspectRatio) && item is IHasAspectRatio hasAspectRatio) { hasAspectRatio.AspectRatio = aspectRatio; } break; case "lockdata": item.IsLocked = string.Equals(reader.ReadElementContentAsString(), "true", StringComparison.OrdinalIgnoreCase); break; case "studio": var studio = reader.ReadNormalizedString(); if (!string.IsNullOrEmpty(studio)) { item.AddStudio(studio); } break; case "director": foreach (var director in reader.GetPersonArray(PersonKind.Director)) { itemResult.AddPerson(director); } break; case "credits": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { var parts = val.Split('/').Select(i => i.Trim()) .Where(i => !string.IsNullOrEmpty(i)); foreach (var p in parts.Select(v => new PersonInfo { Name = v.Trim(), Type = PersonKind.Writer })) { if (string.IsNullOrWhiteSpace(p.Name)) { continue; } itemResult.AddPerson(p); } } break; } case "writer": foreach (var writer in reader.GetPersonArray(PersonKind.Writer)) { itemResult.AddPerson(writer); } break; case "actor": var person = reader.GetPersonFromXmlNode(); if (person is not null) { itemResult.AddPerson(person); } break; case "trailer": var trailer = reader.ReadNormalizedString(); if (!string.IsNullOrEmpty(trailer)) { item.AddTrailerUrl(trailer.Replace( "plugin://plugin.video.youtube/?action=play_video&videoid=", BaseNfoSaver.YouTubeWatchUrl, StringComparison.OrdinalIgnoreCase)); } break; case "displayorder": var displayOrder = reader.ReadNormalizedString(); if (!string.IsNullOrEmpty(displayOrder) && item is IHasDisplayOrder hasDisplayOrder) { hasDisplayOrder.DisplayOrder = displayOrder; } break; case "year": if (reader.TryReadInt(out var productionYear) && productionYear > 1850) { item.ProductionYear = productionYear; } break; case "rating": var rating = reader.ReadElementContentAsString().Replace(',', '.'); // All external meta is saving this as '.' for decimal I believe...but just to be sure if (float.TryParse(rating, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var communityRating)) { item.CommunityRating = communityRating; } break; case "ratings": FetchFromRatingsNode(reader, item); break; case "aired": case "formed": case "premiered": case "releasedate": if (reader.TryReadDateTimeExact(nfoConfiguration.ReleaseDateFormat, out var releaseDate)) { item.PremiereDate = releaseDate; item.ProductionYear = releaseDate.Year; } break; case "enddate": if (reader.TryReadDateTimeExact(nfoConfiguration.ReleaseDateFormat, out var endDate)) { item.EndDate = endDate; } break; case "genre": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { var parts = val.Split('/') .Select(i => i.Trim()) .Where(i => !string.IsNullOrWhiteSpace(i)); foreach (var p in parts) { item.AddGenre(p); } } break; } case "style": case "tag": var tag = reader.ReadNormalizedString(); if (!string.IsNullOrEmpty(tag)) { item.AddTag(tag); } break; case "fileinfo": FetchFromFileInfoNode(reader, item); break; case "uniqueid": if (reader.IsEmptyElement) { reader.Read(); break; } var provider = reader.GetAttribute("type"); var providerId = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(provider) && !string.IsNullOrWhiteSpace(providerId)) { item.SetProviderId(provider, providerId); } break; case "thumb": FetchThumbNode(reader, itemResult, "thumb"); break; case "fanart": { if (reader.IsEmptyElement) { reader.Read(); break; } using var subtree = reader.ReadSubtree(); if (!subtree.ReadToDescendant("thumb")) { break; } FetchThumbNode(subtree, itemResult, "fanart"); break; } default: string readerName = reader.Name; if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue)) { var id = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(providerIdValue) && !string.IsNullOrWhiteSpace(id)) { item.SetProviderId(providerIdValue, id); } } else { reader.Skip(); } break; } } private void FetchThumbNode(XmlReader reader, MetadataResult itemResult, string parentNode) { var artType = reader.GetAttribute("aspect"); var val = reader.ReadElementContentAsString(); // artType is null if the thumb node is a child of the fanart tag // -> set image type to fanart if (string.IsNullOrWhiteSpace(artType) && parentNode.Equals("fanart", StringComparison.Ordinal)) { artType = "fanart"; } else if (string.IsNullOrWhiteSpace(artType)) { // Sonarr writes thumb tags for posters without aspect property artType = "poster"; } // skip: // - empty uri // - tag containing '.' because we can't set images for seasons, episodes or movie sets within series or movies if (string.IsNullOrEmpty(val) || artType.Contains('.', StringComparison.Ordinal)) { return; } ImageType imageType = GetImageType(artType); if (!Uri.TryCreate(val, UriKind.Absolute, out var uri)) { Logger.LogError("Image location {Path} specified in nfo file for {ItemName} is not a valid URL or file path.", val, itemResult.Item.Name); return; } if (uri.IsFile) { // only allow one item of each type if (itemResult.Images.Any(x => x.Type == imageType)) { return; } var fileSystemMetadata = _directoryService.GetFile(val); // non existing file returns null if (fileSystemMetadata is null || !fileSystemMetadata.Exists) { Logger.LogWarning("Artwork file {Path} specified in nfo file for {ItemName} does not exist.", uri, itemResult.Item.Name); return; } itemResult.Images.Add(new LocalImageInfo() { FileInfo = fileSystemMetadata, Type = imageType }); } else { // only allow one item of each type if (itemResult.RemoteImages.Any(x => x.Type == imageType)) { return; } itemResult.RemoteImages.Add((uri.ToString(), imageType)); } } private void FetchFromFileInfoNode(XmlReader parentReader, T item) { if (parentReader.IsEmptyElement) { parentReader.Read(); return; } using var reader = parentReader.ReadSubtree(); reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { if (reader.NodeType != XmlNodeType.Element) { reader.Read(); continue; } switch (reader.Name) { case "streamdetails": FetchFromStreamDetailsNode(reader, item); break; default: reader.Skip(); break; } } } private void FetchFromStreamDetailsNode(XmlReader parentReader, T item) { if (parentReader.IsEmptyElement) { parentReader.Read(); return; } using var reader = parentReader.ReadSubtree(); reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { if (reader.NodeType != XmlNodeType.Element) { reader.Read(); continue; } switch (reader.Name) { case "video": FetchFromVideoNode(reader, item); break; case "subtitle": FetchFromSubtitleNode(reader, item); break; default: reader.Skip(); break; } } } private void FetchFromVideoNode(XmlReader parentReader, T item) { if (parentReader.IsEmptyElement) { parentReader.Read(); return; } using var reader = parentReader.ReadSubtree(); reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { if (reader.NodeType != XmlNodeType.Element || item is not Video video) { reader.Read(); continue; } switch (reader.Name) { case "format3d": var format = reader.ReadElementContentAsString(); if (string.Equals("HSBS", format, StringComparison.OrdinalIgnoreCase)) { video.Video3DFormat = Video3DFormat.HalfSideBySide; } else if (string.Equals("HTAB", format, StringComparison.OrdinalIgnoreCase)) { video.Video3DFormat = Video3DFormat.HalfTopAndBottom; } else if (string.Equals("FTAB", format, StringComparison.OrdinalIgnoreCase)) { video.Video3DFormat = Video3DFormat.FullTopAndBottom; } else if (string.Equals("FSBS", format, StringComparison.OrdinalIgnoreCase)) { video.Video3DFormat = Video3DFormat.FullSideBySide; } else if (string.Equals("MVC", format, StringComparison.OrdinalIgnoreCase)) { video.Video3DFormat = Video3DFormat.MVC; } break; case "aspect": video.AspectRatio = reader.ReadNormalizedString(); break; case "width": video.Width = reader.ReadElementContentAsInt(); break; case "height": video.Height = reader.ReadElementContentAsInt(); break; case "durationinseconds": video.RunTimeTicks = new TimeSpan(0, 0, reader.ReadElementContentAsInt()).Ticks; break; default: reader.Skip(); break; } } } private void FetchFromSubtitleNode(XmlReader parentReader, T item) { if (parentReader.IsEmptyElement) { parentReader.Read(); return; } using var reader = parentReader.ReadSubtree(); reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { if (reader.NodeType != XmlNodeType.Element) { reader.Read(); continue; } switch (reader.Name) { case "language": _ = reader.ReadElementContentAsString(); if (item is Video video) { video.HasSubtitles = true; } break; default: reader.Skip(); break; } } } private void FetchFromRatingsNode(XmlReader parentReader, T item) { if (parentReader.IsEmptyElement) { parentReader.Read(); return; } using var reader = parentReader.ReadSubtree(); reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "rating": { if (reader.IsEmptyElement) { reader.Read(); continue; } var ratingName = reader.GetAttribute("name"); using var subtree = reader.ReadSubtree(); FetchFromRatingNode(subtree, item, ratingName); break; } default: reader.Skip(); break; } } else { reader.Read(); } } } private void FetchFromRatingNode(XmlReader reader, T item, string? ratingName) { reader.MoveToContent(); reader.Read(); // Loop through each element while (!reader.EOF && reader.ReadState == ReadState.Interactive) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "value": var val = reader.ReadElementContentAsString(); if (float.TryParse(val, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var ratingValue)) { // if ratingName contains tomato --> assume critic rating if (ratingName is not null && ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase) && !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase)) { if (!ratingName.Contains("avg", StringComparison.OrdinalIgnoreCase)) { item.CriticRating = ratingValue; } } else { item.CommunityRating = ratingValue; } } break; default: reader.Skip(); break; } } else { reader.Read(); } } } internal XmlReaderSettings GetXmlReaderSettings() => new XmlReaderSettings() { ValidationType = ValidationType.None, CheckCharacters = false, IgnoreProcessingInstructions = true, IgnoreComments = true }; /// /// Parses the from the NFO aspect property. /// /// The NFO aspect property. /// The . private static ImageType GetImageType(string aspect) { return aspect switch { "banner" => ImageType.Banner, "clearlogo" => ImageType.Logo, "discart" => ImageType.Disc, "landscape" => ImageType.Thumb, "clearart" => ImageType.Art, "fanart" => ImageType.Backdrop, // unknown type (including "poster") --> primary _ => ImageType.Primary, }; } } }