BaseNfoParser.cs 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355
  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. var subtree = reader.ReadSubtree();
  645. subtree.ReadToDescendant("thumb");
  646. FetchThumbNode(subtree, itemResult);
  647. break;
  648. }
  649. default:
  650. string readerName = reader.Name;
  651. if (_validProviderIds.TryGetValue(readerName, out string? providerIdValue))
  652. {
  653. var id = reader.ReadElementContentAsString();
  654. if (!string.IsNullOrWhiteSpace(providerIdValue) && !string.IsNullOrWhiteSpace(id))
  655. {
  656. item.SetProviderId(providerIdValue, id);
  657. }
  658. }
  659. else
  660. {
  661. reader.Skip();
  662. }
  663. break;
  664. }
  665. }
  666. private void FetchThumbNode(XmlReader reader, MetadataResult<T> itemResult)
  667. {
  668. var artType = reader.GetAttribute("aspect");
  669. var val = reader.ReadElementContentAsString();
  670. // artType is null if the thumb node is a child of the fanart tag
  671. // -> set image type to fanart
  672. if (string.IsNullOrWhiteSpace(artType))
  673. {
  674. artType = "fanart";
  675. }
  676. // skip:
  677. // - empty uri
  678. // - tag containing '.' because we can't set images for seasons, episodes or movie sets within series or movies
  679. if (string.IsNullOrEmpty(val) || artType.Contains('.', StringComparison.Ordinal))
  680. {
  681. return;
  682. }
  683. ImageType imageType = GetImageType(artType);
  684. if (!Uri.TryCreate(val, UriKind.Absolute, out var uri))
  685. {
  686. Logger.LogError("Image location {Path} specified in nfo file for {ItemName} is not a valid URL or file path.", val, itemResult.Item.Name);
  687. return;
  688. }
  689. if (uri.IsFile)
  690. {
  691. // only allow one item of each type
  692. if (itemResult.Images.Any(x => x.Type == imageType))
  693. {
  694. return;
  695. }
  696. var fileSystemMetadata = _directoryService.GetFile(val);
  697. // non existing file returns null
  698. if (fileSystemMetadata == null || !fileSystemMetadata.Exists)
  699. {
  700. Logger.LogWarning("Artwork file {Path} specified in nfo file for {ItemName} does not exist.", uri, itemResult.Item.Name);
  701. return;
  702. }
  703. itemResult.Images.Add(new LocalImageInfo()
  704. {
  705. FileInfo = fileSystemMetadata,
  706. Type = imageType
  707. });
  708. }
  709. else
  710. {
  711. // only allow one item of each type
  712. if (itemResult.RemoteImages.Any(x => x.type == imageType))
  713. {
  714. return;
  715. }
  716. itemResult.RemoteImages.Add((uri.ToString(), imageType));
  717. }
  718. }
  719. private void FetchFromFileInfoNode(XmlReader reader, T item)
  720. {
  721. reader.MoveToContent();
  722. reader.Read();
  723. // Loop through each element
  724. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  725. {
  726. if (reader.NodeType == XmlNodeType.Element)
  727. {
  728. switch (reader.Name)
  729. {
  730. case "streamdetails":
  731. {
  732. if (reader.IsEmptyElement)
  733. {
  734. reader.Read();
  735. continue;
  736. }
  737. using (var subtree = reader.ReadSubtree())
  738. {
  739. FetchFromStreamDetailsNode(subtree, item);
  740. }
  741. break;
  742. }
  743. default:
  744. reader.Skip();
  745. break;
  746. }
  747. }
  748. else
  749. {
  750. reader.Read();
  751. }
  752. }
  753. }
  754. private void FetchFromStreamDetailsNode(XmlReader reader, T item)
  755. {
  756. reader.MoveToContent();
  757. reader.Read();
  758. // Loop through each element
  759. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  760. {
  761. if (reader.NodeType == XmlNodeType.Element)
  762. {
  763. switch (reader.Name)
  764. {
  765. case "video":
  766. {
  767. if (reader.IsEmptyElement)
  768. {
  769. reader.Read();
  770. continue;
  771. }
  772. using (var subtree = reader.ReadSubtree())
  773. {
  774. FetchFromVideoNode(subtree, item);
  775. }
  776. break;
  777. }
  778. case "subtitle":
  779. {
  780. if (reader.IsEmptyElement)
  781. {
  782. reader.Read();
  783. continue;
  784. }
  785. using (var subtree = reader.ReadSubtree())
  786. {
  787. FetchFromSubtitleNode(subtree, item);
  788. }
  789. break;
  790. }
  791. default:
  792. reader.Skip();
  793. break;
  794. }
  795. }
  796. else
  797. {
  798. reader.Read();
  799. }
  800. }
  801. }
  802. private void FetchFromVideoNode(XmlReader reader, T item)
  803. {
  804. reader.MoveToContent();
  805. reader.Read();
  806. // Loop through each element
  807. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  808. {
  809. if (reader.NodeType == XmlNodeType.Element)
  810. {
  811. switch (reader.Name)
  812. {
  813. case "format3d":
  814. {
  815. var val = reader.ReadElementContentAsString();
  816. var video = item as Video;
  817. if (video != null)
  818. {
  819. if (string.Equals("HSBS", val, StringComparison.OrdinalIgnoreCase))
  820. {
  821. video.Video3DFormat = Video3DFormat.HalfSideBySide;
  822. }
  823. else if (string.Equals("HTAB", val, StringComparison.OrdinalIgnoreCase))
  824. {
  825. video.Video3DFormat = Video3DFormat.HalfTopAndBottom;
  826. }
  827. else if (string.Equals("FTAB", val, StringComparison.OrdinalIgnoreCase))
  828. {
  829. video.Video3DFormat = Video3DFormat.FullTopAndBottom;
  830. }
  831. else if (string.Equals("FSBS", val, StringComparison.OrdinalIgnoreCase))
  832. {
  833. video.Video3DFormat = Video3DFormat.FullSideBySide;
  834. }
  835. else if (string.Equals("MVC", val, StringComparison.OrdinalIgnoreCase))
  836. {
  837. video.Video3DFormat = Video3DFormat.MVC;
  838. }
  839. }
  840. break;
  841. }
  842. case "aspect":
  843. {
  844. var val = reader.ReadElementContentAsString();
  845. if (item is Video video)
  846. {
  847. video.AspectRatio = val;
  848. }
  849. break;
  850. }
  851. case "width":
  852. {
  853. var val = reader.ReadElementContentAsInt();
  854. if (item is Video video)
  855. {
  856. video.Width = val;
  857. }
  858. break;
  859. }
  860. case "height":
  861. {
  862. var val = reader.ReadElementContentAsInt();
  863. if (item is Video video)
  864. {
  865. video.Height = val;
  866. }
  867. break;
  868. }
  869. case "durationinseconds":
  870. {
  871. var val = reader.ReadElementContentAsInt();
  872. if (item is Video video)
  873. {
  874. video.RunTimeTicks = new TimeSpan(0, 0, val).Ticks;
  875. }
  876. break;
  877. }
  878. default:
  879. reader.Skip();
  880. break;
  881. }
  882. }
  883. else
  884. {
  885. reader.Read();
  886. }
  887. }
  888. }
  889. private void FetchFromSubtitleNode(XmlReader reader, T item)
  890. {
  891. reader.MoveToContent();
  892. reader.Read();
  893. // Loop through each element
  894. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  895. {
  896. if (reader.NodeType == XmlNodeType.Element)
  897. {
  898. switch (reader.Name)
  899. {
  900. case "language":
  901. {
  902. _ = reader.ReadElementContentAsString();
  903. if (item is Video video)
  904. {
  905. video.HasSubtitles = true;
  906. }
  907. break;
  908. }
  909. default:
  910. reader.Skip();
  911. break;
  912. }
  913. }
  914. else
  915. {
  916. reader.Read();
  917. }
  918. }
  919. }
  920. private void FetchFromRatingsNode(XmlReader reader, T item)
  921. {
  922. reader.MoveToContent();
  923. reader.Read();
  924. // Loop through each element
  925. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  926. {
  927. if (reader.NodeType == XmlNodeType.Element)
  928. {
  929. switch (reader.Name)
  930. {
  931. case "rating":
  932. {
  933. if (reader.IsEmptyElement)
  934. {
  935. reader.Read();
  936. continue;
  937. }
  938. var ratingName = reader.GetAttribute("name");
  939. using var subtree = reader.ReadSubtree();
  940. FetchFromRatingNode(subtree, item, ratingName);
  941. break;
  942. }
  943. default:
  944. reader.Skip();
  945. break;
  946. }
  947. }
  948. else
  949. {
  950. reader.Read();
  951. }
  952. }
  953. }
  954. private void FetchFromRatingNode(XmlReader reader, T item, string? ratingName)
  955. {
  956. reader.MoveToContent();
  957. reader.Read();
  958. // Loop through each element
  959. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  960. {
  961. if (reader.NodeType == XmlNodeType.Element)
  962. {
  963. switch (reader.Name)
  964. {
  965. case "value":
  966. var val = reader.ReadElementContentAsString();
  967. if (!string.IsNullOrWhiteSpace(val))
  968. {
  969. if (float.TryParse(val, NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var ratingValue))
  970. {
  971. // if ratingName contains tomato --> assume critic rating
  972. if (ratingName != null &&
  973. ratingName.Contains("tomato", StringComparison.OrdinalIgnoreCase) &&
  974. !ratingName.Contains("audience", StringComparison.OrdinalIgnoreCase))
  975. {
  976. item.CriticRating = ratingValue;
  977. }
  978. else
  979. {
  980. item.CommunityRating = ratingValue;
  981. }
  982. }
  983. }
  984. break;
  985. default:
  986. reader.Skip();
  987. break;
  988. }
  989. }
  990. else
  991. {
  992. reader.Read();
  993. }
  994. }
  995. }
  996. /// <summary>
  997. /// Gets the persons from XML node.
  998. /// </summary>
  999. /// <param name="reader">The reader.</param>
  1000. /// <returns>IEnumerable{PersonInfo}.</returns>
  1001. private PersonInfo GetPersonFromXmlNode(XmlReader reader)
  1002. {
  1003. var name = string.Empty;
  1004. var type = PersonType.Actor; // If type is not specified assume actor
  1005. var role = string.Empty;
  1006. int? sortOrder = null;
  1007. string? imageUrl = null;
  1008. reader.MoveToContent();
  1009. reader.Read();
  1010. // Loop through each element
  1011. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  1012. {
  1013. if (reader.NodeType == XmlNodeType.Element)
  1014. {
  1015. switch (reader.Name)
  1016. {
  1017. case "name":
  1018. name = reader.ReadElementContentAsString();
  1019. break;
  1020. case "role":
  1021. {
  1022. var val = reader.ReadElementContentAsString();
  1023. if (!string.IsNullOrWhiteSpace(val))
  1024. {
  1025. role = val;
  1026. }
  1027. break;
  1028. }
  1029. case "type":
  1030. {
  1031. var val = reader.ReadElementContentAsString();
  1032. if (!string.IsNullOrWhiteSpace(val))
  1033. {
  1034. type = val switch
  1035. {
  1036. PersonType.Composer => PersonType.Composer,
  1037. PersonType.Conductor => PersonType.Conductor,
  1038. PersonType.Director => PersonType.Director,
  1039. PersonType.Lyricist => PersonType.Lyricist,
  1040. PersonType.Producer => PersonType.Producer,
  1041. PersonType.Writer => PersonType.Writer,
  1042. PersonType.GuestStar => PersonType.GuestStar,
  1043. // unknown type --> actor
  1044. _ => PersonType.Actor
  1045. };
  1046. }
  1047. break;
  1048. }
  1049. case "order":
  1050. case "sortorder":
  1051. {
  1052. var val = reader.ReadElementContentAsString();
  1053. if (!string.IsNullOrWhiteSpace(val))
  1054. {
  1055. if (int.TryParse(val, NumberStyles.Integer, CultureInfo.InvariantCulture, out var intVal))
  1056. {
  1057. sortOrder = intVal;
  1058. }
  1059. }
  1060. break;
  1061. }
  1062. case "thumb":
  1063. {
  1064. var val = reader.ReadElementContentAsString();
  1065. if (!string.IsNullOrWhiteSpace(val))
  1066. {
  1067. imageUrl = val;
  1068. }
  1069. break;
  1070. }
  1071. default:
  1072. reader.Skip();
  1073. break;
  1074. }
  1075. }
  1076. else
  1077. {
  1078. reader.Read();
  1079. }
  1080. }
  1081. return new PersonInfo
  1082. {
  1083. Name = name.Trim(),
  1084. Role = role,
  1085. Type = type,
  1086. SortOrder = sortOrder,
  1087. ImageUrl = imageUrl
  1088. };
  1089. }
  1090. internal XmlReaderSettings GetXmlReaderSettings()
  1091. => new XmlReaderSettings()
  1092. {
  1093. ValidationType = ValidationType.None,
  1094. CheckCharacters = false,
  1095. IgnoreProcessingInstructions = true,
  1096. IgnoreComments = true
  1097. };
  1098. /// <summary>
  1099. /// Used to split names of comma or pipe delimeted genres and people.
  1100. /// </summary>
  1101. /// <param name="value">The value.</param>
  1102. /// <returns>IEnumerable{System.String}.</returns>
  1103. private IEnumerable<string> SplitNames(string value)
  1104. {
  1105. // Only split by comma if there is no pipe in the string
  1106. // We have to be careful to not split names like Matthew, Jr.
  1107. var separator = !value.Contains('|', StringComparison.Ordinal) && !value.Contains(';', StringComparison.Ordinal)
  1108. ? new[] { ',' }
  1109. : new[] { '|', ';' };
  1110. value = value.Trim().Trim(separator);
  1111. return string.IsNullOrWhiteSpace(value) ? Array.Empty<string>() : value.Split(separator, StringSplitOptions.RemoveEmptyEntries);
  1112. }
  1113. /// <summary>
  1114. /// Parses the ImageType from the nfo aspect property.
  1115. /// </summary>
  1116. /// <param name="aspect">The nfo aspect property.</param>
  1117. /// <returns>The image type.</returns>
  1118. private static ImageType GetImageType(string aspect)
  1119. {
  1120. return aspect switch
  1121. {
  1122. "banner" => ImageType.Banner,
  1123. "clearlogo" => ImageType.Logo,
  1124. "discart" => ImageType.Disc,
  1125. "landscape" => ImageType.Thumb,
  1126. "clearart" => ImageType.Art,
  1127. "fanart" => ImageType.Backdrop,
  1128. // unknown type (including "poster") --> primary
  1129. _ => ImageType.Primary,
  1130. };
  1131. }
  1132. }
  1133. }