BaseNfoParser.cs 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007
  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. if (!string.IsNullOrEmpty(provider))
  522. {
  523. if (_validProviderIds.TryGetValue(provider, out string? normalizedProvider))
  524. {
  525. item.TrySetProviderId(normalizedProvider, providerId);
  526. }
  527. else
  528. {
  529. item.TrySetProviderId(provider, providerId);
  530. }
  531. }
  532. break;
  533. case "thumb":
  534. FetchThumbNode(reader, itemResult, "thumb");
  535. break;
  536. case "fanart":
  537. {
  538. if (reader.IsEmptyElement)
  539. {
  540. reader.Read();
  541. break;
  542. }
  543. using var subtree = reader.ReadSubtree();
  544. if (!subtree.ReadToDescendant("thumb"))
  545. {
  546. break;
  547. }
  548. FetchThumbNode(subtree, itemResult, "fanart");
  549. break;
  550. }
  551. default:
  552. string readerName = reader.Name;
  553. if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue))
  554. {
  555. var id = reader.ReadElementContentAsString();
  556. item.TrySetProviderId(providerIdValue, id);
  557. }
  558. else
  559. {
  560. reader.Skip();
  561. }
  562. break;
  563. }
  564. }
  565. private void FetchThumbNode(XmlReader reader, MetadataResult<T> itemResult, string parentNode)
  566. {
  567. var artType = reader.GetAttribute("aspect");
  568. var val = reader.ReadElementContentAsString();
  569. // artType is null if the thumb node is a child of the fanart tag
  570. // -> set image type to fanart
  571. if (string.IsNullOrWhiteSpace(artType) && parentNode.Equals("fanart", StringComparison.Ordinal))
  572. {
  573. artType = "fanart";
  574. }
  575. else if (string.IsNullOrWhiteSpace(artType))
  576. {
  577. // Sonarr writes thumb tags for posters without aspect property
  578. artType = "poster";
  579. }
  580. // skip:
  581. // - empty uri
  582. // - tag containing '.' because we can't set images for seasons, episodes or movie sets within series or movies
  583. if (string.IsNullOrEmpty(val) || artType.Contains('.', StringComparison.Ordinal))
  584. {
  585. return;
  586. }
  587. ImageType imageType = GetImageType(artType);
  588. if (!Uri.TryCreate(val, UriKind.Absolute, out var uri))
  589. {
  590. Logger.LogError("Image location {Path} specified in nfo file for {ItemName} is not a valid URL or file path.", val, itemResult.Item.Name);
  591. return;
  592. }
  593. if (uri.IsFile)
  594. {
  595. // only allow one item of each type
  596. if (itemResult.Images.Any(x => x.Type == imageType))
  597. {
  598. return;
  599. }
  600. var fileSystemMetadata = _directoryService.GetFile(val);
  601. // nonexistent file returns null
  602. if (fileSystemMetadata is null || !fileSystemMetadata.Exists)
  603. {
  604. Logger.LogWarning("Artwork file {Path} specified in nfo file for {ItemName} does not exist.", uri, itemResult.Item.Name);
  605. return;
  606. }
  607. itemResult.Images.Add(new LocalImageInfo()
  608. {
  609. FileInfo = fileSystemMetadata,
  610. Type = imageType
  611. });
  612. }
  613. else
  614. {
  615. // only allow one item of each type
  616. if (itemResult.RemoteImages.Any(x => x.Type == imageType))
  617. {
  618. return;
  619. }
  620. itemResult.RemoteImages.Add((uri.ToString(), imageType));
  621. }
  622. }
  623. private void FetchFromFileInfoNode(XmlReader parentReader, T item)
  624. {
  625. if (parentReader.IsEmptyElement)
  626. {
  627. parentReader.Read();
  628. return;
  629. }
  630. using var reader = parentReader.ReadSubtree();
  631. reader.MoveToContent();
  632. reader.Read();
  633. // Loop through each element
  634. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  635. {
  636. if (reader.NodeType != XmlNodeType.Element)
  637. {
  638. reader.Read();
  639. continue;
  640. }
  641. switch (reader.Name)
  642. {
  643. case "streamdetails":
  644. FetchFromStreamDetailsNode(reader, item);
  645. break;
  646. default:
  647. reader.Skip();
  648. break;
  649. }
  650. }
  651. }
  652. private void FetchFromStreamDetailsNode(XmlReader parentReader, T item)
  653. {
  654. if (parentReader.IsEmptyElement)
  655. {
  656. parentReader.Read();
  657. return;
  658. }
  659. using var reader = parentReader.ReadSubtree();
  660. reader.MoveToContent();
  661. reader.Read();
  662. // Loop through each element
  663. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  664. {
  665. if (reader.NodeType != XmlNodeType.Element)
  666. {
  667. reader.Read();
  668. continue;
  669. }
  670. switch (reader.Name)
  671. {
  672. case "video":
  673. FetchFromVideoNode(reader, item);
  674. break;
  675. case "subtitle":
  676. FetchFromSubtitleNode(reader, item);
  677. break;
  678. default:
  679. reader.Skip();
  680. break;
  681. }
  682. }
  683. }
  684. private void FetchFromVideoNode(XmlReader parentReader, T item)
  685. {
  686. if (parentReader.IsEmptyElement)
  687. {
  688. parentReader.Read();
  689. return;
  690. }
  691. using var reader = parentReader.ReadSubtree();
  692. reader.MoveToContent();
  693. reader.Read();
  694. // Loop through each element
  695. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  696. {
  697. if (reader.NodeType != XmlNodeType.Element || item is not Video video)
  698. {
  699. reader.Read();
  700. continue;
  701. }
  702. switch (reader.Name)
  703. {
  704. case "format3d":
  705. var format = reader.ReadElementContentAsString();
  706. if (string.Equals("HSBS", format, StringComparison.OrdinalIgnoreCase))
  707. {
  708. video.Video3DFormat = Video3DFormat.HalfSideBySide;
  709. }
  710. else if (string.Equals("HTAB", format, StringComparison.OrdinalIgnoreCase))
  711. {
  712. video.Video3DFormat = Video3DFormat.HalfTopAndBottom;
  713. }
  714. else if (string.Equals("FTAB", format, StringComparison.OrdinalIgnoreCase))
  715. {
  716. video.Video3DFormat = Video3DFormat.FullTopAndBottom;
  717. }
  718. else if (string.Equals("FSBS", format, StringComparison.OrdinalIgnoreCase))
  719. {
  720. video.Video3DFormat = Video3DFormat.FullSideBySide;
  721. }
  722. else if (string.Equals("MVC", format, StringComparison.OrdinalIgnoreCase))
  723. {
  724. video.Video3DFormat = Video3DFormat.MVC;
  725. }
  726. break;
  727. case "aspect":
  728. video.AspectRatio = reader.ReadNormalizedString();
  729. break;
  730. case "width":
  731. video.Width = reader.ReadElementContentAsInt();
  732. break;
  733. case "height":
  734. video.Height = reader.ReadElementContentAsInt();
  735. break;
  736. case "durationinseconds":
  737. video.RunTimeTicks = new TimeSpan(0, 0, reader.ReadElementContentAsInt()).Ticks;
  738. break;
  739. default:
  740. reader.Skip();
  741. break;
  742. }
  743. }
  744. }
  745. private void FetchFromSubtitleNode(XmlReader parentReader, T item)
  746. {
  747. if (parentReader.IsEmptyElement)
  748. {
  749. parentReader.Read();
  750. return;
  751. }
  752. using var reader = parentReader.ReadSubtree();
  753. reader.MoveToContent();
  754. reader.Read();
  755. // Loop through each element
  756. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  757. {
  758. if (reader.NodeType != XmlNodeType.Element)
  759. {
  760. reader.Read();
  761. continue;
  762. }
  763. switch (reader.Name)
  764. {
  765. case "language":
  766. _ = reader.ReadElementContentAsString();
  767. if (item is Video video)
  768. {
  769. video.HasSubtitles = true;
  770. }
  771. break;
  772. default:
  773. reader.Skip();
  774. break;
  775. }
  776. }
  777. }
  778. private void FetchFromRatingsNode(XmlReader parentReader, T item)
  779. {
  780. if (parentReader.IsEmptyElement)
  781. {
  782. parentReader.Read();
  783. return;
  784. }
  785. using var reader = parentReader.ReadSubtree();
  786. reader.MoveToContent();
  787. reader.Read();
  788. // Loop through each element
  789. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  790. {
  791. if (reader.NodeType == XmlNodeType.Element)
  792. {
  793. switch (reader.Name)
  794. {
  795. case "rating":
  796. {
  797. if (reader.IsEmptyElement)
  798. {
  799. reader.Read();
  800. continue;
  801. }
  802. var ratingName = reader.GetAttribute("name");
  803. using var subtree = reader.ReadSubtree();
  804. FetchFromRatingNode(subtree, item, ratingName);
  805. break;
  806. }
  807. default:
  808. reader.Skip();
  809. break;
  810. }
  811. }
  812. else
  813. {
  814. reader.Read();
  815. }
  816. }
  817. }
  818. private void FetchFromRatingNode(XmlReader reader, T item, string? ratingName)
  819. {
  820. reader.MoveToContent();
  821. reader.Read();
  822. // Loop through each element
  823. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  824. {
  825. if (reader.NodeType == XmlNodeType.Element)
  826. {
  827. switch (reader.Name)
  828. {
  829. case "value":
  830. var val = reader.ReadElementContentAsString();
  831. if (float.TryParse(val, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var ratingValue))
  832. {
  833. // if ratingName contains tomato --> assume critic rating
  834. if (ratingName is not null
  835. && ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase)
  836. && !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase))
  837. {
  838. if (!ratingName.Contains("avg", StringComparison.OrdinalIgnoreCase))
  839. {
  840. item.CriticRating = ratingValue;
  841. }
  842. }
  843. else
  844. {
  845. item.CommunityRating = ratingValue;
  846. }
  847. }
  848. break;
  849. default:
  850. reader.Skip();
  851. break;
  852. }
  853. }
  854. else
  855. {
  856. reader.Read();
  857. }
  858. }
  859. }
  860. internal XmlReaderSettings GetXmlReaderSettings()
  861. => new XmlReaderSettings()
  862. {
  863. ValidationType = ValidationType.None,
  864. CheckCharacters = false,
  865. IgnoreProcessingInstructions = true,
  866. IgnoreComments = true
  867. };
  868. /// <summary>
  869. /// Parses the <see cref="ImageType"/> from the NFO aspect property.
  870. /// </summary>
  871. /// <param name="aspect">The NFO aspect property.</param>
  872. /// <returns>The <see cref="ImageType"/>.</returns>
  873. private static ImageType GetImageType(string aspect)
  874. {
  875. return aspect switch
  876. {
  877. "banner" => ImageType.Banner,
  878. "clearlogo" => ImageType.Logo,
  879. "discart" => ImageType.Disc,
  880. "landscape" => ImageType.Thumb,
  881. "clearart" => ImageType.Art,
  882. "fanart" => ImageType.Backdrop,
  883. // unknown type (including "poster") --> primary
  884. _ => ImageType.Primary,
  885. };
  886. }
  887. }
  888. }