BaseNfoParser.cs 48 KB

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