BaseNfoParser.cs 37 KB

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