BaseItemXmlParser.cs 46 KB

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