using System.Globalization; using System.IO; using MediaBrowser.Controller.Entities; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using System; using System.Collections.Generic; using System.Linq; using System.Threading; using System.Xml; namespace MediaBrowser.Controller.Providers { /// /// Provides a base class for parsing metadata xml /// /// public class BaseItemXmlParser where T : BaseItem, new() { /// /// The logger /// protected ILogger Logger { get; private set; } /// /// Initializes a new instance of the class. /// /// The logger. public BaseItemXmlParser(ILogger logger) { Logger = logger; } /// /// Fetches metadata for an item from one xml file /// /// The item. /// The metadata file. /// The cancellation token. /// public void Fetch(T item, string metadataFile, CancellationToken cancellationToken) { if (item == null) { throw new ArgumentNullException(); } if (string.IsNullOrEmpty(metadataFile)) { throw new ArgumentNullException(); } var settings = new XmlReaderSettings { CheckCharacters = false, IgnoreProcessingInstructions = true, IgnoreComments = true, ValidationType = ValidationType.None }; item.Taglines.Clear(); item.Studios.Clear(); item.Genres.Clear(); item.People.Clear(); // Use XmlReader for best performance using (var reader = XmlReader.Create(metadataFile, settings)) { reader.MoveToContent(); // Loop through each element while (reader.Read()) { cancellationToken.ThrowIfCancellationRequested(); if (reader.NodeType == XmlNodeType.Element) { FetchDataFromXmlNode(reader, item); } } } } private readonly CultureInfo _usCulture = new CultureInfo("en-US"); /// /// Fetches metadata from one Xml Element /// /// The reader. /// The item. protected virtual void FetchDataFromXmlNode(XmlReader reader, T item) { switch (reader.Name) { // DateCreated case "Added": DateTime added; if (DateTime.TryParse(reader.ReadElementContentAsString() ?? string.Empty, out added)) { item.DateCreated = added.ToUniversalTime(); } break; case "LocalTitle": item.Name = reader.ReadElementContentAsString(); break; case "Type": { var type = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(type) && !type.Equals("none", StringComparison.OrdinalIgnoreCase)) { item.DisplayMediaType = type; } break; } case "Budget": { var text = reader.ReadElementContentAsString(); double value; if (double.TryParse(text, NumberStyles.Any, _usCulture, out value)) { item.Budget = value; } break; } case "Revenue": { var text = reader.ReadElementContentAsString(); double value; if (double.TryParse(text, NumberStyles.Any, _usCulture, out value)) { item.Revenue = value; } break; } case "SortTitle": item.ForcedSortName = reader.ReadElementContentAsString(); break; case "Overview": case "Description": item.Overview = reader.ReadInnerXml(); break; case "TagLine": { var tagline = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(tagline)) { item.AddTagline(tagline); } break; } case "Website": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { item.HomePageUrl = val; } break; } case "TagLines": { FetchFromTaglinesNode(reader.ReadSubtree(), item); break; } case "ContentRating": case "certification": case "MPAARating": { var rating = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(rating)) { item.OfficialRating = rating; } break; } case "CustomRating": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { item.CustomRating = val; } break; } case "Runtime": case "RunningTime": { var text = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(text)) { int runtime; if (int.TryParse(text.Split(' ')[0], out runtime)) { item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks; } } break; } case "Genre": { foreach (var name in SplitNames(reader.ReadElementContentAsString())) { if (string.IsNullOrWhiteSpace(name)) { continue; } item.AddGenre(name); } break; } case "AspectRatio": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { item.AspectRatio = val; } break; } case "Network": { foreach (var name in SplitNames(reader.ReadElementContentAsString())) { if (string.IsNullOrWhiteSpace(name)) { continue; } item.AddStudio(name); } break; } case "Director": { foreach (var p in SplitNames(reader.ReadElementContentAsString()).Select(v => new PersonInfo { Name = v, Type = PersonType.Director })) { if (string.IsNullOrWhiteSpace(p.Name)) { continue; } item.AddPerson(p); } break; } case "Writer": { foreach (var p in SplitNames(reader.ReadElementContentAsString()).Select(v => new PersonInfo { Name = v, Type = PersonType.Writer })) { if (string.IsNullOrWhiteSpace(p.Name)) { continue; } item.AddPerson(p); } break; } case "Actors": { var actors = reader.ReadInnerXml(); if (actors.Contains("<")) { // This is one of the mis-named "Actors" full nodes created by MB2 // Create a reader and pass it to the persons node processor FetchDataFromPersonsNode(new XmlTextReader(new StringReader("" + actors + "")), item); } else { // Old-style piped string foreach (var p in SplitNames(actors).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Actor })) { if (string.IsNullOrWhiteSpace(p.Name)) { continue; } item.AddPerson(p); } } break; } case "GuestStars": { foreach (var p in SplitNames(reader.ReadElementContentAsString()).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.GuestStar })) { if (string.IsNullOrWhiteSpace(p.Name)) { continue; } item.AddPerson(p); } break; } case "Trailer": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { //item.AddTrailerUrl(val); } break; } case "ProductionYear": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { int productionYear; if (int.TryParse(val, out productionYear) && productionYear > 1850) { item.ProductionYear = productionYear; } } break; } case "Rating": case "IMDBrating": { var rating = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(rating)) { float val; if (float.TryParse(rating, out val)) { item.CommunityRating = val; } } break; } case "FirstAired": { var firstAired = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(firstAired)) { DateTime airDate; if (DateTime.TryParse(firstAired, out airDate) && airDate.Year > 1850) { item.PremiereDate = airDate.ToUniversalTime(); item.ProductionYear = airDate.Year; } } break; } case "TMDbId": var tmdb = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(tmdb)) { item.SetProviderId(MetadataProviders.Tmdb, tmdb); } break; case "TVcomId": var TVcomId = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(TVcomId)) { item.SetProviderId(MetadataProviders.Tvcom, TVcomId); } break; case "IMDB_ID": case "IMDB": case "IMDbId": var IMDbId = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(IMDbId)) { item.SetProviderId(MetadataProviders.Imdb, IMDbId); } break; case "Genres": FetchFromGenresNode(reader.ReadSubtree(), item); break; case "Persons": FetchDataFromPersonsNode(reader.ReadSubtree(), item); break; case "ParentalRating": FetchFromParentalRatingNode(reader.ReadSubtree(), item); break; case "Studios": FetchFromStudiosNode(reader.ReadSubtree(), item); break; default: reader.Skip(); break; } } /// /// Fetches from taglines node. /// /// The reader. /// The item. private void FetchFromTaglinesNode(XmlReader reader, T item) { reader.MoveToContent(); while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Tagline": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { item.AddTagline(val); } break; } default: reader.Skip(); break; } } } } /// /// Fetches from genres node. /// /// The reader. /// The item. private void FetchFromGenresNode(XmlReader reader, T item) { reader.MoveToContent(); while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Genre": { var genre = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(genre)) { item.AddGenre(genre); } break; } default: reader.Skip(); break; } } } } /// /// Fetches the data from persons node. /// /// The reader. /// The item. private void FetchDataFromPersonsNode(XmlReader reader, T item) { reader.MoveToContent(); while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Person": case "Actor": { foreach (var person in GetPersonsFromXmlNode(reader.ReadSubtree())) { item.AddPerson(person); } break; } default: reader.Skip(); break; } } } } /// /// Fetches from studios node. /// /// The reader. /// The item. private void FetchFromStudiosNode(XmlReader reader, T item) { reader.MoveToContent(); while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Studio": { var studio = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(studio)) { item.AddStudio(studio); } break; } default: reader.Skip(); break; } } } } /// /// Fetches from parental rating node. /// /// The reader. /// The item. private void FetchFromParentalRatingNode(XmlReader reader, T item) { reader.MoveToContent(); while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Value": { var ratingString = reader.ReadElementContentAsString(); int rating = 7; if (!string.IsNullOrWhiteSpace(ratingString)) { int.TryParse(ratingString, out rating); } switch (rating) { case -1: item.OfficialRating = "NR"; break; case 0: item.OfficialRating = "UR"; break; case 1: item.OfficialRating = "G"; break; case 3: item.OfficialRating = "PG"; break; case 4: item.OfficialRating = "PG-13"; break; case 5: item.OfficialRating = "NC-17"; break; case 6: item.OfficialRating = "R"; break; } break; } default: reader.Skip(); break; } } } } /// /// Gets the persons from XML node. /// /// The reader. /// IEnumerable{PersonInfo}. private IEnumerable GetPersonsFromXmlNode(XmlReader reader) { var names = new List(); var type = "Actor"; // If type is not specified assume actor var role = string.Empty; reader.MoveToContent(); while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Name": names.AddRange(SplitNames(reader.ReadElementContentAsString())); break; case "Type": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { type = val; } break; } case "Role": { var val = reader.ReadElementContentAsString(); if (!string.IsNullOrWhiteSpace(val)) { role = val; } break; } default: reader.Skip(); break; } } } return names.Select(n => new PersonInfo { Name = n, Role = role, Type = type }); } /// /// Used to split names of comma or pipe delimeted genres and people /// /// The value. /// IEnumerable{System.String}. private IEnumerable SplitNames(string value) { value = value ?? string.Empty; // Only split by comma if there is no pipe in the string // We have to be careful to not split names like Matthew, Jr. var separator = value.IndexOf('|') == -1 ? ',' : '|'; value = value.Trim().Trim(separator); return string.IsNullOrWhiteSpace(value) ? new string[] { } : Split(value, separator, StringSplitOptions.RemoveEmptyEntries); } /// /// Provides an additional overload for string.split /// /// The val. /// The separator. /// The options. /// System.String[][]. private static string[] Split(string val, char separator, StringSplitOptions options) { return val.Split(new[] { separator }, options); } } }