BaseNfoParser.cs 47 KB

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