SyncManager.cs 44 KB

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