BaseNfoParser.cs 45 KB

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