SyncManager.cs 46 KB

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