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 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 || video.VideoType == VideoType.BluRay || video.VideoType == VideoType.Dvd || video.VideoType == VideoType.HdDvd)
  430. {
  431. return false;
  432. }
  433. if (video.IsPlaceHolder)
  434. {
  435. return false;
  436. }
  437. if (video.IsArchive)
  438. {
  439. return false;
  440. }
  441. if (video.IsStacked)
  442. {
  443. return false;
  444. }
  445. if (video.IsShortcut)
  446. {
  447. return false;
  448. }
  449. }
  450. var game = item as Game;
  451. if (game != null)
  452. {
  453. if (game.IsMultiPart)
  454. {
  455. return false;
  456. }
  457. }
  458. if (item is LiveTvChannel || item is IChannelItem)
  459. {
  460. return false;
  461. }
  462. // It would be nice to support these later
  463. if (item is Game || item is Book)
  464. {
  465. return false;
  466. }
  467. return true;
  468. }
  469. return item.LocationType == LocationType.FileSystem || item is Season;
  470. }
  471. private string GetDefaultName(BaseItem item)
  472. {
  473. return item.Name;
  474. }
  475. public async Task ReportSyncJobItemTransferred(string id)
  476. {
  477. var jobItem = _repo.GetJobItem(id);
  478. jobItem.Status = SyncJobItemStatus.Synced;
  479. jobItem.Progress = 100;
  480. if (!string.IsNullOrWhiteSpace(jobItem.TemporaryPath))
  481. {
  482. try
  483. {
  484. _fileSystem.DeleteDirectory(jobItem.TemporaryPath, true);
  485. }
  486. catch (DirectoryNotFoundException)
  487. {
  488. }
  489. catch (Exception ex)
  490. {
  491. _logger.ErrorException("Error deleting temporary job file: {0}", ex, jobItem.OutputPath);
  492. }
  493. }
  494. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  495. var processor = GetSyncJobProcessor();
  496. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  497. }
  498. private SyncJobProcessor GetSyncJobProcessor()
  499. {
  500. return new SyncJobProcessor(_libraryManager, _repo, this, _logger, _userManager, _tvSeriesManager, _mediaEncoder(), _subtitleEncoder(), _config, _fileSystem, _mediaSourceManager());
  501. }
  502. public SyncJobItem GetJobItem(string id)
  503. {
  504. return _repo.GetJobItem(id);
  505. }
  506. public QueryResult<SyncJobItem> GetJobItems(SyncJobItemQuery query)
  507. {
  508. var result = _repo.GetJobItems(query);
  509. if (query.AddMetadata)
  510. {
  511. result.Items.ForEach(FillMetadata);
  512. }
  513. return result;
  514. }
  515. private SyncedItem GetJobItemInfo(SyncJobItem jobItem)
  516. {
  517. var job = _repo.GetJob(jobItem.JobId);
  518. if (job == null)
  519. {
  520. _logger.Error("GetJobItemInfo job id {0} no longer exists", jobItem.JobId);
  521. return null;
  522. }
  523. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  524. if (libraryItem == null)
  525. {
  526. _logger.Error("GetJobItemInfo library item with id {0} no longer exists", jobItem.ItemId);
  527. return null;
  528. }
  529. var syncedItem = new SyncedItem
  530. {
  531. SyncJobId = jobItem.JobId,
  532. SyncJobItemId = jobItem.Id,
  533. ServerId = _appHost.SystemId,
  534. UserId = job.UserId,
  535. SyncJobName = job.Name,
  536. SyncJobDateCreated = job.DateCreated,
  537. AdditionalFiles = jobItem.AdditionalFiles.Select(i => new ItemFileInfo
  538. {
  539. ImageType = i.ImageType,
  540. Name = i.Name,
  541. Type = i.Type,
  542. Index = i.Index
  543. }).ToList()
  544. };
  545. var dtoOptions = new DtoOptions();
  546. // Remove some bloat
  547. dtoOptions.Fields.Remove(ItemFields.MediaStreams);
  548. dtoOptions.Fields.Remove(ItemFields.IndexOptions);
  549. dtoOptions.Fields.Remove(ItemFields.MediaSourceCount);
  550. dtoOptions.Fields.Remove(ItemFields.OriginalPrimaryImageAspectRatio);
  551. dtoOptions.Fields.Remove(ItemFields.Path);
  552. dtoOptions.Fields.Remove(ItemFields.SeriesGenres);
  553. dtoOptions.Fields.Remove(ItemFields.Settings);
  554. dtoOptions.Fields.Remove(ItemFields.SyncInfo);
  555. syncedItem.Item = _dtoService().GetBaseItemDto(libraryItem, dtoOptions);
  556. var mediaSource = jobItem.MediaSource;
  557. syncedItem.Item.MediaSources = new List<MediaSourceInfo>();
  558. syncedItem.OriginalFileName = Path.GetFileName(libraryItem.Path);
  559. if (string.IsNullOrWhiteSpace(syncedItem.OriginalFileName))
  560. {
  561. syncedItem.OriginalFileName = Path.GetFileName(mediaSource.Path);
  562. }
  563. // This will be null for items that are not audio/video
  564. if (mediaSource != null)
  565. {
  566. syncedItem.OriginalFileName = Path.ChangeExtension(syncedItem.OriginalFileName, Path.GetExtension(mediaSource.Path));
  567. syncedItem.Item.MediaSources.Add(mediaSource);
  568. }
  569. return syncedItem;
  570. }
  571. public Task ReportOfflineAction(UserAction action)
  572. {
  573. switch (action.Type)
  574. {
  575. case UserActionType.PlayedItem:
  576. return ReportOfflinePlayedItem(action);
  577. default:
  578. throw new ArgumentException("Unexpected action type");
  579. }
  580. }
  581. private Task ReportOfflinePlayedItem(UserAction action)
  582. {
  583. var item = _libraryManager.GetItemById(action.ItemId);
  584. var userData = _userDataManager.GetUserData(new Guid(action.UserId), item.GetUserDataKey());
  585. userData.LastPlayedDate = action.Date;
  586. _userDataManager.UpdatePlayState(item, userData, action.PositionTicks);
  587. return _userDataManager.SaveUserData(new Guid(action.UserId), item, userData, UserDataSaveReason.Import, CancellationToken.None);
  588. }
  589. public async Task<List<SyncedItem>> GetReadySyncItems(string targetId)
  590. {
  591. var processor = GetSyncJobProcessor();
  592. await processor.SyncJobItems(targetId, false, new Progress<double>(), CancellationToken.None).ConfigureAwait(false);
  593. var jobItemResult = GetJobItems(new SyncJobItemQuery
  594. {
  595. TargetId = targetId,
  596. Statuses = new[]
  597. {
  598. SyncJobItemStatus.ReadyToTransfer
  599. }
  600. });
  601. var readyItems = jobItemResult.Items
  602. .Select(GetJobItemInfo)
  603. .Where(i => i != null)
  604. .ToList();
  605. _logger.Debug("Returning {0} ready sync items for targetId {1}", readyItems.Count, targetId);
  606. return readyItems;
  607. }
  608. public async Task<SyncDataResponse> SyncData(SyncDataRequest request)
  609. {
  610. if (request.SyncJobItemIds != null)
  611. {
  612. return await SyncDataUsingSyncJobItemIds(request).ConfigureAwait(false);
  613. }
  614. var jobItemResult = GetJobItems(new SyncJobItemQuery
  615. {
  616. TargetId = request.TargetId,
  617. Statuses = new[] { SyncJobItemStatus.Synced }
  618. });
  619. var response = new SyncDataResponse();
  620. foreach (var jobItem in jobItemResult.Items)
  621. {
  622. var requiresSaving = false;
  623. var removeFromDevice = false;
  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. removeFromDevice = true;
  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. removeFromDevice = true;
  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. removeFromDevice = true;
  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. removeFromDevice = true;
  657. }
  658. }
  659. }
  660. else
  661. {
  662. // Content is no longer on the device
  663. if (jobItem.IsMarkedForRemoval)
  664. {
  665. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  666. }
  667. else
  668. {
  669. _logger.Debug("Setting status to Queued for {0} because it is no longer on the device.", jobItem.ItemId);
  670. jobItem.Status = SyncJobItemStatus.Queued;
  671. }
  672. requiresSaving = true;
  673. }
  674. if (removeFromDevice)
  675. {
  676. response.ItemIdsToRemove.Add(jobItem.ItemId);
  677. jobItem.IsMarkedForRemoval = true;
  678. requiresSaving = true;
  679. }
  680. if (requiresSaving)
  681. {
  682. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  683. }
  684. }
  685. // Now check each item that's on the device
  686. foreach (var itemId in request.LocalItemIds)
  687. {
  688. // See if it's already marked for removal
  689. if (response.ItemIdsToRemove.Contains(itemId, StringComparer.OrdinalIgnoreCase))
  690. {
  691. continue;
  692. }
  693. // If there isn't a sync job for this item, mark it for removal
  694. if (!jobItemResult.Items.Any(i => string.Equals(itemId, i.ItemId, StringComparison.OrdinalIgnoreCase)))
  695. {
  696. response.ItemIdsToRemove.Add(itemId);
  697. }
  698. }
  699. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  700. var itemsOnDevice = request.LocalItemIds
  701. .Except(response.ItemIdsToRemove)
  702. .ToList();
  703. SetUserAccess(request, response, itemsOnDevice);
  704. return response;
  705. }
  706. private async Task<SyncDataResponse> SyncDataUsingSyncJobItemIds(SyncDataRequest request)
  707. {
  708. var jobItemResult = GetJobItems(new SyncJobItemQuery
  709. {
  710. TargetId = request.TargetId,
  711. Statuses = new[] { SyncJobItemStatus.Synced }
  712. });
  713. var response = new SyncDataResponse();
  714. foreach (var jobItem in jobItemResult.Items)
  715. {
  716. var requiresSaving = false;
  717. var removeFromDevice = false;
  718. if (request.SyncJobItemIds.Contains(jobItem.Id, StringComparer.OrdinalIgnoreCase))
  719. {
  720. var job = _repo.GetJob(jobItem.JobId);
  721. var user = _userManager.GetUserById(job.UserId);
  722. if (jobItem.IsMarkedForRemoval)
  723. {
  724. // Tell the device to remove it since it has been marked for removal
  725. _logger.Debug("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.Id);
  726. removeFromDevice = true;
  727. }
  728. else if (user == null)
  729. {
  730. // Tell the device to remove it since the user is gone now
  731. _logger.Debug("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.Id);
  732. removeFromDevice = true;
  733. }
  734. else if (job.UnwatchedOnly)
  735. {
  736. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  737. if (IsLibraryItemAvailable(libraryItem))
  738. {
  739. if (libraryItem.IsPlayed(user) && libraryItem is Video)
  740. {
  741. // Tell the device to remove it since it has been played
  742. _logger.Debug("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.Id);
  743. removeFromDevice = true;
  744. }
  745. }
  746. else
  747. {
  748. // Tell the device to remove it since it's no longer available
  749. _logger.Debug("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.Id);
  750. removeFromDevice = true;
  751. }
  752. }
  753. }
  754. else
  755. {
  756. // Content is no longer on the device
  757. if (jobItem.IsMarkedForRemoval)
  758. {
  759. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  760. }
  761. else
  762. {
  763. _logger.Debug("Setting status to Queued for {0} because it is no longer on the device.", jobItem.Id);
  764. jobItem.Status = SyncJobItemStatus.Queued;
  765. }
  766. requiresSaving = true;
  767. }
  768. if (removeFromDevice)
  769. {
  770. response.ItemIdsToRemove.Add(jobItem.Id);
  771. jobItem.IsMarkedForRemoval = true;
  772. requiresSaving = true;
  773. }
  774. if (requiresSaving)
  775. {
  776. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  777. }
  778. }
  779. // Now check each item that's on the device
  780. foreach (var syncJobItemId in request.SyncJobItemIds)
  781. {
  782. // See if it's already marked for removal
  783. if (response.ItemIdsToRemove.Contains(syncJobItemId, StringComparer.OrdinalIgnoreCase))
  784. {
  785. continue;
  786. }
  787. // If there isn't a sync job for this item, mark it for removal
  788. if (!jobItemResult.Items.Any(i => string.Equals(syncJobItemId, i.Id, StringComparison.OrdinalIgnoreCase)))
  789. {
  790. response.ItemIdsToRemove.Add(syncJobItemId);
  791. }
  792. }
  793. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  794. return response;
  795. }
  796. private void SetUserAccess(SyncDataRequest request, SyncDataResponse response, List<string> itemIds)
  797. {
  798. var users = request.OfflineUserIds
  799. .Select(_userManager.GetUserById)
  800. .Where(i => i != null)
  801. .ToList();
  802. foreach (var itemId in itemIds)
  803. {
  804. var item = _libraryManager.GetItemById(itemId);
  805. if (item != null)
  806. {
  807. response.ItemUserAccess[itemId] = users
  808. .Where(i => IsUserVisible(item, i))
  809. .Select(i => i.Id.ToString("N"))
  810. .OrderBy(i => i)
  811. .ToList();
  812. }
  813. }
  814. }
  815. private bool IsUserVisible(BaseItem item, User user)
  816. {
  817. return item.IsVisibleStandalone(user);
  818. }
  819. private bool IsLibraryItemAvailable(BaseItem item)
  820. {
  821. if (item == null)
  822. {
  823. return false;
  824. }
  825. // TODO: Make sure it hasn't been deleted
  826. return true;
  827. }
  828. public async Task ReEnableJobItem(string id)
  829. {
  830. var jobItem = _repo.GetJobItem(id);
  831. if (jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Cancelled)
  832. {
  833. throw new ArgumentException("Operation is not valid for this job item");
  834. }
  835. jobItem.Status = SyncJobItemStatus.Queued;
  836. jobItem.Progress = 0;
  837. jobItem.IsMarkedForRemoval = false;
  838. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  839. var processor = GetSyncJobProcessor();
  840. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  841. }
  842. public async Task CancelItems(string targetId, IEnumerable<string> itemIds)
  843. {
  844. foreach (var item in itemIds)
  845. {
  846. var syncJobItemResult = GetJobItems(new SyncJobItemQuery
  847. {
  848. AddMetadata = false,
  849. ItemId = item,
  850. TargetId = targetId,
  851. Statuses = new[] { SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Converting, SyncJobItemStatus.Synced, SyncJobItemStatus.Failed }
  852. });
  853. foreach (var jobItem in syncJobItemResult.Items)
  854. {
  855. await CancelJobItem(jobItem.Id).ConfigureAwait(false);
  856. }
  857. }
  858. }
  859. public async Task CancelJobItem(string id)
  860. {
  861. var jobItem = _repo.GetJobItem(id);
  862. if (jobItem.Status != SyncJobItemStatus.Queued && jobItem.Status != SyncJobItemStatus.ReadyToTransfer && jobItem.Status != SyncJobItemStatus.Converting && jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Synced)
  863. {
  864. throw new ArgumentException("Operation is not valid for this job item");
  865. }
  866. if (jobItem.Status != SyncJobItemStatus.Synced)
  867. {
  868. jobItem.Status = SyncJobItemStatus.Cancelled;
  869. }
  870. jobItem.Progress = 0;
  871. jobItem.IsMarkedForRemoval = true;
  872. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  873. var processor = GetSyncJobProcessor();
  874. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  875. var path = processor.GetTemporaryPath(jobItem);
  876. try
  877. {
  878. _fileSystem.DeleteDirectory(path, true);
  879. }
  880. catch (DirectoryNotFoundException)
  881. {
  882. }
  883. catch (Exception ex)
  884. {
  885. _logger.ErrorException("Error deleting directory {0}", ex, path);
  886. }
  887. //var jobItemsResult = GetJobItems(new SyncJobItemQuery
  888. //{
  889. // AddMetadata = false,
  890. // JobId = jobItem.JobId,
  891. // Limit = 0,
  892. // Statuses = new[] { SyncJobItemStatus.Converting, SyncJobItemStatus.Failed, SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Synced, SyncJobItemStatus.Transferring }
  893. //});
  894. //if (jobItemsResult.TotalRecordCount == 0)
  895. //{
  896. // await CancelJob(jobItem.JobId).ConfigureAwait(false);
  897. //}
  898. }
  899. public Task MarkJobItemForRemoval(string id)
  900. {
  901. return CancelJobItem(id);
  902. }
  903. public async Task UnmarkJobItemForRemoval(string id)
  904. {
  905. var jobItem = _repo.GetJobItem(id);
  906. if (jobItem.Status != SyncJobItemStatus.Synced)
  907. {
  908. throw new ArgumentException("Operation is not valid for this job item");
  909. }
  910. jobItem.IsMarkedForRemoval = false;
  911. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  912. var processor = GetSyncJobProcessor();
  913. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  914. }
  915. public async Task ReportSyncJobItemTransferBeginning(string id)
  916. {
  917. var jobItem = _repo.GetJobItem(id);
  918. jobItem.Status = SyncJobItemStatus.Transferring;
  919. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  920. var processor = GetSyncJobProcessor();
  921. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  922. }
  923. public async Task ReportSyncJobItemTransferFailed(string id)
  924. {
  925. var jobItem = _repo.GetJobItem(id);
  926. jobItem.Status = SyncJobItemStatus.ReadyToTransfer;
  927. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  928. var processor = GetSyncJobProcessor();
  929. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  930. }
  931. public QueryResult<string> GetLibraryItemIds(SyncJobItemQuery query)
  932. {
  933. return _repo.GetLibraryItemIds(query);
  934. }
  935. public SyncJobOptions GetAudioOptions(SyncJobItem jobItem, SyncJob job)
  936. {
  937. var options = GetSyncJobOptions(jobItem.TargetId, null, null);
  938. if (job.Bitrate.HasValue)
  939. {
  940. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  941. }
  942. return options;
  943. }
  944. public SyncJobOptions GetVideoOptions(SyncJobItem jobItem, SyncJob job)
  945. {
  946. var options = GetSyncJobOptions(jobItem.TargetId, job.Profile, job.Quality);
  947. if (job.Bitrate.HasValue)
  948. {
  949. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  950. }
  951. return options;
  952. }
  953. private SyncJobOptions GetSyncJobOptions(string targetId, string profile, string quality)
  954. {
  955. foreach (var provider in _providers)
  956. {
  957. foreach (var target in GetSyncTargets(provider))
  958. {
  959. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  960. {
  961. return GetSyncJobOptions(provider, target, profile, quality);
  962. }
  963. }
  964. }
  965. return GetDefaultSyncJobOptions(profile, quality);
  966. }
  967. private SyncJobOptions GetSyncJobOptions(ISyncProvider provider, SyncTarget target, string profile, string quality)
  968. {
  969. var hasProfile = provider as IHasSyncQuality;
  970. if (hasProfile != null)
  971. {
  972. return hasProfile.GetSyncJobOptions(target, profile, quality);
  973. }
  974. return GetDefaultSyncJobOptions(profile, quality);
  975. }
  976. private SyncJobOptions GetDefaultSyncJobOptions(string profile, string quality)
  977. {
  978. var supportsAc3 = string.Equals(profile, "general", StringComparison.OrdinalIgnoreCase);
  979. var deviceProfile = new CloudSyncProfile(supportsAc3, false);
  980. deviceProfile.MaxStaticBitrate = SyncHelper.AdjustBitrate(deviceProfile.MaxStaticBitrate, quality);
  981. return new SyncJobOptions
  982. {
  983. DeviceProfile = deviceProfile,
  984. IsConverting = IsConverting(profile, quality)
  985. };
  986. }
  987. private bool IsConverting(string profile, string quality)
  988. {
  989. return !string.Equals(profile, "original", StringComparison.OrdinalIgnoreCase);
  990. }
  991. public IEnumerable<SyncQualityOption> GetQualityOptions(string targetId)
  992. {
  993. return GetQualityOptions(targetId, null);
  994. }
  995. public IEnumerable<SyncQualityOption> GetQualityOptions(string targetId, User user)
  996. {
  997. foreach (var provider in _providers)
  998. {
  999. foreach (var target in GetSyncTargets(provider))
  1000. {
  1001. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  1002. {
  1003. return GetQualityOptions(provider, target, user);
  1004. }
  1005. }
  1006. }
  1007. return new List<SyncQualityOption>();
  1008. }
  1009. private IEnumerable<SyncQualityOption> GetQualityOptions(ISyncProvider provider, SyncTarget target, User user)
  1010. {
  1011. var hasQuality = provider as IHasSyncQuality;
  1012. if (hasQuality != null)
  1013. {
  1014. var options = hasQuality.GetQualityOptions(target);
  1015. if (user != null && !user.Policy.EnableSyncTranscoding)
  1016. {
  1017. options = options.Where(i => i.IsOriginalQuality);
  1018. }
  1019. return options;
  1020. }
  1021. // Default options for providers that don't override
  1022. return new List<SyncQualityOption>
  1023. {
  1024. new SyncQualityOption
  1025. {
  1026. Name = "High",
  1027. Id = "high",
  1028. IsDefault = true
  1029. },
  1030. new SyncQualityOption
  1031. {
  1032. Name = "Medium",
  1033. Id = "medium"
  1034. },
  1035. new SyncQualityOption
  1036. {
  1037. Name = "Low",
  1038. Id = "low"
  1039. },
  1040. new SyncQualityOption
  1041. {
  1042. Name = "Custom",
  1043. Id = "custom"
  1044. }
  1045. };
  1046. }
  1047. public IEnumerable<SyncProfileOption> GetProfileOptions(string targetId, User user)
  1048. {
  1049. foreach (var provider in _providers)
  1050. {
  1051. foreach (var target in GetSyncTargets(provider))
  1052. {
  1053. if (string.Equals(target.Id, targetId, StringComparison.OrdinalIgnoreCase))
  1054. {
  1055. return GetProfileOptions(provider, target, user);
  1056. }
  1057. }
  1058. }
  1059. return new List<SyncProfileOption>();
  1060. }
  1061. public IEnumerable<SyncProfileOption> GetProfileOptions(string targetId)
  1062. {
  1063. return GetProfileOptions(targetId, null);
  1064. }
  1065. private IEnumerable<SyncProfileOption> GetProfileOptions(ISyncProvider provider, SyncTarget target, User user)
  1066. {
  1067. var hasQuality = provider as IHasSyncQuality;
  1068. if (hasQuality != null)
  1069. {
  1070. return hasQuality.GetProfileOptions(target);
  1071. }
  1072. var list = new List<SyncProfileOption>();
  1073. list.Add(new SyncProfileOption
  1074. {
  1075. Name = "Original",
  1076. Id = "Original",
  1077. Description = "Syncs original files as-is.",
  1078. EnableQualityOptions = false
  1079. });
  1080. if (user == null || user.Policy.EnableSyncTranscoding)
  1081. {
  1082. list.Add(new SyncProfileOption
  1083. {
  1084. Name = "Baseline",
  1085. Id = "baseline",
  1086. Description = "Designed for compatibility with all devices, including web browsers. Targets H264/AAC video and MP3 audio."
  1087. });
  1088. list.Add(new SyncProfileOption
  1089. {
  1090. Name = "General",
  1091. Id = "general",
  1092. Description = "Designed for compatibility with Chromecast, Roku, Smart TV's, and other similar devices. Targets H264/AAC/AC3 video and MP3 audio.",
  1093. IsDefault = true
  1094. });
  1095. }
  1096. return list;
  1097. }
  1098. }
  1099. }