BaseNfoParser.cs 37 KB

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