BaseNfoSaver.cs 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Controller.Configuration;
  3. using MediaBrowser.Controller.Entities;
  4. using MediaBrowser.Controller.Entities.Audio;
  5. using MediaBrowser.Controller.Entities.Movies;
  6. using MediaBrowser.Controller.Entities.TV;
  7. using MediaBrowser.Controller.Library;
  8. using MediaBrowser.Controller.Persistence;
  9. using MediaBrowser.Model.Configuration;
  10. using MediaBrowser.Model.Entities;
  11. using MediaBrowser.Model.Logging;
  12. using MediaBrowser.XbmcMetadata.Configuration;
  13. using System;
  14. using System.Collections.Generic;
  15. using System.Globalization;
  16. using System.IO;
  17. using System.Linq;
  18. using System.Text;
  19. using System.Threading;
  20. using System.Xml;
  21. using CommonIO;
  22. using MediaBrowser.Model.Extensions;
  23. namespace MediaBrowser.XbmcMetadata.Savers
  24. {
  25. public abstract class BaseNfoSaver : IMetadataFileSaver
  26. {
  27. private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
  28. private static readonly Dictionary<string, string> CommonTags = new[] {
  29. "plot",
  30. "customrating",
  31. "lockdata",
  32. "type",
  33. "dateadded",
  34. "title",
  35. "rating",
  36. "year",
  37. "sorttitle",
  38. "mpaa",
  39. "mpaadescription",
  40. "aspectratio",
  41. "website",
  42. "collectionnumber",
  43. "tmdbid",
  44. "rottentomatoesid",
  45. "language",
  46. "tvcomid",
  47. "budget",
  48. "revenue",
  49. "tagline",
  50. "studio",
  51. "genre",
  52. "tag",
  53. "runtime",
  54. "actor",
  55. "criticratingsummary",
  56. "criticrating",
  57. "fileinfo",
  58. "director",
  59. "writer",
  60. "trailer",
  61. "premiered",
  62. "releasedate",
  63. "outline",
  64. "id",
  65. "votes",
  66. "credits",
  67. "originaltitle",
  68. "watched",
  69. "playcount",
  70. "lastplayed",
  71. "art",
  72. "resume",
  73. "biography",
  74. "formed",
  75. "review",
  76. "style",
  77. "imdbid",
  78. "imdb_id",
  79. "plotkeyword",
  80. "country",
  81. "audiodbalbumid",
  82. "audiodbartistid",
  83. "awardsummary",
  84. "enddate",
  85. "lockedfields",
  86. "metascore",
  87. "zap2itid",
  88. "tvrageid",
  89. "gamesdbid",
  90. "musicbrainzartistid",
  91. "musicbrainzalbumartistid",
  92. "musicbrainzalbumid",
  93. "musicbrainzreleasegroupid",
  94. "tvdbid",
  95. "collectionitem",
  96. "isuserfavorite",
  97. "userrating"
  98. }.ToDictionary(i => i, StringComparer.OrdinalIgnoreCase);
  99. protected BaseNfoSaver(IFileSystem fileSystem, IServerConfigurationManager configurationManager, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataManager, ILogger logger)
  100. {
  101. Logger = logger;
  102. UserDataManager = userDataManager;
  103. UserManager = userManager;
  104. LibraryManager = libraryManager;
  105. ConfigurationManager = configurationManager;
  106. FileSystem = fileSystem;
  107. }
  108. protected IFileSystem FileSystem { get; private set; }
  109. protected IServerConfigurationManager ConfigurationManager { get; private set; }
  110. protected ILibraryManager LibraryManager { get; private set; }
  111. protected IUserManager UserManager { get; private set; }
  112. protected IUserDataManager UserDataManager { get; private set; }
  113. protected ILogger Logger { get; private set; }
  114. protected ItemUpdateType MinimumUpdateType
  115. {
  116. get
  117. {
  118. if (ConfigurationManager.GetNfoConfiguration().SaveImagePathsInNfo)
  119. {
  120. return ItemUpdateType.ImageUpdate;
  121. }
  122. return ItemUpdateType.MetadataDownload;
  123. }
  124. }
  125. public string Name
  126. {
  127. get
  128. {
  129. return SaverName;
  130. }
  131. }
  132. public static string SaverName
  133. {
  134. get
  135. {
  136. return "Nfo";
  137. }
  138. }
  139. public string GetSavePath(IHasMetadata item)
  140. {
  141. return GetLocalSavePath(item);
  142. }
  143. /// <summary>
  144. /// Gets the save path.
  145. /// </summary>
  146. /// <param name="item">The item.</param>
  147. /// <returns>System.String.</returns>
  148. protected abstract string GetLocalSavePath(IHasMetadata item);
  149. /// <summary>
  150. /// Gets the name of the root element.
  151. /// </summary>
  152. /// <param name="item">The item.</param>
  153. /// <returns>System.String.</returns>
  154. protected abstract string GetRootElementName(IHasMetadata item);
  155. /// <summary>
  156. /// Determines whether [is enabled for] [the specified item].
  157. /// </summary>
  158. /// <param name="item">The item.</param>
  159. /// <param name="updateType">Type of the update.</param>
  160. /// <returns><c>true</c> if [is enabled for] [the specified item]; otherwise, <c>false</c>.</returns>
  161. public abstract bool IsEnabledFor(IHasMetadata item, ItemUpdateType updateType);
  162. protected virtual List<string> GetTagsUsed()
  163. {
  164. return new List<string>();
  165. }
  166. public void Save(IHasMetadata item, CancellationToken cancellationToken)
  167. {
  168. var path = GetSavePath(item);
  169. using (var memoryStream = new MemoryStream())
  170. {
  171. Save(item, memoryStream, path);
  172. memoryStream.Position = 0;
  173. cancellationToken.ThrowIfCancellationRequested();
  174. SaveToFile(memoryStream, path);
  175. }
  176. }
  177. private void SaveToFile(Stream stream, string path)
  178. {
  179. FileSystem.CreateDirectory(Path.GetDirectoryName(path));
  180. var file = new FileInfo(path);
  181. var wasHidden = false;
  182. // This will fail if the file is hidden
  183. if (file.Exists)
  184. {
  185. if ((file.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden)
  186. {
  187. file.Attributes &= ~FileAttributes.Hidden;
  188. wasHidden = true;
  189. }
  190. }
  191. using (var filestream = FileSystem.GetFileStream(path, FileMode.Create, FileAccess.Write, FileShare.Read))
  192. {
  193. stream.CopyTo(filestream);
  194. }
  195. if (wasHidden || ConfigurationManager.Configuration.SaveMetadataHidden)
  196. {
  197. file.Refresh();
  198. // Add back the attribute
  199. file.Attributes |= FileAttributes.Hidden;
  200. }
  201. }
  202. private void Save(IHasMetadata item, Stream stream, string xmlPath)
  203. {
  204. var settings = new XmlWriterSettings
  205. {
  206. Indent = true,
  207. Encoding = Encoding.UTF8,
  208. CloseOutput = false
  209. };
  210. using (XmlWriter writer = XmlWriter.Create(stream, settings))
  211. {
  212. var root = GetRootElementName(item);
  213. writer.WriteStartDocument(true);
  214. writer.WriteStartElement(root);
  215. var baseItem = item as BaseItem;
  216. if (baseItem != null)
  217. {
  218. AddCommonNodes(baseItem, writer, LibraryManager, UserManager, UserDataManager, FileSystem, ConfigurationManager);
  219. }
  220. WriteCustomElements(item, writer);
  221. var hasMediaSources = baseItem as IHasMediaSources;
  222. if (hasMediaSources != null)
  223. {
  224. AddMediaInfo(hasMediaSources, writer);
  225. }
  226. var tagsUsed = GetTagsUsed();
  227. try
  228. {
  229. AddCustomTags(xmlPath, tagsUsed, writer, Logger);
  230. }
  231. catch (FileNotFoundException)
  232. {
  233. }
  234. catch (DirectoryNotFoundException)
  235. {
  236. }
  237. catch (XmlException ex)
  238. {
  239. Logger.ErrorException("Error reading existng nfo", ex);
  240. }
  241. writer.WriteEndElement();
  242. writer.WriteEndDocument();
  243. }
  244. }
  245. protected abstract void WriteCustomElements(IHasMetadata item, XmlWriter writer);
  246. public static void AddMediaInfo<T>(T item, XmlWriter writer)
  247. where T : IHasMediaSources
  248. {
  249. writer.WriteStartElement("fileinfo");
  250. writer.WriteStartElement("streamdetails");
  251. var mediaSource = item.GetMediaSources(false).First();
  252. foreach (var stream in mediaSource.MediaStreams)
  253. {
  254. writer.WriteStartElement(stream.Type.ToString().ToLower());
  255. if (!string.IsNullOrEmpty(stream.Codec))
  256. {
  257. var codec = stream.Codec;
  258. if ((stream.CodecTag ?? string.Empty).IndexOf("xvid", StringComparison.OrdinalIgnoreCase) != -1)
  259. {
  260. codec = "xvid;";
  261. }
  262. else if ((stream.CodecTag ?? string.Empty).IndexOf("divx", StringComparison.OrdinalIgnoreCase) != -1)
  263. {
  264. codec = "divx;";
  265. }
  266. writer.WriteElementString("codec", codec);
  267. writer.WriteElementString("micodec", codec);
  268. }
  269. if (stream.BitRate.HasValue)
  270. {
  271. writer.WriteElementString("bitrate", stream.BitRate.Value.ToString(UsCulture));
  272. }
  273. if (stream.Width.HasValue)
  274. {
  275. writer.WriteElementString("width", stream.Width.Value.ToString(UsCulture));
  276. }
  277. if (stream.Height.HasValue)
  278. {
  279. writer.WriteElementString("height", stream.Height.Value.ToString(UsCulture));
  280. }
  281. if (!string.IsNullOrEmpty(stream.AspectRatio))
  282. {
  283. writer.WriteElementString("aspect", stream.AspectRatio);
  284. writer.WriteElementString("aspectratio", stream.AspectRatio);
  285. }
  286. var framerate = stream.AverageFrameRate ?? stream.RealFrameRate;
  287. if (framerate.HasValue)
  288. {
  289. writer.WriteElementString("framerate", framerate.Value.ToString(UsCulture));
  290. }
  291. if (!string.IsNullOrEmpty(stream.Language))
  292. {
  293. writer.WriteElementString("language", stream.Language);
  294. }
  295. var scanType = stream.IsInterlaced ? "interlaced" : "progressive";
  296. if (!string.IsNullOrEmpty(scanType))
  297. {
  298. writer.WriteElementString("scantype", scanType);
  299. }
  300. if (stream.Channels.HasValue)
  301. {
  302. writer.WriteElementString("channels", stream.Channels.Value.ToString(UsCulture));
  303. }
  304. if (stream.SampleRate.HasValue)
  305. {
  306. writer.WriteElementString("samplingrate", stream.SampleRate.Value.ToString(UsCulture));
  307. }
  308. writer.WriteElementString("default", stream.IsDefault.ToString());
  309. writer.WriteElementString("forced", stream.IsForced.ToString());
  310. if (stream.Type == MediaStreamType.Video)
  311. {
  312. if (mediaSource.RunTimeTicks.HasValue)
  313. {
  314. var timespan = TimeSpan.FromTicks(mediaSource.RunTimeTicks.Value);
  315. writer.WriteElementString("duration", Convert.ToInt32(timespan.TotalMinutes).ToString(UsCulture));
  316. writer.WriteElementString("durationinseconds", Convert.ToInt32(timespan.TotalSeconds).ToString(UsCulture));
  317. }
  318. var video = item as Video;
  319. if (video != null)
  320. {
  321. //AddChapters(video, builder, itemRepository);
  322. if (video.Video3DFormat.HasValue)
  323. {
  324. switch (video.Video3DFormat.Value)
  325. {
  326. case Video3DFormat.FullSideBySide:
  327. writer.WriteElementString("format3d", "FSBS");
  328. break;
  329. case Video3DFormat.FullTopAndBottom:
  330. writer.WriteElementString("format3d", "FTAB");
  331. break;
  332. case Video3DFormat.HalfSideBySide:
  333. writer.WriteElementString("format3d", "HSBS");
  334. break;
  335. case Video3DFormat.HalfTopAndBottom:
  336. writer.WriteElementString("format3d", "HTAB");
  337. break;
  338. case Video3DFormat.MVC:
  339. writer.WriteElementString("format3d", "MVC");
  340. break;
  341. }
  342. }
  343. }
  344. }
  345. writer.WriteEndElement();
  346. }
  347. writer.WriteEndElement();
  348. writer.WriteEndElement();
  349. }
  350. public const string DateAddedFormat = "yyyy-MM-dd HH:mm:ss";
  351. /// <summary>
  352. /// Adds the common nodes.
  353. /// </summary>
  354. /// <returns>Task.</returns>
  355. public static void AddCommonNodes(BaseItem item, XmlWriter writer, ILibraryManager libraryManager, IUserManager userManager, IUserDataManager userDataRepo, IFileSystem fileSystem, IServerConfigurationManager config)
  356. {
  357. var overview = (item.Overview ?? string.Empty)
  358. .StripHtml()
  359. .Replace("&quot;", "'");
  360. var options = config.GetNfoConfiguration();
  361. if (item is MusicArtist)
  362. {
  363. writer.WriteElementString("biography", overview);
  364. }
  365. else if (item is MusicAlbum)
  366. {
  367. writer.WriteElementString("review", overview);
  368. }
  369. else
  370. {
  371. writer.WriteElementString("plot", overview);
  372. }
  373. var hasShortOverview = item as IHasShortOverview;
  374. if (hasShortOverview != null)
  375. {
  376. var outline = (hasShortOverview.ShortOverview ?? string.Empty)
  377. .StripHtml()
  378. .Replace("&quot;", "'");
  379. writer.WriteElementString("outline", outline);
  380. }
  381. else
  382. {
  383. writer.WriteElementString("outline", overview);
  384. }
  385. if (!string.IsNullOrWhiteSpace(item.CustomRating))
  386. {
  387. writer.WriteElementString("customrating", item.CustomRating);
  388. }
  389. writer.WriteElementString("lockdata", item.IsLocked.ToString().ToLower());
  390. if (item.LockedFields.Count > 0)
  391. {
  392. writer.WriteElementString("lockedfields", string.Join("|", item.LockedFields.Select(i => i.ToString()).ToArray()));
  393. }
  394. if (!string.IsNullOrEmpty(item.DisplayMediaType))
  395. {
  396. writer.WriteElementString("type", item.DisplayMediaType);
  397. }
  398. writer.WriteElementString("dateadded", item.DateCreated.ToLocalTime().ToString(DateAddedFormat));
  399. writer.WriteElementString("title", item.Name ?? string.Empty);
  400. var hasOriginalTitle = item as IHasOriginalTitle;
  401. if (hasOriginalTitle != null)
  402. {
  403. if (!string.IsNullOrEmpty(hasOriginalTitle.OriginalTitle))
  404. {
  405. writer.WriteElementString("originaltitle", hasOriginalTitle.OriginalTitle ?? string.Empty);
  406. }
  407. }
  408. var people = libraryManager.GetPeople(item);
  409. var directors = people
  410. .Where(i => IsPersonType(i, PersonType.Director))
  411. .Select(i => i.Name)
  412. .ToList();
  413. foreach (var person in directors)
  414. {
  415. writer.WriteElementString("director", person);
  416. }
  417. var writers = people
  418. .Where(i => IsPersonType(i, PersonType.Writer))
  419. .Select(i => i.Name)
  420. .Distinct(StringComparer.OrdinalIgnoreCase)
  421. .ToList();
  422. foreach (var person in writers)
  423. {
  424. writer.WriteElementString("writer", person);
  425. }
  426. foreach (var person in writers)
  427. {
  428. writer.WriteElementString("credits", person);
  429. }
  430. var hasTrailer = item as IHasTrailers;
  431. if (hasTrailer != null)
  432. {
  433. foreach (var trailer in hasTrailer.RemoteTrailers)
  434. {
  435. writer.WriteElementString("trailer", GetOutputTrailerUrl(trailer.Url));
  436. }
  437. }
  438. if (item.CommunityRating.HasValue)
  439. {
  440. writer.WriteElementString("rating", item.CommunityRating.Value.ToString(UsCulture));
  441. }
  442. if (item.ProductionYear.HasValue)
  443. {
  444. writer.WriteElementString("year", item.ProductionYear.Value.ToString(UsCulture));
  445. }
  446. if (!string.IsNullOrEmpty(item.ForcedSortName))
  447. {
  448. writer.WriteElementString("sorttitle", item.ForcedSortName);
  449. }
  450. if (!string.IsNullOrEmpty(item.OfficialRating))
  451. {
  452. writer.WriteElementString("mpaa", item.OfficialRating);
  453. }
  454. if (!string.IsNullOrEmpty(item.OfficialRatingDescription))
  455. {
  456. writer.WriteElementString("mpaadescription", item.OfficialRatingDescription);
  457. }
  458. var hasAspectRatio = item as IHasAspectRatio;
  459. if (hasAspectRatio != null)
  460. {
  461. if (!string.IsNullOrEmpty(hasAspectRatio.AspectRatio))
  462. {
  463. writer.WriteElementString("aspectratio", hasAspectRatio.AspectRatio);
  464. }
  465. }
  466. if (!string.IsNullOrEmpty(item.HomePageUrl))
  467. {
  468. writer.WriteElementString("website", item.HomePageUrl);
  469. }
  470. var rt = item.GetProviderId(MetadataProviders.RottenTomatoes);
  471. if (!string.IsNullOrEmpty(rt))
  472. {
  473. writer.WriteElementString("rottentomatoesid", rt);
  474. }
  475. var tmdbCollection = item.GetProviderId(MetadataProviders.TmdbCollection);
  476. if (!string.IsNullOrEmpty(tmdbCollection))
  477. {
  478. writer.WriteElementString("collectionnumber", tmdbCollection);
  479. }
  480. var imdb = item.GetProviderId(MetadataProviders.Imdb);
  481. if (!string.IsNullOrEmpty(imdb))
  482. {
  483. if (item is Series)
  484. {
  485. writer.WriteElementString("imdb_id", imdb);
  486. }
  487. else
  488. {
  489. writer.WriteElementString("imdbid", imdb);
  490. }
  491. }
  492. // Series xml saver already saves this
  493. if (!(item is Series))
  494. {
  495. var tvdb = item.GetProviderId(MetadataProviders.Tvdb);
  496. if (!string.IsNullOrEmpty(tvdb))
  497. {
  498. writer.WriteElementString("tvdbid", tvdb);
  499. }
  500. }
  501. var tmdb = item.GetProviderId(MetadataProviders.Tmdb);
  502. if (!string.IsNullOrEmpty(tmdb))
  503. {
  504. writer.WriteElementString("tmdbid", tmdb);
  505. }
  506. var tvcom = item.GetProviderId(MetadataProviders.Tvcom);
  507. if (!string.IsNullOrEmpty(tvcom))
  508. {
  509. writer.WriteElementString("tvcomid", tvcom);
  510. }
  511. if (!string.IsNullOrEmpty(item.PreferredMetadataLanguage))
  512. {
  513. writer.WriteElementString("language", item.PreferredMetadataLanguage);
  514. }
  515. if (!string.IsNullOrEmpty(item.PreferredMetadataCountryCode))
  516. {
  517. writer.WriteElementString("countrycode", item.PreferredMetadataCountryCode);
  518. }
  519. if (item.PremiereDate.HasValue && !(item is Episode))
  520. {
  521. var formatString = options.ReleaseDateFormat;
  522. if (item is MusicArtist)
  523. {
  524. writer.WriteElementString("formed", item.PremiereDate.Value.ToLocalTime().ToString(formatString));
  525. }
  526. else
  527. {
  528. writer.WriteElementString("premiered", item.PremiereDate.Value.ToLocalTime().ToString(formatString));
  529. writer.WriteElementString("releasedate", item.PremiereDate.Value.ToLocalTime().ToString(formatString));
  530. }
  531. }
  532. if (item.EndDate.HasValue)
  533. {
  534. if (!(item is Episode))
  535. {
  536. var formatString = options.ReleaseDateFormat;
  537. writer.WriteElementString("enddate", item.EndDate.Value.ToLocalTime().ToString(formatString));
  538. }
  539. }
  540. var hasCriticRating = item as IHasCriticRating;
  541. if (hasCriticRating != null)
  542. {
  543. if (hasCriticRating.CriticRating.HasValue)
  544. {
  545. writer.WriteElementString("criticrating", hasCriticRating.CriticRating.Value.ToString(UsCulture));
  546. }
  547. if (!string.IsNullOrEmpty(hasCriticRating.CriticRatingSummary))
  548. {
  549. writer.WriteElementString("criticratingsummary", hasCriticRating.CriticRatingSummary);
  550. }
  551. }
  552. var hasDisplayOrder = item as IHasDisplayOrder;
  553. if (hasDisplayOrder != null)
  554. {
  555. if (!string.IsNullOrEmpty(hasDisplayOrder.DisplayOrder))
  556. {
  557. writer.WriteElementString("displayorder", hasDisplayOrder.DisplayOrder);
  558. }
  559. }
  560. if (item.VoteCount.HasValue)
  561. {
  562. writer.WriteElementString("votes", item.VoteCount.Value.ToString(UsCulture));
  563. }
  564. var hasBudget = item as IHasBudget;
  565. if (hasBudget != null)
  566. {
  567. if (hasBudget.Budget.HasValue)
  568. {
  569. writer.WriteElementString("budget", hasBudget.Budget.Value.ToString(UsCulture));
  570. }
  571. if (hasBudget.Revenue.HasValue)
  572. {
  573. writer.WriteElementString("revenue", hasBudget.Revenue.Value.ToString(UsCulture));
  574. }
  575. }
  576. var hasMetascore = item as IHasMetascore;
  577. if (hasMetascore != null && hasMetascore.Metascore.HasValue)
  578. {
  579. writer.WriteElementString("metascore", hasMetascore.Metascore.Value.ToString(UsCulture));
  580. }
  581. // Use original runtime here, actual file runtime later in MediaInfo
  582. var runTimeTicks = item.RunTimeTicks;
  583. if (runTimeTicks.HasValue)
  584. {
  585. var timespan = TimeSpan.FromTicks(runTimeTicks.Value);
  586. writer.WriteElementString("runtime", Convert.ToInt32(timespan.TotalMinutes).ToString(UsCulture));
  587. }
  588. var hasTaglines = item as IHasTaglines;
  589. if (hasTaglines != null)
  590. {
  591. foreach (var tagline in hasTaglines.Taglines)
  592. {
  593. writer.WriteElementString("tagline", tagline);
  594. }
  595. }
  596. var hasProductionLocations = item as IHasProductionLocations;
  597. if (hasProductionLocations != null)
  598. {
  599. foreach (var country in hasProductionLocations.ProductionLocations)
  600. {
  601. writer.WriteElementString("country", country);
  602. }
  603. }
  604. foreach (var genre in item.Genres)
  605. {
  606. writer.WriteElementString("genre", genre);
  607. }
  608. foreach (var studio in item.Studios)
  609. {
  610. writer.WriteElementString("studio", studio);
  611. }
  612. foreach (var tag in item.Tags)
  613. {
  614. if (item is MusicAlbum || item is MusicArtist)
  615. {
  616. writer.WriteElementString("style", tag);
  617. }
  618. else
  619. {
  620. writer.WriteElementString("tag", tag);
  621. }
  622. }
  623. foreach (var tag in item.Keywords)
  624. {
  625. writer.WriteElementString("plotkeyword", tag);
  626. }
  627. var hasAwards = item as IHasAwards;
  628. if (hasAwards != null && !string.IsNullOrEmpty(hasAwards.AwardSummary))
  629. {
  630. writer.WriteElementString("awardsummary", hasAwards.AwardSummary);
  631. }
  632. var externalId = item.GetProviderId(MetadataProviders.AudioDbArtist);
  633. if (!string.IsNullOrEmpty(externalId))
  634. {
  635. writer.WriteElementString("audiodbartistid", externalId);
  636. }
  637. externalId = item.GetProviderId(MetadataProviders.AudioDbAlbum);
  638. if (!string.IsNullOrEmpty(externalId))
  639. {
  640. writer.WriteElementString("audiodbalbumid", externalId);
  641. }
  642. externalId = item.GetProviderId(MetadataProviders.Zap2It);
  643. if (!string.IsNullOrEmpty(externalId))
  644. {
  645. writer.WriteElementString("zap2itid", externalId);
  646. }
  647. externalId = item.GetProviderId(MetadataProviders.MusicBrainzAlbum);
  648. if (!string.IsNullOrEmpty(externalId))
  649. {
  650. writer.WriteElementString("musicbrainzalbumid", externalId);
  651. }
  652. externalId = item.GetProviderId(MetadataProviders.MusicBrainzAlbumArtist);
  653. if (!string.IsNullOrEmpty(externalId))
  654. {
  655. writer.WriteElementString("musicbrainzalbumartistid", externalId);
  656. }
  657. externalId = item.GetProviderId(MetadataProviders.MusicBrainzArtist);
  658. if (!string.IsNullOrEmpty(externalId))
  659. {
  660. writer.WriteElementString("musicbrainzartistid", externalId);
  661. }
  662. externalId = item.GetProviderId(MetadataProviders.MusicBrainzReleaseGroup);
  663. if (!string.IsNullOrEmpty(externalId))
  664. {
  665. writer.WriteElementString("musicbrainzreleasegroupid", externalId);
  666. }
  667. externalId = item.GetProviderId(MetadataProviders.Gamesdb);
  668. if (!string.IsNullOrEmpty(externalId))
  669. {
  670. writer.WriteElementString("gamesdbid", externalId);
  671. }
  672. externalId = item.GetProviderId(MetadataProviders.TvRage);
  673. if (!string.IsNullOrEmpty(externalId))
  674. {
  675. writer.WriteElementString("tvrageid", externalId);
  676. }
  677. if (options.SaveImagePathsInNfo)
  678. {
  679. AddImages(item, writer, libraryManager, config);
  680. }
  681. AddUserData(item, writer, userManager, userDataRepo, options);
  682. AddActors(people, writer, libraryManager, fileSystem, config);
  683. var folder = item as BoxSet;
  684. if (folder != null)
  685. {
  686. AddCollectionItems(folder, writer);
  687. }
  688. }
  689. public static void AddChapters(Video item, XmlWriter writer, IItemRepository repository)
  690. {
  691. var chapters = repository.GetChapters(item.Id);
  692. foreach (var chapter in chapters)
  693. {
  694. writer.WriteStartElement("chapter");
  695. writer.WriteElementString("name", chapter.Name);
  696. var time = TimeSpan.FromTicks(chapter.StartPositionTicks);
  697. var ms = Convert.ToInt64(time.TotalMilliseconds);
  698. writer.WriteElementString("startpositionms", ms.ToString(UsCulture));
  699. writer.WriteEndElement();
  700. }
  701. }
  702. private static void AddCollectionItems(Folder item, XmlWriter writer)
  703. {
  704. var items = item.LinkedChildren
  705. .Where(i => i.Type == LinkedChildType.Manual)
  706. .ToList();
  707. foreach (var link in items)
  708. {
  709. writer.WriteStartElement("collectionitem");
  710. if (!string.IsNullOrWhiteSpace(link.Path))
  711. {
  712. writer.WriteElementString("path", link.Path);
  713. }
  714. writer.WriteEndElement();
  715. }
  716. }
  717. /// <summary>
  718. /// Gets the output trailer URL.
  719. /// </summary>
  720. /// <param name="url">The URL.</param>
  721. /// <returns>System.String.</returns>
  722. private static string GetOutputTrailerUrl(string url)
  723. {
  724. // This is what xbmc expects
  725. return url.Replace("https://www.youtube.com/watch?v=",
  726. "plugin://plugin.video.youtube/?action=play_video&videoid=",
  727. StringComparison.OrdinalIgnoreCase);
  728. }
  729. private static void AddImages(BaseItem item, XmlWriter writer, ILibraryManager libraryManager, IServerConfigurationManager config)
  730. {
  731. writer.WriteStartElement("art");
  732. var image = item.GetImageInfo(ImageType.Primary, 0);
  733. if (image != null && image.IsLocalFile)
  734. {
  735. writer.WriteElementString("poster", GetPathToSave(image.Path, libraryManager, config));
  736. }
  737. foreach (var backdrop in item.GetImages(ImageType.Backdrop))
  738. {
  739. if (backdrop.IsLocalFile)
  740. {
  741. writer.WriteElementString("fanart", GetPathToSave(backdrop.Path, libraryManager, config));
  742. }
  743. }
  744. writer.WriteEndElement();
  745. }
  746. private static void AddUserData(BaseItem item, XmlWriter writer, IUserManager userManager, IUserDataManager userDataRepo, XbmcMetadataOptions options)
  747. {
  748. var userId = options.UserId;
  749. if (string.IsNullOrWhiteSpace(userId))
  750. {
  751. return;
  752. }
  753. var user = userManager.GetUserById(userId);
  754. if (user == null)
  755. {
  756. return;
  757. }
  758. if (item.IsFolder)
  759. {
  760. return;
  761. }
  762. var userdata = userDataRepo.GetUserData(user, item);
  763. writer.WriteElementString("isuserfavorite", userdata.IsFavorite.ToString().ToLower());
  764. if (userdata.Rating.HasValue)
  765. {
  766. writer.WriteElementString("userrating", userdata.Rating.Value.ToString(CultureInfo.InvariantCulture).ToLower());
  767. }
  768. if (!item.IsFolder)
  769. {
  770. writer.WriteElementString("playcount", userdata.PlayCount.ToString(UsCulture));
  771. writer.WriteElementString("watched", userdata.Played.ToString().ToLower());
  772. if (userdata.LastPlayedDate.HasValue)
  773. {
  774. writer.WriteElementString("lastplayed", userdata.LastPlayedDate.Value.ToLocalTime().ToString("yyyy-MM-dd HH:mm:ss").ToLower());
  775. }
  776. writer.WriteStartElement("resume");
  777. var runTimeTicks = item.RunTimeTicks ?? 0;
  778. writer.WriteElementString("position", TimeSpan.FromTicks(userdata.PlaybackPositionTicks).TotalSeconds.ToString(UsCulture));
  779. writer.WriteElementString("total", TimeSpan.FromTicks(runTimeTicks).TotalSeconds.ToString(UsCulture));
  780. }
  781. writer.WriteEndElement();
  782. }
  783. private static void AddActors(List<PersonInfo> people, XmlWriter writer, ILibraryManager libraryManager, IFileSystem fileSystem, IServerConfigurationManager config)
  784. {
  785. var actors = people
  786. .Where(i => !IsPersonType(i, PersonType.Director) && !IsPersonType(i, PersonType.Writer))
  787. .ToList();
  788. foreach (var person in actors)
  789. {
  790. writer.WriteStartElement("actor");
  791. if (!string.IsNullOrWhiteSpace(person.Name))
  792. {
  793. writer.WriteElementString("name", person.Name);
  794. }
  795. if (!string.IsNullOrWhiteSpace(person.Role))
  796. {
  797. writer.WriteElementString("role", person.Role);
  798. }
  799. if (!string.IsNullOrWhiteSpace(person.Type))
  800. {
  801. writer.WriteElementString("type", person.Type);
  802. }
  803. if (person.SortOrder.HasValue)
  804. {
  805. writer.WriteElementString("sortorder", person.SortOrder.Value.ToString(UsCulture));
  806. }
  807. try
  808. {
  809. var personEntity = libraryManager.GetPerson(person.Name);
  810. var image = personEntity.GetImageInfo(ImageType.Primary, 0);
  811. if (image != null && image.IsLocalFile)
  812. {
  813. writer.WriteElementString("thumb", GetPathToSave(image.Path, libraryManager, config));
  814. }
  815. }
  816. catch (Exception)
  817. {
  818. // Already logged in core
  819. }
  820. writer.WriteEndElement();
  821. }
  822. }
  823. private static string GetPathToSave(string path, ILibraryManager libraryManager, IServerConfigurationManager config)
  824. {
  825. foreach (var map in config.Configuration.PathSubstitutions)
  826. {
  827. path = libraryManager.SubstitutePath(path, map.From, map.To);
  828. }
  829. return path;
  830. }
  831. private static bool IsPersonType(PersonInfo person, string type)
  832. {
  833. return string.Equals(person.Type, type, StringComparison.OrdinalIgnoreCase) || string.Equals(person.Role, type, StringComparison.OrdinalIgnoreCase);
  834. }
  835. private static void AddCustomTags(string path, List<string> xmlTagsUsed, XmlWriter writer, ILogger logger)
  836. {
  837. var settings = new XmlReaderSettings
  838. {
  839. CheckCharacters = false,
  840. IgnoreProcessingInstructions = true,
  841. IgnoreComments = true,
  842. ValidationType = ValidationType.None
  843. };
  844. using (var streamReader = GetStreamReader(path))
  845. {
  846. // Use XmlReader for best performance
  847. using (var reader = XmlReader.Create(streamReader, settings))
  848. {
  849. try
  850. {
  851. reader.MoveToContent();
  852. }
  853. catch (Exception ex)
  854. {
  855. logger.ErrorException("Error reading existing xml tags from {0}.", ex, path);
  856. return;
  857. }
  858. // Loop through each element
  859. while (reader.Read())
  860. {
  861. if (reader.NodeType == XmlNodeType.Element)
  862. {
  863. var name = reader.Name;
  864. if (!CommonTags.ContainsKey(name) && !xmlTagsUsed.Contains(name, StringComparer.OrdinalIgnoreCase))
  865. {
  866. writer.WriteNode(reader, false);
  867. }
  868. else
  869. {
  870. reader.Skip();
  871. }
  872. }
  873. }
  874. }
  875. }
  876. }
  877. public static StreamReader GetStreamReader(string path)
  878. {
  879. return new StreamReader(path, Encoding.UTF8);
  880. }
  881. }
  882. }