SyncManager.cs 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159
  1. using MediaBrowser.Common;
  2. using MediaBrowser.Common.Configuration;
  3. using MediaBrowser.Common.Events;
  4. using MediaBrowser.Common.Extensions;
  5. using MediaBrowser.Common.IO;
  6. using MediaBrowser.Controller.Channels;
  7. using MediaBrowser.Controller.Drawing;
  8. using MediaBrowser.Controller.Dto;
  9. using MediaBrowser.Controller.Entities;
  10. using MediaBrowser.Controller.Entities.Audio;
  11. using MediaBrowser.Controller.Entities.TV;
  12. using MediaBrowser.Controller.Library;
  13. using MediaBrowser.Controller.LiveTv;
  14. using MediaBrowser.Controller.MediaEncoding;
  15. using MediaBrowser.Controller.Playlists;
  16. using MediaBrowser.Controller.Sync;
  17. using MediaBrowser.Controller.TV;
  18. using MediaBrowser.Model.Dto;
  19. using MediaBrowser.Model.Entities;
  20. using MediaBrowser.Model.Events;
  21. using MediaBrowser.Model.Logging;
  22. using MediaBrowser.Model.Querying;
  23. using MediaBrowser.Model.Serialization;
  24. using MediaBrowser.Model.Sync;
  25. using MediaBrowser.Model.Users;
  26. using MoreLinq;
  27. using System;
  28. using System.Collections.Concurrent;
  29. using System.Collections.Generic;
  30. using System.IO;
  31. using System.Linq;
  32. using System.Threading;
  33. using System.Threading.Tasks;
  34. namespace MediaBrowser.Server.Implementations.Sync
  35. {
  36. public class SyncManager : ISyncManager
  37. {
  38. private readonly ILibraryManager _libraryManager;
  39. private readonly ISyncRepository _repo;
  40. private readonly IImageProcessor _imageProcessor;
  41. private readonly ILogger _logger;
  42. private readonly IUserManager _userManager;
  43. private readonly Func<IDtoService> _dtoService;
  44. private readonly IApplicationHost _appHost;
  45. private readonly ITVSeriesManager _tvSeriesManager;
  46. private readonly Func<IMediaEncoder> _mediaEncoder;
  47. private readonly IFileSystem _fileSystem;
  48. private readonly Func<ISubtitleEncoder> _subtitleEncoder;
  49. private readonly IConfigurationManager _config;
  50. private readonly IUserDataManager _userDataManager;
  51. private readonly Func<IMediaSourceManager> _mediaSourceManager;
  52. private readonly IJsonSerializer _json;
  53. private ISyncProvider[] _providers = { };
  54. public event EventHandler<GenericEventArgs<SyncJobCreationResult>> SyncJobCreated;
  55. public event EventHandler<GenericEventArgs<SyncJob>> SyncJobCancelled;
  56. public event EventHandler<GenericEventArgs<SyncJob>> SyncJobUpdated;
  57. public event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemUpdated;
  58. public event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemCreated;
  59. public SyncManager(ILibraryManager libraryManager, ISyncRepository repo, IImageProcessor imageProcessor, ILogger logger, IUserManager userManager, Func<IDtoService> dtoService, IApplicationHost appHost, ITVSeriesManager tvSeriesManager, Func<IMediaEncoder> mediaEncoder, IFileSystem fileSystem, Func<ISubtitleEncoder> subtitleEncoder, IConfigurationManager config, IUserDataManager userDataManager, Func<IMediaSourceManager> mediaSourceManager, IJsonSerializer json)
  60. {
  61. _libraryManager = libraryManager;
  62. _repo = repo;
  63. _imageProcessor = imageProcessor;
  64. _logger = logger;
  65. _userManager = userManager;
  66. _dtoService = dtoService;
  67. _appHost = appHost;
  68. _tvSeriesManager = tvSeriesManager;
  69. _mediaEncoder = mediaEncoder;
  70. _fileSystem = fileSystem;
  71. _subtitleEncoder = subtitleEncoder;
  72. _config = config;
  73. _userDataManager = userDataManager;
  74. _mediaSourceManager = mediaSourceManager;
  75. _json = json;
  76. }
  77. public void AddParts(IEnumerable<ISyncProvider> providers)
  78. {
  79. _providers = providers.ToArray();
  80. }
  81. public IEnumerable<IServerSyncProvider> ServerSyncProviders
  82. {
  83. get { return _providers.OfType<IServerSyncProvider>(); }
  84. }
  85. private readonly ConcurrentDictionary<string, ISyncDataProvider> _dataProviders =
  86. new ConcurrentDictionary<string, ISyncDataProvider>(StringComparer.OrdinalIgnoreCase);
  87. public ISyncDataProvider GetDataProvider(IServerSyncProvider provider, SyncTarget target)
  88. {
  89. return _dataProviders.GetOrAdd(target.Id, key => new TargetDataProvider(provider, target, _appHost.SystemId, _logger, _json, _fileSystem, _config.CommonApplicationPaths));
  90. }
  91. public async Task<SyncJobCreationResult> CreateJob(SyncJobRequest request)
  92. {
  93. var processor = GetSyncJobProcessor();
  94. var user = _userManager.GetUserById(request.UserId);
  95. var items = (await processor
  96. .GetItemsForSync(request.Category, request.ParentId, request.ItemIds, user, request.UnwatchedOnly).ConfigureAwait(false))
  97. .ToList();
  98. if (items.Any(i => !SupportsSync(i)))
  99. {
  100. throw new ArgumentException("Item does not support sync.");
  101. }
  102. if (string.IsNullOrWhiteSpace(request.Name))
  103. {
  104. if (request.ItemIds.Count == 1)
  105. {
  106. request.Name = GetDefaultName(_libraryManager.GetItemById(request.ItemIds[0]));
  107. }
  108. }
  109. if (string.IsNullOrWhiteSpace(request.Name))
  110. {
  111. throw new ArgumentException("Please supply a name for the sync job.");
  112. }
  113. var target = GetSyncTargets(request.UserId)
  114. .FirstOrDefault(i => string.Equals(request.TargetId, i.Id));
  115. if (target == null)
  116. {
  117. throw new ArgumentException("Sync target not found.");
  118. }
  119. var jobId = Guid.NewGuid().ToString("N");
  120. if (string.IsNullOrWhiteSpace(request.Quality))
  121. {
  122. request.Quality = GetQualityOptions(request.TargetId)
  123. .Where(i => i.IsDefault)
  124. .Select(i => i.Id)
  125. .FirstOrDefault(i => !string.IsNullOrWhiteSpace(i));
  126. }
  127. var job = new SyncJob
  128. {
  129. Id = jobId,
  130. Name = request.Name,
  131. TargetId = target.Id,
  132. UserId = request.UserId,
  133. UnwatchedOnly = request.UnwatchedOnly,
  134. ItemLimit = request.ItemLimit,
  135. RequestedItemIds = request.ItemIds ?? new List<string> { },
  136. DateCreated = DateTime.UtcNow,
  137. DateLastModified = DateTime.UtcNow,
  138. SyncNewContent = request.SyncNewContent,
  139. ItemCount = items.Count,
  140. Category = request.Category,
  141. ParentId = request.ParentId,
  142. Quality = request.Quality,
  143. Profile = request.Profile,
  144. Bitrate = request.Bitrate
  145. };
  146. if (!request.Category.HasValue && request.ItemIds != null)
  147. {
  148. var requestedItems = request.ItemIds
  149. .Select(_libraryManager.GetItemById)
  150. .Where(i => i != null);
  151. // It's just a static list
  152. if (!requestedItems.Any(i => i.IsFolder || i is IItemByName))
  153. {
  154. job.SyncNewContent = false;
  155. }
  156. }
  157. await _repo.Create(job).ConfigureAwait(false);
  158. await processor.EnsureJobItems(job).ConfigureAwait(false);
  159. // If it already has a converting status then is must have been aborted during conversion
  160. var jobItemsResult = _repo.GetJobItems(new SyncJobItemQuery
  161. {
  162. Statuses = new List<SyncJobItemStatus> { SyncJobItemStatus.Queued, SyncJobItemStatus.Converting },
  163. JobId = jobId
  164. });
  165. await processor.SyncJobItems(jobItemsResult.Items, false, new Progress<double>(), CancellationToken.None)
  166. .ConfigureAwait(false);
  167. jobItemsResult = _repo.GetJobItems(new SyncJobItemQuery
  168. {
  169. Statuses = new List<SyncJobItemStatus> { SyncJobItemStatus.Queued, SyncJobItemStatus.Converting },
  170. JobId = jobId
  171. });
  172. var returnResult = new SyncJobCreationResult
  173. {
  174. Job = GetJob(jobId),
  175. JobItems = jobItemsResult.Items.ToList()
  176. };
  177. if (SyncJobCreated != null)
  178. {
  179. EventHelper.FireEventIfNotNull(SyncJobCreated, this, new GenericEventArgs<SyncJobCreationResult>
  180. {
  181. Argument = returnResult
  182. }, _logger);
  183. }
  184. return returnResult;
  185. }
  186. public async Task UpdateJob(SyncJob job)
  187. {
  188. // Get fresh from the db and only update the fields that are supported to be changed.
  189. var instance = _repo.GetJob(job.Id);
  190. instance.Name = job.Name;
  191. instance.Quality = job.Quality;
  192. instance.Profile = job.Profile;
  193. instance.UnwatchedOnly = job.UnwatchedOnly;
  194. instance.SyncNewContent = job.SyncNewContent;
  195. instance.ItemLimit = job.ItemLimit;
  196. await _repo.Update(instance).ConfigureAwait(false);
  197. OnSyncJobUpdated(instance);
  198. }
  199. internal void OnSyncJobUpdated(SyncJob job)
  200. {
  201. if (SyncJobUpdated != null)
  202. {
  203. EventHelper.FireEventIfNotNull(SyncJobUpdated, this, new GenericEventArgs<SyncJob>
  204. {
  205. Argument = job
  206. }, _logger);
  207. }
  208. }
  209. internal async Task UpdateSyncJobItemInternal(SyncJobItem jobItem)
  210. {
  211. await _repo.Update(jobItem).ConfigureAwait(false);
  212. if (SyncJobUpdated != null)
  213. {
  214. EventHelper.FireEventIfNotNull(SyncJobItemUpdated, this, new GenericEventArgs<SyncJobItem>
  215. {
  216. Argument = jobItem
  217. }, _logger);
  218. }
  219. }
  220. internal void OnSyncJobItemCreated(SyncJobItem job)
  221. {
  222. if (SyncJobUpdated != null)
  223. {
  224. EventHelper.FireEventIfNotNull(SyncJobItemCreated, this, new GenericEventArgs<SyncJobItem>
  225. {
  226. Argument = job
  227. }, _logger);
  228. }
  229. }
  230. public async Task<QueryResult<SyncJob>> GetJobs(SyncJobQuery query)
  231. {
  232. var result = _repo.GetJobs(query);
  233. foreach (var item in result.Items)
  234. {
  235. await FillMetadata(item).ConfigureAwait(false);
  236. }
  237. return result;
  238. }
  239. private async Task FillMetadata(SyncJob job)
  240. {
  241. var target = GetSyncTargets(job.UserId)
  242. .FirstOrDefault(i => string.Equals(i.Id, job.TargetId, StringComparison.OrdinalIgnoreCase));
  243. if (target != null)
  244. {
  245. job.TargetName = target.Name;
  246. }
  247. var item = job.RequestedItemIds
  248. .Select(_libraryManager.GetItemById)
  249. .FirstOrDefault(i => i != null);
  250. if (item == null)
  251. {
  252. var processor = GetSyncJobProcessor();
  253. var user = _userManager.GetUserById(job.UserId);
  254. item = (await processor
  255. .GetItemsForSync(job.Category, job.ParentId, job.RequestedItemIds, user, job.UnwatchedOnly).ConfigureAwait(false))
  256. .FirstOrDefault();
  257. }
  258. if (item != null)
  259. {
  260. var hasSeries = item as IHasSeries;
  261. if (hasSeries != null)
  262. {
  263. job.ParentName = hasSeries.SeriesName;
  264. }
  265. var hasAlbumArtist = item as IHasAlbumArtist;
  266. if (hasAlbumArtist != null)
  267. {
  268. job.ParentName = hasAlbumArtist.AlbumArtists.FirstOrDefault();
  269. }
  270. var primaryImage = item.GetImageInfo(ImageType.Primary, 0);
  271. var itemWithImage = item;
  272. if (primaryImage == null)
  273. {
  274. var parentWithImage = item.Parents.FirstOrDefault(i => i.HasImage(ImageType.Primary));
  275. if (parentWithImage != null)
  276. {
  277. itemWithImage = parentWithImage;
  278. primaryImage = parentWithImage.GetImageInfo(ImageType.Primary, 0);
  279. }
  280. }
  281. if (primaryImage != null)
  282. {
  283. try
  284. {
  285. job.PrimaryImageTag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Primary);
  286. job.PrimaryImageItemId = itemWithImage.Id.ToString("N");
  287. }
  288. catch (Exception ex)
  289. {
  290. _logger.ErrorException("Error getting image info", ex);
  291. }
  292. }
  293. }
  294. }
  295. private void FillMetadata(SyncJobItem jobItem)
  296. {
  297. var item = _libraryManager.GetItemById(jobItem.ItemId);
  298. if (item == null)
  299. {
  300. return;
  301. }
  302. var primaryImage = item.GetImageInfo(ImageType.Primary, 0);
  303. var itemWithImage = item;
  304. if (primaryImage == null)
  305. {
  306. var parentWithImage = item.Parents.FirstOrDefault(i => i.HasImage(ImageType.Primary));
  307. if (parentWithImage != null)
  308. {
  309. itemWithImage = parentWithImage;
  310. primaryImage = parentWithImage.GetImageInfo(ImageType.Primary, 0);
  311. }
  312. }
  313. if (primaryImage != null)
  314. {
  315. try
  316. {
  317. jobItem.PrimaryImageTag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Primary);
  318. jobItem.PrimaryImageItemId = itemWithImage.Id.ToString("N");
  319. }
  320. catch (Exception ex)
  321. {
  322. _logger.ErrorException("Error getting image info", ex);
  323. }
  324. }
  325. }
  326. public async Task CancelJob(string id)
  327. {
  328. var job = GetJob(id);
  329. if (job == null)
  330. {
  331. throw new ArgumentException("Job not found.");
  332. }
  333. await _repo.DeleteJob(id).ConfigureAwait(false);
  334. var path = GetSyncJobProcessor().GetTemporaryPath(id);
  335. try
  336. {
  337. _fileSystem.DeleteDirectory(path, true);
  338. }
  339. catch (DirectoryNotFoundException)
  340. {
  341. }
  342. catch (Exception ex)
  343. {
  344. _logger.ErrorException("Error deleting directory {0}", ex, path);
  345. }
  346. if (SyncJobCancelled != null)
  347. {
  348. EventHelper.FireEventIfNotNull(SyncJobCancelled, this, new GenericEventArgs<SyncJob>
  349. {
  350. Argument = job
  351. }, _logger);
  352. }
  353. }
  354. public SyncJob GetJob(string id)
  355. {
  356. return _repo.GetJob(id);
  357. }
  358. public IEnumerable<SyncTarget> GetSyncTargets(string userId)
  359. {
  360. return _providers
  361. .SelectMany(i => GetSyncTargets(i, userId))
  362. .OrderBy(i => i.Name);
  363. }
  364. private IEnumerable<SyncTarget> GetSyncTargets(ISyncProvider provider)
  365. {
  366. return provider.GetAllSyncTargets().Select(i => new SyncTarget
  367. {
  368. Name = i.Name,
  369. Id = GetSyncTargetId(provider, i)
  370. });
  371. }
  372. private IEnumerable<SyncTarget> GetSyncTargets(ISyncProvider provider, string userId)
  373. {
  374. return provider.GetSyncTargets(userId).Select(i => new SyncTarget
  375. {
  376. Name = i.Name,
  377. Id = GetSyncTargetId(provider, i)
  378. });
  379. }
  380. private string GetSyncTargetId(ISyncProvider provider, SyncTarget target)
  381. {
  382. var hasUniqueId = provider as IHasUniqueTargetIds;
  383. if (hasUniqueId != null)
  384. {
  385. return target.Id;
  386. }
  387. return target.Id;
  388. //var providerId = GetSyncProviderId(provider);
  389. //return (providerId + "-" + target.Id).GetMD5().ToString("N");
  390. }
  391. private string GetSyncProviderId(ISyncProvider provider)
  392. {
  393. return (provider.GetType().Name).GetMD5().ToString("N");
  394. }
  395. public bool SupportsSync(BaseItem item)
  396. {
  397. if (item is Playlist)
  398. {
  399. return true;
  400. }
  401. if (item is Person)
  402. {
  403. return false;
  404. }
  405. if (item is Year)
  406. {
  407. return false;
  408. }
  409. if (string.Equals(item.MediaType, MediaType.Video, StringComparison.OrdinalIgnoreCase) ||
  410. string.Equals(item.MediaType, MediaType.Audio, StringComparison.OrdinalIgnoreCase) ||
  411. string.Equals(item.MediaType, MediaType.Photo, StringComparison.OrdinalIgnoreCase) ||
  412. string.Equals(item.MediaType, MediaType.Game, StringComparison.OrdinalIgnoreCase) ||
  413. string.Equals(item.MediaType, MediaType.Book, StringComparison.OrdinalIgnoreCase))
  414. {
  415. if (item.LocationType == LocationType.Virtual)
  416. {
  417. return false;
  418. }
  419. if (!item.RunTimeTicks.HasValue)
  420. {
  421. return false;
  422. }
  423. var video = item as Video;
  424. if (video != null)
  425. {
  426. if (video.VideoType == VideoType.Iso)
  427. {
  428. return false;
  429. }
  430. if (video.VideoType == VideoType.BluRay || video.VideoType == VideoType.Dvd || video.VideoType == VideoType.HdDvd)
  431. {
  432. return false;
  433. }
  434. if (video.IsPlaceHolder)
  435. {
  436. return false;
  437. }
  438. if (video.IsArchive)
  439. {
  440. return false;
  441. }
  442. if (video.IsStacked)
  443. {
  444. return false;
  445. }
  446. if (video.IsShortcut)
  447. {
  448. return false;
  449. }
  450. }
  451. var game = item as Game;
  452. if (game != null)
  453. {
  454. if (game.IsMultiPart)
  455. {
  456. return false;
  457. }
  458. }
  459. if (item is LiveTvChannel || item is IChannelItem || item is ILiveTvRecording)
  460. {
  461. return false;
  462. }
  463. // It would be nice to support these later
  464. if (item is Game || item is Book)
  465. {
  466. return false;
  467. }
  468. return true;
  469. }
  470. return item.LocationType == LocationType.FileSystem || item is Season || item is ILiveTvRecording;
  471. }
  472. private string GetDefaultName(BaseItem item)
  473. {
  474. return item.Name;
  475. }
  476. public async Task ReportSyncJobItemTransferred(string id)
  477. {
  478. var jobItem = _repo.GetJobItem(id);
  479. jobItem.Status = SyncJobItemStatus.Synced;
  480. jobItem.Progress = 100;
  481. if (!string.IsNullOrWhiteSpace(jobItem.TemporaryPath))
  482. {
  483. try
  484. {
  485. _fileSystem.DeleteDirectory(jobItem.TemporaryPath, true);
  486. }
  487. catch (DirectoryNotFoundException)
  488. {
  489. }
  490. catch (Exception ex)
  491. {
  492. _logger.ErrorException("Error deleting temporary job file: {0}", ex, jobItem.OutputPath);
  493. }
  494. }
  495. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  496. var processor = GetSyncJobProcessor();
  497. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  498. }
  499. private SyncJobProcessor GetSyncJobProcessor()
  500. {
  501. return new SyncJobProcessor(_libraryManager, _repo, this, _logger, _userManager, _tvSeriesManager, _mediaEncoder(), _subtitleEncoder(), _config, _fileSystem, _mediaSourceManager());
  502. }
  503. public SyncJobItem GetJobItem(string id)
  504. {
  505. return _repo.GetJobItem(id);
  506. }
  507. public QueryResult<SyncJobItem> GetJobItems(SyncJobItemQuery query)
  508. {
  509. var result = _repo.GetJobItems(query);
  510. if (query.AddMetadata)
  511. {
  512. result.Items.ForEach(FillMetadata);
  513. }
  514. return result;
  515. }
  516. private SyncedItem GetJobItemInfo(SyncJobItem jobItem)
  517. {
  518. var job = _repo.GetJob(jobItem.JobId);
  519. if (job == null)
  520. {
  521. _logger.Error("GetJobItemInfo job id {0} no longer exists", jobItem.JobId);
  522. return null;
  523. }
  524. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  525. if (libraryItem == null)
  526. {
  527. _logger.Error("GetJobItemInfo library item with id {0} no longer exists", jobItem.ItemId);
  528. return null;
  529. }
  530. var syncedItem = new SyncedItem
  531. {
  532. SyncJobId = jobItem.JobId,
  533. SyncJobItemId = jobItem.Id,
  534. ServerId = _appHost.SystemId,
  535. UserId = job.UserId,
  536. AdditionalFiles = jobItem.AdditionalFiles.Select(i => new ItemFileInfo
  537. {
  538. ImageType = i.ImageType,
  539. Name = i.Name,
  540. Type = i.Type,
  541. Index = i.Index
  542. }).ToList()
  543. };
  544. var dtoOptions = new DtoOptions();
  545. // Remove some bloat
  546. dtoOptions.Fields.Remove(ItemFields.MediaStreams);
  547. dtoOptions.Fields.Remove(ItemFields.IndexOptions);
  548. dtoOptions.Fields.Remove(ItemFields.MediaSourceCount);
  549. dtoOptions.Fields.Remove(ItemFields.OriginalPrimaryImageAspectRatio);
  550. dtoOptions.Fields.Remove(ItemFields.Path);
  551. dtoOptions.Fields.Remove(ItemFields.SeriesGenres);
  552. dtoOptions.Fields.Remove(ItemFields.Settings);
  553. dtoOptions.Fields.Remove(ItemFields.SyncInfo);
  554. syncedItem.Item = _dtoService().GetBaseItemDto(libraryItem, dtoOptions);
  555. var mediaSource = jobItem.MediaSource;
  556. syncedItem.Item.MediaSources = new List<MediaSourceInfo>();
  557. // This will be null for items that are not audio/video
  558. if (mediaSource == null)
  559. {
  560. syncedItem.OriginalFileName = Path.GetFileName(libraryItem.Path);
  561. }
  562. else
  563. {
  564. syncedItem.OriginalFileName = Path.GetFileName(mediaSource.Path);
  565. syncedItem.Item.MediaSources.Add(mediaSource);
  566. }
  567. return syncedItem;
  568. }
  569. public Task ReportOfflineAction(UserAction action)
  570. {
  571. switch (action.Type)
  572. {
  573. case UserActionType.PlayedItem:
  574. return ReportOfflinePlayedItem(action);
  575. default:
  576. throw new ArgumentException("Unexpected action type");
  577. }
  578. }
  579. private Task ReportOfflinePlayedItem(UserAction action)
  580. {
  581. var item = _libraryManager.GetItemById(action.ItemId);
  582. var userData = _userDataManager.GetUserData(new Guid(action.UserId), item.GetUserDataKey());
  583. userData.LastPlayedDate = action.Date;
  584. _userDataManager.UpdatePlayState(item, userData, action.PositionTicks);
  585. return _userDataManager.SaveUserData(new Guid(action.UserId), item, userData, UserDataSaveReason.Import, CancellationToken.None);
  586. }
  587. public async Task<List<SyncedItem>> GetReadySyncItems(string targetId)
  588. {
  589. var processor = GetSyncJobProcessor();
  590. await processor.SyncJobItems(targetId, false, new Progress<double>(), CancellationToken.None).ConfigureAwait(false);
  591. var jobItemResult = GetJobItems(new SyncJobItemQuery
  592. {
  593. TargetId = targetId,
  594. Statuses = new List<SyncJobItemStatus>
  595. {
  596. SyncJobItemStatus.ReadyToTransfer
  597. }
  598. });
  599. return jobItemResult.Items
  600. .Select(GetJobItemInfo)
  601. .Where(i => i != null)
  602. .ToList();
  603. }
  604. public async Task<SyncDataResponse> SyncData(SyncDataRequest request)
  605. {
  606. var jobItemResult = GetJobItems(new SyncJobItemQuery
  607. {
  608. TargetId = request.TargetId,
  609. Statuses = new List<SyncJobItemStatus> { SyncJobItemStatus.Synced }
  610. });
  611. var response = new SyncDataResponse();
  612. foreach (var jobItem in jobItemResult.Items)
  613. {
  614. if (request.LocalItemIds.Contains(jobItem.ItemId, StringComparer.OrdinalIgnoreCase))
  615. {
  616. var job = _repo.GetJob(jobItem.JobId);
  617. var user = _userManager.GetUserById(job.UserId);
  618. if (jobItem.IsMarkedForRemoval)
  619. {
  620. // Tell the device to remove it since it has been marked for removal
  621. response.ItemIdsToRemove.Add(jobItem.ItemId);
  622. }
  623. else if (user == null)
  624. {
  625. // Tell the device to remove it since the user is gone now
  626. response.ItemIdsToRemove.Add(jobItem.ItemId);
  627. }
  628. else if (job.UnwatchedOnly)
  629. {
  630. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  631. if (IsLibraryItemAvailable(libraryItem))
  632. {
  633. if (libraryItem.IsPlayed(user) && libraryItem is Video)
  634. {
  635. // Tell the device to remove it since it has been played
  636. response.ItemIdsToRemove.Add(jobItem.ItemId);
  637. }
  638. }
  639. else
  640. {
  641. // Tell the device to remove it since it's no longer available
  642. response.ItemIdsToRemove.Add(jobItem.ItemId);
  643. }
  644. }
  645. }
  646. else
  647. {
  648. // Content is no longer on the device
  649. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  650. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  651. }
  652. }
  653. // Now check each item that's on the device
  654. foreach (var itemId in request.LocalItemIds)
  655. {
  656. // See if it's already marked for removal
  657. if (response.ItemIdsToRemove.Contains(itemId, StringComparer.OrdinalIgnoreCase))
  658. {
  659. continue;
  660. }
  661. // If there isn't a sync job for this item, mark it for removal
  662. if (!jobItemResult.Items.Any(i => string.Equals(itemId, i.ItemId, StringComparison.OrdinalIgnoreCase)))
  663. {
  664. response.ItemIdsToRemove.Add(itemId);
  665. }
  666. }
  667. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  668. var itemsOnDevice = request.LocalItemIds
  669. .Except(response.ItemIdsToRemove)
  670. .ToList();
  671. SetUserAccess(request, response, itemsOnDevice);
  672. return response;
  673. }
  674. private void SetUserAccess(SyncDataRequest request, SyncDataResponse response, List<string> itemIds)
  675. {
  676. var users = request.OfflineUserIds
  677. .Select(_userManager.GetUserById)
  678. .Where(i => i != null)
  679. .ToList();
  680. foreach (var itemId in itemIds)
  681. {
  682. var item = _libraryManager.GetItemById(itemId);
  683. if (item != null)
  684. {
  685. var usersWithAccess = new List<User>();
  686. foreach (var user in users)
  687. {
  688. if (IsUserVisible(item, user))
  689. {
  690. usersWithAccess.Add(user);
  691. }
  692. }
  693. response.ItemUserAccess[itemId] = users
  694. .Select(i => i.Id.ToString("N"))
  695. .OrderBy(i => i)
  696. .ToList();
  697. }
  698. }
  699. }
  700. private bool IsUserVisible(BaseItem item, User user)
  701. {
  702. return item.IsVisibleStandalone(user);
  703. }
  704. private bool IsLibraryItemAvailable(BaseItem item)
  705. {
  706. if (item == null)
  707. {
  708. return false;
  709. }
  710. // TODO: Make sure it hasn't been deleted
  711. return true;
  712. }
  713. public async Task ReEnableJobItem(string id)
  714. {
  715. var jobItem = _repo.GetJobItem(id);
  716. if (jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Cancelled)
  717. {
  718. throw new ArgumentException("Operation is not valid for this job item");
  719. }
  720. jobItem.Status = SyncJobItemStatus.Queued;
  721. jobItem.Progress = 0;
  722. jobItem.IsMarkedForRemoval = false;
  723. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  724. var processor = GetSyncJobProcessor();
  725. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  726. }
  727. public async Task CancelJobItem(string id)
  728. {
  729. var jobItem = _repo.GetJobItem(id);
  730. if (jobItem.Status != SyncJobItemStatus.Queued && jobItem.Status != SyncJobItemStatus.ReadyToTransfer && jobItem.Status != SyncJobItemStatus.Converting)
  731. {
  732. throw new ArgumentException("Operation is not valid for this job item");
  733. }
  734. jobItem.Status = SyncJobItemStatus.Cancelled;
  735. jobItem.Progress = 0;
  736. jobItem.IsMarkedForRemoval = true;
  737. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  738. var processor = GetSyncJobProcessor();
  739. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  740. var path = processor.GetTemporaryPath(jobItem);
  741. try
  742. {
  743. _fileSystem.DeleteDirectory(path, true);
  744. }
  745. catch (DirectoryNotFoundException)
  746. {
  747. }
  748. catch (Exception ex)
  749. {
  750. _logger.ErrorException("Error deleting directory {0}", ex, path);
  751. }
  752. }
  753. public async Task MarkJobItemForRemoval(string id)
  754. {
  755. var jobItem = _repo.GetJobItem(id);
  756. if (jobItem.Status != SyncJobItemStatus.Synced)
  757. {
  758. throw new ArgumentException("Operation is not valid for this job item");
  759. }
  760. jobItem.IsMarkedForRemoval = true;
  761. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  762. var processor = GetSyncJobProcessor();
  763. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  764. }
  765. public async Task UnmarkJobItemForRemoval(string id)
  766. {
  767. var jobItem = _repo.GetJobItem(id);
  768. if (jobItem.Status != SyncJobItemStatus.Synced)
  769. {
  770. throw new ArgumentException("Operation is not valid for this job item");
  771. }
  772. jobItem.IsMarkedForRemoval = false;
  773. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  774. var processor = GetSyncJobProcessor();
  775. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  776. }
  777. public async Task ReportSyncJobItemTransferBeginning(string id)
  778. {
  779. var jobItem = _repo.GetJobItem(id);
  780. jobItem.Status = SyncJobItemStatus.Transferring;
  781. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  782. var processor = GetSyncJobProcessor();
  783. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  784. }
  785. public async Task ReportSyncJobItemTransferFailed(string id)
  786. {
  787. var jobItem = _repo.GetJobItem(id);
  788. jobItem.Status = SyncJobItemStatus.ReadyToTransfer;
  789. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  790. var processor = GetSyncJobProcessor();
  791. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  792. }
  793. public QueryResult<string> GetLibraryItemIds(SyncJobItemQuery query)
  794. {
  795. return _repo.GetLibraryItemIds(query);
  796. }
  797. public SyncJobOptions GetAudioOptions(SyncJobItem jobItem, SyncJob job)
  798. {
  799. var options = GetSyncJobOptions(jobItem.TargetId, null, null);
  800. if (job.Bitrate.HasValue)
  801. {
  802. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  803. }
  804. return options;
  805. }
  806. public SyncJobOptions GetVideoOptions(SyncJobItem jobItem, SyncJob job)
  807. {
  808. var options = GetSyncJobOptions(jobItem.TargetId, job.Profile, job.Quality);
  809. if (job.Bitrate.HasValue)
  810. {
  811. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  812. }
  813. return options;
  814. }
  815. private SyncJobOptions GetSyncJobOptions(string targetId, string profile, string quality)
  816. {
  817. foreach (var provider in _providers)
  818. {
  819. foreach (var target in GetSyncTargets(provider))
  820. {
  821. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  822. {
  823. return GetSyncJobOptions(provider, target, profile, quality);
  824. }
  825. }
  826. }
  827. return GetDefaultSyncJobOptions(profile, quality);
  828. }
  829. private SyncJobOptions GetSyncJobOptions(ISyncProvider provider, SyncTarget target, string profile, string quality)
  830. {
  831. var hasProfile = provider as IHasSyncQuality;
  832. if (hasProfile != null)
  833. {
  834. return hasProfile.GetSyncJobOptions(target, profile, quality);
  835. }
  836. return GetDefaultSyncJobOptions(profile, quality);
  837. }
  838. private SyncJobOptions GetDefaultSyncJobOptions(string profile, string quality)
  839. {
  840. var supportsAc3 = string.Equals(profile, "general", StringComparison.OrdinalIgnoreCase);
  841. var deviceProfile = new CloudSyncProfile(supportsAc3, false);
  842. deviceProfile.MaxStaticBitrate = SyncHelper.AdjustBitrate(deviceProfile.MaxStaticBitrate, quality);
  843. return new SyncJobOptions
  844. {
  845. DeviceProfile = deviceProfile,
  846. IsConverting = IsConverting(profile, quality)
  847. };
  848. }
  849. private bool IsConverting(string profile, string quality)
  850. {
  851. return !string.Equals(profile, "original", StringComparison.OrdinalIgnoreCase);
  852. }
  853. public IEnumerable<SyncQualityOption> GetQualityOptions(string targetId)
  854. {
  855. foreach (var provider in _providers)
  856. {
  857. foreach (var target in GetSyncTargets(provider))
  858. {
  859. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  860. {
  861. return GetQualityOptions(provider, target);
  862. }
  863. }
  864. }
  865. return new List<SyncQualityOption>();
  866. }
  867. private IEnumerable<SyncQualityOption> GetQualityOptions(ISyncProvider provider, SyncTarget target)
  868. {
  869. var hasQuality = provider as IHasSyncQuality;
  870. if (hasQuality != null)
  871. {
  872. return hasQuality.GetQualityOptions(target);
  873. }
  874. // Default options for providers that don't override
  875. return new List<SyncQualityOption>
  876. {
  877. new SyncQualityOption
  878. {
  879. Name = "High",
  880. Id = "high",
  881. IsDefault = true
  882. },
  883. new SyncQualityOption
  884. {
  885. Name = "Medium",
  886. Id = "medium"
  887. },
  888. new SyncQualityOption
  889. {
  890. Name = "Low",
  891. Id = "low"
  892. },
  893. new SyncQualityOption
  894. {
  895. Name = "Custom",
  896. Id = "custom"
  897. }
  898. };
  899. }
  900. public IEnumerable<SyncProfileOption> GetProfileOptions(string targetId)
  901. {
  902. foreach (var provider in _providers)
  903. {
  904. foreach (var target in GetSyncTargets(provider))
  905. {
  906. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  907. {
  908. return GetProfileOptions(provider, target);
  909. }
  910. }
  911. }
  912. return new List<SyncProfileOption>();
  913. }
  914. private IEnumerable<SyncProfileOption> GetProfileOptions(ISyncProvider provider, SyncTarget target)
  915. {
  916. var hasQuality = provider as IHasSyncQuality;
  917. if (hasQuality != null)
  918. {
  919. return hasQuality.GetProfileOptions(target);
  920. }
  921. var list = new List<SyncProfileOption>();
  922. list.Add(new SyncProfileOption
  923. {
  924. Name = "Original",
  925. Id = "Original",
  926. Description = "Syncs original files as-is.",
  927. EnableQualityOptions = false
  928. });
  929. list.Add(new SyncProfileOption
  930. {
  931. Name = "Baseline",
  932. Id = "baseline",
  933. Description = "Designed for compatibility with all devices, including web browsers. Targets H264/AAC video and MP3 audio."
  934. });
  935. list.Add(new SyncProfileOption
  936. {
  937. Name = "General",
  938. Id = "general",
  939. Description = "Designed for compatibility with Chromecast, Roku, Smart TV's, and other similar devices. Targets H264/AAC/AC3 video and MP3 audio.",
  940. IsDefault = true
  941. });
  942. return list;
  943. }
  944. }
  945. }