2
0

BaseNfoParser.cs 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981
  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 (!string.IsNullOrWhiteSpace(nfoConfiguration.UserId))
  272. {
  273. var user = _userManager.GetUserById(Guid.Parse(nfoConfiguration.UserId));
  274. userData = _userDataManager.GetUserData(user, item);
  275. userData.Played = played;
  276. _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None);
  277. }
  278. break;
  279. case "playcount":
  280. if (reader.TryReadInt(out var count)
  281. && Guid.TryParse(nfoConfiguration.UserId, out var playCountUserId))
  282. {
  283. var user = _userManager.GetUserById(playCountUserId);
  284. userData = _userDataManager.GetUserData(user, item);
  285. userData.PlayCount = count;
  286. _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None);
  287. }
  288. break;
  289. case "lastplayed":
  290. if (reader.TryReadDateTime(out var lastPlayed)
  291. && Guid.TryParse(nfoConfiguration.UserId, out var lastPlayedUserId))
  292. {
  293. var user = _userManager.GetUserById(lastPlayedUserId);
  294. userData = _userDataManager.GetUserData(user, item);
  295. userData.LastPlayedDate = lastPlayed;
  296. _userDataManager.SaveUserData(user, item, userData, UserDataSaveReason.Import, CancellationToken.None);
  297. }
  298. break;
  299. case "countrycode":
  300. item.PreferredMetadataCountryCode = reader.ReadNormalizedString();
  301. break;
  302. case "lockedfields":
  303. {
  304. var val = reader.ReadElementContentAsString();
  305. if (!string.IsNullOrWhiteSpace(val))
  306. {
  307. item.LockedFields = val.Split('|').Select(i =>
  308. {
  309. if (Enum.TryParse(i, true, out MetadataField field))
  310. {
  311. return (MetadataField?)field;
  312. }
  313. return null;
  314. }).OfType<MetadataField>().ToArray();
  315. }
  316. break;
  317. }
  318. case "tagline":
  319. item.Tagline = reader.ReadNormalizedString();
  320. break;
  321. case "country":
  322. {
  323. var val = reader.ReadElementContentAsString();
  324. if (!string.IsNullOrWhiteSpace(val))
  325. {
  326. item.ProductionLocations = val.Split('/')
  327. .Select(i => i.Trim())
  328. .Where(i => !string.IsNullOrWhiteSpace(i))
  329. .ToArray();
  330. }
  331. break;
  332. }
  333. case "mpaa":
  334. item.OfficialRating = reader.ReadNormalizedString();
  335. break;
  336. case "customrating":
  337. item.CustomRating = reader.ReadNormalizedString();
  338. break;
  339. case "runtime":
  340. var runtimeText = reader.ReadElementContentAsString();
  341. if (int.TryParse(runtimeText.AsSpan().LeftPart(' '), NumberStyles.Integer, CultureInfo.InvariantCulture, out var runtime))
  342. {
  343. item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks;
  344. }
  345. break;
  346. case "aspectratio":
  347. var aspectRatio = reader.ReadNormalizedString();
  348. if (!string.IsNullOrEmpty(aspectRatio) && item is IHasAspectRatio hasAspectRatio)
  349. {
  350. hasAspectRatio.AspectRatio = aspectRatio;
  351. }
  352. break;
  353. case "lockdata":
  354. item.IsLocked = string.Equals(reader.ReadElementContentAsString(), "true", StringComparison.OrdinalIgnoreCase);
  355. break;
  356. case "studio":
  357. var studio = reader.ReadNormalizedString();
  358. if (!string.IsNullOrEmpty(studio))
  359. {
  360. item.AddStudio(studio);
  361. }
  362. break;
  363. case "director":
  364. foreach (var director in reader.GetPersonArray(PersonKind.Director))
  365. {
  366. itemResult.AddPerson(director);
  367. }
  368. break;
  369. case "credits":
  370. {
  371. var val = reader.ReadElementContentAsString();
  372. if (!string.IsNullOrWhiteSpace(val))
  373. {
  374. var parts = val.Split('/').Select(i => i.Trim())
  375. .Where(i => !string.IsNullOrEmpty(i));
  376. foreach (var p in parts.Select(v => new PersonInfo { Name = v.Trim(), Type = PersonKind.Writer }))
  377. {
  378. if (string.IsNullOrWhiteSpace(p.Name))
  379. {
  380. continue;
  381. }
  382. itemResult.AddPerson(p);
  383. }
  384. }
  385. break;
  386. }
  387. case "writer":
  388. foreach (var writer in reader.GetPersonArray(PersonKind.Writer))
  389. {
  390. itemResult.AddPerson(writer);
  391. }
  392. break;
  393. case "actor":
  394. var person = reader.GetPersonFromXmlNode();
  395. if (person is not null)
  396. {
  397. itemResult.AddPerson(person);
  398. }
  399. break;
  400. case "trailer":
  401. var trailer = reader.ReadNormalizedString();
  402. if (!string.IsNullOrEmpty(trailer))
  403. {
  404. if (trailer.StartsWith("plugin://plugin.video.youtube/?action=play_video&videoid=", StringComparison.OrdinalIgnoreCase))
  405. {
  406. // Deprecated format
  407. item.AddTrailerUrl(trailer.Replace(
  408. "plugin://plugin.video.youtube/?action=play_video&videoid=",
  409. BaseNfoSaver.YouTubeWatchUrl,
  410. StringComparison.OrdinalIgnoreCase));
  411. var suggestedUrl = trailer.Replace(
  412. "plugin://plugin.video.youtube/?action=play_video&videoid=",
  413. "plugin://plugin.video.youtube/play/?video_id=",
  414. StringComparison.OrdinalIgnoreCase);
  415. Logger.LogWarning("Trailer URL uses a deprecated format : {Url}. Using {NewUrl} instead is advised.", trailer, suggestedUrl);
  416. }
  417. else if (trailer.StartsWith("plugin://plugin.video.youtube/play/?video_id=", StringComparison.OrdinalIgnoreCase))
  418. {
  419. // Proper format
  420. item.AddTrailerUrl(trailer.Replace(
  421. "plugin://plugin.video.youtube/play/?video_id=",
  422. BaseNfoSaver.YouTubeWatchUrl,
  423. StringComparison.OrdinalIgnoreCase));
  424. }
  425. }
  426. break;
  427. case "displayorder":
  428. var displayOrder = reader.ReadNormalizedString();
  429. if (!string.IsNullOrEmpty(displayOrder) && item is IHasDisplayOrder hasDisplayOrder)
  430. {
  431. hasDisplayOrder.DisplayOrder = displayOrder;
  432. }
  433. break;
  434. case "year":
  435. if (reader.TryReadInt(out var productionYear) && productionYear > 1850)
  436. {
  437. item.ProductionYear = productionYear;
  438. }
  439. break;
  440. case "rating":
  441. var rating = reader.ReadElementContentAsString().Replace(',', '.');
  442. // All external meta is saving this as '.' for decimal I believe...but just to be sure
  443. if (float.TryParse(rating, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var communityRating))
  444. {
  445. item.CommunityRating = communityRating;
  446. }
  447. break;
  448. case "ratings":
  449. FetchFromRatingsNode(reader, item);
  450. break;
  451. case "aired":
  452. case "formed":
  453. case "premiered":
  454. case "releasedate":
  455. if (reader.TryReadDateTimeExact(nfoConfiguration.ReleaseDateFormat, out var releaseDate))
  456. {
  457. item.PremiereDate = releaseDate;
  458. item.ProductionYear = releaseDate.Year;
  459. }
  460. break;
  461. case "enddate":
  462. if (reader.TryReadDateTimeExact(nfoConfiguration.ReleaseDateFormat, out var endDate))
  463. {
  464. item.EndDate = endDate;
  465. }
  466. break;
  467. case "genre":
  468. {
  469. var val = reader.ReadElementContentAsString();
  470. if (!string.IsNullOrWhiteSpace(val))
  471. {
  472. var parts = val.Split('/')
  473. .Select(i => i.Trim())
  474. .Where(i => !string.IsNullOrWhiteSpace(i));
  475. foreach (var p in parts)
  476. {
  477. item.AddGenre(p);
  478. }
  479. }
  480. break;
  481. }
  482. case "style":
  483. case "tag":
  484. var tag = reader.ReadNormalizedString();
  485. if (!string.IsNullOrEmpty(tag))
  486. {
  487. item.AddTag(tag);
  488. }
  489. break;
  490. case "fileinfo":
  491. FetchFromFileInfoNode(reader, item);
  492. break;
  493. case "uniqueid":
  494. if (reader.IsEmptyElement)
  495. {
  496. reader.Read();
  497. break;
  498. }
  499. var provider = reader.GetAttribute("type");
  500. var providerId = reader.ReadElementContentAsString();
  501. if (!string.IsNullOrWhiteSpace(provider) && !string.IsNullOrWhiteSpace(providerId))
  502. {
  503. item.SetProviderId(provider, providerId);
  504. }
  505. break;
  506. case "thumb":
  507. FetchThumbNode(reader, itemResult, "thumb");
  508. break;
  509. case "fanart":
  510. {
  511. if (reader.IsEmptyElement)
  512. {
  513. reader.Read();
  514. break;
  515. }
  516. using var subtree = reader.ReadSubtree();
  517. if (!subtree.ReadToDescendant("thumb"))
  518. {
  519. break;
  520. }
  521. FetchThumbNode(subtree, itemResult, "fanart");
  522. break;
  523. }
  524. default:
  525. string readerName = reader.Name;
  526. if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue))
  527. {
  528. var id = reader.ReadElementContentAsString();
  529. if (!string.IsNullOrWhiteSpace(providerIdValue) && !string.IsNullOrWhiteSpace(id))
  530. {
  531. item.SetProviderId(providerIdValue, id);
  532. }
  533. }
  534. else
  535. {
  536. reader.Skip();
  537. }
  538. break;
  539. }
  540. }
  541. private void FetchThumbNode(XmlReader reader, MetadataResult<T> itemResult, string parentNode)
  542. {
  543. var artType = reader.GetAttribute("aspect");
  544. var val = reader.ReadElementContentAsString();
  545. // artType is null if the thumb node is a child of the fanart tag
  546. // -> set image type to fanart
  547. if (string.IsNullOrWhiteSpace(artType) && parentNode.Equals("fanart", StringComparison.Ordinal))
  548. {
  549. artType = "fanart";
  550. }
  551. else if (string.IsNullOrWhiteSpace(artType))
  552. {
  553. // Sonarr writes thumb tags for posters without aspect property
  554. artType = "poster";
  555. }
  556. // skip:
  557. // - empty uri
  558. // - tag containing '.' because we can't set images for seasons, episodes or movie sets within series or movies
  559. if (string.IsNullOrEmpty(val) || artType.Contains('.', StringComparison.Ordinal))
  560. {
  561. return;
  562. }
  563. ImageType imageType = GetImageType(artType);
  564. if (!Uri.TryCreate(val, UriKind.Absolute, out var uri))
  565. {
  566. Logger.LogError("Image location {Path} specified in nfo file for {ItemName} is not a valid URL or file path.", val, itemResult.Item.Name);
  567. return;
  568. }
  569. if (uri.IsFile)
  570. {
  571. // only allow one item of each type
  572. if (itemResult.Images.Any(x => x.Type == imageType))
  573. {
  574. return;
  575. }
  576. var fileSystemMetadata = _directoryService.GetFile(val);
  577. // non existing file returns null
  578. if (fileSystemMetadata is null || !fileSystemMetadata.Exists)
  579. {
  580. Logger.LogWarning("Artwork file {Path} specified in nfo file for {ItemName} does not exist.", uri, itemResult.Item.Name);
  581. return;
  582. }
  583. itemResult.Images.Add(new LocalImageInfo()
  584. {
  585. FileInfo = fileSystemMetadata,
  586. Type = imageType
  587. });
  588. }
  589. else
  590. {
  591. // only allow one item of each type
  592. if (itemResult.RemoteImages.Any(x => x.Type == imageType))
  593. {
  594. return;
  595. }
  596. itemResult.RemoteImages.Add((uri.ToString(), imageType));
  597. }
  598. }
  599. private void FetchFromFileInfoNode(XmlReader parentReader, T item)
  600. {
  601. if (parentReader.IsEmptyElement)
  602. {
  603. parentReader.Read();
  604. return;
  605. }
  606. using var reader = parentReader.ReadSubtree();
  607. reader.MoveToContent();
  608. reader.Read();
  609. // Loop through each element
  610. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  611. {
  612. if (reader.NodeType != XmlNodeType.Element)
  613. {
  614. reader.Read();
  615. continue;
  616. }
  617. switch (reader.Name)
  618. {
  619. case "streamdetails":
  620. FetchFromStreamDetailsNode(reader, item);
  621. break;
  622. default:
  623. reader.Skip();
  624. break;
  625. }
  626. }
  627. }
  628. private void FetchFromStreamDetailsNode(XmlReader parentReader, T item)
  629. {
  630. if (parentReader.IsEmptyElement)
  631. {
  632. parentReader.Read();
  633. return;
  634. }
  635. using var reader = parentReader.ReadSubtree();
  636. reader.MoveToContent();
  637. reader.Read();
  638. // Loop through each element
  639. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  640. {
  641. if (reader.NodeType != XmlNodeType.Element)
  642. {
  643. reader.Read();
  644. continue;
  645. }
  646. switch (reader.Name)
  647. {
  648. case "video":
  649. FetchFromVideoNode(reader, item);
  650. break;
  651. case "subtitle":
  652. FetchFromSubtitleNode(reader, item);
  653. break;
  654. default:
  655. reader.Skip();
  656. break;
  657. }
  658. }
  659. }
  660. private void FetchFromVideoNode(XmlReader parentReader, T item)
  661. {
  662. if (parentReader.IsEmptyElement)
  663. {
  664. parentReader.Read();
  665. return;
  666. }
  667. using var reader = parentReader.ReadSubtree();
  668. reader.MoveToContent();
  669. reader.Read();
  670. // Loop through each element
  671. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  672. {
  673. if (reader.NodeType != XmlNodeType.Element || item is not Video video)
  674. {
  675. reader.Read();
  676. continue;
  677. }
  678. switch (reader.Name)
  679. {
  680. case "format3d":
  681. var format = reader.ReadElementContentAsString();
  682. if (string.Equals("HSBS", format, StringComparison.OrdinalIgnoreCase))
  683. {
  684. video.Video3DFormat = Video3DFormat.HalfSideBySide;
  685. }
  686. else if (string.Equals("HTAB", format, StringComparison.OrdinalIgnoreCase))
  687. {
  688. video.Video3DFormat = Video3DFormat.HalfTopAndBottom;
  689. }
  690. else if (string.Equals("FTAB", format, StringComparison.OrdinalIgnoreCase))
  691. {
  692. video.Video3DFormat = Video3DFormat.FullTopAndBottom;
  693. }
  694. else if (string.Equals("FSBS", format, StringComparison.OrdinalIgnoreCase))
  695. {
  696. video.Video3DFormat = Video3DFormat.FullSideBySide;
  697. }
  698. else if (string.Equals("MVC", format, StringComparison.OrdinalIgnoreCase))
  699. {
  700. video.Video3DFormat = Video3DFormat.MVC;
  701. }
  702. break;
  703. case "aspect":
  704. video.AspectRatio = reader.ReadNormalizedString();
  705. break;
  706. case "width":
  707. video.Width = reader.ReadElementContentAsInt();
  708. break;
  709. case "height":
  710. video.Height = reader.ReadElementContentAsInt();
  711. break;
  712. case "durationinseconds":
  713. video.RunTimeTicks = new TimeSpan(0, 0, reader.ReadElementContentAsInt()).Ticks;
  714. break;
  715. default:
  716. reader.Skip();
  717. break;
  718. }
  719. }
  720. }
  721. private void FetchFromSubtitleNode(XmlReader parentReader, T item)
  722. {
  723. if (parentReader.IsEmptyElement)
  724. {
  725. parentReader.Read();
  726. return;
  727. }
  728. using var reader = parentReader.ReadSubtree();
  729. reader.MoveToContent();
  730. reader.Read();
  731. // Loop through each element
  732. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  733. {
  734. if (reader.NodeType != XmlNodeType.Element)
  735. {
  736. reader.Read();
  737. continue;
  738. }
  739. switch (reader.Name)
  740. {
  741. case "language":
  742. _ = reader.ReadElementContentAsString();
  743. if (item is Video video)
  744. {
  745. video.HasSubtitles = true;
  746. }
  747. break;
  748. default:
  749. reader.Skip();
  750. break;
  751. }
  752. }
  753. }
  754. private void FetchFromRatingsNode(XmlReader parentReader, T item)
  755. {
  756. if (parentReader.IsEmptyElement)
  757. {
  758. parentReader.Read();
  759. return;
  760. }
  761. using var reader = parentReader.ReadSubtree();
  762. reader.MoveToContent();
  763. reader.Read();
  764. // Loop through each element
  765. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  766. {
  767. if (reader.NodeType == XmlNodeType.Element)
  768. {
  769. switch (reader.Name)
  770. {
  771. case "rating":
  772. {
  773. if (reader.IsEmptyElement)
  774. {
  775. reader.Read();
  776. continue;
  777. }
  778. var ratingName = reader.GetAttribute("name");
  779. using var subtree = reader.ReadSubtree();
  780. FetchFromRatingNode(subtree, item, ratingName);
  781. break;
  782. }
  783. default:
  784. reader.Skip();
  785. break;
  786. }
  787. }
  788. else
  789. {
  790. reader.Read();
  791. }
  792. }
  793. }
  794. private void FetchFromRatingNode(XmlReader reader, T item, string? ratingName)
  795. {
  796. reader.MoveToContent();
  797. reader.Read();
  798. // Loop through each element
  799. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  800. {
  801. if (reader.NodeType == XmlNodeType.Element)
  802. {
  803. switch (reader.Name)
  804. {
  805. case "value":
  806. var val = reader.ReadElementContentAsString();
  807. if (float.TryParse(val, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var ratingValue))
  808. {
  809. // if ratingName contains tomato --> assume critic rating
  810. if (ratingName is not null
  811. && ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase)
  812. && !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase))
  813. {
  814. if (!ratingName.Contains("avg", StringComparison.OrdinalIgnoreCase))
  815. {
  816. item.CriticRating = ratingValue;
  817. }
  818. }
  819. else
  820. {
  821. item.CommunityRating = ratingValue;
  822. }
  823. }
  824. break;
  825. default:
  826. reader.Skip();
  827. break;
  828. }
  829. }
  830. else
  831. {
  832. reader.Read();
  833. }
  834. }
  835. }
  836. internal XmlReaderSettings GetXmlReaderSettings()
  837. => new XmlReaderSettings()
  838. {
  839. ValidationType = ValidationType.None,
  840. CheckCharacters = false,
  841. IgnoreProcessingInstructions = true,
  842. IgnoreComments = true
  843. };
  844. /// <summary>
  845. /// Parses the <see cref="ImageType"/> from the NFO aspect property.
  846. /// </summary>
  847. /// <param name="aspect">The NFO aspect property.</param>
  848. /// <returns>The <see cref="ImageType"/>.</returns>
  849. private static ImageType GetImageType(string aspect)
  850. {
  851. return aspect switch
  852. {
  853. "banner" => ImageType.Banner,
  854. "clearlogo" => ImageType.Logo,
  855. "discart" => ImageType.Disc,
  856. "landscape" => ImageType.Thumb,
  857. "clearart" => ImageType.Art,
  858. "fanart" => ImageType.Backdrop,
  859. // unknown type (including "poster") --> primary
  860. _ => ImageType.Primary,
  861. };
  862. }
  863. }
  864. }