DtoService.cs 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837
  1. using MediaBrowser.Common;
  2. using MediaBrowser.Controller.Channels;
  3. using MediaBrowser.Controller.Configuration;
  4. using MediaBrowser.Controller.Devices;
  5. using MediaBrowser.Controller.Drawing;
  6. using MediaBrowser.Controller.Dto;
  7. using MediaBrowser.Controller.Entities;
  8. using MediaBrowser.Controller.Entities.Audio;
  9. using MediaBrowser.Controller.Entities.Movies;
  10. using MediaBrowser.Controller.Entities.TV;
  11. using MediaBrowser.Controller.Library;
  12. using MediaBrowser.Controller.LiveTv;
  13. using MediaBrowser.Controller.Persistence;
  14. using MediaBrowser.Controller.Playlists;
  15. using MediaBrowser.Controller.Providers;
  16. using MediaBrowser.Controller.Sync;
  17. using MediaBrowser.Model.Drawing;
  18. using MediaBrowser.Model.Dto;
  19. using MediaBrowser.Model.Entities;
  20. using MediaBrowser.Model.Logging;
  21. using MediaBrowser.Model.Querying;
  22. using MediaBrowser.Model.Sync;
  23. using MoreLinq;
  24. using System;
  25. using System.Collections.Generic;
  26. using System.IO;
  27. using System.Linq;
  28. using System.Threading.Tasks;
  29. using CommonIO;
  30. namespace MediaBrowser.Server.Implementations.Dto
  31. {
  32. public class DtoService : IDtoService
  33. {
  34. private readonly ILogger _logger;
  35. private readonly ILibraryManager _libraryManager;
  36. private readonly IUserDataManager _userDataRepository;
  37. private readonly IItemRepository _itemRepo;
  38. private readonly IImageProcessor _imageProcessor;
  39. private readonly IServerConfigurationManager _config;
  40. private readonly IFileSystem _fileSystem;
  41. private readonly IProviderManager _providerManager;
  42. private readonly Func<IChannelManager> _channelManagerFactory;
  43. private readonly ISyncManager _syncManager;
  44. private readonly IApplicationHost _appHost;
  45. private readonly Func<IDeviceManager> _deviceManager;
  46. private readonly Func<IMediaSourceManager> _mediaSourceManager;
  47. private readonly Func<ILiveTvManager> _livetvManager;
  48. public DtoService(ILogger logger, ILibraryManager libraryManager, IUserDataManager userDataRepository, IItemRepository itemRepo, IImageProcessor imageProcessor, IServerConfigurationManager config, IFileSystem fileSystem, IProviderManager providerManager, Func<IChannelManager> channelManagerFactory, ISyncManager syncManager, IApplicationHost appHost, Func<IDeviceManager> deviceManager, Func<IMediaSourceManager> mediaSourceManager, Func<ILiveTvManager> livetvManager)
  49. {
  50. _logger = logger;
  51. _libraryManager = libraryManager;
  52. _userDataRepository = userDataRepository;
  53. _itemRepo = itemRepo;
  54. _imageProcessor = imageProcessor;
  55. _config = config;
  56. _fileSystem = fileSystem;
  57. _providerManager = providerManager;
  58. _channelManagerFactory = channelManagerFactory;
  59. _syncManager = syncManager;
  60. _appHost = appHost;
  61. _deviceManager = deviceManager;
  62. _mediaSourceManager = mediaSourceManager;
  63. _livetvManager = livetvManager;
  64. }
  65. /// <summary>
  66. /// Converts a BaseItem to a DTOBaseItem
  67. /// </summary>
  68. /// <param name="item">The item.</param>
  69. /// <param name="fields">The fields.</param>
  70. /// <param name="user">The user.</param>
  71. /// <param name="owner">The owner.</param>
  72. /// <returns>Task{DtoBaseItem}.</returns>
  73. /// <exception cref="System.ArgumentNullException">item</exception>
  74. public BaseItemDto GetBaseItemDto(BaseItem item, List<ItemFields> fields, User user = null, BaseItem owner = null)
  75. {
  76. var options = new DtoOptions
  77. {
  78. Fields = fields
  79. };
  80. return GetBaseItemDto(item, options, user, owner);
  81. }
  82. public IEnumerable<BaseItemDto> GetBaseItemDtos(IEnumerable<BaseItem> items, DtoOptions options, User user = null, BaseItem owner = null)
  83. {
  84. var syncJobItems = GetSyncedItemProgress(options);
  85. var syncDictionary = GetSyncedItemProgressDictionary(syncJobItems);
  86. var list = new List<BaseItemDto>();
  87. var programTuples = new List<Tuple<BaseItem, BaseItemDto>> { };
  88. var channelTuples = new List<Tuple<BaseItemDto, LiveTvChannel>> { };
  89. foreach (var item in items)
  90. {
  91. var dto = GetBaseItemDtoInternal(item, options, syncDictionary, user, owner);
  92. var tvChannel = item as LiveTvChannel;
  93. if (tvChannel != null)
  94. {
  95. channelTuples.Add(new Tuple<BaseItemDto, LiveTvChannel>(dto, tvChannel));
  96. }
  97. else if (item is LiveTvProgram)
  98. {
  99. programTuples.Add(new Tuple<BaseItem, BaseItemDto>(item, dto));
  100. }
  101. var byName = item as IItemByName;
  102. if (byName != null)
  103. {
  104. if (options.Fields.Contains(ItemFields.ItemCounts))
  105. {
  106. var itemFilter = byName.GetItemFilter();
  107. var libraryItems = user != null ?
  108. user.RootFolder.GetRecursiveChildren(user, itemFilter) :
  109. _libraryManager.RootFolder.GetRecursiveChildren(itemFilter);
  110. SetItemByNameInfo(item, dto, libraryItems.ToList(), user);
  111. }
  112. }
  113. FillSyncInfo(dto, item, syncJobItems, options, user);
  114. list.Add(dto);
  115. }
  116. if (programTuples.Count > 0)
  117. {
  118. var task = _livetvManager().AddInfoToProgramDto(programTuples, options.Fields, user);
  119. Task.WaitAll(task);
  120. }
  121. if (channelTuples.Count > 0)
  122. {
  123. _livetvManager().AddChannelInfo(channelTuples, options, user);
  124. }
  125. return list;
  126. }
  127. private Dictionary<string, SyncedItemProgress> GetSyncedItemProgressDictionary(IEnumerable<SyncedItemProgress> items)
  128. {
  129. var dict = new Dictionary<string, SyncedItemProgress>();
  130. foreach (var item in items)
  131. {
  132. dict[item.ItemId] = item;
  133. }
  134. return dict;
  135. }
  136. public BaseItemDto GetBaseItemDto(BaseItem item, DtoOptions options, User user = null, BaseItem owner = null)
  137. {
  138. var syncProgress = GetSyncedItemProgress(options);
  139. var dto = GetBaseItemDtoInternal(item, options, GetSyncedItemProgressDictionary(syncProgress), user, owner);
  140. var tvChannel = item as LiveTvChannel;
  141. if (tvChannel != null)
  142. {
  143. var list = new List<Tuple<BaseItemDto, LiveTvChannel>> { new Tuple<BaseItemDto, LiveTvChannel>(dto, tvChannel) };
  144. _livetvManager().AddChannelInfo(list, options, user);
  145. }
  146. else if (item is LiveTvProgram)
  147. {
  148. var list = new List<Tuple<BaseItem, BaseItemDto>> { new Tuple<BaseItem, BaseItemDto>(item, dto) };
  149. var task = _livetvManager().AddInfoToProgramDto(list, options.Fields, user);
  150. Task.WaitAll(task);
  151. }
  152. var byName = item as IItemByName;
  153. if (byName != null)
  154. {
  155. if (options.Fields.Contains(ItemFields.ItemCounts))
  156. {
  157. SetItemByNameInfo(item, dto, GetTaggedItems(byName, user), user);
  158. }
  159. FillSyncInfo(dto, item, options, user, syncProgress);
  160. return dto;
  161. }
  162. FillSyncInfo(dto, item, options, user, syncProgress);
  163. return dto;
  164. }
  165. private List<BaseItem> GetTaggedItems(IItemByName byName, User user)
  166. {
  167. var person = byName as Person;
  168. if (person != null)
  169. {
  170. var items = _libraryManager.GetItemList(new InternalItemsQuery(user)
  171. {
  172. Person = byName.Name
  173. }, new string[] { });
  174. return items.ToList();
  175. }
  176. var itemFilter = byName.GetItemFilter();
  177. return user != null ?
  178. user.RootFolder.GetRecursiveChildren(user, itemFilter).ToList() :
  179. _libraryManager.RootFolder.GetRecursiveChildren(itemFilter).ToList();
  180. }
  181. private SyncedItemProgress[] GetSyncedItemProgress(DtoOptions options)
  182. {
  183. if (!options.Fields.Contains(ItemFields.SyncInfo))
  184. {
  185. return new SyncedItemProgress[] { };
  186. }
  187. var deviceId = options.DeviceId;
  188. if (string.IsNullOrWhiteSpace(deviceId))
  189. {
  190. return new SyncedItemProgress[] { };
  191. }
  192. var caps = _deviceManager().GetCapabilities(deviceId);
  193. if (caps == null || !caps.SupportsSync)
  194. {
  195. return new SyncedItemProgress[] { };
  196. }
  197. return _syncManager.GetSyncedItemProgresses(new SyncJobItemQuery
  198. {
  199. TargetId = deviceId,
  200. Statuses = new[]
  201. {
  202. SyncJobItemStatus.Converting,
  203. SyncJobItemStatus.Queued,
  204. SyncJobItemStatus.Transferring,
  205. SyncJobItemStatus.ReadyToTransfer,
  206. SyncJobItemStatus.Synced
  207. }
  208. }).Items;
  209. }
  210. public void FillSyncInfo(IEnumerable<Tuple<BaseItem, BaseItemDto>> tuples, DtoOptions options, User user)
  211. {
  212. if (options.Fields.Contains(ItemFields.SyncInfo))
  213. {
  214. var syncProgress = GetSyncedItemProgress(options);
  215. foreach (var tuple in tuples)
  216. {
  217. var item = tuple.Item1;
  218. FillSyncInfo(tuple.Item2, item, syncProgress, options, user);
  219. }
  220. }
  221. }
  222. private void FillSyncInfo(IHasSyncInfo dto, BaseItem item, DtoOptions options, User user, SyncedItemProgress[] syncProgress)
  223. {
  224. if (options.Fields.Contains(ItemFields.SyncInfo))
  225. {
  226. var userCanSync = user != null && user.Policy.EnableSync;
  227. dto.SupportsSync = userCanSync && _syncManager.SupportsSync(item);
  228. }
  229. if (dto.SupportsSync ?? false)
  230. {
  231. dto.HasSyncJob = syncProgress.Any(i => i.Status != SyncJobItemStatus.Synced && string.Equals(i.ItemId, dto.Id, StringComparison.OrdinalIgnoreCase));
  232. dto.IsSynced = syncProgress.Any(i => i.Status == SyncJobItemStatus.Synced && string.Equals(i.ItemId, dto.Id, StringComparison.OrdinalIgnoreCase));
  233. if (dto.IsSynced.Value)
  234. {
  235. dto.SyncStatus = SyncJobItemStatus.Synced;
  236. }
  237. else if (dto.HasSyncJob.Value)
  238. {
  239. dto.SyncStatus = SyncJobItemStatus.Queued;
  240. }
  241. }
  242. }
  243. private void FillSyncInfo(IHasSyncInfo dto, BaseItem item, SyncedItemProgress[] syncProgress, DtoOptions options, User user)
  244. {
  245. if (options.Fields.Contains(ItemFields.SyncInfo))
  246. {
  247. var userCanSync = user != null && user.Policy.EnableSync;
  248. dto.SupportsSync = userCanSync && _syncManager.SupportsSync(item);
  249. }
  250. if (dto.SupportsSync ?? false)
  251. {
  252. dto.HasSyncJob = syncProgress.Any(i => i.Status != SyncJobItemStatus.Synced && string.Equals(i.ItemId, dto.Id, StringComparison.OrdinalIgnoreCase));
  253. dto.IsSynced = syncProgress.Any(i => i.Status == SyncJobItemStatus.Synced && string.Equals(i.ItemId, dto.Id, StringComparison.OrdinalIgnoreCase));
  254. if (dto.IsSynced.Value)
  255. {
  256. dto.SyncStatus = SyncJobItemStatus.Synced;
  257. }
  258. else if (dto.HasSyncJob.Value)
  259. {
  260. dto.SyncStatus = SyncJobItemStatus.Queued;
  261. }
  262. }
  263. }
  264. private BaseItemDto GetBaseItemDtoInternal(BaseItem item, DtoOptions options, Dictionary<string, SyncedItemProgress> syncProgress, User user = null, BaseItem owner = null)
  265. {
  266. var fields = options.Fields;
  267. if (item == null)
  268. {
  269. throw new ArgumentNullException("item");
  270. }
  271. if (fields == null)
  272. {
  273. throw new ArgumentNullException("fields");
  274. }
  275. var dto = new BaseItemDto
  276. {
  277. ServerId = _appHost.SystemId
  278. };
  279. if (item.SourceType == SourceType.Channel)
  280. {
  281. dto.SourceType = item.SourceType.ToString();
  282. }
  283. if (fields.Contains(ItemFields.People))
  284. {
  285. AttachPeople(dto, item);
  286. }
  287. if (fields.Contains(ItemFields.PrimaryImageAspectRatio))
  288. {
  289. try
  290. {
  291. AttachPrimaryImageAspectRatio(dto, item);
  292. }
  293. catch (Exception ex)
  294. {
  295. // Have to use a catch-all unfortunately because some .net image methods throw plain Exceptions
  296. _logger.ErrorException("Error generating PrimaryImageAspectRatio for {0}", ex, item.Name);
  297. }
  298. }
  299. if (fields.Contains(ItemFields.DisplayPreferencesId))
  300. {
  301. dto.DisplayPreferencesId = item.DisplayPreferencesId.ToString("N");
  302. }
  303. if (user != null)
  304. {
  305. AttachUserSpecificInfo(dto, item, user, fields, syncProgress);
  306. }
  307. var hasMediaSources = item as IHasMediaSources;
  308. if (hasMediaSources != null)
  309. {
  310. if (fields.Contains(ItemFields.MediaSources))
  311. {
  312. if (user == null)
  313. {
  314. dto.MediaSources = _mediaSourceManager().GetStaticMediaSources(hasMediaSources, true).ToList();
  315. }
  316. else
  317. {
  318. dto.MediaSources = _mediaSourceManager().GetStaticMediaSources(hasMediaSources, true, user).ToList();
  319. }
  320. }
  321. }
  322. if (fields.Contains(ItemFields.Studios))
  323. {
  324. AttachStudios(dto, item);
  325. }
  326. AttachBasicFields(dto, item, owner, options);
  327. var collectionFolder = item as ICollectionFolder;
  328. if (collectionFolder != null)
  329. {
  330. dto.OriginalCollectionType = collectionFolder.CollectionType;
  331. dto.CollectionType = user == null ?
  332. collectionFolder.CollectionType :
  333. collectionFolder.GetViewType(user);
  334. }
  335. var playlist = item as Playlist;
  336. if (playlist != null)
  337. {
  338. AttachLinkedChildImages(dto, playlist, user, options);
  339. }
  340. if (fields.Contains(ItemFields.CanDelete))
  341. {
  342. dto.CanDelete = user == null
  343. ? item.CanDelete()
  344. : item.CanDelete(user);
  345. }
  346. if (fields.Contains(ItemFields.CanDownload))
  347. {
  348. dto.CanDownload = user == null
  349. ? item.CanDownload()
  350. : item.CanDownload(user);
  351. }
  352. if (fields.Contains(ItemFields.Etag))
  353. {
  354. dto.Etag = item.GetEtag(user);
  355. }
  356. if (item is ILiveTvRecording)
  357. {
  358. _livetvManager().AddInfoToRecordingDto(item, dto, user);
  359. }
  360. return dto;
  361. }
  362. public BaseItemDto GetItemByNameDto(BaseItem item, DtoOptions options, List<BaseItem> taggedItems, User user = null)
  363. {
  364. var syncProgress = GetSyncedItemProgress(options);
  365. var dto = GetBaseItemDtoInternal(item, options, GetSyncedItemProgressDictionary(syncProgress), user);
  366. if (options.Fields.Contains(ItemFields.ItemCounts))
  367. {
  368. SetItemByNameInfo(item, dto, taggedItems, user);
  369. }
  370. FillSyncInfo(dto, item, options, user, syncProgress);
  371. return dto;
  372. }
  373. private void SetItemByNameInfo(BaseItem item, BaseItemDto dto, List<BaseItem> taggedItems, User user = null)
  374. {
  375. if (item is MusicArtist || item is MusicGenre)
  376. {
  377. dto.AlbumCount = taggedItems.Count(i => i is MusicAlbum);
  378. dto.MusicVideoCount = taggedItems.Count(i => i is MusicVideo);
  379. dto.SongCount = taggedItems.Count(i => i is Audio);
  380. }
  381. else if (item is GameGenre)
  382. {
  383. dto.GameCount = taggedItems.Count(i => i is Game);
  384. }
  385. else
  386. {
  387. // This populates them all and covers Genre, Person, Studio, Year
  388. dto.AlbumCount = taggedItems.Count(i => i is MusicAlbum);
  389. dto.EpisodeCount = taggedItems.Count(i => i is Episode);
  390. dto.GameCount = taggedItems.Count(i => i is Game);
  391. dto.MovieCount = taggedItems.Count(i => i is Movie);
  392. dto.TrailerCount = taggedItems.Count(i => i is Trailer);
  393. dto.MusicVideoCount = taggedItems.Count(i => i is MusicVideo);
  394. dto.SeriesCount = taggedItems.Count(i => i is Series);
  395. dto.SongCount = taggedItems.Count(i => i is Audio);
  396. }
  397. dto.ChildCount = taggedItems.Count;
  398. }
  399. /// <summary>
  400. /// Attaches the user specific info.
  401. /// </summary>
  402. /// <param name="dto">The dto.</param>
  403. /// <param name="item">The item.</param>
  404. /// <param name="user">The user.</param>
  405. /// <param name="fields">The fields.</param>
  406. /// <param name="syncProgress">The synchronize progress.</param>
  407. private void AttachUserSpecificInfo(BaseItemDto dto, BaseItem item, User user, List<ItemFields> fields, Dictionary<string, SyncedItemProgress> syncProgress)
  408. {
  409. if (item.IsFolder)
  410. {
  411. var userData = _userDataRepository.GetUserData(user.Id, item.GetUserDataKey());
  412. // Skip the user data manager because we've already looped through the recursive tree and don't want to do it twice
  413. // TODO: Improve in future
  414. dto.UserData = GetUserItemDataDto(userData);
  415. var folder = (Folder)item;
  416. if (item.SourceType == SourceType.Library)
  417. {
  418. dto.ChildCount = GetChildCount(folder, user);
  419. // These are just far too slow.
  420. if (!(folder is UserRootFolder) && !(folder is UserView) && !(folder is ICollectionFolder))
  421. {
  422. SetSpecialCounts(folder, user, dto, fields, syncProgress);
  423. }
  424. }
  425. dto.UserData.Played = dto.UserData.PlayedPercentage.HasValue && dto.UserData.PlayedPercentage.Value >= 100;
  426. }
  427. else
  428. {
  429. dto.UserData = _userDataRepository.GetUserDataDto(item, user);
  430. }
  431. dto.PlayAccess = item.GetPlayAccess(user);
  432. if (fields.Contains(ItemFields.SeasonUserData))
  433. {
  434. var episode = item as Episode;
  435. if (episode != null)
  436. {
  437. var season = episode.Season;
  438. if (season != null)
  439. {
  440. dto.SeasonUserData = _userDataRepository.GetUserDataDto(season, user);
  441. }
  442. }
  443. }
  444. var userView = item as UserView;
  445. if (userView != null)
  446. {
  447. dto.HasDynamicCategories = userView.ContainsDynamicCategories(user);
  448. }
  449. var collectionFolder = item as ICollectionFolder;
  450. if (collectionFolder != null)
  451. {
  452. dto.HasDynamicCategories = false;
  453. }
  454. }
  455. private int GetChildCount(Folder folder, User user)
  456. {
  457. return folder.GetChildren(user, true)
  458. .Count();
  459. }
  460. /// <summary>
  461. /// Gets client-side Id of a server-side BaseItem
  462. /// </summary>
  463. /// <param name="item">The item.</param>
  464. /// <returns>System.String.</returns>
  465. /// <exception cref="System.ArgumentNullException">item</exception>
  466. public string GetDtoId(BaseItem item)
  467. {
  468. if (item == null)
  469. {
  470. throw new ArgumentNullException("item");
  471. }
  472. return item.Id.ToString("N");
  473. }
  474. /// <summary>
  475. /// Converts a UserItemData to a DTOUserItemData
  476. /// </summary>
  477. /// <param name="data">The data.</param>
  478. /// <returns>DtoUserItemData.</returns>
  479. /// <exception cref="System.ArgumentNullException"></exception>
  480. public UserItemDataDto GetUserItemDataDto(UserItemData data)
  481. {
  482. if (data == null)
  483. {
  484. throw new ArgumentNullException("data");
  485. }
  486. return new UserItemDataDto
  487. {
  488. IsFavorite = data.IsFavorite,
  489. Likes = data.Likes,
  490. PlaybackPositionTicks = data.PlaybackPositionTicks,
  491. PlayCount = data.PlayCount,
  492. Rating = data.Rating,
  493. Played = data.Played,
  494. LastPlayedDate = data.LastPlayedDate,
  495. Key = data.Key
  496. };
  497. }
  498. private void SetBookProperties(BaseItemDto dto, Book item)
  499. {
  500. dto.SeriesName = item.SeriesName;
  501. }
  502. private void SetPhotoProperties(BaseItemDto dto, Photo item)
  503. {
  504. dto.Width = item.Width;
  505. dto.Height = item.Height;
  506. dto.CameraMake = item.CameraMake;
  507. dto.CameraModel = item.CameraModel;
  508. dto.Software = item.Software;
  509. dto.ExposureTime = item.ExposureTime;
  510. dto.FocalLength = item.FocalLength;
  511. dto.ImageOrientation = item.Orientation;
  512. dto.Aperture = item.Aperture;
  513. dto.ShutterSpeed = item.ShutterSpeed;
  514. dto.Latitude = item.Latitude;
  515. dto.Longitude = item.Longitude;
  516. dto.Altitude = item.Altitude;
  517. dto.IsoSpeedRating = item.IsoSpeedRating;
  518. var album = item.Album;
  519. if (album != null)
  520. {
  521. dto.Album = album.Name;
  522. dto.AlbumId = album.Id.ToString("N");
  523. }
  524. }
  525. private void SetMusicVideoProperties(BaseItemDto dto, MusicVideo item)
  526. {
  527. if (!string.IsNullOrEmpty(item.Album))
  528. {
  529. var parentAlbum = _libraryManager.RootFolder
  530. .GetRecursiveChildren(i => i is MusicAlbum && string.Equals(i.Name, item.Album, StringComparison.OrdinalIgnoreCase))
  531. .FirstOrDefault();
  532. if (parentAlbum != null)
  533. {
  534. dto.AlbumId = GetDtoId(parentAlbum);
  535. }
  536. }
  537. dto.Album = item.Album;
  538. }
  539. private void SetGameProperties(BaseItemDto dto, Game item)
  540. {
  541. dto.Players = item.PlayersSupported;
  542. dto.GameSystem = item.GameSystem;
  543. dto.MultiPartGameFiles = item.MultiPartGameFiles;
  544. }
  545. private void SetGameSystemProperties(BaseItemDto dto, GameSystem item)
  546. {
  547. dto.GameSystem = item.GameSystemName;
  548. }
  549. private List<string> GetBackdropImageTags(BaseItem item, int limit)
  550. {
  551. return GetCacheTags(item, ImageType.Backdrop, limit).ToList();
  552. }
  553. private List<string> GetScreenshotImageTags(BaseItem item, int limit)
  554. {
  555. var hasScreenshots = item as IHasScreenshots;
  556. if (hasScreenshots == null)
  557. {
  558. return new List<string>();
  559. }
  560. return GetCacheTags(item, ImageType.Screenshot, limit).ToList();
  561. }
  562. private IEnumerable<string> GetCacheTags(BaseItem item, ImageType type, int limit)
  563. {
  564. return item.GetImages(type)
  565. // Convert to a list now in case GetImageCacheTag is slow
  566. .ToList()
  567. .Select(p => GetImageCacheTag(item, p))
  568. .Where(i => i != null)
  569. .Take(limit)
  570. .ToList();
  571. }
  572. private string GetImageCacheTag(BaseItem item, ImageType type)
  573. {
  574. try
  575. {
  576. return _imageProcessor.GetImageCacheTag(item, type);
  577. }
  578. catch (Exception ex)
  579. {
  580. _logger.ErrorException("Error getting {0} image info", ex, type);
  581. return null;
  582. }
  583. }
  584. private string GetImageCacheTag(BaseItem item, ItemImageInfo image)
  585. {
  586. try
  587. {
  588. return _imageProcessor.GetImageCacheTag(item, image);
  589. }
  590. catch (Exception ex)
  591. {
  592. _logger.ErrorException("Error getting {0} image info for {1}", ex, image.Type, image.Path);
  593. return null;
  594. }
  595. }
  596. /// <summary>
  597. /// Attaches People DTO's to a DTOBaseItem
  598. /// </summary>
  599. /// <param name="dto">The dto.</param>
  600. /// <param name="item">The item.</param>
  601. /// <returns>Task.</returns>
  602. private void AttachPeople(BaseItemDto dto, BaseItem item)
  603. {
  604. // Ordering by person type to ensure actors and artists are at the front.
  605. // This is taking advantage of the fact that they both begin with A
  606. // This should be improved in the future
  607. var people = _libraryManager.GetPeople(item).OrderBy(i => i.SortOrder ?? int.MaxValue)
  608. .ThenBy(i =>
  609. {
  610. if (i.IsType(PersonType.Actor))
  611. {
  612. return 0;
  613. }
  614. if (i.IsType(PersonType.GuestStar))
  615. {
  616. return 1;
  617. }
  618. if (i.IsType(PersonType.Director))
  619. {
  620. return 2;
  621. }
  622. if (i.IsType(PersonType.Writer))
  623. {
  624. return 3;
  625. }
  626. if (i.IsType(PersonType.Producer))
  627. {
  628. return 4;
  629. }
  630. if (i.IsType(PersonType.Composer))
  631. {
  632. return 4;
  633. }
  634. return 10;
  635. })
  636. .ToList();
  637. var list = new List<BaseItemPerson>();
  638. var dictionary = people.Select(p => p.Name)
  639. .Distinct(StringComparer.OrdinalIgnoreCase).Select(c =>
  640. {
  641. try
  642. {
  643. return _libraryManager.GetPerson(c);
  644. }
  645. catch (Exception ex)
  646. {
  647. _logger.ErrorException("Error getting person {0}", ex, c);
  648. return null;
  649. }
  650. }).Where(i => i != null)
  651. .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  652. .ToDictionary(i => i.Name, StringComparer.OrdinalIgnoreCase);
  653. for (var i = 0; i < people.Count; i++)
  654. {
  655. var person = people[i];
  656. var baseItemPerson = new BaseItemPerson
  657. {
  658. Name = person.Name,
  659. Role = person.Role,
  660. Type = person.Type
  661. };
  662. Person entity;
  663. if (dictionary.TryGetValue(person.Name, out entity))
  664. {
  665. baseItemPerson.PrimaryImageTag = GetImageCacheTag(entity, ImageType.Primary);
  666. baseItemPerson.Id = entity.Id.ToString("N");
  667. list.Add(baseItemPerson);
  668. }
  669. }
  670. dto.People = list.ToArray();
  671. }
  672. /// <summary>
  673. /// Attaches the studios.
  674. /// </summary>
  675. /// <param name="dto">The dto.</param>
  676. /// <param name="item">The item.</param>
  677. /// <returns>Task.</returns>
  678. private void AttachStudios(BaseItemDto dto, BaseItem item)
  679. {
  680. var studios = item.Studios.ToList();
  681. dto.Studios = new StudioDto[studios.Count];
  682. var dictionary = studios.Distinct(StringComparer.OrdinalIgnoreCase).Select(name =>
  683. {
  684. try
  685. {
  686. return _libraryManager.GetStudio(name);
  687. }
  688. catch (IOException ex)
  689. {
  690. _logger.ErrorException("Error getting studio {0}", ex, name);
  691. return null;
  692. }
  693. })
  694. .Where(i => i != null)
  695. .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  696. .ToDictionary(i => i.Name, StringComparer.OrdinalIgnoreCase);
  697. for (var i = 0; i < studios.Count; i++)
  698. {
  699. var studio = studios[i];
  700. var studioDto = new StudioDto
  701. {
  702. Name = studio
  703. };
  704. Studio entity;
  705. if (dictionary.TryGetValue(studio, out entity))
  706. {
  707. studioDto.Id = entity.Id.ToString("N");
  708. studioDto.PrimaryImageTag = GetImageCacheTag(entity, ImageType.Primary);
  709. }
  710. dto.Studios[i] = studioDto;
  711. }
  712. }
  713. /// <summary>
  714. /// If an item does not any backdrops, this can be used to find the first parent that does have one
  715. /// </summary>
  716. /// <param name="item">The item.</param>
  717. /// <param name="owner">The owner.</param>
  718. /// <returns>BaseItem.</returns>
  719. private BaseItem GetParentBackdropItem(BaseItem item, BaseItem owner)
  720. {
  721. var parent = item.GetParent() ?? owner;
  722. while (parent != null)
  723. {
  724. if (parent.GetImages(ImageType.Backdrop).Any())
  725. {
  726. return parent;
  727. }
  728. parent = parent.GetParent();
  729. }
  730. return null;
  731. }
  732. /// <summary>
  733. /// If an item does not have a logo, this can be used to find the first parent that does have one
  734. /// </summary>
  735. /// <param name="item">The item.</param>
  736. /// <param name="type">The type.</param>
  737. /// <param name="owner">The owner.</param>
  738. /// <returns>BaseItem.</returns>
  739. private BaseItem GetParentImageItem(BaseItem item, ImageType type, BaseItem owner)
  740. {
  741. var parent = item.GetParent() ?? owner;
  742. while (parent != null)
  743. {
  744. if (parent.HasImage(type))
  745. {
  746. return parent;
  747. }
  748. parent = parent.GetParent();
  749. }
  750. return null;
  751. }
  752. /// <summary>
  753. /// Gets the chapter info dto.
  754. /// </summary>
  755. /// <param name="chapterInfo">The chapter info.</param>
  756. /// <param name="item">The item.</param>
  757. /// <returns>ChapterInfoDto.</returns>
  758. private ChapterInfoDto GetChapterInfoDto(ChapterInfo chapterInfo, BaseItem item)
  759. {
  760. var dto = new ChapterInfoDto
  761. {
  762. Name = chapterInfo.Name,
  763. StartPositionTicks = chapterInfo.StartPositionTicks
  764. };
  765. if (!string.IsNullOrEmpty(chapterInfo.ImagePath))
  766. {
  767. dto.ImageTag = GetImageCacheTag(item, new ItemImageInfo
  768. {
  769. Path = chapterInfo.ImagePath,
  770. Type = ImageType.Chapter,
  771. DateModified = _fileSystem.GetLastWriteTimeUtc(chapterInfo.ImagePath)
  772. });
  773. }
  774. return dto;
  775. }
  776. public List<ChapterInfoDto> GetChapterInfoDtos(BaseItem item)
  777. {
  778. return _itemRepo.GetChapters(item.Id)
  779. .Select(c => GetChapterInfoDto(c, item))
  780. .ToList();
  781. }
  782. /// <summary>
  783. /// Sets simple property values on a DTOBaseItem
  784. /// </summary>
  785. /// <param name="dto">The dto.</param>
  786. /// <param name="item">The item.</param>
  787. /// <param name="owner">The owner.</param>
  788. /// <param name="options">The options.</param>
  789. private void AttachBasicFields(BaseItemDto dto, BaseItem item, BaseItem owner, DtoOptions options)
  790. {
  791. var fields = options.Fields;
  792. if (fields.Contains(ItemFields.DateCreated))
  793. {
  794. dto.DateCreated = item.DateCreated;
  795. }
  796. if (fields.Contains(ItemFields.DisplayMediaType))
  797. {
  798. dto.DisplayMediaType = item.DisplayMediaType;
  799. }
  800. if (fields.Contains(ItemFields.Settings))
  801. {
  802. dto.LockedFields = item.LockedFields;
  803. dto.LockData = item.IsLocked;
  804. dto.ForcedSortName = item.ForcedSortName;
  805. }
  806. var hasBudget = item as IHasBudget;
  807. if (hasBudget != null)
  808. {
  809. if (fields.Contains(ItemFields.Budget))
  810. {
  811. dto.Budget = hasBudget.Budget;
  812. }
  813. if (fields.Contains(ItemFields.Revenue))
  814. {
  815. dto.Revenue = hasBudget.Revenue;
  816. }
  817. }
  818. dto.EndDate = item.EndDate;
  819. if (fields.Contains(ItemFields.HomePageUrl))
  820. {
  821. dto.HomePageUrl = item.HomePageUrl;
  822. }
  823. if (fields.Contains(ItemFields.ExternalUrls))
  824. {
  825. dto.ExternalUrls = _providerManager.GetExternalUrls(item).ToArray();
  826. }
  827. if (fields.Contains(ItemFields.Tags))
  828. {
  829. var hasTags = item as IHasTags;
  830. if (hasTags != null)
  831. {
  832. dto.Tags = hasTags.Tags;
  833. }
  834. if (dto.Tags == null)
  835. {
  836. dto.Tags = new List<string>();
  837. }
  838. }
  839. if (fields.Contains(ItemFields.Keywords))
  840. {
  841. var hasTags = item as IHasKeywords;
  842. if (hasTags != null)
  843. {
  844. dto.Keywords = hasTags.Keywords;
  845. }
  846. if (dto.Keywords == null)
  847. {
  848. dto.Keywords = new List<string>();
  849. }
  850. }
  851. if (fields.Contains(ItemFields.ProductionLocations))
  852. {
  853. SetProductionLocations(item, dto);
  854. }
  855. var hasAspectRatio = item as IHasAspectRatio;
  856. if (hasAspectRatio != null)
  857. {
  858. dto.AspectRatio = hasAspectRatio.AspectRatio;
  859. }
  860. if (fields.Contains(ItemFields.Metascore))
  861. {
  862. var hasMetascore = item as IHasMetascore;
  863. if (hasMetascore != null)
  864. {
  865. dto.Metascore = hasMetascore.Metascore;
  866. }
  867. }
  868. if (fields.Contains(ItemFields.AwardSummary))
  869. {
  870. var hasAwards = item as IHasAwards;
  871. if (hasAwards != null)
  872. {
  873. dto.AwardSummary = hasAwards.AwardSummary;
  874. }
  875. }
  876. var backdropLimit = options.GetImageLimit(ImageType.Backdrop);
  877. if (backdropLimit > 0)
  878. {
  879. dto.BackdropImageTags = GetBackdropImageTags(item, backdropLimit);
  880. }
  881. if (fields.Contains(ItemFields.ScreenshotImageTags))
  882. {
  883. var screenshotLimit = options.GetImageLimit(ImageType.Screenshot);
  884. if (screenshotLimit > 0)
  885. {
  886. dto.ScreenshotImageTags = GetScreenshotImageTags(item, screenshotLimit);
  887. }
  888. }
  889. if (fields.Contains(ItemFields.Genres))
  890. {
  891. dto.Genres = item.Genres;
  892. }
  893. dto.ImageTags = new Dictionary<ImageType, string>();
  894. // Prevent implicitly captured closure
  895. var currentItem = item;
  896. foreach (var image in currentItem.ImageInfos.Where(i => !currentItem.AllowsMultipleImages(i.Type))
  897. .ToList())
  898. {
  899. if (options.GetImageLimit(image.Type) > 0)
  900. {
  901. var tag = GetImageCacheTag(item, image);
  902. if (tag != null)
  903. {
  904. dto.ImageTags[image.Type] = tag;
  905. }
  906. }
  907. }
  908. dto.Id = GetDtoId(item);
  909. dto.IndexNumber = item.IndexNumber;
  910. dto.IsFolder = item.IsFolder;
  911. dto.MediaType = item.MediaType;
  912. dto.LocationType = item.LocationType;
  913. if (item.IsHD.HasValue && item.IsHD.Value)
  914. {
  915. dto.IsHD = item.IsHD;
  916. }
  917. dto.Audio = item.Audio;
  918. dto.PreferredMetadataCountryCode = item.PreferredMetadataCountryCode;
  919. dto.PreferredMetadataLanguage = item.PreferredMetadataLanguage;
  920. var hasCriticRating = item as IHasCriticRating;
  921. if (hasCriticRating != null)
  922. {
  923. dto.CriticRating = hasCriticRating.CriticRating;
  924. if (fields.Contains(ItemFields.CriticRatingSummary))
  925. {
  926. dto.CriticRatingSummary = hasCriticRating.CriticRatingSummary;
  927. }
  928. }
  929. var hasTrailers = item as IHasTrailers;
  930. if (hasTrailers != null)
  931. {
  932. dto.LocalTrailerCount = hasTrailers.GetTrailerIds().Count;
  933. }
  934. var hasDisplayOrder = item as IHasDisplayOrder;
  935. if (hasDisplayOrder != null)
  936. {
  937. dto.DisplayOrder = hasDisplayOrder.DisplayOrder;
  938. }
  939. var userView = item as UserView;
  940. if (userView != null)
  941. {
  942. dto.CollectionType = userView.ViewType;
  943. }
  944. if (fields.Contains(ItemFields.RemoteTrailers))
  945. {
  946. dto.RemoteTrailers = hasTrailers != null ?
  947. hasTrailers.RemoteTrailers :
  948. new List<MediaUrl>();
  949. }
  950. dto.Name = item.Name;
  951. dto.OfficialRating = item.OfficialRating;
  952. if (fields.Contains(ItemFields.Overview))
  953. {
  954. dto.Overview = item.Overview;
  955. }
  956. if (fields.Contains(ItemFields.ShortOverview))
  957. {
  958. var hasShortOverview = item as IHasShortOverview;
  959. if (hasShortOverview != null)
  960. {
  961. dto.ShortOverview = hasShortOverview.ShortOverview;
  962. }
  963. }
  964. // If there are no backdrops, indicate what parent has them in case the Ui wants to allow inheritance
  965. if (backdropLimit > 0 && dto.BackdropImageTags.Count == 0)
  966. {
  967. var parentWithBackdrop = GetParentBackdropItem(item, owner);
  968. if (parentWithBackdrop != null)
  969. {
  970. dto.ParentBackdropItemId = GetDtoId(parentWithBackdrop);
  971. dto.ParentBackdropImageTags = GetBackdropImageTags(parentWithBackdrop, backdropLimit);
  972. }
  973. }
  974. if (fields.Contains(ItemFields.ParentId))
  975. {
  976. var displayParent = item.DisplayParent;
  977. if (displayParent != null)
  978. {
  979. dto.ParentId = GetDtoId(displayParent);
  980. }
  981. }
  982. dto.ParentIndexNumber = item.ParentIndexNumber;
  983. // If there is no logo, indicate what parent has one in case the Ui wants to allow inheritance
  984. if (!dto.HasLogo && options.GetImageLimit(ImageType.Logo) > 0)
  985. {
  986. var parentWithLogo = GetParentImageItem(item, ImageType.Logo, owner);
  987. if (parentWithLogo != null)
  988. {
  989. dto.ParentLogoItemId = GetDtoId(parentWithLogo);
  990. dto.ParentLogoImageTag = GetImageCacheTag(parentWithLogo, ImageType.Logo);
  991. }
  992. }
  993. // If there is no art, indicate what parent has one in case the Ui wants to allow inheritance
  994. if (!dto.HasArtImage && options.GetImageLimit(ImageType.Art) > 0)
  995. {
  996. var parentWithImage = GetParentImageItem(item, ImageType.Art, owner);
  997. if (parentWithImage != null)
  998. {
  999. dto.ParentArtItemId = GetDtoId(parentWithImage);
  1000. dto.ParentArtImageTag = GetImageCacheTag(parentWithImage, ImageType.Art);
  1001. }
  1002. }
  1003. // If there is no thumb, indicate what parent has one in case the Ui wants to allow inheritance
  1004. if (!dto.HasThumb && options.GetImageLimit(ImageType.Thumb) > 0)
  1005. {
  1006. var parentWithImage = GetParentImageItem(item, ImageType.Thumb, owner);
  1007. if (parentWithImage != null)
  1008. {
  1009. dto.ParentThumbItemId = GetDtoId(parentWithImage);
  1010. dto.ParentThumbImageTag = GetImageCacheTag(parentWithImage, ImageType.Thumb);
  1011. }
  1012. }
  1013. if (fields.Contains(ItemFields.Path))
  1014. {
  1015. dto.Path = GetMappedPath(item);
  1016. }
  1017. dto.PremiereDate = item.PremiereDate;
  1018. dto.ProductionYear = item.ProductionYear;
  1019. if (fields.Contains(ItemFields.ProviderIds))
  1020. {
  1021. dto.ProviderIds = item.ProviderIds;
  1022. }
  1023. dto.RunTimeTicks = item.RunTimeTicks;
  1024. if (fields.Contains(ItemFields.SortName))
  1025. {
  1026. dto.SortName = item.SortName;
  1027. }
  1028. if (fields.Contains(ItemFields.CustomRating))
  1029. {
  1030. dto.CustomRating = item.CustomRating;
  1031. }
  1032. if (fields.Contains(ItemFields.Taglines))
  1033. {
  1034. var hasTagline = item as IHasTaglines;
  1035. if (hasTagline != null)
  1036. {
  1037. dto.Taglines = hasTagline.Taglines;
  1038. }
  1039. if (dto.Taglines == null)
  1040. {
  1041. dto.Taglines = new List<string>();
  1042. }
  1043. }
  1044. dto.Type = item.GetClientTypeName();
  1045. dto.CommunityRating = item.CommunityRating;
  1046. if (fields.Contains(ItemFields.VoteCount))
  1047. {
  1048. dto.VoteCount = item.VoteCount;
  1049. }
  1050. //if (item.IsFolder)
  1051. //{
  1052. // var folder = (Folder)item;
  1053. // if (fields.Contains(ItemFields.IndexOptions))
  1054. // {
  1055. // dto.IndexOptions = folder.IndexByOptionStrings.ToArray();
  1056. // }
  1057. //}
  1058. var supportsPlaceHolders = item as ISupportsPlaceHolders;
  1059. if (supportsPlaceHolders != null)
  1060. {
  1061. dto.IsPlaceHolder = supportsPlaceHolders.IsPlaceHolder;
  1062. }
  1063. // Add audio info
  1064. var audio = item as Audio;
  1065. if (audio != null)
  1066. {
  1067. dto.Album = audio.Album;
  1068. dto.ExtraType = audio.ExtraType;
  1069. var albumParent = audio.AlbumEntity;
  1070. if (albumParent != null)
  1071. {
  1072. dto.AlbumId = GetDtoId(albumParent);
  1073. dto.AlbumPrimaryImageTag = GetImageCacheTag(albumParent, ImageType.Primary);
  1074. }
  1075. //if (fields.Contains(ItemFields.MediaSourceCount))
  1076. //{
  1077. // Songs always have one
  1078. //}
  1079. }
  1080. var hasArtist = item as IHasArtist;
  1081. if (hasArtist != null)
  1082. {
  1083. dto.Artists = hasArtist.Artists;
  1084. dto.ArtistItems = hasArtist
  1085. .Artists
  1086. .Select(i =>
  1087. {
  1088. try
  1089. {
  1090. var artist = _libraryManager.GetArtist(i);
  1091. return new NameIdPair
  1092. {
  1093. Name = artist.Name,
  1094. Id = artist.Id.ToString("N")
  1095. };
  1096. }
  1097. catch (Exception ex)
  1098. {
  1099. _logger.ErrorException("Error getting artist", ex);
  1100. return null;
  1101. }
  1102. })
  1103. .Where(i => i != null)
  1104. .ToList();
  1105. }
  1106. var hasAlbumArtist = item as IHasAlbumArtist;
  1107. if (hasAlbumArtist != null)
  1108. {
  1109. dto.AlbumArtist = hasAlbumArtist.AlbumArtists.FirstOrDefault();
  1110. dto.AlbumArtists = hasAlbumArtist
  1111. .AlbumArtists
  1112. .Select(i =>
  1113. {
  1114. try
  1115. {
  1116. var artist = _libraryManager.GetArtist(i);
  1117. return new NameIdPair
  1118. {
  1119. Name = artist.Name,
  1120. Id = artist.Id.ToString("N")
  1121. };
  1122. }
  1123. catch (Exception ex)
  1124. {
  1125. _logger.ErrorException("Error getting album artist", ex);
  1126. return null;
  1127. }
  1128. })
  1129. .Where(i => i != null)
  1130. .ToList();
  1131. }
  1132. // Add video info
  1133. var video = item as Video;
  1134. if (video != null)
  1135. {
  1136. dto.VideoType = video.VideoType;
  1137. dto.Video3DFormat = video.Video3DFormat;
  1138. dto.IsoType = video.IsoType;
  1139. if (video.HasSubtitles)
  1140. {
  1141. dto.HasSubtitles = video.HasSubtitles;
  1142. }
  1143. if (video.AdditionalParts.Count != 0)
  1144. {
  1145. dto.PartCount = video.AdditionalParts.Count + 1;
  1146. }
  1147. if (fields.Contains(ItemFields.MediaSourceCount))
  1148. {
  1149. if (video.MediaSourceCount != 1)
  1150. {
  1151. dto.MediaSourceCount = video.MediaSourceCount;
  1152. }
  1153. }
  1154. if (fields.Contains(ItemFields.Chapters))
  1155. {
  1156. dto.Chapters = GetChapterInfoDtos(item);
  1157. }
  1158. dto.ExtraType = video.ExtraType;
  1159. }
  1160. if (fields.Contains(ItemFields.MediaStreams))
  1161. {
  1162. // Add VideoInfo
  1163. var iHasMediaSources = item as IHasMediaSources;
  1164. if (iHasMediaSources != null)
  1165. {
  1166. List<MediaStream> mediaStreams;
  1167. if (dto.MediaSources != null && dto.MediaSources.Count > 0)
  1168. {
  1169. mediaStreams = dto.MediaSources.Where(i => new Guid(i.Id) == item.Id)
  1170. .SelectMany(i => i.MediaStreams)
  1171. .ToList();
  1172. }
  1173. else
  1174. {
  1175. mediaStreams = _mediaSourceManager().GetStaticMediaSources(iHasMediaSources, true).First().MediaStreams;
  1176. }
  1177. dto.MediaStreams = mediaStreams;
  1178. }
  1179. }
  1180. var hasSpecialFeatures = item as IHasSpecialFeatures;
  1181. if (hasSpecialFeatures != null)
  1182. {
  1183. var specialFeatureCount = hasSpecialFeatures.SpecialFeatureIds.Count;
  1184. if (specialFeatureCount > 0)
  1185. {
  1186. dto.SpecialFeatureCount = specialFeatureCount;
  1187. }
  1188. }
  1189. // Add EpisodeInfo
  1190. var episode = item as Episode;
  1191. if (episode != null)
  1192. {
  1193. dto.IndexNumberEnd = episode.IndexNumberEnd;
  1194. if (fields.Contains(ItemFields.AlternateEpisodeNumbers))
  1195. {
  1196. dto.DvdSeasonNumber = episode.DvdSeasonNumber;
  1197. dto.DvdEpisodeNumber = episode.DvdEpisodeNumber;
  1198. dto.AbsoluteEpisodeNumber = episode.AbsoluteEpisodeNumber;
  1199. }
  1200. if (fields.Contains(ItemFields.SpecialEpisodeNumbers))
  1201. {
  1202. dto.AirsAfterSeasonNumber = episode.AirsAfterSeasonNumber;
  1203. dto.AirsBeforeEpisodeNumber = episode.AirsBeforeEpisodeNumber;
  1204. dto.AirsBeforeSeasonNumber = episode.AirsBeforeSeasonNumber;
  1205. }
  1206. var episodeSeason = episode.Season;
  1207. if (episodeSeason != null)
  1208. {
  1209. dto.SeasonId = episodeSeason.Id.ToString("N");
  1210. if (fields.Contains(ItemFields.SeasonName))
  1211. {
  1212. dto.SeasonName = episodeSeason.Name;
  1213. }
  1214. }
  1215. if (fields.Contains(ItemFields.SeriesGenres))
  1216. {
  1217. var episodeseries = episode.Series;
  1218. if (episodeseries != null)
  1219. {
  1220. dto.SeriesGenres = episodeseries.Genres.ToList();
  1221. }
  1222. }
  1223. }
  1224. // Add SeriesInfo
  1225. var series = item as Series;
  1226. if (series != null)
  1227. {
  1228. dto.AirDays = series.AirDays;
  1229. dto.AirTime = series.AirTime;
  1230. dto.SeriesStatus = series.Status;
  1231. if (fields.Contains(ItemFields.Settings))
  1232. {
  1233. dto.DisplaySpecialsWithSeasons = series.DisplaySpecialsWithSeasons;
  1234. }
  1235. dto.AnimeSeriesIndex = series.AnimeSeriesIndex;
  1236. }
  1237. if (episode != null)
  1238. {
  1239. series = episode.Series;
  1240. if (series != null)
  1241. {
  1242. dto.SeriesId = GetDtoId(series);
  1243. dto.SeriesName = series.Name;
  1244. if (fields.Contains(ItemFields.AirTime))
  1245. {
  1246. dto.AirTime = series.AirTime;
  1247. }
  1248. if (options.GetImageLimit(ImageType.Thumb) > 0)
  1249. {
  1250. dto.SeriesThumbImageTag = GetImageCacheTag(series, ImageType.Thumb);
  1251. }
  1252. if (options.GetImageLimit(ImageType.Primary) > 0)
  1253. {
  1254. dto.SeriesPrimaryImageTag = GetImageCacheTag(series, ImageType.Primary);
  1255. }
  1256. if (fields.Contains(ItemFields.SeriesStudio))
  1257. {
  1258. dto.SeriesStudio = series.Studios.FirstOrDefault();
  1259. }
  1260. }
  1261. }
  1262. // Add SeasonInfo
  1263. var season = item as Season;
  1264. if (season != null)
  1265. {
  1266. series = season.Series;
  1267. if (series != null)
  1268. {
  1269. dto.SeriesId = GetDtoId(series);
  1270. dto.SeriesName = series.Name;
  1271. dto.AirTime = series.AirTime;
  1272. dto.SeriesStudio = series.Studios.FirstOrDefault();
  1273. if (options.GetImageLimit(ImageType.Primary) > 0)
  1274. {
  1275. dto.SeriesPrimaryImageTag = GetImageCacheTag(series, ImageType.Primary);
  1276. }
  1277. }
  1278. }
  1279. var game = item as Game;
  1280. if (game != null)
  1281. {
  1282. SetGameProperties(dto, game);
  1283. }
  1284. var gameSystem = item as GameSystem;
  1285. if (gameSystem != null)
  1286. {
  1287. SetGameSystemProperties(dto, gameSystem);
  1288. }
  1289. var musicVideo = item as MusicVideo;
  1290. if (musicVideo != null)
  1291. {
  1292. SetMusicVideoProperties(dto, musicVideo);
  1293. }
  1294. var book = item as Book;
  1295. if (book != null)
  1296. {
  1297. SetBookProperties(dto, book);
  1298. }
  1299. var photo = item as Photo;
  1300. if (photo != null)
  1301. {
  1302. SetPhotoProperties(dto, photo);
  1303. }
  1304. dto.ChannelId = item.ChannelId;
  1305. if (item.SourceType == SourceType.Channel && !string.IsNullOrWhiteSpace(item.ChannelId))
  1306. {
  1307. var channel = _libraryManager.GetItemById(item.ChannelId);
  1308. if (channel != null)
  1309. {
  1310. dto.ChannelName = channel.Name;
  1311. }
  1312. }
  1313. }
  1314. private void AttachLinkedChildImages(BaseItemDto dto, Folder folder, User user, DtoOptions options)
  1315. {
  1316. List<BaseItem> linkedChildren = null;
  1317. var backdropLimit = options.GetImageLimit(ImageType.Backdrop);
  1318. if (backdropLimit > 0 && dto.BackdropImageTags.Count == 0)
  1319. {
  1320. linkedChildren = user == null
  1321. ? folder.GetRecursiveChildren().ToList()
  1322. : folder.GetRecursiveChildren(user).ToList();
  1323. var parentWithBackdrop = linkedChildren.FirstOrDefault(i => i.GetImages(ImageType.Backdrop).Any());
  1324. if (parentWithBackdrop != null)
  1325. {
  1326. dto.ParentBackdropItemId = GetDtoId(parentWithBackdrop);
  1327. dto.ParentBackdropImageTags = GetBackdropImageTags(parentWithBackdrop, backdropLimit);
  1328. }
  1329. }
  1330. if (!dto.ImageTags.ContainsKey(ImageType.Primary) && options.GetImageLimit(ImageType.Primary) > 0)
  1331. {
  1332. if (linkedChildren == null)
  1333. {
  1334. linkedChildren = user == null
  1335. ? folder.GetRecursiveChildren().ToList()
  1336. : folder.GetRecursiveChildren(user).ToList();
  1337. }
  1338. var parentWithImage = linkedChildren.FirstOrDefault(i => i.GetImages(ImageType.Primary).Any());
  1339. if (parentWithImage != null)
  1340. {
  1341. dto.ParentPrimaryImageItemId = GetDtoId(parentWithImage);
  1342. dto.ParentPrimaryImageTag = GetImageCacheTag(parentWithImage, ImageType.Primary);
  1343. }
  1344. }
  1345. }
  1346. private string GetMappedPath(IHasMetadata item)
  1347. {
  1348. var path = item.Path;
  1349. var locationType = item.LocationType;
  1350. if (locationType == LocationType.FileSystem || locationType == LocationType.Offline)
  1351. {
  1352. foreach (var map in _config.Configuration.PathSubstitutions)
  1353. {
  1354. path = _libraryManager.SubstitutePath(path, map.From, map.To);
  1355. }
  1356. }
  1357. return path;
  1358. }
  1359. private void SetProductionLocations(BaseItem item, BaseItemDto dto)
  1360. {
  1361. var hasProductionLocations = item as IHasProductionLocations;
  1362. if (hasProductionLocations != null)
  1363. {
  1364. dto.ProductionLocations = hasProductionLocations.ProductionLocations;
  1365. }
  1366. var person = item as Person;
  1367. if (person != null)
  1368. {
  1369. dto.ProductionLocations = new List<string>();
  1370. if (!string.IsNullOrEmpty(person.PlaceOfBirth))
  1371. {
  1372. dto.ProductionLocations.Add(person.PlaceOfBirth);
  1373. }
  1374. }
  1375. if (dto.ProductionLocations == null)
  1376. {
  1377. dto.ProductionLocations = new List<string>();
  1378. }
  1379. }
  1380. /// <summary>
  1381. /// Since it can be slow to make all of these calculations independently, this method will provide a way to do them all at once
  1382. /// </summary>
  1383. /// <param name="folder">The folder.</param>
  1384. /// <param name="user">The user.</param>
  1385. /// <param name="dto">The dto.</param>
  1386. /// <param name="fields">The fields.</param>
  1387. /// <param name="syncProgress">The synchronize progress.</param>
  1388. /// <returns>Task.</returns>
  1389. private void SetSpecialCounts(Folder folder, User user, BaseItemDto dto, List<ItemFields> fields, Dictionary<string, SyncedItemProgress> syncProgress)
  1390. {
  1391. var recursiveItemCount = 0;
  1392. var unplayed = 0;
  1393. long runtime = 0;
  1394. DateTime? dateLastMediaAdded = null;
  1395. double totalPercentPlayed = 0;
  1396. double totalSyncPercent = 0;
  1397. var addSyncInfo = fields.Contains(ItemFields.SyncInfo);
  1398. var children = folder.GetItems(new InternalItemsQuery
  1399. {
  1400. IsFolder = false,
  1401. Recursive = true,
  1402. ExcludeLocationTypes = new[] { LocationType.Virtual },
  1403. User = user
  1404. }).Result.Items;
  1405. // Loop through each recursive child
  1406. foreach (var child in children)
  1407. {
  1408. if (!dateLastMediaAdded.HasValue)
  1409. {
  1410. dateLastMediaAdded = child.DateCreated;
  1411. }
  1412. else
  1413. {
  1414. dateLastMediaAdded = new[] { dateLastMediaAdded.Value, child.DateCreated }.Max();
  1415. }
  1416. var userdata = _userDataRepository.GetUserData(user.Id, child.GetUserDataKey());
  1417. recursiveItemCount++;
  1418. var isUnplayed = true;
  1419. // Incrememt totalPercentPlayed
  1420. if (userdata != null)
  1421. {
  1422. if (userdata.Played)
  1423. {
  1424. totalPercentPlayed += 100;
  1425. isUnplayed = false;
  1426. }
  1427. else if (userdata.PlaybackPositionTicks > 0 && child.RunTimeTicks.HasValue && child.RunTimeTicks.Value > 0)
  1428. {
  1429. double itemPercent = userdata.PlaybackPositionTicks;
  1430. itemPercent /= child.RunTimeTicks.Value;
  1431. totalPercentPlayed += itemPercent;
  1432. }
  1433. }
  1434. if (isUnplayed)
  1435. {
  1436. unplayed++;
  1437. }
  1438. runtime += child.RunTimeTicks ?? 0;
  1439. if (addSyncInfo)
  1440. {
  1441. double percent = 0;
  1442. SyncedItemProgress syncItemProgress;
  1443. if (syncProgress.TryGetValue(child.Id.ToString("N"), out syncItemProgress))
  1444. {
  1445. switch (syncItemProgress.Status)
  1446. {
  1447. case SyncJobItemStatus.Synced:
  1448. percent = 100;
  1449. break;
  1450. case SyncJobItemStatus.Converting:
  1451. case SyncJobItemStatus.ReadyToTransfer:
  1452. case SyncJobItemStatus.Transferring:
  1453. percent = 50;
  1454. break;
  1455. }
  1456. }
  1457. totalSyncPercent += percent;
  1458. }
  1459. }
  1460. dto.RecursiveItemCount = recursiveItemCount;
  1461. dto.UserData.UnplayedItemCount = unplayed;
  1462. if (recursiveItemCount > 0)
  1463. {
  1464. dto.UserData.PlayedPercentage = totalPercentPlayed / recursiveItemCount;
  1465. if (addSyncInfo)
  1466. {
  1467. var pct = totalSyncPercent / recursiveItemCount;
  1468. if (pct > 0)
  1469. {
  1470. dto.SyncPercent = pct;
  1471. }
  1472. }
  1473. }
  1474. if (runtime > 0 && fields.Contains(ItemFields.CumulativeRunTimeTicks))
  1475. {
  1476. dto.CumulativeRunTimeTicks = runtime;
  1477. }
  1478. if (fields.Contains(ItemFields.DateLastMediaAdded))
  1479. {
  1480. dto.DateLastMediaAdded = dateLastMediaAdded;
  1481. }
  1482. }
  1483. /// <summary>
  1484. /// Attaches the primary image aspect ratio.
  1485. /// </summary>
  1486. /// <param name="dto">The dto.</param>
  1487. /// <param name="item">The item.</param>
  1488. /// <returns>Task.</returns>
  1489. public void AttachPrimaryImageAspectRatio(IItemDto dto, IHasImages item)
  1490. {
  1491. dto.PrimaryImageAspectRatio = GetPrimaryImageAspectRatio(item);
  1492. }
  1493. public double? GetPrimaryImageAspectRatio(IHasImages item)
  1494. {
  1495. var imageInfo = item.GetImageInfo(ImageType.Primary, 0);
  1496. if (imageInfo == null || !imageInfo.IsLocalFile)
  1497. {
  1498. return null;
  1499. }
  1500. ImageSize size;
  1501. try
  1502. {
  1503. size = _imageProcessor.GetImageSize(imageInfo);
  1504. }
  1505. catch (Exception ex)
  1506. {
  1507. //_logger.ErrorException("Failed to determine primary image aspect ratio for {0}", ex, path);
  1508. return null;
  1509. }
  1510. var supportedEnhancers = _imageProcessor.GetSupportedEnhancers(item, ImageType.Primary).ToList();
  1511. foreach (var enhancer in supportedEnhancers)
  1512. {
  1513. try
  1514. {
  1515. size = enhancer.GetEnhancedImageSize(item, ImageType.Primary, 0, size);
  1516. }
  1517. catch (Exception ex)
  1518. {
  1519. _logger.ErrorException("Error in image enhancer: {0}", ex, enhancer.GetType().Name);
  1520. }
  1521. }
  1522. var width = size.Width;
  1523. var height = size.Height;
  1524. if (width == 0 || height == 0)
  1525. {
  1526. return null;
  1527. }
  1528. var photo = item as Photo;
  1529. if (photo != null && photo.Orientation.HasValue)
  1530. {
  1531. switch (photo.Orientation.Value)
  1532. {
  1533. case ImageOrientation.LeftBottom:
  1534. case ImageOrientation.LeftTop:
  1535. case ImageOrientation.RightBottom:
  1536. case ImageOrientation.RightTop:
  1537. var temp = height;
  1538. height = width;
  1539. width = temp;
  1540. break;
  1541. }
  1542. }
  1543. return width / height;
  1544. }
  1545. }
  1546. }