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