BaseNfoParser.cs 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357
  1. #pragma warning disable CS1591
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Globalization;
  5. using System.IO;
  6. using System.Linq;
  7. using System.Text;
  8. using System.Threading;
  9. using System.Xml;
  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.Library;
  17. using MediaBrowser.Controller.Providers;
  18. using MediaBrowser.Model.Entities;
  19. using MediaBrowser.XbmcMetadata.Configuration;
  20. using MediaBrowser.XbmcMetadata.Savers;
  21. using Microsoft.Extensions.Logging;
  22. namespace MediaBrowser.XbmcMetadata.Parsers
  23. {
  24. public class BaseNfoParser<T>
  25. where T : BaseItem
  26. {
  27. private readonly IConfigurationManager _config;
  28. private readonly IUserManager _userManager;
  29. private readonly IUserDataManager _userDataManager;
  30. private readonly IDirectoryService _directoryService;
  31. private Dictionary<string, string> _validProviderIds;
  32. /// <summary>
  33. /// Initializes a new instance of the <see cref="BaseNfoParser{T}" /> class.
  34. /// </summary>
  35. /// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param>
  36. /// <param name="config">Instance of the <see cref="IConfigurationManager"/> interface.</param>
  37. /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
  38. /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
  39. /// <param name="userDataManager">Instance of the <see cref="IUserDataManager"/> interface.</param>
  40. /// <param name="directoryService">Instance of the <see cref="IDirectoryService"/> interface.</param>
  41. public BaseNfoParser(
  42. ILogger logger,
  43. IConfigurationManager config,
  44. IProviderManager providerManager,
  45. IUserManager userManager,
  46. IUserDataManager userDataManager,
  47. IDirectoryService directoryService)
  48. {
  49. Logger = logger;
  50. _config = config;
  51. ProviderManager = providerManager;
  52. _validProviderIds = new Dictionary<string, string>();
  53. _userManager = userManager;
  54. _userDataManager = userDataManager;
  55. _directoryService = directoryService;
  56. }
  57. protected CultureInfo UsCulture { get; } = new CultureInfo("en-US");
  58. /// <summary>
  59. /// Gets the logger.
  60. /// </summary>
  61. protected ILogger Logger { get; }
  62. protected IProviderManager ProviderManager { get; }
  63. protected virtual bool SupportsUrlAfterClosingXmlTag => false;
  64. /// <summary>
  65. /// Fetches metadata for an item from one xml file.
  66. /// </summary>
  67. /// <param name="item">The item.</param>
  68. /// <param name="metadataFile">The metadata file.</param>
  69. /// <param name="cancellationToken">The cancellation token.</param>
  70. /// <exception cref="ArgumentNullException"><c>item</c> is <c>null</c>.</exception>
  71. /// <exception cref="ArgumentException"><c>metadataFile</c> is <c>null</c> or empty.</exception>
  72. public void Fetch(MetadataResult<T> item, string metadataFile, CancellationToken cancellationToken)
  73. {
  74. if (item.Item == null)
  75. {
  76. throw new ArgumentException("Item can't be null.", nameof(item));
  77. }
  78. if (string.IsNullOrEmpty(metadataFile))
  79. {
  80. throw new ArgumentException("The metadata filepath was empty.", nameof(metadataFile));
  81. }
  82. _validProviderIds = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
  83. var idInfos = ProviderManager.GetExternalIdInfos(item.Item);
  84. foreach (var info in idInfos)
  85. {
  86. var id = info.Key + "Id";
  87. if (!_validProviderIds.ContainsKey(id))
  88. {
  89. _validProviderIds.Add(id, info.Key);
  90. }
  91. }
  92. // Additional Mappings
  93. _validProviderIds.Add("collectionnumber", "TmdbCollection");
  94. _validProviderIds.Add("tmdbcolid", "TmdbCollection");
  95. _validProviderIds.Add("imdb_id", "Imdb");
  96. Fetch(item, metadataFile, GetXmlReaderSettings(), cancellationToken);
  97. }
  98. /// <summary>
  99. /// Fetches the specified item.
  100. /// </summary>
  101. /// <param name="item">The item.</param>
  102. /// <param name="metadataFile">The metadata file.</param>
  103. /// <param name="settings">The settings.</param>
  104. /// <param name="cancellationToken">The cancellation token.</param>
  105. protected virtual void Fetch(MetadataResult<T> item, string metadataFile, XmlReaderSettings settings, CancellationToken cancellationToken)
  106. {
  107. if (!SupportsUrlAfterClosingXmlTag)
  108. {
  109. using (var fileStream = File.OpenRead(metadataFile))
  110. using (var streamReader = new StreamReader(fileStream, Encoding.UTF8))
  111. using (var reader = XmlReader.Create(streamReader, settings))
  112. {
  113. item.ResetPeople();
  114. reader.MoveToContent();
  115. reader.Read();
  116. // Loop through each element
  117. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  118. {
  119. cancellationToken.ThrowIfCancellationRequested();
  120. if (reader.NodeType == XmlNodeType.Element)
  121. {
  122. FetchDataFromXmlNode(reader, item);
  123. }
  124. else
  125. {
  126. reader.Read();
  127. }
  128. }
  129. }
  130. return;
  131. }
  132. item.ResetPeople();
  133. // Need to handle a url after the xml data
  134. // http://kodi.wiki/view/NFO_files/movies
  135. var xml = File.ReadAllText(metadataFile);
  136. // Find last closing Tag
  137. // Need to do this in two steps to account for random > characters after the closing xml
  138. var index = xml.LastIndexOf(@"</", StringComparison.Ordinal);
  139. // If closing tag exists, move to end of Tag
  140. if (index != -1)
  141. {
  142. index = xml.IndexOf('>', index);
  143. }
  144. if (index != -1)
  145. {
  146. var endingXml = xml.AsSpan().Slice(index);
  147. ParseProviderLinks(item.Item, endingXml);
  148. // If the file is just an imdb url, don't go any further
  149. if (index == 0)
  150. {
  151. return;
  152. }
  153. xml = xml.Substring(0, index + 1);
  154. }
  155. else
  156. {
  157. // If the file is just provider urls, handle that
  158. ParseProviderLinks(item.Item, xml);
  159. return;
  160. }
  161. // These are not going to be valid xml so no sense in causing the provider to fail and spamming the log with exceptions
  162. try
  163. {
  164. using (var stringReader = new StringReader(xml))
  165. using (var reader = XmlReader.Create(stringReader, settings))
  166. {
  167. reader.MoveToContent();
  168. reader.Read();
  169. // Loop through each element
  170. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  171. {
  172. cancellationToken.ThrowIfCancellationRequested();
  173. if (reader.NodeType == XmlNodeType.Element)
  174. {
  175. FetchDataFromXmlNode(reader, item);
  176. }
  177. else
  178. {
  179. reader.Read();
  180. }
  181. }
  182. }
  183. }
  184. catch (XmlException)
  185. {
  186. }
  187. }
  188. protected void ParseProviderLinks(T item, ReadOnlySpan<char> xml)
  189. {
  190. if (ProviderIdParsers.TryFindImdbId(xml, out var imdbId))
  191. {
  192. item.SetProviderId(MetadataProvider.Imdb, imdbId.ToString());
  193. }
  194. if (item is Movie)
  195. {
  196. if (ProviderIdParsers.TryFindTmdbMovieId(xml, out var tmdbId))
  197. {
  198. item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString());
  199. }
  200. }
  201. if (item is Series)
  202. {
  203. if (ProviderIdParsers.TryFindTmdbSeriesId(xml, out var tmdbId))
  204. {
  205. item.SetProviderId(MetadataProvider.Tmdb, tmdbId.ToString());
  206. }
  207. if (ProviderIdParsers.TryFindTvdbId(xml, out var tvdbId))
  208. {
  209. item.SetProviderId(MetadataProvider.Tvdb, tvdbId.ToString());
  210. }
  211. }
  212. }
  213. protected virtual void FetchDataFromXmlNode(XmlReader reader, MetadataResult<T> itemResult)
  214. {
  215. var item = itemResult.Item;
  216. var nfoConfiguration = _config.GetNfoConfiguration();
  217. UserItemData? userData = null;
  218. if (!string.IsNullOrWhiteSpace(nfoConfiguration.UserId))
  219. {
  220. var user = _userManager.GetUserById(Guid.Parse(nfoConfiguration.UserId));
  221. userData = _userDataManager.GetUserData(user, item);
  222. }
  223. switch (reader.Name)
  224. {
  225. // DateCreated
  226. case "dateadded":
  227. {
  228. var val = reader.ReadElementContentAsString();
  229. if (!string.IsNullOrWhiteSpace(val))
  230. {
  231. if (DateTime.TryParse(val, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var added))
  232. {
  233. item.DateCreated = added;
  234. }
  235. else
  236. {
  237. Logger.LogWarning("Invalid Added value found: {Value}", val);
  238. }
  239. }
  240. break;
  241. }
  242. case "originaltitle":
  243. {
  244. var val = reader.ReadElementContentAsString();
  245. if (!string.IsNullOrEmpty(val))
  246. {
  247. item.OriginalTitle = val;
  248. }
  249. break;
  250. }
  251. case "name":
  252. case "title":
  253. case "localtitle":
  254. item.Name = reader.ReadElementContentAsString();
  255. break;
  256. case "sortname":
  257. item.SortName = reader.ReadElementContentAsString();
  258. break;
  259. case "criticrating":
  260. {
  261. var text = reader.ReadElementContentAsString();
  262. if (!string.IsNullOrEmpty(text))
  263. {
  264. if (float.TryParse(text, NumberStyles.Any, UsCulture, out var value))
  265. {
  266. item.CriticRating = value;
  267. }
  268. }
  269. break;
  270. }
  271. case "sorttitle":
  272. {
  273. var val = reader.ReadElementContentAsString();
  274. if (!string.IsNullOrWhiteSpace(val))
  275. {
  276. item.ForcedSortName = val;
  277. }
  278. break;
  279. }
  280. case "biography":
  281. case "plot":
  282. case "review":
  283. {
  284. var val = reader.ReadElementContentAsString();
  285. if (!string.IsNullOrWhiteSpace(val))
  286. {
  287. item.Overview = val;
  288. }
  289. break;
  290. }
  291. case "language":
  292. {
  293. var val = reader.ReadElementContentAsString();
  294. item.PreferredMetadataLanguage = val;
  295. break;
  296. }
  297. case "watched":
  298. {
  299. var val = reader.ReadElementContentAsBoolean();
  300. if (userData != null)
  301. {
  302. userData.Played = val;
  303. }
  304. break;
  305. }
  306. case "playcount":
  307. {
  308. var val = reader.ReadElementContentAsString();
  309. if (!string.IsNullOrWhiteSpace(val) && userData != null)
  310. {
  311. if (int.TryParse(val, NumberStyles.Integer, UsCulture, out var count))
  312. {
  313. userData.PlayCount = count;
  314. }
  315. }
  316. break;
  317. }
  318. case "lastplayed":
  319. {
  320. var val = reader.ReadElementContentAsString();
  321. if (!string.IsNullOrWhiteSpace(val) && userData != null)
  322. {
  323. if (DateTime.TryParse(val, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var added))
  324. {
  325. userData.LastPlayedDate = added;
  326. }
  327. else
  328. {
  329. Logger.LogWarning("Invalid lastplayed value found: {Value}", val);
  330. }
  331. }
  332. break;
  333. }
  334. case "countrycode":
  335. {
  336. var val = reader.ReadElementContentAsString();
  337. item.PreferredMetadataCountryCode = val;
  338. break;
  339. }
  340. case "lockedfields":
  341. {
  342. var val = reader.ReadElementContentAsString();
  343. if (!string.IsNullOrWhiteSpace(val))
  344. {
  345. item.LockedFields = val.Split('|').Select(i =>
  346. {
  347. if (Enum.TryParse(i, true, out MetadataField field))
  348. {
  349. return (MetadataField?)field;
  350. }
  351. return null;
  352. }).OfType<MetadataField>().ToArray();
  353. }
  354. break;
  355. }
  356. case "tagline":
  357. item.Tagline = reader.ReadElementContentAsString();
  358. break;
  359. case "country":
  360. {
  361. var val = reader.ReadElementContentAsString();
  362. if (!string.IsNullOrWhiteSpace(val))
  363. {
  364. item.ProductionLocations = val.Split('/')
  365. .Select(i => i.Trim())
  366. .Where(i => !string.IsNullOrWhiteSpace(i))
  367. .ToArray();
  368. }
  369. break;
  370. }
  371. case "mpaa":
  372. {
  373. var rating = reader.ReadElementContentAsString();
  374. if (!string.IsNullOrWhiteSpace(rating))
  375. {
  376. item.OfficialRating = rating;
  377. }
  378. break;
  379. }
  380. case "customrating":
  381. {
  382. var val = reader.ReadElementContentAsString();
  383. if (!string.IsNullOrWhiteSpace(val))
  384. {
  385. item.CustomRating = val;
  386. }
  387. break;
  388. }
  389. case "runtime":
  390. {
  391. var text = reader.ReadElementContentAsString();
  392. if (!string.IsNullOrWhiteSpace(text))
  393. {
  394. if (int.TryParse(text.AsSpan().LeftPart(' '), NumberStyles.Integer, UsCulture, out var runtime))
  395. {
  396. item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks;
  397. }
  398. }
  399. break;
  400. }
  401. case "aspectratio":
  402. {
  403. var val = reader.ReadElementContentAsString();
  404. if (!string.IsNullOrWhiteSpace(val)
  405. && item is IHasAspectRatio hasAspectRatio)
  406. {
  407. hasAspectRatio.AspectRatio = val;
  408. }
  409. break;
  410. }
  411. case "lockdata":
  412. {
  413. var val = reader.ReadElementContentAsString();
  414. if (!string.IsNullOrWhiteSpace(val))
  415. {
  416. item.IsLocked = string.Equals("true", val, StringComparison.OrdinalIgnoreCase);
  417. }
  418. break;
  419. }
  420. case "studio":
  421. {
  422. var val = reader.ReadElementContentAsString();
  423. if (!string.IsNullOrWhiteSpace(val))
  424. {
  425. item.AddStudio(val);
  426. }
  427. break;
  428. }
  429. case "director":
  430. {
  431. var val = reader.ReadElementContentAsString();
  432. foreach (var p in SplitNames(val).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Director }))
  433. {
  434. if (string.IsNullOrWhiteSpace(p.Name))
  435. {
  436. continue;
  437. }
  438. itemResult.AddPerson(p);
  439. }
  440. break;
  441. }
  442. case "credits":
  443. {
  444. var val = reader.ReadElementContentAsString();
  445. if (!string.IsNullOrWhiteSpace(val))
  446. {
  447. var parts = val.Split('/').Select(i => i.Trim())
  448. .Where(i => !string.IsNullOrEmpty(i));
  449. foreach (var p in parts.Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Writer }))
  450. {
  451. if (string.IsNullOrWhiteSpace(p.Name))
  452. {
  453. continue;
  454. }
  455. itemResult.AddPerson(p);
  456. }
  457. }
  458. break;
  459. }
  460. case "writer":
  461. {
  462. var val = reader.ReadElementContentAsString();
  463. foreach (var p in SplitNames(val).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Writer }))
  464. {
  465. if (string.IsNullOrWhiteSpace(p.Name))
  466. {
  467. continue;
  468. }
  469. itemResult.AddPerson(p);
  470. }
  471. break;
  472. }
  473. case "actor":
  474. {
  475. if (!reader.IsEmptyElement)
  476. {
  477. using (var subtree = reader.ReadSubtree())
  478. {
  479. var person = GetPersonFromXmlNode(subtree);
  480. if (!string.IsNullOrWhiteSpace(person.Name))
  481. {
  482. itemResult.AddPerson(person);
  483. }
  484. }
  485. }
  486. else
  487. {
  488. reader.Read();
  489. }
  490. break;
  491. }
  492. case "trailer":
  493. {
  494. var val = reader.ReadElementContentAsString();
  495. if (!string.IsNullOrWhiteSpace(val))
  496. {
  497. val = val.Replace("plugin://plugin.video.youtube/?action=play_video&videoid=", BaseNfoSaver.YouTubeWatchUrl, StringComparison.OrdinalIgnoreCase);
  498. item.AddTrailerUrl(val);
  499. }
  500. break;
  501. }
  502. case "displayorder":
  503. {
  504. var val = reader.ReadElementContentAsString();
  505. var hasDisplayOrder = item as IHasDisplayOrder;
  506. if (hasDisplayOrder != null)
  507. {
  508. if (!string.IsNullOrWhiteSpace(val))
  509. {
  510. hasDisplayOrder.DisplayOrder = val;
  511. }
  512. }
  513. break;
  514. }
  515. case "year":
  516. {
  517. var val = reader.ReadElementContentAsString();
  518. if (!string.IsNullOrWhiteSpace(val))
  519. {
  520. if (int.TryParse(val, out var productionYear) && productionYear > 1850)
  521. {
  522. item.ProductionYear = productionYear;
  523. }
  524. }
  525. break;
  526. }
  527. case "rating":
  528. {
  529. var rating = reader.ReadElementContentAsString();
  530. if (!string.IsNullOrWhiteSpace(rating))
  531. {
  532. // All external meta is saving this as '.' for decimal I believe...but just to be sure
  533. if (float.TryParse(rating.Replace(',', '.'), NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var val))
  534. {
  535. item.CommunityRating = val;
  536. }
  537. }
  538. break;
  539. }
  540. case "ratings":
  541. {
  542. if (!reader.IsEmptyElement)
  543. {
  544. using var subtree = reader.ReadSubtree();
  545. FetchFromRatingsNode(subtree, item);
  546. }
  547. else
  548. {
  549. reader.Read();
  550. }
  551. break;
  552. }
  553. case "aired":
  554. case "formed":
  555. case "premiered":
  556. case "releasedate":
  557. {
  558. var formatString = nfoConfiguration.ReleaseDateFormat;
  559. var val = reader.ReadElementContentAsString();
  560. if (!string.IsNullOrWhiteSpace(val))
  561. {
  562. if (DateTime.TryParseExact(val, formatString, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var date) && date.Year > 1850)
  563. {
  564. item.PremiereDate = date;
  565. item.ProductionYear = date.Year;
  566. }
  567. }
  568. break;
  569. }
  570. case "enddate":
  571. {
  572. var formatString = nfoConfiguration.ReleaseDateFormat;
  573. var val = reader.ReadElementContentAsString();
  574. if (!string.IsNullOrWhiteSpace(val))
  575. {
  576. if (DateTime.TryParseExact(val, formatString, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var date) && date.Year > 1850)
  577. {
  578. item.EndDate = date;
  579. }
  580. }
  581. break;
  582. }
  583. case "genre":
  584. {
  585. var val = reader.ReadElementContentAsString();
  586. if (!string.IsNullOrWhiteSpace(val))
  587. {
  588. var parts = val.Split('/')
  589. .Select(i => i.Trim())
  590. .Where(i => !string.IsNullOrWhiteSpace(i));
  591. foreach (var p in parts)
  592. {
  593. item.AddGenre(p);
  594. }
  595. }
  596. break;
  597. }
  598. case "style":
  599. case "tag":
  600. {
  601. var val = reader.ReadElementContentAsString();
  602. if (!string.IsNullOrWhiteSpace(val))
  603. {
  604. item.AddTag(val);
  605. }
  606. break;
  607. }
  608. case "fileinfo":
  609. {
  610. if (!reader.IsEmptyElement)
  611. {
  612. using (var subtree = reader.ReadSubtree())
  613. {
  614. FetchFromFileInfoNode(subtree, item);
  615. }
  616. }
  617. else
  618. {
  619. reader.Read();
  620. }
  621. break;
  622. }
  623. case "uniqueid":
  624. {
  625. if (reader.IsEmptyElement)
  626. {
  627. reader.Read();
  628. break;
  629. }
  630. var provider = reader.GetAttribute("type");
  631. var id = reader.ReadElementContentAsString();
  632. if (!string.IsNullOrWhiteSpace(provider) && !string.IsNullOrWhiteSpace(id))
  633. {
  634. item.SetProviderId(provider, id);
  635. }
  636. break;
  637. }
  638. case "thumb":
  639. {
  640. FetchThumbNode(reader, itemResult);
  641. break;
  642. }
  643. case "fanart":
  644. {
  645. var subtree = reader.ReadSubtree();
  646. subtree.ReadToDescendant("thumb");
  647. FetchThumbNode(subtree, itemResult);
  648. break;
  649. }
  650. default:
  651. string readerName = reader.Name;
  652. if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue))
  653. {
  654. var id = reader.ReadElementContentAsString();
  655. if (!string.IsNullOrWhiteSpace(providerIdValue) && !string.IsNullOrWhiteSpace(id))
  656. {
  657. item.SetProviderId(providerIdValue, id);
  658. }
  659. }
  660. else
  661. {
  662. reader.Skip();
  663. }
  664. break;
  665. }
  666. }
  667. private void FetchThumbNode(XmlReader reader, MetadataResult<T> itemResult)
  668. {
  669. var artType = reader.GetAttribute("aspect");
  670. var val = reader.ReadElementContentAsString();
  671. // artType is null if the thumb node is a child of the fanart tag
  672. // -> set image type to fanart
  673. if (string.IsNullOrWhiteSpace(artType))
  674. {
  675. artType = "fanart";
  676. }
  677. // skip:
  678. // - empty uri
  679. // - tag containing '.' because we can't set images for seasons, episodes or movie sets within series or movies
  680. if (string.IsNullOrEmpty(val) || artType.Contains('.', StringComparison.Ordinal))
  681. {
  682. return;
  683. }
  684. ImageType imageType = GetImageType(artType);
  685. if (!Uri.TryCreate(val, UriKind.Absolute, out var uri))
  686. {
  687. Logger.LogError("Image location {Path} specified in nfo file for {ItemName} is not a valid URL or file path.", val, itemResult.Item.Name);
  688. return;
  689. }
  690. if (uri.IsFile)
  691. {
  692. // only allow one item of each type
  693. if (itemResult.Images.Any(x => x.Type == imageType))
  694. {
  695. return;
  696. }
  697. var fileSystemMetadata = _directoryService.GetFile(val);
  698. // non existing file returns null
  699. if (fileSystemMetadata == null || !fileSystemMetadata.Exists)
  700. {
  701. Logger.LogWarning("Artwork file {Path} specified in nfo file for {ItemName} does not exist.", uri, itemResult.Item.Name);
  702. return;
  703. }
  704. itemResult.Images.Add(new LocalImageInfo()
  705. {
  706. FileInfo = fileSystemMetadata,
  707. Type = imageType
  708. });
  709. }
  710. else
  711. {
  712. // only allow one item of each type
  713. if (itemResult.RemoteImages.Any(x => x.type == imageType))
  714. {
  715. return;
  716. }
  717. itemResult.RemoteImages.Add((uri.ToString(), imageType));
  718. }
  719. }
  720. private void FetchFromFileInfoNode(XmlReader reader, T item)
  721. {
  722. reader.MoveToContent();
  723. reader.Read();
  724. // Loop through each element
  725. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  726. {
  727. if (reader.NodeType == XmlNodeType.Element)
  728. {
  729. switch (reader.Name)
  730. {
  731. case "streamdetails":
  732. {
  733. if (reader.IsEmptyElement)
  734. {
  735. reader.Read();
  736. continue;
  737. }
  738. using (var subtree = reader.ReadSubtree())
  739. {
  740. FetchFromStreamDetailsNode(subtree, item);
  741. }
  742. break;
  743. }
  744. default:
  745. reader.Skip();
  746. break;
  747. }
  748. }
  749. else
  750. {
  751. reader.Read();
  752. }
  753. }
  754. }
  755. private void FetchFromStreamDetailsNode(XmlReader reader, T item)
  756. {
  757. reader.MoveToContent();
  758. reader.Read();
  759. // Loop through each element
  760. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  761. {
  762. if (reader.NodeType == XmlNodeType.Element)
  763. {
  764. switch (reader.Name)
  765. {
  766. case "video":
  767. {
  768. if (reader.IsEmptyElement)
  769. {
  770. reader.Read();
  771. continue;
  772. }
  773. using (var subtree = reader.ReadSubtree())
  774. {
  775. FetchFromVideoNode(subtree, item);
  776. }
  777. break;
  778. }
  779. case "subtitle":
  780. {
  781. if (reader.IsEmptyElement)
  782. {
  783. reader.Read();
  784. continue;
  785. }
  786. using (var subtree = reader.ReadSubtree())
  787. {
  788. FetchFromSubtitleNode(subtree, item);
  789. }
  790. break;
  791. }
  792. default:
  793. reader.Skip();
  794. break;
  795. }
  796. }
  797. else
  798. {
  799. reader.Read();
  800. }
  801. }
  802. }
  803. private void FetchFromVideoNode(XmlReader reader, T item)
  804. {
  805. reader.MoveToContent();
  806. reader.Read();
  807. // Loop through each element
  808. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  809. {
  810. if (reader.NodeType == XmlNodeType.Element)
  811. {
  812. switch (reader.Name)
  813. {
  814. case "format3d":
  815. {
  816. var val = reader.ReadElementContentAsString();
  817. var video = item as Video;
  818. if (video != null)
  819. {
  820. if (string.Equals("HSBS", val, StringComparison.OrdinalIgnoreCase))
  821. {
  822. video.Video3DFormat = Video3DFormat.HalfSideBySide;
  823. }
  824. else if (string.Equals("HTAB", val, StringComparison.OrdinalIgnoreCase))
  825. {
  826. video.Video3DFormat = Video3DFormat.HalfTopAndBottom;
  827. }
  828. else if (string.Equals("FTAB", val, StringComparison.OrdinalIgnoreCase))
  829. {
  830. video.Video3DFormat = Video3DFormat.FullTopAndBottom;
  831. }
  832. else if (string.Equals("FSBS", val, StringComparison.OrdinalIgnoreCase))
  833. {
  834. video.Video3DFormat = Video3DFormat.FullSideBySide;
  835. }
  836. else if (string.Equals("MVC", val, StringComparison.OrdinalIgnoreCase))
  837. {
  838. video.Video3DFormat = Video3DFormat.MVC;
  839. }
  840. }
  841. break;
  842. }
  843. case "aspect":
  844. {
  845. var val = reader.ReadElementContentAsString();
  846. if (item is Video video)
  847. {
  848. video.AspectRatio = val;
  849. }
  850. break;
  851. }
  852. case "width":
  853. {
  854. var val = reader.ReadElementContentAsInt();
  855. if (item is Video video)
  856. {
  857. video.Width = val;
  858. }
  859. break;
  860. }
  861. case "height":
  862. {
  863. var val = reader.ReadElementContentAsInt();
  864. if (item is Video video)
  865. {
  866. video.Height = val;
  867. }
  868. break;
  869. }
  870. case "durationinseconds":
  871. {
  872. var val = reader.ReadElementContentAsInt();
  873. if (item is Video video)
  874. {
  875. video.RunTimeTicks = new TimeSpan(0, 0, val).Ticks;
  876. }
  877. break;
  878. }
  879. default:
  880. reader.Skip();
  881. break;
  882. }
  883. }
  884. else
  885. {
  886. reader.Read();
  887. }
  888. }
  889. }
  890. private void FetchFromSubtitleNode(XmlReader reader, T item)
  891. {
  892. reader.MoveToContent();
  893. reader.Read();
  894. // Loop through each element
  895. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  896. {
  897. if (reader.NodeType == XmlNodeType.Element)
  898. {
  899. switch (reader.Name)
  900. {
  901. case "language":
  902. {
  903. _ = reader.ReadElementContentAsString();
  904. if (item is Video video)
  905. {
  906. video.HasSubtitles = true;
  907. }
  908. break;
  909. }
  910. default:
  911. reader.Skip();
  912. break;
  913. }
  914. }
  915. else
  916. {
  917. reader.Read();
  918. }
  919. }
  920. }
  921. private void FetchFromRatingsNode(XmlReader reader, T item)
  922. {
  923. reader.MoveToContent();
  924. reader.Read();
  925. // Loop through each element
  926. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  927. {
  928. if (reader.NodeType == XmlNodeType.Element)
  929. {
  930. switch (reader.Name)
  931. {
  932. case "rating":
  933. {
  934. if (reader.IsEmptyElement)
  935. {
  936. reader.Read();
  937. continue;
  938. }
  939. var ratingName = reader.GetAttribute("name");
  940. using var subtree = reader.ReadSubtree();
  941. FetchFromRatingNode(subtree, item, ratingName);
  942. break;
  943. }
  944. default:
  945. reader.Skip();
  946. break;
  947. }
  948. }
  949. else
  950. {
  951. reader.Read();
  952. }
  953. }
  954. }
  955. private void FetchFromRatingNode(XmlReader reader, T item, string? ratingName)
  956. {
  957. reader.MoveToContent();
  958. reader.Read();
  959. // Loop through each element
  960. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  961. {
  962. if (reader.NodeType == XmlNodeType.Element)
  963. {
  964. switch (reader.Name)
  965. {
  966. case "value":
  967. var val = reader.ReadElementContentAsString();
  968. if (!string.IsNullOrWhiteSpace(val))
  969. {
  970. if (float.TryParse(val, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var ratingValue))
  971. {
  972. // if ratingName contains tomato --> assume critic rating
  973. if (ratingName != null &&
  974. ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase) &&
  975. !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase))
  976. {
  977. item.CriticRating = ratingValue;
  978. }
  979. else
  980. {
  981. item.CommunityRating = ratingValue;
  982. }
  983. }
  984. }
  985. break;
  986. default:
  987. reader.Skip();
  988. break;
  989. }
  990. }
  991. else
  992. {
  993. reader.Read();
  994. }
  995. }
  996. }
  997. /// <summary>
  998. /// Gets the persons from XML node.
  999. /// </summary>
  1000. /// <param name="reader">The reader.</param>
  1001. /// <returns>IEnumerable{PersonInfo}.</returns>
  1002. private PersonInfo GetPersonFromXmlNode(XmlReader reader)
  1003. {
  1004. var name = string.Empty;
  1005. var type = PersonType.Actor; // If type is not specified assume actor
  1006. var role = string.Empty;
  1007. int? sortOrder = null;
  1008. string? imageUrl = null;
  1009. reader.MoveToContent();
  1010. reader.Read();
  1011. // Loop through each element
  1012. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  1013. {
  1014. if (reader.NodeType == XmlNodeType.Element)
  1015. {
  1016. switch (reader.Name)
  1017. {
  1018. case "name":
  1019. name = reader.ReadElementContentAsString();
  1020. break;
  1021. case "role":
  1022. {
  1023. var val = reader.ReadElementContentAsString();
  1024. if (!string.IsNullOrWhiteSpace(val))
  1025. {
  1026. role = val;
  1027. }
  1028. break;
  1029. }
  1030. case "type":
  1031. {
  1032. var val = reader.ReadElementContentAsString();
  1033. if (!string.IsNullOrWhiteSpace(val))
  1034. {
  1035. type = val switch
  1036. {
  1037. PersonType.Composer => PersonType.Composer,
  1038. PersonType.Conductor => PersonType.Conductor,
  1039. PersonType.Director => PersonType.Director,
  1040. PersonType.Lyricist => PersonType.Lyricist,
  1041. PersonType.Producer => PersonType.Producer,
  1042. PersonType.Writer => PersonType.Writer,
  1043. PersonType.GuestStar => PersonType.GuestStar,
  1044. // unknown type --> actor
  1045. _ => PersonType.Actor
  1046. };
  1047. }
  1048. break;
  1049. }
  1050. case "order":
  1051. case "sortorder":
  1052. {
  1053. var val = reader.ReadElementContentAsString();
  1054. if (!string.IsNullOrWhiteSpace(val))
  1055. {
  1056. if (int.TryParse(val, NumberStyles.Integer, UsCulture, out var intVal))
  1057. {
  1058. sortOrder = intVal;
  1059. }
  1060. }
  1061. break;
  1062. }
  1063. case "thumb":
  1064. {
  1065. var val = reader.ReadElementContentAsString();
  1066. if (!string.IsNullOrWhiteSpace(val))
  1067. {
  1068. imageUrl = val;
  1069. }
  1070. break;
  1071. }
  1072. default:
  1073. reader.Skip();
  1074. break;
  1075. }
  1076. }
  1077. else
  1078. {
  1079. reader.Read();
  1080. }
  1081. }
  1082. return new PersonInfo
  1083. {
  1084. Name = name.Trim(),
  1085. Role = role,
  1086. Type = type,
  1087. SortOrder = sortOrder,
  1088. ImageUrl = imageUrl
  1089. };
  1090. }
  1091. internal XmlReaderSettings GetXmlReaderSettings()
  1092. => new XmlReaderSettings()
  1093. {
  1094. ValidationType = ValidationType.None,
  1095. CheckCharacters = false,
  1096. IgnoreProcessingInstructions = true,
  1097. IgnoreComments = true
  1098. };
  1099. /// <summary>
  1100. /// Used to split names of comma or pipe delimeted genres and people.
  1101. /// </summary>
  1102. /// <param name="value">The value.</param>
  1103. /// <returns>IEnumerable{System.String}.</returns>
  1104. private IEnumerable<string> SplitNames(string value)
  1105. {
  1106. // Only split by comma if there is no pipe in the string
  1107. // We have to be careful to not split names like Matthew, Jr.
  1108. var separator = !value.Contains('|', StringComparison.Ordinal) && !value.Contains(';', StringComparison.Ordinal)
  1109. ? new[] { ',' }
  1110. : new[] { '|', ';' };
  1111. value = value.Trim().Trim(separator);
  1112. return string.IsNullOrWhiteSpace(value) ? Array.Empty<string>() : value.Split(separator, StringSplitOptions.RemoveEmptyEntries);
  1113. }
  1114. /// <summary>
  1115. /// Parses the ImageType from the nfo aspect property.
  1116. /// </summary>
  1117. /// <param name="aspect">The nfo aspect property.</param>
  1118. /// <returns>The image type.</returns>
  1119. private static ImageType GetImageType(string aspect)
  1120. {
  1121. return aspect switch
  1122. {
  1123. "banner" => ImageType.Banner,
  1124. "clearlogo" => ImageType.Logo,
  1125. "discart" => ImageType.Disc,
  1126. "landscape" => ImageType.Thumb,
  1127. "clearart" => ImageType.Art,
  1128. "fanart" => ImageType.Backdrop,
  1129. // unknown type (including "poster") --> primary
  1130. _ => ImageType.Primary,
  1131. };
  1132. }
  1133. }
  1134. }