BaseNfoParser.cs 38 KB

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