jellyfin/MediaBrowser.XbmcMetadata/Parsers/BaseNfoParser.cs

1343 lines
47 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using System.Globalization;
2014-10-31 05:57:24 +01:00
using System.IO;
using System.Linq;
2014-10-31 05:57:24 +01:00
using System.Text;
using System.Threading;
using System.Xml;
using Jellyfin.Data.Enums;
2021-09-19 20:53:31 +02:00
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.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
{
2022-04-27 13:08:54 +02:00
/// <summary>
/// The BaseNfoParser class.
/// </summary>
/// <typeparam name="T">The type.</typeparam>
public class BaseNfoParser<T>
where T : BaseItem
{
private readonly IConfigurationManager _config;
private readonly IUserManager _userManager;
private readonly IUserDataManager _userDataManager;
2021-02-27 22:46:03 +01:00
private readonly IDirectoryService _directoryService;
private Dictionary<string, string> _validProviderIds;
/// <summary>
/// Initializes a new instance of the <see cref="BaseNfoParser{T}" /> class.
/// </summary>
/// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param>
/// <param name="config">Instance of the <see cref="IConfigurationManager"/> interface.</param>
/// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
/// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
/// <param name="userDataManager">Instance of the <see cref="IUserDataManager"/> interface.</param>
2021-02-27 22:46:03 +01:00
/// <param name="directoryService">Instance of the <see cref="IDirectoryService"/> interface.</param>
public BaseNfoParser(
ILogger logger,
IConfigurationManager config,
IProviderManager providerManager,
IUserManager userManager,
2021-02-27 22:46:03 +01:00
IUserDataManager userDataManager,
IDirectoryService directoryService)
{
Logger = logger;
_config = config;
ProviderManager = providerManager;
_validProviderIds = new Dictionary<string, string>();
_userManager = userManager;
_userDataManager = userDataManager;
2021-02-27 22:46:03 +01:00
_directoryService = directoryService;
}
/// <summary>
/// Gets the logger.
/// </summary>
protected ILogger Logger { get; }
2022-04-27 13:08:54 +02:00
/// <summary>
/// Gets the provider manager.
/// </summary>
protected IProviderManager ProviderManager { get; }
2022-04-27 13:08:54 +02:00
/// <summary>
/// Gets a value indicating whether URLs after a closing XML tag are supporrted.
/// </summary>
protected virtual bool SupportsUrlAfterClosingXmlTag => false;
/// <summary>
/// Fetches metadata for an item from one xml file.
/// </summary>
2022-04-27 13:08:54 +02:00
/// <param name="item">The <see cref="MetadataResult{T}"/>.</param>
/// <param name="metadataFile">The metadata file.</param>
2022-04-27 13:08:54 +02:00
/// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
/// <exception cref="ArgumentNullException"><c>item</c> is <c>null</c>.</exception>
/// <exception cref="ArgumentException"><c>metadataFile</c> is <c>null</c> or empty.</exception>
2015-08-02 19:31:08 +02:00
public void Fetch(MetadataResult<T> item, string metadataFile, CancellationToken cancellationToken)
{
2022-12-05 15:00:20 +01:00
if (item.Item is null)
{
2021-01-09 20:14:50 +01:00
throw new ArgumentException("Item can't be null.", nameof(item));
}
ArgumentException.ThrowIfNullOrEmpty(metadataFile);
_validProviderIds = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
var idInfos = ProviderManager.GetExternalIdInfos(item.Item);
foreach (var info in idInfos)
{
var id = info.Key + "Id";
2023-04-06 19:16:12 +02:00
_validProviderIds.TryAdd(id, info.Key);
}
// Additional Mappings
_validProviderIds.Add("collectionnumber", "TmdbCollection");
_validProviderIds.Add("tmdbcolid", "TmdbCollection");
_validProviderIds.Add("imdb_id", "Imdb");
2019-02-02 16:12:16 +01:00
Fetch(item, metadataFile, GetXmlReaderSettings(), cancellationToken);
}
/// <summary>
/// Fetches the specified item.
/// </summary>
2022-04-27 13:08:54 +02:00
/// <param name="item">The <see cref="MetadataResult{T}"/>.</param>
/// <param name="metadataFile">The metadata file.</param>
2022-04-27 13:08:54 +02:00
/// <param name="settings">The <see cref="XmlReaderSettings"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
protected virtual void Fetch(MetadataResult<T> item, string metadataFile, XmlReaderSettings settings, CancellationToken cancellationToken)
{
2014-11-11 04:41:55 +01:00
if (!SupportsUrlAfterClosingXmlTag)
{
2019-01-26 22:31:59 +01:00
using (var fileStream = File.OpenRead(metadataFile))
2019-02-02 16:12:16 +01:00
using (var streamReader = new StreamReader(fileStream, Encoding.UTF8))
using (var reader = XmlReader.Create(streamReader, settings))
2014-11-11 04:41:55 +01:00
{
2019-02-02 16:12:16 +01:00
item.ResetPeople();
2016-10-26 04:53:47 +02:00
2019-02-02 16:12:16 +01:00
reader.MoveToContent();
reader.Read();
2014-11-11 04:41:55 +01:00
2019-02-02 16:12:16 +01:00
// Loop through each element
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
cancellationToken.ThrowIfCancellationRequested();
2016-10-26 04:53:47 +02:00
2019-02-02 16:12:16 +01:00
if (reader.NodeType == XmlNodeType.Element)
{
FetchDataFromXmlNode(reader, item);
}
else
{
reader.Read();
2014-11-11 04:41:55 +01:00
}
}
}
2014-11-11 04:41:55 +01:00
return;
}
2021-08-15 17:20:07 +02:00
item.ResetPeople();
2014-10-21 05:41:11 +02:00
2021-08-15 17:20:07 +02:00
// Need to handle a url after the xml data
// http://kodi.wiki/view/NFO_files/movies
2016-10-26 04:53:47 +02:00
2021-08-15 17:20:07 +02:00
var xml = File.ReadAllText(metadataFile);
2014-10-31 05:57:24 +01:00
2021-08-15 17:20:07 +02:00
// Find last closing Tag
// Need to do this in two steps to account for random > characters after the closing xml
var index = xml.LastIndexOf(@"</", StringComparison.Ordinal);
2014-10-31 05:57:24 +01:00
2021-08-15 17:20:07 +02:00
// If closing tag exists, move to end of Tag
if (index != -1)
{
index = xml.IndexOf('>', index);
}
2015-03-31 21:33:38 +02:00
2021-08-15 17:20:07 +02:00
if (index != -1)
{
var endingXml = xml.AsSpan().Slice(index);
2021-08-15 17:20:07 +02:00
ParseProviderLinks(item.Item, endingXml);
2016-10-26 04:53:47 +02:00
// If the file is just an IMDb url, don't go any further
2021-08-15 17:20:07 +02:00
if (index == 0)
2019-02-02 16:12:16 +01:00
{
return;
}
2021-08-15 17:20:07 +02:00
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))
2019-02-02 16:12:16 +01:00
{
2021-08-15 17:20:07 +02:00
reader.MoveToContent();
reader.Read();
// Loop through each element
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
2021-08-15 17:20:07 +02:00
cancellationToken.ThrowIfCancellationRequested();
2019-02-02 16:12:16 +01:00
2021-08-15 17:20:07 +02:00
if (reader.NodeType == XmlNodeType.Element)
2016-10-26 04:53:47 +02:00
{
2021-08-15 17:20:07 +02:00
FetchDataFromXmlNode(reader, item);
}
else
{
reader.Read();
}
2018-09-12 19:26:21 +02:00
}
2019-02-02 16:12:16 +01:00
}
2021-08-15 17:20:07 +02:00
}
catch (XmlException)
{
}
}
2022-04-27 13:08:54 +02:00
/// <summary>
/// Parses a XML tag to a provider id.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="xml">The xml tag.</param>
2021-08-15 17:20:07 +02:00
protected void ParseProviderLinks(T item, ReadOnlySpan<char> xml)
2015-05-22 17:59:17 +02:00
{
if (ProviderIdParsers.TryFindImdbId(xml, out var imdbId))
2015-05-22 17:59:17 +02:00
{
item.SetProviderId(MetadataProvider.Imdb, imdbId.ToString());
2015-05-22 17:59:17 +02:00
}
if (item is Movie)
2016-03-13 04:30:42 +01:00
{
if (ProviderIdParsers.TryFindTmdbMovieId(xml, out var tmdbId))
2016-03-13 04:30:42 +01:00
{
item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString());
2016-03-13 04:30:42 +01:00
}
}
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());
}
}
2015-05-22 17:59:17 +02:00
}
2022-04-27 13:08:54 +02:00
/// <summary>
/// Fetches metadata from an XML node.
/// </summary>
/// <param name="reader">The <see cref="XmlReader"/>.</param>
/// <param name="itemResult">The <see cref="MetadataResult{T}"/>.</param>
2015-08-02 19:31:08 +02:00
protected virtual void FetchDataFromXmlNode(XmlReader reader, MetadataResult<T> itemResult)
{
2015-06-29 03:10:45 +02:00
var item = itemResult.Item;
var nfoConfiguration = _config.GetNfoConfiguration();
UserItemData? userData = null;
switch (reader.Name)
{
// DateCreated
case "dateadded":
{
var val = reader.ReadElementContentAsString();
if (DateTime.TryParse(val, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var added))
{
item.DateCreated = added;
}
else
{
Logger.LogWarning("Invalid Added value found: {Value}", val);
}
break;
}
2015-03-10 02:30:20 +01:00
case "originaltitle":
{
var val = reader.ReadElementContentAsString();
2016-10-31 05:28:23 +01:00
if (!string.IsNullOrEmpty(val))
2015-03-10 02:30:20 +01:00
{
2016-10-31 05:28:23 +01:00
item.OriginalTitle = val;
2015-03-10 02:30:20 +01:00
}
2015-03-10 02:30:20 +01:00
break;
}
2021-01-09 21:49:36 +01:00
case "name":
case "title":
case "localtitle":
item.Name = reader.ReadElementContentAsString();
break;
2021-01-09 21:49:36 +01:00
case "sortname":
item.SortName = reader.ReadElementContentAsString();
break;
case "criticrating":
{
var text = reader.ReadElementContentAsString();
if (float.TryParse(text, CultureInfo.InvariantCulture, out var value))
{
item.CriticRating = value;
}
break;
}
case "sorttitle":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
item.ForcedSortName = val;
}
break;
}
case "biography":
case "plot":
case "review":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
item.Overview = val;
}
break;
}
case "language":
{
var val = reader.ReadElementContentAsString();
2015-09-29 19:35:23 +02:00
item.PreferredMetadataLanguage = val;
break;
}
case "watched":
{
2021-02-11 12:43:36 +01:00
var val = reader.ReadElementContentAsBoolean();
if (!string.IsNullOrWhiteSpace(nfoConfiguration.UserId))
{
var user = _userManager.GetUserById(Guid.Parse(nfoConfiguration.UserId));
userData = _userDataManager.GetUserData(user, item);
2021-02-11 12:43:36 +01:00
userData.Played = val;
_userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None);
}
break;
}
case "playcount":
{
2021-02-11 12:43:36 +01:00
var val = reader.ReadElementContentAsString();
if (int.TryParse(val, NumberStyles.Integer, CultureInfo.InvariantCulture, out var count)
&& Guid.TryParse(nfoConfiguration.UserId, out var guid))
{
var user = _userManager.GetUserById(guid);
userData = _userDataManager.GetUserData(user, item);
userData.PlayCount = count;
_userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None);
}
break;
}
2021-02-11 13:36:35 +01:00
case "lastplayed":
{
2021-02-11 12:43:36 +01:00
var val = reader.ReadElementContentAsString();
if (Guid.TryParse(nfoConfiguration.UserId, out var guid))
{
2021-09-21 01:21:45 +02:00
if (DateTime.TryParse(val, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var added))
2021-02-11 12:43:36 +01:00
{
var user = _userManager.GetUserById(guid);
userData = _userDataManager.GetUserData(user, item);
2021-09-21 01:21:45 +02:00
userData.LastPlayedDate = added;
_userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None);
}
2021-02-11 12:43:36 +01:00
else
{
2021-02-11 12:43:36 +01:00
Logger.LogWarning("Invalid lastplayed value found: {Value}", val);
}
}
break;
}
2015-02-15 04:36:07 +01:00
case "countrycode":
{
var val = reader.ReadElementContentAsString();
2015-09-29 19:35:23 +02:00
item.PreferredMetadataCountryCode = val;
2015-02-15 04:36:07 +01:00
break;
}
case "lockedfields":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
item.LockedFields = val.Split('|').Select(i =>
{
2020-06-10 00:12:53 +02:00
if (Enum.TryParse(i, true, out MetadataField field))
{
2020-06-10 00:12:53 +02:00
return (MetadataField?)field;
}
return null;
}).OfType<MetadataField>().ToArray();
}
break;
}
case "tagline":
2021-01-09 20:14:50 +01:00
item.Tagline = reader.ReadElementContentAsString();
break;
case "country":
{
var val = reader.ReadElementContentAsString();
2016-10-08 07:57:38 +02:00
if (!string.IsNullOrWhiteSpace(val))
{
item.ProductionLocations = val.Split('/')
2016-10-09 09:18:43 +02:00
.Select(i => i.Trim())
.Where(i => !string.IsNullOrWhiteSpace(i))
.ToArray();
}
break;
}
case "mpaa":
{
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":
{
var text = reader.ReadElementContentAsString();
if (int.TryParse(text.AsSpan().LeftPart(' '), NumberStyles.Integer, CultureInfo.InvariantCulture, out var runtime))
{
item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks;
}
break;
}
case "aspectratio":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val)
&& item is IHasAspectRatio hasAspectRatio)
{
hasAspectRatio.AspectRatio = val;
}
break;
}
case "lockdata":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
item.IsLocked = string.Equals("true", val, StringComparison.OrdinalIgnoreCase);
}
break;
}
case "studio":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
2016-11-04 02:18:51 +01:00
item.AddStudio(val);
}
break;
}
case "director":
{
2016-12-03 22:46:06 +01:00
var val = reader.ReadElementContentAsString();
foreach (var p in SplitNames(val).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonKind.Director }))
{
if (string.IsNullOrWhiteSpace(p.Name))
{
continue;
}
2015-07-24 04:48:10 +02:00
itemResult.AddPerson(p);
}
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;
}
2015-07-24 04:48:10 +02:00
itemResult.AddPerson(p);
}
}
break;
}
case "writer":
{
2016-12-03 22:46:06 +01:00
var val = reader.ReadElementContentAsString();
foreach (var p in SplitNames(val).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonKind.Writer }))
{
if (string.IsNullOrWhiteSpace(p.Name))
{
continue;
}
2015-07-24 04:48:10 +02:00
itemResult.AddPerson(p);
}
break;
}
case "actor":
{
2016-12-04 00:57:34 +01:00
if (!reader.IsEmptyElement)
{
2016-12-04 00:57:34 +01:00
using (var subtree = reader.ReadSubtree())
2016-01-28 19:38:40 +01:00
{
2016-12-04 00:57:34 +01:00
var person = GetPersonFromXmlNode(subtree);
if (!string.IsNullOrWhiteSpace(person.Name))
{
itemResult.AddPerson(person);
}
2016-01-28 19:38:40 +01:00
}
}
2016-12-04 00:57:34 +01:00
else
{
reader.Read();
}
break;
}
case "trailer":
{
var val = reader.ReadElementContentAsString();
2018-09-12 19:26:21 +02:00
if (!string.IsNullOrWhiteSpace(val))
{
2018-09-12 19:26:21 +02:00
val = val.Replace("plugin://plugin.video.youtube/?action=play_video&videoid=", BaseNfoSaver.YouTubeWatchUrl, StringComparison.OrdinalIgnoreCase);
2016-03-14 02:34:24 +01:00
2018-09-12 19:26:21 +02:00
item.AddTrailerUrl(val);
}
break;
}
case "displayorder":
{
var val = reader.ReadElementContentAsString();
if (item is IHasDisplayOrder hasDisplayOrder && !string.IsNullOrWhiteSpace(val))
{
hasDisplayOrder.DisplayOrder = val;
}
break;
}
case "year":
{
var val = reader.ReadElementContentAsString();
if (int.TryParse(val, out var productionYear) && productionYear > 1850)
{
item.ProductionYear = productionYear;
}
break;
}
case "rating":
{
var rating = reader.ReadElementContentAsString();
// All external meta is saving this as '.' for decimal I believe...but just to be sure
if (float.TryParse(rating.Replace(',', '.'), NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var val))
{
item.CommunityRating = val;
}
break;
}
2021-01-08 14:48:08 +01:00
case "ratings":
{
if (!reader.IsEmptyElement)
{
using var subtree = reader.ReadSubtree();
FetchFromRatingsNode(subtree, item);
}
else
{
reader.Read();
}
break;
}
case "aired":
case "formed":
case "premiered":
case "releasedate":
{
var formatString = nfoConfiguration.ReleaseDateFormat;
var val = reader.ReadElementContentAsString();
if (DateTime.TryParseExact(val, formatString, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var date) && date.Year > 1850)
{
item.PremiereDate = date;
item.ProductionYear = date.Year;
}
break;
}
case "enddate":
{
var formatString = nfoConfiguration.ReleaseDateFormat;
var val = reader.ReadElementContentAsString();
if (DateTime.TryParseExact(val, formatString, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var date) && date.Year > 1850)
{
item.EndDate = date;
}
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 val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
2016-06-02 19:43:29 +02:00
item.AddTag(val);
}
break;
}
case "fileinfo":
{
2016-12-04 00:57:34 +01:00
if (!reader.IsEmptyElement)
{
2016-12-04 00:57:34 +01:00
using (var subtree = reader.ReadSubtree())
{
FetchFromFileInfoNode(subtree, item);
}
}
else
{
reader.Read();
}
break;
}
2021-01-09 20:14:50 +01:00
case "uniqueid":
{
if (reader.IsEmptyElement)
{
reader.Read();
break;
}
var provider = reader.GetAttribute("type");
var id = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(provider) && !string.IsNullOrWhiteSpace(id))
{
item.SetProviderId(provider, id);
}
break;
}
2021-02-27 22:46:03 +01:00
case "thumb":
{
2022-02-08 09:08:35 +01:00
FetchThumbNode(reader, itemResult, "thumb");
2021-02-27 22:46:03 +01:00
break;
}
case "fanart":
{
2021-11-17 14:49:30 +01:00
if (reader.IsEmptyElement)
{
reader.Read();
break;
}
using var subtree = reader.ReadSubtree();
if (!subtree.ReadToDescendant("thumb"))
{
break;
}
2022-02-08 09:08:35 +01:00
FetchThumbNode(subtree, itemResult, "fanart");
2021-02-27 22:46:03 +01:00
break;
}
default:
2017-01-14 04:48:42 +01:00
string readerName = reader.Name;
if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue))
{
var id = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(providerIdValue) && !string.IsNullOrWhiteSpace(id))
{
2017-01-14 04:48:42 +01:00
item.SetProviderId(providerIdValue, id);
}
}
else
{
reader.Skip();
}
break;
}
}
2022-02-08 09:08:35 +01:00
private void FetchThumbNode(XmlReader reader, MetadataResult<T> 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
2022-02-08 09:08:35 +01:00
if (string.IsNullOrWhiteSpace(artType) && parentNode.Equals("fanart", StringComparison.Ordinal))
{
artType = "fanart";
}
2022-02-08 09:08:35 +01:00
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
2022-12-05 15:00:20 +01:00
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
2021-12-24 22:18:24 +01:00
if (itemResult.RemoteImages.Any(x => x.Type == imageType))
{
return;
}
itemResult.RemoteImages.Add((uri.ToString(), imageType));
}
}
private void FetchFromFileInfoNode(XmlReader reader, T item)
{
reader.MoveToContent();
2016-12-02 21:10:35 +01:00
reader.Read();
2016-12-02 21:10:35 +01:00
// Loop through each element
2016-12-03 22:46:06 +01:00
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
if (reader.NodeType == XmlNodeType.Element)
{
switch (reader.Name)
{
case "streamdetails":
{
2016-12-04 00:57:34 +01:00
if (reader.IsEmptyElement)
{
reader.Read();
continue;
}
using (var subtree = reader.ReadSubtree())
{
FetchFromStreamDetailsNode(subtree, item);
}
break;
}
default:
reader.Skip();
break;
}
}
2016-12-02 21:10:35 +01:00
else
{
reader.Read();
}
}
}
private void FetchFromStreamDetailsNode(XmlReader reader, T item)
{
reader.MoveToContent();
2016-12-02 21:10:35 +01:00
reader.Read();
2016-12-02 21:10:35 +01:00
// Loop through each element
2016-12-03 22:46:06 +01:00
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
if (reader.NodeType == XmlNodeType.Element)
{
switch (reader.Name)
{
case "video":
{
2016-12-04 00:57:34 +01:00
if (reader.IsEmptyElement)
{
reader.Read();
continue;
}
using (var subtree = reader.ReadSubtree())
{
FetchFromVideoNode(subtree, item);
}
break;
}
2021-01-09 15:00:59 +01:00
case "subtitle":
{
if (reader.IsEmptyElement)
{
reader.Read();
continue;
}
using (var subtree = reader.ReadSubtree())
{
FetchFromSubtitleNode(subtree, item);
}
break;
}
default:
reader.Skip();
break;
}
}
2016-12-02 21:10:35 +01:00
else
{
reader.Read();
}
}
}
private void FetchFromVideoNode(XmlReader reader, T item)
{
reader.MoveToContent();
2016-12-02 21:10:35 +01:00
reader.Read();
2016-12-02 21:10:35 +01:00
// Loop through each element
2016-12-03 22:46:06 +01:00
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
if (reader.NodeType == XmlNodeType.Element)
{
switch (reader.Name)
{
case "format3d":
{
2016-12-02 21:10:35 +01:00
var val = reader.ReadElementContentAsString();
var video = item as Video;
2022-12-05 15:01:13 +01:00
if (video is not null)
{
2014-11-14 07:27:10 +01:00
if (string.Equals("HSBS", val, StringComparison.OrdinalIgnoreCase))
{
video.Video3DFormat = Video3DFormat.HalfSideBySide;
}
2014-11-14 07:27:10 +01:00
else if (string.Equals("HTAB", val, StringComparison.OrdinalIgnoreCase))
{
video.Video3DFormat = Video3DFormat.HalfTopAndBottom;
}
2014-11-14 07:27:10 +01:00
else if (string.Equals("FTAB", val, StringComparison.OrdinalIgnoreCase))
{
video.Video3DFormat = Video3DFormat.FullTopAndBottom;
}
2014-11-14 07:27:10 +01:00
else if (string.Equals("FSBS", val, StringComparison.OrdinalIgnoreCase))
{
video.Video3DFormat = Video3DFormat.FullSideBySide;
}
2016-02-11 20:11:28 +01:00
else if (string.Equals("MVC", val, StringComparison.OrdinalIgnoreCase))
{
video.Video3DFormat = Video3DFormat.MVC;
}
}
break;
}
2021-01-09 15:00:59 +01:00
case "aspect":
{
var val = reader.ReadElementContentAsString();
if (item is Video video)
{
video.AspectRatio = val;
}
break;
}
case "width":
{
var val = reader.ReadElementContentAsInt();
if (item is Video video)
{
video.Width = val;
}
break;
}
case "height":
{
var val = reader.ReadElementContentAsInt();
if (item is Video video)
{
video.Height = val;
}
break;
}
case "durationinseconds":
{
var val = reader.ReadElementContentAsInt();
if (item is Video video)
{
video.RunTimeTicks = new TimeSpan(0, 0, val).Ticks;
}
break;
}
default:
reader.Skip();
break;
}
}
else
{
reader.Read();
}
}
}
private void FetchFromSubtitleNode(XmlReader reader, T item)
{
reader.MoveToContent();
reader.Read();
// Loop through each element
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
if (reader.NodeType == XmlNodeType.Element)
{
switch (reader.Name)
{
case "language":
2022-04-27 13:08:54 +02:00
_ = reader.ReadElementContentAsString();
if (item is Video video)
2021-01-09 15:00:59 +01:00
{
2022-04-27 13:08:54 +02:00
video.HasSubtitles = true;
2021-01-09 15:00:59 +01:00
}
2022-04-27 13:08:54 +02:00
break;
default:
reader.Skip();
break;
}
}
2016-12-02 21:10:35 +01:00
else
{
reader.Read();
}
}
}
2021-01-08 14:48:08 +01:00
private void FetchFromRatingsNode(XmlReader reader, T item)
{
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;
}
2021-01-08 14:48:08 +01:00
var ratingName = reader.GetAttribute("name");
2021-01-08 14:48:08 +01:00
using var subtree = reader.ReadSubtree();
FetchFromRatingNode(subtree, item, ratingName);
2021-01-08 14:48:08 +01:00
break;
}
2021-01-08 14:48:08 +01:00
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))
2021-01-08 14:48:08 +01:00
{
// if ratingName contains tomato --> assume critic rating
if (ratingName is not null
&& ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase)
&& !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase))
2021-01-08 14:48:08 +01:00
{
if (!ratingName.Contains("avg", StringComparison.OrdinalIgnoreCase))
2021-01-08 14:48:08 +01:00
{
item.CriticRating = ratingValue;
}
}
else
{
item.CommunityRating = ratingValue;
2021-01-08 14:48:08 +01:00
}
}
break;
default:
reader.Skip();
break;
}
}
2016-12-02 21:10:35 +01:00
else
{
reader.Read();
}
}
}
/// <summary>
2022-04-27 13:08:54 +02:00
/// Gets the persons from a XML node.
/// </summary>
2022-04-27 13:08:54 +02:00
/// <param name="reader">The <see cref="XmlReader"/>.</param>
/// <returns>IEnumerable{PersonInfo}.</returns>
private PersonInfo GetPersonFromXmlNode(XmlReader reader)
{
var name = string.Empty;
var type = PersonKind.Actor; // If type is not specified assume actor
var role = string.Empty;
int? sortOrder = null;
2021-01-09 15:00:59 +01:00
string? imageUrl = null;
reader.MoveToContent();
2016-12-02 21:10:35 +01:00
reader.Read();
2016-12-02 21:10:35 +01:00
// Loop through each element
2016-12-03 22:46:06 +01:00
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
{
if (reader.NodeType == XmlNodeType.Element)
{
switch (reader.Name)
{
case "name":
2021-08-04 14:40:09 +02:00
name = reader.ReadElementContentAsString();
break;
case "role":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
role = val;
}
break;
}
2021-01-23 18:06:26 +01:00
case "type":
{
var val = reader.ReadElementContentAsString();
if (!Enum.TryParse(val, true, out type))
2021-01-23 18:06:26 +01:00
{
type = PersonKind.Actor;
2021-01-23 18:06:26 +01:00
}
break;
}
2021-01-09 15:00:59 +01:00
case "order":
case "sortorder":
{
var val = reader.ReadElementContentAsString();
if (int.TryParse(val, NumberStyles.Integer, CultureInfo.InvariantCulture, out var intVal))
{
sortOrder = intVal;
}
break;
}
2021-01-09 15:00:59 +01:00
case "thumb":
{
var val = reader.ReadElementContentAsString();
if (!string.IsNullOrWhiteSpace(val))
{
imageUrl = val;
}
break;
}
default:
reader.Skip();
break;
}
}
2016-12-02 21:10:35 +01:00
else
{
reader.Read();
}
}
return new PersonInfo
{
Name = name.Trim(),
Role = role,
Type = type,
2021-01-09 15:00:59 +01:00
SortOrder = sortOrder,
ImageUrl = imageUrl
};
}
2019-02-02 16:12:16 +01:00
internal XmlReaderSettings GetXmlReaderSettings()
=> new XmlReaderSettings()
{
ValidationType = ValidationType.None,
CheckCharacters = false,
IgnoreProcessingInstructions = true,
IgnoreComments = true
};
/// <summary>
/// Used to split names of comma or pipe delimited genres and people.
/// </summary>
/// <param name="value">The value.</param>
/// <returns>IEnumerable{System.String}.</returns>
private IEnumerable<string> SplitNames(string value)
{
// Only split by comma if there is no pipe in the string
// We have to be careful to not split names like Matthew, Jr.
2021-03-09 03:04:47 +01:00
var separator = !value.Contains('|', StringComparison.Ordinal) && !value.Contains(';', StringComparison.Ordinal)
? new[] { ',' }
: new[] { '|', ';' };
value = value.Trim().Trim(separator);
return string.IsNullOrWhiteSpace(value) ? Array.Empty<string>() : value.Split(separator, StringSplitOptions.RemoveEmptyEntries);
}
/// <summary>
2022-04-27 13:08:54 +02:00
/// Parses the <see cref="ImageType"/> from the NFO aspect property.
/// </summary>
2022-04-27 13:08:54 +02:00
/// <param name="aspect">The NFO aspect property.</param>
/// <returns>The <see cref="ImageType"/>.</returns>
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,
};
}
}
}