BaseNfoParser.cs 37 KB

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