BaseNfoParser.cs 48 KB

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