DtoService.cs 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Controller.Drawing;
  3. using MediaBrowser.Controller.Dto;
  4. using MediaBrowser.Controller.Entities;
  5. using MediaBrowser.Controller.Entities.Audio;
  6. using MediaBrowser.Controller.Entities.Movies;
  7. using MediaBrowser.Controller.Entities.TV;
  8. using MediaBrowser.Controller.Library;
  9. using MediaBrowser.Controller.Persistence;
  10. using MediaBrowser.Controller.Session;
  11. using MediaBrowser.Model.Drawing;
  12. using MediaBrowser.Model.Dto;
  13. using MediaBrowser.Model.Entities;
  14. using MediaBrowser.Model.Logging;
  15. using MediaBrowser.Model.Querying;
  16. using MediaBrowser.Model.Session;
  17. using MoreLinq;
  18. using System;
  19. using System.Collections.Generic;
  20. using System.IO;
  21. using System.Linq;
  22. namespace MediaBrowser.Server.Implementations.Dto
  23. {
  24. public class DtoService : IDtoService
  25. {
  26. private readonly ILogger _logger;
  27. private readonly ILibraryManager _libraryManager;
  28. private readonly IUserManager _userManager;
  29. private readonly IUserDataRepository _userDataRepository;
  30. private readonly IItemRepository _itemRepo;
  31. private readonly IImageProcessor _imageProcessor;
  32. public DtoService(ILogger logger, ILibraryManager libraryManager, IUserManager userManager, IUserDataRepository userDataRepository, IItemRepository itemRepo, IImageProcessor imageProcessor)
  33. {
  34. _logger = logger;
  35. _libraryManager = libraryManager;
  36. _userManager = userManager;
  37. _userDataRepository = userDataRepository;
  38. _itemRepo = itemRepo;
  39. _imageProcessor = imageProcessor;
  40. }
  41. /// <summary>
  42. /// Converts a BaseItem to a DTOBaseItem
  43. /// </summary>
  44. /// <param name="item">The item.</param>
  45. /// <param name="fields">The fields.</param>
  46. /// <param name="user">The user.</param>
  47. /// <param name="owner">The owner.</param>
  48. /// <returns>Task{DtoBaseItem}.</returns>
  49. /// <exception cref="System.ArgumentNullException">item</exception>
  50. public BaseItemDto GetBaseItemDto(BaseItem item, List<ItemFields> fields, User user = null, BaseItem owner = null)
  51. {
  52. if (item == null)
  53. {
  54. throw new ArgumentNullException("item");
  55. }
  56. if (fields == null)
  57. {
  58. throw new ArgumentNullException("fields");
  59. }
  60. var dto = new BaseItemDto();
  61. if (fields.Contains(ItemFields.People))
  62. {
  63. AttachPeople(dto, item);
  64. }
  65. if (fields.Contains(ItemFields.PrimaryImageAspectRatio))
  66. {
  67. try
  68. {
  69. AttachPrimaryImageAspectRatio(dto, item);
  70. }
  71. catch (Exception ex)
  72. {
  73. // Have to use a catch-all unfortunately because some .net image methods throw plain Exceptions
  74. _logger.ErrorException("Error generating PrimaryImageAspectRatio for {0}", ex, item.Name);
  75. }
  76. }
  77. if (fields.Contains(ItemFields.DisplayPreferencesId))
  78. {
  79. dto.DisplayPreferencesId = item.DisplayPreferencesId.ToString("N");
  80. }
  81. if (user != null)
  82. {
  83. AttachUserSpecificInfo(dto, item, user, fields);
  84. }
  85. if (fields.Contains(ItemFields.Studios))
  86. {
  87. AttachStudios(dto, item);
  88. }
  89. AttachBasicFields(dto, item, owner, fields);
  90. if (fields.Contains(ItemFields.SoundtrackIds))
  91. {
  92. dto.SoundtrackIds = item.SoundtrackIds
  93. .Select(i => i.ToString("N"))
  94. .ToArray();
  95. }
  96. var itemByName = item as IItemByName;
  97. if (itemByName != null)
  98. {
  99. AttachItemByNameCounts(dto, itemByName, user);
  100. }
  101. return dto;
  102. }
  103. /// <summary>
  104. /// Attaches the item by name counts.
  105. /// </summary>
  106. /// <param name="dto">The dto.</param>
  107. /// <param name="item">The item.</param>
  108. /// <param name="user">The user.</param>
  109. private void AttachItemByNameCounts(BaseItemDto dto, IItemByName item, User user)
  110. {
  111. ItemByNameCounts counts;
  112. if (user == null)
  113. {
  114. //counts = item.ItemCounts;
  115. return;
  116. }
  117. else
  118. {
  119. if (!item.UserItemCounts.TryGetValue(user.Id, out counts))
  120. {
  121. counts = new ItemByNameCounts();
  122. }
  123. }
  124. dto.ChildCount = counts.TotalCount;
  125. dto.AdultVideoCount = counts.AdultVideoCount;
  126. dto.AlbumCount = counts.AlbumCount;
  127. dto.EpisodeCount = counts.EpisodeCount;
  128. dto.GameCount = counts.GameCount;
  129. dto.MovieCount = counts.MovieCount;
  130. dto.MusicVideoCount = counts.MusicVideoCount;
  131. dto.SeriesCount = counts.SeriesCount;
  132. dto.SongCount = counts.SongCount;
  133. dto.TrailerCount = counts.TrailerCount;
  134. }
  135. /// <summary>
  136. /// Attaches the user specific info.
  137. /// </summary>
  138. /// <param name="dto">The dto.</param>
  139. /// <param name="item">The item.</param>
  140. /// <param name="user">The user.</param>
  141. /// <param name="fields">The fields.</param>
  142. private void AttachUserSpecificInfo(BaseItemDto dto, BaseItem item, User user, List<ItemFields> fields)
  143. {
  144. if (item.IsFolder)
  145. {
  146. var folder = (Folder)item;
  147. dto.ChildCount = folder.GetChildren(user, true).Count();
  148. if (!(folder is UserRootFolder))
  149. {
  150. SetSpecialCounts(folder, user, dto, fields);
  151. }
  152. }
  153. var userData = _userDataRepository.GetUserData(user.Id, item.GetUserDataKey());
  154. dto.UserData = GetUserItemDataDto(userData);
  155. if (item.IsFolder)
  156. {
  157. dto.UserData.Played = dto.PlayedPercentage.HasValue && dto.PlayedPercentage.Value >= 100;
  158. }
  159. }
  160. public UserDto GetUserDto(User user)
  161. {
  162. if (user == null)
  163. {
  164. throw new ArgumentNullException("user");
  165. }
  166. var dto = new UserDto
  167. {
  168. Id = user.Id.ToString("N"),
  169. Name = user.Name,
  170. HasPassword = !String.IsNullOrEmpty(user.Password),
  171. LastActivityDate = user.LastActivityDate,
  172. LastLoginDate = user.LastLoginDate,
  173. Configuration = user.Configuration
  174. };
  175. var image = user.PrimaryImagePath;
  176. if (!string.IsNullOrEmpty(image))
  177. {
  178. dto.PrimaryImageTag = _imageProcessor.GetImageCacheTag(user, ImageType.Primary, image);
  179. try
  180. {
  181. AttachPrimaryImageAspectRatio(dto, user);
  182. }
  183. catch (Exception ex)
  184. {
  185. // Have to use a catch-all unfortunately because some .net image methods throw plain Exceptions
  186. _logger.ErrorException("Error generating PrimaryImageAspectRatio for {0}", ex, user.Name);
  187. }
  188. }
  189. return dto;
  190. }
  191. public SessionInfoDto GetSessionInfoDto(SessionInfo session)
  192. {
  193. var dto = new SessionInfoDto
  194. {
  195. Client = session.Client,
  196. DeviceId = session.DeviceId,
  197. DeviceName = session.DeviceName,
  198. Id = session.Id.ToString("N"),
  199. LastActivityDate = session.LastActivityDate,
  200. NowPlayingPositionTicks = session.NowPlayingPositionTicks,
  201. SupportsRemoteControl = session.SupportsRemoteControl,
  202. IsPaused = session.IsPaused,
  203. IsMuted = session.IsMuted,
  204. NowViewingContext = session.NowViewingContext,
  205. NowViewingItemId = session.NowViewingItemId,
  206. NowViewingItemName = session.NowViewingItemName,
  207. NowViewingItemType = session.NowViewingItemType,
  208. ApplicationVersion = session.ApplicationVersion,
  209. CanSeek = session.CanSeek,
  210. QueueableMediaTypes = session.QueueableMediaTypes
  211. };
  212. if (session.NowPlayingItem != null)
  213. {
  214. dto.NowPlayingItem = GetBaseItemInfo(session.NowPlayingItem);
  215. }
  216. if (session.User != null)
  217. {
  218. dto.UserId = session.User.Id.ToString("N");
  219. dto.UserName = session.User.Name;
  220. }
  221. return dto;
  222. }
  223. /// <summary>
  224. /// Converts a BaseItem to a BaseItemInfo
  225. /// </summary>
  226. /// <param name="item">The item.</param>
  227. /// <returns>BaseItemInfo.</returns>
  228. /// <exception cref="System.ArgumentNullException">item</exception>
  229. public BaseItemInfo GetBaseItemInfo(BaseItem item)
  230. {
  231. if (item == null)
  232. {
  233. throw new ArgumentNullException("item");
  234. }
  235. var info = new BaseItemInfo
  236. {
  237. Id = GetDtoId(item),
  238. Name = item.Name,
  239. MediaType = item.MediaType,
  240. Type = item.GetType().Name,
  241. RunTimeTicks = item.RunTimeTicks
  242. };
  243. var imagePath = item.PrimaryImagePath;
  244. if (!string.IsNullOrEmpty(imagePath))
  245. {
  246. try
  247. {
  248. info.PrimaryImageTag = _imageProcessor.GetImageCacheTag(item, ImageType.Primary, imagePath);
  249. }
  250. catch (IOException)
  251. {
  252. }
  253. }
  254. return info;
  255. }
  256. const string IndexFolderDelimeter = "-index-";
  257. /// <summary>
  258. /// Gets client-side Id of a server-side BaseItem
  259. /// </summary>
  260. /// <param name="item">The item.</param>
  261. /// <returns>System.String.</returns>
  262. /// <exception cref="System.ArgumentNullException">item</exception>
  263. public string GetDtoId(BaseItem item)
  264. {
  265. if (item == null)
  266. {
  267. throw new ArgumentNullException("item");
  268. }
  269. var indexFolder = item as IndexFolder;
  270. if (indexFolder != null)
  271. {
  272. return GetDtoId(indexFolder.Parent) + IndexFolderDelimeter + (indexFolder.IndexName ?? string.Empty) + IndexFolderDelimeter + indexFolder.Id;
  273. }
  274. return item.Id.ToString("N");
  275. }
  276. /// <summary>
  277. /// Converts a UserItemData to a DTOUserItemData
  278. /// </summary>
  279. /// <param name="data">The data.</param>
  280. /// <returns>DtoUserItemData.</returns>
  281. /// <exception cref="System.ArgumentNullException"></exception>
  282. public UserItemDataDto GetUserItemDataDto(UserItemData data)
  283. {
  284. if (data == null)
  285. {
  286. throw new ArgumentNullException("data");
  287. }
  288. return new UserItemDataDto
  289. {
  290. IsFavorite = data.IsFavorite,
  291. Likes = data.Likes,
  292. PlaybackPositionTicks = data.PlaybackPositionTicks,
  293. PlayCount = data.PlayCount,
  294. Rating = data.Rating,
  295. Played = data.Played,
  296. LastPlayedDate = data.LastPlayedDate
  297. };
  298. }
  299. private void SetBookProperties(BaseItemDto dto, Book item)
  300. {
  301. dto.SeriesName = item.SeriesName;
  302. }
  303. private void SetMusicVideoProperties(BaseItemDto dto, MusicVideo item)
  304. {
  305. if (!string.IsNullOrEmpty(item.Album))
  306. {
  307. var parentAlbum = _libraryManager.RootFolder
  308. .GetRecursiveChildren(i => i is MusicAlbum)
  309. .FirstOrDefault(i => string.Equals(i.Name, item.Album, StringComparison.OrdinalIgnoreCase));
  310. if (parentAlbum != null)
  311. {
  312. dto.AlbumId = GetDtoId(parentAlbum);
  313. }
  314. }
  315. dto.Album = item.Album;
  316. dto.Artists = string.IsNullOrEmpty(item.Artist) ? new List<string>() : new List<string> { item.Artist };
  317. }
  318. private void SetGameProperties(BaseItemDto dto, Game item)
  319. {
  320. dto.Players = item.PlayersSupported;
  321. dto.GameSystem = item.GameSystem;
  322. }
  323. /// <summary>
  324. /// Gets the backdrop image tags.
  325. /// </summary>
  326. /// <param name="item">The item.</param>
  327. /// <returns>List{System.String}.</returns>
  328. private List<Guid> GetBackdropImageTags(BaseItem item)
  329. {
  330. return item.BackdropImagePaths
  331. .Select(p => GetImageCacheTag(item, ImageType.Backdrop, p))
  332. .Where(i => i.HasValue)
  333. .Select(i => i.Value)
  334. .ToList();
  335. }
  336. /// <summary>
  337. /// Gets the screenshot image tags.
  338. /// </summary>
  339. /// <param name="item">The item.</param>
  340. /// <returns>List{Guid}.</returns>
  341. private List<Guid> GetScreenshotImageTags(BaseItem item)
  342. {
  343. return item.ScreenshotImagePaths
  344. .Select(p => GetImageCacheTag(item, ImageType.Screenshot, p))
  345. .Where(i => i.HasValue)
  346. .Select(i => i.Value)
  347. .ToList();
  348. }
  349. private Guid? GetImageCacheTag(BaseItem item, ImageType type, string path)
  350. {
  351. try
  352. {
  353. return _imageProcessor.GetImageCacheTag(item, type, path);
  354. }
  355. catch (IOException ex)
  356. {
  357. _logger.ErrorException("Error getting {0} image info for {1}", ex, type, path);
  358. return null;
  359. }
  360. }
  361. /// <summary>
  362. /// Attaches People DTO's to a DTOBaseItem
  363. /// </summary>
  364. /// <param name="dto">The dto.</param>
  365. /// <param name="item">The item.</param>
  366. /// <returns>Task.</returns>
  367. private void AttachPeople(BaseItemDto dto, BaseItem item)
  368. {
  369. // Ordering by person type to ensure actors and artists are at the front.
  370. // This is taking advantage of the fact that they both begin with A
  371. // This should be improved in the future
  372. var people = item.People.OrderBy(i => i.Type).ToList();
  373. // Attach People by transforming them into BaseItemPerson (DTO)
  374. dto.People = new BaseItemPerson[people.Count];
  375. var dictionary = people.Select(p => p.Name)
  376. .Distinct(StringComparer.OrdinalIgnoreCase).Select(c =>
  377. {
  378. try
  379. {
  380. return _libraryManager.GetPerson(c);
  381. }
  382. catch (IOException ex)
  383. {
  384. _logger.ErrorException("Error getting person {0}", ex, c);
  385. return null;
  386. }
  387. }).Where(i => i != null)
  388. .DistinctBy(i => i.Name)
  389. .ToDictionary(i => i.Name, StringComparer.OrdinalIgnoreCase);
  390. for (var i = 0; i < people.Count; i++)
  391. {
  392. var person = people[i];
  393. var baseItemPerson = new BaseItemPerson
  394. {
  395. Name = person.Name,
  396. Role = person.Role,
  397. Type = person.Type
  398. };
  399. Person entity;
  400. if (dictionary.TryGetValue(person.Name, out entity))
  401. {
  402. var primaryImagePath = entity.PrimaryImagePath;
  403. if (!string.IsNullOrEmpty(primaryImagePath))
  404. {
  405. baseItemPerson.PrimaryImageTag = GetImageCacheTag(entity, ImageType.Primary, primaryImagePath);
  406. }
  407. }
  408. dto.People[i] = baseItemPerson;
  409. }
  410. }
  411. /// <summary>
  412. /// Attaches the studios.
  413. /// </summary>
  414. /// <param name="dto">The dto.</param>
  415. /// <param name="item">The item.</param>
  416. /// <returns>Task.</returns>
  417. private void AttachStudios(BaseItemDto dto, BaseItem item)
  418. {
  419. var studios = item.Studios.ToList();
  420. dto.Studios = new StudioDto[studios.Count];
  421. var dictionary = studios.Distinct(StringComparer.OrdinalIgnoreCase).Select(name =>
  422. {
  423. try
  424. {
  425. return _libraryManager.GetStudio(name);
  426. }
  427. catch (IOException ex)
  428. {
  429. _logger.ErrorException("Error getting studio {0}", ex, name);
  430. return null;
  431. }
  432. })
  433. .Where(i => i != null)
  434. .ToDictionary(i => i.Name, StringComparer.OrdinalIgnoreCase);
  435. for (var i = 0; i < studios.Count; i++)
  436. {
  437. var studio = studios[i];
  438. var studioDto = new StudioDto
  439. {
  440. Name = studio
  441. };
  442. Studio entity;
  443. if (dictionary.TryGetValue(studio, out entity))
  444. {
  445. var primaryImagePath = entity.PrimaryImagePath;
  446. if (!string.IsNullOrEmpty(primaryImagePath))
  447. {
  448. studioDto.PrimaryImageTag = GetImageCacheTag(entity, ImageType.Primary, primaryImagePath);
  449. }
  450. }
  451. dto.Studios[i] = studioDto;
  452. }
  453. }
  454. /// <summary>
  455. /// If an item does not any backdrops, this can be used to find the first parent that does have one
  456. /// </summary>
  457. /// <param name="item">The item.</param>
  458. /// <param name="owner">The owner.</param>
  459. /// <returns>BaseItem.</returns>
  460. private BaseItem GetParentBackdropItem(BaseItem item, BaseItem owner)
  461. {
  462. var parent = item.Parent ?? owner;
  463. while (parent != null)
  464. {
  465. if (parent.BackdropImagePaths != null && parent.BackdropImagePaths.Count > 0)
  466. {
  467. return parent;
  468. }
  469. parent = parent.Parent;
  470. }
  471. return null;
  472. }
  473. /// <summary>
  474. /// If an item does not have a logo, this can be used to find the first parent that does have one
  475. /// </summary>
  476. /// <param name="item">The item.</param>
  477. /// <param name="type">The type.</param>
  478. /// <param name="owner">The owner.</param>
  479. /// <returns>BaseItem.</returns>
  480. private BaseItem GetParentImageItem(BaseItem item, ImageType type, BaseItem owner)
  481. {
  482. var parent = item.Parent ?? owner;
  483. while (parent != null)
  484. {
  485. if (parent.HasImage(type))
  486. {
  487. return parent;
  488. }
  489. parent = parent.Parent;
  490. }
  491. return null;
  492. }
  493. /// <summary>
  494. /// Gets the chapter info dto.
  495. /// </summary>
  496. /// <param name="chapterInfo">The chapter info.</param>
  497. /// <param name="item">The item.</param>
  498. /// <returns>ChapterInfoDto.</returns>
  499. private ChapterInfoDto GetChapterInfoDto(ChapterInfo chapterInfo, BaseItem item)
  500. {
  501. var dto = new ChapterInfoDto
  502. {
  503. Name = chapterInfo.Name,
  504. StartPositionTicks = chapterInfo.StartPositionTicks
  505. };
  506. if (!string.IsNullOrEmpty(chapterInfo.ImagePath))
  507. {
  508. dto.ImageTag = GetImageCacheTag(item, ImageType.Chapter, chapterInfo.ImagePath);
  509. }
  510. return dto;
  511. }
  512. /// <summary>
  513. /// Gets a BaseItem based upon it's client-side item id
  514. /// </summary>
  515. /// <param name="id">The id.</param>
  516. /// <param name="userId">The user id.</param>
  517. /// <returns>BaseItem.</returns>
  518. public BaseItem GetItemByDtoId(string id, Guid? userId = null)
  519. {
  520. if (string.IsNullOrEmpty(id))
  521. {
  522. throw new ArgumentNullException("id");
  523. }
  524. // If the item is an indexed folder we have to do a special routine to get it
  525. var isIndexFolder = id.IndexOf(IndexFolderDelimeter, StringComparison.OrdinalIgnoreCase) != -1;
  526. if (isIndexFolder)
  527. {
  528. if (userId.HasValue)
  529. {
  530. return GetIndexFolder(id, userId.Value);
  531. }
  532. }
  533. BaseItem item = null;
  534. if (userId.HasValue || !isIndexFolder)
  535. {
  536. item = _libraryManager.GetItemById(new Guid(id));
  537. }
  538. // If we still don't find it, look within individual user views
  539. if (item == null && !userId.HasValue && isIndexFolder)
  540. {
  541. foreach (var user in _userManager.Users)
  542. {
  543. item = GetItemByDtoId(id, user.Id);
  544. if (item != null)
  545. {
  546. break;
  547. }
  548. }
  549. }
  550. return item;
  551. }
  552. /// <summary>
  553. /// Finds an index folder based on an Id and userId
  554. /// </summary>
  555. /// <param name="id">The id.</param>
  556. /// <param name="userId">The user id.</param>
  557. /// <returns>BaseItem.</returns>
  558. private BaseItem GetIndexFolder(string id, Guid userId)
  559. {
  560. var user = _userManager.GetUserById(userId);
  561. var stringSeparators = new[] { IndexFolderDelimeter };
  562. // Split using the delimeter
  563. var values = id.Split(stringSeparators, StringSplitOptions.None).ToList();
  564. // Get the top folder normally using the first id
  565. var folder = GetItemByDtoId(values[0], userId) as Folder;
  566. values.RemoveAt(0);
  567. // Get indexed folders using the remaining values in the id string
  568. return GetIndexFolder(values, folder, user);
  569. }
  570. /// <summary>
  571. /// Gets indexed folders based on a list of index names and folder id's
  572. /// </summary>
  573. /// <param name="values">The values.</param>
  574. /// <param name="parentFolder">The parent folder.</param>
  575. /// <param name="user">The user.</param>
  576. /// <returns>BaseItem.</returns>
  577. private BaseItem GetIndexFolder(List<string> values, Folder parentFolder, User user)
  578. {
  579. // The index name is first
  580. var indexBy = values[0];
  581. // The index folder id is next
  582. var indexFolderId = new Guid(values[1]);
  583. // Remove them from the lst
  584. values.RemoveRange(0, 2);
  585. // Get the IndexFolder
  586. var indexFolder = parentFolder.GetChildren(user, false, indexBy).FirstOrDefault(i => i.Id == indexFolderId) as Folder;
  587. // Nested index folder
  588. if (values.Count > 0)
  589. {
  590. return GetIndexFolder(values, indexFolder, user);
  591. }
  592. return indexFolder;
  593. }
  594. /// <summary>
  595. /// Sets simple property values on a DTOBaseItem
  596. /// </summary>
  597. /// <param name="dto">The dto.</param>
  598. /// <param name="item">The item.</param>
  599. /// <param name="owner">The owner.</param>
  600. /// <param name="fields">The fields.</param>
  601. private void AttachBasicFields(BaseItemDto dto, BaseItem item, BaseItem owner, List<ItemFields> fields)
  602. {
  603. if (fields.Contains(ItemFields.DateCreated))
  604. {
  605. dto.DateCreated = item.DateCreated;
  606. }
  607. if (fields.Contains(ItemFields.OriginalRunTimeTicks))
  608. {
  609. dto.OriginalRunTimeTicks = item.OriginalRunTimeTicks;
  610. }
  611. dto.DisplayMediaType = item.DisplayMediaType;
  612. if (fields.Contains(ItemFields.MetadataSettings))
  613. {
  614. dto.LockedFields = item.LockedFields;
  615. dto.EnableInternetProviders = !item.DontFetchMeta;
  616. }
  617. if (fields.Contains(ItemFields.Budget))
  618. {
  619. dto.Budget = item.Budget;
  620. }
  621. if (fields.Contains(ItemFields.Revenue))
  622. {
  623. dto.Revenue = item.Revenue;
  624. }
  625. dto.EndDate = item.EndDate;
  626. if (fields.Contains(ItemFields.HomePageUrl))
  627. {
  628. dto.HomePageUrl = item.HomePageUrl;
  629. }
  630. if (fields.Contains(ItemFields.Tags))
  631. {
  632. dto.Tags = item.Tags;
  633. }
  634. if (fields.Contains(ItemFields.ProductionLocations))
  635. {
  636. dto.ProductionLocations = item.ProductionLocations;
  637. }
  638. dto.AspectRatio = item.AspectRatio;
  639. dto.BackdropImageTags = GetBackdropImageTags(item);
  640. if (fields.Contains(ItemFields.ScreenshotImageTags))
  641. {
  642. dto.ScreenshotImageTags = GetScreenshotImageTags(item);
  643. }
  644. if (fields.Contains(ItemFields.Genres))
  645. {
  646. dto.Genres = item.Genres;
  647. }
  648. dto.ImageTags = new Dictionary<ImageType, Guid>();
  649. foreach (var image in item.Images)
  650. {
  651. var type = image.Key;
  652. var tag = GetImageCacheTag(item, type, image.Value);
  653. if (tag.HasValue)
  654. {
  655. dto.ImageTags[type] = tag.Value;
  656. }
  657. }
  658. dto.Id = GetDtoId(item);
  659. dto.IndexNumber = item.IndexNumber;
  660. dto.IsFolder = item.IsFolder;
  661. dto.Language = item.Language;
  662. dto.MediaType = item.MediaType;
  663. dto.LocationType = item.LocationType;
  664. dto.CriticRating = item.CriticRating;
  665. if (fields.Contains(ItemFields.CriticRatingSummary))
  666. {
  667. dto.CriticRatingSummary = item.CriticRatingSummary;
  668. }
  669. var localTrailerCount = item.LocalTrailerIds.Count;
  670. if (localTrailerCount > 0)
  671. {
  672. dto.LocalTrailerCount = localTrailerCount;
  673. }
  674. dto.Name = item.Name;
  675. dto.OfficialRating = item.OfficialRating;
  676. var hasOverview = fields.Contains(ItemFields.Overview);
  677. var hasHtmlOverview = fields.Contains(ItemFields.OverviewHtml);
  678. if (hasOverview || hasHtmlOverview)
  679. {
  680. var strippedOverview = string.IsNullOrEmpty(item.Overview) ? item.Overview : item.Overview.StripHtml();
  681. if (hasOverview)
  682. {
  683. dto.Overview = strippedOverview;
  684. }
  685. // Only supply the html version if there was actually html content
  686. if (hasHtmlOverview)
  687. {
  688. dto.OverviewHtml = item.Overview;
  689. }
  690. }
  691. // If there are no backdrops, indicate what parent has them in case the Ui wants to allow inheritance
  692. if (dto.BackdropImageTags.Count == 0)
  693. {
  694. var parentWithBackdrop = GetParentBackdropItem(item, owner);
  695. if (parentWithBackdrop != null)
  696. {
  697. dto.ParentBackdropItemId = GetDtoId(parentWithBackdrop);
  698. dto.ParentBackdropImageTags = GetBackdropImageTags(parentWithBackdrop);
  699. }
  700. }
  701. if (item.Parent != null && fields.Contains(ItemFields.ParentId))
  702. {
  703. dto.ParentId = GetDtoId(item.Parent);
  704. }
  705. dto.ParentIndexNumber = item.ParentIndexNumber;
  706. // If there is no logo, indicate what parent has one in case the Ui wants to allow inheritance
  707. if (!dto.HasLogo)
  708. {
  709. var parentWithLogo = GetParentImageItem(item, ImageType.Logo, owner);
  710. if (parentWithLogo != null)
  711. {
  712. dto.ParentLogoItemId = GetDtoId(parentWithLogo);
  713. dto.ParentLogoImageTag = GetImageCacheTag(parentWithLogo, ImageType.Logo, parentWithLogo.GetImage(ImageType.Logo));
  714. }
  715. }
  716. // If there is no art, indicate what parent has one in case the Ui wants to allow inheritance
  717. if (!dto.HasArtImage)
  718. {
  719. var parentWithImage = GetParentImageItem(item, ImageType.Art, owner);
  720. if (parentWithImage != null)
  721. {
  722. dto.ParentArtItemId = GetDtoId(parentWithImage);
  723. dto.ParentArtImageTag = GetImageCacheTag(parentWithImage, ImageType.Art, parentWithImage.GetImage(ImageType.Art));
  724. }
  725. }
  726. if (fields.Contains(ItemFields.Path))
  727. {
  728. dto.Path = item.Path;
  729. }
  730. dto.PremiereDate = item.PremiereDate;
  731. dto.ProductionYear = item.ProductionYear;
  732. if (fields.Contains(ItemFields.ProviderIds))
  733. {
  734. dto.ProviderIds = item.ProviderIds;
  735. }
  736. dto.RunTimeTicks = item.RunTimeTicks;
  737. if (fields.Contains(ItemFields.SortName))
  738. {
  739. dto.SortName = item.SortName;
  740. }
  741. if (fields.Contains(ItemFields.CustomRating))
  742. {
  743. dto.CustomRating = item.CustomRating;
  744. }
  745. if (fields.Contains(ItemFields.Taglines))
  746. {
  747. dto.Taglines = item.Taglines;
  748. }
  749. if (fields.Contains(ItemFields.RemoteTrailers))
  750. {
  751. dto.RemoteTrailers = item.RemoteTrailers;
  752. }
  753. dto.Type = item.GetType().Name;
  754. dto.CommunityRating = item.CommunityRating;
  755. if (item.IsFolder)
  756. {
  757. var folder = (Folder)item;
  758. if (fields.Contains(ItemFields.IndexOptions))
  759. {
  760. dto.IndexOptions = folder.IndexByOptionStrings.ToArray();
  761. }
  762. }
  763. // Add audio info
  764. var audio = item as Audio;
  765. if (audio != null)
  766. {
  767. dto.Album = audio.Album;
  768. dto.Artists = audio.Artists;
  769. var albumParent = audio.FindParent<MusicAlbum>();
  770. if (albumParent != null)
  771. {
  772. dto.AlbumId = GetDtoId(albumParent);
  773. var imagePath = albumParent.PrimaryImagePath;
  774. if (!string.IsNullOrEmpty(imagePath))
  775. {
  776. dto.AlbumPrimaryImageTag = GetImageCacheTag(albumParent, ImageType.Primary, imagePath);
  777. }
  778. }
  779. }
  780. var album = item as MusicAlbum;
  781. if (album != null)
  782. {
  783. dto.Artists = album.Artists;
  784. }
  785. var hasAlbumArtist = item as IHasAlbumArtist;
  786. if (hasAlbumArtist != null)
  787. {
  788. dto.AlbumArtist = hasAlbumArtist.AlbumArtist;
  789. }
  790. // Add video info
  791. var video = item as Video;
  792. if (video != null)
  793. {
  794. dto.VideoType = video.VideoType;
  795. dto.Video3DFormat = video.Video3DFormat;
  796. dto.IsoType = video.IsoType;
  797. dto.IsHD = video.IsHD;
  798. dto.PartCount = video.AdditionalPartIds.Count + 1;
  799. if (fields.Contains(ItemFields.Chapters))
  800. {
  801. dto.Chapters = _itemRepo.GetChapters(video.Id).Select(c => GetChapterInfoDto(c, item)).ToList();
  802. }
  803. }
  804. if (fields.Contains(ItemFields.MediaStreams))
  805. {
  806. // Add VideoInfo
  807. var iHasMediaStreams = item as IHasMediaStreams;
  808. if (iHasMediaStreams != null)
  809. {
  810. dto.MediaStreams = iHasMediaStreams.MediaStreams;
  811. }
  812. }
  813. // Add MovieInfo
  814. var movie = item as Movie;
  815. if (movie != null)
  816. {
  817. var specialFeatureCount = movie.SpecialFeatureIds.Count;
  818. if (specialFeatureCount > 0)
  819. {
  820. dto.SpecialFeatureCount = specialFeatureCount;
  821. }
  822. }
  823. // Add EpisodeInfo
  824. var episode = item as Episode;
  825. if (episode != null)
  826. {
  827. dto.IndexNumberEnd = episode.IndexNumberEnd;
  828. }
  829. // Add SeriesInfo
  830. var series = item as Series;
  831. if (series != null)
  832. {
  833. dto.AirDays = series.AirDays;
  834. dto.AirTime = series.AirTime;
  835. dto.Status = series.Status;
  836. dto.SpecialFeatureCount = series.SpecialFeatureIds.Count;
  837. dto.SeasonCount = series.SeasonCount;
  838. }
  839. if (episode != null)
  840. {
  841. series = item.FindParent<Series>();
  842. dto.SeriesId = GetDtoId(series);
  843. dto.SeriesName = series.Name;
  844. }
  845. // Add SeasonInfo
  846. var season = item as Season;
  847. if (season != null)
  848. {
  849. series = item.FindParent<Series>();
  850. dto.SeriesId = GetDtoId(series);
  851. dto.SeriesName = series.Name;
  852. }
  853. var game = item as Game;
  854. if (game != null)
  855. {
  856. SetGameProperties(dto, game);
  857. }
  858. var musicVideo = item as MusicVideo;
  859. if (musicVideo != null)
  860. {
  861. SetMusicVideoProperties(dto, musicVideo);
  862. }
  863. var book = item as Book;
  864. if (book != null)
  865. {
  866. SetBookProperties(dto, book);
  867. }
  868. }
  869. /// <summary>
  870. /// Since it can be slow to make all of these calculations independently, this method will provide a way to do them all at once
  871. /// </summary>
  872. /// <param name="folder">The folder.</param>
  873. /// <param name="user">The user.</param>
  874. /// <param name="dto">The dto.</param>
  875. /// <param name="fields">The fields.</param>
  876. /// <returns>Task.</returns>
  877. private void SetSpecialCounts(Folder folder, User user, BaseItemDto dto, List<ItemFields> fields)
  878. {
  879. var rcentlyAddedItemCount = 0;
  880. var recursiveItemCount = 0;
  881. var unplayed = 0;
  882. long runtime = 0;
  883. double totalPercentPlayed = 0;
  884. // Loop through each recursive child
  885. foreach (var child in folder.GetRecursiveChildren(user, i => !i.IsFolder))
  886. {
  887. var userdata = _userDataRepository.GetUserData(user.Id, child.GetUserDataKey());
  888. recursiveItemCount++;
  889. // Check is recently added
  890. if (child.IsRecentlyAdded())
  891. {
  892. rcentlyAddedItemCount++;
  893. }
  894. var isUnplayed = true;
  895. // Incrememt totalPercentPlayed
  896. if (userdata != null)
  897. {
  898. if (userdata.Played)
  899. {
  900. totalPercentPlayed += 100;
  901. isUnplayed = false;
  902. }
  903. else if (userdata.PlaybackPositionTicks > 0 && child.RunTimeTicks.HasValue && child.RunTimeTicks.Value > 0)
  904. {
  905. double itemPercent = userdata.PlaybackPositionTicks;
  906. itemPercent /= child.RunTimeTicks.Value;
  907. totalPercentPlayed += itemPercent;
  908. }
  909. }
  910. if (isUnplayed)
  911. {
  912. unplayed++;
  913. }
  914. runtime += child.RunTimeTicks ?? 0;
  915. }
  916. dto.RecursiveItemCount = recursiveItemCount;
  917. dto.RecentlyAddedItemCount = rcentlyAddedItemCount;
  918. dto.RecursiveUnplayedItemCount = unplayed;
  919. if (recursiveItemCount > 0)
  920. {
  921. dto.PlayedPercentage = totalPercentPlayed / recursiveItemCount;
  922. }
  923. if (runtime > 0 && fields.Contains(ItemFields.CumulativeRunTimeTicks))
  924. {
  925. dto.CumulativeRunTimeTicks = runtime;
  926. }
  927. }
  928. /// <summary>
  929. /// Attaches the primary image aspect ratio.
  930. /// </summary>
  931. /// <param name="dto">The dto.</param>
  932. /// <param name="item">The item.</param>
  933. /// <returns>Task.</returns>
  934. private void AttachPrimaryImageAspectRatio(IItemDto dto, BaseItem item)
  935. {
  936. var path = item.PrimaryImagePath;
  937. if (string.IsNullOrEmpty(path))
  938. {
  939. return;
  940. }
  941. var metaFileEntry = item.ResolveArgs.GetMetaFileByPath(path);
  942. // See if we can avoid a file system lookup by looking for the file in ResolveArgs
  943. var dateModified = metaFileEntry == null ? File.GetLastWriteTimeUtc(path) : metaFileEntry.LastWriteTimeUtc;
  944. ImageSize size;
  945. try
  946. {
  947. size = _imageProcessor.GetImageSize(path, dateModified);
  948. }
  949. catch (FileNotFoundException)
  950. {
  951. _logger.Error("Image file does not exist: {0}", path);
  952. return;
  953. }
  954. catch (Exception ex)
  955. {
  956. _logger.ErrorException("Failed to determine primary image aspect ratio for {0}", ex, path);
  957. return;
  958. }
  959. dto.OriginalPrimaryImageAspectRatio = size.Width / size.Height;
  960. var supportedEnhancers = _imageProcessor.GetSupportedEnhancers(item, ImageType.Primary).ToList();
  961. foreach (var enhancer in supportedEnhancers)
  962. {
  963. try
  964. {
  965. size = enhancer.GetEnhancedImageSize(item, ImageType.Primary, 0, size);
  966. }
  967. catch (Exception ex)
  968. {
  969. _logger.ErrorException("Error in image enhancer: {0}", ex, enhancer.GetType().Name);
  970. }
  971. }
  972. dto.PrimaryImageAspectRatio = size.Width / size.Height;
  973. }
  974. }
  975. }