BaseNfoParser.cs 44 KB

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