SyncManager.cs 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328
  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.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. SyncJobItemStatus.Transferring
  600. }
  601. });
  602. var readyItems = jobItemResult.Items
  603. .Select(GetJobItemInfo)
  604. .Where(i => i != null)
  605. .ToList();
  606. _logger.Debug("Returning {0} ready sync items for targetId {1}", readyItems.Count, targetId);
  607. return readyItems;
  608. }
  609. public async Task<SyncDataResponse> SyncData(SyncDataRequest request)
  610. {
  611. if (request.SyncJobItemIds != null)
  612. {
  613. return await SyncDataUsingSyncJobItemIds(request).ConfigureAwait(false);
  614. }
  615. var jobItemResult = GetJobItems(new SyncJobItemQuery
  616. {
  617. TargetId = request.TargetId,
  618. Statuses = new[] { SyncJobItemStatus.Synced }
  619. });
  620. var response = new SyncDataResponse();
  621. foreach (var jobItem in jobItemResult.Items)
  622. {
  623. var requiresSaving = false;
  624. var removeFromDevice = false;
  625. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  626. if (request.LocalItemIds.Contains(jobItem.ItemId, StringComparer.OrdinalIgnoreCase))
  627. {
  628. var job = _repo.GetJob(jobItem.JobId);
  629. var user = _userManager.GetUserById(job.UserId);
  630. if (jobItem.IsMarkedForRemoval)
  631. {
  632. // Tell the device to remove it since it has been marked for removal
  633. _logger.Debug("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.ItemId);
  634. removeFromDevice = true;
  635. }
  636. else if (user == null)
  637. {
  638. // Tell the device to remove it since the user is gone now
  639. _logger.Debug("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.ItemId);
  640. removeFromDevice = true;
  641. }
  642. else if (!IsLibraryItemAvailable(libraryItem))
  643. {
  644. // Tell the device to remove it since it's no longer available
  645. _logger.Debug("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.ItemId);
  646. removeFromDevice = true;
  647. }
  648. else if (job.UnwatchedOnly)
  649. {
  650. if (libraryItem.IsPlayed(user) && libraryItem is Video)
  651. {
  652. // Tell the device to remove it since it has been played
  653. _logger.Debug("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.ItemId);
  654. removeFromDevice = true;
  655. }
  656. }
  657. }
  658. else
  659. {
  660. // Content is no longer on the device
  661. if (jobItem.IsMarkedForRemoval)
  662. {
  663. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  664. }
  665. else
  666. {
  667. _logger.Debug("Setting status to Queued for {0} because it is no longer on the device.", jobItem.ItemId);
  668. jobItem.Status = SyncJobItemStatus.Queued;
  669. }
  670. requiresSaving = true;
  671. }
  672. if (removeFromDevice)
  673. {
  674. response.ItemIdsToRemove.Add(jobItem.ItemId);
  675. jobItem.IsMarkedForRemoval = true;
  676. requiresSaving = true;
  677. }
  678. if (requiresSaving)
  679. {
  680. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  681. }
  682. }
  683. // Now check each item that's on the device
  684. foreach (var itemId in request.LocalItemIds)
  685. {
  686. // See if it's already marked for removal
  687. if (response.ItemIdsToRemove.Contains(itemId, StringComparer.OrdinalIgnoreCase))
  688. {
  689. continue;
  690. }
  691. // If there isn't a sync job for this item, mark it for removal
  692. if (!jobItemResult.Items.Any(i => string.Equals(itemId, i.ItemId, StringComparison.OrdinalIgnoreCase)))
  693. {
  694. response.ItemIdsToRemove.Add(itemId);
  695. }
  696. }
  697. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  698. var itemsOnDevice = request.LocalItemIds
  699. .Except(response.ItemIdsToRemove)
  700. .ToList();
  701. SetUserAccess(request, response, itemsOnDevice);
  702. return response;
  703. }
  704. private async Task<SyncDataResponse> SyncDataUsingSyncJobItemIds(SyncDataRequest request)
  705. {
  706. var jobItemResult = GetJobItems(new SyncJobItemQuery
  707. {
  708. TargetId = request.TargetId,
  709. Statuses = new[] { SyncJobItemStatus.Synced }
  710. });
  711. var response = new SyncDataResponse();
  712. foreach (var jobItem in jobItemResult.Items)
  713. {
  714. var requiresSaving = false;
  715. var removeFromDevice = false;
  716. var libraryItem = _libraryManager.GetItemById(jobItem.ItemId);
  717. if (request.SyncJobItemIds.Contains(jobItem.Id, StringComparer.OrdinalIgnoreCase))
  718. {
  719. var job = _repo.GetJob(jobItem.JobId);
  720. var user = _userManager.GetUserById(job.UserId);
  721. if (jobItem.IsMarkedForRemoval)
  722. {
  723. // Tell the device to remove it since it has been marked for removal
  724. _logger.Debug("Adding ItemIdsToRemove {0} because IsMarkedForRemoval is set.", jobItem.Id);
  725. removeFromDevice = true;
  726. }
  727. else if (user == null)
  728. {
  729. // Tell the device to remove it since the user is gone now
  730. _logger.Debug("Adding ItemIdsToRemove {0} because the user is no longer valid.", jobItem.Id);
  731. removeFromDevice = true;
  732. }
  733. else if (!IsLibraryItemAvailable(libraryItem))
  734. {
  735. // Tell the device to remove it since it's no longer available
  736. _logger.Debug("Adding ItemIdsToRemove {0} because it is no longer available.", jobItem.Id);
  737. removeFromDevice = true;
  738. }
  739. else if (job.UnwatchedOnly)
  740. {
  741. if (libraryItem.IsPlayed(user) && libraryItem is Video)
  742. {
  743. // Tell the device to remove it since it has been played
  744. _logger.Debug("Adding ItemIdsToRemove {0} because it has been marked played.", jobItem.Id);
  745. removeFromDevice = true;
  746. }
  747. }
  748. }
  749. else
  750. {
  751. // Content is no longer on the device
  752. if (jobItem.IsMarkedForRemoval)
  753. {
  754. jobItem.Status = SyncJobItemStatus.RemovedFromDevice;
  755. }
  756. else
  757. {
  758. _logger.Debug("Setting status to Queued for {0} because it is no longer on the device.", jobItem.Id);
  759. jobItem.Status = SyncJobItemStatus.Queued;
  760. }
  761. requiresSaving = true;
  762. }
  763. if (removeFromDevice)
  764. {
  765. response.ItemIdsToRemove.Add(jobItem.Id);
  766. jobItem.IsMarkedForRemoval = true;
  767. requiresSaving = true;
  768. }
  769. if (requiresSaving)
  770. {
  771. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  772. }
  773. }
  774. // Now check each item that's on the device
  775. foreach (var syncJobItemId in request.SyncJobItemIds)
  776. {
  777. // See if it's already marked for removal
  778. if (response.ItemIdsToRemove.Contains(syncJobItemId, StringComparer.OrdinalIgnoreCase))
  779. {
  780. continue;
  781. }
  782. // If there isn't a sync job for this item, mark it for removal
  783. if (!jobItemResult.Items.Any(i => string.Equals(syncJobItemId, i.Id, StringComparison.OrdinalIgnoreCase)))
  784. {
  785. response.ItemIdsToRemove.Add(syncJobItemId);
  786. }
  787. }
  788. response.ItemIdsToRemove = response.ItemIdsToRemove.Distinct(StringComparer.OrdinalIgnoreCase).ToList();
  789. return response;
  790. }
  791. private void SetUserAccess(SyncDataRequest request, SyncDataResponse response, List<string> itemIds)
  792. {
  793. var users = request.OfflineUserIds
  794. .Select(_userManager.GetUserById)
  795. .Where(i => i != null)
  796. .ToList();
  797. foreach (var itemId in itemIds)
  798. {
  799. var item = _libraryManager.GetItemById(itemId);
  800. if (item != null)
  801. {
  802. response.ItemUserAccess[itemId] = users
  803. .Where(i => IsUserVisible(item, i))
  804. .Select(i => i.Id.ToString("N"))
  805. .OrderBy(i => i)
  806. .ToList();
  807. }
  808. }
  809. }
  810. private bool IsUserVisible(BaseItem item, User user)
  811. {
  812. return item.IsVisibleStandalone(user);
  813. }
  814. private bool IsLibraryItemAvailable(BaseItem item)
  815. {
  816. if (item == null)
  817. {
  818. return false;
  819. }
  820. // TODO: Make sure it hasn't been deleted
  821. return true;
  822. }
  823. public async Task ReEnableJobItem(string id)
  824. {
  825. var jobItem = _repo.GetJobItem(id);
  826. if (jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Cancelled)
  827. {
  828. throw new ArgumentException("Operation is not valid for this job item");
  829. }
  830. jobItem.Status = SyncJobItemStatus.Queued;
  831. jobItem.Progress = 0;
  832. jobItem.IsMarkedForRemoval = false;
  833. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  834. var processor = GetSyncJobProcessor();
  835. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  836. }
  837. public async Task CancelItems(string targetId, IEnumerable<string> itemIds)
  838. {
  839. foreach (var item in itemIds)
  840. {
  841. var syncJobItemResult = GetJobItems(new SyncJobItemQuery
  842. {
  843. AddMetadata = false,
  844. ItemId = item,
  845. TargetId = targetId,
  846. Statuses = new[] { SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Converting, SyncJobItemStatus.Synced, SyncJobItemStatus.Failed }
  847. });
  848. foreach (var jobItem in syncJobItemResult.Items)
  849. {
  850. await CancelJobItem(jobItem.Id).ConfigureAwait(false);
  851. }
  852. }
  853. }
  854. public async Task CancelJobItem(string id)
  855. {
  856. var jobItem = _repo.GetJobItem(id);
  857. if (jobItem.Status != SyncJobItemStatus.Queued && jobItem.Status != SyncJobItemStatus.ReadyToTransfer && jobItem.Status != SyncJobItemStatus.Converting && jobItem.Status != SyncJobItemStatus.Failed && jobItem.Status != SyncJobItemStatus.Synced)
  858. {
  859. throw new ArgumentException("Operation is not valid for this job item");
  860. }
  861. if (jobItem.Status != SyncJobItemStatus.Synced)
  862. {
  863. jobItem.Status = SyncJobItemStatus.Cancelled;
  864. }
  865. jobItem.Progress = 0;
  866. jobItem.IsMarkedForRemoval = true;
  867. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  868. var processor = GetSyncJobProcessor();
  869. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  870. var path = processor.GetTemporaryPath(jobItem);
  871. try
  872. {
  873. _fileSystem.DeleteDirectory(path, true);
  874. }
  875. catch (DirectoryNotFoundException)
  876. {
  877. }
  878. catch (Exception ex)
  879. {
  880. _logger.ErrorException("Error deleting directory {0}", ex, path);
  881. }
  882. //var jobItemsResult = GetJobItems(new SyncJobItemQuery
  883. //{
  884. // AddMetadata = false,
  885. // JobId = jobItem.JobId,
  886. // Limit = 0,
  887. // Statuses = new[] { SyncJobItemStatus.Converting, SyncJobItemStatus.Failed, SyncJobItemStatus.Queued, SyncJobItemStatus.ReadyToTransfer, SyncJobItemStatus.Synced, SyncJobItemStatus.Transferring }
  888. //});
  889. //if (jobItemsResult.TotalRecordCount == 0)
  890. //{
  891. // await CancelJob(jobItem.JobId).ConfigureAwait(false);
  892. //}
  893. }
  894. public Task MarkJobItemForRemoval(string id)
  895. {
  896. return CancelJobItem(id);
  897. }
  898. public async Task UnmarkJobItemForRemoval(string id)
  899. {
  900. var jobItem = _repo.GetJobItem(id);
  901. if (jobItem.Status != SyncJobItemStatus.Synced)
  902. {
  903. throw new ArgumentException("Operation is not valid for this job item");
  904. }
  905. jobItem.IsMarkedForRemoval = false;
  906. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  907. var processor = GetSyncJobProcessor();
  908. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  909. }
  910. public async Task ReportSyncJobItemTransferBeginning(string id)
  911. {
  912. var jobItem = _repo.GetJobItem(id);
  913. jobItem.Status = SyncJobItemStatus.Transferring;
  914. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  915. var processor = GetSyncJobProcessor();
  916. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  917. }
  918. public async Task ReportSyncJobItemTransferFailed(string id)
  919. {
  920. var jobItem = _repo.GetJobItem(id);
  921. jobItem.Status = SyncJobItemStatus.ReadyToTransfer;
  922. await UpdateSyncJobItemInternal(jobItem).ConfigureAwait(false);
  923. var processor = GetSyncJobProcessor();
  924. await processor.UpdateJobStatus(jobItem.JobId).ConfigureAwait(false);
  925. }
  926. public QueryResult<string> GetLibraryItemIds(SyncJobItemQuery query)
  927. {
  928. return _repo.GetLibraryItemIds(query);
  929. }
  930. public SyncJobOptions GetAudioOptions(SyncJobItem jobItem, SyncJob job)
  931. {
  932. var options = GetSyncJobOptions(jobItem.TargetId, null, null);
  933. if (job.Bitrate.HasValue)
  934. {
  935. options.DeviceProfile.MaxStaticBitrate = job.Bitrate.Value;
  936. }
  937. return options;
  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. }