SyncManager.cs 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333
  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 user = _userManager.GetUserById(job.UserId);
  245. if (user == null)
  246. {
  247. return;
  248. }
  249. var target = GetSyncTargets(job.UserId)
  250. .FirstOrDefault(i => string.Equals(i.Id, job.TargetId, StringComparison.OrdinalIgnoreCase));
  251. if (target != null)
  252. {
  253. job.TargetName = target.Name;
  254. }
  255. var item = job.RequestedItemIds
  256. .Select(_libraryManager.GetItemById)
  257. .FirstOrDefault(i => i != null);
  258. if (item == null)
  259. {
  260. var processor = GetSyncJobProcessor();
  261. item = (await processor
  262. .GetItemsForSync(job.Category, job.ParentId, job.RequestedItemIds, user, job.UnwatchedOnly).ConfigureAwait(false))
  263. .FirstOrDefault();
  264. }
  265. if (item != null)
  266. {
  267. var hasSeries = item as IHasSeries;
  268. if (hasSeries != null)
  269. {
  270. job.ParentName = hasSeries.SeriesName;
  271. }
  272. var hasAlbumArtist = item as IHasAlbumArtist;
  273. if (hasAlbumArtist != null)
  274. {
  275. job.ParentName = hasAlbumArtist.AlbumArtists.FirstOrDefault();
  276. }
  277. var primaryImage = item.GetImageInfo(ImageType.Primary, 0);
  278. var itemWithImage = item;
  279. if (primaryImage == null)
  280. {
  281. var parentWithImage = item.Parents.FirstOrDefault(i => i.HasImage(ImageType.Primary));
  282. if (parentWithImage != null)
  283. {
  284. itemWithImage = parentWithImage;
  285. primaryImage = parentWithImage.GetImageInfo(ImageType.Primary, 0);
  286. }
  287. }
  288. if (primaryImage != null)
  289. {
  290. try
  291. {
  292. job.PrimaryImageTag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Primary);
  293. job.PrimaryImageItemId = itemWithImage.Id.ToString("N");
  294. }
  295. catch (Exception ex)
  296. {
  297. _logger.ErrorException("Error getting image info", ex);
  298. }
  299. }
  300. }
  301. }
  302. private void FillMetadata(SyncJobItem jobItem)
  303. {
  304. var item = _libraryManager.GetItemById(jobItem.ItemId);
  305. if (item == null)
  306. {
  307. return;
  308. }
  309. var primaryImage = item.GetImageInfo(ImageType.Primary, 0);
  310. var itemWithImage = item;
  311. if (primaryImage == null)
  312. {
  313. var parentWithImage = item.Parents.FirstOrDefault(i => i.HasImage(ImageType.Primary));
  314. if (parentWithImage != null)
  315. {
  316. itemWithImage = parentWithImage;
  317. primaryImage = parentWithImage.GetImageInfo(ImageType.Primary, 0);
  318. }
  319. }
  320. if (primaryImage != null)
  321. {
  322. try
  323. {
  324. jobItem.PrimaryImageTag = _imageProcessor.GetImageCacheTag(itemWithImage, ImageType.Primary);
  325. jobItem.PrimaryImageItemId = itemWithImage.Id.ToString("N");
  326. }
  327. catch (Exception ex)
  328. {
  329. _logger.ErrorException("Error getting image info", ex);
  330. }
  331. }
  332. }
  333. public async Task CancelJob(string id)
  334. {
  335. var job = GetJob(id);
  336. if (job == null)
  337. {
  338. throw new ArgumentException("Job not found.");
  339. }
  340. await _repo.DeleteJob(id).ConfigureAwait(false);
  341. var path = GetSyncJobProcessor().GetTemporaryPath(id);
  342. try
  343. {
  344. _fileSystem.DeleteDirectory(path, true);
  345. }
  346. catch (DirectoryNotFoundException)
  347. {
  348. }
  349. catch (Exception ex)
  350. {
  351. _logger.ErrorException("Error deleting directory {0}", ex, path);
  352. }
  353. if (SyncJobCancelled != null)
  354. {
  355. EventHelper.FireEventIfNotNull(SyncJobCancelled, this, new GenericEventArgs<SyncJob>
  356. {
  357. Argument = job
  358. }, _logger);
  359. }
  360. }
  361. public SyncJob GetJob(string id)
  362. {
  363. return _repo.GetJob(id);
  364. }
  365. public IEnumerable<SyncTarget> GetSyncTargets(string userId)
  366. {
  367. return _providers
  368. .SelectMany(i => GetSyncTargets(i, userId))
  369. .OrderBy(i => i.Name);
  370. }
  371. private IEnumerable<SyncTarget> GetSyncTargets(ISyncProvider provider)
  372. {
  373. return provider.GetAllSyncTargets().Select(i => new SyncTarget
  374. {
  375. Name = i.Name,
  376. Id = GetSyncTargetId(provider, i)
  377. });
  378. }
  379. private IEnumerable<SyncTarget> GetSyncTargets(ISyncProvider provider, string userId)
  380. {
  381. return provider.GetSyncTargets(userId).Select(i => new SyncTarget
  382. {
  383. Name = i.Name,
  384. Id = GetSyncTargetId(provider, i)
  385. });
  386. }
  387. private string GetSyncTargetId(ISyncProvider provider, SyncTarget target)
  388. {
  389. var hasUniqueId = provider as IHasUniqueTargetIds;
  390. if (hasUniqueId != null)
  391. {
  392. return target.Id;
  393. }
  394. return target.Id;
  395. //var providerId = GetSyncProviderId(provider);
  396. //return (providerId + "-" + target.Id).GetMD5().ToString("N");
  397. }
  398. private string GetSyncProviderId(ISyncProvider provider)
  399. {
  400. return (provider.GetType().Name).GetMD5().ToString("N");
  401. }
  402. public bool SupportsSync(BaseItem item)
  403. {
  404. if (item is Playlist)
  405. {
  406. return true;
  407. }
  408. if (item is Person)
  409. {
  410. return false;
  411. }
  412. if (item is Year)
  413. {
  414. return false;
  415. }
  416. if (string.Equals(item.MediaType, MediaType.Video, StringComparison.OrdinalIgnoreCase) ||
  417. string.Equals(item.MediaType, MediaType.Audio, StringComparison.OrdinalIgnoreCase) ||
  418. string.Equals(item.MediaType, MediaType.Photo, StringComparison.OrdinalIgnoreCase) ||
  419. string.Equals(item.MediaType, MediaType.Game, StringComparison.OrdinalIgnoreCase) ||
  420. string.Equals(item.MediaType, MediaType.Book, StringComparison.OrdinalIgnoreCase))
  421. {
  422. if (item.LocationType == LocationType.Virtual)
  423. {
  424. return false;
  425. }
  426. if (!item.RunTimeTicks.HasValue)
  427. {
  428. return false;
  429. }
  430. var video = item as Video;
  431. if (video != null)
  432. {
  433. if (video.VideoType == VideoType.Iso || 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)
  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;
  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. SyncJobItemStatus.Transferring
  604. }
  605. });
  606. var readyItems = jobItemResult.Items
  607. .Select(GetJobItemInfo)
  608. .Where(i => i != null)
  609. .ToList();
  610. _logger.Debug("Returning {0} ready sync items for targetId {1}", readyItems.Count, targetId);
  611. return readyItems;
  612. }
  613. public async Task<SyncDataResponse> SyncData(SyncDataRequest request)
  614. {
  615. if (request.SyncJobItemIds != null)
  616. {
  617. return await SyncDataUsingSyncJobItemIds(request).ConfigureAwait(false);
  618. }
  619. var jobItemResult = GetJobItems(new SyncJobItemQuery
  620. {
  621. TargetId = request.TargetId,
  622. Statuses = new[] { SyncJobItemStatus.Synced }
  623. });
  624. var response = new SyncDataResponse();
  625. foreach (var jobItem in jobItemResult.Items)
  626. {
  627. var requiresSaving = false;
  628. var removeFromDevice = false;
  629. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  630. if (request.LocalItemIds.Contains(jobItem.ItemId, StringComparer.OrdinalIgnoreCase))
  631. {
  632. var job = _repo.GetJob(jobItem.JobId);
  633. var user = _userManager.GetUserById(job.UserId);
  634. if (jobItem.IsMarkedForRemoval)
  635. {
  636. // Tell the device to remove it since it has been marked for removal
  637. _logger.Debug("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.ItemId);
  638. removeFromDevice = true;
  639. }
  640. else if (user == null)
  641. {
  642. // Tell the device to remove it since the user is gone now
  643. _logger.Debug("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.ItemId);
  644. removeFromDevice = true;
  645. }
  646. else if (!IsLibraryItemAvailable(libraryItem))
  647. {
  648. // Tell the device to remove it since it's no longer available
  649. _logger.Debug("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.ItemId);
  650. removeFromDevice = true;
  651. }
  652. else if (job.UnwatchedOnly)
  653. {
  654. if (libraryItem.IsPlayed(user) && libraryItem is Video)
  655. {
  656. // Tell the device to remove it since it has been played
  657. _logger.Debug("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.ItemId);
  658. removeFromDevice = true;
  659. }
  660. }
  661. }
  662. else
  663. {
  664. // Content is no longer on the device
  665. if (jobItem.IsMarkedForRemoval)
  666. {
  667. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  668. }
  669. else
  670. {
  671. _logger.Debug("Setting status to Queued for {0} because it is no longer on the device.", jobItem.ItemId);
  672. jobItem.Status = SyncJobItemStatus.Queued;
  673. }
  674. requiresSaving = true;
  675. }
  676. if (removeFromDevice)
  677. {
  678. response.ItemIdsToRemove.Add(jobItem.ItemId);
  679. jobItem.IsMarkedForRemoval = true;
  680. requiresSaving = true;
  681. }
  682. if (requiresSaving)
  683. {
  684. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  685. }
  686. }
  687. // Now check each item that's on the device
  688. foreach (var itemId in request.LocalItemIds)
  689. {
  690. // See if it's already marked for removal
  691. if (response.ItemIdsToRemove.Contains(itemId, StringComparer.OrdinalIgnoreCase))
  692. {
  693. continue;
  694. }
  695. // If there isn't a sync job for this item, mark it for removal
  696. if (!jobItemResult.Items.Any(i => string.Equals(itemId, i.ItemId, StringComparison.OrdinalIgnoreCase)))
  697. {
  698. response.ItemIdsToRemove.Add(itemId);
  699. }
  700. }
  701. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  702. var itemsOnDevice = request.LocalItemIds
  703. .Except(response.ItemIdsToRemove)
  704. .ToList();
  705. SetUserAccess(request, response, itemsOnDevice);
  706. return response;
  707. }
  708. private async Task<SyncDataResponse> SyncDataUsingSyncJobItemIds(SyncDataRequest request)
  709. {
  710. var jobItemResult = GetJobItems(new SyncJobItemQuery
  711. {
  712. TargetId = request.TargetId,
  713. Statuses = new[] { SyncJobItemStatus.Synced }
  714. });
  715. var response = new SyncDataResponse();
  716. foreach (var jobItem in jobItemResult.Items)
  717. {
  718. var requiresSaving = false;
  719. var removeFromDevice = false;
  720. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  721. if (request.SyncJobItemIds.Contains(jobItem.Id, StringComparer.OrdinalIgnoreCase))
  722. {
  723. var job = _repo.GetJob(jobItem.JobId);
  724. var user = _userManager.GetUserById(job.UserId);
  725. if (jobItem.IsMarkedForRemoval)
  726. {
  727. // Tell the device to remove it since it has been marked for removal
  728. _logger.Debug("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.Id);
  729. removeFromDevice = true;
  730. }
  731. else if (user == null)
  732. {
  733. // Tell the device to remove it since the user is gone now
  734. _logger.Debug("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.Id);
  735. removeFromDevice = true;
  736. }
  737. else if (!IsLibraryItemAvailable(libraryItem))
  738. {
  739. // Tell the device to remove it since it's no longer available
  740. _logger.Debug("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.Id);
  741. removeFromDevice = true;
  742. }
  743. else if (job.UnwatchedOnly)
  744. {
  745. if (libraryItem.IsPlayed(user) && libraryItem is Video)
  746. {
  747. // Tell the device to remove it since it has been played
  748. _logger.Debug("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.Id);
  749. removeFromDevice = true;
  750. }
  751. }
  752. }
  753. else
  754. {
  755. // Content is no longer on the device
  756. if (jobItem.IsMarkedForRemoval)
  757. {
  758. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  759. }
  760. else
  761. {
  762. _logger.Debug("Setting status to Queued for {0} because it is no longer on the device.", jobItem.Id);
  763. jobItem.Status = SyncJobItemStatus.Queued;
  764. }
  765. requiresSaving = true;
  766. }
  767. if (removeFromDevice)
  768. {
  769. response.ItemIdsToRemove.Add(jobItem.Id);
  770. jobItem.IsMarkedForRemoval = true;
  771. requiresSaving = true;
  772. }
  773. if (requiresSaving)
  774. {
  775. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  776. }
  777. }
  778. // Now check each item that's on the device
  779. foreach (var syncJobItemId in request.SyncJobItemIds)
  780. {
  781. // See if it's already marked for removal
  782. if (response.ItemIdsToRemove.Contains(syncJobItemId, StringComparer.OrdinalIgnoreCase))
  783. {
  784. continue;
  785. }
  786. // If there isn't a sync job for this item, mark it for removal
  787. if (!jobItemResult.Items.Any(i => string.Equals(syncJobItemId, i.Id, StringComparison.OrdinalIgnoreCase)))
  788. {
  789. response.ItemIdsToRemove.Add(syncJobItemId);
  790. }
  791. }
  792. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  793. return response;
  794. }
  795. private void SetUserAccess(SyncDataRequest request, SyncDataResponse response, List<string> itemIds)
  796. {
  797. var users = request.OfflineUserIds
  798. .Select(_userManager.GetUserById)
  799. .Where(i => i != null)
  800. .ToList();
  801. foreach (var itemId in itemIds)
  802. {
  803. var item = _libraryManager.GetItemById(itemId);
  804. if (item != null)
  805. {
  806. response.ItemUserAccess[itemId] = users
  807. .Where(i => IsUserVisible(item, i))
  808. .Select(i => i.Id.ToString("N"))
  809. .OrderBy(i => i)
  810. .ToList();
  811. }
  812. }
  813. }
  814. private bool IsUserVisible(BaseItem item, User user)
  815. {
  816. return item.IsVisibleStandalone(user);
  817. }
  818. private bool IsLibraryItemAvailable(BaseItem item)
  819. {
  820. if (item == null)
  821. {
  822. return false;
  823. }
  824. // TODO: Make sure it hasn't been deleted
  825. return true;
  826. }
  827. public async Task ReEnableJobItem(string id)
  828. {
  829. var jobItem = _repo.GetJobItem(id);
  830. if (jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Cancelled)
  831. {
  832. throw new ArgumentException("Operation is not valid for this job item");
  833. }
  834. jobItem.Status = SyncJobItemStatus.Queued;
  835. jobItem.Progress = 0;
  836. jobItem.IsMarkedForRemoval = false;
  837. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  838. var processor = GetSyncJobProcessor();
  839. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  840. }
  841. public async Task CancelItems(string targetId, IEnumerable<string> itemIds)
  842. {
  843. foreach (var item in itemIds)
  844. {
  845. var syncJobItemResult = GetJobItems(new SyncJobItemQuery
  846. {
  847. AddMetadata = false,
  848. ItemId = item,
  849. TargetId = targetId,
  850. Statuses = new[] { SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Converting, SyncJobItemStatus.Synced, SyncJobItemStatus.Failed }
  851. });
  852. foreach (var jobItem in syncJobItemResult.Items)
  853. {
  854. await CancelJobItem(jobItem.Id).ConfigureAwait(false);
  855. }
  856. }
  857. }
  858. public async Task CancelJobItem(string id)
  859. {
  860. var jobItem = _repo.GetJobItem(id);
  861. if (jobItem.Status != SyncJobItemStatus.Queued && jobItem.Status != SyncJobItemStatus.ReadyToTransfer && jobItem.Status != SyncJobItemStatus.Converting && jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Synced)
  862. {
  863. throw new ArgumentException("Operation is not valid for this job item");
  864. }
  865. if (jobItem.Status != SyncJobItemStatus.Synced)
  866. {
  867. jobItem.Status = SyncJobItemStatus.Cancelled;
  868. }
  869. jobItem.Progress = 0;
  870. jobItem.IsMarkedForRemoval = true;
  871. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  872. var processor = GetSyncJobProcessor();
  873. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  874. var path = processor.GetTemporaryPath(jobItem);
  875. try
  876. {
  877. _fileSystem.DeleteDirectory(path, true);
  878. }
  879. catch (DirectoryNotFoundException)
  880. {
  881. }
  882. catch (Exception ex)
  883. {
  884. _logger.ErrorException("Error deleting directory {0}", ex, path);
  885. }
  886. //var jobItemsResult = GetJobItems(new SyncJobItemQuery
  887. //{
  888. // AddMetadata = false,
  889. // JobId = jobItem.JobId,
  890. // Limit = 0,
  891. // Statuses = new[] { SyncJobItemStatus.Converting, SyncJobItemStatus.Failed, SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Synced, SyncJobItemStatus.Transferring }
  892. //});
  893. //if (jobItemsResult.TotalRecordCount == 0)
  894. //{
  895. // await CancelJob(jobItem.JobId).ConfigureAwait(false);
  896. //}
  897. }
  898. public Task MarkJobItemForRemoval(string id)
  899. {
  900. return CancelJobItem(id);
  901. }
  902. public async Task UnmarkJobItemForRemoval(string id)
  903. {
  904. var jobItem = _repo.GetJobItem(id);
  905. if (jobItem.Status != SyncJobItemStatus.Synced)
  906. {
  907. throw new ArgumentException("Operation is not valid for this job item");
  908. }
  909. jobItem.IsMarkedForRemoval = false;
  910. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  911. var processor = GetSyncJobProcessor();
  912. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  913. }
  914. public async Task ReportSyncJobItemTransferBeginning(string id)
  915. {
  916. var jobItem = _repo.GetJobItem(id);
  917. jobItem.Status = SyncJobItemStatus.Transferring;
  918. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  919. var processor = GetSyncJobProcessor();
  920. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  921. }
  922. public async Task ReportSyncJobItemTransferFailed(string id)
  923. {
  924. var jobItem = _repo.GetJobItem(id);
  925. jobItem.Status = SyncJobItemStatus.ReadyToTransfer;
  926. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  927. var processor = GetSyncJobProcessor();
  928. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  929. }
  930. public QueryResult<SyncedItemProgress> GetSyncedItemProgresses(SyncJobItemQuery query)
  931. {
  932. return _repo.GetSyncedItemProgresses(query);
  933. }
  934. public SyncJobOptions GetAudioOptions(SyncJobItem jobItem, SyncJob job)
  935. {
  936. var options = GetSyncJobOptions(jobItem.TargetId, null, null);
  937. if (job.Bitrate.HasValue)
  938. {
  939. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  940. }
  941. return options;
  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. }