BaseItemXmlParser.cs 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297
  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 MediaBrowser.Controller.Entities;
  10. using MediaBrowser.Controller.Providers;
  11. using MediaBrowser.Model.Entities;
  12. using Microsoft.Extensions.Logging;
  13. namespace MediaBrowser.LocalMetadata.Parsers
  14. {
  15. /// <summary>
  16. /// Provides a base class for parsing metadata xml.
  17. /// </summary>
  18. /// <typeparam name="T">Type of item xml parser.</typeparam>
  19. public class BaseItemXmlParser<T>
  20. where T : BaseItem
  21. {
  22. private readonly CultureInfo _usCulture = new CultureInfo("en-US");
  23. private Dictionary<string, string>? _validProviderIds;
  24. /// <summary>
  25. /// Initializes a new instance of the <see cref="BaseItemXmlParser{T}" /> class.
  26. /// </summary>
  27. /// <param name="logger">Instance of the <see cref="ILogger{BaseItemXmlParser}"/> interface.</param>
  28. /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
  29. public BaseItemXmlParser(ILogger<BaseItemXmlParser<T>> logger, IProviderManager providerManager)
  30. {
  31. Logger = logger;
  32. ProviderManager = providerManager;
  33. }
  34. /// <summary>
  35. /// Gets the logger.
  36. /// </summary>
  37. protected ILogger<BaseItemXmlParser<T>> Logger { get; private set; }
  38. /// <summary>
  39. /// Gets the provider manager.
  40. /// </summary>
  41. protected IProviderManager ProviderManager { get; private set; }
  42. /// <summary>
  43. /// Fetches metadata for an item from one xml file.
  44. /// </summary>
  45. /// <param name="item">The item.</param>
  46. /// <param name="metadataFile">The metadata file.</param>
  47. /// <param name="cancellationToken">The cancellation token.</param>
  48. /// <exception cref="ArgumentNullException">Item is null.</exception>
  49. public void Fetch(MetadataResult<T> item, string metadataFile, CancellationToken cancellationToken)
  50. {
  51. if (item == null)
  52. {
  53. throw new ArgumentNullException(nameof(item));
  54. }
  55. if (string.IsNullOrEmpty(metadataFile))
  56. {
  57. throw new ArgumentException("The metadata file was empty or null.", nameof(metadataFile));
  58. }
  59. var settings = new XmlReaderSettings
  60. {
  61. ValidationType = ValidationType.None,
  62. CheckCharacters = false,
  63. IgnoreProcessingInstructions = true,
  64. IgnoreComments = true
  65. };
  66. _validProviderIds = _validProviderIds = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
  67. var idInfos = ProviderManager.GetExternalIdInfos(item.Item);
  68. foreach (var info in idInfos)
  69. {
  70. var id = info.Key + "Id";
  71. if (!_validProviderIds.ContainsKey(id))
  72. {
  73. _validProviderIds.Add(id, info.Key!);
  74. }
  75. }
  76. // Additional Mappings
  77. _validProviderIds.Add("IMDB", "Imdb");
  78. // Fetch(item, metadataFile, settings, Encoding.GetEncoding("ISO-8859-1"), cancellationToken);
  79. Fetch(item, metadataFile, settings, Encoding.UTF8, cancellationToken);
  80. }
  81. /// <summary>
  82. /// Fetches the specified item.
  83. /// </summary>
  84. /// <param name="item">The item.</param>
  85. /// <param name="metadataFile">The metadata file.</param>
  86. /// <param name="settings">The settings.</param>
  87. /// <param name="encoding">The encoding.</param>
  88. /// <param name="cancellationToken">The cancellation token.</param>
  89. private void Fetch(MetadataResult<T> item, string metadataFile, XmlReaderSettings settings, Encoding encoding, CancellationToken cancellationToken)
  90. {
  91. item.ResetPeople();
  92. using var fileStream = File.OpenRead(metadataFile);
  93. using var streamReader = new StreamReader(fileStream, encoding);
  94. using var reader = XmlReader.Create(streamReader, settings);
  95. reader.MoveToContent();
  96. reader.Read();
  97. // Loop through each element
  98. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  99. {
  100. cancellationToken.ThrowIfCancellationRequested();
  101. if (reader.NodeType == XmlNodeType.Element)
  102. {
  103. FetchDataFromXmlNode(reader, item);
  104. }
  105. else
  106. {
  107. reader.Read();
  108. }
  109. }
  110. }
  111. /// <summary>
  112. /// Fetches metadata from one Xml Element.
  113. /// </summary>
  114. /// <param name="reader">The reader.</param>
  115. /// <param name="itemResult">The item result.</param>
  116. protected virtual void FetchDataFromXmlNode(XmlReader reader, MetadataResult<T> itemResult)
  117. {
  118. var item = itemResult.Item;
  119. switch (reader.Name)
  120. {
  121. // DateCreated
  122. case "Added":
  123. {
  124. var val = reader.ReadElementContentAsString();
  125. if (!string.IsNullOrWhiteSpace(val))
  126. {
  127. if (DateTime.TryParse(val, out var added))
  128. {
  129. item.DateCreated = added.ToUniversalTime();
  130. }
  131. else
  132. {
  133. Logger.LogWarning("Invalid Added value found: " + val);
  134. }
  135. }
  136. break;
  137. }
  138. case "OriginalTitle":
  139. {
  140. var val = reader.ReadElementContentAsString();
  141. if (!string.IsNullOrEmpty(val))
  142. {
  143. item.OriginalTitle = val;
  144. }
  145. break;
  146. }
  147. case "LocalTitle":
  148. item.Name = reader.ReadElementContentAsString();
  149. break;
  150. case "CriticRating":
  151. {
  152. var text = reader.ReadElementContentAsString();
  153. if (!string.IsNullOrEmpty(text))
  154. {
  155. if (float.TryParse(text, NumberStyles.Any, _usCulture, out var value))
  156. {
  157. item.CriticRating = value;
  158. }
  159. }
  160. break;
  161. }
  162. case "SortTitle":
  163. {
  164. var val = reader.ReadElementContentAsString();
  165. if (!string.IsNullOrWhiteSpace(val))
  166. {
  167. item.ForcedSortName = val;
  168. }
  169. break;
  170. }
  171. case "Overview":
  172. case "Description":
  173. {
  174. var val = reader.ReadElementContentAsString();
  175. if (!string.IsNullOrWhiteSpace(val))
  176. {
  177. item.Overview = val;
  178. }
  179. break;
  180. }
  181. case "Language":
  182. {
  183. var val = reader.ReadElementContentAsString();
  184. item.PreferredMetadataLanguage = val;
  185. break;
  186. }
  187. case "CountryCode":
  188. {
  189. var val = reader.ReadElementContentAsString();
  190. item.PreferredMetadataCountryCode = val;
  191. break;
  192. }
  193. case "PlaceOfBirth":
  194. {
  195. var val = reader.ReadElementContentAsString();
  196. if (!string.IsNullOrWhiteSpace(val))
  197. {
  198. if (item is Person person)
  199. {
  200. person.ProductionLocations = new[] { val };
  201. }
  202. }
  203. break;
  204. }
  205. case "LockedFields":
  206. {
  207. var val = reader.ReadElementContentAsString();
  208. if (!string.IsNullOrWhiteSpace(val))
  209. {
  210. item.LockedFields = val.Split('|').Select(i =>
  211. {
  212. if (Enum.TryParse(i, true, out MetadataField field))
  213. {
  214. return (MetadataField?)field;
  215. }
  216. return null;
  217. }).Where(i => i.HasValue).Select(i => i!.Value).ToArray();
  218. }
  219. break;
  220. }
  221. case "TagLines":
  222. {
  223. if (!reader.IsEmptyElement)
  224. {
  225. using (var subtree = reader.ReadSubtree())
  226. {
  227. FetchFromTaglinesNode(subtree, item);
  228. }
  229. }
  230. else
  231. {
  232. reader.Read();
  233. }
  234. break;
  235. }
  236. case "Countries":
  237. {
  238. if (!reader.IsEmptyElement)
  239. {
  240. using (var subtree = reader.ReadSubtree())
  241. {
  242. FetchFromCountriesNode(subtree);
  243. }
  244. }
  245. else
  246. {
  247. reader.Read();
  248. }
  249. break;
  250. }
  251. case "ContentRating":
  252. case "MPAARating":
  253. {
  254. var rating = reader.ReadElementContentAsString();
  255. if (!string.IsNullOrWhiteSpace(rating))
  256. {
  257. item.OfficialRating = rating;
  258. }
  259. break;
  260. }
  261. case "CustomRating":
  262. {
  263. var val = reader.ReadElementContentAsString();
  264. if (!string.IsNullOrWhiteSpace(val))
  265. {
  266. item.CustomRating = val;
  267. }
  268. break;
  269. }
  270. case "RunningTime":
  271. {
  272. var text = reader.ReadElementContentAsString();
  273. if (!string.IsNullOrWhiteSpace(text))
  274. {
  275. if (int.TryParse(text.Split(' ')[0], NumberStyles.Integer, _usCulture, out var runtime))
  276. {
  277. item.RunTimeTicks = TimeSpan.FromMinutes(runtime).Ticks;
  278. }
  279. }
  280. break;
  281. }
  282. case "AspectRatio":
  283. {
  284. var val = reader.ReadElementContentAsString();
  285. if (!string.IsNullOrWhiteSpace(val) && item is IHasAspectRatio hasAspectRatio)
  286. {
  287. hasAspectRatio.AspectRatio = val;
  288. }
  289. break;
  290. }
  291. case "LockData":
  292. {
  293. var val = reader.ReadElementContentAsString();
  294. if (!string.IsNullOrWhiteSpace(val))
  295. {
  296. item.IsLocked = string.Equals("true", val, StringComparison.OrdinalIgnoreCase);
  297. }
  298. break;
  299. }
  300. case "Network":
  301. {
  302. foreach (var name in SplitNames(reader.ReadElementContentAsString()))
  303. {
  304. if (string.IsNullOrWhiteSpace(name))
  305. {
  306. continue;
  307. }
  308. item.AddStudio(name);
  309. }
  310. break;
  311. }
  312. case "Director":
  313. {
  314. foreach (var p in SplitNames(reader.ReadElementContentAsString()).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Director }))
  315. {
  316. if (string.IsNullOrWhiteSpace(p.Name))
  317. {
  318. continue;
  319. }
  320. itemResult.AddPerson(p);
  321. }
  322. break;
  323. }
  324. case "Writer":
  325. {
  326. foreach (var p in SplitNames(reader.ReadElementContentAsString()).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Writer }))
  327. {
  328. if (string.IsNullOrWhiteSpace(p.Name))
  329. {
  330. continue;
  331. }
  332. itemResult.AddPerson(p);
  333. }
  334. break;
  335. }
  336. case "Actors":
  337. {
  338. var actors = reader.ReadInnerXml();
  339. if (actors.Contains("<", StringComparison.Ordinal))
  340. {
  341. // This is one of the mis-named "Actors" full nodes created by MB2
  342. // Create a reader and pass it to the persons node processor
  343. using var xmlReader = XmlReader.Create(new StringReader($"<Persons>{actors}</Persons>"));
  344. FetchDataFromPersonsNode(xmlReader, itemResult);
  345. }
  346. else
  347. {
  348. // Old-style piped string
  349. foreach (var p in SplitNames(actors).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.Actor }))
  350. {
  351. if (string.IsNullOrWhiteSpace(p.Name))
  352. {
  353. continue;
  354. }
  355. itemResult.AddPerson(p);
  356. }
  357. }
  358. break;
  359. }
  360. case "GuestStars":
  361. {
  362. foreach (var p in SplitNames(reader.ReadElementContentAsString()).Select(v => new PersonInfo { Name = v.Trim(), Type = PersonType.GuestStar }))
  363. {
  364. if (string.IsNullOrWhiteSpace(p.Name))
  365. {
  366. continue;
  367. }
  368. itemResult.AddPerson(p);
  369. }
  370. break;
  371. }
  372. case "Trailer":
  373. {
  374. var val = reader.ReadElementContentAsString();
  375. if (!string.IsNullOrWhiteSpace(val))
  376. {
  377. item.AddTrailerUrl(val);
  378. }
  379. break;
  380. }
  381. case "DisplayOrder":
  382. {
  383. var val = reader.ReadElementContentAsString();
  384. if (item is IHasDisplayOrder hasDisplayOrder)
  385. {
  386. if (!string.IsNullOrWhiteSpace(val))
  387. {
  388. hasDisplayOrder.DisplayOrder = val;
  389. }
  390. }
  391. break;
  392. }
  393. case "Trailers":
  394. {
  395. if (!reader.IsEmptyElement)
  396. {
  397. using var subtree = reader.ReadSubtree();
  398. FetchDataFromTrailersNode(subtree, item);
  399. }
  400. else
  401. {
  402. reader.Read();
  403. }
  404. break;
  405. }
  406. case "ProductionYear":
  407. {
  408. var val = reader.ReadElementContentAsString();
  409. if (!string.IsNullOrWhiteSpace(val))
  410. {
  411. if (int.TryParse(val, out var productionYear) && productionYear > 1850)
  412. {
  413. item.ProductionYear = productionYear;
  414. }
  415. }
  416. break;
  417. }
  418. case "Rating":
  419. case "IMDBrating":
  420. {
  421. var rating = reader.ReadElementContentAsString();
  422. if (!string.IsNullOrWhiteSpace(rating))
  423. {
  424. // All external meta is saving this as '.' for decimal I believe...but just to be sure
  425. if (float.TryParse(rating.Replace(',', '.'), NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var val))
  426. {
  427. item.CommunityRating = val;
  428. }
  429. }
  430. break;
  431. }
  432. case "BirthDate":
  433. case "PremiereDate":
  434. case "FirstAired":
  435. {
  436. var firstAired = reader.ReadElementContentAsString();
  437. if (!string.IsNullOrWhiteSpace(firstAired))
  438. {
  439. if (DateTime.TryParseExact(firstAired, "yyyy-MM-dd", CultureInfo.InvariantCulture, DateTimeStyles.AssumeLocal, out var airDate) && airDate.Year > 1850)
  440. {
  441. item.PremiereDate = airDate.ToUniversalTime();
  442. item.ProductionYear = airDate.Year;
  443. }
  444. }
  445. break;
  446. }
  447. case "DeathDate":
  448. case "EndDate":
  449. {
  450. var firstAired = reader.ReadElementContentAsString();
  451. if (!string.IsNullOrWhiteSpace(firstAired))
  452. {
  453. if (DateTime.TryParseExact(firstAired, "yyyy-MM-dd", CultureInfo.InvariantCulture, DateTimeStyles.AssumeLocal, out var airDate) && airDate.Year > 1850)
  454. {
  455. item.EndDate = airDate.ToUniversalTime();
  456. }
  457. }
  458. break;
  459. }
  460. case "CollectionNumber":
  461. var tmdbCollection = reader.ReadElementContentAsString();
  462. if (!string.IsNullOrWhiteSpace(tmdbCollection))
  463. {
  464. item.SetProviderId(MetadataProvider.TmdbCollection, tmdbCollection);
  465. }
  466. break;
  467. case "Genres":
  468. {
  469. if (!reader.IsEmptyElement)
  470. {
  471. using var subtree = reader.ReadSubtree();
  472. FetchFromGenresNode(subtree, item);
  473. }
  474. else
  475. {
  476. reader.Read();
  477. }
  478. break;
  479. }
  480. case "Tags":
  481. {
  482. if (!reader.IsEmptyElement)
  483. {
  484. using var subtree = reader.ReadSubtree();
  485. FetchFromTagsNode(subtree, item);
  486. }
  487. else
  488. {
  489. reader.Read();
  490. }
  491. break;
  492. }
  493. case "Persons":
  494. {
  495. if (!reader.IsEmptyElement)
  496. {
  497. using var subtree = reader.ReadSubtree();
  498. FetchDataFromPersonsNode(subtree, itemResult);
  499. }
  500. else
  501. {
  502. reader.Read();
  503. }
  504. break;
  505. }
  506. case "Studios":
  507. {
  508. if (!reader.IsEmptyElement)
  509. {
  510. using var subtree = reader.ReadSubtree();
  511. FetchFromStudiosNode(subtree, item);
  512. }
  513. else
  514. {
  515. reader.Read();
  516. }
  517. break;
  518. }
  519. case "Shares":
  520. {
  521. if (!reader.IsEmptyElement)
  522. {
  523. using var subtree = reader.ReadSubtree();
  524. if (item is IHasShares hasShares)
  525. {
  526. FetchFromSharesNode(subtree, hasShares);
  527. }
  528. }
  529. else
  530. {
  531. reader.Read();
  532. }
  533. break;
  534. }
  535. case "Format3D":
  536. {
  537. var val = reader.ReadElementContentAsString();
  538. if (item is Video video)
  539. {
  540. if (string.Equals("HSBS", val, StringComparison.OrdinalIgnoreCase))
  541. {
  542. video.Video3DFormat = Video3DFormat.HalfSideBySide;
  543. }
  544. else if (string.Equals("HTAB", val, StringComparison.OrdinalIgnoreCase))
  545. {
  546. video.Video3DFormat = Video3DFormat.HalfTopAndBottom;
  547. }
  548. else if (string.Equals("FTAB", val, StringComparison.OrdinalIgnoreCase))
  549. {
  550. video.Video3DFormat = Video3DFormat.FullTopAndBottom;
  551. }
  552. else if (string.Equals("FSBS", val, StringComparison.OrdinalIgnoreCase))
  553. {
  554. video.Video3DFormat = Video3DFormat.FullSideBySide;
  555. }
  556. else if (string.Equals("MVC", val, StringComparison.OrdinalIgnoreCase))
  557. {
  558. video.Video3DFormat = Video3DFormat.MVC;
  559. }
  560. }
  561. break;
  562. }
  563. default:
  564. {
  565. string readerName = reader.Name;
  566. if (_validProviderIds!.TryGetValue(readerName, out string? providerIdValue))
  567. {
  568. var id = reader.ReadElementContentAsString();
  569. if (!string.IsNullOrWhiteSpace(id))
  570. {
  571. item.SetProviderId(providerIdValue, id);
  572. }
  573. }
  574. else
  575. {
  576. reader.Skip();
  577. }
  578. break;
  579. }
  580. }
  581. }
  582. private void FetchFromSharesNode(XmlReader reader, IHasShares item)
  583. {
  584. var list = new List<Share>();
  585. reader.MoveToContent();
  586. reader.Read();
  587. // Loop through each element
  588. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  589. {
  590. if (reader.NodeType == XmlNodeType.Element)
  591. {
  592. switch (reader.Name)
  593. {
  594. case "Share":
  595. {
  596. if (reader.IsEmptyElement)
  597. {
  598. reader.Read();
  599. continue;
  600. }
  601. using (var subReader = reader.ReadSubtree())
  602. {
  603. var child = GetShare(subReader);
  604. if (child != null)
  605. {
  606. list.Add(child);
  607. }
  608. }
  609. break;
  610. }
  611. default:
  612. {
  613. reader.Skip();
  614. break;
  615. }
  616. }
  617. }
  618. else
  619. {
  620. reader.Read();
  621. }
  622. }
  623. item.Shares = list.ToArray();
  624. }
  625. private Share GetShareFromNode(XmlReader reader)
  626. {
  627. var share = new Share();
  628. reader.MoveToContent();
  629. reader.Read();
  630. // Loop through each element
  631. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  632. {
  633. if (reader.NodeType == XmlNodeType.Element)
  634. {
  635. switch (reader.Name)
  636. {
  637. case "UserId":
  638. {
  639. share.UserId = reader.ReadElementContentAsString();
  640. break;
  641. }
  642. case "CanEdit":
  643. {
  644. share.CanEdit = string.Equals(reader.ReadElementContentAsString(), true.ToString(CultureInfo.InvariantCulture), StringComparison.OrdinalIgnoreCase);
  645. break;
  646. }
  647. default:
  648. reader.Skip();
  649. break;
  650. }
  651. }
  652. else
  653. {
  654. reader.Read();
  655. }
  656. }
  657. return share;
  658. }
  659. private void FetchFromCountriesNode(XmlReader reader)
  660. {
  661. reader.MoveToContent();
  662. reader.Read();
  663. // Loop through each element
  664. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  665. {
  666. if (reader.NodeType == XmlNodeType.Element)
  667. {
  668. switch (reader.Name)
  669. {
  670. case "Country":
  671. {
  672. var val = reader.ReadElementContentAsString();
  673. if (!string.IsNullOrWhiteSpace(val))
  674. {
  675. }
  676. break;
  677. }
  678. default:
  679. reader.Skip();
  680. break;
  681. }
  682. }
  683. else
  684. {
  685. reader.Read();
  686. }
  687. }
  688. }
  689. /// <summary>
  690. /// Fetches from taglines node.
  691. /// </summary>
  692. /// <param name="reader">The reader.</param>
  693. /// <param name="item">The item.</param>
  694. private void FetchFromTaglinesNode(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 "Tagline":
  706. {
  707. var val = reader.ReadElementContentAsString();
  708. if (!string.IsNullOrWhiteSpace(val))
  709. {
  710. item.Tagline = val;
  711. }
  712. break;
  713. }
  714. default:
  715. reader.Skip();
  716. break;
  717. }
  718. }
  719. else
  720. {
  721. reader.Read();
  722. }
  723. }
  724. }
  725. /// <summary>
  726. /// Fetches from genres node.
  727. /// </summary>
  728. /// <param name="reader">The reader.</param>
  729. /// <param name="item">The item.</param>
  730. private void FetchFromGenresNode(XmlReader reader, T item)
  731. {
  732. reader.MoveToContent();
  733. reader.Read();
  734. // Loop through each element
  735. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  736. {
  737. if (reader.NodeType == XmlNodeType.Element)
  738. {
  739. switch (reader.Name)
  740. {
  741. case "Genre":
  742. {
  743. var genre = reader.ReadElementContentAsString();
  744. if (!string.IsNullOrWhiteSpace(genre))
  745. {
  746. item.AddGenre(genre);
  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 FetchFromTagsNode(XmlReader reader, BaseItem item)
  762. {
  763. reader.MoveToContent();
  764. reader.Read();
  765. var tags = new List<string>();
  766. // Loop through each element
  767. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  768. {
  769. if (reader.NodeType == XmlNodeType.Element)
  770. {
  771. switch (reader.Name)
  772. {
  773. case "Tag":
  774. {
  775. var tag = reader.ReadElementContentAsString();
  776. if (!string.IsNullOrWhiteSpace(tag))
  777. {
  778. tags.Add(tag);
  779. }
  780. break;
  781. }
  782. default:
  783. reader.Skip();
  784. break;
  785. }
  786. }
  787. else
  788. {
  789. reader.Read();
  790. }
  791. }
  792. item.Tags = tags.Distinct(StringComparer.Ordinal).ToArray();
  793. }
  794. /// <summary>
  795. /// Fetches the data from persons node.
  796. /// </summary>
  797. /// <param name="reader">The reader.</param>
  798. /// <param name="item">The item.</param>
  799. private void FetchDataFromPersonsNode(XmlReader reader, MetadataResult<T> item)
  800. {
  801. reader.MoveToContent();
  802. reader.Read();
  803. // Loop through each element
  804. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  805. {
  806. if (reader.NodeType == XmlNodeType.Element)
  807. {
  808. switch (reader.Name)
  809. {
  810. case "Person":
  811. case "Actor":
  812. {
  813. if (reader.IsEmptyElement)
  814. {
  815. reader.Read();
  816. continue;
  817. }
  818. using (var subtree = reader.ReadSubtree())
  819. {
  820. foreach (var person in GetPersonsFromXmlNode(subtree))
  821. {
  822. if (string.IsNullOrWhiteSpace(person.Name))
  823. {
  824. continue;
  825. }
  826. item.AddPerson(person);
  827. }
  828. }
  829. break;
  830. }
  831. default:
  832. reader.Skip();
  833. break;
  834. }
  835. }
  836. else
  837. {
  838. reader.Read();
  839. }
  840. }
  841. }
  842. private void FetchDataFromTrailersNode(XmlReader reader, T item)
  843. {
  844. reader.MoveToContent();
  845. reader.Read();
  846. // Loop through each element
  847. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  848. {
  849. if (reader.NodeType == XmlNodeType.Element)
  850. {
  851. switch (reader.Name)
  852. {
  853. case "Trailer":
  854. {
  855. var val = reader.ReadElementContentAsString();
  856. if (!string.IsNullOrWhiteSpace(val))
  857. {
  858. item.AddTrailerUrl(val);
  859. }
  860. break;
  861. }
  862. default:
  863. reader.Skip();
  864. break;
  865. }
  866. }
  867. else
  868. {
  869. reader.Read();
  870. }
  871. }
  872. }
  873. /// <summary>
  874. /// Fetches from studios node.
  875. /// </summary>
  876. /// <param name="reader">The reader.</param>
  877. /// <param name="item">The item.</param>
  878. private void FetchFromStudiosNode(XmlReader reader, T item)
  879. {
  880. reader.MoveToContent();
  881. reader.Read();
  882. // Loop through each element
  883. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  884. {
  885. if (reader.NodeType == XmlNodeType.Element)
  886. {
  887. switch (reader.Name)
  888. {
  889. case "Studio":
  890. {
  891. var studio = reader.ReadElementContentAsString();
  892. if (!string.IsNullOrWhiteSpace(studio))
  893. {
  894. item.AddStudio(studio);
  895. }
  896. break;
  897. }
  898. default:
  899. reader.Skip();
  900. break;
  901. }
  902. }
  903. else
  904. {
  905. reader.Read();
  906. }
  907. }
  908. }
  909. /// <summary>
  910. /// Gets the persons from XML node.
  911. /// </summary>
  912. /// <param name="reader">The reader.</param>
  913. /// <returns>IEnumerable{PersonInfo}.</returns>
  914. private IEnumerable<PersonInfo> GetPersonsFromXmlNode(XmlReader reader)
  915. {
  916. var name = string.Empty;
  917. var type = PersonType.Actor; // If type is not specified assume actor
  918. var role = string.Empty;
  919. int? sortOrder = null;
  920. reader.MoveToContent();
  921. reader.Read();
  922. // Loop through each element
  923. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  924. {
  925. if (reader.NodeType == XmlNodeType.Element)
  926. {
  927. switch (reader.Name)
  928. {
  929. case "Name":
  930. name = reader.ReadElementContentAsString() ?? string.Empty;
  931. break;
  932. case "Type":
  933. {
  934. var val = reader.ReadElementContentAsString();
  935. if (!string.IsNullOrWhiteSpace(val))
  936. {
  937. type = val;
  938. }
  939. break;
  940. }
  941. case "Role":
  942. {
  943. var val = reader.ReadElementContentAsString();
  944. if (!string.IsNullOrWhiteSpace(val))
  945. {
  946. role = val;
  947. }
  948. break;
  949. }
  950. case "SortOrder":
  951. {
  952. var val = reader.ReadElementContentAsString();
  953. if (!string.IsNullOrWhiteSpace(val))
  954. {
  955. if (int.TryParse(val, NumberStyles.Integer, _usCulture, out var intVal))
  956. {
  957. sortOrder = intVal;
  958. }
  959. }
  960. break;
  961. }
  962. default:
  963. reader.Skip();
  964. break;
  965. }
  966. }
  967. else
  968. {
  969. reader.Read();
  970. }
  971. }
  972. var personInfo = new PersonInfo { Name = name.Trim(), Role = role, Type = type, SortOrder = sortOrder };
  973. return new[] { personInfo };
  974. }
  975. /// <summary>
  976. /// Get linked child.
  977. /// </summary>
  978. /// <param name="reader">The xml reader.</param>
  979. /// <returns>The linked child.</returns>
  980. protected LinkedChild? GetLinkedChild(XmlReader reader)
  981. {
  982. var linkedItem = new LinkedChild { Type = LinkedChildType.Manual };
  983. reader.MoveToContent();
  984. reader.Read();
  985. // Loop through each element
  986. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  987. {
  988. if (reader.NodeType == XmlNodeType.Element)
  989. {
  990. switch (reader.Name)
  991. {
  992. case "Path":
  993. {
  994. linkedItem.Path = reader.ReadElementContentAsString();
  995. break;
  996. }
  997. case "ItemId":
  998. {
  999. linkedItem.LibraryItemId = reader.ReadElementContentAsString();
  1000. break;
  1001. }
  1002. default:
  1003. reader.Skip();
  1004. break;
  1005. }
  1006. }
  1007. else
  1008. {
  1009. reader.Read();
  1010. }
  1011. }
  1012. // This is valid
  1013. if (!string.IsNullOrWhiteSpace(linkedItem.Path) || !string.IsNullOrWhiteSpace(linkedItem.LibraryItemId))
  1014. {
  1015. return linkedItem;
  1016. }
  1017. return null;
  1018. }
  1019. /// <summary>
  1020. /// Get share.
  1021. /// </summary>
  1022. /// <param name="reader">The xml reader.</param>
  1023. /// <returns>The share.</returns>
  1024. protected Share? GetShare(XmlReader reader)
  1025. {
  1026. var item = new Share();
  1027. reader.MoveToContent();
  1028. reader.Read();
  1029. // Loop through each element
  1030. while (!reader.EOF && reader.ReadState == ReadState.Interactive)
  1031. {
  1032. if (reader.NodeType == XmlNodeType.Element)
  1033. {
  1034. switch (reader.Name)
  1035. {
  1036. case "UserId":
  1037. {
  1038. item.UserId = reader.ReadElementContentAsString();
  1039. break;
  1040. }
  1041. case "CanEdit":
  1042. {
  1043. item.CanEdit = string.Equals(reader.ReadElementContentAsString(), "true", StringComparison.OrdinalIgnoreCase);
  1044. break;
  1045. }
  1046. default:
  1047. {
  1048. reader.Skip();
  1049. break;
  1050. }
  1051. }
  1052. }
  1053. else
  1054. {
  1055. reader.Read();
  1056. }
  1057. }
  1058. // This is valid
  1059. if (!string.IsNullOrWhiteSpace(item.UserId))
  1060. {
  1061. return item;
  1062. }
  1063. return null;
  1064. }
  1065. /// <summary>
  1066. /// Used to split names of comma or pipe delimited genres and people.
  1067. /// </summary>
  1068. /// <param name="value">The value.</param>
  1069. /// <returns>IEnumerable{System.String}.</returns>
  1070. private IEnumerable<string> SplitNames(string value)
  1071. {
  1072. value ??= string.Empty;
  1073. // Only split by comma if there is no pipe in the string
  1074. // We have to be careful to not split names like Matthew, Jr.
  1075. var separator = !value.Contains('|', StringComparison.Ordinal)
  1076. && !value.Contains(';', StringComparison.Ordinal) ? new[] { ',' } : new[] { '|', ';' };
  1077. value = value.Trim().Trim(separator);
  1078. return string.IsNullOrWhiteSpace(value) ? Array.Empty<string>() : Split(value, separator, StringSplitOptions.RemoveEmptyEntries);
  1079. }
  1080. /// <summary>
  1081. /// Provides an additional overload for string.split.
  1082. /// </summary>
  1083. /// <param name="val">The val.</param>
  1084. /// <param name="separators">The separators.</param>
  1085. /// <param name="options">The options.</param>
  1086. /// <returns>System.String[][].</returns>
  1087. private string[] Split(string val, char[] separators, StringSplitOptions options)
  1088. {
  1089. return val.Split(separators, options);
  1090. }
  1091. }
  1092. }