SyncManager.cs 46 KB

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